@egen-civitas/esm-extensions 1.1.1 → 1.2.1

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @egen-civitas/esm-extensions
 
+## 1.2.1
+
+### Patch Changes
+
+- bd97b0e: Correctif de 1.2.0 : `registerNavBehavior` et `getNavBehavior` (ainsi que les types `NavBehavior`, `NavBehaviorTarget`, `NavSelectContext`) étaient documentés dans l'API publique mais absents du point d'entrée du package, donc inutilisables par les apps. `esm-extensions` les exporte désormais, et `esm-framework` les réexporte. Un test vérifie que chaque module de l'API publique (`public.ts`) est bien exporté par `index.ts`.
+
+## 1.2.0
+
+### Minor Changes
+
+- 6700454: Navigation de niveau 2 de la TopBar : contextualisation par espace et surcharge de comportement par app (changements additifs, sans rupture).
+
+  - `NavEntryMeta.workspaces` : espaces (`intranet`, `extranet`…) où l'entrée apparaît ; absent, vide ou `'*'` = tous. Nouveau helper `isNavEntryInWorkspace` et constante `NAV_ALL_WORKSPACES`.
+  - `NavEntryMeta.group` devient facultatif : une entrée sans `group` est un lien simple (une section à entrée unique devient un bouton direct, sans menu déroulant).
+  - `NavEntryMeta.sectionRoute` : route du bouton de la section lui-même.
+  - `registerNavBehavior({ entry } | { section }, { onSelect })` / `getNavBehavior` : une app remplace (ou enrichit via `ctx.runDefault()`) la logique globale appliquée au clic sur son bouton de navigation.
+  - Mocks `esm-framework` (`mock` et `mock-jest`) : `registerNavBehavior`, `getNavBehavior` et réexport des constantes/validateurs purs.
+
 ## 1.1.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export * from './extensions.js';
 export * from './helpers.js';
 export * from './left-nav.js';
 export * from './nav-entry.js';
+export * from './nav-behavior.js';
 export * from './modals.js';
 export * from './workspaces.js';
 export * from './workspaces2.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -2,6 +2,7 @@ export * from "./extensions.js";
 export * from "./helpers.js";
 export * from "./left-nav.js";
 export * from "./nav-entry.js";
+export * from "./nav-behavior.js";
 export * from "./modals.js";
 export * from "./workspaces.js";
 export * from "./workspaces2.js";

package/dist/nav-behavior.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Cible d'un comportement de navigation : une entrée (le lien d'un menu, identifiée par le nom de
+ * son extension dans `routes.json`) ou une section (le bouton de niveau 2, identifié par `section`).
+ */
+export type NavBehaviorTarget = {
+    entry: string;
+} | {
+    section: string;
+};
+/** Contexte transmis à `NavBehavior.onSelect` quand l'utilisateur active un bouton de navigation. */
+export interface NavSelectContext {
+    /** Ce qui a été activé. */
+    target: NavBehaviorTarget;
+    /** Route visée, relative à la base SPA (ex. `annuaire/contacts`) ; absente pour une section sans `sectionRoute`. */
+    route?: string;
+    /** Identifiant de l'espace actif (ex. `intranet`). */
+    workspaceId: string;
+    /**
+     * Exécute la logique globale de la TopBar (son, fermeture du menu, navigation). Un comportement
+     * qui REMPLACE le défaut peut ne pas l'appeler ; un qui l'ENRICHIT l'appelle (avant ou après).
+     */
+    runDefault: () => void;
+}
+export interface NavBehavior {
+    /** Remplace la logique globale appliquée au clic. Appeler `ctx.runDefault()` pour la conserver. */
+    onSelect: (ctx: NavSelectContext) => void;
+}
+interface NavBehaviorStore {
+    behaviors: Record<string, NavBehavior>;
+}
+/** @internal */
+export declare const navBehaviorStore: import("zustand").StoreApi<NavBehaviorStore>;
+/**
+ * Déclare le comportement d'un bouton de navigation du niveau 2 de la TopBar, à appeler au
+ * démarrage de l'app (`startupApp`). Sans comportement déclaré, la TopBar applique sa logique
+ * globale. Un seul comportement par cible : le dernier enregistré l'emporte.
+ *
+ * @returns Une fonction qui retire ce comportement (sans effet s'il a été remplacé depuis).
+ *
+ * @example
+ * ```ts
+ * registerNavBehavior({ entry: 'annuaire-nav-contacts' }, {
+ *   onSelect: ({ runDefault }) => {
+ *     trackEvent('annuaire.contacts');
+ *     runDefault();
+ *   },
+ * });
+ * ```
+ */
+export declare function registerNavBehavior(target: NavBehaviorTarget, behavior: NavBehavior): () => void;
+/** Comportement déclaré pour une cible, s'il y en a un. */
+export declare function getNavBehavior(target: NavBehaviorTarget): NavBehavior | undefined;
+export {};
+//# sourceMappingURL=nav-behavior.d.ts.map

