@fgv/ts-utils 5.0.0-21 → 5.0.0-23

package/src/packlets/file-tree/in-memory/inMemoryTree.ts

@@ -1,171 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * 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 { captureResult, fail, Result, succeed } from '../../base';
-import { DirectoryItem } from '../directoryItem';
-import { FileItem } from '../fileItem';
-import { FileTreeItem, IFileTreeAccessors } from '../fileTreeAccessors';
-import { InMemoryDirectory, InMemoryFile, TreeBuilder } from './treeBuilder';
-
-/**
- * Represents a single file in an in-memory {@link FileTree.FileTree | file tree}.
- * @public
- */
-export interface IInMemoryFile {
-  /**
-   * The absolute path of the file in the tree.
-   */
-  readonly path: string;
-
-  /**
-   * The contents of the file
-   */
-  readonly contents: unknown;
-}
-
-/**
- * Implementation of {@link FileTree.IFileTreeAccessors | IFileTreeAccessors} that uses an in-memory
- * tree to access files and directories.
- * @public
- */
-export class InMemoryTreeAccessors implements IFileTreeAccessors {
-  private readonly _tree: TreeBuilder;
-
-  /**
-   * Protected constructor for derived classes.
-   * @param files - An array of {@link FileTree.IInMemoryFile | in-memory files} to include in the tree.
-   * @param prefix - Optional prefix for the tree.
-   * @public
-   */
-  protected constructor(files: IInMemoryFile[], prefix?: string) {
-    this._tree = TreeBuilder.create(prefix).orThrow();
-    for (const file of files) {
-      this._tree.addFile(file.path, file.contents).orThrow();
-    }
-  }
-
-  /**
-   * Creates a new {@link FileTree.InMemoryTreeAccessors | InMemoryTreeAccessors} instance with the supplied
-   * in-memory files.
-   * @param files - An array of {@link FileTree.IInMemoryFile | in-memory files} to include in the tree.
-   * @param prefix - Optional prefix for the tree.
-   */
-  public static create(files: IInMemoryFile[], prefix?: string): Result<InMemoryTreeAccessors> {
-    return captureResult(() => new InMemoryTreeAccessors(files, prefix));
-  }
-
-  /**
-   * {@inheritDoc FileTree.IFileTreeAccessors.resolveAbsolutePath}
-   */
-  public resolveAbsolutePath(...paths: string[]): string {
-    const parts = paths[0].startsWith('/') ? paths : [this._tree.prefix, ...paths];
-    const joined = parts.flatMap((p) => p.split('/').filter((s) => s.length > 0)).join('/');
-    return `/${joined}`;
-  }
-
-  /**
-   * {@inheritdoc FileTree.IFileTreeAccessors.getExtension}
-   */
-  public getExtension(path: string): string {
-    const parts = path.split('.');
-    if (parts.length === 1) {
-      return '';
-    }
-    return `.${parts.pop()}`;
-  }
-
-  /**
-   * {@inheritdoc FileTree.IFileTreeAccessors.getBaseName}
-   */
-  public getBaseName(path: string, suffix?: string): string {
-    /* c8 ignore next 1 - ?? is defense in depth should never happen */
-    const base = path.split('/').pop() ?? '';
-    if (suffix && base.endsWith(suffix)) {
-      return base.slice(0, base.length - suffix.length);
-    }
-    return base;
-  }
-
-  /**
-   * {@inheritdoc FileTree.IFileTreeAccessors.joinPaths}
-   */
-  public joinPaths(...paths: string[]): string {
-    return paths.join('/');
-  }
-
-  /**
-   * {@inheritDoc FileTree.IFileTreeAccessors.getItem}
-   */
-  public getItem(itemPath: string): Result<FileTreeItem> {
-    const existing = this._tree.byAbsolutePath.get(itemPath);
-    if (existing) {
-      if (existing instanceof InMemoryFile) {
-        return FileItem.create(existing.absolutePath, this);
-      } else if (existing instanceof InMemoryDirectory) {
-        return DirectoryItem.create(existing.absolutePath, this);
-      }
-    }
-    return fail(`${itemPath}: not found`);
-  }
-
-  /**
-   * {@inheritDoc FileTree.IFileTreeAccessors.getFileContents}
-   */
-  public getFileContents(path: string): Result<string> {
-    const item = this._tree.byAbsolutePath.get(path);
-    if (item === undefined) {
-      return fail(`${path}: not found`);
-    }
-    if (!(item instanceof InMemoryFile)) {
-      return fail(`${path}: not a file`);
-    }
-    // if the body is a string we don't want to add quotes
-    if (typeof item.contents === 'string') {
-      return succeed(item.contents);
-    }
-    return captureResult(() => JSON.stringify(item.contents));
-  }
-
-  /**
-   * {@inheritDoc FileTree.IFileTreeAccessors.getChildren}
-   */
-  public getChildren(path: string): Result<ReadonlyArray<FileTreeItem>> {
-    const item = this._tree.byAbsolutePath.get(path);
-    if (item === undefined) {
-      return fail(`${path}: not found`);
-    }
-    if (!(item instanceof InMemoryDirectory)) {
-      return fail(`${path}: not a directory`);
-    }
-    return captureResult(() => {
-      const children: FileTreeItem[] = [];
-      for (const child of item.children.values()) {
-        if (child instanceof InMemoryFile) {
-          children.push(FileItem.create(child.absolutePath, this).orThrow());
-        } else if (child instanceof InMemoryDirectory) {
-          children.push(DirectoryItem.create(child.absolutePath, this).orThrow());
-        }
-      }
-      return children;
-    });
-  }
-}

