Elastic Path Commerce Cloud TypeScript SDK

This repository is a personal TypeScript-first rewrite to the original @elasticpath/js-sdk.

This repository is currently in process and dosn't cover all Elastic Path endpoints at this time.

Use at your own risk.

Requirements

• Bun 1.3+
• Node.js 22+

Install

bun install

Available Commands

bun run lint
bun run typecheck
bun run build
bun run test
bun run check
bun run test-output
bun run playground
bun run playground:dist

bun run check runs the full pre-push verification sequence: build, lint, typecheck, and test.

To enforce that locally before every push, install the tracked Git hooks once per clone:

bun run hooks:install

Current API Surface

The starter entrypoint preserves the legacy gateway(...) shape while using a TypeScript-native implementation.

import { gateway } from '@aaronbarnaby/ep-sdk';

const client = gateway({
  client_id: process.env.EP_CLIENT_ID,
  client_secret: process.env.EP_CLIENT_SECRET,
  headers: {
    'EP-Beta-Features': 'account-management',
  },
});

const products = await client.send('/products', 'GET');
console.log(products);

Supported foundation pieces today:

• Typed gateway and client factory
• Shared request factory with auth support
• Legacy-friendly config keys such as client_id, client_secret, custom_fetch, and custom_authenticator
• Dual ESM and CJS package output
• bun:test test suite and JUnit output for CI
• CLI playground for local manual testing

Playground

The playground is a Bun CLI script intended for quick local verification outside the test suite.

bun run playground

Useful environment variables:

• EP_CLIENT_ID
• EP_CLIENT_SECRET
• EP_HOST
• EP_BETA_FEATURES

Build Output

The build is handled by tsup and emits:

• dist/index.js for ESM consumers
• dist/index.cjs for CommonJS consumers
• dist/index.d.ts for type definitions

Release

Publishing is handled with semantic-release from main and publishes to npm as @aaronbarnaby/ep-sdk.