complete-common 2.19.1 → 2.20.1

package/dist/functions/string.d.cts

@@ -3,6 +3,7 @@
  *
  * @module
  */
+import type { SemanticVersion } from "../interfaces/SemanticVersion.js";
 /** Helper function to capitalize the first letter of a string. */
 export declare function capitalizeFirstLetter(string: string): string;
 /**
@@ -73,14 +74,7 @@ export declare function normalizeString(string: string): string;
  *
  * @see https://semver.org/
  */
-export declare function parseSemanticVersion(versionString: string): {
-    /** The first number inside of the semantic version. */
-    majorVersion: number;
-    /** The second number inside of the semantic version. */
-    minorVersion: number;
-    /** The third number inside of the semantic version. */
-    patchVersion: number;
-} | undefined;
+export declare function parseSemanticVersion(versionString: string): SemanticVersion | undefined;
 /**
  * Helper function to remove lines from a multi-line string. This function looks for a "-start" and
  * a "-end" suffix after the marker. Lines with markets will be completely removed from the output.
@@ -115,6 +109,13 @@ export declare function removeLinesMatching(string: string, match: string): stri
 export declare function removeNonPrintableCharacters(string: string): string;
 /** Helper function to remove all whitespace characters from a string. */
 export declare function removeWhitespace(string: string): string;
+/**
+ * Helper function to check if a semantic version is equal to or greater than a second semantic
+ * version.
+ *
+ * @throws If either the version or minimum version are not valid semantic versions.
+ */
+export declare function satisfiesSemanticVersion(version: string, minimumVersion: string): boolean;
 /** Helper function to convert a string from TitleCase (PascalCase) to kebab-case. */
 export declare function titleCaseToKebabCase(string: string): string;
 /**

package/dist/functions/string.d.mts

@@ -3,6 +3,7 @@
  *
  * @module
  */
+import type { SemanticVersion } from "../interfaces/SemanticVersion.js";
 /** Helper function to capitalize the first letter of a string. */
 export declare function capitalizeFirstLetter(string: string): string;
 /**
@@ -73,14 +74,7 @@ export declare function normalizeString(string: string): string;
  *
  * @see https://semver.org/
  */
-export declare function parseSemanticVersion(versionString: string): {
-    /** The first number inside of the semantic version. */
-    majorVersion: number;
-    /** The second number inside of the semantic version. */
-    minorVersion: number;
-    /** The third number inside of the semantic version. */
-    patchVersion: number;
-} | undefined;
+export declare function parseSemanticVersion(versionString: string): SemanticVersion | undefined;
 /**
  * Helper function to remove lines from a multi-line string. This function looks for a "-start" and
  * a "-end" suffix after the marker. Lines with markets will be completely removed from the output.
@@ -115,6 +109,13 @@ export declare function removeLinesMatching(string: string, match: string): stri
 export declare function removeNonPrintableCharacters(string: string): string;
 /** Helper function to remove all whitespace characters from a string. */
 export declare function removeWhitespace(string: string): string;
+/**
+ * Helper function to check if a semantic version is equal to or greater than a second semantic
+ * version.
+ *
+ * @throws If either the version or minimum version are not valid semantic versions.
+ */
+export declare function satisfiesSemanticVersion(version: string, minimumVersion: string): boolean;
 /** Helper function to convert a string from TitleCase (PascalCase) to kebab-case. */
 export declare function titleCaseToKebabCase(string: string): string;
 /**

package/dist/functions/string.d.ts

@@ -3,6 +3,7 @@
  *
  * @module
  */
+import type { SemanticVersion } from "../interfaces/SemanticVersion.js";
 /** Helper function to capitalize the first letter of a string. */
 export declare function capitalizeFirstLetter(string: string): string;
 /**
@@ -73,14 +74,7 @@ export declare function normalizeString(string: string): string;
  *
  * @see https://semver.org/
  */
-export declare function parseSemanticVersion(versionString: string): {
-    /** The first number inside of the semantic version. */
-    majorVersion: number;
-    /** The second number inside of the semantic version. */
-    minorVersion: number;
-    /** The third number inside of the semantic version. */
-    patchVersion: number;
-} | undefined;
+export declare function parseSemanticVersion(versionString: string): SemanticVersion | undefined;
 /**
  * Helper function to remove lines from a multi-line string. This function looks for a "-start" and
  * a "-end" suffix after the marker. Lines with markets will be completely removed from the output.
@@ -115,6 +109,13 @@ export declare function removeLinesMatching(string: string, match: string): stri
 export declare function removeNonPrintableCharacters(string: string): string;
 /** Helper function to remove all whitespace characters from a string. */
 export declare function removeWhitespace(string: string): string;
