generator-jhipster 8.7.0 → 8.7.2

package/dist/types/generators/base-application/types/entity.d.ts

@@ -1,139 +0,0 @@
-/**
- * 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 { SpringEntity } from '../../server/types.js';
-import Field from './field.js';
-import Relationship from './relationship.js';
-
-export type BaseEntity = {
-  name: string;
-  changelogDate?: string;
-  dto?: string;
-
-  primaryKey?: Record<string, any>;
-  fields?: Field[];
-  relationships?: Relationship[];
-
-  readOnly?: boolean;
-  embedded?: boolean;
-  skipClient?: boolean;
-  skipServer?: boolean;
-};
-
-type AngularEntity = {
-  entityAngularAuthorities?: string;
-  entityAngularReadAuthorities?: string;
-};
-
-type Entity = Required<BaseEntity> &
-  SpringEntity &
-  AngularEntity & {
-    builtIn?: boolean;
-    builtInUser?: boolean;
-    builtInAuthority?: boolean;
-    microserviceName?: string;
-    adminEntity?: boolean;
-    entityAuthority?: string;
-    entityReadAuthority?: string;
-    hasCyclicRequiredRelationship?: boolean;
-
-    entityNameCapitalized: string;
-    entityClass: string;
-    entityInstance: string;
-    entityTableName: string;
-    entityNamePlural: string;
-
-    dtoClass?: string;
-    dtoInstance?: string;
-
-    persistClass: string;
-    persistInstance: string;
-    restClass: string;
-    restInstance: string;
-
-    entityNamePluralizedAndSpinalCased: string;
-    entityClassPlural: string;
-    entityInstancePlural: string;
-
-    entityI18nVariant: string;
-    entityClassHumanized: string;
-    entityClassPluralHumanized: string;
-
-    entityFileName: string;
-    entityFolderName: string;
-    entityModelFileName: string;
-    entityParentPathAddition: string;
-    entityPluralFileName: string;
-    entityServiceFileName: string;
-
-    /** Generate only the model at client side for relationships. */
-    entityClientModelOnly?: boolean;
-    entityAngularName: string;
-    entityAngularNamePlural: string;
-    entityReactName: string;
-
-    entityApiUrl: string;
-    entityStateName: string;
-    entityUrl: string;
-
-    entityTranslationKey: string;
-    entityTranslationKeyMenu: string;
-
-    i18nKeyPrefix: string;
-    i18nAlertHeaderPrefix: string;
-
-    entityApi: string;
-    entityPage: string;
-
-    anyFieldIsBigDecimal: boolean;
-    /**
-     * Any file is of type Bytes or ByteBuffer
-     */
-    anyFieldIsBlobDerived: boolean;
-    /**
-     * Any field is of type ZonedDateTime, Instant or LocalDate
-     */
-    anyFieldIsDateDerived: boolean;
-    anyFieldIsDuration: boolean;
-    anyFieldIsInstant: boolean;
-    anyFieldIsLocalDate: boolean;
-    /**
-     * Any field is of type ZonedDateTime or Instant
-     */
-    anyFieldIsTimeDerived: boolean;
-    anyFieldIsUUID: boolean;
-    anyFieldIsZonedDateTime: boolean;
-
-    anyFieldHasDocumentation: boolean;
-    anyFieldHasImageContentType: boolean;
-    anyFieldHasTextContentType: boolean;
-    /**
-     * Any field has image or any contentType
-     */
-    anyFieldHasFileBasedContentType: boolean;
-
-    /**
-     * Any relationship is required or id
-     */
-    anyRelationshipIsRequired: boolean;
-
-    dtoMapstruct: boolean;
-  };
-
-export default Entity;

package/dist/types/generators/base-application/types/field.d.ts

@@ -1,27 +0,0 @@
-/**
- * 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.
- */
-
-type Field = {
-  fieldName: string;
-  fieldType: string;
-  fieldTypeBlobContent?: string;
-  propertyName: string;
-} & Record<string, any>;
-
-export default Field;

package/dist/types/generators/base-application/types/index.d.ts

@@ -1,22 +0,0 @@
-/**
- * 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 { default as Entity, BaseEntity } from './entity.js';
-export type { default as Field } from './field.js';
-export type { default as Relationship } from './relationship.js';

package/dist/types/generators/base-application/types/relationship.d.ts

@@ -1,30 +0,0 @@
-/**
- * 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.
- */
-
-type Relationship = {
-  relationshipName: string;
-  propertyName: string;
-  collection: boolean;
-  /**
-   * A persistable relationship means that the relationship will be updated in the database.
-   */
-  persistableRelationship: boolean;
-} & Record<string, any>;
-
-export default Relationship;

