@rippling/pebble-sdui-web 0.6.2 → 0.7.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.
Files changed (38) hide show
  1. package/dist/2020-C_v5qH0D.cjs +9 -0
  2. package/dist/2020-C_v5qH0D.cjs.map +1 -0
  3. package/dist/2020-PBERvPzO.js +4846 -0
  4. package/dist/2020-PBERvPzO.js.map +1 -0
  5. package/dist/catalogs/custom-apps/action-params.d.ts +0 -5
  6. package/dist/catalogs/custom-apps/catalog.d.ts +1 -1
  7. package/dist/catalogs/custom-apps/component-props.d.ts +628 -203
  8. package/dist/catalogs/custom-apps/index.cjs +3 -10
  9. package/dist/catalogs/custom-apps/index.cjs.map +1 -1
  10. package/dist/catalogs/custom-apps/index.d.ts +1 -1
  11. package/dist/catalogs/custom-apps/index.js +458 -5291
  12. package/dist/catalogs/custom-apps/index.js.map +1 -1
  13. package/dist/catalogs/hub_platform/action-params.d.ts +5 -0
  14. package/dist/catalogs/hub_platform/actions.d.ts +5 -0
  15. package/dist/catalogs/hub_platform/catalog.d.ts +33 -0
  16. package/dist/catalogs/hub_platform/component-events.d.ts +10 -0
  17. package/dist/catalogs/hub_platform/component-props.d.ts +287 -0
  18. package/dist/catalogs/hub_platform/components.d.ts +11 -0
  19. package/dist/catalogs/hub_platform/function-params.d.ts +5 -0
  20. package/dist/catalogs/hub_platform/functions.d.ts +5 -0
  21. package/dist/catalogs/hub_platform/index.cjs +2 -0
  22. package/dist/catalogs/hub_platform/index.cjs.map +1 -0
  23. package/dist/catalogs/hub_platform/index.d.ts +11 -0
  24. package/dist/catalogs/hub_platform/index.js +1087 -0
  25. package/dist/catalogs/hub_platform/index.js.map +1 -0
  26. package/dist/catalogs/hub_platform/render.d.ts +20 -0
  27. package/dist/docs/typescript/web/catalogs/custom-apps/actions.md +15 -21
  28. package/dist/docs/typescript/web/catalogs/custom-apps/components.md +879 -879
  29. package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +656 -150
  30. package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +2 -2
  31. package/dist/docs/typescript/web/catalogs/custom-apps/types.md +1045 -142
  32. package/dist/docs/typescript/web/catalogs/hub_platform/actions.md +6 -0
  33. package/dist/docs/typescript/web/catalogs/hub_platform/components.md +212 -0
  34. package/dist/docs/typescript/web/catalogs/hub_platform/computed-functions.md +6 -0
  35. package/dist/docs/typescript/web/catalogs/hub_platform/definitions.md +91 -0
  36. package/dist/docs/typescript/web/catalogs/hub_platform/readme.md +16 -0
  37. package/dist/docs/typescript/web/catalogs/hub_platform/types.md +368 -0
  38. package/package.json +6 -1
