Skip to content

fix(types): one authority for ActionSchema and the Breadcrumb pair#6936

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-sam merged 1 commit into from
Aug 31, 2026
Merged

fix(types): one authority for ActionSchema and the Breadcrumb pair #6936

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
43 changes: 43 additions & 0 deletions .changeset/6349-types-internal-name-collisions-batch-1.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
---
'@object-ui/types': minor
---

Three exported type names inside `@object-ui/types` had two authorities each; each now has
one (objectui#6349, first batch — the three intra-package collisions from the 46-name
census on objectui#6273).

**`ActionSchema` — renamed, because the two shapes are unrelated.** `crud.ts` and
`ui-action.ts` both declared it. Measured member-by-member they share 9 keys out of 28 each:
`crud.ts` `extends BaseSchema` and pins `type: 'action'` (a UI node — a button in a
component tree), `ui-action.ts` extends nothing and types `type` as `ActionType` (a spec-v2
action definition, with `name`, `locations`, `params`, `target`). Re-pointing either at the
other would silently hand a consumer a different type, so this took the rename branch
(objectui#5044 is the precedent for choosing the surviving name). `ui-action.ts`'s
declaration is now spelled **`UIActionSchema`** — the name `src/index.ts` has always
PUBLISHED it under, via `export type { ActionSchema as UIActionSchema }`, which is now a
plain re-export. **The package's public surface is unchanged**: `ActionSchema` still means
`crud.ts`'s legacy shape and `UIActionSchema` still means `ui-action.ts`'s, exactly as
before. Nothing outside `ui-action.ts` imported the old spelling — there is no `./ui-action`
subpath in `exports`, so the old name was never reachable from outside the package.

**`BreadcrumbItem` / `BreadcrumbSchema` — re-pointed, because one copy was stale.** Both
were declared in `data-display.ts` and in `navigation.ts`. The data-display pair was not a
second dialect but a strict SUBSET: no key declared differently on either side, and missing
`BreadcrumbItem.icon` / `onClick` / `siblings` and `BreadcrumbSchema.maxItems`. Everything
that reads a breadcrumb was already on the navigation declaration — `registry.ts` maps the
`'breadcrumb'` component type to it, `src/index.ts` re-exports it under the bare names,
`zod/navigation.zod.ts` mirrors it (`icon`, `onClick`, `siblings`, `maxItems` included), the
`ui:breadcrumb` renderer consumes it, and the component's own documentation page documents
`icon` and `maxItems`. `data-display.ts` now re-exports the one authority.

**What changes for a consumer.** The `@object-ui/types/data-display` subpath is published, so
its `BreadcrumbItem` / `BreadcrumbSchema` and the `DataDisplaySchema` union's breadcrumb
member widen to the navigation declaration — they gain the four keys above. Nothing narrows
and no key changes type, so every value that type-checked before still does; what the subpath
now declares is what the renderer already honoured and the docs already described. Graded
`minor` because a published `.d.ts` member changes shape, per this repo's version-alignment
rule (never `major`).

The three `KNOWN_COLLISIONS` lines came down in the same change; that baseline
(`scripts/__tests__/one-authority-per-exported-name-6273.test.ts`) is shrink-only and fails in
both directions, so converging without deleting them would have been red too. 43 entries → 40.
48 changes: 21 additions & 27 deletions packages/types/src/data-display.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@

import type { ChartType as SpecChartType } from '@objectstack/spec/ui';
import type { BaseSchema, SchemaNode } from './base.js';
import type { BreadcrumbSchema } from './navigation.js';

/**
* Alert component
Expand DownExpand Up@@ -1644,34 +1645,27 @@ export interface TimelineSchema extends BaseSchema {
}

/**
* Breadcrumb item
*/
export interface BreadcrumbItem {
/**
* Item label
*/
label: string;
/**
* Item href/link
*/
href?: string;
}

/**
* Breadcrumb component
* Breadcrumb — ONE authority, and it lives in `./navigation.ts`.
*
* This module declared its own `BreadcrumbItem` / `BreadcrumbSchema` until
* objectui#6349. They were not a second dialect, they were a stale COPY: a
* strict subset of the navigation declarations, missing `BreadcrumbItem.icon` /
* `onClick` / `siblings` and `BreadcrumbSchema.maxItems`, with no key declared
* differently on either side. Everything that actually reads a breadcrumb was
* already on the navigation declaration — `registry.ts` maps the `'breadcrumb'`
* component type to it, `packages/types/src/index.ts` re-exports it under the
* bare names, `zod/navigation.zod.ts` mirrors it, and
* `content/docs/components/data-display/breadcrumb.mdx` documents `icon` and
* `maxItems` on THIS page. The copy's only reach was the
* `@object-ui/types/data-display` subpath and the {@link DataDisplaySchema}
* union below, both of which under-declared what the renderer honours.
*
* A re-export is one declaration with a second export site, which is exactly
* how this monorepo is meant to fan a type out; the recurrence guard
* (`scripts/__tests__/one-authority-per-exported-name-6273.test.ts`) does not
* count it. 2026-08-25 family ruling, objectui#6172 decision 甲/A1.
*/
export interface BreadcrumbSchema extends BaseSchema {
type: 'breadcrumb';
/**
* Breadcrumb items
*/
items: BreadcrumbItem[];
/**
* Separator character
* @default '/'
*/
separator?: string;
}
export type { BreadcrumbItem, BreadcrumbSchema } from './navigation.js';

/**
* Keyboard key component
Expand Down
2 changes: 1 addition & 1 deletion packages/types/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1034,7 +1034,7 @@ export type {
ObjectUiLocalParamFieldType,
ResolvableParamFieldType,
ActionParam,
ActionSchema as UIActionSchema,
UIActionSchema,
ActionGroup,
ActionContext,
ActionResult,
Expand Down
30 changes: 21 additions & 9 deletions packages/types/src/ui-action.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -367,11 +367,23 @@ export interface ActionParam

/**
* Enhanced Action Schema (ObjectStack Spec v2.0.1)
*
* This is the primary action schema that should be used for all new implementations.
* The legacy ActionSchema in crud.ts is maintained for backward compatibility.
*
* This is the primary action schema that should be used for all new
* implementations. The legacy `ActionSchema` in `crud.ts` is maintained for
* backward compatibility.
*
* ⚠️ Named `UIActionSchema`, which is the name `packages/types/src/index.ts`
* has always PUBLISHED it under. It was declared as `ActionSchema` until
* objectui#6349 — a second authority for a name `crud.ts` also declares, so an
* IDE auto-import picked between two structurally unrelated types (9 shared
* keys out of 28 each; `type` is the literal `'action'` there and
* {@link ActionType} here) and the wrong pick surfaced as a remote `TS2322`.
* The declaration now spells the published name; nothing outside this file
* imported the old one, so the package's public surface is unchanged. See the
* 2026-08-25 family ruling (objectui#6172, decision 甲/A1) and the recurrence
* guard `scripts/__tests__/one-authority-per-exported-name-6273.test.ts`.
*/
export interface ActionSchema {
export interface UIActionSchema {
/** Unique action identifier (snake_case) */
name: string;

Expand DownExpand Up@@ -472,7 +484,7 @@ export interface ActionSchema {
* `inline-action-api-params-to-body-extra` conversion (ADR-0087 D2).
*
* Declared here so the action renderers can forward it off a typed
* `ActionSchema` rather than through an `as any` cast — the renderers are the
* `UIActionSchema` rather than through an `as any` cast — the renderers are the
* consumers this field exists for (objectstack#6837). Typed off the spec
* rather than restated, so the shape cannot drift from the contract.
*/
Expand All@@ -491,7 +503,7 @@ export interface ActionSchema {
* exactly that, so the key has one meaning everywhere it is honoured.
*
* Declared here for the same reason as {@link bodyExtra}: the action
* renderers forward it off a typed `ActionSchema` instead of an `as any`
* renderers forward it off a typed `UIActionSchema` instead of an `as any`
* cast, and dropping it from those whitelists is what made a declared wrap
* degrade silently to a flat body (objectstack#6938). Typed by derivation
* from the spec so the union cannot drift from the contract.
Expand DownExpand Up@@ -583,7 +595,7 @@ export interface ActionGroup {
icon?: string;

/** Actions in this group */
actions: ActionSchema[];
actions: UIActionSchema[];

/** Group visibility condition */
visible?: string;
Expand DownExpand Up@@ -637,7 +649,7 @@ export interface ActionResult {
* Action executor function type
*/
export type ActionExecutor = (
action: ActionSchema,
action: UIActionSchema,
context: ActionContext,
params?: Record<string, any>
) => Promise<ActionResult>;
Expand DownExpand Up@@ -698,7 +710,7 @@ export interface TransactionConfig {
/** Timeout in milliseconds */
timeout?: number;
/** Actions to execute within the transaction */
actions: ActionSchema[];
actions: UIActionSchema[];
/** Rollback action on failure */
rollbackAction?: string;
/** Whether to auto-retry on conflict */
Expand Down
6 changes: 3 additions & 3 deletions scripts/__tests__/check-action-forward-parity.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,7 +98,7 @@ function repoWith(
files: {
[UI_VIEW]:
overrides.view ??
'export interface ActionSchema {\n name?: string;\n description?: string;\n}\n',
'export interface UIActionSchema {\n name?: string;\n description?: string;\n}\n',
[KEYS_MODULE]:
overrides.keys ?? "export const RETIRED_ACTION_KEYS = {\n execute: 'renamed to target',\n};\n",
[CONSUMER]:
Expand DownExpand Up@@ -388,7 +388,7 @@ describe('extraction failure throws rather than returning a clean verdict', () =
});

it('a renderer view with no properties is red', () => {
expect(() => judge(repoWith('{ target }', { view: 'export interface ActionSchema {}\n' }))).toThrow(
expect(() => judge(repoWith('{ target }', { view: 'export interface UIActionSchema {}\n' }))).toThrow(
/declares no properties/,
);
});
Expand All@@ -409,7 +409,7 @@ describe('extraction failure throws rather than returning a clean verdict', () =
// Authorable and runtime-read do not intersect at all: nothing would ever be
// checked for this surface again.
expect(() =>
judge(repoWith('{ target }', { view: 'export interface ActionSchema {\n nothingReadsThis?: string;\n}\n' }), {
judge(repoWith('{ target }', { view: 'export interface UIActionSchema {\n nothingReadsThis?: string;\n}\n' }), {
spec: { declared: ['norThis'], inline: [] },
}),
).toThrow(/owed set is empty/);
Expand Down
12 changes: 9 additions & 3 deletions scripts/__tests__/one-authority-per-exported-name-6273.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -349,11 +349,17 @@ const filesOf = (sites: readonly Located[]): string[] => [
const KNOWN_COLLISIONS: ReadonlyMap<string, readonly string[]> = new Map([
['ActionContext', ['packages/core/src/actions/ActionRunner.ts', 'packages/types/src/ui-action.ts']],
['ActionResult', ['packages/core/src/actions/ActionRunner.ts', 'packages/types/src/ui-action.ts']],
['ActionSchema', ['packages/types/src/crud.ts', 'packages/types/src/ui-action.ts']],
['AggregationConfig', ['packages/plugin-grid/src/useGroupedData.ts', 'packages/types/src/data-protocol.ts']],
['AppShellProps', ['packages/app-shell/src/types.ts', 'packages/layout/src/AppShell.tsx']],
['BreadcrumbItem', ['packages/types/src/data-display.ts', 'packages/types/src/navigation.ts']],
['BreadcrumbSchema', ['packages/types/src/data-display.ts', 'packages/types/src/navigation.ts']],
// `ActionSchema` sat here, colliding between `packages/types/src/crud.ts` and
// `packages/types/src/ui-action.ts`. Structurally unrelated types — 28 members
// each, 9 shared, `type` the literal `'action'` there and `ActionType` here — so
// the remedy was the RENAME branch: ui-action's declaration now spells
// `UIActionSchema`, the name `src/index.ts` always published it under
// (objectui#6349). `BreadcrumbItem` / `BreadcrumbSchema` sat here too, colliding
// between `packages/types/src/data-display.ts` and
// `packages/types/src/navigation.ts`; data-display's were a strict SUBSET copy, so
// that file re-points at navigation's one authority.
['CalendarEvent', ['packages/plugin-calendar/src/index.tsx', 'packages/types/src/complex.ts']], // the ruled-on objectui#5044 alias — see the header
['CalendarSchema', ['packages/plugin-calendar/src/ObjectCalendar.tsx', 'packages/types/src/form.ts']],
['ChatMessage', ['packages/plugin-chatbot/src/ChatbotEnhanced.tsx', 'packages/types/src/complex.ts']],
Expand Down
13 changes: 9 additions & 4 deletions scripts/check-action-forward-parity.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -392,7 +392,12 @@ export function loadSpecSchemas(require = createRequire(import.meta.url)) {
}

/**
* `@object-ui/types`' renderer VIEW of an action.
* `@object-ui/types`' renderer VIEW of an action — `interface UIActionSchema`.
*
* ⚠️ It was `interface ActionSchema` until objectui#6349, a second authority for
* a name `packages/types/src/crud.ts` also declares. The declaration now spells
* the name the package always PUBLISHED it under (`UIActionSchema`); the type
* and the file are unchanged.
*
* Declared surfaces are typed against this, not against the spec schema
* directly — it carries renderer-only fields the spec does not model
Expand All@@ -408,16 +413,16 @@ export function uiActionViewKeys(root, file = UI_ACTION_VIEW) {
}
const sf = parse(root, file);
for (const stmt of sf.statements) {
if (!ts.isInterfaceDeclaration(stmt) || stmt.name.text !== "ActionSchema") continue;
if (!ts.isInterfaceDeclaration(stmt) || stmt.name.text !== "UIActionSchema") continue;
const keys = stmt.members
.filter(ts.isPropertySignature)
.map((m) => (m.name && (ts.isIdentifier(m.name) || ts.isStringLiteral(m.name)) ? m.name.text : null))
.filter((n) => n !== null);
if (keys.length === 0) fail(`\`ActionSchema\` in ${file} declares no properties — extraction failed.`);
if (keys.length === 0) fail(`\`UIActionSchema\` in ${file} declares no properties — extraction failed.`);
return keys;
}
fail(
`\`interface ActionSchema\` not found in ${file}.\n` +
`\`interface UIActionSchema\` not found in ${file}.\n` +
" The renderer view moved or was renamed; re-point this gate at it."
);
}
Expand Down
13 changes: 8 additions & 5 deletions scripts/check-spec-symbol-derivation.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -243,11 +243,14 @@ const root = resolve(dirname(fileURLToPath(import.meta.url)), "..");
const ALLOW = {
"@object-ui/types:ActionSchema": {
reason:
"Two deliberate objectui-side shapes, both documented at their declaration. " +
"`ui-action.ts` is a renderer VIEW over the spec's action — it carries renderer-only " +
"fields the spec does not model, while importing the spec-owned parts it does share " +
"(`ActionLocation`, `ActionType`). `crud.ts` is the explicitly @deprecated legacy " +
"shape kept for backward compatibility and slated for removal in a future major.",
"`crud.ts`'s explicitly @deprecated legacy action shape, kept for backward " +
"compatibility and slated for removal in a future major. ⚠️ This entry covered TWO " +
"objectui-side shapes until objectui#6349: `ui-action.ts` declared a same-named " +
"renderer VIEW over the spec's action (renderer-only fields the spec does not model, " +
"importing the spec-owned parts it shares — `ActionLocation`, `ActionType`). That one " +
"is now declared as `UIActionSchema`, the name the package always published it under, " +
"so it no longer shadows a spec export and no longer needs excusing here. This entry " +
"stays because `crud.ts` still carries the name.",
issue: 4115,
},
"@object-ui/types:FormField": {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(types): one authority for `ActionSchema` and the Breadcrumb pair by os-sam · Pull Request #6936 · objectstack-ai/objectui · GitHub
Skip to content
fix(types): one authority for ActionSchema and the Breadcrumb pair#6936

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-sam
merged 1 commit into

from

Aug 31, 2026
 Merged


fix(types): one authority for ActionSchema and the Breadcrumb pair
#6936
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


43 changes: 43 additions & 0 deletions
.changeset/6349-types-internal-name-collisions-batch-1.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
---
'@object-ui/types': minor
---

Three exported type names inside `@object-ui/types` had two authorities each; each now has
one (objectui#6349, first batch — the three intra-package collisions from the 46-name
census on objectui#6273).

**`ActionSchema` — renamed, because the two shapes are unrelated.** `crud.ts` and
`ui-action.ts` both declared it. Measured member-by-member they share 9 keys out of 28 each:
`crud.ts` `extends BaseSchema` and pins `type: 'action'` (a UI node — a button in a
component tree), `ui-action.ts` extends nothing and types `type` as `ActionType` (a spec-v2
action definition, with `name`, `locations`, `params`, `target`). Re-pointing either at the
other would silently hand a consumer a different type, so this took the rename branch
(objectui#5044 is the precedent for choosing the surviving name). `ui-action.ts`'s
declaration is now spelled **`UIActionSchema`** — the name `src/index.ts` has always
PUBLISHED it under, via `export type { ActionSchema as UIActionSchema }`, which is now a
plain re-export. **The package's public surface is unchanged**: `ActionSchema` still means
`crud.ts`'s legacy shape and `UIActionSchema` still means `ui-action.ts`'s, exactly as
before. Nothing outside `ui-action.ts` imported the old spelling — there is no `./ui-action`
subpath in `exports`, so the old name was never reachable from outside the package.

**`BreadcrumbItem` / `BreadcrumbSchema` — re-pointed, because one copy was stale.** Both
were declared in `data-display.ts` and in `navigation.ts`. The data-display pair was not a
second dialect but a strict SUBSET: no key declared differently on either side, and missing
`BreadcrumbItem.icon` / `onClick` / `siblings` and `BreadcrumbSchema.maxItems`. Everything
that reads a breadcrumb was already on the navigation declaration — `registry.ts` maps the
`'breadcrumb'` component type to it, `src/index.ts` re-exports it under the bare names,
`zod/navigation.zod.ts` mirrors it (`icon`, `onClick`, `siblings`, `maxItems` included), the
`ui:breadcrumb` renderer consumes it, and the component's own documentation page documents
`icon` and `maxItems`. `data-display.ts` now re-exports the one authority.

**What changes for a consumer.** The `@object-ui/types/data-display` subpath is published, so
its `BreadcrumbItem` / `BreadcrumbSchema` and the `DataDisplaySchema` union's breadcrumb
member widen to the navigation declaration — they gain the four keys above. Nothing narrows
and no key changes type, so every value that type-checked before still does; what the subpath
now declares is what the renderer already honoured and the docs already described. Graded
`minor` because a published `.d.ts` member changes shape, per this repo's version-alignment
rule (never `major`).

The three `KNOWN_COLLISIONS` lines came down in the same change; that baseline
(`scripts/__tests__/one-authority-per-exported-name-6273.test.ts`) is shrink-only and fails in
both directions, so converging without deleting them would have been red too. 43 entries → 40.

48 changes: 21 additions & 27 deletions
packages/types/src/data-display.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@

import type { ChartType as SpecChartType } from '@objectstack/spec/ui';
import type { BaseSchema, SchemaNode } from './base.js';
import type { BreadcrumbSchema } from './navigation.js';

/**
 * Alert component
Expand DownExpand Up@@ -1644,34 +1645,27 @@ export interface TimelineSchema extends BaseSchema {
}

/**
 * Breadcrumb item
 */
export interface BreadcrumbItem {
 /**
 * Item label
 */
 label: string;
 /**
 * Item href/link
 */
 href?: string;
}

/**
 * Breadcrumb component
 * Breadcrumb — ONE authority, and it lives in `./navigation.ts`.
 *
 * This module declared its own `BreadcrumbItem` / `BreadcrumbSchema` until
 * objectui#6349. They were not a second dialect, they were a stale COPY: a
 * strict subset of the navigation declarations, missing `BreadcrumbItem.icon` /
 * `onClick` / `siblings` and `BreadcrumbSchema.maxItems`, with no key declared
 * differently on either side. Everything that actually reads a breadcrumb was
 * already on the navigation declaration — `registry.ts` maps the `'breadcrumb'`
 * component type to it, `packages/types/src/index.ts` re-exports it under the
 * bare names, `zod/navigation.zod.ts` mirrors it, and
 * `content/docs/components/data-display/breadcrumb.mdx` documents `icon` and
 * `maxItems` on THIS page. The copy's only reach was the
 * `@object-ui/types/data-display` subpath and the {@link DataDisplaySchema}
 * union below, both of which under-declared what the renderer honours.
 *
 * A re-export is one declaration with a second export site, which is exactly
 * how this monorepo is meant to fan a type out; the recurrence guard
 * (`scripts/__tests__/one-authority-per-exported-name-6273.test.ts`) does not
 * count it. 2026-08-25 family ruling, objectui#6172 decision 甲/A1.
 */
export interface BreadcrumbSchema extends BaseSchema {
 type: 'breadcrumb';
 /**
 * Breadcrumb items
 */
 items: BreadcrumbItem[];
 /**
 * Separator character
 * @default '/'
 */
 separator?: string;
}
export type { BreadcrumbItem, BreadcrumbSchema } from './navigation.js';

/**
 * Keyboard key component
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1034,7 +1034,7 @@ export type {
 ObjectUiLocalParamFieldType,
 ResolvableParamFieldType,
 ActionParam,
ActionSchema as UIActionSchema,
 UIActionSchema,
 ActionGroup,
 ActionContext,
 ActionResult,
Expand Down

30 changes: 21 additions & 9 deletions
packages/types/src/ui-action.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,11 +367,23 @@ export interface ActionParam

/**
 * Enhanced Action Schema (ObjectStack Spec v2.0.1)
 * 
 * This is the primary action schema that should be used for all new implementations.
 * The legacy ActionSchema in crud.ts is maintained for backward compatibility.
 *
 * This is the primary action schema that should be used for all new
 * implementations. The legacy `ActionSchema` in `crud.ts` is maintained for
 * backward compatibility.
 *
 * ⚠️ Named `UIActionSchema`, which is the name `packages/types/src/index.ts`
 * has always PUBLISHED it under. It was declared as `ActionSchema` until
 * objectui#6349 — a second authority for a name `crud.ts` also declares, so an
 * IDE auto-import picked between two structurally unrelated types (9 shared
 * keys out of 28 each; `type` is the literal `'action'` there and
 * {@link ActionType} here) and the wrong pick surfaced as a remote `TS2322`.
 * The declaration now spells the published name; nothing outside this file
 * imported the old one, so the package's public surface is unchanged. See the
 * 2026-08-25 family ruling (objectui#6172, decision 甲/A1) and the recurrence
 * guard `scripts/__tests__/one-authority-per-exported-name-6273.test.ts`.
 */
export interface ActionSchema {
export interface UIActionSchema {
 /** Unique action identifier (snake_case) */
 name: string;

Expand DownExpand Up@@ -472,7 +484,7 @@ export interface ActionSchema {
 * `inline-action-api-params-to-body-extra` conversion (ADR-0087 D2).
 *
 * Declared here so the action renderers can forward it off a typed
 * `ActionSchema` rather than through an `as any` cast — the renderers are the
 * `UIActionSchema` rather than through an `as any` cast — the renderers are the
 * consumers this field exists for (objectstack#6837). Typed off the spec
 * rather than restated, so the shape cannot drift from the contract.
 */
Expand All@@ -491,7 +503,7 @@ export interface ActionSchema {
 * exactly that, so the key has one meaning everywhere it is honoured.
 *
 * Declared here for the same reason as {@link bodyExtra}: the action
 * renderers forward it off a typed `ActionSchema` instead of an `as any`
 * renderers forward it off a typed `UIActionSchema` instead of an `as any`
 * cast, and dropping it from those whitelists is what made a declared wrap
 * degrade silently to a flat body (objectstack#6938). Typed by derivation
 * from the spec so the union cannot drift from the contract.
Expand DownExpand Up@@ -583,7 +595,7 @@ export interface ActionGroup {
 icon?: string;

 /** Actions in this group */
 actions: ActionSchema[];
 actions: UIActionSchema[];

 /** Group visibility condition */
 visible?: string;
Expand DownExpand Up@@ -637,7 +649,7 @@ export interface ActionResult {
 * Action executor function type
 */
export type ActionExecutor = (
 action: ActionSchema,
 action: UIActionSchema,
 context: ActionContext,
 params?: Record<string, any>
) => Promise<ActionResult>;
Expand DownExpand Up@@ -698,7 +710,7 @@ export interface TransactionConfig {
 /** Timeout in milliseconds */
 timeout?: number;
 /** Actions to execute within the transaction */
 actions: ActionSchema[];
 actions: UIActionSchema[];
 /** Rollback action on failure */
 rollbackAction?: string;
 /** Whether to auto-retry on conflict */
Expand Down

6 changes: 3 additions & 3 deletions
scripts/__tests__/check-action-forward-parity.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,7 +98,7 @@ function repoWith(
 files: {
 [UI_VIEW]:
 overrides.view ??
 'export interface ActionSchema {\n name?: string;\n description?: string;\n}\n',
 'export interface UIActionSchema {\n name?: string;\n description?: string;\n}\n',
 [KEYS_MODULE]:
 overrides.keys ?? "export const RETIRED_ACTION_KEYS = {\n execute: 'renamed to target',\n};\n",
 [CONSUMER]:
Expand DownExpand Up@@ -388,7 +388,7 @@ describe('extraction failure throws rather than returning a clean verdict', () =
 });

 it('a renderer view with no properties is red', () => {
 expect(() => judge(repoWith('{ target }', { view: 'export interface ActionSchema {}\n' }))).toThrow(
 expect(() => judge(repoWith('{ target }', { view: 'export interface UIActionSchema {}\n' }))).toThrow(
 /declares no properties/,
 );
 });
Expand All@@ -409,7 +409,7 @@ describe('extraction failure throws rather than returning a clean verdict', () =
 // Authorable and runtime-read do not intersect at all: nothing would ever be
 // checked for this surface again.
 expect(() =>
 judge(repoWith('{ target }', { view: 'export interface ActionSchema {\n nothingReadsThis?: string;\n}\n' }), {
 judge(repoWith('{ target }', { view: 'export interface UIActionSchema {\n nothingReadsThis?: string;\n}\n' }), {
 spec: { declared: ['norThis'], inline: [] },
 }),
 ).toThrow(/owed set is empty/);
Expand Down

12 changes: 9 additions & 3 deletions
scripts/__tests__/one-authority-per-exported-name-6273.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -349,11 +349,17 @@ const filesOf = (sites: readonly Located[]): string[] => [
const KNOWN_COLLISIONS: ReadonlyMap<string, readonly string[]> = new Map([
 ['ActionContext', ['packages/core/src/actions/ActionRunner.ts', 'packages/types/src/ui-action.ts']],
 ['ActionResult', ['packages/core/src/actions/ActionRunner.ts', 'packages/types/src/ui-action.ts']],
 ['ActionSchema', ['packages/types/src/crud.ts', 'packages/types/src/ui-action.ts']],
 ['AggregationConfig', ['packages/plugin-grid/src/useGroupedData.ts', 'packages/types/src/data-protocol.ts']],
 ['AppShellProps', ['packages/app-shell/src/types.ts', 'packages/layout/src/AppShell.tsx']],
 ['BreadcrumbItem', ['packages/types/src/data-display.ts', 'packages/types/src/navigation.ts']],
 ['BreadcrumbSchema', ['packages/types/src/data-display.ts', 'packages/types/src/navigation.ts']],
 // `ActionSchema` sat here, colliding between `packages/types/src/crud.ts` and
 // `packages/types/src/ui-action.ts`. Structurally unrelated types — 28 members
 // each, 9 shared, `type` the literal `'action'` there and `ActionType` here — so
 // the remedy was the RENAME branch: ui-action's declaration now spells
 // `UIActionSchema`, the name `src/index.ts` always published it under
 // (objectui#6349). `BreadcrumbItem` / `BreadcrumbSchema` sat here too, colliding
 // between `packages/types/src/data-display.ts` and
 // `packages/types/src/navigation.ts`; data-display's were a strict SUBSET copy, so
 // that file re-points at navigation's one authority.
 ['CalendarEvent', ['packages/plugin-calendar/src/index.tsx', 'packages/types/src/complex.ts']], // the ruled-on objectui#5044 alias — see the header
 ['CalendarSchema', ['packages/plugin-calendar/src/ObjectCalendar.tsx', 'packages/types/src/form.ts']],
 ['ChatMessage', ['packages/plugin-chatbot/src/ChatbotEnhanced.tsx', 'packages/types/src/complex.ts']],
Expand Down

13 changes: 9 additions & 4 deletions
scripts/check-action-forward-parity.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -392,7 +392,12 @@ export function loadSpecSchemas(require = createRequire(import.meta.url)) {
}

/**
 * `@object-ui/types`' renderer VIEW of an action.
 * `@object-ui/types`' renderer VIEW of an action — `interface UIActionSchema`.
 *
 * ⚠️ It was `interface ActionSchema` until objectui#6349, a second authority for
 * a name `packages/types/src/crud.ts` also declares. The declaration now spells
 * the name the package always PUBLISHED it under (`UIActionSchema`); the type
 * and the file are unchanged.
 *
 * Declared surfaces are typed against this, not against the spec schema
 * directly — it carries renderer-only fields the spec does not model
Expand All@@ -408,16 +413,16 @@ export function uiActionViewKeys(root, file = UI_ACTION_VIEW) {
 }
 const sf = parse(root, file);
 for (const stmt of sf.statements) {
 if (!ts.isInterfaceDeclaration(stmt) || stmt.name.text !== "ActionSchema") continue;
 if (!ts.isInterfaceDeclaration(stmt) || stmt.name.text !== "UIActionSchema") continue;
 const keys = stmt.members
 .filter(ts.isPropertySignature)
 .map((m) => (m.name && (ts.isIdentifier(m.name) || ts.isStringLiteral(m.name)) ? m.name.text : null))
 .filter((n) => n !== null);
 if (keys.length === 0) fail(`\`ActionSchema\` in ${file} declares no properties — extraction failed.`);
 if (keys.length === 0) fail(`\`UIActionSchema\` in ${file} declares no properties — extraction failed.`);
 return keys;
 }
 fail(
 `\`interface ActionSchema\` not found in ${file}.\n` +
 `\`interface UIActionSchema\` not found in ${file}.\n` +
 " The renderer view moved or was renamed; re-point this gate at it."
 );
}
Expand Down

13 changes: 8 additions & 5 deletions
scripts/check-spec-symbol-derivation.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -243,11 +243,14 @@ const root = resolve(dirname(fileURLToPath(import.meta.url)), "..");
const ALLOW = {
 "@object-ui/types:ActionSchema": {
 reason:
 "Two deliberate objectui-side shapes, both documented at their declaration. " +
 "`ui-action.ts` is a renderer VIEW over the spec's action — it carries renderer-only " +
 "fields the spec does not model, while importing the spec-owned parts it does share " +
 "(`ActionLocation`, `ActionType`). `crud.ts` is the explicitly @deprecated legacy " +
 "shape kept for backward compatibility and slated for removal in a future major.",
 "`crud.ts`'s explicitly @deprecated legacy action shape, kept for backward " +
 "compatibility and slated for removal in a future major. ⚠️ This entry covered TWO " +
 "objectui-side shapes until objectui#6349: `ui-action.ts` declared a same-named " +
 "renderer VIEW over the spec's action (renderer-only fields the spec does not model, " +
 "importing the spec-owned parts it shares — `ActionLocation`, `ActionType`). That one " +
 "is now declared as `UIActionSchema`, the name the package always published it under, " +
 "so it no longer shadows a spec export and no longer needs excusing here. This entry " +
 "stays because `crud.ts` still carries the name.",
 issue: 4115,
 },
 "@object-ui/types:FormField": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(types): one authority for `ActionSchema` and the Breadcrumb pair by os-sam · Pull Request #6936 · objectstack-ai/objectui · GitHub
Skip to content
fix(types): one authority for ActionSchema and the Breadcrumb pair#6936

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-sam
merged 1 commit into

from

Aug 31, 2026
 Merged


fix(types): one authority for ActionSchema and the Breadcrumb pair
#6936
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


43 changes: 43 additions & 0 deletions
.changeset/6349-types-internal-name-collisions-batch-1.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
---
'@object-ui/types': minor
---

Three exported type names inside `@object-ui/types` had two authorities each; each now has
one (objectui#6349, first batch — the three intra-package collisions from the 46-name
census on objectui#6273).

**`ActionSchema` — renamed, because the two shapes are unrelated.** `crud.ts` and
`ui-action.ts` both declared it. Measured member-by-member they share 9 keys out of 28 each:
`crud.ts` `extends BaseSchema` and pins `type: 'action'` (a UI node — a button in a
component tree), `ui-action.ts` extends nothing and types `type` as `ActionType` (a spec-v2
action definition, with `name`, `locations`, `params`, `target`). Re-pointing either at the
other would silently hand a consumer a different type, so this took the rename branch
(objectui#5044 is the precedent for choosing the surviving name). `ui-action.ts`'s
declaration is now spelled **`UIActionSchema`** — the name `src/index.ts` has always
PUBLISHED it under, via `export type { ActionSchema as UIActionSchema }`, which is now a
plain re-export. **The package's public surface is unchanged**: `ActionSchema` still means
`crud.ts`'s legacy shape and `UIActionSchema` still means `ui-action.ts`'s, exactly as
before. Nothing outside `ui-action.ts` imported the old spelling — there is no `./ui-action`
subpath in `exports`, so the old name was never reachable from outside the package.

**`BreadcrumbItem` / `BreadcrumbSchema` — re-pointed, because one copy was stale.** Both
were declared in `data-display.ts` and in `navigation.ts`. The data-display pair was not a
second dialect but a strict SUBSET: no key declared differently on either side, and missing
`BreadcrumbItem.icon` / `onClick` / `siblings` and `BreadcrumbSchema.maxItems`. Everything
that reads a breadcrumb was already on the navigation declaration — `registry.ts` maps the
`'breadcrumb'` component type to it, `src/index.ts` re-exports it under the bare names,
`zod/navigation.zod.ts` mirrors it (`icon`, `onClick`, `siblings`, `maxItems` included), the
`ui:breadcrumb` renderer consumes it, and the component's own documentation page documents
`icon` and `maxItems`. `data-display.ts` now re-exports the one authority.

**What changes for a consumer.** The `@object-ui/types/data-display` subpath is published, so
its `BreadcrumbItem` / `BreadcrumbSchema` and the `DataDisplaySchema` union's breadcrumb
member widen to the navigation declaration — they gain the four keys above. Nothing narrows
and no key changes type, so every value that type-checked before still does; what the subpath
now declares is what the renderer already honoured and the docs already described. Graded
`minor` because a published `.d.ts` member changes shape, per this repo's version-alignment
rule (never `major`).

The three `KNOWN_COLLISIONS` lines came down in the same change; that baseline
(`scripts/__tests__/one-authority-per-exported-name-6273.test.ts`) is shrink-only and fails in
both directions, so converging without deleting them would have been red too. 43 entries → 40.

48 changes: 21 additions & 27 deletions
packages/types/src/data-display.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@

import type { ChartType as SpecChartType } from '@objectstack/spec/ui';
import type { BaseSchema, SchemaNode } from './base.js';
import type { BreadcrumbSchema } from './navigation.js';

/**
 * Alert component
Expand DownExpand Up@@ -1644,34 +1645,27 @@ export interface TimelineSchema extends BaseSchema {
}

/**
 * Breadcrumb item
 */
export interface BreadcrumbItem {
 /**
 * Item label
 */
 label: string;
 /**
 * Item href/link
 */
 href?: string;
}

/**
 * Breadcrumb component
 * Breadcrumb — ONE authority, and it lives in `./navigation.ts`.
 *
 * This module declared its own `BreadcrumbItem` / `BreadcrumbSchema` until
 * objectui#6349. They were not a second dialect, they were a stale COPY: a
 * strict subset of the navigation declarations, missing `BreadcrumbItem.icon` /
 * `onClick` / `siblings` and `BreadcrumbSchema.maxItems`, with no key declared
 * differently on either side. Everything that actually reads a breadcrumb was
 * already on the navigation declaration — `registry.ts` maps the `'breadcrumb'`
 * component type to it, `packages/types/src/index.ts` re-exports it under the
 * bare names, `zod/navigation.zod.ts` mirrors it, and
 * `content/docs/components/data-display/breadcrumb.mdx` documents `icon` and
 * `maxItems` on THIS page. The copy's only reach was the
 * `@object-ui/types/data-display` subpath and the {@link DataDisplaySchema}
 * union below, both of which under-declared what the renderer honours.
 *
 * A re-export is one declaration with a second export site, which is exactly
 * how this monorepo is meant to fan a type out; the recurrence guard
 * (`scripts/__tests__/one-authority-per-exported-name-6273.test.ts`) does not
 * count it. 2026-08-25 family ruling, objectui#6172 decision 甲/A1.
 */
export interface BreadcrumbSchema extends BaseSchema {
 type: 'breadcrumb';
 /**
 * Breadcrumb items
 */
 items: BreadcrumbItem[];
 /**
 * Separator character
 * @default '/'
 */
 separator?: string;
}
export type { BreadcrumbItem, BreadcrumbSchema } from './navigation.js';

/**
 * Keyboard key component
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1034,7 +1034,7 @@ export type {
 ObjectUiLocalParamFieldType,
 ResolvableParamFieldType,
 ActionParam,
ActionSchema as UIActionSchema,
 UIActionSchema,
 ActionGroup,
 ActionContext,
 ActionResult,
Expand Down

30 changes: 21 additions & 9 deletions
packages/types/src/ui-action.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,11 +367,23 @@ export interface ActionParam

/**
 * Enhanced Action Schema (ObjectStack Spec v2.0.1)
 * 
 * This is the primary action schema that should be used for all new implementations.
 * The legacy ActionSchema in crud.ts is maintained for backward compatibility.
 *
 * This is the primary action schema that should be used for all new
 * implementations. The legacy `ActionSchema` in `crud.ts` is maintained for
 * backward compatibility.
 *
 * ⚠️ Named `UIActionSchema`, which is the name `packages/types/src/index.ts`
 * has always PUBLISHED it under. It was declared as `ActionSchema` until
 * objectui#6349 — a second authority for a name `crud.ts` also declares, so an
 * IDE auto-import picked between two structurally unrelated types (9 shared
 * keys out of 28 each; `type` is the literal `'action'` there and
 * {@link ActionType} here) and the wrong pick surfaced as a remote `TS2322`.
 * The declaration now spells the published name; nothing outside this file
 * imported the old one, so the package's public surface is unchanged. See the
 * 2026-08-25 family ruling (objectui#6172, decision 甲/A1) and the recurrence
 * guard `scripts/__tests__/one-authority-per-exported-name-6273.test.ts`.
 */
export interface ActionSchema {
export interface UIActionSchema {
 /** Unique action identifier (snake_case) */
 name: string;

Expand DownExpand Up@@ -472,7 +484,7 @@ export interface ActionSchema {
 * `inline-action-api-params-to-body-extra` conversion (ADR-0087 D2).
 *
 * Declared here so the action renderers can forward it off a typed
 * `ActionSchema` rather than through an `as any` cast — the renderers are the
 * `UIActionSchema` rather than through an `as any` cast — the renderers are the
 * consumers this field exists for (objectstack#6837). Typed off the spec
 * rather than restated, so the shape cannot drift from the contract.
 */
Expand All@@ -491,7 +503,7 @@ export interface ActionSchema {
 * exactly that, so the key has one meaning everywhere it is honoured.
 *
 * Declared here for the same reason as {@link bodyExtra}: the action
 * renderers forward it off a typed `ActionSchema` instead of an `as any`
 * renderers forward it off a typed `UIActionSchema` instead of an `as any`
 * cast, and dropping it from those whitelists is what made a declared wrap
 * degrade silently to a flat body (objectstack#6938). Typed by derivation
 * from the spec so the union cannot drift from the contract.
Expand DownExpand Up@@ -583,7 +595,7 @@ export interface ActionGroup {
 icon?: string;

 /** Actions in this group */
 actions: ActionSchema[];
 actions: UIActionSchema[];

 /** Group visibility condition */
 visible?: string;
Expand DownExpand Up@@ -637,7 +649,7 @@ export interface ActionResult {
 * Action executor function type
 */
export type ActionExecutor = (
 action: ActionSchema,
 action: UIActionSchema,
 context: ActionContext,
 params?: Record<string, any>
) => Promise<ActionResult>;
Expand DownExpand Up@@ -698,7 +710,7 @@ export interface TransactionConfig {
 /** Timeout in milliseconds */
 timeout?: number;
 /** Actions to execute within the transaction */
 actions: ActionSchema[];
 actions: UIActionSchema[];
 /** Rollback action on failure */
 rollbackAction?: string;
 /** Whether to auto-retry on conflict */
Expand Down

6 changes: 3 additions & 3 deletions
scripts/__tests__/check-action-forward-parity.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,7 +98,7 @@ function repoWith(
 files: {
 [UI_VIEW]:
 overrides.view ??
 'export interface ActionSchema {\n name?: string;\n description?: string;\n}\n',
 'export interface UIActionSchema {\n name?: string;\n description?: string;\n}\n',
 [KEYS_MODULE]:
 overrides.keys ?? "export const RETIRED_ACTION_KEYS = {\n execute: 'renamed to target',\n};\n",
 [CONSUMER]:
Expand DownExpand Up@@ -388,7 +388,7 @@ describe('extraction failure throws rather than returning a clean verdict', () =
 });

 it('a renderer view with no properties is red', () => {
 expect(() => judge(repoWith('{ target }', { view: 'export interface ActionSchema {}\n' }))).toThrow(
 expect(() => judge(repoWith('{ target }', { view: 'export interface UIActionSchema {}\n' }))).toThrow(
 /declares no properties/,
 );
 });
Expand All@@ -409,7 +409,7 @@ describe('extraction failure throws rather than returning a clean verdict', () =
 // Authorable and runtime-read do not intersect at all: nothing would ever be
 // checked for this surface again.
 expect(() =>
 judge(repoWith('{ target }', { view: 'export interface ActionSchema {\n nothingReadsThis?: string;\n}\n' }), {
 judge(repoWith('{ target }', { view: 'export interface UIActionSchema {\n nothingReadsThis?: string;\n}\n' }), {
 spec: { declared: ['norThis'], inline: [] },
 }),
 ).toThrow(/owed set is empty/);
Expand Down

12 changes: 9 additions & 3 deletions
scripts/__tests__/one-authority-per-exported-name-6273.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -349,11 +349,17 @@ const filesOf = (sites: readonly Located[]): string[] => [
const KNOWN_COLLISIONS: ReadonlyMap<string, readonly string[]> = new Map([
 ['ActionContext', ['packages/core/src/actions/ActionRunner.ts', 'packages/types/src/ui-action.ts']],
 ['ActionResult', ['packages/core/src/actions/ActionRunner.ts', 'packages/types/src/ui-action.ts']],
 ['ActionSchema', ['packages/types/src/crud.ts', 'packages/types/src/ui-action.ts']],
 ['AggregationConfig', ['packages/plugin-grid/src/useGroupedData.ts', 'packages/types/src/data-protocol.ts']],
 ['AppShellProps', ['packages/app-shell/src/types.ts', 'packages/layout/src/AppShell.tsx']],
 ['BreadcrumbItem', ['packages/types/src/data-display.ts', 'packages/types/src/navigation.ts']],
 ['BreadcrumbSchema', ['packages/types/src/data-display.ts', 'packages/types/src/navigation.ts']],
 // `ActionSchema` sat here, colliding between `packages/types/src/crud.ts` and
 // `packages/types/src/ui-action.ts`. Structurally unrelated types — 28 members
 // each, 9 shared, `type` the literal `'action'` there and `ActionType` here — so
 // the remedy was the RENAME branch: ui-action's declaration now spells
 // `UIActionSchema`, the name `src/index.ts` always published it under
 // (objectui#6349). `BreadcrumbItem` / `BreadcrumbSchema` sat here too, colliding
 // between `packages/types/src/data-display.ts` and
 // `packages/types/src/navigation.ts`; data-display's were a strict SUBSET copy, so
 // that file re-points at navigation's one authority.
 ['CalendarEvent', ['packages/plugin-calendar/src/index.tsx', 'packages/types/src/complex.ts']], // the ruled-on objectui#5044 alias — see the header
 ['CalendarSchema', ['packages/plugin-calendar/src/ObjectCalendar.tsx', 'packages/types/src/form.ts']],
 ['ChatMessage', ['packages/plugin-chatbot/src/ChatbotEnhanced.tsx', 'packages/types/src/complex.ts']],
Expand Down

13 changes: 9 additions & 4 deletions
scripts/check-action-forward-parity.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -392,7 +392,12 @@ export function loadSpecSchemas(require = createRequire(import.meta.url)) {
}

/**
 * `@object-ui/types`' renderer VIEW of an action.
 * `@object-ui/types`' renderer VIEW of an action — `interface UIActionSchema`.
 *
 * ⚠️ It was `interface ActionSchema` until objectui#6349, a second authority for
 * a name `packages/types/src/crud.ts` also declares. The declaration now spells
 * the name the package always PUBLISHED it under (`UIActionSchema`); the type
 * and the file are unchanged.
 *
 * Declared surfaces are typed against this, not against the spec schema
 * directly — it carries renderer-only fields the spec does not model
Expand All@@ -408,16 +413,16 @@ export function uiActionViewKeys(root, file = UI_ACTION_VIEW) {
 }
 const sf = parse(root, file);
 for (const stmt of sf.statements) {
 if (!ts.isInterfaceDeclaration(stmt) || stmt.name.text !== "ActionSchema") continue;
 if (!ts.isInterfaceDeclaration(stmt) || stmt.name.text !== "UIActionSchema") continue;
 const keys = stmt.members
 .filter(ts.isPropertySignature)
 .map((m) => (m.name && (ts.isIdentifier(m.name) || ts.isStringLiteral(m.name)) ? m.name.text : null))
 .filter((n) => n !== null);
 if (keys.length === 0) fail(`\`ActionSchema\` in ${file} declares no properties — extraction failed.`);
 if (keys.length === 0) fail(`\`UIActionSchema\` in ${file} declares no properties — extraction failed.`);
 return keys;
 }
 fail(
 `\`interface ActionSchema\` not found in ${file}.\n` +
 `\`interface UIActionSchema\` not found in ${file}.\n` +
 " The renderer view moved or was renamed; re-point this gate at it."
 );
}
Expand Down

13 changes: 8 additions & 5 deletions
scripts/check-spec-symbol-derivation.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -243,11 +243,14 @@ const root = resolve(dirname(fileURLToPath(import.meta.url)), "..");
const ALLOW = {
 "@object-ui/types:ActionSchema": {
 reason:
 "Two deliberate objectui-side shapes, both documented at their declaration. " +
 "`ui-action.ts` is a renderer VIEW over the spec's action — it carries renderer-only " +
 "fields the spec does not model, while importing the spec-owned parts it does share " +
 "(`ActionLocation`, `ActionType`). `crud.ts` is the explicitly @deprecated legacy " +
 "shape kept for backward compatibility and slated for removal in a future major.",
 "`crud.ts`'s explicitly @deprecated legacy action shape, kept for backward " +
 "compatibility and slated for removal in a future major. ⚠️ This entry covered TWO " +
 "objectui-side shapes until objectui#6349: `ui-action.ts` declared a same-named " +
 "renderer VIEW over the spec's action (renderer-only fields the spec does not model, " +
 "importing the spec-owned parts it shares — `ActionLocation`, `ActionType`). That one " +
 "is now declared as `UIActionSchema`, the name the package always published it under, " +
 "so it no longer shadows a spec export and no longer needs excusing here. This entry " +
 "stays because `crud.ts` still carries the name.",
 issue: 4115,
 },
 "@object-ui/types:FormField": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(types): one authority for `ActionSchema` and the Breadcrumb pair by os-sam · Pull Request #6936 · objectstack-ai/objectui · GitHub
Skip to content
fix(types): one authority for ActionSchema and the Breadcrumb pair#6936

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-sam
merged 1 commit into

from

Aug 31, 2026
 Merged


fix(types): one authority for ActionSchema and the Breadcrumb pair
#6936
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


43 changes: 43 additions & 0 deletions
.changeset/6349-types-internal-name-collisions-batch-1.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
---
'@object-ui/types': minor
---

Three exported type names inside `@object-ui/types` had two authorities each; each now has
one (objectui#6349, first batch — the three intra-package collisions from the 46-name
census on objectui#6273).

**`ActionSchema` — renamed, because the two shapes are unrelated.** `crud.ts` and
`ui-action.ts` both declared it. Measured member-by-member they share 9 keys out of 28 each:
`crud.ts` `extends BaseSchema` and pins `type: 'action'` (a UI node — a button in a
component tree), `ui-action.ts` extends nothing and types `type` as `ActionType` (a spec-v2
action definition, with `name`, `locations`, `params`, `target`). Re-pointing either at the
other would silently hand a consumer a different type, so this took the rename branch
(objectui#5044 is the precedent for choosing the surviving name). `ui-action.ts`'s
declaration is now spelled **`UIActionSchema`** — the name `src/index.ts` has always
PUBLISHED it under, via `export type { ActionSchema as UIActionSchema }`, which is now a
plain re-export. **The package's public surface is unchanged**: `ActionSchema` still means
`crud.ts`'s legacy shape and `UIActionSchema` still means `ui-action.ts`'s, exactly as
before. Nothing outside `ui-action.ts` imported the old spelling — there is no `./ui-action`
subpath in `exports`, so the old name was never reachable from outside the package.

**`BreadcrumbItem` / `BreadcrumbSchema` — re-pointed, because one copy was stale.** Both
were declared in `data-display.ts` and in `navigation.ts`. The data-display pair was not a
second dialect but a strict SUBSET: no key declared differently on either side, and missing
`BreadcrumbItem.icon` / `onClick` / `siblings` and `BreadcrumbSchema.maxItems`. Everything
that reads a breadcrumb was already on the navigation declaration — `registry.ts` maps the
`'breadcrumb'` component type to it, `src/index.ts` re-exports it under the bare names,
`zod/navigation.zod.ts` mirrors it (`icon`, `onClick`, `siblings`, `maxItems` included), the
`ui:breadcrumb` renderer consumes it, and the component's own documentation page documents
`icon` and `maxItems`. `data-display.ts` now re-exports the one authority.

**What changes for a consumer.** The `@object-ui/types/data-display` subpath is published, so
its `BreadcrumbItem` / `BreadcrumbSchema` and the `DataDisplaySchema` union's breadcrumb
member widen to the navigation declaration — they gain the four keys above. Nothing narrows
and no key changes type, so every value that type-checked before still does; what the subpath
now declares is what the renderer already honoured and the docs already described. Graded
`minor` because a published `.d.ts` member changes shape, per this repo's version-alignment
rule (never `major`).

The three `KNOWN_COLLISIONS` lines came down in the same change; that baseline
(`scripts/__tests__/one-authority-per-exported-name-6273.test.ts`) is shrink-only and fails in
both directions, so converging without deleting them would have been red too. 43 entries → 40.

48 changes: 21 additions & 27 deletions
packages/types/src/data-display.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@

import type { ChartType as SpecChartType } from '@objectstack/spec/ui';
import type { BaseSchema, SchemaNode } from './base.js';
import type { BreadcrumbSchema } from './navigation.js';

/**
 * Alert component
Expand DownExpand Up@@ -1644,34 +1645,27 @@ export interface TimelineSchema extends BaseSchema {
}

/**
 * Breadcrumb item
 */
export interface BreadcrumbItem {
 /**
 * Item label
 */
 label: string;
 /**
 * Item href/link
 */
 href?: string;
}

/**
 * Breadcrumb component
 * Breadcrumb — ONE authority, and it lives in `./navigation.ts`.
 *
 * This module declared its own `BreadcrumbItem` / `BreadcrumbSchema` until
 * objectui#6349. They were not a second dialect, they were a stale COPY: a
 * strict subset of the navigation declarations, missing `BreadcrumbItem.icon` /
 * `onClick` / `siblings` and `BreadcrumbSchema.maxItems`, with no key declared
 * differently on either side. Everything that actually reads a breadcrumb was
 * already on the navigation declaration — `registry.ts` maps the `'breadcrumb'`
 * component type to it, `packages/types/src/index.ts` re-exports it under the
 * bare names, `zod/navigation.zod.ts` mirrors it, and
 * `content/docs/components/data-display/breadcrumb.mdx` documents `icon` and
 * `maxItems` on THIS page. The copy's only reach was the
 * `@object-ui/types/data-display` subpath and the {@link DataDisplaySchema}
 * union below, both of which under-declared what the renderer honours.
 *
 * A re-export is one declaration with a second export site, which is exactly
 * how this monorepo is meant to fan a type out; the recurrence guard
 * (`scripts/__tests__/one-authority-per-exported-name-6273.test.ts`) does not
 * count it. 2026-08-25 family ruling, objectui#6172 decision 甲/A1.
 */
export interface BreadcrumbSchema extends BaseSchema {
 type: 'breadcrumb';
 /**
 * Breadcrumb items
 */
 items: BreadcrumbItem[];
 /**
 * Separator character
 * @default '/'
 */
 separator?: string;
}
export type { BreadcrumbItem, BreadcrumbSchema } from './navigation.js';

/**
 * Keyboard key component
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1034,7 +1034,7 @@ export type {
 ObjectUiLocalParamFieldType,
 ResolvableParamFieldType,
 ActionParam,
ActionSchema as UIActionSchema,
 UIActionSchema,
 ActionGroup,
 ActionContext,
 ActionResult,
Expand Down

30 changes: 21 additions & 9 deletions
packages/types/src/ui-action.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,11 +367,23 @@ export interface ActionParam

/**
 * Enhanced Action Schema (ObjectStack Spec v2.0.1)
 * 
 * This is the primary action schema that should be used for all new implementations.
 * The legacy ActionSchema in crud.ts is maintained for backward compatibility.
 *
 * This is the primary action schema that should be used for all new
 * implementations. The legacy `ActionSchema` in `crud.ts` is maintained for
 * backward compatibility.
 *
 * ⚠️ Named `UIActionSchema`, which is the name `packages/types/src/index.ts`
 * has always PUBLISHED it under. It was declared as `ActionSchema` until
 * objectui#6349 — a second authority for a name `crud.ts` also declares, so an
 * IDE auto-import picked between two structurally unrelated types (9 shared
 * keys out of 28 each; `type` is the literal `'action'` there and
 * {@link ActionType} here) and the wrong pick surfaced as a remote `TS2322`.
 * The declaration now spells the published name; nothing outside this file
 * imported the old one, so the package's public surface is unchanged. See the
 * 2026-08-25 family ruling (objectui#6172, decision 甲/A1) and the recurrence
 * guard `scripts/__tests__/one-authority-per-exported-name-6273.test.ts`.
 */
export interface ActionSchema {
export interface UIActionSchema {
 /** Unique action identifier (snake_case) */
 name: string;

Expand DownExpand Up@@ -472,7 +484,7 @@ export interface ActionSchema {
 * `inline-action-api-params-to-body-extra` conversion (ADR-0087 D2).
 *
 * Declared here so the action renderers can forward it off a typed
 * `ActionSchema` rather than through an `as any` cast — the renderers are the
 * `UIActionSchema` rather than through an `as any` cast — the renderers are the
 * consumers this field exists for (objectstack#6837). Typed off the spec
 * rather than restated, so the shape cannot drift from the contract.
 */
Expand All@@ -491,7 +503,7 @@ export interface ActionSchema {
 * exactly that, so the key has one meaning everywhere it is honoured.
 *
 * Declared here for the same reason as {@link bodyExtra}: the action
 * renderers forward it off a typed `ActionSchema` instead of an `as any`
 * renderers forward it off a typed `UIActionSchema` instead of an `as any`
 * cast, and dropping it from those whitelists is what made a declared wrap
 * degrade silently to a flat body (objectstack#6938). Typed by derivation
 * from the spec so the union cannot drift from the contract.
Expand DownExpand Up@@ -583,7 +595,7 @@ export interface ActionGroup {
 icon?: string;

 /** Actions in this group */
 actions: ActionSchema[];
 actions: UIActionSchema[];

 /** Group visibility condition */
 visible?: string;
Expand DownExpand Up@@ -637,7 +649,7 @@ export interface ActionResult {
 * Action executor function type
 */
export type ActionExecutor = (
 action: ActionSchema,
 action: UIActionSchema,
 context: ActionContext,
 params?: Record<string, any>
) => Promise<ActionResult>;
Expand DownExpand Up@@ -698,7 +710,7 @@ export interface TransactionConfig {
 /** Timeout in milliseconds */
 timeout?: number;
 /** Actions to execute within the transaction */
 actions: ActionSchema[];
 actions: UIActionSchema[];
 /** Rollback action on failure */
 rollbackAction?: string;
 /** Whether to auto-retry on conflict */
Expand Down

6 changes: 3 additions & 3 deletions
scripts/__tests__/check-action-forward-parity.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,7 +98,7 @@ function repoWith(
 files: {
 [UI_VIEW]:
 overrides.view ??
 'export interface ActionSchema {\n name?: string;\n description?: string;\n}\n',
 'export interface UIActionSchema {\n name?: string;\n description?: string;\n}\n',
 [KEYS_MODULE]:
 overrides.keys ?? "export const RETIRED_ACTION_KEYS = {\n execute: 'renamed to target',\n};\n",
 [CONSUMER]:
Expand DownExpand Up@@ -388,7 +388,7 @@ describe('extraction failure throws rather than returning a clean verdict', () =
 });

 it('a renderer view with no properties is red', () => {
 expect(() => judge(repoWith('{ target }', { view: 'export interface ActionSchema {}\n' }))).toThrow(
 expect(() => judge(repoWith('{ target }', { view: 'export interface UIActionSchema {}\n' }))).toThrow(
 /declares no properties/,
 );
 });
Expand All@@ -409,7 +409,7 @@ describe('extraction failure throws rather than returning a clean verdict', () =
 // Authorable and runtime-read do not intersect at all: nothing would ever be
 // checked for this surface again.
 expect(() =>
 judge(repoWith('{ target }', { view: 'export interface ActionSchema {\n nothingReadsThis?: string;\n}\n' }), {
 judge(repoWith('{ target }', { view: 'export interface UIActionSchema {\n nothingReadsThis?: string;\n}\n' }), {
 spec: { declared: ['norThis'], inline: [] },
 }),
 ).toThrow(/owed set is empty/);
Expand Down

12 changes: 9 additions & 3 deletions
scripts/__tests__/one-authority-per-exported-name-6273.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -349,11 +349,17 @@ const filesOf = (sites: readonly Located[]): string[] => [
const KNOWN_COLLISIONS: ReadonlyMap<string, readonly string[]> = new Map([
 ['ActionContext', ['packages/core/src/actions/ActionRunner.ts', 'packages/types/src/ui-action.ts']],
 ['ActionResult', ['packages/core/src/actions/ActionRunner.ts', 'packages/types/src/ui-action.ts']],
 ['ActionSchema', ['packages/types/src/crud.ts', 'packages/types/src/ui-action.ts']],
 ['AggregationConfig', ['packages/plugin-grid/src/useGroupedData.ts', 'packages/types/src/data-protocol.ts']],
 ['AppShellProps', ['packages/app-shell/src/types.ts', 'packages/layout/src/AppShell.tsx']],
 ['BreadcrumbItem', ['packages/types/src/data-display.ts', 'packages/types/src/navigation.ts']],
 ['BreadcrumbSchema', ['packages/types/src/data-display.ts', 'packages/types/src/navigation.ts']],
 // `ActionSchema` sat here, colliding between `packages/types/src/crud.ts` and
 // `packages/types/src/ui-action.ts`. Structurally unrelated types — 28 members
 // each, 9 shared, `type` the literal `'action'` there and `ActionType` here — so
 // the remedy was the RENAME branch: ui-action's declaration now spells
 // `UIActionSchema`, the name `src/index.ts` always published it under
 // (objectui#6349). `BreadcrumbItem` / `BreadcrumbSchema` sat here too, colliding
 // between `packages/types/src/data-display.ts` and
 // `packages/types/src/navigation.ts`; data-display's were a strict SUBSET copy, so
 // that file re-points at navigation's one authority.
 ['CalendarEvent', ['packages/plugin-calendar/src/index.tsx', 'packages/types/src/complex.ts']], // the ruled-on objectui#5044 alias — see the header
 ['CalendarSchema', ['packages/plugin-calendar/src/ObjectCalendar.tsx', 'packages/types/src/form.ts']],
 ['ChatMessage', ['packages/plugin-chatbot/src/ChatbotEnhanced.tsx', 'packages/types/src/complex.ts']],
Expand Down

13 changes: 9 additions & 4 deletions
scripts/check-action-forward-parity.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -392,7 +392,12 @@ export function loadSpecSchemas(require = createRequire(import.meta.url)) {
}

/**
 * `@object-ui/types`' renderer VIEW of an action.
 * `@object-ui/types`' renderer VIEW of an action — `interface UIActionSchema`.
 *
 * ⚠️ It was `interface ActionSchema` until objectui#6349, a second authority for
 * a name `packages/types/src/crud.ts` also declares. The declaration now spells
 * the name the package always PUBLISHED it under (`UIActionSchema`); the type
 * and the file are unchanged.
 *
 * Declared surfaces are typed against this, not against the spec schema
 * directly — it carries renderer-only fields the spec does not model
Expand All@@ -408,16 +413,16 @@ export function uiActionViewKeys(root, file = UI_ACTION_VIEW) {
 }
 const sf = parse(root, file);
 for (const stmt of sf.statements) {
 if (!ts.isInterfaceDeclaration(stmt) || stmt.name.text !== "ActionSchema") continue;
 if (!ts.isInterfaceDeclaration(stmt) || stmt.name.text !== "UIActionSchema") continue;
 const keys = stmt.members
 .filter(ts.isPropertySignature)
 .map((m) => (m.name && (ts.isIdentifier(m.name) || ts.isStringLiteral(m.name)) ? m.name.text : null))
 .filter((n) => n !== null);
 if (keys.length === 0) fail(`\`ActionSchema\` in ${file} declares no properties — extraction failed.`);
 if (keys.length === 0) fail(`\`UIActionSchema\` in ${file} declares no properties — extraction failed.`);
 return keys;
 }
 fail(
 `\`interface ActionSchema\` not found in ${file}.\n` +
 `\`interface UIActionSchema\` not found in ${file}.\n` +
 " The renderer view moved or was renamed; re-point this gate at it."
 );
}
Expand Down

13 changes: 8 additions & 5 deletions
scripts/check-spec-symbol-derivation.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -243,11 +243,14 @@ const root = resolve(dirname(fileURLToPath(import.meta.url)), "..");
const ALLOW = {
 "@object-ui/types:ActionSchema": {
 reason:
 "Two deliberate objectui-side shapes, both documented at their declaration. " +
 "`ui-action.ts` is a renderer VIEW over the spec's action — it carries renderer-only " +
 "fields the spec does not model, while importing the spec-owned parts it does share " +
 "(`ActionLocation`, `ActionType`). `crud.ts` is the explicitly @deprecated legacy " +
 "shape kept for backward compatibility and slated for removal in a future major.",
 "`crud.ts`'s explicitly @deprecated legacy action shape, kept for backward " +
 "compatibility and slated for removal in a future major. ⚠️ This entry covered TWO " +
 "objectui-side shapes until objectui#6349: `ui-action.ts` declared a same-named " +
 "renderer VIEW over the spec's action (renderer-only fields the spec does not model, " +
 "importing the spec-owned parts it shares — `ActionLocation`, `ActionType`). That one " +
 "is now declared as `UIActionSchema`, the name the package always published it under, " +
 "so it no longer shadows a spec export and no longer needs excusing here. This entry " +
 "stays because `crud.ts` still carries the name.",
 issue: 4115,
 },
 "@object-ui/types:FormField": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
fix(types): one authority for `ActionSchema` and the Breadcrumb pair by os-sam · Pull Request #6936 · objectstack-ai/objectui · GitHub
Skip to content
fix(types): one authority for ActionSchema and the Breadcrumb pair#6936

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-sam
merged 1 commit into

from

Aug 31, 2026
 Merged


fix(types): one authority for ActionSchema and the Breadcrumb pair
#6936
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


43 changes: 43 additions & 0 deletions
.changeset/6349-types-internal-name-collisions-batch-1.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
---
'@object-ui/types': minor
---

Three exported type names inside `@object-ui/types` had two authorities each; each now has
one (objectui#6349, first batch — the three intra-package collisions from the 46-name
census on objectui#6273).

**`ActionSchema` — renamed, because the two shapes are unrelated.** `crud.ts` and
`ui-action.ts` both declared it. Measured member-by-member they share 9 keys out of 28 each:
`crud.ts` `extends BaseSchema` and pins `type: 'action'` (a UI node — a button in a
component tree), `ui-action.ts` extends nothing and types `type` as `ActionType` (a spec-v2
action definition, with `name`, `locations`, `params`, `target`). Re-pointing either at the
other would silently hand a consumer a different type, so this took the rename branch
(objectui#5044 is the precedent for choosing the surviving name). `ui-action.ts`'s
declaration is now spelled **`UIActionSchema`** — the name `src/index.ts` has always
PUBLISHED it under, via `export type { ActionSchema as UIActionSchema }`, which is now a
plain re-export. **The package's public surface is unchanged**: `ActionSchema` still means
`crud.ts`'s legacy shape and `UIActionSchema` still means `ui-action.ts`'s, exactly as
before. Nothing outside `ui-action.ts` imported the old spelling — there is no `./ui-action`
subpath in `exports`, so the old name was never reachable from outside the package.

**`BreadcrumbItem` / `BreadcrumbSchema` — re-pointed, because one copy was stale.** Both
were declared in `data-display.ts` and in `navigation.ts`. The data-display pair was not a
second dialect but a strict SUBSET: no key declared differently on either side, and missing
`BreadcrumbItem.icon` / `onClick` / `siblings` and `BreadcrumbSchema.maxItems`. Everything
that reads a breadcrumb was already on the navigation declaration — `registry.ts` maps the
`'breadcrumb'` component type to it, `src/index.ts` re-exports it under the bare names,
`zod/navigation.zod.ts` mirrors it (`icon`, `onClick`, `siblings`, `maxItems` included), the
`ui:breadcrumb` renderer consumes it, and the component's own documentation page documents
`icon` and `maxItems`. `data-display.ts` now re-exports the one authority.

**What changes for a consumer.** The `@object-ui/types/data-display` subpath is published, so
its `BreadcrumbItem` / `BreadcrumbSchema` and the `DataDisplaySchema` union's breadcrumb
member widen to the navigation declaration — they gain the four keys above. Nothing narrows
and no key changes type, so every value that type-checked before still does; what the subpath
now declares is what the renderer already honoured and the docs already described. Graded
`minor` because a published `.d.ts` member changes shape, per this repo's version-alignment
rule (never `major`).

The three `KNOWN_COLLISIONS` lines came down in the same change; that baseline
(`scripts/__tests__/one-authority-per-exported-name-6273.test.ts`) is shrink-only and fails in
both directions, so converging without deleting them would have been red too. 43 entries → 40.

48 changes: 21 additions & 27 deletions
packages/types/src/data-display.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@

import type { ChartType as SpecChartType } from '@objectstack/spec/ui';
import type { BaseSchema, SchemaNode } from './base.js';
import type { BreadcrumbSchema } from './navigation.js';

/**
 * Alert component
Expand DownExpand Up@@ -1644,34 +1645,27 @@ export interface TimelineSchema extends BaseSchema {
}

/**
 * Breadcrumb item
 */
export interface BreadcrumbItem {
 /**
 * Item label
 */
 label: string;
 /**
 * Item href/link
 */
 href?: string;
}

/**
 * Breadcrumb component
 * Breadcrumb — ONE authority, and it lives in `./navigation.ts`.
 *
 * This module declared its own `BreadcrumbItem` / `BreadcrumbSchema` until
 * objectui#6349. They were not a second dialect, they were a stale COPY: a
 * strict subset of the navigation declarations, missing `BreadcrumbItem.icon` /
 * `onClick` / `siblings` and `BreadcrumbSchema.maxItems`, with no key declared
 * differently on either side. Everything that actually reads a breadcrumb was
 * already on the navigation declaration — `registry.ts` maps the `'breadcrumb'`
 * component type to it, `packages/types/src/index.ts` re-exports it under the
 * bare names, `zod/navigation.zod.ts` mirrors it, and
 * `content/docs/components/data-display/breadcrumb.mdx` documents `icon` and
 * `maxItems` on THIS page. The copy's only reach was the
 * `@object-ui/types/data-display` subpath and the {@link DataDisplaySchema}
 * union below, both of which under-declared what the renderer honours.
 *
 * A re-export is one declaration with a second export site, which is exactly
 * how this monorepo is meant to fan a type out; the recurrence guard
 * (`scripts/__tests__/one-authority-per-exported-name-6273.test.ts`) does not
 * count it. 2026-08-25 family ruling, objectui#6172 decision 甲/A1.
 */
export interface BreadcrumbSchema extends BaseSchema {
 type: 'breadcrumb';
 /**
 * Breadcrumb items
 */
 items: BreadcrumbItem[];
 /**
 * Separator character
 * @default '/'
 */
 separator?: string;
}
export type { BreadcrumbItem, BreadcrumbSchema } from './navigation.js';

/**
 * Keyboard key component
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1034,7 +1034,7 @@ export type {
 ObjectUiLocalParamFieldType,
 ResolvableParamFieldType,
 ActionParam,
ActionSchema as UIActionSchema,
 UIActionSchema,
 ActionGroup,
 ActionContext,
 ActionResult,
Expand Down

30 changes: 21 additions & 9 deletions
packages/types/src/ui-action.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,11 +367,23 @@ export interface ActionParam

/**
 * Enhanced Action Schema (ObjectStack Spec v2.0.1)
 * 
 * This is the primary action schema that should be used for all new implementations.
 * The legacy ActionSchema in crud.ts is maintained for backward compatibility.
 *
 * This is the primary action schema that should be used for all new
 * implementations. The legacy `ActionSchema` in `crud.ts` is maintained for
 * backward compatibility.
 *
 * ⚠️ Named `UIActionSchema`, which is the name `packages/types/src/index.ts`
 * has always PUBLISHED it under. It was declared as `ActionSchema` until
 * objectui#6349 — a second authority for a name `crud.ts` also declares, so an
 * IDE auto-import picked between two structurally unrelated types (9 shared
 * keys out of 28 each; `type` is the literal `'action'` there and
 * {@link ActionType} here) and the wrong pick surfaced as a remote `TS2322`.
 * The declaration now spells the published name; nothing outside this file
 * imported the old one, so the package's public surface is unchanged. See the
 * 2026-08-25 family ruling (objectui#6172, decision 甲/A1) and the recurrence
 * guard `scripts/__tests__/one-authority-per-exported-name-6273.test.ts`.
 */
export interface ActionSchema {
export interface UIActionSchema {
 /** Unique action identifier (snake_case) */
 name: string;

Expand DownExpand Up@@ -472,7 +484,7 @@ export interface ActionSchema {
 * `inline-action-api-params-to-body-extra` conversion (ADR-0087 D2).
 *
 * Declared here so the action renderers can forward it off a typed
 * `ActionSchema` rather than through an `as any` cast — the renderers are the
 * `UIActionSchema` rather than through an `as any` cast — the renderers are the
 * consumers this field exists for (objectstack#6837). Typed off the spec
 * rather than restated, so the shape cannot drift from the contract.
 */
Expand All@@ -491,7 +503,7 @@ export interface ActionSchema {
 * exactly that, so the key has one meaning everywhere it is honoured.
 *
 * Declared here for the same reason as {@link bodyExtra}: the action
 * renderers forward it off a typed `ActionSchema` instead of an `as any`
 * renderers forward it off a typed `UIActionSchema` instead of an `as any`
 * cast, and dropping it from those whitelists is what made a declared wrap
 * degrade silently to a flat body (objectstack#6938). Typed by derivation
 * from the spec so the union cannot drift from the contract.
Expand DownExpand Up@@ -583,7 +595,7 @@ export interface ActionGroup {
 icon?: string;

 /** Actions in this group */
 actions: ActionSchema[];
 actions: UIActionSchema[];

 /** Group visibility condition */
 visible?: string;
Expand DownExpand Up@@ -637,7 +649,7 @@ export interface ActionResult {
 * Action executor function type
 */
export type ActionExecutor = (
 action: ActionSchema,
 action: UIActionSchema,
 context: ActionContext,
 params?: Record<string, any>
) => Promise<ActionResult>;
Expand DownExpand Up@@ -698,7 +710,7 @@ export interface TransactionConfig {
 /** Timeout in milliseconds */
 timeout?: number;
 /** Actions to execute within the transaction */
 actions: ActionSchema[];
 actions: UIActionSchema[];
 /** Rollback action on failure */
 rollbackAction?: string;
 /** Whether to auto-retry on conflict */
Expand Down

6 changes: 3 additions & 3 deletions
scripts/__tests__/check-action-forward-parity.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,7 +98,7 @@ function repoWith(
 files: {
 [UI_VIEW]:
 overrides.view ??
 'export interface ActionSchema {\n name?: string;\n description?: string;\n}\n',
 'export interface UIActionSchema {\n name?: string;\n description?: string;\n}\n',
 [KEYS_MODULE]:
 overrides.keys ?? "export const RETIRED_ACTION_KEYS = {\n execute: 'renamed to target',\n};\n",
 [CONSUMER]:
Expand DownExpand Up@@ -388,7 +388,7 @@ describe('extraction failure throws rather than returning a clean verdict', () =
 });

 it('a renderer view with no properties is red', () => {
 expect(() => judge(repoWith('{ target }', { view: 'export interface ActionSchema {}\n' }))).toThrow(
 expect(() => judge(repoWith('{ target }', { view: 'export interface UIActionSchema {}\n' }))).toThrow(
 /declares no properties/,
 );
 });
Expand All@@ -409,7 +409,7 @@ describe('extraction failure throws rather than returning a clean verdict', () =
 // Authorable and runtime-read do not intersect at all: nothing would ever be
 // checked for this surface again.
 expect(() =>
 judge(repoWith('{ target }', { view: 'export interface ActionSchema {\n nothingReadsThis?: string;\n}\n' }), {
 judge(repoWith('{ target }', { view: 'export interface UIActionSchema {\n nothingReadsThis?: string;\n}\n' }), {
 spec: { declared: ['norThis'], inline: [] },
 }),
 ).toThrow(/owed set is empty/);
Expand Down

12 changes: 9 additions & 3 deletions
scripts/__tests__/one-authority-per-exported-name-6273.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -349,11 +349,17 @@ const filesOf = (sites: readonly Located[]): string[] => [
const KNOWN_COLLISIONS: ReadonlyMap<string, readonly string[]> = new Map([
 ['ActionContext', ['packages/core/src/actions/ActionRunner.ts', 'packages/types/src/ui-action.ts']],
 ['ActionResult', ['packages/core/src/actions/ActionRunner.ts', 'packages/types/src/ui-action.ts']],
 ['ActionSchema', ['packages/types/src/crud.ts', 'packages/types/src/ui-action.ts']],
 ['AggregationConfig', ['packages/plugin-grid/src/useGroupedData.ts', 'packages/types/src/data-protocol.ts']],
 ['AppShellProps', ['packages/app-shell/src/types.ts', 'packages/layout/src/AppShell.tsx']],
 ['BreadcrumbItem', ['packages/types/src/data-display.ts', 'packages/types/src/navigation.ts']],
 ['BreadcrumbSchema', ['packages/types/src/data-display.ts', 'packages/types/src/navigation.ts']],
 // `ActionSchema` sat here, colliding between `packages/types/src/crud.ts` and
 // `packages/types/src/ui-action.ts`. Structurally unrelated types — 28 members
 // each, 9 shared, `type` the literal `'action'` there and `ActionType` here — so
 // the remedy was the RENAME branch: ui-action's declaration now spells
 // `UIActionSchema`, the name `src/index.ts` always published it under
 // (objectui#6349). `BreadcrumbItem` / `BreadcrumbSchema` sat here too, colliding
 // between `packages/types/src/data-display.ts` and
 // `packages/types/src/navigation.ts`; data-display's were a strict SUBSET copy, so
 // that file re-points at navigation's one authority.
 ['CalendarEvent', ['packages/plugin-calendar/src/index.tsx', 'packages/types/src/complex.ts']], // the ruled-on objectui#5044 alias — see the header
 ['CalendarSchema', ['packages/plugin-calendar/src/ObjectCalendar.tsx', 'packages/types/src/form.ts']],
 ['ChatMessage', ['packages/plugin-chatbot/src/ChatbotEnhanced.tsx', 'packages/types/src/complex.ts']],
Expand Down

13 changes: 9 additions & 4 deletions
scripts/check-action-forward-parity.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -392,7 +392,12 @@ export function loadSpecSchemas(require = createRequire(import.meta.url)) {
}

/**
 * `@object-ui/types`' renderer VIEW of an action.
 * `@object-ui/types`' renderer VIEW of an action — `interface UIActionSchema`.
 *
 * ⚠️ It was `interface ActionSchema` until objectui#6349, a second authority for
 * a name `packages/types/src/crud.ts` also declares. The declaration now spells
 * the name the package always PUBLISHED it under (`UIActionSchema`); the type
 * and the file are unchanged.
 *
 * Declared surfaces are typed against this, not against the spec schema
 * directly — it carries renderer-only fields the spec does not model
Expand All@@ -408,16 +413,16 @@ export function uiActionViewKeys(root, file = UI_ACTION_VIEW) {
 }
 const sf = parse(root, file);
 for (const stmt of sf.statements) {
 if (!ts.isInterfaceDeclaration(stmt) || stmt.name.text !== "ActionSchema") continue;
 if (!ts.isInterfaceDeclaration(stmt) || stmt.name.text !== "UIActionSchema") continue;
 const keys = stmt.members
 .filter(ts.isPropertySignature)
 .map((m) => (m.name && (ts.isIdentifier(m.name) || ts.isStringLiteral(m.name)) ? m.name.text : null))
 .filter((n) => n !== null);
 if (keys.length === 0) fail(`\`ActionSchema\` in ${file} declares no properties — extraction failed.`);
 if (keys.length === 0) fail(`\`UIActionSchema\` in ${file} declares no properties — extraction failed.`);
 return keys;
 }
 fail(
 `\`interface ActionSchema\` not found in ${file}.\n` +
 `\`interface UIActionSchema\` not found in ${file}.\n` +
 " The renderer view moved or was renamed; re-point this gate at it."
 );
}
Expand Down

13 changes: 8 additions & 5 deletions
scripts/check-spec-symbol-derivation.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -243,11 +243,14 @@ const root = resolve(dirname(fileURLToPath(import.meta.url)), "..");
const ALLOW = {
 "@object-ui/types:ActionSchema": {
 reason:
 "Two deliberate objectui-side shapes, both documented at their declaration. " +
 "`ui-action.ts` is a renderer VIEW over the spec's action — it carries renderer-only " +
 "fields the spec does not model, while importing the spec-owned parts it does share " +
 "(`ActionLocation`, `ActionType`). `crud.ts` is the explicitly @deprecated legacy " +
 "shape kept for backward compatibility and slated for removal in a future major.",
 "`crud.ts`'s explicitly @deprecated legacy action shape, kept for backward " +
 "compatibility and slated for removal in a future major. ⚠️ This entry covered TWO " +
 "objectui-side shapes until objectui#6349: `ui-action.ts` declared a same-named " +
 "renderer VIEW over the spec's action (renderer-only fields the spec does not model, " +
 "importing the spec-owned parts it shares — `ActionLocation`, `ActionType`). That one " +
 "is now declared as `UIActionSchema`, the name the package always published it under, " +
 "so it no longer shadows a spec export and no longer needs excusing here. This entry " +
 "stays because `crud.ts` still carries the name.",
 issue: 4115,
 },
 "@object-ui/types:FormField": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(types): one authority for `ActionSchema` and the Breadcrumb pair by os-sam · Pull Request #6936 · objectstack-ai/objectui · GitHub
Skip to content
fix(types): one authority for ActionSchema and the Breadcrumb pair#6936

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-sam
merged 1 commit into

from

Aug 31, 2026
 Merged


fix(types): one authority for ActionSchema and the Breadcrumb pair
#6936
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


43 changes: 43 additions & 0 deletions
.changeset/6349-types-internal-name-collisions-batch-1.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
---
'@object-ui/types': minor
---

Three exported type names inside `@object-ui/types` had two authorities each; each now has
one (objectui#6349, first batch — the three intra-package collisions from the 46-name
census on objectui#6273).

**`ActionSchema` — renamed, because the two shapes are unrelated.** `crud.ts` and
`ui-action.ts` both declared it. Measured member-by-member they share 9 keys out of 28 each:
`crud.ts` `extends BaseSchema` and pins `type: 'action'` (a UI node — a button in a
component tree), `ui-action.ts` extends nothing and types `type` as `ActionType` (a spec-v2
action definition, with `name`, `locations`, `params`, `target`). Re-pointing either at the
other would silently hand a consumer a different type, so this took the rename branch
(objectui#5044 is the precedent for choosing the surviving name). `ui-action.ts`'s
declaration is now spelled **`UIActionSchema`** — the name `src/index.ts` has always
PUBLISHED it under, via `export type { ActionSchema as UIActionSchema }`, which is now a
plain re-export. **The package's public surface is unchanged**: `ActionSchema` still means
`crud.ts`'s legacy shape and `UIActionSchema` still means `ui-action.ts`'s, exactly as
before. Nothing outside `ui-action.ts` imported the old spelling — there is no `./ui-action`
subpath in `exports`, so the old name was never reachable from outside the package.

**`BreadcrumbItem` / `BreadcrumbSchema` — re-pointed, because one copy was stale.** Both
were declared in `data-display.ts` and in `navigation.ts`. The data-display pair was not a
second dialect but a strict SUBSET: no key declared differently on either side, and missing
`BreadcrumbItem.icon` / `onClick` / `siblings` and `BreadcrumbSchema.maxItems`. Everything
that reads a breadcrumb was already on the navigation declaration — `registry.ts` maps the
`'breadcrumb'` component type to it, `src/index.ts` re-exports it under the bare names,
`zod/navigation.zod.ts` mirrors it (`icon`, `onClick`, `siblings`, `maxItems` included), the
`ui:breadcrumb` renderer consumes it, and the component's own documentation page documents
`icon` and `maxItems`. `data-display.ts` now re-exports the one authority.

**What changes for a consumer.** The `@object-ui/types/data-display` subpath is published, so
its `BreadcrumbItem` / `BreadcrumbSchema` and the `DataDisplaySchema` union's breadcrumb
member widen to the navigation declaration — they gain the four keys above. Nothing narrows
and no key changes type, so every value that type-checked before still does; what the subpath
now declares is what the renderer already honoured and the docs already described. Graded
`minor` because a published `.d.ts` member changes shape, per this repo's version-alignment
rule (never `major`).

The three `KNOWN_COLLISIONS` lines came down in the same change; that baseline
(`scripts/__tests__/one-authority-per-exported-name-6273.test.ts`) is shrink-only and fails in
both directions, so converging without deleting them would have been red too. 43 entries → 40.

48 changes: 21 additions & 27 deletions
packages/types/src/data-display.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@

import type { ChartType as SpecChartType } from '@objectstack/spec/ui';
import type { BaseSchema, SchemaNode } from './base.js';
import type { BreadcrumbSchema } from './navigation.js';

/**
 * Alert component
Expand DownExpand Up@@ -1644,34 +1645,27 @@ export interface TimelineSchema extends BaseSchema {
}

/**
 * Breadcrumb item
 */
export interface BreadcrumbItem {
 /**
 * Item label
 */
 label: string;
 /**
 * Item href/link
 */
 href?: string;
}

/**
 * Breadcrumb component
 * Breadcrumb — ONE authority, and it lives in `./navigation.ts`.
 *
 * This module declared its own `BreadcrumbItem` / `BreadcrumbSchema` until
 * objectui#6349. They were not a second dialect, they were a stale COPY: a
 * strict subset of the navigation declarations, missing `BreadcrumbItem.icon` /
 * `onClick` / `siblings` and `BreadcrumbSchema.maxItems`, with no key declared
 * differently on either side. Everything that actually reads a breadcrumb was
 * already on the navigation declaration — `registry.ts` maps the `'breadcrumb'`
 * component type to it, `packages/types/src/index.ts` re-exports it under the
 * bare names, `zod/navigation.zod.ts` mirrors it, and
 * `content/docs/components/data-display/breadcrumb.mdx` documents `icon` and
 * `maxItems` on THIS page. The copy's only reach was the
 * `@object-ui/types/data-display` subpath and the {@link DataDisplaySchema}
 * union below, both of which under-declared what the renderer honours.
 *
 * A re-export is one declaration with a second export site, which is exactly
 * how this monorepo is meant to fan a type out; the recurrence guard
 * (`scripts/__tests__/one-authority-per-exported-name-6273.test.ts`) does not
 * count it. 2026-08-25 family ruling, objectui#6172 decision 甲/A1.
 */
export interface BreadcrumbSchema extends BaseSchema {
 type: 'breadcrumb';
 /**
 * Breadcrumb items
 */
 items: BreadcrumbItem[];
 /**
 * Separator character
 * @default '/'
 */
 separator?: string;
}
export type { BreadcrumbItem, BreadcrumbSchema } from './navigation.js';

/**
 * Keyboard key component
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1034,7 +1034,7 @@ export type {
 ObjectUiLocalParamFieldType,
 ResolvableParamFieldType,
 ActionParam,
ActionSchema as UIActionSchema,
 UIActionSchema,
 ActionGroup,
 ActionContext,
 ActionResult,
Expand Down

30 changes: 21 additions & 9 deletions
packages/types/src/ui-action.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,11 +367,23 @@ export interface ActionParam

/**
 * Enhanced Action Schema (ObjectStack Spec v2.0.1)
 * 
 * This is the primary action schema that should be used for all new implementations.
 * The legacy ActionSchema in crud.ts is maintained for backward compatibility.
 *
 * This is the primary action schema that should be used for all new
 * implementations. The legacy `ActionSchema` in `crud.ts` is maintained for
 * backward compatibility.
 *
 * ⚠️ Named `UIActionSchema`, which is the name `packages/types/src/index.ts`
 * has always PUBLISHED it under. It was declared as `ActionSchema` until
 * objectui#6349 — a second authority for a name `crud.ts` also declares, so an
 * IDE auto-import picked between two structurally unrelated types (9 shared
 * keys out of 28 each; `type` is the literal `'action'` there and
 * {@link ActionType} here) and the wrong pick surfaced as a remote `TS2322`.
 * The declaration now spells the published name; nothing outside this file
 * imported the old one, so the package's public surface is unchanged. See the
 * 2026-08-25 family ruling (objectui#6172, decision 甲/A1) and the recurrence
 * guard `scripts/__tests__/one-authority-per-exported-name-6273.test.ts`.
 */
export interface ActionSchema {
export interface UIActionSchema {
 /** Unique action identifier (snake_case) */
 name: string;

Expand DownExpand Up@@ -472,7 +484,7 @@ export interface ActionSchema {
 * `inline-action-api-params-to-body-extra` conversion (ADR-0087 D2).
 *
 * Declared here so the action renderers can forward it off a typed
 * `ActionSchema` rather than through an `as any` cast — the renderers are the
 * `UIActionSchema` rather than through an `as any` cast — the renderers are the
 * consumers this field exists for (objectstack#6837). Typed off the spec
 * rather than restated, so the shape cannot drift from the contract.
 */
Expand All@@ -491,7 +503,7 @@ export interface ActionSchema {
 * exactly that, so the key has one meaning everywhere it is honoured.
 *
 * Declared here for the same reason as {@link bodyExtra}: the action
 * renderers forward it off a typed `ActionSchema` instead of an `as any`
 * renderers forward it off a typed `UIActionSchema` instead of an `as any`
 * cast, and dropping it from those whitelists is what made a declared wrap
 * degrade silently to a flat body (objectstack#6938). Typed by derivation
 * from the spec so the union cannot drift from the contract.
Expand DownExpand Up@@ -583,7 +595,7 @@ export interface ActionGroup {
 icon?: string;

 /** Actions in this group */
 actions: ActionSchema[];
 actions: UIActionSchema[];

 /** Group visibility condition */
 visible?: string;
Expand DownExpand Up@@ -637,7 +649,7 @@ export interface ActionResult {
 * Action executor function type
 */
export type ActionExecutor = (
 action: ActionSchema,
 action: UIActionSchema,
 context: ActionContext,
 params?: Record<string, any>
) => Promise<ActionResult>;
Expand DownExpand Up@@ -698,7 +710,7 @@ export interface TransactionConfig {
 /** Timeout in milliseconds */
 timeout?: number;
 /** Actions to execute within the transaction */
 actions: ActionSchema[];
 actions: UIActionSchema[];
 /** Rollback action on failure */
 rollbackAction?: string;
 /** Whether to auto-retry on conflict */
Expand Down

6 changes: 3 additions & 3 deletions
scripts/__tests__/check-action-forward-parity.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,7 +98,7 @@ function repoWith(
 files: {
 [UI_VIEW]:
 overrides.view ??
 'export interface ActionSchema {\n name?: string;\n description?: string;\n}\n',
 'export interface UIActionSchema {\n name?: string;\n description?: string;\n}\n',
 [KEYS_MODULE]:
 overrides.keys ?? "export const RETIRED_ACTION_KEYS = {\n execute: 'renamed to target',\n};\n",
 [CONSUMER]:
Expand DownExpand Up@@ -388,7 +388,7 @@ describe('extraction failure throws rather than returning a clean verdict', () =
 });

 it('a renderer view with no properties is red', () => {
 expect(() => judge(repoWith('{ target }', { view: 'export interface ActionSchema {}\n' }))).toThrow(
 expect(() => judge(repoWith('{ target }', { view: 'export interface UIActionSchema {}\n' }))).toThrow(
 /declares no properties/,
 );
 });
Expand All@@ -409,7 +409,7 @@ describe('extraction failure throws rather than returning a clean verdict', () =
 // Authorable and runtime-read do not intersect at all: nothing would ever be
 // checked for this surface again.
 expect(() =>
 judge(repoWith('{ target }', { view: 'export interface ActionSchema {\n nothingReadsThis?: string;\n}\n' }), {
 judge(repoWith('{ target }', { view: 'export interface UIActionSchema {\n nothingReadsThis?: string;\n}\n' }), {
 spec: { declared: ['norThis'], inline: [] },
 }),
 ).toThrow(/owed set is empty/);
Expand Down

12 changes: 9 additions & 3 deletions
scripts/__tests__/one-authority-per-exported-name-6273.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -349,11 +349,17 @@ const filesOf = (sites: readonly Located[]): string[] => [
const KNOWN_COLLISIONS: ReadonlyMap<string, readonly string[]> = new Map([
 ['ActionContext', ['packages/core/src/actions/ActionRunner.ts', 'packages/types/src/ui-action.ts']],
 ['ActionResult', ['packages/core/src/actions/ActionRunner.ts', 'packages/types/src/ui-action.ts']],
 ['ActionSchema', ['packages/types/src/crud.ts', 'packages/types/src/ui-action.ts']],
 ['AggregationConfig', ['packages/plugin-grid/src/useGroupedData.ts', 'packages/types/src/data-protocol.ts']],
 ['AppShellProps', ['packages/app-shell/src/types.ts', 'packages/layout/src/AppShell.tsx']],
 ['BreadcrumbItem', ['packages/types/src/data-display.ts', 'packages/types/src/navigation.ts']],
 ['BreadcrumbSchema', ['packages/types/src/data-display.ts', 'packages/types/src/navigation.ts']],
 // `ActionSchema` sat here, colliding between `packages/types/src/crud.ts` and
 // `packages/types/src/ui-action.ts`. Structurally unrelated types — 28 members
 // each, 9 shared, `type` the literal `'action'` there and `ActionType` here — so
 // the remedy was the RENAME branch: ui-action's declaration now spells
 // `UIActionSchema`, the name `src/index.ts` always published it under
 // (objectui#6349). `BreadcrumbItem` / `BreadcrumbSchema` sat here too, colliding
 // between `packages/types/src/data-display.ts` and
 // `packages/types/src/navigation.ts`; data-display's were a strict SUBSET copy, so
 // that file re-points at navigation's one authority.
 ['CalendarEvent', ['packages/plugin-calendar/src/index.tsx', 'packages/types/src/complex.ts']], // the ruled-on objectui#5044 alias — see the header
 ['CalendarSchema', ['packages/plugin-calendar/src/ObjectCalendar.tsx', 'packages/types/src/form.ts']],
 ['ChatMessage', ['packages/plugin-chatbot/src/ChatbotEnhanced.tsx', 'packages/types/src/complex.ts']],
Expand Down

13 changes: 9 additions & 4 deletions
scripts/check-action-forward-parity.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -392,7 +392,12 @@ export function loadSpecSchemas(require = createRequire(import.meta.url)) {
}

/**
 * `@object-ui/types`' renderer VIEW of an action.
 * `@object-ui/types`' renderer VIEW of an action — `interface UIActionSchema`.
 *
 * ⚠️ It was `interface ActionSchema` until objectui#6349, a second authority for
 * a name `packages/types/src/crud.ts` also declares. The declaration now spells
 * the name the package always PUBLISHED it under (`UIActionSchema`); the type
 * and the file are unchanged.
 *
 * Declared surfaces are typed against this, not against the spec schema
 * directly — it carries renderer-only fields the spec does not model
Expand All@@ -408,16 +413,16 @@ export function uiActionViewKeys(root, file = UI_ACTION_VIEW) {
 }
 const sf = parse(root, file);
 for (const stmt of sf.statements) {
 if (!ts.isInterfaceDeclaration(stmt) || stmt.name.text !== "ActionSchema") continue;
 if (!ts.isInterfaceDeclaration(stmt) || stmt.name.text !== "UIActionSchema") continue;
 const keys = stmt.members
 .filter(ts.isPropertySignature)
 .map((m) => (m.name && (ts.isIdentifier(m.name) || ts.isStringLiteral(m.name)) ? m.name.text : null))
 .filter((n) => n !== null);
 if (keys.length === 0) fail(`\`ActionSchema\` in ${file} declares no properties — extraction failed.`);
 if (keys.length === 0) fail(`\`UIActionSchema\` in ${file} declares no properties — extraction failed.`);
 return keys;
 }
 fail(
 `\`interface ActionSchema\` not found in ${file}.\n` +
 `\`interface UIActionSchema\` not found in ${file}.\n` +
 " The renderer view moved or was renamed; re-point this gate at it."
 );
}
Expand Down

13 changes: 8 additions & 5 deletions
scripts/check-spec-symbol-derivation.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -243,11 +243,14 @@ const root = resolve(dirname(fileURLToPath(import.meta.url)), "..");
const ALLOW = {
 "@object-ui/types:ActionSchema": {
 reason:
 "Two deliberate objectui-side shapes, both documented at their declaration. " +
 "`ui-action.ts` is a renderer VIEW over the spec's action — it carries renderer-only " +
 "fields the spec does not model, while importing the spec-owned parts it does share " +
 "(`ActionLocation`, `ActionType`). `crud.ts` is the explicitly @deprecated legacy " +
 "shape kept for backward compatibility and slated for removal in a future major.",
 "`crud.ts`'s explicitly @deprecated legacy action shape, kept for backward " +
 "compatibility and slated for removal in a future major. ⚠️ This entry covered TWO " +
 "objectui-side shapes until objectui#6349: `ui-action.ts` declared a same-named " +
 "renderer VIEW over the spec's action (renderer-only fields the spec does not model, " +
 "importing the spec-owned parts it shares — `ActionLocation`, `ActionType`). That one " +
 "is now declared as `UIActionSchema`, the name the package always published it under, " +
 "so it no longer shadows a spec export and no longer needs excusing here. This entry " +
 "stays because `crud.ts` still carries the name.",
 issue: 4115,
 },
 "@object-ui/types:FormField": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
fix(types): one authority for `ActionSchema` and the Breadcrumb pair by os-sam · Pull Request #6936 · objectstack-ai/objectui · GitHub
Skip to content
fix(types): one authority for ActionSchema and the Breadcrumb pair#6936

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-sam
merged 1 commit into

from

Aug 31, 2026
 Merged


fix(types): one authority for ActionSchema and the Breadcrumb pair
#6936
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


43 changes: 43 additions & 0 deletions
.changeset/6349-types-internal-name-collisions-batch-1.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
---
'@object-ui/types': minor
---

Three exported type names inside `@object-ui/types` had two authorities each; each now has
one (objectui#6349, first batch — the three intra-package collisions from the 46-name
census on objectui#6273).

**`ActionSchema` — renamed, because the two shapes are unrelated.** `crud.ts` and
`ui-action.ts` both declared it. Measured member-by-member they share 9 keys out of 28 each:
`crud.ts` `extends BaseSchema` and pins `type: 'action'` (a UI node — a button in a
component tree), `ui-action.ts` extends nothing and types `type` as `ActionType` (a spec-v2
action definition, with `name`, `locations`, `params`, `target`). Re-pointing either at the
other would silently hand a consumer a different type, so this took the rename branch
(objectui#5044 is the precedent for choosing the surviving name). `ui-action.ts`'s
declaration is now spelled **`UIActionSchema`** — the name `src/index.ts` has always
PUBLISHED it under, via `export type { ActionSchema as UIActionSchema }`, which is now a
plain re-export. **The package's public surface is unchanged**: `ActionSchema` still means
`crud.ts`'s legacy shape and `UIActionSchema` still means `ui-action.ts`'s, exactly as
before. Nothing outside `ui-action.ts` imported the old spelling — there is no `./ui-action`
subpath in `exports`, so the old name was never reachable from outside the package.

**`BreadcrumbItem` / `BreadcrumbSchema` — re-pointed, because one copy was stale.** Both
were declared in `data-display.ts` and in `navigation.ts`. The data-display pair was not a
second dialect but a strict SUBSET: no key declared differently on either side, and missing
`BreadcrumbItem.icon` / `onClick` / `siblings` and `BreadcrumbSchema.maxItems`. Everything
that reads a breadcrumb was already on the navigation declaration — `registry.ts` maps the
`'breadcrumb'` component type to it, `src/index.ts` re-exports it under the bare names,
`zod/navigation.zod.ts` mirrors it (`icon`, `onClick`, `siblings`, `maxItems` included), the
`ui:breadcrumb` renderer consumes it, and the component's own documentation page documents
`icon` and `maxItems`. `data-display.ts` now re-exports the one authority.

**What changes for a consumer.** The `@object-ui/types/data-display` subpath is published, so
its `BreadcrumbItem` / `BreadcrumbSchema` and the `DataDisplaySchema` union's breadcrumb
member widen to the navigation declaration — they gain the four keys above. Nothing narrows
and no key changes type, so every value that type-checked before still does; what the subpath
now declares is what the renderer already honoured and the docs already described. Graded
`minor` because a published `.d.ts` member changes shape, per this repo's version-alignment
rule (never `major`).

The three `KNOWN_COLLISIONS` lines came down in the same change; that baseline
(`scripts/__tests__/one-authority-per-exported-name-6273.test.ts`) is shrink-only and fails in
both directions, so converging without deleting them would have been red too. 43 entries → 40.

48 changes: 21 additions & 27 deletions
packages/types/src/data-display.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@

import type { ChartType as SpecChartType } from '@objectstack/spec/ui';
import type { BaseSchema, SchemaNode } from './base.js';
import type { BreadcrumbSchema } from './navigation.js';

/**
 * Alert component
Expand DownExpand Up@@ -1644,34 +1645,27 @@ export interface TimelineSchema extends BaseSchema {
}

/**
 * Breadcrumb item
 */
export interface BreadcrumbItem {
 /**
 * Item label
 */
 label: string;
 /**
 * Item href/link
 */
 href?: string;
}

/**
 * Breadcrumb component
 * Breadcrumb — ONE authority, and it lives in `./navigation.ts`.
 *
 * This module declared its own `BreadcrumbItem` / `BreadcrumbSchema` until
 * objectui#6349. They were not a second dialect, they were a stale COPY: a
 * strict subset of the navigation declarations, missing `BreadcrumbItem.icon` /
 * `onClick` / `siblings` and `BreadcrumbSchema.maxItems`, with no key declared
 * differently on either side. Everything that actually reads a breadcrumb was
 * already on the navigation declaration — `registry.ts` maps the `'breadcrumb'`
 * component type to it, `packages/types/src/index.ts` re-exports it under the
 * bare names, `zod/navigation.zod.ts` mirrors it, and
 * `content/docs/components/data-display/breadcrumb.mdx` documents `icon` and
 * `maxItems` on THIS page. The copy's only reach was the
 * `@object-ui/types/data-display` subpath and the {@link DataDisplaySchema}
 * union below, both of which under-declared what the renderer honours.
 *
 * A re-export is one declaration with a second export site, which is exactly
 * how this monorepo is meant to fan a type out; the recurrence guard
 * (`scripts/__tests__/one-authority-per-exported-name-6273.test.ts`) does not
 * count it. 2026-08-25 family ruling, objectui#6172 decision 甲/A1.
 */
export interface BreadcrumbSchema extends BaseSchema {
 type: 'breadcrumb';
 /**
 * Breadcrumb items
 */
 items: BreadcrumbItem[];
 /**
 * Separator character
 * @default '/'
 */
 separator?: string;
}
export type { BreadcrumbItem, BreadcrumbSchema } from './navigation.js';

/**
 * Keyboard key component
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1034,7 +1034,7 @@ export type {
 ObjectUiLocalParamFieldType,
 ResolvableParamFieldType,
 ActionParam,
ActionSchema as UIActionSchema,
 UIActionSchema,
 ActionGroup,
 ActionContext,
 ActionResult,
Expand Down

30 changes: 21 additions & 9 deletions
packages/types/src/ui-action.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,11 +367,23 @@ export interface ActionParam

/**
 * Enhanced Action Schema (ObjectStack Spec v2.0.1)
 * 
 * This is the primary action schema that should be used for all new implementations.
 * The legacy ActionSchema in crud.ts is maintained for backward compatibility.
 *
 * This is the primary action schema that should be used for all new
 * implementations. The legacy `ActionSchema` in `crud.ts` is maintained for
 * backward compatibility.
 *
 * ⚠️ Named `UIActionSchema`, which is the name `packages/types/src/index.ts`
 * has always PUBLISHED it under. It was declared as `ActionSchema` until
 * objectui#6349 — a second authority for a name `crud.ts` also declares, so an
 * IDE auto-import picked between two structurally unrelated types (9 shared
 * keys out of 28 each; `type` is the literal `'action'` there and
 * {@link ActionType} here) and the wrong pick surfaced as a remote `TS2322`.
 * The declaration now spells the published name; nothing outside this file
 * imported the old one, so the package's public surface is unchanged. See the
 * 2026-08-25 family ruling (objectui#6172, decision 甲/A1) and the recurrence
 * guard `scripts/__tests__/one-authority-per-exported-name-6273.test.ts`.
 */
export interface ActionSchema {
export interface UIActionSchema {
 /** Unique action identifier (snake_case) */
 name: string;

Expand DownExpand Up@@ -472,7 +484,7 @@ export interface ActionSchema {
 * `inline-action-api-params-to-body-extra` conversion (ADR-0087 D2).
 *
 * Declared here so the action renderers can forward it off a typed
 * `ActionSchema` rather than through an `as any` cast — the renderers are the
 * `UIActionSchema` rather than through an `as any` cast — the renderers are the
 * consumers this field exists for (objectstack#6837). Typed off the spec
 * rather than restated, so the shape cannot drift from the contract.
 */
Expand All@@ -491,7 +503,7 @@ export interface ActionSchema {
 * exactly that, so the key has one meaning everywhere it is honoured.
 *
 * Declared here for the same reason as {@link bodyExtra}: the action
 * renderers forward it off a typed `ActionSchema` instead of an `as any`
 * renderers forward it off a typed `UIActionSchema` instead of an `as any`
 * cast, and dropping it from those whitelists is what made a declared wrap
 * degrade silently to a flat body (objectstack#6938). Typed by derivation
 * from the spec so the union cannot drift from the contract.
Expand DownExpand Up@@ -583,7 +595,7 @@ export interface ActionGroup {
 icon?: string;

 /** Actions in this group */
 actions: ActionSchema[];
 actions: UIActionSchema[];

 /** Group visibility condition */
 visible?: string;
Expand DownExpand Up@@ -637,7 +649,7 @@ export interface ActionResult {
 * Action executor function type
 */
export type ActionExecutor = (
 action: ActionSchema,
 action: UIActionSchema,
 context: ActionContext,
 params?: Record<string, any>
) => Promise<ActionResult>;
Expand DownExpand Up@@ -698,7 +710,7 @@ export interface TransactionConfig {
 /** Timeout in milliseconds */
 timeout?: number;
 /** Actions to execute within the transaction */
 actions: ActionSchema[];
 actions: UIActionSchema[];
 /** Rollback action on failure */
 rollbackAction?: string;
 /** Whether to auto-retry on conflict */
Expand Down

6 changes: 3 additions & 3 deletions
scripts/__tests__/check-action-forward-parity.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,7 +98,7 @@ function repoWith(
 files: {
 [UI_VIEW]:
 overrides.view ??
 'export interface ActionSchema {\n name?: string;\n description?: string;\n}\n',
 'export interface UIActionSchema {\n name?: string;\n description?: string;\n}\n',
 [KEYS_MODULE]:
 overrides.keys ?? "export const RETIRED_ACTION_KEYS = {\n execute: 'renamed to target',\n};\n",
 [CONSUMER]:
Expand DownExpand Up@@ -388,7 +388,7 @@ describe('extraction failure throws rather than returning a clean verdict', () =
 });

 it('a renderer view with no properties is red', () => {
 expect(() => judge(repoWith('{ target }', { view: 'export interface ActionSchema {}\n' }))).toThrow(
 expect(() => judge(repoWith('{ target }', { view: 'export interface UIActionSchema {}\n' }))).toThrow(
 /declares no properties/,
 );
 });
Expand All@@ -409,7 +409,7 @@ describe('extraction failure throws rather than returning a clean verdict', () =
 // Authorable and runtime-read do not intersect at all: nothing would ever be
 // checked for this surface again.
 expect(() =>
 judge(repoWith('{ target }', { view: 'export interface ActionSchema {\n nothingReadsThis?: string;\n}\n' }), {
 judge(repoWith('{ target }', { view: 'export interface UIActionSchema {\n nothingReadsThis?: string;\n}\n' }), {
 spec: { declared: ['norThis'], inline: [] },
 }),
 ).toThrow(/owed set is empty/);
Expand Down

12 changes: 9 additions & 3 deletions
scripts/__tests__/one-authority-per-exported-name-6273.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -349,11 +349,17 @@ const filesOf = (sites: readonly Located[]): string[] => [
const KNOWN_COLLISIONS: ReadonlyMap<string, readonly string[]> = new Map([
 ['ActionContext', ['packages/core/src/actions/ActionRunner.ts', 'packages/types/src/ui-action.ts']],
 ['ActionResult', ['packages/core/src/actions/ActionRunner.ts', 'packages/types/src/ui-action.ts']],
 ['ActionSchema', ['packages/types/src/crud.ts', 'packages/types/src/ui-action.ts']],
 ['AggregationConfig', ['packages/plugin-grid/src/useGroupedData.ts', 'packages/types/src/data-protocol.ts']],
 ['AppShellProps', ['packages/app-shell/src/types.ts', 'packages/layout/src/AppShell.tsx']],
 ['BreadcrumbItem', ['packages/types/src/data-display.ts', 'packages/types/src/navigation.ts']],
 ['BreadcrumbSchema', ['packages/types/src/data-display.ts', 'packages/types/src/navigation.ts']],
 // `ActionSchema` sat here, colliding between `packages/types/src/crud.ts` and
 // `packages/types/src/ui-action.ts`. Structurally unrelated types — 28 members
 // each, 9 shared, `type` the literal `'action'` there and `ActionType` here — so
 // the remedy was the RENAME branch: ui-action's declaration now spells
 // `UIActionSchema`, the name `src/index.ts` always published it under
 // (objectui#6349). `BreadcrumbItem` / `BreadcrumbSchema` sat here too, colliding
 // between `packages/types/src/data-display.ts` and
 // `packages/types/src/navigation.ts`; data-display's were a strict SUBSET copy, so
 // that file re-points at navigation's one authority.
 ['CalendarEvent', ['packages/plugin-calendar/src/index.tsx', 'packages/types/src/complex.ts']], // the ruled-on objectui#5044 alias — see the header
 ['CalendarSchema', ['packages/plugin-calendar/src/ObjectCalendar.tsx', 'packages/types/src/form.ts']],
 ['ChatMessage', ['packages/plugin-chatbot/src/ChatbotEnhanced.tsx', 'packages/types/src/complex.ts']],
Expand Down

13 changes: 9 additions & 4 deletions
scripts/check-action-forward-parity.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -392,7 +392,12 @@ export function loadSpecSchemas(require = createRequire(import.meta.url)) {
}

/**
 * `@object-ui/types`' renderer VIEW of an action.
 * `@object-ui/types`' renderer VIEW of an action — `interface UIActionSchema`.
 *
 * ⚠️ It was `interface ActionSchema` until objectui#6349, a second authority for
 * a name `packages/types/src/crud.ts` also declares. The declaration now spells
 * the name the package always PUBLISHED it under (`UIActionSchema`); the type
 * and the file are unchanged.
 *
 * Declared surfaces are typed against this, not against the spec schema
 * directly — it carries renderer-only fields the spec does not model
Expand All@@ -408,16 +413,16 @@ export function uiActionViewKeys(root, file = UI_ACTION_VIEW) {
 }
 const sf = parse(root, file);
 for (const stmt of sf.statements) {
 if (!ts.isInterfaceDeclaration(stmt) || stmt.name.text !== "ActionSchema") continue;
 if (!ts.isInterfaceDeclaration(stmt) || stmt.name.text !== "UIActionSchema") continue;
 const keys = stmt.members
 .filter(ts.isPropertySignature)
 .map((m) => (m.name && (ts.isIdentifier(m.name) || ts.isStringLiteral(m.name)) ? m.name.text : null))
 .filter((n) => n !== null);
 if (keys.length === 0) fail(`\`ActionSchema\` in ${file} declares no properties — extraction failed.`);
 if (keys.length === 0) fail(`\`UIActionSchema\` in ${file} declares no properties — extraction failed.`);
 return keys;
 }
 fail(
 `\`interface ActionSchema\` not found in ${file}.\n` +
 `\`interface UIActionSchema\` not found in ${file}.\n` +
 " The renderer view moved or was renamed; re-point this gate at it."
 );
}
Expand Down

13 changes: 8 additions & 5 deletions
scripts/check-spec-symbol-derivation.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -243,11 +243,14 @@ const root = resolve(dirname(fileURLToPath(import.meta.url)), "..");
const ALLOW = {
 "@object-ui/types:ActionSchema": {
 reason:
 "Two deliberate objectui-side shapes, both documented at their declaration. " +
 "`ui-action.ts` is a renderer VIEW over the spec's action — it carries renderer-only " +
 "fields the spec does not model, while importing the spec-owned parts it does share " +
 "(`ActionLocation`, `ActionType`). `crud.ts` is the explicitly @deprecated legacy " +
 "shape kept for backward compatibility and slated for removal in a future major.",
 "`crud.ts`'s explicitly @deprecated legacy action shape, kept for backward " +
 "compatibility and slated for removal in a future major. ⚠️ This entry covered TWO " +
 "objectui-side shapes until objectui#6349: `ui-action.ts` declared a same-named " +
 "renderer VIEW over the spec's action (renderer-only fields the spec does not model, " +
 "importing the spec-owned parts it shares — `ActionLocation`, `ActionType`). That one " +
 "is now declared as `UIActionSchema`, the name the package always published it under, " +
 "so it no longer shadows a spec export and no longer needs excusing here. This entry " +
 "stays because `crud.ts` still carries the name.",
 issue: 4115,
 },
 "@object-ui/types:FormField": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
fix(types): one authority for `ActionSchema` and the Breadcrumb pair by os-sam · Pull Request #6936 · objectstack-ai/objectui · GitHub
Skip to content
fix(types): one authority for ActionSchema and the Breadcrumb pair#6936

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-sam
merged 1 commit into

from

Aug 31, 2026
 Merged


fix(types): one authority for ActionSchema and the Breadcrumb pair
#6936
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


43 changes: 43 additions & 0 deletions
.changeset/6349-types-internal-name-collisions-batch-1.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
---
'@object-ui/types': minor
---

Three exported type names inside `@object-ui/types` had two authorities each; each now has
one (objectui#6349, first batch — the three intra-package collisions from the 46-name
census on objectui#6273).

**`ActionSchema` — renamed, because the two shapes are unrelated.** `crud.ts` and
`ui-action.ts` both declared it. Measured member-by-member they share 9 keys out of 28 each:
`crud.ts` `extends BaseSchema` and pins `type: 'action'` (a UI node — a button in a
component tree), `ui-action.ts` extends nothing and types `type` as `ActionType` (a spec-v2
action definition, with `name`, `locations`, `params`, `target`). Re-pointing either at the
other would silently hand a consumer a different type, so this took the rename branch
(objectui#5044 is the precedent for choosing the surviving name). `ui-action.ts`'s
declaration is now spelled **`UIActionSchema`** — the name `src/index.ts` has always
PUBLISHED it under, via `export type { ActionSchema as UIActionSchema }`, which is now a
plain re-export. **The package's public surface is unchanged**: `ActionSchema` still means
`crud.ts`'s legacy shape and `UIActionSchema` still means `ui-action.ts`'s, exactly as
before. Nothing outside `ui-action.ts` imported the old spelling — there is no `./ui-action`
subpath in `exports`, so the old name was never reachable from outside the package.

**`BreadcrumbItem` / `BreadcrumbSchema` — re-pointed, because one copy was stale.** Both
were declared in `data-display.ts` and in `navigation.ts`. The data-display pair was not a
second dialect but a strict SUBSET: no key declared differently on either side, and missing
`BreadcrumbItem.icon` / `onClick` / `siblings` and `BreadcrumbSchema.maxItems`. Everything
that reads a breadcrumb was already on the navigation declaration — `registry.ts` maps the
`'breadcrumb'` component type to it, `src/index.ts` re-exports it under the bare names,
`zod/navigation.zod.ts` mirrors it (`icon`, `onClick`, `siblings`, `maxItems` included), the
`ui:breadcrumb` renderer consumes it, and the component's own documentation page documents
`icon` and `maxItems`. `data-display.ts` now re-exports the one authority.

**What changes for a consumer.** The `@object-ui/types/data-display` subpath is published, so
its `BreadcrumbItem` / `BreadcrumbSchema` and the `DataDisplaySchema` union's breadcrumb
member widen to the navigation declaration — they gain the four keys above. Nothing narrows
and no key changes type, so every value that type-checked before still does; what the subpath
now declares is what the renderer already honoured and the docs already described. Graded
`minor` because a published `.d.ts` member changes shape, per this repo's version-alignment
rule (never `major`).

The three `KNOWN_COLLISIONS` lines came down in the same change; that baseline
(`scripts/__tests__/one-authority-per-exported-name-6273.test.ts`) is shrink-only and fails in
both directions, so converging without deleting them would have been red too. 43 entries → 40.

48 changes: 21 additions & 27 deletions
packages/types/src/data-display.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@

import type { ChartType as SpecChartType } from '@objectstack/spec/ui';
import type { BaseSchema, SchemaNode } from './base.js';
import type { BreadcrumbSchema } from './navigation.js';

/**
 * Alert component
Expand DownExpand Up@@ -1644,34 +1645,27 @@ export interface TimelineSchema extends BaseSchema {
}

/**
 * Breadcrumb item
 */
export interface BreadcrumbItem {
 /**
 * Item label
 */
 label: string;
 /**
 * Item href/link
 */
 href?: string;
}

/**
 * Breadcrumb component
 * Breadcrumb — ONE authority, and it lives in `./navigation.ts`.
 *
 * This module declared its own `BreadcrumbItem` / `BreadcrumbSchema` until
 * objectui#6349. They were not a second dialect, they were a stale COPY: a
 * strict subset of the navigation declarations, missing `BreadcrumbItem.icon` /
 * `onClick` / `siblings` and `BreadcrumbSchema.maxItems`, with no key declared
 * differently on either side. Everything that actually reads a breadcrumb was
 * already on the navigation declaration — `registry.ts` maps the `'breadcrumb'`
 * component type to it, `packages/types/src/index.ts` re-exports it under the
 * bare names, `zod/navigation.zod.ts` mirrors it, and
 * `content/docs/components/data-display/breadcrumb.mdx` documents `icon` and
 * `maxItems` on THIS page. The copy's only reach was the
 * `@object-ui/types/data-display` subpath and the {@link DataDisplaySchema}
 * union below, both of which under-declared what the renderer honours.
 *
 * A re-export is one declaration with a second export site, which is exactly
 * how this monorepo is meant to fan a type out; the recurrence guard
 * (`scripts/__tests__/one-authority-per-exported-name-6273.test.ts`) does not
 * count it. 2026-08-25 family ruling, objectui#6172 decision 甲/A1.
 */
export interface BreadcrumbSchema extends BaseSchema {
 type: 'breadcrumb';
 /**
 * Breadcrumb items
 */
 items: BreadcrumbItem[];
 /**
 * Separator character
 * @default '/'
 */
 separator?: string;
}
export type { BreadcrumbItem, BreadcrumbSchema } from './navigation.js';

/**
 * Keyboard key component
Expand Down

2 changes: 1 addition & 1 deletion
packages/types/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1034,7 +1034,7 @@ export type {
 ObjectUiLocalParamFieldType,
 ResolvableParamFieldType,
 ActionParam,
ActionSchema as UIActionSchema,
 UIActionSchema,
 ActionGroup,
 ActionContext,
 ActionResult,
Expand Down

30 changes: 21 additions & 9 deletions
packages/types/src/ui-action.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,11 +367,23 @@ export interface ActionParam

/**
 * Enhanced Action Schema (ObjectStack Spec v2.0.1)
 * 
 * This is the primary action schema that should be used for all new implementations.
 * The legacy ActionSchema in crud.ts is maintained for backward compatibility.
 *
 * This is the primary action schema that should be used for all new
 * implementations. The legacy `ActionSchema` in `crud.ts` is maintained for
 * backward compatibility.
 *
 * ⚠️ Named `UIActionSchema`, which is the name `packages/types/src/index.ts`
 * has always PUBLISHED it under. It was declared as `ActionSchema` until
 * objectui#6349 — a second authority for a name `crud.ts` also declares, so an
 * IDE auto-import picked between two structurally unrelated types (9 shared
 * keys out of 28 each; `type` is the literal `'action'` there and
 * {@link ActionType} here) and the wrong pick surfaced as a remote `TS2322`.
 * The declaration now spells the published name; nothing outside this file
 * imported the old one, so the package's public surface is unchanged. See the
 * 2026-08-25 family ruling (objectui#6172, decision 甲/A1) and the recurrence
 * guard `scripts/__tests__/one-authority-per-exported-name-6273.test.ts`.
 */
export interface ActionSchema {
export interface UIActionSchema {
 /** Unique action identifier (snake_case) */
 name: string;

Expand DownExpand Up@@ -472,7 +484,7 @@ export interface ActionSchema {
 * `inline-action-api-params-to-body-extra` conversion (ADR-0087 D2).
 *
 * Declared here so the action renderers can forward it off a typed
 * `ActionSchema` rather than through an `as any` cast — the renderers are the
 * `UIActionSchema` rather than through an `as any` cast — the renderers are the
 * consumers this field exists for (objectstack#6837). Typed off the spec
 * rather than restated, so the shape cannot drift from the contract.
 */
Expand All@@ -491,7 +503,7 @@ export interface ActionSchema {
 * exactly that, so the key has one meaning everywhere it is honoured.
 *
 * Declared here for the same reason as {@link bodyExtra}: the action
 * renderers forward it off a typed `ActionSchema` instead of an `as any`
 * renderers forward it off a typed `UIActionSchema` instead of an `as any`
 * cast, and dropping it from those whitelists is what made a declared wrap
 * degrade silently to a flat body (objectstack#6938). Typed by derivation
 * from the spec so the union cannot drift from the contract.
Expand DownExpand Up@@ -583,7 +595,7 @@ export interface ActionGroup {
 icon?: string;

 /** Actions in this group */
 actions: ActionSchema[];
 actions: UIActionSchema[];

 /** Group visibility condition */
 visible?: string;
Expand DownExpand Up@@ -637,7 +649,7 @@ export interface ActionResult {
 * Action executor function type
 */
export type ActionExecutor = (
 action: ActionSchema,
 action: UIActionSchema,
 context: ActionContext,
 params?: Record<string, any>
) => Promise<ActionResult>;
Expand DownExpand Up@@ -698,7 +710,7 @@ export interface TransactionConfig {
 /** Timeout in milliseconds */
 timeout?: number;
 /** Actions to execute within the transaction */
 actions: ActionSchema[];
 actions: UIActionSchema[];
 /** Rollback action on failure */
 rollbackAction?: string;
 /** Whether to auto-retry on conflict */
Expand Down

6 changes: 3 additions & 3 deletions
scripts/__tests__/check-action-forward-parity.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -98,7 +98,7 @@ function repoWith(
 files: {
 [UI_VIEW]:
 overrides.view ??
 'export interface ActionSchema {\n name?: string;\n description?: string;\n}\n',
 'export interface UIActionSchema {\n name?: string;\n description?: string;\n}\n',
 [KEYS_MODULE]:
 overrides.keys ?? "export const RETIRED_ACTION_KEYS = {\n execute: 'renamed to target',\n};\n",
 [CONSUMER]:
Expand DownExpand Up@@ -388,7 +388,7 @@ describe('extraction failure throws rather than returning a clean verdict', () =
 });

 it('a renderer view with no properties is red', () => {
 expect(() => judge(repoWith('{ target }', { view: 'export interface ActionSchema {}\n' }))).toThrow(
 expect(() => judge(repoWith('{ target }', { view: 'export interface UIActionSchema {}\n' }))).toThrow(
 /declares no properties/,
 );
 });
Expand All@@ -409,7 +409,7 @@ describe('extraction failure throws rather than returning a clean verdict', () =
 // Authorable and runtime-read do not intersect at all: nothing would ever be
 // checked for this surface again.
 expect(() =>
 judge(repoWith('{ target }', { view: 'export interface ActionSchema {\n nothingReadsThis?: string;\n}\n' }), {
 judge(repoWith('{ target }', { view: 'export interface UIActionSchema {\n nothingReadsThis?: string;\n}\n' }), {
 spec: { declared: ['norThis'], inline: [] },
 }),
 ).toThrow(/owed set is empty/);
Expand Down

12 changes: 9 additions & 3 deletions
scripts/__tests__/one-authority-per-exported-name-6273.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -349,11 +349,17 @@ const filesOf = (sites: readonly Located[]): string[] => [
const KNOWN_COLLISIONS: ReadonlyMap<string, readonly string[]> = new Map([
 ['ActionContext', ['packages/core/src/actions/ActionRunner.ts', 'packages/types/src/ui-action.ts']],
 ['ActionResult', ['packages/core/src/actions/ActionRunner.ts', 'packages/types/src/ui-action.ts']],
 ['ActionSchema', ['packages/types/src/crud.ts', 'packages/types/src/ui-action.ts']],
 ['AggregationConfig', ['packages/plugin-grid/src/useGroupedData.ts', 'packages/types/src/data-protocol.ts']],
 ['AppShellProps', ['packages/app-shell/src/types.ts', 'packages/layout/src/AppShell.tsx']],
 ['BreadcrumbItem', ['packages/types/src/data-display.ts', 'packages/types/src/navigation.ts']],
 ['BreadcrumbSchema', ['packages/types/src/data-display.ts', 'packages/types/src/navigation.ts']],
 // `ActionSchema` sat here, colliding between `packages/types/src/crud.ts` and
 // `packages/types/src/ui-action.ts`. Structurally unrelated types — 28 members
 // each, 9 shared, `type` the literal `'action'` there and `ActionType` here — so
 // the remedy was the RENAME branch: ui-action's declaration now spells
 // `UIActionSchema`, the name `src/index.ts` always published it under
 // (objectui#6349). `BreadcrumbItem` / `BreadcrumbSchema` sat here too, colliding
 // between `packages/types/src/data-display.ts` and
 // `packages/types/src/navigation.ts`; data-display's were a strict SUBSET copy, so
 // that file re-points at navigation's one authority.
 ['CalendarEvent', ['packages/plugin-calendar/src/index.tsx', 'packages/types/src/complex.ts']], // the ruled-on objectui#5044 alias — see the header
 ['CalendarSchema', ['packages/plugin-calendar/src/ObjectCalendar.tsx', 'packages/types/src/form.ts']],
 ['ChatMessage', ['packages/plugin-chatbot/src/ChatbotEnhanced.tsx', 'packages/types/src/complex.ts']],
Expand Down

13 changes: 9 additions & 4 deletions
scripts/check-action-forward-parity.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -392,7 +392,12 @@ export function loadSpecSchemas(require = createRequire(import.meta.url)) {
}

/**
 * `@object-ui/types`' renderer VIEW of an action.
 * `@object-ui/types`' renderer VIEW of an action — `interface UIActionSchema`.
 *
 * ⚠️ It was `interface ActionSchema` until objectui#6349, a second authority for
 * a name `packages/types/src/crud.ts` also declares. The declaration now spells
 * the name the package always PUBLISHED it under (`UIActionSchema`); the type
 * and the file are unchanged.
 *
 * Declared surfaces are typed against this, not against the spec schema
 * directly — it carries renderer-only fields the spec does not model
Expand All@@ -408,16 +413,16 @@ export function uiActionViewKeys(root, file = UI_ACTION_VIEW) {
 }
 const sf = parse(root, file);
 for (const stmt of sf.statements) {
 if (!ts.isInterfaceDeclaration(stmt) || stmt.name.text !== "ActionSchema") continue;
 if (!ts.isInterfaceDeclaration(stmt) || stmt.name.text !== "UIActionSchema") continue;
 const keys = stmt.members
 .filter(ts.isPropertySignature)
 .map((m) => (m.name && (ts.isIdentifier(m.name) || ts.isStringLiteral(m.name)) ? m.name.text : null))
 .filter((n) => n !== null);
 if (keys.length === 0) fail(`\`ActionSchema\` in ${file} declares no properties — extraction failed.`);
 if (keys.length === 0) fail(`\`UIActionSchema\` in ${file} declares no properties — extraction failed.`);
 return keys;
 }
 fail(
 `\`interface ActionSchema\` not found in ${file}.\n` +
 `\`interface UIActionSchema\` not found in ${file}.\n` +
 " The renderer view moved or was renamed; re-point this gate at it."
 );
}
Expand Down

13 changes: 8 additions & 5 deletions
scripts/check-spec-symbol-derivation.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -243,11 +243,14 @@ const root = resolve(dirname(fileURLToPath(import.meta.url)), "..");
const ALLOW = {
 "@object-ui/types:ActionSchema": {
 reason:
 "Two deliberate objectui-side shapes, both documented at their declaration. " +
 "`ui-action.ts` is a renderer VIEW over the spec's action — it carries renderer-only " +
 "fields the spec does not model, while importing the spec-owned parts it does share " +
 "(`ActionLocation`, `ActionType`). `crud.ts` is the explicitly @deprecated legacy " +
 "shape kept for backward compatibility and slated for removal in a future major.",
 "`crud.ts`'s explicitly @deprecated legacy action shape, kept for backward " +
 "compatibility and slated for removal in a future major. ⚠️ This entry covered TWO " +
 "objectui-side shapes until objectui#6349: `ui-action.ts` declared a same-named " +
 "renderer VIEW over the spec's action (renderer-only fields the spec does not model, " +
 "importing the spec-owned parts it shares — `ActionLocation`, `ActionType`). That one " +
 "is now declared as `UIActionSchema`, the name the package always published it under, " +
 "so it no longer shadows a spec export and no longer needs excusing here. This entry " +
 "stays because `crud.ts` still carries the name.",
 issue: 4115,
 },
 "@object-ui/types:FormField": {
Expand Down
Loading