@sveltekit-i18n/base 1.3.7 → 3.0.0-next.0

package/dist/index.d.ts

@@ -1,227 +1,2 @@
-import { Readable, Writable } from 'svelte/store';
-
-type ExtendedStore<T, Get = () => T, Store = Readable<T>> = Store & {
-    get: Get;
-};
-type LoadingStore = Readable<boolean> & {
-    toPromise: (locale?: Config.Locale, route?: string) => Promise<void[] | void>;
-    get: () => boolean;
-};
-declare namespace DotNotation {
-    type Input = any;
-    type Output<V = any, K extends keyof V = keyof V> = {
-        [P in K]?: V[K];
-    } | null | V;
-    type T = <I = Input>(input: I, preserveArrays?: boolean, parentKey?: string) => Output<I>;
-}
-declare namespace Logger {
-    type Level = 'error' | 'warn' | 'debug';
-    type Prefix = string;
-    type T = {
-        [key in Logger.Level]: (value: any) => void;
-    };
-    type FactoryProps = {
-        /**
-         * You can setup your custom logger using this property.
-         *
-         * @default console
-         */
-        logger?: Logger.T;
-        /**
-         * You can manage log level using this property.
-         *
-         * @default 'warn'
-         */
-        level?: Logger.Level;
-        /**
-         * You can prefix output logs using this property.
-         *
-         * @default '[i18n]: '
-         */
-        prefix?: Logger.Prefix;
-    };
-}
-declare namespace Config {
-    type Loader = Loader.LoaderModule;
-    type Translations = Translations.T;
-    type Locale = Translations.Locales[number];
-    type InitLocale = Locale | undefined;
-    type FallbackLocale = Locale | undefined;
-    type FallbackValue = any;
-    type T<P extends Parser.Params = Parser.Params> = {
-        /**
-         * You can use loaders to define your asyncronous translation load. All loaded data are stored so loader is triggered only once – in case there is no previous version of the translation. It can get refreshed according to `config.cache`.
-         */
-        loaders?: Loader[];
-        /**
-         * Locale-indexed translations, which should be in place before loaders will trigger. It's useful for static pages and synchronous translations – for example locally defined language names which are the same for all of the language mutations.
-         *
-         * @example {
-         *  "en": {"lang": {"en": "English", "cs": "Česky"}}
-         *  "cs": {"lang": {"en": "English", "cs": "Česky"}}
-         * }
-         */
-        translations?: Translations.T;
-        /**
-         * If you set this property, translations will be initialized immediately using this locale.
-         */
-        initLocale?: InitLocale;
-        /**
-         * If you set this property, translations are automatically loaded not for current `$locale` only, but for this locale as well. In case there is no translation for current `$locale`, fallback locale translation is used instead of translation key placeholder. This is also used as a fallback when unknown locale is set.
-         */
-        fallbackLocale?: FallbackLocale;
-        /**
-         * By default, translation key is returned in case no translation is found for given translation key. For example, `$t('unknown.key')` will result in `'unknown.key'` output. You can set this output value using this config prop.
-         */
-        fallbackValue?: FallbackValue;
-        /**
-         * Preprocessor strategy or a custom function. Defines, how to transform the translation data immediately after the load.
-         * @default 'full'
-         *
-         * @example 'full'
-         * {a: {b: [{c: {d: 1}}, {c: {d: 2}}]}} => {"a.b.0.c.d": 1, "a.b.1.c.d": 2}
-         *
-         * @example 'preserveArrays'
-         * {a: {b: [{c: {d: 1}}, {c: {d: 2}}]}} => {"a.b": [{"c.d": 1}, {"c.d": 2}]}
-         *
-         * @example 'none'
-         * {a: {b: [{c: {d: 1}}, {c: {d: 2}}]}} => {a: {b: [{c: {d: 1}}, {c: {d: 2}}]}}
-         */
-        preprocess?: 'full' | 'preserveArrays' | 'none' | ((input: Translations.Input) => any);
-        /**
-         * This property defines translation syntax you want to use.
-         */
-        parser: Parser.T<P>;
-        /**
-         * When you are running your app on Node.js server, translations are loaded only once during the SSR. This property allows you to setup a refresh period in milliseconds when your translations are refetched on the server.
-         *
-         * @default 86400000 // 24 hours
-         *
-         * @tip You can set to `Number.POSITIVE_INFINITY` to disable server-side refreshing.
-         */
-        cache?: number;
-        /**
-         * Custom logger configuration.
-         */
-        log?: Logger.FactoryProps;
-    };
-}
-declare namespace Loader {
-    type Key = string;
-    type Locale = Config.Locale;
-    type Route = string | RegExp;
-    type IndexedKeys = Translations.LocaleIndexed<Key[]>;
-    type LoaderModule = {
-        /**
-         * Represents the translation namespace. This key is used as a translation prefix so it should be module-unique. You can access your translation later using `$t('key.yourTranslation')`. It shouldn't include `.` (dot) character.
-         */
-        key: Key;
-        /**
-         * Locale (e.g. `en`, `de`) which is this loader for.
-         */
-        locale: Locale;
-        /**
-         * Function returning a `Promise` with translation data. You can use it to load files locally, fetch it from your API etc...
-        */
-        loader: T;
-        /**
-        * Define routes this loader should be triggered for. You can use Regular expressions too. For example `[/\/.ome/]` will be triggered for `/home` and `/rome` route as well (but still only once). Leave this `undefined` in case you want to load this module with any route (useful for common translations).
-        */
-        routes?: Route[];
-    };
-    type T = () => Promise<Translations.Input>;
-}
-declare namespace Parser {
-    type Value = any;
-    type Params = Array<unknown>;
-    type Locale = Config.Locale;
-    type Key = Loader.Key;
-    type Output = any;
-    type Parse<P extends Parser.Params = Parser.Params> = (
-    /**
-     * Translation value from the definitions.
-    */
-    value: Value, 
-    /**
-     * Array of rest parameters given by user (e.g. payload variables etc...)
-     */
-    params: P, 
-    /**
-     * Locale of translated message.
-     */
-    locale: Locale, 
-    /**
-     * This key is serialized path to translation (e.g., `home.content.title`)
-     */
-    key: Key) => Output;
-    type T<P extends Parser.Params = Parser.Params> = {
-        /**
-         * Parse function deals with interpolation of user payload and returns interpolated message.
-        */
-        parse: Parse<P>;
-    };
-}
-declare namespace Translations {
-    type Locales<T = string> = T[];
-    type SerializedTranslations = LocaleIndexed<DotNotation.Input>;
-    type TranslationData<T = any> = Loader.LoaderModule & {
-        data: T;
-    };
-    type FetchTranslations = (loaders: Loader.LoaderModule[]) => Promise<SerializedTranslations>;
-    type TranslationFunction<P extends Parser.Params = Parser.Params> = (key: string, ...restParams: P) => any;
-    type LocalTranslationFunction<P extends Parser.Params = Parser.Params> = (locale: Config.Locale, key: string, ...restParams: P) => any;
-    type Translate = <P extends Parser.Params = Parser.Params>(props: {
-        parser: Parser.T<P>;
-        key: string;
-        params: P;
-        translations: SerializedTranslations;
-        locale: Locales[number];
-        fallbackLocale?: Config.FallbackLocale;
-        fallbackValue?: Config.FallbackValue;
-    }) => string;
-    type Input<V = any> = {
-        [K in any]: Input<V> | V;
-    };
-    type LocaleIndexed<V, L extends string = string> = {
-        [locale in Locales<L>[number]]: V;
-    };
-    type T<V = any, L extends string = string> = LocaleIndexed<Input<V>, L>;
-}
-
-declare class I18n<ParserParams extends Parser.Params = any> {
-    constructor(config?: Config.T<ParserParams>);
-    private cachedAt;
-    private loadedKeys;
-    private currentRoute;
-    private config;
-    private isLoading;
-    private promises;
-    loading: LoadingStore;
-    private privateRawTranslations;
-    rawTranslations: ExtendedStore<Translations.SerializedTranslations>;
-    private privateTranslations;
-    translations: ExtendedStore<Translations.SerializedTranslations>;
-    locales: ExtendedStore<Config.Locale[]>;
-    private internalLocale;
-    private loaderTrigger;
-    private localeHelper;
-    locale: ExtendedStore<Config.Locale, () => Config.Locale, Writable<string>> & {
-        forceSet: any;
-    };
-    initialized: Readable<boolean>;
-    private translation;
-    t: ExtendedStore<Translations.TranslationFunction<ParserParams>, Translations.TranslationFunction<ParserParams>>;
-    l: ExtendedStore<Translations.LocalTranslationFunction<ParserParams>, Translations.LocalTranslationFunction<ParserParams>>;
-    private getLocale;
-    setLocale: (locale?: string) => Promise<void | void[]> | undefined;
-    setRoute: (route: string) => Promise<void | void[]> | undefined;
-    configLoader(config: Config.T<ParserParams>): Promise<void>;
-    loadConfig: (config: Config.T<ParserParams>) => Promise<void>;
-    getTranslationProps: ($locale?: string, $route?: string) => Promise<[Translations.SerializedTranslations, Loader.IndexedKeys] | [
-    ]>;
-    addTranslations: (translations?: Translations.SerializedTranslations, keys?: Loader.IndexedKeys) => void;
-    private loader;
-    loadTranslations: (locale: Config.Locale, route?: string) => Promise<void | void[]> | undefined;
-}
-
-export { Config, Loader, Logger, Parser, Translations, I18n as default };
+export { default, I18n } from './I18n.svelte.js';
+export type { Config, Extension, Loader, Logger, Parser, Schema, Translations } from './types.js';

