bruce-models 0.1.6 → 0.1.7

package/dist/bruce-models.umd.js

@@ -81,6 +81,9 @@
         }
     }
 
+    /**
+     * Contains generic descriptions used for Bruce requests.
+     */
     (function (Api) {
         var ECacheKey;
         (function (ECacheKey) {
@@ -111,10 +114,27 @@
             ECacheKey["AccessToken"] = "accesstoken";
             ECacheKey["UserGroup"] = "usergroup";
             ECacheKey["Account"] = "account";
+            ECacheKey["CustomForm"] = "customform";
         })(ECacheKey = Api.ECacheKey || (Api.ECacheKey = {}));
         Api.DEFAULT_CACHE_DURATION = 60 * 5; // 5 minutes.
         Api.TEMPLATE_ACCOUNT_ID = "template";
         Api.ACCESS_TOKEN_HEADER = "X-Access-Token";
+        /**
+         * Possible environments we host Bruce apps on.
+         * When these are matched, they should be case-insensitive.
+         */
+        var EEnv;
+        (function (EEnv) {
+            EEnv["DEV"] = "DEV";
+            EEnv["STG"] = "STG";
+            EEnv["UAT"] = "UAT";
+            EEnv["PROD"] = "PROD";
+        })(EEnv = Api.EEnv || (Api.EEnv = {}));
+        /**
+         * Prepares a string to be included in a url.
+         * @param str
+         * @returns
+         */
         function Encode(str) {
             return encodeURIComponent(str.replace(/\+/g, "%2B").replace(/\./g, "%2E"));
         }
@@ -130,13 +150,11 @@
             EEncoding["UTF8"] = "UTF-8";
             EEncoding["UTF16"] = "UTF-16BE";
         })(EEncoding = Api.EEncoding || (Api.EEncoding = {}));
-        var EEnv;
-        (function (EEnv) {
-            EEnv["DEV"] = "DEV";
-            EEnv["STG"] = "STG";
-            EEnv["UAT"] = "UAT";
-            EEnv["PROD"] = "PROD";
-        })(EEnv = Api.EEnv || (Api.EEnv = {}));
+        /**
+         * Prepares default settings for a request to Bruce Api.
+         * Our requests WRONGLY have utf-16 for 95% of them. Please be wary of that.
+         * @returns
+         */
         function PrepReqParams() {
             return { response: { encoding: Api.EEncoding.UTF16 } };
         }
@@ -215,6 +233,98 @@
         AnnDocument.GetList = GetList;
     })(exports.AnnDocument || (exports.AnnDocument = {}));
 
