@zkpassport/ui 0.16.1 → 0.17.0-beta.1

package/dist/cjs/verify-button-BTuf-26F.d.cts

@@ -0,0 +1,978 @@
+declare global {
+    interface BigIntConstructor {
+        (value: Binary): bigint;
+    }
+}
+type BinaryInput = bigint | Buffer | Uint8Array | number[] | string | number | ArrayBufferLike;
+type HexString = string & {
+    readonly __hex: unique symbol;
+};
+declare class Binary {
+    private readonly bytes;
+    constructor(data: BinaryInput);
+    private static convertToBytes;
+    private static isHexString;
+    static from(data: BinaryInput): Binary;
+    static fromHex(hex: string): Binary;
+    static fromBuffer(buffer: Buffer): Binary;
+    static fromBase64(base64: string): Binary;
+    static empty(): Binary;
+    static zero(length: number): Binary;
+    toBigInt(): bigint;
+    toUInt8Array(): Uint8Array;
+    toNumberArray(): number[];
+    toHex(): HexString | string;
+    toBuffer(): Buffer;
+    toString(encoding?: BufferEncoding): string;
+    toBase64(): string;
+    toJSON(): string;
+    [Symbol.toPrimitive](hint: string): string | number | bigint;
+    valueOf(): bigint;
+    get length(): number;
+    [Symbol.iterator](): Iterator<number>;
+    equals(other: Binary): boolean;
+    slice(start?: number, end?: number): Binary;
+    concat(other: Binary): Binary;
+    compare(other: Binary): number;
+    xor(other: Binary): Binary;
+    and(other: Binary): Binary;
+    or(other: Binary): Binary;
+    not(): Binary;
+    padStart(length: number, fillByte?: number): Binary;
+    padEnd(length: number, fillByte?: number): Binary;
+}
+
+type Alpha3Code =
+  | "AFG"
+  | "ALB"
+  | "DZA"
+  | "ASM"
+  | "AND"
+  | "AGO"
+  | "AIA"
+  | "ATA"
+  | "ATG"
+  | "ARG"
+  | "ARM"
+  | "ABW"
+  | "AUS"
+  | "AUT"
+  | "AZE"
+  | "BHS"
+  | "BHR"
+  | "BGD"
+  | "BRB"
+  | "BLR"
+  | "BEL"
+  | "BLZ"
+  | "BEN"
+  | "BMU"
+  | "BTN"
+  | "BOL"
+  | "BIH"
+  | "BWA"
+  | "BVT"
+  | "BRA"
+  | "IOT"
+  | "BRN"
+  | "BGR"
+  | "BFA"
+  | "BDI"
+  | "KHM"
+  | "CMR"
+  | "CAN"
+  | "CPV"
+  | "CYM"
+  | "CAF"
+  | "TCD"
+  | "CHL"
+  | "CHN"
+  | "CXR"
+  | "CCK"
+  | "COL"
+  | "COM"
+  | "COG"
+  | "COD"
+  | "COK"
+  | "CRI"
+  | "CIV"
+  | "HRV"
+  | "CUB"
+  | "CYP"
+  | "CZE"
+  | "DNK"
+  | "DJI"
+  | "DMA"
+  | "DOM"
+  | "ECU"
+  | "EGY"
+  | "SLV"
+  | "GNQ"
+  | "ERI"
+  | "EST"
+  | "ETH"
+  | "FLK"
+  | "FRO"
+  | "FJI"
+  | "FIN"
+  | "FRA"
+  | "GUF"
+  | "PYF"
+  | "ATF"
+  | "GAB"
+  | "GMB"
+  | "GEO"
+  | "DEU"
+  | "GHA"
+  | "GIB"
+  | "GRC"
+  | "GRL"
+  | "GRD"
+  | "GLP"
+  | "GUM"
+  | "GTM"
+  | "GIN"
+  | "GNB"
+  | "GUY"
+  | "HTI"
+  | "HMD"
+  | "VAT"
+  | "HND"
+  | "HKG"
+  | "HUN"
+  | "ISL"
+  | "IND"
+  | "IDN"
+  | "IRN"
+  | "IRQ"
+  | "IRL"
+  | "ISR"
+  | "ITA"
+  | "JAM"
+  | "JPN"
+  | "JOR"
+  | "KAZ"
+  | "KEN"
+  | "KIR"
+  | "PRK"
+  | "KOR"
+  | "KWT"
+  | "KGZ"
+  | "LAO"
+  | "LVA"
+  | "LBN"
+  | "LSO"
+  | "LBR"
+  | "LBY"
+  | "LIE"
+  | "LTU"
+  | "LUX"
+  | "MAC"
+  | "MDG"
+  | "MWI"
+  | "MYS"
+  | "MDV"
+  | "MLI"
+  | "MLT"
+  | "MHL"
+  | "MTQ"
+  | "MRT"
+  | "MUS"
+  | "MYT"
+  | "MEX"
+  | "FSM"
+  | "MDA"
+  | "MCO"
+  | "MNG"
+  | "MSR"
+  | "MAR"
+  | "MOZ"
+  | "MMR"
+  | "NAM"
+  | "NRU"
+  | "NPL"
+  | "NLD"
+  | "NCL"
+  | "NZL"
+  | "NIC"
+  | "NER"
+  | "NGA"
+  | "NIU"
+  | "NFK"
+  | "MNP"
+  | "MKD"
+  | "NOR"
+  | "OMN"
+  | "PAK"
+  | "PLW"
+  | "PSE"
+  | "PAN"
+  | "PNG"
+  | "PRY"
+  | "PER"
+  | "PHL"
+  | "PCN"
+  | "POL"
+  | "PRT"
+  | "PRI"
+  | "QAT"
+  | "REU"
+  | "ROU"
+  | "RUS"
+  | "RWA"
+  | "SHN"
+  | "KNA"
+  | "LCA"
+  | "SPM"
+  | "VCT"
+  | "WSM"
+  | "SMR"
+  | "STP"
+  | "SAU"
+  | "SEN"
+  | "SYC"
+  | "SLE"
+  | "SGP"
+  | "SVK"
+  | "SVN"
+  | "SLB"
+  | "SOM"
+  | "ZAF"
+  | "SGS"
+  | "ESP"
+  | "LKA"
+  | "SDN"
+  | "SUR"
+  | "SJM"
+  | "SWZ"
+  | "SWE"
+  | "CHE"
+  | "SYR"
+  | "TWN"
+  | "TJK"
+  | "TZA"
+  | "THA"
+  | "TLS"
+  | "TGO"
+  | "TKL"
+  | "TON"
+  | "TTO"
+  | "TUN"
+  | "TUR"
+  | "TKM"
+  | "TCA"
+  | "TUV"
+  | "UGA"
+  | "UKR"
+  | "ARE"
+  | "GBR"
+  | "USA"
+  | "UMI"
+  | "URY"
+  | "UZB"
+  | "VUT"
+  | "VEN"
+  | "VNM"
+  | "VGB"
+  | "VIR"
+  | "WLF"
+  | "ESH"
+  | "YEM"
+  | "ZMB"
+  | "ZWE"
+  | "ALA"
+  | "BES"
+  | "CUW"
+  | "GGY"
+  | "IMN"
+  | "JEY"
+  | "MNE"
+  | "BLM"
+  | "MAF"
+  | "SRB"
+  | "SXM"
+  | "SSD"
+  | "XKX"
+
+type CountryName = "Afghanistan" | "Albania" | "Algeria" | "American Samoa" | "Andorra" | "Angola" | "Anguilla" | "Antarctica" | "Antigua and Barbuda" | "Argentina" | "Armenia" | "Aruba" | "Australia" | "Austria" | "Azerbaijan" | "Bahamas" | "Bahrain" | "Bangladesh" | "Barbados" | "Belarus" | "Belgium" | "Belize" | "Benin" | "Bermuda" | "Bhutan" | "Bolivia" | "Bosnia and Herzegovina" | "Botswana" | "Bouvet Island" | "Brazil" | "British Indian Ocean Territory" | "Brunei Darussalam" | "Bulgaria" | "Burkina Faso" | "Burundi" | "Cambodia" | "Cameroon" | "Canada" | "Cape Verde" | "Cayman Islands" | "Central African Republic" | "Chad" | "Chile" | "People's Republic of China" | "China" | "Christmas Island" | "Cocos (Keeling) Islands" | "Colombia" | "Comoros" | "Republic of the Congo" | "Congo" | "Democratic Republic of the Congo" | "Cook Islands" | "Costa Rica" | "Cote d'Ivoire" | "Côte d'Ivoire" | "Ivory Coast" | "Croatia" | "Cuba" | "Cyprus" | "Czech Republic" | "Czechia" | "Denmark" | "Djibouti" | "Dominica" | "Dominican Republic" | "Ecuador" | "Egypt" | "El Salvador" | "Equatorial Guinea" | "Eritrea" | "Estonia" | "Ethiopia" | "Falkland Islands (Malvinas)" | "Faroe Islands" | "Fiji" | "Finland" | "France" | "French Guiana" | "French Polynesia" | "French Southern Territories" | "Gabon" | "Republic of The Gambia" | "The Gambia" | "Gambia" | "Georgia" | "Germany" | "Ghana" | "Gibraltar" | "Greece" | "Greenland" | "Grenada" | "Guadeloupe" | "Guam" | "Guatemala" | "Guinea" | "Guinea-Bissau" | "Guyana" | "Haiti" | "Heard Island and McDonald Islands" | "Holy See (Vatican City State)" | "Honduras" | "Hong Kong" | "Hungary" | "Iceland" | "India" | "Indonesia" | "Islamic Republic of Iran" | "Iran" | "Iraq" | "Ireland" | "Israel" | "Italy" | "Jamaica" | "Japan" | "Jordan" | "Kazakhstan" | "Kenya" | "Kiribati" | "North Korea" | "South Korea" | "Korea, Republic of" | "Republic of Korea" | "Kuwait" | "Kyrgyzstan" | "Lao People's Democratic Republic" | "Latvia" | "Lebanon" | "Lesotho" | "Liberia" | "Libya" | "Liechtenstein" | "Lithuania" | "Luxembourg" | "Macao" | "Madagascar" | "Malawi" | "Malaysia" | "Maldives" | "Mali" | "Malta" | "Marshall Islands" | "Martinique" | "Mauritania" | "Mauritius" | "Mayotte" | "Mexico" | "Micronesia, Federated States of" | "Moldova, Republic of" | "Monaco" | "Mongolia" | "Montserrat" | "Morocco" | "Mozambique" | "Myanmar" | "Namibia" | "Nauru" | "Nepal" | "Netherlands" | "The Netherlands" | "Netherlands (Kingdom of the)" | "New Caledonia" | "New Zealand" | "Nicaragua" | "Niger" | "Nigeria" | "Niue" | "Norfolk Island" | "The Republic of North Macedonia" | "North Macedonia" | "Northern Mariana Islands" | "Norway" | "Oman" | "Pakistan" | "Palau" | "State of Palestine" | "Palestine" | "Panama" | "Papua New Guinea" | "Paraguay" | "Peru" | "Philippines" | "Pitcairn" | "Pitcairn Islands" | "Poland" | "Portugal" | "Puerto Rico" | "Qatar" | "Reunion" | "Romania" | "Russian Federation" | "Russia" | "Rwanda" | "Saint Helena" | "Saint Kitts and Nevis" | "Saint Lucia" | "Saint Pierre and Miquelon" | "Saint Vincent and the Grenadines" | "Samoa" | "San Marino" | "Sao Tome and Principe" | "Saudi Arabia" | "Senegal" | "Seychelles" | "Sierra Leone" | "Singapore" | "Slovakia" | "Slovenia" | "Solomon Islands" | "Somalia" | "South Africa" | "South Georgia and the South Sandwich Islands" | "Spain" | "Sri Lanka" | "Sudan" | "Suriname" | "Svalbard and Jan Mayen" | "Eswatini" | "Sweden" | "Switzerland" | "Syrian Arab Republic" | "Taiwan" | "Tajikistan" | "United Republic of Tanzania" | "Tanzania" | "Thailand" | "Timor-Leste" | "Togo" | "Tokelau" | "Tonga" | "Trinidad and Tobago" | "Tunisia" | "Türkiye" | "Turkey" | "Turkmenistan" | "Turks and Caicos Islands" | "Tuvalu" | "Uganda" | "Ukraine" | "United Arab Emirates" | "UAE" | "United Kingdom" | "UK" | "Great Britain" | "United States of America" | "United States" | "USA" | "U.S.A." | "US" | "U.S." | "United States Minor Outlying Islands" | "Uruguay" | "Uzbekistan" | "Vanuatu" | "Venezuela" | "Vietnam" | "Virgin Islands, British" | "Virgin Islands, U.S." | "Wallis and Futuna" | "Western Sahara" | "Yemen" | "Zambia" | "Zimbabwe" | "Åland Islands" | "Aland Islands" | "Bonaire, Sint Eustatius and Saba" | "Curaçao" | "Guernsey" | "Isle of Man" | "Jersey" | "Montenegro" | "Saint Barthélemy" | "Saint Martin (French part)" | "Serbia" | "Sint Maarten (Dutch part)" | "South Sudan" | "Kosovo" | "Zero Knowledge Republic";
+
+type DisclosableIDCredential = "birthdate" | "expiry_date" | "nationality" | "firstname" | "lastname" | "fullname" | "document_number" | "document_type" | "issuing_country" | "gender";
+type NumericalIDCredential = "age" | "birthdate" | "expiry_date";
+type IDCredential = NumericalIDCredential | DisclosableIDCredential;
+type IDCredentialValue<T extends IDCredential> = T extends "nationality" | "issuing_country" ? CountryName | Alpha3Code : T extends "gender" ? "male" | "female" : T extends "document_type" ? "passport" | "id_card" | "residence_permit" | "other" : T extends "age" ? number : T extends "birthdate" | "expiry_date" ? Date : string;
+type IDCredentialConfig = {
+    eq?: any;
+    gte?: number | Date;
+    gt?: number | Date;
+    lte?: number | Date;
+    lt?: number | Date;
+    range?: [number | Date, number | Date];
+    in?: any[];
+    out?: any[];
+    disclose?: boolean;
+};
+type QueryResultValue<T extends IDCredential> = {
+    eq?: {
+        expected: T extends "nationality" | "issuing_country" ? Alpha3Code : T extends "age" ? number : T extends "birthdate" | "expiry_date" ? Date : string;
+        result: boolean;
+    };
+    gte?: {
+        expected: T extends "age" ? number : Date;
+        result: boolean;
+    };
+    gt?: {
+        expected: T extends "age" ? number : Date;
+        result: boolean;
+    };
+    lte?: {
+        expected: T extends "age" ? number : Date;
+        result: boolean;
+    };
+    lt?: {
+        expected: T extends "age" ? number : Date;
+        result: boolean;
+    };
+    range?: {
+        expected: [T extends "age" ? number : Date, T extends "age" ? number : Date];
+        result: boolean;
+    };
+    in?: {
+        expected: T extends "nationality" | "issuing_country" ? Alpha3Code[] : any[];
+        result: boolean;
+    };
+    out?: {
+        expected: T extends "nationality" | "issuing_country" ? Alpha3Code[] : any[];
+        result: boolean;
+    };
+    disclose?: {
+        result: T extends "birthdate" | "expiry_date" ? Date : T extends "age" ? number : T extends "nationality" | "issuing_country" ? Alpha3Code : string;
+    };
+};
+type SanctionsAlpha2Code = "US" | "GB" | "CH" | "EU";
+type SanctionsCountries = "all";
+type SanctionsLists = "all";
+type SanctionsConfig = {
+    countries?: SanctionsCountries;
+    lists?: SanctionsLists;
+    strict?: boolean;
+};
+type SanctionsResult = {
+    passed: boolean;
+    countries?: Record<SanctionsAlpha2Code, {
+        passed: boolean;
+    }>;
+    lists?: Record<string, {
+        passed: boolean;
+    }>;
+    isStrict: boolean;
+};
+type FacematchMode = "strict" | "regular";
+type FacematchConfig = {
+    mode: FacematchMode;
+};
+type FacematchResult = {
+    mode: FacematchMode;
+    passed: boolean;
+};
+type Query = {
+    [key in IDCredential]?: IDCredentialConfig;
+} & {
+    bind?: BoundData;
+    sanctions?: SanctionsConfig;
+    facematch?: FacematchConfig;
+    policy?: string;
+};
+type QueryResult = {
+    [key in IDCredential]?: QueryResultValue<key>;
+} & {
+    bind?: BoundData;
+    sanctions?: SanctionsResult;
+    facematch?: FacematchResult;
+};
+type AgeCommittedInputs = {
+    minAge: number;
+    maxAge: number;
+};
+type CountryCommittedInputs = {
+    countries: Alpha3Code[];
+};
+type DateCommittedInputs = {
+    minDateTimestamp: number;
+    maxDateTimestamp: number;
+};
+type DiscloseCommittedInputs = {
+    discloseMask: number[];
+    disclosedBytes: number[];
+};
+type FacematchCommittedInputs = {
+    rootKeyLeaf: string;
+    environment: "development" | "production";
+    appIdHash: string;
+    integrityPubkeyHash: string;
+    mode: FacematchMode;
+};
+type SupportedChain = "ethereum" | "base" | "arbitrum" | "optimism" | "polygon" | "celo" | "gnosis" | "scroll" | "linea" | "world_chain" | "ethereum_sepolia" | "base_sepolia" | "arbitrum_sepolia" | "polygon_amoy" | "celo_sepolia" | "gnosis_chiado" | "scroll_sepolia" | "linea_sepolia" | "world_chain_sepolia" | "local";
+type BoundData = {
+    user_address?: string;
+    chain?: SupportedChain;
+    custom_data?: string;
+};
+type BindCommittedInputs = {
+    data: BoundData;
+};
+type SanctionsCommittedInputs = {
+    rootHash: string;
+    isStrict: boolean;
+};
+type CommittedInputs = AgeCommittedInputs | CountryCommittedInputs | DateCommittedInputs | DiscloseCommittedInputs | BindCommittedInputs | SanctionsCommittedInputs | FacematchCommittedInputs;
+type DisclosureCircuitName = "disclose_bytes" | "disclose_bytes_evm" | "compare_age" | "compare_age_evm" | "compare_birthdate" | "compare_birthdate_evm" | "compare_expiry" | "compare_expiry_evm" | "exclusion_check_issuing_country" | "exclusion_check_issuing_country_evm" | "exclusion_check_nationality" | "exclusion_check_nationality_evm" | "exclusion_check_sanctions" | "exclusion_check_sanctions_evm" | "inclusion_check_issuing_country" | "inclusion_check_issuing_country_evm" | "inclusion_check_nationality" | "inclusion_check_nationality_evm" | "bind" | "bind_evm" | "facematch" | "facematch_evm";
+type ProofResult = {
+    proof?: string;
+    vkeyHash?: string;
+    version?: `${number}.${number}.${number}`;
+    name?: string;
+    committedInputs?: {
+        [circuitName in DisclosureCircuitName]?: CommittedInputs;
+    };
+    index?: number;
+    total?: number;
+};
+type Service = {
+    name: string;
+    logo: string;
+    purpose: string;
+    scope?: string;
+    projectID?: string;
+    chainId?: number;
+    cloudProverUrl?: string;
+    bridgeUrl?: string;
+};
+type ProofMode = "fast" | "compressed" | "compressed-evm";
+declare enum NullifierType {
+    NON_SALTED = 0,
+    SALTED = 1,
+    NON_SALTED_MOCK = 2,
+    SALTED_MOCK = 3,
+    NONE = 4
+}
+
+type QueryResultError<T> = {
+    expected?: T;
+    received?: T;
+    message: string;
+};
+type QueryResultErrors = {
+    [key in IDCredential | "sig_check_dsc" | "sig_check_id_data" | "data_check_integrity" | "outer" | "disclose" | "bind" | "facematch" | "sanctions"]: {
+        disclose?: QueryResultError<string | number | Date>;
+        gte?: QueryResultError<number | Date>;
+        gt?: QueryResultError<number | Date>;
+        lte?: QueryResultError<number | Date>;
+        lt?: QueryResultError<number | Date>;
+        range?: QueryResultError<[number | Date, number | Date]>;
+        in?: QueryResultError<string[]>;
+        out?: QueryResultError<string[]>;
+        eq?: QueryResultError<string | number | Date>;
+        commitment?: QueryResultError<string>;
+        date?: QueryResultError<string>;
+        certificate?: QueryResultError<string>;
+        scope?: QueryResultError<string>;
+    };
+};
+type VerifierMode = "auto" | "local" | "api";
+type VerificationResult = {
+    uniqueIdentifier: string | undefined;
+    uniqueIdentifierType: NullifierType | undefined;
+    verified: boolean;
+    queryResultErrors?: Partial<QueryResultErrors>;
+};
+type SolidityProofVerificationData = {
+    vkeyHash: string;
+    proof: string;
+    publicInputs: string[];
+};
+type SolidityServiceConfig = {
+    validityPeriodInSeconds: number;
+    domain: string;
+    scope: string;
+    devMode: boolean;
+};
+type SolidityVerifierParameters = {
+    version: string;
+    proofVerificationData: SolidityProofVerificationData;
+    committedInputs: string;
+    serviceConfig: SolidityServiceConfig;
+};
+type RequestSuccess = {
+    proofs: ProofResult[];
+    result: QueryResult;
+};
+type OnSuccessVerdict = void | boolean | Promise<void | boolean>;
+type QueryBuilderResult = {
+    /**
+     * The URL of the request.
+     *
+     * You can either encode the URL in a QR code or let the user click the link
+     * to this URL on your website if they're visiting your website on their phone.
+     */
+    url: string;
+    /**
+     * The query object.
+     */
+    query: Query;
+    /**
+     * The id of the request.
+     */
+    requestId: string;
+    /**
+     * The id of the policy used to build the request, if one was provided.
+     */
+    policy?: string;
+    /**
+     * Called when the user has scanned the QR code or clicked the link to the request.
+     *
+     * This means the user is currently viewing the request popup with your website information
+     * and the information requested from them.
+     */
+    onRequestReceived: (callback: () => void) => void;
+    /**
+     * Called when the user has accepted the request and
+     * started to generate the proof on their phone.
+     */
+    onGeneratingProof: (callback: () => void) => void;
+    /**
+     * Called when the SDK successfully connects to the bridge with the mobile app.
+     */
+    onBridgeConnect: (callback: () => void) => void;
+    /**
+     * Called when the user has generated a proof.
+     *
+     * There is a minimum of 4 proofs, but there can be more depending
+     * on the type of information requested from the user.
+     */
+    onProofGenerated: (callback: (proof: ProofResult) => void) => void;
+    /**
+     * Called when the user has completed the request and all proofs were received.
+     *
+     * The proofs are not verified at this point: send them along with the result
+     * to your backend and verify them there with `verify()`. The UI components wait
+     * for this callback before showing their success state; return `false` (or throw)
+     * to show the error state instead, e.g. when your backend rejects the proofs.
+     */
+    onSuccess: (callback: (response: RequestSuccess) => OnSuccessVerdict) => void;
+    /**
+     * Called when the user has sent the query result.
+     *
+     * The response contains the unique identifier associated to the user,
+     * your domain name and chosen scope, along with the query result and whether
+     * the proofs were successfully verified.
+     *
+     * @deprecated The verified flag can be tampered with in the browser. Use `onSuccess`
+     * and verify the proofs on your backend with `verify()`.
+     */
+    onResult: (callback: (response: {
+        uniqueIdentifier: string | undefined;
+        uniqueIdentifierType: NullifierType | undefined;
+        verified: boolean;
+        result: QueryResult;
+        queryResultErrors?: Partial<QueryResultErrors>;
+        proofs: ProofResult[];
+        sdkInstance: ZKPassport;
+    }) => void) => void;
+    /**
+     * Called when the user has rejected the request.
+     */
+    onReject: (callback: () => void) => void;
+    /**
+     * Called when an error occurs, such as one of the requirements not being met
+     * or a proof failing to be generated.
+     */
+    onError: (callback: (error: string) => void) => void;
+    /**
+     * @returns true if the bridge with the mobile app is connected
+     */
+    isBridgeConnected: () => boolean;
+    /**
+     * Get if the user has scanned the QR code or the link to this request
+     * @returns true if the request has been received by the user on their phone
+     */
+    requestReceived: () => boolean;
+};
+type OfflineQueryBuilderResult = {
+    query: Query;
+};
+type QueryBuilder<T extends "online" | "offline" = "online"> = {
+    /**
+     * Requires this attribute to be equal to the provided value.
+     * @param key The attribute to compare.
+     * @param value The value of the attribute you require.
+     */
+    eq: <T extends IDCredential>(key: T, value: IDCredentialValue<T>) => QueryBuilder;
+    /**
+     * Requires this attribute to be greater than or equal to the provided value.
+     * @param key The attribute to compare.
+     * @param value The value of the attribute you require.
+     */
+    gte: <T extends NumericalIDCredential>(key: T, value: IDCredentialValue<T>) => QueryBuilder;
+    /**
+     * Requires this attribute to be greater than the provided value.
+     * @param key The attribute to compare.
+     * @param value The value of the attribute you require.
+     */
+    gt: <T extends NumericalIDCredential>(key: T, value: IDCredentialValue<T>) => QueryBuilder;
+    /**
+     * Requires this attribute to be less than or equal to the provided value.
+     * @param key The attribute to compare.
+     * @param value The value of the attribute you require.
+     */
+    lte: <T extends NumericalIDCredential>(key: T, value: IDCredentialValue<T>) => QueryBuilder;
+    /**
+     * Requires this attribute to be less than the provided value.
+     * @param key The attribute to compare.
+     * @param value The value of the attribute you require.
+     */
+    lt: <T extends NumericalIDCredential>(key: T, value: IDCredentialValue<T>) => QueryBuilder;
+    /**
+     * Requires this attribute to be included in the provided range.
+     * @param key The attribute to compare.
+     * @param start The start of the range.
+     * @param end The end of the range.
+     */
+    range: <T extends NumericalIDCredential>(key: T, start: IDCredentialValue<T>, end: IDCredentialValue<T>) => QueryBuilder;
+    /**
+     * Requires this attribute to be included in the provided list.
+     * @param key The attribute to compare.
+     * @param value The list of values to check inclusion against.
+     */
+    in: <T extends "nationality" | "issuing_country">(key: T, value: IDCredentialValue<T>[]) => QueryBuilder;
+    /**
+     * Requires this attribute to be excluded from the provided list.
+     * @param key The attribute to compare.
+     * @param value The list of values to check exclusion against.
+     */
+    out: <T extends "nationality" | "issuing_country">(key: T, value: IDCredentialValue<T>[]) => QueryBuilder;
+    /**
+     * Requires this attribute to be disclosed.
+     * @param key The attribute to disclose.
+     */
+    disclose: (key: DisclosableIDCredential) => QueryBuilder;
+    /**
+     * Binds a value to the request.
+     * @param key The key of the value to bind.
+     * @param value The value to bind the request to.
+     */
+    bind: <T extends keyof BoundData>(key: T, value: T extends "chain" ? SupportedChain : T extends "user_address" ? `0x${string}` : string | undefined) => QueryBuilder;
+    /**
+     * Requires that the ID holder is not part of any of the specified sanction lists.
+     * @param countries The country or list of countries whose sanction lists to check against. Defaults to "all".
+     * e.g. "US", ["US", "GB", "CH", "EU"], "all"
+     * @param lists The specific lists from a given country to check against. Defaults to "all".
+     * e.g. ["OFAC_SDN"], "all"
+     * @param options The options to use for the sanction check.
+     * @param options.strict Whether to use a strict sanction check. Defaults to false.
+     *
+     * If set to true, this means the checks will be done against just the lastname and firstname,
+     * while when set to false, matches will need to include either the date of birth and name or
+     * the passport number and nationality.
+     * Strict mode has therefore a higher false positive rate but is harder to evade.
+     */
+    sanctions: (countries?: SanctionsCountries, lists?: SanctionsLists, options?: {
+        strict?: boolean;
+    }) => QueryBuilder;
+    /**
+     * Requires that the ID holder's face matches the photo on the ID.
+     * @param mode The mode to use for the face match. Defaults to "strict".
+     * @param mode "strict" - The user will have to go through an extensive liveness check to prevent spoofing making it more secure.
+     * Best for high security requirements such as KYC.
+     * @param mode "regular" - The user will only have to go through a basic liveness check to prevent spoofing, making it faster for the user.
+     * Best for lower security requirements that requires fast verification such as age verification.
+     */
+    facematch: (mode?: FacematchMode) => QueryBuilder;
+    raw: (query: Query) => QueryBuilder<T>;
+    /**
+     * Applies an immutable policy fetched from the dashboard. The policy's query,
+     * purpose and scope are locked; combining with builder methods (except
+     * `.bind()`, which may follow it) or calling twice throws.
+     * @param id The policy id (e.g. `'pol_xyz'`).
+     */
+    policy: (id: string) => QueryBuilder<T>;
+    /**
+     * Builds the request.
+     *
+     * This will return the URL of the request, which you can either encode in a QR code
+     * or provide as a link to the user if they're visiting your website on their phone.
+     * It also returns all the callbacks you can use to handle the user's response.
+     */
+    done: () => T extends "online" ? QueryBuilderResult : OfflineQueryBuilderResult;
+};
+declare function createOfflineQuery(): QueryBuilder<"offline">;
+
+declare class ZKPassport {
+    private domain;
+    private domainProvided;
+    private topicToConfig;
+    private topicToLocalConfig;
+    private topicToPublicKey;
+    private topicToBridge;
+    private topicToRequestReceived;
+    private topicToService;
+    private topicToCallerPurpose;
+    private topicToProofs;
+    private topicToFailedProofCount;
+    private topicToResults;
+    private topicToPolicy;
+    private dashboardConfig;
+    private dashboardConfigPromise;
+    private dashboardConfigError;
+    private onRequestReceivedCallbacks;
+    private onGeneratingProofCallbacks;
+    private onBridgeConnectCallbacks;
+    private onProofGeneratedCallbacks;
+    private onSuccessCallbacks;
+    private onResultCallbacks;
+    private onRejectCallbacks;
+    private onErrorCallbacks;
+    private normalizeDomain;
+    constructor(_domain?: string);
+    private handleResult;
+    private verifyAndReportResult;
+    /**
+     * @notice Handle an encrypted message.
+     * @param request The request.
+     * @param outerRequest The outer request.
+     */
+    private handleEncryptedMessage;
+    private assertNotPolicyLocked;
+    private getZkPassportRequest;
+    private getDashboardConfig;
+    private fetchDashboardConfig;
+    private findPolicy;
+    private assertCanApplyPolicy;
+    /**
+     * @notice Create a new request. To apply a policy, chain `.policy('<id>')` on
+     * the returned builder; a policy locks the query and scope.
+     * @param name Your service name. Defaults to the dashboard branding, then the domain.
+     * @param logo Your service logo. Defaults to the dashboard branding.
+     * @param purpose Explanation shown to the user. Defaults to the policy's purpose (if any), then a generic message.
+     * @param scope Use-case scope (drives the nullifier). Defaults to the domain. Locked by `.policy()` (to the policy id).
+     * @param projectID The project ID of your service
+     * @param validity How many seconds ago the proof checking the expiry date of the ID should have been generated
+     * @param mode The proof mode (e.g. "fast" / "compressed").
+     * @param devMode Whether to enable dev mode. This will allow you to verify mock proofs (i.e. from ZKR)
+     * @param verifierMode How the received proofs are verified: "local", "api" or "auto" (default).
+     * @returns The query builder object.
+     */
+    request({ name, logo, purpose, scope, projectID, mode, validity, devMode, uniqueIdentifierType, oprfKeyId, topicOverride, keyPairOverride, cloudProverUrl, bridgeUrl, returnDeepLink, verifierMode, }: {
+        name?: string;
+        logo?: string;
+        purpose?: string;
+        scope?: string;
+        mode?: ProofMode;
+        projectID?: string;
+        validity?: number;
+        devMode?: boolean;
+        uniqueIdentifierType?: NullifierType.NON_SALTED | NullifierType.SALTED | NullifierType.NONE;
+        oprfKeyId?: string;
+        topicOverride?: string;
+        keyPairOverride?: {
+            privateKey: Uint8Array;
+            publicKey: Uint8Array;
+        };
+        cloudProverUrl?: string;
+        bridgeUrl?: string;
+        returnDeepLink?: string;
+        verifierMode?: VerifierMode;
+    }): Promise<QueryBuilder>;
+    /**
+     * @notice Create a new offline query
+     * Unlike request(), this function does not connect to the bridge.
+     * It returns only the query object and no callbacks and no URL.
+     * This can be useful to recreate the same query server-side when calling `verify()`
+     * to ensure the original query wasn't tampered with.
+     * @returns The query builder object.
+     */
+    createQuery(): QueryBuilder<"offline">;
+    /**
+     * @notice Verify the proofs received from the mobile app.
+     * @param proofs The proofs to verify.
+     * @param originalQuery The original query that was sent to the mobile app.
+     * @param queryResult The query result to verify against
+     * @param validity How many seconds ago the proof checking the expiry date of the ID should have been generated
+     * @param scope The scope used in the original request, if any. Proofs generated for a different scope fail verification.
+     * @param devMode Whether to enable dev mode. This will allow you to verify mock proofs (i.e. from ZKR)
+     * @param writingDirectory The directory (e.g. `./tmp`) where the necessary temporary artifacts for verification are written to.
+     * It should only be needed when running the `verify` function on a server with restricted write access (e.g. Vercel)
+     * @param oprfKeyId The OPRF key id used in the original request, if any.
+     * @param verifierMode "local" verifies with the verifier bundled in this SDK, "api" with the
+     * ZKPassport verifier API, and "auto" (default) verifies locally but defers to the API when
+     * the local result is not verified — e.g. proofs from a newer bb version than this SDK supports.
+     * @returns An object containing the unique identifier associated to the user
+     * and a boolean indicating whether the proofs were successfully verified.
+     */
+    verify({ proofs, originalQuery, queryResult, validity, scope, devMode, writingDirectory, oprfKeyId, verifierMode, }: {
+        proofs: Array<ProofResult>;
+        originalQuery: Query;
+        queryResult: QueryResult;
+        validity?: number;
+        scope?: string;
+        devMode?: boolean;
+        writingDirectory?: string;
+        oprfKeyId?: string;
+        verifierMode?: VerifierMode;
+    }): Promise<VerificationResult>;
+    private verifyLocally;
+    getSolidityVerifierDetails(): {
+        address: `0x${string}`;
+        functionName: string;
+        abi: {
+            type: "function" | "event" | "constructor";
+            name: string;
+            inputs: {
+                name: string;
+                type: string;
+                internalType: string;
+            }[];
+            outputs: {
+                name: string;
+                type: string;
+                internalType: string;
+            }[];
+        }[];
+    };
+    getSolidityVerifierParameters({ proof, validityPeriodInSeconds, domain, scope, devMode, }: {
+        proof: ProofResult;
+        validityPeriodInSeconds?: number;
+        domain?: string;
+        scope?: string;
+        devMode?: boolean;
+    }): SolidityVerifierParameters;
+    private _getUrl;
+    /**
+     * @notice Returns the URL of the request.
+     * @param requestId The request ID.
+     * @returns The URL of the request.
+     */
+    getUrl(requestId: string): string;
+    /**
+     * @notice Returns the resolved service details (name, logo, purpose) shown to the
+     * user for a pending request, including branding resolved from the dashboard config.
+     * @param requestId The request ID.
+     */
+    getServiceDetails(requestId: string): Service | undefined;
+    /**
+     * @notice Cancels a request by closing the WebSocket connection and deleting the associated data.
+     * @param requestId The request ID.
+     */
+    cancelRequest(requestId: string): void;
+    /**
+     * @notice Clears all requests.
+     */
+    clearAllRequests(): void;
+}
+
+type PopupRequestConfig = {
+    name?: string;
+    logo?: string;
+    purpose?: string;
+    scope?: string;
+    mode?: ProofMode;
+    devMode?: boolean;
+    validity?: number;
+    uniqueIdentifierType?: NullifierType.NON_SALTED | NullifierType.SALTED;
+    oprfKeyId?: string;
+};
+type PopupEventMessage = {
+    zkpassport: true;
+    type: "request-received";
+} | {
+    zkpassport: true;
+    type: "generating";
+} | {
+    zkpassport: true;
+    type: "proof-generated";
+    index?: number;
+    total?: number;
+    name?: string;
+} | {
+    zkpassport: true;
+    type: "success";
+    proofs: ProofResult[];
+    result: QueryResult;
+} | {
+    zkpassport: true;
+    type: "rejected";
+} | {
+    zkpassport: true;
+    type: "error";
+    message: string;
+};
+
+type PopupSuccess = Extract<PopupEventMessage, {
+    type: "success";
+}>;
+type PopupCallbacks = {
+    onRequestReceived?: () => void;
+    onGeneratingProof?: () => void;
+    onProofGenerated?: (progress: {
+        index?: number;
+        total?: number;
+        name?: string;
+    }) => void;
+    onSuccess?: (response: Omit<PopupSuccess, "zkpassport" | "type">) => OnSuccessVerdict;
+    onReject?: () => void;
+    onError?: (message: string) => void;
+    onClose?: () => void;
+};
+type OpenVerificationPopupOptions = {
+    popupUrl?: string;
+    request: PopupRequestConfig;
+    query: Query;
+    callbacks?: PopupCallbacks;
+};
+type VerificationPopupHandle = {
+    close: () => void;
+    popup: Window;
+};
+/**
+ * Open the hosted verification popup. MUST be called from a user gesture
+ * (e.g. a click handler) or the browser will block the popup.
+ *
+ * If popup is blocked, will attempt to open in a new window.
+ */
+declare function openVerificationPopup(options: OpenVerificationPopupOptions): VerificationPopupHandle | null;
+
+type VerificationStatus = "idle" | "in-progress" | "success" | "error";
+type VerificationState = {
+    status: VerificationStatus;
+    error: string | null;
+};
+type VerificationOptions = PopupRequestConfig & PopupCallbacks & {
+    popupUrl?: string;
+    policyId?: string;
+    query: (queryBuilder: QueryBuilder) => QueryBuilderResult;
+};
+type VerificationController = {
+    readonly state: VerificationState;
+    verify: () => void;
+    close: () => void;
+};
+declare function createVerification(getOptions: () => VerificationOptions, onStateChange: (state: VerificationState) => void): VerificationController;
+
+declare const BUTTON_FONT_SIZES: {
+    readonly small: "13px";
+    readonly medium: "15px";
+    readonly large: "18px";
+};
+type VerifyButtonSize = keyof typeof BUTTON_FONT_SIZES;
+type VerifyWithZKPassportButtonOptions = VerificationOptions & {
+    theme?: "light" | "dark" | "auto";
+    size?: VerifyButtonSize;
+    label?: string;
+    showErrorMessage?: boolean;
+    classes?: {
+        root?: string;
+        button?: string;
+        error?: string;
+    };
+};
+
+export { type BoundData as B, type CountryName as C, type DisclosableIDCredential as D, type FacematchMode as F, type IDCredential as I, NullifierType as N, type ProofMode as P, type Query as Q, type SanctionsCountries as S, type VerificationOptions as V, ZKPassport as Z, type IDCredentialValue as a, type NumericalIDCredential as b, type ProofResult as c, type QueryBuilder as d, type QueryBuilderResult as e, type QueryResult as f, type QueryResultError as g, type QueryResultErrors as h, type SanctionsLists as i, type Service as j, type SupportedChain as k, type VerificationState as l, type VerificationStatus as m, type VerifyButtonSize as n, type VerifyWithZKPassportButtonOptions as o, type VerificationController as p, createVerification as q, type PopupRequestConfig as r, type PopupSuccess as s, type VerificationPopupHandle as t, createOfflineQuery as u, openVerificationPopup as v };