Patch release 0.7.2: System protocol schemas and documentation by Copilot · Pull Request #444 · objectstack-ai/framework

Copilot · 2026-01-31T10:15:04Z

Prepares patch release 0.7.2 with updated system protocol artifacts.

Changes

JSON Schemas: Generated schemas for system protocols (events, worker, metadata-loader, service-registry, plugin-lifecycle-events, startup-orchestrator)
Documentation: Added reference documentation for system layer protocols, organized by source files
Release artifacts: Changeset for 0.7.2, updated CHANGELOG

Schema updates

New schemas cover:

Event system: Event, EventHandler, EventPersistence, EventBusConfig, EventQueueConfig
Worker/Task: Task, TaskRetryPolicy, WorkerConfig, WorkerStats, BatchTask
Orchestration: MetadataLoader, ServiceRegistry, PluginValidator, StartupOrchestrator

All packages bump to 0.7.2 via changeset. No breaking changes.

Original prompt

发一个补丁

✨ 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-31T10:15:07Z

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

Project	Deployment	Actions	Updated (UTC)
spec	Ready	Preview, Comment	Jan 31, 2026 10:25am

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

github-actions · 2026-01-31T10:36:29Z

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

Copilot

Pull request overview

Prepares the 0.7.2 patch release by adding/generated JSON Schema artifacts for system protocols and updating reference documentation + release metadata.

Changes:

Added/generated JSON Schemas for system protocols (events + worker/task-related schemas).
Refactored several system reference docs into schema-first reference pages and updated navigation.
Added a changeset for patch bumps and updated the root CHANGELOG for 0.7.2.

Reviewed changes

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

Show a summary per file

File	Description
packages/spec/json-schema/system/WorkerStats.json	Adds JSON Schema for worker runtime statistics.
packages/spec/json-schema/system/WorkerConfig.json	Adds JSON Schema for worker configuration (queues, limits, handlers).
packages/spec/json-schema/system/TaskStatus.json	Adds TaskStatus enum JSON Schema.
packages/spec/json-schema/system/TaskRetryPolicy.json	Adds TaskRetryPolicy JSON Schema.
packages/spec/json-schema/system/TaskPriority.json	Adds TaskPriority enum JSON Schema.
packages/spec/json-schema/system/TaskExecutionResult.json	Adds JSON Schema describing task execution results.
packages/spec/json-schema/system/Task.json	Adds JSON Schema for task objects (payload, scheduling, retries).
packages/spec/json-schema/system/RealTimeNotificationConfig.json	Adds JSON Schema for realtime event notification settings.
packages/spec/json-schema/system/QueueConfig.json	Adds JSON Schema for queue configuration (rate limits, autoscale, etc.).
packages/spec/json-schema/system/EventWebhookConfig.json	Adds JSON Schema for event webhooks configuration.
packages/spec/json-schema/system/EventTypeDefinition.json	Adds JSON Schema for event type registry entries.
packages/spec/json-schema/system/EventSourcingConfig.json	Adds JSON Schema for event sourcing settings.
packages/spec/json-schema/system/EventReplayConfig.json	Adds JSON Schema for event replay settings.
packages/spec/json-schema/system/EventQueueConfig.json	Adds JSON Schema for event queue settings.
packages/spec/json-schema/system/EventPriority.json	Adds EventPriority enum JSON Schema.
packages/spec/json-schema/system/EventPersistence.json	Extends persistence schema (adds storage backend enum).
packages/spec/json-schema/system/EventMetadata.json	Extends event metadata schema (correlation/causation/priority).
packages/spec/json-schema/system/EventMessageQueueConfig.json	Adds JSON Schema for MQ publishing integration.
packages/spec/json-schema/system/EventLogEntry.json	Adds JSON Schema for persisted/observed event log entries.
packages/spec/json-schema/system/EventHandler.json	Extends event handler schema (adds id + retry policy).
packages/spec/json-schema/system/EventBusConfig.json	Adds comprehensive JSON Schema for event bus configuration.
packages/spec/json-schema/system/Event.json	Extends event schema (adds id + metadata additions).
packages/spec/json-schema/system/DeadLetterQueueEntry.json	Adds JSON Schema for DLQ entries.
packages/spec/json-schema/system/BatchTask.json	Adds JSON Schema for batch task definitions.
packages/spec/json-schema/system/BatchProgress.json	Adds JSON Schema for batch progress reporting.
content/docs/references/system/startup-orchestrator.mdx	Rewrites doc to schema-focused reference format.
content/docs/references/system/service-registry.mdx	Rewrites doc to schema-focused reference format.
content/docs/references/system/plugin-validator.mdx	Rewrites doc to schema-focused reference format.
content/docs/references/system/plugin-lifecycle-events.mdx	Updates schema-focused reference formatting and expands schema listing.
content/docs/references/system/metadata-loader.mdx	Rewrites doc to schema-focused reference format and expands schema listing.
content/docs/references/system/meta.json	Updates system docs sidebar/navigation entries (adds `worker`).
content/docs/references/system/index.mdx	Updates system docs landing page cards (adds `worker`).
content/docs/references/system/events.mdx	Expands events reference doc with new related schemas and properties.
content/docs/references/integration/meta.json	Removes `connector-file-storage` page from integration docs navigation.
content/docs/references/integration/connector-file-storage.mdx	Deletes the File Storage Connector reference page.
content/docs/references/data/meta.json	Removes `driver-mongo` and `driver-postgres` pages from data docs navigation.
content/docs/references/data/driver-postgres.mdx	Deletes PostgreSQL driver reference page.
content/docs/references/data/driver-mongo.mdx	Deletes MongoDB driver reference page.
content/docs/references/automation/connector.mdx	Updates the Connector reference page source/import paths (currently incorrect).
CHANGELOG.md	Adds 0.7.2 release entry and updates compare links.
.changeset/patch-release.md	Adds patch changeset for version bumps across packages.

