Package org.openapitools.codegen.languages

Class TypeScriptNestjsServerCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen

org.openapitools.codegen.languages.TypeScriptNestjsServerCodegen

All Implemented Interfaces:

CodegenConfig

public class TypeScriptNestjsServerCodegen
extends AbstractTypeScriptClientCodegen

Nested Class Summary

Nested classes/interfaces inherited from class org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen

AbstractTypeScriptClientCodegen.ParameterExpander

Field Summary

Fields

Modifier and Type	Field	Description
static String	API_FILE_SUFFIX
static String	API_SUFFIX
protected String	apiFileSuffix
protected String	apiSuffix
static String	FILE_NAMING
protected String	fileNaming
static String	MODEL_FILE_SUFFIX
static String	MODEL_SUFFIX
protected String	modelFileSuffix
protected String	modelSuffix
static String	NEST_VERSION
protected String	nestVersion
static String	NODE_VERSION
static String	NPM_REPOSITORY
protected String	npmRepository
static String	RXJS_VERSION
static String	STRING_ENUMS
static String	STRING_ENUMS_DESC
protected Boolean	stringEnums
static String	TAGGED_UNIONS
static String	TS_VERSION
static String	USE_SINGLE_REQUEST_PARAMETER

Fields inherited from class org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen

classEnumSeparator, ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR, ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR_DESC, enumPropertyNaming, enumPropertyNamingReplaceSpecialChar, enumSuffix, languageGenericTypes, LICENSE_NAME_DEFAULT_VALUE, licenseName, MODEL_PROPERTY_NAMING_DESC_WITH_WARNING, modelPropertyNaming, NPM_NAME, NPM_VERSION, npmName, npmVersion, NULL_SAFE_ADDITIONAL_PROPS, NULL_SAFE_ADDITIONAL_PROPS_DESC, nullSafeAdditionalProps, paramNaming, SNAPSHOT, SNAPSHOT_SUFFIX_FORMAT, supportsES6

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, addSuffixToDuplicateOperationNicknames, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, autosetConstants, cliOptions, DefaultFeatureSet, defaultIncludes, defaultToEmptyContainer, disallowAdditionalPropertiesIfNotPresent, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, enumNameMapping, enumUnknownDefaultCase, enumUnknownDefaultCaseName, falseSchema, filesMetadataFilename, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importBaseType, importContainerType, importMapping, inlineSchemaNameMapping, inlineSchemaOption, inputSpec, instantiationTypes, JSON_MIME_PATTERN, JSON_VENDOR_MIME_PATTERN, languageSpecificPrimitives, legacyDiscriminatorBehavior, library, loadDeepObjectIntoItems, modelDocTemplateFiles, modelNameMapping, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, nameMapping, openAPI, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, prependFormOrBodyParameters, releaseNote, removeEnumValuePrefix, removeOperationIdPrefix, removeOperationIdPrefixCount, removeOperationIdPrefixDelimiter, reservedWords, reservedWordsMappings, schemaMapping, serverVariables, skipOperationExample, skipOverwrite, skipSortingOperations, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, templateOutputDirs, testPackage, trueSchema, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions, versionMetadataFilename, XML_MIME_PATTERN

Constructor Summary

Constructors

Constructor	Description
TypeScriptNestjsServerCodegen()

Method Summary

Modifier and Type	Method	Description
protected void	addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel, io.swagger.v3.oas.models.media.Schema schema)	Handle the model for the 'additionalProperties' keyword in the OAS schema.
String	apiFilename(String templateName, String tag)
String	getHelp()
String	getName()
String	getSchemaType(io.swagger.v3.oas.models.media.Schema p)	returns the OpenAPI type for the property.
CodegenType	getTag()
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)	Output the language-specific type declaration of the property.
boolean	isDataTypeFile(String dataType)
Map<String,ModelsMap>	postProcessAllModels(Map<String,ModelsMap> objs)
ModelsMap	postProcessModels(ModelsMap objs)
OperationsMap	postProcessOperationsWithModels(OperationsMap operations, List<ModelMap> allModels)
void	postProcessParameter(CodegenParameter parameter)
void	processOpts()
String	removeModelPrefixSuffix(String name)
void	setStringEnums(boolean value)
String	toApiImport(String name)	Return the fully-qualified "Api" name for import
String	toApiName(String name)	Output the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is empty
String	toApiVarName(String name)	Return the variable name in the Api
String	toModelFilename(String name)	Return the capitalized file name of the model
String	toModelImport(String name)	Return the fully-qualified "Model" name for import
String	toModelName(String name)	Converts the OpenAPI schema name to a model name suitable for the current code generator.

