Merge pull request #337 from objectstack-ai/copilot/assess-objectstack-schema-compliance

fix: schema compliance audit — fix field type, naming, and label violations across all packages

Author: hotlong

CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Fixed
+- **Schema compliance audit — fix field type, naming, and label violations across all packages** —
+  Evaluated all 142 `*.object.ts` files across 14 packages against the ObjectStack schema specification.
+  Fixed 120+ violations in 40+ files:
+  - **Field type corrections (27 fixes):** Changed `Field.text()` to semantic types (`Field.date()`,
+    `Field.datetime()`, `Field.email()`, `Field.phone()`, `Field.url()`) and `Field.number()` to
+    `Field.currency()` for monetary values in healthcare (7 files), education (6 files), and
+    financial-services (2 files) packages.
+  - **Default value casing (5 fixes):** Lowercased `defaultValue` to match option values per spec
+    (`'New'`→`'new'`, `'Planned'`→`'planned'`, `'CNY'`→`'cny'`, `'USD'`→`'usd'`) in CRM lead,
+    marketing campaign, finance payment, and products pricebook.
+  - **Field naming (3 fixes):** Corrected non-snake_case field names in marketing email_template
+    (`openrate`→`open_rate`, `clickrate`→`click_rate`, `conversionrate`→`conversion_rate`).
+  - **Label capitalization (80+ fixes):** Standardized field labels to Title Case across support
+    (20 files) and products (7 files) packages.
+  - Updated spec-compliance tests in healthcare, education, and financial-services to match
+    corrected field types. All 210 test files (4104 tests) continue to pass.
+  - **Compliant packages (no changes needed):** analytics, community, real-estate, integration, HR, core.
+
 ### Changed
 - **Optimize static file access paths — serve SPA assets directly from Vercel CDN** — Console
   and Studio SPA static assets (JS, CSS, fonts, images) are now copied to `public/console/` and

packages/crm/src/lead.object.ts

