@peable.to/sdk 0.4.0 → 0.4.1

package/dist/cjs/display.js

@@ -1,4 +1,13 @@
 "use strict";
+/**
+ * Read-only display values. Never use these estimates to authorize a payment.
+ *
+ * This entry is imported by every Oxy app's startup bundle (through
+ * `@oxy.so/services`), and Metro does not tree-shake: it must import nothing.
+ * `@fairco.in/core` exposes only its root barrel, which drags in the whole
+ * wallet stack, so the Explorer origin is restated here and a test pins it to
+ * the core constant.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DISPLAY_CURRENCIES = void 0;
 exports.isDisplayCurrency = isDisplayCurrency;
@@ -6,8 +15,9 @@ exports.displayRatesAreFresh = displayRatesAreFresh;
 exports.readDisplayRates = readDisplayRates;
 exports.formatDisplayUnits = formatDisplayUnits;
 exports.convertDisplayAmount = convertDisplayAmount;
-/** Read-only display values. Never use these estimates to authorize a payment. */
-const core_1 = require("@fairco.in/core");
+/** Same value as `EXPLORER_BASE_URL` in `@fairco.in/core`. */
+const DISPLAY_RATES_ORIGIN = 'https://explorer.fairco.in';
+const DISPLAY_RATES_TIMEOUT_MS = 8000;
 exports.DISPLAY_CURRENCIES = ['USD', 'EUR', 'FAIR'];
 function isDisplayCurrency(value) {
     return exports.DISPLAY_CURRENCIES.some((currency) => currency === value);
@@ -38,19 +48,45 @@ function displayRatesAreFresh(rates, now = Date.now()) {
         expires > now &&
         expires <= observed + 120000);
 }
