@vlayer/sdk 0.1.0-nightly-20241028-74b5b0d → 0.1.0-nightly-202410292-42360cf

package/dist/api/webProof/steps/expectUrl.js

@@ -0,0 +1,8 @@
+import { EXTENSION_STEP, } from "../../../web-proof-commons";
+export const expectUrl = (url, label) => {
+    return {
+        url,
+        label,
+        step: EXTENSION_STEP.expectUrl,
+    };
+};

package/dist/api/webProof/steps/index.d.ts

@@ -0,0 +1,9 @@
+import { expectUrl } from "./expectUrl";
+import { startPage } from "./startPage";
+import { notarize } from "./notarize";
+declare const steps: {
+    expectUrl: (url: string, label: string) => import("../../../web-proof-commons").WebProofStepExpectUrl;
+    startPage: (url: string, label: string) => import("../../../web-proof-commons").WebProofStepStartPage;
+    notarize: (url: string, method: string | undefined, label: string) => import("../../../web-proof-commons").WebProofStepNotarize;
+};
+export { expectUrl, startPage, notarize, steps };

package/dist/api/webProof/steps/index.js

@@ -0,0 +1,9 @@
+import { expectUrl } from "./expectUrl";
+import { startPage } from "./startPage";
+import { notarize } from "./notarize";
+const steps = {
+    expectUrl,
+    startPage,
+    notarize,
+};
+export { expectUrl, startPage, notarize, steps };

package/dist/api/webProof/steps/notarize.d.ts

@@ -0,0 +1,2 @@
+import { WebProofStepNotarize } from "../../../web-proof-commons";
+export declare const notarize: (url: string, method: string | undefined, label: string) => WebProofStepNotarize;

package/dist/api/webProof/steps/notarize.js

@@ -0,0 +1,9 @@
+import { EXTENSION_STEP, } from "../../../web-proof-commons";
+export const notarize = (url, method = "GET", label) => {
+    return {
+        url,
+        method,
+        label,
+        step: EXTENSION_STEP.notarize,
+    };
+};

package/dist/api/webProof/steps/startPage.d.ts

@@ -0,0 +1,2 @@
+import { WebProofStepStartPage } from "../../../web-proof-commons";
+export declare const startPage: (url: string, label: string) => WebProofStepStartPage;

package/dist/api/webProof/steps/startPage.js

@@ -0,0 +1,8 @@
+import { EXTENSION_STEP, } from "../../../web-proof-commons";
+export const startPage = (url, label) => {
+    return {
+        url,
+        label,
+        step: EXTENSION_STEP.startPage,
+    };
+};

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * as testHelpers from "./api/helpers";
+export { preverifyEmail } from "./api/email/preverify";
+export { createVlayerClient } from "./api/lib/client";
+export * from "./api/webProof";
+export * from "./api/lib/types";
+export * from "./web-proof-commons/types/webProof";
+export * from "./web-proof-commons/utils";

package/dist/index.js

@@ -0,0 +1,7 @@
+export * as testHelpers from "./api/helpers";
+export { preverifyEmail } from "./api/email/preverify";
+export { createVlayerClient } from "./api/lib/client";
+export * from "./api/webProof";
+export * from "./api/lib/types";
+export * from "./web-proof-commons/types/webProof";
+export * from "./web-proof-commons/utils";

package/dist/testHelpers/readFile.d.ts

@@ -0,0 +1 @@
+export declare const readFile: (path: string) => string;

package/dist/testHelpers/readFile.js

@@ -0,0 +1,2 @@
+import fs from "fs";
+export const readFile = (path) => fs.readFileSync(path).toString();

package/dist/web-proof-commons/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./types/message";
+export * from "./types/webProof";
+export * from "./utils";

package/dist/web-proof-commons/index.js

@@ -0,0 +1,3 @@
+export * from "./types/message";
+export * from "./types/webProof";
+export * from "./utils";

package/dist/web-proof-commons/types/message.d.ts

