Introducing file versioning

packages/schema/src/doc.ts

@@ -5,6 +5,7 @@ import * as Y from 'yjs';
 
 import { IJCadObject, IJCadOptions } from './_interface/jcad';
 import {
+  CURRENT_SCHEMA_VERSION,
   IDict,
   IJcadObjectDocChange,
   IJupyterCadDoc,
@@ -35,7 +36,7 @@ export class JupyterCadDoc
   }
 
   get version(): string {
-    return '0.1.0';
+    return CURRENT_SCHEMA_VERSION;
   }
 
   get objects(): Array<IJCadObject> {

packages/schema/src/interfaces.ts

@@ -19,6 +19,8 @@ import {
   IJCadOptions
 } from './_interface/jcad';
 
+export const CURRENT_SCHEMA_VERSION = "3.0.0";
+
 export interface IDict<T = any> {
   [key: string]: T;
 }

packages/schema/src/schema/jcad.json

@@ -4,6 +4,10 @@
   "required": ["objects"],
   "additionalProperties": false,
   "properties": {
+    "schemaVersion": {
+      "type": "string",
+      "default": "3.0.0"
+    },
     "objects": {
       "$ref": "#/definitions/jcadModel"
     },

python/jupytercad_core/jupytercad_core/constants.py

@@ -0,0 +1 @@
+CURRENT_SCHEMA_VERSION = "3.0.0"

python/jupytercad_core/jupytercad_core/handlers.py

@@ -5,6 +5,8 @@
 from jupyter_server.utils import url_path_join, ApiPath, to_os_path
 import tornado
 
+from .constants import CURRENT_SCHEMA_VERSION
+
 
 class JCadExportHandler(APIHandler):
     @tornado.web.authenticated
@@ -22,6 +24,7 @@ def post(self):
             file_content = fobj.read()
 
         jcad = dict(
+            schemaVersion=CURRENT_SCHEMA_VERSION,
             objects=[
                 dict(
                     name=Path(export_name).stem,

python/jupytercad_core/jupytercad_core/jcad_ydoc.py

@@ -5,6 +5,8 @@
 from pycrdt import Array, Map, Text
 from jupyter_ydoc.ybasedoc import YBaseDoc
 
+from .constants import CURRENT_SCHEMA_VERSION
+
 
 class YJCad(YBaseDoc):
     def __init__(self, *args, **kwargs):
@@ -17,7 +19,7 @@ def __init__(self, *args, **kwargs):
         self.undo_manager.expand_scope(self._yobjects)
 
     def version(self) -> str:
-        return "0.1.0"
+        return CURRENT_SCHEMA_VERSION
 
     def get(self) -> str:
         """
@@ -30,7 +32,7 @@ def get(self) -> str:
         meta = self._ymetadata.to_py()
         outputs = self._youtputs.to_py()
         return json.dumps(
-            dict(objects=objects, options=options, metadata=meta, outputs=outputs),
+            dict(schemaVersion=CURRENT_SCHEMA_VERSION, objects=objects, options=options, metadata=meta, outputs=outputs),
             indent=2,
             sort_keys=True,
         )
@@ -42,6 +44,12 @@ def set(self, value: str) -> None:
         :type value: Any
         """
         valueDict = json.loads(value)
+
+        # Assuming file version 3.0.0 if the version is not specified
+        file_version = valueDict["schemaVersion"] if "schemaVersion" in valueDict else "3.0.0"
+        if file_version != CURRENT_SCHEMA_VERSION:
+            raise ValueError(f"Cannot load file version {file_version}")
+
         newObj = []
         for obj in valueDict["objects"]:
             newObj.append(Map(obj))

python/jupytercad_core/jupytercad_core/step_ydoc.py

@@ -5,14 +5,16 @@
 from pycrdt import Text
 from jupyter_ydoc.ybasedoc import YBaseDoc
 
+from .constants import CURRENT_SCHEMA_VERSION
+
 
 class YSTEP(YBaseDoc):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self._ydoc["source"] = self._ysource = Text()
 
     def version(self) -> str:
-        return "0.1.0"
+        return CURRENT_SCHEMA_VERSION
 
     def get(self) -> str:
         """

python/jupytercad_core/jupytercad_core/stl_ydoc.py

@@ -5,14 +5,16 @@
 from pycrdt import Text
 from jupyter_ydoc.ybasedoc import YBaseDoc
 
+from .constants import CURRENT_SCHEMA_VERSION
+
 
 class YSTL(YBaseDoc):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self._ydoc["source"] = self._ysource = Text()
 
     def version(self) -> str:
-        return "0.1.0"
+        return CURRENT_SCHEMA_VERSION
 
     def get(self) -> str:
         """

python/jupytercad_core/src/jcadplugin/plugins.ts

@@ -4,6 +4,7 @@ import {
 } from '@jupyter/collaborative-drive';
 import { logoIcon, CommandIDs as BaseCommandIDs } from '@jupytercad/base';
 import {
+  CURRENT_SCHEMA_VERSION,
   IAnnotationModel,
   IAnnotationToken,
   IJCadExternalCommandRegistry,
@@ -146,7 +147,7 @@ const activate = (
         format: 'text',
         size: undefined,
         content:
-          '{\n\t"objects": [],\n\t"options": {},\n\t"metadata": {},\n\t"outputs": {}}'
+          `{\n\t"schemaVersion": "${CURRENT_SCHEMA_VERSION}",\n\t"objects": [],\n\t"options": {},\n\t"metadata": {},\n\t"outputs": {}}`
       });
 
       // Open the newly created file with the 'Editor'

python/jupytercad_core/src/stepplugin/model.ts

@@ -1,4 +1,5 @@
 import {
+  CURRENT_SCHEMA_VERSION,
   IJCadObject,
   IJcadObjectDocChange,
   IJupyterCadDoc,
@@ -22,7 +23,7 @@ export class JupyterCadStepDoc extends JupyterCadDoc {
   }
 
   get version(): string {
-    return '0.1.0';
+    return CURRENT_SCHEMA_VERSION;
   }
 
   get objectsChanged(): ISignal<IJupyterCadDoc, IJcadObjectDocChange> {

python/jupytercad_core/src/stlplugin/model.ts

@@ -1,4 +1,5 @@
 import {
+  CURRENT_SCHEMA_VERSION,
   IJCadObject,
   IJcadObjectDocChange,
   IJupyterCadDoc,
@@ -22,7 +23,7 @@ export class JupyterCadStlDoc extends JupyterCadDoc {
   }
 
   get version(): string {
-    return '0.1.0';
+    return CURRENT_SCHEMA_VERSION;
   }
 
   get objectsChanged(): ISignal<IJupyterCadDoc, IJcadObjectDocChange> {