@elasticpath/component-test-framework 1.0.0

package/README.md

@@ -0,0 +1,147 @@
+## Elasticpath Component Test Framework
+
+### Installation
+
+*With Yarn*
+```shell
+yarn add --dev @moltin/component-test-framework
+```
+
+*With NPM*
+```shell
+npm install --save-dev @moltin/component-test-framework
+```
+
+### Usage
+
+The framework exposes a few classes:
+
+#### Api
+This is the class responsible for communicating with your API. You can use the methods directly, however, it's usually a better idea to have it as a binding.
+
+*Example*
+```javascript
+import { binding, then } from 'cucumber-tsflow'
+import { Api } from 'component-test-framework'
+
+@binding([ Api ])
+export default class MyStepDefinitions {
+    constructor(protected api: Api) {
+    
+    }
+    
+    @then(...)
+    public async myStep(): void {
+      await this.api.get('/products')
+    }
+    
+    ...
+```
+
+### Payloads
+Because everything that comes from the Gherkin language is a string, it's impossible to specify literals such as `null`.
+The framework has a `Payload` class to handle such cases. Whenever you want to send a payload to the API, you can use
+```javascript
+const payload = new Payload(table.hashes()[0])
+```
+
+#### Type conversions
+The framework is clever when it comes to type conversions. Consider the following Gherkin table
+```
+| null | 123 | foo | "" | [{"foo": "bar"}] |
+```
+When sent to the framework, they are all strings
+```javascript
+[ "null", "123", "foo", "\"\"", "[{\"foo\": \"bar\"}]"]
+```
+
+The `new Payload` method does some conversion for us. Here's a mapping of the conversion:
+```
+{
+    "null": null,
+    "123": "123",
+    "foo": "foo",
+    "\"\"": "",
+    "[{"foo": "bar"}]": [{"foo": "bar"}],
+}
+```
+
+You may have noticed the number remains a string. The framework *could* convert that, however there are certain cases
+where you need to keep it as a string (a product upc_ean can be specified like a number but is a string).
+Therefore, the framework introduces a special symbol to force an integer. Given the following gherkin table, the framework will parse the first value as
+an integer and leave the second as a string
+```
+| <i>123 | 456 |
+```
+
+
+### ResourceStore
+When working with the API in your component tests, it's often benificial to reference the last created resource
+
+*Example*
+```
+Given An admin creates a product
+When They get the created product
+```
+For this, we can use the ResourceStore. When ever you use the API module, it stores the resource that was created, or fetched in the resource store.
+Knowing that, we can create our step definition to easily fetch the last created resource
+
+*Example*
+```javascript
+import { ResourceStore } from 'component-test-framework'
+...
+const resource: Resource =  ResourceStore.LastCreated('file')
+```
+
+We can also get all of the resources under one type
+
+*Example*
+```javascript
+import { ResourceStore } from 'component-test-framework'
+...
+const resource =  ResourceStore.FetchByType('file')
+```
+
+And find a resource
+
+*Example*
+```javascript
+import { ResourceStore } from 'component-test-framework'
+...
+const resource =  ResourceStore.Find('file', 'id', 'abc-123')
+```
+
+Each method on the `ResourceStore` returns a `Resource`
+
+### Resource
+This is a representation of a resource. 
+
+```javascript
+const resource = new Resource(data)
+```
+
+These are usually only created by the ResourceStore. However, there are a few public methods
+
+#### asPayload()
+
+Useful if you want to build an update payload for your `PUT` request. If no argument is supplied, then the 
+resource is returned as a payload, which removes attributes not allowed in payloads (relationships) and nullifies 
+values which are string "null"
+
+If an argument is supplied, this function will merge the data from that with the current data
+
+*Example*
+```javascript
+const resource = ResourceStore.LastCreated('hierarchy')
+const payload = resource.asPayload(table.hashes()[0])
+```
+
+### Publishing
+
+Publishing is handled via the GitLab pipeline. On an MR branch, the pipeline checks to see if the version in `package.json` is already
+a published version, and fails if so, letting you know that the version needs to be updated.
+
+Actual publishing happens on a merge to main.
+
+In the event that a rollback is needed, the rollback MR will fail because the version in `package.json` will exist on NPM. To resolve this, 
+you will need to bump the version in `package.json`.

package/lib/api.d.ts

@@ -0,0 +1,28 @@
+import { AxiosInstance } from 'axios';
+import * as FormData from 'form-data';
+import { ApiPayload, ApiResponse, ApiArrayResponse, Error, V2Response, V3Response } from './api.interfaces';
+declare class Api {
+    axiosInstance: AxiosInstance;
+    private axiosResponseObject;
+    private requestPath;
+    private requestMethod;
+    private readonly defaultHeaders;
+    private headers;
+    constructor();
+    private isError;
+    isV3Response(data: V2Response | V3Response): data is V3Response;
+    IsV2Response(data: V2Response | V3Response): data is V2Response;
+    get errors(): Array<Error> | Array<any>;
+    get axiosResponse(): ApiResponse | ApiArrayResponse;
+    get(endpoint: string, abortOnError?: boolean): Promise<void>;
+    post(endpoint: string, payload: ApiPayload, abortOnError?: boolean): Promise<void>;
+    form(endpoint: string, form: FormData, abortOnError?: boolean): Promise<void>;
+    put(endpoint: string, payload: ApiPayload, abortOnError?: boolean): Promise<void>;
+    delete(endpoint: string, payload?: ApiPayload, abortOnError?: boolean): Promise<void>;
+    setHeaders(newHeaders: object, reset?: boolean, preserveValueType?: boolean): void;
+    deleteHeader(key: string): void;
+    private fail;
+    private beautifyError;
+    private isEmpty;
+}
+export default Api;

package/lib/api.interfaces.d.ts

@@ -0,0 +1,42 @@
+export interface Error {
+    status: string;
+    title: string;
+    detail: string;
+}
+export interface V2Response {
+    id: string;
+    type: string;
+    [key: string]: any;
+    errors?: Array<any>;
+}
+export interface V3Response {
+    id: string;
+    type: string;
+    attributes: {
+        [key: string]: any;
+    };
+    relationships?: any;
+    errors?: Array<Error>;
+}
+export interface ApiResponse {
+    status: number;
+    data: V2Response | V3Response;
+}
+interface V2Payload {
+    [key: string]: any;
+}
+interface V3Payload {
+    id?: string;
+    type?: string;
+    attributes: {
+        [key: string]: string;
+    };
+}
+export interface ApiArrayResponse {
+    status: number;
+    data: Array<V2Response> | Array<V3Response>;
+}
+export interface ApiPayload {
+    data: V2Payload | V3Payload;
+}
+export {};

