@maai-types/maai

为Maai自定义服务端引擎提供的TypeScript类型定义，支持VSCode智能感知和自动完成。

特性

• 完整的类型定义，覆盖Maai服务端核心API
• 与VSCode深度集成，提供智能代码补全
• 严格的类型检查，减少运行时错误
• 轻量级，无运行时依赖

安装

npm install @maai/types --save-dev
# 或
yarn add @maai/types -D

使用

安装后，TypeScript会自动识别类型定义。在代码中导入Maai模块即可获得类型支持：

import webUtils from "@maai/utils/web";
import asserts from "@maai/utils/asserts";

const body = webUtils.getBody();
asserts.isNotBlank(body.name, "名称不能为空");

模块说明

本模块为maai项目提供完整的TypeScript类型定义，包含以下子模块：

• biz: 业务相关类型定义
• utils: 工具类类型定义

类型定义规范

1. 文件命名：

• 使用小写字母和连字符，如user-auth.d.ts
• 接口类型使用大驼峰命名，如UserAuth

2. 定义要求：

// 示例：定义业务接口
interface UserProfile {
  id: string;
  name: string;
  roles: string[];
}

3. 导出规则：

• 每个.d.ts文件应在index.d.ts中导出
• 避免使用默认导出

开发流程

1. 添加新定义：

# 在biz目录创建新定义文件
touch biz/new-feature.d.ts

# 更新index.d.ts导出
echo 'export * from "./new-feature";' >> index.d.ts

2. 版本发布：

• 修改package.json版本号
• 提交git tag