@dev.fast/whiteboard 0.4.0 → 0.4.1-preview.20261026.138

package/src/sharing/import.ts

@@ -1,3 +1,4 @@
+import { createHash } from "node:crypto";
 import { existsSync } from "node:fs";
 import {
   mkdir,
@@ -12,17 +13,12 @@ import {
 } from "node:fs/promises";
 import path from "node:path";
 
-import { parseJsonText } from "@dev.fast/json";
+import { type JsonObject, type JsonValue } from "@dev.fast/review-protocol";
 import {
-  type JsonObject,
-  type JsonValue,
-  isJsonObject,
-} from "@dev.fast/review-protocol";
-import {
-  MAX_SHARE_MANIFEST_BYTES,
-  type ShareManifest,
-  shareIdSchema,
-  shareManifestSchema,
+  MAX_SHARE_BYTES,
+  type ShareBundle,
+  capabilitySchema,
+  shareBundleSchema,
 } from "@dev.fast/review-share-protocol";
 import { textIncludesQuote } from "@review/evidence.js";
 import { lensSchema } from "@review/review-api/diff-lenses.js";
@@ -50,12 +46,7 @@ import {
 } from "@review/stored-document-migration.js";
 import { z } from "zod";
 
-import {
-  type ShareBundle,
-  digestBytes,
-  referenceCommits,
-  validateShareSources,
-} from "./export.js";
+import { referenceCommits, validateShareSources } from "./export.js";
 import {
   COMMIT_ID,
   assertCommitIds,
@@ -132,59 +123,48 @@ export const sharePresentationSchema = z.strictObject({
   maps: z.record(z.string(), mapSchema),
 });
 
-export function validateShareBundle(bundle: ShareBundle) {
-  const manifest = shareManifestSchema.parse(bundle.manifest);
-
-  if (Buffer.byteLength(JSON.stringify(manifest)) > MAX_SHARE_MANIFEST_BYTES)
-    throw new Error("Share manifest is too large.");
-
-  if (bundle.objects.size !== manifest.objects.length)
-    throw new Error("Share object count does not match its manifest.");
-
-  for (const object of manifest.objects) {
-    const bytes = bundle.objects.get(object.id);
-
-    if (
-      !bytes ||
-      bytes.byteLength !== object.size ||
-      digestBytes(bytes) !== object.sha256
-    )
-      throw new Error(`Shared object ${object.id} is missing or corrupt.`);
-  }
-
-  const json = (id: string) =>
-    parseJsonText(Buffer.from(bundle.objects.get(id)!).toString());
+export interface ShareAttribution {
+  login: string;
+  sharedAt: number;
+}
 
-  const stored = json(manifest.snapshot);
+export function validateShareBundle(input: ShareBundle) {
+  const bundle = shareBundleSchema.parse(input);
+  // SAFETY: a bundle is parsed from JSON, so its snapshot is a JSON object.
+  const stored = bundle.snapshot as JsonObject;
 
-  // Bundles shared before a field was retired still open; the bytes stay
-  // sealed and only the parsed document drops the retired form. Lenses
-  // shared as document blocks read as the snapshot's lenses.
+  // Bundles shared before a field was retired still open; only the parsed
+  // document drops the retired form. Lenses shared as document blocks read
+  // as the snapshot's lenses.
   const snapshot = sharedSnapshotSchema.parse(
-    isJsonObject(stored) && "document" in stored
-      ? liftSharedLenses(stored, migrateStoredDocument(stored.document))
-      : stored,
+    stored.document === undefined
+      ? stored
+      : liftSharedLenses(stored, migrateStoredDocument(stored.document)),
   );
 
   if (
-    snapshot.reviewId !== manifest.reviewId ||
-    snapshot.version !== manifest.version ||
-    snapshot.title !== manifest.title
+    snapshot.reviewId !== bundle.reviewId ||
+    snapshot.version !== bundle.version ||
+    snapshot.title !== bundle.title
   )
-    throw new Error("Shared snapshot does not match its manifest.");
+    throw new Error("Shared snapshot does not match its bundle.");
   checkReferences(snapshot.document);
   validateShareSources(snapshot);
   // Every commit it quotes reaches git as an argument.
   assertCommitIds(referenceCommits(snapshot));
 
-  if (snapshot.pins && !manifest.repository)
-    throw new Error("Shared source pins require a repository.");
+  if (
+    (snapshot.pins || referenceCommits(snapshot).length) &&
+    !bundle.repository
+  )
+    throw new ReviewInputError(
+      "This share can only be viewed in the browser.",
+      409,
+    );
 
-  const presentation = sharePresentationSchema.parse(
-    json(manifest.presentation),
-  );
+  const maps = z.record(z.string(), mapSchema).parse(bundle.maps);
 
-  if (!snapshot.pins && Object.keys(presentation.maps).length)
+  if (!snapshot.pins && Object.keys(maps).length)
     throw new Error("Shared maps require source pins.");
 
   const traces = new Map<
@@ -193,25 +173,18 @@ export function validateShareBundle(bundle: ShareBundle) {
   >();
 
   for (const block of resourceReferences(snapshot.document)) {
-    const reference = resourceReference(block);
-
-    const resource = manifest.resources.find(
-      (item) => item.id === reference?.id,
-    );
-
-    if (!reference || !resource || resource.kind !== reference.kind)
-      throw new Error("Missing or mismatched shared resource.");
-
     if (block.type === "trace_quote") {
-      let events = traces.get(resource.object);
+      let events = traces.get(block.traceId);
 
       if (!events) {
-        const trace = traceSchema.parse(json(resource.object));
+        if (!Object.hasOwn(bundle.traces, block.traceId))
+          throw new Error("Missing shared trace.");
+        const trace = traceSchema.parse(bundle.traces[block.traceId]);
         events = new Map(trace.events.map((event) => [event.id, event]));
 
         if (events.size !== trace.events.length)
           throw new Error("Duplicate shared trace event.");
-        traces.set(resource.object, events);
+        traces.set(block.traceId, events);
       }
 
       const event = events.get(block.eventId);
@@ -221,14 +194,16 @@ export function validateShareBundle(bundle: ShareBundle) {
     }
 
     if (block.type === "software_map") {
-      const map = presentation.maps[block.mapVersionId];
+      const map = Object.hasOwn(maps, block.mapVersionId)
+        ? maps[block.mapVersionId]
+        : undefined;
 
       if (!map || map.commit !== snapshot.pins?.[map.side])
         throw new Error("Shared map pins do not match.");
     }
   }
 
-  return { manifest, snapshot, presentation };
+  return { bundle, snapshot, maps };
 }
 
 function liftSharedLenses(stored: JsonObject, migrated: JsonValue): JsonObject {
@@ -246,16 +221,21 @@ function liftSharedLenses(stored: JsonObject, migrated: JsonValue): JsonObject {
   };
 }
 
-export function sharedReviewId(origin: string, shareId: string) {
+export function sharedReviewId(origin: string, capability: string) {
   const url = new URL(origin);
-  shareIdSchema.parse(shareId);
+  capabilitySchema.parse(capability);
 
-  return `shared-${digestBytes(Buffer.from(JSON.stringify([url.origin, shareId])))}`;
+  return `shared-${createHash("sha256")
+    .update(JSON.stringify([url.origin, capability]))
+    .digest("hex")}`;
 }
 
 /** Separate immutable directory tree; authoring mutation handlers cannot write it. */
 export class SharedReviewStore {
-  private readonly loaded = new Map<string, Omit<ShareBundle, "objects">>();
+  private readonly loaded = new Map<
+    string,
+    { attribution?: ShareAttribution }
+  >();
   private readonly validated = new Map<
     string,
     ReturnType<typeof validateShareBundle>
@@ -383,7 +363,7 @@ export class SharedReviewStore {
       throw new ReviewInputError("Shared review is not available.", 404);
 
     if (!saved.snapshot.pins) {
-      await this.prepareUnpinned(id, saved.manifest.repository?.cloneUrl);
+      await this.prepareUnpinned(id, saved.bundle.repository?.cloneUrl);
 
       return;
     }
@@ -405,7 +385,7 @@ export class SharedReviewStore {
         await rm(root, { recursive: true, force: true });
         await this.fetchRepository(
           root,
-          saved.manifest.repository!.cloneUrl,
+          saved.bundle.repository!.cloneUrl,
           saved.snapshot.pins,
           false,
           commits,
@@ -481,7 +461,7 @@ export class SharedReviewStore {
       add({ ...anchorPins(source, pins), repositoryId }, source);
 
     if (pins)
-      for (const map of Object.values(saved.presentation.maps))
+      for (const map of Object.values(saved.maps))
         for (const element of map.elements)
           for (const range of element.sourceRanges ?? [])
             add(pins, { ...range, side: map.side });
@@ -588,6 +568,13 @@ export class SharedReviewStore {
 
     for (const id of await readdir(this.root)) {
       if (!/^shared-[a-f0-9]{64}$/.test(id)) continue;
+
+      // Earlier share formats are not read; reopening the link imports again.
+      if (!existsSync(path.join(this.root, id, "bundle.json"))) {
+        await rm(path.join(this.root, id), { recursive: true, force: true });
+        continue;
+      }
+
       let saved: Awaited<ReturnType<SharedReviewStore["readValidated"]>>;
 
       try {
@@ -603,11 +590,8 @@ export class SharedReviewStore {
         continue;
       }
 
-      const { bundle, validated } = saved;
-      this.loaded.set(id, {
-        manifest: bundle.manifest,
-        attribution: bundle.attribution,
-      });
+      const { attribution, validated } = saved;
+      this.loaded.set(id, { attribution });
       this.validated.set(id, validated);
 
       let prepared = false;
@@ -641,7 +625,7 @@ export class SharedReviewStore {
       }
 
       if (!validated.snapshot.pins) {
-        if (this.repositories.has(id) || !validated.manifest.repository)
+        if (this.repositories.has(id) || !validated.bundle.repository)
           this.setStatus(id, "ready");
         else void this.prepare(id).catch(() => {});
       } else if (
@@ -719,9 +703,9 @@ export class SharedReviewStore {
   }
 
   get(id: string) {
-    const bundle = this.loaded.get(id);
+    const loaded = this.loaded.get(id);
 
-    if (!bundle)
+    if (!loaded)
       throw new ReviewInputError("Shared review is not available.", 404);
     const validated = this.validated.get(id)!;
     const repositoryId = this.repositories.get(id);
@@ -757,8 +741,8 @@ export class SharedReviewStore {
             ? { kind: "project" as const, repositoryId }
             : undefined,
         shared: {
-          ...bundle.attribution,
-          cloneUrl: bundle.manifest.repository?.cloneUrl,
+          ...loaded.attribution,
+          cloneUrl: validated.bundle.repository?.cloneUrl,
         },
       },
     };
@@ -795,25 +779,6 @@ export class SharedReviewStore {
     return this.local?.store.withDiffStats(reviews) ?? reviews;
   }
 
-  async readObject(id: string, objectId: string) {
-    const entry = this.get(id).manifest.objects.find(
-      (object) => object.id === objectId,
-    );
-
-    if (!entry)
-      throw new ReviewInputError("Shared object is unavailable.", 404);
-    const file = path.join(this.root, id, objectId);
-
-    if ((await stat(file)).size !== entry.size)
-      throw new Error("Corrupt cached shared object.");
-    const bytes = await readFile(file);
-
-    if (digestBytes(bytes) !== entry.sha256)
-      throw new Error("Corrupt cached shared object.");
-
-    return bytes;
-  }
-
   async removeLocal(id: string) {
     await this.jobs.get(id)?.catch(() => {});
 
@@ -893,30 +858,32 @@ export class SharedReviewStore {
     for (const listener of this.listeners) listener();
   }
 
-  async import(origin: string, shareId: string, bundle: ShareBundle) {
+  async import(
+    origin: string,
+    capability: string,
+    bundle: ShareBundle,
+    attribution?: ShareAttribution,
+  ) {
     const validated = validateShareBundle(bundle);
-    const id = sharedReviewId(origin, shareId);
+    const id = sharedReviewId(origin, capability);
     this.assertWritable(id);
     await mkdir(this.root, { recursive: true, mode: 0o700 });
     const staging = await mkdtemp(path.join(this.root, ".import-"));
 
     try {
       await writeFile(
-        path.join(staging, "manifest.json"),
-        JSON.stringify(bundle.manifest),
+        path.join(staging, "bundle.json"),
+        JSON.stringify(validated.bundle),
         { mode: 0o600 },
       );
 
-      if (bundle.attribution)
+      if (attribution)
         await writeFile(
           path.join(staging, "attribution.json"),
-          JSON.stringify(bundle.attribution),
+          JSON.stringify(attribution),
           { mode: 0o600 },
         );
 
-      for (const [objectId, bytes] of bundle.objects)
-        await writeFile(path.join(staging, objectId), bytes, { mode: 0o600 });
-
       try {
         await rename(staging, path.join(this.root, id));
       } catch (error) {
@@ -930,19 +897,14 @@ export class SharedReviewStore {
           throw error;
         const existing = await this.read(id);
 
-        if (
-          JSON.stringify(existing.manifest) !== JSON.stringify(bundle.manifest)
-        )
-          throw new Error("An immutable share changed its manifest.");
+        if (JSON.stringify(existing) !== JSON.stringify(validated.bundle))
+          throw new Error("An immutable share changed its bundle.");
       }
     } finally {
       await rm(staging, { recursive: true, force: true });
     }
 
-    this.loaded.set(id, {
-      manifest: bundle.manifest,
-      attribution: bundle.attribution,
-    });
+    this.loaded.set(id, { attribution });
     this.validated.set(id, validated);
 
     for (const listener of this.listeners) listener();
@@ -953,35 +915,19 @@ export class SharedReviewStore {
   }
 
   async read(id: string): Promise<ShareBundle> {
-    return (await this.readValidated(id)).bundle;
+    return (await this.readValidated(id)).validated.bundle;
   }
 
   private async readValidated(id: string) {
     if (!/^shared-[a-f0-9]{64}$/.test(id))
       throw new Error("Invalid shared review ID.");
     const dir = path.join(this.root, id);
+    const file = path.join(dir, "bundle.json");
 
-    if (
-      (await stat(path.join(dir, "manifest.json"))).size >
-      MAX_SHARE_MANIFEST_BYTES
-    )
-      throw new Error("Shared manifest is too large.");
-
-    const manifest: ShareManifest = shareManifestSchema.parse(
-      JSON.parse(await readFile(path.join(dir, "manifest.json"), "utf8")),
-    );
-
-    const objects = new Map<string, Uint8Array>();
-
-    for (const object of manifest.objects) {
-      const file = path.join(dir, object.id);
+    if ((await stat(file)).size > MAX_SHARE_BYTES)
+      throw new Error("Shared bundle is too large.");
 
-      if ((await stat(file)).size !== object.size)
-        throw new Error("Corrupt cached shared object.");
-      objects.set(object.id, await readFile(file));
-    }
-
-    let attribution: ShareBundle["attribution"];
+    let attribution: ShareAttribution | undefined;
 
     try {
       attribution = z
@@ -995,9 +941,9 @@ export class SharedReviewStore {
       /* Local-only fixtures have no hosted sender. */
     }
 
-    const bundle = { manifest, objects, attribution };
-    const validated = validateShareBundle(bundle);
-
-    return { bundle, validated };
+    return {
+      attribution,
+      validated: validateShareBundle(JSON.parse(await readFile(file, "utf8"))),
+    };
   }
 }

package/src/sharing/index.ts

@@ -1,11 +1,6 @@
 export { ShareClient } from "./client.js";
 
-export {
-  exportShare,
-  type ShareBundle,
-  type ShareExportData,
-  type ShareExportStore,
-} from "./export.js";
+export { exportShare } from "./export.js";
 
 export {
   SharedReviewStore,

package/src/sharing/routes.ts

@@ -7,28 +7,29 @@ export class SharedReviewData {
   constructor(private readonly store: SharedReviewStore) {}
 
   map(id: string, resourceId: string) {
-    const map = this.store.get(id).presentation.maps[resourceId];
+    const { maps } = this.store.get(id);
 
-    if (!map)
+    if (!Object.hasOwn(maps, resourceId))
       throw new ReviewInputError("Map is not included in this share.", 404);
 
-    return map;
+    return maps[resourceId]!;
   }
 
   async resource(id: string, resourceId: string) {
-    const resource = this.store
-      .get(id)
-      .manifest.resources.find((item) => item.id === resourceId);
-
-    if (!resource)
-      throw new ReviewInputError(
-        "Resource is not included in this share.",
-        404,
-      );
-
-    return {
-      data: await this.store.readObject(id, resource.object),
-      mimeType: resource.mimeType,
-    };
+    const { bundle } = this.store.get(id);
+
+    if (Object.hasOwn(bundle.images, resourceId))
+      return {
+        data: Buffer.from(bundle.images[resourceId]!.png, "base64"),
+        mimeType: "image/png",
+      };
+
+    if (Object.hasOwn(bundle.traces, resourceId))
+      return {
+        data: Buffer.from(JSON.stringify(bundle.traces[resourceId])),
+        mimeType: "application/json",
+      };
+
+    throw new ReviewInputError("Resource is not included in this share.", 404);
   }
 }

package/src/ui-telemetry-events.ts

@@ -148,6 +148,7 @@ export const SETTING_NAME = [
   "sharing_enabled",
   "diffr_config",
   "theme",
+  "diff_theme",
   "ctrl_tab",
   "open_files_in",
   "ready_notification",
@@ -155,6 +156,7 @@ export const SETTING_NAME = [
   "code_font_size",
   "document_font_size",
   "reading_font",
+  "reading_font_family",
   "code_font_family",
   "font_ligatures",
   "diff_font_size",
@@ -621,6 +623,15 @@ export const UI_TELEMETRY_EVENTS = {
     event: "review_diff_failed",
     properties: { reason: DIFF_FAILED_REASON, files: "number" },
   },
+  diff_loaded: {
+    event: "review_diff_loaded",
+    properties: {
+      first_file_ms: "number",
+      updates_ms: "number",
+      files: "number",
+      update_errors: "number",
+    },
+  },
   discord_clicked: {
     event: "review_discord_clicked",
     properties: { via: DISCORD_VIA },

package/dist/agent-cli-Cn4-16XA.js

@@ -1,2 +0,0 @@
-import { n as runReviewAgentCli } from "./agent-cli-CHNDd4Ga.js";
-export { runReviewAgentCli };

package/dist/profile-BopGMZUh.js

@@ -1,2 +0,0 @@
-import { t as openReviewProfile } from "./profile-D9wdlPgw.js";
-export { openReviewProfile };

package/dist/{s3-config-CjcLyFV5.js → s3-config-D7Yt0VhS.js}

@@ -1,9 +1,9 @@
 import { a as jsonNumber, c as jsonString, o as jsonObject, u as parseJsonText } from "./src-X9phtB2j.js";
 import { createHash, randomBytes } from "node:crypto";
 import { z } from "zod";
+import path from "node:path";
 import { chmodSync, chownSync, closeSync, existsSync, fsyncSync, lstatSync, mkdirSync, openSync, readFileSync, realpathSync, renameSync, rmSync, statSync, writeSync } from "node:fs";
 import { chmod, chown, lstat, mkdir, open, readFile, realpath, rename, rm, stat, utimes, writeFile } from "node:fs/promises";
-import path from "node:path";
 import os from "node:os";
 import { spawnSync } from "node:child_process";
 import { setTimeout } from "node:timers/promises";

package/dist/{src-X9ZebeOD.js → src-DXnn7RrI.js}

@@ -1,6 +1,6 @@
 import { createRequire } from "node:module";
-import fs from "node:fs";
 import path from "node:path";
+import fs from "node:fs";
 import { tmpdir } from "node:os";
 import { execFile, execFileSync, spawn } from "node:child_process";
 import "node:timers/promises";