@player-ui/async-node-plugin 0.13.0-next.1 → 0.13.0-next.3

package/types/index.d.ts

@@ -1,7 +1,16 @@
 import type { Player, PlayerPlugin, Node, ViewInstance, Parser, ViewPlugin, Resolver } from "@player-ui/player";
-import { AsyncParallelBailHook } from "tapable-ts";
+import { AsyncParallelBailHook, SyncBailHook } from "tapable-ts";
 export * from "./types";
 export * from "./transform";
+/** Object type for storing data related to a single `apply` of the `AsyncNodePluginPlugin`
+ * This object should be setup once per ViewInstance to keep any cached info just for that view to avoid conflicts of shared async node ids across different view states.
+ */
+type AsyncPluginContext = {
+    /** Map of async node id to resolved content */
+    nodeResolveCache: Map<string, any>;
+    /** The view instance this context is attached to. */
+    view: ViewInstance;
+};
 export interface AsyncNodePluginOptions {
     /** A set of plugins to load  */
     plugins?: AsyncNodeViewPlugin[];
@@ -12,33 +21,48 @@ export interface AsyncNodeViewPlugin extends ViewPlugin {
     asyncNode: AsyncParallelBailHook<[Node.Async, (result: any) => void], any>;
 }
 export type AsyncHandler = (node: Node.Async, callback?: (result: any) => void) => Promise<any>;
+/** Hook declaration for the AsyncNodePlugin */
+type AsyncNodeHooks = {
+    /** Async hook to get content for an async node */
+    onAsyncNode: AsyncParallelBailHook<[Node.Async, (result: any) => void], any>;
+    /** Sync hook to manage errors coming from the onAsyncNode hook. Return a fallback node or null to render a fallback. The first argument of passed in the call is the error thrown. */
+    onAsyncNodeError: SyncBailHook<[Error, Node.Async], any>;
+};
 /**
  * Async node plugin used to resolve async nodes in the content
  * If an async node is present, allow users to provide a replacement node to be rendered when ready
  */
 export declare class AsyncNodePlugin implements PlayerPlugin {
     private plugins;
+    private playerInstance;
     constructor(options: AsyncNodePluginOptions, asyncHandler?: AsyncHandler);
-    readonly hooks: {
-        onAsyncNode: AsyncParallelBailHook<[Node.Async, (result: any) => void], any, Record<string, any>>;
-    };
+    readonly hooks: AsyncNodeHooks;
+    getPlayerInstance(): Player | undefined;
     name: string;
     apply(player: Player): void;
 }
 export declare class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {
-    asyncNode: AsyncParallelBailHook<[Node.Async, (result: any) => void], any, Record<string, any>>;
+    asyncNode: AsyncParallelBailHook<[
+        Node.Async,
+        (result: any) => void
+    ], any>;
     private basePlugin;
     name: string;
-    private resolvedMapping;
-    private currentView;
+    /**
+     * Parses the node from the result and triggers an asynchronous view update if necessary.
+     * @param node The asynchronous node that might be updated.
+     * @param result The result obtained from resolving the async node. This could be any data structure or value.
+     * @param options Options provided for node resolution, including a potential parseNode function to process the result.
+     * @param view The view instance where the node resides. This can be undefined if the view is not currently active.
+     */
+    private parseNodeAndUpdate;
     /**
      * Updates the node asynchronously based on the result provided.
      * This method is responsible for handling the update logic of asynchronous nodes.
      * It checks if the node needs to be updated based on the new result and updates the mapping accordingly.
      * If an update is necessary, it triggers an asynchronous update on the view.
      * @param node The asynchronous node that might be updated.
-     * @param result The result obtained from resolving the async node. This could be any data structure or value.
-     * @param options Options provided for node resolution, including a potential parseNode function to process the result.
+     * @param newNode The new node to replace the async node.
      * @param view The view instance where the node resides. This can be undefined if the view is not currently active.
      */
     private handleAsyncUpdate;
@@ -48,7 +72,8 @@ export declare class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {
      * @param resolver The resolver instance to attach the hook to.
      * @param view
      */
-    applyResolver(resolver: Resolver): void;
+    applyResolver(resolver: Resolver, context: AsyncPluginContext): void;
+    private runAsyncNode;
     private isAsync;
     private isDeterminedAsync;
     applyParser(parser: Parser): void;