@tramvai/module-page-render-mode 2.28.0 → 2.31.0

package/lib/staticPages.d.ts

@@ -0,0 +1,94 @@
+import type { Counter } from 'prom-client';
+import { BackgroundFetchService } from './staticPages/backgroundFetchService';
+import { StaticPagesService } from './staticPages/staticPagesService';
+export declare const STATIC_PAGES_BACKGROUND_FETCH_SERVICE: import("@tinkoff/dippy").BaseTokenInterface<BackgroundFetchService>;
+export declare const STATIC_PAGES_GET_CACHE_KEY_TOKEN: import("@tinkoff/dippy").BaseTokenInterface<() => string>;
+export declare const STATIC_PAGES_CACHE_HIT_METRIC_TOKEN: import("@tinkoff/dippy").BaseTokenInterface<Counter<any>>;
+export declare const STATIC_PAGES_SERVICE: import("@tinkoff/dippy").BaseTokenInterface<StaticPagesService>;
+export declare const staticPagesProviders: (import("@tinkoff/dippy/lib/Provider").ValueProvider<import("@tinkoff/dippy").BaseTokenInterface<Counter<any>>> | import("@tinkoff/dippy/lib/Provider").ClassProvider<{
+    metrics: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-metrics").Metrics>;
+}, import("@tinkoff/dippy").BaseTokenInterface<Counter<any>>> | import("@tinkoff/dippy/lib/Provider").FactoryProvider<{
+    metrics: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-metrics").Metrics>;
+}, import("@tinkoff/dippy").BaseTokenInterface<Counter<any>>> | import("@tinkoff/dippy/lib/Provider").ValueProvider<import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").Cache<Map<string, import("./tokens").StaticPagesCacheEntry>>>> | import("@tinkoff/dippy/lib/Provider").ClassProvider<{
+    createCache: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").CacheFactory>;
+    staticPagesOptions: import("@tinkoff/dippy").BaseTokenInterface<import("./tokens").StaticPagesOptions>;
+}, import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").Cache<Map<string, import("./tokens").StaticPagesCacheEntry>>>> | import("@tinkoff/dippy/lib/Provider").FactoryProvider<{
+    createCache: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").CacheFactory>;
+    staticPagesOptions: import("@tinkoff/dippy").BaseTokenInterface<import("./tokens").StaticPagesOptions>;
+}, import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").Cache<Map<string, import("./tokens").StaticPagesCacheEntry>>>> | import("@tinkoff/dippy/lib/Provider").ValueProvider<import("@tinkoff/dippy").BaseTokenInterface<import("./tokens").StaticPagesOptions>> | import("@tinkoff/dippy/lib/Provider").ClassProvider<unknown, import("@tinkoff/dippy").BaseTokenInterface<import("./tokens").StaticPagesOptions>> | import("@tinkoff/dippy/lib/Provider").FactoryProvider<unknown, import("@tinkoff/dippy").BaseTokenInterface<import("./tokens").StaticPagesOptions>> | import("@tinkoff/dippy/lib/Provider").ValueProvider<import("@tinkoff/dippy").BaseTokenInterface<() => string>> | import("@tinkoff/dippy/lib/Provider").ClassProvider<{
+    requestManager: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").RequestManager>;
+    userAgent: import("@tinkoff/dippy").BaseTokenInterface<import("@tinkoff/user-agent").UserAgent>;
+    modern: import("@tinkoff/dippy").BaseTokenInterface<boolean>;
+}, import("@tinkoff/dippy").BaseTokenInterface<() => string>> | import("@tinkoff/dippy/lib/Provider").FactoryProvider<{
+    requestManager: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").RequestManager>;
+    userAgent: import("@tinkoff/dippy").BaseTokenInterface<import("@tinkoff/user-agent").UserAgent>;
+    modern: import("@tinkoff/dippy").BaseTokenInterface<boolean>;
+}, import("@tinkoff/dippy").BaseTokenInterface<() => string>> | import("@tinkoff/dippy/lib/Provider").ValueProvider<import("@tinkoff/dippy").BaseTokenInterface<() => boolean>> | import("@tinkoff/dippy/lib/Provider").ClassProvider<unknown, import("@tinkoff/dippy").BaseTokenInterface<() => boolean>> | import("@tinkoff/dippy/lib/Provider").FactoryProvider<unknown, import("@tinkoff/dippy").BaseTokenInterface<() => boolean>> | import("@tinkoff/dippy/lib/Provider").ValueProvider<import("@tinkoff/dippy").BaseTokenInterface<BackgroundFetchService>> | import("@tinkoff/dippy/lib/Provider").ClassProvider<{
+    logger: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").LoggerFactory>;
+    backgroundFetchEnabled: import("@tinkoff/dippy").BaseTokenInterface<() => boolean>;
+}, import("@tinkoff/dippy").BaseTokenInterface<BackgroundFetchService>> | import("@tinkoff/dippy/lib/Provider").FactoryProvider<{
+    logger: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").LoggerFactory>;
+    backgroundFetchEnabled: import("@tinkoff/dippy").BaseTokenInterface<() => boolean>;
+}, import("@tinkoff/dippy").BaseTokenInterface<BackgroundFetchService>> | import("@tinkoff/dippy/lib/Provider").ValueProvider<import("@tinkoff/dippy").BaseTokenInterface<StaticPagesService>> | import("@tinkoff/dippy/lib/Provider").ClassProvider<{
+    getCacheKey: import("@tinkoff/dippy").BaseTokenInterface<() => string>;
+    requestManager: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").RequestManager>;
+    responseManager: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").ResponseManager>;
+    response: import("@tinkoff/dippy").BaseTokenInterface<import("fastify").FastifyReply<import("fastify").RawServerDefault, import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>, import("fastify/types/route").RouteGenericInterface, unknown>>;
+    environmentManager: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").EnvironmentManager>;
+    userAgent: import("@tinkoff/dippy").BaseTokenInterface<import("@tinkoff/user-agent").UserAgent>;
+    modern: import("@tinkoff/dippy").BaseTokenInterface<boolean>;
+    logger: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").LoggerFactory>;
+    cache: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").Cache<Map<string, import("./tokens").StaticPagesCacheEntry>>>;
+    modifyCache: {
+        token: import("@tinkoff/dippy").MultiTokenInterface<(entry: import("./tokens").StaticPagesCacheEntry) => import("./tokens").StaticPagesCacheEntry>;
+        optional: boolean;
+    };
+    shouldUseCache: import("@tinkoff/dippy").BaseTokenInterface<() => boolean>;
+    shouldSetToCache: import("@tinkoff/dippy").BaseTokenInterface<() => boolean>;
+    backgroundFetchService: import("@tinkoff/dippy").BaseTokenInterface<BackgroundFetchService>;
+    options: import("@tinkoff/dippy").BaseTokenInterface<import("./tokens").StaticPagesOptions>;
+    cache5xxResponse: import("@tinkoff/dippy").BaseTokenInterface<() => boolean>;
+}, import("@tinkoff/dippy").BaseTokenInterface<StaticPagesService>> | import("@tinkoff/dippy/lib/Provider").FactoryProvider<{
+    getCacheKey: import("@tinkoff/dippy").BaseTokenInterface<() => string>;
+    requestManager: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").RequestManager>;
+    responseManager: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").ResponseManager>;
+    response: import("@tinkoff/dippy").BaseTokenInterface<import("fastify").FastifyReply<import("fastify").RawServerDefault, import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>, import("fastify/types/route").RouteGenericInterface, unknown>>;
+    environmentManager: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").EnvironmentManager>;
+    userAgent: import("@tinkoff/dippy").BaseTokenInterface<import("@tinkoff/user-agent").UserAgent>;
+    modern: import("@tinkoff/dippy").BaseTokenInterface<boolean>;
+    logger: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").LoggerFactory>;
+    cache: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").Cache<Map<string, import("./tokens").StaticPagesCacheEntry>>>;
+    modifyCache: {
+        token: import("@tinkoff/dippy").MultiTokenInterface<(entry: import("./tokens").StaticPagesCacheEntry) => import("./tokens").StaticPagesCacheEntry>;
+        optional: boolean;
+    };
+    shouldUseCache: import("@tinkoff/dippy").BaseTokenInterface<() => boolean>;
+    shouldSetToCache: import("@tinkoff/dippy").BaseTokenInterface<() => boolean>;
+    backgroundFetchService: import("@tinkoff/dippy").BaseTokenInterface<BackgroundFetchService>;
+    options: import("@tinkoff/dippy").BaseTokenInterface<import("./tokens").StaticPagesOptions>;
+    cache5xxResponse: import("@tinkoff/dippy").BaseTokenInterface<() => boolean>;
+}, import("@tinkoff/dippy").BaseTokenInterface<StaticPagesService>> | import("@tinkoff/dippy/lib/Provider").ValueProvider<import("@tinkoff/dippy").MultiTokenInterface<import("@tramvai/core").Command>> | import("@tinkoff/dippy/lib/Provider").ClassProvider<{
+    di: import("@tinkoff/dippy").BaseTokenInterface<import("@tinkoff/dippy").Container>;
+    staticPagesCommandLine: {
+        token: import("@tinkoff/dippy").BaseTokenInterface<"init" | "listen" | "customerStart" | "resolveUserDeps" | "resolvePageDeps" | "generatePage" | "clear" | "spaTransition" | "afterSpaTransition" | "close">;
+        optional: boolean;
+    };
+}, import("@tinkoff/dippy").MultiTokenInterface<import("@tramvai/core").Command>> | import("@tinkoff/dippy/lib/Provider").FactoryProvider<{
+    di: import("@tinkoff/dippy").BaseTokenInterface<import("@tinkoff/dippy").Container>;
+    staticPagesCommandLine: {
+        token: import("@tinkoff/dippy").BaseTokenInterface<"init" | "listen" | "customerStart" | "resolveUserDeps" | "resolvePageDeps" | "generatePage" | "clear" | "spaTransition" | "afterSpaTransition" | "close">;
+        optional: boolean;
+    };
+}, import("@tinkoff/dippy").MultiTokenInterface<import("@tramvai/core").Command>> | import("@tinkoff/dippy/lib/Provider").ClassProvider<{
+    staticPagesService: import("@tinkoff/dippy").BaseTokenInterface<StaticPagesService>;
+    pageService: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-router").PageService>;
+    defaultRenderMode: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-render").TramvaiRenderMode>;
+}, import("@tinkoff/dippy").MultiTokenInterface<import("@tramvai/core").Command>> | import("@tinkoff/dippy/lib/Provider").FactoryProvider<{
+    staticPagesService: import("@tinkoff/dippy").BaseTokenInterface<StaticPagesService>;
+    pageService: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-router").PageService>;
+    defaultRenderMode: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-render").TramvaiRenderMode>;
+}, import("@tinkoff/dippy").MultiTokenInterface<import("@tramvai/core").Command>> | import("@tinkoff/dippy/lib/Provider").ValueProvider<import("@tinkoff/dippy").MultiTokenInterface<import("@tramvai/papi").Papi<any, any>>> | import("@tinkoff/dippy/lib/Provider").ClassProvider<{
+    staticPagesCache: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").Cache<Map<string, import("./tokens").StaticPagesCacheEntry>>>;
+}, import("@tinkoff/dippy").MultiTokenInterface<import("@tramvai/papi").Papi<any, any>>> | import("@tinkoff/dippy/lib/Provider").FactoryProvider<{
+    staticPagesCache: import("@tinkoff/dippy").BaseTokenInterface<import("@tramvai/tokens-common").Cache<Map<string, import("./tokens").StaticPagesCacheEntry>>>;
+}, import("@tinkoff/dippy").MultiTokenInterface<import("@tramvai/papi").Papi<any, any>>>)[];

