@cobaltio/cobalt-js 0.0.2 → 0.0.3

package/README.md

@@ -1,10 +1,45 @@
 # cobalt.js
 Cobalt frontend SDK.
 
-# Install
+## Install
+
+#### npm
 ```bash
+npm install @cobaltio/cobalt-js
 ```
 
-# Usage
+#### yarn
 ```bash
+yarn add @cobaltio/cobalt-js
+```
+
+## Usage
+
+### Include
+
+#### Browser
+```js
+<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@0"></script>
+```
+
+#### Node
+```js
+// CommonJS
+const Cobalt = require("@cobaltio/cobalt-js");
+// ESM
+import Cobalt from "@cobaltio/cobalt-js";
+```
+
+### Initialize
+```js
+// initialize with token
+const cobalt = new Cobalt({
+    // the token you generate for linked accounts using the cobalt backend SDK
+    token: "COBALT_SESSION_TOKEN",
+});
+
+// initialize without token
+const cobalt = new Cobalt();
+// the token you generate for linked accounts using the cobalt backend SDK
+cobalt.token("COBALT_SESSION_TOKEN");
 ```

package/cobalt.js

@@ -5,25 +5,26 @@ 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.
      */
     constructor(options) {
         this.apiBaseUrl = options?.baseUrl || "https://api.gocobalt.io";
-        this.template = {};
+        this.token(options?.token);
     }
 
     /**
-     * @returns {string} The token to install a template.
+     * @returns {string} The session token.
      */
     get token() {
-        return this.templateToken;
+        return this.sessionToken;
     };
 
     /**
-     * @returns {string} The token to install a template.
+     * @returns {string} The session token.
      */
     set token(token) {
-        return this.templateToken = typeof token === "string" ? token : "";
+        return this.sessionToken = typeof token === "string" ? token : "";
     };
 
     /**
@@ -57,25 +58,28 @@ class Cobalt {
 
     /**
      * Install the given template.
+     * @property {string} templateId The ID of the template you want to install.
      * @returns {Promise<Workflow>}
      */
