internal: add generics to base-core

Author: mshima

.blueprint/generate-sample/generator.mts

@@ -7,7 +7,7 @@ import { GENERATOR_APP, GENERATOR_INFO, GENERATOR_JDL } from '../../generators/g
 import { entitiesByType, generateSample } from './support/index.js';
 import assert from 'assert';
 
-export default class extends BaseGenerator {
+export default class extends BaseGenerator<{ entities: string[] }> {
   sampleName;
   global;
   projectFolder;

generators/angular/generator.ts

@@ -43,7 +43,7 @@ import type { AngularApplication, AngularEntity } from './types.js';
 
 const { ANGULAR } = clientFrameworkTypes;
 
-export default class AngularGenerator extends BaseApplicationGenerator<DefaultTaskTypes<AngularEntity, AngularApplication>> {
+export default class AngularGenerator extends BaseApplicationGenerator<unknown, DefaultTaskTypes<AngularEntity, AngularApplication>> {
   async beforeQueue() {
     if (!this.fromBlueprint) {
       await this.composeWithBlueprints();

generators/angular/types.d.ts

@@ -26,10 +26,10 @@ export interface AngularEntity extends Entity {
    * @param fields returns the import of enums that are referenced by the fields
    * @returns {typeImports:Map} the fields that potentially contains some enum types
    */
-  generateEntityClientEnumImports: (fields: any) => Map<any, any>;
+  generateEntityClientEnumImports?: (fields: any) => Map<any, any>;
 }
 
 export type AngularApplication = {
   /** @experimental to be replaced with needles */
-  angularEntities: AngularEntity[];
+  angularEntities?: AngularEntity[];
 } & ApplicationType<AngularEntity>;

generators/base-application/generator.ts

@@ -86,8 +86,11 @@ const asPriority = BaseGenerator.asPriority;
  * This is the base class for a generator that generates entities.
  */
 export default class BaseApplicationGenerator<
+  ConfigType = unknown,
   TaskTypes extends DefaultTaskTypes<any, any> = DefaultTaskTypes,
-> extends BaseGenerator<TaskTypes> {
+  Options = unknown,
+  Features = unknown,
+> extends BaseGenerator<ConfigType & ApplicationConfiguration, TaskTypes, Options, Features> {
   static CONFIGURING_EACH_ENTITY = asPriority(CONFIGURING_EACH_ENTITY);
 
   static LOADING_ENTITIES = asPriority(LOADING_ENTITIES);
@@ -104,7 +107,6 @@ export default class BaseApplicationGenerator<
 
   static POST_WRITING_ENTITIES = asPriority(POST_WRITING_ENTITIES);
 
-  declare jhipsterConfig: ApplicationConfiguration & Record<string, any>;
   declare sharedData: SharedData;
 
   constructor(args: string | string[], options: JHipsterGeneratorOptions, features: JHipsterGeneratorFeatures) {

generators/base-application/support/task-type-inference.ts

@@ -17,44 +17,45 @@
 import type { ApplicationType } from '../../../lib/types/application/application.js';
 import type { TaskTypes } from '../../../lib/types/application/tasks.js';
 import type CoreGenerator from '../../base-core/generator.js';
+import type BaseApplicationGenerator from '../../base-application/generator.js';
 import type { WriteFileSection } from '../../base/api.js';
 import type { Entity } from '../../../lib/types/application/entity.js';
 
 export function asWriteFilesSection<Data = ApplicationType<Entity>>(section: WriteFileSection<Data>) {
   return section;
 }
 
-export function asPromptingTask<E = Entity, A = ApplicationType<E>, const G extends CoreGenerator = CoreGenerator>(
+export function asPromptingTask<E = Entity, A = ApplicationType<E>, const G extends CoreGenerator = BaseApplicationGenerator>(
   task: (this: G, params: TaskTypes<E, A>['PromptingTaskParam']) => void,
 ) {
   return task;
 }
 
-export function asPostPreparingEachEntityTask<E = Entity, A = ApplicationType<E>, const G extends CoreGenerator = CoreGenerator>(
+export function asPostPreparingEachEntityTask<E = Entity, A = ApplicationType<E>, const G extends CoreGenerator = BaseApplicationGenerator>(
   task: (this: G, params: TaskTypes<E, A>['PostPreparingEachEntityTaskParam']) => void,
 ) {
   return task;
 }
 
-export function asWritingTask<E = Entity, A = ApplicationType<E>, const G extends CoreGenerator = CoreGenerator>(
+export function asWritingTask<E = Entity, A = ApplicationType<E>, const G extends CoreGenerator = BaseApplicationGenerator>(
   task: (this: G, params: TaskTypes<E, A>['WritingTaskParam']) => void,
 ) {
   return task;
 }
 
-export function asWritingEntitiesTask<E = Entity, A = ApplicationType<E>, const G extends CoreGenerator = CoreGenerator>(
+export function asWritingEntitiesTask<E = Entity, A = ApplicationType<E>, const G extends CoreGenerator = BaseApplicationGenerator>(
   task: (this: G, params: TaskTypes<E, A>['WritingEntitiesTaskParam']) => void,
 ) {
   return task;
 }
 
-export function asPostWritingTask<E = Entity, A = ApplicationType<E>, const G extends CoreGenerator = CoreGenerator>(
+export function asPostWritingTask<E = Entity, A = ApplicationType<E>, const G extends CoreGenerator = BaseApplicationGenerator>(
   task: (this: G, params: TaskTypes<E, A>['PostWritingTaskParam']) => void,
 ) {
   return task;
 }
 
-export function asPostWritingEntitiesTask<E = Entity, A = ApplicationType<E>, const G extends CoreGenerator = CoreGenerator>(
+export function asPostWritingEntitiesTask<E = Entity, A = ApplicationType<E>, const G extends CoreGenerator = BaseApplicationGenerator>(
   task: (this: G, params: TaskTypes<E, A>['PostWritingEntitiesTaskParam']) => void,
 ) {
   return task;

generators/base-core/generator.ts

@@ -75,8 +75,7 @@ import { dockerPlaceholderGenerator } from '../docker/utils.js';
 import { getConfigWithDefaults } from '../../lib/jhipster/index.js';
 import { extractArgumentsFromConfigs } from '../../lib/command/index.js';
 import type BaseApplicationGenerator from '../base-application/generator.js';
-import type { ApplicationConfiguration } from '../../lib/types/application/yo-rc.js';
-import type { Control } from '../base/types.js';
+import type { Config, Control } from './types.js';
 import { convertWriteFileSectionsToBlocks } from './internal/index.js';
 
 const {
@@ -111,7 +110,12 @@ const deepMerge = (source1: any, source2: any) => mergeWith({}, source1, source2
 /**
  * This is the base class for a generator for every generator.
  */
-export default class CoreGenerator extends YeomanGenerator<JHipsterGeneratorOptions, JHipsterGeneratorFeatures> {
+export default class CoreGenerator<
+  ConfigType extends Config = Config,
+  ConfigDefaultsType extends Readonly<ConfigType> = Readonly<ConfigType>,
+  Options = unknown,
+  Features = unknown,
+> extends YeomanGenerator<JHipsterGeneratorOptions & Options, JHipsterGeneratorFeatures & Features> {
   static asPriority = asPriority;
 
   static INITIALIZING = asPriority(INITIALIZING);
@@ -153,7 +157,7 @@ export default class CoreGenerator extends YeomanGenerator<JHipsterGeneratorOpti
 
   readonly sharedData!: SharedData<any>;
   readonly logger: Logger;
-  jhipsterConfig!: Record<string, any>;
+  jhipsterConfig!: ConfigType;
   /**
    * @deprecated
    */
@@ -189,9 +193,9 @@ export default class CoreGenerator extends YeomanGenerator<JHipsterGeneratorOpti
       this._config = this._getStorage('generator-jhipster');
 
       /* JHipster config using proxy mode used as a plain object instead of using get/set. */
-      this.jhipsterConfig = this.config.createProxy();
+      this.jhipsterConfig = this.config.createProxy() as ConfigType;
 
-      this.sharedData = this.createSharedData() as any;
+      this.sharedData = this.createSharedData();
 
       /* Options parsing must be executed after forcing jhipster storage namespace and after sharedData have been populated */
       this.parseJHipsterOptions(baseCommand.options);
@@ -254,7 +258,7 @@ export default class CoreGenerator extends YeomanGenerator<JHipsterGeneratorOpti
   /**
    * JHipster config with default values fallback
    */
-  get jhipsterConfigWithDefaults(): Readonly<ApplicationConfiguration & Record<string, any>> {
+  get jhipsterConfigWithDefaults(): ConfigDefaultsType {
     const configWithDefaults = getConfigWithDefaults(removeFieldsWithNullishValues(this.config.getAll()));
     defaults(configWithDefaults, {
       skipFakeData: false,
@@ -263,7 +267,7 @@ export default class CoreGenerator extends YeomanGenerator<JHipsterGeneratorOpti
       autoCrlf: false,
       pages: [],
     });
-    return configWithDefaults as ApplicationConfiguration;
+    return configWithDefaults as ConfigDefaultsType;
   }
 
   /**
@@ -680,11 +684,11 @@ You can ignore this error by passing '--skip-checks' to jhipster command.`);
       }
     } else {
       // Get and store lastLiquibaseTimestamp, a future timestamp can be used
-      let lastLiquibaseTimestamp = this.jhipsterConfig.lastLiquibaseTimestamp;
+      const lastLiquibaseTimestamp = this.jhipsterConfig.lastLiquibaseTimestamp;
       if (lastLiquibaseTimestamp) {
-        lastLiquibaseTimestamp = new Date(lastLiquibaseTimestamp);
-        if (lastLiquibaseTimestamp >= now) {
-          now = lastLiquibaseTimestamp;
+        const lastTimeStampDate = new Date(lastLiquibaseTimestamp);
+        if (lastTimeStampDate >= now) {
+          now = lastTimeStampDate;
           now.setSeconds(now.getSeconds() + 1);
           now.setMilliseconds(0);
         }

generators/base/types.d.ts renamed to generators/base-core/types.d.ts

@@ -22,3 +22,10 @@ export type Control = {
    */
   cleanupFiles: (cleanup: CleanupArgumentType) => Promise<void> | ((oldVersion: string, cleanup: CleanupArgumentType) => Promise<void>);
 };
+
+export type Config = {
+  jhipsterVersion?: string;
+  autoCrlf?: boolean;
+  lastLiquibaseTimestamp?: number;
+  blueprints?: { name: string; version?: string }[];
+};

generators/base-entity-changes/generator.ts

@@ -53,7 +53,7 @@ type TaskTypes = ApplicationTaskTypes & {
 /**
  * This is the base class for a generator for every generator.
  */
-export default abstract class GeneratorBaseEntityChanges extends GeneratorBaseApplication<TaskTypes> {
+export default abstract class GeneratorBaseEntityChanges extends GeneratorBaseApplication<unknown, TaskTypes> {
   recreateInitialChangelog!: boolean;
   private entityChanges!: any[];
 

generators/base-workspaces/generator.ts

@@ -59,7 +59,17 @@ type WorkspacesTypes<E extends Entity = Entity, A extends ApplicationType<E> = A
 /**
  * This is the base class for a generator that generates entities.
  */
-export default abstract class BaseWorkspacesGenerator extends BaseGenerator<WorkspacesTypes> {
+export default abstract class BaseWorkspacesGenerator<Config = unknown> extends BaseGenerator<
+  Config & {
+    appsFolders: string[];
+    directoryPath: string;
+    deploymentType: string;
+    jwtSecretKey: string;
+    adminPassword: string;
+    serviceDiscoveryType: string;
+  },
+  WorkspacesTypes
+> {
   static PROMPTING_WORKSPACES = BaseGenerator.asPriority(PROMPTING_WORKSPACES);
 
   static CONFIGURING_WORKSPACES = BaseGenerator.asPriority(CONFIGURING_WORKSPACES);

generators/base-workspaces/internal/deployments.ts

@@ -19,15 +19,15 @@
 import { defaults } from 'lodash-es';
 import { applicationOptions, deploymentOptions } from '../../../lib/jhipster/index.js';
 import { loadDerivedPlatformConfig, loadDerivedServerAndPlatformProperties, loadPlatformConfig } from '../../server/support/index.js';
-import type { GeneratorBaseCore } from '../../index.js';
+import type BaseWorkspacesGenerator from '../index.js';
 
 const { OptionNames } = applicationOptions;
 const { Options: DeploymentOptions } = deploymentOptions;
 
 const { JWT_SECRET_KEY } = OptionNames;
 
 export function loadDeploymentConfig(
-  this: GeneratorBaseCore,
+  this: BaseWorkspacesGenerator,
   {
     config = defaults({}, this.jhipsterConfig, DeploymentOptions.defaults(this.jhipsterConfig.deploymentType)),
     deployment = this,

generators/base/generator.ts

@@ -26,6 +26,7 @@ import { union } from 'lodash-es';
 import { packageJson } from '../../lib/index.js';
 import CoreGenerator from '../base-core/index.js';
 import type { TaskTypes as BaseTaskTypes, GenericTaskGroup } from '../../lib/types/base/tasks.js';
+import type { Config } from '../base-core/types.js';
 import { packageNameToNamespace } from './support/index.js';
 import { loadBlueprintsFromConfiguration, mergeBlueprints, normalizeBlueprintName, parseBluePrints } from './internal/index.js';
 import { PRIORITY_NAMES } from './priorities.js';
@@ -35,7 +36,12 @@ import { LOCAL_BLUEPRINT_PACKAGE_NAMESPACE } from './support/constants.js';
 /**
  * Base class that contains blueprints support.
  */
-export default class JHipsterBaseBlueprintGenerator<TaskTypes extends BaseTaskTypes = BaseTaskTypes> extends CoreGenerator {
+export default class JHipsterBaseBlueprintGenerator<
+  ConfigType = unknown,
+  TaskTypes extends BaseTaskTypes = BaseTaskTypes,
+  Options = unknown,
+  Features = unknown,
+> extends CoreGenerator<ConfigType & Config, Readonly<ConfigType & Config>, Options, Features> {
   fromBlueprint!: boolean;
   sbsBlueprint?: boolean;
   delegateToBlueprint?: boolean;

generators/base/shared-data.ts

@@ -29,7 +29,7 @@ import { GENERATOR_JHIPSTER } from '../generator-constants.js';
 import type { ApplicationType, BaseApplicationSource } from '../../lib/types/application/application.js';
 import type { Entity } from '../../lib/types/application/entity.js';
 import type { Entity as BaseEntity } from '../../lib/types/base/entity.js';
-import type { CleanupArgumentType, Control } from './types.js';
+import type { CleanupArgumentType, Control } from '../base-core/types.js';
 
 export default class SharedData<EntityType extends BaseEntity = Entity, Application = ApplicationType> {
   _storage: any;

generators/bootstrap/generator.ts

@@ -212,7 +212,7 @@ export default class BootstrapGenerator extends BaseGenerator {
         await createPrettierTransform.call(this, {
           ignoreErrors,
           prettierPackageJson: true,
-          prettierJava: !this.jhipsterConfig.skipServer,
+          prettierJava: !(this.jhipsterConfig as any).skipServer,
           extensions: this.prettierExtensions.join(','),
           prettierOptions: this.prettierOptions,
           skipForks: this.skipForks,

generators/client/generator.ts

@@ -84,7 +84,7 @@ export default class JHipsterClientGenerator extends BaseApplicationGenerator {
         if (this.jhipsterConfig.devServerPort !== undefined || this.jhipsterConfig.applicationIndex === undefined) return;
 
         const { applicationIndex, devServerPort } = this.jhipsterConfigWithDefaults;
-        this.jhipsterConfig.devServerPort = devServerPort + applicationIndex;
+        this.jhipsterConfig.devServerPort = devServerPort! + applicationIndex!;
       },
     });
   }

generators/git/generator.ts

@@ -23,11 +23,7 @@ import type { QueuedAdapter } from '@yeoman/types';
 import BaseGenerator from '../base/index.js';
 import { files } from './files.js';
 
-/**
- * @class
- * @extends {BaseGenerator}
- */
-export default class GitGenerator extends BaseGenerator {
+export default class GitGenerator extends BaseGenerator<{ baseName?: string; monorepository?: boolean }> {
   gitInitialized!: boolean;
   skipGit!: boolean;
   forceGit!: boolean;
@@ -68,7 +64,7 @@ export default class GitGenerator extends BaseGenerator {
       async preparing() {
         if (!this.skipGit) {
           // Force write .yo-rc.json to disk, it's used to check if the application is regenerated
-          this.jhipsterConfig.skipGit = undefined;
+          this.jhipsterConfig.monorepository ??= undefined;
         }
       },
     });

generators/info/generator.ts

@@ -21,19 +21,19 @@
  */
 import chalk from 'chalk';
 
-import BaseApplicationGenerator from '../base-application/index.js';
+import BaseGenerator from '../base/index.js';
 import JSONToJDLEntityConverter from '../../lib/jdl/converters/json-to-jdl-entity-converter.js';
 import JSONToJDLOptionConverter from '../../lib/jdl/converters/json-to-jdl-option-converter.js';
 import type { JHipsterGeneratorFeatures, JHipsterGeneratorOptions } from '../base/api.js';
-import { YO_RC_FILE } from '../generator-constants.js';
+import { JHIPSTER_CONFIG_DIR, YO_RC_FILE } from '../generator-constants.js';
 import { applicationsLookup } from '../workspaces/support/applications-lookup.js';
 import type { Entity } from '../../lib/types/base/entity.js';
-import { convertFieldBlobType } from '../../lib/application/field-types.js';
+import { getEntitiesFromDir } from '../base-application/support/index.js';
 import { replaceSensitiveConfig } from './support/utils.js';
 
 const isInfoCommand = commandName => commandName === 'info' || undefined;
 
-export default class InfoGenerator extends BaseApplicationGenerator {
+export default class InfoGenerator extends BaseGenerator<{ appsFolders?: string[]; baseName?: string; packages?: string[] }> {
   constructor(args: string | string[], options: JHipsterGeneratorOptions, features: JHipsterGeneratorFeatures) {
     super(args, options, {
       jhipsterBootstrap: false,
@@ -44,7 +44,7 @@ export default class InfoGenerator extends BaseApplicationGenerator {
     });
   }
 
-  get [BaseApplicationGenerator.INITIALIZING]() {
+  get [BaseGenerator.INITIALIZING]() {
     return this.asInitializingTaskGroup({
       sayHello() {
         this.log.log(chalk.white('Welcome to the JHipster Information Sub-Generator\n'));
@@ -143,16 +143,13 @@ export default class InfoGenerator extends BaseApplicationGenerator {
     let jdlObject;
     const entities = new Map<string, Entity>();
     try {
-      this.getExistingEntities().forEach(({ name, definition: entity }) => {
-        if (entity.fields) {
-          for (const field of entity.fields) {
-            if (field.fieldType === 'byte[]') {
-              convertFieldBlobType(field);
-            }
-          }
+      const foundEntities = getEntitiesFromDir(this.destinationPath(JHIPSTER_CONFIG_DIR));
+      for (const entity of foundEntities) {
+        const entityJson = this.readDestinationJSON(this.destinationPath(JHIPSTER_CONFIG_DIR, `${entity}.json`));
+        if (entityJson) {
+          entities.set(entity, entityJson);
         }
-        entities.set(name, entity);
-      });
+      }
       jdlObject = JSONToJDLEntityConverter.convertEntitiesToJDL(entities);
       JSONToJDLOptionConverter.convertServerOptionsToJDL({ 'generator-jhipster': this.config.getAll() }, jdlObject);
     } catch (error) {

generators/javascript/generators/husky/command.ts

@@ -18,7 +18,7 @@
  */
 import type { JHipsterCommandDefinition } from '../../../../lib/command/index.js';
 
-const command: JHipsterCommandDefinition = {
+const command = {
   configs: {
     skipCommitHook: {
       description: 'Skip adding husky commit hooks',
@@ -29,6 +29,6 @@ const command: JHipsterCommandDefinition = {
     },
   },
   import: [],
-};
+} as const satisfies JHipsterCommandDefinition;
 
 export default command;

generators/jdl/generator.ts

@@ -47,7 +47,7 @@ const toJdlFile = file => {
 
 type ApplicationWithEntitiesAndPath = ApplicationWithEntities & { folder?: string; sharedFs?: MemFs };
 
-export default class JdlGenerator extends BaseGenerator {
+export default class JdlGenerator extends BaseGenerator<{ baseName: string; prodDatabaseType: string }> {
   jdlFiles?: string[];
   inline?: string;
   jdlContents: string[] = [];