@progress/kendo-react-intl 7.2.4-develop.2 → 7.2.4-develop.4

package/index.d.mts

@@ -1,5 +1,277 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-export * from './index';
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2024 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { DateFieldNameOptions } from '@progress/kendo-intl';
+import { DateFormatNameOptions } from '@progress/kendo-intl';
+import { DateFormatOptions } from '@progress/kendo-intl';
+import { DateFormatPart } from '@progress/kendo-intl';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { load } from '@progress/kendo-intl';
+import { NumberFormatOptions } from '@progress/kendo-intl';
+import PropTypes from 'prop-types';
+import * as React_2 from 'react';
+
+export { DateFieldNameOptions }
+
+export { DateFormatNameOptions }
+
+export { DateFormatOptions }
+
+export { DateFormatPart }
+
+/** @hidden */
+export declare const GlobalizationContext: React_2.Context<GlobalizationContextType>;
+
+/** @hidden */
+declare type GlobalizationContextType = {
+    intl: IntlService;
+    localization: LocalizationService;
+};
+
+/**
+ * A React component which provides an internationalization service. Expects a locale string as a property of the component.
+ */
+export declare class IntlProvider extends React_2.Component<IntlProviderProps, {}> {
+    /**
+     * @hidden
+     */
+    static propTypes: {
+        locale: PropTypes.Requireable<string>;
+    };
+    /**
+     * Returns an internationalization service. The method is suitable for overriding when you implement custom internationalization behavior.
+     */
+    getIntlService(): IntlService;
+    /**
+     * @hidden
+     */
+    render(): JSX_2.Element;
+}
+
+/**
+ * Represents the props of the KendoReact IntlProvider component.
+ */
+export declare interface IntlProviderProps {
+    /**
+     * The locale that will be used by the child components.
+     */
+    locale: string;
+    /**
+     * @hidden
+     */
+    children?: React.ReactNode;
+}
+
+/**
+ * A service which provides internationalization methods and is bound to a specific locale.
+ */
+export declare class IntlService {
+    locale: string;
+    /**
+     * Creates a new instance of the internationalization service.
+     *
+     * @param locale - The locale that will be used by the internationalization methods.
+     */
+    constructor(locale: 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 a `Date` object to a string based on the specified format. If no format is provided, the default short date format is used.
+     *
+     * @param value - The date which will be formatted.
+     * @param format - The format string or options.
+     * @return - The formatted date.
+     */
+    formatDate(value: Date, format?: string | DateFormatOptions): string;
+    /**
+     * Converts an object to a string based on the specified format.
+     *
+     * @param value - The value which will be formatted.
+     * @param format - The format to use.
+     * @return - The formatted object.
+     */
+    toString(value: any, format: string | any): string;
+    /**
+     * Converts a string to a `Number`.
+     *
+     * @param value - The string which will be parsed.
+     * @param format - The format string or options.
+     * @return - The parsed number.
+     */
+    parseNumber(value: string, format?: string | NumberFormatOptions): number;
+    /**
+     * Converts a string to a `Date` object based on the specified format.
+     *
+     * @param value - The string which will be converted.
+     * @param format - The format strings or options.
+     * @return - The parsed date.
+     */
+    parseDate(value: string, format?: string | DateFormatOptions | string[] | DateFormatOptions[]): Date;
+    /**
+     * Converts a `Number` to a string based on the specified format.
+     *
+     * @param value - The number which will be formatted.
+     * @param format - The format string or options.
+     * @return - The formatted number.
+     */
+    formatNumber(value: number, format: string | NumberFormatOptions): string;
+    /**
+     * Returns a localized date field name based on specific `dateFieldName` options.
+     *
+     * @param options - The detailed configuration for the desired date field name.
+     * @returns - The localized date field name from the current locale based on the option.
+     */
+    dateFieldName(options: DateFieldNameOptions): string;
+    /**
+     * Returns the day names from the current locale based on the option.
+     *
+     * @param options - The detailed configuration for the desired date format.
+     * @return - The day names from the current locale based on the option.
+     */
+    dateFormatNames(options: DateFormatNameOptions): any;
+    /**
+     * Splits the date format into objects which contain information about each part of the pattern.
+     *
+     * @param format - The format string or options.
+     * @returns - The date format parts.
+     */
+    splitDateFormat(format: string | DateFormatOptions): DateFormatPart[];
+    /**
+     * Returns the number symbols from the current locale.
+     *
+     * @return - The number symbols from the current locale.
+     */
+    numberSymbols(): any;
+    /**
+     * Returns the first day index, starting from Sunday.
+     *
+     * @return - The index of the first day of the week (0 == Sunday).
+     */
+    firstDay(): number;
+    /**
+     * @hidden
+     */
+    localeInfo(): any;
+    /**
+     * @hidden
+     */
+    localeCurrency(): any;
+}
+
+export { load }
+
+/**
+ * Provides mechanism to load language-specific messages for the KendoReact components.
+ *
+ * @param messages - An iterable object which contains key-value pairs.
+ * @param languages - The language to which the messages are associated.
+ */
+export declare function loadMessages(messages: any, language: string): void;
+
+/**
+ * @hidden
+ */
+export declare const localizationMessages: any;
+
+/**
+ * A React component which provides a localization service. Expects a language string as a property of the component.
+ */
+export declare class LocalizationProvider extends React_2.Component<LocalizationProviderProps, {}> {
+    /**
+     * @hidden
+     */
+    static propTypes: {
+        language: PropTypes.Requireable<string>;
+    };
+    /**
+     * Returns a localization service. The method is suitable for overriding when you implement custom localization behavior.
+     */
+    getLocalizationService(): LocalizationService;
+    /**
+     * @hidden
+     */
+    render(): JSX_2.Element;
+}
+
+/**
+ * Represents the props of the KendoReact LocalizationProvider component.
+ */
+export declare interface LocalizationProviderProps {
+    /**
+     * The language that will be used by the child components.
+     */
+    language: string;
+    /**
+     * @hidden
+     */
+    children?: React.ReactNode;
+}
+
+/**
+ * A service which provides localization methods.
+ */
+export declare class LocalizationService {
+    language?: string | undefined;
+    constructor(language?: string | undefined);
+    /**
+     * Provides a string based on a key for the current language. When no string for the current language is available under this key, the `defaultValue` is returned.
+     *
+     * @param key - The key which identifies the string for the current language.
+     * @param defaultValue - The default value which will be returned when no string
+     * for the current language is available under the key.
+     * @return - The string for the current language.
+     */
+    toLanguageString(key: string, defaultValue: string): string;
+}
+
+export { NumberFormatOptions }
+
+/**
+ * Provides an internationalization service. When the passed component is a direct or indirect child of `IntlProvider`, the returned service uses the locale of the provider. Otherwise, uses `en` as a default locale. To handle locale changes, call the method on each `render`.
+ *
+ * @param componentClass - The React component class that will use the internationalization service.
+ */
+export declare function provideIntlService(component: React_2.Component): IntlService;
+
+/**
+ * Provides a localization service. When the passed component is a direct or indirect child of `LocalizationProvider`, the returned service uses the language of the provider. To handle locale changes, call the method on each `render`.
+ *
+ * @param componentClass - The React component class that will use the internationalization service.
+ */
+export declare function provideLocalizationService(component: React_2.Component): LocalizationService;
+
+/**
+ * A method which registers a component class or a functional stateless component for internationalization. When a component of that type is a direct or indirect child of `IntlProvider`, the locale of the provider is used. Otherwise, uses `en` as a default locale.
+ *
+ * @param component - The React component class that will use the internationalization methods.
+ */
+export declare function registerForIntl(component: React_2.ComponentClass<any, any>): void;
+
+/**
+ * A method which registers a component class or a stateless functional component for localization. When a component of that type is a direct or indirect child of `LocalizationProvider`, the language of the provider is used.
+ *
+ * @param component - The React component class that will use the internationalization methods.
+ */
+export declare function registerForLocalization(component: React_2.ComponentClass<any, any>): void;
+
+/**
+ * A custom [React Hook](https://reactjs.org/docs/hooks-intro.html) providing access to an [IntlService]({% slug api_intl_intlservice %}).
+ */
+export declare const useInternationalization: () => IntlService;
+
+/**
+ * A custom [React Hook](https://reactjs.org/docs/hooks-intro.html) providing access to an [LocalizationService]({% slug api_intl_localizationservice %}).
+ */
+export declare const useLocalization: () => LocalizationService;
+
+export { }

package/index.d.ts

@@ -1,11 +1,277 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-export { GlobalizationContext } from './globalization/GlobalizationContext';
-export { messages as localizationMessages } from './Localization/messages';
-export * from './Intl/main';
-export * from './Localization/main';
-export * from './coreExports';
-export * from './intlUtils';
-export * from './hooks';
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2024 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { DateFieldNameOptions } from '@progress/kendo-intl';
+import { DateFormatNameOptions } from '@progress/kendo-intl';
+import { DateFormatOptions } from '@progress/kendo-intl';
+import { DateFormatPart } from '@progress/kendo-intl';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { load } from '@progress/kendo-intl';
+import { NumberFormatOptions } from '@progress/kendo-intl';
+import PropTypes from 'prop-types';
+import * as React_2 from 'react';
+
+export { DateFieldNameOptions }
+
+export { DateFormatNameOptions }
+
+export { DateFormatOptions }
+
+export { DateFormatPart }
+
+/** @hidden */
+export declare const GlobalizationContext: React_2.Context<GlobalizationContextType>;
+
+/** @hidden */
+declare type GlobalizationContextType = {
+    intl: IntlService;
+    localization: LocalizationService;
+};
+
+/**
+ * A React component which provides an internationalization service. Expects a locale string as a property of the component.
+ */
+export declare class IntlProvider extends React_2.Component<IntlProviderProps, {}> {
+    /**
+     * @hidden
+     */
+    static propTypes: {
+        locale: PropTypes.Requireable<string>;
+    };
+    /**
+     * Returns an internationalization service. The method is suitable for overriding when you implement custom internationalization behavior.
+     */
+    getIntlService(): IntlService;
+    /**
+     * @hidden
+     */
+    render(): JSX_2.Element;
+}
+
+/**
+ * Represents the props of the KendoReact IntlProvider component.
+ */
+export declare interface IntlProviderProps {
+    /**
+     * The locale that will be used by the child components.
+     */
+    locale: string;
+    /**
+     * @hidden
+     */
+    children?: React.ReactNode;
+}
+
+/**
+ * A service which provides internationalization methods and is bound to a specific locale.
+ */
+export declare class IntlService {
+    locale: string;
+    /**
+     * Creates a new instance of the internationalization service.
+     *
+     * @param locale - The locale that will be used by the internationalization methods.
+     */
+    constructor(locale: 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 a `Date` object to a string based on the specified format. If no format is provided, the default short date format is used.
+     *
+     * @param value - The date which will be formatted.
+     * @param format - The format string or options.
+     * @return - The formatted date.
+     */
+    formatDate(value: Date, format?: string | DateFormatOptions): string;
+    /**
+     * Converts an object to a string based on the specified format.
+     *
+     * @param value - The value which will be formatted.
+     * @param format - The format to use.
+     * @return - The formatted object.
+     */
+    toString(value: any, format: string | any): string;
+    /**
+     * Converts a string to a `Number`.
+     *
+     * @param value - The string which will be parsed.
+     * @param format - The format string or options.
+     * @return - The parsed number.
+     */
+    parseNumber(value: string, format?: string | NumberFormatOptions): number;
+    /**
+     * Converts a string to a `Date` object based on the specified format.
+     *
+     * @param value - The string which will be converted.
+     * @param format - The format strings or options.
+     * @return - The parsed date.
+     */
+    parseDate(value: string, format?: string | DateFormatOptions | string[] | DateFormatOptions[]): Date;
+    /**
+     * Converts a `Number` to a string based on the specified format.
+     *
+     * @param value - The number which will be formatted.
+     * @param format - The format string or options.
+     * @return - The formatted number.
+     */
+    formatNumber(value: number, format: string | NumberFormatOptions): string;
+    /**
+     * Returns a localized date field name based on specific `dateFieldName` options.
+     *
+     * @param options - The detailed configuration for the desired date field name.
+     * @returns - The localized date field name from the current locale based on the option.
+     */
+    dateFieldName(options: DateFieldNameOptions): string;
+    /**
+     * Returns the day names from the current locale based on the option.
+     *
+     * @param options - The detailed configuration for the desired date format.
+     * @return - The day names from the current locale based on the option.
+     */
+    dateFormatNames(options: DateFormatNameOptions): any;
+    /**
+     * Splits the date format into objects which contain information about each part of the pattern.
+     *
+     * @param format - The format string or options.
+     * @returns - The date format parts.
+     */
+    splitDateFormat(format: string | DateFormatOptions): DateFormatPart[];
+    /**
+     * Returns the number symbols from the current locale.
+     *
+     * @return - The number symbols from the current locale.
+     */
+    numberSymbols(): any;
+    /**
+     * Returns the first day index, starting from Sunday.
+     *
+     * @return - The index of the first day of the week (0 == Sunday).
+     */
+    firstDay(): number;
+    /**
+     * @hidden
+     */
+    localeInfo(): any;
+    /**
+     * @hidden
+     */
+    localeCurrency(): any;
+}
+
+export { load }
+
+/**
+ * Provides mechanism to load language-specific messages for the KendoReact components.
+ *
+ * @param messages - An iterable object which contains key-value pairs.
+ * @param languages - The language to which the messages are associated.
+ */
+export declare function loadMessages(messages: any, language: string): void;
+
+/**
+ * @hidden
+ */
+export declare const localizationMessages: any;
+
+/**
+ * A React component which provides a localization service. Expects a language string as a property of the component.
+ */
+export declare class LocalizationProvider extends React_2.Component<LocalizationProviderProps, {}> {
+    /**
+     * @hidden
+     */
+    static propTypes: {
+        language: PropTypes.Requireable<string>;
+    };
+    /**
+     * Returns a localization service. The method is suitable for overriding when you implement custom localization behavior.
+     */
+    getLocalizationService(): LocalizationService;
+    /**
+     * @hidden
+     */
+    render(): JSX_2.Element;
+}
+
+/**
+ * Represents the props of the KendoReact LocalizationProvider component.
+ */
+export declare interface LocalizationProviderProps {
+    /**
+     * The language that will be used by the child components.
+     */
+    language: string;
+    /**
+     * @hidden
+     */
+    children?: React.ReactNode;
+}
+
+/**
+ * A service which provides localization methods.
+ */
+export declare class LocalizationService {
+    language?: string | undefined;
+    constructor(language?: string | undefined);
+    /**
+     * Provides a string based on a key for the current language. When no string for the current language is available under this key, the `defaultValue` is returned.
+     *
+     * @param key - The key which identifies the string for the current language.
+     * @param defaultValue - The default value which will be returned when no string
+     * for the current language is available under the key.
+     * @return - The string for the current language.
+     */
+    toLanguageString(key: string, defaultValue: string): string;
+}
+
+export { NumberFormatOptions }
+
+/**
+ * Provides an internationalization service. When the passed component is a direct or indirect child of `IntlProvider`, the returned service uses the locale of the provider. Otherwise, uses `en` as a default locale. To handle locale changes, call the method on each `render`.
+ *
+ * @param componentClass - The React component class that will use the internationalization service.
+ */
+export declare function provideIntlService(component: React_2.Component): IntlService;
+
+/**
+ * Provides a localization service. When the passed component is a direct or indirect child of `LocalizationProvider`, the returned service uses the language of the provider. To handle locale changes, call the method on each `render`.
+ *
+ * @param componentClass - The React component class that will use the internationalization service.
+ */
+export declare function provideLocalizationService(component: React_2.Component): LocalizationService;
+
+/**
+ * A method which registers a component class or a functional stateless component for internationalization. When a component of that type is a direct or indirect child of `IntlProvider`, the locale of the provider is used. Otherwise, uses `en` as a default locale.
+ *
+ * @param component - The React component class that will use the internationalization methods.
+ */
+export declare function registerForIntl(component: React_2.ComponentClass<any, any>): void;
+
+/**
+ * A method which registers a component class or a stateless functional component for localization. When a component of that type is a direct or indirect child of `LocalizationProvider`, the language of the provider is used.
+ *
+ * @param component - The React component class that will use the internationalization methods.
+ */
+export declare function registerForLocalization(component: React_2.ComponentClass<any, any>): void;
+
+/**
+ * A custom [React Hook](https://reactjs.org/docs/hooks-intro.html) providing access to an [IntlService]({% slug api_intl_intlservice %}).
+ */
+export declare const useInternationalization: () => IntlService;
+
+/**
+ * A custom [React Hook](https://reactjs.org/docs/hooks-intro.html) providing access to an [LocalizationService]({% slug api_intl_localizationservice %}).
+ */
+export declare const useLocalization: () => LocalizationService;
+
+export { }

package/index.js

@@ -1,5 +1,8 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-"use client";"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const y=require("react"),p=require("@progress/kendo-intl"),z=require("@progress/kendo-react-common"),d=require("prop-types");function g(t){const e=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(t){for(const r in t)if(r!=="default"){const i=Object.getOwnPropertyDescriptor(t,r);Object.defineProperty(e,r,i.get?i:{enumerable:!0,get:()=>t[r]})}}return e.default=t,Object.freeze(e)}const n=g(y),o=g(p),b={name:"@progress/kendo-react-intl",productName:"KendoReact",productCodes:["KENDOUIREACT","KENDOUICOMPLETE"],publishDate:0,version:"",licensingDocsUrl:"https://www.telerik.com/kendo-react-ui/components/my-license/"};class s{constructor(e){if(this.locale=e,z.validatePackage(b),e===""&&process.env.NODE_ENV!=="production")throw"Locale should not be empty string"}format(e,...r){return r.length===1&&Array.isArray(r[0])?o.format(e,r[0],this.locale):o.format(e,r,this.locale)}formatDate(e,r){return o.formatDate(e,r,this.locale)}toString(e,r){return o.toString(e,r,this.locale)}parseNumber(e,r){return o.parseNumber(e,this.locale,r)}parseDate(e,r){return o.parseDate(e,r,this.locale)}formatNumber(e,r){return o.formatNumber(e,r,this.locale)}dateFieldName(e){return o.dateFieldName(e,this.locale)}dateFormatNames(e){return o.dateFormatNames(this.locale,e)}splitDateFormat(e){return o.splitDateFormat(e,this.locale)}numberSymbols(){return o.numberSymbols(this.locale)}firstDay(){return o.firstDay(this.locale)}localeInfo(){return o.localeInfo(this.locale)}localeCurrency(){return o.localeCurrency(this.locale)}}const l=Object.create({});class c{constructor(e){if(this.language=e,e===""&&process.env.NODE_ENV!=="production")throw"Language should not be an empty string"}toLanguageString(e,r){return this.language&&l[this.language]&&l[this.language].hasOwnProperty(e)?l[this.language][e]:r}}const a=n.createContext({intl:new s("en"),localization:new c});class m extends n.Component{getIntlService(){return new s(this.props.locale)}render(){return n.createElement(a.Consumer,null,e=>n.createElement(a.Provider,{value:{...e,intl:this.getIntlService()}},this.props.children))}}m.propTypes={locale:d.string};const h=(t,e,r)=>{for(const i in t)if(t.hasOwnProperty(i)){const u=[...r];if(u.push(i),typeof t[i]!="string")h(t[i],e,u);else{const v=t[i];Object.defineProperty(e,u.join("."),{value:v})}}};function S(t,e){let r=l[e]=l[e]||{};h(t,r,[])}class f extends n.Component{getLocalizationService(){return new c(this.props.language)}render(){return n.createElement(a.Consumer,null,e=>n.createElement(a.Provider,{value:{...e,localization:this.getLocalizationService()}},this.props.children))}}f.propTypes={language:d.string};function N(t){if(!t&&process.env.NODE_ENV!=="production")throw`Passed component - ${t} is invalid.`;const e=t.context;return e&&e.intl?e.intl:new s("en")}function D(t){if(!t&&process.env.NODE_ENV!=="production")throw`Passed component - ${t} is invalid.`;const e=t.context;return e&&e.localization?e.localization:new c}function I(t){t.contextType=a}function O(t){t.contextType=a}const P=()=>n.useContext(a).intl,E=()=>n.useContext(a).localization;Object.defineProperty(exports,"load",{enumerable:!0,get:()=>p.load});exports.GlobalizationContext=a;exports.IntlProvider=m;exports.IntlService=s;exports.LocalizationProvider=f;exports.LocalizationService=c;exports.loadMessages=S;exports.localizationMessages=l;exports.provideIntlService=N;exports.provideLocalizationService=D;exports.registerForIntl=I;exports.registerForLocalization=O;exports.useInternationalization=P;exports.useLocalization=E;
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2024 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+"use client";"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("./globalization/GlobalizationContext.js"),o=require("./Localization/messages.js"),e=require("./intlUtils.js"),r=require("./Intl/IntlProvider.js"),t=require("./Intl/IntlService.js"),n=require("./Localization/loadMessages.js"),a=require("./Localization/LocalizationProvider.js"),l=require("./Localization/LocalizationService.js"),s=require("@progress/kendo-intl"),c=require("./hooks/useInternationalization.js"),u=require("./hooks/useLocalization.js");exports.GlobalizationContext=i.GlobalizationContext;exports.localizationMessages=o.messages;exports.provideIntlService=e.provideIntlService;exports.provideLocalizationService=e.provideLocalizationService;exports.registerForIntl=e.registerForIntl;exports.registerForLocalization=e.registerForLocalization;exports.IntlProvider=r.IntlProvider;exports.IntlService=t.IntlService;exports.loadMessages=n.loadMessages;exports.LocalizationProvider=a.LocalizationProvider;exports.LocalizationService=l.LocalizationService;Object.defineProperty(exports,"load",{enumerable:!0,get:()=>s.load});exports.useInternationalization=c.useInternationalization;exports.useLocalization=u.useLocalization;