docs(core): fix ComponentRegistry singleton example in README by os-support-ai · Pull Request #5268 · objectstack-ai/objectui

os-support-ai · 2026-08-18T23:17:42Z

What

packages/core/README.md's Component Registry example taught new ComponentRegistry(), but ComponentRegistry is an exported singleton instance, not a class. Built packages/core/dist/registry/Registry.d.ts declares:

exportdeclareconstComponentRegistry: Registry<any>;

The #5138 doc-snippet type gate (scripts/check-doc-snippet-types.mjs) measured this as TS2351: This expression is not constructable. The README ships to npm inside the package's files, so a reader who copied the snippet got a compile error.

Verified against the builtpackages/core/dist/index.d.ts before editing: ComponentRegistry is a const instance and Registry is separately exported as a real class (export declare class Registry< T = any >) — the premise held.

Fix

Dropped the new, call register/get directly on the singleton, and added one line stating it is the process-level shared instance (the part a reader cannot infer from the example) — copied verbatim from the wording packages/components/README.md was given in #5160, so both READMEs stay consistent:

import{ComponentRegistry}from'@object-ui/core'ComponentRegistry.register('button',buttonMetadata)constmetadata=ComponentRegistry.get('button')

UNGATED_DOCS ledger — please read before reviewing the diff

packages/core/README.md has a live entry in scripts/check-doc-snippet-types.mjs's UNGATED_DOCS. Before this change it read:

'5 undefined-name diagnostic(s) — blocks continue an earlier block, or use ambient names the page never defines; plus TS2339x2 TS2351x1 — candidate real defects, un-triaged'

Measured by temporarily un-gating the file and running the gate against the built types, the diagnostics were exactly: TS2351 at line 49 (this card), five TS2304 undefined-name diagnostics, and TS2339x2 at lines 116/121.

This PR fixes only the TS2351. The ledger entry is intentionally NOT deleted — the TS2339x2 pair is a separate, pre-existing defect on the same document and the same ledger line, tracked as out of scope: #5257 (not fixed here, not dispatched at the time this PR was opened). Re-measured after the fix, the entry now reads:

'5 undefined-name diagnostic(s) — blocks continue an earlier block, or use ambient names the page never defines; plus TS2339x2 — candidate real defects, un-triaged'

Only TS2351x1 is dropped from the reason text. A reviewer should read the surviving TS2339x2 clause as expected, not as an incomplete fix on this card — the document is genuinely still ungated because #5257's defects remain, out of scope: #5257.

Verification

Built @object-ui/core's dependency closure plus every package the currently-covered doc snippets import (node scripts/check-doc-snippet-types.mjs --build-filter), then:

