@multiplatform.one/backoffice 6.3.0

package/types/config/BackofficeProvider.d.ts

@@ -0,0 +1,128 @@
+/**
+ * BackofficeProvider — the single configuration surface for embedding the
+ * backoffice in a host app.
+ *
+ * It composes @multiplatform.one/frappe-ui's FrappeProvider internally (the
+ * `frappe` prop), publishes the navigation seam + capability flags + slots +
+ * event bus through BackofficeConfigContext (consumed by every backoffice
+ * surface), registers the package's "backoffice" i18n namespace, and applies
+ * host field-registry overrides.
+ *
+ * Surfaces render without a provider too (stories/tests): the context
+ * default is a fully-enabled config with an inert navigator.
+ */
+import { type FieldRenderProps, type FrappeProviderProps } from "@multiplatform.one/frappe-ui";
+import type { i18n as I18nInstance } from "i18next";
+import type { ComponentType, ReactNode } from "react";
+import { type BackofficeLocation, type BackofficeNavigator } from "../navigation/navigator";
+import { type BackofficePaths } from "../navigation/paths";
+import { type BackofficeCapabilities, type BackofficeDoctypeScope, type ResolvedBackofficeCapabilities } from "./capabilities";
+import type { BackofficeEvent, BackofficeEventHandler } from "./events";
+import type { BackofficeSlots } from "./slots";
+/** Frappe connection config — fed into frappe-ui's FrappeProvider. */
+export interface BackofficeFrappeConfig {
+    /** Base URL of the Frappe server, e.g. "https://mysite.frappe.cloud". */
+    baseURL: string;
+    /** Override port for the Socket.IO realtime connection (e.g. 9000 in dev). */
+    socketPort?: number;
+    /** Authentication configuration (token auth for cross-origin/native hosts). */
+    auth?: FrappeProviderProps["auth"];
+    /** Sync options for the live data engine (persistKey, cdcInterval, …). */
+    syncOptions?: FrappeProviderProps["syncOptions"];
+    /** Extra Socket.IO client options for the realtime connection. */
+    socketOptions?: FrappeProviderProps["socketOptions"];
+    /** Fixture provider (stories/tests — no network). */
+    fixtures?: FrappeProviderProps["fixtures"];
+}
+/** Host color-scheme adapter (drives the user menu's "Toggle Theme"). */
+export interface BackofficeAppearance {
+    /** Current scheme value. */
+    scheme: "light" | "dark" | "system" | (string & {});
+    /** Set the scheme. */
+    setScheme: (scheme: "light" | "dark" | "system") => void;
+}
+/** Host-injected custom action (form toolbars, list toolbars). */
+export interface BackofficeActionContext {
+    doctype: string;
+    /** Document name (form actions; undefined for unsaved docs). */
+    name?: string;
+    /** Selected row names (list bulk actions). */
+    selection?: readonly string[];
+}
+export interface BackofficeAction {
+    id: string;
+    label: string;
+    onPress: (context: BackofficeActionContext) => void;
+}
+export interface BackofficeActions {
+    /** Extra actions on the document form toolbar. */
+    form?: readonly BackofficeAction[];
+    /** Extra actions on the list toolbar / bulk-actions bar. */
+    list?: readonly BackofficeAction[];
+}
+export interface BackofficeProviderProps {
+    children: ReactNode;
+    /** Frappe connection — feeds FrappeProvider internally. */
+    frappe: BackofficeFrappeConfig;
+    /**
+     * Navigation adapter. Use `useOneNavigator()` from
+     * `@multiplatform.one/backoffice/one-adapter` in One apps,
+     * `createMemoryNavigator()` in tests/stories, or bridge your own router
+     * with `ControlledNavigator`.
+     */
+    navigation: BackofficeNavigator;
+    /** URL prefix the backoffice is mounted under. Default "/backoffice". */
+    basePath?: string;
+    /** Feature visibility/behavior flags. Everything defaults ON. */
+    capabilities?: BackofficeCapabilities;
+    /** Restrict which doctypes are reachable (awesomebar, lists, links). */
+    doctypes?: BackofficeDoctypeScope;
+    /**
+     * Field-renderer overrides merged into frappe-ui's field registry
+     * (fieldtype → component), e.g. `{ Rating: MyRating }`.
+     */
+    fields?: Record<string, ComponentType<FieldRenderProps>>;
+    /** Host-injected custom actions (form/list toolbars). */
+    actions?: BackofficeActions;
+    /** Render-prop slots replacing built-in chrome. */
+    slots?: BackofficeSlots;
+    /** Color-scheme adapter for the user menu's "Toggle Theme". */
+    appearance?: BackofficeAppearance;
+    /** Event bus — every notable backoffice action lands here. */
+    onEvent?: BackofficeEventHandler;
+    /**
+     * i18next instance to register the "backoffice" namespace on (defaults to
+     * the global singleton).
+     */
+    i18nInstance?: I18nInstance;
+}
+/** Resolved config every backoffice surface consumes. */
+export interface BackofficeConfig {
+    frappe?: BackofficeFrappeConfig;
+    navigation: BackofficeNavigator;
+    basePath: string;
+    paths: BackofficePaths;
+    capabilities: ResolvedBackofficeCapabilities;
+    doctypes?: BackofficeDoctypeScope;
+    actions: BackofficeActions;
+    slots: BackofficeSlots;
+    appearance?: BackofficeAppearance;
+    /** Emit an event to the host's `onEvent` bus (no-op when unset). */
+    emitEvent: (event: BackofficeEvent) => void;
+}
+/**
+ * The resolved backoffice config. Outside a BackofficeProvider this returns
+ * a fully-enabled default config with an inert navigator, so surfaces stay
+ * mountable in isolation (stories, tests).
+ */
+export declare function useBackofficeConfig(): BackofficeConfig;
+export declare function useBackofficeCapabilities(): ResolvedBackofficeCapabilities;
+export declare function useBackofficeNavigator(): BackofficeNavigator;
+export declare function useBackofficePaths(): BackofficePaths;
+export declare function useBackofficeSlots(): BackofficeSlots;
+/** Current location from the navigation adapter (subscription-backed). */
+export declare function useBackofficeLocation(): BackofficeLocation;
+/** Is `doctype` reachable under the provider's doctype scope? */
+export declare function useIsDoctypeAllowed(): (doctype: string) => boolean;
+export declare function BackofficeProvider({ children, frappe, navigation, basePath, capabilities, doctypes, fields, actions, slots, appearance, onEvent, i18nInstance, }: BackofficeProviderProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=BackofficeProvider.d.ts.map

package/types/config/BackofficeProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackofficeProvider.d.ts","sourceRoot":"","sources":["../../src/config/BackofficeProvider.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,EAGL,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACzB,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,IAAI,IAAI,YAAY,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAItD,OAAO,EAEL,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACzB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAA0C,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAGL,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,8BAA8B,EACpC,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAM/C,sEAAsE;AACtE,MAAM,WAAW,sBAAsB;IACrC,yEAAyE;IACzE,OAAO,EAAE,MAAM,CAAC;IAChB,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,+EAA+E;IAC/E,IAAI,CAAC,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;IACnC,0EAA0E;IAC1E,WAAW,CAAC,EAAE,mBAAmB,CAAC,aAAa,CAAC,CAAC;IACjD,kEAAkE;IAClE,aAAa,CAAC,EAAE,mBAAmB,CAAC,eAAe,CAAC,CAAC;IACrD,qDAAqD;IACrD,QAAQ,CAAC,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC;CAC5C;AAED,yEAAyE;AACzE,MAAM,WAAW,oBAAoB;IACnC,4BAA4B;IAC5B,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IACpD,sBAAsB;IACtB,SAAS,EAAE,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,QAAQ,KAAK,IAAI,CAAC;CAC1D;AAED,kEAAkE;AAClE,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,MAAM,CAAC;IAChB,gEAAgE;IAChE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8CAA8C;IAC9C,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,CAAC,OAAO,EAAE,uBAAuB,KAAK,IAAI,CAAC;CACrD;AAED,MAAM,WAAW,iBAAiB;IAChC,kDAAkD;IAClD,IAAI,CAAC,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACnC,4DAA4D;IAC5D,IAAI,CAAC,EAAE,SAAS,gBAAgB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,SAAS,CAAC;IACpB,2DAA2D;IAC3D,MAAM,EAAE,sBAAsB,CAAC;IAC/B;;;;;OAKG;IACH,UAAU,EAAE,mBAAmB,CAAC;IAChC,yEAAyE;IACzE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iEAAiE;IACjE,YAAY,CAAC,EAAE,sBAAsB,CAAC;IACtC,wEAAwE;IACxE,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAClC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACzD,yDAAyD;IACzD,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B,mDAAmD;IACnD,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,+DAA+D;IAC/D,UAAU,CAAC,EAAE,oBAAoB,CAAC;IAClC,8DAA8D;IAC9D,OAAO,CAAC,EAAE,sBAAsB,CAAC;IACjC;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,yDAAyD;AACzD,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,sBAAsB,CAAC;IAChC,UAAU,EAAE,mBAAmB,CAAC;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,eAAe,CAAC;IACvB,YAAY,EAAE,8BAA8B,CAAC;IAC7C,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAClC,OAAO,EAAE,iBAAiB,CAAC;IAC3B,KAAK,EAAE,eAAe,CAAC;IACvB,UAAU,CAAC,EAAE,oBAAoB,CAAC;IAClC,oEAAoE;IACpE,SAAS,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;CAC7C;AAkBD;;;;GAIG;AACH,wBAAgB,mBAAmB,IAAI,gBAAgB,CAEtD;AAED,wBAAgB,yBAAyB,IAAI,8BAA8B,CAE1E;AAED,wBAAgB,sBAAsB,IAAI,mBAAmB,CAE5D;AAED,wBAAgB,kBAAkB,IAAI,eAAe,CAEpD;AAED,wBAAgB,kBAAkB,IAAI,eAAe,CAEpD;AAED,0EAA0E;AAC1E,wBAAgB,qBAAqB,IAAI,kBAAkB,CAG1D;AAED,iEAAiE;AACjE,wBAAgB,mBAAmB,IAAI,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAGlE;AAMD,wBAAgB,kBAAkB,CAAC,EACjC,QAAQ,EACR,MAAM,EACN,UAAU,EACV,QAA0B,EAC1B,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,OAAO,EACP,KAAK,EACL,UAAU,EACV,OAAO,EACP,YAAY,GACb,EAAE,uBAAuB,2CAsGzB"}

package/types/config/capabilities.d.ts

@@ -0,0 +1,109 @@
+/**
+ * Backoffice capability flags — the host's on/off (and per-feature config)
+ * switches for what the embedded backoffice displays and allows.
+ *
+ * Every flag accepts either a boolean or a config object; everything
+ * defaults ON so `<BackofficeProvider>` with no `capabilities` prop renders
+ * the full desk. Resolution happens once in the provider; surfaces read the
+ * resolved shape via `useBackofficeCapabilities()`.
+ */
+import { type BackofficeView } from "../navigation/paths";
+/** Boolean shorthand or per-feature config object. */
+export type CapabilityInput<Config extends object = {
+    enabled?: boolean;
+}> = boolean | (Config & {
+    enabled?: boolean;
+}) | undefined;
+export interface BackofficeCapabilities {
+    /** Global search / command bar in the shell navbar. */
+    awesomebar?: CapabilityInput;
+    /** Notification bell + panel in the shell navbar. */
+    notifications?: CapabilityInput;
+    /** Avatar menu (profile, theme toggle, logout) in the shell navbar. */
+    userMenu?: CapabilityInput<{
+        /** Show the "Toggle Theme" item (needs an `appearance` adapter too). */
+        themeToggle?: boolean;
+        /** Show the "Log Out" item. */
+        logout?: boolean;
+        /**
+         * "Exit to site" escape hatch back into the host app (web only).
+         * `path` is host-app absolute (default "/"); `label` overrides the
+         * translated default.
+         */
+        exitToSite?: boolean | {
+            enabled?: boolean;
+            path?: string;
+            label?: string;
+        };
+    }>;
+    /** Help menu (docs links, shortcuts + about dialogs) in the shell navbar. */
+    help?: CapabilityInput;
+    /** Workspace sidebar (desktop rail + narrow drawer). */
+    sidebar?: CapabilityInput;
+    /** Quick-entry dialogs (compact create forms). */
+    quickEntry?: CapabilityInput;
+    /** List views. `allow` restricts which views are reachable. */
+    views?: CapabilityInput<{
+        allow?: readonly BackofficeView[];
+    }>;
+    /** "New <doctype>" affordances (list header, awesomebar new-commands, …). */
+    newDoc?: CapabilityInput;
+    /** List bulk-action bar (multi-select edit/assign/tag/delete). */
+    bulkActions?: CapabilityInput;
+    /** Form sidebar attachments section. */
+    attachments?: CapabilityInput;
+    /** Form activity timeline (comments, versions, communications). */
+    timeline?: CapabilityInput;
+    /** Assignment (ToDo) surfaces on forms and lists. */
+    assignments?: CapabilityInput;
+    /** Tag surfaces on forms and lists. */
+    tags?: CapabilityInput;
+    /** Document share surfaces. */
+    shares?: CapabilityInput;
+    /** Print affordances. */
+    print?: CapabilityInput;
+    /** Email / communication affordances. */
+    email?: CapabilityInput;
+}
+export interface ResolvedCapability {
+    enabled: boolean;
+}
+export interface ResolvedExitToSite {
+    enabled: boolean;
+    path: string;
+    label?: string;
+}
+export interface ResolvedBackofficeCapabilities {
+    awesomebar: ResolvedCapability;
+    notifications: ResolvedCapability;
+    userMenu: ResolvedCapability & {
+        themeToggle: boolean;
+        logout: boolean;
+        exitToSite: ResolvedExitToSite;
+    };
+    help: ResolvedCapability;
+    sidebar: ResolvedCapability;
+    quickEntry: ResolvedCapability;
+    views: ResolvedCapability & {
+        allow: readonly BackofficeView[];
+    };
+    newDoc: ResolvedCapability;
+    bulkActions: ResolvedCapability;
+    attachments: ResolvedCapability;
+    timeline: ResolvedCapability;
+    assignments: ResolvedCapability;
+    tags: ResolvedCapability;
+    shares: ResolvedCapability;
+    print: ResolvedCapability;
+    email: ResolvedCapability;
+}
+export declare function resolveCapabilities(input?: BackofficeCapabilities): ResolvedBackofficeCapabilities;
+/** Doctype reachability scope (allow wins over deny being absent; deny always wins). */
+export interface BackofficeDoctypeScope {
+    /** When set, only these doctypes are reachable. */
+    allow?: readonly string[];
+    /** Always-unreachable doctypes (applied after `allow`). */
+    deny?: readonly string[];
+}
+export declare function isDoctypeAllowed(scope: BackofficeDoctypeScope | undefined, doctype: string): boolean;
+//# sourceMappingURL=capabilities.d.ts.map

package/types/config/capabilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../../src/config/capabilities.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAoB,KAAK,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE5E,sDAAsD;AACtD,MAAM,MAAM,eAAe,CAAC,MAAM,SAAS,MAAM,GAAG;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,IACrE,OAAO,GACP,CAAC,MAAM,GAAG;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,GAChC,SAAS,CAAC;AAEd,MAAM,WAAW,sBAAsB;IACrC,uDAAuD;IACvD,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,qDAAqD;IACrD,aAAa,CAAC,EAAE,eAAe,CAAC;IAChC,uEAAuE;IACvE,QAAQ,CAAC,EAAE,eAAe,CAAC;QACzB,wEAAwE;QACxE,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB,+BAA+B;QAC/B,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB;;;;WAIG;QACH,UAAU,CAAC,EAAE,OAAO,GAAG;YAAE,OAAO,CAAC,EAAE,OAAO,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAC;YAAC,KAAK,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KAC7E,CAAC,CAAC;IACH,6EAA6E;IAC7E,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,wDAAwD;IACxD,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,kDAAkD;IAClD,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,+DAA+D;IAC/D,KAAK,CAAC,EAAE,eAAe,CAAC;QAAE,KAAK,CAAC,EAAE,SAAS,cAAc,EAAE,CAAA;KAAE,CAAC,CAAC;IAC/D,6EAA6E;IAC7E,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,kEAAkE;IAClE,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B,wCAAwC;IACxC,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B,mEAAmE;IACnE,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,qDAAqD;IACrD,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B,uCAAuC;IACvC,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,+BAA+B;IAC/B,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,yBAAyB;IACzB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,yCAAyC;IACzC,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,8BAA8B;IAC7C,UAAU,EAAE,kBAAkB,CAAC;IAC/B,aAAa,EAAE,kBAAkB,CAAC;IAClC,QAAQ,EAAE,kBAAkB,GAAG;QAC7B,WAAW,EAAE,OAAO,CAAC;QACrB,MAAM,EAAE,OAAO,CAAC;QAChB,UAAU,EAAE,kBAAkB,CAAC;KAChC,CAAC;IACF,IAAI,EAAE,kBAAkB,CAAC;IACzB,OAAO,EAAE,kBAAkB,CAAC;IAC5B,UAAU,EAAE,kBAAkB,CAAC;IAC/B,KAAK,EAAE,kBAAkB,GAAG;QAAE,KAAK,EAAE,SAAS,cAAc,EAAE,CAAA;KAAE,CAAC;IACjE,MAAM,EAAE,kBAAkB,CAAC;IAC3B,WAAW,EAAE,kBAAkB,CAAC;IAChC,WAAW,EAAE,kBAAkB,CAAC;IAChC,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,WAAW,EAAE,kBAAkB,CAAC;IAChC,IAAI,EAAE,kBAAkB,CAAC;IACzB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,KAAK,EAAE,kBAAkB,CAAC;CAC3B;AA2BD,wBAAgB,mBAAmB,CACjC,KAAK,GAAE,sBAA2B,GACjC,8BAA8B,CA6BhC;AAED,wFAAwF;AACxF,MAAM,WAAW,sBAAsB;IACrC,mDAAmD;IACnD,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,2DAA2D;IAC3D,IAAI,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC1B;AAED,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,sBAAsB,GAAG,SAAS,EACzC,OAAO,EAAE,MAAM,GACd,OAAO,CAKT"}

package/types/config/events.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Host event bus — `onEvent` on the provider receives every notable thing
+ * the embedded backoffice does, so host apps can sync their own chrome,
+ * analytics, or state.
+ */
+export type BackofficeEvent = 
+/** Any navigation performed through the backoffice navigator. */
+{
+    type: "navigate";
+    path: string;
+    mode: "push" | "replace" | "back";
+}
+/** A document form was opened. */
+ | {
+    type: "doc-opened";
+    doctype: string;
+    name: string;
+}
+/** A document was saved (`isNew` for first inserts). */
+ | {
+    type: "doc-saved";
+    doctype: string;
+    name: string;
+    isNew?: boolean;
+}
+/** A document was deleted. */
+ | {
+    type: "doc-deleted";
+    doctype: string;
+    name: string;
+}
+/** A surface caught an operational error worth surfacing to the host. */
+ | {
+    type: "error";
+    error: unknown;
+    context?: string;
+};
+export type BackofficeEventHandler = (event: BackofficeEvent) => void;
+//# sourceMappingURL=events.d.ts.map

package/types/config/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/config/events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,MAAM,eAAe;AACzB,iEAAiE;AAC/D;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAAA;CAAE;AACvE,kCAAkC;GAChC;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE;AACvD,wDAAwD;GACtD;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE;AACvE,8BAA8B;GAC5B;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE;AACxD,yEAAyE;GACvE;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,OAAO,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAExD,MAAM,MAAM,sBAAsB,GAAG,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC"}

package/types/config/slots.d.ts

@@ -0,0 +1,32 @@
+import type { ReactNode } from "react";
+/**
+ * Host render-prop slots — the highest-leverage replacement points. Slots
+ * are provider-level (they apply everywhere the surface renders); when a
+ * slot is undefined the built-in rendering is used.
+ */
+export interface BackofficeSlots {
+    /**
+     * Replace the shell navbar CONTENT (inside the styled banner bar).
+     * `defaultContent` is the built-in navbar row (home button, awesomebar,
+     * bell/help/user chrome) so hosts can wrap instead of rebuild.
+     */
+    renderShellHeader?: (context: {
+        defaultContent: ReactNode;
+    }) => ReactNode;
+    /** Rendered at the bottom of the workspace sidebar (rail and drawer). */
+    renderSidebarFooter?: () => ReactNode;
+    /** Replace the list screen's empty state. (Consumed by the list surface.) */
+    renderListEmpty?: (context: {
+        doctype: string;
+    }) => ReactNode;
+    /**
+     * Replace the document form header row. (Consumed by the form surface.)
+     * `name` is undefined for new (unsaved) documents.
+     */
+    renderFormHeader?: (context: {
+        doctype: string;
+        name?: string;
+        defaultContent: ReactNode;
+    }) => ReactNode;
+}
+//# sourceMappingURL=slots.d.ts.map

package/types/config/slots.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slots.d.ts","sourceRoot":"","sources":["../../src/config/slots.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEvC;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,cAAc,EAAE,SAAS,CAAA;KAAE,KAAK,SAAS,CAAC;IAC1E,yEAAyE;IACzE,mBAAmB,CAAC,EAAE,MAAM,SAAS,CAAC;IACtC,6EAA6E;IAC7E,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,KAAK,SAAS,CAAC;IAC9D;;;OAGG;IACH,gBAAgB,CAAC,EAAE,CAAC,OAAO,EAAE;QAC3B,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,cAAc,EAAE,SAAS,CAAC;KAC3B,KAAK,SAAS,CAAC;CACjB"}

package/types/i18n/en.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Bundled English resources for the "backoffice" i18n namespace.
+ *
+ * Keys mirror the surface structure (shell/sidebar/awesomebar/notifications/
+ * userMenu/help). Host apps override by registering their own bundle:
+ *
+ *   i18next.addResourceBundle("en", "backoffice", { shell: { title: "Admin" } }, true, true);
+ */
+export declare const en: {
+    readonly shell: {
+        readonly title: "Backoffice";
+        readonly home: "Home";
+        readonly toggleSidebar: "Toggle sidebar";
+    };
+    readonly sidebar: {
+        readonly private: "Private";
+        readonly public: "Public";
+        readonly loading: "Loading workspaces";
+    };
+    readonly awesomebar: {
+        readonly triggerLabel: "Search";
+        readonly placeholder: "Search or type a command…";
+        readonly label: "Search or type a command";
+        readonly results: "Search results";
+        readonly recents: "Recents";
+        readonly actions: "Actions";
+        readonly navigation: "Navigation";
+        readonly documents: "Documents";
+        readonly listCommand: "{{doctype}} List";
+        readonly newCommand: "New {{doctype}}";
+        readonly reportCommand: "{{doctype}} Report";
+        readonly kanbanCommand: "{{doctype}} Kanban";
+        readonly workspaceBadge: "Workspace";
+        readonly doctypeBadge: "DocType";
+        readonly searching: "Searching…";
+        readonly noResults: "No results for “{{query}}”";
+        readonly empty: "Type to search…";
+        readonly hintNavigate: "navigate";
+        readonly hintOpen: "open";
+        readonly hintClose: "close";
+    };
+    readonly notifications: {
+        readonly title: "Notifications";
+        readonly untitled: "Notification";
+        readonly markAllRead: "Mark all as read";
+        readonly settingsUnavailable: "Notification settings (not available yet)";
+        readonly emptyTitle: "No new notifications";
+        readonly emptyDescription: "Mentions, assignments, and shares will show up here.";
+    };
+    readonly userMenu: {
+        readonly label: "User menu";
+        readonly sessionUnavailable: "Session not loaded";
+        readonly myProfile: "My Profile";
+        readonly mySettings: "My Settings";
+        readonly sessionDefaults: "Session Defaults";
+        readonly sessionDefaultsGap: "Not implemented yet";
+        readonly reload: "Reload";
+        readonly toggleTheme: "Toggle Theme";
+        readonly themeUnavailable: "Theme switching is unavailable on this platform";
+        readonly viewWebsite: "View Website";
+        readonly exitToSite: "← multiplatform.one";
+        readonly logOut: "Log Out";
+    };
+    readonly help: {
+        readonly label: "Help";
+        readonly documentation: "Documentation";
+        readonly userForum: "User Forum";
+        readonly reportIssue: "Report an Issue";
+        readonly keyboardShortcuts: "Keyboard Shortcuts";
+        readonly about: "About";
+        readonly aboutTitle: "About";
+        readonly aboutTagline: "Backoffice is the multiplatform.one recreation of the Frappe Desk — one codebase across web, mobile, and desktop.";
+        readonly installedApps: "Installed Apps";
+        readonly versionsUnavailable: "Version information is unavailable.";
+        readonly close: "Close";
+        readonly shortcutsTitle: "Keyboard Shortcuts";
+        readonly shortcutsIntro: "Shortcuts available across the backoffice (web).";
+        readonly shortcutFocusSearch: "Open the command palette";
+        readonly shortcutSaveForm: "Save the open document";
+        readonly shortcutCloseOverlays: "Close dialogs and menus";
+    };
+};
+//# sourceMappingURL=en.d.ts.map

package/types/i18n/en.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"en.d.ts","sourceRoot":"","sources":["../../src/i18n/en.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,eAAO,MAAM,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0EL,CAAC"}

package/types/i18n/index.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Backoffice i18n — the package ships its own translations under the
+ * "backoffice" namespace (English bundled; more languages can join the
+ * BUNDLED_RESOURCES map) and registers them into the ambient i18next
+ * instance, following @multiplatform.one/i18n conventions:
+ *
+ *   - registration is additive: `addResourceBundle(lng, ns, …, deep=true,
+ *     overwrite=false)`, so anything the HOST already registered for the
+ *     namespace wins, and a Frappe i18n backend (partialBundledLanguages)
+ *     can still supplement over the bundle.
+ *   - every t() call in the package also carries an inline English default,
+ *     so a missing bundle degrades to English instead of raw keys.
+ *
+ * When no i18next instance was initialized at all (a host app that does not
+ * use i18n), the provider initializes a minimal English-only instance so
+ * react-i18next binds a working `t`.
+ */
+import { type i18n as I18nInstance } from "i18next";
+export declare const BACKOFFICE_I18N_NAMESPACE = "backoffice";
+/**
+ * Idempotently register the bundled backoffice translations on `instance`
+ * (the global i18next singleton by default). Safe to call before the host
+ * initializes i18next — registration is deferred to the `initialized` event.
+ * Called automatically by BackofficeProvider.
+ */
+export declare function registerBackofficeTranslations(instance?: I18nInstance): void;
+//# sourceMappingURL=index.d.ts.map

package/types/i18n/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/i18n/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAgB,EAAE,KAAK,IAAI,IAAI,YAAY,EAAE,MAAM,SAAS,CAAC;AAI7D,eAAO,MAAM,yBAAyB,eAAe,CAAC;AAetD;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAAC,QAAQ,GAAE,YAAsB,GAAG,IAAI,CA0BrF"}

package/types/index.d.ts

@@ -0,0 +1,55 @@
+/**
+ * @multiplatform.one/backoffice — embeddable Frappe desk recreation.
+ *
+ * Mount BackofficeProvider (frappe connection + navigation adapter +
+ * capability flags) around the surfaces you want; BackofficeShell is the
+ * full desk chrome. See README.md for the embedding story.
+ *
+ * The one-router adapter lives on the `./one-adapter` subpath so this entry
+ * stays router-free.
+ */
+export { BackofficeProvider, useBackofficeCapabilities, useBackofficeConfig, useBackofficeLocation, useBackofficeNavigator, useBackofficePaths, useBackofficeSlots, useIsDoctypeAllowed, } from "./config/BackofficeProvider";
+export type { BackofficeAction, BackofficeActionContext, BackofficeActions, BackofficeAppearance, BackofficeConfig, BackofficeFrappeConfig, BackofficeProviderProps, } from "./config/BackofficeProvider";
+export { isDoctypeAllowed, resolveCapabilities } from "./config/capabilities";
+export type { BackofficeCapabilities, BackofficeDoctypeScope, CapabilityInput, ResolvedBackofficeCapabilities, ResolvedCapability, ResolvedExitToSite, } from "./config/capabilities";
+export type { BackofficeEvent, BackofficeEventHandler } from "./config/events";
+export type { BackofficeSlots } from "./config/slots";
+export { ControlledNavigator, MemoryNavigator, createMemoryNavigator, createNoopNavigator, parseBackofficeHref, } from "./navigation/navigator";
+export type { BackofficeLocation, BackofficeNavigator, BackofficeParams, ControlledNavigatorHandlers, } from "./navigation/navigator";
+export { BACKOFFICE_BASE, BACKOFFICE_VIEWS, createBackofficePaths, formPath, homePath, isBackofficeView, listPath, newDocPath, parseDocDefaults, slugToDisplayName, toSlug, viewPath, workspacePath, } from "./navigation/paths";
+export type { BackofficePath, BackofficePaths, BackofficeSubPath, BackofficeView, } from "./navigation/paths";
+export { BACKOFFICE_I18N_NAMESPACE, registerBackofficeTranslations } from "./i18n";
+export { BackofficeShell } from "./shell/BackofficeShell";
+export type { BackofficeShellProps } from "./shell/BackofficeShell";
+export { WORKSPACE_SIDEBAR_WIDTH, WorkspaceSidebar } from "./shell/WorkspaceSidebar";
+export type { WorkspaceSidebarProps } from "./shell/WorkspaceSidebar";
+export { useDefaultWorkspace, useSessionUser, useWorkspaces } from "./shell/useWorkspaces";
+export type { WorkspaceDoc, WorkspacesResult } from "./shell/useWorkspaces";
+export { workspaceIcon } from "./shell/workspaceIcons";
+export { BackofficeAwesomebar } from "./chrome/BackofficeAwesomebar";
+export type { BackofficeAwesomebarHandle, BackofficeAwesomebarProps, } from "./chrome/BackofficeAwesomebar";
+export { CommandPalette } from "./chrome/CommandPalette";
+export type { CommandPaletteProps } from "./chrome/CommandPalette";
+export { useCommandPaletteModel } from "./chrome/command-palette-model";
+export type { CommandPaletteItem, CommandPaletteModel, CommandPaletteSection, CommandPaletteSectionId, UseCommandPaletteModelOptions, } from "./chrome/command-palette-model";
+export { rankNameMatches, readRecentItems, toContentSnippet, useAwesomebarCatalog, useGlobalSearch, } from "./chrome/awesomebar-data";
+export type { AwesomebarCatalog, AwesomebarCatalogState, AwesomebarWorkspace, GlobalSearchHit, GlobalSearchState, RecentItem, } from "./chrome/awesomebar-data";
+export { NotificationsButton } from "./chrome/NotificationsButton";
+export { NotificationsPanel } from "./chrome/notifications-panel";
+export type { NotificationsPanelProps } from "./chrome/notifications-panel";
+export { useNotifications } from "./chrome/notifications-data";
+export type { NotificationItem, NotificationLogDoc, UseNotificationsResult, } from "./chrome/notifications-data";
+export { parseFrappeTimestamp, stripHtmlToText } from "./chrome/notifications-utils";
+export { HelpMenu } from "./chrome/HelpMenu";
+export { HelpAboutDialog } from "./chrome/help-about-dialog";
+export type { FrappeAppVersion, HelpAboutDialogProps } from "./chrome/help-about-dialog";
+export { HelpShortcutsDialog } from "./chrome/help-shortcuts-dialog";
+export type { HelpShortcutsDialogProps } from "./chrome/help-shortcuts-dialog";
+export { UserMenu } from "./chrome/UserMenu";
+export type { UserMenuProps } from "./chrome/UserMenu";
+export { clearSessionUserCache, resolveUserImageUrl, useSessionUserInfo, } from "./chrome/user-session";
+export type { SessionUserInfo } from "./chrome/user-session";
+export { useBackofficeShortcuts } from "./chrome/shortcuts";
+export type { BackofficeShortcutHandlers } from "./chrome/shortcuts";
+export { useFrappeApp } from "./shared/useFrappeApp";
+//# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EACL,kBAAkB,EAClB,yBAAyB,EACzB,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,6BAA6B,CAAC;AACrC,YAAY,EACV,gBAAgB,EAChB,uBAAuB,EACvB,iBAAiB,EACjB,oBAAoB,EACpB,gBAAgB,EAChB,sBAAsB,EACtB,uBAAuB,GACxB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC9E,YAAY,EACV,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EACf,8BAA8B,EAC9B,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAC/E,YAAY,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAGtD,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,qBAAqB,EACrB,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,wBAAwB,CAAC;AAChC,YAAY,EACV,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,2BAA2B,GAC5B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,qBAAqB,EACrB,QAAQ,EACR,QAAQ,EACR,gBAAgB,EAChB,QAAQ,EACR,UAAU,EACV,gBAAgB,EAChB,iBAAiB,EACjB,MAAM,EACN,QAAQ,EACR,aAAa,GACd,MAAM,oBAAoB,CAAC;AAC5B,YAAY,EACV,cAAc,EACd,eAAe,EACf,iBAAiB,EACjB,cAAc,GACf,MAAM,oBAAoB,CAAC;AAG5B,OAAO,EAAE,yBAAyB,EAAE,8BAA8B,EAAE,MAAM,QAAQ,CAAC;AAGnF,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,YAAY,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AACpE,OAAO,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AACrF,YAAY,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACtE,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC3F,YAAY,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAGvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,YAAY,EACV,0BAA0B,EAC1B,yBAAyB,GAC1B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,YAAY,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,YAAY,EACV,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,6BAA6B,GAC9B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,GAChB,MAAM,0BAA0B,CAAC;AAClC,YAAY,EACV,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,eAAe,EACf,iBAAiB,EACjB,UAAU,GACX,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClE,YAAY,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,YAAY,EACV,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACrF,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,YAAY,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AACzF,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,YAAY,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAC/E,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EACL,qBAAqB,EACrB,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,YAAY,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAGrE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC"}

package/types/navigation/navigator.d.ts

@@ -0,0 +1,98 @@
+/**
+ * Backoffice navigation seam.
+ *
+ * The backoffice never imports a router. Every surface navigates through a
+ * host-supplied {@link BackofficeNavigator} — a deliberately minimal contract
+ * (push/replace/back + a subscribable location) that any routing runtime can
+ * satisfy in a few lines:
+ *
+ *   - One router      → `useOneNavigator()` from
+ *                       `@multiplatform.one/backoffice/one-adapter`
+ *   - tests/storybook → {@link createMemoryNavigator}
+ *   - custom hosts    → {@link ControlledNavigator} (bridge callbacks in,
+ *                       mirror location back with `setLocation`)
+ *
+ * This is intentionally lighter than the stack-navigation seam in
+ * `@multiplatform.one/router/seam`: that module OWNS a navigation stack
+ * (route manifest + host stack adapter) for targets with no router at all,
+ * while this contract EMBEDS into whatever router the host app already runs.
+ * A seam-backed host can still implement this interface over its
+ * StackNavigator (push/replace/back map 1:1, location from `useNavState`).
+ */
+export type BackofficeParams = Record<string, string | string[] | undefined>;
+export interface BackofficeLocation {
+    /** Current pathname (no query string), e.g. `"/backoffice/todo"`. */
+    path: string;
+    /** Dynamic route segments merged with query params (One router semantics). */
+    params: BackofficeParams;
+}
+export interface BackofficeNavigator {
+    /** Push a new history entry. */
+    navigate(path: string): void;
+    /** Replace the current history entry. */
+    replace(path: string): void;
+    /** Go back one entry. */
+    back(): void;
+    /** Snapshot of the current location (stable identity until it changes). */
+    getLocation(): BackofficeLocation;
+    /** Subscribe to location changes. Returns an unsubscribe function. */
+    subscribe(listener: () => void): () => void;
+}
+/** Split an href into a {@link BackofficeLocation} (query → params). */
+export declare function parseBackofficeHref(href: string): BackofficeLocation;
+type Listener = () => void;
+declare abstract class SubscribableNavigator implements BackofficeNavigator {
+    protected listeners: Set<Listener>;
+    protected location: BackofficeLocation;
+    constructor(initialLocation: BackofficeLocation);
+    abstract navigate(path: string): void;
+    abstract replace(path: string): void;
+    abstract back(): void;
+    getLocation: () => BackofficeLocation;
+    subscribe: (listener: Listener) => (() => void);
+    protected setLocationInternal(next: BackofficeLocation): void;
+}
+/**
+ * In-memory navigator — a self-contained history stack for tests, stories,
+ * and hosts with no routing runtime (e.g. a modal embedding of a single
+ * backoffice surface).
+ */
+export declare class MemoryNavigator extends SubscribableNavigator {
+    private stack;
+    constructor(initialPath?: string);
+    /** History entries, oldest first (test introspection). */
+    get entries(): readonly BackofficeLocation[];
+    navigate: (path: string) => void;
+    replace: (path: string) => void;
+    back: () => void;
+}
+export declare function createMemoryNavigator(initialPath?: string): MemoryNavigator;
+export interface ControlledNavigatorHandlers {
+    navigate(path: string): void;
+    replace(path: string): void;
+    back(): void;
+}
+/**
+ * Bridge navigator for adapters over an external router: navigation calls
+ * forward to the host handlers, and the host mirrors its location back via
+ * {@link ControlledNavigator.setLocation}. The one-adapter is ~20 lines over
+ * this class; a react-router or seam adapter looks the same.
+ */
+export declare class ControlledNavigator extends SubscribableNavigator {
+    private handlers;
+    constructor(handlers: ControlledNavigatorHandlers, initialLocation?: BackofficeLocation);
+    /** Swap the forwarding callbacks (adapters keep them fresh per render). */
+    setHandlers(handlers: ControlledNavigatorHandlers): void;
+    /** Mirror the host router's current location into the navigator. */
+    setLocation(next: BackofficeLocation): void;
+    navigate: (path: string) => void;
+    replace: (path: string) => void;
+    back: () => void;
+}
+/**
+ * Inert navigator — the default-context fallback so package surfaces render
+ * (and stories mount) without a BackofficeProvider. Navigation is a no-op.
+ */
+export declare function createNoopNavigator(initialPath?: string): BackofficeNavigator;
+export {};
+//# sourceMappingURL=navigator.d.ts.map

package/types/navigation/navigator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigator.d.ts","sourceRoot":"","sources":["../../src/navigation/navigator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;AAE7E,MAAM,WAAW,kBAAkB;IACjC,qEAAqE;IACrE,IAAI,EAAE,MAAM,CAAC;IACb,8EAA8E;IAC9E,MAAM,EAAE,gBAAgB,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,gCAAgC;IAChC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,yCAAyC;IACzC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,yBAAyB;IACzB,IAAI,IAAI,IAAI,CAAC;IACb,2EAA2E;IAC3E,WAAW,IAAI,kBAAkB,CAAC;IAClC,sEAAsE;IACtE,SAAS,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;CAC7C;AA+BD,wEAAwE;AACxE,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,kBAAkB,CAKpE;AAED,KAAK,QAAQ,GAAG,MAAM,IAAI,CAAC;AAE3B,uBAAe,qBAAsB,YAAW,mBAAmB;IACjE,SAAS,CAAC,SAAS,gBAAuB;IAC1C,SAAS,CAAC,QAAQ,EAAE,kBAAkB,CAAC;gBAE3B,eAAe,EAAE,kBAAkB;IAI/C,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IACrC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IACpC,QAAQ,CAAC,IAAI,IAAI,IAAI;IAErB,WAAW,QAAO,kBAAkB,CAAkB;IAEtD,SAAS,GAAI,UAAU,QAAQ,KAAG,CAAC,MAAM,IAAI,CAAC,CAG5C;IAEF,SAAS,CAAC,mBAAmB,CAAC,IAAI,EAAE,kBAAkB,GAAG,IAAI;CAK9D;AAED;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,qBAAqB;IACxD,OAAO,CAAC,KAAK,CAAuB;gBAExB,WAAW,SAAgB;IAMvC,0DAA0D;IAC1D,IAAI,OAAO,IAAI,SAAS,kBAAkB,EAAE,CAE3C;IAED,QAAQ,GAAI,MAAM,MAAM,KAAG,IAAI,CAI7B;IAEF,OAAO,GAAI,MAAM,MAAM,KAAG,IAAI,CAI5B;IAEF,IAAI,QAAO,IAAI,CAKb;CACH;AAED,wBAAgB,qBAAqB,CAAC,WAAW,SAAgB,GAAG,eAAe,CAElF;AAED,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,IAAI,IAAI,IAAI,CAAC;CACd;AAED;;;;;GAKG;AACH,qBAAa,mBAAoB,SAAQ,qBAAqB;IAC5D,OAAO,CAAC,QAAQ,CAA8B;gBAElC,QAAQ,EAAE,2BAA2B,EAAE,eAAe,CAAC,EAAE,kBAAkB;IAKvF,2EAA2E;IAC3E,WAAW,CAAC,QAAQ,EAAE,2BAA2B,GAAG,IAAI;IAIxD,oEAAoE;IACpE,WAAW,CAAC,IAAI,EAAE,kBAAkB,GAAG,IAAI;IAI3C,QAAQ,GAAI,MAAM,MAAM,KAAG,IAAI,CAE7B;IAEF,OAAO,GAAI,MAAM,MAAM,KAAG,IAAI,CAE5B;IAEF,IAAI,QAAO,IAAI,CAEb;CACH;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,SAAgB,GAAG,mBAAmB,CASpF"}