@tramvai/tokens-child-app 1.46.5

package/README.md

@@ -0,0 +1,3 @@
+# Child-app tokens
+
+@inline src/index.ts

package/lib/index.d.ts

@@ -0,0 +1,112 @@
+import type { Action, Command } from '@tramvai/core';
+import type { ComponentType } from 'react';
+import type { ChildAppLoader, ChildAppDiManager, ChildAppPreloadManager, ChildAppCommandLineRunner, ChildAppRequestConfig, WrapperProps, RootStateSubscription, ChildAppStateManager, ChildAppFinalConfig, ChildAppRenderManager, ChildAppResolutionConfig, ResolutionConfig } from './types';
+export * from './types';
+/**
+ * @public
+ * @description CommandLineRunner steps specific for child app
+ */
+export declare const commandLineListTokens: {
+    customerStart: Command;
+    resolveUserDeps: Command;
+    resolvePageDeps: Command;
+    clear: Command;
+    spaTransition: Command;
+};
+/**
+ * @public
+ * @description Contains child app configs that was used to figure out how to load child apps
+ */
+export declare const CHILD_APP_RESOLUTION_CONFIGS_TOKEN: ChildAppResolutionConfig[];
+/**
+ * @public
+ * @description async function to execute any preload action before any child-app starts execute
+ */
+export declare const CHILD_APP_PRELOAD_EXTERNAL_CONFIG_TOKEN: () => Promise<void>;
+/**
+ * @public
+ * @description Used to resolve resolution config for a specific child-app
+ */
+export declare const CHILD_APP_GET_RESOLUTION_CONFIG_TOKEN: (config: ChildAppRequestConfig) => ResolutionConfig;
+/**
+ * @public
+ * @description Used to resolve external config with urls to external code entries
+ */
+export declare const CHILD_APP_RESOLVE_CONFIG_TOKEN: (config: ChildAppRequestConfig) => ChildAppFinalConfig;
+/**
+ * @public
+ * @description Base url for external urls for child apps on client
+ */
+export declare const CHILD_APP_RESOLVE_BASE_URL_TOKEN: string;
+/**
+ * @public
+ * @description Allows to preload child app for the specific page
+ */
+export declare const CHILD_APP_PRELOAD_MANAGER_TOKEN: ChildAppPreloadManager;
+/**
+ * @public
+ * @description Contains child app config that was used to load current child app
+ */
+export declare const CHILD_APP_INTERNAL_CONFIG_TOKEN: ChildAppFinalConfig;
+/**
+ * @public
+ * @description Actions of child app
+ */
+export declare const CHILD_APP_INTERNAL_ACTION_TOKEN: Action<any, any, any>;
+/**
+ * @public
+ * @description Subscription on a root state updates
+ */
+export declare const CHILD_APP_INTERNAL_ROOT_STATE_SUBSCRIPTION_TOKEN: RootStateSubscription;
+/**
+ * @public
+ * @description Allows to recreate token implementation the same way as in root di, but specific to child-app di
+ */
+export declare const CHILD_APP_INTERNAL_ROOT_DI_BORROW_TOKEN: any;
+/**
+ * @private
+ * @description boolean flag indicating that current di if for a child-app
+ */
+export declare const IS_CHILD_APP_DI_TOKEN: boolean;
+/**
+ * @private
+ * @description Manages Singleton-Scope DIs for every child app
+ */
+export declare const CHILD_APP_SINGLETON_DI_MANAGER_TOKEN: ChildAppDiManager;
+/**
+ * @private
+ * @description Manages Request-Scope DIs for every child app
+ */
+export declare const CHILD_APP_DI_MANAGER_TOKEN: ChildAppDiManager;
+/**
+ * @private
+ * @description Bridge from React render to di providers for child apps
+ */
+export declare const CHILD_APP_RENDER_MANAGER_TOKEN: ChildAppRenderManager;
+/**
+ * @private
+ * @description Manages state dehydration for child-app
+ */
+export declare const CHILD_APP_STATE_MANAGER_TOKEN: ChildAppStateManager;
+/**
+ * @private
+ * @description Manages loading child-app resources from the external place
+ */
+export declare const CHILD_APP_LOADER_TOKEN: ChildAppLoader;
+/**
+ * @private
+ * @description Implements CommandLineRunner for child apps
+ */
+export declare const CHILD_APP_COMMAND_LINE_RUNNER_TOKEN: ChildAppCommandLineRunner;
+/**
+ * @private
+ * @description Stores the common server-dehydrated state for all of child apps
+ */
+export declare const CHILD_APP_COMMON_INITIAL_STATE_TOKEN: Record<string, {
+    stores: Record<string, any>;
+}>;
+/**
+ * @private
+ * @description Used as render function for a child app. Usually implemented as a wrapper over child app render itself with an additional logic for di and connections to root app
+ */
+export declare const CHILD_APP_INTERNAL_RENDER_TOKEN: ComponentType<WrapperProps<any>>;

