@budibase/types 3.10.5 → 3.10.7

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

@@ -1,17 +1,43 @@
 import openai from "openai";
 import { EnrichedBinding } from "../../ui";
-export interface Message {
-    role: "system" | "user";
+import { z } from "zod";
+export interface SystemMessage {
+    role: "system";
     content: string;
 }
+export interface UserMessage {
+    role: "user";
+    content: string;
+}
+export interface AssistantMessage {
+    role: "assistant";
+    content: string | null;
+    tool_calls?: openai.ChatCompletionMessageToolCall[];
+}
+export interface ToolMessage {
+    role: "tool";
+    tool_call_id: string;
+    content: string;
+}
+export type Message = SystemMessage | UserMessage | AssistantMessage | ToolMessage;
+export type Tool<T extends z.ZodType = z.ZodType> = Required<ToolArgs<T>>;
+export interface ToolArgs<T extends z.ZodType> {
+    name: string;
+    description: string;
+    parameters?: T;
+    handler: (args: z.infer<T>) => Promise<string>;
+    strict?: boolean;
+}
+export declare function newTool<T extends z.ZodType>(tool: ToolArgs<T>): Tool<T>;
 export type ResponseFormat = "text" | "json" | openai.ResponseFormatJSONSchema;
 export interface ChatCompletionRequest {
     messages: Message[];
     format?: ResponseFormat;
+    useTools?: boolean;
 }
 export interface ChatCompletionResponse {
-    message?: string;
-    tokensUsed?: number;
+    messages: Message[];
+    tokensUsed: number;
 }
 export interface GenerateJsRequest {
     prompt: string;

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

@@ -42,7 +42,7 @@ export interface ClearAutomationLogResponse {
     message: string;
 }
 export interface TriggerAutomationRequest {
-    fields: Record<string, any>;
+    fields?: Record<string, any>;
     timestamp?: number;
     timeout: number;
 }
@@ -50,7 +50,8 @@ export type TriggerAutomationResponse = Record<string, any> | undefined;
 export interface TestAutomationRequest {
     id?: string;
     revision?: string;
-    fields: Record<string, any>;
+    timeout?: number;
+    fields?: Record<string, any>;
     row?: Row;
     oldRow?: Row;
 }

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

@@ -32,7 +32,7 @@ export interface PreviewQueryResponse {
     extra: any;
 }
 export interface ExecuteQueryRequest {
-    parameters?: Record<string, string>;
+    parameters?: Record<string, string | number | null>;
     pagination?: any;
 }
 export type ExecuteV1QueryResponse = Record<string, any>[];

package/dist/api/web/global/agents.d.ts

@@ -0,0 +1,4 @@
+import { AgentChat } from "../../../documents";
+export type ChatAgentRequest = AgentChat;
+export type ChatAgentResponse = AgentChat;
+export type FetchAgentHistoryResponse = AgentChat[];

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

@@ -9,3 +9,4 @@ export * from "./email";
 export * from "./role";
 export * from "./self";
 export * from "./template";
+export * from "./agents";

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

@@ -171,10 +171,11 @@ export type TriggerAutomationStepInputs = {
     automation: {
         automationId: string;
     };
-    timeout: number;
+    timeout?: number;
 };
 export type TriggerAutomationStepOutputs = BaseAutomationOutputs & {
     value?: AutomationResults["steps"];
+    status: AutomationResults["status"];
 };
 export type UpdateRowStepInputs = {
     meta: Record<string, any>;

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

@@ -13,6 +13,7 @@ export declare enum AutomationIOType {
     ARRAY = "array",
     JSON = "json",
     DATE = "date",
+    DATETIME = "datetime",
     ATTACHMENT = "attachment"
 }
 export declare enum AutomationCustomIOType {
@@ -151,10 +152,12 @@ export declare enum AutomationStatus {
     ERROR = "error",
     STOPPED = "stopped",
     STOPPED_ERROR = "stopped_error",
-    NO_CONDITION_MET = "No branch condition met"
+    NO_CONDITION_MET = "No branch condition met",
+    TIMED_OUT = "timed_out"
 }
 export declare enum AutomationStoppedReason {
-    TRIGGER_FILTER_NOT_MET = "Automation did not run. Filter conditions in trigger were not met."
+    TRIGGER_FILTER_NOT_MET = "Automation did not run. Filter conditions in trigger were not met.",
+    TIMED_OUT = "Automation timed out."
 }
 export interface AutomationStepResultOutputs {
     success: boolean;
@@ -179,7 +182,7 @@ export interface AutomationTriggerResult {
 }
 export interface AutomationResults {
     automationId?: string;
-    status?: AutomationStatus;
+    status: AutomationStatus;
     trigger: AutomationTriggerResult;
     steps: [AutomationTriggerResult, ...AutomationStepResult[]];
 }

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

@@ -1,10 +1,15 @@
 import { Document } from "../document";
 export interface Layout extends Document {
-    componentLibraries: string[];
-    title: string;
-    favicon: string;
-    stylesheets: string[];
+    componentLibraries?: string[];
+    title?: string;
+    favicon?: string;
+    stylesheets?: string[];
     props: any;
     layoutId?: string;
     name?: string;
+    navigation?: string;
+    pageWidth?: string;
+    embedded?: boolean;
+    logoUrl?: string;
+    hideTitle?: boolean;
 }

package/dist/documents/document.d.ts

@@ -39,7 +39,8 @@ export declare enum DocumentType {
     SCIM_LOG = "scimlog",
     ROW_ACTIONS = "ra",
     OAUTH2_CONFIG = "oauth2",
-    OAUTH2_CONFIG_LOG = "oauth2log"
+    OAUTH2_CONFIG_LOG = "oauth2log",
+    AGENT_CHAT = "agentchat"
 }
 export declare function getDocumentType(id: string): DocumentType | undefined;
 export declare const DocumentTypesToImport: DocumentType[];

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

@@ -0,0 +1,5 @@
+import { Document, Message } from "../../";
+export interface AgentChat extends Document {
+    title: string;
+    messages: Message[];
+}

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

@@ -9,3 +9,4 @@ export * from "./environmentVariables";
 export * from "./auditLogs";
 export * from "./apikeys";
 export * from "./devInfo";
+export * from "./agents";