@heavybit/shared-lib 1.3.2 → 2.7.0

package/dist/cjs/messaging/staff-recipients.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.staffEmailListSchema = exports.ConfiguredStaffRecipients = void 0;
+/**
+ * Staff alert recipients (messaging layer helper): who receives an alert raised for a permission.
+ * Today the lists come from configuration; an app can plug in a lookup (e.g. its auth service)
+ * by implementing {@link StaffRecipientResolver}.
+ */
+const zod_1 = require("zod");
+const notification_dispatch_js_1 = require("../contracts/notification-dispatch.js");
+/**
+ * Recipients from configuration (env), keyed by the permission an alert targets.
+ *
+ * @param byPermission Map of permission → recipients, typically built with {@link staffEmailListSchema}.
+ * @example new ConfiguredStaffRecipients({ 'payouts.manage': env.FINANCE_ALERT_EMAILS })
+ */
+class ConfiguredStaffRecipients {
+    byPermission;
+    constructor(byPermission) {
+        this.byPermission = byPermission;
+    }
+    /**
+     * @param permission The permission an alert targets.
+     * @returns A copy of the configured recipients, or `[]` when none are configured.
+     */
+    async resolve(permission) {
+        return [...(this.byPermission[permission] ?? [])];
+    }
+}
+exports.ConfiguredStaffRecipients = ConfiguredStaffRecipients;
+const emailSchema = zod_1.z.string().email().max(notification_dispatch_js_1.DISPATCH_LIMITS.email);
+/**
+ * A comma-separated staff address list from env (`"a@x.io, b@y.io"`): trimmed, blanks dropped,
+ * de-duplicated case-insensitively. An invalid address fails validation, so a typo is caught at boot
+ * instead of dead-lettering in the notification-service when the alert finally fires.
+ *
+ * @returns (on parse) `DispatchRecipient[]` with `email` only.
+ * @example const config = z.object({ FINANCE_ALERT_EMAILS: staffEmailListSchema }).parse(process.env);
+ */
+exports.staffEmailListSchema = zod_1.z
+    .string()
+    .optional()
+    .transform((csv) => {
+    const seen = new Set();
+    return (csv ?? '')
+        .split(',')
+        .map((entry) => entry.trim())
+        .filter((email) => email && !seen.has(email.toLowerCase()) && seen.add(email.toLowerCase()));
+})
+    .superRefine((emails, ctx) => {
+    for (const email of emails) {
+        if (!emailSchema.safeParse(email).success)
+            ctx.addIssue({ code: zod_1.z.ZodIssueCode.custom, message: `Not a valid email address: ${email}` });
+    }
+})
+    .transform((emails) => emails.map((email) => ({ email })));
+//# sourceMappingURL=staff-recipients.js.map

package/dist/cjs/messaging/staff-recipients.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"staff-recipients.js","sourceRoot":"","sources":["../../../src/messaging/staff-recipients.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,6BAAwB;AACxB,oFAAgG;AAehG;;;;;GAKG;AACH,MAAa,yBAAyB;IACP;IAA7B,YAA6B,YAAoE;QAApE,iBAAY,GAAZ,YAAY,CAAwD;IAAG,CAAC;IAErG;;;OAGG;IACH,KAAK,CAAC,OAAO,CAAC,UAAkB;QAC9B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACpD,CAAC;CACF;AAVD,8DAUC;AAED,MAAM,WAAW,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,0CAAe,CAAC,KAAK,CAAC,CAAC;AAElE;;;;;;;GAOG;AACU,QAAA,oBAAoB,GAAG,OAAC;KAClC,MAAM,EAAE;KACR,QAAQ,EAAE;KACV,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;IACjB,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC;SACf,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;SAC5B,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;AACjG,CAAC,CAAC;KACD,WAAW,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;IAC3B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO;YAAE,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,8BAA8B,KAAK,EAAE,EAAE,CAAC,CAAC;IAC3I,CAAC;AACH,CAAC,CAAC;KACD,SAAS,CAAC,CAAC,MAAM,EAAuB,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC"}

package/dist/cjs/messaging/topology.js

@@ -1,22 +1,58 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deadLetterQueueName = exports.retryQueueName = void 0;
+exports.MIN_DELAY_BUCKET_MS = exports.deadLetterQueueName = exports.retryQueueName = void 0;
 exports.createTopology = createTopology;
+exports.delayQueueName = delayQueueName;
+const SEGMENT = /^[a-z0-9][a-z0-9_-]*$/;
+const PURPOSE = /^[a-z0-9][a-z0-9._-]*$/;
+function segment(label, value, pattern = SEGMENT) {
+    const v = value.trim();
+    if (!pattern.test(v))
+        throw new Error(`Topology ${label} must match ${pattern} (got "${value}")`);
+    return v;
+}
+/**
+ * Builds the naming scheme for one app and environment.
+ *
+ * @param options App slug and environment prefix.
+ * @returns The {@link Topology}.
+ * @throws Error when a segment is empty or has other characters.
+ * @example const topology = createTopology({ app: config.APP_SLUG, prefix: config.QUEUE_PREFIX });
+ */
 function createTopology(options) {
-    const app = options.app.trim();
-    const prefix = options.prefix.trim();
-    if (!app || !prefix)
-        throw new Error('Topology requires both app and prefix');
+    const app = segment('app', options.app);
+    const prefix = segment('prefix', options.prefix);
     return {
         app,
         prefix,
         eventsExchange: `${app}.${prefix}.events`,
         commandsExchange: `${app}.${prefix}.commands`,
         queue: (name) => (name.startsWith(`${prefix}.`) ? name : `${prefix}.${name}`),
+        queueName: (service, purpose) => `${prefix}.${segment('service', service)}.${segment('purpose', purpose, PURPOSE)}`,
+        deadLetterExchange: (service) => `${app}.${prefix}.${segment('service', service)}.dlx`,
     };
 }
