@player-ui/async-node-plugin 0.13.0-next.7 → 0.13.1--canary.716.26546
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 +479 -280
- package/dist/AsyncNodePlugin.native.js.map +1 -1
- package/dist/cjs/index.cjs +224 -21
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/index.legacy-esm.js +224 -19
- package/dist/index.mjs +224 -19
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
- package/src/__tests__/__snapshots__/transform.test.ts.snap +1 -0
- package/src/__tests__/createAsyncTransform.test.ts +515 -0
- package/src/__tests__/index.test.ts +94 -13
- package/src/__tests__/transform.bench.ts +177 -0
- package/src/createAsyncTransform.ts +110 -0
- package/src/index.ts +95 -19
- package/src/transform.ts +5 -2
- package/src/types.ts +1 -0
- package/src/utils/__tests__/extractNodeFromPath.test.ts +181 -0
- package/src/utils/__tests__/requiresAssetWrapper.test.ts +63 -0
- package/src/utils/__tests__/traverseAndReplace.test.ts +182 -0
- package/src/utils/__tests__/unwrapAsset.test.ts +65 -0
- package/src/utils/extractNodeFromPath.ts +56 -0
- package/src/utils/index.ts +4 -0
- package/src/utils/requiresAssetWrapper.ts +14 -0
- package/src/utils/traverseAndReplace.ts +34 -0
- package/src/utils/unwrapAsset.ts +16 -0
- package/types/createAsyncTransform.d.ts +26 -0
- package/types/index.d.ts +16 -6
- package/types/transform.d.ts +2 -1
- package/types/types.d.ts +1 -1
- package/types/utils/extractNodeFromPath.d.ts +4 -0
- package/types/utils/index.d.ts +5 -0
- package/types/utils/requiresAssetWrapper.d.ts +3 -0
- package/types/utils/traverseAndReplace.d.ts +4 -0
- package/types/utils/unwrapAsset.d.ts +3 -0
package/types/transform.d.ts
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import type { AsyncTransformFunc } from "./types";
|
|
2
2
|
/**
|
|
3
|
+
* @deprecated Use {@link createAsyncTransform} to create your before transform function.
|
|
3
4
|
* Util function to generate transform function for async asset
|
|
4
5
|
* @param asset - async asset to apply beforeResolve transform
|
|
5
|
-
* @param transformedAssetType: transformed asset type for rendering
|
|
6
6
|
* @param wrapperAssetType: container asset type
|
|
7
7
|
* @param flatten: flatten the streamed in content
|
|
8
|
+
* @param path: property path to add the multinode containing the next async node to
|
|
8
9
|
* @returns - wrapper asset with children of transformed asset and async node
|
|
9
10
|
*/
|
|
10
11
|
export declare const asyncTransform: AsyncTransformFunc;
|
package/types/types.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import type { Node } from "@player-ui/player";
|
|
2
2
|
export type AsyncNodeHandler = (node: Node.Node, update: (object: any) => void) => void;
|
|
3
|
-
export type AsyncTransformFunc = (id: string, wrapperAssetType: string, asset?: Node.Node, flatten?: boolean) => Node.Asset;
|
|
3
|
+
export type AsyncTransformFunc = (id: string, wrapperAssetType: string, asset?: Node.Node, flatten?: boolean, path?: string[]) => Node.Asset;
|
|
4
4
|
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { Node } from "@player-ui/player";
|
|
2
|
+
/** Follows the given path and returns the node. If there is no match, returns undefined */
|
|
3
|
+
export declare const extractNodeFromPath: (node: Node.Node, path?: string[]) => Node.Node | undefined;
|
|
4
|
+
//# sourceMappingURL=extractNodeFromPath.d.ts.map
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Node } from "@player-ui/player";
|
|
2
|
+
/** Replaces a node using the given replace function. If the node is a multi-node it does this transformation to all of its values. */
|
|
3
|
+
export declare const traverseAndReplace: (node: Node.Node, replaceFn: (node: Node.Node) => Node.Node) => Node.Node;
|
|
4
|
+
//# sourceMappingURL=traverseAndReplace.d.ts.map
|