Copilot · 2026-01-31T10:47:18Z

 <Callout type="info">
-**Source:** `packages/spec/src/integration/connector.zod.ts`
+**Source:** `packages/spec/src/automation/connector.zod.ts`
 </Callout>

 ## TypeScript Usage

 ```typescript
-import { AuthenticationSchema, ConflictResolutionSchema, ConnectorSchema, DataSyncConfigSchema } from '@objectstack/spec/integration';
-import type { Authentication, ConflictResolution, Connector, DataSyncConfig } from '@objectstack/spec/integration';
+import { AuthenticationSchema, ConflictResolutionSchema, ConnectorSchema, DataSyncConfigSchema } from '@objectstack/spec/automation';
+import type { Authentication, ConflictResolution, Connector, DataSyncConfig } from '@objectstack/spec/automation';


This reference page points to packages/spec/src/automation/connector.zod.ts and imports from @objectstack/spec/automation, but there is no src/automation/connector.zod.ts and automation/index.ts does not export a Connector protocol. The Connector protocol currently lives in packages/spec/src/integration/connector.zod.ts and should be referenced/imported from @objectstack/spec/integration instead (or add the missing automation schema + exports if the move was intended).

Copilot · 2026-01-31T10:47:18Z

+        "durationMs": {
+          "type": "integer",
+          "description": "Execution duration in milliseconds"
+        },


durationMs represents an execution duration, but the schema allows negative values because it has no minimum. Consider adding minimum: 0 (and updating the source Zod schema so regenerated JSON Schema stays in sync).

Copilot · 2026-01-31T10:47:18Z

+---
+"@objectstack/spec": patch
+"@objectstack/core": patch
+"@objectstack/types": patch
+"@objectstack/objectql": patch
+"@objectstack/runtime": patch
+"@objectstack/client": patch


PR description says “All packages bump to 0.7.2 via changeset”, but this changeset does not include @objectstack/metadata (which still exists as a package). Either include it here or adjust the PR description/release plan so versions stay consistent across packages.

Copilot · 2026-01-31T10:47:19Z

  <Card href="./startup-orchestrator" title="Startup Orchestrator" description="Source: packages/spec/src/system/startup-orchestrator.zod.ts" />
  <Card href="./tracing" title="Tracing" description="Source: packages/spec/src/system/tracing.zod.ts" />
  <Card href="./translation" title="Translation" description="Source: packages/spec/src/system/translation.zod.ts" />
+  <Card href="./worker" title="Worker" description="Source: packages/spec/src/system/worker.zod.ts" />


The System docs index now links to a ./worker page, but there is no corresponding content/docs/references/system/worker.mdx in the repo. This will create a broken link in the docs navigation. Add the missing Worker reference page (and ensure it’s included in the build) or remove this card entry.

Suggested change

<Card href="./worker" title="Worker" description="Source: packages/spec/src/system/worker.zod.ts" />

Copilot · 2026-01-31T10:47:19Z

+    "translation",
+    "worker"


"worker" was added to the System docs sidebar pages list, but the content/docs/references/system/worker.mdx page does not exist. This will break the generated navigation/route. Add the missing page or remove this entry.

Suggested change

"translation",

"worker"

"translation"

Initial plan

2186068

Copilot AI assigned Copilot and hotlong Jan 31, 2026

Copilot started work on behalf of hotlong January 31, 2026 10:15 View session

vercel bot deployed to Preview January 31, 2026 10:17 View deployment

Copilot AI and others added 3 commits January 31, 2026 10:18

Initial plan for creating a patch release

6c0dabb

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

Add changeset for patch release 0.7.2

fb41cc0

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

Update CHANGELOG for version 0.7.2 patch release

f77c036

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

Copilot AI changed the title ~~[WIP] Add patch for code updates~~ Patch release 0.7.2: System protocol schemas and documentation Jan 31, 2026

Copilot AI requested a review from hotlong January 31, 2026 10:21

Copilot finished work on behalf of hotlong January 31, 2026 10:21

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

hotlong approved these changes Jan 31, 2026

View reviewed changes

github-actions bot added documentation Improvements or additions to documentation tooling labels Jan 31, 2026

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

hotlong marked this pull request as ready for review January 31, 2026 10:41

Copilot AI review requested due to automatic review settings January 31, 2026 10:41

hotlong merged commit 360bec3 into main Jan 31, 2026
13 checks passed

Copilot started reviewing on behalf of hotlong January 31, 2026 10:42 View session

Copilot AI reviewed Jan 31, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Patch release 0.7.2: System protocol schemas and documentation#444

Patch release 0.7.2: System protocol schemas and documentation#444
hotlong merged 4 commits intomainfrom
copilot/create-patch

Copilot AI commented Jan 31, 2026 •

edited

Loading

Uh oh!

vercel bot commented Jan 31, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Jan 31, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 31, 2026

Uh oh!

Copilot AI Jan 31, 2026

Uh oh!

Copilot AI Jan 31, 2026

Uh oh!

Copilot AI Jan 31, 2026

Uh oh!

Copilot AI Jan 31, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

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

Uh oh!

Changes

Schema updates

Uh oh!

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

Uh oh!

Uh oh!

github-actions bot commented Jan 31, 2026

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 31, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 31, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 31, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 31, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 31, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jan 31, 2026 •

edited

Loading

vercel bot commented Jan 31, 2026 •

edited

Loading