@azure/web-pubsub-express 1.0.6-alpha.20240528.1 → 1.0.6-alpha.20240814.1

package/dist/commonjs/cloudEventsDispatcher.d.ts

@@ -0,0 +1,15 @@
+import { IncomingMessage, ServerResponse } from "node:http";
+import type { WebPubSubEventHandlerOptions } from "./cloudEventsProtocols.js";
+/**
+ * @internal
+ */
+export declare class CloudEventsDispatcher {
+    private hub;
+    private eventHandler?;
+    private readonly _allowAll;
+    private readonly _allowedOrigins;
+    constructor(hub: string, eventHandler?: WebPubSubEventHandlerOptions | undefined);
+    handlePreflight(req: IncomingMessage, res: ServerResponse): boolean;
+    handleRequest(request: IncomingMessage, response: ServerResponse): Promise<boolean>;
+}
+//# sourceMappingURL=cloudEventsDispatcher.d.ts.map

package/dist/commonjs/cloudEventsDispatcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloudEventsDispatcher.d.ts","sourceRoot":"","sources":["../../src/cloudEventsDispatcher.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAI5D,OAAO,KAAK,EASV,4BAA4B,EAC7B,MAAM,2BAA2B,CAAC;AAyKnC;;GAEG;AACH,qBAAa,qBAAqB;IAI9B,OAAO,CAAC,GAAG;IACX,OAAO,CAAC,YAAY,CAAC;IAJvB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAC3C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAqB;gBAE3C,GAAG,EAAE,MAAM,EACX,YAAY,CAAC,EAAE,4BAA4B,YAAA;IAa9C,eAAe,CAAC,GAAG,EAAE,eAAe,EAAE,GAAG,EAAE,cAAc,GAAG,OAAO;IAoB7D,aAAa,CAAC,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;CAyGjG"}

package/dist/commonjs/cloudEventsDispatcher.js