+/**
+ * A signal that aborts after `ms` or when `parent` does. React Native's
+ * AbortSignal (Hermes) lacks `AbortSignal.timeout` and `AbortSignal.any`, which
+ * made every native read fail, so this uses only a controller and a timer.
+ */
+function timeoutSignal(ms, parent) {
+    const controller = new AbortController();
+    const onParentAbort = () => controller.abort(parent?.reason);
+    const timer = setTimeout(() => controller.abort(new Error('Exchange rate request timed out')), ms);
+    if (parent?.aborted)
+        onParentAbort();
+    else
+        parent?.addEventListener('abort', onParentAbort);
+    return {
+        signal: controller.signal,
+        dispose: () => {
+            clearTimeout(timer);
+            parent?.removeEventListener('abort', onParentAbort);
+        },
+    };
+}
 /** Uses the owning FairCoin source; no cached fallback after expiry or failure. */
 async function readDisplayRates(options = {}) {
-    const source = `${core_1.EXPLORER_BASE_URL}/api/price`;
-    const response = await (options.fetch ?? fetch)(source, {
-        signal: options.signal
-            ? AbortSignal.any([options.signal, AbortSignal.timeout(8000)])
-            : AbortSignal.timeout(8000),
-        redirect: 'error',
-        headers: { Accept: 'application/json' },
-    });
-    if (!response.ok)
-        throw new Error('Exchange rate unavailable');
-    const body = await response.json();
+    const source = `${DISPLAY_RATES_ORIGIN}/api/price`;
+    const request = timeoutSignal(DISPLAY_RATES_TIMEOUT_MS, options.signal);
+    let body;
+    try {
+        const response = await (options.fetch ?? fetch)(source, {
+            signal: request.signal,
+            redirect: 'error',
+            headers: { Accept: 'application/json' },
+        });
+        if (!response.ok)
+            throw new Error('Exchange rate unavailable');
+        body = await response.json();
+    }
+    finally {
+        request.dispose();
+    }
     if (!body || typeof body !== 'object' || !('price' in body) || !('updatedAt' in body))
         throw new Error('Exchange rate unavailable');
     const price = body.price;

package/dist/esm/display.js

@@ -1,5 +1,15 @@
-/** Read-only display values. Never use these estimates to authorize a payment. */
-import { EXPLORER_BASE_URL } from '@fairco.in/core';
+/**
+ * Read-only display values. Never use these estimates to authorize a payment.
+ *
+ * This entry is imported by every Oxy app's startup bundle (through
+ * `@oxy.so/services`), and Metro does not tree-shake: it must import nothing.
+ * `@fairco.in/core` exposes only its root barrel, which drags in the whole
+ * wallet stack, so the Explorer origin is restated here and a test pins it to
+ * the core constant.
+ */
+/** Same value as `EXPLORER_BASE_URL` in `@fairco.in/core`. */
+const DISPLAY_RATES_ORIGIN = 'https://explorer.fairco.in';
+const DISPLAY_RATES_TIMEOUT_MS = 8000;
 export const DISPLAY_CURRENCIES = ['USD', 'EUR', 'FAIR'];
 export function isDisplayCurrency(value) {
     return DISPLAY_CURRENCIES.some((currency) => currency === value);
@@ -30,19 +40,45 @@ export function displayRatesAreFresh(rates, now = Date.now()) {
         expires > now &&
         expires <= observed + 120000);
 }
+/**
+ * A signal that aborts after `ms` or when `parent` does. React Native's
+ * AbortSignal (Hermes) lacks `AbortSignal.timeout` and `AbortSignal.any`, which
+ * made every native read fail, so this uses only a controller and a timer.
+ */
+function timeoutSignal(ms, parent) {
+    const controller = new AbortController();
+    const onParentAbort = () => controller.abort(parent?.reason);
+    const timer = setTimeout(() => controller.abort(new Error('Exchange rate request timed out')), ms);
+    if (parent?.aborted)
+        onParentAbort();
+    else
+        parent?.addEventListener('abort', onParentAbort);
+    return {
+        signal: controller.signal,
+        dispose: () => {
+            clearTimeout(timer);
+            parent?.removeEventListener('abort', onParentAbort);
+        },
+    };
+}
 /** Uses the owning FairCoin source; no cached fallback after expiry or failure. */
 export async function readDisplayRates(options = {}) {
-    const source = `${EXPLORER_BASE_URL}/api/price`;
-    const response = await (options.fetch ?? fetch)(source, {
-        signal: options.signal
-            ? AbortSignal.any([options.signal, AbortSignal.timeout(8000)])
-            : AbortSignal.timeout(8000),
-        redirect: 'error',
-        headers: { Accept: 'application/json' },
-    });
-    if (!response.ok)
-        throw new Error('Exchange rate unavailable');
-    const body = await response.json();
+    const source = `${DISPLAY_RATES_ORIGIN}/api/price`;
+    const request = timeoutSignal(DISPLAY_RATES_TIMEOUT_MS, options.signal);
+    let body;
+    try {
+        const response = await (options.fetch ?? fetch)(source, {
+            signal: request.signal,
+            redirect: 'error',
+            headers: { Accept: 'application/json' },
+        });
+        if (!response.ok)
+            throw new Error('Exchange rate unavailable');
+        body = await response.json();
+    }
+    finally {
+        request.dispose();
+    }
     if (!body || typeof body !== 'object' || !('price' in body) || !('updatedAt' in body))
         throw new Error('Exchange rate unavailable');
     const price = body.price;

package/dist/types/display.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Read-only display values. Never use these estimates to authorize a payment.
+ *
+ * This entry is imported by every Oxy app's startup bundle (through
+ * `@oxy.so/services`), and Metro does not tree-shake: it must import nothing.
+ * `@fairco.in/core` exposes only its root barrel, which drags in the whole
+ * wallet stack, so the Explorer origin is restated here and a test pins it to
+ * the core constant.
+ */
 export declare const DISPLAY_CURRENCIES: readonly ["USD", "EUR", "FAIR"];
 export type DisplayCurrency = (typeof DISPLAY_CURRENCIES)[number];
 export interface DisplayRates {

package/dist/types/resources/merchants.d.ts

@@ -31,7 +31,13 @@ export interface RegisterMerchantParams {
     webhookSecret?: string;
     requiredConfirmations?: number;
     displayName?: string;
-    /** A bare Oxy file id, never a URL. */
+    /**
+     * A bare Oxy file id, never a URL. It must name an active, public or unlisted
+     * file owned by your application, by the account that owns it, or by the
+     * user your token acts for — anything else is refused with a 422 (a 503 when
+     * Oxy cannot be asked). If the file is later deleted or taken down, Peable
+     * clears it.
+     */
     avatarFileId?: string;
     description?: string;
 }
@@ -46,6 +52,7 @@ export interface UpdateMerchantParams {
     webhookSecret?: string | null;
     requiredConfirmations?: number;
     displayName?: string | null;
+    /** Same rule as {@link RegisterMerchantParams.avatarFileId}; `null` removes it. */
     avatarFileId?: string | null;
     description?: string | null;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peable.to/sdk",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Peable SDK — a Stripe-ergonomics TypeScript client over the Peable Gateway REST + realtime contract. Server entry (`@peable.to/sdk`) mints Oxy service tokens from an ApplicationCredential and exposes paymentIntents/paymentLinks/checkout.sessions/webhooks; browser entry (`@peable.to/sdk/checkout`) is the anonymous payer-side client core.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -93,10 +93,10 @@
     "@peable.to/shared-types": "0.5.0",
     "qrcode-generator": "^2.0.4",
     "socket.io-client": "^4.8.3",
-    "@peable.to/contracts": "0.1.0",
-    "@fairco.in/core": "0.5.0"
+    "@peable.to/contracts": "0.1.0"
   },
   "devDependencies": {
+    "@fairco.in/core": "0.5.0",
     "typescript": "~5.9.2",
     "@types/node": "^20.0.0",
     "@types/bun": "latest"