@tramvai/module-environment 3.41.1 → 3.41.3

package/lib/server/ClientEnvironmentRepository.d.ts

@@ -0,0 +1,13 @@
+import type { EnvParameter, EnvironmentManager, ClientEnvironmentRepository as Interface } from '@tramvai/tokens-common';
+export declare class ClientEnvironmentRepository implements Interface {
+    private envManager;
+    private tokens;
+    protected parameters: Record<string, string | undefined>;
+    constructor(envManager: EnvironmentManager, tokens: EnvParameter[]);
+    get(name: string): string | undefined;
+    set(name: string, value: string | undefined): void;
+    getAll(): Record<string, string | undefined>;
+    update(result: Record<string, string>): void;
+    private processing;
+}
+//# sourceMappingURL=ClientEnvironmentRepository.d.ts.map

package/lib/server/ClientEnvironmentRepository.es.js

@@ -0,0 +1,31 @@
+class ClientEnvironmentRepository {
+    constructor(envManager, tokens) {
+        this.envManager = envManager;
+        this.tokens = tokens;
+        this.parameters = {};
+        this.processing();
+    }
+    get(name) {
+        return this.parameters[name];
+    }
+    set(name, value) {
+        this.parameters[name] = value;
+    }
+    getAll() {
+        return this.parameters;
+    }
+    update(result) {
+        this.parameters = Object.assign(this.parameters, result);
+    }
+    processing() {
+        const envParameters = this.envManager.getAll();
+        this.tokens.forEach(({ key, dehydrate }) => {
+            const value = envParameters[key];
+            if (dehydrate !== false) {
+                this.set(key, value);
+            }
+        });
+    }
+}
+
+export { ClientEnvironmentRepository };

package/lib/server/ClientEnvironmentRepository.js

@@ -0,0 +1,35 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+class ClientEnvironmentRepository {
+    constructor(envManager, tokens) {
+        this.envManager = envManager;
+        this.tokens = tokens;
+        this.parameters = {};
+        this.processing();
+    }
+    get(name) {
+        return this.parameters[name];
+    }
+    set(name, value) {
+        this.parameters[name] = value;
+    }
+    getAll() {
+        return this.parameters;
+    }
+    update(result) {
+        this.parameters = Object.assign(this.parameters, result);
+    }
+    processing() {
+        const envParameters = this.envManager.getAll();
+        this.tokens.forEach(({ key, dehydrate }) => {
+            const value = envParameters[key];
+            if (dehydrate !== false) {
+                this.set(key, value);
+            }
+        });
+    }
+}
+
+exports.ClientEnvironmentRepository = ClientEnvironmentRepository;

package/lib/server/EnvironmentManagerServer.d.ts

