控制台远程服务

简介

控制台远程服务，属于 GZMJS 项目的控制台模块。

版本

当前版本：0.1.4

包名

@gzmjs/console-remote

功能特性

• 提供 GraphQL API 客户端
• WebSocket 订阅支持
• 多租户管理
• 与 GZMJS 生态系统无缝集成

安装

pnpm add @gzmjs/console-remote

使用方法

核心功能模块

1. 配置管理 (config)

提供远程服务配置功能：

• setConfig() - 设置远程配置
• getGraphQLUrl() - 获取 GraphQL URL
• getIconUrl() - 获取图标 URL
• getUploadUrl() - 获取上传 URL
• getDownloadUrl() - 获取下载 URL

示例：

import { setConfig, getGraphQLUrl } from '@gzmjs/console-remote';

// 配置远程服务
setConfig({
  graphqlEndpoint: '/api/graphql'
});

// 获取 GraphQL URL
const url = getGraphQLUrl();

2. GraphQL 通信 (graphQL)

提供 GraphQL 查询和订阅功能：

• GraphError - GraphQL 错误类
• postGraph<T>() - 发送 GraphQL POST 请求
• subscribeGraph<T>() - 创建 GraphQL 订阅

示例：

import { postGraph } from '@gzmjs/console-remote';

// 执行 GraphQL 查询
const result = await postGraph<MyType>(`
  query {
    getApp(id: "123") {
      name
      icon
    }
  }
`);

3. 表单处理 (form)

提供 GraphQL 表单创建功能：

• createGraphQLForm() - 创建 GraphQL 表单
• createHiddenForRVT() - 创建隐藏输入字段
• downloadGraph() - 下载 GraphQL 结果

4. 图标处理 (icon)

提供图标 URL 生成功能：

• getIcon16Url() - 获取 16x16 图标 URL
• getIcon32Url() - 获取 32x32 图标 URL

5. 租户管理 (tenant)

提供多租户支持：

• getTenants() - 获取租户列表
• AppModuleTenants - 应用模块租户类
• tryGetCurrentTenant() - 获取当前租户
• getAppModuleIdFromQueryId() - 从查询 ID 获取应用模块 ID
• saveCurrentTenant() - 保存当前租户

6. 类型查询 (type)

提供 GraphQL 类型查询功能：

• EnumValues - 枚举值类型
• TypeFields - 类型字段类型
• GraphQLType - GraphQL 类型
• getGraphQLType() - 获取 GraphQL 类型定义
• getEnumValues() - 获取枚举值
• getEnumObj() - 获取枚举对象

依赖关系

本包依赖以下模块：

• graphql-ws (^6.0.7)
• @gzmjs/console-types (workspace:*)

构建

pnpm run build

许可证

本项目采用 ISC 许可证。