@taon-dev/i18n 0.0.1

package/lib-esm/lib/transignal-service.js

@@ -0,0 +1,197 @@
+import { computed, EnvironmentInjector, inject, Injectable, resource, runInInjectionContext, signal, untracked, } from '@angular/core';
+import { TREE_SHAKED_TRANSLATIONS } from './internals';
+import { injectTransignalConfig } from './transignal-config';
+import { simpleParamsHandler } from './transignal-param-handlers';
+/**
+ * Main transignal service, used to process and cache translations
+ * Can be injected directly or with use of transignal object created with {@link prepareTransignal} function (recommended)
+ */
+let TransignalService = class TransignalService {
+    injector = inject(EnvironmentInjector);
+    config = injectTransignalConfig();
+    paramsHandler = this.config.paramHandler ?? simpleParamsHandler;
+    loadingFn = this.config.loadingFn ?? (() => '...');
+    // eslint-disable-next-line no-console
+    errorHandler = this.config.errorHandler ?? console.error; // TODO maybe add a link to error page in docs
+    loadingCount = signal(0);
+    scopeMap = new Map();
+    languageMap = new Map();
+    /**
+     * Use to set or get active language
+     */
+    activeLang = signal(this.config.defaultLang);
+    /**
+     * Use to determine whether service is currently loading translation files
+     */
+    isLoading = computed(() => this.loadingCount() > 0);
+    t(scope) {
+        const existing = this.scopeMap.get(scope);
+        if (existing) {
+            return existing;
+        }
+        const scopeObj = this.initT(scope);
+        this.scopeMap.set(scope, scopeObj);
+        return scopeObj;
+    }
+    initT(scope) {
+        const cache = new Map();
+        const t = ((key, params) => {
+            const lang = this.activeLang();
+            const baseKey = `${lang}/${key}`;
+            const memoKey = params ? `${baseKey}_${JSON.stringify(params)}` : baseKey;
+            const alreadyComputed = cache.get(memoKey);
+            if (alreadyComputed) {
+                return alreadyComputed;
+            }
+            const { isLoading, error, value } = this.fetchLanguage(scope, lang);
+            if (isLoading()) {
+                return this.loadingFn?.(key);
+            }
+            if (error() || !value()) {
+                this.errorHandler('missing_file', error());
+                return '';
+            }
+            const result = this.replaceParams(this.resolveObjectPath(value(), key), params);
+            cache.set(memoKey, result);
+            return result;
+        }); // needed as other props are assigned below
+        t.arr = t;
+        t.obj = t;
+        t.prefix = this.preparePrefixFn(t, 1);
+        t.plural = this.preparePluralFn(t);
+        t.select = this.prepareSelectFn(t);
+        return t;
+    }
+    preparePrefixFn(t, depth) {
+        return (prefix) => {
+            const prefixedT = (key, params) => t(`${prefix}.${key}`, params);
+            prefixedT.arr = prefixedT;
+            prefixedT.obj = prefixedT;
+            prefixedT.plural = this.preparePluralFn(prefixedT);
+            prefixedT.select = this.prepareSelectFn(prefixedT);
+            prefixedT.prefix =
+                this.config.maxPrefixDepth || 3 >= depth
+                    ? this.preparePrefixFn(prefixedT, depth + 1)
+                    : () => {
+                        this.errorHandler('prefix_too_deep');
+                        const t = () => '';
+                        t.arr = () => [];
+                        t.obj = () => ({});
+                        t.plural = () => '';
+                        return t;
+                    };
+            return prefixedT;
+        };
+    }
+    preparePluralFn(t) {
+        return (key, count, params) => {
+            const plurals = t(key, { count, ...params });
+            if (typeof plurals === 'string') {
+                if (plurals === this.loadingFn(key)) {
+                    return plurals;
+                }
+                this.errorHandler('invalid_plural', key, plurals);
+                return plurals;
+            }
+            if (plurals[count]) {
+                return plurals[count];
+            }
+            const valueLastDigit = +count.toFixed(0).at(-1);
+            if (plurals.one && valueLastDigit === 1) {
+                return plurals.one;
+            }
+            if (plurals.many && valueLastDigit >= 5) {
+                return plurals.many;
+            }
+            if (plurals.few && valueLastDigit > 1 && valueLastDigit < 5) {
+                return plurals.few;
+            }
+            if (plurals.other) {
+                return plurals.other;
+            }
+            this.errorHandler('missing_plural', key, plurals, count);
+            return '';
+        };
+    }
+    prepareSelectFn(t) {
+        return (key, value, params) => {
+            const selects = t(key, { value, ...params });
+            if (typeof selects === 'string') {
+                if (selects === this.loadingFn(key)) {
+                    return selects;
+                }
+                this.errorHandler('invalid_select', key, selects);
+                return selects;
+            }
+            if (value !== null) {
+                if (selects[value]) {
+                    return selects[value];
+                }
+            }
+            else if (selects['null']) {
+                return selects['null'];
+            }
+            this.errorHandler('missing_select', key, selects, value);
+            return '';
+        };
+    }
+    replaceParams(translation, params) {
+        if (!translation)
+            return translation;
+        if (typeof translation === 'string') {
+            return this.paramsHandler(translation, params);
+        }
+        if (Array.isArray(translation)) {
+            return translation.map(val => this.replaceParams(val, params));
+        }
+        if (typeof translation === 'object') {
+            return Object.entries(translation).reduce((prev, [objKey, objVal]) => {
+                prev[objKey] = this.replaceParams(objVal, params);
+                return prev;
+            }, {});
+        }
+        return translation;
+    }
+    fetchLanguage(scope, lang) {
+        const cacheKey = `${scope}/${lang}`;
+        const existing = this.languageMap.get(cacheKey);
+        if (existing)
+            return existing;
+        const { translations, loader } = this.config;
+        const translation = runInInjectionContext(this.injector, () => translations === TREE_SHAKED_TRANSLATIONS
+            ? untracked(() => resource({
+                loader: async () => {
+                    this.loadingCount.update(count => ++count);
+                    const file = await runInInjectionContext(this.injector, () => loader(scope, lang));
+                    this.loadingCount.update(count => --count);
+                    return file;
+                },
+            }))
+            : {
+                value: signal(translations[scope]),
+                isLoading: signal(false),
+                error: signal(undefined),
+            });
+        this.languageMap.set(cacheKey, translation);
+        return translation;
+    }
+    resolveObjectPath(obj, path) {
+        const keys = path.split('.');
+        let current = obj;
+        for (const key of keys) {
+            if (current && typeof current === 'object') {
+                current = current[key];
+            }
+            else {
+                this.errorHandler('missing_key', { obj, path });
+                return undefined;
+            }
+        }
+        return current;
+    }
+};
+TransignalService = __decorate([
+    Injectable()
+], TransignalService);
+export { TransignalService };
+//# sourceMappingURL=transignal-service.js.map

package/lib-esm/lib/transignal-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transignal-service.js","sourceRoot":"","sources":[""],"names":[],"mappings":"AAAA,OAAO,EACL,QAAQ,EACR,mBAAmB,EACnB,MAAM,EACN,UAAU,EACV,QAAQ,EACR,qBAAqB,EACrB,MAAM,EACN,SAAS,GACV,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAWlE;;;GAGG;AAEI,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;IAKX,QAAQ,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC;IACvC,MAAM,GAAG,sBAAsB,EAA2B,CAAC;IAC3D,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,IAAI,mBAAmB,CAAC;IAChE,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;IACpE,sCAAsC;IACrB,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,8CAA8C;IACxG,YAAY,GAAG,MAAM,CAAS,CAAC,CAAC,CAAC;IACjC,QAAQ,GAAG,IAAI,GAAG,EAA8C,CAAC;IACjE,WAAW,GAAG,IAAI,GAAG,EAAwD,CAAC;IAE/F;;OAEG;IACM,UAAU,GAAG,MAAM,CAAY,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACjE;;OAEG;IACM,SAAS,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC;IAE7D,CAAC,CAAuB,KAAY;QAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,QAAwD,CAAC;QAClE,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAsB,KAAK,CAAC,CAAC;QAExD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,QAAyD,CAAC,CAAC;QACpF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,KAAK,CAAsC,KAAa;QAC9D,MAAM,KAAK,GAAG,IAAI,GAAG,EAAmB,CAAC;QACzC,MAAM,CAAC,GAA0B,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;YAChD,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;YAC/B,MAAM,OAAO,GAAG,GAAG,IAAI,IAAI,GAAa,EAAE,CAAC;YAC3C,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;YAC1E,MAAM,eAAe,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAC3C,IAAI,eAAe,EAAE,CAAC;gBACpB,OAAO,eAAe,CAAC;YACzB,CAAC;YACD,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACpE,IAAI,SAAS,EAAE,EAAE,CAAC;gBAChB,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,CAAC;YAC/B,CAAC;YACD,IAAI,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;gBACxB,IAAI,CAAC,YAAY,CAAC,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC3C,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;YAChF,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC3B,OAAO,MAAM,CAAC;QAChB,CAAC,CAA0B,CAAC,CAAC,2CAA2C;QAExE,CAAC,CAAC,GAAG,GAAG,CAAQ,CAAC;QACjB,CAAC,CAAC,GAAG,GAAG,CAAQ,CAAC;QACjB,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACtC,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACnC,OAAO,CAAC,CAAC;IACX,CAAC;IAEO,eAAe,CAAC,CAAwB,EAAE,KAAa;QAC7D,OAAO,CAAC,MAAc,EAAE,EAAE;YACxB,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,MAAwB,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,EAAE,MAAM,CAAC,CAAC;YAC3F,SAAS,CAAC,GAAG,GAAG,SAAS,CAAC;YAC1B,SAAS,CAAC,GAAG,GAAG,SAAS,CAAC;YAC1B,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YACnD,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;YACnD,SAAS,CAAC,MAAM;gBACd,IAAI,CAAC,MAAM,CAAC,cAAc,IAAI,CAAC,IAAI,KAAK;oBACtC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,KAAK,GAAG,CAAC,CAAC;oBAC5C,CAAC,CAAC,GAAG,EAAE;wBACH,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;wBACrC,MAAM,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,CAAC;wBACnB,CAAC,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,EAAE,CAAC;wBACjB,CAAC,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;wBACnB,CAAC,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,EAAE,CAAC;wBACpB,OAAO,CAAC,CAAC;oBACX,CAAC,CAAC;YACR,OAAO,SAAgB,CAAC;QAC1B,CAAC,CAAC;IACJ,CAAC;IAEO,eAAe,CAAC,CAAwB;QAC9C,OAAO,CAAC,GAAW,EAAE,KAAa,EAAE,MAAwB,EAAE,EAAE;YAC9D,MAAM,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,MAAM,EAAE,CAA+B,CAAC;YAC3E,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAChC,IAAI,OAAO,KAAK,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;oBACpC,OAAO,OAAO,CAAC;gBACjB,CAAC;gBACD,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;gBAClD,OAAO,OAAiB,CAAC;YAC3B,CAAC;YACD,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACnB,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;YACxB,CAAC;YACD,MAAM,cAAc,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC;YACjD,IAAI,OAAO,CAAC,GAAG,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;gBACxC,OAAO,OAAO,CAAC,GAAG,CAAC;YACrB,CAAC;YACD,IAAI,OAAO,CAAC,IAAI,IAAI,cAAc,IAAI,CAAC,EAAE,CAAC;gBACxC,OAAO,OAAO,CAAC,IAAI,CAAC;YACtB,CAAC;YACD,IAAI,OAAO,CAAC,GAAG,IAAI,cAAc,GAAG,CAAC,IAAI,cAAc,GAAG,CAAC,EAAE,CAAC;gBAC5D,OAAO,OAAO,CAAC,GAAG,CAAC;YACrB,CAAC;YACD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;gBAClB,OAAO,OAAO,CAAC,KAAK,CAAC;YACvB,CAAC;YACD,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YACzD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;IACJ,CAAC;IAEO,eAAe,CAAC,CAAwB;QAC9C,OAAO,CAAC,GAAW,EAAE,KAA6B,EAAE,MAAwB,EAAE,EAAE;YAC9E,MAAM,OAAO,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,MAAM,EAAE,CAA+B,CAAC;YAC3E,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAChC,IAAI,OAAO,KAAK,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;oBACpC,OAAO,OAAO,CAAC;gBACjB,CAAC;gBACD,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;gBAClD,OAAO,OAAiB,CAAC;YAC3B,CAAC;YACD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBACnB,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACnB,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC;iBAAM,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3B,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;YACzB,CAAC;YACD,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;YACzD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;IACJ,CAAC;IAES,aAAa,CAAI,WAAc,EAAE,MAAwB;QACjE,IAAI,CAAC,WAAW;YAAE,OAAO,WAAW,CAAC;QACrC,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACpC,OAAO,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,MAAM,CAAM,CAAC;QACtD,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/B,OAAO,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,GAAQ,EAAE,MAAM,CAAC,CAAM,CAAC;QAC3E,CAAC;QACD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACpC,OAAO,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,MAAM,CACvC,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE;gBACzB,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBAClD,OAAO,IAAI,CAAC;YACd,CAAC,EACD,EAA6B,CACzB,CAAC;QACT,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,aAAa,CACnB,KAAa,EACb,IAAe;QAEf,MAAM,QAAQ,GAAG,GAAG,KAAK,IAAI,IAAI,EAAE,CAAC;QACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,QAAQ;YAAE,OAAO,QAAQ,CAAC;QAC9B,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QAE7C,MAAM,WAAW,GAAG,qBAAqB,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,CAC3D,YAA+D,KAAK,wBAAwB;YAC3F,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,CACb,QAAQ,CAAC;gBACP,MAAM,EAAE,KAAK,IAAI,EAAE;oBACjB,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;oBAC3C,MAAM,IAAI,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;oBACnF,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;oBAC3C,OAAO,IAAI,CAAC;gBACd,CAAC;aACF,CAAC,CACH;YACH,CAAC,CAAC;gBACE,KAAK,EAAE,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;gBAClC,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC;gBACxB,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC;aACzB,CACN,CAAC;QACF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAC5C,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,iBAAiB,CAAC,GAAoC,EAAE,IAAY;QAC1E,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,OAAO,GAAY,GAAG,CAAC;QAC3B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAC3C,OAAO,GAAI,OAAmC,CAAC,GAAG,CAAC,CAAC;YACtD,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;gBAChD,OAAO,SAAS,CAAC;YACnB,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;CACF,CAAA;AA9MY,iBAAiB;IAD7B,UAAU,EAAE;GACA,iBAAiB,CA8M7B"}

