@progress/kendo-angular-intl 4.0.0-next.202204060817 → 4.0.1-dev.202206071423

package/fesm2015/kendo-angular-intl.js

@@ -0,0 +1,502 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import * as i0 from '@angular/core';
+import { EventEmitter, LOCALE_ID, Injectable, Inject, Pipe, NgModule } from '@angular/core';
+import { validatePackage } from '@progress/kendo-licensing';
+import * as intl from '@progress/kendo-intl';
+
+/**
+ * @hidden
+ */
+const packageMetadata = {
+    name: '@progress/kendo-angular-intl',
+    productName: 'Kendo UI for Angular',
+    productCodes: ['KENDOUIANGULAR', 'KENDOUICOMPLETE'],
+    publishDate: 1654611794,
+    version: '',
+    licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/?utm_medium=product&utm_source=kendoangular&utm_campaign=kendo-ui-angular-purchase-license-keys-warning'
+};
+
+const DOCS_URL = 'http://www.telerik.com/kendo-angular-ui/components/internationalization/troubleshooting/';
+/**
+ * @hidden
+ */
+const errorSolutions = {
+    'NoCurrency': `Solution: ${DOCS_URL}#toc-no-currency`,
+    'NoCurrencyDisplay': `Solution: ${DOCS_URL}#toc-no-currency-display`,
+    'NoCurrencyRegion': `Solution: ${DOCS_URL}#toc-no-currency-region`,
+    'NoDateFieldNames': `Solution: ${DOCS_URL}#toc-no-date-filed-names`,
+    'NoFirstDay': `Solution: ${DOCS_URL}#toc-no-first-day`,
+    'NoGMTInfo': `Solution: ${DOCS_URL}#toc-no-gmt-info`,
+    'NoLocale': `Solution: ${DOCS_URL}#toc-no-locale`,
+    'NoValidCurrency': `Solution: ${DOCS_URL}#toc-no-valid-currency`,
+    'NoWeekData': `Solution: ${DOCS_URL}#toc-no-week-data`
+};
+
+function formatMessage(error) {
+    const message = error.message;
+    const errorSolution = errorSolutions[Object.keys(errorSolutions).filter(key => message.indexOf(key) === 0)[0]];
+    return errorSolution ? `${message} ${errorSolution}` : message;
+}
+function intlMethod(fn) {
+    return function (...values) {
+        try {
+            return fn.apply(null, values);
+        }
+        catch (error) {
+            error.message = formatMessage(error);
+            throw error;
+        }
+    };
+}
+/**
+ * @hidden
+ */
+const dateFormatNames = intlMethod(intl.dateFormatNames);
+/**
+ * @hidden
+ */
+const dateFieldName = intlMethod(intl.dateFieldName);
+/**
+ * @hidden
+ */
+const firstDay = intlMethod(intl.firstDay);
+/**
+ * @hidden
+ */
+const format = intlMethod(intl.format);
+/**
+ * @hidden
+ */
+const formatDate = intlMethod(intl.formatDate);
+/**
+ * @hidden
+ */
+const formatNumber = intlMethod(intl.formatNumber);
+/**
+ * @hidden
+ */
+const load = intlMethod(intl.load);
+/**
+ * @hidden
+ */
+const numberSymbols = intlMethod(intl.numberSymbols);
+/**
+ * @hidden
+ */
+const parseDate = intlMethod(intl.parseDate);
+/**
+ * @hidden
+ */
+const parseNumber = intlMethod(intl.parseNumber);
+/**
+ * @hidden
+ */
+const splitDateFormat = intlMethod(intl.splitDateFormat);
+/**
+ * @hidden
+ */
+const toString = intlMethod(intl.toString);
+/**
+ * @hidden
+ */
+const weekendRange = intlMethod(intl.weekendRange);
+/**
+ * Sets a pre-built locale.
+ *
+ * @params data - The pre-built locale data.
+ */
+const setData = (data) => intl.setData(data);
+/**
+ * Retrieves the locale data for the specified locale.
+ *
+ * @params locale - The locale id.
+ * @returns data - The locale data.
+ */
+const localeData = (locale) => {
+    try {
+        return intl.localeInfo(locale);
+    }
+    catch (error) {
+        error.message = formatMessage(error);
+        throw error;
+    }
+};
+
+const LOCALE_REGEX = /_/g;
+/**
+ * @hidden
+ */
+function cldrServiceFactory(localeId) {
+    return new CldrIntlService(localeId);
+}
+/**
+ * An abstract base class that implements
+ * the Internationalization service methods
+ * for the current locale.
+ */
+class IntlService {
+    /**
+     * @hidden
+     */
+    constructor() {
+        /**
+         * @hidden
+         */
+        this.changes = new EventEmitter();
+        validatePackage(packageMetadata);
+    }
+    /**
+     * Notifies that the service was changed.
+     */
+    notify() {
+        this.changes.emit();
+    }
+}
+IntlService.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: IntlService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
+IntlService.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: IntlService, providedIn: 'root', useFactory: cldrServiceFactory, deps: [{ token: LOCALE_ID }] });
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: IntlService, decorators: [{
+            type: Injectable,
+            args: [{
+                    providedIn: 'root',
+                    useFactory: cldrServiceFactory,
+                    deps: [LOCALE_ID]
+                }]
+        }], ctorParameters: function () { return []; } });
+/**
+ * The Internationalization service implemented by using
+ * the CLDR Database via the `@progress/kendo-intl` package.
+ */
+class CldrIntlService extends IntlService {
+    /**
+     * Creates a new instance of the service with the ID of the specified locale.
+     *
+     * Note that the parts of the locale ID can be separated by either `_` (underscore)
+     * or `-` (dash).
+     *
+     * @param localeId - The default locale ID.
+     */
+    constructor(localeId) {
+        super();
+        this.localeId = localeId;
+    }
+    /**
+     * Gets or sets the current locale ID.
+     */
+    get localeId() {
+        return this.locale;
+    }
+    set localeId(value) {
+        // Angular locales use underscore, for example, en_US
+        // while IETF BCP-47 specifies a dash.
+        // https://tools.ietf.org/html/bcp47
+        const locale = value.replace(LOCALE_REGEX, '-');
+        if (locale !== this.locale) {
+            this.locale = locale;
+            this.notify();
+        }
+    }
+    /**
+     * Formats a string with placeholders such as
+     * `Total amount {0:c}`.
+     *
+     * @param format - The format string.
+     * @param values - One or more values to output in the format string placeholders.
+     * @return - The formatted string.
+     */
+    format(format$1, ...values) {
+        return format(format$1, values, this.localeId);
+    }
+    /**
+     * Converts an object into a string based on the specified format.
+     *
+     * @param value - The value to format.
+     * @param format - The format to use.
+     * @param localeId - The locale ID to use in place of the default one. Optional.
+     * @return The formatted object.
+     */
+    toString(value, format, localeId) {
+        return toString(value, format, localeId || this.localeId);
+    }
+    /**
+     * Converts a `Date` object into a string based on the specified format.
+     * If no format is provided, the default short date format is used.
+     *
+     * @param value - The date to format.
+     * @param format - The format string or options.
+     * @param localeId - The locale ID to use in place of the default one. Optional.
+     * @return The formatted date.
+     */
+    formatDate(value, format, localeId) {
+        return formatDate(value, format, localeId || this.localeId);
+    }
+    /**
+     * Converts a string into a `Date` object based on the specified format.
+     *
+     * @param value - The string to convert.
+     * @param format - The format strings or options.
+     * @param localeId - The locale ID to use in place of the default one. Optional.
+     * @return The parsed date.
+     */
+    parseDate(value, format, localeId) {
+        return parseDate(value, format, localeId || this.localeId);
+    }
+    /**
+     * Converts a string into a `Number`.
+     *
+     * @param value - The string to convert.
+     * @param format - The format string or options.
+     * @param localeId - The locale ID to use in place of the default one. Optional.
+     * @return The parsed number.
+     */
+    parseNumber(value, format, localeId) {
+        return parseNumber(value, localeId || this.localeId, format);
+    }
+    /**
+     * Converts a `Number` into a string based on the specified format.
+     *
+     * @param value - The number to format.
+     * @param format - The format string or options.
+     * @param localeId - The locale ID to use in place of the default one. Optional.
+     * @return The formatted number.
+     */
+    formatNumber(value, format, localeId) {
+        return formatNumber(value, format, localeId || this.localeId);
+    }
+    /**
+     * Returns the date names from the current locale based on the option.
+     *
+     * The available `type` values are:
+     * - `era`
+     * - `year`
+     * - `quarter`
+     * - `month`
+     * - `week`
+     * - `day`
+     * - `dayperiod`
+     * - `hour`
+     * - `minute`
+     * - `second`
+     * - `zone`
+     *
+     * The available `nameType` values are:
+     * - `wide`
+     * - `narrow`
+     * - `short`
+     *
+     * @param options - Detailed configuration for the desired date field name.
+     * @param localeId - The locale ID to use in place of the default one. Optional.
+     * @return - The day names from the current locale based on the option.
+     * @returns The localized date field name from the current locale based on the option.
+     *
+     * @example
+     * ```
+     * dateFieldName({ type: 'day' });                      //returns 'day';
+     * dateFieldName({ type: 'day', nameType: 'wide' });    //returns 'day';
+     * dateFieldName({ type: 'month', nameType: 'short' }); //returns 'mo.';
+     * dateFieldName({ type: 'month', nameType: 'wide' });  //returns 'month';
+     * ```
+     */
+    dateFieldName(options, localeId) {
+        return dateFieldName(options, localeId || this.localeId);
+    }
+    /**
+     * Returns a localized date field name based on specific dateFieldName options.
+     *
+     * The available type values are:
+     * - `day`
+     * - `dayperiod`
+     * - `months`
+     * - `quarters`
+     * - `eras`
+     *
+     * @param options - Detailed configuration for the desired date format.
+     * @param localeId - The locale ID to use in place of the default one. Optional.
+     * @return - The day names from the current locale based on the option.
+     */
+    dateFormatNames(options, localeId) {
+        return dateFormatNames(localeId || this.localeId, options);
+    }
+    /**
+     * Splits the date format into objects containing information about each part of the pattern.
+     *
+     * @param format The format string or options.
+     * @param localeId The optional locale id. If not specified, the `"en"` locale id is used.
+     * @returns The date format parts.
+     */
+    splitDateFormat(format, localeId) {
+        return splitDateFormat(format, localeId || this.localeId);
+    }
+    /**
+     * Returns the number symbols from the current locale based on the option.
+     *
+     * @param localeId - The locale ID to use in place of the default one. Optional.
+     * @return - The number symbols from the current locale.
+     */
+    numberSymbols(localeId) {
+        return numberSymbols(localeId || this.localeId);
+    }
+    /**
+     * Returns the first day index starting from Sunday.
+     *
+     * @param localeId - The locale ID. Defaults to the current locale ID.
+     * @return - The index of the first day of the week (0 == Sunday).
+     */
+    firstDay(localeId) {
+        return firstDay(localeId || this.localeId);
+    }
+    /**
+     * Returns the start and end index of the locale weekend starting from Sunday.
+     *
+     * @param localeId - The locale ID. Defaults to the current locale ID.
+     * @return - The the start and end index of the locale weekend (0 == Sunday).
+     */
+    weekendRange(localeId) {
+        return weekendRange(localeId || this.localeId);
+    }
+}
+CldrIntlService.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: CldrIntlService, deps: [{ token: LOCALE_ID }], target: i0.ɵɵFactoryTarget.Injectable });
+CldrIntlService.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: CldrIntlService });
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: CldrIntlService, decorators: [{
+            type: Injectable
+        }], ctorParameters: function () { return [{ type: undefined, decorators: [{
+                    type: Inject,
+                    args: [LOCALE_ID]
+                }] }]; } });
+
+const isNumeric = (value) => !isNaN(value - parseFloat(value));
+/**
+ * Formats a date value to a string based on the requested format.
+ * This pipe uses the [IntlService]({% slug api_intl_intlservice %}).
+ *
+ * @example
+ * ```ng-template-no-run
+ * <ul>
+ *    <li>{{date | kendoDate }}</li>
+ *    <li>{{milliseconds | kendoDate: 'M/dd/yyy' }}</li>
+ *    <li>{{stringDate | kendoDate: 'G' }}</li>
+ * </ul>
+ * ```
+ */
+class DatePipe {
+    /**
+     * @hidden
+     */
+    constructor(intlService) {
+        this.intlService = intlService;
+    }
+    /**
+     * Converts a `Date` object into a string based on the specified format.
+     * If no format is provided, the default short date format is used.
+     *
+     * @param value - The date to format.
+     * @param format - The format string or options.
+     * @param localeId - (Optional) The ID of the locale which will be used instead of the default one.
+     * @return - The formatted date.
+     */
+    transform(value, format = "", localeId) {
+        value = this.normalize(value);
+        if (value) {
+            return this.intlService.formatDate(value, format, localeId);
+        }
+        return value;
+    }
+    normalize(value) {
+        if (value && typeof value === 'string') {
+            value = this.intlService.parseDate(value);
+        }
+        else if (value && isNumeric(value)) {
+            value = new Date(parseFloat(value));
+        }
+        return value;
+    }
+}
+DatePipe.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: DatePipe, deps: [{ token: IntlService }], target: i0.ɵɵFactoryTarget.Pipe });
+DatePipe.ɵpipe = i0.ɵɵngDeclarePipe({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: DatePipe, name: "kendoDate" });
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: DatePipe, decorators: [{
+            type: Pipe,
+            args: [{
+                    name: 'kendoDate'
+                }]
+        }], ctorParameters: function () { return [{ type: IntlService }]; } });
+
+/**
+ * Formats a number value to a string based on the requested format.
+ * This pipe uses the [`IntlService`]({% slug api_intl_intlservice %}).
+ *
+ * @example
+ * ```ng-template-no-run
+ *   <ul>
+ *     <li>{{decimal | kendoNumber:'c' }}</li>
+ *     <li>{{stringNumber | kendoNumber:'p' }}</li>
+ *     <li>{{int | kendoNumber:'##.00' }}</li>
+ *  </ul>
+ * ```
+ */
+class NumberPipe {
+    /**
+     * @hidden
+     */
+    constructor(intlService) {
+        this.intlService = intlService;
+    }
+    /**
+     * Converts a `Number` object into a string based on the specified format.
+     * If no format is provided, the value is formatted as decimal number using the
+     * [`"n"`](https://github.com/telerik/kendo-intl/blob/master/docs/num-formatting/index.md#standard) format.
+     *
+     * @param value - The numer that will be formatted.
+     * @param format - The format string or options.
+     * @param localeId - (Optional) The locale ID that will be used in place of the default one.
+     * @return - The formatted number.
+     */
+    transform(value, format, localeId) {
+        if (typeof value === 'string') {
+            value = this.intlService.parseNumber(value);
+        }
+        if (value !== null && value !== undefined) {
+            return this.intlService.formatNumber(value, format, localeId);
+        }
+        return value;
+    }
+}
+NumberPipe.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: NumberPipe, deps: [{ token: IntlService }], target: i0.ɵɵFactoryTarget.Pipe });
+NumberPipe.ɵpipe = i0.ɵɵngDeclarePipe({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: NumberPipe, name: "kendoNumber" });
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: NumberPipe, decorators: [{
+            type: Pipe,
+            args: [{
+                    name: 'kendoNumber'
+                }]
+        }], ctorParameters: function () { return [{ type: IntlService }]; } });
+
+const pipes = [
+    DatePipe,
+    NumberPipe
+];
+/**
+ * Represents the [NgModule]({{ site.data.urls.angular['ngmoduleapi'] }}docs/ts/latest/guide/ngmodule.html)
+ * definition for the Intl services.
+ */
+class IntlModule {
+}
+IntlModule.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: IntlModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
+IntlModule.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: IntlModule, declarations: [DatePipe,
+        NumberPipe], exports: [DatePipe,
+        NumberPipe] });
+IntlModule.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: IntlModule });
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0, type: IntlModule, decorators: [{
+            type: NgModule,
+            args: [{
+                    declarations: [pipes],
+                    exports: [pipes]
+                }]
+        }] });
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { CldrIntlService, DatePipe, IntlModule, IntlService, NumberPipe, cldrServiceFactory, dateFieldName, dateFormatNames, firstDay, format, formatDate, formatNumber, load, localeData, numberSymbols, parseDate, parseNumber, setData, splitDateFormat, toString, weekendRange };
+

