@n8n/decorators 1.5.1 → 1.6.1

package/dist/controller/index.d.ts

@@ -6,4 +6,5 @@ export { Middleware } from './middleware';
 export { ControllerRegistryMetadata } from './controller-registry-metadata';
 export { Licensed } from './licensed';
 export { GlobalScope, ProjectScope } from './scoped';
-export type { AccessScope, Controller, CorsOptions, Method, RateLimit, StaticRouterMetadata, } from './types';
+export type { AccessScope, Controller, CorsOptions, Method, StaticRouterMetadata, } from './types';
+export { type RateLimiterLimits, type BodyKeyedRateLimiterConfig, type UserKeyedRateLimiterConfig, type KeyedRateLimiterConfig, createBodyKeyedRateLimiter, createUserKeyedRateLimiter, } from './rate-limit';

package/dist/controller/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProjectScope = exports.GlobalScope = exports.Licensed = exports.ControllerRegistryMetadata = exports.Middleware = exports.Options = exports.Head = exports.Delete = exports.Patch = exports.Put = exports.Post = exports.Get = exports.RootLevelController = exports.RestController = exports.Param = exports.Query = exports.Body = void 0;
+exports.createUserKeyedRateLimiter = exports.createBodyKeyedRateLimiter = exports.ProjectScope = exports.GlobalScope = exports.Licensed = exports.ControllerRegistryMetadata = exports.Middleware = exports.Options = exports.Head = exports.Delete = exports.Patch = exports.Put = exports.Post = exports.Get = exports.RootLevelController = exports.RestController = exports.Param = exports.Query = exports.Body = void 0;
 var args_1 = require("./args");
 Object.defineProperty(exports, "Body", { enumerable: true, get: function () { return args_1.Body; } });
 Object.defineProperty(exports, "Query", { enumerable: true, get: function () { return args_1.Query; } });
