@prairielearn/config 4.0.2 → 4.1.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @prairielearn/config
 
+## 4.1.0
+
+### Minor Changes
+
+- 9400eb3: Add generic type parameter to `ConfigSource` for type-safe config loading
+
+### Patch Changes
+
+- 3c4799a: Upgrade all JavaScript dependencies
+- Updated dependencies [3c4799a]
+  - @prairielearn/aws-imds@3.0.2
+
+## 4.0.3
+
+### Patch Changes
+
+- cde69c1: Upgrade all JavaScript dependencies
+
 ## 4.0.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 type AbstractConfig = Record<string, unknown>;
-export interface ConfigSource {
-    load: (existingConfig: AbstractConfig) => Promise<AbstractConfig>;
+export interface ConfigSource<T extends AbstractConfig = AbstractConfig> {
+    load: (existingConfig: T) => Promise<Partial<T>>;
 }
 export declare function makeLiteralConfigSource(config: AbstractConfig): {
     load: () => Promise<AbstractConfig>;
@@ -21,7 +21,7 @@ export declare class ConfigLoader<Schema extends z.ZodTypeAny> {
     private readonly schema;
     private resolvedConfig;
     constructor(schema: Schema);
-    loadAndValidate(sources?: ConfigSource[]): Promise<void>;
+    loadAndValidate(sources?: ConfigSource<any>[]): Promise<void>;
     reset(): void;
     get config(): z.TypeOf<Schema>;
 }

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,KAAK,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE9C,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,CAAC,cAAc,EAAE,cAAc,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;CACnE;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,cAAc;;EAI7D;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAS/D;AAED;;;GAGG;AACH,KAAK,oBAAoB,CAAC,CAAC,IAAI;KAC5B,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAChD,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX,wBAAgB,mBAAmB,CAAC,MAAM,SAAS,CAAC,CAAC,UAAU,EAC7D,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GACtE,YAAY,CAed;AAED,wBAAgB,8BAA8B,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAoC3E;AAED,wBAAgB,oBAAoB,IAAI,YAAY,CAiBnD;AAED,qBAAa,YAAY,CAAC,MAAM,SAAS,CAAC,CAAC,UAAU;IACnD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,cAAc,CAAkB;IAExC,YAAY,MAAM,EAAE,MAAM,EAOzB;IAEK,eAAe,CAAC,OAAO,GAAE,YAAY,EAAO,iBAWjD;IAED,KAAK,SAEJ;IAED,IAAI,MAAM,qBAET;CACF","sourcesContent":["import { DescribeTagsCommand, EC2Client } from '@aws-sdk/client-ec2';\nimport { GetSecretValueCommand, SecretsManagerClient } from '@aws-sdk/client-secrets-manager';\nimport { mergeWith } from 'es-toolkit';\nimport fs from 'fs-extra';\nimport { z } from 'zod';\n\nimport { fetchInstanceHostname, fetchInstanceIdentity } from '@prairielearn/aws-imds';\n\ntype AbstractConfig = Record<string, unknown>;\n\nexport interface ConfigSource {\n  load: (existingConfig: AbstractConfig) => Promise<AbstractConfig>;\n}\n\nexport function makeLiteralConfigSource(config: AbstractConfig) {\n  return {\n    load: async () => config,\n  };\n}\n\nexport function makeFileConfigSource(path: string): ConfigSource {\n  return {\n    load: async () => {\n      if (!(await fs.pathExists(path))) return {};\n\n      const config = await fs.readJson(path);\n      return z.record(z.string(), z.any()).parse(config);\n    },\n  };\n}\n\n/**\n * Extracts keys from T where string is assignable to the value type.\n * This ensures we only map environment variables to fields that accept strings.\n */\ntype StringAssignableKeys<T> = {\n  [K in keyof T]: string extends T[K] ? K : never;\n}[keyof T];\n\nexport function makeEnvConfigSource<Schema extends z.ZodTypeAny>(\n  mapping: Partial<Record<StringAssignableKeys<z.infer<Schema>>, string>>,\n): ConfigSource {\n  return {\n    load: async () => {\n      const config: Record<string, string> = {};\n\n      for (const [key, envVar] of Object.entries(mapping) as [string, string][]) {\n        const value = process.env[envVar];\n        if (value !== undefined) {\n          config[key] = value;\n        }\n      }\n\n      return config;\n    },\n  };\n}\n\nexport function makeSecretsManagerConfigSource(tagKey: string): ConfigSource {\n  return {\n    load: async (existingConfig) => {\n      if (!existingConfig.runningInEc2 && !process.env.CONFIG_LOAD_FROM_AWS) {\n        return {};\n      }\n\n      const identity = await fetchInstanceIdentity();\n\n      // We disable the ESLint rule here because we don't care about sharing\n      // configs between clients in this case. We only want to share configs\n      // to avoid spamming the IMDS API when creating lots of clients, but\n      // this client will only be used once, typically at application startup.\n      // eslint-disable-next-line @prairielearn/aws-client-shared-config\n      const ec2Client = new EC2Client({ region: identity.region });\n      const tags = await ec2Client.send(\n        new DescribeTagsCommand({\n          Filters: [{ Name: 'resource-id', Values: [identity.instanceId] }],\n        }),\n      );\n\n      const secretId = tags.Tags?.find((tag) => tag.Key === tagKey)?.Value;\n      if (!secretId) return {};\n\n      // As above, we don't care about sharing configs between clients.\n      // eslint-disable-next-line @prairielearn/aws-client-shared-config\n      const secretsManagerClient = new SecretsManagerClient({ region: identity.region });\n      const secretValue = await secretsManagerClient.send(\n        new GetSecretValueCommand({ SecretId: secretId }),\n      );\n      if (!secretValue.SecretString) return {};\n\n      const config = JSON.parse(secretValue.SecretString);\n      return z.record(z.string(), z.any()).parse(config);\n    },\n  };\n}\n\nexport function makeImdsConfigSource(): ConfigSource {\n  return {\n    load: async (existingConfig) => {\n      if (!existingConfig.runningInEc2 && !process.env.CONFIG_LOAD_FROM_AWS) {\n        return {};\n      }\n\n      const hostname = await fetchInstanceHostname();\n      const identity = await fetchInstanceIdentity();\n\n      return {\n        hostname,\n        instanceId: identity.instanceId,\n        awsRegion: identity.region,\n      };\n    },\n  };\n}\n\nexport class ConfigLoader<Schema extends z.ZodTypeAny> {\n  private readonly schema: Schema;\n  private resolvedConfig: z.infer<Schema>;\n\n  constructor(schema: Schema) {\n    this.schema = schema;\n\n    // Get the default values from the schema. This ensures that all values\n    // have defaults, and also allows us to override nested defaults with\n    // `_.merge()` in `loadAndValidate()`.\n    this.resolvedConfig = schema.parse({});\n  }\n\n  async loadAndValidate(sources: ConfigSource[] = []) {\n    let config = this.schema.parse({});\n    // If the config setting is an array, override instead of merge\n    const mergeRule = (_obj: any, src: any) => (Array.isArray(src) ? src : undefined);\n\n    for (const source of sources) {\n      config = mergeWith(config, await source.load(config), mergeRule);\n    }\n\n    const parsedConfig = this.schema.parse(config);\n    mergeWith(this.resolvedConfig, parsedConfig, mergeRule);\n  }\n\n  reset() {\n    this.resolvedConfig = this.schema.parse({});\n  }\n\n  get config() {\n    return this.resolvedConfig;\n  }\n}\n"]}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,KAAK,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE9C,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,cAAc,GAAG,cAAc;IACrE,IAAI,EAAE,CAAC,cAAc,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;CAClD;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,cAAc;;EAI7D;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAS/D;AAED;;;GAGG;AACH,KAAK,oBAAoB,CAAC,CAAC,IAAI;KAC5B,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK;CAChD,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX,wBAAgB,mBAAmB,CAAC,MAAM,SAAS,CAAC,CAAC,UAAU,EAC7D,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GACtE,YAAY,CAed;AAED,wBAAgB,8BAA8B,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAoC3E;AAED,wBAAgB,oBAAoB,IAAI,YAAY,CAiBnD;AAED,qBAAa,YAAY,CAAC,MAAM,SAAS,CAAC,CAAC,UAAU;IACnD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,cAAc,CAAkB;IAExC,YAAY,MAAM,EAAE,MAAM,EAOzB;IAEK,eAAe,CAAC,OAAO,GAAE,YAAY,CAAC,GAAG,CAAC,EAAO,iBAWtD;IAED,KAAK,SAEJ;IAED,IAAI,MAAM,qBAET;CACF","sourcesContent":["import { DescribeTagsCommand, EC2Client } from '@aws-sdk/client-ec2';\nimport { GetSecretValueCommand, SecretsManagerClient } from '@aws-sdk/client-secrets-manager';\nimport { mergeWith } from 'es-toolkit';\nimport fs from 'fs-extra';\nimport { z } from 'zod';\n\nimport { fetchInstanceHostname, fetchInstanceIdentity } from '@prairielearn/aws-imds';\n\ntype AbstractConfig = Record<string, unknown>;\n\nexport interface ConfigSource<T extends AbstractConfig = AbstractConfig> {\n  load: (existingConfig: T) => Promise<Partial<T>>;\n}\n\nexport function makeLiteralConfigSource(config: AbstractConfig) {\n  return {\n    load: async () => config,\n  };\n}\n\nexport function makeFileConfigSource(path: string): ConfigSource {\n  return {\n    load: async () => {\n      if (!(await fs.pathExists(path))) return {};\n\n      const config = await fs.readJson(path);\n      return z.record(z.string(), z.any()).parse(config);\n    },\n  };\n}\n\n/**\n * Extracts keys from T where string is assignable to the value type.\n * This ensures we only map environment variables to fields that accept strings.\n */\ntype StringAssignableKeys<T> = {\n  [K in keyof T]: string extends T[K] ? K : never;\n}[keyof T];\n\nexport function makeEnvConfigSource<Schema extends z.ZodTypeAny>(\n  mapping: Partial<Record<StringAssignableKeys<z.infer<Schema>>, string>>,\n): ConfigSource {\n  return {\n    load: async () => {\n      const config: Record<string, string> = {};\n\n      for (const [key, envVar] of Object.entries(mapping) as [string, string][]) {\n        const value = process.env[envVar];\n        if (value !== undefined) {\n          config[key] = value;\n        }\n      }\n\n      return config;\n    },\n  };\n}\n\nexport function makeSecretsManagerConfigSource(tagKey: string): ConfigSource {\n  return {\n    load: async (existingConfig) => {\n      if (!existingConfig.runningInEc2 && !process.env.CONFIG_LOAD_FROM_AWS) {\n        return {};\n      }\n\n      const identity = await fetchInstanceIdentity();\n\n      // We disable the ESLint rule here because we don't care about sharing\n      // configs between clients in this case. We only want to share configs\n      // to avoid spamming the IMDS API when creating lots of clients, but\n      // this client will only be used once, typically at application startup.\n      // eslint-disable-next-line @prairielearn/aws-client-shared-config\n      const ec2Client = new EC2Client({ region: identity.region });\n      const tags = await ec2Client.send(\n        new DescribeTagsCommand({\n          Filters: [{ Name: 'resource-id', Values: [identity.instanceId] }],\n        }),\n      );\n\n      const secretId = tags.Tags?.find((tag) => tag.Key === tagKey)?.Value;\n      if (!secretId) return {};\n\n      // As above, we don't care about sharing configs between clients.\n      // eslint-disable-next-line @prairielearn/aws-client-shared-config\n      const secretsManagerClient = new SecretsManagerClient({ region: identity.region });\n      const secretValue = await secretsManagerClient.send(\n        new GetSecretValueCommand({ SecretId: secretId }),\n      );\n      if (!secretValue.SecretString) return {};\n\n      const config = JSON.parse(secretValue.SecretString);\n      return z.record(z.string(), z.any()).parse(config);\n    },\n  };\n}\n\nexport function makeImdsConfigSource(): ConfigSource {\n  return {\n    load: async (existingConfig) => {\n      if (!existingConfig.runningInEc2 && !process.env.CONFIG_LOAD_FROM_AWS) {\n        return {};\n      }\n\n      const hostname = await fetchInstanceHostname();\n      const identity = await fetchInstanceIdentity();\n\n      return {\n        hostname,\n        instanceId: identity.instanceId,\n        awsRegion: identity.region,\n      };\n    },\n  };\n}\n\nexport class ConfigLoader<Schema extends z.ZodTypeAny> {\n  private readonly schema: Schema;\n  private resolvedConfig: z.infer<Schema>;\n\n  constructor(schema: Schema) {\n    this.schema = schema;\n\n    // Get the default values from the schema. This ensures that all values\n    // have defaults, and also allows us to override nested defaults with\n    // `_.merge()` in `loadAndValidate()`.\n    this.resolvedConfig = schema.parse({});\n  }\n\n  async loadAndValidate(sources: ConfigSource<any>[] = []) {\n    let config = this.schema.parse({});\n    // If the config setting is an array, override instead of merge\n    const mergeRule = (_obj: any, src: any) => (Array.isArray(src) ? src : undefined);\n\n    for (const source of sources) {\n      config = mergeWith(config, await source.load(config), mergeRule);\n    }\n\n    const parsedConfig = this.schema.parse(config);\n    mergeWith(this.resolvedConfig, parsedConfig, mergeRule);\n  }\n\n  reset() {\n    this.resolvedConfig = this.schema.parse({});\n  }\n\n  get config() {\n    return this.resolvedConfig;\n  }\n}\n"]}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAC9F,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAQtF,MAAM,UAAU,uBAAuB,CAAC,MAAsB,EAAE;IAC9D,OAAO;QACL,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM;KACzB,CAAC;AAAA,CACH;AAED,MAAM,UAAU,oBAAoB,CAAC,IAAY,EAAgB;IAC/D,OAAO;QACL,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;YAChB,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;gBAAE,OAAO,EAAE,CAAC;YAE5C,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAAA,CACpD;KACF,CAAC;AAAA,CACH;AAUD,MAAM,UAAU,mBAAmB,CACjC,OAAuE,EACzD;IACd,OAAO;QACL,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;YAChB,MAAM,MAAM,GAA2B,EAAE,CAAC;YAE1C,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAuB,EAAE,CAAC;gBAC1E,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAClC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACxB,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;gBACtB,CAAC;YACH,CAAC;YAED,OAAO,MAAM,CAAC;QAAA,CACf;KACF,CAAC;AAAA,CACH;AAED,MAAM,UAAU,8BAA8B,CAAC,MAAc,EAAgB;IAC3E,OAAO;QACL,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,CAAC;YAC9B,IAAI,CAAC,cAAc,CAAC,YAAY,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC;gBACtE,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,qBAAqB,EAAE,CAAC;YAE/C,sEAAsE;YACtE,sEAAsE;YACtE,oEAAoE;YACpE,wEAAwE;YACxE,kEAAkE;YAClE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YAC7D,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,IAAI,CAC/B,IAAI,mBAAmB,CAAC;gBACtB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;aAClE,CAAC,CACH,CAAC;YAEF,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC;YACrE,IAAI,CAAC,QAAQ;gBAAE,OAAO,EAAE,CAAC;YAEzB,iEAAiE;YACjE,kEAAkE;YAClE,MAAM,oBAAoB,GAAG,IAAI,oBAAoB,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YACnF,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,IAAI,CACjD,IAAI,qBAAqB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAClD,CAAC;YACF,IAAI,CAAC,WAAW,CAAC,YAAY;gBAAE,OAAO,EAAE,CAAC;YAEzC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YACpD,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAAA,CACpD;KACF,CAAC;AAAA,CACH;AAED,MAAM,UAAU,oBAAoB,GAAiB;IACnD,OAAO;QACL,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,CAAC;YAC9B,IAAI,CAAC,cAAc,CAAC,YAAY,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC;gBACtE,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,qBAAqB,EAAE,CAAC;YAC/C,MAAM,QAAQ,GAAG,MAAM,qBAAqB,EAAE,CAAC;YAE/C,OAAO;gBACL,QAAQ;gBACR,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,SAAS,EAAE,QAAQ,CAAC,MAAM;aAC3B,CAAC;QAAA,CACH;KACF,CAAC;AAAA,CACH;AAED,MAAM,OAAO,YAAY;IACN,MAAM,CAAS;IACxB,cAAc,CAAkB;IAExC,YAAY,MAAc,EAAE;QAC1B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,uEAAuE;QACvE,qEAAqE;QACrE,sCAAsC;QACtC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAAA,CACxC;IAED,KAAK,CAAC,eAAe,CAAC,OAAO,GAAmB,EAAE,EAAE;QAClD,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACnC,+DAA+D;QAC/D,MAAM,SAAS,GAAG,CAAC,IAAS,EAAE,GAAQ,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAElF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC;QACnE,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC/C,SAAS,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;IAAA,CACzD;IAED,KAAK,GAAG;QACN,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAAA,CAC7C;IAED,IAAI,MAAM,GAAG;QACX,OAAO,IAAI,CAAC,cAAc,CAAC;IAAA,CAC5B;CACF","sourcesContent":["import { DescribeTagsCommand, EC2Client } from '@aws-sdk/client-ec2';\nimport { GetSecretValueCommand, SecretsManagerClient } from '@aws-sdk/client-secrets-manager';\nimport { mergeWith } from 'es-toolkit';\nimport fs from 'fs-extra';\nimport { z } from 'zod';\n\nimport { fetchInstanceHostname, fetchInstanceIdentity } from '@prairielearn/aws-imds';\n\ntype AbstractConfig = Record<string, unknown>;\n\nexport interface ConfigSource {\n  load: (existingConfig: AbstractConfig) => Promise<AbstractConfig>;\n}\n\nexport function makeLiteralConfigSource(config: AbstractConfig) {\n  return {\n    load: async () => config,\n  };\n}\n\nexport function makeFileConfigSource(path: string): ConfigSource {\n  return {\n    load: async () => {\n      if (!(await fs.pathExists(path))) return {};\n\n      const config = await fs.readJson(path);\n      return z.record(z.string(), z.any()).parse(config);\n    },\n  };\n}\n\n/**\n * Extracts keys from T where string is assignable to the value type.\n * This ensures we only map environment variables to fields that accept strings.\n */\ntype StringAssignableKeys<T> = {\n  [K in keyof T]: string extends T[K] ? K : never;\n}[keyof T];\n\nexport function makeEnvConfigSource<Schema extends z.ZodTypeAny>(\n  mapping: Partial<Record<StringAssignableKeys<z.infer<Schema>>, string>>,\n): ConfigSource {\n  return {\n    load: async () => {\n      const config: Record<string, string> = {};\n\n      for (const [key, envVar] of Object.entries(mapping) as [string, string][]) {\n        const value = process.env[envVar];\n        if (value !== undefined) {\n          config[key] = value;\n        }\n      }\n\n      return config;\n    },\n  };\n}\n\nexport function makeSecretsManagerConfigSource(tagKey: string): ConfigSource {\n  return {\n    load: async (existingConfig) => {\n      if (!existingConfig.runningInEc2 && !process.env.CONFIG_LOAD_FROM_AWS) {\n        return {};\n      }\n\n      const identity = await fetchInstanceIdentity();\n\n      // We disable the ESLint rule here because we don't care about sharing\n      // configs between clients in this case. We only want to share configs\n      // to avoid spamming the IMDS API when creating lots of clients, but\n      // this client will only be used once, typically at application startup.\n      // eslint-disable-next-line @prairielearn/aws-client-shared-config\n      const ec2Client = new EC2Client({ region: identity.region });\n      const tags = await ec2Client.send(\n        new DescribeTagsCommand({\n          Filters: [{ Name: 'resource-id', Values: [identity.instanceId] }],\n        }),\n      );\n\n      const secretId = tags.Tags?.find((tag) => tag.Key === tagKey)?.Value;\n      if (!secretId) return {};\n\n      // As above, we don't care about sharing configs between clients.\n      // eslint-disable-next-line @prairielearn/aws-client-shared-config\n      const secretsManagerClient = new SecretsManagerClient({ region: identity.region });\n      const secretValue = await secretsManagerClient.send(\n        new GetSecretValueCommand({ SecretId: secretId }),\n      );\n      if (!secretValue.SecretString) return {};\n\n      const config = JSON.parse(secretValue.SecretString);\n      return z.record(z.string(), z.any()).parse(config);\n    },\n  };\n}\n\nexport function makeImdsConfigSource(): ConfigSource {\n  return {\n    load: async (existingConfig) => {\n      if (!existingConfig.runningInEc2 && !process.env.CONFIG_LOAD_FROM_AWS) {\n        return {};\n      }\n\n      const hostname = await fetchInstanceHostname();\n      const identity = await fetchInstanceIdentity();\n\n      return {\n        hostname,\n        instanceId: identity.instanceId,\n        awsRegion: identity.region,\n      };\n    },\n  };\n}\n\nexport class ConfigLoader<Schema extends z.ZodTypeAny> {\n  private readonly schema: Schema;\n  private resolvedConfig: z.infer<Schema>;\n\n  constructor(schema: Schema) {\n    this.schema = schema;\n\n    // Get the default values from the schema. This ensures that all values\n    // have defaults, and also allows us to override nested defaults with\n    // `_.merge()` in `loadAndValidate()`.\n    this.resolvedConfig = schema.parse({});\n  }\n\n  async loadAndValidate(sources: ConfigSource[] = []) {\n    let config = this.schema.parse({});\n    // If the config setting is an array, override instead of merge\n    const mergeRule = (_obj: any, src: any) => (Array.isArray(src) ? src : undefined);\n\n    for (const source of sources) {\n      config = mergeWith(config, await source.load(config), mergeRule);\n    }\n\n    const parsedConfig = this.schema.parse(config);\n    mergeWith(this.resolvedConfig, parsedConfig, mergeRule);\n  }\n\n  reset() {\n    this.resolvedConfig = this.schema.parse({});\n  }\n\n  get config() {\n    return this.resolvedConfig;\n  }\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAC9F,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,MAAM,UAAU,CAAC;AAC1B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAQtF,MAAM,UAAU,uBAAuB,CAAC,MAAsB,EAAE;IAC9D,OAAO;QACL,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM;KACzB,CAAC;AAAA,CACH;AAED,MAAM,UAAU,oBAAoB,CAAC,IAAY,EAAgB;IAC/D,OAAO;QACL,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;YAChB,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;gBAAE,OAAO,EAAE,CAAC;YAE5C,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAAA,CACpD;KACF,CAAC;AAAA,CACH;AAUD,MAAM,UAAU,mBAAmB,CACjC,OAAuE,EACzD;IACd,OAAO;QACL,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;YAChB,MAAM,MAAM,GAA2B,EAAE,CAAC;YAE1C,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAuB,EAAE,CAAC;gBAC1E,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAClC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACxB,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;gBACtB,CAAC;YACH,CAAC;YAED,OAAO,MAAM,CAAC;QAAA,CACf;KACF,CAAC;AAAA,CACH;AAED,MAAM,UAAU,8BAA8B,CAAC,MAAc,EAAgB;IAC3E,OAAO;QACL,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,CAAC;YAC9B,IAAI,CAAC,cAAc,CAAC,YAAY,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC;gBACtE,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,qBAAqB,EAAE,CAAC;YAE/C,sEAAsE;YACtE,sEAAsE;YACtE,oEAAoE;YACpE,wEAAwE;YACxE,kEAAkE;YAClE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YAC7D,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,IAAI,CAC/B,IAAI,mBAAmB,CAAC;gBACtB,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;aAClE,CAAC,CACH,CAAC;YAEF,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC;YACrE,IAAI,CAAC,QAAQ;gBAAE,OAAO,EAAE,CAAC;YAEzB,iEAAiE;YACjE,kEAAkE;YAClE,MAAM,oBAAoB,GAAG,IAAI,oBAAoB,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YACnF,MAAM,WAAW,GAAG,MAAM,oBAAoB,CAAC,IAAI,CACjD,IAAI,qBAAqB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAClD,CAAC;YACF,IAAI,CAAC,WAAW,CAAC,YAAY;gBAAE,OAAO,EAAE,CAAC;YAEzC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YACpD,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAAA,CACpD;KACF,CAAC;AAAA,CACH;AAED,MAAM,UAAU,oBAAoB,GAAiB;IACnD,OAAO;QACL,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,CAAC;YAC9B,IAAI,CAAC,cAAc,CAAC,YAAY,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,CAAC;gBACtE,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,qBAAqB,EAAE,CAAC;YAC/C,MAAM,QAAQ,GAAG,MAAM,qBAAqB,EAAE,CAAC;YAE/C,OAAO;gBACL,QAAQ;gBACR,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,SAAS,EAAE,QAAQ,CAAC,MAAM;aAC3B,CAAC;QAAA,CACH;KACF,CAAC;AAAA,CACH;AAED,MAAM,OAAO,YAAY;IACN,MAAM,CAAS;IACxB,cAAc,CAAkB;IAExC,YAAY,MAAc,EAAE;QAC1B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,uEAAuE;QACvE,qEAAqE;QACrE,sCAAsC;QACtC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAAA,CACxC;IAED,KAAK,CAAC,eAAe,CAAC,OAAO,GAAwB,EAAE,EAAE;QACvD,IAAI,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACnC,+DAA+D;QAC/D,MAAM,SAAS,GAAG,CAAC,IAAS,EAAE,GAAQ,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAElF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,GAAG,SAAS,CAAC,MAAM,EAAE,MAAM,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC;QACnE,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC/C,SAAS,CAAC,IAAI,CAAC,cAAc,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;IAAA,CACzD;IAED,KAAK,GAAG;QACN,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAAA,CAC7C;IAED,IAAI,MAAM,GAAG;QACX,OAAO,IAAI,CAAC,cAAc,CAAC;IAAA,CAC5B;CACF","sourcesContent":["import { DescribeTagsCommand, EC2Client } from '@aws-sdk/client-ec2';\nimport { GetSecretValueCommand, SecretsManagerClient } from '@aws-sdk/client-secrets-manager';\nimport { mergeWith } from 'es-toolkit';\nimport fs from 'fs-extra';\nimport { z } from 'zod';\n\nimport { fetchInstanceHostname, fetchInstanceIdentity } from '@prairielearn/aws-imds';\n\ntype AbstractConfig = Record<string, unknown>;\n\nexport interface ConfigSource<T extends AbstractConfig = AbstractConfig> {\n  load: (existingConfig: T) => Promise<Partial<T>>;\n}\n\nexport function makeLiteralConfigSource(config: AbstractConfig) {\n  return {\n    load: async () => config,\n  };\n}\n\nexport function makeFileConfigSource(path: string): ConfigSource {\n  return {\n    load: async () => {\n      if (!(await fs.pathExists(path))) return {};\n\n      const config = await fs.readJson(path);\n      return z.record(z.string(), z.any()).parse(config);\n    },\n  };\n}\n\n/**\n * Extracts keys from T where string is assignable to the value type.\n * This ensures we only map environment variables to fields that accept strings.\n */\ntype StringAssignableKeys<T> = {\n  [K in keyof T]: string extends T[K] ? K : never;\n}[keyof T];\n\nexport function makeEnvConfigSource<Schema extends z.ZodTypeAny>(\n  mapping: Partial<Record<StringAssignableKeys<z.infer<Schema>>, string>>,\n): ConfigSource {\n  return {\n    load: async () => {\n      const config: Record<string, string> = {};\n\n      for (const [key, envVar] of Object.entries(mapping) as [string, string][]) {\n        const value = process.env[envVar];\n        if (value !== undefined) {\n          config[key] = value;\n        }\n      }\n\n      return config;\n    },\n  };\n}\n\nexport function makeSecretsManagerConfigSource(tagKey: string): ConfigSource {\n  return {\n    load: async (existingConfig) => {\n      if (!existingConfig.runningInEc2 && !process.env.CONFIG_LOAD_FROM_AWS) {\n        return {};\n      }\n\n      const identity = await fetchInstanceIdentity();\n\n      // We disable the ESLint rule here because we don't care about sharing\n      // configs between clients in this case. We only want to share configs\n      // to avoid spamming the IMDS API when creating lots of clients, but\n      // this client will only be used once, typically at application startup.\n      // eslint-disable-next-line @prairielearn/aws-client-shared-config\n      const ec2Client = new EC2Client({ region: identity.region });\n      const tags = await ec2Client.send(\n        new DescribeTagsCommand({\n          Filters: [{ Name: 'resource-id', Values: [identity.instanceId] }],\n        }),\n      );\n\n      const secretId = tags.Tags?.find((tag) => tag.Key === tagKey)?.Value;\n      if (!secretId) return {};\n\n      // As above, we don't care about sharing configs between clients.\n      // eslint-disable-next-line @prairielearn/aws-client-shared-config\n      const secretsManagerClient = new SecretsManagerClient({ region: identity.region });\n      const secretValue = await secretsManagerClient.send(\n        new GetSecretValueCommand({ SecretId: secretId }),\n      );\n      if (!secretValue.SecretString) return {};\n\n      const config = JSON.parse(secretValue.SecretString);\n      return z.record(z.string(), z.any()).parse(config);\n    },\n  };\n}\n\nexport function makeImdsConfigSource(): ConfigSource {\n  return {\n    load: async (existingConfig) => {\n      if (!existingConfig.runningInEc2 && !process.env.CONFIG_LOAD_FROM_AWS) {\n        return {};\n      }\n\n      const hostname = await fetchInstanceHostname();\n      const identity = await fetchInstanceIdentity();\n\n      return {\n        hostname,\n        instanceId: identity.instanceId,\n        awsRegion: identity.region,\n      };\n    },\n  };\n}\n\nexport class ConfigLoader<Schema extends z.ZodTypeAny> {\n  private readonly schema: Schema;\n  private resolvedConfig: z.infer<Schema>;\n\n  constructor(schema: Schema) {\n    this.schema = schema;\n\n    // Get the default values from the schema. This ensures that all values\n    // have defaults, and also allows us to override nested defaults with\n    // `_.merge()` in `loadAndValidate()`.\n    this.resolvedConfig = schema.parse({});\n  }\n\n  async loadAndValidate(sources: ConfigSource<any>[] = []) {\n    let config = this.schema.parse({});\n    // If the config setting is an array, override instead of merge\n    const mergeRule = (_obj: any, src: any) => (Array.isArray(src) ? src : undefined);\n\n    for (const source of sources) {\n      config = mergeWith(config, await source.load(config), mergeRule);\n    }\n\n    const parsedConfig = this.schema.parse(config);\n    mergeWith(this.resolvedConfig, parsedConfig, mergeRule);\n  }\n\n  reset() {\n    this.resolvedConfig = this.schema.parse({});\n  }\n\n  get config() {\n    return this.resolvedConfig;\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prairielearn/config",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "type": "module",
   "repository": {
     "type": "git",
@@ -17,18 +17,18 @@
     "test": "vitest run --coverage"
   },
   "dependencies": {
-    "@aws-sdk/client-ec2": "^3.980.0",
-    "@aws-sdk/client-secrets-manager": "^3.980.0",
-    "@prairielearn/aws-imds": "^3.0.1",
-    "es-toolkit": "^1.44.0",
+    "@aws-sdk/client-ec2": "^3.1000.0",
+    "@aws-sdk/client-secrets-manager": "^3.1000.0",
+    "@prairielearn/aws-imds": "^3.0.2",
+    "es-toolkit": "^1.45.0",
     "fs-extra": "^11.3.3",
     "zod": "^3.25.76"
   },
   "devDependencies": {
     "@prairielearn/tsconfig": "^2.0.0",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^24.10.9",
-    "@typescript/native-preview": "^7.0.0-dev.20260130.1",
+    "@types/node": "^24.11.0",
+    "@typescript/native-preview": "^7.0.0-dev.20260302.1",
     "@vitest/coverage-v8": "^4.0.18",
     "tmp-promise": "^3.0.3",
     "tsx": "^4.21.0",

package/src/index.ts

@@ -8,8 +8,8 @@ import { fetchInstanceHostname, fetchInstanceIdentity } from '@prairielearn/aws-
 
 type AbstractConfig = Record<string, unknown>;
 
-export interface ConfigSource {
-  load: (existingConfig: AbstractConfig) => Promise<AbstractConfig>;
+export interface ConfigSource<T extends AbstractConfig = AbstractConfig> {
+  load: (existingConfig: T) => Promise<Partial<T>>;
 }
 
 export function makeLiteralConfigSource(config: AbstractConfig) {
@@ -126,7 +126,7 @@ export class ConfigLoader<Schema extends z.ZodTypeAny> {
     this.resolvedConfig = schema.parse({});
   }
 
-  async loadAndValidate(sources: ConfigSource[] = []) {
+  async loadAndValidate(sources: ConfigSource<any>[] = []) {
     let config = this.schema.parse({});
     // If the config setting is an array, override instead of merge
     const mergeRule = (_obj: any, src: any) => (Array.isArray(src) ? src : undefined);