@afriex/sdk 5.1.0 → 6.0.0

package/dist/esm/resources/transactions.js

@@ -0,0 +1,63 @@
+import { APIResource, data, path } from '../core/resource.js';
+export class Transactions extends APIResource {
+    /**
+     * Creates a deposit, withdrawal or swap.
+     *
+     * `meta.idempotencyKey` makes this safe to send again, so the SDK retries it
+     * on timeouts and server errors with the same body. If a retry gets
+     * `409 DUPLICATE_REQUEST` (a `ConflictError`), the first attempt went
+     * through: look the transaction up by `meta.reference`.
+     */
+    create(params, options) {
+        return this._client
+            .request('post', '/api/v1/transaction', {
+            body: params,
+            idempotent: true,
+            options,
+        })
+            ._thenUnwrap(data);
+    }
+    /** Lists transactions, newest first. Iterate the result with `for await` to walk every page. */
+    list(params = {}, options) {
+        return this._client.getPage('/api/v1/transaction', params, options);
+    }
+    /** Quotes a withdrawal: the rate, fee and amounts, without creating anything. */
+    quote(params, options) {
+        return this._client
+            .request('get', '/api/v1/transaction/quote', { query: params, options })
+            ._thenUnwrap(data);
+    }
+    /** Retrieves a transaction. */
+    get(transactionId, options) {
+        return this._client
+            .request('get', path `/api/v1/transaction/${transactionId}`, { options })
+            ._thenUnwrap(data);
+    }
+    /** Authorizes a transaction that is waiting for it, for example with an OTP. */
+    authorize(transactionId, params, options) {
+        return this._client
+            .request('post', path `/api/v1/transaction/${transactionId}/authorize`, { body: params, options })
+            ._thenUnwrap(data);
+    }
+    /** Sandbox only: moves a transaction to the outcome you choose. */
+    simulate(transactionId, params, options) {
+        return this._client
+            .request('post', path `/api/v1/transaction/${transactionId}/simulate`, { body: params, options })
+            ._thenUnwrap(data);
+    }
+    /** Retrieves the settlement advice for a completed transaction. */
+    getAdvice(transactionId, options) {
+        return this._client
+            .request('get', path `/api/v1/transaction/${transactionId}/advice`, { options })
+            ._thenUnwrap(data);
+    }
+    /** Submits proof of a payment into a pool account. */
+    submitPoolAccountProof(params, options) {
+        return this._client
+            .request('post', '/api/v1/transaction/pool-account', {
+            body: params,
+            options,
+        })
+            ._thenUnwrap(data);
+    }
+}

package/dist/esm/resources/webhooks.d.ts

@@ -0,0 +1,43 @@
+import type { Afriex } from '../client.js';
+import type { APIPromise } from '../core/api-promise.js';
+import { APIResource } from '../core/resource.js';
+import type { Body, Data, RequestOptions } from '../core/types.js';
+import type { webhooks } from '../generated/openapi.js';
+/** The header that carries a webhook's signature. */
+export declare const WEBHOOK_SIGNATURE_HEADER = "x-webhook-signature";
+type WebhookBody<K extends keyof webhooks> = NonNullable<webhooks[K]['post']> extends {
+    requestBody: {
+        content: {
+            'application/json': infer B;
+        };
+    };
+} ? B : never;
+/** Any event Afriex delivers. Switch on `event` to narrow it. */
+export type WebhookEvent = {
+    [K in keyof webhooks]: WebhookBody<K>;
+}[keyof webhooks];
+export type WebhookEventType = WebhookEvent['event'];
+export type CustomerWebhookEvent = WebhookBody<'customer.events'>;
+export type PaymentMethodWebhookEvent = WebhookBody<'payment_method.events'>;
+export type TransactionWebhookEvent = WebhookBody<'transaction.events'>;
+export type PoolDepositRequestWebhookEvent = WebhookBody<'pool_deposit_request.events'>;
+export type TriggerWebhookParams = Body<'triggerWebhook'>;
+export type TriggerWebhookResult = Data<'triggerWebhook'>;
+export declare class Webhooks extends APIResource {
+    #private;
+    constructor(client: Afriex, publicKey?: string);
+    /**
+     * Whether `signature` is Afriex's signature of `payload`. Pass the raw body
+     * exactly as received: a re-serialized object never matches.
+     */
+    verify(payload: string | Uint8Array, signature: string | string[] | null | undefined): boolean;
+    /**
+     * Verifies a webhook and returns its parsed event.
+     *
+     * @throws WebhookVerificationError when no public key is configured or the signature does not match.
+     */
+    verifyAndParse(payload: string | Uint8Array, signature: string | string[] | null | undefined): WebhookEvent;
+    /** Sandbox only: sends a test webhook for an event and entity to your configured URL. */
+    triggerTestWebhook(params: TriggerWebhookParams, options?: RequestOptions): APIPromise<TriggerWebhookResult>;
+}
+export {};

