get-reading-time 1.0.4 → 1.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Md Nur Ahmad
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,36 +1,29 @@
-
 # Text Analysis Tool
 
 A simple text analysis tool that provides insights into text such as reading time, word count, sentiment, readability score, link count, and SEO-friendly keywords.
 
 ## Features
 
--   **Reading Time**: Estimates how long it will take to read the given text based on a default or custom reading speed (words per minute).
-    
--   **Word Count**: Counts the number of words in the text.
-    
--   **Character Count**: Counts the number of characters (excluding spaces) in the text.
-    
--   **Sentence Count**: Counts the number of sentences based on punctuation marks.
-    
--   **Link Count**: Detects and counts the number of URLs in the text.
-    
--   **Readability Score**: Calculates the Flesch Reading Ease score to evaluate the text's readability.
-    
--   **Sentiment Analysis**: Analyzes the sentiment of the text (Positive, Negative, or Neutral).
-    
--   **SEO-friendly Keywords**: Extracts the top 5 SEO-friendly keywords or key phrases (bi-grams and tri-grams) from the text.
-    
+- **Reading Time**: Estimates how long it will take to read the given text based on a default or custom reading speed (words per minute).
+- **Word Count**: Counts the number of words in the text.
+- **Character Count**: Counts the number of characters (excluding spaces) in the text.
+- **Sentence Count**: Counts the number of sentences based on punctuation marks.
+- **Link Count**: Detects and counts the number of URLs in the text.
+- **Readability Score**: Calculates the Flesch Reading Ease score to evaluate the text's readability.
+- **Sentiment Analysis**: Analyzes the sentiment of the text (Positive, Negative, or Neutral).
+- **SEO-friendly Keywords**: Extracts the top 5 SEO-friendly keywords or key phrases (bi-grams and tri-grams) from the text.
+- **aiTexGen**: Allows users to generate content based on a search prompt using the Cohere AI API, with a specified word count.
 
 ## Installation
 
 To install the package from npm, run:
-``` bash
+
+```bash
 npm i get-reading-time
 ```
 
-
 Or using yarn:
+
 ```bash
 yarn add get-reading-time
 ```
@@ -38,54 +31,106 @@ yarn add get-reading-time
 ## Usage
 
 Here’s how you can use the analyzeText function to analyze a piece of text:
+
 ```bash
 import { analyzeText } from "get-reading-time/dist/index.js";
 ```
-// Example input text
+
+### Example Code
+
 ```javascript
-const text =  "This is an example of text. It contains words, sentences, and links like https://example.com.";
+const text = `This is an example of text. It contains words, sentences, and links like there are https://linkedin.com/in/06nurahmed https://github.com/nurahmed123`;
 
-const result =  analyzeText(text);
+const result = analyzeText(text);
 
 // Analyze the text
 try {
-    const result = analyzeText(text);
+  const result = analyzeText(text);
 
-    // Output the analysis results
-    console.log("Text Analysis Result:");
-    console.log(JSON.stringify(result, null, 2));
+  // Output the analysis results
+  console.log("Text Analysis Result:");
+  console.log(JSON.stringify(result, null, 2));
 } catch (error) {
-    // Narrow the type of error to Error
-    if (error instanceof Error) {
-        console.error("Error analyzing text:", error.message);
-    } else {
-        console.error("Unknown error:", error);
-    }
+  // Narrow the type of error to Error
+  if (error instanceof Error) {
+    console.error("Error analyzing text:", error.message);
+  } else {
+    console.error("Unknown error:", error);
+  }
 }
