@ycodium-ai/agent-fake 0.2.2690 → 0.2.2694

package/README.md

@@ -8,9 +8,12 @@ A minimal executor plugin. It starts no CLI and replays a fixed event script:
 - `interruptTurn` (or an aborted `AbortSignal`) ends the in-flight turn as `interrupted`
 - `readThread` returns the bookkeeping the instance recorded
 - `probe` reports two models, `fake` (default) and `fake-large`
+- `usage` answers quota and token reads deterministically (no network, no disk): `readQuota` returns a session and a weekly window that creep up by one percent per read, `readTokenUsage` returns one record per day for the past two weeks (alternating a priced and an unpriced model), `redeemQuotaReset` spends one of two reset credits and zeroes the session window
 
 The card also shows how a third-party executor gets its own settings form: `configSchema` marks `replyText` with `x-ycodium-form`, and the labels resolve in this package's `locales/en.json` and `locales/zh-CN.json`. `replyText` is what the plain script answers; empty means `fake turn complete`.
 
+The instance config `usageScript` picks how quota reads answer: `available` (default), `balance` (the API-key shape: a remaining CNY balance, no windows), `rate-limited`, `custom-endpoint` or `signed-out`. It is not in the settings form; edit the instance config to change it. The window labels are locale keys (`usage.window.session`, `usage.window.weekly`, `usage.balance.account`), a worked example of how an agent plugin labels its quota rows.
+
 Two uses:
 
 1. **Template** for an `@ycodium-ai/agent-*` author: one card, `createInstance`, lease-scoped `host.process.spawn` (this fake never calls it), `ctx.log` instead of console.

package/dist/index.js