package/src/packlets/file-tree/in-memory/index.ts

@@ -1,23 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * 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 * from './inMemoryTree';

package/src/packlets/file-tree/in-memory/treeBuilder.ts

@@ -1,203 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * 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 { Result, captureResult, fail, succeed } from '../../base';
-
-/**
- * Represents a file in an in-memory file tree.
- * @public
- */
-export class InMemoryFile {
-  /**
-   * The absolute path of the file.
-   */
-  public readonly absolutePath: string;
-  /**
-   * The contents of the file.
-   */
-  public readonly contents: unknown;
-
-  /**
-   * Creates a new {@link InMemoryFile | InMemoryFile} instance.
-   * @param absolutePath - The absolute path of the file.
-   * @param contents - The contents of the file.
-   */
-  public constructor(absolutePath: string, contents: unknown) {
-    this.absolutePath = absolutePath;
-    this.contents = contents;
-  }
-}
-
-/**
- * Represents a directory in an in-memory file tree.
- * @public
- */
-export class InMemoryDirectory {
-  /**
-   * The absolute path of the directory.
-   */
-  public readonly absolutePath: string;
-  protected _children: Map<string, InMemoryDirectory | InMemoryFile>;
-
-  /**
-   * The children of the directory.
-   */
-  public get children(): ReadonlyMap<string, InMemoryDirectory | InMemoryFile> {
-    return this._children;
-  }
-
-  /**
-   * Creates an empty new {@link InMemoryDirectory | InMemoryDirectory} instance.
-   * @param absolutePath - The absolute path of the directory.
-   */
-  public constructor(absolutePath: string) {
-    this.absolutePath = absolutePath;
-    this._children = new Map<string, InMemoryDirectory | InMemoryFile>();
-  }
-
-  /**
-   * Gets or adds a child directory with the specified name.
-   * @param name - The name of the child directory.
-   * @returns {@link Success | Success} with the child directory if successful, or
-   * {@link Failure | Failure} with an error message otherwise.
-   */
-  public getOrAddDirectory(name: string): Result<InMemoryDirectory> {
-    const existing = this._children.get(name);
-    if (existing) {
-      if (existing instanceof InMemoryDirectory) {
-        return succeed(existing);
-      }
-      return fail(`${name}: not a directory`);
-    }
-    const child = new InMemoryDirectory(this.getChildPath(name));
-    this._children.set(name, child);
-    return succeed(child);
-  }
-
-  /**
-   * Adds a file to the directory.
-   * @param name - The name of the file.
-   * @param contents - The contents of the file.
-   * @returns {@link Success | Success} with the new file if successful, or
-   * {@link Failure | Failure} with an error message otherwise.
-   */
-  public addFile(name: string, contents: unknown): Result<InMemoryFile> {
-    if (this._children.has(name)) {
-      return fail(`${name}: already exists`);
-    }
-    const child = new InMemoryFile(this.getChildPath(name), contents);
-    this._children.set(name, child);
-    return succeed(child);
-  }
-
-  /**
-   * Gets the absolute path for a child of this directory with the supplied
-   * name.
-   * @param name - The name of the child.
-   * @returns {@link Success | Success} with the absolute path if successful, or
-   * {@link Failure | Failure} with an error message otherwise.
-   */
-  public getChildPath(name: string): string {
-    if (this.absolutePath === '/') {
-      return `/${name}`;
-    }
-    return [this.absolutePath, name].join('/');
-  }
-}
-
-/**
- * Helper class to build an in-memory file tree.
- * @public
- */
-export class TreeBuilder {
-  /**
-   * The prefix for all paths in the tree.
-   */
-  public readonly prefix: string;
-
-  /**
-   * The root directory of the tree.
-   */
-  public readonly root: InMemoryDirectory;
-
-  /**
-   * A map of all directories and files in the tree by absolute path.
-   */
-  public readonly byAbsolutePath: Map<string, InMemoryDirectory | InMemoryFile>;
-
-  /**
-   * Protected constructor for derived classes.
-   * @param prefix - The prefix for all paths in the tree.
-   * @public
-   */
-  protected constructor(prefix?: string) {
-    this.prefix = prefix ?? '/';
-    if (!this.prefix.startsWith('/')) {
-      throw new Error(`${prefix}: not an absolute path`);
-    }
-    this.root = new InMemoryDirectory(this.prefix);
-    this.byAbsolutePath = new Map<string, InMemoryDirectory | InMemoryFile>();
-    this.byAbsolutePath.set(this.prefix, this.root);
-  }
-
-  /**
-   * Creates a new {@link TreeBuilder | TreeBuilder} instance.
-   * @param prefix - The prefix for all paths in the tree.
-   * @returns {@link Success | Success} with the new {@link TreeBuilder | TreeBuilder} instance if successful,
-   * or {@link Failure | Failure} with an error message otherwise.
-   * @public
-   */
-  public static create(prefix?: string): Result<TreeBuilder> {
-    return captureResult(() => new TreeBuilder(prefix));
-  }
-
-  /**
-   * Adds a file to the tree.
-   * @param absolutePath - The absolute path of the file.
-   * @param contents - The contents of the file.
-   * @returns {@link Success | Success} with the new file if successful, or
-   * {@link Failure | Failure} with an error message otherwise.
-   * @public
-   */
-  public addFile(absolutePath: string, contents: unknown): Result<InMemoryFile> {
-    const parts = absolutePath.split('/').filter((p) => p.length > 0);
-    if (parts.length === 0) {
-      return fail(`${absolutePath}: invalid file path`);
-    }
-    let dir = this.root;
-    while (parts.length > 1) {
-      const part = parts.shift()!;
-      const result = dir.getOrAddDirectory(part);
-      if (result.isFailure()) {
-        return fail(result.message);
-      }
-      dir = result.value;
-      if (!this.byAbsolutePath.has(dir.absolutePath)) {
-        this.byAbsolutePath.set(dir.absolutePath, dir);
-      }
-    }
-    return dir.addFile(parts[0], contents).onSuccess((file) => {
-      this.byAbsolutePath.set(file.absolutePath, file);
-      return succeed(file);
-    });
-  }
-}

package/src/packlets/file-tree/index.ts

@@ -1,31 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * 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 { IInMemoryFile, InMemoryTreeAccessors } from './in-memory';
-
-export * from './directoryItem';
-export * from './fileItem';
-export * from './fileTreeAccessors';
-export * from './fsTree';
-export * from './fileTree';
-
-export { IInMemoryFile, InMemoryTreeAccessors };

package/src/packlets/hash/crcNormalizer.ts

@@ -1,81 +0,0 @@
-/*
- * Copyright (c) 2023 Erik Fortune
- *
- * 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 { HashingNormalizer } from './hashingNormalizer';
-
-const textEncoder: TextEncoder = new TextEncoder();
-
-const POLYNOMIAL: number = 0xedb88320;
-
-const crc32Table: number[] = [];
-
-function crc32(bytes: Uint8Array, crc: number = 0xffffffff): number {
-  if (crc32Table.length === 0) {
-    buildCrc32Table();
-  }
-  for (let i = 0; i < bytes.length; ++i) {
-    // eslint-disable-next-line no-bitwise
-    crc = crc32Table[(crc ^ bytes[i]) & 0xff] ^ (crc >>> 8);
-  }
-  return (crc ^ -1) >>> 0;
-}
-
-const toUInt32 = (n: number): number => {
-  if (n >= 0) {
-    return n;
-  }
-  return 0xffffffff - n * -1 + 1;
-};
-
-function buildCrc32Table(): void {
-  if (crc32Table.length === 0) {
-    for (let n = 0; n < 256; n++) {
-      let r = n;
-      for (let i = 0; i < 8; i++) {
-        // eslint-disable-next-line no-bitwise
-        if (r & 1) {
-          r = (r >>> 1) ^ POLYNOMIAL;
-        } else {
-          r = r >>> 1;
-        }
-      }
-      crc32Table.push(toUInt32(r));
-    }
-  }
-}
-
-/**
- * A {@link Hash.HashingNormalizer | hashing normalizer} which computes object
- * hash using the CRC32 algorithm.
- * @public
- */
-export class Crc32Normalizer extends HashingNormalizer {
-  public constructor() {
-    super(Crc32Normalizer.crc32Hash);
-  }
-
-  public static crc32Hash(parts: string[]): string {
-    return crc32(textEncoder.encode(parts.join('|')))
-      .toString(16)
-      .padStart(8, '0');
-  }
-}

