@budibase/types 2.5.9 → 2.5.10-alpha.0

package/dist/cjs/api/account/accounts.d.ts

@@ -0,0 +1,11 @@
+import { Hosting } from "../../sdk";
+export interface CreateAccountRequest {
+    email: string;
+    tenantId: string;
+    hosting: Hosting;
+    size: string;
+    profession: string;
+    tenantName?: string;
+    name?: string;
+    password: string;
+}

package/dist/cjs/api/account/accounts.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=accounts.js.map

package/dist/cjs/api/account/accounts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accounts.js","sourceRoot":"","sources":["../../../../src/api/account/accounts.ts"],"names":[],"mappings":""}

package/dist/cjs/api/account/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./accounts";
 export * from "./user";
 export * from "./license";
 export * from "./status";

package/dist/cjs/api/account/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./accounts"), exports);
 __exportStar(require("./user"), exports);
 __exportStar(require("./license"), exports);
 __exportStar(require("./status"), exports);

package/dist/cjs/api/account/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/account/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAsB;AACtB,4CAAyB;AACzB,2CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/account/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA0B;AAC1B,yCAAsB;AACtB,4CAAyB;AACzB,2CAAwB"}

package/dist/cjs/api/account/license.d.ts

@@ -1,9 +1,22 @@
-import { QuotaUsage } from "../../documents";
+import { LicenseOverrides, QuotaUsage } from "../../documents";
+import { PlanType } from "../../sdk";
 export interface GetLicenseRequest {
-    quotaUsage: QuotaUsage;
+    quotaUsage?: QuotaUsage;
+    install: {
+        id: string;
+        tenantId: string;
+        version: string;
+    };
 }
 export interface QuotaTriggeredRequest {
     percentage: number;
     name: string;
     resetDate?: string;
 }
+export interface LicenseActivateRequest {
+    installVersion?: string;
+}
+export interface UpdateLicenseRequest {
+    planType?: PlanType;
+    overrides?: LicenseOverrides;
+}

package/dist/cjs/api/web/app/datasource.d.ts

@@ -0,0 +1,15 @@
+import { Datasource } from "../../../documents";
+export interface CreateDatasourceResponse {
+    datasource: Datasource;
+    error?: any;
+}
+export interface UpdateDatasourceResponse {
+    datasource: Datasource;
+}
+export interface CreateDatasourceRequest {
+    datasource: Datasource;
+    fetchSchema?: boolean;
+}
+export interface UpdateDatasourceRequest extends Datasource {
+    datasource: Datasource;
+}

package/dist/cjs/api/web/app/datasource.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=datasource.js.map

package/dist/cjs/api/web/app/datasource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"datasource.js","sourceRoot":"","sources":["../../../../../src/api/web/app/datasource.ts"],"names":[],"mappings":""}

package/dist/cjs/api/web/app/index.d.ts

@@ -1 +1,2 @@
 export * from "./backup";
+export * from "./datasource";

