@gct-paas/api 0.1.0-word.2 → 0.1.0

package/lib/apaas/service/apis/model-meta.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   ModelMetaResponse,
   CategoryCompleteResponse,
@@ -10,198 +11,346 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id
+  /**
+   * 删除的id
+   */
+  ids: string;
 }
 export interface getAggListQuery {
-  modelKey: string; // 模型key
+  /**
+   * 模型key
+   */
+  modelKey: string;
 }
 export interface getAggModelQuery {
-  modelKey: string; // 模型key
+  /**
+   * 模型key
+   */
+  modelKey: string;
 }
 export interface getByKeysQuery {
-  modelKeys: string; // 多个模型key 逗号拼接
+  /**
+   * 多个模型key 逗号拼接
+   */
+  modelKeys: string;
+}
+export interface putConstantModelKeyPathParams {
+  modelKey: string;
 }
 export interface getDataPermissionListQuery {
-  keyword?: string; // 根据名称搜索
+  /**
+   * 根据名称搜索
+   */
+  keyword?: string;
 }
 export interface getDetailQuery {
-  modelKey: string; // 模型key
-  types?: string; // 需要去除的类型type，多个按','分割
+  /**
+   * 模型key
+   */
+  modelKey: string;
+  /**
+   * 需要去除的类型type，多个按','分割
+   */
+  types?: string;
+}
+export interface putDisplayModelKeyFieldKeyPathParams {
+  modelKey: string;
+  fieldKey: string;
 }
 export interface getFindAllByTypeInQuery {
-  type: string; // 类型根据逗号分割：BASE,NDO,RDO
+  /**
+   * 类型根据逗号分割：BASE,NDO,RDO
+   */
+  type: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  categoryId?: string; // 分类id
-  type?: string; // 模型标志:(NDO/RDO)
+  /**
+   * 分类id
+   */
+  categoryId?: string;
+  /**
+   * 模型标志:(NDO/RDO)
+   */
+  type?: string;
 }
 export interface getListAllModelAndFieldByNameQuery {
-  name: string; // 名称
+  /**
+   * 名称
+   */
+  name: string;
 }
 export interface getListMasterModelQuery {
-  subModelKey: string; // subModelKey
+  /**
+   * subModelKey
+   */
+  subModelKey: string;
 }
 export interface getListModelReferencedByQuery {
-  modelKey: string; // 模型key
-  type?: string; // 关联字段类型: 多个类型逗号分隔，例如 ref,rdo_ref
+  /**
+   * 模型key
+   */
+  modelKey: string;
+  /**
+   * 关联字段类型: 多个类型逗号分隔，例如 ref,rdo_ref
+   */
+  type?: string;
 }
 export interface getListSlaveModelQuery {
-  modelKey: string; // 模型key
+  /**
+   * 模型key
+   */
+  modelKey: string;
 }
 export interface getPageGetRecycledListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+}
