@zhin.js/plugin-ledger 1.0.1 → 1.0.3

package/lib/tool-caller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tool-caller.js","sourceRoot":"","sources":["../src/tool-caller.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAe,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAuB,MAAM,SAAS,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAqB,MAAM,iBAAiB,CAAC;AACtE,OAAO,EAAE,QAAQ,IAAI,CAAC,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAqB,MAAM,eAAe,CAAC;AAuBpF,SAAS,UAAU,CACjB,MAAwB;IAExB,OAAO,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC;AAC9B,CAAC;AAED,SAAS,uBAAuB,CAAC,OAAgC,EAAE,MAAc;IAC/E,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC9B,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,gBAAgB,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACjD,CAAC;IACD,IAAI,UAAU,GAAG,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,EAAE,IAAI,MAAM,CAAC,QAAQ,CAAC;IACrE,IAAI,OAAO,OAAO,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;QAC1C,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAe,gBAAgB,CAAC,CAAC;YAC9D,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;gBAClD,MAAM,OAAO,GAAG,KAAK;qBAClB,QAAQ,EAAE;qBACV,MAAM,CACL,CAAC,QAAQ,EAAE,EAAE,CACX,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAI,KAAK,MAAM,CAAC,QAAQ,CAAC;oBAC9E,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC,QAAQ,CACvD,CAAC;gBACJ,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACzB,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAE,CAAC,EAAE,CAAC,CAAC;gBACtC,CAAC;YACH,CAAC;QACH,CAAC;QAAC,MAAM,CAAC;YACP,oGAAoG;QACtG,CAAC;IACH,CAAC;IACD,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,gBAAgB,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACjD,CAAC;IACD,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;QACxB,OAAO,oBAAoB,CAAC;YAC1B,YAAY,EAAE;gBACZ,GAAG,MAAM,CAAC,YAAY;gBACtB,QAAQ,EAAE,EAAE,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE;aACvD;SACF,CAAC,CAAC;IACL,CAAC;IACD,OAAO,oBAAoB,CAAC;QAC1B,YAAY,EAAE;YACZ,QAAQ,EAAE,EAAE,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE;YACtD,IAAI,EAAE,MAAM,CAAC,KAAK;YAClB,EAAE,EAAE,MAAM,CAAC,OAAO;YAClB,GAAG,CAAC,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACxE;KACF,CAAC,CAAC;AACL,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,oBAAoB,CAAC,OAAgC;IACnE,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,IAAI,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC;IAC5E,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,gBAAgB,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IACjD,CAAC;IACD,MAAM,YAAY,GAAG,uBAAuB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC9D,MAAM,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC;IACvC,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,KAAK,SAAS,CAAC;IAClD,MAAM,aAAa,GAAmB,SAAS;QAC7C,CAAC,CAAC,YAAY;QACd,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC/D,OAAO;QACL,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;QACjE,QAAQ;QACR,MAAM;QACN,YAAY;QACZ,aAAa;QACb,SAAS;KACV,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/plugin-ledger",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Personal expense ledger for Zhin.js (Plugin Runtime): per-user entries in integer cents, period and category summaries, group privacy and an opt-in daily report",
   "type": "module",
   "main": "./lib/index.js",
@@ -16,8 +16,10 @@
     "README.md",
     "commands",
     "lib",
+    "pages",
     "plugin.js",
     "schedules",
+    "skills",
     "src",
     "schema.json"
   ],
@@ -34,10 +36,21 @@
     "email": "admin@liucl.cn",
     "url": "https://github.com/lc-cn"
   },