+    (function (CustomForm) {
+        function GetCacheKey(id) {
+            return exports.Api.ECacheKey.CustomForm + exports.Api.ECacheKey.Id + id;
+        }
+        CustomForm.GetCacheKey = GetCacheKey;
+        function GetListCacheKey(typeId) {
+            if (typeId) {
+                return exports.Api.ECacheKey.CustomForm + exports.Api.ECacheKey.EntityType + exports.Api.ECacheKey.Id + typeId;
+            }
+            return exports.Api.ECacheKey.CustomForm;
+        }
+        CustomForm.GetListCacheKey = GetListCacheKey;
+        var EType;
+        (function (EType) {
+            EType["Form"] = "GENERIC";
+            EType["Markup"] = "MARKUP";
+        })(EType = CustomForm.EType || (CustomForm.EType = {}));
+        function Get(api, id) {
+            return __awaiter(this, void 0, void 0, function () {
+                var cacheData, req;
+                return __generator(this, function (_a) {
+                    if (!id) {
+                        throw ("Id is required.");
+                    }
+                    cacheData = api.Cache.Get(GetCacheKey(id));
+                    if (cacheData) {
+                        return [2 /*return*/, cacheData];
+                    }
+                    req = api.GET("customForm/" + id, exports.Api.PrepReqParams());
+                    api.Cache.Set(GetCacheKey(id), req, exports.Api.DEFAULT_CACHE_DURATION);
+                    return [2 /*return*/, req];
+                });
+            });
+        }
+        CustomForm.Get = Get;
+        function Delete(api, id) {
+            return __awaiter(this, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            if (!id) {
+                                throw ("Id is required.");
+                            }
+                            return [4 /*yield*/, api.DELETE("customForm/" + id, exports.Api.PrepReqParams())];
+                        case 1:
+                            _a.sent();
+                            api.Cache.RemoveByStartsWith(exports.Api.ECacheKey.CustomForm);
+                            return [2 /*return*/];
+                    }
+                });
+            });
+        }
+        CustomForm.Delete = Delete;
+        function GetList(api, typeId) {
+            return __awaiter(this, void 0, void 0, function () {
+                var url, cacheData, req, prom;
+                return __generator(this, function (_a) {
+                    url = typeId ? "entityType/" + typeId + "/customForms" : "customForms";
+                    cacheData = api.Cache.Get(GetListCacheKey(typeId));
+                    if (cacheData) {
+                        return [2 /*return*/, cacheData];
+                    }
+                    req = api.GET(url, exports.Api.PrepReqParams());
+                    prom = req.then(function (data) {
+                        return data.Items;
+                    });
+                    api.Cache.Set(GetListCacheKey(typeId), prom, exports.Api.DEFAULT_CACHE_DURATION);
+                    return [2 /*return*/, prom];
+                });
+            });
+        }
+        CustomForm.GetList = GetList;
+        function Update(api, data) {
+            return __awaiter(this, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            if (!data.ID) {
+                                data.ID = 0;
+                            }
+                            return [4 /*yield*/, api.POST("customForm/" + data.ID, data, exports.Api.PrepReqParams())];
+                        case 1:
+                            data = _a.sent();
+                            api.Cache.RemoveByStartsWith(exports.Api.ECacheKey.CustomForm);
+                            return [2 /*return*/, data];
+                    }
+                });
+            });
+        }
+        CustomForm.Update = Update;
+    })(exports.CustomForm || (exports.CustomForm = {}));
+
     var CacheItem = /** @class */ (function () {
         function CacheItem(id, data, duration) {
             this.Id = id;
@@ -230,6 +340,9 @@
         };
         return CacheItem;
     }());
+    /**
+     * Simple local cache controller.
+     */
     var CacheControl = /** @class */ (function () {
         function CacheControl() {
             this.data = {};
@@ -318,6 +431,9 @@
             });
         });
     }