package/lib/tokens.d.ts

@@ -1,5 +1,6 @@
 import type { ComponentType } from 'react';
 import type { TramvaiRenderMode } from '@tramvai/tokens-render';
+import type { Cache, ResponseManager } from '@tramvai/tokens-common';
 export declare const PAGE_RENDER_FALLBACK_COMPONENT_PREFIX: import("@tinkoff/dippy").BaseTokenInterface<string>;
 /**
  * @deprecated Use token `TRAMVAI_RENDER_MODE` from `@tramvai/tokens-render`
@@ -7,3 +8,29 @@ export declare const PAGE_RENDER_FALLBACK_COMPONENT_PREFIX: import("@tinkoff/dip
 export declare const PAGE_RENDER_DEFAULT_MODE: import("@tinkoff/dippy").BaseTokenInterface<TramvaiRenderMode>;
 export declare const PAGE_RENDER_WRAPPER_TYPE: import("@tinkoff/dippy").BaseTokenInterface<"layout" | "content" | "page">;
 export declare const PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT: import("@tinkoff/dippy").BaseTokenInterface<ComponentType<any>>;
+export interface StaticPagesCacheEntry {
+    updatedAt: number;
+    headers: ReturnType<ResponseManager['getHeaders']>;
+    status: ReturnType<ResponseManager['getStatus']>;
+    body: string;
+}
+export interface StaticPagesOptions {
+    /**
+     * Static page cache live time in milliseconds
+     * @default 60000
+     */
+    ttl: number;
+    /**
+     * Cached static page maximum size
+     * @default 1000
+     */
+    maxSize: number;
+}
+export declare const STATIC_PAGES_CACHE_TOKEN: import("@tinkoff/dippy").BaseTokenInterface<Cache<Map<string, StaticPagesCacheEntry>>>;
+export declare const STATIC_PAGES_SHOULD_USE_CACHE: import("@tinkoff/dippy").BaseTokenInterface<() => boolean>;
+export declare const STATIC_PAGES_SHOULD_SET_TO_CACHE: import("@tinkoff/dippy").BaseTokenInterface<() => boolean>;
+export declare const STATIC_PAGES_BACKGROUND_FETCH_ENABLED: import("@tinkoff/dippy").BaseTokenInterface<() => boolean>;
+export declare const STATIC_PAGES_OPTIONS_TOKEN: import("@tinkoff/dippy").BaseTokenInterface<StaticPagesOptions>;
+export declare const STATIC_PAGES_COMMAND_LINE: import("@tinkoff/dippy").BaseTokenInterface<"init" | "listen" | "customerStart" | "resolveUserDeps" | "resolvePageDeps" | "generatePage" | "clear" | "spaTransition" | "afterSpaTransition" | "close">;
+export declare const STATIC_PAGES_MODIFY_CACHE: import("@tinkoff/dippy").MultiTokenInterface<(entry: StaticPagesCacheEntry) => StaticPagesCacheEntry>;
+export declare const STATIC_PAGES_CACHE_5xx_RESPONSE: import("@tinkoff/dippy").BaseTokenInterface<() => boolean>;

