Skip to content

docs(releases): v17 checklist — Metadata*Options now come from contracts, not system (#4538) #4569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-zhuang merged 1 commit into from
Aug 2, 2026
+17 −5
Merged

docs(releases): v17 checklist — Metadata*Options now come from contracts, not system (#4538) #4569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/v17-metadata-options-pointer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
---

Releases nothing — docs-only. The v17 upgrade checklist pointed kernel
importers of `MetadataExportOptions` / `MetadataImportOptions` at
`@objectstack/spec/system`; since #4538 deleted the zero-consumer system-side
bags, the correct source is `@objectstack/spec/contracts`. No package ships
from this change.
14 changes: 9 additions & 5 deletions content/docs/releases/v17.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2114,11 +2114,15 @@ covers are folded into the list below rather than left to the changelog.)
- **Type importers:** replace `ObjectStackProtocol` / `ObjectStackProtocolSchema`
with the narrowest per-domain slices; drop GraphQL types and any of the removed
dead spec clusters. If you imported `MetadataFormat`, `MetadataStats`,
`MetadataLoadOptions`, `MetadataSaveOptions`, `MetadataExportOptions`,
`MetadataImportOptions`, `MetadataLoadResult`, `MetadataSaveResult`,
`MetadataWatchEvent`, `MetadataCollectionInfo` or `MetadataLoaderContract`
from `@objectstack/spec/kernel`, change the path to `@objectstack/spec/system`
— same names, and that copy is the one the runtime has always emitted. It is
`MetadataLoadOptions`, `MetadataSaveOptions`, `MetadataLoadResult`,
`MetadataSaveResult`, `MetadataWatchEvent`, `MetadataCollectionInfo` or
`MetadataLoaderContract` from `@objectstack/spec/kernel`, change the path to
`@objectstack/spec/system` — same names, and that copy is the one the runtime
has always emitted. (`MetadataExportOptions` / `MetadataImportOptions` moved
again in #4538: the system-side option bags turned out to have zero consumers
and were deleted, so those two names now come from
`@objectstack/spec/contracts` — the shape `MetadataManager` actually
implements.) It is
the *looser* of the two, so a reader may need new narrowing: notably
`metadataType`/`name`/`timestamp` are optional there. (`MetadataWatchEvent.type`
briefly also declared the raw watcher values `add`/`change`/`unlink`; they had
Expand Down
Loading