@budibase/types 2.8.22 → 2.8.23-alpha.0

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

@@ -1,3 +1,4 @@
+import { Account } from "../../documents";
 import { Hosting } from "../../sdk";
 export interface CreateAccountRequest {
     email: string;
@@ -9,3 +10,8 @@ export interface CreateAccountRequest {
     name?: string;
     password: string;
 }
+export interface SearchAccountsRequest {
+    email?: string;
+    tenantId?: string;
+}
+export declare type SearchAccountsResponse = Account[];

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

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

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

@@ -16,4 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./backup"), exports);
 __exportStar(require("./datasource"), exports);
+__exportStar(require("./view"), exports);
+__exportStar(require("./rows"), exports);
+__exportStar(require("./table"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/web/app/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,+CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/web/app/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,+CAA4B;AAC5B,yCAAsB;AACtB,yCAAsB;AACtB,0CAAuB"}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -18,6 +18,7 @@ __exportStar(require("./analytics"), exports);
 __exportStar(require("./auth"), exports);
 __exportStar(require("./user"), exports);
 __exportStar(require("./errors"), exports);
+__exportStar(require("./debug"), exports);
 __exportStar(require("./schedule"), exports);
 __exportStar(require("./system"), exports);
 __exportStar(require("./app"), exports);

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/web/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,yCAAsB;AACtB,yCAAsB;AACtB,2CAAwB;AACxB,6CAA0B;AAC1B,2CAAwB;AACxB,wCAAqB;AACrB,2CAAwB;AACxB,+CAA4B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/web/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,yCAAsB;AACtB,yCAAsB;AACtB,2CAAwB;AACxB,0CAAuB;AACvB,6CAA0B;AAC1B,2CAAwB;AACxB,wCAAqB;AACrB,2CAAwB;AACxB,+CAA4B"}

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

@@ -1,4 +1,5 @@
 import { User, Document } from "../";
+import { SocketSession } from "../../sdk";
 export declare 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/dist/cjs/documents/app/table/constants.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,3 +1,6 @@
+import { SortOrder, SortType } from "../../api";
+import { SearchFilters } from "../../sdk";
+import { UIFieldMetadata } from "./table";
 export interface View {
     name: string;
     tableId: string;
@@ -9,6 +12,19 @@ export interface View {
     reduce?: any;
     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 declare type ViewSchema = ViewCountOrSumSchema | ViewStatisticsSchema;
 export interface ViewCountOrSumSchema {
     field: string;

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

@@ -1 +1 @@
-{"version":3,"file":"view.js","sourceRoot":"","sources":["../../../../src/documents/app/view.ts"],"names":[],"mappings":";;;AAyCA,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,uCAAoB,CAAA;AACtB,CAAC,EAJW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAI1B"}
+{"version":3,"file":"view.js","sourceRoot":"","sources":["../../../../src/documents/app/view.ts"],"names":[],"mappings":";;;AA2DA,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,uCAAoB,CAAA;AACtB,CAAC,EAJW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAI1B"}

package/dist/cjs/sdk/db.d.ts

@@ -75,7 +75,7 @@ export interface Database {
     name: string;
     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): Promise<Nano.DocumentDestroyResponse>;
     put(document: AnyDocument, opts?: DatabasePutOpts): Promise<Nano.DocumentInsertResponse>;
     bulkDocs(documents: AnyDocument[]): Promise<Nano.DocumentBulkResponse[]>;

package/dist/cjs/sdk/search.d.ts

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