@vaadin/hilla-file-router 24.4.0-alpha4 → 24.4.0-alpha6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/hilla-file-router",
-  "version": "24.4.0-alpha4",
+  "version": "24.4.0-alpha6",
   "description": "Hilla file-based router",
   "main": "index.js",
   "module": "index.js",
@@ -34,8 +34,11 @@
     "./runtime.js": {
       "default": "./runtime.js"
     },
-    "./vite-plugin-file-router.js": {
-      "default": "./vite-plugin-file-router.js"
+    "./types.js": {
+      "types": "./types.d.ts"
+    },
+    "./vite-plugin.js": {
+      "default": "./vite-plugin.js"
     }
   },
   "author": "Vaadin Ltd",
@@ -47,30 +50,37 @@
   "files": [
     "*.{d.ts.map,d.ts,js.map,js}",
     "runtime",
+    "shared",
     "vite-plugin"
   ],
   "publishConfig": {
     "access": "public"
   },
   "peerDependencies": {
-    "react-router": "^6.21.1"
+    "react": "^18.2.0",
+    "react-router": "^6.21.1",
+    "react-router-dom": "^6.21.1"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4-fix.0",
+    "@types/chai-as-promised": "^7.1.8",
+    "@types/chai-fs": "^2.0.4",
     "@types/chai-like": "^1.1.3",
     "@types/deep-equal-in-any-order": "^1.0.3",
     "@types/mocha": "^10.0.6",
-    "@types/sinon": "^17.0.3",
+    "@types/sinon": "^10.0.17",
+    "chai-as-promised": "^7.1.1",
+    "chai-fs": "^2.0.0",
     "chai-like": "^1.1.1",
     "deep-equal-in-any-order": "^2.0.6",
     "mocha": "^10.2.0",
     "rimraf": "^5.0.5",
-    "sinon": "^17.0.1",
-    "type-fest": "^4.9.0",
-    "typescript": "^5.3.3"
+    "sinon": "^16.0.0",
+    "type-fest": "^4.9.0"
   },
   "dependencies": {
-    "@vaadin/hilla-generator-utils": "24.4.0-alpha4",
-    "react": "^18.2.0"
+    "@vaadin/hilla-generator-utils": "24.4.0-alpha6",
+    "react": "^18.2.0",
+    "typescript": "5.3.2"
   }
 }

package/runtime/createMenuItems.d.ts

@@ -0,0 +1,44 @@
+import { RouteParamType } from '../shared/routeParamType.js';
+import type { ViewConfig } from '../types.js';
+export type VaadinServer = Readonly<{
+    views: Record<string, ViewConfig>;
+}>;
+export type VaadinObject = Readonly<{
+    server?: VaadinServer;
+}>;
+declare global {
+    interface Window {
+        Vaadin?: VaadinObject;
+    }
+}
+export type MenuItem = Readonly<{
+    to: string;
+    icon?: string;
+    title?: string;
+}>;
+/**
+ * Creates menu items from the views provided by the server. The views are sorted according to the
+ * {@link ViewConfig.menu.order} and filtered out if they are explicitly excluded via {@link ViewConfig.menu.exclude}.
+ *
+ * @param vaadinObject - The Vaadin object containing the server views.
+ * @returns A list of menu items.
+ */
+export declare function createMenuItems(vaadinObject?: Readonly<{
+    server?: Readonly<{
+        views: Record<string, Readonly<{
+            title?: string | undefined;
+            params?: Readonly<Record<string, RouteParamType>> | undefined;
+            rolesAllowed?: string[] | undefined;
+            route?: string | undefined;
+            lazy?: boolean | undefined;
+            register?: boolean | undefined;
+            menu?: Readonly<{
+                title?: string | undefined;
+                order?: number | undefined;
+                exclude?: boolean | undefined;
+                icon?: string | undefined;
+            }> | undefined;
+        }>>;
+    }> | undefined;
+}> | undefined): readonly MenuItem[];
+//# sourceMappingURL=createMenuItems.d.ts.map

package/runtime/createMenuItems.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createMenuItems.d.ts","sourceRoot":"","sources":["../src/runtime/createMenuItems.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC;IAClC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;CACnC,CAAC,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC;IAClC,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB,CAAC,CAAC;AAEH,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,MAAM,CAAC,EAAE,YAAY,CAAC;KACvB;CACF;AAED,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAC;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,YAAY;;;;;;;;;;;;;;;;;cAAgB,GAAG,SAAS,QAAQ,EAAE,CAwBjF"}

package/runtime/createMenuItems.js

@@ -0,0 +1,17 @@
+import { RouteParamType } from "../shared/routeParamType.js";
+function createMenuItems(vaadinObject = window.Vaadin) {
+  return vaadinObject?.server?.views ? Object.entries(vaadinObject.server.views).filter(
+    ([_key, value]) => !value.menu?.exclude && !(value.params && Object.values(value.params).some((p) => p === RouteParamType.Required))
+  ).sort(([_a, a], [_b, b]) => (a.menu?.order ?? 0) - (b.menu?.order ?? 0)).map(([path, config]) => {
+    const _path = config.params ? Object.keys(config.params).reduce((acc, key) => acc.replaceAll(key, ""), path) : path;
+    return {
+      to: _path,
+      icon: config.menu?.icon,
+      title: config.menu?.title ?? config.title
+    };
+  }) : [];
+}
+export {
+  createMenuItems
+};
+//# sourceMappingURL=createMenuItems.js.map