+  "dependencies": {
+    "@zhin.js/client": "1.1.25",
+    "@zhin.js/console-contract": "1.1.3",
+    "@zhin.js/page": "1.1.15",
+    "@zhin.js/skill": "1.1.14",
+    "@zhin.js/tool": "1.1.16"
+  },
   "peerDependencies": {
-    "zhin.js": "^1.1.13",
-    "@zhin.js/command": "^1.1.9",
-    "@zhin.js/schedule-feature": "^1.1.7"
+    "zod": "^4.0.0",
+    "zhin.js": "^1.1.22",
+    "@zhin.js/command": "^1.1.15",
+    "@zhin.js/page": "^1.1.15",
+    "@zhin.js/schedule-feature": "^1.1.13",
+    "@zhin.js/skill": "^1.1.14",
+    "@zhin.js/tool": "^1.1.16"
   },
   "peerDependenciesMeta": {
     "@zhin.js/command": {
@@ -45,14 +58,18 @@
     },
     "@zhin.js/schedule-feature": {
       "optional": true
+    },
+    "zod": {
+      "optional": true
     }
   },
   "devDependencies": {
     "typescript": "^6.0.3",
     "vitest": "^4.1.10",
-    "@zhin.js/schedule-feature": "1.1.7",
-    "@zhin.js/testing": "1.0.5",
-    "zhin.js": "1.1.13"
+    "zod": "^4.4.3",
+    "@zhin.js/schedule-feature": "1.1.13",
+    "@zhin.js/testing": "1.0.8",
+    "zhin.js": "1.1.22"
   },
   "engines": {
     "node": ">=22.19.0"
@@ -81,6 +98,18 @@
       {
         "package": "@zhin.js/schedule-feature",
         "api": "^1.0.0"
+      },
+      {
+        "package": "@zhin.js/tool",
+        "api": "^1.1.0"
+      },
+      {
+        "package": "@zhin.js/skill",
+        "api": "^1.0.0"
+      },
+      {
+        "package": "@zhin.js/page",
+        "api": "^1.0.0"
       }
     ],
     "plugins": []

package/pages/index/index.js

@@ -0,0 +1,63 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { definePage } from '@zhin.js/console-contract';
+import { createDeclarativePage } from '@zhin.js/client';
+export const meta = definePage({
+    title: '记账本',
+    titleI18n: { en: 'Ledger' },
+    icon: 'Wallet',
+    order: 50,
+    requiredPermissions: ['ledger:read'],
+});
+export default createDeclarativePage({
+    title: { zh: '记账本', en: 'Ledger' },
+    description: {
+        zh: '个人记账日报订阅状态与运行配置概览。',
+        en: 'Personal expense ledger daily report subscriptions and runtime configuration.',
+    },
+    stats: [
+        {
+            key: 'subscriberCount',
+            label: { zh: '日报订阅数', en: 'Report Subscribers' },
+            value: 'subscriberCount',
+        },
+        {
+            key: 'reportTime',
+            label: { zh: '日报发送时间', en: 'Report Time' },
+            value: 'reportTime',
+        },
+        {
+            key: 'timezone',
+            label: { zh: '统计时区', en: 'Timezone' },
+            value: 'timezone',
+        },
+    ],
+    actions: [
+        {
+            name: 'run-daily-reports',
+            label: { zh: '执行日报发送', en: 'Run Daily Reports' },
+            variant: 'primary',
+        },
+    ],
+    sections: [
+        {
+            id: 'subscribers',
+            title: { zh: '日报订阅用户', en: 'Daily Report Subscribers' },
+            emptyText: { zh: '暂无开启记账日报的用户', en: 'No users have enabled daily reports.' },
+            items: 'subscribers',
+            columns: [
+                { key: 'ownerKey', label: { zh: '用户标识', en: 'Owner Key' } },
+                { key: 'reportLocale', label: { zh: '语言', en: 'Locale' } },
+                { key: 'lastReportDate', label: { zh: '最近发送日期', en: 'Last Report Date' } },
+            ],
+        },
+        {
+            id: 'config',
+            title: { zh: '配置详情', en: 'Configuration' },
+            entries: (data) => [
+                { label: 'Timezone', value: data.timezone },
+                { label: 'Report Time', value: data.reportTime },
+                { label: 'Report When Empty', value: data.reportWhenEmpty ? 'Yes' : 'No' },
+            ],
+        },
+    ],
+});

package/pages/index/index.ts

