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

package/lib/platform/service/apis/pm-task-done.service.d.ts

@@ -6,54 +6,85 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  processId?: string; // 流程ID
-  processTitle?: string; // 流程标题
-  status?: string; // 状态
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 流程ID
+   */
+  processId?: string;
+  /**
+   * 流程标题
+   */
+  processTitle?: string;
+  /**
+   * 状态
+   */
+  status?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface PmTaskDoneService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PmTaskDoneRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PmTaskDoneResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PmTaskDoneResponse[]>>;
-  // 分页列表
+  ): Promise<PmTaskDoneResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<PmTaskDoneResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<PmTaskDoneResponse>>>;
-  // 我的流程
-  getProcess(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<AppProcess[]>>;
-  // 修改
+  ): Promise<IPage<PmTaskDoneResponse>>;
+  /**
+   * 我的流程
+   */
+  getProcess(config?: Partial<AxiosRequestConfig>): Promise<AppProcess[]>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PmTaskDoneRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/platform/service/apis/pm-task-todo.service.d.ts

@@ -6,53 +6,81 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  processId?: string; // 流程ID
-  processTitle?: string; // 流程标题
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 流程ID
+   */
+  processId?: string;
+  /**
+   * 流程标题
+   */
+  processTitle?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface PmTaskTodoService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PmTaskTodoRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PmTaskTodoResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PmTaskTodoResponse[]>>;
-  // 分页列表
+  ): Promise<PmTaskTodoResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<PmTaskTodoResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<PmTaskTodoResponse>>>;
-  // 我的流程
-  getProcess(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<AppProcess[]>>;
-  // 修改
+  ): Promise<IPage<PmTaskTodoResponse>>;
+  /**
+   * 我的流程
+   */
+  getProcess(config?: Partial<AxiosRequestConfig>): Promise<AppProcess[]>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PmTaskTodoRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/platform/service/apis/pn-page.service.d.ts

@@ -2,47 +2,69 @@ import type { AxiosRequestConfig } from 'axios';
 import type { PnPageRequest, PnPageResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: 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 PnPageService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PnPageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PnPageResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PnPageResponse[]>>;
-  // 分页列表
+  ): Promise<PnPageResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<PnPageResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<PnPageResponse>>>;
-  // 修改
+  ): Promise<IPage<PnPageResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PnPageRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/platform/service/apis/pn-project.service.d.ts

@@ -7,100 +7,166 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getChangeCategoryQuery {
-  destId?: string; // 目的地category id
-  projectId?: string; // 数据集Id
+  /**
+   * 目的地category id
+   */
+  destId?: string;
+  /**
+   * 数据集Id
+   */
+  projectId?: string;
 }
 export interface getExportQuery {
-  appId: string; // appId
-  projectId: string; // projectId
+  /**
+   * appId
+   */
+  appId: string;
+  /**
+   * projectId
+   */
+  projectId: string;
 }
 export interface postImportQuery {
-  appId: string; // appId
+  /**
+   * appId
+   */
+  appId: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getInfoNoHeaderQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  appId?: string; // 应用Id
-  categoryId?: string; // 分类Id
-  developCanvas?: string; // 绑定设计器组件名
-  name?: string; // 查询条件
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 应用Id
+   */
+  appId?: string;
+  /**
+   * 分类Id
+   */
+  categoryId?: string;
+  /**
+   * 绑定设计器组件名
+   */
+  developCanvas?: string;
+  /**
+   * 查询条件
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface PnProjectService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PnProjectRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 更换project分类
+  ): Promise<string>;
+  /**
+   * 更换project分类
+   */
   getChangeCategory(
     query: getChangeCategoryQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 复制
+  ): Promise<string>;
+  /**
+   * 复制
+   */
   postCopy(
     data: PnPageSaveRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 工程导出
+  ): Promise<string>;
+  /**
+   * 工程导出
+   */
   getExport(
     query: getExportQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 工程导入
+  ): Promise<unknown>;
+  /**
+   * 工程导入
+   */
   postImport(
     query: postImportQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PnProjectResponse>>;
-  // 详情(裸奔接口)
+  ): Promise<PnProjectResponse>;
+  /**
+   * 详情(裸奔接口)
+   */
   getInfoNoHeader(
     query: getInfoNoHeaderQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PnProjectResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PnProjectResponse[]>>;
-  // 分页列表
+  ): Promise<PnProjectResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<PnProjectResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<PnProjectResponse>>>;
-  // 发布/取消发布
+  ): Promise<IPage<PnProjectResponse>>;
+  /**
+   * 发布/取消发布
+   */
   postRelease(
     data: 发布,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 保存页面
+  ): Promise<string>;
+  /**
+   * 保存页面
+   */
   postSavePage(
     data: PnPageSaveRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PnProjectRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/platform/service/apis/print-log.service.d.ts

@@ -2,47 +2,106 @@ import type { AxiosRequestConfig } from 'axios';
 import type { PrintLogRequest, PrintLogResponse } from '../entities';
 
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  key: string; // key
+  /**
+   * key
+   */
+  key: string;
 }
 export interface getPageListQuery {
-  branchId?: string; // 分支
-  endTime?: string; // 结束时间
-  env?: string; // 环境
-  key?: string; // key
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  printAppId?: string; // printAppId
-  printAppName?: string; // 触发打印的应用名称
-  printName?: string; // printName
-  printType?: string; // 打印的类型
-  resourceName?: string; // resourceName
-  resourceType?: string; // resourceType
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
+  /**
+   * 分支
+   */
+  branchId?: string;
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 环境
+   */
+  env?: string;
+  /**
+   * key
+   */
+  key?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * printAppId
+   */
+  printAppId?: string;
+  /**
+   * 触发打印的应用名称
+   */
+  printAppName?: string;
+  /**
+   * printName
+   */
+  printName?: string;
+  /**
+   * 打印的类型
+   */
+  printType?: string;
+  /**
+   * resourceName
+   */
+  resourceName?: string;
+  /**
+   * resourceType
+   */
+  resourceType?: string;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
 }
 export interface PrintLogService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PrintLogRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PrintLogResponse>>;
-  // 列表
+  ): Promise<PrintLogResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PrintLogResponse[]>>;
-  // 分页列表
+  ): Promise<PrintLogResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<PrintLogResponse>>>;
+  ): Promise<IPage<PrintLogResponse>>;
 }