@@ -0,0 +1,56 @@
+import type { Branded } from "../utils";
+import type { WebProof } from "./webProof";
+export declare const EXTENSION_STEP: {
+    readonly expectUrl: "expectUrl";
+    readonly startPage: "startPage";
+    readonly notarize: "notarize";
+};
+export type ExtensionStep = (typeof EXTENSION_STEP)[keyof typeof EXTENSION_STEP];
+export declare const enum ExtensionAction {
+    RequestWebProof = 0
+}
+export type MessageToExtension = {
+    action: ExtensionAction;
+    payload: WebProverSessionConfig;
+};
+export declare const enum ExtensionMessageType {
+    ProofDone = "ProofDone",
+    ProofError = "ProofError",
+    RedirectBack = "RedirectBack",
+    TabOpened = "TabOpened"
+}
+export type ExtensionMessage = {
+    type: ExtensionMessageType.ProofDone;
+    proof: WebProof;
+} | {
+    type: ExtensionMessageType.ProofError;
+    error: string;
+} | {
+    type: ExtensionMessageType.RedirectBack;
+} | {
+    type: ExtensionMessageType.TabOpened;
+    tabId: number;
+};
+export type WebProverSessionConfig = {
+    notaryUrl: string;
+    wsProxyUrl: string;
+    logoUrl: string;
+    steps: WebProofStep[];
+};
+export type WebProofStep = WebProofStepNotarize | WebProofStepExpectUrl | WebProofStepStartPage;
+export type WebProofStepNotarize = Branded<{
+    url: string;
+    method: string;
+    label: string;
+    step: typeof EXTENSION_STEP.notarize;
+}, "notarize">;
+export type WebProofStepExpectUrl = Branded<{
+    url: string;
+    label: string;
+    step: typeof EXTENSION_STEP.expectUrl;
+}, "expectUrl">;
+export type WebProofStepStartPage = Branded<{
+    url: string;
+    label: string;
+    step: typeof EXTENSION_STEP.startPage;
+}, "startPage">;

package/dist/web-proof-commons/types/message.js

@@ -0,0 +1,5 @@
+export const EXTENSION_STEP = {
+    expectUrl: "expectUrl",
+    startPage: "startPage",
+    notarize: "notarize",
+};

package/dist/web-proof-commons/types/webProof.d.ts

@@ -0,0 +1,86 @@
+export interface WebProof {
+    session: Session;
+    substrings: Substrings;
+    notaryUrl: string;
+}
+export interface Session {
+    header: Header;
+    signature: Signature;
+    session_info: SessionInfo;
+}
+export interface SessionInfo {
+    server_name: ServerName;
+    handshake_decommitment: HandshakeDecommitment;
+}
+export interface HandshakeDecommitment {
+    nonce: number[];
+    data: Data;
+}
+export interface Data {
+    server_cert_details: ServerCERTDetails;
+    server_kx_details: ServerKxDetails;
+    client_random: number[];
+    server_random: number[];
+}
+export interface ServerCERTDetails {
+    cert_chain: Array<number[]>;
+    ocsp_response: number[];
+    scts: null;
+}
+export interface ServerKxDetails {
+    kx_params: number[];
+    kx_sig: KxSig;
+}
+export interface KxSig {
+    scheme: string;
+    sig: number[];
+}
+export interface Header {
+    encoder_seed: number[];
+    merkle_root: number[];
+    sent_len: number;
+    recv_len: number;
+    handshake_summary: HandshakeSummary;
+}
+export interface HandshakeSummary {
+    time: number;
+    server_public_key: ServerPublicKey;
+    handshake_commitment: number[];
+}
+export interface ServerPublicKey {
+    group: string;
+    key: number[];
+}
+export interface ServerName {
+    Dns: string;
+}
+export interface Signature {
+    P256: string;
+}
+export interface Substrings {
+    openings: {
+        [key: string]: Opening[];
+    };
+    inclusion_proof: InclusionProof;
+}
+export interface InclusionProof {
+    proof: unknown[];
+    total_leaves: number;
+}
+export interface Opening {
+    kind?: string;
+    ranges?: Range[];
+    direction?: string;
+    Blake3?: Blake3;
+}
+export interface Blake3 {
+    data: number[];
+    nonce: number[];
+}
+export interface Range {
+    start: number;
+    end: number;
+}
+export declare const assertWebProof: (candidate: {
+    notaryUrl?: string;
+}) => asserts candidate is WebProof;

