@object-ui/core 16.1.0 → 17.1.0

package/dist/registry/Registry.js

@@ -31,6 +31,19 @@ export class Registry {
             writable: true,
             value: new Set()
         });
+        /**
+         * Bumped whenever the set of KNOWN types changes — a registration, an
+         * unregistration, or a new lazy stub. A cheap cache key for consumers that
+         * derive something from the whole registry (whitelists, manifests, palettes)
+         * and need to rebuild when it grows. Counting types is not a substitute: a
+         * registration paired with an unregistration leaves the count untouched.
+         */
+        Object.defineProperty(this, "version", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 0
+        });
     }
     /**
      * Register a component with optional namespace support.
@@ -144,6 +157,10 @@ export class Registry {
         if (meta?.namespace && !meta?.skipFallback) {
             this.lazyEntries.set(type, entry);
         }
+        // Bump the version but do NOT notify: the set of KNOWN types grew, so
+        // whitelists and manifests must rebuild, but nothing new can render yet —
+        // waking every subscriber for each stub at boot would be pure churn.
+        this.version++;
     }
     /**
      * Returns true if `type` (or its namespaced form) has a registered lazy
@@ -186,6 +203,7 @@ export class Registry {
         };
     }
     notify() {
+        this.version++;
         for (const listener of this.listeners) {
             try {
                 listener();
@@ -195,6 +213,13 @@ export class Registry {
             }
         }
     }
+    /**
+     * Monotonic counter of changes to the set of known types. Rebuild anything
+     * derived from the whole registry when this moves — see {@link getKnownTypes}.
+     */
+    getVersion() {
+        return this.version;
+    }
     /**
      * Get a component by type. Supports both namespaced and non-namespaced lookups.
      *
@@ -226,6 +251,13 @@ export class Registry {
     /**
      * Get component configuration by type with namespace support.
      *
+     * LOADED registrations only — a type that exists solely as a `registerLazy`
+     * stub returns `undefined` here, because callers read `.component` off the
+     * result and a stub has no renderer until its loader runs. The *contract*
+     * question ("is this tag part of the public surface?") must not depend on
+     * load order, so {@link getPublicConfigs} resolves lazy stubs separately
+     * (objectui#2953). Use {@link hasLazy} / {@link loadLazy} to reach a stub.
+     *
      * @param type - Component type (e.g., 'button' or 'ui:button')
      * @param namespace - Optional namespace for lookup priority
      * @returns Component configuration or undefined
@@ -256,13 +288,47 @@ export class Registry {
         return this.components.has(type);
     }
     /**
-     * Get all registered component types.
+     * Get all LOADED component types — what can be rendered right now.
+     *
+     * Pending `registerLazy` stubs are not included; use {@link getKnownTypes}
+     * for the question "is this a type this app knows about", which is what a
+     * whitelist or manifest wants (objectui#2953).
      *
      * @returns Array of all component type identifiers
      */
     getAllTypes() {
         return Array.from(this.components.keys());
     }
