@dxtmisha/functional-basic 1.8.10 → 1.10.1

package/dist/types/formattersTypes.d.ts

@@ -1,224 +0,0 @@
-import { ArrayToItem } from './basicTypes';
-import { GeoDate } from './geoTypes';
-/**
- * Enumeration of available formatter types.
- *
- * Перечисление доступных типов форматировщиков.
- */
-export declare enum FormattersType {
-    /** Currency formatting / Форматирование валюты. */
-    currency = "currency",
-    /** Date formatting / Форматирование даты. */
-    date = "date",
-    /** Name formatting / Форматирование имени. */
-    name = "name",
-    /** Number formatting / Форматирование чисел. */
-    number = "number",
-    /** Plural forms formatting / Форматирование форм множественного числа. */
-    plural = "plural",
-    /** Unit formatting (e.g., meters, kilograms) / Форматирование единиц измерения (например, метры, килограммы). */
-    unit = "unit"
-}
-/**
- * Options for currency formatting.
- *
- * Параметры для форматирования валюты.
- */
-export type FormattersOptionsCurrency = {
-    /** The name of the property in the data item that contains the currency code / Имя свойства в элементе данных, которое содержит код валюты. */
-    currencyPropName?: string;
-    /** Currency code or international number format options / Код валюты или международные параметры форматирования чисел. */
-    options?: string | Intl.NumberFormatOptions;
-    /** If true, only the numeric value will be returned / Если true, будет возвращено только числовое значение. */
-    numberOnly?: boolean;
-};
-/**
- * Options for date formatting.
- *
- * Параметры для форматирования даты.
- */
-export type FormattersOptionsDate = {
-    /** The type of date representation / Тип представления даты. */
-    type?: GeoDate;
-    /** International date-time format options / Междунар. параметры форматирования даты и времени. */
-    options?: Intl.DateTimeFormatOptions['month'] | Intl.DateTimeFormatOptions;
-    /** Use 24-hour format if true / Использовать 24-часовой формат, если true. */
-    hour24?: boolean;
-};
-/**
- * Options for name formatting.
- *
- * Параметры для форматирования имени.
- */
-export type FormattersOptionsName = {
-    /** Property name for the last name / Имя свойства для фамилии. */
-    lastPropName?: string;
-    /** Property name for the first name / Имя свойства для имени. */
-    firstPropName?: string;
-    /** Property name for the middle name / Имя свойства для отчества. */
-    surname?: string;
-    /** If true, returns a short version of the name / Если true, возвращает сокращенную версию имени. */
-    short?: boolean;
-};
-/**
- * Options for number formatting.
- *
- * Параметры для форматирования чисел.
- */
-export type FormattersOptionsNumber = {
-    /** International number format options / Междунар. параметры форматирования чисел. */
-    options?: Intl.NumberFormatOptions;
-};
-/**
- * Options for plural forms formatting.
- *
- * Параметры для форматирования форм множественного числа.
- */
-export type FormattersOptionsPlural = {
-    /** A string containing plural forms / Строка, содержащая формы множественного числа. */
-    words: string;
-    /** International plural rules options / Междунар. параметры правил множественного числа. */
-    options?: Intl.PluralRulesOptions;
-    /** International number format options for the numeric part / Междунар. параметры форматирования чисел для числовой части. */
-    optionsNumber?: Intl.NumberFormatOptions;
-};
-/**
- * Options for unit formatting.
- *
- * Параметры для форматирования единиц измерения.
- */
-export type FormattersOptionsUnit = {
-    /** The unit to format or international number format options / Ед. изм. для форматирования или междунар. параметры форматирования чисел. */
-    unit: string | Intl.NumberFormatOptions;
-};
-/**
- * Mapping of formatter types to their respective option types.
- *
- * Соответствие типов форматировщиков их типам параметров.
- *
- * @template Type - The formatter type / Тип форматировщика.
- */
-export type FormattersOptionsInformation<Type extends FormattersType> = Type extends FormattersType.currency ? FormattersOptionsCurrency : Type extends FormattersType.date ? FormattersOptionsDate : Type extends FormattersType.name ? FormattersOptionsName : Type extends FormattersType.number ? FormattersOptionsNumber : Type extends FormattersType.plural ? FormattersOptionsPlural : Type extends FormattersType.unit ? FormattersOptionsUnit : Record<string, any>;
-/**
- * Configuration for a single property formatter.
- *
- * Конфигурация для форматировщика одного свойства.
- *
- * @template Type - The type of formatter / Тип форматировщика.
- * @template R - The return type / Возвращаемый тип.
- */
-export type FormattersOptionsItem<Type extends FormattersType = FormattersType, R = string> = {
-    /** The type of formatter / Тип форматировщика. */
-    type?: Type;
-    /** Custom transformation function / Пользовательская функция преобразования. */
-    transformation?: (valueOriginal: any, item: any, options?: FormattersOptionsInformation<Type>) => R;
-    /** Options for the specified formatter type / Параметры для указанного типа форматировщика. */
-    options?: FormattersOptionsInformation<Type>;
-};
-/**
- * A dictionary mapping property paths to their formatting configurations.
- *
- * Словарь, сопоставляющий пути к свойствам с их конфигурациями форматирования.
- */
-export type FormattersOptionsList = Record<string, FormattersOptionsItem>;
-/**
- * Represents a single data item as a key-value record.
- *
- * Представляет один элемент данных как запись "ключ-значение".
- */
-export type FormattersListItem = Record<string, any>;
-/**
- * An array of data items to be formatted.
- *
- * Массив элементов данных для форматирования.
- *
- * @template Item - The type of data items / Тип элементов данных.
- */
-export type FormattersList<Item extends FormattersListItem> = Item[];
-/**
- * Utility type to capitalize a camelCase or dot-notated string.
- *
- * Вспомогательный тип для капитализации строки.
- *
- * @template K - The string to capitalize / Строка для капитализации.
- */
-export type FormattersCapitalize<K extends string> = K extends `${infer First}.${infer Rest}` ? `${First}${Capitalize<FormattersCapitalize<Rest>>}` : K;
-/**
- * Utility type to extract column keys from formatting options.
- *
- * Вспомогательный тип для извлечения ключей столбцов.
- *
- * @template T - The formatting options list type / Тип списка параметров форматирования.
- */
-export type FormattersColumns<T extends FormattersOptionsList> = (keyof T & string)[];
-/**
- * Utility type to generate a formatted property key.
- *
- * Вспомогательный тип для генерации ключа отформатированного свойства.
- *
- * @template K - The original property key / Ключ исходного свойства.
- * @template A - The suffix to add / Суффикс.
- */
-export type FormattersKey<K, A extends string = 'Format'> = K extends string ? `${FormattersCapitalize<K>}${A}` : never;
-/**
- * Represents a data item with additional formatted properties.
- *
- * Представляет элемент данных с доп. отформатированными свойствами.
- *
- * @template T - The original item type / Исходный тип элемента.
- * @template KT - Array of property keys / Массив ключей свойств.
- */
-export type FormattersDataItem<T extends FormattersListItem, KT extends string[]> = {
-    [K in keyof T | FormattersKey<KT[number]>]: K extends keyof T ? T[K] : string;
-};
-/**
- * An array of data items with additional formatted properties.
- *
- * Массив элементов данных с доп. отформатированными свойствами.
- *
- * @template T - The original item type / Исходный тип элемента.
- * @template K - Array of property keys / Массив ключей свойств.
- */
-export type FormattersListFormat<T extends FormattersListItem, K extends string[]> = FormattersDataItem<T, K>[];
-/**
- * A single data item formatted based on the provided options list.
- *
- * Один элемент данных, отформатированный на основе параметров.
- *
- * @template T - The original item type / Исходный тип элемента.
- * @template O - The formatting options / Параметры форматирования.
- */
-export type FormattersListColumnItem<T extends FormattersListItem, O extends FormattersOptionsList> = FormattersDataItem<T, FormattersColumns<O>>;
-/**
- * A list of data items formatted based on the provided options list.
- *
- * Список элементов данных, отформатированных на основе параметров.
- *
- * @template T - The original item type / Исходный тип элемента.
- * @template O - The formatting options / Параметры форматирования.
- */
-export type FormattersListColumns<T extends FormattersListItem, O extends FormattersOptionsList> = FormattersListFormat<T, FormattersColumns<O>>;
-/**
- * Possible formats for input data: either a single item or a list of items.
- *
- * Возможные форматы входных данных: либо один элемент, либо список элементов.
- */
-export type FormattersListProp = FormattersList<FormattersListItem> | FormattersListItem;
-/**
- * Extracts the single item type from a single item or a list of items.
- *
- * Извлекает тип одного элемента из одного элемента или из списка элементов.
- *
- * @template List - The type of the input data / Тип входных данных.
- */
-export type FormattersItemProp<List extends FormattersListProp> = ArrayToItem<List>;
-/**
- * The return type of the formatter, matching the structure of the input data.
- *
- * Возвращаемый тип форматировщика, соответствующий структуре входных данных.
- *
- * @template List - The input data type / Тип входных данных.
- * @template Options - The formatting options / Параметры форматирования.
- * @template Item - The type of a single item / Тип одного элемента.
- */
-export type FormattersReturn<List extends FormattersListProp, Options extends FormattersOptionsList = FormattersOptionsList, Item extends FormattersItemProp<List> = FormattersItemProp<List>> = List extends any[] ? FormattersListColumns<Item, Options> : (FormattersListColumnItem<Item, Options> | undefined);

package/dist/types/geoTypes.d.ts

@@ -1,142 +0,0 @@
-/**
- * Union type for date format options in geographic context /
- * Объединенный тип для опций формата даты в географическом контексте
- */
-export type GeoDate = 'full' | 'datetime' | 'date' | 'year-month' | 'year' | 'month' | 'day' | 'day-month' | 'time' | 'hour-minute' | 'hour' | 'minute' | 'second';
-/** First day of week code (0 = Sunday, 1 = Monday, 6 = Saturday) / Код первого дня недели (0 = воскресенье, 1 = понедельник, 6 = суббота) */
-export type GeoFirstDay = 1 | 6 | 0;
-/** Hour format type (12-hour or 24-hour) / Тип формата часов (12-часовой или 24-часовой) */
-export type GeoHours = '12' | '24';
-/** Timezone display style options / Опции стиля отображения часового пояса */
-export type GeoTimeZoneStyle = 'minute' | 'hour' | 'ISO8601' | 'RFC';
-/** Geographic item interface for country and language data / Интерфейс географического элемента для данных страны и языка */
-export interface GeoItem {
-    /** Country code / Код страны */
-    country: string;
-    /** Alternative country codes / Альтернативные коды стран */
-    countryAlternative?: string[];
-    /** Language code / Код языка */
-    language: string;
-    /** Alternative language codes / Альтернативные коды языков */
-    languageAlternative?: string[];
-    /** First day of week / Первый день недели */
-    firstDay?: string | null;
-    /** Timezone / Часовой пояс */
-    zone?: string | null;
-    /** Phone country code / Телефонный код страны */
-    phoneCode?: string;
-    /** Phone code for domestic calls / Телефонный код для внутренних звонков */
-    phoneWithin?: string;
-    /** Phone number mask / Маска телефонного номера */
-    phoneMask?: string | string[];
-    /** Name format pattern / Шаблон формата имени */
-    nameFormat?: 'fl' | 'fsl' | 'lf' | 'lsf' | string;
-    /** Units of measurement configuration / Конфигурация единиц измерения */
-    unit?: {
-        /** Millimeter unit format or symbol / Формат или символ единицы измерения миллиметра */
-        'millimeter'?: string;
-        /** Centimeter unit format or symbol / Формат или символ единицы измерения сантиметра */
-        'centimeter'?: string;
-        /** Meter unit format or symbol / Формат или символ единицы измерения метра */
-        'meter'?: string;
-        /** Kilometer unit format or symbol / Формат или символ единицы измерения километра */
-        'kilometer'?: string;
-        /** Square meter unit format or symbol / Формат или символ единицы измерения квадратного метра */
-        'square-meter'?: string;
-        /** Hectare unit format or symbol / Формат или символ единицы измерения гектара */
-        'hectare'?: string;
-        /** Gram unit format or symbol / Формат или символ единицы измерения грамма */
-        'gram'?: string;
-        /** Kilogram unit format or symbol / Формат или символ единицы измерения килограмма */
-        'kilogram'?: string;
-        /** Tonne unit format or symbol / Формат или символ единицы измерения тонны */
-        'tonne'?: string;
-        /** Milliliter unit format or symbol / Формат или символ единицы измерения миллилитра */
-        'milliliter'?: string;
-        /** Liter unit format or symbol / Формат или символ единицы измерения литра */
-        'liter'?: string;
-        /** Celsius unit format or symbol / Формат или символ единицы измерения градуса Цельсия */
-        'celsius'?: string;
-        /** Kilometer per hour unit format or symbol / Формат или символ единицы измерения километра в час */
-        'kilometer-per-hour'?: string;
-    };
-}
-/** Extended geographic item with required fields / Расширенный географический элемент с обязательными полями */
-export interface GeoItemFull extends Omit<GeoItem, 'firstDay'> {
-    /** Standard locale code / Стандартный код локали */
-    standard: string;
-    /** First day of week (required) / Первый день недели (обязательный) */
-    firstDay: string;
-    /** Current location string / Строка текущего местоположения */
-    location: string;
-    /** Current country code from location / Текущий код страны из местоположения */
-    locationCountry: string;
-    /** Current language code from location / Текущий код языка из местоположения */
-    locationLanguage: string;
-}
-/** Geographic flag item for country flag display / Элемент географического флага для отображения флага страны */
-export interface GeoFlagItem {
-    /** Language name / Название языка */
-    language: string;
-    /** Language code / Код языка */
-    languageCode: string;
-    /** Country name / Название страны */
-    country: string;
-    /** Country code / Код страны */
-    countryCode: string;
-    /** Standard locale code / Стандартный код локали */
-    standard: string;
-    /** Flag icon identifier / Идентификатор иконки флага */
-    icon?: string;
-    /** Display label / Отображаемая метка */
-    label: string;
-    /** Value for selection / Значение для выбора */
-    value: string;
-    /** Phone country code / Телефонный код страны */
-    phoneCode?: string;
-}
-/**
- * Extended geographic flag item with national language information /
- * Расширенный элемент географического флага с информацией о национальном языке
- */
-export interface GeoFlagNational extends GeoFlagItem {
-    /** Description in national language / Описание на национальном языке */
-    description: string;
-    /** Language name in national language / Название языка на национальном языке */
-    nationalLanguage: string;
-    /** Country name in national language / Название страны на национальном языке */
-    nationalCountry: string;
-}
-/** Phone configuration metadata for a country / Структура метаданных для конфигурации телефона страны */
-export interface GeoPhoneValue {
-    /** Phone country code (e.g., 7) / Телефонный код страны (например, 7) */
-    phone: number;
-    /** Internal dialing rule code / Код внутреннего правила набора */
-    within: number;
-    /** Array of mask patterns assigned to the country / Массив паттернов масок, закрепленных за страной */
-    mask: string[];
-    /** Country identifier (ISO 3166) / Идентификатор страны (ISO 3166) */
-    value: string;
-}
-/** Node in the internal phone prefix tree (Trie) / Узел внутреннего префиксного дерева телефонов (Trie) */
-export interface GeoPhoneMap {
-    /** List of all items available in this branch of the tree / Список всех элементов, доступных в данной ветви дерева */
-    items: GeoPhoneValue[];
-    /** Phone metadata if the current node is a complete code / Метаданные телефона, если текущий узел является завершенным кодом */
-    info: GeoPhoneValue | undefined;
-    /** Country identifier for this node / Идентификатор страны для данного узла */
-    value: string | undefined;
-    /** Array of masks with substituted internal symbols / Массив масок с подставленными спецсимволами */
-    mask: string[];
-    /** Full masks including the international code / Полные маски, включая международный код */
-    maskFull: string[];
-    /** Pointers to the next digits in the search tree / Указатели на следующие цифры номера в дереве поиска */
-    next: Record<string, GeoPhoneMap>;
-}
-/** Result of searching a country by phone number / Результат поиска страны по номеру телефона */
-export interface GeoPhoneMapInfo {
-    /** The found tree node with country and mask information / Найденный узел дерева с информацией о стране и масках */
-    item?: GeoPhoneMap;
-    /** The remaining part of the number after separating the country code / Оставшаяся часть номера после отделения кода страны */
-    phone?: string;
-}