@bcc-code/payment-client 1.0.1

package/README.md

@@ -0,0 +1,51 @@
+# @bcc-code/payment-client
+
+Client SDK for BCC Payment Orchestrator API
+
+## Installation
+
+```bash
+pnpm add @bcc-code/payment-client
+# or
+npm install @bcc-code/payment-client
+```
+
+## Usage
+
+```typescript
+import { PaymentClient } from '@bcc-code/payment-client'
+
+const client = new PaymentClient({
+  baseUrl: 'http://localhost:3200',
+  tenantId: 'your-tenant-uuid',
+  getAuthToken: async () => {
+    // Implement your BCC Auth0 token retrieval
+    return await getBccAuthToken()
+  }
+})
+
+// Create a payment
+const payment = await client.createPayment({
+  amount: 99.99,
+  currency: 'EUR',
+  paymentMethodType: 'stripe',
+  returnUrl: 'https://yourapp.com/success',
+  lineItems: [
+    {
+      name: 'Product Name',
+      unitPrice: 99.99,
+      quantity: 1
+    }
+  ]
+})
+
+// Get payment status
+const status = await client.getPayment(payment.paymentId)
+
+// Get receipt
+const receipt = await client.getReceipt(payment.paymentId)
+```
+
+
+
+

package/dist/index.d.mts

@@ -0,0 +1,109 @@
+interface CreatePaymentRequest {
+    payerId?: string;
+    amount: number;
+    currency: string;
+    countryCode?: string;
+    paymentMethodType: string;
+    merchantReference?: string;
+    returnUrl: string;
+    paymentMethodDetails?: Record<string, any>;
+    person?: PersonInfoRequest;
+    lineItems?: LineItemRequest[];
+}
+interface PersonInfoRequest {
+    payerUid: string;
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    addressLine1?: string;
+    addressLine2?: string;
+    city?: string;
+    postalCode?: string;
+    country?: string;
+}
+interface LineItemRequest {
+    name: string;
+    description?: string;
+    unitPrice: number;
+    quantity: number;
+    taxPercentage?: number;
+    taxAmount?: number;
+    discountAmount?: number;
+    discountPercentage?: number;
+    productCode?: string;
+    category?: string;
+}
+interface CreatePaymentResponse {
+    paymentId: string;
+    clientData?: string;
+    clientKey?: string;
+}
+interface PaymentResponse {
+    uid: string;
+    amount: number;
+    currency: string;
+    status: string;
+    payerUid: string;
+    orgId: string;
+    createdAt: string;
+    updatedAt: string;
+    lineItems?: LineItemResponse[];
+}
+interface LineItemResponse {
+    id: string;
+    productId: string;
+    name: string;
+    description?: string;
+    unitPrice: number;
+    quantity: number;
+    taxPercentage?: number;
+    taxAmount?: number;
+    discountAmount?: number;
+    discountPercentage?: number;
+    productCode?: string;
+    category?: string;
+    createdAt: string;
+    updatedAt: string;
+    subtotal: number;
+    totalTaxAmount: number;
+    totalDiscountAmount: number;
+    total: number;
+}
+interface PaymentReceiptResponse {
+    uid: string;
+    amount: number;
+    currency: string;
+    status: string;
+    payerId?: string;
+    createdAt: string;
+    updatedAt: string;
+    lineItems?: LineItemResponse[];
+    merchantName?: string;
+    merchantContact?: string;
+    pspReference?: string;
+    buyerName?: string;
+    buyerEmail?: string;
+    taxAmount?: number;
+    discountAmount?: number;
+    amountFormatted?: string;
+}
+
+interface PaymentClientOptions {
+    baseUrl: string;
+    tenantId: string;
+    getAuthToken: () => Promise<string>;
+    timeout?: number;
+}
+
+declare class PaymentClient {
+    private baseUrl;
+    private tenantId;
+    private getAuthToken;
+    private timeout?;
+    constructor(options: PaymentClientOptions);
+    createPayment(request: CreatePaymentRequest): Promise<CreatePaymentResponse>;
+    getPayment(paymentId: string): Promise<PaymentResponse | null>;
+    getReceipt(paymentId: string): Promise<PaymentReceiptResponse | null>;
+}
+
+export { type CreatePaymentRequest, type CreatePaymentResponse, type LineItemRequest, type LineItemResponse, PaymentClient, type PaymentClientOptions, type PaymentReceiptResponse, type PaymentResponse, type PersonInfoRequest };