package/lib-esm/lib/transignal-testing.d.ts

@@ -0,0 +1,8 @@
+import { prepareTransignal } from './transignal-config';
+/**
+ * Provides unit-test version of transignal that loads translation instantly without loading
+ *
+ * @param transignal   existing transignal instance
+ * @param translations real translations in a selected language
+ */
+export declare const provideTransignalTesting: <Languages extends string, Translations extends Record<string, Record<string, unknown>>>(transignal: ReturnType<typeof prepareTransignal<Languages, Translations>>, translations: Translations) => import("@angular/core").EnvironmentProviders;

package/lib-esm/lib/transignal-testing.js

@@ -0,0 +1,10 @@
+import { INTERNAL_TRANSIGNAL_CONFIG } from './internals';
+import { prepareTransignal } from './transignal-config';
+/**
+ * Provides unit-test version of transignal that loads translation instantly without loading
+ *
+ * @param transignal   existing transignal instance
+ * @param translations real translations in a selected language
+ */
+export const provideTransignalTesting = (transignal, translations) => prepareTransignal({ ...transignal[INTERNAL_TRANSIGNAL_CONFIG].config, translations }, ...transignal[INTERNAL_TRANSIGNAL_CONFIG].features).provide();
+//# sourceMappingURL=transignal-testing.js.map

