@squiz/dx-common-lib 1.2.12 → 1.2.13-alpha.1

package/lib/formatted-text/formattedTextToHtmlSting.spec.d.ts

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

package/lib/formatted-text/formattedTextToHtmlSting.spec.js

@@ -0,0 +1,212 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const formattedTextToHtmlSting_1 = require("./formattedTextToHtmlSting");
+describe('formattedTextToHtmlSting', () => {
+    it('should convert text nodes to HTML', () => {
+        const textNode = {
+            type: 'text',
+            value: 'Hello, world!',
+        };
+        expect((0, formattedTextToHtmlSting_1.formattedTextToHtmlSting)(textNode)).toBe('Hello, world!');
+    });
+    it('should convert tag nodes to HTML', () => {
+        const tagNode = {
+            type: 'tag',
+            tag: 'p',
+            children: [{ type: 'text', value: 'Hello, world!' }],
+        };
+        expect((0, formattedTextToHtmlSting_1.formattedTextToHtmlSting)(tagNode)).toBe('<p>Hello, world!</p>');
+    });
+    it('should convert tag nodes with attributes to HTML', () => {
+        const tagNode = {
+            type: 'tag',
+            tag: 'p',
+            attributes: {
+                id: 'hello-world',
+                class: 'greeting',
+            },
+            children: [{ type: 'text', value: 'Hello, world!' }],
+        };
+        expect((0, formattedTextToHtmlSting_1.formattedTextToHtmlSting)(tagNode)).toBe('<p id="hello-world" class="greeting">Hello, world!</p>');
+    });
+    it('should convert tag nodes with font properties to HTML', () => {
+        const tagNode = {
+            type: 'tag',
+            tag: 'p',
+            font: {
+                bold: true,
+                underline: true,
+                italics: false,
+                color: 'red',
+                size: 'large',
+                fontFamily: 'Arial',
+            },
+            children: [{ type: 'text', value: 'Hello, world!' }],
+        };
+        expect((0, formattedTextToHtmlSting_1.formattedTextToHtmlSting)(tagNode)).toBe('<p class="bold underline color-red size-large font-Arial">Hello, world!</p>');
+    });
+    it('converts a tag node with attributes but no children to html', () => {
+        const node = {
+            type: 'tag',
+            tag: 'p',
+            children: [],
+            attributes: { class: 'test-class' },
+        };
+        expect((0, formattedTextToHtmlSting_1.formattedTextToHtmlSting)(node)).toEqual('<p class="test-class"></p>');
+    });
+    it('converts a tag node with children but no attributes to html', () => {
+        const node = {
+            type: 'tag',
+            tag: 'p',
+            children: [
+                { type: 'text', value: 'This is a test' },
+                { type: 'text', value: 'This is another test' },
+            ],
+        };
+        expect((0, formattedTextToHtmlSting_1.formattedTextToHtmlSting)(node)).toEqual('<p>This is a testThis is another test</p>');
+    });
+    it('converts a tag node with children and attributes to html', () => {
+        const node = {
+            type: 'tag',
+            tag: 'p',
+            attributes: { class: 'test-class' },
+            children: [
+                { type: 'text', value: 'This is a test' },
+                { type: 'text', value: 'This is another test' },
+            ],
+        };
+        expect((0, formattedTextToHtmlSting_1.formattedTextToHtmlSting)(node)).toEqual('<p class="test-class">This is a testThis is another test</p>');
+    });
+    it('should convert a tag node with attributes to HTML', () => {
+        const input = {
+            type: 'tag',
+            tag: 'div',
+            children: [],
+            attributes: {
+                id: 'my-div',
+                'data-foo': 'bar',
+            },
+        };
+        const expectedOutput = '<div id="my-div" data-foo="bar"></div>';
+        expect((0, formattedTextToHtmlSting_1.formattedTextToHtmlSting)(input)).toEqual(expectedOutput);
+    });
+    it('should add the correct class for left alignment', () => {
+        const formattedNode = {
+            type: 'tag',
+            children: [],
+            tag: 'p',
+            formattingOptions: {
+                alignment: 'left',
+            },
+        };
+        const html = (0, formattedTextToHtmlSting_1.formattedTextToHtmlSting)(formattedNode);
+        expect(html).toEqual('<p class="left"></p>');
+    });
+    it('should add the correct class for right alignment', () => {
+        const formattedNode = {
+            type: 'tag',
+            children: [],
+            tag: 'p',
+            formattingOptions: {
+                alignment: 'right',
+            },
+        };
+        const html = (0, formattedTextToHtmlSting_1.formattedTextToHtmlSting)(formattedNode);
+        expect(html).toEqual('<p class="right"></p>');
+    });
+    it('should add the correct class for center alignment', () => {
+        const formattedNode = {
+            type: 'tag',
+            children: [],
+            tag: 'p',
+            formattingOptions: {
+                alignment: 'center',
+            },
+        };
+        const html = (0, formattedTextToHtmlSting_1.formattedTextToHtmlSting)(formattedNode);
+        expect(html).toEqual('<p class="center"></p>');
+    });
+    it('should add the correct class for justify alignment', () => {
+        const formattedNode = {
+            type: 'tag',
+            children: [],
+            tag: 'p',
+            formattingOptions: {
+                alignment: 'justify',
+            },
+        };
+        const html = (0, formattedTextToHtmlSting_1.formattedTextToHtmlSting)(formattedNode);
+        expect(html).toEqual('<p class="justify"></p>');
+    });
+    it('should handle input with formattingOptions, font and class attributes', () => {
+        const formattedTextTag = {
+            type: 'tag',
+            tag: 'p',
+            formattingOptions: {
+                alignment: 'center',
+            },
+            font: {
+                bold: true,
+                color: 'red',
+            },
+            attributes: {
+                class: 'my-class',
+            },
+            children: [
+                {
+                    type: 'text',
+                    value: 'Hello, World!',
+                },
+            ],
+        };
+        const expectedResult = '<p class="my-class bold color-red center">Hello, World!</p>';
+        const result = (0, formattedTextToHtmlSting_1.formattedTextToHtmlSting)(formattedTextTag);
+        expect(result).toBe(expectedResult);
+    });
+    it('should return an error message for an unknown node type', () => {
+        const formattedNodes = {
+            type: 'unknown',
+            value: 'Hello World!',
+        };
+        const expectedHTML = `<p class="invalid-node-type"> node of type "unknown" cannot be converted to html</p>`;
+        expect((0, formattedTextToHtmlSting_1.formattedTextToHtmlSting)(formattedNodes)).toEqual(expectedHTML);
+    });
+    it('should handle deeply nested FormattedNodes object', () => {
+        const formattedNodes = {
+            type: 'tag',
+            tag: 'div',
+            formattingOptions: {
+                alignment: 'justify',
+            },
+            children: [
+                {
+                    type: 'text',
+                    value: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. ',
+                },
+                {
+                    type: 'tag',
+                    tag: 'strong',
+                    font: {
+                        bold: true,
+                    },
+                    children: [
+                        {
+                            type: 'text',
+                            value: 'Vestibulum',
+                        },
+                        {
+                            type: 'text',
+                            value: ' dictum',
+                        },
+                    ],
+                },
+                {
+                    type: 'text',
+                    value: ' mi vel urna maximus, et luctus ipsum tincidunt',
+                },
+            ],
+        };
+        expect((0, formattedTextToHtmlSting_1.formattedTextToHtmlSting)(formattedNodes)).toMatchInlineSnapshot(`"<div class=\\"justify\\">Lorem ipsum dolor sit amet, consectetur adipiscing elit. <strong class=\\"bold\\">Vestibulum dictum</strong> mi vel urna maximus, et luctus ipsum tincidunt</div>"`);
+    });
+});
+//# sourceMappingURL=formattedTextToHtmlSting.spec.js.map

