gen-jhipster
Version:
VHipster - Spring Boot + Angular/React/Vue in one handy generator
210 lines (209 loc) • 7.79 kB
TypeScript
/**
* Copyright 2013-2026 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 type { Application as ClientApplication, Entity as ClientEntity } from '../client/types.ts';
export declare const vueFiles: import("../base-core/api.js").WriteFileSection<ClientApplication>;
export declare const entitiesFiles: {
entities: {
templates: string[];
path?: string | ((this: import("../index.ts").GeneratorBaseCore<import("../base-core/types.js").Config, import("../base-core/types.js").Options, import("../base-core/types.js").Features>, data: ClientApplication) => string) | undefined;
renameTo?: ((this: import("../index.ts").GeneratorBaseCore<import("../base-core/types.js").Config, import("../base-core/types.js").Options, import("../base-core/types.js").Features>, data: ClientApplication, filePath: string) => string) | undefined;
}[];
};
export declare const writeFiles: (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-simple-application/tasks.js").TaskParamWithApplication<ClientApplication>) => void;
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;