@jupytergis/schema 0.14.1 → 0.16.0-alpha.0

package/lib/_interface/project/sources/imageSource.d.ts

@@ -21,4 +21,12 @@ export interface IImageSource {
    * Interpolate between grid cells when overzooming?
    */
   interpolate?: boolean;
+  /**
+   * Route requests through the Jupyter server proxy to avoid CORS issues.
+   */
+  useProxy?: boolean;
+  /**
+   * HTTP headers forwarded to the upstream server when useProxy is true.
+   */
+  httpHeaders?: string;
 }

package/lib/_interface/project/sources/openeoTileSource.d.ts

@@ -0,0 +1,26 @@
+/* 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.
+ */
+
+/**
+ * OpenEOTileSource
+ */
+export interface IOpenEOTileSource {
+  /**
+   * The process graph for the OpenEO layer.
+   */
+  processGraph: {
+    [k: string]: any;
+  };
+  /**
+   * The OpenEO tile server url.
+   */
+  serverUrl?: string;
+  /**
+   * The OpenEO connection identifier.
+   */
+  authBearer?: string;
+}

package/lib/_interface/project/sources/rasterDemSource.d.ts

@@ -24,4 +24,12 @@ export interface IRasterDemSource {
    * Interpolate between grid cells when overzooming?
    */
   interpolate?: boolean;
+  /**
+   * Route tile requests through the Jupyter server proxy to avoid CORS issues.
+   */
+  useProxy?: boolean;
+  /**
+   * HTTP headers forwarded to the upstream tile server when useProxy is true.
+   */
+  httpHeaders?: string;
 }

package/lib/_interface/project/sources/rasterSource.d.ts

