@apiverve/wordlehelper 1.1.13 → 1.2.0

package/README.md

@@ -134,21 +134,19 @@ async function makeRequest() {
   "status": "ok",
   "error": null,
   "data": {
-    "matchCount": 13,
+    "matchCount": 11,
     "suggestions": [
-      "ayrie",
       "adore",
-      "aigre",
       "afore",
-      "adure",
       "afire",
       "argue",
       "aerie",
       "azure",
-      "arace",
+      "aurae",
+      "arame",
       "agree",
       "aware",
-      "arere"
+      "areae"
     ],
     "filters": {
       "green": {

package/index.d.ts

@@ -4,25 +4,37 @@ declare module '@apiverve/wordlehelper' {
     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 wordlehelperResponse {
     status: string;
     error: string | null;
     data: WordleHelperData;
     code?: number;
+    premium?: PremiumInfo;
   }
 
 
   interface WordleHelperData {
-      matchCount:  number;
-      suggestions: string[];
+      matchCount:  number | null;
+      suggestions: (null | string)[];
       filters:     Filters;
-      pattern:     string;
+      pattern:     null | string;
   }
   
   interface Filters {
-      green:  { [key: string]: string };
-      yellow: string[];
-      gray:   string[];
+      green:  { [key: string]: null | string };
+      yellow: (null | string)[];
+      gray:   (null | string)[];
   }
 
   export default class wordlehelperWrapper {

package/index.js

@@ -13,16 +13,10 @@ class wordlehelperWrapper {
             throw new Error('API key must be provided as a non-empty string. Get your API key at: https://apiverve.com');
         }
 
-        // Validate API key format (GUID or alphanumeric with hyphens)
-        const apiKeyPattern = /^[a-zA-Z0-9-]+$/;
+        // Validate API key format (GUID, prefixed keys like apv_xxx, or alphanumeric)
+        const apiKeyPattern = /^[a-zA-Z0-9_-]+$/;
         if (!apiKeyPattern.test(api_key)) {
-            throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens. Get your API key at: https://apiverve.com');
-        }
-
-        // Check minimum length (GUIDs are typically 36 chars with hyphens, or 32 without)
-        const trimmedKey = api_key.replace(/-/g, '');
-        if (trimmedKey.length < 32) {
-            throw new Error('Invalid API key. API key appears to be too short. Get your API key at: https://apiverve.com');
+            throw new Error('Invalid API key format. API key must be alphanumeric and may contain hyphens and underscores. Get your API key at: https://apiverve.com');
         }
 
         if (typeof secure !== 'boolean') {

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@apiverve/wordlehelper",
-  "version": "1.1.13",
+  "version": "1.2.0",
   "description": "Wordle Helper finds possible 5-letter word solutions based on known letter positions, letters in wrong positions, and eliminated letters.",
   "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": [
-    ""
+    "wordle helper", "wordle solver", "word game", "five letter words", "word puzzle"
   ],
   "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"
   }
 }