@kitbag/router 0.22.2 → 0.22.3

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.
Files changed (26) hide show
  1. package/README.md +1 -1
  2. package/dist/compositions/useQueryValue.d.ts +1 -1
  3. package/dist/kitbag-router.js +1537 -1517
  4. package/dist/kitbag-router.umd.cjs +3 -3
  5. package/dist/services/combineHash.d.ts +4 -3
  6. package/dist/services/combinePath.d.ts +8 -12
  7. package/dist/services/combineQuery.d.ts +8 -12
  8. package/dist/services/combineUrl.d.ts +2 -1
  9. package/dist/services/createRouteHooks.d.ts +2 -1
  10. package/dist/services/createRouterCallbackContext.d.ts +2 -29
  11. package/dist/services/createRouterHistory.d.ts +1 -1
  12. package/dist/services/createRouterReject.d.ts +2 -2
  13. package/dist/services/createVueAppStore.d.ts +2 -1
  14. package/dist/services/getParamsForString.d.ts +2 -1
  15. package/dist/services/params.d.ts +5 -4
  16. package/dist/services/paramsFinder.d.ts +3 -3
  17. package/dist/services/routeRegex.d.ts +2 -5
  18. package/dist/services/urlParser.d.ts +3 -2
  19. package/dist/services/withParams.d.ts +65 -10
  20. package/dist/types/createRouteOptions.d.ts +5 -5
  21. package/dist/types/params.d.ts +2 -7
  22. package/dist/types/url.d.ts +11 -17
  23. package/dist/types/utilities.d.ts +0 -1
  24. package/dist/utilities/array.d.ts +0 -1
  25. package/dist/utilities/testHelpers.d.ts +246 -90
  26. package/package.json +2 -2
package/dist/utilities/testHelpers.d.ts CHANGED
@@ -56,10 +56,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
56
56
  id: string;
57
57
  props: undefined;
58
58
  meta: Readonly<{}>;