Methods inherited from class org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen

addImport, addPrefix, addSuffix, apiFileFolder, escapeQuotationMark, escapeReservedWord, escapeText, escapeUnsafeCharacters, generatorLanguage, getEnumPropertyNaming, getLicenseNameDefaultValue, getParameterDataType, getTypesFromSchemas, isEnumPropertyNamingReplaceSpecialChar, isReservedWord, modelFileFolder, needToImport, postProcessFile, preprocessOpenAPI, setEnumPropertyNaming, setEnumPropertyNamingReplaceSpecialChar, setModelPropertyNaming, setParamNaming, supportModelPropertyNaming, toAllOfName, toAnyOfName, toDefaultValue, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toModelImportMap, toOneOfName, toOperationId, toParamName, toTypescriptTypeName, toVarName

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addBodyModelSchema, addHeaders, addImport, addImport, addImports, addImports, addImports, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addMustacheLambdas, addOneOfInterfaceModel, addOneOfNameExtension, addOperationToGroup, addOption, addOption, addParentContainer, addParentFromContainer, addProperties, addRegularExpressionDelimiter, addRequiredVarsMap, addSwitch, addVars, addVars, addVarsRequiredVarsAdditionalProps, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, convertPropertyToBooleanAndWriteBack, convertPropertyToStringAndWriteBack, convertPropertyToTypeAndWriteBack, createDiscriminator, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeTextInSingleQuotes, escapeTextWhileAllowingNewLines, executePostProcessor, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, fromParameter, fromProperty, fromProperty, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, generatorLanguageVersion, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAlias, getAllModels, getAllOfDescendants, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDocExtension, getEnumDefaultValue, getEnumUnknownDefaultCase, getEnumValueForProperty, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getItemsName, getLegacyDiscriminatorBehavior, getLibrary, getModelNameToSchemaCache, getMostInnerItems, getOneOfAnyOfDescendants, getOpenapiGeneratorIgnoreList, getOrGenerateOperationId, getOutputDir, getProducesInfo, getReleaseNote, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSingleSchemaType, getSupportedVendorExtensions, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseInlineModelResolver, getUseOneOfInterfaces, getUseOpenapiNormalizer, getVersionMetadataFilename, handleConstantParams, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isDataTypeBinary, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isSkipSortingOperations, isStrictSpecBehavior, isTypeErasedGenerics, isXmlMimeType, languageSpecificPrimitives, lowerCamelCase, modelDocFileFolder, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, modifyFeatureSet, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcess, postProcessEnumVars, postProcessModelProperty, postProcessModelsEnum, postProcessResponseWithProperty, postProcessSupportingFileData, postProcessWebhooksWithModels, processCompiler, processOpenAPI, processTemplatingEngine, processTestExampleData, removeImport, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setAddProps, setCircularReferences, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnumDiscriminatorDefaultValue, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterEncodingValues, setParameterExamples, setParameterExampleValue, setParameterExampleValue, setParameterExampleValue, setParameterNullable, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSkipSortingOperations, setStrictSpecBehavior, setTemplatingEngine, setUseOneOfInterfaces, shouldAddImport, shouldOverwrite, SortModelPropertiesByRequiredFlag, SortParametersByRequiredFlag, specVersionGreaterThanOrEqualTo310, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toApiDocFilename, toApiFilename, toApiTestFilename, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toExamples, toExampleValue, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelDocFilename, toModelTestFilename, toRegularExpression, toSetter, toTestCaseName, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateModelForAnyType, updateModelForComposedSchema, updateModelForInteger, updateModelForNumber, updateModelForObject, updateModelForString, updateOption, updateParameterForString, updatePropertyForAnyType, updatePropertyForArray, updatePropertyForInteger, updatePropertyForMap, updatePropertyForMap, updatePropertyForNumber, updatePropertyForObject, updatePropertyForString, updateRequestBodyForArray, updateRequestBodyForMap, updateRequestBodyForObject, updateRequestBodyForPrimitiveType, updateRequestBodyForString, useCodegenAsMustacheParentContext, vendorExtensions, writePropertyBack

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openapitools.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOpenapiGeneratorIgnoreList, getOutputDir, getReleaseNote, getSupportedVendorExtensions, getTemplatingEngine, getTypeDeclaration, getUseInlineModelResolver, getUseOpenapiNormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isSkipSortingOperations, isStrictSpecBehavior, isTypeErasedGenerics, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcess, postProcessModelProperty, postProcessResponseWithProperty, postProcessSupportingFileData, postProcessWebhooksWithModels, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, sanitizeTag, schemaMapping, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOperationExample, setSkipOverwrite, setSkipSortingOperations, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toApiDocFilename, toApiFilename, toApiTestFilename, toBooleanGetter, toGetter, toModelDocFilename, toModelTestFilename, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensions

Field Detail

NPM_REPOSITORY

public static final String NPM_REPOSITORY

See Also:

Constant Field Values

TAGGED_UNIONS

public static final String TAGGED_UNIONS

See Also:

Constant Field Values

NEST_VERSION

public static final String NEST_VERSION

See Also:

Constant Field Values

API_SUFFIX

public static final String API_SUFFIX

See Also:

Constant Field Values

API_FILE_SUFFIX

public static final String API_FILE_SUFFIX

See Also:

Constant Field Values

MODEL_SUFFIX

public static final String MODEL_SUFFIX

See Also:

Constant Field Values

MODEL_FILE_SUFFIX

public static final String MODEL_FILE_SUFFIX

See Also:

Constant Field Values

FILE_NAMING

public static final String FILE_NAMING

See Also:

Constant Field Values

STRING_ENUMS

public static final String STRING_ENUMS

See Also:

Constant Field Values

STRING_ENUMS_DESC

public static final String STRING_ENUMS_DESC

See Also:

Constant Field Values

USE_SINGLE_REQUEST_PARAMETER

public static final String USE_SINGLE_REQUEST_PARAMETER

See Also:

Constant Field Values

NODE_VERSION

public static final String NODE_VERSION

See Also:

Constant Field Values

TS_VERSION

public static final String TS_VERSION

See Also:

Constant Field Values

RXJS_VERSION

public static final String RXJS_VERSION

See Also:

Constant Field Values

nestVersion

protected String nestVersion

npmRepository

protected String npmRepository

apiSuffix

protected String apiSuffix

apiFileSuffix

protected String apiFileSuffix

modelSuffix

protected String modelSuffix

modelFileSuffix

protected String modelFileSuffix

fileNaming

protected String fileNaming

stringEnums

protected Boolean stringEnums

Constructor Detail

TypeScriptNestjsServerCodegen

public TypeScriptNestjsServerCodegen()

Method Detail

addAdditionPropertiesToCodeGenModel

protected void addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel,
                                                   io.swagger.v3.oas.models.media.Schema schema)

Description copied from class: DefaultCodegen

Handle the model for the 'additionalProperties' keyword in the OAS schema.

Overrides:

addAdditionPropertiesToCodeGenModel in class DefaultCodegen

Parameters:

codegenModel - The codegen representation of the schema.

schema - The input OAS schema.

getTag

public CodegenType getTag()

Specified by:

getTag in interface CodegenConfig

Overrides:

getTag in class AbstractTypeScriptClientCodegen

getName

public String getName()

Specified by:

getName in interface CodegenConfig

Overrides:

getName in class DefaultCodegen

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

Overrides:

getHelp in class DefaultCodegen

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class AbstractTypeScriptClientCodegen