@@ -0,0 +1,65 @@
+import { definePage } from '@zhin.js/console-contract';
+import { createDeclarativePage } from '@zhin.js/client';
+import type { LedgerConsoleSnapshot, LedgerConsoleSubscriber } from '../../src/service.js';
+
+export const meta = definePage({
+  title: '记账本',
+  titleI18n: { en: 'Ledger' },
+  icon: 'Wallet',
+  order: 50,
+  requiredPermissions: ['ledger:read'],
+});
+
+export default createDeclarativePage<LedgerConsoleSnapshot>({
+  title: { zh: '记账本', en: 'Ledger' },
+  description: {
+    zh: '个人记账日报订阅状态与运行配置概览。',
+    en: 'Personal expense ledger daily report subscriptions and runtime configuration.',
+  },
+  stats: [
+    {
+      key: 'subscriberCount',
+      label: { zh: '日报订阅数', en: 'Report Subscribers' },
+      value: 'subscriberCount',
+    },
+    {
+      key: 'reportTime',
+      label: { zh: '日报发送时间', en: 'Report Time' },
+      value: 'reportTime',
+    },
+    {
+      key: 'timezone',
+      label: { zh: '统计时区', en: 'Timezone' },
+      value: 'timezone',
+    },
+  ],
+  actions: [
+    {
+      name: 'run-daily-reports',
+      label: { zh: '执行日报发送', en: 'Run Daily Reports' },
+      variant: 'primary',
+    },
+  ],
+  sections: [
+    {
+      id: 'subscribers',
+      title: { zh: '日报订阅用户', en: 'Daily Report Subscribers' },
+      emptyText: { zh: '暂无开启记账日报的用户', en: 'No users have enabled daily reports.' },
+      items: 'subscribers',
+      columns: [
+        { key: 'ownerKey', label: { zh: '用户标识', en: 'Owner Key' } },
+        { key: 'reportLocale', label: { zh: '语言', en: 'Locale' } },
+        { key: 'lastReportDate', label: { zh: '最近发送日期', en: 'Last Report Date' } },
+      ] satisfies readonly { readonly key: keyof LedgerConsoleSubscriber & string; readonly label: { readonly zh: string; readonly en: string } }[],
+    },
+    {
+      id: 'config',
+      title: { zh: '配置详情', en: 'Configuration' },
+      entries: (data) => [
+        { label: 'Timezone', value: data.timezone },
+        { label: 'Report Time', value: data.reportTime },
+        { label: 'Report When Empty', value: data.reportWhenEmpty ? 'Yes' : 'No' },
+      ],
+    },
+  ],
+});

package/plugin.js

@@ -1,6 +1,7 @@
 // Generated by build-plugin-runtime-entries.mjs. Do not edit.
-import { databaseHostToken, definePlugin, outboundHostToken } from 'zhin.js';
+import { databaseHostToken, definePlugin, outboundHostToken, pluginConsoleRpcToken } from 'zhin.js';
 import { resolveLedgerConfig } from "./lib/config.js";
+import { createLedgerConsoleRpc } from "./lib/console.js";
 import { ledgerServiceToken } from "./lib/runtime.js";
 import { LedgerService } from "./lib/service.js";
 import { defineLedgerTables } from "./lib/store.js";
@@ -15,5 +16,6 @@ export default definePlugin({
         const outbound = context.resources.has(outboundHostToken) ? context.resources.use(outboundHostToken) : undefined;
         const service = new LedgerService(database, outbound, config);
         context.resources.provide(ledgerServiceToken, service);
+        context.resources.provide(pluginConsoleRpcToken, createLedgerConsoleRpc(service));
     },
 });

package/schema.json

@@ -8,6 +8,11 @@
       "default": "Asia/Shanghai",
       "x-zhin-config": {
         "effect": "reload"
+      },
+      "x-i18n": {
+        "en": {
+          "description": "IANA timezone used to calculate today, this week (starting Monday), this month and daily-report dates."
+        }
       }
     },
     "reportTime": {
@@ -17,6 +22,11 @@
       "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d$",
       "x-zhin-config": {
         "effect": "reload"
+      },
+      "x-i18n": {
+        "en": {
+          "description": "Daily ledger report time (HH:MM in timezone); sent only to users who explicitly subscribed to daily reports."
+        }
       }
     },
     "reportWhenEmpty": {
@@ -25,6 +35,11 @@
       "default": false,
       "x-zhin-config": {
         "effect": "reload"
+      },
+      "x-i18n": {
+        "en": {
+          "description": "Send a daily report even when no transactions were recorded that day."
+        }
       }
     }
   }

package/skills/ledger/SKILL.md

