@budibase/types 2.8.31-alpha.0 → 2.8.31

package/dist/cjs/sdk/index.js

@@ -0,0 +1,37 @@
+"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("./automations"), exports);
+__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);
+__exportStar(require("./websocket"), 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,gDAA6B;AAC7B,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;AACrB,8CAA2B"}

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/cjs/sdk/koa.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# 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,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/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,15 @@
+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",
+    OFFLINE = "offline"
+}
+export declare type PlanFeatures = {
+    [key in PlanType]: Feature[] | undefined;
+};

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

@@ -0,0 +1,16 @@
+"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["SYNC_AUTOMATIONS"] = "syncAutomations";
+    Feature["OFFLINE"] = "offline";
+})(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":";;;AAEA,IAAY,OAUX;AAVD,WAAY,OAAO;IACjB,qCAA0B,CAAA;IAC1B,qCAA0B,CAAA;IAC1B,yDAA8C,CAAA;IAC9C,mCAAwB,CAAA;IACxB,6CAAkC,CAAA;IAClC,gCAAqB,CAAA;IACrB,wBAAa,CAAA;IACb,+CAAoC,CAAA;IACpC,8BAAmB,CAAA;AACrB,CAAC,EAVW,OAAO,GAAP,eAAO,KAAP,eAAO,QAUlB"}

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,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/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,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/cjs/sdk/licensing/plan.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlanModel = exports.PriceDuration = exports.PlanType = void 0;
+var PlanType;
+(function (PlanType) {
+    PlanType["FREE"] = "free";
+    /** @deprecated */
+    PlanType["PRO"] = "pro";
+    /** @deprecated */
+    PlanType["TEAM"] = "team";
+    PlanType["PREMIUM"] = "premium";
+    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 = {}));
+var PlanModel;
+(function (PlanModel) {
+    PlanModel["PER_USER"] = "perUser";
+    PlanModel["DAY_PASS"] = "dayPass";
+})(PlanModel = exports.PlanModel || (exports.PlanModel = {}));
+//# 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":";;;AAAA,IAAY,QASX;AATD,WAAY,QAAQ;IAClB,yBAAa,CAAA;IACb,kBAAkB;IAClB,uBAAW,CAAA;IACX,kBAAkB;IAClB,yBAAa,CAAA;IACb,+BAAmB,CAAA;IACnB,iCAAqB,CAAA;IACrB,qCAAyB,CAAA;AAC3B,CAAC,EATW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QASnB;AAED,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,kCAAiB,CAAA;AACnB,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAgBD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,iCAAoB,CAAA;IACpB,iCAAoB,CAAA;AACtB,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}

package/dist/cjs/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;
+}

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;
+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["USERS"] = "users";
+    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

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

@@ -0,0 +1 @@
+{"version":3,"file":"quota.js","sourceRoot":"","sources":["../../../../src/sdk/licensing/quota.ts"],"names":[],"mappings":";;;AAEA,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,qCAAmB,CAAA;AACrB,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAED,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,4BAAe,CAAA;IACf,kCAAqB,CAAA;AACvB,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAED,IAAY,eAMX;AAND,WAAY,eAAe;IACzB,gCAAa,CAAA;IACb,gCAAa,CAAA;IACb,kCAAe,CAAA;IACf,6CAA0B,CAAA;IAC1B,sCAAmB,CAAA;AACrB,CAAC,EANW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAM1B;AAED,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,+CAA2B,CAAA;IAC3B,4CAAwB,CAAA;AAC1B,CAAC,EAJW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAI3B;AAED,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,iFAA4D,CAAA;IAC5D,0EAAqD,CAAA;AACvD,CAAC,EAHW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAG5B;AAKM,MAAM,aAAa,GAAG,CAC3B,SAAoB,EACpB,SAAyB,EACzB,IAAe,EACU,EAAE;IAC3B,OAAO,SAAS,KAAK,SAAS,CAAC,KAAK,IAAI,SAAS,KAAK,cAAc,CAAC,MAAM,CAAA;AAC7E,CAAC,CAAA;AANY,QAAA,aAAa,iBAMzB;AAEM,MAAM,cAAc,GAAG,CAC5B,SAAoB,EACpB,SAAyB,EACzB,IAAe,EACW,EAAE;IAC5B,OAAO,SAAS,KAAK,SAAS,CAAC,KAAK,IAAI,SAAS,KAAK,cAAc,CAAC,OAAO,CAAA;AAC9E,CAAC,CAAA;AANY,QAAA,cAAc,kBAM1B;AAEM,MAAM,eAAe,GAAG,CAC7B,SAAoB,EACpB,IAAe,EACY,EAAE;IAC7B,OAAO,SAAS,KAAK,SAAS,CAAC,QAAQ,CAAA;AACzC,CAAC,CAAA;AALY,QAAA,eAAe,mBAK3B"}

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