package/runtime/createMenuItems.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/runtime/createMenuItems.ts"],
+  "sourcesContent": ["import { RouteParamType } from '../shared/routeParamType.js';\nimport type { ViewConfig } from '../types.js';\n\nexport type VaadinServer = Readonly<{\n  views: Record<string, ViewConfig>;\n}>;\n\nexport type VaadinObject = Readonly<{\n  server?: VaadinServer;\n}>;\n\ndeclare global {\n  interface Window {\n    Vaadin?: VaadinObject;\n  }\n}\n\nexport type MenuItem = Readonly<{\n  to: string;\n  icon?: string;\n  title?: string;\n}>;\n\n/**\n * Creates menu items from the views provided by the server. The views are sorted according to the\n * {@link ViewConfig.menu.order} and filtered out if they are explicitly excluded via {@link ViewConfig.menu.exclude}.\n *\n * @param vaadinObject - The Vaadin object containing the server views.\n * @returns A list of menu items.\n */\nexport function createMenuItems(vaadinObject = window.Vaadin): readonly MenuItem[] {\n  return vaadinObject?.server?.views\n    ? Object.entries(vaadinObject.server.views)\n        // Filter out the views that are explicitly excluded from the menu.\n        .filter(\n          ([_key, value]) =>\n            !value.menu?.exclude &&\n            !(value.params && Object.values(value.params).some((p) => p === RouteParamType.Required)),\n        )\n        // Sort views according to the order specified in the view configuration.\n        .sort(([_a, a], [_b, b]) => (a.menu?.order ?? 0) - (b.menu?.order ?? 0))\n        // Map the views to menu items.\n        .map(([path, config]) => {\n          const _path = config.params\n            ? Object.keys(config.params).reduce((acc, key) => acc.replaceAll(key, ''), path)\n            : path;\n\n          return {\n            to: _path,\n            icon: config.menu?.icon,\n            title: config.menu?.title ?? config.title,\n          };\n        })\n    : [];\n}\n"],
+  "mappings": "AAAA,SAAS,sBAAsB;AA8BxB,SAAS,gBAAgB,eAAe,OAAO,QAA6B;AACjF,SAAO,cAAc,QAAQ,QACzB,OAAO,QAAQ,aAAa,OAAO,KAAK,EAErC;AAAA,IACC,CAAC,CAAC,MAAM,KAAK,MACX,CAAC,MAAM,MAAM,WACb,EAAE,MAAM,UAAU,OAAO,OAAO,MAAM,MAAM,EAAE,KAAK,CAAC,MAAM,MAAM,eAAe,QAAQ;AAAA,EAC3F,EAEC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,SAAS,MAAM,EAAE,MAAM,SAAS,EAAE,EAEtE,IAAI,CAAC,CAAC,MAAM,MAAM,MAAM;AACvB,UAAM,QAAQ,OAAO,SACjB,OAAO,KAAK,OAAO,MAAM,EAAE,OAAO,CAAC,KAAK,QAAQ,IAAI,WAAW,KAAK,EAAE,GAAG,IAAI,IAC7E;AAEJ,WAAO;AAAA,MACL,IAAI;AAAA,MACJ,MAAM,OAAO,MAAM;AAAA,MACnB,OAAO,OAAO,MAAM,SAAS,OAAO;AAAA,IACtC;AAAA,EACF,CAAC,IACH,CAAC;AACP;",
+  "names": []
+}

package/runtime/createRoute.d.ts

@@ -0,0 +1,13 @@
+import type { AgnosticRoute, RouteModule } from '../types.js';
+/**
+ * Create a single framework-agnostic route object. Later, it can be transformed into a framework-specific route object,
+ * e.g., the one used by React Router.
+ *
+ * @param path - A route path segment.
+ * @param children - An array of child routes.
+ *
+ * @returns A framework-agnostic route object.
+ */
+export declare function createRoute<C = unknown>(path: string, children?: ReadonlyArray<AgnosticRoute<C>>): AgnosticRoute<C>;
+export declare function createRoute<C = unknown>(path: string, module: RouteModule<C>, children?: ReadonlyArray<AgnosticRoute<C>>): AgnosticRoute<C>;
+//# sourceMappingURL=createRoute.d.ts.map

package/runtime/createRoute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createRoute.d.ts","sourceRoot":"","sources":["../src/runtime/createRoute.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE9D;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AACrH,wBAAgB,WAAW,CAAC,CAAC,GAAG,OAAO,EACrC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,EACtB,QAAQ,CAAC,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GACzC,aAAa,CAAC,CAAC,CAAC,CAAC"}

package/runtime/createRoute.js

