@dbmx/toasts 0.0.56 → 0.0.58

package/cjs/node_modules/@dbmx/semver/dist/index.esm.cjs

@@ -87,6 +87,45 @@ createToken('GTLT', '((?:<|>)?=?)');
 
 // A simple gt/lt/eq thing, or just "" to indicate "any version"
 createToken('COMPARATOR', `^${src[t.GTLT]}\\s*(${src[t.FULLPLAIN]})$|^$`);
+
+/**
+ * Represents a Semantic Version (SemVer) object
+ *
+ * @function SemVer
+ * @tag semver
+ * @param {string} - Version to parse
+ * @throws {SemVerError} - Throws an error if the provided version is invalid
+ * @example
+ *
+ * expect(SemVer('1.0').parts()).toEqual(2)
+ * expect(SemVer('1.0.1').parts()).toEqual(3)
+ * expect(SemVer('1.0.1-draft').parts()).toEqual(4)
+ * expect(SemVer('1.0').isNonVersioned()).toBeTruthy()
+ * expect(SemVer('1.0.1').isNonVersioned()).toBeFalsy()
+ *
+ * expect(SemVer('1.0').is2Parts()).toBeTruthy()
+ * expect(SemVer('1.0').patch).toEqual(null)
+ * expect(SemVer('1.0.0').patch).toEqual(0)
+ * expect(SemVer('1.0.0').is2Parts()).toBeFalsy()
+ * expect(SemVer('1.0.0-draft.1').extension).toEqual('draft.1')
+ * expect(() => SemVer('1.0-draft.1')).toThrow(/Invalid version/)
+ *
+ * expect(SemVer('1.0').isStable()).toBeFalsy()
+ * expect(SemVer('0.1.2').isStable()).toBeFalsy()
+ * expect(SemVer('3.1.2-draft').isStable()).toBeFalsy()
+ * expect(SemVer('3.1.2').isStable()).toBeTruthy()
+ *
+ * expect(SemVer('1.0').compare('1.0')).toEqual(0)
+ * expect(SemVer('1.1').compare('1.0')).toEqual(1)
+ * expect(SemVer('1.0').compare('1.0.0')).toEqual(-1)
+ * expect(SemVer('1.0.0-draft').compare('1.0')).toEqual(1)
+ * expect(SemVer('1.2.1').compare('1.2.1')).toEqual(0)
+ * expect(SemVer('1.2.2').compare('1.2.1')).toEqual(1)
+ * expect(SemVer('1.2.2').compare('1.2.2-draft')).toEqual(1)
+ * expect(SemVer('1.2.2-draft').compare('1.2.2-draft.1')).toEqual(-1)
+ *
+ */
+
 class SemVer {
   constructor(version) {
     if (version instanceof SemVer) {
@@ -198,13 +237,139 @@ class SemVer {
   }
 }
 var SemVer$1 = version => new SemVer(version);
+
+/**
+ * Compares two version strings or SemVer instances
+ *
+ * @function compare
+ * @tag core
+ * @param {string|SemVer} - First version string or SemVer instance (a)
+ * @param {string|SemVer} - Second version string or SemVer instance (b)
+ * @return {number} - Returns 0 if versions are equal, 1 if `a` is greater than `b`, and -1 if `a` is less than `b`
+ * @example
+ *
+ * compare('1.0.0', '1.2.0'); // -1
+ * compare('1.2.0', '1.2.0'); // 0
+ * compare('2.0.0', '1.2.0'); // 1
+ */
+
 const compare = (a, b) => SemVer$1(a).compare(SemVer$1(b));
+
+/**
+ * Checks if two version strings or SemVer instances are equal
+ *
+ * @function eq
+ * @tag core
+ * @param {string|SemVer} - First version string or SemVer instance
+ * @param {string|SemVer} - Second version string or SemVer instance
+ * @return {boolean} - Returns true if the versions are equal, otherwise false
+ * @example
+ *
+ * eq('1.0.0', '1.0.0'); // true
+ * eq('1.0.0', '1.2.0'); // false
+ */
+
 const eq = (a, b) => compare(a, b) === 0;
+
+/**
+ * Checks if two version strings or SemVer instances are not equal
+ *
+ * @function neq
+ * @tag core
+ * @param {string|SemVer} - First version string or SemVer instance
+ * @param {string|SemVer} - Second version string or SemVer instance
+ * @return {boolean} - Returns true if the versions are not equal, otherwise false
+ * @example
+ *
+ * neq('1.0.0', '1.0.0'); // false
+ * neq('1.0.0', '1.2.0'); // true
+ */
+
 const neq = (a, b) => compare(a, b) !== 0;
+
+/**
+ * Checks if the first version string or SemVer instance is greater than the second
+ *
+ * @function gt
+ * @tag core
+ * @param {string|SemVer} - First version string or SemVer instance (a)
+ * @param {string|SemVer} - Second version string or SemVer instance (b)
+ * @return {boolean} - Returns true if `a` is greater than `b`, otherwise false
+ * @example
+ *
+ * gt('1.2.0', '1.0.0'); // true
+ * gt('1.0.0', '1.2.0'); // false
+ */
+
 const gt = (a, b) => compare(a, b) > 0;
+
+/**
+ * Checks if the first version string or SemVer instance is greater than or equal to the second
+ *
+ * @function gte
+ * @tag core
+ * @param {string|SemVer} - First version string or SemVer instance (a)
+ * @param {string|SemVer} - Second version string or SemVer instance (b)
+ * @return {boolean} - Returns true if `a` is greater than or equal `b`, otherwise false
+ * @example
+ *
+ * gte('1.2.0', '1.0.0'); // true
+ * gte('1.0.0', '1.2.0'); // false
+ * gte('1.2.0', '1.2.0'); // true
+ */
+
 const gte = (a, b) => compare(a, b) >= 0;
+
+/**
+ * Checks if the first version string or SemVer instance is less than the second
+ *
+ * @function lt
+ * @tag core
+ * @param {string|SemVer} - First version string or SemVer instance (a)
+ * @param {string|SemVer} - Second version string or SemVer instance (b)
+ * @return {boolean} - Returns true if `a` is less than `b`, otherwise false
+ * @example
+ *
+ * lt('1.0.0', '1.2.0'); // true
+ * lt('1.2.0', '1.0.0'); // false
+ */
+
 const lt = (a, b) => compare(a, b) < 0;
+
+/**
+ * Checks if the first version string or SemVer instance is less than or equal to the second
+ *
+ * @function lte
+ * @tag core
+ * @param {string|SemVer} - First version string or SemVer instance (a)
+ * @param {string|SemVer} - Second version string or SemVer instance (b)
+ * @return {boolean} - Returns true if `a` is less than or equal than `b`, otherwise false
+ * @example
+ *
+ * lte('1.0.0', '1.2.0'); // true
+ * lte('1.2.0', '1.0.0'); // false
+ * lte('1.2.0', '1.2.0'); // true
+ */
+
 const lte = (a, b) => compare(a, b) <= 0;
+
+/**
+ * Performs comparison operations between version strings or SemVer instances
+ *
+ * @function cmp
+ * @tag core
+ * @param {string|SemVer} - First version string or SemVer instance
+ * @param {string} - Comparison operator ('===', '!==', '=', '==', '!=', '>', '>=', '<', '<=')
+ * @param {string|SemVer} - Second version string or SemVer instance
+ * @return {boolean} - Returns true if the comparison operation is true, otherwise false.
+ * @throws {SemVerError} - Throws an error if the comparison operator is invalid.
+ * @example
+ *
+ * cmp('1.0.0', '===', '1.0.0'); // true
+ * cmp('1.0.0', '!=', '1.0.1'); // true
+ * cmp('1.2.0', '>', '1.0.0'); // true
+ */
+
 var cmp = (a, op, b) => {
   switch (op) {
     case '===':
@@ -234,6 +399,22 @@ var cmp = (a, op, b) => {
   }
 };
 const ANY = Symbol('SemVer ANY');
+
+/**
+ * Represents a comparator object used for version comparison
+ *
+ * @function Comparator
+ * @param {string|Comparator} - Comparator string or another Comparator object
+ * @throw {SemVerError} - Throws an error if the provided comparator is invalid
+ * @example
+ *
+ * Comparator('> 1.2.3')
+ * Comparator('<= 1.2')
+ * Comparator('= 1.21.3-draft')
+ * Comparator('1.21.3-draft')
+ *
+ */
+
 class Comparator {
   static get ANY() {
     return ANY;
@@ -336,6 +517,37 @@ const isSatisfiable = comparators => {
   }
   return result;
 };
+
+/**
+ * Represents a range of versions for semantic versioning
+ *
+ * @function Range
+ * @tag range
+ * @param {string} - Version range
+ * @throws {SemVerError} - Throws an error if the provided range is invalid
+ * @example
+ *
+ * expect(() => Range('wrong range')).toThrow()
+ * expect(Range('1.0').test('1.0')).toBeTruthy()
+ * expect(Range('1.0').test('1.0.0')).toBeFalsy()
+ *
+ * expect(Range('~').toString()).toEqual('>=0.0.0-0')
+ * expect(Range('~').test('1.2.3-draft')).toBeTruthy()
+ * expect(Range('1.~').test('1.2.3-draft')).toBeFalsy()
+ *
+ * expect(Range('+').toString()).toEqual('>=1.0.0')
+ * expect(Range('+').test('1.2.3-draft')).toBeFalsy()
+ * expect(Range('1.0.+').test('1.0.3')).toBeTruthy()
+ *
+ * expect(Range('*').test('1.0')).toBeTruthy()
+ * expect(Range('*').test('1.0.0-draft')).toBeTruthy()
+ * expect(Range('1.*').test('1.1.3')).toBeFalsy()
+ *
+ * expect(Range('1~.2.0').test('4.3.2')).toBeTruthy()
+ * expect(Range('1~.2.0').test('4.3.2-draft')).toBeTruthy()
+ * expect(Range('1.2~.0').toString()).toEqual('>=1.2.0-0 <2.0.0-0')
+ *
+ */
 class Range {
   constructor(range) {
     if (range instanceof Range) return new Range(range.raw);
@@ -525,6 +737,24 @@ const testSet = (set, version) => {
   return true;
 };
 var Range$1 = range => new Range(range);
+
+/**
+ * Represents a matcher object used for version matching
+ *
+ * @function Matcher
+ * @tag matcher
+ * @param {string} - Version string or range to create a matcher for
+ * @throws {SemVerError} - Throws an error if the provided version or range is invalid
+ * @example
+ *
+ * expect(() => Matcher('wrong range')).toThrow()
+ * expect(Matcher('1.0').isMonoType()).toBeTruthy()
+ * expect(Matcher('1.0.1').isMonoType()).toBeTruthy()
+ * expect(Matcher('1.0.1').isResolved()).toBeTruthy()
+ * expect(Matcher('1~.2.0').isLatestType()).toBeTruthy()
+ * expect(() => Matcher('1.*')).toThrow()
+ *
+ */
 class Matcher {
   constructor(value) {
     this.raw = value;
@@ -542,6 +772,36 @@ class Matcher {
   }
 }
 var matcher = value => new Matcher(value);
+
+/**
+ * Represents a dependency between two artifacts
+ *
+ * @class Dependency
+ * @tag dependency
+ * @param {object} - The source artifact object containing a version property
+ * @param {string} - The version or version range of the target artifact
+ * @throws {SemVerError} Throws an error if the provided version or range is invalid or if dependency source or version is undefined
+ * @example
+ *
+ * //Should manage stable source
+ * const source = { version: '1.0.1' };
+ * Dependency(source, '2.3.0');
+ * Dependency(source, '2+.3.0');
+ * Dependency(source, '2.3+.0');
+ * const dep = Dependency(source, '2.3.0+');
+ * expect(dep.range.raw).toEqual(dep.raw);
+ * expect(() => Dependency(source, '2.3')).toThrow();
+ * expect(() => Dependency(source, '2.3.1-draft')).toThrow();
+ *
+ * //Should manage unstable source
+ * const source = { version: '1.0.1-draft' }
+ * Dependency(source, '2.3.0')
+ * let dep = Dependency(source, '2.3.0+')
+ * expect(dep.range.raw).toEqual('2.3.0~')
+ * dep = Dependency({ version: '1.0' }, '2+.3.0')
+ * expect(dep.range.raw).toEqual('2~.3.0')
+ *
+ */
 class Dependency {
   constructor(source, value) {
     if (!value) throw new SemVerError(`Dependency version must be defined`);
@@ -565,6 +825,26 @@ class Dependency {
   }
 }
 var dependency = (source, value) => new Dependency(source, value);
+
+/**
+ * Checks if a dependency is valid
+ *
+ * @function isValidDependency
+ * @tag dependency
+ * @param {Object} - Source artifact object containing a version property
+ * @param {string} - Version or version range of the target artifact
+ * @return {boolean} - Returns true if the dependency is valid, otherwise false
+ * @example
+ *
+ * const source = { version: '1.0.1' };
+ * isValidDependency(source, '2.3-'); // false
+ * isValidDependency(source, '2.3+.1'); // true
+ * isValidDependency(source, '2.3.1-draft'); // false
+ * isValidDependency({ version: '1.2.1' }, '2.3'); // false
+ * isValidDependency({ version: '1.2' }, '2.3.1'); // true
+ * isValidDependency({ version: '1.2.1' }, '2.3.1-draft'); // false
+ */
+
 const isValidDependency = (source, targetVersion) => {
   try {
     new Dependency(source, targetVersion);