@tramvai/tokens-router 7.5.3 → 7.7.0

package/lib/index.d.ts

@@ -1,11 +1,15 @@
 import type { AbstractRouter, NavigationGuard, Route, Navigation, NavigationRoute, NavigateOptions, UpdateCurrentRouteOptions, HistoryOptions, RouteConfig, RouterPlugin } from '@tinkoff/router';
+import type { AsyncParallelTapableHookInstance, AsyncTapableHookInstance } from '@tinkoff/hook-runner';
 import type { TramvaiComponent } from '@tramvai/react';
 /**
  * @description
  * Token to access the router instance
  */
 export declare const ROUTER_TOKEN: AbstractRouter & {
-    __type?: "base token" | undefined;
+    __type?: "base token" | undefined; /**
+     * @description
+     * Encapsulates the logic of working with the router - contains methods for getting the configuration of the route and performing navigation
+     */
 };
 /**
  * @description
@@ -28,21 +32,30 @@ export declare const ROUTER_GUARD_TOKEN: NavigationGuard & {
  * Encapsulates the logic of working with the router - contains methods for getting the configuration of the route and performing navigation
  */
 export declare const PAGE_SERVICE_TOKEN: PageService & {
-    __type?: "base token" | undefined;
+    __type?: "base token" | undefined; /**
+     * @description
+     * Encapsulates the logic of working with the router - contains methods for getting the configuration of the route and performing navigation
+     */
 };
 /**
  * @description
  * Managers registration for additions related to pages and bundles
  */
 export declare const PAGE_REGISTRY_TOKEN: PageRegistry & {
-    __type?: "base token" | undefined;
+    __type?: "base token" | undefined; /**
+     * @description
+     * Encapsulates the logic of working with the router - contains methods for getting the configuration of the route and performing navigation
+     */
 };
 /**
  * @description
  * Hook to resolve route dynamically
  */
 export declare const ROUTE_RESOLVE_TOKEN: RouteResolve & {
-    __type?: "base token" | undefined;
+    __type?: "base token" | undefined; /**
+     * @description
+     * Encapsulates the logic of working with the router - contains methods for getting the configuration of the route and performing navigation
+     */
 };
 /**
  * @description
@@ -56,20 +69,35 @@ export declare const ROUTE_TRANSFORM_TOKEN: RouteTransform & {
  * Flag for SPA-transitions, indicating that actions must be executed before or after a route update in the stor
  */
 export declare const ROUTER_SPA_ACTIONS_RUN_MODE_TOKEN: ("before" & {
-    __type?: "base token" | undefined;
+    __type?: "base token" | undefined; /**
+     * @description
+     * Encapsulates the logic of working with the router - contains methods for getting the configuration of the route and performing navigation
+     */
 }) | ("after" & {
-    __type?: "base token" | undefined;
+    __type?: "base token" | undefined; /**
+     * @description
+     * Encapsulates the logic of working with the router - contains methods for getting the configuration of the route and performing navigation
+     */
 });
 export declare const LINK_PREFETCH_MANAGER_TOKEN: LinkPrefetchManager & {
-    __type?: "base token" | undefined;
+    __type?: "base token" | undefined; /**
+     * @description
+     * Encapsulates the logic of working with the router - contains methods for getting the configuration of the route and performing navigation
+     */
 };
 export declare const LINK_PREFETCH_HANDLER_TOKEN: ((route: Route) => Promise<void>) & {
     __type?: "multi token" | undefined;
 };
 export declare const ROUTER_MODE_TOKEN: ("spa" & {
-    __type?: "base token" | undefined;
+    __type?: "base token" | undefined; /**
+     * @description
+     * Encapsulates the logic of working with the router - contains methods for getting the configuration of the route and performing navigation
+     */
 }) | ("no-spa" & {
-    __type?: "base token" | undefined;
+    __type?: "base token" | undefined; /**
+     * @description
+     * Encapsulates the logic of working with the router - contains methods for getting the configuration of the route and performing navigation
+     */
 });
 export type PageServiceComponentType = 'page' | 'layout' | 'nestedLayout' | 'header' | 'footer' | 'errorBoundary';
 export interface PageService {
@@ -102,4 +130,24 @@ export interface LinkPrefetchManager {
 export declare const ROUTER_PLUGIN: RouterPlugin & {
     __type?: "multi token" | undefined;
 };
+export interface PrerenderRequest {
+    /**
+     * Page path, for example, '/product/123/', without query parameters
+     */
+    pathname: string;
+    headers?: Record<string, string>;
+    query?: Record<string, string>;
+}
+export type PrerenderHooksToken = {
+    'prerender:routes': AsyncParallelTapableHookInstance<Array<string | PrerenderRequest>>;
+    'prerender:generate': AsyncTapableHookInstance<NavigationRoute & {
+        prerenderSkip?: boolean;
+    }>;
+};
+export declare const PRERENDER_HOOKS_TOKEN: PrerenderHooksToken & {
+    __type?: "base token" | undefined; /**
+     * @description
+     * Encapsulates the logic of working with the router - contains methods for getting the configuration of the route and performing navigation
+     */
+};
 //# sourceMappingURL=index.d.ts.map

package/lib/index.es.js

@@ -1,4 +1,4 @@
-import { createToken } from '@tinkoff/dippy';
+import { createToken, Scope } from '@tinkoff/dippy';
 
 /**
  * @description
@@ -50,5 +50,8 @@ const ROUTER_MODE_TOKEN = createToken('router mode');
  * Token to provide router plugins
  */
 const ROUTER_PLUGIN = createToken('router plugin', { multi: true });
+const PRERENDER_HOOKS_TOKEN = createToken('tramvai prerender hooks', {
+    scope: Scope.SINGLETON,
+});
 
-export { LINK_PREFETCH_HANDLER_TOKEN, LINK_PREFETCH_MANAGER_TOKEN, PAGE_REGISTRY_TOKEN, PAGE_SERVICE_TOKEN, ROUTER_GUARD_TOKEN, ROUTER_MODE_TOKEN, ROUTER_PLUGIN, ROUTER_SPA_ACTIONS_RUN_MODE_TOKEN, ROUTER_TOKEN, ROUTES_TOKEN, ROUTE_RESOLVE_TOKEN, ROUTE_TRANSFORM_TOKEN };
+export { LINK_PREFETCH_HANDLER_TOKEN, LINK_PREFETCH_MANAGER_TOKEN, PAGE_REGISTRY_TOKEN, PAGE_SERVICE_TOKEN, PRERENDER_HOOKS_TOKEN, ROUTER_GUARD_TOKEN, ROUTER_MODE_TOKEN, ROUTER_PLUGIN, ROUTER_SPA_ACTIONS_RUN_MODE_TOKEN, ROUTER_TOKEN, ROUTES_TOKEN, ROUTE_RESOLVE_TOKEN, ROUTE_TRANSFORM_TOKEN };

package/lib/index.js

@@ -54,11 +54,15 @@ const ROUTER_MODE_TOKEN = dippy.createToken('router mode');
  * Token to provide router plugins
  */
 const ROUTER_PLUGIN = dippy.createToken('router plugin', { multi: true });
+const PRERENDER_HOOKS_TOKEN = dippy.createToken('tramvai prerender hooks', {
+    scope: dippy.Scope.SINGLETON,
+});
 
 exports.LINK_PREFETCH_HANDLER_TOKEN = LINK_PREFETCH_HANDLER_TOKEN;
 exports.LINK_PREFETCH_MANAGER_TOKEN = LINK_PREFETCH_MANAGER_TOKEN;
 exports.PAGE_REGISTRY_TOKEN = PAGE_REGISTRY_TOKEN;
 exports.PAGE_SERVICE_TOKEN = PAGE_SERVICE_TOKEN;
+exports.PRERENDER_HOOKS_TOKEN = PRERENDER_HOOKS_TOKEN;
 exports.ROUTER_GUARD_TOKEN = ROUTER_GUARD_TOKEN;
 exports.ROUTER_MODE_TOKEN = ROUTER_MODE_TOKEN;
 exports.ROUTER_PLUGIN = ROUTER_PLUGIN;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/tokens-router",
-  "version": "7.5.3",
+  "version": "7.7.0",
   "description": "Tramvai tokens for @tramvai/module-router",
   "main": "lib/index.js",
   "module": "lib/index.es.js",
@@ -18,8 +18,9 @@
     "watch": "tsc -w"
   },
   "dependencies": {
-    "@tinkoff/router": "0.7.21",
-    "@tramvai/react": "7.5.3"
+    "@tinkoff/hook-runner": "0.9.1",
+    "@tinkoff/router": "0.7.25",
+    "@tramvai/react": "7.7.0"
   },
   "peerDependencies": {
     "@tinkoff/dippy": "0.13.2",