twd-js 0.5.1 → 0.6.0

package/README.md

@@ -73,7 +73,6 @@ pnpm add twd-js
       // Use Vite's glob import to find all test files
       const testModules = import.meta.glob("./**/*.twd.test.ts");
       const { initTests, twd, TWDSidebar } = await import('twd-js');
-      const { createRoot } = await import('react-dom/client');
       // You need to pass the test modules, the sidebar component, and createRoot function
       initTests(testModules, <TWDSidebar open={true} position="left" />, createRoot);
       // if you want to use mock requests, you can initialize it here
@@ -141,7 +140,6 @@ pnpm add twd-js
        // Use Vite's glob import to find all test files
        const testModules = import.meta.glob("./**/*.twd.test.ts");
        const { initTests, twd, TWDSidebar } = await import('twd-js');
-       const { createRoot } = await import('react-dom/client');
        // You need to pass the test modules, the sidebar component, and createRoot function
        initTests(testModules, <TWDSidebar open={true} position="left" />, createRoot);
        // Optionally initialize request mocking
@@ -171,7 +169,6 @@ pnpm add twd-js
          './another-test-file.twd.test.ts': () => import('./another-test-file.twd.test'),
        };
        const { initTests, TWDSidebar } = await import('twd-js');
-       const { createRoot } = await import('react-dom/client');
        initTests(testModules, <TWDSidebar open={true} position="left" />, createRoot);
      }
      ```
@@ -292,6 +289,25 @@ npx twd-js init <public-dir> [--save]
 
 This will copy `mock-sw.js` to your public directory.
 
+**Removing the Service Worker in Production Builds**
+
+The service worker file (`mock-sw.js`) is only needed during development for API mocking. To remove it from production builds, use the `removeMockServiceWorker` Vite plugin:
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite';
+import { removeMockServiceWorker } from 'twd-js';
+
+export default defineConfig({
+  plugins: [
+    // ... other plugins
+    removeMockServiceWorker()
+  ]
+});
+```
+
+This plugin will automatically remove `mock-sw.js` from your build output during production builds.
+
 ### Mock Requests
 
 Use `twd.mockRequest()` to define API mocks in your tests:

package/dist/commands/mockBridge.d.ts