@@ -43,6 +43,11 @@ var FAKE_CARD = {
       script: { type: "string", enum: ["plain", "approval-tool", "async-question", "stream"] },
       streamChunks: { type: "integer", minimum: 1 },
       streamIntervalMs: { type: "integer", minimum: 0 },
+      // 额度与用量怎么答（见 fakeUsage.ts）；不进设置表单，开发与验收时手改实例配置。
+      usageScript: {
+        type: "string",
+        enum: ["available", "balance", "rate-limited", "custom-endpoint", "signed-out"]
+      },
       replyText: {
         type: "string",
         "x-ycodium-form": {
@@ -63,6 +68,127 @@ var FAKE_CARD = {
 
 // src/fakeInstance.ts
 import * as NodeCrypto from "node:crypto";
+
+// src/fakeUsage.ts
+var FAKE_USAGE_SCRIPTS = [
+  "available",
+  "balance",
+  "rate-limited",
+  "custom-endpoint",
+  "signed-out"
+];
+var parseUsageScript = (input) => {
+  const config = input?.config;
+  return FAKE_USAGE_SCRIPTS.find((script) => script === config?.usageScript) ?? "available";
+};
+var HOUR_MS = 60 * 60 * 1e3;
+var DAY_MS = 24 * HOUR_MS;
+var INITIAL_RESET_CREDITS = 2;
+var FAKE_DAYS = 14;
+var createFakeUsage = (input) => {
+  const now = input.now ?? Date.now;
+  let reads = 0;
+  let resetCredits = INITIAL_RESET_CREDITS;
+  let sessionUsed = 40;
+  const readQuota = async () => {
+    switch (input.script) {
+      case "custom-endpoint":
+        return { status: "unavailable", reason: "customEndpoint" };
+      case "signed-out":
+        return { status: "unavailable", reason: "missingCredentials" };
+      case "rate-limited":
+        return { status: "unavailable", reason: "rateLimited", retryAfterMs: 3e4 };
+      case "balance":
+        reads += 1;
+        return {
+          status: "available",
+          windows: [],
+          balances: [
+            {
+              id: "account",
+              label: { key: "usage.balance.account" },
+              remaining: Math.max(0, 100 - reads),
+              used: null,
+              limit: null,
+              unit: { kind: "money", currency: "CNY" },
+              resetsAt: null
+            }
+          ],
+          accountKey: `fake:${input.instanceId}`
+        };
+      case "available":
+        reads += 1;
+        sessionUsed = Math.min(100, sessionUsed + 1);
+        return {
+          status: "available",
+          plan: "Fake Pro",
+          accountKey: `fake:${input.instanceId}`,
+          windows: [
+            {
+              id: "session",
+              label: { key: "usage.window.session" },
+              // 兑换过重置额度后，会话窗口从 0 重新算。
+              usedPercent: sessionUsed,
+              resetsAt: new Date(now() + 3 * HOUR_MS).toISOString(),
+              windowMs: 5 * HOUR_MS
+            },
+            {
+              id: "weekly",
+              label: { key: "usage.window.weekly" },
+              usedPercent: Math.min(100, 16 + reads),
+              resetsAt: new Date(now() + 4 * DAY_MS).toISOString(),
+              windowMs: 7 * DAY_MS
+            }
+          ],
+          balances: [],
+          resetCredits: { availableCount: resetCredits }
+        };
+    }
+  };
+  const readTokenUsage = async (request) => {
+    const since = Date.parse(request.since);
+    const until = Date.parse(request.until);
+    const todayStart = Math.floor(now() / DAY_MS) * DAY_MS;
+    const records = [];
+    for (let age = 0; age < FAKE_DAYS; age += 1) {
+      const at = todayStart - age * DAY_MS + 9 * HOUR_MS;
+      if (at < since || at >= until) continue;
+      records.push({
+        at: new Date(at).toISOString(),
+        // gpt-4o 在价格表里，fake-model 不在：两种费用来源都能在页面上看到。
+        model: age % 2 === 0 ? "gpt-4o" : "fake-model",
+        sessionId: `fake-${input.instanceId}-${age}`,
+        totals: {
+          uncachedInputTokens: 1200 + 100 * age,
+          cachedInputTokens: 8e3,
+          cacheCreationTokens: 300,
+          outputTokens: 900 + 50 * age,
+          reasoningTokens: 100
+        }
+      });
+    }
+    return {
+      records,
+      source: {
+        homePath: `fake://${input.instanceId}`,
+        volumeId: "fake",
+        status: "ok",
+        scannedFiles: FAKE_DAYS,
+        skippedFiles: 0
+      }
+    };
+  };
+  const redeemQuotaReset = async () => {
+    if (input.script !== "available") return { outcome: "nothingToReset" };
+    if (resetCredits <= 0) return { outcome: "noCredit" };
+    resetCredits -= 1;
+    sessionUsed = 0;
+    return { outcome: "reset" };
+  };
+  return { readQuota, readTokenUsage, redeemQuotaReset };
+};
+
+// src/fakeInstance.ts
 var yieldTick = () => Promise.resolve();
 var EventBus = class {
   #queued = [];
@@ -458,6 +584,7 @@ var createFakeInstance = (config, host) => {
       return { threadId, turns: booked.turns };
     },
     events,
+    usage: createFakeUsage({ instanceId: host.instanceId, script: parseUsageScript(config) }),
     dispose: async () => {
       disposed = true;
       inflight?.abort();

package/locales/en.json

@@ -5,5 +5,14 @@
       "description": "What the fake executor answers to every message. Leave empty to use the built-in reply.",
       "placeholder": "fake turn complete"
     }
+  },
+  "usage": {
+    "window": {
+      "session": "Session (5 hours)",
+      "weekly": "Weekly"
+    },
+    "balance": {
+      "account": "Account balance"
+    }
   }
 }

package/locales/zh-CN.json

@@ -5,5 +5,14 @@
       "description": "假执行器对每条消息的回答。留空就用内置的那句。",
       "placeholder": "fake turn complete"
     }
+  },
+  "usage": {
+    "window": {
+      "session": "会话（5 小时）",
+      "weekly": "每周"
+    },
+    "balance": {
+      "account": "账户余额"
+    }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ycodium-ai/agent-fake",
-  "version": "0.2.2690",
+  "version": "0.2.2694",
   "description": "Minimal fake executor for plugin authors and host orchestration tests.",
   "keywords": [
     "ycodium",
@@ -21,7 +21,8 @@
     "@types/node": "24.12.4",
     "esbuild": "0.28.1",
     "vite-plus": "0.2.2",
-    "@ycodium-ai/plugin-api": "0.2.2690"
+    "@ycodium-ai/plugin-api": "0.2.2694",
+    "ycodium-executor-testing": "0.0.0"
   },
   "ycodium": {
     "plugin": "./dist/index.js",