@fitzzero/quickdraw-core 5.0.1 → 5.1.1

package/dist/{chunk-NS5PUHIZ.js → chunk-RZTP4IEW.js}

@@ -30,7 +30,7 @@ import {
   toQuickdrawError,
   toWireIssues,
   withSignal
-} from "./chunk-2XJFNVHW.js";
+} from "./chunk-2PWMUVC7.js";
 import {
   createRecorder,
   describeError,
@@ -77,7 +77,7 @@ import {
   streamRoom,
   topicRoom,
   userRoom
-} from "./chunk-WVIRXYI4.js";
+} from "./chunk-VSQBHPWH.js";
 import {
   hasJsonSchema
 } from "./chunk-47AEXVDM.js";
@@ -1547,8 +1547,11 @@ function receive(deps, state, frame) {
     return;
   }
   const { principal } = state.socket.data;
-  const parsed = principal === null ? void 0 : parse(deps, channel, payload);
-  if (principal === null || parsed === void 0) {
+  if (principal === null || channel.kinds?.has(principal.kind ?? "") === false) {
+    return;
+  }
+  const parsed = parse(deps, channel, payload);
+  if (parsed === void 0) {
     return;
   }
   const room = allowed(channel, state.socket, principal, parsed.value);
@@ -2107,6 +2110,44 @@ var StreamIndex = class {
   }
 };
 
