@gct-paas/core 0.1.4-dev.1 → 0.1.4-dev.3

package/es/modules/api-service/api-service.d.ts

@@ -0,0 +1,96 @@
+import { ApiConfigItem, IHttpResponse } from './api-service.interface';
+/**
+ * 服务基类
+ * 提供基础的 HTTP 请求方法封装
+ *
+ * @export
+ * @class ApiService
+ */
+export declare class ApiService {
+    private url;
+    /**
+     * Creates an instance of ApiService.
+     * @author chitanda
+     * @date 2025-08-21 18:08:19
+     * @param {string} url 服务基础 URL
+     * @param {ApiConfigItem} config 当前实例的 api 配置
+     */
+    constructor(url: string, config: ApiConfigItem);
+    /**
+     * PUT 请求方法
+     *
+     * @protected
+     * @param {string} method 请求方法路径
+     * @param {(IObject | null)} data 请求数据
+     * @param {(IParams | null)} query 查询参数
+     * @param {IParams} config 请求配置
+     * @returns {Promise<IHttpResponse>} 请求结果
+     */
+    protected _put(method: string, data: IObject | null, query: IParams | null, config: IParams): Promise<IHttpResponse>;
+    /**
+     * GET 请求方法
+     *
+     * @protected
+     * @param {string} method 请求方法路径
+     * @param {(IObject | null)} data 请求数据
+     * @param {(IParams | null)} query 查询参数
+     * @param {IParams} config 请求配置
+     * @returns {Promise<IHttpResponse>} 请求结果
+     */
+    protected _get(method: string, data: IObject | null, query: IParams | null, config: IParams): Promise<IHttpResponse>;
+    /**
+     * DELETE 请求方法
+     *
+     * @protected
+     * @param {string} method 请求方法路径
+     * @param {(IObject | null)} data 请求数据
+     * @param {(IParams | null)} query 查询参数
+     * @param {IParams} config 请求配置
+     * @returns {Promise<IHttpResponse>} 请求结果
+     */
+    protected _delete(method: string, data: IObject | null, query: IParams | null, config: IParams): Promise<IHttpResponse>;
+    /**
+     * POST 请求方法
+     *
+     * @protected
+     * @param {string} method 请求方法路径
+     * @param {(IObject | null)} data 请求数据
+     * @param {(IParams | null)} query 查询参数
+     * @param {IParams} config 请求配置
+     * @returns {Promise<IHttpResponse>} 请求结果
+     */
+    protected _post(method: string, data: IObject | null, query: IParams | null, config: IParams): Promise<IHttpResponse>;
+    /**
+     * OPTIONS 请求方法
+     *
+     * @protected
+     * @param {string} method 请求方法路径
+     * @param {(IObject | null)} data 请求数据
+     * @param {(IParams | null)} query 查询参数
+     * @param {IParams} config 请求配置
+     * @returns {Promise<IHttpResponse>} 请求结果
+     */
+    protected _options(method: string, data: IObject | null, query: IParams | null, config: IParams): Promise<IHttpResponse>;
+    /**
+     * PATCH 请求方法
+     *
+     * @protected
+     * @param {string} method 请求方法路径
+     * @param {(IObject | null)} data 请求数据
+     * @param {(IParams | null)} query 查询参数
+     * @param {IParams} config 请求配置
+     * @returns {Promise<IHttpResponse>} 请求结果
+     */
+    protected _patch(method: string, data: IObject | null, query: IParams | null, config: IParams): Promise<IHttpResponse>;
+    /**
+     * HEAD 请求方法
+     *
+     * @protected
+     * @param {string} method 请求方法路径
+     * @param {(IObject | null)} data 请求数据
+     * @param {(IParams | null)} query 查询参数
+     * @param {IParams} config 请求配置
+     * @returns {Promise<IHttpResponse>} 请求结果
+     */
+    protected _head(method: string, data: IObject | null, query: IParams | null, config: IParams): Promise<IHttpResponse>;
+}

package/es/modules/api-service/api-service.interface.d.ts

