@apiverve/advice 1.1.9 → 1.1.10

package/README.md

@@ -1,5 +1,4 @@
-Advice Generator API
-============
+# Advice Generator API
 
 Advice Generator is a simple tool for generating random pieces of advice. It returns a random piece of advice.
 
@@ -7,52 +6,60 @@ Advice Generator is a simple tool for generating random pieces of advice. It ret
 ![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 [Advice Generator API](https://apiverve.com/marketplace/api/advice)
+This is a Javascript Wrapper for the [Advice Generator API](https://apiverve.com/marketplace/advice)
 
 ---
 
 ## Installation
-	npm install @apiverve/advice --save
+
+Using npm:
+```shell
+npm install @apiverve/advice
+```
+
+Using yarn:
+```shell
+yarn add @apiverve/advice
+```
 
 ---
 
 ## Configuration
 
-Before using the advice API client, you have to setup your account and obtain your API Key.  
+Before using the Advice 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)
 
 ---
 
-## Usage
+## Quick Start
 
-The Advice Generator API documentation is found here: [https://docs.apiverve.com/api/advice](https://docs.apiverve.com/api/advice).  
+[Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart)
+
+The Advice Generator API documentation is found here: [https://docs.apiverve.com/ref/advice](https://docs.apiverve.com/ref/advice).
 You can find parameters, example responses, and status codes documented here.
 
 ### Setup
 
-```
-var adviceAPI = require('@apiverve/advice');
-var api = new adviceAPI({
-    api_key: [YOUR_API_KEY],
-    secure: true //(Optional, defaults to true)
+```javascript
+const adviceAPI = require('@apiverve/advice');
+const api = new adviceAPI({
+    api_key: '[YOUR_API_KEY]'
 });
 ```
 
 ---
 
+## Usage
 
-### Perform Request
-Using the API client, you can perform requests to the API.
+---
 
-###### Define Query
+### Perform Request
 
-```
-This API does not require a Query
-```
+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.
 
-###### Simple Request (using Callback)
+```javascript
+// This API does not require a Query
 
-```
 api.execute(function (error, data) {
     if (error) {
         return console.error(error);
@@ -62,16 +69,56 @@ api.execute(function (error, data) {
 });
 ```
 
-###### Example Response
+---
+
+### Using Promises
+
+You can also use promises to make requests. The API returns a promise that you can use to handle the response.
 
+```javascript
+// This API does not require a Query
+
+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() {
+    // This API does not require a Query
+
+    try {
+        const data = await api.execute(query);
+        console.log(data);
+    } catch (error) {
+        console.error(error);
+    }
+}
 ```
-{
-  "status": "ok",
-  "error": null,
-  "data": {
-    "advice": "Nurture your friendships."
-  },
-  "code": 200
+
+---
+
+## Example Response
+
+```json
+{
+  "status": "ok",
+  "error": null,
+  "data": {
+    "id": "1t39qBIy",
+    "advice": "Seek ways to improve your financial literacy and make sound financial decisions.",
+    "lang": "en"
+  }
 }
 ```
 
@@ -84,6 +131,7 @@ Need any assistance? [Get in touch with Customer Support](https://apiverve.com/c
 ---
 
 ## Updates
+
 Stay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.
 
 ---
@@ -97,10 +145,10 @@ All usage of the APIVerve website, API, and services is subject to the [APIVerve
 ## License
 Licensed under the The MIT License (MIT)
 
-Copyright (©) 2025 APIVerve, and EvlarSoft LLC
+Copyright (©) 2025 APIVerve, and Evlar 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.
+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,34 @@
+/**
+ * Basic Example - Advice Generator API
+ *
+ * This example demonstrates how to use the Advice Generator API.
+ * Make sure to set your API key in the .env file or replace '[YOUR_API_KEY]' below.
+ */
+
+require('dotenv').config();
+const adviceAPI = require('../index.js');
+
+// Initialize the API client
+const api = new adviceAPI({
+    api_key: process.env.API_KEY || '[YOUR_API_KEY]'
+});
+
+// Example query
+// This API does not require a Query
+
+// Make the API request
+async function main() {
+    try {
+        console.log('Making request to Advice Generator API...\n');
+        const data = await api.execute(query);
+        console.log('Response:');
+        console.log(JSON.stringify(data, null, 2));
+    } catch (error) {
+        console.error('Error:', error.message);
+        if (error.response && error.response.data) {
+            console.error('API Error:', error.response.data);
+        }
+    }
+}
+
+main();

package/index.d.ts

@@ -0,0 +1,21 @@
+declare module '@apiverve/advice' {
+  export interface adviceOptions {
+    api_key: string;
+    secure?: boolean;
+  }
+
+  export interface adviceResponse {
+    status: string;
+    error: string | null;
+    data: any;
+    code?: number;
+  }
+
+  export default class adviceWrapper {
+    constructor(options: adviceOptions);
+
+    execute(callback: (error: any, data: adviceResponse | null) => void): Promise<adviceResponse>;
+    execute(query: Record<string, any>, callback: (error: any, data: adviceResponse | null) => void): Promise<adviceResponse>;
+    execute(query?: Record<string, any>): Promise<adviceResponse>;
+  }
+}

package/index.js

@@ -4,14 +4,27 @@ class adviceWrapper {
 
     constructor(options) {
         if (!options || typeof options !== 'object') {
-            throw new Error('Options object must be provided.');
+            throw new Error('Options object must be provided. See documentation: https://docs.apiverve.com/ref/advice');
         }
 
         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.');
+            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.');
         }
@@ -24,20 +37,32 @@ class adviceWrapper {
     }
 
     async execute(query, callback) {
-        if(arguments.length > 1) {
+        // 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.');
             }
-        } else {
-            callback = query;
-            query = {};
         }
 
         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.`);
+                    throw new Error(`Required parameter [${requiredParams[i]}] is missing. See documentation: https://docs.apiverve.com/ref/advice`);
                 }
             }
         }
@@ -58,16 +83,16 @@ class adviceWrapper {
             });
 
             const data = response.data;
-            callback(null, data);
+            if (callback) callback(null, data);
             return data;
         } catch (error) {
-            if (error.response.data) {
-                callback(error.response.data, null);
+            if (error.response && error.response.data) {
+                if (callback) callback(error.response.data, null);
                 throw error.response.data;
             } else {
-                callback(error, null);
+                if (callback) callback(error, null);
                 throw error;
-            }          
+            }
         }
     }
 

package/package.json

@@ -1,24 +1,26 @@
 {
   "name": "@apiverve/advice",
-  "version": "1.1.9",
+  "version": "1.1.10",
   "description": "Advice Generator is a simple tool for generating random pieces of advice. It returns a random piece of advice.",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
-    "test": "mocha"
+    "test": "mocha",
+    "example": "node examples/basic.js"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/apiverve/advice-API.git"
   },
   "keywords": [
-    "advice generator","advice generation","advice generate","advice api","advice tool"
+    "advice generator", "advice generation", "advice generate", "advice api", "advice tool"
   ],
   "author": "APIVerve <hello@apiverve.com> (http://apiverve.com/)",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/apiverve/advice-API/issues"
   },
-  "homepage": "https://apiverve.com/marketplace/api/advice?utm_source=npm",
+  "homepage": "https://apiverve.com/marketplace/advice?utm_source=npm",
   "devDependencies": {
     "mocha": "^11.0.1",
     "chai": "^5.1.2",
@@ -27,6 +29,6 @@
   "dependencies": {
     "node-fetch": "^3.3.2",
     "promise": "^8.3.0",
-    "axios": "1.7.9"
+    "axios": "1.8.4"
   }
 }