bitpay-rates 3.0.0 → 3.1.0

package/README.md

@@ -1,19 +1,18 @@
 # bitpay-rates
 
-![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/colkito/bitpay-rates/ci.yml?style=flat-square)
+[![CI](https://img.shields.io/github/actions/workflow/status/colkito/bitpay-rates/ci.yml?style=flat-square&label=CI)](https://github.com/colkito/bitpay-rates/actions/workflows/ci.yml)
 [![npm](https://img.shields.io/npm/v/bitpay-rates.svg?style=flat-square)](https://www.npmjs.com/package/bitpay-rates)
-[![BundlePhobia](https://img.shields.io/bundlephobia/min/bitpay-rates.svg?style=flat-square)](https://bundlephobia.com/result?p=bitpay-rates)
-[![BundlePhobia](https://img.shields.io/bundlephobia/minzip/bitpay-rates.svg?style=flat-square)](https://bundlephobia.com/result?p=bitpay-rates)
 
 A lightweight Node.js wrapper for [BitPay exchange rates](https://www.bitpay.com/exchange-rates), written in TypeScript.
 
-Zero runtime dependencies, promise-based, dual ESM + CommonJS. Talks to the
-official public [Rates API](https://developer.bitpay.com/reference/rates)
+Zero runtime dependencies, promise-based, ESM (and `require()` on Node 22.12+).
+Talks to the official public
+[Rates API](https://developer.bitpay.com/reference/rates)
 (`X-Accept-Version: 2.0.0`).
 
 ## Requirements
 
-- Node.js >= 22
+- Node.js >= 22.12
 
 ```bash
 npm install bitpay-rates
@@ -28,12 +27,15 @@ npm install bitpay-rates
   `get({ base: 'ETH', quote: 'USD' })`.
 - `get({ base })` returns the **whole table** for that base, which v2 could not
   express. `get({ quote })` returns that one rate against BTC.
-- Dual ESM + CJS with an `exports` map (`import` and `require` both work).
-- Node.js >= 22.
+- Dual ESM + CJS (the CJS file is gone in 3.1 — see below).
+- Node.js >= 22 (3.1 requires >= 22.12).
 - Requests time out after 10 seconds.
 - Currency codes are validated (`/^[A-Z0-9]{2,10}$/`); anything else rejects
   with a `TypeError` before a request is made.
 
+v3.1 ships a **single ESM file**. `require('bitpay-rates')` still works on
+Node 22.12+ (`require(esm)`). Node 22.0–22.11 need `import` or an upgrade.
+
 ## Usage
 
 ### ESM / TypeScript

package/dist/index.d.mts

@@ -42,9 +42,8 @@ export declare function get(query: {
   quote: string;
 }): Promise<RateObj>;
 /**
- * Namespace object, so both import styles work in ESM and CommonJS:
- * `import { get }` / `const { get } = require(...)`, and
- * `import bitpayRates` / `const bitpayRates = require(...)` + `bitpayRates.get()`.
+ * Namespace object, so `import bitpayRates` / `require(...)` + `.get()` works
+ * the same as the named export.
  */
 declare const _default: {
   get: typeof get;

package/dist/index.mjs

@@ -1 +1 @@
-const e=`https://bitpay.com/rates`,t=1e4,n=/^[A-Z0-9]{2,10}$/,r={"X-Accept-Version":`2.0.0`,Accept:`application/json`,"User-Agent":`bitpay-rates`};async function i(n={}){let{quote:r}=n,i=a(n.base??`BTC`,`base`),s=r===void 0,c=s?`${e}/${i}`:`${e}/${i}/${a(r,`quote`)}`,l=new AbortController,u,d=new Promise((e,n)=>{u=setTimeout(()=>{let e=Error(`Request to ${c} timed out after ${t}ms`);l.abort(e),n(e)},t)});try{return await Promise.race([o(c,l.signal,s),d])}finally{u!==void 0&&clearTimeout(u)}}function a(e,t){let r=e.toUpperCase();if(!n.test(r))throw TypeError(`Invalid ${t} currency code: ${JSON.stringify(e)}`);return r}async function o(e,t,n){let i=await fetch(e,{headers:r,signal:t}),a=await i.text(),o;try{o=JSON.parse(a)}catch(t){throw i.ok?t:Error(`Request to ${e} failed with HTTP ${i.status}`)}if(s(o)&&o.error!=null)throw Error(String(o.error));if(!i.ok)throw Error(`Request to ${e} failed with HTTP ${i.status}`);let l=s(o)?o.data:void 0;if(n){if(!Array.isArray(l)||!l.every(c))throw Error(`Unexpected response from ${e}: expected a list of rates`)}else if(!c(l))throw Error(`Unexpected response from ${e}: expected a single rate`);return l}function s(e){return typeof e==`object`&&!!e}function c(e){return s(e)&&typeof e.code==`string`&&typeof e.name==`string`&&typeof e.rate==`number`}var l={get:i};export{l as default,i as get};
+const e=`https://bitpay.com/rates`,t=1e4,n=/^[A-Z0-9]{2,10}$/,r={"X-Accept-Version":`2.0.0`,Accept:`application/json`,"User-Agent":`bitpay-rates`};async function i(n={}){let{quote:r}=n,i=a(n.base??`BTC`,`base`),c=r===void 0,l=c?`${e}/${i}`:`${e}/${i}/${a(r,`quote`)}`;try{return await o(l,AbortSignal.timeout(t),c)}catch(e){throw s(e)?Error(`Request to ${l} timed out after ${t}ms`):e}}function a(e,t){let r=e.toUpperCase();if(!n.test(r))throw TypeError(`Invalid ${t} currency code: ${JSON.stringify(e)}`);return r}async function o(e,t,n){let i=await fetch(e,{headers:r,signal:t}),a=await i.text(),o;try{o=JSON.parse(a)}catch(t){throw i.ok?t:Error(`Request to ${e} failed with HTTP ${i.status}`)}if(c(o)&&o.error!=null)throw Error(String(o.error));if(!i.ok)throw Error(`Request to ${e} failed with HTTP ${i.status}`);let s=c(o)?o.data:void 0;if(n){if(!Array.isArray(s)||!s.every(l))throw Error(`Unexpected response from ${e}: expected a list of rates`)}else if(!l(s))throw Error(`Unexpected response from ${e}: expected a single rate`);return s}function s(e){return e instanceof Error?e.name===`TimeoutError`||e.cause instanceof Error&&e.cause.name===`TimeoutError`:!1}function c(e){return typeof e==`object`&&!!e}function l(e){return c(e)&&typeof e.code==`string`&&typeof e.name==`string`&&typeof e.rate==`number`}var u={get:i};export{u as default,i as get};

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "bitpay-rates",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "A tiny Node.js wrapper for the BitPay Rates API",
   "engines": {
-    "node": ">=22"
+    "node": ">=22.12"
   },
   "keywords": [
     "bitcoin",
@@ -14,24 +14,18 @@
   ],
   "author": "colkito <dev@colkito.com>",
   "license": "MIT",
-  "type": "commonjs",
-  "main": "./dist/index.cjs",
-  "types": "./dist/index.d.cts",
+  "type": "module",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
   "exports": {
     ".": {
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
     }
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/colkito/bitpay-rates.git"
+    "url": "git+https://github.com/colkito/bitpay-rates.git"
   },
   "bugs": {
     "url": "https://github.com/colkito/bitpay-rates/issues"
@@ -58,7 +52,7 @@
   },
   "devDependencies": {
     "@biomejs/biome": "2.5.13",
-    "@types/node": "26.4.1",
+    "@types/node": "22.20.2",
     "knip": "6.35.1",
     "tsdown": "0.23.0",
     "typescript": "7.0.2"

package/dist/index.cjs

@@ -1 +0,0 @@
-Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:`Module`}});const e=`https://bitpay.com/rates`,t=1e4,n=/^[A-Z0-9]{2,10}$/,r={"X-Accept-Version":`2.0.0`,Accept:`application/json`,"User-Agent":`bitpay-rates`};async function i(n={}){let{quote:r}=n,i=a(n.base??`BTC`,`base`),s=r===void 0,c=s?`${e}/${i}`:`${e}/${i}/${a(r,`quote`)}`,l=new AbortController,u,d=new Promise((e,n)=>{u=setTimeout(()=>{let e=Error(`Request to ${c} timed out after ${t}ms`);l.abort(e),n(e)},t)});try{return await Promise.race([o(c,l.signal,s),d])}finally{u!==void 0&&clearTimeout(u)}}function a(e,t){let r=e.toUpperCase();if(!n.test(r))throw TypeError(`Invalid ${t} currency code: ${JSON.stringify(e)}`);return r}async function o(e,t,n){let i=await fetch(e,{headers:r,signal:t}),a=await i.text(),o;try{o=JSON.parse(a)}catch(t){throw i.ok?t:Error(`Request to ${e} failed with HTTP ${i.status}`)}if(s(o)&&o.error!=null)throw Error(String(o.error));if(!i.ok)throw Error(`Request to ${e} failed with HTTP ${i.status}`);let l=s(o)?o.data:void 0;if(n){if(!Array.isArray(l)||!l.every(c))throw Error(`Unexpected response from ${e}: expected a list of rates`)}else if(!c(l))throw Error(`Unexpected response from ${e}: expected a single rate`);return l}function s(e){return typeof e==`object`&&!!e}function c(e){return s(e)&&typeof e.code==`string`&&typeof e.name==`string`&&typeof e.rate==`number`}var l={get:i};exports.default=l,exports.get=i;

package/dist/index.d.cts

@@ -1,53 +0,0 @@
-//#region src/index.d.mts
-export type RateObj = {
-  code: string;
-  name: string;
-  rate: number;
-};
-export type RateResponse = RateObj | RateObj[];
-/** Arguments for {@link get}. Named so neither code can be passed in the wrong position. */
-export type RateQuery = {
-  /**
-   * Base cryptocurrency: the asset being priced.
-   *
-   * @defaultValue `'BTC'`
-   */
-  base?: string;
-  /**
-   * Quote currency: what to price `base` in. Omit for every rate against
-   * `base`.
-   */
-  quote?: string;
-};
-/**
- * Fetch BitPay exchange rates.
- *
- * @param query - `{ base, quote }`. Omit `quote` for the full table, omit both for BTC.
- * @returns Every rate for `base` when `quote` is omitted, otherwise that single {@link RateObj}.
- * @throws `TypeError` if a code is not 2-10 alphanumeric characters, before any request is made.
- *
- * @example
- * await get();                              // every rate against BTC
- * await get({ base: 'ETH' });               // every rate against ETH
- * await get({ quote: 'USD' });              // BTC/USD
- * await get({ base: 'ETH', quote: 'USD' }); // ETH/USD
- */
-export declare function get(): Promise<RateObj[]>;
-export declare function get(query: {
-  base?: string;
-  quote?: undefined;
-}): Promise<RateObj[]>;
-export declare function get(query: {
-  base?: string;
-  quote: string;
-}): Promise<RateObj>;
-/**
- * Namespace object, so both import styles work in ESM and CommonJS:
- * `import { get }` / `const { get } = require(...)`, and
- * `import bitpayRates` / `const bitpayRates = require(...)` + `bitpayRates.get()`.
- */
-declare const _default: {
-  get: typeof get;
-};
-//#endregion
-export { _default as default };