package/lib-esm/lib/transignal-testing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transignal-testing.js","sourceRoot":"","sources":[""],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAItC,UAAyE,EACzE,YAA0B,EAC1B,EAAE,CACF,iBAAiB,CACf,EAAE,GAAG,UAAU,CAAC,0BAA0B,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,EAClE,GAAG,UAAU,CAAC,0BAA0B,CAAC,CAAC,QAAQ,CACnD,CAAC,OAAO,EAAE,CAAC"}

package/lib-esm/lib/types.d.ts

@@ -0,0 +1,124 @@
+import { ParamHandler } from './transignal-param-handlers';
+import { ArrayPaths, GetNestedType, ObjectPaths, PluralPaths, SelectPaths, StringKeys, StringPaths } from './utility-types';
+export type TransignalError = 
+/** Error when key is not found in translations */
+'missing_key'
+/** Error when translation file for scope and lang has not been found */
+ | 'missing_file'
+/** Error plural for a value is not defined for a language */
+ | 'missing_plural'
+/** Error when plural used on a non-plural translation */
+ | 'invalid_plural'
+/** Error select for a value is not defined for a language */
+ | 'missing_select'
+/** Error when select used on a non-select translation */
+ | 'invalid_select'
+/** Error when prefix chain is called more then {@link TransignalConfig.maxPrefixDepth} */
+ | 'prefix_too_deep';
+export type TranslateParams = Record<string, unknown>;
+export type Marked<K, T> = K & {
+    __marker: T;
+};
+export type BasePluralTranslation = Partial<Record<number | 'one' | 'few' | 'many' | 'other', string>>;
+export type PluralTranslation = Marked<BasePluralTranslation, 'plural'>;
+export type BaseSelectTranslation = Partial<Record<string | number | 'null', string>>;
+export type MarkedAsSelect<T extends BaseSelectTranslation> = Marked<T, 'select'>;
+export type SelectTranslation = MarkedAsSelect<BaseSelectTranslation>;
+export type TranslateFn<Keys extends string, Result> = (key: Keys, params?: TranslateParams) => Result;
+export type TranslateObj<Context extends Record<string, any>> = TranslateFn<StringPaths<Context>, string> & {
+    /**
+     * Returns translating function that returns an array of translations
+     * @param key path of translation
+     * @param params parameters of translation in syntax defined by {@link TransignalConfig.paramHandler}
+     */
+    arr: <ArrKey extends ArrayPaths<Context>>(key: ArrKey, params?: TranslateParams) => GetNestedType<Context, ArrKey>;
+    /**
+     * Returns translating function that returns an object of translations
+     * @param key path of translation
+     * @param params parameters of translation in syntax defined by {@link TransignalConfig.paramHandler}
+     */
+    obj: <ObjKey extends ObjectPaths<Context>>(key: ObjKey, params?: TranslateParams) => GetNestedType<Context, ObjKey>;
+    /**
+     * Returns translating function that returns a string translation depending on a correct plural form
+     * @param key path of translation
+     * @param count count to determine correct plural form
+     * @param params parameters of translation in syntax defined by {@link TransignalConfig.paramHandler}
+     */
+    plural: <ObjKey extends PluralPaths<Context>>(key: ObjKey, count: number, params?: TranslateParams) => string;
+    /**
+     * Returns translating function that returns a string translation depending on a selected value
+     * @param key path of translation
+     * @param value value to determine selected translation
+     * @param params parameters of translation in syntax defined by {@link TransignalConfig.paramHandler}
+     */
+    select: <ObjKey extends SelectPaths<Context>>(key: ObjKey, value: keyof SelectTranslation | null, params?: TranslateParams) => string;
+    /**
+     * Returns translating function that is encapsulated in a selected prefix
+     * @param prefix path of new root translation
+     */
+    prefix: <T extends ObjectPaths<Context>>(prefix: T) => TranslateObj<GetNestedType<Context, T>>;
+};
+export type TranslationFile = Record<string, unknown>;
+export type TransignalConfig<Languages extends string, Translations extends Record<string, Record<string, unknown>>> = {
+    /**
+     * Default language code
+     */
+    defaultLang: NoInfer<Languages>;
+    /**
+     * An array of available languages that your application supports.
+     * These should be unique string identifiers for each language (e.g., ['en', 'fr', 'es']).
+     */
+    availableLangs: Languages[];
+    /**
+     * Defines the type of translations.
+     * Please use helper function {@link treeShakedTranslations()}
+     * @example
+     * ```typescript
+     * import type translations from './i18n/translations';
+     * ...
+     * translations: treeShakedTranslations<typeof translations>(),
+     * ```
+     */
+    translations: Translations;
+    /**
+     * A function responsible for dynamically loading translation files.
+     * This function is called when a specific translation scope and language is requested
+     * It runs in TransignalService injection context so {@link inject()} can be used to e.g. use HttpClient
+     *
+     * @param scope The string key representing the translation scope (e.g., 'common', 'auth').
+     * @param lang The language identifier for which to load translations (e.g., 'en', 'fr').
+     * @returns A Promise that resolves to a `TranslationFile` object, which is
+     * a record of string keys to unknown values representing the translations for
+     * the given scope and language.
+     */
+    loader: (scope: StringKeys<Translations>, lang: Languages) => Promise<TranslationFile>;
+    /**
+     * An optional function that defines how a loading message should be displayed
+     * while translations are being loaded.
+     *
+     * @param key The translation key that is currently being loaded.
+     * @returns A string representing the loading message.
+     */
+    loadingFn?: (key: string) => string;
+    /**
+     * An optional function that defines how params should be processed
+     * Defaults to {@link simpleParamsHandler}
+     * Use {@link noParamsHandler} if you don't want to use params
+     * If you want to handle message format then you can install TODO
+     */
+    paramHandler?: ParamHandler;
+    /**
+     * An optional error handler function that will be called when a `TransignalError` occurs.
+     * This allows you to implement custom error reporting or logging.
+     *
+     * @param errorCode Code of an error {@link TransignalError} code that occurred.
+     * @param args Any additional arguments relevant to the error.
+     */
+    errorHandler?: (errorCode: TransignalError, ...args: unknown[]) => void;
+    /**
+     * Defines max depth of prefix functions in {@link TranslateObj}
+     * Defaults to 3, this means that if prefix function is used more than 3 time on the same t then it will fail
+     * Required for performance reasons
+     */
+    maxPrefixDepth?: number;
+};

