Package org.openapitools.codegen.languages

Class TypeScriptClientCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractTypeScriptClientCodegen

org.openapitools.codegen.languages.TypeScriptClientCodegen

All Implemented Interfaces:

CodegenConfig

public class TypeScriptClientCodegen
extends AbstractTypeScriptClientCodegen
implements CodegenConfig

Nested Class Summary

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

AbstractTypeScriptClientCodegen.ParameterExpander

Field Summary

Fields

Modifier and Type	Field	Description
protected CodegenConstants.ENUM_PROPERTY_NAMING_TYPE	enumPropertyNaming
protected String	npmRepository
protected String	snapshot

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

classEnumSeparator, ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR, ENUM_PROPERTY_NAMING_REPLACE_SPECIAL_CHAR_DESC, 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
TypeScriptClientCodegen()

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.
protected void	addImport(Set<String> importsToBeAddedTo, String type)
CodegenParameter	fromFormProperty(String name, io.swagger.v3.oas.models.media.Schema propertySchema, Set<String> imports)	Create a CodegenParameter for a Form Property We have a custom version of this method so we can invoke setParameterExampleValue(codegenParameter, parameter) rather than setParameterExampleValue(codegenParameter) This ensures that all of our samples are generated in toExampleValueRecursive
String	getHelp()
String	getModelName(io.swagger.v3.oas.models.media.Schema sc)
String	getName()
protected Object	getObjectExample(io.swagger.v3.oas.models.media.Schema sc)	Gets an example if it exists
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)	Output the language-specific type declaration of the property.
ModelsMap	postProcessModels(ModelsMap objs)
OperationsMap	postProcessOperationsWithModels(OperationsMap operations, List<ModelMap> models)
Map<String,Object>	postProcessSupportingFileData(Map<String,Object> objs)
void	processOpts()
void	setParameterExampleValue(CodegenParameter codegenParameter, io.swagger.v3.oas.models.parameters.Parameter parameter)	Set the codegenParameter example value We have a custom version of this function so we can invoke toExampleValue
void	setParameterExampleValue(CodegenParameter codegenParameter, io.swagger.v3.oas.models.parameters.RequestBody requestBody)	Return the example value of the parameter.
protected String	setPropertyExampleValue(CodegenProperty p)
protected String[]	splitComposedTypes(String type)	Split composed types e.g.
String	toEnumValue(String value, String datatype)	Return the enum value in the language specified format e.g. status becomes "status"
String	toEnumVarName(String name, String datatype)	Return the sanitized variable name for enum
String	toExampleValue(io.swagger.v3.oas.models.media.Schema schema)	Return the example value of the property
String	toExampleValue(io.swagger.v3.oas.models.media.Schema schema, Object objExample)
String	toModelImport(String name)	Return the fully-qualified "Model" name for import
String	toParamName(String name)	Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.
String	toVarName(String name)	Return the variable name by removing invalid characters and proper escaping if it's a reserved word.
String	typescriptDate(Object dateValue)
String	typescriptDateTime(Object dateTimeValue)

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

addImport, addPrefix, addSuffix, apiFileFolder, escapeQuotationMark, escapeReservedWord, escapeText, escapeUnsafeCharacters, generatorLanguage, getEnumPropertyNaming, getLicenseNameDefaultValue, getParameterDataType, getSchemaType, getTag, getTypesFromSchemas, isEnumPropertyNamingReplaceSpecialChar, isReservedWord, modelFileFolder, postProcessAllModels, postProcessFile, preprocessOpenAPI, setEnumPropertyNaming, setEnumPropertyNamingReplaceSpecialChar, setModelPropertyNaming, setParamNaming, supportModelPropertyNaming, toAllOfName, toAnyOfName, toDefaultValue, toEnumDefaultValue, toEnumName, toModelFilename, toModelImportMap, toModelName, toOneOfName, toOperationId, toTypescriptTypeName

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addBodyModelSchema, addHeaders, 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, 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, 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, isDataTypeFile, 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, needToImport, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcess, postProcessEnumVars, postProcessModelProperty, postProcessModelsEnum, postProcessParameter, postProcessResponseWithProperty, 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, setParameterNullable, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSkipSortingOperations, setStrictSpecBehavior, setTemplatingEngine, setUseOneOfInterfaces, shouldAddImport, shouldOverwrite, SortModelPropertiesByRequiredFlag, SortParametersByRequiredFlag, specVersionGreaterThanOrEqualTo310, supportedLibraries, supportingFiles, templateDir, templateOutputDirs, testPackage, toApiDocFilename, toApiFilename, toApiImport, toApiName, toApiTestFilename, toApiVarName, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toExamples, 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, apiFileFolder, apiFilename, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, enumNameMapping, escapeQuotationMark, escapeReservedWord, escapeText, escapeTextWhileAllowingNewLines, escapeUnsafeCharacters, fileSuffix, fromModel, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generatorLanguage, generatorLanguageVersion, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOpenapiGeneratorIgnoreList, getOutputDir, getReleaseNote, getSupportedVendorExtensions, getTag, getTemplatingEngine, getTypeDeclaration, getUseInlineModelResolver, getUseOpenapiNormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameMapping, inlineSchemaOption, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isSkipSortingOperations, isStrictSpecBehavior, isTypeErasedGenerics, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFileFolder, modelFilename, modelFilename, modelNameMapping, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, nameMapping, openapiGeneratorIgnoreList, openapiNormalizer, operationIdNameMapping, outputFolder, parameterNameMapping, postProcess, postProcessAllModels, postProcessFile, postProcessModelProperty, postProcessParameter, postProcessResponseWithProperty, postProcessWebhooksWithModels, preprocessOpenAPI, 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, toApiImport, toApiName, toApiTestFilename, toApiVarName, toBooleanGetter, toGetter, toModelDocFilename, toModelFilename, toModelImportMap, toModelName, toModelTestFilename, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensions

Field Detail

npmRepository

protected String npmRepository

snapshot

protected String snapshot

enumPropertyNaming

protected CodegenConstants.ENUM_PROPERTY_NAMING_TYPE enumPropertyNaming

Constructor Detail

TypeScriptClientCodegen

public TypeScriptClientCodegen()

Method Detail

postProcessSupportingFileData

public Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)

Specified by:

postProcessSupportingFileData in interface CodegenConfig

Overrides:

postProcessSupportingFileData in class DefaultCodegen

postProcessOperationsWithModels

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

Specified by:

postProcessOperationsWithModels in interface CodegenConfig

Overrides:

postProcessOperationsWithModels in class DefaultCodegen

toParamName

public String toParamName(String name)

Description copied from class: DefaultCodegen

Return the parameter name by removing invalid characters and proper escaping if it's a reserved word.

Specified by:

toParamName in interface CodegenConfig

Overrides:

toParamName in class AbstractTypeScriptClientCodegen

Parameters:

name - Codegen property object

Returns:

the sanitized parameter name

toVarName

public String toVarName(String name)

Description copied from class: DefaultCodegen

Return the variable name by removing invalid characters and proper escaping if it's a reserved word.

Overrides:

toVarName in class AbstractTypeScriptClientCodegen

Parameters:

name - the variable name

Returns:

the sanitized variable name

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

toEnumValue

public String toEnumValue(String value,
                          String datatype)

Description copied from class: DefaultCodegen

Return the enum value in the language specified format e.g. status becomes "status"

Overrides:

toEnumValue in class AbstractTypeScriptClientCodegen

Parameters:

value - enum variable name

datatype - data type

Returns:

the sanitized value for enum

toEnumVarName

public String toEnumVarName(String name,
                            String datatype)

Description copied from class: DefaultCodegen

Return the sanitized variable name for enum

Overrides:

toEnumVarName in class AbstractTypeScriptClientCodegen

Parameters:

name - enum variable name

datatype - data type

Returns:

the sanitized variable name for enum

postProcessModels

public ModelsMap postProcessModels(ModelsMap objs)

Specified by:

postProcessModels in interface CodegenConfig

Overrides:

postProcessModels 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

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

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.

typescriptDate

public String typescriptDate(Object dateValue)

typescriptDateTime

public String typescriptDateTime(Object dateTimeValue)

getModelName

public String getModelName(io.swagger.v3.oas.models.media.Schema sc)

getObjectExample

protected Object getObjectExample(io.swagger.v3.oas.models.media.Schema sc)

Gets an example if it exists

Parameters:

sc - input schema

Returns:

the example value

toExampleValue

public String toExampleValue(io.swagger.v3.oas.models.media.Schema schema)

Description copied from class: DefaultCodegen

Return the example value of the property

This method should be overridden in the generator to meet its requirement.

Overrides:

toExampleValue in class DefaultCodegen

Parameters:

schema - Property schema

Returns:

string presentation of the example value of the property

toExampleValue

public String toExampleValue(io.swagger.v3.oas.models.media.Schema schema,
                             Object objExample)

setPropertyExampleValue

protected String setPropertyExampleValue(CodegenProperty p)

setParameterExampleValue

public void setParameterExampleValue(CodegenParameter codegenParameter,
                                     io.swagger.v3.oas.models.parameters.Parameter parameter)

Set the codegenParameter example value We have a custom version of this function so we can invoke toExampleValue

Overrides:

setParameterExampleValue in class DefaultCodegen

Parameters:

codegenParameter - the item we are setting the example on

parameter - the base parameter that came from the spec

setParameterExampleValue

public void setParameterExampleValue(CodegenParameter codegenParameter,
                                     io.swagger.v3.oas.models.parameters.RequestBody requestBody)

Return the example value of the parameter.

Overrides:

setParameterExampleValue in class DefaultCodegen

Parameters:

codegenParameter - Codegen parameter

requestBody - Request body

fromFormProperty

public CodegenParameter fromFormProperty(String name,
                                         io.swagger.v3.oas.models.media.Schema propertySchema,
                                         Set<String> imports)

Create a CodegenParameter for a Form Property We have a custom version of this method so we can invoke setParameterExampleValue(codegenParameter, parameter) rather than setParameterExampleValue(codegenParameter) This ensures that all of our samples are generated in toExampleValueRecursive

Overrides:

fromFormProperty in class DefaultCodegen

Parameters:

name - the property name

propertySchema - the property schema

imports - our import set

Returns:

the resultant CodegenParameter

addImport

protected void addImport(Set<String> importsToBeAddedTo,
                         String type)

Overrides:

addImport in class DefaultCodegen

splitComposedTypes

protected String[] splitComposedTypes(String type)

Split composed types e.g. TheFirstType | TheSecondType to TheFirstType and TheSecondType

Parameters:

type - String with composed types

Returns:

list of types