@dxtmisha/functional-basic 1.1.0 → 1.1.6

package/dist/classes/Geo.d.ts

@@ -0,0 +1,151 @@
+import { GeoInstance } from './GeoInstance';
+import { GeoItem, GeoItemFull } from '../types/geoTypes';
+/**
+ * Static class for working with geographical data.
+ * Provides a centralized interface for managing locale, country, and time zone.
+ *
+ * Статический класс для работы с географическими данными.
+ * Предоставляет централизованный интерфейс для управления локалью, страной и часовым поясом.
+ */
+export declare class Geo {
+    /**
+     * Returns a request-isolated instance of GeoInstance.
+     *
+     * Возвращает изолированный в рамках запроса экземпляр GeoInstance.
+     * @returns GeoInstance instance / экземпляр GeoInstance
+     */
+    static getObject(): GeoInstance;
+    /**
+     * Returns information about the current country and language.
+     *
+     * Возвращает информацию о текущей стране и языке.
+     * @returns current geo item / данные о текущей гео-позиции
+     */
+    static get(): GeoItemFull;
+    /**
+     * Returns the 2-letter code of the current country.
+     *
+     * Возвращает 2-буквенный код текущей страны.
+     * @returns country code / код страны
+     */
+    static getCountry(): string;
+    /**
+     * Returns the 2-letter code of the current language.
+     *
+     * Возвращает 2-буквенный код текущего языка.
+     * @returns language code / код языка
+     */
+    static getLanguage(): string;
+    /**
+     * Returns the combined locale string in the standard format (e.g., 'en-US').
+     *
+     * Возвращает комбинированную строку локали в стандартном формате (например, 'ru-RU').
+     * @returns standard locale string / стандартная строка локали
+     */
+    static getStandard(): string;
+    /**
+     * Returns the code for the first day of the week for the current locale.
+     *
+     * Возвращает код первого дня недели для текущей локали.
+     * @returns first day of the week / первый день недели
+     */
+    static getFirstDay(): string;
+    /**
+     * Returns the current location string.
+     *
+     * Возвращает текущую строку местоположения.
+     * @returns location string / строка местоположения
+     */
+    static getLocation(): string;
+    /**
+     * Returns fully processed geo data updated with the current language.
+     *
+     * Возвращает полностью обработанные гео-данные с учетом текущего языка.
+     * @returns full geo item data / полные данные гео-объекта
+     */
+    static getItem(): GeoItemFull;
+    /**
+     * Returns the complete list of available countries and regions.
+     *
+     * Возвращает полный список доступных стран и регионов.
+     * @returns list of geo items / список гео-объектов
+     */
+    static getList(): GeoItem[];
+    /**
+     * Returns geo data by country or language code from the global database.
+     *
+     * Возвращает гео-данные по коду страны или языка из глобальной базы данных.
+     * @param code country or language code / код страны или языка
+     * @returns full geo data / полные гео-данные
+     */
+    static getByCode(code?: string): GeoItemFull;
+    /**
+     * Returns exact geo data by searching for the full locale match (e.g., 'en-US').
+     *
+     * Возвращает точные гео-данные по поиску полного совпадения локали (например, 'ru-RU').
+     * @param code full locale string / полная строка локали
+     * @returns geo item or undefined / гео-объект или undefined
+     */
+    static getByCodeFull(code: string): GeoItem | undefined;
+    /**
+     * Returns geo data for a specific country by its code.
+     *
+     * Возвращает гео-данные для конкретной страны по её коду.
+     * @param country country code / код страны
+     * @returns geo item or undefined / гео-объект или undefined
+     */
+    static getByCountry(country: string): GeoItem | undefined;
+    /**
+     * Returns geo data for a specific language by its code.
+     *
+     * Возвращает гео-данные для конкретного языка по его коду.
+     * @param language language code / код языка
+     * @returns geo item or undefined / гео-объект или undefined
+     */
+    static getByLanguage(language: string): GeoItem | undefined;
+    /**
+     * Returns the time zone offset in minutes for the current context.
+     *
+     * Возвращает смещение часового пояса в минутах для текущего контекста.
+     * @returns timezone offset / смещение часового пояса
+     */
+    static getTimezone(): number;
+    /**
+     * Returns the formatted time zone string (e.g., '+00:00') for the current context.
+     *
+     * Возвращает отформатированную строку часового пояса (например, '+03:00') для текущего контекста.
+     * @returns formatted timezone / отформатированная временная зона
+     */
+    static getTimezoneFormat(): string;
+    /**
+     * Finds or determines the geo data for a given code. Alias for getByCode.
+     *
+     * Находит или определяет гео-данные для заданного кода. Алиас для getByCode.
+     * @param code country or language code / код страны или языка
+     * @returns full geo data / полные гео-данные
+     */
+    static find(code: string): GeoItemFull;
+    /**
+     * Returns a standard concatenated string for a geo item (e.g., 'en-US').
+     *
+     * Возвращает стандартную объединенную строку для гео-объекта (например, 'ru-RU').
+     * @param item geo item data / данные гео-объекта
+     * @returns standard string / стандартная строка
+     */
+    static toStandard(item: GeoItem): string;
+    /**
+     * Sets the current geographical location. Updates the instance state.
+     *
+     * Устанавливает текущее географическое положение. Обновляет состояние инстанса.
+     * @param code location code / код локации
+     * @param save whether to persist the change in storage / сохранять ли изменения в хранилище
+     */
+    static set(code: string, save?: boolean): void;
+    /**
+     * Sets a custom time zone offset for the current context.
+     *
+     * Устанавливает кастомное смещение часового пояса для текущего контекста.
+     * @param timezone timezone offset in minutes / смещение часового пояса в минутах
+     */
+    static setTimezone(timezone: number): void;
+}

