@n8n/decorators 0.11.0 → 0.12.0

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

@@ -0,0 +1,7 @@
+import type { CommandEntry } from './types';
+export declare class CommandMetadata {
+    private readonly commands;
+    register(name: string, entry: CommandEntry): void;
+    get(name: string): CommandEntry | undefined;
+    getEntries(): [string, CommandEntry][];
+}

package/dist/command/command-metadata.js

@@ -0,0 +1,29 @@
+"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.CommandMetadata = void 0;
+const di_1 = require("@n8n/di");
+let CommandMetadata = class CommandMetadata {
+    constructor() {
+        this.commands = new Map();
+    }
+    register(name, entry) {
+        this.commands.set(name, entry);
+    }
+    get(name) {
+        return this.commands.get(name);
+    }
+    getEntries() {
+        return [...this.commands.entries()];
+    }
+};
+exports.CommandMetadata = CommandMetadata;
+exports.CommandMetadata = CommandMetadata = __decorate([
+    (0, di_1.Service)()
+], CommandMetadata);
+//# sourceMappingURL=command-metadata.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"command-metadata.js","sourceRoot":"","sources":["../../src/command/command-metadata.ts"],"names":[],"mappings":";;;;;;;;;AAAA,gCAAkC;AAK3B,IAAM,eAAe,GAArB,MAAM,eAAe;IAArB;QACW,aAAQ,GAA8B,IAAI,GAAG,EAAE,CAAC;IAalE,CAAC;IAXA,QAAQ,CAAC,IAAY,EAAE,KAAmB;QACzC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAChC,CAAC;IAED,GAAG,CAAC,IAAY;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,UAAU;QACT,OAAO,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACrC,CAAC;CACD,CAAA;AAdY,0CAAe;0BAAf,eAAe;IAD3B,IAAA,YAAO,GAAE;GACG,eAAe,CAc3B"}

package/dist/command/command.d.ts

@@ -0,0 +1,2 @@
+import type { CommandOptions } from './types';
+export declare const Command: ({ name, description, examples, flagsSchema }: CommandOptions) => ClassDecorator;

package/dist/command/command.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Command = void 0;
+const di_1 = require("@n8n/di");
+const command_metadata_1 = require("./command-metadata");
+const Command = ({ name, description, examples, flagsSchema }) => (target) => {
+    const commandClass = target;
+    di_1.Container.get(command_metadata_1.CommandMetadata).register(name, {
+        description,
+        flagsSchema,
+        class: commandClass,
+        examples,
+    });
+    return (0, di_1.Service)()(target);
+};
+exports.Command = Command;
+//# sourceMappingURL=command.js.map

package/dist/command/command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/command/command.ts"],"names":[],"mappings":";;;AAAA,gCAA6C;AAE7C,yDAAqD;AAG9C,MAAM,OAAO,GACnB,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAkB,EAAkB,EAAE,CACjF,CAAC,MAAM,EAAE,EAAE;IACV,MAAM,YAAY,GAAG,MAAiC,CAAC;IACvD,cAAS,CAAC,GAAG,CAAC,kCAAe,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE;QAC7C,WAAW;QACX,WAAW;QACX,KAAK,EAAE,YAAY;QACnB,QAAQ;KACR,CAAC,CAAC;IAEH,OAAO,IAAA,YAAO,GAAE,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC,CAAC;AAZU,QAAA,OAAO,WAYjB"}

package/dist/command/index.d.ts

@@ -0,0 +1,3 @@
+export { Command } from './command';
+export { CommandMetadata } from './command-metadata';
+export type { ICommand, CommandClass, CommandEntry } from './types';

package/dist/command/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommandMetadata = exports.Command = void 0;
+var command_1 = require("./command");
+Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return command_1.Command; } });
+var command_metadata_1 = require("./command-metadata");
+Object.defineProperty(exports, "CommandMetadata", { enumerable: true, get: function () { return command_metadata_1.CommandMetadata; } });
+//# sourceMappingURL=index.js.map

package/dist/command/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/command/index.ts"],"names":[],"mappings":";;;AAAA,qCAAoC;AAA3B,kGAAA,OAAO,OAAA;AAChB,uDAAqD;AAA5C,mHAAA,eAAe,OAAA"}

package/dist/command/types.d.ts

@@ -0,0 +1,24 @@
+import type { Constructable } from '@n8n/di';
+import type { ZodObject, ZodTypeAny } from 'zod';
+type FlagsSchema = ZodObject<Record<string, ZodTypeAny>>;
+export type CommandOptions = {
+    name: string;
+    description: string;
+    examples?: string[];
+    flagsSchema?: FlagsSchema;
+};
+export type ICommand = {
+    flags?: object;
+    init?: () => Promise<void>;
+    run: () => Promise<void>;
+    catch?: (e: Error) => Promise<void>;
+    finally?: (e?: Error) => Promise<void>;
+};
+export type CommandClass = Constructable<ICommand>;
+export type CommandEntry = {
+    class: CommandClass;
+    description: string;
+    examples?: string[];
+    flagsSchema?: FlagsSchema;
+};
+export {};

package/dist/command/types.js

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

package/dist/command/types.js.map

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

package/dist/controller/route.d.ts

@@ -4,6 +4,7 @@ interface RouteOptions {
     middlewares?: RequestHandler[];
     usesTemplates?: boolean;
     skipAuth?: boolean;
+    allowSkipMFA?: boolean;
     rateLimit?: boolean | RateLimit;
 }
 export declare const Get: (path: `/${string}`, options?: RouteOptions) => MethodDecorator;

