@cobaltio/cobalt-js 1.0.0 → 1.0.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.
Files changed (4) hide show
  1. package/README.md +11 -11
  2. package/cobalt.js +7 -7
  3. package/docs.md +11 -11
  4. package/package.json +1 -1
package/README.md CHANGED
@@ -65,8 +65,8 @@ cobalt.token = "COBALT_SESSION_TOKEN";
65
65
  <dt><a href="#AppInstance">AppInstance</a> : <code>Object</code></dt>
66
66
  <dd><p>An installed application.</p>
67
67
  </dd>
68
- <dt><a href="#WorkflowTemplate">WorkflowTemplate</a> : <code>Object</code></dt>
69
- <dd><p>The workflow template.</p>
68
+ <dt><a href="#Workflow">Workflow</a> : <code>Object</code></dt>
69
+ <dd><p>The workflow.</p>
70
70
  </dd>
71
71
  </dl>
72
72
 
@@ -245,7 +245,7 @@ The configuration data for an application.
245
245
  | Name | Type | Description |
246
246
  | --- | --- | --- |
247
247
  | application_data_slots | <code>Array.&lt;DataSlot&gt;</code> | Array of application data slots. |
248
- | templates | <code>Array.&lt;Template&gt;</code> | Array of workflow templates. |
248
+ | workflows | [<code>Array.&lt;Workflow&gt;</code>](#Workflow) | Array of workflows. |
249
249
 
250
250
  <a name="AppInstance"></a>
251
251
 
@@ -257,20 +257,20 @@ An installed application.
257
257
 
258
258
  | Name | Type | Description |
259
259
  | --- | --- | --- |
260
- | [intallation_id] | <code>String</code> | Unique ID for the installation. |
260
+ | [installation_id] | <code>String</code> | Unique ID for the installation. |
261
261
  | application_data_slots | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of application data slots and their values. |
262
- | templates | [<code>Array.&lt;WorkflowTemplate&gt;</code>](#WorkflowTemplate) | Whether the workflow template is enabled. |
262
+ | workflows | [<code>Array.&lt;Workflow&gt;</code>](#Workflow) | Whether the workflow is enabled. |
263
263
 
264
- <a name="WorkflowTemplate"></a>
264
+ <a name="Workflow"></a>
265
265
 
266
- ## WorkflowTemplate : <code>Object</code>
267
- The workflow template.
266
+ ## Workflow : <code>Object</code>
267
+ The workflow.
268
268
 
269
269
  **Kind**: global typedef
270
270
  **Properties**
271
271
 
272
272
  | Name | Type | Description |
273
273
  | --- | --- | --- |
274
- | id | <code>String</code> | The ID of the workflow template. |
275
- | enabled | <code>Boolean</code> | Whether the workflow template is enabled. |
276
- | data_slots | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of workflow template's data slots and their values. |
274
+ | id | <code>String</code> | The ID of the workflow. |
275
+ | enabled | <code>Boolean</code> | Whether the workflow is enabled. |
276
+ | data_slots | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of workflow's data slots and their values. |
package/cobalt.js CHANGED
@@ -183,7 +183,7 @@ class Cobalt {
183
183
  /**
184
184
  * @typedef {object} AppConfig The configuration data for an application.
185
185
  * @property {DataSlot[]} application_data_slots Array of application data slots.
186
- * @property {Template[]} templates Array of workflow templates.
186
+ * @property {Workflow[]} workflows Array of workflows.
187
187
  */
188
188
 
189
189
  /**
@@ -207,16 +207,16 @@ class Cobalt {
207
207
 
208
208
  /**
209
209
  * @typedef {Object} AppInstance An installed application.
210
- * @property {String} [intallation_id] Unique ID for the installation.
210
+ * @property {String} [installation_id] Unique ID for the installation.
211
211
  * @property {Object.<string, string | number | boolean>} application_data_slots A map of application data slots and their values.
212
- * @property {WorkflowTemplate[]} templates Whether the workflow template is enabled.
212
+ * @property {Workflow[]} workflows Whether the workflow is enabled.
213
213
  */
214
214
 
215
215
  /**
216
- * @typedef {Object} WorkflowTemplate The workflow template.
217
- * @property {String} id The ID of the workflow template.
218
- * @property {Boolean} enabled Whether the workflow template is enabled.
219
- * @property {Object.<string, string | number | boolean>} data_slots A map of workflow template's data slots and their values.
216
+ * @typedef {Object} Workflow The workflow.
217
+ * @property {String} id The ID of the workflow.
218
+ * @property {Boolean} enabled Whether the workflow is enabled.
219
+ * @property {Object.<string, string | number | boolean>} data_slots A map of workflow's data slots and their values.
220
220
  */
221
221
 
222
222
  /**
package/docs.md CHANGED
@@ -15,8 +15,8 @@
15
15
  <dt><a href="#AppInstance">AppInstance</a> : <code>Object</code></dt>
16
16
  <dd><p>An installed application.</p>
17
17
  </dd>
18
- <dt><a href="#WorkflowTemplate">WorkflowTemplate</a> : <code>Object</code></dt>
19
- <dd><p>The workflow template.</p>
18
+ <dt><a href="#Workflow">Workflow</a> : <code>Object</code></dt>
19
+ <dd><p>The workflow.</p>
20
20
  </dd>
21
21
  </dl>
22
22
 
@@ -195,7 +195,7 @@ The configuration data for an application.
195
195
  | Name | Type | Description |
196
196
  | --- | --- | --- |
197
197
  | application_data_slots | <code>Array.&lt;DataSlot&gt;</code> | Array of application data slots. |
198
- | templates | <code>Array.&lt;Template&gt;</code> | Array of workflow templates. |
198
+ | workflows | [<code>Array.&lt;Workflow&gt;</code>](#Workflow) | Array of workflows. |
199
199
 
200
200
  <a name="AppInstance"></a>
201
201
 
@@ -207,21 +207,21 @@ An installed application.
207
207
 
208
208
  | Name | Type | Description |
209
209
  | --- | --- | --- |
210
- | [intallation_id] | <code>String</code> | Unique ID for the installation. |
210
+ | [installation_id] | <code>String</code> | Unique ID for the installation. |
211
211
  | application_data_slots | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of application data slots and their values. |
212
- | templates | [<code>Array.&lt;WorkflowTemplate&gt;</code>](#WorkflowTemplate) | Whether the workflow template is enabled. |
212
+ | workflows | [<code>Array.&lt;Workflow&gt;</code>](#Workflow) | Whether the workflow is enabled. |
213
213
 
214
- <a name="WorkflowTemplate"></a>
214
+ <a name="Workflow"></a>
215
215
 
216
- ## WorkflowTemplate : <code>Object</code>
217
- The workflow template.
216
+ ## Workflow : <code>Object</code>
217
+ The workflow.
218
218
 
219
219
  **Kind**: global typedef
220
220
  **Properties**
221
221
 
222
222
  | Name | Type | Description |
223
223
  | --- | --- | --- |
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.&lt;string, (string\|number\|boolean)&gt;</code> | A map of workflow template's data slots and their values. |
224
+ | id | <code>String</code> | The ID of the workflow. |
225
+ | enabled | <code>Boolean</code> | Whether the workflow is enabled. |
226
+ | data_slots | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of workflow's data slots and their values. |
227
227
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cobaltio/cobalt-js",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Cobalt frontend SDK",
5
5
  "main": "./cobalt.js",
6
6
  "scripts": {