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

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

@@ -9,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?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 删除
+  ): Promise<string>;
+  /**
+   * 删除
+   */
   delete(
     query: deleteQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 查询打印机状态
+  ): Promise<string>;
+  /**
+   * 查询打印机状态
+   */
   getGetIpAddressStatus(
     query: getGetIpAddressStatusQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<boolean>>;
-  // 获取打印服务和网络打印机的数量
+  ): Promise<boolean>;
+  /**
+   * 获取打印服务和网络打印机的数量
+   */
   getGetPrintCount(
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PrintResourceCount>>;
-  // 详情
+  ): Promise<PrintResourceCount>;
+  /**
+   * 详情
+   */
   getInfo(
     query: getInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PrintResourceResponse>>;
-  // 列表
+  ): Promise<PrintResourceResponse>;
+  /**
+   * 列表
+   */
   getList(
     query: getListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PrintResourceResponse[]>>;
-  // 根据mac地址查询打印机列表
+  ): Promise<PrintResourceResponse[]>;
+  /**
+   * 根据mac地址查询打印机列表
+   */
   getListByMacAddress(
     query: getListByMacAddressQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PrintListDto[]>>;
-  // printTest
-  postPrintTest(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 给打印机推送打印消息
+  ): Promise<PrintListDto[]>;
+  /**
+   * printTest
+   */
+  postPrintTest(config?: Partial<AxiosRequestConfig>): Promise<string>;
+  /**
+   * 给打印机推送打印消息
+   */
   postSendPrintData(
     data: PrintLogDto,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改备注
+  ): Promise<string>;
+  /**
+   * 修改备注
+   */
   putUpdateRemarkId(
+    path: putUpdateRemarkIdPathParams,
     data: PrintResourceRemarkRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 修改
+  ): Promise<string>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: PrintResourceRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

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

@@ -2,53 +2,93 @@ 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?: 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<RegexpResponse>>;
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<RegexpResponse[]>>;
-  // 分页列表
+  ): Promise<RegexpResponse>;
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<RegexpResponse[]>;
+  /**
+   * 分页列表
+   */
   getPageList(
     query: getPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<RegexpResponse>>>;
-  // 修改
+  ): Promise<IPage<RegexpResponse>>;
+  /**
+   * 修改
+   */
   putId(
-    query: putIdQuery,
+    path: putIdPathParams,
     data: RegexpRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/platform/service/apis/released.service.d.ts

@@ -2,44 +2,95 @@ import type { AxiosRequestConfig } from 'axios';
 import type { PublishedAppDtoResponse } from '../entities';
 
 export interface deleteAppDeletePublishedAppByTestIdQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
+}
+export interface putAppDisableAppIdPathParams {
+  appId: string;
+}
+export interface putAppEnableAppIdPathParams {
+  appId: string;
 }
 export interface getAppPublishedAppGetByIdQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getAppPublishedAppListQuery {
-  appId?: string; // 应用id
-  appName?: string; // 应用名称
-  endTime?: string; // 结束时间
-  env?: string; // 环境标识
-  pageNo?: number; // 页码
-  pageSize?: number; // 分页大小
-  sortField?: string; // 排序字段
-  sortType?: string; // 排序方式：ASC/DESC， 不传默认 ASC
-  startTime?: string; // 开始时间
+  /**
+   * 应用id
+   */
+  appId?: string;
+  /**
+   * 应用名称
+   */
+  appName?: string;
+  /**
+   * 结束时间
+   */
+  endTime?: string;
+  /**
+   * 环境标识
+   */
+  env?: string;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 分页大小
+   */
+  pageSize?: number;
+  /**
+   * 排序字段
+   */
+  sortField?: string;
+  /**
+   * 排序方式：ASC/DESC， 不传默认 ASC
+   */
+  sortType?: string;
+  /**
+   * 开始时间
+   */
+  startTime?: string;
 }
 export interface ReleasedService {
-  // 测试环境应用移除接口
+  /**
+   * 测试环境应用移除接口
+   */
   deleteAppDeletePublishedAppByTestId(
     query: deleteAppDeletePublishedAppByTestIdQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 企业后台管理禁用应用
+  ): Promise<string>;
+  /**
+   * 企业后台管理禁用应用
+   */
   putAppDisableAppId(
+    path: putAppDisableAppIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 启用
+  ): Promise<string>;
+  /**
+   * 启用
+   */
   putAppEnableAppId(
+    path: putAppEnableAppIdPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // 获取已发布应详情
+  ): Promise<string>;
+  /**
+   * 获取已发布应详情
+   */
   getAppPublishedAppGetById(
     query: getAppPublishedAppGetByIdQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<PublishedAppDtoResponse>>;
-  // 获取已发布应用列表
+  ): Promise<PublishedAppDtoResponse>;
+  /**
+   * 获取已发布应用列表
+   */
   getAppPublishedAppList(
     query: getAppPublishedAppListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<PublishedAppDtoResponse>>>;
+  ): Promise<IPage<PublishedAppDtoResponse>>;
 }

