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

package/CHANGELOG.md

@@ -3,150 +3,90 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [1.2.12](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.12) (2022-11-24)
+## [1.2.13-alpha.1](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.13-alpha.1) (2023-01-13)
 
-**Note:** Version bump only for package @squiz/dx-common-lib
+### Bug Fixes
 
+- **deps:** update dependency constructs to v10.1.183 ([def2040](https://gitlab.squiz.net/developer-experience/cmp/commit/def204076fd709282067ccaa09f73f08824bdbf4))
 
+## [1.2.13-alpha.0](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.13-alpha.0) (2023-01-13)
 
+### Bug Fixes
 
+- **deps:** update dependency constructs to v10.1.183 ([def2040](https://gitlab.squiz.net/developer-experience/cmp/commit/def204076fd709282067ccaa09f73f08824bdbf4))
 
-## [1.2.11](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.11) (2022-11-11)
+## [1.2.12](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.12) (2022-11-24)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
+## [1.2.11](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.11) (2022-11-11)
 
-
-
+**Note:** Version bump only for package @squiz/dx-common-lib
 
 ## [1.2.10](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.10) (2022-11-09)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
-
-
-
-
 ## [1.2.9](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.9) (2022-11-04)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
-
-
-
-
 ## [1.2.8](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.8) (2022-10-21)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
-
-
-
-
 ## [1.2.7](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.7) (2022-10-20)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
-
-
-
-
 ## [1.2.6](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.6) (2022-10-20)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
-
-
-
-
 ## [1.2.5](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.2...v1.2.5) (2022-10-18)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
-
-
-
-
 ## [1.2.2](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1...v1.2.2) (2022-09-26)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
-
-
-
-
 ## [1.2.1](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1) (2022-09-23)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
-
-
-
-
 ## [1.2.1-alpha.107](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.107) (2022-09-21)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
-
-
-
-
 ## [1.2.1-alpha.106](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.106) (2022-09-02)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
-
-
-
-
 ## [1.2.1-alpha.105](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.105) (2022-08-26)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
-
-
-
-
 ## [1.2.1-alpha.104](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.104) (2022-08-23)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
-
-
-
-
 ## [1.2.1-alpha.103](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.103) (2022-08-23)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
-
-
-
-
 ## [1.2.1-alpha.102](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.102) (2022-08-23)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
-
-
-
-
 ## [1.2.1-alpha.101](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.101) (2022-08-19)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
-
-
-
-
 ## [1.2.1-alpha.100](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.100) (2022-08-18)
 
 **Note:** Version bump only for package @squiz/dx-common-lib
 
-
-
-
-
 ## [1.2.1-alpha.99](https://gitlab.squiz.net/developer-experience/cmp/compare/v1.2.1-alpha.90...v1.2.1-alpha.99) (2022-08-18)
 
 **Note:** Version bump only for package @squiz/dx-common-lib

package/lib/api-key-validation/ApiKeyValidationService.d.ts

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

package/lib/api-key-validation/ApiKeyValidationService.js

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

package/lib/api-key-validation/ApiKeyValidationService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiKeyValidationService.js","sourceRoot":"","sources":["../../src/api-key-validation/ApiKeyValidationService.ts"],"names":[],"mappings":""}

package/lib/api-key-validation/CloudflareApiKeyService.d.ts

@@ -0,0 +1,17 @@
+import { SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
+import { ApiKeyValidationService } from './ApiKeyValidationService';
+import { Logger } from '@squiz/dx-logger-lib';
+export interface CloudFlareKeys {
+    keys: string[];
+    'matrix-keys': string[];
+}
+export declare class CloudflareApiKeyService implements ApiKeyValidationService {
+    protected secretName: string;
+    protected secretsClient: SecretsManagerClient;
+    protected logger: Logger;
+    constructor(secretName: string, logger?: Logger);
+    keyIsValid(key: string): boolean;
+    matrixKeyIsValid(key: string): boolean;
+    protected getValidApiKeys(): Promise<CloudFlareKeys>;
+    refreshApiKeys(): Promise<void>;
+}

package/lib/api-key-validation/CloudflareApiKeyService.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudflareApiKeyService = void 0;
+const client_secrets_manager_1 = require("@aws-sdk/client-secrets-manager");
+const UnAuthenticatedRequestError_1 = require("../error/UnAuthenticatedRequestError");
+const dx_logger_lib_1 = require("@squiz/dx-logger-lib");
+let validKeys = {
+    keys: [],
+    'matrix-keys': [],
+};
+let refreshInterval;
+// 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
+class CloudflareApiKeyService {
+    constructor(secretName, logger) {
+        this.secretName = secretName;
+        this.secretsClient = new client_secrets_manager_1.SecretsManagerClient({
+            region: 'ap-southeast-2',
+        });
+        if (!logger) {
+            logger = (0, dx_logger_lib_1.getLogger)({ name: 'CloudflareApiKeyService' });
+        }
+        this.logger = logger;
+    }
+    keyIsValid(key) {
+        if (validKeys.keys.length == 0) {
+            throw new UnAuthenticatedRequestError_1.UnAuthenticatedRequestError('No api keys to check against');
+        }
+        return validKeys.keys.includes(key);
+    }
+    matrixKeyIsValid(key) {
+        if (validKeys['matrix-keys'].length == 0) {
+            throw new UnAuthenticatedRequestError_1.UnAuthenticatedRequestError('No api keys to check against');
+        }
+        return validKeys['matrix-keys'].includes(key);
+    }
+    async getValidApiKeys() {
+        let secretValue;
+        try {
+            secretValue = await this.secretsClient.send(new client_secrets_manager_1.GetSecretValueCommand({
+                SecretId: this.secretName,
+            }));
+        }
+        catch (e) {
+            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');
+        }
+    }
+    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);
+        }
+    }
+}
+exports.CloudflareApiKeyService = CloudflareApiKeyService;
+//# sourceMappingURL=CloudflareApiKeyService.js.map

package/lib/api-key-validation/CloudflareApiKeyService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CloudflareApiKeyService.js","sourceRoot":"","sources":["../../src/api-key-validation/CloudflareApiKeyService.ts"],"names":[],"mappings":";;;AAAA,4EAIyC;AACzC,sFAAmF;AAEnF,wDAAyD;AAOzD,IAAI,SAAS,GAAmB;IAC9B,IAAI,EAAE,EAAE;IACR,aAAa,EAAE,EAAE;CAClB,CAAC;AAEF,IAAI,eAA+C,CAAC;AACpD,uCAAuC;AACvC,2EAA2E;AAC3E,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,qCAAqC;AAEjF,MAAa,uBAAuB;IAIlC,YAAsB,UAAkB,EAAE,MAAe;QAAnC,eAAU,GAAV,UAAU,CAAQ;QACtC,IAAI,CAAC,aAAa,GAAG,IAAI,6CAAoB,CAAC;YAC5C,MAAM,EAAE,gBAAgB;SACzB,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,GAAG,IAAA,yBAAS,EAAC,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAC,CAAC;SACzD;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEM,UAAU,CAAC,GAAW;QAC3B,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE;YAC9B,MAAM,IAAI,yDAA2B,CAAC,8BAA8B,CAAC,CAAC;SACvE;QAED,OAAO,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;IAEM,gBAAgB,CAAC,GAAW;QACjC,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE;YACxC,MAAM,IAAI,yDAA2B,CAAC,8BAA8B,CAAC,CAAC;SACvE;QAED,OAAO,SAAS,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAChD,CAAC;IAES,KAAK,CAAC,eAAe;QAC7B,IAAI,WAAwC,CAAC;QAE7C,IAAI;YACF,WAAW,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CACzC,IAAI,8CAAqB,CAAC;gBACxB,QAAQ,EAAE,IAAI,CAAC,UAAU;aAC1B,CAAC,CACH,CAAC;SACH;QAAC,OAAO,CAAM,EAAE;YACf,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,oCAAoC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;SACnE;QAED,IAAI;YACF,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,YAAa,CAAC,CAAC;YAErD,IAAI,MAAM,CAAC,IAAI,EAAE;gBACf,OAAO,MAAM,CAAC;aACf;YAED,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;SACxF;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;SAC/D;IACH,CAAC;IAEM,KAAK,CAAC,cAAc;QACzB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACpC,SAAS,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAEzC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,+BAA+B,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAEzE,IAAI,CAAC,eAAe,EAAE;YACpB,eAAe,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE;gBACvC,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;YAC9B,CAAC,EAAE,aAAa,CAAC,CAAC;SACnB;IACH,CAAC;CACF;AAvED,0DAuEC"}

package/lib/api-key-validation/CloudflareApiKeyService.spec.d.ts

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

package/lib/api-key-validation/CloudflareApiKeyService.spec.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const client_secrets_manager_1 = require("@aws-sdk/client-secrets-manager");
+const UnAuthenticatedRequestError_1 = require("../error/UnAuthenticatedRequestError");
+const CloudflareApiKeyService_1 = require("./CloudflareApiKeyService");
+const sendSpy = jest.spyOn(client_secrets_manager_1.SecretsManagerClient.prototype, 'send');
+jest.useFakeTimers();
+jest.spyOn(global, 'setInterval');
+describe('CloudflareApiKeyService', () => {
+    const service = new CloudflareApiKeyService_1.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(client_secrets_manager_1.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_1.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_1.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);
+            });
+        });
+    });
+});
+//# sourceMappingURL=CloudflareApiKeyService.spec.js.map

