@squiz/dx-common-lib 1.71.1 → 1.72.1

package/lib/secret-api-key-service/getSecretApiKeyService.spec.js

@@ -0,0 +1,313 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const getSecretApiKeyService_1 = require("./getSecretApiKeyService");
+const DevSecretApiKeyService_1 = require("./DevSecretApiKeyService");
+const SecretApiKeyService_1 = require("./SecretApiKeyService");
+// Mock the util module
+jest.mock('../util', () => ({
+    getNodeEnv: jest.fn(),
+    never: jest.fn((value) => {
+        throw new Error(`Unexpected value: ${value}`);
+    }),
+}));
+// Import the mocked function
+const util_1 = require("../util");
+const mockGetNodeEnv = util_1.getNodeEnv;
+describe('getSecretApiKeyService', () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+    describe('Development Environment', () => {
+        beforeEach(() => {
+            mockGetNodeEnv.mockReturnValue('development');
+        });
+        it('should return EnvApiKeyService when environment is development', () => {
+            const envVars = {
+                deploymentEnvironment: 'dev',
+                apiKey: 'test-dev-api-key',
+            };
+            const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+            expect(service).toBeInstanceOf(DevSecretApiKeyService_1.DevSecretApiKeyService);
+        });
+        it('should pass API key to EnvApiKeyService', async () => {
+            const apiKey = 'my-dev-api-key-123';
+            const envVars = {
+                deploymentEnvironment: 'dev',
+                apiKey,
+            };
+            const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+            const result = await service.getApiKey();
+            expect(result).toBe(apiKey);
+        });
+        it('should create EnvApiKeyService even when awsRegion is provided', () => {
+            const envVars = {
+                deploymentEnvironment: 'dev',
+                apiKey: 'dev-key',
+                awsRegion: 'us-east-1', // This should be ignored in dev
+                secretName: 'some-secret', // This should also be ignored
+            };
+            const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+            expect(service).toBeInstanceOf(DevSecretApiKeyService_1.DevSecretApiKeyService);
+        });
+        it('should throw error if apiKey is empty in development', () => {
+            const envVars = {
+                deploymentEnvironment: 'dev',
+                apiKey: '',
+            };
+            expect(() => (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars)).toThrow('API key must be a non-empty string');
+        });
+        it('should throw error if apiKey is undefined in development', () => {
+            const envVars = {
+                deploymentEnvironment: 'dev',
+                apiKey: undefined,
+            };
+            // TypeScript will complain, but at runtime this could happen
+            expect(() => (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars)).toThrow();
+        });
+        it('should handle whitespace-only apiKey in development', () => {
+            const envVars = {
+                deploymentEnvironment: 'dev',
+                apiKey: '   ',
+            };
+            expect(() => (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars)).toThrow('API key must be a non-empty string');
+        });
+    });
+    describe('Production Environment', () => {
+        beforeEach(() => {
+            mockGetNodeEnv.mockReturnValue('production');
+        });
+        it('should return SecretApiKeyService when environment is production', () => {
+            const envVars = {
+                deploymentEnvironment: 'prod',
+                secretName: 'my-secret-name',
+                awsRegion: 'us-east-1',
+            };
+            const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+            expect(service).toBeInstanceOf(SecretApiKeyService_1.SecretApiKeyService);
+        });
+        it('should pass secretName and awsRegion to SecretApiKeyService', () => {
+            const secretName = '/servicekeys-prod-us/metrics-api';
+            const awsRegion = 'ap-southeast-2';
+            const envVars = {
+                deploymentEnvironment: 'prod',
+                secretName,
+                awsRegion,
+            };
+            const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+            expect(service).toBeInstanceOf(SecretApiKeyService_1.SecretApiKeyService);
+            // We can't directly inspect the private properties, but we can verify the type
+        });
+        it('should create SecretApiKeyService even when apiKey is provided', () => {
+            const envVars = {
+                deploymentEnvironment: 'prod',
+                apiKey: 'some-key', // This should be ignored in prod
+                secretName: 'my-secret',
+                awsRegion: 'us-west-2',
+            };
+            const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+            expect(service).toBeInstanceOf(SecretApiKeyService_1.SecretApiKeyService);
+        });
+        it('should handle production with various AWS regions', () => {
+            const regions = ['us-east-1', 'us-west-2', 'eu-west-1', 'ap-southeast-2', 'ap-northeast-1'];
+            regions.forEach((region) => {
+                const envVars = {
+                    deploymentEnvironment: 'prod',
+                    secretName: 'test-secret',
+                    awsRegion: region,
+                };
+                const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+                expect(service).toBeInstanceOf(SecretApiKeyService_1.SecretApiKeyService);
+            });
+        });
+        it('should handle production with various secret name formats', () => {
+            const secretNames = [
+                '/servicekeys-prod-us/metrics',
+                'servicekeys-dev-au/feaas-metrics',
+                'arn:aws:secretsmanager:us-east-1:123456789:secret:metrics-key',
+                'simple-secret-name',
+            ];
+            secretNames.forEach((secretName) => {
+                const envVars = {
+                    deploymentEnvironment: 'prod',
+                    secretName,
+                    awsRegion: 'us-east-1',
+                };
+                const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+                expect(service).toBeInstanceOf(SecretApiKeyService_1.SecretApiKeyService);
+            });
+        });
+    });
+    describe('Invalid Environment', () => {
+        it('should throw error for test environment', () => {
+            mockGetNodeEnv.mockReturnValue('test');
+            const envVars = {
+                deploymentEnvironment: 'test',
+                apiKey: 'test-key',
+            };
+            expect(() => (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars)).toThrow();
+        });
+        it('should throw error for staging environment', () => {
+            mockGetNodeEnv.mockReturnValue('staging');
+            const envVars = {
+                deploymentEnvironment: 'staging',
+                apiKey: 'staging-key',
+            };
+            expect(() => (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars)).toThrow();
+        });
+        it('should throw error for unknown environment', () => {
+            mockGetNodeEnv.mockReturnValue('unknown');
+            const envVars = {
+                deploymentEnvironment: 'unknown',
+                apiKey: 'unknown-key',
+            };
+            expect(() => (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars)).toThrow();
+        });
+        it('should throw error for empty string environment', () => {
+            mockGetNodeEnv.mockReturnValue('');
+            const envVars = {
+                deploymentEnvironment: '',
+                apiKey: 'test-key',
+            };
+            expect(() => (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars)).toThrow();
+        });
+    });
+    describe('Environment Variables Validation', () => {
+        it('should handle envVars with all possible fields in development', () => {
+            mockGetNodeEnv.mockReturnValue('development');
+            const envVars = {
+                deploymentEnvironment: 'dev',
+                apiKey: 'dev-key',
+                awsRegion: 'us-east-1',
+                secretName: 'secret-name',
+            };
+            const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+            expect(service).toBeInstanceOf(DevSecretApiKeyService_1.DevSecretApiKeyService);
+        });
+        it('should handle envVars with only required fields for production', () => {
+            mockGetNodeEnv.mockReturnValue('production');
+            const envVars = {
+                deploymentEnvironment: 'prod',
+                secretName: 'secret-name',
+                awsRegion: 'us-east-1',
+            };
+            const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+            expect(service).toBeInstanceOf(SecretApiKeyService_1.SecretApiKeyService);
+        });
+        it('should handle different deployment environments', () => {
+            mockGetNodeEnv.mockReturnValue('development');
+            const deploymentEnvs = ['dev', 'development', 'local', 'dev-au', 'dev-us'];
+            deploymentEnvs.forEach((deploymentEnv) => {
+                const envVars = {
+                    deploymentEnvironment: deploymentEnv,
+                    apiKey: 'test-key',
+                };
+                const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+                expect(service).toBeInstanceOf(DevSecretApiKeyService_1.DevSecretApiKeyService);
+            });
+        });
+    });
+    describe('Real-world Scenarios', () => {
+        it('should handle local development scenario', async () => {
+            mockGetNodeEnv.mockReturnValue('development');
+            const envVars = {
+                deploymentEnvironment: 'dev-au',
+                apiKey: 'local-dev-metrics-api-key-12345',
+            };
+            const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+            const apiKey = await service.getApiKey();
+            expect(service).toBeInstanceOf(DevSecretApiKeyService_1.DevSecretApiKeyService);
+            expect(apiKey).toBe('local-dev-metrics-api-key-12345');
+        });
+        it('should handle production AWS scenario', () => {
+            mockGetNodeEnv.mockReturnValue('production');
+            const envVars = {
+                deploymentEnvironment: 'prod-us',
+                secretName: '/servicekeys-prod-us/feaas-metrics',
+                awsRegion: 'us-east-1',
+            };
+            const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+            expect(service).toBeInstanceOf(SecretApiKeyService_1.SecretApiKeyService);
+        });
+        it('should handle Australian region production scenario', () => {
+            mockGetNodeEnv.mockReturnValue('production');
+            const envVars = {
+                deploymentEnvironment: 'prod-au',
+                secretName: '/servicekeys-prod-au/feaas-metrics',
+                awsRegion: 'ap-southeast-2',
+            };
+            const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+            expect(service).toBeInstanceOf(SecretApiKeyService_1.SecretApiKeyService);
+        });
+        it('should create different instances for different calls', () => {
+            mockGetNodeEnv.mockReturnValue('development');
+            const envVars1 = {
+                deploymentEnvironment: 'dev',
+                apiKey: 'key-1',
+            };
+            const envVars2 = {
+                deploymentEnvironment: 'dev',
+                apiKey: 'key-2',
+            };
+            const service1 = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars1);
+            const service2 = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars2);
+            // Should be different instances
+            expect(service1).not.toBe(service2);
+        });
+    });
+    describe('Edge Cases', () => {
+        it('should handle very long secret names in production', () => {
+            mockGetNodeEnv.mockReturnValue('production');
+            const envVars = {
+                deploymentEnvironment: 'prod',
+                secretName: '/very/long/secret/path/with/many/segments/'.repeat(10),
+                awsRegion: 'us-east-1',
+            };
+            const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+            expect(service).toBeInstanceOf(SecretApiKeyService_1.SecretApiKeyService);
+        });
+        it('should handle very long API keys in development', () => {
+            mockGetNodeEnv.mockReturnValue('development');
+            const envVars = {
+                deploymentEnvironment: 'dev',
+                apiKey: 'x'.repeat(1000),
+            };
+            const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+            expect(service).toBeInstanceOf(DevSecretApiKeyService_1.DevSecretApiKeyService);
+        });
+        it('should handle special characters in secretName', () => {
+            mockGetNodeEnv.mockReturnValue('production');
+            const envVars = {
+                deploymentEnvironment: 'prod',
+                secretName: '/servicekeys-prod_us/feaas.metrics-api',
+                awsRegion: 'us-east-1',
+            };
+            const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+            expect(service).toBeInstanceOf(SecretApiKeyService_1.SecretApiKeyService);
+        });
+    });
+    describe('Type Safety', () => {
+        it('should accept all valid envVars properties', () => {
+            mockGetNodeEnv.mockReturnValue('development');
+            const envVars = {
+                deploymentEnvironment: 'dev',
+                apiKey: 'key',
+                awsRegion: undefined,
+                secretName: 'secret',
+            };
+            const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+            expect(service).toBeInstanceOf(DevSecretApiKeyService_1.DevSecretApiKeyService);
+        });
+        it('should handle optional undefined properties correctly', () => {
+            mockGetNodeEnv.mockReturnValue('production');
+            const envVars = {
+                deploymentEnvironment: 'prod',
+                apiKey: undefined,
+                awsRegion: 'us-east-1',
+                secretName: 'secret-name',
+            };
+            const service = (0, getSecretApiKeyService_1.getSecretApiKeyService)(envVars);
+            expect(service).toBeInstanceOf(SecretApiKeyService_1.SecretApiKeyService);
+        });
+    });
+});
+//# sourceMappingURL=getSecretApiKeyService.spec.js.map

package/lib/secret-api-key-service/getSecretApiKeyService.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getSecretApiKeyService.spec.js","sourceRoot":"","sources":["../../src/secret-api-key-service/getSecretApiKeyService.spec.ts"],"names":[],"mappings":";;AAAA,qEAAkE;AAClE,qEAAkE;AAClE,+DAA4D;AAE5D,uBAAuB;AACvB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC;IAC1B,UAAU,EAAE,IAAI,CAAC,EAAE,EAAE;IACrB,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,KAAY,EAAE,EAAE;QAC9B,MAAM,IAAI,KAAK,CAAC,qBAAqB,KAAK,EAAE,CAAC,CAAC;IAChD,CAAC,CAAC;CACH,CAAC,CAAC,CAAC;AAEJ,6BAA6B;AAC7B,kCAAqC;AAErC,MAAM,cAAc,GAAG,iBAAoD,CAAC;AAE5E,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;IACtC,UAAU,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACvC,UAAU,CAAC,GAAG,EAAE;YACd,cAAc,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;YACxE,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,KAAK;gBAC5B,MAAM,EAAE,kBAAkB;aAC3B,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;YAEhD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,+CAAsB,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;YACvD,MAAM,MAAM,GAAG,oBAAoB,CAAC;YACpC,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,KAAK;gBAC5B,MAAM;aACP,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;YAEzC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;YACxE,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,KAAK;gBAC5B,MAAM,EAAE,SAAS;gBACjB,SAAS,EAAE,WAAW,EAAE,gCAAgC;gBACxD,UAAU,EAAE,aAAa,EAAE,8BAA8B;aAC1D,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;YAEhD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,+CAAsB,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC9D,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,KAAK;gBAC5B,MAAM,EAAE,EAAE;aACX,CAAC;YAEF,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;QAC9F,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;YAClE,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,KAAK;gBAC5B,MAAM,EAAE,SAAS;aAClB,CAAC;YAEF,6DAA6D;YAC7D,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,+CAAsB,EAAC,OAAc,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACjE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC7D,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,KAAK;gBAC5B,MAAM,EAAE,KAAK;aACd,CAAC;YAEF,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;QAC9F,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACtC,UAAU,CAAC,GAAG,EAAE;YACd,cAAc,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;YAC1E,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,MAAM;gBAC7B,UAAU,EAAE,gBAAgB;gBAC5B,SAAS,EAAE,WAAW;aACvB,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;YAEhD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,yCAAmB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;YACrE,MAAM,UAAU,GAAG,kCAAkC,CAAC;YACtD,MAAM,SAAS,GAAG,gBAAgB,CAAC;YACnC,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,MAAM;gBAC7B,UAAU;gBACV,SAAS;aACV,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;YAEhD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,yCAAmB,CAAC,CAAC;YACpD,+EAA+E;QACjF,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;YACxE,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,MAAM;gBAC7B,MAAM,EAAE,UAAU,EAAE,iCAAiC;gBACrD,UAAU,EAAE,WAAW;gBACvB,SAAS,EAAE,WAAW;aACvB,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;YAEhD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,yCAAmB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YAC3D,MAAM,OAAO,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;YAE5F,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;gBACzB,MAAM,OAAO,GAAG;oBACd,qBAAqB,EAAE,MAAM;oBAC7B,UAAU,EAAE,aAAa;oBACzB,SAAS,EAAE,MAAM;iBAClB,CAAC;gBAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;gBAChD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,yCAAmB,CAAC,CAAC;YACtD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,WAAW,GAAG;gBAClB,8BAA8B;gBAC9B,kCAAkC;gBAClC,+DAA+D;gBAC/D,oBAAoB;aACrB,CAAC;YAEF,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBACjC,MAAM,OAAO,GAAG;oBACd,qBAAqB,EAAE,MAAM;oBAC7B,UAAU;oBACV,SAAS,EAAE,WAAW;iBACvB,CAAC;gBAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;gBAChD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,yCAAmB,CAAC,CAAC;YACtD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACnC,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,cAAc,CAAC,eAAe,CAAC,MAAa,CAAC,CAAC;YAE9C,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,MAAM;gBAC7B,MAAM,EAAE,UAAU;aACnB,CAAC;YAEF,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QAC1D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,cAAc,CAAC,eAAe,CAAC,SAAgB,CAAC,CAAC;YAEjD,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,SAAS;gBAChC,MAAM,EAAE,aAAa;aACtB,CAAC;YAEF,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QAC1D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,cAAc,CAAC,eAAe,CAAC,SAAgB,CAAC,CAAC;YAEjD,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,SAAS;gBAChC,MAAM,EAAE,aAAa;aACtB,CAAC;YAEF,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QAC1D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,cAAc,CAAC,eAAe,CAAC,EAAS,CAAC,CAAC;YAE1C,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,EAAE;gBACzB,MAAM,EAAE,UAAU;aACnB,CAAC;YAEF,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAChD,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;YACvE,cAAc,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;YAE9C,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,KAAK;gBAC5B,MAAM,EAAE,SAAS;gBACjB,SAAS,EAAE,WAAW;gBACtB,UAAU,EAAE,aAAa;aAC1B,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;YAChD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,+CAAsB,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;YACxE,cAAc,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;YAE7C,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,MAAM;gBAC7B,UAAU,EAAE,aAAa;gBACzB,SAAS,EAAE,WAAW;aACvB,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;YAChD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,yCAAmB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,cAAc,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;YAE9C,MAAM,cAAc,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAE3E,cAAc,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;gBACvC,MAAM,OAAO,GAAG;oBACd,qBAAqB,EAAE,aAAa;oBACpC,MAAM,EAAE,UAAU;iBACnB,CAAC;gBAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;gBAChD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,+CAAsB,CAAC,CAAC;YACzD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;YACxD,cAAc,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;YAE9C,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,QAAQ;gBAC/B,MAAM,EAAE,iCAAiC;aAC1C,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;YAEzC,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,+CAAsB,CAAC,CAAC;YACvD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,cAAc,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;YAE7C,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,SAAS;gBAChC,UAAU,EAAE,oCAAoC;gBAChD,SAAS,EAAE,WAAW;aACvB,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;YAEhD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,yCAAmB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC7D,cAAc,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;YAE7C,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,SAAS;gBAChC,UAAU,EAAE,oCAAoC;gBAChD,SAAS,EAAE,gBAAgB;aAC5B,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;YAEhD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,yCAAmB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,cAAc,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;YAE9C,MAAM,QAAQ,GAAG;gBACf,qBAAqB,EAAE,KAAK;gBAC5B,MAAM,EAAE,OAAO;aAChB,CAAC;YAEF,MAAM,QAAQ,GAAG;gBACf,qBAAqB,EAAE,KAAK;gBAC5B,MAAM,EAAE,OAAO;aAChB,CAAC;YAEF,MAAM,QAAQ,GAAG,IAAA,+CAAsB,EAAC,QAAQ,CAAC,CAAC;YAClD,MAAM,QAAQ,GAAG,IAAA,+CAAsB,EAAC,QAAQ,CAAC,CAAC;YAElD,gCAAgC;YAChC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC5D,cAAc,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;YAE7C,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,MAAM;gBAC7B,UAAU,EAAE,4CAA4C,CAAC,MAAM,CAAC,EAAE,CAAC;gBACnE,SAAS,EAAE,WAAW;aACvB,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;YAChD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,yCAAmB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,cAAc,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;YAE9C,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,KAAK;gBAC5B,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;aACzB,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;YAChD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,+CAAsB,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACxD,cAAc,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;YAE7C,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,MAAM;gBAC7B,UAAU,EAAE,wCAAwC;gBACpD,SAAS,EAAE,WAAW;aACvB,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;YAChD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,yCAAmB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,cAAc,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;YAE9C,MAAM,OAAO,GAKT;gBACF,qBAAqB,EAAE,KAAK;gBAC5B,MAAM,EAAE,KAAK;gBACb,SAAS,EAAE,SAAS;gBACpB,UAAU,EAAE,QAAQ;aACrB,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;YAChD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,+CAAsB,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,cAAc,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;YAE7C,MAAM,OAAO,GAAG;gBACd,qBAAqB,EAAE,MAAM;gBAC7B,MAAM,EAAE,SAAS;gBACjB,SAAS,EAAE,WAAW;gBACtB,UAAU,EAAE,aAAa;aAC1B,CAAC;YAEF,MAAM,OAAO,GAAG,IAAA,+CAAsB,EAAC,OAAO,CAAC,CAAC;YAChD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,yCAAmB,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dx-common-lib",
-  "version": "1.71.1",
+  "version": "1.72.1",
   "description": "",
   "main": "lib/index.js",
   "private": false,
