@uplab/vendure-plugin-exchange-rates 0.1.0

package/dist/sources/nbu-exchange-rate-source.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NbuExchangeRateSource = void 0;
+const core_1 = require("@vendure/core");
+const constants_1 = require("../constants");
+const fetch_body_1 = require("./fetch-body");
+/**
+ * @description
+ * The National Bank of Ukraine's official rates, set once per business day. The list also carries
+ * metals and the SDR, which are dropped because they are not Vendure currencies.
+ */
+class NbuExchangeRateSource {
+    constructor(options = {}) {
+        this.name = 'nbu';
+        this.apiUrl = options.apiUrl ?? 'https://bank.gov.ua/NBUStatService/v1/statdirectory/exchange?json';
+        this.timeout = options.timeout ?? constants_1.DEFAULT_SOURCE_TIMEOUT;
+    }
+    async fetchRates() {
+        const rows = await (0, fetch_body_1.fetchJsonArray)(this.name, this.apiUrl, this.timeout);
+        const quotes = rows.map((row) => ({ currencyCode: row.cc, rate: row.rate }));
+        return { base: core_1.CurrencyCode.UAH, quotes };
+    }
+}
+exports.NbuExchangeRateSource = NbuExchangeRateSource;
+//# sourceMappingURL=nbu-exchange-rate-source.js.map

package/dist/sources/nbu-exchange-rate-source.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nbu-exchange-rate-source.js","sourceRoot":"","sources":["../../src/sources/nbu-exchange-rate-source.ts"],"names":[],"mappings":";;;AAAA,wCAA6C;AAC7C,4CAAsD;AAEtD,6CAA8C;AAe9C;;;;GAIG;AACH,MAAa,qBAAqB;IAKhC,YAAY,UAAwC,EAAE;QAJ7C,SAAI,GAAG,KAAK,CAAC;QAKpB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,mEAAmE,CAAC;QACpG,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,kCAAsB,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,UAAU;QACd,MAAM,IAAI,GAAG,MAAM,IAAA,2BAAc,EAAU,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACjF,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,YAAY,EAAE,GAAG,CAAC,EAAkB,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAC7F,OAAO,EAAE,IAAI,EAAE,mBAAY,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC;IAC5C,CAAC;CACF;AAfD,sDAeC"}

package/dist/sources/static-exchange-rate-source.d.ts

@@ -0,0 +1,20 @@
+import { CurrencyCode } from '@vendure/core';
+import { ExchangeRateSource, ExchangeRateSourceResult } from '../types';
+export interface StaticExchangeRateSourceOptions {
+    /** The currency `rates` are expressed in. */
+    base: CurrencyCode;
+    /** Units of `base` per one unit of each currency. */
+    rates: Partial<Record<CurrencyCode, number>>;
+}
+/**
+ * @description
+ * Fixed rates, for a shop that keys them in by hand, for development and for tests:
+ * `new StaticExchangeRateSource({ base: CurrencyCode.USD, rates: { EUR: 1.12, GBP: 1.32 } })`.
+ */
+export declare class StaticExchangeRateSource implements ExchangeRateSource {
+    config: StaticExchangeRateSourceOptions;
+    readonly name = "static";
+    constructor(config: StaticExchangeRateSourceOptions);
+    fetchRates(): Promise<ExchangeRateSourceResult>;
+}
+//# sourceMappingURL=static-exchange-rate-source.d.ts.map

package/dist/sources/static-exchange-rate-source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"static-exchange-rate-source.d.ts","sourceRoot":"","sources":["../../src/sources/static-exchange-rate-source.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC;AAExE,MAAM,WAAW,+BAA+B;IAC9C,6CAA6C;IAC7C,IAAI,EAAE,YAAY,CAAC;IACnB,qDAAqD;IACrD,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC;CAC9C;AAED;;;;GAIG;AACH,qBAAa,wBAAyB,YAAW,kBAAkB;IAG9C,MAAM,EAAE,+BAA+B;IAF1D,QAAQ,CAAC,IAAI,YAAY;gBAEN,MAAM,EAAE,+BAA+B;IAE1D,UAAU,IAAI,OAAO,CAAC,wBAAwB,CAAC;CAOhD"}

