@multiplatform.one/backoffice 6.3.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,310 @@
+# @multiplatform.one/backoffice
+
+An embeddable, cross-platform recreation of the Frappe Desk. Drop the whole
+backoffice — shell chrome, workspaces, doctype lists, forms, views — into any
+React app on the multiplatform.one stack, mounted at any URL prefix, behind
+your own router, with flags for everything it shows and does.
+
+Built on `@multiplatform.one/frappe` (live data client) and
+`@multiplatform.one/frappe-ui` (doctype-aware components), rendering through
+Tamagui — the same code runs on web, React Native, and the GTK/webview
+targets the monorepo supports.
+
+## Install
+
+```sh
+pnpm add @multiplatform.one/backoffice
+# peers you likely already have:
+pnpm add react react-dom react-i18next i18next
+```
+
+`one` is an **optional** peer — only needed if you use the
+`@multiplatform.one/backoffice/one-adapter` subpath.
+
+## Concepts
+
+Everything hangs off one component:
+
+```
+<BackofficeProvider
+  frappe={…}        ← Frappe connection (feeds FrappeProvider internally)
+  navigation={…}    ← how the backoffice navigates (adapter, see below)
+  basePath={…}      ← URL prefix it is mounted under (default "/backoffice")
+  capabilities={…}  ← visibility/behavior flags (all default ON)
+  doctypes={…}      ← allow/deny doctype scoping
+  slots={…}         ← render-prop replacements for built-in chrome
+  onEvent={…}       ← event bus (navigation, doc lifecycle, errors)
+>
+```
+
+The backoffice never imports a router. It navigates through the
+`BackofficeNavigator` you hand it — three methods and a subscribable
+location:
+
+```ts
+interface BackofficeNavigator {
+  navigate(path: string): void;
+  replace(path: string): void;
+  back(): void;
+  getLocation(): { path: string; params: Record<string, string | string[] | undefined> };
+  subscribe(listener: () => void): () => void;
+}
+```
+
+## Minimal example (one screen)
+
+```tsx
+import {
+  BackofficeProvider,
+  BackofficeShell,
+  createMemoryNavigator,
+} from "@multiplatform.one/backoffice";
+
+const navigation = createMemoryNavigator("/backoffice");
+
+export function App() {
+  return (
+    <BackofficeProvider frappe={{ baseURL: "https://mysite.frappe.cloud" }} navigation={navigation}>
+      <BackofficeShell>
+        <MyRoutedContent />
+      </BackofficeShell>
+    </BackofficeProvider>
+  );
+}
+```
+
+## Full shell in a One app
+
+Routes stay thin files; the layout wires the adapter once:
+
+```tsx
+// routes/backoffice/_layout.tsx
+import { Slot } from "one";
+import { BackofficeProvider, BackofficeShell } from "@multiplatform.one/backoffice";
+import { useOneNavigator } from "@multiplatform.one/backoffice/one-adapter";
+
+export default function BackofficeLayout() {
+  const navigation = useOneNavigator();
+  return (
+    <BackofficeProvider
+      frappe={{
+        baseURL: process.env.ONE_PUBLIC_FRAPPE_URL!,
+        socketPort: 9000,
+        auth: { useToken: true, token: "key:secret", type: "token" },
+        syncOptions: { persistKey: "backoffice", cdcInterval: 30_000 },
+      }}
+      navigation={navigation}
+    >
+      <BackofficeShell>
+        <Slot />
+      </BackofficeShell>
+    </BackofficeProvider>
+  );
+}
+```
+
+Auth note: in cross-origin dev (app on one port, bench on another) the frappe
+`sid` cookie never attaches — pass token `auth`. Same-origin deployments
+behind a reverse proxy can omit `auth` and ride cookie auth.
+
+## Navigation adapters
+
+**One router** (subpath export, keeps the main entry router-free):
+
+```tsx
+import { useOneNavigator } from "@multiplatform.one/backoffice/one-adapter";
+const navigation = useOneNavigator();
+```
+
+**Memory** (tests, Storybook, router-less embeddings):
+
+```tsx
+import { createMemoryNavigator } from "@multiplatform.one/backoffice";
+const navigation = createMemoryNavigator("/backoffice");
+navigation.navigate("/backoffice/todo"); // full history stack, subscribable
+```
+
+**Anything else** — bridge your router with `ControlledNavigator`:
+
+```tsx
+import { ControlledNavigator } from "@multiplatform.one/backoffice";
+
+const navigation = new ControlledNavigator({
+  navigate: (path) => myRouter.push(path),
+  replace: (path) => myRouter.replace(path),
+  back: () => myRouter.back(),
+});
+// mirror your router's location back in (e.g. in a layout effect):
+navigation.setLocation({ path: myRouter.pathname, params: myRouter.query });
+```
+
+## Mount anywhere: `basePath`
+
+```tsx
+<BackofficeProvider basePath="/admin" …>
+```
+
+Every path the backoffice builds (sidebar workspaces, awesomebar commands,
+notification links) is rebound to the prefix. Path helpers are available to
+hosts too: `createBackofficePaths("/admin").form("ToDo", "abc")` →
+`"/admin/todo/abc"`.
+
+## Capability flags
+
+All flags default **ON**; pass booleans or per-feature config objects:
+
+```tsx
+<BackofficeProvider
+  capabilities={{
+    notifications: false,
+    userMenu: { themeToggle: false, logout: false },
+    views: { allow: ["list", "report"] },
+    bulkActions: false,
+  }}
+  doctypes={{ allow: ["ToDo", "Note"] }}   // or deny: […]
+  …
+>
+```
+
+| Flag            | Gates                                     | Config                                                                |
+| --------------- | ----------------------------------------- | --------------------------------------------------------------------- |
+| `awesomebar`    | Global search / command bar in the navbar | `enabled`                                                             |
+| `notifications` | Notification bell + panel                 | `enabled`                                                             |
+| `userMenu`      | Avatar menu                               | `enabled`, `themeToggle`, `logout`                                    |
+| `help`          | Help menu (docs, shortcuts, about)        | `enabled`                                                             |
+| `sidebar`       | Workspace sidebar (rail + drawer)         | `enabled`                                                             |
+| `quickEntry`    | Quick-entry create dialogs                | `enabled`                                                             |
+| `views`         | List views                                | `enabled`, `allow` (list/report/kanban/calendar/tree/image/dashboard) |
+| `newDoc`        | "New <doctype>" affordances               | `enabled`                                                             |
+| `bulkActions`   | List multi-select action bar              | `enabled`                                                             |
+| `attachments`   | Form sidebar attachments                  | `enabled`                                                             |
+| `timeline`      | Form activity timeline                    | `enabled`                                                             |
+| `assignments`   | Assignment surfaces                       | `enabled`                                                             |
+| `tags`          | Tag surfaces                              | `enabled`                                                             |
+| `shares`        | Document shares                           | `enabled`                                                             |
+| `print`         | Print affordances                         | `enabled`                                                             |
+| `email`         | Email / communication affordances         | `enabled`                                                             |
+
+`doctypes.allow` / `doctypes.deny` scope which doctypes are reachable
+(awesomebar commands and document hits today; lists/links as surfaces land).
+
+## Slots
+
+Provider-level render props replace built-in chrome; everything else keeps
+rendering:
+
+| Slot                                                  | Replaces                                                               |
+| ----------------------------------------------------- | ---------------------------------------------------------------------- |
+| `renderShellHeader({ defaultContent })`               | Navbar content (wrap or rebuild; `defaultContent` is the built-in row) |
+| `renderSidebarFooter()`                               | Appended under the workspace sidebar                                   |
+| `renderListEmpty({ doctype })`                        | List screen empty state                                                |
+| `renderFormHeader({ doctype, name, defaultContent })` | Document form header row                                               |
+
+```tsx
+slots={{
+  renderSidebarFooter: () => <MyEnvironmentBadge />,
+  renderShellHeader: ({ defaultContent }) => (
+    <>
+      {defaultContent}
+      <MyTenantSwitcher />
+    </>
+  ),
+}}
+```
+
+## Events
+
+```tsx
+<BackofficeProvider
+  onEvent={(event) => {
+    switch (event.type) {
+      case "navigate":   // { path, mode: "push" | "replace" | "back" }
+      case "doc-opened": // { doctype, name }
+      case "doc-saved":  // { doctype, name, isNew? }
+      case "doc-deleted":
+      case "error":      // { error, context? }
+    }
+  }}
+  …
+>
+```
+
+## Custom fields and actions
+
+```tsx
+<BackofficeProvider
+  // merged into frappe-ui's field registry (fieldtype → renderer)
+  fields={{ Rating: MyRatingField }}
+  // extra toolbar actions (form + list surfaces)
+  actions={{
+    form: [{ id: "audit", label: "Audit", onPress: ({ doctype, name }) => … }],
+  }}
+  …
+>
+```
+
+## Theme toggle
+
+The user menu's "Toggle Theme" needs a host adapter (the package does not own
+your color-scheme store):
+
+```tsx
+<BackofficeProvider
+  appearance={{ scheme, setScheme }}   // e.g. from one's useUserScheme()
+  …
+>
+```
+
+Without it the item renders disabled (some platforms have no scheme store).
+
+## i18n
+
+The package ships English translations under the **`backoffice`** namespace
+and registers them on the global i18next instance at provider mount —
+additive only (`deep: true, overwrite: false`), so your bundles win. If you
+never initialize i18next, the provider brings up a minimal English-only
+instance itself.
+
+Override any key:
+
+```ts
+import i18next from "i18next";
+
+i18next.addResourceBundle(
+  "en",
+  "backoffice",
+  { shell: { title: "Acme Admin" }, userMenu: { logOut: "Sign out" } },
+  true, // deep
+  true, // overwrite the bundled defaults
+);
+```
+
+Ship another language the same way (`addResourceBundle("de", "backoffice", …)`).
+Every built-in string also carries an inline English default, so a missing
+bundle never renders raw keys.
+
+## Testing your embedding
+
+```tsx
+import { render } from "@testing-library/react";
+import {
+  BackofficeProvider,
+  BackofficeShell,
+  createMemoryNavigator,
+} from "@multiplatform.one/backoffice";
+import { InMemoryFixtureProvider } from "@multiplatform.one/frappe";
+
+const navigation = createMemoryNavigator("/backoffice");
+render(
+  <BackofficeProvider
+    frappe={{ baseURL: "https://mock.test", fixtures: new InMemoryFixtureProvider({ Workspace: […] }) }}
+    navigation={navigation}
+  >
+    <BackofficeShell>…</BackofficeShell>
+  </BackofficeProvider>,
+);
+navigation.navigate("/backoffice/todo");
+expect(navigation.getLocation().path).toBe("/backoffice/todo");
+```
+
+`fixtures` swaps every network read for in-memory data — no bench needed.

