@zkpassport/sdk 0.14.2 → 0.15.0-alpha.1

package/dist/cjs/index.d.cts

@@ -40,6 +40,23 @@ type SolidityVerifierParameters = {
     committedInputs: string;
     serviceConfig: SolidityServiceConfig;
 };
+type Policy = {
+    id: string;
+    version: number;
+    name: string;
+    purpose: string;
+    projectId: string | null;
+    query: Query;
+};
+type DashboardConfig = {
+    project: {
+        name: string;
+        domain: string;
+        logoUrl: string | null;
+        allowedOrigins: string[];
+    };
+    policies: Policy[];
+};
 type QueryBuilderResult = {
     /**
      * The URL of the request.
@@ -56,6 +73,10 @@ type QueryBuilderResult = {
      * The id of the request.
      */
     requestId: string;
+    /**
+     * The id of the policy used to build the request, if one was provided.
+     */
+    policy?: string;
     /**
      * Called when the user has scanned the QR code or clicked the link to the request.
      *
@@ -92,6 +113,8 @@ type QueryBuilderResult = {
         verified: boolean;
         result: QueryResult;
         queryResultErrors?: Partial<QueryResultErrors>;
+        proofs: ProofResult[];
+        sdkInstance: ZKPassport;
     }) => void) => void;
     /**
      * Called when the user has rejected the request.
@@ -203,6 +226,13 @@ type QueryBuilder<T extends "online" | "offline" = "online"> = {
      * Best for lower security requirements that requires fast verification such as age verification.
      */
     facematch: (mode?: FacematchMode) => QueryBuilder;
+    /**
+     * Applies an immutable policy fetched from the dashboard. The policy's query,
+     * purpose and scope are locked; combining with builder methods or calling
+     * twice throws.
+     * @param id The policy id (e.g. `'pol_xyz'`).
+     */
+    policy: (id: string) => QueryBuilder<T>;
     /**
      * Builds the request.
      *
@@ -215,15 +245,22 @@ type QueryBuilder<T extends "online" | "offline" = "online"> = {
 
 declare class ZKPassport {
     private domain;
+    private domainProvided;
+    private disableProofStorage;
     private topicToConfig;
     private topicToLocalConfig;
     private topicToPublicKey;
     private topicToBridge;
     private topicToRequestReceived;
     private topicToService;
+    private topicToCallerPurpose;
     private topicToProofs;
     private topicToFailedProofCount;
     private topicToResults;
+    private topicToPolicy;
+    private dashboardConfig;
+    private dashboardConfigPromise;
+    private dashboardConfigError;
     private onRequestReceivedCallbacks;
     private onGeneratingProofCallbacks;
     private onBridgeConnectCallbacks;
@@ -232,7 +269,9 @@ declare class ZKPassport {
     private onRejectCallbacks;
     private onErrorCallbacks;
     private normalizeDomain;
-    constructor(_domain?: string);
+    constructor(_domain?: string, options?: {
+        disableProofStorage?: boolean;
+    });
     private handleResult;
     /**
      * @notice Handle an encrypted message.
@@ -240,22 +279,29 @@ declare class ZKPassport {
      * @param outerRequest The outer request.
      */
     private handleEncryptedMessage;
+    private assertNotPolicyLocked;
     private getZkPassportRequest;
-    /**
-     * @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
+    private getDashboardConfig;
+    private fetchDashboardConfig;
+    private findPolicy;
+    private assertCanApplyPolicy;
+    /**
+     * @notice Create a new request. To apply a policy, chain `.policy('<id>')` on
+     * the returned builder; a policy locks the query and scope.
+     * @param name Your service name. Defaults to the dashboard branding, then the domain.
+     * @param logo Your service logo. Defaults to the dashboard branding.
+     * @param purpose Explanation shown to the user. Defaults to the policy's purpose (if any), then a generic message.
+     * @param scope Use-case scope (drives the nullifier). Defaults to the domain. Locked by `.policy()` (to `<id>:<version>`).
      * @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 mode The proof mode (e.g. "fast" / "compressed").
      * @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, projectID, mode, validity, devMode, uniqueIdentifierType, oprfKeyId, topicOverride, keyPairOverride, cloudProverUrl, bridgeUrl, }: {
-        name: string;
-        logo: string;
-        purpose: string;
+        name?: string;
+        logo?: string;
+        purpose?: string;
         scope?: string;
         mode?: ProofMode;
         projectID?: string;
@@ -351,4 +397,4 @@ declare class ZKPassport {
     clearAllRequests(): void;
 }
 
-export { type OfflineQueryBuilderResult, type QueryBuilder, type QueryBuilderResult, type QueryResultError, type QueryResultErrors, type SolidityProofVerificationData, type SolidityServiceConfig, type SolidityVerifierParameters, ZKPassport };
+export { type DashboardConfig, type OfflineQueryBuilderResult, type Policy, type QueryBuilder, type QueryBuilderResult, type QueryResultError, type QueryResultErrors, type SolidityProofVerificationData, type SolidityServiceConfig, type SolidityVerifierParameters, ZKPassport };

package/dist/esm/index.d.ts

@@ -40,6 +40,23 @@ type SolidityVerifierParameters = {
     committedInputs: string;
     serviceConfig: SolidityServiceConfig;
 };
+type Policy = {
+    id: string;
+    version: number;
+    name: string;
+    purpose: string;
+    projectId: string | null;
+    query: Query;
+};
+type DashboardConfig = {
+    project: {
+        name: string;
+        domain: string;
+        logoUrl: string | null;
+        allowedOrigins: string[];
+    };
+    policies: Policy[];
+};
 type QueryBuilderResult = {
     /**
      * The URL of the request.
@@ -56,6 +73,10 @@ type QueryBuilderResult = {
      * The id of the request.
      */
     requestId: string;
+    /**
+     * The id of the policy used to build the request, if one was provided.
+     */
+    policy?: string;
     /**
      * Called when the user has scanned the QR code or clicked the link to the request.
      *
@@ -92,6 +113,8 @@ type QueryBuilderResult = {
         verified: boolean;
         result: QueryResult;
         queryResultErrors?: Partial<QueryResultErrors>;
+        proofs: ProofResult[];
+        sdkInstance: ZKPassport;
     }) => void) => void;
     /**
      * Called when the user has rejected the request.
@@ -203,6 +226,13 @@ type QueryBuilder<T extends "online" | "offline" = "online"> = {
      * Best for lower security requirements that requires fast verification such as age verification.
      */
     facematch: (mode?: FacematchMode) => QueryBuilder;
+    /**
+     * Applies an immutable policy fetched from the dashboard. The policy's query,
+     * purpose and scope are locked; combining with builder methods or calling
+     * twice throws.
+     * @param id The policy id (e.g. `'pol_xyz'`).
+     */
+    policy: (id: string) => QueryBuilder<T>;
     /**
      * Builds the request.
      *
@@ -215,15 +245,22 @@ type QueryBuilder<T extends "online" | "offline" = "online"> = {
 
 declare class ZKPassport {
     private domain;
+    private domainProvided;
+    private disableProofStorage;
     private topicToConfig;
     private topicToLocalConfig;
     private topicToPublicKey;
     private topicToBridge;
     private topicToRequestReceived;
     private topicToService;
+    private topicToCallerPurpose;
     private topicToProofs;
     private topicToFailedProofCount;
     private topicToResults;
+    private topicToPolicy;
+    private dashboardConfig;
+    private dashboardConfigPromise;
+    private dashboardConfigError;
     private onRequestReceivedCallbacks;
     private onGeneratingProofCallbacks;
     private onBridgeConnectCallbacks;
@@ -232,7 +269,9 @@ declare class ZKPassport {
     private onRejectCallbacks;
     private onErrorCallbacks;
     private normalizeDomain;
-    constructor(_domain?: string);
+    constructor(_domain?: string, options?: {
+        disableProofStorage?: boolean;
+    });
     private handleResult;
     /**
      * @notice Handle an encrypted message.
@@ -240,22 +279,29 @@ declare class ZKPassport {
      * @param outerRequest The outer request.
      */
     private handleEncryptedMessage;
+    private assertNotPolicyLocked;
     private getZkPassportRequest;
-    /**
-     * @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
+    private getDashboardConfig;
+    private fetchDashboardConfig;
+    private findPolicy;
+    private assertCanApplyPolicy;
+    /**
+     * @notice Create a new request. To apply a policy, chain `.policy('<id>')` on
+     * the returned builder; a policy locks the query and scope.
+     * @param name Your service name. Defaults to the dashboard branding, then the domain.
+     * @param logo Your service logo. Defaults to the dashboard branding.
+     * @param purpose Explanation shown to the user. Defaults to the policy's purpose (if any), then a generic message.
+     * @param scope Use-case scope (drives the nullifier). Defaults to the domain. Locked by `.policy()` (to `<id>:<version>`).
      * @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 mode The proof mode (e.g. "fast" / "compressed").
      * @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, projectID, mode, validity, devMode, uniqueIdentifierType, oprfKeyId, topicOverride, keyPairOverride, cloudProverUrl, bridgeUrl, }: {
-        name: string;
-        logo: string;
-        purpose: string;
+        name?: string;
+        logo?: string;
+        purpose?: string;
         scope?: string;
         mode?: ProofMode;
         projectID?: string;
@@ -351,4 +397,4 @@ declare class ZKPassport {
     clearAllRequests(): void;
 }
 
-export { type OfflineQueryBuilderResult, type QueryBuilder, type QueryBuilderResult, type QueryResultError, type QueryResultErrors, type SolidityProofVerificationData, type SolidityServiceConfig, type SolidityVerifierParameters, ZKPassport };
+export { type DashboardConfig, type OfflineQueryBuilderResult, type Policy, type QueryBuilder, type QueryBuilderResult, type QueryResultError, type QueryResultErrors, type SolidityProofVerificationData, type SolidityServiceConfig, type SolidityVerifierParameters, ZKPassport };