@jupytergis/schema 0.1.1

package/lib/schema/jgis.json

@@ -0,0 +1,248 @@
+{
+    "type": "object",
+    "title": "IJGISContent",
+    "required": ["layers", "sources"],
+    "additionalProperties": false,
+    "properties": {
+        "layers": {
+            "$ref": "#/definitions/jGISLayers"
+        },
+        "sources": {
+            "$ref": "#/definitions/jGISSources"
+        },
+        "layerTree": {
+            "$ref": "#/definitions/jGISLayerTree"
+        },
+        "terrain": {
+            "$ref": "#/definitions/jGISTerrain"
+        },
+        "options": {
+            "$ref": "#/definitions/jGISOptions"
+        }
+    },
+    "definitions": {
+        "layerType": {
+            "type": "string",
+            "enum": [
+                "RasterLayer",
+                "VectorLayer",
+                "VectorTileLayer",
+                "HillshadeLayer",
+                "WebGlLayer",
+                "ImageLayer"
+            ]
+        },
+        "sourceType": {
+            "type": "string",
+            "enum": [
+                "RasterSource",
+                "VectorTileSource",
+                "GeoJSONSource",
+                "RasterDemSource",
+                "VideoSource",
+                "ImageSource",
+                "ShapefileSource",
+                "GeoTiffSource"
+            ]
+        },
+        "jGISLayer": {
+            "title": "IJGISLayer",
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["name", "type", "visible"],
+            "properties": {
+                "name": {
+                    "type": "string"
+                },
+                "type": {
+                    "$ref": "#/definitions/layerType"
+                },
+                "visible": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "parameters": {
+                    "type": "object"
+                },
+                "filters": {
+                    "$ref": "#/definitions/jGISFilter"
+                }
+            }
+        },
+        "jGISSource": {
+            "title": "IJGISSource",
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["name", "type"],
+            "properties": {
+                "name": {
+                    "type": "string"
+                },
+                "type": {
+                    "$ref": "#/definitions/sourceType"
+                },
+                "parameters": {
+                    "type": "object"
+                }
+            }
+        },
+        "jGISLayerGroup": {
+            "title": "IJGISLayerGroup",
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["name", "layers"],
+            "properties": {
+                "name": {
+                    "type": "string"
+                },
+                "layers": {
+                    "type": "array",
+                    "default": [],
+                    "items": {
+                        "$ref": "#/definitions/jGISLayerItem"
+                    }
+                },
+                "visible": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "parameters": {
+                    "type": "object"
+                }
+            }
+        },
+        "jGISLayerItem": {
+            "title": "IJGISLayerItem",
+            "oneOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "$ref": "#/definitions/jGISLayerGroup"
+                }
+            ]
+        },
+        "jGISLayers": {
+            "title": "IJGISLayers",
+            "type": "object",
+            "default": {},
+            "additionalProperties": {
+                "$ref": "#/definitions/jGISLayer"
+            }
+        },
+        "jGISSources": {
+            "title": "IJGISSources",
+            "type": "object",
+            "default": {},
+            "additionalProperties": {
+                "$ref": "#/definitions/jGISSource"
+            }
+        },
+        "jGISLayerTree": {
+            "title": "IJGISLayerTree",
+            "type": "array",
+            "default": [],
+            "items": {
+                "$ref": "#/definitions/jGISLayerItem"
+            }
+        },
+        "jGISTerrain": {
+            "title": "IJGISTerrain",
+            "type": "object",
+            "default": {},
+            "required": ["source", "exaggeration"],
+            "additionalProperties": false,
+            "properties": {
+                "source": {
+                    "type": "string",
+                    "description": "The id of the DEM source",
+                    "default": ""
+                },
+                "exaggeration": {
+                    "type": "number",
+                    "default": 1
+                }
+            }
+        },
+        "jGISOptions": {
+            "title": "IJGISOptions",
+            "type": "object",
+            "default": {},
+            "required": [],
+            "additionalProperties": false,
+            "properties": {
+                "latitude": {
+                    "type": "number",
+                    "default": 0
+                },
+                "longitude": {
+                    "type": "number",
+                    "default": 0
+                },
+                "zoom": {
+                    "type": "number",
+                    "default": 0
+                },
+                "bearing": {
+                    "type": "number",
+                    "default": 0
+                },
+                "pitch": {
+                    "type": "number",
+                    "default": 0
+                },
+                "extent": {
+                    "type": "array",
+                    "default": null,
+                    "items": {
+                        "type": "number"
+                    }
+                },
+                "projection": {
+                    "type": "string",
+                    "default": "EPSG:3857"
+                }
+            }
+        },
+        "jGISFilterItem": {
+            "title": "IJGISFilterItem",
+            "type": "object",
+            "default": {},
+            "required": ["operator", "feature", "value"],
+            "additionalProperties": false,
+            "properties": {
+                "operator": {
+                    "type": "string",
+                    "enum": ["==", "!=", ">", "<", ">=", "<="],
+                    "default": "=="
+                },
+                "feature": {
+                    "type": "string",
+                    "default": ""
+                },
+                "value": {
+                    "type": ["string", "number"]
+                }
+            }
+        },
+        "jGISFilter": {
+            "title": "IJGISFilter",
+            "type": "object",
+            "required": ["logicalOp", "appliedFilters"],
+            "additionalProperties": false,
+            "properties": {
+                "logicalOp": {
+                    "type": "string",
+                    "default": "all"
+                },
+                "appliedFilters": {
+                    "type": "array",
+                    "default": [],
+                    "items": {
+                        "$ref": "#/definitions/jGISFilterItem"
+                    }
+                }
+            }
+        }
+    }
+}