package/dist/index.d.ts

@@ -0,0 +1,109 @@
+interface CreatePaymentRequest {
+    payerId?: string;
+    amount: number;
+    currency: string;
+    countryCode?: string;
+    paymentMethodType: string;
+    merchantReference?: string;
+    returnUrl: string;
+    paymentMethodDetails?: Record<string, any>;
+    person?: PersonInfoRequest;
+    lineItems?: LineItemRequest[];
+}
+interface PersonInfoRequest {
+    payerUid: string;
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    addressLine1?: string;
+    addressLine2?: string;
+    city?: string;
+    postalCode?: string;
+    country?: string;
+}
+interface LineItemRequest {
+    name: string;
+    description?: string;
+    unitPrice: number;
+    quantity: number;
+    taxPercentage?: number;
+    taxAmount?: number;
+    discountAmount?: number;
+    discountPercentage?: number;
+    productCode?: string;
+    category?: string;
+}
+interface CreatePaymentResponse {
+    paymentId: string;
+    clientData?: string;
+    clientKey?: string;
+}
+interface PaymentResponse {
+    uid: string;
+    amount: number;
+    currency: string;
+    status: string;
+    payerUid: string;
+    orgId: string;
+    createdAt: string;
+    updatedAt: string;
+    lineItems?: LineItemResponse[];
+}
+interface LineItemResponse {
+    id: string;
+    productId: string;
+    name: string;
+    description?: string;
+    unitPrice: number;
+    quantity: number;
+    taxPercentage?: number;
+    taxAmount?: number;
+    discountAmount?: number;
+    discountPercentage?: number;
+    productCode?: string;
+    category?: string;
+    createdAt: string;
+    updatedAt: string;
+    subtotal: number;
+    totalTaxAmount: number;
+    totalDiscountAmount: number;
+    total: number;
+}
+interface PaymentReceiptResponse {
+    uid: string;
+    amount: number;
+    currency: string;
+    status: string;
+    payerId?: string;
+    createdAt: string;
+    updatedAt: string;
+    lineItems?: LineItemResponse[];
+    merchantName?: string;
+    merchantContact?: string;
+    pspReference?: string;
+    buyerName?: string;
+    buyerEmail?: string;
+    taxAmount?: number;
+    discountAmount?: number;
+    amountFormatted?: string;
+}
+
+interface PaymentClientOptions {
+    baseUrl: string;
+    tenantId: string;
+    getAuthToken: () => Promise<string>;
+    timeout?: number;
+}
+
+declare class PaymentClient {
+    private baseUrl;
+    private tenantId;
+    private getAuthToken;
+    private timeout?;
+    constructor(options: PaymentClientOptions);
+    createPayment(request: CreatePaymentRequest): Promise<CreatePaymentResponse>;
+    getPayment(paymentId: string): Promise<PaymentResponse | null>;
+    getReceipt(paymentId: string): Promise<PaymentReceiptResponse | null>;
+}
+
+export { type CreatePaymentRequest, type CreatePaymentResponse, type LineItemRequest, type LineItemResponse, PaymentClient, type PaymentClientOptions, type PaymentReceiptResponse, type PaymentResponse, type PersonInfoRequest };

package/dist/index.js

