@zkpassport/sdk 0.11.0 → 0.12.0

package/dist/esm/constants.d.ts

@@ -1,9 +0,0 @@
-declare const VERSION = "0.11.0";
-declare const DEFAULT_VALIDITY: number;
-declare const DEFAULT_DATE_VALUE: Date;
-declare const ZKPASSPORT_IOS_APP_ID_HASH = "0x1fa73686cf510f8f85757b0602de0dd72a13e68ae2092462be8b72662e7f179b";
-declare const ZKPASSPORT_ANDROID_APP_ID_HASH = "0x24d9929b248be7eeecaa98e105c034a50539610f3fdd4cb9c8983ef4100d615d";
-declare const APPLE_APP_ATTEST_ROOT_KEY_HASH = "0x2532418a107c5306fa8308c22255792cf77e4a290cbce8a840a642a3e591340b";
-declare const GOOGLE_APP_ATTEST_RSA_ROOT_KEY_HASH = "0x16700a2d9168a194fc85f237af5829b5a2be05b8ae8ac4879ada34cf54a9c211";
-
-export { APPLE_APP_ATTEST_ROOT_KEY_HASH, DEFAULT_DATE_VALUE, DEFAULT_VALIDITY, GOOGLE_APP_ATTEST_RSA_ROOT_KEY_HASH, VERSION, ZKPASSPORT_ANDROID_APP_ID_HASH, ZKPASSPORT_IOS_APP_ID_HASH };

package/dist/esm/constants.js

@@ -1,18 +0,0 @@
-import {
-  APPLE_APP_ATTEST_ROOT_KEY_HASH,
-  DEFAULT_DATE_VALUE,
-  DEFAULT_VALIDITY,
-  GOOGLE_APP_ATTEST_RSA_ROOT_KEY_HASH,
-  VERSION,
-  ZKPASSPORT_ANDROID_APP_ID_HASH,
-  ZKPASSPORT_IOS_APP_ID_HASH
-} from "./chunk-B57NBZWJ.js";
-export {
-  APPLE_APP_ATTEST_ROOT_KEY_HASH,
-  DEFAULT_DATE_VALUE,
-  DEFAULT_VALIDITY,
-  GOOGLE_APP_ATTEST_RSA_ROOT_KEY_HASH,
-  VERSION,
-  ZKPASSPORT_ANDROID_APP_ID_HASH,
-  ZKPASSPORT_IOS_APP_ID_HASH
-};

package/dist/esm/logger.d.ts

@@ -1,14 +0,0 @@
-declare const customLogger: {
-    debug: (message: string, ...args: any[]) => void;
-    info: (message: string, ...args: any[]) => void;
-    warn: (message: string, ...args: any[]) => void;
-    error: (message: string, ...args: any[]) => void;
-};
-declare const noLogger: {
-    debug: (..._: any[]) => void;
-    info: (..._: any[]) => void;
-    warn: (..._: any[]) => void;
-    error: (..._: any[]) => void;
-};
-
-export { customLogger, noLogger };

package/dist/esm/logger.js

@@ -1,8 +0,0 @@
-import {
-  customLogger,
-  noLogger
-} from "./chunk-AFLQN3AC.js";
-export {
-  customLogger,
-  noLogger
-};

package/dist/esm/public-input-checker.d.ts

