@genesislcap/event-type-codegen

中文文档
15.96.2发布于 2026/11/16SEE LICENSE IN license.txtTypeScriptCommonJS近 30 天下载 2.2万

来自 Kotlin 事件处理器 DTOs 的构建时间 TypeScript 代码

中文使用文档
文档目录6 节
  1. 配置
  2. 国 际
  3. 限制(v1)
  4. 输入
  5. 元数据堆放路径(FUI-2608)
  6. 移徙

@ 起源cap/ event- type- codegen

创建时间 TypeScript 创建事件接口 DETAILS 有效载荷,从没有运行服务器的克特林PAL事件处理器中发现.

配置

启用通过 genx.config.* 或 genx 编号 : genesis 键入 package.json数字 :

{
  "genx": {
    "eventTypes": {
      "enabled": true,
      "serverModule": "../server/my-app",
      "kotlinSources": [
        "src/main/kotlin/**/dto/**/*.kt",
        "src/main/genesis/scripts/**/*.kts"
      ],
      "generatedDaoSources": [
        "build/internal-modules/**/*-generated-dao/build/generated/sources/dao/global/genesis/gen/dao/**/*.kt"
      ],
      "handlerScan": [
        "src/main/kotlin/**/*.kt",
        "src/main/genesis/scripts/**/*.kts"
      ],
      "output": "src/generated/genesis-event-types.ts",
      "runOnBuild": true
    }
  }
}

何时 enabled 错误或块被省略,代码被跳过.

generatedDaoSources globs通过两个应用模块解决(serverModule)及其父缓冲 server/ 目录(字典-cache DAOs通常居住的地方). 默认覆盖之后常见的单重排布局 ./gradlew … 已经生成 DAO 源 。 自定义 data class DTO 总是使用相同的类名覆盖生成的 DAO .

国 际

从客户端应用程序目录 :

genx generate event-types

genx build 当 eventTypes.enabled 财务报告和审定财务报表 runOnBuild (默认) true 当启用时).

在显示服务器Gradle构建中, generateDao 实值 finalizedBy generateEventTypes,运行中 genx generate event-types 内 react-client 何时 genx 可用(在单发靴后)。 禁用为 -PenableEventTypeCodegen=false。 。 。 .

限制(v1)

  • 发现使用克特林源解析,而不是编译器或活的JSON Schema.
  • 只有具有可解决的 DETAILS 形状的处理器( Custom DTO 或生成的表格/索引来自 generatedDaoSources获得 *Details 类型和类型 EventDetailsMap 条目。 其他任何东西都列在生成文件顶端的注释中.
  • 完整的表格 DAO 处理器(例如 . eventHandler<Trade>("TRADE_INSERT"))和索引处理器(例如. eventHandler<Trade.ById>("TRADE_DELETE"))在生成 DAO 时被映射 .kt 资料来源列于下 generatedDaoSources。 。 。 .
  • 基于类的处理器源命名 *EventHandler.kt a 项下 dto/ 路径被跳过。 这个 dto/** glob 用于输入 data class只有; 这些文件通常是 SyncValidatingEventHandler 执行,而不是PAL eventHandler { } 剧本. PAL 处理器在 *-eventhandler.kts (和其他 handlerScan 路径)仍然被发现.
  • 在 CI 中客户端代码源之前生成 DAO 源( Gradle) 如果树没有被执行 .
  • 词典 国家网 字段:字符串字符串 enum class 和/或伴侣 Field.Type.ENUM values = "…" 出现在 generatedDaoSources (单位:千美元)gen/dao/**/*.kt) (中文(简体) ).
  • Enum 出口以 Kotlin enum 来命名, 并且只能使用自有表格 当声明不一致时。 创世纪也发出一个谜题 未覆盖,在平顶楼 global.genesis.gen.dao.enums,或 表格范围d输入 …enums.<dictionary>.<table> 这样啊 多个宣言可以共享一个简单的名称. 同值套件共用一个导出; 不同者有资格(AxeStatus 编号 : RfqStatus 编号 : OrderStatus所以没有桌子的地盘 以另一个值为单位。 在他们之中,有未加明镜的申报,那确是隐讳的, 因为这是 PAL 脚本默认导入决定的 .
  • 一个字段的enum解决了克特林解决这个名字的方式,与写它的文件相对: 输入文件声明本身,然后显示 import,然后是文件自己的软件包,然后 恒星导入。 每跑一跑就把下面的人蒙入阴影中 import 那个名字 在生成的树产量之外 unknown,从不使用同名生成的enum.
  • PAL 脚本(.kts 下级 genesis/scripts/附加默认进口 创世纪编译器用品 (单位:千美元)…gen.dao.enums.*, (中文(简体) ), …gen.dao.* 和生成的配置/视图 软件包),这就是为什么 val feeType: FeeType 解决那里没有 import 线条。 星号 进口不再重复,所以 表格范围d 仍然没有导入脚本的 enum 名称 决定: unknown:创世纪确实通过 tables-info.json,但该等级尚未建模。 一个平地 .kt 来源,什么的 下级 genesis/cfg/中,没有默认值.

输入

  • *Details 接口 Kotlin DTO的DETAILS有效载荷.
  • GenesisEvent (从) @genesislcap/foundation-comms)——抽象基础;子类集 MESSAGE_TYPE。 。 。 .
  • 每个手执班 - 比如说. EventAqsCounterpartyInsert。 。 。 .
