bruce-models 0.7.5 → 0.7.7

package/dist/types/project/project-view-bookmark.d.ts

@@ -2,6 +2,7 @@ import { BruceApi } from "../api/bruce-api";
 import { Camera } from "../common/camera";
 import { UTC } from "../common/utc";
 import { Markup } from "../markup/markup";
+import { ProjectViewTile } from "./project-view-tile";
 /**
  * Describe the "Project View Bookmark" concept within Bruce.
  * This is referred to as "slides" in older code.
@@ -11,47 +12,95 @@ import { Markup } from "../markup/markup";
 export declare namespace ProjectViewBookmark {
     function GetCacheKey(viewId: string, bookmarkId: string): string;
     function GetListCacheKey(viewId: string): string;
-    interface IBookmarkImagery {
-        title: string;
-        contrast: number;
-        hue: number;
-        saturation: number;
-        gamma: number;
-        brightness: number;
-        alpha: number;
-    }
-    interface IBookmarkSettings {
-        selectedItemIds?: string[];
-        order?: number;
-        hiddenEntityIds?: string[];
-        drawnRelationEntityIDs?: string[];
-        imagery?: IBookmarkImagery[];
-        terrain?: string;
-        globeColor?: string;
-        shadows?: boolean;
-        groundOcclusion?: boolean;
-        ambientOcclusion?: boolean;
-        markup?: Markup.IMarkup;
-        cameraFrustum?: Camera.EFrustum;
-        displayTimeline?: boolean;
-        timelineSettings?: any;
-    }
-    interface IBookmark {
+    const DEFAULT_DATA_VERSION = 1;
+    interface IBookmarkMeta {
         ID?: string;
-        Camera?: any;
-        "Created.ByUser.ID"?: string;
-        "Created.Date"?: UTC.IUTC;
-        Note?: string;
-        Settings?: IBookmarkSettings;
         Title?: string;
-        "UI.View.ID"?: string;
-        DisplayOrder?: number;
+        Note?: string;
         "Screenshot.ClientFile.ID"?: string;
+        "UI.View.ID"?: string;
+        "Created.ByUser.ID"?: string;
+        "Created.Date"?: UTC.IUTC;
         "UI.SlideGroup.ID"?: number;
+        DataVersion: number;
+    }
+    type Bookmark = V1.IBookmark | V2.IBookmark;
+    namespace V1 {
+        const DATA_VERSION = 1;
+        interface IBookmark extends IBookmarkMeta {
+            Camera?: ICamera;
+            DisplayOrder?: number;
+            Settings?: ISettings;
+        }
+        interface IBookmarkImagery {
+            title: string;
+            contrast: number;
+            hue: number;
+            saturation: number;
+            gamma: number;
+            brightness: number;
+            alpha: number;
+        }
+        interface ISettings {
+            selectedItemIds?: string[];
+            order?: number;
+            hiddenEntityIds?: string[];
+            drawnRelationEntityIDs?: string[];
+            imagery?: IBookmarkImagery[];
+            terrain?: string;
+            globeColor?: string;
+            shadows?: boolean;
+            groundOcclusion?: boolean;
+            ambientOcclusion?: boolean;
+            markup?: Markup.IMarkup;
+            cameraFrustum?: Camera.EFrustum;
+            displayTimeline?: boolean;
+            timelineSettings?: any;
+        }
+        /**
+         * Lat,lon is in degrees.
+         * Altitude is meters relative to ground.
+         * Heading, pitch, roll are in radians.
+         */
+        interface ICamera {
+            position: {
+                latitude: number;
+                longitude: number;
+                height: number;
+            };
+            heading: number;
+            pitch: number;
+            roll: number;
+        }
+    }
+    namespace V2 {
+        const DATA_VERSION = 2;
+        interface IBookmark extends IBookmarkMeta {
+            Camera?: ICamera;
+            DisplayOrder?: number;
+            Settings?: ISettings;
+        }
+        interface ISettings {
+            menuItemIds?: string[];
+            groundOcclusion?: boolean;
+            imagery?: ProjectViewTile.IBookmarkImagery[];
+            terrain?: ProjectViewTile.IBookmarkTerrain;
+            globeColor?: string;
+        }
+        interface ICamera {
+            altitude: number;
+            latitude: number;
+            longitude: number;
+            heading: number;
+            pitch: number;
+            roll: number;
+            transition?: number;
+            cameraFrustum?: Camera.EFrustum;
+        }
     }
