[WIP] Add examples for currently defined protocols by Copilot · Pull Request #157 · objectstack-ai/framework

Copilot · 2026-01-25T09:27:54Z

Create Examples for Missing Protocol Categories

Analysis Complete

Analyze all 57 protocol schemas across 11 categories
Identify existing examples (only UI protocols have examples)
Understand example structure pattern

Protocols with Examples ✅

Protocols Needing Examples 📝

AI (8 protocols): agent, conversation, cost, model-registry, nlq, orchestration, predictive, rag-pipeline
API (5 protocols): contract, discovery, endpoint, realtime, router
Auth (5 protocols): config, identity, organization, policy, role
Automation (3 protocols): flow, webhook, workflow
Driver (4 protocols): datasource, driver, mongo, postgres
Hub (5 protocols): composer, license, marketplace, space, tenant
Kernel (5 protocols): context, logger, manifest, plugin, scoped-storage
Permission (3 protocols): permission, sharing, territory
System (4 protocols): audit, events, job, translation

Plan

Original prompt

显示目前协议还有哪些需要写例子二级文件夹的方式在examples中写

✨ 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-01-25T09:27:58Z

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

Project	Deployment	Review	Updated (UTC)
spec	Ready	Preview, Comment	Jan 25, 2026 2:31pm

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

xuyushun441-sys · 2026-01-25T10:03:59Z

@copilot 继续

hotlong · 2026-01-25T13:27:51Z

@copilot 继续

github-actions · 2026-01-25T14:19:26Z

This PR is very large. Consider breaking it into smaller PRs for easier review.

Copilot

Pull request overview

This PR adds comprehensive examples for the Data protocol category (8/8 protocols with 158 total examples) and completes the UI protocol examples by adding report and widget examples. The examples follow the established pattern from existing UI examples and demonstrate real-world use cases aligned with industry standards like Salesforce and ServiceNow.

Changes:

Added complete Data protocol examples package with 158 examples covering all 8 data protocols (field, object, query, filter, validation, hook, mapping, dataset)
Added UI protocol examples for Report (12 examples) and Widget (20 examples)
Included comprehensive documentation, package configuration, and TypeScript setup for the new examples package

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
examples/data/metadata-examples/src/field.examples.ts	36 field type examples demonstrating all field types from text to QR codes
examples/data/metadata-examples/src/object.examples.ts	10 complete object definitions for CRM, e-commerce, and project management
examples/data/metadata-examples/src/query.examples.ts	25 query examples from simple selects to complex joins and aggregations
examples/data/metadata-examples/src/filter.examples.ts	27 filter condition examples demonstrating MongoDB-style operators
examples/data/metadata-examples/src/validation.examples.ts	20 validation rule examples covering all validation types
examples/data/metadata-examples/src/hook.examples.ts	20 lifecycle hook examples for data operations
examples/data/metadata-examples/src/mapping.examples.ts	10 ETL mapping examples with one invalid mode value
examples/data/metadata-examples/src/dataset.examples.ts	10 seed data examples for bootstrapping and testing
examples/data/metadata-examples/src/index.ts	Exports all Data protocol examples
examples/data/metadata-examples/package.json	Package configuration for the Data examples
examples/data/metadata-examples/tsconfig.json	TypeScript configuration matching UI examples pattern
examples/data/metadata-examples/README.md	Comprehensive documentation for Data protocol examples
examples/ui/metadata-examples/src/report.examples.ts	12 report examples with incorrect filter format (7 instances)
examples/ui/metadata-examples/src/widget.examples.ts	20 widget prop examples for various field types
examples/ui/metadata-examples/src/index.ts	Updated exports to include report and widget examples
examples/ui/metadata-examples/README.md	Updated documentation listing all UI examples

Copilot · 2026-01-25T14:24:08Z

+  filter: {
+    $and: [
+      { field: 'amount', operator: 'gte', value: 100000 },
+      {
+        $or: [
+          { field: 'stage', operator: 'eq', value: 'Negotiation' },
+          { field: 'stage', operator: 'eq', value: 'Proposal' },
+        ],
+      },
+    ],
+  },
+};


The filter structure is incorrect. Use MongoDB-style operators with $and, $or for logical combinations and field-level operators like $gte for comparisons. For example: { $and: [{ amount: { $gte: 100000 } }, { $or: [{ stage: { $eq: 'Negotiation' } }, { stage: { $eq: 'Proposal' } }] }] }.

Copilot · 2026-01-25T14:24:09Z

+  filter: {
+    field: 'stage',
+    operator: 'eq',
+    value: 'Closed Won',
+  },


The filter structure is incorrect. Use MongoDB-style operators: { stage: { $eq: 'Closed Won' } } instead of { field: 'stage', operator: 'eq', value: 'Closed Won' }.

Copilot · 2026-01-25T14:24:09Z

+  label: 'Migrate Products from Legacy System',
+  sourceFormat: 'json',
+  targetObject: 'product',
+  mode: 'replace',


The mode value 'replace' is not valid for Mapping. According to the MappingSchema in packages/spec/src/data/mapping.zod.ts, the mode field only accepts 'insert', 'update', or 'upsert'. Change this to one of the valid values, likely 'upsert' based on the use case description.

Suggested change

mode: 'replace',

mode: 'upsert',

Copilot · 2026-01-25T14:24:09Z

+      { field: 'stage', operator: 'ne', value: 'Closed Won' },
+      { field: 'stage', operator: 'ne', value: 'Closed Lost' },


