Add missing Field.phone() helper and factory methods for Action/Dashboard/Report by Copilot · Pull Request #15 · objectstack-ai/framework

Copilot · 2026-01-19T11:51:04Z

Fix CRM Example TypeScript Build Errors ✅

Problem: The CRM example has multiple TypeScript compilation errors preventing CI from passing.

Root Causes:

Field.select() signature mismatch - expects string[] but code passes SelectOption[] objects
Missing phone field type helper in Field factory
Action, Dashboard, and Report are only types, not runtime objects with .create() methods

Solution:

Add phone field type helper to Field factory
Update Field.select()/Field.multiselect() to support both old and new API signatures (backward compatible)
Add factory methods (Action.create, Dashboard.create, Report.create) using z.input for proper default handling
Add comprehensive test coverage (12 new tests)
Add JSDoc comments documenting the API
Fix spread order in select/multiselect to avoid option duplication
Security scan: ✅ No vulnerabilities
Code review: ✅ Addressed feedback

Backward Compatibility:

// Old API (still works)
Field.select(['High', 'Low'], { label: 'Priority' })

// New API (now supported)
Field.select({ 
  options: [{label: 'High Priority', value: 'high', color: '#FF0000'}], 
  label: 'Priority' 
})

Test Results: ✅ All 279 tests passing
Build Status: ✅ All packages build successfully (CRM, TODO, docs)
Security: ✅ No vulnerabilities detected

Original prompt

引用: https://github.com/objectstack-ai/spec/actions/runs/21135959933/job/60779299734#step:8:1

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

vercel · 2026-01-19T11:51:49Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Review	Updated (UTC)
spec	Ready	Preview, Comment	Jan 19, 2026 0:12am

- Add phone field type helper to Field factory - Update Field.select/multiselect to support both array and object signatures - Add factory methods (Action.create, Dashboard.create, Report.create) - Use z.input and parse for factory methods to support default values Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Copilot

Pull request overview

This PR fixes TypeScript compilation errors in the CRM example by enhancing the Field factory API and adding factory helper methods for UI components. The changes enable both legacy string-array syntax and new object-based configuration for select fields, while adding missing field type helpers and runtime factory methods.

Changes:

Added phone field type helper and dual-signature support for select/multiselect fields (backward compatible)
Added factory helper methods (Action.create, Dashboard.create, Report.create) with proper type inference using z.input
Restructured documentation metadata hierarchy by moving root: true from parent to child sections

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/spec/src/data/field.zod.ts	Added `phone` helper and refactored `select`/`multiselect` to accept both string arrays and SelectOption objects
packages/spec/src/ui/action.zod.ts	Added `Action.create()` factory method with additional exported types
packages/spec/src/ui/dashboard.zod.ts	Added `Dashboard.create()` factory method with exported widget type
packages/spec/src/ui/report.zod.ts	Added `Report.create()` factory method with additional exported types
content/docs/references/meta.json	Removed `root: true` from parent metadata
content/docs/references/data/meta.json	Added `root: true` to Data Protocol section
content/docs/references/ui/meta.json	Added `root: true` to UI Protocol section
content/docs/references/system/meta.json	Added `root: true` to System Protocol section
content/docs/references/ai/meta.json	Added `root: true` to AI Protocol section

Copilot · 2026-01-19T11:59:26Z

+      finalConfig = optionsOrConfig;
+    }
+
+    return { type: 'select', ...finalConfig, options } as const;


The spread order ...finalConfig, options means that if finalConfig contains an options property, it will be overwritten by the options variable. Consider using options, ...finalConfig to ensure the parsed options take precedence, or explicitly handle the options property separately to avoid confusion.

Fixed in 49030d1. Now extracting options from config object and placing processed options first in spread order to ensure they always take precedence.

Copilot · 2026-01-19T11:59:26Z

+      finalConfig = optionsOrConfig;
+    }
+
+    return { type: 'multiselect', ...finalConfig, options } as const;


