@gct-paas/api 0.1.0-dev.2 → 0.1.0-dev.3

package/es/service/http.util.d.ts

@@ -0,0 +1,113 @@
+import type { AxiosInstance, AxiosRequestConfig } from 'axios';
+import type { 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>>;
+}

package/es/service/http.util.mjs

@@ -0,0 +1,155 @@
+import axios from "axios";
+import qs from "qs";
+import { ContentTypeEnum } from "./http.enum.mjs";
+import { deepMerge } from "../utils/index.mjs";
+const instance = axios.create();
+export class HttpUtil {
+  /**
+   * 挂载中间件
+   *
+   * @static
+   * @param {(_axios: AxiosInstance) => void} fn 中间件函数
+   */
+  static use(fn) {
+    fn(instance);
+  }
+  /**
+   * GET 请求方法
+   *
+   * @static
+   * @template T
+   * @param {string} url 请求地址
+   * @param {IObject} [data={}] 请求数据
+   * @param {IParams} [query={}] 查询参数
+   * @param {AxiosRequestConfig} [config={}] 请求配置
+   * @returns {Promise<IHttpResponse<T>>} 请求结果
+   */
+  static get(url, data = {}, query = {}, config = {}) {
+    return this.request(url, data, query, { ...config, method: "GET" });
+  }
+  /**
+   * POST 请求方法
+   *
+   * @static
+   * @template T
+   * @param {string} url 请求地址
+   * @param {IObject} [data={}] 请求数据
+   * @param {IParams} [query={}] 查询参数
+   * @param {AxiosRequestConfig} [config={}] 请求配置
+   * @returns {Promise<IHttpResponse<T>>} 请求结果
+   */
+  static post(url, data = {}, query = {}, config = {}) {
+    return this.request(url, data, query, { ...config, method: "POST" });
+  }
+  /**
+   * PUT 请求方法
+   *
+   * @static
+   * @template T
+   * @param {string} url 请求地址
+   * @param {IObject} [data={}] 请求数据
+   * @param {IParams} [query={}] 查询参数
+   * @param {AxiosRequestConfig} [config={}] 请求配置
+   * @returns {Promise<IHttpResponse<T>>} 请求结果
+   */
+  static put(url, data = {}, query = {}, config = {}) {
+    return this.request(url, data, query, { ...config, method: "PUT" });
+  }
+  /**
+   * DELETE 请求方法
+   *
+   * @static
+   * @template T
+   * @param {string} url 请求地址
+   * @param {IObject} [data={}] 请求数据
+   * @param {IParams} [query={}] 查询参数
+   * @param {AxiosRequestConfig} [config={}] 请求配置
+   * @returns {Promise<IHttpResponse<T>>} 请求结果
+   */
+  static delete(url, data = {}, query = {}, config = {}) {
+    return this.request(url, data, query, { ...config, method: "DELETE" });
+  }
+  /**
+   * OPTIONS 请求方法
+   *
+   * @static
+   * @template T
+   * @param {string} url 请求地址
+   * @param {IObject} [data={}] 请求数据
+   * @param {IParams} [query={}] 查询参数
+   * @param {AxiosRequestConfig} [config={}] 请求配置
+   * @returns {Promise<IHttpResponse<T>>} 请求结果
+   */
+  static options(url, data = {}, query = {}, config = {}) {
+    return this.request(url, data, query, { ...config, method: "OPTIONS" });
+  }
+  /**
+   * PATCH 请求方法
+   *
+   * @static
+   * @template T
+   * @param {string} url 请求地址
+   * @param {IObject} [data={}] 请求数据
+   * @param {IParams} [query={}] 查询参数
+   * @param {AxiosRequestConfig} [config={}] 请求配置
+   * @returns {Promise<IHttpResponse<T>>} 请求结果
+   */
+  static patch(url, data = {}, query = {}, config = {}) {
+    return this.request(url, data, query, { ...config, method: "PATCH" });
+  }
+  /**
+   * HEAD 请求方法
+   *
+   * @static
+   * @template T
+   * @param {string} url 请求地址
+   * @param {IObject} [data={}] 请求数据
+   * @param {IParams} [query={}] 查询参数
+   * @param {AxiosRequestConfig} [config={}] 请求配置
+   * @returns {Promise<IHttpResponse<T>>} 请求结果
+   */
+  static head(url, data = {}, query = {}, config = {}) {
+    return this.request(url, data, query, { ...config, method: "HEAD" });
+  }
+  /**
+   * 通用请求方法
+   *
+   * @static
+   * @template T
+   * @param {string} url 请求地址
+   * @param {(IObject | null)} data 请求数据
+   * @param {(IParams | null)} query 查询参数
+   * @param {AxiosRequestConfig} [config={}] 请求配置
+   * @returns {Promise<IHttpResponse<T>>} 请求结果
+   */
+  static async request(url, data, query, config = {}) {
+    if (query) {
+      const queryStr = qs.stringify(query, { arrayFormat: "brackets" });
+      if (queryStr) {
+        if (url.includes("?")) {
+          url += `&${queryStr}`;
+        } else {
+          url += `?${queryStr}`;
+        }
+      }
+    }
+    const res = await instance.request(
+      deepMerge(
+        {
+          url,
+          data: JSON.stringify(data ? data : {}),
+          params: query,
+          timeout: 2 * 60 * 1e3,
+          headers: {
+            "Content-Type": ContentTypeEnum.JSON
+          }
+        },
+        config
+      )
+    );
+    if (res.status >= 200 && res.status < 300) {
+      return res.data;
+    }
+    throw res;
+  }
+}

