openai-api-mock 0.1.24 → 0.1.25

package/__tests__/custom_endpoint.test.js

@@ -0,0 +1,47 @@
+import fetch from 'node-fetch';
+import { mockOpenAIResponse, stopMocking } from '../src/index.js';
+
+describe('Mock Custom OpenAI endpoint', () => {
+    let mock;
+    beforeEach(() => {
+        mock = mockOpenAIResponse(true, { logRequests: true });
+    });
+
+    afterEach(() => {
+        stopMocking();
+    });
+
+    test('should mock custom endpoint', async () => {
+        mock.addCustomEndpoint('POST', '/v1/custom/endpoint', () => {
+            return [200, { message: 'Custom endpoint response' }];
+        });
+        const response = await fetch('https://api.openai.com/v1/custom/endpoint'
+            , {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                },
+            }
+        );
+
+        const data = await response.json();
+        expect(data).toEqual({ message: 'Custom endpoint response' });
+    });
+
+    test('should mock custom endpoint with error', async () => {
+        mock.addCustomEndpoint('POST', '/v1/custom/endpoint', () => {
+            return [400, { error: { message: 'Invalid request' } }];
+        });
+        const response = await fetch('https://api.openai.com/v1/custom/endpoint'
+            , {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                },
+            }
+        );
+
+        const data = await response.json();
+        expect(data).toEqual({ error: { message: 'Invalid request' } });
+    });
+});

package/{src → __tests__}/index.test.js

@@ -1,5 +1,5 @@
 import fetch from 'node-fetch';
-import { mockOpenAIResponse, stopMocking } from  './index.js'
+import { mockOpenAIResponse, stopMocking } from  '../src/index.js';
 import OpenAI from 'openai'; 
 
 const openai = new OpenAI({ apiKey: "OPENAI_API_KEY" });

package/package.json

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

package/readme.md

@@ -61,7 +61,7 @@ console.log(mock.isActive);
 // Stop all mocks
 mock.stopMocking();
 
-// Add custom endpoint mock
+// Add custom endpoint mock (uses api.openai.com as base url)
 mock.addCustomEndpoint('POST', '/v1/custom', (uri, body) => {
     return [200, { custom: 'response' }];
 });

package/src/index.js

@@ -6,7 +6,7 @@ import { getImageResponce } from './image.js';
 const OPEN_AI_BASE_URL = 'https://api.openai.com';
 const CHAT_COMPLETIONS_ENDPOINT = '/v1/chat/completions';
 const IMAGE_GENERATIONS_ENDPOINT = '/v1/images/generations';
-
+const customScopes = []; // Track custom scopes
 /**
  * Mock OpenAI API responses
  * @param {boolean} force - Force mocking regardless of environment
@@ -22,18 +22,18 @@ function mockOpenAIResponse(force = false, options = {}) {
         latency = 0,
         logRequests = false
     } = options;
-    
+
     const env = process.env.NODE_ENV || 'development';
-    
+
     // Only proceed if in development or forced
     if (env !== 'development' && !force) {
         return { isActive: false, stopMocking };
     }
-    
+
     // Add delay if latency is specified
-    const delayResponse = latency > 0 ? 
+    const delayResponse = latency > 0 ?
         nock.defaults({ delayConnection: latency }) : null;
-    
+
     // Mock chat completions endpoint
     const chatScope = nock(OPEN_AI_BASE_URL)
         .post(CHAT_COMPLETIONS_ENDPOINT)
@@ -41,32 +41,32 @@ function mockOpenAIResponse(force = false, options = {}) {
             if (logRequests) {
                 console.log(`[openai-api-mock] Chat request:`, JSON.stringify(requestBody, null, 2));
             }
-            
+
             try {
                 // Validate minimal required fields
                 if (!requestBody.model || !requestBody.messages || !Array.isArray(requestBody.messages)) {
                     return [400, { error: { message: 'Invalid request. Missing required fields.' } }];
                 }
-                
+
                 // Simulate random errors if enabled
                 if (includeErrors && Math.random() < 0.05) {
                     return [429, { error: { message: 'Rate limit exceeded' } }];
                 }
-                
+
                 const isSteaming = requestBody.stream === true;
-                
+
                 if (isSteaming) {
                     const stream = createChatStream(requestBody);
                     return [200, stream];
                 }
-                
+
                 return [200, getChatResponce(requestBody)];
             } catch (error) {
                 console.error('[openai-api-mock] Error processing chat request:', error);
                 return [500, { error: { message: 'Internal server error in mock' } }];
             }
         });
-    
+
     // Mock image generations endpoint
     const imageScope = nock(OPEN_AI_BASE_URL)
         .post(IMAGE_GENERATIONS_ENDPOINT)
@@ -74,49 +74,54 @@ function mockOpenAIResponse(force = false, options = {}) {
             if (logRequests) {
                 console.log(`[openai-api-mock] Image request:`, JSON.stringify(requestBody, null, 2));
             }
-            
+
             try {
                 // Validate minimal required fields
                 if (!requestBody.prompt) {
                     return [400, { error: { message: 'Invalid request. Missing prompt.' } }];
                 }
-                
+
                 // Simulate random errors if enabled
                 if (includeErrors && Math.random() < 0.05) {
                     return [400, { error: { message: 'Your request was rejected as a result of our safety system.' } }];
                 }
-                
+
                 return [200, getImageResponce(requestBody)];
             } catch (error) {
                 console.error('[openai-api-mock] Error processing image request:', error);
                 return [500, { error: { message: 'Internal server error in mock' } }];
             }
         });
-    
+
     // Enable other network connections
     nock.enableNetConnect(host => host !== "api.openai.com");
-    
+
+
+
     return {
         isActive: true,
         stopMocking,
-        
+
         /**
          * Adds a custom endpoint mock
-         * @param {string} method - HTTP method (GET, POST, etc.)
-         * @param {string} path - Path to mock (e.g., '/v1/custom')
-         * @param {Function} handler - Handler function that returns [statusCode, responseBody]
+         * @param {string} method - HTTP method (e.g., 'GET', 'POST')
+         * @param {string} path - Endpoint path (e.g., '/v1/custom')
+         * @param {Function} handler - Function returning [statusCode, responseBody]
          */
         addCustomEndpoint(method, path, handler) {
-            nock(OPEN_AI_BASE_URL)[method.toLowerCase()](path).reply(handler);
+            const methodLower = method.toLowerCase();
+            const scope = nock(OPEN_AI_BASE_URL)
+            [methodLower](path)
+                .reply(handler)
+                .persist(); // Keep the mock active indefinitely
+            customScopes.push(scope);
         }
     };
 }
 
-/**
- * Stop all active mocks
- */
 function stopMocking() {
     nock.cleanAll();
+    customScopes.forEach(scope => scope.persist(false)); // Disable persistence
 }
 
 export { mockOpenAIResponse, stopMocking };