@jsverse/transloco-locale 7.0.0

package/lib/pipes/transloco-date.pipe.d.ts

@@ -0,0 +1,24 @@
+import { PipeTransform } from '@angular/core';
+import { DateFormatOptions, Locale, ValidDate } from '../transloco-locale.types';
+import { BaseLocalePipe } from './base-locale.pipe';
+import * as i0 from "@angular/core";
+export declare class TranslocoDatePipe extends BaseLocalePipe implements PipeTransform {
+    private localeConfig;
+    /**
+     * Transform a date into the locale's date format.
+     *
+     * The date expression: a `Date` object,  a number
+     * (milliseconds since UTC epoch), or an ISO string (https://www.w3.org/TR/NOTE-datetime).
+     *
+     * @example
+     *
+     * date | translocoDate: {} : en-US // 9/10/2019
+     * date | translocoDate: { dateStyle: 'medium', timeStyle: 'medium' } : en-US // Sep 10, 2019, 10:46:12 PM
+     * date | translocoDate: { timeZone: 'UTC', timeStyle: 'full' } : en-US // 7:40:32 PM Coordinated Universal Time
+     * 1 | translocoDate: { dateStyle: 'medium' } // Jan 1, 1970
+     * '2019-02-08' | translocoDate: { dateStyle: 'medium' } // Feb 8, 2019
+     */
+    transform(date: ValidDate, options?: DateFormatOptions, locale?: Locale): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TranslocoDatePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<TranslocoDatePipe, "translocoDate", true>;
+}

package/lib/pipes/transloco-decimal.pipe.d.ts

@@ -0,0 +1,19 @@
+import { PipeTransform } from '@angular/core';
+import { Locale, NumberFormatOptions } from '../transloco-locale.types';
+import { BaseLocalePipe } from './base-locale.pipe';
+import * as i0 from "@angular/core";
+export declare class TranslocoDecimalPipe extends BaseLocalePipe implements PipeTransform {
+    private localeConfig;
+    /**
+     * Transform a given number into the locale's currency format.
+     *
+     * @example
+     *
+     * 1234567890 | translocoDecimal: {} : en-US // 1,234,567,890
+     * 1234567890 | translocoDecimal: {useGrouping: false}: en-US // 1234567890
+     *
+     */
+    transform(value: string | number, numberFormatOptions?: NumberFormatOptions, locale?: Locale): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TranslocoDecimalPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<TranslocoDecimalPipe, "translocoDecimal", true>;
+}

package/lib/pipes/transloco-percent.pipe.d.ts

@@ -0,0 +1,19 @@
+import { PipeTransform } from '@angular/core';
+import { Locale, NumberFormatOptions } from '../transloco-locale.types';
+import { BaseLocalePipe } from './base-locale.pipe';
+import * as i0 from "@angular/core";
+export declare class TranslocoPercentPipe extends BaseLocalePipe implements PipeTransform {
+    private localeConfig;
+    /**
+     * Transform a given number into the locale's currency format.
+     *
+     * @example
+     *
+     * 1 | translocoPercent : {} : en-US // 100%
+     * "1" | translocoPercent : {} : en-US // 100%
+     *
+     */
+    transform(value: number | string, numberFormatOptions?: NumberFormatOptions, locale?: Locale): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TranslocoPercentPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<TranslocoPercentPipe, "translocoPercent", true>;
+}

package/lib/shared.d.ts

@@ -0,0 +1,2 @@
+import { Locale, LocaleFormatOptions, LocaleConfig } from './transloco-locale.types';
+export declare function getDefaultOptions<T extends keyof LocaleFormatOptions>(locale: Locale, style: T, localeConfig: LocaleConfig): NonNullable<LocaleFormatOptions[T]>;

package/lib/transloco-locale.config.d.ts

@@ -0,0 +1,8 @@
+import { InjectionToken } from '@angular/core';
+import { TranslocoLocaleConfig, LocaleConfigMapping, LangToLocaleMapping, LocaleToCurrencyMapping } from './transloco-locale.types';
+export declare const defaultConfig: Required<TranslocoLocaleConfig>;
+export declare const TRANSLOCO_LOCALE_DEFAULT_LOCALE: InjectionToken<string>;
+export declare const TRANSLOCO_LOCALE_DEFAULT_CURRENCY: InjectionToken<string>;
+export declare const TRANSLOCO_LOCALE_LANG_MAPPING: InjectionToken<LangToLocaleMapping>;
+export declare const TRANSLOCO_LOCALE_CONFIG: InjectionToken<LocaleConfigMapping>;
+export declare const TRANSLOCO_LOCALE_CURRENCY_MAPPING: InjectionToken<LocaleToCurrencyMapping>;

