@vaadin/hilla-file-router 24.4.0-alpha10

package/.lintstagedrc.js

@@ -0,0 +1,6 @@
+import { commands, extensions } from '../../../.lintstagedrc.js';
+
+export default {
+  [`src/**/*.{${extensions}}`]: commands,
+  [`test/**/*.{${extensions}}`]: commands,
+};

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@vaadin/hilla-file-router",
+  "version": "24.4.0-alpha10",
+  "description": "Hilla file-based router",
+  "main": "index.js",
+  "module": "index.js",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vaadin/hilla.git",
+    "directory": "packages/ts/hilla-file-router"
+  },
+  "keywords": [
+    "Hilla",
+    "Vite",
+    "Plugin",
+    "File",
+    "Router",
+    "Routing"
+  ],
+  "scripts": {
+    "clean:build": "git clean -fx . -e .vite -e node_modules",
+    "build": "concurrently npm:build:*",
+    "build:esbuild": "tsx ../../../scripts/build.ts",
+    "build:dts": "tsc --isolatedModules -p tsconfig.build.json",
+    "build:copy": "cd src && copyfiles *.d.ts **/*.d.ts ..",
+    "lint": "eslint src test",
+    "lint:fix": "eslint src test --fix",
+    "test": "mocha test/**/*.spec.ts --config ../../../.mocharc.cjs",
+    "test:coverage": "c8 -c ../../../.c8rc.json npm test",
+    "typecheck": "tsc --noEmit"
+  },
+  "exports": {
+    "./runtime.js": {
+      "default": "./runtime.js"
+    },
+    "./types.js": {
+      "types": "./types.d.ts"
+    },
+    "./vite-plugin.js": {
+      "default": "./vite-plugin.js"
+    }
+  },
+  "author": "Vaadin Ltd",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/vaadin/hilla/issues"
+  },
+  "homepage": "https://vaadin.com",
+  "files": [
+    "*.{d.ts.map,d.ts,js.map,js}",
+    "runtime",
+    "shared",
+    "vite-plugin"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "react": "^18.2.0",
+    "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": "^10.0.17",
+    "@types/sinon-chai": "^3.2.12",
+    "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": "^16.0.0",
+    "sinon-chai": "^3.7.0",
+    "type-fest": "^4.9.0"
+  },
+  "dependencies": {
+    "@vaadin/hilla-generator-utils": "24.4.0-alpha10",
+    "react": "^18.2.0",
+    "rollup": "^4.12.0",
+    "typescript": "5.3.2"
+  }
+}

package/runtime/createMenuItems.d.ts

@@ -0,0 +1,14 @@
+import type { MenuItem } from '../types.js';
+/**
+ * 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: Readonly<Record<string, import("../shared/internal.js").ServerViewConfig>>;
+    }> | 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":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAc,MAAM,aAAa,CAAC;AAExD;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,YAAY;;;;cAAkC,GAAG,SAAS,QAAQ,EAAE,CAwBnG"}

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 type { VaadinWindow } from '../shared/internal.js';\nimport { RouteParamType } from '../shared/routeParamType.js';\nimport type { MenuItem, ViewConfig } from '../types.js';\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 as VaadinWindow).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": "AACA,SAAS,sBAAsB;AAUxB,SAAS,gBAAgB,eAAgB,OAAwB,QAA6B;AACnG,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-dom';
+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,kBAAkB,CAAC;AAEpD,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-dom';\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-dom";
+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-dom';\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

@@ -0,0 +1,11 @@
+/**
+ * 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;
+//# sourceMappingURL=utils.d.ts.map

package/runtime/utils.d.ts.map

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,11 @@
+function transformRoute(route, getChildren, transformer) {
+  const children = getChildren(route);
+  return transformer(
+    route,
+    children ? Array.from(children, (child) => transformRoute(child, getChildren, transformer)) : []
+  );
+}
+export {
+  transformRoute
+};
+//# sourceMappingURL=utils.js.map

package/runtime/utils.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/runtime/utils.ts"],
+  "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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["src/runtime.ts"],
+  "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/internal.d.ts

@@ -0,0 +1,21 @@
+import type { ViewConfig } from '../types.js';
+import type { RouteParamType } from './routeParamType.js';
+
+/**
+ * Internal type used for server communication and menu building. It extends the
+ * view configuration with the route parameters.
+ */
+export type ServerViewConfig = Readonly<{ params?: Readonly<Record<string, RouteParamType>> }> & ViewConfig;
+
+export type VaadinServer = Readonly<{
+  views: Readonly<Record<string, ServerViewConfig>>;
+}>;
+
+export type VaadinObject = Readonly<{
+  server?: VaadinServer;
+}>;
+
+export type VaadinWindow = Readonly<{
+  Vaadin?: VaadinObject;
+}> &
+  Window;

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.ts

