@choksheak/ts-utils 0.2.9 → 0.3.1

package/sha256.js

@@ -1,58 +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);
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-
-// src/sha256.ts
-var sha256_exports = {};
-__export(sha256_exports, {
-  sha256: () => sha256
-});
-module.exports = __toCommonJS(sha256_exports);
-function sha256(input) {
-  return __async(this, null, function* () {
-    const encoder = new TextEncoder();
-    const uint8Array = encoder.encode(input);
-    const arrayBuffer = yield crypto.subtle.digest("SHA-256", uint8Array);
-    return arrayBuffer;
-  });
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  sha256
-});
-//# sourceMappingURL=sha256.js.map

package/src/arrayBuffer.ts

@@ -1,29 +0,0 @@
-/**
- * Encode an input ArrayBuffer into a hex string.
- */
-export function arrayBufferToHex(buffer: ArrayBuffer): string {
-  // Create a Uint8Array view of the ArrayBuffer
-  const byteArray = new Uint8Array(buffer);
-
-  // Convert each byte to a two-character hexadecimal string
-  return Array.from(byteArray)
-    .map((byte) => byte.toString(16).padStart(2, "0"))
-    .join("");
-}
-
-/**
- * Encode an input ArrayBuffer into a base64 string.
- */
-export function arrayBufferToBase64(buffer: ArrayBuffer): string {
-  // Convert the ArrayBuffer to a Uint8Array
-  const byteArray = new Uint8Array(buffer);
-
-  // Create a binary string from the byte array
-  const binaryString = Array.from(byteArray)
-    .map((byte) => String.fromCodePoint(byte))
-    .join("");
-
-  // Encode the binary string to base64. No need to use safeBtoa because we
-  // already simplified the binary input above.
-  return btoa(binaryString);
-}

package/src/assert.ts

@@ -1,14 +0,0 @@
-/**
- * Type asserts that `t` is truthy. Throws an error with `errorMessage` if
- * `t` is falsy.
- */
-export function assert<T>(
-  t: T | null | undefined | "" | 0 | -0 | 0n | false | typeof NaN,
-  errorMessage?: string,
-): asserts t is T {
-  if (!t) {
-    throw new Error(
-      errorMessage || `Assertion failed: ${JSON.stringify(t)} is falsy`,
-    );
-  }
-}

package/src/average.ts

@@ -1,13 +0,0 @@
-import { sum } from "./sum";
-
-/**
- * Average all the numbers together in the given array. Treats null, undefined
- * and NaN as zero.
- */
-export function average(numbers: (number | null | undefined)[]): number {
-  if (numbers.length === 0) return 0;
-
-  const total = sum(numbers);
-
-  return total / numbers.length;
-}

package/src/base64Url.ts

@@ -1,20 +0,0 @@
-/**
- * Convert a base64 string to a base64url string.
- */
-export function base64ToBase64URL(base64: string): string {
-  return base64.replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/, ""); // Remove padding
-}
-
-/**
- * Convert a base64url string to a base64 string.
- */
-export function base64UrlToBase64(base64Url: string): string {
-  if (!base64Url) return "";
-
-  // Replace URL-safe characters
-  const base64 = base64Url.replace(/-/g, "+").replace(/_/g, "/");
-
-  // Calculate and add padding
-  const padLength = (4 - (base64.length % 4)) % 4;
-  return base64 + "=".repeat(padLength);
-}

package/src/dateTimeStr.ts