package/lib/schema/rasterDemSource.json

@@ -0,0 +1,33 @@
+{
+    "type": "object",
+    "description": "RasterDemSource",
+    "title": "IRasterDemSource",
+    "required": ["url"],
+    "additionalProperties": false,
+    "properties": {
+        "url": {
+            "type": "string",
+            "description": "The url to the tile provider"
+        },
+        "tileSize": {
+            "type": "number",
+            "description": " The tile size",
+            "default": 512
+        },
+        "attribution": {
+            "type": "string",
+            "description": "The attribution for the raster-dem source"
+        },
+        "encoding": {
+            "type": "string",
+            "enum": ["terrarium", "mapbox"],
+            "default": "mapbox"
+        },
+        "urlParameters": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        }
+    }
+}

package/lib/schema/rasterlayer.json

@@ -0,0 +1,21 @@
+{
+    "type": "object",
+    "description": "RasterLayer",
+    "title": "IRasterLayer",
+    "required": ["source"],
+    "additionalProperties": false,
+    "properties": {
+        "source": {
+            "type": "string",
+            "description": "The id of the source"
+        },
+        "opacity": {
+            "type": "number",
+            "description": "The opacity of the source",
+            "default": 1,
+            "multipleOf": 0.1,
+            "minimum": 0,
+            "maximum": 1
+        }
+    }
+}

package/lib/schema/rastersource.json

@@ -0,0 +1,66 @@
+{
+    "type": "object",
+    "description": "RasterSource",
+    "title": "IRasterSource",
+    "required": ["url", "maxZoom", "minZoom"],
+    "additionalProperties": false,
+    "properties": {
+        "url": {
+            "type": "string",
+            "description": "The url to the tile provider"
+        },
+        "minZoom": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 24,
+            "readOnly": true,
+            "description": "The minimum zoom level for the raster source",
+            "default": 0
+        },
+        "maxZoom": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 24,
+            "readOnly": true,
+            "description": "The maximum zoom level for the raster source",
+            "default": 24
+        },
+        "attribution": {
+            "type": "string",
+            "readOnly": true,
+            "description": "The attribution for the raster source",
+            "default": ""
+        },
+        "htmlAttribution": {
+            "type": "string",
+            "readOnly": true,
+            "description": "The html attribution for the raster source",
+            "default": ""
+        },
+        "provider": {
+            "type": "string",
+            "readOnly": true,
+            "description": "The map provider",
+            "default": ""
+        },
+        "bounds": {
+            "type": "array",
+            "readOnly": true,
+            "items": {
+                "type": "array",
+                "items": {
+                    "type": "number"
+                }
+            },
+            "default": [],
+            "description": "The bounds of the source"
+        },
+        "urlParameters": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            },
+            "default": {}
+        }
+    }
+}