package/lib/api-key-validation/CloudflareApiKeyService.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CloudflareApiKeyService.spec.js","sourceRoot":"","sources":["../../src/api-key-validation/CloudflareApiKeyService.spec.ts"],"names":[],"mappings":";;AAAA,4EAA8F;AAC9F,sFAAmF;AACnF,uEAAoE;AAEpE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,6CAAoB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;AAEnE,IAAI,CAAC,aAAa,EAAE,CAAC;AACrB,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAElC,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACvC,MAAM,OAAO,GAAG,IAAI,iDAAuB,CAAC,gBAAgB,CAAC,CAAC;IAE9D,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;YACvF,OAAO,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;YAEpF,MAAM,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CACzD,IAAI,KAAK,CAAC,4CAA4C,CAAC,CACxD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2EAA2E,EAAE,KAAK,IAAI,EAAE;YACzF,OAAO,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;YACvF,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;YAE/B,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,CAAC;YAC/E,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,8CAAqB,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yDAAyD,EAAE,CAAC,IAAI,EAAE,EAAE;YACrE,OAAO,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,yBAAyB,EAAE,CAAC,CAAC,CAAC;YACnG,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;YAElD,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;YAC7B,MAAM,CAAC,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,wBAAwB;YACtE,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAE5B,MAAM,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,CAAC;YAE/B,IAAI,CAAC,aAAa,EAAE,CAAC;YACrB,UAAU,CAAC,GAAG,EAAE;gBACd,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACvD,IAAI,EAAE,CAAC;YACT,CAAC,EAAE,CAAC,CAAC,CAAC;QACR,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;YAC1C,SAAS,CAAC,KAAK,IAAI,EAAE;gBACnB,OAAO,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC;gBACnF,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,8GAA8G,EAAE,GAAG,EAAE;gBACtH,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CACvD,IAAI,yDAA2B,CAAC,8BAA8B,CAAC,CAChE,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;YACvC,SAAS,CAAC,KAAK,IAAI,EAAE;gBACnB,OAAO,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAC9B,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,sEAAsE,EAAE,CAAC,CAC1G,CAAC;gBACF,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;YACjC,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,8FAA8F,EAAE,GAAG,EAAE;gBACtG,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACnD,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC3D,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,mGAAmG,EAAE,KAAK,IAAI,EAAE;gBACjH,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC1D,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;gBAChE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC7D,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;YAC1C,SAAS,CAAC,KAAK,IAAI,EAAE;gBACnB,OAAO,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,+BAA+B,EAAE,CAAC,CAAC,CAAC;gBACrG,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,8GAA8G,EAAE,GAAG,EAAE;gBACtH,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAC7D,IAAI,yDAA2B,CAAC,8BAA8B,CAAC,CAChE,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;YACvC,SAAS,CAAC,KAAK,IAAI,EAAE;gBACnB,OAAO,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAC9B,OAAO,CAAC,OAAO,CAAC,EAAE,YAAY,EAAE,sEAAsE,EAAE,CAAC,CAC1G,CAAC;gBACF,MAAM,OAAO,CAAC,cAAc,EAAE,CAAC;YACjC,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,qGAAqG,EAAE,GAAG,EAAE;gBAC7G,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAClE,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,0GAA0G,EAAE,KAAK,IAAI,EAAE;gBACxH,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAChE,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;gBAC9D,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC1D,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAClE,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/api-key-validation/DevelopmentApiKeyService.d.ts

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

