Create WEBIMAGE_PREVIEW distribution in sdk

Replaces the SVM_WASM_API distribution and is included automatically on
the boot classpath

Author: patrick96

sdk/mx.sdk/mx_sdk.py

@@ -159,7 +159,7 @@ def upx(args):
     third_party_license_files=[],
     dependencies=['sdkc'],
     jar_distributions=[],
-    boot_jars=['sdk:NATIVEIMAGE', 'sdk:NATIVEIMAGE_LIBGRAAL'],
+    boot_jars=['sdk:NATIVEIMAGE', 'sdk:NATIVEIMAGE_LIBGRAAL', 'sdk:WEBIMAGE_PREVIEW'],
     stability="supported",
 )
 mx_sdk_vm.register_graalvm_component(graalvm_sdk_native_image_component)

sdk/mx.sdk/suite.py

@@ -456,6 +456,16 @@
       "javaCompliance" : "21+"
     },
 
+    "org.graalvm.webimage.api": {
+        "subDir": "src",
+        "sourceDirs": ["src"],
+        "dependencies": [],
+        "javaCompliance": "21+",
+        "spotbugs": "true",
+        "workingSets": "SDK",
+        "checkstyle": "org.graalvm.word",
+    },
+
     "com.oracle.svm.core.annotate" : {
       "subDir" : "src",
       "sourceDirs" : ["src"],
@@ -906,6 +916,25 @@ class UniversalDetector {
       },
     },
 
+    "WEBIMAGE_PREVIEW": {
+      "subDir": "src",
+      "dependencies": [
+        "org.graalvm.webimage.api",
+      ],
+      "distDependencies": [],
+      "moduleInfo": {
+        "name": "org.graalvm.webimage.api",
+        "exports": [
+          "org.graalvm.webimage.api",
+        ],
+      },
+      "description": "The JavaScript interoperability API for GraalVM Web Image. This API is currently in preview and subject to change at any time.",
+      "maven": {
+        "artifactId": "webimage-preview",
+        "tag": ["default", "public"],
+      },
+    },
+
     "POLYGLOT_VERSION": {
       "type": "dir",
       "platformDependent": False,

sdk/src/org.graalvm.webimage.api/OWNERS.toml

@@ -0,0 +1,7 @@
+[[rule]]
+files = "*"
+all = [
+    "[email protected]",
+    "[email protected]",
+    "[email protected]",
+]

sdk/src/org.graalvm.webimage.api/src/org/graalvm/webimage/api/package-info.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * The Universal Permissive License (UPL), Version 1.0
+ *
+ * Subject to the condition set forth below, permission is hereby granted to any
+ * person obtaining a copy of this software, associated documentation and/or
+ * data (collectively the "Software"), free of charge and under any and all
+ * copyright rights in the Software, and any and all patent rights owned or
+ * freely licensable by each licensor hereunder covering either (i) the
+ * unmodified Software as contributed to or provided by such licensor, or (ii)
+ * the Larger Works (as defined below), to deal in both
+ *
+ * (a) the Software, and
+ *
+ * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
+ * one is included with the Software each a "Larger Work" to which the Software
+ * is contributed by such licensors),
+ *
+ * without restriction, including without limitation the rights to copy, create
+ * derivative works of, display, perform, and distribute the Software and make,
+ * use, sell, offer for sale, import, export, have made, and have sold the
+ * Software and the Larger Work(s), and to sublicense the foregoing rights on
+ * either these or other terms.
+ *
+ * This license is subject to the following condition:
+ *
+ * The above copyright notice and either this complete permission notice or at a
+ * minimum a reference to the UPL must be included in all copies or substantial
+ * portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * This package provides an interface between Java code and the embedding JavaScript code.
+ * <p>
+ * This functionality is limited to the WebAssembly backend for Native Image.
+ * <p>
+ * Any functionality specified here is experimental, subject to change, and may not fully work yet.
+ *
+ * @since 25.0
+ */
+package org.graalvm.webimage.api;

web-image/mx.web-image/mx_web_image.py

