bruce-models 0.7.8 → 0.8.0

package/dist/lib/util/encrypt-utils.js

@@ -1,21 +1,21 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EncryptUtils = void 0;
-var EncryptUtils;
-(function (EncryptUtils) {
-    // https://stackoverflow.com/questions/7616461/generate-a-hash-from-string-in-javascript
-    function Cyrb53Hash(str, seed) {
-        if (seed === void 0) { seed = 0; }
-        var h1 = 0xdeadbeef ^ seed, h2 = 0x41c6ce57 ^ seed;
-        for (var i = 0, ch = void 0; i < str.length; i++) {
-            ch = str.charCodeAt(i);
-            h1 = Math.imul(h1 ^ ch, 2654435761);
-            h2 = Math.imul(h2 ^ ch, 1597334677);
-        }
-        h1 = Math.imul(h1 ^ (h1 >>> 16), 2246822507) ^ Math.imul(h2 ^ (h2 >>> 13), 3266489909);
-        h2 = Math.imul(h2 ^ (h2 >>> 16), 2246822507) ^ Math.imul(h1 ^ (h1 >>> 13), 3266489909);
-        return (4294967296 * (2097151 & h2) + (h1 >>> 0));
-    }
-    EncryptUtils.Cyrb53Hash = Cyrb53Hash;
-})(EncryptUtils = exports.EncryptUtils || (exports.EncryptUtils = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EncryptUtils = void 0;
+var EncryptUtils;
+(function (EncryptUtils) {
+    // https://stackoverflow.com/questions/7616461/generate-a-hash-from-string-in-javascript
+    function Cyrb53Hash(str, seed) {
+        if (seed === void 0) { seed = 0; }
+        var h1 = 0xdeadbeef ^ seed, h2 = 0x41c6ce57 ^ seed;
+        for (var i = 0, ch = void 0; i < str.length; i++) {
+            ch = str.charCodeAt(i);
+            h1 = Math.imul(h1 ^ ch, 2654435761);
+            h2 = Math.imul(h2 ^ ch, 1597334677);
+        }
+        h1 = Math.imul(h1 ^ (h1 >>> 16), 2246822507) ^ Math.imul(h2 ^ (h2 >>> 13), 3266489909);
+        h2 = Math.imul(h2 ^ (h2 >>> 16), 2246822507) ^ Math.imul(h1 ^ (h1 >>> 13), 3266489909);
+        return (4294967296 * (2097151 & h2) + (h1 >>> 0));
+    }
+    EncryptUtils.Cyrb53Hash = Cyrb53Hash;
+})(EncryptUtils = exports.EncryptUtils || (exports.EncryptUtils = {}));
 //# sourceMappingURL=encrypt-utils.js.map

package/dist/lib/util/math-utils.js

@@ -1,42 +1,42 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MathUtils = void 0;
-var MathUtils;
-(function (MathUtils) {
-    /**
-     * Rounds a number to a given number of decimal places.
-     * @param num
-     * @param decimals
-     * @returns
-     */
-    function Round(num, decimals) {
-        if (decimals === void 0) { decimals = 0; }
-        if (decimals <= 0) {
-            return Math.round(num);
-        }
-        var tmp = "1";
-        for (var i = 0; i < decimals; i++) {
-            tmp += "0";
-        }
-        var d = parseFloat(tmp);
-        return Math.round((num + Number.EPSILON) * d) / d;
-    }
-    MathUtils.Round = Round;
-    /**
-     * Returns a random integer between min (inclusive) and max (inclusive).
-     * @param min
-     * @param max
-     * @returns
-     */
-    function RandInt(min, max) {
-        if (min == max) {
-            return min;
-        }
-        else if (min > max) {
-            throw ("Min is greater than max.");
-        }
-        return Math.floor(Math.random() * (max - min + 1)) + min;
-    }
-    MathUtils.RandInt = RandInt;
-})(MathUtils = exports.MathUtils || (exports.MathUtils = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MathUtils = void 0;
+var MathUtils;
+(function (MathUtils) {
+    /**
+     * Rounds a number to a given number of decimal places.
+     * @param num
+     * @param decimals
+     * @returns
+     */
+    function Round(num, decimals) {
+        if (decimals === void 0) { decimals = 0; }
+        if (decimals <= 0) {
+            return Math.round(num);
+        }
+        var tmp = "1";
+        for (var i = 0; i < decimals; i++) {
+            tmp += "0";
+        }
+        var d = parseFloat(tmp);
+        return Math.round((num + Number.EPSILON) * d) / d;
+    }
+    MathUtils.Round = Round;
+    /**
+     * Returns a random integer between min (inclusive) and max (inclusive).
+     * @param min
+     * @param max
+     * @returns
+     */
+    function RandInt(min, max) {
+        if (min == max) {
+            return min;
+        }
+        else if (min > max) {
+            throw ("Min is greater than max.");
+        }
+        return Math.floor(Math.random() * (max - min + 1)) + min;
+    }
+    MathUtils.RandInt = RandInt;
+})(MathUtils = exports.MathUtils || (exports.MathUtils = {}));
 //# sourceMappingURL=math-utils.js.map

package/dist/lib/util/object-utils.js

@@ -1,18 +1,18 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectUtils = void 0;
-var ObjectUtils;
-(function (ObjectUtils) {
-    /**
-     * Generates a Bruce compatible UID.
-     * @returns
-     */
-    function UId() {
-        return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function (c) {
-            var r = Math.random() * 16 | 0, v = c == "x" ? r : (r & 0x3 | 0x8);
-            return v.toString(16);
-        });
-    }
-    ObjectUtils.UId = UId;
-})(ObjectUtils = exports.ObjectUtils || (exports.ObjectUtils = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ObjectUtils = void 0;
+var ObjectUtils;
+(function (ObjectUtils) {
+    /**
+     * Generates a Bruce compatible UID.
+     * @returns
+     */
+    function UId() {
+        return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function (c) {
+            var r = Math.random() * 16 | 0, v = c == "x" ? r : (r & 0x3 | 0x8);
+            return v.toString(16);
+        });
+    }
+    ObjectUtils.UId = UId;
+})(ObjectUtils = exports.ObjectUtils || (exports.ObjectUtils = {}));
 //# sourceMappingURL=object-utils.js.map

package/dist/lib/util/path-utils.js

@@ -1,62 +1,62 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PathUtils = void 0;
-/**
- * Utility to help with parsing and wrapping Bruce paths.
- */
-var PathUtils;
-(function (PathUtils) {
-    function Parse(str) {
-        if (!str) {
-            return [];
-        }
-        var broken = str.split("\"/\"");
-        if (broken.length > 0) {
-            var top_1 = broken[0];
-            if (top_1.length > 0) {
-                if (top_1.charAt(0) == "\"") {
-                    top_1 = top_1.substring(1);
-                }
-                broken[0] = top_1;
-            }
-            var endIndex = broken.length - 1;
-            var bot = broken[endIndex];
-            if (bot.length > 0) {
-                if (bot.charAt(bot.length - 1) == "\"") {
-                    bot = bot.substring(0, bot.length - 1);
-                }
-                broken[endIndex] = bot;
-            }
-        }
-        return broken;
-    }
-    PathUtils.Parse = Parse;
-    function Wrap(path) {
-        var tmp = "\"";
-        for (var i = 0; i < path.length; i++) {
-            var section = path[i];
-            tmp += section;
-            if (i < path.length - 1) {
-                tmp += "\"/\"";
-            }
-        }
-        tmp += "\"";
-        return tmp;
-    }
-    PathUtils.Wrap = Wrap;
-    function ParseLegacy(str) {
-        var broken = str.split(".");
-        for (var i = 0; i < broken.length; i++) {
-            var piece = broken[0];
-            if (piece.charAt(0) == "\"") {
-                piece = broken[0] = piece.substring(1);
-            }
-            if (piece.charAt(piece.length - 1) == "\"") {
-                broken[0] = piece.substring(0, piece.length - 1);
-            }
-        }
-        return broken;
-    }
-    PathUtils.ParseLegacy = ParseLegacy;
-})(PathUtils = exports.PathUtils || (exports.PathUtils = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathUtils = void 0;
+/**
+ * Utility to help with parsing and wrapping Bruce paths.
+ */
+var PathUtils;
+(function (PathUtils) {
+    function Parse(str) {
+        if (!str) {
+            return [];
+        }
+        var broken = str.split("\"/\"");
+        if (broken.length > 0) {
+            var top_1 = broken[0];
+            if (top_1.length > 0) {
+                if (top_1.charAt(0) == "\"") {
+                    top_1 = top_1.substring(1);
+                }
+                broken[0] = top_1;
+            }
+            var endIndex = broken.length - 1;
+            var bot = broken[endIndex];
+            if (bot.length > 0) {
+                if (bot.charAt(bot.length - 1) == "\"") {
+                    bot = bot.substring(0, bot.length - 1);
+                }
+                broken[endIndex] = bot;
+            }
+        }
+        return broken;
+    }
+    PathUtils.Parse = Parse;
+    function Wrap(path) {
+        var tmp = "\"";
+        for (var i = 0; i < path.length; i++) {
+            var section = path[i];
+            tmp += section;
+            if (i < path.length - 1) {
+                tmp += "\"/\"";
+            }
+        }
+        tmp += "\"";
+        return tmp;
+    }
+    PathUtils.Wrap = Wrap;
+    function ParseLegacy(str) {
+        var broken = str.split(".");
+        for (var i = 0; i < broken.length; i++) {
+            var piece = broken[0];
+            if (piece.charAt(0) == "\"") {
+                piece = broken[0] = piece.substring(1);
+            }
+            if (piece.charAt(piece.length - 1) == "\"") {
+                broken[0] = piece.substring(0, piece.length - 1);
+            }
+        }
+        return broken;
+    }
+    PathUtils.ParseLegacy = ParseLegacy;
+})(PathUtils = exports.PathUtils || (exports.PathUtils = {}));
 //# sourceMappingURL=path-utils.js.map

package/dist/lib/util/url-utils.js

@@ -1,108 +1,108 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UrlUtils = void 0;
-/**
- * Utility to help with url manipulation.
- */
-var UrlUtils;
-(function (UrlUtils) {
-    function GetQueryString(doc) {
-        var qs = {};
-        var p0 = doc.location.href.indexOf("?");
-        if (p0 >= 0) {
-            var str = doc.location.href.substring(p0 + 1);
-            var tokens = str.split("&");
-            tokens.forEach(function (token) {
-                var p = token.split("=");
-                if (p.length == 2) {
-                    qs[p[0]] = p[1];
-                }
-            });
-        }
-        return qs;
-    }
-    UrlUtils.GetQueryString = GetQueryString;
-    /**
-     * Helper to get and set url params for a given window.
-     */
-    var Handler = /** @class */ (function () {
-        function Handler(window, allowedKeys) {
-            this._allowedKeys = null;
-            this._window = window;
-            this._allowedKeys = allowedKeys;
-        }
-        Object.defineProperty(Handler.prototype, "window", {
-            get: function () {
-                return this._window;
-            },
-            enumerable: false,
-            configurable: true
-        });
-        Object.defineProperty(Handler.prototype, "document", {
-            get: function () {
-                var _a;
-                return (_a = this.window) === null || _a === void 0 ? void 0 : _a.document;
-            },
-            enumerable: false,
-            configurable: true
-        });
-        Object.defineProperty(Handler.prototype, "allowedKeys", {
-            get: function () {
-                return this._allowedKeys;
-            },
-            enumerable: false,
-            configurable: true
-        });
-        Handler.prototype.UpdateAllowedKeys = function (allowedKeys) {
-            this._allowedKeys = allowedKeys;
-            var params = this.GetParams();
-            this.refresh(params);
-        };
-        Handler.prototype.UpdateParam = function (key, value) {
-            var params = this.GetParams();
-            params[key + ""] = value + "";
-            this.refresh(params);
-        };
-        Handler.prototype.RemoveParam = function (key) {
-            var params = this.GetParams();
-            params[key + ""] = null;
-            this.refresh(params);
-        };
-        Handler.prototype.GetParamKeys = function () {
-            var params = GetQueryString(this.document);
-            return Object.keys(params);
-        };
-        Handler.prototype.GetParams = function () {
-            return GetQueryString(this.document);
-        };
-        Handler.prototype.GetParam = function (key) {
-            var params = this.GetParams();
-            return params[key + ""];
-        };
-        Handler.prototype.Clear = function () {
-            this.refresh({});
-        };
-        Handler.prototype.refresh = function (data) {
-            var params = [];
-            var keys = Object.keys(data);
-            for (var i = 0; i < keys.length; i++) {
-                var key = keys[i];
-                if (this._allowedKeys == null || this._allowedKeys.includes(key)) {
-                    var val = data[key];
-                    if (!!val || val == 0) {
-                        params.push(key + "=" + val);
-                    }
-                }
-            }
-            if (params.length > 0) {
-                this.window.history.replaceState({}, null, "?" + params.join("&"));
-            }
-            else {
-                this.window.history.replaceState({}, null, "");
-            }
-        };
-        return Handler;
-    }());
-    UrlUtils.Handler = Handler;
-})(UrlUtils = exports.UrlUtils || (exports.UrlUtils = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UrlUtils = void 0;
+/**
+ * Utility to help with url manipulation.
+ */
+var UrlUtils;
+(function (UrlUtils) {
+    function GetQueryString(doc) {
+        var qs = {};
+        var p0 = doc.location.href.indexOf("?");
+        if (p0 >= 0) {
+            var str = doc.location.href.substring(p0 + 1);
+            var tokens = str.split("&");
+            tokens.forEach(function (token) {
+                var p = token.split("=");
+                if (p.length == 2) {
+                    qs[p[0]] = p[1];
+                }
+            });
+        }
+        return qs;
+    }
+    UrlUtils.GetQueryString = GetQueryString;
+    /**
+     * Helper to get and set url params for a given window.
+     */
+    var Handler = /** @class */ (function () {
+        function Handler(window, allowedKeys) {
+            this._allowedKeys = null;
+            this._window = window;
+            this._allowedKeys = allowedKeys;
+        }
+        Object.defineProperty(Handler.prototype, "window", {
+            get: function () {
+                return this._window;
+            },
+            enumerable: false,
+            configurable: true
+        });
+        Object.defineProperty(Handler.prototype, "document", {
+            get: function () {
+                var _a;
+                return (_a = this.window) === null || _a === void 0 ? void 0 : _a.document;
+            },
+            enumerable: false,
+            configurable: true
+        });
+        Object.defineProperty(Handler.prototype, "allowedKeys", {
+            get: function () {
+                return this._allowedKeys;
+            },
+            enumerable: false,
+            configurable: true
+        });
+        Handler.prototype.UpdateAllowedKeys = function (allowedKeys) {
+            this._allowedKeys = allowedKeys;
+            var params = this.GetParams();
+            this.refresh(params);
+        };
+        Handler.prototype.UpdateParam = function (key, value) {
+            var params = this.GetParams();
+            params[key + ""] = value + "";
+            this.refresh(params);
+        };
+        Handler.prototype.RemoveParam = function (key) {
+            var params = this.GetParams();
+            params[key + ""] = null;
+            this.refresh(params);
+        };
+        Handler.prototype.GetParamKeys = function () {
+            var params = GetQueryString(this.document);
+            return Object.keys(params);
+        };
+        Handler.prototype.GetParams = function () {
+            return GetQueryString(this.document);
+        };
+        Handler.prototype.GetParam = function (key) {
+            var params = this.GetParams();
+            return params[key + ""];
+        };
+        Handler.prototype.Clear = function () {
+            this.refresh({});
+        };
+        Handler.prototype.refresh = function (data) {
+            var params = [];
+            var keys = Object.keys(data);
+            for (var i = 0; i < keys.length; i++) {
+                var key = keys[i];
+                if (this._allowedKeys == null || this._allowedKeys.includes(key)) {
+                    var val = data[key];
+                    if (!!val || val == 0) {
+                        params.push(key + "=" + val);
+                    }
+                }
+            }
+            if (params.length > 0) {
+                this.window.history.replaceState({}, null, "?" + params.join("&"));
+            }
+            else {
+                this.window.history.replaceState({}, null, "");
+            }
+        };
+        return Handler;
+    }());
+    UrlUtils.Handler = Handler;
+})(UrlUtils = exports.UrlUtils || (exports.UrlUtils = {}));
 //# sourceMappingURL=url-utils.js.map

package/dist/types/api/bruce-api.d.ts

@@ -1,6 +1,7 @@
 import { AbstractApi } from "./abstract-api";
 import { Api as A } from "./api";
 import { CamApi } from "./cam-api";
+import { MessageBroker } from "../server/message-broker";
 export declare namespace BruceApi {
     interface IGetter {
         env: A.EEnv;
@@ -17,6 +18,8 @@ export declare namespace BruceApi {
         private env;
         private loadProm;
         private loadCancelled;
+        private messageBroker;
+        get MessageBroker(): MessageBroker.IBroker;
         get Loading(): Promise<void>;
         /**
          * @param accountId
@@ -24,7 +27,12 @@ export declare namespace BruceApi {
          * @param cam (Optional) cam instance to use for loading the regional base url.
          */
         constructor(accountId: string, env?: A.Env, cam?: CamApi.Api);
-        private setBaseUrl;
+        /**
+         * Loads regional base url and sets up message broker.
+         * @param cam
+         * @returns
+         */
+        private init;
         /**
          * Warning: This method does not wait for init to finish loading.
          * This means the url could be changed once fully initialized.

package/dist/types/bruce-models.d.ts

@@ -44,6 +44,7 @@ export * from "./project/project-view";
 export * from "./project/project-view-legacy-tile";
 export * from "./project/project-view-tile";
 export * from "./server/pending-action";
+export * from "./server/message-broker";
 export * from "./style/style";
 export * from "./tileset/tileset-cad";
 export * from "./tileset/tileset-entities-map-tiles";

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

@@ -11,9 +11,7 @@ export declare namespace ProjectViewTile {
     interface IViewImagery extends ITileMeta {
         tilesetId: MapTileId;
     }
-    interface IBookmarkImagery {
-        tilesetId: MapTileId;
-        accountId: string;
+    interface IBookmarkImagery extends IViewImagery {
         alpha?: number;
         brightness?: number;
         saturation?: number;
@@ -21,9 +19,7 @@ export declare namespace ProjectViewTile {
         gamma?: number;
         hue?: number;
     }
-    interface IBookmarkTerrain {
-        tilesetId: TerrainTileId;
-        accountId: string;
+    interface IBookmarkTerrain extends IViewTerrain {
     }
     enum EDefaultImagery {
         BingMapsAerial = "bingmapsaerial",

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

@@ -0,0 +1,108 @@
+import { Api } from "../api/api";
+export declare namespace MessageBroker {
+    export enum Action {
+        SUBSCRIBE = "subscribe",
+        SUBSCRIBE_SHADOW = "subscribeShadow",
+        UNSUBSCRIBE = "unsubscribe",
+        BROADCAST = "broadcast",
+        GET_TOPIC_SUBSCRIBERS = "getTopicSubscribers"
+    }
+    /** Events types any component may get from server */
+    export enum Event {
+        SAVED = "saved",
+        UPDATED = "updated",
+        DELETED = "deleted",
+        EDIT_STARTED = "editStarted",
+        EDIT_FINISHED = "editFinished",
+        USERS_UPDATE = "usersUpdate"
+    }
+    interface IMessageBase {
+        action: Action;
+        topic: string;
+    }
+    interface IBroadcastMessage extends IMessageBase {
+        action: Action.BROADCAST;
+        event: Event;
+        user: string;
+    }
+    export type SubscribeMessage = IMessageBase & {
+        action: Action.SUBSCRIBE | Action.SUBSCRIBE_SHADOW;
+        user: string;
+    };
+    export type UnsubscribeMessage = IMessageBase & {
+        action: Action.UNSUBSCRIBE;
+    };
+    export type GetTopicSubscribersMessage = IMessageBase & {
+        action: Action.GET_TOPIC_SUBSCRIBERS;
+    };
+    export type BroadcastMessageSaved = IBroadcastMessage & {
+        event: Event.SAVED;
+    };
+    export type BroadcastMessageUpdated = IBroadcastMessage & {
+        event: Event.UPDATED;
+    };
+    export type BroadcastMessageDeleted = IBroadcastMessage & {
+        event: Event.DELETED;
+    };
+    export type BroadcastMessageEditionStarted = IBroadcastMessage & {
+        event: Event.EDIT_STARTED;
+    };
+    export type BroadcastMessageEditionFinished = IBroadcastMessage & {
+        event: Event.EDIT_FINISHED;
+    };
+    export type BroadcastMessageUsersUpdate = IBroadcastMessage & {
+        event: Event.USERS_UPDATE;
+        data: string[];
+    };
+    export interface OutgoingMessageBase {
+        topic: string;
+        event?: Event;
+    }
+    export type OutgoingBroadcastMessage = IMessageBase & {
+        action: Action.BROADCAST;
+        time: number;
+    };
+    export type IncomingMessage = BroadcastMessageSaved | BroadcastMessageUpdated | BroadcastMessageDeleted | BroadcastMessageEditionStarted | BroadcastMessageEditionFinished | BroadcastMessageUsersUpdate;
+    export type OutgoingMessage = (SubscribeMessage | UnsubscribeMessage | GetTopicSubscribersMessage | OutgoingBroadcastMessage) & {
+        user: string;
+        time: number;
+    };
+    export interface IBroker {
+        subscribe: (topic: string, callback: (msg: IncomingMessage) => void) => void;
+        subscribeShadow: (topic: string, callback: (msg: IncomingMessage) => void) => void;
+        unsubscribe: (topic: string, callback: (msg: IncomingMessage) => void) => void;
+        sendBroadcastMessage: (msg: OutgoingMessageBase) => void;
+        connected: boolean;
+    }
+    /** Communicates with a server message broker */
+    export class WebSocketBroker implements IBroker {
+        private uri;
+        private env;
+        private subscriptions;
+        private ws;
+        private reconnects;
+        private maxReconnects;
+        private user;
+        constructor(uri: string, env: Api.Env);
+        private connect;
+        private formatApiUri;
+        setUser(user: string): void;
+        private onOpen;
+        private onClose;
+        private onMessage;
+        private onError;
+        private addSubscriber;
+        /** Send message to server */
+        private sendMessage;
+        get connected(): boolean;
+        /** Add a subscriber to a topic */
+        subscribe(topic: string, callback: (msg: IncomingMessage) => void, action?: Action): void;
+        /** Add a shadow subscriber to a topic */
+        subscribeShadow(topic: string, callback: (msg: IncomingMessage) => void): void;
+        /** Remove a subscriber from a topic */
+        unsubscribe(topic: string, callback: (msg: IncomingMessage) => void): void;
+        sendBroadcastMessage(msg: OutgoingMessageBase): void;
+        requestTopicUsers(topic: string, callback: (msg: IncomingMessage) => void): void;
+    }
+    export {};
+}