@keeex/utils 7.0.1

package/web/uint8array.js

@@ -0,0 +1,412 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ */
+import TextEncodingShim from "text-encoding-shim";
+import { arrayEqual } from "./array.js";
+import { b642ab as bitsB642ab } from "./bits/arraybuffer.js";
+import { clearHexInput } from "./bits/hex.js";
+import { getUint8Array as getUint8ArrayBits, pureBuf82B64, buf82b64 } from "./bits/uint8array.js";
+import { HEXBYTE_CHR_COUNT, HEX_DIGITS, MAX_RADIX } from "./consts.js";
+import { bufferB642Buf8, bufferBuf82Hex, bufferBuf82Utf8, bufferHex2Buf8, bufferUtf82Buf8, haveBufferBase64, haveBufferHex, haveBufferUTF8 } from "./utils/buffer.js";
+import FourBytes from "./utils/fourbytes.js";
+/**
+ * Return a Uint8Array view on the provided ArrayBuffer.
+ *
+ * If clone is set to true, return a clone of the source array. Otherwise a view is returned.
+ *
+ * @public
+ */
+export const getUint8Array = getUint8ArrayBits;
+/**
+ * Convert an Uint8Array to a raw string.
+ *
+ * @public
+ */
+export const buf82str = buf8 => {
+  const charArray = [];
+  const length = buf8.byteLength;
+  charArray.length = length;
+  for (let i = 0; i < length; i++) charArray[i] = String.fromCharCode(buf8[i]);
+  return charArray.join("");
+};
+/**
+ * Convert a string to an Uint8Array
+ *
+ * @public
+ */
+export const str2buf8 = str => {
+  const buf8 = new Uint8Array(str.length);
+  for (let i = 0, strLen = str.length; i < strLen; i++) buf8[i] = str.charCodeAt(i);
+  return buf8;
+};
+/** @internal */
+export const pureBuf82Hex = (buf8, addPrefix) => {
+  const hexArray = [];
+  const length = buf8.length;
+  hexArray.length = length * HEXBYTE_CHR_COUNT;
+  for (let i = 0; i < length; i++) {
+    hexArray[i] = buf8[i].toString(HEX_DIGITS).padStart(HEXBYTE_CHR_COUNT, "0");
+  }
+  const hexResult = hexArray.join("");
+  return addPrefix ? `0x${hexResult}` : hexResult;
+};
+/**
+ * Convert an Uint8Array to a hex string.
+ *
+ * @public
+ */
+export const buf82hex = haveBufferHex() ? bufferBuf82Hex : pureBuf82Hex;
+/** @internal */
+export const pureHex2Buf8 = hex => {
+  const input = clearHexInput(hex);
+  const buf8 = new Uint8Array(input.length / HEXBYTE_CHR_COUNT);
+  for (let i = 0; i < buf8.length; ++i) {
+    buf8[i] = parseInt(input[i * HEXBYTE_CHR_COUNT] + input[i * HEXBYTE_CHR_COUNT + 1], HEX_DIGITS);
+  }
+  return buf8;
+};
+/**
+ * Convert an hex string to an Uint8Array.
+ *
+ * @public
+ */
+export const hex2buf8 = haveBufferHex() ? bufferHex2Buf8 : pureHex2Buf8;
+const lengthAsUint8Array = length => {
+  const lengthAsString = length.toString(MAX_RADIX);
+  const maxByteValue = 255;
+  if (lengthAsString.length > maxByteValue) throw new Error("Unsupported buffer length");
+  return str2buf8(lengthAsString);
+};
+/**
+ * Concatenate multiple Uint8Array into one output.
+ *
+ * The output will have each individual buffer length stored so that they can be
+ * split afterward using explodeBuf8List(). Simple concatenation is available with merge().
+ *
+ * Output have the following format for each buffer:
+ *
+ * - 1 byte: the character "!", that identifies the kind of data that follows
+ * - 1 byte: length of the "buffer length as a string(base36)"
+ * - x bytes: buffer length as a string(base36)
+ * - y bytes: buffer content
+ *
+ * A special byte set to '#' can be appended to indicate the end of the buffers list. This allows
+ * the output of this function to be followed by other data while still being able to use the
+ * explode function.
+ *
+ * @public
+ */
+export const concatenateBuf8List = (buf8s, addEndMarker = false) => {
+  const inputs = buf8s.map(buf8Input => ({
+    buf8Input,
+    lengthBuf8: lengthAsUint8Array(buf8Input.length)
+  }));
+  const totalOutputLength = inputs.reduce(
+  // + 2 because of the length's length and the '!' prefix
+  (acc, cur) => acc + cur.buf8Input.length + cur.lengthBuf8.length + 1 + 1, 0) + (addEndMarker ? 1 : 0);
+  const buf8 = new Uint8Array(totalOutputLength);
+  let cursor = 0;
+  const EXCLAMATION_CODE = "!".charCodeAt(0);
+  for (const input of inputs) {
+    buf8[cursor++] = EXCLAMATION_CODE;
+    buf8[cursor++] = input.lengthBuf8.length;
+    buf8.set(input.lengthBuf8, cursor);
+    cursor += input.lengthBuf8.length;
+    buf8.set(input.buf8Input, cursor);
+    cursor += input.buf8Input.length;
+  }
+  if (addEndMarker) buf8[cursor] = "#".charCodeAt(0);
+  return buf8;
+};
+/** Helper for explodeBuf8List() */
+const extractConcatenatedBuffer = (mergedBuf8s, start, length) => {
+  const buffer = mergedBuf8s.slice(start, start + length);
+  return {
+    buffer,
+    newCursorPos: start + length
+  };
+};
+/** Helper for explodeBuf8List() */
+const readNewConcatenatedBuffer = (mergedBuf8s, initialCursor) => {
+  // Skip '!'
+  let cursor = initialCursor + 1;
+  const bufferLengthLength = mergedBuf8s[cursor++];
+  const bufferLength = parseInt(buf82str(mergedBuf8s.slice(cursor, cursor + bufferLengthLength)), MAX_RADIX);
+  cursor += bufferLengthLength;
+  return extractConcatenatedBuffer(mergedBuf8s, cursor, bufferLength);
+};
+/**
+ * Try to read a "middle" version buffer; the intermediate version with no delimiters.
+ *
+ * This format was short-lived and we just assume the buffers reach the end.
+ */
+const tryReadMiddleVersionBuffer = mergedBuf8s => {
+  if (mergedBuf8s.byteLength < 1) return;
+  // Don't lose time fake-decoding a newer buffer
+  const firstChar = mergedBuf8s[0];
+  if (firstChar === "!".charCodeAt(0) || firstChar === "#".charCodeAt(0)) return;
+  let cursor = 0;
+  const result = [];
+  while (cursor < mergedBuf8s.byteLength) {
+    const lengthStringLength = mergedBuf8s[cursor++];
+    if (cursor + lengthStringLength > mergedBuf8s.byteLength) return;
+    const lengthString = buf82str(getUint8Array(mergedBuf8s, cursor, lengthStringLength));
+    const length = parseInt(lengthString, MAX_RADIX);
+    cursor += lengthStringLength;
+    if (cursor + length > mergedBuf8s.byteLength) return;
+    const extraction = extractConcatenatedBuffer(mergedBuf8s, cursor, length);
+    cursor = extraction.newCursorPos;
+    result.push(extraction.buffer);
+  }
+  // Somewhat redundant but kept because I'm not sure the whole logic is sound
+  if (cursor !== mergedBuf8s.byteLength) return;
+  return result;
+};
+/** Helper for explodeBuf8List() */
+const readOldConcatenatedBuffer = (mergedBuf8s, initialCursor) => {
+  let cursor = initialCursor;
+  const lengthCharacters = [];
+  const COMMA_CODE = ",".charCodeAt(0);
+  while (cursor < mergedBuf8s.length) {
+    const readChar = mergedBuf8s[cursor++];
+    if (readChar === COMMA_CODE) break;
+    lengthCharacters.push(readChar);
+  }
+  const bufferLength = parseInt(lengthCharacters.map(charCode => String.fromCharCode(charCode)).join(""), HEX_DIGITS);
+  return extractConcatenatedBuffer(mergedBuf8s, cursor, bufferLength);
+};
+const parseBuf8List = mergedBuf8s => {
+  let cursor = 0;
+  // Compatibility layer
+  const result = tryReadMiddleVersionBuffer(mergedBuf8s) ?? [];
+  if (result.length === 0) {
+    while (cursor < mergedBuf8s.length) {
+      // Read buffer's length's length
+      const bufferFirstChar = mergedBuf8s[cursor];
+      // eslint-disable-next-line @typescript-eslint/init-declarations
+      let bufferResult;
+      if (bufferFirstChar === "!".charCodeAt(0)) {
+        // Read new buffer
+        bufferResult = readNewConcatenatedBuffer(mergedBuf8s, cursor);
+      } else if (bufferFirstChar === "#".charCodeAt(0)) {
+        ++cursor;
+        break;
+      } else {
+        bufferResult = readOldConcatenatedBuffer(mergedBuf8s, cursor);
+      }
+      result.push(bufferResult.buffer);
+      cursor = bufferResult.newCursorPos;
+    }
+  } else {
+    // This result comes from the compatibility layer, we used all the input buffer
+    cursor = mergedBuf8s.byteLength;
+  }
+  return {
+    data: result,
+    inputBytesUsed: cursor
+  };
+};
+/**
+ * Separate Uint8Array previously merged using concatenateBuf8List().
+ *
+ * Each buffer prefixed by a "!" uses the format described in `concatenateBuf8List()`.
+ * If a buffer is not prefixed by a "!", it uses the old format:
+ *
+ * - x bytes: the length of the buffer, as an hexadecimal string
+ * - 1 bytes: the "," character
+ * - y bytes: buffer content
+ *
+ * As a special case, if the first byte read for the next buffer is "#", which is an impossible
+ * character for both the old and new format, it is interpreted as the end of the buffer list.
+ *
+ * @public
+ */
+export const explodeBuf8List = mergedBuf8s => parseBuf8List(mergedBuf8s).data;
+/**
+ * Return the length of the buffer list, up to either the end marker or the buffer size.
+ *
+ * @public
+ */
+export const concatenatedBuf8ListSize = mergedBuf8s => parseBuf8List(mergedBuf8s).inputBytesUsed;
+/**
+ * Merge Uint8Arrays into one.
+ *
+ * This performs a simple concatenation;
+ *
+ * @public
+ */
+export const merge = buf8s => {
+  const fullLength = buf8s.reduce((acc, cur) => acc + cur.length, 0);
+  const buf8 = new Uint8Array(fullLength);
+  let cursor = 0;
+  for (const buf8Input of buf8s) {
+    buf8.set(buf8Input, cursor);
+    cursor += buf8Input.length;
+  }
+  return buf8;
+};
+/** @internal */
+export const pureB642Buf8 = (b64, strict = false) => getUint8Array(bitsB642ab(b64, strict));
+/**
+ * Convert a B64 string to an Uint8Array.
+ *
+ * @public
+ */
+export const b642buf8 = haveBufferBase64() ? bufferB642Buf8 : pureB642Buf8;
+/** @internal */
+export const pureUtf82Buf8 = str => new TextEncodingShim.TextEncoder().encode(str);
+/**
+ * Convert an UTF-8 string into an Uint8Array.
+ *
+ * @public
+ */
+export const utf82buf8 = haveBufferUTF8() ? bufferUtf82Buf8 : pureUtf82Buf8;
+/** @internal */
+export const pureBuf82Utf8 = buf8 => new TextEncodingShim.TextDecoder().decode(buf8);
+/**
+ * Convert an Uint8Array into an UTF-8 string
+ *
+ * @public
+ */
+export const buf82utf8 = haveBufferUTF8() ? bufferBuf82Utf8 : pureBuf82Utf8;
+/**
+ * Check that the content of two Uint8Array is equal.
+ *
+ * @public
+ */
+export const buf8Equal = (op1, op2) => arrayEqual(op1, op2);
+/**
+ * Find the position of a string in a buffer
+ *
+ * @param needle - String to find. Only work with 1 byte-wide characters.
+ *
+ * @param ab - Buffer to look into
+ *
+ * @param startPosition - Starting index to look from
+ *
+ * @returns
+ * The position of the string in the buffer. If not found returns -1
+ *
+ * @public
+ */
+export const findString = (needle, buf8, startPosition = 0) => {
+  let position = startPosition;
+  const charCodes = needle.split("").map(strChr => strChr.charCodeAt(0));
+  while (position < buf8.length) {
+    position = buf8.indexOf(charCodes[0], position);
+    // First character not found in buffer?
+    if (position === -1) break;
+    // Maybe we're too late
+    if (position > buf8.length - charCodes.length) break;
+    let valid = true;
+    // Possible match, test all upcoming characters
+    for (let i = 1; valid && i < charCodes.length; ++i) {
+      // Mismatch?
+      if (buf8[position + i] !== charCodes[i]) valid = false;
+    }
+    // Found string
+    if (valid) return position;
+    ++position;
+  }
+  return -1;
+};
+/**
+ * Find the position of a string in a buffer from the end
+ *
+ * @param needle - String to find. Only work with 1 byte characters.
+ *
+ * @param ab - Buffer to look into
+ *
+ * @param startPosition - Starting index to look from
+ *
+ * @param endPosition - Last index to look from. The needle must fit completely before this.
+ * -1 mean end of the file.
+ *
+ * @returns
+ * The position of the string in the buffer. If not found returns -1
+ *
+ * @public
+ */
+export const findLastString = (needle, buf8, startPosition = 0, endPosition = -1) => {
+  let position = endPosition === -1 ? buf8.length - 1 : endPosition;
+  const charCodes = needle.split("").reverse().map(strChr => strChr.charCodeAt(0));
+  while (position >= startPosition) {
+    position = buf8.lastIndexOf(charCodes[0], position);
+    // First character not found in buffer?
+    if (position === -1) break;
+    // Maybe we're too late
+    if (position < startPosition + charCodes.length) break;
+    let valid = true;
+    // Possible match, test all upcoming characters
+    for (let i = 1; valid && i < charCodes.length; ++i) {
+      // Mismatch?
+      if (buf8[position - i] !== charCodes[i]) valid = false;
+    }
+    // Found string
+    if (valid) return position - charCodes.length + 1;
+    --position;
+  }
+  return -1;
+};
+/* eslint-disable @typescript-eslint/no-magic-numbers */
+const isInvalidFollowByte = value => value === undefined || value < 0b10000000 || value >= 0b11000000;
+const utf8SequenceLength = byte1 => {
+  if (byte1 < 0b10000000) return 1;
+  if (byte1 < 0b11100000) return 2;
+  if (byte1 < 0b11110000) return 3;
+  if (byte1 < 0b11111000) return 4;
+  throw new Error("Invalid first byte");
+};
+/**
+ * Check if a byte sequence looks like a valid UTF-8 sequence that *does* have wide characters.
+ *
+ * https://en.wikipedia.org/wiki/UTF-8
+ *
+ * @returns
+ * `true` if the byte sequence does contain UTF-8 sequences.
+ * Regular ASCII string will return `false` as they won't contain such sequence.
+ */
+export const isUTF8Sequence = bytes => {
+  try {
+    let haveUTF8 = false;
+    const b = new FourBytes(bytes);
+    while (b.byte1 !== undefined) {
+      const seqLength = utf8SequenceLength(b.byte1);
+      // Voluntary fallthrough
+      /* eslint-disable no-fallthrough */
+      switch (seqLength) {
+        // Range 0x10000-0x10FFFF
+        case 4:
+          if (isInvalidFollowByte(b.byte4)) return false;
+        // Range 0x0800-0xFFFF
+        case 3:
+          if (isInvalidFollowByte(b.byte3)) return false;
+        // Range 0x80-0x07FF
+        case 2:
+          if (isInvalidFollowByte(b.byte2)) return false;
+          haveUTF8 = true;
+        // Range 0x00-0x7F
+        case 1:
+      }
+      /* eslint-enable no-fallthrough */
+      b.advance(seqLength);
+    }
+    return haveUTF8;
+  } catch {
+    return false;
+  }
+};
+/* eslint-enable @typescript-eslint/no-magic-numbers */
+export { buf82b64, pureBuf82B64 };

