twd-js 1.7.1 → 1.7.3

package/dist/cli.js

@@ -1,35 +1,35 @@
 #!/usr/bin/env node
-import fs from "fs";
-import path from "path";
-import { fileURLToPath } from "url";
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 const [, , command, targetDir, ...flags] = process.argv;
 
-if (command !== "init") {
-  console.error("Usage: npx twd-js init <public-dir> [--save]");
+if (command !== 'init') {
+  console.error('Usage: npx twd-js init <public-dir> [--save]');
   process.exit(1);
 }
 
 if (!targetDir) {
-  console.error("❌ You must provide a target public dir");
+  console.error('❌ You must provide a target public dir');
   process.exit(1);
 }
 
-const save = flags.includes("--save");
-const src = path.join(__dirname, "../dist/mock-sw.js");
-const dest = path.resolve(process.cwd(), targetDir, "mock-sw.js");
+const save = flags.includes('--save');
+const src = path.join(__dirname, '../dist/mock-sw.js');
+const dest = path.resolve(process.cwd(), targetDir, 'mock-sw.js');
 
 fs.mkdirSync(path.dirname(dest), { recursive: true });
 fs.copyFileSync(src, dest);
 
 console.log(`✅ mock-sw.js copied to ${dest}`);
 if (save) {
-  console.log("💡 Remember to register it in your app:");
+  console.log('💡 Remember to register it in your app:');
   console.log(`
 if ("serviceWorker" in navigator) {
   navigator.serviceWorker.register("/mock-sw.js");
 }
   `);
-}
+}

package/dist/commands/mockBridge.d.ts

@@ -0,0 +1,117 @@
+export type Rule = {
+    /** HTTP method to match (e.g. `"GET"`, `"POST"`). */
+    method: string;
+    /** URL string or RegExp to match against the request URL. */
+    url: string | RegExp;
+    /** The mocked response body returned to the client. */
+    response: unknown;
+    /** Unique identifier for this mock rule, used with `waitForRequest`. */
+    alias: string;
+    /** Whether this rule has been matched by an actual request. Set automatically by the service worker. */
+    executed?: boolean;
+    /**
+     * The parsed request body sent by the client.
+     * For JSON requests this is the parsed object, for form data an object of key/value pairs, for text a string.
+     * Access fields directly: `rule.request.email`, **not** `rule.request.body.email`.
+     */
+    request?: any;
+    /** HTTP status code for the mocked response (default: `200`). */
+    status?: number;
+    /** Headers to include in the mocked response. */
+    responseHeaders?: Record<string, string>;
+    /** Whether the `url` field should be treated as a regex pattern. */
+    urlRegex?: boolean;
+    /** Delay in milliseconds before returning the mocked response. */
+    delay?: number;
+    /** Number of times this rule has been matched. Updated automatically by the service worker. */
+    hitCount?: number;
+};
+export interface Options {
+    /** HTTP method to match (e.g. `"GET"`, `"POST"`). */
+    method: string;
+    /** URL string or RegExp to match against the request URL. */
+    url: string | RegExp;
+    /** The mocked response body returned to the client. */
+    response: unknown;
+    /** HTTP status code for the mocked response (default: `200`). */
+    status?: number;
+    /** Headers to include in the mocked response. */
+    responseHeaders?: Record<string, string>;
+    /** Whether the `url` field should be treated as a regex pattern. */
+    urlRegex?: boolean;
+    /** Delay in milliseconds before returning the mocked response. */
+    delay?: number;
+}
+/**
+ * Initialize the mocking service worker.
+ * Call this once before using `mockRequest` or `waitFor`.
+ */
+export declare const initRequestMocking: (path?: string) => Promise<void>;
+/**
+ * Mock a network request.
+ *
+ * @param alias Identifier for the mock rule. Useful for `waitFor()`.
+ * @param options Options to configure the mock:
+ *  - `method`: HTTP method ("GET", "POST", …)
+ *  - `url`: URL string or RegExp to match
+ *  - `response`: Body of the mocked response
+ *  - `status`: (optional) HTTP status code (default: 200)
+ *  - `responseHeaders`: (optional) Response headers
+ *  - `urlRegex`: (optional) Whether the URL is a regex (default: false)
+ *  - `delay`: (optional) Delay in ms before returning the response
+ *
+ * @example
+ * ```ts
+ * mockRequest("getUser", {
+ *   method: "GET",
+ *   url: /\/api\/user\/\d+/,
+ *   response: { id: 1, name: "Kevin" },
+ *   status: 200,
+ *   responseHeaders: { "x-mock": "true" }
+ * });
+ * ```
+ */
+export declare const mockRequest: (alias: string, options: Options) => Promise<void>;
+/**
+ * wait for a list of mocked requests to be made.
+ * @param aliases The aliases of the mock rules to wait for
+ * @returns The matched rules (with body if applicable)
+ * @example
+ * ```ts
+ * await waitForRequests(["getUser", "postComment"]);
+ * ```
+ */
+export declare const waitForRequests: (aliases: string[]) => Promise<Rule[]>;
+/**
+ * Wait for a mocked request to be made.
+ * @param alias The alias of the mock rule to wait for
+ * @param retries The number of retries to make
+ * @param retryDelay The delay between retries
+ * @returns The matched rule (with body if applicable)
+ */
+export declare const waitForRequest: (alias: string, retries?: number, retryDelay?: number) => Promise<Rule>;
+/**
+ * Get the current list of request mock rules.
+ * @returns The current list of request mock rules.
+ */
+export declare const getRequestMockRules: () => Rule[];
+/**
+ * Clear all request mock rules.
+ */
+export declare const clearRequestMockRules: () => void;
+/**
+ * Get the number of times a specific mock rule was hit.
+ * @param alias The alias of the mock rule
+ * @returns The number of times the rule was matched
+ */
+export declare const getRequestCount: (alias: string) => number;
+/**
+ * Get a snapshot of all mock rule hit counts.
+ * @returns An object mapping rule aliases to their hit counts
+ */
+export declare const getRequestCounts: () => Record<string, number>;
+/**
+ * Reset the initialized state. Only use in tests.
+ * @internal
+ */
+export declare const resetMockingState: () => void;

