@andbridge/glowpod 1.0.7 → 1.0.9

package/build/glowpod.esm.js

@@ -1 +1 @@
-import e from"axios";class s{constructor(s){this.getInstance=()=>this.instance,this.Get=e=>this.instance({method:"GET",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Put=e=>this.instance({method:"PUT",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Delete=e=>this.instance({method:"DELETE",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Post=e=>this.instance({method:"POST",url:e.url,data:e.params,headers:{...e.headers},...e.others}),this.instance=e.create(s)}}const t=()=>{},a=()=>{},r=()=>{};var o;!function(e){e[e.success=200]="success"}(o||(o={}));const n=({instance:e,authTokenStorageName:s="token",authFailedCaller:n=t,networkSuccessCode:c=200,authFailedCode:d=401,networkFailedCaller:h=a,serverKillCaller:i=r,responseStruct:l={codeName:"code",messageName:"message",dataName:"data"}})=>{let u=null,m=!0;const p=e=>(u&&clearTimeout(u),u=setTimeout(()=>{m&&(e.status==o.success?(e.data?.[l.codeName]==d&&n(),e.data?.[l.codeName]!=c&&h()):i())},0),()=>m=!1);e.interceptors.request.use(async e=>{const t=localStorage.getItem(s);return t&&e.headers&&e.headers.set(s,t),e},e=>(console.log("请求错误拦截器:",e),p(e),Promise.reject(e))),e.interceptors.response.use(e=>{if("blob"===e.config.responseType)return e;if(e.data?.[l.codeName]===c)return e.data?.[l.dataName];{const s=p(e);throw{...e,hiddenDefaultErrorHandler:s}}},e=>{const s=p(e);throw{...e,hiddenDefaultErrorHandler:s}})};export{s as GlowPod,n as setupInterceptors};
+import e from"axios";class t{constructor(t){this.getInstance=()=>this.instance,this.Get=e=>this.instance({method:"GET",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Put=e=>this.instance({method:"PUT",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Delete=e=>this.instance({method:"DELETE",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Post=e=>this.instance({method:"POST",url:e.url,data:e.params,headers:{...e.headers},...e.others}),this.instance=e.create(t)}}const a=()=>{},s=()=>{},r=()=>{},o=200,n=299,d=({instance:e,authTokenStorageName:t="token",authFailedCaller:d=a,networkSuccessCode:h=200,authFailedCode:i=401,networkFailedCaller:l=s,serverKillCaller:c=r,responseStruct:u={codeName:"code",messageName:"message",dataName:"data"}})=>{let m=null,p=!0;const g=e=>(m&&clearTimeout(m),m=setTimeout(()=>{if(p)return e.status<=o&&e.status>=n?c():e.data?.[u.codeName]==i?d():e.data?.[u.codeName]!=h?l():void 0},0),()=>p=!1);e.interceptors.request.use(async e=>{const a=localStorage.getItem(t);return a&&e.headers&&e.headers.set(t,a),e},e=>(console.log("请求错误拦截器:",e),g(e),Promise.reject(e))),e.interceptors.response.use(e=>{if("blob"===e.config.responseType)return e;if(e.data?.[u.codeName]===h)return e.data?.[u.dataName];{const t=g(e);throw{...e,hiddenDefaultErrorHandler:t}}},e=>{const t=g(e);throw{...e,hiddenDefaultErrorHandler:t}})};export{t as GlowPod,d as setupInterceptors};

package/build/glowpod.js

@@ -1 +1 @@
-"use strict";var e=require("axios");const s=()=>{},t=()=>{},a=()=>{};var r;!function(e){e[e.success=200]="success"}(r||(r={}));exports.GlowPod=class{constructor(s){this.getInstance=()=>this.instance,this.Get=e=>this.instance({method:"GET",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Put=e=>this.instance({method:"PUT",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Delete=e=>this.instance({method:"DELETE",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Post=e=>this.instance({method:"POST",url:e.url,data:e.params,headers:{...e.headers},...e.others}),this.instance=e.create(s)}},exports.setupInterceptors=({instance:e,authTokenStorageName:o="token",authFailedCaller:n=s,networkSuccessCode:c=200,authFailedCode:d=401,networkFailedCaller:h=t,serverKillCaller:i=a,responseStruct:l={codeName:"code",messageName:"message",dataName:"data"}})=>{let u=null,m=!0;const p=e=>(u&&clearTimeout(u),u=setTimeout(()=>{m&&(e.status==r.success?(e.data?.[l.codeName]==d&&n(),e.data?.[l.codeName]!=c&&h()):i())},0),()=>m=!1);e.interceptors.request.use(async e=>{const s=localStorage.getItem(o);return s&&e.headers&&e.headers.set(o,s),e},e=>(console.log("请求错误拦截器:",e),p(e),Promise.reject(e))),e.interceptors.response.use(e=>{if("blob"===e.config.responseType)return e;if(e.data?.[l.codeName]===c)return e.data?.[l.dataName];{const s=p(e);throw{...e,hiddenDefaultErrorHandler:s}}},e=>{const s=p(e);throw{...e,hiddenDefaultErrorHandler:s}})};
+"use strict";var e=require("axios");const t=()=>{},s=()=>{},a=()=>{},r=200,o=299;exports.GlowPod=class{constructor(t){this.getInstance=()=>this.instance,this.Get=e=>this.instance({method:"GET",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Put=e=>this.instance({method:"PUT",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Delete=e=>this.instance({method:"DELETE",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Post=e=>this.instance({method:"POST",url:e.url,data:e.params,headers:{...e.headers},...e.others}),this.instance=e.create(t)}},exports.setupInterceptors=({instance:e,authTokenStorageName:n="token",authFailedCaller:d=t,networkSuccessCode:i=200,authFailedCode:h=401,networkFailedCaller:c=s,serverKillCaller:l=a,responseStruct:u={codeName:"code",messageName:"message",dataName:"data"}})=>{let m=null,p=!0;const g=e=>(m&&clearTimeout(m),m=setTimeout(()=>{if(p)return e.status<=r&&e.status>=o?l():e.data?.[u.codeName]==h?d():e.data?.[u.codeName]!=i?c():void 0},0),()=>p=!1);e.interceptors.request.use(async e=>{const t=localStorage.getItem(n);return t&&e.headers&&e.headers.set(n,t),e},e=>(console.log("请求错误拦截器:",e),g(e),Promise.reject(e))),e.interceptors.response.use(e=>{if("blob"===e.config.responseType)return e;if(e.data?.[u.codeName]===i)return e.data?.[u.dataName];{const t=g(e);throw{...e,hiddenDefaultErrorHandler:t}}},e=>{const t=g(e);throw{...e,hiddenDefaultErrorHandler:t}})};

package/build/glowpod.umd.js

@@ -1 +1 @@
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports,require("axios")):"function"==typeof define&&define.amd?define(["exports","axios"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).GlowPod={},e.axios)}(this,function(e,t){"use strict";const s=()=>{},a=()=>{},r=()=>{};var o;!function(e){e[e.success=200]="success"}(o||(o={}));e.GlowPod=class{constructor(e){this.getInstance=()=>this.instance,this.Get=e=>this.instance({method:"GET",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Put=e=>this.instance({method:"PUT",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Delete=e=>this.instance({method:"DELETE",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Post=e=>this.instance({method:"POST",url:e.url,data:e.params,headers:{...e.headers},...e.others}),this.instance=t.create(e)}},e.setupInterceptors=({instance:e,authTokenStorageName:t="token",authFailedCaller:n=s,networkSuccessCode:d=200,authFailedCode:i=401,networkFailedCaller:c=a,serverKillCaller:l=r,responseStruct:u={codeName:"code",messageName:"message",dataName:"data"}})=>{let h=null,m=!0;const p=e=>(h&&clearTimeout(h),h=setTimeout(()=>{m&&(e.status==o.success?(e.data?.[u.codeName]==i&&n(),e.data?.[u.codeName]!=d&&c()):l())},0),()=>m=!1);e.interceptors.request.use(async e=>{const s=localStorage.getItem(t);return s&&e.headers&&e.headers.set(t,s),e},e=>(console.log("请求错误拦截器:",e),p(e),Promise.reject(e))),e.interceptors.response.use(e=>{if("blob"===e.config.responseType)return e;if(e.data?.[u.codeName]===d)return e.data?.[u.dataName];{const t=p(e);throw{...e,hiddenDefaultErrorHandler:t}}},e=>{const t=p(e);throw{...e,hiddenDefaultErrorHandler:t}})}});
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports,require("axios")):"function"==typeof define&&define.amd?define(["exports","axios"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).GlowPod={},e.axios)}(this,function(e,t){"use strict";const s=()=>{},a=()=>{},r=()=>{},o=200,n=299;e.GlowPod=class{constructor(e){this.getInstance=()=>this.instance,this.Get=e=>this.instance({method:"GET",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Put=e=>this.instance({method:"PUT",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Delete=e=>this.instance({method:"DELETE",url:e.url,params:e.params,headers:{...e.headers},...e.others}),this.Post=e=>this.instance({method:"POST",url:e.url,data:e.params,headers:{...e.headers},...e.others}),this.instance=t.create(e)}},e.setupInterceptors=({instance:e,authTokenStorageName:t="token",authFailedCaller:d=s,networkSuccessCode:i=200,authFailedCode:l=401,networkFailedCaller:c=a,serverKillCaller:h=r,responseStruct:u={codeName:"code",messageName:"message",dataName:"data"}})=>{let m=null,p=!0;const f=e=>(m&&clearTimeout(m),m=setTimeout(()=>{if(p)return e.status<=o&&e.status>=n?h():e.data?.[u.codeName]==l?d():e.data?.[u.codeName]!=i?c():void 0},0),()=>p=!1);e.interceptors.request.use(async e=>{const s=localStorage.getItem(t);return s&&e.headers&&e.headers.set(t,s),e},e=>(console.log("请求错误拦截器:",e),f(e),Promise.reject(e))),e.interceptors.response.use(e=>{if("blob"===e.config.responseType)return e;if(e.data?.[u.codeName]===i)return e.data?.[u.dataName];{const t=f(e);throw{...e,hiddenDefaultErrorHandler:t}}},e=>{const t=f(e);throw{...e,hiddenDefaultErrorHandler:t}})}});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@andbridge/glowpod",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "A axios-based HTTP client library",
   "main": "build/glowpod.js",
   "module": "build/glowpod.esm.js",

package/readme.md

@@ -0,0 +1,344 @@
+### @andbrigd/glowpod is a network request library base on axios.
+
+
+# Installation
+pnpm download
+```bash
+pnpm install @andbrigd/glowpod
+```
+yarn download
+```bash
+yarn add @andbrigd/glowpod
+```
+npm download
+```bash
+npm install @andbrigd/glowpod
+```
+
+# Usage
+## base usage
+```ts
+import { GlowPod } from "@andbridge/glowpod";
+
+const glowpod = new GlowPod({
+    baseURL: "",
+});
+
+glowpod.Get("/api/v1/users").then((res) => {})
+
+glowpod.Post("/api/v1/users", {})
+
+glowpod.Put("/api/v1/users", {})
+
+glowpod.Delete("/api/v1/users", {})
+```
+
+## custom config
+
+```ts
+import { GlowPod } from "@andbridge/glowpod";
+
+
+
+const glowpod = new GlowPod({
+  // `url` is the server URL that will be used for the request
+  url: '/user',
+  // `method` is the request method to be used when making the request
+  method: 'get', // default
+  // `baseURL` will be prepended to `url` unless `url` is absolute.
+  // It can be convenient to set `baseURL` for an instance of axios to pass relative URLs
+  // to methods of that instance.
+  baseURL: 'https://some-domain.com/api',
+  // `allowAbsoluteUrls` determines whether or not absolute URLs will override a configured `baseUrl`.
+  // When set to true (default), absolute values for `url` will override `baseUrl`.
+  // When set to false, absolute values for `url` will always be prepended by `baseUrl`.
+  allowAbsoluteUrls: true,
+  // `transformRequest` allows changes to the request data before it is sent to the server
+  // This is only applicable for request methods 'PUT', 'POST', 'PATCH' and 'DELETE'
+  // The last function in the array must return a string or an instance of Buffer, ArrayBuffer,
+  // FormData or Stream
+  // You may modify the headers object.
+  transformRequest: [function (data, headers) {
+    // Do whatever you want to transform the data
+
+    return data;
+  }],
+
+  // `transformResponse` allows changes to the response data to be made before
+  // it is passed to then/catch
+  transformResponse: [function (data) {
+    // Do whatever you want to transform the data
+
+    return data;
+  }],
+
+  // `headers` are custom headers to be sent
+  headers: {'X-Requested-With': 'XMLHttpRequest'},
+
+  // `params` are the URL parameters to be sent with the request
+  // Must be a plain object or a URLSearchParams object
+  // NOTE: params that are null or undefined are not rendered in the URL.
+  params: {
+    ID: 12345
+  },
+
+  // `paramsSerializer` is an optional config in charge of serializing `params`
+  paramsSerializer: {
+    encode?: (param: string): string => { /* Do custom ops here and return transformed string */ }, // custom encoder function; sends Key/Values in an iterative fashion
+    serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions ), // mimic pre 1.x behavior and send entire params object to a custom serializer func. Allows consumer to control how params are serialized.
+    indexes: false // array indexes format (null - no brackets, false (default) - empty brackets, true - brackets with indexes)
+  },
+
+  // `data` is the data to be sent as the request body
+  // Only applicable for request methods 'PUT', 'POST', 'DELETE', and 'PATCH'
+  // When no `transformRequest` is set, must be of one of the following types:
+  // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
+  // - Browser only: FormData, File, Blob
+  // - Node only: Stream, Buffer
+  data: {
+    firstName: 'Fred'
+  },
+  
+  // syntax alternative to send data into the body
+  // method post
+  // only the value is sent, not the key
+  data: 'Country=Brasil&City=Belo Horizonte',
+
+  // `timeout` specifies the number of milliseconds before the request times out.
+  // If the request takes longer than `timeout`, the request will be aborted.
+  timeout: 1000, // default is `0` (no timeout)
+
+  // `withCredentials` indicates whether or not cross-site Access-Control requests
+  // should be made using credentials
+  withCredentials: false, // default
+
+  // `adapter` allows custom handling of requests which makes testing easier.
+  // Return a promise and supply a valid response (see lib/adapters/README.md).
+  adapter: function (config) {
+    /* ... */
+  },
+
+  // `auth` indicates that HTTP Basic auth should be used, and supplies credentials.
+  // This will set an `Authorization` header, overwriting any existing
+  // `Authorization` custom headers you have set using `headers`.
+  // Please note that only HTTP Basic auth is configurable through this parameter.
+  // For Bearer tokens and such, use `Authorization` custom headers instead.
+  auth: {
+    username: 'janedoe',
+    password: 's00pers3cret'
+  },
+
+  // `responseType` indicates the type of data that the server will respond with
+  // options are: 'arraybuffer', 'document', 'json', 'text', 'stream'
+  //   browser only: 'blob'
+  responseType: 'json', // default
+
+  // `responseEncoding` indicates encoding to use for decoding responses (Node.js only)
+  // Note: Ignored for `responseType` of 'stream' or client-side requests
+  responseEncoding: 'utf8', // default
+
+  // `xsrfCookieName` is the name of the cookie to use as a value for xsrf token
+  xsrfCookieName: 'XSRF-TOKEN', // default
+
+  // `xsrfHeaderName` is the name of the http header that carries the xsrf token value
+  xsrfHeaderName: 'X-XSRF-TOKEN', // default
+
+  // `onUploadProgress` allows handling of progress events for uploads
+  // browser only
+  onUploadProgress: function (progressEvent) {
+    // Do whatever you want with the native progress event
+  },
+
+  // `onDownloadProgress` allows handling of progress events for downloads
+  // browser only
+  onDownloadProgress: function (progressEvent) {
+    // Do whatever you want with the native progress event
+  },
+
+  // `maxContentLength` defines the max size of the http response content in bytes allowed in node.js
+  maxContentLength: 2000,
+
+  // `maxBodyLength` (Node only option) defines the max size of the http request content in bytes allowed
+  maxBodyLength: 2000,
+
+  // `validateStatus` defines whether to resolve or reject the promise for a given
+  // HTTP response status code. If `validateStatus` returns `true` (or is set to `null`
+  // or `undefined`), the promise will be resolved; otherwise, the promise will be
+  // rejected.
+  validateStatus: function (status) {
+    return status >= 200 && status < 300; // default
+  },
+
+  // `maxRedirects` defines the maximum number of redirects to follow in node.js.
+  // If set to 0, no redirects will be followed.
+  maxRedirects: 21, // default
+
+  // `beforeRedirect` defines a function that will be called before redirect.
+  // Use this to adjust the request options upon redirecting,
+  // to inspect the latest response headers,
+  // or to cancel the request by throwing an error
+  // If maxRedirects is set to 0, `beforeRedirect` is not used.
+  beforeRedirect: (options, { headers }) => {
+   if (options.hostname === "example.com") {
+     options.auth = "user:password";
+   }
+  },
+
+  // `socketPath` defines a UNIX Socket to be used in node.js.
+  // e.g. '/var/run/docker.sock' to send requests to the docker daemon.
+  // Only either `socketPath` or `proxy` can be specified.
+  // If both are specified, `socketPath` is used.
+  socketPath: null, // default
+
+  // `transport` determines the transport method that will be used to make the request. If defined, it will be used. Otherwise, if `maxRedirects` is 0, the default `http` or `https` library will be used, depending on the protocol specified in `protocol`. Otherwise, the `httpFollow` or `httpsFollow` library will be used, again depending on the protocol, which can handle redirects.
+  transport: undefined, // default
+
+  // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http
+  // and https requests, respectively, in node.js. This allows options to be added like
+  // `keepAlive` that are not enabled by default before Node.js v19.0.0. After Node.js
+  // v19.0.0, you no longer need to customize the agent to enable `keepAlive` because
+  // `http.globalAgent` has `keepAlive` enabled by default.
+  httpAgent: new http.Agent({ keepAlive: true }),
+  httpsAgent: new https.Agent({ keepAlive: true }),
+
+  // `proxy` defines the hostname, port, and protocol of the proxy server.
+  // You can also define your proxy using the conventional `http_proxy` and
+  // `https_proxy` environment variables. If you are using environment variables
+  // for your proxy configuration, you can also define a `no_proxy` environment
+  // variable as a comma-separated list of domains that should not be proxied.
+  // Use `false` to disable proxies, ignoring environment variables.
+  // Disable if supplying a custom httpAgent/httpsAgent to manage proxying requests.
+  // `auth` indicates that HTTP Basic auth should be used to connect to the proxy, and
+  // supplies credentials.
+  // This will set an `Proxy-Authorization` header, overwriting any existing
+  // `Proxy-Authorization` custom headers you have set using `headers`.
+  // If the proxy server uses HTTPS, then you must set the protocol to `https`. 
+  proxy: {
+    protocol: 'https',
+    host: '127.0.0.1',
+    port: 9000,
+    auth: {
+      username: 'mikeymike',
+      password: 'rapunz3l'
+    }
+  },
+
+  // `signal` and instance of AbortController can be used to cancel the request
+  signal: new AbortController().signal,
+
+  // (Deprecated) `cancelToken` specifies a cancel token that can also be used to cancel the request
+  // (see Cancellation section below for details)
+  cancelToken: new CancelToken(function (cancel) {
+  }),
+
+  // an alternative way to cancel Axios requests using AbortController
+  signal: new AbortController().signal,
+
+  // `decompress` indicates whether or not the response body should be decompressed 
+  // automatically. If set to `true` will also remove the 'content-encoding' header 
+  // from the responses objects of all decompressed responses
+  // - Node only (XHR cannot turn off decompression)
+  decompress: true // default
+
+  // `insecureHTTPParser` boolean.
+  // Indicates where to use an insecure HTTP parser that accepts invalid HTTP headers.
+  // This may allow interoperability with non-conformant HTTP implementations.
+  // Using the insecure parser should be avoided.
+  // see options https://nodejs.org/dist/latest-v12.x/docs/api/http.html#http_http_request_url_options_callback
+  // see also https://nodejs.org/en/blog/vulnerability/february-2020-security-releases/#strict-http-header-parsing-none
+  insecureHTTPParser: undefined // default
+
+  // transitional options for backward compatibility that may be removed in the newer versions
+  transitional: {
+    // silent JSON parsing mode
+    // `true`  - ignore JSON parsing errors and set response.data to null if parsing failed (old behaviour)
+    // `false` - throw SyntaxError if JSON parsing failed (Note: responseType must be set to 'json')
+    silentJSONParsing: true, // default value for the current Axios version
+
+    // try to parse the response string as JSON even if `responseType` is not 'json'
+    forcedJSONParsing: true,
+
+    // throw ETIMEDOUT error instead of generic ECONNABORTED on request timeouts
+    clarifyTimeoutError: false,
+  },
+
+  env: {
+    // The FormData class to be used to automatically serialize the payload into a FormData object
+    FormData: window?.FormData || global?.FormData
+  },
+
+  formSerializer: {
+    visitor: (value, key, path, helpers) => {}; // custom visitor function to serialize form values
+    dots: boolean; // use dots instead of brackets format
+    metaTokens: boolean; // keep special endings like {} in parameter key
+    indexes: boolean; // array indexes format null - no brackets, false - empty brackets, true - brackets with indexes
+  },
+
+  // http adapter only (node.js)
+  maxRate: [
+    100 * 1024, // 100KB/s upload limit,
+    100 * 1024  // 100KB/s download limit
+  ]
+}
+)
+```
+
+# Feature
+## provider error global handler and request method custom error handler.
+## provider custom network response struct and custom network response code and so on.
+### 1. network response meaning is the response from the server.
+### 2. network response code meaning is the code from the server.
+### 3. server kill callback is the callback when the server is killed or the http status code range is not [200, 299]
+
+```ts
+import { setupInterceptors, GlowPod } from "@andbridge/glowpod";
+
+const { Post,getInstance } = new GlowPod({
+  baseURL: "https://api.github.com",
+});
+
+const instance = getInstance();
+
+setupInterceptors({
+// request instance must getInstance() return value
+  instance,
+// auth failed callback default callback
+  authFailedCaller: () => {
+    alert("登录失效");
+  },
+// server kill callback default callback
+  serverKillCaller: () => {
+    alert("服务器已关闭");
+  },
+// network request failed callback default callback
+  networkFailedCaller: () => {
+    alert("网络请求异常");
+  },
+/* network request response struct default response struct{
+    codeName: "code",
+    messageName: "message",
+    dataName: "data",
+  }
+*/
+  responseStruct: {
+    codeName: "code",
+    messageName: "message",
+    dataName: "data",
+  },
+// auth token storage name default 'token'
+  authTokenStorageName: "token",
+// auth failed code default 401
+  authFailedCode: 401,
+// network success code default 200
+  networkSuccessCode: 200,
+});
+
+Post("/users/login", {})
+```
+
+# last
+
+## If you still have questions or customization needs, you can leave me a message.
+
+
+