package/dist/index.js

@@ -1 +1 @@
-var H=Object.defineProperty,q=Object.defineProperties;var B=Object.getOwnPropertyDescriptors;var x=Object.getOwnPropertySymbols;var K=Object.prototype.hasOwnProperty,A=Object.prototype.propertyIsEnumerable;var N=(s,t,e)=>t in s?H(s,t,{enumerable:!0,configurable:!0,writable:!0,value:e}):s[t]=e,l=(s,t)=>{for(var e in t||(t={}))K.call(t,e)&&N(s,e,t[e]);if(x)for(var e of x(t))A.call(t,e)&&N(s,e,t[e]);return s},f=(s,t)=>q(s,B(t));var L=(s,t)=>{var e={};for(var a in s)K.call(s,a)&&t.indexOf(a)<0&&(e[a]=s[a]);if(s!=null&&x)for(var a of x(s))t.indexOf(a)<0&&A.call(s,a)&&(e[a]=s[a]);return e};import{derived as v,get as g,writable as m}from"svelte/store";var C=["error","warn","debug"],$=({logger:s=console,level:t=C[1],prefix:e="[i18n]: "})=>C.reduce((a,r,i)=>f(l({},a),{[r]:o=>C.indexOf(t)>=i&&s[r](`${e}${o}`)}),{}),c=$({}),V=s=>{c=s};var z=n=>{var d=n,{parser:s,key:t,params:e,translations:a,locale:r,fallbackLocale:i}=d,o=L(d,["parser","key","params","translations","locale","fallbackLocale"]);if(!t)return c.warn(`No translation key provided ('${r}' locale). Skipping translation...`),"";if(!r)return c.warn(`No locale provided for '${t}' key. Skipping translation...`),"";let u=(a[r]||{})[t];if(i&&u===void 0&&(c.debug(`No translation provided for '${t}' key in locale '${r}'. Trying fallback '${i}'`),u=(a[i]||{})[t]),u===void 0){if(c.debug(`No translation provided for '${t}' key in fallback '${i}'.`),o.hasOwnProperty("fallbackValue"))return o.fallbackValue;c.warn(`No translation nor fallback found for '${t}' .`)}return s.parse(u,e,r,t)},h=(...s)=>s.length?s.filter(t=>!!t).map(t=>{let e=`${t}`.toLowerCase();try{let[a]=Intl.Collator.supportedLocalesOf(t);if(!a)throw new Error;e=a}catch(a){c.warn(`'${t}' locale is non-standard.`)}return e}):[],w=(s,t,e)=>{if(t&&Array.isArray(s))return s.map(a=>w(a,t));if(s&&typeof s=="object"){let a=Object.keys(s).reduce((r,i)=>{let o=s[i],n=e?`${e}.${i}`:`${i}`;return o&&typeof o=="object"&&!(t&&Array.isArray(o))?l(l({},r),w(o,t,n)):f(l({},r),{[n]:w(o,t)})},{});return Object.keys(a).length?a:null}return s},G=s=>s.reduce((t,{key:e,data:a,locale:r})=>{if(!a)return t;let[i]=h(r),o=f(l({},t[i]||{}),{[e]:a});return f(l({},t),{[i]:o})},{}),E=async s=>{try{let t=await Promise.all(s.map(r=>{var i=r,{loader:e}=i,a=L(i,["loader"]);return new Promise(async o=>{let n;try{n=await e()}catch(d){c.error(`Failed to load translation. Verify your '${a.locale}' > '${a.key}' Loader.`),c.error(d)}o(f(l({loader:e},a),{data:n}))})}));return G(t)}catch(t){c.error(t)}return{}},W=s=>t=>{try{if(typeof t=="string")return t===s;if(typeof t=="object")return t.test(s)}catch(e){c.error("Invalid route config!")}return!1},F=(s,t)=>{let e=!0;try{e=Object.keys(s).filter(a=>s[a]!==void 0).every(a=>s[a]===t[a])}catch(a){}return e};var D=1e3*60*60*24,O=class{constructor(t){this.cachedAt=0;this.loadedKeys={};this.currentRoute=m();this.config=m();this.isLoading=m(!1);this.promises=new Set;this.loading={subscribe:this.isLoading.subscribe,toPromise:(t,e)=>{let{fallbackLocale:a}=g(this.config),r=Array.from(this.promises).filter(i=>{let o=F({locale:h(t)[0],route:e},i);return a&&(o=o||F({locale:h(a)[0],route:e},i)),o}).map(({promise:i})=>i);return Promise.all(r)},get:()=>g(this.isLoading)};this.privateRawTranslations=m({});this.rawTranslations={subscribe:this.privateRawTranslations.subscribe,get:()=>g(this.rawTranslations)};this.privateTranslations=m({});this.translations={subscribe:this.privateTranslations.subscribe,get:()=>g(this.translations)};this.locales=f(l({},v([this.config,this.privateTranslations],([t,e])=>{if(!t)return[];let{loaders:a=[]}=t,r=a.map(({locale:o})=>o),i=Object.keys(e).map(o=>o);return Array.from(new Set([...h(...r),...h(...i)]))},[])),{get:()=>g(this.locales)});this.internalLocale=m();this.loaderTrigger=v([this.internalLocale,this.currentRoute],([t,e],a)=>{var r,i;t!==void 0&&e!==void 0&&!(t===((r=g(this.loaderTrigger))==null?void 0:r[0])&&e===((i=g(this.loaderTrigger))==null?void 0:i[1]))&&(c.debug("Triggering translation load..."),a([t,e]))},[]);this.localeHelper=m();this.locale={subscribe:this.localeHelper.subscribe,forceSet:this.localeHelper.set,set:this.internalLocale.set,update:this.internalLocale.update,get:()=>g(this.locale)};this.initialized=v([this.locale,this.currentRoute,this.privateTranslations],([t,e,a],r)=>{g(this.initialized)||r(t!==void 0&&e!==void 0&&!!Object.keys(a).length)});this.translation=v([this.privateTranslations,this.locale,this.isLoading],([t,e,a],r)=>{let i=t[e];i&&Object.keys(i).length&&!a&&r(i)},{});this.t=f(l({},v([this.config,this.translation],r=>{var[i]=r,o=i,{parser:t,fallbackLocale:e}=o,a=L(o,["parser","fallbackLocale"]);return(n,...d)=>z(l({parser:t,key:n,params:d,translations:this.translations.get(),locale:this.locale.get(),fallbackLocale:e},a.hasOwnProperty("fallbackValue")?{fallbackValue:a.fallbackValue}:{}))})),{get:(t,...e)=>g(this.t)(t,...e)});this.l=f(l({},v([this.config,this.translations],i=>{var[o,...n]=i,d=o,{parser:t,fallbackLocale:e}=d,a=L(d,["parser","fallbackLocale"]),[r]=n;return(u,b,...k)=>z(l({parser:t,key:b,params:k,translations:r,locale:u,fallbackLocale:e},a.hasOwnProperty("fallbackValue")?{fallbackValue:a.fallbackValue}:{}))})),{get:(t,e,...a)=>g(this.l)(t,e,...a)});this.getLocale=t=>{let{fallbackLocale:e}=g(this.config)||{},a=t||e;if(!a)return;let r=this.locales.get();return r.find(o=>h(a).includes(o))||r.find(o=>h(e).includes(o))};this.setLocale=t=>{if(t&&t!==g(this.internalLocale))return c.debug(`Setting '${t}' locale.`),this.internalLocale.set(t),this.loading.toPromise(t,g(this.currentRoute))};this.setRoute=t=>{if(t!==g(this.currentRoute)){c.debug(`Setting '${t}' route.`),this.currentRoute.set(t);let e=g(this.internalLocale);return this.loading.toPromise(e,t)}};this.loadConfig=async t=>{await this.configLoader(t)};this.getTranslationProps=async(t=this.locale.get(),e=g(this.currentRoute))=>{let a=g(this.config);if(!a||!t)return[];let r=this.translations.get(),{loaders:i,fallbackLocale:o="",cache:n=D}=a||{},d=Number.isNaN(+n)?D:+n;this.cachedAt?Date.now()>d+this.cachedAt&&(c.debug("Refreshing cache."),this.loadedKeys={},this.cachedAt=0):(c.debug("Setting cache timestamp."),this.cachedAt=Date.now());let[u,b]=h(t,o),k=r[u],I=r[b],R=(i||[]).map(j=>{var T=j,{locale:p}=T,y=L(T,["locale"]);return f(l({},y),{locale:h(p)[0]})}).filter(({routes:p})=>!p||(p||[]).some(W(e))).filter(({key:p,locale:y})=>y===u&&(!k||!(this.loadedKeys[u]||[]).includes(p))||o&&y===b&&(!I||!(this.loadedKeys[b]||[]).includes(p)));if(R.length){this.isLoading.set(!0),c.debug("Fetching translations...");let p=await E(R);this.isLoading.set(!1);let y=Object.keys(p).reduce((T,P)=>f(l({},T),{[P]:Object.keys(p[P])}),{}),j=R.filter(({key:T,locale:P})=>(y[P]||[]).some(S=>`${S}`.startsWith(T))).reduce((T,{key:P,locale:S})=>f(l({},T),{[S]:[...T[S]||[],P]}),{});return[p,j]}return[]};this.addTranslations=(t,e)=>{if(!t)return;let a=g(this.config),{preprocess:r}=a||{};c.debug("Adding translations...");let i=Object.keys(t||{});this.privateRawTranslations.update(o=>i.reduce((n,d)=>f(l({},n),{[d]:l(l({},n[d]||{}),t[d])}),o)),this.privateTranslations.update(o=>i.reduce((n,d)=>{let u=!0,b=t[d];return typeof r=="function"&&(b=r(b)),(typeof r=="function"||r==="none")&&(u=!1),f(l({},n),{[d]:l(l({},n[d]||{}),u?w(b,r==="preserveArrays"):b)})},o)),i.forEach(o=>{let n=Object.keys(t[o]).map(d=>`${d}`.split(".")[0]);e&&(n=e[o]),this.loadedKeys[o]=Array.from(new Set([...this.loadedKeys[o]||[],...n||[]]))})};this.loader=async([t,e])=>{let a=this.getLocale(t)||void 0;c.debug(`Adding loader promise for '${a}' locale and '${e}' route.`);let r=(async()=>{let i=await this.getTranslationProps(a,e);i.length&&this.addTranslations(...i)})();this.promises.add({locale:a,route:e,promise:r}),r.then(()=>{a&&this.locale.get()!==a&&this.locale.forceSet(a)})};this.loadTranslations=(t,e=g(this.currentRoute)||"")=>{let a=this.getLocale(t);if(a)return this.setRoute(e),this.setLocale(a),this.loading.toPromise(a,e)};this.loaderTrigger.subscribe(this.loader),this.isLoading.subscribe(async e=>{e&&this.promises.size&&(await this.loading.toPromise(),this.promises.clear(),c.debug("Loader promises have been purged."))}),t&&this.loadConfig(t)}async configLoader(t){if(!t)return c.error("No config provided!");let n=t,{initLocale:e,fallbackLocale:a,translations:r,log:i}=n,o=L(n,["initLocale","fallbackLocale","translations","log"]);i&&V($(i)),[e]=h(e),[a]=h(a),c.debug("Setting config."),this.config.set(l({initLocale:e,fallbackLocale:a,translations:r},o)),r&&this.addTranslations(r),e&&await this.loadTranslations(e)}};export{O as default};
+export { default, I18n } from './I18n.svelte.js';

