@woosau/dsh-custom-env 0.1.1 → 0.1.6

package/README.md

@@ -1,53 +1,84 @@
-# dsh-custom-env
-
-English | [中文](README.zh-CN.md)
-
-Community DeepSeek Harness plugin: manage `$DSH_HOME/.env` from **Settings → Environment**. Not an official DeepSeek AI product.
-
-Edits apply to the Host immediately and sync to the Windows / macOS user environment (new terminals pick up OS changes). Linux user-env sync is not supported.
-
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
-
-## Features
-
-- CRUD for `$DSH_HOME/.env` in Settings
-- Hot-apply to the current Host process
-- Sync to Windows / macOS user environment
-- Rejects bootstrap names (`PATH`, `DSH_*`, `XDG_*`, …)
-- Optional **Install** for the `dsh` CLI used by this Host (Windows / macOS)
-
-## Install
-
-Requires a working DSH install with the `dsh` CLI. Use profile `desktop` or `web`.
-
-```powershell
-dsh plugin --profile desktop add @woosau/dsh-custom-env
-```
-
-```powershell
-dsh plugin --profile web add @woosau/dsh-custom-env
-```
-
-GitHub: `dsh plugin --profile desktop add github:ownduck/dsh-custom-env`
-
-Close Desktop first if `plugin` hits `EPERM` on the profile `package.json`. GitHub installs may need `allowBuilds.koffi: true` in the profile `pnpm-workspace.yaml` (native `koffi`). Then restart DSH and open **Settings → Environment**.
-
-## Uninstall
-
-```powershell
-dsh plugin --profile desktop remove @woosau/dsh-custom-env
-```
-
-## Usage
-
-1. Open **Settings → Environment**
-2. Edit as a draft: **Confirm** writes `.env` and live Host/OS; **Cancel** reverts the inputs
-3. After Confirm, restart tips appear for new/changed rows; **Restore** writes back the Host-start value
-4. Restart DSH or open a new terminal for the full OS effect
-5. Use **Install** in the dsh block only when offered (Windows user PATH / macOS `/usr/local/bin/dsh`; may replace Desktop’s link on macOS)
-
-Do not put bootstrap names (including `PATH`) in `.env`.
-
-## License
-
-MIT
+# dsh-custom-env
+
+English | [中文](README.zh-CN.md)
+
+Community DeepSeek Harness plugin for managing environment variables in **Settings → Environment**. Not an official DeepSeek AI product.
+
+Changes apply to the running app right away, and on Windows / macOS also to the user environment so new terminals can see them. Linux user-environment sync is not supported.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+## Install
+
+Requires DSH with the `dsh` CLI (`desktop` or `web`).
+
+```powershell
+dsh plugin --profile desktop add @woosau/dsh-custom-env
+# or: dsh plugin --profile web add @woosau/dsh-custom-env
+# or: dsh plugin --profile desktop add github:ownduck/dsh-custom-env
+```
+
+If install fails because Desktop is locking files, quit Desktop first. After install, restart DSH and open **Settings → Environment**.
+
+```powershell
+dsh plugin --profile desktop remove @woosau/dsh-custom-env
+```
+
+## For users
+
+1. Open **Settings → Environment**
+2. Edit a row as a draft → **Confirm** to save, **Cancel** to discard
+3. **Restore** brings back the value from when this app session started
+4. At startup, values are injected into the Host `process.env` first; writing the user environment (registry / launchctl) is deferred off the boot path and is not broadcast. Log off or reboot before other tools need those values
+5. Use **Install** only when shown, to wire this Host’s `dsh` command into your user PATH (Windows / macOS)
+
+System-reserved names (such as `PATH` and names starting with `DSH_` / `XDG_`) cannot be edited here.
+
+### When saving a value
+
+| You save | Variable does not exist yet | Variable already exists |
+|----------|-----------------------------|-------------------------|
+| A non-empty value | Created | Replaced |
+| An empty value | Created as empty | Left unchanged |
+
+## For other plugins (Remote API)
+
+Call the Host `customEnv` service (`ctx.get('customEnv')` or injected `ctx.customEnv`).
+
+**Everyday use — by variable name**
+
+```ts
+const env = ctx.get('customEnv')
+
+await env?.setVar('MY_KEY', 'value')  // create or replace
+await env?.setVar('MY_KEY', '')       // create only if missing
+await env?.removeVar('MY_KEY')
+
+await env?.setVars([
+  { name: 'A', value: '1' },
+  { name: 'B', value: '' },           // no-op if B already exists
+])
+await env?.removeVars(['A', 'B'])
+```
+
+Reserved names are rejected (batch calls fail entirely).
+
+**Settings UI — by row id**
+
+| Call | Purpose |
+|------|---------|
+| `list()` | Current variables and row ids |
+| `upsert(id, name, value)` | Create (`id` empty) or update/rename a row |
+| `deleteEntry(id)` | Delete that row |
+| `restore(id)` | Restore session-start value, or remove if the row was added later |
+
+**CLI helpers**
+
+| Call | Purpose |
+|------|---------|
+| `cliStatus()` | Whether this Host’s `dsh` CLI is ready / can be installed |
+| `cliInstall()` | Install or repair that CLI entry |
+
+## License
+
+MIT

