@zk-email/sdk 0.0.86 → 0.0.88

package/dist/types/auth.d.ts

@@ -0,0 +1,3 @@
+import { Auth } from "./types/auth";
+export declare function getLoginWithGithubUrl(callbackUrl: string, githubClientId?: string): string;
+export declare function getTokenFromAuth(auth: Auth): Promise<string>;

package/dist/types/blueprint.d.ts

@@ -0,0 +1,132 @@
+import { Prover } from "./prover";
+import { BlueprintProps, ChunkedZkeyUrl, DownloadUrls, ListBlueprintsOptions, Status } from "./types/blueprint";
+import { Auth } from "./types/auth";
+import { Proof } from "./proof";
+import { blueprintFormSchema } from "./blueprintValidation";
+import { ProverOptions } from "./types";
+/**
+ * Represents a Regex Blueprint including the decomposed regex access to the circuit.
+ */
+export declare class Blueprint {
+    props: BlueprintProps;
+    auth?: Auth;
+    baseUrl: string;
+    stars: number;
+    static readonly formSchema: typeof blueprintFormSchema;
+    private lastCheckedStatus;
+    constructor(props: BlueprintProps, baseUrl: string, auth?: Auth);
+    addAuth(auth: Auth): void;
+    /**
+     * Fetches an existing RegexBlueprint from the database.
+     * @param {string} id - Id of the RegexBlueprint.
+     * @returns A promise that resolves to a new instance of RegexBlueprint.
+     */
+    static getBlueprintById(id: string, baseUrl: string, auth?: Auth): Promise<Blueprint>;
+    /**
+     * Fetches an existing RegexBlueprint by slug from the database.
+     * @param slug - Slug of the blueprint. Must include version, e.g. "slug:v1"
+     * @param version - Version of the slug.
+     * @returns A promise that resolves to a new instance of RegexBlueprint.
+     */
+    static getBlueprintBySlug(slug: string, baseUrl: string, auth?: Auth): Promise<Blueprint>;
+    private static responseToBlueprintProps;
+    private static blueprintPropsToRequest;
+    /**
+     * Submits a new RegexBlueprint to the registry as draft.
+     * This does not compile the circuits yet and you will still be able to make changes.
+     * @returns A promise. Once it resolves, `getId` can be called.
+     */
+    submitDraft(): Promise<void>;
+    /**
+     * Submits a new version of the RegexBlueprint to the registry as draft.
+     * This does not compile the circuits yet and you will still be able to make changes.
+     * @param newProps - The updated blueprint props.
+     * @returns A promise. Once it resolves, the current Blueprint will be replaced with the new one.
+     */
+    submitNewVersionDraft(newProps: BlueprintProps): Promise<void>;
+    /**
+     * Submits a new version of the blueprint. This will save the new blueprint version
+     * and start the compilation.
+     * This will also overwrite the current Blueprint with its new version, even if the last
+     * version was not compiled yet.
+     * @param newProps - The updated blueprint props.
+     */
+    submitNewVersion(newProps: BlueprintProps): Promise<void>;
+    /**
+     * Lists blueblueprints, only including the latest version per unique slug.
+     * @param options - Options to filter the blueprints by.
+     * @returns A promise. Once it resolves, `getId` can be called.
+     */
+    static listBlueprints(baseUrl: string, options?: ListBlueprintsOptions, auth?: Auth): Promise<Blueprint[]>;
+    /**
+     * Submits a blueprint. This will save the blueprint if it didn't exist before
+     * and start the compilation.
+     */
+    submit(): Promise<void>;
+    private _checkStatus;
+    /**
+     * Checks the status of blueprint.
+     * checkStatus can be used in a while(await checkStatus()) loop, since it will wait a fixed
+     * amount of time the second time you call it.
+     * @returns A promise with the Status.
+     */
+    checkStatus(): Promise<Status>;
+    /**
+     * Get the id of the blueprint.
+     * @returns The id of the blueprint. If it was not saved yet, return null.
+     */
+    getId(): string | null;
+    /**
+     * Returns a download link for the ZKeys of the blueprint.
+     * @returns The the url to download the ZKeys.
+     */
+    getZKeyDownloadLink(): Promise<DownloadUrls>;
+    /**
+     * Directly starts a download of the ZKeys in the browser.
+     * Must be called within a user action, like a button click.
+     */
+    startZKeyDownload(): Promise<void>;
+    /**
+     * Creates an instance of Prover with which you can create proofs.
+     * @returns An instance of Prover.
+     */
+    createProver(options?: ProverOptions): Prover;
+    /**
+     * Verifies a proof on chain.
+     * @param proof - The generated proof you want to verify.
+     * @returns A true if the verification was successfull, false if it failed.
+     */
+    verifyProofOnChain(proof: Proof): Promise<boolean>;
+    /**
+     * Returns a deep cloned version of the Blueprints props.
+     * This can be used to update properties and then to use them with createNewVersion.
+     * @param proof - The generated proof you want to verify.
+     * @returns A true if the verification was successfull, false if it failed.
+     */
+    getClonedProps(): BlueprintProps;
+    /**
+     * Returns true if the blueprint can be updated. A blueprint can be updated if the circuits
+     * haven't beed compiled yet, i.e. the status is not Done. The blueprint also must be saved
+     * already before it can be updated.
+     * @returns true if it can be updated
+     */
+    canUpdate(): boolean;
+    /**
+     * Updates an existing blueprint that is not compiled yet.
+     * @param newProps - The props the blueprint should be updated to.
+     * @returns a promise.
+     */
+    update(newProps: BlueprintProps): Promise<void>;
+    listAllVersions(): Promise<Blueprint[]>;
+    addStar(): Promise<number>;
+    removeStar(): Promise<number>;
+    getStars(): Promise<number>;
+    cancelCompilation(): Promise<void>;
+    delete(): Promise<void>;
+    getChunkedZkeyDownloadLinks(): Promise<ChunkedZkeyUrl[]>;
+    getWasmFileDownloadLink(): Promise<string>;
+    getVkeyFileDownloadLink(): Promise<string>;
+    getVkey(): Promise<string>;
+    getNumOfRemoteProofs(): Promise<number>;
+}
+export * from "./types/blueprint";

