@squiz/dx-common-lib 1.71.1 → 1.72.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## 1.72.1
+
+### Patch Changes
+
+- fabc58b: Added EnvApiKeyService fallback
+
+## 1.72.0
+
+### Minor Changes
+
+- 480cbf0: Added SecretApiKeyService
+
 ## 1.71.1
 
 ### Patch Changes

package/lib/cache/applyDefaultRulesToCacheControlObject.d.ts

@@ -1,6 +1,6 @@
 import { CacheControl } from './parseCacheControl';
 export declare function applyDefaultRulesToCacheControlObject(cacheControlInput: CacheControl): {
-    [x: string]: string | number | boolean | undefined;
+    [key: string]: string | number | boolean | undefined;
     'max-age'?: number;
     's-maxage'?: number;
     'min-fresh'?: number;

package/lib/index.d.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/lib/index.js

@@ -31,4 +31,7 @@ __exportStar(require("./edge-components-secret-key-service/ProductionEdgeCompone
 __exportStar(require("./edge-components-secret-key-service/EdgeComponentsSecretKeyService"), exports);
 __exportStar(require("./edge-components-secret-key-service/getEdgeComponentsSecretService"), exports);
 __exportStar(require("./esi-mac-token-generator/EsiMacTokenGenerator"), exports);
+__exportStar(require("./secret-api-key-service/SecretApiKeyService"), exports);
+__exportStar(require("./secret-api-key-service/DevSecretApiKeyService"), exports);
+__exportStar(require("./secret-api-key-service/getSecretApiKeyService"), 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;AAC7C,+EAA6D;AAC7D,+EAA6D;AAC7D,gFAA8D;AAC9D,wEAAsD;AACtD,0CAAwB;AACxB,+CAA6B;AAC7B,iHAA+F;AAC/F,gHAA8F;AAC9F,sGAAoF;AACpF,sGAAoF;AACpF,iFAA+D"}
+{"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,0CAAwB;AACxB,+CAA6B;AAC7B,iHAA+F;AAC/F,gHAA8F;AAC9F,sGAAoF;AACpF,sGAAoF;AACpF,iFAA+D;AAC/D,+EAA6D;AAC7D,kFAAgE;AAChE,kFAAgE"}

package/lib/secret-api-key-service/DevSecretApiKeyService.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * @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 declare class DevSecretApiKeyService implements SecretApiKeyServiceInterface {
+    private readonly apiKey;
+    /**
+     * Constructor for EnvApiKeyService
+     * @param apiKey The API key value from environment variable
+     */
+    constructor(apiKey: string);
+    /**
+     * Returns the API key.
+     * @returns The API key string
+     */
+    getApiKey(): Promise<string>;
+}

package/lib/secret-api-key-service/DevSecretApiKeyService.js

@@ -0,0 +1,35 @@
+"use strict";
+/*!
+ * @file EnvApiKeyService.ts
+ * @description Retrieves API key from environment variable (for local development).
+ * @author Squiz
+ * @copyright 2025 Squiz
+ * @license MIT
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DevSecretApiKeyService = void 0;
+/**
+ * Service for retrieving API keys from environment variables.
+ * Used for local development as an alternative to AWS Secrets Manager.
+ */
+class DevSecretApiKeyService {
+    /**
+     * Constructor for EnvApiKeyService
+     * @param apiKey The API key value from environment variable
+     */
+    constructor(apiKey) {
+        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
+     */
+    async getApiKey() {
+        return this.apiKey;
+    }
+}
+exports.DevSecretApiKeyService = DevSecretApiKeyService;
+//# sourceMappingURL=DevSecretApiKeyService.js.map

package/lib/secret-api-key-service/DevSecretApiKeyService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DevSecretApiKeyService.js","sourceRoot":"","sources":["../../src/secret-api-key-service/DevSecretApiKeyService.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAIH;;;GAGG;AACH,MAAa,sBAAsB;IAGjC;;;OAGG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF;AArBD,wDAqBC"}

package/lib/secret-api-key-service/DevSecretApiKeyService.spec.d.ts

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

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

@@ -0,0 +1,157 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const DevSecretApiKeyService_1 = require("./DevSecretApiKeyService");
+describe('DevSecretApiKeyService', () => {
+    describe('Constructor', () => {
+        it('should successfully create service with valid API key', () => {
+            const apiKey = 'test-api-key-12345';
+            const service = new DevSecretApiKeyService_1.DevSecretApiKeyService(apiKey);
+            expect(service).toBeInstanceOf(DevSecretApiKeyService_1.DevSecretApiKeyService);
+        });
+        it('should throw error when API key is empty string', () => {
+            expect(() => new DevSecretApiKeyService_1.DevSecretApiKeyService('')).toThrow('API key must be a non-empty string');
+        });
+        it('should throw error when API key is whitespace only', () => {
+            expect(() => new DevSecretApiKeyService_1.DevSecretApiKeyService('   ')).toThrow('API key must be a non-empty string');
+        });
+        it('should throw error when API key is only tabs', () => {
+            expect(() => new DevSecretApiKeyService_1.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_1.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_1.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_1.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_1.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_1.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_1.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_1.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_1.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_1.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_1.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_1.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_1.DevSecretApiKeyService(apiKey);
+            const result = await service.getApiKey();
+            expect(result).toBe(apiKey);
+        });
+    });
+    describe('Interface Compliance', () => {
+        it('should implement SecretApiKeyServiceInterface', async () => {
+            const service = new DevSecretApiKeyService_1.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_1.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_1.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_1.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_1.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_1.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_1.DevSecretApiKeyService(apiKey);
+            const result = await service.getApiKey();
+            expect(result).toBe(apiKey);
+        });
+    });
+});
+//# sourceMappingURL=DevSecretApiKeyService.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DevSecretApiKeyService.spec.js","sourceRoot":"","sources":["../../src/secret-api-key-service/DevSecretApiKeyService.spec.ts"],"names":[],"mappings":";;AAAA,qEAAkE;AAElE,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;IACtC,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAC3B,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,MAAM,MAAM,GAAG,oBAAoB,CAAC;YACpC,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC;YAEnD,MAAM,CAAC,OAAO,CAAC,CAAC,cAAc,CAAC,+CAAsB,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,+CAAsB,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;QAC7F,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC5D,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,+CAAsB,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;QAChG,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;QACjG,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,oCAAoC,CAAC,CAAC;QACjG,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YAC3D,6EAA6E;YAC7E,MAAM,MAAM,GAAG,eAAe,CAAC;YAC/B,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACjE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QACzB,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;YACjE,MAAM,MAAM,GAAG,kBAAkB,CAAC;YAClC,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC;YAEnD,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,8CAA8C,EAAE,KAAK,IAAI,EAAE;YAC5D,MAAM,MAAM,GAAG,oBAAoB,CAAC;YACpC,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC;YAEnD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;YAC1C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;YAC1C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;YAE1C,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC7B,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC7B,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;YAC1D,MAAM,MAAM,GAAG,qBAAqB,CAAC;YACrC,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC;YAEnD,iCAAiC;YACjC,MAAM,QAAQ,GAAG,KAAK,CAAC,EAAE,CAAC;iBACvB,IAAI,CAAC,IAAI,CAAC;iBACV,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;YAElC,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAE5C,iCAAiC;YACjC,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;YAChD,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,yBAAyB;YAC1D,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC;YAEnD,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,6CAA6C,EAAE,KAAK,IAAI,EAAE;YAC3D,MAAM,MAAM,GAAG,yCAAyC,CAAC;YACzD,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC;YAEnD,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,6CAA6C,EAAE,KAAK,IAAI,EAAE;YAC3D,MAAM,MAAM,GAAG,sBAAsB,CAAC;YACtC,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC;YAEnD,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,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,MAAM,MAAM,GAAG,wBAAwB,CAAC;YACxC,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC;YAEnD,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,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,MAAM,GACV,6JAA6J,CAAC;YAChK,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC;YAEnD,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,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,MAAM,GAAG,sCAAsC,CAAC;YACtD,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC;YAEnD,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,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,MAAM,GAAG,4CAA4C,CAAC;YAC5D,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC;YAEnD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;YAEzC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;YAC7D,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,UAAU,CAAC,CAAC;YAEvD,wCAAwC;YACxC,MAAM,CAAC,OAAO,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,UAAU,CAAC,CAAC;YACvD,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;YAEnC,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;QACtC,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;YAChE,MAAM,WAAW,GAAG,mBAAmB,CAAC;YACxC,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,WAAW,CAAC,CAAC;YAExD,6BAA6B;YAC7B,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;YAC1B,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;YAC1B,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;YAE1B,+BAA+B;YAC/B,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;YACzC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;YACpD,MAAM,MAAM,GAAG,gBAAgB,CAAC;YAChC,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC;YAEnD,8BAA8B;YAC9B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;gBACzC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;YACvE,MAAM,MAAM,GAAG,mCAAmC,CAAC;YACnD,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC;YAEnD,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,0CAA0C,EAAE,KAAK,IAAI,EAAE;YACxD,MAAM,MAAM,GAAG,qCAAqC,CAAC;YACrD,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC;YAEnD,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,sCAAsC,EAAE,KAAK,IAAI,EAAE;YACpD,MAAM,MAAM,GAAG,6CAA6C,CAAC;YAC7D,MAAM,OAAO,GAAG,IAAI,+CAAsB,CAAC,MAAM,CAAC,CAAC;YAEnD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;YAEzC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/secret-api-key-service/SecretApiKeyService.d.ts

@@ -0,0 +1,43 @@
+/*!
+ * @file SecretApiKeyService.ts
+ * @description Retrieves API keys from AWS Secrets Manager.
+ * @author Squiz
+ * @copyright 2025 Squiz
+ * @license MIT
+ */
+/**
+ * Interface for the SecretApiKeyService
+ */
+export interface SecretApiKeyServiceInterface {
+    /**
+     * Retrieves the API key from AWS Secrets Manager.
+     * Expects the secret to be stored as JSON with an 'apikey' field.
+     *
+     * @returns The API key string
+     */
+    getApiKey(): Promise<string>;
+}
+/**
+ * Service for retrieving API keys from AWS Secrets Manager.
+ * Expects the secret to be stored as JSON with an 'apikey' field.
+ *
+ * @see https://squizgroup.atlassian.net/wiki/spaces/PRODUCT/pages/3029827767/Service+Keys
+ */
+export declare class SecretApiKeyService implements SecretApiKeyServiceInterface {
+    private readonly secretName;
+    private readonly region;
+    private cachedApiKey;
+    /**
+     * Constructor for SecretApiKeyService
+     * @param secretName The name/ARN of the secret in AWS Secrets Manager
+     * @param region AWS region
+     */
+    constructor(secretName: string, region: string);
+    /**
+     * Retrieves the API key from AWS Secrets Manager.
+     * Expects the secret to be stored as JSON with an 'apikey' field.
+     *
+     * @returns The API key string
+     */
+    getApiKey(): Promise<string>;
+}

package/lib/secret-api-key-service/SecretApiKeyService.js

@@ -0,0 +1,85 @@
+"use strict";
+/*!
+ * @file SecretApiKeyService.ts
+ * @description Retrieves API keys from AWS Secrets Manager.
+ * @author Squiz
+ * @copyright 2025 Squiz
+ * @license MIT
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecretApiKeyService = void 0;
+// External
+const client_secrets_manager_1 = require("@aws-sdk/client-secrets-manager");
+/**
+ * Service for retrieving API keys from AWS Secrets Manager.
+ * Expects the secret to be stored as JSON with an 'apikey' field.
+ *
+ * @see https://squizgroup.atlassian.net/wiki/spaces/PRODUCT/pages/3029827767/Service+Keys
+ */
+class SecretApiKeyService {
+    /**
+     * Constructor for SecretApiKeyService
+     * @param secretName The name/ARN of the secret in AWS Secrets Manager
+     * @param region AWS region
+     */
+    constructor(secretName, region) {
+        this.secretName = secretName;
+        this.region = region;
+        this.cachedApiKey = undefined;
+    }
+    /**
+     * Retrieves the API key from AWS Secrets Manager.
+     * Expects the secret to be stored as JSON with an 'apikey' field.
+     *
+     * @returns The API key string
+     */
+    async getApiKey() {
+        // Return cached value if available
+        if (this.cachedApiKey) {
+            return this.cachedApiKey;
+        }
+        const secretClient = new client_secrets_manager_1.SecretsManagerClient({ region: this.region });
+        try {
+            // Retrieve the secret from AWS Secrets Manager
+            const command = new client_secrets_manager_1.GetSecretValueCommand({ SecretId: this.secretName });
+            const response = await secretClient.send(command);
+            // Check if the secret has a SecretString value
+            if (!response.SecretString) {
+                throw new Error(`Secret ${this.secretName} has no SecretString value`);
+            }
+            // Parse the secret JSON to extract the apikey field
+            let parsedSecret;
+            try {
+                parsedSecret = JSON.parse(response.SecretString);
+            }
+            catch (parseError) {
+                throw new Error(`Failed to parse secret as JSON. Secret value may not be valid JSON.`);
+            }
+            // Extract the apikey field from the parsed secret
+            const { apikey } = parsedSecret;
+            // Check if the apikey field is present
+            if (!apikey) {
+                const availableKeys = Object.keys(parsedSecret).join(', ');
+                throw new Error(`API key not found in secret JSON structure (expected "apikey" field). Available keys: ${availableKeys}`);
+            }
+            // Check if the apikey field is a non-empty string
+            if (typeof apikey !== 'string' || apikey.trim().length === 0) {
+                throw new Error('API key value is invalid (must be a non-empty string)');
+            }
+            // Cache the apikey
+            this.cachedApiKey = apikey;
+            // Return the apikey
+            return apikey;
+        }
+        catch (error) {
+            // Log the error
+            const errorMessage = `Failed to retrieve API key: ${error instanceof Error ? error.message : 'Unknown error'}`;
+            const wrappedError = new Error(errorMessage);
+            // @ts-expect-error - cause property is not standard in all TypeScript versions
+            wrappedError.cause = error;
+            throw wrappedError;
+        }
+    }
+}
+exports.SecretApiKeyService = SecretApiKeyService;
+//# sourceMappingURL=SecretApiKeyService.js.map

package/lib/secret-api-key-service/SecretApiKeyService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SecretApiKeyService.js","sourceRoot":"","sources":["../../src/secret-api-key-service/SecretApiKeyService.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAEH,WAAW;AACX,4EAA8F;AAe9F;;;;;GAKG;AACH,MAAa,mBAAmB;IAK9B;;;;OAIG;IACH,YAAY,UAAkB,EAAE,MAAc;QAC5C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS;QACpB,mCAAmC;QACnC,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC,YAAY,CAAC;QAC3B,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,6CAAoB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAEvE,IAAI,CAAC;YACH,+CAA+C;YAC/C,MAAM,OAAO,GAAG,IAAI,8CAAqB,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;YACzE,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAElD,+CAA+C;YAC/C,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC;gBAC3B,MAAM,IAAI,KAAK,CAAC,UAAU,IAAI,CAAC,UAAU,4BAA4B,CAAC,CAAC;YACzE,CAAC;YAED,oDAAoD;YACpD,IAAI,YAAY,CAAC;YACjB,IAAI,CAAC;gBACH,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;YACnD,CAAC;YAAC,OAAO,UAAU,EAAE,CAAC;gBACpB,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;YACzF,CAAC;YAED,kDAAkD;YAClD,MAAM,EAAE,MAAM,EAAE,GAAG,YAAY,CAAC;YAEhC,uCAAuC;YACvC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3D,MAAM,IAAI,KAAK,CACb,yFAAyF,aAAa,EAAE,CACzG,CAAC;YACJ,CAAC;YAED,kDAAkD;YAClD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC7D,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;YAC3E,CAAC;YAED,mBAAmB;YACnB,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC;YAC3B,oBAAoB;YACpB,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,gBAAgB;YAChB,MAAM,YAAY,GAAG,+BAA+B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,CAAC;YAC/G,MAAM,YAAY,GAAG,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;YAC7C,+EAA+E;YAC/E,YAAY,CAAC,KAAK,GAAG,KAAK,CAAC;YAC3B,MAAM,YAAY,CAAC;QACrB,CAAC;IACH,CAAC;CACF;AA7ED,kDA6EC"}

package/lib/secret-api-key-service/SecretApiKeyService.spec.d.ts

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