@cobaltio/cobalt-js 0.1.0 → 1.0.0

package/README.md

@@ -21,7 +21,7 @@ yarn add @cobaltio/cobalt-js
 
 #### Browser
 ```js
-<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@0"></script>
+<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@1"></script>
 ```
 
 #### Node
@@ -59,17 +59,14 @@ cobalt.token = "COBALT_SESSION_TOKEN";
 ## Typedefs
 
 <dl>
-<dt><a href="#Field">Field</a> : <code>object</code></dt>
-<dd><p>The Node Field object available for configuration.</p>
+<dt><a href="#AppConfig">AppConfig</a> : <code>object</code></dt>
+<dd><p>The configuration data for an application.</p>
 </dd>
-<dt><a href="#Node">Node</a> : <code>object</code></dt>
-<dd><p>The Node object available for configuration.</p>
+<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 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>
+<dt><a href="#WorkflowTemplate">WorkflowTemplate</a> : <code>Object</code></dt>
+<dd><p>The workflow template.</p>
 </dd>
 </dl>
 
@@ -79,25 +76,25 @@ cobalt.token = "COBALT_SESSION_TOKEN";
 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)
-    * [.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>
+    * [.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)
+    * [.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>
 
@@ -107,246 +104,173 @@ 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+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 |
-| --- | --- | --- |
-| workflowId | <code>string</code> | The ID of the workflow. |
-
-<a name="Field"></a>
-
-## Field : <code>object</code>
-The Node Field object available for configuration.
 
-**Kind**: global typedef
-**Properties**
-
-| Name | Type | Description |
+| Param | 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. |
+| applicationId | <code>String</code> | The application ID. |
+| installationId | <code>String</code> | The installation ID of the application instance. |
 
-<a name="Node"></a>
+<a name="AppConfig"></a>
 
-## Node : <code>object</code>
-The Node object available for configuration.
+## AppConfig : <code>object</code>
+The configuration data for an 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. |
+| 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. |
 
-<a name="Workflow"></a>
+<a name="AppInstance"></a>
 
-## Workflow : <code>object</code>
-The installed workflow.
+## AppInstance : <code>Object</code>
+An installed application.
 
 **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. |
+| [intallation_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. |
+| templates | [<code>Array.&lt;WorkflowTemplate&gt;</code>](#WorkflowTemplate) | Whether the workflow template is enabled. |
 
-<a name="AppAuthStatus"></a>
+<a name="WorkflowTemplate"></a>
 
-## AppAuthStatus : <code>object</code>
-The auth status of the user for an application.
+## WorkflowTemplate : <code>Object</code>
+The workflow template.
 
 **Kind**: global typedef
 **Properties**
 
 | Name | Type | Description |
 | --- | --- | --- |
-| status | <code>boolean</code> | Whether the user has authenticated with this application. |
+| id | <code>String</code> | The ID of the workflow template. |
+| enabled | <code>Boolean</code> | Whether the workflow template is enabled. |
+| data_slots | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of workflow template's data slots and their values. |

package/cobalt.js

@@ -1,116 +1,35 @@
 /**
  * Cobalt Frontend SDK
+ * @property {String} token The session token.
  */
 class Cobalt {
     /**
      * Cobalt Frontend SDK
-     * @param {object} options The options to configure the Cobalt SDK.
-     * @param {string} [options.token] The session token.
-     * @param {string} [options.baseUrl=https://api.gocobalt.io] The base URL of your Cobalt API.
+     * @param {Object} options The options to configure the Cobalt SDK.
+     * @param {String} [options.token] The session token.
+     * @param {String} [options.baseUrl=https://api.gocobalt.io] The base URL of the Cobalt API.
      */
     constructor(options) {
-        this.apiBaseUrl = options?.baseUrl || "https://api.gocobalt.io";
+        this.baseUrl = options?.baseUrl || "https://api.gocobalt.io";
         this.token = options?.token;
     }
 
-    /**
-     * @returns {string} The session token.
-     */
     get token() {
         return this.sessionToken;
     };
 
-    /**
-     * @returns {string} The session token.
-     */
     set token(token) {
         return this.sessionToken = typeof token === "string" ? token : "";
     };
 
-    /**
-     * @returns {string} The base URL of cobalt API.
-     */
-    get baseUrl() {
-        return this.apiBaseUrl;
-    };
-
-    /**
-     * @typedef {object} Field The Node Field object available for configuration.
-     * @property {string} name The field name.
-     * @property {string} type The input type of the field.
-     * @property {string} placeholder The placeholder text for the field.
-     * @property {boolean} required Whether the field is required.
-     */
-
-    /**
-     * @typedef {object} Node The Node object available for configuration.
-     * @property {string} node_id The ID of the installed workflow.
-     * @property {string} node_name The Name of the installed workflow.
-     * @property {Field[]} fields The applications integrated in the workflow.
-     */
-
-    /**
-     * @typedef {object} Workflow The installed workflow.
-     * @property {string} workflow_id The ID of the installed workflow.
-     * @property {unknown[]} applications The applications integrated in the workflow.
-     * @property {Node[]} configure The configuration data for the workflow.
-     */
-
-    /**
-     * @typedef {object} AppAuthStatus The auth status of the user for an application.
-     * @property {boolean} status Whether the user has authenticated with this application.
-     */
-
-    /**
-     * Install the given template.
-     * @property {string} templateId The ID of the template you want to install.
-     * @property {object} udf Custom key value pairs you want to store with the installed worklfow.
-     * @returns {Promise<Workflow>}
-     */
-    async installTemplate(templateId, udf = {}) {
-        const res = await fetch(`${this.baseUrl}/api/v1/template/install/${templateId}`, {
-            method: "POST",
-            headers: {
-                authorization: `Bearer ${this.token}`,
-                "content-type": "application/json",
-            },
-            body: JSON.stringify({ udf }),
-        });
-
-        if (res.status >= 400 && res.status < 600) {
-            throw new Error(res.statusText);
-        }
-
-        return await res.json();
-    }
-
-    /**
-     * Returns the auth status of the user for the specified application.
-     * @property {string} application The application type.
-     * @returns {Promise<boolean>} The auth status of the user.
-     */
-    async getAppAuthStatus(application) {
-        const res = await fetch(`${this.baseUrl}/api/v1/linked-acc/integration/auth?integration_type=${application}`, {
-            headers: {
-                authorization: `Bearer ${this.token}`,
-            },
-        });
-
-        if (res.status >= 400 && res.status < 600) {
-            throw new Error(res.statusText);
-        }
-
-        const data = await res.json();
-        return !!data?.status;
-    }
-
     /**
      * Returns the auth URL that users can use to authenticate themselves to the
      * specified application.
-     * @property {string} application The application type.
-     * @returns {Promise<string>} The auth URL where users can authenticate themselves.
+     * @private
+     * @param {String} application The application type.
+     * @returns {Promise<String>} The auth URL where users can authenticate themselves.
      */
-    async getAppAuthUrl(application) {
+    async getOAuthUrl(application) {
         const res = await fetch(`${this.baseUrl}/api/v1/${application}/integrate`, {
             headers: {
                 authorization: `Bearer ${this.token}`,
@@ -126,19 +45,19 @@ class Cobalt {
     }
 
     /**
-     * Handle OAuth for the specified application.
-     * @property {string} application The application type.
-     * @returns {Promise<boolean>} Whether the user authenticated.
+     * Handle OAuth for the specified native application.
+     * @param {String} application The application type.
+     * @returns {Promise<Boolean>} Whether the user authenticated.
      */
     async oauth(application) {
         return new Promise((resolve, reject) => {
-            this.getAppAuthUrl(application)
+            this.getOAuthUrl(application)
             .then(oauthUrl => {
                 const connectWindow = window.open(oauthUrl);
 
                 // keep checking connection status
                 const interval = setInterval(() => {
-                    this.getAppAuthStatus(application)
+                    this.checkAuth(application)
                     .then(connected => {
                         if (connected === true) {
                             // close auth window
@@ -170,14 +89,13 @@ class Cobalt {
 
     /**
      * Save the auth data that user provides to authenticate themselves to the
-     * specified application.
-     * @property {string} application The application type.
-     * @property {object} payload The key value pairs of auth data.
-     * @property {object} appId The application ID in case of custom applications.
-     * @returns {Promise<void>}
+     * specified native application.
+     * @param {String} application The application type.
+     * @param {Object.<string, string | number | boolean>} payload The key value pairs of auth data.
+     * @returns {Promise<unknown>}
      */
-    async setAppAuthData(application, payload, appId) {
-        const res = await fetch(appId ? `${this.baseUrl}/api/v1/${application}/${appId}/save` : `${this.baseUrl}/api/v1/${application}/save`, {
+    async auth(application, payload) {
+        const res = await fetch(`${this.baseUrl}/api/v1/${application}/save`, {
             method: "POST",
             headers: {
                 authorization: `Bearer ${this.token}`,
@@ -197,93 +115,84 @@ class Cobalt {
     }
 
     /**
-     * Unauthorize the specified application and remove any associated data from Cobalt.
-     * @property {string} application The application type.
-     * @property {string} appId The application ID in case of custom applications.
-     * @returns {Promise<void>}
+     * Save the auth data that user provides to authenticate themselves to the
+     * specified custom application.
+     * @param {String} applicationId The application ID of the custom application.
+     * @param {Object.<string, string | number | boolean>} payload The key value pairs of auth data.
+     * @returns {Promise<unknown>}
      */
-    async removeAppAuth(application, appId) {
-        const res = await fetch(`${this.baseUrl}/api/v1/linked-acc/integration/${application}?app_id=${appId}`, {
-            method: "DELETE",
+    async authCustom(applicationId, payload) {
+        const res = await fetch(`${this.baseUrl}/api/v1/custom/${applicationId}/save`, {
+            method: "POST",
             headers: {
                 authorization: `Bearer ${this.token}`,
+                "content-type": "application/json",
             },
+            body: JSON.stringify({
+                ...payload,
+            }),
         });
 
         if (res.status >= 400 && res.status < 600) {
             throw new Error(res.statusText);
         }
+
+        const data = await res.json();
+        return data;
     }
 
     /**
-     * Returns the node configuration data for dynamic fields.
-     * @property {string} workflowId The ID of the workflow.
-     * @property {string} nodeId The ID of the node.
-     * @property {string} fieldName The field name for which config data is required.
-     * @property {object} selectedValues The input data already selected for the node.
-     * @returns {Promise<Field[]>}
+     * Returns the auth status of the user for the specified application.
+     * @param {String} application The application type.
+     * @returns {Promise<Boolean>} The auth status of the user.
      */
-    async getNodeConfiguration(workflowId, nodeId, fieldName, selectedValues = {}) {
-        const res = await fetch(`${this.baseUrl}/api/v1/workflow/${workflowId}/node/${nodeId}/configuration`, {
-            method: "POST",
+    async checkAuth(application) {
+        const res = await fetch(`${this.baseUrl}/api/v1/linked-acc/integration/auth?integration_type=${application}`, {
             headers: {
                 authorization: `Bearer ${this.token}`,
-                "content-type": "application/json",
             },
-            body: JSON.stringify({
-                fieldName,
-                selectedValues,
-            }),
         });
 
         if (res.status >= 400 && res.status < 600) {
             throw new Error(res.statusText);
         }
 
-        return await res.json();
+        const data = await res.json();
+        return !!data?.status;
     }
 
     /**
-     * Save the input data for the specified node.
-     * @property {string} workflowId The ID of the workflow.
-     * @property {string} nodeId The ID of the node.
-     * @property {object} inputData The input data for the node.
-     * @returns {Promise<Workflow>}
+     * Unauthorize the specified application and remove any associated data from Cobalt.
+     * @param {String} application The application type.
+     * @param {String} [applicationId] The application ID in case of custom applications.
+     * @returns {Promise<void>}
      */
-    async saveNode(workflowId, nodeId, inputData = {}) {
-        const payload = {};
-        for (const key in inputData) {
-            if (Object.hasOwnProperty.call(inputData, key)) {
-                const value = inputData[key];
-                payload[key] = { value };
-            }
-        }
-
-        const res = await fetch(`${this.baseUrl}/api/v2/workflow/${workflowId}/node/${nodeId}`, {
-            method: "PUT",
+    async removeAuth(application, applicationId) {
+        const res = await fetch(`${this.baseUrl}/api/v1/linked-acc/integration/${application}?app_id=${applicationId}`, {
+            method: "DELETE",
             headers: {
                 authorization: `Bearer ${this.token}`,
-                "content-type": "application/json",
             },
-            body: JSON.stringify({
-                input_data: payload,
-            }),
         });
 
         if (res.status >= 400 && res.status < 600) {
             throw new Error(res.statusText);
         }
-
-        return await res.json();
     }
 
     /**
-     * Returns the workflow configuration data.
-     * @property {string} workflowId The ID of the workflow.
-     * @returns {Promise<Workflow>}
+     * @typedef {object} AppConfig The configuration data for an application.
+     * @property {DataSlot[]} application_data_slots Array of application data slots.
+     * @property {Template[]} templates Array of workflow templates.
+     */
+
+    /**
+     * Returns the configuration data for the specified application.
+     * @param {String} application The application ID.
+     * @returns {Promise<AppConfig>} The specified application's configuration data.
      */
-    async getWorkflowConfiguration(workflowId) {
-        const res = await fetch(`${this.baseUrl}/api/v2/workflow/${workflowId}/configuration`, {
+    async getAppConfig(application) {
+        const res = await fetch(`${this.baseUrl}/api/v1/application/${application}/config`, {
             headers: {
                 authorization: `Bearer ${this.token}`,
             },
@@ -297,16 +206,33 @@ class Cobalt {
     }
 
     /**
-     * Activate the given installed workflow.
-     * @property {string} workflowId The ID of the workflow you want to activate.
-     * @returns {Promise<void>}
+     * @typedef {Object} AppInstance An installed application.
+     * @property {String} [intallation_id] Unique ID for the installation.
+     * @property {Object.<string, string | number | boolean>} application_data_slots A map of application data slots and their values.
+     * @property {WorkflowTemplate[]} templates Whether the workflow template is enabled.
      */
-    async activateWorkflow(workflowId) {
-        const res = await fetch(`${this.baseUrl}/api/v2/workflow/${workflowId}/install/success`, {
-            method: "PUT",
+
+    /**
+     * @typedef {Object} WorkflowTemplate The workflow template.
+     * @property {String} id The ID of the workflow template.
+     * @property {Boolean} enabled Whether the workflow template is enabled.
+     * @property {Object.<string, string | number | boolean>} data_slots A map of workflow template's data slots and their values.
+     */
+
+    /**
+     * Install the specified application.
+     * @param {String} applicationId The application ID.
+     * @param {AppInstance} payload The install payload.
+     * @returns {Promise<AppInstance>} The specified application installation.
+     */
+    async install(applicationId, payload = {}) {
+        const res = await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/install`, {
+            method: "POST",
             headers: {
                 authorization: `Bearer ${this.token}`,
+                "content-type": "application/json",
             },
+            body: JSON.stringify(payload),
         });
 
         if (res.status >= 400 && res.status < 600) {
@@ -317,19 +243,16 @@ class Cobalt {
     }
 
     /**
-     * Activate the given installed workflows.
-     * @property {string} workflowIds The list of IDs of the workflows you want to activate.
-     * @returns {Promise<void>}
+     * Returns the specified application installation.
+     * @param {String} applicationId The application ID.
+     * @param {String} installationId The installation ID of the application instance.
+     * @returns {Promise<AppInstance>} The specified application installation.
      */
-    async activateWorkflows(workflowIds = []) {
-        const res = await fetch(`${this.baseUrl}/api/v2/workflow/install/success`, {
-            method: "PUT",
+    async getInstallation(applicationId, installationId) {
+        const res = await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${installationId}`, {
             headers: {
                 authorization: `Bearer ${this.token}`,
             },
-            body: JSON.stringify({
-                workflow_ids: workflowIds,
-            }),
         });
 
         if (res.status >= 400 && res.status < 600) {
@@ -340,16 +263,20 @@ class Cobalt {
     }
 
     /**
-     * Toggle the status of the specified workflow.
-     * @property {string} workflowId The ID of the workflow.
-     * @returns {Promise<Workflow>}
+     * Update the specified application installation.
+     * @param {String} applicationId The application ID.
+     * @param {String} installationId The installation ID of the application instance.
+     * @param {AppInstance} payload The update payload.
+     * @returns {Promise<AppInstance>} The specified application installation.
      */
-    async toggleWorkflowStatus(workflowId) {
-        const res = await fetch(`${this.baseUrl}/api/v2/workflow/${workflowId}/toggle-status`, {
+    async updateInstallation(applicationId, installationId, payload = {}) {
+        const res = await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${installationId}`, {
             method: "PUT",
             headers: {
                 authorization: `Bearer ${this.token}`,
+                "content-type": "application/json",
             },
+            body: JSON.stringify(payload),
         });
 
         if (res.status >= 400 && res.status < 600) {
@@ -360,12 +287,13 @@ class Cobalt {
     }
 
     /**
-     * Delete the specified workflow.
-     * @property {string} workflowId The ID of the workflow.
+     * Delete the specified installation.
+     * @param {String} applicationId The application ID.
+     * @param {String} installationId The installation ID of the application instance.
      * @returns {Promise<unknown>}
      */
-    async deleteWorkflow(workflowId) {
-        const res = await fetch(`${this.baseUrl}/api/v1/workflow/${workflowId}`, {
+    async deleteInstallation(applicationId, installationId) {
+        const res = await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${installationId}`, {
             method: "DELETE",
             headers: {
                 authorization: `Bearer ${this.token}`,

package/cobalt.min.js

@@ -1 +1 @@
-class Cobalt{constructor(options){this.apiBaseUrl=options?.baseUrl||"https://api.gocobalt.io";this.token=options?.token}get token(){return this.sessionToken}set token(token){return this.sessionToken=typeof token==="string"?token:""}get baseUrl(){return this.apiBaseUrl}async installTemplate(templateId,udf={}){const res=await fetch(`${this.baseUrl}/api/v1/template/install/${templateId}`,{method:"POST",headers:{authorization:`Bearer ${this.token}`,"content-type":"application/json"},body:JSON.stringify({udf:udf})});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async getAppAuthStatus(application){const res=await fetch(`${this.baseUrl}/api/v1/linked-acc/integration/auth?integration_type=${application}`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}const data=await res.json();return!!data?.status}async getAppAuthUrl(application){const res=await fetch(`${this.baseUrl}/api/v1/${application}/integrate`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}const data=await res.json();return data?.auth_url}async oauth(application){return new Promise((resolve,reject)=>{this.getAppAuthUrl(application).then(oauthUrl=>{const connectWindow=window.open(oauthUrl);const interval=setInterval(()=>{this.getAppAuthStatus(application).then(connected=>{if(connected===true){connectWindow?.close();clearInterval(interval);resolve(true)}else{if(connectWindow?.closed){clearInterval(interval);resolve(false)}}}).catch(e=>{console.error(e);clearInterval(interval);reject(e)})},3e3)}).catch(reject)})}async setAppAuthData(application,payload,appId){const res=await fetch(appId?`${this.baseUrl}/api/v1/${application}/${appId}/save`:`${this.baseUrl}/api/v1/${application}/save`,{method:"POST",headers:{authorization:`Bearer ${this.token}`,"content-type":"application/json"},body:JSON.stringify({...payload})});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}const data=await res.json();return data}async removeAppAuth(application,appId){const res=await fetch(`${this.baseUrl}/api/v1/linked-acc/integration/${application}?app_id=${appId}`,{method:"DELETE",headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}}async getNodeConfiguration(workflowId,nodeId,fieldName,selectedValues={}){const res=await fetch(`${this.baseUrl}/api/v1/workflow/${workflowId}/node/${nodeId}/configuration`,{method:"POST",headers:{authorization:`Bearer ${this.token}`,"content-type":"application/json"},body:JSON.stringify({fieldName:fieldName,selectedValues:selectedValues})});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async saveNode(workflowId,nodeId,inputData={}){const payload={};for(const key in inputData){if(Object.hasOwnProperty.call(inputData,key)){const value=inputData[key];payload[key]={value:value}}}const res=await fetch(`${this.baseUrl}/api/v2/workflow/${workflowId}/node/${nodeId}`,{method:"PUT",headers:{authorization:`Bearer ${this.token}`,"content-type":"application/json"},body:JSON.stringify({input_data:payload})});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async getWorkflowConfiguration(workflowId){const res=await fetch(`${this.baseUrl}/api/v2/workflow/${workflowId}/configuration`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async activateWorkflow(workflowId){const res=await fetch(`${this.baseUrl}/api/v2/workflow/${workflowId}/install/success`,{method:"PUT",headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async activateWorkflows(workflowIds=[]){const res=await fetch(`${this.baseUrl}/api/v2/workflow/install/success`,{method:"PUT",headers:{authorization:`Bearer ${this.token}`},body:JSON.stringify({workflow_ids:workflowIds})});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async toggleWorkflowStatus(workflowId){const res=await fetch(`${this.baseUrl}/api/v2/workflow/${workflowId}/toggle-status`,{method:"PUT",headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async deleteWorkflow(workflowId){const res=await fetch(`${this.baseUrl}/api/v1/workflow/${workflowId}`,{method:"DELETE",headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}}module.exports=Cobalt;
+class Cobalt{constructor(options){this.baseUrl=options?.baseUrl||"https://api.gocobalt.io";this.token=options?.token}get token(){return this.sessionToken}set token(token){return this.sessionToken=typeof token==="string"?token:""}async getOAuthUrl(application){const res=await fetch(`${this.baseUrl}/api/v1/${application}/integrate`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}const data=await res.json();return data?.auth_url}async oauth(application){return new Promise((resolve,reject)=>{this.getOAuthUrl(application).then(oauthUrl=>{const connectWindow=window.open(oauthUrl);const interval=setInterval(()=>{this.checkAuth(application).then(connected=>{if(connected===true){connectWindow?.close();clearInterval(interval);resolve(true)}else{if(connectWindow?.closed){clearInterval(interval);resolve(false)}}}).catch(e=>{console.error(e);clearInterval(interval);reject(e)})},3e3)}).catch(reject)})}async auth(application,payload){const res=await fetch(`${this.baseUrl}/api/v1/${application}/save`,{method:"POST",headers:{authorization:`Bearer ${this.token}`,"content-type":"application/json"},body:JSON.stringify({...payload})});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}const data=await res.json();return data}async authCustom(applicationId,payload){const res=await fetch(`${this.baseUrl}/api/v1/custom/${applicationId}/save`,{method:"POST",headers:{authorization:`Bearer ${this.token}`,"content-type":"application/json"},body:JSON.stringify({...payload})});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}const data=await res.json();return data}async checkAuth(application){const res=await fetch(`${this.baseUrl}/api/v1/linked-acc/integration/auth?integration_type=${application}`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}const data=await res.json();return!!data?.status}async removeAuth(application,applicationId){const res=await fetch(`${this.baseUrl}/api/v1/linked-acc/integration/${application}?app_id=${applicationId}`,{method:"DELETE",headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}}async getAppConfig(application){const res=await fetch(`${this.baseUrl}/api/v1/application/${application}/config`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async install(applicationId,payload={}){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/install`,{method:"POST",headers:{authorization:`Bearer ${this.token}`,"content-type":"application/json"},body:JSON.stringify(payload)});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async getInstallation(applicationId,installationId){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${installationId}`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async updateInstallation(applicationId,installationId,payload={}){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${installationId}`,{method:"PUT",headers:{authorization:`Bearer ${this.token}`,"content-type":"application/json"},body:JSON.stringify(payload)});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async deleteInstallation(applicationId,installationId){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${installationId}`,{method:"DELETE",headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}}module.exports=Cobalt;

package/docs.md

@@ -9,17 +9,14 @@
 ## Typedefs
 
 <dl>
-<dt><a href="#Field">Field</a> : <code>object</code></dt>
-<dd><p>The Node Field object available for configuration.</p>
+<dt><a href="#AppConfig">AppConfig</a> : <code>object</code></dt>
+<dd><p>The configuration data for an application.</p>
 </dd>
-<dt><a href="#Node">Node</a> : <code>object</code></dt>
-<dd><p>The Node object available for configuration.</p>
+<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 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>
+<dt><a href="#WorkflowTemplate">WorkflowTemplate</a> : <code>Object</code></dt>
+<dd><p>The workflow template.</p>
 </dd>
 </dl>
 
@@ -29,25 +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)
-    * [.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>
+    * [.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)
+    * [.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>
 
@@ -57,247 +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+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 |
-| --- | --- | --- |
-| workflowId | <code>string</code> | The ID of the workflow. |
-
-<a name="Field"></a>
-
-## Field : <code>object</code>
-The Node Field object available for configuration.
 
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
+| Param | 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. |
+| applicationId | <code>String</code> | The application ID. |
+| installationId | <code>String</code> | The installation ID of the application instance. |
 
-<a name="Node"></a>
+<a name="AppConfig"></a>
 
-## Node : <code>object</code>
-The Node object available for configuration.
+## AppConfig : <code>object</code>
+The configuration data for an 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. |
+| 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. |
 
-<a name="Workflow"></a>
+<a name="AppInstance"></a>
 
-## Workflow : <code>object</code>
-The installed workflow.
+## AppInstance : <code>Object</code>
+An installed application.
 
 **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. |
+| [intallation_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. |
+| templates | [<code>Array.&lt;WorkflowTemplate&gt;</code>](#WorkflowTemplate) | Whether the workflow template is enabled. |
 
-<a name="AppAuthStatus"></a>
+<a name="WorkflowTemplate"></a>
 
-## AppAuthStatus : <code>object</code>
-The auth status of the user for an application.
+## WorkflowTemplate : <code>Object</code>
+The workflow template.
 
 **Kind**: global typedef  
 **Properties**
 
 | Name | Type | Description |
 | --- | --- | --- |
-| status | <code>boolean</code> | Whether the user has authenticated with this application. |
+| id | <code>String</code> | The ID of the workflow template. |
+| enabled | <code>Boolean</code> | Whether the workflow template is enabled. |
+| data_slots | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of workflow template's data slots and their values. |
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobaltio/cobalt-js",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "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"