@plumile/router 0.1.11 → 0.1.12
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/README.md +342 -1
- package/lib/esm/builder.d.ts.map +1 -1
- package/lib/esm/builder.js +10 -3
- package/lib/esm/eslint-rules/index.d.ts +2 -0
- package/lib/esm/eslint-rules/index.d.ts.map +1 -0
- package/lib/esm/eslint-rules/index.js +2 -0
- package/lib/esm/eslint-rules/no-direct-window-location-search.d.ts +4 -0
- package/lib/esm/eslint-rules/no-direct-window-location-search.d.ts.map +1 -0
- package/lib/esm/eslint-rules/no-direct-window-location-search.js +48 -0
- package/lib/esm/history/BrowserHistory.d.ts.map +1 -1
- package/lib/esm/history/BrowserHistory.js +4 -2
- package/lib/esm/index.d.ts +1 -0
- package/lib/esm/index.d.ts.map +1 -1
- package/lib/esm/index.js +2 -1
- package/lib/esm/routing/Link.d.ts +1 -0
- package/lib/esm/routing/Link.d.ts.map +1 -1
- package/lib/esm/routing/Link.js +35 -4
- package/lib/esm/routing/RouteComponentWrapper.d.ts.map +1 -1
- package/lib/esm/routing/RouteComponentWrapper.js +7 -2
- package/lib/esm/routing/createRouter.d.ts +7 -1
- package/lib/esm/routing/createRouter.d.ts.map +1 -1
- package/lib/esm/routing/createRouter.js +494 -11
- package/lib/esm/routing/index.d.ts +4 -0
- package/lib/esm/routing/index.d.ts.map +1 -1
- package/lib/esm/routing/index.js +5 -1
- package/lib/esm/routing/useNavigate.d.ts +6 -0
- package/lib/esm/routing/useNavigate.d.ts.map +1 -0
- package/lib/esm/routing/useNavigate.js +11 -0
- package/lib/esm/routing/useQuery.d.ts +2 -0
- package/lib/esm/routing/useQuery.d.ts.map +1 -0
- package/lib/esm/routing/useQuery.js +9 -0
- package/lib/esm/routing/useQueryState.d.ts +13 -0
- package/lib/esm/routing/useQueryState.d.ts.map +1 -0
- package/lib/esm/routing/useQueryState.js +80 -0
- package/lib/esm/routing/useTypedQuery.d.ts +2 -0
- package/lib/esm/routing/useTypedQuery.d.ts.map +1 -0
- package/lib/esm/routing/useTypedQuery.js +36 -0
- package/lib/esm/tools/buildSearch.d.ts +6 -0
- package/lib/esm/tools/buildSearch.d.ts.map +1 -0
- package/lib/esm/tools/buildSearch.js +60 -0
- package/lib/esm/tools/query-dsl.d.ts +28 -0
- package/lib/esm/tools/query-dsl.d.ts.map +1 -0
- package/lib/esm/tools/query-dsl.js +250 -0
- package/lib/esm/tools/query.d.ts +2 -0
- package/lib/esm/tools/query.d.ts.map +1 -0
- package/lib/esm/tools/query.js +43 -0
- package/lib/esm/tools.d.ts +2 -2
- package/lib/esm/tools.d.ts.map +1 -1
- package/lib/esm/tools.js +3 -2
- package/lib/esm/type-tests/query-infer.test-d.d.ts +2 -0
- package/lib/esm/type-tests/query-infer.test-d.d.ts.map +1 -0
- package/lib/esm/type-tests/query-infer.test-d.js +49 -0
- package/lib/esm/types.d.ts +28 -4
- package/lib/esm/types.d.ts.map +1 -1
- package/lib/esm/types.js +1 -1
- package/lib/tsconfig.esm.tsbuildinfo +1 -1
- package/lib/types/builder.d.ts.map +1 -1
- package/lib/types/eslint-rules/index.d.ts +2 -0
- package/lib/types/eslint-rules/index.d.ts.map +1 -0
- package/lib/types/eslint-rules/no-direct-window-location-search.d.ts +4 -0
- package/lib/types/eslint-rules/no-direct-window-location-search.d.ts.map +1 -0
- package/lib/types/history/BrowserHistory.d.ts.map +1 -1
- package/lib/types/index.d.ts +1 -0
- package/lib/types/index.d.ts.map +1 -1
- package/lib/types/routing/Link.d.ts +1 -0
- package/lib/types/routing/Link.d.ts.map +1 -1
- package/lib/types/routing/RouteComponentWrapper.d.ts.map +1 -1
- package/lib/types/routing/createRouter.d.ts +7 -1
- package/lib/types/routing/createRouter.d.ts.map +1 -1
- package/lib/types/routing/index.d.ts +4 -0
- package/lib/types/routing/index.d.ts.map +1 -1
- package/lib/types/routing/useNavigate.d.ts +6 -0
- package/lib/types/routing/useNavigate.d.ts.map +1 -0
- package/lib/types/routing/useQuery.d.ts +2 -0
- package/lib/types/routing/useQuery.d.ts.map +1 -0
- package/lib/types/routing/useQueryState.d.ts +13 -0
- package/lib/types/routing/useQueryState.d.ts.map +1 -0
- package/lib/types/routing/useTypedQuery.d.ts +2 -0
- package/lib/types/routing/useTypedQuery.d.ts.map +1 -0
- package/lib/types/tools/buildSearch.d.ts +6 -0
- package/lib/types/tools/buildSearch.d.ts.map +1 -0
- package/lib/types/tools/query-dsl.d.ts +28 -0
- package/lib/types/tools/query-dsl.d.ts.map +1 -0
- package/lib/types/tools/query.d.ts +2 -0
- package/lib/types/tools/query.d.ts.map +1 -0
- package/lib/types/tools.d.ts +2 -2
- package/lib/types/tools.d.ts.map +1 -1
- package/lib/types/type-tests/query-infer.test-d.d.ts +2 -0
- package/lib/types/type-tests/query-infer.test-d.d.ts.map +1 -0
- package/lib/types/types.d.ts +28 -4
- package/lib/types/types.d.ts.map +1 -1
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -111,13 +111,15 @@ function Navigation() {
|
|
|
111
111
|
|
|
112
112
|
### Core Components
|
|
113
113
|
|
|
114
|
-
#### `createRouter(routes: Route[])`
|
|
114
|
+
#### `createRouter(routes: Route[], options?)`
|
|
115
115
|
|
|
116
116
|
Creates a router instance with the given route configuration.
|
|
117
117
|
|
|
118
118
|
**Parameters:**
|
|
119
119
|
|
|
120
120
|
- `routes`: Array of route definitions
|
|
121
|
+
- `options?`: Optional object
|
|
122
|
+
- `devtools?: boolean` Force enable/disable the global inspector. Defaults to enabled when `NODE_ENV !== 'production'`, disabled otherwise.
|
|
121
123
|
|
|
122
124
|
**Returns:**
|
|
123
125
|
|
|
@@ -228,6 +230,345 @@ Type helper for strongly-typed route definitions.
|
|
|
228
230
|
|
|
229
231
|
## Advanced Usage
|
|
230
232
|
|
|
233
|
+
### Typed Query Parameters (DSL)
|
|
234
|
+
|
|
235
|
+
The router provides a lightweight schema DSL for parsing, typing, normalizing and serializing query strings.
|
|
236
|
+
|
|
237
|
+
#### 1. Define a schema on the deepest route
|
|
238
|
+
|
|
239
|
+
```ts
|
|
240
|
+
import { q, r } from '@plumile/router';
|
|
241
|
+
|
|
242
|
+
const routes = [
|
|
243
|
+
r({
|
|
244
|
+
path: '/items',
|
|
245
|
+
// Schema: page = number (default 1), tag(s) = array of strings, flag = optional boolean
|
|
246
|
+
query: {
|
|
247
|
+
page: q.default(q.number(), 1),
|
|
248
|
+
tags: q.array(q.string()),
|
|
249
|
+
flag: q.optional(q.boolean()),
|
|
250
|
+
},
|
|
251
|
+
prepare: ({ query }) => {
|
|
252
|
+
// query is typed: { page: number; tags: string[]; flag?: boolean }
|
|
253
|
+
return { page: query.page };
|
|
254
|
+
},
|
|
255
|
+
render: () => null,
|
|
256
|
+
}),
|
|
257
|
+
];
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
#### 2. Access parsed & typed queries
|
|
261
|
+
|
|
262
|
+
```tsx
|
|
263
|
+
import { useQuery, useTypedQuery } from '@plumile/router';
|
|
264
|
+
|
|
265
|
+
function List() {
|
|
266
|
+
const raw = useQuery(); // Record<string, string | string[]>
|
|
267
|
+
const typed = useTypedQuery(); // Auto‑inferred from deepest route schema (no generic needed)
|
|
268
|
+
const [page, setPage] = useQueryState<number>('page'); // Bidirectional state ↔ URL for one param
|
|
269
|
+
return <pre>{JSON.stringify({ raw, typed }, null, 2)}</pre>;
|
|
270
|
+
}
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
Referential stability: both `raw` (from `useQuery()`) and `typed` (from `useTypedQuery()`) are memoized per canonical search string. If the URL search part doesn't change semantically (including key order canonicalization), the hook returns the exact same object reference. You can safely list either in React dependency arrays without extra `useMemo` or a hypothetical `useStableQuery` helper (not needed).
|
|
274
|
+
|
|
275
|
+
Type inference:
|
|
276
|
+
|
|
277
|
+
- If the matched deepest route has a `query` schema, `useTypedQuery()` returns the inferred `InferQuery<typeof schema>` shape automatically.
|
|
278
|
+
- If no schema exists, it returns the raw parsed object (record of string | string[]) so you can still read values safely.
|
|
279
|
+
- You can still supply a generic manually (`useTypedQuery<MyShape>()`) in edge cases (e.g. incremental migration) but it is usually unnecessary now.
|
|
280
|
+
|
|
281
|
+
#### 3. Programmatic navigation with typed query
|
|
282
|
+
|
|
283
|
+
```tsx
|
|
284
|
+
import { useNavigate } from '@plumile/router';
|
|
285
|
+
|
|
286
|
+
function Pager({ page }: { page: number }) {
|
|
287
|
+
const navigate = useNavigate();
|
|
288
|
+
return (
|
|
289
|
+
<button
|
|
290
|
+
onClick={() => {
|
|
291
|
+
navigate({ query: { page: page + 1 } });
|
|
292
|
+
}}
|
|
293
|
+
>
|
|
294
|
+
Next page
|
|
295
|
+
</button>
|
|
296
|
+
);
|
|
297
|
+
}
|
|
298
|
+
```
|
|
299
|
+
|
|
300
|
+
#### 4. Link component with query
|
|
301
|
+
|
|
302
|
+
```tsx
|
|
303
|
+
import { Link } from '@plumile/router';
|
|
304
|
+
|
|
305
|
+
<Link to="/items" query={{ page: 2, tags: ['a', 'b'], flag: true }}>
|
|
306
|
+
Filter
|
|
307
|
+
</Link>;
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
`Link` & `navigate` automatically serialize using the route schema, applying:
|
|
311
|
+
|
|
312
|
+
- Schema key order
|
|
313
|
+
- Array repetition (`?tags=a&tags=b`)
|
|
314
|
+
- Omission of default values when `omitDefaults` optimization applies internally
|
|
315
|
+
|
|
316
|
+
#### 5. Normalization
|
|
317
|
+
|
|
318
|
+
Built‑in simple normalization currently clamps `page < 1` to `1` and issues a `replaceState` to avoid polluting history.
|
|
319
|
+
|
|
320
|
+
#### 6. Serialization utility
|
|
321
|
+
|
|
322
|
+
```ts
|
|
323
|
+
import { buildSearch, q } from '@plumile/router';
|
|
324
|
+
|
|
325
|
+
const schema = {
|
|
326
|
+
page: q.default(q.number(), 1),
|
|
327
|
+
tag: q.array(q.string()),
|
|
328
|
+
} as const;
|
|
329
|
+
const search = buildSearch({ page: 1, tag: ['x', 'y'] }, schema, {
|
|
330
|
+
omitDefaults: true,
|
|
331
|
+
});
|
|
332
|
+
// => '?tag=x&tag=y'
|
|
333
|
+
```
|
|
334
|
+
|
|
335
|
+
#### 7. Parsing utility / alias
|
|
336
|
+
|
|
337
|
+
```ts
|
|
338
|
+
import { parseSearch, q } from '@plumile/router';
|
|
339
|
+
|
|
340
|
+
const schema = { flag: q.boolean() } as const;
|
|
341
|
+
const typed = parseSearch(schema, '?flag=1'); // { flag: true }
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
#### 8. Performance and stability
|
|
345
|
+
|
|
346
|
+
There are two coordinated caching layers:
|
|
347
|
+
|
|
348
|
+
1. Raw query cache: A process-wide Map keyed by a canonicalized search string (sorted keys, ordered value emission). Produces a frozen empty object for the empty search and reuses prior parsed objects, yielding stable references for unchanged search state.
|
|
349
|
+
2. Typed query cache: A WeakMap keyed by (schema reference → canonical search signature) that parses once and reuses the typed value. Structural deep-equality canonicalization means semantically equivalent searches (e.g. reordered keys) reuse object identity.
|
|
350
|
+
|
|
351
|
+
Effects:
|
|
352
|
+
|
|
353
|
+
- Stable object identity for both raw and typed queries eliminates needless renders and removes the need for an extra `useStableQuery` hook.
|
|
354
|
+
- Safe to put `useQuery()` / `useTypedQuery()` results directly in dependency arrays (`useEffect`, `useMemo`, selectors, etc.).
|
|
355
|
+
- Empty query allocations are avoided (shared frozen object).
|
|
356
|
+
|
|
357
|
+
Guideline: If you need to derive lightweight projections (e.g. `const { page } = typed`), you can still destructure; but avoid spreading into a new object if you rely on reference equality downstream.
|
|
358
|
+
|
|
359
|
+
#### Devtools / Inspection
|
|
360
|
+
|
|
361
|
+
In development (`NODE_ENV !== 'production'` by default, or when `createRouter(..., { devtools: true })` is passed), the router exposes a lightweight global inspector.
|
|
362
|
+
|
|
363
|
+
Optionally you can enable an in‑page overlay panel for quick visual inspection:
|
|
364
|
+
|
|
365
|
+
```ts
|
|
366
|
+
createRouter(routes, {
|
|
367
|
+
devtools: { panel: true, global: true, shortcut: 'Alt+Shift+R' },
|
|
368
|
+
});
|
|
369
|
+
```
|
|
370
|
+
|
|
371
|
+
Devtools option forms:
|
|
372
|
+
|
|
373
|
+
- `devtools: true | false` (boolean) – legacy form, controls global only.
|
|
374
|
+
- `devtools: { global?: boolean; panel?: boolean; shortcut?: string }` – granular.
|
|
375
|
+
- `global` (default: NODE_ENV !== 'production') exposes `window.__PLUMILE_ROUTER__`.
|
|
376
|
+
- `panel` (default: false) mounts an overlay; closed with the close button or page reload.
|
|
377
|
+
- `shortcut` (default: `Alt+Shift+R`) toggles panel visibility.
|
|
378
|
+
|
|
379
|
+
The panel displays current path+search, variables, raw query and typed query. It is intentionally framework‑agnostic (no React runtime cost) and uses a shadow root to minimize style collisions.
|
|
380
|
+
|
|
381
|
+
```js
|
|
382
|
+
window.__PLUMILE_ROUTER__.get(); // current RouteEntry
|
|
383
|
+
const unsub = window.__PLUMILE_ROUTER__.subscribe((entry) =>
|
|
384
|
+
console.log(entry.typedQuery),
|
|
385
|
+
);
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
This lets you introspect parsed queries & variables without adding debug code. Neither global nor panel is present in production unless explicitly forced with `devtools: { global: true, panel: true }` (discouraged).
|
|
389
|
+
|
|
390
|
+
##### Detailed Usage
|
|
391
|
+
|
|
392
|
+
The global is intentionally tiny to avoid coupling and bundle weight. It only appears when the devtools flag resolves truthy:
|
|
393
|
+
|
|
394
|
+
1. Explicit: `createRouter(routes, { devtools: true })`
|
|
395
|
+
2. Implicit heuristic: `NODE_ENV !== 'production'`
|
|
396
|
+
3. Disabled explicitly: `createRouter(routes, { devtools: false })`
|
|
397
|
+
|
|
398
|
+
Always guard in snippets that might be copied to production code:
|
|
399
|
+
|
|
400
|
+
```js
|
|
401
|
+
if (window.__PLUMILE_ROUTER__) {
|
|
402
|
+
console.log(window.__PLUMILE_ROUTER__.get());
|
|
403
|
+
}
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
`get()` returns the current `RouteEntry` (simplified shape):
|
|
407
|
+
|
|
408
|
+
```ts
|
|
409
|
+
type RouteEntry = {
|
|
410
|
+
location: Location; // window.location snapshot
|
|
411
|
+
route: { match; params; path } | null; // current matched route (or null)
|
|
412
|
+
preparedMatch: { routes: { prepared; render?; resourcePage? }[]; match }; // internal prepared tree
|
|
413
|
+
forceRerender: boolean; // indicates forced re-render situations
|
|
414
|
+
rawSearch: string; // '?page=2&tag=a'
|
|
415
|
+
query: Record<string, string | string[]>; // raw aggregated query params
|
|
416
|
+
typedQuery: any; // typed query if schema present
|
|
417
|
+
};
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
Common console patterns:
|
|
421
|
+
|
|
422
|
+
1. Log every navigation with typed query & params:
|
|
423
|
+
|
|
424
|
+
```js
|
|
425
|
+
const dev = window.__PLUMILE_ROUTER__;
|
|
426
|
+
if (dev) {
|
|
427
|
+
const off = dev.subscribe((e) => {
|
|
428
|
+
console.log('[router]', e.location.pathname + e.location.search, {
|
|
429
|
+
vars: e.route?.params,
|
|
430
|
+
typed: e.typedQuery,
|
|
431
|
+
});
|
|
432
|
+
});
|
|
433
|
+
// later: off();
|
|
434
|
+
}
|
|
435
|
+
```
|
|
436
|
+
|
|
437
|
+
2. Inspect prepared data for the deepest route (last element):
|
|
438
|
+
|
|
439
|
+
```js
|
|
440
|
+
const entry = window.__PLUMILE_ROUTER__?.get();
|
|
441
|
+
const deepest = entry?.preparedMatch.routes.at(-1);
|
|
442
|
+
deepest?.prepared; // Prepared data returned by deepest prepare()
|
|
443
|
+
```
|
|
444
|
+
|
|
445
|
+
3. Quick diff watcher for query changes only:
|
|
446
|
+
|
|
447
|
+
```js
|
|
448
|
+
let last = window.__PLUMILE_ROUTER__?.get().rawSearch;
|
|
449
|
+
const off = window.__PLUMILE_ROUTER__?.subscribe((e) => {
|
|
450
|
+
if (e.rawSearch !== last) {
|
|
451
|
+
console.log('query changed', last, '=>', e.rawSearch, e.typedQuery);
|
|
452
|
+
last = e.rawSearch;
|
|
453
|
+
}
|
|
454
|
+
});
|
|
455
|
+
```
|
|
456
|
+
|
|
457
|
+
4. Measuring parse performance (rough dev-only micro‑benchmark):
|
|
458
|
+
|
|
459
|
+
```js
|
|
460
|
+
const { get } = window.__PLUMILE_ROUTER__;
|
|
461
|
+
const before = performance.now();
|
|
462
|
+
for (let i = 0; i < 200; i++) get().typedQuery; // use cache; ensures no GC
|
|
463
|
+
console.log('elapsed ms', performance.now() - before);
|
|
464
|
+
```
|
|
465
|
+
|
|
466
|
+
5. Safe optional chaining helper (copy/paste):
|
|
467
|
+
|
|
468
|
+
```js
|
|
469
|
+
const R = window.__PLUMILE_ROUTER__;
|
|
470
|
+
R && R.subscribe((e) => console.debug('[typedQuery]', e.typedQuery));
|
|
471
|
+
```
|
|
472
|
+
|
|
473
|
+
Unsubscribing: every `subscribe` returns a disposer function. Always call it if you set up long‑lived listeners in a debugging session to avoid memory leaks during hot reloads.
|
|
474
|
+
|
|
475
|
+
Extending: if you need more (e.g. trigger navigations) you can wrap `createRouter` in your app and attach additional methods to `window.__PLUMILE_ROUTER__` (e.g. `navigate: context.navigate`) — omitted by default to avoid accidental production reliance.
|
|
476
|
+
|
|
477
|
+
Production: the symbol is not defined; accessing it will yield `undefined`. Never ship logic depending on it; keep usage inside `if (process.env.NODE_ENV !== 'production')` blocks or guarded optional checks.
|
|
478
|
+
|
|
479
|
+
### ESLint Rule: no-direct-window-location-search
|
|
480
|
+
|
|
481
|
+
To encourage consistent usage of the query hooks, a custom rule is provided inside the router package to flag raw `window.location.search` access.
|
|
482
|
+
|
|
483
|
+
Add to your flat ESLint config:
|
|
484
|
+
|
|
485
|
+
```js
|
|
486
|
+
import noDirectWindowLocationSearch from '@plumile/router/lib/eslint-rules/no-direct-window-location-search.js';
|
|
487
|
+
|
|
488
|
+
export default [
|
|
489
|
+
{
|
|
490
|
+
plugins: {
|
|
491
|
+
'@plumile-router/dx': {
|
|
492
|
+
rules: {
|
|
493
|
+
'no-direct-window-location-search': noDirectWindowLocationSearch,
|
|
494
|
+
},
|
|
495
|
+
},
|
|
496
|
+
},
|
|
497
|
+
rules: {
|
|
498
|
+
'@plumile-router/dx/no-direct-window-location-search': 'warn',
|
|
499
|
+
},
|
|
500
|
+
},
|
|
501
|
+
];
|
|
502
|
+
```
|
|
503
|
+
|
|
504
|
+
Optional configuration:
|
|
505
|
+
|
|
506
|
+
```js
|
|
507
|
+
// allow some files (e.g. legacy bootstrap) to keep direct access
|
|
508
|
+
rules: {
|
|
509
|
+
'@plumile-router/dx/no-direct-window-location-search': [
|
|
510
|
+
'warn',
|
|
511
|
+
{ allowInFiles: ['legacy-entry.ts'] },
|
|
512
|
+
],
|
|
513
|
+
},
|
|
514
|
+
```
|
|
515
|
+
|
|
516
|
+
When triggered, replace patterns like:
|
|
517
|
+
|
|
518
|
+
```ts
|
|
519
|
+
const qs = window.location.search;
|
|
520
|
+
```
|
|
521
|
+
|
|
522
|
+
with:
|
|
523
|
+
|
|
524
|
+
```ts
|
|
525
|
+
const query = useQuery(); // or useTypedQuery()
|
|
526
|
+
```
|
|
527
|
+
|
|
528
|
+
### Migration Guide (Phases 1 → 5)
|
|
529
|
+
|
|
530
|
+
1. Phase 1/2: Upgrade — no schema needed. Use `useQuery()` for raw params.
|
|
531
|
+
2. Phase 3: Add `query` schema to your deepest route; adopt `useTypedQuery()` where type safety is desirable.
|
|
532
|
+
3. Phase 4: Replace manual URL building with `navigate({ query })` or `<Link query={...} />`. Remove ad‑hoc serialization logic.
|
|
533
|
+
4. Phase 5: Move lightweight data loading logic that depends on query into `prepare({ query })` (now typed). Rely on built‑in normalization (e.g. page clamp) or add custom normalization inside `prepare` followed by a `navigate({ replace: true, query: normalized })` if needed.
|
|
534
|
+
5. Optional: Use `buildSearch` / `parseSearch` for unit tests & utilities.
|
|
535
|
+
|
|
536
|
+
### Query Descriptor Reference
|
|
537
|
+
|
|
538
|
+
| Descriptor | Description | Serialize Example |
|
|
539
|
+
| -------------------------------- | --------------------------------------------------- | ------------------------------------ |
|
|
540
|
+
| `q.string()` | Last occurrence string | `{ q: 'x' } -> ?q=x` |
|
|
541
|
+
| `q.number()` | Number (invalid => undefined) | `{ n: 2 } -> ?n=2` |
|
|
542
|
+
| `q.boolean()` | Presence / true/false/1/0 | `{ f: true } -> ?f=1` |
|
|
543
|
+
| `q.enum('a','b')` | Restricted string | `{ e: 'a' } -> ?e=a` |
|
|
544
|
+
| `q.array(inner)` | Repeated key multi-values | `{ tag: ['x','y'] } -> ?tag=x&tag=y` |
|
|
545
|
+
| `q.optional(d)` | Marks descriptor optional | omitted if undefined |
|
|
546
|
+
| `q.default(d, v)` | Supplies default + omit on serialize (omitDefaults) | default skipped |
|
|
547
|
+
| `q.emptyAsUndefined(q.string())` | Maps empty string '' to undefined | omitted |
|
|
548
|
+
| `q.custom({ parse, serialize })` | Custom parse/serialize logic | depends |
|
|
549
|
+
|
|
550
|
+
Custom: `q.custom({ parse(values), serialize(value) })` lets you wire bespoke formats. Ensure `serialize` outputs an array of raw string values. Use sparingly to keep schemas readable.
|
|
551
|
+
|
|
552
|
+
### useQueryState Hook
|
|
553
|
+
|
|
554
|
+
`useQueryState(key, opts?)` creates a controlled binding between a single query parameter and component state.
|
|
555
|
+
|
|
556
|
+
```tsx
|
|
557
|
+
const [page, setPage] = useQueryState<number>('page');
|
|
558
|
+
// Increment page without pushing a new history entry
|
|
559
|
+
setPage(page! + 1, { replace: true });
|
|
560
|
+
```
|
|
561
|
+
|
|
562
|
+
Behavior:
|
|
563
|
+
|
|
564
|
+
- Reads from typedQuery if schema present, else raw query.
|
|
565
|
+
- Respects schema defaults (and `defaultValue` override in options) and omits key when value equals default (with `omitIfDefault: true`).
|
|
566
|
+
- Pass `{ raw: true }` to force raw (string) source for incremental migrations.
|
|
567
|
+
- Uses existing navigation serialization (ordering, omit defaults, arrays).
|
|
568
|
+
|
|
569
|
+
Options:
|
|
570
|
+
`{ defaultValue?, omitIfDefault?: boolean = true, replace?: boolean, raw?: boolean }`
|
|
571
|
+
|
|
231
572
|
### Data Preloading
|
|
232
573
|
|
|
233
574
|
```typescript
|
package/lib/esm/builder.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../../src/builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,KAAK,aAAa,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3E,OAAO,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAQlE,qBAAa,SAAS,CAAC,OAAO,SAAS,SAAS;IAEvC,IAAI,EAAE,MAAM,CAAC;IAGb,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;IAG1B,aAAa,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;IAGtC,UAAU,CAAC,EAAE,MAAM,CAAC;gBAOR,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC;CAOlD;AAQD,wBAAgB,UAAU,CACxB,KAAK,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,QAAQ,GAChC,KAAK,IAAI,QAAQ,CAGnB;AAYD,wBAAgB,UAAU,CACxB,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,QAAQ,CAAC,EAAE,EAC3C,YAAY,GAAE,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,EAAO,EACpC,MAAM,SAAK,GACV,SAAS,CAAC,GAAG,CAAC,EAAE,
|
|
1
|
+
{"version":3,"file":"builder.d.ts","sourceRoot":"","sources":["../../src/builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,KAAK,aAAa,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3E,OAAO,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAQlE,qBAAa,SAAS,CAAC,OAAO,SAAS,SAAS;IAEvC,IAAI,EAAE,MAAM,CAAC;IAGb,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC;IAG1B,aAAa,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;IAGtC,UAAU,CAAC,EAAE,MAAM,CAAC;gBAOR,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC;CAOlD;AAQD,wBAAgB,UAAU,CACxB,KAAK,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,QAAQ,GAChC,KAAK,IAAI,QAAQ,CAGnB;AAYD,wBAAgB,UAAU,CACxB,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,QAAQ,CAAC,EAAE,EAC3C,YAAY,GAAE,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,EAAO,EACpC,MAAM,SAAK,GACV,SAAS,CAAC,GAAG,CAAC,EAAE,CA8DlB;AASD,wBAAgB,WAAW,CAAC,WAAW,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,EAAE,CAE5E"}
|
package/lib/esm/builder.js
CHANGED
|
@@ -23,7 +23,11 @@ export function buildRoute(routeConfig, parentRoutes = [], prefix = '') {
|
|
|
23
23
|
parts.push(prefix);
|
|
24
24
|
}
|
|
25
25
|
if (route.path != null && route.path !== '' && route.path !== '/') {
|
|
26
|
-
|
|
26
|
+
let normalized = route.path;
|
|
27
|
+
if (normalized.startsWith('/')) {
|
|
28
|
+
normalized = normalized.slice(1);
|
|
29
|
+
}
|
|
30
|
+
parts.push(normalized);
|
|
27
31
|
}
|
|
28
32
|
const newPath = parts.join('/');
|
|
29
33
|
const { children } = route;
|
|
@@ -35,7 +39,10 @@ export function buildRoute(routeConfig, parentRoutes = [], prefix = '') {
|
|
|
35
39
|
const matchFunction = match(`/${newPath}`, {
|
|
36
40
|
trailing: false,
|
|
37
41
|
});
|
|
38
|
-
|
|
42
|
+
let path = newPath;
|
|
43
|
+
if (!newPath.startsWith('/')) {
|
|
44
|
+
path = `/${newPath}`;
|
|
45
|
+
}
|
|
39
46
|
if (isRedirect(route)) {
|
|
40
47
|
let redirectTo = route.to;
|
|
41
48
|
if (!redirectTo.startsWith('/')) {
|
|
@@ -61,4 +68,4 @@ export function buildRoute(routeConfig, parentRoutes = [], prefix = '') {
|
|
|
61
68
|
export function buildRoutes(routeConfig) {
|
|
62
69
|
return buildRoute(routeConfig);
|
|
63
70
|
}
|
|
64
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
71
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"builder.js","sourceRoot":"","sources":["../../src/builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAsC,MAAM,gBAAgB,CAAC;AAU3E,MAAM,OAAO,SAAS;IAEb,IAAI,CAAS;IAGb,MAAM,CAAoB;IAG1B,aAAa,CAAyB;IAGtC,UAAU,CAAU;IAO3B,YAAmB,KAA8B;QAC/C,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;QAC1D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACrC,CAAC;CACF;AAQD,MAAM,UAAU,UAAU,CACxB,KAAiC;IAGjC,OAAQ,KAAkB,CAAC,EAAE,IAAI,IAAI,CAAC;AACxC,CAAC;AAYD,MAAM,UAAU,UAAU,CACxB,WAA2C,EAC3C,eAAkC,EAAE,EACpC,MAAM,GAAG,EAAE;IAEX,MAAM,UAAU,GAAqB,EAAE,CAAC;IAExC,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE,CAAC;QAChC,MAAM,KAAK,GAAG,EAAE,CAAC;QACjB,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,IAAI,IAAI,IAAI,KAAK,CAAC,IAAI,KAAK,EAAE,IAAI,KAAK,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC;YAClE,IAAI,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC;YAC5B,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/B,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACnC,CAAC;YACD,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACzB,CAAC;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEhC,MAAM,EAAE,QAAQ,EAAE,GAAG,KAAwB,CAAC;QAE9C,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YAC3C,MAAM,MAAM,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,GAAG,YAAY,EAAE,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;YACvE,UAAU,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;YAE3B,SAAS;QACX,CAAC;QAED,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,OAAO,EAAE,EAAE;YACzC,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAC;QAEH,IAAI,IAAI,GAAG,OAAO,CAAC;QACnB,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,IAAI,GAAG,IAAI,OAAO,EAAE,CAAC;QACvB,CAAC;QAED,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,IAAI,UAAU,GAAG,KAAK,CAAC,EAAE,CAAC;YAE1B,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChC,UAAU,GAAG,GAAG,IAAI,IAAI,UAAU,EAAE,CAAC;YACvC,CAAC;YACD,UAAU,CAAC,IAAI,CACb,IAAI,SAAS,CAAC;gBACZ,IAAI;gBACJ,UAAU;gBACV,aAAa;gBACb,MAAM,EAAE,CAAC,GAAG,YAAY,CAAC;aAC1B,CAAC,CACH,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,IAAI,CACb,IAAI,SAAS,CAAC;gBACZ,IAAI;gBACJ,aAAa;gBACb,MAAM,EAAE,CAAC,GAAG,YAAY,EAAE,KAAK,CAAC;aACjC,CAAC,CACH,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AASD,MAAM,UAAU,WAAW,CAAC,WAA8B;IACxD,OAAO,UAAU,CAAC,WAAW,CAAC,CAAC;AACjC,CAAC","sourcesContent":["import { match, type MatchFunction, type ParamData } from 'path-to-regexp';\n\nimport type { FlatRouteInput, Redirect, Route } from './types.js';\n\n/**\n * Represents a flattened route with a compiled match function.\n * This is an internal representation used by the router to efficiently match URLs.\n *\n * @template TParams - Route parameter types extracted from the URL path\n */\nexport class FlatRoute<TParams extends ParamData> {\n  /** The URL path pattern for this route */\n  public path: string;\n\n  /** Nested routes that should be rendered within this route */\n  public routes: Route<any, any>[];\n\n  /** Compiled function to match URL paths against this route pattern */\n  public matchFunction: MatchFunction<TParams>;\n\n  /** Optional redirect destination if this route should redirect */\n  public redirectTo?: string;\n\n  /**\n   * Creates a new FlatRoute instance.\n   *\n   * @param input - Configuration for the flat route\n   */\n  public constructor(input: FlatRouteInput<TParams>) {\n    const { matchFunction, path, redirectTo, routes } = input;\n    this.path = path;\n    this.redirectTo = redirectTo;\n    this.routes = routes;\n    this.matchFunction = matchFunction;\n  }\n}\n\n/**\n * Type guard to check if a route configuration is a redirect.\n *\n * @param route - Route or redirect configuration to check\n * @returns True if the route is a redirect configuration\n */\nexport function isRedirect(\n  route: Route<any, any> | Redirect,\n): route is Redirect {\n  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n  return (route as Redirect).to != null;\n}\n\n/**\n * Recursively builds a flat list of routes from a nested route configuration.\n * This function processes the route tree and creates FlatRoute instances with\n * compiled path matchers for efficient URL matching.\n *\n * @param routeConfig - Array of route or redirect configurations\n * @param parentRoutes - Parent routes in the current path (for nested routes)\n * @param prefix - URL prefix from parent routes\n * @returns Array of flattened routes ready for matching\n */\nexport function buildRoute(\n  routeConfig: (Route<any, any> | Redirect)[],\n  parentRoutes: Route<any, any>[] = [],\n  prefix = '',\n): FlatRoute<any>[] {\n  const flatRoutes: FlatRoute<any>[] = [];\n\n  for (const route of routeConfig) {\n    const parts = [];\n    if (prefix !== '') {\n      parts.push(prefix);\n    }\n    if (route.path != null && route.path !== '' && route.path !== '/') {\n      let normalized = route.path;\n      if (normalized.startsWith('/')) {\n        normalized = normalized.slice(1);\n      }\n      parts.push(normalized);\n    }\n\n    const newPath = parts.join('/');\n\n    const { children } = route as Route<any, any>;\n\n    if (!isRedirect(route) && children != null) {\n      const routes = buildRoute(children, [...parentRoutes, route], newPath);\n      flatRoutes.push(...routes);\n      // eslint-disable-next-line no-continue\n      continue;\n    }\n\n    const matchFunction = match(`/${newPath}`, {\n      trailing: false,\n    });\n\n    let path = newPath;\n    if (!newPath.startsWith('/')) {\n      path = `/${newPath}`;\n    }\n\n    if (isRedirect(route)) {\n      let redirectTo = route.to;\n\n      if (!redirectTo.startsWith('/')) {\n        redirectTo = `${path}/${redirectTo}`;\n      }\n      flatRoutes.push(\n        new FlatRoute({\n          path,\n          redirectTo,\n          matchFunction,\n          routes: [...parentRoutes],\n        }),\n      );\n    } else {\n      flatRoutes.push(\n        new FlatRoute({\n          path,\n          matchFunction,\n          routes: [...parentRoutes, route],\n        }),\n      );\n    }\n  }\n\n  return flatRoutes;\n}\n\n/**\n * Builds a flat route list from the given route configuration.\n * This is the main entry point for route building.\n *\n * @param routeConfig - Array of route configurations to flatten\n * @returns Array of flattened routes ready for matching\n */\nexport function buildRoutes(routeConfig: Route<any, any>[]): FlatRoute<any>[] {\n  return buildRoute(routeConfig);\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/eslint-rules/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,4BAA4B,EAAE,MAAM,uCAAuC,CAAC"}
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
export { default as noDirectWindowLocationSearch } from './no-direct-window-location-search.js';
|
|
2
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvZXNsaW50LXJ1bGVzL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxPQUFPLElBQUksNEJBQTRCLEVBQUUsTUFBTSx1Q0FBdUMsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCB7IGRlZmF1bHQgYXMgbm9EaXJlY3RXaW5kb3dMb2NhdGlvblNlYXJjaCB9IGZyb20gJy4vbm8tZGlyZWN0LXdpbmRvdy1sb2NhdGlvbi1zZWFyY2guanMnO1xuIl19
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-direct-window-location-search.d.ts","sourceRoot":"","sources":["../../../src/eslint-rules/no-direct-window-location-search.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAMnC,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAmDhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
const rule = {
|
|
2
|
+
meta: {
|
|
3
|
+
type: 'suggestion',
|
|
4
|
+
docs: {
|
|
5
|
+
description: 'Discourage direct window.location.search access; use useQuery()/useTypedQuery() instead',
|
|
6
|
+
recommended: false,
|
|
7
|
+
},
|
|
8
|
+
messages: {
|
|
9
|
+
avoid: 'Avoid direct access to window.location.search. Use useQuery() / useTypedQuery() from @plumile/router.',
|
|
10
|
+
},
|
|
11
|
+
schema: [
|
|
12
|
+
{
|
|
13
|
+
type: 'object',
|
|
14
|
+
properties: {
|
|
15
|
+
allowInFiles: { type: 'array', items: { type: 'string' } },
|
|
16
|
+
},
|
|
17
|
+
additionalProperties: false,
|
|
18
|
+
},
|
|
19
|
+
],
|
|
20
|
+
},
|
|
21
|
+
create(context) {
|
|
22
|
+
const rawOption = context.options[0];
|
|
23
|
+
const allowIn = new Set(rawOption?.allowInFiles ?? []);
|
|
24
|
+
const filename = context.getFilename();
|
|
25
|
+
const isAllowed = [...allowIn].some((pat) => {
|
|
26
|
+
return filename.includes(pat);
|
|
27
|
+
});
|
|
28
|
+
return {
|
|
29
|
+
MemberExpression(node) {
|
|
30
|
+
if (isAllowed)
|
|
31
|
+
return;
|
|
32
|
+
if (node.property.type === 'Identifier' &&
|
|
33
|
+
node.property.name === 'search' &&
|
|
34
|
+
node.object.type === 'MemberExpression') {
|
|
35
|
+
const obj = node.object;
|
|
36
|
+
if (obj.property.type === 'Identifier' &&
|
|
37
|
+
obj.property.name === 'location' &&
|
|
38
|
+
obj.object.type === 'Identifier' &&
|
|
39
|
+
obj.object.name === 'window') {
|
|
40
|
+
context.report({ node, messageId: 'avoid' });
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
},
|
|
44
|
+
};
|
|
45
|
+
},
|
|
46
|
+
};
|
|
47
|
+
export default rule;
|
|
48
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibm8tZGlyZWN0LXdpbmRvdy1sb2NhdGlvbi1zZWFyY2guanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvZXNsaW50LXJ1bGVzL25vLWRpcmVjdC13aW5kb3ctbG9jYXRpb24tc2VhcmNoLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQU9BLE1BQU0sSUFBSSxHQUFvQjtJQUM1QixJQUFJLEVBQUU7UUFDSixJQUFJLEVBQUUsWUFBWTtRQUNsQixJQUFJLEVBQUU7WUFDSixXQUFXLEVBQ1QseUZBQXlGO1lBQzNGLFdBQVcsRUFBRSxLQUFLO1NBQ25CO1FBQ0QsUUFBUSxFQUFFO1lBQ1IsS0FBSyxFQUNILHVHQUF1RztTQUMxRztRQUNELE1BQU0sRUFBRTtZQUNOO2dCQUNFLElBQUksRUFBRSxRQUFRO2dCQUNkLFVBQVUsRUFBRTtvQkFDVixZQUFZLEVBQUUsRUFBRSxJQUFJLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxFQUFFLElBQUksRUFBRSxRQUFRLEVBQUUsRUFBRTtpQkFDM0Q7Z0JBQ0Qsb0JBQW9CLEVBQUUsS0FBSzthQUM1QjtTQUNGO0tBQ0Y7SUFDRCxNQUFNLENBQUMsT0FBTztRQUNaLE1BQU0sU0FBUyxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUE2QixDQUFDO1FBQ2pFLE1BQU0sT0FBTyxHQUFHLElBQUksR0FBRyxDQUFDLFNBQVMsRUFBRSxZQUFZLElBQUksRUFBRSxDQUFDLENBQUM7UUFDdkQsTUFBTSxRQUFRLEdBQUcsT0FBTyxDQUFDLFdBQVcsRUFBRSxDQUFDO1FBQ3ZDLE1BQU0sU0FBUyxHQUFHLENBQUMsR0FBRyxPQUFPLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxHQUFHLEVBQUUsRUFBRTtZQUMxQyxPQUFPLFFBQVEsQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLENBQUM7UUFDaEMsQ0FBQyxDQUFDLENBQUM7UUFFSCxPQUFPO1lBQ0wsZ0JBQWdCLENBQUMsSUFBSTtnQkFDbkIsSUFBSSxTQUFTO29CQUFFLE9BQU87Z0JBQ3RCLElBQ0UsSUFBSSxDQUFDLFFBQVEsQ0FBQyxJQUFJLEtBQUssWUFBWTtvQkFDbkMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxJQUFJLEtBQUssUUFBUTtvQkFDL0IsSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLEtBQUssa0JBQWtCLEVBQ3ZDLENBQUM7b0JBQ0QsTUFBTSxHQUFHLEdBQUcsSUFBSSxDQUFDLE1BQU0sQ0FBQztvQkFDeEIsSUFDRSxHQUFHLENBQUMsUUFBUSxDQUFDLElBQUksS0FBSyxZQUFZO3dCQUNsQyxHQUFHLENBQUMsUUFBUSxDQUFDLElBQUksS0FBSyxVQUFVO3dCQUNoQyxHQUFHLENBQUMsTUFBTSxDQUFDLElBQUksS0FBSyxZQUFZO3dCQUNoQyxHQUFHLENBQUMsTUFBTSxDQUFDLElBQUksS0FBSyxRQUFRLEVBQzVCLENBQUM7d0JBQ0QsT0FBTyxDQUFDLE1BQU0sQ0FBQyxFQUFFLElBQUksRUFBRSxTQUFTLEVBQUUsT0FBTyxFQUFFLENBQUMsQ0FBQztvQkFDL0MsQ0FBQztnQkFDSCxDQUFDO1lBQ0gsQ0FBQztTQUNGLENBQUM7SUFDSixDQUFDO0NBQ0YsQ0FBQztBQUVGLGVBQWUsSUFBSSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLy8gTW92ZWQgZnJvbSBwYWNrYWdlIHJvb3QgZXNsaW50LXJ1bGVzIGRpcmVjdG9yeSBpbnRvIHNyYyB0byBzYXRpc2Z5IFRTIHJvb3REaXJcbmltcG9ydCB0eXBlIHsgUnVsZSB9IGZyb20gJ2VzbGludCc7XG5cbmludGVyZmFjZSBPcHRpb25zU2hhcGUge1xuICBhbGxvd0luRmlsZXM/OiBzdHJpbmdbXTtcbn1cblxuY29uc3QgcnVsZTogUnVsZS5SdWxlTW9kdWxlID0ge1xuICBtZXRhOiB7XG4gICAgdHlwZTogJ3N1Z2dlc3Rpb24nLFxuICAgIGRvY3M6IHtcbiAgICAgIGRlc2NyaXB0aW9uOlxuICAgICAgICAnRGlzY291cmFnZSBkaXJlY3Qgd2luZG93LmxvY2F0aW9uLnNlYXJjaCBhY2Nlc3M7IHVzZSB1c2VRdWVyeSgpL3VzZVR5cGVkUXVlcnkoKSBpbnN0ZWFkJyxcbiAgICAgIHJlY29tbWVuZGVkOiBmYWxzZSxcbiAgICB9LFxuICAgIG1lc3NhZ2VzOiB7XG4gICAgICBhdm9pZDpcbiAgICAgICAgJ0F2b2lkIGRpcmVjdCBhY2Nlc3MgdG8gd2luZG93LmxvY2F0aW9uLnNlYXJjaC4gVXNlIHVzZVF1ZXJ5KCkgLyB1c2VUeXBlZFF1ZXJ5KCkgZnJvbSBAcGx1bWlsZS9yb3V0ZXIuJyxcbiAgICB9LFxuICAgIHNjaGVtYTogW1xuICAgICAge1xuICAgICAgICB0eXBlOiAnb2JqZWN0JyxcbiAgICAgICAgcHJvcGVydGllczoge1xuICAgICAgICAgIGFsbG93SW5GaWxlczogeyB0eXBlOiAnYXJyYXknLCBpdGVtczogeyB0eXBlOiAnc3RyaW5nJyB9IH0sXG4gICAgICAgIH0sXG4gICAgICAgIGFkZGl0aW9uYWxQcm9wZXJ0aWVzOiBmYWxzZSxcbiAgICAgIH0sXG4gICAgXSxcbiAgfSxcbiAgY3JlYXRlKGNvbnRleHQpIHtcbiAgICBjb25zdCByYXdPcHRpb24gPSBjb250ZXh0Lm9wdGlvbnNbMF0gYXMgT3B0aW9uc1NoYXBlIHwgdW5kZWZpbmVkO1xuICAgIGNvbnN0IGFsbG93SW4gPSBuZXcgU2V0KHJhd09wdGlvbj8uYWxsb3dJbkZpbGVzID8/IFtdKTtcbiAgICBjb25zdCBmaWxlbmFtZSA9IGNvbnRleHQuZ2V0RmlsZW5hbWUoKTtcbiAgICBjb25zdCBpc0FsbG93ZWQgPSBbLi4uYWxsb3dJbl0uc29tZSgocGF0KSA9PiB7XG4gICAgICByZXR1cm4gZmlsZW5hbWUuaW5jbHVkZXMocGF0KTtcbiAgICB9KTtcblxuICAgIHJldHVybiB7XG4gICAgICBNZW1iZXJFeHByZXNzaW9uKG5vZGUpIHtcbiAgICAgICAgaWYgKGlzQWxsb3dlZCkgcmV0dXJuO1xuICAgICAgICBpZiAoXG4gICAgICAgICAgbm9kZS5wcm9wZXJ0eS50eXBlID09PSAnSWRlbnRpZmllcicgJiZcbiAgICAgICAgICBub2RlLnByb3BlcnR5Lm5hbWUgPT09ICdzZWFyY2gnICYmXG4gICAgICAgICAgbm9kZS5vYmplY3QudHlwZSA9PT0gJ01lbWJlckV4cHJlc3Npb24nXG4gICAgICAgICkge1xuICAgICAgICAgIGNvbnN0IG9iaiA9IG5vZGUub2JqZWN0O1xuICAgICAgICAgIGlmIChcbiAgICAgICAgICAgIG9iai5wcm9wZXJ0eS50eXBlID09PSAnSWRlbnRpZmllcicgJiZcbiAgICAgICAgICAgIG9iai5wcm9wZXJ0eS5uYW1lID09PSAnbG9jYXRpb24nICYmXG4gICAgICAgICAgICBvYmoub2JqZWN0LnR5cGUgPT09ICdJZGVudGlmaWVyJyAmJlxuICAgICAgICAgICAgb2JqLm9iamVjdC5uYW1lID09PSAnd2luZG93J1xuICAgICAgICAgICkge1xuICAgICAgICAgICAgY29udGV4dC5yZXBvcnQoeyBub2RlLCBtZXNzYWdlSWQ6ICdhdm9pZCcgfSk7XG4gICAgICAgICAgfVxuICAgICAgICB9XG4gICAgICB9LFxuICAgIH07XG4gIH0sXG59O1xuXG5leHBvcnQgZGVmYXVsdCBydWxlO1xuIl19
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BrowserHistory.d.ts","sourceRoot":"","sources":["../../../src/history/BrowserHistory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAQ5E,wBAAgB,UAAU,CAAC,QAAQ,EAAE,eAAe,GAAG,MAAM,CAI5D;AAOD,MAAM,CAAC,OAAO,OAAO,cAAe,YAAW,OAAO;IAEpD,OAAO,CAAC,WAAW,CAAyB;;IAe5C,IAAW,QAAQ,IAAI,QAAQ,
|
|
1
|
+
{"version":3,"file":"BrowserHistory.d.ts","sourceRoot":"","sources":["../../../src/history/BrowserHistory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAQ5E,wBAAgB,UAAU,CAAC,QAAQ,EAAE,eAAe,GAAG,MAAM,CAI5D;AAOD,MAAM,CAAC,OAAO,OAAO,cAAe,YAAW,OAAO;IAEpD,OAAO,CAAC,WAAW,CAAyB;;IAe5C,IAAW,QAAQ,IAAI,QAAQ,CAU9B;IAKM,IAAI,IAAI,IAAI;IAUZ,GAAG,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI;IAapC,IAAI,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI;IAYrC,WAAW,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI;IAY5C,SAAS,CAAC,QAAQ,EAAE,eAAe,GAAG,MAAM,IAAI;IAWvD,OAAO,CAAC,MAAM,CAOZ;IAOF,OAAO,CAAC,QAAQ,CAOd;IAKF,OAAO,CAAC,WAAW;CAGpB"}
|
|
@@ -9,7 +9,9 @@ export default class BrowserHistory {
|
|
|
9
9
|
}
|
|
10
10
|
get location() {
|
|
11
11
|
return {
|
|
12
|
-
|
|
12
|
+
pathname: window.location.pathname,
|
|
13
|
+
search: window.location.search,
|
|
14
|
+
hash: window.location.hash,
|
|
13
15
|
};
|
|
14
16
|
}
|
|
15
17
|
init() {
|
|
@@ -56,4 +58,4 @@ export default class BrowserHistory {
|
|
|
56
58
|
window.addEventListener('popstate', this.__fire);
|
|
57
59
|
}
|
|
58
60
|
}
|
|
59
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
61
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"BrowserHistory.js","sourceRoot":"","sources":["../../../src/history/BrowserHistory.ts"],"names":[],"mappings":"AAQA,MAAM,UAAU,UAAU,CAAC,QAAyB;IAClD,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,EAAE,EAAE,IAAI,GAAG,EAAE,EAAE,GAAG,QAAQ,CAAC;IAEtD,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,IAAI,EAAE,CAAC;AACvC,CAAC;AAOD,MAAM,CAAC,OAAO,OAAO,cAAc;IAEzB,WAAW,GAAsB,EAAE,CAAC;IAK5C;QACE,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAQD,IAAW,QAAQ;QAIjB,OAAO;YAEL,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ;YAClC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM;YAC9B,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI;SACJ,CAAC;IAC3B,CAAC;IAKM,IAAI;QACT,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAQM,GAAG,CAAC,QAAyB;QAClC,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;QAElC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAQM,IAAI,CAAC,QAAyB;QACnC,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;QAElC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAOM,WAAW,CAAC,QAAyB;QAC1C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YAClD,OAAO,IAAI,KAAK,QAAQ,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAQM,SAAS,CAAC,QAAyB;QACxC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChC,OAAO,GAAG,EAAE;YACV,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC7B,CAAC,CAAC;IACJ,CAAC;IAMO,MAAM,GAAG,GAAS,EAAE;QAC1B,UAAU,CAAC,GAAG,EAAE;YACd,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;YAC1B,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACpC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YAC5B,CAAC,CAAC,CAAC;QACL,CAAC,EAAE,CAAC,CAAC,CAAC;IACR,CAAC,CAAC;IAOM,QAAQ,GAAG,CAAC,aAAa,GAAG,KAAK,EAAE,EAAE;QAC3C,UAAU,CAAC,GAAG,EAAE;YACd,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;YAC1B,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACpC,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC;QACL,CAAC,EAAE,CAAC,CAAC,CAAC;IACR,CAAC,CAAC;IAKM,WAAW;QACjB,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACnD,CAAC;CACF","sourcesContent":["import type { History, HistoryListener, HistoryLocation } from './types.js';\n\n/**\n * Creates a complete URL path from a HistoryLocation object.\n *\n * @param location - Location object containing pathname, search, and hash\n * @returns Complete path string combining all components\n */\nexport function createPath(location: HistoryLocation): string {\n  const { pathname, search = '', hash = '' } = location;\n\n  return `${pathname}${search}${hash}`;\n}\n\n/**\n * Browser history implementation using the HTML5 History API.\n * Manages browser navigation state and provides a consistent interface\n * for programmatic navigation and location change notifications.\n */\nexport default class BrowserHistory implements History {\n  /** Array of listeners for location changes */\n  private __listeners: HistoryListener[] = [];\n\n  /**\n   * Creates a new BrowserHistory instance and initializes event listeners.\n   */\n  public constructor() {\n    this.init();\n  }\n\n  /**\n   * Gets the current browser location.\n   *\n   * @returns Current window.location object\n   */\n  // eslint-disable-next-line class-methods-use-this\n  public get location(): Location {\n    // Some test DOM environments (e.g. happy-dom) expose non-enumerable\n    // Location properties so a simple spread returns an empty object.\n    // Return an explicit plain object with the fields we rely on.\n    return {\n      // pathname/search/hash are sufficient for our router logic\n      pathname: window.location.pathname,\n      search: window.location.search,\n      hash: window.location.hash,\n    } as unknown as Location;\n  }\n\n  /**\n   * Initializes the history instance by setting up event listeners.\n   */\n  public init(): void {\n    this.__subscribe();\n  }\n\n  /**\n   * Replaces the current history entry with a new location.\n   * This updates the URL without creating a new history entry.\n   *\n   * @param location - New location to set\n   */\n  public set(location: HistoryLocation): void {\n    const path = createPath(location);\n\n    window.history.replaceState({}, '', path);\n    this.__doFire(true);\n  }\n\n  /**\n   * Navigates to a new location by pushing a new history entry.\n   * This creates a new entry in the browser's history stack.\n   *\n   * @param location - Location to navigate to\n   */\n  public push(location: HistoryLocation): void {\n    const path = createPath(location);\n\n    window.history.pushState({}, '', path);\n    this.__fire();\n  }\n\n  /**\n   * Removes a listener from the history change notifications.\n   *\n   * @param listener - Listener function to remove\n   */\n  public unsubscribe(listener: HistoryListener): void {\n    this.__listeners = this.__listeners.filter((item) => {\n      return item !== listener;\n    });\n  }\n\n  /**\n   * Subscribes to history changes.\n   *\n   * @param listener - Function to call when location changes\n   * @returns Unsubscribe function\n   */\n  public subscribe(listener: HistoryListener): () => void {\n    this.__listeners.push(listener);\n    return () => {\n      this.unsubscribe(listener);\n    };\n  }\n\n  /**\n   * Notifies all listeners of a location change.\n   * Uses setTimeout to ensure the notification happens after the current execution.\n   */\n  private __fire = (): void => {\n    setTimeout(() => {\n      const { location } = this;\n      this.__listeners.forEach((listener) => {\n        listener(location, false);\n      });\n    }, 0);\n  };\n\n  /**\n   * Notifies all listeners of a location change with optional force rerender.\n   *\n   * @param forceRerender - Whether to force a re-render\n   */\n  private __doFire = (forceRerender = false) => {\n    setTimeout(() => {\n      const { location } = this;\n      this.__listeners.forEach((listener) => {\n        listener(location, forceRerender);\n      });\n    }, 0);\n  };\n\n  /**\n   * Sets up the popstate event listener for browser back/forward navigation.\n   */\n  private __subscribe() {\n    window.addEventListener('popstate', this.__fire);\n  }\n}\n"]}
|
package/lib/esm/index.d.ts
CHANGED
package/lib/esm/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,cAAc,mBAAmB,CAAC;AAGlC,cAAc,oBAAoB,CAAC;AAGnC,cAAc,oBAAoB,CAAC;AAGnC,cAAc,cAAc,CAAC;AAG7B,cAAc,mBAAmB,CAAC;AAGlC,cAAc,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,cAAc,mBAAmB,CAAC;AAGlC,cAAc,oBAAoB,CAAC;AAGnC,cAAc,oBAAoB,CAAC;AAGnC,cAAc,cAAc,CAAC;AAG7B,cAAc,mBAAmB,CAAC;AAGlC,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,CAAC,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAG1D,mBAAmB,YAAY,CAAC"}
|
package/lib/esm/index.js
CHANGED
|
@@ -4,4 +4,5 @@ export * from './routing/index.js';
|
|
|
4
4
|
export * from './builder.js';
|
|
5
5
|
export * from './ResourcePage.js';
|
|
6
6
|
export * from './tools.js';
|
|
7
|
-
|
|
7
|
+
export { q, parseTypedQuery } from './tools/query-dsl.js';
|
|
8
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsY0FBYyxtQkFBbUIsQ0FBQztBQUdsQyxjQUFjLG9CQUFvQixDQUFDO0FBR25DLGNBQWMsb0JBQW9CLENBQUM7QUFHbkMsY0FBYyxjQUFjLENBQUM7QUFHN0IsY0FBYyxtQkFBbUIsQ0FBQztBQUdsQyxjQUFjLFlBQVksQ0FBQztBQUMzQixPQUFPLEVBQUUsQ0FBQyxFQUFFLGVBQWUsRUFBRSxNQUFNLHNCQUFzQixDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLy8gRXhwb3J0IGVycm9yIGhhbmRsaW5nIHV0aWxpdGllc1xuZXhwb3J0ICogZnJvbSAnLi9lcnJvcnMvaW5kZXguanMnO1xuXG4vLyBFeHBvcnQgYnJvd3NlciBoaXN0b3J5IG1hbmFnZW1lbnRcbmV4cG9ydCAqIGZyb20gJy4vaGlzdG9yeS9pbmRleC5qcyc7XG5cbi8vIEV4cG9ydCByb3V0aW5nIGNvbXBvbmVudHMgYW5kIHV0aWxpdGllc1xuZXhwb3J0ICogZnJvbSAnLi9yb3V0aW5nL2luZGV4LmpzJztcblxuLy8gRXhwb3J0IHJvdXRlIGJ1aWxkaW5nIHV0aWxpdGllc1xuZXhwb3J0ICogZnJvbSAnLi9idWlsZGVyLmpzJztcblxuLy8gRXhwb3J0IHJlc291cmNlIHBhZ2UgbWFuYWdlbWVudCBmb3IgbGF6eSBsb2FkaW5nXG5leHBvcnQgKiBmcm9tICcuL1Jlc291cmNlUGFnZS5qcyc7XG5cbi8vIEV4cG9ydCB1dGlsaXR5IGZ1bmN0aW9uc1xuZXhwb3J0ICogZnJvbSAnLi90b29scy5qcyc7XG5leHBvcnQgeyBxLCBwYXJzZVR5cGVkUXVlcnkgfSBmcm9tICcuL3Rvb2xzL3F1ZXJ5LWRzbC5qcyc7XG5cbi8vIEV4cG9ydCBhbGwgVHlwZVNjcmlwdCB0eXBlc1xuZXhwb3J0IHR5cGUgKiBmcm9tICcuL3R5cGVzLmpzJztcbiJdfQ==
|
|
@@ -15,6 +15,7 @@ type Props = {
|
|
|
15
15
|
onMouseOver?: React.MouseEventHandler<HTMLAnchorElement>;
|
|
16
16
|
target?: HTMLAttributeAnchorTarget;
|
|
17
17
|
to?: HistoryLocation | string;
|
|
18
|
+
query?: Record<string, any>;
|
|
18
19
|
};
|
|
19
20
|
declare const Link: React.ForwardRefExoticComponent<Props & React.RefAttributes<HTMLAnchorElement>>;
|
|
20
21
|
export default Link;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Link.d.ts","sourceRoot":"","sources":["../../../src/routing/Link.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EACZ,KAAK,yBAAyB,EAE9B,KAAK,SAAS,EAIf,MAAM,OAAO,CAAC;AAEf,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"Link.d.ts","sourceRoot":"","sources":["../../../src/routing/Link.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EACZ,KAAK,yBAAyB,EAE9B,KAAK,SAAS,EAIf,MAAM,OAAO,CAAC;AAEf,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAY3E,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,OAAO,EACd,OAAO,EAAE,cAAc,GAAG,SAAS,EACnC,QAAQ,EAAE,MAAM,GACf,OAAO,CAmBT;AAKD,KAAK,KAAK,GAAG;IAEX,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,QAAQ,EAAE,SAAS,CAAC;IAEpB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;IAErD,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;IAErD,WAAW,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;IAEzD,MAAM,CAAC,EAAE,yBAAyB,CAAC;IAEnC,EAAE,CAAC,EAAE,eAAe,GAAG,MAAM,CAAC;IAE9B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7B,CAAC;AAyBF,QAAA,MAAM,IAAI,iFA2KR,CAAC;AAEH,eAAe,IAAI,CAAC"}
|