# @karlroigus/api-contracts 中文文档

规范地址：https://npmcn.com/package/%40karlroigus/api-contracts/

版本：1\.0\.19
npm 元数据更新时间：2026-11-01T13:55:47.687Z
中文译文更新时间：2026-11-01T15:06:37.503Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40karlroigus/api-contracts
原文对照：https://npmcn.com/package/%40karlroigus/api-contracts/?lang=original
项目主页：https://github.com/karlroigus/enchante#readme
源码仓库：https://github.com/karlroigus/enchante

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

- 包体积（解压后）：16.5 kB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-10-17T13:44:50.999Z
- 最新版本发布：2026-11-01T13:55:47.491Z
- 已发布版本数：20（近 12 个月 20 个）

## 中文简介

共享的TypeScript类型，用于enchanted webstore API

## 安装

```sh
npm install @karlroigus/api-contracts
```

也可以使用：`pnpm add @karlroigus/api-contracts`、`yarn add @karlroigus/api-contracts`、`bun add @karlroigus/api-contracts`

## README

# @karlroigus / api契约

共享的TypeScript类型，用于enchanted webstore API。Express后端和React前端都使用。

## 安装

```
npm install @karlroigus/api-contracts
```

## 使用

```ts
import type { Product, Order, CreatePaymentSessionRequest } from '@karlroigus/api-contracts';
```

## 开发

在更改类型之后 `src/index.ts`：

```
npm version patch
npm publish --access public
```

然后更新消费者：

```
cd api && npm install @karlroigus/api-contracts@latest
cd frontend && npm install @karlroigus/api-contracts@latest
```

## 常见问题

### @karlroigus/api-contracts 是什么？

共享的TypeScript类型，用于enchanted webstore API

### 如何安装 @karlroigus/api-contracts？

在项目目录运行 npm install @karlroigus/api-contracts，或使用 pnpm add / yarn add / bun add。

### @karlroigus/api-contracts 支持 TypeScript 吗？

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

### @karlroigus/api-contracts 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @karlroigus/api-contracts 可以商用吗？

@karlroigus/api-contracts 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @karlroigus/api-contracts 还在维护吗？

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