@n8n/frontend-module-sdk 0.15.4 → 0.16.0

package/package.json

@@ -1,17 +1,17 @@
 {
   "type": "module",
   "name": "@n8n/frontend-module-sdk",
-  "version": "0.15.4",
+  "version": "0.16.0",
   "main": "src/index.ts",
   "import": "src/index.ts",
   "exports": {
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@n8n/api-types": "1.45.3",
-    "@n8n/design-system": "2.44.4",
-    "@n8n/utils": "1.52.0",
-    "n8n-workflow": "2.45.1",
+    "@n8n/api-types": "1.46.0",
+    "@n8n/design-system": "2.45.0",
+    "@n8n/utils": "1.53.0",
+    "n8n-workflow": "2.46.0",
     "vue": "^3.5.13",
     "vue-router": "^4.5.0"
   },
@@ -21,7 +21,7 @@
     "@n8n/vitest-config": "1.24.0",
     "typescript": "6.0.2",
     "unplugin-icons": "^23.0.1",
-    "vite": "^8.0.2",
+    "vite": "^8.1.6",
     "vitest": "5.0.1",
     "vue-tsc": "^2.2.8"
   },

package/src/capabilities/createSelfHealingChatHandoff.ts

@@ -0,0 +1,7 @@
+import { declareCapability } from '../declareCapability';
+import type { SelfHealingChatHandoff } from '../types/capability';
+
+/** Call during component setup so the shell can capture its router and toast context. */
+export const createSelfHealingChatHandoff = declareCapability<() => SelfHealingChatHandoff>(
+	'create-self-healing-chat-handoff',
+);

package/src/capabilities/index.ts

@@ -1,3 +1,4 @@
+export { createSelfHealingChatHandoff } from './createSelfHealingChatHandoff';
 export { mcpExposeAllOffer } from './mcpExposeAllOffer';
 // Experiment cleanup (123_surface_mcp_to_claude_trial_users)
 export { mcpDiscoverySettings } from './mcpDiscoverySettings';

package/src/types/capability.ts

@@ -1,3 +1,6 @@
+import type { SelfHealingResultDetail } from '@n8n/api-types';
+import type { ComputedRef } from 'vue';
+
 /**
  * A typed key for a capability. `declareCapability()` is the only way to make
  * one, and the token is the only way to read or write its slot in the registry.
@@ -30,3 +33,25 @@ export interface McpExposeAllOffer {
 	 */
 	offer(onExposed: () => Promise<void> | void): Promise<boolean>;
 }
+
+export type SelfHealingChatInput = Pick<
+	SelfHealingResultDetail,
+	'resultId' | 'workflowId' | 'report' | 'outcome' | 'reviewState' | 'execution'
+>;
+
+/**
+ * `started` means the chat opened and the report is on its way, so do not start it again.
+ * `busy` and `failed` mean no chat started, so the caller can offer another try.
+ */
+export type SelfHealingChatStartOutcome = 'started' | 'busy' | 'failed' | 'unavailable';
+
+export interface SelfHealingChatHandoff {
+	available: ComputedRef<boolean>;
+	/**
+	 * Returns the current user's personal project, or null if it cannot load.
+	 * A reviewer can lack read access to the result's project.
+	 */
+	resolveProjectId(): Promise<string | null>;
+	/** Opens a chat in the project and sends the report through the normal Assistant handoff. */
+	start(projectId: string, input: SelfHealingChatInput): Promise<SelfHealingChatStartOutcome>;
+}

package/src/types/component.ts

@@ -12,8 +12,10 @@ import type { WorkflowReviewVersionSnapshot } from '@n8n/api-types';
  * `features/collaboration/projects`, which sits above the module layer. A module
  * that needs to filter by project renders this instead of importing any of it.
  * `workflow-diff` renders plain workflow snapshots with the editor canvas.
+ * `promotion-changes` lists what a promotion review changes. It loads the changes itself, so
+ * the module needs no knowledge of the promotion types.
  */
-export type ModuleComponentSlot = 'project-filter' | 'workflow-diff';
+export type ModuleComponentSlot = 'project-filter' | 'workflow-diff' | 'promotion-changes';
 
 /**
  * The `v-model` value of the `project-filter` slot. `null` means "all projects".
@@ -25,14 +27,33 @@ export type ModuleComponentSlot = 'project-filter' | 'workflow-diff';
 export type SlotProjectSelection = { id: string } | null;
 
 /** Plain snapshots keep the editor canvas types inside the shell. */
+export type SlotWorkflowDiffSnapshot = Pick<
+	WorkflowReviewVersionSnapshot,
+	'nodes' | 'connections'
+> &
+	Partial<Pick<WorkflowReviewVersionSnapshot, 'versionId' | 'createdAt' | 'nodeGroups'>>;
+
 export type SlotWorkflowDiffProps = {
 	workflowId: string;
 	workflowName: string;
-	sourceSnapshot?: WorkflowReviewVersionSnapshot;
-	targetSnapshot?: WorkflowReviewVersionSnapshot;
+	sourceSnapshot?: SlotWorkflowDiffSnapshot;
+	targetSnapshot?: SlotWorkflowDiffSnapshot;
 	sourceLabel?: string;
 	targetLabel?: string;
 	showFullscreenButton?: boolean;
 	canvasIdPrefix?: string;
 	hideTitle?: boolean;
 };
+
+export type SlotPromotionChangesProps = {
+	reviewId: string;
+};
+
+/**
+ * What the `promotion-changes` slot shows, emitted as `state`. Approve sends the head commit of
+ * the changes that the reviewer saw, so it waits for `ready`.
+ */
+export type PromotionChangesState =
+	| { status: 'loading' }
+	| { status: 'ready'; headCommitSha: string }
+	| { status: 'unavailable' };

package/src/types/descriptor.ts

@@ -24,14 +24,32 @@ export type ModulePlaceholderPage = {
 	component: () => Promise<Component>;
 };
 
+/**
+ * A heading in the settings sidebar. The shell lists them in this order:
+ * Personal, People & access, AI, Integrations, Security, Operations, Billing.
+ */
+export type SettingsSectionId =
+	| 'personal'
+	| 'people'
+	| 'ai'
+	| 'integrations'
+	| 'security'
+	| 'operations'
+	| 'billing';
+
 /** A link in the settings sidebar. Shell and modules both use it. */
 export type IMenuSettingItem = IMenuItem & {
 	/**
-	 * @description Sort position, low to high. Shell links use 10, 20, 30, ... so pick a number
-	 * between two of them to land between them. No `order` means last. Equal values
-	 * keep registration order.
+	 * @description Sort position inside the section, low to high. Shell links use 10, 20, 30, ...
+	 * in each section, so pick a number between two of them to land between them. No `order`
+	 * means last in the section. Equal values keep registration order.
 	 */
 	order?: number;
+	/**
+	 * @description Heading the link is listed under. No `section` means the link is listed before
+	 * the first heading.
+	 */
+	section?: SettingsSectionId;
 };
 
 /**