@budibase/types 2.8.31-alpha.0 → 2.8.31

package/src/documents/global/user.ts

@@ -42,8 +42,7 @@ export interface User extends Document {
   forceResetPassword?: boolean
   roles: UserRoles
   builder?: {
-    global?: boolean
-    apps?: string[]
+    global: boolean
   }
   admin?: {
     global: boolean
@@ -70,8 +69,7 @@ export interface UserRoles {
 
 export interface BuilderUser extends User {
   builder: {
-    global?: boolean
-    apps?: string[]
+    global: boolean
   }
 }
 
@@ -84,12 +82,6 @@ export interface AdminUser extends User {
   }
 }
 
-export interface AdminOnlyUser extends User {
-  admin: {
-    global: boolean
-  }
-}
-
 export function isUser(user: object): user is User {
   return !!(user as User).roles
 }

package/src/index.ts

@@ -1,5 +1,3 @@
 export * from "./documents"
 export * from "./sdk"
 export * from "./api"
-export * from "./core"
-export * from "./shared"

package/src/sdk/db.ts

@@ -89,7 +89,7 @@ export interface Database {
 
   exists(): Promise<boolean>
   checkSetup(): Promise<Nano.DocumentScope<any>>
-  get<T>(id?: string): Promise<T>
+  get<T>(id?: string): Promise<T | any>
   remove(
     id: string | Document,
     rev?: string

package/src/sdk/index.ts

@@ -18,4 +18,3 @@ export * from "./sso"
 export * from "./user"
 export * from "./cli"
 export * from "./websocket"
-export * from "./permissions"

package/src/sdk/koa.ts

@@ -38,7 +38,6 @@ export interface Ctx<RequestBody = any, ResponseBody = any> extends Context {
 export interface UserCtx<RequestBody = any, ResponseBody = any>
   extends Ctx<RequestBody, ResponseBody> {
   user: ContextUser
-  roleId?: string
 }
 
 /**

package/src/sdk/licensing/feature.ts

@@ -9,7 +9,6 @@ export enum Feature {
   BRANDING = "branding",
   SCIM = "scim",
   SYNC_AUTOMATIONS = "syncAutomations",
-  APP_BUILDERS = "appBuilders",
   OFFLINE = "offline",
 }
 

package/src/sdk/search.ts

@@ -32,7 +32,7 @@ export interface SearchFilters {
     [key: string]: any[]
   }
   contains?: {
-    [key: string]: any[] | any
+    [key: string]: any[]
   }
   notContains?: {
     [key: string]: any[]

package/src/shared/typeUtils.ts

@@ -3,7 +3,3 @@ export type DeepPartial<T> = {
 }
 
 export type ISO8601 = string
-
-export type RequiredKeys<T> = {
-  [K in keyof Required<T>]: T[K]
-}

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,18 +1,8 @@
 {
+  "extends": "./tsconfig-base.build.json",
   "compilerOptions": {
     "target": "es6",
     "moduleResolution": "node",
-    "lib": ["es2020"],
-    "strict": true,
-    "noImplicitAny": true,
-    "esModuleInterop": true,
-    "resolveJsonModule": true,
-    "incremental": true,
-    "sourceMap": true,
-    "declaration": true,
-    "skipLibCheck": true,
-    "outDir": "dist"
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist", "**/*.spec.ts", "**/*.spec.js"]
+    "outDir": "dist/mjs"
+  }
 }

package/tsconfig.json

@@ -1,10 +1,10 @@
 {
   "extends": "./tsconfig.build.json",
   "compilerOptions": {
-    "baseUrl": ".",
-    "rootDir": "./src",
-    "composite": true,
-    "tsBuildInfoFile": "dist/tsconfig.tsbuildinfo"
+    "composite": true
   },
-  "exclude": ["node_modules", "dist"]
-}
+  "exclude": [
+    "node_modules",
+    "dist"
+  ]
+}

package/src/api/web/app/row.ts

@@ -1,11 +0,0 @@
-import { Row } from "../../../documents/app/row"
-
-export interface DeleteRows {
-  rows: (Row | string)[]
-}
-
-export interface DeleteRow {
-  _id: string
-}
-
-export type DeleteRowRequest = DeleteRows | DeleteRow

package/src/api/web/app/rows.ts

@@ -1,13 +0,0 @@
-import { Row } from "../../../documents"
-
-export interface PatchRowRequest extends Row {
-  _id: string
-  _rev: string
-  tableId: string
-}
-
-export interface PatchRowResponse extends Row {}
-
-export interface SearchResponse {
-  rows: any[]
-}

package/src/api/web/app/table.ts

@@ -1,13 +0,0 @@
-import { Table, TableSchema, View, ViewV2 } from "../../../documents"
-
-interface ViewV2Response extends ViewV2 {
-  schema: TableSchema
-}
-
-export type TableViewsResponse = { [key: string]: View | ViewV2Response }
-
-export interface TableResponse extends Table {
-  views?: TableViewsResponse
-}
-
-export type FetchTablesResponse = TableResponse[]

package/src/api/web/app/view.ts

@@ -1,15 +0,0 @@
-import { ViewV2, UIFieldMetadata } from "../../../documents"
-
-export interface ViewResponse {
-  data: ViewV2
-}
-
-export interface CreateViewRequest
-  extends Omit<ViewV2, "version" | "id" | "columns" | "schemaUI"> {
-  schema?: Record<string, UIFieldMetadata>
-}
-
-export interface UpdateViewRequest
-  extends Omit<ViewV2, "columns" | "schemaUI"> {
-  schema?: Record<string, UIFieldMetadata>
-}

package/src/api/web/debug.ts

@@ -1,11 +0,0 @@
-export interface GetDiagnosticsResponse {
-  budibaseVersion: string
-  hosting: string
-  nodeVersion: string
-  platform: string
-  cpuArch: string
-  cpuCores: number
-  cpuInfo: string
-  totalMemory: string
-  uptime: string
-}

package/src/core/index.ts

@@ -1 +0,0 @@
-export * from "./installation"

package/src/core/installation.ts

@@ -1,4 +0,0 @@
-export enum ServiceType {
-  WORKER = "worker",
-  APPS = "apps",
-}

package/src/documents/app/table/constants.ts

@@ -1,9 +0,0 @@
-export enum RelationshipType {
-  ONE_TO_MANY = "one-to-many",
-  MANY_TO_ONE = "many-to-one",
-  MANY_TO_MANY = "many-to-many",
-}
-
-export enum AutoReason {
-  FOREIGN_KEY = "foreign_key",
-}

package/src/documents/app/table/index.ts

@@ -1,3 +0,0 @@
-export * from "./table"
-export * from "./schema"
-export * from "./constants"

package/src/documents/app/table/schema.ts

@@ -1,98 +0,0 @@
-// all added by grid/table when defining the
-// column size, position and whether it can be viewed
-import { FieldType } from "../row"
-import { AutoReason, RelationshipType } from "./constants"
-
-export interface UIFieldMetadata {
-  order?: number
-  width?: number
-  visible?: boolean
-  icon?: string
-}
-
-export interface RelationshipFieldMetadata {
-  main?: boolean
-  fieldName?: string
-  tableId?: string
-  // below is used for SQL relationships, needed to define the foreign keys
-  // or the tables used for many-to-many relationships (through)
-  relationshipType?: RelationshipType
-  through?: string
-  foreignKey?: string
-  throughFrom?: string
-  throughTo?: string
-}
-
-export interface AutoColumnFieldMetadata {
-  autocolumn?: boolean
-  subtype?: string
-  lastID?: number
-  // if the column was turned to an auto-column for SQL, explains why (primary, foreign etc)
-  autoReason?: AutoReason
-}
-
-export interface NumberFieldMetadata {
-  // used specifically when Budibase generates external tables, this denotes if a number field
-  // is a foreign key used for a many-to-many relationship
-  meta?: {
-    toTable: string
-    toKey: string
-  }
-}
-
-export interface DateFieldMetadata {
-  ignoreTimezones?: boolean
-  timeOnly?: boolean
-}
-
-export interface StringFieldMetadata {
-  useRichText?: boolean | null
-}
-
-export interface FormulaFieldMetadata {
-  formula?: string
-  formulaType?: string
-}
-
-export interface FieldConstraints {
-  type?: string
-  email?: boolean
-  inclusion?: string[]
-  length?: {
-    minimum?: string | number | null
-    maximum?: string | number | null
-  }
-  numericality?: {
-    greaterThanOrEqualTo: string | null
-    lessThanOrEqualTo: string | null
-  }
-  presence?:
-    | boolean
-    | {
-        allowEmpty?: boolean
-      }
-  datetime?: {
-    latest: string
-    earliest: string
-  }
-}
-
-export interface FieldSchema
-  extends UIFieldMetadata,
-    DateFieldMetadata,
-    RelationshipFieldMetadata,
-    AutoColumnFieldMetadata,
-    StringFieldMetadata,
-    FormulaFieldMetadata,
-    NumberFieldMetadata {
-  type: FieldType
-  name: string
-  sortable?: boolean
-  // only used by external databases, to denote the real type
-  externalType?: string
-  constraints?: FieldConstraints
-}
-
-export interface TableSchema {
-  [key: string]: FieldSchema
-}

package/src/documents/app/table/table.ts

@@ -1,30 +0,0 @@
-import { Document } from "../../document"
-import { View, ViewV2 } from "../view"
-import { RenameColumn } from "../../../sdk"
-import { TableSchema } from "./schema"
-
-export interface Table extends Document {
-  type?: string
-  views?: { [key: string]: View | ViewV2 }
-  name: string
-  primary?: string[]
-  schema: TableSchema
-  primaryDisplay?: string
-  sourceId?: string
-  relatedFormula?: string[]
-  constrained?: string[]
-  sql?: boolean
-  indexes?: { [key: string]: any }
-  rows?: { [key: string]: any }
-  created?: boolean
-  rowHeight?: number
-}
-
-export interface ExternalTable extends Table {
-  sourceId: string
-}
-
-export interface TableRequest extends Table {
-  _rename?: RenameColumn
-  created?: boolean
-}

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",
-}