@cobaltio/cobalt-js 0.1.1 → 1.0.1

package/docs.md

@@ -9,21 +9,15 @@
 ## Typedefs
 
 <dl>
-<dt><a href="#Field">Field</a> : <code>object</code></dt>
-<dd><p>The Node Field object available for configuration.</p>
-</dd>
-<dt><a href="#Node">Node</a> : <code>object</code></dt>
-<dd><p>The Node object available for configuration.</p>
-</dd>
-<dt><a href="#Workflow">Workflow</a> : <code>object</code></dt>
-<dd><p>The installed workflow.</p>
-</dd>
-<dt><a href="#AppAuthStatus">AppAuthStatus</a> : <code>object</code></dt>
-<dd><p>The auth status of the user for an application.</p>
-</dd>
 <dt><a href="#AppConfig">AppConfig</a> : <code>object</code></dt>
 <dd><p>The configuration data for an application.</p>
 </dd>
+<dt><a href="#AppInstance">AppInstance</a> : <code>Object</code></dt>
+<dd><p>An installed application.</p>
+</dd>
+<dt><a href="#Workflow">Workflow</a> : <code>Object</code></dt>
+<dd><p>The workflow.</p>
+</dd>
 </dl>
 
 <a name="Cobalt"></a>
@@ -32,26 +26,25 @@
 Cobalt Frontend SDK
 
 **Kind**: global class  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| token | <code>String</code> | The session token. |
