@apiverve/websitereadability 1.1.14 → 1.2.0

package/README.md

@@ -131,6 +131,11 @@ async function makeRequest() {
     "automatedReadabilityIndex": 22.6,
     "daleChallReadabilityScore": 17,
     "daleChallReadabilityScoreText": "average 13th to 15th-grade (college) student",
+    "wordCount": 634,
+    "sentenceCount": 29,
+    "readingTimeMinutes": 3,
+    "averageGradeLevel": 17.8,
+    "targetAudience": "post-graduate",
     "url": "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts"
   }
 }

package/index.d.ts

@@ -4,25 +4,42 @@ declare module '@apiverve/websitereadability' {
     secure?: boolean;
   }
 
+  /**
+   * Describes fields the current plan does not unlock. Locked fields arrive as null
+   * in `data`; `locked_fields` names them, using dot paths for nested fields.
+   * Absent when the plan unlocks everything.
+   */
+  export interface PremiumInfo {
+    message: string;
+    upgrade_url: string;
+    locked_fields: string[];
+  }
+
   export interface websitereadabilityResponse {
     status: string;
     error: string | null;
     data: WebsiteReadabilityData;
     code?: number;
+    premium?: PremiumInfo;
   }
 
 
   interface WebsiteReadabilityData {
-      fleschReadingEase:             number;
-      fleschReadingEaseText:         string;
-      fleschKincaidGrade:            number;
-      gunningFog:                    number;
-      colemanLiauIndex:              number;
-      smogIndex:                     number;
-      automatedReadabilityIndex:     number;
-      daleChallReadabilityScore:     number;
-      daleChallReadabilityScoreText: string;
-      url:                           string;
+      fleschReadingEase:             number | null;
+      fleschReadingEaseText:         null | string;
+      fleschKincaidGrade:            number | null;
+      gunningFog:                    number | null;
+      colemanLiauIndex:              number | null;
+      smogIndex:                     number | null;
+      automatedReadabilityIndex:     number | null;
+      daleChallReadabilityScore:     number | null;
+      daleChallReadabilityScoreText: null | string;
+      wordCount:                     number | null;
+      sentenceCount:                 number | null;
+      readingTimeMinutes:            number | null;
+      averageGradeLevel:             number | null;
+      targetAudience:                null | string;
+      url:                           null | string;
   }
 
   export default class websitereadabilityWrapper {

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@apiverve/websitereadability",
-  "version": "1.1.14",
+  "version": "1.2.0",
   "description": "Website Readability is a simple tool for analyzing the readability of a website. It returns the readability score of the website provided.",
   "main": "index.js",
   "types": "index.d.ts",
   "sideEffects": false,
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=18.0.0"
   },
   "files": [
     "index.js",
@@ -23,7 +23,7 @@
     "directory": "npm"
   },
   "keywords": [
-    ""
+    "website readability", "website readability api", "website readability tool", "website readability software", "website readability service"
   ],
   "author": {
     "name": "APIVerve",
@@ -41,8 +41,7 @@
     "dotenv": "^16.4.7"
   },
   "dependencies": {
-    "node-fetch": "^3.3.2",
-    "promise": "^8.3.0",
-    "axios": "1.13.2"
+    "axios": "1.13.2",
+    "form-data": "^4.0.1"
   }
 }