package/dist/types/blueprintValidation.d.ts

@@ -0,0 +1,82 @@
+import { z } from "zod";
+export declare const blueprintFormSchema: z.ZodObject<{
+    title: z.ZodString;
+    circuitName: z.ZodString;
+    description: z.ZodString;
+    emailQuery: z.ZodString;
+    ignoreBodyHashCheck: z.ZodBoolean;
+    shaPrecomputeSelector: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    senderDomain: z.ZodEffects<z.ZodString, string, string>;
+    emailBodyMaxLength: z.ZodEffects<z.ZodNumber, number, number>;
+    emailHeaderMaxLength: z.ZodDefault<z.ZodEffects<z.ZodNumber, number, number>>;
+    decomposedRegexes: z.ZodArray<z.ZodObject<{
+        name: z.ZodEffects<z.ZodString, string, string>;
+        maxLength: z.ZodDefault<z.ZodNumber>;
+        location: z.ZodString;
+        parts: z.ZodUnion<[z.ZodOptional<z.ZodEffects<z.ZodString, any[], string>>, z.ZodArray<z.ZodAny, "many">]>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        maxLength: number;
+        location: string;
+        parts?: any[] | undefined;
+    }, {
+        name: string;
+        location: string;
+        maxLength?: number | undefined;
+        parts?: string | any[] | undefined;
+    }>, "many">;
+    externalInputs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        maxLength: z.ZodDefault<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        maxLength: number;
+    }, {
+        name: string;
+        maxLength?: number | undefined;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    description: string;
+    title: string;
+    circuitName: string;
+    emailQuery: string;
+    ignoreBodyHashCheck: boolean;
+    senderDomain: string;
+    emailBodyMaxLength: number;
+    emailHeaderMaxLength: number;
+    decomposedRegexes: {
+        name: string;
+        maxLength: number;
+        location: string;
+        parts?: any[] | undefined;
+    }[];
+    shaPrecomputeSelector?: string | undefined;
+    externalInputs?: {
+        name: string;
+        maxLength: number;
+    }[] | undefined;
+}, {
+    description: string;
+    title: string;
+    circuitName: string;
+    emailQuery: string;
+    ignoreBodyHashCheck: boolean;
+    senderDomain: string;
+    emailBodyMaxLength: number;
+    decomposedRegexes: {
+        name: string;
+        location: string;
+        maxLength?: number | undefined;
+        parts?: string | any[] | undefined;
+    }[];
+    shaPrecomputeSelector?: string | undefined;
+    emailHeaderMaxLength?: number | undefined;
+    externalInputs?: {
+        name: string;
+        maxLength?: number | undefined;
+    }[] | undefined;
+}>;
+export type ValidationErrors = {
+    [K in keyof z.infer<typeof blueprintFormSchema>]?: string;
+};
+export { ZodError } from "zod";

package/dist/types/chain/index.d.ts

@@ -0,0 +1,2 @@
+import { Proof } from "../proof";
+export declare function verifyProofOnChain(proof: Proof): Promise<void>;

package/dist/types/index.d.ts

@@ -0,0 +1,24 @@
+import { Blueprint, BlueprintProps, ListBlueprintsOptions } from "./blueprint";
+import { Proof } from "./proof";
+import { SdkOptions } from "./types/sdk";
+export * from "./types/blueprint";
+export { Blueprint } from "./blueprint";
+export * from "./types/proof";
+export { Proof } from "./proof";
+export * from "./types/prover";
+export type { Auth } from "./types/auth";
+export type { ParsedEmail } from "./types/utils";
+export type { ValidationErrors } from "./blueprintValidation";
+export { startJsonFileDownload, getDKIMSelector } from "./utils";
+export { testDecomposedRegex, parseEmail, generateProofInputs, testBlueprint, } from "./relayerUtils";
+export { getLoginWithGithubUrl } from "./auth";
+export { ZodError } from "./blueprintValidation";
+declare const _default: (sdkOptions?: SdkOptions) => {
+    createBlueprint(props: BlueprintProps): Blueprint;
+    getBlueprint(slug: string): Promise<Blueprint>;
+    getBlueprintById(id: string): Promise<Blueprint>;
+    listBlueprints(options?: ListBlueprintsOptions): Promise<Blueprint[]>;
+    getProof(id: string): Promise<Proof>;
+    getStarredBlueprints(): Promise<string[]>;
+};
+export default _default;