package/lib/schema/shapefileSource.json

@@ -0,0 +1,37 @@
+{
+    "type": "object",
+    "description": "ShapefileSource",
+    "title": "IShapefileSource",
+    "required": ["path"],
+    "additionalProperties": false,
+    "properties": {
+        "path": {
+            "type": "string",
+            "description": "The path to the shapefile (.shp, .zip, or folder URL)."
+        },
+        "attribution": {
+            "type": "string",
+            "readOnly": true,
+            "description": "The attribution for the shapefile source.",
+            "default": ""
+        },
+        "projection": {
+            "type": "string",
+            "description": "The projection information for the shapefile (optional).",
+            "default": "WGS84"
+        },
+        "encoding": {
+            "type": "string",
+            "description": "The encoding used for the shapefile's DBF (optional).",
+            "default": "UTF-8"
+        },
+        "additionalFiles": {
+            "type": "object",
+            "description": "Additional files associated with the shapefile (e.g., .dbf, .prj, .cpg).",
+            "additionalProperties": {
+                "type": "string"
+            },
+            "default": {}
+        }
+    }
+}

package/lib/schema/vectorTileLayer.json

@@ -0,0 +1,36 @@
+{
+    "type": "object",
+    "description": "VectorTileLayer",
+    "title": "IVectorTileLayer",
+    "required": ["source", "type"],
+    "additionalProperties": false,
+    "properties": {
+        "source": {
+            "type": "string",
+            "description": "The id of the source"
+        },
+        "type": {
+            "type": "string",
+            "enum": ["circle", "fill", "line"],
+            "default": "line",
+            "description": "The type of vector layer"
+        },
+        "sourceLayer": {
+            "type": "string",
+            "description": "The source layer to use"
+        },
+        "color": {
+            "type": "string",
+            "description": "The color of the the object",
+            "default": "#FF0000"
+        },
+        "opacity": {
+            "type": "number",
+            "description": "The opacity of the the object",
+            "default": 1,
+            "multipleOf": 0.1,
+            "minimum": 0,
+            "maximum": 1
+        }
+    }
+}

package/lib/schema/vectorlayer.json

@@ -0,0 +1,36 @@
+{
+    "type": "object",
+    "description": "VectorLayer",
+    "title": "IVectorLayer",
+    "required": ["source", "type"],
+    "additionalProperties": false,
+    "properties": {
+        "source": {
+            "type": "string",
+            "description": "The id of the source"
+        },
+        "type": {
+            "type": "string",
+            "enum": ["circle", "fill", "line"],
+            "default": "line",
+            "description": "The type of vector layer"
+        },
+        "sourceLayer": {
+            "type": "string",
+            "description": "The source layer to use"
+        },
+        "color": {
+            "type": "string",
+            "description": "The color of the the object",
+            "default": "#FF0000"
+        },
+        "opacity": {
+            "type": "number",
+            "description": "The opacity of the the object",
+            "default": 1,
+            "multipleOf": 0.1,
+            "minimum": 0,
+            "maximum": 1
+        }
+    }
+}

package/lib/schema/vectortilesource.json

@@ -0,0 +1,40 @@
+{
+    "type": "object",
+    "description": "VectorTileSource",
+    "title": "IVectorTileSource",
+    "required": ["url", "maxZoom", "minZoom"],
+    "additionalProperties": false,
+    "properties": {
+        "url": {
+            "type": "string",
+            "description": "The url to the tile provider"
+        },
+        "minZoom": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 24,
+            "description": "The minimum zoom level for the vector source"
+        },
+        "maxZoom": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 24,
+            "description": "The maximum zoom level for the vector source"
+        },
+        "attribution": {
+            "type": "string",
+            "description": "The attribution for the vector source"
+        },
+        "provider": {
+            "type": "string",
+            "readOnly": true,
+            "description": "The map provider"
+        },
+        "urlParameters": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        }
+    }
+}

package/lib/schema/videoSource.json

