@dxtmisha/functional-basic 0.1.0 → 0.1.1

package/src/functions/toCamelCaseFirst.ts

@@ -0,0 +1,12 @@
+import { toCamelCase } from './toCamelCase'
+
+/**
+ * Convert a String to Camel Case (+ first letter).
+ *
+ * Преобразование строки в Camel Case (+ первая буква).
+ * @param value input value/ входное значение
+ */
+export function toCamelCaseFirst(value: string): string {
+  return toCamelCase(value)
+    .replace(/^([a-z])/, char => `${char.toUpperCase()}`)
+}

package/src/functions/toDate.ts

@@ -0,0 +1,44 @@
+import { isNull } from './isNull'
+import { Geo } from '../classes/Geo'
+
+/**
+ * Conversion to Date object.
+ *
+ * Преобразование в объект Date.
+ * @param value input value/ входное значение
+ */
+export function toDate<T extends Date | number | string>(value?: T): (T & Date) | Date {
+  if (value instanceof Date) {
+    return value
+  }
+
+  if (isNull(value)) {
+    return new Date()
+  }
+
+  if (typeof value === 'number') {
+    return new Date(value)
+  }
+
+  let date: string = value
+  let timeZone: string = Geo.getTimezoneFormat()
+
+  value.replace(/^([\s\S]+)([-+]\d{2}:?\d{2})$/, (all, d: string, z: string) => {
+    date = d
+    timeZone = z
+
+    return all
+  })
+
+  const stringDate = ((/^\d{4}\d{2}\d{2}$/.exec(date)) && `${date.replace(/^(\d{4})(\d{2})(\d{2})$/, '$1-$2-$3')}T00:00:00`)
+    ?? ((/^\d{4}\d{2}$/.exec(date)) && `${date.replace(/^(\d{4})(\d{2})$/, '$1-$2')}-01T00:00:00`)
+    ?? ((/^\d{4}\d{2}\d{2} \d{2}:\d{2}:\d{2}$/.exec(date)) && date.replace(/^(\d{4})(\d{2})(\d{2}) (\d{2}):(\d{2}):(\d{2})$/, '$1-$2-$3T$4:$5:$6'))
+    ?? ((/^\d{4}-\d{2}-\d{2}$/.exec(date)) && `${date}T00:00:00`)
+    ?? ((/^\d{4}-\d{2}$/.exec(date)) && `${date}-01T00:00:00`)
+    ?? ((/^\d{4}$/.exec(date)) && `${date}-01-01T00:00:00`)
+    ?? ((/^\d{2}:\d{2}$/.exec(date)) && `2000-01-01T${date}:00`)
+    ?? ((/^\d{2}:\d{2}:\d{2}$/.exec(date)) && `2000-01-01T${date}`)
+    ?? (date.replace(' ', 'T'))
+
+  return new Date(`${stringDate}${timeZone}`)
+}

package/src/functions/toKebabCase.ts

@@ -0,0 +1,25 @@
+/**
+ * Преобразует строку в формат kebab-case.
+ * Преобразует все заглавные буквы в строчные, заменяет пробелы и другие символы на дефисы.
+ *
+ * Converts a string to kebab-case.
+ * It converts uppercase letters to lowercase, replaces spaces and other characters with dashes.
+ *
+ * @param value - Строка, которую необходимо преобразовать.
+ *
+ * The string to be converted.
+ * @returns Строка в формате kebab-case.
+ *
+ * The string in kebab-case format.
+ */
+export function toKebabCase(value: string): string {
+  return value
+    .toString()
+    .trim()
+    .replace(/[^\w- ]+/g, '')
+    .replace(/ +/g, '-')
+    .replace(/(?<=[A-Z])([A-Z])/g, char => `${char.toLowerCase()}`)
+    .replace(/^[A-Z]/, char => char.toLowerCase())
+    .replace(/(?<=[\w ])[A-Z]/g, char => `-${char.toLowerCase()}`)
+    .replace(/[A-Z]/g, char => char.toLowerCase())
+}

package/src/functions/toNumber.ts

@@ -0,0 +1,35 @@
+import type { NumberOrString } from '../types/basicTypes'
+
+/**
+ * The method parses a string argument and returns a floating point number.
+ *
+ * Метод принимает строку в качестве аргумента и возвращает десятичное число
+ * @param value input value/ входное значение
+ */
+export function toNumber<T extends NumberOrString>(value?: T): (T & number) | number {
+  if (typeof value === 'number') {
+    return value
+  }
+
+  if (!value) {
+    return 0
+  }
+
+  let number = value.replace(/[^\d., ]+/ig, '')
+
+  if (number.match(/( [0-9]{3}[ ,.]|[0-9] [0-9])/ig)) {
+    number = number
+      .replace(/ /ig, '')
+      .replace(/,/ig, '.')
+  } else if (number.match(/,[0-9]{3}[,.]/ig)) {
+    number = number.replace(/,/ig, '')
+  } else if (number.match(/[.][0-9]{3}[,.]/ig)) {
+    number = number
+      .replace(/[.]/ig, '')
+      .replace(/,/ig, '.')
+  } else {
+    number = number.replace(/,/ig, '.')
+  }
+
+  return parseFloat(number)
+}

package/src/functions/toNumberByMax.ts

@@ -0,0 +1,33 @@
+import { toNumber } from './toNumber'
+
+import { GeoIntl } from '../classes/GeoIntl'
+
+/**
+ * Converts the data into a number, taking into account the maximum permissible value.<br>
+ * Преобразует данные в число с учетом максимально допустимого значения.
+ * @param value input value /<br>входное значение
+ * @param max maximum achievable value /<br>максимально достижимое значение
+ * @param formatting format the number /<br>форматировать число
+ * @param language formatting language /<br>язык форматирования
+ */
+export function toNumberByMax(
+  value: string | number,
+  max?: string | number,
+  formatting?: boolean,
+  language?: string
+) {
+  const number = toNumber(value)
+  const maxNumber = toNumber(max)
+
+  if (max && maxNumber < number) {
+    return `${getFormatting(maxNumber, formatting, language)}+`
+  }
+
+  return getFormatting(number, formatting, language)
+}
+
+const getFormatting = (
+  value: number,
+  formatting?: boolean,
+  language?: string
+) => formatting ? new GeoIntl(language).number(value) : value

package/src/functions/toPercent.ts

@@ -0,0 +1,10 @@
+/**
+ * Converts values to percentages
+ *
+ * Преобразует значения в проценты
+ * @param maxValue maximum value/ максимальное значение
+ * @param value current value/ текущее значение
+ */
+export function toPercent(maxValue: number, value: number): number {
+  return 1 / maxValue * value
+}

package/src/functions/toPercentBy100.ts

@@ -0,0 +1,12 @@
+import { toPercent } from './toPercent'
+
+/**
+ * Converts values to percentages (three-digit)
+ *
+ * Преобразует значения в проценты (трёхзначный)
+ * @param maxValue maximum value/ максимальное значение
+ * @param value current value/ текущее значение
+ */
+export function toPercentBy100(maxValue: number, value: number): number {
+  return toPercent(maxValue, value) * 100
+}

package/src/functions/transformation.ts

