openai-api-mock 0.1.24 → 0.1.26

package/.github/workflows/test.yml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x]
 
     steps:
     - uses: actions/checkout@v4
@@ -26,5 +26,8 @@ jobs:
     - name: Install dependencies
       run: npm ci
       
-    - name: Run tests
-      run: npm test
+    - name: Build package
+      run: npm run build
+      
+    - name: Run tests  
+      run: npm test

package/{readme.md → README.md}

@@ -23,8 +23,15 @@ npm install -D openai-api-mock
 ```
 
 ## Usage
+
+The module supports both ESM and CommonJS imports:
+
 ```js
+// ESM
 import { mockOpenAIResponse } from 'openai-api-mock';
+
+// CommonJS
+const { mockOpenAIResponse } = require('openai-api-mock');
 ```
 
 Then, call the mockOpenAIResponse function to set up the mock response:
@@ -61,7 +68,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/__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" });