@dxtmisha/functional-basic 0.1.1 → 0.2.0

package/src/classes/ApiResponse.ts

@@ -1,293 +0,0 @@
-import { executeFunction } from '../functions/executeFunction'
-import { executePromise } from '../functions/executePromise'
-import { isDomRuntime } from '../functions/isDomRuntime'
-import { isFilled } from '../functions/isFilled'
-import { isFunction } from '../functions/isFunction'
-import { isObjectNotArray } from '../functions/isObjectNotArray'
-import { random } from '../functions/random'
-import { toArray } from '../functions/toArray'
-
-import { ApiDefault } from './ApiDefault'
-import { Loading } from './Loading'
-
-import {
-  type ApiFetch,
-  type ApiMethod,
-  ApiMethodItem,
-  type ApiResponseItem
-} from '../types/apiTypes'
-
-const CLASS_RESPONSE_LOADING = 'd-response-loading'
-
-export class ApiResponse {
-  /** List of first-time API requests/ Список первичных API запросов */
-  protected readonly first: ApiResponseItem[] = []
-
-  /** Cached responses/ Кешированные ответы */
-  protected readonly response: ApiResponseItem[] = []
-
-  /** Loading instance/ Экземпляр загрузки */
-  protected loading?: any
-
-  /** Developer mode flag/ Флаг режима разработчика */
-  protected devMode: boolean = false
-
-  /**
-   * Constructor
-   * @param requestDefault default request processor/ процессор запросов по умолчанию
-   */
-  constructor(
-    protected readonly requestDefault: ApiDefault
-  ) {
-  }
-
-  /**
-   * Checks if there is a global cached request, if there is, returns it.
-   *
-   * Проверяет, есть ли глобальный кешированный запрос, если есть, возвращает его.
-   * @param path link to the request/ ссылка на запрос
-   * @param method request method/ метод запроса
-   * @param request data for the request/ данные для запроса
-   * @param devMode is it developer mode/ является ли режим разработчика
-   */
-  get(
-    path: string = '',
-    method: ApiMethod,
-    request?: ApiFetch['request'],
-    devMode?: boolean
-  ): ApiResponseItem | undefined {
-    return this.response.find((item) => {
-      if (
-        !this.isDisable(item)
-        && this.isPath(item, path)
-        && method === item.method
-        && this.isFirst(item, devMode)
-        && this.isResponse(item, request)
-      ) {
-        if (this.isDevMode(devMode)) {
-          console.warn(`Response type: ${item.path}`)
-        }
-
-        this.first.push(item)
-        return true
-      }
-
-      return false
-    })
-  }
-
-  /**
-   * Returns a list of data about the emulator.
-   *
-   * Возвращает список данных об эмуляторе.
-   */
-  getList(): (ApiResponseItem & Record<string, any>)[] {
-    return this.response.filter(item => item.isForGlobal !== true)
-  }
-
-  /**
-   * Adding cached requests.
-   *
-   * Добавление кешированных запросов.
-   * @param response data for caching/ данные для кеширования
-   */
-  add(
-    response: ApiResponseItem | ApiResponseItem[]
-  ): this {
-    this.response.push(...toArray(response) as ApiResponseItem[])
-    return this
-  }
-
-  /**
-   * Sets developer mode.
-   *
-   * Устанавливает режим разработчика.
-   * @param devMode is it developer mode/ является ли режим разработчика
-   */
-  setDevMode(devMode: boolean): this {
-    this.devMode = devMode
-    return this
-  }
-
-  /**
-   * Выполнение эмулятора, если доступно
-   * @param apiFetch property of the request/ свойство запроса
-   */
-  async emulator<T>(apiFetch: ApiFetch): Promise<T | undefined> {
-    const {
-      path = '',
-      method = ApiMethodItem.get,
-      global = method === ApiMethodItem.get,
-      devMode = false
-    } = apiFetch
-
-    if (
-      global
-      || this.isDevMode(devMode)
-    ) {
-      const request: ApiFetch['request'] = this.requestDefault.request(apiFetch.request)
-      const response = this.get(path, method, request, devMode)
-
-      if (response) {
-        const read = (await this.fetch<T>(response, request))
-
-        if (this.isDevMode(devMode)) {
-          console.warn('Response data:', path, request, read)
-        }
-
-        return read
-      }
-    }
-
-    return undefined
-  }
-
-  /**
-   * Checks if the cached item is disabled.
-   *
-   * Проверяет, отключен ли кешированный элемент.
-   * @param item cached item/ кешированный элемент
-   */
-  protected isDisable(item: ApiResponseItem): boolean {
-    return Boolean(executeFunction(item?.disable))
-  }
-
-  /**
-   * Checks if the path matches the cached one.
-   *
-   * Проверяет, совпадает ли путь с кешированным.
-   * @param item cached item/ кешированный элемент
-   * @param path request path/ путь запроса
-   */
-  protected isPath(
-    item: ApiResponseItem,
-    path: string
-  ): boolean {
-    return path === item.path
-      || Boolean(
-        item.path instanceof RegExp
-        && path.match(item.path)
-      )
-  }
-
-  /**
-   * Checks if it is developer mode.
-   *
-   * Проверяет, является ли режимом разработчика.
-   * @param devMode is it developer mode/ является ли режим разработчика
-   */
-  protected isDevMode(devMode?: boolean): boolean {
-    return devMode || this.devMode
-  }
-
-  /**
-   * Checks if this is the first request.
-   *
-   * Проверяет, является ли это первым запросом.
-   * @param item cached item/ кешированный элемент
-   * @param devMode is it developer mode/ является ли режим разработчика
-   */
-  protected isFirst(
-    item: ApiResponseItem,
-    devMode?: boolean
-  ): boolean {
-    return this.first.indexOf(item) === -1
-      || this.isDevMode(devMode)
-  }
-
-  /**
-   * Checks if the request matches the cached one.
-   *
-   * Проверяет, совпадает ли запрос с кешированным.
-   * @param item cached item/ кешированный элемент
-   * @param request request data/ данные запроса
-   */
-  protected isResponse(
-    item: ApiResponseItem,
-    request?: ApiFetch['request']
-  ) {
-    const requestItem = this.requestDefault.request(item?.request)
-
-    return request === requestItem
-      || '*any' === requestItem
-      || (
-        isFilled(request)
-        && isFilled(requestItem)
-        && isObjectNotArray(request)
-        && isObjectNotArray(requestItem)
-        && !(request instanceof FormData)
-        && !(requestItem instanceof FormData)
-        && Object.values(request).length === Object.values(requestItem).length
-        && Object.entries(requestItem).reduce(
-          (accum, [key, value]) => (accum && (value === request?.[key] || value === '*any')),
-          true
-        )
-      )
-  }
-
-  /**
-   * Emulates an execution request.
-   *
-   * Эмулирует запрос выполнения.
-   * @param response Data for pre-request/ Данные для пред-запроса
-   * @param request data for the request/ данные для запроса
-   */
-  protected fetch<T>(
-    response: ApiResponseItem,
-    request?: ApiFetch['request']
-  ): Promise<T> {
-    this.startResponseLoading()
-
-    return new Promise((resolve) => {
-      executePromise(
-        isFunction(response.response)
-          ? response.response(request)
-          : response.response
-      ).then((data) => {
-        if (response?.lag) {
-          Loading.show()
-
-          setTimeout(() => {
-            this.stopResponseLoading()
-
-            resolve(data)
-            Loading.hide()
-          }, random(0, 2000))
-        } else {
-          this.stopResponseLoading()
-          resolve(data)
-        }
-      })
-    })
-  }
-
-  /**
-   * Enable loading for request emulation.
-   *
-   * Включить загрузку для эмуляции запроса.
-   */
-  protected startResponseLoading() {
-    if (this.loading) {
-      clearTimeout(this.loading)
-    }
-
-    if (isDomRuntime()) {
-      document.body.classList.add(CLASS_RESPONSE_LOADING)
-    }
-  }
-
-  /**
-   * Disable loading for request emulation.
-   *
-   * Отключить загрузку для эмуляции запроса.
-   */
-  protected stopResponseLoading() {
-    this.loading = setTimeout(() => {
-      this.loading = undefined
-
-      if (isDomRuntime()) {
-        document.body.classList.remove(CLASS_RESPONSE_LOADING)
-      }
-    }, 1200)
-  }
-}