@@ -0,0 +1,281 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudEventsDispatcher = void 0;
+const tslib_1 = require("tslib");
+const utils = tslib_1.__importStar(require("./utils.js"));
+const node_url_1 = require("node:url");
+const logger_js_1 = require("./logger.js");
+var EventType;
+(function (EventType) {
+    EventType[EventType["Connect"] = 0] = "Connect";
+    EventType[EventType["Connected"] = 1] = "Connected";
+    EventType[EventType["Disconnected"] = 2] = "Disconnected";
+    EventType[EventType["UserEvent"] = 3] = "UserEvent";
+})(EventType || (EventType = {}));
+function getConnectResponseHandler(connectRequest, response) {
+    const states = connectRequest.context.states;
+    let modified = false;
+    const handler = {
+        setState(name, value) {
+            states[name] = value;
+            modified = true;
+        },
+        success(res) {
+            response.statusCode = 200;
+            if (modified) {
+                response.setHeader("ce-connectionState", utils.toBase64JsonString(states));
+            }
+            if (res === undefined) {
+                response.end();
+            }
+            else {
+                response.setHeader("Content-Type", "application/json; charset=utf-8");
+                response.end(JSON.stringify(res));
+            }
+        },
+        fail(code, detail) {
+            response.statusCode = code;
+            response.end(detail !== null && detail !== void 0 ? detail : "");
+        },
+    };
+    return handler;
+}
+function getUserEventResponseHandler(userRequest, response) {
+    const states = userRequest.context.states;
+    let modified = false;
+    const handler = {
+        setState(name, value) {
+            modified = true;
+            states[name] = value;
+        },
+        success(data, dataType) {
+            response.statusCode = 200;
+            if (modified) {
+                response.setHeader("ce-connectionState", utils.toBase64JsonString(states));
+            }
+            switch (dataType) {
+                case "json":
+                    response.setHeader("Content-Type", "application/json; charset=utf-8");
+                    break;
+                case "text":
+                    response.setHeader("Content-Type", "text/plain; charset=utf-8");
+                    break;
+                default:
+                    response.setHeader("Content-Type", "application/octet-stream");
+                    break;
+            }
+            response.end(data !== null && data !== void 0 ? data : "");
+        },
+        fail(code, detail) {
+            response.statusCode = code;
+            response.end(detail !== null && detail !== void 0 ? detail : "");
+        },
+    };
+    return handler;
+}
+function getContext(request, origin) {
+    const context = {
+        signature: utils.getHttpHeader(request, "ce-signature"),
+        userId: utils.getHttpHeader(request, "ce-userid"),
+        hub: utils.getHttpHeader(request, "ce-hub"),
+        connectionId: utils.getHttpHeader(request, "ce-connectionid"),
+        eventName: utils.getHttpHeader(request, "ce-eventname"),
+        origin: origin,
+        states: utils.fromBase64JsonString(utils.getHttpHeader(request, "ce-connectionstate")),
+    };
+    // TODO: validation
+    return context;
+}
+function tryGetWebPubSubEvent(req) {
+    // check ce-type to see if it is a valid WebPubSub CloudEvent request
+    const prefix = "azure.webpubsub.";
+    const connect = "azure.webpubsub.sys.connect";
+    const connected = "azure.webpubsub.sys.connected";
+    const disconnectd = "azure.webpubsub.sys.disconnected";
+    const userPrefix = "azure.webpubsub.user.";
+    const type = utils.getHttpHeader(req, "ce-type");
+    if (!(type === null || type === void 0 ? void 0 : type.startsWith(prefix))) {
+        return undefined;
+    }
+    if (type.startsWith(userPrefix)) {
+        return EventType.UserEvent;
+    }
+    switch (type) {
+        case connect:
+            return EventType.Connect;
+        case connected:
+            return EventType.Connected;
+        case disconnectd:
+            return EventType.Disconnected;
+        default:
+            return undefined;
+    }
+}
+function isWebPubSubRequest(req) {
+    return utils.getHttpHeader(req, "ce-awpsversion") !== undefined;
+}
+async function readUserEventRequest(request, origin) {
+    const contentTypeheader = utils.getHttpHeader(request, "content-type");
+    if (contentTypeheader === undefined) {
+        return undefined;
+    }
+    const contentType = contentTypeheader.split(";")[0].trim();
+    switch (contentType) {
+        case "application/octet-stream":
+            return {
+                context: getContext(request, origin),
+                data: await utils.readRequestBody(request),
+                dataType: "binary",
+            };
+        case "application/json":
+            return {
+                context: getContext(request, origin),
+                data: JSON.parse((await utils.readRequestBody(request)).toString()),
+                dataType: "json",
+            };
+        case "text/plain":
+            return {
+                context: getContext(request, origin),
+                data: (await utils.readRequestBody(request)).toString(),
+                dataType: "text",
+            };
+        default:
+            return undefined;
+    }
+}
+async function readSystemEventRequest(request, origin) {
+    const body = (await utils.readRequestBody(request)).toString();
+    const parsedRequest = JSON.parse(body);
+    parsedRequest.context = getContext(request, origin);
+    return parsedRequest;
+}
+/**
+ * @internal
+ */
+class CloudEventsDispatcher {
+    constructor(hub, eventHandler) {
+        this.hub = hub;
+        this.eventHandler = eventHandler;
+        this._allowAll = true;
+        this._allowedOrigins = [];
+        if (Array.isArray(eventHandler)) {
+            throw new Error("Unexpected WebPubSubEventHandlerOptions");
+        }
+        if ((eventHandler === null || eventHandler === void 0 ? void 0 : eventHandler.allowedEndpoints) !== undefined) {
+            this._allowedOrigins = eventHandler.allowedEndpoints.map((endpoint) => new node_url_1.URL(endpoint).host.toLowerCase());
+            this._allowAll = false;
+        }
+    }
+    handlePreflight(req, res) {
+        if (!isWebPubSubRequest(req)) {
+            return false;
+        }
+        const origin = utils.getHttpHeader(req, "webhook-request-origin");
+        if (origin === undefined) {
+            logger_js_1.logger.warning("Expecting webhook-request-origin header.");
+            res.statusCode = 400;
+        }
+        else if (this._allowAll) {
+            res.setHeader("WebHook-Allowed-Origin", "*");
+        }
+        else {
+            // service to do the check
+            res.setHeader("WebHook-Allowed-Origin", this._allowedOrigins);
+        }
+        res.end();
+        return true;
+    }
+    async handleRequest(request, response) {
+        var _a, _b, _c, _d;
+        if (!isWebPubSubRequest(request)) {
+            return false;
+        }
+        // check if it is a valid WebPubSub cloud events
+        const origin = utils.getHttpHeader(request, "webhook-request-origin");
+        if (origin === undefined) {
+            return false;
+        }
+        const eventType = tryGetWebPubSubEvent(request);
+        if (eventType === undefined) {
+            return false;
+        }
+        // check if hub matches
+        const hub = utils.getHttpHeader(request, "ce-hub");
+        if ((hub === null || hub === void 0 ? void 0 : hub.toUpperCase()) !== this.hub.toUpperCase()) {
+            return false;
+        }
+        // No need to read body if handler is not specified
+        switch (eventType) {
+            case EventType.Connect:
+                if (!((_a = this.eventHandler) === null || _a === void 0 ? void 0 : _a.handleConnect)) {
+                    response.end();
+                    return true;
+                }
+                break;
+            case EventType.Connected:
+                if (!((_b = this.eventHandler) === null || _b === void 0 ? void 0 : _b.onConnected)) {
+                    response.end();
+                    return true;
+                }
+                break;
+            case EventType.Disconnected:
+                if (!((_c = this.eventHandler) === null || _c === void 0 ? void 0 : _c.onDisconnected)) {
+                    response.end();
+                    return true;
+                }
+                break;
+            case EventType.UserEvent:
+                if (!((_d = this.eventHandler) === null || _d === void 0 ? void 0 : _d.handleUserEvent)) {
+                    response.end();
+                    return true;
+                }
+                break;
+            default:
+                logger_js_1.logger.warning(`Unknown EventType ${eventType}`);
+                return false;
+        }
+        switch (eventType) {
+            case EventType.Connect: {
+                const connectRequest = await readSystemEventRequest(request, origin);
+                // service passes out query property, assign it to queries
+                connectRequest.queries = connectRequest.query;
+                logger_js_1.logger.verbose(connectRequest);
+                this.eventHandler.handleConnect(connectRequest, getConnectResponseHandler(connectRequest, response));
+                return true;
+            }
+            case EventType.Connected: {
+                // for unblocking events, we responds to the service as early as possible
+                response.end();
+                const connectedRequest = await readSystemEventRequest(request, origin);
+                logger_js_1.logger.verbose(connectedRequest);
+                this.eventHandler.onConnected(connectedRequest);
+                return true;
+            }
+            case EventType.Disconnected: {
+                // for unblocking events, we responds to the service as early as possible
+                response.end();
+                const disconnectedRequest = await readSystemEventRequest(request, origin);
+                logger_js_1.logger.verbose(disconnectedRequest);
+                this.eventHandler.onDisconnected(disconnectedRequest);
+                return true;
+            }
+            case EventType.UserEvent: {
+                const userRequest = await readUserEventRequest(request, origin);
+                if (userRequest === undefined) {
+                    logger_js_1.logger.warning(`Unsupported content type ${utils.getHttpHeader(request, "content-type")}`);
+                    return false;
+                }
+                logger_js_1.logger.verbose(userRequest);
+                this.eventHandler.handleUserEvent(userRequest, getUserEventResponseHandler(userRequest, response));
+                return true;
+            }
+            default:
+                logger_js_1.logger.warning(`Unknown EventType ${eventType}`);
+                return false;
+        }
+    }
+}
+exports.CloudEventsDispatcher = CloudEventsDispatcher;
+//# sourceMappingURL=cloudEventsDispatcher.js.map