package/dist/controller/route.js

@@ -10,6 +10,7 @@ const RouteFactory = (method) => (path, options = {}) => (target, handlerName) =
     routeMetadata.middlewares = options.middlewares ?? [];
     routeMetadata.usesTemplates = options.usesTemplates ?? false;
     routeMetadata.skipAuth = options.skipAuth ?? false;
+    routeMetadata.allowSkipMFA = options.allowSkipMFA ?? false;
     routeMetadata.rateLimit = options.rateLimit;
 };
 exports.Get = RouteFactory('get');

package/dist/controller/route.js.map

@@ -1 +1 @@
-{"version":3,"file":"route.js","sourceRoot":"","sources":["../../src/controller/route.ts"],"names":[],"mappings":";;;AAAA,gCAAoC;AAGpC,iFAA4E;AAY5E,MAAM,YAAY,GACjB,CAAC,MAAc,EAAE,EAAE,CACnB,CAAC,IAAkB,EAAE,UAAwB,EAAE,EAAmB,EAAE,CACpE,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE;IACvB,MAAM,aAAa,GAAG,cAAS,CAAC,GAAG,CAAC,yDAA0B,CAAC,CAAC,gBAAgB,CAC/E,MAAM,CAAC,WAAyB,EAChC,MAAM,CAAC,WAAW,CAAC,CACnB,CAAC;IACF,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC;IAC9B,aAAa,CAAC,IAAI,GAAG,IAAI,CAAC;IAC1B,aAAa,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC;IACtD,aAAa,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,KAAK,CAAC;IAC7D,aAAa,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAC;IACnD,aAAa,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;AAC7C,CAAC,CAAC;AAEU,QAAA,GAAG,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;AAC1B,QAAA,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;AAC5B,QAAA,GAAG,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;AAC1B,QAAA,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;AAC9B,QAAA,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC"}
+{"version":3,"file":"route.js","sourceRoot":"","sources":["../../src/controller/route.ts"],"names":[],"mappings":";;;AAAA,gCAAoC;AAGpC,iFAA4E;AAc5E,MAAM,YAAY,GACjB,CAAC,MAAc,EAAE,EAAE,CACnB,CAAC,IAAkB,EAAE,UAAwB,EAAE,EAAmB,EAAE,CACpE,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE;IACvB,MAAM,aAAa,GAAG,cAAS,CAAC,GAAG,CAAC,yDAA0B,CAAC,CAAC,gBAAgB,CAC/E,MAAM,CAAC,WAAyB,EAChC,MAAM,CAAC,WAAW,CAAC,CACnB,CAAC;IACF,aAAa,CAAC,MAAM,GAAG,MAAM,CAAC;IAC9B,aAAa,CAAC,IAAI,GAAG,IAAI,CAAC;IAC1B,aAAa,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC;IACtD,aAAa,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,KAAK,CAAC;IAC7D,aAAa,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,KAAK,CAAC;IACnD,aAAa,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,KAAK,CAAC;IAC3D,aAAa,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;AAC7C,CAAC,CAAC;AAEU,QAAA,GAAG,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;AAC1B,QAAA,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;AAC5B,QAAA,GAAG,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;AAC1B,QAAA,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;AAC9B,QAAA,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC"}

package/dist/controller/types.d.ts

@@ -24,6 +24,7 @@ export interface RouteMetadata {
     middlewares: RequestHandler[];
     usesTemplates: boolean;
     skipAuth: boolean;
+    allowSkipMFA: boolean;
     rateLimit?: boolean | RateLimit;
     licenseFeature?: BooleanLicenseFeature;
     accessScope?: AccessScope;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './controller';
+export * from './command';
 export { Debounce } from './debounce';
 export * from './execution-lifecycle';
 export { Memoized } from './memoized';

package/dist/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redactable = exports.Memoized = exports.Debounce = void 0;
 __exportStar(require("./controller"), exports);
+__exportStar(require("./command"), exports);
 var debounce_1 = require("./debounce");
 Object.defineProperty(exports, "Debounce", { enumerable: true, get: function () { return debounce_1.Debounce; } });
 __exportStar(require("./execution-lifecycle"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,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"}
+{"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"}

package/dist/module/module.d.ts

@@ -12,7 +12,7 @@ export type EntityClass = new () => BaseEntity;
 export type ModuleSettings = Record<string, unknown>;
 export interface ModuleInterface {
     init?(): Promise<void>;
-    entities?(): EntityClass[];
+    entities?(): Promise<EntityClass[]>;
     settings?(): Promise<ModuleSettings>;
 }
 export type ModuleClass = Constructable<ModuleInterface>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@n8n/decorators",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "main": "dist/index.js",
   "module": "src/index.ts",
   "types": "dist/index.d.ts",
@@ -12,14 +12,14 @@
   "devDependencies": {
     "@types/express": "^5.0.1",
     "@types/lodash": "^4.17.17",
-    "@n8n/typescript-config": "1.2.0"
+    "@n8n/typescript-config": "1.3.0"
   },
   "dependencies": {
     "lodash": "4.17.21",
-    "@n8n/constants": "^0.8.0",
-    "@n8n/permissions": "^0.29.0",
-    "@n8n/di": "^0.7.0",
-    "n8n-workflow": "^1.98.0"
+    "@n8n/constants": "^0.9.0",
+    "@n8n/permissions": "^0.30.0",
+    "n8n-workflow": "^1.99.0",
+    "@n8n/di": "^0.8.0"
   },
   "license": "SEE LICENSE IN LICENSE.md",
   "homepage": "https://n8n.io",