package/dist/logger.d.ts

@@ -0,0 +1,5 @@
+import type { Logger } from './types.js';
+export declare const loggerFactory: ({ logger, level, prefix }: Logger.FactoryProps) => Logger.T;
+export declare let logger: Logger.T;
+export declare const setLogger: (l: Logger.T) => void;
+export declare const logError: (message: string, error?: unknown) => void;

package/dist/logger.js

@@ -0,0 +1,35 @@
+const loggerLevels = ['error', 'warn', 'debug'];
+export const loggerFactory = ({ logger = console, level = loggerLevels[1], prefix = '[i18n]: ' }) => {
+    // An unknown level would otherwise yield indexOf === -1 and silence everything.
+    const levelIndex = loggerLevels.includes(level) ? loggerLevels.indexOf(level) : loggerLevels.indexOf('warn');
+    return loggerLevels.reduce((acc, key, i) => ({
+        ...acc,
+        [key]: (message, error) => {
+            if (levelIndex < i)
+                return undefined;
+            try {
+                // Inside the `try`: the logger is consumer code — it can be null, omit
+                // a level, or throw. Several call sites log from promise handlers that
+                // nothing awaits, where a throw would become an unhandled rejection.
+                if (typeof logger[key] !== 'function')
+                    return undefined;
+                // The prefix applies to the message only; the error passes through raw
+                // so the logger formats its stack (or serializes it) itself. Forwarded
+                // only when present — `console` would otherwise print `undefined`.
+                if (error === undefined)
+                    return logger[key](`${prefix}${message}`);
+                return logger[key](`${prefix}${message}`, error);
+            }
+            catch {
+                return undefined;
+            }
+        },
+    }), {});
+};
+export let logger = loggerFactory({});
+export const setLogger = (l) => { logger = l; };
+// Single shape for every reported failure: the context message first, the raw
+// error alongside it, in one call — so a consumer's logger sees them together.
+export const logError = (message, error) => {
+    logger.error(message, error);
+};