package/lib/formatted-text/formattedTextToHtmlSting.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formattedTextToHtmlSting.spec.js","sourceRoot":"","sources":["../../src/formatted-text/formattedTextToHtmlSting.spec.ts"],"names":[],"mappings":";;AACA,yEAAsE;AAKtE,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,QAAQ,GAAmB;YAC/B,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,eAAe;SACvB,CAAC;QACF,MAAM,CAAC,IAAA,mDAAwB,EAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,MAAM,OAAO,GAAmB;YAC9B,IAAI,EAAE,KAAK;YACX,GAAG,EAAE,GAAG;YACR,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;SACrD,CAAC;QACF,MAAM,CAAC,IAAA,mDAAwB,EAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAC1D,MAAM,OAAO,GAAmB;YAC9B,IAAI,EAAE,KAAK;YACX,GAAG,EAAE,GAAG;YACR,UAAU,EAAE;gBACV,EAAE,EAAE,aAAa;gBACjB,KAAK,EAAE,UAAU;aAClB;YACD,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;SACrD,CAAC;QACF,MAAM,CAAC,IAAA,mDAAwB,EAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;IAC3G,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC/D,MAAM,OAAO,GAAmB;YAC9B,IAAI,EAAE,KAAK;YACX,GAAG,EAAE,GAAG;YACR,IAAI,EAAE;gBACJ,IAAI,EAAE,IAAI;gBACV,SAAS,EAAE,IAAI;gBACf,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,KAAK;gBACZ,IAAI,EAAE,OAAO;gBACb,UAAU,EAAE,OAAO;aACpB;YACD,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;SACrD,CAAC;QACF,MAAM,CAAC,IAAA,mDAAwB,EAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAC5C,6EAA6E,CAC9E,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACrE,MAAM,IAAI,GAAmB;YAC3B,IAAI,EAAE,KAAK;YACX,GAAG,EAAE,GAAG;YACR,QAAQ,EAAE,EAAE;YACZ,UAAU,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE;SACpC,CAAC;QACF,MAAM,CAAC,IAAA,mDAAwB,EAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAC/E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACrE,MAAM,IAAI,GAAmB;YAC3B,IAAI,EAAE,KAAK;YACX,GAAG,EAAE,GAAG;YACR,QAAQ,EAAE;gBACR,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,EAAE;gBACzC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,sBAAsB,EAAE;aAChD;SACF,CAAC;QACF,MAAM,CAAC,IAAA,mDAAwB,EAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,2CAA2C,CAAC,CAAC;IAC9F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAClE,MAAM,IAAI,GAAmB;YAC3B,IAAI,EAAE,KAAK;YACX,GAAG,EAAE,GAAG;YACR,UAAU,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE;YACnC,QAAQ,EAAE;gBACR,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,EAAE;gBACzC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,sBAAsB,EAAE;aAChD;SACF,CAAC;QACF,MAAM,CAAC,IAAA,mDAAwB,EAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,8DAA8D,CAAC,CAAC;IACjH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,KAAK,GAAmB;YAC5B,IAAI,EAAE,KAAK;YACX,GAAG,EAAE,KAAK;YACV,QAAQ,EAAE,EAAE;YACZ,UAAU,EAAE;gBACV,EAAE,EAAE,QAAQ;gBACZ,UAAU,EAAE,KAAK;aAClB;SACF,CAAC;QACF,MAAM,cAAc,GAAG,wCAAwC,CAAC;QAChE,MAAM,CAAC,IAAA,mDAAwB,EAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,aAAa,GAAqB;YACtC,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,EAAE;YACZ,GAAG,EAAE,GAAG;YACR,iBAAiB,EAAE;gBACjB,SAAS,EAAE,MAAM;aAClB;SACF,CAAC;QACF,MAAM,IAAI,GAAG,IAAA,mDAAwB,EAAC,aAAa,CAAC,CAAC;QACrD,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAC1D,MAAM,aAAa,GAAqB;YACtC,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,EAAE;YACZ,GAAG,EAAE,GAAG;YACR,iBAAiB,EAAE;gBACjB,SAAS,EAAE,OAAO;aACnB;SACF,CAAC;QACF,MAAM,IAAI,GAAG,IAAA,mDAAwB,EAAC,aAAa,CAAC,CAAC;QACrD,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,aAAa,GAAqB;YACtC,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,EAAE;YACZ,GAAG,EAAE,GAAG;YACR,iBAAiB,EAAE;gBACjB,SAAS,EAAE,QAAQ;aACpB;SACF,CAAC;QACF,MAAM,IAAI,GAAG,IAAA,mDAAwB,EAAC,aAAa,CAAC,CAAC;QACrD,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,aAAa,GAAqB;YACtC,IAAI,EAAE,KAAK;YACX,QAAQ,EAAE,EAAE;YACZ,GAAG,EAAE,GAAG;YACR,iBAAiB,EAAE;gBACjB,SAAS,EAAE,SAAS;aACrB;SACF,CAAC;QACF,MAAM,IAAI,GAAG,IAAA,mDAAwB,EAAC,aAAa,CAAC,CAAC;QACrD,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAC/E,MAAM,gBAAgB,GAAqB;YACzC,IAAI,EAAE,KAAK;YACX,GAAG,EAAE,GAAG;YACR,iBAAiB,EAAE;gBACjB,SAAS,EAAE,QAAQ;aACpB;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,IAAI;gBACV,KAAK,EAAE,KAAK;aACb;YACD,UAAU,EAAE;gBACV,KAAK,EAAE,UAAU;aAClB;YACD,QAAQ,EAAE;gBACR;oBACE,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE,eAAe;iBACvB;aACF;SACF,CAAC;QAEF,MAAM,cAAc,GAAG,6DAA6D,CAAC;QAErF,MAAM,MAAM,GAAG,IAAA,mDAAwB,EAAC,gBAAgB,CAAC,CAAC;QAC1D,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,MAAM,cAAc,GAAmB;YACrC,IAAI,EAAE,SAAgB;YACtB,KAAK,EAAE,cAAc;SACtB,CAAC;QACF,MAAM,YAAY,GAAG,sFAAsF,CAAC;QAC5G,MAAM,CAAC,IAAA,mDAAwB,EAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,cAAc,GAAmB;YACrC,IAAI,EAAE,KAAK;YACX,GAAG,EAAE,KAAK;YACV,iBAAiB,EAAE;gBACjB,SAAS,EAAE,SAAS;aACrB;YACD,QAAQ,EAAE;gBACR;oBACE,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE,2DAA2D;iBACnE;gBACD;oBACE,IAAI,EAAE,KAAK;oBACX,GAAG,EAAE,QAAQ;oBACb,IAAI,EAAE;wBACJ,IAAI,EAAE,IAAI;qBACX;oBACD,QAAQ,EAAE;wBACR;4BACE,IAAI,EAAE,MAAM;4BACZ,KAAK,EAAE,YAAY;yBACpB;wBACD;4BACE,IAAI,EAAE,MAAM;4BACZ,KAAK,EAAE,SAAS;yBACjB;qBACF;iBACF;gBACD;oBACE,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE,iDAAiD;iBACzD;aACF;SACF,CAAC;QAEF,MAAM,CAAC,IAAA,mDAAwB,EAAC,cAAc,CAAC,CAAC,CAAC,qBAAqB,CACpE,8LAA8L,CAC/L,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/index.d.ts