package/lib/index.es.js

@@ -0,0 +1,114 @@
+import { createToken } from '@tinkoff/dippy';
+
+const multiOptions = { multi: true };
+/**
+ * @public
+ * @description CommandLineRunner steps specific for child app
+ */
+const commandLineListTokens = {
+    // section: client processing
+    customerStart: createToken('child-app customer_start', multiOptions),
+    resolveUserDeps: createToken('child-app resolve_user_deps', multiOptions),
+    resolvePageDeps: createToken('child-app resolve_page_deps', multiOptions),
+    // section: clear data
+    clear: createToken('child-app clear', multiOptions),
+    // section: spa transitions
+    spaTransition: createToken('child-app spa_transition', multiOptions),
+};
+/**
+ * @public
+ * @description Contains child app configs that was used to figure out how to load child apps
+ */
+const CHILD_APP_RESOLUTION_CONFIGS_TOKEN = createToken('child-app resolve configs');
+/**
+ * @public
+ * @description async function to execute any preload action before any child-app starts execute
+ */
+const CHILD_APP_PRELOAD_EXTERNAL_CONFIG_TOKEN = createToken('child-app preload external config');
+/**
+ * @public
+ * @description Used to resolve resolution config for a specific child-app
+ */
+const CHILD_APP_GET_RESOLUTION_CONFIG_TOKEN = createToken('child-app get resolution config');
+/**
+ * @public
+ * @description Used to resolve external config with urls to external code entries
+ */
+const CHILD_APP_RESOLVE_CONFIG_TOKEN = createToken('child-app resolve external config');
+/**
+ * @public
+ * @description Base url for external urls for child apps on client
+ */
+const CHILD_APP_RESOLVE_BASE_URL_TOKEN = createToken('child-app resolve external base url');
+/**
+ * @public
+ * @description Allows to preload child app for the specific page
+ */
+const CHILD_APP_PRELOAD_MANAGER_TOKEN = createToken('child-app preload manager');
+/**
+ * @public
+ * @description Contains child app config that was used to load current child app
+ */
+const CHILD_APP_INTERNAL_CONFIG_TOKEN = createToken('child-app current config');
+/**
+ * @public
+ * @description Actions of child app
+ */
+const CHILD_APP_INTERNAL_ACTION_TOKEN = createToken('child-app action', multiOptions);
+/**
+ * @public
+ * @description Subscription on a root state updates
+ */
+const CHILD_APP_INTERNAL_ROOT_STATE_SUBSCRIPTION_TOKEN = createToken('child-app root state subscription', multiOptions);
+/**
+ * @public
+ * @description Allows to recreate token implementation the same way as in root di, but specific to child-app di
+ */
+const CHILD_APP_INTERNAL_ROOT_DI_BORROW_TOKEN = createToken('child-app root di borrow', multiOptions);
+/**
+ * @private
+ * @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 Manages Singleton-Scope DIs for every child app
+ */
+const CHILD_APP_SINGLETON_DI_MANAGER_TOKEN = createToken('child-app singleton di manager');
+/**
+ * @private
+ * @description Manages Request-Scope DIs for every child app
+ */
+const CHILD_APP_DI_MANAGER_TOKEN = createToken('child-app di manager');
+/**
+ * @private
+ * @description Bridge from React render to di providers for child apps
+ */
+const CHILD_APP_RENDER_MANAGER_TOKEN = createToken('child-app render manager');
+/**
+ * @private
+ * @description Manages state dehydration for child-app
+ */
+const CHILD_APP_STATE_MANAGER_TOKEN = createToken('child-app state manager');
+/**
+ * @private
+ * @description Manages loading child-app resources from the external place
+ */
+const CHILD_APP_LOADER_TOKEN = createToken('child-app loader');
+/**
+ * @private
+ * @description Implements CommandLineRunner for child apps
+ */
+const CHILD_APP_COMMAND_LINE_RUNNER_TOKEN = createToken('child-app command runner');
+/**
+ * @private
+ * @description Stores the common server-dehydrated state for all of child apps
+ */
+const CHILD_APP_COMMON_INITIAL_STATE_TOKEN = createToken('child-app initialAppState');
+/**
+ * @private
+ * @description Used as render function for a child app. Usually implemented as a wrapper over child app render itself with an additional logic for di and connections to root app
+ */
+const CHILD_APP_INTERNAL_RENDER_TOKEN = createToken('child-app render');
+
+export { CHILD_APP_COMMAND_LINE_RUNNER_TOKEN, CHILD_APP_COMMON_INITIAL_STATE_TOKEN, CHILD_APP_DI_MANAGER_TOKEN, CHILD_APP_GET_RESOLUTION_CONFIG_TOKEN, CHILD_APP_INTERNAL_ACTION_TOKEN, CHILD_APP_INTERNAL_CONFIG_TOKEN, CHILD_APP_INTERNAL_RENDER_TOKEN, CHILD_APP_INTERNAL_ROOT_DI_BORROW_TOKEN, CHILD_APP_INTERNAL_ROOT_STATE_SUBSCRIPTION_TOKEN, CHILD_APP_LOADER_TOKEN, CHILD_APP_PRELOAD_EXTERNAL_CONFIG_TOKEN, CHILD_APP_PRELOAD_MANAGER_TOKEN, CHILD_APP_RENDER_MANAGER_TOKEN, CHILD_APP_RESOLUTION_CONFIGS_TOKEN, CHILD_APP_RESOLVE_BASE_URL_TOKEN, CHILD_APP_RESOLVE_CONFIG_TOKEN, CHILD_APP_SINGLETON_DI_MANAGER_TOKEN, CHILD_APP_STATE_MANAGER_TOKEN, IS_CHILD_APP_DI_TOKEN, commandLineListTokens };

