@feiyang666/dsh-usage-plugin 1.9.0

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@feiyang666/dsh-usage-plugin",
+  "version": "1.9.0",
+  "description": "DeepSeek Harness usage & cost tracker plugin: per-call token/cache-hit stats, peak/off-peak billing, DeepSeek balance query, CSV/JSON/PNG export with custom destination, and persistent local storage. Ships a host half plus a web client half in one npm package; installs into a DSH profile as a dsh.bundle with one command (dsh plugin --profile web add @feiyang666/dsh-usage-plugin).",
+  "keywords": [
+    "deepseek",
+    "harness",
+    "dsh",
+    "plugin",
+    "usage",
+    "cost",
+    "tokens",
+    "cache",
+    "balance"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "main": "lib/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/feiyang-dev/dsh-usage-plugin.git"
+  },
+  "contributors": [
+    {
+      "name": "liu3734",
+      "url": "https://github.com/liu3734"
+    }
+  ],
+  "homepage": "https://github.com/feiyang-dev/dsh-usage-plugin#readme",
+  "bugs": {
+    "url": "https://github.com/feiyang-dev/dsh-usage-plugin/issues"
+  },
+  "exports": {
+    ".": "./lib/index.js",
+    "./client": "./lib/client.js",
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dsh": {
+    "bundle": {
+      "patch": "./cordis.patch.yml"
+    },
+    "client": {
+      "platform": "web",
+      "inject": [
+        "@deepseek-ai/dsh-client-ui-conversation"
+      ]
+    }
+  },
+  "files": [
+    "lib",
+    "scripts",
+    "cordis.patch.yml",
+    "README.md",
+    "README.en.md",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "wire": "node scripts/wire.js",
+    "check": "node scripts/check-package.js",
+    "prepublishOnly": "node scripts/check-package.js",
+    "pack": "npm pack"
+  },
+  "peerDependencies": {
+    "@deepseek-ai/cordis": "^4.0.1"
+  }
+}

package/scripts/check-package.js

@@ -0,0 +1,84 @@
+/**
+ * dsh-usage-plugin — pre-publish sanity gate (dependency-free).
+ *
+ * Run by `npm run check` and `npm run prepublishOnly` before the package is
+ * packed/uploaded. It verifies every piece of the DSH plugin contract that
+ * would otherwise fail LOUDLY at boot or client-load time when missing:
+ *
+ *   1. `dsh.bundle.patch` — the profile bundle patch file exists and carries a
+ *      valid insert entry naming this package (auto-activation via
+ *      `dsh plugin --profile <name> add <pkg>` depends on it).
+ *   2. `dsh.client` — the web client declaration and `exports["./client"]`
+ *      bundle exist (the host serves it at `/plugins/<name>/client.js`).
+ *   3. `files` — the publish whitelist covers every artifact above.
+ *
+ * This is a structural gate, not a full parser; the authoritative YAML +
+ * loader-composition validation is done by DSH itself at profile boot.
+ */
+import { readFileSync, existsSync } from "node:fs";
+import { resolve, dirname } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const pkgDir = resolve(dirname(fileURLToPath(import.meta.url)), "..");
+
+const fail = (message) => {
+	console.error(`[check-package] FAIL: ${message}`);
+	process.exitCode = 1;
+};
+
+let ok = true;
+const check = (condition, message) => {
+	if (!condition) {
+		fail(message);
+		ok = false;
+	}
+};
+
+let pkg;
+try {
+	pkg = JSON.parse(readFileSync(resolve(pkgDir, "package.json"), "utf8"));
+} catch (error) {
+	console.error(`[check-package] FAIL: cannot read package.json: ${String(error && error.message || error)}`);
+	process.exit(1);
+}
+
+// ── identity ───────────────────────────────────────────────────────────────
+check(typeof pkg.name === "string" && pkg.name.length > 0, "package.json must declare a name");
+check(typeof pkg.version === "string" && /^\d+\.\d+\.\d+/.test(pkg.version), `invalid version ${JSON.stringify(pkg.version)}`);
+
+// ── dsh.bundle patch (host-side auto-activation) ───────────────────────────
+const bundlePatch = pkg.dsh && pkg.dsh.bundle && pkg.dsh.bundle.patch;
+check(typeof bundlePatch === "string" && bundlePatch.length > 0, 'package.json must declare "dsh": { "bundle": { "patch": "..." } }');
+if (typeof bundlePatch === "string") {
+	const patchPath = resolve(pkgDir, bundlePatch);
+	check(existsSync(patchPath), `dsh.bundle.patch file not found: ${bundlePatch}`);
+	if (existsSync(patchPath)) {
+		const text = readFileSync(patchPath, "utf8");
+		check(text.includes("- insert:"), `bundle patch ${bundlePatch} must contain a top-level "- insert:" entry`);
+		check(text.includes(`name: '${pkg.name}'`) || text.includes(`name: "${pkg.name}"`), `bundle patch ${bundlePatch} must insert an entry with name: '${pkg.name}'`);
+		const required = ["fs", "webServer", "subprocess", "credentials", "sandboxPolicy", "agents"];
+		const missing = required.filter((service) => !text.includes(`- ${service}`));
+		check(missing.length === 0, `bundle patch ${bundlePatch} is missing inject entries: ${missing.join(", ")}`);
+	}
+}
+
+// ── dsh.client + client bundle (browser half) ──────────────────────────────
+const clientDecl = pkg.dsh && pkg.dsh.client;
+check(clientDecl !== null && typeof clientDecl === "object", 'package.json must declare "dsh": { "client": { "platform": "web", ... } }');
+if (clientDecl !== null && typeof clientDecl === "object") {
+	check(clientDecl.platform === "web", `dsh.client.platform must be "web" (got ${JSON.stringify(clientDecl.platform)})`);
+	check(Array.isArray(clientDecl.inject) && clientDecl.inject.length > 0, "dsh.client.inject must be a non-empty string array");
+}
+const clientRel = pkg.exports && (typeof pkg.exports["./client"] === "string" ? pkg.exports["./client"] : (pkg.exports["./client"] && pkg.exports["./client"].default));
+check(typeof clientRel === "string", 'package.json must export "./client" pointing at the client bundle');
+if (typeof clientRel === "string") {
+	check(existsSync(resolve(pkgDir, clientRel)), `client bundle not found: ${clientRel} (run the client build before publishing)`);
+}
+
+// ── files whitelist ────────────────────────────────────────────────────────
+check(Array.isArray(pkg.files), "package.json must declare a files whitelist");
+for (const entry of pkg.files || []) {
+	check(existsSync(resolve(pkgDir, entry)), `files entry not found: ${entry}`);
+}
+
+if (ok) console.log(`[check-package] OK — ${pkg.name}@${pkg.version} satisfies the DSH plugin contract`);