package/lib/utils/cacheKey.d.ts

@@ -0,0 +1,8 @@
+export declare const getCacheKey: ({ method, host, path, deviceType, modern, }: {
+    method: string;
+    host: string;
+    path: string;
+    deviceType: 'desktop' | 'mobile';
+    modern: boolean;
+}) => string;
+export declare const parseCacheKey: (key: string) => string[];

package/lib/utils/getPageRenderMode.d.ts

@@ -0,0 +1,8 @@
+import type { ExtractDependencyType } from '@tinkoff/dippy';
+import type { TramvaiRenderMode } from '@tramvai/tokens-render';
+import type { PAGE_SERVICE_TOKEN } from '@tramvai/tokens-router';
+import type { PAGE_RENDER_DEFAULT_MODE } from '../tokens';
+export declare const getPageRenderMode: ({ pageService, defaultRenderMode, }: {
+    pageService: ExtractDependencyType<typeof PAGE_SERVICE_TOKEN>;
+    defaultRenderMode: ExtractDependencyType<typeof PAGE_RENDER_DEFAULT_MODE>;
+}) => TramvaiRenderMode;

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@tramvai/module-page-render-mode",
-  "version": "2.28.0",
+  "version": "2.31.0",
   "description": "Enable different rendering modes for pages",