package/README.zh-CN.md

@@ -1,53 +1,84 @@
-# dsh-custom-env
-
-[English](README.md) | 中文
-
-社区 DeepSeek Harness 插件：在 **设置 → 环境变量** 管理 `$DSH_HOME/.env`。非 DeepSeek AI 官方产品。
-
-保存后立即作用于 Host，并同步到 Windows / macOS 用户环境（新开终端可见 OS 侧变更）。不同步 Linux 用户环境。
-
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
-
-## 功能
-
-- 设置页管理 `$DSH_HOME/.env`
-- 热写当前 Host 进程
-- 同步 Windows / macOS 用户环境
-- 拒绝 bootstrap 名（`PATH`、`DSH_*`、`XDG_*` 等）
-- 可选为本 Host **安装** `dsh` CLI（Windows / macOS）
-
-## 安装
-
-需已安装 DSH 且可用 `dsh` CLI。profile 选 `desktop` 或 `web`。
-
-```powershell
-dsh plugin --profile desktop add @woosau/dsh-custom-env
-```
-
-```powershell
-dsh plugin --profile web add @woosau/dsh-custom-env
-```
-
-GitHub：`dsh plugin --profile desktop add github:ownduck/dsh-custom-env`
-
-若 `plugin` 报 profile `package.json` 的 `EPERM`，先退出 Desktop。从 GitHub 安装时，profile 的 `pnpm-workspace.yaml` 可能需要 `allowBuilds.koffi: true`（原生依赖 `koffi`）。然后重启 DSH，打开 **设置 → 环境变量**。
-
-## 卸载
-
-```powershell
-dsh plugin --profile desktop remove @woosau/dsh-custom-env
-```
-
-## 使用
-
-1. 打开 **设置 → 环境变量**
-2. 草稿编辑：**确定** 写入 `.env` 并热写 Host/OS；**取消** 只恢复输入框
-3. 确定后新增/修改行旁有重启提示；**恢复** 可写回 Host 启动时的值
-4. 完整生效请重启 DSH 或新开终端
-5. **dsh** 区块仅在出现按钮时点 **安装**（Windows 用户 PATH / macOS `/usr/local/bin/dsh`；macOS 上可能覆盖 Desktop 的链接）
-
-不要把 bootstrap 名（含 `PATH`）写进 `.env`。
-
-## 许可证
-
-MIT
+# dsh-custom-env
+
+[English](README.md) | 中文
+
+社区 DeepSeek Harness 插件：在 **设置 → 环境变量** 里管理环境变量。非 DeepSeek AI 官方产品。
+
+保存后立即作用于当前应用；在 Windows / macOS 上还会写入用户环境，方便新开的终端读到。不支持同步 Linux 用户环境。
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+## 安装
+
+需已安装 DSH，并能使用 `dsh` 命令（`desktop` 或 `web`）。
+
+```powershell
+dsh plugin --profile desktop add @woosau/dsh-custom-env
+# 或: dsh plugin --profile web add @woosau/dsh-custom-env
+# 或: dsh plugin --profile desktop add github:ownduck/dsh-custom-env
+```
+
+若因 Desktop 占用文件导致安装失败，先退出 Desktop。安装后重启 DSH，打开 **设置 → 环境变量**。
+
+```powershell
+dsh plugin --profile desktop remove @woosau/dsh-custom-env
+```
+
+## 给使用者
+
+1. 打开 **设置 → 环境变量**
+2. 先改草稿 → **确定** 保存，**取消** 放弃
+3. **恢复** 可回到本次应用启动时的值
+4. 启动时先注入当前 Host 的 `process.env`；写入用户环境（注册表 / launchctl）会延后到启动路径之后，且不会广播。其它工具若要读到，请注销/重启后再开终端
+5. 仅在出现 **安装** 时使用：把本 Host 的 `dsh` 接到用户 PATH（Windows / macOS）
+
+系统保留名（如 `PATH`，以及 `DSH_` / `XDG_` 开头）不可在此编辑。
+
+### 保存时怎么处理
+
+| 你保存的内容 | 变量还不存在 | 变量已存在 |
+|--------------|--------------|------------|
+| 非空 | 新建 | 覆盖 |
+| 空 | 建为空变量 | 保持原样不动 |
+
+## 给其他插件（Remote API）
+
+通过 Host 的 `customEnv` 服务调用（`ctx.get('customEnv')` 或已注入的 `ctx.customEnv`）。
+
+**常用：按变量名**
+
+```ts
+const env = ctx.get('customEnv')
+
+await env?.setVar('MY_KEY', 'value')  // 新建或覆盖
+await env?.setVar('MY_KEY', '')       // 仅当不存在时新建
+await env?.removeVar('MY_KEY')
+
+await env?.setVars([
+  { name: 'A', value: '1' },
+  { name: 'B', value: '' },           // B 已存在则跳过
+])
+await env?.removeVars(['A', 'B'])
+```
+
+保留名会被拒绝（批量调用整批失败）。
+
+**设置页：按行 id**
+
+| 调用 | 用途 |
+|------|------|
+| `list()` | 列出当前变量与行 id |
+| `upsert(id, name, value)` | 新建（`id` 为空）或更新/重命名一行 |
+| `deleteEntry(id)` | 删除该行 |
+| `restore(id)` | 恢复启动时的值；若是启动后新增的行则删除 |
+
+**CLI**
+
+| 调用 | 用途 |
+|------|------|
+| `cliStatus()` | 本 Host 的 `dsh` 是否可用 / 能否安装 |
+| `cliInstall()` | 安装或修复该 CLI 入口 |
+
+## 许可证
+
+MIT

