@qilin-agent/client-ui-settings-session-log 0.0.0-stage → 3.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 kkutysllb
+
+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.i18n.yaml

@@ -0,0 +1,37 @@
+# Bilingual-pair consistency record for README.md (docs/i18n/README.md): per heading
+# section, a hash of its English and Chinese blocks outside code blocks and generated regions.
+# After editing either side, bring the other along and re-record with:
+#   pnpm run verify-translation-pairing --write packages/client/ui-settings-session-log/README.md
+/:
+  en: 71cee35d4ba9ca79
+  zh: c2aec2b4d3d7bd54
+/qilin-client-ui-settings-session-log:
+  en: c98151984ea6bcbf
+  zh: 2b07e9f561391159
+/qilin-client-ui-settings-session-log/summary:
+  en: 39c3846ca9dfd3e4
+  zh: 8a745b54482403f8
+/qilin-client-ui-settings-session-log/table-of-contents:
+  en: d152484eb41ac6b4
+  zh: bda879a892f240f0
+/qilin-client-ui-settings-session-log/use-this-package:
+  en: cf7f168744181569
+  zh: 1da24a0fb48b9ada
+/qilin-client-ui-settings-session-log/understand-the-implementation:
+  en: 573cd565e22a6f6e
+  zh: d214978ce1c43a86
+/qilin-client-ui-settings-session-log/further-exploration:
+  en: 0f83b5ddf1add8ad
+  zh: 6e58c09b4b315638
+/qilin-client-ui-settings-session-log/model-experience:
+  en: dd26d7193f9ca4ce
+  zh: 954a7085b03beb8a
+/qilin-client-ui-settings-session-log/model-experience/kv-cache-effect:
+  en: c8b5628ff5370218
+  zh: 5ebb7ff0959a3a69
+/qilin-client-ui-settings-session-log/known-limitations-and-deferred-work:
+  en: a77d8093293518fa
+  zh: 0098c6b150a6d382
+/qilin-client-ui-settings-session-log/known-limitations-and-deferred-work/dev-note:
+  en: 0a1253c6f7b5e8b9
+  zh: 9f56528562c7c914

package/README.md

@@ -1,3 +1,69 @@
-# Temporary Holding Version
+---
+description: "Control Session-log upload with DeepSeek API requests from General settings."
+kind: "package-reference"
+---
 
