🤖 Merge PR DefinitelyTyped#67409 Update axios-token-interceptor types…

… - works with old and new versions by @mgdodge * Update axios-token-interceptor types - works with old and new versions * Fix typo in "owners" section of package.json --------- Co-authored-by: Mike Dodge <[email protected]>
team-innovation · Nov 29, 2023 · 2ec8a47 · 2ec8a47
1 parent a8ef356
commit 2ec8a47
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/types/axios-token-interceptor/axios-token-interceptor-tests.ts b/types/axios-token-interceptor/axios-token-interceptor-tests.ts
@@ -1,3 +1,4 @@
+import axios from "axios";
 import tokenProvider = require("axios-token-interceptor");
 
 const getToken = async (): Promise<tokenProvider.Token> => ({
@@ -20,12 +21,14 @@ tokenProvider();
 const validOptions1 = {
     getToken: () => "qwerty",
 };
-tokenProvider(validOptions1); // $ExpectType TokenProvider
+const provider1 = tokenProvider(validOptions1); // $ExpectType TokenProvider
+axios.interceptors.request.use(provider1);
 
 const validOptions2 = {
     getToken: () => Promise.resolve("qwerty"),
 };
-tokenProvider(validOptions2); // $ExpectType TokenProvider
+const provider2 = tokenProvider(validOptions2); // $ExpectType TokenProvider
+axios.interceptors.request.use(provider2);
 
 // @ts-expect-error
 tokenProvider.tokenCache();

diff --git a/types/axios-token-interceptor/index.d.ts b/types/axios-token-interceptor/index.d.ts
@@ -1,4 +1,4 @@
-import { AxiosRequestConfig } from "axios";
+import { AxiosInstance } from "axios";
 
 // Module
 declare function AxiosTokenProvider(Options: AxiosTokenProvider.InterceptorOptions): AxiosTokenProvider.TokenProvider;
@@ -18,7 +18,9 @@ declare namespace AxiosTokenProvider {
         expires_in: number;
     }
 
-    type TokenProvider = (config: AxiosRequestConfig) => Promise<AxiosRequestConfig>;
+    type _InterceptorsRequestUseParam = Parameters<AxiosInstance["interceptors"]["request"]["use"]>[0];
+    type InternalAxiosRequestConfig = Parameters<NonNullable<_InterceptorsRequestUseParam>>[0];
+    type TokenProvider = (config: InternalAxiosRequestConfig) => Promise<InternalAxiosRequestConfig>;
 
     interface TokenCacheOptions<T = unknown> {
         getMaxAge?: (() => number) | ((el: T) => number) | undefined;

diff --git a/types/axios-token-interceptor/package.json b/types/axios-token-interceptor/package.json
@@ -14,7 +14,7 @@
     "owners": [
         {
             "name": "Vivint Team Innovation",
-            "githubUsername": "innovation-team"
+            "githubUsername": "team-innovation"
         },
         {
             "name": "Mike Dodge",