package/lib-esm/lib/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/lib-esm/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":[""],"names":[],"mappings":""}

package/lib-esm/lib/utility-types.d.ts

@@ -0,0 +1,29 @@
+import { Signal } from '@angular/core';
+import { PluralTranslation, SelectTranslation } from './types';
+export type GetNestedType<T, P extends string> = P extends `${infer Key}.${infer Rest}` ? Key extends keyof T ? GetNestedType<T[Key], Rest> : never : P extends keyof T ? NonNullable<T[P]> : never;
+type DotPrefix<T extends string> = T extends '' ? '' : `.${T}`;
+export type Paths<T> = T extends object ? T extends Array<infer U> ? `${number}${'' | DotPrefix<Paths<U>>}` : {
+    [K in keyof T]-?: K extends string | number ? `${K}${'' | DotPrefix<Paths<T[K]>>}` : never;
+}[keyof T] : '';
+export type ArrayPaths<T> = {
+    [P in Paths<T>]: GetNestedType<T, P> extends Array<unknown> ? P : never;
+}[Paths<T>];
+export type ObjectPaths<T> = {
+    [P in Paths<T>]: GetNestedType<T, P> extends Record<any, unknown> ? P : never;
+}[Paths<T>];
+export type PluralPaths<T> = {
+    [P in Paths<T>]: GetNestedType<T, P> extends PluralTranslation ? P : never;
+}[Paths<T>];
+export type SelectPaths<T> = {
+    [P in Paths<T>]: GetNestedType<T, P> extends SelectTranslation ? P : never;
+}[Paths<T>];
+export type StringPaths<T> = {
+    [P in Paths<T>]: GetNestedType<T, P> extends string ? P : never;
+}[Paths<T>];
+export type StringKeys<T> = Extract<keyof T, string>;
+export type ResourceRefLike<T> = {
+    value: Signal<T | undefined>;
+    isLoading: Signal<boolean>;
+    error: Signal<Error | undefined>;
+};
+export {};

