@player-ui/async-node-plugin 0.15.0-next.4 → 0.15.0-next.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/AsyncNodePlugin.native.js +119 -113
- package/dist/AsyncNodePlugin.native.js.map +1 -1
- package/dist/cjs/index.cjs +34 -19
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/index.legacy-esm.js +34 -19
- package/dist/index.mjs +34 -19
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
- package/src/__tests__/index.test.ts +143 -0
- package/src/index.ts +48 -22
- package/types/index.d.ts +10 -2
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/index.ts","../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/transform.ts","../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/createAsyncTransform.ts","../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/utils/extractNodeFromPath.ts","../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/utils/traverseAndReplace.ts","../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/utils/unwrapAsset.ts","../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/utils/requiresAssetWrapper.ts"],"sourcesContent":["import { NodeType, getNodeID } from \"@player-ui/player\";\nimport type {\n Player,\n PlayerPlugin,\n Node,\n ParseObjectOptions,\n ParseObjectChildOptions,\n ViewInstance,\n Parser,\n ViewPlugin,\n Resolver,\n Resolve,\n} from \"@player-ui/player\";\nimport { AsyncSeriesBailHook, SyncBailHook } from \"tapable-ts\";\nimport queueMicrotask from \"queue-microtask\";\n\nexport * from \"./types\";\nexport * from \"./transform\";\nexport * from \"./createAsyncTransform\";\n\n/** Object type for storing data related to a single `apply` of the `AsyncNodePluginPlugin`\n * 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.\n */\ntype AsyncPluginContext = {\n /** Map of async node id to resolved content */\n nodeResolveCache: Map<string, any>;\n /** The view instance this context is attached to. */\n view: ViewInstance;\n /** Map of async node id to promises being used to resolve them */\n inProgressNodes: Set<string>;\n};\n\nexport interface AsyncNodePluginOptions {\n /** A set of plugins to load */\n plugins?: AsyncNodeViewPlugin[];\n}\n\nexport interface AsyncNodeViewPlugin extends ViewPlugin {\n /** Use this to tap into the async node plugin hooks */\n applyPlugin: (asyncNodePlugin: AsyncNodePlugin) => void;\n}\nexport type AsyncHandler = (\n node: Node.Async,\n callback?: (result: any) => void,\n) => Promise<any>;\n\nexport type AsyncContent = {\n async: true;\n flatten?: boolean;\n [key: string]: unknown;\n};\n\n/** Hook declaration for the AsyncNodePlugin */\nexport type AsyncNodeHooks = {\n /** Async hook to get content for an async node */\n onAsyncNode: AsyncSeriesBailHook<[Node.Async, (result: any) => void], any>;\n /** 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. */\n onAsyncNodeError: SyncBailHook<[Error, Node.Async], any>;\n};\n\nexport const AsyncNodePluginSymbol: symbol = Symbol.for(\"AsyncNodePlugin\");\n\n/**\n * Async node plugin used to resolve async nodes in the content\n * If an async node is present, allow users to provide a replacement node to be rendered when ready\n */\nexport class AsyncNodePlugin implements PlayerPlugin {\n private plugins: AsyncNodeViewPlugin[] | undefined;\n private playerInstance: Player | undefined;\n\n static Symbol: symbol = AsyncNodePluginSymbol;\n public readonly symbol: symbol = AsyncNodePlugin.Symbol;\n\n constructor(options: AsyncNodePluginOptions, asyncHandler?: AsyncHandler) {\n if (options?.plugins) {\n this.plugins = options.plugins;\n options.plugins.forEach((plugin) => {\n plugin.applyPlugin(this);\n });\n }\n\n if (asyncHandler) {\n this.hooks.onAsyncNode.tap(\n \"async\",\n async (node: Node.Async, callback) => {\n return await asyncHandler(node, callback);\n },\n );\n }\n }\n\n public readonly hooks: AsyncNodeHooks = {\n onAsyncNode: new AsyncSeriesBailHook(),\n onAsyncNodeError: new SyncBailHook(),\n };\n\n getPlayerInstance(): Player | undefined {\n return this.playerInstance;\n }\n\n name = \"AsyncNode\";\n\n apply(player: Player): void {\n this.playerInstance = player;\n\n player.hooks.viewController.tap(this.name, (viewController) => {\n viewController.hooks.view.tap(this.name, (view) => {\n this.plugins?.forEach((plugin) => {\n plugin.apply(view);\n });\n });\n });\n }\n}\n\nexport class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {\n private basePlugin: AsyncNodePlugin | undefined;\n\n name = \"AsyncNode\";\n\n /**\n * Parses the node from the result and triggers an asynchronous view update if necessary.\n * @param node The asynchronous node that might be updated.\n * @param result The result obtained from resolving the async node. This could be any data structure or value.\n * @param options Options provided for node resolution, including a potential parseNode function to process the result.\n * @param view The view instance where the node resides. This can be undefined if the view is not currently active.\n */\n private parseNodeAndUpdate(\n node: Node.Async,\n context: AsyncPluginContext,\n result: any,\n options: Resolve.NodeResolveOptions,\n ) {\n let parsedNode =\n options.parseNode && result ? options.parseNode(result) : undefined;\n\n if (parsedNode && node.onValueReceived) {\n parsedNode = node.onValueReceived(parsedNode);\n }\n\n this.handleAsyncUpdate(node, context, parsedNode);\n }\n\n /**\n * Updates the node asynchronously based on the result provided.\n * This method is responsible for handling the update logic of asynchronous nodes.\n * It checks if the node needs to be updated based on the new result and updates the mapping accordingly.\n * If an update is necessary, it triggers an asynchronous update on the view.\n * @param node The asynchronous node that might be updated.\n * @param newNode The new node to replace the async node.\n * @param view The view instance where the node resides. This can be undefined if the view is not currently active.\n */\n private handleAsyncUpdate(\n node: Node.Async,\n context: AsyncPluginContext,\n newNode?: Node.Node | null,\n ) {\n const { nodeResolveCache, view } = context;\n if (nodeResolveCache.get(node.id) !== newNode) {\n nodeResolveCache.set(node.id, newNode ? newNode : node);\n view.updateAsync(node.id);\n }\n }\n\n private hasValidMapping(\n node: Node.Async,\n context: AsyncPluginContext,\n ): boolean {\n const { nodeResolveCache } = context;\n return (\n nodeResolveCache.has(node.id) && nodeResolveCache.get(node.id) !== node\n );\n }\n\n /**\n * Handles the asynchronous API integration for resolving nodes.\n * This method sets up a hook on the resolver's `beforeResolve` event to process async nodes.\n * @param resolver The resolver instance to attach the hook to.\n * @param view\n */\n applyResolver(resolver: Resolver, context: AsyncPluginContext): void {\n resolver.hooks.beforeResolve.tap(this.name, (node, options) => {\n if (!this.isAsync(node)) {\n return node === null ? node : this.resolveAsyncChildren(node, context);\n }\n\n const resolvedNode = context.nodeResolveCache.get(node.id);\n if (resolvedNode !== undefined) {\n if (resolvedNode.asyncNodesResolved === undefined) {\n resolvedNode.asyncNodesResolved = [];\n }\n resolvedNode.asyncNodesResolved.push(node.id);\n return this.resolveAsyncChildren(resolvedNode, context);\n }\n\n if (context.inProgressNodes.has(node.id)) {\n return node;\n }\n\n // Track that the node is in progress.\n context.inProgressNodes.add(node.id);\n queueMicrotask(() => {\n this.runAsyncNode(node, context, options).finally();\n });\n\n return node;\n });\n }\n\n /**\n * Replaces child async nodes with their resolved content and flattens when necessary. Resolving the children directly helps manage the `parent` reference without needing as much work within the resolver itself.\n * Handles async node chains as well to make sure all applicable nodes can get flattened.\n * @param node - The node whose children need to be resolved.\n * @param context - the async plugin context needed to reach into the cache\n * @returns The same node but with async node children mapped to their resolved AST.\n */\n private resolveAsyncChildren(\n node: Node.Node,\n context: AsyncPluginContext,\n ): Node.Node {\n const asyncNodesResolved: string[] = node.asyncNodesResolved ?? [];\n node.asyncNodesResolved = asyncNodesResolved;\n if (node.type === NodeType.MultiNode) {\n // Using a while loop lets us catch when async nodes produce more async nodes that need to be flattened further\n let index = 0;\n while (index < node.values.length) {\n const childNode = node.values[index];\n if (\n childNode?.type !== NodeType.Async ||\n !this.hasValidMapping(childNode, context)\n ) {\n index++;\n continue;\n }\n\n const mappedNode = context.nodeResolveCache.get(childNode.id);\n asyncNodesResolved.push(childNode.id);\n if (mappedNode.type === NodeType.MultiNode && childNode.flatten) {\n mappedNode.values.forEach((v: Node.Node) => (v.parent = node));\n node.values = [\n ...node.values.slice(0, index),\n ...mappedNode.values,\n ...node.values.slice(index + 1),\n ];\n } else {\n node.values[index] = mappedNode;\n mappedNode.parent = node;\n }\n }\n } else if (\"children\" in node) {\n node.children?.forEach((c) => {\n // Similar to above, using a while loop lets us handle when async nodes produce more async nodes.\n while (\n c.value.type === NodeType.Async &&\n this.hasValidMapping(c.value, context)\n ) {\n asyncNodesResolved.push(c.value.id);\n c.value = context.nodeResolveCache.get(c.value.id);\n c.value.parent = node;\n }\n });\n }\n\n return node;\n }\n\n private async runAsyncNode(\n node: Node.Async,\n context: AsyncPluginContext,\n options: Resolve.NodeResolveOptions,\n ) {\n try {\n const result = await this.basePlugin?.hooks.onAsyncNode.call(\n node,\n (result) => {\n this.parseNodeAndUpdate(node, context, result, options);\n },\n );\n\n // Stop tracking before the next update is triggered\n context.inProgressNodes.delete(node.id);\n this.parseNodeAndUpdate(node, context, result, options);\n } catch (e: unknown) {\n const error = e instanceof Error ? e : new Error(String(e));\n const result = this.basePlugin?.hooks.onAsyncNodeError.call(error, node);\n\n if (result === undefined) {\n const playerState = this.basePlugin?.getPlayerInstance()?.getState();\n\n if (playerState?.status === \"in-progress\") {\n playerState.fail(error);\n }\n\n return;\n }\n\n options.logger?.error(\n \"Async node handling failed and resolved with a fallback. Error:\",\n error,\n );\n\n // Stop tracking before the next update is triggered\n context.inProgressNodes.delete(node.id);\n this.parseNodeAndUpdate(node, context, result, options);\n }\n }\n\n private isAsync(node: Node.Node | null): node is Node.Async {\n return node?.type === NodeType.Async;\n }\n\n private isDeterminedAsync(obj: unknown): obj is AsyncContent {\n return (\n typeof obj === \"object\" &&\n obj !== null &&\n Object.prototype.hasOwnProperty.call(obj, \"async\")\n );\n }\n\n applyParser(parser: Parser): void {\n parser.hooks.parseNode.tap(\n this.name,\n (\n obj: any,\n nodeType: Node.ChildrenTypes,\n options: ParseObjectOptions,\n childOptions?: ParseObjectChildOptions,\n ) => {\n if (this.isDeterminedAsync(obj)) {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n const { async, flatten, ...rest } = obj;\n const parsedAsync = parser.parseObject(rest, nodeType, options);\n const parsedNodeId = getNodeID(parsedAsync);\n\n if (parsedAsync === null || !parsedNodeId) {\n return childOptions ? [] : null;\n }\n\n const asyncAST = parser.createASTNode(\n {\n id: parsedNodeId,\n type: NodeType.Async,\n value: parsedAsync,\n flatten,\n },\n obj,\n );\n\n if (childOptions) {\n return asyncAST\n ? [\n {\n path: [...childOptions.path, childOptions.key],\n value: asyncAST,\n },\n ]\n : [];\n }\n\n return asyncAST;\n }\n },\n );\n }\n\n apply(view: ViewInstance): void {\n const context: AsyncPluginContext = {\n nodeResolveCache: new Map(),\n inProgressNodes: new Set(),\n view,\n };\n\n view.hooks.parser.tap(\"async\", this.applyParser.bind(this));\n view.hooks.resolver.tap(\"async\", (resolver) => {\n this.applyResolver(resolver, context);\n });\n }\n\n applyPlugin(asyncNodePlugin: AsyncNodePlugin): void {\n this.basePlugin = asyncNodePlugin;\n }\n}\n","import { Builder } from \"@player-ui/player\";\nimport type { AsyncTransformFunc } from \"./types\";\n\n/**\n * @deprecated Use {@link createAsyncTransform} to create your before transform function.\n * Util function to generate transform function for async asset\n * @param asset - async asset to apply beforeResolve transform\n * @param wrapperAssetType: container asset type\n * @param flatten: flatten the streamed in content\n * @param path: property path to add the multinode containing the next async node to\n * @returns - wrapper asset with children of transformed asset and async node\n */\n\nexport const asyncTransform: AsyncTransformFunc = (\n assetId,\n wrapperAssetType,\n asset,\n flatten,\n path = [\"values\"],\n) => {\n const id = \"async-\" + assetId;\n\n const asyncNode = Builder.asyncNode(id, flatten);\n\n let multiNode;\n let assetNode;\n\n if (asset) {\n assetNode = Builder.assetWrapper(asset);\n multiNode = Builder.multiNode(assetNode, asyncNode);\n } else {\n multiNode = Builder.multiNode(asyncNode);\n }\n\n const wrapperAsset = Builder.asset({\n id: wrapperAssetType + \"-\" + id,\n type: wrapperAssetType,\n });\n\n Builder.addChild(wrapperAsset, path, multiNode);\n\n return wrapperAsset;\n};\n","import {\n BeforeTransformFunction,\n Builder,\n Node,\n NodeType,\n} from \"@player-ui/player\";\nimport {\n extractNodeFromPath,\n requiresAssetWrapper,\n traverseAndReplace,\n unwrapAsset,\n} from \"./utils\";\n\nexport type AsyncTransformOptions = {\n /** Whether or not to flatten the results into its container. Defaults to true */\n flatten?: boolean;\n /** The path to the array within the `wrapperAssetType` that will contain the async content. Defaults to [\"values\"] */\n path?: string[];\n /** The asset type that the transform is matching against. */\n transformAssetType: string;\n /** The asset type that will contain the async content. */\n wrapperAssetType: string;\n /** Function to get any nested asset that will need to be extracted and kept when creating the wrapper asset. */\n getNestedAsset?: (node: Node.ViewOrAsset) => Node.Node | undefined;\n /** Function to get the id for the async node being generated. Defaults to creating an id with the format of async-<ASSET.ID> */\n getAsyncNodeId?: (node: Node.ViewOrAsset) => string;\n /** Where to place the async node relative to the asset from `getNestedAsset`. Defaults to \"append\" */\n asyncNodePosition?: \"append\" | \"prepend\";\n};\n\nconst defaultGetNodeId = (node: Node.ViewOrAsset): string => {\n return `async-${node.value.id}`;\n};\n\n/** Creates a BeforeTransformFunction that turns the given asset into a wrapper asset with an async node in it.\n * By setting {@link AsyncTransformOptions.flatten} to true, you can chain multiple of the same asset type to create a flow of async content that\n * exists within a single collection.\n *\n * @param options - Options for managing the transform\n * @returns The {@link BeforeTransformFunction} that can be used for your asset.\n */\nexport const createAsyncTransform = (\n options: AsyncTransformOptions,\n): BeforeTransformFunction => {\n const {\n transformAssetType,\n wrapperAssetType,\n getNestedAsset,\n getAsyncNodeId = defaultGetNodeId,\n path = [\"values\"],\n flatten = true,\n asyncNodePosition = \"append\",\n } = options;\n\n const replaceNode = (node: Node.Node): Node.Node => {\n const unwrapped = unwrapAsset(node);\n\n if (\n unwrapped.type !== NodeType.Asset ||\n unwrapped.value.type !== transformAssetType\n ) {\n return node;\n }\n\n const transformed = asyncTransform(unwrapped);\n return extractNodeFromPath(transformed, path) ?? node;\n };\n\n const replacer = (node: Node.Node) => traverseAndReplace(node, replaceNode);\n\n const asyncTransform = (node: Node.ViewOrAsset) => {\n const id = getAsyncNodeId(node);\n const asset = getNestedAsset?.(node);\n\n // If flattening is disabled, don't need to extract the multi-node when async node is resolved.\n const replaceFunction = flatten ? replacer : undefined;\n const asyncNode = Builder.asyncNode(id, flatten, replaceFunction);\n\n const values: Node.Node[] = [asyncNode];\n if (asset) {\n const otherValues = [];\n if (requiresAssetWrapper(asset)) {\n otherValues.push(Builder.assetWrapper(asset));\n } else if (asset.type === NodeType.MultiNode) {\n otherValues.push(...asset.values);\n } else {\n otherValues.push(asset);\n }\n\n if (asyncNodePosition === \"append\") {\n values.unshift(...otherValues);\n } else {\n values.push(...otherValues);\n }\n }\n\n const multiNode = Builder.multiNode(...(values as any[]));\n\n const wrapperAsset: Node.ViewOrAsset = Builder.asset({\n id: wrapperAssetType + \"-\" + id,\n type: wrapperAssetType,\n });\n\n Builder.addChild(wrapperAsset, path, multiNode);\n\n return wrapperAsset;\n };\n\n return asyncTransform;\n};\n","import type { Node } from \"@player-ui/player\";\n\n/** Matches 2 segments where pathA matches or is a subset of pathB. Returns the number of matching segments */\nconst getMatchValue = (\n pathA: Node.PathSegment[],\n pathB: Node.PathSegment[],\n): number => {\n if (pathA.length > pathB.length) {\n return 0;\n }\n\n let matchCount = 0;\n for (let i = 0; i < pathA.length; i++) {\n if (pathA[i] === pathB[i]) {\n matchCount++;\n } else {\n return 0;\n }\n }\n\n return matchCount;\n};\n\n/** Follows the given path and returns the node. If there is no match, returns undefined */\nexport const extractNodeFromPath = (\n node: Node.Node,\n path?: string[],\n): Node.Node | undefined => {\n if (path === undefined || path.length === 0) {\n return node;\n }\n\n if (!(\"children\" in node && node.children)) {\n return undefined;\n }\n\n let matchResult = 0;\n let bestMatch: Node.Child | undefined;\n for (const child of node.children) {\n const matchValue = getMatchValue(child.path, path);\n if (matchValue > matchResult) {\n matchResult = matchValue;\n bestMatch = child;\n }\n }\n\n if (!bestMatch) {\n return undefined;\n }\n\n if (matchResult >= path.length) {\n return bestMatch.value;\n }\n\n return extractNodeFromPath(bestMatch.value, path.slice(matchResult));\n};\n","import { NodeType, Node } from \"@player-ui/player\";\n\n/** Replaces a node using the given replace function. If the node is a multi-node it does this transformation to all of its values. */\nexport const traverseAndReplace = (\n node: Node.Node,\n replaceFn: (node: Node.Node) => Node.Node,\n): Node.Node => {\n if (node.type === NodeType.MultiNode) {\n let index = 0;\n while (index < node.values.length) {\n const child = node.values[index];\n if (!child) {\n index++;\n continue;\n }\n\n const result = replaceFn(child);\n if (result.type === NodeType.MultiNode) {\n node.values = [\n ...node.values.slice(0, index),\n ...result.values,\n ...node.values.slice(index + 1),\n ];\n } else {\n node.values[index] = result;\n index++;\n }\n }\n\n return node;\n }\n\n return replaceFn(node);\n};\n","import { NodeType, Node } from \"@player-ui/player\";\n\nexport const unwrapAsset = (node: Node.Node): Node.Node => {\n if (node.type !== NodeType.Value) {\n return node;\n }\n const child = node.children?.find(\n (x) => x.path.length === 1 && x.path[0] === \"asset\",\n );\n\n if (!child) {\n return node;\n }\n\n return child.value;\n};\n","import { NodeType } from \"@player-ui/player\";\nimport type { Node } from \"@player-ui/player\";\n\nexport const requiresAssetWrapper = (node: Node.Node): boolean => {\n if (node.type === NodeType.Asset) {\n return true;\n }\n\n if (node.type !== NodeType.Applicability) {\n return false;\n }\n\n return node.value.type === NodeType.Asset;\n};\n"],"mappings":";AAAA,SAAS,YAAAA,WAAU,iBAAiB;AAapC,SAAS,qBAAqB,oBAAoB;AAClD,OAAO,oBAAoB;;;ACd3B,SAAS,eAAe;AAajB,IAAM,iBAAqC,CAChD,SACA,kBACA,OACA,SACA,OAAO,CAAC,QAAQ,MACb;AACH,QAAM,KAAK,WAAW;AAEtB,QAAM,YAAY,QAAQ,UAAU,IAAI,OAAO;AAE/C,MAAI;AACJ,MAAI;AAEJ,MAAI,OAAO;AACT,gBAAY,QAAQ,aAAa,KAAK;AACtC,gBAAY,QAAQ,UAAU,WAAW,SAAS;AAAA,EACpD,OAAO;AACL,gBAAY,QAAQ,UAAU,SAAS;AAAA,EACzC;AAEA,QAAM,eAAe,QAAQ,MAAM;AAAA,IACjC,IAAI,mBAAmB,MAAM;AAAA,IAC7B,MAAM;AAAA,EACR,CAAC;AAED,UAAQ,SAAS,cAAc,MAAM,SAAS;AAE9C,SAAO;AACT;;;AC1CA;AAAA,EAEE,WAAAC;AAAA,EAEA,YAAAC;AAAA,OACK;;;ACFP,IAAM,gBAAgB,CACpB,OACA,UACW;AACX,MAAI,MAAM,SAAS,MAAM,QAAQ;AAC/B,WAAO;AAAA,EACT;AAEA,MAAI,aAAa;AACjB,WAAS,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK;AACrC,QAAI,MAAM,CAAC,MAAM,MAAM,CAAC,GAAG;AACzB;AAAA,IACF,OAAO;AACL,aAAO;AAAA,IACT;AAAA,EACF;AAEA,SAAO;AACT;AAGO,IAAM,sBAAsB,CACjC,MACA,SAC0B;AAC1B,MAAI,SAAS,UAAa,KAAK,WAAW,GAAG;AAC3C,WAAO;AAAA,EACT;AAEA,MAAI,EAAE,cAAc,QAAQ,KAAK,WAAW;AAC1C,WAAO;AAAA,EACT;AAEA,MAAI,cAAc;AAClB,MAAI;AACJ,aAAW,SAAS,KAAK,UAAU;AACjC,UAAM,aAAa,cAAc,MAAM,MAAM,IAAI;AACjD,QAAI,aAAa,aAAa;AAC5B,oBAAc;AACd,kBAAY;AAAA,IACd;AAAA,EACF;AAEA,MAAI,CAAC,WAAW;AACd,WAAO;AAAA,EACT;AAEA,MAAI,eAAe,KAAK,QAAQ;AAC9B,WAAO,UAAU;AAAA,EACnB;AAEA,SAAO,oBAAoB,UAAU,OAAO,KAAK,MAAM,WAAW,CAAC;AACrE;;;ACvDA,SAAS,gBAAsB;AAGxB,IAAM,qBAAqB,CAChC,MACA,cACc;AACd,MAAI,KAAK,SAAS,SAAS,WAAW;AACpC,QAAI,QAAQ;AACZ,WAAO,QAAQ,KAAK,OAAO,QAAQ;AACjC,YAAM,QAAQ,KAAK,OAAO,KAAK;AAC/B,UAAI,CAAC,OAAO;AACV;AACA;AAAA,MACF;AAEA,YAAM,SAAS,UAAU,KAAK;AAC9B,UAAI,OAAO,SAAS,SAAS,WAAW;AACtC,aAAK,SAAS;AAAA,UACZ,GAAG,KAAK,OAAO,MAAM,GAAG,KAAK;AAAA,UAC7B,GAAG,OAAO;AAAA,UACV,GAAG,KAAK,OAAO,MAAM,QAAQ,CAAC;AAAA,QAChC;AAAA,MACF,OAAO;AACL,aAAK,OAAO,KAAK,IAAI;AACrB;AAAA,MACF;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAEA,SAAO,UAAU,IAAI;AACvB;;;ACjCA,SAAS,YAAAC,iBAAsB;AAExB,IAAM,cAAc,CAAC,SAA+B;AACzD,MAAI,KAAK,SAASA,UAAS,OAAO;AAChC,WAAO;AAAA,EACT;AACA,QAAM,QAAQ,KAAK,UAAU;AAAA,IAC3B,CAAC,MAAM,EAAE,KAAK,WAAW,KAAK,EAAE,KAAK,CAAC,MAAM;AAAA,EAC9C;AAEA,MAAI,CAAC,OAAO;AACV,WAAO;AAAA,EACT;AAEA,SAAO,MAAM;AACf;;;ACfA,SAAS,YAAAC,iBAAgB;AAGlB,IAAM,uBAAuB,CAAC,SAA6B;AAChE,MAAI,KAAK,SAASA,UAAS,OAAO;AAChC,WAAO;AAAA,EACT;AAEA,MAAI,KAAK,SAASA,UAAS,eAAe;AACxC,WAAO;AAAA,EACT;AAEA,SAAO,KAAK,MAAM,SAASA,UAAS;AACtC;;;AJiBA,IAAM,mBAAmB,CAAC,SAAmC;AAC3D,SAAO,SAAS,KAAK,MAAM,EAAE;AAC/B;AASO,IAAM,uBAAuB,CAClC,YAC4B;AAC5B,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA,iBAAiB;AAAA,IACjB,OAAO,CAAC,QAAQ;AAAA,IAChB,UAAU;AAAA,IACV,oBAAoB;AAAA,EACtB,IAAI;AAEJ,QAAM,cAAc,CAAC,SAA+B;AAClD,UAAM,YAAY,YAAY,IAAI;AAElC,QACE,UAAU,SAASC,UAAS,SAC5B,UAAU,MAAM,SAAS,oBACzB;AACA,aAAO;AAAA,IACT;AAEA,UAAM,cAAcC,gBAAe,SAAS;AAC5C,WAAO,oBAAoB,aAAa,IAAI,KAAK;AAAA,EACnD;AAEA,QAAM,WAAW,CAAC,SAAoB,mBAAmB,MAAM,WAAW;AAE1E,QAAMA,kBAAiB,CAAC,SAA2B;AACjD,UAAM,KAAK,eAAe,IAAI;AAC9B,UAAM,QAAQ,iBAAiB,IAAI;AAGnC,UAAM,kBAAkB,UAAU,WAAW;AAC7C,UAAM,YAAYC,SAAQ,UAAU,IAAI,SAAS,eAAe;AAEhE,UAAM,SAAsB,CAAC,SAAS;AACtC,QAAI,OAAO;AACT,YAAM,cAAc,CAAC;AACrB,UAAI,qBAAqB,KAAK,GAAG;AAC/B,oBAAY,KAAKA,SAAQ,aAAa,KAAK,CAAC;AAAA,MAC9C,WAAW,MAAM,SAASF,UAAS,WAAW;AAC5C,oBAAY,KAAK,GAAG,MAAM,MAAM;AAAA,MAClC,OAAO;AACL,oBAAY,KAAK,KAAK;AAAA,MACxB;AAEA,UAAI,sBAAsB,UAAU;AAClC,eAAO,QAAQ,GAAG,WAAW;AAAA,MAC/B,OAAO;AACL,eAAO,KAAK,GAAG,WAAW;AAAA,MAC5B;AAAA,IACF;AAEA,UAAM,YAAYE,SAAQ,UAAU,GAAI,MAAgB;AAExD,UAAM,eAAiCA,SAAQ,MAAM;AAAA,MACnD,IAAI,mBAAmB,MAAM;AAAA,MAC7B,MAAM;AAAA,IACR,CAAC;AAED,IAAAA,SAAQ,SAAS,cAAc,MAAM,SAAS;AAE9C,WAAO;AAAA,EACT;AAEA,SAAOD;AACT;;;AFjDO,IAAM,wBAAgC,OAAO,IAAI,iBAAiB;AAMlE,IAAM,mBAAN,MAAM,iBAAwC;AAAA,EAOnD,YAAY,SAAiC,cAA6B;AAF1E,SAAgB,SAAiB,iBAAgB;AAoBjD,SAAgB,QAAwB;AAAA,MACtC,aAAa,IAAI,oBAAoB;AAAA,MACrC,kBAAkB,IAAI,aAAa;AAAA,IACrC;AAMA,gBAAO;AA1BL,QAAI,SAAS,SAAS;AACpB,WAAK,UAAU,QAAQ;AACvB,cAAQ,QAAQ,QAAQ,CAAC,WAAW;AAClC,eAAO,YAAY,IAAI;AAAA,MACzB,CAAC;AAAA,IACH;AAEA,QAAI,cAAc;AAChB,WAAK,MAAM,YAAY;AAAA,QACrB;AAAA,QACA,OAAO,MAAkB,aAAa;AACpC,iBAAO,MAAM,aAAa,MAAM,QAAQ;AAAA,QAC1C;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAOA,oBAAwC;AACtC,WAAO,KAAK;AAAA,EACd;AAAA,EAIA,MAAM,QAAsB;AAC1B,SAAK,iBAAiB;AAEtB,WAAO,MAAM,eAAe,IAAI,KAAK,MAAM,CAAC,mBAAmB;AAC7D,qBAAe,MAAM,KAAK,IAAI,KAAK,MAAM,CAAC,SAAS;AACjD,aAAK,SAAS,QAAQ,CAAC,WAAW;AAChC,iBAAO,MAAM,IAAI;AAAA,QACnB,CAAC;AAAA,MACH,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AACF;AA/Ca,iBAIJ,SAAiB;AAJnB,IAAM,kBAAN;AAiDA,IAAM,wBAAN,MAA2D;AAAA,EAA3D;AAGL,gBAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASC,mBACN,MACA,SACA,QACA,SACA;AACA,QAAI,aACF,QAAQ,aAAa,SAAS,QAAQ,UAAU,MAAM,IAAI;AAE5D,QAAI,cAAc,KAAK,iBAAiB;AACtC,mBAAa,KAAK,gBAAgB,UAAU;AAAA,IAC9C;AAEA,SAAK,kBAAkB,MAAM,SAAS,UAAU;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWQ,kBACN,MACA,SACA,SACA;AACA,UAAM,EAAE,kBAAkB,KAAK,IAAI;AACnC,QAAI,iBAAiB,IAAI,KAAK,EAAE,MAAM,SAAS;AAC7C,uBAAiB,IAAI,KAAK,IAAI,UAAU,UAAU,IAAI;AACtD,WAAK,YAAY,KAAK,EAAE;AAAA,IAC1B;AAAA,EACF;AAAA,EAEQ,gBACN,MACA,SACS;AACT,UAAM,EAAE,iBAAiB,IAAI;AAC7B,WACE,iBAAiB,IAAI,KAAK,EAAE,KAAK,iBAAiB,IAAI,KAAK,EAAE,MAAM;AAAA,EAEvE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,cAAc,UAAoB,SAAmC;AACnE,aAAS,MAAM,cAAc,IAAI,KAAK,MAAM,CAAC,MAAM,YAAY;AAC7D,UAAI,CAAC,KAAK,QAAQ,IAAI,GAAG;AACvB,eAAO,SAAS,OAAO,OAAO,KAAK,qBAAqB,MAAM,OAAO;AAAA,MACvE;AAEA,YAAM,eAAe,QAAQ,iBAAiB,IAAI,KAAK,EAAE;AACzD,UAAI,iBAAiB,QAAW;AAC9B,YAAI,aAAa,uBAAuB,QAAW;AACjD,uBAAa,qBAAqB,CAAC;AAAA,QACrC;AACA,qBAAa,mBAAmB,KAAK,KAAK,EAAE;AAC5C,eAAO,KAAK,qBAAqB,cAAc,OAAO;AAAA,MACxD;AAEA,UAAI,QAAQ,gBAAgB,IAAI,KAAK,EAAE,GAAG;AACxC,eAAO;AAAA,MACT;AAGA,cAAQ,gBAAgB,IAAI,KAAK,EAAE;AACnC,qBAAe,MAAM;AACnB,aAAK,aAAa,MAAM,SAAS,OAAO,EAAE,QAAQ;AAAA,MACpD,CAAC;AAED,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASQ,qBACN,MACA,SACW;AACX,UAAM,qBAA+B,KAAK,sBAAsB,CAAC;AACjE,SAAK,qBAAqB;AAC1B,QAAI,KAAK,SAASE,UAAS,WAAW;AAEpC,UAAI,QAAQ;AACZ,aAAO,QAAQ,KAAK,OAAO,QAAQ;AACjC,cAAM,YAAY,KAAK,OAAO,KAAK;AACnC,YACE,WAAW,SAASA,UAAS,SAC7B,CAAC,KAAK,gBAAgB,WAAW,OAAO,GACxC;AACA;AACA;AAAA,QACF;AAEA,cAAM,aAAa,QAAQ,iBAAiB,IAAI,UAAU,EAAE;AAC5D,2BAAmB,KAAK,UAAU,EAAE;AACpC,YAAI,WAAW,SAASA,UAAS,aAAa,UAAU,SAAS;AAC/D,qBAAW,OAAO,QAAQ,CAAC,MAAkB,EAAE,SAAS,IAAK;AAC7D,eAAK,SAAS;AAAA,YACZ,GAAG,KAAK,OAAO,MAAM,GAAG,KAAK;AAAA,YAC7B,GAAG,WAAW;AAAA,YACd,GAAG,KAAK,OAAO,MAAM,QAAQ,CAAC;AAAA,UAChC;AAAA,QACF,OAAO;AACL,eAAK,OAAO,KAAK,IAAI;AACrB,qBAAW,SAAS;AAAA,QACtB;AAAA,MACF;AAAA,IACF,WAAW,cAAc,MAAM;AAC7B,WAAK,UAAU,QAAQ,CAAC,MAAM;AAE5B,eACE,EAAE,MAAM,SAASA,UAAS,SAC1B,KAAK,gBAAgB,EAAE,OAAO,OAAO,GACrC;AACA,6BAAmB,KAAK,EAAE,MAAM,EAAE;AAClC,YAAE,QAAQ,QAAQ,iBAAiB,IAAI,EAAE,MAAM,EAAE;AACjD,YAAE,MAAM,SAAS;AAAA,QACnB;AAAA,MACF,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,EACT;AAAA,EAEA,MAAc,aACZ,MACA,SACA,SACA;AACA,QAAI;AACF,YAAM,SAAS,MAAM,KAAK,YAAY,MAAM,YAAY;AAAA,QACtD;AAAA,QACA,CAACC,YAAW;AACV,eAAK,mBAAmB,MAAM,SAASA,SAAQ,OAAO;AAAA,QACxD;AAAA,MACF;AAGA,cAAQ,gBAAgB,OAAO,KAAK,EAAE;AACtC,WAAK,mBAAmB,MAAM,SAAS,QAAQ,OAAO;AAAA,IACxD,SAAS,GAAY;AACnB,YAAM,QAAQ,aAAa,QAAQ,IAAI,IAAI,MAAM,OAAO,CAAC,CAAC;AAC1D,YAAM,SAAS,KAAK,YAAY,MAAM,iBAAiB,KAAK,OAAO,IAAI;AAEvE,UAAI,WAAW,QAAW;AACxB,cAAM,cAAc,KAAK,YAAY,kBAAkB,GAAG,SAAS;AAEnE,YAAI,aAAa,WAAW,eAAe;AACzC,sBAAY,KAAK,KAAK;AAAA,QACxB;AAEA;AAAA,MACF;AAEA,cAAQ,QAAQ;AAAA,QACd;AAAA,QACA;AAAA,MACF;AAGA,cAAQ,gBAAgB,OAAO,KAAK,EAAE;AACtC,WAAK,mBAAmB,MAAM,SAAS,QAAQ,OAAO;AAAA,IACxD;AAAA,EACF;AAAA,EAEQ,QAAQ,MAA4C;AAC1D,WAAO,MAAM,SAASD,UAAS;AAAA,EACjC;AAAA,EAEQ,kBAAkB,KAAmC;AAC3D,WACE,OAAO,QAAQ,YACf,QAAQ,QACR,OAAO,UAAU,eAAe,KAAK,KAAK,OAAO;AAAA,EAErD;AAAA,EAEA,YAAY,QAAsB;AAChC,WAAO,MAAM,UAAU;AAAA,MACrB,KAAK;AAAA,MACL,CACE,KACA,UACA,SACA,iBACG;AACH,YAAI,KAAK,kBAAkB,GAAG,GAAG;AAE/B,gBAAM,EAAE,OAAO,SAAS,GAAG,KAAK,IAAI;AACpC,gBAAM,cAAc,OAAO,YAAY,MAAM,UAAU,OAAO;AAC9D,gBAAM,eAAe,UAAU,WAAW;AAE1C,cAAI,gBAAgB,QAAQ,CAAC,cAAc;AACzC,mBAAO,eAAe,CAAC,IAAI;AAAA,UAC7B;AAEA,gBAAM,WAAW,OAAO;AAAA,YACtB;AAAA,cACE,IAAI;AAAA,cACJ,MAAMA,UAAS;AAAA,cACf,OAAO;AAAA,cACP;AAAA,YACF;AAAA,YACA;AAAA,UACF;AAEA,cAAI,cAAc;AAChB,mBAAO,WACH;AAAA,cACE;AAAA,gBACE,MAAM,CAAC,GAAG,aAAa,MAAM,aAAa,GAAG;AAAA,gBAC7C,OAAO;AAAA,cACT;AAAA,YACF,IACA,CAAC;AAAA,UACP;AAEA,iBAAO;AAAA,QACT;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,MAA0B;AAC9B,UAAM,UAA8B;AAAA,MAClC,kBAAkB,oBAAI,IAAI;AAAA,MAC1B,iBAAiB,oBAAI,IAAI;AAAA,MACzB;AAAA,IACF;AAEA,SAAK,MAAM,OAAO,IAAI,SAAS,KAAK,YAAY,KAAK,IAAI,CAAC;AAC1D,SAAK,MAAM,SAAS,IAAI,SAAS,CAAC,aAAa;AAC7C,WAAK,cAAc,UAAU,OAAO;AAAA,IACtC,CAAC;AAAA,EACH;AAAA,EAEA,YAAY,iBAAwC;AAClD,SAAK,aAAa;AAAA,EACpB;AACF;","names":["NodeType","Builder","NodeType","NodeType","NodeType","NodeType","asyncTransform","Builder","NodeType","result"]}
|
|
1
|
+
{"version":3,"sources":["../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/index.ts","../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/transform.ts","../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/createAsyncTransform.ts","../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/utils/extractNodeFromPath.ts","../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/utils/traverseAndReplace.ts","../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/utils/unwrapAsset.ts","../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/utils/requiresAssetWrapper.ts"],"sourcesContent":["import { NodeType, getNodeID } from \"@player-ui/player\";\nimport type {\n Player,\n PlayerPlugin,\n Node,\n ParseObjectOptions,\n ParseObjectChildOptions,\n ViewInstance,\n Parser,\n ViewPlugin,\n Resolver,\n Resolve,\n ViewController,\n} from \"@player-ui/player\";\nimport { AsyncSeriesBailHook, SyncBailHook } from \"tapable-ts\";\nimport queueMicrotask from \"queue-microtask\";\n\nexport * from \"./types\";\nexport * from \"./transform\";\nexport * from \"./createAsyncTransform\";\n\n/** Object type for storing data related to a single `apply` of the `AsyncNodePluginPlugin`\n * 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.\n */\ntype AsyncPluginContext = {\n /** Map of async node id to resolved content */\n nodeResolveCache: Map<string, Node.Node>;\n /** The view instance this context is attached to. */\n view: ViewInstance;\n /** The view controller this context is attached to. */\n viewController: ViewController;\n /** Map of async node id to promises being used to resolve them */\n inProgressNodes: Set<string>;\n /** Map of async node ids to the original node they represent.\n * In some cases, async nodes are transformed into from other node types so the original reference is needed in order to trigger an update on the view when the async node changes.\n */\n originalNodeCache: Map<string, Set<Node.Node>>;\n};\n\nexport interface AsyncNodePluginOptions {\n /** A set of plugins to load */\n plugins?: AsyncNodeViewPlugin[];\n}\n\nexport interface AsyncNodeViewPlugin extends ViewPlugin {\n /** Use this to tap into the async node plugin hooks */\n applyPlugin: (asyncNodePlugin: AsyncNodePlugin) => void;\n\n applyPlayer?: (player: Player) => void;\n}\nexport type AsyncHandler = (\n node: Node.Async,\n callback?: (result: any) => void,\n) => Promise<any>;\n\nexport type AsyncContent = {\n async: true;\n flatten?: boolean;\n [key: string]: unknown;\n};\n\n/** Hook declaration for the AsyncNodePlugin */\nexport type AsyncNodeHooks = {\n /** Async hook to get content for an async node */\n onAsyncNode: AsyncSeriesBailHook<[Node.Async, (result: any) => void], any>;\n /** 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. */\n onAsyncNodeError: SyncBailHook<[Error, Node.Async], any>;\n};\n\nexport const AsyncNodePluginSymbol: symbol = Symbol.for(\"AsyncNodePlugin\");\n\n/**\n * Async node plugin used to resolve async nodes in the content\n * If an async node is present, allow users to provide a replacement node to be rendered when ready\n */\nexport class AsyncNodePlugin implements PlayerPlugin {\n private plugins: AsyncNodeViewPlugin[] | undefined;\n private playerInstance: Player | undefined;\n\n static Symbol: symbol = AsyncNodePluginSymbol;\n public readonly symbol: symbol = AsyncNodePlugin.Symbol;\n\n constructor(options: AsyncNodePluginOptions, asyncHandler?: AsyncHandler) {\n if (options?.plugins) {\n this.plugins = options.plugins;\n options.plugins.forEach((plugin) => {\n plugin.applyPlugin(this);\n });\n }\n\n if (asyncHandler) {\n this.hooks.onAsyncNode.tap(\n \"async\",\n async (node: Node.Async, callback) => {\n return await asyncHandler(node, callback);\n },\n );\n }\n }\n\n public readonly hooks: AsyncNodeHooks = {\n onAsyncNode: new AsyncSeriesBailHook(),\n onAsyncNodeError: new SyncBailHook(),\n };\n\n getPlayerInstance(): Player | undefined {\n return this.playerInstance;\n }\n\n name = \"AsyncNode\";\n\n apply(player: Player): void {\n this.playerInstance = player;\n\n this.plugins?.forEach((plugin) => {\n plugin.applyPlayer?.(player);\n });\n\n player.hooks.viewController.tap(this.name, (viewController) => {\n viewController.hooks.view.tap(this.name, (view) => {\n this.plugins?.forEach((plugin) => {\n plugin.apply(view);\n });\n });\n });\n }\n}\n\nexport class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {\n private basePlugin: AsyncNodePlugin | undefined;\n\n name = \"AsyncNode\";\n\n /**\n * Parses the node from the result and triggers an asynchronous view update if necessary.\n * @param node The asynchronous node that might be updated.\n * @param result The result obtained from resolving the async node. This could be any data structure or value.\n * @param options Options provided for node resolution, including a potential parseNode function to process the result.\n * @param view The view instance where the node resides. This can be undefined if the view is not currently active.\n */\n private parseNodeAndUpdate(\n node: Node.Async,\n context: AsyncPluginContext,\n result: any,\n options: Resolve.NodeResolveOptions,\n ) {\n let parsedNode =\n options.parseNode && result ? options.parseNode(result) : undefined;\n\n if (parsedNode && node.onValueReceived) {\n parsedNode = node.onValueReceived(parsedNode);\n }\n\n this.handleAsyncUpdate(node, context, parsedNode);\n }\n\n /**\n * Updates the node asynchronously based on the result provided.\n * This method is responsible for handling the update logic of asynchronous nodes.\n * It checks if the node needs to be updated based on the new result and updates the mapping accordingly.\n * If an update is necessary, it triggers an asynchronous update on the view.\n * @param node The asynchronous node that might be updated.\n * @param newNode The new node to replace the async node.\n * @param view The view instance where the node resides. This can be undefined if the view is not currently active.\n */\n private handleAsyncUpdate(\n node: Node.Async,\n context: AsyncPluginContext,\n newNode?: Node.Node | null,\n ) {\n const { nodeResolveCache, viewController, originalNodeCache } = context;\n if (nodeResolveCache.get(node.id) !== newNode) {\n nodeResolveCache.set(node.id, newNode ? newNode : node);\n const originalNode = originalNodeCache.get(node.id) ?? new Set([node]);\n viewController.updateViewAST(originalNode);\n }\n }\n\n private hasValidMapping(\n node: Node.Async,\n context: AsyncPluginContext,\n ): boolean {\n const { nodeResolveCache } = context;\n return (\n nodeResolveCache.has(node.id) && nodeResolveCache.get(node.id) !== node\n );\n }\n\n /**\n * Handles the asynchronous API integration for resolving nodes.\n * This method sets up a hook on the resolver's `beforeResolve` event to process async nodes.\n * @param resolver The resolver instance to attach the hook to.\n * @param view\n */\n applyResolver(resolver: Resolver, context: AsyncPluginContext): void {\n resolver.hooks.beforeResolve.tap(this.name, (node, options) => {\n if (!this.isAsync(node)) {\n return node === null ? node : this.resolveAsyncChildren(node, context);\n }\n if (options.node) {\n context.originalNodeCache.set(node.id, new Set([options.node]));\n }\n\n const resolvedNode = context.nodeResolveCache.get(node.id);\n if (resolvedNode !== undefined) {\n return this.resolveAsyncChildren(resolvedNode, context);\n }\n\n if (context.inProgressNodes.has(node.id)) {\n return node;\n }\n\n // Track that the node is in progress.\n context.inProgressNodes.add(node.id);\n queueMicrotask(() => {\n this.runAsyncNode(node, context, options).finally();\n });\n\n return node;\n });\n }\n\n /**\n * Replaces child async nodes with their resolved content and flattens when necessary. Resolving the children directly helps manage the `parent` reference without needing as much work within the resolver itself.\n * Handles async node chains as well to make sure all applicable nodes can get flattened.\n * @param node - The node whose children need to be resolved.\n * @param context - the async plugin context needed to reach into the cache\n * @returns The same node but with async node children mapped to their resolved AST.\n */\n private resolveAsyncChildren(\n node: Node.Node,\n context: AsyncPluginContext,\n ): Node.Node {\n if (node.type === NodeType.MultiNode) {\n // Using a while loop lets us catch when async nodes produce more async nodes that need to be flattened further\n let index = 0;\n while (index < node.values.length) {\n const childNode = node.values[index];\n if (\n childNode?.type !== NodeType.Async ||\n !this.hasValidMapping(childNode, context)\n ) {\n index++;\n continue;\n }\n\n const mappedNode = context.nodeResolveCache.get(childNode.id)!;\n const nodeSet = new Set<Node.Node>();\n if (mappedNode.type === NodeType.MultiNode && childNode.flatten) {\n mappedNode.values.forEach((v: Node.Node) => {\n v.parent = node;\n nodeSet.add(v);\n });\n node.values = [\n ...node.values.slice(0, index),\n ...mappedNode.values,\n ...node.values.slice(index + 1),\n ];\n } else {\n node.values[index] = mappedNode;\n mappedNode.parent = node;\n nodeSet.add(mappedNode);\n }\n context.originalNodeCache.set(childNode.id, nodeSet);\n }\n } else if (\"children\" in node) {\n node.children?.forEach((c) => {\n // Similar to above, using a while loop lets us handle when async nodes produce more async nodes.\n while (\n c.value.type === NodeType.Async &&\n this.hasValidMapping(c.value, context)\n ) {\n const mappedNode = context.nodeResolveCache.get(c.value.id)!;\n context.originalNodeCache.set(c.value.id, new Set([mappedNode]));\n c.value = mappedNode;\n c.value.parent = node;\n }\n });\n }\n\n return node;\n }\n\n private async runAsyncNode(\n node: Node.Async,\n context: AsyncPluginContext,\n options: Resolve.NodeResolveOptions,\n ) {\n try {\n const result = await this.basePlugin?.hooks.onAsyncNode.call(\n node,\n (result) => {\n this.parseNodeAndUpdate(node, context, result, options);\n },\n );\n\n // Stop tracking before the next update is triggered\n context.inProgressNodes.delete(node.id);\n this.parseNodeAndUpdate(node, context, result, options);\n } catch (e: unknown) {\n const error = e instanceof Error ? e : new Error(String(e));\n const result = this.basePlugin?.hooks.onAsyncNodeError.call(error, node);\n\n if (result === undefined) {\n const playerState = this.basePlugin?.getPlayerInstance()?.getState();\n\n if (playerState?.status === \"in-progress\") {\n playerState.fail(error);\n }\n\n return;\n }\n\n options.logger?.error(\n \"Async node handling failed and resolved with a fallback. Error:\",\n error,\n );\n\n // Stop tracking before the next update is triggered\n context.inProgressNodes.delete(node.id);\n this.parseNodeAndUpdate(node, context, result, options);\n }\n }\n\n private isAsync(node: Node.Node | null): node is Node.Async {\n return node?.type === NodeType.Async;\n }\n\n private isDeterminedAsync(obj: unknown): obj is AsyncContent {\n return (\n typeof obj === \"object\" &&\n obj !== null &&\n Object.prototype.hasOwnProperty.call(obj, \"async\")\n );\n }\n\n applyParser(parser: Parser): void {\n parser.hooks.parseNode.tap(\n this.name,\n (\n obj: any,\n nodeType: Node.ChildrenTypes,\n options: ParseObjectOptions,\n childOptions?: ParseObjectChildOptions,\n ) => {\n if (this.isDeterminedAsync(obj)) {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n const { async, flatten, ...rest } = obj;\n const parsedAsync = parser.parseObject(rest, nodeType, options);\n const parsedNodeId = getNodeID(parsedAsync);\n\n if (parsedAsync === null || !parsedNodeId) {\n return childOptions ? [] : null;\n }\n\n const asyncAST = parser.createASTNode(\n {\n id: parsedNodeId,\n type: NodeType.Async,\n value: parsedAsync,\n flatten,\n },\n obj,\n );\n\n if (childOptions) {\n return asyncAST\n ? [\n {\n path: [...childOptions.path, childOptions.key],\n value: asyncAST,\n },\n ]\n : [];\n }\n\n return asyncAST;\n }\n },\n );\n }\n\n apply(view: ViewInstance): void {\n view.hooks.parser.tap(\"async\", this.applyParser.bind(this));\n }\n\n applyPlayer(player: Player): void {\n player.hooks.viewController.tap(\"async\", (viewController) => {\n viewController.hooks.view.tap(\"async\", (view) => {\n const context: AsyncPluginContext = {\n nodeResolveCache: new Map(),\n inProgressNodes: new Set(),\n view,\n viewController,\n originalNodeCache: new Map(),\n };\n\n view.hooks.resolver.tap(\"async\", (resolver) => {\n this.applyResolver(resolver, context);\n });\n });\n });\n }\n\n applyPlugin(asyncNodePlugin: AsyncNodePlugin): void {\n this.basePlugin = asyncNodePlugin;\n }\n}\n","import { Builder } from \"@player-ui/player\";\nimport type { AsyncTransformFunc } from \"./types\";\n\n/**\n * @deprecated Use {@link createAsyncTransform} to create your before transform function.\n * Util function to generate transform function for async asset\n * @param asset - async asset to apply beforeResolve transform\n * @param wrapperAssetType: container asset type\n * @param flatten: flatten the streamed in content\n * @param path: property path to add the multinode containing the next async node to\n * @returns - wrapper asset with children of transformed asset and async node\n */\n\nexport const asyncTransform: AsyncTransformFunc = (\n assetId,\n wrapperAssetType,\n asset,\n flatten,\n path = [\"values\"],\n) => {\n const id = \"async-\" + assetId;\n\n const asyncNode = Builder.asyncNode(id, flatten);\n\n let multiNode;\n let assetNode;\n\n if (asset) {\n assetNode = Builder.assetWrapper(asset);\n multiNode = Builder.multiNode(assetNode, asyncNode);\n } else {\n multiNode = Builder.multiNode(asyncNode);\n }\n\n const wrapperAsset = Builder.asset({\n id: wrapperAssetType + \"-\" + id,\n type: wrapperAssetType,\n });\n\n Builder.addChild(wrapperAsset, path, multiNode);\n\n return wrapperAsset;\n};\n","import {\n BeforeTransformFunction,\n Builder,\n Node,\n NodeType,\n} from \"@player-ui/player\";\nimport {\n extractNodeFromPath,\n requiresAssetWrapper,\n traverseAndReplace,\n unwrapAsset,\n} from \"./utils\";\n\nexport type AsyncTransformOptions = {\n /** Whether or not to flatten the results into its container. Defaults to true */\n flatten?: boolean;\n /** The path to the array within the `wrapperAssetType` that will contain the async content. Defaults to [\"values\"] */\n path?: string[];\n /** The asset type that the transform is matching against. */\n transformAssetType: string;\n /** The asset type that will contain the async content. */\n wrapperAssetType: string;\n /** Function to get any nested asset that will need to be extracted and kept when creating the wrapper asset. */\n getNestedAsset?: (node: Node.ViewOrAsset) => Node.Node | undefined;\n /** Function to get the id for the async node being generated. Defaults to creating an id with the format of async-<ASSET.ID> */\n getAsyncNodeId?: (node: Node.ViewOrAsset) => string;\n /** Where to place the async node relative to the asset from `getNestedAsset`. Defaults to \"append\" */\n asyncNodePosition?: \"append\" | \"prepend\";\n};\n\nconst defaultGetNodeId = (node: Node.ViewOrAsset): string => {\n return `async-${node.value.id}`;\n};\n\n/** Creates a BeforeTransformFunction that turns the given asset into a wrapper asset with an async node in it.\n * By setting {@link AsyncTransformOptions.flatten} to true, you can chain multiple of the same asset type to create a flow of async content that\n * exists within a single collection.\n *\n * @param options - Options for managing the transform\n * @returns The {@link BeforeTransformFunction} that can be used for your asset.\n */\nexport const createAsyncTransform = (\n options: AsyncTransformOptions,\n): BeforeTransformFunction => {\n const {\n transformAssetType,\n wrapperAssetType,\n getNestedAsset,\n getAsyncNodeId = defaultGetNodeId,\n path = [\"values\"],\n flatten = true,\n asyncNodePosition = \"append\",\n } = options;\n\n const replaceNode = (node: Node.Node): Node.Node => {\n const unwrapped = unwrapAsset(node);\n\n if (\n unwrapped.type !== NodeType.Asset ||\n unwrapped.value.type !== transformAssetType\n ) {\n return node;\n }\n\n const transformed = asyncTransform(unwrapped);\n return extractNodeFromPath(transformed, path) ?? node;\n };\n\n const replacer = (node: Node.Node) => traverseAndReplace(node, replaceNode);\n\n const asyncTransform = (node: Node.ViewOrAsset) => {\n const id = getAsyncNodeId(node);\n const asset = getNestedAsset?.(node);\n\n // If flattening is disabled, don't need to extract the multi-node when async node is resolved.\n const replaceFunction = flatten ? replacer : undefined;\n const asyncNode = Builder.asyncNode(id, flatten, replaceFunction);\n\n const values: Node.Node[] = [asyncNode];\n if (asset) {\n const otherValues = [];\n if (requiresAssetWrapper(asset)) {\n otherValues.push(Builder.assetWrapper(asset));\n } else if (asset.type === NodeType.MultiNode) {\n otherValues.push(...asset.values);\n } else {\n otherValues.push(asset);\n }\n\n if (asyncNodePosition === \"append\") {\n values.unshift(...otherValues);\n } else {\n values.push(...otherValues);\n }\n }\n\n const multiNode = Builder.multiNode(...(values as any[]));\n\n const wrapperAsset: Node.ViewOrAsset = Builder.asset({\n id: wrapperAssetType + \"-\" + id,\n type: wrapperAssetType,\n });\n\n Builder.addChild(wrapperAsset, path, multiNode);\n\n return wrapperAsset;\n };\n\n return asyncTransform;\n};\n","import type { Node } from \"@player-ui/player\";\n\n/** Matches 2 segments where pathA matches or is a subset of pathB. Returns the number of matching segments */\nconst getMatchValue = (\n pathA: Node.PathSegment[],\n pathB: Node.PathSegment[],\n): number => {\n if (pathA.length > pathB.length) {\n return 0;\n }\n\n let matchCount = 0;\n for (let i = 0; i < pathA.length; i++) {\n if (pathA[i] === pathB[i]) {\n matchCount++;\n } else {\n return 0;\n }\n }\n\n return matchCount;\n};\n\n/** Follows the given path and returns the node. If there is no match, returns undefined */\nexport const extractNodeFromPath = (\n node: Node.Node,\n path?: string[],\n): Node.Node | undefined => {\n if (path === undefined || path.length === 0) {\n return node;\n }\n\n if (!(\"children\" in node && node.children)) {\n return undefined;\n }\n\n let matchResult = 0;\n let bestMatch: Node.Child | undefined;\n for (const child of node.children) {\n const matchValue = getMatchValue(child.path, path);\n if (matchValue > matchResult) {\n matchResult = matchValue;\n bestMatch = child;\n }\n }\n\n if (!bestMatch) {\n return undefined;\n }\n\n if (matchResult >= path.length) {\n return bestMatch.value;\n }\n\n return extractNodeFromPath(bestMatch.value, path.slice(matchResult));\n};\n","import { NodeType, Node } from \"@player-ui/player\";\n\n/** Replaces a node using the given replace function. If the node is a multi-node it does this transformation to all of its values. */\nexport const traverseAndReplace = (\n node: Node.Node,\n replaceFn: (node: Node.Node) => Node.Node,\n): Node.Node => {\n if (node.type === NodeType.MultiNode) {\n let index = 0;\n while (index < node.values.length) {\n const child = node.values[index];\n if (!child) {\n index++;\n continue;\n }\n\n const result = replaceFn(child);\n if (result.type === NodeType.MultiNode) {\n node.values = [\n ...node.values.slice(0, index),\n ...result.values,\n ...node.values.slice(index + 1),\n ];\n } else {\n node.values[index] = result;\n index++;\n }\n }\n\n return node;\n }\n\n return replaceFn(node);\n};\n","import { NodeType, Node } from \"@player-ui/player\";\n\nexport const unwrapAsset = (node: Node.Node): Node.Node => {\n if (node.type !== NodeType.Value) {\n return node;\n }\n const child = node.children?.find(\n (x) => x.path.length === 1 && x.path[0] === \"asset\",\n );\n\n if (!child) {\n return node;\n }\n\n return child.value;\n};\n","import { NodeType } from \"@player-ui/player\";\nimport type { Node } from \"@player-ui/player\";\n\nexport const requiresAssetWrapper = (node: Node.Node): boolean => {\n if (node.type === NodeType.Asset) {\n return true;\n }\n\n if (node.type !== NodeType.Applicability) {\n return false;\n }\n\n return node.value.type === NodeType.Asset;\n};\n"],"mappings":";AAAA,SAAS,YAAAA,WAAU,iBAAiB;AAcpC,SAAS,qBAAqB,oBAAoB;AAClD,OAAO,oBAAoB;;;ACf3B,SAAS,eAAe;AAajB,IAAM,iBAAqC,CAChD,SACA,kBACA,OACA,SACA,OAAO,CAAC,QAAQ,MACb;AACH,QAAM,KAAK,WAAW;AAEtB,QAAM,YAAY,QAAQ,UAAU,IAAI,OAAO;AAE/C,MAAI;AACJ,MAAI;AAEJ,MAAI,OAAO;AACT,gBAAY,QAAQ,aAAa,KAAK;AACtC,gBAAY,QAAQ,UAAU,WAAW,SAAS;AAAA,EACpD,OAAO;AACL,gBAAY,QAAQ,UAAU,SAAS;AAAA,EACzC;AAEA,QAAM,eAAe,QAAQ,MAAM;AAAA,IACjC,IAAI,mBAAmB,MAAM;AAAA,IAC7B,MAAM;AAAA,EACR,CAAC;AAED,UAAQ,SAAS,cAAc,MAAM,SAAS;AAE9C,SAAO;AACT;;;AC1CA;AAAA,EAEE,WAAAC;AAAA,EAEA,YAAAC;AAAA,OACK;;;ACFP,IAAM,gBAAgB,CACpB,OACA,UACW;AACX,MAAI,MAAM,SAAS,MAAM,QAAQ;AAC/B,WAAO;AAAA,EACT;AAEA,MAAI,aAAa;AACjB,WAAS,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK;AACrC,QAAI,MAAM,CAAC,MAAM,MAAM,CAAC,GAAG;AACzB;AAAA,IACF,OAAO;AACL,aAAO;AAAA,IACT;AAAA,EACF;AAEA,SAAO;AACT;AAGO,IAAM,sBAAsB,CACjC,MACA,SAC0B;AAC1B,MAAI,SAAS,UAAa,KAAK,WAAW,GAAG;AAC3C,WAAO;AAAA,EACT;AAEA,MAAI,EAAE,cAAc,QAAQ,KAAK,WAAW;AAC1C,WAAO;AAAA,EACT;AAEA,MAAI,cAAc;AAClB,MAAI;AACJ,aAAW,SAAS,KAAK,UAAU;AACjC,UAAM,aAAa,cAAc,MAAM,MAAM,IAAI;AACjD,QAAI,aAAa,aAAa;AAC5B,oBAAc;AACd,kBAAY;AAAA,IACd;AAAA,EACF;AAEA,MAAI,CAAC,WAAW;AACd,WAAO;AAAA,EACT;AAEA,MAAI,eAAe,KAAK,QAAQ;AAC9B,WAAO,UAAU;AAAA,EACnB;AAEA,SAAO,oBAAoB,UAAU,OAAO,KAAK,MAAM,WAAW,CAAC;AACrE;;;ACvDA,SAAS,gBAAsB;AAGxB,IAAM,qBAAqB,CAChC,MACA,cACc;AACd,MAAI,KAAK,SAAS,SAAS,WAAW;AACpC,QAAI,QAAQ;AACZ,WAAO,QAAQ,KAAK,OAAO,QAAQ;AACjC,YAAM,QAAQ,KAAK,OAAO,KAAK;AAC/B,UAAI,CAAC,OAAO;AACV;AACA;AAAA,MACF;AAEA,YAAM,SAAS,UAAU,KAAK;AAC9B,UAAI,OAAO,SAAS,SAAS,WAAW;AACtC,aAAK,SAAS;AAAA,UACZ,GAAG,KAAK,OAAO,MAAM,GAAG,KAAK;AAAA,UAC7B,GAAG,OAAO;AAAA,UACV,GAAG,KAAK,OAAO,MAAM,QAAQ,CAAC;AAAA,QAChC;AAAA,MACF,OAAO;AACL,aAAK,OAAO,KAAK,IAAI;AACrB;AAAA,MACF;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAEA,SAAO,UAAU,IAAI;AACvB;;;ACjCA,SAAS,YAAAC,iBAAsB;AAExB,IAAM,cAAc,CAAC,SAA+B;AACzD,MAAI,KAAK,SAASA,UAAS,OAAO;AAChC,WAAO;AAAA,EACT;AACA,QAAM,QAAQ,KAAK,UAAU;AAAA,IAC3B,CAAC,MAAM,EAAE,KAAK,WAAW,KAAK,EAAE,KAAK,CAAC,MAAM;AAAA,EAC9C;AAEA,MAAI,CAAC,OAAO;AACV,WAAO;AAAA,EACT;AAEA,SAAO,MAAM;AACf;;;ACfA,SAAS,YAAAC,iBAAgB;AAGlB,IAAM,uBAAuB,CAAC,SAA6B;AAChE,MAAI,KAAK,SAASA,UAAS,OAAO;AAChC,WAAO;AAAA,EACT;AAEA,MAAI,KAAK,SAASA,UAAS,eAAe;AACxC,WAAO;AAAA,EACT;AAEA,SAAO,KAAK,MAAM,SAASA,UAAS;AACtC;;;AJiBA,IAAM,mBAAmB,CAAC,SAAmC;AAC3D,SAAO,SAAS,KAAK,MAAM,EAAE;AAC/B;AASO,IAAM,uBAAuB,CAClC,YAC4B;AAC5B,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA,iBAAiB;AAAA,IACjB,OAAO,CAAC,QAAQ;AAAA,IAChB,UAAU;AAAA,IACV,oBAAoB;AAAA,EACtB,IAAI;AAEJ,QAAM,cAAc,CAAC,SAA+B;AAClD,UAAM,YAAY,YAAY,IAAI;AAElC,QACE,UAAU,SAASC,UAAS,SAC5B,UAAU,MAAM,SAAS,oBACzB;AACA,aAAO;AAAA,IACT;AAEA,UAAM,cAAcC,gBAAe,SAAS;AAC5C,WAAO,oBAAoB,aAAa,IAAI,KAAK;AAAA,EACnD;AAEA,QAAM,WAAW,CAAC,SAAoB,mBAAmB,MAAM,WAAW;AAE1E,QAAMA,kBAAiB,CAAC,SAA2B;AACjD,UAAM,KAAK,eAAe,IAAI;AAC9B,UAAM,QAAQ,iBAAiB,IAAI;AAGnC,UAAM,kBAAkB,UAAU,WAAW;AAC7C,UAAM,YAAYC,SAAQ,UAAU,IAAI,SAAS,eAAe;AAEhE,UAAM,SAAsB,CAAC,SAAS;AACtC,QAAI,OAAO;AACT,YAAM,cAAc,CAAC;AACrB,UAAI,qBAAqB,KAAK,GAAG;AAC/B,oBAAY,KAAKA,SAAQ,aAAa,KAAK,CAAC;AAAA,MAC9C,WAAW,MAAM,SAASF,UAAS,WAAW;AAC5C,oBAAY,KAAK,GAAG,MAAM,MAAM;AAAA,MAClC,OAAO;AACL,oBAAY,KAAK,KAAK;AAAA,MACxB;AAEA,UAAI,sBAAsB,UAAU;AAClC,eAAO,QAAQ,GAAG,WAAW;AAAA,MAC/B,OAAO;AACL,eAAO,KAAK,GAAG,WAAW;AAAA,MAC5B;AAAA,IACF;AAEA,UAAM,YAAYE,SAAQ,UAAU,GAAI,MAAgB;AAExD,UAAM,eAAiCA,SAAQ,MAAM;AAAA,MACnD,IAAI,mBAAmB,MAAM;AAAA,MAC7B,MAAM;AAAA,IACR,CAAC;AAED,IAAAA,SAAQ,SAAS,cAAc,MAAM,SAAS;AAE9C,WAAO;AAAA,EACT;AAEA,SAAOD;AACT;;;AFxCO,IAAM,wBAAgC,OAAO,IAAI,iBAAiB;AAMlE,IAAM,mBAAN,MAAM,iBAAwC;AAAA,EAOnD,YAAY,SAAiC,cAA6B;AAF1E,SAAgB,SAAiB,iBAAgB;AAoBjD,SAAgB,QAAwB;AAAA,MACtC,aAAa,IAAI,oBAAoB;AAAA,MACrC,kBAAkB,IAAI,aAAa;AAAA,IACrC;AAMA,gBAAO;AA1BL,QAAI,SAAS,SAAS;AACpB,WAAK,UAAU,QAAQ;AACvB,cAAQ,QAAQ,QAAQ,CAAC,WAAW;AAClC,eAAO,YAAY,IAAI;AAAA,MACzB,CAAC;AAAA,IACH;AAEA,QAAI,cAAc;AAChB,WAAK,MAAM,YAAY;AAAA,QACrB;AAAA,QACA,OAAO,MAAkB,aAAa;AACpC,iBAAO,MAAM,aAAa,MAAM,QAAQ;AAAA,QAC1C;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAOA,oBAAwC;AACtC,WAAO,KAAK;AAAA,EACd;AAAA,EAIA,MAAM,QAAsB;AAC1B,SAAK,iBAAiB;AAEtB,SAAK,SAAS,QAAQ,CAAC,WAAW;AAChC,aAAO,cAAc,MAAM;AAAA,IAC7B,CAAC;AAED,WAAO,MAAM,eAAe,IAAI,KAAK,MAAM,CAAC,mBAAmB;AAC7D,qBAAe,MAAM,KAAK,IAAI,KAAK,MAAM,CAAC,SAAS;AACjD,aAAK,SAAS,QAAQ,CAAC,WAAW;AAChC,iBAAO,MAAM,IAAI;AAAA,QACnB,CAAC;AAAA,MACH,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AACF;AAnDa,iBAIJ,SAAiB;AAJnB,IAAM,kBAAN;AAqDA,IAAM,wBAAN,MAA2D;AAAA,EAA3D;AAGL,gBAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASC,mBACN,MACA,SACA,QACA,SACA;AACA,QAAI,aACF,QAAQ,aAAa,SAAS,QAAQ,UAAU,MAAM,IAAI;AAE5D,QAAI,cAAc,KAAK,iBAAiB;AACtC,mBAAa,KAAK,gBAAgB,UAAU;AAAA,IAC9C;AAEA,SAAK,kBAAkB,MAAM,SAAS,UAAU;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWQ,kBACN,MACA,SACA,SACA;AACA,UAAM,EAAE,kBAAkB,gBAAgB,kBAAkB,IAAI;AAChE,QAAI,iBAAiB,IAAI,KAAK,EAAE,MAAM,SAAS;AAC7C,uBAAiB,IAAI,KAAK,IAAI,UAAU,UAAU,IAAI;AACtD,YAAM,eAAe,kBAAkB,IAAI,KAAK,EAAE,KAAK,oBAAI,IAAI,CAAC,IAAI,CAAC;AACrE,qBAAe,cAAc,YAAY;AAAA,IAC3C;AAAA,EACF;AAAA,EAEQ,gBACN,MACA,SACS;AACT,UAAM,EAAE,iBAAiB,IAAI;AAC7B,WACE,iBAAiB,IAAI,KAAK,EAAE,KAAK,iBAAiB,IAAI,KAAK,EAAE,MAAM;AAAA,EAEvE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,cAAc,UAAoB,SAAmC;AACnE,aAAS,MAAM,cAAc,IAAI,KAAK,MAAM,CAAC,MAAM,YAAY;AAC7D,UAAI,CAAC,KAAK,QAAQ,IAAI,GAAG;AACvB,eAAO,SAAS,OAAO,OAAO,KAAK,qBAAqB,MAAM,OAAO;AAAA,MACvE;AACA,UAAI,QAAQ,MAAM;AAChB,gBAAQ,kBAAkB,IAAI,KAAK,IAAI,oBAAI,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;AAAA,MAChE;AAEA,YAAM,eAAe,QAAQ,iBAAiB,IAAI,KAAK,EAAE;AACzD,UAAI,iBAAiB,QAAW;AAC9B,eAAO,KAAK,qBAAqB,cAAc,OAAO;AAAA,MACxD;AAEA,UAAI,QAAQ,gBAAgB,IAAI,KAAK,EAAE,GAAG;AACxC,eAAO;AAAA,MACT;AAGA,cAAQ,gBAAgB,IAAI,KAAK,EAAE;AACnC,qBAAe,MAAM;AACnB,aAAK,aAAa,MAAM,SAAS,OAAO,EAAE,QAAQ;AAAA,MACpD,CAAC;AAED,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASQ,qBACN,MACA,SACW;AACX,QAAI,KAAK,SAASE,UAAS,WAAW;AAEpC,UAAI,QAAQ;AACZ,aAAO,QAAQ,KAAK,OAAO,QAAQ;AACjC,cAAM,YAAY,KAAK,OAAO,KAAK;AACnC,YACE,WAAW,SAASA,UAAS,SAC7B,CAAC,KAAK,gBAAgB,WAAW,OAAO,GACxC;AACA;AACA;AAAA,QACF;AAEA,cAAM,aAAa,QAAQ,iBAAiB,IAAI,UAAU,EAAE;AAC5D,cAAM,UAAU,oBAAI,IAAe;AACnC,YAAI,WAAW,SAASA,UAAS,aAAa,UAAU,SAAS;AAC/D,qBAAW,OAAO,QAAQ,CAAC,MAAiB;AAC1C,cAAE,SAAS;AACX,oBAAQ,IAAI,CAAC;AAAA,UACf,CAAC;AACD,eAAK,SAAS;AAAA,YACZ,GAAG,KAAK,OAAO,MAAM,GAAG,KAAK;AAAA,YAC7B,GAAG,WAAW;AAAA,YACd,GAAG,KAAK,OAAO,MAAM,QAAQ,CAAC;AAAA,UAChC;AAAA,QACF,OAAO;AACL,eAAK,OAAO,KAAK,IAAI;AACrB,qBAAW,SAAS;AACpB,kBAAQ,IAAI,UAAU;AAAA,QACxB;AACA,gBAAQ,kBAAkB,IAAI,UAAU,IAAI,OAAO;AAAA,MACrD;AAAA,IACF,WAAW,cAAc,MAAM;AAC7B,WAAK,UAAU,QAAQ,CAAC,MAAM;AAE5B,eACE,EAAE,MAAM,SAASA,UAAS,SAC1B,KAAK,gBAAgB,EAAE,OAAO,OAAO,GACrC;AACA,gBAAM,aAAa,QAAQ,iBAAiB,IAAI,EAAE,MAAM,EAAE;AAC1D,kBAAQ,kBAAkB,IAAI,EAAE,MAAM,IAAI,oBAAI,IAAI,CAAC,UAAU,CAAC,CAAC;AAC/D,YAAE,QAAQ;AACV,YAAE,MAAM,SAAS;AAAA,QACnB;AAAA,MACF,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,EACT;AAAA,EAEA,MAAc,aACZ,MACA,SACA,SACA;AACA,QAAI;AACF,YAAM,SAAS,MAAM,KAAK,YAAY,MAAM,YAAY;AAAA,QACtD;AAAA,QACA,CAACC,YAAW;AACV,eAAK,mBAAmB,MAAM,SAASA,SAAQ,OAAO;AAAA,QACxD;AAAA,MACF;AAGA,cAAQ,gBAAgB,OAAO,KAAK,EAAE;AACtC,WAAK,mBAAmB,MAAM,SAAS,QAAQ,OAAO;AAAA,IACxD,SAAS,GAAY;AACnB,YAAM,QAAQ,aAAa,QAAQ,IAAI,IAAI,MAAM,OAAO,CAAC,CAAC;AAC1D,YAAM,SAAS,KAAK,YAAY,MAAM,iBAAiB,KAAK,OAAO,IAAI;AAEvE,UAAI,WAAW,QAAW;AACxB,cAAM,cAAc,KAAK,YAAY,kBAAkB,GAAG,SAAS;AAEnE,YAAI,aAAa,WAAW,eAAe;AACzC,sBAAY,KAAK,KAAK;AAAA,QACxB;AAEA;AAAA,MACF;AAEA,cAAQ,QAAQ;AAAA,QACd;AAAA,QACA;AAAA,MACF;AAGA,cAAQ,gBAAgB,OAAO,KAAK,EAAE;AACtC,WAAK,mBAAmB,MAAM,SAAS,QAAQ,OAAO;AAAA,IACxD;AAAA,EACF;AAAA,EAEQ,QAAQ,MAA4C;AAC1D,WAAO,MAAM,SAASD,UAAS;AAAA,EACjC;AAAA,EAEQ,kBAAkB,KAAmC;AAC3D,WACE,OAAO,QAAQ,YACf,QAAQ,QACR,OAAO,UAAU,eAAe,KAAK,KAAK,OAAO;AAAA,EAErD;AAAA,EAEA,YAAY,QAAsB;AAChC,WAAO,MAAM,UAAU;AAAA,MACrB,KAAK;AAAA,MACL,CACE,KACA,UACA,SACA,iBACG;AACH,YAAI,KAAK,kBAAkB,GAAG,GAAG;AAE/B,gBAAM,EAAE,OAAO,SAAS,GAAG,KAAK,IAAI;AACpC,gBAAM,cAAc,OAAO,YAAY,MAAM,UAAU,OAAO;AAC9D,gBAAM,eAAe,UAAU,WAAW;AAE1C,cAAI,gBAAgB,QAAQ,CAAC,cAAc;AACzC,mBAAO,eAAe,CAAC,IAAI;AAAA,UAC7B;AAEA,gBAAM,WAAW,OAAO;AAAA,YACtB;AAAA,cACE,IAAI;AAAA,cACJ,MAAMA,UAAS;AAAA,cACf,OAAO;AAAA,cACP;AAAA,YACF;AAAA,YACA;AAAA,UACF;AAEA,cAAI,cAAc;AAChB,mBAAO,WACH;AAAA,cACE;AAAA,gBACE,MAAM,CAAC,GAAG,aAAa,MAAM,aAAa,GAAG;AAAA,gBAC7C,OAAO;AAAA,cACT;AAAA,YACF,IACA,CAAC;AAAA,UACP;AAEA,iBAAO;AAAA,QACT;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,MAA0B;AAC9B,SAAK,MAAM,OAAO,IAAI,SAAS,KAAK,YAAY,KAAK,IAAI,CAAC;AAAA,EAC5D;AAAA,EAEA,YAAY,QAAsB;AAChC,WAAO,MAAM,eAAe,IAAI,SAAS,CAAC,mBAAmB;AAC3D,qBAAe,MAAM,KAAK,IAAI,SAAS,CAAC,SAAS;AAC/C,cAAM,UAA8B;AAAA,UAClC,kBAAkB,oBAAI,IAAI;AAAA,UAC1B,iBAAiB,oBAAI,IAAI;AAAA,UACzB;AAAA,UACA;AAAA,UACA,mBAAmB,oBAAI,IAAI;AAAA,QAC7B;AAEA,aAAK,MAAM,SAAS,IAAI,SAAS,CAAC,aAAa;AAC7C,eAAK,cAAc,UAAU,OAAO;AAAA,QACtC,CAAC;AAAA,MACH,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA,EAEA,YAAY,iBAAwC;AAClD,SAAK,aAAa;AAAA,EACpB;AACF;","names":["NodeType","Builder","NodeType","NodeType","NodeType","NodeType","asyncTransform","Builder","NodeType","result"]}
|
package/package.json
CHANGED
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
"types"
|
|
7
7
|
],
|
|
8
8
|
"name": "@player-ui/async-node-plugin",
|
|
9
|
-
"version": "0.15.0-next.
|
|
9
|
+
"version": "0.15.0-next.6",
|
|
10
10
|
"main": "dist/cjs/index.cjs",
|
|
11
11
|
"peerDependencies": {
|
|
12
|
-
"@player-ui/player": "0.15.0-next.
|
|
12
|
+
"@player-ui/player": "0.15.0-next.6"
|
|
13
13
|
},
|
|
14
14
|
"devDependencies": {
|
|
15
15
|
"@player-ui/check-path-plugin": "workspace:*",
|
|
@@ -181,6 +181,34 @@ describe("view", () => {
|
|
|
181
181
|
},
|
|
182
182
|
};
|
|
183
183
|
|
|
184
|
+
const simpleAsyncMultiNode: Flow = {
|
|
185
|
+
id: "test-flow",
|
|
186
|
+
views: [
|
|
187
|
+
{
|
|
188
|
+
type: "view",
|
|
189
|
+
id: "my-view",
|
|
190
|
+
values: [
|
|
191
|
+
{
|
|
192
|
+
async: true,
|
|
193
|
+
id: "async-values",
|
|
194
|
+
flatten: true,
|
|
195
|
+
},
|
|
196
|
+
],
|
|
197
|
+
},
|
|
198
|
+
],
|
|
199
|
+
navigation: {
|
|
200
|
+
BEGIN: "FLOW_1",
|
|
201
|
+
FLOW_1: {
|
|
202
|
+
startState: "VIEW_1",
|
|
203
|
+
VIEW_1: {
|
|
204
|
+
state_type: "VIEW",
|
|
205
|
+
ref: "my-view",
|
|
206
|
+
transitions: {},
|
|
207
|
+
},
|
|
208
|
+
},
|
|
209
|
+
},
|
|
210
|
+
};
|
|
211
|
+
|
|
184
212
|
const asyncNodeTest = async (resolvedValue: any) => {
|
|
185
213
|
const plugin = new AsyncNodePlugin({
|
|
186
214
|
plugins: [new AsyncNodePluginPlugin()],
|
|
@@ -318,6 +346,121 @@ describe("view", () => {
|
|
|
318
346
|
});
|
|
319
347
|
});
|
|
320
348
|
|
|
349
|
+
test("should update flattened multi-nodes", async () => {
|
|
350
|
+
const plugin = new AsyncNodePlugin({
|
|
351
|
+
plugins: [new AsyncNodePluginPlugin()],
|
|
352
|
+
});
|
|
353
|
+
|
|
354
|
+
let updateFn: ((content: unknown) => void) | undefined;
|
|
355
|
+
const asyncNodeHandler = vi.fn((_, update) => {
|
|
356
|
+
updateFn = update;
|
|
357
|
+
|
|
358
|
+
return new Promise(() => {});
|
|
359
|
+
});
|
|
360
|
+
|
|
361
|
+
plugin.hooks.onAsyncNode.tap("test", asyncNodeHandler);
|
|
362
|
+
const player = new Player({ plugins: [plugin] });
|
|
363
|
+
|
|
364
|
+
player.start(simpleAsyncMultiNode);
|
|
365
|
+
|
|
366
|
+
await waitFor(() => {
|
|
367
|
+
expect(asyncNodeHandler).toHaveBeenCalled();
|
|
368
|
+
expect(updateFn).toBeDefined();
|
|
369
|
+
});
|
|
370
|
+
|
|
371
|
+
// Initial update. Check after that content is flattened
|
|
372
|
+
updateFn?.([
|
|
373
|
+
{
|
|
374
|
+
asset: {
|
|
375
|
+
id: "test-1",
|
|
376
|
+
type: "text",
|
|
377
|
+
value: "Test 1",
|
|
378
|
+
},
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
asset: {
|
|
382
|
+
id: "test-2",
|
|
383
|
+
type: "text",
|
|
384
|
+
value: "Test 2",
|
|
385
|
+
},
|
|
386
|
+
},
|
|
387
|
+
]);
|
|
388
|
+
|
|
389
|
+
await waitFor(() => {
|
|
390
|
+
const playerState = player.getState();
|
|
391
|
+
expect(playerState.status).toBe("in-progress");
|
|
392
|
+
expect(
|
|
393
|
+
(playerState as InProgressState).controllers.view.currentView
|
|
394
|
+
?.lastUpdate,
|
|
395
|
+
).toStrictEqual(
|
|
396
|
+
expect.objectContaining({
|
|
397
|
+
values: [
|
|
398
|
+
{
|
|
399
|
+
asset: {
|
|
400
|
+
id: "test-1",
|
|
401
|
+
type: "text",
|
|
402
|
+
value: "Test 1",
|
|
403
|
+
},
|
|
404
|
+
},
|
|
405
|
+
{
|
|
406
|
+
asset: {
|
|
407
|
+
id: "test-2",
|
|
408
|
+
type: "text",
|
|
409
|
+
value: "Test 2",
|
|
410
|
+
},
|
|
411
|
+
},
|
|
412
|
+
],
|
|
413
|
+
}),
|
|
414
|
+
);
|
|
415
|
+
});
|
|
416
|
+
|
|
417
|
+
// Second update. Check that it is properly updated and flattened.
|
|
418
|
+
updateFn?.([
|
|
419
|
+
{
|
|
420
|
+
asset: {
|
|
421
|
+
id: "test-1",
|
|
422
|
+
type: "text",
|
|
423
|
+
value: "Test 1 (updated)",
|
|
424
|
+
},
|
|
425
|
+
},
|
|
426
|
+
{
|
|
427
|
+
asset: {
|
|
428
|
+
id: "test-2",
|
|
429
|
+
type: "text",
|
|
430
|
+
value: "Test 2 (updated)",
|
|
431
|
+
},
|
|
432
|
+
},
|
|
433
|
+
]);
|
|
434
|
+
|
|
435
|
+
await waitFor(() => {
|
|
436
|
+
const playerState = player.getState();
|
|
437
|
+
expect(playerState.status).toBe("in-progress");
|
|
438
|
+
expect(
|
|
439
|
+
(playerState as InProgressState).controllers.view.currentView
|
|
440
|
+
?.lastUpdate,
|
|
441
|
+
).toStrictEqual(
|
|
442
|
+
expect.objectContaining({
|
|
443
|
+
values: [
|
|
444
|
+
{
|
|
445
|
+
asset: {
|
|
446
|
+
id: "test-1",
|
|
447
|
+
type: "text",
|
|
448
|
+
value: "Test 1 (updated)",
|
|
449
|
+
},
|
|
450
|
+
},
|
|
451
|
+
{
|
|
452
|
+
asset: {
|
|
453
|
+
id: "test-2",
|
|
454
|
+
type: "text",
|
|
455
|
+
value: "Test 2 (updated)",
|
|
456
|
+
},
|
|
457
|
+
},
|
|
458
|
+
],
|
|
459
|
+
}),
|
|
460
|
+
);
|
|
461
|
+
});
|
|
462
|
+
});
|
|
463
|
+
|
|
321
464
|
test("should return current node view when the resolved node is null", async () => {
|
|
322
465
|
await asyncNodeTest(null);
|
|
323
466
|
});
|
package/src/index.ts
CHANGED
|
@@ -10,6 +10,7 @@ import type {
|
|
|
10
10
|
ViewPlugin,
|
|
11
11
|
Resolver,
|
|
12
12
|
Resolve,
|
|
13
|
+
ViewController,
|
|
13
14
|
} from "@player-ui/player";
|
|
14
15
|
import { AsyncSeriesBailHook, SyncBailHook } from "tapable-ts";
|
|
15
16
|
import queueMicrotask from "queue-microtask";
|
|
@@ -23,11 +24,17 @@ export * from "./createAsyncTransform";
|
|
|
23
24
|
*/
|
|
24
25
|
type AsyncPluginContext = {
|
|
25
26
|
/** Map of async node id to resolved content */
|
|
26
|
-
nodeResolveCache: Map<string,
|
|
27
|
+
nodeResolveCache: Map<string, Node.Node>;
|
|
27
28
|
/** The view instance this context is attached to. */
|
|
28
29
|
view: ViewInstance;
|
|
30
|
+
/** The view controller this context is attached to. */
|
|
31
|
+
viewController: ViewController;
|
|
29
32
|
/** Map of async node id to promises being used to resolve them */
|
|
30
33
|
inProgressNodes: Set<string>;
|
|
34
|
+
/** Map of async node ids to the original node they represent.
|
|
35
|
+
* In some cases, async nodes are transformed into from other node types so the original reference is needed in order to trigger an update on the view when the async node changes.
|
|
36
|
+
*/
|
|
37
|
+
originalNodeCache: Map<string, Set<Node.Node>>;
|
|
31
38
|
};
|
|
32
39
|
|
|
33
40
|
export interface AsyncNodePluginOptions {
|
|
@@ -38,6 +45,8 @@ export interface AsyncNodePluginOptions {
|
|
|
38
45
|
export interface AsyncNodeViewPlugin extends ViewPlugin {
|
|
39
46
|
/** Use this to tap into the async node plugin hooks */
|
|
40
47
|
applyPlugin: (asyncNodePlugin: AsyncNodePlugin) => void;
|
|
48
|
+
|
|
49
|
+
applyPlayer?: (player: Player) => void;
|
|
41
50
|
}
|
|
42
51
|
export type AsyncHandler = (
|
|
43
52
|
node: Node.Async,
|
|
@@ -103,6 +112,10 @@ export class AsyncNodePlugin implements PlayerPlugin {
|
|
|
103
112
|
apply(player: Player): void {
|
|
104
113
|
this.playerInstance = player;
|
|
105
114
|
|
|
115
|
+
this.plugins?.forEach((plugin) => {
|
|
116
|
+
plugin.applyPlayer?.(player);
|
|
117
|
+
});
|
|
118
|
+
|
|
106
119
|
player.hooks.viewController.tap(this.name, (viewController) => {
|
|
107
120
|
viewController.hooks.view.tap(this.name, (view) => {
|
|
108
121
|
this.plugins?.forEach((plugin) => {
|
|
@@ -155,10 +168,11 @@ export class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {
|
|
|
155
168
|
context: AsyncPluginContext,
|
|
156
169
|
newNode?: Node.Node | null,
|
|
157
170
|
) {
|
|
158
|
-
const { nodeResolveCache,
|
|
171
|
+
const { nodeResolveCache, viewController, originalNodeCache } = context;
|
|
159
172
|
if (nodeResolveCache.get(node.id) !== newNode) {
|
|
160
173
|
nodeResolveCache.set(node.id, newNode ? newNode : node);
|
|
161
|
-
|
|
174
|
+
const originalNode = originalNodeCache.get(node.id) ?? new Set([node]);
|
|
175
|
+
viewController.updateViewAST(originalNode);
|
|
162
176
|
}
|
|
163
177
|
}
|
|
164
178
|
|
|
@@ -183,13 +197,12 @@ export class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {
|
|
|
183
197
|
if (!this.isAsync(node)) {
|
|
184
198
|
return node === null ? node : this.resolveAsyncChildren(node, context);
|
|
185
199
|
}
|
|
200
|
+
if (options.node) {
|
|
201
|
+
context.originalNodeCache.set(node.id, new Set([options.node]));
|
|
202
|
+
}
|
|
186
203
|
|
|
187
204
|
const resolvedNode = context.nodeResolveCache.get(node.id);
|
|
188
205
|
if (resolvedNode !== undefined) {
|
|
189
|
-
if (resolvedNode.asyncNodesResolved === undefined) {
|
|
190
|
-
resolvedNode.asyncNodesResolved = [];
|
|
191
|
-
}
|
|
192
|
-
resolvedNode.asyncNodesResolved.push(node.id);
|
|
193
206
|
return this.resolveAsyncChildren(resolvedNode, context);
|
|
194
207
|
}
|
|
195
208
|
|
|
@@ -218,8 +231,6 @@ export class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {
|
|
|
218
231
|
node: Node.Node,
|
|
219
232
|
context: AsyncPluginContext,
|
|
220
233
|
): Node.Node {
|
|
221
|
-
const asyncNodesResolved: string[] = node.asyncNodesResolved ?? [];
|
|
222
|
-
node.asyncNodesResolved = asyncNodesResolved;
|
|
223
234
|
if (node.type === NodeType.MultiNode) {
|
|
224
235
|
// Using a while loop lets us catch when async nodes produce more async nodes that need to be flattened further
|
|
225
236
|
let index = 0;
|
|
@@ -233,10 +244,13 @@ export class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {
|
|
|
233
244
|
continue;
|
|
234
245
|
}
|
|
235
246
|
|
|
236
|
-
const mappedNode = context.nodeResolveCache.get(childNode.id)
|
|
237
|
-
|
|
247
|
+
const mappedNode = context.nodeResolveCache.get(childNode.id)!;
|
|
248
|
+
const nodeSet = new Set<Node.Node>();
|
|
238
249
|
if (mappedNode.type === NodeType.MultiNode && childNode.flatten) {
|
|
239
|
-
mappedNode.values.forEach((v: Node.Node) =>
|
|
250
|
+
mappedNode.values.forEach((v: Node.Node) => {
|
|
251
|
+
v.parent = node;
|
|
252
|
+
nodeSet.add(v);
|
|
253
|
+
});
|
|
240
254
|
node.values = [
|
|
241
255
|
...node.values.slice(0, index),
|
|
242
256
|
...mappedNode.values,
|
|
@@ -245,7 +259,9 @@ export class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {
|
|
|
245
259
|
} else {
|
|
246
260
|
node.values[index] = mappedNode;
|
|
247
261
|
mappedNode.parent = node;
|
|
262
|
+
nodeSet.add(mappedNode);
|
|
248
263
|
}
|
|
264
|
+
context.originalNodeCache.set(childNode.id, nodeSet);
|
|
249
265
|
}
|
|
250
266
|
} else if ("children" in node) {
|
|
251
267
|
node.children?.forEach((c) => {
|
|
@@ -254,8 +270,9 @@ export class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {
|
|
|
254
270
|
c.value.type === NodeType.Async &&
|
|
255
271
|
this.hasValidMapping(c.value, context)
|
|
256
272
|
) {
|
|
257
|
-
|
|
258
|
-
|
|
273
|
+
const mappedNode = context.nodeResolveCache.get(c.value.id)!;
|
|
274
|
+
context.originalNodeCache.set(c.value.id, new Set([mappedNode]));
|
|
275
|
+
c.value = mappedNode;
|
|
259
276
|
c.value.parent = node;
|
|
260
277
|
}
|
|
261
278
|
});
|
|
@@ -364,15 +381,24 @@ export class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {
|
|
|
364
381
|
}
|
|
365
382
|
|
|
366
383
|
apply(view: ViewInstance): void {
|
|
367
|
-
const context: AsyncPluginContext = {
|
|
368
|
-
nodeResolveCache: new Map(),
|
|
369
|
-
inProgressNodes: new Set(),
|
|
370
|
-
view,
|
|
371
|
-
};
|
|
372
|
-
|
|
373
384
|
view.hooks.parser.tap("async", this.applyParser.bind(this));
|
|
374
|
-
|
|
375
|
-
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
applyPlayer(player: Player): void {
|
|
388
|
+
player.hooks.viewController.tap("async", (viewController) => {
|
|
389
|
+
viewController.hooks.view.tap("async", (view) => {
|
|
390
|
+
const context: AsyncPluginContext = {
|
|
391
|
+
nodeResolveCache: new Map(),
|
|
392
|
+
inProgressNodes: new Set(),
|
|
393
|
+
view,
|
|
394
|
+
viewController,
|
|
395
|
+
originalNodeCache: new Map(),
|
|
396
|
+
};
|
|
397
|
+
|
|
398
|
+
view.hooks.resolver.tap("async", (resolver) => {
|
|
399
|
+
this.applyResolver(resolver, context);
|
|
400
|
+
});
|
|
401
|
+
});
|
|
376
402
|
});
|
|
377
403
|
}
|
|
378
404
|
|
package/types/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { Player, PlayerPlugin, Node, ViewInstance, Parser, ViewPlugin, Resolver } from "@player-ui/player";
|
|
1
|
+
import type { Player, PlayerPlugin, Node, ViewInstance, Parser, ViewPlugin, Resolver, ViewController } from "@player-ui/player";
|
|
2
2
|
import { AsyncSeriesBailHook, SyncBailHook } from "tapable-ts";
|
|
3
3
|
export * from "./types";
|
|
4
4
|
export * from "./transform";
|
|
@@ -8,11 +8,17 @@ export * from "./createAsyncTransform";
|
|
|
8
8
|
*/
|
|
9
9
|
type AsyncPluginContext = {
|
|
10
10
|
/** Map of async node id to resolved content */
|
|
11
|
-
nodeResolveCache: Map<string,
|
|
11
|
+
nodeResolveCache: Map<string, Node.Node>;
|
|
12
12
|
/** The view instance this context is attached to. */
|
|
13
13
|
view: ViewInstance;
|
|
14
|
+
/** The view controller this context is attached to. */
|
|
15
|
+
viewController: ViewController;
|
|
14
16
|
/** Map of async node id to promises being used to resolve them */
|
|
15
17
|
inProgressNodes: Set<string>;
|
|
18
|
+
/** Map of async node ids to the original node they represent.
|
|
19
|
+
* In some cases, async nodes are transformed into from other node types so the original reference is needed in order to trigger an update on the view when the async node changes.
|
|
20
|
+
*/
|
|
21
|
+
originalNodeCache: Map<string, Set<Node.Node>>;
|
|
16
22
|
};
|
|
17
23
|
export interface AsyncNodePluginOptions {
|
|
18
24
|
/** A set of plugins to load */
|
|
@@ -21,6 +27,7 @@ export interface AsyncNodePluginOptions {
|
|
|
21
27
|
export interface AsyncNodeViewPlugin extends ViewPlugin {
|
|
22
28
|
/** Use this to tap into the async node plugin hooks */
|
|
23
29
|
applyPlugin: (asyncNodePlugin: AsyncNodePlugin) => void;
|
|
30
|
+
applyPlayer?: (player: Player) => void;
|
|
24
31
|
}
|
|
25
32
|
export type AsyncHandler = (node: Node.Async, callback?: (result: any) => void) => Promise<any>;
|
|
26
33
|
export type AsyncContent = {
|
|
@@ -93,6 +100,7 @@ export declare class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {
|
|
|
93
100
|
private isDeterminedAsync;
|
|
94
101
|
applyParser(parser: Parser): void;
|
|
95
102
|
apply(view: ViewInstance): void;
|
|
103
|
+
applyPlayer(player: Player): void;
|
|
96
104
|
applyPlugin(asyncNodePlugin: AsyncNodePlugin): void;
|
|
97
105
|
}
|
|
98
106
|
//# sourceMappingURL=index.d.ts.map
|