package/scripts/wire.js

@@ -0,0 +1,108 @@
+/**
+ * dsh-usage-plugin — wiring script (LEGACY fallback).
+ *
+ * PREFERRED INSTALL: this package declares `dsh.bundle`, so it auto-activates
+ * with a single command and NO manual wiring:
+ *
+ *   dsh plugin --profile web add @feiyang666/dsh-usage-plugin
+ *
+ * This script exists only for the manual fallback path (installing the package
+ * by hand into a profile's node_modules): it appends the plugin row to the
+ * profile's `cordis.patch.yml` so the plugin loads with the web app:
+ *
+ *   npm run wire
+ *
+ * It is idempotent: running it again never duplicates the row. If it cannot
+ * find a profile patch it prints what to add manually and exits non-zero.
+ */
+import { readFileSync, writeFileSync, existsSync, readdirSync } from "node:fs";
+import { resolve, join, dirname } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const here = dirname(fileURLToPath(import.meta.url));
+const pkgDir = resolve(here, "..");
+const ROW_ID = "usage-plugin";
+const PACKAGE_NAME = JSON.parse(readFileSync(join(pkgDir, "package.json"), "utf8")).name || "dsh-usage-plugin";
+
+function candidateRoots() {
+  const roots = [];
+  // When installed at <profilesRoot>/node_modules/dsh-usage-plugin, the
+  // profiles root is two levels up; try several depths for other layouts.
+  for (let up = 1; up <= 4; up++) {
+    let p = pkgDir;
+    for (let i = 0; i < up; i++) p = resolve(p, "..");
+    roots.push(p);
+  }
+  if (process.env.DSH_HOME) {
+    roots.push(join(process.env.DSH_HOME, "profiles"));
+    roots.push(process.env.DSH_HOME);
+  }
+  return roots;
+}
+
+function findPatches(roots) {
+  const seen = new Set();
+  const patches = [];
+  for (const root of roots) {
+    let entries;
+    try {
+      entries = readdirSync(root, { withFileTypes: true });
+    } catch {
+      continue;
+    }
+    for (const entry of entries) {
+      if (!entry.isDirectory() || entry.name === "node_modules") continue;
+      const patch = join(root, entry.name, "cordis.patch.yml");
+      if (existsSync(patch) && !seen.has(patch)) {
+        seen.add(patch);
+        patches.push(patch);
+      }
+    }
+  }
+  return patches;
+}
+
+function alreadyWired(text) {
+  return text.includes(`id: ${ROW_ID}`);
+}
+
+function wire(patchPath) {
+  const text = readFileSync(patchPath, "utf8");
+  if (alreadyWired(text)) {
+    console.log(`[dsh-usage-plugin] already wired in ${patchPath}`);
+    return true;
+  }
+  const block =
+    "\n# " + PACKAGE_NAME + ": usage & cost tracking (installed via npm).\n" +
+    "- insert:\n" +
+    "    - id: " + ROW_ID + "\n" +
+    "      name: '" + PACKAGE_NAME + "'\n" +
+    "      inject:\n" +
+    "        - fs\n" +
+    "        - webServer\n" +
+    "        - subprocess\n" +
+    "        - credentials\n" +
+    "        - sandboxPolicy\n" +
+    "        - agents\n";
+  writeFileSync(patchPath, text.endsWith("\n") ? text + block : text + "\n" + block, "utf8");
+  console.log(`[dsh-usage-plugin] wired into ${patchPath}`);
+  return true;
+}
+
+const patches = findPatches(candidateRoots());
+if (patches.length === 0) {
+  console.error(
+    "[dsh-usage-plugin] no DSH profile patch found. Preferred: install with `dsh plugin --profile web add " + PACKAGE_NAME + "` (auto-wires via dsh.bundle, no manual editing).\n" +
+    "Manual fallback — add this row to your profile's cordis.patch.yml, then restart the app:\n\n" +
+    "- insert:\n" +
+    "    - id: " + ROW_ID + "\n" +
+    "      name: '" + PACKAGE_NAME + "'\n"
+  );
+  process.exit(1);
+}
+let ok = true;
+for (const patch of patches) ok = wire(patch) && ok;
+if (ok) {
+  console.log("[dsh-usage-plugin] done. Restart the DeepSeek Harness web app for the plugin to load.");
+}
+process.exit(ok ? 0 : 1);