openai-api-mock 0.1.4 → 0.1.5

package/main.js

@@ -1,19 +1,31 @@
 const nock = require('nock');
-const { getResponce } = require('./src/responce.js');
+const { getChatResponce } = require('./src/chat.js');
+const { getImageResponce } = require('./src/image.js');
 
 function mockOpenAIResponse(force = false) {
-    // Define the OpenAI endpoint
-    const openaiEndpoint = 'https://api.openai.com/v1/chat/completions';
-    var env = process.env.NODE_ENV || 'development'
+    // Define the OpenAI endpoints
+    const openaiCompletionEndpoint = 'https://api.openai.com/v1/chat/completions';
+    const imageEndpoint = 'https://api.openai.com/v1/images/generations';
+    var env = process.env.NODE_ENV || 'development';
+
     // Intercept the HTTP call and return the mock response
     if (env === 'development' || force) {
-        nock(openaiEndpoint)
+        nock(openaiCompletionEndpoint)
+            .post('')
+            .reply(function (uri, requestBody) {
+                return [200, getChatResponce(requestBody)];
+            });
+
+        nock(imageEndpoint)
             .post('')
-            .reply(
-                function (uri, requestBody) {
-                    return [200, getResponce(requestBody)];
-                }
-            );
+            .reply(function (uri, requestBody) {
+                return [200, getImageResponce(requestBody)];
+            });
+
+        // Mocking only the chat completion endpoint, not blocking other requests
+        nock.emitter.on('no match', function (req) {
+            nock.enableNetConnect(req);
+        });
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai-api-mock",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "A Node.js module for mocking OpenAI API responses in a development environment",
   "repository": {
     "type": "git",
@@ -18,6 +18,7 @@
   "main": "main.js",
   "dependencies": {
     "@faker-js/faker": "^8.4.0",
-    "nock": "^13.5.1"
+    "nock": "^13.5.1",
+    "openai": "^4.26.0"
   }
 }

package/readme.md

@@ -4,6 +4,7 @@ This is a Node.js module for mocking OpenAI API responses in a development envir
 It's useful for testing and development purposes when you don't want to make actual API calls.
 The module also supports mocking function_calling
 
+
 ## Installation
 
 You can install this module using npm as a dev dependency :
@@ -12,12 +13,12 @@ You can install this module using npm as a dev dependency :
 npm install -D openai-api-mock
 ```
 
+
 ## Usage
 ```js
 const { mockOpenAIResponse } = require('openai-api-mock');
 ```
 
-
 Then, call the mockOpenAIResponse function to set up the mock response:
 
 ```js
@@ -31,6 +32,12 @@ mockOpenAIResponse(force = true);
 The force parameter is a boolean that determines whether the mock response should be used regardless of the environment. 
 If force is true, the mock response will be used regardless of the environment. If force is false or not provided, the mock response will only be used if the <code>NODE_ENV</code> environment variable is set to 'development'.
 
+## Intercepted URLs
+
+This module uses the `nock` library to intercept HTTP calls to the following OpenAI API endpoints:
+
+- `https://api.openai.com/v1/chat/completions`: This endpoint is used for generating chat completions.
+- `https://api.openai.com/v1/images/generations`: This endpoint is used for generating images.
 
 
 ## Dependencies

package/src/chat.js

@@ -0,0 +1,122 @@
+const { faker } = require('@faker-js/faker');
+
+function getChatResponce(requestBody) {
+    const created = Math.floor(Date.now() / 1000);
+
+    if (!requestBody.functions) {
+        return createDefaultResponse(created);
+    }
+
+    return createFunctionCallingResponse(requestBody, created);
+}
+
+function createDefaultResponse(created) {
+    return {
+        choices: [
+            {
+                finish_reason: 'stop',
+                index: 0,
+                message: {
+                    content: faker.lorem.words(5),
+                    role: 'assistant',
+                },
+                logprobs: null,
+            },
+        ],
+        created: created,
+        id: `chatcmpl-${faker.string.alphanumeric(30)}`,
+        model: `gpt-3.5-mock`,
+        object: 'chat.completion',
+        usage: {
+            completion_tokens: 17,
+            prompt_tokens: 57,
+            total_tokens: 74,
+        },
+    };
+}
+
+function createFunctionCallingResponse(requestBody, created) {
+    const functionCallingResponse = {
+        id: `chatcmpl-${faker.string.alphanumeric(30)}`,
+        object: 'chat.completion',
+        created: created,
+        model: 'gpt-3.5-mock',
+        choices: [
+            {
+                index: 0,
+                message: {
+                    role: 'assistant',
+                    content: null,
+                    function_call: createFunctionCallObject(requestBody),
+                },
+                finish_reason: 'function_call',
+            },
+        ],
+        usage: {
+            prompt_tokens: 81,
+            completion_tokens: 19,
+            total_tokens: 100,
+        },
+    };
+
+    return functionCallingResponse;
+}
+
+function createFunctionCallObject(requestBody) {
+    return {
+        name: `${requestBody.functions[0].name}`,
+        arguments: `${generateFunctionCallArguments(requestBody)}`,
+    };
+}
+
+function generateFakeData(type, properties) {
+    switch (type) {
+        case 'string':
+            return faker.lorem.words(5);
+        case 'number':
+            return faker.number.int();
+        case 'array':
+            return generateFakeArray(properties);
+        case 'object':
+            return generateFakeObject(properties);
+        case 'boolean':
+            return faker.datatype.boolean();
+        default:
+            return faker.lorem.words(1);
+    }
+}
+
+function generateFakeArray(properties) {
+    const arrayItemsType = properties.items.type;
+    return Array.from({ length: 5 }, () => {
+        if (arrayItemsType === 'string') {
+            return faker.lorem.words(1);
+        } else if (arrayItemsType === 'object') {
+            const itemProperties = properties.items.properties;
+            return generateFakeData('object', { properties: itemProperties });
+        }
+    });
+}
+
+function generateFakeObject(properties) {
+    const itemObject = {};
+    Object.entries(properties.properties).forEach(([itemName, itemDetails]) => {
+        itemObject[itemName] = generateFakeData(itemDetails.type, itemDetails);
+    });
+    return itemObject;
+}
+
+function generateFunctionCallArguments(requestBody) {
+    const { parameters } = requestBody.functions[0];
+    const argumentsObject = {};
+
+    Object.entries(parameters.properties).forEach(([paramName, paramDetails]) => {
+        argumentsObject[paramName] = generateFakeData(paramDetails.type, paramDetails);
+    });
+
+    return JSON.stringify(argumentsObject, null, 2);
+}
+
+module.exports = {
+    getChatResponce,
+};

package/src/image.js

@@ -0,0 +1,26 @@
+const { faker } = require('@faker-js/faker');
+
+
+function getImageResponce(requestBody) {
+
+  const n = requestBody.n || 1;
+  const data = [];
+  for (let i = 0; i < n; i++) {
+    data.push({
+      revised_prompt: faker.lorem.words(5),
+      url: "http://via.placeholder.com/" + requestBody.size
+    });
+  }
+
+  return {
+    created: Math.floor(Date.now() / 1000),
+    data: data
+  };
+}
+
+
+
+
+module.exports = {
+  getImageResponce,
+};

package/src/responce.js

@@ -1,102 +0,0 @@
-const { faker } = require('@faker-js/faker');
-
-function getResponce(requestBody) {
-    const created = Math.floor(Date.now() / 1000)
-    if (!requestBody.functions) {
-        return {
-            choices: [
-                {
-                    finish_reason: 'stop',
-                    index: 0,
-                    message: {
-                        content: faker.lorem.words(5),
-                        role: 'assistant',
-                    },
-                    logprobs: null,
-                },
-            ],
-            created: created,
-            id: `chatcmpl-${faker.string.alphanumeric(30)}`,
-            model: `gpt-3.5-mock`,
-            object: 'chat.completion',
-            usage: {
-                completion_tokens: 17,
-                prompt_tokens: 57,
-                total_tokens: 74,
-            },
-        }
-    }
-
-    let functionCallingResponse = {
-        id: `chatcmpl-${faker.string.alphanumeric(30)}`,
-        object: 'chat.completion',
-        created: created,
-        model: 'gpt-3.5-mock',
-        choices: [
-            {
-                index: 0,
-                message: {
-                    role: 'assistant',
-                    content: null,
-                    function_call: {
-                        name: `${requestBody.functions[0].name}`,
-                        arguments: `${generateFunctionCallArguments(requestBody)}`,
-                    }
-                },
-                finish_reason: 'function_call'
-            }
-        ],
-        usage: {
-            prompt_tokens: 81,
-            completion_tokens: 19,
-            total_tokens: 100
-        }
-    };
-    return functionCallingResponse;
-}
-
-function generateFakeData(type, properties) {
-    if (type === 'string') {
-        return faker.lorem.words(5);
-    } else if (type === 'number') {
-        return faker.number.int();
-    } else if (type === 'array') {
-        const arrayItemsType = properties.items.type;
-        let arrayItems = [];
-        if (arrayItemsType === 'string') {
-            arrayItems = Array.from({ length: 5 }, () => faker.lorem.words(1));
-        } else if (arrayItemsType === 'object') {
-            const itemProperties = properties.items.properties;
-            arrayItems = Array.from({ length: 5 }, () => generateFakeData('object', { properties: itemProperties }));
-        }
-        return arrayItems;
-    } else if (type === 'object') {
-        const itemObject = {};
-        Object.entries(properties.properties).forEach(([itemName, itemDetails]) => {
-            itemObject[itemName] = generateFakeData(itemDetails.type, itemDetails);
-        });
-        return itemObject;
-    }else if (type === 'boolean') {
-        return faker.datatype.boolean();
-    }else {
-        return faker.lorem.words(1);
-    }
-}
-
-/*
-* Generate function call arguments
-*/
-function generateFunctionCallArguments(requestBody) {
-    const { parameters } = requestBody.functions[0];
-    const argumentsObject = {};
-
-    Object.entries(parameters.properties).forEach(([paramName, paramDetails]) => {
-        argumentsObject[paramName] = generateFakeData(paramDetails.type, paramDetails);
-    });
-
-    return JSON.stringify(argumentsObject, null, 2);
-}
-
-module.exports = {
-    getResponce
-}