node scripts/check-doc-snippet-types.mjs — passes (exit 0); "Every covered documentation snippet compiles against the built types."
Before/after measurement (ledger entry temporarily removed, not committed that way) confirms TS2351 at packages/core/README.md:49 is gone and only the five TS2304 + TS2339x2 (out of scope, core: cloneAsOverride keeps its input's deep-readonly type, so a Tenant/User override clone does not type-check as mutable #5257) remain.
node scripts/check-control-bytes.mjs — passes
node scripts/check-doc-links.mjs — passes ("Links are valid across 13 scan roots.")
node scripts/check-changeset-presence.mjs — passes
node scripts/check-changeset-fixed.mjs — passes
node scripts/check-changeset-no-major.mjs — passes
node scripts/check-doc-component-types.mjs — passes (unaffected, run for completeness)

Diff is surgically narrow — one README snippet + one ledger reason-text line — so #5257 can land on this same file/ledger entry afterward without conflict.

Changeset: @object-ui/core patch (README correction; packages/core is a released package and its README ships in files).

Hard limits observed

No edits to docs/adr/**, .claude/**, skills/**, AGENTS.md, or CLAUDE.md.

Generated by Claude Code

packages/core/README.md's Component Registry snippet taught `new ComponentRegistry()`, but ComponentRegistry is an exported singleton instance, not a class -- packages/core/dist/registry/Registry.d.ts declares `export declare const ComponentRegistry: Registry<any>`. The #5138 doc-snippet type gate measures this as TS2351: This expression is not constructable. README ships to npm inside the package's `files`, so a reader who copied the snippet got a compile error. Drops the `new`, calls ComponentRegistry.register/get directly on the singleton, and adds one line stating it is the process-level shared instance SchemaRenderer resolves every `type` against -- the same wording packages/components/README.md was given in #5160, kept consistent across both READMEs. Updates the UNGATED_DOCS ledger entry for packages/core/README.md in scripts/check-doc-snippet-types.mjs: TS2351x1 is dropped from the reason text now that the diagnostic is gone (measured before/after against the built dist/*.d.ts). The entry is not deleted -- the document's remaining TS2339x2 pair is a separate, pre-existing defect out of scope here, tracked as #5257. Fixes#5258 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RV6yuVCxymHYE16PL9vQkE

github-actions · 2026-08-18T23:21:19Z

✅ Console Performance Budget

Metric	Value	Budget
Main entry (gzip)	25.3 KB	350 KB
Entry file	`index-DGBVb25P.js`	—
Status	PASS	—

📦 Bundle Size Report

Package	Size	Gzipped
app-shell (index.js)	9.83KB	3.70KB
app-shell (runtime-config.js)	7.42KB	2.32KB
app-shell (types.js)	0.01KB	0.04KB
app-shell (urlParams.js)	8.92KB	3.41KB
auth (AuthContext.js)	0.31KB	0.24KB
auth (AuthGuard.js)	1.17KB	0.53KB
auth (AuthProvider.js)	29.33KB	7.05KB
auth (AuthShell.js)	3.49KB	1.40KB
auth (ForgotPasswordForm.js)	12.21KB	3.45KB
auth (LoginForm.js)	18.13KB	5.39KB
auth (PreviewBanner.js)	0.90KB	0.50KB
auth (RegisterForm.js)	6.64KB	2.21KB
auth (SocialSignInButtons.js)	9.60KB	3.89KB
auth (UserMenu.js)	3.40KB	1.22KB
auth (auth-gate-events.js)	1.29KB	0.66KB
auth (authStyles.js)	5.04KB	1.72KB
auth (createAuthClient.js)	40.21KB	10.79KB
auth (createAuthenticatedFetch.js)	6.34KB	2.43KB
auth (index.js)	2.71KB	1.22KB
auth (invitation-status.js)	1.22KB	0.70KB
auth (org-roles.js)	6.66KB	2.78KB
auth (phone-identifier.js)	1.11KB	0.66KB
auth (types.js)	0.59KB	0.35KB
auth (useAuth.js)	5.02KB	0.88KB
auth (useIsWorkspaceAdmin.js)	1.61KB	0.85KB
collaboration (CommentThread.js)	26.07KB	7.56KB
collaboration (LiveCursors.js)	3.17KB	1.27KB
collaboration (PresenceAvatars.js)	6.49KB	2.64KB
collaboration (PresenceProvider.js)	2.79KB	1.13KB
collaboration (index.js)	1.65KB	0.73KB
collaboration (useCollaborationTranslation.js)	6.05KB	2.52KB
collaboration (useCommentSearch.js)	1.98KB	0.88KB
collaboration (useConflictResolution.js)	7.75KB	1.86KB
collaboration (useMentionNotifications.js)	1.81KB	0.68KB
collaboration (usePresence.js)	6.33KB	1.84KB
collaboration (useRealtimeSubscription.js)	7.91KB	2.01KB
components (index.js)	506.17KB	113.33KB
core (index.js)	4.11KB	1.62KB
create-plugin (index.js)	10.08KB	3.26KB
data-objectstack (index.js)	159.03KB	44.08KB
fields (index.js)	237.07KB	59.46KB
i18n (LocalizationContext.js)	1.76KB	0.96KB
i18n (currency.js)	1.22KB	0.64KB
i18n (i18n.js)	4.28KB	1.75KB
i18n (index.js)	3.42KB	1.39KB
i18n (pickLocalized.js)	3.69KB	1.73KB
i18n (provider.js)	23.13KB	7.63KB
i18n (useDisplayLocale.js)	2.85KB	1.45KB
i18n (useObjectLabel.js)	29.43KB	7.15KB
i18n (useSafeTranslation.js)	7.77KB	3.13KB
layout (index.js)	39.16KB	10.97KB
mobile (MobileProvider.js)	0.92KB	0.49KB
mobile (ResponsiveContainer.js)	0.94KB	0.38KB
mobile (breakpoints.js)	1.51KB	0.70KB
mobile (createOfflineDataSource.js)	5.61KB	1.74KB
mobile (index.js)	1.50KB	0.62KB
mobile (offlineQueue.js)	3.91KB	1.35KB
mobile (pwa.js)	0.97KB	0.49KB
mobile (serviceWorker.js)	1.48KB	0.62KB
mobile (serviceWorkerSource.js)	3.41KB	1.48KB
mobile (useBreakpoint.js)	1.54KB	0.65KB
mobile (useGesture.js)	6.96KB	1.98KB
mobile (useOfflineSync.js)	1.99KB	0.72KB
mobile (usePullToRefresh.js)	2.53KB	0.85KB
mobile (useResponsive.js)	0.71KB	0.42KB
mobile (useResponsiveConfig.js)	1.36KB	0.63KB
mobile (useSpecGesture.js)	4.32KB	1.64KB
mobile (useTouchTarget.js)	1.01KB	0.54KB
permissions (MePermissionsProvider.js)	9.35KB	3.31KB
permissions (PermissionContext.js)	0.31KB	0.25KB
permissions (PermissionGuard.js)	0.89KB	0.45KB
permissions (PermissionProvider.js)	4.42KB	1.42KB
permissions (evaluator.js)	5.12KB	1.74KB
permissions (index.js)	0.91KB	0.41KB
permissions (store.js)	0.91KB	0.42KB
permissions (useFieldPermissions.js)	1.28KB	0.52KB
permissions (usePermissions.js)	1.81KB	0.83KB
plugin-ai (index.js)	15.75KB	3.80KB
plugin-calendar (index.js)	46.62KB	12.83KB
plugin-charts (index.js)	64.75KB	18.37KB
plugin-chatbot (index.js)	181.21KB	43.14KB
plugin-dashboard (index.js)	128.04KB	32.75KB
plugin-designer (index.js)	212.39KB	42.83KB
plugin-detail (index.js)	241.46KB	60.56KB
plugin-editor (index.js)	2.46KB	1.10KB
plugin-form (index.js)	123.77KB	30.07KB
plugin-gantt (index.js)	164.10KB	39.87KB
plugin-grid (index.js)	198.22KB	53.27KB
plugin-kanban (index.js)	52.93KB	14.60KB
plugin-list (index.js)	111.66KB	27.13KB
plugin-map (index.js)	19.96KB	6.56KB
plugin-markdown (index.js)	13.72KB	4.69KB
plugin-report (index.js)	42.84KB	11.77KB
plugin-timeline (index.js)	26.68KB	7.66KB
plugin-tree (index.js)	8.50KB	2.88KB
plugin-view (index.js)	84.08KB	20.59KB
providers (DataSourceProvider.js)	0.75KB	0.39KB
providers (MetadataProvider.js)	1.37KB	0.59KB
providers (ThemeProvider.js)	1.90KB	0.85KB
providers (UploadProvider.js)	11.66KB	3.50KB
providers (index.js)	0.44KB	0.22KB
providers (types.js)	0.01KB	0.04KB
react-runtime (index.js)	5.62KB	2.34KB
react (LazyPluginLoader.js)	3.77KB	1.33KB
react (SchemaRenderer.js)	31.56KB	10.70KB
react (data-invalidation.js)	5.05KB	2.08KB
react (index.js)	1.33KB	0.69KB
react (schema-input.js)	1.45KB	0.83KB
react (spec-input.js)	0.20KB	0.18KB
sdui-parser (codegen.js)	5.41KB	2.34KB
sdui-parser (index.js)	4.77KB	2.16KB
sdui-parser (input-type.js)	2.84KB	1.40KB
sdui-parser (parse.js)	10.76KB	3.17KB
sdui-parser (provenance.js)	3.66KB	1.82KB
sdui-parser (types.js)	0.29KB	0.24KB
sdui-parser (validate.js)	6.92KB	2.40KB
types (ai.js)	0.20KB	0.17KB
types (api-types.js)	0.20KB	0.18KB
types (app.js)	2.87KB	0.99KB
types (base.js)	0.20KB	0.18KB
types (blocks.js)	0.20KB	0.18KB
types (complex.js)	0.20KB	0.18KB
types (crud.js)	0.20KB	0.18KB
types (dashboard-filter-alias.js)	6.23KB	2.74KB
types (data-display.js)	0.20KB	0.18KB
types (data-protocol.js)	0.20KB	0.19KB
types (data.js)	0.20KB	0.18KB
types (designer.js)	1.87KB	0.85KB
types (disclosure.js)	0.20KB	0.18KB
types (error-code.js)	1.54KB	0.88KB
types (feedback.js)	0.20KB	0.18KB
types (field-types.js)	0.20KB	0.18KB
types (form.js)	0.20KB	0.18KB
types (http-retry.js)	4.32KB	2.02KB
types (index.js)	3.08KB	1.53KB
types (layout.js)	0.20KB	0.18KB
types (managed-by.js)	0.19KB	0.18KB
types (mobile.js)	2.59KB	1.31KB
types (navigation.js)	0.20KB	0.18KB
types (objectql.js)	0.20KB	0.18KB
types (overlay.js)	0.20KB	0.18KB
types (permissions.js)	0.20KB	0.18KB
types (plugin-scope.js)	0.20KB	0.18KB
types (record-components.js)	0.20KB	0.19KB
types (record-semantics.js)	1.28KB	0.67KB
types (registry.js)	0.20KB	0.18KB
types (reports.js)	0.20KB	0.18KB
types (spec-report.js)	5.05KB	1.93KB
types (system-fields.js)	3.33KB	1.54KB
types (theme.js)	0.20KB	0.18KB
types (ui-action.js)	3.40KB	1.71KB
types (views.js)	0.20KB	0.18KB
types (widget.js)	0.20KB	0.18KB

Size Limits

✅ Core packages should be < 50KB gzipped
✅ Component packages should be < 100KB gzipped
⚠️ Plugin packages should be < 150KB gzipped

github-actionsBot added documentation Improvements or additions to documentation package: core labels Aug 18, 2026

os-support-ai mentioned this pull request Aug 18, 2026
docs: packages/core/README.md teaches new ComponentRegistry(), but ComponentRegistry is an exported singleton instance, not a class #5258
Closed

os-support-ai marked this pull request as ready for review August 18, 2026 23:27

os-support-ai added this pull request to the merge queue Aug 18, 2026

Merged via the queue into main with commit 41f498bAug 18, 2026
22 checks passed

os-support-ai deleted the claude/issue-5258-core-readme-registry-singleton branch August 18, 2026 23:28

Navigation Menu

Uh oh!

docs(core): fix ComponentRegistry singleton example in README - #5268

docs(core): fix ComponentRegistry singleton example in README#5268
os-support-ai merged 1 commit into
mainfrom
claude/issue-5258-core-readme-registry-singleton

os-support-ai commented Aug 18, 2026

Uh oh!

github-actionsBot commented Aug 18, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

os-support-ai commented Aug 18, 2026

What

Fix

UNGATED_DOCS ledger — please read before reviewing the diff

Verification

Hard limits observed

Uh oh!

github-actionsBot commented Aug 18, 2026

✅ Console Performance Budget

📦 Bundle Size Report

Size Limits

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants