@lightsparkdev/core 1.0.4 → 1.0.6

package/src/utils/localeToCurrencyCodes.ts

@@ -0,0 +1,272 @@
+/* From https://github.com/tadeegan/locale-currency. For now only USD conversion from
+   BTC is supported by sparkcore, strip additional currency codes from the bundle: */
+export const countryCodesToCurrencyCodes = {
+  AD: "EUR",
+  // AE: "AED",
+  // AF: "AFN",
+  // AG: "XCD",
+  // AI: "XCD",
+  // AL: "ALL",
+  // AM: "AMD",
+  // AO: "AOA",
+  AR: "ARS",
+  AS: "USD",
+  AT: "EUR",
+  AU: "AUD",
+  // AW: "AWG",
+  AX: "EUR",
+  // AZ: "AZN",
+  // BA: "BAM",
+  // BB: "BBD",
+  // BD: "BDT",
+  BE: "EUR",
+  // BF: "XOF",
+  // BG: "BGN",
+  // BH: "BHD",
+  // BI: "BIF",
+  // BJ: "XOF",
+  BL: "EUR",
+  // BM: "BMD",
+  // BN: "BND",
+  // BO: "BOB",
+  BQ: "USD",
+  BR: "BRL",
+  // BS: "BSD",
+  // BT: "BTN",
+  // BV: "NOK",
+  // BW: "BWP",
+  // BY: "BYN",
+  // BZ: "BZD",
+  CA: "CAD",
+  // CC: "AUD",
+  // CD: "CDF",
+  // CF: "XAF",
+  // CG: "XAF",
+  // CH: "CHF",
+  // CI: "XOF",
+  // CK: "NZD",
+  // CL: "CLP",
+  // CM: "XAF",
+  // CN: "CNY",
+  CO: "COP",
+  // CR: "CRC",
+  // CU: "CUP",
+  // CV: "CVE",
+  // CW: "ANG",
+  // CX: "AUD",
+  CY: "EUR",
+  // CZ: "CZK",
+  DE: "EUR",
+  // DJ: "DJF",
+  // DK: "DKK",
+  // DM: "XCD",
+  // DO: "DOP",
+  // DZ: "DZD",
+  EC: "USD",
+  EE: "EUR",
+  // EG: "EGP",
+  // EH: "MAD",
+  // ER: "ERN",
+  ES: "EUR",
+  // ET: "ETB",
+  FI: "EUR",
+  // FJ: "FJD",
+  // FK: "FKP",
+  FM: "USD",
+  // FO: "DKK",
+  FR: "EUR",
+  // GA: "XAF",
+  GB: "GBP",
+  // GD: "XCD",
+  // GE: "GEL",
+  GF: "EUR",
+  GG: "GBP",
+  // GH: "GHS",
+  // GI: "GIP",
+  // GL: "DKK",
+  // GM: "GMD",
+  // GN: "GNF",
+  GP: "EUR",
+  // GQ: "XAF",
+  GR: "EUR",
+  GS: "GBP",
+  // GT: "GTQ",
+  GU: "USD",
+  // GW: "XOF",
+  // GY: "GYD",
+  // HK: "HKD",
+  // HM: "AUD",
+  // HN: "HNL",
+  // HR: "HRK",
+  // HT: "HTG",
+  // HU: "HUF",
+  // ID: "IDR",
+  IE: "EUR",
+  // IL: "ILS",
+  IM: "GBP",
+  IN: "INR",
+  IO: "USD",
+  // IQ: "IQD",
+  // IR: "IRR",
+  // IS: "ISK",
+  IT: "EUR",
+  JE: "GBP",
+  // JM: "JMD",
+  // JO: "JOD",
+  // JP: "JPY",
+  // KE: "KES",
+  // KG: "KGS",
+  // KH: "KHR",
+  // KI: "AUD",
+  // KM: "KMF",
+  // KN: "XCD",
+  // KP: "KPW",
+  // KR: "KRW",
+  // KW: "KWD",
+  // KY: "KYD",
+  // KZ: "KZT",
+  // LA: "LAK",
+  // LB: "LBP",
+  // LC: "XCD",
+  // LI: "CHF",
+  // LK: "LKR",
+  // LR: "LRD",
+  // LS: "LSL",
+  LT: "EUR",
+  LU: "EUR",
+  LV: "EUR",
+  // LY: "LYD",
+  // MA: "MAD",
+  MC: "EUR",
+  // MD: "MDL",
+  ME: "EUR",
+  MF: "EUR",
+  // MG: "MGA",
+  MH: "USD",
+  // MK: "MKD",
+  // ML: "XOF",
+  // MM: "MMK",
+  // MN: "MNT",
+  // MO: "MOP",
+  MP: "USD",
+  MQ: "EUR",
+  // MR: "MRO",
+  // MS: "XCD",
+  MT: "EUR",
+  // MU: "MUR",
+  // MV: "MVR",
+  // MW: "MWK",
+  MX: "MXN",
+  // MY: "MYR",
+  // MZ: "MZN",
+  // NA: "NAD",
+  // NC: "XPF",
+  // NE: "XOF",
+  NF: "AUD",
+  // NG: "NGN",
+  // NI: "NIO",
+  NL: "EUR",
+  // NO: "NOK",
+  // NP: "NPR",
+  NR: "AUD",
+  // NU: "NZD",
+  // NZ: "NZD",
+  // OM: "OMR",
+  // PA: "PAB",
+  // PE: "PEN",
+  // PF: "XPF",
+  // PG: "PGK",
+  // PH: "PHP",
+  // PK: "PKR",
+  // PL: "PLN",
+  PM: "EUR",
+  // PN: "NZD",
+  PR: "USD",
+  // PS: "ILS",
+  PT: "EUR",
+  PW: "USD",
+  // PY: "PYG",
+  // QA: "QAR",
+  RE: "EUR",
+  // RO: "RON",
+  // RS: "RSD",
+  // RU: "RUB",
+  // RW: "RWF",
+  // SA: "SAR",
+  // SB: "SBD",
+  // SC: "SCR",
+  // SD: "SDG",
+  // SE: "SEK",
+  // SG: "SGD",
+  // SH: "SHP",
+  SI: "EUR",
+  // SJ: "NOK",
+  SK: "EUR",
+  // SL: "SLL",
+  SM: "EUR",
+  // SN: "XOF",
+  // SO: "SOS",
+  // SR: "SRD",
+  // ST: "STD",
+  // SV: "SVC",
+  // SX: "ANG",
+  // SY: "SYP",
+  // SZ: "SZL",
+  TC: "USD",
+  // TD: "XAF",
+  TF: "EUR",
+  // TG: "XOF",
+  // TH: "THB",
+  // TJ: "TJS",
+  // TK: "NZD",
+  TL: "USD",
+  // TM: "TMT",
+  // TN: "TND",
+  // TO: "TOP",
+  // TR: "TRY",
+  // TT: "TTD",
+  TV: "AUD",
+  // TW: "TWD",
+  // TZ: "TZS",
+  // UA: "UAH",
+  // UG: "UGX",
+  UM: "USD",
+  US: "USD",
+  // UY: "UYU",
+  // UZ: "UZS",
+  VA: "EUR",
+  // VC: "XCD",
+  // VE: "VEF",
+  VG: "USD",
+  VI: "USD",
+  // VN: "VND",
+  // VU: "VUV",
+  // WF: "XPF",
+  // WS: "WST",
+  // YE: "YER",
+  YT: "EUR",
+  // ZA: "ZAR",
+  // ZM: "ZMW",
+  // ZW: "ZWL",
+} as const;
+
+export type CurrencyLocales = keyof typeof countryCodesToCurrencyCodes;
+export type CurrencyCodes =
+  (typeof countryCodesToCurrencyCodes)[CurrencyLocales];
+
+function getCountryCode(localeString: string) {
+  let components = localeString.split("_");
+  if (components.length === 2) {
+    return components.pop() as string;
+  }
+  components = localeString.split("-");
+  if (components.length === 2) {
+    return components.pop() as string;
+  }
+  return localeString;
+}
+
+export function localeToCurrencyCode(locale: string): CurrencyCodes {
+  const countryCode = getCountryCode(locale) as CurrencyLocales;
+  return countryCodesToCurrencyCodes[countryCode];
+}