@@ -0,0 +1,72 @@
+import type { RouteParamType } from './shared/routeParamType.js';
+
+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, the component name will be taken,
+   * transformed from camelCase.
+   */
+  title?: string;
+
+  /**
+   * Same as in the explicit React Router configuration.
+   */
+  rolesAllowed?: readonly 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;
+
+  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;
+    /**
+     * Icon to use in the menu.
+     */
+    icon?: string;
+  }>;
+}>;
+
+/**
+ * A module that exports a component and an optional view configuration.
+ */
+export type RouteModule<C = unknown> = Readonly<{
+  default: C;
+  config?: ViewConfig;
+}>;
+
+/**
+ * A framework-agnostic object generated from the file-based route.
+ */
+export type AgnosticRoute<C = unknown> = Readonly<{
+  path: string;
+  module?: RouteModule<C>;
+  children?: ReadonlyArray<AgnosticRoute<T>>;
+}>;
+
+/**
+ * A menu item used in for building the navigation menu.
+ */
+export type MenuItem = Readonly<{
+  to: string;
+  icon?: string;
+  title?: string;
+}>;

package/vite-plugin/collectRoutesFromFS.d.ts

@@ -0,0 +1,41 @@
+import type { Logger } from 'vite';
+export type RouteMeta = Readonly<{
+    path: string;
+    file?: URL;
+    layout?: URL;
+    children: RouteMeta[];
+}>;
+/**
+ * Routes collector options.
+ */
+export type CollectRoutesOptions = Readonly<{
+    /**
+     * The list of extensions for files that will be collected as routes.
+     */
+    extensions: readonly string[];
+    /**
+     * The parent directory of the current directory. This is a
+     * nested parameter used inside the function only.
+     */
+    parent?: URL;
+    /**
+     * The Vite logger instance.
+     */
+    logger: Logger;
+}>;
+/**
+ * Collect route metadata from the file system and build a route tree.
+ *
+ * It accepts files that start with `$` as special files.
+ * - `$layout` contains a component that wraps the child components.
+ * - `$index` contains a component that will be used as the index page of the directory.
+ *
+ * It accepts files that start with `_` as private files. They will be ignored.
+ *
+ * @param dir - The directory to collect routes from.
+ * @param options - The options object.
+ *
+ * @returns The route metadata tree.
+ */
+export default function collectRoutesFromFS(dir: URL, { extensions, logger, parent }: CollectRoutesOptions): Promise<RouteMeta>;
+//# sourceMappingURL=collectRoutesFromFS.d.ts.map

package/vite-plugin/collectRoutesFromFS.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collectRoutesFromFS.d.ts","sourceRoot":"","sources":["../src/vite-plugin/collectRoutesFromFS.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAGnC,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,SAAS,EAAE,CAAC;CACvB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,QAAQ,CAAC;IAC1C;;OAEG;IACH,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9B;;;OAGG;IACH,MAAM,CAAC,EAAE,GAAG,CAAC;IACb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC,CAAC;AAiBH;;;;;;;;;;;;;GAaG;AACH,wBAA8B,mBAAmB,CAC/C,GAAG,EAAE,GAAG,EACR,EAAE,UAAU,EAAE,MAAM,EAAE,MAAY,EAAE,EAAE,oBAAoB,GACzD,OAAO,CAAC,SAAS,CAAC,CAuDpB"}