-  "main": "lib/index.js",
-  "module": "lib/index.es.js",
-  "typings": "lib/index.d.ts",
+  "main": "./lib/server.js",
+  "module": "./lib/server.es.js",
+  "browser": "./lib/browser.js",
+  "typings": "./lib/server.d.ts",
   "files": [
     "lib"
   ],
@@ -22,14 +23,26 @@
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
-  "dependencies": {},
+  "dependencies": {
+    "node-fetch": "^2.6.1",
+    "@tinkoff/errors": "0.3.4",
+    "@tinkoff/url": "0.8.3"
+  },
   "peerDependencies": {
+    "@tinkoff/utils": "^2.1.2",
     "@tinkoff/dippy": "0.8.6",
-    "@tramvai/core": "2.28.0",
-    "@tramvai/react": "2.28.0",
-    "@tramvai/module-router": "2.28.0",
-    "@tramvai/tokens-render": "2.28.0",
-    "@tramvai/tokens-router": "2.28.0",
+    "@tramvai/core": "2.31.0",
+    "@tramvai/react": "2.31.0",
+    "@tramvai/papi": "2.31.0",
+    "@tramvai/module-router": "2.31.0",
+    "@tramvai/module-client-hints": "2.31.0",
+    "@tramvai/tokens-common": "2.31.0",
+    "@tramvai/tokens-core": "2.31.0",
+    "@tramvai/tokens-render": "2.31.0",
+    "@tramvai/tokens-router": "2.31.0",
+    "@tramvai/tokens-server": "2.31.0",
+    "@tramvai/tokens-metrics": "2.31.0",
+    "prom-client": "^12.0.0",
     "react": ">=16.14.0",
     "tslib": "^2.4.0"
   }