@@ -1,10 +1,19 @@
-import type { EnvParameter } from '@tramvai/tokens-common';
+import type { EnvParameter, EnvTemplate } from '@tramvai/tokens-common';
 import { EnvironmentManager } from '../shared/EnvironmentManager';
 export declare class EnvironmentManagerServer extends EnvironmentManager {
     private tokens;
-    private clientUsedList;
-    constructor(tokens: EnvParameter[]);
-    clientUsed(): Record<string, string>;
+    private clientEnvRepository;
+    private templates;
+    constructor(tokens: EnvParameter[], templates?: EnvTemplate[]);
+    get(name: string): string | undefined;
+    getAll(): Record<string, string | undefined>;
+    /**
+     * @deprecated use CLIENT_ENV_MANAGER_TOKEN
+     */
+    clientUsed(): Record<string, string | undefined>;
+    /**
+     * @deprecated use CLIENT_ENV_MANAGER_TOKEN
+     */
     updateClientUsed(result: Record<string, string>): void;
     private getEnvInFiles;
     private getEnvInApp;

package/lib/server/EnvironmentManagerServer.es.js

@@ -1,5 +1,7 @@
 import noop from '@tinkoff/utils/function/noop';
 import { EnvironmentManager } from '../shared/EnvironmentManager.es.js';
+import { ClientEnvironmentRepository } from './ClientEnvironmentRepository.es.js';
+import { interpolate } from '../shared/template.es.js';
 
 const readFileWithEnv = (path) => {
     try {
@@ -13,17 +15,41 @@ const readFileWithEnv = (path) => {
     }
 };
 class EnvironmentManagerServer extends EnvironmentManager {
-    constructor(tokens) {
+    constructor(tokens, templates = []) {
         super();
         this.tokens = tokens;
-        this.clientUsedList = {};
+        this.templates = templates.reduce((acc, { key, fn }) => {
+            // TODO: key duplicates?
+            acc[key] = fn;
+            return acc;
+        }, {});
         this.processing();
+        // for backward compatibility.
+        this.clientEnvRepository = new ClientEnvironmentRepository(this, this.tokens);
     }
+    get(name) {
+        const value = super.get(name);
+        return interpolate({ envKey: name, envValue: value, templates: this.templates });
+    }
+    getAll() {
+        const values = super.getAll();
+        const result = {};
+        for (const name in values) {
+            result[name] = this.get(name);
+        }
+        return result;
+    }
+    /**
+     * @deprecated use CLIENT_ENV_MANAGER_TOKEN
+     */
     clientUsed() {
-        return this.clientUsedList;
+        return this.clientEnvRepository.getAll();
     }
+    /**
+     * @deprecated use CLIENT_ENV_MANAGER_TOKEN
+     */
     updateClientUsed(result) {
-        this.clientUsedList = Object.assign(this.clientUsedList, result);
+        this.clientEnvRepository.update(result);
     }
     // eslint-disable-next-line class-methods-use-this
     getEnvInFiles() {
@@ -53,22 +79,25 @@ class EnvironmentManagerServer extends EnvironmentManager {
     processing() {
         const result = {};
         const envParameters = this.collectionEnv();
-        this.tokens.forEach(({ key, validator = noop, optional, dehydrate }) => {
+        this.tokens.forEach(({ key, validator = noop, optional }) => {
             const value = envParameters[key];
+            const interpolatedValue = interpolate({
+                envKey: key,
+                envValue: value,
+                templates: this.templates,
+            });
             if (typeof value === 'undefined' && !optional) {
                 throw new Error(`Env parameter ${key} not found. You need add a this env parameter. If you have questions read the docs`);
             }
             // Not calling validation on empty values.
-            const validation = typeof value !== 'undefined' && validator(value);
+            const validation = typeof interpolatedValue !== 'undefined' && validator(interpolatedValue);
             if (typeof validation === 'string') {
                 throw new Error(`Env parameter ${key} with value ${value} not valid, message: ${validation}`);
             }
             result[key] = value;
-            if (dehydrate !== false) {
-                this.clientUsedList[key] = value;
-            }
         });
-        process.env = envParameters; // Записываем в process.env итоговый результат. TODO убрать позже
+        // sync process.env
+        process.env = envParameters;
         this.update(result);
     }
 }

package/lib/server/EnvironmentManagerServer.js

@@ -4,6 +4,8 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var noop = require('@tinkoff/utils/function/noop');
 var EnvironmentManager = require('../shared/EnvironmentManager.js');
+var ClientEnvironmentRepository = require('./ClientEnvironmentRepository.js');
+var template = require('../shared/template.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -21,17 +23,41 @@ const readFileWithEnv = (path) => {
     }
 };
 class EnvironmentManagerServer extends EnvironmentManager.EnvironmentManager {
-    constructor(tokens) {
+    constructor(tokens, templates = []) {
         super();
         this.tokens = tokens;
-        this.clientUsedList = {};
+        this.templates = templates.reduce((acc, { key, fn }) => {
+            // TODO: key duplicates?
+            acc[key] = fn;
+            return acc;
+        }, {});
         this.processing();
+        // for backward compatibility.
+        this.clientEnvRepository = new ClientEnvironmentRepository.ClientEnvironmentRepository(this, this.tokens);
     }
+    get(name) {
+        const value = super.get(name);
+        return template.interpolate({ envKey: name, envValue: value, templates: this.templates });
+    }
+    getAll() {
+        const values = super.getAll();
+        const result = {};
+        for (const name in values) {
+            result[name] = this.get(name);
+        }
+        return result;
+    }
+    /**
+     * @deprecated use CLIENT_ENV_MANAGER_TOKEN
+     */
     clientUsed() {
-        return this.clientUsedList;
+        return this.clientEnvRepository.getAll();
     }
+    /**
+     * @deprecated use CLIENT_ENV_MANAGER_TOKEN
+     */
     updateClientUsed(result) {
-        this.clientUsedList = Object.assign(this.clientUsedList, result);
+        this.clientEnvRepository.update(result);
     }
     // eslint-disable-next-line class-methods-use-this
     getEnvInFiles() {
@@ -61,22 +87,25 @@ class EnvironmentManagerServer extends EnvironmentManager.EnvironmentManager {
     processing() {
         const result = {};
         const envParameters = this.collectionEnv();
-        this.tokens.forEach(({ key, validator = noop__default["default"], optional, dehydrate }) => {
+        this.tokens.forEach(({ key, validator = noop__default["default"], optional }) => {
             const value = envParameters[key];
+            const interpolatedValue = template.interpolate({
+                envKey: key,
+                envValue: value,
+                templates: this.templates,
+            });
             if (typeof value === 'undefined' && !optional) {
                 throw new Error(`Env parameter ${key} not found. You need add a this env parameter. If you have questions read the docs`);
             }
             // Not calling validation on empty values.
-            const validation = typeof value !== 'undefined' && validator(value);
+            const validation = typeof interpolatedValue !== 'undefined' && validator(interpolatedValue);
             if (typeof validation === 'string') {
                 throw new Error(`Env parameter ${key} with value ${value} not valid, message: ${validation}`);
             }
             result[key] = value;
-            if (dehydrate !== false) {
-                this.clientUsedList[key] = value;
-            }
         });
-        process.env = envParameters; // Записываем в process.env итоговый результат. TODO убрать позже
+        // sync process.env
+        process.env = envParameters;
         this.update(result);
     }
 }

package/lib/server.es.js

@@ -1,12 +1,13 @@
 import { __decorate } from 'tslib';
 import { Module, provide, Scope, commandLineListTokens } from '@tramvai/core';
 import flatten from '@tinkoff/utils/array/flatten';
-import { ENV_MANAGER_TOKEN, ENV_USED_TOKEN, COMBINE_REDUCERS, CONTEXT_TOKEN } from '@tramvai/tokens-common';
+import { ENV_MANAGER_TOKEN, ENV_USED_TOKEN, ENV_TEMPLATE_TOKEN, CLIENT_ENV_REPOSITORY_TOKEN, COMBINE_REDUCERS, CONTEXT_TOKEN } from '@tramvai/tokens-common';
 export { ENV_MANAGER_TOKEN, ENV_USED_TOKEN } from '@tramvai/tokens-common';
 import { SERVER_MODULE_PAPI_PUBLIC_ROUTE } from '@tramvai/tokens-server';
 import { createPapiMethod } from '@tramvai/papi';
 import { EnvironmentStore } from './shared/EnvironmentStore.es.js';
 import { EnvironmentManagerServer } from './server/EnvironmentManagerServer.es.js';
+import { ClientEnvironmentRepository } from './server/ClientEnvironmentRepository.es.js';
 
 let EnvironmentModule = class EnvironmentModule {
 };
@@ -15,16 +16,34 @@ EnvironmentModule = __decorate([
         providers: [
             provide({
                 provide: ENV_MANAGER_TOKEN,
-                useFactory: ({ tokens }) => {
-                    return new EnvironmentManagerServer(flatten(tokens !== null && tokens !== void 0 ? tokens : []));
+                scope: Scope.SINGLETON,
+                useFactory: ({ tokens, templates }) => {
+                    return new EnvironmentManagerServer(flatten(tokens !== null && tokens !== void 0 ? tokens : []), templates !== null && templates !== void 0 ? templates : []);
                 },
                 deps: {
                     tokens: {
                         token: ENV_USED_TOKEN,
                         optional: true,
                     },
+                    templates: {
+                        token: ENV_TEMPLATE_TOKEN,
+                        optional: true,
+                    },
+                },
+            }),
+            provide({
+                provide: CLIENT_ENV_REPOSITORY_TOKEN,
+                scope: Scope.REQUEST,
+                useFactory: ({ envManager, tokens }) => {
+                    return new ClientEnvironmentRepository(envManager, flatten(tokens !== null && tokens !== void 0 ? tokens : []));
+                },
+                deps: {
+                    envManager: ENV_MANAGER_TOKEN,
+                    tokens: {
+                        token: ENV_USED_TOKEN,
+                        optional: true,
+                    },
                 },
-                scope: Scope.SINGLETON,
             }),
             provide({
                 provide: COMBINE_REDUCERS,
@@ -33,14 +52,14 @@ EnvironmentModule = __decorate([
             }),
             provide({
                 provide: commandLineListTokens.customerStart,
-                useFactory: ({ context, environmentManager }) => {
+                useFactory: ({ context, clientEnvRepository }) => {
                     return function envCommand() {
-                        context.getStore('environment').setState(environmentManager.clientUsed());
+                        context.getStore('environment').setState(clientEnvRepository.getAll());
                     };
                 },
                 multi: true,
                 deps: {
-                    environmentManager: ENV_MANAGER_TOKEN,
+                    clientEnvRepository: CLIENT_ENV_REPOSITORY_TOKEN,
                     context: CONTEXT_TOKEN,
                 },
             }),

package/lib/server.js

@@ -10,6 +10,7 @@ var tokensServer = require('@tramvai/tokens-server');
 var papi = require('@tramvai/papi');
 var EnvironmentStore = require('./shared/EnvironmentStore.js');
 var EnvironmentManagerServer = require('./server/EnvironmentManagerServer.js');
+var ClientEnvironmentRepository = require('./server/ClientEnvironmentRepository.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -22,16 +23,34 @@ exports.EnvironmentModule = tslib.__decorate([
         providers: [
             core.provide({
                 provide: tokensCommon.ENV_MANAGER_TOKEN,
-                useFactory: ({ tokens }) => {
-                    return new EnvironmentManagerServer.EnvironmentManagerServer(flatten__default["default"](tokens !== null && tokens !== void 0 ? tokens : []));
+                scope: core.Scope.SINGLETON,
+                useFactory: ({ tokens, templates }) => {
+                    return new EnvironmentManagerServer.EnvironmentManagerServer(flatten__default["default"](tokens !== null && tokens !== void 0 ? tokens : []), templates !== null && templates !== void 0 ? templates : []);
                 },
                 deps: {
                     tokens: {
                         token: tokensCommon.ENV_USED_TOKEN,
                         optional: true,
                     },
+                    templates: {
+                        token: tokensCommon.ENV_TEMPLATE_TOKEN,
+                        optional: true,
+                    },
+                },
+            }),
+            core.provide({
+                provide: tokensCommon.CLIENT_ENV_REPOSITORY_TOKEN,
+                scope: core.Scope.REQUEST,
+                useFactory: ({ envManager, tokens }) => {
+                    return new ClientEnvironmentRepository.ClientEnvironmentRepository(envManager, flatten__default["default"](tokens !== null && tokens !== void 0 ? tokens : []));
+                },
+                deps: {
+                    envManager: tokensCommon.ENV_MANAGER_TOKEN,
+                    tokens: {
+                        token: tokensCommon.ENV_USED_TOKEN,
+                        optional: true,
+                    },
                 },
-                scope: core.Scope.SINGLETON,
             }),
             core.provide({
                 provide: tokensCommon.COMBINE_REDUCERS,
@@ -40,14 +59,14 @@ exports.EnvironmentModule = tslib.__decorate([
             }),
             core.provide({
                 provide: core.commandLineListTokens.customerStart,
-                useFactory: ({ context, environmentManager }) => {
+                useFactory: ({ context, clientEnvRepository }) => {
                     return function envCommand() {
-                        context.getStore('environment').setState(environmentManager.clientUsed());
+                        context.getStore('environment').setState(clientEnvRepository.getAll());
                     };
                 },
                 multi: true,
                 deps: {
-                    environmentManager: tokensCommon.ENV_MANAGER_TOKEN,
+                    clientEnvRepository: tokensCommon.CLIENT_ENV_REPOSITORY_TOKEN,
                     context: tokensCommon.CONTEXT_TOKEN,
                 },
             }),

package/lib/shared/EnvironmentManager.d.ts

@@ -1,12 +1,12 @@
 import type { EnvironmentManager as Interface } from '@tramvai/tokens-common';
 export declare class EnvironmentManager implements Interface {
-    protected parameters: Record<string, string>;
+    protected parameters: Record<string, string | undefined>;
     constructor();
     get(name: string): string | undefined;
     getInt(name: string, def: number): number;
-    getAll(): Record<string, string>;
-    update(result: Record<string, string>): void;
-    clientUsed(): Record<string, string>;
+    getAll(): Record<string, string | undefined>;
+    update(result: Record<string, string | undefined>): void;
+    clientUsed(): Record<string, string | undefined>;
     updateClientUsed(result: Record<string, string>): void;
 }
 //# sourceMappingURL=EnvironmentManager.d.ts.map

package/lib/shared/template.d.ts

@@ -0,0 +1,8 @@
+import type { EnvTemplate } from '@tramvai/tokens-common';
+export type Templates = Record<string, EnvTemplate['fn']>;
+export declare function interpolate({ envKey, envValue, templates, }: {
+    envKey: string;
+    envValue: string | undefined;
+    templates: Templates;
+}): string | undefined;
+//# sourceMappingURL=template.d.ts.map

package/lib/shared/template.es.js

@@ -0,0 +1,20 @@
+// use `$[...]` as template placeholder, because this symbols are not used in popular terminal shell for string interpolation
+const templateRegex = /(?:\$\[(.+?)\])/g;
+function interpolate({ envKey, envValue, templates, }) {
+    const originalValue = envValue;
+    if (!envValue || typeof envValue !== 'string') {
+        return envValue;
+    }
+    return envValue.replace(templateRegex, (templateRaw, templateStr) => {
+        // expect string in `key:param1,param2` format
+        const [key, paramsRaw = ''] = templateStr.split(':');
+        const params = paramsRaw.split(',').filter(Boolean);
+        const template = templates[key];
+        if (template) {
+            return template(...params);
+        }
+        throw Error(`Problem with "${envKey}=${originalValue}" env variable - template for ${templateRaw} not found.`);
+    });
+}
+
+export { interpolate };

package/lib/shared/template.js

@@ -0,0 +1,24 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+// use `$[...]` as template placeholder, because this symbols are not used in popular terminal shell for string interpolation
+const templateRegex = /(?:\$\[(.+?)\])/g;
+function interpolate({ envKey, envValue, templates, }) {
+    const originalValue = envValue;
+    if (!envValue || typeof envValue !== 'string') {
+        return envValue;
+    }
+    return envValue.replace(templateRegex, (templateRaw, templateStr) => {
+        // expect string in `key:param1,param2` format
+        const [key, paramsRaw = ''] = templateStr.split(':');
+        const params = paramsRaw.split(',').filter(Boolean);
+        const template = templates[key];
+        if (template) {
+            return template(...params);
+        }
+        throw Error(`Problem with "${envKey}=${originalValue}" env variable - template for ${templateRaw} not found.`);
+    });
+}
+
+exports.interpolate = interpolate;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tramvai/module-environment",
-  "version": "3.41.1",
+  "version": "3.41.3",
   "description": "",
   "browser": "lib/browser.js",
   "main": "lib/server.js",
@@ -19,11 +19,11 @@
   },
   "peerDependencies": {
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/core": "3.41.1",
-    "@tramvai/papi": "3.41.1",
-    "@tramvai/state": "3.41.1",
-    "@tramvai/tokens-common": "3.41.1",
-    "@tramvai/tokens-server": "3.41.1",
+    "@tramvai/core": "3.41.3",
+    "@tramvai/papi": "3.41.3",
+    "@tramvai/state": "3.41.3",
+    "@tramvai/tokens-common": "3.41.3",
+    "@tramvai/tokens-server": "3.41.3",
     "@tinkoff/dippy": "0.9.4",
     "react": ">=16.14.0",
     "react-dom": ">=16.14.0",