swapped-commerce-sdk 1.0.0

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "swapped-commerce-sdk",
+  "version": "1.0.0",
+  "description": "TypeScript SDK for Swapped Commerce Integration API - Functional, performant, and fully typed",
+  "type": "module",
+  "main": "src/index.ts",
+  "module": "src/index.ts",
+  "types": "src/index.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "import": "./src/index.ts",
+      "default": "./src/index.ts"
+    }
+  },
+  "scripts": {
+    "build": "bun build src/index.ts --outdir dist --target bun",
+    "test": "bun test",
+    "test:watch": "bun test --watch",
+    "test:coverage": "bun test --coverage",
+    "test:unit": "bun test tests/unit",
+    "test:integration": "bun test tests/integration",
+    "benchmark": "bun run scripts/run-benchmarks.ts",
+    "benchmark:test": "bun test benchmarks/performance.test.ts",
+    "lint": "bunx biome check src",
+    "lint:fix": "bunx biome check --write src",
+    "format": "bunx biome format --write src"
+  },
+  "keywords": [
+    "swapped",
+    "commerce",
+    "crypto",
+    "payment",
+    "gateway",
+    "cryptocurrency",
+    "bitcoin",
+    "ethereum",
+    "sdk",
+    "typescript"
+  ],
+  "author": {
+    "name": "xpriori",
+    "url": "https://github.com/phtn"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/phtn/swapped-commerce-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/phtn/swapped-commerce-sdk/issues"
+  },
+  "homepage": "https://github.com/phtn/swapped-commerce-sdk#readme",
+  "engines": {
+    "bun": ">=1.0.0"
+  }
+}

package/src/client/createClient.ts

