@open-mercato/events 0.7.1-develop.7193.1.910a5b0a1e → 0.7.1-develop.7194.1.ab4fc81f82

package/dist/modules/events/api/route.js

@@ -4,6 +4,15 @@ const metadata = {
   path: "/events",
   GET: { requireAuth: true, requireFeatures: ["workflows.view"] }
 };
+const eventPayloadFieldSchema = z.object({
+  path: z.string(),
+  type: z.enum(["text", "number", "boolean", "select", "date", "object", "unknown"]),
+  label: z.string().optional(),
+  optional: z.boolean().optional()
+});
+const eventPayloadSchemaSchema = z.object({
+  fields: z.array(eventPayloadFieldSchema)
+});
 const eventDefinitionSchema = z.object({
   id: z.string(),
   label: z.string(),
@@ -14,7 +23,8 @@ const eventDefinitionSchema = z.object({
   excludeFromTriggers: z.boolean().optional(),
   clientBroadcast: z.boolean().optional(),
   crossProcessBroadcast: z.boolean().optional(),
-  portalBroadcast: z.boolean().optional()
+  portalBroadcast: z.boolean().optional(),
+  payloadSchema: eventPayloadSchemaSchema.optional()
 });
 const eventsResponseSchema = z.object({
   data: z.array(eventDefinitionSchema),
@@ -46,7 +56,7 @@ const openApi = {
   methods: {
     GET: {
       summary: "List declared events",
-      description: "Returns every declared event. Filters: category, module, excludeTriggerExcluded (default true).",
+      description: "Returns every declared event, including its declared payloadSchema when the module (or the generated CRUD default) provides one. Filters: category, module, excludeTriggerExcluded (default true).",
       responses: [{ status: 200, description: "Declared events", schema: eventsResponseSchema }]
     }
   }

package/dist/modules/events/api/route.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../../src/modules/events/api/route.ts"],
-  "sourcesContent": ["/**\n * Events registry API \u2014 returns declared events from module `events.ts` files.\n *\n * Uses the globally registered event configs (populated during bootstrap). Data\n * leaked here (event ids, module ids, entity ids, broadcast flags) is\n * recon-grade and MUST NOT be served to anonymous callers; the route\n * is protected by the standard `[...slug]` dispatcher with `requireAuth: true`.\n * Consumer: `packages/ui/src/backend/inputs/EventSelect.tsx` (workflow triggers,\n * business rules, webhook config).\n */\n\nimport { z } from 'zod'\nimport type { OpenApiRouteDoc } from '@open-mercato/shared/lib/openapi'\nimport { getDeclaredEvents } from '@open-mercato/shared/modules/events'\n\nexport const metadata = {\n  path: '/events',\n  GET: { requireAuth: true, requireFeatures: ['workflows.view'] },\n}\n\nconst eventDefinitionSchema = z.object({\n  id: z.string(),\n  label: z.string(),\n  description: z.string().optional(),\n  category: z.enum(['crud', 'lifecycle', 'system', 'custom']).optional(),\n  module: z.string().optional(),\n  entity: z.string().optional(),\n  excludeFromTriggers: z.boolean().optional(),\n  clientBroadcast: z.boolean().optional(),\n  crossProcessBroadcast: z.boolean().optional(),\n  portalBroadcast: z.boolean().optional(),\n})\n\nconst eventsResponseSchema = z.object({\n  data: z.array(eventDefinitionSchema),\n  total: z.number().int().nonnegative(),\n})\n\nexport async function GET(req: Request): Promise<Response> {\n  const { searchParams } = new URL(req.url)\n  const category = searchParams.get('category')\n  const moduleId = searchParams.get('module')\n  const excludeTriggerExcluded = searchParams.get('excludeTriggerExcluded') !== 'false'\n\n  let filteredEvents = getDeclaredEvents()\n\n  if (excludeTriggerExcluded) {\n    filteredEvents = filteredEvents.filter((e) => !e.excludeFromTriggers)\n  }\n  if (category) {\n    filteredEvents = filteredEvents.filter((e) => e.category === category)\n  }\n  if (moduleId) {\n    filteredEvents = filteredEvents.filter((e) => e.module === moduleId)\n  }\n\n  return Response.json({\n    data: filteredEvents,\n    total: filteredEvents.length,\n  })\n}\n\nexport const openApi: OpenApiRouteDoc = {\n  summary: 'List declared platform events',\n  description: 'Returns all declared platform events from every enabled module. Supports optional category and module filters.',\n  methods: {\n    GET: {\n      summary: 'List declared events',\n      description: 'Returns every declared event. Filters: category, module, excludeTriggerExcluded (default true).',\n      responses: [{ status: 200, description: 'Declared events', schema: eventsResponseSchema }],\n    },\n  },\n}\n"],
-  "mappings": "AAWA,SAAS,SAAS;AAElB,SAAS,yBAAyB;AAE3B,MAAM,WAAW;AAAA,EACtB,MAAM;AAAA,EACN,KAAK,EAAE,aAAa,MAAM,iBAAiB,CAAC,gBAAgB,EAAE;AAChE;AAEA,MAAM,wBAAwB,EAAE,OAAO;AAAA,EACrC,IAAI,EAAE,OAAO;AAAA,EACb,OAAO,EAAE,OAAO;AAAA,EAChB,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA,EACjC,UAAU,EAAE,KAAK,CAAC,QAAQ,aAAa,UAAU,QAAQ,CAAC,EAAE,SAAS;AAAA,EACrE,QAAQ,EAAE,OAAO,EAAE,SAAS;AAAA,EAC5B,QAAQ,EAAE,OAAO,EAAE,SAAS;AAAA,EAC5B,qBAAqB,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC1C,iBAAiB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACtC,uBAAuB,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC5C,iBAAiB,EAAE,QAAQ,EAAE,SAAS;AACxC,CAAC;AAED,MAAM,uBAAuB,EAAE,OAAO;AAAA,EACpC,MAAM,EAAE,MAAM,qBAAqB;AAAA,EACnC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY;AACtC,CAAC;AAED,eAAsB,IAAI,KAAiC;AACzD,QAAM,EAAE,aAAa,IAAI,IAAI,IAAI,IAAI,GAAG;AACxC,QAAM,WAAW,aAAa,IAAI,UAAU;AAC5C,QAAM,WAAW,aAAa,IAAI,QAAQ;AAC1C,QAAM,yBAAyB,aAAa,IAAI,wBAAwB,MAAM;AAE9E,MAAI,iBAAiB,kBAAkB;AAEvC,MAAI,wBAAwB;AAC1B,qBAAiB,eAAe,OAAO,CAAC,MAAM,CAAC,EAAE,mBAAmB;AAAA,EACtE;AACA,MAAI,UAAU;AACZ,qBAAiB,eAAe,OAAO,CAAC,MAAM,EAAE,aAAa,QAAQ;AAAA,EACvE;AACA,MAAI,UAAU;AACZ,qBAAiB,eAAe,OAAO,CAAC,MAAM,EAAE,WAAW,QAAQ;AAAA,EACrE;AAEA,SAAO,SAAS,KAAK;AAAA,IACnB,MAAM;AAAA,IACN,OAAO,eAAe;AAAA,EACxB,CAAC;AACH;AAEO,MAAM,UAA2B;AAAA,EACtC,SAAS;AAAA,EACT,aAAa;AAAA,EACb,SAAS;AAAA,IACP,KAAK;AAAA,MACH,SAAS;AAAA,MACT,aAAa;AAAA,MACb,WAAW,CAAC,EAAE,QAAQ,KAAK,aAAa,mBAAmB,QAAQ,qBAAqB,CAAC;AAAA,IAC3F;AAAA,EACF;AACF;",
+  "sourcesContent": ["/**\n * Events registry API \u2014 returns declared events from module `events.ts` files.\n *\n * Uses the globally registered event configs (populated during bootstrap). Data\n * leaked here (event ids, module ids, entity ids, broadcast flags) is\n * recon-grade and MUST NOT be served to anonymous callers; the route\n * is protected by the standard `[...slug]` dispatcher with `requireAuth: true`.\n * Consumer: `packages/ui/src/backend/inputs/EventSelect.tsx` (workflow triggers,\n * business rules, webhook config).\n */\n\nimport { z } from 'zod'\nimport type { OpenApiRouteDoc } from '@open-mercato/shared/lib/openapi'\nimport { getDeclaredEvents } from '@open-mercato/shared/modules/events'\n\nexport const metadata = {\n  path: '/events',\n  GET: { requireAuth: true, requireFeatures: ['workflows.view'] },\n}\n\nconst eventPayloadFieldSchema = z.object({\n  path: z.string(),\n  type: z.enum(['text', 'number', 'boolean', 'select', 'date', 'object', 'unknown']),\n  label: z.string().optional(),\n  optional: z.boolean().optional(),\n})\n\nconst eventPayloadSchemaSchema = z.object({\n  fields: z.array(eventPayloadFieldSchema),\n})\n\nconst eventDefinitionSchema = z.object({\n  id: z.string(),\n  label: z.string(),\n  description: z.string().optional(),\n  category: z.enum(['crud', 'lifecycle', 'system', 'custom']).optional(),\n  module: z.string().optional(),\n  entity: z.string().optional(),\n  excludeFromTriggers: z.boolean().optional(),\n  clientBroadcast: z.boolean().optional(),\n  crossProcessBroadcast: z.boolean().optional(),\n  portalBroadcast: z.boolean().optional(),\n  payloadSchema: eventPayloadSchemaSchema.optional(),\n})\n\nconst eventsResponseSchema = z.object({\n  data: z.array(eventDefinitionSchema),\n  total: z.number().int().nonnegative(),\n})\n\nexport async function GET(req: Request): Promise<Response> {\n  const { searchParams } = new URL(req.url)\n  const category = searchParams.get('category')\n  const moduleId = searchParams.get('module')\n  const excludeTriggerExcluded = searchParams.get('excludeTriggerExcluded') !== 'false'\n\n  let filteredEvents = getDeclaredEvents()\n\n  if (excludeTriggerExcluded) {\n    filteredEvents = filteredEvents.filter((e) => !e.excludeFromTriggers)\n  }\n  if (category) {\n    filteredEvents = filteredEvents.filter((e) => e.category === category)\n  }\n  if (moduleId) {\n    filteredEvents = filteredEvents.filter((e) => e.module === moduleId)\n  }\n\n  return Response.json({\n    data: filteredEvents,\n    total: filteredEvents.length,\n  })\n}\n\nexport const openApi: OpenApiRouteDoc = {\n  summary: 'List declared platform events',\n  description: 'Returns all declared platform events from every enabled module. Supports optional category and module filters.',\n  methods: {\n    GET: {\n      summary: 'List declared events',\n      description: 'Returns every declared event, including its declared payloadSchema when the module (or the generated CRUD default) provides one. Filters: category, module, excludeTriggerExcluded (default true).',\n      responses: [{ status: 200, description: 'Declared events', schema: eventsResponseSchema }],\n    },\n  },\n}\n"],
+  "mappings": "AAWA,SAAS,SAAS;AAElB,SAAS,yBAAyB;AAE3B,MAAM,WAAW;AAAA,EACtB,MAAM;AAAA,EACN,KAAK,EAAE,aAAa,MAAM,iBAAiB,CAAC,gBAAgB,EAAE;AAChE;AAEA,MAAM,0BAA0B,EAAE,OAAO;AAAA,EACvC,MAAM,EAAE,OAAO;AAAA,EACf,MAAM,EAAE,KAAK,CAAC,QAAQ,UAAU,WAAW,UAAU,QAAQ,UAAU,SAAS,CAAC;AAAA,EACjF,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA,EAC3B,UAAU,EAAE,QAAQ,EAAE,SAAS;AACjC,CAAC;AAED,MAAM,2BAA2B,EAAE,OAAO;AAAA,EACxC,QAAQ,EAAE,MAAM,uBAAuB;AACzC,CAAC;AAED,MAAM,wBAAwB,EAAE,OAAO;AAAA,EACrC,IAAI,EAAE,OAAO;AAAA,EACb,OAAO,EAAE,OAAO;AAAA,EAChB,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA,EACjC,UAAU,EAAE,KAAK,CAAC,QAAQ,aAAa,UAAU,QAAQ,CAAC,EAAE,SAAS;AAAA,EACrE,QAAQ,EAAE,OAAO,EAAE,SAAS;AAAA,EAC5B,QAAQ,EAAE,OAAO,EAAE,SAAS;AAAA,EAC5B,qBAAqB,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC1C,iBAAiB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACtC,uBAAuB,EAAE,QAAQ,EAAE,SAAS;AAAA,EAC5C,iBAAiB,EAAE,QAAQ,EAAE,SAAS;AAAA,EACtC,eAAe,yBAAyB,SAAS;AACnD,CAAC;AAED,MAAM,uBAAuB,EAAE,OAAO;AAAA,EACpC,MAAM,EAAE,MAAM,qBAAqB;AAAA,EACnC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY;AACtC,CAAC;AAED,eAAsB,IAAI,KAAiC;AACzD,QAAM,EAAE,aAAa,IAAI,IAAI,IAAI,IAAI,GAAG;AACxC,QAAM,WAAW,aAAa,IAAI,UAAU;AAC5C,QAAM,WAAW,aAAa,IAAI,QAAQ;AAC1C,QAAM,yBAAyB,aAAa,IAAI,wBAAwB,MAAM;AAE9E,MAAI,iBAAiB,kBAAkB;AAEvC,MAAI,wBAAwB;AAC1B,qBAAiB,eAAe,OAAO,CAAC,MAAM,CAAC,EAAE,mBAAmB;AAAA,EACtE;AACA,MAAI,UAAU;AACZ,qBAAiB,eAAe,OAAO,CAAC,MAAM,EAAE,aAAa,QAAQ;AAAA,EACvE;AACA,MAAI,UAAU;AACZ,qBAAiB,eAAe,OAAO,CAAC,MAAM,EAAE,WAAW,QAAQ;AAAA,EACrE;AAEA,SAAO,SAAS,KAAK;AAAA,IACnB,MAAM;AAAA,IACN,OAAO,eAAe;AAAA,EACxB,CAAC;AACH;AAEO,MAAM,UAA2B;AAAA,EACtC,SAAS;AAAA,EACT,aAAa;AAAA,EACb,SAAS;AAAA,IACP,KAAK;AAAA,MACH,SAAS;AAAA,MACT,aAAa;AAAA,MACb,WAAW,CAAC,EAAE,QAAQ,KAAK,aAAa,mBAAmB,QAAQ,qBAAqB,CAAC;AAAA,IAC3F;AAAA,EACF;AACF;",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-mercato/events",
-  "version": "0.7.1-develop.7193.1.910a5b0a1e",
+  "version": "0.7.1-develop.7194.1.ab4fc81f82",
   "license": "MIT",
   "type": "module",
   "main": "./dist/index.js",
@@ -33,8 +33,8 @@
     }
   },
   "dependencies": {
-    "@open-mercato/queue": "0.7.1-develop.7193.1.910a5b0a1e",
-    "@open-mercato/shared": "0.7.1-develop.7193.1.910a5b0a1e",
+    "@open-mercato/queue": "0.7.1-develop.7194.1.ab4fc81f82",
+    "@open-mercato/shared": "0.7.1-develop.7194.1.ab4fc81f82",
     "pg": "8.23.0"
   },
   "devDependencies": {

package/src/modules/events/api/__tests__/route.test.ts

@@ -6,6 +6,13 @@ jest.mock('@open-mercato/shared/modules/events', () => ({
       entity: 'person',
       label: 'Person Created',
       category: 'crud',
+      payloadSchema: {
+        fields: [
+          { path: 'id', type: 'text' },
+          { path: 'organizationId', type: 'text', optional: true },
+          { path: 'tenantId', type: 'text', optional: true },
+        ],
+      },
     },
     {
       id: 'sales.order.placed',
@@ -69,4 +76,22 @@ describe('GET /api/events (core events module route)', () => {
     expect(body.total).toBe(1)
     expect(body.data[0].module).toBe('customers')
   })
+
+  it('exposes payloadSchema for events that declare one and omits it otherwise', async () => {
+    const res = await GET(makeReq())
+    const body = (await res.json()) as {
+      data: Array<{ id: string; payloadSchema?: { fields: Array<{ path: string; type: string; optional?: boolean }> } }>
+    }
+    const typed = body.data.find((e) => e.id === 'customers.person.created')
+    expect(typed?.payloadSchema).toEqual({
+      fields: [
+        { path: 'id', type: 'text' },
+        { path: 'organizationId', type: 'text', optional: true },
+        { path: 'tenantId', type: 'text', optional: true },
+      ],
+    })
+    const untyped = body.data.find((e) => e.id === 'sales.order.placed')
+    expect(untyped).toBeDefined()
+    expect(untyped?.payloadSchema).toBeUndefined()
+  })
 })

package/src/modules/events/api/route.ts

@@ -18,6 +18,17 @@ export const metadata = {
   GET: { requireAuth: true, requireFeatures: ['workflows.view'] },
 }
 
+const eventPayloadFieldSchema = z.object({
+  path: z.string(),
+  type: z.enum(['text', 'number', 'boolean', 'select', 'date', 'object', 'unknown']),
+  label: z.string().optional(),
+  optional: z.boolean().optional(),
+})
+
+const eventPayloadSchemaSchema = z.object({
+  fields: z.array(eventPayloadFieldSchema),
+})
+
 const eventDefinitionSchema = z.object({
   id: z.string(),
   label: z.string(),
@@ -29,6 +40,7 @@ const eventDefinitionSchema = z.object({
   clientBroadcast: z.boolean().optional(),
   crossProcessBroadcast: z.boolean().optional(),
   portalBroadcast: z.boolean().optional(),
+  payloadSchema: eventPayloadSchemaSchema.optional(),
 })
 
 const eventsResponseSchema = z.object({
@@ -66,7 +78,7 @@ export const openApi: OpenApiRouteDoc = {
   methods: {
     GET: {
       summary: 'List declared events',
-      description: 'Returns every declared event. Filters: category, module, excludeTriggerExcluded (default true).',
+      description: 'Returns every declared event, including its declared payloadSchema when the module (or the generated CRUD default) provides one. Filters: category, module, excludeTriggerExcluded (default true).',
       responses: [{ status: 200, description: 'Declared events', schema: eventsResponseSchema }],
     },
   },