@apiverve/wordladder 1.1.13 → 1.2.0

package/README.md

@@ -63,7 +63,8 @@ var query = {
   start: "cold",
   end: "warm",
   difficulty: "medium",
-  count: 1
+  count: 1,
+  image: false
 };
 
 api.execute(query, function (error, data) {
@@ -86,7 +87,8 @@ var query = {
   start: "cold",
   end: "warm",
   difficulty: "medium",
-  count: 1
+  count: 1,
+  image: false
 };
 
 api.execute(query)
@@ -110,7 +112,8 @@ async function makeRequest() {
   start: "cold",
   end: "warm",
   difficulty: "medium",
-  count: 1
+  count: 1,
+  image: false
 };
 
     try {
@@ -133,25 +136,31 @@ async function makeRequest() {
   "data": {
     "puzzles": [
       {
-        "startWord": "LESS",
-        "endWord": "QUAT",
-        "steps": 4,
+        "startWord": "ANIL",
+        "endWord": "CUED",
+        "steps": 5,
         "solution": [
-          "LESS",
-          "LEST",
-          "BEST",
-          "BUST",
-          "BUAT",
-          "QUAT"
+          "ANIL",
+          "ARIL",
+          "ARID",
+          "IRID",
+          "IRED",
+          "CRED",
+          "CUED"
         ],
         "solvable": true,
-        "difficulty": "medium",
-        "hint": "(a) A pustule. [Obs.] (b) An annoying, worthless person. Sha"
+        "difficulty": "medium"
       }
     ],
     "count": 1,
     "difficulty": "medium",
-    "html": "<html><head><title>Word Ladder</title><style>body {font-family: Arial, sans-serif; padding: 20px; max-width: 600px; margin: 0 auto;}h1 {text-align: center; color: #4CAF50;}.puzzle {background: #f5f5f5; padding: 25px; margin: 20px 0; border-radius: 10px;}.words {display: flex; justify-content: space-between; align-items: center; margin: 20px 0;}.word {font-size: 28px; font-weight: bold; letter-spacing: 3px; padding: 15px 25px; border-radius: 10px;}.start {background: #4CAF50; color: white;}.end {background: #2196F3; color: white;}.arrow {font-size: 30px; color: #999;}.steps {text-align: center; font-size: 14px; color: #666; margin-bottom: 15px;}.ladder {display: flex; flex-direction: column; align-items: center; gap: 10px; margin: 20px 0;}.rung {width: 150px; height: 40px; border: 2px dashed #ccc; border-radius: 5px; display: flex; align-items: center; justify-content: center; font-size: 18px; letter-spacing: 5px;}.hint {font-size: 13px; color: #888; font-style: italic; margin-top: 10px;}</style></head><body><h1>Word Ladder</h1><p style='text-align:center;'>Change one letter at a time to get from the first word to the last</p><div class='puzzle'><div class='steps'>Puzzle #1 - 4 steps</div><div class='words'><span class='word start'>LESS</span><span class='arrow'>→</span><span class='word end'>QUAT</span></div><div class='ladder'><div class='rung'>_ _ _ _</div><div class='rung'>_ _ _ _</div><div class='rung'>_ _ _ _</div><div class='rung'>_ _ _ _</div></div><div class='hint'>End word hint: (a) A pustule. [Obs.] (b) An annoying, worthless person. Sha...</div></div></body></html>"
+    "html": "<html><head><title>Word Ladder</title><style>body {font-family: Arial, sans-serif; padding: 20px; max-width: 600px; margin: 0 auto;}h1 {text-align: center; color: #4CAF50;}.puzzle {background: #f5f5f5; padding: 25px; margin: 20px 0; border-radius: 10px;}.words {display: flex; justify-content: space-between; align-items: center; margin: 20px 0;}.word {font-size: 28px; font-weight: bold; letter-spacing: 3px; padding: 15px 25px; border-radius: 10px;}.start {background: #4CAF50; color: white;}.end {background: #2196F3; color: white;}.arrow {font-size: 30px; color: #999;}.steps {text-align: center; font-size: 14px; color: #666; margin-bottom: 15px;}.ladder {display: flex; flex-direction: column; align-items: center; gap: 10px; margin: 20px 0;}.rung {width: 150px; height: 40px; border: 2px dashed #ccc; border-radius: 5px; display: flex; align-items: center; justify-content: center; font-size: 18px; letter-spacing: 5px;}.hint {font-size: 13px; color: #888; font-style: italic; margin-top: 10px;}</style></head><body><h1>Word Ladder</h1><p style='text-align:center;'>Change one letter at a time to get from the first word to the last</p><div class='puzzle'><div class='steps'>Puzzle #1 - 5 steps</div><div class='words'><span class='word start'>ANIL</span><span class='arrow'>→</span><span class='word end'>CUED</span></div><div class='ladder'><div class='rung'>_ _ _ _</div><div class='rung'>_ _ _ _</div><div class='rung'>_ _ _ _</div><div class='rung'>_ _ _ _</div><div class='rung'>_ _ _ _</div></div></div></body></html>",
+    "image": {
+      "imageName": "6f0f9e5e-ce0d-4570-a706-8fc5ccbfc948_wordladder.png",
+      "format": ".png",
+      "downloadURL": "https://storage.googleapis.com/apiverve/APIData/wordladder/6f0f9e5e-ce0d-4570-a706-8fc5ccbfc948_wordladder.png?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1766010731&Signature=FQwH%2FqXC0eYHgHqGKfBoEETrcXALoIpkf2z7HCkmYcFu2IgL2uMbCBi22tEsrlY3yOkksRuZ56C2685lLi98CWvgCF1J9UrYaAWjFtLesnHZ0i%2B0SWYIy5wZLWnVq4UrJDLZVrvSe8lh21mQJrduVY8QqV%2FI0sViUlnlndLMFUfhEQedKYAGRtmXjJlpl1YA9A9%2BtJoqRvMm4YStfJyLJmExPQKnPiRoP6EB6%2B8%2F1WUq5vH3%2BWglijVroxaJ%2BJy6kgQ8qTuVX9%2FzFi8R0DDHZtd0IpcTL8EBvNvHnjRPS4lZB%2Bm3k9GCxqGCnsj8pssu6ymtzGNEqA%2BBqAthODekWw%3D%3D",
+      "expires": 1766010731681
+    }
   }
 }
 ```

package/index.d.ts

@@ -4,29 +4,48 @@ declare module '@apiverve/wordladder' {
     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 wordladderResponse {
     status: string;
     error: string | null;
     data: WordLadderGeneratorData;
     code?: number;
+    premium?: PremiumInfo;
   }
 
 
   interface WordLadderGeneratorData {
       puzzles:    Puzzle[];
-      count:      number;
-      difficulty: string;
-      html:       string;
+      count:      number | null;
+      difficulty: null | string;
+      html:       null | string;
+      image:      Image;
+  }
+  
+  interface Image {
+      imageName:   null | string;
+      format:      null | string;
+      downloadURL: null | string;
+      expires:     number | null;
   }
   
   interface Puzzle {
-      startWord:  string;
-      endWord:    string;
-      steps:      number;
-      solution:   string[];
-      solvable:   boolean;
-      difficulty: string;
-      hint:       string;
+      startWord:  null | string;
+      endWord:    null | string;
+      steps:      number | null;
+      solution:   (null | string)[];
+      solvable:   boolean | null;
+      difficulty: null | string;
   }
 
   export default class wordladderWrapper {

package/index.js

@@ -13,16 +13,10 @@ class wordladderWrapper {
             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') {
@@ -36,7 +30,7 @@ class wordladderWrapper {
         this.baseURL = 'https://api.apiverve.com/v1/wordladder';
 
         // Validation rules for parameters (generated from schema)
-        this.validationRules = {"start":{"type":"string","required":false,"minLength":3,"maxLength":6},"end":{"type":"string","required":false,"minLength":3,"maxLength":6},"difficulty":{"type":"string","required":false,"default":"medium"},"count":{"type":"integer","required":false,"min":1,"max":5,"default":1}};
+        this.validationRules = {"start":{"type":"string","required":false,"minLength":3,"maxLength":6},"end":{"type":"string","required":false,"minLength":3,"maxLength":6},"difficulty":{"type":"string","required":false,"default":"medium"},"count":{"type":"integer","required":false,"min":1,"max":5,"default":1},"image":{"type":"boolean","required":false,"default":false}};
     }
 
     /**

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@apiverve/wordladder",
-  "version": "1.1.13",
+  "version": "1.2.0",
   "description": "Word Ladder Generator creates puzzles where players transform one word into another by changing one letter at a time, with each step forming a valid word.",
   "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": [
-    ""
+    "word ladder", "word chain", "doublets", "word puzzle", "vocabulary game"
   ],
   "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"
   }
 }