@tramvai/tokens-child-app 4.18.4 → 4.19.0

package/lib/index.d.ts

@@ -6,7 +6,7 @@ import type { ActionsRegistry } from '@tramvai/tokens-common';
 import type { LazyComponentWrapper } from '@tramvai/react';
 import type { StoreClass } from '@tramvai/state';
 import type { ChunkExtractor } from '@loadable/server';
-import type { ChildAppLoader, ChildAppDiManager, ChildAppPreloadManager, ChildAppCommandLineRunner, ChildAppRequestConfig, WrapperProps, RootStateSubscription, ChildAppStateManager, ChildAppFinalConfig, ChildAppRenderManager, ChildAppResolutionConfig, ResolutionConfig } from './types';
+import type { ChildAppLoader, ChildAppDiManager, ChildAppPreloadManager, ChildAppCommandLineRunner, ChildAppRequestConfig, WrapperProps, RootStateSubscription, ChildAppStateManager, ChildAppFinalConfig, ChildAppRenderManager, ChildAppResolutionConfig, ResolutionConfig, HostProvidedContracts, ChildAppContractManager } from './types';
 export * from './types';
 /**
  * @public
@@ -132,6 +132,15 @@ export declare const IS_CHILD_APP_DI_TOKEN: (false & {
 }) | (true & {
     __type?: "base token" | undefined;
 });
+/**
+ * @private
+ * @description boolean flag indicating that current child-app version support contracts
+ */
+export declare const IS_CHILD_APP_CONTRACTS_COMPATIBLE_TOKEN: (false & {
+    __type?: "base token" | undefined;
+}) | (true & {
+    __type?: "base token" | undefined;
+});
 /**
  * @private
  * @description Manages Singleton-Scope DIs for every child app
@@ -179,6 +188,10 @@ export declare const CHILD_APP_COMMAND_LINE_RUNNER_TOKEN: ChildAppCommandLineRun
  * @description Stores the common server-dehydrated state for all of child apps
  */
 export declare const CHILD_APP_COMMON_INITIAL_STATE_TOKEN: Record<string, {
+    /**
+     * @public
+     * @description CommandLineRunner steps specific for child app
+     */
     stores: Record<string, any>;
 } & {
     __type?: "base token" | undefined;
@@ -271,4 +284,13 @@ export declare const CHILD_APP_ROOT_DI_ACCESS_MODE_TOKEN: ({
 } & {
     __type?: "base token" | undefined;
 });
+export declare const CHILD_APP_CONTRACT_MANAGER: ChildAppContractManager & {
+    __type?: "base token" | undefined;
+};
+export declare const HOST_PROVIDED_CONTRACTS: HostProvidedContracts & {
+    __type?: "multi token" | undefined;
+};
+export declare const CHILD_REQUIRED_CONTRACTS: import("./types").Contracts & {
+    __type?: "multi token" | undefined;
+};
 //# 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';
 
 const multiOptions = { multi: true };
 /**
@@ -78,6 +78,11 @@ const CHILD_APP_INTERNAL_ROOT_DI_BORROW_TOKEN = createToken('child-app root di b
  * @description boolean flag indicating that current di if for a child-app
  */
 const IS_CHILD_APP_DI_TOKEN = createToken('child-app isChildApp Di');
+/**
+ * @private
+ * @description boolean flag indicating that current child-app version support contracts
+ */
+const IS_CHILD_APP_CONTRACTS_COMPATIBLE_TOKEN = createToken('child-app contracts compatible');
 /**
  * @private
  * @description Manages Singleton-Scope DIs for every child app
@@ -153,6 +158,9 @@ const CHILD_APP_RENDER_CHILDREN_TOKEN = createToken('child-app render children')
  * - allow full access - `{ mode: 'blacklist', list: [] }`
  * - block any access - `{ mode: 'whitelist', list: [] }`
  */
-const CHILD_APP_ROOT_DI_ACCESS_MODE_TOKEN = createToken('child-app root di access mode');
+const CHILD_APP_ROOT_DI_ACCESS_MODE_TOKEN = createToken('child-app root di access mode', { scope: Scope.SINGLETON });
+const CHILD_APP_CONTRACT_MANAGER = createToken('child-app contract manager', { scope: Scope.SINGLETON });
+const HOST_PROVIDED_CONTRACTS = createToken('child-app host provided contracts', { multi: true, scope: Scope.SINGLETON });
+const CHILD_REQUIRED_CONTRACTS = createToken('child-app child required contracts', { multi: true, scope: Scope.SINGLETON });
 
-export { CHILD_APP_ACTIONS_REGISTRY_TOKEN, CHILD_APP_COMMAND_LINE_RUNNER_TOKEN, CHILD_APP_COMMON_INITIAL_STATE_TOKEN, CHILD_APP_DI_MANAGER_TOKEN, CHILD_APP_INTERNAL_ACTION_TOKEN, CHILD_APP_INTERNAL_CHUNK_EXTRACTOR, CHILD_APP_INTERNAL_CONFIG_TOKEN, CHILD_APP_INTERNAL_RENDER_TOKEN, CHILD_APP_INTERNAL_ROOT_DI_BORROW_TOKEN, CHILD_APP_INTERNAL_ROOT_STATE_ALLOWED_STORE_TOKEN, CHILD_APP_INTERNAL_ROOT_STATE_SUBSCRIPTION_TOKEN, CHILD_APP_LOADER_TOKEN, CHILD_APP_PAGE_COMPONENTS_TOKEN, CHILD_APP_PAGE_SERVICE_TOKEN, CHILD_APP_PRELOAD_MANAGER_TOKEN, CHILD_APP_RENDER_CHILDREN_TOKEN, CHILD_APP_RENDER_MANAGER_TOKEN, CHILD_APP_RESOLUTION_CONFIGS_TOKEN, CHILD_APP_RESOLUTION_CONFIG_MANAGER_TOKEN, CHILD_APP_RESOLVE_BASE_URL_TOKEN, CHILD_APP_RESOLVE_CONFIG_TOKEN, CHILD_APP_ROOT_DI_ACCESS_MODE_TOKEN, CHILD_APP_SINGLETON_DI_MANAGER_TOKEN, CHILD_APP_STATE_MANAGER_TOKEN, IS_CHILD_APP_DI_TOKEN, commandLineListTokens };
+export { CHILD_APP_ACTIONS_REGISTRY_TOKEN, CHILD_APP_COMMAND_LINE_RUNNER_TOKEN, CHILD_APP_COMMON_INITIAL_STATE_TOKEN, CHILD_APP_CONTRACT_MANAGER, CHILD_APP_DI_MANAGER_TOKEN, CHILD_APP_INTERNAL_ACTION_TOKEN, CHILD_APP_INTERNAL_CHUNK_EXTRACTOR, CHILD_APP_INTERNAL_CONFIG_TOKEN, CHILD_APP_INTERNAL_RENDER_TOKEN, CHILD_APP_INTERNAL_ROOT_DI_BORROW_TOKEN, CHILD_APP_INTERNAL_ROOT_STATE_ALLOWED_STORE_TOKEN, CHILD_APP_INTERNAL_ROOT_STATE_SUBSCRIPTION_TOKEN, CHILD_APP_LOADER_TOKEN, CHILD_APP_PAGE_COMPONENTS_TOKEN, CHILD_APP_PAGE_SERVICE_TOKEN, CHILD_APP_PRELOAD_MANAGER_TOKEN, CHILD_APP_RENDER_CHILDREN_TOKEN, CHILD_APP_RENDER_MANAGER_TOKEN, CHILD_APP_RESOLUTION_CONFIGS_TOKEN, CHILD_APP_RESOLUTION_CONFIG_MANAGER_TOKEN, CHILD_APP_RESOLVE_BASE_URL_TOKEN, CHILD_APP_RESOLVE_CONFIG_TOKEN, CHILD_APP_ROOT_DI_ACCESS_MODE_TOKEN, CHILD_APP_SINGLETON_DI_MANAGER_TOKEN, CHILD_APP_STATE_MANAGER_TOKEN, CHILD_REQUIRED_CONTRACTS, HOST_PROVIDED_CONTRACTS, IS_CHILD_APP_CONTRACTS_COMPATIBLE_TOKEN, IS_CHILD_APP_DI_TOKEN, commandLineListTokens };

package/lib/index.js

@@ -82,6 +82,11 @@ const CHILD_APP_INTERNAL_ROOT_DI_BORROW_TOKEN = dippy.createToken('child-app roo
  * @description boolean flag indicating that current di if for a child-app
  */
 const IS_CHILD_APP_DI_TOKEN = dippy.createToken('child-app isChildApp Di');
+/**
+ * @private
+ * @description boolean flag indicating that current child-app version support contracts
+ */
+const IS_CHILD_APP_CONTRACTS_COMPATIBLE_TOKEN = dippy.createToken('child-app contracts compatible');
 /**
  * @private
  * @description Manages Singleton-Scope DIs for every child app
@@ -157,11 +162,15 @@ const CHILD_APP_RENDER_CHILDREN_TOKEN = dippy.createToken('child-app render chil
  * - allow full access - `{ mode: 'blacklist', list: [] }`
  * - block any access - `{ mode: 'whitelist', list: [] }`
  */
-const CHILD_APP_ROOT_DI_ACCESS_MODE_TOKEN = dippy.createToken('child-app root di access mode');
+const CHILD_APP_ROOT_DI_ACCESS_MODE_TOKEN = dippy.createToken('child-app root di access mode', { scope: dippy.Scope.SINGLETON });
+const CHILD_APP_CONTRACT_MANAGER = dippy.createToken('child-app contract manager', { scope: dippy.Scope.SINGLETON });
+const HOST_PROVIDED_CONTRACTS = dippy.createToken('child-app host provided contracts', { multi: true, scope: dippy.Scope.SINGLETON });
+const CHILD_REQUIRED_CONTRACTS = dippy.createToken('child-app child required contracts', { multi: true, scope: dippy.Scope.SINGLETON });
 
 exports.CHILD_APP_ACTIONS_REGISTRY_TOKEN = CHILD_APP_ACTIONS_REGISTRY_TOKEN;
 exports.CHILD_APP_COMMAND_LINE_RUNNER_TOKEN = CHILD_APP_COMMAND_LINE_RUNNER_TOKEN;
 exports.CHILD_APP_COMMON_INITIAL_STATE_TOKEN = CHILD_APP_COMMON_INITIAL_STATE_TOKEN;
+exports.CHILD_APP_CONTRACT_MANAGER = CHILD_APP_CONTRACT_MANAGER;
 exports.CHILD_APP_DI_MANAGER_TOKEN = CHILD_APP_DI_MANAGER_TOKEN;
 exports.CHILD_APP_INTERNAL_ACTION_TOKEN = CHILD_APP_INTERNAL_ACTION_TOKEN;
 exports.CHILD_APP_INTERNAL_CHUNK_EXTRACTOR = CHILD_APP_INTERNAL_CHUNK_EXTRACTOR;
@@ -183,5 +192,8 @@ exports.CHILD_APP_RESOLVE_CONFIG_TOKEN = CHILD_APP_RESOLVE_CONFIG_TOKEN;
 exports.CHILD_APP_ROOT_DI_ACCESS_MODE_TOKEN = CHILD_APP_ROOT_DI_ACCESS_MODE_TOKEN;
 exports.CHILD_APP_SINGLETON_DI_MANAGER_TOKEN = CHILD_APP_SINGLETON_DI_MANAGER_TOKEN;
 exports.CHILD_APP_STATE_MANAGER_TOKEN = CHILD_APP_STATE_MANAGER_TOKEN;
+exports.CHILD_REQUIRED_CONTRACTS = CHILD_REQUIRED_CONTRACTS;
+exports.HOST_PROVIDED_CONTRACTS = HOST_PROVIDED_CONTRACTS;
+exports.IS_CHILD_APP_CONTRACTS_COMPATIBLE_TOKEN = IS_CHILD_APP_CONTRACTS_COMPATIBLE_TOKEN;
 exports.IS_CHILD_APP_DI_TOKEN = IS_CHILD_APP_DI_TOKEN;
 exports.commandLineListTokens = commandLineListTokens;

package/lib/types.d.ts

@@ -1,5 +1,5 @@
 import type { ComponentType } from 'react';
-import type { Container, Provider } from '@tinkoff/dippy';
+import type { Container, Provider, TokenInterface } from '@tinkoff/dippy';
 import type { CommandLines, CommandLineDescription, ModuleType, ExtendedModule, Action, TramvaiAction } from '@tramvai/core';
 import type { Route } from '@tinkoff/router';
 export interface ChildApp {
@@ -94,5 +94,15 @@ export interface RootStateSubscription {
     stores: Array<Store | OptionalStore>;
     listener: (state: Record<string, any>) => void;
 }
+export interface ChildAppContractManager {
+    registerChildContracts(childDi: Container): void;
+}
+export type Contract = TokenInterface;
+export type Contracts = Contract[];
+export type ChildRequiredContracts = Contracts;
+export type HostProvidedContracts = {
+    childAppName?: string;
+    providedContracts: Contracts;
+};
 export {};
 //# sourceMappingURL=types.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/tokens-child-app",
-  "version": "4.18.4",
+  "version": "4.19.0",
   "description": "",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -20,12 +20,12 @@
     "registry": "https://registry.npmjs.org/"
   },
   "peerDependencies": {
-    "@tinkoff/dippy": "0.10.6",
-    "@tinkoff/router": "0.4.56",
-    "@tramvai/core": "4.18.4",
-    "@tramvai/react": "4.18.4",
-    "@tramvai/state": "4.18.4",
-    "@tramvai/tokens-common": "4.18.4",
+    "@tinkoff/dippy": "0.10.7",
+    "@tinkoff/router": "0.4.58",
+    "@tramvai/core": "4.19.0",
+    "@tramvai/react": "4.19.0",
+    "@tramvai/state": "4.19.0",
+    "@tramvai/tokens-common": "4.19.0",
     "@loadable/server": "*",
     "react": ">=16.14.0"
   },