package/lib/index.d.ts

@@ -1,3 +0,0 @@
-export * from './tokens';
-export declare class PageRenderModeModule {
-}

package/lib/index.js

@@ -1,99 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var tslib = require('tslib');
-var core = require('@tramvai/core');
-var tokensRender = require('@tramvai/tokens-render');
-var jsxRuntime = require('react/jsx-runtime');
-var react = require('react');
-var react$1 = require('@tramvai/react');
-var tokensRouter = require('@tramvai/tokens-router');
-var moduleRouter = require('@tramvai/module-router');
-var dippy = require('@tinkoff/dippy');
-
-const PAGE_RENDER_FALLBACK_COMPONENT_PREFIX = dippy.createToken('pageRenderFallbackComponentName');
-/**
- * @deprecated Use token `TRAMVAI_RENDER_MODE` from `@tramvai/tokens-render`
- */
-const PAGE_RENDER_DEFAULT_MODE = dippy.createToken('pageRenderDefaultMode');
-const PAGE_RENDER_WRAPPER_TYPE = dippy.createToken('pageRenderWrapperType');
-const PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT = dippy.createToken('pageRenderDefaultFallbackComponent');
-
-const PageRenderWrapper = ({ children }) => {
-    var _a;
-    const [mounted, setMounted] = react.useState(false);
-    const { config } = moduleRouter.useRoute();
-    const pageService = react$1.useDi(tokensRouter.PAGE_SERVICE_TOKEN);
-    const fallbackKey = react$1.useDi(PAGE_RENDER_FALLBACK_COMPONENT_PREFIX);
-    const defaultRenderMode = react$1.useDi(PAGE_RENDER_DEFAULT_MODE);
-    const DefaultFallbackComponent = react$1.useDi({
-        token: PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT,
-        optional: true,
-    });
-    const { pageComponent, pageRenderMode } = config;
-    const { renderMode } = (_a = pageService.getComponent(pageComponent)) !== null && _a !== void 0 ? _a : { renderMode: false };
-    const FallbackComponent = pageService.resolveComponentFromConfig(fallbackKey) || DefaultFallbackComponent;
-    const mode = renderMode || pageRenderMode || defaultRenderMode;
-    react.useEffect(() => {
-        if (mode === 'client') {
-            setMounted(true);
-        }
-        // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, []);
-    if (mode === 'client' && !mounted) {
-        if (FallbackComponent) {
-            return jsxRuntime.jsx(FallbackComponent, {});
-        }
-        return null;
-    }
-    return jsxRuntime.jsx(jsxRuntime.Fragment, { children: children });
-};
-const pageRenderHOC = (WrapperPage) => (props) => {
-    return (jsxRuntime.jsx(PageRenderWrapper, { children: jsxRuntime.jsx(WrapperPage, { ...props }) }));
-};
-
-exports.PageRenderModeModule = class PageRenderModeModule {
-};
-exports.PageRenderModeModule = tslib.__decorate([
-    core.Module({
-        providers: [
-            {
-                provide: tokensRender.LAYOUT_OPTIONS,
-                multi: true,
-                useFactory: ({ wrapperType }) => {
-                    return {
-                        wrappers: {
-                            [wrapperType]: pageRenderHOC,
-                        },
-                    };
-                },
-                deps: {
-                    wrapperType: PAGE_RENDER_WRAPPER_TYPE,
-                },
-            },
-            {
-                provide: PAGE_RENDER_FALLBACK_COMPONENT_PREFIX,
-                useValue: 'pageRenderFallback',
-            },
-            {
-                provide: PAGE_RENDER_DEFAULT_MODE,
-                useFactory: ({ tramvaiRenderMode }) => {
-                    return tramvaiRenderMode;
-                },
-                deps: {
-                    tramvaiRenderMode: tokensRender.TRAMVAI_RENDER_MODE,
-                },
-            },
-            {
-                provide: PAGE_RENDER_WRAPPER_TYPE,
-                useValue: 'page',
-            },
-        ],
-    })
-], exports.PageRenderModeModule);
-
-exports.PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT = PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT;
-exports.PAGE_RENDER_DEFAULT_MODE = PAGE_RENDER_DEFAULT_MODE;
-exports.PAGE_RENDER_FALLBACK_COMPONENT_PREFIX = PAGE_RENDER_FALLBACK_COMPONENT_PREFIX;
-exports.PAGE_RENDER_WRAPPER_TYPE = PAGE_RENDER_WRAPPER_TYPE;