executable-stories-showcase 0.0.0-stage → 0.0.0

package/dist/schema.d.ts

@@ -0,0 +1,161 @@
+import { z } from 'zod';
+/** Scenarios live in JSON files and URLs, so everything they carry is JSON. */
+export declare const JsonSchema: z.ZodJSONSchema;
+export type Json = z.output<typeof JsonSchema>;
+export type JsonObject = {
+    [key: string]: Json;
+};
+/** Anything an app can hand over to be stored as JSON. */
+export type Serializable = object | string | number | boolean | null;
+/**
+ * Decode JSON text. Pair with `JSON.stringify` to copy app state into the format scenarios
+ * are stored in: functions and undefined drop out, and the result is checked to be JSON.
+ */
+export declare const parseJson: (text: string) => Json;
+export declare const MethodSchema: z.ZodEnum<{
+    GET: "GET";
+    POST: "POST";
+    PUT: "PUT";
+    PATCH: "PATCH";
+    DELETE: "DELETE";
+    HEAD: "HEAD";
+    OPTIONS: "OPTIONS";
+}>;
+declare const ResponseSchema: z.ZodObject<{
+    status: z.ZodDefault<z.ZodNumber>;
+    body: z.ZodOptional<z.ZodJSONSchema>;
+    text: z.ZodOptional<z.ZodString>;
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    delay: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodLiteral<"infinite">]>>;
+}, z.core.$strip>;
+declare const NetworkEntrySchema: z.ZodObject<{
+    method: z.ZodDefault<z.ZodEnum<{
+        GET: "GET";
+        POST: "POST";
+        PUT: "PUT";
+        PATCH: "PATCH";
+        DELETE: "DELETE";
+        HEAD: "HEAD";
+        OPTIONS: "OPTIONS";
+    }>>;
+    path: z.ZodString;
+    query: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    response: z.ZodOptional<z.ZodObject<{
+        status: z.ZodDefault<z.ZodNumber>;
+        body: z.ZodOptional<z.ZodJSONSchema>;
+        text: z.ZodOptional<z.ZodString>;
+        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        delay: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodLiteral<"infinite">]>>;
+    }, z.core.$strip>>;
+    sequence: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        status: z.ZodDefault<z.ZodNumber>;
+        body: z.ZodOptional<z.ZodJSONSchema>;
+        text: z.ZodOptional<z.ZodString>;
+        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        delay: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodLiteral<"infinite">]>>;
+    }, z.core.$strip>>>;
+    remove: z.ZodOptional<z.ZodLiteral<true>>;
+}, z.core.$strip>;
+export declare const ScenarioSchema: z.ZodObject<{
+    $schema: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    extends: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+    path: z.ZodOptional<z.ZodString>;
+    url: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>>;
+    network: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        method: z.ZodDefault<z.ZodEnum<{
+            GET: "GET";
+            POST: "POST";
+            PUT: "PUT";
+            PATCH: "PATCH";
+            DELETE: "DELETE";
+            HEAD: "HEAD";
+            OPTIONS: "OPTIONS";
+        }>>;
+        path: z.ZodString;
+        query: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        response: z.ZodOptional<z.ZodObject<{
+            status: z.ZodDefault<z.ZodNumber>;
+            body: z.ZodOptional<z.ZodJSONSchema>;
+            text: z.ZodOptional<z.ZodString>;
+            headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            delay: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodLiteral<"infinite">]>>;
+        }, z.core.$strip>>;
+        sequence: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            status: z.ZodDefault<z.ZodNumber>;
+            body: z.ZodOptional<z.ZodJSONSchema>;
+            text: z.ZodOptional<z.ZodString>;
+            headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            delay: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodLiteral<"infinite">]>>;
+        }, z.core.$strip>>>;
+        remove: z.ZodOptional<z.ZodLiteral<true>>;
+    }, z.core.$strip>>>;
+    handlers: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    state: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodJSONSchema>>;
+    ready: z.ZodOptional<z.ZodString>;
+    viewport: z.ZodOptional<z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type Scenario = z.output<typeof ScenarioSchema>;
+export type ScenarioInput = z.input<typeof ScenarioSchema>;
+export type NetworkEntry = z.output<typeof NetworkEntrySchema>;
+export type ScenarioResponse = z.output<typeof ResponseSchema>;
+/**
+ * JSON Schema for editors, validators and AI generators.
+ * Pass adapter state schemas so `state` is described too.
+ */
+export declare function scenarioJsonSchema({ state }?: {
+    state?: Record<string, z.ZodType>;
+}): z.core.ZodStandardJSONSchemaPayload<z.ZodObject<{
+    $schema: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    extends: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+    path: z.ZodOptional<z.ZodString>;
+    url: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>>;
+    network: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        method: z.ZodDefault<z.ZodEnum<{
+            GET: "GET";
+            POST: "POST";
+            PUT: "PUT";
+            PATCH: "PATCH";
+            DELETE: "DELETE";
+            HEAD: "HEAD";
+            OPTIONS: "OPTIONS";
+        }>>;
+        path: z.ZodString;
+        query: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        response: z.ZodOptional<z.ZodObject<{
+            status: z.ZodDefault<z.ZodNumber>;
+            body: z.ZodOptional<z.ZodJSONSchema>;
+            text: z.ZodOptional<z.ZodString>;
+            headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            delay: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodLiteral<"infinite">]>>;
+        }, z.core.$strip>>;
+        sequence: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            status: z.ZodDefault<z.ZodNumber>;
+            body: z.ZodOptional<z.ZodJSONSchema>;
+            text: z.ZodOptional<z.ZodString>;
+            headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            delay: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodLiteral<"infinite">]>>;
+        }, z.core.$strip>>>;
+        remove: z.ZodOptional<z.ZodLiteral<true>>;
+    }, z.core.$strip>>>;
+    handlers: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    ready: z.ZodOptional<z.ZodString>;
+    viewport: z.ZodOptional<z.ZodObject<{
+        width: z.ZodNumber;
+        height: z.ZodNumber;
+    }, z.core.$strip>>;
+    state: z.ZodOptional<z.ZodObject<{
+        [x: string]: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
+    }, z.core.$catchall<z.ZodJSONSchema>>>;
+}, z.core.$strip>>;
+/** Validate scenario input (from a file, URL or editor) into a Scenario, with readable errors. */
+export declare function parseScenario(data: ScenarioInput, source?: string): Scenario;
+export {};