@@ -4,3 +4,10 @@ export * from './util';
 export * from './zip/zipDirectory';
 export * from './server-utils/errorMiddleware';
 export * from './server-utils/requestLogger';
+export * from './api-key-validation/ApiKeyValidationService';
+export * from './api-key-validation/CloudflareApiKeyService';
+export * from './api-key-validation/DevelopmentApiKeyService';
+export * from './api-key-validation/getApiKeyService';
+export * from './server-utils/apiKeyMiddleware';
+export * from './cache';
+export * from './formatted-text/formattedTextToHtmlSting';

package/lib/index.js

@@ -20,4 +20,11 @@ __exportStar(require("./util"), exports);
 __exportStar(require("./zip/zipDirectory"), exports);
 __exportStar(require("./server-utils/errorMiddleware"), exports);
 __exportStar(require("./server-utils/requestLogger"), exports);
+__exportStar(require("./api-key-validation/ApiKeyValidationService"), exports);
+__exportStar(require("./api-key-validation/CloudflareApiKeyService"), exports);
+__exportStar(require("./api-key-validation/DevelopmentApiKeyService"), exports);
+__exportStar(require("./api-key-validation/getApiKeyService"), exports);
+__exportStar(require("./server-utils/apiKeyMiddleware"), exports);
+__exportStar(require("./cache"), exports);
+__exportStar(require("./formatted-text/formattedTextToHtmlSting"), exports);
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,0CAAwB;AACxB,yCAAuB;AACvB,qDAAmC;AACnC,iEAA+C;AAC/C,+DAA6C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,0CAAwB;AACxB,yCAAuB;AACvB,qDAAmC;AACnC,iEAA+C;AAC/C,+DAA6C;AAC7C,+EAA6D;AAC7D,+EAA6D;AAC7D,gFAA8D;AAC9D,wEAAsD;AACtD,kEAAgD;AAChD,0CAAwB;AACxB,4EAA0D"}

