@eintrek/erp-shell 0.1.56 → 0.1.58

package/dist/navigation/navigation-data-helpers.d.ts

@@ -18,14 +18,91 @@ export declare function filterNavigationToolsByPermission(tools: Tool[], rulesMa
  */
 export declare function filterNavigationModulesByPermission(modules: Module[], rulesMap: PermissionRulesMap, userChildSegments: string[]): Module[];
 /**
- * Find the active top-level module id from `pathname`. Strips the org-code
- * prefix from the path (first path segment) before matching.
+ * Find the active top-level module id from `pathname`: the module whose URL
+ * (or one of whose pages' URLs) is the longest prefix of the path below the
+ * org code.
+ *
+ * Before 0.1.57 this took the first module with a page URL anywhere in the
+ * path (`includes`), so "/project" claimed /project/schedule and the sidebar,
+ * the trail and the tabs could disagree about where the user was.
  */
 export declare function getActiveModule(pathname: string, modules: Module[]): string | null;
-/** Find the active sub-module id from `pathname`. */
+/**
+ * Find the active sub-module id from `pathname`: the page whose own URL — or
+ * one of whose listed `subPages` — is the path itself (below the org code,
+ * ignoring a trailing slash). A record, a create or an edit page below a page
+ * is no page of the menu, so it has no active sub-module (0.1.58); the module
+ * (`getActiveModule`) still says where it belongs.
+ *
+ * Equal URLs in two modules go to the active module's page.
+ */
 export declare function getActiveSubModule(pathname: string, modules: Module[]): string | null;
 /** Prepend `code` (org code) to a relative URL so `/sales` → `/O25.../sales`.
  * Absolute `http(s)://` URLs are left intact; optional `{code}` placeholder is replaced.
  * Query/hash are preserved: `/?start=1` → `/O25...?start=1` (not `/O25.../?start=1`).
  */
 export declare function buildUrlWithCode(code: string | undefined, url: string): string;
+/**
+ * The one entry in the sidebar that stands for the current page.
+ *
+ * `item` is the index of the top-level row. `sub` is the index of the
+ * sub-item under it, or null when the row itself is the entry (a one-line
+ * item, or a group on its own URL with no page of its own matching).
+ * `subPage` is the index of the page inside a sub-item's `subPages`.
+ */
+export interface ActiveNavEntry {
+    item: number;
+    sub: number | null;
+    subPage: number | null;
+}
+/** Where the current page sits in the menu, lit or not. */
+export interface SidebarNavState {
+    /**
+     * The entry lit for this page — only when the page is that entry's own
+     * page (its URL, or one of its `subPages`). Null on a record, a create or
+     * an edit page below a menu page.
+     */
+    active: ActiveNavEntry | null;
+    /**
+     * The group (and sub-item) holding the page: the lit entry's, or else the
+     * one with the deepest URL the path sits below. It opens so the user sees
+     * where they are, with nothing in it lit.
+     */
+    open: {
+        item: number;
+        sub: number | null;
+    } | null;
+}
+export interface ResolveActiveNavOptions {
+    /** Org code the relative URLs are prefixed with. */
+    code?: string;
+    /**
+     * Kept for callers. Since 0.1.58 every chrome treats "/O1/x/" and "/O1/x"
+     * as the same page; this no longer changes anything.
+     */
+    workspace?: boolean;
+    /** See NavMain: a one-line item is lit by `item.isActive` alone. */
+    highlightActiveModule?: boolean;
+}
+/** "/O1/" and "/O1" are the same page; a query string never is. */
+export declare function samePage(pathname: string, url: string): boolean;
+/**
+ * Where `pathname` sits in the sidebar: the entry to light and the group to
+ * open.
+ *
+ * Lit (0.1.58): only the entry whose own page this is — its URL or one of its
+ * `subPages`, exactly. A record, a create or an edit page below a menu page
+ * (Plannex /project/detail/<id>/schedule under "โครงการ" /project) lights
+ * nothing; an app lists such a page in `subPages` when it should keep its
+ * entry lit. At most one entry across every group (0.1.57).
+ *
+ * Open: the lit entry's group, or else the group with the deepest URL the
+ * path sits below.
+ *
+ * Equal lengths go to the group the app marks active (`item.isActive`, from
+ * its `activeModule`), then to a page over a group row, then to the first in
+ * menu order.
+ */
+export declare function resolveSidebarNav(items: Module[], pathname: string | null | undefined, { code, highlightActiveModule }?: ResolveActiveNavOptions): SidebarNavState;
+/** The entry lit for `pathname` — `resolveSidebarNav(...).active`. */
+export declare function resolveActiveNav(items: Module[], pathname: string | null | undefined, options?: ResolveActiveNavOptions): ActiveNavEntry | null;

package/dist/navigation/navigation-types.d.ts

@@ -38,6 +38,12 @@ export interface SubModule {
     isActive?: boolean;
     icon?: IconType;
     isCollapsible?: boolean;
+    /**
+     * Pages that are this item's own: the sidebar lights the item on any of
+     * them, exactly as on its URL (0.1.58 lights nothing on other pages below
+     * it). A collapsible item also draws them as its children. Each needs a
+     * `permissionRouteKey` the user holds — the filter drops one without.
+     */
     subPages?: SubPage[];
     permissionRouteKey?: string;
     /**

package/dist/version.d.ts

@@ -2,4 +2,4 @@
  * This package's version, attached to help messages so the back office can
  * tell which shell a report came from. Keep in step with package.json.
  */
-export declare const SHELL_VERSION = "0.1.53";
+export declare const SHELL_VERSION = "0.1.58";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eintrek/erp-shell",
-  "version": "0.1.56",
+  "version": "0.1.58",
   "private": false,
   "type": "module",
   "description": "Shared frontend platform for ERP apps — HTTP client, providers, navigation, hooks.",