@jupytergis/schema 0.1.1

package/lib/_interface/rastersource.d.ts

@@ -0,0 +1,43 @@
+/* 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.
+ */
+
+/**
+ * RasterSource
+ */
+export interface IRasterSource {
+  /**
+   * The url to the tile provider
+   */
+  url: string;
+  /**
+   * The minimum zoom level for the raster source
+   */
+  minZoom: number;
+  /**
+   * The maximum zoom level for the raster source
+   */
+  maxZoom: number;
+  /**
+   * The attribution for the raster source
+   */
+  attribution?: string;
+  /**
+   * The html attribution for the raster source
+   */
+  htmlAttribution?: string;
+  /**
+   * The map provider
+   */
+  provider?: string;
+  /**
+   * The bounds of the source
+   */
+  bounds?: number[][];
+  urlParameters?: {
+    [k: string]: string;
+  };
+}

package/lib/_interface/shapefileSource.d.ts

@@ -0,0 +1,34 @@
+/* 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.
+ */
+
+/**
+ * ShapefileSource
+ */
+export interface IShapefileSource {
+  /**
+   * The path to the shapefile (.shp, .zip, or folder URL).
+   */
+  path: string;
+  /**
+   * The attribution for the shapefile source.
+   */
+  attribution?: string;
+  /**
+   * The projection information for the shapefile (optional).
+   */
+  projection?: string;
+  /**
+   * The encoding used for the shapefile's DBF (optional).
+   */
+  encoding?: string;
+  /**
+   * Additional files associated with the shapefile (e.g., .dbf, .prj, .cpg).
+   */
+  additionalFiles?: {
+    [k: string]: string;
+  };
+}

package/lib/_interface/vectorTileLayer.d.ts

@@ -0,0 +1,32 @@
+/* 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.
+ */
+
+/**
+ * VectorTileLayer
+ */
+export interface IVectorTileLayer {
+  /**
+   * The id of the source
+   */
+  source: string;
+  /**
+   * The type of vector layer
+   */
+  type: "circle" | "fill" | "line";
+  /**
+   * The source layer to use
+   */
+  sourceLayer?: string;
+  /**
+   * The color of the the object
+   */
+  color?: string;
+  /**
+   * The opacity of the the object
+   */
+  opacity?: number;
+}

package/lib/_interface/vectorlayer.d.ts

@@ -0,0 +1,32 @@
+/* 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.
+ */
+
+/**
+ * VectorLayer
+ */
+export interface IVectorLayer {
+  /**
+   * The id of the source
+   */
+  source: string;
+  /**
+   * The type of vector layer
+   */
+  type: "circle" | "fill" | "line";
+  /**
+   * The source layer to use
+   */
+  sourceLayer?: string;
+  /**
+   * The color of the the object
+   */
+  color?: string;
+  /**
+   * The opacity of the the object
+   */
+  opacity?: number;
+}

package/lib/_interface/vectortilesource.d.ts

@@ -0,0 +1,35 @@
+/* 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.
+ */
+
+/**
+ * VectorTileSource
+ */
+export interface IVectorTileSource {
+  /**
+   * The url to the tile provider
+   */
+  url: string;
+  /**
+   * The minimum zoom level for the vector source
+   */
+  minZoom: number;
+  /**
+   * The maximum zoom level for the vector source
+   */
+  maxZoom: number;
+  /**
+   * The attribution for the vector source
+   */
+  attribution?: string;
+  /**
+   * The map provider
+   */
+  provider?: string;
+  urlParameters?: {
+    [k: string]: string;
+  };
+}

package/lib/_interface/videoSource.d.ts

@@ -0,0 +1,20 @@
+/* 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.
+ */
+
+/**
+ * VideoSource
+ */
+export interface IVideoSource {
+  /**
+   * URLs to video content in order of preferred format
+   */
+  urls: [string, ...string[]];
+  /**
+   * Corners of video specified in longitude, latitude pairs
+   */
+  coordinates: [[number, number], [number, number], [number, number], [number, number]];
+}

package/lib/_interface/webGlLayer.d.ts

