@jupytergis/schema 0.11.1 → 0.12.0

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

@@ -45,6 +45,22 @@ export type IJGISLayerItem = string | IJGISLayerGroup;
  */
 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;
@@ -52,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
@@ -149,16 +166,13 @@ export interface IJGISOptions {
  * via the `definition` "jGISStoryMap".
  */
 export interface IJGISStoryMap {
-  /**
-   * The title of the story map
-   */
-  title?: string;
-  /**
-   * The type of story map
-   */
-  storyType?: "guided" | "unguided";
+  title?: Title;
+  storyType?: StoryType;
   /**
    * Array of story segments for the story map
    */
   storySegments?: string[];
+  presentaionBgColor?: PresentationBackgroundColor;
+  presentaionTextColor?: PresentationTextColor;
+  [k: string]: any;
 }

package/lib/interfaces.d.ts

@@ -229,13 +229,14 @@ export interface IJupyterGISModel extends DocumentRegistry.IModel {
     triggerLayerUpdate(layerId: string, layer: IJGISLayer): void;
     disposed: ISignal<any, void>;
     getSelectedStory(): {
-        storySegmentId: string;
+        storyId: string;
         story: IJGISStoryMap | undefined;
     };
     addStorySegment(): {
         storySegmentId: string;
-        storyMapId: string;
+        storyId: string;
     } | null;
+    isSpectaMode(): boolean;
 }
 export interface IUserData {
     userId: number;
@@ -341,4 +342,5 @@ export interface IJupyterGISSettings {
     annotationsDisabled?: boolean;
     identifyDisabled?: boolean;
     storyMapsDisabled: boolean;
+    zoomButtonsEnabled?: boolean;
 }

package/lib/model.d.ts

@@ -157,12 +157,19 @@ 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(): {
-        storySegmentId: string;
+        storyId: string;
         story: IJGISStoryMap | undefined;
     };
     /**
@@ -171,7 +178,7 @@ export declare class JupyterGISModel implements IJupyterGISModel {
      */
     addStorySegment(): {
         storySegmentId: string;
-        storyMapId: string;
+        storyId: string;
     } | null;
     /**
      * Add an item in the layer tree.

package/lib/model.js

@@ -15,6 +15,7 @@ const DEFAULT_SETTINGS = {
     annotationsDisabled: false,
     identifyDisabled: false,
     storyMapsDisabled: false,
+    zoomButtonsEnabled: false,
 };
 export class JupyterGISModel {
     constructor(options) {
@@ -261,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,
@@ -273,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;
     }
@@ -485,6 +487,19 @@ 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
@@ -493,7 +508,7 @@ export class JupyterGISModel {
         const stories = this.sharedModel.stories;
         const storyId = Object.keys(stories)[0];
         return {
-            storySegmentId: storyId,
+            storyId: storyId,
             story: this.sharedModel.getStoryMap(storyId),
         };
     }
@@ -504,11 +519,11 @@ export class JupyterGISModel {
     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 storyMapId = UUID.uuid4();
         const newStorySegmentId = UUID.uuid4();
         const layerParams = {
             extent,
@@ -522,27 +537,27 @@ export class JupyterGISModel {
             parameters: layerParams,
         };
         this.addLayer(newStorySegmentId, layerModel);
-        // check for stories
-        const isStoriesExist = Object.keys(this.sharedModel.stories).length !== 0;
-        // if not stories, then just add simple
-        if (!isStoriesExist) {
+        // 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(storyMapId, storyMap);
+            this.sharedModel.addStoryMap(storyId, storyMap);
+            return { storySegmentId: newStorySegmentId, storyId };
         }
         else {
-            // else need to update stories
+            // 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(storyMapId, newStory);
+            this.sharedModel.updateStoryMap(storyId, newStory);
+            return { storySegmentId: newStorySegmentId, storyId };
         }
-        return { storySegmentId: newStorySegmentId, storyMapId };
     }
     /**
      * Add an item in the layer tree.

package/lib/schema/project/jgis.json

@@ -20,6 +20,9 @@
         "options": {
             "$ref": "#/definitions/jGISOptions"
         },
+        "stories": {
+            "$ref": "#/definitions/jGISStoryMap"
+        },
         "metadata": {
             "type": "object",
             "patternProperties": {
@@ -140,14 +143,16 @@
         "jGISStoryMap": {
             "title": "IJGISStoryMap",
             "type": "object",
-            "additionalProperties": false,
+            "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"
                 },
@@ -158,6 +163,16 @@
                     "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"
                 }
             }
         },

package/package.json

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