@taon-dev/i18n 0.0.1

package/websql-prod/types/i18n-websql-prod.d.ts

@@ -0,0 +1,353 @@
+// @ts-nocheck
+import * as i18n_websql_prod from 'i18n/websql-prod';
+import * as _angular_core from '@angular/core';
+import { EnvironmentProviders, Signal, InjectionToken } from '@angular/core';
+
+/**
+ *  Autogenerated by current cli tool
+ */
+declare const BUILD_FRAMEWORK_CLI_NAME = "tnp";
+/**
+ *  This value can be change in taon.jsonc (appId)
+ */
+declare const APP_ID = "com.domain.example.i18n";
+/**
+ *  Autogenerated by current cli tool
+ */
+declare const BUILD_BASE_HREF = "";
+/**
+ *  This value can be change in taon.jsonc (overrideNpmName)
+ */
+declare const PROJECT_NPM_NAME = "@taon-dev/i18n";
+/**
+ * Taon version from you project taon.json
+ */
+declare const CURRENT_PACKAGE_TAON_VERSION = "v21";
+/**
+ *  Autogenerated by current cli tool. Use *tnp release* to bump version.
+ */
+declare const CURRENT_PACKAGE_VERSION = "0.0.1";
+
+declare const INTERNAL_TRANSIGNAL_CONFIG: unique symbol;
+declare const TREE_SHAKED_TRANSLATIONS: unique symbol;
+
+/**
+ *
+ * @param argsv process.argsv
+ * @param filename needed if you want ipc communicaiton
+ */
+declare function startCli(argsv: string[], filename: string): Promise<void>;
+
+type TransignalFeature<Languages extends string, Translations extends Record<string, Record<string, unknown>>> = {
+    providers: EnvironmentProviders[];
+};
+
+type ParamHandler = (translation: string, params?: TranslateParams) => string;
+/**
+ * Param handler which allows for specification of basic params: `{name}`
+ *
+ * @param translation Translated text
+ * @param params      Params provided to translation function
+ */
+declare const simpleParamsHandler: ParamHandler;
+declare const noParamsHandler: ParamHandler;
+declare const simpleParamValueStringify: (paramValue: unknown) => any;
+
+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}`;
+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] : '';
+type ArrayPaths<T> = {
+    [P in Paths<T>]: GetNestedType<T, P> extends Array<unknown> ? P : never;
+}[Paths<T>];
+type ObjectPaths<T> = {
+    [P in Paths<T>]: GetNestedType<T, P> extends Record<any, unknown> ? P : never;
+}[Paths<T>];
+type PluralPaths<T> = {
+    [P in Paths<T>]: GetNestedType<T, P> extends PluralTranslation ? P : never;
+}[Paths<T>];
+type SelectPaths<T> = {
+    [P in Paths<T>]: GetNestedType<T, P> extends SelectTranslation ? P : never;
+}[Paths<T>];
+type StringPaths<T> = {
+    [P in Paths<T>]: GetNestedType<T, P> extends string ? P : never;
+}[Paths<T>];
+type StringKeys<T> = Extract<keyof T, string>;
+type ResourceRefLike<T> = {
+    value: Signal<T | undefined>;
+    isLoading: Signal<boolean>;
+    error: Signal<Error | undefined>;
+};
+
+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';
+type TranslateParams = Record<string, unknown>;
+type Marked<K, T> = K & {
+    __marker: T;
+};
+type BasePluralTranslation = Partial<Record<number | 'one' | 'few' | 'many' | 'other', string>>;
+type PluralTranslation = Marked<BasePluralTranslation, 'plural'>;
+type BaseSelectTranslation = Partial<Record<string | number | 'null', string>>;
+type MarkedAsSelect<T extends BaseSelectTranslation> = Marked<T, 'select'>;
+type SelectTranslation = MarkedAsSelect<BaseSelectTranslation>;
+type TranslateFn<Keys extends string, Result> = (key: Keys, params?: TranslateParams) => Result;
+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>>;
+};
+type TranslationFile = Record<string, unknown>;
+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;
+};
+
+/**
+ * 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)
+ */
+declare class TransignalService<Languages extends string, Translations extends Record<string, Record<string, any>>, Scopes extends StringKeys<Translations>> {
+    private readonly injector;
+    private readonly config;
+    private readonly paramsHandler;
+    private readonly loadingFn;
+    private readonly errorHandler;
+    private readonly loadingCount;
+    private readonly scopeMap;
+    private readonly languageMap;
+    /**
+     * Use to set or get active language
+     */
+    readonly activeLang: _angular_core.WritableSignal<Languages>;
+    /**
+     * Use to determine whether service is currently loading translation files
+     */
+    readonly isLoading: _angular_core.Signal<boolean>;
+    t<Scope extends Scopes>(scope: Scope): TranslateObj<Translations[Scope]>;
+    private initT;
+    private preparePrefixFn;
+    private preparePluralFn;
+    private prepareSelectFn;
+    protected replaceParams<T>(translation: T, params?: TranslateParams): T;
+    private fetchLanguage;
+    private resolveObjectPath;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<TransignalService<any, any, any>, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<TransignalService<any, any, any>>;
+}
+
+/**
+ * Utility function to define a type of translations for type inference
+ */
+declare const treeShakedTranslations: <Translations extends Record<string, Record<string, unknown>>>() => Translations;
+declare const TRANSIGNAL_CONFIG: InjectionToken<unknown>;
+/**
+ * Use to inject transignal config
+ */
+declare const injectTransignalConfig: <Languages extends string, Translations extends Record<string, Record<string, unknown>>>() => TransignalConfig<Languages, Translations>;
+/**
+ * Prepares type-safe transignal object
+ * @param config Transignal configruation {@link TransignalConfig}
+ * @param features Extra tree-shakeable features
+ * - {@link withPreloadScopes} - preloads selected scopes
+ * - {@link withServerSideLanguage} - sets language based on `document.lang` in SSR environment
+ * - {@link withNavigatorLanguage} - sets language based on `navigator.language` in browser environment
+ * - {@link withLanguageLocalStorageSync} - syncs language with localStorage
+ * - {@link withTranslatedTitle} - enables translation of page title
+ */
+declare const prepareTransignal: <Languages extends string, Translations extends Record<string, Record<string, unknown>>>(config: TransignalConfig<Languages, Translations>, ...features: NoInfer<TransignalFeature<Languages, Translations>[]>) => {
+    [INTERNAL_TRANSIGNAL_CONFIG]: {
+        config: TransignalConfig<Languages, Translations>;
+        features: TransignalFeature<Languages, Translations>[];
+    };
+    provide: () => _angular_core.EnvironmentProviders;
+    service: () => TransignalService<Languages, Translations, StringKeys<Translations>>;
+    t: <Scope extends StringKeys<Translations>>(scope: Scope) => i18n_websql_prod.TranslateObj<Translations[Scope]>;
+};
+
+/**
+ * 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
+ */
+declare const provideTransignalTesting: <Languages extends string, Translations extends Record<string, Record<string, unknown>>>(transignal: ReturnType<typeof prepareTransignal<Languages, Translations>>, translations: Translations) => _angular_core.EnvironmentProviders;
+
+/**
+ * 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
+ */
+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
+ */
+declare const select: <T extends BaseSelectTranslation>(translation: T) => MarkedAsSelect<T>;
+
+/**
+ * Saves user selected language in selected storage e.g. localStorage
+ * Works only in browser environment
+ *
+ * @param key Key under which it should save the language in storage
+ * @param storage Storage to be used e.g. localStorage or sessionStorage
+ */
+declare const withLanguageLocalStorageSync: <Languages extends string, Translations extends Record<string, Record<string, unknown>>>(key?: string, storage?: "localStorage" | "sessionStorage") => TransignalFeature<Languages, Translations>;
+
+/**
+ * Sets active language depending on `navigator.language`, which represents user defined browser settings
+ * Works only in browser environment
+ */
+declare const withNavigatorLanguage: <Languages extends string, Translations extends Record<string, Record<string, unknown>>>() => TransignalFeature<Languages, Translations>;
+
+/**
+ * Preloads selected scopes in default language
+ * Use after language init by {@link withServerSideLanguage} or {@link withNavigatorLanguage}
+ * @param scopes Scopes which should be preloaded
+ */
+declare const withPreloadScopes: <Languages extends string, Translations extends Record<string, Record<string, unknown>>>(scopes: StringKeys<Translations>[]) => TransignalFeature<Languages, Translations>;
+
+/**
+ * Sets active language depending on `document.lang` attribute which should be set by the server.ts depending on `Accept-language` header
+ * Works only in SSR environment
+ */
+declare const withServerSideLanguage: <Languages extends string, Translations extends Record<string, Record<string, unknown>>>() => TransignalFeature<Languages, Translations>;
+
+/**
+ * Enables translation of title param in route definition with use of prepared {@link TitleStrategy}
+ * Automatically translates `title` param form route definition, sets website title and updates on language changes
+ * Also it is possible to use parameters from `navigation.extras.state`
+ *
+ * @example
+ * ```typescript
+ * // src/app/app.routes.ts
+ * export const routes = [
+ *   { path: 'base', title: 'base', children: [
+ *     { path: 'child', title: 'child' },
+ *   ],
+ *   { path: 'aux', outlet: 'popup', title: 'popupTitle' }
+ * ];
+ *
+ * // src/app/transignal.ts
+ * export const transignal = prepareTransignal(<config>, withTranslatedTitle('global'));
+ *
+ * // src/app/i18n/global/en.ts
+ * export default {
+ *   title: {
+ *     base: 'Base title',
+ *     child: 'Child title'
+ *     popupTitle: 'Popup title'
+ *   }
+ * };
+ * ```
+ *
+ * @param scope scope under which there are title translations
+ * @param translationKey translation key under which there are translations, `title` by default
+ */
+declare const withTranslatedTitle: <Languages extends string, Translations extends Record<string, Record<string, unknown>>>(scope: StringKeys<Translations>, translationKey?: string) => TransignalFeature<Languages, Translations>;
+
+export { APP_ID, BUILD_BASE_HREF, BUILD_FRAMEWORK_CLI_NAME, CURRENT_PACKAGE_TAON_VERSION, CURRENT_PACKAGE_VERSION, INTERNAL_TRANSIGNAL_CONFIG, PROJECT_NPM_NAME, TRANSIGNAL_CONFIG, TREE_SHAKED_TRANSLATIONS, TransignalService, injectTransignalConfig, noParamsHandler, plural, prepareTransignal, provideTransignalTesting, select, simpleParamValueStringify, simpleParamsHandler, startCli, treeShakedTranslations, withLanguageLocalStorageSync, withNavigatorLanguage, withPreloadScopes, withServerSideLanguage, withTranslatedTitle };
+export type { ArrayPaths, BasePluralTranslation, BaseSelectTranslation, GetNestedType, Marked, MarkedAsSelect, ObjectPaths, ParamHandler, Paths, PluralPaths, PluralTranslation, ResourceRefLike, SelectPaths, SelectTranslation, StringKeys, StringPaths, TransignalConfig, TransignalError, TransignalFeature, TranslateFn, TranslateObj, TranslateParams, TranslationFile };

package/websql-prod.re-export.json

@@ -0,0 +1 @@
+{}

package/websql-prod.split-namespaces.json

@@ -0,0 +1,4 @@
+{
+  "namespacesMapObj": {},
+  "namespacesReplace": {}
+}