@zk-email/sdk 0.0.90 → 0.0.92

package/dist/zk-email-sdk.cjs.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const e=require("./index-C8FLbH7o.js");exports.Blueprint=e.Blueprint;exports.Proof=e.Proof;Object.defineProperty(exports,"ProofStatus",{enumerable:!0,get:()=>e.ProofStatus});Object.defineProperty(exports,"Status",{enumerable:!0,get:()=>e.Status});Object.defineProperty(exports,"ZkFramework",{enumerable:!0,get:()=>e.ZkFramework});exports.ZodError=e.ZodError;exports.default=e.index;exports.generateProofInputs=e.generateProofInputs;exports.getDKIMSelector=e.getDKIMSelector;exports.getLoginWithGithubUrl=e.getLoginWithGithubUrl;exports.parseEmail=e.parseEmail;exports.startJsonFileDownload=e.startJsonFileDownload;exports.testBlueprint=e.testBlueprint;exports.testDecomposedRegex=e.testDecomposedRegex;
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const e=require("./index-DM81s2-Y.js");exports.Blueprint=e.Blueprint;exports.Proof=e.Proof;Object.defineProperty(exports,"ProofStatus",{enumerable:!0,get:()=>e.ProofStatus});Object.defineProperty(exports,"Status",{enumerable:!0,get:()=>e.Status});Object.defineProperty(exports,"ZkFramework",{enumerable:!0,get:()=>e.ZkFramework});exports.ZodError=e.ZodError;exports.default=e.index;exports.generateProofInputs=e.generateProofInputs;exports.getDKIMSelector=e.getDKIMSelector;exports.getLoginWithGithubUrl=e.getLoginWithGithubUrl;exports.parseEmail=e.parseEmail;exports.startJsonFileDownload=e.startJsonFileDownload;exports.testBlueprint=e.testBlueprint;exports.testDecomposedRegex=e.testDecomposedRegex;
 //# sourceMappingURL=zk-email-sdk.cjs.js.map

package/dist/zk-email-sdk.es.js

@@ -1,4 +1,4 @@
-import { h as t, P as e, q as o, S as r, o as l, Z as n, f as i, l as p, k as u, n as f, p as g, j as m, m as d, t as P } from "./index-uNa-m4WB.mjs";
+import { h as t, P as e, q as o, S as r, o as l, Z as n, f as i, l as p, k as u, n as f, p as g, j as m, m as d, t as P } from "./index-CKBpDKzL.mjs";
 export {
   t as Blueprint,
   e as Proof,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zk-email/sdk",
-  "version": "0.0.90",
+  "version": "0.0.92",
   "description": "ZK Email SDK for TypeScript",
   "main": "./dist/index.js",
   "module": "./dist/zk-email-sdk.es.js",

package/NPM-README.md

@@ -1,70 +0,0 @@
-# ZKEmail SDK
-
-With the ZKEmail SDK you can create proofs about emails using blueprints. You can create blueprints with this
-SDK (documentation pending), or using our [registry](registry.zk.email).
-
-## Install
-
-The SDK works for all JavaScript environments. You can find
-examples for server-side (Node, Deno, Bun) and client-side (Vite, Next.js) usage [here](https://github.com/zkemail/sdk-ts-demo).
-
-To install run:
-
-```bash
-npm i @zk-email/sdk
-```
-
-## Create a blueprint
-
-Go to our [registry](registry.zk.email) and create a blueprint there. You can also create one with the SDK,
-we will provide the documentation for this shortly.
-
-## Generate a proof
-
-Initialize the SDK:
-
-```ts
-import zkeSdk from "@zk-email/sdk";
-const sdk = zkSdk();
-```
-
-Next, obtain the slug of the blueprint you want to create a proof for from our [registry](registry.zk.email).
-
-![Copy Slug](./assets/copy_slug.png)
-
-Use the slug to get the blueprint:
-
-```ts
-const blueprint = await sdk.getBlueprint("Bisht13/SuccinctZKResidencyInvite@v2");
-```
-
-Create a prover. Here you can define whether the proof should be generated remotely (faster)
-or in the browser (slower but private).
-Set `isLocal` to `true` for proving in the browser.
-
-```ts
-const prover = blueprint.createProver({ isLocal: true });
-```
-
-Now pass the email as a `string` to the prover to generate a proof.
-
-If your blueprint requires external inputs, pass them as a second argument.
-
-You can check out our [Next.js example](https://github.com/zkemail/sdk-ts-demo/tree/main/nextjs) to see how
-a user can locally upload an email file.
-
-```ts
-// 2. argument, externalInputs is only required if defined in the blueprint
-const proof = await prover.generateProof(emailStr, [
-  { name: "email", value: "a@b.de", maxLength: 50 },
-]);
-
-console.log("Proof data: ", proof.props.proofData);
-console.log("Public data: ", proof.props.publicData);
-```
-
-You can also verify the proof on chain. We currently use a contract deployed to Base Sepolia for this.
-
-```ts
-const isVerified = await blueprint.verifyProofOnChain(proof);
-```

package/dist/README.md

@@ -1,70 +0,0 @@
-# ZKEmail SDK
-
-With the ZKEmail SDK you can create proofs about emails using blueprints. You can create blueprints with this
-SDK (documentation pending), or using our [registry](registry.zk.email).
-
-## Install
-
-The SDK works for all JavaScript environments. You can find
-examples for server-side (Node, Deno, Bun) and client-side (Vite, Next.js) usage [here](https://github.com/zkemail/sdk-ts-demo).
-
-To install run:
-
-```bash
-npm i @zk-email/sdk
-```
-
-## Create a blueprint
-
-Go to our [registry](registry.zk.email) and create a blueprint there. You can also create one with the SDK,
-we will provide the documentation for this shortly.
-
-## Generate a proof
-
-Initialize the SDK:
-
-```ts
-import zkeSdk from "@zk-email/sdk";
-const sdk = zkSdk();
-```
-
-Next, obtain the slug of the blueprint you want to create a proof for from our [registry](registry.zk.email).
-
-![Copy Slug](./assets/copy_slug.png)
-
-Use the slug to get the blueprint:
-
-```ts
-const blueprint = await sdk.getBlueprint("Bisht13/SuccinctZKResidencyInvite@v2");
-```
-
-Create a prover. Here you can define whether the proof should be generated remotely (faster)
-or in the browser (slower but private).
-Set `isLocal` to `true` for proving in the browser.
-
-```ts
-const prover = blueprint.createProver({ isLocal: true });
-```
-
-Now pass the email as a `string` to the prover to generate a proof.
-
-If your blueprint requires external inputs, pass them as a second argument.
-
-You can check out our [Next.js example](https://github.com/zkemail/sdk-ts-demo/tree/main/nextjs) to see how
-a user can locally upload an email file.
-
-```ts
-// 2. argument, externalInputs is only required if defined in the blueprint
-const proof = await prover.generateProof(emailStr, [
-  { name: "email", value: "a@b.de", maxLength: 50 },
-]);
-
-console.log("Proof data: ", proof.props.proofData);
-console.log("Public data: ", proof.props.publicData);
-```
-
-You can also verify the proof on chain. We currently use a contract deployed to Base Sepolia for this.
-
-```ts
-const isVerified = await blueprint.verifyProofOnChain(proof);
-```