@vaadin/hilla-file-router 24.8.0-alpha4 → 24.8.0-alpha6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/hilla-file-router",
|
|
3
|
-
"version": "24.8.0-
|
|
3
|
+
"version": "24.8.0-alpha6",
|
|
4
4
|
"description": "Hilla file-based router",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"module": "index.js",
|
|
@@ -61,9 +61,9 @@
|
|
|
61
61
|
"react-router": "7"
|
|
62
62
|
},
|
|
63
63
|
"dependencies": {
|
|
64
|
-
"@vaadin/hilla-generator-utils": "24.8.0-
|
|
65
|
-
"@vaadin/hilla-react-auth": "24.8.0-
|
|
66
|
-
"@vaadin/hilla-react-signals": "24.8.0-
|
|
67
|
-
"typescript": "5"
|
|
64
|
+
"@vaadin/hilla-generator-utils": "24.8.0-alpha6",
|
|
65
|
+
"@vaadin/hilla-react-auth": "24.8.0-alpha6",
|
|
66
|
+
"@vaadin/hilla-react-signals": "24.8.0-alpha6",
|
|
67
|
+
"typescript": "5.8.3"
|
|
68
68
|
}
|
|
69
69
|
}
|
|
@@ -9,4 +9,4 @@ export declare const viewsSignal: Signal<Readonly<Record<string, Readonly<ViewCo
|
|
|
9
9
|
*
|
|
10
10
|
* @returns A list of menu items.
|
|
11
11
|
*/
|
|
12
|
-
export declare function createMenuItems():
|
|
12
|
+
export declare function createMenuItems<T = unknown>(): ReadonlyArray<MenuItem<T>>;
|
|
@@ -19,7 +19,7 @@ export function createMenuItems() {
|
|
|
19
19
|
vaadinObj.registrations ??= [];
|
|
20
20
|
vaadinObj.registrations.push({
|
|
21
21
|
is: feature ? `@vaadin/hilla-file-router/${feature}` : "@vaadin/hilla-file-router",
|
|
22
|
-
version: "24.8.0-
|
|
22
|
+
version: "24.8.0-alpha6"
|
|
23
23
|
});
|
|
24
24
|
})("createMenuItems", window.Vaadin);
|
|
25
25
|
const collator = new Intl.Collator("en-US");
|
|
@@ -31,7 +31,8 @@ export function createMenuItems() {
|
|
|
31
31
|
to: path,
|
|
32
32
|
icon: config.menu?.icon,
|
|
33
33
|
title: config.menu?.title ?? config.title,
|
|
34
|
-
order: config.menu?.order
|
|
34
|
+
order: config.menu?.order,
|
|
35
|
+
detail: config.detail
|
|
35
36
|
})).sort((menuA, menuB) => {
|
|
36
37
|
const ordersDiff = (menuA.order ?? Number.MAX_VALUE) - (menuB.order ?? Number.MAX_VALUE);
|
|
37
38
|
return ordersDiff !== 0 ? ordersDiff : collator.compare(menuA.to, menuB.to);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"mappings":"AACA,SAAsB,2CAA4C;AAIlE,OAAO,MAAMA,cAAkF,OAC5F,OAAwB,QAAQ,MAClC;AAED,SAAS,WAAWC,OAA4B;AAC9C,UAAS,MAAM,MAAM;AACtB;AAED,SAAS,uBAAuBC,MAAuB;AACrD,QAAO,KAAK,MAAM,IAAI,CAAC,KAAK,CAAC,YAAY,QAAQ,WAAW,IAAI,CAAC;AAClE;;;;;;;;;AAUD,OAAO,SAAS,
|
|
1
|
+
{"mappings":"AACA,SAAsB,2CAA4C;AAIlE,OAAO,MAAMA,cAAkF,OAC5F,OAAwB,QAAQ,MAClC;AAED,SAAS,WAAWC,OAA4B;AAC9C,UAAS,MAAM,MAAM;AACtB;AAED,SAAS,uBAAuBC,MAAuB;AACrD,QAAO,KAAK,MAAM,IAAI,CAAC,KAAK,CAAC,YAAY,QAAQ,WAAW,IAAI,CAAC;AAClE;;;;;;;;;AAUD,OAAO,SAAS,kBAA2D;AAGzE,EAAC,CAAC,SAAS,YAAa,OAAO,WAAW,CAAE,MAAM;AAClD,YAAU,kBAAkB,CAAE;AAC9B,YAAU,cAAc,KAAK;GAC3B,IAAI,WAAW,4BAA4B,QAAQ,IAAI;GACvD,SAAS;EACV,EAAC;CACH,GAAE,mBAAoB,OAAwB,OAAO;CACpD,MAAM,WAAW,IAAI,KAAK,SAAS;AACnC,MAAK,YAAY,OAAO;AACtB,SAAO,CAAE;CACV;CAED,MAAM,QAAQ,OAAO,QAAQ,YAAY,MAAM;AAE/C,QACE,MAEG,OAAO,CAAC,CAAC,MAAM,MAAM,MAAM,WAAW,MAAM,KAAK,uBAAuB,KAAK,CAAC,CAE9E,IAAI,CAAC,CAAC,MAAM,OAAO,MAAM;EACxB,IAAI;EACJ,MAAM,OAAO,MAAM;EACnB,OAAO,OAAO,MAAM,SAAS,OAAO;EACpC,OAAO,OAAO,MAAM;EACpB,QAAQ,OAAO;CAChB,GAAE,CAEF,KAAK,CAAC,OAAO,UAAU;EACtB,MAAM,cAAc,MAAM,SAAS,OAAO,cAAc,MAAM,SAAS,OAAO;AAC9E,SAAO,eAAe,IAAI,aAAa,SAAS,QAAQ,MAAM,IAAI,MAAM,GAAG;CAC5E,EAAC;AAEP;AAED,IAAI,OAAO,KAAK,KAAK;AACnB,QAAO,KAAK,IAAI,GAAG,mBAAmB,MAAM;AAC1C,QAAM,iBAAiB,CACpB,KAAK,OAAO,SAAS,KAAK,MAAM,CAAC,CACjC,KAAK,CAAC,SAAS;AACd,eAAY,QAAQ;EACrB,EAAC,CACD,MAAM,CAACC,MAAe;AACrB,WAAQ,MAAM,8BAA8B,EAAE;EAC/C,EAAC;CACL,EAAC;AACH","names":["viewsSignal: Signal<Readonly<Record<string, Readonly<ViewConfig>>> | undefined>","value: ViewConfig","path: string","e: unknown"],"sources":["/opt/agent/work/1af72d8adc613024/hilla/packages/ts/file-router/src/runtime/createMenuItems.ts"],"sourcesContent":["/// <reference types=\"vite/client\" />\nimport { type Signal, signal } from '@vaadin/hilla-react-signals';\nimport type { VaadinWindow } from '../shared/internal.js';\nimport type { MenuItem, ViewConfig } from '../types.js';\n\nexport const viewsSignal: Signal<Readonly<Record<string, Readonly<ViewConfig>>> | undefined> = signal(\n (window as VaadinWindow).Vaadin?.views,\n);\n\nfunction isExcluded(value: ViewConfig): boolean {\n return !!value.menu?.exclude;\n}\n\nfunction hasVariablePathSegment(path: string): boolean {\n return path.split('/').some((segment) => segment.startsWith(':'));\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}, filtered out if they are explicitly excluded via {@link ViewConfig.menu.exclude}.\n * Note that views with no order are put below views with an order. Ties are resolved based on the path string\n * comparison.\n *\n * @returns A list of menu items.\n */\nexport function createMenuItems<T = unknown>(): ReadonlyArray<MenuItem<T>> {\n // @ts-expect-error: esbuild injection\n // eslint-disable-next-line @typescript-eslint/no-unsafe-call\n ((feature, vaadinObj = (window.Vaadin ??= {})) => {\n vaadinObj.registrations ??= [];\n vaadinObj.registrations.push({\n is: feature ? `@vaadin/hilla-file-router/${feature}` : '@vaadin/hilla-file-router',\n version: '24.8.0-alpha6',\n });\n})('createMenuItems', (window as VaadinWindow).Vaadin);\n const collator = new Intl.Collator('en-US');\n if (!viewsSignal.value) {\n return [];\n }\n\n const views = Object.entries(viewsSignal.value);\n\n return (\n views\n // Filter out the views that are explicitly excluded from the menu.\n .filter(([path, value]) => !isExcluded(value) && !hasVariablePathSegment(path))\n // Map the views to menu items.\n .map(([path, config]) => ({\n to: path,\n icon: config.menu?.icon,\n title: config.menu?.title ?? config.title,\n order: config.menu?.order,\n detail: config.detail as T | undefined,\n }))\n // Sort views according to the order specified in the view configuration.\n .sort((menuA, menuB) => {\n const ordersDiff = (menuA.order ?? Number.MAX_VALUE) - (menuB.order ?? Number.MAX_VALUE);\n return ordersDiff !== 0 ? ordersDiff : collator.compare(menuA.to, menuB.to);\n })\n );\n}\n\nif (import.meta.hot) {\n import.meta.hot.on('fs-route-update', () => {\n fetch('?v-r=routeinfo')\n .then(async (resp) => resp.json())\n .then((json) => {\n viewsSignal.value = json;\n })\n .catch((e: unknown) => {\n console.error('Failed to fetch route info', e);\n });\n });\n}\n"],"version":3}
|
package/shared/internal.d.ts
CHANGED
|
@@ -4,10 +4,10 @@ import type { RouteParamType } from "./routeParamType.js";
|
|
|
4
4
|
* Internal type used for server communication and menu building. It extends the
|
|
5
5
|
* view configuration with the route parameters.
|
|
6
6
|
*/
|
|
7
|
-
export type ServerViewConfig = Readonly<{
|
|
7
|
+
export type ServerViewConfig<T = unknown> = Readonly<{
|
|
8
8
|
children?: readonly ServerViewConfig[]
|
|
9
9
|
params?: Readonly<Record<string, RouteParamType>>
|
|
10
|
-
}> & ViewConfig
|
|
10
|
+
}> & ViewConfig<T>;
|
|
11
11
|
export type VaadinObject = Readonly<{
|
|
12
12
|
views: Readonly<Record<string, ViewConfig>>
|
|
13
13
|
}>;
|
package/types.d.ts
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
import type { createBrowserRouter, RouteObject } from "react-router";
|
|
2
|
-
|
|
2
|
+
/**
|
|
3
|
+
* A configuration object for a view. This is used to define the view's
|
|
4
|
+
* metadata, such as the title, roles allowed, and other properties.
|
|
5
|
+
*
|
|
6
|
+
* @typeParam T - The type of the detail object.
|
|
7
|
+
*/
|
|
8
|
+
export type ViewConfig<T = unknown> = Readonly<{
|
|
3
9
|
/**
|
|
4
10
|
* View title used in the main layout header, as <title> and as the default
|
|
5
11
|
* for the menu entry. If not defined, the component name will be taken,
|
|
@@ -51,6 +57,13 @@ export type ViewConfig = Readonly<{
|
|
|
51
57
|
*/
|
|
52
58
|
icon?: string
|
|
53
59
|
}>
|
|
60
|
+
/**
|
|
61
|
+
* Used to add additional properties to the view. This object will be
|
|
62
|
+
* available when building the menu.
|
|
63
|
+
*
|
|
64
|
+
* @see {@link ./runtime/createMenuItems.ts#createMenuItems}
|
|
65
|
+
*/
|
|
66
|
+
detail?: T
|
|
54
67
|
}>;
|
|
55
68
|
/**
|
|
56
69
|
* An unknown JavaScript module.
|
|
@@ -74,11 +87,14 @@ export type AgnosticRoute = Readonly<{
|
|
|
74
87
|
}>;
|
|
75
88
|
/**
|
|
76
89
|
* A menu item used in for building the navigation menu.
|
|
90
|
+
*
|
|
91
|
+
* @typeParam T - The type of the detail object, same as in the view configuration.
|
|
77
92
|
*/
|
|
78
|
-
export type MenuItem = Readonly<{
|
|
93
|
+
export type MenuItem<T = unknown> = Readonly<{
|
|
79
94
|
to: string
|
|
80
95
|
icon?: string
|
|
81
96
|
title?: string
|
|
97
|
+
detail?: T
|
|
82
98
|
}>;
|
|
83
99
|
export type RouterConfiguration = Readonly<{
|
|
84
100
|
routes: readonly RouteObject[]
|