@dannychirkov/salesdrive-transport-fetch

Fetch-based HTTP transport for SalesDrive API client.

Installation

npm install @dannychirkov/salesdrive-api-client @dannychirkov/salesdrive-transport-fetch

Usage

import { createFetchTransport } from '@dannychirkov/salesdrive-transport-fetch';
import { createClient, orderService } from '@dannychirkov/salesdrive-api-client';

const transport = createFetchTransport({
  apiKey: 'your-api-key',
  baseUrl: 'https://your-account.salesdrive.me',
});

const client = createClient({
  transport,
  apiKey: 'your-api-key',
  baseUrl: 'https://your-account.salesdrive.me',
}).extend(orderService);

const orders = await client.orders.list();

Configuration

interface FetchTransportConfig {
  // SalesDrive API key (required)
  apiKey: string;

  // Base URL for the API (required)
  // Example: https://demo.salesdrive.me
  baseUrl: string;

  // Additional headers to include in requests
  headers?: Record<string, string>;

  // Custom fetch implementation
  // Useful for testing or Node.js < 18
  fetch?: typeof fetch;

  // Request timeout in milliseconds (default: 30000)
  timeout?: number;
}

With Retry Logic

For automatic retry on rate limit errors:

import { createFetchTransportWithRetry } from '@dannychirkov/salesdrive-transport-fetch';

const transport = createFetchTransportWithRetry(
  {
    apiKey: 'your-api-key',
    baseUrl: 'https://your-account.salesdrive.me',
  },
  {
    maxRetries: 3,
    retryDelay: 1000,
    retryMultiplier: 2,
  }
);

SalesDrive Rate Limits

SalesDrive API has the following rate limits:

• 10 requests per minute
• 100 requests per hour
• 1000 requests per 24 hours

When limits are exceeded, the API returns HTTP 400 with message "API limit reached. Please try again later." (not standard 429). This transport handles both cases automatically.

Recommended retry config for SalesDrive:

const transport = createFetchTransportWithRetry(
  {
    apiKey: 'your-api-key',
    baseUrl: 'https://demo.salesdrive.me',
  },
  {
    maxRetries: 3,
    retryDelay: 60000, // Wait 60 seconds (full minute window)
    retryMultiplier: 1, // Don't increase delay, just wait another minute
  }
);

Custom Fetch Implementation

import nodeFetch from 'node-fetch';

const transport = createFetchTransport({
  apiKey: 'your-api-key',
  baseUrl: 'https://your-account.salesdrive.me',
  fetch: nodeFetch as unknown as typeof fetch,
});

License

Apache License 2.0