@budibase/types 2.1.39 → 2.1.40-alpha.0

package/src/documents/app/table.ts

@@ -1,5 +1,6 @@
 import { Document } from "../document"
 import { View } from "./view"
+import { RenameColumn } from "../../sdk"
 
 export interface FieldSchema {
   // TODO: replace with field types enum when done
@@ -7,10 +8,12 @@ export interface FieldSchema {
   externalType?: string
   fieldName?: string
   name: string
+  sortable?: boolean
   tableId?: string
   relationshipType?: string
   through?: string
   foreignKey?: string
+  icon?: string
   autocolumn?: boolean
   subtype?: string
   throughFrom?: string
@@ -19,6 +22,9 @@ export interface FieldSchema {
   formulaType?: string
   main?: boolean
   ignoreTimezones?: boolean
+  timeOnly?: boolean
+  lastID?: number
+  useRichText?: boolean | null
   meta?: {
     toTable: string
     toKey: string
@@ -28,10 +34,22 @@ export interface FieldSchema {
     email?: boolean
     inclusion?: string[]
     length?: {
-      minimum?: string | number
-      maximum?: string | number
+      minimum?: string | number | null
+      maximum?: string | number | null
+    }
+    numericality?: {
+      greaterThanOrEqualTo: string | null
+      lessThanOrEqualTo: string | null
+    }
+    presence?:
+      | boolean
+      | {
+          allowEmpty?: boolean
+        }
+    datetime?: {
+      latest: string
+      earliest: string
     }
-    presence?: boolean
   }
 }
 
@@ -53,3 +71,8 @@ export interface Table extends Document {
   indexes?: { [key: string]: any }
   dataImport?: { [key: string]: any }
 }
+
+export interface TableRequest extends Table {
+  _rename?: RenameColumn
+  created?: boolean
+}

package/src/documents/app/view.ts

@@ -5,6 +5,9 @@ export interface View {
   filters: ViewFilter[]
   schema: ViewSchema
   calculation?: ViewCalculation
+  map?: string
+  reduce?: any
+  meta?: Record<string, any>
 }
 
 export type ViewSchema = ViewCountOrSumSchema | ViewStatisticsSchema
@@ -30,7 +33,7 @@ export interface ViewStatisticsSchema {
 }
 
 export interface ViewFilter {
-  value: any
+  value?: any
   condition: string
   key: string
   conjunction?: string

package/src/documents/document.ts

@@ -4,3 +4,7 @@ export interface Document {
   createdAt?: string | number
   updatedAt?: string
 }
+
+export interface AnyDocument extends Document {
+  [key: string]: any
+}

package/src/documents/global/config.ts

@@ -31,17 +31,29 @@ export interface GoogleConfig extends Config {
   }
 }
 
+export interface OIDCConfiguration {
+  issuer: string
+  authorizationURL: string
+  tokenURL: string
+  userInfoURL: string
+  clientID: string
+  clientSecret: string
+  callbackURL: string
+}
+
+export interface OIDCInnerCfg {
+  configUrl: string
+  clientID: string
+  clientSecret: string
+  logo: string
+  name: string
+  uuid: string
+  activated: boolean
+}
+
 export interface OIDCConfig extends Config {
   config: {
-    configs: {
-      configUrl: string
-      clientID: string
-      clientSecret: string
-      logo: string
-      name: string
-      uuid: string
-      activated: boolean
-    }[]
+    configs: OIDCInnerCfg[]
   }
 }
 
@@ -62,7 +74,9 @@ export const isOIDCConfig = (config: Config): config is OIDCConfig =>
 
 export enum ConfigType {
   SETTINGS = "settings",
+  ACCOUNT = "account",
   SMTP = "smtp",
   GOOGLE = "google",
   OIDC = "oidc",
+  OIDC_LOGOS = "logos_oidc",
 }

package/src/documents/global/index.ts

@@ -4,3 +4,4 @@ export * from "./userGroup"
 export * from "./plugin"
 export * from "./quotas"
 export * from "./schedule"
+export * from "./templates"

package/src/documents/global/templates.ts

@@ -0,0 +1,9 @@
+import { Document } from "../document"
+
+export interface Template extends Document {
+  ownerId?: string
+  name?: string
+  contents: string
+  purpose: string
+  type?: string
+}

package/src/documents/global/user.ts

@@ -1,8 +1,37 @@
 import { Document } from "../document"
 
-export interface User extends Document {
+export interface SSOProfile {
+  id: string
+  name?: {
+    givenName?: string
+    familyName?: string
+  }
+  _json: {
+    email: string
+    picture: string
+  }
+  provider?: string
+}
+
+export interface ThirdPartyUser extends Document {
+  thirdPartyProfile?: SSOProfile["_json"]
+  firstName?: string
+  lastName?: string
+  pictureUrl?: string
+  profile?: SSOProfile
+  oauth2?: any
+  provider?: string
+  providerType?: string
+  email: string
+  userId?: string
+  forceResetPassword?: boolean
+}
+
+export interface User extends ThirdPartyUser {
   tenantId: string
   email: string
+  userId?: string
+  forceResetPassword?: boolean
   roles: UserRoles
   builder?: {
     global: boolean
@@ -10,13 +39,14 @@ export interface User extends Document {
   admin?: {
     global: boolean
   }
-  providerType?: string
   password?: string
   status?: string
   createdAt?: number // override the default createdAt behaviour - users sdk historically set this to Date.now()
   userGroups?: string[]
-  forceResetPassword?: boolean
   dayPassRecordedAt?: string
+  account?: {
+    authType: string
+  }
 }
 
 export interface UserRoles {

package/src/documents/platform/index.ts

@@ -1,3 +1,4 @@
 export * from "./info"
 export * from "./users"
 export * from "./accounts"
+export * from "./tenants"

package/src/documents/platform/tenants.ts

@@ -0,0 +1,5 @@
+import { Document } from "../document"
+
+export interface Tenants extends Document {
+  tenantIds: string[]
+}

package/src/documents/pouch.ts

@@ -7,8 +7,8 @@ export interface RowResponse<T> {
   id: string
   key: string
   error: string
-  value: RowValue
-  doc: T
+  value: T | RowValue
+  doc?: T | any
 }
 
 export interface AllDocsResponse<T> {
@@ -24,3 +24,9 @@ interface BulkDocResponse {
   id: string
   rev: string
 }
+
+export interface PutResponse {
+  ok: boolean
+  id: string
+  rev: string
+}

package/src/sdk/auth.ts

@@ -1,3 +1,6 @@
+import { BBContext } from "./koa"
+import { Hosting } from "./hosting"
+
 export interface AuthToken {
   userId: string
   tenantId: string
@@ -8,6 +11,7 @@ export interface CreateSession {
   sessionId: string
   tenantId: string
   csrfToken?: string
+  hosting?: Hosting
 }
 
 export interface Session extends CreateSession {
@@ -25,3 +29,9 @@ export interface SessionKey {
 export interface ScannedSession {
   value: Session
 }
+
+export interface PlatformLogoutOpts {
+  ctx: BBContext
+  userId: string
+  keepActiveSession?: boolean
+}

package/src/sdk/context.ts

@@ -1,5 +1,5 @@
 import { User, Account } from "../documents"
-import { IdentityType } from "./events/identification"
+import { IdentityType } from "./events"
 
 export interface BaseContext {
   _id: string

package/src/sdk/db.ts

@@ -1,10 +1,12 @@
 import PouchDB from "pouchdb"
+import Nano from "nano"
+import { AllDocsResponse, AnyDocument, Document } from "../"
 
 export type PouchOptions = {
-  inMemory: boolean
-  replication: boolean
-  onDisk: boolean
-  find: boolean
+  inMemory?: boolean
+  replication?: boolean
+  onDisk?: boolean
+  find?: boolean
 }
 
 export enum SortOption {
@@ -22,3 +24,73 @@ export type CouchFindOptions = {
   skip?: number
   bookmark?: string
 }
+
+export type DatabaseOpts = {
+  skip_setup?: boolean
+}
+
+export type DatabasePutOpts = {
+  force?: boolean
+}
+
+export type DatabaseCreateIndexOpts = {
+  index: {
+    fields: string[]
+    name?: string | undefined
+    ddoc?: string | undefined
+    type?: string | undefined
+  }
+}
+
+export type DatabaseDeleteIndexOpts = {
+  name: string
+  ddoc: string
+  type?: string | undefined
+}
+
+export type DatabaseQueryOpts = {
+  include_docs?: boolean
+  startkey?: string
+  endkey?: string
+  limit?: number
+  skip?: number
+  descending?: boolean
+  key?: string
+  keys?: string[]
+  group?: boolean
+}
+
+export const isDocument = (doc: any): doc is Document => {
+  return typeof doc === "object" && doc._id && doc._rev
+}
+
+export interface Database {
+  name: string
+
+  exists(): Promise<boolean>
+  checkSetup(): Promise<Nano.DocumentScope<any>>
+  get<T>(id?: string): Promise<T | any>
+  remove(
+    id: string | Document,
+    rev?: string
+  ): Promise<Nano.DocumentDestroyResponse>
+  put(
+    document: AnyDocument,
+    opts?: DatabasePutOpts
+  ): Promise<Nano.DocumentInsertResponse>
+  bulkDocs(documents: AnyDocument[]): Promise<Nano.DocumentBulkResponse[]>
+  allDocs<T>(params: DatabaseQueryOpts): Promise<AllDocsResponse<T>>
+  query<T>(
+    viewName: string,
+    params: DatabaseQueryOpts
+  ): Promise<AllDocsResponse<T>>
+  destroy(): Promise<Nano.OkResponse | void>
+  compact(): Promise<Nano.OkResponse | void>
+  // these are all PouchDB related functions that are rarely used - in future
+  // should be replaced by better typed/non-pouch implemented methods
+  dump(...args: any[]): Promise<any>
+  load(...args: any[]): Promise<any>
+  createIndex(...args: any[]): Promise<any>
+  deleteIndex(...args: any[]): Promise<any>
+  getIndexes(...args: any[]): Promise<any>
+}

package/src/sdk/events/role.ts

@@ -3,19 +3,19 @@ import { BaseEvent } from "./event"
 export interface RoleCreatedEvent extends BaseEvent {
   roleId: string
   permissionId: string
-  inherits: string
+  inherits?: string
 }
 
 export interface RoleUpdatedEvent extends BaseEvent {
   roleId: string
   permissionId: string
-  inherits: string
+  inherits?: string
 }
 
 export interface RoleDeletedEvent extends BaseEvent {
   roleId: string
   permissionId: string
-  inherits: string
+  inherits?: string
 }
 
 export interface RoleAssignedEvent extends BaseEvent {

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

@@ -9,3 +9,5 @@ export * from "./koa"
 export * from "./auth"
 export * from "./locks"
 export * from "./db"
+export * from "./middleware"
+export * from "./featureFlag"

package/src/sdk/koa.ts

@@ -1,14 +1,23 @@
 import { Context, Request } from "koa"
-import { User } from "../documents"
-import { License } from "../sdk"
+import { User, Role, UserRoles, Account } from "../documents"
+import { FeatureFlag, License } from "../sdk"
 
-export interface ContextUser extends User {
+export interface ContextUser extends Omit<User, "roles"> {
   globalId?: string
-  license: License
+  license?: License
+  userId?: string
+  roleId?: string | null
+  role?: Role
+  roles?: UserRoles
+  csrfToken?: string
+  featureFlags?: FeatureFlag[]
+  accountPortalAccess?: boolean
+  account?: Account
 }
 
 export interface BBRequest extends Request {
   body: any
+  files?: any
 }
 
 export interface BBContext extends Context {

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/search.ts

@@ -72,7 +72,7 @@ export interface QueryJson {
     operation: Operation
     schema?: string
   }
-  resource: {
+  resource?: {
     fields: string[]
   }
   filters?: SearchFilters
@@ -83,7 +83,7 @@ export interface QueryJson {
   meta?: {
     table?: Table
     tables?: Record<string, Table>
-    renamed: RenameColumn
+    renamed?: RenameColumn
   }
   extra?: {
     idFilter?: SearchFilters

package/tsconfig.build.json

@@ -3,7 +3,6 @@
     "target": "es6",
     "module": "commonjs",
     "lib": ["es2020"],
-    "allowJs": true,
     "strict": true,
     "noImplicitAny": true,
     "esModuleInterop": true,