@apiverve/wordscramble 1.1.13 → 1.2.0

package/README.md

@@ -61,7 +61,8 @@ Using the API is simple. All you have to do is make a request. The API will retu
 ```javascript
 var query = {
   difficulty: "medium",
-  count: 5
+  count: 5,
+  image: false
 };
 
 api.execute(query, function (error, data) {
@@ -82,7 +83,8 @@ You can also use promises to make requests. The API returns a promise that you c
 ```javascript
 var query = {
   difficulty: "medium",
-  count: 5
+  count: 5,
+  image: false
 };
 
 api.execute(query)
@@ -104,7 +106,8 @@ You can also use async/await to make requests. The API returns a promise that yo
 async function makeRequest() {
     var query = {
   difficulty: "medium",
-  count: 5
+  count: 5,
+  image: false
 };
 
     try {
@@ -127,39 +130,40 @@ async function makeRequest() {
   "data": {
     "puzzles": [
       {
-        "scrambled": "AFYLER",
-        "answer": "FLAYER",
-        "letterCount": 6,
-        "hint": "One who strips off the skin."
+        "scrambled": "ISIEMM",
+        "answer": "IMMIES",
+        "letterCount": 6
       },
       {
-        "scrambled": "PUHIRRC",
-        "answer": "CHIRRUP",
-        "letterCount": 7,
-        "hint": "To quicken or animate by chirping; to cherup.  To chirp. Tennyson. The criket chirrups on the hearth..."
+        "scrambled": "DRIGIANN",
+        "answer": "DRAINING",
+        "letterCount": 8
       },
       {
-        "scrambled": "PAINTACO",
-        "answer": "PACATION",
-        "letterCount": 8,
-        "hint": "The act of pacifying; a peacemaking.  Coleridge."
+        "scrambled": "RDAKCE",
+        "answer": "ARCKED",
+        "letterCount": 6
       },
       {
-        "scrambled": "OMADTSI",
-        "answer": "MASTOID",
-        "letterCount": 7,
-        "hint": "(a) Resembling the nipple or the breast; -- applied specifically to a process of the temporal bone b..."
+        "scrambled": "ERTHASDB",
+        "answer": "BREADTHS",
+        "letterCount": 8
       },
       {
-        "scrambled": "CRVELAA",
-        "answer": "ACERVAL",
-        "letterCount": 7,
-        "hint": "Pertaining to a heap. [Obs.]"
+        "scrambled": "SISSNASA",
+        "answer": "ASSASSIN",
+        "letterCount": 8
       }
     ],
     "count": 5,
     "difficulty": "medium",
-    "html": "<html><head><title>Word Scramble Puzzle</title><style>body {font-family: Arial, sans-serif; padding: 20px; max-width: 600px; margin: 0 auto;}h1 {text-align: center; color: #333;}.puzzle {background: #f5f5f5; padding: 20px; margin: 15px 0; border-radius: 10px;}.scrambled {font-size: 28px; font-weight: bold; letter-spacing: 5px; color: #2196F3; text-align: center;}.hint {font-size: 14px; color: #666; margin-top: 10px; font-style: italic;}.answer-line {margin-top: 15px; border-bottom: 2px solid #333; height: 30px;}.number {font-size: 14px; color: #999;}</style></head><body><h1>Word Scramble</h1><div class='puzzle'><div class='number'>#1 (6 letters)</div><div class='scrambled'>AFYLER</div><div class='hint'>Hint: One who strips off the skin.</div><div class='answer-line'></div></div><div class='puzzle'><div class='number'>#2 (7 letters)</div><div class='scrambled'>PUHIRRC</div><div class='hint'>Hint: To quicken or animate by chirping; to cherup.  To chirp. Tennyson. The criket chirrups on the hearth...</div><div class='answer-line'></div></div><div class='puzzle'><div class='number'>#3 (8 letters)</div><div class='scrambled'>PAINTACO</div><div class='hint'>Hint: The act of pacifying; a peacemaking.  Coleridge.</div><div class='answer-line'></div></div><div class='puzzle'><div class='number'>#4 (7 letters)</div><div class='scrambled'>OMADTSI</div><div class='hint'>Hint: (a) Resembling the nipple or the breast; -- applied specifically to a process of the temporal bone b...</div><div class='answer-line'></div></div><div class='puzzle'><div class='number'>#5 (7 letters)</div><div class='scrambled'>CRVELAA</div><div class='hint'>Hint: Pertaining to a heap. [Obs.]</div><div class='answer-line'></div></div></body></html>"
+    "html": "<html><head><title>Word Scramble Puzzle</title><style>body {font-family: Arial, sans-serif; padding: 20px; max-width: 600px; margin: 0 auto;}h1 {text-align: center; color: #333;}.puzzle {background: #f5f5f5; padding: 20px; margin: 15px 0; border-radius: 10px;}.scrambled {font-size: 28px; font-weight: bold; letter-spacing: 5px; color: #2196F3; text-align: center;}.hint {font-size: 14px; color: #666; margin-top: 10px; font-style: italic;}.answer-line {margin-top: 15px; border-bottom: 2px solid #333; height: 30px;}.number {font-size: 14px; color: #999;}</style></head><body><h1>Word Scramble</h1><div class='puzzle'><div class='number'>#1 (6 letters)</div><div class='scrambled'>ISIEMM</div><div class='answer-line'></div></div><div class='puzzle'><div class='number'>#2 (8 letters)</div><div class='scrambled'>DRIGIANN</div><div class='answer-line'></div></div><div class='puzzle'><div class='number'>#3 (6 letters)</div><div class='scrambled'>RDAKCE</div><div class='answer-line'></div></div><div class='puzzle'><div class='number'>#4 (8 letters)</div><div class='scrambled'>ERTHASDB</div><div class='answer-line'></div></div><div class='puzzle'><div class='number'>#5 (8 letters)</div><div class='scrambled'>SISSNASA</div><div class='answer-line'></div></div></body></html>",
+    "image": {
+      "imageName": "d1ae484c-e879-4a0e-95b0-bfa872fa758a_wordscramble.png",
+      "format": ".png",
+      "downloadURL": "https://storage.googleapis.com/apiverve/APIData/wordscramble/d1ae484c-e879-4a0e-95b0-bfa872fa758a_wordscramble.png?GoogleAccessId=635500398038-compute%40developer.gserviceaccount.com&Expires=1766010755&Signature=A9uZl5RTt%2Bk0WWM4onUMA5OyLA4xXdvR2iar2gjYoNWpdlLgYreoRvdOSYdbKpXOUENwtFphQIS6AU5iOKeAD6zC47jFAgFPPR%2BiVJjdluhg%2B37xJXMzSaU3uaFRkO4YWu2zAgSRxPNgtMM3ahbGlU5H5Nv6GGuLBihmIPcw6IVhJXG1LBzt4Vat7FEnfU4GuwJhEcpYINhkuIPTdN7yy%2FjSeBq7ZAgvwJuzDI13Ng5mFcE4uB1qB5B9AiL%2BApnyqoAJljXJbbgzHCtwwg%2FCtTlzMa0C4Biy1ka4f%2Bjf%2Bs8c07khRku4b6MNvuMiRVhjw4tRb3D7Hui%2Bx%2FWyaoB6Pg%3D%3D",
+      "expires": 1766010755245
+    }
   }
 }
 ```

package/index.d.ts

@@ -4,26 +4,45 @@ declare module '@apiverve/wordscramble' {
     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 wordscrambleResponse {
     status: string;
     error: string | null;
     data: WordScrambleGeneratorData;
     code?: number;
+    premium?: PremiumInfo;
   }
 
 
   interface WordScrambleGeneratorData {
       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 {
-      scrambled:   string;
-      answer:      string;
-      letterCount: number;
-      hint:        string;
+      scrambled:   null | string;
+      answer:      null | string;
+      letterCount: number | null;
   }
 
   export default class wordscrambleWrapper {

package/index.js

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

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@apiverve/wordscramble",
-  "version": "1.1.13",
+  "version": "1.2.0",
   "description": "Word Scramble Generator creates puzzles where players unscramble letters to form words, with optional hints from dictionary definitions.",
   "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 scramble", "anagram", "word puzzle", "unscramble", "jumble"
   ],
   "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"
   }
 }