@rippling/pebble-sdui-web 0.6.3 → 0.8.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/catalog.d.ts +1 -1
  6. package/dist/catalogs/custom-apps/component-events.d.ts +2 -0
  7. package/dist/catalogs/custom-apps/component-props.d.ts +100 -29
  8. package/dist/catalogs/custom-apps/components.d.ts +4 -2
  9. package/dist/catalogs/custom-apps/index.cjs +2 -9
  10. package/dist/catalogs/custom-apps/index.cjs.map +1 -1
  11. package/dist/catalogs/custom-apps/index.d.ts +3 -3
  12. package/dist/catalogs/custom-apps/index.js +818 -5342
  13. package/dist/catalogs/custom-apps/index.js.map +1 -1
  14. package/dist/catalogs/hub_platform/action-params.d.ts +5 -0
  15. package/dist/catalogs/hub_platform/actions.d.ts +5 -0
  16. package/dist/catalogs/hub_platform/catalog.d.ts +33 -0
  17. package/dist/catalogs/hub_platform/component-events.d.ts +10 -0
  18. package/dist/catalogs/hub_platform/component-props.d.ts +287 -0
  19. package/dist/catalogs/hub_platform/components.d.ts +11 -0
  20. package/dist/catalogs/hub_platform/function-params.d.ts +5 -0
  21. package/dist/catalogs/hub_platform/functions.d.ts +5 -0
  22. package/dist/catalogs/hub_platform/index.cjs +2 -0
  23. package/dist/catalogs/hub_platform/index.cjs.map +1 -0
  24. package/dist/catalogs/hub_platform/index.d.ts +11 -0
  25. package/dist/catalogs/hub_platform/index.js +1087 -0
  26. package/dist/catalogs/hub_platform/index.js.map +1 -0
  27. package/dist/catalogs/hub_platform/render.d.ts +20 -0
  28. package/dist/docs/typescript/web/catalogs/custom-apps/components.md +85 -3
  29. package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +71 -1
  30. package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +1 -1
  31. package/dist/docs/typescript/web/catalogs/custom-apps/types.md +64 -47
  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,212 @@
