@rippling/pebble-sdui-web 0.4.2 → 0.6.3

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.
@@ -9,8 +9,8 @@ Navigate to a URL path.
9
9
 
10
10
  Page URLs: `/custom-apps/{app_id}/sdui/{page_id}`. Use openInNewTab for external links.
11
11
 
12
- Catalog key: `navigate`
13
- Creator: `navigate`
12
+ Catalog key: `navigate`
13
+ Creator: `navigate`
14
14
  Params type: `NavigateParams`
15
15
 
16
16
  ### Params
@@ -34,8 +34,8 @@ on: {
34
34
 
35
35
  Append an item to an array in state. Optionally clear another state path.
36
36
 
37
- Catalog key: `pushState`
38
- Creator: `pushState`
37
+ Catalog key: `pushState`
38
+ Creator: `pushState`
39
39
  Params type: `PushStateParams`
40
40
 
41
41
  ### Params
@@ -60,8 +60,8 @@ on: {
60
60
 
61
61
  Remove an item from an array in state by index.
62
62
 
63
- Catalog key: `removeState`
64
- Creator: `removeState`
63
+ Catalog key: `removeState`
64
+ Creator: `removeState`
65
65
  Params type: `RemoveStateParams`
66
66
 
67
67
  ### Params
@@ -85,8 +85,8 @@ on: {
85
85
 
86
86
  Update a value in the state model at the given statePath.
87
87
 
88
- Catalog key: `setState`
89
- Creator: `setState`
88
+ Catalog key: `setState`
89
+ Creator: `setState`
90
90
  Params type: `SetStateParams`
91
91
 
92
92
  ### Params
@@ -110,8 +110,8 @@ on: {
110
110
 
111
111
  Show a toast notification. Auto-dismisses after 7 seconds.
112
112
 
113
- Catalog key: `showNotification`
114
- Creator: `showNotification`
113
+ Catalog key: `showNotification`
114
+ Creator: `showNotification`
115
115
  Params type: `ShowNotificationParams`
116
116
 
117
117
  ### Params
@@ -133,26 +133,20 @@ on: {
133
133
 
134
134
  ## triggerFunction
135
135
 
136
- Call a Rippling Function. Extra params are sent as event.parameters.
136
+ Call a Rippling Function. params.inputs is sent as event.parameters. Legacy top-level action and extra params are still supported.
137
137
 
138
+ inputs: preferred format for function inputs. Must include action; extra keys are sent to the server as event.parameters.
138
139
  responsePath (client-side): stores response body at that state path. Body must match the state shape (e.g. array, NOT wrapped in { data: [...] }).
139
140
  onSuccess (client-side): runs after handler resolves. Must use { set: { "/path": value } } format, NOT actions.set().
140
141
  onError (client-side): runs if handler throws. Same format as onSuccess.
141
- Extra params (beyond functionId, action, responsePath, onSuccess, onError) are sent to the server as event.parameters.
142
142
 
143
- Catalog key: `triggerFunction`
144
- Creator: `triggerFunction`
143
+ Catalog key: `triggerFunction`
144
+ Creator: `triggerFunction`
145
145
  Params type: `TriggerFunctionParams`
146
146
 
147
147
  ### Params
148
148
 
149
- | Name | Required | Type | Description |
150
- |---|---:|---|---|
151
- | `action` | yes | string | |
152
- | `functionId` | yes | string | |
153
- | `onError` | no | unknown | |
154
- | `onSuccess` | no | unknown | |
155
- | `responsePath` | no | string | |
149
+ _No fields._
156
150
 
157
151
  No additional properties.
158
152