@biconomy/abstractjs/dist/_esm/account/utils/getVersion.js

SDK for Biconomy integration with support for account abstraction, smart accounts, ERC-4337.

/**
 * Retrieves the current version of the SDK from package.json
 *
 * This function provides access to the version number defined in the package.json file,
 * which can be useful for logging, debugging, or feature compatibility checks.
 *
 * @returns {string} The current version of the SDK
 *
 * @example
 * ```typescript
 * import { getVersion } from '@biconomy/abstractjs'
 *
 * console.log(`Using Biconomy SDK version: ${getVersion()}`)
 * ```
 */
export function getVersion() {
    try {
        // Using dynamic import with a relative path to the package.json
        // This works in both Node.js and bundled environments
        // eslint-disable-next-line @typescript-eslint/no-var-requires
        const packageJson = require("../../../../package.json");
        return packageJson.version;
    }
    catch (error) {
        // Fallback in case the package.json cannot be loaded
        console.warn("Could not determine SDK version from package.json");
        return "unknown";
    }
}
/**
 * Compares two semantic version strings
 *
 * This function compares two semantic version strings (e.g., "1.2.3" and "1.3.0")
 * and determines their relative order.
 *
 * @param {string} a - First version string to compare
 * @param {string} b - Second version string to compare
 * @returns {number} Returns:
 *   - Negative number if version a is lower than version b
 *   - Zero if versions are equal
 *   - Positive number if version a is higher than version b
 *
 * @example
 * ```typescript
 * import { semverCompare } from '@biconomy/abstractjs'
 *
 * // Returns negative number (a < b)
 * semverCompare("1.2.3", "1.3.0")
 *
 * // Returns positive number (a > b)
 * semverCompare("2.0.0", "1.9.9")
 *
 * // Returns 0 (a === b)
 * semverCompare("1.2.3", "1.2.3")
 * ```
 */
export const semverCompare = (a, b) => {
    const aParts = a.split(".").map((part) => Number.parseInt(part, 10));
    const bParts = b.split(".").map((part) => Number.parseInt(part, 10));
    // Ensure both arrays have the same length
    const maxLength = Math.max(aParts.length, bParts.length);
    while (aParts.length < maxLength)
        aParts.push(0);
    while (bParts.length < maxLength)
        bParts.push(0);
    for (let i = 0; i < maxLength; i++) {
        if (aParts[i] !== bParts[i]) {
            return aParts[i] - bParts[i];
        }
    }
    return 0;
};
/**
 * Checks if a version meets or exceeds a required version
 *
 * This function determines if a given version is equal to or higher than
 * a required minimum version, which is useful for feature compatibility checks.
 *
 * @param {string} currentVersion - The version to check
 * @param {string} requiredVersion - The minimum required version
 * @returns {boolean} Returns true if currentVersion >= requiredVersion, false otherwise
 *
 * @example
 * ```typescript
 * import { versionMeetsRequirement } from '@biconomy/abstractjs'
 *
 * // Returns true (current version exceeds required)
 * versionMeetsRequirement("1.3.0", "1.2.0")
 *
 * // Returns false (current version below required)
 * versionMeetsRequirement("1.2.3", "1.3.0")
 *
 * // Returns true (versions are equal)
 * versionMeetsRequirement("1.2.3", "1.2.3")
 * ```
 */
export const versionIsAtLeast = (currentVersion, requiredVersion) => {
    // Use the existing semverCompare function
    const comparison = semverCompare(currentVersion, requiredVersion);
    // Return true if currentVersion >= requiredVersion (comparison >= 0)
    return comparison >= 0;
};
/**
 * Checks if a version is older than a specified version
 *
 * This function determines if a given version is lower than (comes before)
 * a specified version, which is useful for backward compatibility checks.
 *
 * @param {string} currentVersion - The version to check
 * @param {string} referenceVersion - The version to compare against
 * @returns {boolean} Returns true if currentVersion < referenceVersion, false otherwise
 *
 * @example
 * ```typescript
 * import { isVersionOlder } from '@biconomy/abstractjs'
 *
 * // Returns true (current version is older than reference)
 * isVersionOlder("1.2.0", "1.3.0")
 *
 * // Returns false (current version is newer than reference)
 * isVersionOlder("1.3.0", "1.2.3")
 *
 * // Returns false (versions are equal)
 * isVersionOlder("1.2.3", "1.2.3")
 * ```
 */
export const isVersionOlder = (currentVersion, referenceVersion) => {
    // Use the existing semverCompare function
    const comparison = semverCompare(currentVersion, referenceVersion);
    // Return true if currentVersion < referenceVersion (comparison < 0)
    return comparison < 0;
};
/**
 * Checks if a version is newer than a specified version
 *
 * This function determines if a given version is higher than (comes after)
 * a specified version, which is useful for forward compatibility checks.
 *
 * @param {string} currentVersion - The version to check
 * @param {string} referenceVersion - The version to compare against
 * @returns {boolean} Returns true if currentVersion > referenceVersion, false otherwise
 *
 * @example
 * ```typescript
 * import { isVersionNewer } from '@biconomy/abstractjs'
 *
 * // Returns true (current version is newer than reference)
 * isVersionNewer("1.3.0", "1.2.3")
 *
 * // Returns false (current version is older than reference)
 * isVersionNewer("1.2.0", "1.3.0")
 *
 * // Returns false (versions are equal)
 * isVersionNewer("1.2.3", "1.2.3")
 * ```
 */
export const isVersionNewer = (currentVersion, referenceVersion) => {
    // Use the existing semverCompare function
    const comparison = semverCompare(currentVersion, referenceVersion);
    // Return true if currentVersion > referenceVersion (comparison > 0)
    return comparison > 0;
};
//# sourceMappingURL=getVersion.js.map