package/dist/types/generators/base-application/types.d.ts

@@ -1,162 +0,0 @@
-import CoreGenerator from '../base-core/generator.ts';
-import { ClientApplication } from '../client/types.js';
-import { I18nApplication } from '../languages/types.js';
-import { SpringBootApplication } from '../server/types.js';
-import { DeterministicOptionWithDerivedProperties, OptionWithDerivedProperties } from './application-options.js';
-
-export type BaseApplication = {
-  jhipsterVersion: string;
-  baseName: string;
-  capitalizedBaseName: string;
-  dasherizedBaseName: string;
-  humanizedBaseName: string;
-  camelizedBaseName: string;
-  hipster: string;
-  lowercaseBaseName: string;
-  upperFirstCamelCaseBaseName: string;
-  documentationArchiveUrl: string;
-
-  projectVersion: string;
-  projectDescription: string;
-
-  jhiPrefix: string;
-  entitySuffix: string;
-  dtoSuffix: string;
-
-  skipCommitHook: boolean;
-  skipJhipsterDependencies: boolean;
-  fakerSeed?: string;
-
-  nodeVersion: string;
-  nodePackageManager: string;
-  nodeDependencies: Record<string, string>;
-
-  skipClient?: boolean;
-  skipServer?: boolean;
-  monorepository?: boolean;
-
-  /** Customize templates sourceFile and destinationFile */
-  customizeTemplatePaths: ((
-    this: CoreGenerator,
-    file: {
-      namespace: string;
-      sourceFile: string;
-      resolvedSourceFile: string;
-      destinationFile: string;
-      templatesRoots: string[];
-    },
-    context: any,
-  ) => undefined | { sourceFile: string; resolvedSourceFile: string; destinationFile: string; templatesRoots: string[] })[];
-} & I18nApplication;
-
-/* ApplicationType Start */
-type MicroservicesArchitectureApplication = {
-  microfrontend: boolean;
-  gatewayServerPort: number;
-};
-
-type GatewayApplication = MicroservicesArchitectureApplication & {
-  microfrontends: string[];
-};
-
-type ApplicationType = DeterministicOptionWithDerivedProperties<
-  'applicationType',
-  ['monolith', 'gateway', 'microservice'],
-  [Record<string, never>, GatewayApplication, MicroservicesArchitectureApplication]
->;
-
-/* ApplicationType End */
-
-/* AuthenticationType Start */
-type UserManagement =
-  | {
-      skipUserManagement: true;
-      generateUserManagement: false;
-      generateBuiltInUserEntity?: false;
-      generateBuiltInAuthorityEntity: false;
-    }
-  | {
-      skipUserManagement: false;
-      generateBuiltInUserEntity?: boolean;
-      generateUserManagement: true;
-      user: any;
-      userManagement: any;
-      generateBuiltInAuthorityEntity: boolean;
-      authority: any;
-    };
-
-type JwtApplication = UserManagement & {
-  jwtSecretKey: string;
-};
-
-type Oauth2Application = {
-  jwtSecretKey: string;
-  generateBuiltInUserEntity?: boolean;
-  user: any;
-  generateBuiltInAuthorityEntity: false;
-  generateUserManagement: false;
-};
-
-type SessionApplication = UserManagement & {
-  rememberMeKey: string;
-};
-
-type AuthenticationType = DeterministicOptionWithDerivedProperties<
-  'authenticationType',
-  ['jwt', 'oauth2', 'session'],
-  [JwtApplication, Oauth2Application, SessionApplication]
->;
-
-/* AuthenticationType End */
-
-type QuirksApplication = {
-  cypressBootstrapEntities?: boolean;
-};
-
-export type CommonClientServerApplication = BaseApplication &
-  QuirksApplication &
-  AuthenticationType &
-  SpringBootApplication &
-  ClientApplication &
-  ApplicationType & {
-    clientRootDir: string;
-    clientSrcDir: string;
-    clientTestDir?: string;
-    clientDistDir?: string;
-    devServerPort: number;
-    pages: string[];
-
-    serverPort: number;
-    backendType?: string;
-    backendTypeJavaAny?: boolean;
-    backendTypeSpringBoot?: boolean;
-    temporaryDir?: string;
-
-    hipsterName?: string;
-    hipsterProductName?: string;
-    hipsterHomePageProductName?: string;
-    hipsterStackOverflowProductName?: string;
-    hipsterBugTrackerProductName?: string;
-    hipsterChatProductName?: string;
-    hipsterTwitterUsername?: string;
-    hipsterDocumentationLink?: string;
-    hipsterTwitterLink?: string;
-    hipsterProjectLink?: string;
-    hipsterStackoverflowLink?: string;
-    hipsterBugTrackerLink?: string;
-    hipsterChatLink?: string;
-
-    dockerServicesDir?: string;
-    dockerServices?: string[];
-    prettierExtensions?: string;
-
-    skipUserManagement?: boolean;
-    syncUserWithIdp?: boolean;
-    generateUserManagement?: boolean;
-  };
-
-type ServiceDiscoveryApplication = OptionWithDerivedProperties<'serviceDiscoveryType', ['no', 'eureka', 'consul']>;
-
-type MonitoringApplication = OptionWithDerivedProperties<'monitoring', ['no', 'elk', 'prometheus']>;
-
-export type PlatformApplication = ServiceDiscoveryApplication & MonitoringApplication;