@@ -1,184 +0,0 @@
-export type AnyDateTime = number | Date | string;
-
-function isAllDigits(str: string): boolean {
-  return /^\d+$/.test(str);
-}
-
-/**
- * Convert a number (epoch seconds or milliseconds), string (parseable
- * date/time or epoch seconds or milliseconds), or Date object (no conversion)
- * into a Date object.
- */
-export function toDate(ts: AnyDateTime): Date {
-  if (typeof ts === "number") {
-    // Handle timestamp in seconds (less than 12 digits long).
-    if (ts < 1_000_000_000_00) {
-      return new Date(ts * 1000);
-    }
-
-    // Handle timestamp in milliseconds.
-    return new Date(ts);
-  }
-
-  if (typeof ts === "string") {
-    if (isAllDigits(ts)) {
-      return toDate(Number(ts));
-    }
-
-    return new Date(ts);
-  }
-
-  return ts;
-}
-
-/**
- * Returns a date in yyyy-MM format. E.g. '2000-01'.
- *
- * @param dt Specify a date object or default to the current date.
- * @param separator Defaults to '-'.
- */
-export function yyyyMm(dt = new Date(), separator = "-"): string {
-  const yr = dt.getFullYear();
-  const mth = dt.getMonth() + 1;
-
-  return yr + separator + (mth < 10 ? "0" + mth : mth);
-}
-
-/**
- * Returns a date in yyyy-MM-dd format. E.g. '2000-01-02'.
- *
- * @param dt Specify a date object or default to the current date.
- * @param separator Defaults to '-'.
- */
-export function yyyyMmDd(dt = new Date(), separator = "-"): string {
-  const day = dt.getDate();
-
-  return yyyyMm(dt, separator) + separator + (day < 10 ? "0" + day : day);
-}
-
-/**
- * Returns a date in hh:mm format. E.g. '01:02'.
- *
- * @param dt Specify a date object or default to the current date/time.
- * @param separator Defaults to ':'.
- */
-export function hhMm(dt = new Date(), separator = ":"): string {
-  const hr = dt.getHours();
-  const min = dt.getMinutes();
-
-  return (hr < 10 ? "0" + hr : hr) + separator + (min < 10 ? "0" + min : min);
-}
-
-/**
- * Returns a date in hh:mm:ss format. E.g. '01:02:03'.
- *
- * @param dt Specify a date object or default to the current date/time.
- * @param separator Defaults to ':'.
- */
-export function hhMmSs(dt = new Date(), separator = ":"): string {
-  const sec = dt.getSeconds();
-
-  return hhMm(dt, separator) + separator + (sec < 10 ? "0" + sec : sec);
-}
-
-/**
- * Returns a date in hh:mm:ss.SSS format. E.g. '01:02:03.004'.
- *
- * @param dt Specify a date object or default to the current date/time.
- * @param timeSeparator Separator for hh/mm/ss. Defaults to ':'.
- * @param msSeparator Separator before SSS. Defaults to '.'.
- */
-export function hhMmSsMs(
-  dt = new Date(),
-  timeSeparator = ":",
-  msSeparator = ".",
-): string {
-  const ms = dt.getMilliseconds();
-
-  return (
-    hhMmSs(dt, timeSeparator) +
-    msSeparator +
-    (ms < 10 ? "00" + ms : ms < 100 ? "0" + ms : ms)
-  );
-}
-
-/**
- * Returns the timezone string for the given date. E.g. '+8', '-3.5'.
- * Returns 'Z' for UTC.
- *
- * @param dt Specify a date object or default to the current date/time.
- */
-export function tzShort(dt = new Date()): string {
-  if (dt.getTimezoneOffset() === 0) {
-    return "Z";
-  }
-
-  const tzHours = dt.getTimezoneOffset() / 60;
-  return tzHours >= 0 ? "+" + tzHours : String(tzHours);
-}
-
-/**
- * Returns the long month name, zero-indexed. E.g. 0 for 'January'.
- *
- * @param month Zero-indexed month.
- * @param locales Specify the locale, e.g. 'en-US', new Intl.Locale("en-US").
- */
-export function getLongMonthNameZeroIndexed(
-  month: number,
-  locales: Intl.LocalesArgument = "default",
-): string {
-  return new Date(2024, month, 15).toLocaleString(locales, {
-    month: "long",
-  });
-}
-
-/**
- * Returns the long month name, one-indexed. E.g. 1 for 'January'.
- *
- * @param month One-indexed month.
- * @param locales Specify the locale, e.g. 'en-US', new Intl.Locale("en-US").
- */
-export function getLongMonthNameOneIndexed(
-  month: number,
-  locales: Intl.LocalesArgument = "default",
-): string {
-  return getLongMonthNameZeroIndexed(month - 1, locales);
-}
-
-/**
- * Returns the short month name, zero-indexed. E.g. 0 for 'Jan'.
- *
- * @param month Zero-indexed month.
- * @param locales Specify the locale, e.g. 'en-US', new Intl.Locale("en-US").
- */
-export function getShortMonthNameZeroIndexed(
-  month: number,
-  locales: Intl.LocalesArgument = "default",
-): string {
-  return new Date(2000, month, 15).toLocaleString(locales, {
-    month: "short",
-  });
-}
-
-/**
- * Returns the short month name, one-indexed. E.g. 1 for 'Jan'.
- *
- * @param month One-indexed month.
- * @param locales Specify the locale, e.g. 'en-US', new Intl.Locale("en-US").
- */
-export function getShortMonthNameOneIndexed(
-  month: number,
-  locales: Intl.LocalesArgument = "default",
-): string {
-  return getShortMonthNameZeroIndexed(month - 1, locales);
-}
-
-/**
- * Returns a human-readable string date/time like '2025-01-01 22:31:16Z'.
- * Excludes the milliseconds assuming it is not necessary for display.
- */
-export function getDisplayDateTime(ts: AnyDateTime) {
-  const iso = toDate(ts).toISOString();
-  const noMs = iso.slice(0, 19) + "Z";
-  return noMs.replace("T", " ");
-}