@@ -6,7 +6,7 @@ export type Rule = {
     executed?: boolean;
     request?: unknown;
     status?: number;
-    headers?: Record<string, string>;
+    responseHeaders?: Record<string, string>;
     urlRegex?: boolean;
 };
 export interface Options {
@@ -14,7 +14,7 @@ export interface Options {
     url: string | RegExp;
     response: unknown;
     status?: number;
-    headers?: Record<string, string>;
+    responseHeaders?: Record<string, string>;
     urlRegex?: boolean;
 }
 /**
@@ -31,7 +31,8 @@ export declare const initRequestMocking: () => Promise<void>;
  *  - `url`: URL string or RegExp to match
  *  - `response`: Body of the mocked response
  *  - `status`: (optional) HTTP status code (default: 200)
- *  - `headers`: (optional) Response headers
+ *  - `responseHeaders`: (optional) Response headers
+ *  - `urlRegex`: (optional) Whether the URL is a regex (default: false)
  *
  * @example
  * ```ts

package/dist/index.d.ts

@@ -3,3 +3,4 @@ export { TWDSidebar } from './ui/TWDSidebar';
 export { initTests } from './initializers/initTests';
 export { expect } from 'chai';
 export { userEvent } from './proxies/userEvent';
+export { removeMockServiceWorker } from './plugin/removeMockServiceWorker';

package/dist/initializers/initTests.d.ts

@@ -21,7 +21,6 @@ type TestModule = Record<string, () => Promise<unknown>>;
  * if (import.meta.env.DEV) {
  *   const testModules = import.meta.glob("./example.twd.test.ts");
  *   const { initTests, TWDSidebar } = await import('twd-js');
- *   const { createRoot } = await import('react-dom/client');
  *   await initTests(testModules, <TWDSidebar open={true} position="left" />, createRoot);
  * }
  * ```

package/dist/mock-sw.js

@@ -1 +1 @@
-function c(t,s,n){return n.find(e=>{const l=e.method.toLowerCase()===t.toLowerCase();if(e.urlRegex){const r=new RegExp(e.url);return l&&r.test(s)}const a=e.url===s||s.includes(e.url);return l&&a})}function i(t,s,n){t.forEach(e=>e.postMessage({type:"EXECUTED",alias:s.alias,request:n}))}let o=[];const u=async t=>{const{method:s}=t.request,n=t.request.url,e=c(s,n,o);e&&(console.log("Mock hit:",e.alias,s,n),t.respondWith((async()=>{let l=null;try{l=await t.request.clone().text()}catch{}return self.clients.matchAll().then(a=>{i(a,e,l)}),new Response(JSON.stringify(e.response),{status:e.status||200,headers:e.headers||{"Content-Type":"application/json"}})})()))},d=t=>{const{type:s,rule:n}=t.data||{};s==="ADD_RULE"&&(o=o.filter(e=>e.alias!==n.alias),o.push(n),console.log("Rule added:",n)),s==="CLEAR_RULES"&&(o=[],console.log("All rules cleared"))};self.addEventListener("fetch",u);self.addEventListener("message",d);
+function u(e,s,n){return n.find(t=>{const o=t.method.toLowerCase()===e.toLowerCase();if(t.urlRegex){const a=new RegExp(t.url);return o&&a.test(s)}const l=t.url===s||s.includes(t.url);return o&&l})}function d(e,s,n){e.forEach(t=>t.postMessage({type:"EXECUTED",alias:s.alias,request:n}))}const f=(e,s,n)=>{const o=![204,205,304].includes(s),l=o?JSON.stringify(e):null;return new Response(l,{status:s,headers:o?n||{"Content-Type":"application/json"}:n||{}})};let c=[];const h=async e=>{const{method:s}=e.request,n=e.request.url,t=u(s,n,c);t&&(console.log("[TWD] Mock hit:",t.alias,s,n),e.respondWith((async()=>{let o=null;const l=e.request.headers.get("content-type")||"application/json";if(l.includes("application/json"))try{o=await e.request.clone().json()}catch{}else if(l.includes("form"))try{const a=await e.request.clone().formData();o={},a.forEach((r,i)=>{o[i]=r})}catch{}else if(l.includes("text"))try{o=await e.request.clone().text()}catch{}else if(l.includes("octet-stream"))try{o=await e.request.clone().arrayBuffer()}catch{}else if(l.includes("image"))try{o=await e.request.clone().blob()}catch{}else try{o=await e.request.clone().text()}catch{}return self.clients.matchAll().then(a=>{d(a,t,o)}),f(t.response,t.status??200,t.responseHeaders)})()))},y=e=>{const{type:s,rule:n}=e.data||{};s==="ADD_RULE"&&(c=c.filter(t=>t.alias!==n.alias),c.push(n),console.log("[TWD] Rule added:",n)),s==="CLEAR_RULES"&&(c=[],console.log("[TWD] All rules cleared"))};console.log("[TWD] Mock Service Worker loaded - version 0.6.0");self.addEventListener("fetch",h);self.addEventListener("message",y);

package/dist/plugin/removeMockServiceWorker.d.ts

@@ -0,0 +1,18 @@
+import { Plugin } from 'vite';
+/**
+ * Vite plugin to remove the mock service worker file from the build output.
+ * This is useful for production builds where you don't want the mock service worker to be included.
+ *
+ * @example
+ * ```ts
+ * import { removeMockServiceWorker } from 'twd-js';
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     // ... other plugins
+ *     removeMockServiceWorker()
+ *   ]
+ * });
+ * ```
+ */
+export declare function removeMockServiceWorker(): Plugin;