@object-ui/app-shell 6.2.0 → 6.2.2

package/dist/views/metadata-admin/registry.d.ts

@@ -64,11 +64,32 @@ export interface MetadataResourceConfig {
     }>;
     /**
      * Fully custom edit page. Receives `{ type, name }`.
+     *
+     * Use this when the bespoke editor replaces the JSONSchema form entirely
+     * (e.g. PermissionMatrix grid). For visual designers that should coexist
+     * with the generic Form/Layers/References tabs, prefer `DesignerTab`.
      */
     EditPage?: ComponentType<{
         type: string;
         name: string;
     }>;
+    /**
+     * Optional visual designer that renders inside its own dedicated tab on
+     * the generic edit page, alongside Form / Layers / References. Receives
+     * `{ type, name }` and should render without an outer `PageShell` — the
+     * generic engine owns the chrome.
+     *
+     * When both `EditPage` and `DesignerTab` are provided, `EditPage` wins
+     * (full takeover); the tab variant is only used when `EditPage` is unset.
+     */
+    DesignerTab?: ComponentType<{
+        type: string;
+        name: string;
+    }>;
+    /**
+     * Optional label for the Designer tab. Defaults to "Designer".
+     */
+    designerTabLabel?: string;
     /**
      * Fully custom create page. Receives `{ type }`.
      */
@@ -96,7 +117,97 @@ export interface MetadataResourceConfig {
      * If the server registry DOES return a `schema`, this is ignored.
      */
     defaultSchema?: Record<string, unknown>;
+    /**
+     * Declares that items of this type are "anchored" to one or more
+     * parent metadata types. The Related tab on the parent's edit page
+     * lists every item that matches the anchor predicate.
+     *
+     * For example, registering `hook` with
+     * `{ anchorType: 'object', match: (item, name) => item.object === name }`
+     * makes every `hook` whose `object` field equals `account` show up in
+     * the Account object's Related tab under a "Hooks" group.
+     *
+     * Multiple anchors are allowed (e.g. a field could anchor to both
+     * `object` and `view`). The Related panel groups by anchored type.
+     */
+    anchors?: MetadataAnchor[];
+}
+/**
+ * Anchor declaration — "items of type X are children of items of type Y
+ * when this predicate matches". Used to power the Related tab.
+ *
+ * The predicate runs in the client against the unwrapped item shape
+ * returned by `client.list(type)`. Keep it cheap (just property reads);
+ * we evaluate it once per item per render.
+ */
+export interface MetadataAnchor {
+    /** The parent metadata type whose Related tab should surface this. */
+    anchorType: string;
+    /**
+     * Where the anchored items live.
+     *   - 'list' (default): query `client.list(childType)` and filter with
+     *     `match()`. Used for first-class metadata types (hooks, views, …).
+     *   - 'embedded': items are stored inside the parent body itself
+     *     (e.g. `object.fields[]`). `extract()` plucks the array; no
+     *     network call is made.
+     */
+    source?: 'list' | 'embedded';
+    /**
+     * Returns true when the child `item` belongs to the parent identified
+     * by `anchorName`. The default helper `byField('object')` covers the
+     * common case of an explicit `object: 'foo'` reference. Required when
+     * `source === 'list'` (the default); ignored for `'embedded'`.
+     */
+    match?: (item: Record<string, unknown>, anchorName: string) => boolean;
+    /**
+     * For `source: 'embedded'` only. Returns the embedded items array
+     * given the fully-loaded parent body. Items should already carry a
+     * `name` (or be normalised by the renderer).
+     */
+    extract?: (parentItem: Record<string, unknown>) => Array<Record<string, unknown>>;
+    /**
+     * Optional override for the group label shown on the Related panel.
+     * Defaults to the child type's resolved label.
+     */
+    groupLabel?: string;
+    /**
+     * Optional icon override for the group header. Falls back to the
+     * child type's registered icon.
+     */
+    iconName?: string;
+    /**
+     * Optional explicit ordering hint inside the Related panel. Lower
+     * numbers float to the top. Defaults to 100 if unset.
+     */
+    order?: number;
+    /**
+     * For `source: 'embedded'` only. The metadata type whose schema /
+     * form should drive the embedded item's editor. Defaults to the
+     * synthetic `type` from the registration when omitted (which will
+     * fall back to JSON view).
+     *
+     * Example: object.fields → `editAs: 'field'` so the embedded editor
+     * pulls `field`'s schema + form from `/meta/types`.
+     */
+    editAs?: string;
+    /**
+     * For `source: 'embedded'` only. Dotted path inside the parent body
+     * where the collection lives (e.g. `fields`, `validations`). Used by
+     * the embedded editor to write the modified item back into the
+     * parent on save.
+     */
+    embeddedPath?: string;
 }
