[WIP] Align sharing, exportOptions, and pagination formats by Copilot · Pull Request #793 · objectstack-ai/objectui

Copilot · 2026-02-23T12:21:59Z

Update Zod validator for sharing to accept spec format (type, lockedBy) alongside ObjectUI format
Update Zod validator for exportOptions to accept spec string[] format alongside ObjectUI object format
Add sharing adapter in spec-bridge list-view.ts to normalize spec format (personal→private, collaborative→team, auto-enable)
Add unit tests for sharing dual-format parsing (types + bridge)
Add unit tests for exportOptions string[] format (types + ListView)
Add unit tests for pageSizeOptions selector rendering, options enumeration, page size change with data reload
Run tests — all 206 tests pass
Update ROADMAP.md with completion status

Original prompt

This section details on the original issue you should resolve

<issue_title>[P2] Sharing/ExportOptions/Pagination 协议对齐</issue_title>
<issue_description>## 背景
Parent Issue: #736

三个属性存在 Spec 与 ObjectUI 的 schema 格式不兼容问题：

sharing：Spec { type: personal/collaborative, lockedBy } vs ObjectUI { visibility, enabled }

exportOptions：Spec string[] vs ObjectUI { formats, maxRecords, includeHeaders, fileNamePrefix }

pagination.pageSizeOptions：类型已定义，需 UI 选择器

目标

三个属性均通过适配层兼容两种格式

pageSizeOptions 渲染 page size 下拉选择器

改动范围

packages/types/src/objectql.ts — sharing 类型 union

packages/plugin-list/src/ListView.tsx — exportOptions normalize + pageSizeOptions UI

packages/react/src/spec-bridge/bridges/list-view.ts — sharing adapter

验收标准

Spec sharing format 可被正确解析

Spec exportOptions: ['csv', 'xlsx'] 格式可正常工作

pageSizeOptions 渲染下拉选择器

选择 page size 后数据重新按新 size 加载

所有新增代码有对应单元测试

pnpm test 全部通过
</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes [P2] Sharing/ExportOptions/Pagination 协议对齐 #750

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

vercel · 2026-02-23T12:22:04Z

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

Project	Deployment	Actions	Updated (UTC)
objectui	Ready	Preview, Comment	Feb 23, 2026 0:47am
objectui-demo	Ready	Preview, Comment	Feb 23, 2026 0:47am
objectui-storybook	Error		Feb 23, 2026 0:47am

- Update Zod validators: sharing accepts type/lockedBy, exportOptions accepts string[] union - Add sharing adapter in spec-bridge: normalize spec format to ObjectUI format - Add comprehensive unit tests for all three features (types, bridge, ListView) - Update ROADMAP.md with completion details Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Copilot

Pull request overview

This PR aligns ObjectUI’s ListView protocol compatibility with @objectstack/spec by accepting dual schema formats for sharing and exportOptions, and adding pagination page-size selector coverage (plus roadmap updates).

Changes:

Extend ListView Zod validation to accept exportOptions as either spec string[] or ObjectUI object, and sharing to include spec { type, lockedBy } fields.
Add spec-bridge normalization for spec sharing.type → ObjectUI visibility and auto-enable sharing.
Add/extend unit tests for sharing, export options, and pagination page size selector behaviors; update ROADMAP.md.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
packages/types/src/zod/objectql.zod.ts	Expands ListView Zod schema to accept spec-compatible `exportOptions` and `sharing` fields.
packages/types/src/tests/p1-spec-alignment.test.ts	Adds “spec alignment” tests for sharing/exportOptions/pagination (currently TS-shape focused).
packages/react/src/spec-bridge/bridges/list-view.ts	Normalizes spec `sharing` into ObjectUI-compatible fields during bridge transform.
packages/react/src/spec-bridge/tests/P1SpecBridge.test.ts	Adds bridge tests for sharing/exportOptions/pagination behavior.
packages/plugin-list/src/tests/ListView.test.tsx	Adds tests for page-size selector behavior and sharing spec-format rendering.
packages/plugin-list/src/tests/Export.test.tsx	Adds test ensuring spec `exportOptions: string[]` renders export formats.
ROADMAP.md	Marks the alignment work as completed and documents the reconciliation behavior.

Copilot · 2026-02-23T12:51:29Z

