@cobaltio/cobalt-js 5.1.0 → 6.0.0

package/README.md

@@ -71,20 +71,17 @@ cobalt.token = "COBALT_SESSION_TOKEN";
 <dt><a href="#InputField">InputField</a> : <code>Object</code></dt>
 <dd><p>An Input field to take input from the user.</p>
 </dd>
-<dt><a href="#Config">Config</a> : <code>Object</code></dt>
-<dd><p>The configuration data for an application.</p>
-</dd>
-<dt><a href="#Workflow">Workflow</a> : <code>Object</code></dt>
-<dd><p>The workflow.</p>
-</dd>
 <dt><a href="#ConfigPayload">ConfigPayload</a> : <code>Object</code></dt>
 <dd><p>The payload object for config.</p>
 </dd>
-<dt><a href="#DynamicField">DynamicField</a> : <code>Object</code></dt>
-<dd><p>Field Mapping Label</p>
-</dd>
 <dt><a href="#Label">Label</a> : <code>Object</code></dt>
-<dd><p>Field Mapping Label</p>
+<dd><p>Label Mapping</p>
+</dd>
+<dt><a href="#UpdateConfigPayload">UpdateConfigPayload</a> : <code>Object</code></dt>
+<dd><p>The configuration data for an application.</p>
+</dd>
+<dt><a href="#WorkflowPayload">WorkflowPayload</a> : <code>Object</code></dt>
+<dd><p>The workflow.</p>
 </dd>
 </dl>
 
