@cobaltio/cobalt-js 8.7.2 → 8.8.0

package/README.md

@@ -56,4 +56,8 @@ cobalt.token = "COBALT_SESSION_TOKEN";
 
 # Documentation
 
-Read the [SDK documentation here](https://gocobalt.github.io/cobalt-js).
+- You can read the [SDK documentation here](https://gocobalt.github.io/cobalt-js).
+
+- [`llms.txt`](https://gocobalt.github.io/cobalt-js/llms.txt)
+
+  This documentation is also available in [llms.txt](https://llmstxt.org) format, which is a simple markdown standard that LLMs can consume easily.

package/cobalt.d.ts

@@ -134,7 +134,45 @@ interface PaginationProps {
     page?: number;
     limit?: number;
 }
-type Config = any;
+export interface Config {
+    slug: string;
+    config_id?: string;
+    fields?: ConfigField[];
+    workflows?: ConfigWorkflow[];
+    field_errors?: {
+        id: string;
+        name: string;
+        error: {
+            message: string;
+            error?: unknown;
+        };
+    }[];
+}
+export interface ConfigField {
+    id: string;
+    name: string;
+    field_type: "text" | "date" | "number" | "url" | "email" | "textarea" | "select" | "json" | "map" | "map_v2" | "rule_engine" | string;
+    options?: {
+        name?: string;
+        value: string;
+    }[];
+    parent?: string;
+    labels?: {
+        name?: string;
+        value: string;
+    }[];
+    multiple?: boolean;
+    required?: boolean;
+    hidden?: boolean;
+    value?: any;
+}
+export interface ConfigWorkflow {
+    id: string;
+    name: string;
+    description?: string;
+    enabled: boolean;
+    fields?: ConfigField[];
+}
 declare class Cobalt {
     private baseUrl;
     token: string;
@@ -297,5 +335,11 @@ declare class Cobalt {
      * @returns {Promise<PublicWorkflow>} The created public workflow.
      */
     createWorkflow(params: PublicWorkflowPayload): Promise<PublicWorkflow>;
+    /**
+     * Delete the specified public workflow.
+     * @param {String} workflowId The workflow ID.
+     * @returns {Promise<unknown>}
+     */
+    deleteWorkflow(workflowId: string): Promise<unknown>;
 }
 export { Cobalt };

package/cobalt.js

@@ -518,5 +518,25 @@ class Cobalt {
             return yield res.json();
         });
     }
+    /**
+     * Delete the specified public workflow.
+     * @param {String} workflowId The workflow ID.
+     * @returns {Promise<unknown>}
+     */
+    deleteWorkflow(workflowId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const res = yield fetch(`${this.baseUrl}/api/v2/public/workflow/${workflowId}`, {
+                method: "DELETE",
+                headers: {
+                    authorization: `Bearer ${this.token}`,
+                },
+            });
+            if (res.status >= 400 && res.status < 600) {
+                const error = yield res.json();
+                throw error;
+            }
+            return yield res.json();
+        });
+    }
 }
 exports.Cobalt = Cobalt;

package/cobalt.ts

@@ -149,7 +149,48 @@ interface PaginationProps {
     limit?: number;
 }
 
-type Config = any;
+export interface Config {
+    slug: string;
+    config_id?: string;
+    fields?: ConfigField[];
+    workflows?: ConfigWorkflow[];
+    field_errors?: {
+        id: string;
+        name: string;
+        error: {
+            message: string;
+            error?: unknown;
+        };
+    }[];
+}
+
+export interface ConfigField {
+    id: string;
+    name: string;
+    field_type: "text" | "date" | "number" | "url" | "email" | "textarea" | "select" | "json" | "map" | "map_v2" | "rule_engine" | string;
+    options?: {
+        name?: string;
+        value: string;
+    }[];
+    parent?: string;
+    labels?: {
+        name?: string;
+        value: string;
+    }[];
+    multiple?: boolean;
+    required?: boolean;
+    hidden?: boolean;
+    value?: any;
+}
+
+export interface ConfigWorkflow {
+    id: string;
+    name: string;
+    description?: string;
+    enabled: boolean;
+    fields?: ConfigField[];
+}
+
 type Field = any;
 
 class Cobalt {
@@ -695,6 +736,27 @@ class Cobalt {
 
         return await res.json();
     }
+
+    /**
+     * Delete the specified public workflow.
+     * @param {String} workflowId The workflow ID.
+     * @returns {Promise<unknown>}
+     */
+    async deleteWorkflow(workflowId: string): Promise<unknown> {
+        const res = await fetch(`${this.baseUrl}/api/v2/public/workflow/${workflowId}`, {
+            method: "DELETE",
+            headers: {
+                authorization: `Bearer ${this.token}`,
+            },
+        });
+
+        if (res.status >= 400 && res.status < 600) {
+            const error = await res.json();
+            throw error;
+        }
+
+        return await res.json();
+    }
 }
 
 export { Cobalt };

