@qjysqjy/dsh-prompt-optimizer 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 QJYSQJY
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,84 @@
-# Temporary Holding Version
+# 提示词优化
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+在 DSH Web UI 输入框的工具行里加一个**优化**控件：把当前草稿就地改写为结构化提示词，回填输入框，并且可以一键还原原文。
+
+- 改写是**纯文本操作**：不执行工具、不发消息、不产生会话轮次。
+- 复用**当前会话自己的模型路由**，不需要额外配置 API Key 或供应商账号。
+- 只动**草稿**。附件与 `@` 引用芯片保持原样；草稿以斜杠命令开头时控件不生效。
+
+## 样子
+
+| 草稿已填 | 优化进行中（再点即取消） | 改写完成（点一下还原） |
+|---|---|---|
+| ![typed](./screenshots/composer-typed.jpg) | ![optimizing](./screenshots/toolrow-optimizing.jpg) | ![undo](./screenshots/toolrow-undo.jpg) |
+
+![plugin row](./screenshots/plugins-row.jpg)
+
+## 安装
+
+```text
+plugin_manager install_bundle @qjysqjy/dsh-prompt-optimizer
+```
+
+也可以在 **侧边栏 → 插件 → 添加插件** 里输入同一个包名。想跟最新提交就改用 `github:adonis797/dsh-qjysqjy#path:/packages/prompt-optimizer`；改代码则从本地克隆装，先在仓库根 `pnpm install`。
+
+装好刷新页面即可，控件出现在输入框工具行、模型选择器左侧。
+
+## 配置
+
+每个字段都可选，缺省走内置默认值。在 profile 的 `cordis.patch.yml` 里按行 id 覆盖：
+
+```yaml
+- id: qjysqjy-prompt-optimizer
+  config:
+    useContext: false
+    maxOutputTokens: 2048
+```
+
+| 字段 | 默认 | 含义 |
+|---|---|---|
+| `systemTemplate` | 内置 | 系统提示词。空字符串表示用内置契约。 |
+| `userTemplate` | 内置 | 首次改写的用户提示词，占位符 `{draft}`。 |
+| `revisionTemplate` | 内置 | 增量修订的用户提示词，占位符 `{draft}`、`{previous}`。 |
+| `contextTemplate` | 内置 | 携带上下文时追加的段落，占位符 `{context}`。 |
+| `useContext` | `true` | 是否把会话近期消息作为背景发给模型。关掉可省 token，也让改写只依据草稿。 |
+| `maxContextChars` | `2000` | 开启上下文时保留的字符数上限。 |
+| `maxDraftChars` | `12000` | 接受的最大草稿长度，超过直接拒绝且不调模型。 |
+| `maxOutputTokens` | `4096` | 单次改写的输出上限。 |
+| `provider` / `model` | 未设 | 可选的固定路由，两者同时设置才生效，用于停止跟随会话。 |
+
+## 行为
+
+| 状态 | 触发 | 控件 | 点击后 |
+|---|---|---|---|
+| idle | 首次渲染、还原之后 | ✨ | 发起优化 |
+| optimizing | ✨ 被按下 | 转圈 | **取消**——`fetch` 被 abort，Host 侧连带中断模型调用 |
+| done | 改写已回填 | ↩️ | 还原为捕获的原文 |
+| dirty | 回填后用户又编辑 | ↩️ 禁用，并多出一个 ✨ | 还原被拒绝；新 ✨ 基于当前编辑做增量修订 |
+
+几条钉住的规则：空草稿不发请求；请求期间用户继续输入，结果**被丢弃**而不是覆盖；还原绝不覆盖改写之后用户自己写的字；语言锁定，中文进中文出、英文进英文出。
+
+## HTTP 端点
+
+```text
+POST /__qjysqjy-prompt-optimizer/optimize
+请求：{ text: string, sessionId: string, previousResult?: string }
+响应：{ enhanced: string, language: string, provider: string, model: string }
+```
+
+空草稿、超长、缺 `sessionId` 一律 4xx 且不调模型；请求体上限 96 KiB；无可用路由返回 409，模型失败返回 502。
+
+## 开发
+
+```text
+lib/index.js     Host 半：路由、路由解析、模型调用
+lib/optimize.js  引擎：流收集、失败映射
+lib/prompt.js    纯函数：模板、清洗、语言判定
+lib/client.js    Client 半：槽位注册、状态机、样式
+```
+
+```text
+node --test test/unit.test.js test/client.test.mjs
+```
+
+Client 套件加载**真实的** `lib/client.js`，用最小 React 替身驱动，因此测的是发布出去的那份代码。

