@apiverve/wordladder 1.1.12

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 APIVerve, and EvlarSoft LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,187 @@
+# Word Ladder Generator API
+
+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.
+
+![Build Status](https://img.shields.io/badge/build-passing-green)
+![Code Climate](https://img.shields.io/badge/maintainability-B-purple)
+![Prod Ready](https://img.shields.io/badge/production-ready-blue)
+
+This is a Javascript Wrapper for the [Word Ladder Generator API](https://apiverve.com/marketplace/wordladder)
+
+---
+
+## Installation
+
+Using npm:
+```shell
+npm install @apiverve/wordladder
+```
+
+Using yarn:
+```shell
+yarn add @apiverve/wordladder
+```
+
+---
+
+## Configuration
+
+Before using the Word Ladder Generator API client, you have to setup your account and obtain your API Key.
+You can get it by signing up at [https://apiverve.com](https://apiverve.com)
+
+---
+
+## Quick Start
+
+[Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart)
+
+The Word Ladder Generator API documentation is found here: [https://docs.apiverve.com/ref/wordladder](https://docs.apiverve.com/ref/wordladder).
+You can find parameters, example responses, and status codes documented here.
+
+### Setup
+
+```javascript
+const wordladderAPI = require('@apiverve/wordladder');
+const api = new wordladderAPI({
+    api_key: '[YOUR_API_KEY]'
+});
+```
+
+---
+
+## Usage
+
+---
+
+### Perform Request
+
+Using the API is simple. All you have to do is make a request. The API will return a response with the data you requested.
+
+```javascript
+var query = {
+  start: "cold",
+  end: "warm",
+  difficulty: "medium",
+  count: 1
+};
+
+api.execute(query, function (error, data) {
+    if (error) {
+        return console.error(error);
+    } else {
+        console.log(data);
+    }
+});
+```
+
+---
+
+### Using Promises
+
+You can also use promises to make requests. The API returns a promise that you can use to handle the response.
+
+```javascript
+var query = {
+  start: "cold",
+  end: "warm",
+  difficulty: "medium",
+  count: 1
+};
+
+api.execute(query)
+    .then(data => {
+        console.log(data);
+    })
+    .catch(error => {
+        console.error(error);
+    });
+```
+
+---
+
+### Using Async/Await
+
+You can also use async/await to make requests. The API returns a promise that you can use to handle the response.
+
+```javascript
+async function makeRequest() {
+    var query = {
+  start: "cold",
+  end: "warm",
+  difficulty: "medium",
+  count: 1
+};
+
+    try {
+        const data = await api.execute(query);
+        console.log(data);
+    } catch (error) {
+        console.error(error);
+    }
+}
+```
+
+---
+
+## Example Response
+
+```json
+{
+  "status": "ok",
+  "error": null,
+  "data": {
+    "puzzles": [
+      {
+        "startWord": "LESS",
+        "endWord": "QUAT",
+        "steps": 4,
+        "solution": [
+          "LESS",
+          "LEST",
+          "BEST",
+          "BUST",
+          "BUAT",
+          "QUAT"
+        ],
+        "solvable": true,
+        "difficulty": "medium",
+        "hint": "(a) A pustule. [Obs.] (b) An annoying, worthless person. Sha"
+      }
+    ],
+    "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>"
+  }
+}
+```
+
+---
+
+## Customer Support
+
+Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).
+
+---
+
+## Updates
+
+Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
+
+---
+
+## Legal
+
+All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms) and all legal documents and agreements.
+
+---
+
+## License
+Licensed under the The MIT License (MIT)
+
+Copyright (&copy;) 2025 APIVerve, and EvlarSoft LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/examples/basic.js

@@ -0,0 +1,41 @@
+/**
+ * Basic Example - Word Ladder Generator API
+ *
+ * This example demonstrates how to use the Word Ladder Generator API.
+ * Make sure to set your API key in the .env file or replace '[YOUR_API_KEY]' below.
+ */
+
+require('dotenv').config();
+const wordladderAPI = require('../index.js');
+
+// Initialize the API client
+const api = new wordladderAPI({
+    api_key: process.env.API_KEY || '[YOUR_API_KEY]'
+});
+
+// Example query
+var query = {
+  start: "cold",
+  end: "warm",
+  difficulty: "medium",
+  count: 1
+};
+
+// Make the API request using callback
+console.log('Making request to Word Ladder Generator API...\n');
+
+api.execute(query, function (error, data) {
+    if (error) {
+        console.error('Error occurred:');
+        if (error.error) {
+            console.error('Message:', error.error);
+            console.error('Status:', error.status);
+        } else {
+            console.error(JSON.stringify(error, null, 2));
+        }
+        return;
+    }
+
+    console.log('Response:');
+    console.log(JSON.stringify(data, null, 2));
+});

package/index.d.ts

@@ -0,0 +1,39 @@
+declare module '@apiverve/wordladder' {
+  export interface wordladderOptions {
+    api_key: string;
+    secure?: boolean;
+  }
+
+  export interface wordladderResponse {
+    status: string;
+    error: string | null;
+    data: WordLadderGeneratorData;
+    code?: number;
+  }
+
+
+  interface WordLadderGeneratorData {
+      puzzles:    Puzzle[];
+      count:      number;
+      difficulty: string;
+      html:       string;
+  }
+  
+  interface Puzzle {
+      startWord:  string;
+      endWord:    string;
+      steps:      number;
+      solution:   string[];
+      solvable:   boolean;
+      difficulty: string;
+      hint:       string;
+  }
+
+  export default class wordladderWrapper {
+    constructor(options: wordladderOptions);
+
+    execute(callback: (error: any, data: wordladderResponse | null) => void): Promise<wordladderResponse>;
+    execute(query: Record<string, any>, callback: (error: any, data: wordladderResponse | null) => void): Promise<wordladderResponse>;
+    execute(query?: Record<string, any>): Promise<wordladderResponse>;
+  }
+}

package/index.js

@@ -0,0 +1,124 @@
+const axios = require('axios');
+
+class wordladderWrapper {
+
+    constructor(options) {
+        if (!options || typeof options !== 'object') {
+            throw new Error('Options object must be provided. See documentation: https://docs.apiverve.com/ref/wordladder');
+        }
+
+        const { api_key, secure = true } = options;
+
+        if (!api_key || typeof api_key !== 'string') {
+            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-]+$/;
+        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');
+        }
+
+        if (typeof secure !== 'boolean') {
+            throw new Error('Secure parameter must be a boolean value.');
+        }
+
+        this.APIKey = api_key;
+        this.IsSecure = secure;
+
+        // secure is deprecated, all requests must be made over HTTPS
+        this.baseURL = 'https://api.apiverve.com/v1/wordladder';
+    }
+
+    async execute(query, callback) {
+        // Handle different argument patterns
+        if(arguments.length === 0) {
+            // execute() - no args
+            query = {};
+            callback = null;
+        } else if(arguments.length === 1) {
+            if (typeof query === 'function') {
+                // execute(callback)
+                callback = query;
+                query = {};
+            } else {
+                // execute(query)
+                callback = null;
+            }
+        } else {
+            // execute(query, callback)
+            if (!query || typeof query !== 'object') {
+                throw new Error('Query parameters must be provided as an object.');
+            }
+        }
+
+        var requiredParams = [];
+        if (requiredParams.length > 0) {
+            for (var i = 0; i < requiredParams.length; i++) {
+                if (!query[requiredParams[i]]) {
+                    throw new Error(`Required parameter [${requiredParams[i]}] is missing. See documentation: https://docs.apiverve.com/ref/wordladder`);
+                }
+            }
+        }
+
+        const method = 'GET';
+        const url = method === 'POST' ? this.baseURL : this.constructURL(query);
+
+        try {
+            const response = await axios({
+                method,
+                url,
+                headers: {
+                    'Content-Type': 'application/json',
+                    'x-api-key': this.APIKey,
+                    'auth-mode': 'npm-package'
+                },
+                data: method === 'POST' ? query : undefined
+            });
+
+            const data = response.data;
+            if (callback) callback(null, data);
+            return data;
+        } catch (error) {
+            let apiError;
+
+            if (error.response && error.response.data) {
+                apiError = error.response.data;
+            } else if (error.message) {
+                apiError = { error: error.message, status: 'error' };
+            } else {
+                apiError = { error: 'An unknown error occurred', status: 'error' };
+            }
+
+            if (callback) {
+                callback(apiError, null);
+                return; // Don't throw if callback is provided
+            }
+
+            throw apiError;
+        }
+    }
+
+    constructURL(query) {
+        let url = this.baseURL;
+
+        if(query && typeof query === 'object') 
+        {
+            if (Object.keys(query).length > 0) {
+                const queryString = Object.keys(query)
+                    .map(key => `${encodeURIComponent(key)}=${encodeURIComponent(query[key])}`)
+                    .join('&');
+                url += `?${queryString}`;
+            }
+        }
+        return url;
+    }
+}
+
+module.exports = wordladderWrapper;

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@apiverve/wordladder",
+  "version": "1.1.12",
+  "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",
+  "scripts": {
+    "test": "mocha",
+    "example": "node examples/basic.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/apiverve/wordladder-api.git",
+    "directory": "npm"
+  },
+  "keywords": [
+    "word ladder", "word chain", "doublets", "word puzzle", "vocabulary game"
+  ],
+  "author": "APIVerve <hello@apiverve.com> (http://apiverve.com/)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/apiverve/wordladder-api/issues"
+  },
+  "homepage": "https://apiverve.com/marketplace/wordladder?utm_source=npm",
+  "devDependencies": {
+    "mocha": "^11.0.1",
+    "chai": "^5.1.2",
+    "dotenv": "^16.4.7"
+  },
+  "dependencies": {
+    "node-fetch": "^3.3.2",
+    "promise": "^8.3.0",
+    "axios": "1.13.2"
+  }
+}

package/tmp/build.dat

@@ -0,0 +1 @@
+#