cordova-plugin-rootguard/types/index.d.ts

Best-effort root, jailbreak, and runtime instrumentation risk detection for Cordova.

declare namespace RootGuard {
    type Status = 0 | 1 | 2;
    type UnknownReason =
        | "modern_android_local_integrity_unverifiable"
        | "single_medium_signal"
        | "critical_check_unavailable"
        | "assessment_exception"
        | "ios_simulator"
        | "assessment_deadline";

    interface DetailedResult {
        status: Status;
        statusName: "SAFE" | "COMPROMISED" | "UNKNOWN";
        platform: "android" | "ios";
        osVersion: string;
        apiLevel?: number;
        evidence: string[];
        unavailableChecks: string[];
        unknownReasons?: UnknownReason[];
        localOnly: true;
    }

    interface Plugin {
        readonly SAFE: 0;
        readonly COMPROMISED: 1;
        readonly UNKNOWN: 2;

        checkSecurity(
            success: (compromised: 0 | 1) => void,
            error?: (error: unknown) => void
        ): void;

        checkSecurityStatus(
            success: (status: Status) => void,
            error?: (error: unknown) => void
        ): void;

        checkSecurityDetailed(
            success: (result: DetailedResult) => void,
            error?: (error: unknown) => void
        ): void;
    }
}

declare const RootGuard: RootGuard.Plugin;
export = RootGuard;
export as namespace RootGuard;