@@ -0,0 +1,368 @@
1
+ <!-- Auto-generated from catalogs/hub_platform.catalog.json; do not edit directly. -->
2
+ # hub_platform Types
3
+
4
+ Nested object types are referenced from component props, action params, and computed function params. Read this file only when another catalog doc links to a nested type.
5
+
6
+ ## Command
7
+
8
+ ### Fields
9
+
10
+ | Name | Required | Type | Description |
11
+ |---|---:|---|---|
12
+ | `createIfMissing` | no | boolean | |
13
+ | `errorPath` | no | string | JSON pointer path in the SDUI state model. |
14
+ | `group` | no | [SuperGroupEditorGroup](./types.md#supergroupeditorgroup) | |
15
+ | `includeRoleStates` | no | boolean | |
16
+ | `mode` | no | [SuperGroupEditorMode](./definitions.md#supergroupeditormode) | |
17
+ | `refreshMembers` | no | boolean | |
18
+ | `requestId` | yes | string | |
19
+ | `responsePath` | no | string | JSON pointer path in the SDUI state model. |
20
+ | `retainFocus` | no | boolean | |
21
+ | `skipMembershipUpdateNotification` | no | boolean | |
22
+ | `type` | yes | [CommandType](./definitions.md#commandtype) | |
23
+
24
+ Additional properties: unknown.
25
+
26
+ ## CreatePolicy
27
+
28
+ ### Fields
29
+
30
+ | Name | Required | Type | Description |
31
+ |---|---:|---|---|
32
+ | `groupName` | yes | string | |
33
+ | `groupType` | no | string | |
34
+ | `kind` | yes | "role" | |
35
+ | `overRideRoleStates` | no | string[] | |
36
+ | `parent` | no | string | |
37
+ | `provisionRoleState` | no | string | |
38
+ | `spokeId` | no | string | |
39
+ | `subGroupType` | no | string | |
40
+
41
+ Additional properties: unknown.
42
+
43
+ ## DefaultSelectedDateTimeConfig
44
+
45
+ ### Fields
46
+
47
+ _No fields._
48
+
49
+ Additional properties: unknown.
50
+
51
+ ## EditorPlaceholder
52
+
53
+ Editor placeholders keyed by INCLUSION and EXCLUSION.
54
+
55
+ ### Fields
56
+
57
+ _No fields._
58
+
59
+ Additional properties: string.
60
+
61
+ ## EditorTitle
62
+
63
+ Editor title labels keyed by INCLUSION and EXCLUSION.
64
+
65
+ ### Fields
66
+
67
+ _No fields._
68
+
69
+ Additional properties: string.
70
+
71
+ ## GroupDetailsConfig
72
+
73
+ JSON-safe group details configuration.
74
+
75
+ ### Fields
76
+
77
+ _No fields._
78
+
79
+ Additional properties: unknown.
80
+
81
+ ## InitialGroup
82
+
83
+ Initial serialized group used before a backend group exists.
84
+
85
+ ### Fields
86
+
87
+ _No fields._
88
+
89
+ Additional properties: unknown.
90
+
91
+ ## StatePath
92
+
93
+ Optional state paths the wrapper writes as editor state changes.
94
+
95
+ ### Fields
96
+
97
+ | Name | Required | Type | Description |
98
+ |---|---:|---|---|
99
+ | `draftGroup` | no | string | JSON pointer path in the SDUI state model. |
100
+ | `errors` | no | string | JSON pointer path in the SDUI state model. |
101
+ | `groupId` | no | string | JSON pointer path in the SDUI state model. |
102
+ | `isBusy` | no | string | JSON pointer path in the SDUI state model. |
103
+ | `isCreating` | no | string | JSON pointer path in the SDUI state model. |
104
+ | `isDirty` | no | string | JSON pointer path in the SDUI state model. |
105
+ | `isLoading` | no | string | JSON pointer path in the SDUI state model. |
106
+ | `isResetting` | no | string | JSON pointer path in the SDUI state model. |
107
+ | `isSaving` | no | string | JSON pointer path in the SDUI state model. |
108
+ | `isValidating` | no | string | JSON pointer path in the SDUI state model. |
109
+ | `lastChangeSource` | no | string | JSON pointer path in the SDUI state model. |
110
+ | `lastSavedAt` | no | string | JSON pointer path in the SDUI state model. |
111
+ | `savedGroup` | no | string | JSON pointer path in the SDUI state model. |
112
+ | `serverErrors` | no | string | JSON pointer path in the SDUI state model. |
113
+ | `validation` | no | string | JSON pointer path in the SDUI state model. |
114
+
115
+ No additional properties.
116
+
117
+ ## SuperGroupEditorGroup
118
+
119
+ ### Fields
120
+
121
+ _No fields._
122
+
123
+ Additional properties: unknown.
124
+
125
+ ## SuperGroupEditorGroupTypeConfig
126
+
127
+ Group type metadata used by SuperGroup API adapters.
128
+
129
+ ### Fields
130
+
131
+ | Name | Required | Type | Description |
132
+ |---|---:|---|---|
133
+ | `isInternal` | no | boolean | |
134
+ | `type` | no | string | |
135
+
136
+ Additional properties: unknown.
137
+
138
+ ## SuperGroupEditorProvisionedRole
139
+
140
+ ### Fields
141
+
142
+ | Name | Required | Type | Description |
143
+ |---|---:|---|---|
144
+ | `id` | yes | string | |
145
+
146
+ Additional properties: unknown.
147
+
148
+ ## SuperGroupEditorRequestOption
149
+
150
+ Additional request options forwarded to SuperGroup APIs.
151
+
152
+ ### Fields
153
+
154
+ _No fields._
155
+
156
+ Additional properties: unknown.
157
+
158
+ ## SuperGroupEditorRuleOption
159
+
160
+ JSON-safe SuperGroup rule option configuration.
161
+
162
+ ### Fields
163
+
164
+ _No fields._
165
+
166
+ Additional properties: unknown.
167
+
168
+ ## SuperGroupGridRendererGroup
169
+
170
+ Already-fetched SuperGroup object. Prefer groupId unless the group is already available in the spec context.
171
+
172
+ ### Fields
173
+
174
+ _No fields._
175
+
176
+ Additional properties: unknown.
177
+
178
+ ## SuperGroupGridRendererGroupTypeConfig
179
+
180
+ Group type metadata used by SuperGroup API adapters.
181
+
182
+ ### Fields
183
+
184
+ | Name | Required | Type | Description |
185
+ |---|---:|---|---|
186
+ | `isInternal` | no | boolean | |
187
+ | `type` | no | string | |
188
+
189
+ Additional properties: unknown.
190
+
191
+ ## SuperGroupGridRendererProvisionedRole
192
+
193
+ ### Fields
194
+
195
+ | Name | Required | Type | Description |
196
+ |---|---:|---|---|
197
+ | `id` | yes | string | |
198
+
199
+ Additional properties: unknown.
200
+
201
+ ## SuperGroupGridRendererRequestOption
202
+
203
+ Additional request options forwarded to SuperGroup APIs.
204
+
205
+ ### Fields
206
+
207
+ _No fields._
208
+
209
+ Additional properties: unknown.
210
+
211
+ ## SuperGroupGridRendererRuleOption
212
+
213
+ JSON-safe SuperGroup rule option configuration.
214
+
215
+ ### Fields
216
+
217
+ _No fields._
218
+
219
+ Additional properties: unknown.
220
+
221
+ ## SuperGroupMembersViewerGroup
222
+
223
+ Already-fetched SuperGroup object. Prefer groupId unless the group is already available in the spec context.
224
+
225
+ ### Fields
226
+
227
+ _No fields._
228
+
229
+ Additional properties: unknown.
230
+
231
+ ## SuperGroupMembersViewerGroupTypeConfig
232
+
233
+ Group type metadata used by SuperGroup API adapters.
234
+
235
+ ### Fields
236
+
237
+ | Name | Required | Type | Description |
238
+ |---|---:|---|---|
239
+ | `isInternal` | no | boolean | |
240
+ | `type` | no | string | |
241
+
242
+ Additional properties: unknown.
243
+
244
+ ## SuperGroupMembersViewerProvisionedRole
245
+
246
+ ### Fields
247
+
248
+ | Name | Required | Type | Description |
249
+ |---|---:|---|---|
250
+ | `id` | yes | string | |
251
+
252
+ Additional properties: unknown.
253
+
254
+ ## SuperGroupMembersViewerRequestOption
255
+
256
+ Additional request options forwarded to SuperGroup APIs.
257
+
258
+ ### Fields
259
+
260
+ _No fields._
261
+
262
+ Additional properties: unknown.
263
+
264
+ ## SuperGroupPreviewV2Group
265
+
266
+ Already-fetched SuperGroup object. Prefer groupId unless the group is already available in the spec context.
267
+
268
+ ### Fields
269
+
270
+ _No fields._
271
+
272
+ Additional properties: unknown.
273
+
274
+ ## SuperGroupPreviewV2GroupTypeConfig
275
+
276
+ Group type metadata used by SuperGroup API adapters.
277
+
278
+ ### Fields
279
+
280
+ | Name | Required | Type | Description |
281
+ |---|---:|---|---|
282
+ | `isInternal` | no | boolean | |
283
+ | `type` | no | string | |
284
+
285
+ Additional properties: unknown.
286
+
287
+ ## SuperGroupPreviewV2ProvisionedRole
288
+
289
+ ### Fields
290
+
291
+ | Name | Required | Type | Description |
292
+ |---|---:|---|---|
293
+ | `id` | yes | string | |
294
+
295
+ Additional properties: unknown.
296
+
297
+ ## SuperGroupPreviewV2RequestOption
298
+
299
+ Additional request options forwarded to SuperGroup APIs.
300
+
301
+ ### Fields
302
+
303
+ _No fields._
304
+
305
+ Additional properties: unknown.
306
+
307
+ ## SuperGroupPreviewV2RuleOption
308
+
309
+ JSON-safe SuperGroup rule option configuration.
310
+
311
+ ### Fields
312
+
313
+ _No fields._
314
+
315
+ Additional properties: unknown.
316
+
317
+ ## SuperGroupStateProviderGroup
318
+
319
+ Already-fetched SuperGroup object. Prefer groupId unless the group is already available in the spec context.
320
+
321
+ ### Fields
322
+
323
+ _No fields._
324
+
325
+ Additional properties: unknown.
326
+
327
+ ## SuperGroupStateProviderGroupTypeConfig
328
+
329
+ Group type metadata used by SuperGroup API adapters.
330
+
331
+ ### Fields
332
+
333
+ | Name | Required | Type | Description |
334
+ |---|---:|---|---|
335
+ | `isInternal` | no | boolean | |
336
+ | `type` | no | string | |
337
+
338
+ Additional properties: unknown.
339
+
340
+ ## SuperGroupStateProviderProvisionedRole
341
+
342
+ ### Fields
343
+
344
+ | Name | Required | Type | Description |
345
+ |---|---:|---|---|
346
+ | `id` | yes | string | |
347
+
348
+ Additional properties: unknown.
349
+
350
+ ## SuperGroupStateProviderRequestOption
351
+
352
+ Additional request options forwarded to SuperGroup APIs.
353
+
354
+ ### Fields
355
+
356
+ _No fields._
357
+
358
+ Additional properties: unknown.
359
+
360
+ ## Validation
361
+
362
+ JSON-safe built-in validation configuration.
363
+
364
+ ### Fields
365
+
366
+ _No fields._
367
+
368
+ Additional properties: unknown.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rippling/pebble-sdui-web",
3
- "version": "0.6.2",
3
+ "version": "0.7.0",
4
4
  "description": "Type-safe TypeScript web SDK for authoring json-render specs",
5
5
  "repository": {
6
6
  "type": "git",
@@ -26,6 +26,11 @@
26
26
  "types": "./dist/catalogs/custom-apps/index.d.ts",
27
27
  "import": "./dist/catalogs/custom-apps/index.js",
28
28
  "require": "./dist/catalogs/custom-apps/index.cjs"
29
+ },
30
+ "./catalogs/hub_platform": {
31
+ "types": "./dist/catalogs/hub_platform/index.d.ts",
32
+ "import": "./dist/catalogs/hub_platform/index.js",
33
+ "require": "./dist/catalogs/hub_platform/index.cjs"
29
34
  }
30
35
  },
31
36
  "imports": {