@@ -44,6 +44,14 @@ export interface IRasterSource {
   bounds?: number[][];
   urlParameters?: URLParameters;
   interpolate?: Interpolate;
+  /**
+   * Route tile requests through the Jupyter server proxy to avoid CORS issues.
+   */
+  useProxy?: boolean;
+  /**
+   * HTTP headers forwarded to the upstream tile server when useProxy is true.
+   */
+  httpHeaders?: string;
 }
 export interface URLParameters {
   [k: string]: string;

package/lib/_interface/project/sources/shapefileSource.d.ts

@@ -31,4 +31,12 @@ export interface IShapefileSource {
   additionalFiles?: {
     [k: string]: string;
   };
+  /**
+   * Route requests through the Jupyter server proxy to avoid CORS issues.
+   */
+  useProxy?: boolean;
+  /**
+   * HTTP headers forwarded to the upstream server when useProxy is true.
+   */
+  httpHeaders?: string;
 }

package/lib/_interface/project/sources/vectorTileSource.d.ts

@@ -32,4 +32,12 @@ export interface IVectorTileSource {
   urlParameters?: {
     [k: string]: string;
   };
+  /**
+   * Route tile requests through the Jupyter server proxy to avoid CORS issues.
+   */
+  useProxy?: boolean;
+  /**
+   * HTTP headers forwarded to the upstream tile server when useProxy is true.
+   */
+  httpHeaders?: string;
 }

package/lib/_interface/project/sources/videoSource.d.ts

@@ -17,4 +17,12 @@ export interface IVideoSource {
    * Corners of video specified in longitude, latitude pairs
    */
   coordinates: [[number, number], [number, number], [number, number], [number, number]];
+  /**
+   * Route requests through the Jupyter server proxy to avoid CORS issues.
+   */
+  useProxy?: boolean;
+  /**
+   * HTTP headers forwarded to the upstream server when useProxy is true.
+   */
+  httpHeaders?: string;
 }

package/lib/_interface/project/sources/wmsTileSource.d.ts

@@ -0,0 +1,40 @@
+/* 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.
+ */
+
+/**
+ * WmsTileSource
+ */
+export interface IWmsTileSource {
+  /**
+   * The url to the tile provider
+   */
+  url: string;
+  params: ParamsForURLQuery;
+  /**
+   * The attribution for the raster source
+   */
+  attribution?: string;
+  /**
+   * Interpolate between grid cells when overzooming?
+   */
+  interpolate?: boolean;
+  /**
+   * Route tile requests through the Jupyter server proxy to avoid CORS issues.
+   */
+  useProxy?: boolean;
+  /**
+   * HTTP headers forwarded to the upstream tile server when useProxy is true.
+   */
+  httpHeaders?: string;
+}
+export interface ParamsForURLQuery {
+  /**
+   * WMS layer name to request
+   */
+  layers: string;
+  [k: string]: any;
+}

package/lib/_interface/project/symbology.d.ts

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

package/lib/_interface/version.d.ts

@@ -1 +1 @@
-export declare const SCHEMA_VERSION = '0.5.0';
+export declare const SCHEMA_VERSION = '0.6.0';

package/lib/_interface/version.js

@@ -1 +1 @@
-export const SCHEMA_VERSION = '0.5.0';
+export const SCHEMA_VERSION = '0.6.0';

package/lib/doc.d.ts

@@ -1,10 +1,11 @@
 import { MapChange, YDocument } from '@jupyter/ydoc';
 import { JSONObject } from '@lumino/coreutils';
 import { ISignal } from '@lumino/signaling';
-import { IJGISLayer, IJGISLayerItem, IJGISLayerTree, IJGISLayers, IJGISOptions, IJGISSource, IJGISSources, IJGISStoryMap } from './_interface/project/jgis';
+import { IJGISLayer, IJGISLayerItem, IJGISLayerTree, IJGISLayers, IJGISOptions, IJGISSource, IJGISSources, IJGISStoryMap, IJGISViewState } from './_interface/project/jgis';
 import { IDict, IJGISLayerDocChange, IJGISLayerTreeDocChange, IJGISSourceDocChange, IJGISStoryMapDocChange, IJGISStoryMaps, IJupyterGISDoc, IJupyterGISDocChange } from './interfaces';
+export declare const DEFAULT_PROJECTION = "EPSG:3857";
 /** Default JSON content for a new JupyterGIS document. */
-export declare const DEFAULT_JGIS_DOCUMENT_CONTENT = "{\n\t\"schemaVersion\": \"0.5.0\",\n\t\"layers\": {},\n\t\"sources\": {},\n\t\"options\": {\"latitude\": 0, \"longitude\": 0, \"zoom\": 0, \"bearing\": 0, \"pitch\": 0, \"projection\": \"EPSG:3857\", \"storyMapPresentationMode\": false},\n\t\"layerTree\": [],\n\t\"metadata\": {}\n}";
+export declare const DEFAULT_JGIS_DOCUMENT_CONTENT = "{\n\t\"schemaVersion\": \"0.6.0\",\n\t\"layers\": {},\n\t\"sources\": {},\n  \"stories\": {},\n  \"viewState\": {},\n\t\"options\": {\"latitude\": 0, \"longitude\": 0, \"zoom\": 0, \"bearing\": 0, \"pitch\": 0, \"projection\": \"EPSG:3857\", \"storyMapPresentationMode\": false},\n\t\"layerTree\": [],\n\t\"metadata\": {}\n}";
 export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> implements IJupyterGISDoc {
     constructor();
     get initialSyncReady(): Promise<void>;
@@ -19,6 +20,8 @@ export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> imple
     get sources(): IJGISSources;
     set stories(stories: IJGISStoryMaps);
     get stories(): IJGISStoryMaps;
+    get viewState(): IJGISViewState;
+    set viewState(viewState: IJGISViewState);
     get layerTree(): IJGISLayerTree;
     set layerTree(layerTree: IJGISLayerTree);
     getLayer(id: string): IJGISLayer | undefined;
@@ -36,6 +39,7 @@ export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> imple
     get layerTreeChanged(): ISignal<IJupyterGISDoc, IJGISLayerTreeDocChange>;
     get sourcesChanged(): ISignal<IJupyterGISDoc, IJGISSourceDocChange>;
     get storyMapsChanged(): ISignal<IJupyterGISDoc, IJGISStoryMapDocChange>;
+    get viewStateChanged(): ISignal<IJupyterGISDoc, MapChange>;
     get optionsChanged(): ISignal<IJupyterGISDoc, MapChange>;
     layerExists(id: string): boolean;
     removeLayer(id: string): void;
@@ -71,12 +75,14 @@ export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> imple
     private _layerTreeObserver;
     private _sourcesObserver;
     private _storyMapsObserver;
+    private _viewStateObserver;
     private _optionsObserver;
     private _metaObserver;
     private _layers;
     private _layerTree;
     private _sources;
     private _stories;
+    private _viewState;
     private _options;
     private _metadata;
     private _optionsChanged;
@@ -84,6 +90,7 @@ export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> imple
     private _layerTreeChanged;
     private _sourcesChanged;
     private _storyMapsChanged;
+    private _viewStateChanged;
     private _metadataChanged;
     private _initialSyncReadyPromise;
     private _initialSyncReadyResolve;

package/lib/doc.js

@@ -2,12 +2,16 @@ import { YDocument } from '@jupyter/ydoc';
 import { JSONExt } from '@lumino/coreutils';
 import { Signal } from '@lumino/signaling';
 import { SCHEMA_VERSION } from './_interface/version';
+import { migrateDocument } from './migrations';
+export const DEFAULT_PROJECTION = 'EPSG:3857';
 /** Default JSON content for a new JupyterGIS document. */
 export const DEFAULT_JGIS_DOCUMENT_CONTENT = `{
 	"schemaVersion": "${SCHEMA_VERSION}",
 	"layers": {},
 	"sources": {},
-	"options": {"latitude": 0, "longitude": 0, "zoom": 0, "bearing": 0, "pitch": 0, "projection": "EPSG:3857", "storyMapPresentationMode": false},
+  "stories": {},
+  "viewState": {},
+	"options": {"latitude": 0, "longitude": 0, "zoom": 0, "bearing": 0, "pitch": 0, "projection": "${DEFAULT_PROJECTION}", "storyMapPresentationMode": false},
 	"layerTree": [],
 	"metadata": {}
 }`;
@@ -15,6 +19,17 @@ export class JupyterGISDoc extends YDocument {
     constructor() {
         super();
         this.editable = true;
+        this._viewStateObserver = (event) => {
+            const changes = new Map();
+            event.changes.keys.forEach((event, key) => {
+                changes.set(key, {
+                    action: event.action,
+                    oldValue: event.oldValue,
+                    newValue: this._viewState.get(key),
+                });
+            });
+            this._viewStateChanged.emit(changes);
+        };
         this._optionsObserver = (event) => {
             const changes = new Map();
             event.changes.keys.forEach((event, key) => {
@@ -43,6 +58,7 @@ export class JupyterGISDoc extends YDocument {
         this._layerTreeChanged = new Signal(this);
         this._sourcesChanged = new Signal(this);
         this._storyMapsChanged = new Signal(this);
+        this._viewStateChanged = new Signal(this);
         this._metadataChanged = new Signal(this);
         this._initialSyncResolved = false;
         this._options = this.ydoc.getMap('options');
@@ -50,6 +66,7 @@ export class JupyterGISDoc extends YDocument {
         this._layerTree = this.ydoc.getArray('layerTree');
         this._sources = this.ydoc.getMap('sources');
         this._stories = this.ydoc.getMap('stories');
+        this._viewState = this.ydoc.getMap('viewState');
         this._metadata = this.ydoc.getMap('metadata');
         this.undoManager.addToScope(this._layers);
         this.undoManager.addToScope(this._sources);
@@ -62,6 +79,7 @@ export class JupyterGISDoc extends YDocument {
         this._layerTree.observe(this._layerTreeObserver.bind(this));
         this._sources.observeDeep(this._sourcesObserver.bind(this));
         this._stories.observeDeep(this._storyMapsObserver.bind(this));
+        this._viewState.observe(this._viewStateObserver.bind(this));
         this._options.observe(this._optionsObserver.bind(this));
         this._metadata.observe(this._metaObserver.bind(this));
     }
@@ -81,8 +99,17 @@ export class JupyterGISDoc extends YDocument {
         const options = this._options.toJSON();
         const sources = this._sources.toJSON();
         const stories = this._stories.toJSON();
+        const viewState = this._viewState.toJSON();
         const metadata = this._metadata.toJSON();
-        return { layers, layerTree, sources, stories, options, metadata };
+        return {
+            layers,
+            layerTree,
+            sources,
+            stories,
+            viewState,
+            options,
+            metadata,
+        };
     }
     setSource(value) {
         if (!value) {
@@ -91,9 +118,11 @@ export class JupyterGISDoc extends YDocument {
         if (typeof value === 'string') {
             value = JSON.parse(value);
         }
-        value = value;
+        // Mirror the Python `YJGIS.set()` migration step so JupyterLite (which has
+        // no Python ydoc) loads legacy documents with the same shape as Lab.
+        value = migrateDocument(value);
         this.transact(() => {
-            var _a, _b, _c, _d, _e, _f;
+            var _a, _b, _c, _d, _e, _f, _g;
             const layers = (_a = value['layers']) !== null && _a !== void 0 ? _a : {};
             Object.entries(layers).forEach(([key, val]) => this._layers.set(key, val));
             const layerTree = (_b = value['layerTree']) !== null && _b !== void 0 ? _b : [];
@@ -106,7 +135,9 @@ export class JupyterGISDoc extends YDocument {
             Object.entries(sources).forEach(([key, val]) => this._sources.set(key, val));
             const stories = (_e = value['stories']) !== null && _e !== void 0 ? _e : {};
             Object.entries(stories).forEach(([key, val]) => this._stories.set(key, val));
-            const metadata = (_f = value['metadata']) !== null && _f !== void 0 ? _f : {};
+            const viewState = (_f = value['viewState']) !== null && _f !== void 0 ? _f : {};
+            Object.entries(viewState).forEach(([key, val]) => this._viewState.set(key, val));
+            const metadata = (_g = value['metadata']) !== null && _g !== void 0 ? _g : {};
             Object.entries(metadata).forEach(([key, val]) => this._metadata.set(key, val));
         });
     }
@@ -146,6 +177,16 @@ export class JupyterGISDoc extends YDocument {
     get stories() {
         return JSONExt.deepCopy(this._stories.toJSON());
     }
+    get viewState() {
+        return JSONExt.deepCopy(this._viewState.toJSON());
+    }
+    set viewState(viewState) {
+        this.transact(() => {
+            for (const [key, value] of Object.entries(viewState)) {
+                this._viewState.set(key, value);
+            }
+        });
+    }
     get layerTree() {
         return JSONExt.deepCopy(this._layerTree.toJSON());
     }
@@ -205,6 +246,9 @@ export class JupyterGISDoc extends YDocument {
     get storyMapsChanged() {
         return this._storyMapsChanged;
     }
+    get viewStateChanged() {
+        return this._viewStateChanged;
+    }
     get optionsChanged() {
         return this._optionsChanged;
     }