@rippling/pebble-sdui-web 0.8.0 → 0.9.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/dist/catalogs/ai_gateway/action-params.d.ts +5 -0
- package/dist/catalogs/ai_gateway/actions.d.ts +5 -0
- package/dist/catalogs/ai_gateway/catalog.d.ts +33 -0
- package/dist/catalogs/ai_gateway/component-events.d.ts +6 -0
- package/dist/catalogs/ai_gateway/component-props.d.ts +51 -0
- package/dist/catalogs/ai_gateway/components.d.ts +7 -0
- package/dist/catalogs/ai_gateway/function-params.d.ts +5 -0
- package/dist/catalogs/ai_gateway/functions.d.ts +5 -0
- package/dist/catalogs/ai_gateway/index.cjs +2 -0
- package/dist/catalogs/ai_gateway/index.cjs.map +1 -0
- package/dist/catalogs/ai_gateway/index.d.ts +11 -0
- package/dist/catalogs/ai_gateway/index.js +366 -0
- package/dist/catalogs/ai_gateway/index.js.map +1 -0
- package/dist/catalogs/ai_gateway/render.d.ts +20 -0
- package/dist/catalogs/custom-apps/action-params.d.ts +4 -0
- package/dist/catalogs/custom-apps/actions.d.ts +2 -1
- package/dist/catalogs/custom-apps/component-events.d.ts +15 -14
- package/dist/catalogs/custom-apps/component-props.d.ts +960 -219
- package/dist/catalogs/custom-apps/components.d.ts +4 -3
- package/dist/catalogs/custom-apps/index.cjs +3 -2
- package/dist/catalogs/custom-apps/index.cjs.map +1 -1
- package/dist/catalogs/custom-apps/index.d.ts +5 -5
- package/dist/catalogs/custom-apps/index.js +5725 -1400
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/ai_gateway/actions.md +6 -0
- package/dist/docs/typescript/web/catalogs/ai_gateway/components.md +31 -0
- package/dist/docs/typescript/web/catalogs/ai_gateway/computed-functions.md +6 -0
- package/dist/docs/typescript/web/catalogs/ai_gateway/definitions.md +6 -0
- package/dist/docs/typescript/web/catalogs/ai_gateway/readme.md +16 -0
- package/dist/docs/typescript/web/catalogs/ai_gateway/types.md +75 -0
- package/dist/docs/typescript/web/catalogs/custom-apps/actions.md +28 -0
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +433 -287
- package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +250 -288
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +1307 -157
- package/package.json +6 -1
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
<!-- Auto-generated from catalogs/ai_gateway.catalog.json; do not edit directly. -->
|
|
2
|
+
# ai_gateway Actions
|
|
3
|
+
|
|
4
|
+
Import action creators from `@rippling/pebble-sdui-web/catalogs/ai_gateway`. Read [definitions.md](./definitions.md) for enum values linked from param tables.
|
|
5
|
+
|
|
6
|
+
_This catalog does not define actions._
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
<!-- Auto-generated from catalogs/ai_gateway.catalog.json; do not edit directly. -->
|
|
2
|
+
# ai_gateway Components
|
|
3
|
+
|
|
4
|
+
Import component builders from `@rippling/pebble-sdui-web/catalogs/ai_gateway`. Read [definitions.md](./definitions.md) for enum values linked from prop tables.
|
|
5
|
+
|
|
6
|
+
## ProviderManagement
|
|
7
|
+
|
|
8
|
+
Interactive provider, credential, and model-management page driven by serializable SDUI data.
|
|
9
|
+
|
|
10
|
+
Providers contain credential keys, grouped models, and deprecated models. isLoading replaces model rows with skeletons.
|
|
11
|
+
|
|
12
|
+
Catalog key: `ProviderManagement`
|
|
13
|
+
Builder: `ProviderManagement`
|
|
14
|
+
Props type: `ProviderManagementProps`
|
|
15
|
+
Accepts children: no
|
|
16
|
+
Events: `addProvider`, `providerToggle`, `modelToggle`, `modelAction`
|
|
17
|
+
|
|
18
|
+
### Props
|
|
19
|
+
|
|
20
|
+
| Name | Required | Type | Description |
|
|
21
|
+
|---|---:|---|---|
|
|
22
|
+
| `activeTab` | yes | string | |
|
|
23
|
+
| `addProviderLabel` | yes | string | |
|
|
24
|
+
| `isLoading` | no | boolean | |
|
|
25
|
+
| `providers` | yes | [Provider](./types.md#provider)[] | |
|
|
26
|
+
| `sectionDescription` | yes | string | |
|
|
27
|
+
| `sectionTitle` | yes | string | |
|
|
28
|
+
| `tabs` | yes | string[] | |
|
|
29
|
+
| `title` | yes | string | |
|
|
30
|
+
|
|
31
|
+
No additional properties.
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
<!-- Auto-generated from catalogs/ai_gateway.catalog.json; do not edit directly. -->
|
|
2
|
+
# ai_gateway Computed Functions
|
|
3
|
+
|
|
4
|
+
Import computed function helpers from `@rippling/pebble-sdui-web/catalogs/ai_gateway`. Read [definitions.md](./definitions.md) for enum values linked from param tables.
|
|
5
|
+
|
|
6
|
+
_This catalog does not define computed functions._
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
<!-- Auto-generated from catalogs/ai_gateway.catalog.json; do not edit directly. -->
|
|
2
|
+
# ai_gateway 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
|
+
_This catalog does not define enums._
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
<!-- Auto-generated from catalogs/ai_gateway.catalog.json; do not edit directly. -->
|
|
2
|
+
# ai_gateway Catalog
|
|
3
|
+
|
|
4
|
+
Catalog: `ai_gateway`
|
|
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,75 @@
|
|
|
1
|
+
<!-- Auto-generated from catalogs/ai_gateway.catalog.json; do not edit directly. -->
|
|
2
|
+
# ai_gateway 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
|
+
## DeprecatedModel
|
|
7
|
+
|
|
8
|
+
### Fields
|
|
9
|
+
|
|
10
|
+
| Name | Required | Type | Description |
|
|
11
|
+
|---|---:|---|---|
|
|
12
|
+
| `name` | yes | string | |
|
|
13
|
+
| `id` | yes | string | |
|
|
14
|
+
| `isCompanyDefault` | yes | boolean | |
|
|
15
|
+
| `isDeprecated` | no | boolean | |
|
|
16
|
+
| `isEnabled` | yes | boolean | |
|
|
17
|
+
| `isLatest` | no | boolean | |
|
|
18
|
+
|
|
19
|
+
No additional properties.
|
|
20
|
+
|
|
21
|
+
## Key
|
|
22
|
+
|
|
23
|
+
### Fields
|
|
24
|
+
|
|
25
|
+
| Name | Required | Type | Description |
|
|
26
|
+
|---|---:|---|---|
|
|
27
|
+
| `name` | yes | string | |
|
|
28
|
+
| `description` | yes | string | |
|
|
29
|
+
| `id` | yes | string | |
|
|
30
|
+
|
|
31
|
+
No additional properties.
|
|
32
|
+
|
|
33
|
+
## Model
|
|
34
|
+
|
|
35
|
+
### Fields
|
|
36
|
+
|
|
37
|
+
| Name | Required | Type | Description |
|
|
38
|
+
|---|---:|---|---|
|
|
39
|
+
| `name` | yes | string | |
|
|
40
|
+
| `id` | yes | string | |
|
|
41
|
+
| `isCompanyDefault` | yes | boolean | |
|
|
42
|
+
| `isDeprecated` | no | boolean | |
|
|
43
|
+
| `isEnabled` | yes | boolean | |
|
|
44
|
+
| `isLatest` | no | boolean | |
|
|
45
|
+
|
|
46
|
+
No additional properties.
|
|
47
|
+
|
|
48
|
+
## ModelGroup
|
|
49
|
+
|
|
50
|
+
### Fields
|
|
51
|
+
|
|
52
|
+
| Name | Required | Type | Description |
|
|
53
|
+
|---|---:|---|---|
|
|
54
|
+
| `name` | yes | string | |
|
|
55
|
+
| `models` | yes | [Model](./types.md#model)[] | |
|
|
56
|
+
|
|
57
|
+
No additional properties.
|
|
58
|
+
|
|
59
|
+
## Provider
|
|
60
|
+
|
|
61
|
+
### Fields
|
|
62
|
+
|
|
63
|
+
| Name | Required | Type | Description |
|
|
64
|
+
|---|---:|---|---|
|
|
65
|
+
| `name` | yes | string | |
|
|
66
|
+
| `allowedModelCount` | yes | number | |
|
|
67
|
+
| `brand` | yes | string | |
|
|
68
|
+
| `deprecatedModels` | yes | [DeprecatedModel](./types.md#deprecatedmodel)[] | |
|
|
69
|
+
| `id` | yes | string | |
|
|
70
|
+
| `keys` | yes | [Key](./types.md#key)[] | |
|
|
71
|
+
| `modelGroups` | yes | [ModelGroup](./types.md#modelgroup)[] | |
|
|
72
|
+
| `status` | yes | string | |
|
|
73
|
+
| `totalModelCount` | yes | number | |
|
|
74
|
+
|
|
75
|
+
No additional properties.
|
|
@@ -30,6 +30,34 @@ on: {
|
|
|
30
30
|
}
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
+
## openChatAssistantWithMessage
|
|
34
|
+
|
|
35
|
+
Open Chat Assistant and send an initial message in a new conversation.
|
|
36
|
+
|
|
37
|
+
text: prompt/message that should be sent immediately after Chat Assistant opens.
|
|
38
|
+
target: optional Chat Assistant surface target. Omit to use the default chat surface.
|
|
39
|
+
|
|
40
|
+
Catalog key: `openChatAssistantWithMessage`
|
|
41
|
+
Creator: `openChatAssistantWithMessage`
|
|
42
|
+
Params type: `OpenChatAssistantWithMessageParams`
|
|
43
|
+
|
|
44
|
+
### Params
|
|
45
|
+
|
|
46
|
+
| Name | Required | Type | Description |
|
|
47
|
+
|---|---:|---|---|
|
|
48
|
+
| `target` | no | [openChatAssistantWithMessageTarget](./definitions.md#openchatassistantwithmessagetarget) | Optional Chat Assistant surface target. |
|
|
49
|
+
| `text` | yes | string | Initial message to send in a new Chat Assistant conversation. Must contain at least one non-whitespace character. |
|
|
50
|
+
|
|
51
|
+
No additional properties.
|
|
52
|
+
|
|
53
|
+
### Usage Shape
|
|
54
|
+
|
|
55
|
+
```ts
|
|
56
|
+
on: {
|
|
57
|
+
press: openChatAssistantWithMessage({ ... })
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
33
61
|
## pushState
|
|
34
62
|
|
|
35
63
|
Append an item to an array in state. Optionally clear another state path.
|