@happyvertical/smrt-移动合同
S-m-r-t 移动基础的代码: 项目 s-m-r-t manifest.json
通过移动许可列表输入已键入 Kotlin ()@Serializable 用于
KMP模块)和斯威夫特(平面结构)——加上生成的框架
检查合同文件
@happyvertical/smrt-mobile。 。 。 .
设计 : ADR 0001 (韩语)· ;
史诗"快活"/相声#1745. 代理人/开发者指导:
一般事务人员(其他职等)零运行时间依赖性(按设计)
manifest.json 直接文件并保留在 smrt 包 DAG 之外.
安装
pnpm add -D @happyvertical/smrt-mobile-contract
用法——每个应用程序域的 DTO
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数字 :
pnpm --filter @happyvertical/smrt-mobile-contract generate:framework
斯威夫特镜子frameworkSwiftFiles())按SwiftUI的要求排放
app;一个等同测试使其与克特林一面同步进行战地对战.
发展
pnpm build # vite build + framework contract freshness verify
pnpm test # vitest (goldens, mapping rules, parity, file-set round-trip)