@squiz/dx-common-lib 1.2.1-alpha.99 → 1.2.1

package/lib/util/isPathTryingToAccessOutsideOfRoot.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPathTryingToAccessOutsideOfRoot = void 0;
+const path_1 = __importDefault(require("path"));
+function isPathTryingToAccessOutsideOfRoot(rootPath, filePath) {
+    const resolvedRoot = path_1.default.resolve(rootPath);
+    const joinedPath = path_1.default.join(resolvedRoot, filePath);
+    return !joinedPath.includes(resolvedRoot);
+}
+exports.isPathTryingToAccessOutsideOfRoot = isPathTryingToAccessOutsideOfRoot;
+//# sourceMappingURL=isPathTryingToAccessOutsideOfRoot.js.map

package/lib/util/isPathTryingToAccessOutsideOfRoot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isPathTryingToAccessOutsideOfRoot.js","sourceRoot":"","sources":["../../src/util/isPathTryingToAccessOutsideOfRoot.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AAExB,SAAgB,iCAAiC,CAAC,QAAgB,EAAE,QAAgB;IAClF,MAAM,YAAY,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE5C,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IACrD,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;AAC5C,CAAC;AALD,8EAKC"}

package/lib/util/isPathTryingToAccessOutsideOfRoot.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/util/isPathTryingToAccessOutsideOfRoot.spec.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const isPathTryingToAccessOutsideOfRoot_1 = require("./isPathTryingToAccessOutsideOfRoot");
+describe('isPathTryingToAccessOutsideOfRoot', () => {
+    it("should return false if filepath doesn't try to access outside of root", () => {
+        expect((0, isPathTryingToAccessOutsideOfRoot_1.isPathTryingToAccessOutsideOfRoot)('my-root/', 'hello')).toEqual(false);
+        expect((0, isPathTryingToAccessOutsideOfRoot_1.isPathTryingToAccessOutsideOfRoot)('my-root/', './hello')).toEqual(false);
+        expect((0, isPathTryingToAccessOutsideOfRoot_1.isPathTryingToAccessOutsideOfRoot)('my-root/', './hello/../')).toEqual(false);
+    });
+    it('should resolve a relative root path', () => {
+        expect((0, isPathTryingToAccessOutsideOfRoot_1.isPathTryingToAccessOutsideOfRoot)('./my-root/', 'hello')).toEqual(false);
+        expect((0, isPathTryingToAccessOutsideOfRoot_1.isPathTryingToAccessOutsideOfRoot)('./my-root/', 'hello/../world')).toEqual(false);
+        expect((0, isPathTryingToAccessOutsideOfRoot_1.isPathTryingToAccessOutsideOfRoot)('./my-root/', 'hello/world/..')).toEqual(false);
+        expect((0, isPathTryingToAccessOutsideOfRoot_1.isPathTryingToAccessOutsideOfRoot)('./my-root/', './')).toEqual(false);
+        expect((0, isPathTryingToAccessOutsideOfRoot_1.isPathTryingToAccessOutsideOfRoot)('./my-root/something', './else')).toEqual(false);
+        expect((0, isPathTryingToAccessOutsideOfRoot_1.isPathTryingToAccessOutsideOfRoot)('./my-root/something', './else/1/../../')).toEqual(false);
+    });
+    it('should return true if filepath does access outside of the root', () => {
+        expect((0, isPathTryingToAccessOutsideOfRoot_1.isPathTryingToAccessOutsideOfRoot)('./my-root/', '../')).toEqual(true);
+        expect((0, isPathTryingToAccessOutsideOfRoot_1.isPathTryingToAccessOutsideOfRoot)('./my-root/', '../../')).toEqual(true);
+        expect((0, isPathTryingToAccessOutsideOfRoot_1.isPathTryingToAccessOutsideOfRoot)('./my-root/', 'hello/../world/../../')).toEqual(true);
+        expect((0, isPathTryingToAccessOutsideOfRoot_1.isPathTryingToAccessOutsideOfRoot)('./my-root/', 'hello/../../')).toEqual(true);
+    });
+});
+//# sourceMappingURL=isPathTryingToAccessOutsideOfRoot.spec.js.map

