🗂️ content-grabber-alvamind

A Node.js library to extract text content from various file types. 💪

✨ Features

• Versatile File Support: Extracts text from .txt, .pdf, .docx, .csv, and .xlsx files. 📄
• Local & Remote Files: Works with both local file paths and URLs. 🌐
• Intelligent Content Type Handling: Automatically detects content types from headers and file extensions. 🤔
• PDF Text Extraction: Extracts text from PDF files, with optional OCR support. 🧐
• Configurable OCR: Control OCR behavior (scale, languages). ⚙️
• Customizable Logging: Supports custom logger for info, error and debug messages. 🪵
• Error Handling: Provides descriptive error messages. ⚠️
• Easy to Use: Simple API for quick integration into your projects. 🚀

🎯 Benefits

• Simplify Data Extraction: Quickly grab text from different file types. ⏱️
• Save Time: No need to handle file formats manually. ⏳
• Improve Productivity: Focus on processing text rather than parsing files. 📈
• Reliable: Robust and well-tested. ✅

📦 Installation

1npm install content-grabber-alvamind

🛠️ Usage

Basic Example

1import { fetchFileContent } from 'content-grabber-alvamind';
2
3async function main() {
4  try {
5    const fileUrl = 'path/to/your/document.pdf'; // Replace with your file URL/path
6    const extractedContent = await fetchFileContent(fileUrl);
7    console.log(extractedContent);
8  } catch (error) {
9    console.error('Error:', error);
10  }
11}
12
13main();

PDF with OCR

1import { fetchFileContent } from 'content-grabber-alvamind';
2
3async function main() {
4    try {
5      const fileUrl = 'path/to/your/scanned_document.pdf';
6      const extractedContent = await fetchFileContent(fileUrl, {
7          pdfOptions: {
8              ocrEnabled: true, // Enable OCR for scanned PDFs
9              languages: ['eng', 'spa'], // Specify OCR languages
10              scale: 2.5 // increase scale for better OCR quality
11          }
12      });
13      console.log(extractedContent);
14  } catch (error) {
15      console.error("Error:", error);
16  }
17}
18
19main();

Custom Logger Example

1import { fetchFileContent, FileContentExtractionOptions } from 'content-grabber-alvamind';
2
3class CustomLogger {
4  info(message: string, ...args: any[]): void {
5    console.log(`[CUSTOM INFO] ${message}`, ...args);
6  }
7
8  error(message: string, ...args: any[]): void {
9    console.error(`[CUSTOM ERROR] ${message}`, ...args);
10  }
11
12  debug(message: string, ...args: any[]): void {
13     console.debug(`[CUSTOM DEBUG] ${message}`, ...args);
14  }
15}
16
17
18async function main() {
19  try {
20    const fileUrl = 'path/to/your/document.txt';
21      const options: FileContentExtractionOptions = {
22          logger: new CustomLogger()
23      }
24    const extractedContent = await fetchFileContent(fileUrl, options);
25    console.log(extractedContent);
26  } catch (error) {
27    console.error('Error:', error);
28  }
29}
30
31main();

DOCX Extraction

1import { fetchFileContent } from 'content-grabber-alvamind';
2
3async function main() {
4  try {
5    const fileUrl = 'path/to/your/document.docx'; // Replace with your file URL/path
6    const extractedContent = await fetchFileContent(fileUrl);
7    console.log(extractedContent);
8  } catch (error) {
9    console.error('Error:', error);
10  }
11}
12
13main();

CSV Extraction

1import { fetchFileContent } from 'content-grabber-alvamind';
2
3async function main() {
4  try {
5    const fileUrl = 'path/to/your/data.csv'; // Replace with your file URL/path
6    const extractedContent = await fetchFileContent(fileUrl);
7    console.log(extractedContent);
8  } catch (error) {
9    console.error('Error:', error);
10  }
11}
12
13main();

Excel Extraction

1import { fetchFileContent } from 'content-grabber-alvamind';
2
3async function main() {
4  try {
5    const fileUrl = 'path/to/your/data.xlsx'; // Replace with your file URL/path
6    const extractedContent = await fetchFileContent(fileUrl);
7    console.log(extractedContent);
8  } catch (error) {
9    console.error('Error:', error);
10  }
11}
12
13main();

API

fetchFileContent(fileUrl: string, options?: FileContentExtractionOptions): Promise<string>

• fileUrl (string): The URL or local file path of the document to extract text from.
• options (object, optional): An object containing optional configurations:
  • pdfOptions (object, optional): Configuration for PDF extraction:
    • ocrEnabled (boolean, optional): Enable OCR extraction. Default true.
    • scale (number, optional): Scale factor for OCR image. Default 2.0.
    • languages (string[], optional): Array of OCR languages (e.g., ['eng', 'spa']). Default ['eng'].
    • minTextLength (number, optional): Minimum length of normal text to consider using OCR. Default 50.
  • logger: Custom logger object that implements info, error and debug methods
• Returns: A Promise that resolves with the extracted text content or throws an error.

🛣️ Roadmap

• Support for more file types (e.g., .odt, .rtf).
• Improved OCR accuracy and performance.
• Configurable text extraction strategies.
• Add unit tests.
• More advanced logging options.

🤝 Contributing

Contributions are welcome! Feel free to submit issues, feature requests, and pull requests on GitHub. 🙏

Here’s how you can help:

• Report bugs. 🐛
• Suggest new features. 💡
• Improve documentation. ✍️
• Submit code changes. 💻

💖 Support the Project

If you find this project useful, consider supporting its development! You can contribute through:

• GitHub Sponsors: ⭐️ [Link to GitHub Sponsors]
• Donations: 💰 [Link to Donation Platform]

Your support keeps this project going! 🙌

📄 License

MIT