# @ekwo-ai/core 中文文档

规范地址：https://npmcn.com/package/%40ekwo-ai/core/

版本：0\.25\.2
npm 元数据更新时间：2026-11-13T14:11:16.447Z
中文译文更新时间：2026-11-13T18:21:30.518Z
软件包许可：AGPL-3\.0-only

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40ekwo-ai/core
原文对照：https://npmcn.com/package/%40ekwo-ai/core/?lang=original
项目主页：https://github.com/Ekwo-ai/ekwo-os#readme
源码仓库：https://github.com/Ekwo-ai/ekwo-os

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：939 kB，182 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：14 个
- peer 依赖：@supabase/supabase-js ^2\.0\.0
- 首次发布：2026-09-18T16:07:56.937Z
- 最新版本发布：2026-11-13T14:11:15.908Z
- 近 30 天下载量：3209（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：31（近 12 个月 31 个）

## 中文简介

TypeScript行类型和用于Ekwo OS会计计划的打入Supabase客户端.

## 安装

```sh
npm install @ekwo-ai/core
```

也可以使用：`pnpm add @ekwo-ai/core`、`yarn add @ekwo-ai/core`、`bun add @ekwo-ai/core`

## README

# @ ekwo-ai/ 核心

TypeScript 行类型和输入客户端 [电子操作系统](https://github.com/Ekwo-ai/ekwo-os) 会计计划.

-   **整个计划的类型a**手写的,故他们可以读取, 日记、条目和行数、文件和行数、税款和税务通知, 和行塑造报表函数返回.
-   **法国FEC住在 [`@ekwo-ai/fec`](https://npmcn.com/package/%40ekwo-ai/formats/fec/)**,这是麻省理工学院 并依赖于什么。 不再在此再出口: 从 在这里.
-   **瘦客户端** (b) 具有会计规则的职能—— `post_document`, (中文(简体) ), `reconcile`, (中文(简体) ), `trial_balance`, (中文(简体) ), `vat_return`, (中文(简体) ), `fec_lines`。 。 。 . 其他一切都是一张桌子 Supabase已经把那些都暴露为REST了.
-   **命令行和 MCP 服务器共享功能** - 留着 书籍,开出电子发票,通过散列证明存档 规则存在一次.
-   **没有自己的运行时间依赖.** `@supabase/supabase-js` 是可选的 对等点; `@ekwo-ai/fec` 是因为 `generateFec()` 在客户端上写 刚刚拿到的文件.

## 安装

```sh
npm install @ekwo-ai/core
```

## 使用量

```ts
import { EkwoClient } from '@ekwo-ai/core';
import { fecFileName } from '@ekwo-ai/fec';
import { createClient } from '@supabase/supabase-js';

const ekwo = new EkwoClient(createClient(url, key));

const entry = await ekwo.postDocument(documentId);
await ekwo.reconcile(receivableLineId, bankLineId);

const balance = await ekwo.trialBalance({ companyId, from: '2026-01-01', to: '2026-12-31' });
const boxes   = await ekwo.vatReturn({ companyId, from: '2026-07-01', to: '2026-09-30' });
const aged    = await ekwo.agedBalance(companyId, '2026-09-30', 'receivable');

const fec = await ekwo.generateFec({ companyId, from: '2026-01-01', to: '2026-12-31' });
await writeFile(fecFileName('123456789', '2026-12-31'), fec, 'utf8');
```

没有 Supabase 客户端, 请从 `fec_lines()`数字 :

```ts
import { checkFec, fromQueryRow, generateFec } from '@ekwo-ai/fec';

const lines = rows.map(fromQueryRow);
const violations = checkFec(lines);   // [] when the file is clean
const file = generateFec(lines, { decimalSeparator: ',', fieldSeparator: '|' });
```

## API 密码

| 导出 | 说明 |
| --- | --- |
| `EkwoClient` | 包揽计划会计功能. |
| `initInstance`, (中文(简体) ), `claimInstanceAdmin` | 记录安装并占据第一个管理员席位. |
| `registerInstance`, (中文(简体) ), `unregisterInstance` | 选择被Ekwo接触到,然后再次出局. 从来没有要求. |
| `ACCOUNT_TYPES`, (中文(简体) ), `internalGroup(type)` | 十八个账户类型及其资产负债表组. |
| `isRegistered(instance)` | 运营商是否选择在 Ekwo 注册 . |
| `isSale`, (中文(简体) ), `isCreditNote`, (中文(简体) ), `isAccountable` | 文档类型上游. |
| `createContact`, (中文(简体) ), `createDocument`, (中文(简体) ), `addDocumentLine`, (中文(简体) ), `updateDocumentLines`, (中文(简体) ), `postDocument`, (中文(简体) ), `recordPayment`, (中文(简体) ), `reconcile`, (中文(简体) ), `settleFromStatement`, (中文(简体) ), `listDocuments`, (中文(简体) ), `getDocument`,, , , , , , , , | 保存帐簿,每平面保存一次: MCP 服务器和 `ekwo` 命令行两个调用。 每个需要一个 `Backend` - 五项行动, `select` `insert` `update` `remove` `rpc` ——呼叫者执行作为用户进入数据库的任何内容. 他们没有会计规则,而是有计划. |
| `validateEinvoice`, (中文(简体) ), `issueEinvoice`, (中文(简体) ), `einvoiceStatus`, (中文(简体) ), `listEinvoiceTransmissions`, (中文(简体) ), `EinvoiceTransport`, (中文(简体) ), `directoryTransport` | 网上销售的电子发票,通过 `einvoicing` 运输工具 `send`, (中文(简体) ), `status`, (中文(简体) ), `receive`, (中文(简体) ), `lookup`没有证书可以穿过它。 船的运输者把文件写进文件夹. |
| `proveFile`, (中文(简体) ), `upgradeFilingProofs`, (中文(简体) ), `lookupFilingProof`, (中文(简体) ), `checkProof` | 通过公开的OpenTimestamps日历向Bitcoin承诺的存档文件的sha256,稍后由持有文件的任何人检查([`docs/filing-proofs.md`](https://npmcn.com/package/docs/filing-proofs.md)) (中文(简体) ). |
| `BooksError`, (中文(简体) ), `isRefusalState`, (中文(简体) ), `socleCode`, (中文(简体) ), `isServiceRoleKey` | 这层的错象什么, 算作数据库拒绝, 和一个没有表面接受的密钥. |
| 类型 | `Instance`, (中文(简体) ), `InstanceAdmin`, (中文(简体) ), `MemberRole`, (中文(简体) ), `CompanyRole`, (中文(简体) ), `Account`, (中文(简体) ), `Journal`, (中文(简体) ), `Entry`, (中文(简体) ), `EntryLine`, (中文(简体) ), `EkwoDocument`, (中文(简体) ), `DocumentLine`, (中文(简体) ), `Tax`, (中文(简体) ), `TaxPosting`, (中文(简体) ), `Contact`, (中文(简体) ), `TrialBalanceRow`, (中文(简体) ), `AgedBalanceRow`, (中文(简体) ), `VatReturnRow`,, , , , , , , , |

数量从Postgres回来作为字符串,类型是这样说的: `numeric` 以 `Decimal = string` 而不是在路上绕入浮点 进去.

## 许可证

[仅限AGPL-3.0](https://npmcn.com/package/LICENSE) (原始内容存档于2018-03-21). Ekwo AI.

## 常见问题

### @ekwo-ai/core 是什么？

TypeScript行类型和用于Ekwo OS会计计划的打入Supabase客户端\.

### 如何安装 @ekwo-ai/core？

在项目目录运行 npm install @ekwo-ai/core，或使用 pnpm add / yarn add / bun add。

### @ekwo-ai/core 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @ekwo-ai/core 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @ekwo-ai/core 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @ekwo-ai/core 可以商用吗？

@ekwo-ai/core 使用 AGPL-3\.0-only 许可。最严格的 Copyleft：除分发外，通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括，不构成法律意见，请以许可原文为准。

### @ekwo-ai/core 的下载量有多少？

根据 npm 官方下载统计，@ekwo-ai/core 在 2026/10/13 – 2026/11/11 这 30 天内被下载 3,209 次，日均约 107 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @ekwo-ai/core 还在维护吗？

最新版本 0\.25\.2 发布于 2026/11/13（今天）；至今共发布 31 个版本，其中过去 12 个月发布了 31 个；首次发布于 2026/09/19。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。