# @happyvertical/smrt-mobile-contract 中文文档

规范地址：https://npmcn.com/package/%40happyvertical/smrt-mobile-contract/

版本：0\.62\.1
npm 元数据更新时间：2026-11-17T07:53:47.886Z
中文译文更新时间：2026-11-17T09:33:45.645Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：103 kB，31 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-07-03T03:34:14.383Z
- 最新版本发布：2026-11-17T07:53:47.682Z
- 近 30 天下载量：26888（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：326（近 12 个月 326 个）

## 中文简介

SMRT移动合同代码:表单+许可列表 → 移动合同.json → Kotlin/Swift DTOs,外加生成的 @happyvertical/smrt-mobile的框架合同

## 安装

```sh
npm install @happyvertical/smrt-mobile-contract
```

也可以使用：`pnpm add @happyvertical/smrt-mobile-contract`、`yarn add @happyvertical/smrt-mobile-contract`、`bun add @happyvertical/smrt-mobile-contract`

## README

# @happyvertical/smrt-移动合同

S-m-r-t 移动基础的代码: 项目 s-m-r-t `manifest.json` 通过移动许可列表输入已键入 Kotlin ()`@Serializable` 用于 KMP模块)和斯威夫特(平面结构)——加上生成的框架 检查合同文件 [`@happyvertical/smrt-mobile`](https://npmcn.com/package/%40happyvertical/smrt-mobile/README.md)。 。 。 .

设计 : [ADR 0001 (韩语)](https://npmcn.com/package/docs/content/adr/0001-kmp-mobile-foundation.md)· ; 史诗"快活"/相声#1745. 代理人/开发者指导: [一般事务人员(其他职等)](https://npmcn.com/package/%40happyvertical/smrt-mobile-contract/AGENTS.md)零运行时间依赖性(按设计) `manifest.json` 直接文件并保留在 smrt 包 DAG 之外.

## 安装

```bash
pnpm add -D @happyvertical/smrt-mobile-contract
```

## 用法——每个应用程序域的 DTO

```ts
import {
  buildMobileContract,
  generateKotlinDtoFiles,
  generateSwiftDtoFile,
  writeFileSet,
} from '@happyvertical/smrt-mobile-contract';
import { readFileSync, writeFileSync } from 'node:fs';

const manifest = JSON.parse(
  readFileSync('packages/my-objects/src/manifest/manifest.json', 'utf8'),
);

const contract = buildMobileContract({
  manifests: [manifest],                     // one or more SMRT manifests
  allowlist: ['FieldReport', 'Attachment'],  // short or qualified names
  kotlinPackage: 'com.example.mobile.generated',
  sourceLabel: 'packages/my-objects/src/manifest/manifest.json',
});

writeFileSet(
  'apps/mobile/shared/src/commonMain/kotlin/generated',
  generateKotlinDtoFiles(contract),
);
writeFileSync(
  'apps/mobile/iosApp/App/GeneratedMobileDtos.swift',
  generateSwiftDtoFile(contract),
);
```

### 许可列表规则

-   条目可以是短名(`FieldReport`)或合格名称 (单位:千美元)`@scope/pkg:FieldReport`) (中文(简体) ). 匹配对象的短名 一个表是错误——使用合格名称.
-   两个允许的列表对象可能不会共享短名: 生成 `<Name>Dto` 文件会覆盖彼此, 因此构造会舍弃 .
-   关系声明`oneToMany`编号 :`manyToMany`编号 :`hasMany`) 除外 从 DTO 投影,它们不是平板柱.

### 类型映射

| 声明 `type` | 科特林语Name | 挥发 |
| --- | --- | --- |
| `text` 编号 : `status` 编号 : `foreignKey` 编号 : `crossPackageRef` | `String` | `String` |
| `integer` | `Long` (64位-字节大小/时间段外溢) `Int`(中文(简体) ) | `Int64` |
| `decimal` | `DecimalString?` (字符串编码,无浮标精度损失) | `String?` |
| `boolean` | `Boolean` | `Bool` |
| `datetime` | `Instant?` | `String?` |
| `json` | `JsonObject` | `String` (草JSON) (英语) |

字段默认来自 `default` (当前清单) `defaultValue` (amaru-era)作为倒计时;每个生成的克特林场默认初始化 安全去除部分区域。 字段名称保持明显真实 (电报格式名称,包括: `created_at`);关键词相撞是 每一个语言的后退. `sourceHash` (在许可名单上排列256个) 将投影物体)印入所有输出,这样漂移就可被探测出.

## 用法——框架合同

稳定的框架合同(支助类型、包装本地化和 `/api/mobile` 认证/会话/设备DTO)由这个软件包排放 输入 `smrt-mobile`是因为 `contract/` 目录。 这个包裹 `build` 字节验证这些文件; 编辑后再生成 `src/emit-framework.ts`数字 :

```bash
pnpm --filter @happyvertical/smrt-mobile-contract generate:framework
```

斯威夫特镜子`frameworkSwiftFiles()`)按SwiftUI的要求排放 app;一个等同测试使其与克特林一面同步进行战地对战.

## 发展

```bash
pnpm build   # vite build + framework contract freshness verify
pnpm test    # vitest (goldens, mapping rules, parity, file-set round-trip)
```

## 常见问题

### @happyvertical/smrt-mobile-contract 是什么？

SMRT移动合同代码:表单\+许可列表 → 移动合同\.json → Kotlin/Swift DTOs,外加生成的 @happyvertical/smrt-mobile的框架合同

### 如何安装 @happyvertical/smrt-mobile-contract？

在项目目录运行 npm install @happyvertical/smrt-mobile-contract，或使用 pnpm add / yarn add / bun add。

### @happyvertical/smrt-mobile-contract 支持 TypeScript 吗？

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

### @happyvertical/smrt-mobile-contract 支持 ESM 还是 CommonJS？

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

### @happyvertical/smrt-mobile-contract 可以商用吗？

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

### @happyvertical/smrt-mobile-contract 的下载量有多少？

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

### @happyvertical/smrt-mobile-contract 还在维护吗？

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

