@hashgraph/solo/src/business/utils/version-range.ts

An opinionated CLI tool to deploy and manage private Hedera Networks.

// SPDX-License-Identifier: Apache-2.0

import {SemanticVersion} from './semantic-version.js';

/**
 * A range of versions which includes the beginning version and excludes the end version.
 */
export class VersionRange<T extends string | number> {
  public constructor(
    /**
     * The beginning of the version range (inclusive).
     */
    public readonly begin: SemanticVersion<T>,
    /**
     * The end of the version range (exclusive).
     */
    public readonly end: SemanticVersion<T>,
  ) {
    if (this.begin !== null && this.end !== null && this.begin.compare(this.end) >= 0) {
      throw new RangeError('Invalid version range');
    }
  }

  /**
   * Creates a version range from the given integer bounds.
   *
   * @param begin - the beginning of the version range (inclusive).
   * @param end - the end of the version range (exclusive).
   * @returns the version range.
   * @throws RangeError if the bounds are invalid.
   */
  public static fromIntegerBounds(begin: number, end: number): VersionRange<number> {
    return new VersionRange(new SemanticVersion(begin), new SemanticVersion(end));
  }

  /**
   * Creates a version range from the given integer version.
   *
   * @param version - the specific version for which to create a range.
   * @returns the version range.
   * @throws RangeError if the version is invalid.
   */
  public static fromIntegerVersion(version: number): VersionRange<number> {
    return new VersionRange(new SemanticVersion(version), new SemanticVersion(version + 1));
  }

  /**
   * Creates a version range from the given semantic version bounds.
   *
   * @param begin - the beginning of the version range (inclusive).
   * @param end - the end of the version range (exclusive).
   * @returns the version range.
   * @throws RangeError if the bounds are invalid.
   */
  public static fromSemanticVersionBounds<R extends string | number>(
    begin: SemanticVersion<R>,
    end: SemanticVersion<R>,
  ): VersionRange<R> {
    return new VersionRange(new SemanticVersion(begin), new SemanticVersion(end));
  }

  /**
   * Creates a version range which includes all patch releases for the given major and minor version.
   *
   * @param version - the semantic version.
   * @returns the version range.
   */
  public static patchVersionBounds(version: SemanticVersion<string>): VersionRange<string> {
    // clone the version to avoid modifying the original
    const rangeEnd: SemanticVersion<string | number> = new SemanticVersion(version.toString());
    return new VersionRange(new SemanticVersion(version), new SemanticVersion(rangeEnd.bumpMinor()));
  }

  /**
   * Creates a version range which includes all minor and patch releases for the given major version.
   *
   * @param version - the semantic version.
   * @returns the version range.
   */
  public static minorVersionBounds<R extends string | number>(version: SemanticVersion<R>): VersionRange<R> {
    return new VersionRange<R>(new SemanticVersion(version), version.bumpMajor());
  }

  public equals(other: VersionRange<T>): boolean {
    return this.begin !== null && this.end !== null && this.begin.equals(other.begin) && this.end.equals(other.end);
  }

  public compare(other: VersionRange<T>): number {
    if (this.begin === null || this.end === null) {
      throw new RangeError('Invalid version range');
    }

    const beginComparison: number = this.begin.compare(other.begin);
    if (beginComparison !== 0) {
      return beginComparison;
    }
    return this.end.compare(other.end);
  }

  public contains(version: SemanticVersion<T>): boolean {
    if (this.begin === null || this.end === null) {
      throw new RangeError('Invalid version range');
    }

    return this.begin.compare(version) <= 0 && this.end.compare(version) > 0;
  }

  public toString(): string {
    return `[${this.begin}, ${this.end})`;
  }
}