package/dist/web-proof-commons/types/webProof.js

@@ -0,0 +1,10 @@
+// NOTE : this is copied from tlsn-js 5.4
+// for some reason newest versions doesn't export this type (clarification is in progress)
+// probably it should be reexported from tlsn-js
+export const assertWebProof = function (candidate) {
+    //for now only thing we check is notary url
+    //TODO: implement later once we known the conteact with tlsn-js
+    if (!candidate.notaryUrl) {
+        throw new Error("Missing required parameter");
+    }
+};

package/dist/web-proof-commons/utils.d.ts

@@ -0,0 +1,7 @@
+declare const __brand: unique symbol;
+type Brand<B> = {
+    [__brand]: B;
+};
+export type Branded<T, B> = T & Brand<B>;
+export declare function isDefined<T>(value: T | undefined, message?: string): asserts value is T;
+export {};

package/dist/web-proof-commons/utils.js

@@ -0,0 +1,5 @@
+export function isDefined(value, message = "Value is undefined") {
+    if (value === undefined) {
+        throw new Error(message);
+    }
+}

package/package.json

@@ -1,13 +1,17 @@
 {
   "name": "@vlayer/sdk",
   "type": "module",
-  "exports": "./src/index.ts",
-  "version": "0.1.0-nightly-20241028-74b5b0d",
-  "types": "src/index.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "version": "0.1.0-nightly-202410292-42360cf",
   "scripts": {
-    "build": "npm run gen:types",
+    "build": "bun tsc",
     "test": "vitest --run",
-    "gen:types": "sh ../bash/build_ts_types.sh"
+    "gen:types": "sh ../../bash/build_ts_types.sh"
   },
   "devDependencies": {
     "@changesets/cli": "^2.27.7",
@@ -16,7 +20,7 @@
     "vitest": "^2.1.1"
   },
   "peerDependencies": {
-    "typescript": "^5.0.0"
+    "typescript": "^5.6.3"
   },
   "dependencies": {
     "dns-over-http-resolver": "^3.0.3",
@@ -24,5 +28,10 @@
     "viem": "2.21.0",
     "vite-tsconfig-paths": "^5.0.1",
     "@vitejs/plugin-react": "^4.3.2"
-  }
+  },
+  "files": [
+    "dist/",
+    "package.json",
+    "README.md"
+  ]
 }

package/.changeset/config.json

@@ -1,11 +0,0 @@
-{
-  "$schema": "https://unpkg.com/@changesets/config@3.0.2/schema.json",
-  "changelog": "@changesets/cli/changelog",
-  "commit": false,
-  "fixed": [],
-  "linked": [],
-  "access": "restricted",
-  "baseBranch": "main",
-  "updateInternalDependencies": "patch",
-  "ignore": []
-}

package/CHANGELOG.md

@@ -1,7 +0,0 @@
-# @vlayer/sdk
-
-## 0.0.2
-
-### Patch Changes
-
-- added changesets

package/eslint.config.ts

@@ -1,22 +0,0 @@
-import js from "@eslint/js";
-import ts from "typescript-eslint";
-import prettierRecommended from "eslint-plugin-prettier/recommended";
-import globals from "globals";
-
-export default [
-  js.configs.recommended,
-  ...ts.configs.recommended,
-  prettierRecommended,
-  {
-    rules: {
-      "no-unused-vars": "warn",
-      "no-undef": "warn",
-    },
-    languageOptions: {
-      globals: {
-        ...globals.browser,
-        Bun: false,
-      },
-    },
-  },
-];

package/src/api/email/dnsResolver.test.ts

