Add missing documentation files for mapping and block schemas by Copilot · Pull Request #353 · objectstack-ai/objectstack

Copilot · 2026-01-28T05:46:07Z

Link checker failing on workflow run 21426667831 due to missing MDX files referenced in index pages.

Changes

content/docs/references/data/mapping.mdx - Documents ETL data mapping schema (field transforms, upsert modes, error policies)
content/docs/references/ui/block.mdx - Documents UI component props map (page/record/nav/AI components)

Both follow existing doc format: frontmatter, TypeScript usage, property tables with types and descriptions.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

https://api.github.com/repos/objectstack-ai/spec/commits/fa54cc1af6ff4a575f4a13a913a1463d3876d607/check-runs
- Triggering command: /usr/bin/curl curl -s -H Authorization: token REDACTED ons lib/rustlib/x86_--eh-frame-hdr lib/rustlib/x86_-m 684c58fe.async_sdirname 684c58fe.async_s/usr/bin/lesspipe 684c58fe.async_s--as-needed 684c58fe.async_s-shared lib/�� 684c58fe.6eb2c2orelro lib/rustlib/x86_-o -1949cf8c6b5b557/tmp/cargo-installtUvwvB/release/deps/libconst_format_proc_macros-2be9e5547ea437/tmp/cargo-installtUvwvB/release/deps/clap_derive-a0906f06c25dcade.clap_derive.6290335fb4afbcdf-cgu.13.rcgu.o ib rlib aea84.rlib b8c66b1.rlib (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

引用: https://github.com/objectstack-ai/spec/actions/runs/21426667831/job/61697032957#step:3:1

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

vercel · 2026-01-28T05:46:12Z

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

Project	Deployment	Review	Updated (UTC)
spec	Ready	Preview, Comment	Jan 28, 2026 5:55am

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Copilot

Pull request overview

This PR adds missing reference documentation for the data mapping protocol and UI block/component props to fix link checker failures and bring them in line with existing reference pages.

Changes:

Added mapping.mdx documenting the ETL Mapping and FieldMapping schemas, including transform types and ETL-related options.
Added block.mdx documenting the UI block/component props map and detailed prop tables for page and record-oriented components.

Reviewed changes

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

File	Description
content/docs/references/data/mapping.mdx	Adds reference docs for `MappingSchema`, `FieldMappingSchema`, and `TransformType` with property tables and usage examples.
content/docs/references/ui/block.mdx	Adds reference docs for `ComponentPropsMap` and the various `Page`/`Record` component prop schemas.

Copilot · 2026-01-28T06:03:02Z

+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **name** | `string` | ✅ | Mapping unique name (lowercase snake_case) |
+| **label** | `string` | optional | Human readable label |
+| **sourceFormat** | `Enum<'csv' \| 'json' \| 'xml' \| 'sql'>` | optional | Source data format (default: 'csv') |
+| **targetObject** | `string` | ✅ | Target Object Name |
+| **fieldMapping** | `object[]` | ✅ | Column Mappings |
+| **mode** | `Enum<'insert' \| 'update' \| 'upsert'>` | optional | Data operation mode (default: 'insert') |
+| **upsertKey** | `string[]` | optional | Fields to match for upsert (e.g. email) |
+| **extractQuery** | `object` | optional | Query to run for export only |


The Mapping properties table currently has || at the beginning of the header and row lines, unlike other reference docs that use a single |, which will cause the table to render incorrectly. Please normalize this to standard Markdown table syntax so the schema properties render properly.

Copilot · 2026-01-28T06:03:02Z

+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **type** | `Enum<'line' \| 'card' \| 'pill'>` | optional | Tab type (default: 'line') |
+| **position** | `Enum<'top' \| 'left'>` | optional | Tab position (default: 'top') |
+| **items** | `object[]` | ✅ | Tab items |
+


The PageTabsProps properties table also uses || at the start of each row instead of a single |, which will break the table formatting in the rendered docs. Update this table to match the standard Markdown table syntax used elsewhere in the reference docs.

Copilot · 2026-01-28T06:03:03Z

+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **label** | `string` | ✅ | Tab label |
+| **icon** | `string` | optional | Tab icon |
+| **children** | `any[]` | ✅ | Child components |


In the Tab Item Properties table, the header and data rows start with || rather than a single |, so the table will not render correctly. Please adjust these rows to use a single leading | to be consistent with the rest of the documentation.

Copilot · 2026-01-28T06:03:03Z

+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **columns** | `Enum<'1' \| '2' \| '3' \| '4'>` | optional | Number of columns (default: '2') |
+| **layout** | `Enum<'auto' \| 'custom'>` | optional | Layout mode (default: 'auto') |
+| **sections** | `string[]` | optional | Section IDs to show (for custom layout) |


For the RecordDetailsProps properties table, each row begins with || instead of a single |, making the table inconsistent with others and potentially invalid Markdown. Please normalize these rows to use a single leading |.

Copilot · 2026-01-28T06:03:03Z

+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **objectName** | `string` | ✅ | Related object name |
+| **relationshipField** | `string` | ✅ | Field on related object that points to this record |
+| **columns** | `string[]` | ✅ | Fields to display |
+| **sort** | `string` | optional | Sort order |
+| **limit** | `number` | optional | Maximum number of records (default: 5) |


The RecordRelatedListProps properties table also has rows starting with || rather than a single |, which will interfere with proper table rendering. Update the header and all data rows here to use a single leading | as in other reference tables.

Copilot · 2026-01-28T06:03:04Z

+```typescript
+import { MappingSchema, FieldMappingSchema, TransformType } from '@objectstack/spec/data';
+import type { Mapping, FieldMapping } from '@objectstack/spec/data';
+
+// Validate data
+const result = MappingSchema.parse(data);
+```


The TypeScript Usage example imports MappingSchema, FieldMappingSchema, TransformType, Mapping, and FieldMapping from @objectstack/spec/data, but packages/spec/src/data/index.ts does not currently re-export mapping.zod.ts, so this import path will fail. Either update the data index to export these symbols or adjust the example to import directly from the mapping.zod module so that the snippet reflects the actual public API.

Copilot · 2026-01-28T06:03:04Z

+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **title** | `string` | ✅ | Page title |
+| **subtitle** | `string` | optional | Page subtitle |
+| **icon** | `string` | optional | Icon name |
+| **breadcrumb** | `boolean` | optional | Show breadcrumb (default: true) |
+| **actions** | `string[]` | optional | Action IDs to show in header |


In the PageHeaderProps properties table, all rows begin with || rather than a single |, which is inconsistent with other docs and will prevent the Markdown table from rendering correctly. Please switch these rows (header, separator, and data) to use a single leading |.

Copilot · 2026-01-28T06:03:04Z

+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **title** | `string` | optional | Card title |
+| **bordered** | `boolean` | optional | Show border (default: true) |
+| **actions** | `string[]` | optional | Action IDs |
+| **children** | `any[]` | ✅ | Card content |


The PageCardProps properties table is using || at the beginning of each row instead of the standard single |, which is likely to break Markdown table rendering. This should be updated to use a single leading | for the header, separator, and all data rows.

Copilot · 2026-01-28T06:03:04Z

+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **source** | `string \| string[]` | ✅ | Source column header(s) |
+| **target** | `string \| string[]` | ✅ | Target object field(s) |
+| **transform** | `Enum<'none' \| 'constant' \| 'lookup' \| 'split' \| 'join' \| 'javascript' \| 'map'>` | optional | Transformation type (default: 'none') |
+| **params** | `object` | optional | Configuration for transform |


In the FieldMapping properties table, each row starts with || instead of the single leading | used elsewhere in the docs, which will prevent this table from rendering correctly as Markdown. Please update the header and data rows here to use a single | so the table formats consistently with other reference pages.

Copilot · 2026-01-28T06:03:05Z

+| Property | Type | Required | Description |
+| :--- | :--- | :--- | :--- |
+| **value** | `any` | optional | Value for constant transform |
+| **object** | `string` | optional | Lookup Object for lookup transform |
+| **fromField** | `string` | optional | Match on field (e.g. "name") for lookup |
+| **toField** | `string` | optional | Value to take (e.g. "_id") for lookup |
+| **autoCreate** | `boolean` | optional | Create if missing for lookup |
+| **valueMap** | `Record<string, any>` | optional | Value mapping for map transform (e.g. { "Open": "draft" }) |
+| **separator** | `string` | optional | Separator for split/join transforms |
+


The Transform Params Properties table also uses || at the start of each row, which is inconsistent with the rest of the documentation and likely breaks table rendering. Align this table with the standard Markdown table syntax by using a single leading | for the header, separator, and data rows.

Initial plan

8bd3729

Copilot AI assigned Copilot and hotlong Jan 28, 2026

Copilot started work on behalf of hotlong January 28, 2026 05:46 View session

Add missing documentation files for mapping and block schemas

fa54cc1

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

vercel Bot had a problem deploying to Preview January 28, 2026 05:54 Failure

Copilot AI changed the title ~~[WIP] Check action run status for better monitoring~~ Add missing documentation files for mapping and block schemas Jan 28, 2026

Copilot AI requested a review from hotlong January 28, 2026 05:58

Copilot finished work on behalf of hotlong January 28, 2026 05:58

hotlong marked this pull request as ready for review January 28, 2026 05:58

Copilot AI review requested due to automatic review settings January 28, 2026 05:58

Copilot started reviewing on behalf of hotlong January 28, 2026 05:58 View session

hotlong merged commit aa54256 into dependabot/npm_and_yarn/production-dependencies-29f96a6100 Jan 28, 2026
5 of 6 checks passed

Copilot AI reviewed Jan 28, 2026

View reviewed changes

Navigation Menu

Repository navigation

Add missing documentation files for mapping and block schemas - #353

Add missing documentation files for mapping and block schemas#353
hotlong merged 2 commits into
dependabot/npm_and_yarn/production-dependencies-29f96a6100from
copilot/check-action-run-status-again

Copilot AI commented Jan 28, 2026 •

edited

Loading

Uh oh!

vercel Bot commented Jan 28, 2026 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

This branch had an error being deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

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

Uh oh!

Changes

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

vercel Bot commented Jan 28, 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 Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

This branch had an error being deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jan 28, 2026 •

edited

Loading

vercel Bot commented Jan 28, 2026 •

edited

Loading