openai-api-mock 0.1.20 → 0.1.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai-api-mock",
-  "version": "0.1.20",
+  "version": "0.1.21",
   "description": "A Node.js module for mocking OpenAI API responses in a development environment",
   "repository": {
     "type": "git",

package/src/chat.js

@@ -1,4 +1,4 @@
-const { faker } = require("@faker-js/faker");
+const { createDefaultResponse, createFunctionCallingResponse } = require('./utils/responseGenerators');
 
 function getChatResponce(requestBody) {
   const created = Math.floor(Date.now() / 1000);
@@ -10,180 +10,6 @@ function getChatResponce(requestBody) {
   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 isTool = Boolean(requestBody.tools);
-  const functionOrToolCallObject = isTool
-    ? [createToolCallObject(requestBody)]
-    : createFunctionCallObject(requestBody);
-  const functionOrToolCall = isTool ? "tool_calls" : "function_call";
-
-  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,
-          [functionOrToolCall]: functionOrToolCallObject,
-        },
-        finish_reason: functionOrToolCall,
-      },
-    ],
-    usage: {
-      prompt_tokens: 81,
-      completion_tokens: 19,
-      total_tokens: 100,
-    },
-  };
-
-  return functionCallingResponse;
-}
-
-function createToolCallObject(requestBody) {
-  return {
-    id: `call-${faker.string.alphanumeric(30)}`,
-    type: "function",
-    function: {
-      name: `${requestBody.tools[0].function.name}`,
-      arguments: `${generateToolCallArguments(requestBody)}`,
-    },
-  };
-}
-function createFunctionCallObject(requestBody) {
-  return {
-    name: `${requestBody.functions[0].name}`,
-    arguments: `${generateFunctionCallArguments(requestBody)}`,
-  };
-}
-
-function generateToolCallArguments(requestBody) {
-  const { parameters } = requestBody.tools[0].function;
-  const argumentsObject = {};
-
-  Object.entries(parameters.properties).forEach(([paramName, paramDetails]) => {
-    argumentsObject[paramName] = generateFakeData(
-      paramDetails.type,
-      paramDetails,
-      paramName
-    );
-  });
-
-  return JSON.stringify(argumentsObject, null, 2);
-}
-
-function generateFakeData(type, properties, name) {
-  switch (type) {
-    case "string":
-      return generateFakeStringData(name);
-    case "number":
-      return faker.number.int({ max: 100 });
-    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 }, "item");
-    }
-  });
-}
-
-function generateFakeObject(properties) {
-  const itemObject = {};
-  Object.entries(properties.properties).forEach(([itemName, itemDetails]) => {
-    itemObject[itemName] = generateFakeData(itemDetails.type, itemDetails, itemName);
-  });
-  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,
-      paramName
-    );
-  });
-
-  return JSON.stringify(argumentsObject, null, 2);
-}
-
-function generateFakeStringData(name) {
-  if (name === "name") {
-    return faker.person.fullName();
-  } else if (name === "email") {
-    return faker.internet.email();
-  } else if (name === "price") {
-    return faker.commerce.price();
-  } else if (name === "company") {
-    return faker.company.name();
-  } else if (name === "phone") {
-    return faker.phone.number();
-  } else if (name === "address") {
-    return faker.location.streetAddress();
-  } else if (name === "date") {
-    return faker.date.past();
-  } else if (name === "jobTitle") {
-    return faker.person.jobTitle();
-  } else if (name === "creditCardNumber") {
-    return faker.finance.creditCardNumber();
-  } else if (name === "currencyCode") {
-    return faker.finance.currencyCode();
-  } else if (name === "productName") {
-    return faker.commerce.productName();
-  } else if (name === "uuid") {
-    return faker.string.uuid();
-  } else {
-    return faker.lorem.words(5);
-  }
-}
-
-
 module.exports = {
   getChatResponce,
 };

package/src/chat.stream.js

@@ -1,5 +1,5 @@
-const { faker } = require("@faker-js/faker");
 const { Readable } = require('stream');
