@rippling/pebble-sdui-web 0.8.0 → 0.9.1
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/custom-apps/action-params.d.ts +4 -0
- package/dist/catalogs/custom-apps/actions.d.ts +2 -1
- package/dist/catalogs/custom-apps/catalog.d.ts +2 -2
- package/dist/catalogs/custom-apps/component-events.d.ts +16 -14
- package/dist/catalogs/custom-apps/component-props.d.ts +1041 -260
- package/dist/catalogs/custom-apps/components.d.ts +5 -3
- package/dist/catalogs/custom-apps/index.cjs +4 -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 +5983 -1661
- package/dist/catalogs/custom-apps/index.js.map +1 -1
- package/dist/catalogs/hub_platform/catalog.d.ts +1 -1
- package/dist/catalogs/hub_platform/component-props.d.ts +14 -6
- package/dist/catalogs/hub_platform/index.cjs +1 -1
- package/dist/catalogs/hub_platform/index.cjs.map +1 -1
- package/dist/catalogs/hub_platform/index.d.ts +1 -1
- package/dist/catalogs/hub_platform/index.js +86 -137
- package/dist/catalogs/hub_platform/index.js.map +1 -1
- package/dist/core/catalog-validation.cjs +2 -0
- package/dist/core/catalog-validation.cjs.map +1 -0
- package/dist/core/catalog-validation.d.ts +21 -0
- package/dist/core/catalog-validation.js +245 -0
- package/dist/core/catalog-validation.js.map +1 -0
- package/dist/core/directives.cjs +2 -0
- package/dist/core/directives.cjs.map +1 -0
- package/dist/core/directives.d.ts +72 -0
- package/dist/core/directives.js +35 -0
- package/dist/core/directives.js.map +1 -0
- package/dist/core/expressions.d.ts +5 -15
- package/dist/core/index.cjs +1 -1
- package/dist/core/index.d.ts +2 -0
- package/dist/core/index.js +28 -20
- package/dist/core/index.js.map +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/actions.md +31 -2
- package/dist/docs/typescript/web/catalogs/custom-apps/components.md +468 -291
- package/dist/docs/typescript/web/catalogs/custom-apps/definitions.md +250 -288
- package/dist/docs/typescript/web/catalogs/custom-apps/readme.md +1 -1
- package/dist/docs/typescript/web/catalogs/custom-apps/types.md +1362 -148
- package/dist/docs/typescript/web/catalogs/hub_platform/components.md +1 -1
- package/dist/docs/typescript/web/catalogs/hub_platform/types.md +14 -0
- package/dist/index.cjs +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +25 -17
- package/dist/index.js.map +1 -1
- package/dist/sdk-docs.cjs +208 -1
- package/dist/sdk-docs.cjs.map +1 -1
- package/dist/sdk-docs.js +213 -0
- package/dist/sdk-docs.js.map +1 -1
- package/package.json +1 -1
|
@@ -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.
|
|
@@ -133,9 +161,10 @@ on: {
|
|
|
133
161
|
|
|
134
162
|
## triggerFunction
|
|
135
163
|
|
|
136
|
-
Call a Rippling Function. params.inputs is sent as event.parameters.
|
|
164
|
+
Call a Rippling Function. params.inputs is sent as event.parameters.
|
|
137
165
|
|
|
138
|
-
|
|
166
|
+
functionApiName: API name of the function to invoke.
|
|
167
|
+
inputs: function inputs. Must include action; extra keys are sent to the server as event.parameters.
|
|
139
168
|
responsePath (client-side): stores response body at that state path. Body must match the state shape (e.g. array, NOT wrapped in { data: [...] }).
|
|
140
169
|
onSuccess (client-side): runs after handler resolves. Must use { set: { "/path": value } } format, NOT actions.set().
|
|
141
170
|
onError (client-side): runs if handler throws. Same format as onSuccess.
|