More type checking

jdl/converters/json-to-jdl-converter.ts

@@ -26,7 +26,7 @@ import { readJSONFile } from '../readers/json-file-reader.js';
 import { convertApplicationToJDL } from './json-to-jdl-application-converter.js';
 import { convertEntitiesToJDL } from './json-to-jdl-entity-converter.js';
 import exportJDLObject from '../exporters/jdl-exporter.js';
-import { JSONEntity, JSONRootObject, PostProcessedJSONGeneratorJhipsterContent, PostProcessedJSONRootObject } from './types.js';
+import { JSONEntity, YoRCJSONObject, PostProcessedJSONGeneratorJhipsterContent, PostProcessedJSONRootObject } from './types.js';
 import { removeFieldsWithNullishValues } from '../../generators/base/support/config.js';
 import { GENERATOR_JHIPSTER } from '../../generators/generator-constants.js';
 import JDLApplication from '../models/jdl-application.js';
@@ -44,7 +44,7 @@ export default {
 export function convertToJDL(directory = '.', output: string | false = 'app.jdl'): JDLObject | undefined {
   let jdlObject: JDLObject;
   if (doesFileExist(path.join(directory, '.yo-rc.json'))) {
-    const yoRcFileContent: JSONRootObject = readJSONFile(path.join(directory, '.yo-rc.json'));
+    const yoRcFileContent: YoRCJSONObject = readJSONFile(path.join(directory, '.yo-rc.json'));
     let entities: Map<string, JSONEntity> | undefined;
     if (doesDirectoryExist(path.join(directory, '.jhipster'))) {
       entities = getJSONEntityFiles(directory);
@@ -64,7 +64,7 @@ export function convertToJDL(directory = '.', output: string | false = 'app.jdl'
   return jdlObject;
 }
 
-export function convertSingleContentToJDL(yoRcFileContent: JSONRootObject, entities?: Map<string, JSONEntity>): string {
+export function convertSingleContentToJDL(yoRcFileContent: YoRCJSONObject, entities?: Map<string, JSONEntity>): string {
   return getJDLObjectFromSingleApplication(yoRcFileContent, entities).toString();
 }
 
@@ -76,7 +76,7 @@ function getJDLObjectFromMultipleApplications(directory: string): JDLObject {
   let jdlObject = new JDLObject();
   subDirectories.forEach(subDirectory => {
     const applicationDirectory = path.join(directory, subDirectory);
-    const yoRcFileContent: JSONRootObject = readJSONFile(path.join(applicationDirectory, '.yo-rc.json'));
+    const yoRcFileContent: YoRCJSONObject = readJSONFile(path.join(applicationDirectory, '.yo-rc.json'));
     let entities: Map<string, JSONEntity> = new Map();
     if (doesDirectoryExist(path.join(applicationDirectory, '.jhipster'))) {
       entities = getJSONEntityFiles(applicationDirectory);
@@ -87,7 +87,7 @@ function getJDLObjectFromMultipleApplications(directory: string): JDLObject {
 }
 
 export function getJDLObjectFromSingleApplication(
-  yoRcFileContent: JSONRootObject,
+  yoRcFileContent: YoRCJSONObject,
   entities?: Map<string, JSONEntity>,
   existingJDLObject = new JDLObject(),
 ): JDLObject {
@@ -103,7 +103,7 @@ export function getJDLObjectFromSingleApplication(
   return mergeJDLObjects(existingJDLObject, jdlObject);
 }
 
-function cleanYoRcFileContent(yoRcFileContent: JSONRootObject): PostProcessedJSONRootObject {
+function cleanYoRcFileContent(yoRcFileContent: YoRCJSONObject): PostProcessedJSONRootObject {
   for (const key of Object.keys(yoRcFileContent)) {
     yoRcFileContent[key] = removeFieldsWithNullishValues(yoRcFileContent[key]);
   }

jdl/converters/json-to-jdl-entity-converter.ts

@@ -132,7 +132,7 @@ function convertJSONToJDLValidation(rule: string, field: JSONField): JDLValidati
 }
 
 function addEnumsToJDL(entity: JSONEntity): void {
-  entity?.fields?.forEach(field => {
+  entity?.fields?.forEach((field: JSONField) => {
     if (field.fieldValues !== undefined) {
       jdlObject.addEnum(
         new JDLEnum({
@@ -145,7 +145,7 @@ function addEnumsToJDL(entity: JSONEntity): void {
   });
 }
 
-function getEnumValuesFromString(valuesAsString: string): any {
+function getEnumValuesFromString(valuesAsString: string): any[] {
   return valuesAsString.split(',').map(fieldValue => {
     // if fieldValue looks like ENUM_VALUE (something)
     if (fieldValue.includes('(')) {

jdl/converters/parsed-jdl-to-jdl-object/deployment-converter.spec.ts

@@ -54,6 +54,11 @@ describe('jdl - DeploymentConverter', () => {
     "directoryPath": "../",
     "dockerPushCommand": "docker push",
     "dockerRepositoryName": "test",
+    "gatewayType": undefined,
+    "ingressDomain": undefined,
+    "ingressType": undefined,
+    "istio": undefined,
+    "kubernetesServiceType": undefined,
     "monitoring": "no",
     "openshiftNamespace": "default",
     "registryReplicas": 2,

jdl/converters/parsed-jdl-to-jdl-object/enum-converter.spec.ts

@@ -24,7 +24,6 @@ describe('jdl - EnumConverter', () => {
   describe('convertEnums', () => {
     describe('when not passing enumerations', () => {
       it('should fail', () => {
-        // @ts-expect-error
         expect(() => convertEnums()).toThrow(/^Enumerations have to be passed so as to be converted.$/);
       });
     });

jdl/converters/parsed-jdl-to-jdl-object/enum-converter.ts

@@ -28,7 +28,7 @@ export default { convertEnums };
  * @param {Array} enumerations - parsed JDL enumerations.
  * @return the converted JDLEnums.
  */
-export function convertEnums(enumerations): JDLEnum[] {
+export function convertEnums(enumerations?: ParsedJDLEnum[]): JDLEnum[] {
   if (!enumerations) {
     throw new Error('Enumerations have to be passed so as to be converted.');
   }

jdl/converters/parsed-jdl-to-jdl-object/field-converter.spec.ts

@@ -19,6 +19,7 @@
 
 import { before, it, describe, expect } from 'esmocha';
 import { convertField } from './field-converter.js';
+import JDLField from '../../models/jdl-field.js';
 
 describe('jdl - FieldConverter', () => {
   describe('convertField', () => {
@@ -36,7 +37,6 @@ describe('jdl - FieldConverter', () => {
           convertedField = convertField({
             name: 'anAwesomeField',
             type: 'String',
-            comment: 'An awesome comment!',
           });
         });
 
@@ -56,7 +56,7 @@ JDLField {
         let nameFromConvertedField;
 
         before(() => {
-          const convertedField = convertField({
+          const convertedField: JDLField = convertField({
             name: 'AnAwesomeField',
             type: 'String',
           });

jdl/converters/parsed-jdl-to-jdl-object/field-converter.ts

@@ -20,6 +20,7 @@
 import JDLField from '../../models/jdl-field.js';
 import { formatComment } from '../../utils/format-utils.js';
 import { lowerFirst } from '../../utils/string-utils.js';
+import { ParsedJDLEntityField } from './types.js';
 
 export default { convertField };
 
@@ -28,7 +29,7 @@ export default { convertField };
  * @param {Object} field - a parsed JDL field.
  * @return the converted JDLField.
  */
-export function convertField(field): JDLField {
+export function convertField(field: ParsedJDLEntityField): JDLField {
   if (!field) {
     throw new Error('A field has to be passed so as to be converted.');
   }

jdl/converters/parsed-jdl-to-jdl-object/parsed-jdl-to-jdl-object-converter.spec.ts

@@ -581,8 +581,13 @@ JDLDeployment {
   "directoryPath": "../",
   "dockerRepositoryName": "test",
   "gatewayType": "SpringCloudGateway",
+  "ingressDomain": undefined,
+  "ingressType": undefined,
+  "istio": undefined,
+  "kubernetesServiceType": undefined,
   "monitoring": "no",
   "serviceDiscoveryType": "consul",
+  "storageType": undefined,
 }
 `);
         });

jdl/converters/parsed-jdl-to-jdl-object/parsed-jdl-to-jdl-object-converter.ts

@@ -39,6 +39,8 @@ import {
 } from './types.js';
 import JDLApplication from '../../models/jdl-application.js';
 import JDLField from '../../models/jdl-field.js';
+import JDLValidation from '../../models/jdl-validation.js';
+import { JDLEntity } from '../../models/index.js';
 
 let parsedContent: ParsedJDLApplications;
 let configuration: ParsedJDLRoot;
@@ -103,45 +105,45 @@ function fillDeployments(): void {
   });
 }
 
-function fillEnums() {
+function fillEnums(): void {
   const jdlEnums = convertEnums(parsedContent.enums);
   jdlEnums.forEach(jdlEnum => {
     jdlObject.addEnum(jdlEnum);
   });
 }
 
-function fillClassesAndFields() {
-  const jdlEntities = convertEntities(parsedContent.entities, getJDLFieldsFromParsedEntity);
+function fillClassesAndFields(): void {
+  const jdlEntities: JDLEntity[] = convertEntities(parsedContent.entities, getJDLFieldsFromParsedEntity);
   jdlEntities.forEach(jdlEntity => {
     jdlObject.addEntity(jdlEntity);
   });
 }
 
 function getJDLFieldsFromParsedEntity(entity: ParsedJDLEntity): JDLField[] {
-  const fields: any[] = [];
+  const fields: JDLField[] = [];
   const arr = entity.body || [];
   for (let i = 0; i < arr.length; i++) {
     const field = arr[i];
     const jdlField = convertField(field);
     jdlField.validations = getValidations(field);
-    jdlField.options = convertAnnotationsToOptions(field.annotations);
+    jdlField.options = convertAnnotationsToOptions(field.annotations || []);
     fields.push(jdlField);
   }
   return fields;
 }
 
-function getValidations(field: ParsedJDLEntityField) {
+function getValidations(field: ParsedJDLEntityField): Record<string, JDLValidation> {
   return convertValidations(field.validations, getConstantValueFromConstantName).reduce((jdlValidations, jdlValidation) => {
     jdlValidations[jdlValidation.name] = jdlValidation;
     return jdlValidations;
   }, {});
 }
 
-function getConstantValueFromConstantName(constantName: string) {
+function getConstantValueFromConstantName(constantName: string): string {
   return parsedContent.constants[constantName];
 }
 
-function fillAssociations() {
+function fillAssociations(): void {
   const jdlRelationships = convertRelationships(parsedContent.relationships, convertAnnotationsToOptions);
   jdlRelationships.forEach(jdlRelationship => {
     // TODO: addRelationship only expects one argument.
@@ -173,15 +175,15 @@ function convertAnnotationsToOptions(
   return result;
 }
 
-function fillOptions() {
+function fillOptions(): void {
   if (configuration.applicationType === applicationTypes.MICROSERVICE && !parsedContent.options.microservice) {
-    globallyAddMicroserviceOption(configuration.applicationName);
+    globallyAddMicroserviceOption(configuration.applicationName!);
   }
   fillUnaryAndBinaryOptions();
 }
 
 // TODO: move it to another file? it may not be the parser's responsibility to do it
-function globallyAddMicroserviceOption(applicationName) {
+function globallyAddMicroserviceOption(applicationName: string): void {
   jdlObject.addOption(
     new JDLBinaryOption({
       name: binaryOptions.Options.MICROSERVICE,
@@ -191,7 +193,7 @@ function globallyAddMicroserviceOption(applicationName) {
   );
 }
 
-function fillUnaryAndBinaryOptions() {
+function fillUnaryAndBinaryOptions(): void {
   // TODO: move it to another file? it may not be the parser's responsibility to do it
   if (configuration.applicationType === applicationTypes.MICROSERVICE) {
     jdlObject.addOption(

jdl/converters/parsed-jdl-to-jdl-object/relationship-converter.spec.ts

@@ -56,6 +56,7 @@ describe('jdl - RelationshipConverter', () => {
                 },
               },
             ],
+            // @ts-expect-error
             options => {
               if (options.length !== 0) {
                 return { builtInEntity: true };
@@ -116,6 +117,7 @@ describe('jdl - RelationshipConverter', () => {
                 },
               },
             ],
+            // @ts-expect-error
             options => {
               if (options.length !== 0) {
                 return { builtInEntity: true };

jdl/converters/parsed-jdl-to-jdl-object/relationship-converter.ts

@@ -21,7 +21,7 @@ import JDLRelationship from '../../models/jdl-relationship.js';
 import { lowerFirst } from '../../utils/string-utils.js';
 import { formatComment } from '../../utils/format-utils.js';
 import { asJdlRelationshipType } from '../../jhipster/relationship-types.js';
-import { ParsedJDLRelationship } from './types.js';
+import { ParsedJDLAnnotation, ParsedJDLRelationship } from './types.js';
 
 export default { convertRelationships };
 
@@ -31,7 +31,12 @@ export default { convertRelationships };
  * @param {Function} annotationToOptionConverter - the function that can convert annotations to options.
  * @return the converted JDL relationships.
  */
-export function convertRelationships(parsedRelationships: ParsedJDLRelationship[], annotationToOptionConverter): JDLRelationship[] {
+export function convertRelationships(
+  parsedRelationships: ParsedJDLRelationship[],
+  annotationToOptionConverter: (
+    annotations: ParsedJDLAnnotation[],
+  ) => Record<string, boolean | string | number | string[] | boolean[] | number[]>,
+): JDLRelationship[] {
   if (!parsedRelationships) {
     throw new Error('Relationships have to be passed so as to be converted.');
   }

jdl/converters/parsed-jdl-to-jdl-object/types.ts

@@ -31,8 +31,11 @@ export type ParsedJDLValidation = {
 };
 
 export type ParsedJDLEntityField = {
-  annotations: ParsedJDLAnnotation[];
-  validations: ParsedJDLValidation[];
+  annotations?: ParsedJDLAnnotation[];
+  validations?: ParsedJDLValidation[];
+  name: string;
+  type: string;
+  documentation?: string;
 };
 
 export type ParsedJDLEntity = {

jdl/converters/parsed-jdl-to-jdl-object/validation-converter.spec.ts

@@ -24,7 +24,6 @@ describe('jdl - ValidationConverter', () => {
   describe('convertValidations', () => {
     describe('when not passing validations', () => {
       it('should fail', () => {
-        // @ts-expect-error
         expect(() => convertValidations()).toThrow(/^Validations have to be passed so as to be converted.$/);
       });
     });

jdl/converters/parsed-jdl-to-jdl-object/validation-converter.ts

@@ -34,15 +34,15 @@ export default { convertValidations };
  * @return the converted JDLValidations.
  */
 export function convertValidations(
-  validations: ParsedJDLValidation[],
-  constantValueGetter: (constant: string) => string | number | boolean | RegExp,
+  validations?: ParsedJDLValidation[],
+  constantValueGetter?: (constant: string) => string | number | boolean | RegExp,
 ): JDLValidation[] {
   if (!validations) {
     throw new Error('Validations have to be passed so as to be converted.');
   }
   return validations.reduce((jdlValidations: JDLValidation[], parsedValidation: ParsedJDLValidation) => {
     if (parsedValidation) {
-      jdlValidations = [...jdlValidations, convertValidation(parsedValidation, constantValueGetter)];
+      jdlValidations = [...jdlValidations, convertValidation(parsedValidation, constantValueGetter!)];
     }
     return jdlValidations;
   }, []);
@@ -63,15 +63,15 @@ function convertValidation(
     value = constantValueGetter.call(undefined, value as string);
   }
   if (validation.key === PATTERN) {
-    value = formatThePatternValidationValue(value);
+    value = formatThePatternValidationValue(value as string);
   }
   return new JDLValidation({
     name: validation.key,
     value,
   });
 }
 
-function formatThePatternValidationValue(value) {
+function formatThePatternValidationValue(value: string): string {
   if (!value.includes("'")) {
     return value;
   }

jdl/converters/types.ts

@@ -41,7 +41,10 @@ export type JSONBlueprint = {
 export type JSONMicrofrontend = {
   baseName: string;
 };
-
+export type JSONGeneratorJhipsterContentDeployment = {
+  appsFolders?: string[];
+  clusteredDbApps?: string[];
+};
 export type JSONGeneratorJhipsterContent = {
   baseName: string;
   applicationType?: string;
@@ -74,7 +77,8 @@ export type JSONGeneratorJhipsterContent = {
   promptValues?: Partial<JSONGeneratorJhipsterContent>;
   blueprints?: JSONBlueprint[] | null;
   microfrontends?: JSONMicrofrontend[] | null;
-} & Record<string, any>;
+} & JSONGeneratorJhipsterContentDeployment &
+  Record<string, any>;
 
 export type PostProcessedJSONGeneratorJhipsterContent = Omit<
   JSONGeneratorJhipsterContent,
@@ -88,6 +92,6 @@ export type PostProcessedJSONRootObject = {
   [GENERATOR_JHIPSTER]: PostProcessedJSONGeneratorJhipsterContent;
 };
 
-export type JSONRootObject = {
+export type YoRCJSONObject = {
   [GENERATOR_JHIPSTER]: JSONGeneratorJhipsterContent;
 };

jdl/exporters/config.ts

@@ -1,12 +1,14 @@
 import { GENERATOR_NAME } from './export-utils.js';
+import { YoRCJSONObject } from '../converters/types.js';
 
-export const mergeYoRcContent = (oldConfig: Record<string, Record<string, any>>, newConfig: Record<string, Record<string, any>>) => {
-  const merged: Record<string, Record<string, any>> = { [GENERATOR_NAME]: {} };
+export const mergeYoRcContent = (oldConfig: YoRCJSONObject, newConfig: YoRCJSONObject): YoRCJSONObject => {
+  // @ts-expect-error partial assignment
+  const merged: Partial<YoRCJSONObject> = { [GENERATOR_NAME]: {} };
   for (const ns of new Set([...Object.keys(oldConfig), ...Object.keys(newConfig)])) {
     merged[ns] = { ...oldConfig[ns], ...newConfig[ns] };
   }
   if (oldConfig[GENERATOR_NAME]?.creationTimestamp) {
-    merged[GENERATOR_NAME].creationTimestamp = oldConfig[GENERATOR_NAME].creationTimestamp;
+    merged[GENERATOR_NAME]!.creationTimestamp = oldConfig[GENERATOR_NAME].creationTimestamp;
   }
-  return merged;
+  return merged as YoRCJSONObject;
 };