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

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

@@ -7,125 +7,333 @@ import type {
 } from '../entities';
 
 export interface deleteQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getGetListRdoOrNdoQuery {
-  modelMetaId?: string; // 当前模型的id
-  subModel?: number; // 模型是否为子模型 不传查询全部 (1 子模型, 0 非子模型)
-  type: string; // （分类关联数据） (NDO 名称对象,RDO 版本对象, WORKFLOW 工作流,DYNAMIC_FORM 动态表单,BASE 基础,TREE 树模型 )
+  /**
+   * 当前模型的id
+   */
+  modelMetaId?: string;
+  /**
+   * 模型是否为子模型 不传查询全部 (1 子模型, 0 非子模型)
+   */
+  subModel?: number;
+  /**
+   * （分类关联数据） (NDO 名称对象,RDO 版本对象, WORKFLOW 工作流,DYNAMIC_FORM 动态表单,BASE 基础,TREE 树模型 )
+   */
+  type: string;
+}
+export interface getInfoIdPathParams {
+  id: string;
 }
 export interface getListQuery {
-  endTime?: string; // 结束时间
-  name?: string; // 应用名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortNum?: number; // 排序
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
-  sysBuiltin?: number; // 是否系统内置数据(0普通、1内置)
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 所属模块(实体、枚举、web页面)
+   */
+  module?: string;
+  /**
+   * 应用名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序
+   */
+  sortNum?: number;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
+  /**
+   * 是否系统内置数据(0普通、1内置)
+   */
+  sysBuiltin?: number;
 }
 export interface getListCompleteQuery {
-  createTime?: string; //
-  createUserId?: string; //
-  createUserName?: string; //
-  deleted?: number; //
-  fullPath?: string; //
-  id?: string; //
-  modifyTime?: string; //
-  modifyUserId?: string; //
-  modifyUserName?: string; //
-  name?: string; //
-  pageId?: string; // 关联的页面id, 当pageId 不为空时 追加pageId 相关数据
-  parentId?: string; // 父节点id , 有则传
-  procDefId?: string; //
-  relationId?: string; //
-  sortNum?: number; //
-  sysBuiltin?: number; //
-  type?: string; //
+  /**
+   *
+   */
+  createTime?: string;
+  /**
+   *
+   */
+  createUserId?: string;
+  /**
+   *
+   */
+  createUserName?: string;
+  /**
+   *
+   */
+  deleted?: number;
+  /**
+   *
+   */
+  fullPath?: string;
+  /**
+   *
+   */
+  id?: string;
+  /**
+   *
+   */
+  modifyTime?: string;
+  /**
+   *
+   */
+  modifyUserId?: string;
+  /**
+   *
+   */
+  modifyUserName?: string;
+  /**
+   * 所属模块(实体、枚举、web页面 、view_model_module/视图模型模块 、data_model/数据模型模块、document_module/单据、pad_module/pad页面设计)
+   */
+  module?: string;
+  /**
+   *
+   */
+  name?: string;
+  /**
+   * 关联的页面id, 当pageId 不为空时 追加pageId 相关数据
+   */
+  pageId?: string;
+  /**
+   * 父节点id , 有则传
+   */
+  parentId?: string;
+  /**
+   *
+   */
+  procDefId?: string;
+  /**
+   *
+   */
+  relationId?: string;
+  /**
+   *
+   */
+  sortNum?: number;
+  /**
+   *
+   */
+  sysBuiltin?: number;
+  /**
+   *
+   */
+  type?: string;
 }
 export interface getPageQuery {
-  createTime?: string; //
-  createUserId?: string; //
-  createUserName?: string; //
-  deleted?: number; //
-  fullPath?: string; //
-  id?: string; //
-  modifyTime?: string; //
-  modifyUserId?: string; //
-  modifyUserName?: string; //
-  name?: string; //
-  pageId?: string; // 关联的页面id, 当pageId 不为空时 追加pageId 相关数据
-  parentId?: string; // 父节点id , 有则传
-  procDefId?: string; //
-  relationId?: string; //
-  sortNum?: number; //
-  sysBuiltin?: number; //
-  type?: string; //
+  /**
+   *
+   */
+  createTime?: string;
+  /**
+   *
+   */
+  createUserId?: string;
+  /**
+   *
+   */
+  createUserName?: string;
+  /**
+   *
+   */
+  deleted?: number;
+  /**
+   *
+   */
+  fullPath?: string;
+  /**
+   *
+   */
+  id?: string;
+  /**
+   *
+   */
+  modifyTime?: string;
+  /**
+   *
+   */
+  modifyUserId?: string;
+  /**
+   *
+   */
+  modifyUserName?: string;
+  /**
+   * 所属模块(实体、枚举、web页面 、view_model_module/视图模型模块 、data_model/数据模型模块、document_module/单据、pad_module/pad页面设计)
+   */
+  module?: string;
+  /**
+   *
+   */
+  name?: string;
+  /**
+   * 关联的页面id, 当pageId 不为空时 追加pageId 相关数据
+   */
+  pageId?: string;
+  /**
+   * 父节点id , 有则传
+   */
+  parentId?: string;
+  /**
+   *
+   */
+  procDefId?: string;
+  /**
+   *
+   */
+  relationId?: string;
+  /**
+   *
+   */
+  sortNum?: number;
+  /**
+   *
+   */
+  sysBuiltin?: number;
+  /**
+   *
+   */
+  type?: string;
 }
 export interface getPageListQuery {
-  endTime?: string; // 结束时间
-  name?: string; // 应用名称
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortNum?: number; // 排序
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
-  sysBuiltin?: number; // 是否系统内置数据(0普通、1内置)
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 所属模块(实体、枚举、web页面)
+   */
+  module?: string;
+  /**
+   * 应用名称
+   */
+  name?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序
+   */
+  sortNum?: number;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
+  /**
+   * 是否系统内置数据(0普通、1内置)
+   */
+  sysBuiltin?: number;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface CategoryService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: CategoryRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 拖拽
+  ): Promise<string>;
+  /**
+   * 拖拽
+   */
   postDrag(
     data: CategoryDragRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // （分类关联数据） (NDO 名称对象,RDO 版本对象, WORKFLOW 工作流,DYNAMIC_FORM 动态表单,BASE 基础,TREE 树模型 )
+  ): Promise<string>;
+  /**
+   * （分类关联数据） (NDO 名称对象,RDO 版本对象, WORKFLOW 工作流,DYNAMIC_FORM 动态表单,BASE 基础,TREE 树模型 )
+   */
   getGetListRdoOrNdo(
     query: getGetListRdoOrNdoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<CategoryCompleteResponse[]>>;
-  // 详情
+  ): Promise<CategoryCompleteResponse[]>;
+  /**
+   * 详情
+   */
   getInfoId(
+    path: getInfoIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<CategoryResponse>>;
-  // 列表
+  ): Promise<CategoryResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<CategoryResponse[]>>;
-  // 分页列表（分类关联数据）
+  ): Promise<CategoryResponse[]>;
+  /**
+   * 分页列表（分类关联数据）
+   */
   getListComplete(
     query: getListCompleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<CategoryCompleteResponse[]>>;
-  // 页面列表（分类关联页面数据）
+  ): Promise<CategoryCompleteResponse[]>;
+  /**
+   * 页面列表（分类关联页面数据）
+   */
   getPage(
     query: getPageQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<CategoryCompleteResponse[]>>;
-  // 分页列表
+  ): Promise<CategoryCompleteResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<CategoryResponse>>>;
-  // 修改
+  ): Promise<IPage<CategoryResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: CategoryRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

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

