codex-quota-chip 0.0.0-stage → 0.1.1

package/README.md

@@ -1,3 +1,39 @@
-# Temporary Holding Version
+# codex-quota-chip (npm wrapper)
 
-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.
+这是 [Codex Quota Chip](https://github.com/easerlee/codex-quota-chip) 的 npm 外壳。
+**它不是 JavaScript 库** —— 本体是 C#/WPF 的 Windows 桌面程序，所以这个包做的事只有三件：
+
+1. 安装时从对应的 GitHub Release 下载自包含的 `CodexQuotaChip-<version>-win-x64.zip`；
+2. 用 `package.json` 里钉死的 sha256 校验，校验不过就拒绝解压；
+3. 解到包内 `vendor/`，然后 `codex-quota-chip` 这个命令把参数原样转给那个 exe。
+
+```sh
+npm install -g codex-quota-chip
+
+codex-quota-chip                       # 启动任务栏浮窗
+codex-quota-chip --check               # 打印状态目录 / codex 路径 / 停靠位置
+codex-quota-chip --once                # 读一次并打印 JSON
+```
+
+因为只有 Windows 构建，`package.json` 里限制为 `os: win32`，在别的系统上 npm 直接拒绝安装。
+想装真正的安装包/卸载脚本，用 GitHub Release 里的 zip，或者用 winget（见仓库首页）。
+
+## 卸载
+
+```sh
+npm uninstall -g codex-quota-chip
+```
+
+程序自己的状态目录（`%LOCALAPPDATA%\CodexQuotaChip`）不会被 npm 删除；要一起清就用 Release
+zip 里的 `uninstall.ps1 -Purge`，或手动删那个目录。
+
+## 发布（维护者）
+
+`package.json` 的 `version` 必须和 GitHub Release 的 tag（`v<version>`）一致，`sha256`
+必须是该 Release 上 zip 的哈希，否则安装会被自己的校验拦下：
+
+```powershell
+npm pack                       # 本地打 tarball，可先 --prefix 装到临时目录验证
+npm login
+npm publish
+```

package/bin/codex-quota-chip.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+// Launches the app that install.js unpacked, passing the arguments straight through, and exits
+// with the same code. Run without arguments it starts the taskbar overlay.
+'use strict';
+
+const { existsSync } = require('node:fs');
+const { spawnSync } = require('node:child_process');
+const path = require('node:path');
+
+const exe = path.join(__dirname, '..', 'vendor', 'CodexQuotaChip.exe');
+if (!existsSync(exe)) {
+  console.error('codex-quota-chip: the app is not unpacked yet - run "npm rebuild codex-quota-chip".');
+  process.exit(1);
+}
+
+const result = spawnSync(exe, process.argv.slice(2), { stdio: 'inherit' });
+process.exit(result.status === null ? 1 : result.status);

package/package.json

@@ -1,6 +1,46 @@
 {
   "name": "codex-quota-chip",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "Windows 任务栏上的 Codex 额度浮窗：装上就有一条 5H/周额度条和右键账号面板",
+  "license": "MIT",
+  "author": "easerlee",
+  "homepage": "https://github.com/easerlee/codex-quota-chip",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/easerlee/codex-quota-chip.git",
+    "directory": "npm"
+  },
+  "bugs": {
+    "url": "https://github.com/easerlee/codex-quota-chip/issues"
+  },
+  "keywords": [
+    "codex",
+    "quota",
+    "usage",
+    "taskbar",
+    "windows",
+    "overlay",
+    "wpf"
+  ],
+  "os": [
+    "win32"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "bin": {
+    "codex-quota-chip": "bin/codex-quota-chip.js"
+  },
+  "scripts": {
+    "postinstall": "node scripts/install.js"
+  },
+  "files": [
+    "bin",
+    "scripts",
+    "README.md"
+  ],
+  "codexQuotaChip": {
+    "_comment": "sha256 of CodexQuotaChip-<version>-win-x64.zip on the matching GitHub release. Bump it together with version, or the install refuses to run the download.",
+    "sha256": "235bd163fb2f7c54178587ec87b07e1cac4b2527b979a3396fc33ecbafd62bd3"
+  }
+}

package/scripts/install.js

@@ -0,0 +1,112 @@
+#!/usr/bin/env node
+// Downloads the Windows build from the GitHub release for this package's version, checks it
+// against the sha256 pinned in package.json, and unpacks it next to this package.
+//
+// This is a wrapper, not a JavaScript library: the app is a C#/WPF executable. The download is
+// verified before anything is extracted, and npm has no unzip of its own, so the extraction goes
+// through PowerShell's Expand-Archive (this package only installs on Windows anyway).
+'use strict';
+
+const { createHash } = require('node:crypto');
+const { execFileSync } = require('node:child_process');
+const { createWriteStream, existsSync, mkdirSync, rmSync, statSync } = require('node:fs');
+const path = require('node:path');
+const https = require('node:https');
+
+const packageRoot = path.join(__dirname, '..');
+const pkg = require(path.join(packageRoot, 'package.json'));
+const version = pkg.version;
+const asset = `CodexQuotaChip-${version}-win-x64.zip`;
+const url = `https://github.com/easerlee/codex-quota-chip/releases/download/v${version}/${asset}`;
+const expected = pkg.codexQuotaChip && pkg.codexQuotaChip.sha256;
+const vendor = path.join(packageRoot, 'vendor');
+const archive = path.join(vendor, asset);
+
+function fail(message) {
+  console.error(`codex-quota-chip: ${message}`);
+  console.error('You can also install the app itself from https://github.com/easerlee/codex-quota-chip/releases');
+  process.exit(1);
+}
+
+function download(from, to, redirects = 0) {
+  return new Promise((resolve, reject) => {
+    if (redirects > 5) {
+      reject(new Error('too many redirects'));
+      return;
+    }
+
+    https
+      .get(from, { headers: { 'user-agent': 'codex-quota-chip-npm' } }, (response) => {
+        const status = response.statusCode || 0;
+        if (status >= 300 && status < 400 && response.headers.location) {
+          response.resume();
+          download(response.headers.location, to, redirects + 1).then(resolve, reject);
+          return;
+        }
+        if (status !== 200) {
+          response.resume();
+          reject(new Error(`${status} while downloading ${from}`));
+          return;
+        }
+
+        const file = createWriteStream(to);
+        response.pipe(file);
+        file.on('finish', () => file.close(resolve));
+        file.on('error', reject);
+      })
+      .on('error', reject);
+  });
+}
+
+function sha256(file) {
+  const hash = createHash('sha256');
+  hash.update(require('node:fs').readFileSync(file));
+  return hash.digest('hex');
+}
+
+async function main() {
+  if (process.platform !== 'win32') {
+    fail('this package only installs on Windows');
+  }
+
+  if (!expected || expected.length !== 64) {
+    fail('package.json carries no sha256 for the download; refusing to fetch it');
+  }
+
+  mkdirSync(vendor, { recursive: true });
+  console.log(`codex-quota-chip: downloading ${asset} (${version}) ...`);
+
+  try {
+    await download(url, archive);
+  } catch (error) {
+    fail(`download failed: ${error.message}`);
+  }
+
+  const actual = sha256(archive);
+  if (actual !== expected) {
+    rmSync(archive, { force: true });
+    fail(`checksum mismatch: expected ${expected}, got ${actual}`);
+  }
+
+  console.log('codex-quota-chip: checksum ok, unpacking ...');
+  try {
+    execFileSync(
+      'powershell',
+      ['-NoProfile', '-NonInteractive', '-Command', `Expand-Archive -LiteralPath '${archive}' -DestinationPath '${vendor}' -Force`],
+      { stdio: 'inherit' }
+    );
+  } catch (error) {
+    fail(`could not unpack the archive: ${error.message}`);
+  }
+
+  const exe = path.join(vendor, 'CodexQuotaChip.exe');
+  if (!existsSync(exe) || statSync(exe).size === 0) {
+    fail('the archive did not contain CodexQuotaChip.exe');
+  }
+
+  rmSync(archive, { force: true });
+  console.log(`codex-quota-chip: ready - ${exe}`);
+  console.log('run "codex-quota-chip" to start it, or launch the exe directly.');
+}
+
+main().catch((error) => fail(error.message));