package/lib/api-key-validation/DevelopmentApiKeyService.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DevelopmentApiKeyService = void 0;
+class DevelopmentApiKeyService {
+    keyIsValid() {
+        return true;
+    }
+    matrixKeyIsValid() {
+        return true;
+    }
+}
+exports.DevelopmentApiKeyService = DevelopmentApiKeyService;
+//# sourceMappingURL=DevelopmentApiKeyService.js.map

package/lib/api-key-validation/DevelopmentApiKeyService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DevelopmentApiKeyService.js","sourceRoot":"","sources":["../../src/api-key-validation/DevelopmentApiKeyService.ts"],"names":[],"mappings":";;;AAEA,MAAa,wBAAwB;IAC5B,UAAU;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IACM,gBAAgB;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAPD,4DAOC"}

package/lib/api-key-validation/DevelopmentApiKeyService.spec.d.ts

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

package/lib/api-key-validation/DevelopmentApiKeyService.spec.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const DevelopmentApiKeyService_1 = require("./DevelopmentApiKeyService");
+describe('DevelopmentApiKeyService', () => {
+    const service = new DevelopmentApiKeyService_1.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);
+        });
+    });
+});
+//# sourceMappingURL=DevelopmentApiKeyService.spec.js.map

package/lib/api-key-validation/DevelopmentApiKeyService.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DevelopmentApiKeyService.spec.js","sourceRoot":"","sources":["../../src/api-key-validation/DevelopmentApiKeyService.spec.ts"],"names":[],"mappings":";;AAAA,yEAAsE;AAEtE,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,MAAM,OAAO,GAAG,IAAI,mDAAwB,EAAE,CAAC;IAE/C,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/api-key-validation/getApiKeyService.d.ts