+const { getSteamChatObject } = require('./utils/responseGenerators');
 
 function createChatStream() {
     const stream = new Readable({
@@ -27,34 +27,6 @@ function createChatStream() {
     return stream;
 }
 
-function getSteamChatObject() {
-    const created = Math.floor(Date.now() / 1000);
-
-    let lorem = faker.lorem.paragraph()
-    const loremArray = lorem.split(" ");
-
-    let ob = {
-        id: `chatcmpl-${faker.string.alphanumeric(30)}`,
-        object: 'chat.completion.chunk',
-        created: created,
-        model: "gpt-3.5-mock",
-        system_fingerprint: null,
-        choices: [
-            {
-                index: 0,
-                delta: {
-                    content: loremArray[0]
-                },
-                logprobs: null,
-                finish_reason: null
-            }
-        ]
-    }
-
-    return JSON.stringify(ob);
-}
-
 module.exports = {
     createChatStream,
-    getSteamChatObject,
 };

package/src/utils/fakeDataGenerators.js

@@ -0,0 +1,107 @@
+const { faker } = require("@faker-js/faker");
+
+function generateToolCallArguments(requestBody) {
+  const { parameters } = requestBody.tools[0].function;
+  const argumentsObject = {};
+
+  Object.entries(parameters.properties).forEach(([paramName, paramDetails]) => {
+    argumentsObject[paramName] = generateFakeData(
+      paramDetails.type,
+      paramDetails,
+      paramName
+    );
+  });
+
+  return JSON.stringify(argumentsObject, null, 2);
+}
+
+function generateFunctionCallArguments(requestBody) {
+  const { parameters } = requestBody.functions[0];
+  const argumentsObject = {};
+
+  Object.entries(parameters.properties).forEach(([paramName, paramDetails]) => {
+    argumentsObject[paramName] = generateFakeData(
+      paramDetails.type,
+      paramDetails,
+      paramName
+    );
+  });
+
+  return JSON.stringify(argumentsObject, null, 2);
+}
+
+function generateFakeData(type, properties, name) {
+  switch (type) {
+    case "string":
+      return generateFakeStringData(name);
+    case "number":
+      return faker.number.int({ max: 100 });
+    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 }, "item");
+    }
+  });
+}
+
+function generateFakeObject(properties) {
+  const itemObject = {};
+  Object.entries(properties.properties).forEach(([itemName, itemDetails]) => {
+    itemObject[itemName] = generateFakeData(itemDetails.type, itemDetails, itemName);
+  });
+  return itemObject;
+}
+
+function generateFakeStringData(name) {
+  if (name === "name") {
+    return faker.person.fullName();
+  } else if (name === "email") {
+    return faker.internet.email();
+  } else if (name === "price") {
+    return faker.commerce.price();
+  } else if (name === "company") {
+    return faker.company.name();
+  } else if (name === "phone") {
+    return faker.phone.number();
+  } else if (name === "address") {
+    return faker.location.streetAddress();
+  } else if (name === "date") {
+    return faker.date.past();
+  } else if (name === "jobTitle") {
+    return faker.person.jobTitle();
+  } else if (name === "creditCardNumber") {
+    return faker.finance.creditCardNumber();
+  } else if (name === "currencyCode") {
+    return faker.finance.currencyCode();
+  } else if (name === "productName") {
+    return faker.commerce.productName();
+  } else if (name === "uuid") {
+    return faker.string.uuid();
+  } else {
+    return faker.lorem.words(5);
+  }
+}
+
+module.exports = {
+  generateToolCallArguments,
+  generateFunctionCallArguments,
+  generateFakeData,
+  generateFakeArray,
+  generateFakeObject,
+  generateFakeStringData,
+};

package/src/utils/responseGenerators.js

@@ -0,0 +1,111 @@
+const { faker } = require("@faker-js/faker");
+const { generateFunctionCallArguments, generateToolCallArguments } = require('./fakeDataGenerators');
+
+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 isTool = Boolean(requestBody.tools);
+  const functionOrToolCallObject = isTool
+    ? [createToolCallObject(requestBody)]
+    : createFunctionCallObject(requestBody);
+  const functionOrToolCall = isTool ? "tool_calls" : "function_call";
+
+  return {
+    id: `chatcmpl-${faker.string.alphanumeric(30)}`,
+    object: "chat.completion",
+    created: created,
+    model: "gpt-3.5-mock",
+    choices: [
+      {
+        index: 0,
+        message: {
+          role: "assistant",
+          content: null,
+          [functionOrToolCall]: functionOrToolCallObject,
+        },
+        finish_reason: functionOrToolCall,
+      },
+    ],
+    usage: {
+      prompt_tokens: 81,
+      completion_tokens: 19,
+      total_tokens: 100,
+    },
+  };
+}
+
+function createToolCallObject(requestBody) {
+  return {
+    id: `call-${faker.string.alphanumeric(30)}`,
+    type: "function",
+    function: {
+      name: `${requestBody.tools[0].function.name}`,
+      arguments: `${generateToolCallArguments(requestBody)}`,
+    },
+  };
+}
+
+function createFunctionCallObject(requestBody) {
+  return {
+    name: `${requestBody.functions[0].name}`,
+    arguments: `${generateFunctionCallArguments(requestBody)}`,
+  };
+}
+
+function getSteamChatObject() {
+  const created = Math.floor(Date.now() / 1000);
+
+  let lorem = faker.lorem.paragraph()
+  const loremArray = lorem.split(" ");
+
+  let ob = {
+    id: `chatcmpl-${faker.string.alphanumeric(30)}`,
+    object: 'chat.completion.chunk',
+    created: created,
+    model: "gpt-3.5-mock",
+    system_fingerprint: null,
+    choices: [
+      {
+        index: 0,
+        delta: {
+          content: loremArray[0]
+        },
+        logprobs: null,
+        finish_reason: null
+      }
+    ]
+  }
+
+  return JSON.stringify(ob);
+}
+
+module.exports = {
+  createDefaultResponse,
+  createFunctionCallingResponse,
+  createToolCallObject,
+  createFunctionCallObject,
+  getSteamChatObject,
+};