@cobaltio/cobalt-js 7.0.1 → 8.0.1

package/cobalt.js

@@ -1,57 +1,15 @@
 /**
  * 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 {Boolean} [reauth_required] Whether the connection has expired and re-auth is required.
- * @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} ConfigPayload The payload object for config.
- * @property {String} slug The application slug.
- * @property {String} [config_id] Unique ID for the config.
- * @property {Object.<string, Label[]>} labels The dynamic label mappings.
- */
-
-/**
- * @typedef {Object} Label Label Mapping
- * @property {string} name The label name.
- * @property {string | number | boolean} value The label value.
- */
-
-/**
- * @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, string | number | boolean>} fields A map of application fields and their values.
- * @property {WorkflowPayload[]} workflows Whether the workflow is enabled.
- */
-
-/**
- * @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.
- */
-
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 class Cobalt {
     /**
      * Cobalt Frontend SDK
@@ -61,37 +19,27 @@ class Cobalt {
      */
     constructor(options = {}) {
         this.baseUrl = options.baseUrl || "https://api.gocobalt.io";
-        this.token = options.token;
+        this.token = options.token || "";
     }
-
-    get token() {
-        return this.sessionToken;
-    };
-
-    set token(token) {
-        return this.sessionToken = typeof token === "string" ? token : "";
-    };
-
     /**
      * Returns the org & customer details for the associated token.
      * @private
      * @returns {Promise<unknown>}
      */
-    async getAccountDetails() {
-        const res = await fetch(`${this.baseUrl}/api/v3/org/basics`, {
-            headers: {
-                authorization: `Bearer ${this.token}`,
-            },
+    getAccountDetails() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield fetch(`${this.baseUrl}/api/v3/org/basics`, {
+                headers: {
+                    authorization: `Bearer ${this.token}`,
+                },
+            });
+            if (res.status >= 400 && res.status < 600) {
+                throw new Error(res.statusText);
+            }
+            const data = yield res.json();
+            return data;
         });
-
-        if (res.status >= 400 && res.status < 600) {
-            throw new Error(res.statusText);
-        }
-
-        const data = await res.json();
-        return data;
     }
-
     /**
      * Returns the application details for the specified application, provided
      * the application is enabled in Cobalt. If no application is specified,
@@ -99,232 +47,225 @@ class Cobalt {
      * @param {String} [slug] The application slug.
      * @returns {Promise<Application>} The application details.
      */
-    async getApp(slug) {
-        const res = await fetch(`${this.baseUrl}/api/v2/f-sdk/application${slug ? `/${slug}` : ""}`, {
-            headers: {
-                authorization: `Bearer ${this.token}`,
-            },
+    getApp(slug) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield fetch(`${this.baseUrl}/api/v2/f-sdk/application${slug ? `/${slug}` : ""}`, {
+                headers: {
+                    authorization: `Bearer ${this.token}`,
+                },
+            });
+            if (res.status >= 400 && res.status < 600) {
+                throw new Error(res.statusText);
+            }
+            const data = yield res.json();
+            return data;
         });
-
-        if (res.status >= 400 && res.status < 600) {
-            throw new Error(res.statusText);
-        }
-
-        const data = await res.json();
-        return data;
     }
-
     /**
      * 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 | number | boolean>} [params={}] The key value pairs of auth data.
+     * @param {Object.<string, string>} [params] The key value pairs of auth data.
      * @returns {Promise<String>} The auth URL where users can authenticate themselves.
      */
-    async getOAuthUrl(slug, params) {
-        const res = await fetch(`${this.baseUrl}/api/v1/${slug}/integrate?${new URLSearchParams(params).toString()}`, {
-            headers: {
-                authorization: `Bearer ${this.token}`,
-            },
+    getOAuthUrl(slug, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield fetch(`${this.baseUrl}/api/v1/${slug}/integrate?${new URLSearchParams(params).toString()}`, {
+                headers: {
+                    authorization: `Bearer ${this.token}`,
+                },
+            });
+            if (res.status >= 400 && res.status < 600) {
+                throw new Error(res.statusText);
+            }
+            const data = yield res.json();
+            return data.auth_url;
         });
-
-        if (res.status >= 400 && res.status < 600) {
-            throw new Error(res.statusText);
-        }
-
-        const data = await res.json();
-        return data.auth_url;
     }
-
     /**
      * Handle OAuth for the specified native application.
      * @private
      * @param {String} slug The application slug.
-     * @param {Object.<string, string | number | boolean>} [params={}] The key value pairs of auth data.
+     * @param {Object.<string, string>} [params] The key value pairs of auth data.
      * @returns {Promise<Boolean>} Whether the user authenticated.
      */
-    async oauth(slug, params) {
-        return new Promise((resolve, reject) => {
-            this.getOAuthUrl(slug, params)
-            .then(oauthUrl => {
-                const connectWindow = window.open(oauthUrl);
-
-                // keep checking connection status
-                const interval = setInterval(() => {
-                    this.getApp(slug)
-                    .then(app => {
-                        if (app && app.connected === true && !app.reauth_required) {
-                            // close auth window
-                            connectWindow && connectWindow.close();
-                            // clear interval
-                            clearInterval(interval);
-                            // resovle status
-                            resolve(true);
-                        } else {
-                            // user closed oauth window without authenticating
-                            if (connectWindow && connectWindow.closed) {
+    oauth(slug, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => {
+                this.getOAuthUrl(slug, params)
+                    .then(oauthUrl => {
+                    const connectWindow = window.open(oauthUrl);
+                    // keep checking connection status
+                    const interval = setInterval(() => {
+                        this.getApp(slug)
+                            .then(app => {
+                            if (app && app.connected === true && !app.reauth_required) {
+                                // close auth window
+                                connectWindow && connectWindow.close();
                                 // clear interval
                                 clearInterval(interval);
-                                // resolve status
-                                resolve(false);
+                                // resovle status
+                                resolve(true);
                             }
-                        }
-                    })
-                    .catch(e => {
-                        console.error(e);
-                        clearInterval(interval);
-                        reject(e);
-                    });
-                }, 3e3);
-            })
-            .catch(reject);
+                            else {
+                                // user closed oauth window without authenticating
+                                if (connectWindow && connectWindow.closed) {
+                                    // clear interval
+                                    clearInterval(interval);
+                                    // resolve status
+                                    resolve(false);
+                                }
+                            }
+                        })
+                            .catch(e => {
+                            console.error(e);
+                            clearInterval(interval);
+                            reject(e);
+                        });
+                    }, 3e3);
+                })
+                    .catch(reject);
+            });
         });
     }
-
     /**
      * Connect the specified application, optionally with the auth data that user provides.
      * @param {String} slug The application slug.
-     * @param {Object.<string, string | number | boolean>} [payload={}] The key value pairs of auth data.
+     * @param {Object.<string, string>} [payload] The key value pairs of auth data.
      * @returns {Promise<Boolean>} Whether the connection was successful.
      */
-    async connect(slug, payload) {
-        return new Promise(async (resolve, reject) => {
-            try {
-                const app = await this.getApp(slug);
-
-                // oauth
-                if (app?.auth_type ==="oauth2") {
-                    const connected = await this.oauth(slug, payload);
-                    resolve(connected);
-                // key based
-                } else {
-                    const res = await fetch(`${this.baseUrl}/api/v2/app/${slug}/save`, {
-                        method: "POST",
-                        headers: {
-                            authorization: `Bearer ${this.token}`,
-                            "content-type": "application/json",
-                        },
-                        body: JSON.stringify({
-                            ...payload,
-                        }),
-                    });
-
-                    if (res.status >= 400 && res.status < 600) {
-                        reject(new Error(res.statusText));
+    connect(slug, payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    const app = yield this.getApp(slug);
+                    // oauth
+                    if (app && app.auth_type === "oauth2") {
+                        const connected = yield this.oauth(slug, payload);
+                        resolve(connected);
+                        // key based
+                    }
+                    else {
+                        const res = yield fetch(`${this.baseUrl}/api/v2/app/${slug}/save`, {
+                            method: "POST",
+                            headers: {
+                                authorization: `Bearer ${this.token}`,
+                                "content-type": "application/json",
+                            },
+                            body: JSON.stringify(Object.assign({}, payload)),
+                        });
+                        if (res.status >= 400 && res.status < 600) {
+                            reject(new Error(res.statusText));
+                        }
+                        const data = yield res.json();
+                        resolve(data.success);
                     }
-
-                    const data = await res.json();
-                    resolve(data.success);
                 }
-            } catch (error) {
-                reject(error);
-            }
+                catch (error) {
+                    reject(error);
+                }
+            }));
         });
     }
-
     /**
      * Disconnect the specified application and remove any associated data from Cobalt.
      * @param {String} slug The application slug.
      * @returns {Promise<void>}
      */
-    async disconnect(slug) {
-        const res = await fetch(`${this.baseUrl}/api/v1/linked-acc/integration/${slug}`, {
-            method: "DELETE",
-            headers: {
-                authorization: `Bearer ${this.token}`,
-            },
+    disconnect(slug) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield fetch(`${this.baseUrl}/api/v1/linked-acc/integration/${slug}`, {
+                method: "DELETE",
+                headers: {
+                    authorization: `Bearer ${this.token}`,
+                },
+            });
+            if (res.status >= 400 && res.status < 600) {
+                throw new Error(res.statusText);
+            }
         });
-
-        if (res.status >= 400 && res.status < 600) {
-            throw new Error(res.statusText);
-        }
     }
-
     /**
      * 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.
      */
-    async config(payload) {
-        const res = await fetch(`${this.baseUrl}/api/v2/f-sdk/config`, {
-            method: "POST",
-            headers: {
-                authorization: `Bearer ${this.token}`,
-                "content-type": "application/json",
-            },
-            body: JSON.stringify(payload),
+    config(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield fetch(`${this.baseUrl}/api/v2/f-sdk/config`, {
+                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 yield res.json();
         });
-
-        if (res.status >= 400 && res.status < 600) {
-            throw new Error(res.statusText);
-        }
-
-        return await res.json();
     }
-
     /**
      * 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.
      */
-    async getConfig(slug, configId) {
-        const res = await fetch(`${this.baseUrl}/api/v2/f-sdk/slug/${slug}/config${configId ? `/${configId}` : ""}`, {
-            headers: {
-                authorization: `Bearer ${this.token}`,
-            },
+    getConfig(slug, configId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield fetch(`${this.baseUrl}/api/v2/f-sdk/slug/${slug}/config${configId ? `/${configId}` : ""}`, {
+                headers: {
+                    authorization: `Bearer ${this.token}`,
+                },
+            });
+            if (res.status >= 400 && res.status < 600) {
+                throw new Error(res.statusText);
+            }
+            return yield res.json();
         });
-
-        if (res.status >= 400 && res.status < 600) {
-            throw new Error(res.statusText);
-        }
-
-        return await res.json();
     }
-
     /**
      * Update the specified config.
      * @param {UpdateConfigPayload} payload The update payload.
      * @returns {Promise<Config>} The specified config.
      */
-    async updateConfig(payload) {
-        const res = await fetch(`${this.baseUrl}/api/v2/f-sdk/config`, {
-            method: "PUT",
-            headers: {
-                authorization: `Bearer ${this.token}`,
-                "content-type": "application/json",
-            },
-            body: JSON.stringify(payload),
+    updateConfig(payload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield fetch(`${this.baseUrl}/api/v2/f-sdk/config`, {
+                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 yield res.json();
         });
-
-        if (res.status >= 400 && res.status < 600) {
-            throw new Error(res.statusText);
-        }
-
-        return await res.json();
     }
-
     /**
      * Delete the specified config.
      * @param {String} slug The application slug.
      * @param {String} [configId] The unique ID of the config.
      * @returns {Promise<unknown>}
      */
-    async deleteConfig(slug, configId) {
-        const res = await fetch(`${this.baseUrl}/api/v2/f-sdk/slug/${slug}/config${configId ? `/${configId}` : ""}`, {
-            method: "DELETE",
-            headers: {
-                authorization: `Bearer ${this.token}`,
-            },
+    deleteConfig(slug, configId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield fetch(`${this.baseUrl}/api/v2/f-sdk/slug/${slug}/config${configId ? `/${configId}` : ""}`, {
+                method: "DELETE",
+                headers: {
+                    authorization: `Bearer ${this.token}`,
+                },
+            });
+            if (res.status >= 400 && res.status < 600) {
+                throw new Error(res.statusText);
+            }
+            return yield res.json();
         });
-
-        if (res.status >= 400 && res.status < 600) {
-            throw new Error(res.statusText);
-        }
-
-        return await res.json();
     }
 }
-
-module.exports = Cobalt;
+export { Cobalt };