@player-ui/player 1.1.0--canary.866.38513 → 1.1.0-next.0

package/package.json

@@ -6,12 +6,12 @@
     "types"
   ],
   "name": "@player-ui/player",
-  "version": "1.1.0--canary.866.38513",
+  "version": "1.1.0-next.0",
   "main": "dist/cjs/index.cjs",
   "dependencies": {
-    "@player-ui/partial-match-registry": "1.1.0--canary.866.38513",
-    "@player-ui/make-flow": "1.1.0--canary.866.38513",
-    "@player-ui/types": "1.1.0--canary.866.38513",
+    "@player-ui/partial-match-registry": "1.1.0-next.0",
+    "@player-ui/make-flow": "1.1.0-next.0",
+    "@player-ui/types": "1.1.0-next.0",
     "@types/dlv": "^1.1.4",
     "dequal": "^2.0.2",
     "dlv": "^1.1.3",

package/src/controllers/data/utils.ts

@@ -12,7 +12,7 @@ export class ReadOnlyDataController
     this.controller = controller;
   }
 
-  get(binding: BindingLike, options?: DataModelOptions | undefined): any {
+  get(binding: BindingLike, options?: DataModelOptions | undefined) {
     return this.controller.get(binding, options);
   }
 }

package/src/player.ts

@@ -29,8 +29,6 @@ import type {
   CompletedState,
   ErrorState,
   PlayerHooks,
-  ContentMeta,
-  StartOptions,
 } from "./types";
 import { NOT_STARTED_STATE } from "./types";
 
@@ -127,7 +125,6 @@ export class Player {
     onStart: new SyncHook<[Flow]>(),
     onEnd: new SyncHook<[]>(),
     resolveFlowContent: new SyncWaterfallHook<[Flow]>(),
-    transformContent: new SyncWaterfallHook<[unknown, ContentMeta]>(),
   };
 
   constructor(config?: PlayerConfigOptions) {
@@ -516,16 +513,8 @@ export class Player {
     };
   }
 
