@player-ui/player 1.1.0-next.1 → 1.1.0-next.3

package/types/types.d.ts

@@ -5,8 +5,36 @@ import type { ExpressionEvaluator } from "./expressions";
 import type { Logger } from "./logger";
 import type { ViewController, DataController, ValidationController, FlowController, ErrorController } from "./controllers";
 import type { ReadOnlyDataController } from "./controllers/data/utils";
-import { SyncHook, SyncWaterfallHook } from "tapable-ts";
+import { SyncBailHook, 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
  */
@@ -39,6 +67,16 @@ 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`. Being a bail hook, taps inspect `meta.format`
+     * (and optionally `meta.version`) and return a `Flow` to claim the content;
+     * returning `undefined` passes to the next tap. Player registers a default
+     * tap for the `"player"` format that returns the payload as-is, so the hook
+     * is guaranteed to yield a `Flow` and `start()` needs no type-casting.
+     */
+    transformContent: SyncBailHook<[unknown, ContentMeta], Flow<Asset<string>>>;
 }
 /** The status for a flow's execution state */
 export type PlayerFlowStatus = "not-started" | "in-progress" | "completed" | "error";

package/types/validator/validation-middleware.d.ts

@@ -32,5 +32,7 @@ export declare class ValidationMiddleware implements DataModelMiddleware {
     set(transaction: BatchSetTransaction, options?: DataModelOptions, next?: DataModelImpl): Updates;
     get(binding: BindingInstance, options?: DataModelOptions, next?: DataModelImpl): any;
     delete(binding: BindingInstance, options?: DataModelOptions, next?: DataModelImpl): void | undefined;
+    /** Clears any invalid values staged in the shadow model */
+    reset(): void;
 }
 //# sourceMappingURL=validation-middleware.d.ts.map