package/src/duration.ts

@@ -1,260 +0,0 @@
-/**
- * Bunch of miscellaneous constants and utility functions related to handling
- * date and time durations.
- *
- * Note that month and year do not have fixed durations, and hence are excluded
- * from this file. Weeks have fixed durations, but are excluded because we
- * use days as the max duration supported.
- */
-
-import {
-  MS_PER_SECOND,
-  SECONDS_PER_MINUTE,
-  MINUTES_PER_HOUR,
-  HOURS_PER_DAY,
-  MS_PER_DAY,
-  MS_PER_MINUTE,
-  MS_PER_HOUR,
-} from "./timeConstants";
-
-export type Duration = {
-  days?: number;
-  hours?: number;
-  minutes?: number;
-  seconds?: number;
-  milliseconds?: number;
-};
-
-/**
- * One of: days, hours, minutes, seconds, milliseconds
- */
-export type DurationType = keyof Duration;
-
-/**
- * Order in which the duration type appears in the duration string.
- */
-export const DURATION_TYPE_SEQUENCE: DurationType[] = [
-  "days",
-  "hours",
-  "minutes",
-  "seconds",
-  "milliseconds",
-];
-
-/**
- * Follows the same format as Intl.DurationFormat.prototype.format().
- *
- * Short: 1 yr, 2 mths, 3 wks, 3 days, 4 hr, 5 min, 6 sec, 7 ms, 8 μs, 9 ns
- * Long: 1 year, 2 months, 3 weeks, 3 days, 4 hours, 5 minutes, 6 seconds,
- *       7 milliseconds, 8 microseconds, 9 nanoseconds
- * Narrow: 1y 2mo 3w 3d 4h 5m 6s 7ms 8μs 9ns
- */
-export type DurationStyle = "short" | "long" | "narrow";
-
-export type DurationSuffixMap = {
-  short: string;
-  shorts: string;
-  long: string;
-  longs: string;
-  narrow: string;
-};
-
-export type DurationSuffixType = keyof DurationSuffixMap;
-
-export const DURATION_STYLE_SUFFIX_MAP: Record<
-  DurationType,
-  DurationSuffixMap
-> = {
-  days: {
-    short: "day",
-    shorts: "days",
-    long: "day",
-    longs: "days",
-    narrow: "d",
-  },
-  hours: {
-    short: "hr",
-    shorts: "hrs",
-    long: "hour",
-    longs: "hours",
-    narrow: "h",
-  },
-  minutes: {
-    short: "min",
-    shorts: "mins",
-    long: "minute",
-    longs: "minutes",
-    narrow: "m",
-  },
-  seconds: {
-    short: "sec",
-    shorts: "secs",
-    long: "second",
-    longs: "seconds",
-    narrow: "s",
-  },
-  milliseconds: {
-    short: "ms",
-    shorts: "ms",
-    long: "millisecond",
-    longs: "milliseconds",
-    narrow: "ms",
-  },
-};
-
-function getDurationStyleForPlural(style: DurationStyle): DurationSuffixType {
-  return style == "short" ? "shorts" : style === "long" ? "longs" : style;
-}
-
-function getValueAndUnitSeparator(style: DurationStyle): string {
-  return style === "narrow" ? "" : " ";
-}
-
-function getDurationTypeSeparator(style: DurationStyle): string {
-  return style === "narrow" ? " " : ", ";
-}
-
-/**
- * Convert a milliseconds duration into a Duration object. If the given ms is
- * zero, then return an object with a single field of zero with duration type
- * of durationTypeForZero.
- *
- * @param durationTypeForZero Defaults to 'milliseconds'
- */
-export function msToDuration(
-  ms: number,
-  durationTypeForZero?: DurationType,
-): Duration {
-  if (ms === 0) {
-    durationTypeForZero = durationTypeForZero ?? "milliseconds";
-    return { [durationTypeForZero]: 0 };
-  }
-
-  const duration: Duration = {};
-
-  for (let i = 0; i < 1; i++) {
-    let seconds = Math.floor(ms / MS_PER_SECOND);
-    const millis = ms - seconds * MS_PER_SECOND;
-
-    if (millis > 0) {
-      duration["milliseconds"] = millis;
-    }
-
-    if (seconds === 0) {
-      break;
-    }
-
-    let minutes = Math.floor(seconds / SECONDS_PER_MINUTE);
-    seconds -= minutes * SECONDS_PER_MINUTE;
-
-    if (seconds > 0) {
-      duration["seconds"] = seconds;
-    }
-
-    if (minutes === 0) {
-      break;
-    }
-
-    let hours = Math.floor(minutes / MINUTES_PER_HOUR);
-    minutes -= hours * MINUTES_PER_HOUR;
-
-    if (minutes > 0) {
-      duration["minutes"] = minutes;
-    }
-
-    if (hours === 0) {
-      break;
-    }
-
-    const days = Math.floor(hours / HOURS_PER_DAY);
-    hours -= days * HOURS_PER_DAY;
-
-    if (hours > 0) {
-      duration["hours"] = hours;
-    }
-
-    if (days > 0) {
-      duration["days"] = days;
-    }
-  }
-
-  return duration;
-}
-
-/**
- * Returns the number of milliseconds for the given duration.
- */
-export function durationToMs(duration: Duration): number {
-  const daysMs = (duration.days ?? 0) * MS_PER_DAY;
-  const hoursMs = (duration.hours ?? 0) * MS_PER_HOUR;
-  const minsMs = (duration.minutes ?? 0) * MS_PER_MINUTE;
-  const secsMs = (duration.seconds ?? 0) * MS_PER_SECOND;
-  const msMs = duration.milliseconds ?? 0;
-
-  return daysMs + hoursMs + minsMs + secsMs + msMs;
-}
-
-/**
- * Convenience function to return a duration given an ms or Duration.
- */
-export function durationOrMsToMs(duration: number | Duration): number {
-  return typeof duration === "number" ? duration : durationToMs(duration);
-}
-
-/**
- * Format a given Duration object into a string. If the object has no fields,
- * then returns an empty string.
- *
- * @param style Defaults to 'short'
- */
-export function formatDuration(duration: Duration, style?: DurationStyle) {
-  style = style ?? "short";
-  const stylePlural = getDurationStyleForPlural(style);
-
-  const space = getValueAndUnitSeparator(style);
-
-  const a: string[] = [];
-
-  for (const unit of DURATION_TYPE_SEQUENCE) {
-    const value = duration[unit];
-    if (value === undefined) continue;
-
-    const suffixMap = DURATION_STYLE_SUFFIX_MAP[unit];
-    const suffix = value === 1 ? suffixMap[style] : suffixMap[stylePlural];
-    a.push(value + space + suffix);
-  }
-
-  const separator = getDurationTypeSeparator(style);
-  return a.join(separator);
-}
-
-/**
- * Convert a millisecond duration into a human-readable duration string.
- *
- * @param options.durationTypeForZero - Defaults to 'milliseconds'
- * @param options.style - Defaults to 'short'
- */
-export function readableDuration(
-  ms: number,
-  options?: { durationTypeForZero?: DurationType; style?: DurationStyle },
-): string {
-  const duration = msToDuration(ms, options?.durationTypeForZero);
-
-  return formatDuration(duration, options?.style);
-}
-
-/** A shortened duration string useful for logging timings. */
-export function elapsed(ms: number): string {
-  // Use long format for 1 minute or over.
-  if (ms > MS_PER_MINUTE) {
-    return readableDuration(ms);
-  }
-
-  // Use seconds format for over 100ms.
-  if (ms > 100) {
-    return `${(ms / 1000).toFixed(3)}s`;
-  }
-
-  // Use milliseconds format.
-  return ms + "ms";
-}

package/src/isEmpty.ts

@@ -1,32 +0,0 @@
-/**
- * Returns true if `t` is empty.
- */
-export function isEmpty(t: unknown): boolean {
-  // Anything falsy is considered empty.
-  if (!t) {
-    return true;
-  }
-
-  // Arrays are also of type `object`.
-  if (typeof t !== "object") {
-    return false;
-  }
-
-  // `length` includes arrays as well.
-  if ("length" in t) {
-    return t.length === 0;
-  }
-
-  // `size` is for Set, Map, Blob etc.
-  if ("size" in t) {
-    return t.size === 0;
-  }
-
-  // Super fast check for object emptiness.
-  // https://stackoverflow.com/questions/679915/how-do-i-test-for-an-empty-javascript-object
-  for (const k in t) {
-    return false;
-  }
-
-  return true;
-}