Fix typing error in secrets package and organize its adapters into a …

…separate subdirectory.

packages/secrets/src/lib/aws-param-store.ts → packages/secrets/src/lib/adapters/aws-param-store.ts

@@ -8,7 +8,7 @@ import {
   ParameterNotFound,
 } from '@aws-sdk/client-ssm';
 
-import type { SecretKey, SecretMap, SecretValue, SecretsVault } from './types';
+import type { SecretKey, SecretMap, SecretValue, SecretsVault } from '../types';
 
 export class AWSParameterStoreSecretsVault implements SecretsVault {
   async getSecret(key: SecretKey) {
@@ -55,7 +55,7 @@ export class AWSParameterStoreSecretsVault implements SecretsVault {
     }
   }
 
-  async setSecret(key: string, value: string) {
+  async setSecret(key: SecretKey, value: SecretValue) {
     const client = new SSMClient();
     try {
       await client.send(

packages/secrets/src/lib/in-memory.ts → packages/secrets/src/lib/adapters/in-memory.ts

@@ -1,4 +1,4 @@
-import type { SecretKey, SecretMap, SecretValue, SecretsVault } from './types';
+import type { SecretMap, SecretsVault } from '../types';
 
 export class InMemorySecretsVault implements SecretsVault {
   constructor(private secretMap: SecretMap) {}

packages/secrets/src/lib/adapters/index.ts

@@ -0,0 +1,43 @@
+import { promises as fs } from 'fs';
+
+import * as r from '@atj/common';
+
+import { AWSParameterStoreSecretsVault } from './aws-param-store';
+import { getSecretMapFromJsonString, type SecretsVault } from '../types';
+import { InMemorySecretsVault } from './in-memory';
+
+/**
+ * Returns either a production vault or an in-memory vault initialized with the
+ * contents of a JSON file.
+ * @param jsonFilePath Optional path to a local JSON file that will stand-in
+ * for a secrets vault.
+ * @returns In-memory or production vault.
+ */
+export const getSecretsVault = async (jsonFilePath?: string) => {
+  if (jsonFilePath) {
+    const maybeJsonString = (await fs.readFile(jsonFilePath)).toString();
+    const result = createInMemorySecretsVault(maybeJsonString);
+    if (result.success) {
+      return result.data;
+    } else {
+      throw new Error(result.error);
+    }
+  } else {
+    return getAWSSecretsVault();
+  }
+};
+
+export const getAWSSecretsVault = (): SecretsVault => {
+  return new AWSParameterStoreSecretsVault();
+};
+
+export const createInMemorySecretsVault = (
+  jsonString?: any
+): r.Result<SecretsVault> => {
+  const result = getSecretMapFromJsonString(jsonString);
+  if (result.success) {
+    return r.success(new InMemorySecretsVault(result.data));
+  } else {
+    return r.failure(result.error);
+  }
+};

packages/secrets/src/lib/index.ts

@@ -1,51 +1,7 @@
-import { promises as fs } from 'fs';
+import { type SecretMap, type SecretsVault } from './types';
 
-import * as r from '@atj/common';
-
-import { AWSParameterStoreSecretsVault } from './aws-param-store';
-import {
-  getSecretMapFromJsonString,
-  type SecretMap,
-  type SecretsVault,
-} from './types';
-import { InMemorySecretsVault } from './in-memory';
 export { getSecretMapFromJsonString } from './types';
-
-/**
- * Returns either a production vault or an in-memory vault initialized with the
- * contents of a JSON file.
- * @param jsonFilePath Optional path to a local JSON file that will stand-in
- * for a secrets vault.
- * @returns In-memory or production vault.
- */
-export const getSecretsVault = async (jsonFilePath?: string) => {
-  if (jsonFilePath) {
-    const maybeJsonString = (await fs.readFile(jsonFilePath)).toString();
-    const result = createInMemorySecretsVault(maybeJsonString);
-    if (result.success) {
-      return result.data;
-    } else {
-      throw new Error(result.error);
-    }
-  } else {
-    return getAWSSecretsVault();
-  }
-};
-
-export const getAWSSecretsVault = (): SecretsVault => {
-  return new AWSParameterStoreSecretsVault();
-};
-
-export const createInMemorySecretsVault = (
-  jsonString?: any
-): r.Result<SecretsVault> => {
-  const result = getSecretMapFromJsonString(jsonString);
-  if (result.success) {
-    return r.success(new InMemorySecretsVault(result.data));
-  } else {
-    return r.failure(result.error);
-  }
-};
+export * from './adapters';
 
 export const getSecretMap = async (vault: SecretsVault): Promise<SecretMap> => {
   const secretKeys = await vault.getSecretKeys();

packages/secrets/src/lib/types.ts

@@ -2,7 +2,7 @@ import * as z from 'zod';
 import { Result } from '@atj/common/src';
 
 export type SecretKey = string;
-export type SecretValue = string;
+export type SecretValue = string | undefined;
 export type SecretMap = Record<SecretKey, SecretValue>;
 
 const secretMap = z.record(z.string());