@gct-paas/api 0.1.0-dev.5 → 0.1.0-dev.7

package/lib/apaas/service/apis/biz-process-definition.service.d.ts

@@ -6,53 +6,86 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface deleteDeleteCategoryQuery {
-  id: string; // 删除的分类id
+  /**
+   * 删除的分类id
+   */
+  id: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  categoryId: string; // categoryId
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  query?: string; // query
+  /**
+   * categoryId
+   */
+  categoryId: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * query
+   */
+  query?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface BizProcessDefinitionService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PmProcessDefinition,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PmProcessVersion>>;
-  // 删除
+  ): Promise<PmProcessVersion>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 分类删除
+  ): Promise<string>;
+  /**
+   * 分类删除
+   */
   deleteDeleteCategory(
     query: deleteDeleteCategoryQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<void>>;
-  // 详情
+  ): Promise<void>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PmProcessDefinition>>;
-  // 分页列表
+  ): Promise<PmProcessDefinition>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<PmProcessActiveVersion>>>;
-  // 修改
+  ): Promise<IPage<PmProcessActiveVersion>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PmProcessDefinition,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/biz-service-crud.service.d.ts

@@ -7,86 +7,176 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  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 getPageListQuery {
-  endTime?: string; // 结束时间
-  key?: string; // 服务key
-  method?: string; // 服务方式
-  modelKey?: string; // 模型key
-  name?: string; // 服务name
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortNum?: number; // 排序
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
-  type?: string; // 服务类型
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 服务key
+   */
+  key?: string;
+  /**
+   * 服务方式
+   */
+  method?: string;
+  /**
+   * 模型key
+   */
+  modelKey?: string;
+  /**
+   * 服务name
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序
+   */
+  sortNum?: number;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
+  /**
+   * 服务类型
+   */
+  type?: string;
 }
 export interface getViewModelListQuery {
-  modelKey?: string; // modelKey
+  /**
+   * modelKey
+   */
+  modelKey?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface BizServiceCrudService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: BizServiceRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 数据模型业务服务列表
+  ): Promise<string>;
+  /**
+   * 数据模型业务服务列表
+   */
   getDataModelList(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<BizServiceMeta[]>>;
-  // 拖拽
+  ): Promise<BizServiceMeta[]>;
+  /**
+   * 拖拽
+   */
   postDrag(
     data: BizServiceDragRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<BizServiceResponse>>;
-  // 列表
+  ): Promise<BizServiceResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<BizServiceMeta[]>>;
-  // 分页列表
+  ): Promise<BizServiceMeta[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<BizServiceResponse>>>;
-  // 视图模型业务服务列表
+  ): Promise<IPage<BizServiceResponse>>;
+  /**
+   * 视图模型业务服务列表
+   */
   getViewModelList(
     query: getViewModelListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<BizServiceMeta[]>>;
-  // 修改
+  ): Promise<BizServiceMeta[]>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: BizServiceRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/biz-service.service.d.ts

@@ -1,35 +1,57 @@
 import type { AxiosRequestConfig } from 'axios';
-export interface getModelKeyBsKeyQuery {
-  requestParam: Record<string, unknown>; // requestParam
+export type getModelKeyBsKeyQuery = Record<string, unknown>;
+export interface getModelKeyBsKeyPathParams {
+  modelKey: string;
+  bsKey: string;
 }
-export interface postModelKeyBsKeyQuery {
-  requestParam: Record<string, unknown>; // requestParam
+export type postModelKeyBsKeyQuery = Record<string, unknown>;
+export interface postModelKeyBsKeyPathParams {
+  modelKey: string;
+  bsKey: string;
 }
-export interface putModelKeyBsKeyQuery {
-  requestParam: Record<string, unknown>; // requestParam
+export type putModelKeyBsKeyQuery = Record<string, unknown>;
+export interface putModelKeyBsKeyPathParams {
+  modelKey: string;
+  bsKey: string;
 }
-export interface deleteModelKeyBsKeyQuery {
-  requestParam: Record<string, unknown>; // requestParam
+export type deleteModelKeyBsKeyQuery = Record<string, unknown>;
+export interface deleteModelKeyBsKeyPathParams {
+  modelKey: string;
+  bsKey: string;
 }
 export interface BizServiceService {
-  // get通用接口
+  /**
+   * get通用接口
+   */
   getModelKeyBsKey(
+    path: getModelKeyBsKeyPathParams,
     query: getModelKeyBsKeyQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<object>>;
-  // post通用接口
+  ): Promise<object>;
+  /**
+   * post通用接口
+   */
   postModelKeyBsKey(
+    path: postModelKeyBsKeyPathParams,
     query: postModelKeyBsKeyQuery,
+    data: IObject,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<object>>;
-  // put通用接口
+  ): Promise<object>;
+  /**
+   * put通用接口
+   */
   putModelKeyBsKey(
+    path: putModelKeyBsKeyPathParams,
     query: putModelKeyBsKeyQuery,
+    data: IObject,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<object>>;
-  // delete通用接口
+  ): Promise<object>;
+  /**
+   * delete通用接口
+   */
   deleteModelKeyBsKey(
+    path: deleteModelKeyBsKeyPathParams,
     query: deleteModelKeyBsKeyQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<object>>;
+  ): Promise<object>;
 }

package/lib/apaas/service/apis/bom.service.d.ts

@@ -1,7 +1,7 @@
 import type { AxiosRequestConfig } from 'axios';
 export interface BomService {
-  // 导入 bom
-  postImport(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  /**
+   * 导入 bom
+   */
+  postImport(config?: Partial<AxiosRequestConfig>): Promise<string>;
 }

package/lib/apaas/service/apis/category-relation.service.d.ts

@@ -6,55 +6,103 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
+}
+export interface getInfoIdPathParams {
+  id: string;
 }
 export interface getPageListQuery {
-  categoryId?: string; // 分类id
-  endTime?: string; // 结束时间
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  relationId?: string; // 分类关联id
-  sortField?: string; // 排序字段
-  sortNum?: number; // 排序
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
+  /**
+   * 分类id
+   */
+  categoryId?: string;
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 分类关联id
+   */
+  relationId?: string;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序
+   */
+  sortNum?: number;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface CategoryRelationService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: CategoryRelationRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 拖拽
+  ): Promise<string>;
+  /**
+   * 拖拽
+   */
   postDrag(
     data: CategoryRelationDragRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfoId(
+    path: getInfoIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<CategoryRelationResponse>>;
-  // 列表
+  ): Promise<CategoryRelationResponse>;
+  /**
+   * 列表
+   */
   getList(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<CategoryRelationResponse[]>>;
-  // 分页列表
+  ): Promise<CategoryRelationResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<CategoryRelationResponse>>>;
-  // 修改
+  ): Promise<IPage<CategoryRelationResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: CategoryRelationRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }