@object-ui/react 11.2.0 → 11.4.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @object-ui/react
 
+## 11.4.0
+
+### Patch Changes
+
+- Updated dependencies [8bf6295]
+- Updated dependencies [1948c5b]
+- Updated dependencies [9cd9be1]
+- Updated dependencies [c38d107]
+- Updated dependencies [790558b]
+- Updated dependencies [c0164ad]
+  - @object-ui/types@11.4.0
+  - @object-ui/i18n@11.4.0
+  - @object-ui/data-objectstack@11.4.0
+  - @object-ui/core@11.4.0
+
+## 11.3.0
+
+### Patch Changes
+
+- Updated dependencies [d88c8ec]
+- Updated dependencies [d23d6eb]
+  - @object-ui/i18n@11.3.0
+  - @object-ui/core@11.3.0
+  - @object-ui/data-objectstack@11.3.0
+  - @object-ui/types@11.3.0
+
 ## 11.2.0
 
 ### Patch Changes

package/dist/context/RelatedRecordActionsContext.d.ts

@@ -0,0 +1,96 @@
+/**
+ * ObjectUI
+ * 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.
+ */
+/**
+ * RelatedRecordActionsContext — host-provided CRUD + action handlers for the
+ * child collections ("related lists") rendered on a record DETAIL page.
+ *
+ * The `record:related_list` renderer (in `@object-ui/plugin-detail`) knows the
+ * child object name, the FK back to the parent, and the parent id — but it
+ * lives in a low-level package with no access to the console's SPA router, the
+ * create/edit form routes, or the per-object CRUD affordances / permissions.
+ * Those all live in the app shell.
+ *
+ * So the host (e.g. `RecordDetailView`) provides this context; the renderer
+ * calls {@link RelatedRecordActionsValue.resolve} for its child object and
+ * wires whatever handlers come back onto the `RelatedList` (New / Edit / Delete
+ * / row-click-to-open, plus the child object's own row actions). A handler that
+ * is OMITTED means the capability is unavailable (permission or lifecycle
+ * affordance denied, or no host routing) — the related list simply hides that
+ * affordance. When no provider is present at all (e.g. the Studio designer, or
+ * a standalone embedded renderer) the related list stays read-only, which is
+ * the correct graceful fallback.
+ */
+import React from 'react';
+/** A child-object action surfaced in a related list's row menu. */
+export interface RelatedRowActionDef {
+    /** Stable action name (matches the object's action metadata). */
+    name: string;
+    /** Display label (already localized by the host). */
+    label?: string;
+    /** Lucide icon name (kebab-case). */
+    icon?: string;
+    /** Visual emphasis for the menu item. */
+    variant?: 'primary' | 'secondary' | 'danger' | 'ghost' | 'link';
+    /** Confirmation prompt shown before the action runs. */
+    confirmText?: string;
+    /** Any remaining action metadata (target, params, …) is preserved. */
+    [k: string]: unknown;
+}
+/**
+ * CRUD + action handlers for a single related list's child object, resolved by
+ * the host for a specific child object + parent relationship. Every handler is
+ * optional: an omitted handler hides its affordance in the list.
+ */
+export interface RelatedRecordHandlers {
+    /** Open the child record's detail page (查看详情). */
+    onView?: (recordId: string | number, record?: unknown) => void;
+    /**
+     * Open a create form for a new child record. The host pre-links it to the
+     * parent (via the relationship field + parent id passed to `resolve`), so no
+     * argument is needed here (增).
+     */
+    onCreate?: () => void;
+    /** Open an edit form for an existing child record (改). */
+    onEdit?: (recordId: string | number, record?: unknown) => void;
+    /**
+     * Delete a child record (删). Returns a promise so the list can refresh once
+     * the deletion resolves.
+     */
+    onDelete?: (recordId: string | number, record?: unknown) => void | Promise<void>;
+    /** Child object row-level actions (`locations: ['list_item']`), localized. */
+    rowActions?: RelatedRowActionDef[];
+    /** Execute one of {@link rowActions} against a specific child row. */
+    onRowAction?: (action: RelatedRowActionDef, record: unknown) => void | Promise<void>;
+}
+/** Input to {@link RelatedRecordActionsValue.resolve}. */
+export interface ResolveRelatedRecordActionsInput {
+    /** Child object machine name (the related list's `api`). */
+    objectName: string;
+    /** FK field on the child pointing back at the parent record. */
+    relationshipField?: string;
+    /** Primary-key value of the parent record (used to pre-link new children). */
+    parentId?: string | number | null;
+}
+export interface RelatedRecordActionsValue {
+    /**
+     * Resolve the CRUD + action handlers for a child object. Implementations
+     * should be stable (memoized) so consumers can safely depend on the returned
+     * identity.
+     */
+    resolve: (input: ResolveRelatedRecordActionsInput) => RelatedRecordHandlers;
+}
+export declare const RelatedRecordActionsProvider: React.FC<{
+    value: RelatedRecordActionsValue;
+    children: React.ReactNode;
+}>;
+/**
+ * Consume the host-provided related-record actions. Returns `null` when no
+ * host wired the provider (embedded / designer contexts) — callers must treat
+ * that as "read-only related list".
+ */
+export declare function useRelatedRecordActions(): RelatedRecordActionsValue | null;

