@n8n/decorators 0.31.1 → 0.32.0

package/dist/context-establishment/context-establishment-hook-metadata.d.ts

@@ -0,0 +1,12 @@
+import { ContextEstablishmentHookClass } from './context-establishment-hook';
+type ContextEstablishmentHookEntry = {
+    class: ContextEstablishmentHookClass;
+};
+export declare class ContextEstablishmentHookMetadata {
+    private readonly contextEstablishmentHooks;
+    register(hookEntry: ContextEstablishmentHookEntry): void;
+    getEntries(): [ContextEstablishmentHookEntry, ContextEstablishmentHookEntry][];
+    getClasses(): ContextEstablishmentHookClass[];
+}
+export declare const ContextEstablishmentHook: <T extends ContextEstablishmentHookClass>() => (target: T) => any;
+export {};

package/dist/context-establishment/context-establishment-hook-metadata.js

@@ -0,0 +1,36 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContextEstablishmentHook = exports.ContextEstablishmentHookMetadata = void 0;
+const di_1 = require("@n8n/di");
+let ContextEstablishmentHookMetadata = class ContextEstablishmentHookMetadata {
+    constructor() {
+        this.contextEstablishmentHooks = new Set();
+    }
+    register(hookEntry) {
+        this.contextEstablishmentHooks.add(hookEntry);
+    }
+    getEntries() {
+        return [...this.contextEstablishmentHooks.entries()];
+    }
+    getClasses() {
+        return [...this.contextEstablishmentHooks.values()].map((entry) => entry.class);
+    }
+};
+exports.ContextEstablishmentHookMetadata = ContextEstablishmentHookMetadata;
+exports.ContextEstablishmentHookMetadata = ContextEstablishmentHookMetadata = __decorate([
+    (0, di_1.Service)()
+], ContextEstablishmentHookMetadata);
+const ContextEstablishmentHook = () => (target) => {
+    di_1.Container.get(ContextEstablishmentHookMetadata).register({
+        class: target,
+    });
+    return (0, di_1.Service)()(target);
+};
+exports.ContextEstablishmentHook = ContextEstablishmentHook;
+//# sourceMappingURL=context-establishment-hook-metadata.js.map

package/dist/context-establishment/context-establishment-hook-metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-establishment-hook-metadata.js","sourceRoot":"","sources":["../../src/context-establishment/context-establishment-hook-metadata.ts"],"names":[],"mappings":";;;;;;;;;AAAA,gCAA6C;AAmCtC,IAAM,gCAAgC,GAAtC,MAAM,gCAAgC;IAAtC;QAOW,8BAAyB,GAAuC,IAAI,GAAG,EAAE,CAAC;IA0E5F,CAAC;IA3DA,QAAQ,CAAC,SAAwC;QAChD,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;IAoBD,UAAU;QACT,OAAO,CAAC,GAAG,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,CAAC,CAAC;IACtD,CAAC;IAgCD,UAAU;QACT,OAAO,CAAC,GAAG,IAAI,CAAC,yBAAyB,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACjF,CAAC;CACD,CAAA;AAjFY,4EAAgC;2CAAhC,gCAAgC;IAD5C,IAAA,YAAO,GAAE;GACG,gCAAgC,CAiF5C;AAwEM,MAAM,wBAAwB,GACpC,GAA4C,EAAE,CAC9C,CAAC,MAAS,EAAE,EAAE;IAEb,cAAS,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC,QAAQ,CAAC;QACxD,KAAK,EAAE,MAAM;KACb,CAAC,CAAC;IAIH,OAAO,IAAA,YAAO,GAAE,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC,CAAC;AAXU,QAAA,wBAAwB,4BAWlC"}

package/dist/context-establishment/context-establishment-hook.d.ts

@@ -0,0 +1,23 @@
+import type { Constructable } from '@n8n/di';
+import type { INode, INodeExecutionData, PlaintextExecutionContext, IWorkflowBase } from 'n8n-workflow';
+export type ContextEstablishmentOptions = {
+    triggerNode: INode;
+    workflow: IWorkflowBase;
+    triggerItems: INodeExecutionData[];
+    context: PlaintextExecutionContext;
+    options?: Record<string, unknown>;
+};
+export type ContextEstablishmentResult = {
+    triggerItems?: INodeExecutionData[];
+    contextUpdate?: Partial<PlaintextExecutionContext>;
+};
+export type HookDescription = {
+    name: string;
+};
+export interface IContextEstablishmentHook {
+    hookDescription: HookDescription;
+    execute(options: ContextEstablishmentOptions): Promise<ContextEstablishmentResult>;
+    isApplicableToTriggerNode(nodeType: string): boolean;
+    init?(): Promise<void>;
+}
+export type ContextEstablishmentHookClass = Constructable<IContextEstablishmentHook>;

