get-reading-time 1.2.0 → 1.2.1

package/README.md

@@ -1,3 +1,4 @@
+
 # 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.
@@ -13,6 +14,7 @@ A simple text analysis tool that provides insights into text such as reading tim
 - **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.
+- **Automatic Punctuation and Capitalization**: Automatically adds proper punctuation and capitalizes the beginning of sentences in a provided text.
 
 ## Installation
 
@@ -126,6 +128,46 @@ testGenerateContent();
 }
 ```
 
+### Automatic Punctuation and Capitalization
+
+You can now pass an article to the `analyzeText` function, and it will automatically fix punctuation and capitalize the first letter of sentences. This feature helps to improve the readability of raw text.
+
+#### Example Code
+Import the package and follow the steps: 
+```javascript
+import { getPunch } from 'get-reading-time/dist/index.js';
+```
+
+```javascript
+// Example to test with a string
+const content = "once a lion a fox and a wolf went hunting they ultimately spotted a stag and killed him for their food while sharing the hunt quarter me this stag roared the lion and other animals skinned and cut the spoil into four equal parts";
+async function GetPunch() {
+    try {
+        // Call the getPunch function with content
+        const result = await getPunch(content);
+
+        // Check the result and log it as a formatted JSON response
+        if (result.status_code === 200) {
+            console.log(JSON.stringify(result, null, 2));
+        } else {
+            console.error("Error:", JSON.stringify(result, null, 2));
+        }
+    } catch (error) {
+        // Handle unexpected errors
+        console.error("Unexpected Error:", error);
+    }
+}
+// Run the test
+GetPunch();
+```
+
+### Example Output
+```json
+{
+  "content": "Once a Lion, a Fox and a Wolf went hunting, they ultimately found a stag and killed him for their food while sharing the hunt quarter me. This stag roared the Lion and other animals skinned and cut the spoil into four equal parts.",
+  "status_code": 200
+}
+```
 ## Parameters
 
 - text: The text to be analyzed (required).
@@ -162,6 +204,7 @@ Generates content based on the given topic and word count using the Cohere AI AP
 - **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.
+- **autoPunctuateAndCapitalize(text: string)**: Adds punctuation and capitalization to the content.
 
 ## Contributing
 

package/dist/index.d.mts

@@ -14,18 +14,13 @@ interface TextAnalysisResult {
 }
 declare function analyzeText(text: string, wordsPerMinute?: number): TextAnalysisResult;
 
-/**
- * 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;
+type ApiResponse = {
+    formatted_text?: string;
+    error?: string;
+    status_code: number;
+    content?: string;
 };
+declare function getPunch(next: string): Promise<ApiResponse>;
 
 declare class AiTexGen {
     private cohereClient;

package/dist/index.d.ts

@@ -14,18 +14,13 @@ interface TextAnalysisResult {
 }
 declare function analyzeText(text: string, wordsPerMinute?: number): TextAnalysisResult;
 
-/**
- * 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;
+type ApiResponse = {
+    formatted_text?: string;
+    error?: string;
+    status_code: number;
+    content?: string;
 };
+declare function getPunch(next: string): Promise<ApiResponse>;
 
 declare class AiTexGen {
     private cohereClient;

package/dist/index.js

@@ -186,22 +186,29 @@ function isStopWord(word, stopWords) {
 }
 
 // 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"}`);
-  }
-};
+var import_axios = __toESM(require("axios"));
+var API_URL = "https://e4fc-35-185-85-107.ngrok-free.app/get-reading-time";
+var SECRET_CODE = "amrseccode";
+function getPunch(next) {
+  return __async(this, null, function* () {
+    var _a;
+    try {
+      const response = yield import_axios.default.post(API_URL, {
+        secret_code: SECRET_CODE,
+        content: next
+      });
+      return {
+        content: response.data.formatted_text || "No content returned",
+        status_code: 200
+      };
+    } catch (error) {
+      return {
+        error: ((_a = error.response) == null ? void 0 : _a.data) || "Failed to get response from the server.",
+        status_code: 500
+      };
+    }
+  });
+}
 
 // src/utils/aiTexGen.ts
 var import_cohere_ai = require("cohere-ai");

package/dist/index.mjs

@@ -149,22 +149,29 @@ function isStopWord(word, stopWords) {
 }
 
 // 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"}`);
-  }
-};
+import axios from "axios";
+var API_URL = "https://e4fc-35-185-85-107.ngrok-free.app/get-reading-time";
+var SECRET_CODE = "amrseccode";
+function getPunch(next) {
+  return __async(this, null, function* () {
+    var _a;
+    try {
+      const response = yield axios.post(API_URL, {
+        secret_code: SECRET_CODE,
+        content: next
+      });
+      return {
+        content: response.data.formatted_text || "No content returned",
+        status_code: 200
+      };
+    } catch (error) {
+      return {
+        error: ((_a = error.response) == null ? void 0 : _a.data) || "Failed to get response from the server.",
+        status_code: 500
+      };
+    }
+  });
+}
 
 // src/utils/aiTexGen.ts
 import { CohereClientV2 } from "cohere-ai";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "get-reading-time",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "main": "/dist/index.js",
   "module": "/dist/index.mjs",
   "types": "/dist/index.d.ts",
@@ -148,7 +148,6 @@
   "dependencies": {
     "axios": "^1.7.9",
     "cohere-ai": "^7.15.0",
-    "compromise": "^14.14.3",
     "sentiment": "^5.0.2",
     "tsup": "^8.3.5"
   }