clearbank-sdk 1.0.0

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGxD,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACrE,YAAY,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,YAAY,EACV,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,YAAY,EACZ,MAAM,EACN,IAAI,EACJ,WAAW,EACX,QAAQ,EACR,IAAI,GACL,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,YAAY,EACV,OAAO,EACP,WAAW,EACX,aAAa,EACb,cAAc,EACd,WAAW,EACX,oBAAoB,EACpB,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACnB,0BAA0B,EAC1B,0BAA0B,EAC1B,eAAe,EACf,sBAAsB,GACvB,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,YAAY,EACV,UAAU,EACV,cAAc,EACd,aAAa,EACb,iBAAiB,EACjB,sBAAsB,EACtB,eAAe,EACf,iBAAiB,EACjB,uBAAuB,EACvB,yBAAyB,EACzB,cAAc,EACd,WAAW,EACX,qBAAqB,EACrB,cAAc,EACd,gBAAgB,GACjB,MAAM,6BAA6B,CAAC;AAErC,YAAY,EAAE,cAAc,IAAI,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAE3F,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,YAAY,EACV,WAAW,EACX,eAAe,EACf,kBAAkB,EAClB,uBAAuB,EACvB,uBAAuB,EACvB,8BAA8B,EAC9B,oBAAoB,EACpB,eAAe,EACf,aAAa,EACb,aAAa,EACb,aAAa,EACb,OAAO,GACR,MAAM,kCAAkC,CAAC;AAE1C,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,YAAY,EACV,QAAQ,EACR,YAAY,EACZ,SAAS,EACT,eAAe,EACf,0BAA0B,EAC1B,8BAA8B,EAC9B,+BAA+B,EAC/B,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,mBAAmB,EACnB,sBAAsB,EACtB,0BAA0B,EAC1B,0BAA0B,EAC1B,2BAA2B,EAC3B,iBAAiB,EACjB,eAAe,EACf,mBAAmB,EACnB,eAAe,EACf,uBAAuB,EACvB,iBAAiB,EACjB,eAAe,GAChB,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,YAAY,EACV,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,sBAAsB,EACtB,gBAAgB,EAChB,WAAW,EACX,kBAAkB,EAClB,8BAA8B,EAC9B,8BAA8B,EAC9B,mBAAmB,EACnB,uBAAuB,EACvB,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,EACnB,cAAc,EACd,sBAAsB,EACtB,cAAc,EACd,cAAc,EACd,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,GAC3B,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EACL,YAAY,EACZ,MAAM,EACN,eAAe,EACf,oBAAoB,EACpB,WAAW,EACX,YAAY,GACb,MAAM,kBAAkB,CAAC;AAM1B;;;;;;;;;;;;;;GAcG;AACH,qBAAa,eAAe;IAC1B,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;IACnC,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;IACnC,QAAQ,CAAC,aAAa,EAAE,oBAAoB,CAAC;IAC7C,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,CAAC;IAC1C,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;gBAEvB,MAAM,EAAE,eAAe;IAWnC,MAAM,CAAC,iBAAiB,IAAI,MAAM;CAGnC;AAED,eAAe,eAAe,CAAC"}