1
+ <!-- Auto-generated from catalogs/hub_platform.catalog.json; do not edit directly. -->
2
+ # hub_platform Components
3
+
4
+ Import component builders from `@rippling/pebble-sdui-web/catalogs/hub_platform`. Read [definitions.md](./definitions.md) for enum values linked from prop tables.
5
+
6
+ ## SuperGroupEditor
7
+
8
+ Managed editable SuperGroup editor. Use this when SDUI needs to create, edit, save, reset, or extract a SuperGroup without passing React refs or callback props.
9
+
10
+ SuperGroupEditor owns the internal SuperGroup ref and converts save/draft/reset operations into commandPath, responsePath, errorPath, statePaths, and events.
11
+ Use saveMode="self" for built-in Save/Cancel controls. Use saveMode="external" with commandPath for parent-coordinated save flows.
12
+ createPolicy.kind="role" uses Group.createNewApplicationGroup. createPolicy.kind="nonRole" uses GroupV2.createGroup and requires family.
13
+ The wrapper writes event payloads to state before emitting events. It does not expose createGroup, updateGroup, validateBeforeSave, ref, ReactNode props, or custom renderers.
14
+
15
+ Catalog key: `SuperGroupEditor`
16
+ Builder: `SuperGroupEditor`
17
+ Props type: `SuperGroupEditorProps`
18
+ Accepts children: no
19
+ Events: `load`, `change`, `validationChange`, `editToggle`, `saveStart`, `saveSuccess`, `saveError`, `cancel`, `roleStateChange`, `scopeFilterChange`, `timeBasedConfigChange`
20
+
21
+ ### Props
22
+
23
+ | Name | Required | Type | Description |
24
+ |---|---:|---|---|
25
+ | `appName` | yes | string | Application name used by SuperGroup APIs. Required for all SuperGroup renderers. |
26
+ | `canEditRoleStatesApplied` | no | boolean | |
27
+ | `canSelectAll` | no | boolean | When true, enables select-all support where SuperGroup supports it. |
28
+ | `command` | no | [Command](./types.md#command) | |
29
+ | `commandPath` | no | string | JSON pointer path in the SDUI state model. |
30
+ | `createPolicy` | no | [CreatePolicy](./types.md#createpolicy) \| [CreatePolicy](./types.md#createpolicy) | Declarative create config used for lazy group creation. |
31
+ | `defaultEditable` | no | boolean | When true, the editor starts in edit mode. |
32
+ | `defaultRoleStates` | no | string[] | |
33
+ | `defaultSelectedDateTimeConfig` | no | [DefaultSelectedDateTimeConfig](./types.md#defaultselecteddatetimeconfig) | |
34
+ | `defaultSelectedScheduleEffectiveDateValue` | no | string | |
35
+ | `dropdownPanelMaxHeight` | no | number | Maximum dropdown panel height in pixels. |
36
+ | `editorPlaceholder` | no | [EditorPlaceholder](./types.md#editorplaceholder) | Editor placeholders keyed by INCLUSION and EXCLUSION. |
37
+ | `editorTitle` | no | [EditorTitle](./types.md#editortitle) | Editor title labels keyed by INCLUSION and EXCLUSION. |
38
+ | `errorPath` | no | string | JSON pointer path in the SDUI state model. |
39
+ | `family` | no | string | Object family used when resolving group metadata. |
40
+ | `group` | no | [SuperGroupEditorGroup](./types.md#supergroupeditorgroup) | Already-fetched SuperGroup object. Prefer groupId unless the group is already available in the spec context. |
41
+ | `groupDetailsConfig` | no | [GroupDetailsConfig](./types.md#groupdetailsconfig) | JSON-safe group details configuration. |
42
+ | `groupId` | no | string | Id of the SuperGroup to fetch and render. |
43
+ | `groupTypeConfig` | no | [SuperGroupEditorGroupTypeConfig](./types.md#supergroupeditorgrouptypeconfig) | Group type metadata used by SuperGroup API adapters. |
44
+ | `initialGroup` | no | [InitialGroup](./types.md#initialgroup) | Initial serialized group used before a backend group exists. |
45
+ | `isDisabled` | no | boolean | Disables editing controls. |
46
+ | `isEntityScopeSupported` | no | boolean | |
47
+ | `isScheduleGroupChangesSupported` | no | boolean | |
48
+ | `isTimeBasedConfigurationSupported` | no | boolean | |
49
+ | `minSearchLength` | no | number | Minimum characters required before SuperGroup search runs. |
50
+ | `mode` | no | [SuperGroupEditorMode](./definitions.md#supergroupeditormode) | Controlled initial mode. Defaults to edit when defaultEditable is true. |
51
+ | `ownerId` | no | string | SpokeOwner id. Required for non-internal application groups. |
52
+ | `provisionedRoles` | no | string \| [SuperGroupEditorProvisionedRole](./types.md#supergroupeditorprovisionedrole)[] | Role ids or serialized role objects provisioned by the parent app or object. Required for role groups unless shouldIgnoreProvisioningGroup is true. |
53
+ | `refreshMembers` | no | boolean | Alias for shouldShowRefreshMembersAction. Command-level refreshMembers controls live member refresh during save. |
54
+ | `requestOptions` | no | [SuperGroupEditorRequestOption](./types.md#supergroupeditorrequestoption) | Additional request options forwarded to SuperGroup APIs. |
55
+ | `responsePath` | no | string | JSON pointer path in the SDUI state model. |
56
+ | `ruleOptions` | no | [SuperGroupEditorRuleOption](./types.md#supergroupeditorruleoption) | JSON-safe SuperGroup rule option configuration. |
57
+ | `saveMode` | yes | [SuperGroupEditorSaveMode](./definitions.md#supergroupeditorsavemode) | self renders SuperGroup actions; external expects parent-issued commands. |
58
+ | `scheduleEffectiveDateOptions` | no | unknown[] | |
59
+ | `shouldHideEditorTitle` | no | boolean | When true, hides inclusion/exclusion editor titles. |
60
+ | `shouldIgnoreProvisioningGroup` | no | boolean | When true, excludes provisioning group matching from member previews. |
61
+ | `shouldRefreshGroupMembersLive` | no | boolean | |
62
+ | `shouldShowActions` | no | boolean | When false, hides built-in save and cancel actions. |
63
+ | `shouldShowExclusions` | no | boolean | When false, hides exclusion rule editing. |
64
+ | `shouldShowImportRolesOption` | no | boolean | |
65
+ | `shouldShowRefreshMembersAction` | no | boolean | When true, exposes the manual refresh-members action for role groups. |
66
+ | `shouldShowRoleStateConfiguration` | no | boolean | |
67
+ | `shouldSkipMembershipUpdateNotification` | no | boolean | |
68
+ | `statePaths` | no | [StatePath](./types.md#statepath) | Optional state paths the wrapper writes as editor state changes. |
69
+ | `timeBasedConfigurationOptions` | no | unknown[] | |
70
+ | `validations` | no | [Validation](./types.md#validation) | JSON-safe built-in validation configuration. |
71
+
72
+ No additional properties.
73
+
74
+ ## SuperGroupGridRenderer
75
+
76
+ Compact read-only SuperGroup renderer for table and grid cells.
77
+
78
+ Wrap repeated grid instances in SuperGroupStateProvider so shared SuperGroup metadata is cached across cells.
79
+ Pass groupId for the common fetch-on-render path, or group when the spec already has the SuperGroup object.
80
+
81
+ Catalog key: `SuperGroupGridRenderer`
82
+ Builder: `SuperGroupGridRenderer`
83
+ Props type: `SuperGroupGridRendererProps`
84
+ Accepts children: no
85
+ Events: _none_
86
+
87
+ ### Props
88
+
89
+ | Name | Required | Type | Description |
90
+ |---|---:|---|---|
91
+ | `appName` | yes | string | Application name used by SuperGroup APIs. Required for all SuperGroup renderers. |
92
+ | `emptyPlaceholder` | no | string | Text displayed when the group has no members. |
93
+ | `emptyText` | no | string | Alias for emptyPlaceholder. Text displayed when empty. |
94
+ | `family` | no | string | Object family used when resolving group metadata. |
95
+ | `group` | no | [SuperGroupGridRendererGroup](./types.md#supergroupgridrenderergroup) | Already-fetched SuperGroup object. Prefer groupId unless the group is already available in the spec context. |
96
+ | `groupId` | no | string | Id of the SuperGroup to fetch and render. |
97
+ | `groupTypeConfig` | no | [SuperGroupGridRendererGroupTypeConfig](./types.md#supergroupgridrenderergrouptypeconfig) | Group type metadata used by SuperGroup API adapters. |
98
+ | `includedRoleTypes` | no | string[] | Role type filters applied to the preview result. |
99
+ | `ownerId` | no | string | SpokeOwner id. Required for non-internal application groups. |
100
+ | `previewRulesLimit` | no | number | Maximum number of rules shown before truncation. |
101
+ | `provisionedRoles` | no | string \| [SuperGroupGridRendererProvisionedRole](./types.md#supergroupgridrendererprovisionedrole)[] | Role ids or serialized role objects provisioned by the parent app or object. Required for role groups unless shouldIgnoreProvisioningGroup is true. |
102
+ | `requestOptions` | no | [SuperGroupGridRendererRequestOption](./types.md#supergroupgridrendererrequestoption) | Additional request options forwarded to SuperGroup APIs. |
103
+ | `ruleOptions` | no | [SuperGroupGridRendererRuleOption](./types.md#supergroupgridrendererruleoption) | JSON-safe SuperGroup rule option configuration. |
104
+ | `shouldIgnoreProvisioningGroup` | no | boolean | When true, excludes provisioning group matching from member previews. |
105
+ | `shouldIncludeThirdPartyAdmins` | no | boolean | When true, includes third-party admins in member previews. |
106
+ | `shouldShowExclusions` | no | boolean | When true, renders excluded-member rules. |
107
+ | `shouldShowTitle` | no | boolean | When true, renders the preview title. |
108
+ | `showPreviewMembersInTooltip` | no | boolean | When true, shows preview members inside the grid-cell tooltip. |
109
+ | `skipThrottling` | no | boolean | When true, skips SuperGroup mount throttling. |
110
+
111
+ No additional properties.
112
+
113
+ ## SuperGroupMembersViewer
114
+
115
+ Read-only SuperGroup members viewer for detail pages and summaries.
116
+
117
+ Pass groupId for the common fetch-on-render path, or group when the spec already has the SuperGroup object.
118
+ theme accepts INLINE_TEXT or INLINE_COUNT for compact inline displays. Omit theme for the full member grid.
119
+
120
+ Catalog key: `SuperGroupMembersViewer`
121
+ Builder: `SuperGroupMembersViewer`
122
+ Props type: `SuperGroupMembersViewerProps`
123
+ Accepts children: no
124
+ Events: _none_
125
+
126
+ ### Props
127
+
128
+ | Name | Required | Type | Description |
129
+ |---|---:|---|---|
130
+ | `family` | no | string | Object family used when resolving group metadata. |
131
+ | `gridTitle` | no | string | Title for the members grid. |
132
+ | `group` | no | [SuperGroupMembersViewerGroup](./types.md#supergroupmembersviewergroup) | Already-fetched SuperGroup object. Prefer groupId unless the group is already available in the spec context. |
133
+ | `groupId` | no | string | Id of the SuperGroup whose members should be rendered. |
134
+ | `groupMembersDrawerCaption` | no | string | Caption text for the members drawer. |
135
+ | `groupMembersDrawerTitle` | no | string | Title for the members drawer. |
136
+ | `groupTypeConfig` | no | [SuperGroupMembersViewerGroupTypeConfig](./types.md#supergroupmembersviewergrouptypeconfig) | Group type metadata used by SuperGroup API adapters. |
137
+ | `isPreview` | no | boolean | When true, renders in preview mode. |
138
+ | `provisionedRoles` | no | string \| [SuperGroupMembersViewerProvisionedRole](./types.md#supergroupmembersviewerprovisionedrole)[] | Role ids or serialized role objects provisioned by the parent app or object. |
139
+ | `requestOptions` | no | [SuperGroupMembersViewerRequestOption](./types.md#supergroupmembersviewerrequestoption) | Additional request options forwarded to SuperGroup APIs. |
140
+ | `shouldIgnoreProvisioningGroup` | no | boolean | When true, excludes provisioning group matching from member previews. |
141
+ | `shouldShowRefreshMembersAction` | no | boolean | When true, exposes the refresh-members action. |
142
+ | `theme` | no | [SuperGroupMembersViewerTheme](./definitions.md#supergroupmembersviewertheme) | Inline member display mode. Omit for the full member view. |
143
+
144
+ No additional properties.
145
+
146
+ ## SuperGroupPreviewV2
147
+
148
+ Read-only SuperGroup rule preview. Use this to show membership rules for an existing group without exposing editing controls.
149
+
150
+ Pass groupId for the common fetch-on-render path, or group when the spec already has the SuperGroup object.
151
+ appName is required. ownerId is required for non-internal application groups.
152
+ Compose titles and captions around this component with Pebble/core text components; PreviewV2 itself renders only the rule preview.
153
+
154
+ Catalog key: `SuperGroupPreviewV2`
155
+ Builder: `SuperGroupPreviewV2`
156
+ Props type: `SuperGroupPreviewV2Props`
157
+ Accepts children: no
158
+ Events: _none_
159
+
160
+ ### Props
161
+
162
+ | Name | Required | Type | Description |
163
+ |---|---:|---|---|
164
+ | `appName` | yes | string | Application name used by SuperGroup APIs. Required for all SuperGroup renderers. |
165
+ | `emptyPlaceholder` | no | string | Text displayed when the group has no members. |
166
+ | `emptyText` | no | string | Alias for emptyPlaceholder. Text displayed when empty. |
167
+ | `family` | no | string | Object family used when resolving group metadata. |
168
+ | `group` | no | [SuperGroupPreviewV2Group](./types.md#supergrouppreviewv2group) | Already-fetched SuperGroup object. Prefer groupId unless the group is already available in the spec context. |
169
+ | `groupId` | no | string | Id of the SuperGroup to fetch and render. |
170
+ | `groupTypeConfig` | no | [SuperGroupPreviewV2GroupTypeConfig](./types.md#supergrouppreviewv2grouptypeconfig) | Group type metadata used by SuperGroup API adapters. |
171
+ | `includedRoleTypes` | no | string[] | Role type filters applied to the preview result. |
172
+ | `ownerId` | no | string | SpokeOwner id. Required for non-internal application groups. |
173
+ | `previewRulesLimit` | no | number | Maximum number of rules shown before truncation. |
174
+ | `provisionedRoles` | no | string \| [SuperGroupPreviewV2ProvisionedRole](./types.md#supergrouppreviewv2provisionedrole)[] | Role ids or serialized role objects provisioned by the parent app or object. Required for role groups unless shouldIgnoreProvisioningGroup is true. |
175
+ | `requestOptions` | no | [SuperGroupPreviewV2RequestOption](./types.md#supergrouppreviewv2requestoption) | Additional request options forwarded to SuperGroup APIs. |
176
+ | `ruleOptions` | no | [SuperGroupPreviewV2RuleOption](./types.md#supergrouppreviewv2ruleoption) | JSON-safe SuperGroup rule option configuration. |
177
+ | `shouldIgnoreProvisioningGroup` | no | boolean | When true, excludes provisioning group matching from member previews. |
178
+ | `shouldIncludeThirdPartyAdmins` | no | boolean | When true, includes third-party admins in member previews. |
179
+ | `shouldShowExclusions` | no | boolean | When true, renders excluded-member rules. |
180
+ | `shouldShowTitle` | no | boolean | When true, renders the preview title. |
181
+ | `skipThrottling` | no | boolean | When true, skips SuperGroup mount throttling. |
182
+
183
+ No additional properties.
184
+
185
+ ## SuperGroupStateProvider
186
+
187
+ Provider that shares SuperGroup secondary data across nested read-only SuperGroup renderers.
188
+
189
+ Use this around lists, tables, or grids that render multiple SuperGroupPreviewV2 or SuperGroupGridRenderer instances.
190
+ Pass the same appName, ownerId, family, groupTypeConfig, requestOptions, and provisionedRoles that nested SuperGroup renderers use.
191
+
192
+ Catalog key: `SuperGroupStateProvider`
193
+ Builder: `SuperGroupStateProvider`
194
+ Props type: `SuperGroupStateProviderProps`
195
+ Accepts children: yes
196
+ Events: _none_
197
+
198
+ ### Props
199
+
200
+ | Name | Required | Type | Description |
201
+ |---|---:|---|---|
202
+ | `appName` | yes | string | Application name used by SuperGroup APIs. Required for all SuperGroup renderers. |
203
+ | `family` | no | string | Object family used when resolving group metadata. |
204
+ | `group` | no | [SuperGroupStateProviderGroup](./types.md#supergroupstateprovidergroup) | Already-fetched SuperGroup object. Prefer groupId unless the group is already available in the spec context. |
205
+ | `groupId` | no | string | Id of the SuperGroup to fetch and render. |
206
+ | `groupTypeConfig` | no | [SuperGroupStateProviderGroupTypeConfig](./types.md#supergroupstateprovidergrouptypeconfig) | Group type metadata used by SuperGroup API adapters. |
207
+ | `ownerId` | no | string | SpokeOwner id. Required for non-internal application groups. |
208
+ | `provisionedRoles` | no | string \| [SuperGroupStateProviderProvisionedRole](./types.md#supergroupstateproviderprovisionedrole)[] | Role ids or serialized role objects provisioned by the parent app or object. Required for role groups unless shouldIgnoreProvisioningGroup is true. |
209
+ | `requestOptions` | no | [SuperGroupStateProviderRequestOption](./types.md#supergroupstateproviderrequestoption) | Additional request options forwarded to SuperGroup APIs. |
210
+ | `shouldIgnoreProvisioningGroup` | no | boolean | When true, excludes provisioning group matching from member previews. |
211
+
212
+ No additional properties.
@@ -0,0 +1,6 @@
1
+ <!-- Auto-generated from catalogs/hub_platform.catalog.json; do not edit directly. -->
2
+ # hub_platform Computed Functions
3
+
4
+ Import computed function helpers from `@rippling/pebble-sdui-web/catalogs/hub_platform`. Read [definitions.md](./definitions.md) for enum values linked from param tables.
5
+
6
+ _This catalog does not define computed functions._
@@ -0,0 +1,91 @@
1
+ <!-- Auto-generated from catalogs/hub_platform.catalog.json; do not edit directly. -->
2
+ # hub_platform Definitions
3
+
4
+ Enum values are defined here so component, action, function, and type tables can link to them without duplicating allowed values.
5
+
6
+ ## CommandType
7
+
8
+ TypeScript type:
9
+
10
+ ```ts
11
+ "save" | "extractDraft" | "reset" | "setMode"
12
+ ```
13
+
14
+ Allowed values:
15
+
16
+ | Value |
17
+ |---|
18
+ | `save` |
19
+ | `extractDraft` |
20
+ | `reset` |
21
+ | `setMode` |
22
+
23
+ Referenced by:
24
+
25
+ | Kind | Entity | Field |
26
+ |---|---|---|
27
+ | type | `Command` | `type` |
28
+
29
+ ## SuperGroupEditorMode
30
+
31
+ TypeScript type:
32
+
33
+ ```ts
34
+ "read" | "edit"
35
+ ```
36
+
37
+ Allowed values:
38
+
39
+ | Value |
40
+ |---|
41
+ | `read` |
42
+ | `edit` |
43
+
44
+ Referenced by:
45
+
46
+ | Kind | Entity | Field |
47
+ |---|---|---|
48
+ | component | `SuperGroupEditor` | `mode` |
49
+ | type | `Command` | `mode` |
50
+
51
+ ## SuperGroupEditorSaveMode
52
+
53
+ TypeScript type:
54
+
55
+ ```ts
56
+ "self" | "external"
57
+ ```
58
+
59
+ Allowed values:
60
+
61
+ | Value |
62
+ |---|
63
+ | `self` |
64
+ | `external` |
65
+
66
+ Referenced by:
67
+
68
+ | Kind | Entity | Field |
69
+ |---|---|---|
70
+ | component | `SuperGroupEditor` | `saveMode` |
71
+
72
+ ## SuperGroupMembersViewerTheme
73
+
74
+ TypeScript type:
75
+
76
+ ```ts
77
+ "INLINE_TEXT" | "INLINE_COUNT"
78
+ ```
79
+
80
+ Allowed values:
81
+
82
+ | Value |
83
+ |---|
84
+ | `INLINE_TEXT` |
85
+ | `INLINE_COUNT` |
86
+
87
+ Referenced by:
88
+
89
+ | Kind | Entity | Field |
90
+ |---|---|---|
91
+ | component | `SuperGroupMembersViewer` | `theme` |
@@ -0,0 +1,16 @@
1
+ <!-- Auto-generated from catalogs/hub_platform.catalog.json; do not edit directly. -->
2
+ # hub_platform Catalog
3
+
4
+ Catalog: `hub_platform`
5
+ Version: `1.0.0`
6
+ SDK language: `typescript`
7
+
8
+ Use this catalog index after you have chosen this catalog for the spec. Do not mix components, actions, computed functions, or render helpers from another catalog unless that catalog explicitly documents compatibility.
9
+
10
+ | Doc | Contents |
11
+ |---|---|
12
+ | [components.md](./components.md) | Component builders/classes, descriptions, events, children support, and prop types. |
13
+ | [actions.md](./actions.md) | Action creators, descriptions, docs, and parameter types. |
14
+ | [computed-functions.md](./computed-functions.md) | Computed function helpers, descriptions, docs, and parameter types. |
15
+ | [types.md](./types.md) | Nested object types referenced by props, action params, and computed function params. |
16
+ | [definitions.md](./definitions.md) | Enum definitions linked from the other catalog docs. |
@@ -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.