@budibase/types 2.8.21 → 2.8.22-alpha.0

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 } from "../view"
+import { RenameColumn } from "../../../sdk"
+import { TableSchema } from "./schema"
+
+export interface Table extends Document {
+  type?: string
+  views?: { [key: string]: View }
+  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/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/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/dist/cjs/documents/app/table.d.ts

@@ -1,94 +0,0 @@
-import { Document } from "../document";
-import { View } from "./view";
-import { RenameColumn } from "../../sdk";
-import { FieldType } from "./row";
-export declare enum RelationshipTypes {
-    ONE_TO_MANY = "one-to-many",
-    MANY_TO_ONE = "many-to-one",
-    MANY_TO_MANY = "many-to-many"
-}
-export declare enum AutoReason {
-    FOREIGN_KEY = "foreign_key"
-}
-export interface FieldSchema {
-    type: FieldType;
-    externalType?: string;
-    fieldName?: string;
-    name: string;
-    sortable?: boolean;
-    tableId?: string;
-    relationshipType?: RelationshipTypes;
-    through?: string;
-    foreignKey?: string;
-    icon?: string;
-    autocolumn?: boolean;
-    autoReason?: AutoReason;
-    subtype?: string;
-    throughFrom?: string;
-    throughTo?: string;
-    formula?: string;
-    formulaType?: string;
-    main?: boolean;
-    ignoreTimezones?: boolean;
-    timeOnly?: boolean;
-    lastID?: number;
-    useRichText?: boolean | null;
-    order?: number;
-    width?: number;
-    meta?: {
-        toTable: string;
-        toKey: string;
-    };
-    constraints?: {
-        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 TableSchema {
-    [key: string]: FieldSchema;
-}
-export interface Table extends Document {
-    type?: string;
-    views?: {
-        [key: string]: View;
-    };
-    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/dist/cjs/documents/app/table.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AutoReason = exports.RelationshipTypes = void 0;
-var RelationshipTypes;
-(function (RelationshipTypes) {
-    RelationshipTypes["ONE_TO_MANY"] = "one-to-many";
-    RelationshipTypes["MANY_TO_ONE"] = "many-to-one";
-    RelationshipTypes["MANY_TO_MANY"] = "many-to-many";
-})(RelationshipTypes = exports.RelationshipTypes || (exports.RelationshipTypes = {}));
-var AutoReason;
-(function (AutoReason) {
-    AutoReason["FOREIGN_KEY"] = "foreign_key";
-})(AutoReason = exports.AutoReason || (exports.AutoReason = {}));
-//# sourceMappingURL=table.js.map

package/dist/cjs/documents/app/table.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"table.js","sourceRoot":"","sources":["../../../../src/documents/app/table.ts"],"names":[],"mappings":";;;AAKA,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,gDAA2B,CAAA;IAC3B,gDAA2B,CAAA;IAC3B,kDAA6B,CAAA;AAC/B,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B;AAED,IAAY,UAEX;AAFD,WAAY,UAAU;IACpB,yCAA2B,CAAA;AAC7B,CAAC,EAFW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAErB"}

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

@@ -1,94 +0,0 @@
-import { Document } from "../document";
-import { View } from "./view";
-import { RenameColumn } from "../../sdk";
-import { FieldType } from "./row";
-export declare enum RelationshipTypes {
-    ONE_TO_MANY = "one-to-many",
-    MANY_TO_ONE = "many-to-one",
-    MANY_TO_MANY = "many-to-many"
-}
-export declare enum AutoReason {
-    FOREIGN_KEY = "foreign_key"
-}
-export interface FieldSchema {
-    type: FieldType;
-    externalType?: string;
-    fieldName?: string;
-    name: string;
-    sortable?: boolean;
-    tableId?: string;
-    relationshipType?: RelationshipTypes;
-    through?: string;
-    foreignKey?: string;
-    icon?: string;
-    autocolumn?: boolean;
-    autoReason?: AutoReason;
-    subtype?: string;
-    throughFrom?: string;
-    throughTo?: string;
-    formula?: string;
-    formulaType?: string;
-    main?: boolean;
-    ignoreTimezones?: boolean;
-    timeOnly?: boolean;
-    lastID?: number;
-    useRichText?: boolean | null;
-    order?: number;
-    width?: number;
-    meta?: {
-        toTable: string;
-        toKey: string;
-    };
-    constraints?: {
-        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 TableSchema {
-    [key: string]: FieldSchema;
-}
-export interface Table extends Document {
-    type?: string;
-    views?: {
-        [key: string]: View;
-    };
-    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/dist/mjs/documents/app/table.js

@@ -1,11 +0,0 @@
-export var RelationshipTypes;
-(function (RelationshipTypes) {
-    RelationshipTypes["ONE_TO_MANY"] = "one-to-many";
-    RelationshipTypes["MANY_TO_ONE"] = "many-to-one";
-    RelationshipTypes["MANY_TO_MANY"] = "many-to-many";
-})(RelationshipTypes || (RelationshipTypes = {}));
-export var AutoReason;
-(function (AutoReason) {
-    AutoReason["FOREIGN_KEY"] = "foreign_key";
-})(AutoReason || (AutoReason = {}));
-//# sourceMappingURL=table.js.map

package/dist/mjs/documents/app/table.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"table.js","sourceRoot":"","sources":["../../../../src/documents/app/table.ts"],"names":[],"mappings":"AAKA,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,gDAA2B,CAAA;IAC3B,gDAA2B,CAAA;IAC3B,kDAA6B,CAAA;AAC/B,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AAED,MAAM,CAAN,IAAY,UAEX;AAFD,WAAY,UAAU;IACpB,yCAA2B,CAAA;AAC7B,CAAC,EAFW,UAAU,KAAV,UAAU,QAErB"}

package/src/documents/app/table.ts

@@ -1,97 +0,0 @@
-import { Document } from "../document"
-import { View } from "./view"
-import { RenameColumn } from "../../sdk"
-import { FieldType } from "./row"
-
-export enum RelationshipTypes {
-  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",
-}
-
-export interface FieldSchema {
-  type: FieldType
-  externalType?: string
-  fieldName?: string
-  name: string
-  sortable?: boolean
-  tableId?: string
-  relationshipType?: RelationshipTypes
-  through?: string
-  foreignKey?: string
-  icon?: string
-  autocolumn?: boolean
-  autoReason?: AutoReason
-  subtype?: string
-  throughFrom?: string
-  throughTo?: string
-  formula?: string
-  formulaType?: string
-  main?: boolean
-  ignoreTimezones?: boolean
-  timeOnly?: boolean
-  lastID?: number
-  useRichText?: boolean | null
-  order?: number
-  width?: number
-  meta?: {
-    toTable: string
-    toKey: string
-  }
-  constraints?: {
-    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 TableSchema {
-  [key: string]: FieldSchema
-}
-
-export interface Table extends Document {
-  type?: string
-  views?: { [key: string]: View }
-  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
-}