@gopowerteam/request 0.1.0

package/dist/index.cjs

@@ -0,0 +1,210 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  AxiosAdapter: () => AxiosAdapter,
+  PluginLifecycle: () => PluginLifecycle,
+  RequestMethod: () => RequestMethod,
+  RequestService: () => RequestService,
+  setup: () => setup
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/adapters/axios.adapter.ts
+var import_axios = __toESM(require("axios"), 1);
+var _AxiosAdapter = class {
+  getAxiosInstance() {
+    if (!_AxiosAdapter.axiosInstance) {
+      _AxiosAdapter.axiosInstance = import_axios.default.create({
+        timeout: RequestService.config.timeout,
+        headers: {
+          "Content-Type": "application/json"
+        }
+      });
+    }
+    return _AxiosAdapter.axiosInstance;
+  }
+  request({
+    baseURL,
+    pathURL,
+    headers,
+    method,
+    paramsQuery,
+    paramsBody
+  }) {
+    const axiosInstance = this.getAxiosInstance();
+    return axiosInstance.request({
+      method,
+      baseURL,
+      headers,
+      params: paramsQuery,
+      data: paramsBody,
+      url: pathURL
+    });
+  }
+  transformResponse(response) {
+    return {
+      data: response.data,
+      statusText: response.statusText,
+      status: response.status,
+      headers: response.headers
+    };
+  }
+};
+var AxiosAdapter = _AxiosAdapter;
+__publicField(AxiosAdapter, "axiosInstance");
+
+// src/interfaces/request-plugin.interface.ts
+var PluginLifecycle = /* @__PURE__ */ ((PluginLifecycle2) => {
+  PluginLifecycle2["before"] = "before";
+  PluginLifecycle2["after"] = "after";
+  PluginLifecycle2["catch"] = "catch";
+  return PluginLifecycle2;
+})(PluginLifecycle || {});
+
+// src/request-service.ts
+var _RequestService = class {
+  static getInstance() {
+    if (this.instance) {
+      return this.instance;
+    }
+    return new _RequestService();
+  }
+  getRequestAdapter() {
+    if (typeof _RequestService.config.adapter === "string") {
+      switch (_RequestService.config.adapter) {
+        case "axios":
+          return new AxiosAdapter();
+      }
+    }
+    if (!_RequestService.config.adapter) {
+      throw new Error("\u8BF7\u68C0\u67E5\u662F\u5426\u914D\u7F6E\u8BF7\u6C42Adatper");
+    }
+    return _RequestService.config.adapter;
+  }
+  execRequestPlugin(plugins = [], options) {
+    _RequestService.config.plugins.forEach(
+      (service) => service.before && service.before(options)
+    );
+    plugins.forEach((service) => service.before && service.before(options));
+  }
+  execResponsePlugin(leftcycle, plugins = [], options, response) {
+    plugins.forEach(
+      (plugin) => plugin[leftcycle] && plugin[leftcycle](response, options)
+    );
+    _RequestService.config.plugins.forEach(
+      (plugin) => plugin[leftcycle] && plugin[leftcycle](response, options)
+    );
+  }
+  parseRequestPath(path, paramsPath) {
+    if (paramsPath) {
+      return Object.entries(paramsPath).reduce(
+        (r, [key, value]) => r.replace(`{${key}}`, value.toString()),
+        path
+      );
+    } else {
+      return path;
+    }
+  }
+  startRequest(adapter, options) {
+    return adapter.request({
+      baseURL: _RequestService.config.gateway,
+      pathURL: this.parseRequestPath(options.path, options.paramsPath),
+      method: options.method,
+      headers: options.headers || {},
+      paramsQuery: options.paramsQuery,
+      paramsBody: options.paramsBody
+    });
+  }
+  execInterceptors(response, hasException = false) {
+    var _a;
+    const interceptors = (_a = _RequestService.config) == null ? void 0 : _a.interceptors;
+    if (!(interceptors == null ? void 0 : interceptors.status) || !(interceptors == null ? void 0 : interceptors.error) || !(interceptors == null ? void 0 : interceptors.success) || !(interceptors == null ? void 0 : interceptors.exception)) {
+      throw new Error("\u8BF7\u68C0\u67E5\u62E6\u622A\u5668\u914D\u7F6E");
+    }
+    const status = interceptors.status.exec(response) && !hasException;
+    if (hasException) {
+      interceptors.exception.exec(response);
+    }
+    if (status) {
+      return Promise.resolve(interceptors.success.exec(response));
+    } else {
+      return Promise.reject(interceptors.error.exec(response));
+    }
+  }
+  async send(options, plugins = []) {
+    if (!_RequestService.config) {
+      throw new Error("\u8BF7\u68C0\u67E5\u8BF7\u6C42\u914D\u7F6E\u662F\u5426\u5B8C\u6210");
+    }
+    let hasException = false;
+    const adapter = this.getRequestAdapter();
+    this.execRequestPlugin(plugins, options);
+    const response = await this.startRequest(adapter, options).catch((...response2) => {
+      hasException = true;
+      return response2;
+    }).then((response2) => adapter.transformResponse(response2));
+    if (!hasException) {
+      this.execResponsePlugin("after" /* after */, plugins, options, response);
+    } else {
+      this.execResponsePlugin("catch" /* catch */, plugins, options, response);
+    }
+    return this.execInterceptors(response, hasException);
+  }
+};
+var RequestService = _RequestService;
+__publicField(RequestService, "config");
+__publicField(RequestService, "instance");
+
+// src/request-setup.ts
+function setup(config) {
+  RequestService.config = config;
+}
+
+// src/interfaces/request-send.interface.ts
+var RequestMethod = /* @__PURE__ */ ((RequestMethod2) => {
+  RequestMethod2["Get"] = "GET";
+  RequestMethod2["Post"] = "POST";
+  RequestMethod2["Put"] = "PUT";
+  RequestMethod2["Delete"] = "DELETE";
+  RequestMethod2["Options"] = "OPTIONS";
+  RequestMethod2["Head"] = "HEAD";
+  RequestMethod2["Patch"] = "PATCH";
+  return RequestMethod2;
+})(RequestMethod || {});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AxiosAdapter,
+  PluginLifecycle,
+  RequestMethod,
+  RequestService,
+  setup
+});