-    async installTemplate() {
-        const res = await fetch(`${this.baseUrl}/api/v1/template/install`, {
+    async installTemplate(templateId) {
+        const res = await fetch(`${this.baseUrl}/api/v1/template/install/${templateId}`, {
             method: "POST",
             headers: {
                 authorization: `Bearer ${this.token}`,
             },
         });
-        this.template = await res.json();
-        return this.template;
+        return await res.json();
     }
 
     /**
-     * Install the given template.
+     * 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>}
      */
-    async saveNode(nodeId, inputData = {}) {
-        const res = await fetch(`${this.baseUrl}/api/v2/workflow/${this.template?.workflow_id}/node/${nodeId}`, {
+    async saveNode(workflowId, nodeId, inputData = {}) {
+        const res = await fetch(`${this.baseUrl}/api/v2/workflow/${workflowId}/node/${nodeId}`, {
             method: "PUT",
             headers: {
                 authorization: `Bearer ${this.token}`,

package/cobalt.min.js

@@ -1 +1 @@
-class Cobalt{constructor(options){this.apiBaseUrl=options?.baseUrl||"https://api.gocobalt.io";this.template={}}get token(){return this.templateToken}set token(token){return this.templateToken=typeof token==="string"?token:""}get baseUrl(){return this.apiBaseUrl}async installTemplate(){const res=await fetch(`${this.baseUrl}/api/v1/template/install`,{method:"POST",headers:{authorization:`Bearer ${this.token}`}});this.template=await res.json();return this.template}async saveNode(nodeId,inputData={}){const res=await fetch(`${this.baseUrl}/api/v2/workflow/${this.template?.workflow_id}/node/${nodeId}`,{method:"PUT",headers:{authorization:`Bearer ${this.token}`},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}`}});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}`},body:JSON.stringify({input_data:inputData})});return await res.json()}}module.exports=Cobalt;

package/docs/Cobalt.html

@@ -133,6 +133,43 @@
     <tbody>
     
 
+        <tr>
+            
+                <td class="name"><code>token</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+                <td class="default">
+                
+                </td>
+            
+
+            <td class="description last">The session token.</td>
+        </tr>
+
+    
+
         <tr>
             
                 <td class="name"><code>baseUrl</code></td>
@@ -305,7 +342,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line32">line 32</a>
+        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line33">line 33</a>
     </li></ul></dd>
     
 
@@ -363,7 +400,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line18">line 18</a>
+        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line19">line 19</a>
     </li></ul></dd>
     
 
@@ -421,7 +458,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line25">line 25</a>
+        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line26">line 26</a>
     </li></ul></dd>
     
 
@@ -472,6 +509,58 @@
 
 
 
+    <h5 class="subsection-title">Properties:</h5>
+
+    
+
+<table class="props">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>templateId</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The ID of the template you want to install.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
 <dl class="details">
 
     
@@ -501,7 +590,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line62">line 62</a>
+        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line64">line 64</a>
     </li></ul></dd>
     
 
@@ -563,7 +652,7 @@
 
 
 <div class="description">
-    Install the given template.
+    Save the input data for the specified node.
 </div>
 
 
@@ -578,6 +667,104 @@
 
 
 
+    <h5 class="subsection-title">Properties:</h5>
+
+    
+
+<table class="props">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>workflowId</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The ID of the workflow.</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>nodeId</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The ID of the node.</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>inputData</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">object</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The input data for the node.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
 <dl class="details">
 
     
@@ -607,7 +794,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line77">line 77</a>
+        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line81">line 81</a>
     </li></ul></dd>
     
 
@@ -677,7 +864,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Sep 05 2022 15:43:26 GMT+0530 (India Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Wed Sep 07 2022 12:11:23 GMT+0530 (India Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/docs/cobalt.js.html

@@ -33,25 +33,26 @@ 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.
      */
     constructor(options) {
         this.apiBaseUrl = options?.baseUrl || "https://api.gocobalt.io";
-        this.template = {};
+        this.token(options?.token);
     }
 
     /**
-     * @returns {string} The token to install a template.
+     * @returns {string} The session token.
      */
     get token() {
-        return this.templateToken;
+        return this.sessionToken;
     };
 
     /**
-     * @returns {string} The token to install a template.
+     * @returns {string} The session token.
      */
     set token(token) {
-        return this.templateToken = typeof token === "string" ? token : "";
+        return this.sessionToken = typeof token === "string" ? token : "";
     };
 
     /**
@@ -85,25 +86,28 @@ class Cobalt {
 
     /**
      * Install the given template.
+     * @property {string} templateId The ID of the template you want to install.
      * @returns {Promise<Workflow>}
      */
-    async installTemplate() {
-        const res = await fetch(`${this.baseUrl}/api/v1/template/install`, {
+    async installTemplate(templateId) {
+        const res = await fetch(`${this.baseUrl}/api/v1/template/install/${templateId}`, {
             method: "POST",
             headers: {
                 authorization: `Bearer ${this.token}`,
             },
         });
-        this.template = await res.json();
-        return this.template;
+        return await res.json();
     }
 
     /**
-     * Install the given template.
+     * 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>}
      */
-    async saveNode(nodeId, inputData = {}) {
-        const res = await fetch(`${this.baseUrl}/api/v2/workflow/${this.template?.workflow_id}/node/${nodeId}`, {
+    async saveNode(workflowId, nodeId, inputData = {}) {
+        const res = await fetch(`${this.baseUrl}/api/v2/workflow/${workflowId}/node/${nodeId}`, {
             method: "PUT",
             headers: {
                 authorization: `Bearer ${this.token}`,
@@ -116,7 +120,7 @@ class Cobalt {
     }
 }
 
-export default Cobalt;
+module.exports = Cobalt;
 </code></pre>
         </article>
     </section>
@@ -133,7 +137,7 @@ export default Cobalt;
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Sep 05 2022 15:43:26 GMT+0530 (India Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Wed Sep 07 2022 12:11:23 GMT+0530 (India Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/docs/global.html

@@ -277,7 +277,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line36">line 36</a>
+        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line37">line 37</a>
     </li></ul></dd>
     
 
@@ -447,7 +447,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line44">line 44</a>
+        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line45">line 45</a>
     </li></ul></dd>
     
 
@@ -617,7 +617,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line51">line 51</a>
+        <a href="cobalt.js.html">cobalt.js</a>, <a href="cobalt.js.html#line52">line 52</a>
     </li></ul></dd>
     
 
@@ -653,7 +653,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Sep 05 2022 15:43:26 GMT+0530 (India Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Wed Sep 07 2022 12:11:23 GMT+0530 (India Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/docs/index.html

@@ -45,10 +45,36 @@
     <section>
         <article><h1>cobalt.js</h1>
 <p>Cobalt frontend SDK.</p>
-<h1>Install</h1>
-<pre class="prettyprint source lang-bash"><code></code></pre>
-<h1>Usage</h1>
-<pre class="prettyprint source lang-bash"><code></code></pre></article>
+<h2>Install</h2>
+<h4>npm</h4>
+<pre class="prettyprint source lang-bash"><code>npm install @cobaltio/cobalt-js
+</code></pre>
+<h4>yarn</h4>
+<pre class="prettyprint source lang-bash"><code>yarn add @cobaltio/cobalt-js
+</code></pre>
+<h2>Usage</h2>
+<h3>Include</h3>
+<h4>Browser</h4>
+<pre class="prettyprint source lang-js"><code>&lt;script src=&quot;https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@0&quot;>&lt;/script>
+</code></pre>
+<h4>Node</h4>
+<pre class="prettyprint source lang-js"><code>// CommonJS
+const Cobalt = require(&quot;@cobaltio/cobalt-js&quot;);
+// ESM
+import Cobalt from &quot;@cobaltio/cobalt-js&quot;;
+</code></pre>
+<h3>Initialize</h3>
+<pre class="prettyprint source lang-js"><code>// initialize with token
+const cobalt = new Cobalt({
+    // the token you generate for linked accounts using the cobalt backend SDK
+    token: &quot;COBALT_SESSION_TOKEN&quot;,
+});
+
+// initialize without token
+const cobalt = new Cobalt();
+// the token you generate for linked accounts using the cobalt backend SDK
+cobalt.token(&quot;COBALT_SESSION_TOKEN&quot;);
+</code></pre></article>
     </section>
 
 
@@ -65,7 +91,7 @@
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Sep 05 2022 15:43:26 GMT+0530 (India Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Wed Sep 07 2022 12:11:23 GMT+0530 (India Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

package/package.json

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