get-reading-time 1.3.4 → 1.3.5

package/.github/workflows/publish.yml

@@ -0,0 +1,58 @@
+name: Publish get-reading-time to npm
+
+on:
+  # Trigger automatically when pushing to main or master
+  push:
+    branches:
+      - main
+      - master
+  # Trigger when a GitHub Release is created
+  release:
+    types: [created]
+  # Allow manual trigger from the GitHub Actions tab
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20' # the node version to use
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm install --legacy-peer-deps --force
+
+      - name: Build the package
+        run: npm run build
+
+      - name: Publish to NPM
+        run: |
+            npm publish --access public
+        env:
+          # This connects the step to the token we'll create in GitHub secrets
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Setup Node.js for GitHub Packages
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://npm.pkg.github.com'
+
+      - name: Publish to GitHub Packages
+        run: |
+          # GitHub Packages requires the package name to be scoped to the repository owner
+          npm pkg set name="@nurahmed123/get-reading-time"
+          npm publish
+        env:
+          # The GITHUB_TOKEN is automatically provided by GitHub Actions!
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/dist/index.d.mts

@@ -45,7 +45,7 @@ interface TextAnalysisResult {
  */
 declare function analyzeText(text: string, wordsPerMinute?: number): TextAnalysisResult;
 
-type ApiResponse$3 = {
+type ApiResponse$2 = {
     /** The corrected text output */
     content?: string;
     /** Error message if the request fails */
@@ -65,10 +65,10 @@ type ApiResponse$3 = {
  * console.log(result.content); // "Hello, how are you?"
  * ```
  */
-declare function getPunch(text: string): Promise<ApiResponse$3>;
+declare function getPunch(text: string): Promise<ApiResponse$2>;
 
 type SupportedLanguages = "English" | "Spanish" | "French" | "German" | "Finnish" | "Chinese" | "Japanese" | "Arabic" | "Russian" | "Hindi" | "Bengali" | "Portuguese" | "Korean" | "Italian" | "Dutch" | "Turkish" | "Polish" | "Swedish" | "Thai" | "Greek" | "Hebrew" | "Vietnamese" | "Indonesian" | "Filipino" | "Romanian" | "Czech" | "Hungarian" | "Danish" | "Norwegian" | "Ukrainian" | "Malay" | "Urdu" | "Persian (Farsi)" | "Tamil" | "Telugu" | "Marathi" | "Gujarati" | "Punjabi" | "Swahili" | "Hausa" | "Yoruba" | "Zulu" | "Burmese" | "Khmer" | "Lao";
-type ApiResponse$2 = {
+type ApiResponse$1 = {
     /** The translated content */
     content?: string;
     /** Error message, if any */
@@ -89,29 +89,7 @@ type ApiResponse$2 = {
  * console.log(result.content); // "Bonjour, monde!"
  * ```
  */
-declare function langTrans(content: string, language: SupportedLanguages): Promise<ApiResponse$2>;
-
-type ApiResponse$1 = {
-    /** The corrected text output */
-    content?: string;
-    /** Error message if the request fails */
-    error?: string;
-    /** HTTP Status Code (200 = Success, 500 = Error) */
-    status_code: number;
-};
-/**
- * ✨ Fixes capitalization and punctuation in a given text.
- *
- * @param text - The text that needs correction.
- * @returns A Promise resolving to an object with the corrected text or an error message.
- *
- * @example
- * ```typescript
- * const result = await askAI("How are you?").then((result) => result.content);;
- * console.log(result.content); // "I am good"
- * ```
- */
-declare function askAI(text: string): Promise<ApiResponse$1>;
+declare function langTrans(content: string, language: SupportedLanguages): Promise<ApiResponse$1>;
 
 /**
  * Represents the final response returned by the tableMaker function.
@@ -170,4 +148,4 @@ declare class aiTexGen {
     private formatErrorDetails;
 }
 
-export { aiTexGen, analyzeText, askAI, getPunch, langTrans, tableMaker };
+export { aiTexGen, analyzeText, getPunch, langTrans, tableMaker };

package/dist/index.d.ts

@@ -45,7 +45,7 @@ interface TextAnalysisResult {
  */
 declare function analyzeText(text: string, wordsPerMinute?: number): TextAnalysisResult;
 
-type ApiResponse$3 = {
+type ApiResponse$2 = {
     /** The corrected text output */
     content?: string;
     /** Error message if the request fails */
@@ -65,10 +65,10 @@ type ApiResponse$3 = {
  * console.log(result.content); // "Hello, how are you?"
  * ```
  */
-declare function getPunch(text: string): Promise<ApiResponse$3>;
+declare function getPunch(text: string): Promise<ApiResponse$2>;
 
 type SupportedLanguages = "English" | "Spanish" | "French" | "German" | "Finnish" | "Chinese" | "Japanese" | "Arabic" | "Russian" | "Hindi" | "Bengali" | "Portuguese" | "Korean" | "Italian" | "Dutch" | "Turkish" | "Polish" | "Swedish" | "Thai" | "Greek" | "Hebrew" | "Vietnamese" | "Indonesian" | "Filipino" | "Romanian" | "Czech" | "Hungarian" | "Danish" | "Norwegian" | "Ukrainian" | "Malay" | "Urdu" | "Persian (Farsi)" | "Tamil" | "Telugu" | "Marathi" | "Gujarati" | "Punjabi" | "Swahili" | "Hausa" | "Yoruba" | "Zulu" | "Burmese" | "Khmer" | "Lao";
-type ApiResponse$2 = {
+type ApiResponse$1 = {
     /** The translated content */
     content?: string;
     /** Error message, if any */
@@ -89,29 +89,7 @@ type ApiResponse$2 = {
  * console.log(result.content); // "Bonjour, monde!"
  * ```
  */
-declare function langTrans(content: string, language: SupportedLanguages): Promise<ApiResponse$2>;
-
-type ApiResponse$1 = {
-    /** The corrected text output */
-    content?: string;
-    /** Error message if the request fails */
-    error?: string;
-    /** HTTP Status Code (200 = Success, 500 = Error) */
-    status_code: number;
-};
-/**
- * ✨ Fixes capitalization and punctuation in a given text.
- *
- * @param text - The text that needs correction.
- * @returns A Promise resolving to an object with the corrected text or an error message.
- *
- * @example
- * ```typescript
- * const result = await askAI("How are you?").then((result) => result.content);;
- * console.log(result.content); // "I am good"
- * ```
- */
-declare function askAI(text: string): Promise<ApiResponse$1>;
+declare function langTrans(content: string, language: SupportedLanguages): Promise<ApiResponse$1>;
 
 /**
  * Represents the final response returned by the tableMaker function.
@@ -170,4 +148,4 @@ declare class aiTexGen {
     private formatErrorDetails;
 }
 
-export { aiTexGen, analyzeText, askAI, getPunch, langTrans, tableMaker };
+export { aiTexGen, analyzeText, getPunch, langTrans, tableMaker };

package/dist/index.js

@@ -52,7 +52,6 @@ var index_exports = {};
 __export(index_exports, {
   aiTexGen: () => aiTexGen,
   analyzeText: () => analyzeText,
-  askAI: () => askAI,
   getPunch: () => getPunch,
   langTrans: () => langTrans,
   tableMaker: () => tableMaker
@@ -251,42 +250,9 @@ function langTrans(content, language) {
   });
 }
 
-// src/utils/askAI.ts
+// src/utils/tableMaker.ts
 var import_axios3 = __toESM(require("axios"));
 var API_URL3 = "https://ai.hackclub.com/chat/completions";
-function askAI(text) {
-  return __async(this, null, function* () {
-    var _a, _b, _c, _d, _e, _f;
-    try {
-      const response = yield import_axios3.default.post(API_URL3, {
-        messages: [
-          {
-            role: "user",
-            content: `"${text}"`
-          }
-        ],
-        temperature: 0
-        // Keep corrections consistent
-      });
-      const correctedText = (_d = (_c = (_b = (_a = response.data.choices) == null ? void 0 : _a[0]) == null ? void 0 : _b.message) == null ? void 0 : _c.content) == null ? void 0 : _d.trim();
-      if (!correctedText) {
-        console.warn("API returned no content.");
-        return { content: "No content generated", status_code: 200 };
-      }
-      return { content: correctedText, status_code: 200 };
-    } catch (error) {
-      console.error("Error :", error);
-      return {
-        error: ((_f = (_e = error.response) == null ? void 0 : _e.data) == null ? void 0 : _f.error) || "Failed to get response from the AI server.",
-        status_code: 500
-      };
-    }
-  });
-}
-
-// src/utils/tableMaker.ts
-var import_axios4 = __toESM(require("axios"));
-var API_URL4 = "https://ai.hackclub.com/chat/completions";
 function tableMaker(content) {
   return __async(this, null, function* () {
     var _a, _b, _c, _d, _e, _f, _g;
@@ -294,7 +260,7 @@ function tableMaker(content) {
       return { error: "Input data cannot be empty.", status_code: 400 };
     }
     try {
-      const response = yield import_axios4.default.post(API_URL4, {
+      const response = yield import_axios3.default.post(API_URL3, {
         messages: [
           {
             role: "user",
@@ -348,7 +314,7 @@ function formatMarkdownTable(table) {
 }
 
 // src/utils/aiTexGen.ts
-var import_axios5 = __toESM(require("axios"));
+var import_axios4 = __toESM(require("axios"));
 var aiTexGen = class {
   // Constructor initializes the API URL
   constructor() {
@@ -379,7 +345,7 @@ var aiTexGen = class {
         this.validateInputs(topic, wordCount);
         const formatInstruction = markdown ? "Use proper Markdown formatting." : "Use plain text formatting.";
         const prompt = `Write a detailed article about ${topic}, aiming for a maximum of ${wordCount} words. ${formatInstruction}`;
-        const response = yield import_axios5.default.post(this.apiUrl, {
+        const response = yield import_axios4.default.post(this.apiUrl, {
           messages: [
             {
               role: "user",
@@ -426,7 +392,6 @@ var aiTexGen = class {
 0 && (module.exports = {
   aiTexGen,
   analyzeText,
-  askAI,
   getPunch,
   langTrans,
   tableMaker

package/dist/index.mjs

@@ -211,42 +211,9 @@ function langTrans(content, language) {
   });
 }
 
-// src/utils/askAI.ts
+// src/utils/tableMaker.ts
 import axios3 from "axios";
 var API_URL3 = "https://ai.hackclub.com/chat/completions";
-function askAI(text) {
-  return __async(this, null, function* () {
-    var _a, _b, _c, _d, _e, _f;
-    try {
-      const response = yield axios3.post(API_URL3, {
-        messages: [
-          {
-            role: "user",
-            content: `"${text}"`
-          }
-        ],
-        temperature: 0
-        // Keep corrections consistent
-      });
-      const correctedText = (_d = (_c = (_b = (_a = response.data.choices) == null ? void 0 : _a[0]) == null ? void 0 : _b.message) == null ? void 0 : _c.content) == null ? void 0 : _d.trim();
-      if (!correctedText) {
-        console.warn("API returned no content.");
-        return { content: "No content generated", status_code: 200 };
-      }
-      return { content: correctedText, status_code: 200 };
-    } catch (error) {
-      console.error("Error :", error);
-      return {
-        error: ((_f = (_e = error.response) == null ? void 0 : _e.data) == null ? void 0 : _f.error) || "Failed to get response from the AI server.",
-        status_code: 500
-      };
-    }
-  });
-}
-
-// src/utils/tableMaker.ts
-import axios4 from "axios";
-var API_URL4 = "https://ai.hackclub.com/chat/completions";
 function tableMaker(content) {
   return __async(this, null, function* () {
     var _a, _b, _c, _d, _e, _f, _g;
@@ -254,7 +221,7 @@ function tableMaker(content) {
       return { error: "Input data cannot be empty.", status_code: 400 };
     }
     try {
-      const response = yield axios4.post(API_URL4, {
+      const response = yield axios3.post(API_URL3, {
         messages: [
           {
             role: "user",
@@ -308,7 +275,7 @@ function formatMarkdownTable(table) {
 }
 
 // src/utils/aiTexGen.ts
-import axios5 from "axios";
+import axios4 from "axios";
 var aiTexGen = class {
   // Constructor initializes the API URL
   constructor() {
@@ -339,7 +306,7 @@ var aiTexGen = class {
         this.validateInputs(topic, wordCount);
         const formatInstruction = markdown ? "Use proper Markdown formatting." : "Use plain text formatting.";
         const prompt = `Write a detailed article about ${topic}, aiming for a maximum of ${wordCount} words. ${formatInstruction}`;
-        const response = yield axios5.post(this.apiUrl, {
+        const response = yield axios4.post(this.apiUrl, {
           messages: [
             {
               role: "user",
@@ -385,7 +352,6 @@ var aiTexGen = class {
 export {
   aiTexGen,
   analyzeText,
-  askAI,
   getPunch,
   langTrans,
   tableMaker

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "get-reading-time",
-  "version": "1.3.4",
+  "version": "1.3.5",
   "main": "/dist/index.js",
   "module": "/dist/index.mjs",
   "types": "/dist/index.d.ts",
@@ -9,14 +9,14 @@
     "start": "node dist/test.js",
     "lint": "tsc",
     "prepare": "npm run build"
-  },
+  }, 
   "repository": {
     "type": "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"
+    "access": "public"
   },
   "keywords": [
     "get-reading-time",