+/**
+ * Helper function to check if a semantic version is equal to or greater than a second semantic
+ * version.
+ *
+ * @throws If either the version or minimum version are not valid semantic versions.
+ */
+export declare function satisfiesSemanticVersion(version: string, minimumVersion: string): boolean;
 /** Helper function to convert a string from TitleCase (PascalCase) to kebab-case. */
 export declare function titleCaseToKebabCase(string: string): string;
 /**

package/dist/functions/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../src/functions/string.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AA8BH,kEAAkE;AAClE,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAU5D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAO3D;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAqBlE;AAED,6EAA6E;AAC7E,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAOpD;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED,0FAA0F;AAC1F,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAErD;AAED,+EAA+E;AAC/E,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAE5C;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,+FAA+F;AAC/F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED,+FAA+F;AAC/F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,wEAAwE;AACxE,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAO3D;AAED,yEAAyE;AACzE,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAG5D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAiBtD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,MAAM,GACtD;IACE,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;IAErB,wDAAwD;IACxD,YAAY,EAAE,MAAM,CAAC;IAErB,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;CACtB,GACD,SAAS,CAwBZ;AAGD;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,GACb,MAAM,CAuBR;AAED,gGAAgG;AAChG,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAIzE;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEnE;AAED,yEAAyE;AACzE,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED,qFAAqF;AACrF,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAK3D;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,UAAQ,GACd,MAAM,CAWR;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAOjE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAMxE"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../src/functions/string.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AA8BxE,kEAAkE;AAClE,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAU5D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAO3D;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAqBlE;AAED,6EAA6E;AAC7E,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAOpD;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhD;AAED,0FAA0F;AAC1F,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAErD;AAED,+EAA+E;AAC/E,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAE5C;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,+FAA+F;AAC/F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED,+FAA+F;AAC/F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,wEAAwE;AACxE,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAO3D;AAED,yEAAyE;AACzE,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAG5D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAiBtD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,aAAa,EAAE,MAAM,GACpB,eAAe,GAAG,SAAS,CAwB7B;AAGD;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,GACb,MAAM,CAuBR;AAED,gGAAgG;AAChG,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAIzE;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEnE;AAED,yEAAyE;AACzE,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,MAAM,GACrB,OAAO,CA6BT;AAED,qFAAqF;AACrF,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAK3D;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,UAAQ,GACd,MAAM,CAWR;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAOjE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAMxE"}

package/dist/index.cjs

@@ -595,6 +595,25 @@ function removeNonPrintableCharacters(string) {
 function removeWhitespace(string) {
   return string.replaceAll(WHITESPACE_GLOBAL_REGEX, "");
 }
+function satisfiesSemanticVersion(version, minimumVersion) {
+  const semanticVersion = parseSemanticVersion(version);
+  assertDefined(
+    semanticVersion,
+    `The following version is not a semantic version: ${version}`
+  );
+  const { majorVersion, minorVersion, patchVersion } = semanticVersion;
+  const minimumSemanticVersion = parseSemanticVersion(minimumVersion);
+  assertDefined(
+    minimumSemanticVersion,
+    `The following minimum version is not a semantic version: ${minimumVersion}`
+  );
+  const {
+    majorVersion: minimumMajorVersion,
+    minorVersion: minimumMinorVersion,
+    patchVersion: minimumPatchVersion
+  } = minimumSemanticVersion;
+  return majorVersion > minimumMajorVersion || majorVersion === minimumMajorVersion && minorVersion > minimumMinorVersion || majorVersion === minimumMajorVersion && minorVersion === minimumMinorVersion && patchVersion >= minimumPatchVersion;
+}
 function titleCaseToKebabCase(string) {
   return string.replaceAll(TITLE_CASE_BOUNDARY_REGEX, "-").replaceAll(/ +/g, "-").toLowerCase();
 }
@@ -726,6 +745,7 @@ exports.removeLinesMatching = removeLinesMatching;
 exports.removeNonPrintableCharacters = removeNonPrintableCharacters;
 exports.removeWhitespace = removeWhitespace;
 exports.repeat = repeat;
+exports.satisfiesSemanticVersion = satisfiesSemanticVersion;
 exports.setAdd = setAdd;
 exports.setHas = setHas;
 exports.sortCaseInsensitive = sortCaseInsensitive;

package/dist/index.d.cts

@@ -13,6 +13,7 @@ export * from "./functions/time.js";
 export * from "./functions/tuple.js";
 export * from "./functions/types.js";
 export * from "./functions/utils.js";
+export type * from "./interfaces/SemanticVersion.js";
 export type * from "./types/AddSubtract.js";
 export type * from "./types/CompositionTypeSatisfiesEnum.js";
 export type * from "./types/ERange.js";

package/dist/index.d.mts

@@ -13,6 +13,7 @@ export * from "./functions/time.js";
 export * from "./functions/tuple.js";
 export * from "./functions/types.js";
 export * from "./functions/utils.js";
+export type * from "./interfaces/SemanticVersion.js";
 export type * from "./types/AddSubtract.js";
 export type * from "./types/CompositionTypeSatisfiesEnum.js";
 export type * from "./types/ERange.js";

package/dist/index.d.ts

@@ -13,6 +13,7 @@ export * from "./functions/time.js";
 export * from "./functions/tuple.js";
 export * from "./functions/types.js";
 export * from "./functions/utils.js";
+export type * from "./interfaces/SemanticVersion.js";
 export type * from "./types/AddSubtract.js";
 export type * from "./types/CompositionTypeSatisfiesEnum.js";
 export type * from "./types/ERange.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,mBAAmB,wBAAwB,CAAC;AAC5C,mBAAmB,yCAAyC,CAAC;AAC7D,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,mCAAmC,CAAC;AACvD,mBAAmB,4CAA4C,CAAC;AAChE,mBAAmB,yBAAyB,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,mBAAmB,2BAA2B,CAAC;AAC/C,cAAc,wBAAwB,CAAC;AACvC,mBAAmB,2BAA2B,CAAC;AAC/C,mBAAmB,kBAAkB,CAAC;AACtC,mBAAmB,yBAAyB,CAAC;AAC7C,mBAAmB,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,mBAAmB,iCAAiC,CAAC;AACrD,mBAAmB,wBAAwB,CAAC;AAC5C,mBAAmB,yCAAyC,CAAC;AAC7D,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,sBAAsB,CAAC;AAC1C,mBAAmB,mBAAmB,CAAC;AACvC,mBAAmB,mCAAmC,CAAC;AACvD,mBAAmB,4CAA4C,CAAC;AAChE,mBAAmB,yBAAyB,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,mBAAmB,2BAA2B,CAAC;AAC/C,cAAc,wBAAwB,CAAC;AACvC,mBAAmB,2BAA2B,CAAC;AAC/C,mBAAmB,kBAAkB,CAAC;AACtC,mBAAmB,yBAAyB,CAAC;AAC7C,mBAAmB,sBAAsB,CAAC"}

package/dist/index.mjs

@@ -593,6 +593,25 @@ function removeNonPrintableCharacters(string) {
 function removeWhitespace(string) {
   return string.replaceAll(WHITESPACE_GLOBAL_REGEX, "");
 }
+function satisfiesSemanticVersion(version, minimumVersion) {
+  const semanticVersion = parseSemanticVersion(version);
+  assertDefined(
+    semanticVersion,
+    `The following version is not a semantic version: ${version}`
+  );
+  const { majorVersion, minorVersion, patchVersion } = semanticVersion;
+  const minimumSemanticVersion = parseSemanticVersion(minimumVersion);
+  assertDefined(
+    minimumSemanticVersion,
+    `The following minimum version is not a semantic version: ${minimumVersion}`
+  );
+  const {
+    majorVersion: minimumMajorVersion,
+    minorVersion: minimumMinorVersion,
+    patchVersion: minimumPatchVersion
+  } = minimumSemanticVersion;
+  return majorVersion > minimumMajorVersion || majorVersion === minimumMajorVersion && minorVersion > minimumMinorVersion || majorVersion === minimumMajorVersion && minorVersion === minimumMinorVersion && patchVersion >= minimumPatchVersion;
+}
 function titleCaseToKebabCase(string) {
   return string.replaceAll(TITLE_CASE_BOUNDARY_REGEX, "-").replaceAll(/ +/g, "-").toLowerCase();
 }
@@ -636,4 +655,4 @@ function* tupleKeys(tuple) {
 
 const ReadonlyMap = Map;
 
-export { HOUR_IN_MILLISECONDS, MINUTE_IN_MILLISECONDS, ReadonlyMap, ReadonlySet, SECOND_IN_MILLISECONDS, addSetsToSet, arrayCopyTwoDimensional, arrayEquals, arrayRemove, arrayRemoveAllInPlace, arrayRemoveInPlace, assertArray, assertArrayBoolean, assertArrayNumber, assertArrayObject, assertArrayString, assertBoolean, assertDefined, assertEnumValue, assertInteger, assertIs, assertNotNull, assertNumber, assertObject, assertString, assertStringNotEmpty, capitalizeFirstLetter, clamp, combineSets, copySet, eRange, emptyArray, escapeHTMLCharacters, filterAsync, filterMap, filterMapAsync, getElapsedSeconds, getEnumEntries, getEnumKeys, getEnumValues, getNumConsecutiveDiacritics, getRandomArrayElement, getRandomArrayIndex, getRandomInt, getWidenedObjectValue, hasDiacritic, hasEmoji, hasWhitespace, iRange, includes, includesAny, interfaceSatisfiesEnum, isASCII, isArray, isArrayBoolean, isArrayNumber, isArrayObject, isArrayString, isEnumValue, isFirstLetterCapitalized, isKebabCase, isKeyOf, isLowerCase, isObject, isSemanticVersion, isUpperCase, kebabCaseToCamelCase, kebabCaseToPascalCase, mapAsync, mapFilter, mapFind, newArray, noop, normalizeString, objectFilter, objectKeysToSet, objectMap, objectToMap, objectToReverseMap, objectValuesToSet, parseFloatSafe, parseIntSafe, parseSemanticVersion, removeLinesBetweenMarkers, removeLinesMatching, removeNonPrintableCharacters, removeWhitespace, repeat, setAdd, setHas, sortCaseInsensitive, sumArray, titleCaseToKebabCase, todo, trimPrefix, trimSuffix, truncateString, tupleEntries, tupleKeys };
+export { HOUR_IN_MILLISECONDS, MINUTE_IN_MILLISECONDS, ReadonlyMap, ReadonlySet, SECOND_IN_MILLISECONDS, addSetsToSet, arrayCopyTwoDimensional, arrayEquals, arrayRemove, arrayRemoveAllInPlace, arrayRemoveInPlace, assertArray, assertArrayBoolean, assertArrayNumber, assertArrayObject, assertArrayString, assertBoolean, assertDefined, assertEnumValue, assertInteger, assertIs, assertNotNull, assertNumber, assertObject, assertString, assertStringNotEmpty, capitalizeFirstLetter, clamp, combineSets, copySet, eRange, emptyArray, escapeHTMLCharacters, filterAsync, filterMap, filterMapAsync, getElapsedSeconds, getEnumEntries, getEnumKeys, getEnumValues, getNumConsecutiveDiacritics, getRandomArrayElement, getRandomArrayIndex, getRandomInt, getWidenedObjectValue, hasDiacritic, hasEmoji, hasWhitespace, iRange, includes, includesAny, interfaceSatisfiesEnum, isASCII, isArray, isArrayBoolean, isArrayNumber, isArrayObject, isArrayString, isEnumValue, isFirstLetterCapitalized, isKebabCase, isKeyOf, isLowerCase, isObject, isSemanticVersion, isUpperCase, kebabCaseToCamelCase, kebabCaseToPascalCase, mapAsync, mapFilter, mapFind, newArray, noop, normalizeString, objectFilter, objectKeysToSet, objectMap, objectToMap, objectToReverseMap, objectValuesToSet, parseFloatSafe, parseIntSafe, parseSemanticVersion, removeLinesBetweenMarkers, removeLinesMatching, removeNonPrintableCharacters, removeWhitespace, repeat, satisfiesSemanticVersion, setAdd, setHas, sortCaseInsensitive, sumArray, titleCaseToKebabCase, todo, trimPrefix, trimSuffix, truncateString, tupleEntries, tupleKeys };

package/dist/interfaces/SemanticVersion.d.cts

@@ -0,0 +1,10 @@
+/** @see https://semver.org/ */
+export interface SemanticVersion {
+    /** The first number inside of the semantic version. */
+    majorVersion: number;
+    /** The second number inside of the semantic version. */
+    minorVersion: number;
+    /** The third number inside of the semantic version. */
+    patchVersion: number;
+}
+//# sourceMappingURL=SemanticVersion.d.ts.map