package/lib/server-utils/apiKeyMiddleware.d.ts

@@ -0,0 +1,3 @@
+import type { Request, Response } from 'express';
+import { ApiKeyValidationService } from '../api-key-validation/ApiKeyValidationService';
+export declare function apiKeyMiddleware(apiKeyService: ApiKeyValidationService): (req: Request, res: Response, next: any) => void;

package/lib/server-utils/apiKeyMiddleware.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apiKeyMiddleware = void 0;
+const UnAuthenticatedRequestError_1 = require("../error/UnAuthenticatedRequestError");
+function apiKeyMiddleware(apiKeyService) {
+    return function (req, res, next) {
+        const key = req.header('x-api-key');
+        if (req.path == '/health') {
+            next();
+            return;
+        }
+        if (apiKeyService.keyIsValid(key) || apiKeyService.matrixKeyIsValid(key)) {
+            next();
+            return;
+        }
+        throw new UnAuthenticatedRequestError_1.UnAuthenticatedRequestError(`API KEY IS INVALID`);
+    };
+}
+exports.apiKeyMiddleware = apiKeyMiddleware;
+//# sourceMappingURL=apiKeyMiddleware.js.map

package/lib/server-utils/apiKeyMiddleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiKeyMiddleware.js","sourceRoot":"","sources":["../../src/server-utils/apiKeyMiddleware.ts"],"names":[],"mappings":";;;AAEA,sFAAmF;AAEnF,SAAgB,gBAAgB,CAC9B,aAAsC;IAEtC,OAAO,UAAU,GAAY,EAAE,GAAa,EAAE,IAAS;QACrD,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAEpC,IAAI,GAAG,CAAC,IAAI,IAAI,SAAS,EAAE;YACzB,IAAI,EAAE,CAAC;YACP,OAAO;SACR;QAED,IAAI,aAAa,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,aAAa,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE;YACxE,IAAI,EAAE,CAAC;YACP,OAAO;SACR;QAED,MAAM,IAAI,yDAA2B,CAAC,oBAAoB,CAAC,CAAC;IAC9D,CAAC,CAAC;AACJ,CAAC;AAlBD,4CAkBC"}

