@keeex/utils 7.0.1

package/web/types/record.js

@@ -0,0 +1,213 @@
+/**
+ * @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 { asError } from "../error.js";
+import { PredicateError } from "./predicateerror.js";
+import { getPredicateOptions } from "./types.js";
+/**
+ * Extract modifiers from primitive type name
+ *
+ * A type prefixed/suffixed with "?" is optional.
+ * A type prefixed/suffixed with "!" is a shortcut (only shortcut are tested in shortcut mode)
+ *
+ * @internal
+ */
+const trimTypeValue = typeName => {
+  let expectedValueType = typeName;
+  let optional = false;
+  let shortcut = false;
+  const specialChars = ["?", "!"];
+  while (specialChars.includes(expectedValueType[0])) {
+    const chr = expectedValueType[0];
+    expectedValueType = expectedValueType.slice(1);
+    if (chr === "?") optional = true;
+    if (chr === "!") shortcut = true;
+  }
+  while (specialChars.includes(expectedValueType[expectedValueType.length - 1])) {
+    const chr = expectedValueType[expectedValueType.length - 1];
+    expectedValueType = expectedValueType.slice(0, -1);
+    if (chr === "?") optional = true;
+    if (chr === "!") shortcut = true;
+  }
+  return {
+    expectedValueType,
+    optional,
+    shortcut
+  };
+};
+const isValueMatchPrimitive = (rec, key, typeValue, options) => {
+  if (typeValue === "skip") return true;
+  const {
+    optional,
+    shortcut,
+    expectedValueType
+  } = trimTypeValue(typeValue);
+  if (options.shortcut && !shortcut) return true;
+  if (key in rec && rec[key] !== undefined) {
+    const actualValueType = typeof rec[key];
+    if (actualValueType !== expectedValueType) {
+      PredicateError.expected(options.raise, key, `primitive type ${expectedValueType}`);
+      return false;
+    }
+  } else if (!optional) {
+    PredicateError.mandatory(options.raise, key);
+    return false;
+  }
+  return true;
+};
+const isValueMatchClazz = (value, typeValue, key, options) => {
+  if (!(value instanceof typeValue.clazz)) {
+    const name = typeof typeValue.clazz === "function" ? typeValue.clazz.name : "<something>";
+    PredicateError.expected(options.raise, key, `instance of ${name}`);
+    return false;
+  }
+  return true;
+};
+const isValueMatchPredicate = (value, typeValue, key, options) => {
+  try {
+    if (!typeValue.predicate(value, options)) {
+      PredicateError.predicateFailed(options.raise, key);
+      return false;
+    }
+  } catch (e) {
+    if (e instanceof PredicateError) PredicateError.keyError(options.raise, key, e);
+    throw e;
+  }
+  return true;
+};
+const isValueMatchValue = (value, typeValue, key, options) => {
+  if (value !== typeValue.value) {
+    PredicateError.expected(options.raise, key, "value");
+    return false;
+  }
+  return true;
+};
+// Helper
+const isValueMatchPresent = (value, typeValue, key, options) => {
+  if (options.shortcut && !typeValue.shortcut) return true;
+  if ("clazz" in typeValue) {
+    if (!isValueMatchClazz(value, typeValue, key, options)) return false;
+  } else if ("predicate" in typeValue) {
+    if (!isValueMatchPredicate(value, typeValue, key, options)) return false;
+  } else if ("value" in typeValue) {
+    if (!isValueMatchValue(value, typeValue, key, options)) return false;
+  }
+  return true;
+};
+const isValueMatchAdvanced = (rec, key, typeValue, options) => {
+  if (options.shortcut && !typeValue.shortcut) return true;
+  if (key in rec && rec[key] !== undefined) {
+    return isValueMatchPresent(rec[key], typeValue, key, options);
+  }
+  const result = Boolean(typeValue.optional);
+  if (!result) PredicateError.mandatory(options.raise, key);
+  return result;
+};
+/** Check a single match between a profile and an actual object value */
+const isValueMatch = (rec, key, typeValue, options) => {
+  if (typeof typeValue === "string") return isValueMatchPrimitive(rec, key, typeValue, options);
+  if (typeof typeValue === "function") {
+    if (options.shortcut) return true;
+    try {
+      const res = typeValue(rec[key], options);
+      if (!res) PredicateError.predicateFailed(options.raise, key);
+      return res;
+    } catch (e) {
+      if (e instanceof PredicateError) PredicateError.keyError(options.raise, key, e);
+      throw e;
+    }
+  }
+  return isValueMatchAdvanced(rec, key, typeValue, options);
+};
+const checkArrayTypeDef = (valueType, rec, keyName, options) => {
+  let anyAccept = false;
+  const errors = [];
+  for (const typeInfo of valueType) {
+    try {
+      const res = isValueMatch(rec, keyName, typeInfo, options);
+      if (res) {
+        anyAccept = true;
+        break;
+      }
+    } catch (e) {
+      errors.push(asError(e));
+    }
+  }
+  if (!anyAccept) {
+    PredicateError.allTryFailed(options.raise, keyName, errors);
+    return false;
+  }
+  return true;
+};
+/**
+ * Check if an object's properties fit the basic types profile.
+ *
+ * Only fit to check primitive types, equality and using other predicates.
+ * If `shortcut: true` is used in the options, only properties marked as "shortcut" are checked.
+ * For structured properties like instanceof and predicate this is indicated by the `shortcut`
+ * property; for primary type predicate this is indicated by the "!" character either before or
+ * after the type name.
+ *
+ * @public
+ */
+export const isObjectProfile = (obj, profile, options = false) => {
+  const opt = getPredicateOptions(options);
+  if (typeof obj !== "object" || obj === null) {
+    PredicateError.predicateFailed(opt.raise, "root");
+    return false;
+  }
+  const rec = obj;
+  for (const keyName of Object.keys(profile)) {
+    const valueType = profile[keyName];
+    if (Array.isArray(valueType)) {
+      const res = checkArrayTypeDef(valueType, rec, keyName, opt);
+      if (!res) return false;
+    } else if (!isValueMatch(rec, keyName, valueType, opt)) return false;
+  }
+  return true;
+};
+/**
+ * Create a predicate function based on the given profile.
+ *
+ * @public
+ */
+export const makeProfilePredicate = profile => (obj, options = false) => isObjectProfile(obj, profile, options);
+/**
+ * Check if all of an object properties match a given type.
+ *
+ * @public
+ */
+export const isKeyValueOfType = (obj, typePredicate, options = false) => {
+  const opt = getPredicateOptions(options);
+  if (typeof obj !== "object") {
+    PredicateError.predicateFailed(opt.raise, undefined);
+    return false;
+  }
+  const rec = obj;
+  for (const key of Object.keys(rec)) {
+    try {
+      if (!typePredicate(rec[key], opt)) {
+        PredicateError.predicateFailed(opt.raise, key);
+        return false;
+      }
+    } catch (e) {
+      if (e instanceof PredicateError) PredicateError.keyError(opt.raise, key, e);
+      throw e;
+    }
+  }
+  return true;
+};
+/** @public */
+export const makeKeyValueOfTypePredicate = typePredicate => (obj, options = false) => isKeyValueOfType(obj, typePredicate, options);