package/lib/index.js

@@ -0,0 +1,137 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var dippy = require('@tinkoff/dippy');
+
+const multiOptions = { multi: true };
+/**
+ * @public
+ * @description CommandLineRunner steps specific for child app
+ */
+const commandLineListTokens = {
+    // section: client processing
+    customerStart: dippy.createToken('child-app customer_start', multiOptions),
+    resolveUserDeps: dippy.createToken('child-app resolve_user_deps', multiOptions),
+    resolvePageDeps: dippy.createToken('child-app resolve_page_deps', multiOptions),
+    // section: clear data
+    clear: dippy.createToken('child-app clear', multiOptions),
+    // section: spa transitions
+    spaTransition: dippy.createToken('child-app spa_transition', multiOptions),
+};
+/**
+ * @public
+ * @description Contains child app configs that was used to figure out how to load child apps
+ */
+const CHILD_APP_RESOLUTION_CONFIGS_TOKEN = dippy.createToken('child-app resolve configs');
+/**
+ * @public
+ * @description async function to execute any preload action before any child-app starts execute
+ */
+const CHILD_APP_PRELOAD_EXTERNAL_CONFIG_TOKEN = dippy.createToken('child-app preload external config');
+/**
+ * @public
+ * @description Used to resolve resolution config for a specific child-app
+ */
+const CHILD_APP_GET_RESOLUTION_CONFIG_TOKEN = dippy.createToken('child-app get resolution config');
+/**
+ * @public
+ * @description Used to resolve external config with urls to external code entries
+ */
+const CHILD_APP_RESOLVE_CONFIG_TOKEN = dippy.createToken('child-app resolve external config');
+/**
+ * @public
+ * @description Base url for external urls for child apps on client
+ */
+const CHILD_APP_RESOLVE_BASE_URL_TOKEN = dippy.createToken('child-app resolve external base url');
+/**
+ * @public
+ * @description Allows to preload child app for the specific page
+ */
+const CHILD_APP_PRELOAD_MANAGER_TOKEN = dippy.createToken('child-app preload manager');
+/**
+ * @public
+ * @description Contains child app config that was used to load current child app
+ */
+const CHILD_APP_INTERNAL_CONFIG_TOKEN = dippy.createToken('child-app current config');
+/**
+ * @public
+ * @description Actions of child app
+ */
+const CHILD_APP_INTERNAL_ACTION_TOKEN = dippy.createToken('child-app action', multiOptions);
+/**
+ * @public
+ * @description Subscription on a root state updates
+ */
+const CHILD_APP_INTERNAL_ROOT_STATE_SUBSCRIPTION_TOKEN = dippy.createToken('child-app root state subscription', multiOptions);
+/**
+ * @public
+ * @description Allows to recreate token implementation the same way as in root di, but specific to child-app di
+ */
+const CHILD_APP_INTERNAL_ROOT_DI_BORROW_TOKEN = dippy.createToken('child-app root di borrow', multiOptions);
+/**
+ * @private
+ * @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 Manages Singleton-Scope DIs for every child app
+ */
+const CHILD_APP_SINGLETON_DI_MANAGER_TOKEN = dippy.createToken('child-app singleton di manager');
+/**
+ * @private
+ * @description Manages Request-Scope DIs for every child app
+ */
+const CHILD_APP_DI_MANAGER_TOKEN = dippy.createToken('child-app di manager');
+/**
+ * @private
+ * @description Bridge from React render to di providers for child apps
+ */
+const CHILD_APP_RENDER_MANAGER_TOKEN = dippy.createToken('child-app render manager');
+/**
+ * @private
+ * @description Manages state dehydration for child-app
+ */
+const CHILD_APP_STATE_MANAGER_TOKEN = dippy.createToken('child-app state manager');
+/**
+ * @private
+ * @description Manages loading child-app resources from the external place
+ */
+const CHILD_APP_LOADER_TOKEN = dippy.createToken('child-app loader');
+/**
+ * @private
+ * @description Implements CommandLineRunner for child apps
+ */
+const CHILD_APP_COMMAND_LINE_RUNNER_TOKEN = dippy.createToken('child-app command runner');
+/**
+ * @private
+ * @description Stores the common server-dehydrated state for all of child apps
+ */
+const CHILD_APP_COMMON_INITIAL_STATE_TOKEN = dippy.createToken('child-app initialAppState');
+/**
+ * @private
+ * @description Used as render function for a child app. Usually implemented as a wrapper over child app render itself with an additional logic for di and connections to root app
+ */
+const CHILD_APP_INTERNAL_RENDER_TOKEN = dippy.createToken('child-app render');
+
+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_DI_MANAGER_TOKEN = CHILD_APP_DI_MANAGER_TOKEN;
+exports.CHILD_APP_GET_RESOLUTION_CONFIG_TOKEN = CHILD_APP_GET_RESOLUTION_CONFIG_TOKEN;
+exports.CHILD_APP_INTERNAL_ACTION_TOKEN = CHILD_APP_INTERNAL_ACTION_TOKEN;
+exports.CHILD_APP_INTERNAL_CONFIG_TOKEN = CHILD_APP_INTERNAL_CONFIG_TOKEN;
+exports.CHILD_APP_INTERNAL_RENDER_TOKEN = CHILD_APP_INTERNAL_RENDER_TOKEN;
+exports.CHILD_APP_INTERNAL_ROOT_DI_BORROW_TOKEN = CHILD_APP_INTERNAL_ROOT_DI_BORROW_TOKEN;
+exports.CHILD_APP_INTERNAL_ROOT_STATE_SUBSCRIPTION_TOKEN = CHILD_APP_INTERNAL_ROOT_STATE_SUBSCRIPTION_TOKEN;
+exports.CHILD_APP_LOADER_TOKEN = CHILD_APP_LOADER_TOKEN;
+exports.CHILD_APP_PRELOAD_EXTERNAL_CONFIG_TOKEN = CHILD_APP_PRELOAD_EXTERNAL_CONFIG_TOKEN;
+exports.CHILD_APP_PRELOAD_MANAGER_TOKEN = CHILD_APP_PRELOAD_MANAGER_TOKEN;
+exports.CHILD_APP_RENDER_MANAGER_TOKEN = CHILD_APP_RENDER_MANAGER_TOKEN;
+exports.CHILD_APP_RESOLUTION_CONFIGS_TOKEN = CHILD_APP_RESOLUTION_CONFIGS_TOKEN;
+exports.CHILD_APP_RESOLVE_BASE_URL_TOKEN = CHILD_APP_RESOLVE_BASE_URL_TOKEN;
+exports.CHILD_APP_RESOLVE_CONFIG_TOKEN = CHILD_APP_RESOLVE_CONFIG_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.IS_CHILD_APP_DI_TOKEN = IS_CHILD_APP_DI_TOKEN;
+exports.commandLineListTokens = commandLineListTokens;

