@socketsecurity/lib/dist/versions.d.ts

Core utilities and infrastructure for Socket.dev security tools

/**
 * Coerce a version string to valid semver format.
 */
export declare function coerceVersion(version: string): string | undefined;
/**
 * Compare two semantic version strings.
 * @returns -1 if v1 < v2, 0 if v1 === v2, 1 if v1 > v2, or undefined if invalid.
 */
export declare function compareVersions(v1: string, v2: string): -1 | 0 | 1 | undefined;
/**
 * Get all versions from an array that satisfy a semver range.
 */
export declare function filterVersions(versions: string[], range: string): string[];
/**
 * Get the major version number from a version string.
 */
export declare function getMajorVersion(version: string): number | undefined;
/**
 * Get the minor version number from a version string.
 */
export declare function getMinorVersion(version: string): number | undefined;
/**
 * Get the patch version number from a version string.
 */
export declare function getPatchVersion(version: string): number | undefined;
/**
 * Increment a version by the specified release type.
 */
export declare function incrementVersion(version: string, release: 'major' | 'minor' | 'patch' | 'premajor' | 'preminor' | 'prepatch' | 'prerelease', identifier?: string | undefined): string | undefined;
/**
 * Check if version1 equals version2.
 */
export declare function isEqual(version1: string, version2: string): boolean;
/**
 * Check if version1 is greater than version2.
 */
export declare function isGreaterThan(version1: string, version2: string): boolean;
/**
 * Check if version1 is greater than or equal to version2.
 */
export declare function isGreaterThanOrEqual(version1: string, version2: string): boolean;
/**
 * Check if version1 is less than version2.
 */
export declare function isLessThan(version1: string, version2: string): boolean;
/**
 * Check if version1 is less than or equal to version2.
 */
export declare function isLessThanOrEqual(version1: string, version2: string): boolean;
/**
 * Validate if a string is a valid semantic version.
 */
export declare function isValidVersion(version: string): boolean;
/**
 * Get the highest version from an array of versions.
 */
export declare function maxVersion(versions: string[]): string | undefined;
/**
 * Get the lowest version from an array of versions.
 */
export declare function minVersion(versions: string[]): string | undefined;
/**
 * Parse a version string and return major, minor, patch components.
 */
export declare function parseVersion(version: string): {
    major: number;
    minor: number;
    patch: number;
    prerelease: ReadonlyArray<string | number>;
    build: readonly string[];
} | undefined;
/**
 * Check if a version satisfies a semver range.
 */
export declare function satisfiesVersion(version: string, range: string): boolean;
/**
 * Sort versions in ascending order.
 */
export declare function sortVersions(versions: string[]): string[];
/**
 * Sort versions in descending order.
 */
export declare function sortVersionsDesc(versions: string[]): string[];
/**
 * Get the difference between two versions.
 */
export declare function versionDiff(version1: string, version2: string): 'major' | 'premajor' | 'minor' | 'preminor' | 'patch' | 'prepatch' | 'prerelease' | undefined;