@kitbag/router 0.20.11 → 0.21.0

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 (51) hide show
  1. package/README.md +29 -87
  2. package/dist/components/routerLink.d.ts +3 -3
  3. package/dist/errors/contextAbortError.d.ts +2 -2
  4. package/dist/errors/contextPushError.d.ts +2 -2
  5. package/dist/errors/contextRejectionError.d.ts +2 -2
  6. package/dist/keys.d.ts +1 -3
  7. package/dist/kitbag-router.js +1780 -1847
  8. package/dist/kitbag-router.umd.cjs +3 -3
  9. package/dist/main.d.ts +0 -16
  10. package/dist/models/hooks.d.ts +10 -0
  11. package/dist/services/createComponentHooks.d.ts +7 -7
  12. package/dist/services/createExternalRoute.d.ts +3 -2
  13. package/dist/services/createHooksFactory.d.ts +15 -0
  14. package/dist/services/createPropStore.d.ts +2 -2
  15. package/dist/services/createRoute.d.ts +2 -1
  16. package/dist/services/createRouterAssets.d.ts +5 -5
  17. package/dist/services/createRouterCallbackContext.d.ts +8 -6
  18. package/dist/services/createRouterHooks.d.ts +14 -14
  19. package/dist/services/createRouterPlugin.d.ts +2 -2
  20. package/dist/services/createUrlParts.d.ts +13 -0
  21. package/dist/services/getGlobalHooksForRouter.d.ts +2 -3
  22. package/dist/services/getGlobalRouteHooks.d.ts +3 -3
  23. package/dist/services/getRouteHooks.d.ts +3 -3
  24. package/dist/services/hooks.d.ts +2 -2
  25. package/dist/services/urlCombine.d.ts +2 -1
  26. package/dist/services/urlCreator.d.ts +2 -1
  27. package/dist/services/urlParser.d.ts +1 -1
  28. package/dist/types/callbackContext.d.ts +15 -0
  29. package/dist/types/createRouteOptions.d.ts +6 -13
  30. package/dist/types/hooks.d.ts +56 -136
  31. package/dist/types/params.d.ts +11 -5
  32. package/dist/types/props.d.ts +8 -8
  33. package/dist/types/register.d.ts +1 -41
  34. package/dist/types/rejection.d.ts +6 -2
  35. package/dist/types/resolved.d.ts +2 -2
  36. package/dist/types/route.d.ts +5 -4
  37. package/dist/types/routeContext.d.ts +11 -5
  38. package/dist/types/router.d.ts +11 -11
  39. package/dist/types/routerAbort.d.ts +1 -0
  40. package/dist/types/routerPlugin.d.ts +17 -41
  41. package/dist/types/routerReject.d.ts +2 -2
  42. package/dist/types/url.d.ts +0 -9
  43. package/dist/types/urlParts.d.ts +53 -0
  44. package/dist/utilities/makeOptional.d.ts +1 -0
  45. package/dist/utilities/testHelpers.d.ts +279 -11
  46. package/package.json +4 -2
  47. package/dist/models/RouteHooks.d.ts +0 -12
  48. package/dist/models/RouterRouteHooks.d.ts +0 -10
  49. package/dist/services/createCallbackContext.d.ts +0 -44
  50. package/dist/services/createRouteHooks.d.ts +0 -15
  51. package/dist/services/getRouteHooksDeprecated.d.ts +0 -10
package/package.json CHANGED
@@ -1,7 +1,8 @@
1
1
  {
2
2
  "name": "@kitbag/router",
3
3
  "private": false,
4
- "version": "0.20.11",
4
+ "version": "0.21.0",
5
+ "license": "MIT",
5
6
  "bugs": {
6
7
  "url": "https://github.com/kitbagjs/router/issues"
7
8
  },
@@ -16,7 +17,7 @@
16
17
  "homepage": "https://github.com/kitbagjs/router#readme",
17
18
  "scripts": {
18
19
  "build": "vite build",
19
- "build:watch": "vite build --watch --minify=false",
20
+ "dev": "vite build --watch --minify=false",
20
21
  "test": "vitest",
21
22
  "lint": "eslint ./src",
22
23
  "lint:fix": "eslint ./src --fix",
@@ -69,6 +70,7 @@
69
70
  },
70
71
  "dependencies": {
71
72
  "@standard-schema/spec": "^1.0.0",
73
+ "@vue/devtools-api": "^8.0.5",
72
74
  "history": "^5.3.0"
73
75
  }
74
76
  }