package/lib/types.d.ts

@@ -0,0 +1,88 @@
+import type { Container, Provider } from '@tinkoff/dippy';
+import type { CommandLines, CommandLineDescription, ModuleType, ExtendedModule, Action } from '@tramvai/core';
+export interface ChildApp {
+    name: string;
+    modules?: (ModuleType | ExtendedModule)[];
+    actions?: Action[];
+    providers: Provider[];
+}
+export interface ChildAppRequestConfig {
+    name: string;
+    version?: string;
+    tag?: string;
+}
+export interface ChildAppExternalConfig {
+    server: {
+        entry: string;
+    };
+    client: {
+        baseUrl: string;
+        entry: string;
+    };
+    css?: {
+        entry?: string;
+    };
+}
+export interface ChildAppReactConfig extends ChildAppRequestConfig {
+    props?: Record<string, any>;
+}
+export interface ResolutionConfig extends Partial<ChildAppExternalConfig> {
+    version: string;
+    withoutCss?: boolean;
+    baseUrl?: string;
+}
+export interface ChildAppResolutionConfig {
+    name: string;
+    byTag: {
+        latest: ResolutionConfig;
+        [key: string]: ResolutionConfig;
+    };
+    baseUrl?: string;
+}
+export interface ChildAppFinalConfig extends Required<ChildAppRequestConfig>, ChildAppExternalConfig {
+    key: string;
+}
+export interface ChildAppPreloadManager {
+    preload(config: ChildAppRequestConfig): Promise<void>;
+    isPreloaded(config: ChildAppRequestConfig): boolean;
+    runPreloaded(): Promise<void>;
+    clearPreloaded(): Promise<void>;
+    getPreloadedList(): ChildAppRequestConfig[];
+}
+export interface ChildAppRenderManager {
+    getChildDi(request: ChildAppRequestConfig): [Container | null, Promise<Container | null> | null];
+    flush(): Promise<boolean>;
+    clear(): void;
+}
+export interface ChildAppLoader {
+    load(config: ChildAppFinalConfig): Promise<ChildApp | void>;
+    get(config: ChildAppFinalConfig): ChildApp | void;
+    init(config: ChildAppFinalConfig): Promise<void>;
+}
+export interface ChildAppStateManager {
+    registerChildApp(config: ChildAppFinalConfig): void;
+    getState(): any;
+}
+export interface ChildAppDiManager {
+    getChildDi(config: ChildAppFinalConfig): Container | null;
+    forEachChildDi(callback: (di: Container) => void): void;
+}
+export interface ChildAppCommandLineRunner {
+    run(type: keyof CommandLines, status: keyof CommandLineDescription, config: ChildAppFinalConfig): Promise<void>;
+}
+export interface WrapperProps<T> {
+    di: Container;
+    props: T;
+}
+declare type Store = {
+    storeName: string;
+} | string;
+declare type OptionalStore = {
+    store: Store;
+    optional?: boolean;
+};
+export interface RootStateSubscription {
+    stores: Array<Store | OptionalStore>;
+    listener: (state: Record<string, any>) => void | Promise<void>;
+}
+export {};

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@tramvai/tokens-child-app",
+  "version": "1.46.5",
+  "description": "",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "files": [
+    "lib"
+  ],
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:TinkoffCreditSystems/tramvai.git"
+  },
+  "scripts": {
+    "build": "tramvai-build --for-publish",
+    "watch": "tsc -w",
+    "build-for-publish": "true"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "peerDependencies": {
+    "@tinkoff/dippy": "0.7.36",
+    "@tramvai/core": "1.46.5",
+    "@tramvai/tokens-common": "1.46.5",
+    "react": ">=16.8.0"
+  },
+  "module": "lib/index.es.js"
+}