【新增】部署类型七牛云oss、七牛云cdn、百度cdn、腾讯waf、腾讯edgeone、阿里云waf

【新增】解析类型godaddy
【新增】自定义CA授权管理
【调整】优化部署流程,减少代码冗余,提升类型添加效率
This commit is contained in:
chudong
2025-05-23 16:58:34 +08:00
parent 71de397e11
commit e5634d4992
263 changed files with 18348 additions and 14253 deletions

View File

@@ -1,51 +1,131 @@
import { useApi } from './index'
// Type imports
import type { useAxiosReturn } from '@baota/hooks/axios'
import type {
AccessListParams,
AccessListResponse,
AddAccessParams,
UpdateAccessParams,
DeleteAccessParams,
GetAccessAllListParams,
GetAccessAllListResponse,
} from '../types/access'
import type { AxiosResponseData } from '../types/public'
UpdateAccessParams,
// CA授权相关类型
EabListParams,
EabListResponse,
EabAddParams,
EabUpdateParams,
EabDeleteParams,
EabGetAllListParams,
EabGetAllListResponse,
// 新增类型
TestAccessParams,
GetSitesParams,
GetSitesResponse,
} from '@/types/access' // Sorted types
import type { AxiosResponseData } from '@/types/public'
// Relative internal imports
import { useApi } from '@api/index'
/**
* @description 获取授权列表
* @param {AccessListParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AccessListResponse>>} 授权列表
* @returns {useAxiosReturn<AccessListResponse, AccessListParams>} 获取授权列表的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const getAccessList = (params?: AccessListParams) =>
export const getAccessList = (params?: AccessListParams): useAxiosReturn<AccessListResponse, AccessListParams> =>
useApi<AccessListResponse, AccessListParams>('/v1/access/get_list', params)
/**
* @description 新增授权
* @param {AddAccessParams<string>} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 新增结果
* @returns {useAxiosReturn<AxiosResponseData, AddAccessParams<string>>} 新增授权的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const addAccess = (params?: AddAccessParams<string>) =>
export const addAccess = (
params?: AddAccessParams<string>,
): useAxiosReturn<AxiosResponseData, AddAccessParams<string>> =>
useApi<AxiosResponseData, AddAccessParams<string>>('/v1/access/add_access', params)
/**
* @description 修改授权
* @param {UpdateAccessParams<string>} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 修改结果
* @returns {useAxiosReturn<AxiosResponseData, UpdateAccessParams<string>>} 修改授权的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const updateAccess = (params?: UpdateAccessParams<string>) =>
export const updateAccess = (
params?: UpdateAccessParams<string>,
): useAxiosReturn<AxiosResponseData, UpdateAccessParams<string>> =>
useApi<AxiosResponseData, UpdateAccessParams<string>>('/v1/access/upd_access', params)
/**
* @description 删除授权
* @param {DeleteAccessParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 删除结果
* @returns {useAxiosReturn<AxiosResponseData, DeleteAccessParams>} 删除授权的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const deleteAccess = (params?: DeleteAccessParams) =>
export const deleteAccess = (params?: DeleteAccessParams): useAxiosReturn<AxiosResponseData, DeleteAccessParams> =>
useApi<AxiosResponseData, DeleteAccessParams>('/v1/access/del_access', params)
/**
* @description 获取DNS提供商列表
* @param {GetAccessAllListParams} [params] 请求参数
* @returns {Promise<AxiosResponse<GetAccessAllListResponse>>} 工作流 dns 配置
* @returns {useAxiosReturn<GetAccessAllListResponse, GetAccessAllListParams>} 获取DNS提供商列表的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const getAccessAllList = (params?: GetAccessAllListParams) =>
export const getAccessAllList = (
params?: GetAccessAllListParams,
): useAxiosReturn<GetAccessAllListResponse, GetAccessAllListParams> =>
useApi<GetAccessAllListResponse, GetAccessAllListParams>('/v1/access/get_all', params)
/**
* @description 获取CA授权列表
* @param {EabListParams} [params] 请求参数
* @returns {useAxiosReturn<EabListResponse, EabListParams>} 获取CA授权列表的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const getEabList = (params?: EabListParams): useAxiosReturn<EabListResponse, EabListParams> =>
useApi<EabListResponse, EabListParams>('/v1/access/get_eab_list', params)
/**
* @description 添加CA授权
* @param {EabAddParams} [params] 请求参数
* @returns {useAxiosReturn<AxiosResponseData, EabAddParams>} 添加CA授权的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const addEab = (params?: EabAddParams): useAxiosReturn<AxiosResponseData, EabAddParams> =>
useApi<AxiosResponseData, EabAddParams>('/v1/access/add_eab', params)
/**
* @description 修改CA授权
* @param {EabUpdateParams} [params] 请求参数
* @returns {useAxiosReturn<AxiosResponseData, EabUpdateParams>} 修改CA授权的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const updateEab = (params?: EabUpdateParams): useAxiosReturn<AxiosResponseData, EabUpdateParams> =>
useApi<AxiosResponseData, EabUpdateParams>('/v1/access/upd_eab', params)
/**
* @description 删除CA授权
* @param {EabDeleteParams} [params] 请求参数
* @returns {useAxiosReturn<AxiosResponseData, EabDeleteParams>} 删除CA授权的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const deleteEab = (params?: EabDeleteParams): useAxiosReturn<AxiosResponseData, EabDeleteParams> =>
useApi<AxiosResponseData, EabDeleteParams>('/v1/access/del_eab', params)
/**
* @description 获取CA授权列表下拉框
* @param {EabGetAllListParams} [params] 请求参数
* @returns {useAxiosReturn<EabGetAllListResponse, EabGetAllListParams>} 获取CA授权列表下拉框的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const getAllEabList = (
params?: EabGetAllListParams,
): useAxiosReturn<EabGetAllListResponse, EabGetAllListParams> =>
useApi<EabGetAllListResponse, EabGetAllListParams>('/v1/access/get_all_eab', params)
/**
* @description 测试授权API
* @param {TestAccessParams} [params] 请求参数
* @returns {useAxiosReturn<AxiosResponseData, TestAccessParams>} 测试授权的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const testAccess = (params?: TestAccessParams): useAxiosReturn<AxiosResponseData, TestAccessParams> =>
useApi<AxiosResponseData, TestAccessParams>('/v1/access/test_access', params)
/**
* @description 获取网站列表
* @param {GetSitesParams} [params] 请求参数
* @returns {useAxiosReturn<GetSitesResponse, GetSitesParams>} 获取网站列表的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const getSites = (params?: GetSitesParams): useAxiosReturn<GetSitesResponse, GetSitesParams> =>
useApi<GetSitesResponse, GetSitesParams>('/v1/access/get_sites', params)

View File

@@ -1,56 +1,61 @@
import { useApi } from './index'
// External library dependencies
import axios, { AxiosResponse } from 'axios'
// Type imports
import type { useAxiosReturn } from '@baota/hooks/axios'
import type {
CertListParams,
CertListResponse,
ApplyCertParams,
ApplyCertResponse,
UploadCertParams,
UploadCertResponse,
CertListParams,
CertListResponse,
DeleteCertParams,
DeleteCertResponse,
DownloadCertParams,
} from '../types/cert'
import axios from 'axios'
DownloadCertResponse, // Ensuring this type is imported
UploadCertParams,
UploadCertResponse,
} from '@/types/cert' // Path alias and sorted types
// Relative internal imports
import { useApi } from '@api/index'
/**
* @description 获取证书列表
* @param {CertListParams} [params] 请求参数
* @returns {Promise<AxiosResponse<CertListResponse>>} 证书列表
* @returns {useAxiosReturn<CertListResponse, CertListParams>} 获取证书列表的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const getCertList = (params?: CertListParams) =>
export const getCertList = (params?: CertListParams): useAxiosReturn<CertListResponse, CertListParams> =>
useApi<CertListResponse, CertListParams>('/v1/cert/get_list', params)
/**
* @description 申请证书
* @param {ApplyCertParams} [params] 请求参数
* @returns {Promise<AxiosResponse<ApplyCertResponse>>} 申请结果
* @returns {useAxiosReturn<ApplyCertResponse, ApplyCertParams>} 申请证书的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const applyCert = (params?: ApplyCertParams) =>
export const applyCert = (params?: ApplyCertParams): useAxiosReturn<ApplyCertResponse, ApplyCertParams> =>
useApi<ApplyCertResponse, ApplyCertParams>('/v1/cert/apply_cert', params)
/**
* @description 上传证书
* @param {UploadCertParams} [params] 请求参数
* @returns {Promise<AxiosResponse<UploadCertResponse>>} 上传结果
* @returns {useAxiosReturn<UploadCertResponse, UploadCertParams>} 上传证书的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const uploadCert = (params?: UploadCertParams) =>
export const uploadCert = (params?: UploadCertParams): useAxiosReturn<UploadCertResponse, UploadCertParams> =>
useApi<UploadCertResponse, UploadCertParams>('/v1/cert/upload_cert', params)
/**
* @description 删除证书
* @param {DeleteCertParams} [params] 请求参数
* @returns {Promise<AxiosResponse<DeleteCertResponse>>} 删除结果
* @returns {useAxiosReturn<DeleteCertResponse, DeleteCertParams>} 删除证书的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const deleteCert = (params?: DeleteCertParams) =>
export const deleteCert = (params?: DeleteCertParams): useAxiosReturn<DeleteCertResponse, DeleteCertParams> =>
useApi<DeleteCertResponse, DeleteCertParams>('/v1/cert/del_cert', params)
/**
* @description 下载证书
* @param {DownloadCertParams} [params] 请求参数
* @returns {Promise<AxiosResponse<DownloadCertResponse>>} 下载结果
* @returns {Promise<AxiosResponse<DownloadCertResponse>>} 下载结果的 Promise 对象。
*/
export const downloadCert = (params?: DownloadCertParams) => {
return axios.get('/v1/cert/download', {
params,
})
export const downloadCert = (params?: DownloadCertParams): Promise<AxiosResponse<DownloadCertResponse>> => {
return axios.get<DownloadCertResponse>('/v1/cert/download', { params })
}

View File

@@ -1,16 +1,21 @@
import { AxiosError } from 'axios'
import MD5 from 'crypto-js/md5'
import { isDev } from '@baota/utils/browser'
// External Libraries (sorted alphabetically by module path)
import { HttpClient, useAxios, useAxiosReturn } from '@baota/hooks/axios'
import { errorMiddleware } from '@baota/hooks/axios/model'
import { isDev } from '@baota/utils/browser'
import { AxiosError } from 'axios'
import MD5 from 'crypto-js/md5'
// Type Imports (sorted alphabetically by module path)
import type { AxiosResponseData } from '@/types/public'
import type { Ref } from 'vue'
// Relative Internal Imports (sorted alphabetically by module path)
import { router } from '@router/index'
import type { AxiosResponseData } from '@/types/public'
/**
* @description 处理返回数据,如果状态码为 401
* @param {AxiosResponseData<T>} response 返回数据
* @returns {AxiosResponseData<T>} 返回数据
* @description 处理返回数据,如果状态码为 401 或 404
* @param {AxiosError} error 错误对象
* @returns {AxiosError} 错误对象
*/
export const responseHandleStatusCode = errorMiddleware((error: AxiosError) => {
// 处理 401 状态码
@@ -19,7 +24,7 @@ export const responseHandleStatusCode = errorMiddleware((error: AxiosError) => {
}
// 处理404状态码
if (error.status === 404) {
router.go(0) // 刷新页面
// router.go(0) // 刷新页面
}
return error
})
@@ -52,21 +57,28 @@ export const instance = new HttpClient({
})
/**
* @description 创建api token
* @returns {string} api token
* @description API Token 结构
*/
export const createApiToken = () => {
interface ApiTokenResult {
api_token: string
timestamp: number
}
/**
* @description 创建api token
* @returns {ApiTokenResult} 包含API token和时间戳的对象
*/
export const createApiToken = (): ApiTokenResult => {
const now = new Date().getTime()
const apiKey = '123456'
const apiKey = '123456' // 注意: 此处为硬编码密钥,建议后续优化
const api_token = MD5(now + MD5(apiKey).toString()).toString()
return { api_token, timestamp: now }
}
/**
/**
* @description 创建axios请求
* @param {string} url 请求地址
* @param {Z} params 请求参数
* @param {Z} [params] 请求参数
* @returns {useAxiosReturn<T, Z>} 返回结果
*/
export const useApi = <T, Z = Record<string, unknown>>(url: string, params?: Z) => {

View File

@@ -1,50 +1,60 @@
import { useApi } from './index'
import type { AxiosResponseData } from '@/types/public'
// Type imports
import type { useAxiosReturn } from '@baota/hooks/axios'
import type {
SiteMonitorListParams,
SiteMonitorListResponse,
AddSiteMonitorParams,
UpdateSiteMonitorParams,
DeleteSiteMonitorParams,
SetSiteMonitorParams,
} from '../types/monitor'
SiteMonitorListParams,
SiteMonitorListResponse,
UpdateSiteMonitorParams,
} from '@/types/monitor' // Sorted types
import type { AxiosResponseData } from '@/types/public'
// Relative internal imports
import { useApi } from '@api/index'
/**
* @description 获取站点监控列表
* @param {SiteMonitorListParams} [params] 请求参数
* @returns {Promise<AxiosResponse<SiteMonitorListResponse>>} 站点监控列表
* @returns {useAxiosReturn<SiteMonitorListResponse, SiteMonitorListParams>} 获取站点监控列表的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const getSiteMonitorList = (params?: SiteMonitorListParams) =>
export const getSiteMonitorList = (
params?: SiteMonitorListParams,
): useAxiosReturn<SiteMonitorListResponse, SiteMonitorListParams> =>
useApi<SiteMonitorListResponse, SiteMonitorListParams>('/v1/siteMonitor/get_list', params)
/**
* @description 新增站点监控
* @param {AddSiteMonitorParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 新增结果
* @returns {useAxiosReturn<AxiosResponseData, AddSiteMonitorParams>} 新增站点监控的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const addSiteMonitor = (params?: AddSiteMonitorParams) =>
export const addSiteMonitor = (params?: AddSiteMonitorParams): useAxiosReturn<AxiosResponseData, AddSiteMonitorParams> =>
useApi<AxiosResponseData, AddSiteMonitorParams>('/v1/siteMonitor/add_site_monitor', params)
/**
* @description 修改站点监控
* @param {UpdateSiteMonitorParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 修改结果
* @returns {useAxiosReturn<AxiosResponseData, UpdateSiteMonitorParams>} 修改站点监控的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const updateSiteMonitor = (params?: UpdateSiteMonitorParams) =>
export const updateSiteMonitor = (
params?: UpdateSiteMonitorParams,
): useAxiosReturn<AxiosResponseData, UpdateSiteMonitorParams> =>
useApi<AxiosResponseData, UpdateSiteMonitorParams>('/v1/siteMonitor/upd_site_monitor', params)
/**
* @description 删除站点监控
* @param {DeleteSiteMonitorParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 删除结果
* @returns {useAxiosReturn<AxiosResponseData, DeleteSiteMonitorParams>} 删除站点监控的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const deleteSiteMonitor = (params?: DeleteSiteMonitorParams) =>
export const deleteSiteMonitor = (
params?: DeleteSiteMonitorParams,
): useAxiosReturn<AxiosResponseData, DeleteSiteMonitorParams> =>
useApi<AxiosResponseData, DeleteSiteMonitorParams>('/v1/siteMonitor/del_site_monitor', params)
/**
* @description 启用/禁用站点监控
* @param {SetSiteMonitorParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 操作结果
* @returns {useAxiosReturn<AxiosResponseData, SetSiteMonitorParams>} 启用/禁用站点监控的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const setSiteMonitor = (params?: SetSiteMonitorParams) =>
export const setSiteMonitor = (params?: SetSiteMonitorParams): useAxiosReturn<AxiosResponseData, SetSiteMonitorParams> =>
useApi<AxiosResponseData, SetSiteMonitorParams>('/v1/siteMonitor/set_site_monitor', params)

View File

@@ -1,38 +1,47 @@
import axios from 'axios'
import { useApi } from './index'
// External library dependencies
import axios, { type AxiosResponse } from 'axios'
// Type imports
import type { useAxiosReturn } from '@baota/hooks/axios'
import type {
loginParams,
loginResponse,
AxiosResponseData,
GetOverviewsParams,
GetOverviewsResponse,
AxiosResponseData,
} from '@/types/public'
loginCodeResponse, // Added this type based on usage
loginParams,
loginResponse,
} from '@/types/public' // Sorted types
// Relative internal imports
import { useApi } from '@api/index'
/**
* @description 登录
* @param {loginParams} [params] 登录参数
* @returns {Promise<AxiosResponse<loginResponse>>} 登录结果
* @returns {useAxiosReturn<loginResponse, loginParams>} 登录操作的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const login = (params?: loginParams) => useApi<loginResponse, loginParams>('/v1/login/sign', params)
export const login = (params?: loginParams): useAxiosReturn<loginResponse, loginParams> =>
useApi<loginResponse, loginParams>('/v1/login/sign', params)
/**
* @description 获取登录验证码
* @returns {Promise<AxiosResponse<loginCodeResponse>>} 登录验证码
* @returns {Promise<AxiosResponse<loginCodeResponse>>} 获取登录验证码的 Promise 对象。
*/
export const getLoginCode = () => {
return axios.get('/v1/login/get_code')
export const getLoginCode = (): Promise<AxiosResponse<loginCodeResponse>> => {
return axios.get<loginCodeResponse>('/v1/login/get_code')
}
/**
* @description 登出
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 登出结果
* @returns {useAxiosReturn<AxiosResponseData, unknown>} 登出操作的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const signOut = () => useApi<AxiosResponseData>('/v1/login/sign-out')
export const signOut = (): useAxiosReturn<AxiosResponseData, unknown> =>
useApi<AxiosResponseData, unknown>('/v1/login/sign-out', {})
/**
* @description 获取首页概览
* @param {GetOverviewsParams} [params] 请求参数
* @returns {Promise<AxiosResponse<GetOverviewsResponse>>} 首页概览数据
* @returns {useAxiosReturn<GetOverviewsResponse, GetOverviewsParams>} 获取首页概览数据的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const getOverviews = (params?: GetOverviewsParams) =>
export const getOverviews = (params?: GetOverviewsParams): useAxiosReturn<GetOverviewsResponse, GetOverviewsParams> =>
useApi<GetOverviewsResponse, GetOverviewsParams>('/v1/overview/get_overviews', params)

View File

@@ -1,69 +1,73 @@
import { useApi } from './index'
import type { AxiosResponseData } from '../types/public'
// Type imports
import type { useAxiosReturn } from '@baota/hooks/axios'
import type { AxiosResponseData } from '@/types/public'
import type {
AddReportParams,
DeleteReportParams,
GetReportListParams,
GetReportListResponse,
GetSettingParams,
GetSettingResponse,
SaveSettingParams,
GetReportListParams,
GetReportListResponse,
AddReportParams,
UpdateReportParams,
DeleteReportParams,
TestReportParams,
} from '../types/setting'
UpdateReportParams,
} from '@/types/setting' // Sorted types
// Relative internal imports
import { useApi } from '@api/index'
/**
* @description 获取系统设置
* @param {GetSettingParams} [params] 请求参数
* @returns {Promise<AxiosResponse<GetSettingResponse>>} 系统设置
* @returns {useAxiosReturn<GetSettingResponse, GetSettingParams>} 获取系统设置的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const getSystemSetting = (params?: GetSettingParams) =>
export const getSystemSetting = (params?: GetSettingParams): useAxiosReturn<GetSettingResponse, GetSettingParams> =>
useApi<GetSettingResponse, GetSettingParams>('/v1/setting/get_setting', params)
/**
* @description 保存系统设置
* @param {SaveSettingParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 保存结果
* @returns {useAxiosReturn<AxiosResponseData, SaveSettingParams>} 保存系统设置的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const saveSystemSetting = (params?: SaveSettingParams) =>
export const saveSystemSetting = (params?: SaveSettingParams): useAxiosReturn<AxiosResponseData, SaveSettingParams> =>
useApi<AxiosResponseData, SaveSettingParams>('/v1/setting/save_setting', params)
/**
* @description 添加告警
* @param {AddReportParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 配置结果
* @returns {useAxiosReturn<AxiosResponseData, AddReportParams>} 添加告警的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const addReport = (params?: AddReportParams) =>
export const addReport = (params?: AddReportParams): useAxiosReturn<AxiosResponseData, AddReportParams> =>
useApi<AxiosResponseData, AddReportParams>('/v1/report/add_report', params)
/**
* @description 更新告警
* @param {UpdateReportParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 更新结果
* @returns {useAxiosReturn<AxiosResponseData, UpdateReportParams>} 更新告警的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const updateReport = (params?: UpdateReportParams) =>
export const updateReport = (params?: UpdateReportParams): useAxiosReturn<AxiosResponseData, UpdateReportParams> =>
useApi<AxiosResponseData, UpdateReportParams>('/v1/report/upd_report', params)
/**
* @description 删除告警
* @param {DeleteReportParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 删除结果
* @returns {useAxiosReturn<AxiosResponseData, DeleteReportParams>} 删除告警的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const deleteReport = (params?: DeleteReportParams) =>
export const deleteReport = (params?: DeleteReportParams): useAxiosReturn<AxiosResponseData, DeleteReportParams> =>
useApi<AxiosResponseData, DeleteReportParams>('/v1/report/del_report', params)
/**
* @description 测试告警
* @param {TestReportParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 测试结果
* @returns {useAxiosReturn<AxiosResponseData, TestReportParams>} 测试告警的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const testReport = (params?: TestReportParams) =>
export const testReport = (params?: TestReportParams): useAxiosReturn<AxiosResponseData, TestReportParams> =>
useApi<AxiosResponseData, TestReportParams>('/v1/report/notify_test', params)
/**
* @description 获取告警类型列表
* @param {GetReportListParams} [params] 请求参数
* @returns {Promise<AxiosResponse<GetReportListResponse>>} 告警类型列表
* @returns {useAxiosReturn<GetReportListResponse, GetReportListParams>} 获取告警类型列表的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const getReportList = (params?: GetReportListParams) =>
export const getReportList = (params?: GetReportListParams): useAxiosReturn<GetReportListResponse, GetReportListParams> =>
useApi<GetReportListResponse, GetReportListParams>('/v1/report/get_list', params)

View File

@@ -1,90 +1,97 @@
import { useApi } from './index'
// Type imports
import type { useAxiosReturn } from '@baota/hooks/axios'
import type { AxiosResponseData } from '@/types/public'
import type {
WorkflowListParams,
WorkflowListResponse,
AddWorkflowParams,
UpdateWorkflowParams,
DeleteWorkflowParams,
WorkflowHistoryParams,
WorkflowHistoryResponse,
EnableWorkflowParams,
ExecuteWorkflowParams,
UpdateWorkflowExecTypeParams,
EnableWorkflowParams,
UpdateWorkflowParams,
WorkflowHistoryDetailParams,
} from '../types/workflow'
import { AxiosResponseData } from '@/types/public'
WorkflowHistoryParams,
WorkflowHistoryResponse,
WorkflowListParams,
WorkflowListResponse,
} from '@/types/workflow' // Sorted types
// Relative internal imports
import { useApi } from '@api/index'
/**
* @description 获取工作流列表
* @param {WorkflowListParams} [params] 请求参数
* @returns {Promise<AxiosResponse<WorkflowListResponse>>} 工作流列表
* @returns {useAxiosReturn<WorkflowListResponse, WorkflowListParams>} 获取工作流列表的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const getWorkflowList = (params?: WorkflowListParams) =>
export const getWorkflowList = (params?: WorkflowListParams): useAxiosReturn<WorkflowListResponse, WorkflowListParams> =>
useApi<WorkflowListResponse, WorkflowListParams>('/v1/workflow/get_list', params)
/**
* @description 新增工作流
* @param {AddWorkflowParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 新增结果
* @returns {useAxiosReturn<AxiosResponseData, AddWorkflowParams>} 新增工作流的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const addWorkflow = (params?: AddWorkflowParams) =>
export const addWorkflow = (params?: AddWorkflowParams): useAxiosReturn<AxiosResponseData, AddWorkflowParams> =>
useApi<AxiosResponseData, AddWorkflowParams>('/v1/workflow/add_workflow', params)
/**
* @description 修改工作流
* @param {UpdateWorkflowParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 修改结果
* @returns {useAxiosReturn<AxiosResponseData, UpdateWorkflowParams>} 修改工作流的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const updateWorkflow = (params?: UpdateWorkflowParams) =>
export const updateWorkflow = (params?: UpdateWorkflowParams): useAxiosReturn<AxiosResponseData, UpdateWorkflowParams> =>
useApi<AxiosResponseData, UpdateWorkflowParams>('/v1/workflow/upd_workflow', params)
/**
* @description 删除工作流
* @param {DeleteWorkflowParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 删除结果
* @returns {useAxiosReturn<AxiosResponseData, DeleteWorkflowParams>} 删除工作流的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const deleteWorkflow = (params?: DeleteWorkflowParams) =>
export const deleteWorkflow = (params?: DeleteWorkflowParams): useAxiosReturn<AxiosResponseData, DeleteWorkflowParams> =>
useApi<AxiosResponseData, DeleteWorkflowParams>('/v1/workflow/del_workflow', params)
/**
* @description 获取工作流执行历史
* @param {WorkflowHistoryParams} [params] 请求参数
* @returns {Promise<AxiosResponse<WorkflowHistoryResponse>>} 工作流执行历史
* @returns {useAxiosReturn<WorkflowHistoryResponse, WorkflowHistoryParams>} 获取工作流执行历史的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const getWorkflowHistory = (params?: WorkflowHistoryParams) =>
export const getWorkflowHistory = (
params?: WorkflowHistoryParams,
): useAxiosReturn<WorkflowHistoryResponse, WorkflowHistoryParams> =>
useApi<WorkflowHistoryResponse, WorkflowHistoryParams>('/v1/workflow/get_workflow_history', params)
/**
* @description 获取工作流执行历史详情
* @param {WorkflowHistoryDetailParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 工作流执行历史详情
* @returns {useAxiosReturn<AxiosResponseData, WorkflowHistoryDetailParams>} 获取工作流执行历史详情的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const getWorkflowHistoryDetail = (params?: WorkflowHistoryDetailParams) =>
export const getWorkflowHistoryDetail = (
params?: WorkflowHistoryDetailParams,
): useAxiosReturn<AxiosResponseData, WorkflowHistoryDetailParams> =>
useApi<AxiosResponseData, WorkflowHistoryDetailParams>('/v1/workflow/get_exec_log', params)
/**
* @description 手动执行工作流
* @param {ExecuteWorkflowParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 执行结果
* @returns {useAxiosReturn<AxiosResponseData, ExecuteWorkflowParams>} 手动执行工作流的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const executeWorkflow = (params?: ExecuteWorkflowParams) =>
export const executeWorkflow = (params?: ExecuteWorkflowParams): useAxiosReturn<AxiosResponseData, ExecuteWorkflowParams> =>
useApi<AxiosResponseData, ExecuteWorkflowParams>('/v1/workflow/execute_workflow', params)
/**
* @description 修改工作流执行方式
* @param {UpdateWorkflowExecTypeParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 修改结果
* @returns {useAxiosReturn<AxiosResponseData, UpdateWorkflowExecTypeParams>} 修改工作流执行方式的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const updateWorkflowExecType = (params?: UpdateWorkflowExecTypeParams) =>
export const updateWorkflowExecType = (
params?: UpdateWorkflowExecTypeParams,
): useAxiosReturn<AxiosResponseData, UpdateWorkflowExecTypeParams> =>
useApi<AxiosResponseData, UpdateWorkflowExecTypeParams>('/v1/workflow/exec_type', params)
/**
* @description 启用工作流或禁用工作流
* @param {EnableWorkflowParams} [params] 请求参数
* @returns {Promise<AxiosResponse<AxiosResponseData>>} 启用或禁用结果
* @returns {useAxiosReturn<AxiosResponseData, EnableWorkflowParams>} 启用或禁用工作流的组合式 API 调用封装。包含响应数据、加载状态及执行函数。
*/
export const enableWorkflow = (params?: EnableWorkflowParams) =>
export const enableWorkflow = (params?: EnableWorkflowParams): useAxiosReturn<AxiosResponseData, EnableWorkflowParams> =>
useApi<AxiosResponseData, EnableWorkflowParams>('/v1/workflow/active', params)