@tramvai/module-environment 4.25.0 → 4.26.1

package/lib/server/ClientEnvironmentRepository.d.ts

@@ -2,11 +2,11 @@ import type { EnvParameter, EnvironmentManager, ClientEnvironmentRepository as I
 export declare class ClientEnvironmentRepository implements Interface {
     private envManager;
     private tokens;
-    protected parameters: Record<string, string>;
+    protected parameters: Record<string, string | undefined>;
     constructor(envManager: EnvironmentManager, tokens: EnvParameter[]);
     get(name: string): string | undefined;
-    set(name: string, value: string): void;
-    getAll(): Record<string, string>;
+    set(name: string, value: string | undefined): void;
+    getAll(): Record<string, string | undefined>;
     update(result: Record<string, string>): void;
     private processing;
 }

package/lib/server/EnvironmentManagerServer.d.ts

@@ -1,13 +1,16 @@
-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 clientEnvRepository;
-    constructor(tokens: EnvParameter[]);
+    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>;
+    clientUsed(): Record<string, string | undefined>;
     /**
      * @deprecated use CLIENT_ENV_MANAGER_TOKEN
      */

package/lib/server/EnvironmentManagerServer.es.js

@@ -1,6 +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 {
@@ -14,13 +15,30 @@ const readFileWithEnv = (path) => {
     }
 };
 class EnvironmentManagerServer extends EnvironmentManager {
-    constructor(tokens) {
+    constructor(tokens, templates = []) {
         super();
         this.tokens = tokens;
+        this.templates = templates.reduce((acc, { key, fn }) => {
+            // TODO: key duplicates?
+            acc[key] = fn;
+            return acc;
+        }, {});
         this.processing();
-        // for backward compatibility
+        // 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
      */

package/lib/server/EnvironmentManagerServer.js

@@ -5,6 +5,7 @@ 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 }; }
 
@@ -22,13 +23,30 @@ const readFileWithEnv = (path) => {
     }
 };
 class EnvironmentManagerServer extends EnvironmentManager.EnvironmentManager {
-    constructor(tokens) {
+    constructor(tokens, templates = []) {
         super();
         this.tokens = tokens;
+        this.templates = templates.reduce((acc, { key, fn }) => {
+            // TODO: key duplicates?
+            acc[key] = fn;
+            return acc;
+        }, {});
         this.processing();
-        // for backward compatibility
+        // 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
      */

package/lib/server.es.js

@@ -1,7 +1,7 @@
 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, CLIENT_ENV_REPOSITORY_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';
@@ -17,14 +17,18 @@ EnvironmentModule = __decorate([
             provide({
                 provide: ENV_MANAGER_TOKEN,
                 scope: Scope.SINGLETON,
-                useFactory: ({ tokens }) => {
-                    return new EnvironmentManagerServer(flatten(tokens !== null && tokens !== void 0 ? tokens : []));
+                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({

package/lib/server.js

@@ -24,14 +24,18 @@ exports.EnvironmentModule = tslib.__decorate([
             core.provide({
                 provide: tokensCommon.ENV_MANAGER_TOKEN,
                 scope: core.Scope.SINGLETON,
-                useFactory: ({ tokens }) => {
-                    return new EnvironmentManagerServer.EnvironmentManagerServer(flatten__default["default"](tokens !== null && tokens !== void 0 ? tokens : []));
+                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({

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": "4.25.0",
+  "version": "4.26.1",
   "description": "",
   "browser": "lib/browser.js",
   "main": "lib/server.js",
@@ -19,11 +19,11 @@
   },
   "peerDependencies": {
     "@tinkoff/utils": "^2.1.2",
-    "@tramvai/core": "4.25.0",
-    "@tramvai/papi": "4.25.0",
-    "@tramvai/state": "4.25.0",
-    "@tramvai/tokens-common": "4.25.0",
-    "@tramvai/tokens-server": "4.25.0",
+    "@tramvai/core": "4.26.1",
+    "@tramvai/papi": "4.26.1",
+    "@tramvai/state": "4.26.1",
+    "@tramvai/tokens-common": "4.26.1",
+    "@tramvai/tokens-server": "4.26.1",
     "@tinkoff/dippy": "0.10.8",
     "react": ">=16.14.0",
     "react-dom": ">=16.14.0",