cbj-exchange-rate 1.3.0 → 1.3.3

package/README.md

@@ -1,4 +1,4 @@
-# Central Bank of Jordan Exchange Rate API — cbj-exchange-rate
+# Central Bank of Jordan Exchange Rates API — cbj-exchange-rate
 
 [![npm version](https://img.shields.io/npm/v/cbj-exchange-rate.svg)](https://www.npmjs.com/package/cbj-exchange-rate)
 [![license](https://img.shields.io/npm/l/cbj-exchange-rate.svg)](https://github.com/AllRates-Today/cbj-exchange-rate/blob/main/LICENSE)
@@ -16,7 +16,22 @@
 - 🔷 **Type-safe** — full TypeScript definitions shipped with the package
 - 🧾 **Compliance-grade metadata** — `rate_type`, publication date, and source disclaimer on every response
 
-> **Official rate, not mid-market:** every value here is a number Central Bank of Jordan itself published, fixed once printed and carrying the central bank's own `rate_date` — what filings and audits require. Need the live interbank midpoint for pricing or display instead? Use the [mid-market API](https://allratestoday.com/docs/) or [`@allratestoday/sdk`](https://www.npmjs.com/package/@allratestoday/sdk). The two can diverge by several percent.
+> **Official rate, not mid-market:** every value here is a number Central Bank of Jordan itself published, fixed once printed and carrying the central bank's own `rate_date` — what filings and audits require. Need the live mid-market rate for pricing or display instead? Use the [mid-market API](https://allratestoday.com/docs/) or [`@allratestoday/sdk`](https://www.npmjs.com/package/@allratestoday/sdk). The two can diverge by several percent.
+
+## ⚡ Try it without a key
+
+The latest Central Bank of Jordan table is also served keyless, CORS-open and edge-cached, for evaluation, embeds and AI agents:
+
+```bash
+curl "https://allratestoday.com/api/open/central-bank/cbj?source=USD&target=JOD"
+```
+
+```js
+const r = await fetch('https://allratestoday.com/api/open/central-bank/cbj').then((x) => x.json());
+console.log(r.rate_date, r.rates.length); // the central bank's latest published table, no key
+```
+
+The open endpoint serves the *latest* table only and asks for a visible attribution link. The client below uses the keyed API, which adds point-in-time tables, history, and CSV/XML/Excel output.
 
 ## 🔑 Get your API key
 
@@ -36,7 +51,7 @@ yarn add cbj-exchange-rate
 pnpm add cbj-exchange-rate
 ```
 
-Also published under the org scope as [`@allratestoday/cbj-exchange-rate`](https://www.npmjs.com/package/@allratestoday/cbj-exchange-rate) — same code, same versions.
+Requires Node 18+ (global `fetch`); also runs on Bun, Deno and edge runtimes. Also published under the org scope as [`@allratestoday/cbj-exchange-rate`](https://www.npmjs.com/package/@allratestoday/cbj-exchange-rate) — same code, same versions.
 
 ## 🏁 Quick start
 
@@ -70,14 +85,14 @@ const pair = await getRate('USD', 'JOD', { apiKey: 'art_live_...' });
 {
   bank: 'cbj',
   name: 'Central Bank of Jordan',
-  rate_date: '2026-09-09',   // Central Bank of Jordan's own publication date
+  rate_date: '2026-09-24',   // Central Bank of Jordan's own publication date
   source: 'USD',
   target: 'JOD',
   rate: 0.71,
   rate_type: 'sell',
   derived: false,
   method: 'published',
-  disclaimer: '…'
+  disclaimer: 'Official rates as published by the named central bank. On weekends/holidays the most recent published rate_date is returned.'
 }
 ```
 
@@ -98,7 +113,7 @@ console.log(table.rate_date, table.rates.length);
 {
   bank: 'cbj',
   name: 'Central Bank of Jordan',
-  rate_date: '2026-09-09',
+  rate_date: '2026-09-24',
   rates: [
     { "base": "USD", "quote": "JOD", "type": "sell", "value": 0.71 },
     { "base": "USD", "quote": "JOD", "type": "buy", "value": 0.708 },
@@ -141,7 +156,7 @@ Paid plans. One resolved rate per publication date — ready for charting, reval
 import { getHistory } from 'cbj-exchange-rate';
 
 const series = await getHistory(
-  { source: 'USD', target: 'JOD', from: '2026-01-01', to: '2026-09-09' },
+  { source: 'USD', target: 'JOD', from: '2026-01-01', to: '2026-09-24' },
   { apiKey: 'art_live_...' }
 );
 ```
@@ -154,11 +169,11 @@ const series = await getHistory(
   source: 'USD',
   target: 'JOD',
   from: '2026-01-01',
-  to: '2026-09-09',
+  to: '2026-09-24',
   count: 152,
   rates: [
     // one entry per publication date
-    { date: '2026-09-09', rate: 0.71, rate_type: 'sell', derived: false, method: 'published' },
+    { date: '2026-09-24', rate: 0.71, rate_type: 'sell', derived: false, method: 'published' },
     // …
   ],
   disclaimer: '…'
@@ -175,6 +190,39 @@ Central Bank of Jordan currently publishes rates covering **5 currencies** again
 
 🇨🇭 `CHF` · 🇪🇺 `EUR` · 🇬🇧 `GBP` · 🇯🇵 `JPY` · 🇺🇸 `USD`
 
+## 🏛️ Source
+
+The Central Bank of Jordan publishes a daily foreign exchange bulletin covering the US dollar, euro, sterling, Swiss franc and Japanese yen against the dinar, quoted in fils. The dinar has been pegged to the dollar at 0.709 since 1995, so the USD rate barely moves and the others follow the dollar; these are the rates Jordanian customs valuations and audited accounts are expected to cite.
+
+- Publisher's own page: [Foreign exchange rates](https://www.cbj.gov.jo/en/Pages/foreignexchangerates) · [www.cbj.gov.jo](https://www.cbj.gov.jo)
+- Publication: every business day; the exact schedule, freshness status and any current delay are on the [Central Bank of Jordan rates page](https://allratestoday.com/central-bank-rates-api/cbj/)
+- Values are stored unmodified, with the publisher's own `rate_date` on every row — see the [methodology](https://allratestoday.com/official-rates-methodology/)
+
+## 🧭 Reading the numbers
+
+- `value` is always **quote currency per 1 unit of base currency** (`base: "EUR", quote: "USD", value: 1.15` means 1 EUR = 1.15 USD).
+- Central Bank of Jordan quotes **JOD per 1 unit of foreign currency** (e.g. `base: "USD", quote: "JOD"` means JOD per one US dollar).
+- Need the other way round? Ask `getRate(target, source)` and the API inverts or crosses for you, flagged `derived: true` — never divide a published rate yourself in a compliance workflow.
+- `rate_type` tells you which of the central bank's series a row belongs to (`sell` here); some publishers print buy/sell or several fixings for the same pair.
+
+## 🧩 ERP & accounting systems
+
+Loading the official Central Bank of Jordan rate into an accounting system is a supported workflow, not a hack. Step-by-step guides with the direction each system expects:
+
+- [Dynamics 365 Business Central](https://allratestoday.com/docs/integrations/business-central/) — built-in Currency Exchange Rate Service, no code
+- [Xero](https://allratestoday.com/docs/integrations/xero/) · [QuickBooks Online](https://allratestoday.com/docs/integrations/quickbooks/) · [SAP S/4HANA and ECC](https://allratestoday.com/docs/integrations/sap/) · [Odoo](https://allratestoday.com/docs/integrations/odoo/)
+
+The same keyed endpoints return `?format=csv`, `?format=xml` and `?format=xlsx`, and accept the key as `?api_key=` on the URL for importers that cannot send headers:
+
+```bash
+curl "https://allratestoday.com/api/v1/central-bank/cbj/latest?format=xml&api_key=art_live_..."
+```
+
+## 🤖 AI agents
+
+- MCP server: `npx -y @allratestoday/central-bank-mcp` (stdio) or the hosted endpoint `https://allratestoday.com/api/mcp` — tools for official rates, history, cross-bank comparison and publication calendars
+- Machine-readable site guide: [llms.txt](https://allratestoday.com/llms.txt) · [for-ai-agents](https://allratestoday.com/for-ai-agents/)
+
 ## ⚖️ Published vs derived rates
 
 If Central Bank of Jordan does not print a pair directly, the API resolves it from the central bank's own table and says so — official and computed values are never confused:
@@ -249,7 +297,8 @@ Need the whole archive rather than an API call? The same published tables are mi
 
 - [Central Bank of Jordan rates page](https://allratestoday.com/central-bank-rates-api/cbj/) — live table, publication cadence, FAQ
 - [All central bank sources](https://allratestoday.com/central-bank-rates-api/)
-- [API documentation](https://allratestoday.com/docs/#central-bank) · [Interactive reference](https://allratestoday.com/api-reference/)
+- [Package docs on the site](https://allratestoday.com/docs/sdk/cbj-exchange-rate/) · [ERP integration guides](https://allratestoday.com/docs/integrations/)
+- [API documentation](https://allratestoday.com/docs/#central-bank) · [Interactive reference](https://allratestoday.com/api-reference/) · [Methodology](https://allratestoday.com/official-rates-methodology/)
 - [Register (free)](https://allratestoday.com/register) · [Pricing](https://allratestoday.com/pricing/)
 - [GitHub](https://github.com/AllRates-Today/cbj-exchange-rate)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cbj-exchange-rate",
-  "version": "1.3.0",
+  "version": "1.3.3",
   "description": "Official Central Bank of Jordan (Jordan) daily exchange rates — 5 currencies vs JOD, current table, archive from 2026. Zero-dependency Node.js/TypeScript client.",
   "keywords": [
     "cbj",