package/docs/assets/navigation.js

@@ -1 +1 @@
-window.navigationData = "eJyN0sFKAzEQBuB3mfNisaDI3kQUhEKLIB6Kh9nsrA2dJqEziy2l7y5asLuQTnPN/8+XMGR5AKWdQg1PsUFWqCChrqAGxyhCMjmd36x0w1DB2ocW6tvpw7H6n3xMib1D9TGcx31Q2nboSCaDfMxM7+4HzOmiefrtSRYaNWwqdP5rgXuO2F6gBg2LenZR9qK0mdEFatQopqzH5YoW/BpSry+eOM+dYwuZYUOcnf9LrNFF37B3H3G77jh+Z41xpRyz1pRtltNSbksB/tYzWZ93kFvMe2pR6foHzvQstmSfVzf5+QNokXI8"
+window.navigationData = "eJyN01FLwzAQB/Dvcs/F4UCRvokoCIMNQXwQH67p1YXdkrBc0SF+d9mmroX0ktf+//drcyWvXyD0KVDDnW+QBSoIKGuowTDGSHF2en6xli1DBRvrWqgv5zff1f/kbQhsDYr17jxundCuQ0NxNsjHzPzqesCcXrQMh15MQqOGTrnOvk8Yhyg//GCJW0U45nlmhXv2qEG/jTz14nebjv2HYv1VNOze+LiPQtsFTXzXqFFMaSdNFTX40YVepv/AOdaQBTbEyfljoo2u+oatURc+rpRj2pqSzXI6ltuxAH/qmbTbOMg15jm0KJS/DYmexpbsM7vJtx/uYLj5"

package/docs/assets/search.js

