@vigilbase/cli/dist/local/cloudflare-checkup/errors.d.ts

Vigilbase CLI — security scanners, agent tools, and Vigilbase One from the terminal.

export declare const LOCAL_ERROR_CODES: readonly ["NODE_UNSUPPORTED", "CF_NOT_FOUND", "CF_WRONG_BINARY", "CF_UNSUPPORTED_VERSION", "CF_ALLOWLIST_MISMATCH", "CF_INSTALL_FAILED", "CF_AUTH_REQUIRED", "CF_PERMISSION_DENIED", "CF_RATE_LIMITED", "CF_ERROR", "ACCOUNT_SELECTION_REQUIRED", "ACCOUNT_NOT_VISIBLE", "ACCOUNT_TOO_LARGE", "ACCOUNT_MISMATCH", "OUTPUT_EXISTS", "SNAPSHOT_INVALID", "SNAPSHOT_TOO_LARGE", "SNAPSHOT_STALE", "SNAPSHOT_SECRET_LIKE_VALUE", "EMAIL_INVALID", "EMAIL_CODE_INVALID", "VERIFICATION_INVALID", "VERIFICATION_EXPIRED", "SESSION_INVALID", "SESSION_EXPIRED", "SESSION_USED", "SESSION_BUSY", "SESSION_CLOSED", "SUBMIT_ORIGIN_UNTRUSTED", "CONFIRMATION_REQUIRED", "CLI_UPGRADE_REQUIRED", "LOCAL_MODE_DISABLED", "VIGILBASE_RATE_LIMITED", "VIGILBASE_CHALLENGED", "SUBMIT_FAILED"];
export type LocalCheckupErrorCode = (typeof LOCAL_ERROR_CODES)[number];
/** LOCAL_MODE_DISABLED: the browser checkup on the origin the CLI talks to (vigilbase.com, or a loopback dev server). */
export declare function browserCheckupHint(origin: string): string;
/** One fix per code; shown after the error and in `--json` as `hint`. */
export declare const LOCAL_ERROR_HINTS: Record<LocalCheckupErrorCode, string>;
/**
 * CF_AUTH_REQUIRED in env mode (`--cf-auth env`, or `auto` with the variable
 * set): the browser sign-in is never offered while the token is used, so the
 * hint names both ways out.
 */
export declare const ENV_TOKEN_AUTH_HINT = "Set CLOUDFLARE_API_TOKEN in this shell to a valid read-only Cloudflare API token (read -rs CLOUDFLARE_API_TOKEN && export CLOUDFLARE_API_TOKEN) and run the same command again, or unset it (or use --cf-auth profile) to sign in with your browser instead.";
/** SNAPSHOT_INVALID for an `inspect` or `submit` path with no file: nothing to collect again, so how to make one. */
export declare const SNAPSHOT_MISSING_HINT = "Check the file path. To collect a snapshot into a file, run `npx @vigilbase/cli cloudflare-checkup collect --out <file>`.";
/** CF_PERMISSION_DENIED in env mode: the token lacks a read permission; the browser sign-in is the other way out. */
export declare const ENV_TOKEN_PERMISSION_HINT = "The API token in CLOUDFLARE_API_TOKEN cannot read everything the checkup needs. Add the read permissions to it, or unset it (or use --cf-auth profile) to sign in with your browser instead, then run the same command again.";
export declare class LocalCheckupError extends Error {
    readonly code: LocalCheckupErrorCode;
    readonly hint: string;
    /** HTTP status of the Cloudflare or Vigilbase response, when one caused the error. */
    readonly status?: number;
    readonly retryAfterSec?: number;
    constructor(code: LocalCheckupErrorCode, message: string, options?: {
        hint?: string;
        status?: number;
        retryAfterSec?: number;
    });
    /** Mapped to exit code 2 by `runCli`. */
    get isRateLimited(): boolean;
}
export declare function isLocalCheckupError(error: unknown): error is LocalCheckupError;