package/dist/commonjs/cloudEventsDispatcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloudEventsDispatcher.js","sourceRoot":"","sources":["../../src/cloudEventsDispatcher.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAElC,0DAAoC;AAEpC,uCAA+B;AAC/B,2CAAqC;AAcrC,IAAK,SAKJ;AALD,WAAK,SAAS;IACZ,+CAAO,CAAA;IACP,mDAAS,CAAA;IACT,yDAAY,CAAA;IACZ,mDAAS,CAAA;AACX,CAAC,EALI,SAAS,KAAT,SAAS,QAKb;AAED,SAAS,yBAAyB,CAChC,cAA8B,EAC9B,QAAwB;IAExB,MAAM,MAAM,GAAwB,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC;IAClE,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,MAAM,OAAO,GAAG;QACd,QAAQ,CAAC,IAAY,EAAE,KAAc;YACnC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;YACrB,QAAQ,GAAG,IAAI,CAAC;QAClB,CAAC;QACD,OAAO,CAAC,GAAqB;YAC3B,QAAQ,CAAC,UAAU,GAAG,GAAG,CAAC;YAC1B,IAAI,QAAQ,EAAE,CAAC;gBACb,QAAQ,CAAC,SAAS,CAAC,oBAAoB,EAAE,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7E,CAAC;YACD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;gBACtB,QAAQ,CAAC,GAAG,EAAE,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,SAAS,CAAC,cAAc,EAAE,iCAAiC,CAAC,CAAC;gBACtE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;QACD,IAAI,CAAC,IAAqB,EAAE,MAAe;YACzC,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC;YAC3B,QAAQ,CAAC,GAAG,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,CAAC;QAC7B,CAAC;KACF,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,2BAA2B,CAClC,WAA6B,EAC7B,QAAwB;IAExB,MAAM,MAAM,GAAwB,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;IAC/D,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,MAAM,OAAO,GAAG;QACd,QAAQ,CAAC,IAAY,EAAE,KAAc;YACnC,QAAQ,GAAG,IAAI,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QACvB,CAAC;QACD,OAAO,CAAC,IAA2B,EAAE,QAAqC;YACxE,QAAQ,CAAC,UAAU,GAAG,GAAG,CAAC;YAC1B,IAAI,QAAQ,EAAE,CAAC;gBACb,QAAQ,CAAC,SAAS,CAAC,oBAAoB,EAAE,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7E,CAAC;YAED,QAAQ,QAAQ,EAAE,CAAC;gBACjB,KAAK,MAAM;oBACT,QAAQ,CAAC,SAAS,CAAC,cAAc,EAAE,iCAAiC,CAAC,CAAC;oBACtE,MAAM;gBACR,KAAK,MAAM;oBACT,QAAQ,CAAC,SAAS,CAAC,cAAc,EAAE,2BAA2B,CAAC,CAAC;oBAChE,MAAM;gBACR;oBACE,QAAQ,CAAC,SAAS,CAAC,cAAc,EAAE,0BAA0B,CAAC,CAAC;oBAC/D,MAAM;YACV,CAAC;YACD,QAAQ,CAAC,GAAG,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC;QAC3B,CAAC;QACD,IAAI,CAAC,IAAqB,EAAE,MAAe;YACzC,QAAQ,CAAC,UAAU,GAAG,IAAI,CAAC;YAC3B,QAAQ,CAAC,GAAG,CAAC,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC,CAAC;QAC7B,CAAC;KACF,CAAC;IACF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,UAAU,CAAC,OAAwB,EAAE,MAAc;IAC1D,MAAM,OAAO,GAAG;QACd,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,cAAc,CAAC;QACvD,MAAM,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,WAAW,CAAC;QACjD,GAAG,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAE;QAC5C,YAAY,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,iBAAiB,CAAE;QAC9D,SAAS,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,cAAc,CAAE;QACxD,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;KACvF,CAAC;IAEF,mBAAmB;IACnB,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,oBAAoB,CAAC,GAAoB;IAChD,qEAAqE;IACrE,MAAM,MAAM,GAAG,kBAAkB,CAAC;IAClC,MAAM,OAAO,GAAG,6BAA6B,CAAC;IAC9C,MAAM,SAAS,GAAG,+BAA+B,CAAC;IAClD,MAAM,WAAW,GAAG,kCAAkC,CAAC;IACvD,MAAM,UAAU,GAAG,uBAAuB,CAAC;IAC3C,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IACjD,IAAI,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,UAAU,CAAC,MAAM,CAAC,CAAA,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAChC,OAAO,SAAS,CAAC,SAAS,CAAC;IAC7B,CAAC;IACD,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,OAAO;YACV,OAAO,SAAS,CAAC,OAAO,CAAC;QAC3B,KAAK,SAAS;YACZ,OAAO,SAAS,CAAC,SAAS,CAAC;QAC7B,KAAK,WAAW;YACd,OAAO,SAAS,CAAC,YAAY,CAAC;QAChC;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,GAAoB;IAC9C,OAAO,KAAK,CAAC,aAAa,CAAC,GAAG,EAAE,gBAAgB,CAAC,KAAK,SAAS,CAAC;AAClE,CAAC;AAED,KAAK,UAAU,oBAAoB,CACjC,OAAwB,EACxB,MAAc;IAEd,MAAM,iBAAiB,GAAG,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IACvE,IAAI,iBAAiB,KAAK,SAAS,EAAE,CAAC;QACpC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,WAAW,GAAG,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAE3D,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,0BAA0B;YAC7B,OAAO;gBACL,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC;gBACpC,IAAI,EAAE,MAAM,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC;gBAC1C,QAAQ,EAAE,QAAQ;aACnB,CAAC;QACJ,KAAK,kBAAkB;YACrB,OAAO;gBACL,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC;gBACpC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;gBACnE,QAAQ,EAAE,MAAM;aACjB,CAAC;QACJ,KAAK,YAAY;YACf,OAAO;gBACL,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC;gBACpC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE;gBACvD,QAAQ,EAAE,MAAM;aACjB,CAAC;QACJ;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC;AAED,KAAK,UAAU,sBAAsB,CACnC,OAAwB,EACxB,MAAc;IAEd,MAAM,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC/D,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAM,CAAC;IAC5C,aAAa,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACpD,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;GAEG;AACH,MAAa,qBAAqB;IAGhC,YACU,GAAW,EACX,YAA2C;QAD3C,QAAG,GAAH,GAAG,CAAQ;QACX,iBAAY,GAAZ,YAAY,CAA+B;QAJpC,cAAS,GAAY,IAAI,CAAC;QAC1B,oBAAe,GAAkB,EAAE,CAAC;QAKnD,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,gBAAgB,MAAK,SAAS,EAAE,CAAC;YACjD,IAAI,CAAC,eAAe,GAAG,YAAY,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CACpE,IAAI,cAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CACrC,CAAC;YACF,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACzB,CAAC;IACH,CAAC;IAEM,eAAe,CAAC,GAAoB,EAAE,GAAmB;QAC9D,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,MAAM,GAAG,KAAK,CAAC,aAAa,CAAC,GAAG,EAAE,wBAAwB,CAAC,CAAC;QAElE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,kBAAM,CAAC,OAAO,CAAC,0CAA0C,CAAC,CAAC;YAC3D,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC;QACvB,CAAC;aAAM,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YAC1B,GAAG,CAAC,SAAS,CAAC,wBAAwB,EAAE,GAAG,CAAC,CAAC;QAC/C,CAAC;aAAM,CAAC;YACN,0BAA0B;YAC1B,GAAG,CAAC,SAAS,CAAC,wBAAwB,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAChE,CAAC;QAED,GAAG,CAAC,GAAG,EAAE,CAAC;QACV,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,OAAwB,EAAE,QAAwB;;QAC3E,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC;YACjC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,gDAAgD;QAChD,MAAM,MAAM,GAAG,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAC;QACtE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,SAAS,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,uBAAuB;QACvB,MAAM,GAAG,GAAG,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QACnD,IAAI,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,WAAW,EAAE,MAAK,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC;YAClD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,mDAAmD;QACnD,QAAQ,SAAS,EAAE,CAAC;YAClB,KAAK,SAAS,CAAC,OAAO;gBACpB,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,YAAY,0CAAE,aAAa,CAAA,EAAE,CAAC;oBACtC,QAAQ,CAAC,GAAG,EAAE,CAAC;oBACf,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,MAAM;YACR,KAAK,SAAS,CAAC,SAAS;gBACtB,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,YAAY,0CAAE,WAAW,CAAA,EAAE,CAAC;oBACpC,QAAQ,CAAC,GAAG,EAAE,CAAC;oBACf,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,MAAM;YACR,KAAK,SAAS,CAAC,YAAY;gBACzB,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,YAAY,0CAAE,cAAc,CAAA,EAAE,CAAC;oBACvC,QAAQ,CAAC,GAAG,EAAE,CAAC;oBACf,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,MAAM;YACR,KAAK,SAAS,CAAC,SAAS;gBACtB,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,YAAY,0CAAE,eAAe,CAAA,EAAE,CAAC;oBACxC,QAAQ,CAAC,GAAG,EAAE,CAAC;oBACf,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,MAAM;YACR;gBACE,kBAAM,CAAC,OAAO,CAAC,qBAAqB,SAAS,EAAE,CAAC,CAAC;gBACjD,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,QAAQ,SAAS,EAAE,CAAC;YAClB,KAAK,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;gBACvB,MAAM,cAAc,GAAG,MAAM,sBAAsB,CAAiB,OAAO,EAAE,MAAM,CAAC,CAAC;gBACrF,0DAA0D;gBAC1D,cAAc,CAAC,OAAO,GAAG,cAAc,CAAC,KAAK,CAAC;gBAC9C,kBAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;gBAE/B,IAAI,CAAC,YAAY,CAAC,aAAc,CAC9B,cAAc,EACd,yBAAyB,CAAC,cAAc,EAAE,QAAQ,CAAC,CACpD,CAAC;gBACF,OAAO,IAAI,CAAC;YACd,CAAC;YACD,KAAK,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;gBACzB,yEAAyE;gBACzE,QAAQ,CAAC,GAAG,EAAE,CAAC;gBACf,MAAM,gBAAgB,GAAG,MAAM,sBAAsB,CAAmB,OAAO,EAAE,MAAM,CAAC,CAAC;gBACzF,kBAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;gBACjC,IAAI,CAAC,YAAY,CAAC,WAAY,CAAC,gBAAgB,CAAC,CAAC;gBACjD,OAAO,IAAI,CAAC;YACd,CAAC;YACD,KAAK,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC;gBAC5B,yEAAyE;gBACzE,QAAQ,CAAC,GAAG,EAAE,CAAC;gBACf,MAAM,mBAAmB,GAAG,MAAM,sBAAsB,CACtD,OAAO,EACP,MAAM,CACP,CAAC;gBACF,kBAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;gBACpC,IAAI,CAAC,YAAY,CAAC,cAAe,CAAC,mBAAmB,CAAC,CAAC;gBACvD,OAAO,IAAI,CAAC;YACd,CAAC;YACD,KAAK,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;gBACzB,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;gBAChE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;oBAC9B,kBAAM,CAAC,OAAO,CACZ,4BAA4B,KAAK,CAAC,aAAa,CAAC,OAAO,EAAE,cAAc,CAAC,EAAE,CAC3E,CAAC;oBACF,OAAO,KAAK,CAAC;gBACf,CAAC;gBACD,kBAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gBAC5B,IAAI,CAAC,YAAY,CAAC,eAAgB,CAChC,WAAW,EACX,2BAA2B,CAAC,WAAW,EAAE,QAAQ,CAAC,CACnD,CAAC;gBACF,OAAO,IAAI,CAAC;YACd,CAAC;YACD;gBACE,kBAAM,CAAC,OAAO,CAAC,qBAAqB,SAAS,EAAE,CAAC,CAAC;gBACjD,OAAO,KAAK,CAAC;QACjB,CAAC;IACH,CAAC;CACF;AA/ID,sDA+IC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport * as utils from \"./utils.js\";\nimport { IncomingMessage, ServerResponse } from \"node:http\";\nimport { URL } from \"node:url\";\nimport { logger } from \"./logger.js\";\n\nimport type {\n  ConnectRequest,\n  ConnectResponse,\n  ConnectedRequest,\n  ConnectionContext,\n  ConnectResponseHandler,\n  DisconnectedRequest,\n  UserEventRequest,\n  UserEventResponseHandler,\n  WebPubSubEventHandlerOptions,\n} from \"./cloudEventsProtocols.js\";\n\nenum EventType {\n  Connect,\n  Connected,\n  Disconnected,\n  UserEvent,\n}\n\nfunction getConnectResponseHandler(\n  connectRequest: ConnectRequest,\n  response: ServerResponse,\n): ConnectResponseHandler {\n  const states: Record<string, any> = connectRequest.context.states;\n  let modified = false;\n  const handler = {\n    setState(name: string, value: unknown): void {\n      states[name] = value;\n      modified = true;\n    },\n    success(res?: ConnectResponse): void {\n      response.statusCode = 200;\n      if (modified) {\n        response.setHeader(\"ce-connectionState\", utils.toBase64JsonString(states));\n      }\n      if (res === undefined) {\n        response.end();\n      } else {\n        response.setHeader(\"Content-Type\", \"application/json; charset=utf-8\");\n        response.end(JSON.stringify(res));\n      }\n    },\n    fail(code: 400 | 401 | 500, detail?: string): void {\n      response.statusCode = code;\n      response.end(detail ?? \"\");\n    },\n  };\n\n  return handler;\n}\n\nfunction getUserEventResponseHandler(\n  userRequest: UserEventRequest,\n  response: ServerResponse,\n): UserEventResponseHandler {\n  const states: Record<string, any> = userRequest.context.states;\n  let modified = false;\n  const handler = {\n    setState(name: string, value: unknown): void {\n      modified = true;\n      states[name] = value;\n    },\n    success(data?: string | ArrayBuffer, dataType?: \"binary\" | \"text\" | \"json\"): void {\n      response.statusCode = 200;\n      if (modified) {\n        response.setHeader(\"ce-connectionState\", utils.toBase64JsonString(states));\n      }\n\n      switch (dataType) {\n        case \"json\":\n          response.setHeader(\"Content-Type\", \"application/json; charset=utf-8\");\n          break;\n        case \"text\":\n          response.setHeader(\"Content-Type\", \"text/plain; charset=utf-8\");\n          break;\n        default:\n          response.setHeader(\"Content-Type\", \"application/octet-stream\");\n          break;\n      }\n      response.end(data ?? \"\");\n    },\n    fail(code: 400 | 401 | 500, detail?: string): void {\n      response.statusCode = code;\n      response.end(detail ?? \"\");\n    },\n  };\n  return handler;\n}\n\nfunction getContext(request: IncomingMessage, origin: string): ConnectionContext {\n  const context = {\n    signature: utils.getHttpHeader(request, \"ce-signature\"),\n    userId: utils.getHttpHeader(request, \"ce-userid\"),\n    hub: utils.getHttpHeader(request, \"ce-hub\")!,\n    connectionId: utils.getHttpHeader(request, \"ce-connectionid\")!,\n    eventName: utils.getHttpHeader(request, \"ce-eventname\")!,\n    origin: origin,\n    states: utils.fromBase64JsonString(utils.getHttpHeader(request, \"ce-connectionstate\")),\n  };\n\n  // TODO: validation\n  return context;\n}\n\nfunction tryGetWebPubSubEvent(req: IncomingMessage): EventType | undefined {\n  // check ce-type to see if it is a valid WebPubSub CloudEvent request\n  const prefix = \"azure.webpubsub.\";\n  const connect = \"azure.webpubsub.sys.connect\";\n  const connected = \"azure.webpubsub.sys.connected\";\n  const disconnectd = \"azure.webpubsub.sys.disconnected\";\n  const userPrefix = \"azure.webpubsub.user.\";\n  const type = utils.getHttpHeader(req, \"ce-type\");\n  if (!type?.startsWith(prefix)) {\n    return undefined;\n  }\n  if (type.startsWith(userPrefix)) {\n    return EventType.UserEvent;\n  }\n  switch (type) {\n    case connect:\n      return EventType.Connect;\n    case connected:\n      return EventType.Connected;\n    case disconnectd:\n      return EventType.Disconnected;\n    default:\n      return undefined;\n  }\n}\n\nfunction isWebPubSubRequest(req: IncomingMessage): boolean {\n  return utils.getHttpHeader(req, \"ce-awpsversion\") !== undefined;\n}\n\nasync function readUserEventRequest(\n  request: IncomingMessage,\n  origin: string,\n): Promise<UserEventRequest | undefined> {\n  const contentTypeheader = utils.getHttpHeader(request, \"content-type\");\n  if (contentTypeheader === undefined) {\n    return undefined;\n  }\n\n  const contentType = contentTypeheader.split(\";\")[0].trim();\n\n  switch (contentType) {\n    case \"application/octet-stream\":\n      return {\n        context: getContext(request, origin),\n        data: await utils.readRequestBody(request),\n        dataType: \"binary\",\n      };\n    case \"application/json\":\n      return {\n        context: getContext(request, origin),\n        data: JSON.parse((await utils.readRequestBody(request)).toString()),\n        dataType: \"json\",\n      };\n    case \"text/plain\":\n      return {\n        context: getContext(request, origin),\n        data: (await utils.readRequestBody(request)).toString(),\n        dataType: \"text\",\n      };\n    default:\n      return undefined;\n  }\n}\n\nasync function readSystemEventRequest<T extends { context: ConnectionContext }>(\n  request: IncomingMessage,\n  origin: string,\n): Promise<T> {\n  const body = (await utils.readRequestBody(request)).toString();\n  const parsedRequest = JSON.parse(body) as T;\n  parsedRequest.context = getContext(request, origin);\n  return parsedRequest;\n}\n\n/**\n * @internal\n */\nexport class CloudEventsDispatcher {\n  private readonly _allowAll: boolean = true;\n  private readonly _allowedOrigins: Array<string> = [];\n  constructor(\n    private hub: string,\n    private eventHandler?: WebPubSubEventHandlerOptions,\n  ) {\n    if (Array.isArray(eventHandler)) {\n      throw new Error(\"Unexpected WebPubSubEventHandlerOptions\");\n    }\n    if (eventHandler?.allowedEndpoints !== undefined) {\n      this._allowedOrigins = eventHandler.allowedEndpoints.map((endpoint) =>\n        new URL(endpoint).host.toLowerCase(),\n      );\n      this._allowAll = false;\n    }\n  }\n\n  public handlePreflight(req: IncomingMessage, res: ServerResponse): boolean {\n    if (!isWebPubSubRequest(req)) {\n      return false;\n    }\n    const origin = utils.getHttpHeader(req, \"webhook-request-origin\");\n\n    if (origin === undefined) {\n      logger.warning(\"Expecting webhook-request-origin header.\");\n      res.statusCode = 400;\n    } else if (this._allowAll) {\n      res.setHeader(\"WebHook-Allowed-Origin\", \"*\");\n    } else {\n      // service to do the check\n      res.setHeader(\"WebHook-Allowed-Origin\", this._allowedOrigins);\n    }\n\n    res.end();\n    return true;\n  }\n\n  public async handleRequest(request: IncomingMessage, response: ServerResponse): Promise<boolean> {\n    if (!isWebPubSubRequest(request)) {\n      return false;\n    }\n\n    // check if it is a valid WebPubSub cloud events\n    const origin = utils.getHttpHeader(request, \"webhook-request-origin\");\n    if (origin === undefined) {\n      return false;\n    }\n\n    const eventType = tryGetWebPubSubEvent(request);\n    if (eventType === undefined) {\n      return false;\n    }\n\n    // check if hub matches\n    const hub = utils.getHttpHeader(request, \"ce-hub\");\n    if (hub?.toUpperCase() !== this.hub.toUpperCase()) {\n      return false;\n    }\n\n    // No need to read body if handler is not specified\n    switch (eventType) {\n      case EventType.Connect:\n        if (!this.eventHandler?.handleConnect) {\n          response.end();\n          return true;\n        }\n        break;\n      case EventType.Connected:\n        if (!this.eventHandler?.onConnected) {\n          response.end();\n          return true;\n        }\n        break;\n      case EventType.Disconnected:\n        if (!this.eventHandler?.onDisconnected) {\n          response.end();\n          return true;\n        }\n        break;\n      case EventType.UserEvent:\n        if (!this.eventHandler?.handleUserEvent) {\n          response.end();\n          return true;\n        }\n        break;\n      default:\n        logger.warning(`Unknown EventType ${eventType}`);\n        return false;\n    }\n\n    switch (eventType) {\n      case EventType.Connect: {\n        const connectRequest = await readSystemEventRequest<ConnectRequest>(request, origin);\n        // service passes out query property, assign it to queries\n        connectRequest.queries = connectRequest.query;\n        logger.verbose(connectRequest);\n\n        this.eventHandler.handleConnect!(\n          connectRequest,\n          getConnectResponseHandler(connectRequest, response),\n        );\n        return true;\n      }\n      case EventType.Connected: {\n        // for unblocking events, we responds to the service as early as possible\n        response.end();\n        const connectedRequest = await readSystemEventRequest<ConnectedRequest>(request, origin);\n        logger.verbose(connectedRequest);\n        this.eventHandler.onConnected!(connectedRequest);\n        return true;\n      }\n      case EventType.Disconnected: {\n        // for unblocking events, we responds to the service as early as possible\n        response.end();\n        const disconnectedRequest = await readSystemEventRequest<DisconnectedRequest>(\n          request,\n          origin,\n        );\n        logger.verbose(disconnectedRequest);\n        this.eventHandler.onDisconnected!(disconnectedRequest);\n        return true;\n      }\n      case EventType.UserEvent: {\n        const userRequest = await readUserEventRequest(request, origin);\n        if (userRequest === undefined) {\n          logger.warning(\n            `Unsupported content type ${utils.getHttpHeader(request, \"content-type\")}`,\n          );\n          return false;\n        }\n        logger.verbose(userRequest);\n        this.eventHandler.handleUserEvent!(\n          userRequest,\n          getUserEventResponseHandler(userRequest, response),\n        );\n        return true;\n      }\n      default:\n        logger.warning(`Unknown EventType ${eventType}`);\n        return false;\n    }\n  }\n}\n"]}

