@kitbag/router 0.8.0 → 0.9.0

package/dist/kitbag-router.d.ts

@@ -254,9 +254,9 @@ declare type CreateRouteOptionsMatched = CreateRouteOptions & WithHooks & (WithH
  * const router = createRouter(routes)
  * ```
  */
-export declare function createRouter<const T extends Routes>(routes: T, options?: RouterOptions): Router<T>;
+export declare function createRouter<const TRoutes extends Routes, const TOptions extends RouterOptions>(routes: TRoutes, options?: TOptions): Router<TRoutes, TOptions>;
 
-export declare function createRouter<const T extends Routes>(arrayOfRoutes: T[], options?: RouterOptions): Router<T>;
+export declare function createRouter<const TRoutes extends Routes, const TOptions extends RouterOptions>(arrayOfRoutes: TRoutes[], options?: TOptions): Router<TRoutes, TOptions>;
 
 /**
  * An error thrown when duplicate parameters are detected in a route.
@@ -576,7 +576,7 @@ declare type QueryParamsWithParamNameExtracted<T extends string> = {
 };
 
 /**
- * Represents the state of currently registered router, rejections, and route meta. Used to provide correct type context for
+ * Represents the state of currently registered router, and route meta. Used to provide correct type context for
  * components like `RouterLink`, as well as for composables like `useRouter`, `useRoute`, and hooks.
  *
  * @example
@@ -584,7 +584,6 @@ declare type QueryParamsWithParamNameExtracted<T extends string> = {
  * declare module '@kitbag/router' {
  *   interface Register {
  *     router: typeof router
- *     rejections: ["NotAuthorized"],
  *     routeMeta: { public?: boolean }
  *   }
  * }
@@ -597,8 +596,8 @@ export declare interface Register {
  * Represents the possible Rejections registered within {@link Register}
  */
 export declare type RegisteredRejectionType = Register extends {
-    rejections: infer TRejections extends string[];
-} ? TRejections[number] : never;
+    router: Router<Routes, infer TOptions extends RouterOptions>;
+} ? keyof TOptions['rejections'] | BuiltInRejectionType : BuiltInRejectionType;
 
 /**
  * Represents the a map of all possible route names with corresponding Route registered within {@link Register}
@@ -667,6 +666,10 @@ declare type ResolvedRoute<TRoute extends Route = Route> = Readonly<{
      * Accessor for query string values from user in the current browser location.
      */
     query: ResolvedRouteQuery;
+    /**
+     * Hash value of the route.
+     */
+    hash?: string;
     /**
      * Key value pair for route params, values will be the user provided value from current browser location.
      */
@@ -777,7 +780,7 @@ declare type RouteHookPushResponse<T extends Routes> = {
  */
 declare type RouteHookRejectResponse = {
     status: 'REJECT';
-    type: RouterRejectionType;
+    type: RegisteredRejectionType;
 };
 
 /**
@@ -809,7 +812,7 @@ declare type RouteParams<TPath extends string | Path | undefined, TQuery extends
 
 declare type RouteParamsByKey<TRoutes extends Routes, TKey extends string> = ExtractRouteParamTypesWithoutLosingOptional<RouteGetByKey<TRoutes, TKey>>;
 
-export declare type Router<TRoutes extends Routes = any> = Plugin_2 & {
+export declare type Router<TRoutes extends Routes = any, __TOptions extends RouterOptions = any> = Plugin_2 & {
     /**
      * Manages the current route state.
      */
@@ -964,7 +967,11 @@ export declare type RouterOptions = {
      * Determines what assets are prefetched when router-link is rendered for a specific route
      */
     prefetch?: PrefetchConfig;
-} & RouterRejectionComponents;
+    /**
+     * Components assigned to each type of rejection your router supports.
+     */
+    rejections?: Partial<Record<string, Component>>;
+};
 
 declare type RouterPush<TRoutes extends Routes = any> = {
     <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterPushArgs<TRoutes, TSource>): Promise<void>;
@@ -975,25 +982,20 @@ declare type RouterPushArgs<TRoutes extends Routes, TSource extends RoutesName<T
 
 declare type RouterPushOptions<TState = unknown> = {
     query?: Record<string, string>;
+    hash?: string;
     replace?: boolean;
     state?: Partial<TState>;
 };
 
-export declare type RouterReject = (type: RouterRejectionType) => void;
+export declare type RouterReject = (type: RegisteredRejectionType) => void;
 
 declare type RouterRejection = Ref<null | {
-    type: RouterRejectionType;
+    type: RegisteredRejectionType;
     component: Component;
 }>;
 
-declare type RouterRejectionComponents = {
-    rejections?: Partial<Record<RouterRejectionType, Component>>;
-};
-
 export declare const routerRejectionKey: InjectionKey<RouterRejection>;
 
-declare type RouterRejectionType = BuiltInRejectionType | RegisteredRejectionType;
-
 declare type RouterReplace<TRoutes extends Routes> = {
     <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterReplaceArgs<TRoutes, TSource>): Promise<void>;
     (url: Url, options?: RouterReplaceOptions): Promise<void>;
@@ -1003,6 +1005,7 @@ declare type RouterReplaceArgs<TRoutes extends Routes, TSource extends RoutesNam
 
 declare type RouterReplaceOptions<TState = unknown> = {
     query?: Record<string, string>;
+    hash?: string;
     state?: Partial<TState>;
 };
 
@@ -1015,6 +1018,7 @@ declare type RouterResolveArgs<TRoutes extends Routes, TSource extends RoutesNam
 
 declare type RouterResolveOptions = {
     query?: Record<string, string>;
+    hash?: string;
 };
 
 declare type RouterRoute<TRoute extends ResolvedRoute = ResolvedRoute> = Readonly<{
@@ -1023,6 +1027,7 @@ declare type RouterRoute<TRoute extends ResolvedRoute = ResolvedRoute> = Readonl
     matches: TRoute['matches'];
     state: TRoute['state'];
     query: ResolvedRouteQuery;
+    hash: TRoute['hash'];
     params: Writable<TRoute['params']>;
     update: RouteUpdate<TRoute>;
 }>;
@@ -1053,6 +1058,7 @@ name?: string | undefined;
                 [x: number]: any;
             };
             query: ResolvedRouteQuery;
+            hash: string | undefined;
             params: Writable<    {
             [x: string]: any;
             [x: number]: any;
@@ -1088,6 +1094,7 @@ name?: string | undefined;
                 [x: number]: any;
             };
             query: ResolvedRouteQuery;
+            hash: string | undefined;
             params: Writable<    {
             [x: string]: any;
             [x: number]: any;