@zkpassport/sdk 0.2.8 → 0.2.9

package/dist/esm/index.d.ts

@@ -1,4 +1,24 @@
 import { type DisclosableIDCredential, type IDCredential, type IDCredentialValue, type NumericalIDCredential, type ProofResult, type QueryResult } from "@zkpassport/utils";
+export type QueryResultError<T> = {
+    expected?: T;
+    received?: T;
+    message: string;
+};
+export type QueryResultErrors = {
+    [key in IDCredential | "sig_check_dsc" | "sig_check_id_data" | "data_check_integrity" | "disclose"]: {
+        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>;
+    };
+};
 export type * from "@zkpassport/utils";
 export { SANCTIONED_COUNTRIES, EU_COUNTRIES, EEA_COUNTRIES, SCHENGEN_COUNTRIES, ASEAN_COUNTRIES, MERCOSUR_COUNTRIES, } from "@zkpassport/utils";
 export type QueryBuilderResult = {
@@ -47,6 +67,7 @@ export type QueryBuilderResult = {
         uniqueIdentifier: string | undefined;
         verified: boolean;
         result: QueryResult;
+        queryResultErrors?: QueryResultErrors;
     }) => void) => void;
     /**
      * Called when the user has rejected the request.
@@ -136,6 +157,7 @@ export declare class ZKPassport {
     private topicToService;
     private topicToProofs;
     private topicToExpectedProofCount;
+    private topicToFailedProofCount;
     private topicToResults;
     private onRequestReceivedCallbacks;
     private onGeneratingProofCallbacks;
@@ -187,6 +209,7 @@ export declare class ZKPassport {
     verify(requestId: string, proofs?: Array<ProofResult>, queryResult?: QueryResult): Promise<{
         uniqueIdentifier: string | undefined;
         verified: boolean;
+        queryResultErrors?: QueryResultErrors;
     }>;
     /**
      * @notice Returns the URL of the request.
@@ -199,4 +222,8 @@ export declare class ZKPassport {
      * @param requestId The request ID.
      */
     cancelRequest(requestId: string): void;
+    /**
+     * @notice Clears all requests.
+     */
+    clearAllRequests(): void;
 }