@@ -0,0 +1,159 @@
+import { ApiManage as APaasApiManage } from '@gct-paas/api-apaas';
+import { ApiManage as PlatformApiManage } from '@gct-paas/api-platform';
+/**
+ * HTTP 响应接口
+ *
+ * @export
+ * @interface IHttpResponse
+ * @template T - 响应数据类型
+ */
+export interface IHttpResponse<T = any> {
+    /**
+     * 请求状态码
+     *
+     * @type {number}
+     */
+    code: number;
+    /**
+     * 响应数据
+     *
+     * @type {T}
+     */
+    data: T;
+    /**
+     * 是否请求成功
+     *
+     * @type {boolean}
+     */
+    ok: boolean;
+    /**
+     * 响应消息
+     *
+     * @type {string}
+     */
+    message: string;
+    /**
+     * 子状态码
+     *
+     * @type {number}
+     * @memberof IHttpResponse
+     */
+    subCode?: number;
+    /**
+     * 子状态消息
+     *
+     * @type {string}
+     * @memberof IHttpResponse
+     */
+    subMessage?: string;
+}
+/**
+ * API 接口项
+ *
+ * @author chitanda
+ * @date 2025-08-21 17:08:36
+ * @export
+ * @interface ApiItem
+ */
+export interface ApiItem {
+    /**
+     * 请求方式
+     *
+     * @author chitanda
+     * @date 2025-08-21 17:08:40
+     * @type {string}
+     */
+    mode: string;
+    /**
+     * 方法名称
+     *
+     * @author chitanda
+     * @date 2025-08-21 17:08:50
+     * @type {string}
+     */
+    method: string;
+    /**
+     * 请求路径
+     *
+     * @author chitanda
+     * @date 2025-08-21 17:08:57
+     * @type {string}
+     */
+    path: string;
+    /**
+     * 是否有查询参数
+     *
+     * @author chitanda
+     * @date 2025-08-21 19:08:35
+     * @type {boolean}
+     */
+    hasQuery: boolean;
+    /**
+     * 是否有请求体
+     *
+     * @author chitanda
+     * @date 2025-08-21 19:08:41
+     * @type {boolean}
+     */
+    hasData: boolean;
+}
+/**
+ * 接口配置项
+ *
+ * @author chitanda
+ * @date 2025-08-21 17:08:09
+ * @export
+ * @interface ApiConfigItem
+ */
+export interface ApiConfigItem {
+    /**
+     * 实体名称 camelCase 模式
+     *
+     * @author chitanda
+     * @date 2025-08-21 17:08:24
+     * @type {string}
+     */
+    name: string;
+    /**
+     * 实体名称
+     *
+     * @author chitanda
+     * @date 2025-08-21 19:08:57
+     * @type {string}
+     */
+    entityName: string;
+    /**
+     * 实体所有 api
+     *
+     * @author chitanda
+     * @date 2025-08-21 17:08:07
+     * @type {ApiItem[]}
+     */
+    apis: ApiItem[];
+}
+/**
+ * API 映射
+ *
+ * @author chitanda
+ * @date 2025-08-21 17:08:39
+ * @export
+ * @interface ApiMap
+ */
+export interface ApiMap {
+    /**
+     * APaas 平台 API 管理
+     *
+     * @author chitanda
+     * @date 2025-08-21 17:08:53
+     * @type {APaasApiManage}
+     */
+    apaas: APaasApiManage;
+    /**
+     * 平台 API 管理
+     *
+     * @author chitanda
+     * @date 2025-08-21 17:08:50
+     * @type {PlatformApiManage}
+     */
+    platform: PlatformApiManage;
+}

package/es/modules/api-service/api-service.interface.mjs

@@ -0,0 +1,4 @@
+import '../../node_modules/.pnpm/@gct-paas_api-apaas@0.0.2-dev.4/node_modules/@gct-paas/api-apaas/es/index.mjs';
+import '../../node_modules/.pnpm/@gct-paas_api-platform@0.0.2-dev.4/node_modules/@gct-paas/api-platform/es/index.mjs';
+
+"use strict";

