@cobaltio/cobalt-js 0.0.6 → 0.0.9

package/README.md

@@ -15,6 +15,8 @@ yarn add @cobaltio/cobalt-js
 
 ## Usage
 
+Check the SDK [documentation](docs.md) for detailed information.
+
 ### Include
 
 #### Browser

package/cobalt.js

@@ -73,6 +73,11 @@ class Cobalt {
                 authorization: `Bearer ${this.token}`,
             },
         });
+
+        if (res.status >= 400 && res.status < 600) {
+            throw new Error(res.statusText);
+        }
+
         return await res.json();
     }
 
@@ -87,6 +92,11 @@ class Cobalt {
                 authorization: `Bearer ${this.token}`,
             },
         });
+
+        if (res.status >= 400 && res.status < 600) {
+            throw new Error(res.statusText);
+        }
+
         const data = await res.json();
         return !!data?.status;
     }
@@ -103,6 +113,11 @@ class Cobalt {
                 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;
     }
@@ -125,6 +140,51 @@ class Cobalt {
                 input_data: inputData,
             }),
         });
+
+        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.
+     * @returns {Promise<Workflow>}
+     */
+    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();
+    }
+
+    /**
+     * Delete the specified workflow.
+     * @property {string} workflowId The ID of the workflow.
+     * @returns {Promise<unknown>}
+     */
+    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();
     }
 }

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){const res=await fetch(`${this.baseUrl}/api/v1/template/install/${templateId}`,{method:"POST",headers:{authorization:`Bearer ${this.token}`}});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}`}});const data=await res.json();return!!data?.status}async getAppAuthUrl(application){const res=await fetch(`${this.baseUrl}/api/v1/google/integrate?type=${application}`,{headers:{authorization:`Bearer ${this.token}`}});const data=await res.json();return data?.auth_url}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})});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){const res=await fetch(`${this.baseUrl}/api/v1/template/install/${templateId}`,{method:"POST",headers:{authorization:`Bearer ${this.token}`}});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/google/integrate?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?.auth_url}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 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

@@ -0,0 +1,203 @@
+## 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>
+    * [.saveNode()](#Cobalt+saveNode) ⇒ [<code>Promise.&lt;Workflow&gt;</code>](#Workflow)
+    * [.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. |
+
+<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+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+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/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@cobaltio/cobalt-js",
-  "version": "0.0.6",
+  "version": "0.0.9",
   "description": "Cobalt frontend SDK",
   "main": "./cobalt.js",
   "scripts": {
     "build": "uglifyjs cobalt.js -o cobalt.min.js",
-    "docgen": "jsdoc . -R README.md -d docs",
+    "docgen": "jsdoc2md cobalt.js > docs.md",
     "test": "echo \"Warn: no test specified\""
   },
   "repository": {
@@ -29,10 +29,9 @@
   },
   "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"
-  },
-  "dependencies": {
-    "foodoc": "^0.0.9"
   }
 }