8.3.0 API updates

.github/workflows/pr-build.yml

@@ -8,12 +8,12 @@ jobs:
       - uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
-          java-version: 11
+          java-version: 17
           cache: 'gradle'
       - name: Build
         run: ./gradlew build
       - name: Upload Unsigned Module
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v5
         with:
           name: ignition-extensions-unsigned
           path: build/Ignition-Extensions.unsigned.modl

.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
       - uses: actions/setup-java@v4
         with:
           distribution: 'zulu'
-          java-version: 11
+          java-version: 17
           cache: 'gradle'
       - name: Deserialize signing certs
         run: |

.gitignore

@@ -3,3 +3,4 @@
 .gradle/
 
 local.properties
+/common/.jython_cache

build-logic/build.gradle.kts

@@ -0,0 +1,3 @@
+plugins {
+    `kotlin-dsl` apply false
+}

build-logic/conventions/build.gradle.kts

@@ -0,0 +1,3 @@
+plugins {
+    `kotlin-dsl`
+}

build-logic/conventions/src/main/kotlin/imdc/build/base.gradle.kts

@@ -0,0 +1,15 @@
+package imdc.build
+
+
+group = "org.imdc.extensions"
+
+plugins {
+    base
+}
+
+repositories {
+    mavenCentral()
+    gradlePluginPortal()
+    maven(url = "https://nexus.inductiveautomation.com/repository/public/")
+    maven(url = "https://nexus.inductiveautomation.com/repository/inductiveautomation-releases/")
+}

build-logic/conventions/src/main/kotlin/imdc/build/ignition-module-scope.gradle.kts

@@ -0,0 +1,47 @@
+package imdc.build
+
+import libs
+import org.jetbrains.kotlin.gradle.dsl.KotlinProjectExtension
+
+plugins {
+    id("imdc.build.base")
+    alias(libs.plugins.kotlin)
+    `java-library`
+
+    alias(libs.plugins.spotless)
+}
+
+version = project.parent?.version ?: "0.0.0-SNAPSHOT"
+
+val jvmLanguageVersion = libs.versions.java.map { JavaLanguageVersion.of(it) }
+
+configure<KotlinProjectExtension> {
+    jvmToolchain {
+        languageVersion = jvmLanguageVersion
+    }
+}
+
+configure<JavaPluginExtension> {
+    toolchain {
+        languageVersion = jvmLanguageVersion
+    }
+}
+
+spotless {
+    ratchetFrom("HEAD")
+    format("misc") {
+        target("*.gradle", ".gitattributes", ".gitignore")
+        trimTrailingWhitespace()
+        endWithNewline()
+    }
+    java {
+        palantirJavaFormat()
+        formatAnnotations()
+    }
+    kotlin {
+        ktlint()
+    }
+    kotlinGradle {
+        ktlint()
+    }
+}

build-logic/conventions/src/main/kotlin/imdc/test/junit-tests.gradle.kts

@@ -0,0 +1,8 @@
+package imdc.test
+
+tasks {
+    withType<Test> {
+        useJUnitPlatform()
+        jvmArgs = listOf("--add-opens", "java.base/java.io=ALL-UNNAMED")
+    }
+}

build-logic/settings.gradle.kts

@@ -0,0 +1,19 @@
+rootProject.name = "build-logic"
+
+plugins {
+    id("dev.panuszewski.typesafe-conventions") version "0.10.0"
+}
+
+dependencyResolutionManagement {
+    repositories {
+        mavenCentral()
+        gradlePluginPortal()
+        maven(url = "https://nexus.inductiveautomation.com/repository/public/")
+        maven(url = "https://nexus.inductiveautomation.com/repository/inductiveautomation-releases/")
+        maven(url = "https://nexus.inductiveautomation.com/repository/inductiveautomation-snapshots/")
+    }
+}
+
+include(
+    "conventions",
+)

build.gradle.kts

@@ -1,20 +1,7 @@
 plugins {
-    alias(libs.plugins.kotlin)
     alias(libs.plugins.modl)
 }
 
