@gravitee/gamma-modules-sdk 1.0.0-alpha.1 → 1.0.0-alpha.1-feat-routing.df22a7d

package/dist/routing.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Routing domain — generic helpers for federated modules mounted under the
+ * gamma host URL scheme `/environments/:envHrid/:moduleId/<routeKey>`.
+ */
+export interface ModuleRouteDefinition {
+    readonly path: string;
+    readonly label: string;
+}
+export interface ModuleRouteConfig<K extends string = string> {
+    readonly routeKeys: readonly K[];
+    readonly routes: Record<K, ModuleRouteDefinition>;
+    readonly defaultRouteKey: K;
+}
+/** Type-guard: is `segment` one of the declared route keys? */
+export declare function isRouteKey<K extends string>(segment: string, routeKeys: readonly K[]): segment is K;
+/**
+ * Resolves the active sidebar key and optional host module prefix from the URL.
+ *
+ * Handles three mounting modes:
+ *   1. **Federated** — `/environments/:envHrid/:moduleId/<routeKey>`
+ *   2. **Standalone with prefix** — `/:moduleId/<routeKey>`
+ *   3. **Legacy standalone** — `/<routeKey>` (first segment is itself a key)
+ */
+export declare function resolveModulePath<K extends string>(pathname: string, config: ModuleRouteConfig<K>): {
+    modulePrefix: string;
+    activeNavKey: K;
+};
+/**
+ * Pure string builder: returns the target pathname for navigating to a route
+ * key inside a module.
+ *
+ * When federated, the environment prefix is extracted from `currentPathname`.
+ */
+export declare function buildModuleNavPath(modulePrefix: string, key: string, currentPathname?: string): string;
+/**
+ * Returns the "root" pathname for breadcrumbs (e.g. the module's landing page
+ * under the current environment).
+ */
+export declare function buildModuleRootPath(pathname: string, modulePrefix: string, defaultRouteKey: string): string;
+export interface ModuleRoutingResult<K extends string = string> {
+    modulePrefix: string;
+    activeNavKey: K;
+    navigateToKey: (key: string) => void;
+    rootPath: string;
+}
+/**
+ * Convenience hook that composes the pure routing helpers for a federated module.
+ *
+ * Returns raw data — no JSX, no graphene types. Modules use the returned values
+ * to wire graphene layout components in their own `ModuleLayout`.
+ */
+export declare function useModuleRouting<K extends string>(config: ModuleRouteConfig<K>): ModuleRoutingResult<K>;
+//# sourceMappingURL=routing.d.ts.map

package/dist/routing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routing.d.ts","sourceRoot":"","sources":["../src/routing.ts"],"names":[],"mappings":"AAkBA;;;GAGG;AAIH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAC1D,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC;IACjC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,qBAAqB,CAAC,CAAC;IAClD,QAAQ,CAAC,eAAe,EAAE,CAAC,CAAC;CAC7B;AAID,+DAA+D;AAC/D,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,GAAG,OAAO,IAAI,CAAC,CAEnG;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,MAAM,EAChD,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAC3B;IAAE,YAAY,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,CAAC,CAAA;CAAE,CAqB3C;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,CAUtG;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,MAAM,CAS3G;AAID,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAC5D,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,CAAC,CAAC;IAChB,aAAa,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IACrC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAsBvG"}

package/dist/routing.js

@@ -0,0 +1,62 @@
+import { useCallback as e, useMemo as t } from "react";
+import { useLocation as n, useNavigate as r } from "react-router-dom";
+//#region src/routing.ts
+function i(e, t) {
+	return t.includes(e);
+}
+function a(e, t) {
+	let n = e.split("/").filter(Boolean), { routeKeys: r, defaultRouteKey: a } = t;
+	if (n.length === 0) return {
+		modulePrefix: "",
+		activeNavKey: a
+	};
+	if (n[0] === "environments" && n.length >= 3) {
+		let e = n[2], t = n[3] ?? a;
+		return {
+			modulePrefix: e,
+			activeNavKey: i(t, r) ? t : a
+		};
+	}
+	if (i(n[0], r)) return {
+		modulePrefix: "",
+		activeNavKey: n[0]
+	};
+	let o = n[0], s = n[1] ?? a;
+	return {
+		modulePrefix: o,
+		activeNavKey: i(s, r) ? s : a
+	};
+}
+function o(e, t, n) {
+	if (e) {
+		let r = n ?? (typeof window < "u" ? window.location.pathname : ""), i = r.indexOf("/", 14);
+		return r.startsWith("/environments/") && i > 0 ? `${r.slice(0, i)}/${e}/${t}` : `/${e}/${t}`;
+	}
+	return `/${t}`;
+}
+function s(e, t, n) {
+	if (!t) return "/";
+	let r = e.indexOf("/", 14);
+	return e.startsWith("/environments/") && r > 0 ? `${e.slice(0, r)}/${t}/${n}` : `/${t}/${n}`;
+}
+function c(i) {
+	let c = n(), l = r(), { modulePrefix: u, activeNavKey: d } = t(() => a(c.pathname, i), [c.pathname, i]), f = t(() => s(c.pathname, u, i.defaultRouteKey), [
+		c.pathname,
+		u,
+		i.defaultRouteKey
+	]);
+	return {
+		modulePrefix: u,
+		activeNavKey: d,
+		navigateToKey: e((e) => {
+			l(o(u, e, c.pathname));
+		}, [
+			l,
+			u,
+			c.pathname
+		]),
+		rootPath: f
+	};
+}
+//#endregion
+export { o as buildModuleNavPath, s as buildModuleRootPath, i as isRouteKey, a as resolveModulePath, c as useModuleRouting };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravitee/gamma-modules-sdk",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.1-feat-routing.df22a7d",
   "type": "module",
   "license": "Apache-2.0",
   "packageManager": "yarn@4.13.0",
@@ -19,6 +19,10 @@
     },
     "./types": {
       "types": "./dist/types.d.ts"
+    },
+    "./routing": {
+      "types": "./dist/routing.d.ts",
+      "import": "./dist/routing.js"
     }
   },
   "scripts": {
@@ -28,12 +32,14 @@
     "lint:fix:all": "yarn lint:fix && yarn format",
     "typecheck": "tsc --noEmit",
     "format": "prettier --write .",
+    "test": "vitest run",
     "format:check": "prettier --check .",
     "prepare": "husky"
   },
   "peerDependencies": {
     "react": ">=19",
-    "react-dom": ">=19"
+    "react-dom": ">=19",
+    "react-router-dom": ">=6"
   },
   "devDependencies": {
     "@commitlint/cli": "20.5.0",
@@ -60,11 +66,13 @@
     "prettier": "3.8.3",
     "react": "19.2.5",
     "react-dom": "19.2.5",
+    "react-router-dom": "7.6.1",
     "semantic-release": "25.0.3",
     "typescript": "6.0.3",
     "typescript-eslint": "8.58.2",
     "vite": "8.0.8",
-    "vite-plugin-dts": "4.5.4"
+    "vite-plugin-dts": "4.5.4",
+    "vitest": "3.2.1"
   },
   "lint-staged": {
     "*.{ts,tsx}": [