API Client

API Client — обёртка над Axios с поддержкой фиче-флагов и возможностью отмены запросов.

Release Notes

v1.3.0

$3

- Обновлены настройки npm registry
- Добавлена интеграция @tanstack/react-query
- Добавлена pathTemplateMiddleware

v1.2.3

$3

- Добавлена поддержка динамических хэдеров

v1.2.2

$3

- Добавлен экспорт isErrorQuery и getErrorCode
- mock - добавлен NoInfer

v1.2.1

$3

- Исправлен тип mock

v1.2.0

$3

- Унифицирована конфигурация моков
- Добавлена поддержка ошибки в canceledRequestHandler
- Добавлены расширяемый тип ApiConfig и семейство вспомогательных типов
- Добавлен public static withQueries - фабричный метод для создания API клиента с системой динамического добавления запросов

v1.1.0

$3

- export default заменен на именованный экспорт
- axios - обновлен до последней версии
- BaseConfigType - исправлена типизация полей transformError, processResponseHeaders, setFeatureFlags
- IRequestOptions - добавлены поля method, areParallelRequestsPossible, isCacheDisabled, path
- compileQuery - переписан на URLSearchParams, добавлена кастомизация spaceEncoder
- private static addNewQueryParam, preventCache и getUrlTail - удалены
- private shouldMockRequest, processFeatureFlags - изменена сигнатура
- public pendingRequests - CancelTokenSource заменен на AbortController ()
- public compileUrl - больше не мержит опции с this.request и не обрабатывает isCacheDisabled
- protected getRequestOrMock - заменен на protected getRequest, теперь занимается только инициацией запроса
- public createRequest - теперь занимается сборкой и запуском middlewares
- Добавлены опция middlewares и метод getDefaultMiddlewares
- Старая логика createRequest и getRequestOrMock перенесена в *Middleware методы с небольшими изменениями:
- transformError теперь вызывается до showErrorToaster
- Отменный запрос не попадает в mapper
- areParallelRequestsPossible теперь влияет на текущий запрос, а не предыдущий (для константного значения логика не изменилась)
- isCacheDisabled теперь добавляет ключ _ (&_=123 вместо &123)

v1.0.0

$3

- Поднята версия NodeJs

v0.8.0

$3

- Расширен тип IRequestParams (IValidTypes) - boolean
- Тип RequestMethodTypes - заменен на Method (axios)

v0.7.2

$3

- Добавлен параметр requestName в метод hidePreloader

v0.7.0

$3

- Добавлено свойство shouldShowGlobalPreloader в apiClient

v0.6.0

$3

- Добавлена возможность получить полную ошибку в showErrorToaster (поле rawError в IApiClientError)

v0.5.0

$3

- Реализована возможность мока отдельного метода (поле mockedEnvironments в IRequestOptionsBase)
- Реализована возможность отмены запроса (поле signal в IRequestOptions)
- В режиме тестов добавлена попытка получить моки из mocks после попытки получить их из mockedResponses

$3

- nullToUndefined, INullToUndefined и INullableOptional перенесены в @true-engineering/true-react-platform-helpers

v0.4.0

$3

- Сохранение JSDoc в *.d.ts файлах
- Подключена библиотека @true-engineering/true-react-platform-helpers
- Удалены правила линтера, которые относятся к react
- Добавлена сортировка импортов
- Максимальное число символов в строке увеличено до 100
- Усилена типизация функции nullToUndefined. Для этого были добавлены типы INullToUndefined и INullableOptional
- Типизированы методы api-client для работы с моками. Для этого были добавлены типы ILoggedRequest и ILogs
- Исправлена типизация метода getRequestOrMock в api-client
- Реализована возможность отображения тостера при успешном завершении запроса.
Для этого были добавлены параметры shouldShowToasterOnSuccess и showSuccessToaster

$3

- Функция nullToUndef переименована в nullToUndefined
- Параметр showToaster переименован в showErrorToaster