@@ -0,0 +1,41 @@
+---
+name: ledger
+description: >-
+  Personal expense ledger — record expenses, delete entries, view today/week/month spending summaries and category breakdowns.
+keywords:
+  - 记账
+  - 账单
+  - 消费
+  - 支出
+  - 开销
+  - ledger
+  - expense
+tags:
+  - ledger
+  - finance
+tools:
+  - ledger_add
+  - ledger_summary
+  - ledger_list
+  - ledger_delete
+---
+
+# 个人记账本 (Personal Ledger)
+
+## 何时使用本技能
+
+- 用户想记录一笔消费/支出（如「记一笔午饭 18.5 元」「打车花了 32」）
+- 用户想查看今日、本周或本月的消费汇总或分类占比
+- 用户想列出近期的账单明细或按编号删除某笔账目
+
+## 工作流
+
+1. **记账 (`ledger_add`)**：提取类别（`category`）、金额（`amount`，正数元）与可选备注（`note`）。需要用户批准。
+2. **消费汇总与分类统计 (`ledger_summary`)**：按 `period`（`today` / `week` / `month`）查看总览（`mode: "summary"`）或分类统计（`mode: "categories"`）。
+3. **账单明细 (`ledger_list`)**：按 `period` 查看带 `#编号` 的账单列表。
+4. **删除账目 (`ledger_delete`)**：传入账目编号 `seq` 删除对应记录。需要用户批准。
+
+## 注意
+
+- 账目按发送者隔离，用户只能操作自己的账本。
+- 群聊场景下会自动保护金额隐私（优先私信发送完整账单或在群内脱敏显示）。

package/skills/ledger/tools/ledger_add/index.js

@@ -0,0 +1,25 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { replyLedger } from "../../../../lib/identity.js";
+import { ledgerServiceToken } from "../../../../lib/runtime.js";
+import { ledgerCallerFromTool } from "../../../../lib/tool-caller.js";
+export default defineAgentTool({
+    description: 'Record a personal expense entry in the current user’s ledger with a category, positive amount, and optional note.',
+    requiresApproval: 'always',
+    tags: ['ledger', 'finance'],
+    keywords: ['记账', '消费', '支出', '开销', 'ledger', 'expense'],
+    inputSchema: z.object({
+        category: z.string().min(1).max(32).describe('Expense category, e.g. 午饭, 打车'),
+        amount: z.number().positive().describe('Expense amount in yuan, e.g. 18.5'),
+        note: z.string().max(120).optional().describe('Optional note for the expense'),
+    }),
+    async execute({ category, amount, note }, context) {
+        return replyLedger(async () => {
+            const caller = ledgerCallerFromTool(context);
+            const service = context.use(ledgerServiceToken);
+            const text = `${category} ${amount}${note ? ` ${note}` : ''}`;
+            return service.addEntry(caller, text);
+        });
+    },
+});

package/skills/ledger/tools/ledger_add/index.ts

@@ -0,0 +1,26 @@
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { replyLedger } from '../../../../src/identity.js';
+import { ledgerServiceToken } from '../../../../src/runtime.js';
+import { ledgerCallerFromTool } from '../../../../src/tool-caller.js';
+
+export default defineAgentTool({
+  description:
+    'Record a personal expense entry in the current user’s ledger with a category, positive amount, and optional note.',
+  requiresApproval: 'always',
+  tags: ['ledger', 'finance'],
+  keywords: ['记账', '消费', '支出', '开销', 'ledger', 'expense'],
+  inputSchema: z.object({
+    category: z.string().min(1).max(32).describe('Expense category, e.g. 午饭, 打车'),
+    amount: z.number().positive().describe('Expense amount in yuan, e.g. 18.5'),
+    note: z.string().max(120).optional().describe('Optional note for the expense'),
+  }),
+  async execute({ category, amount, note }, context) {
+    return replyLedger(async () => {
+      const caller = ledgerCallerFromTool(context);
+      const service = context.use(ledgerServiceToken);
+      const text = `${category} ${amount}${note ? ` ${note}` : ''}`;
+      return service.addEntry(caller, text);
+    });
+  },
+});

package/skills/ledger/tools/ledger_delete/index.js

