@n8n/frontend-module-sdk 0.7.1 → 0.8.1

package/README.md

@@ -14,3 +14,12 @@ only public entry point.
 ```ts
 import { modalRegistry, registerResource, type FrontendModuleDescription } from '@n8n/frontend-module-sdk';
 ```
+
+## Push handlers
+
+A module owns a push message type when it declares it in `pushHandlers`. The
+shell dispatches these at app scope, so a handler runs in every layout. The shell
+skips its own built-in handler for a type a module owns.
+
+**Contract:** a handler must not depend on the built-in handling of the same
+event. The two run on separate listeners, so their order is not defined.

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@n8n/frontend-module-sdk",
-  "version": "0.7.1",
+  "version": "0.8.1",
   "main": "src/index.ts",
   "import": "src/index.ts",
   "exports": {
@@ -10,8 +10,8 @@
   "dependencies": {
     "vue": "^3.5.13",
     "vue-router": "^4.5.0",
-    "@n8n/api-types": "1.37.1",
-    "@n8n/design-system": "2.36.1"
+    "@n8n/api-types": "1.38.1",
+    "@n8n/design-system": "2.37.1"
   },
   "devDependencies": {
     "typescript": "6.0.2",
@@ -20,7 +20,7 @@
     "vitest": "^4.1.9",
     "vue-tsc": "^2.2.8",
     "@n8n/eslint-config": "0.0.1",
-    "@n8n/typescript-config": "1.10.0",
+    "@n8n/typescript-config": "1.11.0",
     "@n8n/vitest-config": "1.21.0"
   },
   "license": "SEE LICENSE IN LICENSE.md",

package/src/registries/commandRegistry.test.ts

@@ -68,6 +68,25 @@ describe('commandRegistry', () => {
 		expect(listener).toHaveBeenLastCalledWith([]);
 	});
 
+	it('should give each subscriber its own array', () => {
+		const received: CommandBarEntry[][] = [];
+		commandRegistry.subscribe((commands) => {
+			commands.reverse();
+			received.push(commands);
+		});
+		commandRegistry.subscribe((commands) => {
+			received.push(commands);
+		});
+
+		commandRegistry.register(commandA);
+		commandRegistry.register(commandB);
+
+		const [firstMutated, secondUnaffected] = received.slice(-2);
+		expect(firstMutated).toEqual([commandB, commandA]);
+		expect(secondUnaffected).toEqual([commandA, commandB]);
+		expect(commandRegistry.getAll()).toEqual([commandA, commandB]);
+	});
+
 	it('should return an unsubscribe function that stops notifications', () => {
 		const listener = vi.fn();
 		const unsubscribe = commandRegistry.subscribe(listener);

package/src/registries/commandRegistry.ts

@@ -8,8 +8,8 @@ export function getAll(): CommandBarEntry[] {
 }
 
 function notifyListeners(): void {
-	const snapshot = getAll();
-	listeners.forEach((listener) => listener(snapshot));
+	// One array per listener: `sort`, `reverse` and `splice` mutate in place.
+	listeners.forEach((listener) => listener(getAll()));
 }
 
 export function register(command: CommandBarEntry): void {

package/src/types/descriptor.ts

@@ -42,7 +42,7 @@ export type FrontendModuleDescription = {
 
 	/** Per-module i18n messages, merged into the active locale by the shell. */
 	locales?: ModuleLocaleMessages;
-	/** Push-message handlers, keyed by message type. */
+	/** Push-message handlers, keyed by message type. See `ModulePushHandlers`. */
 	pushHandlers?: ModulePushHandlers;
 	/** Command-bar contributions. */
 	commands?: CommandBarEntry[];

package/src/types/push.ts

@@ -21,6 +21,13 @@ export type ModulePushHandler<Ctx extends ModulePushHandlerContext = ModulePushH
 /**
  * A module's push-message contributions, keyed by message type. Each handler
  * receives the event already narrowed to its type.
+ *
+ * The shell dispatches these at app scope, on a listener of its own. The order
+ * against the built-in handling of the same type is not defined.
+ *
+ * **Contract:** a handler must not depend on the built-in handling of the same
+ * event. Registration makes the module the owner of a type, and the shell then
+ * skips its own handler for it.
  */
 export type ModulePushHandlers = {
 	[T in PushType]?: (