@zkpassport/sdk 0.2.7 → 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.
@@ -128,6 +149,7 @@ export type QueryBuilder = {
 export declare class ZKPassport {
     private domain;
     private topicToConfig;
+    private topicToLocalConfig;
     private topicToKeyPair;
     private topicToWebSocketClient;
     private topicToSharedSecret;
@@ -135,6 +157,7 @@ export declare class ZKPassport {
     private topicToService;
     private topicToProofs;
     private topicToExpectedProofCount;
+    private topicToFailedProofCount;
     private topicToResults;
     private onRequestReceivedCallbacks;
     private onGeneratingProofCallbacks;
@@ -154,14 +177,20 @@ export declare class ZKPassport {
     private handleEncryptedMessage;
     private getZkPassportRequest;
     /**
-     * @notice Create a new request.
+     * @notice Create a new request
+     * @param name Your service name
+     * @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 validity How many days ago should have the ID been last scanned by the user?
      * @returns The query builder object.
      */
-    request({ name, logo, purpose, scope, topicOverride, keyPairOverride, }: {
+    request({ name, logo, purpose, scope, validity, topicOverride, keyPairOverride, }: {
         name: string;
         logo: string;
         purpose: string;
         scope?: string;
+        validity?: number;
         topicOverride?: string;
         keyPairOverride?: {
             privateKey: Uint8Array;
@@ -180,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.
@@ -192,4 +222,8 @@ export declare class ZKPassport {
      * @param requestId The request ID.
      */
     cancelRequest(requestId: string): void;
+    /**
+     * @notice Clears all requests.
+     */
+    clearAllRequests(): void;
 }