package/dist/sources/static-exchange-rate-source.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StaticExchangeRateSource = void 0;
+/**
+ * @description
+ * Fixed rates, for a shop that keys them in by hand, for development and for tests:
+ * `new StaticExchangeRateSource({ base: CurrencyCode.USD, rates: { EUR: 1.12, GBP: 1.32 } })`.
+ */
+class StaticExchangeRateSource {
+    constructor(config) {
+        this.config = config;
+        this.name = 'static';
+    }
+    fetchRates() {
+        const quotes = Object.entries(this.config.rates).map(([currencyCode, rate]) => ({
+            currencyCode: currencyCode,
+            rate: rate,
+        }));
+        return Promise.resolve({ base: this.config.base, quotes });
+    }
+}
+exports.StaticExchangeRateSource = StaticExchangeRateSource;
+//# sourceMappingURL=static-exchange-rate-source.js.map

package/dist/sources/static-exchange-rate-source.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"static-exchange-rate-source.js","sourceRoot":"","sources":["../../src/sources/static-exchange-rate-source.ts"],"names":[],"mappings":";;;AAUA;;;;GAIG;AACH,MAAa,wBAAwB;IAGnC,YAAmB,MAAuC;QAAvC,WAAM,GAAN,MAAM,CAAiC;QAFjD,SAAI,GAAG,QAAQ,CAAC;IAEoC,CAAC;IAE9D,UAAU;QACR,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;YAC9E,YAAY,EAAE,YAA4B;YAC1C,IAAI,EAAE,IAAc;SACrB,CAAC,CAAC,CAAC;QACJ,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAC7D,CAAC;CACF;AAZD,4DAYC"}

package/dist/types.d.ts