@@ -1,12 +1,20 @@
 import type { AxiosRequestConfig } from 'axios';
 export interface postImportExcelQuery {
-  message: string; // message
-  modelKey: string; // modelKey
+  /**
+   * message
+   */
+  message: string;
+  /**
+   * modelKey
+   */
+  modelKey: string;
 }
 export interface ChatService {
-  // 导入excel
+  /**
+   * 导入excel
+   */
   postImportExcel(
     query: postImportExcelQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<object>>;
+  ): Promise<object>;
 }

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

@@ -1,7 +1,7 @@
 import type { AxiosRequestConfig } from 'axios';
 export interface CodeTsService {
-  // 创建ts文件
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
+  /**
+   * 创建ts文件
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<unknown>;
 }

package/lib/apaas/service/apis/commit-log.service.d.ts

@@ -7,93 +7,141 @@ 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; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface getReleaseInfoQuery {
-  releaseTag: string; // releaseTag
+  /**
+   * releaseTag
+   */
+  releaseTag: string;
 }
 export interface getReleasePageListQuery {
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
 }
 export interface getViewDetailQuery {
-  commitId: string; // 提交id
+  /**
+   * 提交id
+   */
+  commitId: string;
 }
-export interface putIdQuery {
-  id: string; // 数据主键
+export interface putIdPathParams {
+  id: string;
 }
 export interface CommitLogService {
-  // 保存
+  /**
+   * 保存
+   */
   post(
     data: CommitLogRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 可发布生产的发行标识列表查询
+  ): Promise<string>;
+  /**
+   * 可发布生产的发行标识列表查询
+   */
   getCanPublishProdReleaseTagList(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string[]>>;
-  // 能发行的提交标识列表
-  getCanReleaseTagList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string[]>>;
-  // 提交
+  ): Promise<string[]>;
+  /**
+   * 能发行的提交标识列表
+   */
+  getCanReleaseTagList(config?: Partial<AxiosRequestConfig>): Promise<string[]>;
+  /**
+   * 提交
+   */
   postCommit(
     data: CommitRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 查看最新提交信息
+  ): Promise<string>;
+  /**
+   * 查看最新提交信息
+   */
   getGetLatestCommit(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<CommitLogResponse>>;
-  // 详情
+  ): Promise<CommitLogResponse>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<CommitLogResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<CommitLogResponse[]>>;
-  // 分页列表
+  ): Promise<CommitLogResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<CommitLogResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<CommitLogResponse>>>;
-  // 发行记录详情
+  ): Promise<IPage<CommitLogResponse>>;
+  /**
+   * 发行记录详情
+   */
   getReleaseInfo(
     query: getReleaseInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<CommitLogResponse>>;
-  // 发行记录分页列表
+  ): Promise<CommitLogResponse>;
+  /**
+   * 发行记录分页列表
+   */
   getReleasePageList(
     query: getReleasePageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<CommitLogResponse>>>;
-  // 浏览提交详情
+  ): Promise<IPage<CommitLogResponse>>;
+  /**
+   * 浏览提交详情
+   */
   getViewDetail(
     query: getViewDetailQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ReadableCommitDetailDTO[]>>;
-  // 浏览草稿
+  ): Promise<ReadableCommitDetailDTO[]>;
+  /**
+   * 浏览草稿
+   */
   getViewDraft(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<ReadableCommitDetailDTO[]>>;
-  // 修改
+  ): Promise<ReadableCommitDetailDTO[]>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: CommitLogRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }