@jupytergis/schema 0.10.1 → 0.12.0

package/lib/_interface/forms.json

@@ -302,6 +302,70 @@
       }
     }
   },
+  "StorySegmentLayer": {
+    "type": "object",
+    "additionalProperties": false,
+    "required": [
+      "zoom",
+      "extent",
+      "transition"
+    ],
+    "properties": {
+      "zoom": {
+        "type": "number",
+        "default": 0
+      },
+      "extent": {
+        "type": "array",
+        "default": null,
+        "items": {
+          "type": "number"
+        }
+      },
+      "content": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "title": {
+            "type": "string"
+          },
+          "image": {
+            "type": "string",
+            "description": "Link to image for the story"
+          },
+          "markdown": {
+            "type": "string",
+            "description": "Markdown string representing the content of the story stop"
+          }
+        }
+      },
+      "transition": {
+        "type": "object",
+        "description": "Transition configuration between to this story segment",
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "linear",
+              "immediate",
+              "smooth"
+            ],
+            "description": "Transition animation style",
+            "default": "linear"
+          },
+          "time": {
+            "type": "number",
+            "description": "The time in seconds for the transition",
+            "default": 1
+          }
+        },
+        "required": [
+          "type",
+          "time"
+        ]
+      }
+    }
+  },
   "VectorLayer": {
     "type": "object",
     "required": [

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

@@ -17,7 +17,8 @@ export type LayerType =
   | "WebGlLayer"
   | "ImageLayer"
   | "HeatmapLayer"
-  | "StacLayer";
+  | "StacLayer"
+  | "StorySegmentLayer";
 /**
  * This interface was referenced by `IJGISContent`'s JSON-Schema
  * via the `definition` "sourceType".
@@ -43,6 +44,23 @@ export type IJGISLayerItem = string | IJGISLayerGroup;
  * via the `definition` "jGISLayerTree".
  */
 export type IJGISLayerTree = IJGISLayerItem[];
+export type WhetherPresentationModeIsActive = boolean;
+/**
+ * The title of the story map
+ */
+export type Title = string;
+/**
+ * The type of story map
+ */
+export type StoryType = "guided" | "unguided";
+/**
+ * The background color of the story map
+ */
+export type PresentationBackgroundColor = string;
+/**
+ * The text color of the story map
+ */
+export type PresentationTextColor = string;
 
 export interface IJGISContent {
   schemaVersion?: string;
@@ -50,6 +68,7 @@ export interface IJGISContent {
   sources: IJGISSources;
   layerTree?: IJGISLayerTree;
   options?: IJGISOptions;
+  stories?: IJGISStoryMap;
   metadata?: {
     /**
      * This interface was referenced by `undefined`'s JSON-Schema definition
@@ -140,4 +159,20 @@ export interface IJGISOptions {
   extent?: number[];
   projection?: string;
   useExtent?: boolean;
+  storyMapPresentationMode?: WhetherPresentationModeIsActive;
+}
+/**
+ * This interface was referenced by `IJGISContent`'s JSON-Schema
+ * via the `definition` "jGISStoryMap".
+ */
+export interface IJGISStoryMap {
+  title?: Title;
+  storyType?: StoryType;
+  /**
+   * Array of story segments for the story map
+   */
+  storySegments?: string[];
+  presentaionBgColor?: PresentationBackgroundColor;
+  presentaionTextColor?: PresentationTextColor;
+  [k: string]: any;
 }

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

@@ -0,0 +1,39 @@
+/* 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.
+ */
+
+/**
+ * StorySegmentLayer
+ */
+export interface IStorySegmentLayer {
+  zoom: number;
+  extent: number[];
+  content?: {
+    title?: string;
+    /**
+     * Link to image for the story
+     */
+    image?: string;
+    /**
+     * Markdown string representing the content of the story stop
+     */
+    markdown?: string;
+  };
+  /**
+   * Transition configuration between to this story segment
+   */
+  transition: {
+    /**
+     * Transition animation style
+     */
+    type: "linear" | "immediate" | "smooth";
+    /**
+     * The time in seconds for the transition
+     */
+    time: number;
+    [k: string]: any;
+  };
+}

package/lib/doc.d.ts

@@ -1,8 +1,8 @@
 import { MapChange, YDocument } from '@jupyter/ydoc';
 import { JSONObject } from '@lumino/coreutils';
 import { ISignal } from '@lumino/signaling';
-import { IJGISLayer, IJGISLayerItem, IJGISLayerTree, IJGISLayers, IJGISOptions, IJGISSource, IJGISSources } from './_interface/project/jgis';
-import { IDict, IJGISLayerDocChange, IJGISLayerTreeDocChange, IJGISSourceDocChange, IJupyterGISDoc, IJupyterGISDocChange } from './interfaces';
+import { IJGISLayer, IJGISLayerItem, IJGISLayerTree, IJGISLayers, IJGISOptions, IJGISSource, IJGISSources, IJGISStoryMap } from './_interface/project/jgis';
+import { IDict, IJGISLayerDocChange, IJGISLayerTreeDocChange, IJGISSourceDocChange, IJGISStoryMapDocChange, IJGISStoryMaps, IJupyterGISDoc, IJupyterGISDocChange } from './interfaces';
 export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> implements IJupyterGISDoc {
     constructor();
     getSource(): JSONObject;
@@ -13,6 +13,8 @@ export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> imple
     set layers(layers: IJGISLayers);
     set sources(sources: IJGISSources);
     get sources(): IJGISSources;
+    set stories(stories: IJGISStoryMaps);
+    get stories(): IJGISStoryMaps;
     get layerTree(): IJGISLayerTree;
     set layerTree(layerTree: IJGISLayerTree);
     getLayer(id: string): IJGISLayer | undefined;
@@ -22,6 +24,7 @@ export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> imple
     get layersChanged(): ISignal<IJupyterGISDoc, IJGISLayerDocChange>;
     get layerTreeChanged(): ISignal<IJupyterGISDoc, IJGISLayerTreeDocChange>;
     get sourcesChanged(): ISignal<IJupyterGISDoc, IJGISSourceDocChange>;
+    get storyMapsChanged(): ISignal<IJupyterGISDoc, IJGISStoryMapDocChange>;
     get optionsChanged(): ISignal<IJupyterGISDoc, MapChange>;
     layerExists(id: string): boolean;
     removeLayer(id: string): void;
@@ -35,6 +38,10 @@ export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> imple
     removeSource(id: string): void;
     addSource(id: string, value: IJGISSource): void;
     updateSource(id: string, value: any): void;
+    removeStoryMap(id: string): void;
+    addStoryMap(id: string, value: IJGISStoryMap): void;
+    updateStoryMap(id: string, value: any): void;
+    getStoryMap(id: string): IJGISStoryMap | undefined;
     getOption(key: keyof IJGISOptions): IDict | undefined;
     setOption(key: keyof IJGISOptions, value: IDict): void;
     getMetadata(key: string): string | undefined;
@@ -52,16 +59,19 @@ export declare class JupyterGISDoc extends YDocument<IJupyterGISDocChange> imple
     private _layersObserver;
     private _layerTreeObserver;
     private _sourcesObserver;
+    private _storyMapsObserver;
     private _optionsObserver;
     private _metaObserver;
     private _layers;
     private _layerTree;
     private _sources;
+    private _stories;
     private _options;
     private _metadata;
     private _optionsChanged;
     private _layersChanged;
     private _layerTreeChanged;
     private _sourcesChanged;
+    private _storyMapsChanged;
     private _metadataChanged;
 }

package/lib/doc.js

@@ -7,27 +7,47 @@ export class JupyterGISDoc extends YDocument {
         super();
         this.editable = true;
         this._optionsObserver = (event) => {
-            this._optionsChanged.emit(event.keys);
+            const changes = new Map();
+            event.changes.keys.forEach((event, key) => {
+                changes.set(key, {
+                    action: event.action,
+                    oldValue: event.oldValue,
+                    newValue: this._options.get(key),
+                });
+            });
+            this._optionsChanged.emit(changes);
         };
         this._metaObserver = (event) => {
-            this._metadataChanged.emit(event.keys);
+            const changes = new Map();
+            event.changes.keys.forEach((event, key) => {
+                changes.set(key, {
+                    action: event.action,
+                    oldValue: event.oldValue,
+                    newValue: this._metadata.get(key),
+                });
+            });
+            this._metadataChanged.emit(changes);
         };
         this._optionsChanged = new Signal(this);
         this._layersChanged = new Signal(this);
         this._layerTreeChanged = new Signal(this);
         this._sourcesChanged = new Signal(this);
+        this._storyMapsChanged = new Signal(this);
         this._metadataChanged = 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._stories = this.ydoc.getMap('stories');
         this._metadata = this.ydoc.getMap('metadata');
         this.undoManager.addToScope(this._layers);
         this.undoManager.addToScope(this._sources);
+        this.undoManager.addToScope(this._stories);
         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._stories.observeDeep(this._storyMapsObserver.bind(this));
         this._options.observe(this._optionsObserver.bind(this));
         this._metadata.observe(this._metaObserver.bind(this));
     }
@@ -36,8 +56,9 @@ export class JupyterGISDoc extends YDocument {
         const layerTree = this._layerTree.toJSON();
         const options = this._options.toJSON();
         const sources = this._sources.toJSON();
+        const stories = this._stories.toJSON();
         const metadata = this._metadata.toJSON();
-        return { layers, layerTree, sources, options, metadata };
+        return { layers, layerTree, sources, stories, options, metadata };
     }
     setSource(value) {
         if (!value) {
@@ -48,7 +69,7 @@ export class JupyterGISDoc extends YDocument {
         }
         value = value;
         this.transact(() => {
-            var _a, _b, _c, _d, _e;
+            var _a, _b, _c, _d, _e, _f;
             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 : [];
@@ -59,7 +80,9 @@ export class JupyterGISDoc extends YDocument {
             Object.entries(options).forEach(([key, val]) => this._options.set(key, val));
             const sources = (_d = value['sources']) !== null && _d !== void 0 ? _d : {};
             Object.entries(sources).forEach(([key, val]) => this._sources.set(key, val));
-            const metadata = (_e = value['metadata']) !== null && _e !== void 0 ? _e : {};
+            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 : {};
             Object.entries(metadata).forEach(([key, val]) => this._metadata.set(key, val));
         });
     }
@@ -89,6 +112,16 @@ export class JupyterGISDoc extends YDocument {
     get sources() {
         return JSONExt.deepCopy(this._sources.toJSON());
     }
+    set stories(stories) {
+        this.transact(() => {
+            for (const [key, value] of Object.entries(stories)) {
+                this._stories.set(key, value);
+            }
+        });
+    }
+    get stories() {
+        return JSONExt.deepCopy(this._stories.toJSON());
+    }
     get layerTree() {
         return JSONExt.deepCopy(this._layerTree.toJSON());
     }
@@ -129,6 +162,9 @@ export class JupyterGISDoc extends YDocument {
     get sourcesChanged() {
         return this._sourcesChanged;
     }
+    get storyMapsChanged() {
+        return this._storyMapsChanged;
+    }
     get optionsChanged() {
         return this._optionsChanged;
     }
@@ -201,6 +237,25 @@ export class JupyterGISDoc extends YDocument {
     updateSource(id, value) {
         this.transact(() => this._sources.set(id, value));
     }
+    removeStoryMap(id) {
+        this.transact(() => {
+            this._stories.delete(id);
+        });
+    }
+    addStoryMap(id, value) {
+        this.transact(() => {
+            this._stories.set(id, value);
+        });
+    }
+    updateStoryMap(id, value) {
+        this.transact(() => this._stories.set(id, value));
+    }
+    getStoryMap(id) {
+        if (!this._stories.has(id)) {
+            return undefined;
+        }
+        return JSONExt.deepCopy(this._stories.get(id));
+    }
     getOption(key) {
         const content = this._options.get(key);
         if (!content) {
@@ -293,4 +348,23 @@ export class JupyterGISDoc extends YDocument {
             this._sourcesChanged.emit({ sourceChange: changes });
         }
     }
+    _storyMapsObserver(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._storyMapsChanged.emit({ storyMapChange: changes });
+        }
+    }
 }

package/lib/interfaces.d.ts

@@ -9,10 +9,13 @@ import { JSONObject } from '@lumino/coreutils';
 import { ISignal, Signal } from '@lumino/signaling';
 import { SplitPanel } from '@lumino/widgets';
 import { FeatureLike } from 'ol/Feature';
-import { IJGISContent, IJGISLayer, IJGISLayerGroup, IJGISLayerItem, IJGISLayers, IJGISLayerTree, IJGISOptions, IJGISSource, IJGISSources, SourceType } from './_interface/project/jgis';
+import { IJGISContent, IJGISLayer, IJGISLayerGroup, IJGISLayerItem, IJGISLayers, IJGISLayerTree, IJGISOptions, IJGISSource, IJGISSources, IJGISStoryMap, SourceType } from './_interface/project/jgis';
 import { IRasterSource } from './_interface/project/sources/rasterSource';
 import { Modes } from './types';
 export { IGeoJSONSource } from './_interface/project/sources/geoJsonSource';
+export interface IJGISStoryMaps {
+    [k: string]: IJGISStoryMap;
+}
 export type JgisCoordinates = {
     x: number;
     y: number;
@@ -40,6 +43,12 @@ export interface IJGISLayerDocChange {
 export interface IJGISLayerTreeDocChange {
     layerTreeChange?: Delta<IJGISLayerItem[]>;
 }
+export interface IJGISStoryMapDocChange {
+    storyMapChange?: Array<{
+        id: string;
+        newValue: IJGISStoryMap | undefined;
+    }>;
+}
 export interface IJGISSourceDocChange {
     sourceChange?: Array<{
         id: string;
@@ -84,6 +93,7 @@ export interface IJupyterGISDoc extends YDocument<IJupyterGISDocChange> {
     options: IJGISOptions;
     layers: IJGISLayers;
     sources: IJGISSources;
+    stories: IJGISStoryMaps;
     layerTree: IJGISLayerTree;
     metadata: any;
     readonly editable: boolean;
@@ -100,6 +110,10 @@ export interface IJupyterGISDoc extends YDocument<IJupyterGISDocChange> {
     removeSource(id: string): void;
     addSource(id: string, value: IJGISSource): void;
     updateSource(id: string, value: IJGISSource): void;
+    getStoryMap(id: string): IJGISStoryMap | undefined;
+    removeStoryMap(id: string): void;
+    addStoryMap(id: string, value: IJGISStoryMap): void;
+    updateStoryMap(id: string, value: IJGISStoryMap): void;
     addLayerTreeItem(index: number, item: IJGISLayerItem): void;
     updateLayerTreeItem(index: number, item: IJGISLayerItem): void;
     updateObjectParameters(id: string, value: IJGISLayer['parameters'] | IJGISSource['parameters']): void;
@@ -112,6 +126,7 @@ export interface IJupyterGISDoc extends YDocument<IJupyterGISDocChange> {
     optionsChanged: ISignal<IJupyterGISDoc, MapChange>;
     layersChanged: ISignal<IJupyterGISDoc, IJGISLayerDocChange>;
     sourcesChanged: ISignal<IJupyterGISDoc, IJGISSourceDocChange>;
+    storyMapsChanged: ISignal<IJupyterGISDoc, IJGISStoryMapDocChange>;
     layerTreeChanged: ISignal<IJupyterGISDoc, IJGISLayerTreeDocChange>;
     metadataChanged: ISignal<IJupyterGISDoc, MapChange>;
 }
@@ -151,6 +166,7 @@ export interface IJupyterGISModel extends DocumentRegistry.IModel {
     contentsManager: Contents.IManager | undefined;
     filePath: string;
     pathChanged: ISignal<IJupyterGISModel, string>;
+    stories: Map<string, IJGISStoryMap>;
     getFeaturesForCurrentTile: ({ sourceId, }: {
         sourceId: string;
     }) => FeatureLike[];
@@ -212,6 +228,15 @@ export interface IJupyterGISModel extends DocumentRegistry.IModel {
     addFeatureAsMs(id: string, selectedFeature: string): void;
     triggerLayerUpdate(layerId: string, layer: IJGISLayer): void;
     disposed: ISignal<any, void>;
+    getSelectedStory(): {
+        storyId: string;
+        story: IJGISStoryMap | undefined;
+    };
+    addStorySegment(): {
+        storySegmentId: string;
+        storyId: string;
+    } | null;
+    isSpectaMode(): boolean;
 }
 export interface IUserData {
     userId: number;
@@ -316,4 +341,6 @@ export interface IJupyterGISSettings {
     objectPropertiesDisabled?: boolean;
     annotationsDisabled?: boolean;
     identifyDisabled?: boolean;
+    storyMapsDisabled: boolean;
+    zoomButtonsEnabled?: boolean;
 }

package/lib/model.d.ts

@@ -6,7 +6,7 @@ import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { PartialJSONObject } from '@lumino/coreutils';
 import { ISignal, Signal } from '@lumino/signaling';
 import { FeatureLike } from 'ol/Feature';
-import { IJGISContent, IJGISLayer, IJGISLayerGroup, IJGISLayerTree, IJGISLayers, IJGISOptions, IJGISSource, IJGISSources } from './_interface/project/jgis';
+import { IJGISContent, IJGISLayer, IJGISLayerGroup, IJGISLayerTree, IJGISLayers, IJGISOptions, IJGISSource, IJGISSources, IJGISStoryMap } from './_interface/project/jgis';
 import { IAnnotationModel, IDict, IJGISLayerDocChange, IJGISLayerTreeDocChange, IJGISSourceDocChange, IJupyterGISClientState, IJupyterGISDoc, IJupyterGISModel, ISelection, IUserData, IViewPortState, JgisCoordinates, Pointer, IJupyterGISSettings, SelectionType } from './interfaces';
 import { Modes } from './types';
 export declare class JupyterGISModel implements IJupyterGISModel {
@@ -157,6 +157,29 @@ export declare class JupyterGISModel implements IJupyterGISModel {
         itemId: string;
     } | null>;
     getClientId(): number;
+    /**
+     * Check if the application is running in Specta mode.
+     * Specta mode is enabled when the URL contains 'specta' AND the model has stories.
+     *
+     * @returns True if running in Specta mode
+     */
+    isSpectaMode(): boolean;
+    /**
+     * Placeholder in case we eventually want to support multiple stories
+     * @returns First/only story
+     */
+    getSelectedStory(): {
+        storyId: string;
+        story: IJGISStoryMap | undefined;
+    };
+    /**
+     * Adds a story segment from the current map view
+     * @returns Object with storySegmentId and storyMapId, or null if no extent/zoom found
+     */
+    addStorySegment(): {
+        storySegmentId: string;
+        storyId: string;
+    } | null;
     /**
      * Add an item in the layer tree.
      *
@@ -179,7 +202,7 @@ export declare class JupyterGISModel implements IJupyterGISModel {
     removeLayerGroup(groupName: string): void;
     /**
      * Toggle a map interaction mode on or off.
-     * Toggleing off sets the mode to 'panning'.
+     * Toggling off sets the mode to 'panning'.
      * @param mode The mode to be toggled
      */
     toggleMode(mode: Modes): void;
@@ -228,6 +251,7 @@ export declare class JupyterGISModel implements IJupyterGISModel {
     private _geolocation;
     private _geolocationChanged;
     private _tileFeatureCache;
+    stories: Map<string, IJGISStoryMap>;
 }
 export declare namespace JupyterGISModel {
     /**

package/lib/model.js

@@ -1,3 +1,4 @@
+import { UUID } from '@lumino/coreutils';
 import { Signal } from '@lumino/signaling';
 import Ajv from 'ajv';
 import { JupyterGISDoc } from './doc';
@@ -13,6 +14,8 @@ const DEFAULT_SETTINGS = {
     objectPropertiesDisabled: false,
     annotationsDisabled: false,
     identifyDisabled: false,
+    storyMapsDisabled: false,
+    zoomButtonsEnabled: false,
 };
 export class JupyterGISModel {
     constructor(options) {
@@ -60,6 +63,7 @@ export class JupyterGISModel {
         this._editingChanged = new Signal(this);
         this._geolocationChanged = new Signal(this);
         this._tileFeatureCache = new Map();
+        this.stories = new Map();
         const { annotationModel, sharedModel, settingRegistry } = options;
         if (sharedModel) {
             this._sharedModel = sharedModel;
@@ -258,11 +262,12 @@ export class JupyterGISModel {
             console.warn(errorMsg);
         }
         this.sharedModel.transact(() => {
-            var _a, _b, _c, _d, _e;
+            var _a, _b, _c, _d, _e, _f;
             this.sharedModel.sources = (_a = jsonData.sources) !== null && _a !== void 0 ? _a : {};
             this.sharedModel.layers = (_b = jsonData.layers) !== null && _b !== void 0 ? _b : {};
             this.sharedModel.layerTree = (_c = jsonData.layerTree) !== null && _c !== void 0 ? _c : [];
-            this.sharedModel.options = (_d = jsonData.options) !== null && _d !== void 0 ? _d : {
+            this.sharedModel.stories = (_d = jsonData.stories) !== null && _d !== void 0 ? _d : {};
+            this.sharedModel.options = (_e = jsonData.options) !== null && _e !== void 0 ? _e : {
                 latitude: 0,
                 longitude: 0,
                 zoom: 0,
@@ -270,7 +275,7 @@ export class JupyterGISModel {
                 pitch: 0,
                 projection: 'EPSG:3857',
             };
-            this.sharedModel.metadata = (_e = jsonData.metadata) !== null && _e !== void 0 ? _e : {};
+            this.sharedModel.metadata = (_f = jsonData.metadata) !== null && _f !== void 0 ? _f : {};
         });
         this.dirty = true;
     }
@@ -409,7 +414,19 @@ export class JupyterGISModel {
         const source_id = (_a = layer === null || layer === void 0 ? void 0 : layer.parameters) === null || _a === void 0 ? void 0 : _a.source;
         this._removeLayerTreeLayer(this.getLayerTree(), layer_id);
         this.sharedModel.removeLayer(layer_id);
-        this.sharedModel.removeSource(source_id);
+        if ((layer === null || layer === void 0 ? void 0 : layer.type) === 'StorySegmentLayer') {
+            // remove this layer id from story maps
+            Object.entries(this.sharedModel.stories).forEach(([storyMapId, storyMap]) => {
+                var _a;
+                if ((_a = storyMap.storySegments) === null || _a === void 0 ? void 0 : _a.includes(layer_id)) {
+                    const updatedStorySegments = storyMap.storySegments.filter(id => id !== layer_id);
+                    this.sharedModel.updateStoryMap(storyMapId, Object.assign(Object.assign({}, storyMap), { storySegments: updatedStorySegments }));
+                }
+            });
+        }
+        else {
+            this.sharedModel.removeSource(source_id);
+        }
     }
     setOptions(value) {
         this._sharedModel.options = value;
@@ -470,6 +487,78 @@ export class JupyterGISModel {
     getClientId() {
         return this.sharedModel.awareness.clientID;
     }
+    /**
+     * Check if the application is running in Specta mode.
+     * Specta mode is enabled when the URL contains 'specta' AND the model has stories.
+     *
+     * @returns True if running in Specta mode
+     */
+    isSpectaMode() {
+        var _a;
+        const hasStories = Object.keys(this.sharedModel.stories).length > 0;
+        const isSpecta = !!document.querySelector('meta[name="specta-config"]');
+        const guidedMode = ((_a = this.getSelectedStory().story) === null || _a === void 0 ? void 0 : _a.storyType) === 'guided';
+        return isSpecta && hasStories && guidedMode;
+    }
+    /**
+     * Placeholder in case we eventually want to support multiple stories
+     * @returns First/only story
+     */
+    getSelectedStory() {
+        const stories = this.sharedModel.stories;
+        const storyId = Object.keys(stories)[0];
+        return {
+            storyId: storyId,
+            story: this.sharedModel.getStoryMap(storyId),
+        };
+    }
+    /**
+     * Adds a story segment from the current map view
+     * @returns Object with storySegmentId and storyMapId, or null if no extent/zoom found
+     */
+    addStorySegment() {
+        var _a;
+        const { zoom, extent } = this.getOptions();
+        const { storyId } = this.getSelectedStory();
+        if (!zoom || !extent) {
+            console.warn('No extent or zoom found');
+            return null;
+        }
+        const newStorySegmentId = UUID.uuid4();
+        const layerParams = {
+            extent,
+            zoom,
+            transition: { type: 'linear', time: 1 },
+        };
+        const layerModel = {
+            type: 'StorySegmentLayer',
+            visible: true,
+            name: 'Story Segment',
+            parameters: layerParams,
+        };
+        this.addLayer(newStorySegmentId, layerModel);
+        // if story doesn't exist then add one
+        if (!storyId) {
+            const storyId = UUID.uuid4();
+            const title = 'New Story';
+            const storyType = 'guided';
+            const storySegments = [newStorySegmentId];
+            const storyMap = { title, storyType, storySegments };
+            this.sharedModel.addStoryMap(storyId, storyMap);
+            return { storySegmentId: newStorySegmentId, storyId };
+        }
+        else {
+            // else need to update story
+            const { story } = this.getSelectedStory();
+            if (!story) {
+                console.warn('No story found, something went wrong');
+                return null;
+            }
+            const newStory = Object.assign(Object.assign({}, story), { storySegments: [...((_a = story.storySegments) !== null && _a !== void 0 ? _a : []), newStorySegmentId] });
+            this.sharedModel.updateStoryMap(storyId, newStory);
+            return { storySegmentId: newStorySegmentId, storyId };
+        }
+    }
     /**
      * Add an item in the layer tree.
      *
@@ -612,7 +701,7 @@ export class JupyterGISModel {
     }
     /**
      * Toggle a map interaction mode on or off.
-     * Toggleing off sets the mode to 'panning'.
+     * Toggling off sets the mode to 'panning'.
      * @param mode The mode to be toggled
      */
     toggleMode(mode) {

package/lib/schema/project/jgis.json

@@ -20,6 +20,9 @@
         "options": {
             "$ref": "#/definitions/jGISOptions"
         },
+        "stories": {
+            "$ref": "#/definitions/jGISStoryMap"
+        },
         "metadata": {
             "type": "object",
             "patternProperties": {
@@ -41,7 +44,8 @@
                 "WebGlLayer",
                 "ImageLayer",
                 "HeatmapLayer",
-                "StacLayer"
+                "StacLayer",
+                "StorySegmentLayer"
             ]
         },
         "sourceType": {
@@ -136,6 +140,42 @@
                 }
             ]
         },
+        "jGISStoryMap": {
+            "title": "IJGISStoryMap",
+            "type": "object",
+            "additionalProperties": true,
+            "properties": {
+                "title": {
+                    "type": "string",
+                    "title": "Title",
+                    "description": "The title of the story map"
+                },
+                "storyType": {
+                    "type": "string",
+                    "title": "Story Type",
+                    "enum": ["guided", "unguided"],
+                    "description": "The type of story map"
+                },
+                "storySegments": {
+                    "type": "array",
+                    "default": [],
+                    "description": "Array of story segments for the story map",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "presentaionBgColor": {
+                    "type": "string",
+                    "title": "Presentation Background Color",
+                    "description": "The background color of the story map"
+                },
+                "presentaionTextColor": {
+                    "type": "string",
+                    "title": "Presentation Text Color",
+                    "description": "The text color of the story map"
+                }
+            }
+        },
         "jGISLayers": {
             "title": "IJGISLayers",
             "type": "object",
@@ -201,6 +241,11 @@
                 "useExtent": {
                     "type": "boolean",
                     "default": false
+                },
+                "storyMapPresentationMode": {
+                    "type": "boolean",
+                    "title": "Whether presentation mode is active",
+                    "default": false
                 }
             }
         },

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

@@ -0,0 +1,55 @@
+{
+    "type": "object",
+    "description": "StorySegmentLayer",
+    "title": "IStorySegmentLayer",
+    "additionalProperties": false,
+    "required": ["zoom", "extent", "transition"],
+    "properties": {
+        "zoom": {
+            "type": "number",
+            "default": 0
+        },
+        "extent": {
+            "type": "array",
+            "default": null,
+            "items": {
+                "type": "number"
+            }
+        },
+        "content": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "title": {
+                    "type": "string"
+                },
+                "image": {
+                    "type": "string",
+                    "description": "Link to image for the story"
+                },
+                "markdown": {
+                    "type": "string",
+                    "description": "Markdown string representing the content of the story stop"
+                }
+            }
+        },
+        "transition": {
+            "type": "object",
+            "description": "Transition configuration between to this story segment",
+            "properties": {
+                "type": {
+                    "type": "string",
+                    "enum": ["linear", "immediate", "smooth"],
+                    "description": "Transition animation style",
+                    "default": "linear"
+                },
+                "time": {
+                    "type": "number",
+                    "description": "The time in seconds for the transition",
+                    "default": 1
+                }
+            },
+            "required": ["type", "time"]
+        }
+    }
+}

package/lib/types.d.ts

@@ -11,6 +11,7 @@ export * from './_interface/project/sources/geoParquetSource';
 export * from './_interface/project/sources/markerSource';
 export * from './_interface/project/layers/heatmapLayer';
 export * from './_interface/project/layers/hillshadeLayer';
+export * from './_interface/project/layers/storySegmentLayer';
 export * from './_interface/project/layers/rasterLayer';
 export * from './_interface/project/layers/vectorLayer';
 export * from './_interface/project/layers/imageLayer';

package/lib/types.js

@@ -13,6 +13,7 @@ export * from './_interface/project/sources/markerSource';
 // 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';
 export * from './_interface/project/layers/vectorLayer';
 export * from './_interface/project/layers/imageLayer';

package/package.json

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