@multiplatform.one/backoffice 6.3.0

package/types/navigation/paths.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Backoffice route paths.
+ *
+ * Route map (relative to the mount `basePath`, default "/backoffice"):
+ *   {base}                          → home (default workspace)
+ *   {base}/[slug]                   → workspace page OR doctype list (runtime-resolved)
+ *   {base}/[slug]/view/[view]       → alternate doctype views (report, kanban, …)
+ *   {base}/[slug]/new               → new document (optional `?d=` JSON prefill)
+ *   {base}/[slug]/[name]            → document form page
+ *
+ * Slugs follow frappe's router slugs: lowercase, spaces → dashes
+ * ("Sales Order" → "sales-order").
+ *
+ * Surfaces inside the package MUST build paths through
+ * `useBackofficeConfig().paths` (basePath-aware). The default-bound helpers
+ * at the bottom exist for host apps mounted at the canonical "/backoffice"
+ * prefix — their template-literal return types match one-router's generated
+ * typed-route unions so they can be passed straight to router.push and
+ * <Link href>.
+ */
+export declare const BACKOFFICE_BASE = "/backoffice";
+export type BackofficeSubPath = `${typeof BACKOFFICE_BASE}/${string}`;
+export type BackofficePath = typeof BACKOFFICE_BASE | BackofficeSubPath;
+export declare const BACKOFFICE_VIEWS: readonly ["list", "report", "kanban", "calendar", "tree", "image", "dashboard"];
+export type BackofficeView = (typeof BACKOFFICE_VIEWS)[number];
+export declare function isBackofficeView(value: string): value is BackofficeView;
+/** frappe.router.slug: "Sales Order" → "sales-order" */
+export declare function toSlug(name: string): string;
+/** Best-effort display name from a slug: "sales-order" → "Sales Order" */
+export declare function slugToDisplayName(slug: string): string;
+/**
+ * Parse the `?d=` new-doc defaults query (urlencoded JSON object). The
+ * router usually decodes the param already, so the raw value is tried first.
+ * Malformed or non-object input degrades to no defaults.
+ */
+export declare function parseDocDefaults(raw: string | undefined): Record<string, unknown> | undefined;
+/** Path builders bound to a mount prefix. */
+export interface BackofficePaths {
+    /** The mount prefix these builders are bound to (no trailing slash). */
+    base: string;
+    home(): string;
+    workspace(workspaceName: string): string;
+    list(doctype: string): string;
+    view(doctype: string, view: BackofficeView): string;
+    /**
+     * New-document route. Optional `defaults` become the create form's initial
+     * field values, carried as `?d=<urlencoded JSON object>` — desk parity for
+     * creating from context (kanban column "+", calendar day click, …).
+     */
+    newDoc(doctype: string, defaults?: Record<string, unknown>): string;
+    form(doctype: string, name: string): string;
+}
+export declare function createBackofficePaths(basePath?: string): BackofficePaths;
+export declare function homePath(): BackofficePath;
+export declare function workspacePath(workspaceName: string): BackofficeSubPath;
+export declare function listPath(doctype: string): BackofficeSubPath;
+export declare function viewPath(doctype: string, view: BackofficeView): BackofficeSubPath;
+export declare function newDocPath(doctype: string, defaults?: Record<string, unknown>): BackofficeSubPath;
+export declare function formPath(doctype: string, name: string): BackofficeSubPath;
+//# sourceMappingURL=paths.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../../src/navigation/paths.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,eAAO,MAAM,eAAe,gBAAgB,CAAC;AAE7C,MAAM,MAAM,iBAAiB,GAAG,GAAG,OAAO,eAAe,IAAI,MAAM,EAAE,CAAC;AACtE,MAAM,MAAM,cAAc,GAAG,OAAO,eAAe,GAAG,iBAAiB,CAAC;AAExE,eAAO,MAAM,gBAAgB,iFAQnB,CAAC;AAEX,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,cAAc,CAEvE;AAED,wDAAwD;AACxD,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED,0EAA0E;AAC1E,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAoB7F;AAED,6CAA6C;AAC7C,MAAM,WAAW,eAAe;IAC9B,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,IAAI,MAAM,CAAC;IACf,SAAS,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,CAAC;IACzC,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,MAAM,CAAC;IACpD;;;;OAIG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC;IACpE,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;CAC7C;AAED,wBAAgB,qBAAqB,CAAC,QAAQ,GAAE,MAAwB,GAAG,eAAe,CAmBzF;AAQD,wBAAgB,QAAQ,IAAI,cAAc,CAEzC;AAED,wBAAgB,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,iBAAiB,CAEtE;AAED,wBAAgB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,iBAAiB,CAE3D;AAED,wBAAgB,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,iBAAiB,CAEjF;AAED,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,iBAAiB,CAEjG;AAED,wBAAgB,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,iBAAiB,CAEzE"}