package/dist/esm/resources/webhooks.js

@@ -0,0 +1,49 @@
+import { createVerify } from 'node:crypto';
+import { WebhookVerificationError } from '../core/errors.js';
+import { APIResource, data } from '../core/resource.js';
+/** The header that carries a webhook's signature. */
+export const WEBHOOK_SIGNATURE_HEADER = 'x-webhook-signature';
+export class Webhooks extends APIResource {
+    #publicKey;
+    constructor(client, publicKey) {
+        super(client);
+        this.#publicKey = publicKey;
+    }
+    /**
+     * Whether `signature` is Afriex's signature of `payload`. Pass the raw body
+     * exactly as received: a re-serialized object never matches.
+     */
+    verify(payload, signature) {
+        const header = Array.isArray(signature) ? signature[0] : signature;
+        if (!this.#publicKey || !header || payload.length === 0)
+            return false;
+        try {
+            // ECDSA P-384 over SHA-256, DER-encoded then base64-encoded.
+            return createVerify('SHA256').update(payload).verify(this.#publicKey, header, 'base64');
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * Verifies a webhook and returns its parsed event.
+     *
+     * @throws WebhookVerificationError when no public key is configured or the signature does not match.
+     */
+    verifyAndParse(payload, signature) {
+        if (!this.#publicKey) {
+            throw new WebhookVerificationError('No webhook public key. Pass `webhookPublicKey` when you create the client.');
+        }
+        if (!this.verify(payload, signature)) {
+            throw new WebhookVerificationError('The webhook signature does not match its body.');
+        }
+        const text = typeof payload === 'string' ? payload : new TextDecoder().decode(payload);
+        return JSON.parse(text);
+    }
+    /** Sandbox only: sends a test webhook for an event and entity to your configured URL. */
+    triggerTestWebhook(params, options) {
+        return this._client
+            .request('post', '/api/v1/webhooks/trigger', { body: params, options })
+            ._thenUnwrap(data);
+    }
+}

package/dist/esm/version.d.ts

@@ -0,0 +1 @@
+export declare const VERSION = "6.0.0";

package/dist/esm/version.js

@@ -0,0 +1,2 @@
+// Kept equal to package.json's version by a unit test.
+export const VERSION = '6.0.0';

package/package.json

@@ -1,81 +1,65 @@
 {
   "name": "@afriex/sdk",
-  "version": "5.1.0",
-  "description": "Official TypeScript SDK for the Afriex Business API: cross-border payouts, collections, virtual accounts, exchange rates and webhooks",
-  "type": "module",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "homepage": "https://afriex-sdk-docs.vercel.app",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Afri-exchange/afriex-sdk",
-    "directory": "packages/sdk"
+  "version": "6.0.0",
+  "description": "Official TypeScript SDK for the Afriex Business API, generated from the API reference's OpenAPI spec",
+  "keywords": [
+    "afriex",
+    "payments",
+    "payouts",
+    "remittance",
+    "africa",
+    "sdk",
+    "api"
+  ],
+  "license": "MIT",
+  "homepage": "https://docs.afriex.com/sdk/introduction",
+  "bugs": {
+    "url": "https://docs.afriex.com/sdk/introduction#support",
+    "email": "support@afriex.com"
   },
-  "author": "Victory Lucky <luckyvictory54@gmail.com>",
+  "type": "module",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/cjs/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "default": "./dist/index.js"
-    }
-  },
-  "dependencies": {
-    "@afriex/customers": "4.0.0",
-    "@afriex/transactions": "3.0.0",
-    "@afriex/payment-methods": "5.0.0",
-    "@afriex/balance": "2.1.0",
-    "@afriex/core": "2.2.0",
-    "@afriex/rates": "2.0.2",
-    "@afriex/checkout": "3.1.0",
-    "@afriex/payment-batches": "1.0.0",
-    "@afriex/webhooks": "3.1.0",
-    "@afriex/media": "1.0.0",
-    "@afriex/sme-registration": "1.0.0"
-  },
-  "devDependencies": {
-    "@tanstack/intent": "^0.3.6",
-    "rimraf": "^6.1.3",
-    "typescript": "^7.0.2"
-  },
-  "peerDependencies": {
-    "typescript": ">=5.0.0"
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    },
+    "./package.json": "./package.json"
   },
   "files": [
     "dist",
     "README.md",
-    "!dist/**/*.map",
-    "skills"
+    "CHANGELOG.md"
   ],
-  "publishConfig": {
-    "access": "public"
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
   },
-  "keywords": [
-    "afriex",
-    "payments",
-    "fintech",
-    "africa",
-    "cross-border-payments",
-    "typescript",
-    "afriex-sdk",
-    "sdk",
-    "api",
-    "payments-api",
-    "api-client",
-    "money-transfer",
-    "remittance",
-    "payouts",
-    "mobile-money",
-    "bank-transfer",
-    "nigeria",
-    "kenya",
-    "ghana",
-    "nodejs",
-    "tanstack-intent"
-  ],
-  "license": "MIT",
   "scripts": {
-    "build": "tsc",
-    "type-check": "tsc --noEmit",
-    "clean": "rimraf dist tsconfig.tsbuildinfo"
+    "generate": "openapi-typescript ../../api-reference/openapi.json --root-types --root-types-no-schema-prefix -o src/generated/openapi.ts",
+    "build": "rm -rf dist && tsc -p tsconfig.build.json && tsc -p tsconfig.cjs.json && echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "check:samples": "node scripts/check-samples.mjs",
+    "check:package": "npm run build && node scripts/check-package.mjs",
+    "smoke": "npm run build && node scripts/smoke-test.mjs"
+  },
+  "devDependencies": {
+    "@types/node": "20.19.25",
+    "openapi-typescript": "7.13.0",
+    "typescript": "5.9.3",
+    "vitest": "4.0.18"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": false
   }
-}
+}