import { commitGenesisEvent } from '@genesislcap/foundation-comms';
import { EventAqsCounterpartyInsert } from './generated/genesis-event-types';

await commitGenesisEvent(
  connect,
  new EventAqsCounterpartyInsert({ COUNTERPARTY_ID: 'x' }),
);

元数据堆放路径(FUI-2608)

由活服务器快照生成,而不是(或除此之外)克特林源扫描:

  1. 在与 foundation-header按钮 Ctrl/Cmd+Shift+E 电源 下载( 仅建为 dev ) event-metadata.json。 。 。 .
  2. 运行 :
genx generate event-types --from-metadata event-metadata.json

这使用了入境的JSON Schema DETAILS(域名, JSON_TYPE作为合同——对于比较克特林-扫描输出和对于处理者来说,源扫描仪丢失是有用的.

Kotlin 路径的电线字段命名匹配起源- 服务器 toUpperUnderscoreWithAcronyms (例如:. addressLine1 → ADDRESS_LINE_1) (中文(简体) ). 日期/时间 Kotlin 类型映射到类型脚本 number (时代小米/ JSON_TYPE: integer) (中文(简体) ).

移徙

应用行动
新建 genx 模板启用 eventTypes、 承诺或 gitignore 生成输出
遗产添加配置, 运行 genx generate event-types,并逐步输入
没有克特林DTO离开已禁用

版本与发布记录

@genesislcap/event-type-codegen 共发布 416 个版本,首次发布于 2026/07/16;过去 12 个月发布了 416 个版本。

版本发布日期距今
15.96.2latest2026/11/16今天
15.96.12026/11/16今天
15.96.0-GENC-1665.32026/11/142 天前
15.96.02026/11/142 天前
15.95.2-GENC-1665.22026/11/132 天前
15.95.22026/11/133 天前

其他发布通道:FUI-2567 → 15.1.0-FUI-2567.3,GENC-1461 → 15.1.0-GENC-1461.6,FUI-2571-formatters → 15.3.2-FUI-2571-formatters.1,FUI-2591 → 15.3.2-FUI-2591.1,GENC-1475 → 15.6.2-GENC-1475.8,ts7-migration → 15.6.1-ts7-migration.1。

关于 @genesislcap/event-type-codegen 的常见问题

@genesislcap/event-type-codegen 是什么?

来自 Kotlin 事件处理器 DTOs 的构建时间 TypeScript 代码

如何安装 @genesislcap/event-type-codegen?

在项目目录运行 npm install @genesislcap/event-type-codegen,或使用 pnpm add / yarn add / bun add。

@genesislcap/event-type-codegen 支持 TypeScript 吗?

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

@genesislcap/event-type-codegen 支持 ESM 还是 CommonJS?

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

@genesislcap/event-type-codegen 需要什么版本的 Node.js?

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

@genesislcap/event-type-codegen 可以商用吗?

@genesislcap/event-type-codegen 使用 SEE LICENSE IN license.txt 许可。许可条款写在包内的独立文件中,请阅读该文件确认可否商用。以上为概括,不构成法律意见,请以许可原文为准。

@genesislcap/event-type-codegen 的下载量有多少?

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

@genesislcap/event-type-codegen 还在维护吗?

最新版本 15.96.2 发布于 2026/11/16(今天);至今共发布 416 个版本,其中过去 12 个月发布了 416 个;首次发布于 2026/07/16。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。