@apiverve/stateboundaries 1.1.8 → 1.1.10

package/examples/basic.js

@@ -0,0 +1,38 @@
+/**
+ * Basic Example - State Boundaries API
+ *
+ * This example demonstrates how to use the State Boundaries API.
+ * Make sure to set your API key in the .env file or replace '[YOUR_API_KEY]' below.
+ */
+
+require('dotenv').config();
+const stateboundariesAPI = require('../index.js');
+
+// Initialize the API client
+const api = new stateboundariesAPI({
+    api_key: process.env.API_KEY || '[YOUR_API_KEY]'
+});
+
+// Example query
+var query = {
+  state: "CA"
+};
+
+// Make the API request using callback
+console.log('Making request to State Boundaries 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,21 @@
+declare module '@apiverve/stateboundaries' {
+  export interface stateboundariesOptions {
+    api_key: string;
+    secure?: boolean;
+  }
+
+  export interface stateboundariesResponse {
+    status: string;
+    error: string | null;
+    data: any;
+    code?: number;
+  }
+
+  export default class stateboundariesWrapper {
+    constructor(options: stateboundariesOptions);
+
+    execute(callback: (error: any, data: stateboundariesResponse | null) => void): Promise<stateboundariesResponse>;
+    execute(query: Record<string, any>, callback: (error: any, data: stateboundariesResponse | null) => void): Promise<stateboundariesResponse>;
+    execute(query?: Record<string, any>): Promise<stateboundariesResponse>;
+  }
+}

package/index.js

@@ -4,14 +4,27 @@ class stateboundariesWrapper {
 
     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/stateboundaries');
         }
 
         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 stateboundariesWrapper {
     }
 
     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 = ["state"];
         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/stateboundaries`);
                 }
             }
         }
@@ -58,16 +83,25 @@ class stateboundariesWrapper {
             });
 
             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);
-                throw error.response.data;
+            let apiError;
+
+            if (error.response && error.response.data) {
+                apiError = error.response.data;
+            } else if (error.message) {
+                apiError = { error: error.message, status: 'error' };
             } else {
-                callback(error, null);
-                throw error;
-            }          
+                apiError = { error: 'An unknown error occurred', status: 'error' };
+            }
+
+            if (callback) {
+                callback(apiError, null);
+                return; // Don't throw if callback is provided
+            }
+
+            throw apiError;
         }
     }
 

package/package.json

@@ -1,24 +1,26 @@
 {
   "name": "@apiverve/stateboundaries",
-  "version": "1.1.8",
+  "version": "1.1.10",
   "description": "State Boundaries is a simple tool for getting the boundaries of a specific state's border. It returns the shape of the specified state's border.",
   "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/stateboundaries-API.git"
   },
   "keywords": [
-    "state boundaries","state boundaries api","state boundaries tool","state boundaries software","state boundaries service"
+    "state boundaries", "state boundaries api", "state boundaries tool", "state boundaries software", "state boundaries service"
   ],
   "author": "APIVerve <hello@apiverve.com> (http://apiverve.com/)",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/apiverve/stateboundaries-API/issues"
   },
-  "homepage": "https://apiverve.com/marketplace/api/stateboundaries?utm_source=npm",
+  "homepage": "https://apiverve.com/marketplace/stateboundaries?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.13.2"
   }
 }