@n8n/api-types 1.27.0 → 1.28.0

package/dist/agents/rich-card.schema.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.richCardComponentTypesInSync = exports.richMessageSchema = exports.richCardSchema = exports.richCardComponentSchema = exports.RICH_CARD_BUTTON_STYLES = exports.RICH_CARD_COMPONENT_TYPES = void 0;
+const zod_1 = require("zod");
+exports.RICH_CARD_COMPONENT_TYPES = [
+    'section',
+    'fields',
+    'image',
+    'divider',
+    'button',
+    'select',
+    'radio_select',
+];
+exports.RICH_CARD_BUTTON_STYLES = ['primary', 'danger', 'default'];
+const richCardButtonStyleSchema = zod_1.z.enum(exports.RICH_CARD_BUTTON_STYLES);
+const richCardFieldPairSchema = zod_1.z
+    .object({
+    label: zod_1.z.string(),
+    value: zod_1.z.string(),
+})
+    .strict();
+const richCardSelectOptionSchema = zod_1.z
+    .object({
+    label: zod_1.z.string(),
+    value: zod_1.z.string(),
+    description: zod_1.z.string().optional(),
+})
+    .strict();
+const richCardButtonSchema = zod_1.z
+    .object({
+    label: zod_1.z.string().optional(),
+    text: zod_1.z.string().optional(),
+    value: zod_1.z.string(),
+    style: richCardButtonStyleSchema.optional(),
+})
+    .strict();
+exports.richCardComponentSchema = zod_1.z.union([
+    zod_1.z
+        .object({
+        type: zod_1.z.literal('section'),
+        text: zod_1.z.string(),
+        button: richCardButtonSchema.optional(),
+    })
+        .strict(),
+    zod_1.z
+        .object({
+        type: zod_1.z.literal('fields'),
+        fields: zod_1.z.array(richCardFieldPairSchema).min(1).optional(),
+        items: zod_1.z.array(richCardFieldPairSchema).min(1).optional(),
+    })
+        .strict()
+        .refine((component) => component.fields !== undefined || component.items !== undefined, {
+        message: 'Provide fields or items.',
+    }),
+    zod_1.z
+        .object({
+        type: zod_1.z.literal('image'),
+        url: zod_1.z.string(),
+        alt: zod_1.z.string().optional(),
+        altText: zod_1.z.string().optional(),
+    })
+        .strict(),
+    zod_1.z
+        .object({
+        type: zod_1.z.literal('divider'),
+    })
+        .strict(),
+    zod_1.z
+        .object({
+        type: zod_1.z.literal('button'),
+        label: zod_1.z.string().optional(),
+        text: zod_1.z.string().optional(),
+        value: zod_1.z.string(),
+        style: richCardButtonStyleSchema.optional(),
+    })
+        .strict(),
+    zod_1.z
+        .object({
+        type: zod_1.z.literal('select'),
+        id: zod_1.z.string().optional(),
+        label: zod_1.z.string().optional(),
+        placeholder: zod_1.z.string().optional(),
+        options: zod_1.z.array(richCardSelectOptionSchema).min(1),
+    })
+        .strict(),
+    zod_1.z
+        .object({
+        type: zod_1.z.literal('radio_select'),
+        id: zod_1.z.string().optional(),
+        label: zod_1.z.string().optional(),
+        placeholder: zod_1.z.string().optional(),
+        options: zod_1.z.array(richCardSelectOptionSchema).min(1),
+    })
+        .strict(),
+]);
+exports.richCardSchema = zod_1.z
+    .object({
+    awaitResponse: zod_1.z.boolean().optional(),
+    title: zod_1.z.string().optional(),
+    message: zod_1.z.string().optional(),
+    components: zod_1.z.array(exports.richCardComponentSchema).min(1),
+})
+    .strict()
+    .describe('Generic card payload rendered by the integration. Use generic components only, not platform-native message payloads.');
+exports.richMessageSchema = zod_1.z
+    .object({
+    text: zod_1.z.string().optional().describe('Plain-text fallback or summary for the message.'),
+    card: exports.richCardSchema.optional(),
+})
+    .strict()
+    .refine((message) => message.text !== undefined || message.card !== undefined, {
+    message: 'Provide message.text or message.card.',
+})
+    .describe('Generic message payload. Use message.text plus optional message.card only.');
+exports.richCardComponentTypesInSync = true;
+//# sourceMappingURL=rich-card.schema.js.map

