@open-mercato/shared 0.6.7-develop.6622.1.4d29ddaca4 → 0.6.7-develop.6628.1.f9e4ecf70f

package/.turbo/turbo-build.log

@@ -1,2 +1,2 @@
-[build:shared] found 238 entry points
+[build:shared] found 239 entry points
 [build:shared] built successfully

package/dist/lib/openapi/attach-docs.js

@@ -0,0 +1,44 @@
+function manifestKey(entry) {
+  return entry.kind === "legacy" && entry.method ? `${entry.moduleId}\0${entry.method}\0${entry.path}` : `${entry.moduleId}\0${entry.path}`;
+}
+async function loadOpenApiExport(entry) {
+  if (!entry) return void 0;
+  try {
+    const mod = await entry.load();
+    const openApi = mod.openApi;
+    return openApi && typeof openApi === "object" ? openApi : void 0;
+  } catch {
+    return void 0;
+  }
+}
+async function attachOpenApiDocsToModules(modules, manifests) {
+  const manifestsByKey = /* @__PURE__ */ new Map();
+  for (const entry of manifests) {
+    manifestsByKey.set(manifestKey(entry), entry);
+  }
+  return Promise.all(
+    modules.map(async (mod) => {
+      if (!Array.isArray(mod.apis) || !mod.apis.length) return mod;
+      const apis = await Promise.all(
+        mod.apis.map(async (api) => {
+          if (api.docs) return api;
+          if ("handlers" in api) {
+            const entry2 = manifestsByKey.get(`${mod.id}\0${api.path}`);
+            const docs2 = await loadOpenApiExport(entry2);
+            if (!docs2) return api;
+            return { ...api, docs: docs2 };
+          }
+          const entry = manifestsByKey.get(`${mod.id}\0${api.method}\0${api.path}`);
+          const docs = await loadOpenApiExport(entry);
+          if (!docs) return api;
+          return { ...api, docs };
+        })
+      );
+      return { ...mod, apis };
+    })
+  );
+}
+export {
+  attachOpenApiDocsToModules
+};
+//# sourceMappingURL=attach-docs.js.map

