@budibase/types 2.8.31-alpha.0 → 2.8.31

package/dist/cjs/sdk/events/index.d.ts

@@ -0,0 +1,25 @@
+export * from "./app";
+export * from "./auth";
+export * from "./automation";
+export * from "./email";
+export * from "./datasource";
+export * from "./event";
+export * from "./layout";
+export * from "./license";
+export * from "./version";
+export * from "./query";
+export * from "./role";
+export * from "./rows";
+export * from "./screen";
+export * from "./serve";
+export * from "./table";
+export * from "./user";
+export * from "./view";
+export * from "./account";
+export * from "./backfill";
+export * from "./identification";
+export * from "./userGroup";
+export * from "./plugin";
+export * from "./backup";
+export * from "./environmentVariable";
+export * from "./auditLog";

package/dist/cjs/sdk/events/index.js

@@ -0,0 +1,42 @@
+"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("./app"), exports);
+__exportStar(require("./auth"), exports);
+__exportStar(require("./automation"), exports);
+__exportStar(require("./email"), exports);
+__exportStar(require("./datasource"), exports);
+__exportStar(require("./event"), exports);
+__exportStar(require("./layout"), exports);
+__exportStar(require("./license"), exports);
+__exportStar(require("./version"), exports);
+__exportStar(require("./query"), exports);
+__exportStar(require("./role"), exports);
+__exportStar(require("./rows"), exports);
+__exportStar(require("./screen"), exports);
+__exportStar(require("./serve"), exports);
+__exportStar(require("./table"), exports);
+__exportStar(require("./user"), exports);
+__exportStar(require("./view"), exports);
+__exportStar(require("./account"), exports);
+__exportStar(require("./backfill"), exports);
+__exportStar(require("./identification"), exports);
+__exportStar(require("./userGroup"), exports);
+__exportStar(require("./plugin"), exports);
+__exportStar(require("./backup"), exports);
+__exportStar(require("./environmentVariable"), exports);
+__exportStar(require("./auditLog"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/sdk/events/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/sdk/events/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAqB;AACrB,yCAAsB;AACtB,+CAA4B;AAC5B,0CAAuB;AACvB,+CAA4B;AAC5B,0CAAuB;AACvB,2CAAwB;AACxB,4CAAyB;AACzB,4CAAyB;AACzB,0CAAuB;AACvB,yCAAsB;AACtB,yCAAsB;AACtB,2CAAwB;AACxB,0CAAuB;AACvB,0CAAuB;AACvB,yCAAsB;AACtB,yCAAsB;AACtB,4CAAyB;AACzB,6CAA0B;AAC1B,mDAAgC;AAChC,8CAA2B;AAC3B,2CAAwB;AACxB,2CAAwB;AACxB,wDAAqC;AACrC,6CAA0B"}

package/dist/cjs/sdk/events/layout.d.ts

@@ -0,0 +1,7 @@
+import { BaseEvent } from "./event";
+export interface LayoutCreatedEvent extends BaseEvent {
+    layoutId: string;
+}
+export interface LayoutDeletedEvent extends BaseEvent {
+    layoutId: string;
+}

package/dist/cjs/sdk/events/layout.js

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

package/dist/cjs/sdk/events/layout.js.map

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

package/dist/cjs/sdk/events/license.d.ts

@@ -0,0 +1,28 @@
+import { PlanType, PriceDuration } from "../licensing";
+export interface LicensePlanChangedEvent {
+    accountId: string;
+    from: PlanType;
+    to: PlanType;
+    fromDuration: PriceDuration | undefined;
+    toDuration: PriceDuration | undefined;
+    fromQuantity: number | undefined;
+    toQuantity: number | undefined;
+}
+export interface LicenseActivatedEvent {
+    accountId: string;
+}
+export interface LicenseCheckoutOpenedEvent {
+    accountId: string;
+}
+export interface LicenseCheckoutSuccessEvent {
+    accountId: string;
+}
+export interface LicensePortalOpenedEvent {
+    accountId: string;
+}
+export interface LicensePaymentFailedEvent {
+    accountId: string;
+}
+export interface LicensePaymentRecoveredEvent {
+    accountId: string;
+}

package/dist/cjs/sdk/events/license.js

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

package/dist/cjs/sdk/events/license.js.map

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

package/dist/cjs/sdk/events/plugin.d.ts

@@ -0,0 +1,23 @@
+import { BaseEvent } from "./event";
+import { PluginSource, PluginType } from "../../";
+export interface PluginInitEvent extends BaseEvent {
+    type: PluginType;
+    name: string;
+    version: string;
+    description: string;
+}
+export interface PluginImportedEvent extends BaseEvent {
+    pluginId: string;
+    type: PluginType;
+    source: PluginSource;
+    name: string;
+    version: string;
+    description: string;
+}
+export interface PluginDeletedEvent extends BaseEvent {
+    pluginId: string;
+    type: PluginType;
+    name: string;
+    version: string;
+    description: string;
+}

package/dist/cjs/sdk/events/plugin.js

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

package/dist/cjs/sdk/events/plugin.js.map

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

package/dist/cjs/sdk/events/query.d.ts

@@ -0,0 +1,34 @@
+import { BaseEvent } from "./event";
+export interface QueryCreatedEvent extends BaseEvent {
+    queryId: string;
+    datasourceId: string;
+    source: string;
+    queryVerb: string;
+}
+export interface QueryUpdatedEvent extends BaseEvent {
+    queryId: string;
+    datasourceId: string;
+    source: string;
+    queryVerb: string;
+}
+export interface QueryDeletedEvent extends BaseEvent {
+    queryId: string;
+    datasourceId: string;
+    source: string;
+    queryVerb: string;
+}
+export interface QueryImportedEvent extends BaseEvent {
+    datasourceId: string;
+    source: string;
+    count: number;
+    importSource: string;
+}
+export interface QueryPreviewedEvent extends BaseEvent {
+    queryId?: string;
+    datasourceId: string;
+    source: string;
+    queryVerb: string;
+}
+export interface QueriesRunEvent extends BaseEvent {
+    count: number;
+}

package/dist/cjs/sdk/events/query.js

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

package/dist/cjs/sdk/events/query.js.map

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

package/dist/cjs/sdk/events/role.d.ts

@@ -0,0 +1,24 @@
+import { BaseEvent } from "./event";
+export interface RoleCreatedEvent extends BaseEvent {
+    roleId: string;
+    permissionId: string;
+    inherits?: string;
+}
+export interface RoleUpdatedEvent extends BaseEvent {
+    roleId: string;
+    permissionId: string;
+    inherits?: string;
+}
+export interface RoleDeletedEvent extends BaseEvent {
+    roleId: string;
+    permissionId: string;
+    inherits?: string;
+}
+export interface RoleAssignedEvent extends BaseEvent {
+    userId: string;
+    roleId: string;
+}
+export interface RoleUnassignedEvent extends BaseEvent {
+    userId: string;
+    roleId: string;
+}

package/dist/cjs/sdk/events/role.js

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

package/dist/cjs/sdk/events/role.js.map

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

package/dist/cjs/sdk/events/rows.d.ts

@@ -0,0 +1,8 @@
+import { BaseEvent } from "./event";
+export interface RowsImportedEvent extends BaseEvent {
+    tableId: string;
+    count: number;
+}
+export interface RowsCreatedEvent extends BaseEvent {
+    count: number;
+}

package/dist/cjs/sdk/events/rows.js

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

package/dist/cjs/sdk/events/rows.js.map

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

package/dist/cjs/sdk/events/screen.d.ts

@@ -0,0 +1,17 @@
+import { BaseEvent } from "./event";
+export interface ScreenCreatedEvent extends BaseEvent {
+    screenId: string;
+    layoutId?: string;
+    roleId: string;
+    audited: {
+        name: string;
+    };
+}
+export interface ScreenDeletedEvent extends BaseEvent {
+    screenId: string;
+    layoutId?: string;
+    roleId: string;
+    audited: {
+        name: string;
+    };
+}

package/dist/cjs/sdk/events/screen.js

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

package/dist/cjs/sdk/events/screen.js.map

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

package/dist/cjs/sdk/events/serve.d.ts

@@ -0,0 +1,13 @@
+import { BaseEvent } from "./event";
+export interface BuilderServedEvent extends BaseEvent {
+    timezone: string;
+}
+export interface AppServedEvent extends BaseEvent {
+    appVersion: string;
+    timezone: string;
+    embed?: boolean;
+}
+export interface AppPreviewServedEvent extends BaseEvent {
+    appVersion: string;
+    timezone: string;
+}

package/dist/cjs/sdk/events/serve.js

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

package/dist/cjs/sdk/events/serve.js.map

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

package/dist/cjs/sdk/events/table.d.ts

@@ -0,0 +1,32 @@
+import { BaseEvent, TableExportFormat } from "./event";
+export interface TableCreatedEvent extends BaseEvent {
+    tableId: string;
+    audited: {
+        name: string;
+    };
+}
+export interface TableUpdatedEvent extends BaseEvent {
+    tableId: string;
+    audited: {
+        name: string;
+    };
+}
+export interface TableDeletedEvent extends BaseEvent {
+    tableId: string;
+    audited: {
+        name: string;
+    };
+}
+export interface TableExportedEvent extends BaseEvent {
+    tableId: string;
+    format: TableExportFormat;
+    audited: {
+        name: string;
+    };
+}
+export interface TableImportedEvent extends BaseEvent {
+    tableId: string;
+    audited: {
+        name: string;
+    };
+}

package/dist/cjs/sdk/events/table.js

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

package/dist/cjs/sdk/events/table.js.map

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

package/dist/cjs/sdk/events/user.d.ts

@@ -0,0 +1,79 @@
+import { BaseEvent } from "./event";
+export interface UserCreatedEvent extends BaseEvent {
+    userId: string;
+    viaScim?: boolean;
+    audited: {
+        email: string;
+    };
+}
+export interface UserUpdatedEvent extends BaseEvent {
+    userId: string;
+    viaScim?: boolean;
+    audited: {
+        email: string;
+    };
+}
+export interface UserDeletedEvent extends BaseEvent {
+    userId: string;
+    viaScim?: boolean;
+    audited: {
+        email: string;
+    };
+}
+export interface UserOnboardingEvent extends BaseEvent {
+    userId: string;
+    step?: string;
+    audited: {
+        email: string;
+    };
+}
+export interface UserPermissionAssignedEvent extends BaseEvent {
+    userId: string;
+    audited: {
+        email: string;
+    };
+}
+export interface UserPermissionRemovedEvent extends BaseEvent {
+    userId: string;
+    audited: {
+        email: string;
+    };
+}
+export interface UserInvitedEvent extends BaseEvent {
+    audited: {
+        email: string;
+    };
+}
+export interface UserInviteAcceptedEvent extends BaseEvent {
+    userId: string;
+    audited: {
+        email: string;
+    };
+}
+export interface UserPasswordForceResetEvent extends BaseEvent {
+    userId: string;
+    audited: {
+        email: string;
+    };
+}
+export interface UserPasswordUpdatedEvent extends BaseEvent {
+    userId: string;
+    audited: {
+        email: string;
+    };
+}
+export interface UserPasswordResetRequestedEvent extends BaseEvent {
+    userId: string;
+    audited: {
+        email: string;
+    };
+}
+export interface UserPasswordResetEvent extends BaseEvent {
+    userId: string;
+    audited: {
+        email: string;
+    };
+}
+export interface UserDataCollaborationEvent extends BaseEvent {
+    users: number;
+}

package/dist/cjs/sdk/events/user.js

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

package/dist/cjs/sdk/events/user.js.map

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

package/dist/cjs/sdk/events/userGroup.d.ts

@@ -0,0 +1,49 @@
+import { BaseEvent } from "./event";
+export interface GroupCreatedEvent extends BaseEvent {
+    groupId: string;
+    viaScim?: boolean;
+    audited: {
+        name: string;
+    };
+}
+export interface GroupUpdatedEvent extends BaseEvent {
+    groupId: string;
+    viaScim?: boolean;
+    audited: {
+        name: string;
+    };
+}
+export interface GroupDeletedEvent extends BaseEvent {
+    groupId: string;
+    viaScim?: boolean;
+    audited: {
+        name: string;
+    };
+}
+export interface GroupUsersAddedEvent extends BaseEvent {
+    count: number;
+    groupId: string;
+    viaScim?: boolean;
+    audited: {
+        name: string;
+    };
+}
+export interface GroupUsersDeletedEvent extends BaseEvent {
+    count: number;
+    groupId: string;
+    viaScim?: boolean;
+    audited: {
+        name: string;
+    };
+}
+export interface GroupAddedOnboardingEvent extends BaseEvent {
+    groupId: string;
+    onboarding: boolean;
+}
+export interface GroupPermissionsEditedEvent extends BaseEvent {
+    permissions: Record<string, string>;
+    groupId: string;
+    audited: {
+        name: string;
+    };
+}

package/dist/cjs/sdk/events/userGroup.js

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

package/dist/cjs/sdk/events/userGroup.js.map

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

package/dist/cjs/sdk/events/version.d.ts

@@ -0,0 +1,8 @@
+import { BaseEvent } from "./event";
+export interface VersionCheckedEvent extends BaseEvent {
+    currentVersion: string;
+}
+export interface VersionChangeEvent extends BaseEvent {
+    from: string;
+    to: string;
+}

package/dist/cjs/sdk/events/version.js

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

package/dist/cjs/sdk/events/version.js.map

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

package/dist/cjs/sdk/events/view.d.ts

@@ -0,0 +1,36 @@
+import { ViewCalculation } from "../../documents";
+import { BaseEvent, TableExportFormat } from "./event";
+export interface ViewCreatedEvent extends BaseEvent {
+    tableId: string;
+}
+export interface ViewUpdatedEvent extends BaseEvent {
+    tableId: string;
+}
+export interface ViewDeletedEvent extends BaseEvent {
+    tableId: string;
+}
+export interface ViewExportedEvent extends BaseEvent {
+    tableId: string;
+    format: TableExportFormat;
+}
+export interface ViewFilterCreatedEvent extends BaseEvent {
+    tableId: string;
+}
+export interface ViewFilterUpdatedEvent extends BaseEvent {
+    tableId: string;
+}
+export interface ViewFilterDeletedEvent extends BaseEvent {
+    tableId: string;
+}
+export interface ViewCalculationCreatedEvent extends BaseEvent {
+    tableId: string;
+    calculation: ViewCalculation;
+}
+export interface ViewCalculationUpdatedEvent extends BaseEvent {
+    tableId: string;
+    calculation: ViewCalculation;
+}
+export interface ViewCalculationDeletedEvent extends BaseEvent {
+    tableId: string;
+    calculation: ViewCalculation;
+}

package/dist/cjs/sdk/events/view.js

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

package/dist/cjs/sdk/events/view.js.map

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

package/dist/cjs/sdk/featureFlag.d.ts

@@ -0,0 +1,6 @@
+export declare enum FeatureFlag {
+    LICENSING = "LICENSING"
+}
+export interface TenantFeatureFlags {
+    [key: string]: FeatureFlag[];
+}

package/dist/cjs/sdk/featureFlag.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeatureFlag = void 0;
+var FeatureFlag;
+(function (FeatureFlag) {
+    FeatureFlag["LICENSING"] = "LICENSING";
+})(FeatureFlag = exports.FeatureFlag || (exports.FeatureFlag = {}));
+//# sourceMappingURL=featureFlag.js.map

package/dist/cjs/sdk/featureFlag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"featureFlag.js","sourceRoot":"","sources":["../../../src/sdk/featureFlag.ts"],"names":[],"mappings":";;;AAAA,IAAY,WAEX;AAFD,WAAY,WAAW;IACrB,sCAAuB,CAAA;AACzB,CAAC,EAFW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAEtB"}

package/dist/cjs/sdk/hosting.d.ts

@@ -0,0 +1,4 @@
+export declare enum Hosting {
+    CLOUD = "cloud",
+    SELF = "self"
+}

package/dist/cjs/sdk/hosting.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Hosting = void 0;
+var Hosting;
+(function (Hosting) {
+    Hosting["CLOUD"] = "cloud";
+    Hosting["SELF"] = "self";
+})(Hosting = exports.Hosting || (exports.Hosting = {}));
+//# sourceMappingURL=hosting.js.map

package/dist/cjs/sdk/hosting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hosting.js","sourceRoot":"","sources":["../../../src/sdk/hosting.ts"],"names":[],"mappings":";;;AAAA,IAAY,OAGX;AAHD,WAAY,OAAO;IACjB,0BAAe,CAAA;IACf,wBAAa,CAAA;AACf,CAAC,EAHW,OAAO,GAAP,eAAO,KAAP,eAAO,QAGlB"}

package/dist/cjs/sdk/index.d.ts

@@ -0,0 +1,20 @@
+export * from "./automations";
+export * from "./hosting";
+export * from "./context";
+export * from "./events";
+export * from "./licensing";
+export * from "./migrations";
+export * from "./datasources";
+export * from "./search";
+export * from "./koa";
+export * from "./auth";
+export * from "./locks";
+export * from "./db";
+export * from "./middleware";
+export * from "./featureFlag";
+export * from "./environmentVariables";
+export * from "./auditLogs";
+export * from "./sso";
+export * from "./user";
+export * from "./cli";
+export * from "./websocket";