@@ -1,12 +0,0 @@
1
- import { AfterRouteHook, BeforeRouteHook } from '../types/hooks';
2
- /**
3
- * @deprecated will be removed in a future version
4
- */
5
- export declare class RouteHooks {
6
- onBeforeRouteEnter: Set<BeforeRouteHook>;
7
- onBeforeRouteUpdate: Set<BeforeRouteHook>;
8
- onBeforeRouteLeave: Set<BeforeRouteHook>;
9
- onAfterRouteEnter: Set<AfterRouteHook>;
10
- onAfterRouteUpdate: Set<AfterRouteHook>;
11
- onAfterRouteLeave: Set<AfterRouteHook>;
12
- }
@@ -1,10 +0,0 @@
1
- import { RouterAfterRouteHook, RouterBeforeRouteHook, RouterErrorHook } from '../types/hooks';
2
- export declare class RouterRouteHooks {
3
- onBeforeRouteEnter: Set<RouterBeforeRouteHook>;
4
- onBeforeRouteUpdate: Set<RouterBeforeRouteHook>;
5
- onBeforeRouteLeave: Set<RouterBeforeRouteHook>;
6
- onAfterRouteEnter: Set<RouterAfterRouteHook>;
7
- onAfterRouteUpdate: Set<RouterAfterRouteHook>;
8
- onAfterRouteLeave: Set<RouterAfterRouteHook>;
9
- onError: Set<RouterErrorHook>;
10
- }
@@ -1,44 +0,0 @@
1
- import { RegisteredRouterPush, RegisteredRouterReject, RegisteredRouterReplace } from '../types/register';
2
- /**
3
- * Defines the structure of a successful callback response.
4
- */
5
- export type CallbackSuccessResponse = {
6
- status: 'SUCCESS';
7
- };
8
- /**
9
- * Defines the structure of an aborted callback response.
10
- */
11
- export type CallbackAbortResponse = {
12
- status: 'ABORT';
13
- };
14
- /**
15
- * Defines the structure of a callback response that results in a push to a new route.
16
- */
17
- export type CallbackPushResponse = {
18
- status: 'PUSH';
19
- to: Parameters<RegisteredRouterPush>;
20
- };
21
- /**
22
- * Defines the structure of a callback response that results in the rejection of a route transition.
23
- */
24
- export type CallbackRejectResponse = {
25
- status: 'REJECT';
26
- type: string;
27
- };
28
- /**
29
- * A function that can be called to abort a routing operation.
30
- */
31
- export type CallbackContextAbort = () => void;
32
- /**
33
- * @deprecated Use `RouterCallbackContext` instead.
34
- */
35
- export type CallbackContext = {
36
- reject: RegisteredRouterReject;
37
- push: RegisteredRouterPush;
38
- replace: RegisteredRouterReplace;
39
- abort: CallbackContextAbort;
40
- };
41
- /**
42
- * @deprecated Use `createRouterCallbackContext` instead.
43
- */
44
- export declare function createCallbackContext(): CallbackContext;
@@ -1,15 +0,0 @@
1
- import { AddRouterBeforeRouteHook, AddRouterAfterRouteHook, AddRouterErrorHook } from '../types/hooks';
2
- import { Routes } from '../types/route';
3
- import { RouterRouteHooks } from '../models/RouterRouteHooks';
4
- import { Rejection } from '../types/rejection';
5
- export type RouteHooks<TRoutes extends Routes = Routes, TRejections extends Rejection[] = Rejection[]> = {
6
- onBeforeRouteEnter: AddRouterBeforeRouteHook<TRoutes, TRejections>;
7
- onBeforeRouteUpdate: AddRouterBeforeRouteHook<TRoutes, TRejections>;
8
- onBeforeRouteLeave: AddRouterBeforeRouteHook<TRoutes, TRejections>;
9
- onAfterRouteEnter: AddRouterAfterRouteHook<TRoutes, TRejections>;
10
- onAfterRouteUpdate: AddRouterAfterRouteHook<TRoutes, TRejections>;
11
- onAfterRouteLeave: AddRouterAfterRouteHook<TRoutes, TRejections>;
12
- onError: AddRouterErrorHook<TRoutes, TRejections>;
13
- store: RouterRouteHooks;
14
- };
15
- export declare function createRouteHooks(): RouteHooks;
@@ -1,10 +0,0 @@
1
- import { RouteHooks } from '../models/RouteHooks';
2
- import { ResolvedRoute } from '../types/resolved';
3
- /**
4
- * @deprecated will be removed in a future version
5
- */
6
- export declare function getBeforeRouteHooksFromRoutesDeprecated(to: ResolvedRoute, from: ResolvedRoute | null): RouteHooks;
7
- /**
8
- * @deprecated will be removed in a future version
9
- */
10
- export declare function getAfterRouteHooksFromRoutesDeprecated(to: ResolvedRoute, from: ResolvedRoute | null): RouteHooks;