package/dist/vite.d.ts

@@ -0,0 +1,11 @@
+import type { Plugin } from 'vite';
+export { SAVE_ENDPOINT } from './link.js';
+export interface ExecutableStoriesShowcasePluginOptions {
+    /** Folder the panel's "Save to project" writes into, relative to the Vite root. Default "src/scenarios". */
+    dir?: string;
+}
+/**
+ * Dev-server plugin: lets the panel save a captured scenario straight into the project
+ * instead of the Downloads folder. Only runs under `vite dev`, and only for this machine.
+ */
+export declare function executableStoriesShowcase({ dir }?: ExecutableStoriesShowcasePluginOptions): Plugin;

package/dist/vite.js

@@ -0,0 +1,26 @@
+import {
+  createSaveHandler
+} from "./chunk-Z664X6AQ.js";
+import {
+  SAVE_ENDPOINT
+} from "./chunk-PKGBYTBX.js";
+import "./chunk-BK4EEQXV.js";
+
+// src/vite.ts
+import { resolve } from "path";
+function executableStoriesShowcase({ dir = "src/scenarios" } = {}) {
+  return {
+    name: "executable-stories-showcase",
+    apply: "serve",
+    configureServer(server) {
+      const root = server.config.root;
+      const handler = createSaveHandler({ dir: resolve(root, dir), root });
+      server.middlewares.use(SAVE_ENDPOINT, (req, res) => void handler(req, res));
+    }
+  };
+}
+export {
+  SAVE_ENDPOINT,
+  executableStoriesShowcase
+};
+//# sourceMappingURL=vite.js.map

