Removed API version from header

Author: jusexton

CHANGELOG.md

@@ -1,5 +1,9 @@
+# 0.4.1
+
+- Removed api version header
 
 # 0.4.0
+
 - Updated API to comply with contact message service v0.6.0
 
 # 0.3.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsextonn/portfolio-api-client",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "NodeJS client for portfolio API",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

src/common/client.ts

@@ -6,7 +6,6 @@ export type Headers = { [headerName: string]: any };
 export interface ClientConfig {
   host: string;
   jwt?: string;
-  version?: string;
 }
 
 export class ClientConfigWrapper {
@@ -27,7 +26,6 @@ export class ClientConfigWrapper {
   get headers(): Headers {
     return {
       Authorization: `Bearer ${this.config.jwt}`,
-      "X-PORTFOLIO-VERSION": this.config.version,
     };
   }
 
@@ -38,10 +36,6 @@ export class ClientConfigWrapper {
   get jwt(): string | undefined {
     return this.config.jwt;
   }
-
-  get version(): string | undefined {
-    return this.config.version;
-  }
 }
 
 export abstract class BaseClient {

src/common/request.ts

@@ -5,7 +5,6 @@
  */
 export interface PortfolioRequest {
   jwt?: string;
-  version?: string;
 }
 
 export interface RequestWithParameters<T> extends PortfolioRequest {

src/common/response.ts

@@ -7,10 +7,16 @@ export interface PortfolioResponse<T = any> {
 export interface Meta {
   message: string;
   errorDetails: ErrorDetail[];
+  paginationDetails: PaginationDetails;
   schemas: { [schemaName: string]: any };
 }
 
 export interface ErrorDetail {
   description: string;
   fieldName: string;
 }
+
+export interface PaginationDetails {
+  page: number;
+  limit: number;
+}

test/client.test.ts

@@ -65,9 +65,4 @@ describe("client config wrapper", () => {
     const headers = configWrapper.headers;
     expect(headers["Authorization"]).toEqual(`Bearer ${config.jwt}`);
   });
-
-  it("should correctly attach version to custom header", () => {
-    const headers = configWrapper.headers;
-    expect(headers["X-PORTFOLIO-VERSION"]).toEqual(config.version);
-  });
 });

test/contact.test.ts

@@ -11,7 +11,6 @@ jest.mock("axios");
 describe("message service", () => {
   const config: ClientConfig = {
     host: "123",
-    version: "v1.0",
     jwt: "123.jwt.abc",
   };
 
@@ -29,7 +28,6 @@ describe("message service", () => {
 
   it("should have expected config", () => {
     expect(client.config.host).toBe(config.host);
-    expect(client.config.version).toBe(config.version);
     expect(client.config.jwt).toBe(config.jwt);
   });