@@ -1,70 +0,0 @@
-import { ProofResult, QueryResult, ProofData, BoundData, SanctionsCommittedInputs, SanctionsBuilder, FacematchCommittedInputs, NullifierType } from '@zkpassport/utils';
-import { QueryResultErrors } from './types.js';
-
-declare class PublicInputChecker {
-    static checkDiscloseBytesPublicInputs(proof: ProofResult, queryResult: QueryResult): {
-        isCorrect: boolean;
-        queryResultErrors: Partial<QueryResultErrors>;
-    };
-    static checkAgePublicInputs(proof: ProofResult, queryResult: QueryResult): {
-        isCorrect: boolean;
-        queryResultErrors: Partial<QueryResultErrors>;
-    };
-    static checkBirthdatePublicInputs(proof: ProofResult, queryResult: QueryResult): {
-        isCorrect: boolean;
-        queryResultErrors: Partial<QueryResultErrors>;
-    };
-    static checkExpiryDatePublicInputs(proof: ProofResult, queryResult: QueryResult): {
-        isCorrect: boolean;
-        queryResultErrors: Partial<QueryResultErrors>;
-    };
-    static checkNationalityExclusionPublicInputs(queryResult: QueryResult, countryList: string[]): {
-        isCorrect: boolean;
-        queryResultErrors: Partial<QueryResultErrors>;
-    };
-    static checkIssuingCountryExclusionPublicInputs(queryResult: QueryResult, countryList: string[]): {
-        isCorrect: boolean;
-        queryResultErrors: Partial<QueryResultErrors>;
-    };
-    static checkNationalityInclusionPublicInputs(queryResult: QueryResult, countryList: string[]): {
-        isCorrect: boolean;
-        queryResultErrors: Partial<QueryResultErrors>;
-    };
-    static checkIssuingCountryInclusionPublicInputs(queryResult: QueryResult, countryList: string[]): {
-        isCorrect: boolean;
-        queryResultErrors: Partial<QueryResultErrors>;
-    };
-    static checkScopeFromDisclosureProof(domain: string, proofData: ProofData, queryResultErrors: Partial<QueryResultErrors>, key: string, scope?: string): {
-        isCorrect: boolean;
-        queryResultErrors: Partial<QueryResultErrors>;
-    };
-    static checkCertificateRegistryRoot(root: string, queryResultErrors: any, outer?: boolean): Promise<{
-        isCorrect: boolean;
-        queryResultErrors: any;
-    }>;
-    static checkCircuitRegistryRoot(root: string, queryResultErrors: any): Promise<{
-        isCorrect: boolean;
-        queryResultErrors: any;
-    }>;
-    static checkBindPublicInputs(queryResult: QueryResult, boundData: BoundData): {
-        isCorrect: boolean;
-        queryResultErrors: Partial<QueryResultErrors>;
-    };
-    static checkSanctionsExclusionPublicInputs(queryResult: QueryResult, sanctionsCommittedInputs: SanctionsCommittedInputs, sanctionsBuilder: SanctionsBuilder): Promise<{
-        isCorrect: boolean;
-        queryResultErrors: Partial<QueryResultErrors>;
-    }>;
-    static checkFacematchPublicInputs(queryResult: QueryResult, facematchCommittedInputs: FacematchCommittedInputs): Promise<{
-        isCorrect: boolean;
-        queryResultErrors: Partial<QueryResultErrors>;
-    }>;
-    private static checkCurrentDate;
-    static checkPublicInputs(domain: string, proofs: Array<ProofResult>, queryResult: QueryResult, validity?: number, scope?: string): Promise<{
-        isCorrect: boolean;
-        uniqueIdentifier: string | undefined;
-        uniqueIdentifierType: NullifierType | undefined;
-        queryResultErrors: Partial<QueryResultErrors>;
-    }>;
-}
-
-export { PublicInputChecker };

package/dist/esm/public-input-checker.js

@@ -1,7 +0,0 @@
-import {
-  PublicInputChecker
-} from "./chunk-N322IQZC.js";
-import "./chunk-B57NBZWJ.js";
-export {
-  PublicInputChecker
-};

package/dist/esm/solidity-verifier.d.ts

@@ -1,32 +0,0 @@
-import { SupportedChain, ProofResult } from '@zkpassport/utils';
-import { SolidityVerifierParameters } from './types.js';
-
-declare class SolidityVerifier {
-    static getDetails(network: SupportedChain): {
-        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;
-            }[];
-        }[];
-    };
-    static getParameters({ proof, validityPeriodInSeconds, domain, scope, devMode, }: {
-        proof: ProofResult;
-        validityPeriodInSeconds?: number;
-        domain: string;
-        scope?: string;
-        devMode?: boolean;
-    }): SolidityVerifierParameters;
-}
-
-export { SolidityVerifier };

package/dist/esm/solidity-verifier.js

@@ -1,7 +0,0 @@
-import {
-  SolidityVerifier
-} from "./chunk-KUTKOI3P.js";
-import "./chunk-B57NBZWJ.js";
-export {
-  SolidityVerifier
-};

package/dist/esm/types.d.ts

@@ -1,208 +0,0 @@
-import { IDCredential, IDCredentialValue, NumericalIDCredential, DisclosableIDCredential, BoundData, SanctionsCountries, SanctionsLists, FacematchMode, ProofResult, QueryResult } from '@zkpassport/utils';
-
-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>;
-        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 SolidityProofVerificationData = {
-    vkeyHash: string;
-    proof: string;
-    publicInputs: string[];
-};
-type SolidityCommitments = {
-    committedInputs: string;
-};
-type SolidityServiceConfig = {
-    validityPeriodInSeconds: number;
-    domain: string;
-    scope: string;
-    devMode: boolean;
-};
-type SolidityVerifierParameters = {
-    proofVerificationData: SolidityProofVerificationData;
-    commitments: SolidityCommitments;
-    serviceConfig: SolidityServiceConfig;
-};
-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 id of the request.
-     */
-    requestId: 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 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.
-     */
-    onResult: (callback: (response: {
-        uniqueIdentifier: string | undefined;
-        verified: boolean;
-        result: QueryResult;
-        queryResultErrors?: Partial<QueryResultErrors>;
-    }) => 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 QueryBuilder = {
-    /**
-     * 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: (key: keyof BoundData, value: BoundData[keyof BoundData]) => 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;
-    /**
-     * This feature is not available yet in the public release of the app.
-     * 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 "regular".
-     * @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;
-    /**
-     * 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: () => QueryBuilderResult;
-};
-
-export type { QueryBuilder, QueryBuilderResult, QueryResultError, QueryResultErrors, SolidityCommitments, SolidityProofVerificationData, SolidityServiceConfig, SolidityVerifierParameters };

package/dist/esm/types.js

@@ -1 +0,0 @@
-import "./chunk-6F4PWJZI.js";