package/lib/transloco-locale.module.d.ts

@@ -0,0 +1,10 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./pipes/transloco-currency.pipe";
+import * as i2 from "./pipes/transloco-date.pipe";
+import * as i3 from "./pipes/transloco-decimal.pipe";
+import * as i4 from "./pipes/transloco-percent.pipe";
+export declare class TranslocoLocaleModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<TranslocoLocaleModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<TranslocoLocaleModule, never, [typeof i1.TranslocoCurrencyPipe, typeof i2.TranslocoDatePipe, typeof i3.TranslocoDecimalPipe, typeof i4.TranslocoPercentPipe], [typeof i1.TranslocoCurrencyPipe, typeof i2.TranslocoDatePipe, typeof i3.TranslocoDecimalPipe, typeof i4.TranslocoPercentPipe]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<TranslocoLocaleModule>;
+}

package/lib/transloco-locale.providers.d.ts

@@ -0,0 +1,11 @@
+import { Type } from '@angular/core';
+import { Currency, LangToLocaleMapping, Locale, LocaleConfig, LocaleToCurrencyMapping, TranslocoLocaleConfig } from './transloco-locale.types';
+import { TranslocoDateTransformer, TranslocoNumberTransformer } from './transloco-locale.transformers';
+export declare function provideTranslocoLocale(config?: TranslocoLocaleConfig): import("@angular/core").EnvironmentProviders[];
+export declare function provideTranslocoLocaleConfig(config: LocaleConfig): import("@angular/core").EnvironmentProviders;
+export declare function provideTranslocoLocaleLangMapping(langToLocale: LangToLocaleMapping): import("@angular/core").EnvironmentProviders;
+export declare function provideTranslocoLocaleCurrencyMapping(localeToCurrency: LocaleToCurrencyMapping): import("@angular/core").EnvironmentProviders;
+export declare function provideTranslocoDefaultLocale(defaultLocale: Locale): import("@angular/core").EnvironmentProviders;
+export declare function provideTranslocoDefaultCurrency(defaultCurrency: Currency): import("@angular/core").EnvironmentProviders;
+export declare function provideTranslocoDateTransformer(transformer: Type<TranslocoDateTransformer>): import("@angular/core").EnvironmentProviders;
+export declare function provideTranslocoNumberTransformer(transformer: Type<TranslocoNumberTransformer>): import("@angular/core").EnvironmentProviders;

package/lib/transloco-locale.service.d.ts

@@ -0,0 +1,54 @@
+import { OnDestroy } from '@angular/core';
+import { DateFormatOptions, Locale, NumberStyles, ValidDate } from './transloco-locale.types';
+import * as i0 from "@angular/core";
+export declare class TranslocoLocaleService implements OnDestroy {
+    private translocoService;
+    private langLocaleMapping;
+    private defaultLocale;
+    private defaultCurrency;
+    private localeCurrencyMapping;
+    private numberTransformer;
+    private dateTransformer;
+    private localeConfig;
+    private _locale;
+    private locale;
+    private subscription;
+    localeChanges$: import("rxjs").Observable<string>;
+    getLocale(): string;
+    setLocale(locale: Locale): void;
+    /**
+     * Get the currency symbol for the currently set locale.
+     */
+    getCurrencySymbol(locale?: string): string | undefined;
+    /**
+     * Transform a date into the locale's date format.
+     *
+     * The date expression: a `Date` object, a number
+     * (milliseconds since UTC epoch), or an ISO string (https://www.w3.org/TR/NOTE-datetime).
+     *
+     * @example
+     *
+     * localizeDate(new Date(2019, 9, 7, 12, 0, 0)) // 10/7/2019
+     * localizeDate(date, 'en-US', { dateStyle: 'medium', timeStyle: 'medium' }) // Sep 10, 2019, 10:46:12 PM
+     * localizeDate(date) 'en-US', { timeZone: 'UTC', timeStyle: 'full' } // 7:40:32 PM Coordinated Universal Time
+     * localizeDate(1, 'en-US', { dateStyle: 'medium' }) // Jan 1, 1970
+     * localizeDate('2019-02-08', 'en-US', { dateStyle: 'medium' }) // Feb 8, 2019
+     */
+    localizeDate(date: ValidDate, locale?: Locale, options?: DateFormatOptions): string;
+    /**
+     * Transform a number into the locale's number format according to the number type.
+     *
+     * localizeNumber(1234567890, 'decimal') // 1,234,567,890
+     * localizeNumber(0.5, 'percent') // 50%
+     * localizeNumber(1000, 'currency') // $1,000.00
+     */
+    localizeNumber(value: number | string, style: NumberStyles, locale?: Locale, options?: Intl.NumberFormatOptions): string;
+    /**
+     * @internal
+     */
+    _resolveCurrencyCode(locale?: Locale): string;
+    ngOnDestroy(): void;
+    private toLocale;
+    static ɵfac: i0.ɵɵFactoryDeclaration<TranslocoLocaleService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<TranslocoLocaleService>;
+}

