@cobaltio/cobalt-js 2.0.0 → 2.1.0

package/README.md

@@ -62,6 +62,12 @@ cobalt.token = "COBALT_SESSION_TOKEN";
 <dt><a href="#Config">Config</a> : <code>object</code></dt>
 <dd><p>The configuration data for an application.</p>
 </dd>
+<dt><a href="#Label">Label</a> : <code>Object</code></dt>
+<dd><p>Field Mapping Label</p>
+</dd>
+<dt><a href="#DynamicFields">DynamicFields</a> : <code>Object</code></dt>
+<dd><p>The dynamic fields payload.</p>
+</dd>
 <dt><a href="#SavedConfig">SavedConfig</a> : <code>Object</code></dt>
 <dd><p>An saved config.</p>
 </dd>
@@ -90,6 +96,7 @@ Cobalt Frontend SDK
     * [.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>
+    * [.config(applicationId, configId, fields)](#Cobalt+config) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
     * [.getConfig(application)](#Cobalt+getConfig) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
     * [.saveConfig(applicationId, payload)](#Cobalt+saveConfig) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
     * [.getSavedConfig(applicationId, configId)](#Cobalt+getSavedConfig) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
@@ -170,6 +177,20 @@ Unauthorize the specified application and remove any associated data from Cobalt
 | application | <code>String</code> | The application type. |
 | [applicationId] | <code>String</code> | The application ID in case of custom applications. |
 
+<a name="Cobalt+config"></a>
+
+### cobalt.config(applicationId, configId, fields) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
+Returns the specified saved config, or creates one if it doesn't exist.
+
+**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
+**Returns**: [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig) - The specified saved config.
+
+| Param | Type | Description |
+| --- | --- | --- |
+| applicationId | <code>String</code> | The application ID. |
+| configId | <code>String</code> | The config ID of the saved config. |
+| fields | [<code>DynamicFields</code>](#DynamicFields) | The dynamic fields payload. |
+
 <a name="Cobalt+getConfig"></a>
 
 ### cobalt.getConfig(application) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
@@ -247,6 +268,31 @@ The configuration data for an application.
 | application_data_slots | <code>Array.&lt;DataSlot&gt;</code> | Array of application data slots. |
 | workflows | [<code>Array.&lt;Workflow&gt;</code>](#Workflow) | Array of workflows. |
 
+<a name="Label"></a>
+
+## Label : <code>Object</code>
+Field Mapping Label
+
+**Kind**: global typedef
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| name | <code>string</code> | The Label name. |
+| value | <code>string</code> \| <code>number</code> \| <code>boolean</code> | The Label value. |
+
+<a name="DynamicFields"></a>
+
+## DynamicFields : <code>Object</code>
+The dynamic fields payload.
+
+**Kind**: global typedef
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| map_field_object | <code>Object.&lt;string, Array.&lt;Label&gt;&gt;</code> | desc. |
+
 <a name="SavedConfig"></a>
 
 ## SavedConfig : <code>Object</code>

package/cobalt.js

@@ -9,9 +9,9 @@ class Cobalt {
      * @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.baseUrl = options?.baseUrl || "https://api.gocobalt.io";
-        this.token = options?.token;
+    constructor(options = {}) {
+        this.baseUrl = options.baseUrl || "https://api.gocobalt.io";
+        this.token = options.token;
     }
 
     get token() {
@@ -186,6 +186,40 @@ class Cobalt {
      * @property {Workflow[]} workflows Array of workflows.
      */
 
+    /**
+     * @typedef {Object} Label Field Mapping Label
+     * @property {string} name The Label name.
+     * @property {string | number | boolean} value The Label value.
+     */
+
+    /**
+     * @typedef {Object} DynamicFields The dynamic fields payload.
+     * @property {Object.<string, Label[]>} map_field_object desc.
+     */
+
+    /**
+     * Returns the specified saved config, or creates one if it doesn't exist.
+     * @param {String} applicationId The application ID.
+     * @param {String} configId The config ID of the saved config.
+     * @param {DynamicFields} fields The dynamic fields payload.
+     * @returns {Promise<SavedConfig>} The specified saved config.
+     */
+    async config(applicationId, configId, fields = {}) {
+        const res = await fetch(`${this.baseUrl}/api/v2/application/${applicationId}/installation/${configId}`, {
+            method: "POST",
+            headers: {
+                authorization: `Bearer ${this.token}`,
+            },
+            body: JSON.stringify(fields),
+        });
+
+        if (res.status >= 400 && res.status < 600) {
+            throw new Error(res.statusText);
+        }
+
+        return await res.json();
+    }
+
     /**
      * Returns the configuration data for the specified application.
      * @param {String} application The application ID.

package/cobalt.min.js

@@ -1 +1 @@
-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 getConfig(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 saveConfig(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 getSavedConfig(applicationId,configId){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${configId}`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async updateSavedConfig(applicationId,configId,payload={}){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${configId}`,{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 deleteSavedConfig(applicationId,configId){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${configId}`,{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 config(applicationId,configId,fields={}){const res=await fetch(`${this.baseUrl}/api/v2/application/${applicationId}/installation/${configId}`,{method:"POST",headers:{authorization:`Bearer ${this.token}`},body:JSON.stringify(fields)});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async getConfig(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 saveConfig(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 getSavedConfig(applicationId,configId){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${configId}`,{headers:{authorization:`Bearer ${this.token}`}});if(res.status>=400&&res.status<600){throw new Error(res.statusText)}return await res.json()}async updateSavedConfig(applicationId,configId,payload={}){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${configId}`,{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 deleteSavedConfig(applicationId,configId){const res=await fetch(`${this.baseUrl}/api/v1/application/${applicationId}/installation/${configId}`,{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

@@ -12,6 +12,12 @@
 <dt><a href="#Config">Config</a> : <code>object</code></dt>
 <dd><p>The configuration data for an application.</p>
 </dd>
+<dt><a href="#Label">Label</a> : <code>Object</code></dt>
+<dd><p>Field Mapping Label</p>
+</dd>
+<dt><a href="#DynamicFields">DynamicFields</a> : <code>Object</code></dt>
+<dd><p>The dynamic fields payload.</p>
+</dd>
 <dt><a href="#SavedConfig">SavedConfig</a> : <code>Object</code></dt>
 <dd><p>An saved config.</p>
 </dd>
@@ -40,6 +46,7 @@ Cobalt Frontend SDK
     * [.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>
+    * [.config(applicationId, configId, fields)](#Cobalt+config) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
     * [.getConfig(application)](#Cobalt+getConfig) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
     * [.saveConfig(applicationId, payload)](#Cobalt+saveConfig) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
     * [.getSavedConfig(applicationId, configId)](#Cobalt+getSavedConfig) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
@@ -120,6 +127,20 @@ Unauthorize the specified application and remove any associated data from Cobalt
 | application | <code>String</code> | The application type. |
 | [applicationId] | <code>String</code> | The application ID in case of custom applications. |
 
+<a name="Cobalt+config"></a>
+
+### cobalt.config(applicationId, configId, fields) ⇒ [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig)
+Returns the specified saved config, or creates one if it doesn't exist.
+
+**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
+**Returns**: [<code>Promise.&lt;SavedConfig&gt;</code>](#SavedConfig) - The specified saved config.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| applicationId | <code>String</code> | The application ID. |
+| configId | <code>String</code> | The config ID of the saved config. |
+| fields | [<code>DynamicFields</code>](#DynamicFields) | The dynamic fields payload. |
+
 <a name="Cobalt+getConfig"></a>
 
 ### cobalt.getConfig(application) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
@@ -197,6 +218,31 @@ The configuration data for an application.
 | application_data_slots | <code>Array.&lt;DataSlot&gt;</code> | Array of application data slots. |
 | workflows | [<code>Array.&lt;Workflow&gt;</code>](#Workflow) | Array of workflows. |
 
+<a name="Label"></a>
+
+## Label : <code>Object</code>
+Field Mapping Label
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| name | <code>string</code> | The Label name. |
+| value | <code>string</code> \| <code>number</code> \| <code>boolean</code> | The Label value. |
+
+<a name="DynamicFields"></a>
+
+## DynamicFields : <code>Object</code>
+The dynamic fields payload.
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| map_field_object | <code>Object.&lt;string, Array.&lt;Label&gt;&gt;</code> | desc. |
+
 <a name="SavedConfig"></a>
 
 ## SavedConfig : <code>Object</code>

package/package.json

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