package/web/units.d.ts

@@ -0,0 +1,159 @@
+/**
+ * @license
+ * @preserve
+ *
+ * MIT License
+ * 
+ * Copyright (c) 2023 KeeeX SAS
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ */
+import ms from "ms";
+/** Coerce a delay value to milliseconds using `ms` if a string is provided */
+export declare const delayInMs: (delayInMsValue: number | ms.StringValue) => number;
+/**
+ * How to convert from one level to the next for a given unit.
+ *
+ * @public
+ */
+interface UnitConversion {
+    prefix?: string;
+    unitName?: string;
+    suffix?: string;
+    multiplierFromPrevious: number;
+}
+/**
+ * Description of a unit system to convert from one level to another.
+ *
+ * @public
+ */
+interface UnitDescription {
+    prefixUnit?: boolean;
+    /** The base name of the unit that will be prefixed/suffixed for each level */
+    basename: string;
+    /** All conversion levels in order from smallest to largest */
+    levels: Array<UnitConversion>;
+}
+/**
+ * Convert description for byte based values
+ *
+ * @public
+ */
+export declare const byteUnit: UnitDescription;
+/**
+ * Convert description for small time based values
+ *
+ * Handles `ms`, `s`, `m` (minutes), `h`, `d`, `w` (weeks)
+ *
+ * @public
+ */
+export declare const timeUnit: UnitDescription;
+type InputAllType = string | number | bigint;
+/**
+ * Convert a numerical value from a given unit multiplier to another.
+ *
+ * @param value - Either the value in the base unit multiplier, or a string with a unit
+ *
+ * @public
+ */
+export declare const unitConvert: (unitDescription: UnitDescription, value: string | number, target?: string) => number;
+/**
+ * Convert a numerical value from a given unit multiplier to another.
+ *
+ * This is the bigint variant, and can only handle integer values.
+ *
+ * @param value - Either the value in the base unit multiplier, or a string with a unit
+ *
+ * @public
+ */
+export declare const unitConvertBigint: (unitDescription: UnitDescription, value: string | bigint | number, target?: string) => bigint;
+/**
+ * Display a value in the largest relevant unit.
+ *
+ * For example, a call with "5678B" would return "5.68kB".
+ * This will lose precision and is destined to human reading.
+ *
+ * @public
+ */
+export declare const unitString: (unitDescription: UnitDescription, value: string | number, decimalPlaces?: number) => string;
+/**
+ * Display a value in the largest relevant unit.
+ *
+ * Bigint variant, will not return decimal values.
+ *
+ * For example, a call with "5678B" would return "5,7kB".
+ * This will lose precision and is destined to human reading.
+ *
+ * @public
+ */
+export declare const unitStringBigint: (unitDescription: UnitDescription, value: string | bigint) => string;
+/**
+ * Convert a size in bytes from one unit to another.
+ *
+ * @param targetUnit - Target unit (`kB`, `MB`, etc.). Defaults to `B`.
+ *
+ * @public
+ */
+export declare const byteConvert: (value: string | number, targetUnit?: string) => number;
+/**
+ * Convert a size in bytes from one unit to another.
+ *
+ * Bigint based function; can only handle integer values.
+ *
+ * @param targetUnit - Target unit (`kB`, `MB`, etc.). Defaults to `B`.
+ *
+ * @public
+ */
+export declare const byteConvertBigint: (value: InputAllType, targetUnit?: string) => bigint;
+/**
+ * Display a human-readable byte size value.
+ *
+ * @public
+ */
+export declare const byteString: (value: string | number, decimalPlaces?: number) => string;
+/**
+ * Display a human-readable byte size value.
+ *
+ * Bigint variant, only handle integer values.
+ *
+ * @public
+ */
+export declare const byteStringBigint: (value: string | bigint) => string;
+/**
+ * Convert a short time from one unit to another.
+ *
+ * @param targetUnit - Target unit (`ms`, `h`, etc.). Defaults to `s`.
+ *
+ * @public
+ */
+export declare const timeConvert: (value: string | number, targetUnit?: string) => number;
+/**
+ * Convert a short time from one unit to another.
+ *
+ * Biting based function; can only handle integer values.
+ *
+ * @param targetUnit - Target unit (`ms`, `h`, etc.). Defaults to `s`.
+ *
+ * @public
+ */
+export declare const timeConvertBigint: (value: InputAllType, targetUnit?: string) => bigint;
+/**
+ * Display a human-readable short time value.
+ *
+ * @public
+ */
+export declare const timeString: (value: string | number, decimalPlaces?: number) => string;
+/**
+ * Display a human-readable short time value.
+ *
+ * Bigint variant, only handle integer values.
+ *
+ * @public
+ */
+export declare const timeStringBigint: (value: string | bigint) => string;
+export {};