Remove configure empty config requirement for NoConfig modules

Author: rpanic

packages/common/src/config/ModuleContainer.ts

@@ -85,18 +85,39 @@ export interface ModulesRecord<
   [name: string]: ModuleType;
 }
 
-// config record derived from the provided modules and their config types
-export type ModulesConfig<Modules extends ModulesRecord> = {
-  // this will translate into = key: module name, value: module.config
-  [ConfigKey in StringKeyOf<Modules>]: InstanceType<
-    Modules[ConfigKey]
-  > extends Configurable<infer Config>
+type ExtractConfig<Module extends BaseModuleType> =
+  InstanceType<Module> extends Configurable<infer Config>
     ? Config extends NoConfig
       ? Config | undefined
       : Config
     : never;
+
+type OnlyDefined<R extends Record<string, unknown>> = {
+  [Key in keyof R as NoConfig extends R[Key] ? never : Key]: R[Key];
+};
+type OptionalUndefined<R extends Record<string, unknown>> = {
+  [Key in keyof R as NoConfig extends R[Key] ? Key : never]?: R[Key];
+};
+
+type MakeNoConfigOptional<A extends Record<string, unknown>> = OnlyDefined<A> &
+  OptionalUndefined<A>;
+
+export type CompletedModulesConfig<Modules extends ModulesRecord> = {
+  // this will translate into = key: module name, value: module.config
+  [ConfigKey in StringKeyOf<Modules>]: ExtractConfig<Modules[ConfigKey]>;
 };
 
+// config record derived from the provided modules and their config types
+export type ModulesConfig<Modules extends ModulesRecord> = MakeNoConfigOptional<
+  CompletedModulesConfig<Modules>
+>;
+
+// export type MakeNeeded<R extends {  }>
+
+// export type ShortConfig<Modules extends ModulesRecord> =
+//   ModulesConfig<Modules>
+// >;
+
 /**
  * This type make any config partial (i.e. optional) up to the first level
  * So { Module: { a: { b: string } } }
@@ -289,6 +310,26 @@ export class ModuleContainer<
     });
   }
 
+  private completeConfig(
+    config: ModulesConfig<Modules>
+  ): ModulesConfig<Modules> {
+    const keys = Object.keys(config);
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    const moduleNames = this.moduleNames as StringKeyOf<Modules>[];
+    const noConfigParts = moduleNames
+      .filter((moduleName) => !keys.includes(moduleName))
+      .reduce<Record<string, NoConfig>>((obj, moduleName) => {
+        obj[moduleName] = {};
+        return obj;
+      }, {});
+
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    return {
+      ...config,
+      ...noConfigParts,
+    } as unknown as ModulesConfig<Modules>;
+  }
+
   /**
    * Provide additional configuration after the ModuleContainer was created.
    *
@@ -298,7 +339,7 @@ export class ModuleContainer<
    * @param config
    */
   public configure(config: ModulesConfig<Modules>) {
-    this.config = config;
+    this.config = this.completeConfig(config);
   }
 
   public configurePartial(config: RecursivePartial<ModulesConfig<Modules>>) {
@@ -316,8 +357,14 @@ export class ModuleContainer<
     super.config = merge<
       ModulesConfig<Modules> | NoConfig,
       ModulesConfig<Modules>
-    >(this.currentConfig ?? {}, config);
+    >(this.currentConfig ?? {}, this.completeConfig(config));
   }
+  // public set config(config: ShortConfig<Modules>) {
+  //   super.config = merge<ShortConfig<Modules> | NoConfig, ShortConfig<Modules>>(
+  //     this.currentConfig ?? {},
+  //     config
+  //   );
+  // }
 
   /**
    * Resolves a module from the current module container
@@ -359,7 +406,11 @@ export class ModuleContainer<
     moduleName: StringKeyOf<Modules>,
     containedModule: InstanceType<Modules[StringKeyOf<Modules>]>
   ) {
-    const config = super.config?.[moduleName];
+    const config =
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+      (super.config as unknown as CompletedModulesConfig<Modules>)?.[
+        moduleName
+      ];
     // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
     if (!config) {
       throw errors.configNotSetInContainer(moduleName.toString());

packages/common/test/config/ModuleContainer.test.ts

@@ -50,6 +50,8 @@ class TestModule
   }
 }
 
+class NoConfigModule extends BaseTestModule<NoConfig> {}
+
 interface OtherTestModuleConfig {
   otherTestConfigProperty: number;
 }
@@ -79,6 +81,7 @@ describe("moduleContainer", () => {
   let container: TestModuleContainer<{
     TestModule: typeof TestModule;
     OtherTestModule: typeof OtherTestModule;
+    NoConfigModule: typeof NoConfigModule;
   }>;
   const testConfigProperty = 0;
 
@@ -89,6 +92,7 @@ describe("moduleContainer", () => {
         OtherTestModule,
         // this module would not be assignable to TestModuleContainer
         // WrongTestModule,
+        NoConfigModule,
       },
     });
   });