@atom8n/n8n 2.2.0

package/dist/push/origin-validator.js

@@ -0,0 +1,145 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateOriginHeaders = validateOriginHeaders;
+function validateOriginHeaders(headers) {
+    const originInfo = parseOrigin(headers.origin ?? '');
+    if (!originInfo) {
+        return {
+            isValid: false,
+            error: 'Origin header is missing or malformed',
+        };
+    }
+    let rawExpectedHost;
+    let expectedProtocol = originInfo.protocol;
+    const forwarded = parseForwardedHeader(headers.forwarded ?? '');
+    if (forwarded?.host) {
+        rawExpectedHost = forwarded.host;
+        if (forwarded.proto) {
+            const validatedProto = validateProtocol(forwarded.proto);
+            if (validatedProto) {
+                expectedProtocol = validatedProto;
+            }
+        }
+    }
+    else {
+        const xForwardedHost = getFirstHeaderValue(headers['x-forwarded-host']);
+        if (xForwardedHost) {
+            rawExpectedHost = xForwardedHost;
+            const xForwardedProto = getFirstHeaderValue(headers['x-forwarded-proto']);
+            if (xForwardedProto) {
+                const validatedProto = validateProtocol(xForwardedProto.split(',')[0]?.trim());
+                if (validatedProto) {
+                    expectedProtocol = validatedProto;
+                }
+            }
+        }
+        else {
+            rawExpectedHost = headers.host;
+        }
+    }
+    const normalizedExpectedHost = normalizeHost(rawExpectedHost ?? '', expectedProtocol);
+    const isValid = normalizedExpectedHost === originInfo.host;
+    return {
+        isValid,
+        originInfo,
+        expectedHost: normalizedExpectedHost,
+        expectedProtocol,
+        rawExpectedHost,
+        error: isValid ? undefined : 'Origin header does not match expected host',
+    };
+}
+function normalizeHost(host, protocol) {
+    if (!host)
+        return host;
+    try {
+        const url = new URL(`${protocol}://${host}`);
+        const defaultPort = protocol === 'https' ? '443' : '80';
+        const actualPort = url.port || defaultPort;
+        if (actualPort === defaultPort) {
+            return stripIPv6Brackets(url.hostname);
+        }
+        return stripIPv6Brackets(url.host);
+    }
+    catch {
+        return host;
+    }
+}
+function stripIPv6Brackets(hostname) {
+    if (hostname.startsWith('[') && hostname.includes(']:')) {
+        const closingBracket = hostname.indexOf(']:');
+        const ipv6 = hostname.slice(1, closingBracket);
+        const port = hostname.slice(closingBracket + 2);
+        return `${ipv6}:${port}`;
+    }
+    if (hostname.startsWith('[') && hostname.endsWith(']')) {
+        return hostname.slice(1, -1);
+    }
+    return hostname;
+}
+function getFirstHeaderValue(header) {
+    if (!header)
+        return undefined;
+    if (typeof header === 'string')
+        return header;
+    return header[0];
+}
+function validateProtocol(proto) {
+    if (!proto)
+        return undefined;
+    const normalized = proto.toLowerCase().trim();
+    return normalized === 'http' || normalized === 'https' ? normalized : undefined;
+}
+function parseForwardedHeader(forwardedHeader) {
+    if (!forwardedHeader || typeof forwardedHeader !== 'string') {
+        return null;
+    }
+    try {
+        const firstEntry = forwardedHeader.split(',')[0]?.trim();
+        if (!firstEntry)
+            return null;
+        const result = {};
+        const pairs = firstEntry.split(';');
+        for (const pair of pairs) {
+            const [key, value] = pair.split('=', 2);
+            if (!key || !value)
+                continue;
+            const cleanKey = key.trim().toLowerCase();
+            const cleanValue = value.trim().replace(/^["']|["']$/g, '');
+            if (cleanKey === 'host') {
+                result.host = cleanValue;
+            }
+            else if (cleanKey === 'proto') {
+                result.proto = cleanValue;
+            }
+        }
+        return result;
+    }
+    catch {
+        return null;
+    }
+}
+function parseOrigin(origin) {
+    if (!origin || typeof origin !== 'string') {
+        return null;
+    }
+    try {
+        const url = new URL(origin);
+        const protocol = url.protocol.toLowerCase();
+        if (protocol !== 'http:' && protocol !== 'https:') {
+            return null;
+        }
+        const protocolName = protocol === 'https:' ? 'https' : 'http';
+        const defaultPort = protocolName === 'https' ? '443' : '80';
+        const actualPort = url.port || defaultPort;
+        const rawHost = actualPort === defaultPort ? url.hostname : url.host;
+        const normalizedHost = stripIPv6Brackets(rawHost);
+        return {
+            protocol: protocolName,
+            host: normalizedHost,
+        };
+    }
+    catch {
+        return null;
+    }
+}
+//# sourceMappingURL=origin-validator.js.map

package/dist/push/origin-validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"origin-validator.js","sourceRoot":"","sources":["../../src/push/origin-validator.ts"],"names":[],"mappings":";;AAkBA,sDA0DC;AA1DD,SAAgB,qBAAqB,CAAC,OAA2B;IAEhE,MAAM,UAAU,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;IAErD,IAAI,CAAC,UAAU,EAAE,CAAC;QACjB,OAAO;YACN,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,uCAAuC;SAC9C,CAAC;IACH,CAAC;IAGD,IAAI,eAAmC,CAAC;IACxC,IAAI,gBAAgB,GAAG,UAAU,CAAC,QAAQ,CAAC;IAG3C,MAAM,SAAS,GAAG,oBAAoB,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC;IAChE,IAAI,SAAS,EAAE,IAAI,EAAE,CAAC;QACrB,eAAe,GAAG,SAAS,CAAC,IAAI,CAAC;QACjC,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;YACrB,MAAM,cAAc,GAAG,gBAAgB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YACzD,IAAI,cAAc,EAAE,CAAC;gBACpB,gBAAgB,GAAG,cAAc,CAAC;YACnC,CAAC;QACF,CAAC;IACF,CAAC;SAEI,CAAC;QACL,MAAM,cAAc,GAAG,mBAAmB,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC;QACxE,IAAI,cAAc,EAAE,CAAC;YACpB,eAAe,GAAG,cAAc,CAAC;YACjC,MAAM,eAAe,GAAG,mBAAmB,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC;YAC1E,IAAI,eAAe,EAAE,CAAC;gBACrB,MAAM,cAAc,GAAG,gBAAgB,CAAC,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC/E,IAAI,cAAc,EAAE,CAAC;oBACpB,gBAAgB,GAAG,cAAc,CAAC;gBACnC,CAAC;YACF,CAAC;QACF,CAAC;aAEI,CAAC;YACL,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;QAChC,CAAC;IACF,CAAC;IAGD,MAAM,sBAAsB,GAAG,aAAa,CAAC,eAAe,IAAI,EAAE,EAAE,gBAAgB,CAAC,CAAC;IAEtF,MAAM,OAAO,GAAG,sBAAsB,KAAK,UAAU,CAAC,IAAI,CAAC;IAE3D,OAAO;QACN,OAAO;QACP,UAAU;QACV,YAAY,EAAE,sBAAsB;QACpC,gBAAgB;QAChB,eAAe;QACf,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,4CAA4C;KACzE,CAAC;AACH,CAAC;AAUD,SAAS,aAAa,CAAC,IAAY,EAAE,QAA0B;IAC9D,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAC;IAEvB,IAAI,CAAC;QAGJ,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,QAAQ,MAAM,IAAI,EAAE,CAAC,CAAC;QAK7C,MAAM,WAAW,GAAG,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QACxD,MAAM,UAAU,GAAG,GAAG,CAAC,IAAI,IAAI,WAAW,CAAC;QAG3C,IAAI,UAAU,KAAK,WAAW,EAAE,CAAC;YAChC,OAAO,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACxC,CAAC;QAGD,OAAO,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAAC,MAAM,CAAC;QAER,OAAO,IAAI,CAAC;IACb,CAAC;AACF,CAAC;AASD,SAAS,iBAAiB,CAAC,QAAgB;IAE1C,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACzD,MAAM,cAAc,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;QAC/C,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC;QAChD,OAAO,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC;IAC1B,CAAC;IAED,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACxD,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC9B,CAAC;IACD,OAAO,QAAQ,CAAC;AACjB,CAAC;AAQD,SAAS,mBAAmB,CAAC,MAAqC;IACjE,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAC9B,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC;IAC9C,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAQD,SAAS,gBAAgB,CAAC,KAAyB;IAClD,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;IAC9C,OAAO,UAAU,KAAK,MAAM,IAAI,UAAU,KAAK,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;AACjF,CAAC;AAQD,SAAS,oBAAoB,CAAC,eAAuB;IACpD,IAAI,CAAC,eAAe,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;QAC7D,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAI,CAAC;QAEJ,MAAM,UAAU,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;QACzD,IAAI,CAAC,UAAU;YAAE,OAAO,IAAI,CAAC;QAE7B,MAAM,MAAM,GAAsC,EAAE,CAAC;QAGrD,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACpC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YAC1B,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACxC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK;gBAAE,SAAS;YAE7B,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YAC1C,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;YAE5D,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;gBACzB,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC;YAC1B,CAAC;iBAAM,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;gBACjC,MAAM,CAAC,KAAK,GAAG,UAAU,CAAC;YAC3B,CAAC;QACF,CAAC;QAED,OAAO,MAAM,CAAC;IACf,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,IAAI,CAAC;IACb,CAAC;AACF,CAAC;AAQD,SAAS,WAAW,CAAC,MAAc;IAClC,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC3C,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAI,CAAC;QACJ,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;QAC5B,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QAE5C,IAAI,QAAQ,KAAK,OAAO,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC;QACb,CAAC;QAED,MAAM,YAAY,GAAG,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;QAG9D,MAAM,WAAW,GAAG,YAAY,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5D,MAAM,UAAU,GAAG,GAAG,CAAC,IAAI,IAAI,WAAW,CAAC;QAE3C,MAAM,OAAO,GAAG,UAAU,KAAK,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;QACrE,MAAM,cAAc,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAElD,OAAO;YACN,QAAQ,EAAE,YAAY;YACtB,IAAI,EAAE,cAAc;SACpB,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QAER,OAAO,IAAI,CAAC;IACb,CAAC;AACF,CAAC"}

package/dist/push/push.config.d.ts

@@ -0,0 +1,3 @@
+export declare class PushConfig {
+    backend: 'sse' | 'websocket';
+}

package/dist/push/push.config.js

@@ -0,0 +1,27 @@
+"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;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PushConfig = void 0;
+const config_1 = require("@n8n/config");
+let PushConfig = class PushConfig {
+    constructor() {
+        this.backend = 'websocket';
+    }
+};
+exports.PushConfig = PushConfig;
+__decorate([
+    (0, config_1.Env)('N8N_PUSH_BACKEND'),
+    __metadata("design:type", String)
+], PushConfig.prototype, "backend", void 0);
+exports.PushConfig = PushConfig = __decorate([
+    config_1.Config
+], PushConfig);
+//# sourceMappingURL=push.config.js.map

package/dist/push/push.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"push.config.js","sourceRoot":"","sources":["../../src/push/push.config.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wCAA0C;AAGnC,IAAM,UAAU,GAAhB,MAAM,UAAU;IAAhB;QAGN,YAAO,GAAwB,WAAW,CAAC;IAC5C,CAAC;CAAA,CAAA;AAJY,gCAAU;AAGtB;IADC,IAAA,YAAG,EAAC,kBAAkB,CAAC;;2CACmB;qBAH/B,UAAU;IADtB,eAAM;GACM,UAAU,CAItB"}

package/dist/push/sse.push.d.ts

@@ -0,0 +1,14 @@
+import type { User } from '@n8n/db';
+import { AbstractPush } from './abstract.push';
+import type { PushRequest, PushResponse } from './types';
+type Connection = {
+    req: PushRequest;
+    res: PushResponse;
+};
+export declare class SSEPush extends AbstractPush<Connection> {
+    add(pushRef: string, userId: User['id'], connection: Connection): void;
+    protected close({ res }: Connection): void;
+    protected sendToOneConnection(connection: Connection, data: string): void;
+    protected ping({ res }: Connection): void;
+}
+export {};

package/dist/push/sse.push.js

@@ -0,0 +1,47 @@
+"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.SSEPush = void 0;
+const di_1 = require("@n8n/di");
+const abstract_push_1 = require("./abstract.push");
+let SSEPush = class SSEPush extends abstract_push_1.AbstractPush {
+    add(pushRef, userId, connection) {
+        const { req, res } = connection;
+        req.socket.setTimeout(0);
+        req.socket.setNoDelay(true);
+        req.socket.setKeepAlive(true);
+        res.setHeader('Content-Type', 'text/event-stream; charset=UTF-8');
+        res.setHeader('Cache-Control', 'no-cache');
+        res.setHeader('Connection', 'keep-alive');
+        res.writeHead(200);
+        res.write(':ok\n\n');
+        res.flush();
+        super.add(pushRef, userId, connection);
+        const removeClient = () => this.remove(pushRef);
+        req.once('end', removeClient);
+        req.once('close', removeClient);
+        res.once('finish', removeClient);
+    }
+    close({ res }) {
+        res.end();
+    }
+    sendToOneConnection(connection, data) {
+        const { res } = connection;
+        res.write('data: ' + data + '\n\n');
+        res.flush();
+    }
+    ping({ res }) {
+        res.write(':ping\n\n');
+        res.flush();
+    }
+};
+exports.SSEPush = SSEPush;
+exports.SSEPush = SSEPush = __decorate([
+    (0, di_1.Service)()
+], SSEPush);
+//# sourceMappingURL=sse.push.js.map

package/dist/push/sse.push.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sse.push.js","sourceRoot":"","sources":["../../src/push/sse.push.ts"],"names":[],"mappings":";;;;;;;;;AACA,gCAAkC;AAElC,mDAA+C;AAMxC,IAAM,OAAO,GAAb,MAAM,OAAQ,SAAQ,4BAAwB;IACpD,GAAG,CAAC,OAAe,EAAE,MAAkB,EAAE,UAAsB;QAC9D,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,UAAU,CAAC;QAGhC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACzB,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC5B,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC9B,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,kCAAkC,CAAC,CAAC;QAClE,GAAG,CAAC,SAAS,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;QAC3C,GAAG,CAAC,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QAC1C,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACnB,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrB,GAAG,CAAC,KAAK,EAAE,CAAC;QAEZ,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QAGvC,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAChD,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QAC9B,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QAChC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAClC,CAAC;IAES,KAAK,CAAC,EAAE,GAAG,EAAc;QAClC,GAAG,CAAC,GAAG,EAAE,CAAC;IACX,CAAC;IAES,mBAAmB,CAAC,UAAsB,EAAE,IAAY;QACjE,MAAM,EAAE,GAAG,EAAE,GAAG,UAAU,CAAC;QAC3B,GAAG,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,GAAG,MAAM,CAAC,CAAC;QACpC,GAAG,CAAC,KAAK,EAAE,CAAC;IACb,CAAC;IAES,IAAI,CAAC,EAAE,GAAG,EAAc;QACjC,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QACvB,GAAG,CAAC,KAAK,EAAE,CAAC;IACb,CAAC;CACD,CAAA;AAtCY,0BAAO;kBAAP,OAAO;IADnB,IAAA,YAAO,GAAE;GACG,OAAO,CAsCnB"}

package/dist/push/types.d.ts

@@ -0,0 +1,22 @@
+import type { AuthenticatedRequest, User } from '@n8n/db';
+import type { Request, Response } from 'express';
+import type { WebSocket } from 'ws';
+export type PushRequest = AuthenticatedRequest<{}, {}, {}, {
+    pushRef: string;
+}>;
+export type SSEPushRequest = PushRequest & {
+    ws: undefined;
+};
+export type WebSocketPushRequest = PushRequest & {
+    ws: WebSocket;
+    headers: Request['headers'];
+};
+export type PushResponse = Response & {
+    req: PushRequest;
+    flush: () => void;
+};
+export interface OnPushMessage {
+    pushRef: string;
+    userId: User['id'];
+    msg: unknown;
+}

package/dist/push/types.js

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

package/dist/push/types.js.map

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

package/dist/push/websocket.push.d.ts

@@ -0,0 +1,10 @@
+import type { User } from '@n8n/db';
+import type WebSocket from 'ws';
+import { AbstractPush } from './abstract.push';
+export declare class WebSocketPush extends AbstractPush<WebSocket> {
+    add(pushRef: string, userId: User['id'], connection: WebSocket): void;
+    protected close(connection: WebSocket): void;
+    protected sendToOneConnection(connection: WebSocket, data: string, asBinary: boolean): void;
+    protected ping(connection: WebSocket): void;
+    private isClientHeartbeat;
+}

package/dist/push/websocket.push.js

@@ -0,0 +1,79 @@
+"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.WebSocketPush = void 0;
+const api_types_1 = require("@n8n/api-types");
+const di_1 = require("@n8n/di");
+const n8n_workflow_1 = require("n8n-workflow");
+const abstract_push_1 = require("./abstract.push");
+function heartbeat() {
+    this.isAlive = true;
+}
+let WebSocketPush = class WebSocketPush extends abstract_push_1.AbstractPush {
+    add(pushRef, userId, connection) {
+        connection.isAlive = true;
+        connection.on('pong', heartbeat);
+        super.add(pushRef, userId, connection);
+        const onMessage = async (data) => {
+            try {
+                const buffer = Array.isArray(data)
+                    ? Buffer.concat(data)
+                    : data instanceof ArrayBuffer
+                        ? Buffer.from(data)
+                        : data;
+                const msg = JSON.parse(buffer.toString('utf8'));
+                if (await this.isClientHeartbeat(msg)) {
+                    return;
+                }
+                this.onMessageReceived(pushRef, msg);
+            }
+            catch (error) {
+                this.errorReporter.error(new n8n_workflow_1.UnexpectedError('Error parsing push message', {
+                    extra: {
+                        userId,
+                        data,
+                    },
+                    cause: error,
+                }));
+                this.logger.error("Couldn't parse message from editor-UI", {
+                    error: error,
+                    pushRef,
+                    data,
+                });
+            }
+        };
+        connection.once('close', () => {
+            connection.off('pong', heartbeat);
+            connection.off('message', onMessage);
+            this.remove(pushRef);
+        });
+        connection.on('message', onMessage);
+    }
+    close(connection) {
+        connection.close();
+    }
+    sendToOneConnection(connection, data, asBinary) {
+        connection.send(data, { binary: asBinary });
+    }
+    ping(connection) {
+        if (!connection.isAlive) {
+            return connection.terminate();
+        }
+        connection.isAlive = false;
+        connection.ping();
+    }
+    async isClientHeartbeat(msg) {
+        const result = await api_types_1.heartbeatMessageSchema.safeParseAsync(msg);
+        return result.success;
+    }
+};
+exports.WebSocketPush = WebSocketPush;
+exports.WebSocketPush = WebSocketPush = __decorate([
+    (0, di_1.Service)()
+], WebSocketPush);
+//# sourceMappingURL=websocket.push.js.map

package/dist/push/websocket.push.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.push.js","sourceRoot":"","sources":["../../src/push/websocket.push.ts"],"names":[],"mappings":";;;;;;;;;AAAA,8CAAwD;AAExD,gCAAkC;AAClC,+CAA+C;AAG/C,mDAA+C;AAE/C,SAAS,SAAS;IACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;AACrB,CAAC;AAGM,IAAM,aAAa,GAAnB,MAAM,aAAc,SAAQ,4BAAuB;IACzD,GAAG,CAAC,OAAe,EAAE,MAAkB,EAAE,UAAqB;QAC7D,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC;QAC1B,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAEjC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QAEvC,MAAM,SAAS,GAAG,KAAK,EAAE,IAAuB,EAAE,EAAE;YACnD,IAAI,CAAC;gBACJ,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;oBACjC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;oBACrB,CAAC,CAAC,IAAI,YAAY,WAAW;wBAC5B,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;wBACnB,CAAC,CAAC,IAAI,CAAC;gBAET,MAAM,GAAG,GAAY,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;gBAKzD,IAAI,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC;oBACvC,OAAO;gBACR,CAAC;gBAED,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YACtC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAChB,IAAI,CAAC,aAAa,CAAC,KAAK,CACvB,IAAI,8BAAe,CAAC,4BAA4B,EAAE;oBACjD,KAAK,EAAE;wBACN,MAAM;wBACN,IAAI;qBACJ;oBACD,KAAK,EAAE,KAAK;iBACZ,CAAC,CACF,CAAC;gBACF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uCAAuC,EAAE;oBAC1D,KAAK,EAAE,KAAgB;oBACvB,OAAO;oBACP,IAAI;iBACJ,CAAC,CAAC;YACJ,CAAC;QACF,CAAC,CAAC;QAGF,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;YAC7B,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAClC,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YACrC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;QAEH,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACrC,CAAC;IAES,KAAK,CAAC,UAAqB;QACpC,UAAU,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC;IAES,mBAAmB,CAAC,UAAqB,EAAE,IAAY,EAAE,QAAiB;QACnF,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC7C,CAAC;IAES,IAAI,CAAC,UAAqB;QAEnC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;YACzB,OAAO,UAAU,CAAC,SAAS,EAAE,CAAC;QAC/B,CAAC;QACD,UAAU,CAAC,OAAO,GAAG,KAAK,CAAC;QAC3B,UAAU,CAAC,IAAI,EAAE,CAAC;IACnB,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAAC,GAAY;QAC3C,MAAM,MAAM,GAAG,MAAM,kCAAsB,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QAEhE,OAAO,MAAM,CAAC,OAAO,CAAC;IACvB,CAAC;CACD,CAAA;AA3EY,sCAAa;wBAAb,aAAa;IADzB,IAAA,YAAO,GAAE;GACG,aAAa,CA2EzB"}

package/dist/requests.d.ts

@@ -0,0 +1,250 @@
+import type { ProjectIcon, ProjectType } from '@n8n/api-types';
+import type { APIRequest, AuthenticatedRequest, Variables, Project, User, ListQueryDb, WorkflowHistory } from '@n8n/db';
+import type { AssignableGlobalRole, AssignableProjectRole, GlobalRole, ProjectRole, Scope } from '@n8n/permissions';
+import type { ICredentialDataDecryptedObject, INodeCredentialTestRequest, IPersonalizationSurveyAnswersV4 } from 'n8n-workflow';
+export type AuthlessRequest<RouteParams = {}, ResponseBody = {}, RequestBody = {}, RequestQuery = {}> = APIRequest<RouteParams, ResponseBody, RequestBody, RequestQuery>;
+export declare namespace ListQuery {
+    type Request = AuthenticatedRequest<{}, {}, {}, Params> & {
+        listQueryOptions?: Options;
+    };
+    type Params = {
+        filter?: string;
+        skip?: string;
+        take?: string;
+        select?: string;
+        sortBy?: string;
+    };
+    type Options = {
+        filter?: Record<string, unknown>;
+        select?: Record<string, true>;
+        skip?: number;
+        take?: number;
+        sortBy?: string;
+    };
+}
+export declare function hasSharing(workflows: ListQueryDb.Workflow.Plain[] | ListQueryDb.Workflow.WithSharing[]): workflows is ListQueryDb.Workflow.WithSharing[];
+export declare namespace CredentialRequest {
+    type CredentialProperties = Partial<{
+        id: string;
+        name: string;
+        type: string;
+        data: ICredentialDataDecryptedObject;
+        projectId?: string;
+        isManaged?: boolean;
+        isGlobal?: boolean;
+        isResolvable?: boolean;
+    }>;
+    type Get = AuthenticatedRequest<{
+        credentialId: string;
+    }, {}, {}, Record<string, string>>;
+    type GetMany = AuthenticatedRequest<{}, {}, {}, ListQuery.Params & {
+        includeScopes?: string;
+        includeFolders?: string;
+    }> & {
+        listQueryOptions: ListQuery.Options;
+    };
+    type Delete = Get;
+    type GetAll = AuthenticatedRequest<{}, {}, {}, {
+        filter: string;
+    }>;
+    type Update = AuthenticatedRequest<{
+        credentialId: string;
+    }, {}, CredentialProperties>;
+    type Test = AuthenticatedRequest<{}, {}, INodeCredentialTestRequest>;
+    type Share = AuthenticatedRequest<{
+        credentialId: string;
+    }, {}, {
+        shareWithIds: string[];
+    }>;
+    type Transfer = AuthenticatedRequest<{
+        credentialId: string;
+    }, {}, {
+        destinationProjectId: string;
+    }>;
+    type ForWorkflow = AuthenticatedRequest<{}, {}, {}, {
+        workflowId: string;
+    } | {
+        projectId: string;
+    }>;
+}
+export declare namespace MeRequest {
+    type SurveyAnswers = AuthenticatedRequest<{}, {}, IPersonalizationSurveyAnswersV4>;
+}
+export declare namespace UserRequest {
+    type InviteResponse = {
+        user: {
+            id: string;
+            email: string;
+            inviteAcceptUrl?: string;
+            emailSent: boolean;
+            role: AssignableGlobalRole;
+        };
+        error?: string;
+    };
+    type Delete = AuthenticatedRequest<{
+        id: string;
+        email: string;
+        identifier: string;
+    }, {}, {}, {
+        transferId?: string;
+        includeRole: boolean;
+    }>;
+    type Get = AuthenticatedRequest<{
+        id: string;
+        email: string;
+        identifier: string;
+    }, {}, {}, {
+        limit?: number;
+        offset?: number;
+        cursor?: string;
+        includeRole?: boolean;
+        projectId?: string;
+    }>;
+    type PasswordResetLink = AuthenticatedRequest<{
+        id: string;
+    }, {}, {}, {}>;
+}
+export declare namespace MFA {
+    type Enforce = AuthenticatedRequest<{}, {}, {
+        enforce: boolean;
+    }, {}>;
+    type Verify = AuthenticatedRequest<{}, {}, {
+        mfaCode: string;
+    }, {}>;
+    type Activate = AuthenticatedRequest<{}, {}, {
+        mfaCode: string;
+    }, {}>;
+    type Disable = AuthenticatedRequest<{}, {}, {
+        mfaCode?: string;
+        mfaRecoveryCode?: string;
+    }, {}>;
+    type Config = AuthenticatedRequest<{}, {}, {
+        login: {
+            enabled: boolean;
+        };
+    }, {}>;
+    type ValidateRecoveryCode = AuthenticatedRequest<{}, {}, {
+        recoveryCode: {
+            enabled: boolean;
+        };
+    }, {}>;
+}
+export declare namespace OAuthRequest {
+    namespace OAuth1Credential {
+        type Auth = AuthenticatedRequest<{}, {}, {}, {
+            id: string;
+        }>;
+        type Callback = AuthenticatedRequest<{}, {}, {}, {
+            oauth_verifier: string;
+            oauth_token: string;
+            state: string;
+        }> & {
+            user?: User;
+        };
+    }
+    namespace OAuth2Credential {
+        type Auth = AuthenticatedRequest<{}, {}, {}, {
+            id: string;
+        }>;
+        type Callback = AuthenticatedRequest<{}, {}, {}, {
+            code: string;
+            state: string;
+        }>;
+    }
+}
+export declare namespace AnnotationTagsRequest {
+    type GetAll = AuthenticatedRequest<{}, {}, {}, {
+        withUsageCount: string;
+    }>;
+    type Create = AuthenticatedRequest<{}, {}, {
+        name: string;
+    }>;
+    type Update = AuthenticatedRequest<{
+        id: string;
+    }, {}, {
+        name: string;
+    }>;
+    type Delete = AuthenticatedRequest<{
+        id: string;
+    }>;
+}
+export declare namespace NodeRequest {
+    type GetAll = AuthenticatedRequest;
+    type Post = AuthenticatedRequest<{}, {}, {
+        name?: string;
+        verify?: boolean;
+        version?: string;
+        checksum?: string;
+    }>;
+    type Delete = AuthenticatedRequest<{}, {}, {}, {
+        name: string;
+    }>;
+    type Update = Post;
+}
+export declare namespace LicenseRequest {
+    type Activate = AuthenticatedRequest<{}, {}, {
+        activationKey: string;
+        eulaUri?: string;
+    }, {}>;
+}
+export declare namespace VariablesRequest {
+    type CreateUpdatePayload = Omit<Variables, 'id'> & {
+        id?: unknown;
+    };
+    type GetAll = AuthenticatedRequest<{}, {}, {}, {
+        limit?: number;
+        cursor?: string;
+        offset?: number;
+        lastId?: string;
+        projectId?: string;
+        state?: 'empty';
+    }>;
+    type Get = AuthenticatedRequest<{
+        id: string;
+    }, {}, {}, {}>;
+    type Create = AuthenticatedRequest<{}, {}, CreateUpdatePayload, {}>;
+    type Update = AuthenticatedRequest<{
+        id: string;
+    }, {}, CreateUpdatePayload, {}>;
+    type Delete = Get;
+}
+export declare namespace WorkflowHistoryRequest {
+    type GetList = AuthenticatedRequest<{
+        workflowId: string;
+    }, Array<Omit<WorkflowHistory, 'nodes' | 'connections'>>, {}, ListQuery.Options>;
+    type GetVersion = AuthenticatedRequest<{
+        workflowId: string;
+        versionId: string;
+    }, WorkflowHistory>;
+}
+export declare namespace ActiveWorkflowRequest {
+    type GetAllActive = AuthenticatedRequest;
+    type GetActivationError = AuthenticatedRequest<{
+        id: string;
+    }>;
+}
+export declare namespace ProjectRequest {
+    type GetMyProjectsResponse = Array<Project & {
+        role: ProjectRole | AssignableProjectRole | GlobalRole;
+        scopes?: Scope[];
+    }>;
+    type ProjectRelationResponse = {
+        id: string;
+        email: string;
+        firstName: string;
+        lastName: string;
+        role: ProjectRole | AssignableProjectRole;
+    };
+    type ProjectWithRelations = {
+        id: string;
+        name: string | undefined;
+        icon: ProjectIcon | null;
+        type: ProjectType;
+        description: string | null;
+        relations: ProjectRelationResponse[];
+        scopes: Scope[];
+    };
+}
+export declare namespace NpsSurveyRequest {
+    type NpsSurveyUpdate = AuthenticatedRequest<{}, {}, unknown>;
+}

package/dist/requests.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasSharing = hasSharing;
+function hasSharing(workflows) {
+    return workflows.some((w) => 'shared' in w);
+}
+//# sourceMappingURL=requests.js.map

package/dist/requests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requests.js","sourceRoot":"","sources":["../src/requests.ts"],"names":[],"mappings":";;AAwDA,gCAIC;AAJD,SAAgB,UAAU,CACzB,SAA4E;IAE5E,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC;AAC7C,CAAC"}

package/dist/response-helper.d.ts

@@ -0,0 +1,6 @@
+import type { Request, Response } from 'express';
+export declare function sendSuccessResponse(res: Response, data: any, raw?: boolean, responseCode?: number, responseHeader?: object): void;
+export declare function sendErrorResponse(res: Response, error: Error): void;
+export declare const isUniqueConstraintError: (error: Error) => boolean;
+export declare function reportError(error: Error): void;
+export declare function send<T, R extends Request, S extends Response>(processFunction: (req: R, res: S) => Promise<T>, raw?: boolean): (req: R, res: S) => Promise<void>;