@cobaltio/cobalt-js 7.0.1 → 8.0.0

package/README.md

@@ -22,10 +22,10 @@ yarn add @cobaltio/cobalt-js
 #### Browser
 ```html
 <!-- use a specific version -->
-<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@7.0.0"></script>
+<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@8.0.0"></script>
 <!-- use a version range instead of a specific version -->
-<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@7"></script>
-<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@7.0"></script>
+<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@8"></script>
+<script src="https://cdn.jsdelivr.net/npm/@cobaltio/cobalt-js@8.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>
@@ -33,10 +33,7 @@ yarn add @cobaltio/cobalt-js
 
 #### Node
 ```js
-// CommonJS
-const Cobalt = require("@cobaltio/cobalt-js");
-// ESM
-import Cobalt from "@cobaltio/cobalt-js";
+import { Cobalt } from "@cobaltio/cobalt-js";
 ```
 
 ### Initialize
@@ -47,247 +44,12 @@ const cobalt = new Cobalt({
     token: "COBALT_SESSION_TOKEN",
 });
 
-// initialize without token
+// Or, initialize without token
 const cobalt = new Cobalt();
-// the token you generate for linked accounts using the cobalt backend SDK
+// and you can set the token later.
 cobalt.token = "COBALT_SESSION_TOKEN";
 ```
 
-### SDK
+# Documentation
 
