@n8n/decorators 0.2.0

package/dist/types.d.ts

@@ -0,0 +1,45 @@
+import type { BooleanLicenseFeature } from '@n8n/constants';
+import type { Constructable } from '@n8n/di';
+import type { Scope } from '@n8n/permissions';
+import type { RequestHandler } from 'express';
+export type Method = 'get' | 'post' | 'put' | 'patch' | 'delete';
+export type Arg = {
+    type: 'body' | 'query';
+} | {
+    type: 'param';
+    key: string;
+};
+export interface RateLimit {
+    limit?: number;
+    windowMs?: number;
+}
+export type HandlerName = string;
+export interface AccessScope {
+    scope: Scope;
+    globalOnly: boolean;
+}
+export interface RouteMetadata {
+    method: Method;
+    path: string;
+    middlewares: RequestHandler[];
+    usesTemplates: boolean;
+    skipAuth: boolean;
+    rateLimit?: boolean | RateLimit;
+    licenseFeature?: BooleanLicenseFeature;
+    accessScope?: AccessScope;
+    args: Arg[];
+}
+export interface ControllerMetadata {
+    basePath: `/${string}`;
+    middlewares: HandlerName[];
+    routes: Map<HandlerName, RouteMetadata>;
+}
+export type Controller = Constructable<object> & Record<HandlerName, (...args: unknown[]) => Promise<unknown>>;
+type RouteHandlerFn = () => Promise<void> | void;
+export type Class<T = object, A extends unknown[] = unknown[]> = new (...args: A) => T;
+export type ServiceClass = Class<Record<string, RouteHandlerFn>>;
+export interface ShutdownHandler {
+    serviceClass: ServiceClass;
+    methodName: string;
+}
+export {};

package/dist/types.js

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

package/dist/types.js.map

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

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@n8n/decorators",
+  "version": "0.2.0",
+  "main": "dist/index.js",
+  "module": "src/index.ts",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/**/*",
+    "LICENSE.md",
+    "LICENSE_EE.md"
+  ],
+  "devDependencies": {
+    "@types/express": "^5.0.1",
+    "@types/lodash": "^4.14.195",
+    "@n8n/typescript-config": "1.2.0"
+  },
+  "dependencies": {
+    "lodash": "4.17.21",
+    "@n8n/constants": "^0.2.0",
+    "@n8n/di": "^0.5.0",
+    "n8n-workflow": "^1.89.0",
+    "@n8n/permissions": "^0.22.0"
+  },
+  "license": "SEE LICENSE IN LICENSE.md",
+  "homepage": "https://n8n.io",
+  "author": {
+    "name": "Jan Oberhauser",
+    "email": "jan@n8n.io"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/n8n-io/n8n.git"
+  },
+  "scripts": {
+    "clean": "rimraf dist .turbo",
+    "dev": "pnpm watch",
+    "typecheck": "tsc --noEmit",
+    "build": "tsc -p tsconfig.build.json",
+    "format": "biome format --write .",
+    "format:check": "biome ci .",
+    "lint": "eslint .",
+    "lintfix": "eslint . --fix",
+    "watch": "tsc -p tsconfig.build.json --watch",
+    "test": "jest",
+    "test:dev": "jest --watch"
+  }
+}