@navipartner/demo-video 0.0.0-stage → 0.4.0

package/dist/index.d.ts

@@ -0,0 +1,255 @@
+import { D as DemoAdapter } from './adapter-CWqMoNdw.js';
+export { B as Brand, C as CardSpec, a as DemoAction, b as DirectorApi, T as Target, V as VideoBrand, d as defineAction, c as defineDemo } from './adapter-CWqMoNdw.js';
+import { Page } from '@playwright/test';
+import { z } from 'zod';
+export { z } from 'zod';
+
+interface Overlay {
+    /** Regex source matched against the request's pathname. */
+    path: string;
+    /**
+     * Where to merge, as dot-separated keys from the response root; `*` merges
+     * into every element of an array. Omitted = the root object.
+     */
+    at?: string;
+    values: Record<string, unknown>;
+}
+declare const overlayResponse: (page: Page, overlay: Overlay) => Promise<void>;
+
+declare const coreStepSchemas: readonly [z.ZodObject<{
+    zoom: z.ZodOptional<z.ZodNumber>;
+    target: z.ZodString;
+    nth: z.ZodOptional<z.ZodNumber>;
+    do: z.ZodLiteral<"click">;
+}, "strict", z.ZodTypeAny, {
+    do: "click";
+    target: string;
+    zoom?: number | undefined;
+    nth?: number | undefined;
+}, {
+    do: "click";
+    target: string;
+    zoom?: number | undefined;
+    nth?: number | undefined;
+}>, z.ZodObject<{
+    text: z.ZodString;
+    perCharMs: z.ZodOptional<z.ZodNumber>;
+    target: z.ZodString;
+    nth: z.ZodOptional<z.ZodNumber>;
+    do: z.ZodLiteral<"type">;
+}, "strict", z.ZodTypeAny, {
+    text: string;
+    do: "type";
+    target: string;
+    nth?: number | undefined;
+    perCharMs?: number | undefined;
+}, {
+    text: string;
+    do: "type";
+    target: string;
+    nth?: number | undefined;
+    perCharMs?: number | undefined;
+}>, z.ZodObject<{
+    do: z.ZodLiteral<"press">;
+    key: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    key: string;
+    do: "press";
+}, {
+    key: string;
+    do: "press";
+}>, z.ZodObject<{
+    scale: z.ZodDefault<z.ZodNumber>;
+    target: z.ZodString;
+    nth: z.ZodOptional<z.ZodNumber>;
+    do: z.ZodLiteral<"zoom">;
+}, "strict", z.ZodTypeAny, {
+    do: "zoom";
+    target: string;
+    scale: number;
+    nth?: number | undefined;
+}, {
+    do: "zoom";
+    target: string;
+    nth?: number | undefined;
+    scale?: number | undefined;
+}>, z.ZodObject<{
+    do: z.ZodLiteral<"frame">;
+    targets: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodObject<{
+        target: z.ZodString;
+        nth: z.ZodOptional<z.ZodNumber>;
+    }, "strict", z.ZodTypeAny, {
+        target: string;
+        nth?: number | undefined;
+    }, {
+        target: string;
+        nth?: number | undefined;
+    }>]>, "many">;
+    maxScale: z.ZodOptional<z.ZodNumber>;
+}, "strict", z.ZodTypeAny, {
+    do: "frame";
+    targets: (string | {
+        target: string;
+        nth?: number | undefined;
+    })[];
+    maxScale?: number | undefined;
+}, {
+    do: "frame";
+    targets: (string | {
+        target: string;
+        nth?: number | undefined;
+    })[];
+    maxScale?: number | undefined;
+}>, z.ZodObject<{
+    do: z.ZodLiteral<"zoomOut">;
+    park: z.ZodOptional<z.ZodBoolean>;
+}, "strict", z.ZodTypeAny, {
+    do: "zoomOut";
+    park?: boolean | undefined;
+}, {
+    do: "zoomOut";
+    park?: boolean | undefined;
+}>, z.ZodObject<{
+    do: z.ZodLiteral<"park">;
+}, "strict", z.ZodTypeAny, {
+    do: "park";
+}, {
+    do: "park";
+}>, z.ZodObject<{
+    hidden: z.ZodOptional<z.ZodBoolean>;
+    timeout: z.ZodDefault<z.ZodNumber>;
+    target: z.ZodString;
+    nth: z.ZodOptional<z.ZodNumber>;
+    do: z.ZodLiteral<"waitFor">;
+}, "strict", z.ZodTypeAny, {
+    do: "waitFor";
+    target: string;
+    timeout: number;
+    nth?: number | undefined;
+    hidden?: boolean | undefined;
+}, {
+    do: "waitFor";
+    target: string;
+    nth?: number | undefined;
+    hidden?: boolean | undefined;
+    timeout?: number | undefined;
+}>, z.ZodObject<{
+    text: z.ZodString;
+    contains: z.ZodOptional<z.ZodBoolean>;
+    timeout: z.ZodDefault<z.ZodNumber>;
+    target: z.ZodString;
+    nth: z.ZodOptional<z.ZodNumber>;
+    do: z.ZodLiteral<"expectText">;
+}, "strict", z.ZodTypeAny, {
+    text: string;
+    do: "expectText";
+    target: string;
+    timeout: number;
+    nth?: number | undefined;
+    contains?: boolean | undefined;
+}, {
+    text: string;
+    do: "expectText";
+    target: string;
+    nth?: number | undefined;
+    timeout?: number | undefined;
+    contains?: boolean | undefined;
+}>, z.ZodObject<{
+    eyebrow: z.ZodOptional<z.ZodString>;
+    heading: z.ZodOptional<z.ZodString>;
+    sub: z.ZodOptional<z.ZodString>;
+    /** Show the brand's logo (open and end cards). */
+    logo: z.ZodOptional<z.ZodBoolean>;
+    /** "pale" = brand-tinted white; "brand" = full-bleed primary colour. */
+    style: z.ZodDefault<z.ZodEnum<["pale", "brand"]>>;
+    seconds: z.ZodDefault<z.ZodNumber>;
+    do: z.ZodLiteral<"card">;
+}, "strict", z.ZodTypeAny, {
+    do: "card";
+    style: "pale" | "brand";
+    seconds: number;
+    logo?: boolean | undefined;
+    sub?: string | undefined;
+    eyebrow?: string | undefined;
+    heading?: string | undefined;
+}, {
+    do: "card";
+    logo?: boolean | undefined;
+    sub?: string | undefined;
+    eyebrow?: string | undefined;
+    heading?: string | undefined;
+    style?: "pale" | "brand" | undefined;
+    seconds?: number | undefined;
+}>, z.ZodObject<{
+    do: z.ZodLiteral<"hold">;
+    seconds: z.ZodNumber;
+}, "strict", z.ZodTypeAny, {
+    do: "hold";
+    seconds: number;
+}, {
+    do: "hold";
+    seconds: number;
+}>];
+type CoreStep = z.infer<(typeof coreStepSchemas)[number]>;
+type ActionStep = {
+    do: string;
+} & Record<string, unknown>;
+type Step = CoreStep | ActionStep;
+declare const cardSchema: z.ZodEffects<z.ZodObject<{
+    eyebrow: z.ZodOptional<z.ZodString>;
+    heading: z.ZodOptional<z.ZodString>;
+    sub: z.ZodOptional<z.ZodString>;
+    /** Show the brand's logo (open and end cards). */
+    logo: z.ZodOptional<z.ZodBoolean>;
+    /** "pale" = brand-tinted white; "brand" = full-bleed primary colour. */
+    style: z.ZodDefault<z.ZodEnum<["pale", "brand"]>>;
+    seconds: z.ZodDefault<z.ZodNumber>;
+}, "strict", z.ZodTypeAny, {
+    style: "pale" | "brand";
+    seconds: number;
+    logo?: boolean | undefined;
+    sub?: string | undefined;
+    eyebrow?: string | undefined;
+    heading?: string | undefined;
+}, {
+    logo?: boolean | undefined;
+    sub?: string | undefined;
+    eyebrow?: string | undefined;
+    heading?: string | undefined;
+    style?: "pale" | "brand" | undefined;
+    seconds?: number | undefined;
+}>, {
+    style: "pale" | "brand";
+    seconds: number;
+    logo?: boolean | undefined;
+    sub?: string | undefined;
+    eyebrow?: string | undefined;
+    heading?: string | undefined;
+}, {
+    logo?: boolean | undefined;
+    sub?: string | undefined;
+    eyebrow?: string | undefined;
+    heading?: string | undefined;
+    style?: "pale" | "brand" | undefined;
+    seconds?: number | undefined;
+}>;
+type Card = z.infer<typeof cardSchema>;
+interface Storyboard {
+    app: string;
+    /** A variant's brand (see loadStoryboard): it is filmed with this one only. */
+    brand?: string;
+    /** The story a variant extends. */
+    variantOf?: string;
+    /** What the story shows, for people (and the Linear agent) choosing one. */
+    description?: string;
+    /** The app's primary journey: the story filmed when none is named. One per app. */
+    primary?: boolean;
+    title?: Card;
+    closing?: Card;
+    steps: Step[];
+}
+declare class StoryboardError extends Error {
+}
+declare const parseStoryboard: (raw: unknown, adapter: Pick<DemoAdapter, "app" | "actions">, source?: string) => Storyboard;
+
+export { type Card, DemoAdapter, type Overlay, type Step, type Storyboard, StoryboardError, overlayResponse, parseStoryboard };