@@ -0,0 +1,64 @@
+import type { CurrencyCode, ID, InjectableStrategy, RequestContext, ScheduledTaskConfig } from '@vendure/core';
+/** One fetched rate: `rate` units of the source's base currency buy one unit of `currencyCode`. */
+export interface ExchangeRateQuote {
+    currencyCode: CurrencyCode;
+    rate: number;
+}
+/** What a source fetched: its quotes, and the base currency they are expressed in. */
+export interface ExchangeRateSourceResult {
+    base: CurrencyCode;
+    quotes: ExchangeRateQuote[];
+}
+/**
+ * @description
+ * Where the rates come from. `fetchRates` returns every pair the source has, in whatever base it quotes
+ * in; the plugin re-bases them onto the shop's base currency, drops unusable quotes and upserts the rest
+ * by code. An admin's custom rate is kept unless the base currency changes.
+ *
+ * Throw (ideally an {@link ExchangeRateSourceError}) when the source cannot be read — never return no
+ * quotes to mean "failed" — and bound the request with a timeout: the API server waits for the first
+ * fetch on boot. The plugin calls `init(injector)` on bootstrap and `destroy()` on shutdown.
+ */
+export interface ExchangeRateSource extends InjectableStrategy {
+    /** Short name for logs, e.g. `'ecb'`. */
+    readonly name: string;
+    fetchRates(ctx: RequestContext): Promise<ExchangeRateSourceResult>;
+}
+export interface ExchangeRatesPluginOptions {
+    /** Where the rates come from: `EcbExchangeRateSource`, `FrankfurterExchangeRateSource`, … or your own. */
+    source: ExchangeRateSource;
+    /**
+     * The currency rates are expressed in: `rate` = units of it per one unit of a currency.
+     *
+     * @default the default channel's `defaultCurrencyCode`
+     */
+    baseCurrency?: CurrencyCode;
+    /**
+     * The scheduled refresh. `false` leaves the task out; `CurrencyExchangeRateSyncService` can still
+     * be called.
+     *
+     * @default { schedule: '40 2-23/3 * * *' } — every 3 hours
+     */
+    sync?: {
+        schedule?: ScheduledTaskConfig['schedule'];
+    } | false;
+}
+/** {@link ExchangeRatesPluginOptions} with every default applied. */
+export interface ResolvedExchangeRatesPluginOptions {
+    source: ExchangeRateSource;
+    baseCurrency?: CurrencyCode;
+    sync: {
+        schedule: ScheduledTaskConfig['schedule'];
+    } | false;
+}
+/** Mirrors `UpdateCurrencyExchangeRateInput` in `api-extensions.ts`. */
+export interface UpdateCurrencyExchangeRateInput {
+    id: ID;
+    enabled: boolean;
+    useCustomRate: boolean;
+    customRate?: number | null;
+}
+export interface MutationUpdateCurrencyExchangeRateArgs {
+    input: UpdateCurrencyExchangeRateInput;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,EAAE,EAAE,kBAAkB,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAE/G,mGAAmG;AACnG,MAAM,WAAW,iBAAiB;IAChC,YAAY,EAAE,YAAY,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,sFAAsF;AACtF,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,YAAY,CAAC;IACnB,MAAM,EAAE,iBAAiB,EAAE,CAAC;CAC7B;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;IAC5D,yCAAyC;IACzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;CACpE;AAED,MAAM,WAAW,0BAA0B;IACzC,0GAA0G;IAC1G,MAAM,EAAE,kBAAkB,CAAC;IAC3B;;;;OAIG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;;;;OAKG;IACH,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAA;KAAE,GAAG,KAAK,CAAC;CAC/D;AAED,qEAAqE;AACrE,MAAM,WAAW,kCAAkC;IACjD,MAAM,EAAE,kBAAkB,CAAC;IAC3B,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,IAAI,EAAE;QAAE,QAAQ,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAA;KAAE,GAAG,KAAK,CAAC;CAC7D;AAED,wEAAwE;AACxE,MAAM,WAAW,+BAA+B;IAC9C,EAAE,EAAE,EAAE,CAAC;IACP,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,OAAO,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,sCAAsC;IACrD,KAAK,EAAE,+BAA+B,CAAC;CACxC"}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@uplab/vendure-plugin-exchange-rates",
+  "version": "0.1.0",
+  "description": "Exchange rates for Vendure in any base currency, from the ECB, Frankfurter, Monobank, the NBU or your own source, overridable per currency in the dashboard",
+  "license": "MIT",
+  "author": "Uplab",
+  "homepage": "https://github.com/Uplab/uplab-vendure-plugins/tree/main/packages/vendure-plugin-exchange-rates#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Uplab/uplab-vendure-plugins.git",
+    "directory": "packages/vendure-plugin-exchange-rates"
+  },
+  "bugs": {
+    "url": "https://github.com/Uplab/uplab-vendure-plugins/issues"
+  },
+  "keywords": [
+    "vendure",
+    "vendure-plugin",
+    "currency",
+    "exchange-rates",
+    "multi-currency",
+    "ecb",
+    "frankfurter",
+    "monobank",
+    "nbu"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "build": "rimraf dist && tsc -p tsconfig.build.json && node ../../scripts/copy-dashboard.mjs",
+    "typecheck": "tsc -p tsconfig.json --noEmit && node ../../scripts/typecheck-dashboard.mjs",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "currency-codes": "^2.2.0",
+    "graphql-tag": "^2.12.6"
+  },
+  "peerDependencies": {
+    "@lingui/react": "^5.0.0",
+    "@nestjs/common": "^11.0.0",
+    "@nestjs/core": "^11.0.0",
+    "@nestjs/graphql": "^13.0.0",
+    "@vendure/core": "^3.7.0",
+    "@vendure/dashboard": "^3.7.0",
+    "react": "^19.0.0",
+    "typeorm": "^0.3.21"
+  },
+  "peerDependenciesMeta": {
+    "@lingui/react": {
+      "optional": true
+    },
+    "@vendure/dashboard": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@lingui/react": "^5.9.5",
+    "@nestjs/common": "^11.0.12",
+    "@nestjs/core": "^11.2.1",
+    "@nestjs/graphql": "^13.0.0",
+    "@types/react": "^19.0.0",
+    "@vendure/core": "3.7.2",
+    "@vendure/dashboard": "3.7.2",
+    "@vendure/testing": "3.7.2",
+    "graphql": "^16.11.0",
+    "react": "^19.0.0",
+    "rimraf": "^6.0.1",
+    "rxjs": "^7.8.1",
+    "typeorm": "^0.3.21",
+    "typescript": "^5.8.3",
+    "unplugin-swc": "^1.5.7",
+    "vitest": "^4.0.0"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}