@budibase/types 2.4.17 → 2.4.19

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

@@ -0,0 +1,29 @@
+import { PlanType } from "../licensing";
+export interface LicenseTierChangedEvent {
+    accountId: string;
+    from: number;
+    to: number;
+}
+export interface LicensePlanChangedEvent {
+    accountId: string;
+    from: PlanType;
+    to: PlanType;
+}
+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/mjs/sdk/events/license.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=license.js.map

package/dist/{sdk → mjs/sdk}/events/license.js.map

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

package/dist/mjs/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/mjs/sdk/events/plugin.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=plugin.js.map

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

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

package/dist/mjs/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/mjs/sdk/events/query.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=query.js.map

package/dist/{sdk → mjs/sdk}/events/query.js.map

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

package/dist/mjs/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/mjs/sdk/events/role.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=role.js.map

package/dist/{sdk → mjs/sdk}/events/role.js.map

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

package/dist/mjs/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/mjs/sdk/events/rows.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=rows.js.map

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

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

package/dist/mjs/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/mjs/sdk/events/screen.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=screen.js.map

package/dist/{sdk → mjs/sdk}/events/screen.js.map

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

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

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

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=serve.js.map

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

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

package/dist/mjs/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/mjs/sdk/events/table.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=table.js.map

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

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

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

@@ -0,0 +1,73 @@
+import { BaseEvent } from "./event";
+export interface UserCreatedEvent extends BaseEvent {
+    userId: string;
+    audited: {
+        email: string;
+    };
+}
+export interface UserUpdatedEvent extends BaseEvent {
+    userId: string;
+    audited: {
+        email: string;
+    };
+}
+export interface UserDeletedEvent extends BaseEvent {
+    userId: string;
+    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;
+    };
+}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=user.js.map

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

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

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

