bruce-models 3.2.0 → 3.2.1

package/dist/types/program-key/program-key.d.ts

@@ -2,23 +2,53 @@ import { Api } from "../api/api";
 import { BruceApi } from "../api/bruce-api";
 type Id = ProgramKey.EProgramId | string;
 /**
- * Describes the "Program Key" concept within Bruce.
+ * Describes the "Program Key" concept within Nextspace.
  * A program key is an access token for an arbitrary software.
  */
 export declare namespace ProgramKey {
+    /**
+     * Returns cache identifier for a program key.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param programId
+     * @returns
+     */
     function GetCacheKey(programId: string): string;
+    /**
+     * Returns cache identifier for a list of program keys.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey();
+     *     api.Cache.Remove(key);
+     * }
+     * @returns
+     */
     function GetListCacheKey(): string;
+    /**
+     * Known program IDs that Nextspace applications will reference.
+     */
     enum EProgramId {
         CesiumIon = "CesiumIon",
         BingMaps = "BingMaps",
         Mapbox = "Mapbox",
         Google = "Google"
     }
+    /**
+     * Describes a program key record.
+     */
     interface IKey {
         ProgramId: Id;
         Key: string;
         IsAccessRestricted?: boolean;
     }
+    /**
+     * Returns a program key record.
+     * @param params
+     * @returns
+     */
     function Get(params: {
         api?: BruceApi.Api;
         programId: Id;
@@ -26,17 +56,31 @@ export declare namespace ProgramKey {
     }): Promise<{
         programKey: IKey;
     }>;
+    /**
+     * Returns a list of program key records.
+     * @param params
+     * @returns
+     */
     function GetList(params: {
         api?: BruceApi.Api;
         req?: Api.IReqParams;
     }): Promise<{
         programKeys: IKey[];
     }>;
+    /**
+     * Deletes a program key record.
+     * @param params
+     */
     function Delete(params: {
         api?: BruceApi.Api;
         programId: Id;
         req?: Api.IReqParams;
     }): Promise<void>;
+    /**
+     * Creates or updates a program key record.
+     * @param params
+     * @returns
+     */
     function Update(params: {
         api?: BruceApi.Api;
         programKey: IKey;

package/dist/types/project/menu-item.d.ts

@@ -8,6 +8,9 @@ import { ZoomControl } from "./zoom-control";
  * A menu item may be a container for other items.
  */
 export declare namespace MenuItem {
+    /**
+     * Possible types of menu items.
+     */
     enum EType {
         None = "NONE",
         Entities = "BruceEntity",
@@ -26,6 +29,9 @@ export declare namespace MenuItem {
         Relationships = "Relationships",
         GooglePhotoTileset = "GooglePhotoTileset"
     }
+    /**
+     * @derepcated.
+     */
     interface ILegend {
         model3d: boolean;
         point: boolean;
@@ -33,6 +39,9 @@ export declare namespace MenuItem {
         polylines: boolean;
         tileset3d: boolean;
     }
+    /**
+     * Settings related to how authoring for a menu item should behave.
+     */
     interface IAuthorSettings {
         readClickedEntity?: boolean;
         clickedRelationTypeId?: string;
@@ -41,6 +50,9 @@ export declare namespace MenuItem {
             toPathStr: string;
         }[];
     }
+    /**
+     * Describes a menu item found in project views.
+     */
     interface IItem {
         id: string;
         Caption: string;
@@ -55,10 +67,32 @@ export declare namespace MenuItem {
         cdnEnabled?: boolean;
         cdnCounter?: number;
     }
+    /**
+     * Creates a menu item for a single entity.
+     * @param entityId
+     * @param typeId
+     * @param styleId
+     * @returns
+     */
     function CreateFromEntityId(entityId: string, typeId: string, styleId?: number): IItem;
+    /**
+     * Creates a menu item for an entity type.
+     * @param typeId
+     * @param styleId
+     * @returns
+     */
     function CreateFromTypeId(typeId: string, styleId?: number): IItem;
+    /**
+     * Creates a menu item for a tileset.
+     * @param tilesetId
+     * @param type
+     * @returns
+     */
     function CreateFromTilesetId(tilesetId: string, type: Tileset.EType): IItem;
     namespace Item {
+        /**
+         * Tileset load information.
+         */
         interface ITileset {
             TilesetURL?: string;
             ClientAccountID?: string;
@@ -71,6 +105,9 @@ export declare namespace MenuItem {
             minDistance?: number;
             minTotalCount?: number;
         }
+        /**
+         * Menu item for loading Nextspace vector or 3D model entities.
+         */
         interface IEntities extends IItem {
             Type: EType.Entities;
             BruceEntity: {
@@ -90,6 +127,9 @@ export declare namespace MenuItem {
                 checked: boolean;
             }[];
         }
+        /**
+         * Menu item for loading a single Nextspace vector or 3D model entity.
+         */
         interface IEntity extends IItem {
             Type: EType.Entity;
             BruceEntity: {
@@ -100,6 +140,9 @@ export declare namespace MenuItem {
             showAllLayers?: boolean;
             showAllLayersExcludeBelow?: boolean;
         }
+        /**
+         * Menu item for loading a legacy tileset.
+         */
         interface IArbTileset extends IItem {
             Type: EType.ArbTileset | EType.IonTileset;
             FlyTo?: boolean;
@@ -117,6 +160,9 @@ export declare namespace MenuItem {
         }
         interface IIonTileset extends IArbTileset {
         }
+        /**
+         * Menu item for loading a CAD tileset.
+         */
         interface ICadTileset extends IItem {
             Type: EType.CadTileset;
             tileset: ITileset;
@@ -132,15 +178,26 @@ export declare namespace MenuItem {
                 Ghosts?: boolean;
             };
         }
+        /**
+         * Menu item for loading a point cloud tileset.
+         */
         interface IPointcloud extends IItem {
             Type: EType.PointCloud;
             FlyTo?: boolean;
             tileset: ITileset;
         }
+        /**
+         * Menu item for loading a raster tileset.
+         * This is deprecated and unsupported in the latest web-Navigator.
+         * If needed, load through the imagery panel.
+         */
         interface IEntitiesRaster extends IItem {
             Type: EType.EntityRaster;
             tileset: ITileset;
         }
+        /**
+         * Menu item for loading a Cesium OSM tileset.
+         */
         interface IOsm extends IItem {
             Type: EType.Osm;
             BruceEntity?: {
@@ -149,6 +206,9 @@ export declare namespace MenuItem {
             };
             ghostLoading?: boolean;
         }
+        /**
+         * Menu item for loading a static KML file.
+         */
         interface IKml extends IItem {
             Type: EType.Kml;
             KML?: {
@@ -158,6 +218,9 @@ export declare namespace MenuItem {
                 fileUrl?: string;
             }[];
         }
+        /**
+         * Menu item for loading a tileset made from entities.
+         */
         interface IEntitiesTileset extends IItem {
             Type: EType.EntityTileset;
             FlyTo: boolean;
@@ -165,6 +228,9 @@ export declare namespace MenuItem {
             attenuation?: boolean;
             attenuationMax?: number;
         }
+        /**
+         * Menu item that loads preloaded entity records.
+         */
         interface IEntitiesLoaded extends MenuItem.IItem {
             Type: EType.EntitiesLoaded;
             BruceEntity: {
@@ -173,6 +239,9 @@ export declare namespace MenuItem {
             };
             CameraZoomSettings?: ZoomControl.IItem[];
         }
+        /**
+         * Menu item that loads specific entity ids.
+         */
         interface IEntityIds extends MenuItem.IItem {
             Type: EType.EntitiesIds;
             BruceEntity: {
@@ -186,12 +255,15 @@ export declare namespace MenuItem {
          * Auto-generated menu item when entity-relationships are marked to be rendered.
          * @deprecated, use IRelationships instead.
          */
-        interface IEntityRelations extends MenuItem.IItem {
+        interface ILegacyRelationships extends MenuItem.IItem {
             Type: EType.Relations;
             BruceEntity?: {
                 EntityIds?: string[];
             };
         }
+        /**
+         * Describes a relationship group to render.
+         */
         interface IRenderedRelations {
             entityIds: string[];
             relationTypeId: string;

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

@@ -8,15 +8,39 @@ import { Section } from "../common/section";
 import { MenuItem } from "./menu-item";
 import { ProjectViewTile } from "./project-view-tile";
 /**
- * Describe the "Project View Bookmark" concept within Bruce.
+ * Describe the "Project View Bookmark" concept within Nextspace.
  * 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 {
+    /**
+     * Returns cache identifier for a bookmark.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("abc", "def");
+     *     api.Cache.Remove(key);
+     * }
+     * @param viewId
+     * @param bookmarkId
+     * @returns
+     */
     function GetCacheKey(viewId: string, bookmarkId: string): string;
+    /**
+     * Returns cache identifier for a list of bookmarks.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param viewId
+     * @returns
+     */
     function GetListCacheKey(viewId: string): string;
-    const DEFAULT_DATA_VERSION = 1;
+    const DEFAULT_DATA_VERSION = 2;
+    /**
+     * Describes a bookmark record.
+     */
     interface IBookmark {
         ID?: string;
         Title?: string;
@@ -62,12 +86,18 @@ export declare namespace ProjectViewBookmark {
         terrainWireframe?: boolean;
         renderedEntityRelations?: string[];
     }
+    /**
+     * Describes the shadows settings for a bookmark.
+     */
     interface IShadows {
         enabled: boolean;
         soften: boolean;
         pixelSize: number;
         darkness: number;
     }
+    /**
+     * Describes the ambient occlusion settings for a bookmark.
+     */
     interface IAmbientOcclusion {
         enabled: boolean;
         intensity: number;
@@ -76,13 +106,22 @@ export declare namespace ProjectViewBookmark {
         blurStepSize: number;
         stepSize: number;
     }
+    /**
+     * Describes the lighting settings for a bookmark.
+     */
     interface ILighting {
         color: string;
         intensity: number;
     }
+    /**
+     * Describes the quality settings for a bookmark.
+     */
     interface IQuality {
         fxaa: boolean;
     }
+    /**
+     * Describes the camera settings for a bookmark.
+     */
     interface ICamera {
         altitude: number;
         latitude: number;
@@ -93,6 +132,11 @@ export declare namespace ProjectViewBookmark {
         transition?: number;
         cameraFrustum?: Camera.EFrustum;
     }
+    /**
+     * Gets a bookmark record.
+     * @param params
+     * @returns
+     */
     function Get(params: {
         api?: BruceApi.Api;
         viewId: string;
@@ -101,12 +145,21 @@ export declare namespace ProjectViewBookmark {
     }): Promise<{
         bookmark: IBookmark;
     }>;
+    /**
+     * Deletes a bookmark record.
+     * @param params
+     */
     function Delete(params: {
         api?: BruceApi.Api;
         viewId: string;
         bookmarkId: string;
         req?: Api.IReqParams;
     }): Promise<void>;
+    /**
+     * Gets a list of bookmark records.
+     * @param params
+     * @returns
+     */
     function GetList(params: {
         api?: BruceApi.Api;
         viewId: string;
@@ -114,6 +167,11 @@ export declare namespace ProjectViewBookmark {
     }): Promise<{
         bookmarks: IBookmark[];
     }>;
+    /**
+     * Creates or updates a bookmark record.
+     * @param params
+     * @returns
+     */
     function Update(params: {
         api?: BruceApi.Api;
         viewId: string;
@@ -122,6 +180,10 @@ export declare namespace ProjectViewBookmark {
     }): Promise<{
         bookmark: IBookmark;
     }>;
+    /**
+     * Sets the order of bookmarks within a project view.
+     * @param params
+     */
     function SetOrder(params: {
         api?: BruceApi.Api;
         viewId: string;

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

@@ -1,16 +1,31 @@
+/**
+ * A tile is an imagery or terrain tileset definition.
+ */
 export declare namespace ProjectViewTile {
     type MapTileId = string | EDefaultImagery;
     type TerrainTileId = string | EDefaultTerrain;
+    /**
+     * Base information for loading an imagery or terrain tileset record.
+     */
     interface ITileMeta {
         accountId?: string;
         tilesetId: string;
     }
+    /**
+     * Definition for a project view terrain.
+     */
     interface IViewTerrain extends ITileMeta {
         tilesetId: TerrainTileId;
     }
+    /**
+     * Definition for a project view imagery.
+     */
     interface IViewImagery extends ITileMeta {
         tilesetId: MapTileId;
     }
+    /**
+     * Definition for a bookmark imagery.
+     */
     interface IBookmarkImagery extends IViewImagery {
         alpha?: number;
         brightness?: number;
@@ -19,8 +34,14 @@ export declare namespace ProjectViewTile {
         gamma?: number;
         hue?: number;
     }
+    /**
+     * Definition for a bookmark terrain.
+     */
     interface IBookmarkTerrain extends IViewTerrain {
     }
+    /**
+     * Available imagery defaults.
+     */
     enum EDefaultImagery {
         BingMapsAerial = "bingmapsaerial",
         BingMapsAerialWithLabels = "bingmapsaerialwithlabels",
@@ -37,6 +58,9 @@ export declare namespace ProjectViewTile {
         StamenToner = "stamentoner",
         Grid = "grid"
     }
+    /**
+     * Definition for a default imagery.
+     */
     interface IDefaultImagery {
         id: EDefaultImagery;
         name: string;
@@ -47,11 +71,17 @@ export declare namespace ProjectViewTile {
      * 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[];
+    /**
+     * Available terrain defaults.
+     */
     enum EDefaultTerrain {
         CesiumWorldTerrain = "cesiumworldterrain",
         FlatTerrain = "flatterrain",
         LINZ = "linz"
     }
+    /**
+     * Definition for a default terrain.
+     */
     interface IDefaultTerrain {
         id: EDefaultTerrain;
         name: string;

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

@@ -6,19 +6,40 @@ import { ProjectViewTile } from "./project-view-tile";
 import { ProjectViewBookmark } from "./project-view-bookmark";
 import { ProjectViewSelection } from "./project-view-selection";
 /**
- * Describes the "Project View" concept within Bruce.
+ * Describes the "Project View" concept within Nextspace.
  * A project view is a collection of settings for a visualization application we support.
  * It will describe what panels to show and how, it will also describe all possible ways data can be displayed.
  */
 export declare namespace ProjectView {
+    /**
+     * Returns cache identifier for a project view.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetCacheKey("abc");
+     *     api.Cache.Remove(key);
+     * }
+     * @param viewId
+     * @returns
+     */
     function GetCacheKey(viewId: string): string;
+    /**
+     * Returns cache identifier for a list of project views.
+     * Example: {
+     *     const api: BruceApi.Api = ...;
+     *     const key = GetListCacheKey();
+     *     api.Cache.Remove(key);
+     * }
+     * @returns
+     */
     function GetListCacheKey(): string;
     const DEFAULT_DATA_VERSION = 2;
+    /**
+     * Describes a project view record.
+     */
     interface IView {
         ID?: string;
         Name: string;
         Description?: string;
-        Feature?: string[];
         "CreatedByUser.ID"?: string;
         CreatedTime?: UTC.IUTC;
         DefaultUISlideID?: string;
@@ -27,6 +48,7 @@ export declare namespace ProjectView {
         SupportEmail?: string;
         Settings?: ISettings;
         IsDefault?: boolean;
+        Feature?: string[];
     }
     /**
      * These are the base settings expected in any project view data-version.
@@ -49,9 +71,15 @@ export declare namespace ProjectView {
         selectionColor?: string;
         present?: IPresent;
     }
+    /**
+     * Per project view branding to compliment the account branding.
+     */
     interface IBranding {
         bannerFileId?: string;
     }
+    /**
+     * Presentation mode settings.
+     */
     interface IPresent {
         bookmarkDuration?: number;
     }
@@ -63,9 +91,17 @@ export declare namespace ProjectView {
         description?: string;
         icon?: string;
     }
+    /**
+     * Describes the plugins enabled for a project view.
+     */
     interface IPlugins {
         enabledIds: string[];
     }
+    /**
+     * Gets a project view record.
+     * @param params
+     * @returns
+     */
     function Get(params: {
         api?: BruceApi.Api;
         viewId: string;
@@ -73,17 +109,31 @@ export declare namespace ProjectView {
     }): Promise<{
         view: IView;
     }>;
+    /**
+     * Gets a list of project views.
+     * @param params
+     * @returns
+     */
     function GetList(params: {
         api?: BruceApi.Api;
         req?: Api.IReqParams;
     }): Promise<{
         views: IView[];
     }>;
+    /**
+     * Deletes a project view.
+     * @param params
+     */
     function Delete(params: {
         api?: BruceApi.Api;
         viewId: string;
         req?: Api.IReqParams;
     }): Promise<void>;
+    /**
+     * Creates or updates a project view.
+     * @param params
+     * @returns
+     */
     function Update(params: {
         api?: BruceApi.Api;
         view: IView;

package/dist/types/project/zoom-control.d.ts

@@ -4,12 +4,19 @@ import { Style } from "../bruce-models";
  * between a min-max distance of an entity to the camera.
  */
 export declare namespace ZoomControl {
+    /**
+     * Available display types for a menu item.
+     */
     enum EDisplayType {
         Hidden = "hidden",
         Point = "point",
         Geometry = "geometry",
         Model3D = "3d"
     }
+    /**
+     * Describes a menu item's zoom control row.
+     * Typically there is an array of these for a menu item.
+     */
     interface IItem {
         MinZoom?: number;
         MaxZoom?: number;

package/dist/types/server/hosting-location.d.ts

@@ -6,6 +6,9 @@ import { GuardianApi } from "../api/guardian-api";
  * A hosting location will have one or many database servers as well, this is an additional setting.
  */
 export declare namespace HostingLocation {
+    /**
+     * Describes a hosting location record.
+     */
     interface ILocation {
         ID: number;
         Key: string;
@@ -21,6 +24,7 @@ export declare namespace HostingLocation {
         Settings?: any;
     }
     /**
+     * Returns a list of hosting locations.
      * @Warning: This will not return the Settings property.
      * @param params
      * @returns
@@ -31,6 +35,11 @@ export declare namespace HostingLocation {
     }): Promise<{
         locations: ILocation[];
     }>;
+    /**
+     * Returns a hosting location record by ID.
+     * @param params
+     * @returns
+     */
     function GetById(params: {
         id: number;
         api?: GuardianApi.Api;
@@ -38,6 +47,11 @@ export declare namespace HostingLocation {
     }): Promise<{
         location: ILocation;
     }>;
+    /**
+     * Returns a hosting location record by key.
+     * @param params
+     * @returns
+     */
     function GetByKey(params: {
         key: string;
         api?: GuardianApi.Api;
@@ -54,6 +68,11 @@ export declare namespace HostingLocation {
     function GuessKey(params: {
         DBServer?: string;
     }): "HYPERFARM" | "AU-VULTR-FIRST" | "US-VULTR-FIRST" | "EU-VULTR-FIRST" | "SE-VULTR-FIRST" | "DEV-FIRST" | "SE" | "US" | "EU" | "AU" | "DEV";
+    /**
+     * Returns a hosting location key by account ID.
+     * @param params
+     * @returns
+     */
     function GetKeyByAccountId(params: {
         accountId?: string;
         apiSettings?: AccountSettings.IBruceApi;
@@ -63,6 +82,11 @@ export declare namespace HostingLocation {
         key: string;
         isLegacy?: boolean;
     }>;
+    /**
+     * Returns a hosting location record by account ID.
+     * @param params
+     * @returns
+     */
     function GetByAccountId(params: {
         accountId?: string;
         apiSettings?: AccountSettings.IBruceApi;

package/dist/types/server/message-broker.d.ts

@@ -1,4 +1,7 @@
 import { Api } from "../api/api";
+/**
+ * TODO: rewrite.
+ */
 export declare namespace MessageBroker {
     enum EAction {
         SUBSCRIBE = "subscribe",