package/intl-members.d.ts

@@ -0,0 +1,71 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { Locale } from './locale-data.interface';
+export { DateFieldNameOptions, DateFormatNameOptions, DateFormatOptions, NumberFormatOptions, DateFormatPart } from '@progress/kendo-intl';
+/**
+ * @hidden
+ */
+export declare const dateFormatNames: Function;
+/**
+ * @hidden
+ */
+export declare const dateFieldName: Function;
+/**
+ * @hidden
+ */
+export declare const firstDay: Function;
+/**
+ * @hidden
+ */
+export declare const format: Function;
+/**
+ * @hidden
+ */
+export declare const formatDate: Function;
+/**
+ * @hidden
+ */
+export declare const formatNumber: Function;
+/**
+ * @hidden
+ */
+export declare const load: Function;
+/**
+ * @hidden
+ */
+export declare const numberSymbols: Function;
+/**
+ * @hidden
+ */
+export declare const parseDate: Function;
+/**
+ * @hidden
+ */
+export declare const parseNumber: Function;
+/**
+ * @hidden
+ */
+export declare const splitDateFormat: Function;
+/**
+ * @hidden
+ */
+export declare const toString: Function;
+/**
+ * @hidden
+ */
+export declare const weekendRange: Function;
+/**
+ * Sets a pre-built locale.
+ *
+ * @params data - The pre-built locale data.
+ */
+export declare const setData: (data: any) => void;
+/**
+ * Retrieves the locale data for the specified locale.
+ *
+ * @params locale - The locale id.
+ * @returns data - The locale data.
+ */
+export declare const localeData: (locale: string) => Locale;

package/intl.module.d.ts

@@ -0,0 +1,16 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import * as i0 from "@angular/core";
+import * as i1 from "./date.pipe";
+import * as i2 from "./number.pipe";
+/**
+ * Represents the [NgModule]({{ site.data.urls.angular['ngmoduleapi'] }}docs/ts/latest/guide/ngmodule.html)
+ * definition for the Intl services.
+ */
+export declare class IntlModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<IntlModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<IntlModule, [typeof i1.DatePipe, typeof i2.NumberPipe], never, [typeof i1.DatePipe, typeof i2.NumberPipe]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<IntlModule>;
+}