package/lib/client.js

@@ -209,6 +209,28 @@ var upsert$parameter$2$schema$value;
 var upsert$parameter$2$schema = () => upsert$parameter$2$schema$value ??= import_zod.z.string();
 var remove$parameter$0$schema$value;
 var remove$parameter$0$schema = () => remove$parameter$0$schema$value ??= import_zod.z.string();
+var setVar$parameter$0$schema$value;
+var setVar$parameter$0$schema = () => setVar$parameter$0$schema$value ??= import_zod.z.string();
+var setVar$parameter$1$schema$value;
+var setVar$parameter$1$schema = () => setVar$parameter$1$schema$value ??= import_zod.z.string();
+var setVars$parameter$0$schema$value;
+var setVars$parameter$0$schema = () => setVars$parameter$0$schema$value ??= import_zod.z.array(import_zod.z.object({
+  name: import_zod.z.string().readonly(),
+  value: import_zod.z.string().readonly()
+}).readonly()).readonly();
+var removeVar$parameter$0$schema$value;
+var removeVar$parameter$0$schema = () => removeVar$parameter$0$schema$value ??= import_zod.z.string();
+var removeVars$parameter$0$schema$value;
+var removeVars$parameter$0$schema = () => removeVars$parameter$0$schema$value ??= import_zod.z.array(import_zod.z.string()).readonly();
+var envVarWriteJsonSchema = {
+  type: "object",
+  properties: {
+    name: { type: "string" },
+    value: { type: "string" }
+  },
+  required: ["name", "value"],
+  additionalProperties: false
+};
 var restore$parameter$0$schema$value;
 var restore$parameter$0$schema = () => restore$parameter$0$schema$value ??= import_zod.z.string();
 var cliStatusJsonSchema = {
@@ -295,7 +317,7 @@ var TYPERT_REMOTE = createTypertRemoteInfo({
         },
         {
           name: "value",
-          description: "non-empty value.",
+          description: "value (empty string allowed).",
           source: "json",
           codec: {
             mode: "strict",
@@ -314,6 +336,121 @@ var TYPERT_REMOTE = createTypertRemoteInfo({
       },
       sourceLocation: { file: "src/index.ts", line: 1, column: 1 }
     },
+    "customEnv/setVars": {
+      service: "customEnv",
+      description: "Create or replace many variables by name in one rewrite. Empty values write NAME=.",
+      invocation: { kind: "direct" },
+      parameters: [
+        {
+          name: "entries",
+          description: "name/value pairs (last duplicate name wins).",
+          source: "json",
+          codec: {
+            mode: "strict",
+            typeSymbol: "readonly EnvVarWrite[]",
+            create: setVars$parameter$0$schema,
+            jsonSchema: { type: "array", items: envVarWriteJsonSchema }
+          }
+        }
+      ],
+      result: {
+        mode: "strict",
+        typeSymbol: "void",
+        create: () => import_zod.z.undefined(),
+        description: "no return value.",
+        jsonSchema: { type: "null" }
+      },
+      sourceLocation: { file: "src/index.ts", line: 1, column: 1 }
+    },
+    "customEnv/setVar": {
+      service: "customEnv",
+      description: "Create or replace one variable by name. Empty value writes NAME=.",
+      invocation: { kind: "direct" },
+      parameters: [
+        {
+          name: "name",
+          description: "writable variable name.",
+          source: "json",
+          codec: {
+            mode: "strict",
+            typeSymbol: "string",
+            create: setVar$parameter$0$schema,
+            jsonSchema: { type: "string" }
+          }
+        },
+        {
+          name: "value",
+          description: "value to store (empty string allowed).",
+          source: "json",
+          codec: {
+            mode: "strict",
+            typeSymbol: "string",
+            create: setVar$parameter$1$schema,
+            jsonSchema: { type: "string" }
+          }
+        }
+      ],
+      result: {
+        mode: "strict",
+        typeSymbol: "void",
+        create: () => import_zod.z.undefined(),
+        description: "no return value.",
+        jsonSchema: { type: "null" }
+      },
+      sourceLocation: { file: "src/index.ts", line: 1, column: 1 }
+    },
+    "customEnv/removeVars": {
+      service: "customEnv",
+      description: "Remove many variables by name from the file, Host, and OS user environment.",
+      invocation: { kind: "direct" },
+      parameters: [
+        {
+          name: "names",
+          description: "writable variable names.",
+          source: "json",
+          codec: {
+            mode: "strict",
+            typeSymbol: "readonly string[]",
+            create: removeVars$parameter$0$schema,
+            jsonSchema: { type: "array", items: { type: "string" } }
+          }
+        }
+      ],
+      result: {
+        mode: "strict",
+        typeSymbol: "number",
+        create: () => import_zod.z.number(),
+        description: "number of .env lines removed.",
+        jsonSchema: { type: "number" }
+      },
+      sourceLocation: { file: "src/index.ts", line: 1, column: 1 }
+    },
+    "customEnv/removeVar": {
+      service: "customEnv",
+      description: "Remove one variable by name from the file, Host, and OS user environment.",
+      invocation: { kind: "direct" },
+      parameters: [
+        {
+          name: "name",
+          description: "writable variable name.",
+          source: "json",
+          codec: {
+            mode: "strict",
+            typeSymbol: "string",
+            create: removeVar$parameter$0$schema,
+            jsonSchema: { type: "string" }
+          }
+        }
+      ],
+      result: {
+        mode: "strict",
+        typeSymbol: "boolean",
+        create: () => import_zod.z.boolean(),
+        description: "true when a .env line was removed.",
+        jsonSchema: { type: "boolean" }
+      },
+      sourceLocation: { file: "src/index.ts", line: 1, column: 1 }
+    },
     "customEnv/deleteEntry": {
       service: "customEnv",
       description: "Delete one entry from the file, Host, and OS user environment.",