@@ -26,4 +26,7 @@ Object.defineProperty(exports, "Licensed", { enumerable: true, get: function ()
 var scoped_1 = require("./scoped");
 Object.defineProperty(exports, "GlobalScope", { enumerable: true, get: function () { return scoped_1.GlobalScope; } });
 Object.defineProperty(exports, "ProjectScope", { enumerable: true, get: function () { return scoped_1.ProjectScope; } });
+var rate_limit_1 = require("./rate-limit");
+Object.defineProperty(exports, "createBodyKeyedRateLimiter", { enumerable: true, get: function () { return rate_limit_1.createBodyKeyedRateLimiter; } });
+Object.defineProperty(exports, "createUserKeyedRateLimiter", { enumerable: true, get: function () { return rate_limit_1.createUserKeyedRateLimiter; } });
 //# sourceMappingURL=index.js.map

package/dist/controller/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/controller/index.ts"],"names":[],"mappings":";;;AAAA,+BAA4C;AAAnC,4FAAA,IAAI,OAAA;AAAE,6FAAA,KAAK,OAAA;AAAE,6FAAA,KAAK,OAAA;AAC3B,qDAAmD;AAA1C,iHAAA,cAAc,OAAA;AACvB,iEAA8D;AAArD,4HAAA,mBAAmB,OAAA;AAC5B,iCAAuE;AAA9D,4FAAA,GAAG,OAAA;AAAE,6FAAA,IAAI,OAAA;AAAE,4FAAA,GAAG,OAAA;AAAE,8FAAA,KAAK,OAAA;AAAE,+FAAA,MAAM,OAAA;AAAE,6FAAA,IAAI,OAAA;AAAE,gGAAA,OAAO,OAAA;AACrD,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,+EAA4E;AAAnE,0IAAA,0BAA0B,OAAA;AACnC,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,mCAAqD;AAA5C,qGAAA,WAAW,OAAA;AAAE,sGAAA,YAAY,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/controller/index.ts"],"names":[],"mappings":";;;AAAA,+BAA4C;AAAnC,4FAAA,IAAI,OAAA;AAAE,6FAAA,KAAK,OAAA;AAAE,6FAAA,KAAK,OAAA;AAC3B,qDAAmD;AAA1C,iHAAA,cAAc,OAAA;AACvB,iEAA8D;AAArD,4HAAA,mBAAmB,OAAA;AAC5B,iCAAuE;AAA9D,4FAAA,GAAG,OAAA;AAAE,6FAAA,IAAI,OAAA;AAAE,4FAAA,GAAG,OAAA;AAAE,8FAAA,KAAK,OAAA;AAAE,+FAAA,MAAM,OAAA;AAAE,6FAAA,IAAI,OAAA;AAAE,gGAAA,OAAO,OAAA;AACrD,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,+EAA4E;AAAnE,0IAAA,0BAA0B,OAAA;AACnC,uCAAsC;AAA7B,oGAAA,QAAQ,OAAA;AACjB,mCAAqD;AAA5C,qGAAA,WAAW,OAAA;AAAE,sGAAA,YAAY,OAAA;AAQlC,2CAOsB;AAFrB,wHAAA,0BAA0B,OAAA;AAC1B,wHAAA,0BAA0B,OAAA"}

package/dist/controller/rate-limit.d.ts

@@ -0,0 +1,16 @@
+export interface RateLimiterLimits {
+    limit?: number;
+    windowMs?: number;
+}
+export interface BodyKeyedRateLimiterConfig extends RateLimiterLimits {
+    source: 'body';
+    field: string;
+}
+export interface UserKeyedRateLimiterConfig extends RateLimiterLimits {
+    source: 'user';
+}
+export type KeyedRateLimiterConfig = BodyKeyedRateLimiterConfig | UserKeyedRateLimiterConfig;
+export declare const createBodyKeyedRateLimiter: <T extends object>({ limit, windowMs, field, }: RateLimiterLimits & {
+    field: keyof T & string;
+}) => BodyKeyedRateLimiterConfig;
+export declare const createUserKeyedRateLimiter: ({ limit, windowMs, }: RateLimiterLimits) => UserKeyedRateLimiterConfig;

package/dist/controller/rate-limit.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createUserKeyedRateLimiter = exports.createBodyKeyedRateLimiter = void 0;
+const createBodyKeyedRateLimiter = ({ limit, windowMs, field, }) => ({
+    source: 'body',
+    limit,
+    windowMs,
+    field,
+});
+exports.createBodyKeyedRateLimiter = createBodyKeyedRateLimiter;
+const createUserKeyedRateLimiter = ({ limit, windowMs, }) => ({
+    source: 'user',
+    limit,
+    windowMs,
+});
+exports.createUserKeyedRateLimiter = createUserKeyedRateLimiter;
+//# sourceMappingURL=rate-limit.js.map

package/dist/controller/rate-limit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limit.js","sourceRoot":"","sources":["../../src/controller/rate-limit.ts"],"names":[],"mappings":";;;AA6CO,MAAM,0BAA0B,GAAG,CAAmB,EAC5D,KAAK,EACL,QAAQ,EACR,KAAK,GAGL,EAA8B,EAAE,CAAC,CAAC;IAClC,MAAM,EAAE,MAAM;IACd,KAAK;IACL,QAAQ;IACR,KAAK;CACL,CAAC,CAAC;AAXU,QAAA,0BAA0B,8BAWpC;AAYI,MAAM,0BAA0B,GAAG,CAAC,EAC1C,KAAK,EACL,QAAQ,GACW,EAA8B,EAAE,CAAC,CAAC;IACrD,MAAM,EAAE,MAAM;IACd,KAAK;IACL,QAAQ;CACR,CAAC,CAAC;AAPU,QAAA,0BAA0B,8BAOpC"}

package/dist/controller/route.d.ts

@@ -1,12 +1,14 @@
 import type { RequestHandler } from 'express';
-import type { CorsOptions, RateLimit } from './types';
+import type { KeyedRateLimiterConfig, RateLimiterLimits } from './rate-limit';
+import type { CorsOptions } from './types';
 interface RouteOptions {
     middlewares?: RequestHandler[];
     usesTemplates?: boolean;
     skipAuth?: boolean;
     allowSkipPreviewAuth?: boolean;
     allowSkipMFA?: boolean;
-    rateLimit?: boolean | RateLimit;
+    ipRateLimit?: boolean | RateLimiterLimits;
+    keyedRateLimit?: KeyedRateLimiterConfig;
     apiKeyAuth?: boolean;
     cors?: Partial<CorsOptions> | true;
 }

package/dist/controller/route.js

@@ -13,7 +13,8 @@ const RouteFactory = (method) => (path, options = {}) => (target, handlerName) =
     routeMetadata.allowSkipPreviewAuth = options.allowSkipPreviewAuth ?? false;
     routeMetadata.allowSkipMFA = options.allowSkipMFA ?? false;
     routeMetadata.apiKeyAuth = options.apiKeyAuth ?? false;
-    routeMetadata.rateLimit = options.rateLimit;
+    routeMetadata.ipRateLimit = options.ipRateLimit;
+    routeMetadata.keyedRateLimit = options.keyedRateLimit;
     routeMetadata.cors = options.cors;
 };
 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;AAmB5E,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,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,IAAI,KAAK,CAAC;IAC3E,aAAa,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,KAAK,CAAC;IAC3D,aAAa,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,KAAK,CAAC;IACvD,aAAa,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAC5C,aAAa,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;AACnC,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;AAChC,QAAA,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;AAC5B,QAAA,OAAO,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC"}
+{"version":3,"file":"route.js","sourceRoot":"","sources":["../../src/controller/route.ts"],"names":[],"mappings":";;;AAAA,gCAAoC;AAGpC,iFAA4E;AAsB5E,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,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,IAAI,KAAK,CAAC;IAC3E,aAAa,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,KAAK,CAAC;IAC3D,aAAa,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,KAAK,CAAC;IACvD,aAAa,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAChD,aAAa,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IACtD,aAAa,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;AACnC,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;AAChC,QAAA,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;AAC5B,QAAA,OAAO,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC"}

package/dist/controller/types.d.ts

@@ -2,6 +2,7 @@ import type { BooleanLicenseFeature } from '@n8n/constants';
 import type { Constructable } from '@n8n/di';
 import type { Scope } from '@n8n/permissions';
 import type { RequestHandler, Router } from 'express';
+import type { KeyedRateLimiterConfig, RateLimiterLimits } from './rate-limit';
 export type Method = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'head' | 'options';
 export type Arg = {
     type: 'body' | 'query';
@@ -16,10 +17,6 @@ export interface CorsOptions {
     allowCredentials?: boolean;
     maxAge?: number;
 }
-export interface RateLimit {
-    limit?: number;
-    windowMs?: number;
-}
 export type HandlerName = string;
 export interface AccessScope {
     scope: Scope;
@@ -35,7 +32,8 @@ export interface RouteMetadata {
     allowSkipMFA: boolean;
     apiKeyAuth: boolean;
     cors?: Partial<CorsOptions> | true;
-    rateLimit?: boolean | RateLimit;
+    ipRateLimit?: boolean | RateLimiterLimits;
+    keyedRateLimit?: KeyedRateLimiterConfig;
     licenseFeature?: BooleanLicenseFeature;
     accessScope?: AccessScope;
     args: Arg[];
@@ -44,7 +42,7 @@ export interface RouteMetadata {
 export type StaticRouterMetadata = {
     path: string;
     router: Router;
-} & Partial<Pick<RouteMetadata, 'skipAuth' | 'allowSkipPreviewAuth' | 'allowSkipMFA' | 'middlewares' | 'rateLimit' | 'licenseFeature' | 'accessScope'>>;
+} & Partial<Pick<RouteMetadata, 'skipAuth' | 'allowSkipPreviewAuth' | 'allowSkipMFA' | 'middlewares' | 'ipRateLimit' | 'keyedRateLimit' | 'licenseFeature' | 'accessScope'>>;
 export interface ControllerMetadata {
     basePath: `/${string}`;
     registerOnRootPath?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@n8n/decorators",
-  "version": "1.5.1",
+  "version": "1.6.1",
   "main": "dist/index.js",
   "module": "src/index.ts",
   "types": "dist/index.d.ts",
@@ -12,14 +12,17 @@
   "devDependencies": {
     "@types/express": "^5.0.1",
     "@types/lodash": "4.17.17",
-    "@n8n/typescript-config": "1.3.0"
+    "vitest": "^3.1.3",
+    "zod": "3.25.67",
+    "@n8n/typescript-config": "1.3.0",
+    "@n8n/vitest-config": "1.6.0"
   },
   "dependencies": {
-    "lodash": "4.17.21",
+    "lodash": "4.17.23",
+    "@n8n/di": "0.10.0",
     "@n8n/constants": "0.16.0",
-    "@n8n/permissions": "0.47.0",
-    "n8n-workflow": "2.5.1",
-    "@n8n/di": "0.10.0"
+    "@n8n/permissions": "0.47.1",
+    "n8n-workflow": "2.6.1"
   },
   "license": "SEE LICENSE IN LICENSE.md",
   "homepage": "https://n8n.io",
@@ -41,8 +44,8 @@
     "lint": "eslint . --quiet",
     "lint:fix": "eslint . --fix",
     "watch": "tsc -p tsconfig.build.json --watch",
-    "test": "jest",
-    "test:unit": "jest",
-    "test:dev": "jest --watch"
+    "test": "vitest run",
+    "test:unit": "vitest run",
+    "test:dev": "vitest"
   }
 }