@budibase/types 2.11.20-alpha.0 → 2.11.22

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

@@ -1,4 +1,4 @@
-import { Table, TableRequest, TableSchema, View, ViewV2 } from "../../../documents";
+import { Row, Table, TableRequest, TableSchema, View, ViewV2 } from "../../../documents";
 interface ViewV2Response extends ViewV2 {
     schema: TableSchema;
 }
@@ -10,6 +10,11 @@ export interface TableResponse extends Table {
 }
 export type FetchTablesResponse = TableResponse[];
 export interface SaveTableRequest extends TableRequest {
+    rows?: Row[];
 }
 export type SaveTableResponse = Table;
+export interface BulkImportRequest {
+    rows: Row[];
+    identifierFields?: Array<string>;
+}
 export {};

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

@@ -7,7 +7,6 @@ export interface Datasource extends Document {
     source: SourceName;
     config?: Record<string, any>;
     plus?: boolean;
-    isSQL?: boolean;
     entities?: {
         [key: string]: Table;
     };

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

@@ -31,10 +31,12 @@ export interface Row extends Document {
     [key: string]: any;
 }
 export declare enum FieldSubtype {
-    USER = "user"
+    USER = "user",
+    USERS = "users"
 }
 export declare const FieldTypeSubtypes: {
     BB_REFERENCE: {
         USER: FieldSubtype;
+        USERS: FieldSubtype;
     };
 };

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

@@ -6,3 +6,14 @@ export declare enum RelationshipType {
 export declare enum AutoReason {
     FOREIGN_KEY = "foreign_key"
 }
+export declare enum AutoFieldSubTypes {
+    CREATED_BY = "createdBy",
+    CREATED_AT = "createdAt",
+    UPDATED_BY = "updatedBy",
+    UPDATED_AT = "updatedAt",
+    AUTO_ID = "autoID"
+}
+export declare enum FormulaTypes {
+    STATIC = "static",
+    DYNAMIC = "dynamic"
+}

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

@@ -1,43 +1,74 @@
-import { FieldType } from "../row";
-import { AutoReason, RelationshipType } from "./constants";
+import { FieldSubtype, FieldType } from "../row";
+import { AutoFieldSubTypes, AutoReason, FormulaTypes, RelationshipType } from "./constants";
 export interface UIFieldMetadata {
     order?: number;
     width?: number;
     visible?: boolean;
     icon?: string;
 }
-export interface RelationshipFieldMetadata {
+interface BaseRelationshipFieldMetadata extends Omit<BaseFieldSchema, "subtype"> {
+    type: FieldType.LINK;
     main?: boolean;
-    fieldName?: string;
-    tableId?: string;
-    relationshipType?: RelationshipType;
-    through?: string;
+    fieldName: string;
+    tableId: string;
+    subtype?: AutoFieldSubTypes.CREATED_BY | AutoFieldSubTypes.UPDATED_BY;
+}
+type ManyToManyJunctionTableMetadata = {
+    through: string;
+    throughFrom: string;
+    throughTo: string;
+} | {
+    through?: never;
+    throughFrom?: never;
+    throughTo?: never;
+};
+export type ManyToManyRelationshipFieldMetadata = BaseRelationshipFieldMetadata & {
+    relationshipType: RelationshipType.MANY_TO_MANY;
+} & ManyToManyJunctionTableMetadata;
+export interface OneToManyRelationshipFieldMetadata extends BaseRelationshipFieldMetadata {
+    relationshipType: RelationshipType.ONE_TO_MANY;
     foreignKey?: string;
-    throughFrom?: string;
-    throughTo?: string;
 }
-export interface AutoColumnFieldMetadata {
-    autocolumn?: boolean;
-    subtype?: string;
+export interface ManyToOneRelationshipFieldMetadata extends BaseRelationshipFieldMetadata {
+    relationshipType: RelationshipType.MANY_TO_ONE;
+    foreignKey?: string;
+}
+export type RelationshipFieldMetadata = ManyToManyRelationshipFieldMetadata | OneToManyRelationshipFieldMetadata | ManyToOneRelationshipFieldMetadata;
+export interface AutoColumnFieldMetadata extends Omit<BaseFieldSchema, "subtype"> {
+    type: FieldType.AUTO;
+    autocolumn: true;
+    subtype?: AutoFieldSubTypes;
     lastID?: number;
     autoReason?: AutoReason;
 }
-export interface NumberFieldMetadata {
+export interface NumberFieldMetadata extends Omit<BaseFieldSchema, "subtype"> {
+    type: FieldType.NUMBER;
+    subtype?: AutoFieldSubTypes.AUTO_ID;
+    lastID?: number;
+    autoReason?: AutoReason.FOREIGN_KEY;
     meta?: {
         toTable: string;
         toKey: string;
     };
 }
-export interface DateFieldMetadata {
+export interface DateFieldMetadata extends Omit<BaseFieldSchema, "subtype"> {
+    type: FieldType.DATETIME;
     ignoreTimezones?: boolean;
     timeOnly?: boolean;
+    subtype?: AutoFieldSubTypes.CREATED_AT | AutoFieldSubTypes.UPDATED_AT;
 }
-export interface StringFieldMetadata {
+export interface LongFormFieldMetadata extends BaseFieldSchema {
+    type: FieldType.LONGFORM;
     useRichText?: boolean | null;
 }
-export interface FormulaFieldMetadata {
-    formula?: string;
-    formulaType?: string;
+export interface FormulaFieldMetadata extends BaseFieldSchema {
+    type: FieldType.FORMULA;
+    formula: string;
+    formulaType?: FormulaTypes;
+}
+export interface BBReferenceFieldMetadata extends Omit<BaseFieldSchema, "subtype"> {
+    type: FieldType.BB_REFERENCE;
+    subtype: FieldSubtype.USER | FieldSubtype.USERS;
 }
 export interface FieldConstraints {
     type?: string;
@@ -59,13 +90,21 @@ export interface FieldConstraints {
         earliest: string;
     };
 }
-export interface FieldSchema extends UIFieldMetadata, DateFieldMetadata, RelationshipFieldMetadata, AutoColumnFieldMetadata, StringFieldMetadata, FormulaFieldMetadata, NumberFieldMetadata {
+interface BaseFieldSchema extends UIFieldMetadata {
     type: FieldType;
     name: string;
     sortable?: boolean;
     externalType?: string;
     constraints?: FieldConstraints;
+    autocolumn?: boolean;
+    autoReason?: AutoReason.FOREIGN_KEY;
+    subtype?: never;
+}
+interface OtherFieldMetadata extends BaseFieldSchema {
+    type: Exclude<FieldType, FieldType.DATETIME | FieldType.LINK | FieldType.AUTO | FieldType.FORMULA | FieldType.NUMBER | FieldType.LONGFORM>;
 }
+export type FieldSchema = OtherFieldMetadata | DateFieldMetadata | RelationshipFieldMetadata | AutoColumnFieldMetadata | FormulaFieldMetadata | NumberFieldMetadata | LongFormFieldMetadata | BBReferenceFieldMetadata;
 export interface TableSchema {
     [key: string]: FieldSchema;
 }
+export {};

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

@@ -18,9 +18,6 @@ export interface Table extends Document {
     indexes?: {
         [key: string]: any;
     };
-    rows?: {
-        [key: string]: any;
-    };
     created?: boolean;
     rowHeight?: number;
 }

package/dist/documents/document.d.ts

@@ -37,6 +37,9 @@ export declare enum DocumentType {
     AUDIT_LOG = "al"
 }
 export declare const DocumentTypesToImport: DocumentType[];
+export declare enum InternalTable {
+    USER_METADATA = "ta_users"
+}
 export declare enum VirtualDocumentType {
     VIEW = "view"
 }

package/dist/index.js

@@ -33,6 +33,7 @@ __export(src_exports, {
   AuditLogSystemUser: () => AuditLogSystemUser,
   AuditedEventFriendlyName: () => AuditedEventFriendlyName,
   AuthType: () => AuthType,
+  AutoFieldSubTypes: () => AutoFieldSubTypes,
   AutoReason: () => AutoReason,
   AutomationActionStepId: () => AutomationActionStepId,
   AutomationCustomIOType: () => AutomationCustomIOType,
@@ -61,11 +62,13 @@ __export(src_exports, {
   FieldType: () => FieldType,
   FieldTypeSubtypes: () => FieldTypeSubtypes,
   FilterType: () => FilterType,
+  FormulaTypes: () => FormulaTypes,
   GroupType: () => GroupType,
   Hosting: () => Hosting,
   IdentityType: () => IdentityType,
   IncludeRelationship: () => IncludeRelationship,
   InitType: () => InitType,
+  InternalTable: () => InternalTable,
   LockName: () => LockName,
   LockType: () => LockType,
   MigrationName: () => MigrationName,
@@ -868,6 +871,19 @@ var AutoReason = /* @__PURE__ */ ((AutoReason2) => {
   AutoReason2["FOREIGN_KEY"] = "foreign_key";
   return AutoReason2;
 })(AutoReason || {});
+var AutoFieldSubTypes = /* @__PURE__ */ ((AutoFieldSubTypes2) => {
+  AutoFieldSubTypes2["CREATED_BY"] = "createdBy";
+  AutoFieldSubTypes2["CREATED_AT"] = "createdAt";
+  AutoFieldSubTypes2["UPDATED_BY"] = "updatedBy";
+  AutoFieldSubTypes2["UPDATED_AT"] = "updatedAt";
+  AutoFieldSubTypes2["AUTO_ID"] = "autoID";
+  return AutoFieldSubTypes2;
+})(AutoFieldSubTypes || {});
+var FormulaTypes = /* @__PURE__ */ ((FormulaTypes2) => {
+  FormulaTypes2["STATIC"] = "static";
+  FormulaTypes2["DYNAMIC"] = "dynamic";
+  return FormulaTypes2;
+})(FormulaTypes || {});
 
 // src/documents/app/view.ts
 var ViewCalculation = /* @__PURE__ */ ((ViewCalculation2) => {
@@ -932,6 +948,10 @@ var DocumentTypesToImport = [
   "inst" /* INSTANCE */,
   "layout" /* LAYOUT */
 ];
+var InternalTable = /* @__PURE__ */ ((InternalTable2) => {
+  InternalTable2["USER_METADATA"] = "ta_users";
+  return InternalTable2;
+})(InternalTable || {});
 var VirtualDocumentType = /* @__PURE__ */ ((VirtualDocumentType2) => {
   VirtualDocumentType2["VIEW"] = "view";
   return VirtualDocumentType2;
@@ -959,11 +979,13 @@ var FieldType = /* @__PURE__ */ ((FieldType2) => {
 })(FieldType || {});
 var FieldSubtype = /* @__PURE__ */ ((FieldSubtype2) => {
   FieldSubtype2["USER"] = "user";
+  FieldSubtype2["USERS"] = "users";
   return FieldSubtype2;
 })(FieldSubtype || {});
 var FieldTypeSubtypes = {
   BB_REFERENCE: {
-    USER: "user" /* USER */
+    USER: "user" /* USER */,
+    USERS: "users" /* USERS */
   }
 };
 
@@ -1132,6 +1154,7 @@ var ServiceType = /* @__PURE__ */ ((ServiceType2) => {
   AuditLogSystemUser,
   AuditedEventFriendlyName,
   AuthType,
+  AutoFieldSubTypes,
   AutoReason,
   AutomationActionStepId,
   AutomationCustomIOType,
@@ -1160,11 +1183,13 @@ var ServiceType = /* @__PURE__ */ ((ServiceType2) => {
   FieldType,
   FieldTypeSubtypes,
   FilterType,
+  FormulaTypes,
   GroupType,
   Hosting,
   IdentityType,
   IncludeRelationship,
   InitType,
+  InternalTable,
   LockName,
   LockType,
   MigrationName,