package/src/classes/ApiStatus.ts

@@ -1,173 +0,0 @@
-import { isObjectNotArray } from '../functions/isObjectNotArray'
-import type { ApiStatusItem } from '../types/apiTypes'
-
-/**
- * API status class
- *
- * Класс статуса API
- */
-export class ApiStatus {
-  protected value?: ApiStatusItem
-
-  /**
-   * Last response data
-   *
-   * Данные последнего ответа
-   */
-  get(): ApiStatusItem {
-    return this.value as ApiStatusItem
-  }
-
-  /**
-   * Returns the execution status code.
-   *
-   * Возвращает код статуса выполнения.
-   */
-  getStatus(): number | undefined {
-    return this.get()?.status
-  }
-
-  /**
-   * Returns the execution status text.
-   *
-   * Возвращает текст статуса выполнения.
-   */
-  getStatusText(): string | undefined {
-    return this.get()?.statusText
-  }
-
-  /**
-   * Returns the script execution error.
-   *
-   * Возвращает ошибку выполнения скрипта.
-   */
-  getError(): string | undefined {
-    return this.get()?.error
-  }
-
-  /**
-   * Returns the data of the last request.
-   *
-   * Возвращает данные последнего запроса.
-   */
-  getResponse<T>(): T | undefined {
-    return this.get()?.lastResponse
-  }
-
-  /**
-   * Returns messages from the last request.
-   *
-   * Возвращает сообщения от последнего запроса.
-   */
-  getMessage(): string {
-    return this.get()?.lastMessage || ''
-  }
-
-  /**
-   * Sets the status item data.
-   *
-   * Устанавливает данные элемента статуса.
-   * @param data status item data/ данные элемента статуса
-   */
-  set(data: ApiStatusItem): this {
-    if ('status' in data) {
-      this.setValue('status', data.status)
-    }
-
-    if ('statusText' in data) {
-      this.setValue('statusText', data.statusText)
-    }
-
-    if ('error' in data) {
-      this.setValue('error', data.error)
-    }
-
-    if ('lastResponse' in data) {
-      this.setValue('lastResponse', data.lastResponse)
-    }
-
-    if ('lastMessage' in data) {
-      this.setValue('lastMessage', data.lastMessage)
-    }
-
-    return this
-  }
-
-  /**
-   * Sets the status code and optional status text.
-   *
-   * Устанавливает код статуса и необязательный текст статуса.
-   * @param status status code/ код статуса
-   * @param statusText optional status text/ необязательный текст статуса
-   */
-  setStatus(
-    status?: number,
-    statusText?: string
-  ): this {
-    this.set({
-      status,
-      statusText
-    })
-
-    return this
-  }
-
-  /**
-   * Sets the error message.
-   *
-   * Устанавливает сообщение об ошибке.
-   * @param error error message/ сообщение об ошибке
-   */
-  setError(error?: string): this {
-    this.set({ error })
-    return this
-  }
-
-  /**
-   * Sets the data of the last response.
-   *
-   * Устанавливает данные последнего ответа.
-   * @param response response data/ данные ответа
-   */
-  setLastResponse(response?: any): this {
-    if (
-      response
-      && isObjectNotArray(response)
-      && ('message' in response)
-    ) {
-      this.setLastMessage(String(response.message))
-    }
-
-    this.set({ lastResponse: response })
-    return this
-  }
-
-  /**
-   * Sets messages from the last request.
-   *
-   * Устанавливает сообщения от последнего запроса.
-   * @param message message text/ текст сообщения
-   */
-  setLastMessage(message?: string): this {
-    this.set({ lastMessage: message })
-    return this
-  }
-
-  /**
-   * Sets a specific field in the status item.
-   *
-   * Устанавливает конкретное поле в элементе статуса.
-   * @param name field name/ название поля
-   * @param value field value/ значение поля
-   */
-  protected setValue<K extends keyof ApiStatusItem>(
-    name: K,
-    value?: ApiStatusItem[K]
-  ) {
-    if (!this.value) {
-      this.value = {} as ApiStatusItem
-    }
-
-    (this.value as ApiStatusItem)[name] = value
-  }
-}