@@ -0,0 +1,182 @@
+import type {
+  SwappedConfig,
+  RequiredSwappedConfig,
+  HttpConfig,
+  ApiResponse,
+  Order,
+  ListOrdersParams,
+  OrdersResponse,
+  RefundParams,
+  RefundResponse,
+  CreateLinkParams,
+  PaymentLinkResponse,
+  CreateRouteParams,
+  PaymentRouteResponse,
+  Payment,
+  Balance,
+  ListBalancesParams,
+  BalancesResponse,
+  GetQuoteParams,
+  QuoteResponse,
+  Payout,
+  CreatePayoutParams,
+  CreatePayoutResponse,
+  PaginationParams,
+  PayoutsResponse,
+  KYCStatusResponse,
+  SubmitKYCParams,
+  SubmitKYCResponse,
+  WebhookEvent,
+} from '../types'
+import * as ordersResource from '../resources/orders'
+import * as paymentLinksResource from '../resources/paymentLinks'
+import * as paymentRoutesResource from '../resources/paymentRoutes'
+import * as paymentsResource from '../resources/payments'
+import * as balancesResource from '../resources/balances'
+import * as quotesResource from '../resources/quotes'
+import * as payoutsResource from '../resources/payouts'
+import * as kycResource from '../resources/kyc'
+import { verifyWebhookSignature, parseWebhookEvent } from '../utils/webhooks'
+
+/**
+ * Swapped Commerce Client interface
+ */
+export interface SwappedClient {
+  readonly orders: {
+    readonly list: (
+      params?: Readonly<ListOrdersParams>
+    ) => Promise<ApiResponse<OrdersResponse>>
+    readonly get: (orderId: string) => Promise<ApiResponse<Order>>
+    readonly refund: (
+      orderId: string,
+      params: Readonly<RefundParams>
+    ) => Promise<ApiResponse<RefundResponse>>
+  }
+  readonly paymentLinks: {
+    readonly create: (
+      params: Readonly<CreateLinkParams>
+    ) => Promise<ApiResponse<PaymentLinkResponse>>
+  }
+  readonly paymentRoutes: {
+    readonly create: (
+      params: Readonly<CreateRouteParams>
+    ) => Promise<ApiResponse<PaymentRouteResponse>>
+  }
+  readonly payments: {
+    readonly get: (paymentId: string) => Promise<ApiResponse<Payment>>
+  }
+  readonly balances: {
+    readonly list: (
+      params?: Readonly<ListBalancesParams>
+    ) => Promise<ApiResponse<BalancesResponse>>
+    readonly get: (currencyId: string) => Promise<ApiResponse<Balance>>
+  }
+  readonly quotes: {
+    readonly get: (
+      params: Readonly<GetQuoteParams>
+    ) => Promise<ApiResponse<QuoteResponse>>
+  }
+  readonly payouts: {
+    readonly create: (
+      params: Readonly<CreatePayoutParams>
+    ) => Promise<ApiResponse<CreatePayoutResponse>>
+    readonly list: (
+      params?: Readonly<PaginationParams>
+    ) => Promise<ApiResponse<PayoutsResponse>>
+    readonly get: (payoutId: string) => Promise<ApiResponse<Payout>>
+  }
+  readonly kyc: {
+    readonly getStatus: (
+      customerId: string
+    ) => Promise<ApiResponse<KYCStatusResponse>>
+    readonly submit: (
+      params: Readonly<SubmitKYCParams>
+    ) => Promise<ApiResponse<SubmitKYCResponse>>
+  }
+  readonly verifyWebhookSignature: (
+    payload: string,
+    signature: string,
+    secret: string
+  ) => Promise<boolean>
+  readonly parseWebhookEvent: (payload: string) => WebhookEvent
+}
+
+/**
+ * Default configuration values
+ */
+const DEFAULT_CONFIG: Omit<RequiredSwappedConfig, 'apiKey'> = {
+  environment: 'production',
+  timeout: 30000,
+  retries: 3,
+}
+
+/**
+ * Base URL for Swapped Commerce API
+ */
+const BASE_URL = 'https://pay-api.swapped.com'
+
+/**
+ * Factory function to create a Swapped Commerce client
+ * 
+ * @param config - Client configuration
+ * @returns Swapped Commerce client instance
+ */
+export function createClient(config: SwappedConfig): SwappedClient {
+  const requiredConfig: RequiredSwappedConfig = {
+    ...DEFAULT_CONFIG,
+    ...config,
+  }
+
+  const httpConfig: HttpConfig = {
+    config: requiredConfig,
+    baseUrl: BASE_URL,
+  }
+
+  return {
+    orders: {
+      list: (params?: Readonly<ListOrdersParams>) =>
+        ordersResource.listOrders(httpConfig, params),
+      get: (orderId: string) => ordersResource.getOrder(httpConfig, orderId),
+      refund: (orderId: string, params: Readonly<RefundParams>) =>
+        ordersResource.refundOrder(httpConfig, orderId, params),
+    },
+    paymentLinks: {
+      create: (params: Readonly<CreateLinkParams>) =>
+        paymentLinksResource.createPaymentLink(httpConfig, params),
+    },
+    paymentRoutes: {
+      create: (params: Readonly<CreateRouteParams>) =>
+        paymentRoutesResource.createPaymentRoute(httpConfig, params),
+    },
+    payments: {
+      get: (paymentId: string) =>
+        paymentsResource.getPayment(httpConfig, paymentId),
+    },
+    balances: {
+      list: (params?: Readonly<ListBalancesParams>) =>
+        balancesResource.listBalances(httpConfig, params),
+      get: (currencyId: string) =>
+        balancesResource.getBalance(httpConfig, currencyId),
+    },
+    quotes: {
+      get: (params: Readonly<GetQuoteParams>) =>
+        quotesResource.getQuote(httpConfig, params),
+    },
+    payouts: {
+      create: (params: Readonly<CreatePayoutParams>) =>
+        payoutsResource.createPayout(httpConfig, params),
+      list: (params?: Readonly<PaginationParams>) =>
+        payoutsResource.listPayouts(httpConfig, params),
+      get: (payoutId: string) =>
+        payoutsResource.getPayout(httpConfig, payoutId),
+    },
+    kyc: {
+      getStatus: (customerId: string) =>
+        kycResource.getKYCStatus(httpConfig, customerId),
+      submit: (params: Readonly<SubmitKYCParams>) =>
+        kycResource.submitKYC(httpConfig, params),
+    },
+    verifyWebhookSignature,
+    parseWebhookEvent,
+  }
+}