package/lib/util/isPathTryingToAccessOutsideOfRoot.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isPathTryingToAccessOutsideOfRoot.spec.js","sourceRoot":"","sources":["../../src/util/isPathTryingToAccessOutsideOfRoot.spec.ts"],"names":[],"mappings":";;AAAA,2FAAwF;AAExF,QAAQ,CAAC,mCAAmC,EAAE,GAAG,EAAE;IACjD,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAC/E,MAAM,CAAC,IAAA,qEAAiC,EAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC9E,MAAM,CAAC,IAAA,qEAAiC,EAAC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAChF,MAAM,CAAC,IAAA,qEAAiC,EAAC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACtF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,CAAC,IAAA,qEAAiC,EAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAChF,MAAM,CAAC,IAAA,qEAAiC,EAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzF,MAAM,CAAC,IAAA,qEAAiC,EAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACzF,MAAM,CAAC,IAAA,qEAAiC,EAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC7E,MAAM,CAAC,IAAA,qEAAiC,EAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC1F,MAAM,CAAC,IAAA,qEAAiC,EAAC,qBAAqB,EAAE,iBAAiB,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACrG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,CAAC,IAAA,qEAAiC,EAAC,YAAY,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7E,MAAM,CAAC,IAAA,qEAAiC,EAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChF,MAAM,CAAC,IAAA,qEAAiC,EAAC,YAAY,EAAE,uBAAuB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/F,MAAM,CAAC,IAAA,qEAAiC,EAAC,YAAY,EAAE,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACxF,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/util/isReadable.d.ts

@@ -0,0 +1 @@
+export declare function isReadable(basePath: string, file: string): Promise<boolean>;

