revert: transformrequest typing 10745 (#10810)

* Revert "chore: added clarifying docs for the type change (#10804)"

This reverts commit 25387ae1ce.

* Revert "fix: transformRequest input typing (#10745)"

This reverts commit 694f1eca8c.

index.d.cts

@@ -320,39 +320,14 @@ declare namespace axios {
 
   type AxiosResponseHeaders = RawAxiosResponseHeaders & AxiosHeaders;
 
-  /**
+  interface AxiosRequestTransformer {
-   * `transformRequest` is invoked as a left-fold pipeline: each function's return
+    (this: InternalAxiosRequestConfig, data: any, headers: AxiosRequestHeaders): any;
-   * value becomes the next function's `data` argument (see `lib/core/transformData.js`).
-   *
-   * The `D` generic describes the type of `data` entering the *first* transformer
-   * in the chain. Subsequent transformers in an array — and any user transformer
-   * that runs after axios's default `transformRequest` (which serializes objects
-   * to JSON, FormData, URLSearchParams, etc.) — may receive a serialized form
-   * (`string`, `Buffer`, `ArrayBuffer`, `FormData`, `URLSearchParams`,
-   * `Stream`, ...) rather than `D`. The final transformer in the chain is
-   * expected to return one of those serialized forms.
-   *
-   * For best results, type `D` only when supplying a single transformer that
-   * runs first, or accept that intermediate stages may need a runtime check.
-   */
-  interface AxiosRequestTransformer<D = any> {
-    (this: InternalAxiosRequestConfig<D>, data: D, headers: AxiosRequestHeaders): any;
   }
 
-  /**
+  interface AxiosResponseTransformer {
-   * `transformResponse` is invoked as a left-fold pipeline: each function's
-   * return value becomes the next function's `data` argument.
-   *
-   * The `T` generic describes the type of `data` entering the *first* transformer
-   * in the chain — typically the raw response body (`string`, `ArrayBuffer`,
-   * `Buffer`, or `Stream` depending on `responseType`). Later transformers
-   * receive whatever the previous stage returned, so `T` is only accurate for
-   * the first call.
-   */
-  interface AxiosResponseTransformer<T = any> {
     (
       this: InternalAxiosRequestConfig,
-      data: T,
+      data: any,
       headers: AxiosResponseHeaders,
       status?: number
     ): any;
@@ -496,7 +471,7 @@ declare namespace axios {
     method?: Method | string;
     baseURL?: string;
     allowAbsoluteUrls?: boolean;
-    transformRequest?: AxiosRequestTransformer<D> | AxiosRequestTransformer<D>[];
+    transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
     transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
     headers?: (RawAxiosRequestHeaders & MethodsHeaders) | AxiosHeaders;
     params?: any;

index.d.ts

@@ -138,39 +138,14 @@ export type RawAxiosResponseHeaders = Partial<RawAxiosHeaders & RawCommonRespons
 
 export type AxiosResponseHeaders = RawAxiosResponseHeaders & AxiosHeaders;
 
-/**
+export interface AxiosRequestTransformer {
- * `transformRequest` is invoked as a left-fold pipeline: each function's return
+  (this: InternalAxiosRequestConfig, data: any, headers: AxiosRequestHeaders): any;
- * value becomes the next function's `data` argument (see `lib/core/transformData.js`).
- *
- * The `D` generic describes the type of `data` entering the *first* transformer
- * in the chain. Subsequent transformers in an array — and any user transformer
- * that runs after axios's default `transformRequest` (which serializes objects
- * to JSON, FormData, URLSearchParams, etc.) — may receive a serialized form
- * (`string`, `Buffer`, `ArrayBuffer`, `FormData`, `URLSearchParams`,
- * `Stream`, ...) rather than `D`. The final transformer in the chain is
- * expected to return one of those serialized forms.
- *
- * For best results, type `D` only when supplying a single transformer that
- * runs first, or accept that intermediate stages may need a runtime check.
- */
-export interface AxiosRequestTransformer<D = any> {
-  (this: InternalAxiosRequestConfig<D>, data: D, headers: AxiosRequestHeaders): any;
 }
 
-/**
+export interface AxiosResponseTransformer {
- * `transformResponse` is invoked as a left-fold pipeline: each function's
- * return value becomes the next function's `data` argument.
- *
- * The `T` generic describes the type of `data` entering the *first* transformer
- * in the chain — typically the raw response body (`string`, `ArrayBuffer`,
- * `Buffer`, or `Stream` depending on `responseType`). Later transformers
- * receive whatever the previous stage returned, so `T` is only accurate for
- * the first call.
- */
-export interface AxiosResponseTransformer<T = any> {
   (
     this: InternalAxiosRequestConfig,
-    data: T,
+    data: any,
     headers: AxiosResponseHeaders,
     status?: number
   ): any;
@@ -392,7 +367,7 @@ export interface AxiosRequestConfig<D = any> {
   method?: StringLiteralsOrString<Method>;
   baseURL?: string;
   allowAbsoluteUrls?: boolean;
-  transformRequest?: AxiosRequestTransformer<D> | AxiosRequestTransformer<D>[];
+  transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
   transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
   headers?: (RawAxiosRequestHeaders & MethodsHeaders) | AxiosHeaders;
   params?: any;

tests/module/cjs/tests/helpers/fixture.cjs

@@ -1,19 +1,13 @@
 const fs = require('fs');
 const path = require('path');
 
-const createTempFixture = (suiteRoot, repoRoot, name, sourcePath, tsconfig, packageJson) => {
+const createTempFixture = (suiteRoot, name, sourcePath, tsconfig, packageJson) => {
   const tempRoot = fs.mkdtempSync(path.join(suiteRoot, `.tmp-module-${name}-`));
   const source = fs.readFileSync(sourcePath, 'utf8');
 
   fs.writeFileSync(path.join(tempRoot, 'index.ts'), source);
   fs.writeFileSync(path.join(tempRoot, 'tsconfig.json'), JSON.stringify(tsconfig, null, 2));
 
-  if (repoRoot) {
-    const axiosFixturePath = path.join(tempRoot, 'node_modules', 'axios');
-    fs.mkdirSync(path.dirname(axiosFixturePath), { recursive: true });
-    fs.symlinkSync(repoRoot, axiosFixturePath, 'junction');
-  }
-
   if (packageJson) {
     fs.writeFileSync(path.join(tempRoot, 'package.json'), JSON.stringify(packageJson, null, 2));
   }

tests/module/cjs/tests/helpers/transform-request-typing.ts

@@ -1,52 +0,0 @@
-import axios = require('axios');
-
-type Payload = {
-  foo: string;
-  count: number;
-};
-
-type OtherPayload = {
-  other: number;
-};
-
-const transformer: axios.AxiosRequestTransformer<Payload> = function (data, headers) {
-  headers.setContentType('application/json');
-  data.foo.toUpperCase();
-  data.count.toFixed();
-
-  // `this` is narrowed to InternalAxiosRequestConfig<Payload>, so this.data is Payload
-  this.data?.foo.toUpperCase();
-  this.data?.count.toFixed();
-  // @ts-expect-error this.data is Payload, not OtherPayload
-  this.data?.other;
-
-  // @ts-expect-error property does not exist on Payload
-  data.bar;
-
-  return JSON.stringify(data);
-};
-
-const wrongTransformer: axios.AxiosRequestTransformer<OtherPayload> = (data) => JSON.stringify(data);
-
-const config: axios.AxiosRequestConfig<Payload> = {
-  data: {
-    foo: 'hello',
-    count: 1,
-  },
-  transformRequest: [
-    transformer,
-    (data) => {
-      data.foo.toUpperCase();
-      data.count.toFixed();
-
-      // @ts-expect-error property does not exist on Payload
-      data.bar;
-
-      return JSON.stringify(data);
-    },
-    // @ts-expect-error transformer payload type does not match config D
-    wrongTransformer,
-  ],
-};
-
-void axios.request(config);

tests/module/cjs/tests/ts-require-default.module.test.cjs

@@ -21,13 +21,7 @@ const tsconfig = {
 describe('module ts-require-default compatibility', () => {
   it('compiles and executes require("axios").default imports', () => {
     const sourcePath = path.join(repoRoot, 'tests/module/cjs/tests/helpers/ts-require-default.ts');
-    const fixturePath = createTempFixture(
+    const fixturePath = createTempFixture(suiteRoot, 'ts-require-default', sourcePath, tsconfig);
-      suiteRoot,
-      null,
-      'ts-require-default',
-      sourcePath,
-      tsconfig
-    );
 
     try {
       runCommand('node', [tscBin, '-p', 'tsconfig.json'], { cwd: fixturePath });

tests/module/cjs/tests/ts-require.module.test.cjs

@@ -21,7 +21,7 @@ const tsconfig = {
 describe('module ts-require compatibility', () => {
   it('compiles and executes require("axios") imports', () => {
     const sourcePath = path.join(repoRoot, 'tests/module/cjs/tests/helpers/ts-require.ts');
-    const fixturePath = createTempFixture(suiteRoot, null, 'ts-require', sourcePath, tsconfig);
+    const fixturePath = createTempFixture(suiteRoot, 'ts-require', sourcePath, tsconfig);
 
     try {
       runCommand('node', [tscBin, '-p', 'tsconfig.json'], { cwd: fixturePath });

tests/module/cjs/tests/typings.module.test.cjs

@@ -17,27 +17,7 @@ const tsconfig = {
 describe('module cjs typings compatibility', () => {
   it('type-checks commonjs axios typings', () => {
     const sourcePath = path.join(repoRoot, 'tests/module/cjs/tests/helpers/cjs-typing.ts');
-    const fixturePath = createTempFixture(suiteRoot, repoRoot, 'typings-cjs', sourcePath, tsconfig);
+    const fixturePath = createTempFixture(suiteRoot, 'typings-cjs', sourcePath, tsconfig);
-
-    try {
-      runCommand('node', [tscBin, '--noEmit', '-p', 'tsconfig.json'], { cwd: fixturePath });
-    } finally {
-      cleanupTempFixture(fixturePath);
-    }
-  });
-
-  it('type-checks generic commonjs request transformer typings', () => {
-    const sourcePath = path.join(
-      repoRoot,
-      'tests/module/cjs/tests/helpers/transform-request-typing.ts'
-    );
-    const fixturePath = createTempFixture(
-      suiteRoot,
-      repoRoot,
-      'typings-cjs-transform-request',
-      sourcePath,
-      tsconfig
-    );
 
     try {
       runCommand('node', [tscBin, '--noEmit', '-p', 'tsconfig.json'], { cwd: fixturePath });

tests/module/esm/tests/helpers/fixture.js

@@ -1,19 +1,13 @@
 import fs from 'node:fs';
 import path from 'node:path';
 
-export const createTempFixture = (suiteRoot, repoRoot, name, sourcePath, tsconfig, packageJson) => {
+export const createTempFixture = (suiteRoot, name, sourcePath, tsconfig, packageJson) => {
   const tempRoot = fs.mkdtempSync(path.join(suiteRoot, `.tmp-module-${name}-`));
   const source = fs.readFileSync(sourcePath, 'utf8');
 
   fs.writeFileSync(path.join(tempRoot, 'index.ts'), source);
   fs.writeFileSync(path.join(tempRoot, 'tsconfig.json'), JSON.stringify(tsconfig, null, 2));
 
-  if (repoRoot) {
-    const axiosFixturePath = path.join(tempRoot, 'node_modules', 'axios');
-    fs.mkdirSync(path.dirname(axiosFixturePath), { recursive: true });
-    fs.symlinkSync(repoRoot, axiosFixturePath, 'junction');
-  }
-
   if (packageJson) {
     fs.writeFileSync(path.join(tempRoot, 'package.json'), JSON.stringify(packageJson, null, 2));
   }

tests/module/esm/tests/helpers/transform-request-typing.ts

@@ -1,52 +0,0 @@
-import axios, { AxiosRequestConfig, AxiosRequestTransformer } from 'axios';
-
-type Payload = {
-  foo: string;
-  count: number;
-};
-
-type OtherPayload = {
-  other: number;
-};
-
-const transformer: AxiosRequestTransformer<Payload> = function (data, headers) {
-  headers.setContentType('application/json');
-  data.foo.toUpperCase();
-  data.count.toFixed();
-
-  // `this` is narrowed to InternalAxiosRequestConfig<Payload>, so this.data is Payload
-  this.data?.foo.toUpperCase();
-  this.data?.count.toFixed();
-  // @ts-expect-error this.data is Payload, not OtherPayload
-  this.data?.other;
-
-  // @ts-expect-error property does not exist on Payload
-  data.bar;
-
-  return JSON.stringify(data);
-};
-
-const wrongTransformer: AxiosRequestTransformer<OtherPayload> = (data) => JSON.stringify(data);
-
-const config: AxiosRequestConfig<Payload> = {
-  data: {
-    foo: 'hello',
-    count: 1,
-  },
-  transformRequest: [
-    transformer,
-    (data) => {
-      data.foo.toUpperCase();
-      data.count.toFixed();
-
-      // @ts-expect-error property does not exist on Payload
-      data.bar;
-
-      return JSON.stringify(data);
-    },
-    // @ts-expect-error transformer payload type does not match config D
-    wrongTransformer,
-  ],
-};
-
-void axios.request(config);

tests/module/esm/tests/ts.module.test.js

@@ -22,7 +22,7 @@ const tsconfig = {
 describe('module ts compatibility', () => {
   it('compiles and executes import axios syntax', () => {
     const sourcePath = path.join(repoRoot, 'tests/module/esm/tests/helpers/esm-functions.ts');
-    const fixturePath = createTempFixture(suiteRoot, null, 'ts', sourcePath, tsconfig, {
+    const fixturePath = createTempFixture(suiteRoot, 'ts', sourcePath, tsconfig, {
       type: 'commonjs',
     });
 

tests/module/esm/tests/typings.module.test.js

@@ -16,41 +16,11 @@ const tsconfig = {
 };
 
 describe('module esm typings compatibility', () => {
-  it('type-checks esm axios typings', { timeout: 20000 }, () => {
+  it('type-checks esm axios typings', () => {
     const sourcePath = path.join(repoRoot, 'tests/module/esm/tests/helpers/esm-index.ts');
-    const fixturePath = createTempFixture(
+    const fixturePath = createTempFixture(suiteRoot, 'typings-esm', sourcePath, tsconfig, {
-      suiteRoot,
+      type: 'module',
-      repoRoot,
+    });
-      'typings-esm',
-      sourcePath,
-      tsconfig,
-      {
-        type: 'module',
-      }
-    );
-
-    try {
-      runCommand('node', [tscBin, '--noEmit', '-p', 'tsconfig.json'], { cwd: fixturePath });
-    } finally {
-      cleanupTempFixture(fixturePath);
-    }
-  });
-
-  it('type-checks generic request transformer typings', { timeout: 20000 }, () => {
-    const sourcePath = path.join(
-      repoRoot,
-      'tests/module/esm/tests/helpers/transform-request-typing.ts'
-    );
-    const fixturePath = createTempFixture(
-      suiteRoot,
-      repoRoot,
-      'typings-esm-transform-request',
-      sourcePath,
-      tsconfig,
-      {
-        type: 'module',
-      }
-    );
 
     try {
       runCommand('node', [tscBin, '--noEmit', '-p', 'tsconfig.json'], { cwd: fixturePath });