String overrides all other types in this union type (#31610)

Author: qmonmert

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

@@ -20,6 +20,7 @@
 import { lowerFirst, upperFirst } from 'lodash-es';
 
 import { asJdlRelationshipType } from '../core/basic-types/relationship-types.ts';
+import type { JDLOptionName } from '../core/built-in-options/binary-options.ts';
 import { binaryOptions, relationshipOptions, unaryOptions } from '../core/built-in-options/index.ts';
 import { JDLEntity, JDLEnum } from '../core/models/index.ts';
 import JDLBinaryOption from '../core/models/jdl-binary-option.ts';
@@ -307,7 +308,7 @@ function addEntityOptionsToJDL(entity: JSONEntity, entityName: string): void {
   }
 }
 
-function addUnaryOptionToJDL(unaryOption: string, entityName: string): void {
+function addUnaryOptionToJDL(unaryOption: JDLOptionName, entityName: string): void {
   jdlObject.addOption(
     new JDLUnaryOption({
       name: unaryOption,
@@ -316,7 +317,7 @@ function addUnaryOptionToJDL(unaryOption: string, entityName: string): void {
   );
 }
 
-function addBinaryOptionToJDL(binaryOption: string, value: string, entityName: string): void {
+function addBinaryOptionToJDL(binaryOption: JDLOptionName, value: string, entityName: string): void {
   jdlObject.addOption(
     new JDLBinaryOption({
       name: binaryOption,

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

@@ -17,7 +17,9 @@
  * limitations under the License.
  */
 
+import type { BinaryOptionType } from '../../core/built-in-options/binary-options.ts';
 import { binaryOptions, unaryOptions } from '../../core/built-in-options/index.ts';
+import type { UnaryOptionType } from '../../core/built-in-options/unary-options.ts';
 import type AbstractJDLOption from '../../core/models/abstract-jdl-option.ts';
 import JDLBinaryOption from '../../core/models/jdl-binary-option.ts';
 import JDLUnaryOption from '../../core/models/jdl-unary-option.ts';
@@ -47,7 +49,7 @@ export function convertOptions(
 
 function convertUnaryOptions(parsedOptions: Record<string, ParsedJDLOption>): JDLUnaryOption[] {
   const convertedUnaryOptions: JDLUnaryOption[] = [];
-  unaryOptions.forEach((unaryOptionName: string) => {
+  unaryOptions.forEach((unaryOptionName: UnaryOptionType) => {
     const parsedUnaryOption = parsedOptions[unaryOptionName];
     if (!parsedUnaryOption?.list || parsedUnaryOption.list.length === 0) {
       return;
@@ -65,7 +67,7 @@ function convertUnaryOptions(parsedOptions: Record<string, ParsedJDLOption>): JD
 
 function convertBinaryOptions(parsedOptions: Record<string, Record<string, ParsedJDLOption>>): JDLBinaryOption[] {
   const convertedBinaryOptions: JDLBinaryOption[] = [];
-  binaryOptions.forEach((binaryOptionName: string) => {
+  binaryOptions.forEach((binaryOptionName: BinaryOptionType) => {
     if (!parsedOptions[binaryOptionName]) {
       return;
     }

lib/jdl/core/built-in-options/binary-options.spec.ts

@@ -55,12 +55,6 @@ describe('jdl - BinaryOptions', () => {
         expect(binaryOptions.exists(binaryOptions.Options.DTO, binaryOptions.Values.dto.MAPSTRUCT)).to.be.true;
       });
     });
-    describe('when checking for a custom binary option', () => {
-      it('should return true', () => {
-        expect(binaryOptions.exists('customOption')).to.be.true;
-        expect(binaryOptions.exists('customOption', 'customValue')).to.be.true;
-      });
-    });
   });
   describe('forEach', () => {
     describe('when not passing a function', () => {

lib/jdl/core/built-in-options/binary-options.ts

@@ -18,6 +18,8 @@
  */
 import entityOptions from '../../../jhipster/entity-options.ts';
 
+import type { UnaryOptionType } from './unary-options.ts';
+
 const { MapperTypes, PaginationTypes, SearchTypes, ServiceTypes } = entityOptions;
 const { MAPSTRUCT } = MapperTypes;
 const NO_MAPPER = MapperTypes.NO;
@@ -52,13 +54,17 @@ const Values = {
   search: searchValues,
 } as const;
 
+export type BinaryOptionType = (typeof Options)[keyof typeof Options];
+
+export type JDLOptionName = BinaryOptionType | UnaryOptionType | 'paginate';
+
 const DefaultValues = {
   [Options.DTO]: Values[Options.DTO].NO,
   [Options.SERVICE]: Values[Options.SERVICE].NO,
   [Options.PAGINATION]: Values[Options.PAGINATION].NO,
 };
 
-function getOptionName(optionValue: string): string | undefined {
+function getOptionName(optionValue: string): JDLOptionName | undefined {
   return optionNames.find(optionName => (Values as Record<string, Record<string, string>>)[optionName]?.[optionValue]);
 }
 
@@ -72,14 +78,14 @@ const OptionValues = {
   couchbase: 'COUCHBASE',
 } as const;
 
-function forEach(passedFunction: (optionName: string) => void): void {
+function forEach(passedFunction: (optionName: BinaryOptionType) => void): void {
   if (!passedFunction) {
     throw new Error('A function has to be passed to loop over the binary options.');
   }
-  optionNames.forEach(passedFunction);
+  optionNames.forEach(optionName => passedFunction(optionName as BinaryOptionType));
 }
 
-function exists(passedOption: string | keyof typeof Values | 'microservice' | 'angularSuffix' | 'clientRootFolder', passedValue?: any) {
+function exists(passedOption: JDLOptionName, passedValue?: any) {
   return (
     !(optionNames as string[]).includes(passedOption) ||
     optionNames.some(

lib/jdl/core/built-in-options/unary-options.ts

@@ -27,14 +27,16 @@ const Options = {
 
 const optionNames = Object.values(Options);
 
+export type UnaryOptionType = (typeof Options)[keyof typeof Options];
+
 export default {
   ...Options,
-  forEach: (passedFunction: (optionName: string) => void) => {
+  forEach: (passedFunction: (optionName: UnaryOptionType) => void) => {
     if (!passedFunction) {
       throw new Error('A function has to be passed to loop over the unary options.');
     }
     optionNames.forEach(optionName => {
-      passedFunction(optionName);
+      passedFunction(optionName as UnaryOptionType);
     });
   },
   exists: (optionName: string) => (Object.values(Options) as string[]).includes(optionName),

lib/jdl/core/models/abstract-jdl-option.ts

@@ -17,17 +17,18 @@
  * limitations under the License.
  */
 
+import type { JDLOptionName } from '../built-in-options/binary-options.ts';
 import { merge } from '../utils/object-utils.ts';
 import { addAll } from '../utils/set-utils.ts';
 
 export type JDLOptionParams = {
-  name: string;
+  name: JDLOptionName;
   entityNames?: Set<string> | string[];
   excludedNames?: Set<string> | string[];
 };
 
 export default class AbstractJDLOption {
-  name: string;
+  name: JDLOptionName;
   entityNames: Set<string>;
   excludedNames: Set<string>;