@budibase/types 2.12.1 → 2.12.2

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

@@ -0,0 +1,8 @@
+export interface Upload {
+    size: number;
+    name: string;
+    url: string;
+    extension: string;
+    key: string;
+}
+export type ProcessAttachmentResponse = Upload[];

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

@@ -16,3 +16,7 @@ export interface CreateAppBackupResponse {
 export interface UpdateAppBackupRequest {
     name: string;
 }
+export interface ImportAppBackupResponse {
+    restoreId: string;
+    message: string;
+}

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

@@ -5,3 +5,4 @@ export * from "./view";
 export * from "./rows";
 export * from "./table";
 export * from "./permission";
+export * from "./attachment";

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

@@ -1,4 +1,4 @@
-import { Row, Table, TableRequest, TableSchema, View, ViewV2 } from "../../../documents";
+import { FieldSchema, Row, Table, TableRequest, TableSchema, View, ViewV2 } from "../../../documents";
 interface ViewV2Response extends ViewV2 {
     schema: TableSchema;
 }
@@ -20,4 +20,11 @@ export interface BulkImportRequest {
 export interface BulkImportResponse {
     message: string;
 }
+export interface MigrateRequest {
+    oldColumn: FieldSchema;
+    newColumn: FieldSchema;
+}
+export interface MigrateResponse {
+    message: string;
+}
 export {};

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

@@ -107,4 +107,9 @@ export type FieldSchema = OtherFieldMetadata | DateFieldMetadata | RelationshipF
 export interface TableSchema {
     [key: string]: FieldSchema;
 }
+export declare function isRelationshipField(field: FieldSchema): field is RelationshipFieldMetadata;
+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 {};

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

@@ -2,16 +2,22 @@ import { Document } from "../../document";
 import { View, ViewV2 } from "../view";
 import { RenameColumn } from "../../../sdk";
 import { TableSchema } from "./schema";
+export declare const INTERNAL_TABLE_SOURCE_ID = "bb_internal";
+export declare enum TableSourceType {
+    EXTERNAL = "external",
+    INTERNAL = "internal"
+}
 export interface Table extends Document {
-    type?: string;
+    type: "table";
+    sourceType: TableSourceType;
     views?: {
         [key: string]: View | ViewV2;
     };
     name: string;
+    sourceId: string;
     primary?: string[];
     schema: TableSchema;
     primaryDisplay?: string;
-    sourceId?: string;
     relatedFormula?: string[];
     constrained?: string[];
     sql?: boolean;
@@ -21,9 +27,6 @@ export interface Table extends Document {
     created?: boolean;
     rowHeight?: number;
 }
-export interface ExternalTable extends Table {
-    sourceId: string;
-}
 export interface TableRequest extends Table {
     _rename?: RenameColumn;
     created?: boolean;

package/dist/index.js

@@ -65,6 +65,7 @@ __export(src_exports, {
   FormulaTypes: () => FormulaTypes,
   GroupType: () => GroupType,
   Hosting: () => Hosting,
+  INTERNAL_TABLE_SOURCE_ID: () => INTERNAL_TABLE_SOURCE_ID,
   IdentityType: () => IdentityType,
   IncludeRelationship: () => IncludeRelationship,
   InitType: () => InitType,
@@ -104,6 +105,7 @@ __export(src_exports, {
   SortType: () => SortType,
   SourceName: () => SourceName,
   StaticQuotaName: () => StaticQuotaName,
+  TableSourceType: () => TableSourceType,
   TenantResolutionStrategy: () => TenantResolutionStrategy,
   UNICODE_MAX: () => UNICODE_MAX,
   UserGroupSyncEvents: () => UserGroupSyncEvents,
@@ -112,14 +114,19 @@ __export(src_exports, {
   VirtualDocumentType: () => VirtualDocumentType,
   WebhookActionType: () => WebhookActionType,
   isAppBackupMetadata: () => isAppBackupMetadata,
+  isBBReferenceField: () => isBBReferenceField,
   isCloudAccount: () => isCloudAccount,
   isConstantQuota: () => isConstantQuota,
   isCreatePasswordAccount: () => isCreatePasswordAccount,
   isDocument: () => isDocument,
   isGoogleConfig: () => isGoogleConfig,
+  isManyToMany: () => isManyToMany,
+  isManyToOne: () => isManyToOne,
   isMonthlyQuota: () => isMonthlyQuota,
   isOIDCConfig: () => isOIDCConfig,
+  isOneToMany: () => isOneToMany,
   isPasswordAccount: () => isPasswordAccount,
+  isRelationshipField: () => isRelationshipField,
   isSCIMConfig: () => isSCIMConfig,
   isSMTPConfig: () => isSMTPConfig,
   isSSOAccount: () => isSSOAccount,
@@ -866,6 +873,46 @@ var RestAuthType = /* @__PURE__ */ ((RestAuthType2) => {
   return RestAuthType2;
 })(RestAuthType || {});
 
+// src/documents/app/table/table.ts
+var INTERNAL_TABLE_SOURCE_ID = "bb_internal";
+var TableSourceType = /* @__PURE__ */ ((TableSourceType2) => {
+  TableSourceType2["EXTERNAL"] = "external";
+  TableSourceType2["INTERNAL"] = "internal";
+  return TableSourceType2;
+})(TableSourceType || {});
+
+// src/documents/app/row.ts
+var FieldType = /* @__PURE__ */ ((FieldType2) => {
+  FieldType2["STRING"] = "string";
+  FieldType2["LONGFORM"] = "longform";
+  FieldType2["OPTIONS"] = "options";
+  FieldType2["NUMBER"] = "number";
+  FieldType2["BOOLEAN"] = "boolean";
+  FieldType2["ARRAY"] = "array";
+  FieldType2["DATETIME"] = "datetime";
+  FieldType2["ATTACHMENT"] = "attachment";
+  FieldType2["LINK"] = "link";
+  FieldType2["FORMULA"] = "formula";
+  FieldType2["AUTO"] = "auto";
+  FieldType2["JSON"] = "json";
+  FieldType2["INTERNAL"] = "internal";
+  FieldType2["BARCODEQR"] = "barcodeqr";
+  FieldType2["BIGINT"] = "bigint";
+  FieldType2["BB_REFERENCE"] = "bb_reference";
+  return FieldType2;
+})(FieldType || {});
+var FieldSubtype = /* @__PURE__ */ ((FieldSubtype3) => {
+  FieldSubtype3["USER"] = "user";
+  FieldSubtype3["USERS"] = "users";
+  return FieldSubtype3;
+})(FieldSubtype || {});
+var FieldTypeSubtypes = {
+  BB_REFERENCE: {
+    USER: "user" /* USER */,
+    USERS: "users" /* USERS */
+  }
+};
+
 // src/documents/app/table/constants.ts
 var RelationshipType = /* @__PURE__ */ ((RelationshipType2) => {
   RelationshipType2["ONE_TO_MANY"] = "one-to-many";
@@ -873,24 +920,41 @@ var RelationshipType = /* @__PURE__ */ ((RelationshipType2) => {
   RelationshipType2["MANY_TO_MANY"] = "many-to-many";
   return RelationshipType2;
 })(RelationshipType || {});
-var AutoReason = /* @__PURE__ */ ((AutoReason2) => {
-  AutoReason2["FOREIGN_KEY"] = "foreign_key";
-  return AutoReason2;
+var AutoReason = /* @__PURE__ */ ((AutoReason3) => {
+  AutoReason3["FOREIGN_KEY"] = "foreign_key";
+  return AutoReason3;
 })(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;
+var AutoFieldSubTypes = /* @__PURE__ */ ((AutoFieldSubTypes3) => {
+  AutoFieldSubTypes3["CREATED_BY"] = "createdBy";
+  AutoFieldSubTypes3["CREATED_AT"] = "createdAt";
+  AutoFieldSubTypes3["UPDATED_BY"] = "updatedBy";
+  AutoFieldSubTypes3["UPDATED_AT"] = "updatedAt";
+  AutoFieldSubTypes3["AUTO_ID"] = "autoID";
+  return AutoFieldSubTypes3;
 })(AutoFieldSubTypes || {});
-var FormulaTypes = /* @__PURE__ */ ((FormulaTypes2) => {
-  FormulaTypes2["STATIC"] = "static";
-  FormulaTypes2["DYNAMIC"] = "dynamic";
-  return FormulaTypes2;
+var FormulaTypes = /* @__PURE__ */ ((FormulaTypes3) => {
+  FormulaTypes3["STATIC"] = "static";
+  FormulaTypes3["DYNAMIC"] = "dynamic";
+  return FormulaTypes3;
 })(FormulaTypes || {});
 
+// src/documents/app/table/schema.ts
+function isRelationshipField(field) {
+  return field.type === "link" /* LINK */;
+}
+function isManyToMany(field) {
+  return field.relationshipType === "many-to-many" /* MANY_TO_MANY */;
+}
+function isOneToMany(field) {
+  return field.relationshipType === "one-to-many" /* ONE_TO_MANY */;
+}
+function isManyToOne(field) {
+  return field.relationshipType === "many-to-one" /* MANY_TO_ONE */;
+}
+function isBBReferenceField(field) {
+  return field.type === "bb_reference" /* BB_REFERENCE */;
+}
+
 // src/documents/app/view.ts
 var ViewCalculation = /* @__PURE__ */ ((ViewCalculation2) => {
   ViewCalculation2["SUM"] = "sum";
@@ -963,38 +1027,6 @@ var VirtualDocumentType = /* @__PURE__ */ ((VirtualDocumentType2) => {
   return VirtualDocumentType2;
 })(VirtualDocumentType || {});
 
-// src/documents/app/row.ts
-var FieldType = /* @__PURE__ */ ((FieldType2) => {
-  FieldType2["STRING"] = "string";
-  FieldType2["LONGFORM"] = "longform";
-  FieldType2["OPTIONS"] = "options";
-  FieldType2["NUMBER"] = "number";
-  FieldType2["BOOLEAN"] = "boolean";
-  FieldType2["ARRAY"] = "array";
-  FieldType2["DATETIME"] = "datetime";
-  FieldType2["ATTACHMENT"] = "attachment";
-  FieldType2["LINK"] = "link";
-  FieldType2["FORMULA"] = "formula";
-  FieldType2["AUTO"] = "auto";
-  FieldType2["JSON"] = "json";
-  FieldType2["INTERNAL"] = "internal";
-  FieldType2["BARCODEQR"] = "barcodeqr";
-  FieldType2["BIGINT"] = "bigint";
-  FieldType2["BB_REFERENCE"] = "bb_reference";
-  return FieldType2;
-})(FieldType || {});
-var FieldSubtype = /* @__PURE__ */ ((FieldSubtype2) => {
-  FieldSubtype2["USER"] = "user";
-  FieldSubtype2["USERS"] = "users";
-  return FieldSubtype2;
-})(FieldSubtype || {});
-var FieldTypeSubtypes = {
-  BB_REFERENCE: {
-    USER: "user" /* USER */,
-    USERS: "users" /* USERS */
-  }
-};
-
 // src/documents/app/backup.ts
 var AppBackupType = /* @__PURE__ */ ((AppBackupType2) => {
   AppBackupType2["BACKUP"] = "backup";
@@ -1208,6 +1240,7 @@ var ServiceType = /* @__PURE__ */ ((ServiceType2) => {
   FormulaTypes,
   GroupType,
   Hosting,
+  INTERNAL_TABLE_SOURCE_ID,
   IdentityType,
   IncludeRelationship,
   InitType,
@@ -1247,6 +1280,7 @@ var ServiceType = /* @__PURE__ */ ((ServiceType2) => {
   SortType,
   SourceName,
   StaticQuotaName,
+  TableSourceType,
   TenantResolutionStrategy,
   UNICODE_MAX,
   UserGroupSyncEvents,
@@ -1255,14 +1289,19 @@ var ServiceType = /* @__PURE__ */ ((ServiceType2) => {
   VirtualDocumentType,
   WebhookActionType,
   isAppBackupMetadata,
+  isBBReferenceField,
   isCloudAccount,
   isConstantQuota,
   isCreatePasswordAccount,
   isDocument,
   isGoogleConfig,
+  isManyToMany,
+  isManyToOne,
   isMonthlyQuota,
   isOIDCConfig,
+  isOneToMany,
   isPasswordAccount,
+  isRelationshipField,
   isSCIMConfig,
   isSMTPConfig,
   isSSOAccount,