inflow-client

Minimal HTTP client for the Inflow Inventory API. Shared client layer for inflow-get and inflow-put — handles auth and rate limiting so downstream packages don't have to.

Why use this?

• Fail-fast config - Clear errors if credentials are missing
• Dual rate limiting - Handles both per-minute (60/min) and window (1000/window) limits
• Full pagination - getAll() fetches every page with progress logging
• TypeScript native - Full type support out of the box
• Tiny footprint - No dependencies

Rate Limiting

Inflow API has two rate limits:

| Limit | Header | How we handle it | |-------|--------|------------------| | Per minute | x-inflow-api-rate-limit: N/60 | 1.2s delay between requests | | Per window (1hr sliding) | x-ratelimit-limit: N/1000 | Smart pause until requests age out |

The client tracks request timestamps and calculates optimal wait times based on when requests will age out of the 1-hour sliding window. This avoids unnecessary long pauses.

Rate Limit Configuration

Customize rate limiting behavior:

const client = createClient({
  apiKey: '...',
  companyId: '...',
  rateLimitConfig: {
    windowThreshold: 20,      // Pause when this many requests remain (default: 20)
    windowDurationMs: 3600000, // Sliding window duration in ms (default: 1 hour)
    bufferRequests: 50,       // Wait until this many requests age out (default: 50)
    onRateLimitPause: (info) => {
      console.log(`Pausing ${info.waitMs}ms, ${info.remaining} requests remaining`);
    },
  },
});

Installation

npm install inflow-client

Usage

import { createClient } from 'inflow-client';

const client = createClient({
  apiKey: process.env.INFLOW_API_KEY!,
  companyId: process.env.INFLOW_COMPANY_ID!,
});

// GET a single resource
const product = await client.get<Product>('/products/abc-123');

// GET all items (handles pagination automatically)
const allProducts = await client.getAll<Product>('/products');

// GET one by ID
const product = await client.getOne<Product>('/products', 'abc-123');

// PUT (create or update)
await client.put('/products/abc-123', { name: 'Widget', itemType: 'Inventory' });

API

// Factory (recommended)
createClient(config: InflowClientConfig): InflowClient

interface InflowClientConfig {
  apiKey: string;
  companyId: string;
  rateLimitConfig?: RateLimitConfig;
}

interface RateLimitConfig {
  windowThreshold?: number;      // Default: 20
  windowDurationMs?: number;     // Default: 3600000 (1 hour)
  bufferRequests?: number;       // Default: 50
  onRateLimitPause?: (info: RateLimitPauseInfo) => void;
}

interface RateLimitPauseInfo {
  remaining: number;
  used: number;
  max: number;
  waitMs: number;
  requestsToRecover: number;
}

interface InflowClient {
  get<T>(endpoint: string, params?: QueryParams): Promise<T>;
  getAll<T>(endpoint: string, params?: QueryParams): Promise<T[]>;
  getOne<T>(endpoint: string, id: string, params?: QueryParams): Promise<T>;
  put<T>(endpoint: string, body: unknown): Promise<T>;
}

Legacy API (deprecated)

Bare functions that read from environment variables still work for backwards compatibility:

import { get, getAll, getOne, put } from 'inflow-client';

// Requires INFLOW_API_KEY and INFLOW_COMPANY_ID env vars
const products = await getAll<Product>('/products');

License

MIT