@jupytergis/schema 0.13.2 → 0.14.0

package/lib/_interface/forms.json

@@ -413,6 +413,11 @@
               "type": "object",
               "description": "The color/style override",
               "default": {}
+            },
+            "sourceProperties": {
+              "type": "object",
+              "description": "The symbology source override",
+              "default": {}
             }
           }
         },
@@ -461,8 +466,7 @@
             "default": "Single Symbol"
           },
           "value": {
-            "type": "string",
-            "default": ""
+            "type": "string"
           },
           "method": {
             "type": "string",
@@ -499,7 +503,6 @@
         "additionalProperties": false,
         "default": {
           "renderType": "Single Symbol",
-          "value": "",
           "method": "color",
           "colorRamp": "viridis",
           "nClasses": "9",
@@ -663,7 +666,7 @@
         "properties": {
           "renderType": {
             "type": "string",
-            "default": "Single Symbol"
+            "default": "Singleband Pseudocolor"
           },
           "band": {
             "type": "number",
@@ -714,7 +717,7 @@
         },
         "additionalProperties": false,
         "default": {
-          "renderType": "Single Symbol",
+          "renderType": "Singleband Pseudocolor",
           "band": 1,
           "redBand": 1,
           "greenBand": 2,
@@ -921,8 +924,7 @@
     "properties": {
       "url": {
         "type": "string",
-        "description": "The url to the tile provider",
-        "default": ""
+        "description": "The url to the tile provider"
       },
       "minZoom": {
         "type": "number",
@@ -972,6 +974,7 @@
       },
       "urlParameters": {
         "type": "object",
+        "title": "URL parameters",
         "additionalProperties": {
           "type": "string"
         },
@@ -979,6 +982,7 @@
       },
       "interpolate": {
         "type": "boolean",
+        "title": "Interpolate",
         "description": "Interpolate between grid cells when overzooming?",
         "default": false
       }
@@ -1033,8 +1037,7 @@
     "properties": {
       "url": {
         "type": "string",
-        "description": "The url to the tile provider",
-        "default": ""
+        "description": "The url to the tile provider"
       },
       "minZoom": {
         "type": "number",
@@ -1110,9 +1113,11 @@
     "additionalProperties": false,
     "properties": {
       "path": {
-        "type": "string",
-        "description": "The local path to a GeoJSON file",
-        "default": ""
+        "type": [
+          "string",
+          "null"
+        ],
+        "description": "The local path to a GeoJSON file"
       },
       "data": {
         "type": "object",
@@ -2606,12 +2611,6 @@
             }
           }
         ]
-      },
-      "valid": {
-        "type": "boolean",
-        "description": "Whether the data are valid or not",
-        "readOnly": true,
-        "default": false
       }
     }
   }

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

@@ -37,6 +37,12 @@ export type LayerOverride = {
   color?: {
     [k: string]: any;
   };
+  /**
+   * The symbology source override
+   */
+  sourceProperties?: {
+    [k: string]: any;
+  };
   [k: string]: any;
 }[];
 

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

@@ -26,12 +26,8 @@ export interface IGeoJSONSource {
   /**
    * The local path to a GeoJSON file
    */
-  path?: string;
+  path?: string | null;
   data?: GeoJSON;
-  /**
-   * Whether the data are valid or not
-   */
-  valid?: boolean;
 }
 export interface GeoJSONPoint {
   type: "Point";

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

@@ -5,6 +5,11 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
+/**
+ * Interpolate between grid cells when overzooming?
+ */
+export type Interpolate = boolean;
+
 /**
  * RasterSource
  */
@@ -37,11 +42,9 @@ export interface IRasterSource {
    * The bounds of the source
    */
   bounds?: number[][];
-  urlParameters?: {
-    [k: string]: string;
-  };
-  /**
-   * Interpolate between grid cells when overzooming?
-   */
-  interpolate?: boolean;
+  urlParameters?: URLParameters;
+  interpolate?: Interpolate;
+}
+export interface URLParameters {
+  [k: string]: string;
 }

package/lib/doc.d.ts

@@ -3,8 +3,12 @@ import { JSONObject } from '@lumino/coreutils';
 import { ISignal } from '@lumino/signaling';
 import { IJGISLayer, IJGISLayerItem, IJGISLayerTree, IJGISLayers, IJGISOptions, IJGISSource, IJGISSources, IJGISStoryMap } from './_interface/project/jgis';
 import { IDict, IJGISLayerDocChange, IJGISLayerTreeDocChange, IJGISSourceDocChange, IJGISStoryMapDocChange, IJGISStoryMaps, IJupyterGISDoc, IJupyterGISDocChange } from './interfaces';
+/** 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 class JupyterGISDoc extends YDocument<IJupyterGISDocChange> implements IJupyterGISDoc {
     constructor();
+    get initialSyncReady(): Promise<void>;
+    private _onOptionsObserverFired;
     getSource(): JSONObject;
     setSource(value: JSONObject | string): void;
     dispose(): void;
@@ -19,6 +23,13 @@ export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> imple
     set layerTree(layerTree: IJGISLayerTree);
     getLayer(id: string): IJGISLayer | undefined;
     getLayerSource(id: string): IJGISSource | undefined;
+    /**
+     * Get the list of layers using a source.
+     *
+     * @param id - the source id.
+     * @returns a list of layer ids that use the source.
+     */
+    getLayersBySource(id: string): string[];
     set options(options: IJGISOptions);
     get options(): IJGISOptions;
     get layersChanged(): ISignal<IJupyterGISDoc, IJGISLayerDocChange>;
@@ -74,4 +85,7 @@ export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> imple
     private _sourcesChanged;
     private _storyMapsChanged;
     private _metadataChanged;
+    private _initialSyncReadyPromise;
+    private _initialSyncReadyResolve;
+    private _initialSyncResolved;
 }

package/lib/doc.js

@@ -2,6 +2,15 @@ import { YDocument } from '@jupyter/ydoc';
 import { JSONExt } from '@lumino/coreutils';
 import { Signal } from '@lumino/signaling';
 import { SCHEMA_VERSION } from './_interface/version';
+/** 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},
+	"layerTree": [],
+	"metadata": {}
+}`;
 export class JupyterGISDoc extends YDocument {
     constructor() {
         super();
@@ -16,6 +25,7 @@ export class JupyterGISDoc extends YDocument {
                 });
             });
             this._optionsChanged.emit(changes);
+            this._onOptionsObserverFired();
         };
         this._metaObserver = (event) => {
             const changes = new Map();
@@ -34,6 +44,7 @@ export class JupyterGISDoc extends YDocument {
         this._sourcesChanged = new Signal(this);
         this._storyMapsChanged = new Signal(this);
         this._metadataChanged = new Signal(this);
+        this._initialSyncResolved = false;
         this._options = this.ydoc.getMap('options');
         this._layers = this.ydoc.getMap('layers');
         this._layerTree = this.ydoc.getArray('layerTree');
@@ -44,6 +55,9 @@ export class JupyterGISDoc extends YDocument {
         this.undoManager.addToScope(this._sources);
         this.undoManager.addToScope(this._stories);
         this.undoManager.addToScope(this._layerTree);
+        this._initialSyncReadyPromise = new Promise(resolve => {
+            this._initialSyncReadyResolve = resolve;
+        });
         this._layers.observeDeep(this._layersObserver.bind(this));
         this._layerTree.observe(this._layerTreeObserver.bind(this));
         this._sources.observeDeep(this._sourcesObserver.bind(this));
@@ -51,6 +65,16 @@ export class JupyterGISDoc extends YDocument {
         this._options.observe(this._optionsObserver.bind(this));
         this._metadata.observe(this._metaObserver.bind(this));
     }
+    get initialSyncReady() {
+        return this._initialSyncReadyPromise;
+    }
+    _onOptionsObserverFired() {
+        if (this._initialSyncResolved) {
+            return;
+        }
+        this._initialSyncResolved = true;
+        this._initialSyncReadyResolve();
+    }
     getSource() {
         const layers = this._layers.toJSON();
         const layerTree = this._layerTree.toJSON();
@@ -143,6 +167,22 @@ export class JupyterGISDoc extends YDocument {
         }
         return JSONExt.deepCopy(this._sources.get(id));
     }
+    /**
+     * Get the list of layers using a source.
+     *
+     * @param id - the source id.
+     * @returns a list of layer ids that use the source.
+     */
+    getLayersBySource(id) {
+        const usingLayers = [];
+        Object.entries(this.layers || {}).forEach(([layerId, layer]) => {
+            var _a;
+            if (((_a = layer.parameters) === null || _a === void 0 ? void 0 : _a.source) === id) {
+                usingLayers.push(layerId);
+            }
+        });
+        return usingLayers;
+    }
     set options(options) {
         this.transact(() => {
             for (const [key, value] of Object.entries(options)) {
@@ -225,6 +265,11 @@ export class JupyterGISDoc extends YDocument {
         return Boolean(this._getSourceAsYMap(id));
     }
     removeSource(id) {
+        const layersUsingSource = this.getLayersBySource(id);
+        if (layersUsingSource.length > 0) {
+            console.debug(`Skipping source removal: source ${id} still used by layers: ${layersUsingSource.join(', ')}`);
+            return;
+        }
         this.transact(() => {
             this._sources.delete(id);
         });

package/lib/interfaces.d.ts

@@ -106,6 +106,7 @@ export interface IJupyterGISDoc extends YDocument<IJupyterGISDocChange> {
     updateLayer(id: string, value: IJGISLayer): void;
     sourceExists(id: string): boolean;
     getLayerSource(id: string): IJGISSource | undefined;
+    getLayersBySource(id: string): string[];
     removeSource(id: string): void;
     addSource(id: string, value: IJGISSource): void;
     updateSource(id: string, value: IJGISSource): void;
@@ -128,6 +129,7 @@ export interface IJupyterGISDoc extends YDocument<IJupyterGISDocChange> {
     storyMapsChanged: ISignal<IJupyterGISDoc, IJGISStoryMapDocChange>;
     layerTreeChanged: ISignal<IJupyterGISDoc, IJGISLayerTreeDocChange>;
     metadataChanged: ISignal<IJupyterGISDoc, MapChange>;
+    initialSyncReady: Promise<void>;
 }
 export interface IJupyterGISDocChange extends DocumentChange {
     contextChange?: MapChange;
@@ -179,15 +181,16 @@ export interface IJupyterGISModel extends DocumentRegistry.IModel {
     getContent(): IJGISContent;
     getLayers(): IJGISLayers;
     getLayer(id: string): IJGISLayer | undefined;
+    getLayerOrSource(id: string): IJGISLayer | IJGISSource | undefined;
     getSources(): IJGISSources;
     getSource(id: string): IJGISSource | undefined;
     getSourcesByType(type: SourceType): {
         [key: string]: string;
     };
-    getLayersBySource(id: string): string[];
     getLayerTree(): IJGISLayerTree;
     addLayer(id: string, layer: IJGISLayer, groupName?: string, position?: number): void;
     removeLayer(id: string): void;
+    removeSource(id: string): void;
     getOptions(): IJGISOptions;
     setOptions(value: IJGISOptions): void;
     removeLayerGroup(groupName: string): void;
@@ -225,7 +228,7 @@ export interface IJupyterGISModel extends DocumentRegistry.IModel {
     isTemporalControllerActive: boolean;
     toggleTemporalController(): void;
     addFeatureAsMs(id: string, selectedFeature: string): void;
-    triggerLayerUpdate(layerId: string, layer: IJGISLayer): void;
+    triggerLayerUpdate(layerId: string, layerOrSource: IJGISLayer | IJGISSource): void;
     disposed: ISignal<any, void>;
     getSelectedStory(): {
         storyId: string;
@@ -233,6 +236,7 @@ export interface IJupyterGISModel extends DocumentRegistry.IModel {
     };
     getCurrentSegmentIndex(): number;
     setCurrentSegmentIndex(index: number): void;
+    currentSegmentIndexChanged: ISignal<IJupyterGISModel, number>;
     addStorySegment(): {
         storySegmentId: string;
         storyId: string;

package/lib/model.d.ts

@@ -94,6 +94,7 @@ export declare class JupyterGISModel implements IJupyterGISModel {
     getSources(): IJGISSources;
     getLayerTree(): IJGISLayerTree;
     getLayer(id: string): IJGISLayer | undefined;
+    getLayerOrSource(id: string): IJGISLayer | IJGISSource | undefined;
     getSource(id: string): IJGISSource | undefined;
     /**
      * Get a {[key: id]: name} dictionary of sources for a given source type
@@ -102,13 +103,6 @@ export declare class JupyterGISModel implements IJupyterGISModel {
     getSourcesByType(type: string): {
         [key: string]: string;
     };
-    /**
-     * Get the list of layers using a source.
-     *
-     * @param id - the source id.
-     * @returns a list of layer ids that use the source.
-     */
-    getLayersBySource(id: string): string[];
     /**
      * Add a layer group in the layer tree.
      *
@@ -131,6 +125,7 @@ export declare class JupyterGISModel implements IJupyterGISModel {
      */
     addLayer(id: string, layer: IJGISLayer, groupName?: string, position?: number): void;
     removeLayer(layer_id: string): void;
+    removeSource(sourceId: string): void;
     setOptions(value: IJGISOptions): void;
     getOptions(): IJGISOptions;
     syncViewport(viewport?: IViewPortState, emitter?: string): void;
@@ -180,6 +175,7 @@ export declare class JupyterGISModel implements IJupyterGISModel {
      * Set current slide index for the selected story.
      */
     setCurrentSegmentIndex(index: number): void;
+    get currentSegmentIndexChanged(): ISignal<this, number>;
     /**
      * Adds a story segment from the current map view
      * @returns Object with storySegmentId and storyMapId, or null if no extent/zoom found
@@ -226,7 +222,7 @@ export declare class JupyterGISModel implements IJupyterGISModel {
     addFeatureAsMs: (id: string, selectedFeature: string) => void;
     get addFeatureAsMsSignal(): Signal<this, string>;
     get updateLayerSignal(): Signal<this, string>;
-    triggerLayerUpdate: (layerId: string, layer: IJGISLayer) => void;
+    triggerLayerUpdate: (layerId: string, layer: IJGISLayer | IJGISSource) => void;
     get geolocation(): JgisCoordinates;
     set geolocation(geolocation: JgisCoordinates);
     get geolocationChanged(): Signal<this, JgisCoordinates>;
@@ -265,6 +261,7 @@ export declare class JupyterGISModel implements IJupyterGISModel {
     private _geolocationChanged;
     private _tileFeatureCache;
     private _currentSegmentIndex;
+    private _currentSegmentIndexChanged;
     stories: Map<string, IJGISStoryMap>;
 }
 export declare namespace JupyterGISModel {

package/lib/model.js

@@ -64,6 +64,7 @@ export class JupyterGISModel {
         this._editingChanged = new Signal(this);
         this._geolocationChanged = new Signal(this);
         this._tileFeatureCache = new Map();
+        this._currentSegmentIndexChanged = new Signal(this);
         this.stories = new Map();
         const { annotationModel, sharedModel, settingRegistry } = options;
         if (sharedModel) {
@@ -339,6 +340,10 @@ export class JupyterGISModel {
     getLayer(id) {
         return this.sharedModel.getLayer(id);
     }
+    getLayerOrSource(id) {
+        var _a;
+        return (_a = this.sharedModel.getLayer(id)) !== null && _a !== void 0 ? _a : this.sharedModel.getLayerSource(id);
+    }
     getSource(id) {
         return this.sharedModel.getLayerSource(id);
     }
@@ -356,22 +361,6 @@ export class JupyterGISModel {
         }
         return sources;
     }
-    /**
-     * Get the list of layers using a source.
-     *
-     * @param id - the source id.
-     * @returns a list of layer ids that use the source.
-     */
-    getLayersBySource(id) {
-        const usingLayers = [];
-        Object.entries(this.getLayers() || {}).forEach(([layerId, layer]) => {
-            var _a;
-            if (((_a = layer.parameters) === null || _a === void 0 ? void 0 : _a.source) === id) {
-                usingLayers.push(layerId);
-            }
-        });
-        return usingLayers;
-    }
     /**
      * Add a layer group in the layer tree.
      *
@@ -427,9 +416,14 @@ export class JupyterGISModel {
             });
         }
         else {
-            this.sharedModel.removeSource(source_id);
+            if (source_id) {
+                this.removeSource(source_id);
+            }
         }
     }
+    removeSource(sourceId) {
+        this.sharedModel.removeSource(sourceId);
+    }
     setOptions(value) {
         this._sharedModel.options = value;
     }
@@ -525,6 +519,10 @@ export class JupyterGISModel {
      */
     setCurrentSegmentIndex(index) {
         this._currentSegmentIndex = index;
+        this._currentSegmentIndexChanged.emit(index);
+    }
+    get currentSegmentIndexChanged() {
+        return this._currentSegmentIndexChanged;
     }
     /**
      * Adds a story segment from the current map view

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

@@ -94,6 +94,11 @@
                         "type": "object",
                         "description": "The color/style override",
                         "default": {}
+                    },
+                    "sourceProperties": {
+                        "type": "object",
+                        "description": "The symbology source override",
+                        "default": {}
                     }
                 }
             },

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

@@ -33,8 +33,7 @@
                     "default": "Single Symbol"
                 },
                 "value": {
-                    "type": "string",
-                    "default": ""
+                    "type": "string"
                 },
                 "method": {
                     "type": "string",
@@ -68,7 +67,6 @@
             "additionalProperties": false,
             "default": {
                 "renderType": "Single Symbol",
-                "value": "",
                 "method": "color",
                 "colorRamp": "viridis",
                 "nClasses": "9",

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

@@ -55,7 +55,7 @@
             "properties": {
                 "renderType": {
                     "type": "string",
-                    "default": "Single Symbol"
+                    "default": "Singleband Pseudocolor"
                 },
                 "band": {
                     "type": "number",
@@ -98,7 +98,7 @@
             },
             "additionalProperties": false,
             "default": {
-                "renderType": "Single Symbol",
+                "renderType": "Singleband Pseudocolor",
                 "band": 1,
                 "redBand": 1,
                 "greenBand": 2,

package/lib/schema/project/sources/geoJsonSource.json

@@ -6,20 +6,13 @@
     "additionalProperties": false,
     "properties": {
         "path": {
-            "type": "string",
-            "description": "The local path to a GeoJSON file",
-            "default": ""
+            "type": ["string", "null"],
+            "description": "The local path to a GeoJSON file"
         },
         "data": {
             "type": "object",
             "description": "The GeoJSON data",
             "$ref": "./geojson.json"
-        },
-        "valid": {
-            "type": "boolean",
-            "description": "Whether the data are valid or not",
-            "readOnly": true,
-            "default": false
         }
     }
 }

package/lib/schema/project/sources/rasterSource.json

@@ -7,8 +7,7 @@
     "properties": {
         "url": {
             "type": "string",
-            "description": "The url to the tile provider",
-            "default": ""
+            "description": "The url to the tile provider"
         },
         "minZoom": {
             "type": "number",
@@ -58,6 +57,7 @@
         },
         "urlParameters": {
             "type": "object",
+            "title": "URL parameters",
             "additionalProperties": {
                 "type": "string"
             },
@@ -65,6 +65,7 @@
         },
         "interpolate": {
             "type": "boolean",
+            "title": "Interpolate",
             "description": "Interpolate between grid cells when overzooming?",
             "default": false
         }

package/lib/schema/project/sources/vectorTileSource.json

@@ -7,8 +7,7 @@
     "properties": {
         "url": {
             "type": "string",
-            "description": "The url to the tile provider",
-            "default": ""
+            "description": "The url to the tile provider"
         },
         "minZoom": {
             "type": "number",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupytergis/schema",
-  "version": "0.13.2",
+  "version": "0.14.0",
   "description": "A JupyterGIS schema package.",
   "keywords": [
     "jupytergis"