@zkpassport/sdk 0.17.0-beta.2 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -252,9 +252,9 @@ type QueryBuilder<T extends "online" | "offline" = "online"> = {
252
252
  facematch: (mode?: FacematchMode) => QueryBuilder;
253
253
  raw: (query: Query) => QueryBuilder<T>;
254
254
  /**
255
- * Applies an immutable policy fetched from the dashboard. The policy's query,
256
- * purpose and scope are locked; combining with builder methods (except
257
- * `.bind()`, which may follow it) or calling twice throws.
255
+ * Applies a policy fetched from the dashboard. The policy's query is locked, and its
256
+ * purpose and scope are used unless the request sets its own. Combining with builder
257
+ * methods (except `.bind()`, which may follow it) or calling twice throws.
258
258
  * @param id The policy id (e.g. `'pol_xyz'`).
259
259
  */
260
260
  policy: (id: string) => QueryBuilder<T>;
@@ -318,11 +318,11 @@ declare class ZKPassport {
318
318
  private assertCanApplyPolicy;
319
319
  /**
320
320
  * @notice Create a new request. To apply a policy, chain `.policy('<id>')` on
321
- * the returned builder; a policy locks the query and scope.
321
+ * the returned builder; a policy locks the query.
322
322
  * @param name Your service name. Defaults to the dashboard branding, then the domain.
323
323
  * @param logo Your service logo. Defaults to the dashboard branding.
324
324
  * @param purpose Explanation shown to the user. Defaults to the policy's purpose (if any), then a generic message.
325
- * @param scope Use-case scope (drives the nullifier). Defaults to the domain. Locked by `.policy()` (to the policy id).
325
+ * @param scope Use-case scope (drives the nullifier). Defaults to the policy id (if any), then the domain.
326
326
  * @param projectID The project ID of your service
327
327
  * @param validity How many seconds ago the proof checking the expiry date of the ID should have been generated
328
328
  * @param mode The proof mode (e.g. "fast" / "compressed").