@@ -43,7 +43,7 @@ export const Lead = ObjectSchema.create({
     }),
     status: Field.select({
       label: 'Status',
-      defaultValue: 'New',
+      defaultValue: 'new',
       options: [
         { label: 'New', value: 'new' },
         { label: 'Contacted', value: 'contacted' },

packages/education/__tests__/unit/objects/spec-compliance.test.ts

@@ -40,7 +40,7 @@ describe('Student Object Spec Compliance', () => {
     expect(Student.fields.program.type).toBe('text');
     expect(Student.fields.gpa.type).toBe('number');
     expect(Student.fields.advisor_id.type).toBe('lookup');
-    expect(Student.fields.graduation_date.type).toBe('text');
+    expect(Student.fields.graduation_date.type).toBe('date');
     expect(Student.fields.student_id_number.type).toBe('text');
     expect(Student.fields.phone.type).toBe('text');
     expect(Student.fields.major.type).toBe('text');
@@ -110,7 +110,7 @@ describe('Enrollment Object Spec Compliance', () => {
     expect(Enrollment.fields.status.type).toBe('select');
     expect(Enrollment.fields.grade.type).toBe('text');
     expect(Enrollment.fields.credits.type).toBe('number');
-    expect(Enrollment.fields.enrollment_date.type).toBe('text');
+    expect(Enrollment.fields.enrollment_date.type).toBe('date');
   });
 
   it('should have student_id master_detail referencing student', () => {
@@ -239,7 +239,7 @@ describe('Alumni Object Spec Compliance', () => {
     expect(Alumni.fields.job_title.type).toBe('text');
     expect(Alumni.fields.giving_history.type).toBe('number');
     expect(Alumni.fields.engagement_score.type).toBe('number');
-    expect(Alumni.fields.email.type).toBe('text');
+    expect(Alumni.fields.email.type).toBe('email');
     expect(Alumni.fields.location.type).toBe('text');
   });
 
@@ -284,7 +284,7 @@ describe('Scholarship Object Spec Compliance', () => {
     expect(Scholarship.fields.name.type).toBe('text');
     expect(Scholarship.fields.amount.type).toBe('number');
     expect(Scholarship.fields.criteria.type).toBe('textarea');
-    expect(Scholarship.fields.application_deadline.type).toBe('text');
+    expect(Scholarship.fields.application_deadline.type).toBe('date');
     expect(Scholarship.fields.recipients.type).toBe('number');
     expect(Scholarship.fields.fund_balance.type).toBe('number');
     expect(Scholarship.fields.status.type).toBe('select');
@@ -339,16 +339,16 @@ describe('ApplicationForm Object Spec Compliance', () => {
 
   it('should have correct field types', () => {
     expect(ApplicationForm.fields.applicant_name.type).toBe('text');
-    expect(ApplicationForm.fields.email.type).toBe('text');
+    expect(ApplicationForm.fields.email.type).toBe('email');
     expect(ApplicationForm.fields.program.type).toBe('text');
     expect(ApplicationForm.fields.status.type).toBe('select');
     expect(ApplicationForm.fields.test_scores.type).toBe('textarea');
     expect(ApplicationForm.fields.gpa.type).toBe('number');
     expect(ApplicationForm.fields.essays.type).toBe('textarea');
     expect(ApplicationForm.fields.recommendations.type).toBe('number');
     expect(ApplicationForm.fields.decision.type).toBe('select');
-    expect(ApplicationForm.fields.application_date.type).toBe('text');
-    expect(ApplicationForm.fields.decision_date.type).toBe('text');
+    expect(ApplicationForm.fields.application_date.type).toBe('date');
+    expect(ApplicationForm.fields.decision_date.type).toBe('date');
     expect(ApplicationForm.fields.notes.type).toBe('textarea');
   });
 
@@ -410,7 +410,7 @@ describe('CampusEvent Object Spec Compliance', () => {
   it('should have correct field types', () => {
     expect(CampusEvent.fields.name.type).toBe('text');
     expect(CampusEvent.fields.event_type.type).toBe('select');
-    expect(CampusEvent.fields.event_date.type).toBe('text');
+    expect(CampusEvent.fields.event_date.type).toBe('date');
     expect(CampusEvent.fields.location.type).toBe('text');
     expect(CampusEvent.fields.target_audience.type).toBe('select');
     expect(CampusEvent.fields.rsvp_count.type).toBe('number');

packages/education/src/alumni.object.ts

@@ -13,7 +13,7 @@ export const Alumni = ObjectSchema.create({
     job_title: Field.text({ label: 'Job Title' }),
     giving_history: Field.number({ label: 'Lifetime Giving ($)', min: 0, defaultValue: 0 }),
     engagement_score: Field.number({ label: 'Engagement Score', min: 0, max: 100 }),
-    email: Field.text({ label: 'Email' }),
+    email: Field.email({ label: 'Email' }),
     location: Field.text({ label: 'Location' })
   }
 });

packages/education/src/application_form.object.ts

@@ -6,7 +6,7 @@ export const ApplicationForm = ObjectSchema.create({
   icon: 'file-pen',
   fields: {
     applicant_name: Field.text({ label: 'Applicant Name', required: true, maxLength: 255 }),
-    email: Field.text({ label: 'Email', required: true }),
+    email: Field.email({ label: 'Email', required: true }),
     program: Field.text({ label: 'Applied Program', required: true }),
     status: Field.select({
       label: 'Status',
@@ -36,8 +36,8 @@ export const ApplicationForm = ObjectSchema.create({
       ],
       defaultValue: 'pending'
     }),
-    application_date: Field.text({ label: 'Application Date' }),
-    decision_date: Field.text({ label: 'Decision Date' }),
+    application_date: Field.date({ label: 'Application Date' }),
+    decision_date: Field.date({ label: 'Decision Date' }),
     notes: Field.textarea({ label: 'Notes' })
   }
 });

packages/education/src/campus_event.object.ts

@@ -19,7 +19,7 @@ export const CampusEvent = ObjectSchema.create({
         { label: 'Open House', value: 'open_house' }
       ]
     }),
-    event_date: Field.text({ label: 'Event Date', required: true }),
+    event_date: Field.date({ label: 'Event Date', required: true }),
     location: Field.text({ label: 'Location' }),
     target_audience: Field.select({
       label: 'Target Audience',

packages/education/src/enrollment.object.ts

@@ -21,6 +21,6 @@ export const Enrollment = ObjectSchema.create({
     }),
     grade: Field.text({ label: 'Grade' }),
     credits: Field.number({ label: 'Credits', min: 0 }),
-    enrollment_date: Field.text({ label: 'Enrollment Date' })
+    enrollment_date: Field.date({ label: 'Enrollment Date' })
   }
 });

packages/education/src/scholarship.object.ts

@@ -8,7 +8,7 @@ export const Scholarship = ObjectSchema.create({
     name: Field.text({ label: 'Scholarship Name', required: true, maxLength: 255 }),
     amount: Field.number({ label: 'Award Amount', required: true, min: 0 }),
     criteria: Field.textarea({ label: 'Eligibility Criteria', required: true }),
-    application_deadline: Field.text({ label: 'Application Deadline' }),
+    application_deadline: Field.date({ label: 'Application Deadline' }),
     recipients: Field.number({ label: 'Number of Recipients', min: 0, defaultValue: 0 }),
     fund_balance: Field.number({ label: 'Fund Balance', min: 0 }),
     status: Field.select({

packages/education/src/student.object.ts

@@ -23,7 +23,7 @@ export const Student = ObjectSchema.create({
     program: Field.text({ label: 'Program' }),
     gpa: Field.number({ label: 'GPA', min: 0, max: 4 }),
     advisor_id: Field.lookup('contact', { label: 'Academic Advisor' }),
-    graduation_date: Field.text({ label: 'Expected Graduation Date' }),
+    graduation_date: Field.date({ label: 'Expected Graduation Date' }),
     student_id_number: Field.text({ label: 'Student ID', unique: true }),
     phone: Field.text({ label: 'Phone' }),
     major: Field.text({ label: 'Major' }),

packages/finance/src/payment.object.ts

@@ -34,7 +34,7 @@ export const Payment = ObjectSchema.create({
         { label: 'Written Off', value: 'written_off' },
         { label: 'Cancelled', value: 'cancelled' }
       ],
-      defaultValue: 'Planned'
+      defaultValue: 'planned'
     }),
     account: Field.lookup('account', { label: 'Account', required: true }),
     opportunity: Field.lookup('opportunity', { label: 'Related Opportunity' }),