@budibase/types 2.8.31 → 2.8.32-alpha.0

package/package.json

@@ -1,22 +1,23 @@
 {
   "name": "@budibase/types",
-  "version": "2.8.31",
+  "version": "2.8.32-alpha.0",
   "description": "Budibase types",
-  "main": "dist/cjs/index.js",
-  "types": "dist/mjs/index.d.ts",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
   "exports": {
     ".": {
-      "import": "./dist/mjs/index.js",
-      "require": "./dist/cjs/index.js"
+      "import": "./dist/index.js",
+      "require": "./src/index.ts"
     }
   },
   "author": "Budibase",
   "license": "GPL-3.0",
   "scripts": {
     "prebuild": "rimraf dist/",
-    "build": "tsc -p tsconfig.build.json && tsc -p tsconfig-cjs.build.json",
+    "build": "tsc -p tsconfig.build.json",
     "build:dev": "yarn prebuild && tsc --build --watch --preserveWatchOutput",
-    "dev:builder": "yarn prebuild && concurrently \"tsc -p tsconfig.build.json --watch\" \"tsc -p tsconfig-cjs.build.json --watch\""
+    "dev:builder": "yarn prebuild && tsc -p tsconfig.json --watch --preserveWatchOutput",
+    "check:types": "tsc -p tsconfig.json --noEmit --paths null"
   },
   "jest": {},
   "devDependencies": {
@@ -34,5 +35,5 @@
   "dependencies": {
     "scim-patch": "^0.7.0"
   },
-  "gitHead": "4613b17c1e76328bf279998c821a17195fbaab37"
+  "gitHead": "d004c83e8892505e19d9a06b85167a9f79f127fe"
 }

package/src/api/account/accounts.ts

@@ -1,3 +1,4 @@
+import { Account } from "../../documents"
 import { Hosting } from "../../sdk"
 
 export interface CreateAccountRequest {
@@ -11,3 +12,11 @@ export interface CreateAccountRequest {
   name?: string
   password: string
 }
+
+export interface SearchAccountsRequest {
+  // one or the other - not both
+  email?: string
+  tenantId?: string
+}
+
+export type SearchAccountsResponse = Account[]

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

@@ -1,2 +1,6 @@
 export * from "./backup"
 export * from "./datasource"
+export * from "./row"
+export * from "./view"
+export * from "./rows"
+export * from "./table"

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

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

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

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

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

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

package/src/api/web/index.ts

@@ -2,6 +2,7 @@ export * from "./analytics"
 export * from "./auth"
 export * from "./user"
 export * from "./errors"
+export * from "./debug"
 export * from "./schedule"
 export * from "./system"
 export * from "./app"

package/src/core/index.ts

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

package/src/core/installation.ts

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

package/src/documents/app/app.ts

@@ -1,4 +1,5 @@
 import { User, Document } from "../"
+import { SocketSession } from "../../sdk"
 
 export type AppMetadataErrors = { [key: string]: string[] }
 
@@ -17,6 +18,7 @@ export interface App extends Document {
   customTheme?: AppCustomTheme
   revertableVersion?: string
   lockedBy?: User
+  sessions?: SocketSession[]
   navigation?: AppNavigation
   automationErrors?: AppMetadataErrors
   icon?: AppIcon

package/src/documents/app/row.ts

@@ -30,5 +30,6 @@ export interface RowAttachment {
 export interface Row extends Document {
   type?: string
   tableId?: string
+  _viewId?: string
   [key: string]: any
 }

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

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

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

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

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

@@ -0,0 +1,30 @@
+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/documents/app/view.ts

@@ -1,3 +1,7 @@
+import { SortOrder, SortType } from "../../api"
+import { SearchFilters } from "../../sdk"
+import { TableSchema, UIFieldMetadata } from "./table"
+
 export interface View {
   name: string
   tableId: string
@@ -10,6 +14,22 @@ export interface View {
   meta?: Record<string, any>
 }
 
+export interface ViewV2 {
+  version: 2
+  id: string
+  name: string
+  primaryDisplay?: string
+  tableId: string
+  query?: SearchFilters
+  sort?: {
+    field: string
+    order?: SortOrder
+    type?: SortType
+  }
+  columns?: string[]
+  schemaUI?: Record<string, UIFieldMetadata>
+}
+
 export type ViewSchema = ViewCountOrSumSchema | ViewStatisticsSchema
 
 export interface ViewCountOrSumSchema {

package/src/documents/document.ts

@@ -1,3 +1,44 @@
+export const SEPARATOR = "_"
+export const UNICODE_MAX = "\ufff0"
+
+export const prefixed = (type: DocumentType) => `${type}${SEPARATOR}`
+
+export enum DocumentType {
+  USER = "us",
+  GROUP = "gr",
+  WORKSPACE = "workspace",
+  CONFIG = "config",
+  TEMPLATE = "template",
+  APP = "app",
+  DEV = "dev",
+  APP_DEV = "app_dev",
+  APP_METADATA = "app_metadata",
+  ROLE = "role",
+  MIGRATIONS = "migrations",
+  DEV_INFO = "devinfo",
+  AUTOMATION_LOG = "log_au",
+  ACCOUNT_METADATA = "acc_metadata",
+  PLUGIN = "plg",
+  DATASOURCE = "datasource",
+  DATASOURCE_PLUS = "datasource_plus",
+  APP_BACKUP = "backup",
+  TABLE = "ta",
+  ROW = "ro",
+  AUTOMATION = "au",
+  LINK = "li",
+  WEBHOOK = "wh",
+  INSTANCE = "inst",
+  LAYOUT = "layout",
+  SCREEN = "screen",
+  QUERY = "query",
+  DEPLOYMENTS = "deployments",
+  METADATA = "metadata",
+  MEM_VIEW = "view",
+  USER_FLAG = "flag",
+  AUTOMATION_METADATA = "meta_au",
+  AUDIT_LOG = "al",
+}
+
 export interface Document {
   _id?: string
   _rev?: string

package/src/documents/global/user.ts

@@ -42,7 +42,8 @@ export interface User extends Document {
   forceResetPassword?: boolean
   roles: UserRoles
   builder?: {
-    global: boolean
+    global?: boolean
+    apps?: string[]
   }
   admin?: {
     global: boolean
@@ -69,7 +70,8 @@ export interface UserRoles {
 
 export interface BuilderUser extends User {
   builder: {
-    global: boolean
+    global?: boolean
+    apps?: string[]
   }
 }
 
@@ -82,6 +84,12 @@ 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,3 +1,5 @@
 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 | any>
+  get<T>(id?: string): Promise<T>
   remove(
     id: string | Document,
     rev?: string

package/src/sdk/index.ts

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

package/src/sdk/koa.ts

@@ -38,6 +38,7 @@ 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,6 +9,7 @@ export enum Feature {
   BRANDING = "branding",
   SCIM = "scim",
   SYNC_AUTOMATIONS = "syncAutomations",
+  APP_BUILDERS = "appBuilders",
   OFFLINE = "offline",
 }
 

package/src/sdk/permissions.ts

@@ -0,0 +1,19 @@
+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",
+}

package/src/sdk/search.ts

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

package/src/shared/typeUtils.ts

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

package/tsconfig.build.json

@@ -1,8 +1,18 @@
 {
-  "extends": "./tsconfig-base.build.json",
   "compilerOptions": {
     "target": "es6",
     "moduleResolution": "node",
-    "outDir": "dist/mjs"
-  }
+    "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"]
 }

package/tsconfig.json

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

package/dist/cjs/api/account/accounts.d.ts

@@ -1,11 +0,0 @@
-import { Hosting } from "../../sdk";
-export interface CreateAccountRequest {
-    email: string;
-    tenantId: string;
-    hosting: Hosting;
-    size: string;
-    profession: string;
-    tenantName?: string;
-    name?: string;
-    password: string;
-}

package/dist/cjs/api/account/accounts.js

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

package/dist/cjs/api/account/accounts.js.map

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

package/dist/cjs/api/account/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./accounts";
-export * from "./user";
-export * from "./license";
-export * from "./status";

package/dist/cjs/api/account/index.js

@@ -1,21 +0,0 @@
-"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("./accounts"), exports);
-__exportStar(require("./user"), exports);
-__exportStar(require("./license"), exports);
-__exportStar(require("./status"), exports);
-//# sourceMappingURL=index.js.map

package/dist/cjs/api/account/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/account/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA0B;AAC1B,yCAAsB;AACtB,4CAAyB;AACzB,2CAAwB"}

package/dist/cjs/api/account/license.d.ts

@@ -1,31 +0,0 @@
-import { LicenseOverrides, QuotaUsage } from "../../documents";
-import { OfflineLicense, PlanType } from "../../sdk";
-import { ISO8601 } from "../../shared";
-export interface GetLicenseRequest {
-    quotaUsage?: QuotaUsage;
-    install: {
-        id: string;
-        tenantId: string;
-        version: string;
-    };
-}
-export interface QuotaTriggeredRequest {
-    percentage: number;
-    name: string;
-    resetDate?: string;
-}
-export interface LicenseActivateRequest {
-    installVersion?: string;
-}
-export interface UpdateLicenseRequest {
-    planType?: PlanType;
-    overrides?: LicenseOverrides;
-}
-export interface CreateOfflineLicenseRequest {
-    installationIdentifierBase64: string;
-    expireAt: ISO8601;
-}
-export interface GetOfflineLicenseResponse {
-    offlineLicenseToken: string;
-    license: OfflineLicense;
-}

package/dist/cjs/api/account/license.js

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

package/dist/cjs/api/account/license.js.map

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

package/dist/cjs/api/account/status.d.ts

@@ -1,7 +0,0 @@
-export interface HealthStatusResponse {
-    passing: boolean;
-    checks: {
-        login: boolean;
-        search: boolean;
-    };
-}

package/dist/cjs/api/account/status.js

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

package/dist/cjs/api/account/status.js.map

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