@budibase/types 2.33.1 → 2.33.3

package/dist/api/web/role.d.ts

@@ -1,11 +1,13 @@
 import { Role, RoleUIMetadata } from "../../documents";
+import { PermissionLevel } from "../../sdk";
 export interface SaveRoleRequest {
     _id?: string;
     _rev?: string;
     name: string;
-    inherits: string;
+    inherits?: string | string[];
     permissionId: string;
-    version: string;
+    permissions?: Record<string, PermissionLevel[]>;
+    version?: string;
     uiMetadata?: RoleUIMetadata;
 }
 export interface SaveRoleResponse extends Role {

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

@@ -27,6 +27,7 @@ export interface App extends Document {
     usedPlugins?: Plugin[];
     upgradableVersion?: string;
     snippets?: Snippet[];
+    creationVersion?: string;
 }
 export interface AppInstance {
     _id: string;

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

@@ -222,6 +222,7 @@ export type UpdatedRowEventEmitter = {
     oldRow: Row;
     table: Table;
     appId: string;
+    user: User;
 };
 export declare enum LoopStepType {
     ARRAY = "Array",

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

@@ -7,7 +7,7 @@ export interface RoleUIMetadata {
 }
 export interface Role extends Document {
     permissionId: string;
-    inherits?: string;
+    inherits?: string | string[];
     permissions: Record<string, PermissionLevel[]>;
     version?: string;
     name: string;

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

@@ -75,6 +75,13 @@ export declare enum FieldType {
      * that is part of the initial formula definition, the formula will be live evaluated in the browser.
      */
     AUTO = "auto",
+    /**
+     * A complex type, called an AI column within Budibase. This type is only supported against internal tables
+     * and calculates the output based on a chosen operation (summarise text, translation etc) which passes to
+     * the configured Budibase Large Language Model to retrieve the output and write it back into the row.
+     * AI fields function in a similar fashion to static formulas, and possess many of the same characteristics.
+     */
+    AI = "ai",
     /**
      * a JSON type, called JSON within Budibase. This type allows any arbitrary JSON to be input to this column
      * type, which will be represented as a JSON object in the row. This type depends on a schema being

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

@@ -20,7 +20,8 @@ export declare enum JsonFieldSubType {
 }
 export declare enum FormulaType {
     STATIC = "static",
-    DYNAMIC = "dynamic"
+    DYNAMIC = "dynamic",
+    AI = "ai"
 }
 export declare enum BBReferenceFieldSubType {
     USER = "user",

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

@@ -1,5 +1,6 @@
 import { FieldType } from "../row";
 import { AutoFieldSubType, AutoReason, BBReferenceFieldSubType, FormulaType, JsonFieldSubType, RelationshipType } from "./constants";
+import { AIOperationEnum } from "../../../sdk/ai";
 export interface UIFieldMetadata {
     order?: number;
     width?: number;
@@ -80,6 +81,15 @@ export interface FormulaFieldMetadata extends BaseFieldSchema {
     formula: string;
     formulaType?: FormulaType;
 }
+export interface AIFieldMetadata extends BaseFieldSchema {
+    type: FieldType.AI;
+    operation: AIOperationEnum;
+    columns?: string[];
+    column?: string;
+    categories?: string[];
+    prompt?: string;
+    language?: string;
+}
 export interface BBReferenceFieldMetadata extends Omit<BaseFieldSchema, "subtype"> {
     type: FieldType.BB_REFERENCE;
     subtype: BBReferenceFieldSubType;
@@ -141,9 +151,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.BB_REFERENCE_SINGLE | FieldType.ATTACHMENTS | FieldType.STRING | FieldType.ARRAY | FieldType.OPTIONS>;
+    type: Exclude<FieldType, FieldType.DATETIME | FieldType.LINK | FieldType.AUTO | FieldType.FORMULA | FieldType.AI | FieldType.NUMBER | FieldType.LONGFORM | FieldType.BB_REFERENCE | FieldType.BB_REFERENCE_SINGLE | FieldType.ATTACHMENTS | FieldType.STRING | FieldType.ARRAY | FieldType.OPTIONS>;
 }
-export type FieldSchema = OtherFieldMetadata | DateFieldMetadata | RelationshipFieldMetadata | AutoColumnFieldMetadata | FormulaFieldMetadata | NumberFieldMetadata | LongFormFieldMetadata | StringFieldMetadata | BBReferenceFieldMetadata | JsonFieldMetadata | AttachmentFieldMetadata | BBReferenceSingleFieldMetadata | ArrayFieldMetadata | OptionsFieldMetadata;
+export type FieldSchema = OtherFieldMetadata | DateFieldMetadata | RelationshipFieldMetadata | AutoColumnFieldMetadata | FormulaFieldMetadata | AIFieldMetadata | NumberFieldMetadata | LongFormFieldMetadata | StringFieldMetadata | BBReferenceFieldMetadata | JsonFieldMetadata | AttachmentFieldMetadata | BBReferenceSingleFieldMetadata | ArrayFieldMetadata | OptionsFieldMetadata;
 export interface TableSchema {
     [key: string]: FieldSchema;
 }

package/dist/documents/global/user.d.ts

@@ -56,6 +56,15 @@ export interface User extends Document {
     ssoId?: string;
     appSort?: string;
 }
+export interface UserBindings extends Document {
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    status?: string;
+    roleId?: string | null;
+    globalId?: string;
+    userId?: string;
+}
 export declare enum UserStatus {
     ACTIVE = "active",
     INACTIVE = "inactive"

package/dist/index.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  AIOperationEnum: () => AIOperationEnum,
   APP_QUOTA_NAMES: () => APP_QUOTA_NAMES,
   AUDIT_LOG_TYPE: () => AUDIT_LOG_TYPE,
   AccountSSOProvider: () => AccountSSOProvider,
@@ -86,6 +87,7 @@ __export(src_exports, {
   LockName: () => LockName,
   LockType: () => LockType,
   LogicalOperator: () => LogicalOperator,
+  LoginMethod: () => LoginMethod,
   LoopStepType: () => LoopStepType,
   MaintenanceType: () => MaintenanceType,
   MigrationName: () => MigrationName,
@@ -93,6 +95,7 @@ __export(src_exports, {
   MonthlyQuotaName: () => MonthlyQuotaName,
   NumericTypes: () => NumericTypes,
   Operation: () => Operation,
+  OperationFieldTypeEnum: () => OperationFieldTypeEnum,
   PASSWORD_REPLACEMENT: () => PASSWORD_REPLACEMENT,
   PLUGIN_TYPE_ARR: () => PLUGIN_TYPE_ARR,
   PermissionLevel: () => PermissionLevel,
@@ -166,6 +169,24 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
+// src/sdk/ai.ts
+var AIOperationEnum = /* @__PURE__ */ ((AIOperationEnum2) => {
+  AIOperationEnum2["SUMMARISE_TEXT"] = "SUMMARISE_TEXT";
+  AIOperationEnum2["CLEAN_DATA"] = "CLEAN_DATA";
+  AIOperationEnum2["TRANSLATE"] = "TRANSLATE";
+  AIOperationEnum2["CATEGORISE_TEXT"] = "CATEGORISE_TEXT";
+  AIOperationEnum2["SENTIMENT_ANALYSIS"] = "SENTIMENT_ANALYSIS";
+  AIOperationEnum2["PROMPT"] = "PROMPT";
+  AIOperationEnum2["SEARCH_WEB"] = "SEARCH_WEB";
+  return AIOperationEnum2;
+})(AIOperationEnum || {});
+var OperationFieldTypeEnum = /* @__PURE__ */ ((OperationFieldTypeEnum2) => {
+  OperationFieldTypeEnum2["MULTI_COLUMN"] = "columns";
+  OperationFieldTypeEnum2["COLUMN"] = "column";
+  OperationFieldTypeEnum2["BINDABLE_TEXT"] = "prompt";
+  return OperationFieldTypeEnum2;
+})(OperationFieldTypeEnum || {});
+
 // src/sdk/hosting.ts
 var Hosting = /* @__PURE__ */ ((Hosting2) => {
   Hosting2["CLOUD"] = "cloud";
@@ -744,6 +765,13 @@ var SqlClient = /* @__PURE__ */ ((SqlClient2) => {
   return SqlClient2;
 })(SqlClient || {});
 
+// src/sdk/koa.ts
+var LoginMethod = /* @__PURE__ */ ((LoginMethod2) => {
+  LoginMethod2["API_KEY"] = "api_key";
+  LoginMethod2["COOKIE"] = "cookie";
+  return LoginMethod2;
+})(LoginMethod || {});
+
 // src/sdk/locks.ts
 var LockType = /* @__PURE__ */ ((LockType2) => {
   LockType2["TRY_ONCE"] = "try_once";
@@ -796,9 +824,13 @@ var TenantResolutionStrategy = /* @__PURE__ */ ((TenantResolutionStrategy2) => {
 var FeatureFlag = /* @__PURE__ */ ((FeatureFlag2) => {
   FeatureFlag2["PER_CREATOR_PER_USER_PRICE"] = "PER_CREATOR_PER_USER_PRICE";
   FeatureFlag2["PER_CREATOR_PER_USER_PRICE_ALERT"] = "PER_CREATOR_PER_USER_PRICE_ALERT";
+  FeatureFlag2["AUTOMATION_BRANCHING"] = "AUTOMATION_BRANCHING";
+  FeatureFlag2["SQS"] = "SQS";
   FeatureFlag2["AI_CUSTOM_CONFIGS"] = "AI_CUSTOM_CONFIGS";
+  FeatureFlag2["DEFAULT_VALUES"] = "DEFAULT_VALUES";
   FeatureFlag2["ENRICHED_RELATIONSHIPS"] = "ENRICHED_RELATIONSHIPS";
   FeatureFlag2["TABLES_DEFAULT_ADMIN"] = "TABLES_DEFAULT_ADMIN";
+  FeatureFlag2["BUDIBASE_AI"] = "BUDIBASE_AI";
   return FeatureFlag2;
 })(FeatureFlag || {});
 
@@ -1059,6 +1091,7 @@ var FieldType = /* @__PURE__ */ ((FieldType2) => {
   FieldType2["LINK"] = "link";
   FieldType2["FORMULA"] = "formula";
   FieldType2["AUTO"] = "auto";
+  FieldType2["AI"] = "ai";
   FieldType2["JSON"] = "json";
   FieldType2["INTERNAL"] = "internal";
   FieldType2["BARCODEQR"] = "barcodeqr";
@@ -1119,6 +1152,7 @@ var JsonFieldSubType = /* @__PURE__ */ ((JsonFieldSubType3) => {
 var FormulaType = /* @__PURE__ */ ((FormulaType3) => {
   FormulaType3["STATIC"] = "static";
   FormulaType3["DYNAMIC"] = "dynamic";
+  FormulaType3["AI"] = "ai";
   return FormulaType3;
 })(FormulaType || {});
 var BBReferenceFieldSubType = /* @__PURE__ */ ((BBReferenceFieldSubType3) => {
@@ -1416,6 +1450,7 @@ var MaintenanceType = /* @__PURE__ */ ((MaintenanceType2) => {
 })(MaintenanceType || {});
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  AIOperationEnum,
   APP_QUOTA_NAMES,
   AUDIT_LOG_TYPE,
   AccountSSOProvider,
@@ -1482,6 +1517,7 @@ var MaintenanceType = /* @__PURE__ */ ((MaintenanceType2) => {
   LockName,
   LockType,
   LogicalOperator,
+  LoginMethod,
   LoopStepType,
   MaintenanceType,
   MigrationName,
@@ -1489,6 +1525,7 @@ var MaintenanceType = /* @__PURE__ */ ((MaintenanceType2) => {
   MonthlyQuotaName,
   NumericTypes,
   Operation,
+  OperationFieldTypeEnum,
   PASSWORD_REPLACEMENT,
   PLUGIN_TYPE_ARR,
   PermissionLevel,