package/dist/commonjs/cloudEventsProtocols.d.ts

@@ -0,0 +1,238 @@
+/**
+ * Response of the connect event.
+ */
+export interface ConnectResponse {
+    /**
+     * Set the groups the connection would like to join.
+     */
+    groups?: string[];
+    /**
+     * Set the roles the connection belongs to.
+     */
+    roles?: string[];
+    /**
+     * Set the userId for the connection.
+     */
+    userId?: string;
+    /**
+     * Set the subprotocol for the connection to complete WebSocket handshake.
+     */
+    subprotocol?: string;
+}
+/**
+ * The connection context representing the client WebSocket connection.
+ */
+export interface ConnectionContext {
+    /**
+     * The hub the connection belongs to.
+     */
+    hub: string;
+    /**
+     * The Id of the connection.
+     */
+    connectionId: string;
+    /**
+     * The event name of this CloudEvents request.
+     */
+    eventName: string;
+    /**
+     * The origin this CloudEvents request comes from.
+     */
+    origin: string;
+    /**
+     * The user id of the connection.
+     */
+    userId?: string;
+    /**
+     * The subprotocol of this connection.
+     */
+    subprotocol?: string;
+    /**
+     * Get the additional states for the connection, such states are perserved throughout the lifetime of the connection.
+     */
+    states: Record<string, any>;
+}
+/**
+ * Request for the connect event.
+ */
+export interface ConnectRequest {
+    /**
+     * The context of current CloudEvents request.
+     */
+    context: ConnectionContext;
+    /**
+     * The claims that the client WebSocket connection has when it connects.
+     */
+    claims?: Record<string, string[]>;
+    /**
+     * The query that the client WebSocket connection has when it connects.
+     * @deprecated Please use queries instead.
+     */
+    query?: Record<string, string[]>;
+    /**
+     * The queries that the client WebSocket connection has when it connects.
+     */
+    queries?: Record<string, string[]>;
+    /**
+     * The headers that the client WebSocket connection has when it connects.
+     */
+    headers?: Record<string, string[]>;
+    /**
+     * The subprotocols that the client WebSocket connection uses to do handshake.
+     */
+    subprotocols?: string[];
+    /**
+     * The client certificate info that the client WebSocket connection uses to connect.
+     */
+    clientCertificates?: Certificate[];
+}
+/**
+ * The client certificate.
+ */
+export interface Certificate {
+    /**
+     * The thumbprint of the certificate.
+     */
+    thumbprint: string;
+}
+/**
+ * Request for the connected event.
+ */
+export interface ConnectedRequest {
+    /**
+     * The context of current CloudEvents request.
+     */
+    context: ConnectionContext;
+}
+/**
+ * Request for the user event.
+ */
+export type UserEventRequest = {
+    /**
+     * The context of current CloudEvents request.
+     */
+    context: ConnectionContext;
+    /**
+     * The content data.
+     */
+    data: string;
+    /**
+     * The type of the data.
+     */
+    dataType: "text";
+} | {
+    /**
+     * The context of current CloudEvents request.
+     */
+    context: ConnectionContext;
+    /**
+     * The content data, when data type is `json`, the data is the result of JSON.parse, so the type of the data depends on user scenarios
+     */
+    data: unknown;
+    /**
+     * The type of the data.
+     */
+    dataType: "json";
+} | {
+    /**
+     * The context of current CloudEvents request.
+     */
+    context: ConnectionContext;
+    /**
+     * The content data.
+     */
+    data: ArrayBuffer;
+    /**
+     * The type of the data.
+     */
+    dataType: "binary";
+};
+/**
+ * Request for the disconnected event.
+ */
+export interface DisconnectedRequest {
+    /**
+     * The context of current CloudEvents request.
+     */
+    context: ConnectionContext;
+    /**
+     * The reason that the connection disconnects.
+     */
+    reason?: string;
+}
+/**
+ * The handler to set connect event response
+ */
+export interface ConnectResponseHandler {
+    /**
+     * Set the state of the connection
+     * @param name - The name of the state
+     * @param value - The value of the state
+     */
+    setState(name: string, value: unknown): void;
+    /**
+     * Return success response to the service.
+     * @param response - The response for the connect event.
+     */
+    success(response?: ConnectResponse): void;
+    /**
+     * Return failed response and the service will reject the client WebSocket connection.
+     * @param code - Code can be 400 user error, 401 unauthorized and 500 server error.
+     * @param detail - The detail of the error.
+     */
+    fail(code: 400 | 401 | 500, detail?: string): void;
+}
+/**
+ * The handler to set user event response
+ */
+export interface UserEventResponseHandler {
+    /**
+     * Set the state of the connection
+     * @param name - The name of the state
+     * @param value - The value of the state
+     */
+    setState(name: string, value: unknown): void;
+    /**
+     * Return success response with data to be delivered to the client WebSocket connection.
+     * @param data - The payload data to be returned to the client. Stringify the message if it is a JSON object.
+     * @param dataType - The type of the payload data.
+     */
+    success(data?: string | ArrayBuffer, dataType?: "binary" | "text" | "json"): void;
+    /**
+     * Return failed response and the service will close the client WebSocket connection.
+     * @param code - Code can be 400 user error, 401 unauthorized and 500 server error.
+     * @param detail - The detail of the error.
+     */
+    fail(code: 400 | 401 | 500, detail?: string): void;
+}
+/**
+ * The options for the CloudEvents handler.
+ */
+export interface WebPubSubEventHandlerOptions {
+    /**
+     * Custom serving path for the path of the CloudEvents handler.
+     */
+    path?: string;
+    /**
+     * Handle 'connect' event, the service waits for the response to proceed.
+     */
+    handleConnect?: (connectRequest: ConnectRequest, connectResponse: ConnectResponseHandler) => void;
+    /**
+     * Handle user events, the service waits for the response to proceed.
+     */
+    handleUserEvent?: (userEventRequest: UserEventRequest, userEventResponse: UserEventResponseHandler) => void;
+    /**
+     * Event trigger for "connected" unblocking event. This is an unblocking event and the service does not wait for the response.
+     */
+    onConnected?: (connectedRequest: ConnectedRequest) => void;
+    /**
+     *
+     * Event triggers for "disconnected" unblocking event. This is an unblocking event and the service does not wait for the response.
+     */
+    onDisconnected?: (disconnectedRequest: DisconnectedRequest) => void;
+    /**
+     * If not specified, by default allow all the endpoints, otherwise only allow specified endpoints
+     */
+    allowedEndpoints?: string[];
+}
+//# sourceMappingURL=cloudEventsProtocols.d.ts.map