package/dist/agents/rich-card.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rich-card.schema.js","sourceRoot":"","sources":["../../src/agents/rich-card.schema.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAcX,QAAA,yBAAyB,GAAG;IACxC,SAAS;IACT,QAAQ;IACR,OAAO;IACP,SAAS;IACT,QAAQ;IACR,QAAQ;IACR,cAAc;CACL,CAAC;AAOE,QAAA,uBAAuB,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAU,CAAC;AAGjF,MAAM,yBAAyB,GAAG,OAAC,CAAC,IAAI,CAAC,+BAAuB,CAAC,CAAC;AAElE,MAAM,uBAAuB,GAAG,OAAC;KAC/B,MAAM,CAAC;IACP,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;CACjB,CAAC;KACD,MAAM,EAAE,CAAC;AAEX,MAAM,0BAA0B,GAAG,OAAC;KAClC,MAAM,CAAC;IACP,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC;KACD,MAAM,EAAE,CAAC;AAEX,MAAM,oBAAoB,GAAG,OAAC;KAC5B,MAAM,CAAC;IACP,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,KAAK,EAAE,yBAAyB,CAAC,QAAQ,EAAE;CAC3C,CAAC;KACD,MAAM,EAAE,CAAC;AAEE,QAAA,uBAAuB,GAAG,OAAC,CAAC,KAAK,CAAC;IAC9C,OAAC;SACC,MAAM,CAAC;QACP,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,SAAS,CAAC;QAC1B,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;QAChB,MAAM,EAAE,oBAAoB,CAAC,QAAQ,EAAE;KACvC,CAAC;SACD,MAAM,EAAE;IACV,OAAC;SACC,MAAM,CAAC;QACP,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;QACzB,MAAM,EAAE,OAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;QAC1D,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;KACzD,CAAC;SACD,MAAM,EAAE;SACR,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,KAAK,SAAS,IAAI,SAAS,CAAC,KAAK,KAAK,SAAS,EAAE;QACvF,OAAO,EAAE,0BAA0B;KACnC,CAAC;IACH,OAAC;SACC,MAAM,CAAC;QACP,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC;QACxB,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE;QACf,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC1B,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC9B,CAAC;SACD,MAAM,EAAE;IACV,OAAC;SACC,MAAM,CAAC;QACP,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,SAAS,CAAC;KAC1B,CAAC;SACD,MAAM,EAAE;IACV,OAAC;SACC,MAAM,CAAC;QACP,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;QACzB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,KAAK,EAAE,yBAAyB,CAAC,QAAQ,EAAE;KAC3C,CAAC;SACD,MAAM,EAAE;IACV,OAAC;SACC,MAAM,CAAC;QACP,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;QACzB,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACzB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAClC,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;KACnD,CAAC;SACD,MAAM,EAAE;IACV,OAAC;SACC,MAAM,CAAC;QACP,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,cAAc,CAAC;QAC/B,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACzB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAClC,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;KACnD,CAAC;SACD,MAAM,EAAE;CACV,CAAC,CAAC;AAEU,QAAA,cAAc,GAAG,OAAC;KAC7B,MAAM,CAAC;IACP,aAAa,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACrC,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,UAAU,EAAE,OAAC,CAAC,KAAK,CAAC,+BAAuB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;CACnD,CAAC;KACD,MAAM,EAAE;KACR,QAAQ,CACR,sHAAsH,CACtH,CAAC;AAEU,QAAA,iBAAiB,GAAG,OAAC;KAChC,MAAM,CAAC;IACP,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iDAAiD,CAAC;IACvF,IAAI,EAAE,sBAAc,CAAC,QAAQ,EAAE;CAC/B,CAAC;KACD,MAAM,EAAE;KACR,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE;IAC9E,OAAO,EAAE,uCAAuC;CAChD,CAAC;KACD,QAAQ,CAAC,4EAA4E,CAAC,CAAC;AAc5E,QAAA,4BAA4B,GAGrC,IAAI,CAAC"}

package/dist/agents/types.d.ts

@@ -225,3 +225,7 @@ export interface AgentBuilderMessagesResponse {
     messages: AgentPersistedMessageDto[];
     openSuspensions: AgentBuilderOpenSuspension[];
 }
+export declare const N8N_CHAT_INTEGRATION_TYPE: "n8n_chat";
+export declare const N8N_CHAT_ACTION_TOOL_NAME: "chat_action";
+export declare const N8N_CHAT_CONTEXT_TOOL_NAME: "chat_context";
+export type AgentChatMessagesResponse = AgentBuilderMessagesResponse;