package/lib-esm/lib/utility-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=utility-types.js.map

package/lib-esm/lib/utility-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utility-types.js","sourceRoot":"","sources":[""],"names":[],"mappings":""}

package/lib-esm/lib/utils.d.ts

@@ -0,0 +1,15 @@
+import { BasePluralTranslation, BaseSelectTranslation, MarkedAsSelect, PluralTranslation } from './types';
+/**
+ * Utility to create a plural translation that can differ between languages and includes variants of translations for different plurals
+ * Can be used with {@link TranslateObj.plural}
+ * Translations may use automatic param: `{count}`
+ * @param translation plural translation object
+ */
+export declare const plural: (translation: BasePluralTranslation) => PluralTranslation;
+/**
+ * Utility to create a select translation
+ * Can be used with {@link TranslateObj.select}
+ * Translations may use automatic param: `{value}`
+ * @param translation select translation object
+ */
+export declare const select: <T extends BaseSelectTranslation>(translation: T) => MarkedAsSelect<T>;

package/lib-esm/lib/utils.js

@@ -0,0 +1,15 @@
+/**
+ * Utility to create a plural translation that can differ between languages and includes variants of translations for different plurals
+ * Can be used with {@link TranslateObj.plural}
+ * Translations may use automatic param: `{count}`
+ * @param translation plural translation object
+ */
+export const plural = (translation) => translation;
+/**
+ * Utility to create a select translation
+ * Can be used with {@link TranslateObj.select}
+ * Translations may use automatic param: `{value}`
+ * @param translation select translation object
+ */
+export const select = (translation) => translation;
+//# sourceMappingURL=utils.js.map

