@tramvai/module-child-app 1.49.1 → 1.50.0

package/README.md

@@ -200,6 +200,39 @@ This token is considered dangerous as it leads to high coupling with stores from
    ];
    ```
 
+### Preload child-app
+
+Preloading is vital for using child-app without extensive overhead on its loading.
+
+You may preload using next ways:
+
+1. Preload with `CHILD_APP_PRELOAD_MANAGER_TOKEN`
+
+   ```ts
+   provide({
+     provide: commandLineListTokens.customerStart,
+     multi: true,
+     useFactory: ({ preloadManager }) => {
+       return function preloadHeaderChildApp() {
+         return preloadManager.preload({ name: '[name]' });
+       };
+     },
+     deps: {
+       preloadManager: CHILD_APP_PRELOAD_MANAGER_TOKEN,
+     },
+   });
+   ```
+
+1. Add needed child-apps to the pageComponent or layoutComponent through field `childApps`
+
+```ts
+const PageComponent = () => {
+  return 'Page';
+};
+
+PageComponent.childApps = [{ name: '[name]' }];
+```
+
 ### Debug child-app
 
 #### Single child-app

package/lib/server.browser.js

@@ -6,6 +6,7 @@ import { commandLineListTokens, CHILD_APP_INTERNAL_ROOT_STATE_SUBSCRIPTION_TOKEN
 export * from '@tramvai/tokens-child-app';
 import { ACTION_PAGE_RUNNER_TOKEN, CONTEXT_TOKEN, LOGGER_TOKEN, DISPATCHER_TOKEN, STORE_TOKEN, COMBINE_REDUCERS, ENV_MANAGER_TOKEN, REGISTER_CLEAR_CACHE_TOKEN, CLEAR_CACHE_TOKEN, ENV_USED_TOKEN } from '@tramvai/tokens-common';
 import { RENDER_SLOTS, EXTEND_RENDER } from '@tramvai/tokens-render';
+import { PAGE_SERVICE_TOKEN } from '@tramvai/tokens-router';
 import { Subscription, createEvent, createReducer } from '@tramvai/state';
 import React, { createContext, useContext, useMemo, useState, useEffect, createElement } from 'react';
 import { loadModule } from '@tinkoff/module-loader-client';
@@ -291,6 +292,12 @@ const getModuleFederation = async (container, name = 'entry') => {
     return container.get(name);
 };
 
+const resolveComponent = async (componentOrLoader) => {
+    return 'load' in componentOrLoader && typeof componentOrLoader.load === 'function'
+        ? (await componentOrLoader.load()).default
+        : componentOrLoader;
+};
+
 const sharedProviders = [
     provide({
         provide: COMBINE_REDUCERS,
@@ -417,6 +424,27 @@ const sharedProviders = [
             diManager: CHILD_APP_DI_MANAGER_TOKEN,
         },
     }),
+    provide({
+        provide: commandLineListTokens$1.resolvePageDeps,
+        useFactory: ({ pageService, preloadManager }) => {
+            return async function preloadChildAppByComponent() {
+                var _a, _b, _c, _d;
+                const [layoutComponent, pageComponent] = await Promise.all([
+                    resolveComponent(pageService.resolveComponentFromConfig('layout')),
+                    resolveComponent(pageService.resolveComponentFromConfig('page')),
+                ]);
+                await Promise.all([
+                    ...((_b = (_a = layoutComponent.childApps) === null || _a === void 0 ? void 0 : _a.map((request) => preloadManager.preload(request))) !== null && _b !== void 0 ? _b : []),
+                    ...((_d = (_c = pageComponent.childApps) === null || _c === void 0 ? void 0 : _c.map((request) => preloadManager.preload(request))) !== null && _d !== void 0 ? _d : []),
+                ]);
+            };
+        },
+        multi: true,
+        deps: {
+            pageService: PAGE_SERVICE_TOKEN,
+            preloadManager: CHILD_APP_PRELOAD_MANAGER_TOKEN,
+        },
+    }),
     provide({
         provide: commandLineListTokens$1.clear,
         multi: true,

package/lib/server.es.js

@@ -6,6 +6,7 @@ import { commandLineListTokens, CHILD_APP_INTERNAL_ROOT_STATE_SUBSCRIPTION_TOKEN
 export * from '@tramvai/tokens-child-app';
 import { ACTION_PAGE_RUNNER_TOKEN, CONTEXT_TOKEN, LOGGER_TOKEN, DISPATCHER_TOKEN, STORE_TOKEN, COMBINE_REDUCERS, ENV_MANAGER_TOKEN, REGISTER_CLEAR_CACHE_TOKEN, CLEAR_CACHE_TOKEN, ENV_USED_TOKEN, CREATE_CACHE_TOKEN } from '@tramvai/tokens-common';
 import { RENDER_SLOTS, EXTEND_RENDER, ResourceType, ResourceSlot, RESOURCES_REGISTRY, CUSTOM_RENDER } from '@tramvai/tokens-render';
+import { PAGE_SERVICE_TOKEN } from '@tramvai/tokens-router';
 import { createEvent, createReducer } from '@tramvai/state';
 import React, { createContext, useContext, useMemo, useState, useEffect, createElement } from 'react';
 import { combineValidators, isUrl, endsWith } from '@tinkoff/env-validators';
@@ -289,6 +290,12 @@ const getModuleFederation = async (container, name = 'entry') => {
     return container.get(name);
 };
 
+const resolveComponent = async (componentOrLoader) => {
+    return 'load' in componentOrLoader && typeof componentOrLoader.load === 'function'
+        ? (await componentOrLoader.load()).default
+        : componentOrLoader;
+};
+
 const sharedProviders = [
     provide({
         provide: COMBINE_REDUCERS,
@@ -415,6 +422,27 @@ const sharedProviders = [
             diManager: CHILD_APP_DI_MANAGER_TOKEN,
         },
     }),
+    provide({
+        provide: commandLineListTokens$1.resolvePageDeps,
+        useFactory: ({ pageService, preloadManager }) => {
+            return async function preloadChildAppByComponent() {
+                var _a, _b, _c, _d;
+                const [layoutComponent, pageComponent] = await Promise.all([
+                    resolveComponent(pageService.resolveComponentFromConfig('layout')),
+                    resolveComponent(pageService.resolveComponentFromConfig('page')),
+                ]);
+                await Promise.all([
+                    ...((_b = (_a = layoutComponent.childApps) === null || _a === void 0 ? void 0 : _a.map((request) => preloadManager.preload(request))) !== null && _b !== void 0 ? _b : []),
+                    ...((_d = (_c = pageComponent.childApps) === null || _c === void 0 ? void 0 : _c.map((request) => preloadManager.preload(request))) !== null && _d !== void 0 ? _d : []),
+                ]);
+            };
+        },
+        multi: true,
+        deps: {
+            pageService: PAGE_SERVICE_TOKEN,
+            preloadManager: CHILD_APP_PRELOAD_MANAGER_TOKEN,
+        },
+    }),
     provide({
         provide: commandLineListTokens$1.clear,
         multi: true,

package/lib/server.js

@@ -9,6 +9,7 @@ var dippy = require('@tinkoff/dippy');
 var tokensChildApp = require('@tramvai/tokens-child-app');
 var tokensCommon = require('@tramvai/tokens-common');
 var tokensRender = require('@tramvai/tokens-render');
+var tokensRouter = require('@tramvai/tokens-router');
 var state = require('@tramvai/state');
 var React = require('react');
 var envValidators = require('@tinkoff/env-validators');
@@ -298,6 +299,12 @@ const getModuleFederation = async (container, name = 'entry') => {
     return container.get(name);
 };
 
+const resolveComponent = async (componentOrLoader) => {
+    return 'load' in componentOrLoader && typeof componentOrLoader.load === 'function'
+        ? (await componentOrLoader.load()).default
+        : componentOrLoader;
+};
+
 const sharedProviders = [
     core.provide({
         provide: tokensCommon.COMBINE_REDUCERS,
@@ -424,6 +431,27 @@ const sharedProviders = [
             diManager: tokensChildApp.CHILD_APP_DI_MANAGER_TOKEN,
         },
     }),
+    core.provide({
+        provide: core.commandLineListTokens.resolvePageDeps,
+        useFactory: ({ pageService, preloadManager }) => {
+            return async function preloadChildAppByComponent() {
+                var _a, _b, _c, _d;
+                const [layoutComponent, pageComponent] = await Promise.all([
+                    resolveComponent(pageService.resolveComponentFromConfig('layout')),
+                    resolveComponent(pageService.resolveComponentFromConfig('page')),
+                ]);
+                await Promise.all([
+                    ...((_b = (_a = layoutComponent.childApps) === null || _a === void 0 ? void 0 : _a.map((request) => preloadManager.preload(request))) !== null && _b !== void 0 ? _b : []),
+                    ...((_d = (_c = pageComponent.childApps) === null || _c === void 0 ? void 0 : _c.map((request) => preloadManager.preload(request))) !== null && _d !== void 0 ? _d : []),
+                ]);
+            };
+        },
+        multi: true,
+        deps: {
+            pageService: tokensRouter.PAGE_SERVICE_TOKEN,
+            preloadManager: tokensChildApp.CHILD_APP_PRELOAD_MANAGER_TOKEN,
+        },
+    }),
     core.provide({
         provide: core.commandLineListTokens.clear,
         multi: true,

package/lib/shared/providers.d.ts

@@ -1,2 +1,8 @@
 import type { Provider } from '@tinkoff/dippy';
+import type { ChildAppRequestConfig } from '@tramvai/tokens-child-app';
+declare module '@tramvai/tokens-common' {
+    interface RegistryComponentExtend {
+        childApps?: ChildAppRequestConfig[];
+    }
+}
 export declare const sharedProviders: Provider[];

package/lib/shared/utils/resolveComponent.d.ts

@@ -0,0 +1,6 @@
+import type { Component } from '@tramvai/tokens-common';
+export declare const resolveComponent: <T extends Component>(componentOrLoader: T | {
+    load: () => Promise<{
+        default: T;
+    }>;
+}) => Promise<T>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-child-app",
-  "version": "1.49.1",
+  "version": "1.50.0",
   "description": "Module for child apps",
   "browser": {
     "./lib/server.js": "./lib/browser.js",
@@ -30,19 +30,20 @@
     "@tinkoff/env-validators": "0.0.2",
     "@tinkoff/module-loader-client": "0.3.25",
     "@tinkoff/module-loader-server": "0.4.41",
-    "@tramvai/child-app-core": "1.49.1",
+    "@tramvai/child-app-core": "1.50.0",
     "@tramvai/safe-strings": "0.4.3",
-    "@tramvai/tokens-child-app": "1.49.1"
+    "@tramvai/tokens-child-app": "1.50.0"
   },
   "devDependencies": {},
   "peerDependencies": {
     "@tinkoff/dippy": "0.7.36",
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/core": "1.49.1",
-    "@tramvai/state": "1.49.1",
-    "@tramvai/react": "1.49.1",
-    "@tramvai/tokens-common": "1.49.1",
-    "@tramvai/tokens-render": "1.49.1",
+    "@tramvai/core": "1.50.0",
+    "@tramvai/state": "1.50.0",
+    "@tramvai/react": "1.50.0",
+    "@tramvai/tokens-common": "1.50.0",
+    "@tramvai/tokens-render": "1.50.0",
+    "@tramvai/tokens-router": "1.50.0",
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
     "object-assign": "^4.1.1",