+// src/server/access/kinds.ts
+function isKindList(value) {
+  return Array.isArray(value) && value.length > 0 && value.every((kind) => typeof kind === "string" && kind.length > 0);
+}
+function narrowKinds(value, above, fail5) {
+  if (value === void 0) {
+    return above?.kinds;
+  }
+  if (!isKindList(value)) {
+    fail5(
+      'kinds must be a non-empty list of principal kinds (strings), such as ["user"]; leave it out to admit every kind'
+    );
+  }
+  if (above?.kinds !== void 0) {
+    const { kinds, by } = above;
+    const wider = value.find((kind) => !kinds.includes(kind));
+    if (wider !== void 0) {
+      fail5(
+        `kinds may only narrow the kinds ${by} admits (${kinds.join(", ")}), and "${wider}" is not one of them`
+      );
+    }
+  }
+  return Object.freeze([...new Set(value)]);
+}
+function checkKind(kinds, principal, what) {
+  if (kinds === void 0 || principal === null) {
+    return;
+  }
+  const { kind } = principal;
+  if (typeof kind === "string" && kinds.includes(kind)) {
+    return;
+  }
+  throw new QuickdrawError(
+    "FORBIDDEN",
+    kind === void 0 ? `${what} is not open to a principal without a kind` : `${what} is not open to principals of kind "${String(kind)}"`
+  );
+}
+
 // src/server/realtime/streamTargets.ts
 function isName(value) {
   return typeof value === "string" && value.length > 0;
@@ -2153,6 +2194,7 @@ function inStreamRoom(socket, access, scope) {
   return room !== void 0 && joined !== void 0 && Object.hasOwn(joined, room);
 }
 async function authorizeStream(hub, socket, target2) {
+  checkKind(target2.service.kinds, socket.data.principal, target2.service.name);
   const { room } = target2.stream;
   if (room !== void 0) {
     if (!inStreamRoom(socket, room, target2.scope)) {
@@ -4369,6 +4411,8 @@ function mayWatchService(service, principal) {
   return meetsLevel(serviceGrant(principal, service.name), form.service);
 }
 async function authorizeWatch(hub, principal, target2) {
+  const service = target2.kind === "service" ? target2.service : target2.collection.service;
+  checkKind(service.kinds, principal, service.name);
   if (target2.kind === "service" && target2.service.watchAccess === void 0) {
     throw new QuickdrawError(
       "FORBIDDEN",
@@ -4646,6 +4690,7 @@ function collectionSubscriptions(hub) {
     answerEvent(socket, context, CLIENT_EVENTS.collectionSub, async (frame) => {
       const request = readSubscribe(frame);
       const { collection } = servedCollection(hub, socket, request);
+      checkKind(collection.service.kinds, socket.data.principal, collection.service.name);
       return await subscribeScope(hub, socket, collection, request);
     });
     answerEvent(socket, context, CLIENT_EVENTS.collectionItems, async (frame) => {
@@ -5297,13 +5342,18 @@ function createRealtime(hub) {
         rooms.disconnected(socket);
       });
     },
+    legacyExtension(socket, context) {
+      onDisconnect(socket, context, () => {
+        rooms.disconnected(socket);
+      });
+    },
     presence,
     rooms: rooms.server,
     onRoomLeave: (hooks, run2) => {
       rooms.onLeave(hooks, run2);
     },
     roomsFor(transport, connectionId, share) {
-      const socket = transport === "socket" && connectionId !== void 0 ? hub.io?.sockets.sockets.get(connectionId) : void 0;
+      const socket = (transport === "socket" || transport === "legacy") && connectionId !== void 0 ? hub.io?.sockets.sockets.get(connectionId) : void 0;
       const own = socket === void 0 ? rooms.detached : rooms.of(socket);
       return share === void 0 ? own : unjoinable(own, share);
     },
@@ -5909,6 +5959,7 @@ async function onSubscribe(hub, socket, frame) {
   if (socket.data.principal === null) {
     throw new QuickdrawError("UNAUTHENTICATED", "Authentication required");
   }
+  checkKind(target2.service.kinds, socket.data.principal, target2.service.name);
   if (hub.storage === void 0) {
     throw new QuickdrawError(
       "INTERNAL",
@@ -6155,6 +6206,7 @@ function createLive(options) {
       topics.extension(...args);
       realtime.extension(...args);
     },
+    legacyExtension: realtime.legacyExtension,
     realtime,
     revisions: hub.revisions,
     attach(io, probe, cluster, broadcasts) {
@@ -7343,7 +7395,7 @@ function contextFor(settings, request, requestId, target2, signal, dispatch) {
     log,
     requestId,
     transport: request.transport,
-    ...request.transport === "socket" && request.connectionId !== void 0 ? { socketId: request.connectionId } : {},
+    ...(request.transport === "socket" || request.transport === "legacy") && request.connectionId !== void 0 ? { socketId: request.connectionId } : {},
     ...request.mcp === void 0 ? {} : { mcp: request.mcp },
     touch: settings.touch,
     rooms: realtime.roomsFor(request.transport, request.connectionId, target2.method.share),
@@ -7391,6 +7443,7 @@ async function proceed(pipeline, call, target2) {
   const { request } = call;
   const label = `${target2.service.name}.${target2.method.name}`;
   const input = await stage(call, parseInput(target2.method.input, request.input, label));
+  checkKind(target2.method.kinds, request.principal, label);
   const ctx = contextFor(settings, request, call.requestId, target2, call.signal, pipeline.dispatch);
   const access = {
     service: target2.service,
@@ -8278,17 +8331,58 @@ function toLegacyReply(result) {
   return { success: true, data: result.notModified === true ? void 0 : result.data };
 }
 var LEGACY_INTERNAL = Object.freeze(legacyFailure("INTERNAL", "Internal error"));
-function targetOf5(event, registry) {
+function resolveLegacyWire(option, registered) {
+  if (option === void 0 || option === false) {
+    return void 0;
+  }
+  if (option === true) {
+    return { aliases: /* @__PURE__ */ new Map() };
+  }
+  if (typeof option !== "object" || option === null || Array.isArray(option)) {
+    throw new TypeError("createServer: legacyWire must be a boolean or { aliases }");
+  }
+  for (const key of Object.keys(option)) {
+    if (key !== "aliases") {
+      throw new TypeError(`createServer: legacyWire has an unknown option "${key}"`);
+    }
+  }
+  const { aliases = {} } = option;
+  if (typeof aliases !== "object" || aliases === null || Array.isArray(aliases)) {
+    throw new TypeError("createServer: legacyWire.aliases must map old service names to new ones");
+  }
+  const services = new Set(registered.map((service) => service.name));
+  const resolved = /* @__PURE__ */ new Map();
+  for (const [alias, target2] of Object.entries(aliases)) {
+    const entry = `legacyWire.aliases[${JSON.stringify(alias)}]`;
+    if (alias === "" || alias.includes(":")) {
+      throw new TypeError(`createServer: ${entry} must be a service name without ":"`);
+    }
+    if (services.has(alias)) {
+      throw new TypeError(
+        `createServer: ${entry} is a registered service's own name, so it cannot be an alias`
+      );
+    }
+    if (typeof target2 !== "string" || !services.has(target2)) {
+      throw new TypeError(
+        `createServer: ${entry} names ${JSON.stringify(target2)}, which is not a registered service`
+      );
+    }
+    resolved.set(alias, target2);
+  }
+  return { aliases: resolved };
+}
+function targetOf5(event, registry, aliases) {
   if (typeof event !== "string") {
     return void 0;
   }
   const colon = event.indexOf(":");
-  const service = event.slice(0, colon);
+  const called = event.slice(0, colon);
   const method = event.slice(colon + 1);
-  if (colon <= 0 || registry.find(service, method) === void 0) {
+  const service = aliases.get(called);
+  if (colon <= 0 || registry.find(service ?? called, method) === void 0) {
     return void 0;
   }
-  return { service, method };
+  return service === void 0 ? { service: called, method } : { service, method, alias: called };
 }
 function principalKind(principal) {
   if (principal === null) {
@@ -8298,15 +8392,18 @@ function principalKind(principal) {
 }
 function noteCaller(context, seen, target2, principal) {
   const kind = principalKind(principal);
-  const key = `${target2.service}\0${target2.method}\0${kind}`;
+  const { service, method, alias } = target2;
+  const key = `${alias ?? service}\0${method}\0${kind}`;
   if (seen.has(key)) {
     return;
   }
   seen.add(key);
-  context.logger.warn(
-    `A 4.x client called ${target2.service}.${target2.method} through the legacy shim`,
-    { category: "quickdraw.legacy", ...target2, principalKind: kind }
-  );
+  const as = alias === void 0 ? "" : ` as ${alias}.${method}`;
+  context.logger.warn(`A 4.x client called ${service}.${method}${as} through the legacy shim`, {
+    category: "quickdraw.legacy",
+    ...target2,
+    principalKind: kind
+  });
 }
 function serve2(socket, context, calls, call) {
   const controller = new AbortController();
@@ -8332,19 +8429,20 @@ function serve2(socket, context, calls, call) {
     respond: (result) => acknowledge(context.meter, call.ack, toLegacyReply(result), LEGACY_INTERNAL, report)
   }).then(release3, release3);
 }
-function attachLegacyShim(socket, context, seen) {
+function attachLegacyShim(socket, context, seen, wire) {
   const calls = /* @__PURE__ */ new Set();
   socket.use((packet, next) => {
     const [event, ...args] = packet;
     const ack = args.at(-1);
-    const target2 = targetOf5(event, context.dispatcher.registry);
+    const target2 = targetOf5(event, context.dispatcher.registry, wire.aliases);
     if (target2 === void 0 || typeof ack !== "function") {
       next();
       return;
     }
     noteCaller(context, seen, target2, socket.data.principal);
     const input = args.length > 1 ? args[0] : void 0;
-    serve2(socket, context, calls, { ...target2, input, ack });
+    const { service, method } = target2;
+    serve2(socket, context, calls, { service, method, input, ack });
   });
   socket.on("disconnect", () => {
     for (const controller of calls) {
@@ -8806,7 +8904,10 @@ function onConnection(settings) {
       void socket.join(userRoom(principal.userId));
     }
     if (socket.data.protocol === "legacy") {
-      attachLegacyShim(socket, settings, settings.legacyCallers);
+      attachLegacyShim(socket, settings, settings.legacyCallers, settings.legacyWire);
+      for (const extension of settings.legacyExtensions) {
+        extension(socket, settings);
+      }
       return;
     }
     attachCallListeners(socket, settings);
@@ -8862,7 +8963,7 @@ function createSocketServer(httpServer, settings) {
   settings.live?.attach(io, probe, settings.cluster, broadcasts);
   listenForGrants(io, settings.live, settings.logger);
   listenForDisconnects(io);
-  io.use(protocolMiddleware(settings.legacyWire, context));
+  io.use(protocolMiddleware(settings.legacyWire !== void 0, context));
   io.use(authMiddleware(settings.resolvePrincipal, context));
   if (settings.rateLimit !== false) {
     applySocketRateLimit(io, settings.rateLimit, { ...context, loops: settings.loops });
@@ -8873,7 +8974,10 @@ function createSocketServer(httpServer, settings) {
       ...context,
       hello: helloFrame(settings),
       extensions: settings.live === void 0 ? settings.extensions : [...settings.extensions, settings.live.extension],
-      legacyCallers: /* @__PURE__ */ new Set()
+      legacyExtensions: settings.live === void 0 ? [] : [settings.live.legacyExtension],
+      legacyCallers: /* @__PURE__ */ new Set(),
+      // A server that refuses 4.x clients has no 4.x socket to read it.
+      legacyWire: settings.legacyWire ?? { aliases: /* @__PURE__ */ new Map() }
     })
   );
   return {
@@ -8962,6 +9066,7 @@ function warnUnsourcedGrants(services, sourced, logger) {
 }
 function createServer(options) {
   checkOptions(options);
+  const legacyWire = resolveLegacyWire(options.legacyWire, options.services);
   const logger = options.logger ?? consoleLogger;
   warnUnsourcedGrants(options.services, options.auth?.serviceAccessSource !== void 0, logger);
   const watchdog = prepareWatchdog(options, options.stallWatchdog);
@@ -8982,7 +9087,7 @@ function createServer(options) {
     resolvePrincipal,
     loadServiceAccess: options.auth?.loadServiceAccess,
     binary: options.binary === true,
-    legacyWire: options.legacyWire === true,
+    legacyWire,
     cors: options.cors,
     socket: options.socket,
     rateLimit: options.rateLimit ?? {},
@@ -9039,6 +9144,7 @@ export {
   custom,
   isCustomAccess,
   accessFormProblem,
+  accessIds,
   meetsLevel,
   maxLevel,
   levelsAtLeast,
@@ -9070,6 +9176,7 @@ export {
   MAX_ITEM_IDS,
   selectWith,
   INDEX_MAX_ROWS,
+  narrowKinds,
   allowedScopes,
   membersWhere,
   CHANNEL_ABUSE_WINDOW_MS,
@@ -9099,4 +9206,4 @@ export {
   watchAdapterClients,
   createServer
 };
-//# sourceMappingURL=chunk-NS5PUHIZ.js.map
+//# sourceMappingURL=chunk-RZTP4IEW.js.map