Merge branch 'dev'

Weffe · Weffe · commit 1c7c61cd8976 · 2019-03-01T02:32:58.000-08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,35 +2,40 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-## [1.1.1](https://github.com/Weffe/axios-api-versioning/compare/v1.1.0...v1.1.1) (2019-03-01)
+# [2.0.0](https://github.com/Weffe/axios-api-versioning/compare/v1.1.1...v2.0.0) (2019-03-01)
 
 
 ### Bug Fixes
 
-* properly let users override the Accept header in the req config ([f12e7b8](https://github.com/Weffe/axios-api-versioning/commit/f12e7b8))
+* properly scope versioning types to axios clients with versioning ([648b9fb](https://github.com/Weffe/axios-api-versioning/commit/648b9fb)), closes [#5](https://github.com/Weffe/axios-api-versioning/issues/5)
 
 
+### Features
 
-# Change Log
+* remove flexibilty of configuring versioning in axios.defaults ([3788dfb](https://github.com/Weffe/axios-api-versioning/commit/3788dfb))
 
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-# [1.1.0](https://github.com/Weffe/axios-api-versioning/compare/v1.0.0...v1.1.0) (2019-02-27)
+### BREAKING CHANGES
 
+* withVersioning config is now required
 
-### Features
 
-* add mediaTypeFormatter for manual formatting of Accept Header ([7827b58](https://github.com/Weffe/axios-api-versioning/commit/7827b58))
+## [1.1.1](https://github.com/Weffe/axios-api-versioning/compare/v1.1.0...v1.1.1) (2019-03-01)
+
+### Bug Fixes
 
+* properly let users override the Accept header in the req config ([f12e7b8](https://github.com/Weffe/axios-api-versioning/commit/f12e7b8))
 
 
-# Change Log
+# [1.1.0](https://github.com/Weffe/axios-api-versioning/compare/v1.0.0...v1.1.0) (2019-02-27)
 
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+### Features
 
-# 1.0.0 (2019-02-26)
+* add mediaTypeFormatter for manual formatting of Accept Header ([7827b58](https://github.com/Weffe/axios-api-versioning/commit/7827b58))
 
 
+# 1.0.0 (2019-02-26)
+
 ### Features
 
 * add versioning interceptor ([0c7e187](https://github.com/Weffe/axios-api-versioning/commit/0c7e187))
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ import axios from 'axios';
 import { withVersioning, VersioningStrategy } from 'axios-api-versioning';
 
 // create an axios instance with versioning
-// and supply optional default options
+// and versioning config
 const client = withVersioning(axios, {
     apiVersion: '1.0.0',
     versioningStrategy: VersioningStrategy.QueryString
@@ -67,6 +67,10 @@ You can check them out here:
 
 You can view the changelog [here](./CHANGELOG.md).
 
+## Related Projects
+
+- https://github.com/Microsoft/aspnet-api-versioning
+
 ## License
 
 MIT
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -17,5 +17,9 @@
         - [`VersioningStrategy`](api/types/VersioningStrategy.md)
         - [`MediaTypeFormatterFn`](api/types/MediaTypeFormatterFn.md)
         - [`IWithVersioningConfig`](api/types/IWithVersioningConfig.md)
-        - [`AxiosWithVersioning`](api/types/AxiosWithVersioning.md)
+        - [`AxiosRequestConfigWithVersioning`](api/types/AxiosRequestConfigWithVersioning.md)
+        - [`AxiosAdapterWithVersioning`](api/types/AxiosAdapterWithVersioning.md)
+        - [`AxiosResponseWithVersioning`](api/types/AxiosResponseWithVersioning.md)
+        - [`AxiosErrorWithVersioning`](api/types/AxiosErrorWithVersioning.md)
+        - [`AxiosInstanceWithVersioning`](api/types/AxiosInstanceWithVersioning.md)
 - [Changelog](https://github.com/Weffe/axios-api-versioning/blob/master/CHANGELOG.md)
diff --git a/docs/api/types/AxiosAdapterWithVersioning.md b/docs/api/types/AxiosAdapterWithVersioning.md
@@ -0,0 +1,12 @@
+# `AxiosAdapterWithVersioning`
+
+> [!NOTE]
+> Exported for public use? **No**
+
+```typescript
+import { AxiosPromise } from 'axios';
+
+interface AxiosAdapterWithVersioning {
+    (config: AxiosRequestConfigWithVersioning): AxiosPromise<any>;
+}
+```
diff --git a/docs/api/types/AxiosErrorWithVersioning.md b/docs/api/types/AxiosErrorWithVersioning.md
@@ -0,0 +1,10 @@
+# `AxiosErrorWithVersioning`
+
+> [!NOTE]
+> Exported for public use? **No**
+
+```typescript
+interface AxiosErrorWithVersioning extends Error {
+    config: AxiosRequestConfigWithVersioning;
+}
+```
diff --git a/docs/api/types/AxiosInstanceWithVersioning.md b/docs/api/types/AxiosInstanceWithVersioning.md
@@ -0,0 +1,26 @@
+# `AxiosInstanceWithVersioning`
+
+> [!NOTE]
+> Exported for public use? **No**
+
+```typescript
+import { AxiosPromise, AxiosInterceptorManager } from 'axios';
+
+interface AxiosInstanceWithVersioning {
+    (config: AxiosRequestConfigWithVersioning): AxiosPromise;
+    (url: string, config?: AxiosRequestConfigWithVersioning): AxiosPromise;
+    defaults: AxiosRequestConfigWithVersioning;
+    interceptors: {
+        request: AxiosInterceptorManager<AxiosRequestConfigWithVersioning>;
+        response: AxiosInterceptorManager<AxiosResponseWithVersioning>;
+    };
+    getUri(config?: AxiosRequestConfigWithVersioning): string;
+    request<T = any, R = AxiosResponseWithVersioning<T>>(config: AxiosRequestConfigWithVersioning): Promise<R>;
+    get<T = any, R = AxiosResponseWithVersioning<T>>(url: string, config?: AxiosRequestConfigWithVersioning): Promise<R>;
+    delete<T = any, R = AxiosResponseWithVersioning<T>>(url: string, config?: AxiosRequestConfigWithVersioning): Promise<R>;
+    head<T = any, R = AxiosResponseWithVersioning<T>>(url: string, config?: AxiosRequestConfigWithVersioning): Promise<R>;
+    post<T = any, R = AxiosResponseWithVersioning<T>>(url: string, data?: any, config?: AxiosRequestConfigWithVersioning): Promise<R>;
+    put<T = any, R = AxiosResponseWithVersioning<T>>(url: string, data?: any, config?: AxiosRequestConfigWithVersioning): Promise<R>;
+    patch<T = any, R = AxiosResponseWithVersioning<T>>(url: string, data?: any, config?: AxiosRequestConfigWithVersioning): Promise<R>;
+}
+```
diff --git a/docs/api/types/AxiosRequestConfigWithVersioning.md b/docs/api/types/AxiosRequestConfigWithVersioning.md
@@ -0,0 +1,14 @@
+# `AxiosRequestConfigWithVersioning`
+
+> [!NOTE]
+> Exported for public use? **No**
+
+```typescript
+import { AxiosRequestConfig } from 'axios';
+
+interface AxiosRequestConfigWithVersioning extends AxiosRequestConfig {
+    apiVersion?: string;
+    versioningStrategy?: string;
+    adapter?: AxiosAdapterWithVersioning;
+}
+```
diff --git a/docs/api/types/AxiosResponseWithVersioning.md b/docs/api/types/AxiosResponseWithVersioning.md
@@ -0,0 +1,12 @@
+# `AxiosResponseWithVersioning`
+
+> [!NOTE]
+> Exported for public use? **No**
+
+```typescript
+import { AxiosResponse } from 'axios';
+
+interface AxiosResponseWithVersioning<T = any> extends AxiosResponse {
+    config: AxiosRequestConfigWithVersioning;
+}
+```
diff --git a/docs/api/types/AxiosWithVersioning.md b/docs/api/types/AxiosWithVersioning.md
diff --git a/docs/api/withVersioning.md b/docs/api/withVersioning.md
@@ -8,12 +8,12 @@ import { AxiosInstance, AxiosStatic } from 'axios';
 function withVersioning(
     instance: AxiosInstance | AxiosStatic,
     config?: IWithVersioningConfig
-): AxiosWithVersioning
+): AxiosInstanceWithVersioning
 ```
 
 ## Type References
 
 Here are some quick links to the types that are used in `withVersioning()`.
 
 - [IWithVersioningConfig](api/types/IWithVersioningConfig.md)
-- [AxiosWithVersioning](api/types/AxiosWithVersioning.md)
+- [AxiosInstanceWithVersioning](api/types/AxiosInstanceWithVersioning.md)
diff --git a/docs/default-config-values.md b/docs/default-config-values.md
@@ -12,7 +12,6 @@ default values are.
 import { IWithVersioningConfig, VersioningStrategy }  from 'axios-api-versioning`;
 
 const defaultWithVersioningConfig: IWithVersioningConfig = {
-    versioningStrategy: VersioningStrategy.QueryString,
     mediaTypeKeyName: 'v',
     queryStringKeyName: 'api-version',
 }
diff --git a/docs/guides/basic-usage.md b/docs/guides/basic-usage.md
@@ -7,10 +7,14 @@ Here is an example of very basic usage. It demonstrates creating an axios instan
 
 ```javascript
 import axios from 'axios';
-import { withVersioning } from 'axios-api-versioning';
+import { withVersioning, VersioningStrategy } from 'axios-api-versioning';
 
-// Note: The default VersioningStrategy is QueryString
-const client = withVersioning(axios);
+const config = {
+    apiVersion: '1',
+    versioningStrategy: VersioningStrategy.QueryString
+}
+
+const client = withVersioning(axios, config);
 
 client.get('http://example.com');
 ```
@@ -21,10 +25,14 @@ client.get('http://example.com');
 
 ```typescript
 import axios from 'axios';
-import { withVersioning } from 'axios-api-versioning';
+import { withVersioning, VersioningStrategy, IWithVersioningConfig } from 'axios-api-versioning';
+
+const config: IWithVersioningConfig = {
+    apiVersion: '1',
+    versioningStrategy: VersioningStrategy.QueryString
+}
 
-// Note: The default VersioningStrategy is QueryString
-const client = withVersioning(axios);
+const client = withVersioning(axios, config);
 
 client.get('http://example.com');
 ```
diff --git a/docs/guides/overriding-api-config.md b/docs/guides/overriding-api-config.md
@@ -1,5 +1,7 @@
 # Overriding API Config
 
+## Per Request
+
 You have the ability to override `apiVersion` and `versioningStrategy` on a per request basis.
 
 This can be accomplished by so:
diff --git a/docs/guides/using-axios-create.md b/docs/guides/using-axios-create.md
@@ -15,8 +15,8 @@ const baseClient = axios.create({
     timeout: 5000,
 })
 
-// setting a different default Versioning Strategy
 const client = withVersioning(baseClient, {
+    apiVersion: '1',
     versioningStrategy: VersioningStrategy.MediaType
 });
 
@@ -36,8 +36,8 @@ const baseClient = axios.create({
     timeout: 5000,
 })
 
-// setting a different default Versioning Strategy
 const client = withVersioning(baseClient, {
+    apiVersion: '1',
     versioningStrategy: VersioningStrategy.MediaType
 });
 
@@ -58,7 +58,6 @@ const baseClient = axios.create({
     timeout: 5000,
 })
 
-// setting a different default Versioning Strategy
 const client = withVersioning(baseClient, {
     apiVersion: '1',
     versioningStrategy: VersioningStrategy.UrlPath
diff --git a/docs/quick-start.md b/docs/quick-start.md
@@ -26,7 +26,7 @@ import axios from 'axios';
 import { withVersioning, VersioningStrategy } from 'axios-api-versioning';
 
 // create an axios instance with versioning
-// and supply optional default options
+// and versioning config
 const client = withVersioning(axios, {
     apiVersion: '1.0.0',
     versioningStrategy: VersioningStrategy.QueryString
diff --git a/examples/with-nodejs/package.json b/examples/with-nodejs/package.json
@@ -8,7 +8,7 @@
   },
   "dependencies": {
     "axios": "^0.18.0",
-    "axios-api-versioning": "~1.1.0"
+    "axios-api-versioning": "~2.0.0"
   },
   "devDependencies": {
     "chalk": "^2.4.2",
diff --git a/examples/with-react-typescript/package.json b/examples/with-react-typescript/package.json
@@ -8,7 +8,7 @@
     "@types/react": "16.8.4",
     "@types/react-dom": "16.8.2",
     "axios": "^0.18.0",
-    "axios-api-versioning": "~1.1.0",
+    "axios-api-versioning": "~2.0.0",
     "json-server": "^0.14.2",
     "react": "^16.8.3",
     "react-dom": "^16.8.3",
diff --git a/examples/with-react-typescript/src/api.ts b/examples/with-react-typescript/src/api.ts
@@ -1,11 +1,16 @@
 import axios from 'axios';
-import { withVersioning, VersioningStrategy } from 'axios-api-versioning'
+import { withVersioning, VersioningStrategy, IWithVersioningConfig } from 'axios-api-versioning'
 
 const axiosInstance = axios.create({
     baseURL: 'http://localhost:4000'
 });
 
-const client = withVersioning(axiosInstance);
+const config: IWithVersioningConfig = {
+    apiVersion: '1',
+    versioningStrategy: VersioningStrategy.MediaType,
+}
+
+const client = withVersioning(axiosInstance, config);
 
 /**
  * here we manually set the apiVersion & versioningStrategy on every request
@@ -14,7 +19,6 @@ const client = withVersioning(axiosInstance);
  * If you have an app where you don't need to mix api versions,
  * then set your active version inside the withVersioning()
  */
-
 export function getBooksByQueryString(apiVersion: string) {
     return client.get('books', {
         apiVersion,
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "axios-api-versioning",
   "author": "Rogelio Negrete (Weffe)",
-  "version": "1.1.1",
+  "version": "2.0.0",
   "description": "Adds api versioning for axios",
   "main": "dist/lib/index.js",
   "module": "dist/esm/index.js",
diff --git a/sandbox/main.ts b/sandbox/main.ts
@@ -0,0 +1,13 @@
+import axios from 'axios';
+import { IWithVersioningConfig, VersioningStrategy, withVersioning } from '../src';
+
+const versioningConfig: IWithVersioningConfig = {
+    apiVersion: '1.0',
+    versioningStrategy: VersioningStrategy.UrlPath
+}
+
+const client = withVersioning(axios, versioningConfig);
+
+client.get('hello', {
+    apiVersion: '1'
+})
diff --git a/src/axios-api-versioning-interceptor.ts b/src/axios-api-versioning-interceptor.ts
diff --git a/src/axios-api-versioning.ts b/src/axios-api-versioning.ts
diff --git a/src/axios.types.ts b/src/axios.types.ts
diff --git a/src/defaultConfig.ts b/src/defaultConfig.ts
diff --git a/src/types.ts b/src/types.ts
diff --git a/tsconfig.json b/tsconfig.json