@@ -1,18 +0,0 @@
-import { describe, expect, test } from "vitest";
-import { resolveDkimDns } from "./dnsResolver.ts";
-
-describe("resolveDkimDns Integration", () => {
-  test("resolves VLayer DNS", async () => {
-    const resolved = await resolveDkimDns(
-      "vlayer-xyz.20230601.gappssmtp.com",
-      "20230601",
-    );
-    const expected =
-      "v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3gWcOhCm99qzN+h7/2+LeP3CLsJkQQ4EP/2mrceXle5pKq8uZmBl1U4d2Vxn4w+pWFANDLmcHolLboESLFqEL5N6ae7u9b236dW4zn9AFkXAGenTzQEeif9VUFtLAZ0Qh2eV7OQgz/vPj5IaNqJ7h9hpM9gO031fe4v+J0DLCE8Rgo7hXbNgJavctc0983DaCDQaznHZ44LZ6TtZv9TBs+QFvsy4+UCTfsuOtHzoEqOOuXsVXZKLP6B882XbEnBpXEF8QzV4J26HiAJFUbO3mAqZL2UeKC0hhzoIZqZXNG0BfuzOF0VLpDa18GYMUiu+LhEJPJO9D8zhzvQIHNrpGwIDAQAB";
-    expect(resolved).toBe(expected);
-  });
-
-  test("throws error if dns not found", async () => {
-    await expect(resolveDkimDns("not-a-domain.com", "abcd")).rejects.toThrow();
-  });
-});

package/src/api/email/dnsResolver.ts

@@ -1,7 +0,0 @@
-import DnsResolver from "dns-over-http-resolver";
-
-export async function resolveDkimDns(domain: string, selector: string) {
-  const resolver = new DnsResolver();
-  const address = await resolver.resolveTxt(`${selector}._domainkey.${domain}`);
-  return address.flat()[0];
-}

package/src/api/email/parseEmail.test.ts

