@apiverve/acrostic 1.1.10 → 1.1.13

package/README.md

@@ -5,8 +5,9 @@ Acrostic Puzzle Generator creates puzzles where the first letters of answer 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)
+[![npm version](https://img.shields.io/npm/v/@apiverve/acrostic.svg)](https://www.npmjs.com/package/@apiverve/acrostic)
 
-This is a Javascript Wrapper for the [Acrostic Puzzle Generator API](https://apiverve.com/marketplace/acrostic)
+This is a Javascript Wrapper for the [Acrostic Puzzle Generator API](https://apiverve.com/marketplace/acrostic?utm_source=npm&utm_medium=readme)
 
 ---
 
@@ -27,15 +28,15 @@ yarn add @apiverve/acrostic
 ## Configuration
 
 Before using the Acrostic Puzzle 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)
+You can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=npm&utm_medium=readme)
 
 ---
 
 ## Quick Start
 
-[Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart)
+[Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart?utm_source=npm&utm_medium=readme)
 
-The Acrostic Puzzle Generator API documentation is found here: [https://docs.apiverve.com/ref/acrostic](https://docs.apiverve.com/ref/acrostic).
+The Acrostic Puzzle Generator API documentation is found here: [https://docs.apiverve.com/ref/acrostic](https://docs.apiverve.com/ref/acrostic?utm_source=npm&utm_medium=readme).
 You can find parameters, example responses, and status codes documented here.
 
 ### Setup
@@ -60,7 +61,7 @@ Using the API is simple. All you have to do is make a request. The API will retu
 ```javascript
 var query = {
   word: "HAPPY",
-  theme: "positive"
+  theme: "random"
 };
 
 api.execute(query, function (error, data) {
@@ -81,7 +82,7 @@ You can also use promises to make requests. The API returns a promise that you c
 ```javascript
 var query = {
   word: "HAPPY",
-  theme: "positive"
+  theme: "random"
 };
 
 api.execute(query)
@@ -103,7 +104,7 @@ You can also use async/await to make requests. The API returns a promise that yo
 async function makeRequest() {
     var query = {
   word: "HAPPY",
-  theme: "positive"
+  theme: "random"
 };
 
     try {
@@ -173,7 +174,7 @@ async function makeRequest() {
 
 ## Customer Support
 
-Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact).
+Need any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=npm&utm_medium=readme).
 
 ---
 
@@ -185,14 +186,14 @@ Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Tw
 
 ## 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.
+All usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms?utm_source=npm&utm_medium=readme), [Privacy Policy](https://apiverve.com/privacy?utm_source=npm&utm_medium=readme), and [Refund Policy](https://apiverve.com/refund?utm_source=npm&utm_medium=readme).
 
 ---
 
 ## License
 Licensed under the The MIT License (MIT)
 
-Copyright (©) 2025 APIVerve, and EvlarSoft LLC
+Copyright (©) 2026 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:
 

package/index.js

@@ -34,6 +34,102 @@ class acrosticWrapper {
 
         // secure is deprecated, all requests must be made over HTTPS
         this.baseURL = 'https://api.apiverve.com/v1/acrostic';
+
+        // Validation rules for parameters (generated from schema)
+        this.validationRules = {"word":{"type":"string","required":true},"theme":{"type":"string","required":false,"default":"random"}};
+    }
+
+    /**
+     * Validate query parameters against schema rules
+     * @param {Object} query - The query parameters to validate
+     * @throws {Error} - If validation fails
+     */
+    validateParams(query) {
+        const errors = [];
+
+        for (const [paramName, rules] of Object.entries(this.validationRules)) {
+            const value = query[paramName];
+
+            // Check required
+            if (rules.required && (value === undefined || value === null || value === '')) {
+                errors.push(`Required parameter [${paramName}] is missing.`);
+                continue;
+            }
+
+            // Skip validation if value is not provided and not required
+            if (value === undefined || value === null) {
+                continue;
+            }
+
+            // Type validation
+            if (rules.type === 'integer' || rules.type === 'number') {
+                const numValue = Number(value);
+                if (isNaN(numValue)) {
+                    errors.push(`Parameter [${paramName}] must be a valid ${rules.type}.`);
+                    continue;
+                }
+
+                if (rules.type === 'integer' && !Number.isInteger(numValue)) {
+                    errors.push(`Parameter [${paramName}] must be an integer.`);
+                    continue;
+                }
+
+                // Min/max validation for numbers
+                if (rules.min !== undefined && numValue < rules.min) {
+                    errors.push(`Parameter [${paramName}] must be at least ${rules.min}.`);
+                }
+                if (rules.max !== undefined && numValue > rules.max) {
+                    errors.push(`Parameter [${paramName}] must be at most ${rules.max}.`);
+                }
+            } else if (rules.type === 'string') {
+                if (typeof value !== 'string') {
+                    errors.push(`Parameter [${paramName}] must be a string.`);
+                    continue;
+                }
+
+                // Length validation for strings
+                if (rules.minLength !== undefined && value.length < rules.minLength) {
+                    errors.push(`Parameter [${paramName}] must be at least ${rules.minLength} characters.`);
+                }
+                if (rules.maxLength !== undefined && value.length > rules.maxLength) {
+                    errors.push(`Parameter [${paramName}] must be at most ${rules.maxLength} characters.`);
+                }
+
+                // Format validation
+                if (rules.format) {
+                    const formatPatterns = {
+                        'email': /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
+                        'url': /^https?:\/\/.+/i,
+                        'ip': /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$/,
+                        'date': /^\d{4}-\d{2}-\d{2}$/,
+                        'hexColor': /^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$/
+                    };
+
+                    if (formatPatterns[rules.format] && !formatPatterns[rules.format].test(value)) {
+                        errors.push(`Parameter [${paramName}] must be a valid ${rules.format}.`);
+                    }
+                }
+            } else if (rules.type === 'boolean') {
+                if (typeof value !== 'boolean' && value !== 'true' && value !== 'false') {
+                    errors.push(`Parameter [${paramName}] must be a boolean.`);
+                }
+            } else if (rules.type === 'array') {
+                if (!Array.isArray(value)) {
+                    errors.push(`Parameter [${paramName}] must be an array.`);
+                }
+            }
+
+            // Enum validation
+            if (rules.enum && Array.isArray(rules.enum)) {
+                if (!rules.enum.includes(value)) {
+                    errors.push(`Parameter [${paramName}] must be one of: ${rules.enum.join(', ')}.`);
+                }
+            }
+        }
+
+        if (errors.length > 0) {
+            throw new Error(`Validation failed: ${errors.join(' ')} See documentation: https://docs.apiverve.com/ref/acrostic`);
+        }
     }
 
     async execute(query, callback) {
@@ -58,14 +154,8 @@ class acrosticWrapper {
             }
         }
 
-        var requiredParams = ["word"];
-        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/acrostic`);
-                }
-            }
-        }
+        // Validate parameters against schema rules
+        this.validateParams(query);
 
         const method = 'GET';
         const url = method === 'POST' ? this.baseURL : this.constructURL(query);
@@ -108,7 +198,7 @@ class acrosticWrapper {
     constructURL(query) {
         let url = this.baseURL;
 
-        if(query && typeof query === 'object') 
+        if(query && typeof query === 'object')
         {
             if (Object.keys(query).length > 0) {
                 const queryString = Object.keys(query)
@@ -119,6 +209,7 @@ class acrosticWrapper {
         }
         return url;
     }
+
 }
 
 module.exports = acrosticWrapper;

package/package.json

@@ -1,9 +1,18 @@
 {
   "name": "@apiverve/acrostic",
-  "version": "1.1.10",
+  "version": "1.1.13",
   "description": "Acrostic Puzzle Generator creates puzzles where the first letters of answer words spell out a hidden keyword.",
   "main": "index.js",
   "types": "index.d.ts",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "LICENSE"
+  ],
   "scripts": {
     "test": "mocha",
     "example": "node examples/basic.js"
@@ -14,14 +23,18 @@
     "directory": "npm"
   },
   "keywords": [
-    "acrostic", "word puzzle", "hidden word", "first letters", "vocabulary"
+    ""
   ],
-  "author": "APIVerve <hello@apiverve.com> (http://apiverve.com/)",
+  "author": {
+    "name": "APIVerve",
+    "email": "hello@apiverve.com",
+    "url": "https://apiverve.com"
+  },
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/apiverve/acrostic-api/issues"
   },
-  "homepage": "https://apiverve.com/marketplace/acrostic?utm_source=npm",
+  "homepage": "https://apiverve.com/marketplace/acrostic?utm_source=npm&utm_medium=homepage",
   "devDependencies": {
     "mocha": "^11.0.1",
     "chai": "^5.1.2",

package/examples/basic.js

@@ -1,39 +0,0 @@
-/**
- * Basic Example - Acrostic Puzzle Generator API
- *
- * This example demonstrates how to use the Acrostic Puzzle Generator API.
- * Make sure to set your API key in the .env file or replace '[YOUR_API_KEY]' below.
- */
-
-require('dotenv').config();
-const acrosticAPI = require('../index.js');
-
-// Initialize the API client
-const api = new acrosticAPI({
-    api_key: process.env.API_KEY || '[YOUR_API_KEY]'
-});
-
-// Example query
-var query = {
-  word: "HAPPY",
-  theme: "positive"
-};
-
-// Make the API request using callback
-console.log('Making request to Acrostic Puzzle 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/tmp/build.dat

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