package/src/utils/numbers.ts

@@ -0,0 +1,32 @@
+export function clamp(val: number, min: number, max: number): number {
+  return val > max ? max : val < min ? min : val;
+}
+
+export function linearInterpolate(
+  value: number,
+  fromRangeStart: number,
+  fromRangeEnd: number,
+  toRangeStart: number,
+  toRangeEnd: number,
+) {
+  const fromRangeMax = fromRangeEnd - fromRangeStart;
+  const fromRangeVal = value - fromRangeStart;
+  const toRangeMax = toRangeEnd - toRangeStart;
+  const val = (fromRangeVal / fromRangeMax) * toRangeMax + toRangeStart;
+  return clamp(
+    val,
+    Math.min(toRangeStart, toRangeEnd),
+    Math.max(toRangeStart, toRangeEnd),
+  );
+}
+
+/* https://stackoverflow.com/a/48764436 */
+export function round(num: number, decimalPlaces = 0) {
+  const p = Math.pow(10, decimalPlaces);
+  const n = num * p * (1 + Number.EPSILON);
+  return Math.round(n) / p;
+}
+
+export function isNumber(value: unknown): value is number {
+  return typeof value === "number";
+}

package/src/utils/tests/currency.test.ts

@@ -0,0 +1,190 @@
+// add tests for convertCurrencyAmountValue function
+
+import {
+  convertCurrencyAmountValue,
+  CurrencyUnit,
+  localeToCurrencySymbol,
+  mapCurrencyAmount,
+} from "../currency.js";
+
+describe("convertCurrencyAmountValue", () => {
+  it("should return the same value if the currency is the same", () => {
+    expect(
+      convertCurrencyAmountValue(CurrencyUnit.USD, CurrencyUnit.USD, 10),
+    ).toBe(10);
+  });
+  it("should convert from SAT to mSAT", () => {
+    expect(
+      convertCurrencyAmountValue(
+        CurrencyUnit.SATOSHI,
+        CurrencyUnit.MILLISATOSHI,
+        100_000,
+      ),
+    ).toBe(100_000_000);
+  });
+  it("should convert from SAT to BTC", () => {
+    expect(
+      convertCurrencyAmountValue(
+        CurrencyUnit.SATOSHI,
+        CurrencyUnit.BITCOIN,
+        100000000,
+      ),
+    ).toBe(1);
+  });
+  it("should convert from SAT to USD", () => {
+    expect(
+      convertCurrencyAmountValue(
+        CurrencyUnit.SATOSHI,
+        CurrencyUnit.USD,
+        100_000,
+        25_000_00,
+      ),
+    ).toBe(25_00);
+  });
+  it("should convert from USD to mSAT", () => {
+    expect(
+      convertCurrencyAmountValue(
+        CurrencyUnit.USD,
+        CurrencyUnit.MILLISATOSHI,
+        25_00,
+        25_000_00,
+      ),
+    ).toBe(100_000_000);
+  });
+  it("should convert from USD to SAT", () => {
+    expect(
+      convertCurrencyAmountValue(
+        CurrencyUnit.USD,
+        CurrencyUnit.SATOSHI,
+        25_00,
+        25_000_00,
+      ),
+    ).toBe(100_000);
+  });
+  it("should convert from USD to BTC", () => {
+    expect(
+      convertCurrencyAmountValue(
+        CurrencyUnit.USD,
+        CurrencyUnit.BITCOIN,
+        25_000_00,
+        25_000_00,
+      ),
+    ).toBe(1);
+  });
+  it("should convert from BTC to USD", () => {
+    expect(
+      convertCurrencyAmountValue(
+        CurrencyUnit.BITCOIN,
+        CurrencyUnit.USD,
+        1,
+        25_000_00,
+      ),
+    ).toBe(25_000_00);
+  });
+  it("should convert from BTC to mSAT", () => {
+    expect(
+      convertCurrencyAmountValue(
+        CurrencyUnit.BITCOIN,
+        CurrencyUnit.MILLISATOSHI,
+        1,
+      ),
+    ).toBe(100_000_000_000);
+  });
+  it("should convert from BTC to SAT", () => {
+    expect(
+      convertCurrencyAmountValue(CurrencyUnit.BITCOIN, CurrencyUnit.SATOSHI, 1),
+    ).toBe(100000000);
+  });
+  it("should convert from mSAT to BTC", () => {
+    expect(
+      convertCurrencyAmountValue(
+        CurrencyUnit.MILLISATOSHI,
+        CurrencyUnit.BITCOIN,
+        100_000_000_000,
+      ),
+    ).toBe(1);
+  });
+  it("should convert from mSAT to USD", () => {
+    expect(
+      convertCurrencyAmountValue(
+        CurrencyUnit.MILLISATOSHI,
+        CurrencyUnit.USD,
+        100_000_000,
+        25_000_00,
+      ),
+    ).toBe(25_00);
+  });
+  it("should convert from mSAT to SAT", () => {
+    expect(
+      convertCurrencyAmountValue(
+        CurrencyUnit.MILLISATOSHI,
+        CurrencyUnit.SATOSHI,
+        100_000_000,
+      ),
+    ).toBe(100_000);
+  });
+
+  it("should round properly", () => {
+    expect(
+      convertCurrencyAmountValue(
+        CurrencyUnit.SATOSHI,
+        CurrencyUnit.USD,
+        23_952_251,
+        25_124_19,
+      ),
+    ).toBe(6017_81); // 6017_80.90505169
+  });
+});
+
+describe("mapCurrencyAmount", () => {
+  it("should return the expected value for a CurrencyAmountObj", () => {
+    const currencyMap = mapCurrencyAmount(
+      {
+        value: 100_000_000,
+        unit: CurrencyUnit.SATOSHI,
+      },
+      25_000_00,
+    );
+    expect(currencyMap.btc).toBe(1);
+    expect(currencyMap.USD).toBe(25_000_00);
+    expect(currencyMap.sats).toBe(100_000_000);
+    expect(currencyMap.msats).toBe(100_000_000_000);
+    expect(currencyMap.formatted.btc).toBe("1");
+    expect(currencyMap.formatted.USD).toBe("$25,000.00");
+    expect(currencyMap.formatted.sats).toBe("100,000,000");
+    expect(currencyMap.formatted.msats).toBe("100,000,000,000");
+    expect(currencyMap.isEqualTo(currencyMap)).toBe(true);
+
+    const smallerCurrencyMap = mapCurrencyAmount(
+      {
+        value: 100_000,
+        unit: CurrencyUnit.SATOSHI,
+      },
+      25_000_00,
+    );
+
+    expect(currencyMap.isEqualTo(smallerCurrencyMap)).toBe(false);
+    expect(currencyMap.isGreaterThan(smallerCurrencyMap)).toBe(true);
+    expect(currencyMap.isLessThan(smallerCurrencyMap)).toBe(false);
+    expect(smallerCurrencyMap.isGreaterThan(currencyMap)).toBe(false);
+    expect(smallerCurrencyMap.isLessThan(currencyMap)).toBe(true);
+  });
+});
+
+describe("getCurrencySymbol", () => {
+  it("should return the expected currency symbol", () => {
+    expect(localeToCurrencySymbol("en-US")).toBe("$");
+    expect(localeToCurrencySymbol("en-GB")).toBe("£");
+    expect(localeToCurrencySymbol("en-CA")).toBe("$");
+    expect(localeToCurrencySymbol("en-AU")).toBe("$");
+    expect(localeToCurrencySymbol("en-IN")).toBe("₹");
+    expect(localeToCurrencySymbol("en-IE")).toBe("€");
+    expect(localeToCurrencySymbol("en-DE")).toBe("€");
+    expect(localeToCurrencySymbol("en-FR")).toBe("€");
+    expect(localeToCurrencySymbol("en-IT")).toBe("€");
+    expect(localeToCurrencySymbol("es-MX")).toBe("$");
+    expect(localeToCurrencySymbol("es-CO")).toBe("$");
+    expect(localeToCurrencySymbol("pt-BR")).toBe("R$");
+    expect(localeToCurrencySymbol("es-AR")).toBe("$");
+  });
+});