package/types/oneAdapter/index.d.ts

@@ -0,0 +1,8 @@
+import { type BackofficeNavigator } from "../navigation/navigator";
+/**
+ * A {@link BackofficeNavigator} backed by One's router. Referentially stable
+ * across renders; the current pathname + search params are mirrored into the
+ * navigator's subscribable location after every route change.
+ */
+export declare function useOneNavigator(): BackofficeNavigator;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/oneAdapter/index.tsx"],"names":[],"mappings":"AAkBA,OAAO,EAEL,KAAK,mBAAmB,EAEzB,MAAM,yBAAyB,CAAC;AAMjC;;;;GAIG;AACH,wBAAgB,eAAe,IAAI,mBAAmB,CA2BrD"}

package/types/shared/useFrappeApp.d.ts

@@ -0,0 +1,10 @@
+import { FrappeApp } from "@multiplatform.one/frappe";
+/**
+ * Memoized FrappeApp built from the ambient FrappeProvider config (mounted
+ * by BackofficeProvider). Use `app.call()` for desk RPCs, `app.db()` for
+ * CRUD, `app.file()` for uploads. Prefer Frappe* components /
+ * useFrappeCollection where possible — reach for this only when no component
+ * covers the API. Returns undefined outside a provider.
+ */
+export declare function useFrappeApp(): FrappeApp | undefined;
+//# sourceMappingURL=useFrappeApp.d.ts.map

package/types/shared/useFrappeApp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useFrappeApp.d.ts","sourceRoot":"","sources":["../../src/shared/useFrappeApp.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAmB,MAAM,2BAA2B,CAAC;AAMvE;;;;;;GAMG;AACH,wBAAgB,YAAY,IAAI,SAAS,GAAG,SAAS,CAyBpD"}

package/types/shell/BackofficeShell.d.ts

@@ -0,0 +1,10 @@
+import type React from "react";
+export interface BackofficeShellProps {
+    children: React.ReactNode;
+    /** Current path for the sidebar active state (default: navigator location). */
+    activePath?: string;
+    /** Navigation handler (default: navigator push). */
+    onNavigate?: (path: string) => void;
+}
+export declare function BackofficeShell({ children, activePath, onNavigate }: BackofficeShellProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=BackofficeShell.d.ts.map

package/types/shell/BackofficeShell.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackofficeShell.d.ts","sourceRoot":"","sources":["../../src/shell/BackofficeShell.tsx"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAqB/B,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;IAC1B,+EAA+E;IAC/E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CACrC;AAWD,wBAAgB,eAAe,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,oBAAoB,2CAuKzF"}

package/types/shell/WorkspaceSidebar.d.ts