@@ -0,0 +1,22 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { replyLedger } from "../../../../lib/identity.js";
+import { ledgerServiceToken } from "../../../../lib/runtime.js";
+import { ledgerCallerFromTool } from "../../../../lib/tool-caller.js";
+export default defineAgentTool({
+    description: 'Delete one of the current user’s expense entries by its sequence number (#id).',
+    requiresApproval: 'always',
+    tags: ['ledger', 'finance'],
+    keywords: ['删账', '删除记账', 'delete expense', 'ledger delete'],
+    inputSchema: z.object({
+        seq: z.number().int().positive().describe('Per-user entry sequence number (#id)'),
+    }),
+    async execute({ seq }, context) {
+        return replyLedger(async () => {
+            const caller = ledgerCallerFromTool(context);
+            const service = context.use(ledgerServiceToken);
+            return service.deleteEntry(caller, seq);
+        });
+    },
+});

package/skills/ledger/tools/ledger_delete/index.ts

@@ -0,0 +1,23 @@
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { replyLedger } from '../../../../src/identity.js';
+import { ledgerServiceToken } from '../../../../src/runtime.js';
+import { ledgerCallerFromTool } from '../../../../src/tool-caller.js';
+
+export default defineAgentTool({
+  description:
+    'Delete one of the current user’s expense entries by its sequence number (#id).',
+  requiresApproval: 'always',
+  tags: ['ledger', 'finance'],
+  keywords: ['删账', '删除记账', 'delete expense', 'ledger delete'],
+  inputSchema: z.object({
+    seq: z.number().int().positive().describe('Per-user entry sequence number (#id)'),
+  }),
+  async execute({ seq }, context) {
+    return replyLedger(async () => {
+      const caller = ledgerCallerFromTool(context);
+      const service = context.use(ledgerServiceToken);
+      return service.deleteEntry(caller, seq);
+    });
+  },
+});

package/skills/ledger/tools/ledger_list/index.js

@@ -0,0 +1,23 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { replyLedger } from "../../../../lib/identity.js";
+import { ledgerServiceToken } from "../../../../lib/runtime.js";
+import { ledgerCallerFromTool } from "../../../../lib/tool-caller.js";
+export default defineAgentTool({
+    description: 'List personal expense entries for today, this week, or this month with their sequence numbers (#id).',
+    requiresApproval: 'never',
+    readOnly: true,
+    tags: ['ledger', 'finance'],
+    keywords: ['账单', '账目列表', '消费明细', 'ledger list', 'expenses'],
+    inputSchema: z.object({
+        period: z.enum(['today', 'week', 'month']).default('today').describe('Time period: today, week, or month'),
+    }),
+    async execute({ period = 'today' }, context) {
+        return replyLedger(async () => {
+            const caller = ledgerCallerFromTool(context);
+            const service = context.use(ledgerServiceToken);
+            return service.listEntries(caller, period);
+        });
+    },
+});

package/skills/ledger/tools/ledger_list/index.ts

@@ -0,0 +1,24 @@
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { replyLedger } from '../../../../src/identity.js';
+import { ledgerServiceToken } from '../../../../src/runtime.js';
+import { ledgerCallerFromTool } from '../../../../src/tool-caller.js';
+
+export default defineAgentTool({
+  description:
+    'List personal expense entries for today, this week, or this month with their sequence numbers (#id).',
+  requiresApproval: 'never',
+  readOnly: true,
+  tags: ['ledger', 'finance'],
+  keywords: ['账单', '账目列表', '消费明细', 'ledger list', 'expenses'],
+  inputSchema: z.object({
+    period: z.enum(['today', 'week', 'month']).default('today').describe('Time period: today, week, or month'),
+  }),
+  async execute({ period = 'today' }, context) {
+    return replyLedger(async () => {
+      const caller = ledgerCallerFromTool(context);
+      const service = context.use(ledgerServiceToken);
+      return service.listEntries(caller, period);
+    });
+  },
+});

package/skills/ledger/tools/ledger_summary/index.js