-  public async start(
-    payload: unknown,
-    options?: StartOptions,
-  ): Promise<CompletedState> {
-    const meta: ContentMeta = {
-      format: options?.format ?? "player",
-      version: options?.version,
-    };
-    const flow = this.hooks.transformContent.call(payload, meta) as Flow;
-    const ref = Symbol(flow?.id ?? "payload");
+  public async start(payload: Flow): Promise<CompletedState> {
+    const ref = Symbol(payload?.id ?? "payload");
 
     /** A check to avoid updating the state for a flow that's not the current one */
     const maybeUpdateState = <T extends PlayerFlowState>(newState: T) => {
@@ -548,7 +537,7 @@ export class Player {
     });
 
     try {
-      const { state, start } = this.setupFlow(flow);
+      const { state, start } = this.setupFlow(payload);
       this.setState({
         ref,
         ...state,
@@ -575,7 +564,7 @@ export class Player {
       const errorState: ErrorState = {
         status: "error",
         ref,
-        flow,
+        flow: payload,
         error,
       };
 

package/src/types.ts

@@ -14,36 +14,6 @@ import type { ReadOnlyDataController } from "./controllers/data/utils";
 import { SyncHook, SyncWaterfallHook } from "tapable-ts";
 import { ViewInstance } from "./view";
 
-/**
- * Metadata describing the incoming content to `Player.start()`. Passed
- * alongside the raw payload through the `transformContent` hook so plugins
- * can decide whether to claim/convert it.
- */
-export interface ContentMeta {
-  /**
-   * Content format identifier. `"player"` (default) means the input is
-   * already a `Flow` and needs no conversion. Anything else is a free-form
-   * string a plugin can recognize.
-   */
-  format: string;
-  /**
-   * Optional format version (e.g., `"0.9"`). Free-form — plugins decide the
-   * convention. Lets a single format plugin dispatch across major/minor
-   * versions without the caller picking a different `format` string.
-   */
-  version?: string;
-}
-
-/**
- * Options passed to `Player.start()` alongside the payload.
- */
-export interface StartOptions {
-  /** Identifier of the input content's format. Default: `"player"`. */
-  format?: string;
-  /** Optional content-format version. See `ContentMeta.version`. */
-  version?: string;
-}
-
 /**
  * Public Player Hooks
  */
@@ -77,17 +47,6 @@ export interface PlayerHooks {
     [Flow<Asset<string>>],
     Record<string, any>
   >;
-  /**
-   * Transform raw input content into a Player `Flow` before any state is set
-   * up. Fires at the top of `Player.start()` — after plugins are applied,
-   * before `resolveFlowContent`. Plugins tap this and inspect `meta.format`
-   * (and optionally `meta.version`) to decide whether to convert. Plugins
-   * that don't handle the format pass the content through unchanged.
-   */
-  transformContent: SyncWaterfallHook<
-    [unknown, ContentMeta],
-    Record<string, any>
-  >;
 }
 
 /** The status for a flow's execution state */

package/types/player.d.ts

@@ -1,7 +1,8 @@
+import type { Flow } from "@player-ui/types";
 import type { Logger } from "./logger";
 import { TapableLogger } from "./logger";
 import { ConstantsController } from "./controllers";
-import type { PlayerFlowState, CompletedState, PlayerHooks, StartOptions } from "./types";
+import type { PlayerFlowState, CompletedState, PlayerHooks } from "./types";
 /**
 Variables injected at build time
 */
@@ -74,7 +75,7 @@ export declare class Player {
     private setState;
     /** Start Player with the given flow */
     private setupFlow;
-    start(payload: unknown, options?: StartOptions): Promise<CompletedState>;
+    start(payload: Flow): Promise<CompletedState>;
 }
 export {};
 //# sourceMappingURL=player.d.ts.map

package/types/types.d.ts

@@ -7,34 +7,6 @@ import type { ViewController, DataController, ValidationController, FlowControll
 import type { ReadOnlyDataController } from "./controllers/data/utils";
 import { SyncHook, SyncWaterfallHook } from "tapable-ts";
 import { ViewInstance } from "./view";
-/**
- * Metadata describing the incoming content to `Player.start()`. Passed
- * alongside the raw payload through the `transformContent` hook so plugins
- * can decide whether to claim/convert it.
- */
-export interface ContentMeta {
-    /**
-     * Content format identifier. `"player"` (default) means the input is
-     * already a `Flow` and needs no conversion. Anything else is a free-form
-     * string a plugin can recognize.
-     */
-    format: string;
-    /**
-     * Optional format version (e.g., `"0.9"`). Free-form — plugins decide the
-     * convention. Lets a single format plugin dispatch across major/minor
-     * versions without the caller picking a different `format` string.
-     */
-    version?: string;
-}
-/**
- * Options passed to `Player.start()` alongside the payload.
- */
-export interface StartOptions {
-    /** Identifier of the input content's format. Default: `"player"`. */
-    format?: string;
-    /** Optional content-format version. See `ContentMeta.version`. */
-    version?: string;
-}
 /**
  * Public Player Hooks
  */
@@ -67,17 +39,6 @@ export interface PlayerHooks {
     resolveFlowContent: SyncWaterfallHook<[
         Flow<Asset<string>>
     ], Record<string, any>>;
-    /**
-     * Transform raw input content into a Player `Flow` before any state is set
-     * up. Fires at the top of `Player.start()` — after plugins are applied,
-     * before `resolveFlowContent`. Plugins tap this and inspect `meta.format`
-     * (and optionally `meta.version`) to decide whether to convert. Plugins
-     * that don't handle the format pass the content through unchanged.
-     */
-    transformContent: SyncWaterfallHook<[
-        unknown,
-        ContentMeta
-    ], Record<string, any>>;
 }
 /** The status for a flow's execution state */
 export type PlayerFlowStatus = "not-started" | "in-progress" | "completed" | "error";

package/src/__tests__/transform-content.test.ts

@@ -1,124 +0,0 @@
-import { describe, expect, test, vitest } from "vitest";
-import { Player } from "..";
-import type { Flow, PlayerPlugin, InProgressState } from "..";
-
-/** Minimal Flow used to short-circuit setupFlow. */
-const flowFor = (id: string): Flow => ({
-  id,
-  views: [{ id: "v1", type: "text", value: "hi" }],
-  data: {},
-  navigation: {
-    BEGIN: "F",
-    F: {
-      startState: "VIEW_1",
-      VIEW_1: {
-        state_type: "VIEW",
-        ref: "v1",
-        transitions: { "*": "END" },
-      },
-      END: { state_type: "END", outcome: "done" },
-    },
-  },
-});
-
-describe("transformContent hook", () => {
-  test("default format 'player' passes the payload through unchanged", async () => {
-    const player = new Player();
-    const flow = flowFor("plain");
-    player.start(flow);
-    const state = player.getState() as InProgressState;
-    expect(state.flow).toBe(flow);
-  });
-
-  test("a plugin tapping for a custom format transforms the payload", async () => {
-    const greetPlugin: PlayerPlugin = {
-      name: "greet",
-      apply(p) {
-        p.hooks.transformContent.tap("greet", (content, meta) => {
-          if (meta.format !== "greet") return content;
-          const { message } = content as { message: string };
-          return { ...flowFor("greet"), data: { message } };
-        });
-      },
-    };
-
-    const player = new Player({ plugins: [greetPlugin] });
-    player.start({ message: "Hello world" }, { format: "greet" });
-
-    const state = player.getState() as InProgressState;
-    await vitest.waitFor(() =>
-      expect(state.controllers.view.currentView?.lastUpdate).toBeDefined(),
-    );
-    expect(state.controllers.data.get("message")).toBe("Hello world");
-  });
-
-  test("fires before resolveFlowContent", async () => {
-    const order: string[] = [];
-
-    const orderPlugin: PlayerPlugin = {
-      name: "order",
-      apply(p) {
-        p.hooks.transformContent.tap("order", (c) => {
-          order.push("transformContent");
-          return c;
-        });
-        p.hooks.resolveFlowContent.tap("order", (c) => {
-          order.push("resolveFlowContent");
-          return c;
-        });
-      },
-    };
-
-    const player = new Player({ plugins: [orderPlugin] });
-    player.start(flowFor("order"));
-
-    expect(order).toEqual(["transformContent", "resolveFlowContent"]);
-  });
-
-  test("multiple format plugins coexist — only matching one transforms", async () => {
-    const aPlugin: PlayerPlugin = {
-      name: "a",
-      apply(p) {
-        p.hooks.transformContent.tap("a", (c, meta) =>
-          meta.format === "a" ? flowFor("from-a") : c,
-        );
-      },
-    };
-    const bPlugin: PlayerPlugin = {
-      name: "b",
-      apply(p) {
-        p.hooks.transformContent.tap("b", (c, meta) =>
-          meta.format === "b" ? flowFor("from-b") : c,
-        );
-      },
-    };
-
-    const player = new Player({ plugins: [aPlugin, bPlugin] });
-    player.start({ raw: true }, { format: "b" });
-
-    const state = player.getState() as InProgressState;
-    expect(state.flow.id).toBe("from-b");
-  });
-
-  test("version is plumbed from StartOptions to the hook's meta arg", () => {
-    const versions: Array<string | undefined> = [];
-    const probe: PlayerPlugin = {
-      name: "probe",
-      apply(p) {
-        p.hooks.transformContent.tap("probe", (c, meta) => {
-          versions.push(meta.version);
-          // For format !== "demo", pass through so default path runs.
-          if (meta.format !== "demo") return c;
-          return flowFor("demo");
-        });
-      },
-    };
-
-    const player = new Player({ plugins: [probe] });
-    player.start({ x: 1 }, { format: "demo", version: "2" });
-    player.start({ x: 1 }, { format: "demo", version: "1" });
-    player.start(flowFor("noversion"));
-
-    expect(versions).toEqual(["2", "1", undefined]);
-  });
-});