@@ -26,12 +26,12 @@
   },
   "devDependencies": {
     "@types/archiver": "6.0.3",
-    "@types/express": "4.17.17",
+    "@types/express": "4.17.23",
     "@types/fs-extra": "11.0.1",
     "@types/jest": "28.1.8",
-    "@types/lodash.clonedeep": "4.5.7",
+    "@types/lodash.clonedeep": "4.5.9",
     "@types/node": "22.10.5",
-    "dotenv": "16.0.3",
+    "dotenv": "16.6.1",
     "jest": "29.4.1",
     "ts-jest": "29.0.5",
     "typescript": "^5.7.2"

package/src/index.ts

@@ -15,3 +15,6 @@ export * from './edge-components-secret-key-service/ProductionEdgeComponentsSecr
 export * from './edge-components-secret-key-service/EdgeComponentsSecretKeyService';
 export * from './edge-components-secret-key-service/getEdgeComponentsSecretService';
 export * from './esi-mac-token-generator/EsiMacTokenGenerator';
+export * from './secret-api-key-service/SecretApiKeyService';
+export * from './secret-api-key-service/DevSecretApiKeyService';
+export * from './secret-api-key-service/getSecretApiKeyService';

package/src/secret-api-key-service/DevSecretApiKeyService.spec.ts

@@ -0,0 +1,211 @@
+import { DevSecretApiKeyService } from './DevSecretApiKeyService';
+
+describe('DevSecretApiKeyService', () => {
+  describe('Constructor', () => {
+    it('should successfully create service with valid API key', () => {
+      const apiKey = 'test-api-key-12345';
+      const service = new DevSecretApiKeyService(apiKey);
+
+      expect(service).toBeInstanceOf(DevSecretApiKeyService);
+    });
+
+    it('should throw error when API key is empty string', () => {
+      expect(() => new DevSecretApiKeyService('')).toThrow('API key must be a non-empty string');
+    });
+
+    it('should throw error when API key is whitespace only', () => {
+      expect(() => new DevSecretApiKeyService('   ')).toThrow('API key must be a non-empty string');
+    });
+
+    it('should throw error when API key is only tabs', () => {
+      expect(() => new DevSecretApiKeyService('\t\t')).toThrow('API key must be a non-empty string');
+    });
+
+    it('should throw error when API key is only newlines', () => {
+      expect(() => new DevSecretApiKeyService('\n\n')).toThrow('API key must be a non-empty string');
+    });
+
+    it('should accept API key with surrounding whitespace', () => {
+      // Note: The constructor checks trimmed length, but stores the original value
+      const apiKey = '  valid-key  ';
+      expect(() => new DevSecretApiKeyService(apiKey)).not.toThrow();
+    });
+  });
+
+  describe('getApiKey', () => {
+    it('should return the API key provided in constructor', async () => {
+      const apiKey = 'test-api-key-xyz';
+      const service = new DevSecretApiKeyService(apiKey);
+
+      const result = await service.getApiKey();
+
+      expect(result).toBe(apiKey);
+    });
+
+    it('should return same API key on multiple calls', async () => {
+      const apiKey = 'consistent-api-key';
+      const service = new DevSecretApiKeyService(apiKey);
+
+      const result1 = await service.getApiKey();
+      const result2 = await service.getApiKey();
+      const result3 = await service.getApiKey();
+
+      expect(result1).toBe(apiKey);
+      expect(result2).toBe(apiKey);
+      expect(result3).toBe(apiKey);
+    });
+
+    it('should handle concurrent calls efficiently', async () => {
+      const apiKey = 'concurrent-test-key';
+      const service = new DevSecretApiKeyService(apiKey);
+
+      // Make multiple concurrent calls
+      const promises = Array(10)
+        .fill(null)
+        .map(() => service.getApiKey());
+
+      const results = await Promise.all(promises);
+
+      // All should return the same key
+      expect(results).toEqual(Array(10).fill(apiKey));
+    });
+  });
+
+  describe('Edge Cases', () => {
+    it('should handle very long API keys', async () => {
+      const apiKey = 'x'.repeat(1000); // 1000 character API key
+      const service = new DevSecretApiKeyService(apiKey);
+
+      const result = await service.getApiKey();
+
+      expect(result).toBe(apiKey);
+    });
+
+    it('should handle special characters in API key', async () => {
+      const apiKey = 'test-key-!@#$%^&*()_+-=[]{}|;:"<>,.?/~`';
+      const service = new DevSecretApiKeyService(apiKey);
+
+      const result = await service.getApiKey();
+
+      expect(result).toBe(apiKey);
+    });
+
+    it('should handle unicode characters in API key', async () => {
+      const apiKey = 'test-key-你好-مرحبا-🔑';
+      const service = new DevSecretApiKeyService(apiKey);
+
+      const result = await service.getApiKey();
+
+      expect(result).toBe(apiKey);
+    });
+
+    it('should handle API key with line breaks', async () => {
+      const apiKey = 'key-with\nline\nbreaks';
+      const service = new DevSecretApiKeyService(apiKey);
+
+      const result = await service.getApiKey();
+
+      expect(result).toBe(apiKey);
+    });
+
+    it('should handle base64-like API keys', async () => {
+      const apiKey =
+        'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
+      const service = new DevSecretApiKeyService(apiKey);
+
+      const result = await service.getApiKey();
+
+      expect(result).toBe(apiKey);
+    });
+
+    it('should handle UUID-format API keys', async () => {
+      const apiKey = '550e8400-e29b-41d4-a716-446655440000';
+      const service = new DevSecretApiKeyService(apiKey);
+
+      const result = await service.getApiKey();
+
+      expect(result).toBe(apiKey);
+    });
+
+    it('should handle hexadecimal API keys', async () => {
+      const apiKey = 'a1b2c3d4e5f6789012345678901234567890abcdef';
+      const service = new DevSecretApiKeyService(apiKey);
+
+      const result = await service.getApiKey();
+
+      expect(result).toBe(apiKey);
+    });
+  });
+
+  describe('Interface Compliance', () => {
+    it('should implement SecretApiKeyServiceInterface', async () => {
+      const service = new DevSecretApiKeyService('test-key');
+
+      // Check that the required methods exist
+      expect(typeof service.getApiKey).toBe('function');
+    });
+
+    it('should return a Promise from getApiKey', () => {
+      const service = new DevSecretApiKeyService('test-key');
+      const result = service.getApiKey();
+
+      expect(result).toBeInstanceOf(Promise);
+    });
+  });
+
+  describe('Memory and Performance', () => {
+    it('should not modify the API key after construction', async () => {
+      const originalKey = 'immutable-key-123';
+      const service = new DevSecretApiKeyService(originalKey);
+
+      // Get the key multiple times
+      await service.getApiKey();
+      await service.getApiKey();
+      await service.getApiKey();
+
+      // Key should still be the same
+      const result = await service.getApiKey();
+      expect(result).toBe(originalKey);
+    });
+
+    it('should handle rapid sequential calls', async () => {
+      const apiKey = 'rapid-call-key';
+      const service = new DevSecretApiKeyService(apiKey);
+
+      // Make rapid sequential calls
+      for (let i = 0; i < 100; i++) {
+        const result = await service.getApiKey();
+        expect(result).toBe(apiKey);
+      }
+    });
+  });
+
+  describe('Real-world Scenarios', () => {
+    it('should work with typical metrics service API key format', async () => {
+      const apiKey = 'metrics-api-key-prod-abc123def456';
+      const service = new DevSecretApiKeyService(apiKey);
+
+      const result = await service.getApiKey();
+
+      expect(result).toBe(apiKey);
+    });
+
+    it('should work with AWS-style secret format', async () => {
+      const apiKey = 'aws-secret-key-AKIAIOSFODNN7EXAMPLE';
+      const service = new DevSecretApiKeyService(apiKey);
+
+      const result = await service.getApiKey();
+
+      expect(result).toBe(apiKey);
+    });
+
+    it('should work with Bearer token format', async () => {
+      const apiKey = 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
+      const service = new DevSecretApiKeyService(apiKey);
+
+      const result = await service.getApiKey();
+
+      expect(result).toBe(apiKey);
+    });
+  });
+});

package/src/secret-api-key-service/DevSecretApiKeyService.ts

@@ -0,0 +1,36 @@
+/*!
+ * @file EnvApiKeyService.ts
+ * @description Retrieves API key from environment variable (for local development).
+ * @author Squiz
+ * @copyright 2025 Squiz
+ * @license MIT
+ */
+
+import { SecretApiKeyServiceInterface } from './SecretApiKeyService';
+
+/**
+ * Service for retrieving API keys from environment variables.
+ * Used for local development as an alternative to AWS Secrets Manager.
+ */
+export class DevSecretApiKeyService implements SecretApiKeyServiceInterface {
+  private readonly apiKey: string;
+
+  /**
+   * Constructor for EnvApiKeyService
+   * @param apiKey The API key value from environment variable
+   */
+  constructor(apiKey: string) {
+    if (!apiKey || apiKey.trim().length === 0) {
+      throw new Error('API key must be a non-empty string');
+    }
+    this.apiKey = apiKey;
+  }
+
+  /**
+   * Returns the API key.
+   * @returns The API key string
+   */
+  public async getApiKey(): Promise<string> {
+    return this.apiKey;
+  }
+}