package/src/classes/BroadcastMessage.ts

@@ -1,73 +0,0 @@
-import { isDomRuntime } from '../functions/isDomRuntime'
-import { random } from '../functions/random'
-
-import { DataStorage } from './DataStorage'
-
-/**
- * A class to handle BroadcastChannel messaging.
- *
- * Класс для работы с сообщениями BroadcastChannel.
- */
-export class BroadcastMessage<Message = any> {
-  protected channel?: BroadcastChannel
-
-  /**
-   * Constructor
-   * @param name channel name/ название канала
-   * @param callback callback on message received/ колбэк на получение сообщения
-   */
-  constructor(
-    name: string,
-    protected callback?: (event: MessageEvent<Message>) => void
-  ) {
-    if (isDomRuntime()) {
-      try {
-        this.channel = new BroadcastChannel(`${getBroadcastName()}__${name}`)
-        this.channel.onmessage = this.update
-      } catch (e) {
-        console.error(`BroadcastMessage ${name}:`, e)
-      }
-    }
-  }
-
-  /**
-   * Send a message to the channel.
-   *
-   * Отправить сообщение в канал.
-   * @param message message to send/ сообщение для отправки
-   */
-  post(message: Message): this {
-    this.channel?.postMessage(message)
-    return this
-  }
-
-  /**
-   * Set the callback function to be called when a message is received.
-   *
-   * Установить функцию колбэка, которая будет вызвана при получении сообщения.
-   * @param callback callback function/ функция колбэка
-   */
-  setCallback(callback: (event: MessageEvent<Message>) => void): this {
-    this.callback = callback
-    return this
-  }
-
-  /**
-   * Update state on message received.
-   *
-   * Обновление состояния при получении сообщения.
-   * @param event message event/ событие сообщения
-   */
-  protected readonly update = (event: MessageEvent<Message>): this => {
-    this.callback?.(event)
-    return this
-  }
-}
-
-/**
- * Generates a random name and saves it in local storage.
- *
- * Генерирует случайное имя и сохраняет его в локальном хранилище.
- */
-const getBroadcastName = () => new DataStorage('__broadcast-name')
-  .get(() => `name_${random(1_000_000, 9_999_999)}`)