+    /**
+     * This is a base class for communication with an arbitrary Bruce Api.
+     */
     var AbstractApi = /** @class */ (function () {
         function AbstractApi(ssidHeader) {
             this.ssid = "";
@@ -472,6 +588,10 @@
         return AbstractApi;
     }());
 
+    /**
+     * This is the request handler for Bruce Api,
+     * it should be passed to any method that wants to communicate with this particular api.
+     */
     var BruceApi = /** @class */ (function (_super) {
         __extends(BruceApi, _super);
         function BruceApi(accountId, env) {
@@ -507,6 +627,12 @@
         BruceApi.prototype.GetBaseUrl = function () {
             return this.baseUrl;
         };
+        BruceApi.prototype.SetBaseUrl = function (url) {
+            this.baseUrl = url;
+            if (!this.baseUrl.endsWith("/")) {
+                this.baseUrl += "/";
+            }
+        };
         BruceApi.prototype.GET = function (url, params) {
             return __awaiter(this, void 0, void 0, function () {
                 return __generator(this, function (_a) {
@@ -538,6 +664,10 @@
         return BruceApi;
     }(AbstractApi));
 
+    /**
+     * This is the request handler for Cam Api,
+     * it should be passed to any method that wants to communicate with this particular api.
+     */
     var CamApi = /** @class */ (function (_super) {
         __extends(CamApi, _super);
         function CamApi(env) {
@@ -572,6 +702,12 @@
         CamApi.prototype.GetBaseUrl = function () {
             return this.baseUrl;
         };
+        CamApi.prototype.SetBaseUrl = function (url) {
+            this.baseUrl = url;
+            if (!this.baseUrl.endsWith("/")) {
+                this.baseUrl += "/";
+            }
+        };
         CamApi.prototype.GET = function (url, params) {
             return __awaiter(this, void 0, void 0, function () {
                 return __generator(this, function (_a) {
@@ -603,6 +739,10 @@
         return CamApi;
     }(AbstractApi));
 
+    /**
+     * This is the request handler for Idm Api,
+     * it should be passed to any method that wants to communicate with this particular api.
+     */
     var IdmApi = /** @class */ (function (_super) {
         __extends(IdmApi, _super);
         function IdmApi(env) {
@@ -637,6 +777,12 @@
         IdmApi.prototype.GetBaseUrl = function () {
             return this.baseUrl;
         };
+        IdmApi.prototype.SetBaseUrl = function (url) {
+            this.baseUrl = url;
+            if (!this.baseUrl.endsWith("/")) {
+                this.baseUrl += "/";
+            }
+        };
         IdmApi.prototype.GET = function (url, params) {
             return __awaiter(this, void 0, void 0, function () {
                 return __generator(this, function (_a) {
@@ -687,6 +833,11 @@
             return ColorFromStr(str);
         }
         Color.RandomColor = RandomColor;
+        /**
+         * Attempts to parse a given color string into a model.
+         * @param str
+         * @returns
+         */
         function ColorFromStr(str) {
             var r, g, b, a;
             var rgba = /^rgba?\(\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)\s*(?:,\s*([^\)]+)\s*)?\)$/.exec(str);
@@ -747,6 +898,10 @@
     })(exports.Color || (exports.Color = {}));
 
     (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);
@@ -756,6 +911,9 @@
         ObjectUtils.UId = UId;
     })(exports.ObjectUtils || (exports.ObjectUtils = {}));
 
+    /**
+     * Utility to help with parsing and wrapping Bruce paths.
+     */
     (function (PathUtils) {
         function Parse(str) {
             if (!str) {
@@ -1090,8 +1248,21 @@
         }
         return null;
     }
+    /**
+     * Utilities for parsing "Bruce variables", typically within strings.
+     *
+     * A Bruce variable is a string that starts with "${" and ends with "}".
+     * Within those brackets is a path to an attribute in an entity.
+     */
     var BruceVariable;
     (function (BruceVariable) {
+        /**
+         * Replaces all Bruce variables in a string with the value of the attribute.
+         * @param str
+         * @param data
+         * @param legacyParse
+         * @returns
+         */
         function SwapValues(str, data, legacyParse) {
             if (!legacyParse) {
                 legacyParse = false;
@@ -1125,6 +1296,14 @@
             EValueType[EValueType["TagColor"] = 4] = "TagColor";
             EValueType[EValueType["RandomColor"] = 5] = "RandomColor";
         })(EValueType = Calculator.EValueType || (Calculator.EValueType = {}));
+        /**
+         * Calculates the value of arbitrary field options.
+         * The context calling this should validate results and parse stuff if needed.
+         * @param fields
+         * @param entity
+         * @param tags
+         * @returns
+         */
         function GetValue(fields, entity, tags) {
             if (!tags) {
                 tags = [];
@@ -1246,6 +1425,10 @@
         Calculator.GetInputValue = GetInputValue;
     })(exports.Calculator || (exports.Calculator = {}));
 
+    /**
+     * Simple event utility.
+     * Instantiate the model, then subscribe and trigger events.
+     */
     var BruceEvent = /** @class */ (function () {
         function BruceEvent() {
             // Counter to help differentiate subscriptions.
@@ -1295,6 +1478,12 @@
         })(EFrustum = Camera.EFrustum || (Camera.EFrustum = {}));
     })(exports.Camera || (exports.Camera = {}));
 
+    /**
+     * Describes 2d and 3d coordinates.
+     *
+     * In 2d the x/y typically refers to a window left/top offset.
+     * In 3d the x/y/z, the units are in meters.
+     */
     (function (Cartes) {
         function ValidateCartes2(cartes) {
             if (!cartes) {
@@ -1341,6 +1530,11 @@
         Cartes.IsEqualCartes3 = IsEqualCartes3;
     })(exports.Cartes || (exports.Cartes = {}));
 
+    /**
+     * Describes a geographic point.
+     * The units of the stored data should be in Degrees.
+     * Utilities may use this in Radians for temporary calculations.
+     */
     (function (Carto) {
         function ValidateCarto(carto) {
             if (!carto) {
@@ -1393,6 +1587,10 @@
         Carto.GetCenter = GetCenter;
     })(exports.Carto || (exports.Carto = {}));
 
+    /**
+     * Controls the flow of method calls.
+     * If you have a method that may be called often, but you don't want it to run often, use this.
+     */
     var DelayQueue = /** @class */ (function () {
         function DelayQueue(callback, delay) {
             if (delay === void 0) { delay = 200; }
@@ -1446,12 +1644,21 @@
         return DelayQueue;
     }());
 
+    /**
+     * Describes vector geometry that Bruce uses.
+     */
     (function (Geometry) {
         var EPolygonRingType;
         (function (EPolygonRingType) {
             EPolygonRingType["Boundaries"] = "out";
             EPolygonRingType["Hole"] = "in";
         })(EPolygonRingType = Geometry.EPolygonRingType || (Geometry.EPolygonRingType = {}));
+        /**
+         * Turns an array of points into string vector geometry that Bruce can use.
+         * This is used for saving polyline and polygon data.
+         * @param points
+         * @returns
+         */
         function LineStrFromPoints(points) {
             if (!points.length) {
                 throw ("points is empty.");
@@ -1465,6 +1672,12 @@
             return lineString;
         }
         Geometry.LineStrFromPoints = LineStrFromPoints;
+        /**
+         * Removes same points that occur in a row.
+         * This will not modify the original array.
+         * @param positions
+         * @returns
+         */
         function RemoveRepeatPoints(positions) {
             var filteredList = [];
             for (var i = 0; i < positions.length; i++) {
@@ -1512,6 +1725,12 @@
             return result;
         }
         Geometry.ParsePoints = ParsePoints;
+        /**
+         * Parses both string and object Bruce geometry.
+         * String geometry is legacy Bruce data.
+         * @param geometry
+         * @returns
+         */
         function ParseGeometry(geometry) {
             if (typeof geometry == "string") {
                 var positions = [];
@@ -1542,6 +1761,9 @@
         Geometry.ParseGeometry = ParseGeometry;
     })(exports.Geometry || (exports.Geometry = {}));
 
+    /**
+     * Describes a Bruce stored date.
+     */
     (function (UTC) {
         var EMonth;
         (function (EMonth) {
@@ -1588,9 +1810,6 @@
         (function (EType) {
             EType["Photo"] = "photo";
             EType["Document"] = "document";
-            EType["Video"] = "video";
-            EType["Drawing"] = "drawing";
-            EType["Model"] = "model";
         })(EType = EntityAttachmentType.EType || (EntityAttachmentType.EType = {}));
         function Delete(api, id) {
             return __awaiter(this, void 0, void 0, function () {
@@ -3436,6 +3655,10 @@
         ProgramKey.Update = Update;
     })(exports.ProgramKey || (exports.ProgramKey = {}));
 
+    /**
+     * Describes an expectation on what should be rendered for a menu item-
+     * between a min-max distance of an entity to the camera.
+     */
     (function (ZoomControl) {
         var EDisplayType;
         (function (EDisplayType) {
@@ -4265,6 +4488,11 @@
         Style.Delete = Delete;
     })(exports.Style || (exports.Style = {}));
 
+    /**
+     * Describes expected settings for an entities-map tileset.
+     * This is the kind of tileset generated from arbitrary Bruce entities-
+     * which produced map tiles of the entity vector geometry.
+     */
     (function (TilesetEntitiesMapTiles) {
         var ETileSize;
         (function (ETileSize) {
@@ -4275,6 +4503,10 @@
         })(ETileSize = TilesetEntitiesMapTiles.ETileSize || (TilesetEntitiesMapTiles.ETileSize = {}));
     })(exports.TilesetEntitiesMapTiles || (exports.TilesetEntitiesMapTiles = {}));
 
+    /**
+     * Describes settings for an external map-tiles tileset.
+     * This will serve content from elsewhere with the assumption that the data is valid map tiles.
+     */
     (function (TilesetExtMapTiles) {
         var EType;
         (function (EType) {
@@ -4802,6 +5034,12 @@
     })(exports.EncryptUtils || (exports.EncryptUtils = {}));
 
     (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) {
@@ -4815,6 +5053,12 @@
             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;
@@ -4827,6 +5071,9 @@
         MathUtils.RandInt = RandInt;
     })(exports.MathUtils || (exports.MathUtils = {}));
 
+    /**
+     * Utility to help with url manipulation.
+     */
     (function (UrlUtils) {
         function GetQueryString(doc) {
             var qs = {};
@@ -4844,6 +5091,9 @@
             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;