@@ -0,0 +1,6 @@
+import { CloudflareApiKeyService } from './CloudflareApiKeyService';
+import { DevelopmentApiKeyService } from './DevelopmentApiKeyService';
+export declare function getApiKeyService(prodEnv?: {
+    deploymentEnvironment: string;
+    squizRegion: string;
+}): DevelopmentApiKeyService | CloudflareApiKeyService;

package/lib/api-key-validation/getApiKeyService.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getApiKeyService = void 0;
+const util_1 = require("../util");
+const CloudflareApiKeyService_1 = require("./CloudflareApiKeyService");
+const DevelopmentApiKeyService_1 = require("./DevelopmentApiKeyService");
+function getApiKeyService(prodEnv) {
+    const env = (0, util_1.getNodeEnv)();
+    switch (env) {
+        // this the DX team dev environment
+        case 'development':
+            return new DevelopmentApiKeyService_1.DevelopmentApiKeyService();
+        case 'production':
+            if (prodEnv == undefined) {
+                throw new Error(`invalid production state, need to have deploymentEnvironment and squiz region set`);
+            }
+            return new CloudflareApiKeyService_1.CloudflareApiKeyService(`dx-${prodEnv.deploymentEnvironment}-${prodEnv.squizRegion}-cmp-cloudflare-keys`);
+        default:
+            (0, util_1.never)(env);
+    }
+}
+exports.getApiKeyService = getApiKeyService;
+//# sourceMappingURL=getApiKeyService.js.map

package/lib/api-key-validation/getApiKeyService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getApiKeyService.js","sourceRoot":"","sources":["../../src/api-key-validation/getApiKeyService.ts"],"names":[],"mappings":";;;AAAA,kCAA4C;AAC5C,uEAAoE;AACpE,yEAAsE;AAEtE,SAAgB,gBAAgB,CAAC,OAGhC;IACC,MAAM,GAAG,GAAG,IAAA,iBAAU,GAAE,CAAC;IAEzB,QAAQ,GAAG,EAAE;QACX,mCAAmC;QACnC,KAAK,aAAa;YAChB,OAAO,IAAI,mDAAwB,EAAE,CAAC;QACxC,KAAK,YAAY;YACf,IAAI,OAAO,IAAI,SAAS,EAAE;gBACxB,MAAM,IAAI,KAAK,CAAC,mFAAmF,CAAC,CAAC;aACtG;YAED,OAAO,IAAI,iDAAuB,CAChC,MAAM,OAAO,CAAC,qBAAqB,IAAI,OAAO,CAAC,WAAW,sBAAsB,CACjF,CAAC;QAEJ;YACE,IAAA,YAAK,EAAC,GAAG,CAAC,CAAC;KACd;AACH,CAAC;AAtBD,4CAsBC"}