@@ -0,0 +1,17 @@
+function createRoute(path, moduleOrChildren, children) {
+  let module;
+  if (Array.isArray(moduleOrChildren)) {
+    children = moduleOrChildren;
+  } else {
+    module = moduleOrChildren;
+  }
+  return {
+    path: module?.config?.route ?? path,
+    module,
+    children
+  };
+}
+export {
+  createRoute
+};
+//# sourceMappingURL=createRoute.js.map

package/runtime/createRoute.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/runtime/createRoute.ts"],
+  "sourcesContent": ["/* eslint-disable no-param-reassign */\nimport type { AgnosticRoute, RouteModule } from '../types.js';\n\n/**\n * Create a single framework-agnostic route object. Later, it can be transformed into a framework-specific route object,\n * e.g., the one used by React Router.\n *\n * @param path - A route path segment.\n * @param children - An array of child routes.\n *\n * @returns A framework-agnostic route object.\n */\nexport function createRoute<C = unknown>(path: string, children?: ReadonlyArray<AgnosticRoute<C>>): AgnosticRoute<C>;\nexport function createRoute<C = unknown>(\n  path: string,\n  module: RouteModule<C>,\n  children?: ReadonlyArray<AgnosticRoute<C>>,\n): AgnosticRoute<C>;\nexport function createRoute<C = unknown>(\n  path: string,\n  moduleOrChildren?: ReadonlyArray<AgnosticRoute<C>> | RouteModule<C>,\n  children?: ReadonlyArray<AgnosticRoute<C>>,\n): AgnosticRoute<C> {\n  let module: RouteModule<C> | undefined;\n  if (Array.isArray(moduleOrChildren)) {\n    children = moduleOrChildren;\n  } else {\n    module = moduleOrChildren as RouteModule<C> | undefined;\n  }\n\n  return {\n    path: module?.config?.route ?? path,\n    module,\n    children,\n  };\n}\n"],
+  "mappings": "AAkBO,SAAS,YACd,MACA,kBACA,UACkB;AAClB,MAAI;AACJ,MAAI,MAAM,QAAQ,gBAAgB,GAAG;AACnC,eAAW;AAAA,EACb,OAAO;AACL,aAAS;AAAA,EACX;AAEA,SAAO;AAAA,IACL,MAAM,QAAQ,QAAQ,SAAS;AAAA,IAC/B;AAAA,IACA;AAAA,EACF;AACF;",
+  "names": []
+}

package/runtime/toReactRouter.d.ts

@@ -0,0 +1,12 @@
+import { type ComponentType } from 'react';
+import type { RouteObject } from 'react-router';
+import type { AgnosticRoute } from '../types.js';
+/**
+ * Transforms framework-agnostic route tree into a format that can be used by React Router.
+ *
+ * @param routes - Generated routes
+ *
+ * @returns The React Router tree.
+ */
+export declare function toReactRouter(routes: AgnosticRoute<ComponentType>): RouteObject;
+//# sourceMappingURL=toReactRouter.d.ts.map

package/runtime/toReactRouter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"toReactRouter.d.ts","sourceRoot":"","sources":["../src/runtime/toReactRouter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,OAAO,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAGjD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,CAAC,GAAG,WAAW,CAkB/E"}

package/runtime/toReactRouter.js

@@ -0,0 +1,25 @@
+import { createElement } from "react";
+import { convertComponentNameToTitle } from "../shared/convertComponentNameToTitle.js";
+import { transformRoute } from "./utils.js";
+function toReactRouter(routes) {
+  return transformRoute(
+    routes,
+    (route) => route.children?.values(),
+    ({ path, module }, children) => {
+      const title = module?.config?.title ?? convertComponentNameToTitle(module?.default);
+      return {
+        path,
+        element: module?.default ? createElement(module.default) : void 0,
+        children: children.length > 0 ? children : void 0,
+        handle: {
+          ...module?.config,
+          title
+        }
+      };
+    }
+  );
+}
+export {
+  toReactRouter
+};
+//# sourceMappingURL=toReactRouter.js.map

package/runtime/toReactRouter.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/runtime/toReactRouter.ts"],
+  "sourcesContent": ["import { type ComponentType, createElement } from 'react';\nimport type { RouteObject } from 'react-router';\nimport { convertComponentNameToTitle } from '../shared/convertComponentNameToTitle.js';\nimport type { AgnosticRoute } from '../types.js';\nimport { transformRoute } from './utils.js';\n\n/**\n * Transforms framework-agnostic route tree into a format that can be used by React Router.\n *\n * @param routes - Generated routes\n *\n * @returns The React Router tree.\n */\nexport function toReactRouter(routes: AgnosticRoute<ComponentType>): RouteObject {\n  return transformRoute(\n    routes,\n    (route) => route.children?.values(),\n    ({ path, module }, children) => {\n      const title = module?.config?.title ?? convertComponentNameToTitle(module?.default);\n\n      return {\n        path,\n        element: module?.default ? createElement(module.default) : undefined,\n        children: children.length > 0 ? (children as RouteObject[]) : undefined,\n        handle: {\n          ...module?.config,\n          title,\n        },\n      } satisfies RouteObject;\n    },\n  );\n}\n"],
+  "mappings": "AAAA,SAA6B,qBAAqB;AAElD,SAAS,mCAAmC;AAE5C,SAAS,sBAAsB;AASxB,SAAS,cAAc,QAAmD;AAC/E,SAAO;AAAA,IACL;AAAA,IACA,CAAC,UAAU,MAAM,UAAU,OAAO;AAAA,IAClC,CAAC,EAAE,MAAM,OAAO,GAAG,aAAa;AAC9B,YAAM,QAAQ,QAAQ,QAAQ,SAAS,4BAA4B,QAAQ,OAAO;AAElF,aAAO;AAAA,QACL;AAAA,QACA,SAAS,QAAQ,UAAU,cAAc,OAAO,OAAO,IAAI;AAAA,QAC3D,UAAU,SAAS,SAAS,IAAK,WAA6B;AAAA,QAC9D,QAAQ;AAAA,UACN,GAAG,QAAQ;AAAA,UACX;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;",
+  "names": []
+}