package/lib/server-utils/apiKeyMiddleware.spec.d.ts

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

package/lib/server-utils/apiKeyMiddleware.spec.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const UnAuthenticatedRequestError_1 = require("../error/UnAuthenticatedRequestError");
+const apiKeyMiddleware_1 = require("./apiKeyMiddleware");
+const keyIsValid = jest.fn().mockImplementation(() => true);
+const matrixKeyIsValid = jest.fn().mockImplementation(() => true);
+describe('apiKeyMiddleware', () => {
+    const middleware = (0, apiKeyMiddleware_1.apiKeyMiddleware)({ keyIsValid, matrixKeyIsValid });
+    it('should return an express middleware which', () => {
+        expect(middleware).toBeInstanceOf(Function);
+    });
+    describe('middleware', () => {
+        it('should call next is key is invalid but matrix ke is valid', () => {
+            const nextFunc = jest.fn().mockImplementation(() => {
+                /* no op */
+            });
+            keyIsValid.mockImplementation(() => false);
+            keyIsValid.mockImplementation(() => true);
+            middleware({ header: () => 'some-key' }, {}, nextFunc);
+            expect(nextFunc).toHaveBeenCalled();
+        });
+        it('should call next if api key is valid', () => {
+            const nextFunc = jest.fn().mockImplementation(() => {
+                /* no op */
+            });
+            middleware({ header: () => 'some-key' }, {}, nextFunc);
+            expect(nextFunc).toHaveBeenCalled();
+        });
+        it('should throw an UnAuthenticatedRequestError if key is invalid', () => {
+            const nextFunc = jest.fn().mockImplementation(() => {
+                /* no op */
+            });
+            keyIsValid.mockImplementation(() => false);
+            matrixKeyIsValid.mockImplementation(() => false);
+            expect(() => middleware({ header: () => 'some-key' }, {}, nextFunc)).toThrowError(new UnAuthenticatedRequestError_1.UnAuthenticatedRequestError(`API KEY IS INVALID`));
+        });
+    });
+});
+//# sourceMappingURL=apiKeyMiddleware.spec.js.map

