generator-jhipster 8.4.0 → 8.5.0

package/dist/generators/app/generator.js

@@ -114,8 +114,8 @@ export default class JHipsterAppGenerator extends BaseApplicationGenerator {
     get [BaseApplicationGenerator.CONFIGURING]() {
         return this.delegateTasksToBlueprint(() => this.configuring);
     }
-    get composing() {
-        return this.asComposingTaskGroup({
+    get composingComponent() {
+        return this.asComposingComponentTaskGroup({
             /**
              * Composing with others generators, must be executed after `configuring` priority to let others
              * generators `configuring` priority to run.
@@ -138,19 +138,10 @@ export default class JHipsterAppGenerator extends BaseApplicationGenerator {
                     await this.composeWithJHipster(GENERATOR_CLIENT);
                 }
             },
-            /**
-             * At this point every other generator should already be configured, so, enforce defaults fallback.
-             */
-            saveConfigWithDefaults() {
-                const config = this.jhipsterConfigWithDefaults;
-                if (config.entitySuffix === config.dtoSuffix) {
-                    throw new Error('Entities cannot be generated as the entity suffix and DTO suffix are equals !');
-                }
-            },
         });
     }
-    get [BaseApplicationGenerator.COMPOSING]() {
-        return this.delegateTasksToBlueprint(() => this.composing);
+    get [BaseApplicationGenerator.COMPOSING_COMPONENT]() {
+        return this.delegateTasksToBlueprint(() => this.composingComponent);
     }
     get writing() {
         return this.asWritingTaskGroup({

package/dist/generators/base/generator.js

@@ -20,14 +20,12 @@ import fs from 'fs';
 import path from 'path';
 import chalk from 'chalk';
 import semver from 'semver';
-import { defaults } from 'lodash-es';
 import { packageJson } from '../../lib/index.js';
-import { packageNameToNamespace, removeFieldsWithNullishValues } from './support/index.js';
+import { packageNameToNamespace } from './support/index.js';
 import { mergeBlueprints, parseBluePrints, loadBlueprintsFromConfiguration, normalizeBlueprintName } from './internal/index.js';
 import { PRIORITY_NAMES } from './priorities.js';
 import CoreGenerator from '../base-core/index.js';
 import { LOCAL_BLUEPRINT_PACKAGE_NAMESPACE } from './support/constants.js';
-import { getConfigWithDefaults } from '../../jdl/index.js';
 import { loadStoredAppOptions } from '../app/support/index.js';
 /**
  * Base class that contains blueprints support.
@@ -160,6 +158,20 @@ export default class JHipsterBaseBlueprintGenerator extends CoreGenerator {
     asComposingTaskGroup(taskGroup) {
         return taskGroup;
     }
+    /**
+     * Priority API stub for blueprints.
+     *
+     * ComposingComponent priority should be used to handle component configuration order.
+     */
+    get composingComponent() {
+        return {};
+    }
+    /**
+     * Utility method to get typed objects for autocomplete.
+     */
+    asComposingComponentTaskGroup(taskGroup) {
+        return taskGroup;
+    }
     /**
      * Priority API stub for blueprints.
      *
@@ -343,19 +355,6 @@ export default class JHipsterBaseBlueprintGenerator extends CoreGenerator {
     asEndTaskGroup(taskGroup) {
         return taskGroup;
     }
-    /**
-     * JHipster config with default values fallback
-     */
-    get jhipsterConfigWithDefaults() {
-        const configWithDefaults = getConfigWithDefaults(removeFieldsWithNullishValues(this.config.getAll()));
-        defaults(configWithDefaults, {
-            skipFakeData: false,
-            skipCheckLengthOfIdentifier: false,
-            enableGradleEnterprise: false,
-            pages: [],
-        });
-        return configWithDefaults;
-    }
     /**
      * @protected
      * Composes with blueprint generators, if any.

package/dist/generators/base/priorities.js

@@ -32,6 +32,8 @@ const END = 'end';
 /** Custom priorities */
 const COMPOSING = 'composing';
 const COMPOSING_QUEUE = `${QUEUE_PREFIX}${COMPOSING}`;
+const COMPOSING_COMPONENT = 'composingComponent';
+const COMPOSING_COMPONENT_QUEUE = `${QUEUE_PREFIX}${COMPOSING_COMPONENT}`;
 const LOADING = 'loading';
 const LOADING_QUEUE = `${QUEUE_PREFIX}${LOADING}`;
 const PREPARING = 'preparing';
@@ -70,9 +72,15 @@ export const CUSTOM_PRIORITIES = [
     {
         priorityName: COMPOSING,
         queueName: COMPOSING_QUEUE,
-        before: LOADING,
+        before: COMPOSING_COMPONENT,
         args: generator => generator.getArgsForPriority(COMPOSING),
     },
+    {
+        priorityName: COMPOSING_COMPONENT,
+        queueName: COMPOSING_COMPONENT_QUEUE,
+        before: LOADING,
+        args: generator => generator.getArgsForPriority(COMPOSING_COMPONENT),
+    },
     {
         priorityName: LOADING,
         queueName: LOADING_QUEUE,
@@ -140,6 +148,7 @@ export const PRIORITY_NAMES = {
     PROMPTING,
     CONFIGURING,
     COMPOSING,
+    COMPOSING_COMPONENT,
     LOADING,
     PREPARING,
     POST_PREPARING,
@@ -158,6 +167,7 @@ export const PRIORITY_NAMES_LIST = [
     PROMPTING,
     CONFIGURING,
     COMPOSING,
+    COMPOSING_COMPONENT,
     LOADING,
     PREPARING,
     POST_PREPARING,
@@ -175,6 +185,7 @@ export const QUEUES = {
     PROMPTING_QUEUE: PROMPTING,
     CONFIGURING_QUEUE: CONFIGURING,
     COMPOSING_QUEUE,
+    COMPOSING_COMPONENT_QUEUE,
     LOADING_QUEUE,
     PREPARING_QUEUE,
     POST_PREPARING_QUEUE,

package/dist/generators/base-application/generator.js

@@ -448,6 +448,8 @@ export default class BaseApplicationGenerator extends BaseGenerator {
             taskName: 'queueConfiguringEachEntity',
             cancellable: true,
             method: () => {
+                if (this.options.skipPriorities?.includes(CONFIGURING_EACH_ENTITY))
+                    return;
                 this.log.debug(`Queueing entity tasks ${CONFIGURING_EACH_ENTITY}`);
                 const tasks = this.extractTasksFromPriority(CONFIGURING_EACH_ENTITY, { skip: false });
                 this.getEntitiesDataToConfigure().forEach(({ entityName, entityStorage, entityConfig }) => {
@@ -467,6 +469,8 @@ export default class BaseApplicationGenerator extends BaseGenerator {
             taskName: 'queueLoadingEntities',
             cancellable: true,
             method: () => {
+                if (this.options.skipPriorities?.includes(LOADING_ENTITIES))
+                    return;
                 this.log.debug(`Queueing entity tasks ${LOADING_ENTITIES}`);
                 const tasks = this.extractTasksFromPriority(LOADING_ENTITIES, { skip: false });
                 this.log.debug(`Queueing entity tasks ${LOADING_ENTITIES}`);
@@ -484,6 +488,8 @@ export default class BaseApplicationGenerator extends BaseGenerator {
             taskName: 'queuePreparingEachEntity',
             cancellable: true,
             method: () => {
+                if (this.options.skipPriorities?.includes(PREPARING_EACH_ENTITY))
+                    return;
                 this.log.debug(`Queueing entity tasks ${PREPARING_EACH_ENTITY}`);
                 const tasks = this.extractTasksFromPriority(PREPARING_EACH_ENTITY, { skip: false });
                 this.getEntitiesDataToPrepare().forEach(({ description, ...data }) => {
@@ -503,6 +509,8 @@ export default class BaseApplicationGenerator extends BaseGenerator {
             taskName: 'queuePreparingEachEntityField',
             cancellable: true,
             method: () => {
+                if (this.options.skipPriorities?.includes(PREPARING_EACH_ENTITY_FIELD))
+                    return;
                 const tasks = this.extractTasksFromPriority(PREPARING_EACH_ENTITY_FIELD, { skip: false });
                 this.getEntitiesFieldsDataToPrepare().forEach(({ description, ...data }) => {
                     this.log.debug(`Queueing entity tasks ${PREPARING_EACH_ENTITY_FIELD} for ${description}`);
@@ -521,6 +529,8 @@ export default class BaseApplicationGenerator extends BaseGenerator {
             taskName: 'queuePreparingEachEntityRelationship',
             cancellable: true,
             method: () => {
+                if (this.options.skipPriorities?.includes(PREPARING_EACH_ENTITY_RELATIONSHIP))
+                    return;
                 const tasks = this.extractTasksFromPriority(PREPARING_EACH_ENTITY_RELATIONSHIP, { skip: false });
                 this.getEntitiesRelationshipsDataToPrepare().forEach(({ description, ...data }) => {
                     this.log.debug(`Queueing entity tasks ${PREPARING_EACH_ENTITY_RELATIONSHIP} for ${description}`);
@@ -539,6 +549,8 @@ export default class BaseApplicationGenerator extends BaseGenerator {
             taskName: 'queuePostPreparingEachEntity',
             cancellable: true,
             method: () => {
+                if (this.options.skipPriorities?.includes(POST_PREPARING_EACH_ENTITY))
+                    return;
                 const tasks = this.extractTasksFromPriority(POST_PREPARING_EACH_ENTITY, { skip: false });
                 this.getEntitiesDataToPostPrepare().forEach(({ description, ...data }) => {
                     this.log.debug(`Queueing entity tasks ${POST_PREPARING_EACH_ENTITY} for ${description}`);
@@ -557,7 +569,7 @@ export default class BaseApplicationGenerator extends BaseGenerator {
             taskName: 'queueWritingEachEntity',
             cancellable: true,
             method: () => {
-                if (this.options.skipWriting)
+                if (this.options.skipWriting || this.options.skipPriorities?.includes(WRITING_ENTITIES))
                     return;
                 const tasks = this.extractTasksFromPriority(WRITING_ENTITIES, { skip: false });
                 const args = this.getArgsForPriority(WRITING_ENTITIES);
@@ -574,7 +586,7 @@ export default class BaseApplicationGenerator extends BaseGenerator {
             taskName: 'queuePostWritingEachEntity',
             cancellable: true,
             method: () => {
-                if (this.options.skipWriting)
+                if (this.options.skipWriting || this.options.skipPriorities?.includes(POST_WRITING_ENTITIES))
                     return;
                 const tasks = this.extractTasksFromPriority(POST_WRITING_ENTITIES, { skip: false });
                 const args = this.getArgsForPriority(POST_WRITING_ENTITIES);

package/dist/generators/base-application/priorities.js

@@ -126,6 +126,7 @@ export const PRIORITY_NAMES_LIST = [
     PRIORITY_NAMES.PROMPTING,
     PRIORITY_NAMES.CONFIGURING,
     PRIORITY_NAMES.COMPOSING,
+    PRIORITY_NAMES.COMPOSING_COMPONENT,
     PRIORITY_NAMES.LOADING,
     PRIORITY_NAMES.PREPARING,
     CONFIGURING_EACH_ENTITY,

package/dist/generators/base-application/support/prepare-entity.js

@@ -22,12 +22,11 @@ import { getDatabaseTypeData, hibernateSnakeCase } from '../../server/support/in
 import { createFaker, parseChangelog, stringHashCode, upperFirstCamelCase, getMicroserviceAppName, mutateData, } from '../../base/support/index.js';
 import { fieldToReference } from './prepare-field.js';
 import { getTypescriptKeyType, getEntityParentPathAddition } from '../../client/support/index.js';
-import { applicationTypes, authenticationTypes, binaryOptions, databaseTypes, entityOptions, fieldTypes, searchEngineTypes, } from '../../../jdl/jhipster/index.js';
+import { applicationTypes, binaryOptions, databaseTypes, entityOptions, fieldTypes, searchEngineTypes, } from '../../../jdl/jhipster/index.js';
 import { fieldIsEnum } from './field-utils.js';
 const NO_SEARCH_ENGINE = searchEngineTypes.NO;
 const { PaginationTypes, ServiceTypes, MapperTypes } = entityOptions;
 const { GATEWAY, MICROSERVICE } = applicationTypes;
-const { OAUTH2 } = authenticationTypes;
 const { CommonDBTypes } = fieldTypes;
 const { BOOLEAN, LONG, STRING, UUID, INTEGER } = CommonDBTypes;
 const { NO: NO_DTO, MAPSTRUCT } = MapperTypes;
@@ -191,10 +190,16 @@ export default function prepareEntity(entityWithConfig, generator, application)
         ? `${entityWithConfig.clientRootFolder}-${entityWithConfig.entityStateName}`
         : entityWithConfig.entityStateName);
     mutateData(entityWithConfig, {
+        __override__: false,
         i18nKeyPrefix: data => data.i18nKeyPrefix ?? `${data.frontendAppName}.${data.entityTranslationKey}`,
         i18nAlertHeaderPrefix: data => data.i18nAlertHeaderPrefix ?? data.microserviceAppName
             ? `${data.microserviceAppName}.${data.entityTranslationKey}`
             : data.i18nKeyPrefix,
+        hasRelationshipWithBuiltInUser: ({ relationships }) => relationships.some(relationship => relationship.otherEntity.builtInUser),
+        saveUserSnapshot: ({ hasRelationshipWithBuiltInUser, dto }) => application.applicationTypeMicroservice &&
+            application.authenticationTypeOauth2 &&
+            hasRelationshipWithBuiltInUser &&
+            dto === NO_MAPPER,
     });
     const { microserviceName, entityFileName, microfrontend } = entityWithConfig;
     entityWithConfig.entityApi = microserviceName ? `services/${microserviceName.toLowerCase()}/` : '';
@@ -203,12 +208,6 @@ export default function prepareEntity(entityWithConfig, generator, application)
             (microfrontend && microserviceName && entityWithConfig.applicationType === MICROSERVICE
                 ? `${microserviceName.toLowerCase()}/${entityFileName}`
                 : `${entityFileName}`);
-    const hasBuiltInUserField = entityWithConfig.relationships.some(relationship => relationship.otherEntity.builtInUser);
-    entityWithConfig.saveUserSnapshot =
-        application.applicationType === MICROSERVICE &&
-            application.authenticationType === OAUTH2 &&
-            hasBuiltInUserField &&
-            entityWithConfig.dto === NO_MAPPER;
     entityWithConfig.generateFakeData = type => {
         const fieldsToGenerate = type === 'cypress' ? entityWithConfig.fields.filter(field => !field.id || !field.autoGenerate) : entityWithConfig.fields;
         const fieldEntries = fieldsToGenerate.map(field => {

package/dist/generators/base-application/support/prepare-relationship.js

@@ -71,9 +71,9 @@ export default function prepareRelationship(entityWithConfig, relationship, gene
         otherEntityNameCapitalized: upperFirst(otherEntityName),
         // let ownerSide true when type is 'many-to-one' for convenience.
         // means that this side should control the reference.
-        ownerSide: relationshipManyToOne || (relationshipLeftSide && !relationshipOneToMany),
+        ownerSide: relationship.otherEntity.embedded || relationshipManyToOne || (relationshipLeftSide && !relationshipOneToMany),
         persistableRelationship: ({ ownerSide }) => ownerSide,
-        relationshipUpdateBackReference: ({ ownerSide, relationshipRightSide }) => entityWithConfig.databaseType === 'neo4j' ? relationshipRightSide : !ownerSide,
+        relationshipUpdateBackReference: ({ ownerSide, relationshipRightSide, otherEntity }) => !otherEntity.embedded && (entityWithConfig.databaseType === NEO4J ? relationshipRightSide : !ownerSide),
         // DB properties
         columnName: hibernateSnakeCase(relationshipName),
         columnNamePrefix: relationship.id && relationshipOneToOne ? '' : `${hibernateSnakeCase(relationshipName)}_`,
@@ -94,6 +94,7 @@ export default function prepareRelationship(entityWithConfig, relationship, gene
         relationship.otherSideReferenceExists = true;
     }
     else if (!ignoreMissingRequiredRelationship &&
+        !relationship.otherEntity.embedded &&
         !relationship.relationshipIgnoreBackReference &&
         entityWithConfig.databaseType !== NEO4J &&
         entityWithConfig.databaseType !== DATABASE_NO &&

package/dist/generators/base-core/generator.js

@@ -25,14 +25,14 @@ import assert from 'assert';
 import { requireNamespace } from '@yeoman/namespace';
 import chalk from 'chalk';
 import { parse as parseYaml, stringify as stringifyYaml } from 'yaml';
-import { kebabCase, snakeCase, merge, get, set } from 'lodash-es';
+import { kebabCase, snakeCase, merge, get, set, defaults } from 'lodash-es';
 import { simpleGit } from 'simple-git';
 import semver, { lt as semverLessThan } from 'semver';
 import YeomanGenerator from 'yeoman-generator';
 import latestVersion from 'latest-version';
 import SharedData from '../base/shared-data.js';
 import { CUSTOM_PRIORITIES, PRIORITY_NAMES, PRIORITY_PREFIX } from '../base/priorities.js';
-import { createJHipster7Context, formatDateForChangelog, joinCallbacks } from '../base/support/index.js';
+import { createJHipster7Context, formatDateForChangelog, joinCallbacks, removeFieldsWithNullishValues, } from '../base/support/index.js';
 import { packageJson } from '../../lib/index.js';
 import { GENERATOR_BOOTSTRAP } from '../generator-list.js';
 import NeedleApi from '../needle-api.js';
@@ -41,7 +41,8 @@ import { GENERATOR_JHIPSTER, YO_RC_FILE } from '../generator-constants.js';
 import { convertConfigToOption } from '../../lib/internal/index.js';
 import { getGradleLibsVersionsProperties } from '../gradle/support/dependabot-gradle.js';
 import { dockerPlaceholderGenerator } from '../docker/utils.js';
-const { INITIALIZING, PROMPTING, CONFIGURING, COMPOSING, LOADING, PREPARING, POST_PREPARING, DEFAULT, WRITING, POST_WRITING, INSTALL, POST_INSTALL, END, } = PRIORITY_NAMES;
+import { getConfigWithDefaults } from '../../jdl/index.js';
+const { INITIALIZING, PROMPTING, CONFIGURING, COMPOSING, COMPOSING_COMPONENT, LOADING, PREPARING, POST_PREPARING, DEFAULT, WRITING, POST_WRITING, INSTALL, POST_INSTALL, END, } = PRIORITY_NAMES;
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 const asPriority = (priorityName) => `${PRIORITY_PREFIX}${priorityName}`;
@@ -58,6 +59,7 @@ export default class CoreGenerator extends YeomanGenerator {
     static PROMPTING = asPriority(PROMPTING);
     static CONFIGURING = asPriority(CONFIGURING);
     static COMPOSING = asPriority(COMPOSING);
+    static COMPOSING_COMPONENT = asPriority(COMPOSING_COMPONENT);
     static LOADING = asPriority(LOADING);
     static PREPARING = asPriority(PREPARING);
     static POST_PREPARING = asPriority(POST_PREPARING);
@@ -149,6 +151,19 @@ export default class CoreGenerator extends YeomanGenerator {
         }
         return this._needleApi;
     }
+    /**
+     * JHipster config with default values fallback
+     */
+    get jhipsterConfigWithDefaults() {
+        const configWithDefaults = getConfigWithDefaults(removeFieldsWithNullishValues(this.config.getAll()));
+        defaults(configWithDefaults, {
+            skipFakeData: false,
+            skipCheckLengthOfIdentifier: false,
+            enableGradleEnterprise: false,
+            pages: [],
+        });
+        return configWithDefaults;
+    }
     /**
      * Warn or throws check failure based on current skipChecks option.
      * @param message
@@ -169,11 +184,14 @@ You can ignore this error by passing '--skip-checks' to jhipster command.`);
      */
     isJhipsterVersionLessThan(version) {
         const jhipsterOldVersion = this.sharedData.getControl().jhipsterOldVersion;
-        if (!jhipsterOldVersion) {
-            // if old version is unknown then can't compare (the project may be null) and return false
-            return false;
-        }
-        return semverLessThan(jhipsterOldVersion, version);
+        return this.isVersionLessThan(jhipsterOldVersion, version);
+    }
+    /**
+     * Wrapper for `semver.lt` to check if the oldVersion exists and is less than the newVersion.
+     * Can be used by blueprints.
+     */
+    isVersionLessThan(oldVersion, newVersion) {
+        return oldVersion ? semverLessThan(oldVersion, newVersion) : false;
     }
     /**
      * Get arguments for the priority
@@ -251,6 +269,19 @@ You can ignore this error by passing '--skip-checks' to jhipster command.`);
         }
         return this.prompt(this.prepareQuestions(generatorCommand.configs));
     }
+    /**
+     * Configure the current JHipster command.
+     * Blueprints with command override takes precedence.
+     */
+    async configureCurrentJHipsterCommandConfig() {
+        const generatorCommand = await this.getCurrentJHipsterCommand();
+        if (!generatorCommand.configs) {
+            throw new Error(`Configs not found for generator ${this.options.namespace}`);
+        }
+        for (const def of Object.values(generatorCommand.configs)) {
+            def.configure?.(this);
+        }
+    }
     /**
      * Load the current JHipster command storage configuration into the context.
      * Blueprints with command override takes precedence.
@@ -395,7 +426,7 @@ You can ignore this error by passing '--skip-checks' to jhipster command.`);
         return Object.entries(configs)
             .filter(([_name, def]) => def?.prompt)
             .map(([name, def]) => {
-            const promptSpec = typeof def.prompt === 'function' ? def.prompt(this) : { ...def.prompt };
+            const promptSpec = typeof def.prompt === 'function' ? def.prompt(this, def) : { ...def.prompt };
             let storage;
             if ((def.scope ?? 'storage') === 'storage') {
                 storage = this.config;

package/dist/generators/bootstrap-application-base/generator.js

@@ -140,15 +140,19 @@ export default class BootstrapApplicationBase extends BaseApplicationGenerator {
                     backendTypeJavaAny: ({ backendTypeSpringBoot }) => backendTypeSpringBoot,
                 });
             },
+            userRelationship({ applicationDefaults }) {
+                applicationDefaults({
+                    __override__: false,
+                    anyEntityHasRelationshipWithUser: this.getExistingEntities().some(entity => (entity.definition.relationships ?? []).some(relationship => relationship.otherEntityName.toLowerCase() === 'user')),
+                });
+            },
             syncUserWithIdp({ application, applicationDefaults }) {
                 if (!application.backendTypeSpringBoot)
                     return;
                 if (application.syncUserWithIdp === undefined && application.authenticationType === 'oauth2') {
                     applicationDefaults({
                         __override__: false,
-                        syncUserWithIdp: data => data.databaseType !== 'no' &&
-                            (data.applicationType === 'gateway' ||
-                                this.getExistingEntities().some(entity => (entity.definition.relationships ?? []).some(relationship => relationship.otherEntityName.toLowerCase() === 'user'))),
+                        syncUserWithIdp: data => data.databaseType !== 'no' && (data.applicationType === 'gateway' || data.anyEntityHasRelationshipWithUser),
                     });
                 }
                 else if (application.syncUserWithIdp && application.authenticationType !== 'oauth2') {

package/dist/generators/bootstrap-application-server/generator.js

@@ -71,6 +71,7 @@ export default class BoostrapApplicationServer extends BaseApplicationGenerator
                         ...applicationDockerContainers,
                         ...currentDockerContainers,
                     }),
+                    gatewayRoutes: undefined,
                 });
             },
         });

package/dist/generators/client/command.js

@@ -42,8 +42,8 @@ const command = {
             prompt: generator => ({
                 type: 'list',
                 message: () => generator.jhipsterConfigWithDefaults.applicationType === APPLICATION_TYPE_MICROSERVICE
-                    ? `Which ${chalk.yellow('*Framework*')} would you like to use as microfrontend?`
-                    : `Which ${chalk.yellow('*Framework*')} would you like to use for the client?`,
+                    ? `Which ${chalk.yellow('*framework*')} would you like to use as microfrontend?`
+                    : `Which ${chalk.yellow('*framework*')} would you like to use for the client?`,
             }),
             choices: [
                 { value: ANGULAR, name: 'Angular' },

package/dist/generators/client/generators/common/command.js

@@ -0,0 +1,5 @@
+const command = {
+    configs: {},
+    import: [],
+};
+export default command;

package/dist/generators/client/generators/common/generator.js

@@ -0,0 +1,79 @@
+/**
+ * Copyright 2013-2024 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import BaseApplicationGenerator from '../../../base-application/index.js';
+import { clientApplicationTemplatesBlock } from '../../support/index.js';
+export default class CommonGenerator extends BaseApplicationGenerator {
+    async beforeQueue() {
+        if (!this.fromBlueprint) {
+            await this.composeWithBlueprints();
+        }
+        if (!this.delegateToBlueprint) {
+            await this.dependsOnBootstrapApplication();
+        }
+    }
+    get initializing() {
+        return this.asInitializingTaskGroup({
+            async parseCommand() {
+                await this.parseCurrentJHipsterCommand();
+            },
+        });
+    }
+    get [BaseApplicationGenerator.INITIALIZING]() {
+        return this.delegateTasksToBlueprint(() => this.initializing);
+    }
+    get prompting() {
+        return this.asPromptingTaskGroup({
+            async promptCommand({ control }) {
+                if (control.existingProject && this.options.askAnswered !== true)
+                    return;
+                await this.promptCurrentJHipsterCommand();
+            },
+        });
+    }
+    get [BaseApplicationGenerator.PROMPTING]() {
+        return this.delegateTasksToBlueprint(() => this.prompting);
+    }
+    get loading() {
+        return this.asLoadingTaskGroup({
+            async loadConfig({ application }) {
+                await this.loadCurrentJHipsterCommandConfig(application);
+            },
+        });
+    }
+    get [BaseApplicationGenerator.LOADING]() {
+        return this.delegateTasksToBlueprint(() => this.loading);
+    }
+    get writing() {
+        return this.asWritingTaskGroup({
+            async writing({ application }) {
+                await this.writeFiles({
+                    blocks: [
+                        clientApplicationTemplatesBlock({
+                            templates: ['shared/jhipster/problem-details.ts', 'shared/jhipster/headers.ts'],
+                        }),
+                    ],
+                    context: application,
+                });
+            },
+        });
+    }
+    get [BaseApplicationGenerator.WRITING]() {
+        return this.delegateTasksToBlueprint(() => this.writing);
+    }
+}

package/dist/generators/client/generators/common/index.js

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2013-2024 the original author or authors from the JHipster project.
+ *
+ * This file is part of the JHipster project, see https://www.jhipster.tech/
+ * for more information.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export { default } from './generator.js';
+export { default as command } from './command.js';

package/dist/generators/client/generators/common/templates/src/main/webapp/app/shared/jhipster/headers.ts.ejs

@@ -0,0 +1,57 @@
+<%#
+ Copyright 2013-2024 the original author or authors from the JHipster project.
+
+ This file is part of the JHipster project, see https://www.jhipster.tech/
+ for more information.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-%>
+export type HeaderMessage = {
+  /** Success message */
+  alert?: string;
+  /** Error message */
+  error?: string;
+  /** Entity id for success messages. Entity name for error messages. */
+  param?: string;
+};
+
+const headerToString = (headerValue: any): string => {
+  if (Array.isArray(headerValue)) {
+    if (headerValue.length > 1) {
+      throw new Error('Multiple header values found');
+    }
+    headerValue = headerValue[0];
+  }
+  if (typeof headerValue !== 'string') {
+    throw new Error('Header value is not a string');
+  }
+  return headerValue;
+}
+
+const decodeHeaderValue = (headerValue: string): string => decodeURIComponent(headerValue.replace(/\+/g, ' '));
+
+export const getMessageFromHeaders = (headers: Record<string, any>): HeaderMessage => {
+  let alert: string | undefined = undefined;
+  let param: string | undefined = undefined;
+  let error: string | undefined = undefined;
+  for (const [key, value] of Object.entries(headers)) {
+    if (key.toLowerCase().endsWith('-alert')) {
+      alert = headerToString(value);
+    } else if (key.toLowerCase().endsWith('-error')) {
+      error = headerToString(value);
+    } else if (key.toLowerCase().endsWith('-params')) {
+      param = decodeHeaderValue(headerToString(value));
+    }
+  }
+  return { alert, error, param };
+};

package/dist/generators/client/generators/common/templates/src/main/webapp/app/shared/jhipster/problem-details.ts.ejs

@@ -0,0 +1,51 @@
+<%#
+ Copyright 2013-2024 the original author or authors from the JHipster project.
+
+ This file is part of the JHipster project, see https://www.jhipster.tech/
+ for more information.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+      https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-%>
+/**
+ * Problem details defined in RFC 7807.
+ * @see https://datatracker.ietf.org/doc/html/rfc7807#section-3.1
+ */
+export type ProblemDetails = {
+  /** A URI reference that identifies the problem type */
+  type: string;
+  /** A short, human-readable summary of the problem type */
+  title: string;
+  /** The HTTP status code */
+  status: number;
+  /** A human-readable explanation specific to this occurrence of the problem */
+  detail: string;
+  /** A URI reference that identifies the specific occurrence of the problem */
+  instance: string;
+}
+
+export const ProblemWithMessageType = 'https://www.jhipster.tech/problem/problem-with-message';
+
+export type FieldErrorVM = { message: string; objectName: string; field: string };
+
+export type ProblemWithMessage = ProblemDetails & {
+  type: typeof ProblemWithMessageType;
+
+  /** Translation message key */
+  message?: string;
+  /** Request path */
+  path?: string;
+  /** Field errors */
+  fieldErrors?: FieldErrorVM[];
+};
+
+export const isProblemWithMessage = (data: any): data is ProblemWithMessage => data?.type === ProblemWithMessageType;