@@ -0,0 +1,33 @@
+{
+    "type": "object",
+    "description": "VideoSource",
+    "title": "IVideoSource",
+    "required": ["urls", "coordinates"],
+    "additionalProperties": false,
+    "properties": {
+        "urls": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "minItems": 1,
+            "default": [],
+            "description": "URLs to video content in order of preferred format"
+        },
+        "coordinates": {
+            "type": "array",
+            "items": {
+                "type": "array",
+                "items": {
+                    "type": "number"
+                },
+                "minItems": 2,
+                "maxItems": 2
+            },
+            "minItems": 4,
+            "maxItems": 4,
+            "default": [],
+            "description": "Corners of video specified in longitude, latitude pairs"
+        }
+    }
+}

package/lib/schema/webGlLayer.json

@@ -0,0 +1,41 @@
+{
+    "type": "object",
+    "description": "WebGlLayer",
+    "title": "IWebGlLayer",
+    "required": ["source"],
+    "additionalProperties": false,
+    "properties": {
+        "source": {
+            "type": "string",
+            "description": "The id of the source"
+        },
+        "opacity": {
+            "type": "number",
+            "description": "The opacity of the source",
+            "default": 1,
+            "multipleOf": 0.1,
+            "minimum": 0,
+            "maximum": 1
+        },
+        "color": {
+            "oneOf": [
+                { "type": "string" },
+                {
+                    "type": "array",
+                    "items": {
+                        "anyOf": [
+                            { "type": "string" },
+                            { "type": "number" },
+                            {
+                                "type": "array",
+                                "items": { "type": "string" }
+                            }
+                        ]
+                    }
+                }
+            ],
+            "description": "The color of the the object",
+            "default": "#FF0000"
+        }
+    }
+}

package/lib/token.d.ts

@@ -0,0 +1,6 @@
+import { Token } from '@lumino/coreutils';
+import { IJGISExternalCommandRegistry, IJGISFormSchemaRegistry, IJGISLayerBrowserRegistry, IJupyterGISTracker } from './interfaces';
+export declare const IJupyterGISDocTracker: Token<IJupyterGISTracker>;
+export declare const IJGISFormSchemaRegistryToken: Token<IJGISFormSchemaRegistry>;
+export declare const IJGISExternalCommandRegistryToken: Token<IJGISExternalCommandRegistry>;
+export declare const IJGISLayerBrowserRegistryToken: Token<IJGISLayerBrowserRegistry>;

package/lib/token.js

@@ -0,0 +1,5 @@
+import { Token } from '@lumino/coreutils';
+export const IJupyterGISDocTracker = new Token('jupyterGISDocTracker');
+export const IJGISFormSchemaRegistryToken = new Token('jupytergisFormSchemaRegistry');
+export const IJGISExternalCommandRegistryToken = new Token('jupytergisExternalCommandRegistry');
+export const IJGISLayerBrowserRegistryToken = new Token('jupytergisExternalCommandRegistry');

package/lib/types.d.ts

@@ -0,0 +1,19 @@
+export * from './_interface/jgis';
+export * from './_interface/geoTiffSource';
+export * from './_interface/geojsonsource';
+export * from './_interface/imageSource';
+export * from './_interface/rasterDemSource';
+export * from './_interface/rastersource';
+export * from './_interface/shapefileSource';
+export * from './_interface/vectortilesource';
+export * from './_interface/videoSource';
+export * from './_interface/hillshadeLayer';
+export * from './_interface/rasterlayer';
+export * from './_interface/vectorlayer';
+export * from './_interface/vectorTileLayer';
+export * from './_interface/webGlLayer';
+export * from './_interface/imageLayer';
+export * from './doc';
+export * from './interfaces';
+export * from './model';
+export * from './token';

package/lib/types.js

@@ -0,0 +1,22 @@
+export * from './_interface/jgis';
+// Sources
+export * from './_interface/geoTiffSource';
+export * from './_interface/geojsonsource';
+export * from './_interface/imageSource';
+export * from './_interface/rasterDemSource';
+export * from './_interface/rastersource';
+export * from './_interface/shapefileSource';
+export * from './_interface/vectortilesource';
+export * from './_interface/videoSource';
+// Layers
+export * from './_interface/hillshadeLayer';
+export * from './_interface/rasterlayer';
+export * from './_interface/vectorlayer';
+export * from './_interface/vectorTileLayer';
+export * from './_interface/webGlLayer';
+export * from './_interface/imageLayer';
+// Other
+export * from './doc';
+export * from './interfaces';
+export * from './model';
+export * from './token';