+
 
 * [Cobalt](#Cobalt)
     * [new Cobalt(options)](#new_Cobalt_new)
-    * [.token](#Cobalt+token) ⇒ <code>string</code>
-    * [.token](#Cobalt+token) ⇒ <code>string</code>
-    * [.baseUrl](#Cobalt+baseUrl) ⇒ <code>string</code>
-    * [.installTemplate()](#Cobalt+installTemplate) ⇒ [<code>Promise.&lt;Workflow&gt;</code>](#Workflow)
+    * [.oauth(application)](#Cobalt+oauth) ⇒ <code>Promise.&lt;Boolean&gt;</code>
+    * [.auth(application, payload)](#Cobalt+auth) ⇒ <code>Promise.&lt;unknown&gt;</code>
+    * [.authCustom(applicationId, payload)](#Cobalt+authCustom) ⇒ <code>Promise.&lt;unknown&gt;</code>
+    * [.checkAuth(application)](#Cobalt+checkAuth) ⇒ <code>Promise.&lt;Boolean&gt;</code>
+    * [.removeAuth(application, [applicationId])](#Cobalt+removeAuth) ⇒ <code>Promise.&lt;void&gt;</code>
     * [.getAppConfig(application)](#Cobalt+getAppConfig) ⇒ [<code>Promise.&lt;AppConfig&gt;</code>](#AppConfig)
-    * [.getAppAuthStatus()](#Cobalt+getAppAuthStatus) ⇒ <code>Promise.&lt;boolean&gt;</code>
-    * [.getAppAuthUrl()](#Cobalt+getAppAuthUrl) ⇒ <code>Promise.&lt;string&gt;</code>
-    * [.oauth()](#Cobalt+oauth) ⇒ <code>Promise.&lt;boolean&gt;</code>
-    * [.setAppAuthData()](#Cobalt+setAppAuthData) ⇒ <code>Promise.&lt;void&gt;</code>
-    * [.removeAppAuth()](#Cobalt+removeAppAuth) ⇒ <code>Promise.&lt;void&gt;</code>
-    * [.getNodeConfiguration()](#Cobalt+getNodeConfiguration) ⇒ <code>Promise.&lt;Array.&lt;Field&gt;&gt;</code>
-    * [.saveNode()](#Cobalt+saveNode) ⇒ [<code>Promise.&lt;Workflow&gt;</code>](#Workflow)
-    * [.getWorkflowConfiguration()](#Cobalt+getWorkflowConfiguration) ⇒ [<code>Promise.&lt;Workflow&gt;</code>](#Workflow)
-    * [.activateWorkflow()](#Cobalt+activateWorkflow) ⇒ <code>Promise.&lt;void&gt;</code>
-    * [.activateWorkflows()](#Cobalt+activateWorkflows) ⇒ <code>Promise.&lt;void&gt;</code>
-    * [.toggleWorkflowStatus()](#Cobalt+toggleWorkflowStatus) ⇒ [<code>Promise.&lt;Workflow&gt;</code>](#Workflow)
-    * [.deleteWorkflow()](#Cobalt+deleteWorkflow) ⇒ <code>Promise.&lt;unknown&gt;</code>
+    * [.install(applicationId, payload)](#Cobalt+install) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
+    * [.getInstallation(applicationId, installationId)](#Cobalt+getInstallation) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
+    * [.updateInstallation(applicationId, installationId, payload)](#Cobalt+updateInstallation) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
+    * [.deleteInstallation(applicationId, installationId)](#Cobalt+deleteInstallation) ⇒ <code>Promise.&lt;unknown&gt;</code>
 
 <a name="new_Cobalt_new"></a>
 
@@ -61,272 +54,174 @@ Cobalt Frontend SDK
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| options | <code>object</code> |  | The options to configure the Cobalt SDK. |
-| [options.token] | <code>string</code> |  | The session token. |
-| [options.baseUrl] | <code>string</code> | <code>&quot;https://api.gocobalt.io&quot;</code> | The base URL of your Cobalt API. |
-
-<a name="Cobalt+token"></a>
-
-### cobalt.token ⇒ <code>string</code>
-**Kind**: instance property of [<code>Cobalt</code>](#Cobalt)  
-**Returns**: <code>string</code> - The session token.  
-<a name="Cobalt+token"></a>
-
-### cobalt.token ⇒ <code>string</code>
-**Kind**: instance property of [<code>Cobalt</code>](#Cobalt)  
-**Returns**: <code>string</code> - The session token.  
-<a name="Cobalt+baseUrl"></a>
-
-### cobalt.baseUrl ⇒ <code>string</code>
-**Kind**: instance property of [<code>Cobalt</code>](#Cobalt)  
-**Returns**: <code>string</code> - The base URL of cobalt API.  
-<a name="Cobalt+installTemplate"></a>
-
-### cobalt.installTemplate() ⇒ [<code>Promise.&lt;Workflow&gt;</code>](#Workflow)
-Install the given template.
-
-**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| templateId | <code>string</code> | The ID of the template you want to install. |
-| udf | <code>object</code> | Custom key value pairs you want to store with the installed worklfow. |
-
-<a name="Cobalt+getAppConfig"></a>
-
-### cobalt.getAppConfig(application) ⇒ [<code>Promise.&lt;AppConfig&gt;</code>](#AppConfig)
-Returns the configuration data for the specified application.
-
-**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Returns**: [<code>Promise.&lt;AppConfig&gt;</code>](#AppConfig) - The specified application's configuration data.  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| application | <code>string</code> | The application ID. |
-
-<a name="Cobalt+getAppAuthStatus"></a>
-
-### cobalt.getAppAuthStatus() ⇒ <code>Promise.&lt;boolean&gt;</code>
-Returns the auth status of the user for the specified application.
-
-**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Returns**: <code>Promise.&lt;boolean&gt;</code> - The auth status of the user.  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| application | <code>string</code> | The application type. |
-
-<a name="Cobalt+getAppAuthUrl"></a>
-
-### cobalt.getAppAuthUrl() ⇒ <code>Promise.&lt;string&gt;</code>
-Returns the auth URL that users can use to authenticate themselves to the
-specified application.
-
-**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Returns**: <code>Promise.&lt;string&gt;</code> - The auth URL where users can authenticate themselves.  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| application | <code>string</code> | The application type. |
+| options | <code>Object</code> |  | The options to configure the Cobalt SDK. |
+| [options.token] | <code>String</code> |  | The session token. |
+| [options.baseUrl] | <code>String</code> | <code>https://api.gocobalt.io</code> | The base URL of the Cobalt API. |
 
 <a name="Cobalt+oauth"></a>
 
-### cobalt.oauth() ⇒ <code>Promise.&lt;boolean&gt;</code>
-Handle OAuth for the specified application.
+### cobalt.oauth(application) ⇒ <code>Promise.&lt;Boolean&gt;</code>
+Handle OAuth for the specified native application.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Returns**: <code>Promise.&lt;boolean&gt;</code> - Whether the user authenticated.  
-**Properties**
+**Returns**: <code>Promise.&lt;Boolean&gt;</code> - Whether the user authenticated.  
 
-| Name | Type | Description |
+| Param | Type | Description |
 | --- | --- | --- |
-| application | <code>string</code> | The application type. |
+| application | <code>String</code> | The application type. |
 
-<a name="Cobalt+setAppAuthData"></a>
+<a name="Cobalt+auth"></a>
 
-### cobalt.setAppAuthData() ⇒ <code>Promise.&lt;void&gt;</code>
+### cobalt.auth(application, payload) ⇒ <code>Promise.&lt;unknown&gt;</code>
 Save the auth data that user provides to authenticate themselves to the
-specified application.
+specified native application.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Properties**
 
-| Name | Type | Description |
+| Param | Type | Description |
 | --- | --- | --- |
-| application | <code>string</code> | The application type. |
-| payload | <code>object</code> | The key value pairs of auth data. |
-| appId | <code>object</code> | The application ID in case of custom applications. |
+| application | <code>String</code> | The application type. |
+| payload | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | The key value pairs of auth data. |
 
-<a name="Cobalt+removeAppAuth"></a>
+<a name="Cobalt+authCustom"></a>
 
-### cobalt.removeAppAuth() ⇒ <code>Promise.&lt;void&gt;</code>
-Unauthorize the specified application and remove any associated data from Cobalt.
+### cobalt.authCustom(applicationId, payload) ⇒ <code>Promise.&lt;unknown&gt;</code>
+Save the auth data that user provides to authenticate themselves to the
+specified custom application.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Properties**
 
-| Name | Type | Description |
+| Param | Type | Description |
 | --- | --- | --- |
-| application | <code>string</code> | The application type. |
-| appId | <code>string</code> | The application ID in case of custom applications. |
+| applicationId | <code>String</code> | The application ID of the custom application. |
+| payload | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | The key value pairs of auth data. |
 
-<a name="Cobalt+getNodeConfiguration"></a>
+<a name="Cobalt+checkAuth"></a>
 
-### cobalt.getNodeConfiguration() ⇒ <code>Promise.&lt;Array.&lt;Field&gt;&gt;</code>
-Returns the node configuration data for dynamic fields.
+### cobalt.checkAuth(application) ⇒ <code>Promise.&lt;Boolean&gt;</code>
+Returns the auth status of the user for the specified application.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Properties**
+**Returns**: <code>Promise.&lt;Boolean&gt;</code> - The auth status of the user.  
 
-| Name | Type | Description |
+| Param | Type | Description |
 | --- | --- | --- |
-| workflowId | <code>string</code> | The ID of the workflow. |
-| nodeId | <code>string</code> | The ID of the node. |
-| fieldName | <code>string</code> | The field name for which config data is required. |
-| selectedValues | <code>object</code> | The input data already selected for the node. |
+| application | <code>String</code> | The application type. |
 
-<a name="Cobalt+saveNode"></a>
+<a name="Cobalt+removeAuth"></a>
 
-### cobalt.saveNode() ⇒ [<code>Promise.&lt;Workflow&gt;</code>](#Workflow)
-Save the input data for the specified node.
+### cobalt.removeAuth(application, [applicationId]) ⇒ <code>Promise.&lt;void&gt;</code>
+Unauthorize the specified application and remove any associated data from Cobalt.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Properties**
 
-| Name | Type | Description |
+| Param | Type | Description |
 | --- | --- | --- |
-| workflowId | <code>string</code> | The ID of the workflow. |
-| nodeId | <code>string</code> | The ID of the node. |
-| inputData | <code>object</code> | The input data for the node. |
+| application | <code>String</code> | The application type. |
+| [applicationId] | <code>String</code> | The application ID in case of custom applications. |
 
-<a name="Cobalt+getWorkflowConfiguration"></a>
+<a name="Cobalt+getAppConfig"></a>
 
-### cobalt.getWorkflowConfiguration() ⇒ [<code>Promise.&lt;Workflow&gt;</code>](#Workflow)
-Returns the workflow configuration data.
+### cobalt.getAppConfig(application) ⇒ [<code>Promise.&lt;AppConfig&gt;</code>](#AppConfig)
+Returns the configuration data for the specified application.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Properties**
+**Returns**: [<code>Promise.&lt;AppConfig&gt;</code>](#AppConfig) - The specified application's configuration data.  
 
-| Name | Type | Description |
+| Param | Type | Description |
 | --- | --- | --- |
-| workflowId | <code>string</code> | The ID of the workflow. |
+| application | <code>String</code> | The application ID. |
 
-<a name="Cobalt+activateWorkflow"></a>
+<a name="Cobalt+install"></a>
 
-### cobalt.activateWorkflow() ⇒ <code>Promise.&lt;void&gt;</code>
-Activate the given installed workflow.
+### cobalt.install(applicationId, payload) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
+Install the specified application.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Properties**
+**Returns**: [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance) - The specified application installation.  
 
-| Name | Type | Description |
+| Param | Type | Description |
 | --- | --- | --- |
-| workflowId | <code>string</code> | The ID of the workflow you want to activate. |
+| applicationId | <code>String</code> | The application ID. |
+| payload | [<code>AppInstance</code>](#AppInstance) | The install payload. |
 
-<a name="Cobalt+activateWorkflows"></a>
+<a name="Cobalt+getInstallation"></a>
 
-### cobalt.activateWorkflows() ⇒ <code>Promise.&lt;void&gt;</code>
-Activate the given installed workflows.
+### cobalt.getInstallation(applicationId, installationId) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
+Returns the specified application installation.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Properties**
+**Returns**: [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance) - The specified application installation.  
 
-| Name | Type | Description |
+| Param | Type | Description |
 | --- | --- | --- |
-| workflowIds | <code>string</code> | The list of IDs of the workflows you want to activate. |
+| applicationId | <code>String</code> | The application ID. |
+| installationId | <code>String</code> | The installation ID of the application instance. |
 
-<a name="Cobalt+toggleWorkflowStatus"></a>
+<a name="Cobalt+updateInstallation"></a>
 
-### cobalt.toggleWorkflowStatus() ⇒ [<code>Promise.&lt;Workflow&gt;</code>](#Workflow)
-Toggle the status of the specified workflow.
+### cobalt.updateInstallation(applicationId, installationId, payload) ⇒ [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance)
+Update the specified application installation.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Properties**
+**Returns**: [<code>Promise.&lt;AppInstance&gt;</code>](#AppInstance) - The specified application installation.  
 
-| Name | Type | Description |
+| Param | Type | Description |
 | --- | --- | --- |
-| workflowId | <code>string</code> | The ID of the workflow. |
+| applicationId | <code>String</code> | The application ID. |
+| installationId | <code>String</code> | The installation ID of the application instance. |
+| payload | [<code>AppInstance</code>](#AppInstance) | The update payload. |
 
-<a name="Cobalt+deleteWorkflow"></a>
+<a name="Cobalt+deleteInstallation"></a>
 
-### cobalt.deleteWorkflow() ⇒ <code>Promise.&lt;unknown&gt;</code>
-Delete the specified workflow.
+### cobalt.deleteInstallation(applicationId, installationId) ⇒ <code>Promise.&lt;unknown&gt;</code>
+Delete the specified installation.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Properties**
 
-| Name | Type | Description |
+| Param | Type | Description |
 | --- | --- | --- |
-| workflowId | <code>string</code> | The ID of the workflow. |
+| applicationId | <code>String</code> | The application ID. |
+| installationId | <code>String</code> | The installation ID of the application instance. |
 
-<a name="Field"></a>
+<a name="AppConfig"></a>
 
-## Field : <code>object</code>
-The Node Field object available for configuration.
+## AppConfig : <code>object</code>
+The configuration data for an application.
 
 **Kind**: global typedef  
 **Properties**
 
 | Name | Type | Description |
 | --- | --- | --- |
-| name | <code>string</code> | The field name. |
-| type | <code>string</code> | The input type of the field. |
-| placeholder | <code>string</code> | The placeholder text for the field. |
-| required | <code>boolean</code> | Whether the field is required. |
+| application_data_slots | <code>Array.&lt;DataSlot&gt;</code> | Array of application data slots. |
+| workflows | [<code>Array.&lt;Workflow&gt;</code>](#Workflow) | Array of workflows. |
 
-<a name="Node"></a>
+<a name="AppInstance"></a>
 
-## Node : <code>object</code>
-The Node object available for configuration.
+## AppInstance : <code>Object</code>
+An installed application.
 
 **Kind**: global typedef  
 **Properties**
 
 | Name | Type | Description |
 | --- | --- | --- |
-| node_id | <code>string</code> | The ID of the installed workflow. |
-| node_name | <code>string</code> | The Name of the installed workflow. |
-| fields | [<code>Array.&lt;Field&gt;</code>](#Field) | The applications integrated in the workflow. |
+| [installation_id] | <code>String</code> | Unique ID for the installation. |
+| application_data_slots | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of application data slots and their values. |
+| workflows | [<code>Array.&lt;Workflow&gt;</code>](#Workflow) | Whether the workflow is enabled. |
 
 <a name="Workflow"></a>
 
-## Workflow : <code>object</code>
-The installed workflow.
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| workflow_id | <code>string</code> | The ID of the installed workflow. |
-| applications | <code>Array.&lt;unknown&gt;</code> | The applications integrated in the workflow. |
-| configure | [<code>Array.&lt;Node&gt;</code>](#Node) | The configuration data for the workflow. |
-
-<a name="AppAuthStatus"></a>
-
-## AppAuthStatus : <code>object</code>
-The auth status of the user for an application.
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| status | <code>boolean</code> | Whether the user has authenticated with this application. |
-
-<a name="AppConfig"></a>
-
-## AppConfig : <code>object</code>
-The configuration data for an application.
+## Workflow : <code>Object</code>
+The workflow.
 
 **Kind**: global typedef  
 **Properties**
 
 | Name | Type | Description |
 | --- | --- | --- |
-| application_data_slots | <code>Array.&lt;DataSlot&gt;</code> | Array of application data slots. |
-| templates | <code>Array.&lt;Template&gt;</code> | Array of workflow templates. |
+| id | <code>String</code> | The ID of the workflow. |
+| enabled | <code>Boolean</code> | Whether the workflow is enabled. |
+| data_slots | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of workflow's data slots and their values. |
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobaltio/cobalt-js",
-  "version": "0.1.1",
+  "version": "1.0.1",
   "description": "Cobalt frontend SDK",
   "main": "./cobalt.js",
   "scripts": {
@@ -29,7 +29,6 @@
   },
   "homepage": "https://github.com/Breakout-Embed/cobalt-js#readme",
   "devDependencies": {
-    "foodoc": "^0.0.9",
     "jsdoc": "^4.0.0",
     "jsdoc-to-markdown": "^8.0.0",
     "uglify-js": "^3.17.4"