+/** Retry queue for one delay: a fixed TTL, dead-lettering back into `queue`. */
 const retryQueueName = (queue, delayMs) => `${queue}.retry.${delayMs}`;
 exports.retryQueueName = retryQueueName;
+/** Dead-letter queue of `queue`. */
 const deadLetterQueueName = (queue) => `${queue}.dlq`;
 exports.deadLetterQueueName = deadLetterQueueName;
+/** Smallest delay bucket for {@link delayQueueName}. */
+exports.MIN_DELAY_BUCKET_MS = 1000;
+/**
+ * Delay queue for `scheduleDelayed`: one per power-of-two bucket (1s, 2s, 4s …) at or above `delayMs`.
+ * Per-message TTLs only expire at the head of a queue, so bucketing bounds how long a short delay can
+ * wait behind a longer one (at most its own bucket size).
+ *
+ * @param queue Target queue (physical name).
+ * @param delayMs Requested delay in milliseconds.
+ * @returns `{queue}.delay.{bucketMs}`.
+ */
+function delayQueueName(queue, delayMs) {
+    let bucket = exports.MIN_DELAY_BUCKET_MS;
+    while (bucket < delayMs)
+        bucket *= 2;
+    return `${queue}.delay.${bucket}`;
+}
 //# sourceMappingURL=topology.js.map

package/dist/cjs/messaging/topology.js.map

@@ -1 +1 @@
-{"version":3,"file":"topology.js","sourceRoot":"","sources":["../../../src/messaging/topology.ts"],"names":[],"mappings":";;;AAiBA,wCAWC;AAXD,SAAgB,cAAc,CAAC,OAAwC;IACrE,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IAC/B,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IACrC,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC9E,OAAO;QACL,GAAG;QACH,MAAM;QACN,cAAc,EAAE,GAAG,GAAG,IAAI,MAAM,SAAS;QACzC,gBAAgB,EAAE,GAAG,GAAG,IAAI,MAAM,WAAW;QAC7C,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;KACtF,CAAC;AACJ,CAAC;AAEM,MAAM,cAAc,GAAG,CAAC,KAAa,EAAE,OAAe,EAAE,EAAE,CAAC,GAAG,KAAK,UAAU,OAAO,EAAE,CAAC;AAAjF,QAAA,cAAc,kBAAmE;AACvF,MAAM,mBAAmB,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,GAAG,KAAK,MAAM,CAAC;AAAxD,QAAA,mBAAmB,uBAAqC"}
+{"version":3,"file":"topology.js","sourceRoot":"","sources":["../../../src/messaging/topology.ts"],"names":[],"mappings":";;;AAgDA,wCAYC;AAmBD,wCAIC;AApDD,MAAM,OAAO,GAAG,uBAAuB,CAAC;AACxC,MAAM,OAAO,GAAG,wBAAwB,CAAC;AAEzC,SAAS,OAAO,CAAC,KAAa,EAAE,KAAa,EAAE,OAAO,GAAG,OAAO;IAC9D,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IACvB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,YAAY,KAAK,eAAe,OAAO,UAAU,KAAK,IAAI,CAAC,CAAC;IAClG,OAAO,CAAC,CAAC;AACX,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,OAAwB;IACrD,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACxC,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACjD,OAAO;QACL,GAAG;QACH,MAAM;QACN,cAAc,EAAE,GAAG,GAAG,IAAI,MAAM,SAAS;QACzC,gBAAgB,EAAE,GAAG,GAAG,IAAI,MAAM,WAAW;QAC7C,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC;QACrF,SAAS,EAAE,CAAC,OAAe,EAAE,OAAe,EAAE,EAAE,CAAC,GAAG,MAAM,IAAI,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,OAAO,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE;QACnI,kBAAkB,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,MAAM,IAAI,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,MAAM;KAC/F,CAAC;AACJ,CAAC;AAED,gFAAgF;AACzE,MAAM,cAAc,GAAG,CAAC,KAAa,EAAE,OAAe,EAAE,EAAE,CAAC,GAAG,KAAK,UAAU,OAAO,EAAE,CAAC;AAAjF,QAAA,cAAc,kBAAmE;AAC9F,oCAAoC;AAC7B,MAAM,mBAAmB,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,GAAG,KAAK,MAAM,CAAC;AAAxD,QAAA,mBAAmB,uBAAqC;AAErE,wDAAwD;AAC3C,QAAA,mBAAmB,GAAG,IAAI,CAAC;AAExC;;;;;;;;GAQG;AACH,SAAgB,cAAc,CAAC,KAAa,EAAE,OAAe;IAC3D,IAAI,MAAM,GAAG,2BAAmB,CAAC;IACjC,OAAO,MAAM,GAAG,OAAO;QAAE,MAAM,IAAI,CAAC,CAAC;IACrC,OAAO,GAAG,KAAK,UAAU,MAAM,EAAE,CAAC;AACpC,CAAC"}

package/dist/cjs/rate-limit/index.js

@@ -1,5 +1,20 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.limiterKey = void 0;
 exports.createLimiter = createLimiter;
 exports.consumeOrThrow = consumeOrThrow;
 exports.rateLimitMiddleware = rateLimitMiddleware;
@@ -7,23 +22,49 @@ const rate_limiter_flexible_1 = require("rate-limiter-flexible");
 const response_js_1 = require("../common/response.js");
 const errors_js_1 = require("../common/errors.js");
 const index_js_1 = require("../logging/index.js");