package/es/service/index.d.ts

@@ -0,0 +1,8 @@
+import type { ApiMap } from './api-service.interface';
+/**
+ * API 实例
+ */
+export declare const api: ApiMap;
+export { ResultEnum, RequestEnum, ContentTypeEnum, BizServiceEnum, } from './http.enum';
+export type { IHttpResponse, ApiConfigItem, ApiItem, ApiMap, } from './api-service.interface';
+export { HttpUtil } from './http.util';

package/es/service/index.mjs

@@ -0,0 +1,14 @@
+import { apiConfig as aPaasConfig } from "../apaas/index.mjs";
+import { apiConfig as platformConfig } from "../platform/index.mjs";
+import { ApiManage } from "./api-manage.mjs";
+export const api = {
+  apaas: new ApiManage("/gct-apaas/api", aPaasConfig),
+  platform: new ApiManage("/gct-platform/api", platformConfig)
+};
+export {
+  ResultEnum,
+  RequestEnum,
+  ContentTypeEnum,
+  BizServiceEnum
+} from "./http.enum.mjs";
+export { HttpUtil } from "./http.util.mjs";

package/es/types/index.d.ts

@@ -1,3 +1,5 @@
+export {};
+
 /* eslint-disable @typescript-eslint/no-explicit-any */
 declare global {
   /**

package/es/utils/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 递归合并两个对象
+ *
+ * @template T
+ * @template U
+ * @param {T} target 目标对象，合并后结果存放于此
+ * @param {U} source 要合并的源对象
+ * @returns {(T & U)} 合并后的对象
+ */
+export declare function deepMerge<T extends object | null | undefined, U extends object | null | undefined>(target: T, source: U): T & U;

package/es/utils/index.mjs

@@ -0,0 +1,14 @@
+import { cloneDeep, isEqual, mergeWith, unionWith } from "lodash-es";
+export function deepMerge(target, source) {
+  return mergeWith(cloneDeep(target), source, (objValue, srcValue) => {
+    if (typeof objValue === "object" && typeof srcValue === "object") {
+      return mergeWith(
+        cloneDeep(objValue),
+        srcValue,
+        (prevValue, nextValue) => {
+          return Array.isArray(prevValue) ? unionWith(prevValue, nextValue, isEqual) : void 0;
+        }
+      );
+    }
+  });
+}