package/dist/nav-behavior.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nav-behavior.d.ts","sourceRoot":"","sources":["../src/nav-behavior.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAExE,qGAAqG;AACrG,MAAM,WAAW,gBAAgB;IAC/B,2BAA2B;IAC3B,MAAM,EAAE,iBAAiB,CAAC;IAC1B,oHAAoH;IACpH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,UAAU,EAAE,MAAM,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,mGAAmG;IACnG,QAAQ,EAAE,CAAC,GAAG,EAAE,gBAAgB,KAAK,IAAI,CAAC;CAC3C;AAED,UAAU,gBAAgB;IACxB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;CACxC;AAED,gBAAgB;AAChB,eAAO,MAAM,gBAAgB,8CAA0E,CAAC;AAKxG;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,iBAAiB,EAAE,QAAQ,EAAE,WAAW,GAAG,MAAM,IAAI,CAShG;AAED,2DAA2D;AAC3D,wBAAgB,cAAc,CAAC,MAAM,EAAE,iBAAiB,GAAG,WAAW,GAAG,SAAS,CAEjF"}

package/dist/nav-behavior.js

@@ -0,0 +1,41 @@
+/** @module @category Extension */ import { createGlobalStore } from "@egen-civitas/esm-state";
+/** @internal */ export const navBehaviorStore = createGlobalStore('nav-behaviors', {
+    behaviors: {}
+});
+const keyOf = (target)=>'entry' in target ? `entry:${target.entry}` : `section:${target.section}`;
+/**
+ * Déclare le comportement d'un bouton de navigation du niveau 2 de la TopBar, à appeler au
+ * démarrage de l'app (`startupApp`). Sans comportement déclaré, la TopBar applique sa logique
+ * globale. Un seul comportement par cible : le dernier enregistré l'emporte.
+ *
+ * @returns Une fonction qui retire ce comportement (sans effet s'il a été remplacé depuis).
+ *
+ * @example
+ * ```ts
+ * registerNavBehavior({ entry: 'annuaire-nav-contacts' }, {
+ *   onSelect: ({ runDefault }) => {
+ *     trackEvent('annuaire.contacts');
+ *     runDefault();
+ *   },
+ * });
+ * ```
+ */ export function registerNavBehavior(target, behavior) {
+    const key = keyOf(target);
+    navBehaviorStore.setState((s)=>({
+            behaviors: {
+                ...s.behaviors,
+                [key]: behavior
+            }
+        }));
+    return ()=>{
+        const { behaviors } = navBehaviorStore.getState();
+        if (behaviors[key] !== behavior) return;
+        const { [key]: _removed, ...rest } = behaviors;
+        navBehaviorStore.setState({
+            behaviors: rest
+        });
+    };
+}
+/** Comportement déclaré pour une cible, s'il y en a un. */ export function getNavBehavior(target) {
+    return navBehaviorStore.getState().behaviors[keyOf(target)];
+}

package/dist/nav-entry.d.ts

