@zkpassport/sdk 0.7.1 → 0.8.0-beta.2

package/dist/cjs/index.d.cts

@@ -1,4 +1,4 @@
-import { IDCredential, ProofResult, QueryResult, IDCredentialValue, NumericalIDCredential, DisclosableIDCredential, BoundData, ProofMode, SupportedChain } from '@zkpassport/utils';
+import { IDCredential, ProofResult, QueryResult, IDCredentialValue, NumericalIDCredential, DisclosableIDCredential, BoundData, SanctionsCountries, SanctionsLists, ProofMode, SupportedChain } from '@zkpassport/utils';
 export * from '@zkpassport/utils';
 export { ASEAN_COUNTRIES, EEA_COUNTRIES, EU_COUNTRIES, MERCOSUR_COUNTRIES, SANCTIONED_COUNTRIES, SCHENGEN_COUNTRIES } from '@zkpassport/utils';
 
@@ -8,7 +8,7 @@ type QueryResultError<T> = {
     message: string;
 };
 type QueryResultErrors = {
-    [key in IDCredential | "sig_check_dsc" | "sig_check_id_data" | "data_check_integrity" | "outer" | "disclose" | "bind"]: {
+    [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>;
@@ -29,7 +29,7 @@ type SolidityVerifierParameters = {
     publicInputs: string[];
     committedInputs: string;
     committedInputCounts: number[];
-    validityPeriodInDays: number;
+    validityPeriodInSeconds: number;
     domain: string;
     scope: string;
     devMode: boolean;
@@ -81,7 +81,7 @@ type QueryBuilderResult = {
         uniqueIdentifier: string | undefined;
         verified: boolean;
         result: QueryResult;
-        queryResultErrors?: QueryResultErrors;
+        queryResultErrors?: Partial<QueryResultErrors>;
     }) => void) => void;
     /**
      * Called when the user has rejected the request.
@@ -157,6 +157,22 @@ type QueryBuilder = {
      * @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;
+    /**
+     * 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.
+     */
     /**
      * Builds the request.
      *
@@ -185,6 +201,7 @@ declare class ZKPassport {
     private onResultCallbacks;
     private onRejectCallbacks;
     private onErrorCallbacks;
+    private normalizeDomain;
     constructor(_domain?: string);
     private handleResult;
     private setExpectedProofCount;
@@ -201,7 +218,7 @@ 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 validity How many days ago should have the ID been last scanned by the user?
+     * @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.
      */
@@ -233,12 +250,13 @@ declare class ZKPassport {
     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.
      * @param queryResult The query result to verify against
-     * @param validity How many days ago should have the ID been last scanned by the user?
+     * @param validity How many seconds ago the proof checking the expiry date of the ID should have been generated
      * @param scope Scope this request to a specific use case
      * @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.
@@ -256,7 +274,7 @@ declare class ZKPassport {
     }): Promise<{
         uniqueIdentifier: string | undefined;
         verified: boolean;
-        queryResultErrors?: QueryResultErrors;
+        queryResultErrors?: Partial<QueryResultErrors>;
     }>;
     getSolidityVerifierDetails(network: SupportedChain): {
         address: `0x${string}`;
@@ -276,9 +294,9 @@ declare class ZKPassport {
             }[];
         }[];
     };
-    getSolidityVerifierParameters({ proof, validityPeriodInDays, domain, scope, devMode, }: {
+    getSolidityVerifierParameters({ proof, validityPeriodInSeconds, domain, scope, devMode, }: {
         proof: ProofResult;
-        validityPeriodInDays?: number;
+        validityPeriodInSeconds?: number;
         domain?: string;
         scope?: string;
         devMode?: boolean;

package/dist/esm/index.d.ts

@@ -1,4 +1,4 @@
-import { IDCredential, ProofResult, QueryResult, IDCredentialValue, NumericalIDCredential, DisclosableIDCredential, BoundData, ProofMode, SupportedChain } from '@zkpassport/utils';
+import { IDCredential, ProofResult, QueryResult, IDCredentialValue, NumericalIDCredential, DisclosableIDCredential, BoundData, SanctionsCountries, SanctionsLists, ProofMode, SupportedChain } from '@zkpassport/utils';
 export * from '@zkpassport/utils';
 export { ASEAN_COUNTRIES, EEA_COUNTRIES, EU_COUNTRIES, MERCOSUR_COUNTRIES, SANCTIONED_COUNTRIES, SCHENGEN_COUNTRIES } from '@zkpassport/utils';
 
@@ -8,7 +8,7 @@ type QueryResultError<T> = {
     message: string;
 };
 type QueryResultErrors = {
-    [key in IDCredential | "sig_check_dsc" | "sig_check_id_data" | "data_check_integrity" | "outer" | "disclose" | "bind"]: {
+    [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>;
@@ -29,7 +29,7 @@ type SolidityVerifierParameters = {
     publicInputs: string[];
     committedInputs: string;
     committedInputCounts: number[];
-    validityPeriodInDays: number;
+    validityPeriodInSeconds: number;
     domain: string;
     scope: string;
     devMode: boolean;
@@ -81,7 +81,7 @@ type QueryBuilderResult = {
         uniqueIdentifier: string | undefined;
         verified: boolean;
         result: QueryResult;
-        queryResultErrors?: QueryResultErrors;
+        queryResultErrors?: Partial<QueryResultErrors>;
     }) => void) => void;
     /**
      * Called when the user has rejected the request.
@@ -157,6 +157,22 @@ type QueryBuilder = {
      * @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;
+    /**
+     * 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.
+     */
     /**
      * Builds the request.
      *
@@ -185,6 +201,7 @@ declare class ZKPassport {
     private onResultCallbacks;
     private onRejectCallbacks;
     private onErrorCallbacks;
+    private normalizeDomain;
     constructor(_domain?: string);
     private handleResult;
     private setExpectedProofCount;
@@ -201,7 +218,7 @@ 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 validity How many days ago should have the ID been last scanned by the user?
+     * @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.
      */
@@ -233,12 +250,13 @@ declare class ZKPassport {
     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.
      * @param queryResult The query result to verify against
-     * @param validity How many days ago should have the ID been last scanned by the user?
+     * @param validity How many seconds ago the proof checking the expiry date of the ID should have been generated
      * @param scope Scope this request to a specific use case
      * @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.
@@ -256,7 +274,7 @@ declare class ZKPassport {
     }): Promise<{
         uniqueIdentifier: string | undefined;
         verified: boolean;
-        queryResultErrors?: QueryResultErrors;
+        queryResultErrors?: Partial<QueryResultErrors>;
     }>;
     getSolidityVerifierDetails(network: SupportedChain): {
         address: `0x${string}`;
@@ -276,9 +294,9 @@ declare class ZKPassport {
             }[];
         }[];
     };
-    getSolidityVerifierParameters({ proof, validityPeriodInDays, domain, scope, devMode, }: {
+    getSolidityVerifierParameters({ proof, validityPeriodInSeconds, domain, scope, devMode, }: {
         proof: ProofResult;
-        validityPeriodInDays?: number;
+        validityPeriodInSeconds?: number;
         domain?: string;
         scope?: string;
         devMode?: boolean;