@budibase/types 3.42.0 → 3.44.0

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

@@ -1,10 +1,6 @@
 import { Optional } from "../../../shared";
-import { Agent, AgentSharePointKnowledgeSourceScope, AgentKnowledgeSourceSyncRunStatus, AgentOperation, ChatApp, ChatConversation, ChatConversationRequest, CreateChatConversationRequest, KnowledgeBaseFile } from "../../../documents";
+import { Agent, AgentSharePointKnowledgeSourceScope, AgentKnowledgeSourceSyncRunStatus, AgentOperation, ChatConversationRequest, KnowledgeBaseFile } from "../../../documents";
 export type ChatAgentRequest = ChatConversationRequest;
-export type FetchAgentHistoryResponse = ChatConversation[];
-export type { CreateChatConversationRequest };
-export type CreateChatAppRequest = Omit<ChatApp, "_id" | "_rev" | "createdAt" | "updatedAt">;
-export type UpdateChatAppRequest = Omit<ChatApp, "createdAt" | "updatedAt">;
 export interface FetchAgentsResponse {
     agents: Agent[];
 }
@@ -94,33 +90,32 @@ export interface DisconnectAgentSharePointSiteResponse {
     disconnected: true;
     siteId: string;
 }
-export interface FetchChatAppAgentsResponse {
-    agents: Pick<Agent, "_id" | "name" | "icon" | "iconColor" | "live">[];
-}
-interface ConfigureAgentDeploymentChannelRequest {
-    chatAppId?: string;
-}
 interface ConfigureAgentDeploymentChannelResponse {
     success: boolean;
-    chatAppId: string;
-}
-export type SyncAgentDiscordCommandsRequest = ConfigureAgentDeploymentChannelRequest;
-export interface SyncAgentDiscordCommandsResponse extends ConfigureAgentDeploymentChannelResponse {
-    interactionsEndpointUrl: string;
-    inviteUrl: string;
 }
-export type ProvisionAgentMSTeamsChannelRequest = ConfigureAgentDeploymentChannelRequest;
+export type ProvisionAgentMSTeamsChannelRequest = Record<string, never>;
 export interface ProvisionAgentMSTeamsChannelResponse extends ConfigureAgentDeploymentChannelResponse {
     messagingEndpointUrl: string;
 }
-export type ProvisionAgentSlackChannelRequest = ConfigureAgentDeploymentChannelRequest;
+export type ProvisionAgentSlackChannelRequest = Record<string, never>;
 export interface ProvisionAgentSlackChannelResponse extends ConfigureAgentDeploymentChannelResponse {
     messagingEndpointUrl: string;
 }