@@ -0,0 +1,44 @@
+import { BaseEvent } from "./event";
+export interface GroupCreatedEvent extends BaseEvent {
+    groupId: string;
+    audited: {
+        name: string;
+    };
+}
+export interface GroupUpdatedEvent extends BaseEvent {
+    groupId: string;
+    audited: {
+        name: string;
+    };
+}
+export interface GroupDeletedEvent extends BaseEvent {
+    groupId: string;
+    audited: {
+        name: string;
+    };
+}
+export interface GroupUsersAddedEvent extends BaseEvent {
+    count: number;
+    groupId: string;
+    audited: {
+        name: string;
+    };
+}
+export interface GroupUsersDeletedEvent extends BaseEvent {
+    count: number;
+    groupId: string;
+    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/mjs/sdk/events/userGroup.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=userGroup.js.map

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

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

package/dist/mjs/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/mjs/sdk/events/version.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=version.js.map

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

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

package/dist/mjs/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/mjs/sdk/events/view.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=view.js.map

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

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

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

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

package/dist/mjs/sdk/featureFlag.js

@@ -0,0 +1,5 @@
+export var FeatureFlag;
+(function (FeatureFlag) {
+    FeatureFlag["LICENSING"] = "LICENSING";
+})(FeatureFlag || (FeatureFlag = {}));
+//# sourceMappingURL=featureFlag.js.map

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

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

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

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

package/dist/mjs/sdk/hosting.js

@@ -0,0 +1,6 @@
+export var Hosting;
+(function (Hosting) {
+    Hosting["CLOUD"] = "cloud";
+    Hosting["SELF"] = "self";
+})(Hosting || (Hosting = {}));
+//# sourceMappingURL=hosting.js.map

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

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

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

@@ -0,0 +1,18 @@
+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";

package/dist/mjs/sdk/index.js

@@ -0,0 +1,19 @@
+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";
+//# sourceMappingURL=index.js.map

package/dist/mjs/sdk/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/sdk/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,UAAU,CAAA;AACxB,cAAc,OAAO,CAAA;AACrB,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,MAAM,CAAA;AACpB,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,wBAAwB,CAAA;AACtC,cAAc,aAAa,CAAA;AAC3B,cAAc,OAAO,CAAA;AACrB,cAAc,QAAQ,CAAA;AACtB,cAAc,OAAO,CAAA"}

package/dist/mjs/sdk/koa.d.ts

@@ -0,0 +1,43 @@
+import { Context, Request } from "koa";
+import { User, Role, UserRoles, Account } from "../documents";
+import { FeatureFlag, License } from "../sdk";
+import { Files } from "formidable";
+export interface ContextUser extends Omit<User, "roles"> {
+    globalId?: string;
+    license?: License;
+    userId?: string;
+    roleId?: string | null;
+    role?: Role;
+    roles?: UserRoles;
+    csrfToken?: string;
+    featureFlags?: FeatureFlag[];
+    accountPortalAccess?: boolean;
+    account?: Account;
+}
+/**
+ * Add support for koa-body in context.
+ */
+export interface BBRequest<RequestBody> extends Request {
+    body: RequestBody;
+    files?: Files;
+}
+/**
+ * Basic context with no user.
+ */
+export interface Ctx<RequestBody = any, ResponseBody = any> extends Context {
+    request: BBRequest<RequestBody>;
+    body: ResponseBody;
+}
+/**
+ * Authenticated context.
+ */
+export interface UserCtx<RequestBody = any, ResponseBody = any> extends Ctx<RequestBody, ResponseBody> {
+    user: ContextUser;
+}
+/**
+ * @deprecated: Use UserCtx / Ctx appropriately
+ * Authenticated context.
+ */
+export interface BBContext extends Ctx {
+    user?: ContextUser;
+}

package/dist/mjs/sdk/koa.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=koa.js.map

package/dist/mjs/sdk/koa.js.map

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

package/dist/mjs/sdk/licensing/billing.d.ts

@@ -0,0 +1,20 @@
+import { PriceDuration } from "./plan";
+export interface Customer {
+    balance: number | null | undefined;
+    currency: string | null | undefined;
+}
+export interface Subscription {
+    amount: number;
+    quantity: number;
+    duration: PriceDuration;
+    cancelAt: number | null | undefined;
+    currentPeriodStart: number;
+    currentPeriodEnd: number;
+    status: string;
+    pastDueAt?: number | null;
+    downgradeAt?: number;
+}
+export interface Billing {
+    customer: Customer;
+    subscription?: Subscription;
+}

package/dist/mjs/sdk/licensing/billing.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=billing.js.map

package/dist/mjs/sdk/licensing/billing.js.map

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

package/dist/mjs/sdk/licensing/feature.d.ts

@@ -0,0 +1,7 @@
+export declare enum Feature {
+    USER_GROUPS = "userGroups",
+    APP_BACKUPS = "appBackups",
+    ENVIRONMENT_VARIABLES = "environmentVariables",
+    AUDIT_LOGS = "auditLogs",
+    ENFORCEABLE_SSO = "enforceableSSO"
+}

package/dist/mjs/sdk/licensing/feature.js

@@ -0,0 +1,9 @@
+export var Feature;
+(function (Feature) {
+    Feature["USER_GROUPS"] = "userGroups";
+    Feature["APP_BACKUPS"] = "appBackups";
+    Feature["ENVIRONMENT_VARIABLES"] = "environmentVariables";
+    Feature["AUDIT_LOGS"] = "auditLogs";
+    Feature["ENFORCEABLE_SSO"] = "enforceableSSO";
+})(Feature || (Feature = {}));
+//# sourceMappingURL=feature.js.map

package/dist/mjs/sdk/licensing/feature.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"feature.js","sourceRoot":"","sources":["../../../../src/sdk/licensing/feature.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,OAMX;AAND,WAAY,OAAO;IACjB,qCAA0B,CAAA;IAC1B,qCAA0B,CAAA;IAC1B,yDAA8C,CAAA;IAC9C,mCAAwB,CAAA;IACxB,6CAAkC,CAAA;AACpC,CAAC,EANW,OAAO,KAAP,OAAO,QAMlB"}

package/dist/mjs/sdk/licensing/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./license";
+export * from "./plan";
+export * from "./quota";
+export * from "./feature";
+export * from "./billing";

package/dist/mjs/sdk/licensing/index.js

@@ -0,0 +1,6 @@
+export * from "./license";
+export * from "./plan";
+export * from "./quota";
+export * from "./feature";
+export * from "./billing";
+//# sourceMappingURL=index.js.map