package/dist/cjs/chrome/BackofficeAwesomebar.cjs

@@ -0,0 +1,95 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all) __defProp(target, name, {
+    get: all[name],
+    enumerable: true
+  });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from)) if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+      get: () => from[key],
+      enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+    });
+  }
+  return to;
+};
+var __toCommonJS = mod => __copyProps(__defProp({}, "__esModule", {
+  value: true
+}), mod);
+var BackofficeAwesomebar_exports = {};
+__export(BackofficeAwesomebar_exports, {
+  BackofficeAwesomebar: () => BackofficeAwesomebar
+});
+module.exports = __toCommonJS(BackofficeAwesomebar_exports);
+var import_react = require("@phosphor-icons/react");
+var import_components = require("@multiplatform.one/components");
+var import_theme = require("@multiplatform.one/theme");
+var import_react2 = require("react");
+var import_react_i18next = require("react-i18next");
+var import_i18n = require("../i18n/index.cjs");
+var import_CommandPalette = require("./CommandPalette.cjs");
+var import_jsx_runtime = require("react/jsx-runtime");
+function getModLabel() {
+  if (typeof navigator !== "undefined" && /Mac|iPhone|iPad|iPod/i.test(String(navigator.platform ?? ""))) {
+    return "\u2318";
+  }
+  return "Ctrl";
+}
+function BackofficeAwesomebar({
+  focusRef
+} = {}) {
+  const {
+    t
+  } = (0, import_react_i18next.useTranslation)(import_i18n.BACKOFFICE_I18N_NAMESPACE);
+  const isCompact = (0, import_theme.useLayoutSizeClass)() === "compact";
+  const [open, setOpen] = (0, import_react2.useState)(false);
+  (0, import_react2.useImperativeHandle)(focusRef, () => ({
+    focus: () => setOpen(true)
+  }), []);
+  const label = t("awesomebar.triggerLabel", "Search");
+  const showShortcutHint = import_components.isWeb && !isCompact;
+  return /* @__PURE__ */(0, import_jsx_runtime.jsxs)(import_jsx_runtime.Fragment, {
+    children: [/* @__PURE__ */(0, import_jsx_runtime.jsxs)(import_components.Button, {
+      size: "$3",
+      flex: 1,
+      minWidth: 0,
+      justifyContent: "flex-start",
+      "aria-label": label,
+      "aria-haspopup": "dialog",
+      "aria-expanded": open,
+      onPress: () => setOpen(true),
+      "data-testid": "backoffice-awesomebar",
+      children: [/* @__PURE__ */(0, import_jsx_runtime.jsx)(import_react.MagnifyingGlassIcon, {
+        size: 16
+      }), /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_components.Text, {
+        flex: 1,
+        minWidth: 0,
+        numberOfLines: 1,
+        textAlign: "left",
+        color: "$color10",
+        children: label
+      }), showShortcutHint && /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_components.XStack, {
+        borderWidth: 1,
+        borderColor: "$borderColor",
+        backgroundColor: "$color2",
+        borderRadius: "$2",
+        paddingHorizontal: "$1.5",
+        flexShrink: 0,
+        "aria-hidden": true,
+        children: /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_components.SizableText, {
+          size: "$1",
+          fontWeight: "600",
+          color: "$color11",
+          children: `${getModLabel()} K`
+        })
+      })]
+    }), /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_CommandPalette.CommandPalette, {
+      open,
+      onOpenChange: setOpen
+    })]
+  });
+}