@apiverve/titlecapitalization 1.1.8 → 1.1.10

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 APIVerve, and Evlar LLC
+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

package/README.md

@@ -1,5 +1,4 @@
-Title Case Converter API
-============
+# Title Case Converter API
 
 Title Capitalization is a simple tool for converting title text to various cases. It returns the text converted to your desired case.
 
@@ -7,55 +6,63 @@ Title Capitalization is a simple tool for converting title text to various cases
 ![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 [Title Case Converter API](https://apiverve.com/marketplace/api/titlecapitalization)
+This is a Javascript Wrapper for the [Title Case Converter API](https://apiverve.com/marketplace/titlecapitalization)
 
 ---
 
 ## Installation
-	npm install @apiverve/titlecapitalization --save
+
+Using npm:
+```shell
+npm install @apiverve/titlecapitalization
+```
+
+Using yarn:
+```shell
+yarn add @apiverve/titlecapitalization
+```
 
 ---
 
 ## Configuration
 
-Before using the titlecapitalization API client, you have to setup your account and obtain your API Key.  
+Before using the Title Case Converter 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
+
+[Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart)
 
-The Title Case Converter API documentation is found here: [https://docs.apiverve.com/api/titlecapitalization](https://docs.apiverve.com/api/titlecapitalization).  
+The Title Case Converter API documentation is found here: [https://docs.apiverve.com/ref/titlecapitalization](https://docs.apiverve.com/ref/titlecapitalization).
 You can find parameters, example responses, and status codes documented here.
 
 ### Setup
 
-```
-var titlecapitalizationAPI = require('@apiverve/titlecapitalization');
-var api = new titlecapitalizationAPI({
-    api_key: [YOUR_API_KEY],
-    secure: true //(Optional, defaults to true)
+```javascript
+const titlecapitalizationAPI = require('@apiverve/titlecapitalization');
+const api = new titlecapitalizationAPI({
+    api_key: '[YOUR_API_KEY]'
 });
 ```
 
 ---
 
+## Usage
+
+---
 
 ### Perform Request
-Using the API client, you can perform requests to the API.
 
-###### Define 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.
 
-```
+```javascript
 var query = {
   "text": "comprehensive analysis of quarterly financial performance and strategic initiatives for sustainable growth",
   "style": "title-case"
 };
-```
-
-###### Simple Request (using Callback)
 
-```
 api.execute(query, function (error, data) {
     if (error) {
         return console.error(error);
@@ -65,17 +72,61 @@ api.execute(query, 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
+var query = {
+  "text": "comprehensive analysis of quarterly financial performance and strategic initiatives for sustainable growth",
+  "style": "title-case"
+};
+
+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 = {
+  "text": "comprehensive analysis of quarterly financial performance and strategic initiatives for sustainable growth",
+  "style": "title-case"
+};
+
+    try {
+        const data = await api.execute(query);
+        console.log(data);
+    } catch (error) {
+        console.error(error);
+    }
+}
 ```
-{
-  "status": "ok",
-  "error": null,
-  "data": {
-    "style": "title-case",
-    "text": "Comprehensive Analysis of Quarterly Financial Performance and Strategic Initiatives for Sustainable Growth"
-  },
-  "code": 200
+
+---
+
+## Example Response
+
+```json
+{
+  "status": "ok",
+  "error": null,
+  "data": {
+    "style": "title-case",
+    "text": "Comprehensive Analysis of Quarterly Financial Performance and Strategic Initiatives for Sustainable Growth"
+  }
 }
 ```
 
@@ -88,6 +139,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.
 
 ---
@@ -107,4 +159,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 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,39 @@
+/**
+ * Basic Example - Title Case Converter API
+ *
+ * This example demonstrates how to use the Title Case Converter API.
+ * Make sure to set your API key in the .env file or replace '[YOUR_API_KEY]' below.
+ */
+
+require('dotenv').config();
+const titlecapitalizationAPI = require('../index.js');
+
+// Initialize the API client
+const api = new titlecapitalizationAPI({
+    api_key: process.env.API_KEY || '[YOUR_API_KEY]'
+});
+
+// Example query
+var query = {
+  "text": "comprehensive analysis of quarterly financial performance and strategic initiatives for sustainable growth",
+  "style": "title-case"
+};
+
+// Make the API request using callback
+console.log('Making request to Title Case Converter 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/titlecapitalization' {
+  export interface titlecapitalizationOptions {
+    api_key: string;
+    secure?: boolean;
+  }
+
+  export interface titlecapitalizationResponse {
+    status: string;
+    error: string | null;
+    data: any;
+    code?: number;
+  }
+
+  export default class titlecapitalizationWrapper {
+    constructor(options: titlecapitalizationOptions);
+
+    execute(callback: (error: any, data: titlecapitalizationResponse | null) => void): Promise<titlecapitalizationResponse>;
+    execute(query: Record<string, any>, callback: (error: any, data: titlecapitalizationResponse | null) => void): Promise<titlecapitalizationResponse>;
+    execute(query?: Record<string, any>): Promise<titlecapitalizationResponse>;
+  }
+}

package/index.js

@@ -4,14 +4,27 @@ class titlecapitalizationWrapper {
 
     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/titlecapitalization');
         }
 
         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 titlecapitalizationWrapper {
     }
 
     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 = ["text", "style"];
+        var requiredParams = ["text","style"];
         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/titlecapitalization`);
                 }
             }
         }
@@ -58,16 +83,25 @@ class titlecapitalizationWrapper {
             });
 
             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/titlecapitalization",
-  "version": "1.1.8",
+  "version": "1.1.10",
   "description": "Title Capitalization is a simple tool for converting title text to various cases. It returns the text converted to your desired case.",
   "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/titlecapitalization-API.git"
   },
   "keywords": [
-    "title capitalization","title capitalization api","title capitalization tool","title capitalization software","title capitalization service"
+    "title capitalization", "title capitalization api", "title capitalization tool", "title capitalization software", "title capitalization service"
   ],
   "author": "APIVerve <hello@apiverve.com> (http://apiverve.com/)",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/apiverve/titlecapitalization-API/issues"
   },
-  "homepage": "https://apiverve.com/marketplace/api/titlecapitalization?utm_source=npm",
+  "homepage": "https://apiverve.com/marketplace/titlecapitalization?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"
   }
 }