package/src/index.ts

@@ -0,0 +1,29 @@
+/**
+ * Swapped Commerce SDK - Main Export
+ * 
+ * A performant, functional TypeScript SDK for the Swapped Commerce API.
+ * Built with Bun-native patterns, pure functions, and strict typing.
+ */
+
+// Client factory
+export { createClient } from './client/createClient'
+export type { SwappedClient } from './client/createClient'
+
+// Types
+export * from './types'
+
+// Error classes
+export {
+  SwappedError,
+  SwappedAuthenticationError,
+  SwappedValidationError,
+  SwappedRateLimitError,
+  SwappedNotFoundError,
+  createAuthenticationError,
+  createValidationError,
+  createRateLimitError,
+  createNotFoundError,
+} from './utils/errors'
+
+// Webhook utilities
+export { verifyWebhookSignature, parseWebhookEvent } from './utils/webhooks'

package/src/resources/balances.ts

@@ -0,0 +1,39 @@
+import type {
+  HttpConfig,
+  ApiResponse,
+  Balance,
+  ListBalancesParams,
+  BalancesResponse,
+} from '../types'
+import { request } from '../utils/http'
+
+/**
+ * List balances with optional filtering
+ */
+export async function listBalances(
+  httpConfig: HttpConfig,
+  params?: Readonly<ListBalancesParams>
+): Promise<ApiResponse<BalancesResponse>> {
+  return request<BalancesResponse>(
+    httpConfig.config,
+    'GET',
+    '/v1/merchants/balances',
+    {
+      params,
+    }
+  )
+}
+
+/**
+ * Get balance for a specific currency
+ */
+export async function getBalance(
+  httpConfig: HttpConfig,
+  currencyId: string
+): Promise<ApiResponse<Balance>> {
+  return request<Balance>(
+    httpConfig.config,
+    'GET',
+    `/v1/merchants/balances/${encodeURIComponent(currencyId)}`
+  )
+}

package/src/resources/kyc.ts

@@ -0,0 +1,39 @@
+import type {
+  HttpConfig,
+  ApiResponse,
+  KYCStatusResponse,
+  SubmitKYCParams,
+  SubmitKYCResponse,
+} from '../types'
+import { request } from '../utils/http'
+
+/**
+ * Get KYC status for a customer
+ */
+export async function getKYCStatus(
+  httpConfig: HttpConfig,
+  customerId: string
+): Promise<ApiResponse<KYCStatusResponse>> {
+  return request<KYCStatusResponse>(
+    httpConfig.config,
+    'GET',
+    `/v1/merchants/kyc/${encodeURIComponent(customerId)}`
+  )
+}
+
+/**
+ * Submit KYC information for a customer
+ */
+export async function submitKYC(
+  httpConfig: HttpConfig,
+  params: Readonly<SubmitKYCParams>
+): Promise<ApiResponse<SubmitKYCResponse>> {
+  return request<SubmitKYCResponse>(
+    httpConfig.config,
+    'POST',
+    '/v1/merchants/kyc',
+    {
+      body: params,
+    }
+  )
+}

package/src/resources/orders.ts

