@zkpassport/sdk 0.8.7 → 0.9.0-beta.1

package/dist/cjs/index.d.cts

@@ -1,195 +1,9 @@
-import { IDCredential, ProofResult, QueryResult, IDCredentialValue, NumericalIDCredential, DisclosableIDCredential, BoundData, SanctionsCountries, SanctionsLists, FacematchMode, ProofMode, SupportedChain } from '@zkpassport/utils';
+import { QueryBuilder, QueryResultErrors, SolidityVerifierParameters } from './types.cjs';
+export { QueryBuilderResult, QueryResultError } from './types.cjs';
+import { ProofMode, ProofResult, QueryResult, NullifierType, SupportedChain } from '@zkpassport/utils';
 export * from '@zkpassport/utils';
 export { ASEAN_COUNTRIES, EEA_COUNTRIES, EU_COUNTRIES, MERCOSUR_COUNTRIES, SANCTIONED_COUNTRIES, SCHENGEN_COUNTRIES } 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 SolidityVerifierParameters = {
-    vkeyHash: string;
-    proof: string;
-    publicInputs: string[];
-    committedInputs: string;
-    committedInputCounts: number[];
-    validityPeriodInSeconds: number;
-    domain: string;
-    scope: string;
-    devMode: 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 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"
-     */
-    sanctions: (countries?: SanctionsCountries, lists?: SanctionsLists) => 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;
-};
 declare class ZKPassport {
     private domain;
     private topicToConfig;
@@ -226,16 +40,18 @@ declare class ZKPassport {
      * @param logo The logo of your service
      * @param purpose To explain what you want to do with the user's data
      * @param scope Scope this request to a specific use case
+     * @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 devMode Whether to enable dev mode. This will allow you to verify mock proofs (i.e. from ZKR)
      * @returns The query builder object.
      */
-    request({ name, logo, purpose, scope, mode, validity, devMode, topicOverride, keyPairOverride, cloudProverUrl, bridgeUrl, }: {
+    request({ name, logo, purpose, scope, projectID, mode, validity, devMode, topicOverride, keyPairOverride, cloudProverUrl, bridgeUrl, }: {
         name: string;
         logo: string;
         purpose: string;
         scope?: string;
         mode?: ProofMode;
+        projectID?: string;
         validity?: number;
         devMode?: boolean;
         topicOverride?: string;
@@ -246,20 +62,6 @@ declare class ZKPassport {
         cloudProverUrl?: string;
         bridgeUrl?: string;
     }): Promise<QueryBuilder>;
-    private checkDiscloseBytesPublicInputs;
-    private checkAgePublicInputs;
-    private checkBirthdatePublicInputs;
-    private checkExpiryDatePublicInputs;
-    private checkNationalityExclusionPublicInputs;
-    private checkIssuingCountryExclusionPublicInputs;
-    private checkNationalityInclusionPublicInputs;
-    private checkIssuingCountryInclusionPublicInputs;
-    private checkScopeFromDisclosureProof;
-    private checkCertificateRegistryRoot;
-    private checkCircuitRegistryRoot;
-    private checkBindPublicInputs;
-    private checkSanctionsExclusionPublicInputs;
-    private checkPublicInputs;
     /**
      * @notice Verify the proofs received from the mobile app.
      * @param proofs The proofs to verify.
@@ -281,6 +83,7 @@ declare class ZKPassport {
         writingDirectory?: string;
     }): Promise<{
         uniqueIdentifier: string | undefined;
+        uniqueIdentifierType: NullifierType | undefined;
         verified: boolean;
         queryResultErrors?: Partial<QueryResultErrors>;
     }>;
@@ -327,4 +130,4 @@ declare class ZKPassport {
     clearAllRequests(): void;
 }
 
-export { type QueryBuilder, type QueryBuilderResult, type QueryResultError, type QueryResultErrors, type SolidityVerifierParameters, ZKPassport };
+export { QueryBuilder, QueryResultErrors, SolidityVerifierParameters, ZKPassport };