package/es/modules/api-service/api-service.mjs

@@ -0,0 +1,173 @@
+import path from '../../_virtual/index2.mjs';
+import { HttpUtil } from './http.util.mjs';
+
+"use strict";
+class ApiService {
+  /**
+   * Creates an instance of ApiService.
+   * @author chitanda
+   * @date 2025-08-21 18:08:19
+   * @param {string} url 服务基础 URL
+   * @param {ApiConfigItem} config 当前实例的 api 配置
+   */
+  constructor(url, config) {
+    this.url = url;
+    return new Proxy(this, {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      get(api, property) {
+        if (!(property in api)) {
+          const cfg = config.apis.find((item) => item.method === property);
+          if (cfg) {
+            const modeFn = `_${cfg.mode}`;
+            if (cfg.hasData && cfg.hasQuery) {
+              api[property] = (data, query, config2) => {
+                return api[modeFn](cfg.path, query, data, config2);
+              };
+            } else if (cfg.hasData) {
+              api[property] = function(data, config2) {
+                return api[modeFn](cfg.path, data, void 0, config2);
+              };
+            } else if (cfg.hasQuery) {
+              api[property] = function(query, config2) {
+                return api[modeFn](cfg.path, void 0, query, config2);
+              };
+            } else {
+              api[property] = function(config2) {
+                return api[modeFn](cfg.path, void 0, void 0, config2);
+              };
+            }
+          }
+        }
+        return api[property];
+      }
+    });
+  }
+  /**
+   * PUT 请求方法
+   *
+   * @protected
+   * @param {string} method 请求方法路径
+   * @param {(IObject | null)} data 请求数据
+   * @param {(IParams | null)} query 查询参数
+   * @param {IParams} config 请求配置
+   * @returns {Promise<IHttpResponse>} 请求结果
+   */
+  _put(method, data, query, config) {
+    return HttpUtil.put(
+      query?.id ? path.join(this.url, method, query.id) : path.join(this.url, method),
+      data || {},
+      query || {},
+      config
+    );
+  }
+  /**
+   * GET 请求方法
+   *
+   * @protected
+   * @param {string} method 请求方法路径
+   * @param {(IObject | null)} data 请求数据
+   * @param {(IParams | null)} query 查询参数
+   * @param {IParams} config 请求配置
+   * @returns {Promise<IHttpResponse>} 请求结果
+   */
+  _get(method, data, query, config) {
+    return HttpUtil.get(
+      path.join(this.url, method),
+      data || {},
+      query || {},
+      config
+    );
+  }
+  /**
+   * DELETE 请求方法
+   *
+   * @protected
+   * @param {string} method 请求方法路径
+   * @param {(IObject | null)} data 请求数据
+   * @param {(IParams | null)} query 查询参数
+   * @param {IParams} config 请求配置
+   * @returns {Promise<IHttpResponse>} 请求结果
+   */
+  _delete(method, data, query, config) {
+    return HttpUtil.delete(
+      path.join(this.url, method),
+      data || {},
+      query || {},
+      config
+    );
+  }
+  /**
+   * POST 请求方法
+   *
+   * @protected
+   * @param {string} method 请求方法路径
+   * @param {(IObject | null)} data 请求数据
+   * @param {(IParams | null)} query 查询参数
+   * @param {IParams} config 请求配置
+   * @returns {Promise<IHttpResponse>} 请求结果
+   */
+  _post(method, data, query, config) {
+    return HttpUtil.post(
+      path.join(this.url, method),
+      data || {},
+      query || {},
+      config
+    );
+  }
+  /**
+   * OPTIONS 请求方法
+   *
+   * @protected
+   * @param {string} method 请求方法路径
+   * @param {(IObject | null)} data 请求数据
+   * @param {(IParams | null)} query 查询参数
+   * @param {IParams} config 请求配置
+   * @returns {Promise<IHttpResponse>} 请求结果
+   */
+  _options(method, data, query, config) {
+    return HttpUtil.options(
+      path.join(this.url, method),
+      data || {},
+      query || {},
+      config
+    );
+  }
+  /**
+   * PATCH 请求方法
+   *
+   * @protected
+   * @param {string} method 请求方法路径
+   * @param {(IObject | null)} data 请求数据
+   * @param {(IParams | null)} query 查询参数
+   * @param {IParams} config 请求配置
+   * @returns {Promise<IHttpResponse>} 请求结果
+   */
+  _patch(method, data, query, config) {
+    return HttpUtil.patch(
+      path.join(this.url, method),
+      data || {},
+      query || {},
+      config
+    );
+  }
+  /**
+   * HEAD 请求方法
+   *
+   * @protected
+   * @param {string} method 请求方法路径
+   * @param {(IObject | null)} data 请求数据
+   * @param {(IParams | null)} query 查询参数
+   * @param {IParams} config 请求配置
+   * @returns {Promise<IHttpResponse>} 请求结果
+   */
+  _head(method, data, query, config) {
+    return HttpUtil.head(
+      path.join(this.url, method),
+      data || {},
+      query || {},
+      config
+    );
+  }
+}
+
+export { ApiService };