package/lib/api.interfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api.interfaces.js.map

package/lib/api.interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.interfaces.js","sourceRoot":"","sources":["../src/api.interfaces.ts"],"names":[],"mappings":"","sourcesContent":["export interface Error {\n  status: string\n  title: string\n  detail: string\n}\n\nexport interface V2Response {\n  id: string\n  type: string\n  [key: string]: any\n  errors?: Array<any> // V2 has inconsistant error responses\n}\n\nexport interface V3Response {\n  id: string\n  type: string\n  attributes: {\n    [key: string]: any\n  }\n  relationships?: any\n  errors?: Array<Error>\n}\n\nexport interface ApiResponse {\n  status: number\n  data: V2Response | V3Response\n}\n\ninterface V2Payload {\n  [key: string]: any\n}\n\ninterface V3Payload {\n  id?: string\n  type?: string\n  attributes: {\n    [key: string]: string\n  }\n}\n\nexport interface ApiArrayResponse {\n  status: number\n  data: Array<V2Response> | Array<V3Response>\n}\n\nexport interface ApiPayload {\n  data: V2Payload | V3Payload\n}\n"]}

package/lib/api.js

@@ -0,0 +1,191 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = require("axios");
+const AxiosLogger = require("axios-logger");
+const chai_1 = require("chai");
+const resource_store_1 = require("./resource_store");
+const Logger = require("./logger");
+const utils_1 = require("./utils");
+class Api {
+    constructor() {
+        const { CUCUMBER_BASE_URL, CUCUMBER_LOGGING_LEVEL } = process.env;
+        this.defaultHeaders = {
+            'content-type': 'application/json',
+        };
+        this.headers = this.defaultHeaders;
+        this.axiosInstance = axios_1.default.create({
+            baseURL: CUCUMBER_BASE_URL,
+            timeout: 4000,
+            timeoutErrorMessage: `[Fail] Api request timed out. Is the service running on ${CUCUMBER_BASE_URL}`,
+        });
+        this.axiosInstance.interceptors.request.use((config) => {
+            // eslint-disable-next-line no-param-reassign
+            config.headers.accept = 'application/json';
+            return config;
+        });
+        if (CUCUMBER_LOGGING_LEVEL === 'debug') {
+            this.axiosInstance.interceptors.request.use(AxiosLogger.requestLogger);
+            this.axiosInstance.interceptors.response.use(AxiosLogger.responseLogger);
+        }
+    }
+    isError(response) {
+        return this.axiosResponseObject.isAxiosError !== undefined;
+    }
+    isV3Response(data) {
+        if (this.isError(this.axiosResponseObject)) {
+            return false;
+        }
+        return data.attributes !== undefined;
+    }
+    IsV2Response(data) {
+        return !this.isV3Response(data);
+    }
+    get errors() {
+        // Response data is never an array if there's errors
+        if (Array.isArray(this.axiosResponse.data)) {
+            Logger.error('Attempted to access errors on an array response');
+            return null;
+        }
+        return this.axiosResponse.data.errors;
+    }
+    get axiosResponse() {
+        var _a, _b;
+        if (this.isError(this.axiosResponseObject)) {
+            let status;
+            // Status exists in a different place depending on an API request failure or
+            // a general AxiosError
+            if (Object.prototype.hasOwnProperty.call(this.axiosResponseObject, 'code')) {
+                status = this.axiosResponseObject.code;
+            }
+            else {
+                status = this.axiosResponseObject.response.status;
+            }
+            return {
+                status: parseInt(status, 10),
+                data: (_b = (_a = this.axiosResponseObject) === null || _a === void 0 ? void 0 : _a.response) === null || _b === void 0 ? void 0 : _b.data,
+            };
+        }
+        return Object.assign({ status: this.axiosResponseObject.status }, this.axiosResponseObject.data);
+    }
+    get(endpoint, abortOnError = true) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.requestPath = endpoint;
+            this.requestMethod = 'GET';
+            this.axiosResponseObject = yield this.axiosInstance
+                .get(endpoint, { headers: this.headers })
+                .catch((err) => this.fail(err, abortOnError));
+            if (!this.isError(this.axiosResponseObject) && !this.isEmpty(this.axiosResponseObject)) {
+                resource_store_1.default.Store(this.axiosResponseObject.data);
+            }
+        });
+    }
+    post(endpoint, payload, abortOnError = true) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.requestPath = endpoint;
+            this.requestMethod = 'POST';
+            this.axiosResponseObject = yield this.axiosInstance
+                .post(endpoint, payload, { headers: this.headers })
+                .catch((err) => this.fail(err, abortOnError));
+            if (!this.isError(this.axiosResponseObject)) {
+                resource_store_1.default.Store(this.axiosResponseObject.data);
+            }
+        });
+    }
+    form(endpoint, form, abortOnError = true) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.requestPath = endpoint;
+            this.requestMethod = 'POST';
+            const headers = Object.assign(Object.assign({}, this.headers), form.getHeaders());
+            this.axiosResponseObject = yield this.axiosInstance
+                .post(endpoint, form, { headers })
+                .catch((err) => this.fail(err, abortOnError));
+            if (!this.isError(this.axiosResponseObject)) {
+                resource_store_1.default.Store(this.axiosResponseObject.data);
+            }
+        });
+    }
+    put(endpoint, payload, abortOnError = true) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.requestPath = endpoint;
+            this.requestMethod = 'PUT';
+            this.axiosResponseObject = yield this.axiosInstance
+                .put(endpoint, payload, { headers: this.headers })
+                .catch((err) => this.fail(err, abortOnError));
+        });
+    }
+    delete(endpoint, payload, abortOnError = true) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.requestPath = endpoint;
+            this.requestMethod = 'DELETE';
+            // For some reason, axios delete requests specify the payload and headers in the same object
+            const config = Object.assign(Object.assign({}, payload), { headers: this.headers });
+            this.axiosResponseObject = yield this.axiosInstance
+                .delete(endpoint, config)
+                .catch((err) => this.fail(err, abortOnError));
+        });
+    }
+    // setHeaders will merge the new headers with the current ones, overwriting if
+    // the same key exists. The value will use nullOrValue to properly map strings to literals ('null' => null)
+    setHeaders(newHeaders, reset = false, preserveValueType = false) {
+        if (reset) {
+            this.headers = {};
+        }
+        Object.entries(newHeaders).forEach((h) => {
+            let value = h[1];
+            if (!preserveValueType) {
+                value = (0, utils_1.nullOrValue)(value);
+            }
+            return Object.assign(this.headers, {
+                [h[0]]: value,
+            });
+        });
+    }
+    deleteHeader(key) {
+        delete this.headers[key];
+    }
+    fail(error, abortOnError) {
+        if (abortOnError) {
+            this.beautifyError(error);
+            chai_1.expect.fail(error.message);
+        }
+        return error;
+    }
+    beautifyError(error) {
+        var _a, _b, _c, _d;
+        if (error.response) {
+            Logger.error(`Failed requesting ${this.requestMethod.toUpperCase()} ${process.env.CUCUMBER_BASE_URL}${this.requestPath}`);
+            if (((_b = (_a = error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.errors) !== undefined) {
+                Logger.error((_d = (_c = error.response) === null || _c === void 0 ? void 0 : _c.data) === null || _d === void 0 ? void 0 : _d.errors);
+            }
+        }
+        else {
+            Logger.error('[FATAL ERROR]', error, '\n');
+        }
+    }
+    // eslint-disable-next-line class-methods-use-this
+    isEmpty(response) {
+        if (!response.data) {
+            return true;
+        }
+        if (Array.isArray(response.data.data)) {
+            if (response.data.data.length === 0) {
+                return true;
+            }
+        }
+        else if (Object.keys(response.data.data).length === 0) {
+            return true;
+        }
+        return false;
+    }
+}
+exports.default = Api;
+//# sourceMappingURL=api.js.map

package/lib/api.js.map

@@ -0,0 +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,iBAAiB,EAAE,sBAAsB,EAAE,GAAG,OAAO,CAAC,GAAG,CAAA;QAEjE,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,iBAAiB;YAC1B,OAAO,EAAE,IAAI;YACb,mBAAmB,EAAE,2DAA2D,iBAAiB,EAAE;SACpG,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,sBAAsB,KAAK,OAAO,EAAE;YACtC,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,aAAa,CAAC,IAAI,CAAC,EAAE;YAC1C,MAAM,CAAC,KAAK,CAAC,iDAAiD,CAAC,CAAA;YAC/D,OAAO,IAAI,CAAA;SACZ;QAED,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAA;IACvC,CAAC;IAED,IAAW,aAAa;;QACtB,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,iBAAiB,GAAG,IAAI,CAAC,WAAW,EAAE,CAC5G,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 { CUCUMBER_BASE_URL, CUCUMBER_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: CUCUMBER_BASE_URL,\n      timeout: 4000,\n      timeoutErrorMessage: `[Fail] Api request timed out. Is the service running on ${CUCUMBER_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 (CUCUMBER_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.axiosResponse.data)) {\n      Logger.error('Attempted to access errors on an array response')\n      return null\n    }\n\n    return this.axiosResponse.data.errors\n  }\n\n  public get axiosResponse(): 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.CUCUMBER_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/lib/elasticsearch.d.ts

@@ -0,0 +1,6 @@
+import { Client } from '@elastic/elasticsearch';
+export default class Elasticsearch {
+    private readonly elsClient;
+    constructor();
+    get client(): Client;
+}

package/lib/elasticsearch.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const elasticsearch_1 = require("@elastic/elasticsearch");
+const Logger = require("./logger");
+class Elasticsearch {
+    constructor() {
+        if (!process.env.ELS_URL) {
+            Logger.error('No Elasticsearch URL specified');
+            Logger.error('Please update the .env file to provide an ELS_URL');
+            process.exit(1);
+        }
+        this.elsClient = new elasticsearch_1.Client({
+            node: process.env.ELS_URL,
+        });
+    }
+    get client() {
+        return this.elsClient;
+    }
+}
+exports.default = Elasticsearch;
+//# sourceMappingURL=elasticsearch.js.map

package/lib/elasticsearch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"elasticsearch.js","sourceRoot":"","sources":["../src/elasticsearch.ts"],"names":[],"mappings":";;AAAA,0DAA+C;AAC/C,mCAAkC;AAElC,MAAqB,aAAa;IAGhC;QACE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE;YACxB,MAAM,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAA;YAC9C,MAAM,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAA;YACjE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SAChB;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,sBAAM,CAAC;YAC1B,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,OAAO;SAC1B,CAAC,CAAA;IACJ,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;CACF;AAjBD,gCAiBC","sourcesContent":["import { Client } from '@elastic/elasticsearch'\nimport * as Logger from './logger'\n\nexport default class Elasticsearch {\n  private readonly elsClient: Client\n\n  public constructor() {\n    if (!process.env.ELS_URL) {\n      Logger.error('No Elasticsearch URL specified')\n      Logger.error('Please update the .env file to provide an ELS_URL')\n      process.exit(1)\n    }\n    this.elsClient = new Client({\n      node: process.env.ELS_URL,\n    })\n  }\n\n  public get client() {\n    return this.elsClient\n  }\n}\n"]}

package/lib/index.d.ts

@@ -0,0 +1,7 @@
+import Api from './api';
+import MongoDB from './mongodb';
+import Payload from './payload';
+import ResourceStore from './resource_store';
+import { Resource } from './resource';
+import { V2Response, V3Response } from './api.interfaces';
+export { Api, MongoDB, Payload, Resource, ResourceStore, V2Response, V3Response };

package/lib/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceStore = exports.Resource = exports.Payload = exports.MongoDB = exports.Api = void 0;
+const api_1 = require("./api");
+exports.Api = api_1.default;
+const mongodb_1 = require("./mongodb");
+exports.MongoDB = mongodb_1.default;
+const payload_1 = require("./payload");
+exports.Payload = payload_1.default;
+const resource_store_1 = require("./resource_store");
+exports.ResourceStore = resource_store_1.default;
+const resource_1 = require("./resource");
+Object.defineProperty(exports, "Resource", { enumerable: true, get: function () { return resource_1.Resource; } });
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,+BAAuB;AAOd,cAPF,aAAG,CAOE;AANZ,uCAA+B;AAMjB,kBANP,iBAAO,CAMO;AALrB,uCAA+B;AAKR,kBALhB,iBAAO,CAKgB;AAJ9B,qDAA4C;AAIF,wBAJnC,wBAAa,CAImC;AAHvD,yCAAqC;AAGL,yFAHvB,mBAAQ,OAGuB","sourcesContent":["import Api from './api'\nimport MongoDB from './mongodb'\nimport Payload from './payload'\nimport ResourceStore from './resource_store'\nimport { Resource } from './resource'\nimport { V2Response, V3Response } from './api.interfaces'\n\nexport { Api, MongoDB, Payload, Resource, ResourceStore, V2Response, V3Response }\n"]}

package/lib/logger.d.ts

@@ -0,0 +1,2 @@
+export declare const debug: (...stuff: any) => void;
+export declare const error: (...stuff: any) => void;

package/lib/logger.js

@@ -0,0 +1,16 @@
+"use strict";
+/* eslint-disable no-console */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.error = exports.debug = void 0;
+const debug = (...stuff) => {
+    if (process.env.LOG_LEVEL !== 'debug') {
+        return;
+    }
+    console.log(stuff);
+};
+exports.debug = debug;
+const error = (...stuff) => {
+    console.error(...stuff);
+};
+exports.error = error;
+//# sourceMappingURL=logger.js.map

package/lib/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";AAAA,+BAA+B;;;AAExB,MAAM,KAAK,GAAG,CAAC,GAAG,KAAU,EAAQ,EAAE;IAC3C,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,OAAO,EAAE;QACrC,OAAM;KACP;IAED,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;AACpB,CAAC,CAAA;AANY,QAAA,KAAK,SAMjB;AAEM,MAAM,KAAK,GAAG,CAAC,GAAG,KAAU,EAAQ,EAAE;IAC3C,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,CAAA;AACzB,CAAC,CAAA;AAFY,QAAA,KAAK,SAEjB","sourcesContent":["/* eslint-disable no-console */\n\nexport const debug = (...stuff: any): void => {\n  if (process.env.LOG_LEVEL !== 'debug') {\n    return\n  }\n\n  console.log(stuff)\n}\n\nexport const error = (...stuff: any): void => {\n  console.error(...stuff)\n}\n"]}

package/lib/mongodb.d.ts

@@ -0,0 +1,25 @@
+import type { Collection } from 'mongodb';
+export default class MongoDB {
+    private client;
+    /**
+     * Sets up the MongoDB Client
+     */
+    constructor();
+    /**
+     * Connects to the Mongo Database.
+     */
+    connect(): Promise<void>;
+    /**
+     * Returns all MongoDB Collections.
+     */
+    getAllCollections(): Promise<Collection<any>[]>;
+    /**
+     * Returns a specific Collection.
+     */
+    collection(name: string): Collection;
+    /**
+     * Closes the MongoDB connection.
+     * @return Promise<void>
+     */
+    close(): Promise<void>;
+}

package/lib/mongodb.js

@@ -0,0 +1,64 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mongodb_1 = require("mongodb");
+const Logger = require("./logger");
+class MongoDB {
+    /**
+     * Sets up the MongoDB Client
+     */
+    constructor() {
+        if (!process.env.MONGO_DSN) {
+            Logger.error('No Mongo DSN specified');
+            Logger.error('Please update the .env file to provide a MONGO_DSN');
+            process.exit(1);
+        }
+        this.client = new mongodb_1.MongoClient(process.env.MONGO_DSN, {
+            serverSelectionTimeoutMS: 4000,
+        });
+    }
+    /**
+     * Connects to the Mongo Database.
+     */
+    connect() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.client.connect().catch((e) => {
+                Logger.error('Could not connect to MongoDB:', e);
+                process.exit(1);
+            });
+        });
+    }
+    /**
+     * Returns all MongoDB Collections.
+     */
+    getAllCollections() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.db(process.env.MONGO_DB).collections();
+        });
+    }
+    /**
+     * Returns a specific Collection.
+     */
+    collection(name) {
+        return this.client.db(process.env.MONGO_DB).collection(name);
+    }
+    /**
+     * Closes the MongoDB connection.
+     * @return Promise<void>
+     */
+    close() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.client.close();
+        });
+    }
+}
+exports.default = MongoDB;
+//# sourceMappingURL=mongodb.js.map

package/lib/mongodb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mongodb.js","sourceRoot":"","sources":["../src/mongodb.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,qCAAqC;AAErC,mCAAkC;AAElC,MAAqB,OAAO;IAG1B;;OAEG;IACH;QACE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE;YAC1B,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAA;YACtC,MAAM,CAAC,KAAK,CAAC,oDAAoD,CAAC,CAAA;YAClE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SAChB;QAED,IAAI,CAAC,MAAM,GAAG,IAAI,qBAAW,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE;YACnD,wBAAwB,EAAE,IAAI;SAC/B,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACU,OAAO;;YAClB,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;gBACtC,MAAM,CAAC,KAAK,CAAC,+BAA+B,EAAE,CAAC,CAAC,CAAA;gBAChD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACjB,CAAC,CAAC,CAAA;QACJ,CAAC;KAAA;IAED;;OAEG;IACU,iBAAiB;;YAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAA;QAC3D,CAAC;KAAA;IAED;;OAEG;IACI,UAAU,CAAC,IAAY;QAC5B,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;IAC9D,CAAC;IAED;;;OAGG;IACU,KAAK;;YAChB,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QAC3B,CAAC;KAAA;CACF;AAjDD,0BAiDC","sourcesContent":["import { MongoClient } from 'mongodb'\nimport type { Collection } from 'mongodb'\nimport * as Logger from './logger'\n\nexport default class MongoDB {\n  private client: MongoClient\n\n  /**\n   * Sets up the MongoDB Client\n   */\n  public constructor() {\n    if (!process.env.MONGO_DSN) {\n      Logger.error('No Mongo DSN specified')\n      Logger.error('Please update the .env file to provide a MONGO_DSN')\n      process.exit(1)\n    }\n\n    this.client = new MongoClient(process.env.MONGO_DSN, {\n      serverSelectionTimeoutMS: 4000,\n    })\n  }\n\n  /**\n   * Connects to the Mongo Database.\n   */\n  public async connect(): Promise<void> {\n    await this.client.connect().catch((e) => {\n      Logger.error('Could not connect to MongoDB:', e)\n      process.exit(1)\n    })\n  }\n\n  /**\n   * Returns all MongoDB Collections.\n   */\n  public async getAllCollections(): Promise<Collection<any>[]> {\n    return this.client.db(process.env.MONGO_DB).collections()\n  }\n\n  /**\n   * Returns a specific Collection.\n   */\n  public collection(name: string): Collection {\n    return this.client.db(process.env.MONGO_DB).collection(name)\n  }\n\n  /**\n   * Closes the MongoDB connection.\n   * @return Promise<void>\n   */\n  public async close(): Promise<void> {\n    await this.client.close()\n  }\n}\n"]}

package/lib/payload.d.ts

@@ -0,0 +1,7 @@
+interface KeyValue {
+    [key: string]: any;
+}
+declare class Payload {
+    constructor(type: string, data: KeyValue);
+}
+export default Payload;

package/lib/payload.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("./utils");
+// Returns data formatted as a payload, converting string "null" to literal null
+class Payload {
+    constructor(type, data) {
+        const clone = data;
+        if (Object.prototype.hasOwnProperty.call(data, 'attributes')) {
+            Object.keys(data.attributes).forEach((key) => {
+                clone.attributes[key] = (0, utils_1.nullOrValue)(data.attributes[key]);
+            });
+        }
+        else {
+            Object.keys(data).forEach((key) => {
+                clone[key] = (0, utils_1.nullOrValue)(data[key]);
+            });
+        }
+        clone.type = type;
+        // eslint-disable-next-line no-constructor-return
+        return clone;
+    }
+}
+exports.default = Payload;
+//# sourceMappingURL=payload.js.map

package/lib/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../src/payload.ts"],"names":[],"mappings":";;AAAA,mCAAqC;AAMrC,gFAAgF;AAChF,MAAM,OAAO;IACX,YAAY,IAAY,EAAE,IAAc;QACtC,MAAM,KAAK,GAAG,IAAI,CAAA;QAElB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE;YAC5D,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC3C,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,IAAA,mBAAW,EAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAA;YAC3D,CAAC,CAAC,CAAA;SACH;aAAM;YACL,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAChC,KAAK,CAAC,GAAG,CAAC,GAAG,IAAA,mBAAW,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;YACrC,CAAC,CAAC,CAAA;SACH;QAED,KAAK,CAAC,IAAI,GAAG,IAAI,CAAA;QAEjB,iDAAiD;QACjD,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAED,kBAAe,OAAO,CAAA","sourcesContent":["import { nullOrValue } from './utils'\n\ninterface KeyValue {\n  [key: string]: any\n}\n\n// Returns data formatted as a payload, converting string \"null\" to literal null\nclass Payload {\n  constructor(type: string, data: KeyValue) {\n    const clone = data\n\n    if (Object.prototype.hasOwnProperty.call(data, 'attributes')) {\n      Object.keys(data.attributes).forEach((key) => {\n        clone.attributes[key] = nullOrValue(data.attributes[key])\n      })\n    } else {\n      Object.keys(data).forEach((key) => {\n        clone[key] = nullOrValue(data[key])\n      })\n    }\n\n    clone.type = type\n\n    // eslint-disable-next-line no-constructor-return\n    return clone\n  }\n}\n\nexport default Payload\n"]}

package/lib/resource.d.ts

@@ -0,0 +1,15 @@
+interface Attributes {
+    [key: string]: any;
+}
+export interface ResourceData {
+    id: string;
+    type: string;
+    attributes?: Attributes;
+    [key: string]: any;
+}
+export declare class Resource {
+    data: ResourceData;
+    constructor(type: string, attributes: any);
+    asPayload(updateAttributes?: Attributes): ResourceData;
+}
+export {};

package/lib/resource.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Resource = void 0;
+const utils_1 = require("./utils");
+class Resource {
+    constructor(type, attributes) {
+        this.data = Object.assign({ type }, attributes);
+        // eslint-disable-next-line no-constructor-return
+        return this;
+    }
+    // Returns the resource as a payload, removing all attributes that cannot appear
+    // in a payload, as well as converting values from string "null" to literal null
+    asPayload(updateAttributes) {
+        var _a, _b;
+        (_a = this.data) === null || _a === void 0 ? true : delete _a.meta;
+        (_b = this.data) === null || _b === void 0 ? true : delete _b.relationships;
+        if (!updateAttributes) {
+            return this.data;
+        }
+        const clonedUpdate = updateAttributes;
+        // Loop through all update attributes and nullify the key
+        // if its value is string "null"
+        Object.keys(updateAttributes).forEach((key) => {
+            clonedUpdate[key] = (0, utils_1.nullOrValue)(updateAttributes[key]);
+        });
+        const clone = this.data;
+        // For those test cases where you want to remove or change these
+        // attributes to assert an error
+        if (Object.prototype.hasOwnProperty.call(clonedUpdate, 'id')) {
+            this.data.id = clonedUpdate.id;
+            delete clonedUpdate.id; // so we don't put it in the attributes
+        }
+        if (Object.prototype.hasOwnProperty.call(clonedUpdate, 'type')) {
+            this.data.type = updateAttributes.type;
+            delete clonedUpdate.type; // so we don't put it in the attributes
+        }
+        if (Object.prototype.hasOwnProperty.call(this.data, 'attributes')) {
+            this.data.attributes = Object.assign(clone.attributes, clonedUpdate);
+        }
+        else {
+            this.data = Object.assign(clone, clonedUpdate);
+        }
+        return this.data;
+    }
+}
+exports.Resource = Resource;
+//# sourceMappingURL=resource.js.map

package/lib/resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource.js","sourceRoot":"","sources":["../src/resource.ts"],"names":[],"mappings":";;;AAAA,mCAAqC;AAcrC,MAAa,QAAQ;IAGnB,YAAY,IAAY,EAAE,UAAe;QACvC,IAAI,CAAC,IAAI,mBACP,IAAI,IACD,UAAU,CACd,CAAA;QACD,iDAAiD;QACjD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,gFAAgF;IAChF,gFAAgF;IACzE,SAAS,CAAC,gBAA6B;;QACrC,MAAA,IAAI,CAAC,IAAI,+CAAE,IAAI,CAAA;QACf,MAAA,IAAI,CAAC,IAAI,+CAAE,aAAa,CAAA;QAE/B,IAAI,CAAC,gBAAgB,EAAE;YACrB,OAAO,IAAI,CAAC,IAAI,CAAA;SACjB;QAED,MAAM,YAAY,GAAG,gBAAgB,CAAA;QAErC,yDAAyD;QACzD,gCAAgC;QAChC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAC5C,YAAY,CAAC,GAAG,CAAC,GAAG,IAAA,mBAAW,EAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAA;QACxD,CAAC,CAAC,CAAA;QAEF,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAA;QAEvB,gEAAgE;QAChE,gCAAgC;QAChC,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE;YAC5D,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,YAAY,CAAC,EAAE,CAAA;YAC9B,OAAO,YAAY,CAAC,EAAE,CAAA,CAAC,uCAAuC;SAC/D;QAED,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,EAAE;YAC9D,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC,IAAI,CAAA;YACtC,OAAO,YAAY,CAAC,IAAI,CAAA,CAAC,uCAAuC;SACjE;QAED,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE;YACjE,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,YAAY,CAAC,CAAA;SACrE;aAAM;YACL,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;SAC/C;QAED,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;CACF;AApDD,4BAoDC","sourcesContent":["import { nullOrValue } from './utils'\n\ninterface Attributes {\n  [key: string]: any\n}\n\nexport interface ResourceData {\n  id: string\n  type: string\n  attributes?: Attributes\n  // Allow for V2 resources\n  [key: string]: any\n}\n\nexport class Resource {\n  public data: ResourceData\n\n  constructor(type: string, attributes: any) {\n    this.data = {\n      type,\n      ...attributes,\n    }\n    // eslint-disable-next-line no-constructor-return\n    return this\n  }\n\n  // Returns the resource as a payload, removing all attributes that cannot appear\n  // in a payload, as well as converting values from string \"null\" to literal null\n  public asPayload(updateAttributes?: Attributes) {\n    delete this.data?.meta\n    delete this.data?.relationships\n\n    if (!updateAttributes) {\n      return this.data\n    }\n\n    const clonedUpdate = updateAttributes\n\n    // Loop through all update attributes and nullify the key\n    // if its value is string \"null\"\n    Object.keys(updateAttributes).forEach((key) => {\n      clonedUpdate[key] = nullOrValue(updateAttributes[key])\n    })\n\n    const clone = this.data\n\n    // For those test cases where you want to remove or change these\n    // attributes to assert an error\n    if (Object.prototype.hasOwnProperty.call(clonedUpdate, 'id')) {\n      this.data.id = clonedUpdate.id\n      delete clonedUpdate.id // so we don't put it in the attributes\n    }\n\n    if (Object.prototype.hasOwnProperty.call(clonedUpdate, 'type')) {\n      this.data.type = updateAttributes.type\n      delete clonedUpdate.type // so we don't put it in the attributes\n    }\n\n    if (Object.prototype.hasOwnProperty.call(this.data, 'attributes')) {\n      this.data.attributes = Object.assign(clone.attributes, clonedUpdate)\n    } else {\n      this.data = Object.assign(clone, clonedUpdate)\n    }\n\n    return this.data\n  }\n}\n"]}

package/lib/resource_store.d.ts

@@ -0,0 +1,19 @@
+import { ApiResponse, ApiArrayResponse } from './api.interfaces';
+import { ResourceData, Resource } from './resource';
+export default class ResourceStore {
+    private static resources;
+    static FetchByType(type: string): ResourceData;
+    /**
+     * Finds the resource by looking for the key and value
+     * @param type {string} the type of resource
+     * @param key {string} a JSON path string. Eg: attributes.name
+     * @param value {any} the value to look for
+     * @return {Resource | undefined}
+     */
+    static Find(type: string, key: string, value: any): Resource;
+    static LastCreated(type: string): ResourceData;
+    private static isArrayResponse;
+    static Store(responses: ApiResponse | ApiArrayResponse): void;
+    static Clear(): void;
+    private static getResourceType;
+}

package/lib/resource_store.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const resource_1 = require("./resource");
+class ResourceStore {
+    static FetchByType(type) {
+        return this.resources[type];
+    }
+    /**
+     * Finds the resource by looking for the key and value
+     * @param type {string} the type of resource
+     * @param key {string} a JSON path string. Eg: attributes.name
+     * @param value {any} the value to look for
+     * @return {Resource | undefined}
+     */
+    static Find(type, key, value) {
+        const resources = this.resources[type] || [];
+        return resources.find((resource) => {
+            let target = resource;
+            if (key.indexOf('.') > -1) {
+                target = key.split('.').reduce((original, i) => original === null || original === void 0 ? void 0 : original[i], target);
+            }
+            else {
+                target = resource[key];
+            }
+            return target === value;
+        });
+    }
+    /*
+      Returns the last created resource
+      @param type string The type of the resource, eg: product
+      @return The Resource
+     */
+    static LastCreated(type) {
+        const resources = this.resources[type] || [];
+        return resources[resources.length - 1];
+    }
+    static isArrayResponse(responses) {
+        var _a;
+        return ((_a = responses === null || responses === void 0 ? void 0 : responses.data) === null || _a === void 0 ? void 0 : _a.length) !== undefined;
+    }
+    static Store(responses) {
+        const type = this.getResourceType(responses);
+        if (!Object.prototype.hasOwnProperty.call(this.resources, type)) {
+            this.resources[type] = [];
+        }
+        if (this.isArrayResponse(responses)) {
+            ;
+            responses.data.forEach((data) => {
+                const resource = new resource_1.Resource(type, data);
+                this.resources[type].push(resource.data);
+            });
+        }
+        else {
+            const resource = new resource_1.Resource(type, responses.data);
+            this.resources[type].push(resource.data);
+        }
+    }
+    static Clear() {
+        this.resources = [];
+    }
+    // Gets the type of the resource, taking in to account an array API response, where it will
+    // infer the type from the first object
+    static getResourceType(responses) {
+        var _a;
+        if (this.isArrayResponse(responses)) {
+            if (responses.data[0] === undefined) {
+                chai_1.expect.fail('Could not find any resources in the response');
+            }
+            return (_a = responses.data[0]) === null || _a === void 0 ? void 0 : _a.type;
+        }
+        if (responses.data === undefined) {
+            chai_1.expect.fail('Could not a resource in the response');
+        }
+        return responses.data.type;
+    }
+}
+// Contains a list of resources (singular keys for the resource type eg: flow/product)
+ResourceStore.resources = [];
+exports.default = ResourceStore;
+//# sourceMappingURL=resource_store.js.map

package/lib/resource_store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource_store.js","sourceRoot":"","sources":["../src/resource_store.ts"],"names":[],"mappings":";;AAAA,+BAA6B;AAG7B,yCAAmD;AAEnD,MAAqB,aAAa;IAIzB,MAAM,CAAC,WAAW,CAAC,IAAY;QACpC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IAC7B,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,IAAI,CAAC,IAAY,EAAE,GAAW,EAAE,KAAU;QACtD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;QAE5C,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjC,IAAI,MAAM,GAAG,QAAQ,CAAA;YACrB,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE;gBACzB,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;aACvE;iBAAM;gBACL,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAA;aACvB;YAED,OAAO,MAAM,KAAK,KAAK,CAAA;QACzB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,WAAW,CAAC,IAAY;QACpC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;QAC5C,OAAO,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACxC,CAAC;IAEO,MAAM,CAAC,eAAe,CAAC,SAAyC;;QACtE,OAAO,CAAA,MAAC,SAA8B,aAA9B,SAAS,uBAAT,SAAS,CAAuB,IAAI,0CAAE,MAAM,MAAK,SAAS,CAAA;IACpE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,SAAyC;QAC3D,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAA;QAE5C,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE;YAC/D,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,CAAA;SAC1B;QAED,IAAI,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,EAAE;YACnC,CAAC;YAAC,SAAS,CAAC,IAAuC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBACnE,MAAM,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;gBACzC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;YAC1C,CAAC,CAAC,CAAA;SACH;aAAM;YACL,MAAM,QAAQ,GAAG,IAAI,mBAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,CAAA;YACnD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;SACzC;IACH,CAAC;IAEM,MAAM,CAAC,KAAK;QACjB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA;IACrB,CAAC;IAED,2FAA2F;IAC3F,uCAAuC;IAC/B,MAAM,CAAC,eAAe,CAAC,SAAyC;;QACtE,IAAI,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,EAAE;YACnC,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE;gBACnC,aAAM,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAA;aAC5D;YACD,OAAO,MAAA,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,0CAAE,IAAI,CAAA;SAC/B;QAED,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,EAAE;YAChC,aAAM,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAA;SACpD;QACD,OAAQ,SAAyB,CAAC,IAAI,CAAC,IAAI,CAAA;IAC7C,CAAC;;AA/ED,sFAAsF;AACvE,uBAAS,GAAwB,EAAE,CAAA;kBAF/B,aAAa","sourcesContent":["import { expect } from 'chai'\n\nimport { ApiResponse, ApiArrayResponse, V3Response, V2Response } from './api.interfaces'\nimport { ResourceData, Resource } from './resource'\n\nexport default class ResourceStore {\n  // Contains a list of resources (singular keys for the resource type eg: flow/product)\n  private static resources: Array<ResourceData> = []\n\n  public static FetchByType(type: string): ResourceData {\n    return this.resources[type]\n  }\n\n  /**\n   * Finds the resource by looking for the key and value\n   * @param type {string} the type of resource\n   * @param key {string} a JSON path string. Eg: attributes.name\n   * @param value {any} the value to look for\n   * @return {Resource | undefined}\n   */\n  public static Find(type: string, key: string, value: any): Resource {\n    const resources = this.resources[type] || []\n\n    return resources.find((resource) => {\n      let target = resource\n      if (key.indexOf('.') > -1) {\n        target = key.split('.').reduce((original, i) => original?.[i], target)\n      } else {\n        target = resource[key]\n      }\n\n      return target === value\n    })\n  }\n\n  /*\n    Returns the last created resource\n    @param type string The type of the resource, eg: product\n    @return The Resource\n   */\n  public static LastCreated(type: string): ResourceData {\n    const resources = this.resources[type] || []\n    return resources[resources.length - 1]\n  }\n\n  private static isArrayResponse(responses: ApiResponse | ApiArrayResponse): boolean {\n    return (responses as ApiArrayResponse)?.data?.length !== undefined\n  }\n\n  public static Store(responses: ApiResponse | ApiArrayResponse): void {\n    const type = this.getResourceType(responses)\n\n    if (!Object.prototype.hasOwnProperty.call(this.resources, type)) {\n      this.resources[type] = []\n    }\n\n    if (this.isArrayResponse(responses)) {\n      ;(responses.data as Array<V3Response | V2Response>).forEach((data) => {\n        const resource = new Resource(type, data)\n        this.resources[type].push(resource.data)\n      })\n    } else {\n      const resource = new Resource(type, responses.data)\n      this.resources[type].push(resource.data)\n    }\n  }\n\n  public static Clear(): void {\n    this.resources = []\n  }\n\n  // Gets the type of the resource, taking in to account an array API response, where it will\n  // infer the type from the first object\n  private static getResourceType(responses: ApiResponse | ApiArrayResponse): string {\n    if (this.isArrayResponse(responses)) {\n      if (responses.data[0] === undefined) {\n        expect.fail('Could not find any resources in the response')\n      }\n      return responses.data[0]?.type\n    }\n\n    if (responses.data === undefined) {\n      expect.fail('Could not a resource in the response')\n    }\n    return (responses as ApiResponse).data.type\n  }\n}\n"]}

package/lib/utils.d.ts

@@ -0,0 +1,3 @@
+export declare const nullOrValue: (value: any) => any;
+export declare const Pluralize: (word: string) => string;
+export declare const Capitalize: (word: string) => string;

package/lib/utils.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Capitalize = exports.Pluralize = exports.nullOrValue = void 0;
+const Logger = require("./logger");
+/*
+  Values from the component tests are always strings. Some times we
+  want to actually nullify a value. This makes sure any string 'null' is
+  parsed as literal null as well as some other type conversions
+ */
+const nullOrValue = (value) => {
+    if (value === true || value === false) {
+        return value;
+    }
+    if (value === 'null') {
+        return null;
+    }
+    if (value === '""') {
+        return '';
+    }
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === 'true') {
+        return true;
+    }
+    if (value === 'false') {
+        return false;
+    }
+    let returnValue = value;
+    if (typeof value === 'string') {
+        // We can't just parseInt the string if it's numeric like "123" because
+        // a product upc_ean can be numeric but the api expects it as a string still
+        if (value.match('<i>') !== null) {
+            return parseInt(value.replace('<i>', ''), 10);
+        }
+        if (value.match('<f>') !== null) {
+            return parseFloat(value.replace('<f>', ''));
+        }
+        if (value.match(/^\[|{/)) {
+            try {
+                returnValue = JSON.parse(value);
+            }
+            catch (e) {
+                Logger.error('Failed to parse JSON value', value);
+            }
+        }
+    }
+    return returnValue;
+};
+exports.nullOrValue = nullOrValue;
+const Pluralize = (word) => {
+    const oddities = {
+        hierarchy: 'hierarchies',
+    };
+    if (Object.prototype.hasOwnProperty.call(oddities, word)) {
+        return oddities[word];
+    }
+    return `${word}s`;
+};
+exports.Pluralize = Pluralize;
+const Capitalize = (word) => word
+    .split(/[_-]/)
+    .map((w) => `${w.charAt(0).toUpperCase()}${w.slice(1)}`)
+    .join('');
+exports.Capitalize = Capitalize;
+//# sourceMappingURL=utils.js.map

package/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA,mCAAkC;AAElC;;;;GAIG;AACI,MAAM,WAAW,GAAG,CAAC,KAAU,EAAO,EAAE;IAC7C,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,KAAK,EAAE;QACrC,OAAO,KAAK,CAAA;KACb;IAED,IAAI,KAAK,KAAK,MAAM,EAAE;QACpB,OAAO,IAAI,CAAA;KACZ;IAED,IAAI,KAAK,KAAK,IAAI,EAAE;QAClB,OAAO,EAAE,CAAA;KACV;IAED,IAAI,KAAK,KAAK,SAAS,EAAE;QACvB,OAAO,SAAS,CAAA;KACjB;IAED,IAAI,KAAK,KAAK,MAAM,EAAE;QACpB,OAAO,IAAI,CAAA;KACZ;IAED,IAAI,KAAK,KAAK,OAAO,EAAE;QACrB,OAAO,KAAK,CAAA;KACb;IAED,IAAI,WAAW,GAAG,KAAK,CAAA;IAEvB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,uEAAuE;QACvE,4EAA4E;QAC5E,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE;YAC/B,OAAO,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;SAC9C;QACD,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE;YAC/B,OAAO,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAA;SAC5C;QAED,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE;YACxB,IAAI;gBACF,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;aAChC;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,CAAC,KAAK,CAAC,4BAA4B,EAAE,KAAK,CAAC,CAAA;aAClD;SACF;KACF;IAED,OAAO,WAAW,CAAA;AACpB,CAAC,CAAA;AA/CY,QAAA,WAAW,eA+CvB;AAEM,MAAM,SAAS,GAAG,CAAC,IAAY,EAAU,EAAE;IAChD,MAAM,QAAQ,GAAG;QACf,SAAS,EAAE,aAAa;KACzB,CAAA;IAED,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE;QACxD,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAA;KACtB;IAED,OAAO,GAAG,IAAI,GAAG,CAAA;AACnB,CAAC,CAAA;AAVY,QAAA,SAAS,aAUrB;AAEM,MAAM,UAAU,GAAG,CAAC,IAAY,EAAU,EAAE,CACjD,IAAI;KACD,KAAK,CAAC,MAAM,CAAC;KACb,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;KACvD,IAAI,CAAC,EAAE,CAAC,CAAA;AAJA,QAAA,UAAU,cAIV","sourcesContent":["import * as Logger from './logger'\n\n/*\n  Values from the component tests are always strings. Some times we\n  want to actually nullify a value. This makes sure any string 'null' is\n  parsed as literal null as well as some other type conversions\n */\nexport const nullOrValue = (value: any): any => {\n  if (value === true || value === false) {\n    return value\n  }\n\n  if (value === 'null') {\n    return null\n  }\n\n  if (value === '\"\"') {\n    return ''\n  }\n\n  if (value === undefined) {\n    return undefined\n  }\n\n  if (value === 'true') {\n    return true\n  }\n\n  if (value === 'false') {\n    return false\n  }\n\n  let returnValue = value\n\n  if (typeof value === 'string') {\n    // We can't just parseInt the string if it's numeric like \"123\" because\n    // a product upc_ean can be numeric but the api expects it as a string still\n    if (value.match('<i>') !== null) {\n      return parseInt(value.replace('<i>', ''), 10)\n    }\n    if (value.match('<f>') !== null) {\n      return parseFloat(value.replace('<f>', ''))\n    }\n\n    if (value.match(/^\\[|{/)) {\n      try {\n        returnValue = JSON.parse(value)\n      } catch (e) {\n        Logger.error('Failed to parse JSON value', value)\n      }\n    }\n  }\n\n  return returnValue\n}\n\nexport const Pluralize = (word: string): string => {\n  const oddities = {\n    hierarchy: 'hierarchies',\n  }\n\n  if (Object.prototype.hasOwnProperty.call(oddities, word)) {\n    return oddities[word]\n  }\n\n  return `${word}s`\n}\n\nexport const Capitalize = (word: string): string =>\n  word\n    .split(/[_-]/)\n    .map((w) => `${w.charAt(0).toUpperCase()}${w.slice(1)}`)\n    .join('')\n"]}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@elasticpath/component-test-framework",
+  "version": "1.0.0",
+  "description": "A framework for component tests written using ts-flow",
+  "main": "./lib/index.js",
+  "directories": {
+    "lib": "./lib"
+  },
+  "files": [
+    "/lib"
+  ],
+  "engines": {
+    "npm": "Please use Yarn",
+    "yarn": "^1.22.19",
+    "node": "^16.15.0"
+  },
+  "scripts": {
+    "test": "./node_modules/.bin/mocha tests/*.ts",
+    "lint": "./node_modules/.bin/eslint src/**/*.ts --max-warnings 0",
+    "format": "./node_modules/.bin/prettier --check src/**/*.ts",
+    "format-fix": "./node_modules/.bin/prettier --write src/**/*.ts",
+    "build": "./node_modules/.bin/tsc --build ."
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@gitlab.elasticpath.com:commerce-cloud/ncl-projects/nebula/component-test-framework.git"
+  },
+  "keywords": [],
+  "author": "carl.markham@elasticpath.com",
+  "license": "ISC",
+  "dependencies": {
+    "@cucumber/cucumber": "^9.3.0",
+    "@elastic/elasticsearch": "^7.12.0",
+    "@faker-js/faker": "^8.0.2",
+    "axios": "^0.21.1",
+    "axios-logger": "^2.6.2",
+    "chai": "^4.3.7",
+    "cucumber-tsflow": "^4.0.6",
+    "dotenv": "^16.3.1",
+    "eslint": "^8.45.0",
+    "form-data": "^4.0.0",
+    "mongodb": "^5.7.0",
+    "sinon": "^15.2.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.1.6",
+    "uuid": "^9.0.0"
+  },
+  "devDependencies": {
+    "@types/chai": "^4.3.5",
+    "@types/elasticsearch": "^5.0.40",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^16.18.38",
+    "@types/sinon": "^10.0.15",
+    "@types/uuid": "^9.0.2",
+    "@typescript-eslint/eslint-plugin": "^6.1.0",
+    "@typescript-eslint/parser": "^6.1.0",
+    "eslint": "^8.45.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "8.8.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "5.0.0",
+    "mocha": "^10.2.0",
+    "prettier": "^3.0.0"
+  },
+  "mocha": {
+    "require": [
+      "ts-node/register"
+    ]
+  }
+}