ocp-viewer-core 1.0.1 → 1.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ocp-viewer-core",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Shared viewer policy for ocp_vscode, ocp_viewer, Jupyter CadQuery and build123d Studio",
   "type": "module",
   "main": "src/index.js",

package/src/index.js

@@ -63,3 +63,6 @@ export { createNotifier, EVENT_KEYS } from "./notify.js";
 // The splash. Data rather than policy, and here for the same reason the policy
 // is: every client shows it, and four of them had their own copy.
 export { logo } from "./logo.js";
+
+// The JavaScript half's version, for the major.minor handshake with Python.
+export { VERSION } from "./version.js";

package/src/page.js

@@ -36,9 +36,40 @@ import { createNotifier } from "./notify.js";
 import { buildDisplayOptions, preset } from "./options.js";
 import { createRenderer } from "./render.js";
 import { currentStates, restoreStates } from "./states.js";
+import { VERSION } from "./version.js";
 
 const MIN_WIDTH = 450;
 
+// The version handshake: the Python half sends `_core_version` in every
+// model's config, and major.minor is the contract - the patch level is each
+// half's own. Warned once per page, loudly, because a contract mismatch shows
+// up as the vaguest of symptoms otherwise: an option that does nothing, a key
+// nobody answers.
+let versionWarned = false;
+
+function consumeCoreVersion(config, send) {
+    if (config == null || config._core_version === undefined) {
+        return;
+    }
+    const python = String(config._core_version);
+    delete config._core_version;
+    if (versionWarned) {
+        return;
+    }
+    const [pyMajor, pyMinor] = python.split(".");
+    const [jsMajor, jsMinor] = VERSION.split(".");
+    if (pyMajor !== jsMajor || pyMinor !== jsMinor) {
+        versionWarned = true;
+        const msg =
+            `ocp-viewer-core version mismatch: Python ${python}, JavaScript ${VERSION} - ` +
+            "major.minor must match; update the older side";
+        console.error(msg);
+        if (send != null) {
+            send("log", msg);
+        }
+    }
+}
+
 /**
  * Build the page.
  *
@@ -323,6 +354,11 @@ export function createPage({
     function handleMessage(message) {
         var data = message;
 
+        // Before anything reads the config: take the Python half's version
+        // out of it and check the contract, so `_core_version` never reaches
+        // applyConfig as an unknown key.
+        consumeCoreVersion(data?.config, send);
+
         if (data.type === "logo") {
             // The splash lives in the core, so a host asks for it by name and
             // sends only what it alone knows: its theme, its tree width and

package/src/version.js

@@ -0,0 +1,27 @@
+/**
+ * The JavaScript half's own version.
+ *
+ * The Python half sends its version with every model, and page.js compares
+ * the two here: major.minor is the contract and must match, the patch level
+ * is each half's own. Kept in step with js/package.json by `make bump-js` -
+ * a source constant because the packages ship as plain modules, so there is
+ * no build step that could inject it.
+ */
+
+/*
+   Copyright 2026 Bernhard Walter
+
+   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.
+*/
+
+export const VERSION = "1.0.2";