@@ -0,0 +1,59 @@
+import { isDomRuntime } from './isDomRuntime'
+import { type FunctionArgs } from '../types/basicTypes'
+
+/**
+ * Преобразует строку в соответствующий тип данных.
+ * В зависимости от содержания строки, она может быть преобразована в
+ * `undefined`, `null`, `true`, `false`, объект, число или функцию.
+ *
+ * Transforms a string into the corresponding data type.
+ * Based on the string content, it may be transformed into `undefined`,
+ * `null`, `true`, `false`, object, number, or function.
+ *
+ * @param value - Значение, которое необходимо преобразовать
+ *
+ * The value to be transformed
+ * @param isFunction - Флаг, который указывает, необходимо ли проверять функцию
+ * в глобальном объекте window
+ *
+ * A flag that indicates whether to check for a function in the global window object
+ * @returns Преобразованное значение
+ *
+ * The transformed value
+ */
+export function transformation(value: any, isFunction = false): any {
+  if (typeof value === 'string') {
+    const item = value.trim()
+
+    switch (item) {
+      case 'undefined':
+        return undefined
+      case 'null':
+        return null
+      case 'true':
+        return true
+      case 'false':
+        return false
+      default:
+        if (/^[{[]/.exec(item)) {
+          try {
+            return JSON.parse(item)
+          } catch (e) {
+            console.error('transformation: JSON error', e)
+          }
+        } else if (/^[0-9]+\.[0-9.]+$/.exec(item)) {
+          return parseFloat(item)
+        } else if (/^[0-9]+$/.exec(item)) {
+          return parseInt(item, 10)
+        } else if (
+          isFunction
+          && isDomRuntime()
+          && typeof window?.[item as any] === 'function'
+        ) {
+          return window[item as any] as any as FunctionArgs<any, any>
+        }
+    }
+  }
+
+  return value
+}

package/src/functions/uniqueArray.ts

@@ -0,0 +1,9 @@
+/**
+ * Removes duplicate entries in an array.
+ *
+ * Удаляет повторяющиеся записи в массиве.
+ * @param value input value/ входное значение
+ */
+export function uniqueArray<T>(value: T[]): T[] {
+  return [...new Set(value)]
+}

package/src/functions/writeClipboardData.ts

@@ -0,0 +1,17 @@
+import { isDomRuntime } from './isDomRuntime'
+
+/**
+ * Writes data to the buffer.
+ *
+ * Записывает данные в буфер.
+ * @param text text for recording/ текст для записи
+ */
+export async function writeClipboardData(text: string) {
+  if (isDomRuntime()) {
+    try {
+      await navigator.clipboard.writeText(text)
+    } catch (_) {
+      document?.execCommand(text)
+    }
+  }
+}

package/src/library.ts

@@ -0,0 +1,116 @@
+// Classes
+export * from './classes/Api'
+export * from './classes/ApiDefault'
+export * from './classes/ApiHeaders'
+export * from './classes/ApiPreparation'
+export * from './classes/ApiResponse'
+export * from './classes/ApiStatus'
+export * from './classes/BroadcastMessage'
+export * from './classes/Cache'
+export * from './classes/CacheItem'
+export * from './classes/CacheStatic'
+export * from './classes/Cookie'
+export * from './classes/CookieBlock'
+export * from './classes/DataStorage'
+export * from './classes/Datetime'
+export * from './classes/EventItem'
+export * from './classes/Geo'
+export * from './classes/GeoFlag'
+export * from './classes/GeoIntl'
+export * from './classes/GeoPhone'
+export * from './classes/Global'
+export * from './classes/Hash'
+export * from './classes/Icons'
+export * from './classes/Loading'
+export * from './classes/Meta'
+export * from './classes/MetaManager'
+export * from './classes/MetaOg'
+export * from './classes/MetaTwitter'
+export * from './classes/ScrollbarWidth'
+export * from './classes/Translate'
+
+// Composables
+
+// Functions
+export * from './functions/anyToString'
+export * from './functions/applyTemplate'
+export * from './functions/arrFill'
+export * from './functions/copyObject'
+export * from './functions/createElement'
+export * from './functions/domQuerySelector'
+export * from './functions/domQuerySelectorAll'
+export * from './functions/encodeAttribute'
+export * from './functions/eventStopPropagation'
+export * from './functions/executeFunction'
+export * from './functions/executePromise'
+export * from './functions/forEach'
+export * from './functions/frame'
+export * from './functions/getAttributes'
+export * from './functions/getClipboardData'
+export * from './functions/getColumn'
+export * from './functions/getElement'
+export * from './functions/getElementId'
+export * from './functions/getElementItem'
+export * from './functions/getElementOrWindow'
+export * from './functions/getExp'
+export * from './functions/getItemByPath'
+export * from './functions/getKey'
+export * from './functions/getLengthOfAllArray'
+export * from './functions/getMaxLengthAllArray'
+export * from './functions/getMinLengthAllArray'
+export * from './functions/getMouseClient'
+export * from './functions/getMouseClientX'
+export * from './functions/getMouseClientY'
+export * from './functions/getObjectByKeys'
+export * from './functions/getObjectNoUndefined'
+export * from './functions/getObjectOrNone'
+export * from './functions/getRandomText'
+export * from './functions/getRequestString'
+export * from './functions/getStepPercent'
+export * from './functions/getStepValue'
+export * from './functions/goScroll'
+export * from './functions/inArray'
+export * from './functions/initScrollbarOffset'
+export * from './functions/intersectKey'
+export * from './functions/isArray'
+export * from './functions/isDifferent'
+export * from './functions/isDomRuntime'
+export * from './functions/isFilled'
+export * from './functions/isFloat'
+export * from './functions/isFunction'
+export * from './functions/isInDom'
+export * from './functions/isIntegerBetween'
+export * from './functions/isNull'
+export * from './functions/isNumber'
+export * from './functions/isObject'
+export * from './functions/isObjectNotArray'
+export * from './functions/isSelected'
+export * from './functions/isSelectedByList'
+export * from './functions/isString'
+export * from './functions/isWindow'
+export * from './functions/random'
+export * from './functions/replaceRecursive'
+export * from './functions/replaceTemplate'
+export * from './functions/secondToTime'
+export * from './functions/setElementItem'
+export * from './functions/setValues'
+export * from './functions/splice'
+export * from './functions/strFill'
+export * from './functions/toArray'
+export * from './functions/toCamelCase'
+export * from './functions/toCamelCaseFirst'
+export * from './functions/toDate'
+export * from './functions/toKebabCase'
+export * from './functions/toNumber'
+export * from './functions/toNumberByMax'
+export * from './functions/toPercent'
+export * from './functions/toPercentBy100'
+export * from './functions/transformation'
+export * from './functions/uniqueArray'
+export * from './functions/writeClipboardData'
+
+// Types
+export * from './types/apiTypes'
+export * from './types/basicTypes'
+export * from './types/geoTypes'
+export * from './types/metaTypes'

package/src/types/apiTypes.ts

@@ -0,0 +1,143 @@
+/**
+ * Supported HTTP methods for API requests.
+ * Поддерживаемые HTTP-методы для API-запросов.
+ */
+export enum ApiMethodItem {
+  /**
+   * HTTP GET — used to retrieve resources (no request body).
+   * HTTP GET — используется для получения ресурсов (без тела запроса).
+   */
+  get = 'GET',
+
+  /**
+   * HTTP POST — used to create resources or send data.
+   * HTTP POST — используется для создания ресурсов или отправки данных.
+   */
+  post = 'POST',
+
+  /**
+   * HTTP PUT — used to update/replace resources.
+   * HTTP PUT — используется для обновления/замены ресурсов.
+   */
+  put = 'PUT',
+
+  /**
+   * HTTP DELETE — used to delete resources.
+   * HTTP DELETE — используется для удаления ресурсов.
+   */
+  delete = 'DELETE'
+}
+
+/**
+ * Supported HTTP methods type/ Тип HTTP-методов
+ * (derived from ApiMethodItem enum)/ (получен из перечисления ApiMethodItem)
+ */
+export type ApiMethod = string & ApiMethodItem
+
+/**
+ * Options for making API requests/ Опции для выполнения API-запросов
+ */
+export type ApiFetch = {
+  /** Use base API URL/ Использовать базовый URL API */
+  api?: boolean
+
+  /** Endpoint path relative to base URL/ Путь endpoint относительно базового URL */
+  path?: string
+
+  /** Complete URL (overrides api + path)/ Полный URL (переопределяет api + path) */
+  pathFull?: string
+
+  /** HTTP method/ HTTP метод */
+  method?: ApiMethod
+
+  /** Request body data or query parameters/ Данные тела запроса или параметры запроса */
+  request?: FormData | Record<string, any> | string
+
+  /** Include authentication headers/ Включить заголовки аутентификации */
+  auth?: boolean
+
+  /** Custom headers (null = no headers)/ Пользовательские заголовки (null = без заголовков) */
+  headers?: Record<string, string> | null
+
+  /** Content-Type header value/ Значение заголовка Content-Type */
+  type?: string
+
+  /** Extract 'data' field from response/ Извлечь поле 'data' из ответа */
+  toData?: boolean
+
+  /** Use global response cache/ Использовать глобальный кеш ответов */
+  global?: boolean
+
+  /** Enable development logging/ Включить логирование разработки */
+  devMode?: boolean
+
+  /** Suppress error logging/ Подавить логирование ошибок */
+  hideError?: boolean
+
+  /** Custom response processor/ Пользовательский процессор ответа */
+  queryReturn?: (query: Response) => Promise<any>
+
+  /** Run global preparation hooks/ Запускать глобальные хуки подготовки */
+  globalPreparation?: boolean
+
+  /** Run global end hooks/ Запускать глобальные хуки завершения */
+  globalEnd?: boolean
+
+  /** Additional fetch() options/ Дополнительные опции fetch() */
+  init?: RequestInit
+}
+
+/**
+ * Mock API response descriptor/ Описание мок-ответа API
+ */
+export type ApiResponseItem = {
+  /** Path string or RegExp to match request URL/ Путь или RegExp для сопоставления URL */
+  path: string | RegExp
+  /** Expected HTTP method/ Ожидаемый HTTP метод */
+  method: ApiMethod
+  /** Expected request payload or special marker '*any'/ Ожидаемая нагрузка запроса или маркер '*any' */
+  request?: ApiFetch['request'] | '*any'
+  /** Static response or factory function/ Статический ответ или функция, возвращающая ответ */
+  response: any | ((request?: ApiFetch['request']) => any)
+  /** Disable this mock/ Отключить этот мок */
+  disable?: any
+  /** Mark as global mock/ Мок для глобального использования */
+  isForGlobal?: boolean
+  /** Simulate network lag/ Имитировать задержку */
+  lag?: any
+}
+
+/**
+ * Shape of API response data wrapper/ Структура обёртки данных ответа API
+ */
+export type ApiData<T>
+  = T
+    & {
+      /** Primary payload (optional)/ Основная полезная нагрузка (опционально) */
+      data?: T
+      /** Success flag/ Флаг успешности */
+      success?: boolean
+    }
+
+/**
+ * Result of global preparation/end hooks/ Результат глобальных хуков
+ */
+export type ApiPreparationEnd = {
+  /** Reset flag to indicate state reset/ Флаг сброса состояния */
+  reset?: boolean
+  /** Arbitrary data returned by hook/ Произвольные данные, возвращаемые хуком */
+  data?: any
+}
+
+/**
+ * Default API request data type/ Тип данных запроса API по умолчанию
+ */
+export type ApiDefaultValue = Record<string, any>
+
+export type ApiStatusItem = {
+  status?: number
+  statusText?: string
+  error?: string
+  lastResponse?: any
+  lastMessage?: string
+}