@devtools-ui/collection 0.4.0 → 0.4.1-next.0

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/README.md ADDED
@@ -0,0 +1,86 @@
1
+ # @devtools-ui/collection
2
+
3
+ ## Overview
4
+
5
+ `@devtools-ui/collection` is a component package designed to be leveraged by a [Player-UI assets plugin](https://player-ui.github.io/next/plugins).
6
+
7
+ It provides a `Collection` component that can be used to group other Player assets into a stacked layout.
8
+
9
+ ## Installation
10
+
11
+ To install `@devtools-ui/collection`, you can use pnpm or yarn:
12
+
13
+ ```sh
14
+ pnpm i @devtools-ui/collection
15
+ ```
16
+
17
+ or
18
+
19
+ ```sh
20
+ yarn add @devtools-ui/collection
21
+ ```
22
+
23
+ ## Usage
24
+
25
+ You can leverage this asset through the `@devtools-ui/plugin`:
26
+
27
+ ```ts
28
+ import { Collection } from "@devtools-ui/plugin";
29
+
30
+ // and use it to define your Player-UI content:
31
+ myFlow = {
32
+ id: "my_flow",
33
+ views: [
34
+ <MyView>
35
+ <Collection>
36
+ <Collection.Values>
37
+ <Asset type="text">
38
+ <property name="value">Test 1</property>
39
+ </Asset>
40
+ <Asset type="text">
41
+ <property name="value">Test 2</property>
42
+ </Asset>
43
+ </Collection.Values>
44
+ </Collection>
45
+ </MyView>,
46
+ ],
47
+ };
48
+ ```
49
+
50
+ For more information on how to author Player-UI content using DSL, please check our [Player-UI docs](https://player-ui.github.io/next/dsl#tsxjsx-content-authoring-player-dsl).
51
+
52
+ Or, your can leverage this asset in your own plugin:
53
+
54
+ ```ts
55
+ // AssetRegistryPlugin.ts
56
+ import React from "react";
57
+ import type { Player } from "@player-ui/player";
58
+ import type {
59
+ ExtendedPlayerPlugin,
60
+ ReactPlayer,
61
+ ReactPlayerPlugin,
62
+ } from "@player-ui/react";
63
+ import { AssetProviderPlugin } from "@player-ui/asset-provider-plugin-react";
64
+ import { TransformsPlugin } from "./TransformPlugin";
65
+ import { CollectionAsset, CollectionComponent } from "@devtools-ui/collection";
66
+
67
+ export class AssetsRegistryPlugin
68
+ implements ReactPlayerPlugin, ExtendedPlayerPlugin<[CollectionAsset]>
69
+ {
70
+ name = "my-plugin";
71
+
72
+ applyReact(reactPlayer: ReactPlayer) {
73
+ reactPlayer.registerPlugin(
74
+ new AssetProviderPlugin([["collection", CollectionComponent]])
75
+ );
76
+ }
77
+
78
+ apply(player: Player) {
79
+ player.registerPlugin(new TransformsPlugin());
80
+ }
81
+ }
82
+ ```
83
+
84
+ ## Contributing
85
+
86
+ We welcome contributions to `@devtools-ui/collection`!
@@ -45,16 +45,16 @@ var CollectionComponent = (props) => {
45
45
 
46
46
  // ../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/collection/src/dsl/Collection.tsx
47
47
  var import_react4 = __toESM(require("react"));
48
- var import_dsl = require("@player-tools/dsl");
48
+ var import_react_dsl = require("@player-lang/react-dsl");
49
49
  var import_text = require("@devtools-ui/text");
50
50
  var Collection = (props) => {
51
51
  const { children, ...rest } = props;
52
- return /* @__PURE__ */ import_react4.default.createElement(import_dsl.Asset, { type: "collection", ...rest }, children);
52
+ return /* @__PURE__ */ import_react4.default.createElement(import_react_dsl.Asset, { type: "collection", ...rest }, children);
53
53
  };
54
54
  var CollectionComp = (props) => {
55
55
  return /* @__PURE__ */ import_react4.default.createElement(Collection, null, /* @__PURE__ */ import_react4.default.createElement(Collection.Values, null, props.children));
56
56
  };
57
- Collection.Values = (0, import_dsl.createSlot)({
57
+ Collection.Values = (0, import_react_dsl.createSlot)({
58
58
  name: "values",
59
59
  TextComp: import_text.Text,
60
60
  CollectionComp,
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/collection/src/index.ts","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/collection/src/components/CollectionComponent.tsx","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/collection/src/dsl/Collection.tsx"],"sourcesContent":["export * from \"./types\";\nexport * from \"./components\";\nexport * from \"./dsl\";\n","import React from \"react\";\nimport { Flex } from \"@chakra-ui/react\";\nimport { ReactAsset } from \"@player-ui/react\";\nimport { CollectionAsset } from \"../types\";\n\nexport const CollectionComponent = (props: CollectionAsset) => {\n return (\n <Flex direction=\"column\" gap=\"5\">\n {props.values?.map((a) => (\n <ReactAsset key={a.asset.id} {...a} />\n ))}\n </Flex>\n );\n};\n","import React from \"react\";\nimport { AssetPropsWithChildren, Asset, createSlot } from \"@player-tools/dsl\";\nimport type { Asset as AssetType } from \"@player-ui/player\";\nimport { CollectionAsset } from \"../types\";\nimport { Text } from \"@devtools-ui/text\";\n\nexport const Collection = (props: AssetPropsWithChildren<CollectionAsset>) => {\n const { children, ...rest } = props;\n return (\n <Asset type=\"collection\" {...rest}>\n {children}\n </Asset>\n );\n};\n\nconst CollectionComp = (props: AssetPropsWithChildren<AssetType>) => {\n return (\n <Collection>\n <Collection.Values>{props.children}</Collection.Values>\n </Collection>\n );\n};\n\nCollection.Values = createSlot({\n name: \"values\",\n TextComp: Text,\n CollectionComp,\n isArray: true,\n wrapInAsset: true,\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAkB;AAClB,IAAAA,gBAAqB;AACrB,IAAAA,gBAA2B;AAGpB,IAAM,sBAAsB,CAAC,UAA2B;AAC7D,SACE,6BAAAC,QAAA,cAAC,sBAAK,WAAU,UAAS,KAAI,OAC1B,MAAM,QAAQ,IAAI,CAAC,MAClB,6BAAAA,QAAA,cAAC,4BAAW,KAAK,EAAE,MAAM,IAAK,GAAG,GAAG,CACrC,CACH;AAEJ;;;ACbA,IAAAC,gBAAkB;AAClB,iBAA0D;AAG1D,kBAAqB;AAEd,IAAM,aAAa,CAAC,UAAmD;AAC5E,QAAM,EAAE,UAAU,GAAG,KAAK,IAAI;AAC9B,SACE,8BAAAC,QAAA,cAAC,oBAAM,MAAK,cAAc,GAAG,QAC1B,QACH;AAEJ;AAEA,IAAM,iBAAiB,CAAC,UAA6C;AACnE,SACE,8BAAAA,QAAA,cAAC,kBACC,8BAAAA,QAAA,cAAC,WAAW,QAAX,MAAmB,MAAM,QAAS,CACrC;AAEJ;AAEA,WAAW,aAAS,uBAAW;AAAA,EAC7B,MAAM;AAAA,EACN,UAAU;AAAA,EACV;AAAA,EACA,SAAS;AAAA,EACT,aAAa;AACf,CAAC;","names":["import_react","React","import_react","React"]}
1
+ {"version":3,"sources":["../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/collection/src/index.ts","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/collection/src/components/CollectionComponent.tsx","../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/collection/src/dsl/Collection.tsx"],"sourcesContent":["export * from \"./types\";\nexport * from \"./components\";\nexport * from \"./dsl\";\n","import React from \"react\";\nimport { Flex } from \"@chakra-ui/react\";\nimport { ReactAsset } from \"@player-ui/react\";\nimport { CollectionAsset } from \"../types\";\n\nexport const CollectionComponent = (props: CollectionAsset) => {\n return (\n <Flex direction=\"column\" gap=\"5\">\n {props.values?.map((a) => (\n <ReactAsset key={a.asset.id} {...a} />\n ))}\n </Flex>\n );\n};\n","import React from \"react\";\nimport {\n AssetPropsWithChildren,\n Asset,\n createSlot,\n} from \"@player-lang/react-dsl\";\nimport type { Asset as AssetType } from \"@player-ui/player\";\nimport { CollectionAsset } from \"../types\";\nimport { Text } from \"@devtools-ui/text\";\n\nexport const Collection = (props: AssetPropsWithChildren<CollectionAsset>) => {\n const { children, ...rest } = props;\n return (\n <Asset type=\"collection\" {...rest}>\n {children}\n </Asset>\n );\n};\n\nconst CollectionComp = (props: AssetPropsWithChildren<AssetType>) => {\n return (\n <Collection>\n <Collection.Values>{props.children}</Collection.Values>\n </Collection>\n );\n};\n\nCollection.Values = createSlot({\n name: \"values\",\n TextComp: Text,\n CollectionComp,\n isArray: true,\n wrapInAsset: true,\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAkB;AAClB,IAAAA,gBAAqB;AACrB,IAAAA,gBAA2B;AAGpB,IAAM,sBAAsB,CAAC,UAA2B;AAC7D,SACE,6BAAAC,QAAA,cAAC,sBAAK,WAAU,UAAS,KAAI,OAC1B,MAAM,QAAQ,IAAI,CAAC,MAClB,6BAAAA,QAAA,cAAC,4BAAW,KAAK,EAAE,MAAM,IAAK,GAAG,GAAG,CACrC,CACH;AAEJ;;;ACbA,IAAAC,gBAAkB;AAClB,uBAIO;AAGP,kBAAqB;AAEd,IAAM,aAAa,CAAC,UAAmD;AAC5E,QAAM,EAAE,UAAU,GAAG,KAAK,IAAI;AAC9B,SACE,8BAAAC,QAAA,cAAC,0BAAM,MAAK,cAAc,GAAG,QAC1B,QACH;AAEJ;AAEA,IAAM,iBAAiB,CAAC,UAA6C;AACnE,SACE,8BAAAA,QAAA,cAAC,kBACC,8BAAAA,QAAA,cAAC,WAAW,QAAX,MAAmB,MAAM,QAAS,CACrC;AAEJ;AAEA,WAAW,aAAS,6BAAW;AAAA,EAC7B,MAAM;AAAA,EACN,UAAU;AAAA,EACV;AAAA,EACA,SAAS;AAAA,EACT,aAAa;AACf,CAAC;","names":["import_react","React","import_react","React"]}
@@ -8,7 +8,10 @@ var CollectionComponent = (props) => {
8
8
 
9
9
  // ../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/collection/src/dsl/Collection.tsx
10
10
  import React2 from "react";
11
- import { Asset, createSlot } from "@player-tools/dsl";
11
+ import {
12
+ Asset,
13
+ createSlot
14
+ } from "@player-lang/react-dsl";
12
15
  import { Text } from "@devtools-ui/text";
13
16
  var Collection = (props) => {
14
17
  const { children, ...rest } = props;
package/dist/index.mjs CHANGED
@@ -8,7 +8,10 @@ var CollectionComponent = (props) => {
8
8
 
9
9
  // ../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/collection/src/dsl/Collection.tsx
10
10
  import React2 from "react";
11
- import { Asset, createSlot } from "@player-tools/dsl";
11
+ import {
12
+ Asset,
13
+ createSlot
14
+ } from "@player-lang/react-dsl";
12
15
  import { Text } from "@devtools-ui/text";
13
16
  var Collection = (props) => {
14
17
  const { children, ...rest } = props;
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/collection/src/components/CollectionComponent.tsx","../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/collection/src/dsl/Collection.tsx"],"sourcesContent":["import React from \"react\";\nimport { Flex } from \"@chakra-ui/react\";\nimport { ReactAsset } from \"@player-ui/react\";\nimport { CollectionAsset } from \"../types\";\n\nexport const CollectionComponent = (props: CollectionAsset) => {\n return (\n <Flex direction=\"column\" gap=\"5\">\n {props.values?.map((a) => (\n <ReactAsset key={a.asset.id} {...a} />\n ))}\n </Flex>\n );\n};\n","import React from \"react\";\nimport { AssetPropsWithChildren, Asset, createSlot } from \"@player-tools/dsl\";\nimport type { Asset as AssetType } from \"@player-ui/player\";\nimport { CollectionAsset } from \"../types\";\nimport { Text } from \"@devtools-ui/text\";\n\nexport const Collection = (props: AssetPropsWithChildren<CollectionAsset>) => {\n const { children, ...rest } = props;\n return (\n <Asset type=\"collection\" {...rest}>\n {children}\n </Asset>\n );\n};\n\nconst CollectionComp = (props: AssetPropsWithChildren<AssetType>) => {\n return (\n <Collection>\n <Collection.Values>{props.children}</Collection.Values>\n </Collection>\n );\n};\n\nCollection.Values = createSlot({\n name: \"values\",\n TextComp: Text,\n CollectionComp,\n isArray: true,\n wrapInAsset: true,\n});\n"],"mappings":";AAAA,OAAO,WAAW;AAClB,SAAS,YAAY;AACrB,SAAS,kBAAkB;AAGpB,IAAM,sBAAsB,CAAC,UAA2B;AAC7D,SACE,oCAAC,QAAK,WAAU,UAAS,KAAI,OAC1B,MAAM,QAAQ,IAAI,CAAC,MAClB,oCAAC,cAAW,KAAK,EAAE,MAAM,IAAK,GAAG,GAAG,CACrC,CACH;AAEJ;;;ACbA,OAAOA,YAAW;AAClB,SAAiC,OAAO,kBAAkB;AAG1D,SAAS,YAAY;AAEd,IAAM,aAAa,CAAC,UAAmD;AAC5E,QAAM,EAAE,UAAU,GAAG,KAAK,IAAI;AAC9B,SACE,gBAAAA,OAAA,cAAC,SAAM,MAAK,cAAc,GAAG,QAC1B,QACH;AAEJ;AAEA,IAAM,iBAAiB,CAAC,UAA6C;AACnE,SACE,gBAAAA,OAAA,cAAC,kBACC,gBAAAA,OAAA,cAAC,WAAW,QAAX,MAAmB,MAAM,QAAS,CACrC;AAEJ;AAEA,WAAW,SAAS,WAAW;AAAA,EAC7B,MAAM;AAAA,EACN,UAAU;AAAA,EACV;AAAA,EACA,SAAS;AAAA,EACT,aAAa;AACf,CAAC;","names":["React"]}
1
+ {"version":3,"sources":["../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/collection/src/components/CollectionComponent.tsx","../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/collection/src/dsl/Collection.tsx"],"sourcesContent":["import React from \"react\";\nimport { Flex } from \"@chakra-ui/react\";\nimport { ReactAsset } from \"@player-ui/react\";\nimport { CollectionAsset } from \"../types\";\n\nexport const CollectionComponent = (props: CollectionAsset) => {\n return (\n <Flex direction=\"column\" gap=\"5\">\n {props.values?.map((a) => (\n <ReactAsset key={a.asset.id} {...a} />\n ))}\n </Flex>\n );\n};\n","import React from \"react\";\nimport {\n AssetPropsWithChildren,\n Asset,\n createSlot,\n} from \"@player-lang/react-dsl\";\nimport type { Asset as AssetType } from \"@player-ui/player\";\nimport { CollectionAsset } from \"../types\";\nimport { Text } from \"@devtools-ui/text\";\n\nexport const Collection = (props: AssetPropsWithChildren<CollectionAsset>) => {\n const { children, ...rest } = props;\n return (\n <Asset type=\"collection\" {...rest}>\n {children}\n </Asset>\n );\n};\n\nconst CollectionComp = (props: AssetPropsWithChildren<AssetType>) => {\n return (\n <Collection>\n <Collection.Values>{props.children}</Collection.Values>\n </Collection>\n );\n};\n\nCollection.Values = createSlot({\n name: \"values\",\n TextComp: Text,\n CollectionComp,\n isArray: true,\n wrapInAsset: true,\n});\n"],"mappings":";AAAA,OAAO,WAAW;AAClB,SAAS,YAAY;AACrB,SAAS,kBAAkB;AAGpB,IAAM,sBAAsB,CAAC,UAA2B;AAC7D,SACE,oCAAC,QAAK,WAAU,UAAS,KAAI,OAC1B,MAAM,QAAQ,IAAI,CAAC,MAClB,oCAAC,cAAW,KAAK,EAAE,MAAM,IAAK,GAAG,GAAG,CACrC,CACH;AAEJ;;;ACbA,OAAOA,YAAW;AAClB;AAAA,EAEE;AAAA,EACA;AAAA,OACK;AAGP,SAAS,YAAY;AAEd,IAAM,aAAa,CAAC,UAAmD;AAC5E,QAAM,EAAE,UAAU,GAAG,KAAK,IAAI;AAC9B,SACE,gBAAAA,OAAA,cAAC,SAAM,MAAK,cAAc,GAAG,QAC1B,QACH;AAEJ;AAEA,IAAM,iBAAiB,CAAC,UAA6C;AACnE,SACE,gBAAAA,OAAA,cAAC,kBACC,gBAAAA,OAAA,cAAC,WAAW,QAAX,MAAmB,MAAM,QAAS,CACrC;AAEJ;AAEA,WAAW,SAAS,WAAW;AAAA,EAC7B,MAAM;AAAA,EACN,UAAU;AAAA,EACV;AAAA,EACA,SAAS;AAAA,EACT,aAAa;AACf,CAAC;","names":["React"]}
package/package.json CHANGED
@@ -1,9 +1,15 @@
1
1
  {
2
+ "sideEffects": false,
3
+ "files": [
4
+ "dist",
5
+ "src",
6
+ "types"
7
+ ],
2
8
  "name": "@devtools-ui/collection",
3
- "version": "0.4.0",
9
+ "version": "0.4.1-next.0",
4
10
  "main": "dist/cjs/index.cjs",
5
11
  "dependencies": {
6
- "@devtools-ui/text": "0.4.0",
12
+ "@devtools-ui/text": "0.4.1-next.0",
7
13
  "@chakra-ui/react": "^2.8.2",
8
14
  "@emotion/react": "^11.11.4",
9
15
  "@emotion/styled": "^11.11.0",
@@ -15,7 +21,6 @@
15
21
  },
16
22
  "module": "dist/index.legacy-esm.js",
17
23
  "types": "types/index.d.ts",
18
- "sideEffects": false,
19
24
  "exports": {
20
25
  "./package.json": "./package.json",
21
26
  "./dist/index.css": "./dist/index.css",
@@ -25,15 +30,10 @@
25
30
  "default": "./dist/cjs/index.cjs"
26
31
  }
27
32
  },
28
- "files": [
29
- "dist",
30
- "src",
31
- "types"
32
- ],
33
33
  "peerDependencies": {
34
- "@player-ui/player": "0.9.1-next.0",
35
- "@player-tools/dsl": "0.7.0-next.3",
36
- "@player-ui/types": "0.9.1-next.0",
37
- "@player-ui/react": "0.9.1-next.0"
34
+ "@player-ui/player": "0.15.5",
35
+ "@player-lang/react-dsl": "1.0.1",
36
+ "@player-ui/types": "0.15.5",
37
+ "@player-ui/react": "0.15.5"
38
38
  }
39
39
  }
@@ -1,5 +1,9 @@
1
1
  import React from "react";
2
- import { AssetPropsWithChildren, Asset, createSlot } from "@player-tools/dsl";
2
+ import {
3
+ AssetPropsWithChildren,
4
+ Asset,
5
+ createSlot,
6
+ } from "@player-lang/react-dsl";
3
7
  import type { Asset as AssetType } from "@player-ui/player";
4
8
  import { CollectionAsset } from "../types";
5
9
  import { Text } from "@devtools-ui/text";
@@ -1,6 +1,6 @@
1
1
  import React from "react";
2
2
  import { describe, expect, test } from "vitest";
3
- import { Asset, render } from "@player-tools/dsl";
3
+ import { Asset, render } from "@player-lang/react-dsl";
4
4
  import { Collection } from "../Collection";
5
5
 
6
6
  describe("DSL: Collection", () => {
@@ -1,5 +1,5 @@
1
1
  import React from "react";
2
- import { AssetPropsWithChildren } from "@player-tools/dsl";
2
+ import { AssetPropsWithChildren } from "@player-lang/react-dsl";
3
3
  import { CollectionAsset } from "../types";
4
4
  export declare const Collection: {
5
5
  (props: AssetPropsWithChildren<CollectionAsset>): React.JSX.Element;