package/dist/index.d.ts

@@ -0,0 +1,161 @@
+import { IStringifyOptions } from 'qs';
+import * as axios from 'axios';
+
+/**
+ * 请求方法类型
+ */
+declare enum RequestMethod {
+    Get = "GET",
+    Post = "POST",
+    Put = "PUT",
+    Delete = "DELETE",
+    Options = "OPTIONS",
+    Head = "HEAD",
+    Patch = "PATCH"
+}
+interface RequestSendOptions {
+    path: string;
+    method: RequestMethod | string;
+    headers?: Record<string, string>;
+    paramsPath?: Record<string, string | number>;
+    paramsQuery?: Record<string, any>;
+    paramsBody?: any;
+}
+
+interface RequestAdapter {
+    /**
+     * 发送请求
+     */
+    request(options: RequestAdapterOptions): Promise<any>;
+    /**
+     * 转换Response
+     * @param any
+     */
+    transformResponse(response: any): AdapterResponse;
+}
+interface RequestAdapterOptions {
+    baseURL: string;
+    pathURL: string;
+    headers: Record<string, string>;
+    method: RequestMethod | string;
+    paramsQuery?: Record<string, any>;
+    paramsBody?: any;
+}
+interface AdapterResponse {
+    data: Record<string, any>;
+    status: number;
+    statusText: string;
+    headers: Record<string, string>;
+}
+
+/**
+ * 请求插件
+ */
+interface RequestPlugin {
+    before: (options: RequestSendOptions) => void;
+    after: (response: AdapterResponse, options: RequestSendOptions) => void;
+    catch: (response: AdapterResponse, options: RequestSendOptions) => void;
+}
+declare enum PluginLifecycle {
+    before = "before",
+    after = "after",
+    catch = "catch"
+}
+declare type RequestLifecycle = PluginLifecycle.before;
+declare type ResponseLifecycle = PluginLifecycle.after | PluginLifecycle.catch;
+
+interface ResponseInterceptor {
+    exec(response: AdapterResponse): any;
+}
+
+/**
+ * 内部支持适配器
+ */
+declare type InternalAdapter = 'axios';
+interface RequestSetupConfig {
+    gateway: string;
+    timeout?: number;
+    qs?: IStringifyOptions;
+    adapter?: InternalAdapter | RequestAdapter;
+    interceptors: {
+        status: ResponseInterceptor;
+        success: ResponseInterceptor;
+        error: ResponseInterceptor;
+        exception: ResponseInterceptor;
+    };
+    plugins: RequestPlugin[];
+}
+
+declare class RequestService {
+    static config: RequestSetupConfig;
+    static instance: RequestService;
+    /**
+     * 获取服务请求单例
+     */
+    static getInstance(): RequestService;
+    /**
+     * 获取RequestAdatper
+     * @returns
+     */
+    private getRequestAdapter;
+    /**
+     * 执行前置插件逻辑
+     * @param plugins
+     * @param options
+     */
+    private execRequestPlugin;
+    /**
+     * 执行前置插件逻辑
+     * @param plugins
+     * @param options
+     */
+    private execResponsePlugin;
+    /**
+     * 转换请求路径
+     */
+    private parseRequestPath;
+    /**
+     * 开始请求
+     * @param adapter
+     * @param options
+     * @returns
+     */
+    private startRequest;
+    /**
+     * 执行拦截器
+     * @param response 请求响应对象
+     * @returns
+     */
+    private execInterceptors;
+    /**
+     * 发送请求
+     * @param {RequestSendOptions} options 请求选项
+     * @param {RequestPlugin[]} plugins 请求插件
+     * @returns
+     */
+    send(options: RequestSendOptions, plugins?: RequestPlugin[]): Promise<any>;
+}
+
+declare function setup(config: RequestSetupConfig): void;
+
+declare class AxiosAdapter implements RequestAdapter {
+    private static axiosInstance;
+    /**
+     * 获取Axios实例
+     */
+    private getAxiosInstance;
+    /**
+     * 发送请求
+     * @param options 请求参数
+     * @returns AxiosResponse
+     */
+    request({ baseURL, pathURL, headers, method, paramsQuery, paramsBody }: RequestAdapterOptions): Promise<axios.AxiosResponse<any, any>>;
+    /**
+     * 转换Response
+     * @param response
+     * @returns
+     */
+    transformResponse(response: any): AdapterResponse;
+}
+
+export { AdapterResponse, AxiosAdapter, PluginLifecycle, RequestAdapter, RequestAdapterOptions, RequestLifecycle, RequestMethod, RequestPlugin, RequestSendOptions, RequestService, RequestSetupConfig, ResponseInterceptor, ResponseLifecycle, setup };

