@cobaltio/cobalt-js 0.1.1 → 1.0.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/README.md +106 -211
- package/cobalt.js +103 -200
- package/cobalt.min.js +1 -1
- package/docs.md +105 -210
- package/package.json +1 -2
package/docs.md
CHANGED
|
@@ -9,21 +9,15 @@
|
|
|
9
9
|
## Typedefs
|
|
10
10
|
|
|
11
11
|
<dl>
|
|
12
|
-
<dt><a href="#Field">Field</a> : <code>object</code></dt>
|
|
13
|
-
<dd><p>The Node Field object available for configuration.</p>
|
|
14
|
-
</dd>
|
|
15
|
-
<dt><a href="#Node">Node</a> : <code>object</code></dt>
|
|
16
|
-
<dd><p>The Node object available for configuration.</p>
|
|
17
|
-
</dd>
|
|
18
|
-
<dt><a href="#Workflow">Workflow</a> : <code>object</code></dt>
|
|
19
|
-
<dd><p>The installed workflow.</p>
|
|
20
|
-
</dd>
|
|
21
|
-
<dt><a href="#AppAuthStatus">AppAuthStatus</a> : <code>object</code></dt>
|
|
22
|
-
<dd><p>The auth status of the user for an application.</p>
|
|
23
|
-
</dd>
|
|
24
12
|
<dt><a href="#AppConfig">AppConfig</a> : <code>object</code></dt>
|
|
25
13
|
<dd><p>The configuration data for an application.</p>
|
|
26
14
|
</dd>
|
|
15
|
+
<dt><a href="#AppInstance">AppInstance</a> : <code>Object</code></dt>
|
|
16
|
+
<dd><p>An installed application.</p>
|
|
17
|
+
</dd>
|
|
18
|
+
<dt><a href="#WorkflowTemplate">WorkflowTemplate</a> : <code>Object</code></dt>
|
|
19
|
+
<dd><p>The workflow template.</p>
|
|
20
|
+
</dd>
|
|
27
21
|
</dl>
|
|
28
22
|
|
|
29
23
|
<a name="Cobalt"></a>
|
|
@@ -32,26 +26,25 @@
|
|
|
32
26
|
Cobalt Frontend SDK
|
|
33
27
|
|
|
34
28
|
**Kind**: global class
|
|
29
|
+
**Properties**
|
|
30
|
+
|
|
31
|
+
| Name | Type | Description |
|
|
32
|
+
| --- | --- | --- |
|
|
33
|
+
| token | <code>String</code> | The session token. |
|
|
34
|
+
|
|
35
35
|
|
|
36
36
|
* [Cobalt](#Cobalt)
|
|
37
37
|
* [new Cobalt(options)](#new_Cobalt_new)
|
|
38
|
-
* [.
|
|
39
|
-
* [.
|
|
40
|
-
* [.
|
|
41
|
-
* [.
|
|
38
|
+
* [.oauth(application)](#Cobalt+oauth) ⇒ <code>Promise.<Boolean></code>
|
|
39
|
+
* [.auth(application, payload)](#Cobalt+auth) ⇒ <code>Promise.<unknown></code>
|
|
40
|
+
* [.authCustom(applicationId, payload)](#Cobalt+authCustom) ⇒ <code>Promise.<unknown></code>
|
|
41
|
+
* [.checkAuth(application)](#Cobalt+checkAuth) ⇒ <code>Promise.<Boolean></code>
|
|
42
|
+
* [.removeAuth(application, [applicationId])](#Cobalt+removeAuth) ⇒ <code>Promise.<void></code>
|
|
42
43
|
* [.getAppConfig(application)](#Cobalt+getAppConfig) ⇒ [<code>Promise.<AppConfig></code>](#AppConfig)
|
|
43
|
-
* [.
|
|
44
|
-
* [.
|
|
45
|
-
* [.
|
|
46
|
-
* [.
|
|
47
|
-
* [.removeAppAuth()](#Cobalt+removeAppAuth) ⇒ <code>Promise.<void></code>
|
|
48
|
-
* [.getNodeConfiguration()](#Cobalt+getNodeConfiguration) ⇒ <code>Promise.<Array.<Field>></code>
|
|
49
|
-
* [.saveNode()](#Cobalt+saveNode) ⇒ [<code>Promise.<Workflow></code>](#Workflow)
|
|
50
|
-
* [.getWorkflowConfiguration()](#Cobalt+getWorkflowConfiguration) ⇒ [<code>Promise.<Workflow></code>](#Workflow)
|
|
51
|
-
* [.activateWorkflow()](#Cobalt+activateWorkflow) ⇒ <code>Promise.<void></code>
|
|
52
|
-
* [.activateWorkflows()](#Cobalt+activateWorkflows) ⇒ <code>Promise.<void></code>
|
|
53
|
-
* [.toggleWorkflowStatus()](#Cobalt+toggleWorkflowStatus) ⇒ [<code>Promise.<Workflow></code>](#Workflow)
|
|
54
|
-
* [.deleteWorkflow()](#Cobalt+deleteWorkflow) ⇒ <code>Promise.<unknown></code>
|
|
44
|
+
* [.install(applicationId, payload)](#Cobalt+install) ⇒ [<code>Promise.<AppInstance></code>](#AppInstance)
|
|
45
|
+
* [.getInstallation(applicationId, installationId)](#Cobalt+getInstallation) ⇒ [<code>Promise.<AppInstance></code>](#AppInstance)
|
|
46
|
+
* [.updateInstallation(applicationId, installationId, payload)](#Cobalt+updateInstallation) ⇒ [<code>Promise.<AppInstance></code>](#AppInstance)
|
|
47
|
+
* [.deleteInstallation(applicationId, installationId)](#Cobalt+deleteInstallation) ⇒ <code>Promise.<unknown></code>
|
|
55
48
|
|
|
56
49
|
<a name="new_Cobalt_new"></a>
|
|
57
50
|
|
|
@@ -61,272 +54,174 @@ Cobalt Frontend SDK
|
|
|
61
54
|
|
|
62
55
|
| Param | Type | Default | Description |
|
|
63
56
|
| --- | --- | --- | --- |
|
|
64
|
-
| options | <code>
|
|
65
|
-
| [options.token] | <code>
|
|
66
|
-
| [options.baseUrl] | <code>
|
|
67
|
-
|
|
68
|
-
<a name="Cobalt+token"></a>
|
|
69
|
-
|
|
70
|
-
### cobalt.token ⇒ <code>string</code>
|
|
71
|
-
**Kind**: instance property of [<code>Cobalt</code>](#Cobalt)
|
|
72
|
-
**Returns**: <code>string</code> - The session token.
|
|
73
|
-
<a name="Cobalt+token"></a>
|
|
74
|
-
|
|
75
|
-
### cobalt.token ⇒ <code>string</code>
|
|
76
|
-
**Kind**: instance property of [<code>Cobalt</code>](#Cobalt)
|
|
77
|
-
**Returns**: <code>string</code> - The session token.
|
|
78
|
-
<a name="Cobalt+baseUrl"></a>
|
|
79
|
-
|
|
80
|
-
### cobalt.baseUrl ⇒ <code>string</code>
|
|
81
|
-
**Kind**: instance property of [<code>Cobalt</code>](#Cobalt)
|
|
82
|
-
**Returns**: <code>string</code> - The base URL of cobalt API.
|
|
83
|
-
<a name="Cobalt+installTemplate"></a>
|
|
84
|
-
|
|
85
|
-
### cobalt.installTemplate() ⇒ [<code>Promise.<Workflow></code>](#Workflow)
|
|
86
|
-
Install the given template.
|
|
87
|
-
|
|
88
|
-
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
89
|
-
**Properties**
|
|
90
|
-
|
|
91
|
-
| Name | Type | Description |
|
|
92
|
-
| --- | --- | --- |
|
|
93
|
-
| templateId | <code>string</code> | The ID of the template you want to install. |
|
|
94
|
-
| udf | <code>object</code> | Custom key value pairs you want to store with the installed worklfow. |
|
|
95
|
-
|
|
96
|
-
<a name="Cobalt+getAppConfig"></a>
|
|
97
|
-
|
|
98
|
-
### cobalt.getAppConfig(application) ⇒ [<code>Promise.<AppConfig></code>](#AppConfig)
|
|
99
|
-
Returns the configuration data for the specified application.
|
|
100
|
-
|
|
101
|
-
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
102
|
-
**Returns**: [<code>Promise.<AppConfig></code>](#AppConfig) - The specified application's configuration data.
|
|
103
|
-
|
|
104
|
-
| Param | Type | Description |
|
|
105
|
-
| --- | --- | --- |
|
|
106
|
-
| application | <code>string</code> | The application ID. |
|
|
107
|
-
|
|
108
|
-
<a name="Cobalt+getAppAuthStatus"></a>
|
|
109
|
-
|
|
110
|
-
### cobalt.getAppAuthStatus() ⇒ <code>Promise.<boolean></code>
|
|
111
|
-
Returns the auth status of the user for the specified application.
|
|
112
|
-
|
|
113
|
-
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
114
|
-
**Returns**: <code>Promise.<boolean></code> - The auth status of the user.
|
|
115
|
-
**Properties**
|
|
116
|
-
|
|
117
|
-
| Name | Type | Description |
|
|
118
|
-
| --- | --- | --- |
|
|
119
|
-
| application | <code>string</code> | The application type. |
|
|
120
|
-
|
|
121
|
-
<a name="Cobalt+getAppAuthUrl"></a>
|
|
122
|
-
|
|
123
|
-
### cobalt.getAppAuthUrl() ⇒ <code>Promise.<string></code>
|
|
124
|
-
Returns the auth URL that users can use to authenticate themselves to the
|
|
125
|
-
specified application.
|
|
126
|
-
|
|
127
|
-
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
128
|
-
**Returns**: <code>Promise.<string></code> - The auth URL where users can authenticate themselves.
|
|
129
|
-
**Properties**
|
|
130
|
-
|
|
131
|
-
| Name | Type | Description |
|
|
132
|
-
| --- | --- | --- |
|
|
133
|
-
| application | <code>string</code> | The application type. |
|
|
57
|
+
| options | <code>Object</code> | | The options to configure the Cobalt SDK. |
|
|
58
|
+
| [options.token] | <code>String</code> | | The session token. |
|
|
59
|
+
| [options.baseUrl] | <code>String</code> | <code>https://api.gocobalt.io</code> | The base URL of the Cobalt API. |
|
|
134
60
|
|
|
135
61
|
<a name="Cobalt+oauth"></a>
|
|
136
62
|
|
|
137
|
-
### cobalt.oauth() ⇒ <code>Promise.<
|
|
138
|
-
Handle OAuth for the specified application.
|
|
63
|
+
### cobalt.oauth(application) ⇒ <code>Promise.<Boolean></code>
|
|
64
|
+
Handle OAuth for the specified native application.
|
|
139
65
|
|
|
140
66
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
141
|
-
**Returns**: <code>Promise.<
|
|
142
|
-
**Properties**
|
|
67
|
+
**Returns**: <code>Promise.<Boolean></code> - Whether the user authenticated.
|
|
143
68
|
|
|
144
|
-
|
|
|
69
|
+
| Param | Type | Description |
|
|
145
70
|
| --- | --- | --- |
|
|
146
|
-
| application | <code>
|
|
71
|
+
| application | <code>String</code> | The application type. |
|
|
147
72
|
|
|
148
|
-
<a name="Cobalt+
|
|
73
|
+
<a name="Cobalt+auth"></a>
|
|
149
74
|
|
|
150
|
-
### cobalt.
|
|
75
|
+
### cobalt.auth(application, payload) ⇒ <code>Promise.<unknown></code>
|
|
151
76
|
Save the auth data that user provides to authenticate themselves to the
|
|
152
|
-
specified application.
|
|
77
|
+
specified native application.
|
|
153
78
|
|
|
154
79
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
155
|
-
**Properties**
|
|
156
80
|
|
|
157
|
-
|
|
|
81
|
+
| Param | Type | Description |
|
|
158
82
|
| --- | --- | --- |
|
|
159
|
-
| application | <code>
|
|
160
|
-
| payload | <code>
|
|
161
|
-
| appId | <code>object</code> | The application ID in case of custom applications. |
|
|
83
|
+
| application | <code>String</code> | The application type. |
|
|
84
|
+
| payload | <code>Object.<string, (string\|number\|boolean)></code> | The key value pairs of auth data. |
|
|
162
85
|
|
|
163
|
-
<a name="Cobalt+
|
|
86
|
+
<a name="Cobalt+authCustom"></a>
|
|
164
87
|
|
|
165
|
-
### cobalt.
|
|
166
|
-
|
|
88
|
+
### cobalt.authCustom(applicationId, payload) ⇒ <code>Promise.<unknown></code>
|
|
89
|
+
Save the auth data that user provides to authenticate themselves to the
|
|
90
|
+
specified custom application.
|
|
167
91
|
|
|
168
92
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
169
|
-
**Properties**
|
|
170
93
|
|
|
171
|
-
|
|
|
94
|
+
| Param | Type | Description |
|
|
172
95
|
| --- | --- | --- |
|
|
173
|
-
|
|
|
174
|
-
|
|
|
96
|
+
| applicationId | <code>String</code> | The application ID of the custom application. |
|
|
97
|
+
| payload | <code>Object.<string, (string\|number\|boolean)></code> | The key value pairs of auth data. |
|
|
175
98
|
|
|
176
|
-
<a name="Cobalt+
|
|
99
|
+
<a name="Cobalt+checkAuth"></a>
|
|
177
100
|
|
|
178
|
-
### cobalt.
|
|
179
|
-
Returns the
|
|
101
|
+
### cobalt.checkAuth(application) ⇒ <code>Promise.<Boolean></code>
|
|
102
|
+
Returns the auth status of the user for the specified application.
|
|
180
103
|
|
|
181
104
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
182
|
-
**
|
|
105
|
+
**Returns**: <code>Promise.<Boolean></code> - The auth status of the user.
|
|
183
106
|
|
|
184
|
-
|
|
|
107
|
+
| Param | Type | Description |
|
|
185
108
|
| --- | --- | --- |
|
|
186
|
-
|
|
|
187
|
-
| nodeId | <code>string</code> | The ID of the node. |
|
|
188
|
-
| fieldName | <code>string</code> | The field name for which config data is required. |
|
|
189
|
-
| selectedValues | <code>object</code> | The input data already selected for the node. |
|
|
109
|
+
| application | <code>String</code> | The application type. |
|
|
190
110
|
|
|
191
|
-
<a name="Cobalt+
|
|
111
|
+
<a name="Cobalt+removeAuth"></a>
|
|
192
112
|
|
|
193
|
-
### cobalt.
|
|
194
|
-
|
|
113
|
+
### cobalt.removeAuth(application, [applicationId]) ⇒ <code>Promise.<void></code>
|
|
114
|
+
Unauthorize the specified application and remove any associated data from Cobalt.
|
|
195
115
|
|
|
196
116
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
197
|
-
**Properties**
|
|
198
117
|
|
|
199
|
-
|
|
|
118
|
+
| Param | Type | Description |
|
|
200
119
|
| --- | --- | --- |
|
|
201
|
-
|
|
|
202
|
-
|
|
|
203
|
-
| inputData | <code>object</code> | The input data for the node. |
|
|
120
|
+
| application | <code>String</code> | The application type. |
|
|
121
|
+
| [applicationId] | <code>String</code> | The application ID in case of custom applications. |
|
|
204
122
|
|
|
205
|
-
<a name="Cobalt+
|
|
123
|
+
<a name="Cobalt+getAppConfig"></a>
|
|
206
124
|
|
|
207
|
-
### cobalt.
|
|
208
|
-
Returns the
|
|
125
|
+
### cobalt.getAppConfig(application) ⇒ [<code>Promise.<AppConfig></code>](#AppConfig)
|
|
126
|
+
Returns the configuration data for the specified application.
|
|
209
127
|
|
|
210
128
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
211
|
-
**
|
|
129
|
+
**Returns**: [<code>Promise.<AppConfig></code>](#AppConfig) - The specified application's configuration data.
|
|
212
130
|
|
|
213
|
-
|
|
|
131
|
+
| Param | Type | Description |
|
|
214
132
|
| --- | --- | --- |
|
|
215
|
-
|
|
|
133
|
+
| application | <code>String</code> | The application ID. |
|
|
216
134
|
|
|
217
|
-
<a name="Cobalt+
|
|
135
|
+
<a name="Cobalt+install"></a>
|
|
218
136
|
|
|
219
|
-
### cobalt.
|
|
220
|
-
|
|
137
|
+
### cobalt.install(applicationId, payload) ⇒ [<code>Promise.<AppInstance></code>](#AppInstance)
|
|
138
|
+
Install the specified application.
|
|
221
139
|
|
|
222
140
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
223
|
-
**
|
|
141
|
+
**Returns**: [<code>Promise.<AppInstance></code>](#AppInstance) - The specified application installation.
|
|
224
142
|
|
|
225
|
-
|
|
|
143
|
+
| Param | Type | Description |
|
|
226
144
|
| --- | --- | --- |
|
|
227
|
-
|
|
|
145
|
+
| applicationId | <code>String</code> | The application ID. |
|
|
146
|
+
| payload | [<code>AppInstance</code>](#AppInstance) | The install payload. |
|
|
228
147
|
|
|
229
|
-
<a name="Cobalt+
|
|
148
|
+
<a name="Cobalt+getInstallation"></a>
|
|
230
149
|
|
|
231
|
-
### cobalt.
|
|
232
|
-
|
|
150
|
+
### cobalt.getInstallation(applicationId, installationId) ⇒ [<code>Promise.<AppInstance></code>](#AppInstance)
|
|
151
|
+
Returns the specified application installation.
|
|
233
152
|
|
|
234
153
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
235
|
-
**
|
|
154
|
+
**Returns**: [<code>Promise.<AppInstance></code>](#AppInstance) - The specified application installation.
|
|
236
155
|
|
|
237
|
-
|
|
|
156
|
+
| Param | Type | Description |
|
|
238
157
|
| --- | --- | --- |
|
|
239
|
-
|
|
|
158
|
+
| applicationId | <code>String</code> | The application ID. |
|
|
159
|
+
| installationId | <code>String</code> | The installation ID of the application instance. |
|
|
240
160
|
|
|
241
|
-
<a name="Cobalt+
|
|
161
|
+
<a name="Cobalt+updateInstallation"></a>
|
|
242
162
|
|
|
243
|
-
### cobalt.
|
|
244
|
-
|
|
163
|
+
### cobalt.updateInstallation(applicationId, installationId, payload) ⇒ [<code>Promise.<AppInstance></code>](#AppInstance)
|
|
164
|
+
Update the specified application installation.
|
|
245
165
|
|
|
246
166
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
247
|
-
**
|
|
167
|
+
**Returns**: [<code>Promise.<AppInstance></code>](#AppInstance) - The specified application installation.
|
|
248
168
|
|
|
249
|
-
|
|
|
169
|
+
| Param | Type | Description |
|
|
250
170
|
| --- | --- | --- |
|
|
251
|
-
|
|
|
171
|
+
| applicationId | <code>String</code> | The application ID. |
|
|
172
|
+
| installationId | <code>String</code> | The installation ID of the application instance. |
|
|
173
|
+
| payload | [<code>AppInstance</code>](#AppInstance) | The update payload. |
|
|
252
174
|
|
|
253
|
-
<a name="Cobalt+
|
|
175
|
+
<a name="Cobalt+deleteInstallation"></a>
|
|
254
176
|
|
|
255
|
-
### cobalt.
|
|
256
|
-
Delete the specified
|
|
177
|
+
### cobalt.deleteInstallation(applicationId, installationId) ⇒ <code>Promise.<unknown></code>
|
|
178
|
+
Delete the specified installation.
|
|
257
179
|
|
|
258
180
|
**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
|
|
259
|
-
**Properties**
|
|
260
181
|
|
|
261
|
-
|
|
|
262
|
-
| --- | --- | --- |
|
|
263
|
-
| workflowId | <code>string</code> | The ID of the workflow. |
|
|
264
|
-
|
|
265
|
-
<a name="Field"></a>
|
|
266
|
-
|
|
267
|
-
## Field : <code>object</code>
|
|
268
|
-
The Node Field object available for configuration.
|
|
269
|
-
|
|
270
|
-
**Kind**: global typedef
|
|
271
|
-
**Properties**
|
|
272
|
-
|
|
273
|
-
| Name | Type | Description |
|
|
274
|
-
| --- | --- | --- |
|
|
275
|
-
| name | <code>string</code> | The field name. |
|
|
276
|
-
| type | <code>string</code> | The input type of the field. |
|
|
277
|
-
| placeholder | <code>string</code> | The placeholder text for the field. |
|
|
278
|
-
| required | <code>boolean</code> | Whether the field is required. |
|
|
279
|
-
|
|
280
|
-
<a name="Node"></a>
|
|
281
|
-
|
|
282
|
-
## Node : <code>object</code>
|
|
283
|
-
The Node object available for configuration.
|
|
284
|
-
|
|
285
|
-
**Kind**: global typedef
|
|
286
|
-
**Properties**
|
|
287
|
-
|
|
288
|
-
| Name | Type | Description |
|
|
182
|
+
| Param | Type | Description |
|
|
289
183
|
| --- | --- | --- |
|
|
290
|
-
|
|
|
291
|
-
|
|
|
292
|
-
| fields | [<code>Array.<Field></code>](#Field) | The applications integrated in the workflow. |
|
|
184
|
+
| applicationId | <code>String</code> | The application ID. |
|
|
185
|
+
| installationId | <code>String</code> | The installation ID of the application instance. |
|
|
293
186
|
|
|
294
|
-
<a name="
|
|
187
|
+
<a name="AppConfig"></a>
|
|
295
188
|
|
|
296
|
-
##
|
|
297
|
-
The
|
|
189
|
+
## AppConfig : <code>object</code>
|
|
190
|
+
The configuration data for an application.
|
|
298
191
|
|
|
299
192
|
**Kind**: global typedef
|
|
300
193
|
**Properties**
|
|
301
194
|
|
|
302
195
|
| Name | Type | Description |
|
|
303
196
|
| --- | --- | --- |
|
|
304
|
-
|
|
|
305
|
-
|
|
|
306
|
-
| configure | [<code>Array.<Node></code>](#Node) | The configuration data for the workflow. |
|
|
197
|
+
| application_data_slots | <code>Array.<DataSlot></code> | Array of application data slots. |
|
|
198
|
+
| templates | <code>Array.<Template></code> | Array of workflow templates. |
|
|
307
199
|
|
|
308
|
-
<a name="
|
|
200
|
+
<a name="AppInstance"></a>
|
|
309
201
|
|
|
310
|
-
##
|
|
311
|
-
|
|
202
|
+
## AppInstance : <code>Object</code>
|
|
203
|
+
An installed application.
|
|
312
204
|
|
|
313
205
|
**Kind**: global typedef
|
|
314
206
|
**Properties**
|
|
315
207
|
|
|
316
208
|
| Name | Type | Description |
|
|
317
209
|
| --- | --- | --- |
|
|
318
|
-
|
|
|
210
|
+
| [intallation_id] | <code>String</code> | Unique ID for the installation. |
|
|
211
|
+
| application_data_slots | <code>Object.<string, (string\|number\|boolean)></code> | A map of application data slots and their values. |
|
|
212
|
+
| templates | [<code>Array.<WorkflowTemplate></code>](#WorkflowTemplate) | Whether the workflow template is enabled. |
|
|
319
213
|
|
|
320
|
-
<a name="
|
|
214
|
+
<a name="WorkflowTemplate"></a>
|
|
321
215
|
|
|
322
|
-
##
|
|
323
|
-
The
|
|
216
|
+
## WorkflowTemplate : <code>Object</code>
|
|
217
|
+
The workflow template.
|
|
324
218
|
|
|
325
219
|
**Kind**: global typedef
|
|
326
220
|
**Properties**
|
|
327
221
|
|
|
328
222
|
| Name | Type | Description |
|
|
329
223
|
| --- | --- | --- |
|
|
330
|
-
|
|
|
331
|
-
|
|
|
224
|
+
| id | <code>String</code> | The ID of the workflow template. |
|
|
225
|
+
| enabled | <code>Boolean</code> | Whether the workflow template is enabled. |
|
|
226
|
+
| data_slots | <code>Object.<string, (string\|number\|boolean)></code> | A map of workflow template's data slots and their values. |
|
|
332
227
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cobaltio/cobalt-js",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "Cobalt frontend SDK",
|
|
5
5
|
"main": "./cobalt.js",
|
|
6
6
|
"scripts": {
|
|
@@ -29,7 +29,6 @@
|
|
|
29
29
|
},
|
|
30
30
|
"homepage": "https://github.com/Breakout-Embed/cobalt-js#readme",
|
|
31
31
|
"devDependencies": {
|
|
32
|
-
"foodoc": "^0.0.9",
|
|
33
32
|
"jsdoc": "^4.0.0",
|
|
34
33
|
"jsdoc-to-markdown": "^8.0.0",
|
|
35
34
|
"uglify-js": "^3.17.4"
|