+```
+
+### Example Output
 
+```json
+{
+  "readingTime": {
+    "minutes": 0.09,
+    "seconds": 5.1
+  },
+  "wordCount": 17,
+  "characterCount": 132,
+  "sentenceCount": 3,
+  "linkCount": 2,
+  "links": [
+    "https://linkedin.com/in/06nurahmed",
+    "https://github.com/nurahmed123"
+  ],
+  "readabilityScore": 21.93039215686275,
+  "sentiment": "Neutral",
+  "keywords": ["example", "text.", "contains", "words,", "sentences,"]
+}
+```
+
+### aiTexGen: Generate your content
+This new feature allows users to generate content using Cohere AI. You provide your Cohere API key, a search prompt, and a word count, and it will return the generated content.
+
+### Usage
+To use the **aiTexGen** feature, follow these steps:
+```bash
+import { aiTexGen } from "get-reading-time/dist/index.js";
+```
+
+### Example Code
+- Create your [Api key](https://dashboard.cohere.com/api-keys) From here.
+```javascript
+// Replace this with your Cohere API key
+const apiKey = '<api-key>';
+const generator = new aiTexGen(apiKey);
+
+async function testGenerateContent() {
+    try {
+        // Define a topic and word count for testing
+        const topic = 'arduino';
+        const wordCount = 100;
+
+        // Call the generateContent method
+        const result = await generator.generateContent(topic, wordCount);
+
+        // Output the result in JSON format
+        console.log('Generated Content (JSON Format):');
+        console.log(JSON.stringify(result, null, 2)); // Pretty print the JSON output
+
+    } catch (error) {
+        console.error('Error during content generation:', error);
+    }
+}
+// Run the test
+testGenerateContent();
 ```
 ### Example Output
 ```json
 {
- "readingTime":  {
- "minutes":  0.05,
- "seconds":  5.23
- },
- "wordCount":  13,
- "characterCount":  68,
- "sentenceCount":  2,
- "linkCount":  1,
- "readabilityScore":  78.5,
- "sentiment":  "Positive",
- "keywords":  ["example",  "text",  "words",  "sentences",  "links"]
+  "topic": "arduino",
+  "content": "Arduino is an open-source electronics platform based on easy-to-use hardware and software. It's designed to make interactive projects accessible to everyone, from artists and designers to hobbyists and engineers. \n\nAt the heart of the Arduino platform is the Arduino board, a simple microcontroller board that can read inputs and turn them into outputs, such as turning on an LED light or activating a motor. \n\nWhat makes Arduino unique is its user-friendly approach, with a simplified programming language and easy-to-use hardware, making it a popular choice for beginners and professionals alike. With its versatility and robust community support, Arduino has become a go-to platform for creating interactive, sensor-based projects and prototypes."
 }
 ```
+
 ## Parameters
 
--   text: The text to be analyzed (required).
-    
--   wordsPerMinute: The reading speed in words per minute (optional, default is 200 words per minute).
-    
+- text: The text to be analyzed (required).
+- wordsPerMinute: The reading speed in words per minute (optional, default is 200 words per minute).
+- **apiKey**: Your Cohere API key to use this feature (required).
 
 ## Functions
 
@@ -93,45 +138,30 @@ try {
 
 Analyzes the provided text and returns an object containing:
 
--   readingTime: Estimated reading time in minutes and seconds.
-    
--   wordCount: Total word count.
-    
--   characterCount: Total character count (excluding spaces).
-    
--   sentenceCount: Total sentence count.
-    
--   linkCount: Number of links (URLs) in the text.
-    
--   readabilityScore: Flesch Reading Ease score (higher is easier to read).
-    
--   sentiment: Sentiment of the text (Positive, Negative, or Neutral).
-    
--   keywords: Top 5 SEO-friendly keywords or key phrases.
-    
+- readingTime: Estimated reading time in minutes and seconds.
+- wordCount: Total word count.
+- characterCount: Total character count (excluding spaces).
+- sentenceCount: Total sentence count.
+- linkCount: Number of links (URLs) in the text.
+- readabilityScore: Flesch Reading Ease score (higher is easier to read).
+- sentiment: Sentiment of the text (Positive, Negative, or Neutral).
+- keywords: Top 5 SEO-friendly keywords or key phrases.
+### Generate Content(topic: string, wordCount: number)
+Generates content based on the given topic and word count using the Cohere AI API and returns the generated content.
 
 ### Helper Functions
 
--   **cleanTextInput(text: string)**: Cleans and normalizes the input text.
-    
--   **calculateWordCount(text: string)**: Counts the number of words.
-    
--   **calculateCharacterCount(text: string)**: Counts the number of characters (excluding spaces).
-    
--   **calculateSentenceCount(text: string)**: Counts the number of sentences based on punctuation.
-    
--   **countLinks(text: string)**: Counts the number of links (URLs) in the text.
-    
--   **calculateReadabilityScore(text: string)**: Calculates the Flesch Reading Ease score.
-    
--   **analyzeSentiment(text: string)**: Analyzes sentiment using Sentiment.js.
-    
--   **extractKeywords(text: string)**: Extracts the top 5 SEO-friendly keywords or key phrases.
-    
--   **extractNGrams(words: string[])**: Extracts bi-grams and tri-grams from the list of words.
-    
--   **isStopWord(word: string, stopWords: Set<string>)**: Checks if a word is a stop word to exclude from keyword extraction.
-    
+- **cleanTextInput(text: string)**: Cleans and normalizes the input text.
+- **calculateWordCount(text: string)**: Counts the number of words.
+- **calculateCharacterCount(text: string)**: Counts the number of characters (excluding spaces).
+- **calculateSentenceCount(text: string)**: Counts the number of sentences based on punctuation.
+- **countLinks(text: string)**: Counts the number of links (URLs) in the text.
+- **calculateReadabilityScore(text: string)**: Calculates the Flesch Reading Ease score.
+- **analyzeSentiment(text: string)**: Analyzes sentiment using Sentiment.js.
+- **extractKeywords(text: string)**: Extracts the top 5 SEO-friendly keywords or key phrases.
+- **extractNGrams(words: string[])**: Extracts bi-grams and tri-grams from the list of words.
+- **isStopWord(word: string, stopWords: Set<string>)**: Checks if a word is a stop word to exclude from keyword extraction.
+- **generateContent(words: string[])**: Genarate text based on the query and word limit.
 
 ## Contributing
 
@@ -139,8 +169,9 @@ Feel free to fork the repository, make your changes, and submit a pull request.
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/nurahmed123/get-reading-time/blob/main/LICENSE) file for details.
+[![npm version](https://badge.fury.io/js/get-reading-time.svg)](https://www.npmjs.com/get-reading-time)
 
 ## Contact
 
-For any questions or inquiries, feel free to contact [[06nurahmed@gmail.com](06nurahmed@gmail.com)].
+For any questions or inquiries, feel free to contact [[06nurahmed@gmail.com](06nurahmed@gmail.com)].

package/dist/index.d.mts

@@ -14,4 +14,31 @@ interface TextAnalysisResult {
 }
 declare function analyzeText(text: string, wordsPerMinute?: number): TextAnalysisResult;
 
-export { analyzeText };
+/**
+ * Formats an article by correcting punctuation and capitalization,
+ * intelligently inferring sentence boundaries and adding missing punctuation.
+ *
+ * @param {string} article - The raw input string to be formatted.
+ * @returns {{ original: string, formatted: string }} - A JSON object with the original and formatted strings.
+ * @throws {TypeError} If the input is not a valid non-empty string.
+ */
+declare const getPunch: (article: string) => {
+    original: string;
+    formatted: string;
+};
+
+declare class AiTexGen {
+    private cohereClient;
+    constructor(apiKey: string);
+    private validateInputs;
+    generateContent(topic: string, wordCount?: number): Promise<{
+        topic: string;
+        content: string;
+    }>;
+    private processContent;
+    private extractTextFromObject;
+    private createErrorResponse;
+    private formatErrorDetails;
+}
+
+export { AiTexGen as aiTexGen, analyzeText, getPunch };

package/dist/index.d.ts

@@ -14,4 +14,31 @@ interface TextAnalysisResult {
 }
 declare function analyzeText(text: string, wordsPerMinute?: number): TextAnalysisResult;
 
-export { analyzeText };
+/**
+ * Formats an article by correcting punctuation and capitalization,
+ * intelligently inferring sentence boundaries and adding missing punctuation.
+ *
+ * @param {string} article - The raw input string to be formatted.
+ * @returns {{ original: string, formatted: string }} - A JSON object with the original and formatted strings.
+ * @throws {TypeError} If the input is not a valid non-empty string.
+ */
+declare const getPunch: (article: string) => {
+    original: string;
+    formatted: string;
+};
+
+declare class AiTexGen {
+    private cohereClient;
+    constructor(apiKey: string);
+    private validateInputs;
+    generateContent(topic: string, wordCount?: number): Promise<{
+        topic: string;
+        content: string;
+    }>;
+    private processContent;
+    private extractTextFromObject;
+    private createErrorResponse;
+    private formatErrorDetails;
+}
+
+export { AiTexGen as aiTexGen, analyzeText, getPunch };

package/dist/index.js

@@ -26,13 +26,37 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   mod
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
 
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  analyzeText: () => analyzeText
+  aiTexGen: () => AiTexGen,
+  analyzeText: () => analyzeText,
+  getPunch: () => getPunch
 });
 module.exports = __toCommonJS(index_exports);
+
+// src/utils/analyzeText.ts
 var import_sentiment = __toESM(require("sentiment"));
 var DEFAULT_READING_SPEED = 200;
 function analyzeText(text, wordsPerMinute = DEFAULT_READING_SPEED) {
@@ -160,7 +184,117 @@ function extractNGrams(words) {
 function isStopWord(word, stopWords) {
   return stopWords.has(word);
 }
+
+// src/utils/getPunch.ts
+var import_compromise = __toESM(require("compromise"));
+var getPunch = (article) => {
+  if (typeof article !== "string" || article.trim().length === 0) {
+    throw new TypeError("Invalid input: article must be a non-empty string.");
+  }
+  try {
+    const doc = (0, import_compromise.default)(article);
+    const formatted = doc.sentences().normalize().out("text");
+    return {
+      original: article.trim(),
+      formatted
+    };
+  } catch (error) {
+    throw new Error(`Error processing the article: ${error instanceof Error ? error.message : "Unknown error"}`);
+  }
+};
+
+// src/utils/aiTexGen.ts
+var import_cohere_ai = require("cohere-ai");
+var AiTexGen = class {
+  constructor(apiKey) {
+    if (!apiKey || typeof apiKey !== "string") {
+      throw this.createErrorResponse("API_KEY_MISSING", "A valid API key must be provided.", 400);
+    }
+    this.cohereClient = new import_cohere_ai.CohereClientV2({ token: apiKey });
+  }
+  // Validate user input (topic and word count)
+  validateInputs(topic, wordCount) {
+    if (typeof topic !== "string" || topic.trim().length === 0) {
+      throw this.createErrorResponse("INVALID_TOPIC", "Topic must be a non-empty string.", 400);
+    }
+    if (typeof wordCount !== "number" || wordCount <= 0) {
+      console.warn("Invalid word count provided. Defaulting to 100 words.");
+      wordCount = 100;
+    }
+  }
+  // Generate content using Cohere's API
+  generateContent(topic, wordCount = 100) {
+    return __async(this, null, function* () {
+      var _a;
+      try {
+        this.validateInputs(topic, wordCount);
+        const prompt = `Write a detailed article about ${topic}, aiming for maximum ${wordCount} words.`;
+        const response = yield this.cohereClient.chat({
+          model: "command-r-plus",
+          // Specify the model you want to use
+          messages: [
+            {
+              role: "user",
+              content: prompt
+              // Use the prompt with the topic and word count
+            }
+          ]
+        });
+        const content = this.processContent((_a = response.message) == null ? void 0 : _a.content);
+        return {
+          topic,
+          content
+        };
+      } catch (error) {
+        console.error("Error generating content from Cohere API:", error);
+        throw this.createErrorResponse("API_ERROR", "Failed to generate content from Cohere API.", 500, this.formatErrorDetails(error));
+      }
+    });
+  }
+  // Helper method to process the content and format it properly
+  processContent(content) {
+    if (!content || content.length === 0) {
+      return "No content generated or content is empty.";
+    }
+    return content.map((item) => {
+      if (typeof item === "string") {
+        return item.trim();
+      } else if (typeof item === "object") {
+        return this.extractTextFromObject(item);
+      }
+      return "";
+    }).join(" ").trim();
+  }
+  // Helper method to safely extract text from an object, if needed
+  extractTextFromObject(obj) {
+    if (obj && obj.text) {
+      return obj.text.trim();
+    }
+    return "";
+  }
+  // Helper method to create an error response with a status code
+  createErrorResponse(code, message, statusCode, details) {
+    return {
+      error: {
+        code,
+        message,
+        statusCode,
+        details: details || ""
+      }
+    };
+  }
+  // Helper method to format error details (narrowing down the 'unknown' type)
+  formatErrorDetails(error) {
+    if (error instanceof Error) {
+      return error.message;
+    } else {
+      return "An unknown error occurred.";
+    }
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  analyzeText
+  aiTexGen,
+  analyzeText,
+  getPunch
 });

package/dist/index.mjs

@@ -1,4 +1,25 @@
-// src/index.ts
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/utils/analyzeText.ts
 import Sentiment from "sentiment";
 var DEFAULT_READING_SPEED = 200;
 function analyzeText(text, wordsPerMinute = DEFAULT_READING_SPEED) {
@@ -126,6 +147,116 @@ function extractNGrams(words) {
 function isStopWord(word, stopWords) {
   return stopWords.has(word);
 }
+
+// src/utils/getPunch.ts
+import nlp from "compromise";
+var getPunch = (article) => {
+  if (typeof article !== "string" || article.trim().length === 0) {
+    throw new TypeError("Invalid input: article must be a non-empty string.");
+  }
+  try {
+    const doc = nlp(article);
+    const formatted = doc.sentences().normalize().out("text");
+    return {
+      original: article.trim(),
+      formatted
+    };
+  } catch (error) {
+    throw new Error(`Error processing the article: ${error instanceof Error ? error.message : "Unknown error"}`);
+  }
+};
+
+// src/utils/aiTexGen.ts
+import { CohereClientV2 } from "cohere-ai";
+var AiTexGen = class {
+  constructor(apiKey) {
+    if (!apiKey || typeof apiKey !== "string") {
+      throw this.createErrorResponse("API_KEY_MISSING", "A valid API key must be provided.", 400);
+    }
+    this.cohereClient = new CohereClientV2({ token: apiKey });
+  }
+  // Validate user input (topic and word count)
+  validateInputs(topic, wordCount) {
+    if (typeof topic !== "string" || topic.trim().length === 0) {
+      throw this.createErrorResponse("INVALID_TOPIC", "Topic must be a non-empty string.", 400);
+    }
+    if (typeof wordCount !== "number" || wordCount <= 0) {
+      console.warn("Invalid word count provided. Defaulting to 100 words.");
+      wordCount = 100;
+    }
+  }
+  // Generate content using Cohere's API
+  generateContent(topic, wordCount = 100) {
+    return __async(this, null, function* () {
+      var _a;
+      try {
+        this.validateInputs(topic, wordCount);
+        const prompt = `Write a detailed article about ${topic}, aiming for maximum ${wordCount} words.`;
+        const response = yield this.cohereClient.chat({
+          model: "command-r-plus",
+          // Specify the model you want to use
+          messages: [
+            {
+              role: "user",
+              content: prompt
+              // Use the prompt with the topic and word count
+            }
+          ]
+        });
+        const content = this.processContent((_a = response.message) == null ? void 0 : _a.content);
+        return {
+          topic,
+          content
+        };
+      } catch (error) {
+        console.error("Error generating content from Cohere API:", error);
+        throw this.createErrorResponse("API_ERROR", "Failed to generate content from Cohere API.", 500, this.formatErrorDetails(error));
+      }
+    });
+  }
+  // Helper method to process the content and format it properly
+  processContent(content) {
+    if (!content || content.length === 0) {
+      return "No content generated or content is empty.";
+    }
+    return content.map((item) => {
+      if (typeof item === "string") {
+        return item.trim();
+      } else if (typeof item === "object") {
+        return this.extractTextFromObject(item);
+      }
+      return "";
+    }).join(" ").trim();
+  }
+  // Helper method to safely extract text from an object, if needed
+  extractTextFromObject(obj) {
+    if (obj && obj.text) {
+      return obj.text.trim();
+    }
+    return "";
+  }
+  // Helper method to create an error response with a status code
+  createErrorResponse(code, message, statusCode, details) {
+    return {
+      error: {
+        code,
+        message,
+        statusCode,
+        details: details || ""
+      }
+    };
+  }
+  // Helper method to format error details (narrowing down the 'unknown' type)
+  formatErrorDetails(error) {
+    if (error instanceof Error) {
+      return error.message;
+    } else {
+      return "An unknown error occurred.";
+    }
+  }
+};
 export {
-  analyzeText
+  AiTexGen as aiTexGen,
+  analyzeText,
+  getPunch
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "get-reading-time",
-  "version": "1.0.4",
+  "version": "1.2.0",
   "main": "/dist/index.js",
   "module": "/dist/index.mjs",
   "types": "/dist/index.d.ts",
@@ -12,7 +12,11 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/nurahmed123/get-reading-time.git"
+    "url": "git+https://github.com/nurahmed123/get-reading-time.git",
+    "license": "https://github.com/nurahmed123/get-reading-time/blob/main/LICENSE"
+  },
+  "publishConfig": {
+    "registry": "https://www.npmjs.com/package/get-reading-time"
   },
   "keywords": [
     "Reading",
@@ -136,11 +140,15 @@
   "homepage": "https://github.com/nurahmed123/get-reading-time#readme",
   "description": "",
   "devDependencies": {
+    "@types/axios": "^0.9.36",
     "@types/node": "^22.10.2",
     "@types/sentiment": "^5.0.4",
     "typescript": "^5.7.2"
   },
   "dependencies": {
+    "axios": "^1.7.9",
+    "cohere-ai": "^7.15.0",
+    "compromise": "^14.14.3",
     "sentiment": "^5.0.2",
     "tsup": "^8.3.5"
   }