-/** Redis limiter with an in-memory insurance limiter so a Redis outage never blocks traffic. */
+const keyspace_js_1 = require("../cache/keyspace.js");
+const keys_js_1 = require("./keys.js");
+__exportStar(require("./keys.js"), exports);
+/**
+ * Redis limiter with an in-memory insurance limiter so a Redis outage never blocks traffic. Its
+ * keys come from the keyspace; pass already-encoded keys (see {@link limiterKey}) to `consume`.
+ *
+ * @param options Points, window, keyspace and scope.
+ * @returns The limiter.
+ * @example const limiter = createLimiter({ keyspace: ks, scope: 'sign-in-ip', points: 10, durationSec: 60, redis });
+ */
 function createLimiter(options) {
-    const memory = new rate_limiter_flexible_1.RateLimiterMemory({ keyPrefix: options.keyPrefix, points: options.points, duration: options.durationSec, blockDuration: options.blockDurationSec ?? 0 });
+    const keyPrefix = options.keyspace.key(keys_js_1.RATE_LIMIT_PURPOSE, options.scope);
+    const memory = new rate_limiter_flexible_1.RateLimiterMemory({ keyPrefix, points: options.points, duration: options.durationSec, blockDuration: options.blockDurationSec ?? 0 });
     if (!options.redis)
         return memory;
     return new rate_limiter_flexible_1.RateLimiterRedis({
         storeClient: options.redis,
-        keyPrefix: options.keyPrefix,
+        keyPrefix,
         points: options.points,
         duration: options.durationSec,
         blockDuration: options.blockDurationSec ?? 0,
         insuranceLimiter: memory,
     });
 }