+    it('should display lockedBy in sharing tooltip when set', () => {
+      const schema: ListViewSchema = {
+        type: 'list-view',
+        objectName: 'contacts',
+        viewType: 'grid',
+        fields: ['name', 'email'],
+        sharing: { type: 'collaborative', lockedBy: 'admin@example.com' },
+      };
+
+      renderWithProvider(<ListView schema={schema} />);
+      const shareButton = screen.getByTestId('share-button');
+      expect(shareButton).toBeInTheDocument();
+      expect(shareButton).toHaveAttribute('title', 'Sharing: collaborative');
+    });


The test name says it should display lockedBy in the sharing tooltip, but the assertion only checks title="Sharing: collaborative" and does not validate lockedBy is shown anywhere. Either update the assertion to check lockedBy is included in the rendered tooltip/title, or rename the test to reflect what it actually verifies.

Copilot · 2026-02-23T12:51:29Z

+  if (spec.sharing) {
+    // Normalize spec sharing format: map type → visibility, set enabled = true
+    const sharing: Record<string, any> = { ...spec.sharing };
+    if (sharing.type && !sharing.visibility) {
+      sharing.visibility = sharing.type === 'collaborative' ? 'team' : 'private';
+    }
+    if (sharing.type && sharing.enabled == null) {
+      sharing.enabled = true;
+    }
+    node.sharing = sharing;
+  }


The spec-bridge currently only normalizes sharing, but it still assigns exportOptions to the resulting object-grid node without adapting the spec string[] format. ObjectGrid expects an object shape (uses schema.exportOptions.formats), so a string[] will cause the requested formats to be ignored (falling back to defaults). Normalize exportOptions in the bridge (e.g., convert ['csv','xlsx'] → { formats: [...] }) before assigning to node.exportOptions.

Copilot · 2026-02-23T12:51:30Z