package/src/classes/Cache.ts

@@ -1,60 +0,0 @@
-import { CacheItem } from './CacheItem'
-
-/**
- * Simple class for caching.
- *
- * Простой класс для кэширования.
- */
-export class Cache {
-  private cache: Record<string, CacheItem<any>> = {}
-
-  /**
-   * Getting data for the cache, and if there is no cache, it performs a function to save the cache.
-   *
-   * Получение данных для кэша, и если нет кэша, выполняет функцию для сохранения кэша.
-   * @param name cache name/ название кэша
-   * @param callback function for the cache/ функция для кэша
-   * @param comparison additional data for comparison/ дополнительные данные для сравнения
-   */
-  get<T>(
-    name: string,
-    callback: () => T,
-    comparison?: any[]
-  ): T {
-    return this.getCacheItem(name, callback).getCache(comparison ?? [])
-  }
-
-  /**
-   * Getting data for the cache, and if there is no cache, it performs a function to save the cache (Async).
-   *
-   * Получение данных для кэша, и если нет кэша, выполняет функцию для сохранения кэша (Async).
-   * @param name cache name/ название кэша
-   * @param callback function for the cache/ функция для кэша
-   * @param comparison additional data for comparison/ дополнительные данные для сравнения
-   */
-  async getAsync<T>(
-    name: string,
-    callback: () => T,
-    comparison?: any[]
-  ): Promise<T> {
-    return await this.getCacheItem(name, callback).getCacheAsync(comparison ?? [])
-  }
-
-  /**
-   * Returns an instance of the object for working with the cache element.
-   *
-   * Возвращает экземпляр объекта для работы с элементом кэша.
-   * @param name cache name/ название кэша
-   * @param callback function for the cache/ функция для кэша
-   */
-  private getCacheItem<T>(
-    name: string,
-    callback: () => T
-  ): CacheItem<T> {
-    if (!(name in this.cache)) {
-      this.cache[name] = new CacheItem(callback)
-    }
-
-    return this.cache[name] as CacheItem<T>
-  }
-}

