@w3ux/utils 0.2.0 → 0.4.0-alpha.0

package/base.cjs

@@ -0,0 +1,176 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/base.ts
+var base_exports = {};
+__export(base_exports, {
+  appendOr: () => appendOr,
+  appendOrEmpty: () => appendOrEmpty,
+  camelize: () => camelize,
+  ellipsisFn: () => ellipsisFn,
+  formatAccountSs58: () => formatAccountSs58,
+  greaterThanZero: () => greaterThanZero,
+  isNotZero: () => isNotZero,
+  minDecimalPlaces: () => minDecimalPlaces,
+  pageFromUri: () => pageFromUri,
+  removeHexPrefix: () => removeHexPrefix,
+  rmCommas: () => rmCommas,
+  shuffle: () => shuffle,
+  withTimeout: () => withTimeout
+});
+module.exports = __toCommonJS(base_exports);
+var import_bignumber = require("bignumber.js");
+var import_keyring = __toESM(require("@polkadot/keyring"), 1);
+var camelize = (str) => {
+  const convertToString = (string) => {
+    if (string) {
+      if (typeof string === "string") {
+        return string;
+      }
+      return String(string);
+    }
+    return "";
+  };
+  const toWords = (inp) => convertToString(inp).match(
+    /[A-Z\xC0-\xD6\xD8-\xDE]?[a-z\xDF-\xF6\xF8-\xFF]+|[A-Z\xC0-\xD6\xD8-\xDE]+(?![a-z\xDF-\xF6\xF8-\xFF])|\d+/g
+  );
+  const simpleCamelCase = (inp) => {
+    let result = "";
+    for (let i = 0; i < inp?.length; i++) {
+      const currString = inp[i];
+      let tmpStr = currString.toLowerCase();
+      if (i != 0) {
+        tmpStr = tmpStr.slice(0, 1).toUpperCase() + tmpStr.slice(1, tmpStr.length);
+      }
+      result += tmpStr;
+    }
+    return result;
+  };
+  const w = toWords(str)?.map((a) => a.toLowerCase());
+  return simpleCamelCase(w);
+};
+var ellipsisFn = (str, amount = 6, position = "center") => {
+  const half = str.length / 2;
+  if (amount <= 4) {
+    if (position === "center") {
+      return str.slice(0, 4) + "..." + str.slice(-4);
+    }
+    if (position === "end") {
+      return str.slice(0, 4) + "...";
+    }
+    return "..." + str.slice(-4);
+  }
+  if (position === "center") {
+    return amount >= (str.length - 2) / 2 ? str.slice(0, half - 3) + "..." + str.slice(-(half - 3)) : str.slice(0, amount) + "..." + str.slice(-amount);
+  }
+  if (amount >= str.length) {
+    if (position === "end") {
+      return str.slice(0, str.length - 3) + "...";
+    }
+    return "..." + str.slice(-(str.length - 3));
+  } else {
+    if (position === "end") {
+      return str.slice(0, amount) + "...";
+    }
+    return "..." + str.slice(amount);
+  }
+};
+var greaterThanZero = (val) => val.isGreaterThan(0);
+var isNotZero = (val) => !val.isZero();
+var minDecimalPlaces = (val, minDecimals) => {
+  const whole = new import_bignumber.BigNumber(rmCommas(val).split(".")[0] || 0);
+  const decimals = val.split(".")[1] || "";
+  const missingDecimals = new import_bignumber.BigNumber(minDecimals).minus(decimals.length);
+  return missingDecimals.isGreaterThan(0) ? `${whole.toFormat(0)}.${decimals.toString()}${"0".repeat(
+    missingDecimals.toNumber()
+  )}` : val;
+};
+var pageFromUri = (pathname, fallback) => {
+  const lastUriItem = pathname.substring(pathname.lastIndexOf("/") + 1);
+  const page = lastUriItem.trim() === "" ? fallback : lastUriItem;
+  return page.trim();
+};
+var rmCommas = (val) => val.replace(/,/g, "");
+var shuffle = (array) => {
+  let currentIndex = array.length;
+  let randomIndex;
+  while (currentIndex !== 0) {
+    randomIndex = Math.floor(Math.random() * currentIndex);
+    currentIndex--;
+    [array[currentIndex], array[randomIndex]] = [
+      array[randomIndex],
+      array[currentIndex]
+    ];
+  }
+  return array;
+};
+var withTimeout = (ms, promise, options) => {
+  const timeout = new Promise(
+    (resolve) => setTimeout(async () => {
+      if (typeof options?.onTimeout === "function") {
+        options.onTimeout();
+      }
+      resolve(void 0);
+    }, ms)
+  );
+  return Promise.race([promise, timeout]);
+};
+var appendOrEmpty = (condition, value) => condition ? ` ${value}` : "";
+var appendOr = (condition, value, fallback) => condition ? ` ${value}` : ` ${fallback}`;
+var formatAccountSs58 = (address, ss58) => {
+  try {
+    const keyring = new import_keyring.default();
+    keyring.setSS58Format(ss58);
+    const formatted = keyring.addFromAddress(address).address;
+    if (formatted !== address) {
+      return formatted;
+    }
+    return null;
+  } catch (e) {
+    return null;
+  }
+};
+var removeHexPrefix = (str) => str.replace(/^0x/, "");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  appendOr,
+  appendOrEmpty,
+  camelize,
+  ellipsisFn,
+  formatAccountSs58,
+  greaterThanZero,
+  isNotZero,
+  minDecimalPlaces,
+  pageFromUri,
+  removeHexPrefix,
+  rmCommas,
+  shuffle,
+  withTimeout
+});
+/* @license Copyright 2024 w3ux authors & contributors
+SPDX-License-Identifier: GPL-3.0-only */

