@tramvai/module-page-render-mode 1.74.0 → 1.76.0

package/README.md

@@ -10,7 +10,7 @@ Enable different rendering modes for specific pages:
 
   Client mode - render only fallback for page component, then render full page on browser, after hydration.
   This mode can significally improve server rendering performance, but not recommended for pages with high SEO impact.
-  Header and Footer will be rendered as usual.
+  By default, Header and Footer will be rendered as usual.
 
 ## Installation
 
@@ -41,13 +41,13 @@ You can change this mode for all pages or for specific pages only.
 
 #### Default mode
 
-For global rendering mode changing, use token `PAGE_RENDER_DEFAULT_MODE`:
+For global rendering mode changing, use token `TRAMVAI_RENDER_MODE` from `@tramvai/tokens-render`:
 
 ```ts
-import { PAGE_RENDER_DEFAULT_MODE } from '@tramvai/module-page-render-mode';
+import { TRAMVAI_RENDER_MODE } from '@tramvai/tokens-render';
 
 const provider = {
-  provide: PAGE_RENDER_DEFAULT_MODE,
+  provide: TRAMVAI_RENDER_MODE,
   useValue: 'client',
 };
 ```
@@ -89,7 +89,7 @@ You can set default fallback for all pages with `client` render mode, or only fo
 
 #### Default fallback
 
-For setting default fallback, use token `PAGE_RENDER_DEFAULT_MODE`:
+For setting default fallback, use token `PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT`:
 
 ```tsx
 import { PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT } from '@tramvai/module-page-render-mode';
@@ -149,9 +149,27 @@ For specific pages available few options:
         pageRenderFallbackComponent: 'myOwnFallbackComponent',
       },
     },
-  ]
+  ];
   ```
 
+## How-to
+
+### How to prevent Header and Footer Rendering
+
+By default, Header and Footer will be rendered as usual, because this module provide Page component wrapper.
+If you want to make less work on server, use token `PAGE_RENDER_WRAPPER_TYPE` with `layout` or `content` value, e.g.:
+
+```ts
+const providers = [
+  {
+    provide: PAGE_RENDER_WRAPPER_TYPE,
+    useValue: 'layout',
+  },
+];
+```
+
+With `client` rendering mode, all layout will be rendered in browser.
+
 ## Troubleshooting
 
 ### Fallback name conflicts

package/lib/index.d.ts

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

package/lib/index.es.js

@@ -1,6 +1,6 @@
 import { __decorate } from 'tslib';
 import { Module } from '@tramvai/core';
-import { LAYOUT_OPTIONS } from '@tramvai/tokens-render';
+import { LAYOUT_OPTIONS, TRAMVAI_RENDER_MODE } from '@tramvai/tokens-render';
 import React, { useState, useEffect } from 'react';
 import { useDi } from '@tramvai/react';
 import { PAGE_SERVICE_TOKEN } from '@tramvai/tokens-router';
@@ -8,7 +8,11 @@ import { useRoute } from '@tramvai/module-router';
 import { createToken } from '@tinkoff/dippy';
 
 const PAGE_RENDER_FALLBACK_COMPONENT_PREFIX = createToken('pageRenderFallbackComponentName');
+/**
+ * @deprecated Use token `TRAMVAI_RENDER_MODE` from `@tramvai/tokens-render`
+ */
 const PAGE_RENDER_DEFAULT_MODE = createToken('pageRenderDefaultMode');