package/lib/api-key-validation/getApiKeyService.spec.d.ts

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

package/lib/api-key-validation/getApiKeyService.spec.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const CloudflareApiKeyService_1 = require("./CloudflareApiKeyService");
+const DevelopmentApiKeyService_1 = require("./DevelopmentApiKeyService");
+const getApiKeyService_1 = require("./getApiKeyService");
+describe('getApiKeyService', () => {
+    it('should return an instance of DevelopmentApiKeyService when NODE_ENV is development', () => {
+        process.env.NODE_ENV = 'development';
+        expect((0, getApiKeyService_1.getApiKeyService)()).toBeInstanceOf(DevelopmentApiKeyService_1.DevelopmentApiKeyService);
+    });
+    it('should return an instance of CloudflareApiKeyService when NODE_ENV is production', () => {
+        process.env.NODE_ENV = 'production';
+        expect((0, getApiKeyService_1.getApiKeyService)({ deploymentEnvironment: 'any', squizRegion: 'value' })).toBeInstanceOf(CloudflareApiKeyService_1.CloudflareApiKeyService);
+    });
+    it('should throw an error if no prodEnv values available', () => {
+        process.env.NODE_ENV = 'production';
+        expect(() => (0, getApiKeyService_1.getApiKeyService)()).toThrow(new Error(`invalid production state, need to have deploymentEnvironment and squiz region set`));
+    });
+    it('should throw an error if NODE_ENV is anything other than development or production', () => {
+        process.env.NODE_ENV = 'something invalid';
+        expect(() => (0, getApiKeyService_1.getApiKeyService)()).toThrow(new Error(`NODE_ENV env var can only be values "production" or "development"`));
+    });
+});
+//# sourceMappingURL=getApiKeyService.spec.js.map

package/lib/api-key-validation/getApiKeyService.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getApiKeyService.spec.js","sourceRoot":"","sources":["../../src/api-key-validation/getApiKeyService.spec.ts"],"names":[],"mappings":";;AAAA,uEAAoE;AACpE,yEAAsE;AACtE,yDAAsD;AAEtD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,EAAE,CAAC,oFAAoF,EAAE,GAAG,EAAE;QAC5F,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,aAAa,CAAC;QACrC,MAAM,CAAC,IAAA,mCAAgB,GAAE,CAAC,CAAC,cAAc,CAAC,mDAAwB,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kFAAkF,EAAE,GAAG,EAAE;QAC1F,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,YAAY,CAAC;QACpC,MAAM,CAAC,IAAA,mCAAgB,EAAC,EAAE,qBAAqB,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,cAAc,CAC7F,iDAAuB,CACxB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,YAAY,CAAC;QACpC,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,mCAAgB,GAAE,CAAC,CAAC,OAAO,CACtC,IAAI,KAAK,CAAC,mFAAmF,CAAC,CAC/F,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oFAAoF,EAAE,GAAG,EAAE;QAC5F,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,mBAAmB,CAAC;QAE3C,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,mCAAgB,GAAE,CAAC,CAAC,OAAO,CACtC,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAC/E,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/cache/applyDefaultRulesToCacheControlObject.d.ts

@@ -0,0 +1,19 @@
+import { CacheControl } from './parseCacheControl';
+export declare function applyDefaultRulesToCacheControlObject(cacheControlInput: CacheControl): {
+    [x: string]: string | number | boolean | undefined;
+    'max-age'?: number | undefined;
+    's-maxage'?: number | undefined;
+    'min-fresh'?: number | undefined;
+    'stale-while-revalidate'?: number | undefined;
+    'stale-if-error'?: number | undefined;
+    public?: true | undefined;
+    private?: true | undefined;
+    'no-store'?: true | undefined;
+    'no-cache'?: true | undefined;
+    'no-transform'?: true | undefined;
+    'must-revalidate'?: true | undefined;
+    'proxy-revalidate'?: true | undefined;
+    'must-understand'?: true | undefined;
+    immutable?: true | undefined;
+    extension?: string | undefined;
+};

