@w3ux/utils 2.1.0 → 2.2.0

package/unit.cjs

@@ -1,282 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/unit.ts
-var unit_exports = {};
-__export(unit_exports, {
-  addedTo: () => addedTo,
-  applyWidthAsPadding: () => applyWidthAsPadding,
-  capitalizeFirstLetter: () => capitalizeFirstLetter,
-  extractUrlValue: () => extractUrlValue,
-  inChrome: () => inChrome,
-  isValidAddress: () => isValidAddress,
-  isValidHttpUrl: () => isValidHttpUrl,
-  localStorageOrDefault: () => localStorageOrDefault,
-  makeCancelable: () => makeCancelable,
-  matchedProperties: () => matchedProperties,
-  mergeDeep: () => mergeDeep,
-  planckToUnit: () => planckToUnit,
-  remToUnit: () => remToUnit,
-  removeVarFromUrlHash: () => removeVarFromUrlHash,
-  removedFrom: () => removedFrom,
-  setStateWithRef: () => setStateWithRef,
-  snakeToCamel: () => snakeToCamel,
-  sortWithNull: () => sortWithNull,
-  unescape: () => unescape,
-  unimplemented: () => unimplemented,
-  unitToPlanck: () => unitToPlanck,
-  varToUrlHash: () => varToUrlHash
-});
-module.exports = __toCommonJS(unit_exports);
-var import_utils2 = require("dedot/utils");
-
-// src/base.ts
-var import_utils = require("dedot/utils");
-var rmCommas = (val) => val.replace(/,/g, "");
-var rmDecimals = (str) => str.split(".")[0];
-
-// src/unit.ts
-var planckToUnit = (val, units) => {
-  try {
-    units = Math.max(Math.round(units), 0);
-    const bigIntVal = typeof val === "bigint" ? val : BigInt(
-      typeof val === "number" ? Math.floor(val).toString() : rmDecimals(rmCommas(val))
-    );
-    const divisor = units === 0 ? 1n : BigInt(10) ** BigInt(units);
-    const integerPart = bigIntVal / divisor;
-    const fractionalPart = bigIntVal % divisor;
-    const fractionalStr = units > 0 ? `.${fractionalPart.toString().padStart(units, "0")}` : ``;
-    return `${integerPart}${fractionalStr}`;
-  } catch (e) {
-    return "0";
-  }
-};
-var unitToPlanck = (val, units) => {
-  try {
-    units = Math.max(Math.round(units), 0);
-    const strVal = (typeof val === "string" ? rmCommas(val) : val.toString()) || "0";
-    const [integerPart, fractionalPart = ""] = strVal.split(".");
-    let bigIntValue = BigInt(integerPart) * BigInt(10) ** BigInt(units);
-    if (fractionalPart) {
-      let fractionalValue;
-      if (fractionalPart.length > units) {
-        fractionalValue = BigInt(fractionalPart.slice(0, units));
-      } else {
-        fractionalValue = BigInt(fractionalPart.padEnd(units, "0"));
-      }
-      bigIntValue += fractionalValue;
-    }
-    return bigIntValue;
-  } catch (e) {
-    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,
-  (group) => group.toUpperCase().replace("-", "").replace("_", "")
-);
-var setStateWithRef = (value, setState, ref) => {
-  setState(value);
-  ref.current = value;
-};
-var localStorageOrDefault = (key, _default, parse = false) => {
-  const val = localStorage.getItem(key);
-  if (val === null) {
-    return _default;
-  }
-  if (parse) {
-    return JSON.parse(val);
-  }
-  return val;
-};
-var isValidAddress = (address) => {
-  try {
-    (0, import_utils2.decodeAddress)(address);
-    return true;
-  } catch (e) {
-    return false;
-  }
-};
-var extractUrlValue = (key, url) => {
-  if (typeof url === "undefined") {
-    url = window.location.href;
-  }
-  const match = url.match(`[?&]${key}=([^&]+)`);
-  return match ? match[1] : null;
-};
-var varToUrlHash = (key, val, addIfMissing) => {
-  const hash = window.location.hash;
-  const [page, params] = hash.split("?");
-  const searchParams = new URLSearchParams(params);
-  if (searchParams.get(key) === null && !addIfMissing) {
-    return;
-  }
-  searchParams.set(key, val);
-  window.location.hash = `${page}?${searchParams.toString()}`;
-};
-var removeVarFromUrlHash = (key) => {
-  const hash = window.location.hash;
-  const [page, params] = hash.split("?");
-  const searchParams = new URLSearchParams(params);
-  if (searchParams.get(key) === null) {
-    return;
-  }
-  searchParams.delete(key);
-  const paramsAsStr = searchParams.toString();
-  window.location.hash = `${page}${paramsAsStr ? `?${paramsAsStr}` : ``}`;
-};
-var sortWithNull = (ascending) => (a, b) => {
-  if (typeof a === "undefined" && typeof b === "undefined") {
-    return 0;
-  }
-  if (typeof a === "undefined" || typeof b === "undefined") {
-    return typeof a === "undefined" ? 1 : -1;
-  }
-  if (a === b) {
-    return 0;
-  }
-  if (a === null) {
-    return 1;
-  }
-  if (b === null) {
-    return -1;
-  }
-  if (ascending) {
-    return a < b ? -1 : 1;
-  }
-  return a < b ? 1 : -1;
-};
-var applyWidthAsPadding = (subjectRef, containerRef) => {
-  if (containerRef.current && subjectRef.current) {
-    containerRef.current.style.paddingRight = `${subjectRef.current.offsetWidth + remToUnit("1rem")}px`;
-  }
-};
-var unescape = (val) => val.replace(/\\"/g, '"');
-var inChrome = () => {
-  const isChromium = window?.chrome || null;
-  const winNav = window?.navigator || null;
-  const isOpera = typeof window?.opr !== "undefined";
-  const isIEedge = winNav?.userAgent.indexOf("Edg") > -1 || false;
-  const isIOSChrome = winNav?.userAgent.match("CriOS") || false;
-  if (isIOSChrome) {
-    return true;
-  }
-  if (isChromium !== null && typeof isChromium !== "undefined" && isOpera === false && isIEedge === false) {
-    return true;
-  }
-  return false;
-};
-var addedTo = (fresh, stale, keys) => typeof fresh !== "object" || typeof stale !== "object" || !keys.length ? [] : fresh.filter(
-  (freshItem) => !stale.find(
-    (staleItem) => keys.every(
-      (key) => !(key in staleItem) || !(key in freshItem) ? false : staleItem[key] === freshItem[key]
-    )
-  )
-);
-var removedFrom = (fresh, stale, keys) => typeof fresh !== "object" || typeof stale !== "object" || !keys.length ? [] : stale.filter(
-  (staleItem) => !fresh.find(
-    (freshItem) => keys.every(
-      (key) => !(key in staleItem) || !(key in freshItem) ? false : freshItem[key] === staleItem[key]
-    )
-  )
-);
-var matchedProperties = (objX, objY, keys) => typeof objX !== "object" || typeof objY !== "object" || !keys.length ? [] : objY.filter(
-  (x) => objX.find(
-    (y) => keys.every(
-      (key) => !(key in x) || !(key in y) ? false : y[key] === x[key]
-    )
-  )
-);
-var isValidHttpUrl = (string) => {
-  let url;
-  try {
-    url = new URL(string);
-  } catch (_) {
-    return false;
-  }
-  return url.protocol === "http:" || url.protocol === "https:";
-};
-var makeCancelable = (promise) => {
-  let hasCanceled = false;
-  const wrappedPromise = new Promise((resolve, reject) => {
-    promise.then(
-      (val) => hasCanceled ? reject(Error("Cancelled")) : resolve(val)
-    );
-    promise.catch(
-      (error) => hasCanceled ? reject(Error("Cancelled")) : reject(error)
-    );
-  });
-  return {
-    promise: wrappedPromise,
-    cancel: () => {
-      hasCanceled = true;
-    }
-  };
-};
-var unimplemented = ({ ...props }) => {
-};
-var mergeDeep = (target, ...sources) => {
-  if (!sources.length) {
-    return target;
-  }
-  const isObject = (item) => item && typeof item === "object" && !Array.isArray(item);
-  const source = sources.shift();
-  if (isObject(target) && isObject(source)) {
-    for (const key in source) {
-      if (isObject(source[key])) {
-        if (!target[key]) {
-          Object.assign(target, { [key]: {} });
-        }
-        mergeDeep(target[key], source[key]);
-      } else {
-        Object.assign(target, { [key]: source[key] });
-      }
-    }
-  }
-  return mergeDeep(target, ...sources);
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  addedTo,
-  applyWidthAsPadding,
-  capitalizeFirstLetter,
-  extractUrlValue,
-  inChrome,
-  isValidAddress,
-  isValidHttpUrl,
-  localStorageOrDefault,
-  makeCancelable,
-  matchedProperties,
-  mergeDeep,
-  planckToUnit,
-  remToUnit,
-  removeVarFromUrlHash,
-  removedFrom,
-  setStateWithRef,
-  snakeToCamel,
-  sortWithNull,
-  unescape,
-  unimplemented,
-  unitToPlanck,
-  varToUrlHash
-});
-/* @license Copyright 2024 w3ux authors & contributors
-SPDX-License-Identifier: GPL-3.0-only */

package/unit.d.cts

@@ -1,147 +0,0 @@
-import { RefObject } from 'react';
-import { AnyObject } from './types.cjs';
-
-/**
- * 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;
-/**
- * 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.
- */
-declare const capitalizeFirstLetter: (string: string) => string;
-/**
- * @name snakeToCamel
- * @summary converts a string from snake / kebab-case to camel-case.
- */
-declare const snakeToCamel: (str: string) => string;
-/**
- * @name setStateWithRef
- * @summary Synchronize React state and its reference with the provided value.
- */
-declare const setStateWithRef: <T>(value: T, setState: (_state: T) => void, ref: RefObject<T>) => void;
-/**
- * @name localStorageOrDefault
- * @summary Retrieve the local stroage value with the key, return defult value if it is not
- * found.
- */
-declare const localStorageOrDefault: <T>(key: string, _default: T, parse?: boolean) => T | string;
-/**
- * @name isValidAddress
- * @summary Return whether an address is valid Substrate address.
- */
-declare const isValidAddress: (address: string) => boolean;
-/**
- * @name extractUrlValue
- * @summary Extracts a URL value from a URL string.
- */
-declare const extractUrlValue: (key: string, url?: string) => string | null;
-/**
- * @name varToUrlHash
- * @summary Puts a variable into the URL hash as a param.
- * @description
- * Since url variables are added to the hash and are not treated as URL params, the params are split
- * and parsed into a `URLSearchParams`.
- */
-declare const varToUrlHash: (key: string, val: string, addIfMissing: boolean) => void;
-/**
- * @name removeVarFromUrlHash
- * @summary
- * Removes a variable `key` from the URL hash if it exists. Removes dangling `?` if no URL variables
- * exist.
- */
-declare const removeVarFromUrlHash: (key: string) => void;
-/**
- * @name sortWithNull
- * @summary Sorts an array with nulls last.
- */
-declare const sortWithNull: (ascending: boolean) => (a: unknown, b: unknown) => 0 | 1 | -1;
-/**
- * @name applyWidthAsPadding
- * @summary Applies width of subject to paddingRight of container.
- */
-declare const applyWidthAsPadding: (subjectRef: RefObject<HTMLDivElement | null>, containerRef: RefObject<HTMLDivElement | null>) => void;
-/**
- * @name unescape
- * @summary Replaces \” with “
- */
-declare const unescape: (val: string) => string;
-/**
- * @name inChrome
- * @summary Whether the application is rendering in Chrome.
- */
-declare const inChrome: () => boolean;
-/**
- * @name addedTo
- * @summary Given 2 objects and some keys, return items in the fresh object that do not exist in the
- * stale object by matching the given common key values of both objects.
- */
-declare const addedTo: (fresh: AnyObject[], stale: AnyObject[], keys: string[]) => AnyObject[];
-/**
- * @name removedFrom
- * @summary Given 2 objects and some keys, return items in the stale object that do not exist in the
- * fresh object by matching the given common key values of both objects.
- */
-declare const removedFrom: (fresh: AnyObject[], stale: AnyObject[], keys: string[]) => AnyObject[];
-/**
- * @name matchedProperties
- * @summary Given 2 objects and some keys, return items in object 1 that also exist in object 2 by
- * matching the given common key values of both objects.
- */
-declare const matchedProperties: (objX: AnyObject[], objY: AnyObject[], keys: string[]) => AnyObject[];
-/**
- * @name isValidHttpUrl
- * @summary Give a string, return whether it is a valid http URL.
- * @param string  - The string to check.
- */
-declare const isValidHttpUrl: (string: string) => boolean;
-/**
- * @name makeCancelable
- * @summary Makes a promise cancellable.
- * @param promise  - The promise to make cancellable.
- */
-declare const makeCancelable: (promise: Promise<AnyObject>) => {
-    promise: Promise<unknown>;
-    cancel: () => void;
-};
-/**
- * @name unimplemented
- * @summary A placeholder function to signal a deliberate unimplementation.
- * Consumes an arbitrary number of props.
- */
-declare const unimplemented: ({ ...props }: {
-    [x: string]: any;
-}) => void;
-/**
- * Deep merge two objects.
- * @param target
- * @param ...sources
- */
-declare const mergeDeep: (target: AnyObject, ...sources: AnyObject[]) => AnyObject;
-
-export { addedTo, applyWidthAsPadding, capitalizeFirstLetter, extractUrlValue, inChrome, isValidAddress, isValidHttpUrl, localStorageOrDefault, makeCancelable, matchedProperties, mergeDeep, planckToUnit, remToUnit, removeVarFromUrlHash, removedFrom, setStateWithRef, snakeToCamel, sortWithNull, unescape, unimplemented, unitToPlanck, varToUrlHash };

package/unit.d.ts

@@ -1,147 +0,0 @@
-import { RefObject } from 'react';
-import { AnyObject } from './types.js';
-
-/**
- * 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;
-/**
- * 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.
- */
-declare const capitalizeFirstLetter: (string: string) => string;
-/**
- * @name snakeToCamel
- * @summary converts a string from snake / kebab-case to camel-case.
- */
-declare const snakeToCamel: (str: string) => string;
-/**
- * @name setStateWithRef
- * @summary Synchronize React state and its reference with the provided value.
- */
-declare const setStateWithRef: <T>(value: T, setState: (_state: T) => void, ref: RefObject<T>) => void;
-/**
- * @name localStorageOrDefault
- * @summary Retrieve the local stroage value with the key, return defult value if it is not
- * found.
- */
-declare const localStorageOrDefault: <T>(key: string, _default: T, parse?: boolean) => T | string;
-/**
- * @name isValidAddress
- * @summary Return whether an address is valid Substrate address.
- */
-declare const isValidAddress: (address: string) => boolean;
-/**
- * @name extractUrlValue
- * @summary Extracts a URL value from a URL string.
- */
-declare const extractUrlValue: (key: string, url?: string) => string | null;
-/**
- * @name varToUrlHash
- * @summary Puts a variable into the URL hash as a param.
- * @description
- * Since url variables are added to the hash and are not treated as URL params, the params are split
- * and parsed into a `URLSearchParams`.
- */
-declare const varToUrlHash: (key: string, val: string, addIfMissing: boolean) => void;
-/**
- * @name removeVarFromUrlHash
- * @summary
- * Removes a variable `key` from the URL hash if it exists. Removes dangling `?` if no URL variables
- * exist.
- */
-declare const removeVarFromUrlHash: (key: string) => void;
-/**
- * @name sortWithNull
- * @summary Sorts an array with nulls last.
- */
-declare const sortWithNull: (ascending: boolean) => (a: unknown, b: unknown) => 0 | 1 | -1;
-/**
- * @name applyWidthAsPadding
- * @summary Applies width of subject to paddingRight of container.
- */
-declare const applyWidthAsPadding: (subjectRef: RefObject<HTMLDivElement | null>, containerRef: RefObject<HTMLDivElement | null>) => void;
-/**
- * @name unescape
- * @summary Replaces \” with “
- */
-declare const unescape: (val: string) => string;
-/**
- * @name inChrome
- * @summary Whether the application is rendering in Chrome.
- */
-declare const inChrome: () => boolean;
-/**
- * @name addedTo
- * @summary Given 2 objects and some keys, return items in the fresh object that do not exist in the
- * stale object by matching the given common key values of both objects.
- */
-declare const addedTo: (fresh: AnyObject[], stale: AnyObject[], keys: string[]) => AnyObject[];
-/**
- * @name removedFrom
- * @summary Given 2 objects and some keys, return items in the stale object that do not exist in the
- * fresh object by matching the given common key values of both objects.
- */
-declare const removedFrom: (fresh: AnyObject[], stale: AnyObject[], keys: string[]) => AnyObject[];
-/**
- * @name matchedProperties
- * @summary Given 2 objects and some keys, return items in object 1 that also exist in object 2 by
- * matching the given common key values of both objects.
- */
-declare const matchedProperties: (objX: AnyObject[], objY: AnyObject[], keys: string[]) => AnyObject[];
-/**
- * @name isValidHttpUrl
- * @summary Give a string, return whether it is a valid http URL.
- * @param string  - The string to check.
- */
-declare const isValidHttpUrl: (string: string) => boolean;
-/**
- * @name makeCancelable
- * @summary Makes a promise cancellable.
- * @param promise  - The promise to make cancellable.
- */
-declare const makeCancelable: (promise: Promise<AnyObject>) => {
-    promise: Promise<unknown>;
-    cancel: () => void;
-};
-/**
- * @name unimplemented
- * @summary A placeholder function to signal a deliberate unimplementation.
- * Consumes an arbitrary number of props.
- */
-declare const unimplemented: ({ ...props }: {
-    [x: string]: any;
-}) => void;
-/**
- * Deep merge two objects.
- * @param target
- * @param ...sources
- */
-declare const mergeDeep: (target: AnyObject, ...sources: AnyObject[]) => AnyObject;
-
-export { addedTo, applyWidthAsPadding, capitalizeFirstLetter, extractUrlValue, inChrome, isValidAddress, isValidHttpUrl, localStorageOrDefault, makeCancelable, matchedProperties, mergeDeep, planckToUnit, remToUnit, removeVarFromUrlHash, removedFrom, setStateWithRef, snakeToCamel, sortWithNull, unescape, unimplemented, unitToPlanck, varToUrlHash };