@@ -0,0 +1,27 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { replyLedger } from "../../../../lib/identity.js";
+import { ledgerServiceToken } from "../../../../lib/runtime.js";
+import { ledgerCallerFromTool } from "../../../../lib/tool-caller.js";
+export default defineAgentTool({
+    description: 'View personal spending summary or category statistics for today, this week, or this month.',
+    requiresApproval: 'never',
+    readOnly: true,
+    tags: ['ledger', 'finance'],
+    keywords: ['消费汇总', '分类统计', '账单统计', 'ledger summary', 'spending'],
+    inputSchema: z.object({
+        period: z.enum(['today', 'week', 'month']).default('month').describe('Time period: today, week, or month'),
+        mode: z.enum(['summary', 'categories']).default('summary').describe('Summary view or detailed category statistics'),
+    }),
+    async execute({ period = 'month', mode = 'summary' }, context) {
+        return replyLedger(async () => {
+            const caller = ledgerCallerFromTool(context);
+            const service = context.use(ledgerServiceToken);
+            if (mode === 'categories') {
+                return service.categoryStatistics(caller, period);
+            }
+            return service.periodSummary(caller, period);
+        });
+    },
+});

package/skills/ledger/tools/ledger_summary/index.ts

@@ -0,0 +1,28 @@
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { replyLedger } from '../../../../src/identity.js';
+import { ledgerServiceToken } from '../../../../src/runtime.js';
+import { ledgerCallerFromTool } from '../../../../src/tool-caller.js';
+
+export default defineAgentTool({
+  description:
+    'View personal spending summary or category statistics for today, this week, or this month.',
+  requiresApproval: 'never',
+  readOnly: true,
+  tags: ['ledger', 'finance'],
+  keywords: ['消费汇总', '分类统计', '账单统计', 'ledger summary', 'spending'],
+  inputSchema: z.object({
+    period: z.enum(['today', 'week', 'month']).default('month').describe('Time period: today, week, or month'),
+    mode: z.enum(['summary', 'categories']).default('summary').describe('Summary view or detailed category statistics'),
+  }),
+  async execute({ period = 'month', mode = 'summary' }, context) {
+    return replyLedger(async () => {
+      const caller = ledgerCallerFromTool(context);
+      const service = context.use(ledgerServiceToken);
+      if (mode === 'categories') {
+        return service.categoryStatistics(caller, period);
+      }
+      return service.periodSummary(caller, period);
+    });
+  },
+});

package/src/config.ts

@@ -4,9 +4,9 @@ export const DEFAULT_TIMEZONE = 'Asia/Shanghai';
 export const DEFAULT_REPORT_TIME = '22:00';
 
 export const ledgerConfig = Schema.object({
-  timezone: Schema.string().default(DEFAULT_TIMEZONE).description('计算今日、本周（周一开始）、本月与日报日期所用的 IANA 时区').effect('reload'),
-  reportTime: Schema.string().default(DEFAULT_REPORT_TIME).description('记账日报的发送时间（HH:MM，按 timezone）；只发给用「记账日报 开启」订阅的用户').effect('reload'),
-  reportWhenEmpty: Schema.boolean().default(false).description('当天没有记账时是否仍发送日报').effect('reload'),
+  timezone: Schema.string().default(DEFAULT_TIMEZONE).description('计算今日、本周（周一开始）、本月与日报日期所用的 IANA 时区').i18n({"en": {"description": "IANA timezone used to calculate today, this week (starting Monday), this month and daily-report dates."}}).effect('reload'),
+  reportTime: Schema.string().default(DEFAULT_REPORT_TIME).description('记账日报的发送时间（HH:MM，按 timezone）；只发给用「记账日报 开启」订阅的用户').i18n({"en": {"description": "Daily ledger report time (HH:MM in timezone); sent only to users who explicitly subscribed to daily reports."}}).effect('reload'),
+  reportWhenEmpty: Schema.boolean().default(false).description('当天没有记账时是否仍发送日报').i18n({"en": {"description": "Send a daily report even when no transactions were recorded that day."}}).effect('reload'),
 });
 
 export type LedgerConfig = Schema.Output<typeof ledgerConfig>;

package/src/console.ts