+    /**
+     * Every type the registry can resolve — loaded registrations PLUS pending
+     * lazy stubs, deduped. Both the bare and namespaced keys are included, as
+     * they are in {@link getAllTypes}.
+     *
+     * This is the set to build a whitelist or a manifest from. Keying one off
+     * `getAllTypes()` instead makes it depend on which plugin chunks happen to
+     * have loaded: a lazily-registered block gets rejected as unknown, and
+     * whether it does varies by session (objectui#2953).
+     */
+    getKnownTypes() {
+        return Array.from(new Set([...this.components.keys(), ...this.lazyEntries.keys()]));
+    }
+    /**
+     * Metadata for `type` — from the loaded registration when there is one,
+     * otherwise from a pending `registerLazy` stub.
+     *
+     * Use this when you need to know what a type IS (namespace, container-ness,
+     * declared inputs). {@link getConfig} answers a different question — "can I
+     * render this right now" — and is deliberately loaded-only, since callers
+     * read `.component` off it.
+     *
+     * A stub carries only what `registerLazy` was given, so `inputs` is usually
+     * absent until the chunk loads. Consumers should treat that as "not yet
+     * known", not as "declares no props".
+     */
+    getMeta(type, namespace) {
+        const key = namespace ? `${namespace}:${type}` : type;
+        return this.components.get(key) ?? this.lazyEntries.get(key)?.meta;
+    }
     /**
      * Get all registered component configurations.
      *
@@ -271,10 +337,39 @@ export class Registry {
     getAllConfigs() {
         return Array.from(this.components.values());
     }
+    /**
+     * Resolve `tag` for the CONTRACT surface: the loaded registration when the
+     * component is already in the registry, otherwise the metadata of a pending
+     * `registerLazy` stub.
+     *
+     * A block registered lazily is a first-class member of the contract — the
+     * loader is recorded at boot and the plugin chunk is imported on first use —
+     * so contract membership must not hinge on whether that import happened to
+     * have run yet (objectui#2953).
+     */
+    getContractConfig(tag) {
+        const loaded = this.components.get(tag);
+        if (loaded)
+            return loaded;
+        const entry = this.lazyEntries.get(tag);
+        if (!entry)
+            return undefined;
+        // Mirror registerLazy's key derivation so the canonical `type` matches the
+        // one `register()` will store once the loader runs — that keeps the dedupe
+        // below stable across the load. `tag` may already carry the namespace
+        // (lazyEntries holds both keys; curated tags like `record:details` are
+        // themselves colon-shaped), so don't prefix it twice.
+        const ns = entry.meta?.namespace;
+        const canonical = ns && !tag.startsWith(`${ns}:`) ? `${ns}:${tag}` : tag;
+        return { ...entry.meta, type: canonical, lazy: true };
+    }
     /**
      * Get the curated PUBLIC-tier component configs (ADR-0080) — those registered
      * with `tier: 'public'`. This is the contract/AI-vocabulary surface, a subset
      * of the full rendering capability returned by {@link getAllConfigs}.
+     *
+     * Includes blocks that are only lazily registered so far; those come back
+     * with `lazy: true` and no `component` (see {@link PublicComponentConfig}).
      */
     getPublicConfigs() {
         // Dedupe by the config's canonical (namespaced) `type` — a component is
@@ -292,12 +387,17 @@ export class Registry {
         };
         // Curated contract list first (stable, reviewable order) …
         for (const tag of PUBLIC_BLOCKS)
-            add(tag, this.getConfig(tag));
+            add(tag, this.getContractConfig(tag));
         // … plus any bare registration that opted in explicitly via `tier: 'public'`.
         for (const [key, cfg] of this.components.entries()) {
             if (cfg.tier === 'public' && !key.includes(':'))
                 add(key, cfg);
         }
+        // … and the same opt-in for stubs whose loader has not run yet.
+        for (const [key, entry] of this.lazyEntries.entries()) {
+            if (entry.meta?.tier === 'public' && !key.includes(':'))
+                add(key, this.getContractConfig(key));
+        }
         return out;
     }
     /**

package/dist/registry/public-blocks.js

@@ -42,7 +42,58 @@ export const PUBLIC_BLOCKS = [
     'record:highlights',
     'record:related_list',
     'record:path',
-    'line_items',
+    // `record:`-prefixed, like its four siblings above. @object-ui/plugin-form
+    // registers this one with `skipFallback: true`, so the bare `line_items` key
+    // it was listed under here never existed — the block has shipped all along
+    // but could never resolve through the contract (objectui#2953 follow-up).
+    'record:line_items',
+    // Configurable as of objectui#3023 follow-up: these shipped with renderers
+    // but no declared `inputs`, so a model could only emit them bare — which is
+    // why they sat outside the contract. Their inputs now mirror what the
+    // renderers actually read, so they are authorable and belong here.
+    //
+    // `record:chatter` is deliberately NOT in this list: it is the same renderer
+    // as `record:discussion` under a Salesforce-familiar name, kept for schemas
+    // already in the wild. Two spellings of one block is ambiguity an authoring
+    // model has no way to resolve, so the vocabulary carries the spec's name.
+    'record:activity',
+    'record:discussion',
+    'record:history',
+    'record:quick_actions',
+    'record:reference_rail',
+    'record:alert',
+    // ── Tier A, continued — page-semantic blocks (the spec ui/page vocabulary) ─
+    // The `page:` / `element:` / `action:` families the Studio page designer
+    // offers and @objectstack/spec's page schema enumerates. Same standing as
+    // the `record:` family above: semantic page blocks, not primitives.
+    //
+    // Deliberately NOT here (each guarded, with its reason, by the console's
+    // reverse-coverage test):
+    //   action:bar               record:quick_actions covers the record action
+    //                            strip, and the spec blesses button/group/icon/
+    //                            menu but not bar
+    //   element:image            duplicates the curated `image` primitive below —
+    //                            one spelling per concept
+    //   element:record_picker    record picking is a field widget, not a page
+    //                            block (Studio palette exclusion)
+    //   element:text_input       bare inputs belong to a form, not a page block
+    //                            (Studio palette exclusion)
+    //   element:metadata_viewer  internal metadata debugging surface
+    'page:tabs',
+    'page:card',
+    'page:accordion',
+    'page:section',
+    'page:footer',
+    'page:sidebar',
+    'element:text',
+    'element:number',
+    'element:button',
+    'element:definition-list',
+    'element:repeater',
+    'action:button',
+    'action:group',
+    'action:menu',
+    'action:icon',
     // ── Tier B — layout / content primitives ──────────────────────────────────
     'flex',
     'grid',

package/dist/theme/ThemeEngine.js

@@ -316,10 +316,6 @@ export function mergeThemes(parent, child) {
         shadows: child.shadows || parent.shadows
             ? { ...parent.shadows, ...child.shadows }
             : undefined,
-        // Deep-merge breakpoints
-        breakpoints: child.breakpoints || parent.breakpoints
-            ? { ...parent.breakpoints, ...child.breakpoints }
-            : undefined,
         // Deep-merge animation
         animation: child.animation || parent.animation
             ? {
@@ -339,18 +335,10 @@ export function mergeThemes(parent, child) {
         zIndex: child.zIndex || parent.zIndex
             ? { ...parent.zIndex, ...child.zIndex }
             : undefined,
-        // Deep-merge spacing
-        spacing: child.spacing || parent.spacing
-            ? { ...parent.spacing, ...child.spacing }
-            : undefined,
         // Deep-merge customVars
         customVars: child.customVars || parent.customVars
             ? { ...parent.customVars, ...child.customVars }
             : undefined,
-        // Deep-merge logo
-        logo: child.logo || parent.logo
-            ? { ...parent.logo, ...child.logo }
-            : undefined,
     };
 }
 /**

package/dist/utils/chart-series.d.ts

@@ -89,6 +89,34 @@ export declare function findChartSeriesRow(rows: Array<Record<string, unknown>>
  * paint identically across the chart view and dashboard widgets.
  */
 export declare function buildOptionColorMap(options: unknown): Record<string, string> | null;
