n8n-workflow 2.31.2 → 2.32.0

package/dist/esm/interfaces.d.ts

@@ -700,6 +700,12 @@ type CronRecurrenceRule = {
     intervalSize: number;
     typeInterval: 'hours' | 'days' | 'weeks' | 'months';
 };
+/**
+ * @deprecated Remnant of the legacy in-memory scheduling path. `registerCron`
+ * takes {@link Cron}, not this type; the durable scheduler path never uses it.
+ * Only `ScheduledTaskManager` and its helper still reference it (and only for
+ * `CronContext['recurrence']`). Slated to go away with `ScheduledTaskManager`.
+ */
 export type CronContext = {
     nodeId: string;
     workflowId: string;
@@ -707,9 +713,24 @@ export type CronContext = {
     expression: CronExpression;
     recurrence?: CronRecurrenceRule;
 };
+/**
+ * Optional source descriptor.
+ * Which Schedule Trigger field produced this cron rule.
+ *
+ * Two different fields can produce the same cron string: a rule typed as a raw
+ * cron expression and a rule set to "every 30 seconds" can both come out as the
+ * same text. Knowing the original field lets code downstream tell them apart
+ * and store each one under the right kind.
+ */
+export type CronSource = {
+    field: 'seconds' | 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'cronExpression';
+    /** The interval size N (e.g. every N seconds); absent for a raw cron expression. */
+    size?: number;
+};
 export type Cron = {
     expression: CronExpression;
     recurrence?: CronRecurrenceRule;
+    source?: CronSource;
 };
 export interface SchedulingFunctions {
     registerCron(cron: Cron, onTick: (scheduledT: Date) => void): void;
@@ -954,6 +975,11 @@ export interface IWebhookFunctions extends FunctionsBaseWithRequiredKeys<'getMod
     getResponseObject(): express.Response;
     getWebhookName(): string;
     validateCookieAuth(cookieValue: string): Promise<IUser>;
+    /** Emits telemetry for an advanced HITL response actioned via this webhook. */
+    logHitlResponse(payload: {
+        approved: boolean;
+        authorized: boolean;
+    }): void;
     nodeHelpers: NodeHelperFunctions;
     helpers: RequestHelperFunctions & BaseHelperFunctions & BinaryHelperFunctions;
 }
@@ -1022,7 +1048,7 @@ export interface IPairedItemData {
     sourceOverwrite?: ISourceData;
 }
 export declare const ChatNodeMessageType: {
-    readonly WITH_BUTTONS: "with-buttons";
+    readonly WITH_BUTTONS: 'with-buttons';
 };
 export type ChatNodeMessageButtonType = 'primary' | 'secondary';
 export type ChatNodeMessageWithButtons = {
@@ -1305,6 +1331,7 @@ export type FeatureCondition = {
     '@version': Array<number | DisplayCondition>;
 };
 export type NodeFeaturesDefinition = Record<string, FeatureCondition>;
+export type DeploymentCondition = 'cloud' | 'hosted';
 export interface IDisplayOptions {
     hide?: {
         [key: string]: Array<NodeParameterValue | DisplayCondition> | undefined;
@@ -1315,6 +1342,10 @@ export interface IDisplayOptions {
         '@tool'?: boolean[];
         [key: string]: Array<NodeParameterValue | DisplayCondition> | undefined;
     };
+    showOnDeployment?: DeploymentCondition;
+    /**
+     * @deprecated Use showOnDeployment instead
+     */
     hideOnCloud?: boolean;
 }
 export interface ICredentialsDisplayOptions {
@@ -1325,6 +1356,10 @@ export interface ICredentialsDisplayOptions {
         '@version'?: number[];
         [key: string]: NodeParameterValue[] | undefined;
     };
+    showOnDeployment?: DeploymentCondition;
+    /**
+     * @deprecated Use showOnDeployment instead
+     */
     hideOnCloud?: boolean;
 }
 export interface INodeProperties {
@@ -1505,14 +1540,43 @@ export interface ExecuteWorkflowData extends DynamicCredentialsUsage {
     data: Array<INodeExecutionData[] | null>;
     waitTill?: Date | null;
 }
-export interface ExecuteAgentInfo {
-    /** The agent ID to execute. */
+/**
+ * Inline agent definition embedded in the calling node's parameters. Kept
+ * structurally loose here (this package cannot depend on `@n8n/api-types`);
+ * the execution layer validates it against `InlineAgentConfigSchema`.
+ */
+export interface InlineAgentPayload {
+    config: {
+        name?: string;
+        model?: string;
+        credential?: string;
+        instructions?: string;
+        tools?: IDataObject[];
+        mcpServers?: IDataObject[];
+        skills?: Array<{
+            type?: string;
+            id?: string;
+        }>;
+    };
+    /** Skill bodies keyed by the ids `config.skills` references. */
+    skills?: Record<string, IDataObject>;
+}
+/** Which agent to execute: a saved agent by id, or an inline definition. */
+export type ExecuteAgentSource = {
     agentId: string;
+    inlineAgent?: never;
+} | {
+    agentId?: never;
+    inlineAgent: InlineAgentPayload;
+};
+export type ExecuteAgentInfo = ExecuteAgentSource & {
     /**
      * Optional caller-supplied session id. When set, this becomes the agent
      * thread id, letting workflows continue the same conversation (and reuse
      * memory) across executions. When omitted, a per-call thread is derived
-     * from the workflow execution id and item index.
+     * from the workflow execution id and item index. Applies to inline agents
+     * too: their conversation threads persist, even though their runs don't
+     * appear in the sessions UI.
      */
     sessionId?: string;
     /**
@@ -1533,7 +1597,7 @@ export interface ExecuteAgentInfo {
      * which can read any executed node's output. Off by default.
      */
     exposeWorkflowData?: boolean;
-}
+};
 /**
  * Context about the calling workflow execution, passed to the agent runtime so
  * it can expose the `fetch_input_data` and (opt-in) `fetch_workflow_context` tools to the agent. The
@@ -1551,6 +1615,13 @@ export interface ExecuteAgentWorkflowContext {
     inputDataScope?: 'item' | 'all';
     /** Whether to attach the `fetch_workflow_context` tool. */
     exposeWorkflowData?: boolean;
+    /**
+     * Whether the caller supplied an explicit session id (vs the derived
+     * per-call thread id). Inline agents persist conversation memory only when
+     * true — a derived thread is never continued, so persisting it would only
+     * accumulate unreachable rows.
+     */
+    hasCallerSessionId?: boolean;
     /** Name and type of every node in the calling workflow. */
     nodes: Array<{
         name: string;
@@ -1587,14 +1658,21 @@ export interface ExecuteAgentData {
     /**
      * Identifiers of the agent session this call wrote to. Surfaced so the
      * caller (e.g. the MessageAnAgent node) can link from a workflow execution
-     * back to the agent session detail view.
+     * back to the agent session detail view. `null` for inline agents, whose
+     * runs are not recorded as sessions.
      */
     session: {
         agentId: string;
         projectId: string;
-        /** The threadId persisted to the agent session. May be a caller-provided override. */
+        /**
+         * Caller-facing session id: the override the caller supplied, or the
+         * derived per-call id. Safe to feed back into the node's Session ID
+         * parameter to continue the conversation.
+         */
         sessionId: string;
-    };
+        /** The internally scoped thread id the session was persisted under (deep-link key). */
+        threadId: string;
+    } | null;
 }
 export type WebhookSetupMethodNames = 'checkExists' | 'create' | 'delete';
 export declare namespace MultiPartFormData {
@@ -1932,19 +2010,19 @@ export interface IPostReceiveSort extends IPostReceiveBase {
     };
 }
 export declare const NodeConnectionTypes: {
-    readonly AiAgent: "ai_agent";
-    readonly AiChain: "ai_chain";
-    readonly AiDocument: "ai_document";
-    readonly AiEmbedding: "ai_embedding";
-    readonly AiLanguageModel: "ai_languageModel";
-    readonly AiMemory: "ai_memory";
-    readonly AiOutputParser: "ai_outputParser";
-    readonly AiRetriever: "ai_retriever";
-    readonly AiReranker: "ai_reranker";
-    readonly AiTextSplitter: "ai_textSplitter";
-    readonly AiTool: "ai_tool";
-    readonly AiVectorStore: "ai_vectorStore";
-    readonly Main: "main";
+    readonly AiAgent: 'ai_agent';
+    readonly AiChain: 'ai_chain';
+    readonly AiDocument: 'ai_document';
+    readonly AiEmbedding: 'ai_embedding';
+    readonly AiLanguageModel: 'ai_languageModel';
+    readonly AiMemory: 'ai_memory';
+    readonly AiOutputParser: 'ai_outputParser';
+    readonly AiRetriever: 'ai_retriever';
+    readonly AiReranker: 'ai_reranker';
+    readonly AiTextSplitter: 'ai_textSplitter';
+    readonly AiTool: 'ai_tool';
+    readonly AiVectorStore: 'ai_vectorStore';
+    readonly Main: 'main';
 };
 export type NodeConnectionType = (typeof NodeConnectionTypes)[keyof typeof NodeConnectionTypes];
 export type AINodeConnectionType = Exclude<NodeConnectionType, typeof NodeConnectionTypes.Main>;
@@ -2459,6 +2537,7 @@ export interface IWorkflowGroup {
     id: string;
     name: string;
     nodeIds: string[];
+    description?: string;
 }
 export interface IWorkflowBase {
     id: string;
@@ -2602,6 +2681,16 @@ type AiEventPayload = {
     workflowId?: string;
     nodeType?: string;
 };
+/** Telemetry emitted when an advanced HITL (human-in-the-loop) response is actioned. */
+export type HitlResponseTelemetryPayload = {
+    nodeType: string;
+    /** The decision the responder made. */
+    approved: boolean;
+    /** Whether the responder was on the node's approver allow-list (empty list = anyone). */
+    authorized: boolean;
+    executionId?: string;
+    workflowId?: string;
+};
 export type AgentRequestQuery = {
     [nodeName: string]: Record<string, unknown> | string;
 };
@@ -2614,7 +2703,7 @@ export interface AiAgentRequest {
 export interface IWorkflowExecuteAdditionalData {
     credentialsHelper: ICredentialsHelper;
     executeWorkflow: (workflowInfo: IExecuteWorkflowInfo, additionalData: IWorkflowExecuteAdditionalData, options: ExecuteWorkflowOptions) => Promise<ExecuteWorkflowData>;
-    executeAgent?: (agentId: string, message: string, executionId: string, threadId: string, additionalData: IWorkflowExecuteAdditionalData, executionMode: WorkflowExecuteMode, outputSchema?: JSONSchema7, workflowContext?: ExecuteAgentWorkflowContext) => Promise<ExecuteAgentData>;
+    executeAgent?: (source: ExecuteAgentSource, message: string, executionId: string, threadId: string, additionalData: IWorkflowExecuteAdditionalData, executionMode: WorkflowExecuteMode, outputSchema?: JSONSchema7, workflowContext?: ExecuteAgentWorkflowContext) => Promise<ExecuteAgentData>;
     listAgents?: (userId: string) => Promise<Array<{
         id: string;
         name: string;
@@ -2647,6 +2736,7 @@ export interface IWorkflowExecuteAdditionalData {
     projectId?: string;
     variables: IDataObject;
     logAiEvent: (eventName: AiEvent, payload: AiEventPayload) => void;
+    logHitlResponse?: (payload: HitlResponseTelemetryPayload) => void;
     parentCallbackManager?: CallbackManager;
     /**
      * The execution mode of the root (top-level) workflow. Used to propagate manual