@budibase/types 2.9.19 → 2.9.20

package/src/sdk/events/user.ts

@@ -1,92 +0,0 @@
-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/src/sdk/events/userGroup.ts

@@ -1,56 +0,0 @@
-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/featureFlag.ts

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

package/src/sdk/hosting.ts

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

package/src/sdk/index.ts

@@ -1,21 +0,0 @@
-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/src/sdk/koa.ts

@@ -1,50 +0,0 @@
-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/src/sdk/licensing/billing.ts

@@ -1,24 +0,0 @@
-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/src/sdk/licensing/feature.ts

@@ -1,16 +0,0 @@
-import { PlanType } from "./plan"
-
-export 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 type PlanFeatures = { [key in PlanType]: Feature[] | undefined }

package/src/sdk/licensing/index.ts

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

package/src/sdk/licensing/license.ts

@@ -1,20 +0,0 @@
-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/src/sdk/licensing/plan.ts

@@ -1,47 +0,0 @@
-export enum PlanType {
-  FREE = "free",
-  /** @deprecated */
-  PRO = "pro",
-  /** @deprecated */
-  TEAM = "team",
-  PREMIUM = "premium",
-  BUSINESS = "business",
-  ENTERPRISE = "enterprise",
-}
-
-export 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 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/src/sdk/licensing/quota.ts

@@ -1,99 +0,0 @@
-import { PlanType } from "."
-
-export enum QuotaUsageType {
-  STATIC = "static",
-  MONTHLY = "monthly",
-}
-
-export enum QuotaType {
-  USAGE = "usage",
-  CONSTANT = "constant",
-}
-
-export enum StaticQuotaName {
-  ROWS = "rows",
-  APPS = "apps",
-  USERS = "users",
-  USER_GROUPS = "userGroups",
-  PLUGINS = "plugins",
-}
-
-export enum MonthlyQuotaName {
-  QUERIES = "queries",
-  AUTOMATIONS = "automations",
-  DAY_PASSES = "dayPasses",
-}
-
-export enum ConstantQuotaName {
-  AUTOMATION_LOG_RETENTION_DAYS = "automationLogRetentionDays",
-  APP_BACKUPS_RETENTION_DAYS = "appBackupRetentionDays",
-}
-
-export type MeteredQuotaName = StaticQuotaName | MonthlyQuotaName
-export type QuotaName = StaticQuotaName | MonthlyQuotaName | ConstantQuotaName
-
-export const isStaticQuota = (
-  quotaType: QuotaType,
-  usageType: QuotaUsageType,
-  name: QuotaName
-): name is StaticQuotaName => {
-  return quotaType === QuotaType.USAGE && usageType === QuotaUsageType.STATIC
-}
-
-export const isMonthlyQuota = (
-  quotaType: QuotaType,
-  usageType: QuotaUsageType,
-  name: QuotaName
-): name is MonthlyQuotaName => {
-  return quotaType === QuotaType.USAGE && usageType === QuotaUsageType.MONTHLY
-}
-
-export const isConstantQuota = (
-  quotaType: QuotaType,
-  name: QuotaName
-): name is ConstantQuotaName => {
-  return quotaType === QuotaType.CONSTANT
-}
-
-export type PlanQuotas = { [key in PlanType]: Quotas | undefined }
-
-export type MonthlyQuotas = {
-  [MonthlyQuotaName.QUERIES]: Quota
-  [MonthlyQuotaName.AUTOMATIONS]: Quota
-  [MonthlyQuotaName.DAY_PASSES]: Quota
-}
-
-export type StaticQuotas = {
-  [StaticQuotaName.ROWS]: Quota
-  [StaticQuotaName.APPS]: Quota
-  [StaticQuotaName.USERS]: Quota
-  [StaticQuotaName.USER_GROUPS]: Quota
-  [StaticQuotaName.PLUGINS]: Quota
-}
-
-export type ConstantQuotas = {
-  [ConstantQuotaName.AUTOMATION_LOG_RETENTION_DAYS]: Quota
-  [ConstantQuotaName.APP_BACKUPS_RETENTION_DAYS]: Quota
-}
-
-export 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/src/sdk/locks.ts

@@ -1,50 +0,0 @@
-import Redlock from "redlock"
-
-export 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 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/src/sdk/middleware/index.ts

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

package/src/sdk/middleware/matchers.ts

@@ -1,22 +0,0 @@
-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/src/sdk/middleware/tenancy.ts

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

package/src/sdk/migrations.ts

@@ -1,55 +0,0 @@
-export interface Migration extends MigrationDefinition {
-  appOpts?: object
-  fn: Function
-  silent?: boolean
-  preventRetry?: boolean
-}
-
-export enum MigrationType {
-  // run once per tenant, recorded in global db, global db is provided as an argument
-  GLOBAL = "global",
-  // run per app, recorded in each app db, app db is provided as an argument
-  APP = "app",
-  // run once, recorded in global info db, global info db is provided as an argument
-  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 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",
-  // increment this number to re-activate this migration
-  SYNC_QUOTAS = "sync_quotas_1",
-}
-
-export interface MigrationDefinition {
-  type: MigrationType
-  name: MigrationName
-}

package/src/sdk/permissions.ts

@@ -1,19 +0,0 @@
-export enum PermissionLevel {
-  READ = "read",
-  WRITE = "write",
-  EXECUTE = "execute",
-  ADMIN = "admin",
-}
-
-// these are the global types, that govern the underlying default behaviour
-export enum PermissionType {
-  APP = "app",
-  TABLE = "table",
-  USER = "user",
-  AUTOMATION = "automation",
-  WEBHOOK = "webhook",
-  BUILDER = "builder",
-  GLOBAL_BUILDER = "globalBuilder",
-  VIEW = "view",
-  QUERY = "query",
-}