package/base.d.cts

@@ -0,0 +1,77 @@
+import { BigNumber } from 'bignumber.js';
+import { AnyFunction } from '@w3ux/types';
+
+/**
+ * @name camelize
+ * @summary Converts a string of text to camelCase.
+ */
+declare const camelize: (str: string) => string;
+/**
+ * @name ellipsisFn
+ * @summary Receives an address and creates ellipsis on the given string, based on parameters.
+ * @param str  - The string to apply the ellipsis on
+ * @param amount  - The amount of characters that the ellipsis will be
+ * @param position - where the ellipsis will apply; if center the amount of character is the
+ * 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 greaterThanZero
+ * @summary Returns whether a BigNumber is greater than zero.
+ */
+declare const greaterThanZero: (val: BigNumber) => boolean;
+/**
+ * @name isNotZero
+ * @summary Returns whether a BigNumber is zero.
+ */
+declare const isNotZero: (val: BigNumber) => boolean;
+/**
+ * @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.
+ */
+declare const pageFromUri: (pathname: string, fallback: string) => string;
+/**
+ * @name rmCommas
+ * @summary Removes the commas from a string.
+ */
+declare const rmCommas: (val: string) => string;
+/**
+ * @name shuffle
+ * @summary Shuffle a set of objects.
+ */
+declare const shuffle: <T>(array: T[]) => T[];
+/**
+ * @name withTimeout
+ * @summary Timeout a promise after a specified number of milliseconds.
+ */
+declare const withTimeout: (ms: number, promise: AnyFunction, options?: {
+    onTimeout?: AnyFunction;
+}) => Promise<any>;
+/**
+ * @name appendOrEmpty
+ * @summary Returns ` value` if a condition is truthy, or an empty string otherwise.
+ */
+declare const appendOrEmpty: (condition: boolean | string | undefined, value: string) => string;
+/**
+ * @name appendOr
+ * @summary Returns ` value` if condition is truthy, or ` fallback` otherwise.
+ */
+declare const appendOr: (condition: boolean | string | undefined, value: string, fallback: string) => string;
+/**
+ * @name appendOr
+ * @summary Formats an address with the supplied ss58 prefix, or returns null if invalid.
+ */
+declare const formatAccountSs58: (address: string, ss58: number) => string;
+/**
+ * @name removeHexPrefix
+ * @summary Takes a string str as input and returns a new string with the "0x" prefix removed if it
+ * exists at the beginning of the input string.
+ */
+declare const removeHexPrefix: (str: string) => string;
+
+export { appendOr, appendOrEmpty, camelize, ellipsisFn, formatAccountSs58, greaterThanZero, isNotZero, minDecimalPlaces, pageFromUri, removeHexPrefix, rmCommas, shuffle, withTimeout };

package/base.d.ts

@@ -1,5 +1,5 @@
 import { BigNumber } from 'bignumber.js';
-import { AnyFunction } from './types.js';
+import { AnyFunction } from '@w3ux/types';
 
 /**
  * @name camelize