@apiverve/textsimilarity 1.1.9 → 1.1.12

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 @@
-Text Similarity API
-============
+# Text Similarity API
 
 Text Similarity is a simple tool for checking the similarity between two texts. It returns the similarity score.
 
@@ -7,55 +6,63 @@ Text Similarity is a simple tool for checking the similarity between two texts.
 ![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 [Text Similarity API](https://apiverve.com/marketplace/api/textsimilarity)
+This is a Javascript Wrapper for the [Text Similarity API](https://apiverve.com/marketplace/textsimilarity)
 
 ---
 
 ## Installation
-	npm install @apiverve/textsimilarity --save
+
+Using npm:
+```shell
+npm install @apiverve/textsimilarity
+```
+
+Using yarn:
+```shell
+yarn add @apiverve/textsimilarity
+```
 
 ---
 
 ## Configuration
 
-Before using the textsimilarity API client, you have to setup your account and obtain your API Key.  
+Before using the Text Similarity 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 Text Similarity API documentation is found here: [https://docs.apiverve.com/api/textsimilarity](https://docs.apiverve.com/api/textsimilarity).  
+[Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart)
+
+The Text Similarity API documentation is found here: [https://docs.apiverve.com/ref/textsimilarity](https://docs.apiverve.com/ref/textsimilarity).
 You can find parameters, example responses, and status codes documented here.
 
 ### Setup
 
-```
-var textsimilarityAPI = require('@apiverve/textsimilarity');
-var api = new textsimilarityAPI({
-    api_key: [YOUR_API_KEY],
-    secure: true //(Optional, defaults to true)
+```javascript
+const textsimilarityAPI = require('@apiverve/textsimilarity');
+const api = new textsimilarityAPI({
+    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 = {
   "text1": "I'm so excited that tomorrow is going to be sunny! Can't wait!",
   "text2": "We're pretty excited about the weather tomorrow. It's going to be sunny!"
 };
-```
-
-###### Simple Request (using Callback)
 
-```
 api.execute(query, function (error, data) {
     if (error) {
         return console.error(error);
@@ -65,21 +72,65 @@ 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 = {
+  "text1": "I'm so excited that tomorrow is going to be sunny! Can't wait!",
+  "text2": "We're pretty excited about the weather tomorrow. It's going to be sunny!"
+};
+
+api.execute(query)
+    .then(data => {
+        console.log(data);
+    })
+    .catch(error => {
+        console.error(error);
+    });
 ```
-{
-  "status": "ok",
-  "error": null,
-  "data": {
-    "simiarity": 45.83,
-    "similarityCaseSensitive": 47.22,
-    "difference": {
-      "count": 7,
-      "percentage": 58.33
+
+---
+
+### 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 = {
+  "text1": "I'm so excited that tomorrow is going to be sunny! Can't wait!",
+  "text2": "We're pretty excited about the weather tomorrow. It's going to be sunny!"
+};
+
+    try {
+        const data = await api.execute(query);
+        console.log(data);
+    } catch (error) {
+        console.error(error);
     }
-  },
-  "code": 200
+}
+```
+
+---
+
+## Example Response
+
+```json
+{
+  "status": "ok",
+  "error": null,
+  "data": {
+    "simiarity": 45.83,
+    "similarityCaseSensitive": 47.22,
+    "difference": {
+      "count": 7,
+      "percentage": 58.33
+    }
+  }
 }
 ```
 
@@ -92,6 +143,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.
 
 ---
@@ -111,4 +163,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 - Text Similarity API
+ *
+ * This example demonstrates how to use the Text Similarity API.
+ * Make sure to set your API key in the .env file or replace '[YOUR_API_KEY]' below.
+ */
+
+require('dotenv').config();
+const textsimilarityAPI = require('../index.js');
+
+// Initialize the API client
+const api = new textsimilarityAPI({
+    api_key: process.env.API_KEY || '[YOUR_API_KEY]'
+});
+
+// Example query
+var query = {
+  "text1": "I'm so excited that tomorrow is going to be sunny! Can't wait!",
+  "text2": "We're pretty excited about the weather tomorrow. It's going to be sunny!"
+};
+
+// Make the API request using callback
+console.log('Making request to Text Similarity 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,33 @@
+declare module '@apiverve/textsimilarity' {
+  export interface textsimilarityOptions {
+    api_key: string;
+    secure?: boolean;
+  }
+
+  export interface textsimilarityResponse {
+    status: string;
+    error: string | null;
+    data: TextSimilarityData;
+    code?: number;
+  }
+
+
+  interface TextSimilarityData {
+      simiarity:               number;
+      similarityCaseSensitive: number;
+      difference:              Difference;
+  }
+  
+  interface Difference {
+      count:      number;
+      percentage: number;
+  }
+
+  export default class textsimilarityWrapper {
+    constructor(options: textsimilarityOptions);
+
+    execute(callback: (error: any, data: textsimilarityResponse | null) => void): Promise<textsimilarityResponse>;
+    execute(query: Record<string, any>, callback: (error: any, data: textsimilarityResponse | null) => void): Promise<textsimilarityResponse>;
+    execute(query?: Record<string, any>): Promise<textsimilarityResponse>;
+  }
+}

package/index.js

@@ -4,14 +4,27 @@ class textsimilarityWrapper {
 
     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/textsimilarity');
         }
 
         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 textsimilarityWrapper {
     }
 
     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 = ["text1", "text2"];
+        var requiredParams = ["text1","text2"];
         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/textsimilarity`);
                 }
             }
         }
@@ -58,16 +83,25 @@ class textsimilarityWrapper {
             });
 
             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,27 @@
 {
   "name": "@apiverve/textsimilarity",
-  "version": "1.1.9",
+  "version": "1.1.12",
   "description": "Text Similarity is a simple tool for checking the similarity between two texts. It returns the similarity score.",
   "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/textsimilarity-API.git"
+    "url": "git+https://github.com/apiverve/textsimilarity-api.git",
+    "directory": "npm"
   },
   "keywords": [
-    "text similarity","text similarity checker","text similarity api","text similarity tool","text similarity software"
+    "text similarity", "text similarity checker", "text similarity api", "text similarity tool", "text similarity software"
   ],
   "author": "APIVerve <hello@apiverve.com> (http://apiverve.com/)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/apiverve/textsimilarity-API/issues"
+    "url": "https://github.com/apiverve/textsimilarity-api/issues"
   },
-  "homepage": "https://apiverve.com/marketplace/api/textsimilarity?utm_source=npm",
+  "homepage": "https://apiverve.com/marketplace/textsimilarity?utm_source=npm",
   "devDependencies": {
     "mocha": "^11.0.1",
     "chai": "^5.1.2",
@@ -27,6 +30,6 @@
   "dependencies": {
     "node-fetch": "^3.3.2",
     "promise": "^8.3.0",
-    "axios": "1.7.9"
+    "axios": "1.13.2"
   }
 }