@clerk/shared/dist/versionCheck.d.ts

Internal package utils used by the Clerk SDKs

//#region src/versionCheck.d.ts
type VersionBounds = [major: number, minMinor: number, maxMinor: number, minPatch: number];
/**
 * Parses a version string into major, minor, and patch numbers.
 * Returns null if the version string cannot be parsed.
 *
 * @example
 * parseVersion("18.3.1") // { major: 18, minor: 3, patch: 1 }
 * parseVersion("19.0.0-rc.1") // { major: 19, minor: 0, patch: 0 }
 * parseVersion("invalid") // null
 */
declare function parseVersion(version: string): {
  major: number;
  minor: number;
  patch: number;
} | null;
/**
 * Checks if a parsed version satisfies the given version bounds.
 *
 * @param version - The parsed version to check
 * @param version.major
 * @param bounds - Array of version bounds to check against
 * @param version.minor
 * @param version.patch
 * @returns true if the version satisfies any of the bounds
 */
declare function checkVersionAgainstBounds(version: {
  major: number;
  minor: number;
  patch: number;
}, bounds: VersionBounds[]): boolean;
/**
 * Checks if a version string is compatible with the given bounds.
 * This is a convenience function that combines parsing and checking.
 *
 * @param version - The version string to check (e.g., "18.3.1")
 * @param bounds - Array of version bounds to check against
 * @returns true if the version is compatible, false otherwise
 */
declare function isVersionCompatible(version: string, bounds: VersionBounds[]): boolean;
/**
 * Returns true if the given version is at least the minimum version.
 * Both versions are compared by their major.minor.patch components only.
 * Pre-release suffixes are ignored (e.g., "5.114.0-canary.123" is treated as "5.114.0").
 *
 * @param version - The version string to check (e.g., "5.114.0")
 * @param minVersion - The minimum required version (e.g., "5.100.0")
 * @returns true if version >= minVersion, false otherwise (including if either cannot be parsed)
 *
 * @example
 * isVersionAtLeast("5.114.0", "5.100.0") // true
 * isVersionAtLeast("5.99.0", "5.100.0") // false
 * isVersionAtLeast("5.100.0-canary.123", "5.100.0") // true
 */
declare function isVersionAtLeast(version: string | undefined | null, minVersion: string): boolean;
//#endregion
export { VersionBounds, checkVersionAgainstBounds, isVersionAtLeast, isVersionCompatible, parseVersion };