@player-ui/external-state-plugin 1.0.0--canary.865.36694

package/types/index.d.ts

@@ -0,0 +1,52 @@
+import type { Player, PlayerPlugin, InProgressState, NavigationFlowExternalState } from "@player-ui/player";
+export type ExternalStateHandlerMatch = Record<string, unknown>;
+export type ExternalStateHandlerFunction = (state: NavigationFlowExternalState, options: InProgressState["controllers"]) => string | undefined | Promise<string | undefined>;
+export type ExternalStateHandler = {
+    /** The name of the external state. This will appear as it's "ref" property in the DSL. */
+    ref: string;
+    /** Additional properties to match against the external state. */
+    match?: ExternalStateHandlerMatch;
+    /** The function to run when the external state is transitioned to. This should return the `ref` of the next state to transition to. */
+    handlerFunction: ExternalStateHandlerFunction;
+};
+/**
+ * A plugin to handle external states
+ *
+ * This plugin uses a registry-based approach to match external states to handler functions.
+ * Multiple plugins can be registered, and handlers are matched using partial object matching
+ * with specificity ordering (more specific matches take precedence).
+ */
+export declare class ExternalStatePlugin implements PlayerPlugin {
+    name: string;
+    /** Symbol used to identify and find existing instances of this plugin */
+    static Symbol: symbol;
+    readonly symbol: symbol;
+    /**
+     * The shared registry that maps external states to handlers.
+     * All plugin instances use the same registry.
+     */
+    private registry?;
+    /**
+     * The handlers for this plugin instance.
+     */
+    private readonly handlers;
+    /** Creates a new ExternalStatePlugin */
+    constructor(handlers: ExternalStateHandler[]);
+    apply(player: Player): void;
+    /**
+     * Create or share the registry for this plugin instance.
+     *
+     * Uses the Player's plugin registry to find if another instance of ExternalStatePlugin
+     * has already been registered. If found, this instance will share that plugin's registry.
+     * Otherwise, this instance creates a new registry.
+     */
+    private createRegistry;
+    /**
+     * Register this plugin's handlers to the shared registry.
+     *
+     * If a handler with the same specificity already exists, it will be replaced
+     * and a debug log will be emitted (accessible via player.logger.debug).
+     */
+    private registerHandlers;
+}
+//# sourceMappingURL=index.d.ts.map

package/types/symbols.d.ts

@@ -0,0 +1,2 @@
+export declare const ExternalStatePluginSymbol: symbol;
+//# sourceMappingURL=symbols.d.ts.map