package/dist/types/generators/base-core/generator.d.ts

@@ -1,267 +0,0 @@
-import { GeneratorMeta } from '@yeoman/types';
-import type { CopyOptions } from 'mem-fs-editor';
-import type { Data as TemplateData, Options as TemplateOptions } from 'ejs';
-import YeomanGenerator, { type ComposeOptions, type Storage } from 'yeoman-generator';
-import type Environment from 'yeoman-environment';
-import SharedData from '../base/shared-data.js';
-import { Logger } from '../base/support/index.js';
-import type { CascatedEditFileCallback, EditFileCallback, EditFileOptions, JHipsterArguments, JHipsterCommandDefinition, JHipsterConfigs, JHipsterGeneratorFeatures, JHipsterGeneratorOptions, JHipsterOptions, ValidationResult, WriteFileOptions } from '../base/api.js';
-import { CommonClientServerApplication } from '../base-application/types.js';
-import NeedleApi from '../needle-api.js';
-/**
- * This is the base class for a generator for every generator.
- */
-export default class CoreGenerator extends YeomanGenerator<JHipsterGeneratorOptions, JHipsterGeneratorFeatures> {
-    static asPriority: (priorityName: string) => string;
-    static INITIALIZING: string;
-    static PROMPTING: string;
-    static CONFIGURING: string;
-    static COMPOSING: string;
-    static COMPOSING_COMPONENT: string;
-    static LOADING: string;
-    static PREPARING: string;
-    static POST_PREPARING: string;
-    static DEFAULT: string;
-    static WRITING: string;
-    static POST_WRITING: string;
-    static INSTALL: string;
-    static POST_INSTALL: string;
-    static END: string;
-    useVersionPlaceholders?: boolean;
-    skipChecks?: boolean;
-    ignoreNeedlesError?: boolean;
-    experimental?: boolean;
-    debugEnabled?: boolean;
-    jhipster7Migration?: boolean | 'verbose' | 'silent';
-    relativeDir: (from: string, to: string) => string;
-    relative: (from: string, to: string) => string;
-    readonly sharedData: SharedData<CommonClientServerApplication>;
-    readonly logger: Logger;
-    jhipsterConfig: Record<string, any>;
-    /**
-     * @deprecated
-     */
-    jhipsterTemplatesFolders: string[];
-    blueprintStorage?: Storage;
-    /** Allow to use a specific definition at current command operations */
-    generatorCommand?: JHipsterCommandDefinition;
-    /**
-     * @experimental
-     * Additional commands to be considered
-     */
-    generatorsToCompose: string[];
-    private _jhipsterGenerator?;
-    private _needleApi?;
-    env: Environment;
-    log: Logger;
-    _meta?: GeneratorMeta;
-    constructor(args: string | string[], options: JHipsterGeneratorOptions, features: JHipsterGeneratorFeatures);
-    /**
-     * Override yeoman generator's usage function to fine tune --help message.
-     */
-    usage(): string;
-    /**
-     * @deprecated
-     */
-    get needleApi(): NeedleApi;
-    /**
-     * JHipster config with default values fallback
-     */
-    get jhipsterConfigWithDefaults(): any;
-    /**
-     * Warn or throws check failure based on current skipChecks option.
-     * @param message
-     */
-    handleCheckFailure(message: string): void;
-    /**
-     * Check if the JHipster version used to generate an existing project is less than the passed version argument
-     *
-     * @param {string} version - A valid semver version string
-     */
-    isJhipsterVersionLessThan(version: any): any;
-    /**
-     * Wrapper for `semver.lt` to check if the oldVersion exists and is less than the newVersion.
-     * Can be used by blueprints.
-     */
-    isVersionLessThan(oldVersion: string | null, newVersion: string): any;
-    /**
-     * Get arguments for the priority
-     */
-    getArgsForPriority(priorityName: string): {
-        control: import("../base/types.js").Control;
-        source: any;
-    }[] | {
-        control: import("../base/types.js").Control;
-        configChanges: {
-            [k: string]: {
-                newValue: any;
-                oldValue: any;
-            };
-        };
-    }[] | {
-        control: import("../base/types.js").Control;
-    }[];
-    /**
-     * Check if the generator should ask for prompts.
-     */
-    shouldAskForPrompts({ control }: {
-        control: any;
-    }): boolean;
-    /**
-     * Override yeoman-generator method that gets methods to be queued, filtering the result.
-     */
-    getTaskNames(): string[];
-    queueCurrentJHipsterCommandTasks(): void;
-    /**
-     * Get the current Command Definition for the generator.
-     * `generatorCommand` takes precedence.
-     */
-    getCurrentJHipsterCommand(): Promise<JHipsterCommandDefinition>;
-    /**
-     * Parse command definition arguments, options and configs.
-     * Blueprints with command override takes precedence.
-     */
-    parseCurrentJHipsterCommand(): Promise<void>;
-    /**
-     * Prompts for command definition configs.
-     * Blueprints with command override takes precedence.
-     */
-    promptCurrentJHipsterCommand(): Promise<any>;
-    /**
-     * Configure the current JHipster command.
-     * Blueprints with command override takes precedence.
-     */
-    configureCurrentJHipsterCommandConfig(): Promise<void>;
-    /**
-     * Load the current JHipster command storage configuration into the context.
-     * Blueprints with command override takes precedence.
-     */
-    loadCurrentJHipsterCommandConfig(context: any): Promise<void>;
-    /**
-     * @experimental
-     * Compose the current JHipster command compose.
-     * Blueprints commands compose without generators will be composed.
-     */
-    composeCurrentJHipsterCommand(): Promise<void>;
-    parseJHipsterCommand(commandDef: JHipsterCommandDefinition): void;
-    parseJHipsterOptions(options: JHipsterOptions | undefined, configs?: JHipsterConfigs | boolean, common?: boolean): void;
-    parseJHipsterArguments(jhipsterArguments?: JHipsterArguments): void;
-    prepareQuestions(configs?: JHipsterConfigs): {
-        storage: any;
-        type?: "input" | "list" | "checkbox" | "confirm" | undefined;
-        message?: string | ((any: any) => string) | undefined;
-        when?: boolean | ((any: any) => boolean) | undefined;
-        default?: any;
-        filter?: any;
-        transformer?: any;
-        validate?: any;
-        name: string;
-        choices: import("../base/api.js").JHispterChoices | undefined;
-    }[];
-    /**
-     * Generate a date to be used by Liquibase changelogs.
-     *
-     * @param {Boolean} [reproducible=true] - Set true if the changelog date can be reproducible.
-     *                                 Set false to create a changelog date incrementing the last one.
-     * @return {String} Changelog date.
-     */
-    dateFormatForLiquibase(reproducible?: boolean): string;
-    /**
-     * Alternative templatePath that fetches from the blueprinted generator, instead of the blueprint.
-     */
-    jhipsterTemplatePath(...path: string[]): string;
-    /**
-     * Compose with a jhipster generator using default jhipster config.
-     * @return {object} the composed generator
-     */
-    composeWithJHipster(generator: string, options?: ComposeOptions): Promise<import("@yeoman/types").BaseGenerator[]>;
-    /**
-     * Compose with a jhipster generator using default jhipster config, but queue it immediately.
-     */
-    dependsOnJHipster(generator: string, options?: ComposeOptions): Promise<import("@yeoman/types").BaseGenerator[]>;
-    /**
-     * Remove File
-     * @param file
-     */
-    removeFile(...path: string[]): string;
-    /**
-     * Remove Folder
-     * @param path
-     */
-    removeFolder(...path: string[]): void;
-    /**
-     * Fetch files from the generator-jhipster instance installed
-     */
-    fetchFromInstalledJHipster(...path: string[]): string;
-    /**
-     * Utility function to write file.
-     *
-     * @param source
-     * @param destination - destination
-     * @param data - template data
-     * @param options - options passed to ejs render
-     * @param copyOptions
-     */
-    writeFile(source: string, destination: string, data?: TemplateData, options?: TemplateOptions, copyOptions?: CopyOptions): void;
-    /**
-     * write the given files using provided options.
-     */
-    writeFiles<DataType = any>(options: WriteFileOptions<this, DataType>): Promise<string[]>;
-    /**
-     * Edit file content.
-     * Edits an empty file if `options.create` is truthy or no callback is passed.
-     * @example
-     * // Throws if `foo.txt` doesn't exists or append the content.
-     * editFile('foo.txt', content => content + 'foo.txt content');
-     * @example
-     * // Appends `foo.txt` content if whether exists or not.
-     * editFile('foo.txt', { create: true }, content => content + 'foo.txt content');
-     * @example
-     * // Appends `foo.txt` content if whether exists or not using the returned cascaded callback.
-     * editFile('foo.txt')(content => content + 'foo.txt content');
-     */
-    editFile(file: string, ...transformCallbacks: EditFileCallback<this>[]): CascatedEditFileCallback<this>;
-    editFile(file: string, options: EditFileOptions, ...transformCallbacks: EditFileCallback<this>[]): CascatedEditFileCallback<this>;
-    /**
-     * Convert value to a yaml and write to destination
-     */
-    writeDestinationYaml(filepath: string, value: Record<string | number, any>): void;
-    /**
-     * Merge value to an existing yaml and write to destination
-     * Removes every comment (due to parsing/merging process) except the at the top of the file.
-     */
-    mergeDestinationYaml(filepath: string, value: Record<string | number, any>): void;
-    /**
-     * Merge value to an existing json and write to destination
-     */
-    mergeDestinationJson(filepath: string, value: Record<string | number, any>): void;
-    /**
-     * Shallow clone or convert dependencies to placeholder if needed.
-     */
-    prepareDependencies(map: Record<string, string>, valuePlaceholder?: 'java' | 'docker' | ((value: string) => string)): Record<string, string>;
-    loadNodeDependencies(destination: Record<string, string>, source: Record<string, string>): void;
-    /**
-     * Load Java dependencies from a gradle catalog file.
-     * @param javaDependencies
-     * @param gradleCatalog Gradle catalog file path, true for generator-jhipster's generator catalog of falsy for blueprint catalog
-     */
-    loadJavaDependenciesFromGradleCatalog(javaDependencies: Record<string, string>, gradleCatalog?: string | boolean): void;
-    loadNodeDependenciesFromPackageJson(destination: Record<string, string>, packageJsonFile?: string): void;
-    /**
-     * Print ValidationResult info/warnings or throw result Error.
-     */
-    validateResult(result: ValidationResult, { throwOnError }?: {
-        throwOnError?: boolean | undefined;
-    }): void;
-    /**
-     * Checks if there is a newer JHipster version available.
-     */
-    protected checkForNewVersion(): Promise<void>;
-    /**
-     * Create a simple-git instance using current destinationPath as baseDir.
-     */
-    createGit(): import("simple-git").SimpleGit;
-    private calculateApplicationId;
-    protected getSharedApplication(applicationFolder?: string): any;
-    private createSharedData;
-}