package/dist/lib/openapi/attach-docs.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/lib/openapi/attach-docs.ts"],
+  "sourcesContent": ["import type {\n  ApiRouteManifestEntry,\n  Module,\n  ModuleApi,\n  ModuleApiLegacy,\n  ModuleApiRouteFile,\n} from '../../modules/registry'\nimport type { OpenApiMethodDoc, OpenApiRouteDoc } from './types'\n\nfunction manifestKey(entry: ApiRouteManifestEntry): string {\n  return entry.kind === 'legacy' && entry.method\n    ? `${entry.moduleId}\\0${entry.method}\\0${entry.path}`\n    : `${entry.moduleId}\\0${entry.path}`\n}\n\nasync function loadOpenApiExport(entry: ApiRouteManifestEntry | undefined): Promise<unknown> {\n  if (!entry) return undefined\n  try {\n    const mod = await entry.load()\n    const openApi = (mod as { openApi?: unknown }).openApi\n    return openApi && typeof openApi === 'object' ? openApi : undefined\n  } catch {\n    return undefined\n  }\n}\n\n/**\n * The lazy runtime module registry omits each route's `docs` (the `openApi`\n * export) so route files stay dynamically imported. Documentation endpoints\n * that build the OpenAPI document from that registry must re-attach the docs\n * by loading each route module through the API route manifests on demand.\n */\nexport async function attachOpenApiDocsToModules(\n  modules: Module[],\n  manifests: ApiRouteManifestEntry[],\n): Promise<Module[]> {\n  const manifestsByKey = new Map<string, ApiRouteManifestEntry>()\n  for (const entry of manifests) {\n    manifestsByKey.set(manifestKey(entry), entry)\n  }\n\n  return Promise.all(\n    modules.map(async (mod) => {\n      if (!Array.isArray(mod.apis) || !mod.apis.length) return mod\n      const apis = await Promise.all(\n        mod.apis.map(async (api): Promise<ModuleApi> => {\n          if ((api as { docs?: unknown }).docs) return api\n          if ('handlers' in api) {\n            const entry = manifestsByKey.get(`${mod.id}\\0${api.path}`)\n            const docs = await loadOpenApiExport(entry)\n            if (!docs) return api\n            return { ...api, docs: docs as OpenApiRouteDoc } satisfies ModuleApiRouteFile\n          }\n          const entry = manifestsByKey.get(`${mod.id}\\0${api.method}\\0${api.path}`)\n          const docs = await loadOpenApiExport(entry)\n          if (!docs) return api\n          return { ...api, docs: docs as OpenApiMethodDoc } satisfies ModuleApiLegacy\n        }),\n      )\n      return { ...mod, apis }\n    }),\n  )\n}\n"],
+  "mappings": "AASA,SAAS,YAAY,OAAsC;AACzD,SAAO,MAAM,SAAS,YAAY,MAAM,SACpC,GAAG,MAAM,QAAQ,KAAK,MAAM,MAAM,KAAK,MAAM,IAAI,KACjD,GAAG,MAAM,QAAQ,KAAK,MAAM,IAAI;AACtC;AAEA,eAAe,kBAAkB,OAA4D;AAC3F,MAAI,CAAC,MAAO,QAAO;AACnB,MAAI;AACF,UAAM,MAAM,MAAM,MAAM,KAAK;AAC7B,UAAM,UAAW,IAA8B;AAC/C,WAAO,WAAW,OAAO,YAAY,WAAW,UAAU;AAAA,EAC5D,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAQA,eAAsB,2BACpB,SACA,WACmB;AACnB,QAAM,iBAAiB,oBAAI,IAAmC;AAC9D,aAAW,SAAS,WAAW;AAC7B,mBAAe,IAAI,YAAY,KAAK,GAAG,KAAK;AAAA,EAC9C;AAEA,SAAO,QAAQ;AAAA,IACb,QAAQ,IAAI,OAAO,QAAQ;AACzB,UAAI,CAAC,MAAM,QAAQ,IAAI,IAAI,KAAK,CAAC,IAAI,KAAK,OAAQ,QAAO;AACzD,YAAM,OAAO,MAAM,QAAQ;AAAA,QACzB,IAAI,KAAK,IAAI,OAAO,QAA4B;AAC9C,cAAK,IAA2B,KAAM,QAAO;AAC7C,cAAI,cAAc,KAAK;AACrB,kBAAMA,SAAQ,eAAe,IAAI,GAAG,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE;AACzD,kBAAMC,QAAO,MAAM,kBAAkBD,MAAK;AAC1C,gBAAI,CAACC,MAAM,QAAO;AAClB,mBAAO,EAAE,GAAG,KAAK,MAAMA,MAAwB;AAAA,UACjD;AACA,gBAAM,QAAQ,eAAe,IAAI,GAAG,IAAI,EAAE,KAAK,IAAI,MAAM,KAAK,IAAI,IAAI,EAAE;AACxE,gBAAM,OAAO,MAAM,kBAAkB,KAAK;AAC1C,cAAI,CAAC,KAAM,QAAO;AAClB,iBAAO,EAAE,GAAG,KAAK,KAA+B;AAAA,QAClD,CAAC;AAAA,MACH;AACA,aAAO,EAAE,GAAG,KAAK,KAAK;AAAA,IACxB,CAAC;AAAA,EACH;AACF;",
+  "names": ["entry", "docs"]
+}

package/dist/lib/openapi/index.js

@@ -2,7 +2,9 @@ export * from "./types.js";
 import { buildOpenApiDocument, generateMarkdownFromOpenApi } from "./generator.js";
 export * from "./crud.js";
 import { sanitizeOpenApiDocument } from "./sanitize.js";
+import { attachOpenApiDocsToModules } from "./attach-docs.js";
 export {
+  attachOpenApiDocsToModules,
   buildOpenApiDocument,
   generateMarkdownFromOpenApi,
   sanitizeOpenApiDocument

package/dist/lib/openapi/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/lib/openapi/index.ts"],
-  "sourcesContent": ["export * from './types'\nexport { buildOpenApiDocument, generateMarkdownFromOpenApi } from './generator'\nexport * from './crud'\nexport { sanitizeOpenApiDocument } from './sanitize'\n"],
-  "mappings": "AAAA,cAAc;AACd,SAAS,sBAAsB,mCAAmC;AAClE,cAAc;AACd,SAAS,+BAA+B;",
+  "sourcesContent": ["export * from './types'\nexport { buildOpenApiDocument, generateMarkdownFromOpenApi } from './generator'\nexport * from './crud'\nexport { sanitizeOpenApiDocument } from './sanitize'\nexport { attachOpenApiDocsToModules } from './attach-docs'\n"],
+  "mappings": "AAAA,cAAc;AACd,SAAS,sBAAsB,mCAAmC;AAClE,cAAc;AACd,SAAS,+BAA+B;AACxC,SAAS,kCAAkC;",
   "names": []
 }

