@cobaltio/cobalt-js 0.0.18 → 0.0.20

package/README.md

@@ -88,12 +88,14 @@ 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>
+    * [.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>
 
@@ -164,6 +166,19 @@ specified application.
 | --- | --- | --- |
 | application | <code>string</code> | The application type. |
 
+<a name="Cobalt+oauth"></a>
+
+### cobalt.oauth() ⇒ <code>Promise.&lt;boolean&gt;</code>
+Handle OAuth for the specified application.
+
+**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
+**Returns**: <code>Promise.&lt;boolean&gt;</code> - Whether the user authenticated.
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| application | <code>string</code> | The application type. |
+
 <a name="Cobalt+setAppAuthData"></a>
 
 ### cobalt.setAppAuthData() ⇒ <code>Promise.&lt;void&gt;</code>
@@ -177,6 +192,7 @@ specified application.
 | --- | --- | --- |
 | 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. |
 
 <a name="Cobalt+removeAppAuth"></a>
 
@@ -189,6 +205,7 @@ Unauthorize the specified application and remove any associated data from Cobalt
 | Name | Type | Description |
 | --- | --- | --- |
 | application | <code>string</code> | The application type. |
+| appId | <code>string</code> | The application ID in case of custom applications. |
 
 <a name="Cobalt+getNodeConfiguration"></a>
 
@@ -243,6 +260,18 @@ Activate the given installed workflow.
 | --- | --- | --- |
 | workflowId | <code>string</code> | The ID of the workflow you want to activate. |
 
+<a name="Cobalt+activateWorkflows"></a>
+
+### cobalt.activateWorkflows() ⇒ <code>Promise.&lt;void&gt;</code>
+Activate the given installed workflows.
+
+**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| workflowIds | <code>string</code> | The list of IDs of the workflows you want to activate. |
+
 <a name="Cobalt+toggleWorkflowStatus"></a>
 
 ### cobalt.toggleWorkflowStatus() ⇒ [<code>Promise.&lt;Workflow&gt;</code>](#Workflow)

package/cobalt.js

@@ -125,6 +125,49 @@ class Cobalt {
         return data?.auth_url;
     }
 
+    /**
+     * Handle OAuth for the specified application.
+     * @property {string} application The application type.
+     * @returns {Promise<boolean>} Whether the user authenticated.
+     */
+    async oauth(application) {
+        return new Promise((resolve, reject) => {
+            this.getAppAuthUrl(application)
+            .then(oauthUrl => {
+                const connectWindow = window.open(oauthUrl);
+
+                // keep checking connection status
+                const interval = setInterval(() => {
+                    this.getAppAuthStatus(application)
+                    .then(connected => {
+                        if (connected === true) {
+                            // close auth window
+                            connectWindow?.close();
+                            // clear interval
+                            clearInterval(interval);
+                            // resovle status
+                            resolve(true);
+                        } else {
+                            // user closed oauth window without authenticating
+                            if (connectWindow?.closed) {
+                                // clear interval
+                                clearInterval(interval);
+                                // resolve status
+                                resolve(false);
+                            }
+                        }
+                    })
+                    .catch(e => {
+                        console.error(e);
+                        clearInterval(interval);
+                        reject(e);
+                    });
+                }, 3e3);
+            })
+            .catch(reject);
+        });
+    }
+
     /**
      * Save the auth data that user provides to authenticate themselves to the
      * specified application.
@@ -250,7 +293,7 @@ class Cobalt {
      * @property {string} workflowId The ID of the workflow you want to activate.
      * @returns {Promise<void>}
      */
-     async activateWorkflow(workflowId) {
+    async activateWorkflow(workflowId) {
         const res = await fetch(`${this.baseUrl}/api/v2/workflow/${workflowId}/install/success`, {
             method: "PUT",
             headers: {
@@ -265,6 +308,29 @@ class Cobalt {
         return await res.json();
     }
 
+    /**
+     * Activate the given installed workflows.
+     * @property {string} workflowIds The list of IDs of the workflows you want to activate.
+     * @returns {Promise<void>}
+     */
+    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();
+    }
+
     /**
      * Toggle the status of the specified workflow.
      * @property {string} workflowId The ID of the workflow.

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 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 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: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 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 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;

package/docs.md

@@ -38,12 +38,14 @@ 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>
+    * [.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>
 
@@ -114,6 +116,19 @@ specified application.
 | --- | --- | --- |
 | application | <code>string</code> | The application type. |
 
+<a name="Cobalt+oauth"></a>
+
+### cobalt.oauth() ⇒ <code>Promise.&lt;boolean&gt;</code>
+Handle OAuth for the specified application.
+
+**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
+**Returns**: <code>Promise.&lt;boolean&gt;</code> - Whether the user authenticated.  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| application | <code>string</code> | The application type. |
+
 <a name="Cobalt+setAppAuthData"></a>
 
 ### cobalt.setAppAuthData() ⇒ <code>Promise.&lt;void&gt;</code>
@@ -195,6 +210,18 @@ Activate the given installed workflow.
 | --- | --- | --- |
 | workflowId | <code>string</code> | The ID of the workflow you want to activate. |
 
+<a name="Cobalt+activateWorkflows"></a>
+
+### cobalt.activateWorkflows() ⇒ <code>Promise.&lt;void&gt;</code>
+Activate the given installed workflows.
+
+**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| workflowIds | <code>string</code> | The list of IDs of the workflows you want to activate. |
+
 <a name="Cobalt+toggleWorkflowStatus"></a>
 
 ### cobalt.toggleWorkflowStatus() ⇒ [<code>Promise.&lt;Workflow&gt;</code>](#Workflow)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobaltio/cobalt-js",
-  "version": "0.0.18",
+  "version": "0.0.20",
   "description": "Cobalt frontend SDK",
   "main": "./cobalt.js",
   "scripts": {
@@ -30,8 +30,8 @@
   "homepage": "https://github.com/Breakout-Embed/cobalt-js#readme",
   "devDependencies": {
     "foodoc": "^0.0.9",
-    "jsdoc": "^3.6.11",
-    "jsdoc-to-markdown": "^7.1.1",
-    "uglify-js": "^3.17.0"
+    "jsdoc": "^4.0.0",
+    "jsdoc-to-markdown": "^8.0.0",
+    "uglify-js": "^3.17.4"
   }
 }