package/dist/index.d.ts

@@ -1,54 +0,0 @@
-import { AfriexClient, AfriexConfig } from "@afriex/core";
-import { CustomerService } from "@afriex/customers";
-import { TransactionService } from "@afriex/transactions";
-import { PaymentMethodService } from "@afriex/payment-methods";
-import { BalanceService } from "@afriex/balance";
-import { RateService } from "@afriex/rates";
-import { CheckoutService } from "@afriex/checkout";
-import { WebhookService } from "@afriex/webhooks";
-import { MediaService } from "@afriex/media";
-import { PaymentBatchService } from "@afriex/payment-batches";
-import { SmeRegistrationService } from "@afriex/sme-registration";
-export interface AfriexSDKConfig extends AfriexConfig {
-    webhookPublicKey?: string;
-}
-export declare class AfriexSDK extends AfriexClient {
-    readonly customers: CustomerService;
-    readonly transactions: TransactionService;
-    readonly paymentMethods: PaymentMethodService;
-    readonly paymentBatches: PaymentBatchService;
-    readonly balance: BalanceService;
-    readonly rates: RateService;
-    readonly checkout: CheckoutService;
-    readonly media: MediaService;
-    readonly smeRegistration: SmeRegistrationService;
-    readonly webhooks: WebhookService;
-    readonly webhookVerifier?: WebhookService;
-    constructor(config: AfriexSDKConfig);
-}
-export { AfriexSDK as Afriex };
-export { SDK_VERSION } from "./version.js";
-export * from "@afriex/core";
-export { CustomerService } from "@afriex/customers";
-export { TransactionService } from "@afriex/transactions";
-export { PaymentMethodService } from "@afriex/payment-methods";
-export { BalanceService } from "@afriex/balance";
-export { RateService } from "@afriex/rates";
-export { CheckoutService } from "@afriex/checkout";
-export { WebhookVerifier, WebhookService } from "@afriex/webhooks";
-export { MediaService } from "@afriex/media";
-export { PaymentBatchService } from "@afriex/payment-batches";
-export { SmeRegistrationService } from "@afriex/sme-registration";
-export type { Customer, CustomerKyc, CustomerMeta, KycDocumentType, UpdatableKycDocumentType, ReadOnlyKycDocumentType, CreateCustomerRequest, UpdateCustomerRequest, UpdateCustomerKycRequest, VerifyCustomerRequest, ListCustomersParams, CustomerListResponse, } from "@afriex/customers";
-export type { Transaction, CreateTransactionRequest, CreateWithdrawTransaction, CreateDepositTransaction, CreateSwapTransaction, TransactionAmount, TransactionAmounts, SwapAmount, AuthorizeTransactionRequest, SimulateTransactionRequest, SimulateTransactionOutcome, SettlementAdvice, SubmitPoolAccountProofRequest, PoolAccountProofSender, ListTransactionsParams, TransactionListResponse, TransactionListType, TransactionListStatus, TransactionSettlement, TransactionChannel, TransactionType, TransactionMeta, TransactionMetaResponse, TransactionFailureCode, TransactionFailureReason, } from "@afriex/transactions";
-export type { PaymentMethod, PaymentMethodBankAddress, PaymentMethodInstitution, PaymentMethodRecipient, PaymentMethodTransaction, CreatePaymentMethodRequest, CreateInstitutionPaymentMethodRequest, CreateAliasPaymentMethodRequest, CreateVirtualBankAccountPaymentMethodRequest, AliasPaymentChannel, InstitutionPaymentChannel, ListPaymentMethodsParams, PaymentMethodListResponse, PaymentMethodListChannel, PaymentMethodListStatus, PaymentMethodListCapability, VirtualAccountLabel, PaymentChannel, CreatablePaymentChannel, PaymentMethodStatus, CardBrand, CardExpiration, Institution, InstitutionListResponse, InstitutionListChannel, InstitutionCode, InstitutionCodesParams, InstitutionCodesResponse, ResolveAccountParams, ResolvedAccount, ResolveAccountResponse, GetInstitutionsParams, CryptoWallet, CryptoWalletData, CryptoWalletResponse, GetCryptoWalletParams, ListVirtualAccountsParams, CreateVirtualAccountParams, ListPoolAccountsParams, VirtualAccountListResponse, PoolAccountResponse, SimulateTransferRequest, SimulateTransferResult, } from "@afriex/payment-methods";
-export type { BalanceResponse, GetBalanceParams, TopUpParams, TopUpResponse, TopUpTransaction, TopUpTransactionType, TopUpTransactionStatus, } from "@afriex/balance";
-export type { RatesResponse, GetRatesParams } from "@afriex/rates";
-export type { CheckoutSession, CreateCheckoutSessionRequest, CreateCheckoutSessionResponse, CheckoutCustomer, CheckoutChannel, } from "@afriex/checkout";
-export type { MediaUploadType, CreateUploadUrlRequest, UploadUrl, UploadableFile, UploadFileRequest, UploadedFile, } from "@afriex/media";
-export type { PaymentBatch, PaymentBatchRequest, PaymentBatchSource, PaymentBatchFundingMethod, PaymentBatchListItem, PaymentBatchListParams, PaymentBatchListResponse, PaymentBatchInstitution, PaymentBatchAmount, PaymentBatchRecipientRequest, UpdatePaymentBatchRecipientRequest, SavedPaymentBatchRecipient, PaymentBatchRecipient, PaymentBatchRecipientListResponse, PaymentBatchOutcomes, WithdrawPaymentBatchParams, PaymentBatchSession, PaymentBatchSessionResult, PaymentBatchSessionListResponse, } from "@afriex/payment-batches";
-export type { SmeRegistration, SmeRegistrationRequest, SmeRegistrationStep, SmeRegistrationStatus, SmeRegistrationStatusResult, SmeReviewStatus, SmeBusinessType, InitiateSmeRegistrationData, ConfirmSmeRegistrationOtpData, SubmitSmeRegistrationData, } from "@afriex/sme-registration";
-export type { WebhookPayload, CustomerWebhookPayload, CustomerEventType, CustomerWebhookData, PaymentMethodWebhookPayload, PaymentMethodEventType, PaymentMethodWebhookData, TransactionWebhookPayload, TransactionEventType, TransactionWebhookData, TransactionWebhookMeta, TransactionWebhookFailureReason, TransactionWebhookStatus, CheckoutSessionWebhookPayload, CheckoutSessionEventType, CheckoutSessionWebhookData, CheckoutSessionWebhookCustomer, PoolDepositRequestWebhookPayload, PoolDepositRequestEventType, PoolDepositRejectedWebhookData, TriggerWebhookRequest, TriggerWebhookResult, TriggerWebhookResponse, WebhookEventType, TriggerableWebhookEventType, WebhookEnvelope, } from "@afriex/webhooks";
-export { WEBHOOK_SIGNATURE_HEADER } from "@afriex/webhooks";
-export { TransactionStatus, DEFAULT_TRANSACTION_TYPE, } from "@afriex/transactions";
-//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,54 +0,0 @@
-import { AfriexClient, DEFAULT_USER_AGENT, } from "@afriex/core";
-import { SDK_VERSION } from "./version.js";
-import { CustomerService } from "@afriex/customers";
-import { TransactionService } from "@afriex/transactions";
-import { PaymentMethodService } from "@afriex/payment-methods";
-import { BalanceService } from "@afriex/balance";
-import { RateService } from "@afriex/rates";
-import { CheckoutService } from "@afriex/checkout";
-import { WebhookService } from "@afriex/webhooks";
-import { MediaService } from "@afriex/media";
-import { PaymentBatchService } from "@afriex/payment-batches";
-import { SmeRegistrationService } from "@afriex/sme-registration";
-export class AfriexSDK extends AfriexClient {
-    constructor(config) {
-        super({
-            ...config,
-            userAgent: config.userAgent || `${DEFAULT_USER_AGENT}/${SDK_VERSION}`,
-        });
-        const httpClient = this.getHttpClient();
-        this.customers = new CustomerService(httpClient);
-        this.transactions = new TransactionService(httpClient);
-        this.paymentMethods = new PaymentMethodService(httpClient);
-        this.paymentBatches = new PaymentBatchService(httpClient);
-        this.balance = new BalanceService(httpClient);
-        this.rates = new RateService(httpClient);
-        this.checkout = new CheckoutService(httpClient);
-        this.media = new MediaService(httpClient);
-        this.smeRegistration = new SmeRegistrationService(httpClient);
-        this.webhooks = new WebhookService(httpClient, config.webhookPublicKey);
-        if (config.webhookPublicKey) {
-            this.webhookVerifier = this.webhooks;
-        }
-    }
-}
-// Short alias
-export { AfriexSDK as Afriex };
-export { SDK_VERSION } from "./version.js";
-// Re-export core types
-export * from "@afriex/core";
-// Re-export service classes explicitly to avoid conflicts
-export { CustomerService } from "@afriex/customers";
-export { TransactionService } from "@afriex/transactions";
-export { PaymentMethodService } from "@afriex/payment-methods";
-export { BalanceService } from "@afriex/balance";
-export { RateService } from "@afriex/rates";
-export { CheckoutService } from "@afriex/checkout";
-export { WebhookVerifier, WebhookService } from "@afriex/webhooks";
-export { MediaService } from "@afriex/media";
-export { PaymentBatchService } from "@afriex/payment-batches";
-export { SmeRegistrationService } from "@afriex/sme-registration";
-export { WEBHOOK_SIGNATURE_HEADER } from "@afriex/webhooks";
-// `TransactionStatus` is a value as well as a type, so it is exported as both.
-export { TransactionStatus, DEFAULT_TRANSACTION_TYPE, } from "@afriex/transactions";
-//# sourceMappingURL=index.js.map

package/dist/version.d.ts

@@ -1,8 +0,0 @@
-/**
- * The version of `@afriex/sdk`, sent in the `User-Agent` header.
- *
- * Kept equal to the version in package.json by `scripts/sync-sdk-version.mjs`,
- * which runs as part of `pnpm run version`. Do not edit it by hand.
- */
-export declare const SDK_VERSION = "5.1.0";
-//# sourceMappingURL=version.d.ts.map

package/dist/version.js

@@ -1,8 +0,0 @@
-/**
- * The version of `@afriex/sdk`, sent in the `User-Agent` header.
- *
- * Kept equal to the version in package.json by `scripts/sync-sdk-version.mjs`,
- * which runs as part of `pnpm run version`. Do not edit it by hand.
- */
-export const SDK_VERSION = "5.1.0";
-//# sourceMappingURL=version.js.map