@xylabs/axios 5.0.79 → 5.0.81

package/README.md

@@ -23,18 +23,16 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ## Classes
 
-- [AxiosJson](#classes/AxiosJson)
-- [AxiosJsonUncompressed](#classes/AxiosJsonUncompressed)
+- [~~AxiosJson~~](#classes/AxiosJson)
 
-## Type Aliases
+## Variables
 
-- [RawAxiosJsonRequestConfig](#type-aliases/RawAxiosJsonRequestConfig)
-- [RawAxiosJsonRequestUncompressedConfig](#type-aliases/RawAxiosJsonRequestUncompressedConfig)
+- [axiosJson](#variables/axiosJson)
+- [~~axios~~](#variables/axios)
 
-## Variables
+## Functions
 
-- [axios](#variables/axios)
-- [axiosUncompressed](#variables/axiosUncompressed)
+- [axiosJsonConfig](#functions/axiosJsonConfig)
 
 ### classes
 
@@ -44,6 +42,10 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ***
 
+## Deprecated
+
+use axiosJsonConfig instead
+
 ## Extends
 
 - `Axios`
@@ -60,7 +62,7 @@ new AxiosJson(config?): AxiosJson;
 
 #### config?
 
-[`RawAxiosJsonRequestConfig`](#../type-aliases/RawAxiosJsonRequestConfig)\<`any`\>
+`RawAxiosJsonRequestConfig`
 
 ### Returns
 
@@ -72,133 +74,63 @@ new AxiosJson(config?): AxiosJson;
 Axios.constructor
 ```
 
-## Properties
-
-### defaultLogger?
-
-```ts
-static optional defaultLogger: Logger;
-```
-
 ## Methods
 
-### finalPath()
+### ~~axiosConfig()~~
 
 ```ts
-static finalPath(response): any;
+static axiosConfig(config?): RawAxiosJsonRequestConfig;
 ```
 
 ### Parameters
 
-#### response
+#### config?
 
-`AxiosResponse`
+`RawAxiosJsonRequestConfig` = `{}`
 
 ### Returns
 
-`any`
-
-  ### <a id="AxiosJsonUncompressed"></a>AxiosJsonUncompressed
-
-[**@xylabs/axios**](#../README)
+`RawAxiosJsonRequestConfig`
 
 ***
 
-## Extends
-
-- `Axios`
-
-## Constructors
-
-### Constructor
+### ~~create()~~
 
 ```ts
-new AxiosJsonUncompressed(config?): AxiosJsonUncompressed;
+static create(config?): Axios;
 ```
 
 ### Parameters
 
 #### config?
 
-[`RawAxiosJsonRequestUncompressedConfig`](#../type-aliases/RawAxiosJsonRequestUncompressedConfig)\<`any`\>
-
-### Returns
-
-`AxiosJsonUncompressed`
-
-### Overrides
-
-```ts
-Axios.constructor
-```
-
-## Properties
-
-### defaultLogger?
-
-```ts
-static optional defaultLogger: Logger;
-```
-
-## Methods
-
-### finalPath()
-
-```ts
-static finalPath(response): any;
-```
-
-### Parameters
-
-#### response
-
-`AxiosResponse`
+`RawAxiosJsonRequestConfig`
 
 ### Returns
 
-`any`
+`Axios`
 
-### type-aliases
+### functions
 
-  ### <a id="RawAxiosJsonRequestConfig"></a>RawAxiosJsonRequestConfig
+  ### <a id="axiosJsonConfig"></a>axiosJsonConfig
 
 [**@xylabs/axios**](#../README)
 
 ***
 
 ```ts
-type RawAxiosJsonRequestConfig<D> = RawAxiosRequestConfig<D> & object;
-```
-
-## Type declaration
-
-### compressLength?
-
-```ts
-optional compressLength: number;
+function axiosJsonConfig(__namedParameters?): RawAxiosJsonRequestConfig;
 ```
 
-## Type Parameters
+## Parameters
 
-### D
+### \_\_namedParameters?
 
-`D` = `any`
+`RawAxiosJsonRequestConfig` = `{}`
 
-  ### <a id="RawAxiosJsonRequestUncompressedConfig"></a>RawAxiosJsonRequestUncompressedConfig
+## Returns
 
-[**@xylabs/axios**](#../README)
-
-***
-
-```ts
-type RawAxiosJsonRequestUncompressedConfig<D> = RawAxiosRequestConfig<D>;
-```
-
-## Type Parameters
-
-### D
-
-`D` = `any`
+`RawAxiosJsonRequestConfig`
 
 ### variables
 
@@ -209,17 +141,21 @@ type RawAxiosJsonRequestUncompressedConfig<D> = RawAxiosRequestConfig<D>;
 ***
 
 ```ts
-const axios: AxiosJson;
+const axios: Axios = axiosJson;
 ```
 
-  ### <a id="axiosUncompressed"></a>axiosUncompressed
+## Deprecated
+
+use axiosJson instead
+
+  ### <a id="axiosJson"></a>axiosJson
 
 [**@xylabs/axios**](#../README)
 
 ***
 
 ```ts
-const axiosUncompressed: AxiosJsonUncompressed;
+const axiosJson: Axios;
 ```
 
 

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts","../../src/axiosJsonConfig.ts","../../src/AxiosJson.ts"],"sourcesContent":["import { Axios } from 'axios'\n\nimport { axiosJsonConfig } from './axiosJsonConfig.ts'\n\nexport * from './AxiosJson.ts'\nexport { gzip } from 'pako'\n\nexport const axiosJson = new Axios(axiosJsonConfig())\n\n/** @deprecated use axiosJson instead */\nexport const axios = axiosJson\n\nexport { axiosJsonConfig } from './axiosJsonConfig.ts'\n","import type { RawAxiosRequestConfig } from 'axios'\nimport { AxiosHeaders } from 'axios'\nimport { gzip } from 'pako'\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type RawAxiosJsonRequestConfig<D = any> = RawAxiosRequestConfig<D> & { compressLength?: number }\n\nfunction buildHeaders(headers: RawAxiosJsonRequestConfig['headers']) {\n  const axiosHeaders = new AxiosHeaders()\n  axiosHeaders.set('Accept', 'application/json, text/plain, *.*')\n  axiosHeaders.set('Content-Type', 'application/json')\n  for (const [key, value] of Object.entries(headers ?? {})) axiosHeaders.set(key, value)\n  return axiosHeaders\n}\n\nexport function axiosJsonConfig({\n  compressLength, headers, ...config\n}: RawAxiosJsonRequestConfig = {}): RawAxiosJsonRequestConfig {\n  return {\n    headers: buildHeaders(headers),\n    transformRequest: (data, headers) => {\n      const json = JSON.stringify(data)\n      if (headers !== undefined && data && json.length > (compressLength ?? 1024)) {\n        headers.set('Content-Encoding', 'gzip')\n        return gzip(json).buffer\n      }\n      return json\n    },\n    transformResponse: (data) => {\n      try {\n        return JSON.parse(data)\n      } catch {\n        return null\n      }\n    },\n    ...config,\n  }\n}\n","import type { Logger } from '@xylabs/logger'\nimport { Axios } from 'axios'\n\nimport type { RawAxiosJsonRequestConfig } from './axiosJsonConfig.ts'\nimport { axiosJsonConfig } from './axiosJsonConfig.ts'\n\nfunction deprecated(from: string, to: string, logger: Logger = console) {\n  logger.warn(`${from} is deprecated. Please use ${to} instead.`)\n}\n\n/** @deprecated use axiosJsonConfig instead */\nexport class AxiosJson extends Axios {\n  constructor(config?: RawAxiosJsonRequestConfig) {\n    deprecated('AxiosJson', 'axiosJsonConfig')\n    // eslint-disable-next-line sonarjs/deprecation\n    super(AxiosJson.axiosConfig(config))\n  }\n\n  static axiosConfig(config: RawAxiosJsonRequestConfig = {}): RawAxiosJsonRequestConfig {\n    return axiosJsonConfig(config)\n  }\n\n  static create(config?: RawAxiosJsonRequestConfig) {\n    return new Axios(this.axiosConfig(config))\n  }\n}\n"],"mappings":";AAAA,SAAS,SAAAA,cAAa;;;ACCtB,SAAS,oBAAoB;AAC7B,SAAS,YAAY;AAKrB,SAAS,aAAa,SAA+C;AACnE,QAAM,eAAe,IAAI,aAAa;AACtC,eAAa,IAAI,UAAU,mCAAmC;AAC9D,eAAa,IAAI,gBAAgB,kBAAkB;AACnD,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,WAAW,CAAC,CAAC,EAAG,cAAa,IAAI,KAAK,KAAK;AACrF,SAAO;AACT;AAEO,SAAS,gBAAgB;AAAA,EAC9B;AAAA,EAAgB;AAAA,EAAS,GAAG;AAC9B,IAA+B,CAAC,GAA8B;AAC5D,SAAO;AAAA,IACL,SAAS,aAAa,OAAO;AAAA,IAC7B,kBAAkB,CAAC,MAAMC,aAAY;AACnC,YAAM,OAAO,KAAK,UAAU,IAAI;AAChC,UAAIA,aAAY,UAAa,QAAQ,KAAK,UAAU,kBAAkB,OAAO;AAC3E,QAAAA,SAAQ,IAAI,oBAAoB,MAAM;AACtC,eAAO,KAAK,IAAI,EAAE;AAAA,MACpB;AACA,aAAO;AAAA,IACT;AAAA,IACA,mBAAmB,CAAC,SAAS;AAC3B,UAAI;AACF,eAAO,KAAK,MAAM,IAAI;AAAA,MACxB,QAAQ;AACN,eAAO;AAAA,MACT;AAAA,IACF;AAAA,IACA,GAAG;AAAA,EACL;AACF;;;ACpCA,SAAS,aAAa;AAKtB,SAAS,WAAW,MAAc,IAAY,SAAiB,SAAS;AACtE,SAAO,KAAK,GAAG,IAAI,8BAA8B,EAAE,WAAW;AAChE;AAGO,IAAM,YAAN,MAAM,mBAAkB,MAAM;AAAA,EACnC,YAAY,QAAoC;AAC9C,eAAW,aAAa,iBAAiB;AAEzC,UAAM,WAAU,YAAY,MAAM,CAAC;AAAA,EACrC;AAAA,EAEA,OAAO,YAAY,SAAoC,CAAC,GAA8B;AACpF,WAAO,gBAAgB,MAAM;AAAA,EAC/B;AAAA,EAEA,OAAO,OAAO,QAAoC;AAChD,WAAO,IAAI,MAAM,KAAK,YAAY,MAAM,CAAC;AAAA,EAC3C;AACF;;;AFpBA,SAAS,QAAAC,aAAY;AAEd,IAAM,YAAY,IAAIC,OAAM,gBAAgB,CAAC;AAG7C,IAAM,QAAQ;","names":["Axios","headers","gzip","Axios"]}
+{"version":3,"sources":["../../src/index.ts","../../src/axiosJsonConfig.ts","../../src/AxiosJson.ts"],"sourcesContent":["import { Axios } from 'axios'\n\nimport { axiosJsonConfig } from './axiosJsonConfig.ts'\n\nexport * from './AxiosJson.ts'\nexport { gzip } from 'pako'\n\nexport const axiosJson = new Axios(axiosJsonConfig())\n\n/** @deprecated use axiosJson instead */\nexport const axios = axiosJson\n\nexport { axiosJsonConfig } from './axiosJsonConfig.ts'\n","import type { RawAxiosRequestConfig } from 'axios'\nimport { AxiosHeaders } from 'axios'\nimport { gzip } from 'pako'\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type RawAxiosJsonRequestConfig<D = any> = RawAxiosRequestConfig<D> & { compressLength?: number }\n\nfunction buildHeaders(headers: RawAxiosJsonRequestConfig['headers']) {\n  const axiosHeaders = new AxiosHeaders()\n  axiosHeaders.set('Accept', 'application/json, text/plain, *.*')\n  axiosHeaders.set('Content-Type', 'application/json')\n  for (const [key, value] of Object.entries(headers ?? {})) axiosHeaders.set(key, value)\n  return axiosHeaders\n}\n\nexport function axiosJsonConfig({\n  compressLength, headers, ...config\n}: RawAxiosJsonRequestConfig = {}): RawAxiosJsonRequestConfig {\n  return {\n    headers: buildHeaders(headers),\n    transformRequest: (data, headers) => {\n      const json = JSON.stringify(data)\n      if (headers !== undefined && data && json.length > (compressLength ?? 1024)) {\n        headers.set('Content-Encoding', 'gzip')\n        return gzip(json).buffer\n      }\n      return json\n    },\n    transformResponse: (data) => {\n      try {\n        return JSON.parse(data)\n      } catch {\n        return null\n      }\n    },\n    ...config,\n  }\n}\n","import type { Logger } from '@xylabs/logger'\nimport { Axios } from 'axios'\n\nimport type { RawAxiosJsonRequestConfig } from './axiosJsonConfig.ts'\nimport { axiosJsonConfig } from './axiosJsonConfig.ts'\n\nfunction deprecated(from: string, to: string, logger: Logger = console) {\n  logger.warn(`${from} is deprecated. Please use ${to} instead.`)\n}\n\n/** @deprecated use axiosJsonConfig instead */\nexport class AxiosJson extends Axios {\n  constructor(config?: RawAxiosJsonRequestConfig) {\n    deprecated('AxiosJson', 'axiosJsonConfig')\n    // eslint-disable-next-line sonarjs/deprecation, @typescript-eslint/no-deprecated\n    super(AxiosJson.axiosConfig(config))\n  }\n\n  static axiosConfig(config: RawAxiosJsonRequestConfig = {}): RawAxiosJsonRequestConfig {\n    return axiosJsonConfig(config)\n  }\n\n  static create(config?: RawAxiosJsonRequestConfig) {\n    return new Axios(this.axiosConfig(config))\n  }\n}\n"],"mappings":";AAAA,SAAS,SAAAA,cAAa;;;ACCtB,SAAS,oBAAoB;AAC7B,SAAS,YAAY;AAKrB,SAAS,aAAa,SAA+C;AACnE,QAAM,eAAe,IAAI,aAAa;AACtC,eAAa,IAAI,UAAU,mCAAmC;AAC9D,eAAa,IAAI,gBAAgB,kBAAkB;AACnD,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,WAAW,CAAC,CAAC,EAAG,cAAa,IAAI,KAAK,KAAK;AACrF,SAAO;AACT;AAEO,SAAS,gBAAgB;AAAA,EAC9B;AAAA,EAAgB;AAAA,EAAS,GAAG;AAC9B,IAA+B,CAAC,GAA8B;AAC5D,SAAO;AAAA,IACL,SAAS,aAAa,OAAO;AAAA,IAC7B,kBAAkB,CAAC,MAAMC,aAAY;AACnC,YAAM,OAAO,KAAK,UAAU,IAAI;AAChC,UAAIA,aAAY,UAAa,QAAQ,KAAK,UAAU,kBAAkB,OAAO;AAC3E,QAAAA,SAAQ,IAAI,oBAAoB,MAAM;AACtC,eAAO,KAAK,IAAI,EAAE;AAAA,MACpB;AACA,aAAO;AAAA,IACT;AAAA,IACA,mBAAmB,CAAC,SAAS;AAC3B,UAAI;AACF,eAAO,KAAK,MAAM,IAAI;AAAA,MACxB,QAAQ;AACN,eAAO;AAAA,MACT;AAAA,IACF;AAAA,IACA,GAAG;AAAA,EACL;AACF;;;ACpCA,SAAS,aAAa;AAKtB,SAAS,WAAW,MAAc,IAAY,SAAiB,SAAS;AACtE,SAAO,KAAK,GAAG,IAAI,8BAA8B,EAAE,WAAW;AAChE;AAGO,IAAM,YAAN,MAAM,mBAAkB,MAAM;AAAA,EACnC,YAAY,QAAoC;AAC9C,eAAW,aAAa,iBAAiB;AAEzC,UAAM,WAAU,YAAY,MAAM,CAAC;AAAA,EACrC;AAAA,EAEA,OAAO,YAAY,SAAoC,CAAC,GAA8B;AACpF,WAAO,gBAAgB,MAAM;AAAA,EAC/B;AAAA,EAEA,OAAO,OAAO,QAAoC;AAChD,WAAO,IAAI,MAAM,KAAK,YAAY,MAAM,CAAC;AAAA,EAC3C;AACF;;;AFpBA,SAAS,QAAAC,aAAY;AAEd,IAAM,YAAY,IAAIC,OAAM,gBAAgB,CAAC;AAG7C,IAAM,QAAQ;","names":["Axios","headers","gzip","Axios"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/axios",
-  "version": "5.0.79",
+  "version": "5.0.81",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "axios",
@@ -29,17 +29,14 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
-      "source": "./src/index.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "./dist/neutral/index.mjs",
-  "source": "./src/index.ts",
   "types": "./dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
     "!**/*.test.*"
@@ -49,11 +46,12 @@
   },
   "devDependencies": {
     "@types/pako": "~2.0.4",
-    "@xylabs/logger": "~5.0.79",
-    "@xylabs/ts-scripts-yarn3": "~7.3.2",
-    "@xylabs/tsconfig": "~7.3.2",
-    "axios": "^1.13.5",
-    "typescript": "~5.9.3"
+    "@xylabs/logger": "~5.0.81",
+    "@xylabs/ts-scripts-yarn3": "~7.4.11",
+    "@xylabs/tsconfig": "~7.4.11",
+    "axios": "^1.13.6",
+    "typescript": "~5.9.3",
+    "vitest": "~4.0.18"
   },
   "peerDependencies": {
     "axios": "^1"

package/src/AxiosJson.ts

@@ -1,26 +0,0 @@
-import type { Logger } from '@xylabs/logger'
-import { Axios } from 'axios'
-
-import type { RawAxiosJsonRequestConfig } from './axiosJsonConfig.ts'
-import { axiosJsonConfig } from './axiosJsonConfig.ts'
-
-function deprecated(from: string, to: string, logger: Logger = console) {
-  logger.warn(`${from} is deprecated. Please use ${to} instead.`)
-}
-
-/** @deprecated use axiosJsonConfig instead */
-export class AxiosJson extends Axios {
-  constructor(config?: RawAxiosJsonRequestConfig) {
-    deprecated('AxiosJson', 'axiosJsonConfig')
-    // eslint-disable-next-line sonarjs/deprecation
-    super(AxiosJson.axiosConfig(config))
-  }
-
-  static axiosConfig(config: RawAxiosJsonRequestConfig = {}): RawAxiosJsonRequestConfig {
-    return axiosJsonConfig(config)
-  }
-
-  static create(config?: RawAxiosJsonRequestConfig) {
-    return new Axios(this.axiosConfig(config))
-  }
-}

package/src/axiosJsonConfig.ts

@@ -1,38 +0,0 @@
-import type { RawAxiosRequestConfig } from 'axios'
-import { AxiosHeaders } from 'axios'
-import { gzip } from 'pako'
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type RawAxiosJsonRequestConfig<D = any> = RawAxiosRequestConfig<D> & { compressLength?: number }
-
-function buildHeaders(headers: RawAxiosJsonRequestConfig['headers']) {
-  const axiosHeaders = new AxiosHeaders()
-  axiosHeaders.set('Accept', 'application/json, text/plain, *.*')
-  axiosHeaders.set('Content-Type', 'application/json')
-  for (const [key, value] of Object.entries(headers ?? {})) axiosHeaders.set(key, value)
-  return axiosHeaders
-}
-
-export function axiosJsonConfig({
-  compressLength, headers, ...config
-}: RawAxiosJsonRequestConfig = {}): RawAxiosJsonRequestConfig {
-  return {
-    headers: buildHeaders(headers),
-    transformRequest: (data, headers) => {
-      const json = JSON.stringify(data)
-      if (headers !== undefined && data && json.length > (compressLength ?? 1024)) {
-        headers.set('Content-Encoding', 'gzip')
-        return gzip(json).buffer
-      }
-      return json
-    },
-    transformResponse: (data) => {
-      try {
-        return JSON.parse(data)
-      } catch {
-        return null
-      }
-    },
-    ...config,
-  }
-}

package/src/index.ts

@@ -1,13 +0,0 @@
-import { Axios } from 'axios'
-
-import { axiosJsonConfig } from './axiosJsonConfig.ts'
-
-export * from './AxiosJson.ts'
-export { gzip } from 'pako'
-
-export const axiosJson = new Axios(axiosJsonConfig())
-
-/** @deprecated use axiosJson instead */
-export const axios = axiosJson
-
-export { axiosJsonConfig } from './axiosJsonConfig.ts'