@backmatter/core 0.0.32 → 0.0.33

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backmatter/core",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "description": "Experimental Backmatter SDK. APIs will break. Not ready for production.",
   "type": "module",
   "publishConfig": {

package/src/preview-channel.ts

@@ -59,11 +59,17 @@ export type PreviewPointMessage = Envelope & {
 
 export type PreviewGrabMessage = Envelope & {
   type: "backmatter:grab";
-  blockId: string;
+  /** Null when the click is not inside a page block. */
+  blockId: string | null;
   blockType: string | null;
   blockIndex: number | null;
   quote: string;
   shift: boolean;
+  component?: string;
+  file?: string;
+  line?: number;
+  column?: number;
+  stack?: string[];
 };
 
 export type PreviewHighlightMessage = Envelope & {
@@ -119,6 +125,37 @@ function readEnvelope(value: Record<string, unknown>): Envelope | null {
   return { v: PREVIEW_CHANNEL_VERSION, ref };
 }
 
+const GRAB_FILE = /^[\w./@+-]+\.(?:tsx|ts|jsx|js|mdx)$/;
+
+function readGrabPlace(data: Record<string, unknown>): Pick<
+  PreviewGrabMessage,
+  "component" | "file" | "line" | "column" | "stack"
+> {
+  const component =
+    typeof data.component === "string" && data.component.length > 0 && data.component.length <= 80
+      ? data.component
+      : undefined;
+  const file =
+    typeof data.file === "string" && data.file.length <= 240 && GRAB_FILE.test(data.file) && !data.file.includes("..")
+      ? data.file
+      : undefined;
+  const line = typeof data.line === "number" && Number.isInteger(data.line) && data.line > 0 ? data.line : undefined;
+  const column =
+    typeof data.column === "number" && Number.isInteger(data.column) && data.column > 0 ? data.column : undefined;
+  const stack = Array.isArray(data.stack)
+    ? data.stack
+        .filter((item): item is string => typeof item === "string" && item.length > 0 && item.length <= 80)
+        .slice(0, 4)
+    : [];
+  return {
+    ...(component ? { component } : {}),
+    ...(file ? { file } : {}),
+    ...(line ? { line } : {}),
+    ...(column ? { column } : {}),
+    ...(stack.length > 0 ? { stack } : {}),
+  };
+}
+
 /** Parse a channel payload. Legacy hotkey messages (no `v`) still parse. */
 export function parsePreviewMessage(data: unknown): PreviewChannelMessage | null {
   const hotkey = parsePreviewHotkey(data);
@@ -167,7 +204,8 @@ export function parsePreviewMessage(data: unknown): PreviewChannelMessage | null
       return { type: "backmatter:point", ...envelope, on: data.on };
     }
     case "backmatter:grab": {
-      if (typeof data.blockId !== "string" || data.blockId.length === 0) return null;
+      const blockId = data.blockId === null ? null : typeof data.blockId === "string" ? data.blockId : undefined;
+      if (blockId === undefined || blockId === "") return null;
       if (data.blockType !== null && typeof data.blockType !== "string") return null;
       if (
         data.blockIndex !== null &&
@@ -176,14 +214,17 @@ export function parsePreviewMessage(data: unknown): PreviewChannelMessage | null
         return null;
       }
       if (typeof data.quote !== "string" || typeof data.shift !== "boolean") return null;
+      const place = readGrabPlace(data);
+      if (blockId === null && !normalizePointerQuote(data.quote) && !place.component && !place.file) return null;
       return {
         type: "backmatter:grab",
         ...envelope,
-        blockId: data.blockId,
+        blockId,
         blockType: data.blockType,
         blockIndex: data.blockIndex,
         quote: normalizePointerQuote(data.quote),
         shift: data.shift,
+        ...place,
       };
     }
     case "backmatter:highlight": {