package/dist/context-establishment/context-establishment-hook.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=context-establishment-hook.js.map

package/dist/context-establishment/context-establishment-hook.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-establishment-hook.js","sourceRoot":"","sources":["../../src/context-establishment/context-establishment-hook.ts"],"names":[],"mappings":""}

package/dist/context-establishment/index.d.ts

@@ -0,0 +1,2 @@
+export { ContextEstablishmentHookMetadata, ContextEstablishmentHook, } from './context-establishment-hook-metadata';
+export type * from './context-establishment-hook';

package/dist/context-establishment/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContextEstablishmentHook = exports.ContextEstablishmentHookMetadata = void 0;
+var context_establishment_hook_metadata_1 = require("./context-establishment-hook-metadata");
+Object.defineProperty(exports, "ContextEstablishmentHookMetadata", { enumerable: true, get: function () { return context_establishment_hook_metadata_1.ContextEstablishmentHookMetadata; } });
+Object.defineProperty(exports, "ContextEstablishmentHook", { enumerable: true, get: function () { return context_establishment_hook_metadata_1.ContextEstablishmentHook; } });
+//# sourceMappingURL=index.js.map

package/dist/context-establishment/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/context-establishment/index.ts"],"names":[],"mappings":";;;AAAA,6FAG+C;AAF9C,uJAAA,gCAAgC,OAAA;AAChC,+IAAA,wBAAwB,OAAA"}

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export * from './command';
 export { Debounce } from './debounce';
 export * from './execution-lifecycle';
 export { Memoized } from './memoized';
+export * from './context-establishment';
 export * from './module';
 export * from './multi-main';
 export * from './pubsub';

package/dist/index.js

