feat: remove flexibilty of configuring versioning in axios.defaults

BREAKING CHANGE: withVersioning config is now required

Author: Weffe

src/axios-api-versioning-interceptor.ts

@@ -1,22 +1,20 @@
-import { AxiosRequestConfig } from 'axios';
-import { AxiosWithVersioning, VersioningStrategy, IVersioningConfig } from './types'
+import { AxiosInstance } from 'axios';
+import { VersioningStrategy, IVersioningConfig, } from './types'
+import { AxiosRequestConfigWithVersioning } from './axios.types';
 
 function replaceUrlPathWithVersion(url: string, apiVersion: string) {
     // the template name of the api version must be "apiVersion"
     return url.replace('{apiVersion}', apiVersion);
 }
 
-function enhanceConfigByVersioningStrategy(instance: AxiosWithVersioning, requestConfig: AxiosRequestConfig, versioningConfig: IVersioningConfig): AxiosRequestConfig {
-    if (instance.defaults.hasOwnProperty('apiVersion') === false && requestConfig['apiVersion'] === undefined) {
-        return requestConfig;
-    }
+function enhanceConfigByVersioningStrategy(requestConfig: AxiosRequestConfigWithVersioning, versioningConfig: IVersioningConfig): AxiosRequestConfigWithVersioning {
 
     // we prioritize the apiVersion passed via the RequestConfig first
-    // then use the global default apiVersion last
-    const apiVersion = requestConfig['apiVersion'] || instance.defaults['apiVersion'];
+    // then use the initial versioningConfig last
+    const apiVersion = requestConfig['apiVersion'] || versioningConfig['apiVersion'];
 
-    // same way here, we prioritize the RequestConfig first then the global defaults
-    const versioningStrategy = requestConfig['versioningStrategy'] || instance.defaults['versioningStrategy'];
+    // same way here, we prioritize the RequestConfig first then the initial defaults
+    const versioningStrategy = requestConfig['versioningStrategy'] || versioningConfig['versioningStrategy'];
 
     if (versioningStrategy === VersioningStrategy.QueryString) {
         requestConfig.params = {
@@ -60,10 +58,10 @@ function enhanceConfigByVersioningStrategy(instance: AxiosWithVersioning, reques
     return requestConfig;
 }
 
-export function injectApiVersioningInterceptor(instance: AxiosWithVersioning, versioningConfig: IVersioningConfig) {
+export function injectApiVersioningInterceptor(instance: AxiosInstance, versioningConfig: IVersioningConfig) {
     // add an interceptor
-    instance.interceptors.request.use((requestConfig) => {
-        const enhancedConfig = enhanceConfigByVersioningStrategy(instance, requestConfig, versioningConfig);
+    instance.interceptors.request.use((requestConfig: AxiosRequestConfigWithVersioning) => {
+        const enhancedConfig = enhanceConfigByVersioningStrategy(requestConfig, versioningConfig);
         return enhancedConfig;
     });
 }

src/axios-api-versioning.ts

@@ -1,37 +1,18 @@
 import axios, { AxiosInstance, AxiosStatic } from 'axios';
-import { AxiosWithVersioning, IWithVersioningConfig, IVersioningConfig } from './types'
+import { AxiosInstanceWithVersioning } from './axios.types';
+import { IWithVersioningConfig, IVersioningConfig } from './types'
 import { injectApiVersioningInterceptor } from './axios-api-versioning-interceptor'
 import { defaultWithVersioningConfig } from './defaultConfig';
 
-export function withVersioning(instance: AxiosInstance | AxiosStatic, config?: IWithVersioningConfig) {
+export function withVersioning(instance: AxiosInstance | AxiosStatic, config: IWithVersioningConfig) {
     // merge default config options
-    const versioningConfig: IWithVersioningConfig = { ...defaultWithVersioningConfig, ...config };
+    const versioningConfig: IVersioningConfig = { ...defaultWithVersioningConfig, ...config };
 
-    // deep clone the instance so we don't affect it in any way
-    let clonedInstance = axios.create(instance.defaults);
-
-    // set up for modifying the instance.defaults object
-    let value: any = {
-        versioningStrategy: versioningConfig.versioningStrategy
-    };
-
-    if (versioningConfig.apiVersion) {
-        value['apiVersion'] = versioningConfig.apiVersion;
-    }
-
-    value = {
-        ...clonedInstance.defaults,
-        ...value
-    }
-
-    // set defaults property to new defaults w/ apiVersion and versioningStrategy
-    Object.defineProperty(clonedInstance, 'defaults', {
-        value,
-        configurable: true,
-    })
+    // clone the instance so we don't affect it in any way
+    let clonedInstance: AxiosInstance = axios.create(instance.defaults);
 
     // add required api versioning interceptor
-    injectApiVersioningInterceptor(clonedInstance as AxiosWithVersioning, versioningConfig as IVersioningConfig);
+    injectApiVersioningInterceptor(clonedInstance, versioningConfig);
 
-    return clonedInstance as AxiosWithVersioning;
+    return clonedInstance as AxiosInstanceWithVersioning;
 }

src/defaultConfig.ts

@@ -1,7 +1,6 @@
-import { IWithVersioningConfig, VersioningStrategy } from './types';
+import { IVersioningConfig, PickPartial } from './types';
 
-export const defaultWithVersioningConfig: IWithVersioningConfig = {
-    versioningStrategy: VersioningStrategy.QueryString,
+export const defaultWithVersioningConfig: PickPartial<IVersioningConfig, "apiVersion" | "versioningStrategy"> = {
     mediaTypeKeyName: 'v',
     queryStringKeyName: 'api-version',
 }