@jupytergis/schema 0.15.0 → 0.16.0-alpha.1

package/lib/schema/project/symbology.json

@@ -0,0 +1,418 @@
+{
+    "type": "object",
+    "description": "SymbologyState",
+    "title": "ISymbologyState",
+    "definitions": {
+        "RGBA": {
+            "type": "array",
+            "description": "[R 0-255, G 0-255, B 0-255, A 0-1]",
+            "items": { "type": "number" },
+            "minItems": 4,
+            "maxItems": 4
+        },
+        "ClassificationMode": {
+            "type": "string",
+            "enum": ["equal interval", "quantile", "jenks", "pretty", "logarithmic"]
+        },
+        "RGBAChannel": {
+            "type": "string",
+            "enum": [
+                "fill-color",
+                "stroke-color",
+                "circle-fill-color",
+                "circle-stroke-color",
+                "pixel-color"
+            ]
+        },
+        "UInt8Channel": {
+            "type": "string",
+            "enum": [
+                "fill-red",
+                "fill-green",
+                "fill-blue",
+                "pixel-red",
+                "pixel-green",
+                "pixel-blue"
+            ]
+        },
+        "UNormChannel": {
+            "type": "string",
+            "enum": ["fill-alpha", "pixel-alpha"]
+        },
+        "VirtualChannel": {
+            "type": "string",
+            "enum": ["pixel-rgb"]
+        },
+        "PosFloatChannel": {
+            "type": "string",
+            "enum": ["stroke-width", "circle-radius", "circle-stroke-width"]
+        },
+        "StyleChannel": {
+            "anyOf": [
+                { "$ref": "#/definitions/RGBAChannel" },
+                { "$ref": "#/definitions/UInt8Channel" },
+                { "$ref": "#/definitions/UNormChannel" },
+                { "$ref": "#/definitions/VirtualChannel" },
+                { "$ref": "#/definitions/PosFloatChannel" }
+            ]
+        },
+        "ICompareOp": {
+            "type": "string",
+            "enum": [">", "<", ">=", "<=", "!="]
+        },
+        "IPredicate": {
+            "oneOf": [
+                {
+                    "type": "object",
+                    "description": "Filter by geometry type.",
+                    "required": ["type", "value"],
+                    "additionalProperties": false,
+                    "properties": {
+                        "type": { "type": "string", "enum": ["geometryType"] },
+                        "value": {
+                            "type": "string",
+                            "enum": ["Point", "LineString", "Polygon"]
+                        }
+                    }
+                },
+                {
+                    "type": "object",
+                    "description": "Filter by presence of a field.",
+                    "required": ["type", "field"],
+                    "additionalProperties": false,
+                    "properties": {
+                        "type": { "type": "string", "enum": ["hasField"] },
+                        "field": { "type": "string" }
+                    }
+                },
+                {
+                    "type": "object",
+                    "description": "Filter by exact field value (string or number).",
+                    "required": ["type", "field", "value"],
+                    "additionalProperties": false,
+                    "properties": {
+                        "type": { "type": "string", "enum": ["fieldEquals"] },
+                        "field": { "type": "string" },
+                        "value": { "oneOf": [{ "type": "string" }, { "type": "number" }] }
+                    }
+                },
+                {
+                    "type": "object",
+                    "description": "Filter by numeric field comparison.",
+                    "required": ["type", "field", "op", "value"],
+                    "additionalProperties": false,
+                    "properties": {
+                        "type": { "type": "string", "enum": ["fieldCompare"] },
+                        "field": { "type": "string" },
+                        "op": { "$ref": "#/definitions/ICompareOp" },
+                        "value": { "type": "number" }
+                    }
+                },
+                {
+                    "type": "object",
+                    "description": "Filter by numeric field range (inclusive).",
+                    "required": ["type", "field", "min", "max"],
+                    "additionalProperties": false,
+                    "properties": {
+                        "type": { "type": "string", "enum": ["between"] },
+                        "field": { "type": "string" },
+                        "min": { "type": "number" },
+                        "max": { "type": "number" }
+                    }
+                }
+            ]
+        },
+        "IKDETransform": {
+            "type": "object",
+            "description": "KDE heatmap transform. Density output addressed as '$density'.",
+            "required": ["type", "radius", "blur"],
+            "additionalProperties": false,
+            "properties": {
+                "type": { "type": "string", "enum": ["kde"] },
+                "radius": { "type": "number", "minimum": 1 },
+                "blur": { "type": "number", "minimum": 0 },
+                "weightField": { "type": "string" }
+            }
+        },
+        "IClusterTransform": {
+            "type": "object",
+            "description": "Cluster transform. Aggregates nearby points into centroids.",
+            "required": ["type", "radius"],
+            "additionalProperties": false,
+            "properties": {
+                "type": { "type": "string", "enum": ["cluster"] },
+                "radius": { "type": "number", "minimum": 1 }
+            }
+        },
+        "ITransform": {
+            "oneOf": [
+                { "$ref": "#/definitions/IKDETransform" },
+                { "$ref": "#/definitions/IClusterTransform" }
+            ]
+        },
+        "IColorRampScale": {
+            "type": "object",
+            "description": "Maps a numeric field through a named color palette to RGBA.",
+            "required": ["scheme", "params"],
+            "additionalProperties": false,
+            "properties": {
+                "scheme": { "type": "string", "enum": ["colorRamp"] },
+                "params": {
+                    "type": "object",
+                    "required": ["name", "nShades", "mode", "reverse", "fallback"],
+                    "additionalProperties": false,
+                    "properties": {
+                        "name": { "type": "string" },
+                        "domain": {
+                            "type": "array",
+                            "items": { "type": "number" },
+                            "minItems": 2,
+                            "maxItems": 2
+                        },
+                        "nShades": { "type": "number" },
+                        "mode": { "$ref": "#/definitions/ClassificationMode" },
+                        "reverse": { "type": "boolean" },
+                        "fallback": { "$ref": "#/definitions/RGBA" },
+                        "colorStops": {
+                            "type": "array",
+                            "items": {
+                                "type": "object",
+                                "required": ["stop", "color"],
+                                "additionalProperties": false,
+                                "properties": {
+                                    "stop": { "type": "number" },
+                                    "color": { "$ref": "#/definitions/RGBA" }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "ICategoricalScale": {
+            "type": "object",
+            "description": "Maps discrete field values to colors sampled from a named palette.",
+            "required": ["scheme", "params"],
+            "additionalProperties": false,
+            "properties": {
+                "scheme": { "type": "string", "enum": ["categorical"] },
+                "params": {
+                    "type": "object",
+                    "required": ["colorRamp", "fallback"],
+                    "additionalProperties": false,
+                    "properties": {
+                        "colorRamp": { "type": "string" },
+                        "nShades": { "type": "number" },
+                        "reverse": { "type": "boolean" },
+                        "fallback": { "$ref": "#/definitions/RGBA" },
+                        "colorStops": {
+                            "type": "array",
+                            "items": {
+                                "type": "object",
+                                "required": ["stop", "color"],
+                                "additionalProperties": false,
+                                "properties": {
+                                    "stop": {
+                                        "oneOf": [{ "type": "string" }, { "type": "number" }]
+                                    },
+                                    "color": { "$ref": "#/definitions/RGBA" }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "IScalarScale": {
+            "type": "object",
+            "description": "Maps a numeric field to a numeric output (radius, width, sub-channel value).",
+            "required": ["scheme", "params"],
+            "additionalProperties": false,
+            "properties": {
+                "scheme": { "type": "string", "enum": ["scalar"] },
+                "params": {
+                    "type": "object",
+                    "required": ["domain", "range", "mode", "nStops", "fallback"],
+                    "additionalProperties": false,
+                    "properties": {
+                        "domain": {
+                            "type": "array",
+                            "items": { "type": "number" },
+                            "minItems": 2,
+                            "maxItems": 2
+                        },
+                        "range": {
+                            "type": "array",
+                            "items": { "type": "number" },
+                            "minItems": 2,
+                            "maxItems": 2
+                        },
+                        "mode": { "$ref": "#/definitions/ClassificationMode" },
+                        "nStops": { "type": "number" },
+                        "fallback": { "type": "number" },
+                        "scalarStops": {
+                            "type": "array",
+                            "items": {
+                                "type": "object",
+                                "required": ["stop", "output"],
+                                "additionalProperties": false,
+                                "properties": {
+                                    "stop": { "type": "number" },
+                                    "output": { "type": "number" }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        "IConstantRGBAScale": {
+            "type": "object",
+            "description": "Fixed RGBA color regardless of feature data.",
+            "required": ["scheme", "params"],
+            "additionalProperties": false,
+            "properties": {
+                "scheme": { "type": "string", "enum": ["constant_rgba"] },
+                "params": {
+                    "type": "object",
+                    "required": ["value"],
+                    "additionalProperties": false,
+                    "properties": {
+                        "value": { "$ref": "#/definitions/RGBA" }
+                    }
+                }
+            }
+        },
+        "IConstantNumScale": {
+            "type": "object",
+            "description": "Fixed numeric value regardless of feature data.",
+            "required": ["scheme", "params"],
+            "additionalProperties": false,
+            "properties": {
+                "scheme": { "type": "string", "enum": ["constant_num"] },
+                "params": {
+                    "type": "object",
+                    "required": ["value"],
+                    "additionalProperties": false,
+                    "properties": {
+                        "value": { "type": "number" }
+                    }
+                }
+            }
+        },
+        "IIdentityScale": {
+            "type": "object",
+            "description": "Passes the field value through unchanged.",
+            "required": ["scheme"],
+            "additionalProperties": false,
+            "properties": {
+                "scheme": { "type": "string", "enum": ["identity"] }
+            }
+        },
+        "IExpressionScale": {
+            "type": "object",
+            "description": "Evaluates an expression against one or more input fields (reserved).",
+            "required": ["scheme", "params"],
+            "additionalProperties": false,
+            "properties": {
+                "scheme": { "type": "string", "enum": ["expression"] },
+                "params": {
+                    "type": "object",
+                    "required": ["expr", "fallback"],
+                    "additionalProperties": false,
+                    "properties": {
+                        "expr": { "type": "string" },
+                        "fallback": {
+                            "oneOf": [{ "type": "number" }, { "$ref": "#/definitions/RGBA" }]
+                        }
+                    }
+                }
+            }
+        },
+        "IScale": {
+            "oneOf": [
+                { "$ref": "#/definitions/IColorRampScale" },
+                { "$ref": "#/definitions/ICategoricalScale" },
+                { "$ref": "#/definitions/IScalarScale" },
+                { "$ref": "#/definitions/IConstantRGBAScale" },
+                { "$ref": "#/definitions/IConstantNumScale" },
+                { "$ref": "#/definitions/IIdentityScale" },
+                { "$ref": "#/definitions/IExpressionScale" }
+            ]
+        },
+        "IMapping": {
+            "type": "object",
+            "description": "A (scale, channels) pair: one scale drives one or more output channels.",
+            "required": ["scale", "channels"],
+            "additionalProperties": false,
+            "properties": {
+                "scale": { "$ref": "#/definitions/IScale" },
+                "channels": {
+                    "type": "array",
+                    "description": "Target output channel names.",
+                    "items": { "$ref": "#/definitions/StyleChannel" },
+                    "minItems": 1
+                }
+            }
+        },
+        "IEncodingRule": {
+            "type": "object",
+            "description": "Maps optional input fields to one or more (scale, channels) pairs.",
+            "required": ["id", "mappings"],
+            "additionalProperties": false,
+            "properties": {
+                "id": { "type": "string", "description": "Stable UUID." },
+                "fields": {
+                    "type": "array",
+                    "description": "Input field name(s). Absent for constant rules.",
+                    "items": { "type": "string" }
+                },
+                "mappings": {
+                    "type": "array",
+                    "description": "(scale, channels) pairs sharing these input fields.",
+                    "items": { "$ref": "#/definitions/IMapping" },
+                    "minItems": 1
+                },
+                "when": {
+                    "type": "array",
+                    "description": "Guard predicates for this rule.",
+                    "items": { "$ref": "#/definitions/IPredicate" }
+                },
+                "whenOp": {
+                    "type": "string",
+                    "enum": ["all", "any"],
+                    "description": "Logical combinator for when predicates. Defaults to 'all'."
+                }
+            }
+        },
+        "IGrammarLayer": {
+            "type": "object",
+            "description": "One independent rendering pipeline on a source.",
+            "required": ["id", "rules"],
+            "additionalProperties": false,
+            "properties": {
+                "id": { "type": "string", "description": "Stable UUID." },
+                "preprocess": {
+                    "type": "array",
+                    "description": "Render-side transforms (KDE, cluster) applied before encoding rules.",
+                    "items": { "$ref": "#/definitions/ITransform" }
+                },
+                "rules": {
+                    "type": "array",
+                    "description": "Encoding rules compiled into a flat-style expression for this layer.",
+                    "items": { "$ref": "#/definitions/IEncodingRule" }
+                },
+                "when": {
+                    "type": "array",
+                    "description": "Guard predicates applied to every rule in this layer.",
+                    "items": { "$ref": "#/definitions/IPredicate" }
+                },
+                "whenOp": {
+                    "type": "string",
+                    "enum": ["all", "any"],
+                    "description": "Logical combinator for when predicates. Defaults to 'all'."
+                }
+            }
+        }
+    }
+}

package/lib/types.d.ts

@@ -1,4 +1,6 @@
 export * from './_interface/project/jgis';
+export * from './_interface/project/sources/geoPackageVectorSource';
+export * from './_interface/project/sources/geoPackageRasterSource';
 export * from './_interface/project/sources/geoJsonSource';
 export * from './_interface/project/sources/geoTiffSource';
 export * from './_interface/project/sources/imageSource';
@@ -10,7 +12,7 @@ export * from './_interface/project/sources/videoSource';
 export * from './_interface/project/sources/geoParquetSource';
 export * from './_interface/project/sources/markerSource';
 export * from './_interface/project/sources/wmsTileSource';
-export * from './_interface/project/layers/heatmapLayer';
+export * from './_interface/project/sources/openeoTileSource';
 export * from './_interface/project/layers/hillshadeLayer';
 export * from './_interface/project/layers/storySegmentLayer';
 export * from './_interface/project/layers/rasterLayer';
@@ -18,8 +20,19 @@ export * from './_interface/project/layers/vectorLayer';
 export * from './_interface/project/layers/imageLayer';
 export * from './_interface/project/layers/stacLayer';
 export * from './_interface/project/layers/vectorTileLayer';
-export * from './_interface/project/layers/webGlLayer';
+export * from './_interface/project/layers/geoTiffLayer';
+export * from './_interface/project/layers/openeoTileLayer';
 export * from './processing/_generated/exportProcessingSchema';
+export * from './_interface/project/symbology';
+import type { IGrammarLayer } from './_interface/project/symbology';
+export interface IGrammarSymbologyState {
+    /**
+     * Ordered list of independent rendering layers sharing the same source.
+     * Each layer produces one renderer layer (Vector, Image, WebGLTile, etc.).
+     * Layers are rendered in order (first = bottom).
+     */
+    layers: IGrammarLayer[];
+}
 export * from './_interface/export/exportGeoJson';
 export * from './_interface/export/exportGeoTiff';
 export * from './doc';

package/lib/types.js

@@ -1,5 +1,7 @@
 export * from './_interface/project/jgis';
 // Sources
+export * from './_interface/project/sources/geoPackageVectorSource';
+export * from './_interface/project/sources/geoPackageRasterSource';
 export * from './_interface/project/sources/geoJsonSource';
 export * from './_interface/project/sources/geoTiffSource';
 export * from './_interface/project/sources/imageSource';
@@ -11,8 +13,8 @@ export * from './_interface/project/sources/videoSource';
 export * from './_interface/project/sources/geoParquetSource';
 export * from './_interface/project/sources/markerSource';
 export * from './_interface/project/sources/wmsTileSource';
+export * from './_interface/project/sources/openeoTileSource';
 // Layers
-export * from './_interface/project/layers/heatmapLayer';
 export * from './_interface/project/layers/hillshadeLayer';
 export * from './_interface/project/layers/storySegmentLayer';
 export * from './_interface/project/layers/rasterLayer';
@@ -20,9 +22,12 @@ export * from './_interface/project/layers/vectorLayer';
 export * from './_interface/project/layers/imageLayer';
 export * from './_interface/project/layers/stacLayer';
 export * from './_interface/project/layers/vectorTileLayer';
-export * from './_interface/project/layers/webGlLayer';
+export * from './_interface/project/layers/geoTiffLayer';
+export * from './_interface/project/layers/openeoTileLayer';
 // Processing
 export * from './processing/_generated/exportProcessingSchema';
+// Symbology grammar
+export * from './_interface/project/symbology';
 // exportLayer
 export * from './_interface/export/exportGeoJson';
 export * from './_interface/export/exportGeoTiff';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupytergis/schema",
-  "version": "0.15.0",
+  "version": "0.16.0-alpha.1",
   "description": "A JupyterGIS schema package.",
   "keywords": [
     "jupytergis"
@@ -25,6 +25,7 @@
     "url": "https://github.com/geojupyter/jupytergis.git"
   },
   "scripts": {
+    "test": "jest",
     "build": "jlpm build:schema && jlpm build:lib",
     "build:schema": "jlpm run build:processing && node ./cacheGeoJSONSchema.js && jlpm build:schema:registry && jlpm build:schema:js && jlpm build:schema:py",
     "build:processing": "python scripts/process.py",

package/lib/_interface/project/layers/webGlLayer.d.ts

@@ -1,39 +0,0 @@
-/* tslint:disable */
-/**
- * This file was automatically generated by json-schema-to-typescript.
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and run json-schema-to-typescript to regenerate this file.
- */
-
-/**
- * WebGlLayer
- */
-export interface IWebGlLayer {
-  /**
-   * The id of the source
-   */
-  source: string;
-  /**
-   * The opacity of the source
-   */
-  opacity?: number;
-  /**
-   * The color of the the object
-   */
-  color?: string | number | (string | number | (number | string | (number | string)[])[])[];
-  /**
-   * The state of the symbology panel options
-   */
-  symbologyState?: {
-    renderType: string;
-    band?: number;
-    redBand?: number;
-    greenBand?: number;
-    blueBand?: number;
-    alphaBand?: number;
-    interpolation?: "discrete" | "linear" | "exact";
-    colorRamp?: string;
-    nClasses?: string;
-    mode?: "continuous" | "equal interval" | "quantile";
-  };
-}

package/lib/schema/project/layers/heatmapLayer.json

@@ -1,54 +0,0 @@
-{
-    "type": "object",
-    "description": "HeatmapLayer",
-    "title": "IHeatmapLayer",
-    "required": ["source", "blur", "radius"],
-    "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
-        },
-        "radius": {
-            "type": "number",
-            "description": "Radius size in pixels",
-            "default": 8
-        },
-        "blur": {
-            "type": "number",
-            "description": "Blur size in pixels",
-            "default": 15
-        },
-        "color": {
-            "type": "array",
-            "items": {
-                "type": "string"
-            },
-            "default": ["#00f", "#0ff", "#0f0", "#ff0", "#f00"]
-        },
-        "symbologyState": {
-            "type": "object",
-            "description": "The state of the symbology panel options",
-            "required": ["renderType"],
-            "properties": {
-                "renderType": {
-                    "type": "string",
-                    "default": "Heatmap"
-                },
-                "colorRamp": {
-                    "type": "string",
-                    "default": "viridis"
-                }
-            },
-            "default": {}
-        }
-    }
-}