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

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

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { AxiosRequestConfig } from 'axios';
 import type {
   PnProjectRequest,
   PnPageSaveRequest,
@@ -6,100 +8,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?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 更换project分类
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 更换project分类
+   */
   getChangeCategory(
     query: getChangeCategoryQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 复制
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 复制
+   */
   postCopy(
     data: PnPageSaveRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 工程导出
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 工程导出
+   */
   getExport(
     query: getExportQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<unknown>>;
-  // 工程导入
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<any>;
+  /**
+   * 工程导入
+   */
   postImport(
     query: postImportQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PnProjectResponse>>;
-  // 详情(裸奔接口)
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PnProjectResponse>;
+  /**
+   * 详情(裸奔接口)
+   */
   getInfoNoHeader(
     query: getInfoNoHeaderQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PnProjectResponse>>;
-  // 列表
-  getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PnProjectResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PnProjectResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<PnProjectResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<PnProjectResponse>>>;
-  // 发布/取消发布
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<PnProjectResponse>>;
+  /**
+   * 发布/取消发布
+   */
   postRelease(
     data: 发布,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 保存页面
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 保存页面
+   */
   postSavePage(
     data: PnPageSaveRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PnProjectRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

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

@@ -1,47 +1,107 @@
+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?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PrintLogResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PrintLogResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PrintLogResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PrintLogResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<PrintLogResponse>>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<PrintLogResponse>>;
 }

package/es/platform/service/apis/print-resource.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   PrintResourceRequest,
   PrintResourceCount,
@@ -8,78 +9,123 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getGetIpAddressStatusQuery {
-  address: string; // address
-  type: string; // type
+  /**
+   * address
+   */
+  address: string;
+  /**
+   * type
+   */
+  type: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getListQuery {
-  queryState: number; // queryState
-  type: string; // type
+  /**
+   * queryState
+   */
+  queryState: number;
+  /**
+   * type
+   */
+  type: string;
 }
 export interface getListByMacAddressQuery {
-  macAddress?: string; // macAddress
+  /**
+   * macAddress
+   */
+  macAddress?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putUpdateRemarkIdPathParams {
+  id: string;
+}
+export interface putIdPathParams {
+  id: string;
 }
 export interface PrintResourceService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: PrintResourceRequest,
-    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>;
+  /**
+   * 查询打印机状态
+   */
   getGetIpAddressStatus(
     query: getGetIpAddressStatusQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 获取打印服务和网络打印机的数量
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 获取打印服务和网络打印机的数量
+   */
   getGetPrintCount(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PrintResourceCount>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PrintResourceCount>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PrintResourceResponse>>;
-  // 列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PrintResourceResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PrintResourceResponse[]>>;
-  // 根据mac地址查询打印机列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PrintResourceResponse[]>;
+  /**
+   * 根据mac地址查询打印机列表
+   */
   getListByMacAddress(
     query: getListByMacAddressQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<PrintListDto[]>>;
-  // printTest
-  postPrintTest(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 给打印机推送打印消息
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<PrintListDto[]>;
+  /**
+   * printTest
+   */
+  postPrintTest(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 给打印机推送打印消息
+   */
   postSendPrintData(
     data: PrintLogDto,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改备注
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 修改备注
+   */
   putUpdateRemarkId(
+    path: putUpdateRemarkIdPathParams,
     data: PrintResourceRemarkRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PrintResourceRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/es/platform/service/apis/regexp.service.d.ts

@@ -1,53 +1,94 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { RegexpRequest, RegexpResponse } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  endTime?: string; // 结束时间
-  name?: string; // 正则名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
-  value?: string; // 正则值
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 正则名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
+  /**
+   * 正则值
+   */
+  value?: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface RegexpService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: RegexpRequest,
-    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<RegexpResponse>>;
-  // 列表
-  getList(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<RegexpResponse[]>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<RegexpResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<RegexpResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<RegexpResponse>>>;
-  // 修改
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<RegexpResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: RegexpRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }