@elasticpath/component-test-framework 1.0.4 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +2 -2
  2. package/lib/api.d.ts +2 -0
  3. package/lib/api.js +13 -0
  4. package/lib/api.js.map +1 -1
  5. package/package.json +1 -1
package/README.md CHANGED
@@ -4,12 +4,12 @@
4
4
 
5
5
  *With Yarn*
6
6
  ```shell
7
- yarn add --dev @moltin/component-test-framework
7
+ yarn add --dev @elasticpath/component-test-framework
8
8
  ```
9
9
 
10
10
  *With NPM*
11
11
  ```shell
12
- npm install --save-dev @moltin/component-test-framework
12
+ npm install --save-dev @elasticpath/component-test-framework
13
13
  ```
14
14
 
15
15
  ### Usage
package/lib/api.d.ts CHANGED
@@ -8,12 +8,14 @@ declare class Api {
8
8
  private requestMethod;
9
9
  private readonly defaultHeaders;
10
10
  private headers;
11
+ private readonly baseUrl;
11
12
  constructor();
12
13
  private isError;
13
14
  isV3Response(data: V2Response | V3Response): data is V3Response;
14
15
  IsV2Response(data: V2Response | V3Response): data is V2Response;
15
16
  get errors(): Array<Error> | Array<any>;
16
17
  get response(): ApiResponse | ApiArrayResponse;
18
+ validateUrl(endpoint: string): void;
17
19
  get(endpoint: string, abortOnError?: boolean): Promise<void>;
18
20
  post(endpoint: string, payload: ApiPayload, abortOnError?: boolean): Promise<void>;
19
21
  form(endpoint: string, form: FormData, abortOnError?: boolean): Promise<void>;
package/lib/api.js CHANGED
@@ -36,6 +36,7 @@ class Api {
36
36
  this.axiosInstance.interceptors.request.use(AxiosLogger.requestLogger);
37
37
  this.axiosInstance.interceptors.response.use(AxiosLogger.responseLogger);
38
38
  }
39
+ this.baseUrl = CTF_BASE_URL;
39
40
  }
40
41
  isError(response) {
41
42
  return this.axiosResponseObject.isAxiosError !== undefined;
@@ -76,8 +77,16 @@ class Api {
76
77
  }
77
78
  return Object.assign({ status: this.axiosResponseObject.status }, this.axiosResponseObject.data);
78
79
  }
