@multiplatform.one/backoffice 6.4.3 → 6.7.0

package/src/config/BackofficeProvider.tsx

@@ -66,6 +66,28 @@ export interface BackofficeAppearance {
   setScheme: (scheme: "light" | "dark" | "system") => void;
 }
 
+/** Result contract of a host navigation blocker (one's useBlocker shape). */
+export interface BackofficeNavigationBlocker {
+  blocked: boolean;
+  proceed: () => void;
+  reset: () => void;
+}
+
+/**
+ * Router-integration hooks the navigator contract cannot express. Each
+ * entry MUST be a referentially stable hook (rules of hooks — the package
+ * calls it unconditionally on the surfaces that need it).
+ */
+export interface BackofficeIntegrations {
+  /**
+   * Block history-pop navigations (browser back/forward, native back
+   * gesture) while `shouldBlock` is true — the form's dirty guard. The
+   * one-adapter exports `useOneNavigationBlocker`; hosts without a blocker
+   * simply omit this (in-app navigations are still guarded).
+   */
+  useNavigationBlocker?: (shouldBlock: boolean) => BackofficeNavigationBlocker;
+}
+
 /** Host-injected custom action (form toolbars, list toolbars). */
 export interface BackofficeActionContext {
   doctype: string;
@@ -78,9 +100,23 @@ export interface BackofficeActionContext {
 export interface BackofficeAction {
   id: string;
   label: string;
+  /**
+   * Restrict the action to specific doctypes (per-doctype registry). Omit
+   * for every doctype. Example: `{ id: "reset-password", label: "Reset
+   * Password", doctypes: ["User"], onPress: … }`.
+   */
+  doctypes?: readonly string[];
   onPress: (context: BackofficeActionContext) => void;
 }
 
+/** Registry filter: actions with a `doctypes` scope only apply to those. */
+export function actionsForDoctype(
+  actions: readonly BackofficeAction[] | undefined,
+  doctype: string,
+): BackofficeAction[] {
+  return (actions ?? []).filter((action) => !action.doctypes || action.doctypes.includes(doctype));
+}
+
 export interface BackofficeActions {
   /** Extra actions on the document form toolbar. */
   form?: readonly BackofficeAction[];
@@ -116,6 +152,8 @@ export interface BackofficeProviderProps {
   slots?: BackofficeSlots;
   /** Color-scheme adapter for the user menu's "Toggle Theme". */
   appearance?: BackofficeAppearance;
+  /** Router-integration hooks (navigation blocker, …). */
+  integrations?: BackofficeIntegrations;
   /** Event bus — every notable backoffice action lands here. */
   onEvent?: BackofficeEventHandler;
   /**
@@ -136,6 +174,7 @@ export interface BackofficeConfig {
   actions: BackofficeActions;
   slots: BackofficeSlots;
   appearance?: BackofficeAppearance;
+  integrations?: BackofficeIntegrations;
   /** Emit an event to the host's `onEvent` bus (no-op when unset). */
   emitEvent: (event: BackofficeEvent) => void;
 }
@@ -208,6 +247,7 @@ export function BackofficeProvider({
   actions,
   slots,
   appearance,
+  integrations,
   onEvent,
   i18nInstance,
 }: BackofficeProviderProps) {
@@ -262,6 +302,14 @@ export function BackofficeProvider({
         });
         navigation.back();
       },
+      // Param merges are URL-state mirrors, not navigations — forwarded
+      // without a navigate event (and only when the host supports them).
+      ...(navigation.setParams
+        ? {
+            setParams: (params: Record<string, string | undefined>) =>
+              navigation.setParams?.(params),
+          }
+        : {}),
       getLocation: () => navigation.getLocation(),
       subscribe: (listener) => navigation.subscribe(listener),
     }),
@@ -282,6 +330,7 @@ export function BackofficeProvider({
       actions: actions ?? {},
       slots: slots ?? {},
       appearance,
+      integrations,
       emitEvent,
     }),
     [
@@ -294,6 +343,7 @@ export function BackofficeProvider({
       actions,
       slots,
       appearance,
+      integrations,
       emitEvent,
     ],
   );