package/es/modules/api-service/http.enum.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 请求结果枚举
+ *
+ * @description: Request result set
+ */
+export declare enum ResultEnum {
+    SUCCESS = 200,
+    ERROR = -1,
+    TIMEOUT = 401,
+    TYPE = "success"
+}
+/**
+ * 请求方法枚举
+ *
+ * @description: request method
+ */
+export declare enum RequestEnum {
+    GET = "GET",
+    POST = "POST",
+    PUT = "PUT",
+    DELETE = "DELETE"
+}
+/**
+ * 内容类型枚举
+ *
+ * @description: contentType
+ */
+export declare enum ContentTypeEnum {
+    JSON = "application/json;charset=UTF-8",
+    FORM_URLENCODED = "application/x-www-form-urlencoded;charset=UTF-8",
+    FORM_DATA = "multipart/form-data;charset=UTF-8"
+}
+/**
+ * 业务服务枚举
+ *
+ * @description: Business service enum
+ */
+export declare enum BizServiceEnum {
+    submit = "post",
+    listByIds = "get",
+    getone = "post",
+    listAll = "post",
+    listByPage = "post",
+    listTree = "post",
+    save = "post",
+    saveOrUpdate = "post",
+    saveBatch = "post",
+    importData = "post",
+    exportData = "post",
+    remove = "post",
+    removeById = "delete",
+    removeByIds = "delete",
+    update = "put",
+    updateById = "put",
+    updateByIds = "put",
+    rdoSave = "post",
+    rdoListAll = "post",
+    rdoListByPage = "post",
+    rdoListVersionById = "get",
+    rdoSaveVersion = "post",
+    rdoSaveBatch = "post",
+    rdoUpdateVersionById = "put",
+    rdoRemoveVersionById = "delete",
+    rdoRemoveById = "delete",
+    rdoGetVersionById = "get",
+    getOne = "post",
+    rdoGetVersionByRefId = "post",
+    getById = "get",
+    rdoListAllVersion = "post",
+    rdoRefListByPage = "post",
+    export = "post",
+    import = "post",
+    rdoExport = "post",
+    rdoImport = "post",
+    biz_search = "post"
+}

package/es/modules/api-service/http.util.d.ts

