@budibase/types 2.25.0 → 2.26.0

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

@@ -1,4 +1,4 @@
-import { FieldSchema, Row, Table, TableRequest, View, ViewV2Enriched } from "../../../documents";
+import { Row, Table, TableRequest, View, ViewV2Enriched } from "../../../documents";
 export type TableViewsResponse = {
     [key: string]: View | ViewV2Enriched;
 };
@@ -18,8 +18,8 @@ export interface BulkImportResponse {
     message: string;
 }
 export interface MigrateRequest {
-    oldColumn: FieldSchema;
-    newColumn: FieldSchema;
+    oldColumn: string;
+    newColumn: string;
 }
 export interface MigrateResponse {
     message: string;

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

@@ -99,13 +99,17 @@ export declare enum FieldType {
      */
     BIGINT = "bigint",
     /**
-     * a JSON type, called User within Budibase. This type is used to represent a link to an internal Budibase
+     * a JSON type, called Users within Budibase. It will hold an array of strings. This type is used to represent a link to an internal Budibase
      * resource, like a user or group, today only users are supported. This type will be represented as an
      * array of internal resource IDs (e.g. user IDs) within the row - this ID list will be enriched with
      * the full resources when rows are returned from the API. The full resources can be input to the API, or
      * an array of resource IDs, the API will squash these down and validate them before saving the row.
      */
-    BB_REFERENCE = "bb_reference"
+    BB_REFERENCE = "bb_reference",
+    /**
+     * a string type, called User within Budibase. Same logic as `bb_reference`, storing a single id as string instead of an array
+     */
+    BB_REFERENCE_SINGLE = "bb_reference_single"
 }
 export interface RowAttachment {
     size: number;

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

@@ -1,3 +1,4 @@
+import { FieldType } from "../row";
 export declare enum RelationshipType {
     ONE_TO_MANY = "one-to-many",
     MANY_TO_ONE = "many-to-one",
@@ -22,5 +23,7 @@ export declare enum FormulaType {
 }
 export declare enum BBReferenceFieldSubType {
     USER = "user",
+    /** @deprecated this should not be used anymore, left here in order to support the existing usages */
     USERS = "users"
 }
+export type SupportedSqlTypes = FieldType.STRING | FieldType.BARCODEQR | FieldType.LONGFORM | FieldType.OPTIONS | FieldType.DATETIME | FieldType.NUMBER | FieldType.BOOLEAN | FieldType.FORMULA | FieldType.BIGINT | FieldType.BB_REFERENCE | FieldType.BB_REFERENCE_SINGLE | FieldType.LINK | FieldType.ARRAY;

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

@@ -74,9 +74,13 @@ export interface FormulaFieldMetadata extends BaseFieldSchema {
 }
 export interface BBReferenceFieldMetadata extends Omit<BaseFieldSchema, "subtype"> {
     type: FieldType.BB_REFERENCE;
-    subtype: BBReferenceFieldSubType.USER | BBReferenceFieldSubType.USERS;
+    subtype: BBReferenceFieldSubType;
     relationshipType?: RelationshipType;
 }
+export interface BBReferenceSingleFieldMetadata extends Omit<BaseFieldSchema, "subtype"> {
+    type: FieldType.BB_REFERENCE_SINGLE;
+    subtype: Exclude<BBReferenceFieldSubType, BBReferenceFieldSubType.USERS>;
+}
 export interface AttachmentFieldMetadata extends BaseFieldSchema {
     type: FieldType.ATTACHMENTS;
 }
@@ -112,9 +116,9 @@ interface BaseFieldSchema extends UIFieldMetadata {
     subtype?: never;
 }
 interface OtherFieldMetadata extends BaseFieldSchema {
-    type: Exclude<FieldType, FieldType.DATETIME | FieldType.LINK | FieldType.AUTO | FieldType.FORMULA | FieldType.NUMBER | FieldType.LONGFORM | FieldType.BB_REFERENCE | FieldType.ATTACHMENTS>;
+    type: Exclude<FieldType, FieldType.DATETIME | FieldType.LINK | FieldType.AUTO | FieldType.FORMULA | FieldType.NUMBER | FieldType.LONGFORM | FieldType.BB_REFERENCE | FieldType.BB_REFERENCE_SINGLE | FieldType.ATTACHMENTS>;
 }
-export type FieldSchema = OtherFieldMetadata | DateFieldMetadata | RelationshipFieldMetadata | AutoColumnFieldMetadata | FormulaFieldMetadata | NumberFieldMetadata | LongFormFieldMetadata | BBReferenceFieldMetadata | JsonFieldMetadata | AttachmentFieldMetadata;
+export type FieldSchema = OtherFieldMetadata | DateFieldMetadata | RelationshipFieldMetadata | AutoColumnFieldMetadata | FormulaFieldMetadata | NumberFieldMetadata | LongFormFieldMetadata | BBReferenceFieldMetadata | JsonFieldMetadata | AttachmentFieldMetadata | BBReferenceSingleFieldMetadata;
 export interface TableSchema {
     [key: string]: FieldSchema;
 }
@@ -122,6 +126,4 @@ export declare function isRelationshipField(field: FieldSchema): field is Relati
 export declare function isManyToMany(field: RelationshipFieldMetadata): field is ManyToManyRelationshipFieldMetadata;
 export declare function isOneToMany(field: RelationshipFieldMetadata): field is OneToManyRelationshipFieldMetadata;
 export declare function isManyToOne(field: RelationshipFieldMetadata): field is ManyToOneRelationshipFieldMetadata;
-export declare function isBBReferenceField(field: FieldSchema): field is BBReferenceFieldMetadata;
-export declare function isAttachmentField(field: FieldSchema): field is AttachmentFieldMetadata;
 export {};

package/dist/index.js

@@ -118,8 +118,6 @@ __export(src_exports, {
   VirtualDocumentType: () => VirtualDocumentType,
   WebhookActionType: () => WebhookActionType,
   isAppBackupMetadata: () => isAppBackupMetadata,
-  isAttachmentField: () => isAttachmentField,
-  isBBReferenceField: () => isBBReferenceField,
   isCloudAccount: () => isCloudAccount,
   isConstantQuota: () => isConstantQuota,
   isCreatePasswordAccount: () => isCreatePasswordAccount,
@@ -954,6 +952,7 @@ var FieldType = /* @__PURE__ */ ((FieldType2) => {
   FieldType2["BARCODEQR"] = "barcodeqr";
   FieldType2["BIGINT"] = "bigint";
   FieldType2["BB_REFERENCE"] = "bb_reference";
+  FieldType2["BB_REFERENCE_SINGLE"] = "bb_reference_single";
   return FieldType2;
 })(FieldType || {});
 
@@ -1004,12 +1003,6 @@ function isOneToMany(field) {
 function isManyToOne(field) {
   return field.relationshipType === "many-to-one" /* MANY_TO_ONE */;
 }
-function isBBReferenceField(field) {
-  return field.type === "bb_reference" /* BB_REFERENCE */;
-}
-function isAttachmentField(field) {
-  return field.type === "attachment" /* ATTACHMENTS */;
-}
 
 // src/documents/app/view.ts
 var ViewCalculation = /* @__PURE__ */ ((ViewCalculation2) => {
@@ -1349,8 +1342,6 @@ var MaintenanceType = /* @__PURE__ */ ((MaintenanceType2) => {
   VirtualDocumentType,
   WebhookActionType,
   isAppBackupMetadata,
-  isAttachmentField,
-  isBBReferenceField,
   isCloudAccount,
   isConstantQuota,
   isCreatePasswordAccount,