package/dist/context/RelatedRecordActionsContext.js

@@ -0,0 +1,39 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+/**
+ * ObjectUI
+ * 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.
+ */
+/**
+ * RelatedRecordActionsContext — host-provided CRUD + action handlers for the
+ * child collections ("related lists") rendered on a record DETAIL page.
+ *
+ * The `record:related_list` renderer (in `@object-ui/plugin-detail`) knows the
+ * child object name, the FK back to the parent, and the parent id — but it
+ * lives in a low-level package with no access to the console's SPA router, the
+ * create/edit form routes, or the per-object CRUD affordances / permissions.
+ * Those all live in the app shell.
+ *
+ * So the host (e.g. `RecordDetailView`) provides this context; the renderer
+ * calls {@link RelatedRecordActionsValue.resolve} for its child object and
+ * wires whatever handlers come back onto the `RelatedList` (New / Edit / Delete
+ * / row-click-to-open, plus the child object's own row actions). A handler that
+ * is OMITTED means the capability is unavailable (permission or lifecycle
+ * affordance denied, or no host routing) — the related list simply hides that
+ * affordance. When no provider is present at all (e.g. the Studio designer, or
+ * a standalone embedded renderer) the related list stays read-only, which is
+ * the correct graceful fallback.
+ */
+import { createContext, useContext } from 'react';
+const RelatedRecordActionsContext = createContext(null);
+export const RelatedRecordActionsProvider = ({ value, children }) => (_jsx(RelatedRecordActionsContext.Provider, { value: value, children: children }));
+/**
+ * Consume the host-provided related-record actions. Returns `null` when no
+ * host wired the provider (embedded / designer contexts) — callers must treat
+ * that as "read-only related list".
+ */
+export function useRelatedRecordActions() {
+    return useContext(RelatedRecordActionsContext);
+}

package/dist/context/index.d.ts

@@ -8,3 +8,4 @@ export * from './AppShellContext';
 export * from './RecordContext';
 export * from './DiscussionContext';
 export * from './DrillNavigationContext';
+export * from './RelatedRecordActionsContext';

package/dist/context/index.js

@@ -8,3 +8,4 @@ export * from './AppShellContext';
 export * from './RecordContext';
 export * from './DiscussionContext';
 export * from './DrillNavigationContext';
+export * from './RelatedRecordActionsContext';

package/dist/hooks/useRecordSearch.js

@@ -6,32 +6,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { useEffect, useMemo, useRef, useState } from 'react';
-/**
- * Local copy of the display-name resolver used by app-shell. Kept in
- * `@object-ui/react` so hooks can derive a record's visible label without
- * pulling in the shell. Mirrors `app-shell/src/utils#getRecordDisplayName`;
- * the two should stay in sync.
- */
-function defaultDisplayName(objectDef, record) {
-    const fmt = objectDef?.titleFormat;
-    if (fmt && typeof fmt === 'string') {
-        const rendered = fmt.replace(/\{\{\s*([\w.]+)\s*\}\}/g, (_m, path) => {
-            const v = path.split('.').reduce((acc, k) => (acc == null ? acc : acc[k]), record);
-            return v == null ? '' : String(v);
-        }).trim();
-        if (rendered.length > 0)
-            return rendered;
-    }
-    return (record?.name ||
-        record?.full_name ||
-        record?.fullName ||
-        record?.title ||
-        record?.label ||
-        record?.subject ||
-        record?.id ||
-        record?._id ||
-        'Untitled');
-}
+import { getRecordDisplayName as defaultDisplayName } from '@object-ui/core';
+// ADR-0079: the global-search default display-name resolver is now the ONE
+// shared `getRecordDisplayName` from `@object-ui/core` (honors titleFormat →
+// `displayNameField` → type-aware derivation → `Record #<id>`). Callers can
+// still pass an explicit `getDisplayName` (app-shell's CommandPalette passes
+// the same shared resolver re-exported via `@object-ui/app-shell`).
 /**
  * Relevance score for a single record hit against the query. Higher wins.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@object-ui/react",
-  "version": "11.2.0",
+  "version": "11.4.0",
   "type": "module",
   "license": "MIT",
   "description": "React bindings and SchemaRenderer component for Object UI",
@@ -24,12 +24,12 @@
     }
   },
   "dependencies": {
-    "@objectstack/spec": "^11.0.0",
+    "@objectstack/spec": "^11.7.0",
     "react-hook-form": "^7.80.0",
-    "@object-ui/core": "11.2.0",
-    "@object-ui/data-objectstack": "11.2.0",
-    "@object-ui/i18n": "11.2.0",
-    "@object-ui/types": "11.2.0"
+    "@object-ui/core": "11.4.0",
+    "@object-ui/data-objectstack": "11.4.0",
+    "@object-ui/i18n": "11.4.0",
+    "@object-ui/types": "11.4.0"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",