@budibase/types 2.9.19 → 2.9.20

package/dist/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/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/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/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/{src/sdk/events/rows.ts → dist/sdk/events/rows.d.ts}

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

package/dist/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/{src/sdk/events/serve.ts → dist/sdk/events/serve.d.ts}

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

package/dist/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/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/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/{src/sdk/events/version.ts → dist/sdk/events/version.d.ts}

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

package/{src/sdk/events/view.ts → dist/sdk/events/view.d.ts}

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

package/dist/sdk/featureFlag.d.ts

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

package/dist/sdk/hosting.d.ts

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

package/dist/sdk/index.d.ts

@@ -0,0 +1,21 @@
+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";
+export * from "./permissions";

package/dist/sdk/koa.d.ts

@@ -0,0 +1,44 @@
+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;
+    roleId?: string;
+}
+/**
+ * @deprecated: Use UserCtx / Ctx appropriately
+ * Authenticated context.
+ */
+export interface BBContext extends Ctx {
+    user?: ContextUser;
+}

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

@@ -0,0 +1,21 @@
+import { PriceDuration } from "./plan";
+export interface Customer {
+    balance: number | null | undefined;
+    currency: string | null | undefined;
+}
+export interface Subscription {
+    amount: number;
+    currency: string;
+    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/sdk/licensing/feature.d.ts

@@ -0,0 +1,16 @@
+import { PlanType } from "./plan";
+export declare enum Feature {
+    USER_GROUPS = "userGroups",
+    APP_BACKUPS = "appBackups",
+    ENVIRONMENT_VARIABLES = "environmentVariables",
+    AUDIT_LOGS = "auditLogs",
+    ENFORCEABLE_SSO = "enforceableSSO",
+    BRANDING = "branding",
+    SCIM = "scim",
+    SYNC_AUTOMATIONS = "syncAutomations",
+    APP_BUILDERS = "appBuilders",
+    OFFLINE = "offline"
+}
+export declare type PlanFeatures = {
+    [key in PlanType]: Feature[] | undefined;
+};

package/dist/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/sdk/licensing/license.d.ts

@@ -0,0 +1,17 @@
+import { PurchasedPlan, Quotas, Feature, Billing } from ".";
+import { ISO8601 } from "../../shared";
+export interface OfflineIdentifier {
+    installId: string;
+    tenantId: string;
+}
+export interface OfflineLicense extends License {
+    identifier: OfflineIdentifier;
+    expireAt: ISO8601;
+}
+export interface License {
+    features: Feature[];
+    quotas: Quotas;
+    plan: PurchasedPlan;
+    billing?: Billing;
+    testClockId?: string;
+}

package/dist/sdk/licensing/plan.d.ts

@@ -0,0 +1,41 @@
+export declare enum PlanType {
+    FREE = "free",
+    /** @deprecated */
+    PRO = "pro",
+    /** @deprecated */
+    TEAM = "team",
+    PREMIUM = "premium",
+    BUSINESS = "business",
+    ENTERPRISE = "enterprise"
+}
+export declare enum PriceDuration {
+    MONTHLY = "monthly",
+    YEARLY = "yearly"
+}
+export interface AvailablePlan {
+    type: PlanType;
+    maxUsers: number;
+    prices: AvailablePrice[];
+}
+export interface AvailablePrice {
+    amount: number;
+    amountMonthly: number;
+    currency: string;
+    duration: PriceDuration;
+    priceId: string;
+}
+export declare enum PlanModel {
+    PER_USER = "perUser",
+    DAY_PASS = "dayPass"
+}
+export interface PurchasedPlan {
+    type: PlanType;
+    model: PlanModel;
+    usesInvoicing: boolean;
+    price?: PurchasedPrice;
+}
+export interface PurchasedPrice extends AvailablePrice {
+    dayPasses: number | undefined;
+    /** @deprecated - now at the plan level via model */
+    isPerUser: boolean;
+}

package/dist/sdk/licensing/quota.d.ts

@@ -0,0 +1,69 @@
+import { PlanType } from ".";
+export declare enum QuotaUsageType {
+    STATIC = "static",
+    MONTHLY = "monthly"
+}
+export declare enum QuotaType {
+    USAGE = "usage",
+    CONSTANT = "constant"
+}
+export declare enum StaticQuotaName {
+    ROWS = "rows",
+    APPS = "apps",
+    USERS = "users",
+    USER_GROUPS = "userGroups",
+    PLUGINS = "plugins"
+}
+export declare enum MonthlyQuotaName {
+    QUERIES = "queries",
+    AUTOMATIONS = "automations",
+    DAY_PASSES = "dayPasses"
+}
+export declare enum ConstantQuotaName {
+    AUTOMATION_LOG_RETENTION_DAYS = "automationLogRetentionDays",
+    APP_BACKUPS_RETENTION_DAYS = "appBackupRetentionDays"
+}
+export declare type MeteredQuotaName = StaticQuotaName | MonthlyQuotaName;
+export declare type QuotaName = StaticQuotaName | MonthlyQuotaName | ConstantQuotaName;
+export declare const isStaticQuota: (quotaType: QuotaType, usageType: QuotaUsageType, name: QuotaName) => name is StaticQuotaName;
+export declare const isMonthlyQuota: (quotaType: QuotaType, usageType: QuotaUsageType, name: QuotaName) => name is MonthlyQuotaName;
+export declare const isConstantQuota: (quotaType: QuotaType, name: QuotaName) => name is ConstantQuotaName;
+export declare type PlanQuotas = {
+    [key in PlanType]: Quotas | undefined;
+};
+export declare type MonthlyQuotas = {
+    [MonthlyQuotaName.QUERIES]: Quota;
+    [MonthlyQuotaName.AUTOMATIONS]: Quota;
+    [MonthlyQuotaName.DAY_PASSES]: Quota;
+};
+export declare type StaticQuotas = {
+    [StaticQuotaName.ROWS]: Quota;
+    [StaticQuotaName.APPS]: Quota;
+    [StaticQuotaName.USERS]: Quota;
+    [StaticQuotaName.USER_GROUPS]: Quota;
+    [StaticQuotaName.PLUGINS]: Quota;
+};
+export declare type ConstantQuotas = {
+    [ConstantQuotaName.AUTOMATION_LOG_RETENTION_DAYS]: Quota;
+    [ConstantQuotaName.APP_BACKUPS_RETENTION_DAYS]: Quota;
+};
+export declare type Quotas = {
+    [QuotaType.USAGE]: {
+        [QuotaUsageType.MONTHLY]: MonthlyQuotas;
+        [QuotaUsageType.STATIC]: StaticQuotas;
+    };
+    [QuotaType.CONSTANT]: ConstantQuotas;
+};
+export interface Quota {
+    name: string;
+    value: number;
+    /**
+     * Array of whole numbers (1-100) that dictate the percentage that this quota should trigger
+     * at in relation to the corresponding usage inside budibase.
+     *
+     * Triggering results in a budibase installation sending a request to account-portal,
+     * which can have subsequent effects such as sending emails to users.
+     */
+    triggers: number[];
+    startDate?: number;
+}