@fileverse-dev/dsheet 3.0.1 → 3.0.2-29July-1

package/dist/editor/utils/apply-comment-markers.d.ts

@@ -0,0 +1,22 @@
+type CommentData = object | null | undefined;
+/**
+ * Stamps the in-cell comment marker (`cell.ps`) onto sheet data, derived from
+ * the consumer-provided `commentData`.
+ *
+ * `ps` is a per-client, permission-gated *view overlay* — it is NOT persisted in
+ * ydoc. Every path that rebuilds sheet data from ydoc (portal load, collab sync
+ * remount, remote cell edits) produces cells WITHOUT `ps`, so this must run on
+ * each such snapshot or the red-triangle indicator vanishes. Because it is
+ * gated on the local `allowComments` permission, it must never be written back
+ * to shared ydoc state — doing so would let one viewer wipe markers for all.
+ *
+ * Handles both shapes:
+ * - Dense `sheet.data` (the live active sheet in `luckysheetfile`).
+ * - Sparse `sheet.celldata` (plain snapshots from `ySheetArrayToPlain`, and
+ *   inactive sheets). `initSheetData()` converts celldata → data on activation,
+ *   so `ps` set on celldata carries through.
+ *
+ * Mutates in place and returns the same array.
+ */
+export declare const applyCommentMarkers: <T>(sheets: T | null | undefined, commentData: CommentData, allowComments: boolean | undefined) => T | null | undefined;
+export {};