@budibase/types 0.0.1 → 0.0.999-alpha.31

package/dist/{sdk → cjs/sdk}/events/screen.d.ts

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

package/dist/{documents/app → cjs/sdk/events}/screen.js.map

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

package/dist/{sdk → cjs/sdk}/events/serve.d.ts

@@ -1,9 +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/{sdk → cjs/sdk}/events/serve.js.map

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

package/dist/{sdk → cjs/sdk}/events/table.d.ts

@@ -1,18 +1,32 @@
-import { BaseEvent, TableExportFormat, TableImportFormat } from "./event";
+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;
-    format: TableImportFormat;
+    audited: {
+        name: string;
+    };
 }

package/dist/{documents/app → cjs/sdk/events}/table.js.map

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

package/dist/{sdk → cjs/sdk}/events/user.d.ts

@@ -1,33 +1,76 @@
 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;
+    };
 }

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/{documents/app → cjs/sdk/events}/user.js.map

@@ -1 +1 @@
-{"version":3,"file":"user.js","sourceRoot":"","sources":["../../../src/documents/app/user.ts"],"names":[],"mappings":""}
+{"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/{sdk → cjs/sdk}/events/version.js.map

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

package/dist/{sdk → cjs/sdk}/events/view.js.map

@@ -1 +1 @@
-{"version":3,"file":"view.js","sourceRoot":"","sources":["../../../src/sdk/events/view.ts"],"names":[],"mappings":""}
+{"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.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,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/cjs/sdk/index.js

@@ -0,0 +1,35 @@
+"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("./hosting"), exports);
+__exportStar(require("./context"), exports);
+__exportStar(require("./events"), exports);
+__exportStar(require("./licensing"), exports);
+__exportStar(require("./migrations"), exports);
+__exportStar(require("./datasources"), exports);
+__exportStar(require("./search"), exports);
+__exportStar(require("./koa"), exports);
+__exportStar(require("./auth"), exports);
+__exportStar(require("./locks"), exports);
+__exportStar(require("./db"), exports);
+__exportStar(require("./middleware"), exports);
+__exportStar(require("./featureFlag"), exports);
+__exportStar(require("./environmentVariables"), exports);
+__exportStar(require("./auditLogs"), exports);
+__exportStar(require("./sso"), exports);
+__exportStar(require("./user"), exports);
+__exportStar(require("./cli"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/sdk/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB;AACzB,4CAAyB;AACzB,2CAAwB;AACxB,8CAA2B;AAC3B,+CAA4B;AAC5B,gDAA6B;AAC7B,2CAAwB;AACxB,wCAAqB;AACrB,yCAAsB;AACtB,0CAAuB;AACvB,uCAAoB;AACpB,+CAA4B;AAC5B,gDAA6B;AAC7B,yDAAsC;AACtC,8CAA2B;AAC3B,wCAAqB;AACrB,yCAAsB;AACtB,wCAAqB"}

package/dist/cjs/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/{documents/app/row.js → cjs/sdk/koa.js}

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

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

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

package/dist/cjs/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/cjs/sdk/licensing/billing.js

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

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

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

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

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

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

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Feature = void 0;
+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["BRANDING"] = "branding";
+    Feature["SCIM"] = "scim";
+})(Feature = exports.Feature || (exports.Feature = {}));
+//# sourceMappingURL=feature.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"feature.js","sourceRoot":"","sources":["../../../../src/sdk/licensing/feature.ts"],"names":[],"mappings":";;;AAAA,IAAY,OAQX;AARD,WAAY,OAAO;IACjB,qCAA0B,CAAA;IAC1B,qCAA0B,CAAA;IAC1B,yDAA8C,CAAA;IAC9C,mCAAwB,CAAA;IACxB,6CAAkC,CAAA;IAClC,gCAAqB,CAAA;IACrB,wBAAa,CAAA;AACf,CAAC,EARW,OAAO,GAAP,eAAO,KAAP,eAAO,QAQlB"}

package/dist/cjs/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/cjs/sdk/licensing/index.js

@@ -0,0 +1,22 @@
+"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("./license"), exports);
+__exportStar(require("./plan"), exports);
+__exportStar(require("./quota"), exports);
+__exportStar(require("./feature"), exports);
+__exportStar(require("./billing"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/sdk/licensing/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB;AACzB,yCAAsB;AACtB,0CAAuB;AACvB,4CAAyB;AACzB,4CAAyB"}

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

@@ -0,0 +1,7 @@
+import { AccountPlan, Quotas, Feature, Billing } from ".";
+export interface License {
+    features: Feature[];
+    quotas: Quotas;
+    plan: AccountPlan;
+    billing?: Billing;
+}

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

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

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

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

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

@@ -0,0 +1,24 @@
+export interface AccountPlan {
+    type: PlanType;
+    price?: Price;
+}
+export declare enum PlanType {
+    FREE = "free",
+    PRO = "pro",
+    TEAM = "team",
+    BUSINESS = "business",
+    ENTERPRISE = "enterprise"
+}
+export declare enum PriceDuration {
+    MONTHLY = "monthly",
+    YEARLY = "yearly"
+}
+export interface Price {
+    amount: number;
+    amountMonthly: number;
+    currency: string;
+    duration: PriceDuration;
+    priceId: string;
+    dayPasses: number;
+    isPerUser: boolean;
+}

package/dist/cjs/sdk/licensing/plan.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PriceDuration = exports.PlanType = void 0;
+var PlanType;
+(function (PlanType) {
+    PlanType["FREE"] = "free";
+    PlanType["PRO"] = "pro";
+    PlanType["TEAM"] = "team";
+    PlanType["BUSINESS"] = "business";
+    PlanType["ENTERPRISE"] = "enterprise";
+})(PlanType = exports.PlanType || (exports.PlanType = {}));
+var PriceDuration;
+(function (PriceDuration) {
+    PriceDuration["MONTHLY"] = "monthly";
+    PriceDuration["YEARLY"] = "yearly";
+})(PriceDuration = exports.PriceDuration || (exports.PriceDuration = {}));
+//# sourceMappingURL=plan.js.map

package/dist/cjs/sdk/licensing/plan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.js","sourceRoot":"","sources":["../../../../src/sdk/licensing/plan.ts"],"names":[],"mappings":";;;AAKA,IAAY,QAMX;AAND,WAAY,QAAQ;IAClB,yBAAa,CAAA;IACb,uBAAW,CAAA;IACX,yBAAa,CAAA;IACb,iCAAqB,CAAA;IACrB,qCAAyB,CAAA;AAC3B,CAAC,EANW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAMnB;AAED,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,kCAAiB,CAAA;AACnB,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB"}

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

@@ -0,0 +1,70 @@
+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",
+    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 = {
+    [PlanType.FREE]: Quotas;
+    [PlanType.PRO]: Quotas;
+    [PlanType.TEAM]: Quotas;
+    [PlanType.BUSINESS]: Quotas;
+    [PlanType.ENTERPRISE]: Quotas;
+};
+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.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[];
+}

package/dist/cjs/sdk/licensing/quota.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isConstantQuota = exports.isMonthlyQuota = exports.isStaticQuota = exports.ConstantQuotaName = exports.MonthlyQuotaName = exports.StaticQuotaName = exports.QuotaType = exports.QuotaUsageType = void 0;
+const _1 = require(".");
+var QuotaUsageType;
+(function (QuotaUsageType) {
+    QuotaUsageType["STATIC"] = "static";
+    QuotaUsageType["MONTHLY"] = "monthly";
+})(QuotaUsageType = exports.QuotaUsageType || (exports.QuotaUsageType = {}));
+var QuotaType;
+(function (QuotaType) {
+    QuotaType["USAGE"] = "usage";
+    QuotaType["CONSTANT"] = "constant";
+})(QuotaType = exports.QuotaType || (exports.QuotaType = {}));
+var StaticQuotaName;
+(function (StaticQuotaName) {
+    StaticQuotaName["ROWS"] = "rows";
+    StaticQuotaName["APPS"] = "apps";
+    StaticQuotaName["USER_GROUPS"] = "userGroups";
+    StaticQuotaName["PLUGINS"] = "plugins";
+})(StaticQuotaName = exports.StaticQuotaName || (exports.StaticQuotaName = {}));
+var MonthlyQuotaName;
+(function (MonthlyQuotaName) {
+    MonthlyQuotaName["QUERIES"] = "queries";
+    MonthlyQuotaName["AUTOMATIONS"] = "automations";
+    MonthlyQuotaName["DAY_PASSES"] = "dayPasses";
+})(MonthlyQuotaName = exports.MonthlyQuotaName || (exports.MonthlyQuotaName = {}));
+var ConstantQuotaName;
+(function (ConstantQuotaName) {
+    ConstantQuotaName["AUTOMATION_LOG_RETENTION_DAYS"] = "automationLogRetentionDays";
+    ConstantQuotaName["APP_BACKUPS_RETENTION_DAYS"] = "appBackupRetentionDays";
+})(ConstantQuotaName = exports.ConstantQuotaName || (exports.ConstantQuotaName = {}));
+const isStaticQuota = (quotaType, usageType, name) => {
+    return quotaType === QuotaType.USAGE && usageType === QuotaUsageType.STATIC;
+};
+exports.isStaticQuota = isStaticQuota;
+const isMonthlyQuota = (quotaType, usageType, name) => {
+    return quotaType === QuotaType.USAGE && usageType === QuotaUsageType.MONTHLY;
+};
+exports.isMonthlyQuota = isMonthlyQuota;
+const isConstantQuota = (quotaType, name) => {
+    return quotaType === QuotaType.CONSTANT;
+};
+exports.isConstantQuota = isConstantQuota;
+//# sourceMappingURL=quota.js.map