@@ -0,0 +1,47 @@
+import Redlock from "redlock";
+export declare enum LockType {
+    /**
+     * If this lock is already held the attempted operation will not be performed.
+     * No retries will take place and no error will be thrown.
+     */
+    TRY_ONCE = "try_once",
+    TRY_TWICE = "try_twice",
+    DEFAULT = "default",
+    DELAY_500 = "delay_500",
+    CUSTOM = "custom"
+}
+export declare enum LockName {
+    MIGRATIONS = "migrations",
+    TRIGGER_QUOTA = "trigger_quota",
+    SYNC_ACCOUNT_LICENSE = "sync_account_license",
+    UPDATE_TENANTS_DOC = "update_tenants_doc",
+    PERSIST_WRITETHROUGH = "persist_writethrough",
+    QUOTA_USAGE_EVENT = "quota_usage_event"
+}
+export interface LockOptions {
+    /**
+     * The lock type determines which client to use
+     */
+    type: LockType;
+    /**
+     * The custom options to use when creating the redlock instance
+     * type must be set to custom for the options to be applied
+     */
+    customOptions?: Redlock.Options;
+    /**
+     * The name for the lock
+     */
+    name: LockName;
+    /**
+     * The ttl to auto-expire the lock if not unlocked manually
+     */
+    ttl: number;
+    /**
+     * The individual resource to lock. This is useful for locking around very specific identifiers, e.g. a document that is prone to conflicts
+     */
+    resource?: string;
+    /**
+     * This is a system-wide lock - don't use tenancy in lock key
+     */
+    systemLock?: boolean;
+}

package/dist/cjs/sdk/locks.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LockName = exports.LockType = void 0;
+var LockType;
+(function (LockType) {
+    /**
+     * If this lock is already held the attempted operation will not be performed.
+     * No retries will take place and no error will be thrown.
+     */
+    LockType["TRY_ONCE"] = "try_once";
+    LockType["TRY_TWICE"] = "try_twice";
+    LockType["DEFAULT"] = "default";
+    LockType["DELAY_500"] = "delay_500";
+    LockType["CUSTOM"] = "custom";
+})(LockType = exports.LockType || (exports.LockType = {}));
+var LockName;
+(function (LockName) {
+    LockName["MIGRATIONS"] = "migrations";
+    LockName["TRIGGER_QUOTA"] = "trigger_quota";
+    LockName["SYNC_ACCOUNT_LICENSE"] = "sync_account_license";
+    LockName["UPDATE_TENANTS_DOC"] = "update_tenants_doc";
+    LockName["PERSIST_WRITETHROUGH"] = "persist_writethrough";
+    LockName["QUOTA_USAGE_EVENT"] = "quota_usage_event";
+})(LockName = exports.LockName || (exports.LockName = {}));
+//# sourceMappingURL=locks.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"locks.js","sourceRoot":"","sources":["../../../src/sdk/locks.ts"],"names":[],"mappings":";;;AAEA,IAAY,QAUX;AAVD,WAAY,QAAQ;IAClB;;;OAGG;IACH,iCAAqB,CAAA;IACrB,mCAAuB,CAAA;IACvB,+BAAmB,CAAA;IACnB,mCAAuB,CAAA;IACvB,6BAAiB,CAAA;AACnB,CAAC,EAVW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAUnB;AAED,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,qCAAyB,CAAA;IACzB,2CAA+B,CAAA;IAC/B,yDAA6C,CAAA;IAC7C,qDAAyC,CAAA;IACzC,yDAA6C,CAAA;IAC7C,mDAAuC,CAAA;AACzC,CAAC,EAPW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB"}

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

@@ -0,0 +1,2 @@
+export * from "./matchers";
+export * from "./tenancy";

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

