@tramvai/tokens-common 1.36.0 → 1.37.1

package/README.md

@@ -1,47 +1,47 @@
 # Common tokens
 
-Модуль содержащий токены трамвая для интеграция и расширения модуля роутинга.
+Tramvai tokens for integration and extension `@tramvai/module-common`.
 
-## Список action токенов
+## Action tokens
 
 @inline src/action.ts
 
-## Список bundle токенов
+## Bundle tokens
 
 @inline src/bundle.ts
 
-## Список componentRegistry токенов
+## ComponentRegistry tokens
 
 @inline src/componentRegistry.ts
 
-## Список env токенов
+## Env tokens
 
 @inline src/env.ts
 
-## Список context токенов
+## Context tokens
 
 @inline src/context.ts
 
-## Список hook токенов
+## Hook tokens
 
 @inline src/hook.ts
 
-## Список logger токенов
+## Logger tokens
 
 @inline src/logger.ts
 
-## Список pubsub токенов
+## Pubsub tokens
 
 @inline src/pubsub.ts
 
-## Список requestManager токенов
+## RequestManager tokens
 
 @inline src/requestManager.ts
 
-## Список responseManager токенов
+## ResponseManager tokens
 
 @inline src/responseManager.ts
 
-## Список state токенов
+## State tokens
 
 @inline src/state.ts

package/lib/action.d.ts