package/runtime/useViewConfig.d.ts

@@ -0,0 +1,6 @@
+import type { ViewConfig } from '../types.js';
+/**
+ * Hook to return the {@link ViewConfig} for the current route.
+ */
+export declare function useViewConfig<M extends ViewConfig>(): M | undefined;
+//# sourceMappingURL=useViewConfig.d.ts.map

package/runtime/useViewConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useViewConfig.d.ts","sourceRoot":"","sources":["../src/runtime/useViewConfig.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C;;GAEG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,UAAU,KAAK,CAAC,GAAG,SAAS,CAGnE"}

package/runtime/useViewConfig.js

@@ -0,0 +1,9 @@
+import { useMatches } from "react-router";
+function useViewConfig() {
+  const matches = useMatches();
+  return matches[matches.length - 1]?.handle;
+}
+export {
+  useViewConfig
+};
+//# sourceMappingURL=useViewConfig.js.map

package/runtime/useViewConfig.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/runtime/useViewConfig.ts"],
+  "sourcesContent": ["import type { UIMatch } from '@remix-run/router';\nimport { useMatches } from 'react-router';\nimport type { ViewConfig } from '../types.js';\n\n/**\n * Hook to return the {@link ViewConfig} for the current route.\n */\nexport function useViewConfig<M extends ViewConfig>(): M | undefined {\n  const matches = useMatches() as ReadonlyArray<UIMatch<unknown, M>>;\n  return matches[matches.length - 1]?.handle;\n}\n"],
+  "mappings": "AACA,SAAS,kBAAkB;AAMpB,SAAS,gBAAqD;AACnE,QAAM,UAAU,WAAW;AAC3B,SAAO,QAAQ,QAAQ,SAAS,CAAC,GAAG;AACtC;",
+  "names": []
+}

package/runtime/utils.d.ts

@@ -1,58 +1,11 @@
-export type ViewConfig = Readonly<{
-    /**
-     * View title used in the main layout header, as <title> and as the default
-     * for the menu entry. If not defined, then the view function name is converted
-     * from CamelCase after removing any "View" postfix.
-     */
-    title?: string;
-    /**
-     * Same as in the explicit React Router configuration.
-     */
-    rolesAllowed?: string[];
-    /**
-     * Allows overriding the route path configuration. Uses the same syntax as
-     * the path property with React Router. This can be used to define a route
-     * that conflicts with the file name conventions, e.g. /foo/index
-     */
-    route?: string;
-    /**
-     * Controls whether the view implementation will be lazy loaded the first time
-     * it's used or always included in the bundle. If set to undefined (which is
-     * the default), views mapped to / and /login will be eager and any other view
-     * will be lazy (this is in sync with defaults in Flow)
-     */
-    lazy?: boolean;
-    /**
-     * If set to false, then the route will not be registered with React Router,
-     * but it will still be included in the main menu and used to configure
-     * Spring Security
-     */
-    register?: boolean;
-    menu?: Readonly<{
-        /**
-         * Title to use in the menu. Falls back the title property of the view
-         * itself if not defined.
-         */
-        title?: string;
-        /**
-         * Used to determine the order in the menu. Ties are resolved based on the
-         * used title. Entries without explicitly defined ordering are put below
-         * entries with an order.
-         */
-        order?: number;
-        /**
-         * Set to true to explicitly exclude a view from the automatically
-         * populated menu.
-         */
-        exclude?: boolean;
-    }>;
-}>;
-export type AgnosticRoute<T> = Readonly<{
-    path: string;
-    module?: T;
-    children?: ReadonlyArray<AgnosticRoute<T>>;
-}>;
+/**
+ * Transforms the whole route tree into a new format.
+ *
+ * @param route - The route to transform.
+ * @param getChildren - A function that returns the children of the route.
+ * @param transformer - A function that transforms the route and its children.
+ *
+ * @returns The transformed route.
+ */
 export declare function transformRoute<T, U>(route: T, getChildren: (route: T) => IterableIterator<T> | null | undefined, transformer: (route: T, children: readonly U[]) => U): U;
-export declare function extractComponentName(component?: unknown): string | undefined;
-export declare function adjustViewTitle(config?: ViewConfig, componentName?: string): ViewConfig | undefined;
 //# sourceMappingURL=utils.d.ts.map

