RetailCRM Transport API Effect Client

Клиент для RetailCRM Transport API, построенный на библиотеке Effect для TypeScript. Предоставляет типобезопасный и функциональный интерфейс для работы с RetailCRM Transport API.

Особенности

• 🚀 Полная типобезопасность - все методы и сущности имеют строгие TypeScript типы
• ⚡ Функциональный подход - построен на библиотеке Effect для чистого функционального программирования
• 📦 Автогенерация - клиент генерируется из OpenAPI схемы RetailCRM
• 🔧 Гибкая настройка - поддержка кастомные HTTP клиенты и трансформации
• 🧪 Тестирование - включает end-to-end тесты для некоторых методов API

Установка

npm install @integratop/retailcrm-transport-api-effect
# или
yarn add @integratop/retailcrm-transport-api-effect
# или
pnpm add @integratop/retailcrm-transport-api-effect

Быстрый старт

Конфигурация

import { Config } from "effect";

export const RETAILCRM_TRANSPORT_ENDPOINT = Config.url("RETAILCRM_TRANSPORT_ENDPOINT");
export const RETAILCRM_TRANSPORT_TOKEN = Config.redacted("RETAILCRM_TRANSPORT_TOKEN");

Код примера в файле: config.ts.

Настройка HTTP клиента

import { HttpClient, HttpClientRequest } from "@effect/platform";
import { Effect, flow, pipe, Redacted } from "effect";
import { RETAILCRM_TRANSPORT_ENDPOINT, RETAILCRM_TRANSPORT_TOKEN } from "./config.js";

export const makeHttpClient = Effect.gen(function* () {
  const baseUrl = yield* RETAILCRM_TRANSPORT_ENDPOINT;
  const token = yield* RETAILCRM_TRANSPORT_TOKEN;
  const apiUrl = new URL("/api/transport/v1", baseUrl);

  return pipe(
    yield* HttpClient.HttpClient,
    HttpClient.mapRequest(
      flow(
        HttpClientRequest.prependUrl(apiUrl.href),
        HttpClientRequest.setHeaders({
          "X-Transport-Token": `${Redacted.value(token)}`,
          "Content-Type": "application/json",
          Accept: "application/json",
        }),
      ),
    ),
  );
});

Полный код примера с повторными попытками и RateLimiter в файле: httpClient.ts.

Настройка Effect Layer

import { NodeHttpClient } from "@effect/platform-node";
import { Layer, Logger, LogLevel } from "effect";

export const testLayer = Layer.mergeAll(
  Logger.minimumLogLevel(LogLevel.All),
  NodeHttpClient.layer,
  Layer.scope,
);

Код примера в файле: layer.ts.

Пример использования

import { make } from "@integratop/retailcrm-transport-api-effect";
import { Effect, pipe } from "effect";
import { makeHttpClient } from "./httpClient.js";
import { testLayer } from "./layer.js";

// Получение списка каналов
async function main() {
  const result = await pipe(
    Effect.gen(function* () {
      // Создание HttpClient
      const httpClient = yield* makeHttpClient;
      // Создание Transport API клиента
      const client = make(httpClient);
      // Запрос списка каналов
      return yield* client.ListChannels();
    }),
    Effect.provide(testLayer),
    Effect.runPromise,
  );

  console.log(result);
}

// Запуск примера
await main();

Код примера в файле: examples.test.ts.

Transport API

• Документация: RetailCRM Документация: Transport API
• OpenAPI Спецификация: integratop/retailcrm-transport-api-schema

Обработка ошибок

Все методы возвращают Effect, который может завершиться с ошибкой типа HttpClientError или ParseError:

pipe(
  client.ListChannels(),
  // Обработка одного типа ошибки
  Effect.catchTag("ParseError", (error) =>
    Effect.logError(`Failed to parse received data: ${error.message}`),
  ),
  // Обработка двух типов ошибок
  Effect.catchTags({
    RequestError: (error) => Effect.logError(`Failed to make request: ${error.message}`),
    ResponseError: (error) => Effect.logError(`Response error: ${error.message}`),
  }),
);

Разработка

Установка зависимостей

pnpm install

Обновление OpenAPI спецификации

Выполняется через обновление версии зависимости: @integratop/retailcrm-transport-api-schema.

Генерация клиента

pnpm src

Полная сборка

pnpm build

Тестирование

pnpm test

Лицензия

MIT License - смотрите файл LICENSE для подробностей.

Версионирование

Проект использует Semantic Versioning.

Безопасность

Если вы обнаружили уязвимость безопасности, пожалуйста, сообщите нам об этом.

Поддержка

Если у вас есть вопросы или предложения, создайте issue в GitHub репозитории.