@lightsparkdev/core 1.2.6 → 1.2.7

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @lightsparkdev/core
 
+## 1.2.7
+
+### Patch Changes
+
+- 56d359b: - PHP Currency Support Added:
+  – Updated packages/core/src/utils/currency.ts to include PHP as a valid currency unit. This involved extending the CurrencyUnit object, adding PHP conversion functions into the conversion maps (for Bitcoin, microbitcoin, millibitcoin, satoshi, etc.), and updating formatting logic (e.g. in formatCurrencyStr).
+  – Corresponding type definitions and helper functions (such as isCurrencyAmountInputObj and related mapping functions) were enhanced to support PHP, and tests in packages/core/src/utils/tests/currency.test.ts now verify PHP conversions.
+
 ## 1.2.6
 
 ### Patch Changes

package/dist/{chunk-CKJUUY2Z.js → chunk-NY4EJZNK.js}

@@ -407,6 +407,7 @@ var CurrencyUnit = {
   MILLIBITCOIN: "MILLIBITCOIN",
   USD: "USD",
   MXN: "MXN",
+  PHP: "PHP",
   Bitcoin: "BITCOIN",
   Microbitcoin: "MICROBITCOIN",
   Millibitcoin: "MILLIBITCOIN",
@@ -414,7 +415,8 @@ var CurrencyUnit = {
   Nanobitcoin: "NANOBITCOIN",
   Satoshi: "SATOSHI",
   Usd: "USD",
-  Mxn: "MXN"
+  Mxn: "MXN",
+  Php: "PHP"
 };
 var standardUnitConversionObj = {
   [CurrencyUnit.BITCOIN]: (v, unitsPerBtc = 1) => v / unitsPerBtc,
@@ -425,7 +427,8 @@ var standardUnitConversionObj = {
   [CurrencyUnit.SATOSHI]: (v, unitsPerBtc = 1) => v / unitsPerBtc * 1e8,
   /* Converting between two different fiat types is not currently supported */
   [CurrencyUnit.USD]: (v) => v,
-  [CurrencyUnit.MXN]: (v) => v
+  [CurrencyUnit.MXN]: (v) => v,
+  [CurrencyUnit.PHP]: (v) => v
 };
 var toBitcoinConversion = (v, unitsPerBtc = 1) => round(v * unitsPerBtc);
 var toMicrobitcoinConversion = (v, unitsPerBtc = 1) => round(v / 1e6 * unitsPerBtc);
@@ -442,7 +445,8 @@ var CONVERSION_MAP = {
     [CurrencyUnit.NANOBITCOIN]: (v) => v * 1e9,
     [CurrencyUnit.SATOSHI]: (v) => v * 1e8,
     [CurrencyUnit.USD]: toBitcoinConversion,
-    [CurrencyUnit.MXN]: toBitcoinConversion
+    [CurrencyUnit.MXN]: toBitcoinConversion,
+    [CurrencyUnit.PHP]: toBitcoinConversion
   },
   [CurrencyUnit.MICROBITCOIN]: {
     [CurrencyUnit.BITCOIN]: (v) => v / 1e6,
@@ -452,7 +456,8 @@ var CONVERSION_MAP = {
     [CurrencyUnit.NANOBITCOIN]: (v) => v * 1e3,
     [CurrencyUnit.SATOSHI]: (v) => v * 100,
     [CurrencyUnit.USD]: toMicrobitcoinConversion,
-    [CurrencyUnit.MXN]: toMicrobitcoinConversion
+    [CurrencyUnit.MXN]: toMicrobitcoinConversion,
+    [CurrencyUnit.PHP]: toMicrobitcoinConversion
   },
   [CurrencyUnit.MILLIBITCOIN]: {
     [CurrencyUnit.BITCOIN]: (v) => v / 1e3,
@@ -462,7 +467,8 @@ var CONVERSION_MAP = {
     [CurrencyUnit.NANOBITCOIN]: (v) => v * 1e6,
     [CurrencyUnit.SATOSHI]: (v) => v * 1e5,
     [CurrencyUnit.USD]: toMillibitcoinConversion,
-    [CurrencyUnit.MXN]: toMillibitcoinConversion
+    [CurrencyUnit.MXN]: toMillibitcoinConversion,
+    [CurrencyUnit.PHP]: toMillibitcoinConversion
   },
   [CurrencyUnit.MILLISATOSHI]: {
     [CurrencyUnit.BITCOIN]: (v) => v / 1e11,
@@ -472,7 +478,8 @@ var CONVERSION_MAP = {
     [CurrencyUnit.NANOBITCOIN]: (v) => v / 100,
     [CurrencyUnit.SATOSHI]: (v) => v / 1e3,
     [CurrencyUnit.USD]: toMillisatoshiConversion,
-    [CurrencyUnit.MXN]: toMillisatoshiConversion
+    [CurrencyUnit.MXN]: toMillisatoshiConversion,
+    [CurrencyUnit.PHP]: toMillisatoshiConversion
   },
   [CurrencyUnit.NANOBITCOIN]: {
     [CurrencyUnit.BITCOIN]: (v) => v / 1e9,
@@ -482,7 +489,8 @@ var CONVERSION_MAP = {
     [CurrencyUnit.NANOBITCOIN]: (v) => v,
     [CurrencyUnit.SATOSHI]: (v) => v / 10,
     [CurrencyUnit.USD]: toNanobitcoinConversion,
-    [CurrencyUnit.MXN]: toNanobitcoinConversion
+    [CurrencyUnit.MXN]: toNanobitcoinConversion,
+    [CurrencyUnit.PHP]: toNanobitcoinConversion
   },
   [CurrencyUnit.SATOSHI]: {
     [CurrencyUnit.BITCOIN]: (v) => v / 1e8,
@@ -492,10 +500,12 @@ var CONVERSION_MAP = {
     [CurrencyUnit.NANOBITCOIN]: (v) => v * 10,
     [CurrencyUnit.SATOSHI]: (v) => v,
     [CurrencyUnit.USD]: toSatoshiConversion,
-    [CurrencyUnit.MXN]: toSatoshiConversion
+    [CurrencyUnit.MXN]: toSatoshiConversion,
+    [CurrencyUnit.PHP]: toSatoshiConversion
   },
   [CurrencyUnit.USD]: standardUnitConversionObj,
-  [CurrencyUnit.MXN]: standardUnitConversionObj
+  [CurrencyUnit.MXN]: standardUnitConversionObj,
+  [CurrencyUnit.PHP]: standardUnitConversionObj
 };
 function convertCurrencyAmountValue(fromUnit, toUnit, amount, unitsPerBtc = 1) {
   if (fromUnit === CurrencyUnit.FUTURE_VALUE || toUnit === CurrencyUnit.FUTURE_VALUE) {
@@ -526,6 +536,9 @@ var convertCurrencyAmount = (from, toUnit) => {
     preferredCurrencyValueRounded: value
   };
 };
+function isCurrencyAmountInputObj(arg) {
+  return typeof arg === "object" && arg !== null && "value" in arg && (typeof arg.value === "number" || typeof arg.value === "string" || arg.value === null) && "unit" in arg && typeof arg.unit === "string";
+}
 function isDeprecatedCurrencyAmountObj(arg) {
   return typeof arg === "object" && arg !== null && "value" in arg && "unit" in arg;
 }
@@ -533,7 +546,7 @@ function isCurrencyAmountObj(arg) {
   return typeof arg === "object" && arg !== null && "original_value" in arg && "original_unit" in arg;
 }
 function isCurrencyAmountPreferenceObj(arg) {
-  return typeof arg === "object" && arg !== null && "preferred_currency_unit" in arg && "preferred_currency_value_rounded" in arg;
+  return typeof arg === "object" && arg !== null && "original_unit" in arg && typeof arg.original_unit === "string" && "original_value" in arg && typeof arg.original_value === "number" && "preferred_currency_unit" in arg && typeof arg.preferred_currency_unit === "string" && "preferred_currency_value_approx" in arg && typeof arg.preferred_currency_value_approx === "number";
 }
 function isSDKCurrencyAmount(arg) {
   return typeof arg === "object" && arg !== null && /* We can expect all SDK CurrencyAmount types to always have these exact properties: */
@@ -551,13 +564,10 @@ function getCurrencyAmount(currencyAmountArg) {
   if (isSDKCurrencyAmount(currencyAmountArg)) {
     value = currencyAmountArg.originalValue;
     unit = currencyAmountArg.originalUnit;
-  } else if (isCurrencyAmountPreferenceObj(currencyAmountArg)) {
-    value = asNumber(currencyAmountArg.preferred_currency_value_rounded);
-    unit = currencyAmountArg.preferred_currency_unit;
   } else if (isCurrencyAmountObj(currencyAmountArg)) {
     value = asNumber(currencyAmountArg.original_value);
     unit = currencyAmountArg.original_unit;
-  } else if (isDeprecatedCurrencyAmountObj(currencyAmountArg)) {
+  } else if (isCurrencyAmountInputObj(currencyAmountArg) || isDeprecatedCurrencyAmountObj(currencyAmountArg)) {
     value = asNumber(currencyAmountArg.value);
     unit = currencyAmountArg.unit;
   }
@@ -566,23 +576,61 @@ function getCurrencyAmount(currencyAmountArg) {
     unit: unit || CurrencyUnit.SATOSHI
   };
 }
+function convertCurrencyAmountValues(fromUnit, amount, unitsPerBtc = 1, conversionOverride) {
+  const convert = convertCurrencyAmountValue;
+  const namesToUnits = {
+    sats: CurrencyUnit.SATOSHI,
+    btc: CurrencyUnit.BITCOIN,
+    msats: CurrencyUnit.MILLISATOSHI,
+    usd: CurrencyUnit.USD,
+    mxn: CurrencyUnit.MXN,
+    php: CurrencyUnit.PHP,
+    mibtc: CurrencyUnit.MICROBITCOIN,
+    mlbtc: CurrencyUnit.MILLIBITCOIN,
+    nbtc: CurrencyUnit.NANOBITCOIN
+  };
+  return Object.entries(namesToUnits).reduce(
+    (acc, [name, unit]) => {
+      if (conversionOverride && unit === conversionOverride.unit) {
+        acc[name] = conversionOverride.convertedValue;
+      } else {
+        acc[name] = convert(
+          fromUnit,
+          unit,
+          amount,
+          unitsPerBtc
+        );
+      }
+      return acc;
+    },
+    {}
+  );
+}
+function getPreferredConversionOverride(currencyAmountArg) {
+  if (isCurrencyAmountPreferenceObj(currencyAmountArg)) {
+    return {
+      unit: currencyAmountArg.preferred_currency_unit,
+      convertedValue: currencyAmountArg.preferred_currency_value_approx
+    };
+  } else if (isSDKCurrencyAmount(currencyAmountArg)) {
+    return {
+      unit: currencyAmountArg.preferredCurrencyUnit,
+      convertedValue: currencyAmountArg.preferredCurrencyValueApprox
+    };
+  }
+  return void 0;
+}
 function mapCurrencyAmount(currencyAmountArg, unitsPerBtc = 1) {
   const { value, unit } = getCurrencyAmount(currencyAmountArg);
-  const convert = convertCurrencyAmountValue;
-  const sats = convert(unit, CurrencyUnit.SATOSHI, value, unitsPerBtc);
-  const btc = convert(unit, CurrencyUnit.BITCOIN, value, unitsPerBtc);
-  const msats = convert(unit, CurrencyUnit.MILLISATOSHI, value, unitsPerBtc);
-  const usd = convert(unit, CurrencyUnit.USD, value, unitsPerBtc);
-  const mxn = convert(unit, CurrencyUnit.MXN, value, unitsPerBtc);
-  const mibtc = convert(unit, CurrencyUnit.MICROBITCOIN, value, unitsPerBtc);
-  const mlbtc = convert(unit, CurrencyUnit.MILLIBITCOIN, value, unitsPerBtc);
-  const nbtc = convert(unit, CurrencyUnit.NANOBITCOIN, value, unitsPerBtc);
+  const conversionOverride = getPreferredConversionOverride(currencyAmountArg);
+  const { sats, msats, btc, usd, mxn, php, mibtc, mlbtc, nbtc } = convertCurrencyAmountValues(unit, value, unitsPerBtc, conversionOverride);
   const mapWithCurrencyUnits = {
     [CurrencyUnit.BITCOIN]: btc,
     [CurrencyUnit.SATOSHI]: sats,
     [CurrencyUnit.MILLISATOSHI]: msats,
     [CurrencyUnit.USD]: usd,
     [CurrencyUnit.MXN]: mxn,
+    [CurrencyUnit.PHP]: php,
     [CurrencyUnit.MICROBITCOIN]: mibtc,
     [CurrencyUnit.MILLIBITCOIN]: mlbtc,
     [CurrencyUnit.NANOBITCOIN]: nbtc,
@@ -620,6 +668,10 @@ function mapCurrencyAmount(currencyAmountArg, unitsPerBtc = 1) {
         value: mxn,
         unit: CurrencyUnit.MXN
       }),
+      [CurrencyUnit.PHP]: formatCurrencyStr({
+        value: php,
+        unit: CurrencyUnit.PHP
+      }),
       [CurrencyUnit.FUTURE_VALUE]: "-"
     }
   };
@@ -674,8 +726,16 @@ var abbrCurrencyUnit = (unit) => {
       return "SAT";
     case CurrencyUnit.MILLISATOSHI:
       return "MSAT";
+    case CurrencyUnit.MILLIBITCOIN:
+      return "mBTC";
+    case CurrencyUnit.MICROBITCOIN:
+      return "\u03BCBTC";
     case CurrencyUnit.USD:
       return "USD";
+    case CurrencyUnit.MXN:
+      return "MXN";
+    case CurrencyUnit.PHP:
+      return "PHP";
   }
   return "Unsupported CurrencyUnit";
 };
@@ -683,7 +743,8 @@ var defaultOptions = {
   /* undefined indicates to use default precision for unit defined below */
   precision: void 0,
   compact: false,
-  showBtcSymbol: false
+  showBtcSymbol: false,
+  append: void 0
 };
 function formatCurrencyStr(amount, options) {
   const { precision, compact, showBtcSymbol } = {
@@ -693,7 +754,12 @@ function formatCurrencyStr(amount, options) {
   const currencyAmount = getCurrencyAmount(amount);
   let { value: num } = currencyAmount;
   const { unit } = currencyAmount;
-  if (unit === CurrencyUnit.USD) {
+  const centCurrencies = [
+    CurrencyUnit.USD,
+    CurrencyUnit.MXN,
+    CurrencyUnit.PHP
+  ];
+  if (centCurrencies.includes(unit)) {
     num = num / 100;
   }
   function getDefaultMaxFractionDigits(defaultDigits, fullPrecisionDigits) {
@@ -709,34 +775,52 @@ function formatCurrencyStr(amount, options) {
   }
   const symbol = !showBtcSymbol ? "" : unit === CurrencyUnit.BITCOIN ? "\uE903" : unit === CurrencyUnit.SATOSHI ? "\uE902" : "";
   const currentLocale = getCurrentLocale();
+  let formattedStr = "";
   switch (unit) {
+    case CurrencyUnit.MXN:
+    case CurrencyUnit.USD:
+    case CurrencyUnit.PHP:
+      formattedStr = num.toLocaleString(currentLocale, {
+        style: "currency",
+        currency: unit,
+        currencyDisplay: "narrowSymbol",
+        notation: compact ? "compact" : void 0,
+        maximumFractionDigits: getDefaultMaxFractionDigits(2, 2)
+      });
+      break;
     case CurrencyUnit.BITCOIN:
-      return `${symbol}${num.toLocaleString(currentLocale, {
+      formattedStr = `${symbol}${num.toLocaleString(currentLocale, {
         notation: compact ? "compact" : void 0,
         maximumFractionDigits: getDefaultMaxFractionDigits(4, 8)
       })}`;
+      break;
     case CurrencyUnit.SATOSHI:
-      return `${symbol}${num.toLocaleString(currentLocale, {
+      formattedStr = `${symbol}${num.toLocaleString(currentLocale, {
         notation: compact ? "compact" : void 0,
         maximumFractionDigits: getDefaultMaxFractionDigits(0, 3)
       })}`;
+      break;
     case CurrencyUnit.MILLISATOSHI:
     case CurrencyUnit.MICROBITCOIN:
     case CurrencyUnit.MILLIBITCOIN:
     case CurrencyUnit.NANOBITCOIN:
     default:
-      return `${symbol}${num.toLocaleString(currentLocale, {
+      formattedStr = `${symbol}${num.toLocaleString(currentLocale, {
         notation: compact ? "compact" : void 0,
         maximumFractionDigits: getDefaultMaxFractionDigits(0, 0)
       })}`;
-    case CurrencyUnit.USD:
-      return num.toLocaleString(currentLocale, {
-        style: "currency",
-        currency: defaultCurrencyCode,
-        notation: compact ? "compact" : void 0,
-        maximumFractionDigits: getDefaultMaxFractionDigits(2, 2)
-      });
   }
+  if (options?.appendUnits) {
+    const localeCurrencyCode = localeToCurrencyCode(currentLocale);
+    if (unit === localeCurrencyCode && !options.appendUnits.showForCurrentLocaleUnit) {
+      return formattedStr;
+    }
+    const unitStr = abbrCurrencyUnit(unit);
+    const unitSuffix = options.appendUnits.plural && num > 1 ? "s" : "";
+    const unitStrWithSuffix = `${unitStr}${unitSuffix}`;
+    formattedStr += ` ${options.appendUnits.lowercase ? unitStrWithSuffix.toLowerCase() : unitStrWithSuffix}`;
+  }
+  return formattedStr;
 }
 function separateCurrencyStrParts(currencyStr) {
   const symbol = currencyStr.replace(/[0-9\s\u00a0.,]/g, "");
@@ -983,10 +1067,12 @@ export {
   CurrencyUnit,
   convertCurrencyAmountValue,
   convertCurrencyAmount,
+  isCurrencyAmountInputObj,
   isDeprecatedCurrencyAmountObj,
   isCurrencyAmountObj,
   isCurrencyAmountPreferenceObj,
   isSDKCurrencyAmount,
+  getCurrencyAmount,
   mapCurrencyAmount,
   isCurrencyMap,
   abbrCurrencyUnit,

package/dist/{index-COxEW2dD.d.cts → index-r0bUxDu_.d.cts}

@@ -25,6 +25,7 @@ declare const CurrencyUnit: {
     readonly MILLIBITCOIN: "MILLIBITCOIN";
     readonly USD: "USD";
     readonly MXN: "MXN";
+    readonly PHP: "PHP";
     readonly Bitcoin: "BITCOIN";
     readonly Microbitcoin: "MICROBITCOIN";
     readonly Millibitcoin: "MILLIBITCOIN";
@@ -33,6 +34,7 @@ declare const CurrencyUnit: {
     readonly Satoshi: "SATOSHI";
     readonly Usd: "USD";
     readonly Mxn: "MXN";
+    readonly Php: "PHP";
 };
 type CurrencyUnitType = (typeof CurrencyUnit)[keyof typeof CurrencyUnit];
 type SDKCurrencyAmountType = {
@@ -56,6 +58,7 @@ type CurrencyMap = {
     [CurrencyUnit.NANOBITCOIN]: number;
     [CurrencyUnit.USD]: number;
     [CurrencyUnit.MXN]: number;
+    [CurrencyUnit.PHP]: number;
     [CurrencyUnit.FUTURE_VALUE]: number;
     formatted: {
         sats: string;
@@ -69,6 +72,7 @@ type CurrencyMap = {
         [CurrencyUnit.NANOBITCOIN]: string;
         [CurrencyUnit.USD]: string;
         [CurrencyUnit.MXN]: string;
+        [CurrencyUnit.PHP]: string;
         [CurrencyUnit.FUTURE_VALUE]: string;
     };
     isZero: boolean;
@@ -77,33 +81,50 @@ type CurrencyMap = {
     isEqualTo: (other: CurrencyMap | CurrencyAmountObj | number) => boolean;
     type: "CurrencyMap";
 };
+type CurrencyAmountInputObj = {
+    value: number | string | null;
+    unit: CurrencyUnitType;
+};
 type DeprecatedCurrencyAmountObj = {
-    value?: number | string | null;
+    value?: number;
     unit?: CurrencyUnitType;
-    __typename?: "CurrencyAmount" | undefined;
+    __typename?: "CurrencyAmount";
 };
 type CurrencyAmountObj = {
-    original_value?: number | string | null;
+    original_value?: number;
     original_unit?: CurrencyUnitType;
-    __typename?: "CurrencyAmount" | undefined;
+    __typename?: "CurrencyAmount";
 };
 type CurrencyAmountPreferenceObj = {
-    preferred_currency_unit?: CurrencyUnitType;
-    preferred_currency_value_rounded?: number | string | null;
-    __typename?: "CurrencyAmount" | undefined;
+    original_value: number;
+    original_unit: CurrencyUnitType;
+    preferred_currency_unit: CurrencyUnitType;
+    preferred_currency_value_approx: number;
+    __typename?: "CurrencyAmount";
 };
-type CurrencyAmountArg = DeprecatedCurrencyAmountObj | CurrencyAmountObj | CurrencyAmountPreferenceObj | SDKCurrencyAmountType | undefined | null;
+type CurrencyAmountArg = CurrencyAmountInputObj | DeprecatedCurrencyAmountObj | CurrencyAmountObj | CurrencyAmountPreferenceObj | SDKCurrencyAmountType | undefined | null;
+declare function isCurrencyAmountInputObj(arg: unknown): arg is CurrencyAmountInputObj;
 declare function isDeprecatedCurrencyAmountObj(arg: unknown): arg is DeprecatedCurrencyAmountObj;
 declare function isCurrencyAmountObj(arg: unknown): arg is CurrencyAmountObj;
 declare function isCurrencyAmountPreferenceObj(arg: unknown): arg is CurrencyAmountPreferenceObj;
 declare function isSDKCurrencyAmount(arg: unknown): arg is SDKCurrencyAmountType;
+declare function getCurrencyAmount(currencyAmountArg: CurrencyAmountArg): {
+    value: number;
+    unit: CurrencyUnitType;
+};
 declare function mapCurrencyAmount(currencyAmountArg: CurrencyAmountArg, unitsPerBtc?: number): CurrencyMap;
 declare const isCurrencyMap: (currencyMap: unknown) => currencyMap is CurrencyMap;
-declare const abbrCurrencyUnit: (unit: CurrencyUnitType) => "USD" | "BTC" | "SAT" | "MSAT" | "Unsupported CurrencyUnit";
+declare const abbrCurrencyUnit: (unit: CurrencyUnitType) => "USD" | "MXN" | "PHP" | "BTC" | "SAT" | "MSAT" | "mBTC" | "μBTC" | "Unsupported CurrencyUnit";
+type AppendUnitsOptions = {
+    plural?: boolean | undefined;
+    lowercase?: boolean | undefined;
+    showForCurrentLocaleUnit?: boolean | undefined;
+};
 type FormatCurrencyStrOptions = {
     precision?: number | "full" | undefined;
     compact?: boolean | undefined;
     showBtcSymbol?: boolean | undefined;
+    appendUnits?: AppendUnitsOptions | undefined;
 };
 declare function formatCurrencyStr(amount: CurrencyAmountArg, options?: FormatCurrencyStrOptions): string;
 declare function separateCurrencyStrParts(currencyStr: string): {
@@ -266,4 +287,4 @@ declare function lsidToUUID(lsid: string): string;
 declare function isUint8Array(value: unknown): value is Uint8Array;
 declare function isObject(value: unknown): value is Record<string, unknown>;
 
-export { isUint8Array as $, isTest as A, isError as B, ConfigKeys as C, type DeprecatedCurrencyAmountObj as D, isErrorWithMessage as E, getErrorMsg as F, isErrorMsg as G, errorToJSON as H, bytesToHex as I, hexToBytes as J, getCurrentLocale as K, countryCodesToCurrencyCodes as L, type CurrencyLocales as M, type CurrencyCodes as N, localeToCurrencyCode as O, getLocalStorageConfigItem as P, getLocalStorageBoolean as Q, setLocalStorageBoolean as R, type SDKCurrencyAmountType as S, deleteLocalStorageItem as T, clamp as U, linearInterpolate as V, round as W, isNumber as X, pollUntil as Y, sleep as Z, lsidToUUID as _, b64encode as a, isObject as a0, type Maybe as a1, type ExpandRecursively as a2, type ById as a3, type OmitTypename as a4, isType as a5, type DeepPartial as a6, type JSONLiteral as a7, type JSONType as a8, type JSONObject as a9, type NN as aa, notNullUndefined as ab, type PartialBy as ac, type Complete as ad, type RequiredKeys as ae, b64decode as b, createSha256Hash as c, defaultCurrencyCode as d, ensureArray as e, CurrencyUnit as f, type CurrencyUnitType as g, convertCurrencyAmountValue as h, convertCurrencyAmount as i, type CurrencyMap as j, type CurrencyAmountObj as k, type CurrencyAmountPreferenceObj as l, type CurrencyAmountArg as m, isDeprecatedCurrencyAmountObj as n, isCurrencyAmountObj as o, isCurrencyAmountPreferenceObj as p, isSDKCurrencyAmount as q, mapCurrencyAmount as r, isCurrencyMap as s, abbrCurrencyUnit as t, urlsafe_b64decode as u, formatCurrencyStr as v, separateCurrencyStrParts as w, localeToCurrencySymbol as x, isBrowser as y, isNode as z };
+export { isNumber as $, type AppendUnitsOptions as A, localeToCurrencySymbol as B, ConfigKeys as C, type DeprecatedCurrencyAmountObj as D, isBrowser as E, isNode as F, isTest as G, isError as H, isErrorWithMessage as I, getErrorMsg as J, isErrorMsg as K, errorToJSON as L, bytesToHex as M, hexToBytes as N, getCurrentLocale as O, countryCodesToCurrencyCodes as P, type CurrencyLocales as Q, type CurrencyCodes as R, type SDKCurrencyAmountType as S, localeToCurrencyCode as T, getLocalStorageConfigItem as U, getLocalStorageBoolean as V, setLocalStorageBoolean as W, deleteLocalStorageItem as X, clamp as Y, linearInterpolate as Z, round as _, b64encode as a, pollUntil as a0, sleep as a1, lsidToUUID as a2, isUint8Array as a3, isObject as a4, type Maybe as a5, type ExpandRecursively as a6, type ById as a7, type OmitTypename as a8, isType as a9, type DeepPartial as aa, type JSONLiteral as ab, type JSONType as ac, type JSONObject as ad, type NN as ae, notNullUndefined as af, type PartialBy as ag, type Complete as ah, type RequiredKeys as ai, b64decode as b, createSha256Hash as c, defaultCurrencyCode as d, ensureArray as e, CurrencyUnit as f, type CurrencyUnitType as g, convertCurrencyAmountValue as h, convertCurrencyAmount as i, type CurrencyMap as j, type CurrencyAmountInputObj as k, type CurrencyAmountObj as l, type CurrencyAmountPreferenceObj as m, type CurrencyAmountArg as n, isCurrencyAmountInputObj as o, isDeprecatedCurrencyAmountObj as p, isCurrencyAmountObj as q, isCurrencyAmountPreferenceObj as r, isSDKCurrencyAmount as s, getCurrencyAmount as t, urlsafe_b64decode as u, mapCurrencyAmount as v, isCurrencyMap as w, abbrCurrencyUnit as x, formatCurrencyStr as y, separateCurrencyStrParts as z };

package/dist/{index-COxEW2dD.d.ts → index-r0bUxDu_.d.ts}

@@ -25,6 +25,7 @@ declare const CurrencyUnit: {
     readonly MILLIBITCOIN: "MILLIBITCOIN";
     readonly USD: "USD";
     readonly MXN: "MXN";
+    readonly PHP: "PHP";
     readonly Bitcoin: "BITCOIN";
     readonly Microbitcoin: "MICROBITCOIN";
     readonly Millibitcoin: "MILLIBITCOIN";
@@ -33,6 +34,7 @@ declare const CurrencyUnit: {
     readonly Satoshi: "SATOSHI";
     readonly Usd: "USD";
     readonly Mxn: "MXN";
+    readonly Php: "PHP";
 };
 type CurrencyUnitType = (typeof CurrencyUnit)[keyof typeof CurrencyUnit];
 type SDKCurrencyAmountType = {
@@ -56,6 +58,7 @@ type CurrencyMap = {
     [CurrencyUnit.NANOBITCOIN]: number;
     [CurrencyUnit.USD]: number;
     [CurrencyUnit.MXN]: number;
+    [CurrencyUnit.PHP]: number;
     [CurrencyUnit.FUTURE_VALUE]: number;
     formatted: {
         sats: string;
@@ -69,6 +72,7 @@ type CurrencyMap = {
         [CurrencyUnit.NANOBITCOIN]: string;
         [CurrencyUnit.USD]: string;
         [CurrencyUnit.MXN]: string;
+        [CurrencyUnit.PHP]: string;
         [CurrencyUnit.FUTURE_VALUE]: string;
     };
     isZero: boolean;
@@ -77,33 +81,50 @@ type CurrencyMap = {
     isEqualTo: (other: CurrencyMap | CurrencyAmountObj | number) => boolean;
     type: "CurrencyMap";
 };
+type CurrencyAmountInputObj = {
+    value: number | string | null;
+    unit: CurrencyUnitType;
+};
 type DeprecatedCurrencyAmountObj = {
-    value?: number | string | null;
+    value?: number;
     unit?: CurrencyUnitType;
-    __typename?: "CurrencyAmount" | undefined;
+    __typename?: "CurrencyAmount";
 };
 type CurrencyAmountObj = {
-    original_value?: number | string | null;
+    original_value?: number;
     original_unit?: CurrencyUnitType;
-    __typename?: "CurrencyAmount" | undefined;
+    __typename?: "CurrencyAmount";
 };
 type CurrencyAmountPreferenceObj = {
-    preferred_currency_unit?: CurrencyUnitType;
-    preferred_currency_value_rounded?: number | string | null;
-    __typename?: "CurrencyAmount" | undefined;
+    original_value: number;
+    original_unit: CurrencyUnitType;
+    preferred_currency_unit: CurrencyUnitType;
+    preferred_currency_value_approx: number;
+    __typename?: "CurrencyAmount";
 };
-type CurrencyAmountArg = DeprecatedCurrencyAmountObj | CurrencyAmountObj | CurrencyAmountPreferenceObj | SDKCurrencyAmountType | undefined | null;
+type CurrencyAmountArg = CurrencyAmountInputObj | DeprecatedCurrencyAmountObj | CurrencyAmountObj | CurrencyAmountPreferenceObj | SDKCurrencyAmountType | undefined | null;
+declare function isCurrencyAmountInputObj(arg: unknown): arg is CurrencyAmountInputObj;
 declare function isDeprecatedCurrencyAmountObj(arg: unknown): arg is DeprecatedCurrencyAmountObj;
 declare function isCurrencyAmountObj(arg: unknown): arg is CurrencyAmountObj;
 declare function isCurrencyAmountPreferenceObj(arg: unknown): arg is CurrencyAmountPreferenceObj;
 declare function isSDKCurrencyAmount(arg: unknown): arg is SDKCurrencyAmountType;
+declare function getCurrencyAmount(currencyAmountArg: CurrencyAmountArg): {
+    value: number;
+    unit: CurrencyUnitType;
+};
 declare function mapCurrencyAmount(currencyAmountArg: CurrencyAmountArg, unitsPerBtc?: number): CurrencyMap;
 declare const isCurrencyMap: (currencyMap: unknown) => currencyMap is CurrencyMap;
-declare const abbrCurrencyUnit: (unit: CurrencyUnitType) => "USD" | "BTC" | "SAT" | "MSAT" | "Unsupported CurrencyUnit";
+declare const abbrCurrencyUnit: (unit: CurrencyUnitType) => "USD" | "MXN" | "PHP" | "BTC" | "SAT" | "MSAT" | "mBTC" | "μBTC" | "Unsupported CurrencyUnit";
+type AppendUnitsOptions = {
+    plural?: boolean | undefined;
+    lowercase?: boolean | undefined;
+    showForCurrentLocaleUnit?: boolean | undefined;
+};
 type FormatCurrencyStrOptions = {
     precision?: number | "full" | undefined;
     compact?: boolean | undefined;
     showBtcSymbol?: boolean | undefined;
+    appendUnits?: AppendUnitsOptions | undefined;
 };
 declare function formatCurrencyStr(amount: CurrencyAmountArg, options?: FormatCurrencyStrOptions): string;
 declare function separateCurrencyStrParts(currencyStr: string): {
@@ -266,4 +287,4 @@ declare function lsidToUUID(lsid: string): string;
 declare function isUint8Array(value: unknown): value is Uint8Array;
 declare function isObject(value: unknown): value is Record<string, unknown>;
 
-export { isUint8Array as $, isTest as A, isError as B, ConfigKeys as C, type DeprecatedCurrencyAmountObj as D, isErrorWithMessage as E, getErrorMsg as F, isErrorMsg as G, errorToJSON as H, bytesToHex as I, hexToBytes as J, getCurrentLocale as K, countryCodesToCurrencyCodes as L, type CurrencyLocales as M, type CurrencyCodes as N, localeToCurrencyCode as O, getLocalStorageConfigItem as P, getLocalStorageBoolean as Q, setLocalStorageBoolean as R, type SDKCurrencyAmountType as S, deleteLocalStorageItem as T, clamp as U, linearInterpolate as V, round as W, isNumber as X, pollUntil as Y, sleep as Z, lsidToUUID as _, b64encode as a, isObject as a0, type Maybe as a1, type ExpandRecursively as a2, type ById as a3, type OmitTypename as a4, isType as a5, type DeepPartial as a6, type JSONLiteral as a7, type JSONType as a8, type JSONObject as a9, type NN as aa, notNullUndefined as ab, type PartialBy as ac, type Complete as ad, type RequiredKeys as ae, b64decode as b, createSha256Hash as c, defaultCurrencyCode as d, ensureArray as e, CurrencyUnit as f, type CurrencyUnitType as g, convertCurrencyAmountValue as h, convertCurrencyAmount as i, type CurrencyMap as j, type CurrencyAmountObj as k, type CurrencyAmountPreferenceObj as l, type CurrencyAmountArg as m, isDeprecatedCurrencyAmountObj as n, isCurrencyAmountObj as o, isCurrencyAmountPreferenceObj as p, isSDKCurrencyAmount as q, mapCurrencyAmount as r, isCurrencyMap as s, abbrCurrencyUnit as t, urlsafe_b64decode as u, formatCurrencyStr as v, separateCurrencyStrParts as w, localeToCurrencySymbol as x, isBrowser as y, isNode as z };
+export { isNumber as $, type AppendUnitsOptions as A, localeToCurrencySymbol as B, ConfigKeys as C, type DeprecatedCurrencyAmountObj as D, isBrowser as E, isNode as F, isTest as G, isError as H, isErrorWithMessage as I, getErrorMsg as J, isErrorMsg as K, errorToJSON as L, bytesToHex as M, hexToBytes as N, getCurrentLocale as O, countryCodesToCurrencyCodes as P, type CurrencyLocales as Q, type CurrencyCodes as R, type SDKCurrencyAmountType as S, localeToCurrencyCode as T, getLocalStorageConfigItem as U, getLocalStorageBoolean as V, setLocalStorageBoolean as W, deleteLocalStorageItem as X, clamp as Y, linearInterpolate as Z, round as _, b64encode as a, pollUntil as a0, sleep as a1, lsidToUUID as a2, isUint8Array as a3, isObject as a4, type Maybe as a5, type ExpandRecursively as a6, type ById as a7, type OmitTypename as a8, isType as a9, type DeepPartial as aa, type JSONLiteral as ab, type JSONType as ac, type JSONObject as ad, type NN as ae, notNullUndefined as af, type PartialBy as ag, type Complete as ah, type RequiredKeys as ai, b64decode as b, createSha256Hash as c, defaultCurrencyCode as d, ensureArray as e, CurrencyUnit as f, type CurrencyUnitType as g, convertCurrencyAmountValue as h, convertCurrencyAmount as i, type CurrencyMap as j, type CurrencyAmountInputObj as k, type CurrencyAmountObj as l, type CurrencyAmountPreferenceObj as m, type CurrencyAmountArg as n, isCurrencyAmountInputObj as o, isDeprecatedCurrencyAmountObj as p, isCurrencyAmountObj as q, isCurrencyAmountPreferenceObj as r, isSDKCurrencyAmount as s, getCurrencyAmount as t, urlsafe_b64decode as u, mapCurrencyAmount as v, isCurrencyMap as w, abbrCurrencyUnit as x, formatCurrencyStr as y, separateCurrencyStrParts as z };