80
+ validateUrl(endpoint) {
81
+ const regex = /(?<!http:)\/{2,}/;
82
+ const fqURL = `${this.baseUrl}${endpoint}`;
83
+ if (regex.test(fqURL)) {
84
+ throw new Error(`invalid URL: ${fqURL}`);
85
+ }
86
+ }
79
87
  get(endpoint, abortOnError = true) {
80
88
  return __awaiter(this, void 0, void 0, function* () {
89
+ this.validateUrl(endpoint);
81
90
  this.requestPath = endpoint;
82
91
  this.requestMethod = 'GET';
83
92
  this.axiosResponseObject = yield this.axiosInstance
@@ -90,6 +99,7 @@ class Api {
90
99
  }
91
100
  post(endpoint, payload, abortOnError = true) {
92
101
  return __awaiter(this, void 0, void 0, function* () {
102
+ this.validateUrl(endpoint);
93
103
  this.requestPath = endpoint;
94
104
  this.requestMethod = 'POST';
95
105
  this.axiosResponseObject = yield this.axiosInstance
@@ -102,6 +112,7 @@ class Api {
102
112
  }
103
113
  form(endpoint, form, abortOnError = true) {
104
114
  return __awaiter(this, void 0, void 0, function* () {
115
+ this.validateUrl(endpoint);
105
116
  this.requestPath = endpoint;
106
117
  this.requestMethod = 'POST';
107
118
  const headers = Object.assign(Object.assign({}, this.headers), form.getHeaders());
@@ -115,6 +126,7 @@ class Api {
115
126
  }
116
127
  put(endpoint, payload, abortOnError = true) {
117
128
  return __awaiter(this, void 0, void 0, function* () {
129
+ this.validateUrl(endpoint);
118
130
  this.requestPath = endpoint;
119
131
  this.requestMethod = 'PUT';
120
132
  this.axiosResponseObject = yield this.axiosInstance
@@ -124,6 +136,7 @@ class Api {
124
136
  }
125
137
  delete(endpoint, payload, abortOnError = true) {
126
138
  return __awaiter(this, void 0, void 0, function* () {
139
+ this.validateUrl(endpoint);
127
140
  this.requestPath = endpoint;
128
141
  this.requestMethod = 'DELETE';
129
142
  // For some reason, axios delete requests specify the payload and headers in the same object
package/lib/api.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,iCAA2F;AAC3F,4CAA2C;AAE3C,+BAA6B;AAG7B,qDAA4C;AAC5C,mCAAkC;AAClC,mCAAqC;AAErC,MAAM,GAAG;IAeP;QACE,MAAM,EAAE,YAAY,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,GAAG,CAAA;QAEvD,IAAI,CAAC,cAAc,GAAG;YACpB,cAAc,EAAE,kBAAkB;SACnC,CAAA;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,cAAc,CAAA;QAElC,IAAI,CAAC,aAAa,GAAG,eAAK,CAAC,MAAM,CAAC;YAChC,OAAO,EAAE,YAAY;YACrB,OAAO,EAAE,IAAI;YACb,mBAAmB,EAAE,2DAA2D,YAAY,EAAE;SAC/F,CAAC,CAAA;QAEF,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAA0B,EAAE,EAAE;YACzE,6CAA6C;YAC7C,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,kBAAkB,CAAA;YAC1C,OAAO,MAAM,CAAA;QACf,CAAC,CAAC,CAAA;QAEF,IAAI,iBAAiB,KAAK,OAAO,EAAE;YACjC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,aAAa,CAAC,CAAA;YACtE,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,cAAc,CAAC,CAAA;SACzE;IACH,CAAC;IAEO,OAAO,CAAC,QAAQ;QACtB,OAAoB,IAAI,CAAC,mBAAoB,CAAC,YAAY,KAAK,SAAS,CAAA;IAC1E,CAAC;IAEM,YAAY,CAAC,IAA6B;QAC/C,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE;YAC1C,OAAO,KAAK,CAAA;SACb;QAED,OAAmB,IAAI,CAAC,UAAU,KAAK,SAAS,CAAA;IAClD,CAAC;IAEM,YAAY,CAAC,IAA6B;QAC/C,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC;IAED,IAAW,MAAM;QACf,oDAAoD;QACpD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACrC,MAAM,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAA;YAC/D,OAAO,IAAI,CAAA;SACZ;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAA;IAClC,CAAC;IAED,IAAW,QAAQ;;QACjB,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE;YAC1C,IAAI,MAAM,CAAA;YAEV,4EAA4E;YAC5E,uBAAuB;YACvB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,MAAM,CAAC,EAAE;gBAC1E,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAA;aACvC;iBAAM;gBACL,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,MAAM,CAAA;aAClD;YAED,OAAO;gBACL,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC;gBAC5B,IAAI,EAAE,MAAA,MAAA,IAAI,CAAC,mBAAmB,0CAAE,QAAQ,0CAAE,IAAI;aAChC,CAAA;SACjB;QAED,uBACE,MAAM,EAAE,IAAI,CAAC,mBAAmB,CAAC,MAAM,IAEpC,IAAI,CAAC,mBAAmB,CAAC,IAAI,EACjC;IACH,CAAC;IAEY,GAAG,CAAC,QAAgB,EAAE,eAAwB,IAAI;;YAC7D,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAA;YAC3B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;YAE1B,IAAI,CAAC,mBAAmB,GAAG,MAAM,IAAI,CAAC,aAAa;iBAChD,GAAG,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;iBACxC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YAE/C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE;gBACtF,wBAAa,CAAC,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;aACnD;QACH,CAAC;KAAA;IAEY,IAAI,CAAC,QAAgB,EAAE,OAAmB,EAAE,eAAwB,IAAI;;YACnF,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAA;YAC3B,IAAI,CAAC,aAAa,GAAG,MAAM,CAAA;YAE3B,IAAI,CAAC,mBAAmB,GAAG,MAAM,IAAI,CAAC,aAAa;iBAChD,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;iBAClD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YAE/C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE;gBAC3C,wBAAa,CAAC,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;aACnD;QACH,CAAC;KAAA;IAEY,IAAI,CAAC,QAAgB,EAAE,IAAc,EAAE,eAAwB,IAAI;;YAC9E,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAA;YAC3B,IAAI,CAAC,aAAa,GAAG,MAAM,CAAA;YAC3B,MAAM,OAAO,mCAAQ,IAAI,CAAC,OAAO,GAAK,IAAI,CAAC,UAAU,EAAE,CAAE,CAAA;YAEzD,IAAI,CAAC,mBAAmB,GAAG,MAAM,IAAI,CAAC,aAAa;iBAChD,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC;iBACjC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YAE/C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE;gBAC3C,wBAAa,CAAC,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;aACnD;QACH,CAAC;KAAA;IAEY,GAAG,CAAC,QAAgB,EAAE,OAAmB,EAAE,eAAwB,IAAI;;YAClF,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAA;YAC3B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;YAE1B,IAAI,CAAC,mBAAmB,GAAG,MAAM,IAAI,CAAC,aAAa;iBAChD,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;iBACjD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;QACjD,CAAC;KAAA;IAEY,MAAM,CAAC,QAAgB,EAAE,OAAoB,EAAE,eAAwB,IAAI;;YACtF,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAA;YAC3B,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAA;YAC7B,4FAA4F;YAC5F,MAAM,MAAM,mCACP,OAAO,GACP,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAC7B,CAAA;YAED,IAAI,CAAC,mBAAmB,GAAG,MAAM,IAAI,CAAC,aAAa;iBAChD,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;iBACxB,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;QACjD,CAAC;KAAA;IAED,8EAA8E;IAC9E,2GAA2G;IACpG,UAAU,CAAC,UAAkB,EAAE,QAAiB,KAAK,EAAE,oBAA6B,KAAK;QAC9F,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;SAClB;QAED,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACvC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;YAChB,IAAI,CAAC,iBAAiB,EAAE;gBACtB,KAAK,GAAG,IAAA,mBAAW,EAAC,KAAK,CAAC,CAAA;aAC3B;YACD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE;gBACjC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK;aACd,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAEM,YAAY,CAAC,GAAW;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IAC1B,CAAC;IAEO,IAAI,CAAC,KAAiB,EAAE,YAAqB;QACnD,IAAI,YAAY,EAAE;YAChB,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YACzB,aAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;SAC3B;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAEO,aAAa,CAAC,KAAU;;QAC9B,IAAI,KAAK,CAAC,QAAQ,EAAE;YAClB,MAAM,CAAC,KAAK,CACV,qBAAqB,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,EAAE,CACvG,CAAA;YAED,IAAI,CAAA,MAAA,MAAA,KAAK,CAAC,QAAQ,0CAAE,IAAI,0CAAE,MAAM,MAAK,SAAS,EAAE;gBAC9C,MAAM,CAAC,KAAK,CAAC,MAAA,MAAA,KAAK,CAAC,QAAQ,0CAAE,IAAI,0CAAE,MAAM,CAAC,CAAA;aAC3C;SACF;aAAM;YACL,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;SAC3C;IACH,CAAC;IAED,kDAAkD;IAC1C,OAAO,CAAC,QAAuB;QACrC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE;YAClB,OAAO,IAAI,CAAA;SACZ;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YACrC,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;gBACnC,OAAO,IAAI,CAAA;aACZ;SACF;aAAM,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;YACvD,OAAO,IAAI,CAAA;SACZ;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,kBAAe,GAAG,CAAA","sourcesContent":["import Axios, { AxiosInstance, AxiosError, AxiosResponse, AxiosRequestConfig } from 'axios'\nimport * as AxiosLogger from 'axios-logger'\nimport * as FormData from 'form-data'\nimport { expect } from 'chai'\n\nimport { ApiPayload, ApiResponse, ApiArrayResponse, Error, V2Response, V3Response } from './api.interfaces'\nimport ResourceStore from './resource_store'\nimport * as Logger from './logger'\nimport { nullOrValue } from './utils'\n\nclass Api {\n public axiosInstance: AxiosInstance\n\n private axiosResponseObject: AxiosResponse | AxiosError\n\n private requestPath: string\n\n private requestMethod: string\n\n // We can't add this to the interceptors because we sometimes\n // need to overwrite this\n private readonly defaultHeaders: object\n\n private headers: object\n\n public constructor() {\n const { CTF_BASE_URL, CTF_LOGGING_LEVEL } = process.env\n\n this.defaultHeaders = {\n 'content-type': 'application/json',\n }\n this.headers = this.defaultHeaders\n\n this.axiosInstance = Axios.create({\n baseURL: CTF_BASE_URL,\n timeout: 4000,\n timeoutErrorMessage: `[Fail] Api request timed out. Is the service running on ${CTF_BASE_URL}`,\n })\n\n this.axiosInstance.interceptors.request.use((config: AxiosRequestConfig) => {\n // eslint-disable-next-line no-param-reassign\n config.headers.accept = 'application/json'\n return config\n })\n\n if (CTF_LOGGING_LEVEL === 'debug') {\n this.axiosInstance.interceptors.request.use(AxiosLogger.requestLogger)\n this.axiosInstance.interceptors.response.use(AxiosLogger.responseLogger)\n }\n }\n\n private isError(response): response is AxiosError {\n return (<AxiosError>this.axiosResponseObject).isAxiosError !== undefined\n }\n\n public isV3Response(data: V2Response | V3Response): data is V3Response {\n if (this.isError(this.axiosResponseObject)) {\n return false\n }\n\n return <V3Response>data.attributes !== undefined\n }\n\n public IsV2Response(data: V2Response | V3Response): data is V2Response {\n return !this.isV3Response(data)\n }\n\n public get errors(): Array<Error> | Array<any> {\n // Response data is never an array if there's errors\n if (Array.isArray(this.response.data)) {\n Logger.error('Attempted to access errors on an array response')\n return null\n }\n\n return this.response.data.errors\n }\n\n public get response(): ApiResponse | ApiArrayResponse {\n if (this.isError(this.axiosResponseObject)) {\n let status\n\n // Status exists in a different place depending on an API request failure or\n // a general AxiosError\n if (Object.prototype.hasOwnProperty.call(this.axiosResponseObject, 'code')) {\n status = this.axiosResponseObject.code\n } else {\n status = this.axiosResponseObject.response.status\n }\n\n return {\n status: parseInt(status, 10),\n data: this.axiosResponseObject?.response?.data,\n } as ApiResponse\n }\n\n return {\n status: this.axiosResponseObject.status,\n // add everything else from the response\n ...this.axiosResponseObject.data,\n }\n }\n\n public async get(endpoint: string, abortOnError: boolean = true): Promise<void> {\n this.requestPath = endpoint\n this.requestMethod = 'GET'\n\n this.axiosResponseObject = await this.axiosInstance\n .get(endpoint, { headers: this.headers })\n .catch((err) => this.fail(err, abortOnError))\n\n if (!this.isError(this.axiosResponseObject) && !this.isEmpty(this.axiosResponseObject)) {\n ResourceStore.Store(this.axiosResponseObject.data)\n }\n }\n\n public async post(endpoint: string, payload: ApiPayload, abortOnError: boolean = true): Promise<void> {\n this.requestPath = endpoint\n this.requestMethod = 'POST'\n\n this.axiosResponseObject = await this.axiosInstance\n .post(endpoint, payload, { headers: this.headers })\n .catch((err) => this.fail(err, abortOnError))\n\n if (!this.isError(this.axiosResponseObject)) {\n ResourceStore.Store(this.axiosResponseObject.data)\n }\n }\n\n public async form(endpoint: string, form: FormData, abortOnError: boolean = true): Promise<void> {\n this.requestPath = endpoint\n this.requestMethod = 'POST'\n const headers = { ...this.headers, ...form.getHeaders() }\n\n this.axiosResponseObject = await this.axiosInstance\n .post(endpoint, form, { headers })\n .catch((err) => this.fail(err, abortOnError))\n\n if (!this.isError(this.axiosResponseObject)) {\n ResourceStore.Store(this.axiosResponseObject.data)\n }\n }\n\n public async put(endpoint: string, payload: ApiPayload, abortOnError: boolean = true): Promise<void> {\n this.requestPath = endpoint\n this.requestMethod = 'PUT'\n\n this.axiosResponseObject = await this.axiosInstance\n .put(endpoint, payload, { headers: this.headers })\n .catch((err) => this.fail(err, abortOnError))\n }\n\n public async delete(endpoint: string, payload?: ApiPayload, abortOnError: boolean = true): Promise<void> {\n this.requestPath = endpoint\n this.requestMethod = 'DELETE'\n // For some reason, axios delete requests specify the payload and headers in the same object\n const config = {\n ...payload,\n ...{ headers: this.headers },\n }\n\n this.axiosResponseObject = await this.axiosInstance\n .delete(endpoint, config)\n .catch((err) => this.fail(err, abortOnError))\n }\n\n // setHeaders will merge the new headers with the current ones, overwriting if\n // the same key exists. The value will use nullOrValue to properly map strings to literals ('null' => null)\n public setHeaders(newHeaders: object, reset: boolean = false, preserveValueType: boolean = false): void {\n if (reset) {\n this.headers = {}\n }\n\n Object.entries(newHeaders).forEach((h) => {\n let value = h[1]\n if (!preserveValueType) {\n value = nullOrValue(value)\n }\n return Object.assign(this.headers, {\n [h[0]]: value,\n })\n })\n }\n\n public deleteHeader(key: string) {\n delete this.headers[key]\n }\n\n private fail(error: AxiosError, abortOnError: boolean): AxiosError {\n if (abortOnError) {\n this.beautifyError(error)\n expect.fail(error.message)\n }\n\n return error\n }\n\n private beautifyError(error: any): void {\n if (error.response) {\n Logger.error(\n `Failed requesting ${this.requestMethod.toUpperCase()} ${process.env.CTF_BASE_URL}${this.requestPath}`,\n )\n\n if (error.response?.data?.errors !== undefined) {\n Logger.error(error.response?.data?.errors)\n }\n } else {\n Logger.error('[FATAL ERROR]', error, '\\n')\n }\n }\n\n // eslint-disable-next-line class-methods-use-this\n private isEmpty(response: AxiosResponse): boolean {\n if (!response.data) {\n return true\n }\n\n if (Array.isArray(response.data.data)) {\n if (response.data.data.length === 0) {\n return true\n }\n } else if (Object.keys(response.data.data).length === 0) {\n return true\n }\n\n return false\n }\n}\n\nexport default Api\n"]}
1
+ {"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,iCAA2F;AAC3F,4CAA2C;AAE3C,+BAA6B;AAG7B,qDAA4C;AAC5C,mCAAkC;AAClC,mCAAqC;AAErC,MAAM,GAAG;IAiBP;QACE,MAAM,EAAE,YAAY,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,GAAG,CAAA;QAEvD,IAAI,CAAC,cAAc,GAAG;YACpB,cAAc,EAAE,kBAAkB;SACnC,CAAA;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,cAAc,CAAA;QAElC,IAAI,CAAC,aAAa,GAAG,eAAK,CAAC,MAAM,CAAC;YAChC,OAAO,EAAE,YAAY;YACrB,OAAO,EAAE,IAAI;YACb,mBAAmB,EAAE,2DAA2D,YAAY,EAAE;SAC/F,CAAC,CAAA;QAEF,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAA0B,EAAE,EAAE;YACzE,6CAA6C;YAC7C,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,kBAAkB,CAAA;YAC1C,OAAO,MAAM,CAAA;QACf,CAAC,CAAC,CAAA;QAEF,IAAI,iBAAiB,KAAK,OAAO,EAAE;YACjC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,aAAa,CAAC,CAAA;YACtE,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,cAAc,CAAC,CAAA;SACzE;QAED,IAAI,CAAC,OAAO,GAAG,YAAY,CAAA;IAC7B,CAAC;IAEO,OAAO,CAAC,QAAQ;QACtB,OAAoB,IAAI,CAAC,mBAAoB,CAAC,YAAY,KAAK,SAAS,CAAA;IAC1E,CAAC;IAEM,YAAY,CAAC,IAA6B;QAC/C,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE;YAC1C,OAAO,KAAK,CAAA;SACb;QAED,OAAmB,IAAI,CAAC,UAAU,KAAK,SAAS,CAAA;IAClD,CAAC;IAEM,YAAY,CAAC,IAA6B;QAC/C,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC;IAED,IAAW,MAAM;QACf,oDAAoD;QACpD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACrC,MAAM,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAA;YAC/D,OAAO,IAAI,CAAA;SACZ;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAA;IAClC,CAAC;IAED,IAAW,QAAQ;;QACjB,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE;YAC1C,IAAI,MAAM,CAAA;YAEV,4EAA4E;YAC5E,uBAAuB;YACvB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,MAAM,CAAC,EAAE;gBAC1E,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAA;aACvC;iBAAM;gBACL,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,MAAM,CAAA;aAClD;YAED,OAAO;gBACL,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC;gBAC5B,IAAI,EAAE,MAAA,MAAA,IAAI,CAAC,mBAAmB,0CAAE,QAAQ,0CAAE,IAAI;aAChC,CAAA;SACjB;QAED,uBACE,MAAM,EAAE,IAAI,CAAC,mBAAmB,CAAC,MAAM,IAEpC,IAAI,CAAC,mBAAmB,CAAC,IAAI,EACjC;IACH,CAAC;IAEM,WAAW,CAAC,QAAgB;QACjC,MAAM,KAAK,GAAG,kBAAkB,CAAA;QAChC,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,OAAO,GAAG,QAAQ,EAAE,CAAA;QAE1C,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,gBAAgB,KAAK,EAAE,CAAC,CAAA;SACzC;IACH,CAAC;IAEY,GAAG,CAAC,QAAgB,EAAE,eAAwB,IAAI;;YAC7D,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;YAC1B,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAA;YAC3B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;YAE1B,IAAI,CAAC,mBAAmB,GAAG,MAAM,IAAI,CAAC,aAAa;iBAChD,GAAG,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;iBACxC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YAE/C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE;gBACtF,wBAAa,CAAC,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;aACnD;QACH,CAAC;KAAA;IAEY,IAAI,CAAC,QAAgB,EAAE,OAAmB,EAAE,eAAwB,IAAI;;YACnF,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;YAC1B,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAA;YAC3B,IAAI,CAAC,aAAa,GAAG,MAAM,CAAA;YAE3B,IAAI,CAAC,mBAAmB,GAAG,MAAM,IAAI,CAAC,aAAa;iBAChD,IAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;iBAClD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YAE/C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE;gBAC3C,wBAAa,CAAC,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;aACnD;QACH,CAAC;KAAA;IAEY,IAAI,CAAC,QAAgB,EAAE,IAAc,EAAE,eAAwB,IAAI;;YAC9E,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;YAC1B,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAA;YAC3B,IAAI,CAAC,aAAa,GAAG,MAAM,CAAA;YAC3B,MAAM,OAAO,mCAAQ,IAAI,CAAC,OAAO,GAAK,IAAI,CAAC,UAAU,EAAE,CAAE,CAAA;YAEzD,IAAI,CAAC,mBAAmB,GAAG,MAAM,IAAI,CAAC,aAAa;iBAChD,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC;iBACjC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;YAE/C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE;gBAC3C,wBAAa,CAAC,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;aACnD;QACH,CAAC;KAAA;IAEY,GAAG,CAAC,QAAgB,EAAE,OAAmB,EAAE,eAAwB,IAAI;;YAClF,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;YAC1B,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAA;YAC3B,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;YAE1B,IAAI,CAAC,mBAAmB,GAAG,MAAM,IAAI,CAAC,aAAa;iBAChD,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC;iBACjD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;QACjD,CAAC;KAAA;IAEY,MAAM,CAAC,QAAgB,EAAE,OAAoB,EAAE,eAAwB,IAAI;;YACtF,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;YAC1B,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAA;YAC3B,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAA;YAC7B,4FAA4F;YAC5F,MAAM,MAAM,mCACP,OAAO,GACP,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAC7B,CAAA;YAED,IAAI,CAAC,mBAAmB,GAAG,MAAM,IAAI,CAAC,aAAa;iBAChD,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC;iBACxB,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA;QACjD,CAAC;KAAA;IAED,8EAA8E;IAC9E,2GAA2G;IACpG,UAAU,CAAC,UAAkB,EAAE,QAAiB,KAAK,EAAE,oBAA6B,KAAK;QAC9F,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,OAAO,GAAG,EAAE,CAAA;SAClB;QAED,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACvC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;YAChB,IAAI,CAAC,iBAAiB,EAAE;gBACtB,KAAK,GAAG,IAAA,mBAAW,EAAC,KAAK,CAAC,CAAA;aAC3B;YACD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE;gBACjC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK;aACd,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAEM,YAAY,CAAC,GAAW;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;IAC1B,CAAC;IAEO,IAAI,CAAC,KAAiB,EAAE,YAAqB;QACnD,IAAI,YAAY,EAAE;YAChB,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YACzB,aAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;SAC3B;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAEO,aAAa,CAAC,KAAU;;QAC9B,IAAI,KAAK,CAAC,QAAQ,EAAE;YAClB,MAAM,CAAC,KAAK,CACV,qBAAqB,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,EAAE,CACvG,CAAA;YAED,IAAI,CAAA,MAAA,MAAA,KAAK,CAAC,QAAQ,0CAAE,IAAI,0CAAE,MAAM,MAAK,SAAS,EAAE;gBAC9C,MAAM,CAAC,KAAK,CAAC,MAAA,MAAA,KAAK,CAAC,QAAQ,0CAAE,IAAI,0CAAE,MAAM,CAAC,CAAA;aAC3C;SACF;aAAM;YACL,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;SAC3C;IACH,CAAC;IAED,kDAAkD;IAC1C,OAAO,CAAC,QAAuB;QACrC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE;YAClB,OAAO,IAAI,CAAA;SACZ;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YACrC,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;gBACnC,OAAO,IAAI,CAAA;aACZ;SACF;aAAM,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;YACvD,OAAO,IAAI,CAAA;SACZ;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,kBAAe,GAAG,CAAA","sourcesContent":["import Axios, { AxiosInstance, AxiosError, AxiosResponse, AxiosRequestConfig } from 'axios'\nimport * as AxiosLogger from 'axios-logger'\nimport * as FormData from 'form-data'\nimport { expect } from 'chai'\n\nimport { ApiPayload, ApiResponse, ApiArrayResponse, Error, V2Response, V3Response } from './api.interfaces'\nimport ResourceStore from './resource_store'\nimport * as Logger from './logger'\nimport { nullOrValue } from './utils'\n\nclass Api {\n public axiosInstance: AxiosInstance\n\n private axiosResponseObject: AxiosResponse | AxiosError\n\n private requestPath: string\n\n private requestMethod: string\n\n // We can't add this to the interceptors because we sometimes\n // need to overwrite this\n private readonly defaultHeaders: object\n\n private headers: object\n\n private readonly baseUrl: string\n\n public constructor() {\n const { CTF_BASE_URL, CTF_LOGGING_LEVEL } = process.env\n\n this.defaultHeaders = {\n 'content-type': 'application/json',\n }\n this.headers = this.defaultHeaders\n\n this.axiosInstance = Axios.create({\n baseURL: CTF_BASE_URL,\n timeout: 4000,\n timeoutErrorMessage: `[Fail] Api request timed out. Is the service running on ${CTF_BASE_URL}`,\n })\n\n this.axiosInstance.interceptors.request.use((config: AxiosRequestConfig) => {\n // eslint-disable-next-line no-param-reassign\n config.headers.accept = 'application/json'\n return config\n })\n\n if (CTF_LOGGING_LEVEL === 'debug') {\n this.axiosInstance.interceptors.request.use(AxiosLogger.requestLogger)\n this.axiosInstance.interceptors.response.use(AxiosLogger.responseLogger)\n }\n\n this.baseUrl = CTF_BASE_URL\n }\n\n private isError(response): response is AxiosError {\n return (<AxiosError>this.axiosResponseObject).isAxiosError !== undefined\n }\n\n public isV3Response(data: V2Response | V3Response): data is V3Response {\n if (this.isError(this.axiosResponseObject)) {\n return false\n }\n\n return <V3Response>data.attributes !== undefined\n }\n\n public IsV2Response(data: V2Response | V3Response): data is V2Response {\n return !this.isV3Response(data)\n }\n\n public get errors(): Array<Error> | Array<any> {\n // Response data is never an array if there's errors\n if (Array.isArray(this.response.data)) {\n Logger.error('Attempted to access errors on an array response')\n return null\n }\n\n return this.response.data.errors\n }\n\n public get response(): ApiResponse | ApiArrayResponse {\n if (this.isError(this.axiosResponseObject)) {\n let status\n\n // Status exists in a different place depending on an API request failure or\n // a general AxiosError\n if (Object.prototype.hasOwnProperty.call(this.axiosResponseObject, 'code')) {\n status = this.axiosResponseObject.code\n } else {\n status = this.axiosResponseObject.response.status\n }\n\n return {\n status: parseInt(status, 10),\n data: this.axiosResponseObject?.response?.data,\n } as ApiResponse\n }\n\n return {\n status: this.axiosResponseObject.status,\n // add everything else from the response\n ...this.axiosResponseObject.data,\n }\n }\n\n public validateUrl(endpoint: string) {\n const regex = /(?<!http:)\\/{2,}/\n const fqURL = `${this.baseUrl}${endpoint}`\n\n if (regex.test(fqURL)) {\n throw new Error(`invalid URL: ${fqURL}`)\n }\n }\n\n public async get(endpoint: string, abortOnError: boolean = true): Promise<void> {\n this.validateUrl(endpoint)\n this.requestPath = endpoint\n this.requestMethod = 'GET'\n\n this.axiosResponseObject = await this.axiosInstance\n .get(endpoint, { headers: this.headers })\n .catch((err) => this.fail(err, abortOnError))\n\n if (!this.isError(this.axiosResponseObject) && !this.isEmpty(this.axiosResponseObject)) {\n ResourceStore.Store(this.axiosResponseObject.data)\n }\n }\n\n public async post(endpoint: string, payload: ApiPayload, abortOnError: boolean = true): Promise<void> {\n this.validateUrl(endpoint)\n this.requestPath = endpoint\n this.requestMethod = 'POST'\n\n this.axiosResponseObject = await this.axiosInstance\n .post(endpoint, payload, { headers: this.headers })\n .catch((err) => this.fail(err, abortOnError))\n\n if (!this.isError(this.axiosResponseObject)) {\n ResourceStore.Store(this.axiosResponseObject.data)\n }\n }\n\n public async form(endpoint: string, form: FormData, abortOnError: boolean = true): Promise<void> {\n this.validateUrl(endpoint)\n this.requestPath = endpoint\n this.requestMethod = 'POST'\n const headers = { ...this.headers, ...form.getHeaders() }\n\n this.axiosResponseObject = await this.axiosInstance\n .post(endpoint, form, { headers })\n .catch((err) => this.fail(err, abortOnError))\n\n if (!this.isError(this.axiosResponseObject)) {\n ResourceStore.Store(this.axiosResponseObject.data)\n }\n }\n\n public async put(endpoint: string, payload: ApiPayload, abortOnError: boolean = true): Promise<void> {\n this.validateUrl(endpoint)\n this.requestPath = endpoint\n this.requestMethod = 'PUT'\n\n this.axiosResponseObject = await this.axiosInstance\n .put(endpoint, payload, { headers: this.headers })\n .catch((err) => this.fail(err, abortOnError))\n }\n\n public async delete(endpoint: string, payload?: ApiPayload, abortOnError: boolean = true): Promise<void> {\n this.validateUrl(endpoint)\n this.requestPath = endpoint\n this.requestMethod = 'DELETE'\n // For some reason, axios delete requests specify the payload and headers in the same object\n const config = {\n ...payload,\n ...{ headers: this.headers },\n }\n\n this.axiosResponseObject = await this.axiosInstance\n .delete(endpoint, config)\n .catch((err) => this.fail(err, abortOnError))\n }\n\n // setHeaders will merge the new headers with the current ones, overwriting if\n // the same key exists. The value will use nullOrValue to properly map strings to literals ('null' => null)\n public setHeaders(newHeaders: object, reset: boolean = false, preserveValueType: boolean = false): void {\n if (reset) {\n this.headers = {}\n }\n\n Object.entries(newHeaders).forEach((h) => {\n let value = h[1]\n if (!preserveValueType) {\n value = nullOrValue(value)\n }\n return Object.assign(this.headers, {\n [h[0]]: value,\n })\n })\n }\n\n public deleteHeader(key: string) {\n delete this.headers[key]\n }\n\n private fail(error: AxiosError, abortOnError: boolean): AxiosError {\n if (abortOnError) {\n this.beautifyError(error)\n expect.fail(error.message)\n }\n\n return error\n }\n\n private beautifyError(error: any): void {\n if (error.response) {\n Logger.error(\n `Failed requesting ${this.requestMethod.toUpperCase()} ${process.env.CTF_BASE_URL}${this.requestPath}`,\n )\n\n if (error.response?.data?.errors !== undefined) {\n Logger.error(error.response?.data?.errors)\n }\n } else {\n Logger.error('[FATAL ERROR]', error, '\\n')\n }\n }\n\n // eslint-disable-next-line class-methods-use-this\n private isEmpty(response: AxiosResponse): boolean {\n if (!response.data) {\n return true\n }\n\n if (Array.isArray(response.data.data)) {\n if (response.data.data.length === 0) {\n return true\n }\n } else if (Object.keys(response.data.data).length === 0) {\n return true\n }\n\n return false\n }\n}\n\nexport default Api\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@elasticpath/component-test-framework",
3
- "version": "1.0.4",
3
+ "version": "1.0.6",
4
4
  "description": "A framework for component tests written using ts-flow",
5
5
  "main": "./lib/index.js",
6
6
  "directories": {