-
-
Notifications
You must be signed in to change notification settings - Fork 6.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
WIP: new javascript flowtyped generator (#176)
New Javascript flowtyped generator
- Loading branch information
Showing
35 changed files
with
9,209 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| #!/bin/sh | ||
|
|
||
| SCRIPT="$0" | ||
| echo "# START SCRIPT: $SCRIPT" | ||
|
|
||
| while [ -h "$SCRIPT" ] ; do | ||
| ls=`ls -ld "$SCRIPT"` | ||
| link=`expr "$ls" : '.*-> \(.*\)$'` | ||
| if expr "$link" : '/.*' > /dev/null; then | ||
| SCRIPT="$link" | ||
| else | ||
| SCRIPT=`dirname "$SCRIPT"`/"$link" | ||
| fi | ||
| done | ||
|
|
||
| if [ ! -d "${APP_DIR}" ]; then | ||
| APP_DIR=`dirname "$SCRIPT"`/.. | ||
| APP_DIR=`cd "${APP_DIR}"; pwd` | ||
| fi | ||
|
|
||
| executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar" | ||
|
|
||
| if [ ! -f "$executable" ] | ||
| then | ||
| mvn -B clean package | ||
| fi | ||
|
|
||
| # if you've executed sbt assembly previously it will use that instead. | ||
| export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties" | ||
| ags="generate -t modules/openapi-generator/src/main/resources/Javascript-Flowtyped -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g javascript-flowtyped -o samples/client/petstore/javascript-flowtyped -DappName=PetstoreClient $@" | ||
|
|
||
| java $JAVA_OPTS -jar $executable $ags |
281 changes: 281 additions & 0 deletions
281
...or/src/main/java/org/openapitools/codegen/languages/JavascriptFlowtypedClientCodegen.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,281 @@ | ||
| /* | ||
| * Copyright 2018 OpenAPI-Generator Contributors (https://openapi-generator.tech) | ||
| * Copyright 2018 SmartBear Software | ||
| * | ||
| * 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 | ||
| * | ||
| * http://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. | ||
| */ | ||
|
|
||
| package org.openapitools.codegen.languages; | ||
|
|
||
| import io.swagger.v3.oas.models.OpenAPI; | ||
| import io.swagger.v3.oas.models.media.ArraySchema; | ||
| import io.swagger.v3.oas.models.media.Schema; | ||
| import io.swagger.v3.oas.models.info.Info; | ||
| import io.swagger.v3.parser.util.SchemaTypeUtil; | ||
| import org.openapitools.codegen.*; | ||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.openapitools.codegen.utils.ModelUtils; | ||
|
|
||
| import java.text.SimpleDateFormat; | ||
| import java.util.*; | ||
|
|
||
| public class JavascriptFlowtypedClientCodegen extends AbstractTypeScriptClientCodegen { | ||
| private static final SimpleDateFormat SNAPSHOT_SUFFIX_FORMAT = new SimpleDateFormat("yyyyMMddHHmm"); | ||
|
|
||
| public static final String NPM_NAME = "npmName"; | ||
| public static final String NPM_VERSION = "npmVersion"; | ||
| public static final String NPM_REPOSITORY = "npmRepository"; | ||
| public static final String SNAPSHOT = "snapshot"; | ||
|
|
||
| protected String npmName = null; | ||
| protected String npmVersion = "1.0.0"; | ||
| protected String npmRepository = null; | ||
|
|
||
| public JavascriptFlowtypedClientCodegen() { | ||
| super(); | ||
|
|
||
| // clear import mapping (from default generator) as TS does not use it | ||
| // at the moment | ||
| importMapping.clear(); | ||
|
|
||
| setReservedWordsLowerCase(Arrays.asList( | ||
| // local variable names used in API methods (endpoints) | ||
| "varLocalPath", "queryParameters", "headerParams", "formParams", "useFormData", "varLocalDeferred", | ||
| "requestOptions", | ||
| // Typescript reserved words | ||
| "abstract", "arguments", "boolean", "break", "byte", | ||
| "case", "catch", "char", "class", "const", | ||
| "continue", "debugger", "default", "delete", "do", | ||
| "double", "else", "enum", "eval", "export", | ||
| "extends", "false", "final", "finally", "float", | ||
| "for", "function", "goto", "if", "implements", | ||
| "import", "in", "instanceof", "int", "interface", | ||
| "let", "long", "native", "new", "null", | ||
| "package", "private", "protected", "public", "return", | ||
| "short", "static", "super", "switch", "synchronized", | ||
| "this", "throw", "throws", "transient", "true", | ||
| "try", "typeof", "var", "void", "volatile", | ||
| "while", "with", "yield", | ||
| "Array", "Date", "eval", "function", "hasOwnProperty", | ||
| "Infinity", "isFinite", "isNaN", "isPrototypeOf", | ||
| "Math", "NaN", "Number", "Object", | ||
| "prototype", "String", "toString", "undefined", "valueOf")); | ||
|
|
||
| languageSpecificPrimitives = new HashSet<String>( | ||
| Arrays.asList("string", "boolean", "number", "Array", "Object", "Date", "File", "Blob") | ||
| ); | ||
|
|
||
| instantiationTypes.put("array", "Array"); | ||
| instantiationTypes.put("list", "Array"); | ||
| instantiationTypes.put("map", "Object"); | ||
| typeMapping.clear(); | ||
| typeMapping.put("array", "Array"); | ||
| typeMapping.put("map", "Object"); | ||
| typeMapping.put("List", "Array"); | ||
| typeMapping.put("boolean", "boolean"); | ||
| typeMapping.put("string", "string"); | ||
| typeMapping.put("int", "number"); | ||
| typeMapping.put("float", "number"); | ||
| typeMapping.put("number", "number"); | ||
| typeMapping.put("DateTime", "Date"); | ||
| typeMapping.put("date", "Date"); | ||
| typeMapping.put("long", "number"); | ||
| typeMapping.put("short", "number"); | ||
| typeMapping.put("char", "string"); | ||
| typeMapping.put("double", "number"); | ||
| typeMapping.put("object", "Object"); | ||
| typeMapping.put("integer", "number"); | ||
| // file, binary not supported in JS client right now, using String as a workaround | ||
| typeMapping.put("file", "string"); | ||
| typeMapping.put("binary", "string"); | ||
| typeMapping.put("ByteArray", "string"); | ||
| typeMapping.put("UUID", "string"); | ||
|
|
||
| defaultIncludes = new HashSet<String>(languageSpecificPrimitives); | ||
| outputFolder = "generated-code/javascript-flowtyped"; | ||
| embeddedTemplateDir = templateDir = "Javascript-Flowtyped"; | ||
|
|
||
| this.cliOptions.add(new CliOption(NPM_NAME, "The name under which you want to publish generated npm package")); | ||
| this.cliOptions.add(new CliOption(NPM_VERSION, "The version of your npm package")); | ||
| this.cliOptions.add(new CliOption(NPM_REPOSITORY, "Use this property to set an url your private npmRepo in the package.json")); | ||
| this.cliOptions.add(new CliOption(SNAPSHOT, "When setting this property to true the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm", SchemaTypeUtil.BOOLEAN_TYPE).defaultValue(Boolean.FALSE.toString())); | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public CodegenType getTag() { | ||
| return CodegenType.CLIENT; | ||
| } | ||
|
|
||
| @Override | ||
| protected void addAdditionPropertiesToCodeGenModel(CodegenModel codegenModel, Schema schema) { | ||
| codegenModel.additionalPropertiesType = getTypeDeclaration((Schema) schema.getAdditionalProperties()); | ||
| addImport(codegenModel, codegenModel.additionalPropertiesType); | ||
| } | ||
|
|
||
| @Override | ||
| public void processOpts() { | ||
| super.processOpts(); | ||
| supportingFiles.add(new SupportingFile("index.mustache", "src", "index.js")); | ||
| supportingFiles.add(new SupportingFile("api.mustache", "src", "api.js")); | ||
| supportingFiles.add(new SupportingFile("configuration.mustache", "src", "configuration.js")); | ||
| supportingFiles.add(new SupportingFile("gitignore", "", ".gitignore")); | ||
|
|
||
| addNpmPackageGeneration(); | ||
| } | ||
|
|
||
| @Override | ||
| public String getTypeDeclaration(Schema p) { | ||
| Schema inner; | ||
| if (ModelUtils.isArraySchema(p)) { | ||
| inner = ((ArraySchema) p).getItems(); | ||
| return this.getSchemaType(p) + "<" + this.getTypeDeclaration(inner) + ">"; | ||
| } else if (ModelUtils.isMapSchema(p)) { | ||
| inner = (Schema) p.getAdditionalProperties(); | ||
| return "{ [key: string]: " + this.getTypeDeclaration(inner) + "; }"; | ||
| } else if (ModelUtils.isFileSchema(p)) { | ||
| return "any"; | ||
| } else if (ModelUtils.isBinarySchema(p)) { | ||
| return "any"; | ||
| } else { | ||
| return super.getTypeDeclaration(p); | ||
| } | ||
| } | ||
|
|
||
| private void addNpmPackageGeneration() { | ||
| if (additionalProperties.containsKey(NPM_NAME)) { | ||
| this.setNpmName(additionalProperties.get(NPM_NAME).toString()); | ||
| } | ||
|
|
||
| if (additionalProperties.containsKey(NPM_VERSION)) { | ||
| this.setNpmVersion(additionalProperties.get(NPM_VERSION).toString()); | ||
| } | ||
|
|
||
| if (additionalProperties.containsKey(SNAPSHOT) && Boolean.valueOf(additionalProperties.get(SNAPSHOT).toString())) { | ||
| this.setNpmVersion(npmVersion + "-SNAPSHOT." + SNAPSHOT_SUFFIX_FORMAT.format(new Date())); | ||
| } | ||
| additionalProperties.put(NPM_VERSION, npmVersion); | ||
|
|
||
| if (additionalProperties.containsKey(NPM_REPOSITORY)) { | ||
| this.setNpmRepository(additionalProperties.get(NPM_REPOSITORY).toString()); | ||
| } | ||
|
|
||
| //Files for building our lib | ||
| supportingFiles.add(new SupportingFile("README.mustache", "", "README.md")); | ||
| supportingFiles.add(new SupportingFile("package.mustache", "", "package.json")); | ||
| supportingFiles.add(new SupportingFile("flowconfig.mustache", "", ".flowconfig")); | ||
| supportingFiles.add(new SupportingFile("babelrc", "", ".babelrc")); | ||
| } | ||
|
|
||
| @Override | ||
| public void preprocessOpenAPI(OpenAPI openAPI) { | ||
| super.preprocessOpenAPI(openAPI); | ||
|
|
||
| if (openAPI.getInfo() != null) { | ||
| Info info = openAPI.getInfo(); | ||
| if (StringUtils.isBlank(npmName) && info.getTitle() != null) { | ||
| // when projectName is not specified, generate it from info.title | ||
| npmName = sanitizeName(dashize(info.getTitle())); | ||
| } | ||
| if (StringUtils.isBlank(npmVersion)) { | ||
| // when projectVersion is not specified, use info.version | ||
| npmVersion = escapeUnsafeCharacters(escapeQuotationMark(info.getVersion())); | ||
| } | ||
| } | ||
|
|
||
| // default values | ||
| if (StringUtils.isBlank(npmName)) { | ||
| npmName = "openapi-js-client"; | ||
| } | ||
| if (StringUtils.isBlank(npmVersion)) { | ||
| npmVersion = "1.0.0"; | ||
| } | ||
|
|
||
| additionalProperties.put(NPM_NAME, npmName); | ||
| additionalProperties.put(NPM_VERSION, npmVersion); | ||
| additionalProperties.put(CodegenConstants.API_PACKAGE, apiPackage); | ||
| } | ||
|
|
||
| @Override | ||
| public Map<String, Object> postProcessModels(Map<String, Object> objs) { | ||
| // process enum in models | ||
| List<Object> models = (List<Object>) postProcessModelsEnum(objs).get("models"); | ||
| for (Object _mo : models) { | ||
| Map<String, Object> mo = (Map<String, Object>) _mo; | ||
| CodegenModel cm = (CodegenModel) mo.get("model"); | ||
| cm.imports = new TreeSet(cm.imports); | ||
| // name enum with model name, e.g. StatusEnum => Pet.StatusEnum | ||
| for (CodegenProperty var : cm.vars) { | ||
| if (Boolean.TRUE.equals(var.isEnum)) { | ||
| var.datatypeWithEnum = var.datatypeWithEnum.replace(var.enumName, cm.classname + "" + var.enumName); | ||
| } | ||
| } | ||
| if (cm.parent != null) { | ||
| for (CodegenProperty var : cm.allVars) { | ||
| if (Boolean.TRUE.equals(var.isEnum)) { | ||
| var.datatypeWithEnum = var.datatypeWithEnum | ||
| .replace(var.enumName, cm.classname + "" + var.enumName); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return objs; | ||
| } | ||
|
|
||
| @Override | ||
| public String escapeQuotationMark(String input) { | ||
| // remove ', " to avoid code injection | ||
| return input.replace("\"", "").replace("'", ""); | ||
| } | ||
|
|
||
| @Override | ||
| public String escapeUnsafeCharacters(String input) { | ||
| return input.replace("*/", "*_/").replace("/*", "/_*"); | ||
| } | ||
|
|
||
| @Override | ||
| public String getName() { | ||
| return "javascript-flowtyped"; | ||
| } | ||
|
|
||
| @Override | ||
| public String getHelp() { | ||
| return "Generates a Javascript client library (beta) using Flow types and Fetch API."; | ||
| } | ||
|
|
||
| public String getNpmName() { | ||
| return npmName; | ||
| } | ||
|
|
||
| public void setNpmName(String npmName) { | ||
| this.npmName = npmName; | ||
| } | ||
|
|
||
| public String getNpmVersion() { | ||
| return npmVersion; | ||
| } | ||
|
|
||
| public void setNpmVersion(String npmVersion) { | ||
| this.npmVersion = npmVersion; | ||
| } | ||
|
|
||
| public String getNpmRepository() { | ||
| return npmRepository; | ||
| } | ||
|
|
||
| public void setNpmRepository(String npmRepository) { | ||
| this.npmRepository = npmRepository; | ||
| } | ||
|
|
||
| } |
41 changes: 41 additions & 0 deletions
41
modules/openapi-generator/src/main/resources/Javascript-Flowtyped/README.mustache
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| ## {{npmName}}@{{npmVersion}} | ||
|
|
||
| This generator creates Flow typed JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments: | ||
|
|
||
| Environment | ||
| * Node.js | ||
| * Webpack | ||
| * Browserify | ||
|
|
||
| Language level | ||
| * ES6 | ||
|
|
||
| Module system | ||
| * ES6 module system | ||
|
|
||
| ### Building | ||
|
|
||
| To build an compile the flow typed sources to javascript use: | ||
| ``` | ||
| npm install | ||
| npm run build | ||
| ``` | ||
|
|
||
| ### Publishing | ||
|
|
||
| First build the package then run ```npm publish``` | ||
|
|
||
| ### Consuming | ||
|
|
||
| navigate to the folder of your consuming project and run one of the following commands. | ||
|
|
||
| _published:_ | ||
|
|
||
| ``` | ||
| npm install {{npmName}}@{{npmVersion}} --save | ||
| ``` | ||
|
|
||
| _unPublished (not recommended):_ | ||
|
|
||
| ``` | ||
| npm install PATH_TO_GENERATED_PACKAGE --save |
Oops, something went wrong.