bruce-models 2.3.6 → 2.3.8

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

@@ -1,136 +1,136 @@
-import { Api } from "../api/api";
-import { BruceApi } from "../api/bruce-api";
-import { UTC } from "../common/utc";
-import { MenuItem } from "./menu-item";
-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.
- * It will describe what panels to show and how, it will also describe all possible ways data can be displayed.
- */
-export declare namespace ProjectView {
-    function GetCacheKey(viewId: string): string;
-    function GetListCacheKey(): string;
-    const DEFAULT_DATA_VERSION = 1;
-    interface IBaseView {
-        ID?: string;
-        Name: string;
-        Description?: string;
-        Feature?: string[];
-        "CreatedByUser.ID"?: string;
-        CreatedTime?: UTC.IUTC;
-        DefaultUISlideID?: string;
-        CreatedByUIVersion?: string;
-        DataVersion: number;
-        SupportEmail?: string;
-        Settings?: IBaseSettings;
-        IsDefault?: boolean;
-    }
-    /**
-     * These are the base settings expected in any project view data-version.
-     * The only exception is data-version = 1 which is our deprecated legacy format.
-     */
-    interface IBaseSettings {
-        menuItems?: MenuItem.IItem[];
-        IsLoginRequired?: boolean;
-        IsRestricted?: boolean;
-    }
-    type View = LegacyNavigator.IView | Navigator.IView | IBaseView;
-    namespace LegacyNavigator {
-        const DATA_VERSION = 1;
-        interface IShadowSettings {
-            IsShadowEnabled?: boolean;
-            IsShadowSoft?: boolean;
-            ShadowSampleSize?: number;
-        }
-        interface ISettings extends IBaseSettings {
-            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;
-            TilesetBackfaceCulling?: boolean;
-            TopPanelComponents?: string[];
-            LeftPanelComponents?: string[];
-            PostProcessFXAA?: boolean;
-            Shadows?: boolean;
-            CustomFormSettings?: any;
-            PreloadEntityTypes?: boolean;
-            ClickActions?: any;
-            Shadow?: {
-                StaticCamera?: IShadowSettings;
-                MovingCamera?: IShadowSettings;
-            };
-        }
-        interface IView extends IBaseView {
-            Settings: ISettings;
-        }
-    }
-    namespace Navigator {
-        const DATA_VERSION = 2;
-        interface ISettings extends IBaseSettings {
-            imageries?: ProjectViewTile.IViewImagery[];
-            terrains?: ProjectViewTile.IViewTerrain[];
-            defaults?: {
-                camera?: ProjectViewBookmark.Navigator.ICamera;
-                settings?: ProjectViewBookmark.Navigator.ISettings;
-            };
-            contact?: IContact;
-            plugins?: IPlugins;
-            selectionColor?: string;
-        }
-        /**
-         * Describes how to present contact information to the users.
-         */
-        interface IContact {
-            enabled: boolean;
-            description?: string;
-            icon?: string;
-        }
-        interface IPlugins {
-            enabledIds: string[];
-        }
-        interface IView extends IBaseView {
-            Settings: ISettings;
-        }
-    }
-    function Get(params: {
-        api: BruceApi.Api;
-        viewId: string;
-        req?: Api.IReqParams;
-    }): Promise<{
-        view: View;
-    }>;
-    function GetList(params: {
-        api: BruceApi.Api;
-        req?: Api.IReqParams;
-    }): Promise<{
-        views: View[];
-    }>;
-    function Delete(params: {
-        api: BruceApi.Api;
-        viewId: string;
-        req?: Api.IReqParams;
-    }): Promise<void>;
-    function Update(params: {
-        api: BruceApi.Api;
-        view: View;
-        req?: Api.IReqParams;
-    }): Promise<{
-        view: View;
-    }>;
-}
+import { Api } from "../api/api";
+import { BruceApi } from "../api/bruce-api";
+import { UTC } from "../common/utc";
+import { MenuItem } from "./menu-item";
+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.
+ * It will describe what panels to show and how, it will also describe all possible ways data can be displayed.
+ */
+export declare namespace ProjectView {
+    function GetCacheKey(viewId: string): string;
+    function GetListCacheKey(): string;
+    const DEFAULT_DATA_VERSION = 1;
+    interface IBaseView {
+        ID?: string;
+        Name: string;
+        Description?: string;
+        Feature?: string[];
+        "CreatedByUser.ID"?: string;
+        CreatedTime?: UTC.IUTC;
+        DefaultUISlideID?: string;
+        CreatedByUIVersion?: string;
+        DataVersion: number;
+        SupportEmail?: string;
+        Settings?: IBaseSettings;
+        IsDefault?: boolean;
+    }
+    /**
+     * These are the base settings expected in any project view data-version.
+     * The only exception is data-version = 1 which is our deprecated legacy format.
+     */
+    interface IBaseSettings {
+        menuItems?: MenuItem.IItem[];
+        IsLoginRequired?: boolean;
+        IsRestricted?: boolean;
+    }
+    type View = LegacyNavigator.IView | Navigator.IView | IBaseView;
+    namespace LegacyNavigator {
+        const DATA_VERSION = 1;
+        interface IShadowSettings {
+            IsShadowEnabled?: boolean;
+            IsShadowSoft?: boolean;
+            ShadowSampleSize?: number;
+        }
+        interface ISettings extends IBaseSettings {
+            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;
+            TilesetBackfaceCulling?: boolean;
+            TopPanelComponents?: string[];
+            LeftPanelComponents?: string[];
+            PostProcessFXAA?: boolean;
+            Shadows?: boolean;
+            CustomFormSettings?: any;
+            PreloadEntityTypes?: boolean;
+            ClickActions?: any;
+            Shadow?: {
+                StaticCamera?: IShadowSettings;
+                MovingCamera?: IShadowSettings;
+            };
+        }
+        interface IView extends IBaseView {
+            Settings: ISettings;
+        }
+    }
+    namespace Navigator {
+        const DATA_VERSION = 2;
+        interface ISettings extends IBaseSettings {
+            imageries?: ProjectViewTile.IViewImagery[];
+            terrains?: ProjectViewTile.IViewTerrain[];
+            defaults?: {
+                camera?: ProjectViewBookmark.Navigator.ICamera;
+                settings?: ProjectViewBookmark.Navigator.ISettings;
+            };
+            contact?: IContact;
+            plugins?: IPlugins;
+            selectionColor?: string;
+        }
+        /**
+         * Describes how to present contact information to the users.
+         */
+        interface IContact {
+            enabled: boolean;
+            description?: string;
+            icon?: string;
+        }
+        interface IPlugins {
+            enabledIds: string[];
+        }
+        interface IView extends IBaseView {
+            Settings: ISettings;
+        }
+    }
+    function Get(params: {
+        api: BruceApi.Api;
+        viewId: string;
+        req?: Api.IReqParams;
+    }): Promise<{
+        view: View;
+    }>;
+    function GetList(params: {
+        api: BruceApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        views: View[];
+    }>;
+    function Delete(params: {
+        api: BruceApi.Api;
+        viewId: string;
+        req?: Api.IReqParams;
+    }): Promise<void>;
+    function Update(params: {
+        api: BruceApi.Api;
+        view: View;
+        req?: Api.IReqParams;
+    }): Promise<{
+        view: View;
+    }>;
+}

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

@@ -1,22 +1,22 @@
-import { Style } from "../bruce-models";
-/**
- * Describes an expectation on what should be rendered for a menu item-
- * between a min-max distance of an entity to the camera.
- */
-export declare namespace ZoomControl {
-    enum EDisplayType {
-        Hidden = "hidden",
-        Point = "point",
-        Geometry = "geometry",
-        Model3D = "3d"
-    }
-    interface IItem {
-        MinZoom?: number;
-        MaxZoom?: number;
-        DisplayType?: EDisplayType;
-        StyleID?: number;
-        Style?: Style.IEntitySettings;
-        LODCategoryID?: string;
-        LODLevel?: number | string;
-    }
-}
+import { Style } from "../bruce-models";
+/**
+ * Describes an expectation on what should be rendered for a menu item-
+ * between a min-max distance of an entity to the camera.
+ */
+export declare namespace ZoomControl {
+    enum EDisplayType {
+        Hidden = "hidden",
+        Point = "point",
+        Geometry = "geometry",
+        Model3D = "3d"
+    }
+    interface IItem {
+        MinZoom?: number;
+        MaxZoom?: number;
+        DisplayType?: EDisplayType;
+        StyleID?: number;
+        Style?: Style.IEntitySettings;
+        LODCategoryID?: string;
+        LODLevel?: number | string;
+    }
+}

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

@@ -1,74 +1,74 @@
-import { AccountSettings } from "../account/account-settings";
-import { Api } from "../api/api";
-import { GuardianApi } from "../api/guardian-api";
-/**
- * A hosting location is a record for a possible bruce-api server configuration.
- * A hosting location will have one or many database servers as well, this is an additional setting.
- */
-export declare namespace HostingLocation {
-    interface ILocation {
-        ID: number;
-        Key: string;
-        IsEnabledForNewAccounts: boolean;
-        DisplayName?: string;
-        Description?: string;
-        AWSRegion?: string;
-        Country?: string;
-        Hoster?: string;
-        City?: string;
-        BruceAPIURL?: string;
-        Environment?: string;
-        Settings?: any;
-    }
-    /**
-     * @Warning: This will not return the Settings property.
-     * @param params
-     * @returns
-     */
-    function GetList(params: {
-        api: GuardianApi.Api;
-        req?: Api.IReqParams;
-    }): Promise<{
-        locations: ILocation[];
-    }>;
-    function GetById(params: {
-        id: number;
-        api: GuardianApi.Api;
-        req?: Api.IReqParams;
-    }): Promise<{
-        location: ILocation;
-    }>;
-    function GetByKey(params: {
-        key: string;
-        api: GuardianApi.Api;
-        req?: Api.IReqParams;
-    }): Promise<{
-        location: ILocation;
-    }>;
-    /**
-     * Returns hostingLocationKey from given db url.
-     * Some older accounts don't have this set, so we need to guess it.
-     * @param params
-     * @returns
-     */
-    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";
-    function GetKeyByAccountId(params: {
-        accountId?: string;
-        apiSettings?: AccountSettings.IBruceApi;
-        api: GuardianApi.Api;
-        req?: Api.IReqParams;
-    }): Promise<{
-        key: string;
-        isLegacy?: boolean;
-    }>;
-    function GetByAccountId(params: {
-        accountId?: string;
-        apiSettings?: AccountSettings.IBruceApi;
-        api: GuardianApi.Api;
-        req?: Api.IReqParams;
-    }): Promise<{
-        location: ILocation;
-    }>;
-}
+import { AccountSettings } from "../account/account-settings";
+import { Api } from "../api/api";
+import { GuardianApi } from "../api/guardian-api";
+/**
+ * A hosting location is a record for a possible bruce-api server configuration.
+ * A hosting location will have one or many database servers as well, this is an additional setting.
+ */
+export declare namespace HostingLocation {
+    interface ILocation {
+        ID: number;
+        Key: string;
+        IsEnabledForNewAccounts: boolean;
+        DisplayName?: string;
+        Description?: string;
+        AWSRegion?: string;
+        Country?: string;
+        Hoster?: string;
+        City?: string;
+        BruceAPIURL?: string;
+        Environment?: string;
+        Settings?: any;
+    }
+    /**
+     * @Warning: This will not return the Settings property.
+     * @param params
+     * @returns
+     */
+    function GetList(params: {
+        api: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        locations: ILocation[];
+    }>;
+    function GetById(params: {
+        id: number;
+        api: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        location: ILocation;
+    }>;
+    function GetByKey(params: {
+        key: string;
+        api: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        location: ILocation;
+    }>;
+    /**
+     * Returns hostingLocationKey from given db url.
+     * Some older accounts don't have this set, so we need to guess it.
+     * @param params
+     * @returns
+     */
+    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";
+    function GetKeyByAccountId(params: {
+        accountId?: string;
+        apiSettings?: AccountSettings.IBruceApi;
+        api: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        key: string;
+        isLegacy?: boolean;
+    }>;
+    function GetByAccountId(params: {
+        accountId?: string;
+        apiSettings?: AccountSettings.IBruceApi;
+        api: GuardianApi.Api;
+        req?: Api.IReqParams;
+    }): Promise<{
+        location: ILocation;
+    }>;
+}

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

@@ -1,86 +1,86 @@
-import { Api } from "../api/api";
-export declare namespace MessageBroker {
-    enum EAction {
-        SUBSCRIBE = "subscribe",
-        SUBSCRIBE_SHADOW = "subscribeShadow",
-        UNSUBSCRIBE = "unsubscribe",
-        BROADCAST = "broadcast",
-        GET_TOPIC_SUBSCRIBERS = "getTopicSubscribers"
-    }
-    type SubscribeType = EAction.SUBSCRIBE | EAction.SUBSCRIBE_SHADOW;
-    interface IMessageBase {
-        topic: string;
-        event?: string;
-        data?: any;
-    }
-    interface IMessage extends IMessageBase {
-        time?: number;
-        user?: string;
-        action: EAction;
-    }
-    interface IBroker {
-        /**
-         * Add a subscriber to a topic.
-         * @param topic
-         * @param callback
-         * @param action
-         */
-        Subscribe: (topic: string, callback: (msg: IMessage) => void, type?: SubscribeType) => void;
-        /**
-         * Remove a subscriber from a topic.
-         * @param topic
-         * @param callback
-         */
-        Unsubscribe: (topic: string, callback: (msg: IMessage) => void) => void;
-        /**
-         * Send message to server.
-         * @param base
-         * @returns
-         */
-        SendMessage: (base: IMessageBase | IMessage) => void;
-        SetUserId: (userId: string) => void;
-        IsConnected: boolean;
-    }
-    /**
-     * Communicates with a server message broker.
-     */
-    class WebSocketBroker implements IBroker {
-        private subscriptions;
-        private ws;
-        private reconnects;
-        private maxReconnects;
-        private userId;
-        private uri;
-        private env;
-        constructor(uri: string, env?: Api.Env);
-        get IsConnected(): boolean;
-        SetUserId(userId: string): void;
-        private connect;
-        private formatApiUri;
-        private onOpen;
-        private onClose;
-        private onMessage;
-        private onError;
-        private addSubscriber;
-        /**
-         * Send message to server.
-         * @param base
-         * @returns
-         */
-        SendMessage(base: IMessageBase | IMessage): void;
-        /**
-         * Add a subscriber to a topic.
-         * @param topic
-         * @param callback
-         * @param action
-         */
-        Subscribe(topic: string, callback: (msg: IMessage) => void, action?: SubscribeType): void;
-        /**
-         * Remove a subscriber from a topic.
-         * @param topic
-         * @param callback
-         */
-        Unsubscribe(topic: string, callback: (msg: IMessage) => void): void;
-        RequestTopicUsers(topic: string, callback: (msg: IMessage) => void): void;
-    }
-}
+import { Api } from "../api/api";
+export declare namespace MessageBroker {
+    enum EAction {
+        SUBSCRIBE = "subscribe",
+        SUBSCRIBE_SHADOW = "subscribeShadow",
+        UNSUBSCRIBE = "unsubscribe",
+        BROADCAST = "broadcast",
+        GET_TOPIC_SUBSCRIBERS = "getTopicSubscribers"
+    }
+    type SubscribeType = EAction.SUBSCRIBE | EAction.SUBSCRIBE_SHADOW;
+    interface IMessageBase {
+        topic: string;
+        event?: string;
+        data?: any;
+    }
+    interface IMessage extends IMessageBase {
+        time?: number;
+        user?: string;
+        action: EAction;
+    }
+    interface IBroker {
+        /**
+         * Add a subscriber to a topic.
+         * @param topic
+         * @param callback
+         * @param action
+         */
+        Subscribe: (topic: string, callback: (msg: IMessage) => void, type?: SubscribeType) => void;
+        /**
+         * Remove a subscriber from a topic.
+         * @param topic
+         * @param callback
+         */
+        Unsubscribe: (topic: string, callback: (msg: IMessage) => void) => void;
+        /**
+         * Send message to server.
+         * @param base
+         * @returns
+         */
+        SendMessage: (base: IMessageBase | IMessage) => void;
+        SetUserId: (userId: string) => void;
+        IsConnected: boolean;
+    }
+    /**
+     * Communicates with a server message broker.
+     */
+    class WebSocketBroker implements IBroker {
+        private subscriptions;
+        private ws;
+        private reconnects;
+        private maxReconnects;
+        private userId;
+        private uri;
+        private env;
+        constructor(uri: string, env?: Api.Env);
+        get IsConnected(): boolean;
+        SetUserId(userId: string): void;
+        private connect;
+        private formatApiUri;
+        private onOpen;
+        private onClose;
+        private onMessage;
+        private onError;
+        private addSubscriber;
+        /**
+         * Send message to server.
+         * @param base
+         * @returns
+         */
+        SendMessage(base: IMessageBase | IMessage): void;
+        /**
+         * Add a subscriber to a topic.
+         * @param topic
+         * @param callback
+         * @param action
+         */
+        Subscribe(topic: string, callback: (msg: IMessage) => void, action?: SubscribeType): void;
+        /**
+         * Remove a subscriber from a topic.
+         * @param topic
+         * @param callback
+         */
+        Unsubscribe(topic: string, callback: (msg: IMessage) => void): void;
+        RequestTopicUsers(topic: string, callback: (msg: IMessage) => void): void;
+    }
+}