-export type ProvisionAgentTelegramChannelRequest = ConfigureAgentDeploymentChannelRequest;
-export interface ProvisionAgentTelegramChannelResponse extends ConfigureAgentDeploymentChannelResponse {
+export type CreateAgentSlackAppRequest = Record<string, never>;
+export interface CreateAgentSlackAppResponse extends ConfigureAgentDeploymentChannelResponse {
+    appId: string;
+    oauthAuthorizeUrl: string;
     messagingEndpointUrl: string;
-    warning?: string;
+}
+export interface SlackAppConfigResponse {
+    configured: boolean;
+    updatedAt?: string;
+    expiresAt?: string;
+    needsReconfiguration?: boolean;
+}
+export interface SaveSlackAppConfigRequest {
+    configToken: string;
+    refreshToken: string;
 }
 export interface ToggleAgentDeploymentRequest {
     enabled: boolean;
@@ -138,3 +133,4 @@ export type AgentOperationConfigRequest = Pick<AgentOperation, "name" | "live" |
 export type CreateAgentOperationRequest = AgentOperationConfigRequest & Pick<AgentOperation, "id">;
 export type UpdateAgentOperationRequest = Partial<AgentOperationConfigRequest>;
 export type AgentOperationMutationResponse = Omit<Agent, "knowledgeSources" | "knowledgeBases">;
+export {};

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

@@ -16,6 +16,7 @@ export * from "./permission";
 export * from "./query";
 export * from "./recaptcha";
 export * from "./resource";
+export * from "./restTemplate";
 export * from "./role";
 export * from "./rowAction";
 export * from "./rows";

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

@@ -1,5 +1,6 @@
 import { Datasource, ImportEndpoint, Query, QueryPreview, QuerySchema, SecurityScheme } from "../../../documents";
 import { OpenAPIServer } from "../../../ui/rest";
+import type { CustomRestTemplateId } from "../../../ui/rest";
 export type FetchQueriesResponse = Query[];
 export interface SaveQueryRequest extends Query {
 }
@@ -9,12 +10,14 @@ export interface ImportRestQueryRequest {
     datasourceId?: string;
     data?: string;
     url?: string;
+    restTemplateId?: CustomRestTemplateId;
     datasource: Datasource;
     selectedEndpointId?: string;
 }
 export interface ImportRestQueryInfoRequest {
     data?: string;
     url?: string;
+    restTemplateId?: CustomRestTemplateId;
 }
 export interface ImportRestQueryInfoResponse {
     name: string;

package/dist/api/web/workspace/restTemplate.d.ts

@@ -0,0 +1,15 @@
+import type { RestTemplate } from "../../../ui/rest";
+export interface UploadCustomRestTemplateRequest {
+    name: string;
+    description: string;
+}
+export interface UploadCustomRestTemplateResponse {
+    template: RestTemplate;
+}
+export interface UpdateCustomRestTemplateResponse {
+    template: RestTemplate;
+}
+export type FetchCustomRestTemplatesResponse = RestTemplate[];
+export interface DeleteCustomRestTemplateResponse {
+    message: string;
+}

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

@@ -74,18 +74,6 @@ export interface PublishedWorkspaceData {
 export interface FetchPublishedAppsResponse {
     apps: PublishedWorkspaceData[];
 }
-export interface PublishedChatAppData {
-    appId: string;
-    chatAppId: string;
-    agentId: string;
-    agentName: string;
-    name: string;
-    url: string;
-    updatedAt?: string;
-}
-export interface FetchPublishedChatAppsResponse {
-    chatApps: PublishedChatAppData[];
-}
 export interface UpdateWorkspaceRequest extends Partial<Workspace> {
 }
 export interface UpdateWorkspaceResponse extends Workspace {

package/dist/documents/document.d.ts

@@ -38,9 +38,9 @@ export declare enum DocumentType {
     OAUTH2_CONFIG = "oauth2",
     OAUTH2_CONFIG_LOG = "oauth2log",
     AGENT = "agent",
-    CHAT_APP = "chatapp",
     CHAT_CONVERSATION = "chatconvo",
     CHAT_IDENTITY_LINK = "chatidentitylink",
+    SLACK_APP_CONFIG = "slackappconfig",
     AGENT_TOOL_SOURCE = "agenttoolsource",
     AGENT_FILE = "agentfile",
     AGENT_LOG_SESSION = "agentlogsession",
@@ -57,6 +57,7 @@ export declare enum DocumentType {
     WORKSPACE_APP = "workspace_app",
     WORKSPACE_FAVOURITE = "workspace_favourite",
     PROJECT = "project",
+    REST_TEMPLATE = "rest_template",
     AUTO_COLUMN_STATE = "autocolumn_state",
     ESCALATION_CONTEXT = "escalation_context",
     ESCALATION_NOTIFICATION = "escalation_notification"

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

@@ -10,6 +10,16 @@ export declare enum ToolType {
     SEARCH = "SEARCH",
     ESCALATION = "ESCALATION"
 }
+export declare enum ToolExecutionPrincipal {
+    REQUESTER = "requester",
+    ADMIN = "admin"
+}
+export type ToolExecutionPolicy = {
+    mode: "admin";
+} | {
+    mode: "configurable";
+    defaultPrincipal: ToolExecutionPrincipal;
+};
 export interface ToolMetadata {
     name: string;
     readableName?: string;
@@ -17,38 +27,31 @@ export interface ToolMetadata {
     sourceType: ToolType;
     sourceLabel?: string;
     sourceIconType?: string;
+    executionPolicy: ToolExecutionPolicy;
 }
 interface ChatAgentIntegration {
-    chatAppId?: string;
     idleTimeoutMinutes?: number;
     requireUserLink?: boolean;
 }
-export interface DiscordAgentIntegration extends ChatAgentIntegration {
-    applicationId?: string;
-    publicKey?: string;
-    botToken?: string;
-    guildId?: string;
-    interactionsEndpointUrl?: string;
-}
 export interface MSTeamsAgentIntegration extends ChatAgentIntegration {
     appId?: string;
     appPassword?: string;
     tenantId?: string;
     teamId?: string;
     messagingEndpointUrl?: string;
+    appPackageVersion?: string;
 }
 export interface SlackAgentIntegration extends ChatAgentIntegration {
+    appId?: string;
+    clientId?: string;
+    clientSecret?: string;
     botToken?: string;
+    botUserId?: string;
     signingSecret?: string;
+    teamName?: string;
     messagingEndpointUrl?: string;
     teamId?: string;
 }
-export interface TelegramAgentIntegration extends ChatAgentIntegration {
-    botToken?: string;
-    webhookSecretToken?: string;
-    botUserName?: string;
-    messagingEndpointUrl?: string;
-}
 export declare enum AgentKnowledgeSourceType {
     SHAREPOINT = "sharepoint"
 }
@@ -101,12 +104,33 @@ export interface AgentEscalationConfig {
     recipients?: EscalationRecipient[];
     delay?: number;
 }
+export interface AgentOperationToolConfig {
+    toolName: string;
+    executionPrincipal: ToolExecutionPrincipal;
+}
+export interface AgentRequester {
+    userId: string;
+    authorization: {
+        mode: "current";
+    } | {
+        mode: "preview";
+        roleId: string;
+    };
+}
+export interface AgentExecutionContext {
+    tenantId: string;
+    workspaceId: string;
+    agentId: string;
+    operationId: string;
+    conversationId: string;
+    requester: AgentRequester;
+}
 export interface AgentOperation {
     id: string;
     name: string;
     live: boolean;
     promptInstructions?: string;
-    enabledTools?: string[];
+    enabledTools?: AgentOperationToolConfig[];
     knowledgeBases?: string[];
     knowledgeSources?: AgentKnowledgeSource[];
     allowKnowledgeSourceDownload: boolean;
@@ -124,10 +148,8 @@ export interface Agent extends Document {
     icon?: string;
     iconColor?: string;
     createdBy?: string;
-    discordIntegration?: DiscordAgentIntegration;
     MSTeamsIntegration?: MSTeamsAgentIntegration;
     slackIntegration?: SlackAgentIntegration;
-    telegramIntegration?: TelegramAgentIntegration;
 }
 export interface AgentMessageRagSource {
     sourceId: string;

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

@@ -1,38 +1,17 @@
 import { AgentMessageMetadata, Document } from "../../";
 import type { UIMessage } from "ai";
 export declare enum AgentChannelProvider {
-    DISCORD = "discord",
     MSTEAMS = "msteams",
-    SLACK = "slack",
-    TELEGRAM = "telegram"
+    SLACK = "slack"
 }
 export type ChatIdentityLinkProvider = AgentChannelProvider;
 /** Maps provider to deployment UI channel id (e.g. MSTeams for display) */
 export declare const DEPLOYMENT_CHANNEL_IDS: Record<AgentChannelProvider, string>;
 export declare const DEPLOYMENT_ID_TO_PROVIDER: Record<string, AgentChannelProvider>;
-export interface ConversationStarter {
-    prompt: string;
-}
-export interface ChatAppAgent {
-    agentId: string;
-    isEnabled: boolean;
-    isDefault: boolean;
-    roleId?: string;
-    conversationStarters?: ConversationStarter[];
-}
-export interface ChatApp extends Document {
-    title?: string;
-    greeting?: string;
-    description?: string;
-    agents: ChatAppAgent[];
-    live?: boolean;
-    settings?: Record<string, any>;
-}
 export interface ChatConversationChannel {
     provider: AgentChannelProvider;
     conversationId?: string;
     conversationType?: string;
-    guildId?: string;
     teamId?: string;
     tenantId?: string;
     channelId?: string;
@@ -42,13 +21,12 @@ export interface ChatConversationChannel {
     serviceUrl?: string;
 }
 export interface ChatConversationRequest extends Document {
-    chatAppId: string;
     agentId: string;
     title?: string;
     messages: UIMessage<AgentMessageMetadata>[];
     timezone?: string;
-    transient?: boolean;
     isPreview?: boolean;
+    previewRoleId?: string;
     sessionId?: string;
     channel?: ChatConversationChannel;
 }
@@ -59,7 +37,6 @@ export interface WebhookChatCompleteResult {
     allowKnowledgeSourceDownload?: boolean;
     title?: string;
 }
-export type CreateChatConversationRequest = Pick<ChatConversationRequest, "chatAppId" | "agentId" | "title">;
 export type DraftChatConversation = Omit<ChatConversationRequest, "agentId"> & {
     agentId?: string;
 };
@@ -75,7 +52,6 @@ export interface ChatIdentityLink extends Document {
     linkedBy?: string;
     externalUserName?: string;
     teamId?: string;
-    guildId?: string;
     providerTenantId?: string;
     serviceUrl?: string;
 }

package/dist/documents/workspace/escalation.d.ts

@@ -67,9 +67,7 @@ export interface EscalationResult {
 export declare enum EscalationNotificationChannel {
     BUDIBASE = "budibase",
     SLACK = "slack",
-    MSTEAMS = "msteams",
-    DISCORD = "discord",
-    TELEGRAM = "telegram"
+    MSTEAMS = "msteams"
 }
 export declare enum EscalationAction {
     APPROVE = "esc_approve",

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

@@ -10,10 +10,12 @@ export * from "./metadata";
 export * from "./oauth2";
 export * from "./project";
 export * from "./query";
+export * from "./restTemplate";
 export * from "./role";
 export * from "./row";
 export * from "./rowAction";
 export * from "./screen";
+export * from "./slack";
 export * from "./snippet";
 export * from "./sqlite";
 export * from "./table";

package/dist/documents/workspace/query.d.ts

@@ -1,4 +1,5 @@
 import { Document } from "../document";
+import { JSONValue } from "../../core";
 import { RestAuthType } from "./datasource";
 import { Row } from "./row";
 import type { RestTemplateId } from "../../ui";
@@ -67,6 +68,20 @@ export declare enum BodyType {
     JSON = "json",
     TEXT = "text"
 }
+export declare const SecretTag: {
+    BASIC: string;
+    BEARER: string;
+    OAUTH2: string;
+    GENERIC: string;
+};
+export interface RestRequestPreview {
+    url: string;
+    path: string;
+    method: string;
+    headers: Record<string, string>;
+    params: Record<string, string>;
+    body?: JSONValue;
+}
 export interface RestQueryFields {
     path?: string;
     rawPath?: string;

package/dist/documents/workspace/restTemplate.d.ts

@@ -0,0 +1,12 @@
+import type { CustomRestTemplateId } from "../../ui/rest";
+import type { Document } from "../document";
+export type CustomRestTemplateFileExtension = "json" | "yaml";
+export interface CustomRestTemplateDocument extends Document {
+    _id: CustomRestTemplateId;
+    restTemplateId: CustomRestTemplateId;
+    name: string;
+    description: string;
+    objectStoreKey: string;
+    fileExtension: CustomRestTemplateFileExtension;
+    operationsCount: number;
+}

package/dist/documents/workspace/slack.d.ts

@@ -0,0 +1,8 @@
+import type { Document } from "../document";
+export interface SlackAppConfig extends Document {
+    configToken: string;
+    refreshToken?: string;
+    expiresAt?: string;
+    createdAt: string;
+    updatedAt: string;
+}