@@ -0,0 +1,9 @@
+export declare const WORKSPACE_SIDEBAR_WIDTH = 250;
+export interface WorkspaceSidebarProps {
+    /** Current path, used to highlight the active workspace. */
+    activePath?: string;
+    /** Called with the target path when a workspace is selected. */
+    onNavigate?: (path: string) => void;
+}
+export declare function WorkspaceSidebar({ activePath, onNavigate }: WorkspaceSidebarProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=WorkspaceSidebar.d.ts.map

package/types/shell/WorkspaceSidebar.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkspaceSidebar.d.ts","sourceRoot":"","sources":["../../src/shell/WorkspaceSidebar.tsx"],"names":[],"mappings":"AAwBA,eAAO,MAAM,uBAAuB,MAAM,CAAC;AAE3C,MAAM,WAAW,qBAAqB;IACpC,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gEAAgE;IAChE,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CACrC;AAiDD,wBAAgB,gBAAgB,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,qBAAqB,2CAsCjF"}

package/types/shell/useWorkspaces.d.ts

@@ -0,0 +1,43 @@
+export interface WorkspaceDoc {
+    name: string;
+    doctype: string;
+    title?: string;
+    icon?: string;
+    parent_page?: string;
+    public?: 0 | 1;
+    for_user?: string;
+    sequence_id?: number;
+    module?: string;
+    is_hidden?: 0 | 1;
+}
+/**
+ * The frappe session user ("Administrator", …), or undefined while loading,
+ * for Guest sessions, in fixture mode, without a provider, or when the
+ * endpoint is unreachable.
+ */
+export declare function useSessionUser(): string | undefined;
+export interface WorkspacesResult {
+    /** All visible workspaces, sorted by sequence_id. */
+    workspaces: WorkspaceDoc[];
+    /** Session user's private workspaces (desk shows these on top). */
+    privateWorkspaces: WorkspaceDoc[];
+    /** Public root workspaces (no parent_page), ordered by sequence_id. */
+    publicRoots: WorkspaceDoc[];
+    /** Children of a public workspace, keyed by parent name. */
+    childrenByParent: Map<string, WorkspaceDoc[]>;
+    /** True until the first snapshot arrives (always true server-side). */
+    isLoading: boolean;
+    /** Session user, once known (never set in fixture mode). */
+    sessionUser?: string;
+}
+export declare function useWorkspaces(): WorkspacesResult;
+/**
+ * The workspace the backoffice home should land on — desk parity: the
+ * user's first private workspace, else the first public workspace by
+ * sequence order.
+ */
+export declare function useDefaultWorkspace(): {
+    workspace?: string;
+    isLoading: boolean;
+};
+//# sourceMappingURL=useWorkspaces.d.ts.map

package/types/shell/useWorkspaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useWorkspaces.d.ts","sourceRoot":"","sources":["../../src/shell/useWorkspaces.ts"],"names":[],"mappings":"AAsBA,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;CACnB;AA8BD;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,MAAM,GAAG,SAAS,CA+BnD;AAMD,MAAM,WAAW,gBAAgB;IAC/B,qDAAqD;IACrD,UAAU,EAAE,YAAY,EAAE,CAAC;IAC3B,mEAAmE;IACnE,iBAAiB,EAAE,YAAY,EAAE,CAAC;IAClC,uEAAuE;IACvE,WAAW,EAAE,YAAY,EAAE,CAAC;IAC5B,4DAA4D;IAC5D,gBAAgB,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;IAC9C,uEAAuE;IACvE,SAAS,EAAE,OAAO,CAAC;IACnB,4DAA4D;IAC5D,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AASD,wBAAgB,aAAa,IAAI,gBAAgB,CA+DhD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,IAAI;IAAE,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,OAAO,CAAA;CAAE,CAIhF"}

package/types/shell/workspaceIcons.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Best-effort map from frappe desk icon names (Workspace.icon holds symbols
+ * from frappe's timeless icon sprite) to @phosphor-icons/react equivalents.
+ * Unknown names fall back to a generic workspace glyph.
+ */
+import { type Icon } from "@phosphor-icons/react";
+/** Resolve a frappe workspace icon name to a phosphor icon component. */
+export declare function workspaceIcon(name?: string): Icon;
+//# sourceMappingURL=workspaceIcons.d.ts.map

package/types/shell/workspaceIcons.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workspaceIcons.d.ts","sourceRoot":"","sources":["../../src/shell/workspaceIcons.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EA8BL,KAAK,IAAI,EACV,MAAM,uBAAuB,CAAC;AAoC/B,yEAAyE;AACzE,wBAAgB,aAAa,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAEjD"}