@rytass/bpm-core-react 0.3.3 → 0.3.4

package/CHANGELOG.md

@@ -8,6 +8,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 Releases are managed by [`nx release`](https://nx.dev/recipes/nx-release) with
 Conventional Commits — see `nx.json` for the release config.
 
+## 0.3.4 — 2026-05-28
+
+### Documentation
+
+- **README "Mounting BPM under a non-root URL prefix"** added. Shows
+  the exhaustive `createPrefixedRoutes(prefix)` factory covering all
+  **19** `BPMRoutes` entries (previously the README only sketched
+  2-3). Spreading `createDefaultBPMRoutes()` first means new BPMCore
+  versions that add routes never silently regress consumer hosts.
+
+### Why a patch
+
+Documentation-only. No source change.
+
 ## 0.3.3 — 2026-05-28
 
 ### Fixed

package/README.md

@@ -63,6 +63,60 @@ function MyLoginPage() {
 
 For SPA / Remix / Tanstack Router hosts, supply a `RouterAdapter` that bridges your router primitives.
 
+### Mounting BPM under a non-root URL prefix
+
+If your host already owns the `/` namespace (Shuttle, an existing
+admin console, etc.), wrap the BPM tree in `<BPMRoutesProvider>` and
+override every internal cross-link to a prefixed path. The full
+`BPMRoutes` contract has **19 entries** — overriding only some leaves
+the rest pointing at the unprefixed defaults, which usually 404s on
+your host. Use a small factory to keep the override exhaustive:
+
+```tsx
+import {
+  BPMRoutesProvider,
+  createDefaultBPMRoutes,
+  type BPMRoutes,
+} from '@rytass/bpm-core-react/next';
+
+function createPrefixedRoutes(prefix: string): BPMRoutes {
+  const trim = prefix.replace(/\/$/, '');
+  return {
+    ...createDefaultBPMRoutes(), // safety net for any future routes
+    dashboard:             () => `${trim}`,
+    inbox:                 () => `${trim}/inbox`,
+    sent:                  () => `${trim}/sent`,
+    cc:                    () => `${trim}/cc`,
+    search:                () => `${trim}/search`,
+    delegations:           () => `${trim}/delegations`,
+    notifications:         () => `${trim}/notifications`,
+    caseDetail:    (id)         => `${trim}/instances/${id}`,
+    caseNew:       (templateId) => templateId
+      ? `${trim}/instances/new?templateId=${encodeURIComponent(templateId)}`
+      : `${trim}/instances/new`,
+    templates:             () => `${trim}/templates`,
+    templateDesigner:   (id) => `${trim}/templates/${id}/designer`,
+    templateVersions:   (id) => `${trim}/templates/${id}/versions`,
+    templateCategories:    () => `${trim}/templates/categories`,
+    forms:                 () => `${trim}/forms`,
+    formBuilder:        (id) => `${trim}/forms/${id}/builder`,
+    notificationSettings:  () => `${trim}/settings/notifications`,
+    adminOrgs:             () => `${trim}/admin/orgs`,
+    adminUsers:            () => `${trim}/admin/users`,
+    adminDelegations:      () => `${trim}/admin/delegations`,
+  };
+}
+
+// In your layout:
+<BPMRoutesProvider value={createPrefixedRoutes('/operations/approval')}>
+  <BPMNextProviders>{children}</BPMNextProviders>
+</BPMRoutesProvider>
+```
+
+`createDefaultBPMRoutes()` is the source of truth for the route shape;
+spreading it first means new BPMCore versions that add routes never
+silently regress your host.
+
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rytass/bpm-core-react",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "description": "BPM approval workflow React components and views for the Rytass BPM stack. Self-contained AuthProvider, NotificationDrawer, AppNavigation, plus full views for inbox / instances / templates / forms / admin / settings that compose on top of Mezzanine UI and the BPM client functions.",
   "keywords": [
     "bpm",
@@ -278,8 +278,8 @@
     }
   },
   "peerDependencies": {
-    "@rytass/bpm-core-client": "^0.1.6",
-    "@rytass/bpm-core-shared": "^0.1.6",
+    "@rytass/bpm-core-client": "^0.1.7",
+    "@rytass/bpm-core-shared": "^0.1.7",
     "@mezzanine-ui/react": "^1.1.0",
     "@mezzanine-ui/icons": "^1.0.2",
     "react": "^18.0.0 || ^19.0.0",