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

package/intl.service.d.ts

@@ -0,0 +1,298 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { EventEmitter } from '@angular/core';
+import { DateFieldNameOptions, DateFormatOptions, DateFormatNameOptions, NumberFormatOptions, DateFormatPart, DayRange } from '@progress/kendo-intl';
+import * as i0 from "@angular/core";
+/**
+ * @hidden
+ */
+export declare function cldrServiceFactory(localeId: string): CldrIntlService;
+/**
+ * An abstract base class that implements
+ * the Internationalization service methods
+ * for the current locale.
+ */
+export declare abstract class IntlService {
+    /**
+     * @hidden
+     */
+    readonly changes: EventEmitter<any>;
+    /**
+     * @hidden
+     */
+    constructor();
+    /**
+     * Notifies that the service was changed.
+     */
+    notify(): void;
+    /**
+     * 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.
+     */
+    abstract format(format: string, ...values: any[]): string;
+    /**
+     * 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. Optional.
+     * @return - The formatted object.
+     */
+    abstract toString(value: any, format: string | any, localeId?: string): string;
+    /**
+     * Converts a `Date` object into a string based on the specified format
+     * ([see example]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+     * 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. Optional.
+     * @return - The formatted date.
+     */
+    abstract formatDate(value: Date, format?: String | DateFormatOptions, localeId?: string): string;
+    /**
+     * 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. Optional.
+     * @return - The parsed date.
+     */
+    abstract parseDate(value: string, format?: string | DateFormatOptions | string[] | DateFormatOptions[], localeId?: string): Date;
+    /**
+     * 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. Optional.
+     * @return - The parsed number.
+     */
+    abstract parseNumber(value: string, format?: string | NumberFormatOptions, localeId?: string): number;
+    /**
+     * 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. Optional.
+     * @return - The formatted number.
+     */
+    abstract formatNumber(value: number, format: string | NumberFormatOptions, localeId?: string): string;
+    /**
+     * Returns the day names from the current locale based on the option.
+     *
+     * @param options - Detailed configuration for the desired date format.
+     * @param localeId - The locale ID to use in place of the default. Optional.
+     * @return - The day names from the current locale based on the option.
+     */
+    abstract dateFormatNames(options: DateFormatNameOptions, localeId?: string): any;
+    /**
+     * Returns a localized date field name based on specific dateFieldName options.
+     *
+     * @param options - Detailed configuration for the desired date field name.
+     * @param localeId The optional locale id. If not specified, the `"en"` locale id is used.
+     * @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';
+     * ```
+     */
+    abstract dateFieldName(options: DateFieldNameOptions, localeId?: string): string;
+    /**
+     * 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.
+     */
+    abstract splitDateFormat(format: string | DateFormatOptions, localeId?: string): DateFormatPart[];
+    /**
+     * 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.
+     */
+    abstract numberSymbols(localeId?: string): any;
+    /**
+     * 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).
+     */
+    abstract firstDay(localeId?: string): number;
+    /**
+     * 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).
+     */
+    abstract weekendRange(localeId?: string): DayRange;
+    static ɵfac: i0.ɵɵFactoryDeclaration<IntlService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<IntlService>;
+}
+/**
+ * The Internationalization service implemented by using
+ * the CLDR Database via the `@progress/kendo-intl` package.
+ */
+export declare class CldrIntlService extends IntlService {
+    private locale;
+    /**
+     * Gets or sets the current locale ID.
+     */
+    get localeId(): string;
+    set localeId(value: string);
+    /**
+     * 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: string);
+    /**
+     * 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: string, ...values: any[]): string;
+    /**
+     * 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: any, format: string | any, localeId?: string): string;
+    /**
+     * 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: Date, format?: String | DateFormatOptions, localeId?: string): string;
+    /**
+     * 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: string, format?: string | DateFormatOptions | string[] | DateFormatOptions[], localeId?: string): Date;
+    /**
+     * 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: string, format?: string | NumberFormatOptions, localeId?: string): number;
+    /**
+     * 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: number, format: string | NumberFormatOptions, localeId?: string): string;
+    /**
+     * 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: DateFieldNameOptions, localeId?: string): string;
+    /**
+     * 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: DateFormatNameOptions, localeId?: string): any;
+    /**
+     * 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: string | DateFormatOptions, localeId?: string): DateFormatPart[];
+    /**
+     * 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?: string): any;
+    /**
+     * 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?: string): number;
+    /**
+     * 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?: string): DayRange;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CldrIntlService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<CldrIntlService>;
+}

package/kendo-angular-intl.d.ts

@@ -0,0 +1,9 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * Generated bundle index. Do not edit.
+ */
+/// <amd-module name="@progress/kendo-angular-intl" />
+export * from './main';

package/locale-data.interface.d.ts

@@ -0,0 +1,392 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * Describes the number symbols of the locale.
+ */
+export interface LocaleNumberSymbols {
+    /**
+     * The decimal separator.
+     */
+    decimal?: string;
+    /**
+     * The group separator.
+     */
+    group?: string;
+    /**
+     * The percent sign.
+     */
+    percentSign?: string;
+}
+/**
+ * Describes a currency of a locale.
+ */
+export interface LocaleCurrency {
+    /**
+     * The display name of the currency.
+     */
+    displayName?: string;
+    /**
+     * The currency symbol.
+     */
+    symbol?: string;
+    /**
+     * The narrow currency symbol.
+     */
+    "symbol-alt-narrow"?: string;
+}
+/**
+ * Describes the currencies of the locale.
+ */
+export interface LocaleCurrencies {
+    /**
+     * The currency data with the currency code as a key (field name).
+     */
+    [propName: string]: LocaleCurrency;
+}
+/**
+ * Describes the number data of the locale.
+ */
+export interface LocaleNumbers {
+    /**
+     * The number symbols of the locale.
+     */
+    symbols?: LocaleNumberSymbols;
+    /**
+     * The currencies of the locale.
+     */
+    currencies?: LocaleCurrencies;
+    /**
+     * The default currency of the locale.
+     */
+    localeCurrency: string;
+}
+/**
+ * Describes the calendar data of the locale.
+ */
+export interface LocaleCalendarPatterns {
+    /**
+     * The short-date pattern.
+     */
+    d?: string;
+    /**
+     * The long-date pattern.
+     */
+    D?: string;
+    /**
+     * The abbreviated month and day pattern.
+     */
+    m?: string;
+    /**
+     * The wide month and day pattern.
+     */
+    M?: string;
+    /**
+     * The abbreviated month and year pattern.
+     */
+    y?: string;
+    /**
+     * The wide month and year pattern.
+     */
+    Y?: string;
+    /**
+     * The full date and time pattern.
+     */
+    F?: string;
+    /**
+     * The short general date and time pattern.
+     */
+    g?: string;
+    /**
+     * The long general date and time pattern.
+     */
+    G?: string;
+    /**
+     * The short time pattern.
+     */
+    t?: string;
+    /**
+     * The long time pattern.
+     */
+    T?: string;
+    /**
+     * The universal sortable local date and time pattern.
+     */
+    s?: string;
+    /**
+     * The universal sortable UTC date and time pattern.
+     */
+    u?: string;
+}
+/**
+ * Describes the date and time formats of the locale.
+ */
+export interface LocaleDateTimeFormats {
+    /**
+     * The full date-time format.
+     */
+    full?: string;
+    /**
+     * The long date-time format.
+     */
+    long?: string;
+    /**
+     * The medium date-time format.
+     */
+    medium?: string;
+    /**
+     * The short date-time format.
+     */
+    short?: string;
+    /**
+     * The skeleton formats of the locale.
+     */
+    availableFormats?: any;
+}
+/**
+ * Describes the time formats of the locale.
+ */
+export interface LocaleTimeFormats {
+    /**
+     * The full time format.
+     */
+    full?: string;
+    /**
+     * The long time format.
+     */
+    long?: string;
+    /**
+     * The medium time format.
+     */
+    medium?: string;
+    /**
+     * The short time format.
+     */
+    short?: string;
+}
+/**
+ * Describes the date formats of the locale.
+ */
+export interface LocaleDateFormats {
+    /**
+     * The full date format.
+     */
+    full?: string;
+    /**
+     * The long date format.
+     */
+    long?: string;
+    /**
+     * The medium date format.
+     */
+    medium?: string;
+    /**
+     * The short date format.
+     */
+    short?: string;
+}
+/**
+ * Describes the name types of the locale date formats.
+ */
+export interface LocaleDateFormatNames {
+    /**
+     * An array with the abbreviated names.
+     */
+    abbreviated?: string[];
+    /**
+     * An array with the narrow names.
+     */
+    narrow?: string[];
+    /**
+     * An array with the short names.
+     */
+    short?: string[];
+    /**
+     * An array with the wide names.
+     */
+    wide?: string[];
+}
+/**
+ * Describes the date-format names of the locale.
+ */
+export interface LocaleDateFormatNameTypes {
+    /**
+     * The default format names.
+     */
+    format?: LocaleDateFormatNames;
+    /**
+     * The standalone format names.
+     */
+    'stand-alone'?: LocaleDateFormatNames;
+}
+/**
+ * Describes the day-period names of the locale.
+ */
+export interface LocaleDayPeriodNames {
+    /**
+     * The Ante meridiem name.
+     */
+    am?: string;
+    /**
+     * The Post meridiem name.
+     */
+    pm?: string;
+}
+/**
+ * Describes the data for the day-period names of the locale.
+ */
+export interface LocaleDayPeriodNameTypes {
+    /**
+     * The default format names.
+     */
+    format?: LocaleDayPeriodNames;
+    /**
+     * The standalone format names.
+     */
+    'stand-alone'?: LocaleDayPeriodNames;
+}
+/**
+ * Describes the date-field names of the locale.
+ */
+export interface LocaleDateFieldNames {
+    /**
+     * The wide field name.
+     */
+    wide?: string;
+    /**
+     * The short field name.
+     */
+    short?: string;
+    /**
+     * The narrow field name.
+     */
+    narrow?: string;
+}
+/**
+ * Describes the data for the date-field names of the locale.
+ */
+export interface LocaleDateFieldNameTypes {
+    /**
+     * The field names for an era.
+     */
+    era?: LocaleDateFieldNames;
+    /**
+     * The field names for a year.
+     */
+    year?: LocaleDateFieldNames;
+    /**
+     * The field names for a quarter.
+     */
+    quarter?: LocaleDateFieldNames;
+    /**
+     * The field names for a month.
+     */
+    month?: LocaleDateFieldNames;
+    /**
+     * The field names for a week.
+     */
+    week?: LocaleDateFieldNames;
+    /**
+     * The field names for a day.
+     */
+    day?: LocaleDateFieldNames;
+    /**
+     * The field names for a weekday.
+     */
+    weekday?: LocaleDateFieldNames;
+    /**
+     * The field names for a day period.
+     */
+    dayperiod?: LocaleDateFieldNames;
+    /**
+     * The field names for an hour.
+     */
+    hour?: LocaleDateFieldNames;
+    /**
+     * The field names for a minute.
+     */
+    minute?: LocaleDateFieldNames;
+    /**
+     * The field names for a second.
+     */
+    second?: LocaleDateFieldNames;
+    /**
+     * The field names for a zone.
+     */
+    zone?: LocaleDateFieldNames;
+}
+/**
+ * Describes the calendar data of the locale.
+ */
+export interface LocaleCalendar {
+    /**
+     * The GMT format of the locale.
+     */
+    gmtFormat?: string;
+    /**
+     * The zero (offset) GMT format of the locale.
+     */
+    gmtZeroFormat?: string;
+    /**
+     * The predefined patterns of the locale.
+     */
+    patterns?: LocaleCalendarPatterns;
+    /**
+     * The date and time formats of the locale.
+     */
+    dateTimeFormats?: LocaleDateTimeFormats;
+    /**
+     * The time formats of the locale.
+     */
+    timeFormats?: LocaleTimeFormats;
+    /**
+     * The date formats of the locale.
+     */
+    dateFormats?: LocaleDateFormats;
+    /**
+     * The data for the day names of the locale.
+     */
+    days?: LocaleDateFormatNameTypes;
+    /**
+     * The data for the day-period names of the locale.
+     */
+    dayPeriods?: LocaleDayPeriodNameTypes;
+    /**
+     * The data for the month names of the locale.
+     */
+    months?: LocaleDateFormatNameTypes;
+    /**
+     * The data for the quarter names of the locale.
+     */
+    quarters?: LocaleDateFormatNameTypes;
+    /**
+     * The data for the era names of the locale.
+     */
+    eras?: LocaleDateFormatNameTypes;
+    /**
+     * The date-field names of the locale.
+     */
+    dateFields: LocaleDateFieldNameTypes;
+}
+/**
+ * Describes the data of the locale.
+ */
+export interface Locale {
+    /**
+     * The name of the locale.
+     */
+    name?: string;
+    /**
+     * The territory of the locale.
+     */
+    territory?: string;
+    /**
+     * The numbers data of the locale.
+     */
+    numbers?: LocaleNumbers;
+    /**
+     * The calendar data of the locale.
+     */
+    calendar?: LocaleCalendar;
+}

package/main.d.ts

@@ -0,0 +1,10 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2021 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+export * from './intl.service';
+export * from './date.pipe';
+export * from './number.pipe';
+export * from './intl.module';
+export * from './intl-members';
+export * from './locale-data.interface';