@cobaltio/cobalt-js 0.0.14 → 0.0.16

package/README.md

@@ -15,7 +15,7 @@ yarn add @cobaltio/cobalt-js
 
 ## Usage
 
-Check the SDK [documentation](docs.md) for detailed information.
+<!-- Check the SDK [documentation](docs.md) for detailed information. -->
 
 ### Include
 
@@ -45,3 +45,264 @@ const cobalt = new Cobalt();
 // the token you generate for linked accounts using the cobalt backend SDK
 cobalt.token = "COBALT_SESSION_TOKEN";
 ```
+
+### SDK
+
+## Classes
+
+<dl>
+<dt><a href="#Cobalt">Cobalt</a></dt>
+<dd><p>Cobalt Frontend SDK</p>
+</dd>
+</dl>
+
+## 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>
+</dl>
+
+<a name="Cobalt"></a>
+
+## Cobalt
+Cobalt Frontend SDK
+
+**Kind**: global class
+
+* [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>
+    * [.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>
+    * [.toggleWorkflowStatus()](#Cobalt+toggleWorkflowStatus) ⇒ [<code>Promise.&lt;Workflow&gt;</code>](#Workflow)
+    * [.deleteWorkflow()](#Cobalt+deleteWorkflow) ⇒ <code>Promise.&lt;unknown&gt;</code>
+
+<a name="new_Cobalt_new"></a>
+
+### new Cobalt(options)
+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. |
+
+<a name="Cobalt+removeAppAuth"></a>
+
+### cobalt.removeAppAuth() ⇒ <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 |
+| --- | --- | --- |
+| application | <code>string</code> | The application type. |
+
+<a name="Cobalt+getNodeConfiguration"></a>
+
+### cobalt.getNodeConfiguration() ⇒ <code>Promise.&lt;Array.&lt;Field&gt;&gt;</code>
+Returns the node configuration data for dynamic fields.
+
+**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
+**Properties**
+
+| Name | 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. |
+
+<a name="Cobalt+saveNode"></a>
+
+### cobalt.saveNode() ⇒ [<code>Promise.&lt;Workflow&gt;</code>](#Workflow)
+Save the input data for the specified node.
+
+**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
+**Properties**
+
+| Name | 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. |
+
+<a name="Cobalt+getWorkflowConfiguration"></a>
+
+### cobalt.getWorkflowConfiguration() ⇒ [<code>Promise.&lt;Workflow&gt;</code>](#Workflow)
+Returns the workflow configuration data.
+
+**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| workflowId | <code>string</code> | The ID of the workflow. |
+
+<a name="Cobalt+activateWorkflow"></a>
+
+### cobalt.activateWorkflow() ⇒ <code>Promise.&lt;void&gt;</code>
+Activate the given installed workflow.
+
+**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| workflowId | <code>string</code> | The ID of the workflow you want to activate. |
+
+<a name="Cobalt+toggleWorkflowStatus"></a>
+
+### cobalt.toggleWorkflowStatus() ⇒ [<code>Promise.&lt;Workflow&gt;</code>](#Workflow)
+Toggle the status of the specified workflow.
+
+**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| workflowId | <code>string</code> | The ID of the workflow. |
+
+<a name="Cobalt+deleteWorkflow"></a>
+
+### cobalt.deleteWorkflow() ⇒ <code>Promise.&lt;unknown&gt;</code>
+Delete the specified workflow.
+
+**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 |
+| --- | --- | --- |
+| 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. |
+
+<a name="Node"></a>
+
+## Node : <code>object</code>
+The Node object available for configuration.
+
+**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. |
+
+<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. |

package/cobalt.js

@@ -125,6 +125,33 @@ class Cobalt {
         return data?.auth_url;
     }
 
+    /**
+     * 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.
+     * @returns {Promise<void>}
+     */
+    async setAppAuthData(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;
+    }
+
     /**
      * Unauthorize the specified application and remove any associated data from Cobalt.
      * @property {string} application The application type.

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)});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 removeAppAuth(application){const res=await fetch(`${this.baseUrl}/api/v1/linked-acc/integration/${application}`,{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 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:inputData})});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 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.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)});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 setAppAuthData(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 removeAppAuth(application){const res=await fetch(`${this.baseUrl}/api/v1/linked-acc/integration/${application}`,{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 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:inputData})});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 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;

package/docs.md

@@ -38,6 +38,7 @@ Cobalt Frontend SDK
     * [.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>
+    * [.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)
@@ -113,6 +114,20 @@ specified application.
 | --- | --- | --- |
 | application | <code>string</code> | The application type. |
 
+<a name="Cobalt+setAppAuthData"></a>
+
+### cobalt.setAppAuthData() ⇒ <code>Promise.&lt;void&gt;</code>
+Save the auth data that user provides to authenticate themselves to the
+specified application.
+
+**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| application | <code>string</code> | The application type. |
+| payload | <code>object</code> | The key value pairs of auth data. |
+
 <a name="Cobalt+removeAppAuth"></a>
 
 ### cobalt.removeAppAuth() ⇒ <code>Promise.&lt;void&gt;</code>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobaltio/cobalt-js",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "description": "Cobalt frontend SDK",
   "main": "./cobalt.js",
   "scripts": {