@@ -1,133 +0,0 @@
-import { describe, expect, test } from "vitest";
-import { getDkimSigners, parseEmail, parseParams } from "./parseEmail.ts";
-
-const emailHeaders = `From: "John Doe" <john@d.oe>
-To: "Jane Doe" <jane@d.oe>
-Subject: Hello World
-Date: Thu, 1 Jan 1970 00:00:00 +0000
-`;
-
-const dkimHeader =
-  "DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=example.com; h=from:to:subject; s=selector1; b=abcdef;";
-
-const body = "Hello, World!";
-
-const emailFixture = `${emailHeaders}${dkimHeader}\n\n${body}`;
-
-describe("parseEmail", () => {
-  test("should get dkim header from email", async () => {});
-
-  test("correctly parses untrimmed email", async () => {
-    const untrimmed = `\n   ${emailFixture}    \n`;
-    const email = await parseEmail(untrimmed);
-    expect(email.headers.find((h) => h.key === "dkim-signature")).toBeDefined();
-  });
-
-  test("works well with multiple dkim headers", async () => {
-    const dkimHeader2 =
-      "DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=second.signer; h=from:to:subject; s=selector2; b=abcdef;";
-
-    const email = await parseEmail(
-      `${emailHeaders}${dkimHeader}\n${dkimHeader2}\n\n${body}`,
-    );
-    const dkim = email.headers.filter((h) => h.key === "dkim-signature");
-
-    expect(dkim).toHaveLength(2);
-    expect(parseParams(dkim[0].value).s).toBe("selector1");
-    expect(parseParams(dkim[1].value).s).toBe("selector2");
-  });
-});
-
-describe("getDkimSigners", () => {
-  test("should get dkim signers from email", async () => {
-    const email = await parseEmail(emailFixture);
-    const dkim = getDkimSigners(email);
-    expect(dkim).toHaveLength(1);
-    expect(dkim[0].domain).toBe("example.com");
-    expect(dkim[0].selector).toBe("selector1");
-  });
-
-  test("should get multiple dkim signers from email", async () => {
-    const dkimHeader2 =
-      "DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=second.signer; h=from:to:subject; s=selector2; b=abcdef;";
-    const email = await parseEmail(
-      `${emailHeaders}${dkimHeader}\n${dkimHeader2}\n\n${body}`,
-    );
-
-    const dkim = getDkimSigners(email);
-    expect(dkim).toHaveLength(2);
-    expect(dkim[0].domain).toBe("example.com");
-    expect(dkim[0].selector).toBe("selector1");
-    expect(dkim[1].domain).toBe("second.signer");
-    expect(dkim[1].selector).toBe("selector2");
-  });
-
-  test("should throw if no dkim header found", async () => {
-    const email = await parseEmail(emailHeaders);
-    expect(() => getDkimSigners(email)).toThrowError("No DKIM header found");
-  });
-
-  test("should throw if dkim header is invalid", async () => {
-    const email = await parseEmail(
-      `${emailHeaders}DKIM-Signature: invalid\n\n${body}`,
-    );
-    expect(() => getDkimSigners(email)).toThrowError(
-      "DKIM header missing domain",
-    );
-  });
-
-  test("should throw if dkim header is missing domain", async () => {
-    const email = await parseEmail(
-      `${emailHeaders}DKIM-Signature: v=1; s=selector\n\n${body}`,
-    );
-    expect(() => getDkimSigners(email)).toThrowError(
-      "DKIM header missing domain",
-    );
-  });
-
-  test("should throw if dkim header is missing selector", async () => {
-    const email = await parseEmail(
-      `${emailHeaders}DKIM-Signature: v=1; d=example.com\n\n${body}`,
-    );
-    expect(() => getDkimSigners(email)).toThrowError(
-      "DKIM header missing selector",
-    );
-  });
-});
-
-describe("parseParams", () => {
-  test("should parse single parameter", () => {
-    const params = parseParams("a=b");
-    expect(params).toEqual({ a: "b" });
-  });
-
-  test("should parse multiple parameters", () => {
-    const params = parseParams("a=b; c=d; e=f");
-    expect(params).toEqual({ a: "b", c: "d", e: "f" });
-  });
-
-  test("should trim spaces around parameters", () => {
-    const params = parseParams(" a = b ; c = d ; e = f ");
-    expect(params).toEqual({ a: "b", c: "d", e: "f" });
-  });
-
-  test("should handle empty values", () => {
-    const params = parseParams("a=; b=c");
-    expect(params).toEqual({ a: "", b: "c" });
-  });
-
-  test("should handle missing values", () => {
-    const params = parseParams("a; b=c");
-    expect(params).toEqual({ a: undefined, b: "c" });
-  });
-
-  test("should handle empty string", () => {
-    const params = parseParams("");
-    expect(params).toEqual({});
-  });
-
-  test("should handle parameters with extra semicolons", () => {
-    const params = parseParams("a=b;; c=d;");
-    expect(params).toEqual({ a: "b", c: "d" });
-  });
-});

package/src/api/email/parseEmail.ts

@@ -1,49 +0,0 @@
-import PostalMime, { Email, Header } from "postal-mime";
-
-export class DkimParsingError extends Error {
-  constructor(message: string) {
-    super(message);
-    this.name = "DkimParsingError";
-  }
-}
-
-export async function parseEmail(mime: string) {
-  return await PostalMime.parse(mime.trim());
-}
-
-export function getDkimSigners(mail: Email) {
-  const dkimHeader = mail.headers.filter((h) => h.key === "dkim-signature");
-  if (dkimHeader.length === 0)
-    throw new DkimParsingError("No DKIM header found");
-  return dkimHeader.map(parseHeader);
-}
-
-export function parseParams(str: string) {
-  return Object.fromEntries(
-    str.split(";").map((s) =>
-      s
-        .trim()
-        .split("=")
-        .map((v) => v && v.trim()),
-    ),
-  ) as Record<string, string>;
-}
-
-function parseHeader(header: Header) {
-  const params = parseParams(header.value);
-  if (!params) {
-    throw new DkimParsingError(`Invalid DKIM header ${header.value}`);
-  }
-
-  if (!params.d) {
-    throw new DkimParsingError("DKIM header missing domain");
-  }
-
-  if (!params.s) {
-    throw new DkimParsingError("DKIM header missing selector");
-  }
-  return {
-    domain: params.d,
-    selector: params.s,
-  };
-}

