Merge pull request #241 from objectstack-ai/copilot/review-and-modify-metadata

Author: hotlong

ROADMAP.md

@@ -65,7 +65,7 @@
 | Studio Builder Configs | 4 (Interface Builder, Page Builder, Canvas Snap, Element Palette) |
 | Navigation Areas | 3 (header, sidebar, utility bar) |
 | Packages Registered in Root Config | 13 of 13 (all packages registered) |
-| Test Files | 194 files, 3813 tests (all passing) |
+| Test Files | 195 files, 3817 tests (all passing) |
 | TypeScript Compliance | 100% (zero type errors) |
 | Protocol Compliance | 100% (all objects pass ObjectSchema.create()) |
 | Spec Schema Adoption | ~95 of ~95 application-level schemas used (~100%) |
@@ -203,13 +203,15 @@ These items were deferred during Phase 13 and have been completed:
 - [ ] **Legacy API cleanup (Phase 2)** — Remove `db.ts` exports entirely once all consumers migrated to broker/ObjectQL
 - [ ] **E2E test coverage** — Build API-layer end-to-end tests for Feed API / MCP API
 - [ ] **FormView `as any` cleanup** — Remove `as any` casts once `@objectstack/spec` aligns FormView column types
+- [x] **Events metadata schema validation** — Added `EventTypeDefinitionSchema.parse()` to all 9 `*.events.ts` files; all metadata now validated against spec schemas
 
 ---
 
 ## Version Upgrade History
 
 | Date | From | To | Breaking Changes | Tests |
 |------|------|----|-----------------|-------|
+| 2026-02-26 | v3.0.8 | v3.0.8 | None (Phase 15: Added EventTypeDefinitionSchema validation to all 9 events.ts files; 100% metadata schema compliance) | 3817 ✅ |
 | 2026-02-25 | v3.0.8 | v3.0.8 | None (Phase 15: Fixed tsconfig.json path aliases for node16 ESM module resolution — changed directory paths to explicit index.ts files) | 3813 ✅ |
 | 2026-02-21 | v3.0.8 | v3.0.8 | None (Phase 15 continued: Structured pino logging across 154 files, CacheManager test isolation, db.ts deprecation annotations, emoji removal from logs) | 3813 ✅ |
 | 2026-02-21 | v3.0.8 | v3.0.8 | None (Phase 15: Repository quality improvements — hook `any` type migration, CI typecheck, ESLint version alignment, documentation updates, code-quality workflow fixes) | 3799 ✅ |

content/docs/index.mdx

@@ -90,7 +90,7 @@ Explore the six business clouds that power every stage of the customer lifecycle
 | **Server-Side Hooks** | 121+ hooks enforcing business logic |
 | **Integration Connectors** | 10 (Stripe, DocuSign, Slack, Gmail, Teams, PayPal, Adobe Sign, Outlook, QuickBooks, LinkedIn) |
 | **AI Agent Workflows** | 13 AI agents + 6 autonomous workflows |
-| **Tests** | 3,707 passing across 188 test files |
+| **Tests** | 3,817 passing across 195 test files |
 
 ## 📚 Resources
 

content/docs/roadmap.mdx