@@ -0,0 +1,47 @@
+import {
+  definePluginConsoleRpc,
+  PluginConsoleRpcError,
+  type PluginConsoleRpc,
+  type PluginConsoleRpcCall,
+} from 'zhin.js';
+import { ledgerServiceToken } from './runtime.js';
+import type { LedgerService } from './service.js';
+
+function resolveService(
+  provided: LedgerService | undefined,
+  call: PluginConsoleRpcCall,
+): LedgerService {
+  if (provided) return provided;
+  const runtimeWithUse = call.runtime as { use?: (token: typeof ledgerServiceToken) => LedgerService } | undefined;
+  const fromRuntime = runtimeWithUse?.use?.(ledgerServiceToken);
+  if (fromRuntime) return fromRuntime;
+  throw new PluginConsoleRpcError('unavailable', '记账服务尚未就绪');
+}
+
+export function createLedgerConsoleRpc(service?: LedgerService): PluginConsoleRpc {
+  const rpc = definePluginConsoleRpc({
+    status: {
+      page: 'index',
+      requiredPermissions: ['ledger:read'],
+      async handler(_input, call) {
+        return resolveService(service, call).getConsoleSnapshot();
+      },
+    },
+    actions: {
+      'run-daily-reports': {
+        page: 'index',
+        requiredPermissions: ['ledger:write'],
+        async handler(_input, call) {
+          const sent = await resolveService(service, call).runDailyReports();
+          return { sent };
+        },
+      },
+    },
+  });
+  const methods = rpc.methods as Map<string, ReturnType<PluginConsoleRpc['methods']['get']>>;
+  const originalGet = methods.get.bind(methods);
+  const originalHas = methods.has.bind(methods);
+  methods.get = (key: string) => originalGet(key === 'runDailyReports' ? 'run-daily-reports' : key);
+  methods.has = (key: string) => originalHas(key === 'runDailyReports' ? 'run-daily-reports' : key);
+  return rpc;
+}

package/src/entry-input.ts

@@ -1,9 +1,11 @@
+import { resolveLocale, type Locale } from 'zhin.js/i18n';
+import { messages as t } from './i18n.js';
 import { parseAmountToCents } from './money.js';
 
 export const MAX_CATEGORY_LENGTH = 20;
 export const MAX_NOTE_LENGTH = 100;
 
-export const ADD_USAGE = '格式：记 <类别> <金额> [备注]，例如：记 午饭 18.5 和同事';
+export const ADD_USAGE = t('zh-CN', 'usage');
 
 export interface ParsedEntryInput {
   readonly category: string;
@@ -20,20 +22,21 @@ function rejected(reason: string): EntryInputResult {
 }
 
 /** Parses the text after `记`: category, amount, then an optional free-form note. */
-export function parseEntryInput(text: string): EntryInputResult {
+export function parseEntryInput(text: string, locale?: Locale): EntryInputResult {
+  const usage = t(locale, 'usage');
   const words = text.trim().split(/\s+/u).filter((word) => word !== '');
-  if (words.length < 2) return rejected(ADD_USAGE);
+  if (words.length < 2) return rejected(usage);
   const category = words[0]!;
   const amountText = words[1]!;
   const note = words.slice(2).join(' ');
-  const amount = parseAmountToCents(amountText);
+  const amount = parseAmountToCents(amountText, locale);
   if (!amount.ok) {
     const categoryLooksLikeAmount = parseAmountToCents(category).ok;
-    if (categoryLooksLikeAmount) return rejected(`类别要写在金额前面。${ADD_USAGE}`);
-    return rejected(`${amount.reason}。${ADD_USAGE}`);
+    if (categoryLooksLikeAmount) return rejected(t(locale, 'order', { usage }));
+    return rejected(t(locale, 'amountError', { reason: amount.reason, usage }));
   }
-  if (parseAmountToCents(category).ok) return rejected(`类别不能是数字。${ADD_USAGE}`);
-  if ([...category].length > MAX_CATEGORY_LENGTH) return rejected(`类别最多 ${MAX_CATEGORY_LENGTH} 个字`);
-  if ([...note].length > MAX_NOTE_LENGTH) return rejected(`备注最多 ${MAX_NOTE_LENGTH} 个字`);
+  if (parseAmountToCents(category).ok) return rejected(t(locale, 'categoryNumber', { usage }));
+  if ([...category].length > MAX_CATEGORY_LENGTH) return rejected(t(locale, 'categoryLimit', { max: MAX_CATEGORY_LENGTH }));
+  if ([...note].length > MAX_NOTE_LENGTH) return rejected(t(locale, 'noteLimit', { max: MAX_NOTE_LENGTH }));
   return { ok: true, entry: { category, amountCents: amount.cents, note } };
 }