package/lib/server-utils/apiKeyMiddleware.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiKeyMiddleware.spec.js","sourceRoot":"","sources":["../../src/server-utils/apiKeyMiddleware.spec.ts"],"names":[],"mappings":";;AAAA,sFAAmF;AACnF,yDAAsD;AAEtD,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;AAC5D,MAAM,gBAAgB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;AAElE,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,MAAM,UAAU,GAAG,IAAA,mCAAgB,EAAC,EAAE,UAAU,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAEtE,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,QAAQ,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE;gBACjD,WAAW;YACb,CAAC,CAAC,CAAC;YACH,UAAU,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;YAC3C,UAAU,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;YAE1C,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,UAAU,EAAS,EAAE,EAAS,EAAE,QAAQ,CAAC,CAAC;YAErE,MAAM,CAAC,QAAQ,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE;gBACjD,WAAW;YACb,CAAC,CAAC,CAAC;YAEH,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,UAAU,EAAS,EAAE,EAAS,EAAE,QAAQ,CAAC,CAAC;YAErE,MAAM,CAAC,QAAQ,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;YACvE,MAAM,QAAQ,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE;gBACjD,WAAW;YACb,CAAC,CAAC,CAAC;YAEH,UAAU,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;YAC3C,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;YAEjD,MAAM,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,UAAU,EAAS,EAAE,EAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,YAAY,CAC7F,IAAI,yDAA2B,CAAC,oBAAoB,CAAC,CACtD,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,29 +1,31 @@
 {
   "name": "@squiz/dx-common-lib",
-  "version": "1.2.12",
+  "version": "1.2.13-alpha.1",
   "description": "",
   "main": "lib/index.js",
   "scripts": {
-    "compile": "npx tsc",
+    "compile": "tsc",
     "lint": "eslint ./src --ext .ts",
     "test": "jest -c jest.config.ts",
     "test:update-snapshots": "jest -c jest.config.ts --updateSnapshot",
-    "clean": "rimraf \".tsbuildinfo\" \"./lib\""
+    "clean": "rimraf \"tsconfig.tsbuildinfo\" \"./lib\""
   },
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@squiz/dx-logger-lib": "1.2.12",
+    "@aws-sdk/client-secrets-manager": "3.218.0",
+    "@squiz/dx-json-schema-lib": "1.2.13-alpha.1",
+    "@squiz/dx-logger-lib": "1.2.13-alpha.1",
     "archiver": "5.3.1",
     "fs-extra": "10.1.0"
   },
   "devDependencies": {
     "@types/archiver": "5.3.1",
-    "@types/express": "4.17.13",
+    "@types/express": "4.17.14",
     "@types/fs-extra": "9.0.13",
     "@types/jest": "28.1.8",
     "@types/node": "17.0.27",
-    "dotenv": "16.0.2",
+    "dotenv": "16.0.3",
     "eslint": "8.22.0",
     "jest": "28.1.3",
     "rimraf": "3.0.2",
@@ -32,5 +34,5 @@
     "ts-node": "10.9.1",
     "typescript": "4.9.3"
   },
-  "gitHead": "dfecde850fcd8f456c07d11446d49d5e7c7aa0f9"
+  "gitHead": "25fd4ac4502cd93a5cfcd7e7a945a6f2f4fa925b"
 }

package/src/api-key-validation/ApiKeyValidationService.ts

@@ -0,0 +1,4 @@
+export interface ApiKeyValidationService {
+  keyIsValid(key: string | undefined): boolean;
+  matrixKeyIsValid(key: string | undefined): boolean;
+}

package/src/api-key-validation/CloudflareApiKeyService.spec.ts