@@ -22,6 +22,7 @@ Object.defineProperty(exports, "Debounce", { enumerable: true, get: function ()
 __exportStar(require("./execution-lifecycle"), exports);
 var memoized_1 = require("./memoized");
 Object.defineProperty(exports, "Memoized", { enumerable: true, get: function () { return memoized_1.Memoized; } });
+__exportStar(require("./context-establishment"), exports);
 __exportStar(require("./module"), exports);
 __exportStar(require("./multi-main"), exports);
 __exportStar(require("./pubsub"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,4CAA0B;AAC1B,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,wDAAsC;AACtC,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,2CAAyB;AACzB,+CAA6B;AAC7B,2CAAyB;AACzB,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,6CAA2B;AAC3B,2DAAyC;AAEzC,iCAAgC;AAAvB,8FAAA,KAAK,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,4CAA0B;AAC1B,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,wDAAsC;AACtC,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,0DAAwC;AACxC,2CAAyB;AACzB,+CAA6B;AAC7B,2CAAyB;AACzB,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,6CAA2B;AAC3B,2DAAyC;AAEzC,iCAAgC;AAAvB,8FAAA,KAAK,OAAA"}

package/dist/module/module-metadata.d.ts

@@ -1,7 +1,9 @@
+import type { InstanceType } from '@n8n/constants';
 import type { LicenseFlag, ModuleClass } from './module';
 type ModuleEntry = {
     class: ModuleClass;
     licenseFlag?: LicenseFlag | LicenseFlag[];
+    instanceTypes?: InstanceType[];
 };
 export declare class ModuleMetadata {
     private readonly modules;

package/dist/module/module-metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"module-metadata.js","sourceRoot":"","sources":["../../src/module/module-metadata.ts"],"names":[],"mappings":";;;;;;;;;AAAA,gCAAkC;AAc3B,IAAM,cAAc,GAApB,MAAM,cAAc;IAApB;QACW,YAAO,GAA6B,IAAI,GAAG,EAAE,CAAC;IAiBhE,CAAC;IAfA,QAAQ,CAAC,UAAkB,EAAE,WAAwB;QACpD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED,GAAG,CAAC,UAAkB;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC;IAED,UAAU;QACT,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,UAAU;QACT,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC/D,CAAC;CACD,CAAA;AAlBY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,YAAO,GAAE;GACG,cAAc,CAkB1B"}
+{"version":3,"file":"module-metadata.js","sourceRoot":"","sources":["../../src/module/module-metadata.ts"],"names":[],"mappings":";;;;;;;;;AACA,gCAAkC;AAe3B,IAAM,cAAc,GAApB,MAAM,cAAc;IAApB;QACW,YAAO,GAA6B,IAAI,GAAG,EAAE,CAAC;IAiBhE,CAAC;IAfA,QAAQ,CAAC,UAAkB,EAAE,WAAwB;QACpD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED,GAAG,CAAC,UAAkB;QACrB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC;IAED,UAAU;QACT,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,UAAU;QACT,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC/D,CAAC;CACD,CAAA;AAlBY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,YAAO,GAAE;GACG,cAAc,CAkB1B"}

package/dist/module/module.d.ts

@@ -1,4 +1,4 @@
-import type { LICENSE_FEATURES } from '@n8n/constants';
+import type { LICENSE_FEATURES, InstanceType } from '@n8n/constants';
 import { type Constructable } from '@n8n/di';
 export interface BaseEntity {
     hasId(): boolean;
@@ -26,7 +26,9 @@ export interface ModuleInterface {
 }
 export type ModuleClass = Constructable<ModuleInterface>;
 export type LicenseFlag = (typeof LICENSE_FEATURES)[keyof typeof LICENSE_FEATURES];
-export declare const BackendModule: (opts: {
+export type BackendModuleOptions = {
     name: string;
     licenseFlag?: LicenseFlag | LicenseFlag[];
-}) => ClassDecorator;
+    instanceTypes?: InstanceType[];
+};
+export declare const BackendModule: (opts: BackendModuleOptions) => ClassDecorator;

package/dist/module/module.js

@@ -7,6 +7,7 @@ const BackendModule = (opts) => (target) => {
     di_1.Container.get(module_metadata_1.ModuleMetadata).register(opts.name, {
         class: target,
         licenseFlag: opts?.licenseFlag,
+        instanceTypes: opts?.instanceTypes,
     });
     return (0, di_1.Service)()(target);
 };

package/dist/module/module.js.map

@@ -1 +1 @@
-{"version":3,"file":"module.js","sourceRoot":"","sources":["../../src/module/module.ts"],"names":[],"mappings":";;;AACA,gCAAiE;AAEjE,uDAAmD;AAkF5C,MAAM,aAAa,GACzB,CAAC,IAAiE,EAAkB,EAAE,CACtF,CAAC,MAAM,EAAE,EAAE;IACV,cAAS,CAAC,GAAG,CAAC,gCAAc,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE;QACjD,KAAK,EAAE,MAAgC;QACvC,WAAW,EAAE,IAAI,EAAE,WAAW;KAC9B,CAAC,CAAC;IAGH,OAAO,IAAA,YAAO,GAAE,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC,CAAC;AAVU,QAAA,aAAa,iBAUvB"}
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../../src/module/module.ts"],"names":[],"mappings":";;;AACA,gCAAiE;AAEjE,uDAAmD;AAgG5C,MAAM,aAAa,GACzB,CAAC,IAA0B,EAAkB,EAAE,CAC/C,CAAC,MAAM,EAAE,EAAE;IACV,cAAS,CAAC,GAAG,CAAC,gCAAc,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE;QACjD,KAAK,EAAE,MAAgC;QACvC,WAAW,EAAE,IAAI,EAAE,WAAW;QAC9B,aAAa,EAAE,IAAI,EAAE,aAAa;KAClC,CAAC,CAAC;IAGH,OAAO,IAAA,YAAO,GAAE,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC,CAAC;AAXU,QAAA,aAAa,iBAWvB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@n8n/decorators",
-  "version": "0.31.1",
+  "version": "0.32.0",
   "main": "dist/index.js",
   "module": "src/index.ts",
   "types": "dist/index.d.ts",
@@ -17,9 +17,9 @@
   "dependencies": {
     "lodash": "4.17.21",
     "@n8n/constants": "^0.14.0",
-    "@n8n/di": "^0.9.0",
-    "@n8n/permissions": "^0.42.0",
-    "n8n-workflow": "^1.118.1"
+    "@n8n/di": "^0.10.0",
+    "n8n-workflow": "^1.119.0",
+    "@n8n/permissions": "^0.43.0"
   },
   "license": "SEE LICENSE IN LICENSE.md",
   "homepage": "https://n8n.io",
@@ -42,6 +42,7 @@
     "lint:fix": "eslint . --fix",
     "watch": "tsc -p tsconfig.build.json --watch",
     "test": "jest",
+    "test:unit": "jest",
     "test:dev": "jest --watch"
   }
 }