@@ -58,7 +58,6 @@
 web_image_builder = "web-image:SVM_WASM"
 web_image_builder_jars = [
     web_image_builder,
-    "web-image:SVM_WASM_API",
     "web-image:SVM_WASM_JIMFS",
     "web-image:SVM_WASM_GUAVA",
     "web-image:WEBIMAGE_CLOSURE_SUPPORT",
@@ -472,7 +471,7 @@ def get_launcher_flags(names: [str], cp_suffix: str = None) -> [str]:
     (distributions, projects) with web image.
 
     Many internal distributions directly or indirectly depend on jars in the image builder itself
-    (e.g. svm-wasm-api.jar), which cannot be passed to the launcher again.
+    (e.g. svm-wasm.jar), which cannot be passed to the launcher again.
     Because of that we omit all the flags required for the image builder jars and their dependencies (since the image
     builder will already have the proper paths set up for those).
 
@@ -753,7 +752,6 @@ def create_web_image_macro_builder(
     priority=0,
     builder_jar_distributions=[
         "web-image:SVM_WASM",
-        "web-image:SVM_WASM_API",
         "web-image:SVM_WASM_JIMFS",
         "web-image:SVM_WASM_GUAVA",
     ],

web-image/mx.web-image/suite.py

@@ -89,7 +89,7 @@
                 "compiler:GRAAL",
                 "substratevm:SVM",
                 "substratevm:SVM_CONFIGURE",
-                "org.graalvm.webimage.api",
+                "sdk:WEBIMAGE_PREVIEW",
                 "SVM_WASM_JIMFS",
             ],
             "requires": [
@@ -116,17 +116,6 @@
             "spotbugsIgnoresGenerated": True,
             "checkPackagePrefix": False,
         },
-        "org.graalvm.webimage.api": {
-            "subDir": "src",
-            "sourceDirs": ["src"],
-            "dependencies": [],
-            "javaCompliance": "21+",
-            "spotbugs": "true",
-            "workingSets": "web-image",
-            "annotationProcessors": ["compiler:GRAAL_PROCESSOR"],
-            "checkstyle": "com.oracle.svm.webimage",
-            "spotbugsIgnoresGenerated": True,
-        },
         "com.oracle.svm.webimage.tools": {
             "subDir": "src",
             "sourceDirs": [
@@ -160,7 +149,6 @@
             "sourceDirs": ["src"],
             "dependencies": [
                 "substratevm:SVM",
-                "SVM_WASM_API",
                 "WEBIMAGE_LIBRARY_SUPPORT",
                 "mx:JUNIT",
                 "NET_JAVA_HTML",
@@ -281,15 +269,14 @@
             ],
             "distDependencies": [
                 "substratevm:SVM",
-                "SVM_WASM_API",
+                "sdk:WEBIMAGE_PREVIEW",
                 "SVM_WASM_JIMFS",
             ],
             "moduleInfo": {
                 "name": "org.graalvm.extraimage.builder",
                 "requires": [
                     "org.graalvm.nativeimage.pointsto",
                     "org.graalvm.nativeimage.builder",
-                    "org.graalvm.webimage.api",
                     "org.graalvm.collections",
                 ],
                 "opens": [
@@ -307,20 +294,6 @@
             },
             "maven": False,
         },
-        "SVM_WASM_API": {
-            "subDir": "src",
-            "dependencies": [
-                "org.graalvm.webimage.api",
-            ],
-            "distDependencies": [],
-            "moduleInfo": {
-                "name": "org.graalvm.webimage.api",
-                "exports": [
-                    "org.graalvm.webimage.api",
-                ],
-            },
-            "maven": False,
-        },
         "NATIVE_IMAGE_WASM_SUPPORT": {
             "native": True,
             "description": "Macro for the Native Image Wasm Backend",
@@ -349,7 +322,6 @@
                 "requires": [
                     "jdk.graal.compiler",
                     "org.graalvm.nativeimage.builder",
-                    "org.graalvm.webimage.api",
                 ],
             },
         },
@@ -413,7 +385,6 @@
                 "com.oracle.svm.webimage.jtt",
             ],
             "distDependencies": [
-                "SVM_WASM_API",
                 "WEBIMAGE_LIBRARY_SUPPORT",
             ],
             "exclude": [