@@ -0,0 +1,122 @@
+import { GetSecretValueCommand, SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
+import { UnAuthenticatedRequestError } from '../error/UnAuthenticatedRequestError';
+import { CloudflareApiKeyService } from './CloudflareApiKeyService';
+
+const sendSpy = jest.spyOn(SecretsManagerClient.prototype, 'send');
+
+jest.useFakeTimers();
+jest.spyOn(global, 'setInterval');
+
+describe('CloudflareApiKeyService', () => {
+  const service = new CloudflareApiKeyService('my-secret-name');
+
+  describe('refreshApiKeys', () => {
+    it('should throw an error if the secret value is not in the expected format', async () => {
+      sendSpy.mockImplementationOnce(() => Promise.resolve({ SecretString: 'bad json' }));
+
+      await expect(service.refreshApiKeys()).rejects.toThrowError(
+        new Error('failed to decode cloudflare api key values'),
+      );
+    });
+
+    it('should make a request to the aws secrets manager when refreshing the keys', async () => {
+      sendSpy.mockClear();
+      sendSpy.mockImplementationOnce(() => Promise.resolve({ SecretString: '{"keys":[]}' }));
+      await service.refreshApiKeys();
+
+      expect(sendSpy.mock.lastCall[0].input).toEqual({ SecretId: 'my-secret-name' });
+      expect(sendSpy.mock.lastCall[0]).toBeInstanceOf(GetSecretValueCommand);
+    });
+
+    it('should start a refresh timer once called, but only once', (done) => {
+      sendSpy.mockClear();
+      sendSpy.mockImplementationOnce(() => Promise.resolve({ SecretString: '{"keys":["my-new-key"]}' }));
+      const spy = jest.spyOn(service, 'refreshApiKeys');
+
+      expect(spy).not.toBeCalled();
+      expect(setInterval).toHaveBeenCalledTimes(1); // for the above 2 tests
+      jest.runOnlyPendingTimers();
+
+      expect(spy).toHaveBeenCalled();
+
+      jest.useRealTimers();
+      setTimeout(() => {
+        expect(service.keyIsValid('my-new-key')).toEqual(true);
+        done();
+      }, 5);
+    });
+  });
+
+  describe('keyIsValid', () => {
+    describe('when there are no api keys', () => {
+      beforeAll(async () => {
+        sendSpy.mockImplementation(() => Promise.resolve({ SecretString: '{"keys":[]}' }));
+        await service.refreshApiKeys();
+      });
+
+      it('should throw an unauthenticated request error when validating a key if there are no keys to validate against', () => {
+        expect(() => service.keyIsValid('anything')).toThrowError(
+          new UnAuthenticatedRequestError('No api keys to check against'),
+        );
+      });
+    });
+
+    describe('when there are api keys', () => {
+      beforeAll(async () => {
+        sendSpy.mockImplementation(() =>
+          Promise.resolve({ SecretString: '{"keys":["my-key", "my-other-key"], "matrix-keys":["my-matrix-key"]}' }),
+        );
+        await service.refreshApiKeys();
+      });
+      it('should return true when there are keys loaded and the input key is in the list of valid keys', () => {
+        expect(service.keyIsValid('my-key')).toEqual(true);
+        expect(service.keyIsValid('my-other-key')).toEqual(true);
+      });
+
+      it('should return false when there are keys loaded and the input key is not in the list of valid keys', async () => {
+        expect(service.keyIsValid('not-my-key')).toEqual(false);
+      });
+
+      it('should return false if trying to validate a matrix key', () => {
+        expect(service.keyIsValid('my-matrix-key')).toEqual(false);
+      });
+    });
+  });
+
+  describe('matrixKeyIsValid', () => {
+    describe('when there are no api keys', () => {
+      beforeAll(async () => {
+        sendSpy.mockImplementation(() => Promise.resolve({ SecretString: '{"keys":[], "matrix-keys":[]}' }));
+        await service.refreshApiKeys();
+      });
+
+      it('should throw an unauthenticated request error when validating a key if there are no keys to validate against', () => {
+        expect(() => service.matrixKeyIsValid('anything')).toThrowError(
+          new UnAuthenticatedRequestError('No api keys to check against'),
+        );
+      });
+    });
+
+    describe('when there are api keys', () => {
+      beforeAll(async () => {
+        sendSpy.mockImplementation(() =>
+          Promise.resolve({ SecretString: '{"keys":["my-key", "my-other-key"], "matrix-keys":["my-matrix-key"]}' }),
+        );
+        await service.refreshApiKeys();
+      });
+
+      it('should return true when there are keys loaded and the input key is in the list of valid matrix keys', () => {
+        expect(service.matrixKeyIsValid('my-matrix-key')).toEqual(true);
+      });
+
+      it('should return false when there are keys loaded and the input key is not in the list of valid matrix keys', async () => {
+        expect(service.matrixKeyIsValid('not-my-key')).toEqual(false);
+      });
+
+      it('should return false when using non matrix keys', async () => {
+        expect(service.matrixKeyIsValid('my-key')).toEqual(false);
+        expect(service.matrixKeyIsValid('my-other-key')).toEqual(false);
+      });
+    });
+  });
+});

package/src/api-key-validation/CloudflareApiKeyService.ts

@@ -0,0 +1,96 @@
+import {
+  GetSecretValueCommand,
+  GetSecretValueCommandOutput,
+  SecretsManagerClient,
+} from '@aws-sdk/client-secrets-manager';
+import { UnAuthenticatedRequestError } from '../error/UnAuthenticatedRequestError';
+import { ApiKeyValidationService } from './ApiKeyValidationService';
+import { getLogger, Logger } from '@squiz/dx-logger-lib';
+
+export interface CloudFlareKeys {
+  keys: string[];
+  'matrix-keys': string[];
+}
+
+let validKeys: CloudFlareKeys = {
+  keys: [],
+  'matrix-keys': [],
+};
+
+let refreshInterval: ReturnType<typeof setInterval>;
+// number must be smaller than 24 days.
+// This is because the value is int32 and maxes at than 2^31-1 milliseconds
+const REFRESH_TIMER = 7 * 24 * 3600 * 1000; // days, hours, seconds, milliseconds
+
+export class CloudflareApiKeyService implements ApiKeyValidationService {
+  protected secretsClient: SecretsManagerClient;
+  protected logger: Logger;
+
+  constructor(protected secretName: string, logger?: Logger) {
+    this.secretsClient = new SecretsManagerClient({
+      region: 'ap-southeast-2',
+    });
+
+    if (!logger) {
+      logger = getLogger({ name: 'CloudflareApiKeyService' });
+    }
+
+    this.logger = logger;
+  }
+
+  public keyIsValid(key: string): boolean {
+    if (validKeys.keys.length == 0) {
+      throw new UnAuthenticatedRequestError('No api keys to check against');
+    }
+
+    return validKeys.keys.includes(key);
+  }
+
+  public matrixKeyIsValid(key: string): boolean {
+    if (validKeys['matrix-keys'].length == 0) {
+      throw new UnAuthenticatedRequestError('No api keys to check against');
+    }
+
+    return validKeys['matrix-keys'].includes(key);
+  }
+
+  protected async getValidApiKeys(): Promise<CloudFlareKeys> {
+    let secretValue: GetSecretValueCommandOutput;
+
+    try {
+      secretValue = await this.secretsClient.send(
+        new GetSecretValueCommand({
+          SecretId: this.secretName,
+        }),
+      );
+    } catch (e: any) {
+      console.error(e);
+      throw new Error('Failed to request api key from aws' + e.message);
+    }
+
+    try {
+      const secret = JSON.parse(secretValue.SecretString!);
+
+      if (secret.keys) {
+        return secret;
+      }
+
+      throw new Error('api keys retrieved and decoded successfully but contained no values');
+    } catch (e) {
+      throw new Error('failed to decode cloudflare api key values');
+    }
+  }
+
+  public async refreshApiKeys() {
+    this.logger.info('refreshing keys');
+    validKeys = await this.getValidApiKeys();
+
+    this.logger.info(`number of valid keys found: ${validKeys.keys.length}`);
+
+    if (!refreshInterval) {
+      refreshInterval = setInterval(async () => {
+        await this.refreshApiKeys();
+      }, REFRESH_TIMER);
+    }
+  }
+}

package/src/api-key-validation/DevelopmentApiKeyService.spec.ts

@@ -0,0 +1,17 @@
+import { DevelopmentApiKeyService } from './DevelopmentApiKeyService';
+
+describe('DevelopmentApiKeyService', () => {
+  const service = new DevelopmentApiKeyService();
+
+  describe('keyIsValid', () => {
+    it('should always return true', () => {
+      expect(service.keyIsValid()).toEqual(true);
+    });
+  });
+
+  describe('matrixKeyIsValid', () => {
+    it('should always return true', () => {
+      expect(service.matrixKeyIsValid()).toEqual(true);
+    });
+  });
+});

package/src/api-key-validation/DevelopmentApiKeyService.ts

@@ -0,0 +1,10 @@
+import { ApiKeyValidationService } from './ApiKeyValidationService';
+
+export class DevelopmentApiKeyService implements ApiKeyValidationService {
+  public keyIsValid(): boolean {
+    return true;
+  }
+  public matrixKeyIsValid(): boolean {
+    return true;
+  }
+}