@@ -0,0 +1,112 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  PaymentClient: () => PaymentClient
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/client/PaymentClient.ts
+var PaymentClient = class {
+  constructor(options) {
+    this.baseUrl = options.baseUrl.trim().replace(/\/$/, "");
+    this.tenantId = options.tenantId;
+    this.getAuthToken = options.getAuthToken;
+    this.timeout = options.timeout;
+  }
+  async createPayment(request) {
+    const token = await this.getAuthToken();
+    const controller = new AbortController();
+    if (this.timeout) {
+      setTimeout(() => controller.abort(), this.timeout);
+    }
+    const response = await fetch(`${this.baseUrl}/api/v1/payments`, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        "Authorization": `Bearer ${token}`,
+        "X-Tenant-ID": this.tenantId
+      },
+      body: JSON.stringify(request),
+      signal: controller.signal
+    });
+    if (!response.ok) {
+      const errorText = await response.text();
+      throw new Error(
+        `Payment API request failed: ${response.status} ${response.statusText}. ${errorText}`
+      );
+    }
+    return await response.json();
+  }
+  async getPayment(paymentId) {
+    const token = await this.getAuthToken();
+    const controller = new AbortController();
+    if (this.timeout) {
+      setTimeout(() => controller.abort(), this.timeout);
+    }
+    const response = await fetch(`${this.baseUrl}/api/v1/payments/${paymentId}`, {
+      headers: {
+        "Authorization": `Bearer ${token}`
+      },
+      signal: controller.signal
+    });
+    if (response.status === 404) {
+      return null;
+    }
+    if (!response.ok) {
+      const errorText = await response.text();
+      throw new Error(
+        `Payment API request failed: ${response.status} ${response.statusText}. ${errorText}`
+      );
+    }
+    return await response.json();
+  }
+  async getReceipt(paymentId) {
+    const token = await this.getAuthToken();
+    const controller = new AbortController();
+    if (this.timeout) {
+      setTimeout(() => controller.abort(), this.timeout);
+    }
+    const response = await fetch(
+      `${this.baseUrl}/api/v1/payments/${paymentId}/receipt`,
+      {
+        headers: {
+          "Authorization": `Bearer ${token}`
+        },
+        signal: controller.signal
+      }
+    );
+    if (response.status === 404) {
+      return null;
+    }
+    if (!response.ok) {
+      const errorText = await response.text();
+      throw new Error(
+        `Payment API request failed: ${response.status} ${response.statusText}. ${errorText}`
+      );
+    }
+    return await response.json();
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PaymentClient
+});

package/dist/index.mjs

