@restregular/dsh-notepad 0.1.0 → 0.2.0

package/index.js

@@ -28,7 +28,7 @@ import {
 const ROUTE = '/dsh-notepad/api';
 
 /** Plugin version mirrored in package.json. */
-const VERSION = '0.1.0';
+const VERSION = '0.2.0';
 
 /** Request body cap. */
 const BODY_LIMIT = 1024 * 1024;
@@ -218,7 +218,9 @@ async function dispatchRequest(ctx, req, res) {
   if (req.method === 'PUT') {
     const body = await readJsonBody(req);
     const root = await resolveRequestRoot(ctx, body);
-    const note = await writeNote(root, body.text, { maxBytes: DEFAULT_MAX_BYTES });
+    const note = await writeNote(root, Array.isArray(body.segments) ? body.segments : body.text, {
+      maxBytes: DEFAULT_MAX_BYTES,
+    });
     sendJson(res, { ok: true, root, ...note });
     return;
   }

package/lib/note-store.js

@@ -1,11 +1,14 @@
 /**
  * dsh-notepad — workspace note storage.
  *
- * One plain-text note per workspace, kept at `<workspace>/.dsh/notepad.json`.
- * The JSON envelope lets the file carry its own `updatedAt` while still
- * degrading gracefully: if the file is not JSON (a user or another tool
- * edited it by hand), the raw bytes are returned as the note text instead of
- * losing the content.
+ * One note per workspace, kept at `<workspace>/.dsh/notepad.json`. A note is an
+ * ordered list of text segments; each segment may be archived after it was
+ * sent, and only archived segments can be deleted by the client.
+ *
+ * Version 2 stores the segment list under `segments` and repeats the merged
+ * body under `text` so the file stays human readable and older builds can
+ * still read the content. Version 1 files (a single `text`) and hand-edited
+ * plain-text files are migrated on read as one segment.
  *
  * @module dsh-notepad/lib/note-store
  */
@@ -20,11 +23,17 @@ export const NOTE_DIR = '.dsh';
 /** File name inside {@link NOTE_DIR}. */
 export const NOTE_FILE = 'notepad.json';
 
-/** Default maximum note size (UTF-8 bytes). */
+/** Default maximum note file size (UTF-8 bytes). */
 export const DEFAULT_MAX_BYTES = 512 * 1024;
 
+/** Maximum number of segments accepted from the client. */
+export const MAX_SEGMENTS = 200;
+
+/** Maximum characters in one segment. */
+export const MAX_SEGMENT_CHARS = 160_000;
+
 /** Storage envelope version. */
-export const NOTE_VERSION = 1;
+export const NOTE_VERSION = 2;
 
 /** A note-store failure with a stable machine-readable code. */
 export class NoteStoreError extends Error {
@@ -47,25 +56,139 @@ export function notePath(root) {
   return path.join(root, NOTE_DIR, NOTE_FILE);
 }
 
+/**
+ * Normalize one segment read from disk. Reading is forgiving: a malformed
+ * entry is skipped instead of making the whole note unreadable.
+ * @param {unknown} value
+ * @param {number} index
+ * @param {Set<string>} seen
+ * @returns {{id: string, text: string, archived: boolean, archivedAt: string | null} | null}
+ */
+function readSegment(value, index, seen) {
+  if (typeof value === 'string') value = { text: value };
+  if (value === null || typeof value !== 'object') return null;
+  if (typeof value.text !== 'string') return null;
+  const text = value.text;
+  let id = typeof value.id === 'string' && value.id !== '' ? value.id.slice(0, 128) : `seg-${index + 1}`;
+  let suffix = 1;
+  while (seen.has(id)) {
+    id = `${id}-${suffix}`;
+    suffix += 1;
+  }
+  seen.add(id);
+  const archived = value.archived === true;
+  const archivedAt = archived && typeof value.archivedAt === 'string' && value.archivedAt !== ''
+    ? value.archivedAt
+    : null;
+  return { id, text, archived, archivedAt };
+}
+
+/**
+ * Normalize a segment list for a write. Unlike {@link readSegment}, malformed
+ * entries are an input error here: the route must not silently drop content.
+ *
+ * Accepts the modern `segments` array, a single legacy text string, or
+ * `{ text }`.
+ *
+ * @param {unknown} input
+ * @returns {Array<{id: string, text: string, archived: boolean, archivedAt: string | null}>}
+ */
+export function normalizeSegments(input) {
+  if (typeof input === 'string') {
+    if (input === '') return [];
+    return [{ id: 'seg-1', text: input, archived: false, archivedAt: null }];
+  }
+  if (input !== null && typeof input === 'object' && !Array.isArray(input)) {
+    if (Array.isArray(input.segments)) return normalizeSegments(input.segments);
+    if (typeof input.text === 'string') return normalizeSegments(input.text);
+    throw new NoteStoreError('bad-input', 'Note must be a string or a segments array.');
+  }
+  if (!Array.isArray(input)) {
+    throw new NoteStoreError('bad-input', 'Note must be a string or a segments array.');
+  }
+  if (input.length > MAX_SEGMENTS) {
+    throw new NoteStoreError('too-many', `Too many segments (${input.length}; limit ${MAX_SEGMENTS}).`);
+  }
+  const seen = new Set();
+  return input.map((value, index) => {
+    const segment = normalizeWriteSegment(value, index, seen);
+    return segment;
+  });
+}
+
+/**
+ * Strict per-segment normalization for writes.
+ * @param {unknown} value
+ * @param {number} index
+ * @param {Set<string>} seen
+ */
+function normalizeWriteSegment(value, index, seen) {
+  if (typeof value === 'string') value = { text: value };
+  if (value === null || typeof value !== 'object' || Array.isArray(value)) {
+    throw new NoteStoreError('bad-input', `Segment ${index + 1} is not an object.`);
+  }
+  if (typeof value.text !== 'string') {
+    throw new NoteStoreError('bad-input', `Segment ${index + 1} has no text field.`);
+  }
+  if (value.text.length > MAX_SEGMENT_CHARS) {
+    throw new NoteStoreError(
+      'too-large',
+      `Segment ${index + 1} is too large (${value.text.length} characters; limit ${MAX_SEGMENT_CHARS}).`,
+    );
+  }
+  let id = typeof value.id === 'string' && value.id !== '' ? value.id.slice(0, 128) : `seg-${index + 1}`;
+  let suffix = 1;
+  while (seen.has(id)) {
+    id = `${id}-${suffix}`;
+    suffix += 1;
+  }
+  seen.add(id);
+  const archived = value.archived === true;
+  const archivedAt = archived && typeof value.archivedAt === 'string' && value.archivedAt !== ''
+    ? value.archivedAt
+    : null;
+  return { id, text: value.text, archived, archivedAt };
+}
+
+/**
+ * Merge segments into the plain body stored next to the list.
+ * @param {Array<{text: string}>} segments
+ */
+export function mergeSegments(segments) {
+  return segments.map((segment) => segment.text).join('\n\n');
+}
+
 /**
  * Decode a stored note file.
  * @param {string} raw file contents
  * @param {number | undefined} mtimeMs
  */
 export function parseNote(raw, mtimeMs) {
-  let text = raw;
+  let segmentsInput;
   let updatedAt;
   try {
     const parsed = JSON.parse(raw);
-    if (parsed !== null && typeof parsed === 'object' && typeof parsed.text === 'string') {
-      text = parsed.text;
+    if (parsed !== null && typeof parsed === 'object') {
+      if (Array.isArray(parsed.segments)) segmentsInput = parsed.segments;
+      else if (typeof parsed.text === 'string') segmentsInput = parsed.text;
       if (typeof parsed.updatedAt === 'string') updatedAt = parsed.updatedAt;
     }
   } catch {
     /* Not our envelope: keep the raw text. */
   }
+  if (segmentsInput === undefined) segmentsInput = raw;
+  const seen = new Set();
+  const segments = [];
+  const values = typeof segmentsInput === 'string'
+    ? (segmentsInput === '' ? [] : [segmentsInput])
+    : Array.isArray(segmentsInput) ? segmentsInput : [];
+  for (const value of values) {
+    const segment = readSegment(value, segments.length, seen);
+    if (segment !== null) segments.push(segment);
+  }
   return {
-    text,
+    segments,
+    text: mergeSegments(segments),
     updatedAt: updatedAt ?? (typeof mtimeMs === 'number' ? new Date(mtimeMs).toISOString() : null),
     mtimeMs: typeof mtimeMs === 'number' ? mtimeMs : null,
     exists: true,
@@ -76,7 +199,7 @@ export function parseNote(raw, mtimeMs) {
 /**
  * Read one workspace note. A missing file is an empty note, not an error.
  * @param {string} root workspace root
- * @returns {Promise<{text: string, updatedAt: string | null, mtimeMs: number | null, exists: boolean, size: number}>}
+ * @returns {Promise<{segments: Array<{id: string, text: string, archived: boolean, archivedAt: string | null}>, text: string, updatedAt: string | null, mtimeMs: number | null, exists: boolean, size: number}>}
  */
 export async function readNote(root) {
   const file = notePath(root);
@@ -85,7 +208,7 @@ export async function readNote(root) {
     raw = await fs.readFile(file, 'utf8');
   } catch (error) {
     if (error?.code === 'ENOENT') {
-      return { text: '', updatedAt: null, mtimeMs: null, exists: false, size: 0 };
+      return { segments: [], text: '', updatedAt: null, mtimeMs: null, exists: false, size: 0 };
     }
     throw error;
   }
@@ -100,25 +223,34 @@ export async function readNote(root) {
 }
 
 /**
- * Replace one workspace note atomically.
+ * Replace one workspace note atomically. Accepts either a segment array or a
+ * legacy plain-text string.
  * @param {string} root workspace root
- * @param {string} text note body
+ * @param {unknown} note segments array or legacy text
  * @param {{ maxBytes?: number }} [options]
  */
-export async function writeNote(root, text, options = {}) {
-  if (typeof text !== 'string') {
-    throw new NoteStoreError('bad-input', 'Note text must be a string.');
-  }
+export async function writeNote(root, note, options = {}) {
+  const segments = normalizeSegments(note);
   const maxBytes = Number.isFinite(options.maxBytes) ? options.maxBytes : DEFAULT_MAX_BYTES;
-  const size = Buffer.byteLength(text, 'utf8');
+  const dir = path.join(root, NOTE_DIR);
+  const file = path.join(dir, NOTE_FILE);
+  const updatedAt = new Date().toISOString();
+  const payload = `${JSON.stringify({
+    version: NOTE_VERSION,
+    segments: segments.map((segment) => ({
+      id: segment.id,
+      text: segment.text,
+      ...(segment.archived ? { archived: true } : {}),
+      ...(segment.archivedAt ? { archivedAt: segment.archivedAt } : {}),
+    })),
+    text: mergeSegments(segments),
+    updatedAt,
+  }, null, 2)}\n`;
+  const size = Buffer.byteLength(payload, 'utf8');
   if (size > maxBytes) {
     throw new NoteStoreError('too-large', `Note is too large (${size} bytes; limit ${maxBytes} bytes).`);
   }
-  const dir = path.join(root, NOTE_DIR);
-  const file = path.join(dir, NOTE_FILE);
   await fs.mkdir(dir, { recursive: true });
-  const updatedAt = new Date().toISOString();
-  const payload = `${JSON.stringify({ version: NOTE_VERSION, text, updatedAt }, null, 2)}\n`;
   const tmp = path.join(dir, `.${NOTE_FILE}.${process.pid}.${randomBytes(4).toString('hex')}.tmp`);
   await fs.writeFile(tmp, payload, 'utf8');
   try {
@@ -129,7 +261,8 @@ export async function writeNote(root, text, options = {}) {
   }
   const stat = await fs.stat(file);
   return {
-    text,
+    segments,
+    text: mergeSegments(segments),
     updatedAt,
     mtimeMs: stat.mtimeMs,
     exists: true,

package/locale/en.json

@@ -1,6 +1,6 @@
 {
   "meta": {
     "title": "Notepad",
-    "description": "A per-workspace floating notepad in the session view: jot down problems and next steps, insert the note into the composer with one click, drag, minimize, and hide."
+    "description": "A per-workspace floating notepad in the session view. Enter creates segment cards; insert, replace, or send one or many; sending archives automatically. Archived segments can be shown, hidden, restored, and deleted. Resizable and dark-mode aware."
   }
 }

package/locale/zh.json

@@ -1,6 +1,6 @@
 {
   "meta": {
     "title": "记事本",
-    "description": "在会话界面显示一个按工作区共享的文本浮窗：记录问题与下一步，一键插入输入框，支持拖拽、最小化和快捷键隐藏。"
+    "description": "在会话界面显示一个按工作区共享的分段便签浮窗：回车新建分段，支持单段/多段插入、替换和发送，发送后自动归档；归档可显示、隐藏、恢复与删除，浮窗可调整尺寸并适配深色模式。"
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@restregular/dsh-notepad",
-  "version": "0.1.0",
-  "description": "Notepad — a per-workspace floating note window in the DeepSeek Harness session view: jot down problems and next steps, insert the note into the composer with one click, drag, minimize, and hide. · 记事本 — 在 DeepSeek Harness 会话界面显示一个按工作区共享的文本浮窗：记录问题与下一步，一键插入输入框，支持拖拽、最小化和快捷键隐藏。",
+  "version": "0.2.0",
+  "description": "Notepad — a per-workspace floating notepad in the DeepSeek Harness session view: Enter creates segment cards, batch insert / replace / send, sending archives segments, archive management, resizable panel and dark-mode styling. · 记事本 — 在 DeepSeek Harness 会话界面显示一个按工作区共享的分段便签浮窗：回车新建分段卡片，支持单段/多段插入、替换与发送，发送自动归档，归档可显示隐藏和恢复删除，可调整尺寸并适配深色模式。",
   "icon": "./icon.svg",
   "type": "module",
   "main": "index.js",