@cobaltio/cobalt-js 3.0.1 → 3.0.3

package/README.md

@@ -21,10 +21,14 @@ yarn add @cobaltio/cobalt-js
 
 #### Browser
 ```html
-<!-- import the latest version -->
+<!-- use a specific version -->
+<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@3.0.1"></script>
+<!-- use a version range instead of a specific version -->
+<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@3"></script>
+<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@3.0"></script>
+<!-- omit the version completely to use the latest one -->
+<!-- you should NOT use this in production -->
 <script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js"></script>
-<!-- import a specific version -->
-<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@2"></script>
 ```
 
 #### Node
@@ -55,21 +59,17 @@ cobalt.token = "COBALT_SESSION_TOKEN";
 
 <dl>
 <dt><a href="#Cobalt">Cobalt</a></dt>
-<dd><p>Cobalt Frontend SDK</p>
-</dd>
+<dd></dd>
 </dl>
 
 ## Typedefs
 
 <dl>
-<dt><a href="#Label">Label</a> : <code>Object</code></dt>
-<dd><p>Field Mapping Label</p>
-</dd>
-<dt><a href="#DynamicField">DynamicField</a> : <code>Object</code></dt>
-<dd><p>Field Mapping Label</p>
+<dt><a href="#Application">Application</a> : <code>Object</code></dt>
+<dd><p>An application in Cobalt.</p>
 </dd>
-<dt><a href="#DynamicFields">DynamicFields</a> : <code>Object</code></dt>
-<dd><p>The dynamic fields payload.</p>
+<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>
@@ -77,13 +77,20 @@ cobalt.token = "COBALT_SESSION_TOKEN";
 <dt><a href="#Workflow">Workflow</a> : <code>Object</code></dt>
 <dd><p>The workflow.</p>
 </dd>
+<dt><a href="#DynamicFields">DynamicFields</a> : <code>Object</code></dt>
+<dd><p>The dynamic fields payload.</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>
 </dl>
 
 <a name="Cobalt"></a>
 
 ## Cobalt