package/dist/commands/url.d.ts

@@ -0,0 +1,33 @@
+/**
+ * All supported assertion names for the `should` function in url command
+ *
+ * @example
+ * twd.url().should("contain.url", "/new-page");
+ * twd.url().should("eq", "http://localhost:3000/new-page");
+ */
+export type URLAssertionName = 'eq' | 'contain.url';
+/**
+ * Negatable assertion names (e.g., 'not.have.text').
+ */
+export type Negatable<T extends string> = T | `not.${T}`;
+/**
+ * All assertion names, including negated ones.
+ */
+export type AnyURLAssertion = Negatable<URLAssertionName>;
+export type URLCommandAPI = {
+    location: Location;
+    should: (name: AnyURLAssertion, value: string, retries?: number) => Promise<string>;
+};
+/**
+ * Argument types for each assertion.
+ */
+export type URLAssertionArgs = {
+    (name: 'contain.url', urlPart: string): URLCommandAPI;
+    (name: 'not.contain.url', urlPart: string): URLCommandAPI;
+};
+/**
+ * URL command for assertions on the current URL.
+ * @returns URLCommandAPI
+ */
+declare const urlCommand: () => URLCommandAPI;
+export default urlCommand;

package/dist/commands/viewport.d.ts

@@ -0,0 +1,2 @@
+export declare const viewport: (width?: number, height?: number) => void;
+export declare const resetViewport: () => void;

package/dist/commands/visit.d.ts

@@ -0,0 +1 @@
+export declare const visit: (url: string, reload?: boolean) => Promise<void>;

package/dist/constants/version.d.ts

@@ -0,0 +1 @@
+export declare const TWD_VERSION = "1.7.3";

package/dist/global.d.ts

@@ -0,0 +1,20 @@
+// global.d.ts
+export {};
+
+declare global {
+  interface Window {
+    __testRunner?: any;
+    __TWD_STATE__?: any;
+    __TWD_MOCK_STATE__?: any;
+    __twdCollectMock?: (mock: {
+      alias: string;
+      url: string;
+      method: string;
+      status: number;
+      response: unknown;
+      responseHeaders?: Record<string, string>;
+      urlRegex: boolean;
+      testId: string;
+    }) => void;
+  }
+}