bitpay-rates 1.2.17 → 2.0.0

package/README.md

@@ -6,7 +6,7 @@
 
 A lightweight Node.js wrapper for [BitPay's](https://bitpay.com/rates) exchange rates API, now in TypeScript.
 
-Zero-dependency, `promise` and `callback` support for easy integration into your project. ✨
+Zero-dependency and `promise` support for easy integration into your project. ✨
 
 ## Requirements
 
@@ -19,13 +19,27 @@ Getting a rate by `code`:
 ```js
 import bitpayRates from 'bitpay-rates';
 
-const code = 'ARS'; // see list of codes bellow
+const code = 'ARS'; // see list of codes below
 
-// Using promise
+// Using async/await
+try {
+  const rate = await bitpayRates.get(code);
+  console.log(`[Async/Await][${code}] Rate:`, rate);
+} catch (err) {
+  console.error(`[Async/Await][${code}] Error:`, err);
+}
+```
+
+Handling an invalid currency code:
+
+```js
+import bitpayRates from 'bitpay-rates';
+
+// Handling an invalid currency code
 bitpayRates
-  .get(code)
-  .then((rate) => console.log('Promise Rate:', rate))
-  .catch((err) => console.error('Promise Error:', err));
+  .get('INVALID')
+  .then((rate) => console.log('[Promise][INVALID] Rate:', rate))
+  .catch((err) => console.error('[Promise][INVALID] Error:', err));
 ```
 
 Successful response:
@@ -34,7 +48,7 @@ Successful response:
 {
   "code": "ARS",
   "name": "Argentine Peso",
-  "rate": 3793422.92
+  "rate": 60612542.16
 }
 ```
 
@@ -43,11 +57,19 @@ Getting `all` the rates:
 ```js
 import bitpayRates from 'bitpay-rates';
 
-// Using callback
-bitpayRates.get((err, res) => {
-  console.error('Callback Error:', err);
-  console.log('Callback Rates:', res);
-});
+// Using async/await
+try {
+  const rates = await bitpayRates.get();
+  console.log('[Async/Await] Rates:', rates);
+} catch (err) {
+  console.error('[Async/Await] Error:', err);
+}
+
+// Handling an invalid currency code
+bitpayRates
+  .get('INVALID')
+  .then((rate) => console.log('[Promise][INVALID] Rate:', rate))
+  .catch((err) => console.error('[Promise][INVALID] Error:', err));
 ```
 
 Successful response:
@@ -70,7 +92,7 @@ Successful response:
 
 More examples [here](example/rates-example.js).
 
-## Available Codes (updated: 2023-01-11)
+## Available Codes (updated: 2024-01-24)
 
 [Follow this link](CODES.md) to see the complete list of codes.
 

package/dist/index.d.ts

@@ -1 +1,11 @@
-export type RateObj={code:string;name:string;rate:number;};export type RateResponse=RateObj|[RateObj];export type Callback=(error:Error|null,data?:RateResponse)=>void;export declare const get:(code?:string|Callback,callback?:Callback)=>Promise<RateResponse>|void;declare const _default:{get:(code?:string|Callback|undefined,callback?:Callback|undefined)=>void|Promise<RateResponse>;};export default _default;
+export type RateObj = {
+    code: string;
+    name: string;
+    rate: number;
+};
+export type RateResponse = RateObj | RateObj[];
+export type Callback = (err: Error | null, data?: RateResponse) => void;
+export declare function get(code?: string): Promise<RateResponse>;
+export declare function get(code: string, cb: Callback): void;
+export declare function get(cb: Callback): void;
+export default get;

package/dist/index.js

@@ -1 +1,39 @@
-"use strict";var __importDefault=(this&&this.__importDefault)||function(mod){return(mod&&mod.__esModule)?mod:{"default":mod};};Object.defineProperty(exports,"__esModule",{value:true});exports.get=void 0;const https_1=__importDefault(require("https"));const defaultOptions={host:'bitpay.com',path:'/rates',headers:{},agent:false,};const returnPromise=(options)=>{return new Promise((resolve,reject)=>{returnCallback(options,(err,data)=>{if(err)return reject(err);return resolve(data);});});};const returnCallback=(options,callback)=>{https_1.default.get(options,(res)=>{let dataBuffer='';res.on('data',(chunk)=>{dataBuffer+=chunk.toString('utf8');});res.on('end',()=>{try{const{data}=JSON.parse(dataBuffer);return callback(null,data);}catch(err){return callback(err);}});}).on('error',(err)=>{return callback(err);});};const get=(code,callback)=>{const options={...defaultOptions};if(typeof code==='string'){options.path+=`/${code.toUpperCase()}`;}if(typeof code==='function'){return returnCallback(options,code);}else if(callback){return returnCallback(options,callback);}else{return returnPromise(options);}};exports.get=get;exports.default={get:exports.get};
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.get = get;
+const https_1 = __importDefault(require("https"));
+function get(codeOrCb, cb) {
+    const code = typeof codeOrCb === 'string' ? codeOrCb : undefined;
+    const callback = typeof codeOrCb === 'function' ? codeOrCb : cb;
+    const p = new Promise((resolve, reject) => {
+        https_1.default
+            .get(`https://bitpay.com/api/rates${code ? `/${code.toUpperCase()}` : ''}`, (res) => {
+            let d = '';
+            res.on('data', (c) => (d += c));
+            res.on('end', () => {
+                var _a;
+                try {
+                    const json = JSON.parse(d);
+                    if (json.error)
+                        reject(new Error(json.error));
+                    else
+                        resolve((_a = json.data) !== null && _a !== void 0 ? _a : json);
+                }
+                catch (e) {
+                    reject(e);
+                }
+            });
+        })
+            .on('error', reject);
+    });
+    if (callback) {
+        p.then((data) => callback(null, data)).catch((err) => callback(err));
+    }
+    else {
+        return p;
+    }
+}
+exports.default = get;

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "bitpay-rates",
-  "version": "1.2.17",
+  "version": "2.0.0",
   "description": "A tiny Node.js wrapper for the BitPay Rates API",
   "engines": {
-    "node": ">=12"
+    "node": ">=18"
   },
   "keywords": [
     "bitcoin",
@@ -28,33 +28,26 @@
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
-    "build": "tsc --declaration && tsc --removeComments && npm run minifyDeclarations && npm run minify",
+    "build": "tsc",
     "format": "prettier --write \"src/**/*.ts\"",
-    "lint": "tsc --noEmit && eslint '*/**/*.{js,ts}' --quiet --fix",
-    "minify": "jsmin -l 3 -o dist/index.js dist/index.js",
-    "minifyDeclarations": "jsmin -l 3 -o dist/index.d.ts dist/index.d.ts",
+    "lint": "tsc --noEmit && eslint \"src/**/*.ts\"",
     "prepublishOnly": "npm test && npm run lint && npm run build",
     "preversion": "npm run lint",
     "version": "npm run format && git add -A src package.json",
     "postversion": "git push && git push --tags"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.21",
-    "@types/node": "^14.14.37",
-    "@typescript-eslint/eslint-plugin": "^4.18.0",
-    "@typescript-eslint/parser": "^4.18.0",
-    "eslint": "^7.21.0",
-    "eslint-config-prettier": "^8.1.0",
-    "eslint-plugin-prettier": "^3.3.1",
-    "jest": "^26.6.3",
-    "jsmin": "^1.0.1",
-    "nock": "^13.0.11",
-    "prettier": "^2.2.1",
-    "ts-jest": "^26.5.4",
-    "typescript": "^4.2.3"
-  },
-  "resolutions": {
-    "json-schema": "^0.4.0"
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.10.2",
+    "@typescript-eslint/eslint-plugin": "^8.18.2",
+    "@typescript-eslint/parser": "^8.18.2",
+    "eslint": "^9.17.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "jest": "^29.7.0",
+    "prettier": "^3.4.2",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.7.2"
   },
   "files": [
     "dist/**/*"