jupytergis-core 0.4.5__py3-none-any.whl → 0.5.0__py3-none-any.whl

jupytergis_core/_version.py

@@ -1,4 +1,4 @@
 # This file is auto-generated by Hatchling. As such, do not:
 #   - modify
 #   - track in version control e.g. be sure to add to .gitignore
-__version__ = VERSION = '0.4.5'
+__version__ = VERSION = '0.5.0'

jupytergis_core/jgis_ydoc.py

@@ -1,9 +1,11 @@
 import json
 from typing import Any, Callable
 from functools import partial
+from packaging.version import Version
 
 from pycrdt import Array, Map
 from jupyter_ydoc.ybasedoc import YBaseDoc
+from .schema import SCHEMA_VERSION
 
 
 class YJGIS(YBaseDoc):
@@ -16,7 +18,7 @@ class YJGIS(YBaseDoc):
         self._ydoc["metadata"] = self._ymetadata = Map()
 
     def version(self) -> str:
-        return "0.1.0"
+        return SCHEMA_VERSION
 
     def get(self) -> str:
         """
@@ -31,6 +33,7 @@ class YJGIS(YBaseDoc):
         layers_tree = self._ylayerTree.to_py()
         return json.dumps(
             dict(
+                schemaVersion=SCHEMA_VERSION,
                 layers=layers,
                 sources=sources,
                 options=options,
@@ -49,6 +52,15 @@ class YJGIS(YBaseDoc):
         """
         valueDict = json.loads(value)
 
+        # Assuming file version 0.5.0 if the version is not specified
+        file_version = (
+            Version(valueDict["schemaVersion"])
+            if "schemaVersion" in valueDict
+            else Version("0.5.0")
+        )
+        if file_version > Version(SCHEMA_VERSION):
+            raise ValueError(f"Cannot load file version {file_version}")
+
         with self._ydoc.transaction():
             self._ylayers.clear()
             self._ylayers.update(valueDict.get("layers", {}))

jupytergis_core/schema/__init__.py

@@ -0,0 +1,24 @@
+from .interfaces.project.jgis import *  # noqa
+
+from .interfaces.project.layers.rasterlayer import IRasterLayer  # noqa
+from .interfaces.project.layers.vectorlayer import IVectorLayer  # noqa
+from .interfaces.project.layers.vectorTileLayer import IVectorTileLayer  # noqa
+from .interfaces.project.layers.hillshadeLayer import IHillshadeLayer  # noqa
+from .interfaces.project.layers.imageLayer import IImageLayer  # noqa
+from .interfaces.project.layers.webGlLayer import IWebGlLayer  # noqa
+from .interfaces.project.layers.heatmapLayer import IHeatmapLayer  # noqa
+
+from .interfaces.project.sources.vectortilesource import IVectorTileSource  # noqa
+from .interfaces.project.sources.rastersource import IRasterSource  # noqa
+from .interfaces.geojsonsource import IGeoJSONSource  # noqa
+from .interfaces.project.sources.videoSource import IVideoSource  # noqa
+from .interfaces.project.sources.imageSource import IImageSource  # noqa
+from .interfaces.project.sources.geoTiffSource import IGeoTiffSource  # noqa
+from .interfaces.project.sources.rasterDemSource import IRasterDemSource  # noqa
+
+from .interfaces.processing.buffer import IBuffer  # noqa
+
+from .interfaces.export.exportGeojson import IExportGeoJSON  # noqa
+from .interfaces.export.exportGeotiff import IExportGeoTIFF  # noqa
+
+SCHEMA_VERSION = IJGISContent.model_fields["schemaVersion"].default  # noqa

jupytergis_core/schema/interfaces/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  schema
+#   timestamp: 2025-05-08T01:23:34+00:00

jupytergis_core/schema/interfaces/export/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  schema
+#   timestamp: 2025-05-08T01:23:34+00:00

jupytergis_core/schema/interfaces/export/exportGeojson.py