@@ -13,8 +13,12 @@ export declare const TOPBAR_LEVEL2_NAV_SLOT = "topbar-level2-nav";
 export interface NavEntryMeta {
     /** Entrée de niveau 2 (ex. `informations`) ; regroupe les colonnes du méga-menu. */
     section: string;
-    /** Colonne du méga-menu (ex. `news`). */
-    group: string;
+    /**
+     * Colonne du méga-menu (ex. `news`). Facultative : une entrée sans `group` est un lien simple.
+     * Une section dont toutes les entrées sont sans `group` et qui n'en a qu'une devient un bouton
+     * direct (sans menu déroulant) ; avec plusieurs, un menu à une seule colonne sans titre.
+     */
+    group?: string;
     /** Texte par défaut, utilisé si `labelKey` n'a pas de traduction. */
     label: string;
     /** Clé de traduction du libellé (optionnelle). */
@@ -32,7 +36,24 @@ export interface NavEntryMeta {
     sectionLabelKey?: string;
     groupLabel?: string;
     groupLabelKey?: string;
+    /**
+     * Espaces (Intranet, Extranet…) dans lesquels l'entrée apparaît, par identifiant d'espace
+     * (ex. `['intranet']`). Absent, vide ou contenant `'*'` : tous les espaces. Toutes les
+     * entrées d'une même `section` n'ont pas à partager la même liste : la section d'un espace
+     * est composée des seules entrées qui y sont visibles.
+     */
+    workspaces?: string[];
+    /**
+     * Route du bouton de la section lui-même (cliquable en plus de son menu), relative à la base SPA.
+     * Doit exister dans un `pages[].route`. Si plusieurs entrées d'une section la renseignent, la
+     * première dans l'ordre du slot l'emporte.
+     */
+    sectionRoute?: string;
 }
+/** Valeur de `NavEntryMeta.workspaces` qui désigne « tous les espaces ». */
+export declare const NAV_ALL_WORKSPACES = "*";
 /** Valide une `meta` d'extension : vrai si c'est une `NavEntryMeta` exploitable. */
 export declare function isNavEntryMeta(meta: unknown): meta is NavEntryMeta;
+/** Vrai si l'entrée doit être affichée dans l'espace `workspaceId` (voir `NavEntryMeta.workspaces`). */
+export declare function isNavEntryInWorkspace(meta: NavEntryMeta, workspaceId: string): boolean;
 //# sourceMappingURL=nav-entry.d.ts.map

package/dist/nav-entry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nav-entry.d.ts","sourceRoot":"","sources":["../src/nav-entry.ts"],"names":[],"mappings":"AAAA,kCAAkC;AAElC;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,sBAAsB,CAAC;AAE1D;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,oFAAoF;IACpF,OAAO,EAAE,MAAM,CAAC;IAChB,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,qEAAqE;IACrE,KAAK,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oFAAoF;IACpF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2GAA2G;IAC3G,KAAK,EAAE,MAAM,CAAC;IACd,iFAAiF;IACjF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,oFAAoF;AACpF,wBAAgB,cAAc,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,YAAY,CAIlE"}
+{"version":3,"file":"nav-entry.d.ts","sourceRoot":"","sources":["../src/nav-entry.ts"],"names":[],"mappings":"AAAA,kCAAkC;AAElC;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,sBAAsB,CAAC;AAE1D;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,oFAAoF;IACpF,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qEAAqE;IACrE,KAAK,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oFAAoF;IACpF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2GAA2G;IAC3G,KAAK,EAAE,MAAM,CAAC;IACd,iFAAiF;IACjF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,4EAA4E;AAC5E,eAAO,MAAM,kBAAkB,MAAM,CAAC;AAEtC,oFAAoF;AACpF,wBAAgB,cAAc,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,YAAY,CAelE;AAED,wGAAwG;AACxG,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAItF"}

package/dist/nav-entry.js

@@ -3,13 +3,26 @@
  * (niveau 2 de la TopBar). Déclaré dans le `routes.json` de l'app :
  * `{ "slot": "topbar-level2-nav", "component": "navEntry", "meta": NavEntryMeta }`.
  */ export const TOPBAR_LEVEL2_NAV_SLOT = 'topbar-level2-nav';
+/** Valeur de `NavEntryMeta.workspaces` qui désigne « tous les espaces ». */ export const NAV_ALL_WORKSPACES = '*';
 /** Valide une `meta` d'extension : vrai si c'est une `NavEntryMeta` exploitable. */ export function isNavEntryMeta(meta) {
     if (!meta || typeof meta !== 'object') return false;
     const m = meta;
-    return [
+    if (![
         'section',
-        'group',
         'label',
         'route'
-    ].every((k)=>typeof m[k] === 'string' && m[k].length > 0);
+    ].every((k)=>typeof m[k] === 'string' && m[k].length > 0)) {
+        return false;
+    }
+    if (m.group !== undefined && (typeof m.group !== 'string' || m.group.length === 0)) return false;
+    if (m.sectionRoute !== undefined && (typeof m.sectionRoute !== 'string' || m.sectionRoute.length === 0)) return false;
+    if (m.workspaces !== undefined && !(Array.isArray(m.workspaces) && m.workspaces.every((w)=>typeof w === 'string'))) {
+        return false;
+    }
+    return true;
+}
+/** Vrai si l'entrée doit être affichée dans l'espace `workspaceId` (voir `NavEntryMeta.workspaces`). */ export function isNavEntryInWorkspace(meta, workspaceId) {
+    const { workspaces } = meta;
+    if (!workspaces || workspaces.length === 0) return true;
+    return workspaces.includes(NAV_ALL_WORKSPACES) || workspaces.includes(workspaceId);
 }

package/dist/public.d.ts

@@ -4,5 +4,6 @@ export { type CancelLoading, renderExtension } from './render.js';
 export { type ExtensionMeta, type ExtensionRegistration, type ExtensionStore, type AssignedExtension, type ConnectedExtension, type ExtensionSlotState, getExtensionStore, } from './store.js';
 export { type WorkspaceRegistration } from './workspaces.js';
 export { type ExtensionData, type ComponentConfig } from './types.js';
-export { TOPBAR_LEVEL2_NAV_SLOT, type NavEntryMeta, isNavEntryMeta } from './nav-entry.js';
+export { TOPBAR_LEVEL2_NAV_SLOT, NAV_ALL_WORKSPACES, type NavEntryMeta, isNavEntryMeta, isNavEntryInWorkspace, } from './nav-entry.js';
+export { type NavBehavior, type NavBehaviorTarget, type NavSelectContext, registerNavBehavior, getNavBehavior, } from './nav-behavior.js';
 //# sourceMappingURL=public.d.ts.map

package/dist/public.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../src/public.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,MAAM,EACN,MAAM,EACN,SAAS,EACT,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,KAAK,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,KAAK,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACnG,OAAO,EAAE,KAAK,aAAa,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAClE,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,qBAAqB,EAC1B,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,iBAAiB,GAClB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;AACtE,OAAO,EAAE,sBAAsB,EAAE,KAAK,YAAY,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../src/public.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,MAAM,EACN,MAAM,EACN,SAAS,EACT,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,KAAK,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,KAAK,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACnG,OAAO,EAAE,KAAK,aAAa,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAClE,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,qBAAqB,EAC1B,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,iBAAiB,GAClB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;AACtE,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,KAAK,YAAY,EACjB,cAAc,EACd,qBAAqB,GACtB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,mBAAmB,EACnB,cAAc,GACf,MAAM,mBAAmB,CAAC"}

package/dist/public.js

@@ -2,4 +2,5 @@ export { getExtensionNameFromId, registerExtension, attach, detach, detachAll, g
 export { setLeftNav, unsetLeftNav } from "./left-nav.js";
 export { renderExtension } from "./render.js";
 export { getExtensionStore } from "./store.js";
-export { TOPBAR_LEVEL2_NAV_SLOT, isNavEntryMeta } from "./nav-entry.js";
+export { TOPBAR_LEVEL2_NAV_SLOT, NAV_ALL_WORKSPACES, isNavEntryMeta, isNavEntryInWorkspace } from "./nav-entry.js";
+export { registerNavBehavior, getNavBehavior } from "./nav-behavior.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@egen-civitas/esm-extensions",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "license": "MPL-2.0",
   "description": "Coordinates extensions and extension points in the Egen Frontend",
   "type": "module",