@player-ui/react 0.15.3 → 0.15.4--canary.881.37421

package/types/manager/types.d.ts

@@ -1,16 +1,18 @@
 import type React from "react";
-import type { CompletedState, Flow, FlowResult } from "@player-ui/player";
+import type { CompletedState, Flow, InProgressState } from "@player-ui/player";
 import type { ReactPlayer, ReactPlayerOptions } from "../player";
 export interface FinalState {
     /** Mark the iteration as complete */
     done: true;
 }
-export interface NextState<T> {
+export interface NextState {
     /** Optional mark the iteration as _not_ completed */
-    done?: false;
+    done: false;
     /** The next value in the iteration */
-    value: T;
+    value: Flow;
 }
+/** A JS Iterator that returns a new flow or completion marker
+ * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Iterator */
 export interface FlowManager {
     /**
      * An iterator implementation that takes the result of the previous flow and returns a new one or completion marker.
@@ -19,12 +21,12 @@ export interface FlowManager {
      *
      * @param previousValue - The result of the previous flow.
      */
-    next: (previousValue?: CompletedState) => Promise<FinalState | NextState<Flow>>;
+    next: (result?: CompletedState) => Promise<FinalState | NextState>;
     /**
      * Called when the flow is ended early (the react tree is torn down)
      * Allows clients the opportunity to save-data before destroying the tree
      */
-    terminate?: (data?: FlowResult["data"]) => void;
+    terminate?: (state?: InProgressState) => void;
 }
 export interface FallbackProps {
     /** A callback to reset the flow iteration from the start */
@@ -38,7 +40,7 @@ export interface ManagedPlayerProps extends ReactPlayerOptions {
     /** The manager for populating the next flows */
     manager: FlowManager;
     /** A callback when a flow is started */
-    onStartedFlow?: () => void;
+    onStartedFlow?: (flow: Flow) => void;
     /** A callback when the entire async iteration is completed */
     onComplete?: (finalState?: CompletedState) => void;
     /** A callback for any errors */
@@ -67,7 +69,7 @@ export type ManagedPlayerState = {
         /** The previous completed state */
         prevResult?: CompletedState;
         /** A promise from the flow manager for the next state */
-        next: Promise<FinalState | NextState<Flow>>;
+        next: Promise<FinalState | NextState>;
     };
 } | {
     /** A flow was retrieved from the flow manager, but hasn't been processed yet */

package/types/player.d.ts

@@ -1,10 +1,12 @@
 import React from "react";
 import { SyncWaterfallHook, AsyncParallelHook } from "tapable-ts";
 import { Subscribe } from "@player-ui/react-subscribe";
-import type { CompletedState, PlayerPlugin, Flow, PlayerInfo } from "@player-ui/player";
+import type { CompletedState, PlayerPlugin, Flow, View, PlayerInfo } from "@player-ui/player";
 import { Player } from "@player-ui/player";
 import type { AssetRegistryType } from "./asset";
 import type { ReactPlayerProps } from "./app";
+/** Backup context for receiving ReactPlayerComponentProps when components setup in the webComponent call don't pass the props down to their inner components. */
+export declare const ReactPlayerPropsContext: React.Context<ReactPlayerComponentProps>;
 export interface DevtoolsGlobals {
     /** A global for a plugin to load to Player for devtools */
     __PLAYER_DEVTOOLS_PLUGIN?: {
@@ -27,7 +29,11 @@ export interface ReactPlayerOptions {
     /** A set of plugins to apply to this player */
     plugins?: Array<ReactPlayerPlugin>;
 }
-export type ReactPlayerComponentProps = Record<string, unknown>;
+export type ReactPlayerComponentProps = {
+    /** Whether or not player is currently recovering from an error. */
+    isInErrorState?: boolean;
+    [key: string]: unknown;
+};
 /** A Player that renders UI through React */
 export declare class ReactPlayer {
     readonly options: ReactPlayerOptions;
@@ -38,7 +44,9 @@ export declare class ReactPlayer {
         /**
          * A hook to create a React Component to be used for Player, regardless of the current flow state
          */
-        webComponent: SyncWaterfallHook<[React.ComponentType], Record<string, any>>;
+        webComponent: SyncWaterfallHook<[
+            React.ComponentType<any>
+        ], Record<string, any>>;
         /**
          * A hook to create a React Component that's used to render a specific view.
          * It will be called for each view update from the core player.
@@ -52,9 +60,7 @@ export declare class ReactPlayer {
          */
         onBeforeViewReset: AsyncParallelHook<[], Record<string, any>>;
     };
-    readonly viewUpdateSubscription: Subscribe<import("@player-ui/player").Asset<string> & {
-        validation?: Array<import("@player-ui/player").Validation.CrossfieldReference>;
-    }>;
+    readonly viewUpdateSubscription: Subscribe<View>;
     private reactPlayerInfo;
     constructor(options?: ReactPlayerOptions);
     /** Returns the current version Player */
@@ -64,7 +70,7 @@ export declare class ReactPlayer {
     /** Find instance of [Plugin] that has been registered to the web player */
     findPlugin<Plugin extends ReactPlayerPlugin>(symbol: symbol): Plugin | undefined;
     /** Register and apply [Plugin] if one with the same symbol is not already registered. */
-    registerPlugin(plugin: ReactPlayerPlugin): void;
+    registerPlugin(plugin: ReactPlayerPlugin | PlayerPlugin): void;
     /**
      * Returns the current version of the running React Player
      * @deprecated use `getPlayerVersion()` instead. Will be removed next major