-Cobalt Frontend SDK
-
 **Kind**: global class
 
 * [Cobalt](#Cobalt)
@@ -93,8 +100,8 @@ Cobalt Frontend SDK
     * [.config(slug, configId, [fields])](#Cobalt+config) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
     * [.updateConfig(slug, configId, payload)](#Cobalt+updateConfig) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
     * [.deleteConfig(slug, configId)](#Cobalt+deleteConfig) ⇒ <code>Promise.&lt;unknown&gt;</code>
-* Additional Methods:
-    * [.getApp(slug)](#Cobalt+getApp) ⇒ <code>Promise.&lt;Application&gt;</code>
+Additional Methods:
+    * [.getApp([slug])](#Cobalt+getApp) ⇒ [<code>Promise.&lt;Application&gt;</code>](#Application)
     * [.getConfig(slug, configId)](#Cobalt+getConfig) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
 
 <a name="new_Cobalt_new"></a>
@@ -111,16 +118,17 @@ Cobalt Frontend SDK
 
 <a name="Cobalt+getApp"></a>
 
-### cobalt.getApp(slug) ⇒ <code>Promise.&lt;Application&gt;</code>
+### cobalt.getApp([slug]) ⇒ [<code>Promise.&lt;Application&gt;</code>](#Application)
 Returns the application details for the specified application, provided
-the application is enabled in Cobalt.
+the application is enabled in Cobalt. If no application is specified,
+it returns all the enabled applications.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
-**Returns**: <code>Promise.&lt;Application&gt;</code> - The application details.
+**Returns**: [<code>Promise.&lt;Application&gt;</code>](#Application) - The application details.
 
 | Param | Type | Description |
 | --- | --- | --- |
-| slug | <code>String</code> | The application slug. |
+| [slug] | <code>String</code> | The application slug. |
 
 <a name="Cobalt+connect"></a>
 
@@ -199,42 +207,40 @@ Delete the specified config.
 | slug | <code>String</code> | The application slug. |
 | configId | <code>String</code> | The unique ID of the config. |
 
-<a name="Label"></a>
+<a name="Application"></a>
 
-## Label : <code>Object</code>
-Field Mapping Label
+## Application : <code>Object</code>
+An application in Cobalt.
 
 **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. |
+| name | <code>String</code> | The application name. |
+| description | <code>String</code> | The application description. |
+| icon | <code>String</code> | The application icon. |
+| type | <code>String</code> | The application slug for native apps. |
+| [slug] | <code>String</code> | The application slug for custom apps. |
+| auth_type | <code>&quot;oauth2&quot;</code> \| <code>&quot;keybased&quot;</code> | The type of auth used by application. |
+| [connected] | <code>Boolean</code> | Whether the user has connected the application. |
+| [auth_input_map] | [<code>Array.&lt;InputField&gt;</code>](#InputField) | The fields required from the user to connect the application (for `keybased` auth type). |
 
-<a name="DynamicField"></a>
+<a name="InputField"></a>
 
-## DynamicField : <code>Object</code>
-Field Mapping Label
-
-**Kind**: global typedef
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| fields | [<code>Array.&lt;Label&gt;</code>](#Label) | The Label name. |
-
-<a name="DynamicFields"></a>
-
-## DynamicFields : <code>Object</code>
-The dynamic fields payload.
+## InputField : <code>Object</code>
+An Input field to take input from the user.
 
 **Kind**: global typedef
 **Properties**
 
 | Name | Type | Description |
 | --- | --- | --- |
-| map_fields_object | <code>Object.&lt;string, DynamicField&gt;</code> | desc. |
+| name | <code>String</code> | Key name of the field. |
+| type | <code>String</code> | Input type of the field. |
+| required | <code>String</code> | Whether the field is required. |
+| placeholder | <code>String</code> | The placeholder of the field. |
+| label | <code>String</code> | The label of the field. |
 
 <a name="Config"></a>
 
@@ -263,3 +269,40 @@ The workflow.
 | 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. |
+
+<a name="DynamicFields"></a>
+
+## DynamicFields : <code>Object</code>
+The dynamic fields payload.
+
+**Kind**: global typedef
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| map_fields_object | <code>Object.&lt;string, DynamicField&gt;</code> | desc. |
+
+<a name="DynamicField"></a>
+
+## DynamicField : <code>Object</code>
+Field Mapping Label
+
+**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
+
+**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. |

package/cobalt.js

@@ -1,6 +1,58 @@
 /**
  * Cobalt Frontend SDK
  */
+
+/**
+ * @typedef {Object} Application An application in Cobalt.
+ * @property {String} name The application name.
+ * @property {String} description The application description.
+ * @property {String} icon The application icon.
+ * @property {String} type The application slug for native apps.
+ * @property {String} [slug] The application slug for custom apps.
+ * @property {"oauth2"|"keybased"} auth_type The type of auth used by application.
+ * @property {Boolean} [connected] Whether the user has connected the application.
+ * @property {InputField[]} [auth_input_map] The fields required from the user to connect the application (for `keybased` auth type).
+ */
+
+/**
+ * @typedef {Object} InputField An Input field to take input from the user.
+ * @property {String} name Key name of the field.
+ * @property {String} type Input type of the field.
+ * @property {String} required Whether the field is required.
+ * @property {String} placeholder The placeholder of the field.
+ * @property {String} label The label of the field.
+ */
+
+/**
+ * @typedef {Object} Config The configuration data for an application.
+ * @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.
+ */
+
+/**
+ * @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} DynamicFields The dynamic fields payload.
+ * @property {Object.<string, DynamicField>} map_fields_object desc.
+ */
+
+/**
+ * @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.
+ */
+
 class Cobalt {
     /**
      * Cobalt Frontend SDK
@@ -23,12 +75,13 @@ class Cobalt {
 
     /**
      * Returns the application details for the specified application, provided
-     * the application is enabled in Cobalt.
-     * @param {String} slug The application slug.
+     * the application is enabled in Cobalt. If no application is specified,
+     * it returns all the enabled applications.
+     * @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}`, {
+        const res = await fetch(`${this.baseUrl}/api/v1/linked-acc/application` + (slug ? `/${slug}` : ""), {
             headers: {
                 authorization: `Bearer ${this.token}`,
             },
@@ -158,22 +211,6 @@ class Cobalt {
         }
     }
 
-    /**
-     * @typedef {Object} Label Field Mapping Label
-     * @property {string} name The Label name.
-     * @property {string | number | boolean} value The Label value.
-     */
-
-    /**
-     * @typedef {Object} DynamicField Field Mapping Label
-     * @property {Label[]} fields The Label name.
-     */
-
-    /**
-     * @typedef {Object} DynamicFields The dynamic fields payload.
-     * @property {Object.<string, DynamicField>} map_fields_object desc.
-     */
-
     /**
      * Returns the specified config, or creates one if it doesn't exist.
      * @param {String} slug The application slug.
@@ -198,20 +235,6 @@ class Cobalt {
         return await res.json();
     }
 
-    /**
-     * @typedef {Object} Config The configuration data for an application.
-     * @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.
-     */
-
-    /**
-     * @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.
-     */
-
     /**
      * Returns the specified config.
      * @param {String} slug The application slug.

package/docs.md

@@ -2,21 +2,17 @@
 
 <dl>
 <dt><a href="#Cobalt">Cobalt</a></dt>
-<dd><p>Cobalt Frontend SDK</p>
-</dd>
+<dd></dd>
 </dl>
 
 ## Typedefs
 
 <dl>
-<dt><a href="#Label">Label</a> : <code>Object</code></dt>
-<dd><p>Field Mapping Label</p>
-</dd>
-<dt><a href="#DynamicField">DynamicField</a> : <code>Object</code></dt>
-<dd><p>Field Mapping Label</p>
+<dt><a href="#Application">Application</a> : <code>Object</code></dt>
+<dd><p>An application in Cobalt.</p>
 </dd>
-<dt><a href="#DynamicFields">DynamicFields</a> : <code>Object</code></dt>
-<dd><p>The dynamic fields payload.</p>
+<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>
@@ -24,18 +20,25 @@
 <dt><a href="#Workflow">Workflow</a> : <code>Object</code></dt>
 <dd><p>The workflow.</p>
 </dd>
+<dt><a href="#DynamicFields">DynamicFields</a> : <code>Object</code></dt>
+<dd><p>The dynamic fields payload.</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>
 </dl>
 
 <a name="Cobalt"></a>
 
 ## Cobalt
-Cobalt Frontend SDK
-
 **Kind**: global class  
 
 * [Cobalt](#Cobalt)
     * [new Cobalt(options)](#new_Cobalt_new)
-    * [.getApp(slug)](#Cobalt+getApp) ⇒ <code>Promise.&lt;Application&gt;</code>
+    * [.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, configId, [fields])](#Cobalt+config) ⇒ [<code>Promise.&lt;Config&gt;</code>](#Config)
@@ -57,16 +60,17 @@ Cobalt Frontend SDK
 
 <a name="Cobalt+getApp"></a>
 
-### cobalt.getApp(slug) ⇒ <code>Promise.&lt;Application&gt;</code>
+### cobalt.getApp([slug]) ⇒ [<code>Promise.&lt;Application&gt;</code>](#Application)
 Returns the application details for the specified application, provided
-the application is enabled in Cobalt.
+the application is enabled in Cobalt. If no application is specified,
+it returns all the enabled applications.
 
 **Kind**: instance method of [<code>Cobalt</code>](#Cobalt)  
-**Returns**: <code>Promise.&lt;Application&gt;</code> - The application details.  
+**Returns**: [<code>Promise.&lt;Application&gt;</code>](#Application) - The application details.  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| slug | <code>String</code> | The application slug. |
+| [slug] | <code>String</code> | The application slug. |
 
 <a name="Cobalt+connect"></a>
 
@@ -145,42 +149,40 @@ Delete the specified config.
 | slug | <code>String</code> | The application slug. |
 | configId | <code>String</code> | The unique ID of the config. |
 
-<a name="Label"></a>
+<a name="Application"></a>
 
-## Label : <code>Object</code>
-Field Mapping Label
+## Application : <code>Object</code>
+An application in Cobalt.
 
 **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. |
+| name | <code>String</code> | The application name. |
+| description | <code>String</code> | The application description. |
+| icon | <code>String</code> | The application icon. |
+| type | <code>String</code> | The application slug for native apps. |
+| [slug] | <code>String</code> | The application slug for custom apps. |
+| auth_type | <code>&quot;oauth2&quot;</code> \| <code>&quot;keybased&quot;</code> | The type of auth used by application. |
+| [connected] | <code>Boolean</code> | Whether the user has connected the application. |
+| [auth_input_map] | [<code>Array.&lt;InputField&gt;</code>](#InputField) | The fields required from the user to connect the application (for `keybased` auth type). |
 
-<a name="DynamicField"></a>
+<a name="InputField"></a>
 
-## DynamicField : <code>Object</code>
-Field Mapping Label
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| fields | [<code>Array.&lt;Label&gt;</code>](#Label) | The Label name. |
-
-<a name="DynamicFields"></a>
-
-## DynamicFields : <code>Object</code>
-The dynamic fields payload.
+## InputField : <code>Object</code>
+An Input field to take input from the user.
 
 **Kind**: global typedef  
 **Properties**
 
 | Name | Type | Description |
 | --- | --- | --- |
-| map_fields_object | <code>Object.&lt;string, DynamicField&gt;</code> | desc. |
+| name | <code>String</code> | Key name of the field. |
+| type | <code>String</code> | Input type of the field. |
+| required | <code>String</code> | Whether the field is required. |
+| placeholder | <code>String</code> | The placeholder of the field. |
+| label | <code>String</code> | The label of the field. |
 
 <a name="Config"></a>
 
@@ -210,3 +212,40 @@ 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. |
 
+<a name="DynamicFields"></a>
+
+## DynamicFields : <code>Object</code>
+The dynamic fields payload.
+
+**Kind**: global typedef  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| map_fields_object | <code>Object.&lt;string, DynamicField&gt;</code> | desc. |
+
+<a name="DynamicField"></a>
+
+## DynamicField : <code>Object</code>
+Field Mapping Label
+
+**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
+
+**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. |
+

package/package.json

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