currencyapi-node 1.1.1 → 1.2.0

package/.claude/settings.local.json

@@ -0,0 +1,13 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(git checkout:*)",
+      "Bash(docker build:*)",
+      "Bash(npm install:*)",
+      "Bash(git add:*)",
+      "Bash(git commit:*)",
+      "Bash(git push:*)",
+      "Bash(gh pr create:*)"
+    ]
+  }
+}

package/.github/workflows/tests.yml

@@ -8,14 +8,14 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.x, 15.x, 16.x, 18.x]
+        node-version: [16.x, 18.x, 20.x, 22.x, 24.x]
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Set up Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
 
@@ -26,4 +26,4 @@ jobs:
       run: npm run test
 
     - name: Upload coverage to Coveralls
-      uses: coverallsapp/github-action@v2
+      uses: coverallsapp/github-action@v2

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.2.0] - 2026-02-13
+
+### Added
+- Node.js v20, v22, and v24 support
+- `engines` field in package.json specifying minimum Node.js version
+
+### Changed
+- Dockerfile updated from Node 22 to Node 24
+- CI matrix updated to test against Node.js 16, 18, 20, 22, and 24
+- Updated GitHub Actions to latest versions (checkout@v4, setup-node@v4)
+- Minimum supported Node.js version updated from v8 to v16
+- README updated to reflect current Node.js compatibility
+
+## [1.1.1] - Previous release
+
+- Initial tracked version

package/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:18-slim
+FROM node:24-slim
 
 USER node
 ARG APP_DIR=/home/node/app

package/Makefile

@@ -1,10 +1,11 @@
 .DEFAULT_GOAL := help
 .PHONY: help
 LOCAL_DOCKER_IMAGE=houseofapis/currencyapi-node
-CONTAINER_NAME=currencyapi-node
+CONTAINER_NAME=currencyapi-node-sdk
 WORKING_DIR=/application
 PORT=7003
-DOCKER_COMMAND=docker run --rm -v ${PWD}:${WORKING_DIR} -w ${WORKING_DIR} --name ${CONTAINER_NAME} -p ${PORT}:${PORT} -it ${LOCAL_DOCKER_IMAGE}
+DOCKER_COMMAND=docker run --rm -v ${PWD}:${WORKING_DIR} -w ${WORKING_DIR} --name ${CONTAINER_NAME} -p ${PORT}:${PORT} ${LOCAL_DOCKER_IMAGE}
+DOCKER_COMMAND_INTERACTIVE=docker run --rm -v ${PWD}:${WORKING_DIR} -w ${WORKING_DIR} --name ${CONTAINER_NAME} -p ${PORT}:${PORT} -it ${LOCAL_DOCKER_IMAGE}
 
 build: ## Build docker image
 	docker build -t ${LOCAL_DOCKER_IMAGE} . --no-cache
@@ -16,7 +17,10 @@ install: ## Npm install
 	${DOCKER_COMMAND} npm i
 
 run: ## Run test file
-	${DOCKER_COMMAND} npm publish
+	${DOCKER_COMMAND_INTERACTIVE} node run.js
+
+publish: ## Publish version (use: make publish OTP=123456 if 2FA enabled)
+	docker run --rm -v ${PWD}:${WORKING_DIR} -v ${HOME}/.npmrc:/home/node/.npmrc:ro -w ${WORKING_DIR} --name ${CONTAINER_NAME} ${LOCAL_DOCKER_IMAGE} npm publish $(if ${OTP},--otp=${OTP})
 
 help:
 	@grep -h -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'

package/README.md

@@ -17,14 +17,20 @@ Features:
 
 Signup for a free or paid account <a href="https://currencyapi.net/#pricing-sec" title="currency-api-pricing">here</a>.
 
-## This package
+## This package is a:
 
 NodeJs wrapper for <a href="https://currencyapi.net" title="CurrencyApi">CurrencyApi.net</a> endpoints.
 
+## Developer Guide
+
+For an easy to following developer guide, check out our [NodeJs Developer Guide](https://currencyapi.net/sdk/nodejs).
+
+Alternatively keep reading below.
+
 #### Prerequisites
 
-- Minimum NodeJs v8 (npm v5 and above)
-- Working on NodeJs v18
+- Minimum NodeJs v16 (npm v7 and above)
+- Tested on NodeJs v16, v18, v20, v22, v24
 - Free or Paid account with CurrencyApi.net
 
 #### Test Coverage

package/package.json

@@ -18,7 +18,10 @@
       "role": "Developer"
     }
   ],
-  "version": "1.1.1",
+  "version": "1.2.0",
+  "engines": {
+    "node": ">=16.0.0"
+  },
   "scripts": {
     "test": "jest --coverage --collectCoverageFrom='./src/**'"
   },

package/run.js

@@ -1,6 +1,26 @@
-const CurrencyApi = require('./src/CurrencyApi')
+// run.js
+const CurrencyApi = require('./src/CurrencyApi');
 
-const currency = new CurrencyApi('API_KEY');
-currency.rates().output('JSON').get()
-    .then(console.log)
+const currency = new CurrencyApi('YOUR_API_KEY');
 
+async function convertCurrency(amount, fromCurrency, toCurrency) {
+    try {
+        const result = await currency.convert()
+            .from(fromCurrency)
+            .to(toCurrency)
+            .amount(amount)
+            .get();
+        return result.conversion.result;
+    } catch (error) {
+        throw new Error(`Conversion failed: ${error.message}`);
+    }
+}
+
+(async () => {
+    try {
+        const converted = await convertCurrency(100, 'BTC', 'USD');
+        console.log(`100 BTC is equal to ${converted} USD`);
+    } catch (error) {
+        console.error(error);
+    }
+})();