openai-api-mock 0.1.21 → 0.1.22

package/main.js

@@ -1,9 +1,7 @@
-const nock = require('nock');
-
-
-const { getChatResponce } = require('./src/chat.js');
-const { createChatStream } = require('./src/chat.stream.js');
-const { getImageResponce } = require('./src/image.js');
+import nock from 'nock';
+import { getChatResponce } from './src/chat.js';
+import { createChatStream } from './src/chat.stream.js';
+import { getImageResponce } from './src/image.js';
 
 const OPEN_AI_BASE_URL = 'https://api.openai.com';
 const CHAT_COMPLETIONS_ENDPOINT = '/v1/chat/completions';
@@ -41,7 +39,4 @@ function stopMocking() {
     nock.cleanAll();
 }
 
-module.exports = {
-    mockOpenAIResponse,
-    stopMocking,
-};
+export { mockOpenAIResponse, stopMocking };

package/main.test.js

@@ -1,5 +1,6 @@
-const { mockOpenAIResponse, stopMocking } = require('./main');
-const OpenAI = require('openai');
+import { mockOpenAIResponse, stopMocking } from  './main.js'
+import OpenAI from 'openai'; 
+
 const openai = new OpenAI({ apiKey: "OPENAI_API_KEY" });
 
 describe('Mock OpenAI Chat & Image generation API', () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openai-api-mock",
-  "version": "0.1.21",
+  "version": "0.1.22",
   "description": "A Node.js module for mocking OpenAI API responses in a development environment",
   "repository": {
     "type": "git",
@@ -17,7 +17,7 @@
     "interceptor"
   ],
   "scripts": {
-    "test": "jest"
+    "test":"node --experimental-vm-modules node_modules/jest/bin/jest.js"
   },
   "author": "Chiheb Nabil",
   "license": "MIT",
@@ -30,4 +30,4 @@
     "jest": "^29.7.0",
     "openai": "^4.52.4"
   }
-}
+}

package/readme.md

@@ -20,10 +20,9 @@ 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');
+import { mockOpenAIResponse } from 'openai-api-mock';
 ```
 
 Then, call the mockOpenAIResponse function to set up the mock response:
@@ -31,17 +30,18 @@ Then, call the mockOpenAIResponse function to set up the mock response:
 ```js
 mockOpenAIResponse();
 ```
-This function intercepts HTTP calls to the OpenAI endpoint and returns a mock response. The mock response is generated based on the requestBody of the code , and it supports complex (function call) requestBody structures like arrays and nested objects.
+This function intercepts HTTP calls to the OpenAI endpoint and returns a mock response. The mock response is generated based on the requestBody of the code, and it supports complex (function call) requestBody structures like arrays and nested objects.
 
 ```js
-mockOpenAIResponse(force = true);
+mockOpenAIResponse(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 `NODE_ENV` environment variable is set to `development`.
 
-### Example responces
+### Example responses
 
 ```js
 // Call the mockOpenAIResponse function once to set up the mock
@@ -51,7 +51,7 @@ mockOpenAIResponse()
 const response = await openai.chat.completions.create({
                 model: "gpt-3.5",
                 messages: [
-                    { role: 'system', content: "You'r an expert chef" },
+                    { role: 'system', content: "You're an expert chef" },
                     { role: 'user', content: "Suggest at least 5 recipes" },
                 ]
 });
@@ -85,7 +85,7 @@ const response = await openai.chat.completions.create({
                 model: "gpt-3.5",
                 stream : true,
                 messages: [
-                    { role: 'system', content: "You'r an expert chef" },
+                    { role: 'system', content: "You're an expert chef" },
                     { role: 'user', content: "Suggest at least 5 recipes" },
                 ]
 });

package/src/chat.js

@@ -1,4 +1,4 @@
-const { createDefaultResponse, createFunctionCallingResponse } = require('./utils/responseGenerators');
+import { createDefaultResponse, createFunctionCallingResponse } from './utils/responseGenerators.js';
 
 function getChatResponce(requestBody) {
   const created = Math.floor(Date.now() / 1000);
@@ -10,6 +10,7 @@ function getChatResponce(requestBody) {
   return createFunctionCallingResponse(requestBody, created);
 }
 
-module.exports = {
+
+export {
   getChatResponce,
 };

package/src/chat.stream.js

@@ -1,5 +1,5 @@
-const { Readable } = require('stream');
-const { getSteamChatObject } = require('./utils/responseGenerators');
+import { Readable } from 'node:stream';
+import { getSteamChatObject } from './utils/responseGenerators.js'
 
 function createChatStream() {
     const stream = new Readable({
@@ -27,6 +27,7 @@ function createChatStream() {
     return stream;
 }
 
-module.exports = {
+
+export {
     createChatStream,
 };

package/src/image.js

@@ -1,5 +1,4 @@
-const { faker } = require('@faker-js/faker');
-
+import { faker } from '@faker-js/faker';
 
 function getImageResponce(requestBody) {
 
@@ -19,6 +18,7 @@ function getImageResponce(requestBody) {
 }
 
 
-module.exports = {
+
+export {
   getImageResponce,
 };

package/src/utils/fakeDataGenerators.js

@@ -1,4 +1,4 @@
-const { faker } = require("@faker-js/faker");
+import { faker } from '@faker-js/faker';
 
 function generateToolCallArguments(requestBody) {
   const { parameters } = requestBody.tools[0].function;
@@ -97,7 +97,7 @@ function generateFakeStringData(name) {
   }
 }
 
-module.exports = {
+export {
   generateToolCallArguments,
   generateFunctionCallArguments,
   generateFakeData,

package/src/utils/responseGenerators.js

@@ -1,5 +1,5 @@
-const { faker } = require("@faker-js/faker");
-const { generateFunctionCallArguments, generateToolCallArguments } = require('./fakeDataGenerators');
+import { faker } from '@faker-js/faker';
+import  { generateFunctionCallArguments, generateToolCallArguments } from './fakeDataGenerators.js'
 
 function createDefaultResponse(created) {
   return {
@@ -102,7 +102,8 @@ function getSteamChatObject() {
   return JSON.stringify(ob);
 }
 
-module.exports = {
+
+export {
   createDefaultResponse,
   createFunctionCallingResponse,
   createToolCallObject,