package/runtime/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/runtime/utils.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC;IAChC;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,IAAI,CAAC,EAAE,QAAQ,CAAC;QACd;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;;WAIG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC,CAAC;CACJ,CAAC,CAAC;AAEH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,QAAQ,CAAC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,CAAC,CAAC;IACX,QAAQ,CAAC,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5C,CAAC,CAAC;AAEH,wBAAgB,cAAc,CAAC,CAAC,EAAE,CAAC,EACjC,KAAK,EAAE,CAAC,EACR,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,EACjE,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,KAAK,CAAC,GACnD,CAAC,CAOH;AAED,wBAAgB,oBAAoB,CAAC,SAAS,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAW5E;AAKD,wBAAgB,eAAe,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAanG"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/runtime/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,CAAC,EACjC,KAAK,EAAE,CAAC,EACR,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,EACjE,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,KAAK,CAAC,GACnD,CAAC,CAOH"}

package/runtime/utils.js

@@ -5,29 +5,7 @@ function transformRoute(route, getChildren, transformer) {
     children ? Array.from(children, (child) => transformRoute(child, getChildren, transformer)) : []
   );
 }
-function extractComponentName(component) {
-  if (component && (typeof component === "object" || typeof component === "function") && "name" in component && typeof component.name === "string") {
-    return component.name;
-  }
-  return void 0;
-}
-const viewPattern = /view/giu;
-const upperCaseSplitPattern = /(?=[A-Z])/gu;
-function adjustViewTitle(config, componentName) {
-  if (config?.title) {
-    return config;
-  }
-  if (componentName) {
-    return {
-      ...config,
-      title: componentName.replace(viewPattern, "").split(upperCaseSplitPattern).join(" ")
-    };
-  }
-  return config;
-}
 export {
-  adjustViewTitle,
-  extractComponentName,
   transformRoute
 };
 //# sourceMappingURL=utils.js.map

package/runtime/utils.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/runtime/utils.ts"],
-  "sourcesContent": ["export type ViewConfig = Readonly<{\n  /**\n   * View title used in the main layout header, as <title> and as the default\n   * for the menu entry. If not defined, then the view function name is converted\n   * from CamelCase after removing any \"View\" postfix.\n   */\n  title?: string;\n\n  /**\n   * Same as in the explicit React Router configuration.\n   */\n  rolesAllowed?: string[];\n\n  /**\n   * Allows overriding the route path configuration. Uses the same syntax as\n   * the path property with React Router. This can be used to define a route\n   * that conflicts with the file name conventions, e.g. /foo/index\n   */\n  route?: string;\n\n  /**\n   * Controls whether the view implementation will be lazy loaded the first time\n   * it's used or always included in the bundle. If set to undefined (which is\n   * the default), views mapped to / and /login will be eager and any other view\n   * will be lazy (this is in sync with defaults in Flow)\n   */\n  lazy?: boolean;\n\n  /**\n   * If set to false, then the route will not be registered with React Router,\n   * but it will still be included in the main menu and used to configure\n   * Spring Security\n   */\n  register?: boolean;\n\n  menu?: Readonly<{\n    /**\n     * Title to use in the menu. Falls back the title property of the view\n     * itself if not defined.\n     */\n    title?: string;\n\n    /**\n     * Used to determine the order in the menu. Ties are resolved based on the\n     * used title. Entries without explicitly defined ordering are put below\n     * entries with an order.\n     */\n    order?: number;\n    /**\n     * Set to true to explicitly exclude a view from the automatically\n     * populated menu.\n     */\n    exclude?: boolean;\n  }>;\n}>;\n\nexport type AgnosticRoute<T> = Readonly<{\n  path: string;\n  module?: T;\n  children?: ReadonlyArray<AgnosticRoute<T>>;\n}>;\n\nexport function transformRoute<T, U>(\n  route: T,\n  getChildren: (route: T) => IterableIterator<T> | null | undefined,\n  transformer: (route: T, children: readonly U[]) => U,\n): U {\n  const children = getChildren(route);\n\n  return transformer(\n    route,\n    children ? Array.from(children, (child) => transformRoute(child, getChildren, transformer)) : [],\n  );\n}\n\nexport function extractComponentName(component?: unknown): string | undefined {\n  if (\n    component &&\n    (typeof component === 'object' || typeof component === 'function') &&\n    'name' in component &&\n    typeof component.name === 'string'\n  ) {\n    return component.name;\n  }\n\n  return undefined;\n}\n\nconst viewPattern = /view/giu;\nconst upperCaseSplitPattern = /(?=[A-Z])/gu;\n\nexport function adjustViewTitle(config?: ViewConfig, componentName?: string): ViewConfig | undefined {\n  if (config?.title) {\n    return config;\n  }\n\n  if (componentName) {\n    return {\n      ...config,\n      title: componentName.replace(viewPattern, '').split(upperCaseSplitPattern).join(' '),\n    };\n  }\n\n  return config;\n}\n"],
-  "mappings": "AA8DO,SAAS,eACd,OACA,aACA,aACG;AACH,QAAM,WAAW,YAAY,KAAK;AAElC,SAAO;AAAA,IACL;AAAA,IACA,WAAW,MAAM,KAAK,UAAU,CAAC,UAAU,eAAe,OAAO,aAAa,WAAW,CAAC,IAAI,CAAC;AAAA,EACjG;AACF;AAEO,SAAS,qBAAqB,WAAyC;AAC5E,MACE,cACC,OAAO,cAAc,YAAY,OAAO,cAAc,eACvD,UAAU,aACV,OAAO,UAAU,SAAS,UAC1B;AACA,WAAO,UAAU;AAAA,EACnB;AAEA,SAAO;AACT;AAEA,MAAM,cAAc;AACpB,MAAM,wBAAwB;AAEvB,SAAS,gBAAgB,QAAqB,eAAgD;AACnG,MAAI,QAAQ,OAAO;AACjB,WAAO;AAAA,EACT;AAEA,MAAI,eAAe;AACjB,WAAO;AAAA,MACL,GAAG;AAAA,MACH,OAAO,cAAc,QAAQ,aAAa,EAAE,EAAE,MAAM,qBAAqB,EAAE,KAAK,GAAG;AAAA,IACrF;AAAA,EACF;AAEA,SAAO;AACT;",
+  "sourcesContent": ["/**\n * Transforms the whole route tree into a new format.\n *\n * @param route - The route to transform.\n * @param getChildren - A function that returns the children of the route.\n * @param transformer - A function that transforms the route and its children.\n *\n * @returns The transformed route.\n */\nexport function transformRoute<T, U>(\n  route: T,\n  getChildren: (route: T) => IterableIterator<T> | null | undefined,\n  transformer: (route: T, children: readonly U[]) => U,\n): U {\n  const children = getChildren(route);\n\n  return transformer(\n    route,\n    children ? Array.from(children, (child) => transformRoute(child, getChildren, transformer)) : [],\n  );\n}\n"],
+  "mappings": "AASO,SAAS,eACd,OACA,aACA,aACG;AACH,QAAM,WAAW,YAAY,KAAK;AAElC,SAAO;AAAA,IACL;AAAA,IACA,WAAW,MAAM,KAAK,UAAU,CAAC,UAAU,eAAe,OAAO,aAAa,WAAW,CAAC,IAAI,CAAC;AAAA,EACjG;AACF;",
   "names": []
 }