package/lib/util/isReadable.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isReadable = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const fs_1 = require("fs");
+async function isReadable(basePath, file) {
+    try {
+        await fs_extra_1.default.access(path_1.default.join(basePath, file), fs_1.constants.R_OK);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+exports.isReadable = isReadable;
+//# sourceMappingURL=isReadable.js.map

package/lib/util/isReadable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isReadable.js","sourceRoot":"","sources":["../../src/util/isReadable.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,wDAA2B;AAC3B,2BAA+B;AAExB,KAAK,UAAU,UAAU,CAAC,QAAgB,EAAE,IAAY;IAC7D,IAAI;QACF,MAAM,kBAAG,CAAC,MAAM,CAAC,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,cAAS,CAAC,IAAI,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC;KACb;IAAC,MAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAPD,gCAOC"}

package/lib/util/joinAbsoluteUrlPath.d.ts

@@ -0,0 +1 @@
+export declare function joinAbsoluteUrlPath(...args: string[]): string;

package/lib/util/joinAbsoluteUrlPath.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.joinAbsoluteUrlPath = void 0;
+function joinAbsoluteUrlPath(...args) {
+    const [rootUrl] = args;
+    /**
+     * This method takes any form of input string and resolves them to make an absolute url
+     * Since these paths are web paths and not file paths, we are creating a URL object (https://nodejs.org/api/url.html). http://example.com has just been used as a dummy entry to create a valid url.
+     * Note: path.resolves gives you different output based on the OS node is running on. More reading here https://nodejs.org/api/path.html#windows-vs-posix.
+     */
+    const url = new URL(getSanitisedString(args), 'http://example.com');
+    if (urlIsAbsolute(rootUrl)) {
+        return url.toString();
+    }
+    else {
+        return url.pathname.replace(/(^\/|\/$)/g, '');
+    }
+}
+exports.joinAbsoluteUrlPath = joinAbsoluteUrlPath;
+function getSanitisedString(subdirs) {
+    return subdirs.map((dir) => dir.replace(/(^\.\/+)|(^\/+|\/+$)/g, '')).join('/');
+}
+function urlIsAbsolute(url) {
+    return url.match(/^http(s?):\/\//);
+}
+//# sourceMappingURL=joinAbsoluteUrlPath.js.map

package/lib/util/joinAbsoluteUrlPath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"joinAbsoluteUrlPath.js","sourceRoot":"","sources":["../../src/util/joinAbsoluteUrlPath.ts"],"names":[],"mappings":";;;AAAA,SAAgB,mBAAmB,CAAC,GAAG,IAAc;IACnD,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IACvB;;;;OAIG;IACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,oBAAoB,CAAC,CAAC;IACpE,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE;QAC1B,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;KACvB;SAAM;QACL,OAAO,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;KAC/C;AACH,CAAC;AAbD,kDAaC;AAED,SAAS,kBAAkB,CAAC,OAAiB;IAC3C,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClF,CAAC;AAED,SAAS,aAAa,CAAC,GAAW;IAChC,OAAO,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;AACrC,CAAC"}

package/lib/util/joinAbsoluteUrlPath.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/util/joinAbsoluteUrlPath.spec.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const joinAbsoluteUrlPath_1 = require("./joinAbsoluteUrlPath");
+describe('joinAbsoluteUrlPath', () => {
+    it('should return a valid absolute url for protocol based inputs', () => {
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('https://example.com', 'aaa', 'bbb')).toEqual('https://example.com/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('https://example.com/', '/aaa', 'bbb')).toEqual('https://example.com/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('https://example.com/', '/aaa/', '/bbb///')).toEqual('https://example.com/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('https://example.com/', './..///', '/bbb///')).toEqual('https://example.com/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('https://example.com/', './aaa/', '/bbb/')).toEqual('https://example.com/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('https://example.com/', '../aaa/', '/bbb')).toEqual('https://example.com/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('https://example.com/', 'ccc', '../aaa/', '/bbb')).toEqual('https://example.com/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('https://example.com/', 'ccc', '../../aaa/', '/bbb')).toEqual('https://example.com/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('https://example.com/', 'ccc', '/../../aaa/', '/bbb')).toEqual('https://example.com/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('https://example.com/', 'ddd', 'eee', 'ccc', '/../../aaa/', '/bbb')).toEqual('https://example.com/ddd/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('http://localhost:3000', 'aaa', 'bbb')).toEqual('http://localhost:3000/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('http://localhost:3000', '/aaa', 'bbb')).toEqual('http://localhost:3000/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('http://localhost:3000', '/aaa/', '/bbb///')).toEqual('http://localhost:3000/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('http://localhost:3000', './aaa/', '/bbb/')).toEqual('http://localhost:3000/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('http://localhost:3000', '../aaa/', '/bbb')).toEqual('http://localhost:3000/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('http://localhost:3000', 'ccc', '../aaa/', '/bbb')).toEqual('http://localhost:3000/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('http://localhost:3000', 'ccc', '../../aaa/', '/bbb')).toEqual('http://localhost:3000/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('http://localhost:3000', 'ccc', '/../../aaa/', '/bbb')).toEqual('http://localhost:3000/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('http://localhost:3000/', 'ddd', 'eee', 'ccc', '/../../aaa/', '/bbb')).toEqual('http://localhost:3000/ddd/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('http://localhost:3000/', 'localhost', 'eee', 'ccc', '/../../aaa/', '/bbb')).toEqual('http://localhost:3000/localhost/aaa/bbb');
+    });
+    it('should return a valid resolved path for inputs', () => {
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('aaa', 'bbb')).toEqual('aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('/aaa', 'bbb')).toEqual('aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('/aaa/', '/bbb///')).toEqual('aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('./aaa/', '/bbb/')).toEqual('aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('../aaa/', '/bbb')).toEqual('aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('ccc', '../aaa/', '/bbb')).toEqual('aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('ccc', '../../aaa/', '/bbb')).toEqual('aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('ccc', '/../../aaa/', '/bbb')).toEqual('aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('ddd', 'eee', 'ccc', '/../../aaa/', '/bbb')).toEqual('ddd/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('http', 'ccc', '/aaa/', '/bbb')).toEqual('http/ccc/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('https', 'ccc', '/aaa/', '/bbb')).toEqual('https/ccc/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('https', '../ccc', '/aaa/', '/bbb')).toEqual('ccc/aaa/bbb');
+        expect((0, joinAbsoluteUrlPath_1.joinAbsoluteUrlPath)('https', './ccc', '/aaa/', '/bbb')).toEqual('https/ccc/aaa/bbb');
+    });
+});
+//# sourceMappingURL=joinAbsoluteUrlPath.spec.js.map

package/lib/util/joinAbsoluteUrlPath.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"joinAbsoluteUrlPath.spec.js","sourceRoot":"","sources":["../../src/util/joinAbsoluteUrlPath.spec.ts"],"names":[],"mappings":";;AAAA,+DAA4D;AAE5D,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACtE,MAAM,CAAC,IAAA,yCAAmB,EAAC,qBAAqB,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;QACxG,MAAM,CAAC,IAAA,yCAAmB,EAAC,sBAAsB,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;QAC1G,MAAM,CAAC,IAAA,yCAAmB,EAAC,sBAAsB,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;QAC/G,MAAM,CAAC,IAAA,yCAAmB,EAAC,sBAAsB,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;QAC7G,MAAM,CAAC,IAAA,yCAAmB,EAAC,sBAAsB,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;QAC9G,MAAM,CAAC,IAAA,yCAAmB,EAAC,sBAAsB,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;QAE9G,MAAM,CAAC,IAAA,yCAAmB,EAAC,sBAAsB,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CACnF,6BAA6B,CAC9B,CAAC;QACF,MAAM,CAAC,IAAA,yCAAmB,EAAC,sBAAsB,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CACtF,6BAA6B,CAC9B,CAAC;QACF,MAAM,CAAC,IAAA,yCAAmB,EAAC,sBAAsB,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CACvF,6BAA6B,CAC9B,CAAC;QAEF,MAAM,CAAC,IAAA,yCAAmB,EAAC,sBAAsB,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CACrG,iCAAiC,CAClC,CAAC;QACF,MAAM,CAAC,IAAA,yCAAmB,EAAC,uBAAuB,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;QAC5G,MAAM,CAAC,IAAA,yCAAmB,EAAC,uBAAuB,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;QAC7G,MAAM,CAAC,IAAA,yCAAmB,EAAC,uBAAuB,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;QAClH,MAAM,CAAC,IAAA,yCAAmB,EAAC,uBAAuB,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;QACjH,MAAM,CAAC,IAAA,yCAAmB,EAAC,uBAAuB,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;QACjH,MAAM,CAAC,IAAA,yCAAmB,EAAC,uBAAuB,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CACpF,+BAA+B,CAChC,CAAC;QACF,MAAM,CAAC,IAAA,yCAAmB,EAAC,uBAAuB,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CACvF,+BAA+B,CAChC,CAAC;QACF,MAAM,CAAC,IAAA,yCAAmB,EAAC,uBAAuB,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CACxF,+BAA+B,CAChC,CAAC;QACF,MAAM,CAAC,IAAA,yCAAmB,EAAC,wBAAwB,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CACvG,mCAAmC,CACpC,CAAC;QACF,MAAM,CAAC,IAAA,yCAAmB,EAAC,wBAAwB,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAC7G,yCAAyC,CAC1C,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,CAAC,IAAA,yCAAmB,EAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC7D,MAAM,CAAC,IAAA,yCAAmB,EAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC9D,MAAM,CAAC,IAAA,yCAAmB,EAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACnE,MAAM,CAAC,IAAA,yCAAmB,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAClE,MAAM,CAAC,IAAA,yCAAmB,EAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAClE,MAAM,CAAC,IAAA,yCAAmB,EAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACzE,MAAM,CAAC,IAAA,yCAAmB,EAAC,KAAK,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC5E,MAAM,CAAC,IAAA,yCAAmB,EAAC,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC7E,MAAM,CAAC,IAAA,yCAAmB,EAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC/F,MAAM,CAAC,IAAA,yCAAmB,EAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACxF,MAAM,CAAC,IAAA,yCAAmB,EAAC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAC1F,MAAM,CAAC,IAAA,yCAAmB,EAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACvF,MAAM,CAAC,IAAA,yCAAmB,EAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC9F,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/util/never.d.ts

@@ -0,0 +1 @@
+export declare function never(a: never): never;

package/lib/util/never.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.never = void 0;
+function never(a) {
+    // this should never be executed. This is a compile time check
+    throw new Error(`value ${a} is not valid`);
+}
+exports.never = never;
+//# sourceMappingURL=never.js.map

package/lib/util/never.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"never.js","sourceRoot":"","sources":["../../src/util/never.ts"],"names":[],"mappings":";;;AAAA,SAAgB,KAAK,CAAC,CAAQ;IAC5B,8DAA8D;IAC9D,MAAM,IAAI,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;AAC7C,CAAC;AAHD,sBAGC"}

package/lib/util/parseEnvVarForVar.d.ts

@@ -0,0 +1 @@
+export declare function parseEnvVarForVar(varName: string, defaultValue?: string | undefined): string;

package/lib/util/parseEnvVarForVar.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseEnvVarForVar = void 0;
+function parseEnvVarForVar(varName, defaultValue = undefined) {
+    if (process.env[varName] === undefined) {
+        if (defaultValue !== undefined) {
+            return defaultValue;
+        }
+        throw new Error(`env variable ${varName} must be set`);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    return process.env[varName];
+}
+exports.parseEnvVarForVar = parseEnvVarForVar;
+//# sourceMappingURL=parseEnvVarForVar.js.map

package/lib/util/parseEnvVarForVar.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseEnvVarForVar.js","sourceRoot":"","sources":["../../src/util/parseEnvVarForVar.ts"],"names":[],"mappings":";;;AAAA,SAAgB,iBAAiB,CAAC,OAAe,EAAE,eAAmC,SAAS;IAC7F,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,SAAS,EAAE;QACtC,IAAI,YAAY,KAAK,SAAS,EAAE;YAC9B,OAAO,YAAY,CAAC;SACrB;QAED,MAAM,IAAI,KAAK,CAAC,gBAAgB,OAAO,cAAc,CAAC,CAAC;KACxD;IAED,oEAAoE;IACpE,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAE,CAAC;AAC/B,CAAC;AAXD,8CAWC"}

package/lib/util/parseEnvVarForVar.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/util/parseEnvVarForVar.spec.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const parseEnvVarForVar_1 = require("./parseEnvVarForVar");
+describe('parseEnvVarForVar', () => {
+    it('it should read an environment variable from process.env.*', () => {
+        process.env.MY_VAR = 'hello';
+        expect((0, parseEnvVarForVar_1.parseEnvVarForVar)('MY_VAR')).toEqual('hello');
+    });
+    it('it should throw an error if the variable is not available', () => {
+        expect(() => (0, parseEnvVarForVar_1.parseEnvVarForVar)('DOESNT_EXIST')).toThrowError(new Error('env variable DOESNT_EXIST must be set'));
+    });
+    it('it should not throw an error if a default value is provided and env var doesnt exist', () => {
+        expect((0, parseEnvVarForVar_1.parseEnvVarForVar)('DOESNT_EXIST', 'default')).toEqual('default');
+    });
+    it('it should return env var if its set and a defualt value is set', () => {
+        process.env.MY_VAR = 'hello';
+        expect((0, parseEnvVarForVar_1.parseEnvVarForVar)('MY_VAR', 'default')).toEqual('hello');
+    });
+});
+//# sourceMappingURL=parseEnvVarForVar.spec.js.map

package/lib/util/parseEnvVarForVar.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseEnvVarForVar.spec.js","sourceRoot":"","sources":["../../src/util/parseEnvVarForVar.spec.ts"],"names":[],"mappings":";;AAAA,2DAAwD;AAExD,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,OAAO,CAAC,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC;QAE7B,MAAM,CAAC,IAAA,qCAAiB,EAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,qCAAiB,EAAC,cAAc,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC,CAAC;IACnH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sFAAsF,EAAE,GAAG,EAAE;QAC9F,MAAM,CAAC,IAAA,qCAAiB,EAAC,cAAc,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,OAAO,CAAC,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC;QAC7B,MAAM,CAAC,IAAA,qCAAiB,EAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/zip/zipDirectory.d.ts

@@ -0,0 +1 @@
+export declare function zipDirectory(sourceDirectory: string, outputDirectory: string): Promise<string>;

package/lib/zip/zipDirectory.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zipDirectory = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const archiver_1 = __importDefault(require("archiver"));
+function zipDirectory(sourceDirectory, outputDirectory) {
+    return new Promise((resolve, reject) => {
+        const outputZipFile = path_1.default.join(outputDirectory, '/export.zip');
+        const output = fs_1.default.createWriteStream(outputZipFile);
+        const archive = (0, archiver_1.default)('zip', {
+            zlib: { level: 9 }, // Sets the compression level.
+        });
+        output.on('close', function () {
+            resolve(outputZipFile);
+        });
+        archive.on('warning', function (err) {
+            reject(err);
+        });
+        archive.on('error', function (err) {
+            reject(err);
+        });
+        archive.pipe(output);
+        archive.directory(sourceDirectory, false);
+        archive.finalize();
+    });
+}
+exports.zipDirectory = zipDirectory;
+//# sourceMappingURL=zipDirectory.js.map

package/lib/zip/zipDirectory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zipDirectory.js","sourceRoot":"","sources":["../../src/zip/zipDirectory.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,4CAAoB;AAEpB,wDAAgC;AAEhC,SAAgB,YAAY,CAAC,eAAuB,EAAE,eAAuB;IAC3E,OAAO,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC7C,MAAM,aAAa,GAAG,cAAI,CAAC,IAAI,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;QAChE,MAAM,MAAM,GAAG,YAAE,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAEnD,MAAM,OAAO,GAAG,IAAA,kBAAQ,EAAC,KAAK,EAAE;YAC9B,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,8BAA8B;SACnD,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE;YACjB,OAAO,CAAC,aAAa,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,UAAU,GAAG;YACjC,MAAM,CAAC,GAAG,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,GAAG;YAC/B,MAAM,CAAC,GAAG,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrB,OAAO,CAAC,SAAS,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;QAC1C,OAAO,CAAC,QAAQ,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC;AAzBD,oCAyBC"}

package/lib/zip/zipDirectory.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/zip/zipDirectory.spec.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const zipDirectory_1 = require("./zipDirectory");
+describe('zipDirectory', () => {
+    const inputDir = fs_1.default.mkdtempSync('zip-test');
+    const outDir = fs_1.default.mkdtempSync('zip-test-out');
+    beforeAll(() => {
+        fs_1.default.writeFileSync(path_1.default.join(inputDir, 'f1.txt'), '1');
+        fs_1.default.writeFileSync(path_1.default.join(inputDir, 'f2.txt'), '2');
+    });
+    afterAll(() => {
+        fs_1.default.rmSync(inputDir, { force: true, recursive: true });
+        fs_1.default.rmSync(outDir, { force: true, recursive: true });
+    });
+    it('should take an input path and an output path and create a export.zip', async () => {
+        await (0, zipDirectory_1.zipDirectory)(inputDir, outDir);
+        expect(fs_1.default.existsSync(path_1.default.join(outDir, 'export.zip'))).toEqual(true);
+    });
+});
+//# sourceMappingURL=zipDirectory.spec.js.map

package/lib/zip/zipDirectory.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zipDirectory.spec.js","sourceRoot":"","sources":["../../src/zip/zipDirectory.spec.ts"],"names":[],"mappings":";;;;;AAAA,gDAAwB;AACxB,4CAAoB;AACpB,iDAA8C;AAE9C,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,MAAM,QAAQ,GAAG,YAAE,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,YAAE,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IAE9C,SAAS,CAAC,GAAG,EAAE;QACb,YAAE,CAAC,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,GAAG,CAAC,CAAC;QACrD,YAAE,CAAC,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,GAAG,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,GAAG,EAAE;QACZ,YAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,YAAE,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QACpF,MAAM,IAAA,2BAAY,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAErC,MAAM,CAAC,YAAE,CAAC,UAAU,CAAC,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,30 +1,36 @@
 {
   "name": "@squiz/dx-common-lib",
-  "version": "1.2.1-alpha.99",
+  "version": "1.2.1",
   "description": "",
   "main": "lib/index.js",
   "scripts": {
-    "start": "node ./lib/index.js",
     "compile": "npx tsc",
     "lint": "eslint ./src --ext .ts",
     "test": "jest -c jest.config.ts",
-    "test:integration": "jest -c jest.integration.config.ts",
     "test:update-snapshots": "jest -c jest.config.ts --updateSnapshot",
     "clean": "rimraf \".tsbuildinfo\" \"./lib\""
   },
   "author": "",
   "license": "ISC",
+  "dependencies": {
+    "@squiz/dx-logger-lib": "^1.2.1",
+    "archiver": "5.3.1",
+    "fs-extra": "10.1.0"
+  },
   "devDependencies": {
-    "@types/jest": "28.1.6",
+    "@types/archiver": "5.3.1",
+    "@types/express": "4.17.13",
+    "@types/fs-extra": "9.0.13",
+    "@types/jest": "28.1.8",
     "@types/node": "17.0.27",
-    "dotenv": "16.0.1",
+    "dotenv": "16.0.2",
     "eslint": "8.22.0",
     "jest": "28.1.3",
     "rimraf": "3.0.2",
-    "ts-jest": "28.0.7",
+    "ts-jest": "28.0.8",
     "ts-loader": "9.3.1",
     "ts-node": "10.9.1",
     "typescript": "4.7.4"
   },
-  "gitHead": "36030fd058a84822e5c51f7a9f139fc07ab5fdd9"
+  "gitHead": "362dbbb8f3e4cd5e4aa255596fd61d84a579bc73"
 }

package/src/assertions/assertAssignWithDefaultUndefinedValue.ts

@@ -15,3 +15,8 @@ export function assertAssignWithDefaultUndefinedValue<T>(
 
   return assertAssign(value, assertionFunc, errorMessage);
 }
+
+export const isSomeEnum =
+  <TEnum>(enumType: TEnum) =>
+  (token: unknown): token is TEnum[keyof TEnum] =>
+    Object.values(enumType).includes(token as TEnum[keyof TEnum]);

package/src/assertions/assertIsBoolean.spec.ts

@@ -0,0 +1,16 @@
+import { assertIsBoolean } from './assertIsBoolean';
+
+describe('assertIsBoolean', () => {
+  it('should throw an assertion error if input is undefined', () => {
+    expect(() => assertIsBoolean(undefined)).toThrowErrorMatchingInlineSnapshot(`"Expected undefined to be a boolean"`);
+  });
+
+  it('should throw an assertion error if input is null', () => {
+    expect(() => assertIsBoolean(null)).toThrowErrorMatchingInlineSnapshot(`"Expected null to be a boolean"`);
+  });
+
+  it('should return "void" or undefined if valid', () => {
+    expect(assertIsBoolean(true)).toBeUndefined();
+    expect(() => assertIsBoolean(false)).not.toThrowError();
+  });
+});

package/src/assertions/assertIsBoolean.ts

@@ -0,0 +1,5 @@
+import assert from 'assert/strict';
+
+export function assertIsBoolean(value: unknown): asserts value is boolean {
+  assert.ok(typeof value === 'boolean', `Expected ${value} to be a boolean`);
+}

package/src/assertions/assertIsEnumValue.spec.ts

@@ -0,0 +1,39 @@
+import { AssertionError } from 'assert';
+import { assertIsEnumValue } from './assertIsEnumValue';
+
+describe('assertIsEnumValue', () => {
+  enum StringEnum {
+    A = 'a',
+    B = 'b',
+    C = 'c',
+  }
+
+  enum NumEnum {
+    A,
+    B,
+    C,
+  }
+
+  it('should not show an error if input value is in enum object', () => {
+    expect(assertIsEnumValue('a', StringEnum)).toBeUndefined();
+    const val = StringEnum.B;
+    expect(assertIsEnumValue(val, StringEnum)).toBeUndefined();
+  });
+
+  it('should not show an error if input value is in enum object (with no default values)', () => {
+    expect(assertIsEnumValue(2, NumEnum)).toBeUndefined();
+    const val = NumEnum.C;
+    expect(assertIsEnumValue(val, NumEnum)).toBeUndefined();
+  });
+
+  it("should throw an AssertionError is value isn't in enum", () => {
+    expect(() => assertIsEnumValue('zz', StringEnum)).toThrowError(AssertionError);
+    expect(() => assertIsEnumValue('zz', StringEnum)).toThrowErrorMatchingInlineSnapshot(`
+      "'zz' in [
+        'a',
+        'b',
+        'c'
+      ]"
+    `);
+  });
+});

package/src/assertions/assertIsEnumValue.ts

@@ -0,0 +1,15 @@
+import { AssertionError } from 'assert';
+
+export function assertIsEnumValue<T extends object>(val: unknown, obj: T): asserts val is T[keyof T] {
+  if (isValueIsEnumValue(val, obj) === false) {
+    throw new AssertionError({
+      actual: val,
+      expected: Object.values(obj),
+      operator: 'in',
+    });
+  }
+}
+
+function isValueIsEnumValue<TEnum extends object>(val: unknown, enumType: TEnum): val is TEnum[keyof TEnum] {
+  return Object.values(enumType).includes(val as TEnum[keyof TEnum]);
+}

package/src/assertions/index.ts

@@ -0,0 +1,12 @@
+// Common Assertions
+export * from './assertIsString';
+export * from './assertIsDefined';
+export * from './assertIsMapOfStringString';
+export * from './assertIsObject';
+export * from './assertIsNotAnEmptyString';
+export * from './assertIsEnumValue';
+export * from './assertIsBoolean';
+
+// Assert assign
+export * from './assertAssignWithDefaultUndefinedValue';
+export * from './assertAssign';

package/src/error/BadRequestError.ts

@@ -0,0 +1,7 @@
+import { ErrorWithHttpStatusCode } from './ErrorWithHttpStatusCode';
+
+export class BadRequestError extends ErrorWithHttpStatusCode {
+  constructor(message: string) {
+    super(400, message);
+  }
+}

package/src/error/ErrorWithHttpStatusCode.ts

@@ -0,0 +1,5 @@
+export class ErrorWithHttpStatusCode extends Error {
+  constructor(public statusCode: number, public message: string) {
+    super(message);
+  }
+}

package/src/error/InternalServerError.ts

@@ -0,0 +1,7 @@
+import { ErrorWithHttpStatusCode } from './ErrorWithHttpStatusCode';
+
+export class InternalServerError extends ErrorWithHttpStatusCode {
+  constructor(message: string) {
+    super(500, message);
+  }
+}

package/src/error/MethodNotImplementedError.ts

@@ -0,0 +1,7 @@
+import { InternalServerError } from './InternalServerError';
+
+export class MethodNotImplementedError extends InternalServerError {
+  constructor(message?: string) {
+    super(message ?? 'method is not implemented');
+  }
+}

package/src/error/ResourceNotFoundError.ts

@@ -0,0 +1,7 @@
+import { ErrorWithHttpStatusCode } from './ErrorWithHttpStatusCode';
+
+export class ResourceNotFoundError extends ErrorWithHttpStatusCode {
+  constructor(message: string) {
+    super(404, message);
+  }
+}

package/src/error/TimeoutError.ts

@@ -0,0 +1,8 @@
+import { ErrorWithHttpStatusCode } from './ErrorWithHttpStatusCode';
+
+export class TimeoutError extends ErrorWithHttpStatusCode {
+  name = 'TimeoutError';
+  constructor(message: string = 'request failed to evaluate within the timeout period') {
+    super(500, message);
+  }
+}

package/src/error/index.ts

@@ -0,0 +1,6 @@
+export * from './BadRequestError';
+export * from './ErrorWithHttpStatusCode';
+export * from './InternalServerError';
+export * from './ResourceNotFoundError';
+export * from './TimeoutError';
+export * from './MethodNotImplementedError';

package/src/index.ts

@@ -1,10 +1,4 @@
-// Common Assertions
-export * from './assertions/assertIsString';
-export * from './assertions/assertIsDefined';
-export * from './assertions/assertIsMapOfStringString';
-export * from './assertions/assertIsObject';
-export * from './assertions/assertIsNotAnEmptyString';
-
-// Assert assign
-export * from './assertions/assertAssignWithDefaultUndefinedValue';
-export * from './assertions/assertAssign';
+export * from './assertions/';
+export * from './error';
+export * from './util';
+export * from './zip/zipDirectory';

package/src/util/getNodeEnv.spec.ts

@@ -0,0 +1,25 @@
+import { getNodeEnv } from './getNodeEnv';
+
+describe('getNodeEnv', () => {
+  it('should return production if NODE_ENV equals production', () => {
+    process.env.NODE_ENV = 'production';
+    expect(getNodeEnv()).toEqual('production');
+  });
+
+  it('should return development if NODE_ENV equals development', () => {
+    process.env.NODE_ENV = 'development';
+    expect(getNodeEnv()).toEqual('development');
+  });
+
+  it('should return development if NODE_ENV is not set', () => {
+    delete process.env.NODE_ENV;
+    expect(getNodeEnv()).toEqual('development');
+  });
+
+  it('should throw if NODE_ENV set to non valid environment', () => {
+    process.env.NODE_ENV = 'invalid';
+    expect(() => getNodeEnv()).toThrowError(
+      new Error('NODE_ENV env var can only be values "production" or "development"'),
+    );
+  });
+});

package/src/util/getNodeEnv.ts

@@ -0,0 +1,11 @@
+export function getNodeEnv(): 'production' | 'development' {
+  if (process.env.NODE_ENV == 'production') {
+    return 'production';
+  }
+
+  if (process.env.NODE_ENV == 'development' || process.env.NODE_ENV === undefined) {
+    return 'development';
+  }
+
+  throw new Error('NODE_ENV env var can only be values "production" or "development"');
+}

package/src/util/getPageInfo.ts

@@ -0,0 +1,23 @@
+export type PageInfoResult = {
+  current: number;
+  next: number | null;
+  previous: number | null;
+  totalPages: number;
+  totalItems: number;
+  pageSize: number;
+};
+
+export function getPageInfo(current: number, pageSize: number, totalItems: number): PageInfoResult {
+  const totalPages = Math.ceil(totalItems / pageSize);
+  const next = current + 1 > totalPages ? null : current + 1;
+  const previous = current <= 1 ? null : current - 1;
+
+  return {
+    current,
+    next,
+    previous,
+    totalPages,
+    totalItems,
+    pageSize,
+  };
+}