@palbase/backend 24.3.0 → 25.0.0

package/dist/openapi/index.cjs

@@ -5799,6 +5799,50 @@ module.exports = __toCommonJS(openapi_exports);
 
 // src/openapi/aggregate.ts
 var import_zod_to_openapi3 = require("@asteasolutions/zod-to-openapi");
+
+// src/decorators/registry.ts
+var ROUTES = /* @__PURE__ */ Symbol.for("palbase.backend.routes");
+var ROOM = /* @__PURE__ */ Symbol.for("palbase.backend.room");
+var RETURN_BUFFER = /* @__PURE__ */ Symbol.for("palbase.backend.returnBuffer");
+var THROWS_BUFFER = /* @__PURE__ */ Symbol.for("palbase.backend.throwsBuffer");
+function carrierOf(target) {
+  const ctor = typeof target === "function" ? target : target.constructor ?? target;
+  return ctor;
+}
+function getRoutes(ctor) {
+  const carrier = carrierOf(ctor);
+  const routes = carrier[ROUTES] ?? [];
+  const returnBuffer = carrier[RETURN_BUFFER];
+  if (returnBuffer) {
+    for (const route of routes) {
+      const buffered = returnBuffer[route.fnName];
+      if (buffered && route.returnSchema === void 0) {
+        route.returnSchema = buffered;
+      }
+    }
+  }
+  const throwsBuffer = carrier[THROWS_BUFFER];
+  if (throwsBuffer) {
+    for (const route of routes) {
+      const buffered = throwsBuffer[route.fnName];
+      if (buffered && route.throws === void 0) {
+        route.throws = buffered;
+      }
+    }
+  }
+  return routes.map((r) => ({
+    ...r,
+    params: r.params.slice(),
+    ...r.throws !== void 0 ? { throws: r.throws.slice() } : {}
+  }));
+}
+function getRoom(ctor) {
+  const carrier = carrierOf(ctor);
+  if (!Object.prototype.hasOwnProperty.call(carrier, ROOM)) return void 0;
+  return carrier[ROOM];
+}
+
+// src/openapi/aggregate.ts
 var import_zod3 = require("zod");
 
 // src/openapi/convert.ts
@@ -5915,42 +5959,6 @@ var import_fast_glob = __toESM(require_out4(), 1);
 var import_node_path = __toESM(require("path"), 1);
 var import_node_url = require("url");
 
-// src/decorators/registry.ts
-var ROUTES = /* @__PURE__ */ Symbol.for("palbase.backend.routes");
-var RETURN_BUFFER = /* @__PURE__ */ Symbol.for("palbase.backend.returnBuffer");
-var THROWS_BUFFER = /* @__PURE__ */ Symbol.for("palbase.backend.throwsBuffer");
-function carrierOf(target) {
-  const ctor = typeof target === "function" ? target : target.constructor ?? target;
-  return ctor;
-}
-function getRoutes(ctor) {
-  const carrier = carrierOf(ctor);
-  const routes = carrier[ROUTES] ?? [];
-  const returnBuffer = carrier[RETURN_BUFFER];
-  if (returnBuffer) {
-    for (const route of routes) {
-      const buffered = returnBuffer[route.fnName];
-      if (buffered && route.returnSchema === void 0) {
-        route.returnSchema = buffered;
-      }
-    }
-  }
-  const throwsBuffer = carrier[THROWS_BUFFER];
-  if (throwsBuffer) {
-    for (const route of routes) {
-      const buffered = throwsBuffer[route.fnName];
-      if (buffered && route.throws === void 0) {
-        route.throws = buffered;
-      }
-    }
-  }
-  return routes.map((r) => ({
-    ...r,
-    params: r.params.slice(),
-    ...r.throws !== void 0 ? { throws: r.throws.slice() } : {}
-  }));
-}
-
 // src/decorators/controller.ts
 var CONTROLLER_META = /* @__PURE__ */ Symbol.for("palbase.backend.controllerMeta");
 var APP_DEFAULT_AUTH = /* @__PURE__ */ Symbol.for("palbase.backend.appDefaultAuth");
@@ -6026,6 +6034,9 @@ var DEFAULT_IGNORE = [
   "**/node_modules/**"
 ];
 function flattenController(controller) {
+  if (getRoom(controller) !== void 0 && !isController(controller)) {
+    return [];
+  }
   const meta = resolveController(controller);
   const controllerName = deriveControllerName(controller.name);
   const routes = getRoutes(controller);
@@ -6355,6 +6366,44 @@ function isRefinedSchema(schema) {
   if (!typeName) return false;
   return typeName === "ZodEffects" || typeName === "ZodPreprocess" || typeName === "ZodTransform";
 }
+function firstUntypedField(schema) {
+  const shape = schema?.shape;
+  if (!shape) return void 0;
+  for (const [field, sub] of Object.entries(shape)) {
+    const kind = sub?._def?.typeName;
+    if (kind === "ZodUnknown" || kind === "ZodAny") return field;
+  }
+  return void 0;
+}
+function assertRoomFieldsTyped(pattern, room) {
+  for (const [event, schema] of Object.entries(room.events)) {
+    const field = firstUntypedField(schema);
+    if (field !== void 0) {
+      throw new Error(
+        `@Room("${pattern}") event "${event}" has an untyped field "${field}". An untyped payload makes every generated client opaque \u2014 declare its shape.`
+      );
+    }
+  }
+  for (const [message, meta] of Object.entries(room.messages)) {
+    const field = firstUntypedField(meta.schema);
+    if (field !== void 0) {
+      throw new Error(
+        `@Room("${pattern}") message "${message}" has an untyped field "${field}". Inbound payloads reach the server \u2014 declare the shape so it can be validated.`
+      );
+    }
+  }
+}
+function roomExtension(room, register) {
+  const events = {};
+  for (const [name, schema] of Object.entries(room.events)) {
+    events[name] = { $ref: register(name, schema) };
+  }
+  const messages = {};
+  for (const [name, meta] of Object.entries(room.messages)) {
+    messages[name] = { $ref: register(name, meta.schema) };
+  }
+  return { events, messages, graceMs: room.graceMs };
+}
 
 // src/openapi/aggregate.ts
 (0, import_zod_to_openapi3.extendZodWithOpenApi)(import_zod3.z);
@@ -6380,6 +6429,18 @@ async function aggregateOpenAPI(projectRoot, options = {}) {
     registerControllerRoute(registry, route);
   }
   const generator = new import_zod_to_openapi3.OpenApiGeneratorV31(registry.definitions);
+  const roomExt = {};
+  for (const lc of loadedControllers) {
+    const room = getRoom(lc.controller);
+    if (room === void 0) continue;
+    assertRoomFieldsTyped(room.pattern, room);
+    const slug = room.pattern.replace(/[^A-Za-z0-9]+/g, "_").replace(/^_|_$/g, "");
+    roomExt[room.pattern] = roomExtension(room, (name, schema) => {
+      const componentName = `Room_${slug}_${name}`;
+      registry.register(componentName, schema);
+      return `#/components/schemas/${componentName}`;
+    });
+  }
   const document = generator.generateDocument({
     openapi: "3.2.0",
     info: {
@@ -6388,6 +6449,9 @@ async function aggregateOpenAPI(projectRoot, options = {}) {
       description: "Auto-generated from class controllers (@Controller/@Get/@Post + @Body/@QueryParams/@Param) Zod schemas + method return types at deploy time. Do not edit by hand."
     }
   });
+  if (Object.keys(roomExt).length > 0) {
+    document["x-palbase-room"] = roomExt;
+  }
   return {
     document,
     endpointCount: controllerRoutes.length,