@@ -0,0 +1,18 @@
+# generated by datamodel-codegen:
+#   filename:  export/exportGeojson.json
+#   timestamp: 2025-05-08T01:23:34+00:00
+
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class IExportGeoJSON(BaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    exportFileName: str = Field(
+        ...,
+        description='The name of the exported GeoJSON file.',
+        title='GeoJSON File Name',
+    )

jupytergis_core/schema/interfaces/export/exportGeotiff.py

@@ -0,0 +1,28 @@
+# generated by datamodel-codegen:
+#   filename:  export/exportGeotiff.json
+#   timestamp: 2025-05-08T01:23:34+00:00
+
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict, Field, confloat
+
+
+class IExportGeoTIFF(BaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    exportFileName: str = Field(
+        ...,
+        description='The name of the exported GeoTIFF file.',
+        title='GeoTiFF File Name',
+    )
+    resolutionX: confloat(ge=1.0, le=10000.0) = Field(
+        ...,
+        description='The width resolution for the raster export.',
+        title='Resolution (Width)',
+    )
+    resolutionY: confloat(ge=1.0, le=10000.0) = Field(
+        ...,
+        description='The height resolution for the raster export.',
+        title='Resolution (Height)',
+    )

jupytergis_core/schema/interfaces/geojson.py

@@ -0,0 +1,502 @@
+# generated by datamodel-codegen:
+#   filename:  geojson.json
+#   timestamp: 2025-05-08T01:23:34+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Any, Dict, List, Optional, Union
+
+from pydantic import BaseModel, Field, RootModel
+
+
+class Type(Enum):
+    Point = 'Point'
+
+
+class GeoJSON1(BaseModel):
+    type: Type
+    coordinates: List[float] = Field(..., min_length=2)
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type1(Enum):
+    LineString = 'LineString'
+
+
+class Coordinate(RootModel[List[float]]):
+    root: List[float]
+
+
+class GeoJSON2(BaseModel):
+    type: Type1
+    coordinates: List[Coordinate] = Field(..., min_length=2)
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type2(Enum):
+    Polygon = 'Polygon'
+
+
+class GeoJSON3(BaseModel):
+    type: Type2
+    coordinates: List[List[Coordinate]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type3(Enum):
+    MultiPoint = 'MultiPoint'
+
+
+class GeoJSON4(BaseModel):
+    type: Type3
+    coordinates: List[List[float]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type4(Enum):
+    MultiLineString = 'MultiLineString'
+
+
+class GeoJSON5(BaseModel):
+    type: Type4
+    coordinates: List[List[Coordinate]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type5(Enum):
+    MultiPolygon = 'MultiPolygon'
+
+
+class GeoJSON6(BaseModel):
+    type: Type5
+    coordinates: List[List[List[Coordinate]]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type6(Enum):
+    GeometryCollection = 'GeometryCollection'
+
+
+class Type7(Enum):
+    Point = 'Point'
+
+
+class Geometries(BaseModel):
+    type: Type7
+    coordinates: List[float] = Field(..., min_length=2)
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type8(Enum):
+    LineString = 'LineString'
+
+
+class Geometries1(BaseModel):
+    type: Type8
+    coordinates: List[Coordinate] = Field(..., min_length=2)
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type9(Enum):
+    Polygon = 'Polygon'
+
+
+class Geometries2(BaseModel):
+    type: Type9
+    coordinates: List[List[Coordinate]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type10(Enum):
+    MultiPoint = 'MultiPoint'
+
+
+class Geometries3(BaseModel):
+    type: Type10
+    coordinates: List[List[float]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type11(Enum):
+    MultiLineString = 'MultiLineString'
+
+
+class Geometries4(BaseModel):
+    type: Type11
+    coordinates: List[List[Coordinate]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type12(Enum):
+    MultiPolygon = 'MultiPolygon'
+
+
+class Geometries5(BaseModel):
+    type: Type12
+    coordinates: List[List[List[Coordinate]]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class GeoJSON7(BaseModel):
+    type: Type6
+    geometries: List[
+        Union[
+            Geometries, Geometries1, Geometries2, Geometries3, Geometries4, Geometries5
+        ]
+    ]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type13(Enum):
+    Feature = 'Feature'
+
+
+class Type14(Enum):
+    Point = 'Point'
+
+
+class Geometry(BaseModel):
+    type: Type14
+    coordinates: List[float] = Field(..., min_length=2)
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type15(Enum):
+    LineString = 'LineString'
+
+
+class Geometry1(BaseModel):
+    type: Type15
+    coordinates: List[Coordinate] = Field(..., min_length=2)
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type16(Enum):
+    Polygon = 'Polygon'
+
+
+class Geometry2(BaseModel):
+    type: Type16
+    coordinates: List[List[Coordinate]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type17(Enum):
+    MultiPoint = 'MultiPoint'
+
+
+class Geometry3(BaseModel):
+    type: Type17
+    coordinates: List[List[float]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type18(Enum):
+    MultiLineString = 'MultiLineString'
+
+
+class Geometry4(BaseModel):
+    type: Type18
+    coordinates: List[List[Coordinate]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type19(Enum):
+    MultiPolygon = 'MultiPolygon'
+
+
+class Geometry5(BaseModel):
+    type: Type19
+    coordinates: List[List[List[Coordinate]]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type20(Enum):
+    GeometryCollection = 'GeometryCollection'
+
+
+class Type21(Enum):
+    Point = 'Point'
+
+
+class Geometries6(BaseModel):
+    type: Type21
+    coordinates: List[float] = Field(..., min_length=2)
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type22(Enum):
+    LineString = 'LineString'
+
+
+class Geometries7(BaseModel):
+    type: Type22
+    coordinates: List[Coordinate] = Field(..., min_length=2)
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type23(Enum):
+    Polygon = 'Polygon'
+
+
+class Geometries8(BaseModel):
+    type: Type23
+    coordinates: List[List[Coordinate]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type24(Enum):
+    MultiPoint = 'MultiPoint'
+
+
+class Geometries9(BaseModel):
+    type: Type24
+    coordinates: List[List[float]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type25(Enum):
+    MultiLineString = 'MultiLineString'
+
+
+class Geometries10(BaseModel):
+    type: Type25
+    coordinates: List[List[Coordinate]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type26(Enum):
+    MultiPolygon = 'MultiPolygon'
+
+
+class Geometries11(BaseModel):
+    type: Type26
+    coordinates: List[List[List[Coordinate]]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Geometry6(BaseModel):
+    type: Type20
+    geometries: List[
+        Union[
+            Geometries6,
+            Geometries7,
+            Geometries8,
+            Geometries9,
+            Geometries10,
+            Geometries11,
+        ]
+    ]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class GeoJSON8(BaseModel):
+    type: Type13
+    id: Optional[Union[float, str]] = None
+    properties: Optional[Dict[str, Any]] = None
+    geometry: Optional[
+        Union[
+            Geometry, Geometry1, Geometry2, Geometry3, Geometry4, Geometry5, Geometry6
+        ]
+    ] = None
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type27(Enum):
+    FeatureCollection = 'FeatureCollection'
+
+
+class Type28(Enum):
+    Feature = 'Feature'
+
+
+class Type29(Enum):
+    Point = 'Point'
+
+
+class Geometry7(BaseModel):
+    type: Type29
+    coordinates: List[float] = Field(..., min_length=2)
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type30(Enum):
+    LineString = 'LineString'
+
+
+class Geometry8(BaseModel):
+    type: Type30
+    coordinates: List[Coordinate] = Field(..., min_length=2)
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type31(Enum):
+    Polygon = 'Polygon'
+
+
+class Geometry9(BaseModel):
+    type: Type31
+    coordinates: List[List[Coordinate]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type32(Enum):
+    MultiPoint = 'MultiPoint'
+
+
+class Geometry10(BaseModel):
+    type: Type32
+    coordinates: List[List[float]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type33(Enum):
+    MultiLineString = 'MultiLineString'
+
+
+class Geometry11(BaseModel):
+    type: Type33
+    coordinates: List[List[Coordinate]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type34(Enum):
+    MultiPolygon = 'MultiPolygon'
+
+
+class Geometry12(BaseModel):
+    type: Type34
+    coordinates: List[List[List[Coordinate]]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type35(Enum):
+    GeometryCollection = 'GeometryCollection'
+
+
+class Type36(Enum):
+    Point = 'Point'
+
+
+class Geometries12(BaseModel):
+    type: Type36
+    coordinates: List[float] = Field(..., min_length=2)
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type37(Enum):
+    LineString = 'LineString'
+
+
+class Geometries13(BaseModel):
+    type: Type37
+    coordinates: List[Coordinate] = Field(..., min_length=2)
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type38(Enum):
+    Polygon = 'Polygon'
+
+
+class Geometries14(BaseModel):
+    type: Type38
+    coordinates: List[List[Coordinate]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type39(Enum):
+    MultiPoint = 'MultiPoint'
+
+
+class Geometries15(BaseModel):
+    type: Type39
+    coordinates: List[List[float]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type40(Enum):
+    MultiLineString = 'MultiLineString'
+
+
+class Geometries16(BaseModel):
+    type: Type40
+    coordinates: List[List[Coordinate]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Type41(Enum):
+    MultiPolygon = 'MultiPolygon'
+
+
+class Geometries17(BaseModel):
+    type: Type41
+    coordinates: List[List[List[Coordinate]]]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Geometry13(BaseModel):
+    type: Type35
+    geometries: List[
+        Union[
+            Geometries12,
+            Geometries13,
+            Geometries14,
+            Geometries15,
+            Geometries16,
+            Geometries17,
+        ]
+    ]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class Feature(BaseModel):
+    type: Type28
+    id: Optional[Union[float, str]] = None
+    properties: Optional[Dict[str, Any]] = None
+    geometry: Optional[
+        Union[
+            Geometry7,
+            Geometry8,
+            Geometry9,
+            Geometry10,
+            Geometry11,
+            Geometry12,
+            Geometry13,
+        ]
+    ] = None
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class GeoJSON9(BaseModel):
+    type: Type27
+    features: List[Feature]
+    bbox: Optional[List[float]] = Field(None, min_length=4)
+
+
+class GeoJSON(
+    RootModel[
+        Union[
+            GeoJSON1,
+            GeoJSON2,
+            GeoJSON3,
+            GeoJSON4,
+            GeoJSON5,
+            GeoJSON6,
+            GeoJSON7,
+            GeoJSON8,
+            GeoJSON9,
+        ]
+    ]
+):
+    root: Union[
+        GeoJSON1,
+        GeoJSON2,
+        GeoJSON3,
+        GeoJSON4,
+        GeoJSON5,
+        GeoJSON6,
+        GeoJSON7,
+        GeoJSON8,
+        GeoJSON9,
+    ] = Field(..., title='GeoJSON')

jupytergis_core/schema/interfaces/geojsonsource.py

@@ -0,0 +1,20 @@
+# generated by datamodel-codegen:
+#   filename:  geojsonsource.json
+#   timestamp: 2025-05-08T01:23:34+00:00
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from . import geojson
+
+
+class IGeoJSONSource(BaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    path: Optional[str] = Field(None, description='The local path to a GeoJSON file')
+    data: Optional[geojson.GeoJSON] = Field(None, description='The GeoJSON data')
+    valid: Optional[bool] = Field(None, description='Whether the data are valid or not')

jupytergis_core/schema/interfaces/processing/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  schema
+#   timestamp: 2025-05-08T01:23:34+00:00

jupytergis_core/schema/interfaces/processing/buffer.py

@@ -0,0 +1,23 @@
+# generated by datamodel-codegen:
+#   filename:  processing/buffer.json
+#   timestamp: 2025-05-08T01:23:34+00:00
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class IBuffer(BaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    inputLayer: str = Field(..., description='The input layer for buffering.')
+    bufferDistance: float = Field(
+        ...,
+        description='The distance used for buffering the geometry (in projection units).',
+    )
+    embedOutputLayer: Optional[bool] = Field(
+        True, title='Embed output buffered layer in file'
+    )

jupytergis_core/schema/interfaces/processing/dissolve.py

@@ -0,0 +1,24 @@
+# generated by datamodel-codegen:
+#   filename:  processing/dissolve.json
+#   timestamp: 2025-05-08T01:23:34+00:00
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class IDissolve(BaseModel):
+    model_config = ConfigDict(
+        extra='forbid',
+    )
+    inputLayer: str = Field(
+        ..., description='The input layer for the dissolve operation.'
+    )
+    dissolveField: str = Field(
+        ..., description='The field based on which geometries will be dissolved.'
+    )
+    embedOutputLayer: Optional[bool] = Field(
+        True, title='Embed output dissolved layer in file'
+    )

jupytergis_core/schema/interfaces/project/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  schema
+#   timestamp: 2025-05-08T01:23:34+00:00