package/dist/types/types/index.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Core types shared across the ClearBank SDK.
+ */
+export interface ClearBankErrorDetails {
+    readonly [key: string]: unknown;
+}
+export declare class ClearBankError extends Error {
+    readonly statusCode: number | null;
+    readonly code: string | null;
+    readonly correlationId: string | null;
+    readonly requestId: string | null;
+    readonly details: ClearBankErrorDetails | null;
+    readonly retryAfterSeconds: number | null;
+    constructor(params: {
+        message: string;
+        statusCode?: number | null;
+        code?: string | null;
+        correlationId?: string | null;
+        requestId?: string | null;
+        details?: ClearBankErrorDetails | null;
+        retryAfterSeconds?: number | null;
+    });
+    isNotFound(): boolean;
+    isConflict(): boolean;
+    isRateLimited(): boolean;
+    isUnprocessable(): boolean;
+    isRetryable(): boolean;
+    toString(): string;
+}
+export interface PaginationParams {
+    readonly pageNumber?: number;
+    readonly pageSize?: number;
+}
+export interface PaginatedResponse<T> {
+    readonly data: ReadonlyArray<T>;
+    readonly totalCount: number;
+    readonly pageNumber: number;
+    readonly pageSize: number;
+}
+export interface DateRangeParams extends PaginationParams {
+    readonly startDate?: string;
+    readonly endDate?: string;
+}
+/** ISO 4217 currency code, e.g. "GBP", "EUR", "USD" */
+export type CurrencyCode = string;
+/** Decimal string representing a monetary amount, e.g. "1000.00" */
+export type Amount = string;
+/** UUID v4 string */
+export type UUID = string;
+/** ISO 8601 datetime string */
+export type ISODateTime = string;
+/** UK sort code — 6 digits, no dashes, e.g. "040004" */
+export type SortCode = string;
+/** UK account number — 8 digits */
+export type AccountNumber = string;
+/** IBAN string, e.g. "GB29NWBK60161331926819" */
+export type IBAN = string;
+/** BIC/SWIFT code */
+export type BIC = string;
+export interface TelemetryEvent {
+    readonly method: string;
+    readonly url: string;
+    readonly statusCode: number | null;
+    readonly durationMs: number;
+    readonly requestId: string;
+    readonly correlationId: string | null;
+    readonly error: ClearBankError | null;
+}
+export type TelemetryHook = (event: TelemetryEvent) => void;
+export interface StructuredAddress {
+    readonly streetName?: string;
+    readonly buildingNumber?: string;
+    readonly postCode?: string;
+    readonly townName?: string;
+    readonly country: string;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACjC;AAED,qBAAa,cAAe,SAAQ,KAAK;IACvC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,QAAQ,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC/C,QAAQ,CAAC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE9B,MAAM,EAAE;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC9B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;QACvC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACnC;IAaD,UAAU,IAAI,OAAO;IAGrB,UAAU,IAAI,OAAO;IAGrB,aAAa,IAAI,OAAO;IAGxB,eAAe,IAAI,OAAO;IAG1B,WAAW,IAAI,OAAO;IAIb,QAAQ,IAAI,MAAM;CAM5B;AAMD,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,eAAgB,SAAQ,gBAAgB;IACvD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAMD,uDAAuD;AACvD,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC,oEAAoE;AACpE,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAE5B,qBAAqB;AACrB,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC;AAE1B,+BAA+B;AAC/B,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC,wDAAwD;AACxD,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B,mCAAmC;AACnC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC,iDAAiD;AACjD,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC;AAE1B,qBAAqB;AACrB,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC;AAMzB,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;AAM5D,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B"}

package/dist/types/utils/index.d.ts

@@ -0,0 +1,22 @@
+export { generateUUID } from '../core/crypto.js';
+export { HttpClient } from '../core/http.js';
+/** Returns true if a given string is a valid UUID v4 format. */
+export declare function isUUID(value: string): boolean;
+/** Returns true if a string looks like a UK sort code (6 digits). */
+export declare function isValidSortCode(value: string): boolean;
+/** Returns true if a string looks like a UK account number (8 digits). */
+export declare function isValidAccountNumber(value: string): boolean;
+/** Returns true if a string looks like a valid IBAN. */
+export declare function isValidIBAN(value: string): boolean;
+/**
+ * Formats a decimal amount string for display.
+ *
+ * @example formatAmount('1234.5', 'GBP') // '£1,234.50'
+ */
+export declare function formatAmount(amount: string, currency: string, locale?: string): string;
+/**
+ * Generates a pre-flight X-Request-Id for idempotent retries.
+ * Store this before sending — use the same ID when retrying on 5XX.
+ */
+export { HttpClient as _HttpClient } from '../core/http.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,gEAAgE;AAChE,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAE7C;AAED,qEAAqE;AACrE,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAEtD;AAED,0EAA0E;AAC1E,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAE3D;AAED,wDAAwD;AACxD,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAElD;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,SAAU,GAAG,MAAM,CAIvF;AAED;;;GAGG;AACH,OAAO,EAAE,UAAU,IAAI,WAAW,EAAE,MAAM,iBAAiB,CAAC"}

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "clearbank-sdk",
+  "version": "1.0.0",
+  "description": "Production-grade TypeScript SDK for the ClearBank UK API. Covers GBP Accounts, Payments (FPS, CHAPS, Bacs, Cheques, CoP), Multi-currency & FX, Embedded Banking, and Webhooks.",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts"
+    },
+    "./webhooks": {
+      "import": "./dist/esm/domains/webhooks/index.js",
+      "require": "./dist/cjs/domains/webhooks/index.js",
+      "types": "./dist/types/domains/webhooks/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "npm run build:esm && npm run build:cjs && npm run build:types",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:types": "tsc -p tsconfig.types.json",
+    "clean": "rimraf dist",
+    "prebuild": "npm run clean",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint src tests --ext .ts",
+    "lint:fix": "eslint src tests --ext .ts --fix",
+    "typecheck": "tsc --noEmit",
+    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "prepublishOnly": "npm run build && npm run typecheck && npm run lint && npm test",
+    "size": "size-limit"
+  },
+  "keywords": [
+    "clearbank",
+    "uk-banking",
+    "payments",
+    "fps",
+    "chaps",
+    "bacs",
+    "open-banking",
+    "embedded-banking",
+    "fintech",
+    "typescript",
+    "sdk"
+  ],
+  "author": "Kanishka Naik",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/iamkanishka/clearbank-sdk"
+  },
+  "bugs": {
+    "url": "https://github.com/iamkanishka/clearbank-sdk/issues"
+  },
+  "homepage": "https://github.com/iamkanishka/clearbank-sdk#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "devDependencies": {
+    "@size-limit/preset-small-lib": "^11.0.0",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^7.0.0",
+    "@typescript-eslint/parser": "^7.0.0",
+    "@vitest/coverage-v8": "^1.0.0",
+    "eslint": "^8.0.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "msw": "^2.0.0",
+    "prettier": "^3.0.0",
+    "rimraf": "^5.0.0",
+    "size-limit": "^11.0.0",
+    "typescript": "^5.4.0",
+    "vitest": "^1.0.0"
+  },
+  "size-limit": [
+    {
+      "path": "./dist/esm/index.js",
+      "limit": "50 KB"
+    }
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}