@zkproofport-app/sdk 0.2.10 → 0.2.12

package/dist/types.d.ts

@@ -1,16 +1,24 @@
 /**
  * ZKProofport SDK Types
  */
+import type { CircuitId } from './circuits';
 /**
- * Supported zero-knowledge circuit types.
+ * Zero-knowledge circuit identifiers.
  * Uses canonical circuit names matching Nargo.toml circuit definitions.
  *
+ * Alias of {@link CircuitId}, which is defined in `./circuits` — the single
+ * source of truth for circuit identifiers. Adding a circuit there widens this
+ * type automatically, so the two can never disagree.
+ *
+ * Note that this union includes circuits marked `planned` in
+ * `CIRCUIT_SUPPORT_STATUS`; being assignable is not a support guarantee.
+ *
  * @example
  * ```typescript
  * const circuit: CircuitType = 'coinbase_attestation';
  * ```
  */
-export type CircuitType = 'coinbase_attestation' | 'coinbase_country_attestation' | 'oidc_domain_attestation' | 'mdl_kr_ownership' | 'mdl_kr_age' | 'mdl_kr_region';
+export type CircuitType = CircuitId;
 /**
  * Proof request lifecycle status.
  *
@@ -199,7 +207,12 @@ export interface ProofRequest {
     dappIcon?: string;
     /**
      * Optional: which app the ZKProofport app should bring back to the foreground
-     * once it has finished. Not a URL — see {@link ProofportSDK.createRelayRequest}.
+     * once it has finished — a bare custom scheme such as `mydapp://`.
+     *
+     * Not a URL, and an https origin is not accepted: opening one launches a new
+     * browser tab on a fresh page instead of returning the user to the tab they
+     * started from. A web requester therefore has nothing valid to put here and
+     * omits the field. See {@link ProofportSDK.createRelayRequest}.
      */
     returnScheme?: string;
     /** Unix timestamp (ms) when request was created */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zkproofport-app/sdk",
-  "version": "0.2.10",
+  "version": "0.2.12",
   "description": "ZKProofport SDK for requesting zero-knowledge proofs from the ZKProofport mobile app and verifying them on-chain",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -10,7 +10,13 @@
       "import": "./dist/index.esm.js",
       "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
-    }
+    },
+    "./circuits": {
+      "types": "./dist/circuits.d.ts",
+      "import": "./dist/circuits.esm.js",
+      "require": "./dist/circuits.js"
+    },
+    "./package.json": "./package.json"
   },
   "files": [
     "dist",