-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.
+# @qilin-agent/client-ui-settings-session-log
+
+English | [中文](README.zh.md)
+
+## Summary
+
+Use **Upload Session Log when using the official model API** above the version number in **Settings → General** to control Session-log upload with DeepSeek API requests. The switch shows the accepted Host setting and saves each change immediately. It appears only while the Host exposes the upload setting; read-only clients cannot change it.
+
+## Table of Contents
+
+- [Use this package](#use-this-package)
+- [Understand the implementation](#understand-the-implementation)
+- [Further Exploration](#further-exploration)
+- [Model Experience](#model-experience)
+- [Known Limitations and Deferred Work](#known-limitations-and-deferred-work)
+- [Dev Note](#dev-note)
+
+-----
+
+<a id="use-this-package"></a>
+## Use this package
+
+The Web bundle mounts this companion. Its switch edits the Host plugin's `enabled` field through the shared configuration form. A save failure keeps the accepted value and shows a toast that survives closing Settings. See [Session-log upload](../../session/session-log-deepseek/README.md#configuration) for request timing, resumed uploads, and the separate OpenTelemetry setting.
+
+-----
+
+<a id="understand-the-implementation"></a>
+## Understand the implementation
+
+<details>
+<summary>Implementation details — click to expand</summary>
+
+The companion contributes a `settings.general.item` row while `session-log-deepseek` is served and a `shell.overlay` toast for mutation outcomes. The shared form owns persistence and reconnect synchronization; the companion owns only pending-write state and localized notices.
+
+</details>
+
+-----
+
+<a id="further-exploration"></a>
+## Further Exploration
+
+- [Settings forms](../ui-settings/README.md) — accepted Host values and ordered writes.
+- [Session-log upload](../../session/session-log-deepseek/README.md) — request contribution and acceptance tracking.
+- [Web Client](../../../docs/subsystems/web-client.md) — plugin composition and settings placement.
+
+<a id="model-experience"></a>
+## Model Experience
+
+None, as this browser preference contributes no model-visible content.
+
+#### KV Cache effect
+
+None; the setting controls request metadata outside model input.
+
+## Known Limitations and Deferred Work
+
+<a id="known-limitations-and-deferred-work"></a>
+
+- The row is unavailable when the Host does not expose the `session-log-deepseek` namespace.
+
+<a id="dev-note"></a>
+### Dev Note
+
+None.

package/README.zh.md

@@ -0,0 +1,69 @@
+---
+description: "在通用设置中控制随 DeepSeek API 请求上传会话日志。"
+kind: "package-reference"
+---
+
+# @qilin-agent/client-ui-settings-session-log
+
+[English](README.md) | 中文
+
+## 概述
+
+使用**设置 → 通用**中版本号上方的**在使用官方模型 API 时上传 Session Log**开关控制随 DeepSeek API 请求上传会话日志。开关显示 Host 已接受的设置，并立即保存每次修改。仅当 Host 提供上传设置时显示该项；只读客户端无法修改。
+
+## 目录
+
+- [使用本包](#use-this-package)
+- [理解实现](#understand-the-implementation)
+- [进一步探索](#further-exploration)
+- [模型体验](#model-experience)
+- [已知限制与暂缓事项](#known-limitations-and-deferred-work)
+- [开发备注](#dev-note)
+
+-----
+
+<a id="use-this-package"></a>
+## 使用本包
+
+Web bundle 挂载本配套插件。开关通过共享配置表单修改 Host 插件的 `enabled` 字段。保存失败时保留已接受的值，并显示关闭设置后仍可见的提示。请求生效时机、恢复上传和独立的 OpenTelemetry 设置见[会话日志上传](../../session/session-log-deepseek/README.zh.md#configuration)。
+
+-----
+
+<a id="understand-the-implementation"></a>
+## 理解实现
+
+<details>
+<summary>实现细节——点击展开</summary>
+
+Host 提供 `session-log-deepseek` 时，配套插件贡献一个 `settings.general.item` 行，并通过 `shell.overlay` 提示保存结果。共享表单负责持久化和重连同步；配套插件仅管理待完成写入状态和本地化提示。
+
+</details>
+
+-----
+
+<a id="further-exploration"></a>
+## 进一步探索
+
+- [设置表单](../ui-settings/README.zh.md)——Host 已接受的值与有序写入。
+- [会话日志上传](../../session/session-log-deepseek/README.zh.md)——请求字段与接收进度。
+- [Web 客户端](../../../docs/subsystems/web-client.zh.md)——插件组合与设置位置。
+
+<a id="model-experience"></a>
+## 模型体验
+
+无；此浏览器设置不贡献模型可见内容。
+
+#### KV Cache 影响
+
+无；该设置控制模型输入之外的请求元数据。
+
+## 已知限制与暂缓事项
+
+<a id="known-limitations-and-deferred-work"></a>
+
+- Host 不提供 `session-log-deepseek` 命名空间时，该行不可用。
+
+<a id="dev-note"></a>
+### 开发备注
+
+无。

package/lib/client.js

@@ -0,0 +1,180 @@
+window.__ModuleLoader__.load({
+	id: "@qilin-agent/client-ui-settings-session-log",
+	factory: (require) => {
+		var module = { exports: {} };
+		var exports = module.exports;
+		Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+		let _qilin_agent_client_store = require("@qilin-agent/client-store");
+		let react_jsx_runtime = require("react/jsx-runtime");
+		let _qilin_agent_client_ui_primitives = require("@qilin-agent/client-ui-primitives");
+		//#region lib/types/client/upload-preference.js
+		/** Ordered preference writes and notices that survive the settings panel. */
+		/** Writes the Host setting without publishing an optimistic upload state. */
+		var UploadPreference = class {
+			form;
+			/** Observable mutation outcome. */
+			state = (0, _qilin_agent_client_store.createSnapshotStore)({
+				busy: false,
+				notice: null,
+				sequence: 0
+			});
+			/** @param form - Host-owned configuration form. */
+			constructor(form) {
+				this.form = form;
+			}
+			/**
+			* Persist enablement; refusal or transport failure leaves the accepted value visible.
+			* @param enabled - requested upload state.
+			* @returns completion after the write settles.
+			*/
+			async setEnabled(enabled) {
+				if (this.state.getSnapshot().busy) return;
+				this.state.update((state) => {
+					state.busy = true;
+					state.notice = null;
+				});
+				let accepted = false;
+				try {
+					accepted = await this.form.set("enabled", enabled);
+				} catch (_error) {}
+				this.state.update((state) => {
+					state.busy = false;
+					state.notice = accepted ? "saved" : "failed";
+					state.sequence++;
+				});
+			}
+			/** Clear the displayed mutation notice. */
+			dismiss() {
+				this.state.update((state) => {
+					state.notice = null;
+				});
+			}
+		};
+		//#endregion
+		//#region \0qilin-css:/home/runner/work/QiLin/QiLin/packages/client/ui-settings-session-log/src/client/UploadRow.module.css.mjs
+		const css = "._5CVv-a_row{border-bottom:.5px solid var(--qilin-alias-border-l2);justify-content:space-between;align-items:center;gap:24px;padding:16px 0;display:flex}._5CVv-a_title{font-size:14px;line-height:20px}._5CVv-a_description{color:var(--qilin-alias-label-secondary);margin-top:4px;font-size:12px;line-height:18px}";
+		const tagId = "@qilin-agent/client-ui-settings-session-log/UploadRow.module.css";
+		if (typeof document !== "undefined" && document.querySelector("style[data-plugin-css=" + JSON.stringify(tagId) + "]") === null) {
+			const tag = document.createElement("style");
+			tag.dataset.plugin = "@qilin-agent/client-ui-settings-session-log";
+			tag.dataset.pluginCss = tagId;
+			tag.textContent = css;
+			document.head.appendChild(tag);
+		}
+		var UploadRow_module_css_default = {
+			"description": "_5CVv-a_description",
+			"row": "_5CVv-a_row",
+			"title": "_5CVv-a_title"
+		};
+		//#endregion
+		//#region lib/types/client/UploadRow.js
+		/** General settings row and persistent shell notice for API log uploads. */
+		/**
+		* Render the accepted API upload state.
+		* @param props - settings hooks, writer and localized copy.
+		* @returns the bottom preference row.
+		*/
+		function UploadRow({ useUpload, useMutation, setEnabled, t }) {
+			const upload = useUpload((value) => value);
+			const busy = useMutation((value) => value.busy);
+			return (0, react_jsx_runtime.jsxs)("div", {
+				className: UploadRow_module_css_default.row,
+				children: [(0, react_jsx_runtime.jsxs)("div", { children: [(0, react_jsx_runtime.jsx)("div", {
+					className: UploadRow_module_css_default.title,
+					children: t("title")
+				}), (0, react_jsx_runtime.jsx)("div", {
+					className: UploadRow_module_css_default.description,
+					children: t("description")
+				})] }), (0, react_jsx_runtime.jsx)(_qilin_agent_client_ui_primitives.Switch, {
+					checked: upload.value?.enabled === true,
+					label: t("title"),
+					disabled: busy || upload.status !== "ready" || !upload.writable,
+					onChange: (enabled) => {
+						setEnabled(enabled);
+					}
+				})]
+			});
+		}
+		/**
+		* Keep the save outcome visible after settings closes.
+		* @param props - mutation hook, dismissal and localized copy.
+		* @returns the current toast, or nothing.
+		*/
+		function UploadToast({ useMutation, dismiss, t }) {
+			const state = useMutation((value) => value);
+			if (state.notice === null) return null;
+			return (0, react_jsx_runtime.jsx)(_qilin_agent_client_ui_primitives.Toast, {
+				text: t(state.notice),
+				onDone: dismiss,
+				...state.notice === "saved" ? { tone: "success" } : {}
+			}, state.sequence);
+		}
+		//#endregion
+		//#region lib/types/client/locales.js
+		/** Copy for the API Session-log upload preference. */
+		const en = {
+			title: "Upload Session Log when using the official model API",
+			description: "Help improve DeepSeek models and products.",
+			saved: "Preference saved",
+			failed: "Could not save preference"
+		};
+		/** Chinese preference copy. */
+		const zh = {
+			title: "在使用官方模型 API 时上传 Session Log",
+			description: "帮助改进 DeepSeek 模型与产品",
+			saved: "设置已保存",
+			failed: "无法保存设置"
+		};
+		//#endregion
+		//#region lib/types/client/index.js
+		/** Services used by the browser companion. */
+		const inject = [
+			"slots",
+			"locale",
+			"configForms"
+		];
+		/**
+		* Register the preference while its Host configuration is available.
+		* @param ctx - browser plugin context.
+		*/
+		function apply(ctx) {
+			const locale = "settings.sessionLog";
+			const namespace = "session-log-deepseek";
+			ctx.effect(() => ctx.locale.register(locale, {
+				en,
+				zh
+			}));
+			const form = ctx.configForms.get(namespace);
+			const preference = new UploadPreference(form);
+			const face = () => ({
+				hooks: {
+					upload: form,
+					mutation: preference.state
+				},
+				setEnabled: (enabled) => preference.setEnabled(enabled),
+				dismiss: () => {
+					preference.dismiss();
+				}
+			});
+			ctx.effect(() => ctx.configForms.whileServed([namespace], () => ctx.slots.inject("settings.general.item", () => ctx.slots.register({
+				name: "settings.general.item",
+				id: namespace,
+				order: 90,
+				locale,
+				inject: face
+			}, UploadRow))));
+			ctx.slots.inject("shell.overlay", () => ctx.slots.register({
+				name: "shell.overlay",
+				id: "session-log-upload-toast",
+				locale,
+				inject: face
+			}, UploadToast));
+		}
+		//#endregion
+		exports.apply = apply;
+		exports.inject = inject;
+		return module.exports;
+	}
+});
+
+//# sourceMappingURL=client.js.map

package/lib/index.js

@@ -0,0 +1,6 @@
+//#region lib/types/index.js
+/** Browser companion for the Session-log upload preference. */
+/** Mount the browser entry through the Loader. */
+function apply() {}
+//#endregion
+export { apply };

package/lib/types/client/UploadRow.d.ts

@@ -0,0 +1,28 @@
+import type { ObservableSnapshot } from '@qilin-agent/client-store';
+import type { ConfigFormSnapshot } from '@qilin-agent/client-ui-settings/client';
+import type { InjectFace, PropsLocale, PropsRuntime } from '@qilin-agent/client-ui-slots';
+import type { UploadMutation, UploadSettings } from './upload-preference.ts';
+/** Accepted settings and mutation callbacks supplied by the plugin. */
+export interface UploadInjected {
+    hooks: {
+        upload: ObservableSnapshot<ConfigFormSnapshot<UploadSettings>>;
+        mutation: ObservableSnapshot<UploadMutation>;
+    };
+    setEnabled(enabled: boolean): Promise<void>;
+    dismiss(): void;
+}
+type Face = InjectFace<UploadInjected> & PropsLocale<'settings.sessionLog'>;
+/**
+ * Render the accepted API upload state.
+ * @param props - settings hooks, writer and localized copy.
+ * @returns the bottom preference row.
+ */
+export declare function UploadRow({ useUpload, useMutation, setEnabled, t }: PropsRuntime<'settings.general.item'> & Face): import("react").JSX.Element;
+/**
+ * Keep the save outcome visible after settings closes.
+ * @param props - mutation hook, dismissal and localized copy.
+ * @returns the current toast, or nothing.
+ */
+export declare function UploadToast({ useMutation, dismiss, t }: PropsRuntime<'shell.overlay'> & Face): import("react").JSX.Element | null;
+export {};
+//# sourceMappingURL=UploadRow.d.ts.map

package/lib/types/client/index.d.ts

@@ -0,0 +1,17 @@
+/** General settings companion for the Host Session-log upload configuration. */
+import type { Context } from '@qilin-agent/kylin';
+import { en } from './locales.ts';
+declare module '@qilin-agent/client-ui-slots' {
+    interface LocaleNamespaceMap {
+        /** API Session-log preference copy. */
+        'settings.sessionLog': keyof typeof en;
+    }
+}
+/** Services used by the browser companion. */
+export declare const inject: string[];
+/**
+ * Register the preference while its Host configuration is available.
+ * @param ctx - browser plugin context.
+ */
+export declare function apply(ctx: Context): void;
+//# sourceMappingURL=index.d.ts.map

package/lib/types/client/locales.d.ts

@@ -0,0 +1,10 @@
+/** Copy for the API Session-log upload preference. */
+export declare const en: {
+    title: string;
+    description: string;
+    saved: string;
+    failed: string;
+};
+/** Chinese preference copy. */
+export declare const zh: Record<keyof typeof en, string>;
+//# sourceMappingURL=locales.d.ts.map

package/lib/types/client/upload-preference.d.ts

@@ -0,0 +1,28 @@
+import type { ConfigForm } from '@qilin-agent/client-ui-settings/client';
+/** Fields exposed by the Session-log plugin. */
+export interface UploadSettings {
+    enabled: boolean;
+}
+/** Mutation state shared by the preference row and shell notice. */
+export interface UploadMutation {
+    busy: boolean;
+    notice: 'saved' | 'failed' | null;
+    sequence: number;
+}
+/** Writes the Host setting without publishing an optimistic upload state. */
+export declare class UploadPreference {
+    private readonly form;
+    /** Observable mutation outcome. */
+    readonly state: import("@qilin-agent/client-store").SnapshotStore<UploadMutation>;
+    /** @param form - Host-owned configuration form. */
+    constructor(form: ConfigForm<UploadSettings>);
+    /**
+     * Persist enablement; refusal or transport failure leaves the accepted value visible.
+     * @param enabled - requested upload state.
+     * @returns completion after the write settles.
+     */
+    setEnabled(enabled: boolean): Promise<void>;
+    /** Clear the displayed mutation notice. */
+    dismiss(): void;
+}
+//# sourceMappingURL=upload-preference.d.ts.map

package/lib/types/index.d.ts

@@ -0,0 +1,4 @@
+/** Browser companion for the Session-log upload preference. */
+/** Mount the browser entry through the Loader. */
+export declare function apply(): void;
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,70 @@
 {
   "name": "@qilin-agent/client-ui-settings-session-log",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "description": "General settings control for Session-log upload with DeepSeek API requests",
+  "version": "3.1.3",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kkutysllb/QiLin.git",
+    "directory": "packages/client/ui-settings-session-log"
+  },
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./client": {
+      "types": "./lib/types/client/index.d.ts",
+      "default": "./lib/client.js"
+    },
+    "./src/*": "./src/*",
+    "./package.json": "./package.json"
+  },
+  "license": "MIT",
+  "peerDependencies": {
+    "@qilin-agent/kylin": "~4.0.3"
+  },
+  "devDependencies": {
+    "@types/react": "~18.3.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "@types/react-dom": "~18.3.0",
+    "@qilin-agent/kylin": "~4.0.3",
+    "@qilin-agent/api-remotes": "3.1.3",
+    "@qilin-agent/client-locale": "3.1.3",
+    "@qilin-agent/client-test-runtime": "3.1.3",
+    "@qilin-agent/client-store": "3.1.3",
+    "@qilin-agent/client-ui-primitives": "3.1.3",
+    "@qilin-agent/client-ui-renderer": "3.1.3",
+    "@qilin-agent/client-ui-settings": "3.1.3",
+    "@qilin-agent/client-ui-slots": "3.1.3",
+    "@qilin-agent/client-ui-layout": "3.1.3"
+  },
+  "files": [
+    "lib/index.js",
+    "lib/client.js",
+    "lib/types/**/*.d.ts"
+  ],
+  "qilin": {
+    "client": {
+      "inject": [
+        "@qilin-agent/client-locale",
+        "@qilin-agent/client-ui-settings",
+        "@qilin-agent/client-ui-layout"
+      ],
+      "platform": "web"
+    }
+  },
+  "engines": {
+    "node": "^22.19.0 || >=24.0.0"
+  },
+  "scripts": {
+    "bundle": "tsdown",
+    "watch": "tsdown --watch"
+  }
 }