package/web/types/types.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @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.
+ * 
+ */
+export interface PredicateOptionsFull {
+    raise?: boolean;
+    shortcut?: boolean;
+}
+export type PredicateOptions = boolean | PredicateOptionsFull;
+export type TypePredicate<T = unknown> = (obj: unknown, optionsOrRaise?: PredicateOptions) => obj is T;
+/**
+ * Wrap the optional second argument of predicates into the full predicate options
+ *
+ * @internal
+ */
+export declare const getPredicateOptions: (optionsOrRaise?: PredicateOptions) => Required<PredicateOptionsFull>;
+/**
+ * Create a predicate that check in sequence multiple predicates and return true if one succeed.
+ *
+ * Used for construction similar to `type T = T1 | T2`
+ */
+export declare const makeOrPredicate: <T>(predicates: Array<TypePredicate>) => TypePredicate<T>;
+/** Type used for something that can be either a promise or not */
+export type Awaitable<T> = Promise<T> | T;
+/** Ensure that the string match a given regex */
+export declare const isMatchRegexPredicate: <T>(obj: unknown, regex: RegExp, options?: PredicateOptions) => obj is T;
+/**
+ * Convert a type template string to a regex.
+ *
+ * The template string name can be any of:
+ *
+ * - string
+ * - number
+ * - bigint
+ * - boolean
+ * - null
+ * - undefined
+ *
+ * Unknown names will be picked from the `substitutions` parameter.
+ * Missing names will throw an error.
+ *
+ * @param template - The type template string.
+ * @param substitutions - An object for direct string substitutions of unknown keys from template
+ */
+export declare const makeTemplateRegex: (template: string, substitutions?: Record<string, Array<string>>) => RegExp;
+/**
+ * Match a template type value.
+ *
+ * It is advisable to use `makeTemplatePredicate()` instead, as it will cache the computed regex.
+ */
+export declare const isTemplatePredicate: <T>(obj: unknown, template: string, substitutions: Record<string, Array<string>>, options?: PredicateOptions) => obj is T;
+/** Create a predicate function that matches the given template type string. */
+export declare const makeTemplatePredicate: <T>(template: string, substitutions?: Record<string, Array<string>>) => TypePredicate<T>;