-## Classes
-
-<dl>
-<dt><a href="#Cobalt">Cobalt</a></dt>
-<dd></dd>
-</dl>
-
-## Typedefs
-
-<dl>
-<dt><a href="#Application">Application</a> : <code>Object</code></dt>
-<dd><p>An application in Cobalt.</p>
-</dd>
-<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="#ConfigPayload">ConfigPayload</a> : <code>Object</code></dt>
-<dd><p>The payload object for config.</p>
-</dd>
-<dt><a href="#Label">Label</a> : <code>Object</code></dt>
-<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>
-
-<a name="Cobalt"></a>
-
-## Cobalt
-**Kind**: global class
-
-* [Cobalt](#Cobalt)
-    * [new Cobalt(options)](#new_Cobalt_new)
-    * [.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(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>
-
-<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>https://api.gocobalt.io</code> | The base URL of the Cobalt API. |
-
-<a name="Cobalt+getApp"></a>
-
-### 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. 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>](#Application) - The application details.
-
-| Param | Type | Description |
-| --- | --- | --- |
-| [slug] | <code>String</code> | The application slug. |
-
-<a name="Cobalt+connect"></a>
-
-### cobalt.connect(slug, [payload]) ⇒ <code>Promise.&lt;Boolean&gt;</code>
-Connect the specified application, optionally with the auth data that user provides.
-
-**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
-**Returns**: <code>Promise.&lt;Boolean&gt;</code> - Whether the connection was successful.
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| slug | <code>String</code> |  | The application slug. |
-| [payload] | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | <code>{}</code> | The key value pairs of auth data. |
-
-<a name="Cobalt+disconnect"></a>
-
-### cobalt.disconnect(slug) ⇒ <code>Promise.&lt;void&gt;</code>
-Disconnect the specified application and remove any associated data from Cobalt.
-
-**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
-
-| Param | Type | Description |
-| --- | --- | --- |
-| slug | <code>String</code> | The application slug. |
-
-<a name="Cobalt+config"></a>
-
-### 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> - The specified config.
-
-| Param | Type | Description |
-| --- | --- | --- |
-| 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>
-Returns the specified config.
-
-**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
-**Returns**: <code>Promise.&lt;Config&gt;</code> - The specified config.
-
-| Param | Type | Description |
-| --- | --- | --- |
-| slug | <code>String</code> | The application slug. |
-| [configId] | <code>String</code> | The unique ID of the config. |
-
-<a name="Cobalt+updateConfig"></a>
-
-### 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> - The specified config.
-
-| Param | Type | Description |
-| --- | --- | --- |
-| payload | [<code>UpdateConfigPayload</code>](#UpdateConfigPayload) | The update payload. |
-
-<a name="Cobalt+deleteConfig"></a>
-
-### cobalt.deleteConfig(slug, [configId]) ⇒ <code>Promise.&lt;unknown&gt;</code>
-Delete the specified config.
-
-**Kind**: instance method of [<code>Cobalt</code>](#Cobalt)
-
-| Param | Type | Description |
-| --- | --- | --- |
-| slug | <code>String</code> | The application slug. |
-| [configId] | <code>String</code> | The unique ID of the config. |
-
-<a name="Application"></a>
-
-## Application : <code>Object</code>
-An application in Cobalt.
-
-**Kind**: global typedef
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| 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. |
-| [reauth_required] | <code>Boolean</code> | Whether the connection has expired and re-auth is required. |
-| [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="InputField"></a>
-
-## InputField : <code>Object</code>
-An Input field to take input from the user.
-
-**Kind**: global typedef
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| 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="ConfigPayload"></a>
-
-## 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. |
-| labels | <code>Object.&lt;string, Array.&lt;Label&gt;&gt;</code> | The dynamic label mappings. |
-
-<a name="Label"></a>
-
-## Label : <code>Object</code>
-Label Mapping
-
-**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="UpdateConfigPayload"></a>
-
-## 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. |
-| 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. |
-
-<a name="WorkflowPayload"></a>
-
-## WorkflowPayload : <code>Object</code>
-The workflow.
-
-**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. |
-| fields | <code>Object.&lt;string, (string\|number\|boolean)&gt;</code> | A map of workflow fields and their values. |
+Read the [SDK documentation here](https://gocobalt.github.io/cobalt-js).

package/cobalt.d.ts

@@ -0,0 +1,162 @@
+/**
+ * Cobalt Frontend SDK
+ */
+/** An application in Cobalt. */
+export interface Application {
+    /**The application name. */
+    name: string;
+    /**The application description. */
+    description: string;
+    /**The application icon. */
+    icon: string;
+    /**The application slug for native apps. */
+    type: string;
+    /** The application slug for custom apps. */
+    slug?: string;
+    /**The type of auth used by application. */
+    auth_type: "oauth2" | "keybased";
+    /** Whether the user has connected the application. */
+    connected?: boolean;
+    /** Whether the connection has expired and re-auth is required. */
+    reauth_required?: boolean;
+    /** The fields required from the user to connect the application (for `keybased` auth type). */
+    auth_input_map?: InputField[];
+}
+/** An Input field to take input from the user. */
+export interface InputField {
+    /** Key name of the field. */
+    name: string;
+    /** Input type of the field. */
+    type: string;
+    /** Whether the field is required. */
+    required: string;
+    /** The placeholder of the field. */
+    placeholder: string;
+    /** The label of the field. */
+    label: string;
+}
+/** The payload object for config. */
+export interface ConfigPayload {
+    /** The application slug. */
+    slug: string;
+    /**  Unique ID for the config. */
+    config_id?: string;
+    /** The dynamic label mappings. */
+    labels: Label[];
+}
+/** Label Mapping */
+export interface Label {
+    /** The label name. */
+    name: string;
+    /** The label value. */
+    value: string | number | boolean;
+}
+/** The configuration data for an application. */
+export interface UpdateConfigPayload {
+    /** The application slug */
+    slug: string;
+    /** Unique ID for the config. */
+    config_id?: string;
+    /** A map of application fields and their values. */
+    fields: Record<string, string | number | boolean>;
+    /** The config workflows data. */
+    workflows: WorkflowPayload[];
+}
+/** The workflow. */
+export interface WorkflowPayload {
+    /** The ID of the workflow. */
+    id: string;
+    /** Whether the workflow is enabled. */
+    enabled: boolean;
+    /** A map of workflow field names and their values. */
+    fields: Record<string, string | number | boolean>;
+}
+export interface CobaltOptions {
+    /** The base URL of the Cobalt API. You don't need to set this. */
+    baseUrl?: string;
+    /** The session token. */
+    token?: string;
+}
+type Config = any;
+declare class Cobalt {
+    private baseUrl;
+    token: string;
+    /**
+     * 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 the Cobalt API.
+     */
+    constructor(options?: CobaltOptions);
+    /**
+     * Returns the org & customer details for the associated token.
+     * @private
+     * @returns {Promise<unknown>}
+     */
+    getAccountDetails(): Promise<unknown>;
+    /**
+     * 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.
+     * @returns {Promise<Application>} The application details.
+     */
+    getApp(slug?: string): Promise<Application>;
+    /**
+     * Returns the auth URL that users can use to authenticate themselves to the
+     * specified application.
+     * @private
+     * @param {String} slug The application slug.
+     * @param {Object.<string, string>} [params] The key value pairs of auth data.
+     * @returns {Promise<String>} The auth URL where users can authenticate themselves.
+     */
+    private getOAuthUrl;
+    /**
+     * Handle OAuth for the specified native application.
+     * @private
+     * @param {String} slug The application slug.
+     * @param {Object.<string, string>} [params] The key value pairs of auth data.
+     * @returns {Promise<Boolean>} Whether the user authenticated.
+     */
+    private oauth;
+    /**
+     * Connect the specified application, optionally with the auth data that user provides.
+     * @param {String} slug The application slug.
+     * @param {Object.<string, string>} [payload] The key value pairs of auth data.
+     * @returns {Promise<Boolean>} Whether the connection was successful.
+     */
+    connect(slug: string, payload?: Record<string, string>): Promise<boolean>;
+    /**
+     * Disconnect the specified application and remove any associated data from Cobalt.
+     * @param {String} slug The application slug.
+     * @returns {Promise<void>}
+     */
+    disconnect(slug: string): Promise<void>;
+    /**
+     * Returns the specified config, or creates one if it doesn't exist.
+     * @param {ConfigPayload} payload The payload object for config.
+     * @returns {Promise<Config>} The specified config.
+     */
+    config(payload: ConfigPayload): Promise<Config>;
+    /**
+     * Returns the specified config.
+     * @param {String} slug The application slug.
+     * @param {String} [configId] The unique ID of the config.
+     * @returns {Promise<Config>} The specified config.
+     */
+    getConfig(slug: string, configId: string): Promise<Config>;
+    /**
+     * Update the specified config.
+     * @param {UpdateConfigPayload} payload The update payload.
+     * @returns {Promise<Config>} The specified config.
+     */
+    updateConfig(payload: UpdateConfigPayload): Promise<Config>;
+    /**
+     * Delete the specified config.
+     * @param {String} slug The application slug.
+     * @param {String} [configId] The unique ID of the config.
+     * @returns {Promise<unknown>}
+     */
+    deleteConfig(slug: string, configId: string): Promise<unknown>;
+}
+export { Cobalt };