package/lib/platform/service/apis/resourceTransferToPage.service.d.ts

@@ -2,9 +2,11 @@ import type { AxiosRequestConfig } from 'axios';
 import type { ResourceTransferToPageForm } from '../entities';
 
 export interface ResourceTransferToPageService {
-  // 资源文件转移至页面附件目录
+  /**
+   * 资源文件转移至页面附件目录
+   */
   post(
     data: ResourceTransferToPageForm,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
+  ): Promise<unknown>;
 }

package/lib/platform/service/apis/role-permission.service.d.ts

@@ -2,40 +2,58 @@ import type { AxiosRequestConfig } from 'axios';
 import type { RolePermissionDTO, SingleRolePermission } from '../entities';
 
 export interface getPlatListQuery {
-  roleId: string; // 角色id
+  /**
+   * 角色id
+   */
+  roleId: string;
 }
 export interface getTenantListQuery {
-  roleId: string; // 角色id
+  /**
+   * 角色id
+   */
+  roleId: string;
 }
 export interface RolePermissionService {
-  // (平台管理后台)查询角色权限点
+  /**
+   * (平台管理后台)查询角色权限点
+   */
   getPlatList(
     query: getPlatListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<RolePermissionDTO>>;
-  // (平台管理后台)角色权限删除
+  ): Promise<RolePermissionDTO>;
+  /**
+   * (平台管理后台)角色权限删除
+   */
   postPlatRemove(
     data: SingleRolePermission,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // (平台管理后台)角色权限保存
+  ): Promise<string>;
+  /**
+   * (平台管理后台)角色权限保存
+   */
   postPlatSingle(
     data: SingleRolePermission,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // (租户管理后台)查询角色权限点
+  ): Promise<string>;
+  /**
+   * (租户管理后台)查询角色权限点
+   */
   getTenantList(
     query: getTenantListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<RolePermissionDTO>>;
-  // (租户管理后台)角色权限删除
+  ): Promise<RolePermissionDTO>;
+  /**
+   * (租户管理后台)角色权限删除
+   */
   postTenantRemove(
     data: SingleRolePermission,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // (租户管理后台)角色权限保存
+  ): Promise<string>;
+  /**
+   * (租户管理后台)角色权限保存
+   */
   postTenantSingle(
     data: SingleRolePermission,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/platform/service/apis/role.service.d.ts

@@ -2,80 +2,146 @@ import type { AxiosRequestConfig } from 'axios';
 import type { RoleResponse, RoleRequest } from '../entities';
 
 export interface deletePlatQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getPlatInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getPlatPageListQuery {
-  enabled?: number; // 状态(1:启用 ,0: 禁用 空查询全部)
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  roleName?: string; // 角色名称
+  /**
+   * 状态(1:启用 ,0: 禁用 空查询全部)
+   */
+  enabled?: number;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 角色名称
+   */
+  roleName?: string;
+}
+export interface putPlatIdEnabledPathParams {
+  id: string;
+  enabled: string;
 }
 export interface deleteTenantQuery {
-  ids: string; // 删除的id，多个按','分割
+  /**
+   * 删除的id，多个按','分割
+   */
+  ids: string;
 }
 export interface getTenantInfoQuery {
-  id: string; // id
+  /**
+   * id
+   */
+  id: string;
 }
 export interface getTenantPageListQuery {
-  enabled?: number; // 状态(1:启用 ,0: 禁用 空查询全部)
-  pageNo?: number; // 页码
-  pageSize?: number; // 每页数据条数
-  roleName?: string; // 角色名称
+  /**
+   * 状态(1:启用 ,0: 禁用 空查询全部)
+   */
+  enabled?: number;
+  /**
+   * 页码
+   */
+  pageNo?: number;
+  /**
+   * 每页数据条数
+   */
+  pageSize?: number;
+  /**
+   * 角色名称
+   */
+  roleName?: string;
+}
+export interface putTenantIdEnabledPathParams {
+  id: string;
+  enabled: string;
 }
 export interface RoleService {
-  // 列表
-  getList(
-    config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<RoleResponse[]>>;
-  // (平台管理) 新增编辑 角色
+  /**
+   * 列表
+   */
+  getList(config?: Partial<AxiosRequestConfig>): Promise<RoleResponse[]>;
+  /**
+   * (平台管理) 新增编辑 角色
+   */
   postPlat(
     data: RoleRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // (平台管理后台)角色删除
+  ): Promise<string>;
+  /**
+   * (平台管理后台)角色删除
+   */
   deletePlat(
     query: deletePlatQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // (平台管理)角色详情
+  ): Promise<string>;
+  /**
+   * (平台管理)角色详情
+   */
   getPlatInfo(
     query: getPlatInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<RoleResponse>>;
-  // (平台管理)角色条件查询分页列表
+  ): Promise<RoleResponse>;
+  /**
+   * (平台管理)角色条件查询分页列表
+   */
   getPlatPageList(
     query: getPlatPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<RoleResponse>>>;
-  // (平台管理后台)角色 启用禁用
+  ): Promise<IPage<RoleResponse>>;
+  /**
+   * (平台管理后台)角色 启用禁用
+   */
   putPlatIdEnabled(
+    path: putPlatIdEnabledPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // (租户管理后台)新增编辑 角色
+  ): Promise<string>;
+  /**
+   * (租户管理后台)新增编辑 角色
+   */
   postTenant(
     data: RoleRequest,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // (租户管理后台)角色删除
+  ): Promise<string>;
+  /**
+   * (租户管理后台)角色删除
+   */
   deleteTenant(
     query: deleteTenantQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
-  // (租户管理后台)角色详情
+  ): Promise<string>;
+  /**
+   * (租户管理后台)角色详情
+   */
   getTenantInfo(
     query: getTenantInfoQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<RoleResponse>>;
-  // (租户管理后台)角色条件查询分页列表
+  ): Promise<RoleResponse>;
+  /**
+   * (租户管理后台)角色条件查询分页列表
+   */
   getTenantPageList(
     query: getTenantPageListQuery,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<IPage<RoleResponse>>>;
-  // (租户管理后台)角色 启用禁用
+  ): Promise<IPage<RoleResponse>>;
+  /**
+   * (租户管理后台)角色 启用禁用
+   */
   putTenantIdEnabled(
+    path: putTenantIdEnabledPathParams,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<string>>;
+  ): Promise<string>;
 }

package/lib/platform/service/apis/saveCompInfo.service.d.ts

@@ -2,9 +2,11 @@ import type { AxiosRequestConfig } from 'axios';
 import type { 组件信息表实体类 } from '../entities';
 
 export interface SaveCompInfoService {
-  // 保存组件信息
+  /**
+   * 保存组件信息
+   */
   post(
     data: 组件信息表实体类,
     config?: Partial<AxiosRequestConfig>,
-  ): Promise<IHttpResponse<unknown>>;
+  ): Promise<unknown>;
 }