@budibase/types 0.0.1 → 0.0.999-alpha.30

package/src/sdk/featureFlag.ts

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

package/src/sdk/index.ts

@@ -3,3 +3,16 @@ 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/src/sdk/koa.ts

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

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

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

package/src/sdk/licensing/index.ts

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

package/src/sdk/licensing/license.ts

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

package/src/sdk/licensing/plan.ts

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

package/src/sdk/licensing/quota.ts

@@ -0,0 +1,102 @@
+import { PlanType } from "."
+
+export enum QuotaUsageType {
+  STATIC = "static",
+  MONTHLY = "monthly",
+}
+
+export enum QuotaType {
+  USAGE = "usage",
+  CONSTANT = "constant",
+}
+
+export enum StaticQuotaName {
+  ROWS = "rows",
+  APPS = "apps",
+  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 = {
+  [PlanType.FREE]: Quotas
+  [PlanType.PRO]: Quotas
+  [PlanType.TEAM]: Quotas
+  [PlanType.BUSINESS]: Quotas
+  [PlanType.ENTERPRISE]: Quotas
+}
+
+export type MonthlyQuotas = {
+  [MonthlyQuotaName.QUERIES]: Quota
+  [MonthlyQuotaName.AUTOMATIONS]: Quota
+  [MonthlyQuotaName.DAY_PASSES]: Quota
+}
+
+export type StaticQuotas = {
+  [StaticQuotaName.ROWS]: Quota
+  [StaticQuotaName.APPS]: 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[]
+}

package/src/sdk/locks.ts

@@ -0,0 +1,40 @@
+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",
+  DEFAULT = "default",
+  DELAY_500 = "delay_500",
+}
+
+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",
+}
+
+export interface LockOptions {
+  /**
+   * The lock type determines which client to use
+   */
+  type: LockType
+  /**
+   * 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

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

package/src/sdk/middleware/matchers.ts

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,13 @@
+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

@@ -39,13 +39,14 @@ export interface MigrationOptions {
 
 export enum MigrationName {
   USER_EMAIL_VIEW_CASING = "user_email_view_casing",
-  QUOTAS_1 = "quotas_1",
   APP_URLS = "app_urls",
-  DEVELOPER_QUOTA = "developer_quota",
-  PUBLISHED_APP_QUOTA = "published_apps_quota",
   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 {

package/src/sdk/search.ts

@@ -0,0 +1,101 @@
+import { Operation, SortDirection } from "./datasources"
+import { Row, Table } from "../documents"
+import { SortType } from "../api"
+
+export interface SearchFilters {
+  allOr?: boolean
+  string?: {
+    [key: string]: string
+  }
+  fuzzy?: {
+    [key: string]: string
+  }
+  range?: {
+    [key: string]: {
+      high: number | string
+      low: number | string
+    }
+  }
+  equal?: {
+    [key: string]: any
+  }
+  notEqual?: {
+    [key: string]: any
+  }
+  empty?: {
+    [key: string]: any
+  }
+  notEmpty?: {
+    [key: string]: any
+  }
+  oneOf?: {
+    [key: string]: any[]
+  }
+  contains?: {
+    [key: string]: any[]
+  }
+  notContains?: {
+    [key: string]: any[]
+  }
+  containsAny?: {
+    [key: string]: any[]
+  }
+}
+
+export interface SortJson {
+  [key: string]: {
+    direction: SortDirection
+    type?: SortType
+  }
+}
+
+export interface PaginationJson {
+  limit: number
+  page?: string | number
+}
+
+export interface RenameColumn {
+  old: string
+  updated: string
+}
+
+export interface RelationshipsJson {
+  through?: string
+  from?: string
+  to?: string
+  fromPrimary?: string
+  toPrimary?: string
+  tableName: string
+  column: string
+}
+
+export interface QueryJson {
+  endpoint: {
+    datasourceId: string
+    entityId: string
+    operation: Operation
+    schema?: string
+  }
+  resource?: {
+    fields: string[]
+  }
+  filters?: SearchFilters
+  sort?: SortJson
+  paginate?: PaginationJson
+  body?: Row | Row[]
+  table?: Table
+  meta?: {
+    table?: Table
+    tables?: Record<string, Table>
+    renamed?: RenameColumn
+  }
+  extra?: {
+    idFilter?: SearchFilters
+  }
+  relationships?: RelationshipsJson[]
+}
+
+export interface SqlQuery {
+  sql: string
+  bindings?: string[]
+}

package/src/sdk/sso.ts

@@ -0,0 +1,37 @@
+import {
+  OAuth2,
+  SSOProfileJson,
+  SSOProviderType,
+  SSOUser,
+  User,
+} from "../documents"
+import { SaveUserOpts } from "./user"
+
+export interface JwtClaims {
+  preferred_username?: string
+  email?: string
+}
+
+export interface SSOAuthDetails {
+  oauth2: OAuth2
+  provider: string
+  providerType: SSOProviderType
+  userId: string
+  email?: string
+  profile?: SSOProfile
+}
+
+export interface SSOProfile {
+  id: string
+  name?: {
+    givenName?: string
+    familyName?: string
+  }
+  _json: SSOProfileJson
+  provider?: string
+}
+
+export type SaveSSOUserFunction = (
+  user: SSOUser,
+  opts: SaveUserOpts
+) => Promise<User>

package/src/sdk/user.ts

@@ -0,0 +1,5 @@
+export interface SaveUserOpts {
+  hashPassword?: boolean
+  requirePassword?: boolean
+  currentUserId?: string
+}

package/tsconfig-base.build.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "lib": ["es2020"],
+    "strict": true,
+    "noImplicitAny": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "incremental": true,
+    "sourceMap": true,
+    "declaration": true,
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "**/*.spec.ts", "**/*.spec.js"]
+}

package/tsconfig-cjs.build.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig-base.build.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "outDir": "dist/cjs",
+    "target": "es2015"
+  }
+}

package/tsconfig.build.json

@@ -1,25 +1,8 @@
 {
+  "extends": "./tsconfig-base.build.json",
   "compilerOptions": {
     "target": "es6",
-    "module": "commonjs",
-    "lib": ["es2020"],
-    "allowJs": true,
-    "strict": true,
-    "noImplicitAny": true,
-    "esModuleInterop": true,
-    "resolveJsonModule": true,
-    "incremental": true,
-    "sourceMap": true,
-    "declaration": true,
-    "outDir": "dist"
-  },
-  "include": [
-    "src/**/*"
-  ],
-  "exclude": [
-    "node_modules",
-    "dist",
-    "**/*.spec.ts",
-    "**/*.spec.js"
-  ]
-}
+    "moduleResolution": "node",
+    "outDir": "dist/mjs"
+  }
+}