The filter structure is incorrect. According to FilterConditionSchema in packages/spec/src/data/filter.zod.ts, filters should use MongoDB-style operators. Instead of using the format { field: 'stage', operator: 'ne', value: 'Closed Won' }, use the correct format: { stage: { $ne: 'Closed Won' } }. This applies to all filter conditions in this file.

Suggested change

{ field: 'stage', operator: 'ne', value: 'Closed Won' },

{ field: 'stage', operator: 'ne', value: 'Closed Lost' },

{ stage: { $ne: 'Closed Won' } },

{ stage: { $ne: 'Closed Lost' } },

Copilot · 2026-01-25T14:24:09Z

+  filter: {
+    field: 'stage',
+    operator: 'eq',
+    value: 'Closed Won',
+  },


The filter structure is incorrect. Use MongoDB-style operators: { stage: { $eq: 'Closed Won' } } instead of { field: 'stage', operator: 'eq', value: 'Closed Won' }.

Copilot · 2026-01-25T14:24:09Z

+  filter: {
+    field: 'stage',
+    operator: 'eq',
+    value: 'Closed Won',
+  },


The filter structure is incorrect. Use MongoDB-style operators: { stage: { $eq: 'Closed Won' } } instead of { field: 'stage', operator: 'eq', value: 'Closed Won' }.

Copilot · 2026-01-25T14:24:10Z

+    field: 'stage',
+    operator: 'eq',
+    value: 'Closed Won',


The filter structure is incorrect. Use MongoDB-style operators: { stage: { $eq: 'Closed Won' } } instead of { field: 'stage', operator: 'eq', value: 'Closed Won' }.

Suggested change

field: 'stage',

operator: 'eq',

value: 'Closed Won',

stage: { $eq: 'Closed Won' },

Copilot · 2026-01-25T14:24:10Z

+    field: 'stage',
+    operator: 'eq',
+    value: 'Closed Won',


The filter structure is incorrect. Use MongoDB-style operators: { stage: { $eq: 'Closed Won' } } instead of { field: 'stage', operator: 'eq', value: 'Closed Won' }.

Suggested change

field: 'stage',

operator: 'eq',

value: 'Closed Won',

stage: {

$eq: 'Closed Won',

},

hotlong · 2026-01-25T14:27:03Z

@copilot fix all

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

Copilot · 2026-01-25T14:29:37Z

@copilot fix all

Fixed all issues in commit 3a3cb89:

Updated all filter structures in report.examples.ts to use MongoDB-style operators ($eq, $ne, $gte, $and, $or)
Changed mapping mode from 'replace' to 'upsert' in mapping.examples.ts
Both packages build successfully

Initial plan

c14bd2f

Copilot AI assigned Copilot and hotlong Jan 25, 2026

Copilot started work on behalf of hotlong January 25, 2026 09:28 View session

Complete UI category examples (add report and widget examples)

940267d

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

vercel bot deployed to Preview January 25, 2026 09:36 View deployment

Add comprehensive Data protocol examples (158 examples across 8 files)

16bad1f

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

vercel bot deployed to Preview January 25, 2026 09:43 View deployment

Copilot finished work on behalf of hotlong January 25, 2026 10:27

Copilot started work on behalf of xuyushun441-sys January 25, 2026 10:27 View session

Copilot finished work on behalf of xuyushun441-sys January 25, 2026 11:26

Copilot started work on behalf of hotlong January 25, 2026 13:28 View session

hotlong approved these changes Jan 25, 2026

View reviewed changes

hotlong marked this pull request as ready for review January 25, 2026 14:19

Copilot AI review requested due to automatic review settings January 25, 2026 14:19

github-actions bot added documentation Improvements or additions to documentation dependencies Pull requests that update a dependency file tooling labels Jan 25, 2026

github-actions bot added the size/xl label Jan 25, 2026

Copilot started reviewing on behalf of hotlong January 25, 2026 14:19 View session

Copilot AI reviewed Jan 25, 2026

View reviewed changes

Copilot finished work on behalf of hotlong January 25, 2026 14:27

Copilot started work on behalf of hotlong January 25, 2026 14:27 View session

Fix filter structures to use MongoDB-style operators and mapping mode

3a3cb89

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

hotlong merged commit 5d6829b into main Jan 25, 2026
1 of 2 checks passed

vercel bot deployed to Preview January 25, 2026 14:31 View deployment

Copilot AI requested a review from hotlong January 25, 2026 14:31

Copilot stopped work on behalf of hotlong due to an error January 25, 2026 14:31
The session was cancelled by the user.

		{ field: 'stage', operator: 'ne', value: 'Closed Won' },
		{ field: 'stage', operator: 'ne', value: 'Closed Lost' },

Conversation

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

Uh oh!

Create Examples for Missing Protocol Categories

Analysis Complete

Protocols with Examples ✅

Protocols Needing Examples 📝

Plan

Uh oh!

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

Uh oh!

Uh oh!

xuyushun441-sys commented Jan 25, 2026

Uh oh!

hotlong commented Jan 25, 2026

Uh oh!

github-actions bot commented Jan 25, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 25, 2026

Choose a reason for hiding this comment

Uh oh!

hotlong commented Jan 25, 2026

Uh oh!

Copilot AI commented Jan 25, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Jan 25, 2026 •

edited

Loading

vercel bot commented Jan 25, 2026 •

edited

Loading