package/lib/cache/applyDefaultRulesToCacheControlObject.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyDefaultRulesToCacheControlObject = void 0;
+const parseAndSanitiseCacheControlHeader_1 = require("./parseAndSanitiseCacheControlHeader");
+function applyDefaultRulesToCacheControlObject(cacheControlInput) {
+    const cacheControl = { ...cacheControlInput };
+    if (cacheControl['max-age'] !== undefined) {
+        cacheControl['max-age'] = (0, parseAndSanitiseCacheControlHeader_1.ensureBetween)(cacheControl['max-age'], parseAndSanitiseCacheControlHeader_1.MIN_CACHE_SECONDS, parseAndSanitiseCacheControlHeader_1.MAX_CACHE_SECONDS);
+    }
+    if (cacheControl['s-maxage'] !== undefined) {
+        cacheControl['s-maxage'] = (0, parseAndSanitiseCacheControlHeader_1.ensureBetween)(cacheControl['s-maxage'], parseAndSanitiseCacheControlHeader_1.MIN_CACHE_SECONDS, parseAndSanitiseCacheControlHeader_1.MAX_CACHE_SECONDS);
+    }
+    if (cacheControl['min-fresh'] !== undefined) {
+        cacheControl['min-fresh'] = (0, parseAndSanitiseCacheControlHeader_1.ensureBetween)(cacheControl['min-fresh'], parseAndSanitiseCacheControlHeader_1.MIN_CACHE_SECONDS, parseAndSanitiseCacheControlHeader_1.MAX_CACHE_SECONDS);
+    }
+    delete cacheControl['no-store'];
+    delete cacheControl['no-cache'];
+    return cacheControl;
+}
+exports.applyDefaultRulesToCacheControlObject = applyDefaultRulesToCacheControlObject;
+//# sourceMappingURL=applyDefaultRulesToCacheControlObject.js.map

package/lib/cache/applyDefaultRulesToCacheControlObject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"applyDefaultRulesToCacheControlObject.js","sourceRoot":"","sources":["../../src/cache/applyDefaultRulesToCacheControlObject.ts"],"names":[],"mappings":";;;AACA,6FAA2G;AAE3G,SAAgB,qCAAqC,CAAC,iBAA+B;IACnF,MAAM,YAAY,GAAG,EAAE,GAAG,iBAAiB,EAAE,CAAC;IAE9C,IAAI,YAAY,CAAC,SAAS,CAAC,KAAK,SAAS,EAAE;QACzC,YAAY,CAAC,SAAS,CAAC,GAAG,IAAA,kDAAa,EAAC,YAAY,CAAC,SAAS,CAAC,EAAE,sDAAiB,EAAE,sDAAiB,CAAC,CAAC;KACxG;IAED,IAAI,YAAY,CAAC,UAAU,CAAC,KAAK,SAAS,EAAE;QAC1C,YAAY,CAAC,UAAU,CAAC,GAAG,IAAA,kDAAa,EAAC,YAAY,CAAC,UAAU,CAAC,EAAE,sDAAiB,EAAE,sDAAiB,CAAC,CAAC;KAC1G;IAED,IAAI,YAAY,CAAC,WAAW,CAAC,KAAK,SAAS,EAAE;QAC3C,YAAY,CAAC,WAAW,CAAC,GAAG,IAAA,kDAAa,EAAC,YAAY,CAAC,WAAW,CAAC,EAAE,sDAAiB,EAAE,sDAAiB,CAAC,CAAC;KAC5G;IAED,OAAO,YAAY,CAAC,UAAU,CAAC,CAAC;IAChC,OAAO,YAAY,CAAC,UAAU,CAAC,CAAC;IAEhC,OAAO,YAAY,CAAC;AACtB,CAAC;AAnBD,sFAmBC"}

package/lib/cache/applyDefaultRulesToCacheControlObject.spec.d.ts

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