@@ -71,7 +71,7 @@ HotCRM has completed **16 development phases** (1–14 including 10.5, 10.6, 12A
 | Seed Data Files | 39 across 14 packages |
 | Seed Data Validation | ✅ All seed files validated with cross-package relationship tests |
 | Dependency Graph | 14 packages with topological load order validation |
-| Test Files | 192 files, 3,799 tests (all passing) |
+| Test Files | 195 files, 3,817 tests (all passing) |
 | TypeScript Compliance | 100% (zero type errors) |
 | Spec Schema Adoption | ~95 / ~95 (~100%) |
 

packages/analytics/src/analytics.events.ts

@@ -4,26 +4,23 @@
  * Defines the event contracts for cross-package communication.
  * Other plugins can subscribe to these events to react to Analytics domain changes.
  */
+import { EventTypeDefinitionSchema } from '@objectstack/spec/kernel';
 
 export const AnalyticsEvents = {
-  reportExecuted: {
+  reportExecuted: EventTypeDefinitionSchema.parse({
     name: 'analytics.report.executed',
-    type: 'domain' as const,
     description: 'Fired when a report is executed and results are generated',
-  },
-  dashboardRefreshed: {
+  }),
+  dashboardRefreshed: EventTypeDefinitionSchema.parse({
     name: 'analytics.dashboard.refreshed',
-    type: 'domain' as const,
     description: 'Fired when a dashboard is refreshed with updated data',
-  },
-  kpiThresholdBreached: {
+  }),
+  kpiThresholdBreached: EventTypeDefinitionSchema.parse({
     name: 'analytics.kpi.threshold_breached',
-    type: 'domain' as const,
     description: 'Fired when a KPI value crosses a warning or critical threshold',
-  },
-  dataSourceSynced: {
+  }),
+  dataSourceSynced: EventTypeDefinitionSchema.parse({
     name: 'analytics.data_source.synced',
-    type: 'domain' as const,
     description: 'Fired when a data source completes a sync operation',
-  },
+  }),
 };

packages/community/src/community.events.ts

@@ -4,26 +4,23 @@
  * Defines the event contracts for cross-package communication.
  * Other plugins can subscribe to these events to react to Community domain changes.
  */
+import { EventTypeDefinitionSchema } from '@objectstack/spec/kernel';
 
 export const CommunityEvents = {
-  topicCreated: {
+  topicCreated: EventTypeDefinitionSchema.parse({
     name: 'community.topic.created',
-    type: 'domain' as const,
     description: 'Fired when a new topic is created in the forum',
-  },
-  replyPosted: {
+  }),
+  replyPosted: EventTypeDefinitionSchema.parse({
     name: 'community.reply.posted',
-    type: 'domain' as const,
     description: 'Fired when a reply is posted to a topic',
-  },
-  ideaSubmitted: {
+  }),
+  ideaSubmitted: EventTypeDefinitionSchema.parse({
     name: 'community.idea.submitted',
-    type: 'domain' as const,
     description: 'Fired when a new idea is submitted for consideration',
-  },
-  badgeAwarded: {
+  }),
+  badgeAwarded: EventTypeDefinitionSchema.parse({
     name: 'community.badge.awarded',
-    type: 'domain' as const,
     description: 'Fired when a badge is awarded to a community member',
-  },
+  }),
 };

packages/crm/__tests__/unit/schemas/events-schema.test.ts

@@ -0,0 +1,30 @@
+import { describe, it, expect } from 'vitest';
+import { EventTypeDefinitionSchema } from '@objectstack/spec/kernel';
+import { CRMEvents } from '../../../src/crm.events';
+
+describe('CRM Events Schema Compliance', () => {
+  it('should be defined and non-empty', () => {
+    expect(CRMEvents).toBeDefined();
+    expect(Object.keys(CRMEvents).length).toBeGreaterThan(0);
+  });
+
+  it('each event should re-validate against EventTypeDefinitionSchema', () => {
+    for (const [key, event] of Object.entries(CRMEvents)) {
+      expect(() => EventTypeDefinitionSchema.parse(event), `Event "${key}" failed re-validation`).not.toThrow();
+    }
+  });
+
+  it('each event should have required properties from schema', () => {
+    for (const [, event] of Object.entries(CRMEvents)) {
+      expect(event).toHaveProperty('name');
+      expect(event).toHaveProperty('description');
+      expect(event).toHaveProperty('version');
+    }
+  });
+
+  it('event names should follow domain naming convention', () => {
+    for (const [, event] of Object.entries(CRMEvents)) {
+      expect(event.name).toMatch(/^crm\./);
+    }
+  });
+});

packages/crm/__tests__/unit/schemas/plugin-schema.test.ts

@@ -46,10 +46,10 @@ describe('CRM Plugin Schema Compliance', () => {
       expect(CRMEvents.leadConverted).toBeDefined();
     });
 
-    it('each event should have a name and type', () => {
+    it('each event should have a name and description', () => {
       for (const [, event] of Object.entries(CRMEvents)) {
         expect(event).toHaveProperty('name');
-        expect(event).toHaveProperty('type');
+        expect(event).toHaveProperty('description');
       }
     });
   });

packages/crm/src/crm.events.ts

@@ -4,51 +4,43 @@
  * Defines the event contracts for cross-package communication.
  * Other plugins can subscribe to these events to react to CRM domain changes.
  */
+import { EventTypeDefinitionSchema } from '@objectstack/spec/kernel';
 
 export const CRMEvents = {
-  accountCreated: {
+  accountCreated: EventTypeDefinitionSchema.parse({
     name: 'crm.account.created',
-    type: 'domain' as const,
     description: 'Fired when a new account is created',
-  },
-  accountUpdated: {
+  }),
+  accountUpdated: EventTypeDefinitionSchema.parse({
     name: 'crm.account.updated',
-    type: 'domain' as const,
     description: 'Fired when an account record is updated',
-  },
-  contactCreated: {
+  }),
+  contactCreated: EventTypeDefinitionSchema.parse({
     name: 'crm.contact.created',
-    type: 'domain' as const,
     description: 'Fired when a new contact is created',
-  },
-  leadConverted: {
+  }),
+  leadConverted: EventTypeDefinitionSchema.parse({
     name: 'crm.lead.converted',
-    type: 'domain' as const,
     description: 'Fired when a lead is converted to account/contact/opportunity',
-  },
-  leadScored: {
+  }),
+  leadScored: EventTypeDefinitionSchema.parse({
     name: 'crm.lead.scored',
-    type: 'domain' as const,
     description: 'Fired when a lead score is recalculated',
-  },
-  opportunityStageChanged: {
+  }),
+  opportunityStageChanged: EventTypeDefinitionSchema.parse({
     name: 'crm.opportunity.stage_changed',
-    type: 'domain' as const,
     description: 'Fired when an opportunity moves to a new stage',
-  },
-  opportunityWon: {
+  }),
+  opportunityWon: EventTypeDefinitionSchema.parse({
     name: 'crm.opportunity.won',
-    type: 'domain' as const,
     description: 'Fired when an opportunity is closed-won',
-  },
-  opportunityLost: {
+  }),
+  opportunityLost: EventTypeDefinitionSchema.parse({
     name: 'crm.opportunity.lost',
-    type: 'domain' as const,
     description: 'Fired when an opportunity is closed-lost',
-  },
-  activityCompleted: {
+  }),
+  activityCompleted: EventTypeDefinitionSchema.parse({
     name: 'crm.activity.completed',
-    type: 'domain' as const,
     description: 'Fired when an activity or task is marked as completed',
-  },
+  }),
 };

packages/finance/src/finance.events.ts

@@ -4,41 +4,35 @@
  * Defines the event contracts for cross-package communication.
  * Other plugins can subscribe to these events to react to Finance domain changes.
  */
+import { EventTypeDefinitionSchema } from '@objectstack/spec/kernel';
 
 export const FinanceEvents = {
-  invoiceCreated: {
+  invoiceCreated: EventTypeDefinitionSchema.parse({
     name: 'finance.invoice.created',
-    type: 'domain' as const,
     description: 'Fired when a new invoice is created',
-  },
-  invoicePaid: {
+  }),
+  invoicePaid: EventTypeDefinitionSchema.parse({
     name: 'finance.invoice.paid',
-    type: 'domain' as const,
     description: 'Fired when an invoice is fully paid',
-  },
-  invoiceOverdue: {
+  }),
+  invoiceOverdue: EventTypeDefinitionSchema.parse({
     name: 'finance.invoice.overdue',
-    type: 'domain' as const,
     description: 'Fired when an invoice becomes overdue',
-  },
-  paymentReceived: {
+  }),
+  paymentReceived: EventTypeDefinitionSchema.parse({
     name: 'finance.payment.received',
-    type: 'domain' as const,
     description: 'Fired when a payment is received and recorded',
-  },
-  contractActivated: {
+  }),
+  contractActivated: EventTypeDefinitionSchema.parse({
     name: 'finance.contract.activated',
-    type: 'domain' as const,
     description: 'Fired when a contract is activated',
-  },
-  contractRenewed: {
+  }),
+  contractRenewed: EventTypeDefinitionSchema.parse({
     name: 'finance.contract.renewed',
-    type: 'domain' as const,
     description: 'Fired when a contract is renewed',
-  },
-  contractExpiring: {
+  }),
+  contractExpiring: EventTypeDefinitionSchema.parse({
     name: 'finance.contract.expiring',
-    type: 'domain' as const,
     description: 'Fired when a contract is approaching its expiration date',
-  },
+  }),
 };

packages/hr/src/hr.events.ts

@@ -4,41 +4,35 @@
  * Defines the event contracts for cross-package communication.
  * Other plugins can subscribe to these events to react to HR domain changes.
  */
+import { EventTypeDefinitionSchema } from '@objectstack/spec/kernel';
 
 export const HREvents = {
-  employeeOnboarded: {
+  employeeOnboarded: EventTypeDefinitionSchema.parse({
     name: 'hr.employee.onboarded',
-    type: 'domain' as const,
     description: 'Fired when a new employee completes onboarding',
-  },
-  employeeTerminated: {
+  }),
+  employeeTerminated: EventTypeDefinitionSchema.parse({
     name: 'hr.employee.terminated',
-    type: 'domain' as const,
     description: 'Fired when an employee is terminated',
-  },
-  candidateHired: {
+  }),
+  candidateHired: EventTypeDefinitionSchema.parse({
     name: 'hr.candidate.hired',
-    type: 'domain' as const,
     description: 'Fired when a candidate is hired and converted to employee',
-  },
-  offerAccepted: {
+  }),
+  offerAccepted: EventTypeDefinitionSchema.parse({
     name: 'hr.offer.accepted',
-    type: 'domain' as const,
     description: 'Fired when an offer letter is accepted by a candidate',
-  },
-  performanceReviewCompleted: {
+  }),
+  performanceReviewCompleted: EventTypeDefinitionSchema.parse({
     name: 'hr.performance_review.completed',
-    type: 'domain' as const,
     description: 'Fired when a performance review cycle is completed',
-  },
-  timeOffApproved: {
+  }),
+  timeOffApproved: EventTypeDefinitionSchema.parse({
     name: 'hr.time_off.approved',
-    type: 'domain' as const,
     description: 'Fired when a time-off request is approved',
-  },
-  payrollProcessed: {
+  }),
+  payrollProcessed: EventTypeDefinitionSchema.parse({
     name: 'hr.payroll.processed',
-    type: 'domain' as const,
     description: 'Fired when payroll is processed for a pay period',
-  },
+  }),
 };