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

package/lib/apaas/service/apis/edhr-instance.service.d.ts

@@ -1,3 +1,4 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   EdhrInstanceRequest,
   EdhrInstanceResponse,
@@ -6,112 +7,271 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getFindByMaterialNoQuery {
-  materialNo: string; // materialNo
+  /**
+   * materialNo
+   */
+  materialNo: string;
 }
 export interface getFindMaterialNoQuery {
-  ignoreArchived?: boolean; // 是否忽略封存状态
-  materialNo?: string; // 批次号
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
+  /**
+   * 是否忽略封存状态
+   */
+  ignoreArchived?: boolean;
+  /**
+   * 批次号
+   */
+  materialNo?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
 }
 export interface getInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPageListQuery {
-  createUserId?: string; // 创建人id
-  device?: string; // 设备
-  endTime?: string; // 创建时间-结束
-  instanceStatus?: string; // edhr状态
-  materialNo?: string; // 记录标识
-  materialNos?: string; // 批次/SN数组
-  materialStatus?: string; // 记录类型(NO或SN)
-  mfgOrderId?: string; // 工单id
-  modifyUserId?: string; // 更新人id
-  operator?: string; // 操作人
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  productId?: string; // 产品ID
-  serialNo?: string; // 流水号
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 创建时间-开始
+  /**
+   * 创建人id
+   */
+  createUserId?: string;
+  /**
+   * 设备
+   */
+  device?: string;
+  /**
+   * 创建时间-结束
+   */
+  endTime?: string;
+  /**
+   * edhr状态
+   */
+  instanceStatus?: string;
+  /**
+   * 记录标识
+   */
+  materialNo?: string;
+  /**
+   * 批次/SN数组
+   */
+  materialNos?: string[];
+  /**
+   * 记录类型(NO或SN)
+   */
+  materialStatus?: string;
+  /**
+   * 工单id
+   */
+  mfgOrderId?: string;
+  /**
+   * 更新人id
+   */
+  modifyUserId?: string;
+  /**
+   * 操作人
+   */
+  operator?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 产品ID
+   */
+  productId?: string;
+  /**
+   * 流水号
+   */
+  serialNo?: string;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 创建时间-开始
+   */
+  startTime?: string;
 }
 export interface getReversePageListQuery {
-  device?: string; // 设备
-  endTraceDate?: string; // 日期结束
-  materialNo?: string; // 物料编号
-  mfgOrderId?: string; // 工单id
-  operator?: string; // 操作人
-  operatorId?: string; // 操作人id
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  product?: string; // 产品
-  recordNo?: string; // 记录单号
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTraceDate?: string; // 日期开始
+  /**
+   * 设备
+   */
+  device?: string;
+  /**
+   * 日期结束
+   */
+  endTraceDate?: string;
+  /**
+   * 物料编号
+   */
+  materialNo?: string;
+  /**
+   * 工单id
+   */
+  mfgOrderId?: string;
+  /**
+   * 操作人
+   */
+  operator?: string;
+  /**
+   * 操作人id
+   */
+  operatorId?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 产品
+   */
+  product?: string;
+  /**
+   * 记录单号
+   */
+  recordNo?: string;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 日期开始
+   */
+  startTraceDate?: string;
 }
 export interface getRunningPageQuery {
-  ignoreArchived?: boolean; // 是否忽略封存状态
-  materialNo?: string; // 批次号
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
+  /**
+   * 是否忽略封存状态
+   */
+  ignoreArchived?: boolean;
+  /**
+   * 批次号
+   */
+  materialNo?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+}
+export interface putUpdateInstanceStatusById4ArchivedIdPathParams {
+  id: string;
 }
 export interface EdhrInstanceService {
-  // 创建实例保存
+  /**
+   * 创建实例保存
+   */
   post(
     data: EdhrInstanceRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 根据materialNo查询edhr实例
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 根据materialNo查询edhr实例
+   */
   getFindByMaterialNo(
     query: getFindByMaterialNoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<EdhrInstanceResponse>>;
-  // 查询所有批次号
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<EdhrInstanceResponse>;
+  /**
+   * 查询所有批次号
+   */
   getFindMaterialNo(
     query: getFindMaterialNoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<MaterialNo4TaskResponse>>>;
-  // 详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<MaterialNo4TaskResponse>>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<EdhrInstanceResponse>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<EdhrInstanceResponse>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<EdhrInstanceResponse>>>;
-  // 分页列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<EdhrInstanceResponse>>;
+  /**
+   * 分页列表
+   */
   postPageListGroup(
     data: EdhrInstanceQueryRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<EdhrInstanceResponse>>>;
-  // 反向追溯分页查询
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<EdhrInstanceResponse>>;
+  /**
+   * 反向追溯分页查询
+   */
   getReversePageList(
     query: getReversePageListQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<EdhrInstanceResponse>>>;
-  // 根据批次号查询
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<EdhrInstanceResponse>>;
+  /**
+   * 根据批次号查询
+   */
   getRunningPage(
     query: getRunningPageQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<IPage<EdhrInstanceResponse>>>;
-  // 修改为归档状态
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<IPage<EdhrInstanceResponse>>;
+  /**
+   * 修改为归档状态
+   */
   putUpdateInstanceStatusById4ArchivedId(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
+    path: putUpdateInstanceStatusById4ArchivedIdPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
 }

package/lib/apaas/service/apis/edhr-tmpl.service.d.ts

@@ -1,82 +1,138 @@
+import type { AxiosRequestConfig } from 'axios';
 import type {
   OfProcessControlRequest,
   EdhrTmplRequest,
   EdhrTmplResponse,
 } from '../entities';
 
+export interface postCopyIdPathParams {
+  id: string;
+}
+export interface postCopyVersionIdPathParams {
+  id: string;
+}
 export interface getGetVersionByIdQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getInfoQuery {
-  edhrId: string; // id
+  /**
+   * id
+   */
+  edhrId: string;
 }
 export interface getListVersionByIdQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface deleteRemoveByIdQuery {
-  id: string; // 删除的id
+  /**
+   * 删除的id
+   */
+  id: string;
 }
 export interface deleteRemoveVersionByIdQuery {
-  id: string; // 删除的id
+  /**
+   * 删除的id
+   */
+  id: string;
+}
+export interface putSetDefaultIdPathParams {
+  id: string;
+}
+export interface putUpdateVersionByIdIdPathParams {
+  id: string;
 }
 export interface EdhrTmplService {
-  // eDHR发起受控
+  /**
+   * eDHR发起受控
+   */
   postControl(
     data: OfProcessControlRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 复制
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 复制
+   */
   postCopyId(
+    path: postCopyIdPathParams,
     data: EdhrTmplRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 复制版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 复制版本
+   */
   postCopyVersionId(
+    path: postCopyVersionIdPathParams,
     data: EdhrTmplRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 根据id查子
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 根据id查子
+   */
   getGetVersionById(
     query: getGetVersionByIdQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<EdhrTmplResponse>>;
-  // edhr查询详情
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<EdhrTmplResponse>;
+  /**
+   * edhr查询详情
+   */
   getInfo(
     query: getInfoQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<EdhrTmplResponse>>;
-  // 根据父id查子列表
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<EdhrTmplResponse>;
+  /**
+   * 根据父id查子列表
+   */
   getListVersionById(
     query: getListVersionByIdQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<EdhrTmplResponse[]>>;
-  // 删除
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<EdhrTmplResponse[]>;
+  /**
+   * 删除
+   */
   deleteRemoveById(
     query: deleteRemoveByIdQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 删除版本
+   */
   deleteRemoveVersionById(
     query: deleteRemoveVersionByIdQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 保存
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<boolean>;
+  /**
+   * 保存
+   */
   postSave(
     data: EdhrTmplRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 保存版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 保存版本
+   */
   postSaveVersion(
     data: EdhrTmplRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 设为默认版本
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 设为默认版本
+   */
   putSetDefaultId(
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改版本
+    path: putSetDefaultIdPathParams,
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
+  /**
+   * 修改版本
+   */
   putUpdateVersionByIdId(
+    path: putUpdateVersionByIdIdPathParams,
     data: EdhrTmplRequest,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<string>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<string>;
 }

package/lib/apaas/service/apis/ele-search.service.d.ts

@@ -1,12 +1,18 @@
+import type { AxiosRequestConfig } from 'axios';
 import type { ElementInfoResponse } from '../entities';
 
 export interface getSearchByKeyQuery {
-  key?: string; // 搜索关键词
+  /**
+   * 搜索关键词
+   */
+  key?: string;
 }
 export interface EleSearchService {
-  // 按key搜索
+  /**
+   * 按key搜索
+   */
   getSearchByKey(
     query: getSearchByKeyQuery,
-    config?: Record<string, string>,
-  ): Promise<IHttpResponse<ElementInfoResponse[]>>;
+    config?: Partial<AxiosRequestConfig>,
+  ): Promise<ElementInfoResponse[]>;
 }