@player-ui/types 0.4.0-next.5 → 0.4.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.
Files changed (36) hide show
  1. package/dist/index.d.ts +16 -3
  2. package/dist/xlr/Asset.json +40 -0
  3. package/dist/xlr/AssetBinding.json +23 -0
  4. package/dist/xlr/AssetSwitch.json +213 -0
  5. package/dist/xlr/AssetWrapper.json +34 -0
  6. package/dist/xlr/AssetWrapperOrSwitch.json +304 -0
  7. package/dist/xlr/Binding.json +7 -0
  8. package/dist/xlr/BindingRef.json +7 -0
  9. package/dist/xlr/DataModel.json +13 -0
  10. package/dist/xlr/DynamicSwitch.json +96 -0
  11. package/dist/xlr/Expression.json +21 -0
  12. package/dist/xlr/ExpressionObject.json +19 -0
  13. package/dist/xlr/ExpressionRef.json +7 -0
  14. package/dist/xlr/Flow.json +2145 -0
  15. package/dist/xlr/FlowResult.json +131 -0
  16. package/dist/xlr/Navigation.json +783 -0
  17. package/dist/xlr/NavigationBaseState.json +133 -0
  18. package/dist/xlr/NavigationFlow.json +746 -0
  19. package/dist/xlr/NavigationFlowActionState.json +120 -0
  20. package/dist/xlr/NavigationFlowEndState.json +110 -0
  21. package/dist/xlr/NavigationFlowExternalState.json +126 -0
  22. package/dist/xlr/NavigationFlowFlowState.json +125 -0
  23. package/dist/xlr/NavigationFlowState.json +627 -0
  24. package/dist/xlr/NavigationFlowTransition.json +12 -0
  25. package/dist/xlr/NavigationFlowTransitionableState.json +149 -0
  26. package/dist/xlr/NavigationFlowViewState.json +138 -0
  27. package/dist/xlr/StaticSwitch.json +96 -0
  28. package/dist/xlr/Switch.json +71 -0
  29. package/dist/xlr/SwitchCase.json +51 -0
  30. package/dist/xlr/Templatable.json +83 -0
  31. package/dist/xlr/Template.json +65 -0
  32. package/dist/xlr/View.json +166 -0
  33. package/dist/xlr/manifest.js +38 -0
  34. package/dist/xlr/manifest.json +38 -0
  35. package/package.json +1 -1
  36. package/src/index.ts +20 -4
package/dist/index.d.ts CHANGED
@@ -203,14 +203,13 @@ declare namespace Schema {
203
203
  /** A Node describes a specific object in the tree */
204
204
  interface Node {
205
205
  /** Each property describes a property of the object */
206
- [key: string]: DataType;
206
+ [key: string]: DataTypes;
207
207
  }
208
+ type DataTypes = DataType | RecordType | ArrayType;
208
209
  /** Each prop in the object can have a specific DataType */
209
210
  interface DataType<T = unknown> {
210
211
  /** The reference of the base type to use */
211
212
  type: string;
212
- /** The referenced object represents an array rather than an object */
213
- isArray?: boolean;
214
213
  /**
215
214
  * Any additional validations that are associated with this property
216
215
  * These will add to any base validations associated with the "type"
@@ -229,6 +228,20 @@ declare namespace Schema {
229
228
  /** Any additional options */
230
229
  [key: string]: unknown;
231
230
  }
231
+ /** Determines if the Datatype is a record object */
232
+ interface RecordType extends DataType {
233
+ /** boolean to define if its a record */
234
+ isRecord: boolean;
235
+ /** This property is mutually exclusive with RecordType and can not be used with ArrayType */
236
+ isArray?: never;
237
+ }
238
+ /** Determines if the DataType is an Array Object */
239
+ interface ArrayType extends DataType {
240
+ /** boolean to define if its an array */
241
+ isArray: boolean;
242
+ /** This property is mutually exclusive with ArrayType and can not be used with RecordType */
243
+ isRecord?: never;
244
+ }
232
245
  }
233
246
  /** Namespace to wrap up core functionality to be used by the Language Service */