package/web/types/types.js

@@ -0,0 +1,123 @@
+/**
+ * @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 { asError } from "../error.js";
+import { PredicateError } from "./predicateerror.js";
+/**
+ * Wrap the optional second argument of predicates into the full predicate options
+ *
+ * @internal
+ */
+export const getPredicateOptions = optionsOrRaise => {
+  if (!optionsOrRaise) return {
+    raise: false,
+    shortcut: false
+  };
+  if (typeof optionsOrRaise === "boolean") return {
+    raise: optionsOrRaise,
+    shortcut: false
+  };
+  return {
+    raise: false,
+    shortcut: false,
+    ...optionsOrRaise
+  };
+};
+/**
+ * Create a predicate that check in sequence multiple predicates and return true if one succeed.
+ *
+ * Used for construction similar to `type T = T1 | T2`
+ */
+export const makeOrPredicate = predicates => (obj, options = false) => {
+  const opt = getPredicateOptions(options);
+  const errors = [];
+  for (const predicate of predicates) {
+    try {
+      if (predicate(obj, {
+        raise: true,
+        shortcut: opt.shortcut
+      })) return true;
+    } catch (e) {
+      errors.push(asError(e));
+    }
+  }
+  if (opt.raise) throw new PredicateError({
+    cause: errors
+  });
+  return false;
+};
+/** Ensure that the string match a given regex */
+export const isMatchRegexPredicate = (obj, regex, options = false) => {
+  const opt = getPredicateOptions(options);
+  if (typeof obj !== "string" || !regex.exec(obj)) {
+    PredicateError.predicateFailed(opt.raise, undefined);
+    return false;
+  }
+  return true;
+};
+/** Return a regex portion for a choice of strings */
+const regexForStringChoice = choices => `(${choices.map(c => c.replaceAll("|", "\\|").replaceAll(")", "\\)")).join("|")})`;
+/** Substitutions for template types */
+const defaultSubstitutions = {
+  bigint: "-?\\d+",
+  boolean: regexForStringChoice(["true", "false"]),
+  null: "null",
+  number: "[+-]?(?:\\d+\\.?\\d*|\\d*\\.?\\d+)",
+  string: ".*",
+  undefined: "undefined"
+};
+/**
+ * Convert a type template string to a regex.
+ *
+ * The template string name can be any of:
+ *
+ * - string
+ * - number
+ * - bigint
+ * - boolean
+ * - null
+ * - undefined
+ *
+ * Unknown names will be picked from the `substitutions` parameter.
+ * Missing names will throw an error.
+ *
+ * @param template - The type template string.
+ * @param substitutions - An object for direct string substitutions of unknown keys from template
+ */
+export const makeTemplateRegex = (template, substitutions) => {
+  const regexStr = template.replace(/\$\{(?<inputText>.+?)\}/gu, (_, inputText) => {
+    if (inputText in defaultSubstitutions) return defaultSubstitutions[inputText];
+    if (substitutions && inputText in substitutions) {
+      return regexForStringChoice(substitutions[inputText]);
+    }
+    throw new Error(`Unknown substitution "${inputText}" in template`);
+  });
+  return new RegExp(`^${regexStr}$`, "u");
+};
+/**
+ * Match a template type value.
+ *
+ * It is advisable to use `makeTemplatePredicate()` instead, as it will cache the computed regex.
+ */
+export const isTemplatePredicate = (obj, template, substitutions, options = false) => {
+  if (typeof obj !== "string") return false;
+  const regex = makeTemplateRegex(template, substitutions);
+  return isMatchRegexPredicate(obj, regex, options);
+};
+/** Create a predicate function that matches the given template type string. */
+export const makeTemplatePredicate = (template, substitutions) => {
+  const regex = makeTemplateRegex(template, substitutions);
+  return (obj, options = false) => isMatchRegexPredicate(obj, regex, options);
+};

package/web/types/utils.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @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";
+/** Check that a value is suitable for input for `ms()` */
+export declare const isMsInput: import("./types.js").TypePredicate<number | ms.StringValue>;

package/web/types/utils.js