-    function Get(api: BruceApi.Api, viewId: string, bookmarkId: string): Promise<IBookmark>;
+    function Get(api: BruceApi.Api, viewId: string, bookmarkId: string): Promise<Bookmark>;
     function Delete(api: BruceApi.Api, viewId: string, bookmarkId: string): Promise<void>;
-    function GetList(api: BruceApi.Api, viewId: string): Promise<IBookmark[]>;
-    function Update(api: BruceApi.Api, viewId: string, data: IBookmark): Promise<IBookmark>;
+    function GetList(api: BruceApi.Api, viewId: string): Promise<Bookmark[]>;
+    function Update(api: BruceApi.Api, viewId: string, data: Bookmark): Promise<Bookmark>;
     function SetOrder(api: BruceApi.Api, viewId: string, bookmarkIds: string[]): Promise<void>;
 }

package/dist/types/project/{project-view-tile-source.d.ts → project-view-legacy-tile.d.ts}

@@ -4,7 +4,7 @@ import { BruceApi } from "../api/bruce-api";
  * This is a concept we want to trash as we're moving towards storing tileset ids instead.
  * This will help at least understand and manage this dying concept.
  */
-export declare namespace ProjectViewTileSource {
+export declare namespace ProjectViewLegacyTile {
     interface ISource {
         SourceUrl?: string;
         IsEnabled?: boolean;

package/dist/types/project/project-view-tile.d.ts

@@ -0,0 +1,68 @@
+export declare namespace ProjectViewTile {
+    type MapTileId = string | EDefaultImagery;
+    type TerrainTileId = string | EDefaultTerrain;
+    interface ITileMeta {
+        accountId?: string;
+        tilesetId: string;
+    }
+    interface IViewTerrain extends ITileMeta {
+        tilesetId: TerrainTileId;
+    }
+    interface IViewImagery extends ITileMeta {
+        tilesetId: MapTileId;
+    }
+    interface IBookmarkImagery {
+        tilesetId: MapTileId;
+        accountId: string;
+        alpha: number;
+        brightness: number;
+        saturation: number;
+        contrast: number;
+        gamma: number;
+        hue: number;
+    }
+    interface IBookmarkTerrain {
+        tilesetId: TerrainTileId;
+        accountId: string;
+    }
+    enum EDefaultImagery {
+        BingMapsAerial = "bingmapsaerial",
+        BingMapsAerialWithLabels = "bingmapsaerialwithlabels",
+        BingMapsRoads = "bingmapsroads",
+        MapboxSatellite = "mapboxsatellite",
+        MapBoxStreets = "mapboxstreets",
+        MapBoxStreetsClassic = "mapboxstreetsclassic",
+        EsriWorldImagery = "esriworldimagery",
+        EsriWorldStreetMap = "esriworldstreetmap",
+        EsriNationalGeographic = "esrinationalgeographic",
+        OpenStreetMap = "openstreetmap",
+        StamenWaterColor = "stamenwatercolor",
+        StamenToner = "stamentoner",
+        Grid = "grid"
+    }
+    interface IDefaultImagery {
+        id: EDefaultImagery;
+        name: string;
+        iconUrl?: string;
+    }
+    /**
+     * Prepared array for UI.
+     * TODO: Im not happy with icon urls sitting in the code. I'd prefer we ship these icons in the library as files.
+     */
+    const DefaultImagery: IDefaultImagery[];
+    enum EDefaultTerrain {
+        CesiumWorldTerrain = "cesiumworldterrain",
+        FlatTerrain = "flatterrain",
+        LINZ = "linz"
+    }
+    interface IDefaultTerrain {
+        id: EDefaultTerrain;
+        name: string;
+        iconUrl?: string;
+    }
+    /**
+     * Prepared array for UI.
+     * TODO: Im not happy with icon urls sitting in the code. I'd prefer we ship these icons in the library as files.
+     */
+    const DefaultTerrains: IDefaultTerrain[];
+}

package/dist/types/project/project-view.d.ts

@@ -1,7 +1,9 @@
 import { BruceApi } from "../api/bruce-api";
 import { UTC } from "../common/utc";
 import { MenuItem } from "./menu-item";
-import { ProjectViewTileSource } from "./project-view-tile-source";
+import { ProjectViewLegacyTile } from "./project-view-legacy-tile";
+import { ProjectViewTile } from "./project-view-tile";
+import { ProjectViewBookmark } from "./project-view-bookmark";
 /**
  * Describes the "Project View" concept within Bruce.
  * A project view is a collection of settings for a visualization application we support.
@@ -10,54 +12,77 @@ import { ProjectViewTileSource } from "./project-view-tile-source";
 export declare namespace ProjectView {
     function GetCacheKey(viewId: string): string;
     function GetListCacheKey(): string;
-    interface IView {
+    const DEFAULT_DATA_VERSION = 1;
+    interface IViewMeta {
         ID?: string;
         Name: string;
         Description?: string;
         Feature?: string[];
         "CreatedByUser.ID"?: string;
         CreatedTime?: UTC.IUTC;
-        Settings?: IViewSettings;
         DefaultUISlideID?: string;
         CreatedByUIVersion?: string;
+        DataVersion: number;
     }
-    interface IShadowSettings {
-        IsShadowEnabled: boolean;
-        IsShadowSoft: boolean;
-        ShadowSampleSize: number;
+    type View = V1.IView | V2.IView;
+    namespace V1 {
+        const DATA_VERSION = 1;
+        interface IShadowSettings {
+            IsShadowEnabled: boolean;
+            IsShadowSoft: boolean;
+            ShadowSampleSize: number;
+        }
+        interface ISettings {
+            BookmarkTransitionSpeed: number;
+            Camera: any;
+            CameraFrustum: number;
+            CesiumMapSources: ProjectViewLegacyTile.IMapSource[];
+            CesiumTerrainSources: ProjectViewLegacyTile.ITerrainSource[];
+            ControlsSettings: any;
+            DefaultMapTiles: string;
+            DefaultTerrain: string;
+            DisplayTimeline: boolean;
+            GroundOcclusion: boolean;
+            Extensions: any;
+            GlobeColor: string;
+            SelectionHighlightColor?: string;
+            LayersMenu?: MenuItem.IItem[];
+            OASettings?: any;
+            LogoImage: any;
+            LegendImage: any;
+            IsRestricted: boolean;
+            IsLoginRequired: boolean;
+            TilesetBackfaceCulling: boolean;
+            TopPanelComponents?: string[];
+            LeftPanelComponents?: string[];
+            PostProcessFXAA?: boolean;
+            Shadows: boolean;
+            Shadow: {
+                StaticCamera: IShadowSettings;
+                MovingCamera: IShadowSettings;
+            };
+        }
+        interface IView extends IViewMeta {
+            Settings: ISettings;
+        }
     }
-    interface IViewSettings {
-        BookmarkTransitionSpeed: number;
-        Camera: any;
-        CameraFrustum: number;
-        CesiumMapSources: ProjectViewTileSource.IMapSource[];
-        CesiumTerrainSources: ProjectViewTileSource.ITerrainSource[];
-        ControlsSettings: any;
-        DefaultMapTiles: string;
-        DefaultTerrain: string;
-        DisplayTimeline: boolean;
-        GroundOcclusion: boolean;
-        Extensions: any;
-        GlobeColor: string;
-        SelectionHighlightColor?: string;
-        LayersMenu?: MenuItem.IItem[];
-        OASettings?: any;
-        LogoImage: any;
-        LegendImage: any;
-        IsRestricted: boolean;
-        IsLoginRequired: boolean;
-        TilesetBackfaceCulling: boolean;
-        TopPanelComponents?: string[];
-        LeftPanelComponents?: string[];
-        PostProcessFXAA?: boolean;
-        Shadows: boolean;
-        Shadow: {
-            StaticCamera: IShadowSettings;
-            MovingCamera: IShadowSettings;
-        };
+    namespace V2 {
+        const DATA_VERSION = 2;
+        interface ISettings {
+            menuItems?: MenuItem.IItem[];
+            imageries?: ProjectViewTile.IViewImagery[];
+            terrains?: ProjectViewTile.IViewTerrain[];
+            defaults?: {
+                camera?: ProjectViewBookmark.V2.ICamera;
+                settings?: ProjectViewBookmark.V2.ISettings;
+            };
+        }
+        interface IView extends IViewMeta {
+            Settings: ISettings;
+        }
     }
-    function Get(api: BruceApi.Api, viewId: string): Promise<IView>;
-    function GetList(api: BruceApi.Api): Promise<IView[]>;
+    function Get(api: BruceApi.Api, viewId: string): Promise<View>;
+    function GetList(api: BruceApi.Api): Promise<View[]>;
     function Delete(api: BruceApi.Api, viewId: string): Promise<void>;
-    function Update(api: BruceApi.Api, data: IView): Promise<IView>;
+    function Update(api: BruceApi.Api, data: View): Promise<View>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bruce-models",
-  "version": "0.7.5",
+  "version": "0.7.7",
   "description": "",
   "keywords": [],
   "main": "dist/bruce-models.umd.js",

package/dist/lib/project/project-view-tile-source.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"project-view-tile-source.js","sourceRoot":"","sources":["../../../src/project/project-view-tile-source.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kCAAiC;AAEjC,+CAA6C;AAE7C,SAAe,mBAAmB,CAAC,SAA2B;;;;;;wBAC7C,qBAAM,0BAAW,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,SAAG,CAAC,mBAAmB,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,EAAA;;oBAAjG,IAAI,GAAG,SAA0F;oBACvG,4BAAO,IAAI,CAAC,QAAQ,mCAA+B,EAAE,EAAC;;;;CACzD;AAED,SAAS,qBAAqB,CAAC,KAAsC,EAAE,YAA2C,EAAE,YAAqB;IACrI,IAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,UAAA,CAAC,IAAI,OAAA,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI,EAA5B,CAA4B,CAAC,CAAC;IACjE,IAAI,KAAK,GAAG,CAAC,CAAC,EAAE;QACZ,YAAY,CAAC,SAAS,GAAG,IAAI,CAAC;QAC9B,YAAY,CAAC,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC;QAChD,KAAK,CAAC,KAAK,CAAC,GAAG,YAAY,CAAC;KAC/B;SACI,IAAI,YAAY,EAAE;QACnB,YAAY,CAAC,SAAS,GAAG,IAAI,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;KAC5B;AACL,CAAC;AAED;;;;GAIG;AACH,IAAiB,qBAAqB,CA8CrC;AA9CD,WAAiB,qBAAqB;IA2BlC,SAAsB,oBAAoB,CAAC,MAAwB,EAAE,KAAmB,EAAE,YAAqB;;;;;;4BAC1F,qBAAM,mBAAmB,CAAC,MAAM,CAAC,EAAA;;wBAA5C,QAAQ,GAAG,SAAiC;wBAC5C,IAAI,SAAG,QAAQ,CAAC,gBAAgB,mCAAI,EAAE,CAAC;wBAC7C,KAAS,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;4BAC5B,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;4BAC1B,qBAAqB,CAAC,KAAK,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;yBACzD;wBACD,sBAAO,EAAE,EAAC;;;;KACb;IARqB,0CAAoB,uBAQzC,CAAA;IAED,SAAsB,wBAAwB,CAAC,MAAwB,EAAE,KAAuB,EAAE,YAAqB;;;;;;4BAClG,qBAAM,mBAAmB,CAAC,MAAM,CAAC,EAAA;;wBAA5C,QAAQ,GAAG,SAAiC;wBAC5C,QAAQ,SAAG,QAAQ,CAAC,oBAAoB,mCAAI,EAAE,CAAC;wBACrD,KAAS,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;4BAChC,aAAa,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;4BAClC,qBAAqB,CAAC,KAAK,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC;yBAC7D;wBACD,sBAAO,EAAE,EAAC;;;;KACb;IARqB,8CAAwB,2BAQ7C,CAAA;AACL,CAAC,EA9CgB,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QA8CrC"}