The spread order ...finalConfig, options means that if finalConfig contains an options property, it will be overwritten by the options variable. Consider using options, ...finalConfig to ensure the parsed options take precedence, or explicitly handle the options property separately to avoid confusion.

Fixed in 49030d1. Now extracting options from config object and placing processed options first in spread order to ensure they always take precedence.

huangyiirene · 2026-01-19T12:01:02Z

@copilot fix

- Add tests for Field.phone() helper - Add tests for Field.select() backward compatibility (old and new API) - Add tests for Field.multiselect() backward compatibility - Add tests for Action.create() with default value handling - Add tests for Dashboard.create() with default value handling - All 279 tests passing Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Document backward-compatible API with examples for both old and new signatures Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

- Extract options from config object to avoid confusion - Change spread order to options first, then finalConfig - Ensures processed options always take precedence Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Copilot · 2026-01-19T12:11:43Z

@copilot fix

Fixed the spread order issue in select/multiselect field helpers (commit 49030d1). The options property is now extracted from the config object and the processed options array always takes precedence.

Initial plan

e5d98bf

Copilot AI assigned Copilot and huangyiirene Jan 19, 2026

Copilot started work on behalf of huangyiirene January 19, 2026 11:51 View session

vercel Bot deployed to Preview January 19, 2026 11:51 View deployment

huangyiirene approved these changes Jan 19, 2026

View reviewed changes

huangyiirene requested a review from Copilot January 19, 2026 11:58

vercel Bot deployed to Preview January 19, 2026 11:59 View deployment

Copilot AI reviewed Jan 19, 2026

View reviewed changes

vercel Bot deployed to Preview January 19, 2026 12:02 View deployment

Add JSDoc comments for select/multiselect field helpers

95614cd

Document backward-compatible API with examples for both old and new signatures Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

vercel Bot deployed to Preview January 19, 2026 12:06 View deployment

Copilot AI changed the title ~~[WIP] Fix action job step error~~ Add missing Field.phone() helper and factory methods for Action/Dashboard/Report Jan 19, 2026

Copilot finished work on behalf of huangyiirene January 19, 2026 12:08

Copilot AI requested a review from huangyiirene January 19, 2026 12:08

Copilot started work on behalf of huangyiirene January 19, 2026 12:08 View session

vercel Bot deployed to Preview January 19, 2026 12:12 View deployment

Copilot finished work on behalf of huangyiirene January 19, 2026 12:12

huangyiirene approved these changes Jan 19, 2026

View reviewed changes

huangyiirene marked this pull request as ready for review January 19, 2026 12:16

huangyiirene merged commit 8beab63 into copilot/add-crm-functionality-example Jan 19, 2026
2 checks passed

xuyushun441-sys mentioned this pull request May 25, 2026

[P2] config: sort must be nested under options.sort — surprising, no doc example #1317

Open

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add missing Field.phone() helper and factory methods for Action/Dashboard/Report#15

Add missing Field.phone() helper and factory methods for Action/Dashboard/Report#15
huangyiirene merged 5 commits into
copilot/add-crm-functionality-examplefrom
copilot/fix-action-job-step-error

Copilot AI commented Jan 19, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Jan 19, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 19, 2026

Uh oh!

Copilot AI Jan 19, 2026

Uh oh!

Copilot AI Jan 19, 2026

Uh oh!

Copilot AI Jan 19, 2026

Uh oh!

huangyiirene commented Jan 19, 2026

Uh oh!

Copilot AI commented Jan 19, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

Copilot AI commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Fix CRM Example TypeScript Build Errors ✅

Uh oh!

vercel Bot commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

huangyiirene commented Jan 19, 2026

Uh oh!

Copilot AI commented Jan 19, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jan 19, 2026 •

edited

Loading

vercel Bot commented Jan 19, 2026 •

edited

Loading