+export interface putPageRecycledRestoreModelKeyPathParams {
+  modelKey: string;
 }
 export interface getPermissionEnabledListQuery {
-  permissionEnabled?: string; // 是否启用权限 1启用,0未启用
-  type?: string; // 模型标志:(NDO/RDO)
+  /**
+   * 是否启用权限 1启用,0未启用
+   */
+  permissionEnabled?: string;
+  /**
+   * 模型标志:(NDO/RDO)
+   */
+  type?: string;
 }
 export interface getPermissionRelationQuery {
-  keyword?: string; // 搜索关键字
+  /**
+   * 搜索关键字
+   */
+  keyword?: string;
+}
+export interface putSupportMessageModelKeyEnabledPathParams {
+  modelKey: string;
+  enabled: string;
 }
 export interface getTranslateModelFieldExpQuery {
-  exp: string; // 表达式（modelKey.f1.f2）
+  /**
+   * 表达式（modelKey.f1.f2）
+   */
+  exp: string;
 }
 export interface getUnrelatedListQuery {
-  keyword?: string; // 模型key
+  /**
+   * 模型key
+   */
+  keyword?: string;
+}
+export interface putIdPathParams {
+  id: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putModelKeyEnabledPathParams {
+  modelKey: string;
+  enabled: string;
 }
 export interface ModelMetaService {
-  // 删除实体模型
+  /**
+   * 删除实体模型
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 获取汇总模型列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 获取汇总模型列表
+   */
   getAggList(
     query: getAggListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMetaResponse[]>>;
-  // 获取汇总模型列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMetaResponse[]>;
+  /**
+   * 获取汇总模型列表
+   */
   getAggModel(
     query: getAggModelQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<CategoryCompleteResponse[]>>;
-  // 根据模型key批量查询模型列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<CategoryCompleteResponse[]>;
+  /**
+   * 根据模型key批量查询模型列表
+   */
   getByKeys(
     query: getByKeysQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMetaResponse[]>>;
-  // 更新模型约束
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMetaResponse[]>;
+  /**
+   * 更新模型约束
+   */
   putConstantModelKey(
+    path: putConstantModelKeyPathParams,
     data: UpdateConstantRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 查询启用数据权限模型列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 查询启用数据权限模型列表
+   */
   getDataPermissionList(
     query: getDataPermissionListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMetaResponse[]>>;
-  // 根据模型key查询模型和字段详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMetaResponse[]>;
+  /**
+   * 根据模型key查询模型和字段详情
+   */
   getDetail(
     query: getDetailQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMetaDTO>>;
-  // 实体模型默认显示字段配置
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMetaDTO>;
+  /**
+   * 实体模型默认显示字段配置
+   */
   putDisplayModelKeyFieldKey(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 实体模型ER图查询
-  getEr(config?: Record<string, string>): Promise<IHttpResponse<TableMetaER>>;
-  // 根据类型查询所有模型
+    path: putDisplayModelKeyFieldKeyPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 实体模型ER图查询
+   */
+  getEr(config?: Partial<AxiosRequestConfig>): Promise<TableMetaER>;
+  /**
+   * 根据类型查询所有模型
+   */
   getFindAllByTypeIn(
     query: getFindAllByTypeInQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMetaResponse[]>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMetaResponse[]>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMetaResponse>>;
-  // 模型列表查询
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMetaResponse>;
+  /**
+   * 模型列表查询
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMetaResponse[]>>;
-  // 获取所有模型
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMetaResponse[]>;
+  /**
+   * 获取所有模型
+   */
   getListAll(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMetaResponse[]>>;
-  // 通过名称筛选模型和字段
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMetaResponse[]>;
+  /**
+   * 通过名称筛选模型和字段
+   */
   getListAllModelAndFieldByName(
     query: getListAllModelAndFieldByNameQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelField[]>>;
-  // 获取主模型列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelField[]>;
+  /**
+   * 获取主模型列表
+   */
   getListMasterModel(
     query: getListMasterModelQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMetaResponse[]>>;
-  // 获取引用自己的模型
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMetaResponse[]>;
+  /**
+   * 获取引用自己的模型
+   */
   getListModelReferencedBy(
     query: getListModelReferencedByQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMetaDTO[]>>;
-  // 获取自己的子模型
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMetaDTO[]>;
+  /**
+   * 获取自己的子模型
+   */
   getListSlaveModel(
     query: getListSlaveModelQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMetaDTO[]>>;
-  // 回收站模型分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMetaDTO[]>;
+  /**
+   * 回收站模型分页列表
+   */
   getPageGetRecycledList(
     query: getPageGetRecycledListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<ModelMetaResponse>>>;
-  // 从回收站恢复模型
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<ModelMetaResponse>>;
+  /**
+   * 从回收站恢复模型
+   */
   putPageRecycledRestoreModelKey(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 查询启用权限模型列表查询
+    path: putPageRecycledRestoreModelKeyPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 查询启用权限模型列表查询
+   */
   getPermissionEnabledList(
     query: getPermissionEnabledListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMetaResponse[]>>;
-  // 查询配置过数据权限的模型列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMetaResponse[]>;
+  /**
+   * 查询配置过数据权限的模型列表
+   */
   getPermissionRelation(
     query: getPermissionRelationQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelBriefInfo[]>>;
-  // 实体模型保存
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelBriefInfo[]>;
+  /**
+   * 实体模型保存
+   */
   postSave(
     data: ModelMetaVO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 模型启用禁用支持消息
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 模型启用禁用支持消息
+   */
   putSupportMessageModelKeyEnabled(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 获取支持流程的模型树
+    path: putSupportMessageModelKeyEnabledPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 获取支持流程的模型树
+   */
   getSupportProcess(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<CategoryCompleteResponse[]>>;
-  // 翻译模型字段表达式
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<CategoryCompleteResponse[]>;
+  /**
+   * 翻译模型字段表达式
+   */
   getTranslateModelFieldExp(
     query: getTranslateModelFieldExpQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 查询模型列表过滤已添加过数据权限的模型
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 查询模型列表过滤已添加过数据权限的模型
+   */
   getUnrelatedList(
     query: getUnrelatedListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelBriefInfo[]>>;
-  // 实体模型编辑
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelBriefInfo[]>;
+  /**
+   * 实体模型编辑
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: ModelMetaVO,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 实体模型编辑 启用禁用权限
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 实体模型编辑 启用禁用权限
+   */
   putModelKeyEnabled(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    path: putModelKeyEnabledPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/model-method.service.d.ts

@@ -1,59 +1,91 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { ModelMethodRequest, ModelMethodResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  modelKey: string; // modelKey
+  /**
+   * modelKey
+   */
+  modelKey: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface ModelMethodService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: ModelMethodRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 数据模型方法列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 数据模型方法列表
+   */
   getDataModelList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMethodResponse[]>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMethodResponse[]>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMethodResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMethodResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMethodResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMethodResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<ModelMethodResponse>>>;
-  // 视图模型方法列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<ModelMethodResponse>>;
+  /**
+   * 视图模型方法列表
+   */
   getViewModelList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMethodResponse[]>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMethodResponse[]>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: ModelMethodRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/model-permission-relation.service.d.ts

@@ -1,50 +1,75 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   ModelPermissionRelationRequest,
   ModelPermissionRelationResponse,
 } from '../entities';
 
 export interface deleteQuery {
-  id: string; // 删除的id
+  /**
+   * 删除的id
+   */
+  id: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface ModelPermissionRelationService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: ModelPermissionRelationRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelPermissionRelationResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelPermissionRelationResponse>;
+  /**
+   * 列表
+   */
   getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelPermissionRelationResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelPermissionRelationResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<ModelPermissionRelationResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<ModelPermissionRelationResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: ModelPermissionRelationRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }