@player-ui/async-node-plugin 0.7.4-next.4 → 0.7.5--canary.434.14868

package/src/types.ts

@@ -1,6 +1,6 @@
-import type { Node } from '@player-ui/player';
+import type { Node } from "@player-ui/player";
 
 export type AsyncNodeHandler = (
   node: Node.Node,
-  update: (object: any) => void
+  update: (object: any) => void,
 ) => void;

package/types/index.d.ts

@@ -0,0 +1,38 @@
+import type { Player, PlayerPlugin, Node, ViewInstance, Parser, ViewPlugin, Resolver } from "@player-ui/player";
+import { AsyncParallelBailHook } from "tapable-ts";
+export * from "./types";
+export interface AsyncNodePluginOptions {
+    /** A set of plugins to load  */
+    plugins?: AsyncNodeViewPlugin[];
+}
+export interface AsyncNodeViewPlugin extends ViewPlugin {
+    /** Use this to tap into the async node plugin hooks */
+    applyPlugin: (asyncNodePlugin: AsyncNodePlugin) => void;
+    asyncNode: AsyncParallelBailHook<[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;
+    constructor(options: AsyncNodePluginOptions);
+    readonly hooks: {
+        onAsyncNode: AsyncParallelBailHook<[Node.Async], any, Record<string, any>>;
+    };
+    name: string;
+    apply(player: Player): void;
+}
+export declare class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {
+    asyncNode: AsyncParallelBailHook<[Node.Async], any, Record<string, any>>;
+    private basePlugin;
+    name: string;
+    private resolvedMapping;
+    private currentView;
+    private isAsync;
+    applyParser(parser: Parser): void;
+    applyResolverHooks(resolver: Resolver): void;
+    apply(view: ViewInstance): void;
+    applyPlugin(asyncNodePlugin: AsyncNodePlugin): void;
+}
+//# sourceMappingURL=index.d.ts.map

package/types/types.d.ts

@@ -0,0 +1,3 @@
+import type { Node } from "@player-ui/player";
+export type AsyncNodeHandler = (node: Node.Node, update: (object: any) => void) => void;
+//# sourceMappingURL=types.d.ts.map