@@ -0,0 +1,54 @@
+import type {
+  HttpConfig,
+  ApiResponse,
+  Order,
+  ListOrdersParams,
+  OrdersResponse,
+  RefundParams,
+  RefundResponse,
+} from '../types'
+import { request } from '../utils/http'
+
+/**
+ * List orders with optional filtering and pagination
+ */
+export async function listOrders(
+  httpConfig: HttpConfig,
+  params?: Readonly<ListOrdersParams>
+): Promise<ApiResponse<OrdersResponse>> {
+  return request<OrdersResponse>(httpConfig.config, 'GET', '/v1/merchants/orders', {
+    params,
+  })
+}
+
+/**
+ * Get a single order by ID
+ */
+export async function getOrder(
+  httpConfig: HttpConfig,
+  orderId: string
+): Promise<ApiResponse<Order>> {
+  return request<Order>(
+    httpConfig.config,
+    'GET',
+    `/v1/merchants/orders/${encodeURIComponent(orderId)}`
+  )
+}
+
+/**
+ * Refund an order
+ */
+export async function refundOrder(
+  httpConfig: HttpConfig,
+  orderId: string,
+  params: Readonly<RefundParams>
+): Promise<ApiResponse<RefundResponse>> {
+  return request<RefundResponse>(
+    httpConfig.config,
+    'POST',
+    `/v1/merchants/orders/${encodeURIComponent(orderId)}/refund`,
+    {
+      body: params,
+    }
+  )
+}

package/src/resources/paymentLinks.ts

@@ -0,0 +1,24 @@
+import type {
+  HttpConfig,
+  ApiResponse,
+  CreateLinkParams,
+  PaymentLinkResponse,
+} from '../types'
+import { request } from '../utils/http'
+
+/**
+ * Create a payment link
+ */
+export async function createPaymentLink(
+  httpConfig: HttpConfig,
+  params: Readonly<CreateLinkParams>
+): Promise<ApiResponse<PaymentLinkResponse>> {
+  return request<PaymentLinkResponse>(
+    httpConfig.config,
+    'POST',
+    '/v1/orders',
+    {
+      body: params,
+    }
+  )
+}

package/src/resources/paymentRoutes.ts

@@ -0,0 +1,24 @@
+import type {
+  HttpConfig,
+  ApiResponse,
+  CreateRouteParams,
+  PaymentRouteResponse,
+} from '../types'
+import { request } from '../utils/http'
+
+/**
+ * Create a payment route
+ */
+export async function createPaymentRoute(
+  httpConfig: HttpConfig,
+  params: Readonly<CreateRouteParams>
+): Promise<ApiResponse<PaymentRouteResponse>> {
+  return request<PaymentRouteResponse>(
+    httpConfig.config,
+    'POST',
+    '/v1/merchants/payment-routes',
+    {
+      body: params,
+    }
+  )
+}

package/src/resources/payments.ts

@@ -0,0 +1,20 @@
+import type {
+  HttpConfig,
+  ApiResponse,
+  Payment,
+} from '../types'
+import { request } from '../utils/http'
+
+/**
+ * Get payment information by ID
+ */
+export async function getPayment(
+  httpConfig: HttpConfig,
+  paymentId: string
+): Promise<ApiResponse<Payment>> {
+  return request<Payment>(
+    httpConfig.config,
+    'GET',
+    `/v1/merchants/payments/${encodeURIComponent(paymentId)}`
+  )
+}

package/src/resources/payouts.ts

@@ -0,0 +1,58 @@
+import type {
+  HttpConfig,
+  ApiResponse,
+  Payout,
+  CreatePayoutParams,
+  CreatePayoutResponse,
+  PaginationParams,
+  PayoutsResponse,
+} from '../types'
+import { request } from '../utils/http'
+
+/**
+ * Create a payout
+ */
+export async function createPayout(
+  httpConfig: HttpConfig,
+  params: Readonly<CreatePayoutParams>
+): Promise<ApiResponse<CreatePayoutResponse>> {
+  return request<CreatePayoutResponse>(
+    httpConfig.config,
+    'POST',
+    '/v1/merchants/payouts',
+    {
+      body: params,
+    }
+  )
+}
+
+/**
+ * List payouts with pagination
+ */
+export async function listPayouts(
+  httpConfig: HttpConfig,
+  params?: Readonly<PaginationParams>
+): Promise<ApiResponse<PayoutsResponse>> {
+  return request<PayoutsResponse>(
+    httpConfig.config,
+    'GET',
+    '/v1/merchants/payouts',
+    {
+      params,
+    }
+  )
+}
+
+/**
+ * Get a single payout by ID
+ */
+export async function getPayout(
+  httpConfig: HttpConfig,
+  payoutId: string
+): Promise<ApiResponse<Payout>> {
+  return request<Payout>(
+    httpConfig.config,
+    'GET',
+    `/v1/merchants/payouts/${encodeURIComponent(payoutId)}`
+  )
+}