+/**
+ * Build the DECLARED category order from a select field's `options` — the
+ * sequence the author wrote them in on the object (framework#3588).
+ *
+ * A picklist's option order is already the domain order: a sales `stage` field
+ * lists Qualification → Needs Analysis → Proposal → Negotiation because that IS
+ * the pipeline. Analytics groups by that field and returns buckets in whatever
+ * order the GROUP BY produced (usually alphabetical), which for an
+ * ordered-sequence chart — a funnel above all — draws a shape that reads as a
+ * pipeline but isn't one.
+ *
+ * Emits BOTH the stored `value` and its display `label` per option, adjacent
+ * and in declared order, for the same reason {@link buildOptionColorMap} keys
+ * by both: a chart row's category may carry either, depending on whether the
+ * server resolved the dimension's labels. Rank is "index of first match", so
+ * either key ranks the option identically.
+ *
+ * Returns `null` for a field with no options, so callers keep their existing
+ * ordering (a funnel falls back to descending by value).
+ */
+export declare function buildCategoryOrder(options: unknown): string[] | null;
+/**
+ * Rank map for {@link buildCategoryOrder} keys — `category → position`, first
+ * occurrence wins. Categories absent from the declared order get no entry; the
+ * caller decides where those sort (see `AdvancedChartImpl`, which keeps them
+ * after the declared ones rather than dropping them).
+ */
+export declare function buildCategoryRank(order: string[] | null | undefined): Map<string, number> | null;
 /**
  * Build a `{ value → label }` map from a select/enum field's `options`, for
  * resolving a grouped dimension's stored value to its display label (fed to

package/dist/utils/chart-series.js

@@ -147,6 +147,61 @@ export function buildOptionColorMap(options) {
     }
     return Object.keys(map).length > 0 ? map : null;
 }
+/**
+ * Build the DECLARED category order from a select field's `options` — the
+ * sequence the author wrote them in on the object (framework#3588).
+ *
+ * A picklist's option order is already the domain order: a sales `stage` field
+ * lists Qualification → Needs Analysis → Proposal → Negotiation because that IS
+ * the pipeline. Analytics groups by that field and returns buckets in whatever
+ * order the GROUP BY produced (usually alphabetical), which for an
+ * ordered-sequence chart — a funnel above all — draws a shape that reads as a
+ * pipeline but isn't one.
+ *
+ * Emits BOTH the stored `value` and its display `label` per option, adjacent
+ * and in declared order, for the same reason {@link buildOptionColorMap} keys
+ * by both: a chart row's category may carry either, depending on whether the
+ * server resolved the dimension's labels. Rank is "index of first match", so
+ * either key ranks the option identically.
+ *
+ * Returns `null` for a field with no options, so callers keep their existing
+ * ordering (a funnel falls back to descending by value).
+ */
+export function buildCategoryOrder(options) {
+    if (!Array.isArray(options) || options.length === 0)
+        return null;
+    const keys = [];
+    for (const opt of options) {
+        if (typeof opt === 'string' || typeof opt === 'number' || typeof opt === 'boolean') {
+            keys.push(String(opt));
+            continue;
+        }
+        if (opt && typeof opt === 'object') {
+            const o = opt;
+            if (o.value != null)
+                keys.push(String(o.value));
+            if (o.label != null && String(o.label) !== String(o.value))
+                keys.push(String(o.label));
+        }
+    }
+    return keys.length > 0 ? keys : null;
+}
+/**
+ * Rank map for {@link buildCategoryOrder} keys — `category → position`, first
+ * occurrence wins. Categories absent from the declared order get no entry; the
+ * caller decides where those sort (see `AdvancedChartImpl`, which keeps them
+ * after the declared ones rather than dropping them).
+ */
+export function buildCategoryRank(order) {
+    if (!Array.isArray(order) || order.length === 0)
+        return null;
+    const rank = new Map();
+    order.forEach((key, i) => {
+        if (!rank.has(key))
+            rank.set(key, i);
+    });
+    return rank.size > 0 ? rank : null;
+}
 /**
  * Build a `{ value → label }` map from a select/enum field's `options`, for
  * resolving a grouped dimension's stored value to its display label (fed to

package/dist/utils/column-identity.d.ts

@@ -0,0 +1,110 @@
+/**
+ * ObjectUI — column identity canonicalization
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * The spec's canonical key for "which object field this column shows".
+ * `ListColumnSchema` (`@objectstack/spec/view`) declares `field: z.ZodString`
+ * as its ONLY required key — there is no `name`, no `fieldName`, no
+ * `accessorKey` on it. So `field` is not one dialect among several: it is the
+ * contract, and everything else is objectui-side legacy (AGENTS.md #0).
+ *
+ * Note this is the exact opposite of the FORM layer, where the runtime key is
+ * `name` (objectui#3090). The two surfaces sit next to each other and mean the
+ * opposite thing by the same pair of key names, which is why copy-paste between
+ * them keeps producing the defect this module exists to close.
+ */
+export declare const CANONICAL_COLUMN_IDENTITY_KEY = "field";
+/**
+ * Legacy identity spellings, in the order a canonicalizing read falls back
+ * through them. `field` wins over both, always.
+ *
+ * `fieldName` is here for defence, not because objectui emits it: as of
+ * objectui#3104 a repo-wide scan finds NO writer of a column-level `fieldName`
+ * — every `fieldName:` occurrence in the tree is a function parameter or an
+ * unrelated interface member (`AIFieldSuggestion.fieldName`). It survives
+ * purely in READERS that were written defensively, and stored host metadata
+ * could still carry it, so the fold accepts it and the ratchet counts it.
+ */
+export declare const LEGACY_COLUMN_IDENTITY_KEYS: readonly ["name", "fieldName"];
+/**
+ * NOT an identity key — deliberately excluded from everything in this module.
+ *
+ * `accessorKey` is TanStack Table's own column key (`TableColumn.accessorKey`,
+ * `packages/types/src/data-display.ts`, "Data accessor key"). It names a slot in
+ * the table LIBRARY's column model, not a field in ObjectStack metadata. Reads
+ * like `RelatedList`'s `accessorKey || field || name` therefore merge two
+ * different vocabularies in one expression; canonicalizing across that boundary
+ * would fossilize the merge, which is precisely the mistake this battle exists
+ * to undo. The fold neither reads nor writes it.
+ */
+export declare const TABLE_ADAPTER_COLUMN_KEY = "accessorKey";
+/**
+ * Read a column entry's field identity — the ONE reader every consumer should
+ * converge onto (objectui#3104 PR2).
+ *
+ * Accepts the three shapes a `columns` array actually holds: a bare string
+ * (`'stage'`), a spec column (`{ field: 'stage' }`), and the legacy objectui
+ * shapes (`{ name }` / `{ fieldName }`). Resolution is canonical-first, so it
+ * agrees with `buildExpandFields` and with the `$select` projection rather than
+ * with whichever half of a mixed-key column happened to be read.
+ *
+ * Returns `undefined` — not `''` — when nothing is resolvable, so callers can
+ * tell "no identity" from "identity is the empty string" and drop the entry
+ * instead of requesting a nameless column.
+ */
+export declare function columnIdentity(entry: unknown): string | undefined;
+/**
+ * True when a column entry carries more than one identity key AND they
+ * disagree — the shape that makes the renderer and the data request resolve
+ * two different fields. Exported for the "say who wins, loudly" step
+ * (objectui#3104 PR3) and used by the tests to name the defect precisely.
+ */
+export declare function hasConflictingColumnIdentity(entry: unknown): boolean;
+/** Reset the warn-once memo. Exported for tests. */
+export declare function resetColumnIdentityWarnings(): void;
+/**
+ * Stamp the canonical identity onto one column entry.
+ *
+ * The transitional strategy (objectui#3104 PR1) is **mirror, don't delete**:
+ *
+ *  - `field` is written with the resolved identity, so the request path — which
+ *    reads `field` and ONLY `field` in `ListView`'s `$expand`/`$select`
+ *    builders and in `ObjectGrid.getSelectFields` — always finds one.
+ *  - a legacy key that is ALREADY PRESENT is overwritten with that same
+ *    identity, so the name-first read sites still standing (`ListView` ×8,
+ *    `ObjectGrid`, `ObjectTree`, the detail renderers) resolve to exactly what
+ *    the request asked for.
+ *  - a legacy key that is ABSENT is never invented. A spec-clean
+ *    `{ field: 'stage' }` comes back untouched, by reference; the fold does not
+ *    manufacture the legacy vocabulary it is trying to retire.
+ *
+ * This differs on purpose from `normalizeListViewSchema`'s other folds, which
+ * DELETE the legacy key so a missed read-site fails loudly. Deleting works
+ * inside this repo — every name-first read here falls through to `field` — but
+ * `columns` entries cross the package boundary into host applications and
+ * third-party renderers, and dropping `name` from under them is a breaking
+ * change we have no inventory for. Mirroring is behaviour-preserving for every
+ * reader, in or out of the repo; the deletion is PR3's call to make once the
+ * in-repo consumers have converged onto {@link columnIdentity}.
+ *
+ * The result: for any single-key column the resolved identity is unchanged at
+ * every read site. The only entries whose behaviour moves are the ones where
+ * two sites already disagreed — which is the defect, not a regression.
+ */
+export declare function normalizeColumnIdentity<T>(entry: T): T;
+/**
+ * Stamp the canonical identity across a `columns` array.
+ *
+ * Non-mutating and allocation-frugal in the same way as
+ * `normalizeListViewSchema`: when every entry is already canonical the INPUT
+ * array is returned by reference, so `ListView`'s downstream `useMemo`s keep a
+ * stable dependency identity on the common path and nothing re-renders.
+ *
+ * String entries pass through untouched — a bare `'stage'` is unambiguous and
+ * every consumer already special-cases it.
+ */
+export declare function normalizeColumnIdentities<T>(columns: T): T;