package/runtime.d.ts

@@ -1,18 +1,5 @@
-import { type ComponentType } from 'react';
-import { type RouteObject } from 'react-router';
-import { type AgnosticRoute, type ViewConfig } from './runtime/utils.js';
-export type RouteModule<P = object> = Readonly<{
-    default: ComponentType<P>;
-    config?: ViewConfig;
-}>;
-/**
- * Transforms generated routes into a format that can be used by React Router.
- *
- * @param routes - Generated routes
- */
-export declare function toReactRouter(routes: AgnosticRoute<RouteModule>): RouteObject;
-/**
- * Hook to return the {@link ViewConfig} for the current route.
- */
-export declare function useViewConfig<M extends ViewConfig>(): M | undefined;
+export * from './runtime/createRoute.js';
+export * from './runtime/toReactRouter.js';
+export * from './runtime/useViewConfig.js';
+export * from './runtime/createMenuItems.js';
 //# sourceMappingURL=runtime.d.ts.map

package/runtime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["src/runtime.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,OAAO,CAAC;AAC1D,OAAO,EAAE,KAAK,WAAW,EAAc,MAAM,cAAc,CAAC;AAC5D,OAAO,EACL,KAAK,aAAa,EAGlB,KAAK,UAAU,EAEhB,MAAM,oBAAoB,CAAC;AAE5B,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,MAAM,IAAI,QAAQ,CAAC;IAC7C,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAC1B,MAAM,CAAC,EAAE,UAAU,CAAC;CACrB,CAAC,CAAC;AAEH;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,WAAW,CAY7E;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,UAAU,KAAK,CAAC,GAAG,SAAS,CAGnE"}
+{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["src/runtime.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC"}

package/runtime.js

@@ -1,28 +1,5 @@
-import { createElement } from "react";
-import { useMatches } from "react-router";
-import {
-  transformRoute,
-  adjustViewTitle,
-  extractComponentName
-} from "./runtime/utils.js";
-function toReactRouter(routes) {
-  return transformRoute(
-    routes,
-    (route) => route.children?.values(),
-    ({ path, module }, children) => ({
-      path,
-      element: module?.default ? createElement(module.default) : void 0,
-      children: children.length > 0 ? children : void 0,
-      handle: adjustViewTitle(module?.config, extractComponentName(module?.default))
-    })
-  );
-}
-function useViewConfig() {
-  const matches = useMatches();
-  return matches[matches.length - 1]?.handle;
-}
-export {
-  toReactRouter,
-  useViewConfig
-};
+export * from "./runtime/createRoute.js";
+export * from "./runtime/toReactRouter.js";
+export * from "./runtime/useViewConfig.js";
+export * from "./runtime/createMenuItems.js";
 //# sourceMappingURL=runtime.js.map

package/runtime.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["src/runtime.ts"],
-  "sourcesContent": ["import type { UIMatch } from '@remix-run/router';\nimport { type ComponentType, createElement } from 'react';\nimport { type RouteObject, useMatches } from 'react-router';\nimport {\n  type AgnosticRoute,\n  transformRoute,\n  adjustViewTitle,\n  type ViewConfig,\n  extractComponentName,\n} from './runtime/utils.js';\n\nexport type RouteModule<P = object> = Readonly<{\n  default: ComponentType<P>;\n  config?: ViewConfig;\n}>;\n\n/**\n * Transforms generated routes into a format that can be used by React Router.\n *\n * @param routes - Generated routes\n */\nexport function toReactRouter(routes: AgnosticRoute<RouteModule>): RouteObject {\n  return transformRoute(\n    routes,\n    (route) => route.children?.values(),\n    ({ path, module }, children) =>\n      ({\n        path,\n        element: module?.default ? createElement(module.default) : undefined,\n        children: children.length > 0 ? (children as RouteObject[]) : undefined,\n        handle: adjustViewTitle(module?.config, extractComponentName(module?.default)),\n      }) satisfies RouteObject,\n  );\n}\n\n/**\n * Hook to return the {@link ViewConfig} for the current route.\n */\nexport function useViewConfig<M extends ViewConfig>(): M | undefined {\n  const matches = useMatches() as ReadonlyArray<UIMatch<unknown, M>>;\n  return matches[matches.length - 1]?.handle;\n}\n"],
-  "mappings": "AACA,SAA6B,qBAAqB;AAClD,SAA2B,kBAAkB;AAC7C;AAAA,EAEE;AAAA,EACA;AAAA,EAEA;AAAA,OACK;AAYA,SAAS,cAAc,QAAiD;AAC7E,SAAO;AAAA,IACL;AAAA,IACA,CAAC,UAAU,MAAM,UAAU,OAAO;AAAA,IAClC,CAAC,EAAE,MAAM,OAAO,GAAG,cAChB;AAAA,MACC;AAAA,MACA,SAAS,QAAQ,UAAU,cAAc,OAAO,OAAO,IAAI;AAAA,MAC3D,UAAU,SAAS,SAAS,IAAK,WAA6B;AAAA,MAC9D,QAAQ,gBAAgB,QAAQ,QAAQ,qBAAqB,QAAQ,OAAO,CAAC;AAAA,IAC/E;AAAA,EACJ;AACF;AAKO,SAAS,gBAAqD;AACnE,QAAM,UAAU,WAAW;AAC3B,SAAO,QAAQ,QAAQ,SAAS,CAAC,GAAG;AACtC;",
+  "sourcesContent": ["export * from './runtime/createRoute.js';\nexport * from './runtime/toReactRouter.js';\nexport * from './runtime/useViewConfig.js';\nexport * from './runtime/createMenuItems.js';\n"],
+  "mappings": "AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;",
   "names": []
 }