package/dist/lib/version.js

@@ -1,4 +1,4 @@
-const APP_VERSION = "0.6.7-develop.6622.1.4d29ddaca4";
+const APP_VERSION = "0.6.7-develop.6628.1.f9e4ecf70f";
 const appVersion = APP_VERSION;
 export {
   APP_VERSION,

package/dist/lib/version.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/lib/version.ts"],
-  "sourcesContent": ["// Build-time generated version\nexport const APP_VERSION = '0.6.7-develop.6622.1.4d29ddaca4'\nexport const appVersion = APP_VERSION\n"],
+  "sourcesContent": ["// Build-time generated version\nexport const APP_VERSION = '0.6.7-develop.6628.1.f9e4ecf70f'\nexport const appVersion = APP_VERSION\n"],
   "mappings": "AACO,MAAM,cAAc;AACpB,MAAM,aAAa;",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-mercato/shared",
-  "version": "0.6.7-develop.6622.1.4d29ddaca4",
+  "version": "0.6.7-develop.6628.1.f9e4ecf70f",
   "license": "MIT",
   "type": "module",
   "main": "./dist/index.js",
@@ -97,7 +97,7 @@
     "@mikro-orm/core": "^7.1.5",
     "@mikro-orm/decorators": "^7.1.5",
     "@mikro-orm/postgresql": "^7.1.5",
-    "@open-mercato/cache": "0.6.7-develop.6622.1.4d29ddaca4",
+    "@open-mercato/cache": "0.6.7-develop.6628.1.f9e4ecf70f",
     "@types/sanitize-html": "^2.16.1",
     "dotenv": "^17.4.2",
     "pino": "^10.3.1",

package/src/lib/openapi/__tests__/attach-docs.test.ts

@@ -0,0 +1,105 @@
+import { z } from 'zod'
+import { attachOpenApiDocsToModules } from '../attach-docs'
+import { buildOpenApiDocument } from '../generator'
+import type { ApiRouteManifestEntry, Module } from '../../../modules/registry'
+
+const inviteSchema = z.object({ email: z.string().email(), roleIds: z.array(z.string()) })
+
+const routeFileOpenApi = {
+  methods: {
+    POST: {
+      summary: 'Invite user',
+      requestBody: { schema: inviteSchema, description: 'Invitation payload' },
+    },
+  },
+}
+
+const legacyOpenApi = {
+  summary: 'Legacy create',
+  requestBody: { schema: z.object({ name: z.string() }) },
+}
+
+function makeModules(): Module[] {
+  return [
+    {
+      id: 'customer_accounts',
+      apis: [
+        {
+          path: '/customer_accounts/admin/users-invite',
+          metadata: { POST: { requireAuth: true } },
+          handlers: { POST: async () => new Response(null) },
+        },
+        {
+          method: 'POST',
+          path: '/customer_accounts/legacy-create',
+          handler: async () => new Response(null),
+        },
+      ],
+    } as unknown as Module,
+  ]
+}
+
+const manifests: ApiRouteManifestEntry[] = [
+  {
+    moduleId: 'customer_accounts',
+    kind: 'route-file',
+    path: '/customer_accounts/admin/users-invite',
+    methods: ['POST'],
+    load: async () => ({ openApi: routeFileOpenApi }),
+  },
+  {
+    moduleId: 'customer_accounts',
+    kind: 'legacy',
+    method: 'POST',
+    path: '/customer_accounts/legacy-create',
+    methods: ['POST'],
+    load: async () => ({ openApi: legacyOpenApi }),
+  },
+]
+
+describe('attachOpenApiDocsToModules', () => {
+  it('re-attaches route docs the runtime registry omits, restoring request bodies (#4361)', async () => {
+    const bare = buildOpenApiDocument(makeModules())
+    const barePost = bare.paths['/customer_accounts/admin/users-invite']?.post as Record<string, any>
+    expect(barePost.requestBody).toBeUndefined()
+
+    const enriched = await attachOpenApiDocsToModules(makeModules(), manifests)
+    const doc = buildOpenApiDocument(enriched)
+
+    const post = doc.paths['/customer_accounts/admin/users-invite']?.post as Record<string, any>
+    expect(post.summary).toBe('Invite user')
+    const bodySchema = post.requestBody?.content?.['application/json']?.schema
+    expect(bodySchema?.properties?.email).toBeDefined()
+    expect(bodySchema?.required).toContain('email')
+
+    const legacyPost = doc.paths['/customer_accounts/legacy-create']?.post as Record<string, any>
+    expect(legacyPost.summary).toBe('Legacy create')
+    expect(legacyPost.requestBody?.content?.['application/json']?.schema?.properties?.name).toBeDefined()
+  })
+
+  it('keeps entries untouched when no manifest matches or loading fails', async () => {
+    const failing: ApiRouteManifestEntry[] = [
+      {
+        moduleId: 'customer_accounts',
+        kind: 'route-file',
+        path: '/customer_accounts/admin/users-invite',
+        methods: ['POST'],
+        load: async () => {
+          throw new Error('boom')
+        },
+      },
+    ]
+    const enriched = await attachOpenApiDocsToModules(makeModules(), failing)
+    const apis = enriched[0].apis ?? []
+    expect((apis[0] as { docs?: unknown }).docs).toBeUndefined()
+    expect((apis[1] as { docs?: unknown }).docs).toBeUndefined()
+  })
+
+  it('does not overwrite docs that are already present', async () => {
+    const modules = makeModules()
+    const existingDocs = { methods: { POST: { summary: 'Existing' } } }
+    ;(modules[0].apis?.[0] as { docs?: unknown }).docs = existingDocs
+    const enriched = await attachOpenApiDocsToModules(modules, manifests)
+    expect((enriched[0].apis?.[0] as { docs?: unknown }).docs).toBe(existingDocs)
+  })
+})

package/src/lib/openapi/attach-docs.ts

@@ -0,0 +1,63 @@
+import type {
+  ApiRouteManifestEntry,
+  Module,
+  ModuleApi,
+  ModuleApiLegacy,
+  ModuleApiRouteFile,
+} from '../../modules/registry'
+import type { OpenApiMethodDoc, OpenApiRouteDoc } from './types'
+
+function manifestKey(entry: ApiRouteManifestEntry): string {
+  return entry.kind === 'legacy' && entry.method
+    ? `${entry.moduleId}\0${entry.method}\0${entry.path}`
+    : `${entry.moduleId}\0${entry.path}`
+}
+
+async function loadOpenApiExport(entry: ApiRouteManifestEntry | undefined): Promise<unknown> {
+  if (!entry) return undefined
+  try {
+    const mod = await entry.load()
+    const openApi = (mod as { openApi?: unknown }).openApi
+    return openApi && typeof openApi === 'object' ? openApi : undefined
+  } catch {
+    return undefined
+  }
+}
+
+/**
+ * The lazy runtime module registry omits each route's `docs` (the `openApi`
+ * export) so route files stay dynamically imported. Documentation endpoints
+ * that build the OpenAPI document from that registry must re-attach the docs
+ * by loading each route module through the API route manifests on demand.
+ */
+export async function attachOpenApiDocsToModules(
+  modules: Module[],
+  manifests: ApiRouteManifestEntry[],
+): Promise<Module[]> {
+  const manifestsByKey = new Map<string, ApiRouteManifestEntry>()
+  for (const entry of manifests) {
+    manifestsByKey.set(manifestKey(entry), entry)
+  }
+
+  return Promise.all(
+    modules.map(async (mod) => {
+      if (!Array.isArray(mod.apis) || !mod.apis.length) return mod
+      const apis = await Promise.all(
+        mod.apis.map(async (api): Promise<ModuleApi> => {
+          if ((api as { docs?: unknown }).docs) return api
+          if ('handlers' in api) {
+            const entry = manifestsByKey.get(`${mod.id}\0${api.path}`)
+            const docs = await loadOpenApiExport(entry)
+            if (!docs) return api
+            return { ...api, docs: docs as OpenApiRouteDoc } satisfies ModuleApiRouteFile
+          }
+          const entry = manifestsByKey.get(`${mod.id}\0${api.method}\0${api.path}`)
+          const docs = await loadOpenApiExport(entry)
+          if (!docs) return api
+          return { ...api, docs: docs as OpenApiMethodDoc } satisfies ModuleApiLegacy
+        }),
+      )
+      return { ...mod, apis }
+    }),
+  )
+}

package/src/lib/openapi/index.ts

@@ -2,3 +2,4 @@ export * from './types'
 export { buildOpenApiDocument, generateMarkdownFromOpenApi } from './generator'
 export * from './crud'
 export { sanitizeOpenApiDocument } from './sanitize'
+export { attachOpenApiDocsToModules } from './attach-docs'