package/src/resources/quotes.ts

@@ -0,0 +1,24 @@
+import type {
+  HttpConfig,
+  ApiResponse,
+  GetQuoteParams,
+  QuoteResponse,
+} from '../types'
+import { request } from '../utils/http'
+
+/**
+ * Get a quote for currency conversion
+ */
+export async function getQuote(
+  httpConfig: HttpConfig,
+  params: Readonly<GetQuoteParams>
+): Promise<ApiResponse<QuoteResponse>> {
+  return request<QuoteResponse>(
+    httpConfig.config,
+    'POST',
+    '/v1/merchants/quotes',
+    {
+      body: params,
+    }
+  )
+}

package/src/types/balances.ts

@@ -0,0 +1,27 @@
+import type { Currency } from './currencies'
+
+/**
+ * Balance information
+ */
+export interface Balance {
+  readonly currency: Currency
+  readonly available: string
+  readonly pending: string
+  readonly total: string
+  readonly lastUpdated: string
+}
+
+/**
+ * Parameters for listing balances
+ */
+export interface ListBalancesParams {
+  readonly currency?: string
+  readonly blockchain?: string
+}
+
+/**
+ * Response for listing balances
+ */
+export interface BalancesResponse {
+  readonly balances: readonly Balance[]
+}

package/src/types/common.ts

@@ -0,0 +1,46 @@
+/**
+ * Core configuration types
+ */
+export interface SwappedConfig {
+  readonly apiKey: string
+  readonly environment?: 'sandbox' | 'production'
+  readonly timeout?: number
+  readonly retries?: number
+}
+
+export type RequiredSwappedConfig = Required<SwappedConfig>
+
+/**
+ * API Response wrapper
+ */
+export interface ApiResponse<T> {
+  readonly data: T
+  readonly message: string
+  readonly success: boolean
+}
+
+/**
+ * Pagination parameters
+ */
+export interface PaginationParams {
+  readonly page?: number
+  readonly limit?: number
+}
+
+/**
+ * Pagination response
+ */
+export interface PaginationResponse {
+  readonly currentPage: number
+  readonly totalPages: number
+  readonly totalItems: number
+  readonly itemsPerPage: number
+}
+
+/**
+ * HTTP configuration for resource functions
+ */
+export interface HttpConfig {
+  readonly config: RequiredSwappedConfig
+  readonly baseUrl: string
+}

package/src/types/currencies.ts

@@ -0,0 +1,26 @@
+/**
+ * Currency and blockchain types
+ */
+export type CurrencyType = 'FIAT' | 'CRYPTO'
+
+export type CurrencyFlow = 'PAYMENT' | 'SETTLEMENT' | 'BOTH'
+
+export interface Blockchain {
+  readonly id: string
+  readonly name: string
+}
+
+export interface Currency {
+  readonly id: string
+  readonly symbol: string
+  readonly name: string
+  readonly officialId: string
+  readonly type: CurrencyType
+  readonly precision: number
+  readonly flows: readonly CurrencyFlow[]
+  readonly blockchain?: Blockchain
+  readonly blockchainId?: string
+  readonly isStablecoin?: boolean
+  readonly decimals?: number
+  readonly isNative?: boolean
+}