package/shared/convertComponentNameToTitle.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Converts the name of the component to a page title.
+ *
+ * @param component - The component to convert the name from.
+ *
+ * @returns The page title.
+ */
+export declare function convertComponentNameToTitle(component?: unknown): string | undefined;
+//# sourceMappingURL=convertComponentNameToTitle.d.ts.map

package/shared/convertComponentNameToTitle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convertComponentNameToTitle.d.ts","sourceRoot":"","sources":["../src/shared/convertComponentNameToTitle.ts"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,wBAAgB,2BAA2B,CAAC,SAAS,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAmBnF"}

package/shared/convertComponentNameToTitle.js

@@ -0,0 +1,18 @@
+const viewPattern = /view/giu;
+const upperCaseSplitPattern = /(?=[A-Z])/gu;
+function convertComponentNameToTitle(component) {
+  let name;
+  if (typeof component === "string") {
+    name = component;
+  } else if (component && (typeof component === "object" || typeof component === "function") && "name" in component && typeof component.name === "string") {
+    ({ name } = component);
+  }
+  if (name) {
+    return name.replace(viewPattern, "").split(upperCaseSplitPattern).join(" ");
+  }
+  return void 0;
+}
+export {
+  convertComponentNameToTitle
+};
+//# sourceMappingURL=convertComponentNameToTitle.js.map

package/shared/convertComponentNameToTitle.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/shared/convertComponentNameToTitle.ts"],
+  "sourcesContent": ["const viewPattern = /view/giu;\nconst upperCaseSplitPattern = /(?=[A-Z])/gu;\n\n/**\n * Converts the name of the component to a page title.\n *\n * @param component - The component to convert the name from.\n *\n * @returns The page title.\n */\nexport function convertComponentNameToTitle(component?: unknown): string | undefined {\n  let name: string | undefined;\n\n  if (typeof component === 'string') {\n    name = component;\n  } else if (\n    component &&\n    (typeof component === 'object' || typeof component === 'function') &&\n    'name' in component &&\n    typeof component.name === 'string'\n  ) {\n    ({ name } = component);\n  }\n\n  if (name) {\n    return name.replace(viewPattern, '').split(upperCaseSplitPattern).join(' ');\n  }\n\n  return undefined;\n}\n"],
+  "mappings": "AAAA,MAAM,cAAc;AACpB,MAAM,wBAAwB;AASvB,SAAS,4BAA4B,WAAyC;AACnF,MAAI;AAEJ,MAAI,OAAO,cAAc,UAAU;AACjC,WAAO;AAAA,EACT,WACE,cACC,OAAO,cAAc,YAAY,OAAO,cAAc,eACvD,UAAU,aACV,OAAO,UAAU,SAAS,UAC1B;AACA,KAAC,EAAE,KAAK,IAAI;AAAA,EACd;AAEA,MAAI,MAAM;AACR,WAAO,KAAK,QAAQ,aAAa,EAAE,EAAE,MAAM,qBAAqB,EAAE,KAAK,GAAG;AAAA,EAC5E;AAEA,SAAO;AACT;",
+  "names": []
+}