package/dist/documents/account/account.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"account.js","sourceRoot":"","sources":["../../../src/documents/account/account.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AAoB5B,MAAM,uBAAuB,GAAG,CACrC,OAAsB,EACa,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,CAAA;AAFjE,QAAA,uBAAuB,2BAE0C;AAwBvE,MAAM,iBAAiB,GAAG,CAC/B,OAAgB,EACY,EAAE,CAC9B,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,IAAI,OAAO,CAAC,OAAO,KAAK,aAAO,CAAC,IAAI,CAAA;AAH/D,QAAA,iBAAiB,qBAG8C;AAOrE,MAAM,cAAc,GAAG,CAAC,OAAgB,EAA2B,EAAE,CAC1E,OAAO,CAAC,OAAO,KAAK,aAAO,CAAC,KAAK,CAAA;AADtB,QAAA,cAAc,kBACQ;AAE5B,MAAM,iBAAiB,GAAG,CAAC,OAAgB,EAAE,EAAE,CACpD,OAAO,CAAC,OAAO,KAAK,aAAO,CAAC,IAAI,CAAA;AADrB,QAAA,iBAAiB,qBACI;AAE3B,MAAM,YAAY,GAAG,CAAC,OAAgB,EAAyB,EAAE,CACtE,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,GAAG,CAAA;AADtB,QAAA,YAAY,gBACU;AAUnC,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,uBAAW,CAAA;IACX,iCAAqB,CAAA;AACvB,CAAC,EAHW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAGnB"}

package/dist/documents/account/index.js.map

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

package/dist/documents/app/app.d.ts

@@ -1,17 +0,0 @@
-import { Document } from "../document";
-export interface App extends Document {
-    appId: string;
-    type: string;
-    version: string;
-    componentLibraries: string[];
-    name: string;
-    url: string | undefined;
-    template: string | undefined;
-    instance: AppInstance;
-    tenantId: string;
-    status: string;
-    revertableVersion?: string;
-}
-export interface AppInstance {
-    _id: string;
-}

package/dist/documents/app/automation.d.ts

@@ -1,16 +0,0 @@
-import { Document } from "../document";
-export interface Automation extends Document {
-    definition: {
-        steps: AutomationStep[];
-        trigger: AutomationTrigger;
-    };
-    appId: string;
-}
-export interface AutomationStep {
-    id: string;
-    stepId: string;
-}
-export interface AutomationTrigger {
-    id: string;
-    stepId: string;
-}

package/dist/documents/app/automation.js.map

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

package/dist/documents/app/datasource.d.ts

@@ -1,4 +0,0 @@
-import { Document } from "../document";
-export interface Datasource extends Document {
-    source: string;
-}

package/dist/documents/app/datasource.js.map

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

package/dist/documents/app/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/documents/app/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAqB;AACrB,+CAA4B;AAC5B,+CAA4B;AAC5B,2CAAwB;AACxB,0CAAuB;AACvB,yCAAsB;AACtB,0CAAuB;AACvB,2CAAwB;AACxB,yCAAsB;AACtB,8CAA2B;AAC3B,wCAAqB;AACrB,yCAAsB"}

package/dist/documents/app/row.d.ts

@@ -1,3 +0,0 @@
-import { Document } from "../document";
-export interface Row extends Document {
-}

package/dist/documents/app/row.js.map

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

package/dist/documents/app/screen.d.ts

@@ -1,8 +0,0 @@
-import { Document } from "../document";
-export interface Screen extends Document {
-    layoutId: string;
-    routing: {
-        route: string;
-        roleId: string;
-    };
-}

package/dist/documents/app/table.d.ts

@@ -1,7 +0,0 @@
-import { Document } from "../document";
-import { View } from "./view";
-export interface Table extends Document {
-    views: {
-        [key: string]: View;
-    };
-}

package/dist/documents/app/view.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"view.js","sourceRoot":"","sources":["../../../src/documents/app/view.ts"],"names":[],"mappings":";;;AAsCA,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,uCAAoB,CAAA;AACtB,CAAC,EAJW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAI1B"}