@linxin666/dsh-client-ui-diagrams 0.0.0-stage → 0.4.16

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.i18n.yaml

@@ -0,0 +1,6 @@
+# Bilingual-pair consistency record (docs/i18n.md): the git blob hash of each
+# side as of the last confirmed-consistent state. Both languages carry equal authority;
+# after editing either side, bring the other along and re-record with:
+#   node scripts/verify-docs.mjs --write <dir>
+README.md: 1503ca236be598046a8d4fce20c82b1798fa890b
+README.zh.md: ed9ba49d3f317b123b6c91c81b5aaa0ac31cdedf

package/README.md

@@ -1,3 +1,39 @@
-# Temporary Holding Version
+# dsh-diagrams
 
-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.
+English | [中文](README.zh.md)
+
+Mermaid diagram rendering for the DeepSeek Harness Web GUI: a fenced ```mermaid block in the chat transcript or in the document preview panel is rendered in place as an SVG diagram instead of a code block.
+
+## What it does
+
+- **Renders where you read**: the chat transcript and the document preview pane are covered from one observer, because both render through the same official markdown component.
+- **Renders on demand**: the mermaid runtime is served by this package's own host route and fetched only when a page actually shows a mermaid block, so a session without diagrams downloads nothing extra.
+- **Follows the shell theme**: a light/dark switch re-renders the diagrams from their stored source, because mermaid paints colors into the SVG itself.
+- **Never damages the document**: a missing runtime, a half-streamed fence or a diagram the parser rejects all leave the original code block exactly as the renderer drew it, and the block's copy button keeps copying the source.
+
+## Install
+
+```sh
+dsh plugin --profile web add @linxin666/dsh-client-ui-diagrams
+# Restart dsh web
+dsh web
+```
+
+Installing the family bundle (`@linxin666/dsh-web-all`) mounts this package too; the row is enabled by default and can be switched off per row in the plugin manager.
+
+## Config
+
+No settings. The package registers one read-only host route and one page-side observer; there is nothing to configure.
+
+## Known limitations
+
+- **The integration point is the renderer's DOM, not a contract.** The official markdown renderer publishes no code-block extension seam, so this package finds fenced blocks by the `md-code-block` class and reads the fence language from the banner's infostring element. A host release that renames either one stops diagram rendering (the fences stay ordinary code blocks — nothing breaks); the pinned constants live in `src/core/contract.ts` with a test beside them.
+- **Streaming fences render late by design.** While a reply is still streaming, an unclosed fence cannot be rendered. A rejected fence is retried only after a short quiet period and only once its source actually changes, so a half-written diagram is never re-parsed on every DOM change and a fence the parser rejects is never parsed again.
+- **No diagram theme choice.** Diagrams follow the shell's light/dark state; mermaid's own theme variables are not exposed as settings.
+
+## Security model
+
+- The vendor route (`/api/dsh-diagrams/vendor/mermaid.js`) passes the family trust fence first: loopback always passes, and a live paired-device cookie allows remote access when `dsh-remote-web-ui` is loaded. Any other client is refused with 403 before the asset is read.
+- The route is read-only: only `GET` and `HEAD` are answered, everything else is 405.
+- The runtime is served same-origin from the installed package; no CDN is contacted.
+- Rendered SVG passes a second sanitizing pass (beyond mermaid's own strict security level): script-capable elements, `on*` handlers and `javascript:` URLs are stripped, and markup that still carries an executable token after cleaning is rejected — the block then stays a code block.

package/README.zh.md

@@ -0,0 +1,39 @@
+# dsh-diagrams
+
+[English](README.md) | 中文
+
+DeepSeek Harness Web GUI 的 mermaid 图示渲染：会话正文或文档预览面板里的 mermaid 代码块会原地渲染成 SVG 图，而不是留成代码块。
+
+## 功能
+
+- **在你阅读的地方出图**：会话正文与文档预览面板由同一个观察器覆盖——两者都走官方的同一个 markdown 组件。
+- **按需加载**：mermaid 运行库由本包自己的宿主路由伺服，只有在页面真的出现 mermaid 块时才拉取，因此没有图示的会话不会多下载任何东西。
+- **跟随界面主题**：明暗切换时按保存的源码重绘——mermaid 把颜色画进 SVG 本身，CSS 改不动它。
+- **绝不破坏文档**：运行库缺失、围栏还在流式写入、或图示被解析器拒绝，都会把原代码块原样留下；代码块的复制按钮仍复制源码。
+
+## 安装
+
+```sh
+dsh plugin --profile web add @linxin666/dsh-client-ui-diagrams
+# 重启 dsh web
+dsh web
+```
+
+安装全家桶（`@linxin666/dsh-web-all`）会一并挂载本包；该行出厂默认开启，可在插件管理里按行关闭。
+
+## 配置
+
+没有设置项。本包只注册一条只读宿主路由与一个页面侧观察器，没有可配置项。
+
+## 已知限制
+
+- **接入点是渲染器的 DOM，不是契约**：官方 markdown 渲染器没有代码块扩展缝，因此本包用 `md-code-block` 类名找围栏块、从 banner 的 infostring 元素读围栏语言。宿主若改名其一，渲染会停止（围栏退回普通代码块，不会出错）；被钉住的常量集中在 `src/core/contract.ts`，旁边有契约测试。
+- **流式围栏会延后出图**：回复仍在流式写入时，未闭合的围栏无法渲染。被拒的围栏只在短暂静默期之后、且源码确实变化时才重试，因此半截的图不会随每次 DOM 变更反复重解析，解析器拒绝的围栏也不会再被解析。
+- **不提供图示主题选择**：图跟随界面的明暗状态，mermaid 自身的主题变量没有暴露成设置项。
+
+## 安全模型
+
+- vendor 路由（`/api/dsh-diagrams/vendor/mermaid.js`）先过家族信任围栏：本机（loopback）恒通过；在装 `dsh-remote-web-ui` 时，已配对设备的 cookie 是额外的远程放行路径。其它客户端在读资产之前就被 403 拒绝。
+- 路由只读：只应答 `GET` 与 `HEAD`，其余方法 405。
+- 运行库同源来自已安装的包，不访问任何 CDN。
+- 渲染出的 SVG 在 mermaid 自身 strict 等级之外再走一遍消毒：可执行元素、`on*` 事件属性与 `javascript:` URL 一律剥除；清理后仍带可执行 token 的标记被拒——该块保持为代码块。

package/cordis.patch.yml

@@ -0,0 +1,7 @@
+# bundle patch for the diagrams plugin: inserts its row into the web profile
+# roster. Applied as a profile bundle layer (the `dsh.bundle.patch` manifest
+# field); install with
+# `dsh plugin --profile web add link:<this repo>/packages/dsh-diagrams`.
+- insert:
+    - id: ui-diagrams
+      name: '@linxin666/dsh-client-ui-diagrams'

package/icon.svg

@@ -0,0 +1,6 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" fill="none" stroke="#4d6bfe" stroke-width="28" stroke-linecap="round" stroke-linejoin="round">
+  <rect x="176" y="52" width="160" height="104" rx="28"/>
+  <rect x="52" y="356" width="160" height="104" rx="28"/>
+  <rect x="300" y="356" width="160" height="104" rx="28"/>
+  <path d="M256 156v92M256 248H132v108M256 248h124v108"/>
+</svg>