@apiverve/recipe 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 @@
-Recipes API
-============
+# Recipes API
 
 Recipes is a simple tool for getting recipe information. It returns information on various recipes.
 
@@ -7,54 +6,62 @@ Recipes is a simple tool for getting recipe information. It returns information
 ![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 [Recipes API](https://apiverve.com/marketplace/api/recipe)
+This is a Javascript Wrapper for the [Recipes API](https://apiverve.com/marketplace/recipe)
 
 ---
 
 ## Installation
-	npm install @apiverve/recipe --save
+
+Using npm:
+```shell
+npm install @apiverve/recipe
+```
+
+Using yarn:
+```shell
+yarn add @apiverve/recipe
+```
 
 ---
 
 ## Configuration
 
-Before using the recipe API client, you have to setup your account and obtain your API Key.  
+Before using the Recipes 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 Recipes API documentation is found here: [https://docs.apiverve.com/api/recipe](https://docs.apiverve.com/api/recipe).  
+[Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart)
+
+The Recipes API documentation is found here: [https://docs.apiverve.com/ref/recipe](https://docs.apiverve.com/ref/recipe).
 You can find parameters, example responses, and status codes documented here.
 
 ### Setup
 
-```
-var recipeAPI = require('@apiverve/recipe');
-var api = new recipeAPI({
-    api_key: [YOUR_API_KEY],
-    secure: true //(Optional, defaults to true)
+```javascript
+const recipeAPI = require('@apiverve/recipe');
+const api = new recipeAPI({
+    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 = {
-  name: "chicken"
+  name: "cake"
 };
-```
 
-###### Simple Request (using Callback)
-
-```
 api.execute(query, function (error, data) {
     if (error) {
         return console.error(error);
@@ -64,42 +71,84 @@ 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 = {
+  name: "cake"
+};
+
+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 = {
+  name: "cake"
+};
+
+    try {
+        const data = await api.execute(query);
+        console.log(data);
+    } catch (error) {
+        console.error(error);
+    }
+}
 ```
-{
-  "status": "ok",
-  "error": null,
-  "data": {
-    "count": 1,
-    "recipes": [
-      {
-        "instructions": "Heat the oil in a large, non-stick frying pan or wok and stir-fry the chicken and peppers for 2 mins. Sprinkle over the spices and cook for 30 secs more, stirring. Tip the tomatoes into the pan and stir in the chipotle paste. Simmer for 5 mins or until the sauce is thick and glossy, stirring regularly. Stir in the spring onions and coriander, cook for 1 min more, then remove from the heat and leave to cool. Cut the tortillas into quarters, then cut each quarter into three pieces, so you have 36 triangles. Place 1 tsp of the chicken mixture and a little cheese at the widest end of a triangle. Roll the pointed end of the triangle around the filling and secure with a cocktail stick. Place on a baking tray lined with baking parchment. Fill and roll the other triangles. Cover with cling film and chill for up to 8 hrs until ready to reheat. To make the dip, mash all the ingredients in a bowl until almost smooth. Cover the surface of the dip with cling film and chill for up to 24 hrs. When ready to serve, heat oven to 200C/180C fan/gas 6. Uncover the fajitas and bake for 6-8 mins or until hot throughout. Serve with the guacamole.",
-        "name": "Mini Chicken Fajitas",
-        "ingredients": [
-          "2 tbsp sunflower oil",
-          "2 skinless chicken breasts, cut into 1½ cm/½ in chunks",
-          "1 red pepper, deseeded and cut into 1½ cm/½ in chunks",
-          "1 yellow pepper, deseeded and cut into 1½ cm/½ in chunks",
-          "1 tsp ground cumin",
-          "1 tsp ground coriander",
-          "¼ tsp hot chilli powder",
-          "227g can chopped tomatoes",
-          "2 tbsp chipotle paste",
-          "4 spring onions, trimmed and thinly sliced",
-          "large pack coriander, leaves chopped",
-          "3 large flour tortillas",
-          "75g ready-grated mozzarella",
-          "1 ripe avocado, stoned and peeled",
-          "juice 1 large lime",
-          "1 garlic clove, crushed",
-          "2 heaped tbsp finely chopped coriander",
-          "36 cocktail sticks"
-        ]
-      }
-    ]
-  },
-  "code": 200
+
+---
+
+## Example Response
+
+```json
+{
+  "status": "ok",
+  "error": null,
+  "data": {
+    "count": 1,
+    "recipes": [
+      {
+        "instructions": "Heat the oil in a large, non-stick frying pan or wok and stir-fry the chicken and peppers for 2 mins. Sprinkle over the spices and cook for 30 secs more, stirring. Tip the tomatoes into the pan and stir in the chipotle paste. Simmer for 5 mins or until the sauce is thick and glossy, stirring regularly. Stir in the spring onions and coriander, cook for 1 min more, then remove from the heat and leave to cool. Cut the tortillas into quarters, then cut each quarter into three pieces, so you have 36 triangles. Place 1 tsp of the chicken mixture and a little cheese at the widest end of a triangle. Roll the pointed end of the triangle around the filling and secure with a cocktail stick. Place on a baking tray lined with baking parchment. Fill and roll the other triangles. Cover with cling film and chill for up to 8 hrs until ready to reheat. To make the dip, mash all the ingredients in a bowl until almost smooth. Cover the surface of the dip with cling film and chill for up to 24 hrs. When ready to serve, heat oven to 200C/180C fan/gas 6. Uncover the fajitas and bake for 6-8 mins or until hot throughout. Serve with the guacamole.",
+        "name": "Mini Chicken Fajitas",
+        "ingredients": [
+          "2 tbsp sunflower oil",
+          "2 skinless chicken breasts, cut into 1½ cm/½ in chunks",
+          "1 red pepper, deseeded and cut into 1½ cm/½ in chunks",
+          "1 yellow pepper, deseeded and cut into 1½ cm/½ in chunks",
+          "1 tsp ground cumin",
+          "1 tsp ground coriander",
+          "¼ tsp hot chilli powder",
+          "227g can chopped tomatoes",
+          "2 tbsp chipotle paste",
+          "4 spring onions, trimmed and thinly sliced",
+          "large pack coriander, leaves chopped",
+          "3 large flour tortillas",
+          "75g ready-grated mozzarella",
+          "1 ripe avocado, stoned and peeled",
+          "juice 1 large lime",
+          "1 garlic clove, crushed",
+          "2 heaped tbsp finely chopped coriander",
+          "36 cocktail sticks"
+        ]
+      }
+    ]
+  }
 }
 ```
 
@@ -112,6 +161,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.
 
 ---
@@ -131,4 +181,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,38 @@
+/**
+ * Basic Example - Recipes API
+ *
+ * This example demonstrates how to use the Recipes API.
+ * Make sure to set your API key in the .env file or replace '[YOUR_API_KEY]' below.
+ */
+
+require('dotenv').config();
+const recipeAPI = require('../index.js');
+
+// Initialize the API client
+const api = new recipeAPI({
+    api_key: process.env.API_KEY || '[YOUR_API_KEY]'
+});
+
+// Example query
+var query = {
+  name: "cake"
+};
+
+// Make the API request using callback
+console.log('Making request to Recipes 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/recipe' {
+  export interface recipeOptions {
+    api_key: string;
+    secure?: boolean;
+  }
+
+  export interface recipeResponse {
+    status: string;
+    error: string | null;
+    data: RecipesData;
+    code?: number;
+  }
+
+
+  interface RecipesData {
+      count:   number;
+      recipes: Recipe[];
+  }
+  
+  interface Recipe {
+      instructions: string;
+      name:         string;
+      ingredients:  string[];
+  }
+
+  export default class recipeWrapper {
+    constructor(options: recipeOptions);
+
+    execute(callback: (error: any, data: recipeResponse | null) => void): Promise<recipeResponse>;
+    execute(query: Record<string, any>, callback: (error: any, data: recipeResponse | null) => void): Promise<recipeResponse>;
+    execute(query?: Record<string, any>): Promise<recipeResponse>;
+  }
+}

package/index.js

@@ -4,14 +4,27 @@ class recipeWrapper {
 
     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/recipe');
         }
 
         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 recipeWrapper {
     }
 
     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 = ["name"];
         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/recipe`);
                 }
             }
         }
@@ -58,16 +83,25 @@ class recipeWrapper {
             });
 
             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/recipe",
-  "version": "1.1.9",
+  "version": "1.1.12",
   "description": "Recipes is a simple tool for getting recipe information. It returns information on various recipes.",
   "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/recipe-API.git"
+    "url": "git+https://github.com/apiverve/recipe-api.git",
+    "directory": "npm"
   },
   "keywords": [
-    "recipes","recipes api","recipes tool","recipes software","recipes service"
+    "recipes", "recipes api", "recipes tool", "recipes software", "recipes service"
   ],
   "author": "APIVerve <hello@apiverve.com> (http://apiverve.com/)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/apiverve/recipe-API/issues"
+    "url": "https://github.com/apiverve/recipe-api/issues"
   },
-  "homepage": "https://apiverve.com/marketplace/api/recipe?utm_source=npm",
+  "homepage": "https://apiverve.com/marketplace/recipe?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"
   }
 }