package/src/api/email/preverify.test.ts

@@ -1,37 +0,0 @@
-import { describe, expect, test } from "vitest";
-import { preverifyEmail } from "./preverify.ts";
-import { readFile } from "../../testHelpers/readFile";
-
-describe("Preverify email: integration", () => {
-  test("adds dns record to email mime", async () => {
-    const rawEmail = readFile("./src/api/email/testdata/test_email.txt");
-    const preverifiedEmail = await preverifyEmail(rawEmail);
-    expect(preverifiedEmail).toMatchObject({
-      email: rawEmail,
-      dnsRecords: [expect.stringContaining("v=DKIM1; k=rsa; p=")],
-    });
-  });
-
-  test("throws error if DKIM not found", async () => {
-    const emailWithNoDkimHeader = 'From: "Alice"\n\nBody';
-    await expect(preverifyEmail(emailWithNoDkimHeader)).rejects.toThrow(
-      "No DKIM header found",
-    );
-  });
-
-  test("throws error if DNS could not be resolved", async () => {
-    const emailWithNoDkimHeader = readFile(
-      "./src/api/email/testdata/test_email_unknown_domain.txt",
-    );
-    await expect(preverifyEmail(emailWithNoDkimHeader)).rejects.toThrow();
-  });
-
-  test("throws error if multiple DNS records found", async () => {
-    const emailWithNoDkimHeader = readFile(
-      "./src/api/email/testdata/test_email_multiple_dkims.txt",
-    );
-    await expect(preverifyEmail(emailWithNoDkimHeader)).rejects.toThrow(
-      "Multiple DKIM headers found",
-    );
-  });
-});

package/src/api/email/preverify.ts

@@ -1,19 +0,0 @@
-import { parseEmail, getDkimSigners } from "./parseEmail.ts";
-import { resolveDkimDns } from "./dnsResolver.ts";
-
-export async function preverifyEmail(mimeEmail: string) {
-  const parsedEmail = await parseEmail(mimeEmail);
-  const signers = getDkimSigners(parsedEmail);
-  if (signers.length === 0) {
-    throw new Error("No DKIM header found");
-  }
-  if (signers.length > 1) {
-    throw new Error("Multiple DKIM headers found");
-  }
-  const [{ domain, selector }] = signers;
-  const dnsRecord = await resolveDkimDns(domain, selector);
-  return {
-    email: mimeEmail,
-    dnsRecords: [dnsRecord],
-  };
-}

package/src/api/email/testdata/test_email.txt

@@ -1,21 +0,0 @@
-DKIM-Signature: a=rsa-sha256; bh=2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8=;
- c=simple/simple; d=google.com;
- h=Received:From:To:Subject:Date:Message-ID; i=joe@football.example.com;
- s=20230601; t=1615825284; v=1;
- b=Xh4Ujb2wv5x54gXtulCiy4C0e+plRm6pZ4owF+kICpYzs/8WkTVIDBrzhJP0DAYCpnL62T0G
- k+0OH8pi/yqETVjKtKk+peMnNvKkut0GeWZMTze0bfq3/JUK3Ln3jTzzpXxrgVnvBxeY9EZIL4g
- s4wwFRRKz/1bksZGSjD8uuSU=
-Received: from client1.football.example.com  [192.0.2.1]
-      by submitserver.example.com with SUBMISSION;
-      Fri, 11 Jul 2003 21:01:54 -0700 (PDT)
-From: Joe SixPack <joe@football.example.com>
-To: Suzie Q <suzie@shopping.example.net>
-Subject: Is dinner ready?
-Date: Fri, 11 Jul 2003 21:00:37 -0700 (PDT)
-Message-ID: <20030712040037.46341.5F8J@football.example.com>
-
-Hi.
-
-We lost the game. Are you hungry yet?
-
-Joe.