package/dist/agents/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.agentBuilderStatusResponseSchema = exports.AgentBuilderAdminSettingsUpdateDto = exports.agentBuilderAdminSettingsResponseSchema = exports.agentBuilderAdminSettingsSchema = exports.agentBuilderModeSchema = exports.AGENT_BUILDER_DEFAULT_MODEL = exports.AGENT_WORKFLOW_TRIGGER_TYPE = exports.INCOMPATIBLE_WORKFLOW_TOOL_BODY_NODE_TYPES = exports.SUPPORTED_WORKFLOW_TOOL_TRIGGERS = void 0;
+exports.N8N_CHAT_CONTEXT_TOOL_NAME = exports.N8N_CHAT_ACTION_TOOL_NAME = exports.N8N_CHAT_INTEGRATION_TYPE = exports.agentBuilderStatusResponseSchema = exports.AgentBuilderAdminSettingsUpdateDto = exports.agentBuilderAdminSettingsResponseSchema = exports.agentBuilderAdminSettingsSchema = exports.agentBuilderModeSchema = exports.AGENT_BUILDER_DEFAULT_MODEL = exports.AGENT_WORKFLOW_TRIGGER_TYPE = exports.INCOMPATIBLE_WORKFLOW_TOOL_BODY_NODE_TYPES = exports.SUPPORTED_WORKFLOW_TOOL_TRIGGERS = void 0;
 const n8n_workflow_1 = require("n8n-workflow");
 const zod_1 = require("zod");
 exports.SUPPORTED_WORKFLOW_TOOL_TRIGGERS = [
@@ -35,4 +35,7 @@ exports.AgentBuilderAdminSettingsUpdateDto = exports.agentBuilderAdminSettingsSc
 exports.agentBuilderStatusResponseSchema = zod_1.z.object({
     isConfigured: zod_1.z.boolean(),
 });
+exports.N8N_CHAT_INTEGRATION_TYPE = 'n8n_chat';
+exports.N8N_CHAT_ACTION_TOOL_NAME = 'chat_action';
+exports.N8N_CHAT_CONTEXT_TOOL_NAME = 'chat_context';
 //# sourceMappingURL=types.js.map

package/dist/agents/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/agents/types.ts"],"names":[],"mappings":";;;AAAA,+CAOsB;AACtB,6BAAwB;AAKX,QAAA,gCAAgC,GAAG;IAC/C,uCAAwB;IACxB,iDAAkC;IAClC,qCAAsB;IACtB,yCAA0B;IAC1B,qCAAsB;IACtB,gCAAiB;CACR,CAAC;AAEE,QAAA,0CAA0C,GAAG;IACzD,qBAAqB;IACrB,qBAAqB;CACZ,CAAC;AAEE,QAAA,2BAA2B,GAAG,UAAU,CAAC;AA+HzC,QAAA,2BAA2B,GAAG,mBAA4B,CAAC;AAE3D,QAAA,sBAAsB,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;AAGvD,QAAA,+BAA+B,GAAG,OAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IAC3E,OAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;IACxC,OAAC,CAAC,MAAM,CAAC;QACR,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;QACzB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3B,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/B,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;KAC5B,CAAC;CACF,CAAC,CAAC;AAGU,QAAA,uCAAuC,GAAG,OAAC,CAAC,MAAM,CAAC;IAC/D,QAAQ,EAAE,uCAA+B;IACzC,YAAY,EAAE,OAAC,CAAC,OAAO,EAAE;CACzB,CAAC,CAAC;AAKU,QAAA,kCAAkC,GAAG,uCAA+B,CAAC;AAGrE,QAAA,gCAAgC,GAAG,OAAC,CAAC,MAAM,CAAC;IACxD,YAAY,EAAE,OAAC,CAAC,OAAO,EAAE;CACzB,CAAC,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/agents/types.ts"],"names":[],"mappings":";;;AAAA,+CAOsB;AACtB,6BAAwB;AAKX,QAAA,gCAAgC,GAAG;IAC/C,uCAAwB;IACxB,iDAAkC;IAClC,qCAAsB;IACtB,yCAA0B;IAC1B,qCAAsB;IACtB,gCAAiB;CACR,CAAC;AAEE,QAAA,0CAA0C,GAAG;IACzD,qBAAqB;IACrB,qBAAqB;CACZ,CAAC;AAEE,QAAA,2BAA2B,GAAG,UAAU,CAAC;AA+HzC,QAAA,2BAA2B,GAAG,mBAA4B,CAAC;AAE3D,QAAA,sBAAsB,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;AAGvD,QAAA,+BAA+B,GAAG,OAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IAC3E,OAAC,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;IACxC,OAAC,CAAC,MAAM,CAAC;QACR,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;QACzB,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3B,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/B,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;KAC5B,CAAC;CACF,CAAC,CAAC;AAGU,QAAA,uCAAuC,GAAG,OAAC,CAAC,MAAM,CAAC;IAC/D,QAAQ,EAAE,uCAA+B;IACzC,YAAY,EAAE,OAAC,CAAC,OAAO,EAAE;CACzB,CAAC,CAAC;AAKU,QAAA,kCAAkC,GAAG,uCAA+B,CAAC;AAGrE,QAAA,gCAAgC,GAAG,OAAC,CAAC,MAAM,CAAC;IACxD,YAAY,EAAE,OAAC,CAAC,OAAO,EAAE;CACzB,CAAC,CAAC;AAiBU,QAAA,yBAAyB,GAAG,UAAmB,CAAC;AAEhD,QAAA,yBAAyB,GAAG,aAAsB,CAAC;AACnD,QAAA,0BAA0B,GAAG,cAAuB,CAAC"}

package/dist/api-keys.d.ts

@@ -6,6 +6,9 @@ export type ApiKeyOwner = {
     lastName: string | null;
     email: string;
 };
+export type ApiKeyOwnerSummary = ApiKeyOwner & {
+    keyCount: number;
+};
 export type ApiKey = {
     id: string;
     label: string;
@@ -31,5 +34,6 @@ export type ApiKeyList = {
         mine: number;
         all: number;
     };
+    owners: ApiKeyOwnerSummary[];
 };
 export type ApiKeyAudience = 'public-api' | 'mcp-server-api';