-allprojects {
-    repositories {
-        mavenCentral()
-        maven("https://nexus.inductiveautomation.com/repository/public")
-    }
-}
-
-subprojects {
-    // cascade version, which will be set at command line in CI, down to subprojects
-    version = rootProject.version
-}
-
 ignitionModule {
     name = "Ignition Extensions"
     fileName = "Ignition-Extensions.modl"

client/build.gradle.kts

@@ -1,10 +1,5 @@
 plugins {
-    `java-library`
-    kotlin("jvm")
-}
-
-kotlin {
-    jvmToolchain(libs.versions.java.map(String::toInt).get())
+    id("imdc.build.ignition-module-scope")
 }
 
 dependencies {

client/src/main/kotlin/org/imdc/extensions/client/ClientProjectExtensions.kt

@@ -1,13 +1,13 @@
 package org.imdc.extensions.client
 
 import com.inductiveautomation.ignition.client.model.ClientContext
-import com.inductiveautomation.ignition.common.project.Project
-import com.inductiveautomation.ignition.common.script.hints.ScriptFunction
+import com.inductiveautomation.ignition.common.resourcecollection.ResourceCollection
+import com.inductiveautomation.ignition.common.script.hints.JythonElement
 import org.imdc.extensions.common.ProjectExtensions
 
 class ClientProjectExtensions(private val context: ClientContext) : ProjectExtensions {
-    @ScriptFunction(docBundlePrefix = "ClientProjectExtensions")
-    override fun getProject(): Project {
+    @JythonElement(docBundlePrefix = "ClientProjectExtensions")
+    override fun getProject(): ResourceCollection {
         return requireNotNull(context.project)
     }
 }

common/build.gradle.kts

@@ -1,10 +1,6 @@
 plugins {
-    `java-library`
-    kotlin("jvm")
-}
-
-kotlin {
-    jvmToolchain(libs.versions.java.map(String::toInt).get())
+    id("imdc.build.ignition-module-scope")
+    id("imdc.test.junit-tests")
 }
 
 dependencies {
@@ -13,10 +9,3 @@ dependencies {
     testImplementation(libs.bundles.kotest)
     testImplementation(libs.mockk)
 }
-
-tasks {
-    withType<Test> {
-        useJUnitPlatform()
-        jvmArgs = listOf("--add-opens", "java.base/java.io=ALL-UNNAMED")
-    }
-}

common/src/main/java/org/imdc/extensions/common/UtilitiesExtensions.java

@@ -21,7 +21,7 @@
 import com.inductiveautomation.ignition.common.script.PyArgParser;
 import com.inductiveautomation.ignition.common.script.ScriptContext;
 import com.inductiveautomation.ignition.common.script.builtin.KeywordArgs;
-import com.inductiveautomation.ignition.common.script.hints.ScriptFunction;
+import com.inductiveautomation.ignition.common.script.hints.JythonElement;
 import com.inductiveautomation.ignition.common.tags.model.TagPath;
 import com.inductiveautomation.ignition.common.tags.paths.parser.TagPathParser;
 import org.apache.commons.lang3.tuple.Pair;
@@ -41,13 +41,13 @@ public UtilitiesExtensions(CommonContext context) {
         this.context = context;
     }
 
-    @ScriptFunction(docBundlePrefix = "UtilitiesExtensions")
+    @JythonElement(docBundlePrefix = "UtilitiesExtensions")
     @UnsafeExtension
     public CommonContext getContext() {
         return context;
     }
 
-    @ScriptFunction(docBundlePrefix = "UtilitiesExtensions")
+    @JythonElement(docBundlePrefix = "UtilitiesExtensions")
     @KeywordArgs(names = {"object"}, types = {PyObject.class})
     public PyObject deepCopy(PyObject[] args, String[] keywords) {
         PyArgParser parsedArgs = PyArgParser.parseArgs(args, keywords, this.getClass(), "deepCopy");
@@ -76,7 +76,7 @@ private static PyObject recursiveConvert(@NotNull PyObject object) {
         }
     }
 
-    @ScriptFunction(docBundlePrefix = "UtilitiesExtensions")
+    @JythonElement(docBundlePrefix = "UtilitiesExtensions")
     @KeywordArgs(names = {"expression"}, types = {String.class})
     public QualifiedValue evalExpression(PyObject[] args, String[] keywords) throws Exception {
         if (args.length == 0) {
@@ -116,7 +116,7 @@ public Expression createBoundExpression(String reference) throws RuntimeExceptio
                 return new ConstantExpression(keywords.get(reference));
             } else {
                 try {
-                    TagPath path = TagPathParser.parse(ScriptContext.defaultTagProvider(), reference);
+                    TagPath path = TagPathParser.parse(ScriptContext.getDefaultTagProvider().orElseThrow(), reference);
                     var tagValues = context.getTagManager().readAsync(List.of(path)).get(30, TimeUnit.SECONDS);
                     return new ConstantExpression(tagValues.get(0).getValue());
                 } catch (IOException | InterruptedException | ExecutionException | TimeoutException e) {
@@ -131,7 +131,7 @@ public FunctionFactory getFunctionFactory() {
         }
     }
 
-    @ScriptFunction(docBundlePrefix = "UtilitiesExtensions")
+    @JythonElement(docBundlePrefix = "UtilitiesExtensions")
     public UUID getUUID4() {
         return UUID.randomUUID();
     }

common/src/main/kotlin/org/imdc/extensions/common/DatasetExtensions.kt

@@ -6,7 +6,7 @@ import com.inductiveautomation.ignition.common.TypeUtilities
 import com.inductiveautomation.ignition.common.script.PyArgParser
 import com.inductiveautomation.ignition.common.script.builtin.KeywordArgs
 import com.inductiveautomation.ignition.common.script.hints.ScriptArg
-import com.inductiveautomation.ignition.common.script.hints.ScriptFunction
+import com.inductiveautomation.ignition.common.script.hints.JythonElement
 import com.inductiveautomation.ignition.common.util.DatasetBuilder
 import com.inductiveautomation.ignition.common.xmlserialization.ClassNameResolver
 import org.apache.poi.ss.usermodel.Cell
@@ -35,7 +35,7 @@ import kotlin.streams.asSequence
 
 object DatasetExtensions {
     @Suppress("unused")
-    @ScriptFunction(docBundlePrefix = "DatasetExtensions")
+    @JythonElement(docBundlePrefix = "DatasetExtensions")
     @KeywordArgs(
         names = ["dataset", "mapper", "preserveColumnTypes"],
         types = [Dataset::class, PyFunction::class, Boolean::class],
@@ -74,7 +74,7 @@ object DatasetExtensions {
     }
 
     @Suppress("unused")
-    @ScriptFunction(docBundlePrefix = "DatasetExtensions")
+    @JythonElement(docBundlePrefix = "DatasetExtensions")
     @KeywordArgs(
         names = ["dataset", "filter"],
         types = [Dataset::class, PyFunction::class],
@@ -122,7 +122,7 @@ object DatasetExtensions {
     }
 
     @Suppress("unused")
-    @ScriptFunction(docBundlePrefix = "DatasetExtensions")
+    @JythonElement(docBundlePrefix = "DatasetExtensions")
     @KeywordArgs(
         names = ["dataset", "output", "includeTypes"],
         types = [Dataset::class, Appendable::class, Boolean::class],
@@ -221,7 +221,7 @@ object DatasetExtensions {
     }
 
     @Suppress("unused")
-    @ScriptFunction(docBundlePrefix = "DatasetExtensions")
+    @JythonElement(docBundlePrefix = "DatasetExtensions")
     @KeywordArgs(
         names = ["dataset", "filterNull"],
         types = [Dataset::class, Boolean::class],
@@ -253,7 +253,7 @@ object DatasetExtensions {
     }
 
     @Suppress("unused")
-    @ScriptFunction(docBundlePrefix = "DatasetExtensions")
+    @JythonElement(docBundlePrefix = "DatasetExtensions")
     @KeywordArgs(
         names = ["input", "headerRow", "sheetNumber", "firstRow", "lastRow", "firstColumn", "lastColumn", "typeOverrides"],
         types = [ByteArray::class, Int::class, Int::class, Int::class, Int::class, Int::class, Int::class, PyStringMap::class],
@@ -412,7 +412,7 @@ object DatasetExtensions {
     }
 
     @Suppress("unused")
-    @ScriptFunction(docBundlePrefix = "DatasetExtensions")
+    @JythonElement(docBundlePrefix = "DatasetExtensions")
     fun equals(
         @ScriptArg("dataset1") ds1: Dataset,
         @ScriptArg("dataset2") ds2: Dataset,
@@ -421,7 +421,7 @@ object DatasetExtensions {
     }
 
     @Suppress("unused")
-    @ScriptFunction(docBundlePrefix = "DatasetExtensions")
+    @JythonElement(docBundlePrefix = "DatasetExtensions")
     fun valuesEqual(
         @ScriptArg("dataset1") ds1: Dataset,
         @ScriptArg("dataset2") ds2: Dataset,
@@ -440,7 +440,7 @@ object DatasetExtensions {
     }
 
     @Suppress("unused")
-    @ScriptFunction(docBundlePrefix = "DatasetExtensions")
+    @JythonElement(docBundlePrefix = "DatasetExtensions")
     @JvmOverloads
     fun columnsEqual(
         @ScriptArg("dataset1") ds1: Dataset,
@@ -473,7 +473,7 @@ object DatasetExtensions {
         }
     }
 
-    @ScriptFunction(docBundlePrefix = "DatasetExtensions")
+    @JythonElement(docBundlePrefix = "DatasetExtensions")
     @KeywordArgs(
         names = ["**columns"],
         types = [KeywordArgs::class],

common/src/main/kotlin/org/imdc/extensions/common/ExtensionDocProvider.kt

@@ -2,6 +2,7 @@ package org.imdc.extensions.common
 
 import com.inductiveautomation.ignition.common.script.hints.PropertiesFileDocProvider
 import com.inductiveautomation.ignition.common.script.hints.ScriptFunctionDocProvider
+import com.inductiveautomation.ignition.common.script.typing.CompletionDescriptor
 import java.lang.reflect.Method
 
 private val propertiesFileDocProvider = PropertiesFileDocProvider()
@@ -13,20 +14,23 @@ private val WARNING = """
 """.trimIndent()
 
 object ExtensionDocProvider : ScriptFunctionDocProvider by propertiesFileDocProvider {
-    override fun getMethodDescription(path: String, method: Method): String {
-        val methodDescription: String? = propertiesFileDocProvider.getMethodDescription(path, method)
+    override fun getMethodDescriptor(path: String, method: Method): CompletionDescriptor.Method? {
+        val base = propertiesFileDocProvider.getMethodDescriptor(path, method)
+
         val unsafeAnnotation = method.getAnnotation<UnsafeExtension>()
 
-        return buildString {
-            if (unsafeAnnotation != null) {
+        return if (unsafeAnnotation != null) {
+            base?.copy(description = buildString {
                 append("<html><b>")
                 append(WARNING)
                 if (unsafeAnnotation.note.isNotEmpty()) {
                     append("<br>").append(unsafeAnnotation.note)
                 }
                 append("</b><br><br>")
-            }
-            append(methodDescription.orEmpty())
+                append(base.description.orEmpty())
+            })
+        } else {
+            base
         }
     }
 }

common/src/main/kotlin/org/imdc/extensions/common/ProjectExtensions.kt

@@ -1,7 +1,8 @@
 package org.imdc.extensions.common
 
-import com.inductiveautomation.ignition.common.project.Project
+import com.inductiveautomation.ignition.common.resourcecollection.ResourceCollection
+
 
 interface ProjectExtensions {
-    fun getProject(): Project
+    fun getProject(): ResourceCollection
 }