@heavybit/shared-lib 2.1.0 → 2.7.0

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ticket.js","sourceRoot":"","sources":["../../../src/socket/ticket.ts"],"names":[],"mappings":";;;AAiFA,4CAoBC;AAsBD,gDAeC;AAeD,4CAIC;AA7JD,iDAAmD;AACnD,mDAA4D;AAC5D,2CAAwC;AAExC;;;;;;;GAOG;AAEH,qEAAqE;AACxD,QAAA,6BAA6B,GAAG,EAAE,CAAC;AAChD,wCAAwC;AAC3B,QAAA,+BAA+B,GAAG,EAAE,CAAC;AAClD,MAAM,OAAO,GAAG,IAAI,CAAC;AACrB,gEAAgE;AAChE,MAAM,uBAAuB,GAAG,CAAC,CAAC;AA2ClC,SAAS,SAAS,CAAC,OAA+B;IAChD,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,uCAA+B,EAAE,CAAC;QAC/E,MAAM,IAAI,KAAK,CAAC,yCAAyC,uCAA+B,aAAa,CAAC,CAAC;IACzG,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;AACjF,CAAC;AAED,MAAM,SAAS,GAAG,CAAC,OAA+B,EAAE,IAAY,EAAE,EAAE,CAClE,MAAM,CAAC,IAAI,CAAC,IAAA,sBAAU,EAAC,OAAO,CAAC,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,KAAK,OAAO,IAAI,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;AAChH,MAAM,UAAU,GAAG,CAAC,OAA+B,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;AAErH;;;;;;;GAOG;AACH,SAAgB,gBAAgB,CAAC,KAAwB,EAAE,OAAyD;IAClH,SAAS,CAAC,OAAO,CAAC,CAAC;IACnB,MAAM,GAAG,GAAG,OAAO,CAAC,UAAU,IAAI,qCAA6B,CAAC;IAChE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,GAAG,GAAG,qCAA6B,EAAE,CAAC;QAC7E,MAAM,IAAI,UAAU,CAAC,+BAA+B,qCAA6B,UAAU,CAAC,CAAC;IAC/F,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG;QAAE,MAAM,IAAI,UAAU,CAAC,+CAA+C,CAAC,CAAC;IACvG,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAChC,MAAM,MAAM,GAAuB;QACjC,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,GAAG,EAAE,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,EAAE;QAC1B,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,EAAE;QACpC,YAAY,EAAE,KAAK,CAAC,YAAY,KAAK,IAAI;QACzC,GAAG,EAAE,IAAA,aAAK,GAAE;QACZ,GAAG;QACH,GAAG,EAAE,GAAG,GAAG,GAAG;KACf,CAAC;IACF,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACvE,OAAO,GAAG,OAAO,IAAI,IAAI,IAAI,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;AAC1D,CAAC;AAED,SAAS,WAAW,CAAC,IAAY;IAC/B,IAAI,CAAC;QACH,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAgC,CAAC;QACrG,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC,GAAG,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC,GAAG,KAAK,QAAQ;eAC/F,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC;eAClF,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC,YAAY,KAAK,SAAS,CAAC;QACvF,OAAO,KAAK,CAAC,CAAC,CAAE,CAAwB,CAAC,CAAC,CAAC,IAAI,CAAC;IAClD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAAC,MAAe,EAAE,OAA0E;IAC5H,SAAS,CAAC,OAAO,CAAC,CAAC;IACnB,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IACnF,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;IACpH,IAAI,CAAC,IAAA,qBAAS,EAAC,KAAK,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC;IACtG,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;IACvD,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAChC,IAAI,MAAM,CAAC,GAAG,IAAI,GAAG,IAAI,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,GAAG,qCAA6B,IAAI,MAAM,CAAC,GAAG,GAAG,GAAG,GAAG,uBAAuB,EAAE,CAAC;QAC/H,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IAC1C,CAAC;IACD,MAAM,SAAS,GAAG,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC/F,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC;IACpF,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAC9B,CAAC;AAED,6DAA6D;AACtD,MAAM,SAAS,GAAG,CAAC,KAAa,EAAE,OAAe,EAAE,EAAE,CAAC,GAAG,KAAK,IAAI,OAAO,EAAE,CAAC;AAAtE,QAAA,SAAS,aAA6D;AAEnF;;;;;;;;;GASG;AACH,SAAgB,gBAAgB,CAAC,MAA0B,EAAE,KAAa,EAAE,OAAe,EAAE,UAAmB;IAC9G,MAAM,OAAO,GAAG,MAAM,CAAC,YAAY,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACtF,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO;QAAE,OAAO,KAAK,CAAC;IACvC,OAAO,UAAU,CAAC,CAAC,CAAC,IAAA,wBAAa,EAAC,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC/D,CAAC"}

package/dist/cjs/testing/index.js

@@ -19,24 +19,26 @@ exports.RecordingLogger = RecordingLogger;
 function makeAuthUser(overrides = {}) {
     return { id: (0, id_js_1.newId)(), email: 'user@example.com', roles: [], permissions: [], scopes: {}, attrs: {}, ...overrides };
 }