package/cordis.patch.yml

@@ -0,0 +1,6 @@
+# Host half of the prompt optimizer. Service access is declared by the module's
+# own `export const inject`; this row must NOT carry an `inject` field, because
+# a row-level `inject` would also lock the Client half out of its services.
+- insert:
+    - id: qjysqjy-prompt-optimizer
+      name: '@qjysqjy/dsh-prompt-optimizer'

package/icon.svg

@@ -0,0 +1,11 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" role="img" aria-label="Prompt optimizer">
+  <defs>
+    <linearGradient id="g" x1="0" y1="0" x2="1" y2="1">
+      <stop offset="0" stop-color="#5686fe"/>
+      <stop offset="1" stop-color="#8a5cf6"/>
+    </linearGradient>
+  </defs>
+  <rect x="2" y="2" width="60" height="60" rx="14" fill="#101725"/>
+  <path d="M26 16l4.4 11.6L42 32l-11.6 4.4L26 48l-4.4-11.6L10 32l11.6-4.4L26 16z" fill="url(#g)"/>
+  <path d="M47 30l2.2 5.8 5.8 2.2-5.8 2.2L47 46l-2.2-5.8L39 38l5.8-2.2L47 30z" fill="#dbe4ff"/>
+</svg>

package/lib/client.js