setStringEnums

public void setStringEnums(boolean value)

isDataTypeFile

public boolean isDataTypeFile(String dataType)

Overrides:

isDataTypeFile in class DefaultCodegen

getTypeDeclaration

public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)

Description copied from class: DefaultCodegen

Output the language-specific type declaration of the property.

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class AbstractTypeScriptClientCodegen

Parameters:

p - property schema

Returns:

a string presentation of the property type

getSchemaType

public String getSchemaType(io.swagger.v3.oas.models.media.Schema p)

Description copied from class: DefaultCodegen

returns the OpenAPI type for the property. Use getAlias to handle $ref of primitive type

Overrides:

getSchemaType in class AbstractTypeScriptClientCodegen

Parameters:

p - property schema

Returns:

string presentation of the type

postProcessParameter

public void postProcessParameter(CodegenParameter parameter)

Specified by:

postProcessParameter in interface CodegenConfig

Overrides:

postProcessParameter in class DefaultCodegen

postProcessOperationsWithModels

public OperationsMap postProcessOperationsWithModels(OperationsMap operations,
                                                     List<ModelMap> allModels)

Specified by:

postProcessOperationsWithModels in interface CodegenConfig

Overrides:

postProcessOperationsWithModels in class DefaultCodegen

postProcessAllModels

public Map<String,ModelsMap> postProcessAllModels(Map<String,ModelsMap> objs)

Specified by:

postProcessAllModels in interface CodegenConfig

Overrides:

postProcessAllModels in class AbstractTypeScriptClientCodegen

postProcessModels

public ModelsMap postProcessModels(ModelsMap objs)

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels in class AbstractTypeScriptClientCodegen

toApiName

public String toApiName(String name)

Description copied from class: DefaultCodegen

Output the API (class) name (capitalized) ending with the specified or default suffix Return DefaultApi if name is empty

Specified by:

toApiName in interface CodegenConfig

Overrides:

toApiName in class DefaultCodegen

Parameters:

name - the name of the Api

Returns:

capitalized Api name

apiFilename

public String apiFilename(String templateName,
                          String tag)

Specified by:

apiFilename in interface CodegenConfig

Overrides:

apiFilename in class DefaultCodegen

toApiVarName

public String toApiVarName(String name)

Description copied from class: DefaultCodegen

Return the variable name in the Api

Specified by:

toApiVarName in interface CodegenConfig

Overrides:

toApiVarName in class DefaultCodegen

Parameters:

name - the variable name of the Api

Returns:

the snake-cased variable name

toApiImport

public String toApiImport(String name)

Description copied from class: DefaultCodegen

Return the fully-qualified "Api" name for import

Specified by:

toApiImport in interface CodegenConfig

Overrides:

toApiImport in class DefaultCodegen

Parameters:

name - the name of the "Api"

Returns:

the fully-qualified "Api" name for import

toModelFilename

public String toModelFilename(String name)

Description copied from class: DefaultCodegen

Return the capitalized file name of the model

Specified by:

toModelFilename in interface CodegenConfig

Overrides:

toModelFilename in class AbstractTypeScriptClientCodegen

Parameters:

name - the model name

Returns:

the file name of the model

toModelImport

public String toModelImport(String name)

Description copied from class: DefaultCodegen

Return the fully-qualified "Model" name for import

Specified by:

toModelImport in interface CodegenConfig

Overrides:

toModelImport in class AbstractTypeScriptClientCodegen

Parameters:

name - the name of the "Model"

Returns:

the fully-qualified "Model" name for import

toModelName

public String toModelName(String name)

Description copied from class: DefaultCodegen

Converts the OpenAPI schema name to a model name suitable for the current code generator. May be overridden for each programming language. In case the name belongs to the TypeSystem it won't be renamed.

Specified by:

toModelName in interface CodegenConfig

Overrides:

toModelName in class AbstractTypeScriptClientCodegen

Parameters:

name - the name of the model

Returns:

capitalized model name

removeModelPrefixSuffix

public String removeModelPrefixSuffix(String name)