Skip to content

armgit / core

Public Imported from GitHub
0

100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps

Upgrade typescript-generator plugin to 4.1.1 (#2912)

Wouter Born7f6533af631e
diff --git a/gradle.properties b/gradle.properties
index 74c17419f..172229f42 100644
--- a/gradle.properties
+++ b/gradle.properties
@@ -8,7 +8,7 @@ systemProp.org.gradle.internal.repository.max.retries=10
# the initial time before retrying, in milliseconds (default 125)
systemProp.org.gradle.internal.repository.initial.backoff=500
-typescriptGeneratorVersion = 3.2.1263
+typescriptGeneratorVersion = 4.1.1
gradleNexusPublishPluginVersion = 2.0.0
gradleFileEncryptPluginVersion = 2.1.0
ideaExtPluginVersion = 1.2
diff --git a/project.gradle b/project.gradle
index 455648234..911c3bc58 100644
--- a/project.gradle
+++ b/project.gradle
@@ -2,6 +2,19 @@
import org.jetbrains.gradle.ext.JUnit
+import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility
+import cz.habarta.typescript.generator.DateMapping
+import cz.habarta.typescript.generator.EnumMapping
+import cz.habarta.typescript.generator.Jackson2Configuration
+import cz.habarta.typescript.generator.JsonLibrary
+import cz.habarta.typescript.generator.ModuleDependency
+import cz.habarta.typescript.generator.NullabilityDefinition
+import cz.habarta.typescript.generator.OptionalProperties
+import cz.habarta.typescript.generator.RestNamespacing
+import cz.habarta.typescript.generator.TypeScriptFileType
+import cz.habarta.typescript.generator.TypeScriptOutputKind
+
+import java.io.Serializable
import java.nio.file.Files
import java.nio.file.Paths
import java.nio.file.attribute.PosixFileAttributes
@@ -13,7 +26,6 @@ import static org.apache.tools.ant.taskdefs.condition.Os.FAMILY_WINDOWS
import static org.apache.tools.ant.taskdefs.condition.Os.isFamily
import static org.jetbrains.gradle.ext.ShortenCommandLine.MANIFEST
import org.jetbrains.gradle.ext.Application
-import org.jetbrains.gradle.ext.JUnit
// Configure versions in gradle.properties (putting a gradle.properties file
// in a subproject only overrides root properties of same name for the actual
@@ -229,7 +241,7 @@ def getYarnInstallTask() {
def createTSGeneratorConfigForModel(String outputFileName, Project...customProjectsToScan) {
def config = createTSGeneratorConfig(false, outputFileName, customProjectsToScan) <<
{
- extensions = [
+ extensionClasses = [
"org.openremote.model.util.AssetModelInfoExtension",
"CustomExtension",
"JsonSerializeExtension"
@@ -247,7 +259,7 @@ def createTSGeneratorConfigForModel(String outputFileName, Project...customProje
def createTSGeneratorConfigForClient(String outputFileName, File modelInfoJson, Project...customProjectsToScan) {
def config = createTSGeneratorConfig(true, outputFileName, customProjectsToScan) <<
{
- extensions = [
+ extensionClasses = [
"CustomExtension",
"JsonSerializeExtension",
"AggregatedApiClient",
@@ -265,7 +277,7 @@ def createTSGeneratorConfigForClient(String outputFileName, File modelInfoJson,
"org.openremote.model.value.ValueDescriptor<T>:Model.ValueDescriptor"
]
moduleDependencies = [
- cz.habarta.typescript.generator.ModuleDependency.module(
+ ModuleDependency.module(
"@openremote/model",
"Model",
modelInfoJson,
@@ -273,7 +285,7 @@ def createTSGeneratorConfigForClient(String outputFileName, File modelInfoJson,
(String) null
)
]
- restNamespacing = "perResource"
+ restNamespacing = RestNamespacing.perResource
}
return config
}
@@ -299,12 +311,12 @@ def createTSGeneratorConfig(boolean outputAPIClient, String outputFileName, Proj
}.toList()
return {
- jsonLibrary = "jackson2"
+ jsonLibrary = JsonLibrary.jackson2
classPatterns = [
(outputAPIClient ? "org.openremote.model.**Resource" : "org.openremote.model.**")
] + classPatternGlobs
customTypeNamingFunction = "function(name, simpleName) { if (name.indexOf(\"\$\") > 0) return name.substr(name.lastIndexOf(\".\")+1).replace(\"\$\",\"\"); }"
- nullabilityDefinition = cz.habarta.typescript.generator.NullabilityDefinition.nullAndUndefinedInlineUnion
+ nullabilityDefinition = NullabilityDefinition.nullAndUndefinedInlineUnion
nullableAnnotations = ["org.checkerframework.checker.nullness.qual.Nullable"]
excludeClassPatterns = [
"org.openremote.model.event.shared.*Filter**",
@@ -315,19 +327,21 @@ def createTSGeneratorConfig(boolean outputAPIClient, String outputFileName, Proj
"org.hibernate.**",
"jakarta.**"
]
- mapEnum = cz.habarta.typescript.generator.EnumMapping.asEnum
- mapDate = cz.habarta.typescript.generator.DateMapping.asNumber
- optionalProperties = "all" // TODO: cleanup model to be more explicit about optional params
- outputFileType = "implementationFile"
- outputKind = "module"
+ mapEnum = EnumMapping.asEnum
+ mapDate = DateMapping.asNumber
+ optionalProperties = OptionalProperties.all // TODO: cleanup model to be more explicit about optional params
+ outputFileType = TypeScriptFileType.implementationFile
+ outputKind = TypeScriptOutputKind.module
outputFile = outputFileName
- jackson2Configuration = [
- fieldVisibility: "ANY",
- creatorVisibility: "ANY",
- getterVisibility: "NONE",
- isGetterVisibility: "NONE",
- setterVisibility: "NONE"
- ]
+
+ def jackson2Config = new Jackson2Configuration()
+ jackson2Config.fieldVisibility = Visibility.ANY
+ jackson2Config.creatorVisibility = Visibility.ANY
+ jackson2Config.getterVisibility = Visibility.NONE
+ jackson2Config.isGetterVisibility = Visibility.NONE
+ jackson2Config.setterVisibility = Visibility.NONE
+ jackson2Configuration.set(jackson2Config)
+
jackson2Modules = [
"com.fasterxml.jackson.datatype.jdk8.Jdk8Module",
"com.fasterxml.jackson.datatype.jsr310.JavaTimeModule",
diff --git a/ui/component/model/build.gradle b/ui/component/model/build.gradle
index f3de5a724..729c5af1c 100644
--- a/ui/component/model/build.gradle
+++ b/ui/component/model/build.gradle
@@ -24,14 +24,24 @@ dependencies {
generateTypeScript createTSGeneratorConfigForModel("src/model.ts")
+def generateTypeScriptTask = tasks.named("generateTypeScript") {
+ // Work around typescript-generator exposing non-serializable configuration objects as Gradle task inputs.
+ doNotTrackState("typescript-generator uses non-serializable task input types")
+}
+
tasks.register('npmBuild', Exec) {
mustRunAfter npmClean
dependsOn getYarnInstallTask()
commandLine npmCommand("yarn"), "run", "build"
}
-build.dependsOn generateTypeScript, npmBuild
-npmBuild.dependsOn generateTypeScript
+tasks.named("build") {
+ dependsOn generateTypeScriptTask, tasks.named("npmBuild")
+}
+
+tasks.named("npmBuild") {
+ dependsOn generateTypeScriptTask
+}
clean {
doLast {
diff --git a/ui/component/rest/build.gradle b/ui/component/rest/build.gradle
index f7bf0045c..bcf076f02 100644
--- a/ui/component/rest/build.gradle
+++ b/ui/component/rest/build.gradle
@@ -28,9 +28,16 @@ dependencies {
//project.task(Collections.singletonMap(Task.TASK_TYPE, cz.habarta.typescript.generator.gradle.GenerateTask), "generateTypescriptModelInfo")
//generateTypescriptModelInfo createTSGeneratorConfigForModel("$buildDir/model.ts")
+generateTypeScript createTSGeneratorConfigForClient(
+ "src/restclient.ts",
+ new File("${project(":ui:component:model").projectDir}/src/typescript-generator-info.json")
+)
-generateTypeScript createTSGeneratorConfigForClient("src/restclient.ts", new File("${project(":ui:component:model").projectDir}/src/typescript-generator-info.json"))
-generateTypeScript.dependsOn resolveTask(":ui:component:model:generateTypeScript")
+def generateTypeScriptTask = tasks.named("generateTypeScript") {
+ // Work around typescript-generator exposing non-serializable configuration objects as Gradle task inputs.
+ doNotTrackState("typescript-generator uses non-serializable task input types")
+ dependsOn resolveTask(":ui:component:model:generateTypeScript")
+}
clean {
doLast {
@@ -47,8 +54,13 @@ tasks.register('npmBuild', Exec) {
commandLine npmCommand("yarn"), "run", "build"
}
-build.dependsOn generateTypeScript, npmBuild
-npmBuild.dependsOn generateTypeScript
+tasks.named("build") {
+ dependsOn generateTypeScriptTask, tasks.named("npmBuild")
+}
+
+tasks.named("npmBuild") {
+ dependsOn generateTypeScriptTask
+}
tasks.register('prepareUi') {
dependsOn clean, build, npmPrepare