@w3ux/utils 0.10.1-alpha.4 → 1.0.0-alpha.0

package/base.cjs

@@ -35,6 +35,19 @@ __export(base_exports, {
 });
 module.exports = __toCommonJS(base_exports);
 var import_substrate_bindings = require("@polkadot-api/substrate-bindings");
+var minDecimalPlaces = (val, minDecimals) => {
+  try {
+    const retainCommas = typeof val === "string" && val.includes(",");
+    const strVal = typeof val === "string" ? val.replace(/,/g, "") : val.toString();
+    const [integerPart, fractionalPart = ""] = strVal.split(".");
+    const whole = BigInt(integerPart || "0");
+    const missingDecimals = minDecimals - fractionalPart.length;
+    const formattedWhole = retainCommas ? Intl.NumberFormat("en-US").format(whole) : whole.toString();
+    return missingDecimals > 0 ? `${formattedWhole}.${fractionalPart}${"0".repeat(missingDecimals)}` : `${formattedWhole}.${fractionalPart}`;
+  } catch (e) {
+    return "0";
+  }
+};
 var camelize = (str) => {
   const convertToString = (string) => {
     if (string) {
@@ -89,16 +102,6 @@ var ellipsisFn = (str, amount = 6, position = "center") => {
     return "..." + str.slice(amount);
   }
 };
-var minDecimalPlaces = (val, minDecimals) => {
-  try {
-    const whole = BigInt(rmCommas(val).split(".")[0] || "0");
-    const decimals = val.split(".")[1] || "";
-    const missingDecimals = minDecimals - decimals.length;
-    return missingDecimals > 0 ? `${whole.toString()}.${decimals}${"0".repeat(missingDecimals)}` : val;
-  } catch (e) {
-    return "0";
-  }
-};
 var pageFromUri = (pathname, fallback) => {
   const lastUriItem = pathname.substring(pathname.lastIndexOf("/") + 1);
   const page = lastUriItem.trim() === "" ? fallback : lastUriItem;

package/base.d.cts

@@ -1,5 +1,24 @@
 import { AnyFunction } from '@w3ux/types';
 
+/**
+ * Ensures a number has at least the specified number of decimal places, retaining commas in the output if they are present in the input.
+ *
+ * @function minDecimalPlaces
+ * @param {string | number | BigInt} val - The input number, which can be a `string` with or without commas, a `number`, or a `BigInt`.
+ * @param {number} minDecimals - The minimum number of decimal places to enforce.
+ * @returns {string} The formatted number as a string, padded with zeros if needed to meet `minDecimals`, retaining commas if originally provided.
+ *                    If `val` is invalid, returns "0".
+ * @example
+ * // Pads "1,234.5" to have at least 3 decimal places, with commas
+ * minDecimalPlaces("1,234.5", 3); // returns "1,234.500"
+ *
+ * // Returns "1234.56" unchanged
+ * minDecimalPlaces(1234.56, 2); // returns "1234.56"
+ *
+ * // Pads BigInt 1234 with 2 decimals
+ * minDecimalPlaces(BigInt(1234), 2); // returns "1234.00"
+ */
+declare const minDecimalPlaces: (val: string | number | bigint, minDecimals: number) => string;
 /**
  * @name camelize
  * @summary Converts a string of text to camelCase.
@@ -14,11 +33,6 @@ declare const camelize: (str: string) => string;
  * same for beginning and end; if "start" or "end" then its only once the amount; defaults to "start"
  */
 declare const ellipsisFn: (str: string, amount?: number, position?: "start" | "end" | "center") => string;
-/**
- * @name minDecimalPlaces
- * @summary Forces a number to have at least the provided decimal places.
- */
-declare const minDecimalPlaces: (val: string, minDecimals: number) => string;
 /**
  * @name pageFromUri
  * @summary Use url variables to load the default components upon the first page visit.

package/base.d.ts

@@ -1,5 +1,24 @@
 import { AnyFunction } from '@w3ux/types';
 
+/**
+ * Ensures a number has at least the specified number of decimal places, retaining commas in the output if they are present in the input.
+ *
+ * @function minDecimalPlaces
+ * @param {string | number | BigInt} val - The input number, which can be a `string` with or without commas, a `number`, or a `BigInt`.
+ * @param {number} minDecimals - The minimum number of decimal places to enforce.
+ * @returns {string} The formatted number as a string, padded with zeros if needed to meet `minDecimals`, retaining commas if originally provided.
+ *                    If `val` is invalid, returns "0".
+ * @example
+ * // Pads "1,234.5" to have at least 3 decimal places, with commas
+ * minDecimalPlaces("1,234.5", 3); // returns "1,234.500"
+ *
+ * // Returns "1234.56" unchanged
+ * minDecimalPlaces(1234.56, 2); // returns "1234.56"
+ *
+ * // Pads BigInt 1234 with 2 decimals
+ * minDecimalPlaces(BigInt(1234), 2); // returns "1234.00"
+ */
+declare const minDecimalPlaces: (val: string | number | bigint, minDecimals: number) => string;
 /**
  * @name camelize
  * @summary Converts a string of text to camelCase.
@@ -14,11 +33,6 @@ declare const camelize: (str: string) => string;
  * same for beginning and end; if "start" or "end" then its only once the amount; defaults to "start"
  */
 declare const ellipsisFn: (str: string, amount?: number, position?: "start" | "end" | "center") => string;
-/**
- * @name minDecimalPlaces
- * @summary Forces a number to have at least the provided decimal places.
- */
-declare const minDecimalPlaces: (val: string, minDecimals: number) => string;
 /**
  * @name pageFromUri
  * @summary Use url variables to load the default components upon the first page visit.

package/base.js

@@ -1,5 +1,18 @@
 // src/base.ts
 import { AccountId } from "@polkadot-api/substrate-bindings";
+var minDecimalPlaces = (val, minDecimals) => {
+  try {
+    const retainCommas = typeof val === "string" && val.includes(",");
+    const strVal = typeof val === "string" ? val.replace(/,/g, "") : val.toString();
+    const [integerPart, fractionalPart = ""] = strVal.split(".");
+    const whole = BigInt(integerPart || "0");
+    const missingDecimals = minDecimals - fractionalPart.length;
+    const formattedWhole = retainCommas ? Intl.NumberFormat("en-US").format(whole) : whole.toString();
+    return missingDecimals > 0 ? `${formattedWhole}.${fractionalPart}${"0".repeat(missingDecimals)}` : `${formattedWhole}.${fractionalPart}`;
+  } catch (e) {
+    return "0";
+  }
+};
 var camelize = (str) => {
   const convertToString = (string) => {
     if (string) {
@@ -54,16 +67,6 @@ var ellipsisFn = (str, amount = 6, position = "center") => {
     return "..." + str.slice(amount);
   }
 };
-var minDecimalPlaces = (val, minDecimals) => {
-  try {
-    const whole = BigInt(rmCommas(val).split(".")[0] || "0");
-    const decimals = val.split(".")[1] || "";
-    const missingDecimals = minDecimals - decimals.length;
-    return missingDecimals > 0 ? `${whole.toString()}.${decimals}${"0".repeat(missingDecimals)}` : val;
-  } catch (e) {
-    return "0";
-  }
-};
 var pageFromUri = (pathname, fallback) => {
   const lastUriItem = pathname.substring(pathname.lastIndexOf("/") + 1);
   const page = lastUriItem.trim() === "" ? fallback : lastUriItem;

package/index.cjs

@@ -71,6 +71,19 @@ module.exports = __toCommonJS(src_exports);
 
 // src/base.ts
 var import_substrate_bindings = require("@polkadot-api/substrate-bindings");
+var minDecimalPlaces = (val, minDecimals) => {
+  try {
+    const retainCommas = typeof val === "string" && val.includes(",");
+    const strVal = typeof val === "string" ? val.replace(/,/g, "") : val.toString();
+    const [integerPart, fractionalPart = ""] = strVal.split(".");
+    const whole = BigInt(integerPart || "0");
+    const missingDecimals = minDecimals - fractionalPart.length;
+    const formattedWhole = retainCommas ? Intl.NumberFormat("en-US").format(whole) : whole.toString();
+    return missingDecimals > 0 ? `${formattedWhole}.${fractionalPart}${"0".repeat(missingDecimals)}` : `${formattedWhole}.${fractionalPart}`;
+  } catch (e) {
+    return "0";
+  }
+};
 var camelize = (str) => {
   const convertToString = (string) => {
     if (string) {
@@ -125,16 +138,6 @@ var ellipsisFn = (str, amount = 6, position = "center") => {
     return "..." + str.slice(amount);
   }
 };
-var minDecimalPlaces = (val, minDecimals) => {
-  try {
-    const whole = BigInt(rmCommas(val).split(".")[0] || "0");
-    const decimals = val.split(".")[1] || "";
-    const missingDecimals = minDecimals - decimals.length;
-    return missingDecimals > 0 ? `${whole.toString()}.${decimals}${"0".repeat(missingDecimals)}` : val;
-  } catch (e) {
-    return "0";
-  }
-};
 var pageFromUri = (pathname, fallback) => {
   const lastUriItem = pathname.substring(pathname.lastIndexOf("/") + 1);
   const page = lastUriItem.trim() === "" ? fallback : lastUriItem;
@@ -334,7 +337,6 @@ function u8aUnwrapBytes(bytes) {
 
 // src/unit.ts
 var import_substrate_bindings2 = require("@polkadot-api/substrate-bindings");
-var remToUnit = (rem) => Number(rem.slice(0, rem.length - 3)) * parseFloat(getComputedStyle(document.documentElement).fontSize);
 var planckToUnit = (val, units) => {
   try {
     units = Math.max(units, 0);
@@ -363,6 +365,7 @@ var unitToPlanck = (val, units) => {
     return BigInt(0);
   }
 };
+var remToUnit = (rem) => Number(rem.slice(0, rem.length - 3)) * parseFloat(getComputedStyle(document.documentElement).fontSize);
 var capitalizeFirstLetter = (string) => string.charAt(0).toUpperCase() + string.slice(1);
 var snakeToCamel = (str) => str.toLowerCase().replace(
   /([-_][a-z])/g,

package/index.js

@@ -1,5 +1,18 @@
 // src/base.ts
 import { AccountId } from "@polkadot-api/substrate-bindings";
+var minDecimalPlaces = (val, minDecimals) => {
+  try {
+    const retainCommas = typeof val === "string" && val.includes(",");
+    const strVal = typeof val === "string" ? val.replace(/,/g, "") : val.toString();
+    const [integerPart, fractionalPart = ""] = strVal.split(".");
+    const whole = BigInt(integerPart || "0");
+    const missingDecimals = minDecimals - fractionalPart.length;
+    const formattedWhole = retainCommas ? Intl.NumberFormat("en-US").format(whole) : whole.toString();
+    return missingDecimals > 0 ? `${formattedWhole}.${fractionalPart}${"0".repeat(missingDecimals)}` : `${formattedWhole}.${fractionalPart}`;
+  } catch (e) {
+    return "0";
+  }
+};
 var camelize = (str) => {
   const convertToString = (string) => {
     if (string) {
@@ -54,16 +67,6 @@ var ellipsisFn = (str, amount = 6, position = "center") => {
     return "..." + str.slice(amount);
   }
 };
-var minDecimalPlaces = (val, minDecimals) => {
-  try {
-    const whole = BigInt(rmCommas(val).split(".")[0] || "0");
-    const decimals = val.split(".")[1] || "";
-    const missingDecimals = minDecimals - decimals.length;
-    return missingDecimals > 0 ? `${whole.toString()}.${decimals}${"0".repeat(missingDecimals)}` : val;
-  } catch (e) {
-    return "0";
-  }
-};
 var pageFromUri = (pathname, fallback) => {
   const lastUriItem = pathname.substring(pathname.lastIndexOf("/") + 1);
   const page = lastUriItem.trim() === "" ? fallback : lastUriItem;
@@ -263,7 +266,6 @@ function u8aUnwrapBytes(bytes) {
 
 // src/unit.ts
 import { AccountId as AccountId2 } from "@polkadot-api/substrate-bindings";
-var remToUnit = (rem) => Number(rem.slice(0, rem.length - 3)) * parseFloat(getComputedStyle(document.documentElement).fontSize);
 var planckToUnit = (val, units) => {
   try {
     units = Math.max(units, 0);
@@ -292,6 +294,7 @@ var unitToPlanck = (val, units) => {
     return BigInt(0);
   }
 };
+var remToUnit = (rem) => Number(rem.slice(0, rem.length - 3)) * parseFloat(getComputedStyle(document.documentElement).fontSize);
 var capitalizeFirstLetter = (string) => string.charAt(0).toUpperCase() + string.slice(1);
 var snakeToCamel = (str) => str.toLowerCase().replace(
   /([-_][a-z])/g,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@w3ux/utils",
-  "version": "0.10.1-alpha.4",
+  "version": "1.0.0-alpha.0",
   "license": "GPL-3.0-only",
   "dependencies": {
     "@polkadot-api/substrate-bindings": "^0.9.3"

package/unit.cjs

@@ -233,7 +233,6 @@ var ellipsisFn = (str, amount = 6, position = "center") => {
 
 // src/unit.ts
 var import_substrate_bindings2 = require("@polkadot-api/substrate-bindings");
-var remToUnit = (rem) => Number(rem.slice(0, rem.length - 3)) * parseFloat(getComputedStyle(document.documentElement).fontSize);
 var planckToUnit = (val, units) => {
   try {
     units = Math.max(units, 0);
@@ -262,6 +261,7 @@ var unitToPlanck = (val, units) => {
     return BigInt(0);
   }
 };
+var remToUnit = (rem) => Number(rem.slice(0, rem.length - 3)) * parseFloat(getComputedStyle(document.documentElement).fontSize);
 var capitalizeFirstLetter = (string) => string.charAt(0).toUpperCase() + string.slice(1);
 var snakeToCamel = (str) => str.toLowerCase().replace(
   /([-_][a-z])/g,

package/unit.d.cts

@@ -3,26 +3,34 @@ import { AnyObject } from './types.cjs';
 import { AnyJson } from '@w3ux/types';
 
 /**
- * @name remToUnit
- * @summary Converts a rem string to a number.
- */
-declare const remToUnit: (rem: string) => number;
-/**
- * @name planckToUnit
- * @summary Convert planck to the token unit.
- * @description
- * Converts an on-chain balance value from `number`, `BigInt`, or `string` (representing planck)
- * to a decimal value in token units. (1 token = 10^units planck).
+ * Converts an on-chain balance value from planck to a decimal value in token units.
+ *
+ * @function planckToUnit
+ * @param {number | BigInt | string} val - The balance value in planck. Accepts a `number`, `BigInt`, or `string`.
+ * @param {number} units - The number of decimal places in the token unit (10^units planck per 1 token).
+ * @returns {string} The equivalent token unit value as a decimal string.
+ * @example
+ * // Convert 1500000000000 planck to tokens with 12 decimal places
+ * planckToUnit("1500000000000", 12); // returns "1.5"
  */
 declare const planckToUnit: (val: number | bigint | string, units: number) => string;
 /**
- * @name unitToPlanck
- * @summary Convert token unit to planck.
- * @description
- * Converts a token unit value (as `string`, `number`, or `BigInt`) to an integer value in planck.
- * (1 token = 10^units planck).
+ * Converts a token unit value to an integer value in planck.
+ *
+ * @function unitToPlanck
+ * @param {string | number | BigInt} val - The token unit value to convert. Accepts a string, number, or BigInt.
+ * @param {number} units - The number of decimal places for conversion (10^units planck per 1 token).
+ * @returns {BigInt} The equivalent value in planck as a BigInt.
+ * @example
+ * // Convert "1.5" tokens to planck with 12 decimal places
+ * unitToPlanck("1.5", 12); // returns BigInt("1500000000000")
  */
 declare const unitToPlanck: (val: string | number | bigint, units: number) => bigint;
+/**
+ * @name remToUnit
+ * @summary Converts a rem string to a number.
+ */
+declare const remToUnit: (rem: string) => number;
 /**
  * @name capitalizeFirstLetter
  * @summary Capitalize the first letter of a string.

package/unit.d.ts

@@ -3,26 +3,34 @@ import { AnyObject } from './types.js';
 import { AnyJson } from '@w3ux/types';
 
 /**
- * @name remToUnit
- * @summary Converts a rem string to a number.
- */
-declare const remToUnit: (rem: string) => number;
-/**
- * @name planckToUnit
- * @summary Convert planck to the token unit.
- * @description
- * Converts an on-chain balance value from `number`, `BigInt`, or `string` (representing planck)
- * to a decimal value in token units. (1 token = 10^units planck).
+ * Converts an on-chain balance value from planck to a decimal value in token units.
+ *
+ * @function planckToUnit
+ * @param {number | BigInt | string} val - The balance value in planck. Accepts a `number`, `BigInt`, or `string`.
+ * @param {number} units - The number of decimal places in the token unit (10^units planck per 1 token).
+ * @returns {string} The equivalent token unit value as a decimal string.
+ * @example
+ * // Convert 1500000000000 planck to tokens with 12 decimal places
+ * planckToUnit("1500000000000", 12); // returns "1.5"
  */
 declare const planckToUnit: (val: number | bigint | string, units: number) => string;
 /**
- * @name unitToPlanck
- * @summary Convert token unit to planck.
- * @description
- * Converts a token unit value (as `string`, `number`, or `BigInt`) to an integer value in planck.
- * (1 token = 10^units planck).
+ * Converts a token unit value to an integer value in planck.
+ *
+ * @function unitToPlanck
+ * @param {string | number | BigInt} val - The token unit value to convert. Accepts a string, number, or BigInt.
+ * @param {number} units - The number of decimal places for conversion (10^units planck per 1 token).
+ * @returns {BigInt} The equivalent value in planck as a BigInt.
+ * @example
+ * // Convert "1.5" tokens to planck with 12 decimal places
+ * unitToPlanck("1.5", 12); // returns BigInt("1500000000000")
  */
 declare const unitToPlanck: (val: string | number | bigint, units: number) => bigint;
+/**
+ * @name remToUnit
+ * @summary Converts a rem string to a number.
+ */
+declare const remToUnit: (rem: string) => number;
 /**
  * @name capitalizeFirstLetter
  * @summary Capitalize the first letter of a string.

package/unit.js

@@ -175,7 +175,6 @@ var ellipsisFn = (str, amount = 6, position = "center") => {
 
 // src/unit.ts
 import { AccountId as AccountId2 } from "@polkadot-api/substrate-bindings";
-var remToUnit = (rem) => Number(rem.slice(0, rem.length - 3)) * parseFloat(getComputedStyle(document.documentElement).fontSize);
 var planckToUnit = (val, units) => {
   try {
     units = Math.max(units, 0);
@@ -204,6 +203,7 @@ var unitToPlanck = (val, units) => {
     return BigInt(0);
   }
 };
+var remToUnit = (rem) => Number(rem.slice(0, rem.length - 3)) * parseFloat(getComputedStyle(document.documentElement).fontSize);
 var capitalizeFirstLetter = (string) => string.charAt(0).toUpperCase() + string.slice(1);
 var snakeToCamel = (str) => str.toLowerCase().replace(
   /([-_][a-z])/g,