package/dist/interfaces/SemanticVersion.d.mts

@@ -0,0 +1,10 @@
+/** @see https://semver.org/ */
+export interface SemanticVersion {
+    /** The first number inside of the semantic version. */
+    majorVersion: number;
+    /** The second number inside of the semantic version. */
+    minorVersion: number;
+    /** The third number inside of the semantic version. */
+    patchVersion: number;
+}
+//# sourceMappingURL=SemanticVersion.d.ts.map

package/dist/interfaces/SemanticVersion.d.ts

@@ -0,0 +1,10 @@
+/** @see https://semver.org/ */
+export interface SemanticVersion {
+    /** The first number inside of the semantic version. */
+    majorVersion: number;
+    /** The second number inside of the semantic version. */
+    minorVersion: number;
+    /** The third number inside of the semantic version. */
+    patchVersion: number;
+}
+//# sourceMappingURL=SemanticVersion.d.ts.map

package/dist/interfaces/SemanticVersion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SemanticVersion.d.ts","sourceRoot":"","sources":["../../src/interfaces/SemanticVersion.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,MAAM,WAAW,eAAe;IAC9B,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;IAErB,wDAAwD;IACxD,YAAY,EAAE,MAAM,CAAC;IAErB,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;CACtB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "complete-common",
-  "version": "2.19.1",
+  "version": "2.20.1",
   "description": "Helper functions for TypeScript projects.",
   "homepage": "https://complete-ts.github.io/",
   "bugs": {

package/src/functions/string.ts

@@ -4,6 +4,8 @@
  * @module
  */
 
+import type { SemanticVersion } from "../interfaces/SemanticVersion.js";
+import { assertDefined } from "./assert.js";
 import { parseIntSafe } from "./utils.js";
 
 // When regular expressions are located at the root instead of inside the function, the functions
@@ -205,18 +207,9 @@ export function normalizeString(string: string): string {
  *
  * @see https://semver.org/
  */
-export function parseSemanticVersion(versionString: string):
-  | {
-      /** The first number inside of the semantic version. */
-      majorVersion: number;
-
-      /** The second number inside of the semantic version. */
-      minorVersion: number;
-
-      /** The third number inside of the semantic version. */
-      patchVersion: number;
-    }
-  | undefined {
+export function parseSemanticVersion(
+  versionString: string,
+): SemanticVersion | undefined {
   const match = versionString.match(SEMANTIC_VERSION_REGEX);
   if (match === null || match.groups === undefined) {
     return undefined;
@@ -316,6 +309,46 @@ export function removeWhitespace(string: string): string {
   return string.replaceAll(WHITESPACE_GLOBAL_REGEX, "");
 }
 
+/**
+ * Helper function to check if a semantic version is equal to or greater than a second semantic
+ * version.
+ *
+ * @throws If either the version or minimum version are not valid semantic versions.
+ */
+export function satisfiesSemanticVersion(
+  version: string,
+  minimumVersion: string,
+): boolean {
+  const semanticVersion = parseSemanticVersion(version);
+  assertDefined(
+    semanticVersion,
+    `The following version is not a semantic version: ${version}`,
+  );
+
+  const { majorVersion, minorVersion, patchVersion } = semanticVersion;
+
+  const minimumSemanticVersion = parseSemanticVersion(minimumVersion);
+  assertDefined(
+    minimumSemanticVersion,
+    `The following minimum version is not a semantic version: ${minimumVersion}`,
+  );
+
+  const {
+    majorVersion: minimumMajorVersion,
+    minorVersion: minimumMinorVersion,
+    patchVersion: minimumPatchVersion,
+  } = minimumSemanticVersion;
+
+  return (
+    majorVersion > minimumMajorVersion
+    || (majorVersion === minimumMajorVersion
+      && minorVersion > minimumMinorVersion)
+    || (majorVersion === minimumMajorVersion
+      && minorVersion === minimumMinorVersion
+      && patchVersion >= minimumPatchVersion)
+  );
+}
+
 /** Helper function to convert a string from TitleCase (PascalCase) to kebab-case. */
 export function titleCaseToKebabCase(string: string): string {
   return string

package/src/index.ts

@@ -13,6 +13,7 @@ export * from "./functions/time.js";
 export * from "./functions/tuple.js";
 export * from "./functions/types.js";
 export * from "./functions/utils.js";
+export type * from "./interfaces/SemanticVersion.js";
 export type * from "./types/AddSubtract.js";
 export type * from "./types/CompositionTypeSatisfiesEnum.js";
 export type * from "./types/ERange.js";

package/src/interfaces/SemanticVersion.ts

@@ -0,0 +1,11 @@
+/** @see https://semver.org/ */
+export interface SemanticVersion {
+  /** The first number inside of the semantic version. */
+  majorVersion: number;
+
+  /** The second number inside of the semantic version. */
+  minorVersion: number;
+
+  /** The third number inside of the semantic version. */
+  patchVersion: number;
+}