package/src/packlets/hash/hashingNormalizer.ts

@@ -1,102 +0,0 @@
-/*
- * Copyright (c) 2021 Erik Fortune
- *
- * 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 { Normalizer, Result, captureResult, fail, mapResults, succeed } from '../base';
-
-/**
- * Function to compute a hash from a pre-normalized array of strings.
- * @public
- */
-export type HashFunction = (parts: string[]) => string;
-
-/**
- * Normalizes an arbitrary JSON object
- * @public
- */
-export class HashingNormalizer extends Normalizer {
-  private _hash: HashFunction;
-
-  public constructor(hash: HashFunction) {
-    super();
-    this._hash = hash;
-  }
-
-  public computeHash(from: unknown): Result<string> {
-    switch (typeof from) {
-      case 'string':
-      case 'bigint':
-      case 'boolean':
-      case 'number':
-      case 'symbol':
-      case 'undefined':
-        return this._normalizeLiteralToString(from).onSuccess((v) => {
-          return captureResult(() => this._hash([v]));
-        });
-      case 'object':
-        if (from === null || from instanceof Date || from instanceof RegExp) {
-          return this._normalizeLiteralToString(from).onSuccess((v) => {
-            return captureResult(() => this._hash([v]));
-          });
-        } else if (Array.isArray(from)) {
-          return mapResults(from.map((e) => this.computeHash(e))).onSuccess((a) => {
-            return captureResult(() => this._hash(a));
-          });
-        } else if (from instanceof Map || from instanceof Set) {
-          return this.computeHash(this.normalizeEntries(from.entries()));
-        }
-        return this.computeHash(this.normalizeEntries(Object.entries(from)));
-    }
-    return fail(`computeHash: Unexpected type - cannot hash '${typeof from}'`);
-  }
-
-  /**
-   * Constructs a normalized string representation of some literal value.
-   * @param from - The literal value to be normalized.
-   * @returns A normalized string representation of the literal.
-   * @internal
-   */
-  protected _normalizeLiteralToString(
-    from: string | number | bigint | boolean | symbol | undefined | Date | RegExp | null
-  ): Result<string> {
-    switch (typeof from) {
-      case 'string':
-        return succeed(from);
-      case 'bigint':
-      case 'boolean':
-      case 'number':
-      case 'symbol':
-      case 'undefined':
-        return succeed(`${typeof from}:[[[${String(from)}]]]`);
-    }
-    if (from === null) {
-      return succeed('object:[[[null]]');
-    }
-    if (from instanceof Date) {
-      return succeed(`Date:[[[${String(from.valueOf())}]]]`);
-    }
-    if (from instanceof RegExp) {
-      return succeed(`RegExp:[[[${from.toString()}]]]`);
-    }
-    /* c8 ignore next 2 */
-    return fail(`cannot normalize ${JSON.stringify(from)}`);
-  }
-}

package/src/packlets/validation/array.ts

@@ -1,84 +0,0 @@
-/*
- * Copyright (c) 2022 Erik Fortune
- *
- * 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 { Failure, fail } from '../base';
-import { Validator, ValidatorOptions } from './validator';
-import { ValidatorBase, ValidatorBaseConstructorParams } from './validatorBase';
-
-/**
- * Parameters used to construct a {@link Validation.Classes.ArrayValidator | ArrayValidator}.
- * @public
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export interface ArrayValidatorConstructorParams<T, TC = unknown>
-  extends ValidatorBaseConstructorParams<T[], TC> {
-  validateElement: Validator<T, TC>;
-}
-
-/**
- * An in-place {@link Validator | Validator} for arrays of validated
- * values or objects.
- * @public
- */
-export class ArrayValidator<T, TC = unknown> extends ValidatorBase<T[], TC> {
-  /**
-   * {@link Validation.ValidatorOptions | Options} which apply to this
-   * validator.
-   */
-  public readonly options: ValidatorOptions<TC>;
-
-  protected readonly _validateElement: Validator<T, TC>;
-
-  /**
-   * Constructs a new {@link Validation.Classes.ArrayValidator | ArrayValidator}.
-   * @param params - Optional {@link Validation.Classes.ArrayValidatorConstructorParams | init params} for the
-   * new {@link Validation.Classes.ArrayValidator | ArrayValidator}.
-   */
-  public constructor(params: ArrayValidatorConstructorParams<T, TC>) {
-    super(params);
-    this._validateElement = params.validateElement;
-    this.options = params.options ?? {};
-  }
-
-  /**
-   * Static method which validates that a supplied `unknown` value is a `array`
-   * and that every element of the array can be validated by the supplied array
-   * validator.
-   * @param from - The `unknown` value to be tested.
-   * @param context - Optional validation context will be propagated to element validator.
-   * @param self - Optional self-reference for recursive validation.
-   * @returns Returns `true` if `from` is an `array` of valid elements, or
-   * {@link Failure} with an error message if not.
-   */
-  protected _validate(from: unknown, context?: TC, self?: Validator<T[], TC>): boolean | Failure<T[]> {
-    if (Array.isArray(from)) {
-      for (const elem of from) {
-        const result = this._validateElement.validate(elem, context);
-        if (!result.isSuccess()) {
-          return fail(result.message);
-        }
-      }
-      return true;
-    }
-    return fail<T[]>(`"${from}": not an array`);
-  }
-}