@@ -0,0 +1,30 @@
+/**
+ * @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 { isNumber } from "./primitive.js";
+import { makeOrPredicate, makeTemplatePredicate } from "./types.js";
+/** All `ms()` units, extracted from type definition */
+const msBaseUnits = ["Years", "Year", "Yrs", "Yr", "Y", "Weeks", "Week", "W", "Days", "Day", "D", "Hours", "Hour", "Hrs", "Hr", "H", "Minutes", "Minute", "Mins", "Min", "M", "Seconds", "Second", "Secs", "Sec", "s", "Milliseconds", "Millisecond", "Msecs", "Msec", "Ms"];
+/** All `ms()` units, including lowercase and uppercase */
+const msUnitAnyCase = Array.from(new Set([...msBaseUnits, ...msBaseUnits.map(c => c.toUpperCase()), ...msBaseUnits.map(c => c.toLowerCase())]));
+const isMsStrInput = makeTemplatePredicate("${number}");
+const isMsStrUnitPredicate = makeTemplatePredicate("${number}${msUnitAnyCase}", {
+  msUnitAnyCase
+});
+const isMsSpaceUnitPredicate = makeTemplatePredicate("${number} ${msUnitAnyCase}", {
+  msUnitAnyCase
+});
+/** Check that a value is suitable for input for `ms()` */
+export const isMsInput = makeOrPredicate([isNumber, isMsStrInput, isMsStrUnitPredicate, isMsSpaceUnitPredicate]);

package/web/uint8array.d.ts

@@ -0,0 +1,176 @@
+/**
+ * @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 { pureBuf82B64, buf82b64 } from "./bits/uint8array.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 declare const getUint8Array: (arrayBuffer: ArrayBuffer | Uint8Array, offset?: number, length?: number, clone?: boolean) => Uint8Array;
+/**
+ * Convert an Uint8Array to a raw string.
+ *
+ * @public
+ */
+export declare const buf82str: (buf8: Uint8Array) => string;
+/**
+ * Convert a string to an Uint8Array
+ *
+ * @public
+ */
+export declare const str2buf8: (str: string) => Uint8Array;
+/** @internal */
+export declare const pureBuf82Hex: (buf8: Uint8Array, addPrefix?: boolean) => string;
+/**
+ * Convert an Uint8Array to a hex string.
+ *
+ * @public
+ */
+export declare const buf82hex: (buf8: Uint8Array, addPrefix?: boolean) => string;
+/** @internal */
+export declare const pureHex2Buf8: (hex: string) => Uint8Array;
+/**
+ * Convert an hex string to an Uint8Array.
+ *
+ * @public
+ */
+export declare const hex2buf8: (hex: string) => Uint8Array;
+/**
+ * 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 declare const concatenateBuf8List: (buf8s: Array<Uint8Array>, addEndMarker?: boolean) => Uint8Array;
+/**
+ * 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 declare const explodeBuf8List: (mergedBuf8s: Uint8Array) => Array<Uint8Array>;
+/**
+ * Return the length of the buffer list, up to either the end marker or the buffer size.
+ *
+ * @public
+ */
+export declare const concatenatedBuf8ListSize: (mergedBuf8s: Uint8Array) => number;
+/**
+ * Merge Uint8Arrays into one.
+ *
+ * This performs a simple concatenation;
+ *
+ * @public
+ */
+export declare const merge: (buf8s: Array<Uint8Array>) => Uint8Array;
+/** @internal */
+export declare const pureB642Buf8: (b64: string, strict?: boolean) => Uint8Array;
+/**
+ * Convert a B64 string to an Uint8Array.
+ *
+ * @public
+ */
+export declare const b642buf8: (b64: string, strict?: boolean) => Uint8Array;
+/** @internal */
+export declare const pureUtf82Buf8: (str: string) => Uint8Array;
+/**
+ * Convert an UTF-8 string into an Uint8Array.
+ *
+ * @public
+ */
+export declare const utf82buf8: (utf8: string) => Uint8Array;
+/** @internal */
+export declare const pureBuf82Utf8: (buf8: Uint8Array) => string;
+/**
+ * Convert an Uint8Array into an UTF-8 string
+ *
+ * @public
+ */
+export declare const buf82utf8: (buf8: Uint8Array) => string;
+/**
+ * Check that the content of two Uint8Array is equal.
+ *
+ * @public
+ */
+export declare const buf8Equal: (op1: Uint8Array, op2: Uint8Array) => boolean;
+/**
+ * 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 declare const findString: (needle: string, buf8: Uint8Array, startPosition?: number) => number;
+/**
+ * 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 declare const findLastString: (needle: string, buf8: Uint8Array, startPosition?: number, endPosition?: number) => number;
+/**
+ * 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 declare const isUTF8Sequence: (bytes: Uint8Array) => boolean;
+export { buf82b64, pureBuf82B64 };