package/dist/classes/GeoFlag.d.ts

@@ -0,0 +1,98 @@
+import { GeoIntl } from './GeoIntl';
+import { GeoFlagItem, GeoFlagNational, GeoItemFull } from '../types/geoTypes';
+export declare const GEO_FLAG_ICON_NAME = "f";
+/**
+ * Class for working with flags and geographic information.
+ * Provides methods for retrieving country names, languages, and flag icons.
+ *
+ * Класс для работы с флагами и географической информацией.
+ * Предоставляет методы для получения названий стран, языков и иконок флагов.
+ */
+export declare class GeoFlag {
+    protected code: string;
+    /**
+     * Mapping of country codes to flag icon names/
+     * Словарь соответствия кодов стран названиям иконок флагов
+     */
+    static flags: Record<string, string>;
+    /**
+     * Constructor
+     *
+     * Конструктор
+     * @param code country and language code / код страны и языка
+     */
+    constructor(code?: string);
+    /**
+     * Returns information about the country and its flag.
+     *
+     * Возвращает информацию о стране и её флаге.
+     * @param code country code / код страны
+     * @returns country information / информация о стране
+     */
+    get(code?: string): GeoFlagItem | undefined;
+    /**
+     * Returns the identifier of the flag icon.
+     *
+     * Возвращает идентификатор иконки флага.
+     * @param code country code / код страны
+     * @returns flag icon identifier / идентификатор иконки флага
+     */
+    getFlag(code?: string): string | undefined;
+    /**
+     * Returns a list of countries based on the provided codes.
+     * If no codes are provided, returns all available countries.
+     *
+     * Возвращает список стран на основе предоставленных кодов.
+     * Если коды не переданы, возвращает все доступные страны.
+     * @param codes array of country codes / массив кодов стран
+     * @returns list of countries / список стран
+     */
+    getList(codes?: string[]): GeoFlagItem[];
+    /**
+     * Returns a list of countries in their national languages.
+     *
+     * Возвращает список стран на их национальных языках.
+     * @param codes array of country codes / массив кодов стран
+     * @returns list of countries with national names / список стран с национальными названиями
+     */
+    getNational(codes?: string[]): GeoFlagNational[];
+    /**
+     * Changes the current locale/location.
+     *
+     * Изменяет текущую локаль/местоположение.
+     * @param code country and language code / код страны и языка
+     * @returns this
+     */
+    setCode(code: string): this;
+    /**
+     * Returns a special object for formatting and translations.
+     *
+     * Возвращает специальный объект для работы с форматированием и переводами.
+     * @protected
+     * @returns GeoIntl instance / экземпляр GeoIntl
+     */
+    protected getLocation(): GeoIntl;
+    /**
+     * Returns a list of country codes to retrieve data from.
+     *
+     * Возвращает список кодов стран для получения данных.
+     * @param codes optional array of codes / опциональный массив кодов
+     * @protected
+     * @returns array of codes / массив кодов
+     */
+    protected getCodes(codes?: string[]): string[];
+    /**
+     * Getting the name of the language.
+     *
+     * Получение названия языка.
+     * @param data object with information of data/ объект с информацией данных
+     */
+    protected getLanguage(data: GeoItemFull): string;
+    /**
+     * Getting the name of the country.
+     *
+     * Получение названия страны.
+     * @param data object with information of data/ объект с информацией данных
+     */
+    protected getCountry(data: GeoItemFull): string;
+}

