JSPM

@ckreidl/katana-client

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 5
  • Score
    100M100P100Q90569F
  • License MIT

TypeScript client for the Katana MRP API

Package Exports

  • @ckreidl/katana-client

Readme

katana-client

TypeScript client for the Katana MRP REST API.

Install

npm install @ckreidl/katana-client

Usage

import { KatanaClient } from "@ckreidl/katana-client";

// Both options are optional — apiKey falls back to KATANA_API_KEY env var,
// and requestsPerSecond defaults to 1 (or KATANA_REQUESTS_PER_SECOND env var).
const client = new KatanaClient({
  apiKey: "your-api-key",
  requestsPerSecond: 5,
});

// List products
const products = await client.products.list({ name: "Widget" });

// Get a single product
const product = await client.products.get({ id: 1 });

// Create a product
const created = await client.products.create({ name: "Widget", uom: "pcs" });

// Update a product
const updated = await client.products.update({ id: 1, name: "Updated Widget" });

// Paginate through all results
for await (const page of client.paginate(client.products.list, {})) {
  console.log(page);
}

Configuration

Option Environment Variable Description Default
apiKey KATANA_API_KEY API bearer token
requestsPerSecond KATANA_REQUESTS_PER_SECOND Rate limit (requests/sec) 1

Constructor options take precedence over environment variables.

License

MIT