控制台类型定义

简介

控制台类型定义，属于 GZMJS 项目的控制台模块。本包提供了 GraphQL API 的 TypeScript 类型定义。

版本

当前版本：0.1.0

包名

@gzmjs/console-types

功能特性

• 提供完整的 GraphQL API TypeScript 类型定义
• 包含所有控制台相关的类型、接口和枚举
• 支持类型安全的 API 调用
• 与 GZMJS 生态系统无缝集成

安装

pnpm add @gzmjs/console-types

使用方法

核心导出

本包提供以下模块：

graphql (gql/graphql)

使用示例

import { } from '@gzmjs/console-types';

// TODO: 添加使用示例

主要导出内容

本包从 ./gql/graphql 模块导出大量 GraphQL 生成的 TypeScript 类型，主要包括：

1. 基础工具类型

• Maybe<T> - 可空类型
• InputMaybe<T> - 输入可空类型
• Exact<T> - 精确类型
• MakeOptional<T, K> - 使属性可选
• MakeMaybe<T, K> - 使属性可空
• MakeEmpty<T, K> - 使属性为空
• Incremental<T> - 增量类型
• Scalars - GraphQL 标量类型映射

2. 应用相关类型

• App - 应用类型
• AppModule - 应用模块类型
• AppMenuItem - 应用菜单项类型
• AppMenuBadge - 应用菜单徽章类型
• AppClass - 应用类类型
• AppTask - 应用任务类型
• AppTaskScheduleDt - 应用任务调度时间类型
• AppRoleProvider - 应用角色提供者类型

3. 租户和用户类型

• BusinessTenant - 业务租户类型
• 各种用户和组织相关类型

4. 数据库相关类型

• DbTable - 数据库表类型
• DbQuery - 数据库查询类型
• 各种数据库操作输入和输出类型

5. 文件管理类型

• FileDirectory - 文件目录类型
• FileRecord - 文件记录类型
• 各种文件操作类型

6. 安全相关类型

• SecurityIdentity - 安全身份类型
• UserRole - 用户角色类型
• 各种安全和权限相关类型

7. 业务操作类型

• 各种 Caf_App_BasicAction_* 类型，涵盖：
  • 类操作（ClassOperation）
  • 数据库查询（DbQuery）
  • 数据库表操作（DbTable）
  • 文件操作（FileDirectory, FileRecord）
  • 脚手架操作（Scaffolding）
  • 等等...

8. 枚举类型

• 各种枚举类型，如 Caf_App_AccessLogError 等

使用示例

import type { App, AppModule, Maybe } from '@gzmjs/console-types';

// 使用类型定义
function getAppName(app: App): string {
  return app.Name;
}

// 处理可空值
function getIcon(app: App): string | null | undefined {
  return app.Icon; // 类型为 Maybe<string>
}

依赖关系

本包无外部依赖。

构建

pnpm run build

许可证

本项目采用 ISC 许可证。