+/**
+ * Helper that returns a `match` reading a (possibly dotted) field path
+ * from the item and comparing it to the anchor name.
+ *
+ *   anchorByField('object')                  // item.object === name
+ *   anchorByField('data.object')             // item.data?.object === name
+ *   anchorByField(['list.data.object',
+ *                  'form.data.object'])      // either path matches
+ */
+export declare function anchorByField(paths: string | string[]): MetadataAnchor['match'];
 /**
  * Register (or merge) an entry. Idempotent — re-registering with the
  * same `type` merges the new fields with any existing entry so that
@@ -109,6 +220,19 @@ export declare function registerMetadataResource(config: MetadataResourceConfig)
 export declare function getMetadataResource(type: string): MetadataResourceConfig | undefined;
 /** Snapshot of all registered entries (diagnostics; directory page). */
 export declare function listMetadataResources(): MetadataResourceConfig[];
+/**
+ * Build the list of child types whose items can be "anchored to" a
+ * parent type. Used by the Related tab to decide which `client.list`
+ * calls to make.
+ *
+ * Returns an array of `{ type, anchor }` pairs, sorted by `anchor.order`
+ * (lower first) and then by child type label for stable rendering.
+ */
+export declare function listAnchorsFor(parentType: string): Array<{
+    type: string;
+    config: MetadataResourceConfig;
+    anchor: MetadataAnchor;
+}>;
 /**
  * Merge a registered config (if any) with server-side defaults from
  * `/meta/types`. Server fields win for label/description/domain

package/dist/views/metadata-admin/registry.js

@@ -1,4 +1,33 @@
 // Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
+/**
+ * Helper that returns a `match` reading a (possibly dotted) field path
+ * from the item and comparing it to the anchor name.
+ *
+ *   anchorByField('object')                  // item.object === name
+ *   anchorByField('data.object')             // item.data?.object === name
+ *   anchorByField(['list.data.object',
+ *                  'form.data.object'])      // either path matches
+ */
+export function anchorByField(paths) {
+    const list = (Array.isArray(paths) ? paths : [paths]).map((p) => p.split('.'));
+    return (item, name) => {
+        for (const segs of list) {
+            let cur = item;
+            for (const s of segs) {
+                if (cur && typeof cur === 'object' && s in cur) {
+                    cur = cur[s];
+                }
+                else {
+                    cur = undefined;
+                    break;
+                }
+            }
+            if (cur === name)
+                return true;
+        }
+        return false;
+    };
+}
 const REGISTRY = new Map();
 /**
  * Register (or merge) an entry. Idempotent — re-registering with the
@@ -28,6 +57,35 @@ export function getMetadataResource(type) {
 export function listMetadataResources() {
     return Array.from(REGISTRY.values());
 }
+/**
+ * Build the list of child types whose items can be "anchored to" a
+ * parent type. Used by the Related tab to decide which `client.list`
+ * calls to make.
+ *
+ * Returns an array of `{ type, anchor }` pairs, sorted by `anchor.order`
+ * (lower first) and then by child type label for stable rendering.
+ */
+export function listAnchorsFor(parentType) {
+    const hits = [];
+    for (const cfg of REGISTRY.values()) {
+        if (!cfg.anchors?.length)
+            continue;
+        for (const a of cfg.anchors) {
+            if (a.anchorType === parentType)
+                hits.push({ type: cfg.type, config: cfg, anchor: a });
+        }
+    }
+    hits.sort((a, b) => {
+        const ao = a.anchor.order ?? 100;
+        const bo = b.anchor.order ?? 100;
+        if (ao !== bo)
+            return ao - bo;
+        const al = a.anchor.groupLabel ?? a.config.label ?? a.type;
+        const bl = b.anchor.groupLabel ?? b.config.label ?? b.type;
+        return al.localeCompare(bl);
+    });
+    return hits;
+}
 /**
  * Merge a registered config (if any) with server-side defaults from
  * `/meta/types`. Server fields win for label/description/domain

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@object-ui/app-shell",
-  "version": "6.2.0",
+  "version": "6.2.2",
   "type": "module",
   "license": "MIT",
   "description": "Minimal application shell for ObjectUI - framework-agnostic rendering engine",
@@ -28,36 +28,36 @@
     "@sentry/react": "^10.53.1",
     "lucide-react": "^1.16.0",
     "sonner": "^2.0.7",
-    "@object-ui/auth": "6.2.0",
-    "@object-ui/collaboration": "6.2.0",
-    "@object-ui/components": "6.2.0",
-    "@object-ui/plugin-editor": "6.2.0",
-    "@object-ui/core": "6.2.0",
-    "@object-ui/data-objectstack": "6.2.0",
-    "@object-ui/fields": "6.2.0",
-    "@object-ui/i18n": "6.2.0",
-    "@object-ui/layout": "6.2.0",
-    "@object-ui/permissions": "6.2.0",
-    "@object-ui/providers": "6.2.0",
-    "@object-ui/react": "6.2.0",
-    "@object-ui/types": "6.2.0"
+    "@object-ui/auth": "6.2.2",
+    "@object-ui/collaboration": "6.2.2",
+    "@object-ui/components": "6.2.2",
+    "@object-ui/plugin-editor": "6.2.2",
+    "@object-ui/core": "6.2.2",
+    "@object-ui/data-objectstack": "6.2.2",
+    "@object-ui/fields": "6.2.2",
+    "@object-ui/i18n": "6.2.2",
+    "@object-ui/layout": "6.2.2",
+    "@object-ui/permissions": "6.2.2",
+    "@object-ui/providers": "6.2.2",
+    "@object-ui/react": "6.2.2",
+    "@object-ui/types": "6.2.2"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",
     "react-dom": "^18.0.0 || ^19.0.0",
     "react-router-dom": "^6.0.0 || ^7.0.0",
-    "@object-ui/plugin-calendar": "^6.2.0",
-    "@object-ui/plugin-charts": "^6.2.0",
-    "@object-ui/plugin-chatbot": "^6.2.0",
-    "@object-ui/plugin-dashboard": "^6.2.0",
-    "@object-ui/plugin-designer": "^6.2.0",
-    "@object-ui/plugin-detail": "^6.2.0",
-    "@object-ui/plugin-form": "^6.2.0",
-    "@object-ui/plugin-grid": "^6.2.0",
-    "@object-ui/plugin-kanban": "^6.2.0",
-    "@object-ui/plugin-list": "^6.2.0",
-    "@object-ui/plugin-report": "^6.2.0",
-    "@object-ui/plugin-view": "^6.2.0"
+    "@object-ui/plugin-calendar": "^6.2.2",
+    "@object-ui/plugin-charts": "^6.2.2",
+    "@object-ui/plugin-chatbot": "^6.2.2",
+    "@object-ui/plugin-dashboard": "^6.2.2",
+    "@object-ui/plugin-designer": "^6.2.2",
+    "@object-ui/plugin-detail": "^6.2.2",
+    "@object-ui/plugin-form": "^6.2.2",
+    "@object-ui/plugin-grid": "^6.2.2",
+    "@object-ui/plugin-kanban": "^6.2.2",
+    "@object-ui/plugin-list": "^6.2.2",
+    "@object-ui/plugin-report": "^6.2.2",
+    "@object-ui/plugin-view": "^6.2.2"
   },
   "devDependencies": {
     "@types/node": "^25.9.1",