@@ -0,0 +1,392 @@
+window.__ModuleLoader__.load({
+	id: "@qjysqjy/dsh-prompt-optimizer",
+	factory: (require) => {
+		const React = require("react");
+		const h = React.createElement;
+		/** Same-origin Host endpoint owned by this package's Host half. */
+		const OPTIMIZE_PATH = "/__qjysqjy-prompt-optimizer/optimize";
+		/** Locale namespace for this package's visible text. */
+		const NS = "qjysqjy-prompt-optimizer";
+		/** Stand-in InputState for a composition that supplies no `useInput`. */
+		const EMPTY_INPUT = { draft: "", phase: "plain", attachmentIds: [] };
+		/** Style element id, so two plugin generations cannot double-inject. */
+		const STYLE_ID = "@qjysqjy/dsh-prompt-optimizer/prompt-optimizer.css";
+
+		const zh = {
+			"action.optimize": "优化提示词",
+			"action.cancel": "取消优化",
+			"action.undo": "还原为改写前",
+			"action.refine": "基于我的修改继续优化",
+			"state.optimizing": "正在优化…",
+			"state.done": "已优化，可一键还原",
+			"state.dirty": "草稿已修改，原文还原已失效",
+			"hint.empty": "草稿为空，无需优化",
+			"hint.missing": "当前输入框未提供写入接口，无法回填优化结果",
+			"notice.discarded": "草稿在优化期间被修改，结果已丢弃",
+			"notice.unchanged": "优化结果与原文一致，无需还原",
+			"notice.failed": "优化失败",
+			"notice.cancelled": "已取消优化",
+		};
+		const en = {
+			"action.optimize": "Optimize prompt",
+			"action.cancel": "Cancel optimization",
+			"action.undo": "Restore original draft",
+			"action.refine": "Optimize again from your edit",
+			"state.optimizing": "Optimizing…",
+			"state.done": "Optimized; one click restores the original",
+			"state.dirty": "Draft edited; the original can no longer be restored",
+			"hint.empty": "The draft is empty; nothing to optimize",
+			"hint.missing": "This composer exposes no draft writer, so the result cannot be filled in",
+			"notice.discarded": "The draft changed while optimizing; the result was discarded",
+			"notice.unchanged": "The rewrite matched the draft, so there is nothing to restore",
+			"notice.failed": "Optimization failed",
+			"notice.cancelled": "Optimization cancelled",
+		};
+
+		const CSS = `
+.dspo-root{display:inline-flex;align-items:center;gap:2px;min-width:0}
+.dspo-button{
+  appearance:none;display:grid;place-items:center;width:28px;height:28px;flex:none;
+  padding:0;border:0;border-radius:999px;background:transparent;
+  color:var(--dsw-alias-label-secondary);cursor:pointer;
+  transition:background-color .1s,color .1s;
+}
+.dspo-button:hover:not(:disabled){background:var(--dsw-alias-interactive-bg-hover)}
+.dspo-button:focus-visible{outline:2px solid var(--dsw-alias-brand-primary);outline-offset:1px}
+.dspo-button:disabled{opacity:.4;cursor:default}
+.dspo-button[data-busy]{color:var(--dsw-alias-brand-primary);cursor:progress}
+.dspo-button[data-done]{color:var(--dsw-alias-brand-primary)}
+.dspo-button[data-stale]{opacity:.4;cursor:default}
+.dspo-spinner{animation:dspo-spin .8s linear infinite}
+@keyframes dspo-spin{to{transform:rotate(360deg)}}
+@media (prefers-reduced-motion:reduce){.dspo-spinner{animation-duration:2.4s}}
+.dspo-alert{
+  max-width:240px;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;
+  color:var(--dsw-alias-state-error-primary);font-size:12px;line-height:18px;
+}
+.dspo-notice{
+  max-width:240px;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;
+  color:var(--dsw-alias-label-secondary);font-size:12px;line-height:18px;
+}
+`;
+
+		/** Sparkle glyph: the "enhance" affordance. */
+		function IconSparkle(props) {
+			return h("svg", {
+				viewBox: "0 0 16 16", width: 16, height: 16, fill: "none",
+				"aria-hidden": true, focusable: "false", ...props,
+			}, h("path", {
+				d: "M6.5 1.8l1.05 2.9 2.9 1.05-2.9 1.05L6.5 9.7 5.45 6.8 2.55 5.75 5.45 4.7 6.5 1.8z",
+				fill: "currentColor",
+			}), h("path", {
+				d: "M12 9l.6 1.65 1.65.6-1.65.6L12 13.5l-.6-1.65-1.65-.6 1.65-.6L12 9z",
+				fill: "currentColor",
+			}));
+		}
+
+		/** Undo glyph: restore the original draft. */
+		function IconUndo(props) {
+			return h("svg", {
+				viewBox: "0 0 16 16", width: 16, height: 16, fill: "none",
+				"aria-hidden": true, focusable: "false", ...props,
+			}, h("path", {
+				d: "M6.2 4.2L2.6 7.8l3.6 3.6",
+				stroke: "currentColor", strokeWidth: "1.5",
+				strokeLinecap: "round", strokeLinejoin: "round",
+			}), h("path", {
+				d: "M2.8 7.8h6.1a3.4 3.4 0 0 1 0 6.8H6.6",
+				stroke: "currentColor", strokeWidth: "1.5",
+				strokeLinecap: "round", strokeLinejoin: "round",
+			}));
+		}
+
+		/** Spinner glyph while a request is in flight. */
+		function IconSpinner(props) {
+			return h("svg", {
+				className: "dspo-spinner",
+				viewBox: "0 0 16 16", width: 16, height: 16, fill: "none",
+				"aria-hidden": true, focusable: "false", ...props,
+			}, h("circle", {
+				cx: 8, cy: 8, r: 5.6,
+				stroke: "currentColor", strokeWidth: "1.8", strokeOpacity: "0.25",
+			}), h("path", {
+				d: "M13.6 8A5.6 5.6 0 0 0 8 2.4",
+				stroke: "currentColor", strokeWidth: "1.8", strokeLinecap: "round",
+			}));
+		}
+
+		/**
+		 * The optimize control.
+		 *
+		 * Four states, one primary button: idle (sparkle), optimizing (spinner,
+		 * press cancels), done (undo), and the implicit dirty state where an undo
+		 * would overwrite text the user wrote afterwards, so it is refused. A
+		 * second sparkle appears only while dirty, so an edited rewrite can still be
+		 * refined against the previous result.
+		 */
+		function PromptOptimizer(props) {
+			const { sessionId, inputActions, useInput } = props;
+			// The slot's declared `locale: NS` supplies `t`; `tFallback` keeps the
+			// control readable in a composition whose locale dictionary has not
+			// registered yet.
+			const t = typeof props.t === "function"
+				? props.t
+				: (typeof props.tFallback === "function" ? props.tFallback : (key) => en[key] ?? key);
+			// Hook order must not depend on which props arrived: `useInput` is a
+			// standard prop, but a silent undefined must still cost the same two
+			// hooks on every render.
+			const readInput = typeof useInput === "function" ? useInput : (selector) => selector(EMPTY_INPUT);
+			const draft = readInput((state) => state.draft);
+			const phase = readInput((state) => state.phase);
+			const [status, setStatus] = React.useState("idle");
+			const [rollback, setRollback] = React.useState(null);
+			const [error, setError] = React.useState("");
+			const [notice, setNotice] = React.useState("");
+
+			/** Latest draft, readable from an async continuation without stale props. */
+			const draftRef = React.useRef(draft);
+			draftRef.current = typeof draft === "string" ? draft : "";
+			/** The in-flight request, so a second press really aborts it. */
+			const requestRef = React.useRef(null);
+			const mountedRef = React.useRef(true);
+			React.useEffect(() => {
+				mountedRef.current = true;
+				return () => {
+					mountedRef.current = false;
+					requestRef.current?.abort();
+					requestRef.current = null;
+				};
+			}, []);
+
+			const canWrite = inputActions !== undefined && typeof inputActions.setDraft === "function";
+			// Only a plain draft is optimizable: a claimed slash command owns the
+			// leading chip, and a sending/submitting draft is read-only.
+			const writable = phase === undefined ? true : phase === "plain";
+			const current = draftRef.current;
+			const trimmed = current.trim();
+			const enhanced = rollback === null ? undefined : rollback.enhanced;
+			// Compare in the editor's own normalization so the draft the editor
+			// publishes right after a fill is not mistaken for a user edit: newline
+			// style and trailing whitespace per line are ignored, everything a user
+			// actually types is not.
+			const dirty = enhanced != null && normalizeDraft(current) !== normalizeDraft(enhanced);
+			const canUndo = enhanced != null && !dirty;
+			const optimizing = status === "optimizing";
+
+			/**
+			 * One optimization round trip.
+			 * @param {string} text - draft captured at request time.
+			 * @param {string | undefined} previous - earlier rewrite, for a revision.
+			 */
+			const optimize = async (text, previous) => {
+				if (canWrite === false) {
+					setError(t("hint.missing"));
+					return;
+				}
+				const snapshot = text;
+				const controller = new AbortController();
+				requestRef.current = controller;
+				setStatus("optimizing");
+				setError("");
+				setNotice("");
+				try {
+					const response = await fetch(OPTIMIZE_PATH, {
+						method: "POST",
+						headers: { "content-type": "application/json" },
+						body: JSON.stringify({
+							text: snapshot,
+							sessionId,
+							...(previous === undefined ? {} : { previousResult: previous }),
+						}),
+						signal: controller.signal,
+					});
+					const body = await response.json().catch(() => ({}));
+					if (requestRef.current !== controller) return;
+					requestRef.current = null;
+					if (mountedRef.current === false) return;
+					if (response.ok === false) {
+						setStatus("idle");
+						setError(typeof body.message === "string" && body.message !== ""
+							? body.message
+							: `${t("notice.failed")} (${String(body.error ?? response.status)})`);
+						return;
+					}
+					const result = typeof body.enhanced === "string" ? body.enhanced : "";
+					if (result === "") {
+						setStatus("idle");
+						setError(t("notice.failed"));
+						return;
+					}
+					// Race guard: any edit during the request discards the result rather
+					// than overwriting newer text.
+					if (normalizeDraft(draftRef.current) !== normalizeDraft(snapshot)) {
+						setStatus("idle");
+						setNotice(t("notice.discarded"));
+						return;
+					}
+					// A rewrite identical to the draft leaves nothing to undo.
+					if (normalizeDraft(result) === normalizeDraft(snapshot)) {
+						setStatus("idle");
+						setNotice(t("notice.unchanged"));
+						return;
+					}
+					inputActions.setDraft(result);
+					setRollback({ original: snapshot, enhanced: result });
+					setStatus("done");
+				} catch (failure) {
+					if (requestRef.current !== controller) return;
+					requestRef.current = null;
+					if (mountedRef.current === false) return;
+					setStatus("idle");
+					if (controller.signal.aborted) setNotice(t("notice.cancelled"));
+					else setError(failure instanceof Error ? failure.message : String(failure));
+				}
+			};
+
+			const onPrimary = () => {
+				if (status === "optimizing") {
+					// Real cancellation: aborting the fetch closes the response, which
+					// aborts the Host-side model call.
+					requestRef.current?.abort();
+					requestRef.current = null;
+					setStatus("idle");
+					setNotice(t("notice.cancelled"));
+					return;
+				}
+				if (rollback !== null) {
+					// A disabled button does not receive clicks in a browser, but a
+					// keyboard activation, a synthetic event, or a stale render can still
+					// reach this handler: never restore over text the user has since
+					// written.
+					if (dirty || canWrite === false || writable === false) return;
+					inputActions.setDraft(rollback.original);
+					setRollback(null);
+					setStatus("idle");
+					setNotice("");
+					return;
+				}
+				if (trimmed === "" || writable === false) return;
+				optimize(current, undefined);
+			};
+
+			const onRefine = () => {
+				if (trimmed === "" || writable === false || enhanced === undefined) return;
+				optimize(current, enhanced);
+			};
+
+			// With a rollback point in memory the primary control keeps its undo
+			// identity even after the draft was edited further: it stays visible so the
+			// user can see what restoring would mean, and is simply disabled while the
+			// draft no longer matches the rewrite it would replace.
+			const label = optimizing
+				? t("action.cancel")
+				: rollback !== null
+					? t("action.undo")
+					: t("action.optimize");
+			const tooltip = optimizing
+				? t("state.optimizing")
+				: canUndo
+					? t("state.done")
+					: dirty
+						? t("state.dirty")
+						: trimmed === ""
+							? t("hint.empty")
+							: t("action.optimize");
+
+			const primaryDisabled = optimizing === false
+				&& (rollback !== null && dirty
+					? true
+					: (canUndo === false && (trimmed === "" || writable === false)));
+
+			return h("span", { className: "dspo-root" },
+				error === ""
+					? null
+					: h("span", { className: "dspo-alert", role: "alert", title: error }, error),
+				notice === ""
+					? null
+					: h("span", { className: "dspo-notice", role: "status" }, notice),
+				optimizing === false && dirty
+					? h("button", {
+						type: "button",
+						className: "dspo-button",
+						title: t("action.refine"),
+						"aria-label": t("action.refine"),
+						disabled: writable === false || trimmed === "",
+						onMouseDown: (event) => event.preventDefault(),
+						onClick: onRefine,
+					}, h(IconSparkle))
+					: null,
+				h("button", {
+					type: "button",
+					className: "dspo-button",
+					title: notice === "" ? tooltip : `${tooltip} · ${notice}`,
+					"aria-label": label,
+					"aria-busy": optimizing ? "true" : undefined,
+					disabled: primaryDisabled,
+					"data-busy": optimizing ? "" : undefined,
+					"data-done": canUndo ? "" : undefined,
+					"data-stale": rollback !== null && dirty ? "" : undefined,
+					onMouseDown: (event) => event.preventDefault(),
+					onClick: onPrimary,
+				}, optimizing
+					? h(IconSpinner)
+					: rollback !== null
+						? h(IconUndo)
+						: h(IconSparkle)),
+			);
+		}
+
+		/**
+		 * Normalize a draft for comparison only.
+		 * @param {string} text - draft text.
+		 * @returns the comparable form.
+		 */
+		function normalizeDraft(text) {
+			return String(text).replace(/\r\n?/gu, "\n").replace(/[ \t]+$/gmu, "").trimEnd();
+		}
+
+		/** Insert this package's stylesheet once, and remove it with the plugin. */
+		function insertStyles() {
+			if (document.querySelector(`style[data-plugin-css="${STYLE_ID}"]`) !== null) return () => {};
+			const style = document.createElement("style");
+			style.dataset.pluginCss = STYLE_ID;
+			style.textContent = CSS;
+			document.head.appendChild(style);
+			return () => style.remove();
+		}
+
+		return {
+			name: "qjysqjy-prompt-optimizer",
+			// `slots` is the only hard requirement: the control renders nowhere else.
+			inject: ["slots"],
+			apply(ctx) {
+				ctx.effect(insertStyles, "qjysqjy-prompt-optimizer: styles");
+
+				const locale = (() => {
+					try {
+						return ctx.get("locale");
+					} catch {
+						return undefined;
+					}
+				})();
+				let t;
+				if (locale !== undefined && typeof locale.register === "function") {
+					ctx.effect(() => locale.register(NS, { zh, en }), "qjysqjy-prompt-optimizer: copy");
+					t = locale.bind(NS);
+				} else {
+					const table = { zh, en };
+					t = (key) => table.en[key] ?? key;
+				}
+
+				ctx.slots.inject("conversation.input.right", () => ctx.slots.register({
+					name: "conversation.input.right",
+					id: "qjysqjy-prompt-optimizer",
+					// Sits before the model seat, beside the other trailing controls.
+					order: 2,
+					locale: NS,
+					inject: () => ({ t }),
+				}, PromptOptimizer));
+			},
+		};
+	},
+});