package/src/classes/CacheItem.ts

@@ -1,95 +0,0 @@
-/**
- * Class for managing a single caching value.
- *
- * Класс для управления одним значением кэширования.
- */
-export class CacheItem<T> {
-  private cache?: T
-  private cacheOld?: T
-  private comparisons: any[] = []
-
-  /**
-   * Constructor
-   * @param callback function for the cache/ функция для кэша
-   */
-  constructor(
-    private readonly callback: () => T
-  ) {
-  }
-
-  /**
-   * Getting data for the cache, and if there is no cache, it performs a function to save the cache.
-   *
-   * Получение данных для кэша, и если нет кэша, выполняет функцию для сохранения кэша.
-   * @param comparison additional data for comparison/ дополнительные данные для сравнения
-   */
-  getCache(comparison: any[]): T {
-    if (this.isUpdate(comparison)) {
-      this.cacheOld = this.cache
-      this.setCache()
-    }
-
-    return this.cache as T
-  }
-
-  /**
-   * Getting the previous value of the cache.
-   *
-   * Получение предыдущего значения кэша.
-   */
-  getCacheOld(): T | undefined {
-    return this.cacheOld
-  }
-
-  /**
-   * Getting data for the cache, and if there is no cache, it performs a function to save the cache (Async).
-   *
-   * Получение данных для кэша, и если нет кэша, выполняет функцию для сохранения кэша (Async).
-   * @param comparison additional data for comparison/ дополнительные данные для сравнения
-   */
-  async getCacheAsync(comparison: any[]): Promise<T> {
-    if (this.isUpdate(comparison)) {
-      this.cacheOld = this.cache
-      await this.setCacheAsync()
-    }
-
-    return this.cache as T
-  }
-
-  /**
-   * Overwrites or adds new values for the cache.
-   *
-   * Перезаписывает или добавляет новые значения для кэша.
-   */
-  private setCache(): void {
-    this.cache = this.callback()
-  }
-
-  /**
-   * Overwrites or adds new values for the cache (Async).
-   *
-   * Перезаписывает или добавляет новые значения для кэша (Async).
-   */
-  private async setCacheAsync(): Promise<void> {
-    this.cache = await this.callback()
-  }
-
-  /**
-   * Checking additional data.
-   *
-   * Проверка дополнительных данных.
-   * @param comparison additional data for comparison/ дополнительные данные для сравнения
-   */
-  private isUpdate(comparison: any[]): boolean {
-    if (
-      this.cache === undefined
-      || this.comparisons.length !== comparison.length
-      || this.comparisons.findIndex((value, index) => value !== comparison[index]) >= 0
-    ) {
-      this.comparisons = [...comparison]
-      return true
-    }
-
-    return false
-  }
-}