+const PAGE_RENDER_WRAPPER_TYPE = createToken('pageRenderWrapperType');
 const PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT = createToken('pageRenderDefaultFallbackComponent');
 
 const PageRenderWrapper = ({ children }) => {
@@ -52,10 +56,15 @@ PageRenderModeModule = __decorate([
             {
                 provide: LAYOUT_OPTIONS,
                 multi: true,
-                useValue: {
-                    wrappers: {
-                        page: pageRenderHOC,
-                    },
+                useFactory: ({ wrapperType }) => {
+                    return {
+                        wrappers: {
+                            [wrapperType]: pageRenderHOC,
+                        },
+                    };
+                },
+                deps: {
+                    wrapperType: PAGE_RENDER_WRAPPER_TYPE,
                 },
             },
             {
@@ -64,10 +73,19 @@ PageRenderModeModule = __decorate([
             },
             {
                 provide: PAGE_RENDER_DEFAULT_MODE,
-                useValue: 'ssr',
+                useFactory: ({ tramvaiRenderMode }) => {
+                    return tramvaiRenderMode;
+                },
+                deps: {
+                    tramvaiRenderMode: TRAMVAI_RENDER_MODE,
+                },
+            },
+            {
+                provide: PAGE_RENDER_WRAPPER_TYPE,
+                useValue: 'page',
             },
         ],
     })
 ], PageRenderModeModule);
 
-export { PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT, PAGE_RENDER_DEFAULT_MODE, PAGE_RENDER_FALLBACK_COMPONENT_PREFIX, PageRenderModeModule };
+export { PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT, PAGE_RENDER_DEFAULT_MODE, PAGE_RENDER_FALLBACK_COMPONENT_PREFIX, PAGE_RENDER_WRAPPER_TYPE, PageRenderModeModule };

package/lib/index.js

@@ -16,7 +16,11 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 
 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 }) => {
@@ -60,10 +64,15 @@ exports.PageRenderModeModule = tslib.__decorate([
             {
                 provide: tokensRender.LAYOUT_OPTIONS,
                 multi: true,
-                useValue: {
-                    wrappers: {
-                        page: pageRenderHOC,
-                    },
+                useFactory: ({ wrapperType }) => {
+                    return {
+                        wrappers: {
+                            [wrapperType]: pageRenderHOC,
+                        },
+                    };
+                },
+                deps: {
+                    wrapperType: PAGE_RENDER_WRAPPER_TYPE,
                 },
             },
             {
@@ -72,7 +81,16 @@ exports.PageRenderModeModule = tslib.__decorate([
             },
             {
                 provide: PAGE_RENDER_DEFAULT_MODE,
-                useValue: 'ssr',
+                useFactory: ({ tramvaiRenderMode }) => {
+                    return tramvaiRenderMode;
+                },
+                deps: {
+                    tramvaiRenderMode: tokensRender.TRAMVAI_RENDER_MODE,
+                },
+            },
+            {
+                provide: PAGE_RENDER_WRAPPER_TYPE,
+                useValue: 'page',
             },
         ],
     })
@@ -81,3 +99,4 @@ exports.PageRenderModeModule = tslib.__decorate([
 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;

package/lib/tokens.d.ts

@@ -1,5 +1,9 @@
 import type { ComponentType } from 'react';
-import type { PageRenderMode } from '.';
+import type { TramvaiRenderMode } from '@tramvai/tokens-render';
 export declare const PAGE_RENDER_FALLBACK_COMPONENT_PREFIX: string;
-export declare const PAGE_RENDER_DEFAULT_MODE: PageRenderMode;
+/**
+ * @deprecated Use token `TRAMVAI_RENDER_MODE` from `@tramvai/tokens-render`
+ */
+export declare const PAGE_RENDER_DEFAULT_MODE: TramvaiRenderMode;
+export declare const PAGE_RENDER_WRAPPER_TYPE: "layout" | "content" | "page";
 export declare const PAGE_RENDER_DEFAULT_FALLBACK_COMPONENT: ComponentType<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-page-render-mode",
-  "version": "1.74.0",
+  "version": "1.76.0",
   "description": "Enable different rendering modes for pages",
   "main": "lib/index.js",
   "module": "lib/index.es.js",
@@ -25,11 +25,11 @@
   "dependencies": {},
   "peerDependencies": {
     "@tinkoff/dippy": "0.7.38",
-    "@tramvai/core": "1.74.0",
-    "@tramvai/react": "1.74.0",
-    "@tramvai/module-router": "1.74.0",
-    "@tramvai/tokens-render": "1.74.0",
-    "@tramvai/tokens-router": "1.74.0",
+    "@tramvai/core": "1.76.0",
+    "@tramvai/react": "1.76.0",
+    "@tramvai/module-router": "1.76.0",
+    "@tramvai/tokens-render": "1.76.0",
+    "@tramvai/tokens-router": "1.76.0",
     "react": ">=16.8.0",
     "tslib": "^2.0.3"
   }

package/lib/types.d.ts

@@ -1 +0,0 @@
-export declare type PageRenderMode = 'ssr' | 'client';