package/shared/routeParamType.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The type of route parameter.
+ */
+export declare enum RouteParamType {
+    Required = "req",
+    Optional = "opt",
+    Wildcard = "*"
+}
+//# sourceMappingURL=routeParamType.d.ts.map

package/shared/routeParamType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routeParamType.d.ts","sourceRoot":"","sources":["../src/shared/routeParamType.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,cAAc;IACxB,QAAQ,QAAQ;IAChB,QAAQ,QAAQ;IAChB,QAAQ,MAAM;CACf"}

package/shared/routeParamType.js

@@ -0,0 +1,10 @@
+var RouteParamType = /* @__PURE__ */ ((RouteParamType2) => {
+  RouteParamType2["Required"] = "req";
+  RouteParamType2["Optional"] = "opt";
+  RouteParamType2["Wildcard"] = "*";
+  return RouteParamType2;
+})(RouteParamType || {});
+export {
+  RouteParamType
+};
+//# sourceMappingURL=routeParamType.js.map

package/shared/routeParamType.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/shared/routeParamType.ts"],
+  "sourcesContent": ["/**\n * The type of route parameter.\n */\nexport enum RouteParamType {\n  Required = 'req',\n  Optional = 'opt',\n  Wildcard = '*',\n}\n"],
+  "mappings": "AAGO,IAAK,iBAAL,kBAAKA,oBAAL;AACL,EAAAA,gBAAA,cAAW;AACX,EAAAA,gBAAA,cAAW;AACX,EAAAA,gBAAA,cAAW;AAHD,SAAAA;AAAA,GAAA;",
+  "names": ["RouteParamType"]
+}

package/shared/traverse.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Traverse a tree and yield the sequence of parent nodes to each leaf node.
+ *
+ * @param tree - The tree to traverse.
+ * @param parents - The sequence of parent nodes for the current node.
+ */
+export default function traverse<T extends {
+    children?: readonly T[];
+}>(tree: T, parents?: readonly T[]): Generator<readonly T[], undefined, undefined>;
+//# sourceMappingURL=traverse.d.ts.map

package/shared/traverse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traverse.d.ts","sourceRoot":"","sources":["../src/shared/traverse.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAW,QAAQ,CAAC,CAAC,SAAS;IAAE,QAAQ,CAAC,EAAE,SAAS,CAAC,EAAE,CAAA;CAAE,EACrE,IAAI,EAAE,CAAC,EACP,OAAO,GAAE,SAAS,CAAC,EAAO,GACzB,SAAS,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,SAAS,CAAC,CAW/C"}

package/shared/traverse.js

@@ -0,0 +1,14 @@
+function* traverse(tree, parents = []) {
+  const chain = [...parents, tree];
+  const children = tree.children ?? [];
+  if (children.length === 0) {
+    yield chain;
+  }
+  for (const child of children) {
+    yield* traverse(child, chain);
+  }
+}
+export {
+  traverse as default
+};
+//# sourceMappingURL=traverse.js.map

package/shared/traverse.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/shared/traverse.ts"],
+  "sourcesContent": ["/**\n * Traverse a tree and yield the sequence of parent nodes to each leaf node.\n *\n * @param tree - The tree to traverse.\n * @param parents - The sequence of parent nodes for the current node.\n */\nexport default function* traverse<T extends { children?: readonly T[] }>(\n  tree: T,\n  parents: readonly T[] = [],\n): Generator<readonly T[], undefined, undefined> {\n  const chain = [...parents, tree];\n  const children = tree.children ?? [];\n\n  if (children.length === 0) {\n    yield chain;\n  }\n\n  for (const child of children) {\n    yield* traverse(child, chain);\n  }\n}\n"],
+  "mappings": "AAMe,UAAR,SACL,MACA,UAAwB,CAAC,GACsB;AAC/C,QAAM,QAAQ,CAAC,GAAG,SAAS,IAAI;AAC/B,QAAM,WAAW,KAAK,YAAY,CAAC;AAEnC,MAAI,SAAS,WAAW,GAAG;AACzB,UAAM;AAAA,EACR;AAEA,aAAW,SAAS,UAAU;AAC5B,WAAO,SAAS,OAAO,KAAK;AAAA,EAC9B;AACF;",
+  "names": []
+}

package/types.d.js

@@ -0,0 +1 @@
+//# sourceMappingURL=types.d.js.map

package/types.d.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}