package/dist/cjs/api/web/app/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./backup"), exports);
+__exportStar(require("./datasource"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/api/web/app/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/web/app/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/web/app/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,+CAA4B"}

package/dist/cjs/api/web/global/index.d.ts

@@ -2,3 +2,4 @@ export * from "./environmentVariables";
 export * from "./auditLogs";
 export * from "./events";
 export * from "./configs";
+export * from "./scim";

package/dist/cjs/api/web/global/index.js

@@ -18,4 +18,5 @@ __exportStar(require("./environmentVariables"), exports);
 __exportStar(require("./auditLogs"), exports);
 __exportStar(require("./events"), exports);
 __exportStar(require("./configs"), exports);
+__exportStar(require("./scim"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/api/web/global/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/web/global/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAsC;AACtC,8CAA2B;AAC3B,2CAAwB;AACxB,4CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/web/global/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAsC;AACtC,8CAA2B;AAC3B,2CAAwB;AACxB,4CAAyB;AACzB,yCAAsB"}

package/dist/cjs/api/web/global/scim/groups.d.ts

@@ -0,0 +1,27 @@
+import { ScimResource, ScimMeta } from "scim-patch";
+import { ScimListResponse } from "./shared";
+export interface ScimGroupResponse extends ScimResource {
+    schemas: ["urn:ietf:params:scim:schemas:core:2.0:Group"];
+    id: string;
+    externalId: string;
+    displayName: string;
+    meta: ScimMeta & {
+        resourceType: "Group";
+    };
+    members?: {
+        value: string;
+    }[];
+}
+export interface ScimCreateGroupRequest {
+    schemas: [
+        "urn:ietf:params:scim:schemas:core:2.0:Group",
+        "http://schemas.microsoft.com/2006/11/ResourceManagement/ADSCIM/2.0/Group"
+    ];
+    externalId: string;
+    displayName: string;
+    meta: ScimMeta & {
+        resourceType: "Group";
+    };
+}
+export interface ScimGroupListResponse extends ScimListResponse<ScimGroupResponse> {
+}

package/dist/cjs/api/web/global/scim/groups.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=groups.js.map

package/dist/cjs/api/web/global/scim/groups.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"groups.js","sourceRoot":"","sources":["../../../../../../src/api/web/global/scim/groups.ts"],"names":[],"mappings":""}

package/dist/cjs/api/web/global/scim/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./users";
+export * from "./groups";
+export * from "./shared";

package/dist/cjs/api/web/global/scim/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./users"), exports);
+__exportStar(require("./groups"), exports);
+__exportStar(require("./shared"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/api/web/global/scim/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/api/web/global/scim/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,2CAAwB;AACxB,2CAAwB"}

package/dist/cjs/api/web/global/scim/shared.d.ts

@@ -0,0 +1,12 @@
+import { ScimPatchOperation } from "scim-patch";
+export interface ScimListResponse<T> {
+    schemas: ["urn:ietf:params:scim:api:messages:2.0:ListResponse"];
+    totalResults: number;
+    Resources: T[];
+    startIndex: number;
+    itemsPerPage: number;
+}
+export interface ScimUpdateRequest {
+    schemas: ["urn:ietf:params:scim:api:messages:2.0:PatchOp"];
+    Operations: ScimPatchOperation[];
+}

package/dist/cjs/api/web/global/scim/shared.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=shared.js.map

package/dist/cjs/api/web/global/scim/shared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.js","sourceRoot":"","sources":["../../../../../../src/api/web/global/scim/shared.ts"],"names":[],"mappings":""}

package/dist/cjs/api/web/global/scim/users.d.ts

@@ -0,0 +1,48 @@
+import { ScimResource, ScimMeta } from "scim-patch";
+import { ScimListResponse } from "./shared";
+declare type BooleanString = boolean | "True" | "true" | "False" | "false";
+declare type Emails = {
+    value: string;
+    type: "work";
+    primary: boolean;
+}[];
+export interface ScimUserResponse extends ScimResource {
+    schemas: ["urn:ietf:params:scim:schemas:core:2.0:User"];
+    id: string;
+    externalId: string;
+    meta: ScimMeta & {
+        resourceType: "User";
+    };
+    userName: string;
+    displayName?: string;
+    name?: {
+        formatted?: string;
+        familyName?: string;
+        givenName?: string;
+    };
+    active: BooleanString;
+    emails?: Emails;
+}
+export interface ScimCreateUserRequest {
+    schemas: [
+        "urn:ietf:params:scim:schemas:core:2.0:User",
+        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
+    ];
+    externalId: string;
+    userName: string;
+    active: BooleanString;
+    emails?: Emails;
+    meta: {
+        resourceType: "User";
+    };
+    displayName?: string;
+    name?: {
+        formatted: string;
+        familyName: string;
+        givenName: string;
+    };
+    roles: [];
+}
+export interface ScimUserListResponse extends ScimListResponse<ScimUserResponse> {
+}
+export {};

package/dist/cjs/api/web/global/scim/users.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=users.js.map

package/dist/cjs/api/web/global/scim/users.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../../../../../../src/api/web/global/scim/users.ts"],"names":[],"mappings":""}

package/dist/cjs/api/web/index.d.ts

@@ -3,6 +3,7 @@ export * from "./auth";
 export * from "./user";
 export * from "./errors";
 export * from "./schedule";
+export * from "./system";
 export * from "./app";
 export * from "./global";
 export * from "./pagination";

package/dist/cjs/api/web/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./auth"), exports);
 __exportStar(require("./user"), exports);
 __exportStar(require("./errors"), exports);
 __exportStar(require("./schedule"), exports);
+__exportStar(require("./system"), exports);
 __exportStar(require("./app"), exports);
 __exportStar(require("./global"), exports);
 __exportStar(require("./pagination"), exports);

package/dist/cjs/api/web/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/web/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,yCAAsB;AACtB,yCAAsB;AACtB,2CAAwB;AACxB,6CAA0B;AAC1B,wCAAqB;AACrB,2CAAwB;AACxB,+CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/web/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,yCAAsB;AACtB,yCAAsB;AACtB,2CAAwB;AACxB,6CAA0B;AAC1B,2CAAwB;AACxB,wCAAqB;AACrB,2CAAwB;AACxB,+CAA4B"}

package/dist/cjs/api/web/pagination.d.ts

@@ -18,6 +18,6 @@ export interface PaginationRequest extends BasicPaginationRequest {
     };
 }
 export interface PaginationResponse {
-    bookmark: string;
+    bookmark: string | undefined;
     hasNextPage: boolean;
 }

package/dist/cjs/api/web/system/environment.d.ts

@@ -0,0 +1,8 @@
+export interface GetEnvironmentResponse {
+    multiTenancy: boolean;
+    cloud: boolean;
+    accountPortalUrl: string;
+    baseUrl: string;
+    disableAccountPortal: boolean;
+    isDev: boolean;
+}

package/dist/cjs/api/web/system/environment.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=environment.js.map

package/dist/cjs/api/web/system/environment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../../../../src/api/web/system/environment.ts"],"names":[],"mappings":""}

package/dist/cjs/api/web/system/index.d.ts

@@ -0,0 +1 @@
+export * from "./environment";

package/dist/cjs/api/web/system/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./environment"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/api/web/system/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/web/system/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA6B"}

package/dist/cjs/api/web/user.d.ts

@@ -18,22 +18,24 @@ export interface BulkUserRequest {
         groups: any[];
     };
 }
+export interface BulkUserCreated {
+    successful: UserDetails[];
+    unsuccessful: {
+        email: string;
+        reason: string;
+    }[];
+}
+export interface BulkUserDeleted {
+    successful: UserDetails[];
+    unsuccessful: {
+        _id: string;
+        email: string;
+        reason: string;
+    }[];
+}
 export interface BulkUserResponse {
-    created?: {
-        successful: UserDetails[];
-        unsuccessful: {
-            email: string;
-            reason: string;
-        }[];
-    };
-    deleted?: {
-        successful: UserDetails[];
-        unsuccessful: {
-            _id: string;
-            email: string;
-            reason: string;
-        }[];
-    };
+    created?: BulkUserCreated;
+    deleted?: BulkUserDeleted;
     message?: string;
 }
 export interface InviteUserRequest {

package/dist/cjs/documents/account/account.d.ts

@@ -1,4 +1,5 @@
 import { Feature, Hosting, License, PlanType, Quotas } from "../../sdk";
+import { DeepPartial } from "../../shared";
 import { QuotaUsage } from "../global";
 export interface CreateAccount {
     email: string;
@@ -17,7 +18,7 @@ export interface CreatePassswordAccount extends CreateAccount {
 export declare const isCreatePasswordAccount: (account: CreateAccount) => account is CreatePassswordAccount;
 export interface LicenseOverrides {
     features?: Feature[];
-    quotas?: Quotas;
+    quotas?: DeepPartial<Quotas>;
 }
 export interface Account extends CreateAccount {
     accountId: string;
@@ -26,11 +27,16 @@ export interface Account extends CreateAccount {
     verificationSent: boolean;
     tier: string;
     planType?: PlanType;
+    /** @deprecated */
     planTier?: number;
     license?: License;
+    installId?: string;
+    installTenantId?: string;
+    installVersion?: string;
     stripeCustomerId?: string;
     licenseKey?: string;
     licenseKeyActivatedAt?: number;
+    licenseRequestedAt?: number;
     licenseOverrides?: LicenseOverrides;
     quotaUsage?: QuotaUsage;
 }

package/dist/cjs/documents/account/account.js.map

@@ -1 +1 @@
-{"version":3,"file":"account.js","sourceRoot":"","sources":["../../../../src/documents/account/account.ts"],"names":[],"mappings":";;;AAAA,mCASkB;AAqBX,MAAM,uBAAuB,GAAG,CACrC,OAAsB,EACa,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,CAAA;AAFjE,QAAA,uBAAuB,2BAE0C;AA8BvE,MAAM,iBAAiB,GAAG,CAC/B,OAAgB,EACY,EAAE,CAC9B,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,IAAI,OAAO,CAAC,OAAO,KAAK,aAAO,CAAC,IAAI,CAAA;AAH/D,QAAA,iBAAiB,qBAG8C;AAOrE,MAAM,cAAc,GAAG,CAAC,OAAgB,EAA2B,EAAE,CAC1E,OAAO,CAAC,OAAO,KAAK,aAAO,CAAC,KAAK,CAAA;AADtB,QAAA,cAAc,kBACQ;AAE5B,MAAM,iBAAiB,GAAG,CAAC,OAAgB,EAAE,EAAE,CACpD,OAAO,CAAC,OAAO,KAAK,aAAO,CAAC,IAAI,CAAA;AADrB,QAAA,iBAAiB,qBACI;AAE3B,MAAM,YAAY,GAAG,CAAC,OAAgB,EAAyB,EAAE,CACtE,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,GAAG,CAAA;AADtB,QAAA,YAAY,gBACU;AAEnC,IAAY,sBAGX;AAHD,WAAY,sBAAsB;IAChC,2CAAiB,CAAA;IACjB,iDAAuB,CAAA;AACzB,CAAC,EAHW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAGjC;AAED,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,uCAAiB,CAAA;IACjB,6CAAuB,CAAA;AACzB,CAAC,EAHW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAG7B;AAYD,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,uBAAW,CAAA;IACX,iCAAqB,CAAA;AACvB,CAAC,EAHW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAGnB"}
+{"version":3,"file":"account.js","sourceRoot":"","sources":["../../../../src/documents/account/account.ts"],"names":[],"mappings":";;;AAAA,mCAAuE;AAsBhE,MAAM,uBAAuB,GAAG,CACrC,OAAsB,EACa,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,CAAA;AAFjE,QAAA,uBAAuB,2BAE0C;AAmCvE,MAAM,iBAAiB,GAAG,CAC/B,OAAgB,EACY,EAAE,CAC9B,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,IAAI,OAAO,CAAC,OAAO,KAAK,aAAO,CAAC,IAAI,CAAA;AAH/D,QAAA,iBAAiB,qBAG8C;AAOrE,MAAM,cAAc,GAAG,CAAC,OAAgB,EAA2B,EAAE,CAC1E,OAAO,CAAC,OAAO,KAAK,aAAO,CAAC,KAAK,CAAA;AADtB,QAAA,cAAc,kBACQ;AAE5B,MAAM,iBAAiB,GAAG,CAAC,OAAgB,EAAE,EAAE,CACpD,OAAO,CAAC,OAAO,KAAK,aAAO,CAAC,IAAI,CAAA;AADrB,QAAA,iBAAiB,qBACI;AAE3B,MAAM,YAAY,GAAG,CAAC,OAAgB,EAAyB,EAAE,CACtE,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,GAAG,CAAA;AADtB,QAAA,YAAY,gBACU;AAEnC,IAAY,sBAGX;AAHD,WAAY,sBAAsB;IAChC,2CAAiB,CAAA;IACjB,iDAAuB,CAAA;AACzB,CAAC,EAHW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAGjC;AAED,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,uCAAiB,CAAA;IACjB,6CAAuB,CAAA;AACzB,CAAC,EAHW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAG7B;AAYD,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,uBAAW,CAAA;IACX,iCAAqB,CAAA;AACvB,CAAC,EAHW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAGnB"}

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;
@@ -74,7 +122,8 @@ export declare enum AutomationStatus {
     SUCCESS = "success",
     ERROR = "error",
     STOPPED = "stopped",
-    STOPPED_ERROR = "stopped_error"
+    STOPPED_ERROR = "stopped_error",
+    NO_ITERATIONS = "no_iterations"
 }
 export interface AutomationResults {
     automationId?: string;
@@ -106,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,11 +63,16 @@ 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";
     AutomationStatus["ERROR"] = "error";
     AutomationStatus["STOPPED"] = "stopped";
     AutomationStatus["STOPPED_ERROR"] = "stopped_error";
+    AutomationStatus["NO_ITERATIONS"] = "no_iterations";
 })(AutomationStatus = exports.AutomationStatus || (exports.AutomationStatus = {}));
 //# sourceMappingURL=automation.js.map

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,gBAKX;AALD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,mCAAe,CAAA;IACf,uCAAmB,CAAA;IACnB,mDAA+B,CAAA;AACjC,CAAC,EALW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAK3B"}
+{"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/app/query.d.ts

@@ -41,3 +41,9 @@ export interface PaginationValues {
     page: string | number | null;
     limit: number | null;
 }
+export interface PreviewQueryRequest extends Omit<Query, "parameters"> {
+    parameters: {};
+    flags?: {
+        urlName?: boolean;
+    };
+}