package/dist/commonjs/cloudEventsProtocols.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloudEventsProtocols.d.ts","sourceRoot":"","sources":["../../src/cloudEventsProtocols.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAClC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACjC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACnC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB;;OAEG;IACH,kBAAkB,CAAC,EAAE,WAAW,EAAE,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB;IACE;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,GACD;IACE;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,GACD;IACE;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AAEN;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7C;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAC1C;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAC7C;;;;OAIG;IACH,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAClF;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpD;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,aAAa,CAAC,EAAE,CAAC,cAAc,EAAE,cAAc,EAAE,eAAe,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAElG;;OAEG;IACH,eAAe,CAAC,EAAE,CAChB,gBAAgB,EAAE,gBAAgB,EAClC,iBAAiB,EAAE,wBAAwB,KACxC,IAAI,CAAC;IAEV;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAE3D;;;OAGG;IACH,cAAc,CAAC,EAAE,CAAC,mBAAmB,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAEpE;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7B"}

package/dist/commonjs/cloudEventsProtocols.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=cloudEventsProtocols.js.map

package/dist/commonjs/cloudEventsProtocols.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloudEventsProtocols.js","sourceRoot":"","sources":["../../src/cloudEventsProtocols.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Response of the connect event.\n */\nexport interface ConnectResponse {\n  /**\n   * Set the groups the connection would like to join.\n   */\n  groups?: string[];\n  /**\n   * Set the roles the connection belongs to.\n   */\n  roles?: string[];\n  /**\n   * Set the userId for the connection.\n   */\n  userId?: string;\n  /**\n   * Set the subprotocol for the connection to complete WebSocket handshake.\n   */\n  subprotocol?: string;\n}\n\n/**\n * The connection context representing the client WebSocket connection.\n */\nexport interface ConnectionContext {\n  /**\n   * The hub the connection belongs to.\n   */\n  hub: string;\n  /**\n   * The Id of the connection.\n   */\n  connectionId: string;\n  /**\n   * The event name of this CloudEvents request.\n   */\n  eventName: string;\n  /**\n   * The origin this CloudEvents request comes from.\n   */\n  origin: string;\n  /**\n   * The user id of the connection.\n   */\n  userId?: string;\n  /**\n   * The subprotocol of this connection.\n   */\n  subprotocol?: string;\n  /**\n   * Get the additional states for the connection, such states are perserved throughout the lifetime of the connection.\n   */\n  states: Record<string, any>;\n}\n\n/**\n * Request for the connect event.\n */\nexport interface ConnectRequest {\n  /**\n   * The context of current CloudEvents request.\n   */\n  context: ConnectionContext;\n  /**\n   * The claims that the client WebSocket connection has when it connects.\n   */\n  claims?: Record<string, string[]>;\n  /**\n   * The query that the client WebSocket connection has when it connects.\n   * @deprecated Please use queries instead.\n   */\n  query?: Record<string, string[]>;\n  /**\n   * The queries that the client WebSocket connection has when it connects.\n   */\n  queries?: Record<string, string[]>;\n  /**\n   * The headers that the client WebSocket connection has when it connects.\n   */\n  headers?: Record<string, string[]>;\n  /**\n   * The subprotocols that the client WebSocket connection uses to do handshake.\n   */\n  subprotocols?: string[];\n  /**\n   * The client certificate info that the client WebSocket connection uses to connect.\n   */\n  clientCertificates?: Certificate[];\n}\n\n/**\n * The client certificate.\n */\nexport interface Certificate {\n  /**\n   * The thumbprint of the certificate.\n   */\n  thumbprint: string;\n}\n\n/**\n * Request for the connected event.\n */\nexport interface ConnectedRequest {\n  /**\n   * The context of current CloudEvents request.\n   */\n  context: ConnectionContext;\n}\n\n/**\n * Request for the user event.\n */\nexport type UserEventRequest =\n  | {\n      /**\n       * The context of current CloudEvents request.\n       */\n      context: ConnectionContext;\n\n      /**\n       * The content data.\n       */\n      data: string;\n      /**\n       * The type of the data.\n       */\n      dataType: \"text\";\n    }\n  | {\n      /**\n       * The context of current CloudEvents request.\n       */\n      context: ConnectionContext;\n\n      /**\n       * The content data, when data type is `json`, the data is the result of JSON.parse, so the type of the data depends on user scenarios\n       */\n      data: unknown;\n\n      /**\n       * The type of the data.\n       */\n      dataType: \"json\";\n    }\n  | {\n      /**\n       * The context of current CloudEvents request.\n       */\n      context: ConnectionContext;\n\n      /**\n       * The content data.\n       */\n      data: ArrayBuffer;\n      /**\n       * The type of the data.\n       */\n      dataType: \"binary\";\n    };\n\n/**\n * Request for the disconnected event.\n */\nexport interface DisconnectedRequest {\n  /**\n   * The context of current CloudEvents request.\n   */\n  context: ConnectionContext;\n  /**\n   * The reason that the connection disconnects.\n   */\n  reason?: string;\n}\n\n/**\n * The handler to set connect event response\n */\nexport interface ConnectResponseHandler {\n  /**\n   * Set the state of the connection\n   * @param name - The name of the state\n   * @param value - The value of the state\n   */\n  setState(name: string, value: unknown): void;\n  /**\n   * Return success response to the service.\n   * @param response - The response for the connect event.\n   */\n  success(response?: ConnectResponse): void;\n  /**\n   * Return failed response and the service will reject the client WebSocket connection.\n   * @param code - Code can be 400 user error, 401 unauthorized and 500 server error.\n   * @param detail - The detail of the error.\n   */\n  fail(code: 400 | 401 | 500, detail?: string): void;\n}\n\n/**\n * The handler to set user event response\n */\nexport interface UserEventResponseHandler {\n  /**\n   * Set the state of the connection\n   * @param name - The name of the state\n   * @param value - The value of the state\n   */\n  setState(name: string, value: unknown): void;\n  /**\n   * Return success response with data to be delivered to the client WebSocket connection.\n   * @param data - The payload data to be returned to the client. Stringify the message if it is a JSON object.\n   * @param dataType - The type of the payload data.\n   */\n  success(data?: string | ArrayBuffer, dataType?: \"binary\" | \"text\" | \"json\"): void;\n  /**\n   * Return failed response and the service will close the client WebSocket connection.\n   * @param code - Code can be 400 user error, 401 unauthorized and 500 server error.\n   * @param detail - The detail of the error.\n   */\n  fail(code: 400 | 401 | 500, detail?: string): void;\n}\n\n/**\n * The options for the CloudEvents handler.\n */\nexport interface WebPubSubEventHandlerOptions {\n  /**\n   * Custom serving path for the path of the CloudEvents handler.\n   */\n  path?: string;\n\n  /**\n   * Handle 'connect' event, the service waits for the response to proceed.\n   */\n  handleConnect?: (connectRequest: ConnectRequest, connectResponse: ConnectResponseHandler) => void;\n\n  /**\n   * Handle user events, the service waits for the response to proceed.\n   */\n  handleUserEvent?: (\n    userEventRequest: UserEventRequest,\n    userEventResponse: UserEventResponseHandler,\n  ) => void;\n\n  /**\n   * Event trigger for \"connected\" unblocking event. This is an unblocking event and the service does not wait for the response.\n   */\n  onConnected?: (connectedRequest: ConnectedRequest) => void;\n\n  /**\n   *\n   * Event triggers for \"disconnected\" unblocking event. This is an unblocking event and the service does not wait for the response.\n   */\n  onDisconnected?: (disconnectedRequest: DisconnectedRequest) => void;\n\n  /**\n   * If not specified, by default allow all the endpoints, otherwise only allow specified endpoints\n   */\n  allowedEndpoints?: string[];\n}\n"]}

package/dist/commonjs/index.d.ts

@@ -0,0 +1,3 @@
+export { WebPubSubEventHandler } from "./webPubSubEventHandler.js";
+export * from "./cloudEventsProtocols.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/commonjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,cAAc,2BAA2B,CAAC"}

package/dist/{index.js → commonjs/index.js}

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var url = require('url');
+var node_url = require('node:url');
 var logger$1 = require('@azure/logger');
 
 // Copyright (c) Microsoft Corporation.
@@ -226,7 +226,7 @@ class CloudEventsDispatcher {
             throw new Error("Unexpected WebPubSubEventHandlerOptions");
         }
         if ((eventHandler === null || eventHandler === void 0 ? void 0 : eventHandler.allowedEndpoints) !== undefined) {
-            this._allowedOrigins = eventHandler.allowedEndpoints.map((endpoint) => new url.URL(endpoint).host.toLowerCase());
+            this._allowedOrigins = eventHandler.allowedEndpoints.map((endpoint) => new node_url.URL(endpoint).host.toLowerCase());
             this._allowAll = false;
         }
     }