@@ -0,0 +1,24 @@
+/* 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 | (string | number | string[])[];
+}

package/lib/doc.d.ts

@@ -0,0 +1,59 @@
+import { MapChange, YDocument } from '@jupyter/ydoc';
+import { ISignal } from '@lumino/signaling';
+import { IJGISLayer, IJGISLayerItem, IJGISLayerTree, IJGISLayers, IJGISOptions, IJGISSource, IJGISSources, IJGISTerrain } from './_interface/jgis';
+import { IDict, IJGISLayerDocChange, IJGISLayerTreeDocChange, IJGISSourceDocChange, IJupyterGISDoc, IJupyterGISDocChange } from './interfaces';
+export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> implements IJupyterGISDoc {
+    constructor();
+    dispose(): void;
+    get version(): string;
+    get layers(): IJGISLayers;
+    set layers(layers: IJGISLayers);
+    set sources(sources: IJGISSources);
+    get sources(): IJGISSources;
+    get layerTree(): IJGISLayerTree;
+    set layerTree(layerTree: IJGISLayerTree);
+    get terrain(): IJGISTerrain;
+    set terrain(terrain: IJGISTerrain);
+    getLayer(id: string): IJGISLayer | undefined;
+    getSource(id: string): IJGISSource | undefined;
+    set options(options: IJGISOptions);
+    get options(): IJGISOptions;
+    get layersChanged(): ISignal<IJupyterGISDoc, IJGISLayerDocChange>;
+    get layerTreeChanged(): ISignal<IJupyterGISDoc, IJGISLayerTreeDocChange>;
+    get sourcesChanged(): ISignal<IJupyterGISDoc, IJGISSourceDocChange>;
+    get optionsChanged(): ISignal<IJupyterGISDoc, MapChange>;
+    get terrainChanged(): ISignal<IJupyterGISDoc, IJGISTerrain>;
+    layerExists(id: string): boolean;
+    removeLayer(id: string): void;
+    addLayer(id: string, value: IJGISLayer): void;
+    updateLayer(id: string, value: IJGISLayer): void;
+    addLayerTreeItem(index: number, item: IJGISLayerItem): void;
+    updateLayerTreeItem(index: number, item: IJGISLayerItem): void;
+    getObject(id: string): IJGISLayer | IJGISSource | undefined;
+    updateObjectParameters(id: string, value: IJGISLayer['parameters'] | IJGISSource['parameters']): void;
+    sourceExists(id: string): boolean;
+    removeSource(id: string): void;
+    addSource(id: string, value: IJGISSource): void;
+    updateSource(id: string, value: any): void;
+    getOption(key: keyof IJGISOptions): IDict | undefined;
+    setOption(key: keyof IJGISOptions, value: IDict): void;
+    static create(): IJupyterGISDoc;
+    editable: boolean;
+    private _getLayerAsYMap;
+    private _getSourceAsYMap;
+    private _layersObserver;
+    private _layerTreeObserver;
+    private _sourcesObserver;
+    private _terrainObserver;
+    private _optionsObserver;
+    private _layers;
+    private _layerTree;
+    private _sources;
+    private _options;
+    private _terrain;
+    private _optionsChanged;
+    private _layersChanged;
+    private _layerTreeChanged;
+    private _sourcesChanged;
+    private _terrainChanged;
+}

package/lib/doc.js

@@ -0,0 +1,251 @@
+import { YDocument } from '@jupyter/ydoc';
+import { JSONExt } from '@lumino/coreutils';
+import { Signal } from '@lumino/signaling';
+export class JupyterGISDoc extends YDocument {
+    constructor() {
+        super();
+        this.editable = true;
+        this._optionsObserver = (event) => {
+            this._optionsChanged.emit(event.keys);
+        };
+        this._optionsChanged = new Signal(this);
+        this._layersChanged = new Signal(this);
+        this._layerTreeChanged = new Signal(this);
+        this._sourcesChanged = new Signal(this);
+        this._terrainChanged = new Signal(this);
+        this._options = this.ydoc.getMap('options');
+        this._layers = this.ydoc.getMap('layers');
+        this._layerTree = this.ydoc.getArray('layerTree');
+        this._sources = this.ydoc.getMap('sources');
+        this._terrain = this.ydoc.getMap('terrain');
+        this.undoManager.addToScope(this._layers);
+        this.undoManager.addToScope(this._sources);
+        this.undoManager.addToScope(this._layerTree);
+        this._layers.observeDeep(this._layersObserver.bind(this));
+        this._layerTree.observe(this._layerTreeObserver.bind(this));
+        this._sources.observeDeep(this._sourcesObserver.bind(this));
+        this._terrain.observe(this._terrainObserver.bind(this));
+        this._options.observe(this._optionsObserver.bind(this));
+    }
+    dispose() {
+        super.dispose();
+    }
+    get version() {
+        return '0.1.0';
+    }
+    get layers() {
+        return JSONExt.deepCopy(this._layers.toJSON());
+    }
+    set layers(layers) {
+        this.transact(() => {
+            for (const [key, value] of Object.entries(layers)) {
+                this._layers.set(key, value);
+            }
+        });
+    }
+    set sources(sources) {
+        this.transact(() => {
+            for (const [key, value] of Object.entries(sources)) {
+                this._sources.set(key, value);
+            }
+        });
+    }
+    get sources() {
+        return JSONExt.deepCopy(this._sources.toJSON());
+    }
+    get layerTree() {
+        return JSONExt.deepCopy(this._layerTree.toJSON());
+    }
+    set layerTree(layerTree) {
+        this.transact(() => {
+            this._layerTree.delete(0, this._layerTree.length);
+            this._layerTree.push(layerTree);
+        });
+    }
+    get terrain() {
+        return JSONExt.deepCopy(this._terrain.toJSON());
+    }
+    set terrain(terrain) {
+        this.transact(() => {
+            for (const [key, value] of Object.entries(terrain)) {
+                this._terrain.set(key, value);
+            }
+        });
+    }
+    getLayer(id) {
+        if (!this._layers.has(id)) {
+            return undefined;
+        }
+        return JSONExt.deepCopy(this._layers.get(id));
+    }
+    getSource(id) {
+        if (!this._sources.has(id)) {
+            return undefined;
+        }
+        return JSONExt.deepCopy(this._sources.get(id));
+    }
+    set options(options) {
+        this.transact(() => {
+            for (const [key, value] of Object.entries(options)) {
+                this._options.set(key, value);
+            }
+        });
+    }
+    get options() {
+        return JSONExt.deepCopy(this._options.toJSON());
+    }
+    get layersChanged() {
+        return this._layersChanged;
+    }
+    get layerTreeChanged() {
+        return this._layerTreeChanged;
+    }
+    get sourcesChanged() {
+        return this._sourcesChanged;
+    }
+    get optionsChanged() {
+        return this._optionsChanged;
+    }
+    get terrainChanged() {
+        return this._terrainChanged;
+    }
+    layerExists(id) {
+        return Boolean(this._getLayerAsYMap(id));
+    }
+    removeLayer(id) {
+        this.transact(() => {
+            this._layers.delete(id);
+        });
+    }
+    addLayer(id, value) {
+        this.transact(() => {
+            this._layers.set(id, value);
+        });
+    }
+    updateLayer(id, value) {
+        this.transact(() => {
+            this._layers.set(id, value);
+        });
+    }
+    addLayerTreeItem(index, item) {
+        this.transact(() => {
+            this._layerTree.insert(index, [item]);
+        });
+    }
+    updateLayerTreeItem(index, item) {
+        this.transact(() => {
+            this._layerTree.delete(index);
+            if (item) {
+                this._layerTree.insert(index, [item]);
+            }
+        });
+    }
+    getObject(id) {
+        const layer = this.getLayer(id);
+        if (layer) {
+            return layer;
+        }
+        const source = this.getSource(id);
+        if (source) {
+            return source;
+        }
+    }
+    updateObjectParameters(id, value) {
+        const layer = this.getLayer(id);
+        if (layer) {
+            layer.parameters = Object.assign(Object.assign({}, layer.parameters), value);
+            this.updateLayer(id, layer);
+        }
+        const source = this.getSource(id);
+        if (source) {
+            source.parameters = Object.assign(Object.assign({}, source.parameters), value);
+            this.updateSource(id, source);
+        }
+    }
+    sourceExists(id) {
+        return Boolean(this._getSourceAsYMap(id));
+    }
+    removeSource(id) {
+        this.transact(() => {
+            this._sources.delete(id);
+        });
+    }
+    addSource(id, value) {
+        this.transact(() => {
+            this._sources.set(id, value);
+        });
+    }
+    updateSource(id, value) {
+        this.transact(() => this._sources.set(id, value));
+    }
+    getOption(key) {
+        const content = this._options.get(key);
+        if (!content) {
+            return;
+        }
+        return JSONExt.deepCopy(content);
+    }
+    setOption(key, value) {
+        this.transact(() => void this._options.set(key, value));
+    }
+    static create() {
+        return new JupyterGISDoc();
+    }
+    _getLayerAsYMap(id) {
+        if (this._layers.has(id)) {
+            return this._layers.get(id);
+        }
+        return undefined;
+    }
+    _getSourceAsYMap(id) {
+        if (this._sources.has(id)) {
+            return this._sources.get(id);
+        }
+        return undefined;
+    }
+    _layersObserver(events) {
+        const changes = [];
+        let needEmit = false;
+        events.forEach(event => {
+            event.keys.forEach((change, key) => {
+                if (!needEmit) {
+                    needEmit = true;
+                }
+                changes.push({
+                    id: key,
+                    newValue: JSONExt.deepCopy(event.target.toJSON()[key])
+                });
+            });
+        });
+        needEmit = changes.length === 0 ? true : needEmit;
+        if (needEmit) {
+            this._layersChanged.emit({ layerChange: changes });
+        }
+    }
+    _layerTreeObserver(event) {
+        const layerTreeChanges = event.delta;
+        this._layerTreeChanged.emit({ layerTreeChange: layerTreeChanges });
+    }
+    _sourcesObserver(events) {
+        const changes = [];
+        let needEmit = false;
+        events.forEach(event => {
+            event.keys.forEach((change, key) => {
+                if (!needEmit) {
+                    needEmit = true;
+                }
+                changes.push({
+                    id: key,
+                    newValue: JSONExt.deepCopy(event.target.toJSON()[key])
+                });
+            });
+        });
+        needEmit = changes.length === 0 ? true : needEmit;
+        if (needEmit) {
+            this._sourcesChanged.emit({ sourceChange: changes });
+        }
+    }
+    _terrainObserver(event) {
+        this._terrainChanged.emit(this.terrain);
+    }
+}

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+export * from './interfaces';
+export * from './model';
+export * from './token';
+export * from './doc';

package/lib/index.js

@@ -0,0 +1,4 @@
+export * from './interfaces';
+export * from './model';
+export * from './token';
+export * from './doc';