bruce-models 2.3.7 → 2.3.9

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

@@ -1,179 +1,180 @@
-import { Api } from "../api/api";
-import { BruceApi } from "../api/bruce-api";
-import { IDictionary } from "../bruce-models";
-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.
- *
- * A bookmark is a snapshot of what should be displayed and how in a particular project view.
- */
-export declare namespace ProjectViewBookmark {
-    function GetCacheKey(viewId: string, bookmarkId: string): string;
-    function GetListCacheKey(viewId: string): string;
-    const DEFAULT_DATA_VERSION = 1;
-    interface IBaseBookmark {
-        ID?: string;
-        Title?: string;
-        Note?: string;
-        "Screenshot.ClientFile.ID"?: string;
-        "UI.View.ID"?: string;
-        "Created.ByUser.ID"?: string;
-        "Created.Date"?: UTC.IUTC;
-        "UI.SlideGroup.ID"?: number;
-        DataVersion: number;
-        DisplayOrder?: number;
-        Settings?: IBaseSettings;
-    }
-    /**
-     * These are the base settings expected in any bookmark data-version.
-     * The only exception is data-version = 1 which is our deprecated legacy format.
-     */
-    interface IBaseSettings {
-        menuItemIds?: string[];
-    }
-    type Bookmark = LegacyNavigator.IBookmark | Navigator.IBookmark | IBaseBookmark;
-    namespace LegacyNavigator {
-        const DATA_VERSION = 1;
-        interface IBookmark extends IBaseBookmark {
-            Camera?: ICamera;
-            Settings?: ISettings;
-        }
-        interface IBookmarkImagery {
-            title: string;
-            contrast: number;
-            hue: number;
-            saturation: number;
-            gamma: number;
-            brightness: number;
-            alpha: number;
-        }
-        interface ISettings extends IBaseSettings {
-            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 Navigator {
-        const DATA_VERSION = 2;
-        interface IBookmark extends IBaseBookmark {
-            Camera?: ICamera;
-            Settings?: ISettings;
-        }
-        interface ISettings extends IBaseSettings {
-            groundOcclusion?: boolean;
-            imagery?: ProjectViewTile.IBookmarkImagery[];
-            terrain?: ProjectViewTile.IBookmarkTerrain;
-            globeColor?: string;
-            globeAlpha?: number;
-            globeHidden?: boolean;
-            markup?: Markup.IMarkup;
-            shadows?: IShadows;
-            ambientOcclusion?: IAmbientOcclusion;
-            lighting?: ILighting;
-            quality?: IQuality;
-            dateTime?: string;
-            entityOpacityMap?: IDictionary<number>;
-            selectedEntityIds?: string[];
-            hiddenEntityIds?: string[];
-            isolatedEntityIds?: string[];
-            hillShades?: boolean;
-            renderedEntityRelations?: string[];
-        }
-        interface IShadows {
-            enabled: boolean;
-            soften: boolean;
-            pixelSize: number;
-            darkness: number;
-        }
-        interface IAmbientOcclusion {
-            enabled: boolean;
-            intensity: number;
-            lengthCap: number;
-            bias: number;
-            blurStepSize: number;
-            stepSize: number;
-        }
-        interface ILighting {
-            color: string;
-            intensity: number;
-        }
-        interface IQuality {
-            fxaa: boolean;
-        }
-        interface ICamera {
-            altitude: number;
-            latitude: number;
-            longitude: number;
-            heading: number;
-            pitch: number;
-            roll: number;
-            transition?: number;
-            cameraFrustum?: Camera.EFrustum;
-        }
-    }
-    function Get(params: {
-        api: BruceApi.Api;
-        viewId: string;
-        bookmarkId: string;
-        req?: Api.IReqParams;
-    }): Promise<{
-        bookmark: Bookmark;
-    }>;
-    function Delete(params: {
-        api: BruceApi.Api;
-        viewId: string;
-        bookmarkId: string;
-        req?: Api.IReqParams;
-    }): Promise<void>;
-    function GetList(params: {
-        api: BruceApi.Api;
-        viewId: string;
-        req?: Api.IReqParams;
-    }): Promise<{
-        bookmarks: Bookmark[];
-    }>;
-    function Update(params: {
-        api: BruceApi.Api;
-        viewId: string;
-        bookmark: Bookmark;
-        req?: Api.IReqParams;
-    }): Promise<{
-        bookmark: Bookmark;
-    }>;
-    function SetOrder(params: {
-        api: BruceApi.Api;
-        viewId: string;
-        bookmarkIds: string[];
-        req?: Api.IReqParams;
-    }): Promise<void>;
-}
+import { Api } from "../api/api";
+import { BruceApi } from "../api/bruce-api";
+import { IDictionary } from "../bruce-models";
+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.
+ *
+ * A bookmark is a snapshot of what should be displayed and how in a particular project view.
+ */
+export declare namespace ProjectViewBookmark {
+    function GetCacheKey(viewId: string, bookmarkId: string): string;
+    function GetListCacheKey(viewId: string): string;
+    const DEFAULT_DATA_VERSION = 1;
+    interface IBaseBookmark {
+        ID?: string;
+        Title?: string;
+        Note?: string;
+        "Screenshot.ClientFile.ID"?: string;
+        "UI.View.ID"?: string;
+        "Created.ByUser.ID"?: string;
+        "Created.Date"?: UTC.IUTC;
+        "UI.SlideGroup.ID"?: number;
+        DataVersion: number;
+        DisplayOrder?: number;
+        Settings?: IBaseSettings;
+    }
+    /**
+     * These are the base settings expected in any bookmark data-version.
+     * The only exception is data-version = 1 which is our deprecated legacy format.
+     */
+    interface IBaseSettings {
+        menuItemIds?: string[];
+    }
+    type Bookmark = LegacyNavigator.IBookmark | Navigator.IBookmark | IBaseBookmark;
+    namespace LegacyNavigator {
+        const DATA_VERSION = 1;
+        interface IBookmark extends IBaseBookmark {
+            Camera?: ICamera;
+            Settings?: ISettings;
+        }
+        interface IBookmarkImagery {
+            title: string;
+            contrast: number;
+            hue: number;
+            saturation: number;
+            gamma: number;
+            brightness: number;
+            alpha: number;
+        }
+        interface ISettings extends IBaseSettings {
+            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 Navigator {
+        const DATA_VERSION = 2;
+        interface IBookmark extends IBaseBookmark {
+            Camera?: ICamera;
+            Settings?: ISettings;
+        }
+        interface ISettings extends IBaseSettings {
+            groundOcclusion?: boolean;
+            imagery?: ProjectViewTile.IBookmarkImagery[];
+            terrain?: ProjectViewTile.IBookmarkTerrain;
+            globeColor?: string;
+            globeAlpha?: number;
+            globeHidden?: boolean;
+            markup?: Markup.IMarkup;
+            shadows?: IShadows;
+            ambientOcclusion?: IAmbientOcclusion;
+            lighting?: ILighting;
+            quality?: IQuality;
+            dateTime?: string;
+            entityOpacityMap?: IDictionary<number>;
+            selectedEntityIds?: string[];
+            hiddenEntityIds?: string[];
+            isolatedEntityIds?: string[];
+            hillShades?: boolean;
+            renderedEntityRelations?: string[];
+            liveEntityIds?: string[];
+        }
+        interface IShadows {
+            enabled: boolean;
+            soften: boolean;
+            pixelSize: number;
+            darkness: number;
+        }
+        interface IAmbientOcclusion {
+            enabled: boolean;
+            intensity: number;
+            lengthCap: number;
+            bias: number;
+            blurStepSize: number;
+            stepSize: number;
+        }
+        interface ILighting {
+            color: string;
+            intensity: number;
+        }
+        interface IQuality {
+            fxaa: boolean;
+        }
+        interface ICamera {
+            altitude: number;
+            latitude: number;
+            longitude: number;
+            heading: number;
+            pitch: number;
+            roll: number;
+            transition?: number;
+            cameraFrustum?: Camera.EFrustum;
+        }
+    }
+    function Get(params: {
+        api: BruceApi.Api;
+        viewId: string;
+        bookmarkId: string;
+        req?: Api.IReqParams;
+    }): Promise<{
+        bookmark: Bookmark;
+    }>;
+    function Delete(params: {
+        api: BruceApi.Api;
+        viewId: string;
+        bookmarkId: string;
+        req?: Api.IReqParams;
+    }): Promise<void>;
+    function GetList(params: {
+        api: BruceApi.Api;
+        viewId: string;
+        req?: Api.IReqParams;
+    }): Promise<{
+        bookmarks: Bookmark[];
+    }>;
+    function Update(params: {
+        api: BruceApi.Api;
+        viewId: string;
+        bookmark: Bookmark;
+        req?: Api.IReqParams;
+    }): Promise<{
+        bookmark: Bookmark;
+    }>;
+    function SetOrder(params: {
+        api: BruceApi.Api;
+        viewId: string;
+        bookmarkIds: string[];
+        req?: Api.IReqParams;
+    }): Promise<void>;
+}

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

@@ -1,48 +1,48 @@
-import { BruceApi } from "../api/bruce-api";
-import { Api } from "../api/api";
-/**
- * Describes a terrain or map source that are found in project view records.
- * 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 ProjectViewLegacyTile {
-    interface ISource {
-        SourceUrl?: string;
-        IsEnabled?: boolean;
-        IsDefault?: boolean;
-        Name: string;
-        Tooltip?: string;
-        IconUrl?: string;
-    }
-    interface IMapSource extends ISource {
-        SourceUrl?: string;
-        IonAssetID?: number;
-        MapBoxID?: string;
-        MapBoxUsername?: string;
-        ProgramKey?: string;
-        FileExtension?: string;
-        Minimum?: number;
-        Maximum?: number;
-        Type?: string;
-    }
-    interface ITerrainSource extends ISource {
-        RequestWaterMask?: boolean;
-        RequestVertexNormals?: boolean;
-    }
-    function MergeMapTemplateData(params: {
-        getter: BruceApi.IGetter;
-        sources: IMapSource[];
-        addIfMissing: boolean;
-        req?: Api.IReqParams;
-    }): Promise<{
-        sources: IMapSource[];
-    }>;
-    function MergeTerrainTemplateData(params: {
-        getter: BruceApi.IGetter;
-        sources: ITerrainSource[];
-        addIfMissing: boolean;
-        req?: Api.IReqParams;
-    }): Promise<{
-        sources: ITerrainSource[];
-    }>;
-}
+import { BruceApi } from "../api/bruce-api";
+import { Api } from "../api/api";
+/**
+ * Describes a terrain or map source that are found in project view records.
+ * 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 ProjectViewLegacyTile {
+    interface ISource {
+        SourceUrl?: string;
+        IsEnabled?: boolean;
+        IsDefault?: boolean;
+        Name: string;
+        Tooltip?: string;
+        IconUrl?: string;
+    }
+    interface IMapSource extends ISource {
+        SourceUrl?: string;
+        IonAssetID?: number;
+        MapBoxID?: string;
+        MapBoxUsername?: string;
+        ProgramKey?: string;
+        FileExtension?: string;
+        Minimum?: number;
+        Maximum?: number;
+        Type?: string;
+    }
+    interface ITerrainSource extends ISource {
+        RequestWaterMask?: boolean;
+        RequestVertexNormals?: boolean;
+    }
+    function MergeMapTemplateData(params: {
+        getter: BruceApi.IGetter;
+        sources: IMapSource[];
+        addIfMissing: boolean;
+        req?: Api.IReqParams;
+    }): Promise<{
+        sources: IMapSource[];
+    }>;
+    function MergeTerrainTemplateData(params: {
+        getter: BruceApi.IGetter;
+        sources: ITerrainSource[];
+        addIfMissing: boolean;
+        req?: Api.IReqParams;
+    }): Promise<{
+        sources: ITerrainSource[];
+    }>;
+}

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

@@ -1,65 +1,65 @@
-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 extends IViewImagery {
-        alpha?: number;
-        brightness?: number;
-        saturation?: number;
-        contrast?: number;
-        gamma?: number;
-        hue?: number;
-    }
-    interface IBookmarkTerrain extends IViewTerrain {
-    }
-    enum EDefaultImagery {
-        BingMapsAerial = "bingmapsaerial",
-        BingMapsAerialWithLabels = "bingmapsaerialwithlabels",
-        BingMapsRoads = "bingmapsroads",
-        MapboxSatellite = "mapboxsatellite",
-        MapBoxStreets = "mapboxstreets",
-        MapBoxStreetsClassic = "mapboxstreetsclassic",
-        EsriWorldImagery = "esriworldimagery",
-        EsriWorldStreetMap = "esriworldstreetmap",
-        EsriNationalGeographic = "esrinationalgeographic",
-        OpenStreetMap = "openstreetmap",
-        LINZ = "linz",
-        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[];
-}
+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 extends IViewImagery {
+        alpha?: number;
+        brightness?: number;
+        saturation?: number;
+        contrast?: number;
+        gamma?: number;
+        hue?: number;
+    }
+    interface IBookmarkTerrain extends IViewTerrain {
+    }
+    enum EDefaultImagery {
+        BingMapsAerial = "bingmapsaerial",
+        BingMapsAerialWithLabels = "bingmapsaerialwithlabels",
+        BingMapsRoads = "bingmapsroads",
+        MapboxSatellite = "mapboxsatellite",
+        MapBoxStreets = "mapboxstreets",
+        MapBoxStreetsClassic = "mapboxstreetsclassic",
+        EsriWorldImagery = "esriworldimagery",
+        EsriWorldStreetMap = "esriworldstreetmap",
+        EsriNationalGeographic = "esrinationalgeographic",
+        OpenStreetMap = "openstreetmap",
+        LINZ = "linz",
+        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[];
+}