@@ -0,0 +1,19 @@
+"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("./matchers"), exports);
+__exportStar(require("./tenancy"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/sdk/middleware/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA0B;AAC1B,4CAAyB"}

package/dist/cjs/sdk/middleware/matchers.d.ts

@@ -0,0 +1,21 @@
+export interface EndpointMatcher {
+    /**
+     * The HTTP Path. e.g. /api/things/:thingId
+     */
+    route: string;
+    /**
+     * The HTTP Verb. e.g. GET, POST, etc.
+     * ALL is also accepted to cover all verbs.
+     */
+    method: string;
+    /**
+     * The route must match exactly - not just begins with
+     */
+    strict?: boolean;
+}
+export interface RegexMatcher {
+    regex: RegExp;
+    method: string;
+    strict: boolean;
+    route: string;
+}

package/dist/cjs/sdk/middleware/matchers.js

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

package/dist/cjs/sdk/middleware/matchers.js.map

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

package/dist/cjs/sdk/middleware/tenancy.d.ts

@@ -0,0 +1,12 @@
+export interface GetTenantIdOptions {
+    allowNoTenant?: boolean;
+    excludeStrategies?: TenantResolutionStrategy[];
+    includeStrategies?: TenantResolutionStrategy[];
+}
+export declare enum TenantResolutionStrategy {
+    USER = "user",
+    HEADER = "header",
+    QUERY = "query",
+    SUBDOMAIN = "subdomain",
+    PATH = "path"
+}

package/dist/cjs/sdk/middleware/tenancy.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TenantResolutionStrategy = void 0;
+var TenantResolutionStrategy;
+(function (TenantResolutionStrategy) {
+    TenantResolutionStrategy["USER"] = "user";
+    TenantResolutionStrategy["HEADER"] = "header";
+    TenantResolutionStrategy["QUERY"] = "query";
+    TenantResolutionStrategy["SUBDOMAIN"] = "subdomain";
+    TenantResolutionStrategy["PATH"] = "path";
+})(TenantResolutionStrategy = exports.TenantResolutionStrategy || (exports.TenantResolutionStrategy = {}));
+//# sourceMappingURL=tenancy.js.map

package/dist/cjs/sdk/middleware/tenancy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenancy.js","sourceRoot":"","sources":["../../../../src/sdk/middleware/tenancy.ts"],"names":[],"mappings":";;;AAMA,IAAY,wBAMX;AAND,WAAY,wBAAwB;IAClC,yCAAa,CAAA;IACb,6CAAiB,CAAA;IACjB,2CAAe,CAAA;IACf,mDAAuB,CAAA;IACvB,yCAAa,CAAA;AACf,CAAC,EANW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAMnC"}

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

@@ -0,0 +1,46 @@
+export interface Migration extends MigrationDefinition {
+    appOpts?: object;
+    fn: Function;
+    silent?: boolean;
+    preventRetry?: boolean;
+}
+export declare enum MigrationType {
+    GLOBAL = "global",
+    APP = "app",
+    INSTALLATION = "installation"
+}
+export interface MigrationNoOpOptions {
+    type: MigrationType;
+    tenantId: string;
+    appId?: string;
+}
+/**
+ * e.g.
+ * {
+ *   tenantIds: ['bb'],
+ *   force: {
+ *    global: ['quota_1']
+ *   }
+ * }
+ */
+export interface MigrationOptions {
+    tenantIds?: string[];
+    force?: {
+        [type: string]: string[];
+    };
+    noOp?: MigrationNoOpOptions;
+}
+export declare enum MigrationName {
+    USER_EMAIL_VIEW_CASING = "user_email_view_casing",
+    APP_URLS = "app_urls",
+    EVENT_APP_BACKFILL = "event_app_backfill",
+    EVENT_GLOBAL_BACKFILL = "event_global_backfill",
+    EVENT_INSTALLATION_BACKFILL = "event_installation_backfill",
+    GLOBAL_INFO_SYNC_USERS = "global_info_sync_users",
+    TABLE_SETTINGS_LINKS_TO_ACTIONS = "table_settings_links_to_actions",
+    SYNC_QUOTAS = "sync_quotas_1"
+}
+export interface MigrationDefinition {
+    type: MigrationType;
+    name: MigrationName;
+}