package/lib/transloco-locale.transformers.d.ts

@@ -0,0 +1,16 @@
+import { InjectionToken } from '@angular/core';
+import { Locale, DateFormatOptions, NumberStyles } from './transloco-locale.types';
+export interface TranslocoDateTransformer {
+    transform(date: Date, locale: Locale, options: DateFormatOptions): string;
+}
+export interface TranslocoNumberTransformer {
+    transform(value: number | string, type: NumberStyles, locale: Locale, options: Intl.NumberFormatOptions): string;
+}
+export declare const TRANSLOCO_DATE_TRANSFORMER: InjectionToken<TranslocoDateTransformer>;
+export declare const TRANSLOCO_NUMBER_TRANSFORMER: InjectionToken<TranslocoNumberTransformer>;
+export declare class DefaultDateTransformer implements TranslocoDateTransformer {
+    transform(date: Date, locale: Locale, options: DateFormatOptions): string;
+}
+export declare class DefaultNumberTransformer implements TranslocoNumberTransformer {
+    transform(value: number | string, type: NumberStyles, locale: string, options: Intl.NumberFormatOptions): string;
+}

package/lib/transloco-locale.types.d.ts

@@ -0,0 +1,151 @@
+export interface NumberFormatOptions {
+    /**
+     * When to display the sign for the number.
+     */
+    signDisplay?: Intl.NumberFormatOptions['signDisplay'];
+    /**
+     * The currency to use in currency formatting. Possible values are the ISO 4217 currency codes, such as "USD" for the US dollar, "EUR" for the euro
+     */
+    currency?: Intl.NumberFormatOptions['currency'];
+    /**
+     * Whether to use grouping separators, such as thousands separators or thousand/lakh/crore separators. Possible values are true and false; the default is true.
+     */
+    useGrouping?: Intl.NumberFormatOptions['useGrouping'];
+    /**
+     * The minimum number of integer digits to use. Possible values are from 1 to 21.
+     */
+    minimumIntegerDigits?: Intl.NumberFormatOptions['minimumIntegerDigits'];
+    /**
+     * The minimum number of fraction digits to use. Possible values are from 0 to 20.
+     */
+    minimumFractionDigits?: Intl.NumberFormatOptions['minimumFractionDigits'];
+    /**
+     * The maximum number of fraction digits to use. Possible values are from 0 to 20.
+     */
+    maximumFractionDigits?: Intl.NumberFormatOptions['maximumFractionDigits'];
+    /**
+     * The minimum number of significant digits to use. Possible values are from 1 to 21.
+     */
+    minimumSignificantDigits?: Intl.NumberFormatOptions['minimumSignificantDigits'];
+    /**
+     * The maximum number of significant digits to use. Possible values are from 1 to 21
+     */
+    maximumSignificantDigits?: Intl.NumberFormatOptions['maximumSignificantDigits'];
+}
+/**
+ * The number display formatting type.
+ */
+export type NumberStyles = 'currency' | 'decimal' | 'percent';
+/**
+ * Allowed values with Date and Time formats
+ */
+export type DateFormatStyles = 'full' | 'long' | 'medium' | 'short';
+/**
+ * Common allowed formats for time zones
+ */
+export type TimezoneNameFormats = 'short' | 'long';
+/**
+ * Common allowed formats for date strings
+ */
+export type DateStringFormats = TimezoneNameFormats | 'narrow';
+/**
+ * Common allowed formats for numbers
+ */
+export type DateNumberFormats = 'numeric' | '2-digit';
+/**
+ * Supported Intl calender types
+ */
+export interface DateFormatOptions {
+    /**
+     * The date formatting style.
+     */
+    dateStyle?: DateFormatStyles;
+    /**
+     * The time formatting style.
+     */
+    timeStyle?: DateFormatStyles;
+    /**
+     * Number of fractional seconds to show
+     */
+    fractionalSecondDigits?: 0 | 1 | 2 | 3;
+    /**
+     * The way day periods should be displayed
+     */
+    dayPeriod?: DateStringFormats;
+    /**
+     * The option for 12/24 hour display
+     */
+    hour12?: boolean;
+    /**
+     * Locale matcher options
+     */
+    localeMatcher?: 'lookup' | 'best fit';
+    /**
+     * Format matcher options
+     */
+    formatMatcher?: 'lookup' | 'best fit';
+    /**
+     * The weekday formatting style
+     */
+    weekday?: DateStringFormats;
+    /**
+     * The era formatting style
+     */
+    era?: DateStringFormats;
+    /**
+     * The year formatting style
+     */
+    year?: DateNumberFormats;
+    /**
+     * The Month formatting style
+     */
+    month?: DateStringFormats | DateNumberFormats;
+    /**
+     * The Day formatting style
+     */
+    day?: DateNumberFormats;
+    /**
+     * The Hour formatting style
+     */
+    hour?: DateNumberFormats;
+    /**
+     * The Minute formatting style
+     */
+    minute?: DateNumberFormats;
+    /**
+     * The Seconds formatting style
+     */
+    second?: DateNumberFormats;
+    /**
+     * The time zone to use. The only value implementations must recognize is "UTC"; the default is the runtime's default time zone. Implementations may also recognize the time zone names of the IANA time zone database, such as "Asia/Shanghai", "Asia/Kolkata", "America/New_York".
+     */
+    timeZone?: Intl.DateTimeFormatOptions['timeZone'];
+    /**
+     * The formatting for the time zone name
+     */
+    timeZoneName?: TimezoneNameFormats;
+}
+export type Locale = string;
+export type Currency = string;
+export type ValidDate = Date | string | number;
+export interface LocaleFormatOptions {
+    date?: DateFormatOptions;
+    decimal?: NumberFormatOptions;
+    currency?: NumberFormatOptions;
+    percent?: NumberFormatOptions;
+    unit?: NumberFormatOptions;
+}
+export type LocaleConfigMapping = Record<string, LocaleFormatOptions>;
+export type LangToLocaleMapping = Record<string, Locale>;
+export type LocaleToCurrencyMapping = Record<string, Currency>;
+export interface LocaleConfig {
+    global?: LocaleFormatOptions;
+    localeBased?: LocaleConfigMapping;
+}
+export interface TranslocoLocaleConfig {
+    defaultLocale?: Locale;
+    defaultCurrency?: Currency;
+    localeConfig?: LocaleConfig;
+    langToLocaleMapping?: LangToLocaleMapping;
+    localeToCurrencyMapping?: LocaleToCurrencyMapping;
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@jsverse/transloco-locale",
+  "version": "7.0.0",
+  "description": "The localization (l10n) library plugin for Transloco",
+  "publishConfig": {
+    "access": "public"
+  },
+  "bugs": {
+    "url": "https://github.com/jsverse/transloco/issues"
+  },
+  "homepage": "https://jsverse.github.io/transloco/docs/plugins/locale",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jsverse/transloco"
+  },
+  "keywords": [
+    "angular",
+    "angular 2",
+    "i18n",
+    "localization",
+    "l10n",
+    "angular translate",
+    "angular i18n",
+    "transloco"
+  ],
+  "license": "MIT",
+  "peerDependencies": {
+    "@angular/core": ">=16.0.0",
+    "@jsverse/transloco": ">=7.0.0",
+    "rxjs": ">=6.0.0"
+  },
+  "dependencies": {
+    "tslib": "^2.2.0"
+  },
+  "module": "fesm2022/jsverse-transloco-locale.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "esm2022": "./esm2022/jsverse-transloco-locale.mjs",
+      "esm": "./esm2022/jsverse-transloco-locale.mjs",
+      "default": "./fesm2022/jsverse-transloco-locale.mjs"
+    }
+  },
+  "sideEffects": false
+}