package/dist/classes/GeoInstance.d.ts

@@ -0,0 +1,215 @@
+import { GeoItem, GeoItemFull } from '../types/geoTypes';
+/**
+ * Base class for working with geographic data.
+ * Includes methods for determining location, language, and time zone.
+ *
+ * Базовый класс для работы с географическими данными.
+ * Включает методы для определения местоположения, языка и часового пояса.
+ */
+export declare class GeoInstance {
+    /**
+     * Data storage instance for geo code/
+     * Экземпляр хранилища данных для гео-кода
+     */
+    private storage;
+    /**
+     * Current location code (e.g., 'en-GB')/
+     * Текущий код локации (например, 'en-GB')
+     */
+    private location;
+    /**
+     * Detailed data about the current country/
+     * Детальные данные о текущей стране
+     */
+    private item;
+    /**
+     * Current language code/
+     * Текущий код языка
+     */
+    private language;
+    /**
+     * Current time zone offset in minutes/
+     * Текущее смещение часового пояса в минутах
+     */
+    private timezone;
+    /**
+     * Constructor.
+     * Initializes the location and related data.
+     *
+     * Конструктор.
+     * Инициализирует местоположение и связанные с ним данные.
+     */
+    constructor();
+    /**
+     * Getting information about the current country.
+     *
+     * Получение информации о текущей стране.
+     * @returns object with geo data / объект с гео-данными
+     */
+    get(): GeoItemFull;
+    /**
+     * Getting the current country code.
+     *
+     * Получение текущего кода страны.
+     * @returns country code / код страны
+     */
+    getCountry(): string;
+    /**
+     * Getting the current language code.
+     *
+     * Получение текущего кода языка.
+     * @returns language code / код языка
+     */
+    getLanguage(): string;
+    /**
+     * Getting the full format according to the standard (language-country).
+     *
+     * Получение полного формата согласно стандарту (язык-страна).
+     * @returns standard string / строка стандарта
+     */
+    getStandard(): string;
+    /**
+     * Getting the first day of the week for the current country.
+     *
+     * Получение первого дня недели для текущей страны.
+     * @returns first day of the week / первый день недели
+     */
+    getFirstDay(): string;
+    /**
+     * Getting the current location string.
+     *
+     * Получение строки текущего местоположения.
+     * @returns location string / строка местоположения
+     */
+    getLocation(): string;
+    /**
+     * Getting processed data including the current language.
+     *
+     * Получение обработанных данных, включая текущий язык.
+     * @returns full geo item data / полные данные гео-объекта
+     */
+    getItem(): GeoItemFull;
+    /**
+     * Returns the full list of available countries.
+     *
+     * Возвращает полный список доступных стран.
+     * @returns list of geo items / список гео-объектов
+     */
+    getList(): GeoItem[];
+    /**
+     * Returns data about the country by its code.
+     *
+     * Возвращает данные о стране по ее коду.
+     * @param code country code, full form language-country or one of them / код страны, полный вид язык-страна или один из них
+     * @returns full geo data / полные гео-данные
+     */
+    getByCode(code?: string): GeoItemFull;
+    /**
+     * Returns full data by language and country combination.
+     *
+     * Возвращает полные данные по комбинации языка и страны.
+     * @param code string in the form of language-country / строка в виде язык-страна
+     * @returns geo item or undefined / гео-объект или undefined
+     */
+    getByCodeFull(code: string): GeoItem | undefined;
+    /**
+     * Returns full data by country code.
+     *
+     * Возвращает полные данные по коду страны.
+     * @param country country code / код страны
+     * @returns geo item or undefined / гео-объект или undefined
+     */
+    getByCountry(country: string): GeoItem | undefined;
+    /**
+     * Returns full data by language code.
+     *
+     * Возвращает полные данные по коду языка.
+     * @param language language code / код языка
+     * @returns geo item or undefined / гео-объект или undefined
+     */
+    getByLanguage(language: string): GeoItem | undefined;
+    /**
+     * Returns the current time zone offset in minutes.
+     *
+     * Возвращает текущее смещение часового пояса в минутах.
+     * @returns timezone offset / смещение часового пояса
+     */
+    getTimezone(): number;
+    /**
+     * Returns the current time zone offset in a formatted string (e.g., '+03:00').
+     *
+     * Возвращает текущее смещение часового пояса в виде отформатированной строки (например, '+03:00').
+     * @returns formatted timezone string / отформатированная строка часового пояса
+     */
+    getTimezoneFormat(): string;
+    /**
+     * Finds the country data by its code or name.
+     *
+     * Ищет данные о стране по ее коду или названию.
+     * @param code country code / код страны
+     * @returns full geo data / полные гео-данные
+     */
+    find(code: string): GeoItemFull;
+    /**
+     * Converts a geo item to its standard string representation (language-country).
+     *
+     * Преобразует гео-объект в его стандартное строковое представление (язык-страна).
+     * @param item geo item data / данные гео-объекта
+     * @returns standard code string / строка стандартного кода
+     */
+    toStandard(item: GeoItem): string;
+    /**
+     * Updates the current location and related data.
+     *
+     * Обновляет текущее местоположение и связанные с ним данные.
+     * @param code location code (e.g., 'en-GB') / код локации (например, 'en-GB')
+     * @param save whether to save the location in storage / нужно ли сохранять местоположение в хранилище
+     */
+    set(code: string, save?: boolean): void;
+    /**
+     * Updates the default time zone offset.
+     *
+     * Обновляет смещение часового пояса по умолчанию.
+     * @param timezone new time zone offset / новое смещение часового пояса
+     */
+    setTimezone(timezone: number): void;
+    /**
+     * Internal method to determine the initial location.
+     *
+     * Внутренний метод для определения начального местоположения.
+     * @returns initial location code / начальный код локации
+     */
+    private findLocation;
+    /**
+     * Internal method to determine the language from the provided code.
+     *
+     * Внутренний метод для определения языка по предоставленному коду.
+     * @param code location or language code / код локации или языка
+     * @returns language code / код языка
+     */
+    private findLanguage;
+    /**
+     * Internal method to extract country code from a location string.
+     *
+     * Внутренний метод для извлечения кода страны из строки локации.
+     * @param code combined string / комбинированная строка
+     * @returns country code / код страны
+     */
+    private toCountry;
+    /**
+     * Internal method to extract language code from a location string.
+     *
+     * Внутренний метод для извлечения кода языка из строки локации.
+     * @param code combined string / комбинированная строка
+     * @returns language code / код языка
+     */
+    private toLanguage;
+    /**
+     * Internal method to fill missing fields in a geo item.
+     *
+     * Внутренний метод для заполнения отсутствующих полей в гео-объекте.
+     * @param item basic geo item / базовый гео-объект
+     * @returns full geo item data / полные данные гео-объекта
+     */
+    private toFull;
+}