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

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

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 import type {
   BizServiceMeta,
   BizServiceRequest,
@@ -19,205 +21,430 @@ import type {
 } from '../entities';
 
 export interface deleteBizServiceApiQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getBizServiceApiListModelCategoryQuery {
-  endTime?: string; // 结束时间
-  key?: string; // 服务key
-  method?: string; // 服务方式
-  modelKey?: string; // 模型key
-  name?: string; // 服务name
-  searchKey?: string; // 模糊匹配key、name
-  sortNum?: number; // 排序
-  startTime?: string; // 开始时间
-  type?: string; // 服务类型
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 服务key
+   */
+  key?: string;
+  /**
+   * 服务方式
+   */
+  method?: string;
+  /**
+   * 模型key
+   */
+  modelKey?: string;
+  /**
+   * 服务name
+   */
+  name?: string;
+  /**
+   * 模糊匹配key、name
+   */
+  searchKey?: string;
+  /**
+   * 排序
+   */
+  sortNum?: number;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
+  /**
+   * 服务类型
+   */
+  type?: string;
 }
-export interface postBizServiceGeneralModelCategoryModelKeyBsKeyQuery {
-  requestParam: Record<string, unknown>; // requestParam
+export interface getBizServiceApiListModelCategoryPathParams {
+  modelCategory: string;
 }
-export interface getBizServiceModelCategoryModelKeyBsKeyQuery {
-  requestParam: Record<string, unknown>; // requestParam
+export interface putBizServiceApiIdPathParams {
+  id: string;
 }
-export interface postBizServiceModelCategoryModelKeyBsKeyQuery {
-  requestParam: Record<string, unknown>; // requestParam
+export interface postBizServiceApiModelCategoryPathParams {
+  modelCategory: string;
 }
-export interface putBizServiceModelCategoryModelKeyBsKeyQuery {
-  requestParam: Record<string, unknown>; // requestParam
+export type postBizServiceGeneralModelCategoryModelKeyBsKeyQuery = Record<
+  any,
+  any
+>;
+export interface postBizServiceGeneralModelCategoryModelKeyBsKeyPathParams {
+  modelCategory: string;
+  modelKey: string;
+  bsKey: string;
 }
-export interface deleteBizServiceModelCategoryModelKeyBsKeyQuery {
-  requestParam: Record<string, unknown>; // requestParam
+export type getBizServiceModelCategoryModelKeyBsKeyQuery = Record<any, any>;
+export interface getBizServiceModelCategoryModelKeyBsKeyPathParams {
+  modelCategory: string;
+  modelKey: string;
+  bsKey: string;
+}
+export type postBizServiceModelCategoryModelKeyBsKeyQuery = Record<any, any>;
+export interface postBizServiceModelCategoryModelKeyBsKeyPathParams {
+  modelCategory: string;
+  modelKey: string;
+  bsKey: string;
+}
+export type putBizServiceModelCategoryModelKeyBsKeyQuery = Record<any, any>;
+export interface putBizServiceModelCategoryModelKeyBsKeyPathParams {
+  modelCategory: string;
+  modelKey: string;
+  bsKey: string;
+}
+export type deleteBizServiceModelCategoryModelKeyBsKeyQuery = Record<any, any>;
+export interface deleteBizServiceModelCategoryModelKeyBsKeyPathParams {
+  modelCategory: string;
+  modelKey: string;
+  bsKey: string;
 }
 export interface getEnumInfoModelCategoryQuery {
-  fieldKey: string; // 字段 key
-  modelKey: string; // 模型 key
-  searchKey?: string; // 枚举文本/枚举值
+  /**
+   * 字段 key
+   */
+  fieldKey: string;
+  /**
+   * 模型 key
+   */
+  modelKey: string;
+  /**
+   * 枚举文本/枚举值
+   */
+  searchKey?: string;
+}
+export interface getEnumInfoModelCategoryPathParams {
+  modelCategory: string;
 }
-export interface postExportModelCategoryModelKeyTmplKeyQuery {
-  requestParam: Record<string, unknown>; // requestParam
+export type postExportModelCategoryModelKeyTmplKeyQuery = Record<any, any>;
+export interface postExportModelCategoryModelKeyTmplKeyPathParams {
+  modelCategory: string;
+  modelKey: string;
+  tmplKey: string;
 }
 export interface getFieldListModelCategoryQuery {
-  includeBuiltin?: boolean; // 是否包含内置字段
-  keyword?: string; // 搜索关键字
-  modelKey: string; // 模型key
-  sys?: boolean; // 是否包含系统字段
+  /**
+   * 是否包含内置字段
+   */
+  includeBuiltin?: boolean;
+  /**
+   * 搜索关键字
+   */
+  keyword?: string;
+  /**
+   * 模型key
+   */
+  modelKey: string;
+  /**
+   * 是否包含系统字段
+   */
+  sys?: boolean;
+}
+export interface getFieldListModelCategoryPathParams {
+  modelCategory: string;
 }
 export interface getMethodListModelCategoryQuery {
-  modelKey: string; // 模型key
+  /**
+   * 模型key
+   */
+  modelKey: string;
+}
+export interface getMethodListModelCategoryPathParams {
+  modelCategory: string;
 }
 export interface getModelDetailListByKeysModelCategoryQuery {
-  modelKeys: string; // 多个模型key 逗号拼接
+  /**
+   * 多个模型key 逗号拼接
+   */
+  modelKeys: string;
+}
+export interface getModelDetailListByKeysModelCategoryPathParams {
+  modelCategory: string;
 }
 export interface getModelDetailModelCategoryQuery {
-  modelKey: string; // 模型key
+  /**
+   * 模型key
+   */
+  modelKey: string;
+}
+export interface getModelDetailModelCategoryPathParams {
+  modelCategory: string;
 }
 export interface getModelFormQuery {
-  type?: string; // 实体模型类型:(NDO/RDO) 多个类型逗号分隔
+  /**
+   * 实体模型类型:(NDO/RDO) 多个类型逗号分隔
+   */
+  type?: string;
 }
 export interface getModelSummaryQuery {
-  category?: string; // 模型种类:(entity/data/view) 多个类型逗号分隔
-  includeSys?: number; // 是否包含系统模型
-  report?: boolean; // 是否报表
-  subModel?: number; // 实体模型是否为子模型 不传查询全部(1 子模型, 0 非子模型)
-  supportMessage?: number; // 模型是否启用消息通知(1:启用,0:禁用)
-  type?: string; // 实体模型类型:(NDO/RDO) 多个类型逗号分隔
+  /**
+   * 模型种类:(entity/data/view) 多个类型逗号分隔
+   */
+  category?: string;
+  /**
+   * 是否包含系统模型
+   */
+  includeSys?: number;
+  /**
+   * 是否报表
+   */
+  report?: boolean;
+  /**
+   * 实体模型是否为子模型 不传查询全部(1 子模型, 0 非子模型)
+   */
+  subModel?: number;
+  /**
+   * 模型是否启用消息通知(1:启用,0:禁用)
+   */
+  supportMessage?: number;
+  /**
+   * 实体模型类型:(NDO/RDO) 多个类型逗号分隔
+   */
+  type?: string;
+}
+export interface postQueryFieldValueByRefChainDataModelCategoryPathParams {
+  modelCategory: string;
+}
+export interface postQueryRefChainDataModelCategoryPathParams {
+  modelCategory: string;
+}
+export interface postQueryRefDataModelCategoryPathParams {
+  modelCategory: string;
+}
+export interface postQueryRefDataByIdModelCategoryPathParams {
+  modelCategory: string;
+}
+export interface postQueryRefDataByIdsModelCategoryPathParams {
+  modelCategory: string;
 }
 export interface getSubModelListQuery {
-  category?: string; // 模型种类:(entity/data/view) 多个类型逗号分隔
-  modelKey: string; // 模型key
+  /**
+   * 模型种类:(entity/data/view) 多个类型逗号分隔
+   */
+  category?: string;
+  /**
+   * 模型key
+   */
+  modelKey: string;
 }
 export interface ModelComprehensiveService {
-  // 业务服务删除
+  /**
+   * 业务服务删除
+   */
   deleteBizServiceApi(
     query: deleteBizServiceApiQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 模型业务服务列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 模型业务服务列表
+   */
   getBizServiceApiListModelCategory(
+    path: getBizServiceApiListModelCategoryPathParams,
     query: getBizServiceApiListModelCategoryQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<BizServiceMeta[]>>;
-  // 业务服务修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<BizServiceMeta[]>;
+  /**
+   * 业务服务修改
+   */
   putBizServiceApiId(
+    path: putBizServiceApiIdPathParams,
     data: BizServiceRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 业务服务保存
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 业务服务保存
+   */
   postBizServiceApiModelCategory(
+    path: postBizServiceApiModelCategoryPathParams,
     data: BizServiceRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 业务服务通用请求接口(不挑method)
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 业务服务通用请求接口(不挑method)
+   */
   postBizServiceGeneralModelCategoryModelKeyBsKey(
+    path: postBizServiceGeneralModelCategoryModelKeyBsKeyPathParams,
     query: postBizServiceGeneralModelCategoryModelKeyBsKeyQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
-  // 业务服务get请求接口
+    data: IObject,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 业务服务get请求接口
+   */
   getBizServiceModelCategoryModelKeyBsKey(
+    path: getBizServiceModelCategoryModelKeyBsKeyPathParams,
     query: getBizServiceModelCategoryModelKeyBsKeyQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
-  // 业务服务post请求接口
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 业务服务post请求接口
+   */
   postBizServiceModelCategoryModelKeyBsKey(
+    path: postBizServiceModelCategoryModelKeyBsKeyPathParams,
     query: postBizServiceModelCategoryModelKeyBsKeyQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
-  // 业务服务put请求接口
+    data: IObject,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 业务服务put请求接口
+   */
   putBizServiceModelCategoryModelKeyBsKey(
+    path: putBizServiceModelCategoryModelKeyBsKeyPathParams,
     query: putBizServiceModelCategoryModelKeyBsKeyQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
-  // 业务服务delete请求接口
+    data: IObject,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 业务服务delete请求接口
+   */
   deleteBizServiceModelCategoryModelKeyBsKey(
+    path: deleteBizServiceModelCategoryModelKeyBsKeyPathParams,
     query: deleteBizServiceModelCategoryModelKeyBsKeyQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<object>>;
-  // 查询引用枚举数据
+    data: IObject,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<object>;
+  /**
+   * 查询引用枚举数据
+   */
   getEnumInfoModelCategory(
+    path: getEnumInfoModelCategoryPathParams,
     query: getEnumInfoModelCategoryQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<EnumModelFieldResponse[]>>;
-  // excel(按查询条件)数据导出
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<EnumModelFieldResponse[]>;
+  /**
+   * excel(按查询条件)数据导出
+   */
   postExportModelCategoryModelKeyTmplKey(
+    path: postExportModelCategoryModelKeyTmplKeyPathParams,
     query: postExportModelCategoryModelKeyTmplKeyQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 模型字段列表
+    data: IObject,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
+  /**
+   * 模型字段列表
+   */
   getFieldListModelCategory(
+    path: getFieldListModelCategoryPathParams,
     query: getFieldListModelCategoryQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<FieldMetaDTO[]>>;
-  // 模型方法列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<FieldMetaDTO[]>;
+  /**
+   * 模型方法列表
+   */
   getMethodListModelCategory(
+    path: getMethodListModelCategoryPathParams,
     query: getMethodListModelCategoryQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMethodResponse[]>>;
-  // 根据模型key批量查询模型列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMethodResponse[]>;
+  /**
+   * 根据模型key批量查询模型列表
+   */
   getModelDetailListByKeysModelCategory(
+    path: getModelDetailListByKeysModelCategoryPathParams,
     query: getModelDetailListByKeysModelCategoryQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMetaDTO[]>>;
-  // 根据模型key查询模型和字段详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMetaDTO[]>;
+  /**
+   * 根据模型key查询模型和字段详情
+   */
   getModelDetailModelCategory(
+    path: getModelDetailModelCategoryPathParams,
     query: getModelDetailModelCategoryQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMetaDTO>>;
-  // 表单模型
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMetaDTO>;
+  /**
+   * 表单模型
+   */
   getModelForm(
     query: getModelFormQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelBriefInfo[]>>;
-  // 模型信息汇总
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelBriefInfo[]>;
+  /**
+   * 模型信息汇总
+   */
   getModelSummary(
     query: getModelSummaryQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelBriefInfo[]>>;
-  // 系统模型
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelBriefInfo[]>;
+  /**
+   * 系统模型
+   */
   getModelSystem(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelFieldAgg[]>>;
-  // 获取主模型数据以及主从关联模型数据，查询所有
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelFieldAgg[]>;
+  /**
+   * 获取主模型数据以及主从关联模型数据，查询所有
+   */
   postQueryAllModelDataAndDrillData(
     data: QueryForeignFieldsRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMultiRow>>;
-  // 通过引用链数据查询引用链最后节点字段数据
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMultiRow>;
+  /**
+   * 通过引用链数据查询引用链最后节点字段数据
+   */
   postQueryFieldValueByRefChainDataModelCategory(
+    path: postQueryFieldValueByRefChainDataModelCategoryPathParams,
     data: QueryRefChainDataRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 获取主模型数据以及主从关联模型数据，查询一条
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 获取主模型数据以及主从关联模型数据，查询一条
+   */
   postQueryModelDataAndDrillData(
     data: QueryForeignFieldsRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelSingleRow>>;
-  // 查询引用链数据
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelSingleRow>;
+  /**
+   * 查询引用链数据
+   */
   postQueryRefChainDataModelCategory(
+    path: postQueryRefChainDataModelCategoryPathParams,
     data: QueryRefChainDataRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelPageableRow>>;
-  // 查询引用数据
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelPageableRow>;
+  /**
+   * 查询引用数据
+   */
   postQueryRefDataModelCategory(
+    path: postQueryRefDataModelCategoryPathParams,
     data: QueryRefDataRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelPageableRow>>;
-  // 查询引用数据ById（RDO无法使用
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelPageableRow>;
+  /**
+   * 查询引用数据ById（RDO无法使用
+   */
   postQueryRefDataByIdModelCategory(
+    path: postQueryRefDataByIdModelCategoryPathParams,
     data: QueryRefDataByIdRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelSingleRow>>;
-  // 查询引用数据ByIds（RDO无法使用）
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelSingleRow>;
+  /**
+   * 查询引用数据ByIds（RDO无法使用）
+   */
   postQueryRefDataByIdsModelCategory(
+    path: postQueryRefDataByIdsModelCategoryPathParams,
     data: QueryRefDataByIdsRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMultiRow>>;
-  // 查询关联搜索引用链数据
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMultiRow>;
+  /**
+   * 查询关联搜索引用链数据
+   */
   postQuerySearchRefChainData(
     data: QuerySearchRefChainDataRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelPageableRow>>;
-  // 获取指定模型关联的子模型集合
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelPageableRow>;
+  /**
+   * 获取指定模型关联的子模型集合
+   */
   getSubModelList(
     query: getSubModelListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelMetaDTO[]>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelMetaDTO[]>;
 }

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

@@ -1,38 +1,70 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { QueryRefDataRequest, ModelPageableRow } from '../entities';
 
 export interface getCheckFieldValueExistQuery {
-  excludeId?: string; // 需要排除的数据id
-  fieldKey: string; // 字段key
-  fieldValue: Record<string, unknown>; // 字段值
-  modelKey: string; // 模型key
-  refFieldKey?: string; // 主数据字段key，子表数据需要
-  refMasterId?: string; // 主数据id，子表数据需要
+  /**
+   * 需要排除的数据id
+   */
+  excludeId?: string;
+  /**
+   * 字段key
+   */
+  fieldKey: string;
+  /**
+   * 字段值
+   */
+  fieldValue: IObject;
+  /**
+   * 模型key
+   */
+  modelKey: string;
+  /**
+   * 主数据字段key，子表数据需要
+   */
+  refFieldKey?: string;
+  /**
+   * 主数据id，子表数据需要
+   */
+  refMasterId?: string;
 }
 export interface postSingleModelSoftDeleteDataCleanQuery {
-  modelKey: string; // modelKey
+  /**
+   * modelKey
+   */
+  modelKey: string;
 }
 export interface ModelDataService {
-  // 软删改造，liquibase模型数据清洗
+  /**
+   * 软删改造，liquibase模型数据清洗
+   */
   postAllModelLiquibaseSoftDeleteDataClean(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 软删改造，应用下所有模型数据清洗
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 软删改造，应用下所有模型数据清洗
+   */
   postAllModelSoftDeleteDataClean(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 检查字段值是否存在
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 检查字段值是否存在
+   */
   getCheckFieldValueExist(
     query: getCheckFieldValueExistQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 查询引用数据
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 查询引用数据
+   */
   postQueryRefData(
     data: QueryRefDataRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ModelPageableRow>>;
-  // 软删改造，单模型数据清洗
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ModelPageableRow>;
+  /**
+   * 软删改造，单模型数据清洗
+   */
   postSingleModelSoftDeleteDataClean(
     query: postSingleModelSoftDeleteDataCleanQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }