packages/shared/lib/helpers/version.ts

   1 export class Version {
   2     version: number[];
   3
   4     constructor(version: string) {
   5         this.version = this.getSemanticVersion(version);
   6     }
   7
   8     private getSemanticVersion(version: string): number[] {
   9         const array = version.split('.').map(Number);
  10         // remove trailing .0 if any
  11         while (array.at(-1) === 0) {
  12             array.pop();
  13         }
  14         return array;
  15     }
  16
  17     /**
  18      * Compares the version number stored in this instance with a given version number string.
  19      *
  20      * @param {string} comparison - The version number to compare against in the format 'major.minor.patch'.
  21      * @returns {-1 | 0 | 1} - Returns -1 if this version is lower, 1 if it is higher, or 0 if they are equal.
  22      */
  23     private compare(comparison: string): -1 | 0 | 1 {
  24         const comparedVersion = this.getSemanticVersion(comparison);
  25
  26         // Loop through each segment of the version numbers.
  27         for (let i = 0; true; i++) {
  28             // If the end of both versions is reached simultaneously, they are equal.
  29             if (i >= comparedVersion.length) {
  30                 return i >= this.version.length ? 0 : 1;
  31             }
  32             // If this version ends before the compared version, this version is lower.
  33             if (i >= this.version.length) {
  34                 return -1;
  35             }
  36             // Calculate the difference between the same segment of the two versions.
  37             const diff = this.version[i] - comparedVersion[i];
  38             // If there is a difference, determine which version is greater.
  39             if (diff !== 0) {
  40                 return diff > 0 ? 1 : -1;
  41             }
  42         }
  43     }
  44
  45     public isEqualTo(comparison: string): boolean {
  46         return this.compare(comparison) === 0;
  47     }
  48
  49     public isGreaterThan(comparison: string): boolean {
  50         return this.compare(comparison) === 1;
  51     }
  52
  53     public isSmallerThan(comparison: string): boolean {
  54         return this.compare(comparison) === -1;
  55     }
  56
  57     public isGreaterThanOrEqual(comparison: string): boolean {
  58         return this.isGreaterThan(comparison) || this.isEqualTo(comparison);
  59     }
  60
  61     public isSmallerThanOrEqual(comparison: string): boolean {
  62         return !this.isGreaterThan(comparison) || this.isEqualTo(comparison);
  63     }
  64 }