234
247
  declare namespace Language {
@@ -0,0 +1,40 @@
1
+ {
2
+ "source": "core/types/src/index.ts",
3
+ "name": "Asset",
4
+ "type": "object",
5
+ "properties": {
6
+ "id": {
7
+ "required": true,
8
+ "node": {
9
+ "type": "string",
10
+ "title": "Asset.id",
11
+ "description": "Each asset requires a unique id per view"
12
+ }
13
+ },
14
+ "type": {
15
+ "required": true,
16
+ "node": {
17
+ "type": "ref",
18
+ "ref": "T",
19
+ "title": "Asset.type",
20
+ "description": "The asset type determines the semantics of how a user interacts with a page"
21
+ }
22
+ }
23
+ },
24
+ "additionalProperties": {
25
+ "type": "unknown"
26
+ },
27
+ "title": "Asset",
28
+ "description": "An asset is the smallest unit of user interaction in a player view",
29
+ "genericTokens": [
30
+ {
31
+ "symbol": "T",
32
+ "constraints": {
33
+ "type": "string"
34
+ },
35
+ "default": {
36
+ "type": "string"
37
+ }
38
+ }
39
+ ]
40
+ }
@@ -0,0 +1,23 @@
1
+ {
2
+ "source": "core/types/src/index.ts",
3
+ "name": "AssetBinding",
4
+ "type": "object",
5
+ "properties": {
6
+ "binding": {
7
+ "required": true,
8
+ "node": {
9
+ "type": "ref",
10
+ "ref": "Binding",
11
+ "title": "AssetBinding.binding",
12
+ "description": "A binding that points to somewhere in the data model"
13
+ }
14
+ }
15
+ },
16
+ "additionalProperties": false,
17
+ "title": "AssetBinding",
18
+ "description": "An asset that contains a Binding.",
19
+ "extends": {
20
+ "type": "ref",
21
+ "ref": "Asset"
22
+ }
23
+ }
@@ -0,0 +1,213 @@
1
+ {
2
+ "source": "core/types/src/index.ts",
3
+ "name": "AssetSwitch",
4
+ "type": "or",
5
+ "or": [
6
+ {
7
+ "source": "core/types/src/index.ts",
8
+ "name": "StaticSwitch",
9
+ "type": "object",
10
+ "properties": {
11
+ "staticSwitch": {
12
+ "required": true,
13
+ "node": {
14
+ "source": "core/types/src/index.ts",
15
+ "name": "Switch",
16
+ "type": "array",
17
+ "elementType": {
18
+ "source": "core/types/src/index.ts",
19
+ "name": "SwitchCase",
20
+ "type": "object",
21
+ "properties": {
22
+ "asset": {
23
+ "required": true,
24
+ "node": {
25
+ "type": "ref",
26
+ "ref": "T",
27
+ "title": "SwitchCase.asset",
28
+ "description": "The Asset to use if this case is applicable"
29
+ }
30
+ },
31
+ "case": {
32
+ "required": true,
33
+ "node": {
34
+ "type": "or",
35
+ "or": [
36
+ {
37
+ "type": "ref",
38
+ "ref": "Expression",
39
+ "title": "SwitchCase.case"
40
+ },
41
+ {
42
+ "type": "boolean",
43
+ "const": true
44
+ }
45
+ ],
46
+ "title": "SwitchCase.case",
47
+ "description": "An expression to execute to determine if this case applies"
48
+ }
49
+ }
50
+ },
51
+ "additionalProperties": false,
52
+ "title": "SwitchCase",
53
+ "description": "A single case statement to use in a switch",
54
+ "genericTokens": [
55
+ {
56
+ "symbol": "T",
57
+ "constraints": {
58
+ "type": "ref",
59
+ "ref": "Asset"
60
+ },
61
+ "default": {
62
+ "type": "ref",
63
+ "ref": "Asset"
64
+ }
65
+ }
66
+ ]
67
+ },
68
+ "title": "StaticSwitch.staticSwitch",
69
+ "description": "A static switch only evaluates the applicable base on first render of the view",
70
+ "genericTokens": [
71
+ {
72
+ "symbol": "T",
73
+ "constraints": {
74
+ "type": "ref",
75
+ "ref": "Asset"
76
+ },
77
+ "default": {
78
+ "type": "ref",
79
+ "ref": "Asset"
80
+ }
81
+ }
82
+ ]
83
+ }
84
+ }
85
+ },
86
+ "additionalProperties": false,
87
+ "title": "StaticSwitch",
88
+ "genericTokens": [
89
+ {
90
+ "symbol": "T",
91
+ "constraints": {
92
+ "type": "ref",
93
+ "ref": "Asset"
94
+ },
95
+ "default": {
96
+ "type": "ref",
97
+ "ref": "Asset"
98
+ }
99
+ }
100
+ ]
101
+ },
102
+ {
103
+ "source": "core/types/src/index.ts",
104
+ "name": "DynamicSwitch",
105
+ "type": "object",
106
+ "properties": {
107
+ "dynamicSwitch": {
108
+ "required": true,
109
+ "node": {
110
+ "source": "core/types/src/index.ts",
111
+ "name": "Switch",
112
+ "type": "array",
113
+ "elementType": {
114
+ "source": "core/types/src/index.ts",
115
+ "name": "SwitchCase",
116
+ "type": "object",
117
+ "properties": {
118
+ "asset": {
119
+ "required": true,
120
+ "node": {
121
+ "type": "ref",
122
+ "ref": "T",
123
+ "title": "SwitchCase.asset",
124
+ "description": "The Asset to use if this case is applicable"
125
+ }
126
+ },
127
+ "case": {
128
+ "required": true,
129
+ "node": {
130
+ "type": "or",
131
+ "or": [
132
+ {
133
+ "type": "ref",
134
+ "ref": "Expression",
135
+ "title": "SwitchCase.case"
136
+ },
137
+ {
138
+ "type": "boolean",
139
+ "const": true
140
+ }
141
+ ],
142
+ "title": "SwitchCase.case",
143
+ "description": "An expression to execute to determine if this case applies"
144
+ }
145
+ }
146
+ },
147
+ "additionalProperties": false,
148
+ "title": "SwitchCase",
149
+ "description": "A single case statement to use in a switch",
150
+ "genericTokens": [
151
+ {
152
+ "symbol": "T",
153
+ "constraints": {
154
+ "type": "ref",
155
+ "ref": "Asset"
156
+ },
157
+ "default": {
158
+ "type": "ref",
159
+ "ref": "Asset"
160
+ }
161
+ }
162
+ ]
163
+ },
164
+ "title": "DynamicSwitch.dynamicSwitch",
165
+ "description": "A dynamic switch re-evaluates the applicable case as data changes",
166
+ "genericTokens": [
167
+ {
168
+ "symbol": "T",
169
+ "constraints": {
170
+ "type": "ref",
171
+ "ref": "Asset"
172
+ },
173
+ "default": {
174
+ "type": "ref",
175
+ "ref": "Asset"
176
+ }
177
+ }
178
+ ]
179
+ }
180
+ }
181
+ },
182
+ "additionalProperties": false,
183
+ "title": "DynamicSwitch",
184
+ "genericTokens": [
185
+ {
186
+ "symbol": "T",
187
+ "constraints": {
188
+ "type": "ref",
189
+ "ref": "Asset"
190
+ },
191
+ "default": {
192
+ "type": "ref",
193
+ "ref": "Asset"
194
+ }
195
+ }
196
+ ]
197
+ }
198
+ ],
199
+ "title": "AssetSwitch",
200
+ "genericTokens": [
201
+ {
202
+ "symbol": "T",
203
+ "constraints": {
204
+ "type": "ref",
205
+ "ref": "Asset"
206
+ },
207
+ "default": {
208
+ "type": "ref",
209
+ "ref": "Asset"
210
+ }
211
+ }
212
+ ]
213
+ }
@@ -0,0 +1,34 @@
1
+ {
2
+ "source": "core/types/src/index.ts",
3
+ "name": "AssetWrapper",
4
+ "type": "object",
5
+ "properties": {
6
+ "asset": {
7
+ "required": true,
8
+ "node": {
9
+ "type": "ref",
10
+ "ref": "T",
11
+ "title": "AssetWrapper.asset",
12
+ "description": "An asset instance"
13
+ }
14
+ }
15
+ },
16
+ "additionalProperties": {
17
+ "type": "unknown"
18
+ },
19
+ "title": "AssetWrapper",
20
+ "description": "An object that contains an asset",
21
+ "genericTokens": [
22
+ {
23
+ "symbol": "T",
24
+ "constraints": {
25
+ "type": "ref",
26
+ "ref": "Asset"
27
+ },
28
+ "default": {
29
+ "type": "ref",
30
+ "ref": "Asset"
31
+ }
32
+ }
33
+ ]
34
+ }
@@ -0,0 +1,304 @@
1
+ {
2
+ "source": "core/types/src/index.ts",
3
+ "name": "AssetWrapperOrSwitch",
4
+ "type": "or",
5
+ "or": [
6
+ {
7
+ "type": "and",
8
+ "and": [
9
+ {
10
+ "type": "ref",
11
+ "ref": "AssetWrapper<T>",
12
+ "genericArguments": [
13
+ {
14
+ "type": "ref",
15
+ "ref": "T"
16
+ }
17
+ ]
18
+ },
19
+ {
20
+ "type": "object",
21
+ "properties": {
22
+ "dynamicSwitch": {
23
+ "required": false,
24
+ "node": {
25
+ "type": "never",
26
+ "title": "dynamicSwitch",
27
+ "description": "The dynamicSwitch property can't exist at the same time as 'asset'"
28
+ }
29
+ },
30
+ "staticSwitch": {
31
+ "required": false,
32
+ "node": {
33
+ "type": "never",
34
+ "title": "staticSwitch",
35
+ "description": "The staticSwitch property can't exist at the same time as 'asset'"
36
+ }
37
+ }
38
+ },
39
+ "additionalProperties": false
40
+ }
41
+ ]
42
+ },
43
+ {
44
+ "type": "and",
45
+ "and": [
46
+ {
47
+ "source": "core/types/src/index.ts",
48
+ "name": "StaticSwitch",
49
+ "type": "object",
50
+ "properties": {
51
+ "staticSwitch": {
52
+ "required": true,
53
+ "node": {
54
+ "source": "core/types/src/index.ts",
55
+ "name": "Switch",
56
+ "type": "array",
57
+ "elementType": {
58
+ "source": "core/types/src/index.ts",
59
+ "name": "SwitchCase",
60
+ "type": "object",
61
+ "properties": {
62
+ "asset": {
63
+ "required": true,
64
+ "node": {
65
+ "type": "ref",
66
+ "ref": "T",
67
+ "title": "SwitchCase.asset",
68
+ "description": "The Asset to use if this case is applicable"
69
+ }
70
+ },
71
+ "case": {
72
+ "required": true,
73
+ "node": {
74
+ "type": "or",
75
+ "or": [
76
+ {
77
+ "type": "ref",
78
+ "ref": "Expression",
79
+ "title": "SwitchCase.case"
80
+ },
81
+ {
82
+ "type": "boolean",
83
+ "const": true
84
+ }
85
+ ],
86
+ "title": "SwitchCase.case",
87
+ "description": "An expression to execute to determine if this case applies"
88
+ }
89
+ }
90
+ },
91
+ "additionalProperties": false,
92
+ "title": "SwitchCase",
93
+ "description": "A single case statement to use in a switch",
94
+ "genericTokens": [
95
+ {
96
+ "symbol": "T",
97
+ "constraints": {
98
+ "type": "ref",
99
+ "ref": "Asset"
100
+ },
101
+ "default": {
102
+ "type": "ref",
103
+ "ref": "Asset"
104
+ }
105
+ }
106
+ ]
107
+ },
108
+ "title": "StaticSwitch.staticSwitch",
109
+ "description": "A static switch only evaluates the applicable base on first render of the view",
110
+ "genericTokens": [
111
+ {
112
+ "symbol": "T",
113
+ "constraints": {
114
+ "type": "ref",
115
+ "ref": "Asset"
116
+ },
117
+ "default": {
118
+ "type": "ref",
119
+ "ref": "Asset"
120
+ }
121
+ }
122
+ ]
123
+ }
124
+ }
125
+ },
126
+ "additionalProperties": false,
127
+ "title": "StaticSwitch",
128
+ "genericTokens": [
129
+ {
130
+ "symbol": "T",
131
+ "constraints": {
132
+ "type": "ref",
133
+ "ref": "Asset"
134
+ },
135
+ "default": {
136
+ "type": "ref",
137
+ "ref": "Asset"
138
+ }
139
+ }
140
+ ]
141
+ },
142
+ {
143
+ "type": "object",
144
+ "properties": {
145
+ "asset": {
146
+ "required": false,
147
+ "node": {
148
+ "type": "never",
149
+ "title": "asset",
150
+ "description": "The staticSwitch property can't exist at the same time as 'asset'"
151
+ }
152
+ },
153
+ "dynamicSwitch": {
154
+ "required": false,
155
+ "node": {
156
+ "type": "never",
157
+ "title": "dynamicSwitch",
158
+ "description": "The staticSwitch property can't exist at the same time as 'dynamicSwitch'"
159
+ }
160
+ }
161
+ },
162
+ "additionalProperties": false
163
+ }
164
+ ]
165
+ },
166
+ {
167
+ "type": "and",
168
+ "and": [
169
+ {
170
+ "source": "core/types/src/index.ts",
171
+ "name": "DynamicSwitch",
172
+ "type": "object",
173
+ "properties": {
174
+ "dynamicSwitch": {
175
+ "required": true,
176
+ "node": {
177
+ "source": "core/types/src/index.ts",
178
+ "name": "Switch",
179
+ "type": "array",
180
+ "elementType": {
181
+ "source": "core/types/src/index.ts",
182
+ "name": "SwitchCase",
183
+ "type": "object",
184
+ "properties": {
185
+ "asset": {
186
+ "required": true,
187
+ "node": {
188
+ "type": "ref",
189
+ "ref": "T",
190
+ "title": "SwitchCase.asset",
191
+ "description": "The Asset to use if this case is applicable"
192
+ }
193
+ },
194
+ "case": {
195
+ "required": true,
196
+ "node": {
197
+ "type": "or",
198
+ "or": [
199
+ {
200
+ "type": "ref",
201
+ "ref": "Expression",
202
+ "title": "SwitchCase.case"
203
+ },
204
+ {
205
+ "type": "boolean",
206
+ "const": true
207
+ }
208
+ ],
209
+ "title": "SwitchCase.case",
210
+ "description": "An expression to execute to determine if this case applies"
211
+ }
212
+ }
213
+ },
214
+ "additionalProperties": false,
215
+ "title": "SwitchCase",
216
+ "description": "A single case statement to use in a switch",
217
+ "genericTokens": [
218
+ {
219
+ "symbol": "T",
220
+ "constraints": {
221
+ "type": "ref",
222
+ "ref": "Asset"
223
+ },
224
+ "default": {
225
+ "type": "ref",
226
+ "ref": "Asset"
227
+ }
228
+ }
229
+ ]
230
+ },
231
+ "title": "DynamicSwitch.dynamicSwitch",
232
+ "description": "A dynamic switch re-evaluates the applicable case as data changes",
233
+ "genericTokens": [
234
+ {
235
+ "symbol": "T",
236
+ "constraints": {
237
+ "type": "ref",
238
+ "ref": "Asset"
239
+ },
240
+ "default": {
241
+ "type": "ref",
242
+ "ref": "Asset"
243
+ }
244
+ }
245
+ ]
246
+ }
247
+ }
248
+ },
249
+ "additionalProperties": false,
250
+ "title": "DynamicSwitch",
251
+ "genericTokens": [
252
+ {
253
+ "symbol": "T",
254
+ "constraints": {
255
+ "type": "ref",
256
+ "ref": "Asset"
257
+ },
258
+ "default": {
259
+ "type": "ref",
260
+ "ref": "Asset"
261
+ }
262
+ }
263
+ ]
264
+ },
265
+ {
266
+ "type": "object",
267
+ "properties": {
268
+ "asset": {
269
+ "required": false,
270
+ "node": {
271
+ "type": "never",
272
+ "title": "asset",
273
+ "description": "The dynamicSwitch property can't exist at the same time as 'asset'"
274
+ }
275
+ },
276
+ "staticSwitch": {
277
+ "required": false,
278
+ "node": {
279
+ "type": "never",
280
+ "title": "staticSwitch",
281
+ "description": "The dynamicSwitch property can't exist at the same time as 'staticSwitch'"
282
+ }
283
+ }
284
+ },
285
+ "additionalProperties": false
286
+ }
287
+ ]
288
+ }
289
+ ],
290
+ "title": "AssetWrapperOrSwitch",
291
+ "genericTokens": [
292
+ {
293
+ "symbol": "T",
294
+ "constraints": {
295
+ "type": "ref",
296
+ "ref": "Asset"
297
+ },
298
+ "default": {
299
+ "type": "ref",
300
+ "ref": "Asset"
301
+ }
302
+ }
303
+ ]
304
+ }
@@ -0,0 +1,7 @@
1
+ {
2
+ "source": "core/types/src/index.ts",
3
+ "name": "Binding",
4
+ "type": "string",
5
+ "title": "Binding",
6
+ "description": "Bindings describe locations in the data model."
7
+ }
@@ -0,0 +1,7 @@
1
+ {
2
+ "source": "core/types/src/index.ts",
3
+ "name": "BindingRef",
4
+ "type": "template",
5
+ "format": "{{.*}}",
6
+ "title": "BindingRef"
7
+ }