package/dist/index.js

@@ -0,0 +1,56 @@
+import {
+  StoryboardError,
+  parseStoryboard
+} from "./chunk-BYAFDWPA.js";
+
+// src/adapter.ts
+var defineDemo = (adapter) => adapter;
+var defineAction = (action) => action;
+
+// src/overlay.ts
+var overlayResponse = async (page, overlay) => {
+  await page.addInitScript(({ path, at, values }) => {
+    const pattern = new RegExp(path);
+    const merge = (node, keys) => {
+      if (node === null || typeof node !== "object") {
+        return;
+      }
+      const [key, ...rest] = keys;
+      if (key === void 0) {
+        Object.assign(node, values);
+      } else if (key === "*" && Array.isArray(node)) {
+        node.forEach((item) => merge(item, rest));
+      } else {
+        merge(node[key], rest);
+      }
+    };
+    const original = window.fetch.bind(window);
+    window.fetch = async (input, init) => {
+      const response = await original(input, init);
+      const url = new URL(
+        input instanceof Request ? input.url : String(input),
+        location.href
+      );
+      if (!pattern.test(url.pathname) || !response.ok) {
+        return response;
+      }
+      const body = await response.clone().json();
+      merge(body, at ? at.split(".") : []);
+      return new Response(JSON.stringify(body), {
+        status: response.status,
+        headers: response.headers
+      });
+    };
+  }, overlay);
+};
+
+// src/index.ts
+import { z } from "zod";
+export {
+  StoryboardError,
+  defineAction,
+  defineDemo,
+  overlayResponse,
+  parseStoryboard,
+  z
+};

package/dist/runner/index.d.ts

@@ -0,0 +1,23 @@
+import { PlaywrightTestConfig, Page } from '@playwright/test';
+import { D as DemoAdapter } from '../adapter-CWqMoNdw.js';
+import 'zod';
+
+/**
+ * The Playwright config for an app's demo. A plain object, so it needs no
+ * `defineConfig` and loads no Playwright of its own. `demoDir` is the app's
+ * demo/ folder; `runnerDir` holds the spec the CLI generated.
+ */
+declare const createDemoConfig: (adapter: DemoAdapter, demoDir: string, runnerDir: string) => PlaywrightTestConfig;
+
+/** The app's own Playwright `test`, passed in so only one Playwright loads. */
+type DemoTest = (title: string, body: (args: {
+    page: Page;
+}) => Promise<void>) => void;
+/**
+ * Registers the one "test" that performs a story: a dry run in check mode, a
+ * recording otherwise. Called from the spec the CLI generates, with the app's
+ * own `test` and the app's demo/ folder.
+ */
+declare const registerDemoTests: (test: DemoTest, adapter: DemoAdapter, demoDir: string) => void;
+
+export { type DemoTest, createDemoConfig, registerDemoTests };