@@ -1 +1 @@
-window.searchData = "eJy1m9tu40gOht9FudWkXUfZuRsMdoABBtjBArN7YQSBYqvTQiu2R7I72wj63Relg0WaLJlWZq+c2CT/quJXrNKh3pN6/9YkD+v35Gu52yYPSi/TZJe/FslD8sv+Oa+OSZqc6ip5SDZV3jRF86n7+v7L8bVK0uHb5CFJfqRDFKf0Ocpmv2uO9Wlz3NdToe6wHQibJoe8LnbHsUWjkFpoe1Y67r8Wu0mNwUIYXS/sEvbjc/lyrQudycz4u2IzOdx3o80shbrIj8U/Nvvme3MsXn8v8u20WmtfDPZVZz9f+T/7+uvnav8mEH0bTefobYuqOBa/XM9YZ/ihvEGtX8uimh5TKPi5t56lWjYSYJDZHJ2X4vjz4TCp8VIc89ZkfvxGINDMVxCA8FIcP0TBWeU6Amepj+T/rHd16DZns5k6bY/+eTiW+91VsbZL+7PtTMWhUFyVewOGc7ROh20uqhOd4YcIgVrXIYGCt3Li/Fn058OhKjd5yMdZrtwdi/pzvimaT+DnyfUcLbP56fjlqdwdTsen1/wgCXtHXPiuwNZOiR+/Hwq5bm89W7IvoMVWJAmtZ0tui2ZTlwdp2u6w/WzZciPU6w1nC7UfEqHecLZQXbQI1MVfp7IWZpD6zJZvqtOLSLM3nC0knhEzJgOsJ12xuVwMgCAykNeU57wp/qwrWcS7YH2qqyslcWil6GphWlBy3UDl8MCFSv5H/r3a5yyGyEA+cN0K8VQKY95B+1hvYEsjslX+XFQRAIjm2fgDgrGZxMhNzqWYGMwVf4UERJGBPFeRLNFod1P5wa2LYdFeRW2f8qNQETl8QPjKysUoS9YukXTxmpdsBWFEB9sPyMXWMEZtchWLiUWJnCginJ2cz1tyh2bczSm8MtllmURNuCGhV8RFeUXa8vTOLHJx6clad0UaAvZb2JvjqxKgP/4qh6kt+oJgd4Mh3wfQsBvzdakzmaXrMocq3xRf9tW2qCVq2Hyu6NS+9VLx6n71ulxsF3kpNbmJZGUga7/HyGh/kBMWS/wYZjrnXTsiwb/l1ela9MFGFh4OwR+n56rckPuhQAZbfHiPwYSb3GRcNHDegsGJSpYKmXgs/ZzqJAdRuXjGJpZg1vBvW4Pj0WeM7MyFcKINN4zzzKVwQnxyLbwmHs91I052c3O2q/K1ZHfoE4HvBqcx/LHZ/lQ2P5W7L0VddreeIh1vrgz7IX8R5By3p/f5fzRHRkEzFwNGHnLwr1NVTNzqAD/fdL2+LYNPXj1t9tviqTlu9yeWgcv4d3FfvrOw/bGddl3v2f0MER8sZ0vVp6p42uyr0ytb2Yggtr9FFubwT3DXfWIiM2Z/0z2YWGTBnRiu7ZEmtI8IWEqj+meXD4vHZmlUenKK3iD8Rp4TSdSvPzSabgLES7AhmL0VKHb5c8Xv/dn1b7TneyVceeMosapXMBKK8nOHFZyYMETsMU3K3bb4b/Lwnnwr6ibsjR4SfW/uV0k69PRhPWx1NvvX1xApTbb7zan987E3+3cRXkwJxp31p0WSrhepXdwvlHl8TNeDc/tD+8UQY/ymdVRJulacoyKOCjnqJF3r1Nj71cIiR00cNXI0Sbo2nKIhjgY52iRdW87REkeLHF2Srh3n6IijQ44+Sdeec/TE0SPHLEnXGeeYEccMOS6TdL3kHJfEcYkcV0m6XnGOK+K4wgAEHhTLjqLwqAt6Wnx4fhiAMEEqcKE060whUpgiFdhQLEeKgqQwSSrwoViWFIVJYZpUYESxPCkKlMJEqcCJYplSFCqFqVKBFcVypShYCpOlAi+KZUtRuBSmSwVmFMuXooApTJgOzGiWME0J05gwHZjRLGGaEqYvalRbpFjCNFOmMGE6MKNNqrP7hca+FDCNAdMBGc0CpilgGgOmAzLapdrcr9QSO1PANAZMB2Q0C5imgGkMmA7I6CzV7t7YFXamgGkMmA7I6CW7JFDANAZMB2Q0C5imgGkMmAnIGBYwQwEzGDCjYguZoXwZzJcJxBgWTkP5MhfrYLsQ8srMUogBMwEZwy+jFDCDATMummZDATMYMBOQMSzahgJmMGAmIGMc22cKmMGAmYCMYdE2FDCDATOr2Gw2lC+D+bItXxnXakv5spgvq6Kz2VLALAbMtoCxRdtSwCwGzEYLmKV82Yu9lo13mdluYb5svIBZypfFfFkfhdNSvizmy7Z8sWXEUr4s5ssGYuyC7TPly2K+7CreZwqYxYC5gIxl64ijgDkMmAvIWHaRcxQwhwFzOlq0HQXMYcCciQ6Yo4Q5TJiz0QFzlDB3saMPzFi2/DlmU48Jc4EZy1YwRwlzmDAXr2COEuYwYW4Zm5GOAuYwYC4OmKOAOQyYbwFj96yeAuYxYF7FWu0pXx7z5XW01Z7y5TFf3kRLgad8ecyXby8X+as3ypfHfPmWL3an7Slf/uKqseWLLdqeuXDEfPn4FsxTvjzmy7cVjC1/ngLmMWA+IOPYXZSngHkMWBaQcWwFyyhgGQYsC8w4toJllLAME5YFZhxbCjJKWIYJy+J7sIwSlmHCssCMs6wzJSzDhGXxPVhGCcswYVlgxrHTOaOEZRf3JgIzjp0YGXN7AhOWBWYcf2uDEpZhwrJVfMAoYRkmbNkSxt8boYT1X7V33L4V9bHY/tbdeVuvu4fS78lTfy/OuOG+33tisuTh/UeauPbzx3gPrv32fBsu/Bbkcvg++xhRrcaIaiWLdPFK+hhML8ZgeiEP1r0VAeIoEEeJ4pxfbAWDBVpjZK3Z9Of2xiAgxi0hzgc5QKfASGvZSEcfW41RHWigF0dtz2KAkQIDdUOISzg1CGM6z+yWeIfhUQCICUgwWhqrO7U1RrFjEHtLjAK1RYP+aXFbxpOZYNKBOSeLA94xBYPjweAsbwh0cTAR0DQGdDfEG88cjqFA27woFD5QOAbKxkCySsccFByjLcdoshFDL4cAGMCc0T3sZtV92v5/t+w+vSzJ8MThKASqhmx6R5NrwDQwspygWNz0BMNpZVOif90UxAAJtot+BGXT9PzcDhAMcZFluH8+D2KA+ZnJqv7wLA8EAaOd2b4ayjI4HAsFBQNUeSVr0fnoJ4gC646MSXC4E8QBhVDJsn55chMEAxNJyVYLeDQTBAIDrmT8kGOXIBoohUpWC/GpShAKlEIlm3fdKTFQbUDftKxveG12sO7JAGp3eCRdBtQjK6vH/WvKYDkGNNu+RjpZ6ocDMaBBcPMiG5r+NTDQIFA0vCzZ3XNvkCHAi3Z9FVP95/B/vz64vhy4/n8vm0Pd22Kg1SCnXsYVercaRAKFwcnoOLSvg3ELvwWsOmGzUDBmnbFgdP2cBjZcULhFkZFDDjgCAEA0Les2F8aC2upkNRq97gWmPIiUySMxtdCCOe9la2r3nhIYHTDDdH/haoZp4ftp0G+bfP97JpuJ/QlDoAWkeiVZ98llKJhgeqhTsrmKT72DtQCMg5KVT+Y8O4gHmqhkqYHxmFnhQD3NZJ391r3ND4ABMZwsixOT34GZlcnGjF2HHSgimWCGPqbJoTwUVbkrkof1448f/wPIUkup";
+window.searchData = "eJy1nNuO20gOht9FfavpuI6S+m4w2AUGGGAHC8zuhRE0HFvpCFHbXh+SDYK8+6J0sEiRJdHq7FUnNsm/Dl+RpZKl78np8PWcPK2/J5+r/S55UjpPk/3mtUyekt8OHzb1JUmT66lOnpJtvTmfy/O79uPHT5fXOkn7T5OnJPmR9lGc0rco28P+fDldt5fDaSrUA7YDYdPkuDmV+8vQokFIrbS9KV0On8v9pEZvIYyuVzaH/fhYvcx1oTVZGH9fbieH+2GwWaRwKjeX8m/bw/nb+VK+/lFudtNqjX3Z29et/XLlfx9Onz/Wh68C0a+D6RK9XVmXl/K3+RlrDd80b1Dr71VZT48pFPzYWS9XFY1oa/rWEa3OEkCR2RKdl/Ly6/E4qfFSXjaNyfL4Z4HAebmCALyX8vIm6m4q88jdpN7C201vdui2N7OFOk2P/nG8VIf9rFjTpcPNdqFiv4xm5b4CwyVa1+NuI8pLreGbCIFa85BAwXs5cf4m+uvxWFfbTZiPm1y1v5Snj5tteX4Hvp7cP6CyvrlePj1X++P18vy6OUrCPhAXviuwtVPil2/HUq7bWS+W7BJouRNJQuvFkrvyvD1VR+m0PWD7xbLVVqjXGS4Wav5IhDrDxUKnskHgVP7nWp2EM0h9Fsuf6+uLSLMzXCwkXhELFgPMJ22yGRcDIIgM5Dnlw+Zc/nWqZREfgvX1VM+kxL6VoquTaUHJdQqVwwOHagySC9/Ih6qtCc8VCzMI9gANYw1vGhURasrOc3k6HU6RqR60RraL5WRCSyViyxEKTK7E6fBfybYloiHZtoyEKEt4D0GUmq/lVLUTGEsj45APyHyqC20rI6Kfqt0utgZHgjfTxWJTCwYIzS6XSZF686GsJ+YfCN1MF4u9XutLdaxlMwaMFwvGyjYRmyzbAqHDVIEZac1fbczKdbYStZvpYrGpvQiRm92ECAS/bOqrbNp6y3ukaGL6c/OtPmwm+tcZ/NSSB2OKK1/f0oWLGWmKlvOM4HR9QnKCMkXF6FyRAyui2lvIZ2vm4oUJK7p+GTU4Il7uNx/qqcWFhQfzt4jObV2wpmgLMyc5tRaw3OwqmJOazvpYTJD4GTnIJX8cDmSRgZzKSPag0R6m8gZuXSxdNUfmu+cNW1IYReTwBuGZlccoSxaeSLp83VTs5Rsj2tu+QS7GJKM2iWRMLErkRHHj7H5a1owGv38KZ4qQbCZRE+6Y0Blx0bwibfn0Liy+cenJGjwjDQH7PRyMRi/nhm/lMDWbEUGwh96Q7wNo2J3zNdaZnKV5mWO92ZafDvWuPEnUsPlS0amN+lhxdp8+Lxe79h5LTV50szKQtT9iZDRfyAmLTfwQZnrO23bce8UCok9fq4zDwyH48/qhrrZTO19s8eY9BhNucpMxauCygsGJSkqFTDw2/ZzqJAdRufiMTZRg1vCn1eB49AUju7AQTrThjnFeWAonxCdr4Zx4fK7P4sk+3z3bdfVasTv0icAPvdMQ/nLe/VKdf6n2n8pT1d73i3T8PDPsx82LYM5xezqf/0dzZBScl2LAyEMO/nmty4n7TODru86RdlXw2dTP28OufD5fdocry8A4/kPcl+8sbH9spx1ul4jEe8vFUqdrXT5vD/X1lc1sRBDb3yML5/Av8JOHiYXMmP2ks8FYZMEJIdf2u49/ovozZ0B3iMdWaVR6coneITx5tyuqPn/ra7oJEC/BhmDxVmDiHJGtf3MHicLKG0eJVZ3BSCjKrx1WcGLBELH3aVLtd+V/k6fvyZfydA57o6dEP5rHIkn7nj6t+63O9vD62t5a2R221+af7zuzf5XhV8jBuLV+t0rS9Sq1+tHl79+n6963+bz5oA8xfNL4qSRdK8ZPET+F/HSSrnVqskebKeSoiaNGjiZJ14ZzNMTRIEebpGvLtNQSP4v8XJKuHePniJ9Dfj5J157x88TPI78sSdcZ45cRvwz55Um6zhm/nPjlyK9I0nXB+BXEr8AzH0BQHDOKQqNG1DTYsNww4GByVOBBac6XsqMwPCogoQznS/FRmB8VsFAcQYoipDBDKqChOIoUxUhhjlTAQ3EkKYqSwiypgIjiaFIUJ4V5UgETxRGlKFIKM6UCKoqjSlGsFOZKB1Q0x5WmXGnMlQ6oaI4rTbnSo4zUpCSOK83kJMyVDqhojitNudKYKx1Q0TbV2WOhPHamYGkMlg6saA4sTcHSGCwdWNE+1fZR6VESpmRpTJYOsGiOLE3J0pgsHWDRear9o80ddqZoaYyWDrTogi0dlC2N2TIBF8OxZShbBrNlAi6GY8tQtgxmy0TLnaFsmVHBi1c8puRhtkygxejU2Ee1yrAzZctgtkzAxXBQG8qWwWyZQIuxqVGPrrDYmbJlMFsmi/JhKFwGw2UCLsax40XhMhguE3AxXK41lC2D2bINW9yKsJQti9myDVtcrrWULYvZsgEXU3BzbClcFsNlAy92xY2WpXTZ0Y6q2VJxK8IymyoMl3XR5GMpXRbTZQMvlkvVlsJlMVw24GI5qi1ly2K2bKDFWna0KFsWs2UDLpYF01K4LIbLBV4sB6ajcDkMl1PRJOAoXQ7T5XQUEEfpcpguZ6IL2VG6HKbLNXRx68lRutxoz+6iNdUx+3ZMl2voytkuU7wcxstl0cTnKF8O8+Xy6FJ2lC+H+XJFdEU5ypfDfPmGL27D5ilfHvPlAzGORcRTvjzmywdiHJdDPMXLY7y8ic6yp3h5jJcPxDi2JnvKl8d8+Xj28pQvP7owDMQ4LgN55toQ4+WzeJcpXh7j5fN4lyleHuPl43h5ipfHeGWraCLIKF8Z5itr+OIuvDKKV4bxyhq82KSbUb4yzFdmol3OKF8Z5itr+OIydkbxyjBemYvWmYzilWG8Mh/dIGeUr2x0+JDFx4s5gMB8ZXl8vChfGeYri5fHjPKVYb7yQIzjakVO8coxXnk8feWUrxzzlevoeswpXznmK4/zlVO+csxX3vDFHvhQvnLMVx4vjznlK8d85fHLxpzylWO+8vjWPqd85aMTriZ/cUUqZw65MF55AMZzV345pSvHdBUBGM/VqILSVWC6ChXtcEHpKjBdReDFc/vcgsJVYLiKgIvnqkxB2SowW0XAxXMZt6BsFZitItDiuROJgqJVYLSK5syUy5kFJavAZBVZdJdbULIKTFaRR3dtBUWrGB2gFvEpZg5Rx6eoq+j1avsddgefdf4BGc8e8a2Ys9TV6DB1paOb3fa7sf/oQHVloiPXfjf2Hx2qrmx0y9t+N/ZvP2vuhHwpT5dy93t7R2S9bn8s9D157u6RuFV/P+Z74lXy9P1HmuTN3x/DvZHm09vtkfBd0NvAh7yHiBpE1CtZpNFz2iCYAsGEzRoevgZxNIijRXFuT3sOUQxojZG1Ztu9PGcIAoZHNjptiNvzRqA5IJSRxor8nGCI6s0QtTDSqM1TpqBpoGWtk7kn1AhSA2bP2NbTdbAW2R1xu1cagMgeRC7uiHTsb/4OsSyI5cTT8bF6Gd7JAoJlIJiVBmvfuAKiDEHuilGijmkwm1o8jcNbnIZIYP0Ilw94RAEkLRDHy1Yz+xIjEBGM9h3xuJkDFHhRKPzyoSEQIEDGOPNSoSFaPkTL74jG9bAACUIYCvxMEXAF8NT9snbtX9+lDZ91NUl3f2XTA19ABPADCVPJVmiUGAtGwS+IxSQQB9aZl7HTPQIBYoBU6bsx9bIJv/2WBHQSUON86xd2N6Jw7Y/HwMIA013I0hF+vh+kbVhfZETAR8dBILDIrGwW+x+/gCCgY6YbJddxW+T9qMkSZ/9WKwAtTJqyrHl7cxWIArhQsgkE76YCccDIK3GXIjlJgYFTMiLgm6VAIJC/lYwH8tYoEA2kcCVbh/ilUCAU4EvJsnj/ygHAF1iFVkZA+6YckGrBAGnZAI22YCDd2S4XuxvbsrlrdvgEAgcgyGS96x4fAjFA97KudZlsuPsHqEHSA1XCdmXIyZZM9zNtkPNArFxWLIc3JoAmgRxgZYPdmEMCANS6S1K2K7au6ApFX3y7/2dd77NuovPu/7lsUTBLy4I0ZGVR2p+agyEFY1HIUnb/9gTQDpDGrAwU9HQXQA+MayabmmPzg3RuZ+VAusiFfUPBuF0F3PktaeCZCwrSQS7bXpD3WwE2Qbe1bDa4MBZe7nTIZrJkh354DlgDeaWQR2LA9wD8QpZM2l9Mg1ECE6m77plum+H6lbrqVmi//eivkmW5p3vhFNAEkp2irPHkAAYAo/v0IksA+CWIoLaC8VAyBpnXG4J4oIlKNl4wHrNKPMgNhayzX9rnCwHUAEHbD5ysdRNJwcN9yUpWddkNjgHNM7f9gCB1vU+TY3Us62pfJk/r9z9+/A/Dtjjm";