velirapay 0.1.0 → 0.1.1

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this library are documented here. It follows [Semantic Versioning](https://semver.org).
 
+## 0.1.1 - 2026-11-12
+
+- The charges that `charges.create()`, `retrieve()`, `list()`, `iterator()`, `cancel()`, `recordRefund()`, `send()`, `accept()` and `simulate()` answer with are typed `ApiCharge`, whose `checkoutUrl` is a `string`, so `res.redirect(303, charge.checkoutUrl)` compiles under TypeScript's `strict`. Charges in webhooks and events keep `checkoutUrl: string | null`, since webhooks leave it out. Nothing changes at runtime.
+
 ## 0.1.0 - 2026-11-12
 
 The first version, covering what the PHP library covers as of its 0.6.5:

package/README.md

@@ -55,7 +55,7 @@ res.redirect(303, charge.checkoutUrl);
 
 They pay there, and VeliraPay tells your server about it with a [webhook](#verifying-webhooks). The exchange rate is locked when the charge is created, and the customer has 30 minutes to pay.
 
-Parameters are sent as the API names them, in snake_case, and objects come back with camelCase properties: `charge.checkoutUrl`, `charge.assetAmount`, `charge.customer.ipAddress`. Amounts are always strings, such as `'49.90'`, never floating-point numbers, so no precision is lost. `checkoutUrl` is typed `string | null` because the charges in webhooks leave it out; a charge the API answers with always has one.
+Parameters are sent as the API names them, in snake_case, and objects come back with camelCase properties: `charge.checkoutUrl`, `charge.assetAmount`, `charge.customer.ipAddress`. Amounts are always strings, such as `'49.90'`, never floating-point numbers, so no precision is lost. A charge the API answers with is an `ApiCharge`, whose `checkoutUrl` is always a string. Charges in webhooks leave it out, so theirs is `string | null`.
 
 With CommonJS:
 

package/dist/cjs/client.d.ts

@@ -36,7 +36,7 @@ export interface ClientOptions {
 export declare class VeliraPayClient {
     #private;
     /** The version of this library. */
-    static readonly VERSION = "0.1.0";
+    static readonly VERSION = "0.1.1";
     /** The address of the VeliraPay API. */
     static readonly DEFAULT_BASE_URL = "https://api.velirapay.com";
     /** The account the API key belongs to. */

package/dist/cjs/index.d.ts

@@ -10,7 +10,7 @@ export { Account, AccountBusiness, Address, type AccountCheckout, type AccountIn
 export { Activity } from './resources/activity.ts';
 export { ApiKey } from './resources/api-key.ts';
 export { ApiResource, type Attributes } from './resources/api-resource.ts';
-export { Charge, Customer, Refund, Transaction, type ChargeTimelineEntry, type CustomFieldAnswer } from './resources/charge.ts';
+export { Charge, Customer, Refund, Transaction, type ApiCharge, type ChargeTimelineEntry, type CustomFieldAnswer } from './resources/charge.ts';
 export { Coupon } from './resources/coupon.ts';
 export { Event } from './resources/event.ts';
 export { Invoice, InvoiceItem, type InvoiceCharge } from './resources/invoice.ts';

package/dist/cjs/resources/charge.d.ts

@@ -96,6 +96,10 @@ export declare class Charge extends ApiResource {
     /** Whether the charge can still be paid. */
     isOpen(): boolean;
 }
+/** A charge as the API answers with it, which always has its checkout page. Charges in webhooks and events stay plain charges, without one. */
+export type ApiCharge = Charge & {
+    readonly checkoutUrl: string;
+};
 /** What is known about the customer paying a charge, including the signals that help spot fraud. */
 export declare class Customer extends ApiResource {
     /** The customer's email address. */

package/dist/cjs/services/charges.d.ts

@@ -1,25 +1,25 @@
 import type { Page } from '../page.ts';
 import type { ChargeCreateParams, ChargeListParams, RefundParams, RequestOptions, SimulateParams } from '../params.ts';
-import { Charge } from '../resources/charge.ts';
+import { type ApiCharge } from '../resources/charge.ts';
 import { Service } from './service.ts';
 /** The /v1/charges endpoints. */
 export declare class ChargeService extends Service {
     /** Charge a customer: create a charge with what you already know about them, and send them to its checkoutUrl. */
-    create(params: ChargeCreateParams, options?: RequestOptions): Promise<Charge>;
+    create(params: ChargeCreateParams, options?: RequestOptions): Promise<ApiCharge>;
     /** Retrieve a charge by its id. */
-    retrieve(id: string): Promise<Charge>;
+    retrieve(id: string): Promise<ApiCharge>;
     /** List charges, newest first. */
-    list(params?: ChargeListParams): Promise<Page<Charge>>;
+    list(params?: ChargeListParams): Promise<Page<ApiCharge>>;
     /** Iterate over every charge, newest first, fetching pages as they are reached. */
-    iterator(params?: Omit<ChargeListParams, 'page'>): AsyncGenerator<Charge, void, undefined>;
+    iterator(params?: Omit<ChargeListParams, 'page'>): AsyncGenerator<ApiCharge, void, undefined>;
     /** Cancel a pending charge that no transfer has been seen for, so it can no longer be paid. */
-    cancel(id: string, options?: RequestOptions): Promise<Charge>;
+    cancel(id: string, options?: RequestOptions): Promise<ApiCharge>;
     /** Record a refund you sent the customer from your own wallet. An underpaid charge or a late payment is accepted first, and the network surcharge is never refundable. */
-    recordRefund(id: string, params: RefundParams, options?: RequestOptions): Promise<Charge>;
+    recordRefund(id: string, params: RefundParams, options?: RequestOptions): Promise<ApiCharge>;
     /** Email the customer the payment page of a pending charge. */
-    send(id: string, options?: RequestOptions): Promise<Charge>;
+    send(id: string, options?: RequestOptions): Promise<ApiCharge>;
     /** Accept an underpaid charge, or a late payment on an expired or canceled one, as paid for what arrived and confirmed. */
-    accept(id: string, options?: RequestOptions): Promise<Charge>;
+    accept(id: string, options?: RequestOptions): Promise<ApiCharge>;
     /** Pay a test-mode charge without coins, in full or by a chosen amount in the charge's coin. */
-    simulate(id: string, params?: SimulateParams, options?: RequestOptions): Promise<Charge>;
+    simulate(id: string, params?: SimulateParams, options?: RequestOptions): Promise<ApiCharge>;
 }

package/dist/cjs/services/charges.js

@@ -7,15 +7,15 @@ const service_ts_1 = require("./service.js");
 class ChargeService extends service_ts_1.Service {
     /** Charge a customer: create a charge with what you already know about them, and send them to its checkoutUrl. */
     async create(params, options) {
-        return new charge_ts_1.Charge(await this.request('POST', '/v1/charges', params, options));
+        return apiCharge(await this.request('POST', '/v1/charges', params, options));
     }
     /** Retrieve a charge by its id. */
     async retrieve(id) {
-        return new charge_ts_1.Charge(await this.request('GET', (0, service_ts_1.path)('/v1/charges/%s', id)));
+        return apiCharge(await this.request('GET', (0, service_ts_1.path)('/v1/charges/%s', id)));
     }
     /** List charges, newest first. */
     async list(params = {}) {
-        return this.page('/v1/charges', params, (charge) => new charge_ts_1.Charge(charge));
+        return this.page('/v1/charges', params, apiCharge);
     }
     /** Iterate over every charge, newest first, fetching pages as they are reached. */
     async *iterator(params = {}) {
@@ -23,23 +23,27 @@ class ChargeService extends service_ts_1.Service {
     }
     /** Cancel a pending charge that no transfer has been seen for, so it can no longer be paid. */
     async cancel(id, options) {
-        return new charge_ts_1.Charge(await this.request('POST', (0, service_ts_1.path)('/v1/charges/%s/cancel', id), undefined, options));
+        return apiCharge(await this.request('POST', (0, service_ts_1.path)('/v1/charges/%s/cancel', id), undefined, options));
     }
     /** Record a refund you sent the customer from your own wallet. An underpaid charge or a late payment is accepted first, and the network surcharge is never refundable. */
     async recordRefund(id, params, options) {
-        return new charge_ts_1.Charge(await this.request('POST', (0, service_ts_1.path)('/v1/charges/%s/refunds', id), params, options));
+        return apiCharge(await this.request('POST', (0, service_ts_1.path)('/v1/charges/%s/refunds', id), params, options));
     }
     /** Email the customer the payment page of a pending charge. */
     async send(id, options) {
-        return new charge_ts_1.Charge(await this.request('POST', (0, service_ts_1.path)('/v1/charges/%s/send', id), undefined, options));
+        return apiCharge(await this.request('POST', (0, service_ts_1.path)('/v1/charges/%s/send', id), undefined, options));
     }
     /** Accept an underpaid charge, or a late payment on an expired or canceled one, as paid for what arrived and confirmed. */
     async accept(id, options) {
-        return new charge_ts_1.Charge(await this.request('POST', (0, service_ts_1.path)('/v1/charges/%s/accept', id), undefined, options));
+        return apiCharge(await this.request('POST', (0, service_ts_1.path)('/v1/charges/%s/accept', id), undefined, options));
     }
     /** Pay a test-mode charge without coins, in full or by a chosen amount in the charge's coin. */
     async simulate(id, params = {}, options) {
-        return new charge_ts_1.Charge(await this.request('POST', (0, service_ts_1.path)('/v1/charges/%s/simulate', id), Object.keys(params).length === 0 ? undefined : params, options));
+        return apiCharge(await this.request('POST', (0, service_ts_1.path)('/v1/charges/%s/simulate', id), Object.keys(params).length === 0 ? undefined : params, options));
     }
 }
 exports.ChargeService = ChargeService;
+/** Read a charge the API answered with, which always carries its checkout page. */
+function apiCharge(attributes) {
+    return new charge_ts_1.Charge(attributes);
+}

package/dist/cjs/version.d.ts

@@ -1,2 +1,2 @@
 /** The version of this library. */
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.1.1";

package/dist/cjs/version.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 /** The version of this library. */
-exports.VERSION = '0.1.0';
+exports.VERSION = '0.1.1';

package/dist/esm/client.d.ts

@@ -36,7 +36,7 @@ export interface ClientOptions {
 export declare class VeliraPayClient {
     #private;
     /** The version of this library. */
-    static readonly VERSION = "0.1.0";
+    static readonly VERSION = "0.1.1";
     /** The address of the VeliraPay API. */
     static readonly DEFAULT_BASE_URL = "https://api.velirapay.com";
     /** The account the API key belongs to. */

package/dist/esm/index.d.ts

@@ -10,7 +10,7 @@ export { Account, AccountBusiness, Address, type AccountCheckout, type AccountIn
 export { Activity } from './resources/activity.ts';
 export { ApiKey } from './resources/api-key.ts';
 export { ApiResource, type Attributes } from './resources/api-resource.ts';
-export { Charge, Customer, Refund, Transaction, type ChargeTimelineEntry, type CustomFieldAnswer } from './resources/charge.ts';
+export { Charge, Customer, Refund, Transaction, type ApiCharge, type ChargeTimelineEntry, type CustomFieldAnswer } from './resources/charge.ts';
 export { Coupon } from './resources/coupon.ts';
 export { Event } from './resources/event.ts';
 export { Invoice, InvoiceItem, type InvoiceCharge } from './resources/invoice.ts';

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

@@ -96,6 +96,10 @@ export declare class Charge extends ApiResource {
     /** Whether the charge can still be paid. */
     isOpen(): boolean;
 }
+/** A charge as the API answers with it, which always has its checkout page. Charges in webhooks and events stay plain charges, without one. */
+export type ApiCharge = Charge & {
+    readonly checkoutUrl: string;
+};
 /** What is known about the customer paying a charge, including the signals that help spot fraud. */
 export declare class Customer extends ApiResource {
     /** The customer's email address. */

package/dist/esm/services/charges.d.ts

@@ -1,25 +1,25 @@
 import type { Page } from '../page.ts';
 import type { ChargeCreateParams, ChargeListParams, RefundParams, RequestOptions, SimulateParams } from '../params.ts';
-import { Charge } from '../resources/charge.ts';
+import { type ApiCharge } from '../resources/charge.ts';
 import { Service } from './service.ts';
 /** The /v1/charges endpoints. */
 export declare class ChargeService extends Service {
     /** Charge a customer: create a charge with what you already know about them, and send them to its checkoutUrl. */
-    create(params: ChargeCreateParams, options?: RequestOptions): Promise<Charge>;
+    create(params: ChargeCreateParams, options?: RequestOptions): Promise<ApiCharge>;
     /** Retrieve a charge by its id. */
-    retrieve(id: string): Promise<Charge>;
+    retrieve(id: string): Promise<ApiCharge>;
     /** List charges, newest first. */
-    list(params?: ChargeListParams): Promise<Page<Charge>>;
+    list(params?: ChargeListParams): Promise<Page<ApiCharge>>;
     /** Iterate over every charge, newest first, fetching pages as they are reached. */
-    iterator(params?: Omit<ChargeListParams, 'page'>): AsyncGenerator<Charge, void, undefined>;
+    iterator(params?: Omit<ChargeListParams, 'page'>): AsyncGenerator<ApiCharge, void, undefined>;
     /** Cancel a pending charge that no transfer has been seen for, so it can no longer be paid. */
-    cancel(id: string, options?: RequestOptions): Promise<Charge>;
+    cancel(id: string, options?: RequestOptions): Promise<ApiCharge>;
     /** Record a refund you sent the customer from your own wallet. An underpaid charge or a late payment is accepted first, and the network surcharge is never refundable. */
-    recordRefund(id: string, params: RefundParams, options?: RequestOptions): Promise<Charge>;
+    recordRefund(id: string, params: RefundParams, options?: RequestOptions): Promise<ApiCharge>;
     /** Email the customer the payment page of a pending charge. */
-    send(id: string, options?: RequestOptions): Promise<Charge>;
+    send(id: string, options?: RequestOptions): Promise<ApiCharge>;
     /** Accept an underpaid charge, or a late payment on an expired or canceled one, as paid for what arrived and confirmed. */
-    accept(id: string, options?: RequestOptions): Promise<Charge>;
+    accept(id: string, options?: RequestOptions): Promise<ApiCharge>;
     /** Pay a test-mode charge without coins, in full or by a chosen amount in the charge's coin. */
-    simulate(id: string, params?: SimulateParams, options?: RequestOptions): Promise<Charge>;
+    simulate(id: string, params?: SimulateParams, options?: RequestOptions): Promise<ApiCharge>;
 }

package/dist/esm/services/charges.js

@@ -4,15 +4,15 @@ import { path, Service } from './service.js';
 export class ChargeService extends Service {
     /** Charge a customer: create a charge with what you already know about them, and send them to its checkoutUrl. */
     async create(params, options) {
-        return new Charge(await this.request('POST', '/v1/charges', params, options));
+        return apiCharge(await this.request('POST', '/v1/charges', params, options));
     }
     /** Retrieve a charge by its id. */
     async retrieve(id) {
-        return new Charge(await this.request('GET', path('/v1/charges/%s', id)));
+        return apiCharge(await this.request('GET', path('/v1/charges/%s', id)));
     }
     /** List charges, newest first. */
     async list(params = {}) {
-        return this.page('/v1/charges', params, (charge) => new Charge(charge));
+        return this.page('/v1/charges', params, apiCharge);
     }
     /** Iterate over every charge, newest first, fetching pages as they are reached. */
     async *iterator(params = {}) {
@@ -20,22 +20,26 @@ export class ChargeService extends Service {
     }
     /** Cancel a pending charge that no transfer has been seen for, so it can no longer be paid. */
     async cancel(id, options) {
-        return new Charge(await this.request('POST', path('/v1/charges/%s/cancel', id), undefined, options));
+        return apiCharge(await this.request('POST', path('/v1/charges/%s/cancel', id), undefined, options));
     }
     /** Record a refund you sent the customer from your own wallet. An underpaid charge or a late payment is accepted first, and the network surcharge is never refundable. */
     async recordRefund(id, params, options) {
-        return new Charge(await this.request('POST', path('/v1/charges/%s/refunds', id), params, options));
+        return apiCharge(await this.request('POST', path('/v1/charges/%s/refunds', id), params, options));
     }
     /** Email the customer the payment page of a pending charge. */
     async send(id, options) {
-        return new Charge(await this.request('POST', path('/v1/charges/%s/send', id), undefined, options));
+        return apiCharge(await this.request('POST', path('/v1/charges/%s/send', id), undefined, options));
     }
     /** Accept an underpaid charge, or a late payment on an expired or canceled one, as paid for what arrived and confirmed. */
     async accept(id, options) {
-        return new Charge(await this.request('POST', path('/v1/charges/%s/accept', id), undefined, options));
+        return apiCharge(await this.request('POST', path('/v1/charges/%s/accept', id), undefined, options));
     }
     /** Pay a test-mode charge without coins, in full or by a chosen amount in the charge's coin. */
     async simulate(id, params = {}, options) {
-        return new Charge(await this.request('POST', path('/v1/charges/%s/simulate', id), Object.keys(params).length === 0 ? undefined : params, options));
+        return apiCharge(await this.request('POST', path('/v1/charges/%s/simulate', id), Object.keys(params).length === 0 ? undefined : params, options));
     }
 }
+/** Read a charge the API answered with, which always carries its checkout page. */
+function apiCharge(attributes) {
+    return new Charge(attributes);
+}

package/dist/esm/version.d.ts

@@ -1,2 +1,2 @@
 /** The version of this library. */
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.1.1";

package/dist/esm/version.js

@@ -1,2 +1,2 @@
 /** The version of this library. */
-export const VERSION = '0.1.0';
+export const VERSION = '0.1.1';

package/package.json

@@ -1,7 +1,7 @@
 {
     "$schema": "https://www.schemastore.org/package.json",
     "name": "velirapay",
-    "version": "0.1.0",
+    "version": "0.1.1",
     "description": "The official Node.js library for VeliraPay crypto payments: charges, payment links, invoices, payouts, events and webhook verification.",
     "keywords": [
         "velirapay",