59
- }], []>>, import('../main').Url<{} & {
60
- paramA: [StringConstructor, false];
61
- } & {
62
- paramB: [StringConstructor, true];
59
+ }], []>>, import('../main').Url<{
60
+ paramA: {
61
+ param: StringConstructor;
62
+ isOptional: false;
63
+ isGreedy: false;
64
+ };
65
+ paramB: {
66
+ param: StringConstructor;
67
+ isOptional: true;
68
+ isGreedy: false;
69
+ };
63
70
  }> & {
64
71
  id: string;
65
72
  matched: Omit<{
@@ -190,10 +197,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
190
197
  context: [];
191
198
  hooks: import('../models/hooks').Hooks[];
192
199
  depth: number;
193
- } & import('../main').InternalRouteHooks<import('../main').Route<"parentA.childA", import('../main').Url<{} & {
194
- paramA: [StringConstructor, false];
195
- } & {
196
- paramB: [StringConstructor, true];
200
+ } & import('../main').InternalRouteHooks<import('../main').Route<"parentA.childA", import('../main').Url<{
201
+ paramA: {
202
+ param: StringConstructor;
203
+ isOptional: false;
204
+ isGreedy: false;
205
+ };
206
+ paramB: {
207
+ param: StringConstructor;
208
+ isOptional: true;
209
+ isGreedy: false;
210
+ };
197
211
  }>, Readonly<{}>, {}, [Omit<{
198
212
  readonly name: "parentA";
199
213
  readonly path: "/parentA/[paramA]";
@@ -257,10 +271,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
257
271
  id: string;
258
272
  props: undefined;
259
273
  meta: Readonly<{}>;
260
- }], []>, []> & import('../types/redirects').RouteRedirects<import('../main').Route<"parentA.childA", import('../main').Url<{} & {
261
- paramA: [StringConstructor, false];
262
- } & {
263
- paramB: [StringConstructor, true];
274
+ }], []>, []> & import('../types/redirects').RouteRedirects<import('../main').Route<"parentA.childA", import('../main').Url<{
275
+ paramA: {
276
+ param: StringConstructor;
277
+ isOptional: false;
278
+ isGreedy: false;
279
+ };
280
+ paramB: {
281
+ param: StringConstructor;
282
+ isOptional: true;
283
+ isGreedy: false;
284
+ };
264
285
  }>, Readonly<{}>, {}, [Omit<{
265
286
  readonly name: "parentA";
266
287
  readonly path: "/parentA/[paramA]";
@@ -324,10 +345,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
324
345
  id: string;
325
346
  props: undefined;
326
347
  meta: Readonly<{}>;
327
- }], []>>, import('../main').Url<{} & {
328
- paramA: [StringConstructor, false];
329
- } & {
330
- paramD: [StringConstructor, false];
348
+ }], []>>, import('../main').Url<{
349
+ paramA: {
350
+ param: StringConstructor;
351
+ isOptional: false;
352
+ isGreedy: false;
353
+ };
354
+ paramD: {
355
+ param: StringConstructor;
356
+ isOptional: false;
357
+ isGreedy: false;
358
+ };
331
359
  }> & {
332
360
  id: string;
333
361
  matched: Omit<{
@@ -464,10 +492,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
464
492
  context: [];
465
493
  hooks: import('../models/hooks').Hooks[];
466
494
  depth: number;
467
- } & import('../main').InternalRouteHooks<import('../main').Route<"parentA.childB", import('../main').Url<{} & {
468
- paramA: [StringConstructor, false];
469
- } & {
470
- paramD: [StringConstructor, false];
495
+ } & import('../main').InternalRouteHooks<import('../main').Route<"parentA.childB", import('../main').Url<{
496
+ paramA: {
497
+ param: StringConstructor;
498
+ isOptional: false;
499
+ isGreedy: false;
500
+ };
501
+ paramD: {
502
+ param: StringConstructor;
503
+ isOptional: false;
504
+ isGreedy: false;
505
+ };
471
506
  }>, Readonly<{}>, {}, [Omit<{
472
507
  readonly name: "parentA";
473
508
  readonly path: "/parentA/[paramA]";
@@ -534,10 +569,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
534
569
  id: string;
535
570
  props: undefined;
536
571
  meta: Readonly<{}>;
537
- }], []>, []> & import('../types/redirects').RouteRedirects<import('../main').Route<"parentA.childB", import('../main').Url<{} & {
538
- paramA: [StringConstructor, false];
539
- } & {
540
- paramD: [StringConstructor, false];
572
+ }], []>, []> & import('../types/redirects').RouteRedirects<import('../main').Route<"parentA.childB", import('../main').Url<{
573
+ paramA: {
574
+ param: StringConstructor;
575
+ isOptional: false;
576
+ isGreedy: false;
577
+ };
578
+ paramD: {
579
+ param: StringConstructor;
580
+ isOptional: false;
581
+ isGreedy: false;
582
+ };
541
583
  }>, Readonly<{}>, {}, [Omit<{
542
584
  readonly name: "parentA";
543
585
  readonly path: "/parentA/[paramA]";
@@ -604,19 +646,36 @@ export declare const routes: readonly [import('../main').ToUrl<{
604
646
  id: string;
605
647
  props: undefined;
606
648
  meta: Readonly<{}>;
607
- }], []>>, import('../main').Url<{} & {
608
- paramA: [StringConstructor, false];
609
- } & {
610
- paramB: [StringConstructor, true];
611
- } & {
612
- paramC: [StringConstructor, false];
649
+ }], []>>, import('../main').Url<{
650
+ paramA: {
651
+ param: StringConstructor;
652
+ isOptional: false;
653
+ isGreedy: false;
654
+ };
655
+ paramB: {
656
+ param: StringConstructor;
657
+ isOptional: true;
658
+ isGreedy: false;
659
+ };
660
+ paramC: {
661
+ param: StringConstructor;
662
+ isOptional: false;
663
+ isGreedy: false;
664
+ };
613
665
  }> & {
614
666
  id: string;
615
667
  matched: Omit<{
616
- readonly parent: import('../main').Url<{} & {
617
- paramA: [StringConstructor, false];
618
- } & {
619
- paramB: [StringConstructor, true];
668
+ readonly parent: import('../main').Url<{
669
+ paramA: {
670
+ param: StringConstructor;
671
+ isOptional: false;
672
+ isGreedy: false;
673
+ };
674
+ paramB: {
675
+ param: StringConstructor;
676
+ isOptional: true;
677
+ isGreedy: false;
678
+ };
620
679
  }> & {
621
680
  id: string;
622
681
  matched: Omit<{
@@ -747,10 +806,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
747
806
  context: [];
748
807
  hooks: import('../models/hooks').Hooks[];
749
808
  depth: number;
750
- } & import('../main').InternalRouteHooks<import('../main').Route<"parentA.childA", import('../main').Url<{} & {
751
- paramA: [StringConstructor, false];
752
- } & {
753
- paramB: [StringConstructor, true];
809
+ } & import('../main').InternalRouteHooks<import('../main').Route<"parentA.childA", import('../main').Url<{
810
+ paramA: {
811
+ param: StringConstructor;
812
+ isOptional: false;
813
+ isGreedy: false;
814
+ };
815
+ paramB: {
816
+ param: StringConstructor;
817
+ isOptional: true;
818
+ isGreedy: false;
819
+ };
754
820
  }>, Readonly<{}>, {}, [Omit<{
755
821
  readonly name: "parentA";
756
822
  readonly path: "/parentA/[paramA]";
@@ -814,10 +880,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
814
880
  id: string;
815
881
  props: undefined;
816
882
  meta: Readonly<{}>;
817
- }], []>, []> & import('../types/redirects').RouteRedirects<import('../main').Route<"parentA.childA", import('../main').Url<{} & {
818
- paramA: [StringConstructor, false];
819
- } & {
820
- paramB: [StringConstructor, true];
883
+ }], []>, []> & import('../types/redirects').RouteRedirects<import('../main').Route<"parentA.childA", import('../main').Url<{
884
+ paramA: {
885
+ param: StringConstructor;
886
+ isOptional: false;
887
+ isGreedy: false;
888
+ };
889
+ paramB: {
890
+ param: StringConstructor;
891
+ isOptional: true;
892
+ isGreedy: false;
893
+ };
821
894
  }>, Readonly<{}>, {}, [Omit<{
822
895
  readonly name: "parentA";
823
896
  readonly path: "/parentA/[paramA]";
@@ -956,10 +1029,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
956
1029
  props: undefined;
957
1030
  meta: Readonly<{}>;
958
1031
  }, Omit<{
959
- readonly parent: import('../main').Url<{} & {
960
- paramA: [StringConstructor, false];
961
- } & {
962
- paramB: [StringConstructor, true];
1032
+ readonly parent: import('../main').Url<{
1033
+ paramA: {
1034
+ param: StringConstructor;
1035
+ isOptional: false;
1036
+ isGreedy: false;
1037
+ };
1038
+ paramB: {
1039
+ param: StringConstructor;
1040
+ isOptional: true;
1041
+ isGreedy: false;
1042
+ };
963
1043
  }> & {
964
1044
  id: string;
965
1045
  matched: Omit<{
@@ -1090,10 +1170,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
1090
1170
  context: [];
1091
1171
  hooks: import('../models/hooks').Hooks[];
1092
1172
  depth: number;
1093
- } & import('../main').InternalRouteHooks<import('../main').Route<"parentA.childA", import('../main').Url<{} & {
1094
- paramA: [StringConstructor, false];
1095
- } & {
1096
- paramB: [StringConstructor, true];
1173
+ } & import('../main').InternalRouteHooks<import('../main').Route<"parentA.childA", import('../main').Url<{
1174
+ paramA: {
1175
+ param: StringConstructor;
1176
+ isOptional: false;
1177
+ isGreedy: false;
1178
+ };
1179
+ paramB: {
1180
+ param: StringConstructor;
1181
+ isOptional: true;
1182
+ isGreedy: false;
1183
+ };
1097
1184
  }>, Readonly<{}>, {}, [Omit<{
1098
1185
  readonly name: "parentA";
1099
1186
  readonly path: "/parentA/[paramA]";
@@ -1157,10 +1244,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
1157
1244
  id: string;
1158
1245
  props: undefined;
1159
1246
  meta: Readonly<{}>;
1160
- }], []>, []> & import('../types/redirects').RouteRedirects<import('../main').Route<"parentA.childA", import('../main').Url<{} & {
1161
- paramA: [StringConstructor, false];
1162
- } & {
1163
- paramB: [StringConstructor, true];
1247
+ }], []>, []> & import('../types/redirects').RouteRedirects<import('../main').Route<"parentA.childA", import('../main').Url<{
1248
+ paramA: {
1249
+ param: StringConstructor;
1250
+ isOptional: false;
1251
+ isGreedy: false;
1252
+ };
1253
+ paramB: {
1254
+ param: StringConstructor;
1255
+ isOptional: true;
1256
+ isGreedy: false;
1257
+ };
1164
1258
  }>, Readonly<{}>, {}, [Omit<{
1165
1259
  readonly name: "parentA";
1166
1260
  readonly path: "/parentA/[paramA]";
@@ -1242,12 +1336,22 @@ export declare const routes: readonly [import('../main').ToUrl<{
1242
1336
  context: [];
1243
1337
  hooks: import('../models/hooks').Hooks[];
1244
1338
  depth: number;
1245
- } & import('../main').InternalRouteHooks<import('../main').Route<"parentA.childA.grandChildA", import('../main').Url<{} & {
1246
- paramA: [StringConstructor, false];
1247
- } & {
1248
- paramB: [StringConstructor, true];
1249
- } & {
1250
- paramC: [StringConstructor, false];
1339
+ } & import('../main').InternalRouteHooks<import('../main').Route<"parentA.childA.grandChildA", import('../main').Url<{
1340
+ paramA: {
1341
+ param: StringConstructor;
1342
+ isOptional: false;
1343
+ isGreedy: false;
1344
+ };
1345
+ paramB: {
1346
+ param: StringConstructor;
1347
+ isOptional: true;
1348
+ isGreedy: false;
1349
+ };
1350
+ paramC: {
1351
+ param: StringConstructor;
1352
+ isOptional: false;
1353
+ isGreedy: false;
1354
+ };
1251
1355
  }>, Readonly<{}>, {}, [Omit<{
1252
1356
  readonly name: "parentA";
1253
1357
  readonly path: "/parentA/[paramA]";
@@ -1312,10 +1416,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
1312
1416
  props: undefined;
1313
1417
  meta: Readonly<{}>;
1314
1418
  }, Omit<{
1315
- readonly parent: import('../main').Url<{} & {
1316
- paramA: [StringConstructor, false];
1317
- } & {
1318
- paramB: [StringConstructor, true];
1419
+ readonly parent: import('../main').Url<{
1420
+ paramA: {
1421
+ param: StringConstructor;
1422
+ isOptional: false;
1423
+ isGreedy: false;
1424
+ };
1425
+ paramB: {
1426
+ param: StringConstructor;
1427
+ isOptional: true;
1428
+ isGreedy: false;
1429
+ };
1319
1430
  }> & {
1320
1431
  id: string;
1321
1432
  matched: Omit<{
@@ -1446,10 +1557,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
1446
1557
  context: [];
1447
1558
  hooks: import('../models/hooks').Hooks[];
1448
1559
  depth: number;
1449
- } & import('../main').InternalRouteHooks<import('../main').Route<"parentA.childA", import('../main').Url<{} & {
1450
- paramA: [StringConstructor, false];
1451
- } & {
1452
- paramB: [StringConstructor, true];
1560
+ } & import('../main').InternalRouteHooks<import('../main').Route<"parentA.childA", import('../main').Url<{
1561
+ paramA: {
1562
+ param: StringConstructor;
1563
+ isOptional: false;
1564
+ isGreedy: false;
1565
+ };
1566
+ paramB: {
1567
+ param: StringConstructor;
1568
+ isOptional: true;
1569
+ isGreedy: false;
1570
+ };
1453
1571
  }>, Readonly<{}>, {}, [Omit<{
1454
1572
  readonly name: "parentA";
1455
1573
  readonly path: "/parentA/[paramA]";
@@ -1513,10 +1631,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
1513
1631
  id: string;
1514
1632
  props: undefined;
1515
1633
  meta: Readonly<{}>;
1516
- }], []>, []> & import('../types/redirects').RouteRedirects<import('../main').Route<"parentA.childA", import('../main').Url<{} & {
1517
- paramA: [StringConstructor, false];
1518
- } & {
1519
- paramB: [StringConstructor, true];
1634
+ }], []>, []> & import('../types/redirects').RouteRedirects<import('../main').Route<"parentA.childA", import('../main').Url<{
1635
+ paramA: {
1636
+ param: StringConstructor;
1637
+ isOptional: false;
1638
+ isGreedy: false;
1639
+ };
1640
+ paramB: {
1641
+ param: StringConstructor;
1642
+ isOptional: true;
1643
+ isGreedy: false;
1644
+ };
1520
1645
  }>, Readonly<{}>, {}, [Omit<{
1521
1646
  readonly name: "parentA";
1522
1647
  readonly path: "/parentA/[paramA]";
@@ -1590,12 +1715,22 @@ export declare const routes: readonly [import('../main').ToUrl<{
1590
1715
  id: string;
1591
1716
  props: undefined;
1592
1717
  meta: Readonly<{}>;
1593
- }], []>, []> & import('../types/redirects').RouteRedirects<import('../main').Route<"parentA.childA.grandChildA", import('../main').Url<{} & {
1594
- paramA: [StringConstructor, false];
1595
- } & {
1596
- paramB: [StringConstructor, true];
1597
- } & {
1598
- paramC: [StringConstructor, false];
1718
+ }], []>, []> & import('../types/redirects').RouteRedirects<import('../main').Route<"parentA.childA.grandChildA", import('../main').Url<{
1719
+ paramA: {
1720
+ param: StringConstructor;
1721
+ isOptional: false;
1722
+ isGreedy: false;
1723
+ };
1724
+ paramB: {
1725
+ param: StringConstructor;
1726
+ isOptional: true;
1727
+ isGreedy: false;
1728
+ };
1729
+ paramC: {
1730
+ param: StringConstructor;
1731
+ isOptional: false;
1732
+ isGreedy: false;
1733
+ };
1599
1734
  }>, Readonly<{}>, {}, [Omit<{
1600
1735
  readonly name: "parentA";
1601
1736
  readonly path: "/parentA/[paramA]";
@@ -1660,10 +1795,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
1660
1795
  props: undefined;
1661
1796
  meta: Readonly<{}>;
1662
1797
  }, Omit<{
1663
- readonly parent: import('../main').Url<{} & {
1664
- paramA: [StringConstructor, false];
1665
- } & {
1666
- paramB: [StringConstructor, true];
1798
+ readonly parent: import('../main').Url<{
1799
+ paramA: {
1800
+ param: StringConstructor;
1801
+ isOptional: false;
1802
+ isGreedy: false;
1803
+ };
1804
+ paramB: {
1805
+ param: StringConstructor;
1806
+ isOptional: true;
1807
+ isGreedy: false;
1808
+ };
1667
1809
  }> & {
1668
1810
  id: string;
1669
1811
  matched: Omit<{
@@ -1794,10 +1936,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
1794
1936
  context: [];
1795
1937
  hooks: import('../models/hooks').Hooks[];
1796
1938
  depth: number;
1797
- } & import('../main').InternalRouteHooks<import('../main').Route<"parentA.childA", import('../main').Url<{} & {
1798
- paramA: [StringConstructor, false];
1799
- } & {
1800
- paramB: [StringConstructor, true];
1939
+ } & import('../main').InternalRouteHooks<import('../main').Route<"parentA.childA", import('../main').Url<{
1940
+ paramA: {
1941
+ param: StringConstructor;
1942
+ isOptional: false;
1943
+ isGreedy: false;
1944
+ };
1945
+ paramB: {
1946
+ param: StringConstructor;
1947
+ isOptional: true;
1948
+ isGreedy: false;
1949
+ };
1801
1950
  }>, Readonly<{}>, {}, [Omit<{
1802
1951
  readonly name: "parentA";
1803
1952
  readonly path: "/parentA/[paramA]";
@@ -1861,10 +2010,17 @@ export declare const routes: readonly [import('../main').ToUrl<{
1861
2010
  id: string;
1862
2011
  props: undefined;
1863
2012
  meta: Readonly<{}>;
1864
- }], []>, []> & import('../types/redirects').RouteRedirects<import('../main').Route<"parentA.childA", import('../main').Url<{} & {
1865
- paramA: [StringConstructor, false];
1866
- } & {
1867
- paramB: [StringConstructor, true];
2013
+ }], []>, []> & import('../types/redirects').RouteRedirects<import('../main').Route<"parentA.childA", import('../main').Url<{
2014
+ paramA: {
2015
+ param: StringConstructor;
2016
+ isOptional: false;
2017
+ isGreedy: false;
2018
+ };
2019
+ paramB: {
2020
+ param: StringConstructor;
2021
+ isOptional: true;
2022
+ isGreedy: false;
2023
+ };
1868
2024
  }>, Readonly<{}>, {}, [Omit<{
1869
2025
  readonly name: "parentA";
1870
2026
  readonly path: "/parentA/[paramA]";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@kitbag/router",
3
3
  "private": false,
4
- "version": "0.22.2",
4
+ "version": "0.22.3",
5
5
  "license": "MIT",
6
6
  "bugs": {
7
7
  "url": "https://github.com/kitbagjs/router/issues"
@@ -47,7 +47,7 @@
47
47
  "@vue/test-utils": "^2.4.6",
48
48
  "eslint": "^9.39.2",
49
49
  "globals": "^17.1.0",
50
- "happy-dom": "^20.4.0",
50
+ "happy-dom": "^20.5.3",
51
51
  "typedoc": "^0.28.16",
52
52
  "typedoc-plugin-markdown": "^4.9.0",
53
53
  "typedoc-vitepress-theme": "^1.1.2",