+/**
+ * Encodes a raw limiter key (user id, IP …) so it cannot add segments to the limiter's Redis key.
+ *
+ * @param raw Raw identifier.
+ * @returns The encoded key part.
+ * @example limiter.consume(limiterKey(req.ip))
+ */
+const limiterKey = (raw) => (0, keyspace_js_1.encodeKeyPart)(raw);
+exports.limiterKey = limiterKey;
 /**
  * Consumes one point for `key`; throws TooManyRequestsError (429) when exhausted.
- * For in-service checks such as per-identifier login throttling.
+ * For in-service checks such as per-identifier sign-in throttling.
+ *
+ * @param limiter Limiter from {@link createLimiter}.
+ * @param key Encoded key (see {@link limiterKey}).
+ * @param message Optional public message for the 429.
+ * @throws TooManyRequestsError when the limit is exhausted; rethrows limiter failures.
+ * @example await consumeOrThrow(limiter, limiterKey(userId));
  */
 async function consumeOrThrow(limiter, key, message) {
     try {
@@ -35,13 +76,23 @@ async function consumeOrThrow(limiter, key, message) {
         throw rejection;
     }
 }
+/**
+ * Express middleware that consumes one point per request. Sets `X-RateLimit-Limit` and
+ * `X-RateLimit-Remaining`; when exhausted answers 429 `RATE_LIMITED` with `Retry-After` (seconds).
+ * Fails open: a limiter error (not a rejection) is logged and the request continues.
+ *
+ * @param options Limiter options and `keyOf` (default user id, else client IP).
+ * @returns The middleware.
+ * @example router.post('/sessions', rateLimitMiddleware({ keyspace: ks, scope: 'sign-in-ip', points: 10, durationSec: 60, redis }), handler);
+ */
 function rateLimitMiddleware(options) {
     const limiter = createLimiter(options);
     const logger = options.logger ?? index_js_1.silentLogger;
     const keyOf = options.keyOf ?? ((req) => req.user?.id ?? req.ip ?? 'unknown');
+    const scope = options.scope;
     return async (req, res, next) => {
         try {
-            const result = await limiter.consume(keyOf(req));
+            const result = await limiter.consume((0, exports.limiterKey)(keyOf(req)));
             res.setHeader('X-RateLimit-Limit', options.points);
             res.setHeader('X-RateLimit-Remaining', result.remainingPoints);
             next();
@@ -49,7 +100,7 @@ function rateLimitMiddleware(options) {
         catch (rejection) {
             const ms = rejection?.msBeforeNext;
             if (typeof ms !== 'number') {
-                logger.error('Rate limiter failure; allowing request', { keyPrefix: options.keyPrefix, error: String(rejection) });
+                logger.error('Rate limiter failure; allowing request', { scope, error: String(rejection) });
                 next();
                 return;
             }

package/dist/cjs/rate-limit/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/rate-limit/index.ts"],"names":[],"mappings":";;AAoBA,sCAWC;AAMD,wCAOC;AAOD,kDAsBC;AAvED,iEAAsG;AACtG,uDAAsD;AACtD,mDAA2D;AAC3D,kDAAmD;AAcnD,gGAAgG;AAChG,SAAgB,aAAa,CAAC,OAAyB;IACrD,MAAM,MAAM,GAAG,IAAI,yCAAiB,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,WAAW,EAAE,aAAa,EAAE,OAAO,CAAC,gBAAgB,IAAI,CAAC,EAAE,CAAC,CAAC;IAC5K,IAAI,CAAC,OAAO,CAAC,KAAK;QAAE,OAAO,MAAM,CAAC;IAClC,OAAO,IAAI,wCAAgB,CAAC;QAC1B,WAAW,EAAE,OAAO,CAAC,KAAK;QAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,QAAQ,EAAE,OAAO,CAAC,WAAW;QAC7B,aAAa,EAAE,OAAO,CAAC,gBAAgB,IAAI,CAAC;QAC5C,gBAAgB,EAAE,MAAM;KACzB,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,cAAc,CAAC,OAA4B,EAAE,GAAW,EAAE,OAAgB;IAC9F,IAAI,CAAC;QACH,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAAC,OAAO,SAAS,EAAE,CAAC;QACnB,IAAI,OAAQ,SAAuC,EAAE,YAAY,KAAK,QAAQ;YAAE,MAAM,IAAI,gCAAoB,CAAC,OAAO,CAAC,CAAC;QACxH,MAAM,SAAS,CAAC;IAClB,CAAC;AACH,CAAC;AAOD,SAAgB,mBAAmB,CAAC,OAAmC;IACrE,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,uBAAY,CAAC;IAC9C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,GAAY,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,IAAI,GAAG,CAAC,EAAE,IAAI,SAAS,CAAC,CAAC;IAEvF,OAAO,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAiB,EAAE;QAC9E,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;YACjD,GAAG,CAAC,SAAS,CAAC,mBAAmB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;YACnD,GAAG,CAAC,SAAS,CAAC,uBAAuB,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;YAC/D,IAAI,EAAE,CAAC;QACT,CAAC;QAAC,OAAO,SAAS,EAAE,CAAC;YACnB,MAAM,EAAE,GAAI,SAAuC,EAAE,YAAY,CAAC;YAClE,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;gBAC3B,MAAM,CAAC,KAAK,CAAC,wCAAwC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;gBACnH,IAAI,EAAE,CAAC;gBACP,OAAO;YACT,CAAC;YACD,GAAG,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;YACnD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAA,2BAAa,EAAC,4CAA4C,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC;QAC/G,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/rate-limit/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAkCA,sCAYC;AAqBD,wCAOC;AAiBD,kDAuBC;AAhHD,iEAAsG;AACtG,uDAAsD;AACtD,mDAA2D;AAC3D,kDAAmD;AAEnD,sDAAyE;AACzE,uCAA+C;AAE/C,4CAA0B;AAgB1B;;;;;;;GAOG;AACH,SAAgB,aAAa,CAAC,OAAyB;IACrD,MAAM,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,4BAAkB,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAC1E,MAAM,MAAM,GAAG,IAAI,yCAAiB,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,WAAW,EAAE,aAAa,EAAE,OAAO,CAAC,gBAAgB,IAAI,CAAC,EAAE,CAAC,CAAC;IACzJ,IAAI,CAAC,OAAO,CAAC,KAAK;QAAE,OAAO,MAAM,CAAC;IAClC,OAAO,IAAI,wCAAgB,CAAC;QAC1B,WAAW,EAAE,OAAO,CAAC,KAAK;QAC1B,SAAS;QACT,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,QAAQ,EAAE,OAAO,CAAC,WAAW;QAC7B,aAAa,EAAE,OAAO,CAAC,gBAAgB,IAAI,CAAC;QAC5C,gBAAgB,EAAE,MAAM;KACzB,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACI,MAAM,UAAU,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,IAAA,2BAAa,EAAC,GAAG,CAAC,CAAC;AAAzD,QAAA,UAAU,cAA+C;AAEtE;;;;;;;;;GASG;AACI,KAAK,UAAU,cAAc,CAAC,OAA4B,EAAE,GAAW,EAAE,OAAgB;IAC9F,IAAI,CAAC;QACH,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAAC,OAAO,SAAS,EAAE,CAAC;QACnB,IAAI,OAAQ,SAAuC,EAAE,YAAY,KAAK,QAAQ;YAAE,MAAM,IAAI,gCAAoB,CAAC,OAAO,CAAC,CAAC;QACxH,MAAM,SAAS,CAAC;IAClB,CAAC;AACH,CAAC;AAQD;;;;;;;;GAQG;AACH,SAAgB,mBAAmB,CAAC,OAAmC;IACrE,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,uBAAY,CAAC;IAC9C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,GAAY,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,IAAI,GAAG,CAAC,EAAE,IAAI,SAAS,CAAC,CAAC;IACvF,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;IAE5B,OAAO,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAiB,EAAE;QAC9E,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,IAAA,kBAAU,EAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC7D,GAAG,CAAC,SAAS,CAAC,mBAAmB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;YACnD,GAAG,CAAC,SAAS,CAAC,uBAAuB,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;YAC/D,IAAI,EAAE,CAAC;QACT,CAAC;QAAC,OAAO,SAAS,EAAE,CAAC;YACnB,MAAM,EAAE,GAAI,SAAuC,EAAE,YAAY,CAAC;YAClE,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;gBAC3B,MAAM,CAAC,KAAK,CAAC,wCAAwC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;gBAC5F,IAAI,EAAE,CAAC;gBACP,OAAO;YACT,CAAC;YACD,GAAG,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;YACnD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAA,2BAAa,EAAC,4CAA4C,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC;QAC/G,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/dist/cjs/rate-limit/keys.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RATE_LIMIT_PURPOSE = void 0;
+exports.rateLimitKey = rateLimitKey;
+const index_js_1 = require("../config/index.js");
+const keyspace_js_1 = require("../cache/keyspace.js");
+/**
+ * Rate-limit key builder and the sliding-window limiter contract. Dependency-free (exported from the
+ * package root as well as `/rate-limit`); the consuming service implements the sliding window.
+ */
+/** Purpose segment for every rate-limit key: `{prefix}rl:{scope}:…`. */
+exports.RATE_LIMIT_PURPOSE = 'rl';
+const SCOPE_PATTERN = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
+const DIMENSIONS = ['ip', 'userId', 'email', 'host', 'route'];
+const DIMENSION_SEGMENT = { ip: 'ip', userId: 'user', email: 'email', host: 'host', route: 'route' };
+function dimensionValue(name, raw) {
+    const value = raw.trim();
+    if (name === 'email')
+        return (0, keyspace_js_1.sensitivePart)(value.toLowerCase());
+    if (name === 'host')
+        return value.toLowerCase();
+    return value;
+}
+/**
+ * Builds `{prefix}rl:{scope}[:ip:{ip}][:user:{id}][:email:{hash}][:host:{host}][:route:{route}]`.
+ *
+ * @param keyspace The service keyspace.
+ * @param input Scope plus at least one dimension.
+ * @returns The rate-limit key.
+ * @throws ConfigError when no dimension is given or the scope is invalid.
+ * @example rateLimitKey(ks, { scope: 'sign-in', ip: req.ip, email: body.email })
+ */
+function rateLimitKey(keyspace, input) {
+    if (!SCOPE_PATTERN.test(input.scope))
+        throw new index_js_1.ConfigError(`Rate-limit scope "${input.scope}" must be lower-case kebab-case`);
+    const parts = [];
+    for (const name of DIMENSIONS) {
+        const raw = input[name];
+        if (raw === undefined || raw.trim() === '')
+            continue;
+        parts.push(DIMENSION_SEGMENT[name], dimensionValue(name, raw));
+    }
+    if (!parts.length)
+        throw new index_js_1.ConfigError(`Rate-limit key "${input.scope}" needs at least one of ${DIMENSIONS.join(', ')}`);
+    return keyspace.key(exports.RATE_LIMIT_PURPOSE, input.scope, ...parts);
+}
+//# sourceMappingURL=keys.js.map

package/dist/cjs/rate-limit/keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.js","sourceRoot":"","sources":["../../../src/rate-limit/keys.ts"],"names":[],"mappings":";;;AA+CA,oCAUC;AAzDD,iDAAiD;AACjD,sDAA2G;AAE3G;;;GAGG;AAEH,wEAAwE;AAC3D,QAAA,kBAAkB,GAAG,IAAI,CAAC;AAgBvC,MAAM,aAAa,GAAG,4BAA4B,CAAC;AACnD,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAU,CAAC;AAGvE,MAAM,iBAAiB,GAA8B,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAEhI,SAAS,cAAc,CAAC,IAAe,EAAE,GAAW;IAClD,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IACzB,IAAI,IAAI,KAAK,OAAO;QAAE,OAAO,IAAA,2BAAa,EAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;IAChE,IAAI,IAAI,KAAK,MAAM;QAAE,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;IAChD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,YAAY,CAAC,QAAuB,EAAE,KAAwB;IAC5E,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;QAAE,MAAM,IAAI,sBAAW,CAAC,qBAAqB,KAAK,CAAC,KAAK,iCAAiC,CAAC,CAAC;IAC/H,MAAM,KAAK,GAAmB,EAAE,CAAC;IACjC,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QAC9B,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QACxB,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,SAAS;QACrD,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,MAAM,IAAI,sBAAW,CAAC,mBAAmB,KAAK,CAAC,KAAK,2BAA2B,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC3H,OAAO,QAAQ,CAAC,GAAG,CAAC,0BAAkB,EAAE,KAAK,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,CAAC;AACjE,CAAC"}

package/dist/cjs/socket/index.js

@@ -1,27 +1,48 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.userRoom = void 0;
 exports.createSocketServer = createSocketServer;
 exports.gatewaySocketAuth = gatewaySocketAuth;
+exports.createTicketHandshake = createTicketHandshake;
+exports.createTicketSocketServer = createTicketSocketServer;
+const redis_adapter_1 = require("@socket.io/redis-adapter");
 const socket_io_1 = require("socket.io");
 const index_js_1 = require("../identity/index.js");
 const index_js_2 = require("../logging/index.js");
+const ticket_js_1 = require("./ticket.js");
+__exportStar(require("./ticket.js"), exports);
+/** Name of the private room every connection of `userId` joins. */
 const userRoom = (userId) => `user:${userId}`;
 exports.userRoom = userRoom;
-function createSocketServer(httpServer, options) {
-    const logger = options.logger ?? index_js_2.silentLogger;
+/** Builds the server: authenticate every handshake, then join only server-derived rooms. */
+function buildServer(httpServer, core) {
+    const { logger } = core;
     const io = new socket_io_1.Server(httpServer, {
-        path: options.path,
-        cors: { origin: options.corsOrigins?.length ? options.corsOrigins : false, credentials: true },
-        ...(options.adapter ? { adapter: options.adapter } : {}),
-        ...options.serverOptions,
+        path: core.path,
+        cors: core.cors,
+        ...(core.adapter ? { adapter: core.adapter } : {}),
+        ...core.serverOptions,
     });
     io.use(async (socket, next) => {
         try {
-            const user = await options.authenticate(socket);
-            if (!user)
+            const identity = await core.authenticate(socket);
+            if (!identity)
                 return next(new Error('Authentication failed'));
-            socket.data.user = user;
+            socket.data.identity = identity;
             next();
         }
         catch (error) {
@@ -30,11 +51,12 @@ function createSocketServer(httpServer, options) {
         }
     });
     io.on('connection', (socket) => {
-        const user = socket.data.user;
-        const rooms = options.rooms ? options.rooms(user) : [(0, exports.userRoom)(user.id)];
+        const identity = socket.data.identity;
+        const userId = core.userIdOf(identity);
+        const rooms = core.rooms(identity);
         void socket.join(rooms);
-        logger.debug('Socket connected', { userId: user.id, rooms });
-        socket.on('disconnect', (reason) => logger.debug('Socket disconnected', { userId: user.id, reason }));
+        logger.debug('Socket connected', { userId, rooms });
+        socket.on('disconnect', (reason) => logger.debug('Socket disconnected', { userId, reason }));
     });
     return {
         io,
@@ -43,11 +65,100 @@ function createSocketServer(httpServer, options) {
         close: () => new Promise((resolve) => { io.close(() => resolve()); }),
     };
 }
-/** Trusts the gateway-signed identity headers forwarded on the WebSocket upgrade request. */
-function gatewaySocketAuth(secret) {
+/**
+ * Creates a Socket.IO server that authenticates every connection and joins it only to server-derived rooms.
+ * The verified user is in `socket.data.identity`.
+ *
+ * @example const sockets = createSocketServer(httpServer, { path: '/ws', authenticate: gatewaySocketAuth({ secret, protocol }) });
+ */
+function createSocketServer(httpServer, options) {
+    return buildServer(httpServer, {
+        path: options.path,
+        cors: { origin: options.corsOrigins?.length ? options.corsOrigins : false, credentials: true },
+        adapter: options.adapter,
+        serverOptions: options.serverOptions,
+        logger: options.logger ?? index_js_2.silentLogger,
+        authenticate: options.authenticate,
+        userIdOf: (user) => user.id,
+        rooms: options.rooms ?? ((user) => [(0, exports.userRoom)(user.id)]),
+    });
+}
+/**
+ * Trusts the gateway-signed (v2) identity headers forwarded on the WebSocket upgrade request. The gateway
+ * signs the upgrade as `GET <handshake path>` (query ignored).
+ *
+ * @param options The shared secret (at least 32 characters) and the app's identity protocol.
+ * @returns An `authenticate` function for {@link createSocketServer}.
+ * @example createSocketServer(server, { path: '/ws', authenticate: gatewaySocketAuth({ secret, protocol }) });
+ */
+function gatewaySocketAuth(options) {
+    const secret = (0, index_js_1.assertGatewaySecret)(options.secret);
     return (socket) => {
-        const result = (0, index_js_1.verifyIdentityHeaders)(socket.handshake.headers, secret);
+        const result = (0, index_js_1.verifyGatewayIdentity)({
+            headers: socket.handshake.headers, method: 'GET', path: socket.handshake.url, secret, protocol: options.protocol,
+        });
         return result.status === 'authenticated' ? result.user : null;
     };
 }
+/**
+ * The handshake check on its own (testable without a server): verifies the ticket from
+ * `socket.handshake.auth.ticket`, then the browser origin against `allowedOrigins(claims)`, then
+ * single use.
+ *
+ * @param options Ticket keys, audience, origin rule, replay check and rejection hook.
+ * @returns `authenticate(socket)` resolving to the claims, or null when refused.
+ */
+function createTicketHandshake(options) {
+    const reject = (reason, userId, origin) => {
+        options.onRejected?.({ reason, userId, path: options.path, origin });
+        return null;
+    };
+    return async (socket) => {
+        const origin = typeof socket.handshake.headers.origin === 'string' ? socket.handshake.headers.origin : null;
+        const auth = (socket.handshake.auth ?? {});
+        const result = (0, ticket_js_1.verifySocketTicket)(auth.ticket, options);
+        if (!result.ok)
+            return reject(result.reason, null, origin);
+        const { claims } = result;
+        if (origin ? !(await options.allowedOrigins(claims)).includes(origin) : !options.allowMissingOrigin) {
+            return reject('origin_not_allowed', claims.userId, origin);
+        }
+        if (options.isFirstUse && !(await options.isFirstUse(claims)))
+            return reject('replayed', claims.userId, origin);
+        return claims;
+    };
+}
+/**
+ * Creates a Socket.IO server whose clients authenticate with a short-lived ticket
+ * (`io(url, { path, auth: (cb) => getTicket().then((ticket) => cb({ ticket })) })`). Each connection
+ * auto-joins `user:{userId}`; the verified claims are in `socket.data.identity` for later room checks
+ * with `canJoinScopeRoom`.
+ *
+ * @param options HTTP server, path, ticket keys, origin rule, Redis + keyspace, rejection hook.
+ * @returns The emitter.
+ * @example createTicketSocketServer({ httpServer, path: '/ws', secret, domain, audience: 'admin-app', redis, keyspace, allowedOrigins: () => origins, onRejected })
+ */
+function createTicketSocketServer(options) {
+    const { redis, keyspace } = options;
+    if (redis && !keyspace)
+        throw new Error('createTicketSocketServer: a keyspace is required with redis');
+    const isFirstUse = redis && keyspace
+        ? async (claims) => {
+            const ttl = Math.max(1, claims.exp - Math.floor(Date.now() / 1000));
+            return (await redis.set(keyspace.key('socket-ticket', claims.jti), '1', 'EX', ttl, 'NX')) === 'OK';
+        }
+        : undefined;
+    const authenticate = createTicketHandshake({ ...options, isFirstUse });
+    return buildServer(options.httpServer, {
+        path: options.path,
+        // Browsers do not apply CORS to WebSocket upgrades; the per-ticket origin check above is the real gate.
+        cors: { origin: true, credentials: false },
+        adapter: redis && keyspace ? (0, redis_adapter_1.createAdapter)(redis, redis.duplicate(), { key: keyspace.key('socket-io') }) : undefined,
+        serverOptions: options.serverOptions,
+        logger: options.logger ?? index_js_2.silentLogger,
+        authenticate,
+        userIdOf: (claims) => claims.userId,
+        rooms: (claims) => [(0, exports.userRoom)(claims.userId), ...(options.rooms?.(claims) ?? [])],
+    });
+}
 //# sourceMappingURL=index.js.map

package/dist/cjs/socket/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/socket/index.ts"],"names":[],"mappings":";;;AAgCA,gDAmCC;AAGD,8CAKC;AA1ED,yCAAoE;AACpE,mDAA6D;AAC7D,kDAAmD;AA2B5C,MAAM,QAAQ,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,QAAQ,MAAM,EAAE,CAAC;AAAhD,QAAA,QAAQ,YAAwC;AAE7D,SAAgB,kBAAkB,CAAC,UAAsB,EAAE,OAA4B;IACrF,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,uBAAY,CAAC;IAC9C,MAAM,EAAE,GAAG,IAAI,kBAAM,CAAC,UAAU,EAAE;QAChC,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE;QAC9F,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxD,GAAG,OAAO,CAAC,aAAa;KACzB,CAAC,CAAC;IAEH,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;QAC5B,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YAChD,IAAI,CAAC,IAAI;gBAAE,OAAO,IAAI,CAAC,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC;YAC3D,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YACxB,IAAI,EAAE,CAAC;QACT,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,IAAI,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAG,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;YACnF,IAAI,CAAC,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE;QAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAgB,CAAC;QAC1C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAA,gBAAQ,EAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QACxE,KAAK,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,MAAM,CAAC,KAAK,CAAC,kBAAkB,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC7D,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IACxG,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,EAAE;QACF,UAAU,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,IAAA,gBAAQ,EAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QACzF,UAAU,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3E,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;KAC5E,CAAC;AACJ,CAAC;AAED,6FAA6F;AAC7F,SAAgB,iBAAiB,CAAC,MAAc;IAC9C,OAAO,CAAC,MAAc,EAAmB,EAAE;QACzC,MAAM,MAAM,GAAG,IAAA,gCAAqB,EAAC,MAAM,CAAC,SAAS,CAAC,OAAiC,EAAE,MAAM,CAAC,CAAC;QACjG,OAAO,MAAM,CAAC,MAAM,KAAK,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAChE,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/socket/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAgGA,gDAWC;AAUD,8CAQC;AAuCD,sDAiBC;AA6BD,4DAqBC;AAtOD,4DAAyD;AAEzD,yCAAoE;AAEpE,mDAAyG;AACzG,kDAAmD;AAEnD,2CAAmI;AAEnI,8CAA4B;AA0B5B,mEAAmE;AAC5D,MAAM,QAAQ,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,QAAQ,MAAM,EAAE,CAAC;AAAhD,QAAA,QAAQ,YAAwC;AAc7D,4FAA4F;AAC5F,SAAS,WAAW,CAAI,UAAsB,EAAE,IAAmB;IACjE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACxB,MAAM,EAAE,GAAG,IAAI,kBAAM,CAAC,UAAU,EAAE;QAChC,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClD,GAAG,IAAI,CAAC,aAAa;KACtB,CAAC,CAAC;IAEH,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;QAC5B,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YACjD,IAAI,CAAC,QAAQ;gBAAE,OAAO,IAAI,CAAC,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC;YAC/D,MAAM,CAAC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;YAChC,IAAI,EAAE,CAAC;QACT,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,IAAI,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAG,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;YACnF,IAAI,CAAC,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE;QAC7B,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,QAAa,CAAC;QAC3C,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACnC,KAAK,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxB,MAAM,CAAC,KAAK,CAAC,kBAAkB,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QACpD,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC/F,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,EAAE;QACF,UAAU,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,IAAA,gBAAQ,EAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QACzF,UAAU,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3E,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;KAC5E,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,UAAsB,EAAE,OAA4B;IACrF,OAAO,WAAW,CAAW,UAAU,EAAE;QACvC,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE;QAC9F,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,uBAAY;QACtC,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE;QAC3B,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAA,gBAAQ,EAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;KACxD,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAAC,OAAuD;IACvF,MAAM,MAAM,GAAG,IAAA,8BAAmB,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnD,OAAO,CAAC,MAAc,EAAmB,EAAE;QACzC,MAAM,MAAM,GAAG,IAAA,gCAAqB,EAAC;YACnC,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,OAAiC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3I,CAAC,CAAC;QACH,OAAO,MAAM,CAAC,MAAM,KAAK,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IAChE,CAAC,CAAC;AACJ,CAAC;AA+BD;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CAAC,OAA+B;IACnE,MAAM,MAAM,GAAG,CAAC,MAA6B,EAAE,MAAqB,EAAE,MAAqB,EAAE,EAAE;QAC7F,OAAO,CAAC,UAAU,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QACrE,OAAO,IAAI,CAAC;IACd,CAAC,CAAC;IACF,OAAO,KAAK,EAAE,MAAM,EAAE,EAAE;QACtB,MAAM,MAAM,GAAG,OAAO,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5G,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAyB,CAAC;QACnE,MAAM,MAAM,GAAG,IAAA,8BAAkB,EAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACxD,IAAI,CAAC,MAAM,CAAC,EAAE;YAAE,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAC3D,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC;YACpG,OAAO,MAAM,CAAC,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAAE,OAAO,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChH,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAmBD;;;;;;;;;GASG;AACH,SAAgB,wBAAwB,CAAC,OAAkC;IACzE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IACpC,IAAI,KAAK,IAAI,CAAC,QAAQ;QAAE,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;IACvG,MAAM,UAAU,GAAG,KAAK,IAAI,QAAQ;QAClC,CAAC,CAAC,KAAK,EAAE,MAA0B,EAAE,EAAE;YACrC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;YACpE,OAAO,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC;QACrG,CAAC;QACD,CAAC,CAAC,SAAS,CAAC;IACd,MAAM,YAAY,GAAG,qBAAqB,CAAC,EAAE,GAAG,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IACvE,OAAO,WAAW,CAAqB,OAAO,CAAC,UAAU,EAAE;QACzD,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,wGAAwG;QACxG,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE;QAC1C,OAAO,EAAE,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,IAAA,6BAAa,EAAC,KAAK,EAAE,KAAK,CAAC,SAAS,EAAE,EAAE,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS;QACpH,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,uBAAY;QACtC,YAAY;QACZ,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM;QACnC,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAA,gBAAQ,EAAC,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;KACjF,CAAC,CAAC;AACL,CAAC"}

package/dist/cjs/socket/ticket.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scopeRoom = exports.MIN_SOCKET_TICKET_SECRET_LENGTH = exports.SOCKET_TICKET_MAX_TTL_SECONDS = void 0;
+exports.signSocketTicket = signSocketTicket;
+exports.verifySocketTicket = verifySocketTicket;
+exports.canJoinScopeRoom = canJoinScopeRoom;
+const index_js_1 = require("../access/index.js");
+const crypto_js_1 = require("../common/crypto.js");
+const id_js_1 = require("../common/id.js");
+/**
+ * Short-lived socket handshake tickets. The browser cannot send its in-memory access token on a
+ * WebSocket upgrade header, so it asks the API for a ticket (≤ 60 s) and passes it in the Socket.IO
+ * `auth` payload. A ticket is `v1.<base64url claims>.<base64url HMAC-SHA256>`, signed over a domain
+ * separator so a ticket minted for another app or purpose never verifies here.
+ *
+ * Dependency-free (no socket.io), so the issuer can sign tickets without the socket stack.
+ */
+/** Longest allowed ticket lifetime (and the default), in seconds. */
+exports.SOCKET_TICKET_MAX_TTL_SECONDS = 60;
+/** Shortest accepted signing secret. */
+exports.MIN_SOCKET_TICKET_SECRET_LENGTH = 32;
+const VERSION = 'v1';
+/** Tolerated clock skew for `iat` in the future, in seconds. */
+const MAX_FUTURE_SKEW_SECONDS = 5;
+function assertKey(options) {
+    if (!options.secret || options.secret.length < exports.MIN_SOCKET_TICKET_SECRET_LENGTH) {
+        throw new Error(`Socket ticket secret must be at least ${exports.MIN_SOCKET_TICKET_SECRET_LENGTH} characters`);
+    }
+    if (!options.domain)
+        throw new Error('Socket tickets need a domain separator');
+}
+const signature = (options, body) => Buffer.from((0, crypto_js_1.hmacSha256)(options.secret, `${options.domain}\n${VERSION}.${body}`), 'hex').toString('base64url');
+const nowSeconds = (options) => Math.floor((options.now?.() ?? new Date()).getTime() / 1000);
+/**
+ * Signs a ticket.
+ *
+ * @param input User, audience, scopes and permissions.
+ * @param options Secret, domain separator and `ttlSeconds` (1–60, default 60).
+ * @returns The ticket string.
+ * @example signSocketTicket({ userId, aud: 'admin-app', scopes: { tenant: [tenantId] }, permissions }, { secret, domain: 'myapp-socket-ticket:v1' })
+ */
+function signSocketTicket(input, options) {
+    assertKey(options);
+    const ttl = options.ttlSeconds ?? exports.SOCKET_TICKET_MAX_TTL_SECONDS;
+    if (!Number.isInteger(ttl) || ttl < 1 || ttl > exports.SOCKET_TICKET_MAX_TTL_SECONDS) {
+        throw new RangeError(`Socket ticket TTL must be 1–${exports.SOCKET_TICKET_MAX_TTL_SECONDS} seconds`);
+    }
+    if (!input.userId || !input.aud)
+        throw new RangeError('Socket tickets need a user id and an audience');
+    const iat = nowSeconds(options);
+    const claims = {
+        userId: input.userId,
+        aud: input.aud,
+        scopes: input.scopes ?? {},
+        permissions: input.permissions ?? [],
+        isSuperAdmin: input.isSuperAdmin === true,
+        jti: (0, id_js_1.newId)(),
+        iat,
+        exp: iat + ttl,
+    };
+    const body = Buffer.from(JSON.stringify(claims)).toString('base64url');
+    return `${VERSION}.${body}.${signature(options, body)}`;
+}
+function parseClaims(body) {
+    try {
+        const c = JSON.parse(Buffer.from(body, 'base64url').toString('utf8'));
+        const valid = typeof c.userId === 'string' && typeof c.aud === 'string' && typeof c.jti === 'string'
+            && Number.isInteger(c.iat) && Number.isInteger(c.exp) && Array.isArray(c.permissions)
+            && !!c.scopes && typeof c.scopes === 'object' && typeof c.isSuperAdmin === 'boolean';
+        return valid ? c : null;
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * Verifies a ticket's signature, domain, lifetime and audience. Never throws for a bad ticket.
+ *
+ * @param ticket The string from the handshake.
+ * @param options Secret, domain separator and the accepted audience(s).
+ * @returns The claims, or the rejection reason.
+ * @example const result = verifySocketTicket(socket.handshake.auth.ticket, { secret, domain, audience: 'admin-app' });
+ */
+function verifySocketTicket(ticket, options) {
+    assertKey(options);
+    if (typeof ticket !== 'string' || !ticket)
+        return { ok: false, reason: 'missing' };
+    const parts = ticket.split('.');
+    if (parts.length !== 3 || parts[0] !== VERSION || !parts[1] || !parts[2])
+        return { ok: false, reason: 'malformed' };
+    if (!(0, crypto_js_1.safeEqual)(parts[2], signature(options, parts[1])))
+        return { ok: false, reason: 'bad_signature' };
+    const claims = parseClaims(parts[1]);
+    if (!claims)
+        return { ok: false, reason: 'malformed' };
+    const now = nowSeconds(options);
+    if (claims.exp <= now || claims.exp - claims.iat > exports.SOCKET_TICKET_MAX_TTL_SECONDS || claims.iat > now + MAX_FUTURE_SKEW_SECONDS) {
+        return { ok: false, reason: 'expired' };
+    }
+    const audiences = typeof options.audience === 'string' ? [options.audience] : options.audience;
+    if (!audiences.includes(claims.aud))
+        return { ok: false, reason: 'wrong_audience' };
+    return { ok: true, claims };
+}
+/** Name of the room for one scope id, e.g. `tenant:01J…`. */
+const scopeRoom = (scope, scopeId) => `${scope}:${scopeId}`;
+exports.scopeRoom = scopeRoom;
+/**
+ * True when the ticket holder may join the room of `scopeId` in `scope`: the id is in the ticket's scope
+ * ids (or the holder is a super admin) and, when given, the holder has `permission`.
+ *
+ * @param claims Verified ticket claims.
+ * @param scope Scope name, e.g. `tenant`.
+ * @param scopeId The id whose room is requested.
+ * @param permission Permission the room needs (optional).
+ * @example canJoinScopeRoom(claims, 'tenant', tenantId, 'widgets.view')
+ */
+function canJoinScopeRoom(claims, scope, scopeId, permission) {
+    const inScope = claims.isSuperAdmin || (claims.scopes[scope] ?? []).includes(scopeId);
+    if (!inScope || !scopeId)
+        return false;
+    return permission ? (0, index_js_1.hasPermission)(claims, permission) : true;
+}
+//# sourceMappingURL=ticket.js.map