@grasp-labs/ds-microfrontends-integration 0.24.0 → 0.24.2

package/dist/{index.esm-fQDYRCEr-Bj1dI6i0.js → index.esm-fQDYRCEr-B_OscmDH.js}

@@ -1,4 +1,4 @@
-import { O as o } from "./index-8Q3EeCug.js";
+import { O as o } from "./index-DWI6fl0D.js";
 import { useState as J, useEffect as De, createContext as Zt, useRef as ce, useContext as Gt, useMemo as le, useCallback as Re } from "react";
 const $e = (e, t, n, r, a) => {
   if (!r) throw new Error(a ?? `Invalid property path: ${t}

package/dist/index.js

@@ -1,15 +1,15 @@
-import { A as s, B as l, D as r, E as t, F as u, G as i, J as d, L as o, N as F, R as n, S as g, T as c, b as m, V as p, f as V, h, d as v, i as S, q as D, t as b, x as P, j as R, k as T, s as f, l as x, g as y, w as E, m as G, n as L, o as A, p as I, v as N, r as j, u as B, a as J, c as O, e as k } from "./index-8Q3EeCug.js";
+import { A as s, B as t, D as l, E as r, F as i, G as u, J as d, L as o, N as n, R as F, S as g, T as c, b as m, V as p, f as V, h, d as v, i as S, t as D, w as P, z as b, k as f, l as x, j as y, m as R, v as T, n as E, g as G, y as L, o as N, p as A, q as I, s as j, x as B, r as J, u as O, a as k, c as q, e as w } from "./index-DWI6fl0D.js";
 export {
   s as ArrayField,
-  l as BooleanField,
-  r as DateField,
-  t as EnumField,
-  u as FieldError,
-  i as GroupsProvider,
+  t as BooleanField,
+  l as DateField,
+  r as EnumField,
+  i as FieldError,
+  u as GroupsProvider,
   d as JsonField,
   o as LanguageProvider,
-  F as NumberField,
-  n as RouteGuard,
+  n as NumberField,
+  F as RouteGuard,
   g as SchemaFields,
   c as TextField,
   m as ToastProvider,
@@ -19,22 +19,24 @@ export {
   v as VaultProvider,
   S as VaultSecretDialog,
   D as buildDefaultValues,
-  b as createFieldDescriptor,
-  P as createRuleHandler,
-  R as extractConstraints,
-  T as getArrayItemsSchema,
-  f as getDefaultValue,
-  x as getFieldType,
-  y as getLanguage,
-  E as getSchemaResolver,
-  G as isEnumField,
-  L as isNullable,
-  A as isObjectWithoutProperties,
-  I as isReadOnly,
-  N as parseSchemaFields,
-  j as resolveSchema,
-  B as useGroups,
-  J as useLanguage,
-  O as useToast,
-  k as useVault
+  P as createFieldDescriptor,
+  b as createRuleHandler,
+  f as defineNavigation,
+  x as extractConstraints,
+  y as extractPaths,
+  R as getArrayItemsSchema,
+  T as getDefaultValue,
+  E as getFieldType,
+  G as getLanguage,
+  L as getSchemaResolver,
+  N as isEnumField,
+  A as isNullable,
+  I as isObjectWithoutProperties,
+  j as isReadOnly,
+  B as parseSchemaFields,
+  J as resolveSchema,
+  O as useGroups,
+  k as useLanguage,
+  q as useToast,
+  w as useVault
 };

package/dist/mf-common.d.ts

@@ -1,38 +1,8 @@
-import { IconName } from '@grasp-labs/ds-react-components';
 import { ModuleFederationOptions } from '@module-federation/vite/lib/utils/normalizeModuleFederationOptions';
-export type BaseItem = {
-    /**
-     * Display label used as fallback when translation is not available
-     */
-    label: string;
-    /**
-     * Translation key for internationalization.
-     * Must be placed in 'navigation' translation namespace in the host application for it to work.
-     */
-    labelKey: string;
-    icon: IconName;
-};
-export type RouteConfig = BaseItem & {
-    path: string;
-    type?: "hidden" | "visible";
-};
-export type CategoryConfig = BaseItem & {
-    type: "category";
-    children: Record<string, RouteConfig | CategoryConfig>;
-};
-export type NavigationItem = RouteConfig | CategoryConfig;
-/**
- * INDEX is a mandatory route representing the root of the microfrontend, used as the parent navigation item in the sidebar
- */
-export type IndexNavigationConfig = {
-    INDEX: RouteConfig;
-};
-export type NavigationConfig<TKeys extends string = string> = IndexNavigationConfig & Record<TKeys, NavigationItem>;
 export type MicrofrontendExposes = {
     ".": string;
     "./navigationConfig": string;
 } & Record<string, string>;
-export declare const createModuleFederationConfig: (name: string, overrides?: Partial<ModuleFederationOptions>) => ModuleFederationOptions;
 export declare const COMMON_SHARED_DEPS: {
     react: {
         singleton: boolean;
@@ -52,6 +22,7 @@ export declare const COMMON_SHARED_DEPS: {
     };
 };
 export declare const createMicrofrontendsBase: (name: string) => string;
+export declare const createModuleFederationConfig: (name: string, overrides?: Partial<ModuleFederationOptions>) => ModuleFederationOptions;
 /**
  * Creates a configured Vite Module Federation plugin for Data Science microfrontends
  * @param name - The name of the microfrontend

package/dist/mf-common.js

@@ -1,23 +1,7 @@
 import { federation as o } from "@module-federation/vite";
 const i = { react: "19.2.3", "react-dom": "19.2.3", "react-router": "7.12.0" }, n = {
   peerDependencies: i
-}, s = (e, r = {}) => {
-  const t = a(e);
-  return {
-    name: e,
-    manifest: !0,
-    filename: "remoteEntry.js",
-    getPublicPath: `function() {return "${t}"}`,
-    exposes: {
-      ".": "./src/App",
-      "./navigationConfig": "./src/navigationConfig"
-    },
-    shared: {
-      ...c
-    },
-    ...r
-  };
-}, c = {
+}, s = {
   react: {
     singleton: !0,
     requiredVersion: n.peerDependencies.react
@@ -34,12 +18,28 @@ const i = { react: "19.2.3", "react-dom": "19.2.3", "react-router": "7.12.0" },
     singleton: !0,
     requiredVersion: ">=0.17.0 <1.0.0"
   }
-}, a = (e) => `microfrontends/${e}/`, u = (e, r = {}) => o({
-  ...s(e, r)
+}, c = (e) => `microfrontends/${e}/`, a = (e, r = {}) => {
+  const t = c(e);
+  return {
+    name: e,
+    manifest: !0,
+    filename: "remoteEntry.js",
+    getPublicPath: `function() {return "${t}"}`,
+    exposes: {
+      ".": "./src/App",
+      "./navigationConfig": "./src/navigationConfig"
+    },
+    shared: {
+      ...s
+    },
+    ...r
+  };
+}, u = (e, r = {}) => o({
+  ...a(e, r)
 });
 export {
-  c as COMMON_SHARED_DEPS,
-  a as createMicrofrontendsBase,
-  s as createModuleFederationConfig,
+  s as COMMON_SHARED_DEPS,
+  c as createMicrofrontendsBase,
+  a as createModuleFederationConfig,
   u as dsFederation
 };

package/dist/types/Navigation.d.ts

@@ -0,0 +1,52 @@
+import { IconName } from '@grasp-labs/ds-react-components';
+export type BaseItem = {
+    /**
+     * Display label used as fallback when translation is not available
+     */
+    label: string;
+    /**
+     * Translation key for internationalization.
+     * Must be placed in 'navigation' translation namespace in the host application for it to work.
+     */
+    labelKey: string;
+    icon: IconName;
+    /**
+     * Roles required to access this navigation item.
+     * When specified, the item should only be visible to users with at least one of the listed roles.
+     */
+    requiredRoles?: string[];
+};
+export type RouteConfig = BaseItem & {
+    path: string;
+    type?: "hidden" | "visible";
+};
+export type CategoryConfig = BaseItem & {
+    type: "category";
+    children: Record<string, NavigationItem>;
+};
+export type NavigationItem = RouteConfig | CategoryConfig;
+/**
+ * INDEX is a mandatory route representing the root of the microfrontend, used as the parent navigation item in the sidebar
+ * @deprecated Use ComposableNavigationConfig for new microfrontends
+ */
+export type IndexNavigationConfig = {
+    INDEX: RouteConfig;
+};
+/**
+ * @deprecated Use ComposableNavigationConfig for new microfrontends
+ */
+export type NavigationConfig<TKeys extends string = string> = IndexNavigationConfig & Record<TKeys, NavigationItem>;
+/**
+ * Composable navigation configuration where each entry is a standalone NavigationItem.
+ */
+export type ComposableNavigationConfig = Record<string, NavigationItem>;
+export type UnionToIntersection<U> = (U extends unknown ? (x: U) => void : never) extends (x: infer I) => void ? I : never;
+/**
+ * Recursively extracts a flat path map from a navigation config.
+ * For route items, extracts `{ KEY: path }`. For categories, recurses into children.
+ */
+export type ExtractPaths<T extends Record<string, NavigationItem>> = {
+    [K in keyof T as T[K] extends CategoryConfig ? never : K]: T[K] extends RouteConfig ? T[K]["path"] : never;
+} & UnionToIntersection<{
+    [K in keyof T]: T[K] extends CategoryConfig ? ExtractPaths<T[K]["children"]> : never;
+}[keyof T]>;

package/dist/types/index.d.ts

@@ -2,4 +2,5 @@ export * from './Schema';
 export * from './Translation';
 export * from './Vault';
 export * from './Groups';
+export * from './Navigation';
 export * from './customErrorHandler';

package/dist/utils/index.d.ts

@@ -1 +1 @@
-export {};
+export * from './navigation';

package/dist/utils/navigation.d.ts

@@ -0,0 +1,23 @@
+import { ComposableNavigationConfig, ExtractPaths } from '../types/Navigation';
+/**
+ * Extracts a flat `{ KEY: path }` map from a valid navigation config.
+ *
+ * @example
+ * const PageRoutes = extractPaths(navigationConfig);
+ * // PageRoutes.DASHBOARD === "/dashboard"
+ */
+export declare const extractPaths: <const T extends ComposableNavigationConfig>(config: T) => ExtractPaths<T>;
+/**
+ * Defines a navigation config and extracts its page routes in one step.
+ *
+ * @example
+ * const { navigationConfig, pageRoutes } = defineNavigation({
+ *   INDEX: { label: "Home", labelKey: "home", path: "/", icon: "home" },
+ * });
+ * export const PageRoutes = pageRoutes;
+ * export default navigationConfig;
+ */
+export declare const defineNavigation: <const T extends ComposableNavigationConfig>(config: T) => {
+    navigationConfig: T;
+    pageRoutes: ExtractPaths<T>;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grasp-labs/ds-microfrontends-integration",
-  "version": "0.24.0",
+  "version": "0.24.2",
   "private": false,
   "license": "Apache-2.0",
   "type": "module",