@@ -1,22 +1,22 @@
 import type { Action } from '@tramvai/core';
 /**
  * @description
- * Регистр для хранения экшенов по типам
+ * Registry for storing actions based on their type
  */
 export declare const ACTION_REGISTRY_TOKEN: ActionsRegistry;
 /**
  * @description
- * Сущность для исполнения экшенов
+ * Instance that executes actions
  */
 export declare const ACTION_EXECUTION_TOKEN: ActionExecution;
 /**
  * @description
- * Сушность для выполнения экшенов при переходах
+ * Instance that executes actions on navigations
  */
 export declare const ACTION_PAGE_RUNNER_TOKEN: ActionPageRunner;
 /**
  * @description
- * Позволяет добавлять условия на возможность исполнения экшенов
+ * Conditions that specify should action be executing or not
  */
 export declare const ACTION_CONDITIONALS: ActionCondition[];
 export interface ActionsRegistry {

package/lib/bundle.d.ts

@@ -1,13 +1,13 @@
 import type { Bundle } from '@tramvai/core';
 /**
  * @description
- * Хранилище бандлов. При получении бандла дополнительно добавляем экшены и компоненты из бандла в соответсвующие хранилища
+ * Bundle Storage. When getting bundle additionally adds actions and components from bundle to according storages
  */
 export declare const BUNDLE_MANAGER_TOKEN: BundleManager;
 /**
  * @description
- * Токен для предоставления дополнительных бандлов в приложение.
- * Важно! Не перезаписывает существующие бандлы.
+ * Provides additional bundles to the app.
+ * Important! This token doesn't overrides already existing bundles.
  */
 export declare const ADDITIONAL_BUNDLE_TOKEN: {
     [key: string]: Bundle;

package/lib/cache.d.ts

@@ -1,16 +1,16 @@
 /**
  * @description
- * Функция для создания кеша
+ * Function for creating a new cache
  */
 export declare const CREATE_CACHE_TOKEN: CacheFactory;
 /**
  * @description
- * Функция для вызова очистки кешей
+ * Function that us called on force cache clean up in the app
  */
 export declare const REGISTER_CLEAR_CACHE_TOKEN: (type: string) => void | Promise<void>;
 /**
  * @description
- * Можно задать в своем модуле, как функцию которая должна вызываться при вызове `CLEAR_CACHE_TOKEN`
+ * Force cleaning up all caches in the app
  */
 export declare const CLEAR_CACHE_TOKEN: (type?: string | undefined) => Promise<void>;
 export interface Cache<T = any> {

package/lib/context.d.ts

@@ -4,7 +4,7 @@ import type { PUBSUB_TOKEN } from './pubsub';
 export { PlatformAction } from '@tramvai/types-actions-state-context';
 /**
  * @description
- * Реализация контекста
+ * Context implementation
  */
 export declare const CONTEXT_TOKEN: ConsumerContext;
 export interface ConsumerContext extends BaseConsumerContext {

package/lib/env.d.ts

@@ -8,19 +8,19 @@ export interface EnvironmentManager {
 }
 /**
  * @description
- * Сущность `environmentManager` c помощью которого можно получить данные env переменных на сервере и клиенте
+ * Instance that used for managing env data on the server and on the client
  */
 export declare const ENV_MANAGER_TOKEN: EnvironmentManager;
 /**
  * @description
- * Список токенов которые необходимы модулю или приложению.
- * Позднее все токены из этого списка будут доступны через `environmentManager`
- * Формат токена ENV_USED_TOKEN:
-    - `key` - идентификатор env переменной. Под этим ключем будет доступно в `environmentManager` и будет получено из внешних источников
-    - `value` - предустановленное значение для токена `key` с низким приоритетом
-    - `optional` - является ли параметр опциональным для работы приложения. Если `true`, то приложение не будет падать, если не было передано значение
-    - `validator` - функция валидации переданного значения. Если функция вернет текст, то выкинется ошибка
-    - `dehydrate` - если передано `false`, то env параметр не передастся клиенту и можно будет получить значение только на серверной стороне
+ * List of envs that are used by the module or the app.
+ * All of the envs specified by that token will be accessible in the code through `environmentManager`
+ * ENV_USED_TOKEN format:
+    - `key` - id of the env. At that id the value of the env will be accessible through `environmentManager` and will be loaded from the external sources.
+    - `value` - default low-priority value for env `key`
+    - `optional` - is current env is optional. If `true` the app can work as usual event if the env value were not provided, if `false` - the app will fail to run without env value
+    - `validator` - validation function for passed env value. In case this function returns string it will be used as error message and validation will fail
+    - `dehydrate` - if `false` then env value will not be passed to client and this env can be used only on server
  *
  * @example
   ```tsx

package/lib/hook.d.ts

@@ -1,24 +1,24 @@
 /**
  * @description
- * В некоторых случаях нам нужно встроиться в функционал и это позволяют сделать хуки, [документация](https://tramvai.dev/docs/references/libs/hooks)
+ * [Hooks documentation](https://tramvai.dev/docs/references/libs/hooks)
  */
 export declare const HOOK_TOKEN: Hooks;
 declare type Hook<TPayload> = (context: any, payload?: TPayload, options?: any) => TPayload;
 export interface Hooks {
     /**
-     * Регистрация хуков
+     * Register hooks
      */
     registerHooks<TPayload>(name: string, list: Hook<TPayload>[] | Hook<TPayload>): void;
     /**
-     * Запуск синхронных хуков, payload проходит через все хуки и будет результатом выполнения
+     * Run sync hook
      */
     runHooks<TPayload>(name: string, context: any, payload?: TPayload, options?: any): TPayload;
     /**
-     * Запуск ассихронных хуков
+     * Run async hooksЗапуск ассихронных хуков
      */
     runAsyncHooks<TPayload>(name: string, context: any, payload: TPayload, options?: any): TPayload;
     /**
-     * Запуск проммис хуков
+     * Run promise hooks
      */
     runPromiseHooks(name: string, context: any, options?: any): <TPayload>(payload: TPayload) => Promise<TPayload> | Promise<never>;
 }

package/lib/index.es.js

@@ -2,13 +2,13 @@ import { createToken } from '@tinkoff/dippy';
 
 /**
  * @description
- * Хранилище бандлов. При получении бандла дополнительно добавляем экшены и компоненты из бандла в соответсвующие хранилища
+ * Bundle Storage. When getting bundle additionally adds actions and components from bundle to according storages
  */
 const BUNDLE_MANAGER_TOKEN = createToken('bundleManager');
 /**
  * @description
- * Токен для предоставления дополнительных бандлов в приложение.
- * Важно! Не перезаписывает существующие бандлы.
+ * Provides additional bundles to the app.
+ * Important! This token doesn't overrides already existing bundles.
  */
 const ADDITIONAL_BUNDLE_TOKEN = createToken('additional bundle', {
     multi: true,
@@ -16,28 +16,28 @@ const ADDITIONAL_BUNDLE_TOKEN = createToken('additional bundle', {
 
 /**
  * @description
- * Реализация контекста
+ * Context implementation
  */
 const CONTEXT_TOKEN = createToken('context');
 
 /**
  * @description
- * Регистр для хранения экшенов по типам
+ * Registry for storing actions based on their type
  */
 const ACTION_REGISTRY_TOKEN = createToken('actionRegistry');
 /**
  * @description
- * Сущность для исполнения экшенов
+ * Instance that executes actions
  */
 const ACTION_EXECUTION_TOKEN = createToken('actionExecution');
 /**
  * @description
- * Сушность для выполнения экшенов при переходах
+ * Instance that executes actions on navigations
  */
 const ACTION_PAGE_RUNNER_TOKEN = createToken('actionPageRunner');
 /**
  * @description
- * Позволяет добавлять условия на возможность исполнения экшенов
+ * Conditions that specify should action be executing or not
  */
 const ACTION_CONDITIONALS = createToken('actionConditionals', {
     multi: true,
@@ -45,39 +45,39 @@ const ACTION_CONDITIONALS = createToken('actionConditionals', {
 
 /**
  * @description
- * В некоторых случаях нам нужно встроиться в функционал и это позволяют сделать хуки, [документация](https://tramvai.dev/docs/references/libs/hooks)
+ * [Hooks documentation](https://tramvai.dev/docs/references/libs/hooks)
  */
 const HOOK_TOKEN = createToken('hooks');
 
 /**
  * @description
- * Фабрика для создания инстанса pubsub
+ * Factory for creating pubsub instances
  */
 const PUBSUB_FACTORY_TOKEN = createToken('pubsubFactory');
 /**
  * @description
- * Глобальный инстанс pubsub который живет все время
+ * Singleton pubsub instance
  */
 const PUBSUB_TOKEN = createToken('pubsub');
 /**
  * @description
- * Инстанс pubsub который создается для каждого клиента
+ * Request pubsub instance that is created for every client
  */
 const ROOT_PUBSUB_TOKEN = createToken('rootPubsub');
 
 /**
  * @description
- * Функция для создания кеша
+ * Function for creating a new cache
  */
 const CREATE_CACHE_TOKEN = createToken('createCache');
 /**
  * @description
- * Функция для вызова очистки кешей
+ * Function that us called on force cache clean up in the app
  */
 const REGISTER_CLEAR_CACHE_TOKEN = createToken('registerClearCache', { multi: true });
 /**
  * @description
- * Можно задать в своем модуле, как функцию которая должна вызываться при вызове `CLEAR_CACHE_TOKEN`
+ * Force cleaning up all caches in the app
  */
 const CLEAR_CACHE_TOKEN = createToken('clearCache');
 
@@ -91,68 +91,69 @@ const COMPONENT_REGISTRY_TOKEN = createToken('componentRegistry');
 
 /**
  * @description
+ * dispatcher implementation
  * Реализация dispatcher
  */
 const DISPATCHER_TOKEN = createToken('dispatcher');
 /**
  * @description
- * Реализция dispatcher context
+ * dispatcher context implementation
  */
 const DISPATCHER_CONTEXT_TOKEN = createToken('dispatcherContext');
 /**
  * @description
- * Позволяет добавлять свои сторы созданные через createReducer
+ * Token for adding stores that were created with createReducer
  */
 const COMBINE_REDUCERS = createToken('combineReducers', { multi: true });
 /**
  * @description
- * Общий стор приложения
+ * Common app store
  */
 const STORE_TOKEN = createToken('store');
 /**
  * @description
- * Позволяет задавать свои middlewares для работы со стейтом
+ * Custom middlewares for working with store state
  */
 const STORE_MIDDLEWARE = createToken('storeMiddleware', { multi: true });
 
 /**
  * @description
- * Реализация логгера
+ * Logger implementation
  */
 const LOGGER_TOKEN = createToken('logger');
 /**
  * @description
- * Дает возможность модифицировать логгер на этапе реализации
+ * Hook to be able to modify logger on initialization
  */
 const LOGGER_INIT_HOOK = createToken('loggerHook');
 
 /**
  * @description
- * Прямая ссылка на объект запроса
+ * Direct reference to request object
  */
 const REQUEST = createToken('request');
 /**
  * @description
- * Сущность для работы с инстансами запроса (заголовки запросов, query-параметры, куки).
- * В основном используется только на сервере, но на клиенте есть обрезанный функционал, для упрощения реализации изоморфного приложения
+ * Instance for managing client requests (request headers, query-parameters, cookies etc).
+ * Mostly used on server, but has partial functional for browser for simplification build isomorphic app
  */
 const REQUEST_MANAGER_TOKEN = createToken('requestManager');
 
 /**
  * @description
- * Прямая ссылка на объект ответа
+ * Direct reference to Response instance
  */
 const RESPONSE = createToken('response');
 /**
  * @description
- * Сущность для работы с инстансами ответа (заголовки ответа, куки, тело ответа).
- * В основном используется только на сервере, но на клиенте есть обрезанный функционал, для упрощения реализации изоморфного приложения
+ * Instance for managing client response (response headers, cookies, response body).
+ * Mostly used on server, but has partial functional for browser for simplification build isomorphic app
  */
 const RESPONSE_MANAGER_TOKEN = createToken('responseManager');
 
 /**
  * @description
- * Сущность `environmentManager` c помощью которого можно получить данные env переменных на сервере и клиенте
+ * Instance that used for managing env data on the server and on the client
  */
 const ENV_MANAGER_TOKEN = createToken('environmentManager');
 const ENV_USED_TOKEN = createToken('envUsed', { multi: true });

package/lib/index.js

@@ -6,13 +6,13 @@ var dippy = require('@tinkoff/dippy');
 
 /**
  * @description
- * Хранилище бандлов. При получении бандла дополнительно добавляем экшены и компоненты из бандла в соответсвующие хранилища
+ * Bundle Storage. When getting bundle additionally adds actions and components from bundle to according storages
  */
 const BUNDLE_MANAGER_TOKEN = dippy.createToken('bundleManager');
 /**
  * @description
- * Токен для предоставления дополнительных бандлов в приложение.
- * Важно! Не перезаписывает существующие бандлы.
+ * Provides additional bundles to the app.
+ * Important! This token doesn't overrides already existing bundles.
  */
 const ADDITIONAL_BUNDLE_TOKEN = dippy.createToken('additional bundle', {
     multi: true,
@@ -20,28 +20,28 @@ const ADDITIONAL_BUNDLE_TOKEN = dippy.createToken('additional bundle', {
 
 /**
  * @description
- * Реализация контекста
+ * Context implementation
  */
 const CONTEXT_TOKEN = dippy.createToken('context');
 
 /**
  * @description
- * Регистр для хранения экшенов по типам
+ * Registry for storing actions based on their type
  */
 const ACTION_REGISTRY_TOKEN = dippy.createToken('actionRegistry');
 /**
  * @description
- * Сущность для исполнения экшенов
+ * Instance that executes actions
  */
 const ACTION_EXECUTION_TOKEN = dippy.createToken('actionExecution');
 /**
  * @description
- * Сушность для выполнения экшенов при переходах
+ * Instance that executes actions on navigations
  */
 const ACTION_PAGE_RUNNER_TOKEN = dippy.createToken('actionPageRunner');
 /**
  * @description
- * Позволяет добавлять условия на возможность исполнения экшенов
+ * Conditions that specify should action be executing or not
  */
 const ACTION_CONDITIONALS = dippy.createToken('actionConditionals', {
     multi: true,
@@ -49,39 +49,39 @@ const ACTION_CONDITIONALS = dippy.createToken('actionConditionals', {
 
 /**
  * @description
- * В некоторых случаях нам нужно встроиться в функционал и это позволяют сделать хуки, [документация](https://tramvai.dev/docs/references/libs/hooks)
+ * [Hooks documentation](https://tramvai.dev/docs/references/libs/hooks)
  */
 const HOOK_TOKEN = dippy.createToken('hooks');
 
 /**
  * @description
- * Фабрика для создания инстанса pubsub
+ * Factory for creating pubsub instances
  */
 const PUBSUB_FACTORY_TOKEN = dippy.createToken('pubsubFactory');
 /**
  * @description
- * Глобальный инстанс pubsub который живет все время
+ * Singleton pubsub instance
  */
 const PUBSUB_TOKEN = dippy.createToken('pubsub');
 /**
  * @description
- * Инстанс pubsub который создается для каждого клиента
+ * Request pubsub instance that is created for every client
  */
 const ROOT_PUBSUB_TOKEN = dippy.createToken('rootPubsub');
 
 /**
  * @description
- * Функция для создания кеша
+ * Function for creating a new cache
  */
 const CREATE_CACHE_TOKEN = dippy.createToken('createCache');
 /**
  * @description
- * Функция для вызова очистки кешей
+ * Function that us called on force cache clean up in the app
  */
 const REGISTER_CLEAR_CACHE_TOKEN = dippy.createToken('registerClearCache', { multi: true });
 /**
  * @description
- * Можно задать в своем модуле, как функцию которая должна вызываться при вызове `CLEAR_CACHE_TOKEN`
+ * Force cleaning up all caches in the app
  */
 const CLEAR_CACHE_TOKEN = dippy.createToken('clearCache');
 
@@ -95,68 +95,69 @@ const COMPONENT_REGISTRY_TOKEN = dippy.createToken('componentRegistry');
 
 /**
  * @description
+ * dispatcher implementation
  * Реализация dispatcher
  */
 const DISPATCHER_TOKEN = dippy.createToken('dispatcher');
 /**
  * @description
- * Реализция dispatcher context
+ * dispatcher context implementation
  */
 const DISPATCHER_CONTEXT_TOKEN = dippy.createToken('dispatcherContext');
 /**
  * @description
- * Позволяет добавлять свои сторы созданные через createReducer
+ * Token for adding stores that were created with createReducer
  */
 const COMBINE_REDUCERS = dippy.createToken('combineReducers', { multi: true });
 /**
  * @description
- * Общий стор приложения
+ * Common app store
  */
 const STORE_TOKEN = dippy.createToken('store');
 /**
  * @description
- * Позволяет задавать свои middlewares для работы со стейтом
+ * Custom middlewares for working with store state
  */
 const STORE_MIDDLEWARE = dippy.createToken('storeMiddleware', { multi: true });
 
 /**
  * @description
- * Реализация логгера
+ * Logger implementation
  */
 const LOGGER_TOKEN = dippy.createToken('logger');
 /**
  * @description
- * Дает возможность модифицировать логгер на этапе реализации
+ * Hook to be able to modify logger on initialization
  */
 const LOGGER_INIT_HOOK = dippy.createToken('loggerHook');
 
 /**
  * @description
- * Прямая ссылка на объект запроса
+ * Direct reference to request object
  */
 const REQUEST = dippy.createToken('request');
 /**
  * @description
- * Сущность для работы с инстансами запроса (заголовки запросов, query-параметры, куки).
- * В основном используется только на сервере, но на клиенте есть обрезанный функционал, для упрощения реализации изоморфного приложения
+ * Instance for managing client requests (request headers, query-parameters, cookies etc).
+ * Mostly used on server, but has partial functional for browser for simplification build isomorphic app
  */
 const REQUEST_MANAGER_TOKEN = dippy.createToken('requestManager');
 
 /**
  * @description
- * Прямая ссылка на объект ответа
+ * Direct reference to Response instance
  */
 const RESPONSE = dippy.createToken('response');
 /**
  * @description
- * Сущность для работы с инстансами ответа (заголовки ответа, куки, тело ответа).
- * В основном используется только на сервере, но на клиенте есть обрезанный функционал, для упрощения реализации изоморфного приложения
+ * Instance for managing client response (response headers, cookies, response body).
+ * Mostly used on server, but has partial functional for browser for simplification build isomorphic app
  */
 const RESPONSE_MANAGER_TOKEN = dippy.createToken('responseManager');
 
 /**
  * @description
- * Сущность `environmentManager` c помощью которого можно получить данные env переменных на сервере и клиенте
+ * Instance that used for managing env data on the server and on the client
  */
 const ENV_MANAGER_TOKEN = dippy.createToken('environmentManager');
 const ENV_USED_TOKEN = dippy.createToken('envUsed', { multi: true });

package/lib/logger.d.ts

@@ -1,12 +1,12 @@
 import type { Logger } from '@tinkoff/logger';
 /**
  * @description
- * Реализация логгера
+ * Logger implementation
  */
 export declare const LOGGER_TOKEN: LoggerFactory;
 /**
  * @description
- * Дает возможность модифицировать логгер на этапе реализации
+ * Hook to be able to modify logger on initialization
  */
 export declare const LOGGER_INIT_HOOK: LoggerInitHook;
 declare type Config = {

package/lib/pubsub.d.ts

@@ -1,16 +1,16 @@
 /**
  * @description
- * Фабрика для создания инстанса pubsub
+ * Factory for creating pubsub instances
  */
 export declare const PUBSUB_FACTORY_TOKEN: () => PubSub;
 /**
  * @description
- * Глобальный инстанс pubsub который живет все время
+ * Singleton pubsub instance
  */
 export declare const PUBSUB_TOKEN: PubSub;
 /**
  * @description
- * Инстанс pubsub который создается для каждого клиента
+ * Request pubsub instance that is created for every client
  */
 export declare const ROOT_PUBSUB_TOKEN: PubSub;
 export interface PubSub {

package/lib/requestManager.d.ts

@@ -2,13 +2,13 @@ import type { Request } from 'express';
 declare type RequestExt = Request;
 /**
  * @description
- * Прямая ссылка на объект запроса
+ * Direct reference to request object
  */
 export declare const REQUEST: RequestExt;
 /**
  * @description
- * Сущность для работы с инстансами запроса (заголовки запросов, query-параметры, куки).
- * В основном используется только на сервере, но на клиенте есть обрезанный функционал, для упрощения реализации изоморфного приложения
+ * Instance for managing client requests (request headers, query-parameters, cookies etc).
+ * Mostly used on server, but has partial functional for browser for simplification build isomorphic app
  */
 export declare const REQUEST_MANAGER_TOKEN: RequestManager;
 export interface RequestManager {

package/lib/responseManager.d.ts

@@ -1,13 +1,13 @@
 import type { Response } from 'express';
 /**
  * @description
- * Прямая ссылка на объект ответа
+ * Direct reference to Response instance
  */
 export declare const RESPONSE: Response<any, Record<string, any>>;
 /**
  * @description
- * Сущность для работы с инстансами ответа (заголовки ответа, куки, тело ответа).
- * В основном используется только на сервере, но на клиенте есть обрезанный функционал, для упрощения реализации изоморфного приложения
+ * Instance for managing client response (response headers, cookies, response body).
+ * Mostly used on server, but has partial functional for browser for simplification build isomorphic app
  */
 export declare const RESPONSE_MANAGER_TOKEN: ResponseManager;
 export interface ResponseManager {

package/lib/state.d.ts

@@ -1,27 +1,28 @@
 import type { DispatcherContext, Event, Middleware, Reducer } from '@tramvai/state';
 /**
  * @description
+ * dispatcher implementation
  * Реализация dispatcher
  */
 export declare const DISPATCHER_TOKEN: any;
 /**
  * @description
- * Реализция dispatcher context
+ * dispatcher context implementation
  */
 export declare const DISPATCHER_CONTEXT_TOKEN: DispatcherContext<any>;
 /**
  * @description
- * Позволяет добавлять свои сторы созданные через createReducer
+ * Token for adding stores that were created with createReducer
  */
 export declare const COMBINE_REDUCERS: any;
 /**
  * @description
- * Общий стор приложения
+ * Common app store
  */
 export declare const STORE_TOKEN: Store<Record<string, any>>;
 /**
  * @description
- * Позволяет задавать свои middlewares для работы со стейтом
+ * Custom middlewares for working with store state
  */
 export declare const STORE_MIDDLEWARE: Middleware;
 export interface Store<State = Record<string, any>> {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/tokens-common",
-  "version": "1.36.0",
+  "version": "1.37.1",
   "description": "Tramvai tokens for @tramvai/module-common",
   "main": "lib/index.js",
   "module": "lib/index.es.js",
@@ -22,9 +22,9 @@
     "@types/express": "^4.17.9"
   },
   "peerDependencies": {
-    "@tramvai/core": "1.36.0",
-    "@tramvai/state": "1.36.0",
-    "@tramvai/types-actions-state-context": "1.36.0",
+    "@tramvai/core": "1.37.1",
+    "@tramvai/state": "1.37.1",
+    "@tramvai/types-actions-state-context": "1.37.1",
     "@tinkoff/logger": "0.10.10",
     "@tinkoff/dippy": "0.7.35",
     "express": "^4.17.1",