@@ -98,11 +95,11 @@ cobalt.token = "COBALT_SESSION_TOKEN";
     * [.getApp([slug])](#Cobalt+getApp) ⇒ [<code>Promise.&lt;Application&gt;</code>](#Application)
     * [.connect(slug, [payload])](#Cobalt+connect) ⇒ <code>Promise.&lt;Boolean&gt;</code>
     * [.disconnect(slug)](#Cobalt+disconnect) ⇒ <code>Promise.&lt;void&gt;</code>
-    * [.config(slug, [payload])](#Cobalt+config) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
-    * [.updateConfig(slug, payload)](#Cobalt+updateConfig) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
+    * [.config(payload)](#Cobalt+config) ⇒ <code>Promise.&lt;Config&gt;</code>
+    * [.updateConfig(payload)](#Cobalt+updateConfig) ⇒ <code>Promise.&lt;Config&gt;</code>
     * [.deleteConfig(slug, [configId])](#Cobalt+deleteConfig) ⇒ <code>Promise.&lt;unknown&gt;</code>
-* Additional Methods:
-    * [.getConfig(slug, [configId])](#Cobalt+getConfig) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
+* Additional Methods
+    * [.getConfig(slug, [configId])](#Cobalt+getConfig) ⇒ <code>Promise.&lt;Config&gt;</code>
 
 <a name="new_Cobalt_new"></a>
 
@@ -126,9 +123,9 @@ it returns all the enabled applications.
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
 **Returns**: [<code>Promise.&lt;Application&gt;</code>](#Application) - The application details.
 
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| [slug] | <code>String</code> | <code>&quot;*&quot;</code> | The application slug. |
+| Param | Type | Description |
+| --- | --- | --- |
+| [slug] | <code>String</code> | The application slug. |
 
 <a name="Cobalt+connect"></a>
 
@@ -156,24 +153,23 @@ Disconnect the specified application and remove any associated data from Cobalt.
 
 <a name="Cobalt+config"></a>
 
-### cobalt.config(slug, [payload]) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
+### cobalt.config(payload) ⇒ <code>Promise.&lt;Config&gt;</code>
 Returns the specified config, or creates one if it doesn't exist.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
-**Returns**: [<code>Promise.&lt;Config&gt;</code>](#Config) - The specified config.
+**Returns**: <code>Promise.&lt;Config&gt;</code> - The specified config.
 
 | Param | Type | Description |
 | --- | --- | --- |
-| slug | <code>String</code> | The application slug. |
-| [payload] | [<code>ConfigPayload</code>](#ConfigPayload) | The payload object for config. |
+| payload | [<code>ConfigPayload</code>](#ConfigPayload) | The payload object for config. |
 
 <a name="Cobalt+getConfig"></a>
 
-### cobalt.getConfig(slug, [configId]) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
+### cobalt.getConfig(slug, [configId]) ⇒ <code>Promise.&lt;Config&gt;</code>
 Returns the specified config.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
-**Returns**: [<code>Promise.&lt;Config&gt;</code>](#Config) - The specified config.
+**Returns**: <code>Promise.&lt;Config&gt;</code> - The specified config.
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -182,16 +178,15 @@ Returns the specified config.
 
 <a name="Cobalt+updateConfig"></a>
 
-### cobalt.updateConfig(slug, payload) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
+### cobalt.updateConfig(payload) ⇒ <code>Promise.&lt;Config&gt;</code>
 Update the specified config.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
-**Returns**: [<code>Promise.&lt;Config&gt;</code>](#Config) - The specified config.
+**Returns**: <code>Promise.&lt;Config&gt;</code> - The specified config.
 
 | Param | Type | Description |
 | --- | --- | --- |
-| slug | <code>String</code> | The application slug. |
-| payload | [<code>Config</code>](#Config) | The update payload. |
+| payload | [<code>UpdateConfigPayload</code>](#UpdateConfigPayload) | The update payload. |
 
 <a name="Cobalt+deleteConfig"></a>
 
@@ -240,68 +235,58 @@ An Input field to take input from the user.
 | placeholder | <code>String</code> | The placeholder of the field. |
 | label | <code>String</code> | The label of the field. |
 
-<a name="Config"></a>
+<a name="ConfigPayload"></a>
 
-## Config : <code>Object</code>
-The configuration data for an application.
+## ConfigPayload : <code>Object</code>
+The payload object for config.
 
 **Kind**: global typedef
 **Properties**
 
 | Name | Type | Description |
 | --- | --- | --- |
+| slug | <code>String</code> | The application slug. |
 | [config_id] | <code>String</code> | Unique ID for the config. |
-| application_data_slots | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of application data slots and their values. |
-| workflows | [<code>Array.&lt;Workflow&gt;</code>](#Workflow) | Whether the workflow is enabled. |
+| labels | <code>Object.&lt;string, Array.&lt;Label&gt;&gt;</code> | The dynamic label mappings. |
 
-<a name="Workflow"></a>
+<a name="Label"></a>
 
-## Workflow : <code>Object</code>
-The workflow.
+## Label : <code>Object</code>
+Label Mapping
 
 **Kind**: global typedef
 **Properties**
 
 | Name | Type | Description |
 | --- | --- | --- |
-| id | <code>String</code> | The ID of the workflow. |
-| enabled | <code>Boolean</code> | Whether the workflow is enabled. |
-| data_slots | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of workflow's data slots and their values. |
+| name | <code>string</code> | The label name. |
+| value | <code>string</code> \| <code>number</code> \| <code>boolean</code> | The label value. |
 
-<a name="ConfigPayload"></a>
+<a name="UpdateConfigPayload"></a>
 
-## ConfigPayload : <code>Object</code>
-The payload object for config.
+## UpdateConfigPayload : <code>Object</code>
+The configuration data for an application.
 
 **Kind**: global typedef
 **Properties**
 
 | Name | Type | Description |
 | --- | --- | --- |
+| slug | <code>String</code> | The application slug. |
 | [config_id] | <code>String</code> | Unique ID for the config. |
-| map_fields_object | <code>Object.&lt;string, DynamicField&gt;</code> | Map fields object. |
-
-<a name="DynamicField"></a>
+| fields | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of application fields and their values. |
+| workflows | [<code>Array.&lt;WorkflowPayload&gt;</code>](#WorkflowPayload) | Whether the workflow is enabled. |
 
-## DynamicField : <code>Object</code>
-Field Mapping Label
+<a name="WorkflowPayload"></a>
 
-**Kind**: global typedef
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| fields | [<code>Array.&lt;Label&gt;</code>](#Label) | The Label name. |
-
-<a name="Label"></a>
-
-## Label : <code>Object</code>
-Field Mapping Label
+## WorkflowPayload : <code>Object</code>
+The workflow.
 
 **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. |
+| id | <code>String</code> | The ID of the workflow. |
+| enabled | <code>Boolean</code> | Whether the workflow is enabled. |
+| fields | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of workflow fields and their values. |

package/cobalt.js

@@ -24,34 +24,31 @@
  */
 
 /**
- * @typedef {Object} Config The configuration data for an application.
+ * @typedef {Object} ConfigPayload The payload object for config.
+ * @property {String} slug The application slug.
  * @property {String} [config_id] Unique ID for the config.
- * @property {Object.<string, string | number | boolean>} application_data_slots A map of application data slots and their values.
- * @property {Workflow[]} workflows Whether the workflow is enabled.
+ * @property {Object.<string, Label[]>} labels The dynamic label mappings.
  */
 
 /**
- * @typedef {Object} Workflow The workflow.
- * @property {String} id The ID of the workflow.
- * @property {Boolean} enabled Whether the workflow is enabled.
- * @property {Object.<string, string | number | boolean>} data_slots A map of workflow's data slots and their values.
+ * @typedef {Object} Label Label Mapping
+ * @property {string} name The label name.
+ * @property {string | number | boolean} value The label value.
  */
 
 /**
- * @typedef {Object} ConfigPayload The payload object for config.
+ * @typedef {Object} UpdateConfigPayload The configuration data for an application.
+ * @property {String} slug The application slug.
  * @property {String} [config_id] Unique ID for the config.
- * @property {Object.<string, DynamicField>} map_fields_object Map fields object.
+ * @property {Object.<string, string | number | boolean>} fields A map of application fields and their values.
+ * @property {WorkflowPayload[]} workflows Whether the workflow is enabled.
  */
 
 /**
- * @typedef {Object} DynamicField Field Mapping Label
- * @property {Label[]} fields The Label name.
- */
-
-/**
- * @typedef {Object} Label Field Mapping Label
- * @property {string} name The Label name.
- * @property {string | number | boolean} value The Label value.
+ * @typedef {Object} WorkflowPayload The workflow.
+ * @property {String} id The ID of the workflow.
+ * @property {Boolean} enabled Whether the workflow is enabled.
+ * @property {Object.<string, string | number | boolean>} fields A map of workflow fields and their values.
  */
 
 class Cobalt {
@@ -98,11 +95,11 @@ class Cobalt {
      * Returns the application details for the specified application, provided
      * the application is enabled in Cobalt. If no application is specified,
      * it returns all the enabled applications.
-     * @param {String} [slug="*"] The application slug.
+     * @param {String} [slug] The application slug.
      * @returns {Promise<Application>} The application details.
      */
-    async getApp(slug = "*") {
-        const res = await fetch(`${this.baseUrl}/api/v1/linked-acc/application` + (slug ? `/${slug}` : ""), {
+    async getApp(slug) {
+        const res = await fetch(`${this.baseUrl}/api/v2/f-sdk/application${slug ? `/${slug}` : ""}`, {
             headers: {
                 authorization: `Bearer ${this.token}`,
             },
@@ -234,12 +231,11 @@ class Cobalt {
 
     /**
      * Returns the specified config, or creates one if it doesn't exist.
-     * @param {String} slug The application slug.
-     * @param {ConfigPayload} [payload] The payload object for config.
+     * @param {ConfigPayload} payload The payload object for config.
      * @returns {Promise<Config>} The specified config.
      */
-    async config(slug, payload) {
-        const res = await fetch(`${this.baseUrl}/api/v2/application/${slug}/installation`, {
+    async config(payload) {
+        const res = await fetch(`${this.baseUrl}/api/v2/f-sdk/config`, {
             method: "POST",
             headers: {
                 authorization: `Bearer ${this.token}`,
@@ -262,7 +258,7 @@ class Cobalt {
      * @returns {Promise<Config>} The specified config.
      */
     async getConfig(slug, configId) {
-        const res = await fetch(`${this.baseUrl}/api/v1/application/${slug}/installation/${configId ? configId : ""}`, {
+        const res = await fetch(`${this.baseUrl}/api/v2/f-sdk/slug/${slug}/config${configId ? `/${configId}` : ""}`, {
             headers: {
                 authorization: `Bearer ${this.token}`,
             },
@@ -277,12 +273,11 @@ class Cobalt {
 
     /**
      * Update the specified config.
-     * @param {String} slug The application slug.
-     * @param {Config} payload The update payload.
+     * @param {UpdateConfigPayload} payload The update payload.
      * @returns {Promise<Config>} The specified config.
      */
-    async updateConfig(slug, payload = {}) {
-        const res = await fetch(`${this.baseUrl}/api/v1/application/${slug}/installation`, {
+    async updateConfig(payload) {
+        const res = await fetch(`${this.baseUrl}/api/v2/f-sdk/config`, {
             method: "PUT",
             headers: {
                 authorization: `Bearer ${this.token}`,
@@ -305,7 +300,7 @@ class Cobalt {
      * @returns {Promise<unknown>}
      */
     async deleteConfig(slug, configId) {
-        const res = await fetch(`${this.baseUrl}/api/v1/application/${slug}/installation/${configId ? configId : ""}`, {
+        const res = await fetch(`${this.baseUrl}/api/v2/f-sdk/slug/${slug}/config${configId ? `/${configId}` : ""}`, {
             method: "DELETE",
             headers: {
                 authorization: `Bearer ${this.token}`,

package/docs.md

@@ -14,20 +14,17 @@
 <dt><a href="#InputField">InputField</a> : <code>Object</code></dt>
 <dd><p>An Input field to take input from the user.</p>
 </dd>
-<dt><a href="#Config">Config</a> : <code>Object</code></dt>
-<dd><p>The configuration data for an application.</p>
-</dd>
-<dt><a href="#Workflow">Workflow</a> : <code>Object</code></dt>
-<dd><p>The workflow.</p>
-</dd>
 <dt><a href="#ConfigPayload">ConfigPayload</a> : <code>Object</code></dt>
 <dd><p>The payload object for config.</p>
 </dd>
-<dt><a href="#DynamicField">DynamicField</a> : <code>Object</code></dt>
-<dd><p>Field Mapping Label</p>
-</dd>
 <dt><a href="#Label">Label</a> : <code>Object</code></dt>
-<dd><p>Field Mapping Label</p>
+<dd><p>Label Mapping</p>
+</dd>
+<dt><a href="#UpdateConfigPayload">UpdateConfigPayload</a> : <code>Object</code></dt>
+<dd><p>The configuration data for an application.</p>
+</dd>
+<dt><a href="#WorkflowPayload">WorkflowPayload</a> : <code>Object</code></dt>
+<dd><p>The workflow.</p>
 </dd>
 </dl>
 
@@ -41,9 +38,9 @@
     * [.getApp([slug])](#Cobalt+getApp) ⇒ [<code>Promise.&lt;Application&gt;</code>](#Application)
     * [.connect(slug, [payload])](#Cobalt+connect) ⇒ <code>Promise.&lt;Boolean&gt;</code>
     * [.disconnect(slug)](#Cobalt+disconnect) ⇒ <code>Promise.&lt;void&gt;</code>
-    * [.config(slug, [payload])](#Cobalt+config) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
-    * [.getConfig(slug, [configId])](#Cobalt+getConfig) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
-    * [.updateConfig(slug, payload)](#Cobalt+updateConfig) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
+    * [.config(payload)](#Cobalt+config) ⇒ <code>Promise.&lt;Config&gt;</code>
+    * [.getConfig(slug, [configId])](#Cobalt+getConfig) ⇒ <code>Promise.&lt;Config&gt;</code>
+    * [.updateConfig(payload)](#Cobalt+updateConfig) ⇒ <code>Promise.&lt;Config&gt;</code>
     * [.deleteConfig(slug, [configId])](#Cobalt+deleteConfig) ⇒ <code>Promise.&lt;unknown&gt;</code>
 
 <a name="new_Cobalt_new"></a>
@@ -68,9 +65,9 @@ it returns all the enabled applications.
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
 **Returns**: [<code>Promise.&lt;Application&gt;</code>](#Application) - The application details.  
 
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| [slug] | <code>String</code> | <code>&quot;*&quot;</code> | The application slug. |
+| Param | Type | Description |
+| --- | --- | --- |
+| [slug] | <code>String</code> | The application slug. |
 
 <a name="Cobalt+connect"></a>
 
@@ -98,24 +95,23 @@ Disconnect the specified application and remove any associated data from Cobalt.
 
 <a name="Cobalt+config"></a>
 
-### cobalt.config(slug, [payload]) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
+### cobalt.config(payload) ⇒ <code>Promise.&lt;Config&gt;</code>
 Returns the specified config, or creates one if it doesn't exist.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Returns**: [<code>Promise.&lt;Config&gt;</code>](#Config) - The specified config.  
+**Returns**: <code>Promise.&lt;Config&gt;</code> - The specified config.  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| slug | <code>String</code> | The application slug. |
-| [payload] | [<code>ConfigPayload</code>](#ConfigPayload) | The payload object for config. |
+| payload | [<code>ConfigPayload</code>](#ConfigPayload) | The payload object for config. |
 
 <a name="Cobalt+getConfig"></a>
 
-### cobalt.getConfig(slug, [configId]) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
+### cobalt.getConfig(slug, [configId]) ⇒ <code>Promise.&lt;Config&gt;</code>
 Returns the specified config.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Returns**: [<code>Promise.&lt;Config&gt;</code>](#Config) - The specified config.  
+**Returns**: <code>Promise.&lt;Config&gt;</code> - The specified config.  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -124,16 +120,15 @@ Returns the specified config.
 
 <a name="Cobalt+updateConfig"></a>
 
-### cobalt.updateConfig(slug, payload) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
+### cobalt.updateConfig(payload) ⇒ <code>Promise.&lt;Config&gt;</code>
 Update the specified config.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Returns**: [<code>Promise.&lt;Config&gt;</code>](#Config) - The specified config.  
+**Returns**: <code>Promise.&lt;Config&gt;</code> - The specified config.  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| slug | <code>String</code> | The application slug. |
-| payload | [<code>Config</code>](#Config) | The update payload. |
+| payload | [<code>UpdateConfigPayload</code>](#UpdateConfigPayload) | The update payload. |
 
 <a name="Cobalt+deleteConfig"></a>
 
@@ -182,69 +177,59 @@ An Input field to take input from the user.
 | placeholder | <code>String</code> | The placeholder of the field. |
 | label | <code>String</code> | The label of the field. |
 
-<a name="Config"></a>
+<a name="ConfigPayload"></a>
 
-## Config : <code>Object</code>
-The configuration data for an application.
+## ConfigPayload : <code>Object</code>
+The payload object for config.
 
 **Kind**: global typedef  
 **Properties**
 
 | Name | Type | Description |
 | --- | --- | --- |
+| slug | <code>String</code> | The application slug. |
 | [config_id] | <code>String</code> | Unique ID for the config. |
-| application_data_slots | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of application data slots and their values. |
-| workflows | [<code>Array.&lt;Workflow&gt;</code>](#Workflow) | Whether the workflow is enabled. |
+| labels | <code>Object.&lt;string, Array.&lt;Label&gt;&gt;</code> | The dynamic label mappings. |
 
-<a name="Workflow"></a>
+<a name="Label"></a>
 
-## Workflow : <code>Object</code>
-The workflow.
+## Label : <code>Object</code>
+Label Mapping
 
 **Kind**: global typedef  
 **Properties**
 
 | Name | Type | Description |
 | --- | --- | --- |
-| id | <code>String</code> | The ID of the workflow. |
-| enabled | <code>Boolean</code> | Whether the workflow is enabled. |
-| data_slots | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of workflow's data slots and their values. |
+| name | <code>string</code> | The label name. |
+| value | <code>string</code> \| <code>number</code> \| <code>boolean</code> | The label value. |
 
-<a name="ConfigPayload"></a>
+<a name="UpdateConfigPayload"></a>
 
-## ConfigPayload : <code>Object</code>
-The payload object for config.
+## UpdateConfigPayload : <code>Object</code>
+The configuration data for an application.
 
 **Kind**: global typedef  
 **Properties**
 
 | Name | Type | Description |
 | --- | --- | --- |
+| slug | <code>String</code> | The application slug. |
 | [config_id] | <code>String</code> | Unique ID for the config. |
-| map_fields_object | <code>Object.&lt;string, DynamicField&gt;</code> | Map fields object. |
-
-<a name="DynamicField"></a>
+| fields | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of application fields and their values. |
+| workflows | [<code>Array.&lt;WorkflowPayload&gt;</code>](#WorkflowPayload) | Whether the workflow is enabled. |
 
-## DynamicField : <code>Object</code>
-Field Mapping Label
+<a name="WorkflowPayload"></a>
 
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| fields | [<code>Array.&lt;Label&gt;</code>](#Label) | The Label name. |
-
-<a name="Label"></a>
-
-## Label : <code>Object</code>
-Field Mapping Label
+## WorkflowPayload : <code>Object</code>
+The workflow.
 
 **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. |
+| id | <code>String</code> | The ID of the workflow. |
+| enabled | <code>Boolean</code> | Whether the workflow is enabled. |
+| fields | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of workflow fields and their values. |
 

package/package.json

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