package/lib-esm/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":[""],"names":[],"mappings":"AAOA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,WAAkC,EAAqB,EAAE,CAC9E,WAAgC,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAkC,WAAc,EAAE,EAAE,CACxE,WAAgC,CAAC"}

package/lib-prod/build-info._auto-generated_.d.ts

@@ -0,0 +1,24 @@
+/**
+ *  Autogenerated by current cli tool
+ */
+export declare const BUILD_FRAMEWORK_CLI_NAME = "tnp";
+/**
+ *  This value can be change in taon.jsonc (appId)
+ */
+export declare const APP_ID = "com.domain.example.i18n";
+/**
+ *  Autogenerated by current cli tool
+ */
+export declare const BUILD_BASE_HREF = "";
+/**
+ *  This value can be change in taon.jsonc (overrideNpmName)
+ */
+export declare const PROJECT_NPM_NAME = "@taon-dev/i18n";
+/**
+ * Taon version from you project taon.json
+ */
+export declare const CURRENT_PACKAGE_TAON_VERSION = "v21";
+/**
+ *  Autogenerated by current cli tool. Use *tnp release* to bump version.
+ */
+export declare const CURRENT_PACKAGE_VERSION = "0.0.1";

package/lib-prod/build-info._auto-generated_.js

@@ -0,0 +1,27 @@
+// THIS FILE IS GENERATED - DO NOT MODIFY
+/**
+ *  Autogenerated by current cli tool
+ */
+export const BUILD_FRAMEWORK_CLI_NAME = 'tnp';
+/**
+ *  This value can be change in taon.jsonc (appId)
+ */
+export const APP_ID = 'com.domain.example.i18n';
+/**
+ *  Autogenerated by current cli tool
+ */
+export const BUILD_BASE_HREF = '';
+/**
+ *  This value can be change in taon.jsonc (overrideNpmName)
+ */
+export const PROJECT_NPM_NAME = '@taon-dev/i18n';
+/**
+ * Taon version from you project taon.json
+ */
+export const CURRENT_PACKAGE_TAON_VERSION = 'v21';
+/**
+ *  Autogenerated by current cli tool. Use *tnp release* to bump version.
+ */
+export const CURRENT_PACKAGE_VERSION = '0.0.1';
+// THIS FILE IS GENERATED - DO NOT MODIFY
+//# sourceMappingURL=build-info._auto-generated_.js.map

package/lib-prod/build-info._auto-generated_.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build-info._auto-generated_.js","sourceRoot":"","sources":[""],"names":[],"mappings":"AAAA,yCAAyC;AACzC;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,KAAK,CAAC;AAC9C;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,yBAAyB,CAAC;AAChD;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,EAAE,CAAC;AAClC;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,gBAAgB,CAAC;AACjD;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,KAAK,CAAC;AAClD;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,OAAO,CAAC;AAM/C,yCAAyC"}

package/lib-prod/env/env.angular-node-app.d.ts