@@ -0,0 +1,85 @@
+// src/client/PaymentClient.ts
+var PaymentClient = class {
+  constructor(options) {
+    this.baseUrl = options.baseUrl.trim().replace(/\/$/, "");
+    this.tenantId = options.tenantId;
+    this.getAuthToken = options.getAuthToken;
+    this.timeout = options.timeout;
+  }
+  async createPayment(request) {
+    const token = await this.getAuthToken();
+    const controller = new AbortController();
+    if (this.timeout) {
+      setTimeout(() => controller.abort(), this.timeout);
+    }
+    const response = await fetch(`${this.baseUrl}/api/v1/payments`, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        "Authorization": `Bearer ${token}`,
+        "X-Tenant-ID": this.tenantId
+      },
+      body: JSON.stringify(request),
+      signal: controller.signal
+    });
+    if (!response.ok) {
+      const errorText = await response.text();
+      throw new Error(
+        `Payment API request failed: ${response.status} ${response.statusText}. ${errorText}`
+      );
+    }
+    return await response.json();
+  }
+  async getPayment(paymentId) {
+    const token = await this.getAuthToken();
+    const controller = new AbortController();
+    if (this.timeout) {
+      setTimeout(() => controller.abort(), this.timeout);
+    }
+    const response = await fetch(`${this.baseUrl}/api/v1/payments/${paymentId}`, {
+      headers: {
+        "Authorization": `Bearer ${token}`
+      },
+      signal: controller.signal
+    });
+    if (response.status === 404) {
+      return null;
+    }
+    if (!response.ok) {
+      const errorText = await response.text();
+      throw new Error(
+        `Payment API request failed: ${response.status} ${response.statusText}. ${errorText}`
+      );
+    }
+    return await response.json();
+  }
+  async getReceipt(paymentId) {
+    const token = await this.getAuthToken();
+    const controller = new AbortController();
+    if (this.timeout) {
+      setTimeout(() => controller.abort(), this.timeout);
+    }
+    const response = await fetch(
+      `${this.baseUrl}/api/v1/payments/${paymentId}/receipt`,
+      {
+        headers: {
+          "Authorization": `Bearer ${token}`
+        },
+        signal: controller.signal
+      }
+    );
+    if (response.status === 404) {
+      return null;
+    }
+    if (!response.ok) {
+      const errorText = await response.text();
+      throw new Error(
+        `Payment API request failed: ${response.status} ${response.statusText}. ${errorText}`
+      );
+    }
+    return await response.json();
+  }
+};
+export {
+  PaymentClient
+};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@bcc-code/payment-client",
+  "version": "1.0.1",
+  "description": "Client SDK for BCC Payment Orchestrator API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "module": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "keywords": [
+    "payment",
+    "bcc",
+    "stripe",
+    "adyen"
+  ],
+  "author": "BCC Code",
+  "license": "MIT",
+  "dependencies": {},
+  "devDependencies": {
+    "typescript": "^5.0.0",
+    "tsup": "^8.0.0"
+  },
+  "peerDependencies": {
+    "vue": "^3.0.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch"
+  }
+}

package/src/client/PaymentClient.ts

@@ -0,0 +1,117 @@
+import type {
+  CreatePaymentRequest,
+  CreatePaymentResponse,
+  PaymentResponse,
+  PaymentReceiptResponse
+} from '../types'
+import type { PaymentClientOptions } from './PaymentClientOptions'
+
+export class PaymentClient {
+  private baseUrl: string
+  private tenantId: string
+  private getAuthToken: () => Promise<string>
+  private timeout?: number
+
+  constructor(options: PaymentClientOptions) {
+    this.baseUrl = options.baseUrl.trim().replace(/\/$/, '')
+    this.tenantId = options.tenantId
+    this.getAuthToken = options.getAuthToken
+    this.timeout = options.timeout
+  }
+
+  async createPayment(
+    request: CreatePaymentRequest
+  ): Promise<CreatePaymentResponse> {
+    const token = await this.getAuthToken()
+
+    const controller = new AbortController()
+    if (this.timeout) {
+      setTimeout(() => controller.abort(), this.timeout)
+    }
+
+    const response = await fetch(`${this.baseUrl}/api/v1/payments`, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        'Authorization': `Bearer ${token}`,
+        'X-Tenant-ID': this.tenantId
+      },
+      body: JSON.stringify(request),
+      signal: controller.signal
+    })
+
+    if (!response.ok) {
+      const errorText = await response.text()
+      throw new Error(
+        `Payment API request failed: ${response.status} ${response.statusText}. ${errorText}`
+      )
+    }
+
+    return await response.json()
+  }
+
+  async getPayment(paymentId: string): Promise<PaymentResponse | null> {
+    const token = await this.getAuthToken()
+
+    const controller = new AbortController()
+    if (this.timeout) {
+      setTimeout(() => controller.abort(), this.timeout)
+    }
+
+    const response = await fetch(`${this.baseUrl}/api/v1/payments/${paymentId}`, {
+      headers: {
+        'Authorization': `Bearer ${token}`
+      },
+      signal: controller.signal
+    })
+
+    if (response.status === 404) {
+      return null
+    }
+
+    if (!response.ok) {
+      const errorText = await response.text()
+      throw new Error(
+        `Payment API request failed: ${response.status} ${response.statusText}. ${errorText}`
+      )
+    }
+
+    return await response.json()
+  }
+
+  async getReceipt(paymentId: string): Promise<PaymentReceiptResponse | null> {
+    const token = await this.getAuthToken()
+
+    const controller = new AbortController()
+    if (this.timeout) {
+      setTimeout(() => controller.abort(), this.timeout)
+    }
+
+    const response = await fetch(
+      `${this.baseUrl}/api/v1/payments/${paymentId}/receipt`,
+      {
+        headers: {
+          'Authorization': `Bearer ${token}`
+        },
+        signal: controller.signal
+      }
+    )
+
+    if (response.status === 404) {
+      return null
+    }
+
+    if (!response.ok) {
+      const errorText = await response.text()
+      throw new Error(
+        `Payment API request failed: ${response.status} ${response.statusText}. ${errorText}`
+      )
+    }
+
+    return await response.json()
+  }
+}
+
+
+
+