package/dist/vite.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/vite.ts"],"sourcesContent":["import { resolve } from 'node:path';\nimport type { Plugin } from 'vite';\nimport { SAVE_ENDPOINT } from './link.js';\nimport { createSaveHandler } from './save.js';\n\nexport { SAVE_ENDPOINT } from './link.js';\n\nexport interface ExecutableStoriesShowcasePluginOptions {\n  /** Folder the panel's \"Save to project\" writes into, relative to the Vite root. Default \"src/scenarios\". */\n  dir?: string;\n}\n\n/**\n * Dev-server plugin: lets the panel save a captured scenario straight into the project\n * instead of the Downloads folder. Only runs under `vite dev`, and only for this machine.\n */\nexport function executableStoriesShowcase({ dir = 'src/scenarios' }: ExecutableStoriesShowcasePluginOptions = {}): Plugin {\n  return {\n    name: 'executable-stories-showcase',\n    apply: 'serve',\n    configureServer(server) {\n      const root = server.config.root;\n      const handler = createSaveHandler({ dir: resolve(root, dir), root });\n      server.middlewares.use(SAVE_ENDPOINT, (req, res) => void handler(req, res));\n    },\n  };\n}\n"],"mappings":";;;;;;;;;AAAA,SAAS,eAAe;AAgBjB,SAAS,0BAA0B,EAAE,MAAM,gBAAgB,IAA4C,CAAC,GAAW;AACxH,SAAO;AAAA,IACL,MAAM;AAAA,IACN,OAAO;AAAA,IACP,gBAAgB,QAAQ;AACtB,YAAM,OAAO,OAAO,OAAO;AAC3B,YAAM,UAAU,kBAAkB,EAAE,KAAK,QAAQ,MAAM,GAAG,GAAG,KAAK,CAAC;AACnE,aAAO,YAAY,IAAI,eAAe,CAAC,KAAK,QAAQ,KAAK,QAAQ,KAAK,GAAG,CAAC;AAAA,IAC5E;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -1,6 +1,121 @@
 {
   "name": "executable-stories-showcase",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.0",
+  "description": "Put a running app into any state from a URL: shareable JSON scenarios for network, URL and app state, with a dev panel, Playwright helpers and adapters.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jagreehal/executable-stories.git",
+    "directory": "packages/executable-stories-showcase"
+  },
+  "type": "module",
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "source": "./src/index.ts",
+      "import": "./dist/index.js"
+    },
+    "./panel": {
+      "types": "./dist/panel.d.ts",
+      "source": "./src/panel.ts",
+      "import": "./dist/panel.js"
+    },
+    "./playwright": {
+      "types": "./dist/playwright.d.ts",
+      "source": "./src/playwright.ts",
+      "import": "./dist/playwright.js"
+    },
+    "./vite": {
+      "types": "./dist/vite.d.ts",
+      "source": "./src/vite.ts",
+      "import": "./dist/vite.js"
+    },
+    "./next": {
+      "types": "./dist/next.d.ts",
+      "source": "./src/next.ts",
+      "import": "./dist/next.js"
+    },
+    "./tanstack-query": {
+      "types": "./dist/adapters/tanstack-query.d.ts",
+      "source": "./src/adapters/tanstack-query.ts",
+      "import": "./dist/adapters/tanstack-query.js"
+    },
+    "./zustand": {
+      "types": "./dist/adapters/zustand.d.ts",
+      "source": "./src/adapters/zustand.ts",
+      "import": "./dist/adapters/zustand.js"
+    },
+    "./redux": {
+      "types": "./dist/adapters/redux.d.ts",
+      "source": "./src/adapters/redux.ts",
+      "import": "./dist/adapters/redux.js"
+    },
+    "./xstate": {
+      "types": "./dist/adapters/xstate.d.ts",
+      "source": "./src/adapters/xstate.ts",
+      "import": "./dist/adapters/xstate.js"
+    },
+    "./cookies": {
+      "types": "./dist/adapters/cookies.d.ts",
+      "source": "./src/adapters/cookies.ts",
+      "import": "./dist/adapters/cookies.js"
+    }
+  },
+  "imports": {
+    "#msw-browser": {
+      "node": {
+        "source": "./src/no-msw-browser.ts",
+        "default": "./dist/no-msw-browser.js"
+      },
+      "default": "msw/browser"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "msw": "^2.4.0 || ^3.0.0",
+    "zod": "^4.1.0",
+    "@playwright/test": ">=1.40",
+    "@tanstack/react-query": ">=5",
+    "vite": ">=5"
+  },
+  "peerDependenciesMeta": {
+    "msw": {
+      "optional": true
+    },
+    "@playwright/test": {
+      "optional": true
+    },
+    "@tanstack/react-query": {
+      "optional": true
+    },
+    "vite": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@playwright/test": "1.63.0",
+    "@tanstack/react-query": "5.104.1",
+    "msw": "3.0.2",
+    "tsup": "^8.5.1",
+    "typescript": "~6.0.3",
+    "vite": "8.3.2",
+    "zod": "4.6.5",
+    "eslint-config-executable-stories": "0.2.0"
+  },
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "scripts": {
+    "build": "tsup && tsc -p tsconfig.json --noEmit false --declaration --emitDeclarationOnly --outDir dist",
+    "dev": "tsup --watch",
+    "type-check": "tsc --noEmit",
+    "lint": "eslint ."
+  }
 }