-/** Gateway-signed identity headers for route tests (use with supertest `.set()`). */
-function identityHeaders(user, secret) {
-    return (0, index_js_1.signIdentityHeaders)(user, secret);
+/**
+ * Gateway-signed (v2) identity headers for route tests (use with supertest `.set()`). The method and path
+ * must match the request the test sends.
+ *
+ * @example request(app).get('/v1/items').set(identityHeaders({ user, secret, protocol, method: 'GET', path: '/v1/items' }));
+ */
+function identityHeaders(input) {
+    return (0, index_js_1.signedIdentityHeaders)(input);
 }
-/** Records everything published/sent so tests can assert on events, commands and direct queue sends. */
+/** Records everything published/sent so tests can assert on events, commands, queue sends and delayed sends. */
 class RecordingBus {
-    source;
     events = [];
     commands = [];
     queued = [];
+    delayed = [];
     failWith = null;
-    constructor(source = 'test') {
-        this.source = source;
-    }
-    async publish(type, data, meta) {
+    async publish(routingKey, data, meta) {
         if (this.failWith)
             throw this.failWith;
-        const envelope = (0, envelope_js_1.buildEnvelope)(type, data, this.source, meta);
+        const envelope = (0, envelope_js_1.buildEnvelope)(routingKey, data, meta);
         this.events.push(envelope);
         return envelope;
     }
@@ -48,7 +50,7 @@ class RecordingBus {
     async send(command, data, meta) {
         if (this.failWith)
             throw this.failWith;
-        const envelope = (0, envelope_js_1.buildEnvelope)(command, data, this.source, meta);
+        const envelope = (0, envelope_js_1.buildEnvelope)(command, data, meta);
         this.commands.push(envelope);
         return envelope;
     }
@@ -62,11 +64,18 @@ class RecordingBus {
             throw this.failWith;
         this.queued.push({ queue, payload, options });
     }
-    eventsOfType(type) {
-        return this.events.filter((e) => e.type === type);
+    async scheduleDelayed(queue, payload, delayMs, options = {}) {
+        if (this.failWith)
+            throw this.failWith;
+        this.delayed.push({ queue, payload, delayMs, options });
+    }
+    /** Published events with this routing key. */
+    eventsOfType(routingKey) {
+        return this.events.filter((e) => e.routingKey === routingKey);
     }
+    /** Sent commands with this name. */
     commandsOfType(command) {
-        return this.commands.filter((e) => e.type === command);
+        return this.commands.filter((e) => e.routingKey === command);
     }
 }
 exports.RecordingBus = RecordingBus;

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/testing/index.ts"],"names":[],"mappings":";;;AAsBA,oCAEC;AAGD,0CAEC;AA7BD,2CAAwC;AACxC,mDAA2D;AAC3D,0DAA4E;AAU5E,kGAAkG;AAClG,MAAa,eAAe;IACjB,KAAK,GAAc,EAAE,CAAC;IAC/B,KAAK,CAAC,OAAe,EAAE,OAAgC,EAAE,IAAU,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACxH,IAAI,CAAC,OAAe,EAAE,OAAgC,EAAE,IAAU,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACtH,IAAI,CAAC,OAAe,EAAE,OAAgC,EAAE,IAAU,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACtH,KAAK,CAAC,OAAe,EAAE,OAAgC,EAAE,IAAU,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;CACzH;AAND,0CAMC;AAED,6BAA6B;AAC7B,SAAgB,YAAY,CAAC,YAA+B,EAAE;IAC5D,OAAO,EAAE,EAAE,EAAE,IAAA,aAAK,GAAE,EAAE,KAAK,EAAE,kBAAkB,EAAE,KAAK,EAAE,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,SAAS,EAAE,CAAC;AACrH,CAAC;AAED,qFAAqF;AACrF,SAAgB,eAAe,CAAC,IAAc,EAAE,MAAc;IAC5D,OAAO,IAAA,8BAAmB,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAC3C,CAAC;AAED,wGAAwG;AACxG,MAAa,YAAY;IAMM;IALpB,MAAM,GAAoB,EAAE,CAAC;IAC7B,QAAQ,GAAoB,EAAE,CAAC;IAC/B,MAAM,GAA0E,EAAE,CAAC;IAC5F,QAAQ,GAAiB,IAAI,CAAC;IAE9B,YAA6B,SAAS,MAAM;QAAf,WAAM,GAAN,MAAM,CAAS;IAAG,CAAC;IAEhD,KAAK,CAAC,OAAO,CAAI,IAAY,EAAE,IAAO,EAAE,IAAmB;QACzD,IAAI,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,CAAC,QAAQ,CAAC;QACvC,MAAM,QAAQ,GAAG,IAAA,2BAAa,EAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC9D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAyB,CAAC,CAAC;QAC5C,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,QAAuB;QAC3C,IAAI,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,IAAI,CAAI,OAAe,EAAE,IAAO,EAAE,IAAmB;QACzD,IAAI,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,CAAC,QAAQ,CAAC;QACvC,MAAM,QAAQ,GAAG,IAAA,2BAAa,EAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAyB,CAAC,CAAC;QAC9C,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,QAAuB;QACxC,IAAI,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,KAAa,EAAE,OAAgB,EAAE,UAA4B,EAAE;QAC/E,IAAI,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,YAAY,CAAC,IAAY;QACvB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,cAAc,CAAC,OAAe;QAC5B,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AA5CD,oCA4CC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/testing/index.ts"],"names":[],"mappings":";;;AAuBA,oCAEC;AAQD,0CAEC;AAnCD,2CAAwC;AACxC,mDAAoF;AACpF,0DAA4E;AAW5E,kGAAkG;AAClG,MAAa,eAAe;IACjB,KAAK,GAAc,EAAE,CAAC;IAC/B,KAAK,CAAC,OAAe,EAAE,OAAgC,EAAE,IAAU,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACxH,IAAI,CAAC,OAAe,EAAE,OAAgC,EAAE,IAAU,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACtH,IAAI,CAAC,OAAe,EAAE,OAAgC,EAAE,IAAU,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACtH,KAAK,CAAC,OAAe,EAAE,OAAgC,EAAE,IAAU,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;CACzH;AAND,0CAMC;AAED,6BAA6B;AAC7B,SAAgB,YAAY,CAAC,YAA+B,EAAE;IAC5D,OAAO,EAAE,EAAE,EAAE,IAAA,aAAK,GAAE,EAAE,KAAK,EAAE,kBAAkB,EAAE,KAAK,EAAE,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,SAAS,EAAE,CAAC;AACrH,CAAC;AAED;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,KAAiH;IAC/I,OAAO,IAAA,gCAAqB,EAAC,KAAK,CAAC,CAAC;AACtC,CAAC;AAED,gHAAgH;AAChH,MAAa,YAAY;IACd,MAAM,GAAoB,EAAE,CAAC;IAC7B,QAAQ,GAAoB,EAAE,CAAC;IAC/B,MAAM,GAA0E,EAAE,CAAC;IACnF,OAAO,GAA2F,EAAE,CAAC;IAC9G,QAAQ,GAAiB,IAAI,CAAC;IAE9B,KAAK,CAAC,OAAO,CAAmB,UAAkB,EAAE,IAAO,EAAE,IAAmB;QAC9E,IAAI,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,CAAC,QAAQ,CAAC;QACvC,MAAM,QAAQ,GAAG,IAAA,2BAAa,EAAC,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACvD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAyB,CAAC,CAAC;QAC5C,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,QAAuB;QAC3C,IAAI,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,IAAI,CAAmB,OAAe,EAAE,IAAO,EAAE,IAAmB;QACxE,IAAI,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,CAAC,QAAQ,CAAC;QACvC,MAAM,QAAQ,GAAG,IAAA,2BAAa,EAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAyB,CAAC,CAAC;QAC9C,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,QAAuB;QACxC,IAAI,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,KAAa,EAAE,OAAgB,EAAE,UAA4B,EAAE;QAC/E,IAAI,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,KAAa,EAAE,OAAgB,EAAE,OAAe,EAAE,UAA4B,EAAE;QACpG,IAAI,IAAI,CAAC,QAAQ;YAAE,MAAM,IAAI,CAAC,QAAQ,CAAC;QACvC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,8CAA8C;IAC9C,YAAY,CAAC,UAAkB;QAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,UAAU,CAAC,CAAC;IAChE,CAAC;IAED,oCAAoC;IACpC,cAAc,CAAC,OAAe;QAC5B,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF;AAlDD,oCAkDC"}

package/dist/esm/access/index.js

@@ -12,25 +12,33 @@ function grants(granted, required) {
         return true;
     return granted.endsWith('.*') && required.startsWith(granted.slice(0, -1));
 }
-/** True when the user holds at least one of `required`. */
+/** True when the user holds at least one of `required`. A super admin holds every permission. */
 export function hasPermission(user, ...required) {
     if (!user)
         return false;
+    if (user.isSuperAdmin)
+        return true;
     return required.some((perm) => user.permissions.some((g) => grants(g, perm)));
 }
+/** True when the user holds every one of `required`. A super admin holds every permission. */
 export function hasAllPermissions(user, ...required) {
     if (!user)
         return false;
+    if (user.isSuperAdmin)
+        return true;
     return required.every((perm) => user.permissions.some((g) => grants(g, perm)));
 }
+/** True when the user has at least one of `roles`. Prefer permission checks; roles are coarse. */
 export function hasRole(user, ...roles) {
     return !!user && roles.some((role) => user.roles.includes(role));
 }
+/** Returns the user, or throws UnauthorizedError (401) when there is none. */
 export function requireUser(user) {
     if (!user)
         throw new UnauthorizedError();
     return user;
 }
+/** Returns the user when they hold any of `required` (super admin always does); throws 401/403 otherwise. */
 export function assertPermission(user, ...required) {
     const u = requireUser(user);
     if (!hasPermission(u, ...required))

package/dist/esm/access/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/access/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxE;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAEvC,SAAS,MAAM,CAAC,OAAe,EAAE,QAAgB;IAC/C,IAAI,OAAO,KAAK,mBAAmB,IAAI,OAAO,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACzE,OAAO,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7E,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,aAAa,CAAC,IAAsD,EAAE,GAAG,QAAkB;IACzG,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IACxB,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAChF,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,IAAsD,EAAE,GAAG,QAAkB;IAC7G,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IACxB,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AACjF,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,IAAgD,EAAE,GAAG,KAAe;IAC1F,OAAO,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;AACnE,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,IAAiC;IAC3D,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,iBAAiB,EAAE,CAAC;IACzC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,IAAiC,EAAE,GAAG,QAAkB;IACvF,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC;QAAE,MAAM,IAAI,cAAc,EAAE,CAAC;IAC/D,OAAO,CAAC,CAAC;AACX,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,QAAQ,CAAC,IAAiD,EAAE,KAAa;IACvF,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;AACrC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAC,IAAiC,EAAE,WAAmB,EAAE,gBAAyB;IACtH,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,CAAC,CAAC,EAAE,KAAK,WAAW;QAAE,OAAO,CAAC,CAAC;IACnC,IAAI,gBAAgB,IAAI,aAAa,CAAC,CAAC,EAAE,gBAAgB,CAAC;QAAE,OAAO,CAAC,CAAC;IACrE,MAAM,IAAI,cAAc,EAAE,CAAC;AAC7B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,IAAiC,EAAE,KAAa,EAAE,eAAuB,EAAE,gBAAyB;IAChI,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC;QAAE,OAAO,CAAC,CAAC;IAC3D,IAAI,gBAAgB,IAAI,aAAa,CAAC,CAAC,EAAE,gBAAgB,CAAC;QAAE,OAAO,CAAC,CAAC;IACrE,MAAM,IAAI,cAAc,EAAE,CAAC;AAC7B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAiC,EAAE,KAAa,EAAE,SAAyB;IAC9G,MAAM,GAAG,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IAC/C,IAAI,SAAS,EAAE,CAAC;QACd,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC;YAAE,MAAM,IAAI,cAAc,CAAC,wBAAwB,KAAK,EAAE,CAAC,CAAC;QACxF,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,GAAG,CAAC,CAAC,CAAE,CAAC;IACrC,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,cAAc,CAAC,MAAM,KAAK,4BAA4B,CAAC,CAAC;IACxF,MAAM,IAAI,cAAc,CAAC,YAAY,KAAK,YAAY,EAAE,EAAE,IAAI,EAAE,0BAA0B,EAAE,CAAC,CAAC;AAChG,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAiC,EAAE,KAAa,EAAE,SAAyB;IAC/G,MAAM,GAAG,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IAC/C,OAAO,oBAAoB,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAChE,CAAC;AAID;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,IAAiC,EAAE,KAAa,EAAE,gBAAyB;IACrG,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,gBAAgB,IAAI,aAAa,CAAC,CAAC,EAAE,gBAAgB,CAAC;QAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;IACjF,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;AACjD,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/access/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxE;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAC;AAEvC,SAAS,MAAM,CAAC,OAAe,EAAE,QAAgB;IAC/C,IAAI,OAAO,KAAK,mBAAmB,IAAI,OAAO,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IACzE,OAAO,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7E,CAAC;AAID,iGAAiG;AACjG,MAAM,UAAU,aAAa,CAAC,IAAyC,EAAE,GAAG,QAAkB;IAC5F,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IACxB,IAAI,IAAI,CAAC,YAAY;QAAE,OAAO,IAAI,CAAC;IACnC,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAChF,CAAC;AAED,8FAA8F;AAC9F,MAAM,UAAU,iBAAiB,CAAC,IAAyC,EAAE,GAAG,QAAkB;IAChG,IAAI,CAAC,IAAI;QAAE,OAAO,KAAK,CAAC;IACxB,IAAI,IAAI,CAAC,YAAY;QAAE,OAAO,IAAI,CAAC;IACnC,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AACjF,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,OAAO,CAAC,IAAgD,EAAE,GAAG,KAAe;IAC1F,OAAO,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;AACnE,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,WAAW,CAAC,IAAiC;IAC3D,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,iBAAiB,EAAE,CAAC;IACzC,OAAO,IAAI,CAAC;AACd,CAAC;AAED,6GAA6G;AAC7G,MAAM,UAAU,gBAAgB,CAAC,IAAiC,EAAE,GAAG,QAAkB;IACvF,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC;QAAE,MAAM,IAAI,cAAc,EAAE,CAAC;IAC/D,OAAO,CAAC,CAAC;AACX,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,QAAQ,CAAC,IAAiD,EAAE,KAAa;IACvF,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;AACrC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAC,IAAiC,EAAE,WAAmB,EAAE,gBAAyB;IACtH,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,CAAC,CAAC,EAAE,KAAK,WAAW;QAAE,OAAO,CAAC,CAAC;IACnC,IAAI,gBAAgB,IAAI,aAAa,CAAC,CAAC,EAAE,gBAAgB,CAAC;QAAE,OAAO,CAAC,CAAC;IACrE,MAAM,IAAI,cAAc,EAAE,CAAC;AAC7B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,IAAiC,EAAE,KAAa,EAAE,eAAuB,EAAE,gBAAyB;IAChI,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC;QAAE,OAAO,CAAC,CAAC;IAC3D,IAAI,gBAAgB,IAAI,aAAa,CAAC,CAAC,EAAE,gBAAgB,CAAC;QAAE,OAAO,CAAC,CAAC;IACrE,MAAM,IAAI,cAAc,EAAE,CAAC;AAC7B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAiC,EAAE,KAAa,EAAE,SAAyB;IAC9G,MAAM,GAAG,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IAC/C,IAAI,SAAS,EAAE,CAAC;QACd,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC;YAAE,MAAM,IAAI,cAAc,CAAC,wBAAwB,KAAK,EAAE,CAAC,CAAC;QACxF,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,GAAG,CAAC,CAAC,CAAE,CAAC;IACrC,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,cAAc,CAAC,MAAM,KAAK,4BAA4B,CAAC,CAAC;IACxF,MAAM,IAAI,cAAc,CAAC,YAAY,KAAK,YAAY,EAAE,EAAE,IAAI,EAAE,0BAA0B,EAAE,CAAC,CAAC;AAChG,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAiC,EAAE,KAAa,EAAE,SAAyB;IAC/G,MAAM,GAAG,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IAC/C,OAAO,oBAAoB,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAChE,CAAC;AAID;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,IAAiC,EAAE,KAAa,EAAE,gBAAyB;IACrG,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC5B,IAAI,gBAAgB,IAAI,aAAa,CAAC,CAAC,EAAE,gBAAgB,CAAC;QAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;IACjF,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;AACjD,CAAC"}

package/dist/esm/approvals/index.js

@@ -0,0 +1,127 @@
+import { hasAllPermissions } from '../access/index.js';
+import { ConflictError, ForbiddenError } from '../common/errors.js';
+/**
+ * Two-person approval state machine. A requester asks for a sensitive operation; a different person who
+ * holds both the operation's permission and the app's "decide" permission approves or rejects it; the
+ * approved operation is then executed once (or fails). Pending requests expire after a TTL.
+ *
+ * ```
+ * pending ──► approved ──► executed
+ *    │            └──────► failed
+ *    ├──► rejected
+ *    ├──► cancelled
+ *    └──► expired
+ * ```
+ *
+ * App values (the decide permission and the TTL) are passed in through {@link createApprovalPolicy}.
+ */
+/** Every approval state. */
+export const APPROVAL_STATES = ['pending', 'approved', 'rejected', 'cancelled', 'expired', 'executed', 'failed'];
+const TRANSITIONS = Object.freeze({
+    pending: ['approved', 'rejected', 'cancelled', 'expired'],
+    approved: ['executed', 'failed'],
+    rejected: [],
+    cancelled: [],
+    expired: [],
+    executed: [],
+    failed: [],
+});
+/**
+ * True when `from → to` is an allowed move.
+ *
+ * @example canTransition('pending', 'approved') // true
+ */
+export function canTransition(from, to) {
+    return TRANSITIONS[from]?.includes(to) ?? false;
+}
+/**
+ * Throws unless `from → to` is allowed.
+ *
+ * @throws ConflictError (`APPROVAL_INVALID_TRANSITION`).
+ */
+export function assertTransition(from, to) {
+    if (!canTransition(from, to)) {
+        throw new ConflictError(`This request can no longer move from ${from} to ${to}`, { code: 'APPROVAL_INVALID_TRANSITION' });
+    }
+}
+/** True when the state allows no further moves. */
+export function isTerminalApprovalState(state) {
+    return TRANSITIONS[state].length === 0;
+}
+function assertPending(approval, now) {
+    if (approval.state !== 'pending') {
+        throw new ConflictError('This request has already been decided', { code: 'APPROVAL_NOT_PENDING' });
+    }
+    if (approval.expiresAt && new Date(approval.expiresAt).getTime() <= now.getTime()) {
+        throw new ConflictError('This request has expired', { code: 'APPROVAL_EXPIRED' });
+    }
+}
+/**
+ * Throws unless `approver` may approve or reject `approval`: it is pending and not expired, the approver
+ * is not the requester (even a super admin cannot approve their own request), and holds both the
+ * operation permission and `decidePermission`.
+ *
+ * @param approval The request.
+ * @param approver The deciding user.
+ * @param decidePermission The app's "may decide approvals" permission.
+ * @param now Clock (tests).
+ * @throws ConflictError (`APPROVAL_NOT_PENDING`, `APPROVAL_EXPIRED`) or ForbiddenError
+ *   (`APPROVAL_SELF_DECISION`, `APPROVAL_FORBIDDEN`).
+ */
+export function assertCanDecide(approval, approver, decidePermission, now = new Date()) {
+    assertPending(approval, now);
+    if (approver.id === approval.requesterUserId) {
+        throw new ForbiddenError('You cannot decide your own request', { code: 'APPROVAL_SELF_DECISION' });
+    }
+    if (!hasAllPermissions(approver, approval.operationPermission, decidePermission)) {
+        throw new ForbiddenError('You do not have permission to decide this request', { code: 'APPROVAL_FORBIDDEN' });
+    }
+}
+/**
+ * Throws unless `user` may cancel `approval`: only the requester, and only while it is pending.
+ *
+ * @throws ConflictError (`APPROVAL_NOT_PENDING`) or ForbiddenError (`APPROVAL_NOT_REQUESTER`).
+ */
+export function assertCanCancel(approval, user) {
+    if (user.id !== approval.requesterUserId) {
+        throw new ForbiddenError('Only the person who made this request can cancel it', { code: 'APPROVAL_NOT_REQUESTER' });
+    }
+    if (approval.state !== 'pending') {
+        throw new ConflictError('This request has already been decided', { code: 'APPROVAL_NOT_PENDING' });
+    }
+}
+/**
+ * When a request made at `from` expires.
+ *
+ * @param ttlSeconds Positive lifetime in seconds.
+ * @param from Creation time (default now).
+ * @returns The expiry instant.
+ * @example approvalExpiresAt(3600, new Date('2026-01-01T00:00:00Z')) // 2026-01-01T01:00:00Z
+ */
+export function approvalExpiresAt(ttlSeconds, from = new Date()) {
+    if (!Number.isFinite(ttlSeconds) || ttlSeconds <= 0)
+        throw new RangeError('Approval TTL must be a positive number of seconds');
+    return new Date(from.getTime() + ttlSeconds * 1000);
+}
+/**
+ * Binds the approval rules to an app's decide permission and TTL.
+ *
+ * @param options Decide permission and TTL.
+ * @returns The bound policy.
+ * @example const approvals = createApprovalPolicy({ decidePermission: 'requests.decide', ttlSeconds: 86_400 });
+ */
+export function createApprovalPolicy(options) {
+    if (!options.decidePermission)
+        throw new RangeError('An approval policy needs a decide permission');
+    approvalExpiresAt(options.ttlSeconds); // validates the TTL up front
+    return Object.freeze({
+        decidePermission: options.decidePermission,
+        ttlSeconds: options.ttlSeconds,
+        canTransition,
+        assertTransition,
+        assertCanDecide: (approval, approver, now) => assertCanDecide(approval, approver, options.decidePermission, now),
+        assertCanCancel,
+        expiresAt: (from) => approvalExpiresAt(options.ttlSeconds, from),
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/esm/approvals/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/approvals/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGpE;;;;;;;;;;;;;;GAcG;AAEH,4BAA4B;AAC5B,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAU,CAAC;AAK1H,MAAM,WAAW,GAA8D,MAAM,CAAC,MAAM,CAAC;IAC3F,OAAO,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,CAAC;IACzD,QAAQ,EAAE,CAAC,UAAU,EAAE,QAAQ,CAAC;IAChC,QAAQ,EAAE,EAAE;IACZ,SAAS,EAAE,EAAE;IACb,OAAO,EAAE,EAAE;IACX,QAAQ,EAAE,EAAE;IACZ,MAAM,EAAE,EAAE;CACX,CAAC,CAAC;AAeH;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,IAAmB,EAAE,EAAiB;IAClE,OAAO,WAAW,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC;AAClD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAmB,EAAE,EAAiB;IACrE,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,aAAa,CAAC,wCAAwC,IAAI,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,6BAA6B,EAAE,CAAC,CAAC;IAC5H,CAAC;AACH,CAAC;AAED,mDAAmD;AACnD,MAAM,UAAU,uBAAuB,CAAC,KAAoB;IAC1D,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;AACzC,CAAC;AAED,SAAS,aAAa,CAAC,QAAyB,EAAE,GAAS;IACzD,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,IAAI,aAAa,CAAC,uCAAuC,EAAE,EAAE,IAAI,EAAE,sBAAsB,EAAE,CAAC,CAAC;IACrG,CAAC;IACD,IAAI,QAAQ,CAAC,SAAS,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,IAAI,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;QAClF,MAAM,IAAI,aAAa,CAAC,0BAA0B,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC;IACpF,CAAC;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAAC,QAAyB,EAAE,QAAuB,EAAE,gBAAwB,EAAE,MAAY,IAAI,IAAI,EAAE;IAClI,aAAa,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IAC7B,IAAI,QAAQ,CAAC,EAAE,KAAK,QAAQ,CAAC,eAAe,EAAE,CAAC;QAC7C,MAAM,IAAI,cAAc,CAAC,oCAAoC,EAAE,EAAE,IAAI,EAAE,wBAAwB,EAAE,CAAC,CAAC;IACrG,CAAC;IACD,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,CAAC,mBAAmB,EAAE,gBAAgB,CAAC,EAAE,CAAC;QACjF,MAAM,IAAI,cAAc,CAAC,mDAAmD,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC,CAAC;IAChH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,QAAyB,EAAE,IAA0B;IACnF,IAAI,IAAI,CAAC,EAAE,KAAK,QAAQ,CAAC,eAAe,EAAE,CAAC;QACzC,MAAM,IAAI,cAAc,CAAC,qDAAqD,EAAE,EAAE,IAAI,EAAE,wBAAwB,EAAE,CAAC,CAAC;IACtH,CAAC;IACD,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,IAAI,aAAa,CAAC,uCAAuC,EAAE,EAAE,IAAI,EAAE,sBAAsB,EAAE,CAAC,CAAC;IACrG,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAAC,UAAkB,EAAE,OAAa,IAAI,IAAI,EAAE;IAC3E,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,UAAU,IAAI,CAAC;QAAE,MAAM,IAAI,UAAU,CAAC,mDAAmD,CAAC,CAAC;IAC/H,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,UAAU,GAAG,IAAI,CAAC,CAAC;AACtD,CAAC;AAqBD;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAA8B;IACjE,IAAI,CAAC,OAAO,CAAC,gBAAgB;QAAE,MAAM,IAAI,UAAU,CAAC,8CAA8C,CAAC,CAAC;IACpG,iBAAiB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,6BAA6B;IACpE,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,gBAAgB,EAAE,OAAO,CAAC,gBAAgB;QAC1C,UAAU,EAAE,OAAO,CAAC,UAAU;QAC9B,aAAa;QACb,gBAAgB;QAChB,eAAe,EAAE,CAAC,QAAyB,EAAE,QAAuB,EAAE,GAAU,EAAE,EAAE,CAAC,eAAe,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC;QACvJ,eAAe;QACf,SAAS,EAAE,CAAC,IAAW,EAAE,EAAE,CAAC,iBAAiB,CAAC,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC;KACxE,CAAC,CAAC;AACL,CAAC"}

package/dist/esm/audit/index.js

@@ -0,0 +1,70 @@
+import { maskPhone } from '../common/phone.js';
+import { toUtcIso } from '../common/time.js';
+import { createKeyClassifier, redactValue } from '../logging/redact.js';
+/** User-agent strings are cut to this length. */
+export const MAX_USER_AGENT_LENGTH = 255;
+/** Stable JSON form for deep comparison (object keys sorted; Dates as ISO strings). */
+function canonical(value) {
+    return JSON.stringify(value ?? null, (_key, v) => {
+        if (v && typeof v === 'object' && !Array.isArray(v) && !(v instanceof Date)) {
+            return Object.fromEntries(Object.entries(v).sort(([a], [b]) => a.localeCompare(b)));
+        }
+        return v;
+    });
+}
+function diff(before, after, classifier) {
+    const changes = {};
+    const redactedFields = [];
+    const keys = [...new Set([...Object.keys(before), ...Object.keys(after)])].sort();
+    for (const key of keys) {
+        const was = before[key] ?? null;
+        const now = after[key] ?? null;
+        if (canonical(was) === canonical(now))
+            continue;
+        if (classifier.isSecret(key)) {
+            redactedFields.push(key);
+            continue;
+        }
+        const clean = (value) => classifier.isPhone(key) && (typeof value === 'string' || typeof value === 'number') ? maskPhone(String(value)) : redactValue(value, classifier);
+        changes[key] = { before: clean(was), after: clean(now) };
+    }
+    return { changes, redactedFields };
+}
+/**
+ * Creates an audit-event builder with the app's extra redaction words.
+ *
+ * @param options Extra redaction words.
+ * @returns `buildAuditEvent` bound to that list.
+ * @example const buildAudit = createAuditEventBuilder({ redactKeys: ['nationalId'] });
+ */
+export function createAuditEventBuilder(options = {}) {
+    const classifier = createKeyClassifier(options.redactKeys ?? []);
+    return (input) => {
+        if (!input.action || !input.entityType)
+            throw new RangeError('Audit events need an action and an entity type');
+        const { changes, redactedFields } = diff(input.before ?? {}, input.after ?? {}, classifier);
+        return {
+            action: input.action,
+            entityType: input.entityType,
+            entityId: input.entityId,
+            scope: input.scope ? { key: input.scope.key, id: input.scope.id } : null,
+            actorUserId: input.actor?.id ?? null,
+            outcome: input.outcome ?? 'success',
+            occurredAt: toUtcIso(input.occurredAt ?? new Date()),
+            changes,
+            redactedFields,
+            ip: input.ip ?? null,
+            userAgent: input.userAgent ? input.userAgent.slice(0, MAX_USER_AGENT_LENGTH) : null,
+        };
+    };
+}
+/**
+ * Builds an audit event with the default redaction list: the diff holds only changed fields; secret
+ * fields are dropped (named in `redactedFields`); phone fields are masked to their last 4 digits.
+ *
+ * @param input Action, entity, scope, actor, before/after state and request facts.
+ * @returns The event.
+ * @example buildAuditEvent({ action: 'widget.updated', entityType: 'widget', entityId, scope: { key: 'tenant', id: tenantId }, actor: req.user ?? null, before, after, ip: req.ip, userAgent: req.get('user-agent') })
+ */
+export const buildAuditEvent = createAuditEventBuilder();
+//# sourceMappingURL=index.js.map

package/dist/esm/audit/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/audit/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAsB,MAAM,sBAAsB,CAAC;AAwE5F,iDAAiD;AACjD,MAAM,CAAC,MAAM,qBAAqB,GAAG,GAAG,CAAC;AAEzC,uFAAuF;AACvF,SAAS,SAAS,CAAC,KAAc;IAC/B,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC,IAAI,EAAE,CAAU,EAAE,EAAE;QACxD,IAAI,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC,EAAE,CAAC;YAC5E,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAA4B,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjH,CAAC;QACD,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,IAAI,CAAC,MAA+B,EAAE,KAA8B,EAAE,UAAyB;IACtG,MAAM,OAAO,GAAgC,EAAE,CAAC;IAChD,MAAM,cAAc,GAAa,EAAE,CAAC;IACpC,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAClF,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;QAChC,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;QAC/B,IAAI,SAAS,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,GAAG,CAAC;YAAE,SAAS;QAChD,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACzB,SAAS;QACX,CAAC;QACD,MAAM,KAAK,GAAG,CAAC,KAAc,EAAE,EAAE,CAC/B,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAClJ,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;IAC3D,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;AACrC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CAAC,UAAoC,EAAE;IAC5E,MAAM,UAAU,GAAG,mBAAmB,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;IACjE,OAAO,CAAC,KAAK,EAAE,EAAE;QACf,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU;YAAE,MAAM,IAAI,UAAU,CAAC,gDAAgD,CAAC,CAAC;QAC/G,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,EAAE,EAAE,KAAK,CAAC,KAAK,IAAI,EAAE,EAAE,UAAU,CAAC,CAAC;QAC5F,OAAO;YACL,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI;YACxE,WAAW,EAAE,KAAK,CAAC,KAAK,EAAE,EAAE,IAAI,IAAI;YACpC,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,SAAS;YACnC,UAAU,EAAE,QAAQ,CAAC,KAAK,CAAC,UAAU,IAAI,IAAI,IAAI,EAAE,CAAC;YACpD,OAAO;YACP,cAAc;YACd,EAAE,EAAE,KAAK,CAAC,EAAE,IAAI,IAAI;YACpB,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC,IAAI;SACpF,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,eAAe,GAA2C,uBAAuB,EAAE,CAAC"}

package/dist/esm/cache/index.js

@@ -1,5 +1,26 @@
 import { Redis } from 'ioredis';
+import { ConfigError } from '../config/index.js';
 import { silentLogger } from '../logging/index.js';
+export * from './keyspace.js';
+/** Purpose segment for tag index sets: `{prefix}cache-tag:{tag}`. */
+export const CACHE_TAG_PURPOSE = 'cache-tag';
+/** Lower bound for a tag set's own TTL, so it outlives the keys it lists. */
+const MIN_TAG_TTL_SEC = 86_400;
+/**
+ * Throws unless `ttlSec` is a positive whole number of seconds.
+ *
+ * @param ttlSec Proposed TTL.
+ * @throws ConfigError for ttl ≤ 0, fractions, NaN or Infinity.
+ * @example assertTtl(60)
+ */
+export function assertTtl(ttlSec) {
+    if (!Number.isInteger(ttlSec) || ttlSec <= 0)
+        throw new ConfigError(`Redis TTL must be a positive whole number of seconds (got ${String(ttlSec)})`);
+}
+function assertOwned(keyspace, key) {
+    if (!keyspace.owns(key))
+        throw new ConfigError(`Cache key is outside the keyspace ${keyspace.prefix}`);
+}
 const NULL_SENTINEL = '__null__';
 class MemoryStore {
     max;
@@ -33,14 +54,23 @@ class MemoryStore {
  * Redis-backed cache with tag invalidation. If Redis errors, reads fall through to the loader
  * and writes go to a bounded in-memory store, so a cache outage degrades latency rather than
  * availability.
+ *
+ * @param options Redis client (or null for memory only), the service keyspace, memory bound, logger.
+ * @returns The {@link Cache}.
+ * @example
+ * const cache = createCache({ redis, keyspace: ks, logger });
+ * const widget = await cache.wrap(ks.key('widget', id), () => repo.find(id), { ttlSec: 300 });
  */
 export function createCache(options) {
     const logger = options.logger ?? silentLogger;
-    const defaultTtl = options.defaultTtlSec ?? 60;
+    const { keyspace } = options;
     const memory = new MemoryStore(options.memoryMaxEntries ?? 5000);
     const inflight = new Map();
-    const k = (key) => `${options.namespace}:${key}`;
-    const tagKey = (tag) => `${options.namespace}:tag:${tag}`;
+    const k = (key) => {
+        assertOwned(keyspace, key);
+        return key;
+    };
+    const tagKey = (tag) => keyspace.key(CACHE_TAG_PURPOSE, tag);
     let warned = false;
     const redisFailed = (error) => {
         if (!warned)
@@ -60,13 +90,14 @@ export function createCache(options) {
         }
         return memory.get(k(key));
     };
-    const writeRaw = async (key, raw, opts = {}) => {
-        const ttl = opts.ttlSec ?? defaultTtl;
+    const writeRaw = async (key, raw, opts) => {
+        assertTtl(opts.ttlSec);
+        const ttl = opts.ttlSec;
         if (options.redis) {
             try {
                 const pipeline = options.redis.multi().set(k(key), raw, 'EX', ttl);
                 for (const tag of opts.tags ?? [])
-                    pipeline.sadd(tagKey(tag), k(key)).expire(tagKey(tag), Math.max(ttl, 86_400));
+                    pipeline.sadd(tagKey(tag), k(key)).expire(tagKey(tag), Math.max(ttl, MIN_TAG_TTL_SEC));
                 await pipeline.exec();
                 return;
             }
@@ -92,7 +123,8 @@ export function createCache(options) {
             if (options.redis && keys.length)
                 await options.redis.del(...keys.map(k)).catch(redisFailed);
         },
-        async wrap(key, loader, opts = {}) {
+        async wrap(key, loader, opts) {
+            assertTtl(opts.ttlSec);
             const raw = await readRaw(key);
             if (raw !== undefined) {
                 if (raw === NULL_SENTINEL)
@@ -108,7 +140,7 @@ export function createCache(options) {
                     if (value !== null && value !== undefined)
                         await writeRaw(key, JSON.stringify(value), opts);
                     else if (opts.cacheNull)
-                        await writeRaw(key, NULL_SENTINEL, { ...opts, ttlSec: Math.min(opts.ttlSec ?? defaultTtl, 30) });
+                        await writeRaw(key, NULL_SENTINEL, { ...opts, ttlSec: Math.min(opts.ttlSec, 30) });
                     return value;
                 }
                 finally {
@@ -138,19 +170,30 @@ export function createCache(options) {
     };
     return cache;
 }
-/** ioredis client that never crashes the process on connection errors and retries forever. */
-export function createRedisClient(opts) {
+/**
+ * ioredis client that never crashes the process on connection errors and retries forever.
+ * It sets no `keyPrefix`: keys carry their full `{app}:{env}:{service}:` prefix from the keyspace.
+ *
+ * @param env Connection env (`REDIS_URL`, or host/port/password, and `REDIS_DB`).
+ * @param opts Logger and extra ioredis options.
+ * @returns The client.
+ * @example const redis = createRedisClient(config, { logger });
+ */
+export function createRedisClient(env, opts = {}) {
     const logger = opts.logger ?? silentLogger;
     const base = {
-        db: opts.db ?? 0,
-        keyPrefix: opts.keyPrefix || undefined,
+        host: env.REDIS_HOST,
+        port: env.REDIS_PORT,
+        password: env.REDIS_PASSWORD || undefined,
+        db: env.REDIS_DB ?? 0,
         lazyConnect: false,
         enableOfflineQueue: false,
         maxRetriesPerRequest: 1,
         retryStrategy: (times) => Math.min(times * 500, 10_000),
         ...opts.options,
+        keyPrefix: undefined,
     };
-    const client = opts.url ? new Redis(opts.url, base) : new Redis(base);
+    const client = env.REDIS_URL ? new Redis(env.REDIS_URL, base) : new Redis(base);
     let lastError = '';
     client.on('error', (error) => {
         if (error.message !== lastError)
@@ -160,4 +203,18 @@ export function createRedisClient(opts) {
     client.on('ready', () => { lastError = ''; logger.info('Redis connected', { db: base.db }); });
     return client;
 }
+/**
+ * `SET key value EX ttlSec` for a keyspace key; refuses a TTL ≤ 0 so no key lives forever.
+ *
+ * @param redis Client (or anything with a compatible `set`).
+ * @param key Key from the service keyspace.
+ * @param value String value.
+ * @param ttlSec TTL in whole seconds (> 0).
+ * @throws ConfigError for an invalid TTL.
+ * @example await setWithTtl(redis, ks.key('session', id), payload, 900);
+ */
+export async function setWithTtl(redis, key, value, ttlSec) {
+    assertTtl(ttlSec);
+    await redis.set(key, value, 'EX', ttlSec);
+}
 //# sourceMappingURL=index.js.map