package/src/client/PaymentClientOptions.ts

@@ -0,0 +1,10 @@
+export interface PaymentClientOptions {
+  baseUrl: string
+  tenantId: string
+  getAuthToken: () => Promise<string>
+  timeout?: number
+}
+
+
+
+

package/src/client/index.ts

@@ -0,0 +1,6 @@
+export { PaymentClient } from './PaymentClient'
+export type { PaymentClientOptions } from './PaymentClientOptions'
+
+
+
+

package/src/index.ts

@@ -0,0 +1,7 @@
+export { PaymentClient } from './client'
+export type { PaymentClientOptions } from './client'
+export * from './types'
+
+
+
+

package/src/types/index.ts

@@ -0,0 +1,5 @@
+export * from './payment'
+
+
+
+

package/src/types/payment.ts

@@ -0,0 +1,99 @@
+export interface CreatePaymentRequest {
+  payerId?: string
+  amount: number
+  currency: string
+  countryCode?: string
+  paymentMethodType: string
+  merchantReference?: string
+  returnUrl: string
+  paymentMethodDetails?: Record<string, any>
+  person?: PersonInfoRequest
+  lineItems?: LineItemRequest[]
+}
+
+export interface PersonInfoRequest {
+  payerUid: string
+  firstName?: string
+  lastName?: string
+  email?: string
+  addressLine1?: string
+  addressLine2?: string
+  city?: string
+  postalCode?: string
+  country?: string
+}
+
+export interface LineItemRequest {
+  name: string
+  description?: string
+  unitPrice: number
+  quantity: number
+  taxPercentage?: number
+  taxAmount?: number
+  discountAmount?: number
+  discountPercentage?: number
+  productCode?: string
+  category?: string
+}
+
+export interface CreatePaymentResponse {
+  paymentId: string
+  clientData?: string
+  clientKey?: string
+}
+
+export interface PaymentResponse {
+  uid: string
+  amount: number
+  currency: string
+  status: string
+  payerUid: string
+  orgId: string
+  createdAt: string
+  updatedAt: string
+  lineItems?: LineItemResponse[]
+}
+
+export interface LineItemResponse {
+  id: string
+  productId: string
+  name: string
+  description?: string
+  unitPrice: number
+  quantity: number
+  taxPercentage?: number
+  taxAmount?: number
+  discountAmount?: number
+  discountPercentage?: number
+  productCode?: string
+  category?: string
+  createdAt: string
+  updatedAt: string
+  subtotal: number
+  totalTaxAmount: number
+  totalDiscountAmount: number
+  total: number
+}
+
+export interface PaymentReceiptResponse {
+  uid: string
+  amount: number
+  currency: string
+  status: string
+  payerId?: string
+  createdAt: string
+  updatedAt: string
+  lineItems?: LineItemResponse[]
+  merchantName?: string
+  merchantContact?: string
+  pspReference?: string
+  buyerName?: string
+  buyerEmail?: string
+  taxAmount?: number
+  discountAmount?: number
+  amountFormatted?: string
+}
+
+
+
+

package/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "lib": ["ES2020", "DOM"],
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": false
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}
+
+
+
+