@@ -0,0 +1,113 @@
+import { AxiosInstance, AxiosRequestConfig } from 'axios';
+import { IHttpResponse } from './api-service.interface';
+/**
+ * 全局请求工具类
+ *
+ * @export
+ * @class HttpUtil
+ */
+export declare class HttpUtil {
+    /**
+     * 挂载中间件
+     *
+     * @static
+     * @param {(_axios: AxiosInstance) => void} fn 中间件函数
+     */
+    static use(fn: (_axios: AxiosInstance) => void): void;
+    /**
+     * GET 请求方法
+     *
+     * @static
+     * @template T
+     * @param {string} url 请求地址
+     * @param {IObject} [data={}] 请求数据
+     * @param {IParams} [query={}] 查询参数
+     * @param {AxiosRequestConfig} [config={}] 请求配置
+     * @returns {Promise<IHttpResponse<T>>} 请求结果
+     */
+    static get<T = unknown>(url: string, data?: IObject, query?: IParams, config?: AxiosRequestConfig): Promise<IHttpResponse<T>>;
+    /**
+     * POST 请求方法
+     *
+     * @static
+     * @template T
+     * @param {string} url 请求地址
+     * @param {IObject} [data={}] 请求数据
+     * @param {IParams} [query={}] 查询参数
+     * @param {AxiosRequestConfig} [config={}] 请求配置
+     * @returns {Promise<IHttpResponse<T>>} 请求结果
+     */
+    static post<T = unknown>(url: string, data?: IObject, query?: IParams, config?: AxiosRequestConfig): Promise<IHttpResponse<T>>;
+    /**
+     * PUT 请求方法
+     *
+     * @static
+     * @template T
+     * @param {string} url 请求地址
+     * @param {IObject} [data={}] 请求数据
+     * @param {IParams} [query={}] 查询参数
+     * @param {AxiosRequestConfig} [config={}] 请求配置
+     * @returns {Promise<IHttpResponse<T>>} 请求结果
+     */
+    static put<T = unknown>(url: string, data?: IObject, query?: IParams, config?: AxiosRequestConfig): Promise<IHttpResponse<T>>;
+    /**
+     * DELETE 请求方法
+     *
+     * @static
+     * @template T
+     * @param {string} url 请求地址
+     * @param {IObject} [data={}] 请求数据
+     * @param {IParams} [query={}] 查询参数
+     * @param {AxiosRequestConfig} [config={}] 请求配置
+     * @returns {Promise<IHttpResponse<T>>} 请求结果
+     */
+    static delete<T = unknown>(url: string, data?: IObject, query?: IParams, config?: AxiosRequestConfig): Promise<IHttpResponse<T>>;
+    /**
+     * OPTIONS 请求方法
+     *
+     * @static
+     * @template T
+     * @param {string} url 请求地址
+     * @param {IObject} [data={}] 请求数据
+     * @param {IParams} [query={}] 查询参数
+     * @param {AxiosRequestConfig} [config={}] 请求配置
+     * @returns {Promise<IHttpResponse<T>>} 请求结果
+     */
+    static options<T = unknown>(url: string, data?: IObject, query?: IParams, config?: AxiosRequestConfig): Promise<IHttpResponse<T>>;
+    /**
+     * PATCH 请求方法
+     *
+     * @static
+     * @template T
+     * @param {string} url 请求地址
+     * @param {IObject} [data={}] 请求数据
+     * @param {IParams} [query={}] 查询参数
+     * @param {AxiosRequestConfig} [config={}] 请求配置
+     * @returns {Promise<IHttpResponse<T>>} 请求结果
+     */
+    static patch<T = unknown>(url: string, data?: IObject, query?: IParams, config?: AxiosRequestConfig): Promise<IHttpResponse<T>>;
+    /**
+     * HEAD 请求方法
+     *
+     * @static
+     * @template T
+     * @param {string} url 请求地址
+     * @param {IObject} [data={}] 请求数据
+     * @param {IParams} [query={}] 查询参数
+     * @param {AxiosRequestConfig} [config={}] 请求配置
+     * @returns {Promise<IHttpResponse<T>>} 请求结果
+     */
+    static head<T = unknown>(url: string, data?: IObject, query?: IParams, config?: AxiosRequestConfig): Promise<IHttpResponse<T>>;
+    /**
+     * 通用请求方法
+     *
+     * @static
+     * @template T
+     * @param {string} url 请求地址
+     * @param {(IObject | null)} data 请求数据
+     * @param {(IParams | null)} query 查询参数
+     * @param {AxiosRequestConfig} [config={}] 请求配置
+     * @returns {Promise<IHttpResponse<T>>} 请求结果
+     */
+    static request<T = unknown>(url: string, data: IObject | null, query: IParams | null, config?: AxiosRequestConfig): Promise<IHttpResponse<T>>;
+}