@budibase/types 2.5.6-alpha.4 → 2.5.6-alpha.5

package/dist/cjs/documents/app/automation.d.ts

@@ -1,6 +1,30 @@
 /// <reference types="node" />
 import { Document } from "../document";
 import { EventEmitter } from "events";
+export declare enum AutomationIOType {
+    OBJECT = "object",
+    STRING = "string",
+    BOOLEAN = "boolean",
+    NUMBER = "number",
+    ARRAY = "array"
+}
+export declare enum AutomationCustomIOType {
+    TABLE = "table",
+    ROW = "row",
+    ROWS = "rows",
+    WIDE = "wide",
+    QUERY = "query",
+    QUERY_PARAMS = "queryParams",
+    QUERY_LIMIT = "queryLimit",
+    LOOP_OPTION = "loopOption",
+    ITEM = "item",
+    CODE = "code",
+    FILTERS = "filters",
+    COLUMN = "column",
+    TRIGGER_SCHEMA = "triggerSchema",
+    CRON = "cron",
+    WEBHOOK_URL = "webhookUrl"
+}
 export declare enum AutomationTriggerStepId {
     ROW_SAVED = "ROW_SAVED",
     ROW_UPDATED = "ROW_UPDATED",
@@ -9,6 +33,11 @@ export declare enum AutomationTriggerStepId {
     APP = "APP",
     CRON = "CRON"
 }
+export declare enum AutomationStepType {
+    LOGIC = "LOGIC",
+    ACTION = "ACTION",
+    TRIGGER = "TRIGGER"
+}
 export declare enum AutomationActionStepId {
     SEND_EMAIL_SMTP = "SEND_EMAIL_SMTP",
     CREATE_ROW = "CREATE_ROW",
@@ -28,21 +57,44 @@ export declare enum AutomationActionStepId {
     zapier = "zapier",
     integromat = "integromat"
 }
+export declare const AutomationStepIdArray: (AutomationActionStepId | AutomationTriggerStepId)[];
 export interface Automation extends Document {
     definition: {
         steps: AutomationStep[];
         trigger: AutomationTrigger;
     };
+    screenId?: string;
+    uiTree?: any;
     appId: string;
     live?: boolean;
     name: string;
+    internal?: boolean;
+    type?: string;
+}
+interface BaseIOStructure {
+    type?: AutomationIOType;
+    customType?: AutomationCustomIOType;
+    title?: string;
+    description?: string;
+    enum?: string[];
+    pretty?: string[];
+    properties?: {
+        [key: string]: BaseIOStructure;
+    };
+    required?: string[];
+}
+interface InputOutputBlock {
+    properties: {
+        [key: string]: BaseIOStructure;
+    };
+    required?: string[];
 }
 export interface AutomationStepSchema {
     name: string;
     tagline: string;
     icon: string;
     description: string;
-    type: string;
+    type: AutomationStepType;
     internal?: boolean;
     deprecated?: boolean;
     stepId: AutomationTriggerStepId | AutomationActionStepId;
@@ -51,14 +103,10 @@ export interface AutomationStepSchema {
         [key: string]: any;
     };
     schema: {
-        inputs: {
-            [key: string]: any;
-        };
-        outputs: {
-            [key: string]: any;
-        };
-        required?: string[];
+        inputs: InputOutputBlock;
+        outputs: InputOutputBlock;
     };
+    custom?: boolean;
 }
 export interface AutomationStep extends AutomationStepSchema {
     id: string;
@@ -107,3 +155,4 @@ export declare type AutomationStepInput = {
     appId: string;
     apiKey?: string;
 };
+export {};

package/dist/cjs/documents/app/automation.js

@@ -1,6 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AutomationStatus = exports.AutomationActionStepId = exports.AutomationTriggerStepId = void 0;
+exports.AutomationStatus = exports.AutomationStepIdArray = exports.AutomationActionStepId = exports.AutomationStepType = exports.AutomationTriggerStepId = exports.AutomationCustomIOType = exports.AutomationIOType = void 0;
+var AutomationIOType;
+(function (AutomationIOType) {
+    AutomationIOType["OBJECT"] = "object";
+    AutomationIOType["STRING"] = "string";
+    AutomationIOType["BOOLEAN"] = "boolean";
+    AutomationIOType["NUMBER"] = "number";
+    AutomationIOType["ARRAY"] = "array";
+})(AutomationIOType = exports.AutomationIOType || (exports.AutomationIOType = {}));
+var AutomationCustomIOType;
+(function (AutomationCustomIOType) {
+    AutomationCustomIOType["TABLE"] = "table";
+    AutomationCustomIOType["ROW"] = "row";
+    AutomationCustomIOType["ROWS"] = "rows";
+    AutomationCustomIOType["WIDE"] = "wide";
+    AutomationCustomIOType["QUERY"] = "query";
+    AutomationCustomIOType["QUERY_PARAMS"] = "queryParams";
+    AutomationCustomIOType["QUERY_LIMIT"] = "queryLimit";
+    AutomationCustomIOType["LOOP_OPTION"] = "loopOption";
+    AutomationCustomIOType["ITEM"] = "item";
+    AutomationCustomIOType["CODE"] = "code";
+    AutomationCustomIOType["FILTERS"] = "filters";
+    AutomationCustomIOType["COLUMN"] = "column";
+    AutomationCustomIOType["TRIGGER_SCHEMA"] = "triggerSchema";
+    AutomationCustomIOType["CRON"] = "cron";
+    AutomationCustomIOType["WEBHOOK_URL"] = "webhookUrl";
+})(AutomationCustomIOType = exports.AutomationCustomIOType || (exports.AutomationCustomIOType = {}));
 var AutomationTriggerStepId;
 (function (AutomationTriggerStepId) {
     AutomationTriggerStepId["ROW_SAVED"] = "ROW_SAVED";
@@ -10,6 +36,12 @@ var AutomationTriggerStepId;
     AutomationTriggerStepId["APP"] = "APP";
     AutomationTriggerStepId["CRON"] = "CRON";
 })(AutomationTriggerStepId = exports.AutomationTriggerStepId || (exports.AutomationTriggerStepId = {}));
+var AutomationStepType;
+(function (AutomationStepType) {
+    AutomationStepType["LOGIC"] = "LOGIC";
+    AutomationStepType["ACTION"] = "ACTION";
+    AutomationStepType["TRIGGER"] = "TRIGGER";
+})(AutomationStepType = exports.AutomationStepType || (exports.AutomationStepType = {}));
 var AutomationActionStepId;
 (function (AutomationActionStepId) {
     AutomationActionStepId["SEND_EMAIL_SMTP"] = "SEND_EMAIL_SMTP";
@@ -31,6 +63,10 @@ var AutomationActionStepId;
     AutomationActionStepId["zapier"] = "zapier";
     AutomationActionStepId["integromat"] = "integromat";
 })(AutomationActionStepId = exports.AutomationActionStepId || (exports.AutomationActionStepId = {}));
+exports.AutomationStepIdArray = [
+    ...Object.values(AutomationActionStepId),
+    ...Object.values(AutomationTriggerStepId),
+];
 var AutomationStatus;
 (function (AutomationStatus) {
     AutomationStatus["SUCCESS"] = "success";

package/dist/cjs/documents/app/automation.js.map

@@ -1 +1 @@
-{"version":3,"file":"automation.js","sourceRoot":"","sources":["../../../../src/documents/app/automation.ts"],"names":[],"mappings":";;;AAGA,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,kDAAuB,CAAA;IACvB,sDAA2B,CAAA;IAC3B,sDAA2B,CAAA;IAC3B,8CAAmB,CAAA;IACnB,sCAAW,CAAA;IACX,wCAAa,CAAA;AACf,CAAC,EAPW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAOlC;AAED,IAAY,sBAmBX;AAnBD,WAAY,sBAAsB;IAChC,6DAAmC,CAAA;IACnC,mDAAyB,CAAA;IACzB,mDAAyB,CAAA;IACzB,mDAAyB,CAAA;IACzB,uDAA6B,CAAA;IAC7B,+DAAqC,CAAA;IACrC,2DAAiC,CAAA;IACjC,yDAA+B,CAAA;IAC/B,mDAAyB,CAAA;IACzB,yCAAe,CAAA;IACf,2CAAiB,CAAA;IACjB,mDAAyB,CAAA;IACzB,uCAAa,CAAA;IACb,qEAAqE;IACrE,6CAAmB,CAAA;IACnB,yCAAe,CAAA;IACf,2CAAiB,CAAA;IACjB,mDAAyB,CAAA;AAC3B,CAAC,EAnBW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAmBjC;AAiDD,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,mCAAe,CAAA;IACf,uCAAmB,CAAA;IACnB,mDAA+B,CAAA;IAC/B,mDAA+B,CAAA;AACjC,CAAC,EANW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAM3B"}
+{"version":3,"file":"automation.js","sourceRoot":"","sources":["../../../../src/documents/app/automation.ts"],"names":[],"mappings":";;;AAGA,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;IACjB,uCAAmB,CAAA;IACnB,qCAAiB,CAAA;IACjB,mCAAe,CAAA;AACjB,CAAC,EANW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAM3B;AAED,IAAY,sBAgBX;AAhBD,WAAY,sBAAsB;IAChC,yCAAe,CAAA;IACf,qCAAW,CAAA;IACX,uCAAa,CAAA;IACb,uCAAa,CAAA;IACb,yCAAe,CAAA;IACf,sDAA4B,CAAA;IAC5B,oDAA0B,CAAA;IAC1B,oDAA0B,CAAA;IAC1B,uCAAa,CAAA;IACb,uCAAa,CAAA;IACb,6CAAmB,CAAA;IACnB,2CAAiB,CAAA;IACjB,0DAAgC,CAAA;IAChC,uCAAa,CAAA;IACb,oDAA0B,CAAA;AAC5B,CAAC,EAhBW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAgBjC;AAED,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,kDAAuB,CAAA;IACvB,sDAA2B,CAAA;IAC3B,sDAA2B,CAAA;IAC3B,8CAAmB,CAAA;IACnB,sCAAW,CAAA;IACX,wCAAa,CAAA;AACf,CAAC,EAPW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAOlC;AAED,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,qCAAe,CAAA;IACf,uCAAiB,CAAA;IACjB,yCAAmB,CAAA;AACrB,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAED,IAAY,sBAmBX;AAnBD,WAAY,sBAAsB;IAChC,6DAAmC,CAAA;IACnC,mDAAyB,CAAA;IACzB,mDAAyB,CAAA;IACzB,mDAAyB,CAAA;IACzB,uDAA6B,CAAA;IAC7B,+DAAqC,CAAA;IACrC,2DAAiC,CAAA;IACjC,yDAA+B,CAAA;IAC/B,mDAAyB,CAAA;IACzB,yCAAe,CAAA;IACf,2CAAiB,CAAA;IACjB,mDAAyB,CAAA;IACzB,uCAAa,CAAA;IACb,qEAAqE;IACrE,6CAAmB,CAAA;IACnB,yCAAe,CAAA;IACf,2CAAiB,CAAA;IACjB,mDAAyB,CAAA;AAC3B,CAAC,EAnBW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAmBjC;AAEY,QAAA,qBAAqB,GAAG;IACnC,GAAG,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC;IACxC,GAAG,MAAM,CAAC,MAAM,CAAC,uBAAuB,CAAC;CAC1C,CAAA;AAqED,IAAY,gBAMX;AAND,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,mCAAe,CAAA;IACf,uCAAmB,CAAA;IACnB,mDAA+B,CAAA;IAC/B,mDAA+B,CAAA;AACjC,CAAC,EANW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAM3B"}

package/dist/cjs/documents/global/plugin.d.ts

@@ -1,7 +1,8 @@
 import { Document } from "../document";
 export declare enum PluginType {
     DATASOURCE = "datasource",
-    COMPONENT = "component"
+    COMPONENT = "component",
+    AUTOMATION = "automation"
 }
 export declare enum PluginSource {
     NPM = "NPM",

package/dist/cjs/documents/global/plugin.js

@@ -5,6 +5,7 @@ var PluginType;
 (function (PluginType) {
     PluginType["DATASOURCE"] = "datasource";
     PluginType["COMPONENT"] = "component";
+    PluginType["AUTOMATION"] = "automation";
 })(PluginType = exports.PluginType || (exports.PluginType = {}));
 var PluginSource;
 (function (PluginSource) {

package/dist/cjs/documents/global/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../../../src/documents/global/plugin.ts"],"names":[],"mappings":";;;AAEA,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,uCAAyB,CAAA;IACzB,qCAAuB,CAAA;AACzB,CAAC,EAHW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAGrB;AAED,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,2BAAW,CAAA;IACX,iCAAiB,CAAA;IACjB,2BAAW,CAAA;IACX,oCAAoB,CAAA;AACtB,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAwBY,QAAA,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA"}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../../../src/documents/global/plugin.ts"],"names":[],"mappings":";;;AAEA,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,uCAAyB,CAAA;IACzB,qCAAuB,CAAA;IACvB,uCAAyB,CAAA;AAC3B,CAAC,EAJW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAIrB;AAED,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,2BAAW,CAAA;IACX,iCAAiB,CAAA;IACjB,2BAAW,CAAA;IACX,oCAAoB,CAAA;AACtB,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAwBY,QAAA,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA"}