package/dist/types/generators/bootstrap/support/eslint-transform.d.ts

@@ -1,23 +0,0 @@
-import { Piscina } from 'piscina';
-import BaseGenerator from '../../base-core/index.js';
-type PoolOptions = Exclude<ConstructorParameters<typeof Piscina>[0], undefined>;
-type ESLintWorkerOptions = {
-    cwd?: string;
-    extensions: string;
-    recreateEslint?: boolean;
-};
-export declare class ESLintPool extends Piscina {
-    constructor(options?: PoolOptions);
-    apply(data: ESLintWorkerOptions & {
-        filePath: string;
-        fileContents: string;
-    }): Promise<{
-        result: string;
-        error: string;
-    }>;
-}
-export declare const createESLintTransform: (this: BaseGenerator | void, transformOptions?: {
-    ignoreErrors?: boolean;
-    poolOptions?: PoolOptions;
-} & Partial<ESLintWorkerOptions>) => import("p-transform").DuplexWithDebug;
-export {};

package/dist/types/generators/bootstrap/support/force-write-config-files-transform.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-declare const createForceWriteConfigFilesTransform: () => import("stream").Transform;
-export default createForceWriteConfigFilesTransform;

package/dist/types/generators/bootstrap/support/multi-step-transform/index.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-import TemplateFileFs from './template-file-fs.js';
-export declare const createMultiStepTransform: () => import("stream").Duplex & {
-    enableDebug: () => import("stream").Duplex;
-} & {
-    templateFileFs: TemplateFileFs;
-};