package/dist/index.js

@@ -0,0 +1,175 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+
+// src/adapters/axios.adapter.ts
+import axios from "axios";
+var _AxiosAdapter = class {
+  getAxiosInstance() {
+    if (!_AxiosAdapter.axiosInstance) {
+      _AxiosAdapter.axiosInstance = axios.create({
+        timeout: RequestService.config.timeout,
+        headers: {
+          "Content-Type": "application/json"
+        }
+      });
+    }
+    return _AxiosAdapter.axiosInstance;
+  }
+  request({
+    baseURL,
+    pathURL,
+    headers,
+    method,
+    paramsQuery,
+    paramsBody
+  }) {
+    const axiosInstance = this.getAxiosInstance();
+    return axiosInstance.request({
+      method,
+      baseURL,
+      headers,
+      params: paramsQuery,
+      data: paramsBody,
+      url: pathURL
+    });
+  }
+  transformResponse(response) {
+    return {
+      data: response.data,
+      statusText: response.statusText,
+      status: response.status,
+      headers: response.headers
+    };
+  }
+};
+var AxiosAdapter = _AxiosAdapter;
+__publicField(AxiosAdapter, "axiosInstance");
+
+// src/interfaces/request-plugin.interface.ts
+var PluginLifecycle = /* @__PURE__ */ ((PluginLifecycle2) => {
+  PluginLifecycle2["before"] = "before";
+  PluginLifecycle2["after"] = "after";
+  PluginLifecycle2["catch"] = "catch";
+  return PluginLifecycle2;
+})(PluginLifecycle || {});
+
+// src/request-service.ts
+var _RequestService = class {
+  static getInstance() {
+    if (this.instance) {
+      return this.instance;
+    }
+    return new _RequestService();
+  }
+  getRequestAdapter() {
+    if (typeof _RequestService.config.adapter === "string") {
+      switch (_RequestService.config.adapter) {
+        case "axios":
+          return new AxiosAdapter();
+      }
+    }
+    if (!_RequestService.config.adapter) {
+      throw new Error("\u8BF7\u68C0\u67E5\u662F\u5426\u914D\u7F6E\u8BF7\u6C42Adatper");
+    }
+    return _RequestService.config.adapter;
+  }
+  execRequestPlugin(plugins = [], options) {
+    _RequestService.config.plugins.forEach(
+      (service) => service.before && service.before(options)
+    );
+    plugins.forEach((service) => service.before && service.before(options));
+  }
+  execResponsePlugin(leftcycle, plugins = [], options, response) {
+    plugins.forEach(
+      (plugin) => plugin[leftcycle] && plugin[leftcycle](response, options)
+    );
+    _RequestService.config.plugins.forEach(
+      (plugin) => plugin[leftcycle] && plugin[leftcycle](response, options)
+    );
+  }
+  parseRequestPath(path, paramsPath) {
+    if (paramsPath) {
+      return Object.entries(paramsPath).reduce(
+        (r, [key, value]) => r.replace(`{${key}}`, value.toString()),
+        path
+      );
+    } else {
+      return path;
+    }
+  }
+  startRequest(adapter, options) {
+    return adapter.request({
+      baseURL: _RequestService.config.gateway,
+      pathURL: this.parseRequestPath(options.path, options.paramsPath),
+      method: options.method,
+      headers: options.headers || {},
+      paramsQuery: options.paramsQuery,
+      paramsBody: options.paramsBody
+    });
+  }
+  execInterceptors(response, hasException = false) {
+    var _a;
+    const interceptors = (_a = _RequestService.config) == null ? void 0 : _a.interceptors;
+    if (!(interceptors == null ? void 0 : interceptors.status) || !(interceptors == null ? void 0 : interceptors.error) || !(interceptors == null ? void 0 : interceptors.success) || !(interceptors == null ? void 0 : interceptors.exception)) {
+      throw new Error("\u8BF7\u68C0\u67E5\u62E6\u622A\u5668\u914D\u7F6E");
+    }
+    const status = interceptors.status.exec(response) && !hasException;
+    if (hasException) {
+      interceptors.exception.exec(response);
+    }
+    if (status) {
+      return Promise.resolve(interceptors.success.exec(response));
+    } else {
+      return Promise.reject(interceptors.error.exec(response));
+    }
+  }
+  async send(options, plugins = []) {
+    if (!_RequestService.config) {
+      throw new Error("\u8BF7\u68C0\u67E5\u8BF7\u6C42\u914D\u7F6E\u662F\u5426\u5B8C\u6210");
+    }
+    let hasException = false;
+    const adapter = this.getRequestAdapter();
+    this.execRequestPlugin(plugins, options);
+    const response = await this.startRequest(adapter, options).catch((...response2) => {
+      hasException = true;
+      return response2;
+    }).then((response2) => adapter.transformResponse(response2));
+    if (!hasException) {
+      this.execResponsePlugin("after" /* after */, plugins, options, response);
+    } else {
+      this.execResponsePlugin("catch" /* catch */, plugins, options, response);
+    }
+    return this.execInterceptors(response, hasException);
+  }
+};
+var RequestService = _RequestService;
+__publicField(RequestService, "config");
+__publicField(RequestService, "instance");
+
+// src/request-setup.ts
+function setup(config) {
+  RequestService.config = config;
+}
+
+// src/interfaces/request-send.interface.ts
+var RequestMethod = /* @__PURE__ */ ((RequestMethod2) => {
+  RequestMethod2["Get"] = "GET";
+  RequestMethod2["Post"] = "POST";
+  RequestMethod2["Put"] = "PUT";
+  RequestMethod2["Delete"] = "DELETE";
+  RequestMethod2["Options"] = "OPTIONS";
+  RequestMethod2["Head"] = "HEAD";
+  RequestMethod2["Patch"] = "PATCH";
+  return RequestMethod2;
+})(RequestMethod || {});
+export {
+  AxiosAdapter,
+  PluginLifecycle,
+  RequestMethod,
+  RequestService,
+  setup
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@gopowerteam/request",
+  "private": false,
+  "version": "0.1.0",
+  "type": "module",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "gopowerteam",
+    "request"
+  ],
+  "scripts": {
+    "test": "jest --coverage",
+    "build": "tsup"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "devDependencies": {
+    "@types/axios": "^0.14.0",
+    "@types/jest": "^29.1.2",
+    "@types/node": "16",
+    "@types/qs": "^6.9.7",
+    "jest": "^29.1.2",
+    "ts-jest": "^29.0.3",
+    "ts-node": "^10.9.1",
+    "tsup": "^6.2.3",
+    "typescript": "^4.8.4"
+  },
+  "dependencies": {
+    "axios": "^1.1.2",
+    "qs": "^6.11.0"
+  }
+}