@@ -0,0 +1,67 @@
+export declare const ENV_ANGULAR_NODE_APP_LOADING_PRE_ANGULAR_BOOTSTRAP_BACKGROUND = "#fdebed";
+export declare const ENV_ANGULAR_NODE_APP_LOADING_PRE_ANGULAR_BOOTSTRAP_LOADER_NAME = "lds-default";
+export declare const ENV_ANGULAR_NODE_APP_WEBSITE_DOMAIN = "i18n.example.domain.com";
+export declare const ENV_ANGULAR_NODE_APP_WEBSITE_TITLE = "I 18 N";
+export declare const ENV_ANGULAR_NODE_APP_WEBSITE_USE_DOMAIN = true;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_TARGET_ARTIFACT = "angular-node-app";
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_ENV_NAME = "__";
+export declare const ENV_ANGULAR_NODE_APP_CONTAINER_ONLY: any;
+export declare const ENV_ANGULAR_NODE_APP_CONTAINER_END: any;
+export declare const ENV_ANGULAR_NODE_APP_CONTAINER_START: any;
+export declare const ENV_ANGULAR_NODE_APP_CONTAINER_SKIP_RELEASED: any;
+export declare const ENV_ANGULAR_NODE_APP_CONTAINER_SKIP: any;
+export declare const ENV_ANGULAR_NODE_APP_INIT_BRANDING: any;
+export declare const ENV_ANGULAR_NODE_APP_INIT_STRUCT: any;
+export declare const ENV_ANGULAR_NODE_APP_BUILD_PWA_DISABLE_SERVICE_WORKER: any;
+export declare const ENV_ANGULAR_NODE_APP_BUILD_PWA_NAME: any;
+export declare const ENV_ANGULAR_NODE_APP_BUILD_PWA_SHORT_NAME: any;
+export declare const ENV_ANGULAR_NODE_APP_BUILD_PWA_START_URL: any;
+export declare const ENV_ANGULAR_NODE_APP_BUILD_ELECTRON_SHOW_DEV_TOOLS: any;
+export declare const ENV_ANGULAR_NODE_APP_BUILD_SSR: any;
+export declare const ENV_ANGULAR_NODE_APP_BUILD_WEBSQL: any;
+export declare const ENV_ANGULAR_NODE_APP_BUILD_PROD: any;
+export declare const ENV_ANGULAR_NODE_APP_BUILD_OVERRIDE_OUTPUT_PATH: any;
+export declare const ENV_ANGULAR_NODE_APP_BUILD_BASE_HREF: any;
+export declare const ENV_ANGULAR_NODE_APP_BUILD_WATCH: any;
+export declare const ENV_ANGULAR_NODE_APP_BUILD_GEN_ONLY_CLIENT_CODE: any;
+export declare const ENV_ANGULAR_NODE_APP_LOADING_PRE_ANGULAR_BOOTSTRAP_LOADER: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_CLI_MINIFY: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_CLI_INCLUDE_NODE_MODULES: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_CLI_UGLIFY: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_CLI_OBSCURE: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_CLI_COMPRESS: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_NODE_BACKEND_APP_MINIFY: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_LIB_REMOVE_DTS: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_LIB_OBSCURE_FILE_BY_FILE: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_LIB_UGLIFY_FILE_BY_FILE: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_LIB_INCLUDE_SOURCE_MAPS: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_LIB_COMPRESS: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_LIB_DO_NOT_INCLUDE_LIB_FILES: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_RESOLVED_NEW_VERSION: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_RELEASE_VERSION_BUMP_TYPE: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_ENV_NUMBER: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_INSTALL_LOCALLY: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_REMOVE_RELEASE_OUTPUT_AFTER_LOCAL_INSTALL: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_RELEASE_TYPE: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_AUTO_RELEASE_USING_CONFIG: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_AUTO_RELEASE_TASK_NAME: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_TAON_INSTANCE_IP: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_SKIP_NPM_PUBLISH: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_SKIP_DEPLOY: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_SKIP_TAG_GIT_PUSH: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_SKIP_RELEASE_QUESTION: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_SKIP_RESOLVING_GIT_CHANGES: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_SKIP_CODE_CUTTING: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_SKIP_BUILDING_ARTIFACTS: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_PUSH_TO_ALL_ORIGINS_WHEN_LOCAL_RELEASE_BRANCH: any;
+export declare const ENV_ANGULAR_NODE_APP_RELEASE_USE_LOCAL_RELEASE_BRANCH: any;
+export declare const ENV_ANGULAR_NODE_APP_COPY_TO_MANAGER_BEFORE_COPY_HOOK: any;
+export declare const ENV_ANGULAR_NODE_APP_COPY_TO_MANAGER_COPY_TO_LOCATIONS: any;
+export declare const ENV_ANGULAR_NODE_APP_COPY_TO_MANAGER_COPY_TO_PROJECTS: any;
+export declare const ENV_ANGULAR_NODE_APP_COPY_TO_MANAGER_SKIP: any;
+export declare const ENV_ANGULAR_NODE_APP_PURPOSE: any;
+export declare const ENV_ANGULAR_NODE_APP_RECURSIVE_ACTION: any;
+export declare const ENV_ANGULAR_NODE_APP_IS_CI_PROCESS: any;
+export declare const ENV_ANGULAR_NODE_APP_DOCKER_ADDITIONAL_CONTAINER: any;
+export declare const ENV_ANGULAR_NODE_APP_DOCKER_SKIP_START_IN_ORDER: any;
+export declare const ENV_ANGULAR_NODE_APP_DOCKER_SKIP_USING_MYSQL_DB: any;