@budibase/types 2.8.28-alpha.1 → 2.8.28

package/src/documents/app/table.ts

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

package/src/documents/app/view.ts

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

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/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/dist/cjs/api/web/app/row.d.ts

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

package/dist/cjs/api/web/app/row.js

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

package/dist/cjs/api/web/app/row.js.map

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

package/dist/cjs/api/web/app/rows.d.ts

@@ -1,3 +0,0 @@
-export interface SearchResponse {
-    rows: any[];
-}

package/dist/cjs/api/web/app/rows.js

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

package/dist/cjs/api/web/app/rows.js.map

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

package/dist/cjs/api/web/app/table.d.ts

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

package/dist/cjs/api/web/app/table.js

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

package/dist/cjs/api/web/app/table.js.map

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

package/dist/cjs/api/web/app/view.d.ts

@@ -1,6 +0,0 @@
-import { ViewV2 } from "../../../documents";
-export interface ViewResponse {
-    data: ViewV2;
-}
-export declare type CreateViewRequest = Omit<ViewV2, "version" | "id">;
-export declare type UpdateViewRequest = ViewV2;

package/dist/cjs/api/web/app/view.js

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

package/dist/cjs/api/web/app/view.js.map

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

package/dist/cjs/api/web/debug.d.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/dist/cjs/api/web/debug.js

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

package/dist/cjs/api/web/debug.js.map

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

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

@@ -1,8 +0,0 @@
-export declare enum RelationshipType {
-    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"
-}

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

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../../src/documents/app/table/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,+CAA2B,CAAA;IAC3B,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAI3B;AAED,IAAY,UAEX;AAFD,WAAY,UAAU;IACpB,yCAA2B,CAAA;AAC7B,CAAC,EAFW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAErB"}

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

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

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

@@ -1,20 +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("./table"), exports);
-__exportStar(require("./schema"), exports);
-__exportStar(require("./constants"), exports);
-//# sourceMappingURL=index.js.map

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

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

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

@@ -1,71 +0,0 @@
-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;
-    relationshipType?: RelationshipType;
-    through?: string;
-    foreignKey?: string;
-    throughFrom?: string;
-    throughTo?: string;
-}
-export interface AutoColumnFieldMetadata {
-    autocolumn?: boolean;
-    subtype?: string;
-    lastID?: number;
-    autoReason?: AutoReason;
-}
-export interface NumberFieldMetadata {
-    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;
-    externalType?: string;
-    constraints?: FieldConstraints;
-}
-export interface TableSchema {
-    [key: string]: FieldSchema;
-}

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

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

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

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

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

@@ -1,33 +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/dist/cjs/documents/app/table/table.js

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

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

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

package/dist/mjs/api/web/app/row.d.ts

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

package/dist/mjs/api/web/app/row.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=row.js.map

package/dist/mjs/api/web/app/row.js.map

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

package/dist/mjs/api/web/app/rows.d.ts

@@ -1,3 +0,0 @@
-export interface SearchResponse {
-    rows: any[];
-}

package/dist/mjs/api/web/app/rows.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=rows.js.map

package/dist/mjs/api/web/app/rows.js.map

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

package/dist/mjs/api/web/app/table.d.ts

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

package/dist/mjs/api/web/app/table.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=table.js.map

package/dist/mjs/api/web/app/table.js.map

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

package/dist/mjs/api/web/app/view.d.ts

@@ -1,6 +0,0 @@
-import { ViewV2 } from "../../../documents";
-export interface ViewResponse {
-    data: ViewV2;
-}
-export declare type CreateViewRequest = Omit<ViewV2, "version" | "id">;
-export declare type UpdateViewRequest = ViewV2;

package/dist/mjs/api/web/app/view.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=view.js.map

package/dist/mjs/api/web/app/view.js.map

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

package/dist/mjs/api/web/debug.d.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/dist/mjs/api/web/debug.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=debug.js.map

package/dist/mjs/api/web/debug.js.map

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

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

@@ -1,8 +0,0 @@
-export declare enum RelationshipType {
-    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"
-}

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

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../../src/documents/app/table/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,+CAA2B,CAAA;IAC3B,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B;AAED,MAAM,CAAN,IAAY,UAEX;AAFD,WAAY,UAAU;IACpB,yCAA2B,CAAA;AAC7B,CAAC,EAFW,UAAU,KAAV,UAAU,QAErB"}

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

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

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

@@ -1,4 +0,0 @@
-export * from "./table";
-export * from "./schema";
-export * from "./constants";
-//# sourceMappingURL=index.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/documents/app/table/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA"}

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

@@ -1,71 +0,0 @@
-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;
-    relationshipType?: RelationshipType;
-    through?: string;
-    foreignKey?: string;
-    throughFrom?: string;
-    throughTo?: string;
-}
-export interface AutoColumnFieldMetadata {
-    autocolumn?: boolean;
-    subtype?: string;
-    lastID?: number;
-    autoReason?: AutoReason;
-}
-export interface NumberFieldMetadata {
-    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;
-    externalType?: string;
-    constraints?: FieldConstraints;
-}
-export interface TableSchema {
-    [key: string]: FieldSchema;
-}

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

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=schema.js.map

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

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