+    it('should pass through exportOptions string[] format', () => {
+      const bridge = new SpecBridge();
+      const node = bridge.transformListView({
+        name: 'export_spec',
+        exportOptions: ['csv', 'xlsx'],
+      });
+
+      expect(node.exportOptions).toEqual(['csv', 'xlsx']);


This test asserts that exportOptions string[] is passed through unchanged, but bridgeListView returns an object-grid schema where export code expects an object shape with a formats field. Update the test (and bridge behavior) to assert normalization to { formats: [...] }, otherwise the selected formats will be ignored at runtime.

Suggested change

it('should pass through exportOptions string[] format', () => {

const bridge = new SpecBridge();

const node = bridge.transformListView({

name: 'export_spec',

exportOptions: ['csv', 'xlsx'],

});

expect(node.exportOptions).toEqual(['csv', 'xlsx']);

it('should normalize exportOptions string[] format to object with formats', () => {

const bridge = new SpecBridge();

const node = bridge.transformListView({

name: 'export_spec',

exportOptions: ['csv', 'xlsx'],

});

expect(node.exportOptions.formats).toEqual(['csv', 'xlsx']);

Copilot · 2026-02-23T12:51:30Z

+  // P2: Sharing / ExportOptions / Pagination protocol alignment tests
+  it('should accept sharing in spec format { type, lockedBy }', () => {
+    const schema: ListViewSchema = {
+      type: 'list-view',
+      objectName: 'Account',
+      sharing: {
+        type: 'collaborative',
+        lockedBy: 'admin@example.com',
+      },
+    };
+    expect(schema.sharing?.type).toBe('collaborative');
+    expect(schema.sharing?.lockedBy).toBe('admin@example.com');
+  });
+
+  it('should accept sharing in ObjectUI format { visibility, enabled }', () => {
+    const schema: ListViewSchema = {
+      type: 'list-view',
+      objectName: 'Account',
+      sharing: {
+        visibility: 'team',
+        enabled: true,
+      },
+    };
+    expect(schema.sharing?.visibility).toBe('team');
+    expect(schema.sharing?.enabled).toBe(true);
+  });
+
+  it('should accept sharing with both spec and ObjectUI fields merged', () => {
+    const schema: ListViewSchema = {
+      type: 'list-view',
+      objectName: 'Account',
+      sharing: {
+        type: 'personal',
+        visibility: 'private',
+        enabled: true,
+        lockedBy: 'user@example.com',
+      },
+    };
+    expect(schema.sharing?.type).toBe('personal');
+    expect(schema.sharing?.visibility).toBe('private');
+    expect(schema.sharing?.enabled).toBe(true);
+    expect(schema.sharing?.lockedBy).toBe('user@example.com');
+  });
+
+  it('should accept exportOptions as spec string[] format', () => {
+    const schema: ListViewSchema = {
+      type: 'list-view',
+      objectName: 'Account',
+      exportOptions: ['csv', 'xlsx'],
+    };
+    expect(Array.isArray(schema.exportOptions)).toBe(true);
+    expect(schema.exportOptions).toEqual(['csv', 'xlsx']);
+  });
+
+  it('should accept exportOptions as ObjectUI object format', () => {
+    const schema: ListViewSchema = {
+      type: 'list-view',
+      objectName: 'Account',
+      exportOptions: {
+        formats: ['csv', 'json', 'pdf'],
+        maxRecords: 5000,
+        includeHeaders: true,
+        fileNamePrefix: 'accounts_export',
+      },
+    };
+    expect(Array.isArray(schema.exportOptions)).toBe(false);
+    const opts = schema.exportOptions as { formats?: string[]; maxRecords?: number };
+    expect(opts.formats).toEqual(['csv', 'json', 'pdf']);
+    expect(opts.maxRecords).toBe(5000);
+  });
+
+  it('should accept pagination with pageSizeOptions', () => {
+    const schema: ListViewSchema = {
+      type: 'list-view',
+      objectName: 'Account',
+      pagination: {
+        pageSize: 25,
+        pageSizeOptions: [10, 25, 50, 100],
+      },
+    };
+    expect(schema.pagination?.pageSize).toBe(25);
+    expect(schema.pagination?.pageSizeOptions).toEqual([10, 25, 50, 100]);
+  });


These tests only verify that TypeScript accepts the sharing/exportOptions shapes, but they do not exercise the updated Zod validators. Since this PR changes parsing/validation behavior, add assertions using the Zod schemas (e.g. ListViewSchema.safeParse(...)) to confirm both spec and ObjectUI formats are actually accepted at runtime.

Copilot · 2026-02-23T12:51:30Z

+      // Data should be re-fetched with the new page size
+      await vi.waitFor(() => {
+        expect(mockDataSource.find.mock.calls.length).toBeGreaterThan(fetchCountBefore);
+      });


The page-size change test only checks that find() was called again, but it doesn't verify that the new request used the updated page size (e.g. $top: 50). Strengthen the assertion by checking the latest dataSource.find call arguments include the expected $top so the test actually covers the acceptance criteria.

Suggested change

});

});

const lastCall = mockDataSource.find.mock.calls[mockDataSource.find.mock.calls.length - 1];

expect(lastCall[1]).toMatchObject({ $top: 50 });

Initial plan

f2dd28c

Copilot AI assigned Copilot and hotlong Feb 23, 2026

Copilot started work on behalf of hotlong February 23, 2026 12:22 View session

vercel Bot deployed to Preview – objectui-demo February 23, 2026 12:23 View deployment

vercel Bot deployed to Preview – objectui-demo February 23, 2026 12:33 View deployment

vercel Bot had a problem deploying to Preview – objectui-storybook February 23, 2026 12:41 Failure

hotlong marked this pull request as ready for review February 23, 2026 12:45

Copilot AI review requested due to automatic review settings February 23, 2026 12:45

hotlong merged commit 749de6c into main Feb 23, 2026
3 of 5 checks passed

Copilot started reviewing on behalf of hotlong February 23, 2026 12:46 View session

Copilot AI requested a review from hotlong February 23, 2026 12:46

Copilot stopped work on behalf of hotlong due to an error February 23, 2026 12:46
The session was cancelled by the user.

vercel Bot deployed to Preview – objectui February 23, 2026 12:47 View deployment

Copilot AI reviewed Feb 23, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Align sharing, exportOptions, and pagination formats#793

[WIP] Align sharing, exportOptions, and pagination formats#793
hotlong merged 2 commits intomainfrom
copilot/align-sharing-export-options-pagination-again

Copilot AI commented Feb 23, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Feb 23, 2026 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 23, 2026

Uh oh!

Copilot AI Feb 23, 2026

Uh oh!

Copilot AI Feb 23, 2026

Uh oh!

Copilot AI Feb 23, 2026

Uh oh!

Copilot AI Feb 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

-      });
+      });
+      const lastCall = mockDataSource.find.mock.calls[mockDataSource.find.mock.calls.length - 1];
+      expect(lastCall[1]).toMatchObject({ $top: 50 });

Conversation

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

Uh oh!

目标

改动范围

验收标准

Comments on the Issue (you are @copilot in this section)

Uh oh!

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

Uh oh!

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 Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Feb 23, 2026 •

edited

Loading

vercel Bot commented Feb 23, 2026 •

edited

Loading