gen-jhipster/dist/generators/react/entity-files-react.d.ts

VHipster - Spring Boot + Angular/React/Vue in one handy generator

import type { Application as ClientApplication, Entity as ClientEntity } from '../client/types.ts';
export declare const reactFiles: import("../base-core/api.js").WriteFileSection<ClientApplication>;
export declare const writeEntitiesFiles: (this: import("../index.ts").GeneratorBaseCore<import("../base-core/types.js").Config, import("../base-core/types.js").Options, import("../base-core/types.js").Features>, params: import("../base-application/tasks.js").TaskParamWithEntities<ClientEntity<({
    propertyName: string;
    propertyNameCapitalized?: string;
    propertyNameUpperSnakeCase?: string;
    propertyApiDescription?: string;
    skipClient?: boolean;
    skipServer?: boolean;
} & Omit<import("../../lib/jhipster/types/field.js").Field, "fieldType"> & {
    fieldTypeBlob: boolean;
    fieldTypeString: boolean;
    fieldTypeInteger: boolean;
    fieldTypeLong: boolean;
    fieldTypeBigDecimal: boolean;
    fieldTypeFloat: boolean;
    fieldTypeDouble: boolean;
    fieldTypeUUID: boolean;
    fieldTypeBoolean: boolean;
    fieldTypeLocalDate: boolean;
    fieldTypeZonedDateTime: boolean;
    fieldTypeAnyBlob: boolean;
    fieldTypeImageBlob: boolean;
    fieldTypeTextBlob: boolean;
    fieldTypeInstant: boolean;
    fieldTypeDuration: boolean;
    fieldTypeByte: boolean;
    fieldTypeByteBuffer: boolean;
    fieldTypeLocalTime: boolean;
} & {
    fieldValidationMin: boolean;
    fieldValidationRequired: boolean;
    fieldValidationPattern: boolean;
    fieldValidationMax: boolean;
    fieldValidationUnique: boolean;
    fieldValidationMinlength: boolean;
    fieldValidationMaxlength: boolean;
    fieldValidationMinbytes: boolean;
    fieldValidationMaxbytes: boolean;
} & {
    path?: string[];
    fieldNameCapitalized: string;
    fieldNameHumanized: string;
    fieldNameUnderscored: string;
    fieldTranslationKey?: string;
    propertyTranslationKey?: string;
    fieldApiDescription?: string;
    enumFileName?: string;
    enumValues?: {
        name: string;
        value: string;
    }[];
    fieldValidate?: boolean;
    unique?: boolean;
    maxlength?: number;
    fakerTemplate?: string;
    uniqueValue?: any[];
    generateFakeDataFromPattern?: () => string | undefined;
    generateFakeData?: (type?: "csv" | "cypress" | "json-serializable" | "ts") => any;
    transient?: boolean;
    id?: boolean;
    autoGenerate?: boolean;
    readonly?: boolean;
    sequenceGeneratorName?: string;
    fieldWithContentType?: boolean;
    contentTypeFieldName?: string;
    fieldTypeTimed?: boolean;
    blobContentTypeText?: boolean;
    blobContentTypeImage?: boolean;
    blobContentTypeAny?: boolean;
    fieldTypeBytes?: boolean;
    fieldTypeBinary?: boolean;
    fieldValidationMinLength: boolean;
    fieldValidationMaxLength: boolean;
    fieldValidationMinBytes: boolean;
    fieldValidationMaxBytes: boolean;
    relatedByOtherEntity?: boolean;
    enumInstance?: string;
    builtIn?: boolean;
    derivedPath?: string[];
} & {
    fieldType: string;
    fieldIsEnum: true;
} & {
    fieldTypeTemporal: boolean;
    fieldTypeCharSequence: boolean;
    fieldTypeNumeric: boolean;
    fieldSupportsSortBy?: boolean;
} & {
    tsType: string;
    hidden?: boolean;
    hideListView?: boolean;
}) | ({
    propertyName: string;
    propertyNameCapitalized?: string;
    propertyNameUpperSnakeCase?: string;
    propertyApiDescription?: string;
    skipClient?: boolean;
    skipServer?: boolean;
} & Omit<import("../../lib/jhipster/types/field.js").Field, "fieldType"> & {
    fieldTypeBlob: boolean;
    fieldTypeString: boolean;
    fieldTypeInteger: boolean;
    fieldTypeLong: boolean;
    fieldTypeBigDecimal: boolean;
    fieldTypeFloat: boolean;
    fieldTypeDouble: boolean;
    fieldTypeUUID: boolean;
    fieldTypeBoolean: boolean;
    fieldTypeLocalDate: boolean;
    fieldTypeZonedDateTime: boolean;
    fieldTypeAnyBlob: boolean;
    fieldTypeImageBlob: boolean;
    fieldTypeTextBlob: boolean;
    fieldTypeInstant: boolean;
    fieldTypeDuration: boolean;
    fieldTypeByte: boolean;
    fieldTypeByteBuffer: boolean;
    fieldTypeLocalTime: boolean;
} & {
    fieldValidationMin: boolean;
    fieldValidationRequired: boolean;
    fieldValidationPattern: boolean;
    fieldValidationMax: boolean;
    fieldValidationUnique: boolean;
    fieldValidationMinlength: boolean;
    fieldValidationMaxlength: boolean;
    fieldValidationMinbytes: boolean;
    fieldValidationMaxbytes: boolean;
} & {
    path?: string[];
    fieldNameCapitalized: string;
    fieldNameHumanized: string;
    fieldNameUnderscored: string;
    fieldTranslationKey?: string;
    propertyTranslationKey?: string;
    fieldApiDescription?: string;
    enumFileName?: string;
    enumValues?: {
        name: string;
        value: string;
    }[];
    fieldValidate?: boolean;
    unique?: boolean;
    maxlength?: number;
    fakerTemplate?: string;
    uniqueValue?: any[];
    generateFakeDataFromPattern?: () => string | undefined;
    generateFakeData?: (type?: "csv" | "cypress" | "json-serializable" | "ts") => any;
    transient?: boolean;
    id?: boolean;
    autoGenerate?: boolean;
    readonly?: boolean;
    sequenceGeneratorName?: string;
    fieldWithContentType?: boolean;
    contentTypeFieldName?: string;
    fieldTypeTimed?: boolean;
    blobContentTypeText?: boolean;
    blobContentTypeImage?: boolean;
    blobContentTypeAny?: boolean;
    fieldTypeBytes?: boolean;
    fieldTypeBinary?: boolean;
    fieldValidationMinLength: boolean;
    fieldValidationMaxLength: boolean;
    fieldValidationMinBytes: boolean;
    fieldValidationMaxBytes: boolean;
    relatedByOtherEntity?: boolean;
    enumInstance?: string;
    builtIn?: boolean;
    derivedPath?: string[];
} & {
    fieldType: import("../../lib/jhipster/field-types.ts").FieldType;
    fieldIsEnum: false;
} & {
    fieldTypeTemporal: boolean;
    fieldTypeCharSequence: boolean;
    fieldTypeNumeric: boolean;
    fieldSupportsSortBy?: boolean;
} & {
    tsType: string;
    hidden?: boolean;
    hideListView?: boolean;
}), import("../base-application/entity.ts").Relationship>, ClientApplication>) => void;
export declare const postWriteEntitiesFiles: (this: import("../index.ts").GeneratorBaseCore<import("../base-core/types.js").Config, import("../base-core/types.js").Options, import("../base-core/types.js").Features>, params: import("../base-application/tasks.js").PostWritingEntitiesTaskParam<ClientEntity<({
    propertyName: string;
    propertyNameCapitalized?: string;
    propertyNameUpperSnakeCase?: string;
    propertyApiDescription?: string;
    skipClient?: boolean;
    skipServer?: boolean;
} & Omit<import("../../lib/jhipster/types/field.js").Field, "fieldType"> & {
    fieldTypeBlob: boolean;
    fieldTypeString: boolean;
    fieldTypeInteger: boolean;
    fieldTypeLong: boolean;
    fieldTypeBigDecimal: boolean;
    fieldTypeFloat: boolean;
    fieldTypeDouble: boolean;
    fieldTypeUUID: boolean;
    fieldTypeBoolean: boolean;
    fieldTypeLocalDate: boolean;
    fieldTypeZonedDateTime: boolean;
    fieldTypeAnyBlob: boolean;
    fieldTypeImageBlob: boolean;
    fieldTypeTextBlob: boolean;
    fieldTypeInstant: boolean;
    fieldTypeDuration: boolean;
    fieldTypeByte: boolean;
    fieldTypeByteBuffer: boolean;
    fieldTypeLocalTime: boolean;
} & {
    fieldValidationMin: boolean;
    fieldValidationRequired: boolean;
    fieldValidationPattern: boolean;
    fieldValidationMax: boolean;
    fieldValidationUnique: boolean;
    fieldValidationMinlength: boolean;
    fieldValidationMaxlength: boolean;
    fieldValidationMinbytes: boolean;
    fieldValidationMaxbytes: boolean;
} & {
    path?: string[];
    fieldNameCapitalized: string;
    fieldNameHumanized: string;
    fieldNameUnderscored: string;
    fieldTranslationKey?: string;
    propertyTranslationKey?: string;
    fieldApiDescription?: string;
    enumFileName?: string;
    enumValues?: {
        name: string;
        value: string;
    }[];
    fieldValidate?: boolean;
    unique?: boolean;
    maxlength?: number;
    fakerTemplate?: string;
    uniqueValue?: any[];
    generateFakeDataFromPattern?: () => string | undefined;
    generateFakeData?: (type?: "csv" | "cypress" | "json-serializable" | "ts") => any;
    transient?: boolean;
    id?: boolean;
    autoGenerate?: boolean;
    readonly?: boolean;
    sequenceGeneratorName?: string;
    fieldWithContentType?: boolean;
    contentTypeFieldName?: string;
    fieldTypeTimed?: boolean;
    blobContentTypeText?: boolean;
    blobContentTypeImage?: boolean;
    blobContentTypeAny?: boolean;
    fieldTypeBytes?: boolean;
    fieldTypeBinary?: boolean;
    fieldValidationMinLength: boolean;
    fieldValidationMaxLength: boolean;
    fieldValidationMinBytes: boolean;
    fieldValidationMaxBytes: boolean;
    relatedByOtherEntity?: boolean;
    enumInstance?: string;
    builtIn?: boolean;
    derivedPath?: string[];
} & {
    fieldType: string;
    fieldIsEnum: true;
} & {
    fieldTypeTemporal: boolean;
    fieldTypeCharSequence: boolean;
    fieldTypeNumeric: boolean;
    fieldSupportsSortBy?: boolean;
} & {
    tsType: string;
    hidden?: boolean;
    hideListView?: boolean;
}) | ({
    propertyName: string;
    propertyNameCapitalized?: string;
    propertyNameUpperSnakeCase?: string;
    propertyApiDescription?: string;
    skipClient?: boolean;
    skipServer?: boolean;
} & Omit<import("../../lib/jhipster/types/field.js").Field, "fieldType"> & {
    fieldTypeBlob: boolean;
    fieldTypeString: boolean;
    fieldTypeInteger: boolean;
    fieldTypeLong: boolean;
    fieldTypeBigDecimal: boolean;
    fieldTypeFloat: boolean;
    fieldTypeDouble: boolean;
    fieldTypeUUID: boolean;
    fieldTypeBoolean: boolean;
    fieldTypeLocalDate: boolean;
    fieldTypeZonedDateTime: boolean;
    fieldTypeAnyBlob: boolean;
    fieldTypeImageBlob: boolean;
    fieldTypeTextBlob: boolean;
    fieldTypeInstant: boolean;
    fieldTypeDuration: boolean;
    fieldTypeByte: boolean;
    fieldTypeByteBuffer: boolean;
    fieldTypeLocalTime: boolean;
} & {
    fieldValidationMin: boolean;
    fieldValidationRequired: boolean;
    fieldValidationPattern: boolean;
    fieldValidationMax: boolean;
    fieldValidationUnique: boolean;
    fieldValidationMinlength: boolean;
    fieldValidationMaxlength: boolean;
    fieldValidationMinbytes: boolean;
    fieldValidationMaxbytes: boolean;
} & {
    path?: string[];
    fieldNameCapitalized: string;
    fieldNameHumanized: string;
    fieldNameUnderscored: string;
    fieldTranslationKey?: string;
    propertyTranslationKey?: string;
    fieldApiDescription?: string;
    enumFileName?: string;
    enumValues?: {
        name: string;
        value: string;
    }[];
    fieldValidate?: boolean;
    unique?: boolean;
    maxlength?: number;
    fakerTemplate?: string;
    uniqueValue?: any[];
    generateFakeDataFromPattern?: () => string | undefined;
    generateFakeData?: (type?: "csv" | "cypress" | "json-serializable" | "ts") => any;
    transient?: boolean;
    id?: boolean;
    autoGenerate?: boolean;
    readonly?: boolean;
    sequenceGeneratorName?: string;
    fieldWithContentType?: boolean;
    contentTypeFieldName?: string;
    fieldTypeTimed?: boolean;
    blobContentTypeText?: boolean;
    blobContentTypeImage?: boolean;
    blobContentTypeAny?: boolean;
    fieldTypeBytes?: boolean;
    fieldTypeBinary?: boolean;
    fieldValidationMinLength: boolean;
    fieldValidationMaxLength: boolean;
    fieldValidationMinBytes: boolean;
    fieldValidationMaxBytes: boolean;
    relatedByOtherEntity?: boolean;
    enumInstance?: string;
    builtIn?: boolean;
    derivedPath?: string[];
} & {
    fieldType: import("../../lib/jhipster/field-types.ts").FieldType;
    fieldIsEnum: false;
} & {
    fieldTypeTemporal: boolean;
    fieldTypeCharSequence: boolean;
    fieldTypeNumeric: boolean;
    fieldSupportsSortBy?: boolean;
} & {
    tsType: string;
    hidden?: boolean;
    hideListView?: boolean;
}), import("../base-application/entity.ts").Relationship>, ClientApplication, import("../../lib/types/source-all.js").SourceAll>) => void;
export declare const cleanupEntitiesFiles: (this: import("../index.ts").GeneratorBaseCore<import("../base-core/types.js").Config, import("../base-core/types.js").Options, import("../base-core/types.js").Features>, params: import("../base-application/tasks.js").TaskParamWithEntities<ClientEntity<({
    propertyName: string;
    propertyNameCapitalized?: string;
    propertyNameUpperSnakeCase?: string;
    propertyApiDescription?: string;
    skipClient?: boolean;
    skipServer?: boolean;
} & Omit<import("../../lib/jhipster/types/field.js").Field, "fieldType"> & {
    fieldTypeBlob: boolean;
    fieldTypeString: boolean;
    fieldTypeInteger: boolean;
    fieldTypeLong: boolean;
    fieldTypeBigDecimal: boolean;
    fieldTypeFloat: boolean;
    fieldTypeDouble: boolean;
    fieldTypeUUID: boolean;
    fieldTypeBoolean: boolean;
    fieldTypeLocalDate: boolean;
    fieldTypeZonedDateTime: boolean;
    fieldTypeAnyBlob: boolean;
    fieldTypeImageBlob: boolean;
    fieldTypeTextBlob: boolean;
    fieldTypeInstant: boolean;
    fieldTypeDuration: boolean;
    fieldTypeByte: boolean;
    fieldTypeByteBuffer: boolean;
    fieldTypeLocalTime: boolean;
} & {
    fieldValidationMin: boolean;
    fieldValidationRequired: boolean;
    fieldValidationPattern: boolean;
    fieldValidationMax: boolean;
    fieldValidationUnique: boolean;
    fieldValidationMinlength: boolean;
    fieldValidationMaxlength: boolean;
    fieldValidationMinbytes: boolean;
    fieldValidationMaxbytes: boolean;
} & {
    path?: string[];
    fieldNameCapitalized: string;
    fieldNameHumanized: string;
    fieldNameUnderscored: string;
    fieldTranslationKey?: string;
    propertyTranslationKey?: string;
    fieldApiDescription?: string;
    enumFileName?: string;
    enumValues?: {
        name: string;
        value: string;
    }[];
    fieldValidate?: boolean;
    unique?: boolean;
    maxlength?: number;
    fakerTemplate?: string;
    uniqueValue?: any[];
    generateFakeDataFromPattern?: () => string | undefined;
    generateFakeData?: (type?: "csv" | "cypress" | "json-serializable" | "ts") => any;
    transient?: boolean;
    id?: boolean;
    autoGenerate?: boolean;
    readonly?: boolean;
    sequenceGeneratorName?: string;
    fieldWithContentType?: boolean;
    contentTypeFieldName?: string;
    fieldTypeTimed?: boolean;
    blobContentTypeText?: boolean;
    blobContentTypeImage?: boolean;
    blobContentTypeAny?: boolean;
    fieldTypeBytes?: boolean;
    fieldTypeBinary?: boolean;
    fieldValidationMinLength: boolean;
    fieldValidationMaxLength: boolean;
    fieldValidationMinBytes: boolean;
    fieldValidationMaxBytes: boolean;
    relatedByOtherEntity?: boolean;
    enumInstance?: string;
    builtIn?: boolean;
    derivedPath?: string[];
} & {
    fieldType: string;
    fieldIsEnum: true;
} & {
    fieldTypeTemporal: boolean;
    fieldTypeCharSequence: boolean;
    fieldTypeNumeric: boolean;
    fieldSupportsSortBy?: boolean;
} & {
    tsType: string;
    hidden?: boolean;
    hideListView?: boolean;
}) | ({
    propertyName: string;
    propertyNameCapitalized?: string;
    propertyNameUpperSnakeCase?: string;
    propertyApiDescription?: string;
    skipClient?: boolean;
    skipServer?: boolean;
} & Omit<import("../../lib/jhipster/types/field.js").Field, "fieldType"> & {
    fieldTypeBlob: boolean;
    fieldTypeString: boolean;
    fieldTypeInteger: boolean;
    fieldTypeLong: boolean;
    fieldTypeBigDecimal: boolean;
    fieldTypeFloat: boolean;
    fieldTypeDouble: boolean;
    fieldTypeUUID: boolean;
    fieldTypeBoolean: boolean;
    fieldTypeLocalDate: boolean;
    fieldTypeZonedDateTime: boolean;
    fieldTypeAnyBlob: boolean;
    fieldTypeImageBlob: boolean;
    fieldTypeTextBlob: boolean;
    fieldTypeInstant: boolean;
    fieldTypeDuration: boolean;
    fieldTypeByte: boolean;
    fieldTypeByteBuffer: boolean;
    fieldTypeLocalTime: boolean;
} & {
    fieldValidationMin: boolean;
    fieldValidationRequired: boolean;
    fieldValidationPattern: boolean;
    fieldValidationMax: boolean;
    fieldValidationUnique: boolean;
    fieldValidationMinlength: boolean;
    fieldValidationMaxlength: boolean;
    fieldValidationMinbytes: boolean;
    fieldValidationMaxbytes: boolean;
} & {
    path?: string[];
    fieldNameCapitalized: string;
    fieldNameHumanized: string;
    fieldNameUnderscored: string;
    fieldTranslationKey?: string;
    propertyTranslationKey?: string;
    fieldApiDescription?: string;
    enumFileName?: string;
    enumValues?: {
        name: string;
        value: string;
    }[];
    fieldValidate?: boolean;
    unique?: boolean;
    maxlength?: number;
    fakerTemplate?: string;
    uniqueValue?: any[];
    generateFakeDataFromPattern?: () => string | undefined;
    generateFakeData?: (type?: "csv" | "cypress" | "json-serializable" | "ts") => any;
    transient?: boolean;
    id?: boolean;
    autoGenerate?: boolean;
    readonly?: boolean;
    sequenceGeneratorName?: string;
    fieldWithContentType?: boolean;
    contentTypeFieldName?: string;
    fieldTypeTimed?: boolean;
    blobContentTypeText?: boolean;
    blobContentTypeImage?: boolean;
    blobContentTypeAny?: boolean;
    fieldTypeBytes?: boolean;
    fieldTypeBinary?: boolean;
    fieldValidationMinLength: boolean;
    fieldValidationMaxLength: boolean;
    fieldValidationMinBytes: boolean;
    fieldValidationMaxBytes: boolean;
    relatedByOtherEntity?: boolean;
    enumInstance?: string;
    builtIn?: boolean;
    derivedPath?: string[];
} & {
    fieldType: import("../../lib/jhipster/field-types.ts").FieldType;
    fieldIsEnum: false;
} & {
    fieldTypeTemporal: boolean;
    fieldTypeCharSequence: boolean;
    fieldTypeNumeric: boolean;
    fieldSupportsSortBy?: boolean;
} & {
    tsType: string;
    hidden?: boolean;
    hideListView?: boolean;
}), import("../base-application/entity.ts").Relationship>, ClientApplication>) => void;