@restregular/dsh-notepad 0.3.0 → 0.4.0

package/index.js

@@ -22,6 +22,7 @@ import path from 'node:path';
 import {
   IMAGE_TYPES,
   MAX_IMAGE_BYTES,
+  deleteStoredImage,
   saveClipboardImage,
 } from './lib/image-store.js';
 import {
@@ -29,6 +30,7 @@ import {
   NOTE_VERSION,
   NoteStoreError,
   readNote,
+  unsentCount,
   writeNote,
 } from './lib/note-store.js';
 
@@ -36,7 +38,7 @@ import {
 const ROUTE = '/dsh-notepad/api';
 
 /** Plugin version mirrored in package.json. */
-const VERSION = '0.3.0';
+const VERSION = '0.4.0';
 
 /** Request body cap for note writes. */
 const BODY_LIMIT = 1024 * 1024;
@@ -44,6 +46,24 @@ const BODY_LIMIT = 1024 * 1024;
 /** Request body cap for base64 image uploads (decoded cap + base64 overhead). */
 const IMAGE_BODY_LIMIT = Math.ceil((MAX_IMAGE_BYTES * 4) / 3) + 64 * 1024;
 
+/** Longest segment accepted by the AI optimizer. */
+const MAX_OPTIMIZE_CHARS = 60_000;
+
+/** End-to-end deadline for one AI optimization. */
+const OPTIMIZE_TIMEOUT_MS = 120_000;
+
+/** Default output cap for one optimized segment. */
+const OPTIMIZE_MAX_TOKENS = 4096;
+
+/** Shared instruction for the optional writing assistant. */
+const OPTIMIZE_SYSTEM = [
+  'You are a writing assistant for a developer notepad.',
+  'Rewrite the user\'s note so it is clearer, more concise, and better organized,',
+  'while preserving its original language, meaning, technical facts, Markdown,',
+  'code, file paths, and image links. Never invent facts or drop information.',
+  'Return only the rewritten note text: no preamble, no explanation, and no code fence.',
+].join(' ');
+
 // ---------------------------------------------------------------------------
 // HTTP helpers
 // ---------------------------------------------------------------------------
@@ -174,6 +194,131 @@ async function isKnownRoot(ctx, root, sessionId) {
   return false;
 }
 
+/**
+ * Count pending segments for every registered workspace. The sidebar badge
+ * only needs counts, so this route never returns note text or image paths.
+ * @param {import('@deepseek-ai/cordis').Context} ctx
+ * @returns {Promise<Array<{id: string, path: string, title: string, count: number}>>}
+ */
+async function listUnsentCounts(ctx) {
+  const registry = ctx.get('workspaceRegistry');
+  const list = registry !== undefined && typeof registry.list === 'function' ? registry.list() : [];
+  if (!Array.isArray(list)) return [];
+  const out = [];
+  for (const workspace of list) {
+    const root = typeof workspace?.path === 'string' ? workspace.path : '';
+    if (root === '') continue;
+    let count = 0;
+    try {
+      count = unsentCount(await readNote(root));
+    } catch {
+      // A workspace directory may have disappeared; keep the other badges.
+      count = 0;
+    }
+    out.push({
+      id: String(workspace.id ?? workspace.workspaceId ?? ''),
+      path: root,
+      title: typeof workspace.title === 'string' ? workspace.title : '',
+      count,
+    });
+  }
+  return out;
+}
+
+/**
+ * Strip a surrounding Markdown code fence the model may add despite the
+ * instruction, then trim. Inner code fences survive.
+ * @param {string} value
+ * @returns {string}
+ */
+function cleanOptimizedText(value) {
+  let text = String(value ?? '').replace(/^\uFEFF/u, '').trim();
+  const fenced = /^```[^\n]*\r?\n([\s\S]*?)\r?\n```$/u.exec(text);
+  if (fenced !== null) text = fenced[1].trim();
+  return text;
+}
+
+/**
+ * Ask the currently selected default model to improve one note segment.
+ * The LLM service is optional: a deployment without one reports a stable
+ * `unavailable` code instead of failing the whole notepad.
+ * @param {import('@deepseek-ai/cordis').Context} ctx
+ * @param {string} text
+ * @param {string} title
+ * @returns {Promise<string>}
+ */
+async function optimizeText(ctx, text, title) {
+  const llm = ctx.get('llm');
+  if (llm === undefined || llm === null || typeof llm.prepareCall !== 'function'
+    || typeof llm.resolveCallConfig !== 'function') {
+    throw new NoteStoreError('unavailable', 'The AI model service is not available.');
+  }
+  const defaultModel = ctx.get('agentDefaultModel');
+  if (defaultModel === undefined || defaultModel === null || typeof defaultModel.currentSelection !== 'function') {
+    throw new NoteStoreError('unavailable', 'No default model is configured.');
+  }
+  let selection;
+  try {
+    selection = defaultModel.currentSelection();
+  } catch (error) {
+    throw new NoteStoreError('unavailable', `No default model is configured: ${error?.message ?? error}`);
+  }
+  if (selection === undefined || selection === null
+    || typeof selection.provider !== 'string' || selection.provider === ''
+    || typeof selection.model !== 'string' || selection.model === '') {
+    throw new NoteStoreError('unavailable', 'No default model is configured.');
+  }
+  const signal = AbortSignal.timeout(OPTIMIZE_TIMEOUT_MS);
+  const maxTokens = Math.min(8192, Math.max(1024, Math.ceil(text.length / 2)));
+  let base;
+  try {
+    base = await llm.resolveCallConfig({
+      provider: selection.provider,
+      model: selection.model,
+      maxTokens,
+    });
+  } catch (error) {
+    throw new NoteStoreError('llm-failed', `Could not prepare the model call: ${error?.message ?? error}`);
+  }
+  if (typeof base !== 'object' || base === null) {
+    throw new NoteStoreError('llm-failed', 'The model call configuration is empty.');
+  }
+  const heading = title.trim() === '' ? '' : `Card title: ${title.trim()}\n\n`;
+  const prompt = `${heading}Rewrite this note:\n\n${text}`;
+  let output = '';
+  try {
+    const prepared = await llm.prepareCall(base, signal);
+    for await (const chunk of prepared.stream({
+      ...base,
+      system: OPTIMIZE_SYSTEM,
+      messages: [{
+        role: 'user',
+        content: [{ type: 'text', text: prompt }],
+      }],
+      signal,
+    })) {
+      if (chunk?.type === 'text-delta' && typeof chunk.text === 'string') output += chunk.text;
+      else if (chunk?.type === 'finish' && chunk.reason?.kind === 'error') {
+        const failure = chunk.reason.failure;
+        throw new NoteStoreError('llm-failed', `The model call failed: ${failure?.message ?? 'unknown error'}`);
+      } else if (chunk?.type === 'finish' && chunk.reason?.kind === 'aborted') {
+        throw new NoteStoreError('timeout', 'The model did not answer in time.');
+      }
+    }
+  } catch (error) {
+    if (error instanceof NoteStoreError) throw error;
+    if (error?.name === 'AbortError' || error?.name === 'TimeoutError') {
+      throw new NoteStoreError('timeout', 'The model did not answer in time.');
+    }
+    throw new NoteStoreError('llm-failed', `The model call failed: ${error?.message ?? error}`);
+  }
+  const cleaned = cleanOptimizedText(output);
+  if (cleaned === '') {
+    throw new NoteStoreError('llm-failed', 'The model returned no text.');
+  }
+  return cleaned;
+}
+
 // ---------------------------------------------------------------------------
 // Route
 // ---------------------------------------------------------------------------
@@ -190,9 +335,12 @@ export async function handleRequest(ctx, req, res) {
   } catch (error) {
     if (error instanceof NoteStoreError) {
       let status = 400;
-      if (error.code === 'unknown-workspace' || error.code === 'bad-root') status = 403;
+      if (error.code === 'unknown-workspace' || error.code === 'bad-root' || error.code === 'not-owned') status = 403;
       else if (error.code === 'too-large') status = 413;
       else if (error.code === 'unsupported-type') status = 415;
+      else if (error.code === 'unavailable') status = 503;
+      else if (error.code === 'timeout') status = 504;
+      else if (error.code === 'llm-failed') status = 502;
       sendJson(res, { ok: false, code: error.code, error: error.message }, status);
       return;
     }
@@ -230,18 +378,55 @@ async function dispatchRequest(ctx, req, res) {
     return;
   }
   if (action === 'image') {
+    if (req.method === 'POST') {
+      const body = await readJsonBody(req, IMAGE_BODY_LIMIT);
+      const root = await resolveRequestRoot(ctx, body);
+      const image = await saveClipboardImage(root, {
+        name: body.name,
+        mime: body.mime,
+        data: body.data,
+      });
+      sendJson(res, { ok: true, root, ...image });
+      return;
+    }
+    if (req.method === 'DELETE') {
+      const body = await readJsonBody(req);
+      const root = await resolveRequestRoot(ctx, body);
+      const result = await deleteStoredImage(root, body.path);
+      sendJson(res, { ok: true, root, ...result });
+      return;
+    }
+    sendJson(res, { ok: false, code: 'method', error: 'Use POST or DELETE.' }, 405);
+    return;
+  }
+  if (action === 'unsent') {
+    if (req.method !== 'GET') {
+      sendJson(res, { ok: false, code: 'method', error: 'Use GET.' }, 405);
+      return;
+    }
+    const workspaces = await listUnsentCounts(ctx);
+    sendJson(res, { ok: true, workspaces });
+    return;
+  }
+  if (action === 'optimize') {
     if (req.method !== 'POST') {
       sendJson(res, { ok: false, code: 'method', error: 'Use POST.' }, 405);
       return;
     }
-    const body = await readJsonBody(req, IMAGE_BODY_LIMIT);
+    const body = await readJsonBody(req);
     const root = await resolveRequestRoot(ctx, body);
-    const image = await saveClipboardImage(root, {
-      name: body.name,
-      mime: body.mime,
-      data: body.data,
-    });
-    sendJson(res, { ok: true, root, ...image });
+    const text = typeof body.text === 'string' ? body.text : '';
+    if (text.trim() === '') {
+      throw new NoteStoreError('bad-input', 'There is no text to optimize.');
+    }
+    if (text.length > MAX_OPTIMIZE_CHARS) {
+      throw new NoteStoreError(
+        'too-large',
+        `Segment is too large to optimize (${text.length} characters; limit ${MAX_OPTIMIZE_CHARS}).`,
+      );
+    }
+    const optimized = await optimizeText(ctx, text, typeof body.title === 'string' ? body.title : '');
+    sendJson(res, { ok: true, root, text: optimized });
     return;
   }
   if (action !== 'note') {

package/lib/image-store.js

@@ -129,6 +129,55 @@ function displayName(name) {
   return cleaned === '' ? 'image' : cleaned;
 }
 
+/**
+ * Absolute plugin-owned image directory for one workspace.
+ * @param {string} root workspace root
+ * @returns {string}
+ */
+export function imageDirOf(root) {
+  return path.join(root, ...IMAGE_DIR.split('/'));
+}
+
+/**
+ * Delete one image previously stored under the plugin directory.
+ *
+ * The client may only remove files this plugin owns: the resolved target must
+ * be a regular file inside {@link IMAGE_DIR}. Paths outside that directory are
+ * refused instead of being passed to `fs.rm`.
+ *
+ * @param {string} root workspace root
+ * @param {unknown} pathValue workspace-relative or absolute image path
+ * @returns {Promise<{deleted: boolean}>}
+ */
+export async function deleteStoredImage(root, pathValue) {
+  if (typeof pathValue !== 'string' || pathValue.trim() === '') {
+    throw new NoteStoreError('bad-input', 'Image path is required.');
+  }
+  const dir = imageDirOf(root);
+  const resolved = path.resolve(root, pathValue.replace(/\\/gu, '/'));
+  const relative = path.relative(dir, resolved);
+  if (relative === '' || relative.startsWith('..') || path.isAbsolute(relative)) {
+    throw new NoteStoreError('not-owned', 'Only images stored by the notepad can be deleted.');
+  }
+  let stat;
+  try {
+    stat = await fs.lstat(resolved);
+  } catch (error) {
+    if (error?.code === 'ENOENT') return { deleted: false };
+    throw error;
+  }
+  if (!stat.isFile()) {
+    throw new NoteStoreError('not-owned', 'Only regular image files can be deleted.');
+  }
+  try {
+    await fs.unlink(resolved);
+  } catch (error) {
+    if (error?.code === 'ENOENT') return { deleted: false };
+    throw error;
+  }
+  return { deleted: true };
+}
+
 /**
  * Save one pasted image under the plugin directory.
  *
@@ -155,7 +204,7 @@ export async function saveClipboardImage(root, input) {
   const extension = IMAGE_TYPES[declared];
   const name = displayName(input?.name);
   const stem = fileStem(name);
-  const dir = path.join(root, ...IMAGE_DIR.split('/'));
+  const dir = imageDirOf(root);
   await fs.mkdir(dir, { recursive: true });
   const fileName = `${Date.now().toString(36)}-${randomBytes(4).toString('hex')}-${stem}.${extension}`;
   const file = path.join(dir, fileName);

package/lib/note-store.js

@@ -5,10 +5,11 @@
  * 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.
+ * Version 4 adds an optional card title and creation timestamp to every
+ * segment. 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
  */
@@ -32,8 +33,14 @@ export const MAX_SEGMENTS = 200;
 /** Maximum characters in one segment. */
 export const MAX_SEGMENT_CHARS = 160_000;
 
+/** Maximum characters kept for one segment title. */
+export const MAX_SEGMENT_TITLE_CHARS = 200;
+
+/** Maximum characters kept for one creation timestamp. */
+export const MAX_SEGMENT_TIME_CHARS = 64;
+
 /** Storage envelope version. */
-export const NOTE_VERSION = 3;
+export const NOTE_VERSION = 4;
 
 /** Maximum image references accepted on one segment. */
 export const MAX_IMAGES_PER_SEGMENT = 20;
@@ -184,7 +191,7 @@ export function segmentBody(segment) {
  * @param {unknown} value
  * @param {number} index
  * @param {Set<string>} seen
- * @returns {{id: string, text: string, images: Array<{path: string, name: string}>, archived: boolean, archivedAt: string | null} | null}
+ * @returns {{id: string, text: string, title: string, createdAt: string | null, images: Array<{path: string, name: string}>, archived: boolean, archivedAt: string | null} | null}
  */
 function readSegment(value, index, seen) {
   if (typeof value === 'string') value = { text: value };
@@ -199,11 +206,15 @@ function readSegment(value, index, seen) {
     suffix += 1;
   }
   seen.add(id);
+  const title = typeof value.title === 'string' ? value.title.slice(0, MAX_SEGMENT_TITLE_CHARS) : '';
+  const createdAt = typeof value.createdAt === 'string' && value.createdAt !== ''
+    ? value.createdAt.slice(0, MAX_SEGMENT_TIME_CHARS)
+    : null;
   const archived = value.archived === true;
   const archivedAt = archived && typeof value.archivedAt === 'string' && value.archivedAt !== ''
     ? value.archivedAt
     : null;
-  return { id, text, images, archived, archivedAt };
+  return { id, text, title, createdAt, images, archived, archivedAt };
 }
 
 /**
@@ -219,7 +230,7 @@ function readSegment(value, index, seen) {
 export function normalizeSegments(input) {
   if (typeof input === 'string') {
     if (input === '') return [];
-    return [{ id: 'seg-1', text: input, images: [], archived: false, archivedAt: null }];
+    return [{ id: 'seg-1', text: input, title: '', createdAt: null, images: [], archived: false, archivedAt: null }];
   }
   if (input !== null && typeof input === 'object' && !Array.isArray(input)) {
     if (Array.isArray(input.segments)) return normalizeSegments(input.segments);
@@ -271,7 +282,61 @@ function normalizeWriteSegment(value, index, seen) {
   const archivedAt = archived && typeof value.archivedAt === 'string' && value.archivedAt !== ''
     ? value.archivedAt
     : null;
-  return { id, text: value.text, images, archived, archivedAt };
+  const title = value.title === undefined || value.title === null
+    ? ''
+    : typeof value.title === 'string'
+      ? value.title.slice(0, MAX_SEGMENT_TITLE_CHARS)
+      : invalidTitle(index);
+  const createdAt = value.createdAt === undefined || value.createdAt === null
+    ? null
+    : typeof value.createdAt === 'string'
+      ? value.createdAt.slice(0, MAX_SEGMENT_TIME_CHARS)
+      : invalidCreatedAt(index);
+  return { id, text: value.text, title, createdAt, images, archived, archivedAt };
+}
+
+/**
+ * @param {number} index
+ * @returns {never}
+ */
+function invalidTitle(index) {
+  throw new NoteStoreError('bad-input', `Segment ${index + 1} title is not a string.`);
+}
+
+/**
+ * @param {number} index
+ * @returns {never}
+ */
+function invalidCreatedAt(index) {
+  throw new NoteStoreError('bad-input', `Segment ${index + 1} createdAt is not a string.`);
+}
+
+/**
+ * Whether one segment still counts as unsent work: it is active and carries
+ * text or at least one image. Archived segments were already sent or filed
+ * away, so they never contribute to the pending badge.
+ * @param {{text?: string, images?: unknown[], archived?: boolean}} segment
+ * @returns {boolean}
+ */
+export function isUnsentSegment(segment) {
+  if (segment === null || typeof segment !== 'object' || segment.archived === true) return false;
+  const text = typeof segment.text === 'string' ? segment.text : '';
+  const images = Array.isArray(segment.images) ? segment.images : [];
+  return text.trim() !== '' || images.length > 0;
+}
+
+/**
+ * Number of pending segments in one decoded note.
+ * @param {{segments?: Array<{text?: string, images?: unknown[], archived?: boolean}>}} note
+ * @returns {number}
+ */
+export function unsentCount(note) {
+  const segments = Array.isArray(note?.segments) ? note.segments : [];
+  let count = 0;
+  for (const segment of segments) {
+    if (isUnsentSegment(segment)) count += 1;
+  }
+  return count;
 }
 
 /**
@@ -367,6 +432,8 @@ export async function writeNote(root, note, options = {}) {
     segments: segments.map((segment) => ({
       id: segment.id,
       text: segment.text,
+      ...(segment.title !== '' ? { title: segment.title } : {}),
+      ...(segment.createdAt !== null ? { createdAt: segment.createdAt } : {}),
       ...(segment.images.length > 0
         ? { images: segment.images.map((image) => ({ path: image.path, name: image.name })) }
         : {}),

package/locale/en.json

@@ -1,6 +1,6 @@
 {
   "meta": {
     "title": "Notepad",
-    "description": "A per-workspace floating notepad in the session view. Enter creates segment cards; paste or pick images as path-based attachment chips; insert, replace, or send one or many; sending archives automatically. Archived segments can be shown, hidden, restored, and deleted. Resizable and dark-mode aware."
+    "description": "A per-workspace floating notepad in the session view. New segment cards lead the list, each card has an editable title; click an index to select, drag to reorder, merge a selection, and improve one or all cards with AI. Paste or pick images as path-based chips; removing a chip cleans up plugin-owned files. Pending counts appear on the hidden launcher and the sidebar workspace row. 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": "在会话界面显示一个按工作区共享的分段便签浮窗：新分段置顶，标题可编辑，点击序号选中，可拖拽排序、合并多段并用 AI 优化单段或全部；支持粘贴或选择图片并以路径附件形式引入，删除图片芯片会清理插件目录里的文件；隐藏按钮和侧边栏工作区显示未发送数量角标；支持单段/多段插入、替换与发送，发送后自动归档，归档可显示、隐藏、恢复与删除，浮窗可调整尺寸并适配深色模式。"
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@restregular/dsh-notepad",
-  "version": "0.3.0",
-  "description": "Notepad — a per-workspace floating notepad in the DeepSeek Harness session view: Enter creates segment cards, paste or pick images as inline attachment chips, batch insert / replace / send, sending archives segments, archive management, resizable panel and dark-mode styling. · 记事本 — 在 DeepSeek Harness 会话界面显示一个按工作区共享的分段便签浮窗：回车新建分段卡片，可粘贴或选择图片并以路径附件形式引入，支持单段/多段插入、替换与发送，发送自动归档，归档可显示隐藏和恢复删除，可调整尺寸并适配深色模式。",
+  "version": "0.4.0",
+  "description": "Notepad — a per-workspace floating notepad in the DeepSeek Harness session view: newest segment cards first with editable titles, drag to reorder, merge selected segments, AI improve one or all, click an index to select, image chips with automatic file cleanup, pending-count badges on the hidden button and the sidebar workspace, batch insert / replace / send, archive management, resizable panel and dark-mode styling. · 记事本 — 在 DeepSeek Harness 会话界面显示一个按工作区共享的分段便签浮窗：新分段置顶且标题可编辑，可拖拽排序、合并选中分段、AI 优化单段或全部、点击序号选中，图片芯片删除时自动清理磁盘文件，隐藏按钮与侧边栏工作区显示未发送数量角标，支持单段/多段插入、替换与发送，发送自动归档，归档可显示隐藏和恢复删除，可调整尺寸并适配深色模式。",
   "icon": "./icon.svg",
   "type": "module",
   "main": "index.js",