bruce-models 0.1.6 → 0.1.7

package/dist/bruce-models.es5.js

@@ -75,6 +75,9 @@ function __generator(thisArg, body) {
     }
 }
 
+/**
+ * Contains generic descriptions used for Bruce requests.
+ */
 var Api;
 (function (Api) {
     var ECacheKey;
@@ -106,10 +109,27 @@ var Api;
         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"));
     }
@@ -125,19 +145,21 @@ var Api;
         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 } };
     }
     Api.PrepReqParams = PrepReqParams;
 })(Api || (Api = {}));
 
+/**
+ * Describes communication with the "Annotated Document" concept in Bruce.
+ * Annotated documents are files with hotspots that can link to Entity records.
+ */
 var AnnDocument;
 (function (AnnDocument) {
     function GetCacheKey(id) {
@@ -211,6 +233,103 @@ var AnnDocument;
     AnnDocument.GetList = GetList;
 })(AnnDocument || (AnnDocument = {}));
 
+/**
+ * Describes the "Custom Form" concept within Bruce.
+ * Custom forms are dynamic dialogs that get populated with Entity data.
+ */
+var CustomForm;
+(function (CustomForm) {
+    function GetCacheKey(id) {
+        return Api.ECacheKey.CustomForm + Api.ECacheKey.Id + id;
+    }
+    CustomForm.GetCacheKey = GetCacheKey;
+    function GetListCacheKey(typeId) {
+        if (typeId) {
+            return Api.ECacheKey.CustomForm + Api.ECacheKey.EntityType + Api.ECacheKey.Id + typeId;
+        }
+        return 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, Api.PrepReqParams());
+                api.Cache.Set(GetCacheKey(id), req, 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, Api.PrepReqParams())];
+                    case 1:
+                        _a.sent();
+                        api.Cache.RemoveByStartsWith(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, Api.PrepReqParams());
+                prom = req.then(function (data) {
+                    return data.Items;
+                });
+                api.Cache.Set(GetListCacheKey(typeId), prom, 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, Api.PrepReqParams())];
+                    case 1:
+                        data = _a.sent();
+                        api.Cache.RemoveByStartsWith(Api.ECacheKey.CustomForm);
+                        return [2 /*return*/, data];
+                }
+            });
+        });
+    }
+    CustomForm.Update = Update;
+})(CustomForm || (CustomForm = {}));
+
 var CacheItem = /** @class */ (function () {
     function CacheItem(id, data, duration) {
         this.Id = id;
@@ -226,6 +345,9 @@ var CacheItem = /** @class */ (function () {
     };
     return CacheItem;
 }());
+/**
+ * Simple local cache controller.
+ */
 var CacheControl = /** @class */ (function () {
     function CacheControl() {
         this.data = {};
@@ -314,6 +436,9 @@ function parseResult(data, encoding) {
         });
     });
 }
+/**
+ * This is a base class for communication with an arbitrary Bruce Api.
+ */
 var AbstractApi = /** @class */ (function () {
     function AbstractApi(ssidHeader) {
         this.ssid = "";
@@ -468,6 +593,10 @@ var AbstractApi = /** @class */ (function () {
     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) {
@@ -503,6 +632,12 @@ var BruceApi = /** @class */ (function (_super) {
     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) {
@@ -534,6 +669,10 @@ var BruceApi = /** @class */ (function (_super) {
     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) {
@@ -568,6 +707,12 @@ var CamApi = /** @class */ (function (_super) {
     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) {
@@ -599,6 +744,10 @@ var CamApi = /** @class */ (function (_super) {
     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) {
@@ -633,6 +782,12 @@ var IdmApi = /** @class */ (function (_super) {
     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) {
@@ -684,6 +839,11 @@ var Color;
         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);
@@ -745,6 +905,10 @@ var Color;
 
 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);
@@ -754,6 +918,9 @@ var ObjectUtils;
     ObjectUtils.UId = UId;
 })(ObjectUtils || (ObjectUtils = {}));
 
+/**
+ * Utility to help with parsing and wrapping Bruce paths.
+ */
 var PathUtils;
 (function (PathUtils) {
     function Parse(str) {
@@ -810,6 +977,11 @@ var PathUtils;
     PathUtils.ParseLegacy = ParseLegacy;
 })(PathUtils || (PathUtils = {}));
 
+/**
+ * Describes the "Entity" concept within Bruce.
+ * An entity is a JSON blob containing both internal data and user-defined data.
+ * Entity records have many thinks linked to them through their UIDs such as links, files and relationships.
+ */
 var Entity;
 (function (Entity) {
     function GetCacheKey(entityId) {
@@ -1090,8 +1262,21 @@ function getVariable(str) {
     }
     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;
@@ -1115,6 +1300,10 @@ var BruceVariable;
     BruceVariable.SwapValues = SwapValues;
 })(BruceVariable || (BruceVariable = {}));
 
+/**
+ * Utility for calculating values from Bruce fields.
+ * These fields are typically found in entity styles.
+ */
 var Calculator;
 (function (Calculator) {
     var EValueType;
@@ -1126,6 +1315,14 @@ var Calculator;
         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 = [];
@@ -1247,6 +1444,10 @@ var Calculator;
     Calculator.GetInputValue = GetInputValue;
 })(Calculator || (Calculator = {}));
 
+/**
+ * Simple event utility.
+ * Instantiate the model, then subscribe and trigger events.
+ */
 var BruceEvent = /** @class */ (function () {
     function BruceEvent() {
         // Counter to help differentiate subscriptions.
@@ -1297,6 +1498,12 @@ var Camera;
     })(EFrustum = Camera.EFrustum || (Camera.EFrustum = {}));
 })(Camera || (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.
+ */
 var Cartes;
 (function (Cartes) {
     function ValidateCartes2(cartes) {
@@ -1344,6 +1551,11 @@ var Cartes;
     Cartes.IsEqualCartes3 = IsEqualCartes3;
 })(Cartes || (Cartes = {}));
 
+/**
+ * Describes a geographic point.
+ * The units of the stored data should be in Degrees.
+ * Utilities may use this in Radians for temporary calculations.
+ */
 var Carto;
 (function (Carto) {
     function ValidateCarto(carto) {
@@ -1397,6 +1609,10 @@ var Carto;
     Carto.GetCenter = GetCenter;
 })(Carto || (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; }
@@ -1450,6 +1666,9 @@ var DelayQueue = /** @class */ (function () {
     return DelayQueue;
 }());
 
+/**
+ * Describes vector geometry that Bruce uses.
+ */
 var Geometry;
 (function (Geometry) {
     var EPolygonRingType;
@@ -1457,6 +1676,12 @@ var Geometry;
         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.");
@@ -1470,6 +1695,12 @@ var Geometry;
         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++) {
@@ -1517,6 +1748,12 @@ var Geometry;
         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 = [];
@@ -1547,6 +1784,9 @@ var Geometry;
     Geometry.ParseGeometry = ParseGeometry;
 })(Geometry || (Geometry = {}));
 
+/**
+ * Describes a Bruce stored date.
+ */
 var UTC;
 (function (UTC) {
     var EMonth;
@@ -1581,6 +1821,10 @@ var UTC;
     UTC.FromDate = FromDate;
 })(UTC || (UTC = {}));
 
+/**
+ * Describes the "Entity Attachment Type" concept within Bruce.
+ * It is a record that describes the purpose of an attachment.
+ */
 var EntityAttachmentType;
 (function (EntityAttachmentType) {
     function GetCacheKey(id) {
@@ -1595,9 +1839,6 @@ var EntityAttachmentType;
     (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 () {
@@ -1673,6 +1914,11 @@ var EntityAttachmentType;
     EntityAttachmentType.GetList = GetList;
 })(EntityAttachmentType || (EntityAttachmentType = {}));
 
+/**
+ * Describes the "Entity Attachment" concept within Bruce.
+ * An entity attachment is an arbitrary file record that is linked to an entity record.
+ * The same file can be attached to multiple entities.
+ */
 var EntityAttachment;
 (function (EntityAttachment) {
     function GetCacheKey(entityId, typeId, fileId) {
@@ -1837,6 +2083,10 @@ var EntityAttachment;
     EntityAttachment.Upload = Upload;
 })(EntityAttachment || (EntityAttachment = {}));
 
+/**
+ * Describes the "Entity Comment" concept within Bruce.
+ * An entity comment is a user written message that is linked to an entity record.
+ */
 var EntityComment;
 (function (EntityComment) {
     function GetCacheKey(id) {
@@ -1926,6 +2176,10 @@ var EntityComment;
     EntityComment.GetListByEntityId = GetListByEntityId;
 })(EntityComment || (EntityComment = {}));
 
+/**
+ * Describes the "Entity Link" concept within Bruce.
+ * An entity link is a URL linked to an entity record.
+ */
 var EntityLink;
 (function (EntityLink) {
     function GetCacheKey(id) {
@@ -2015,6 +2269,12 @@ var EntityLink;
     EntityLink.GetListByEntityId = GetListByEntityId;
 })(EntityLink || (EntityLink = {}));
 
+/**
+ * Describes the "Entity LOD" concept within Bruce.
+ * LOD stands for Level of Detail.
+ * An lod record is a possible 2d/3d visualization of the entity record.
+ * The most common kind is a GLB.
+ */
 var EntityLod;
 (function (EntityLod) {
     function GetCacheKey(url) {
@@ -2096,6 +2356,10 @@ var EntityLod;
     EntityLod.GetLods = GetLods;
 })(EntityLod || (EntityLod = {}));
 
+/**
+ * Describes the "Entity Relationship Type" concept within Bruce.
+ * A relationship type record describes the purpose of a relationship.
+ */
 var EntityRelationType;
 (function (EntityRelationType) {
     function GetCacheKey(id) {
@@ -2202,6 +2466,11 @@ var EntityRelationType;
     EntityRelationType.Update = Update;
 })(EntityRelationType || (EntityRelationType = {}));
 
+/**
+ * Describes the "Entity Relationship" concept within Bruce.
+ * An entity relationship is an arbitrary link between two entity records.
+ * The relationship can have a "data entity" linked to it as well for the relationship to store arbitrary data about itself.
+ */
 var EntityRelation;
 (function (EntityRelation) {
     function GetCacheKey(entityA, entityB, typeId) {
@@ -2304,6 +2573,11 @@ var EntityRelation;
     EntityRelation.GetByDataEntityId = GetByDataEntityId;
 })(EntityRelation || (EntityRelation = {}));
 
+/**
+ * Describes the "Entity Source" concept within Bruce.
+ * An entity source is a record which links an arbitrary source id to a Bruce entity id.
+ * For example an OSM building id to a Bruce entity id.
+ */
 var EntitySource;
 (function (EntitySource) {
     function GetCacheKey(sourceId, sourceKey) {
@@ -2436,6 +2710,11 @@ var EntitySource;
     EntitySource.GetEntityIdsBySourceKeys = GetEntityIdsBySourceKeys;
 })(EntitySource || (EntitySource = {}));
 
+/**
+ * Describes the "Entity Tag" concept within Bruce.
+ * An entity tag is used to categorize an entity record.
+ * Entity tags can be used in filters, or to restrict entity access.
+ */
 var EntityTag;
 (function (EntityTag) {
     function GetCacheKey(tagId) {
@@ -2621,6 +2900,11 @@ var EntityTag;
     EntityTag.Update = Update;
 })(EntityTag || (EntityTag = {}));
 
+/**
+ * Describes the "Entity Type" concept within Bruce.
+ * An entity type is an "expectation" of what data "should" look like in a particular entity record.
+ * The schema is stencils onto entity data to filter out what we should display or search against.
+ */
 var EntityType;
 (function (EntityType) {
     function GetCacheKey(typeId) {
@@ -2831,6 +3115,11 @@ function getOrCreateCell(cells, cellSize, lon, maxLon, lat, maxLat) {
     }
     return cell;
 }
+/**
+ * This is a helper for making entity requests based on a grid area.
+ * It will return grid cells based on given view-area then will remember when stuff-
+ * was fully-fetched for those cells to avoid making duplicate requests.
+ */
 var EntityGlobe;
 (function (EntityGlobe) {
     var Grid = /** @class */ (function () {
@@ -2890,6 +3179,11 @@ function delay(milliseconds) {
         });
     });
 }
+/**
+ * This is a batched entity getter.
+ * It will scan for entity records in a view-area and emit them in batches.
+ * It will restart scanning if the camera moves.
+ */
 var EntityFilterGetter;
 (function (EntityFilterGetter) {
     var EStatus;
@@ -3165,6 +3459,10 @@ var EntityFilterGetter;
 
 var MAX_AREA_IN_DEGREES$1 = 90;
 var GETTER_DELAY = 50;
+/**
+ * This is a batched "arbitrary data" getter.
+ * You feed it an array of data, then it will emit that data in batches when the view changes.
+ */
 var BatchedDataGetter;
 (function (BatchedDataGetter) {
     var Getter = /** @class */ (function () {
@@ -3236,6 +3534,10 @@ var BatchedDataGetter;
     BatchedDataGetter.Getter = Getter;
 })(BatchedDataGetter || (BatchedDataGetter = {}));
 
+/**
+ * Describes the "Client File" concept within Bruce.
+ * A client file is a record of a file uploaded to Bruce.
+ */
 var ClientFile;
 (function (ClientFile) {
     function GetCacheKey(fileId) {
@@ -3348,6 +3650,10 @@ var ClientFile;
     })(Filter = ClientFile.Filter || (ClientFile.Filter = {}));
 })(ClientFile || (ClientFile = {}));
 
+/**
+ * Describes the "Program Key" concept within Bruce.
+ * A program key is an access token for an arbitrary software.
+ */
 var ProgramKey;
 (function (ProgramKey) {
     function GetCacheKey(programId) {
@@ -3457,6 +3763,10 @@ var ProgramKey;
     ProgramKey.Update = Update;
 })(ProgramKey || (ProgramKey = {}));
 
+/**
+ * Describes an expectation on what should be rendered for a menu item-
+ * between a min-max distance of an entity to the camera.
+ */
 var ZoomControl;
 (function (ZoomControl) {
     var EDisplayType;
@@ -3468,6 +3778,16 @@ var ZoomControl;
     })(EDisplayType = ZoomControl.EDisplayType || (ZoomControl.EDisplayType = {}));
 })(ZoomControl || (ZoomControl = {}));
 
+/**
+ * Describes the "Tileset" concept in Bruce.
+ *
+ * Tilesets come in three possible variants,
+ * 1- A set of instructions to generate a tileset.
+ * 2- Settings to load a tileset hosted elsewhere.
+ * 3- A set of user-provided files to serve.
+ *
+ * Read the individual tileset-type settings for each variant.
+ */
 var Tileset;
 (function (Tileset) {
     function GetCacheKey(tilesetId, loadFiles) {
@@ -3805,6 +4125,11 @@ var Tileset;
     })(Publish = Tileset.Publish || (Tileset.Publish = {}));
 })(Tileset || (Tileset = {}));
 
+/**
+ * Describes a menu item found in project views.
+ * Menu items are used to dictate what data to load in a scene.
+ * A menu item may be a container for other items.
+ */
 var MenuItem;
 (function (MenuItem) {
     var EType;
@@ -3910,6 +4235,12 @@ var MenuItem;
     MenuItem.CreateFromTilesetId = CreateFromTilesetId;
 })(MenuItem || (MenuItem = {}));
 
+/**
+ * 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.
+ */
 var ProjectViewBookmark;
 (function (ProjectViewBookmark) {
     function GetCacheKey(viewId, bookmarkId) {
@@ -4019,6 +4350,11 @@ var ProjectViewBookmark;
     ProjectViewBookmark.Update = Update;
 })(ProjectViewBookmark || (ProjectViewBookmark = {}));
 
+/**
+ * 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.
+ */
 var ProjectView;
 (function (ProjectView) {
     function GetCacheKey(viewId) {
@@ -4125,6 +4461,11 @@ var ProjectView;
     ProjectView.Update = Update;
 })(ProjectView || (ProjectView = {}));
 
+/**
+ * Describes the "Pending Action" concept within Bruce.
+ * A pending action is a record of a server-side background process.
+ * This record is used to monitor its progress and completion state.
+ */
 var PendingAction;
 (function (PendingAction) {
     var EStatus;
@@ -4187,6 +4528,13 @@ var PendingAction;
     PendingAction.GetMessages = GetMessages;
 })(PendingAction || (PendingAction = {}));
 
+/**
+ * Describes the "Style" concept within Bruce.
+ * A legacy way of referring to styles is "entity display settings".
+ *
+ * A style is a collection of settings (which can be calculations to perform on entity data) that
+ * describe how an entity should be displayed.
+ */
 var Style;
 (function (Style) {
     function GetCacheKey(id) {
@@ -4293,6 +4641,11 @@ var Style;
     Style.Delete = Delete;
 })(Style || (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.
+ */
 var TilesetEntitiesMapTiles;
 (function (TilesetEntitiesMapTiles) {
     var ETileSize;
@@ -4304,6 +4657,10 @@ var TilesetEntitiesMapTiles;
     })(ETileSize = TilesetEntitiesMapTiles.ETileSize || (TilesetEntitiesMapTiles.ETileSize = {}));
 })(TilesetEntitiesMapTiles || (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.
+ */
 var TilesetExtMapTiles;
 (function (TilesetExtMapTiles) {
     var EType;
@@ -4315,6 +4672,11 @@ var TilesetExtMapTiles;
     })(EType = TilesetExtMapTiles.EType || (TilesetExtMapTiles.EType = {}));
 })(TilesetExtMapTiles || (TilesetExtMapTiles = {}));
 
+/**
+ * Describes the "UCS" concept within Bruce.
+ * A UCS is a user-coordinate-system.
+ * It is a description of an offset to apply to tilesets so that they can all align with each other.
+ */
 var Ucs;
 (function (Ucs) {
     function GetCacheKey(id, expandUsage) {
@@ -4424,6 +4786,11 @@ var Permission;
     })(EPermPrefix = Permission.EPermPrefix || (Permission.EPermPrefix = {}));
 })(Permission || (Permission = {}));
 
+/**
+ * Describes the "Session" concept within Bruce.
+ * A session is a set of settings produced from a user or access token login.
+ * The session describes what the access should be allowed to do.
+ */
 var Session;
 (function (Session) {
     function GetCacheKey(sessionId) {
@@ -4523,6 +4890,10 @@ var Session;
     Session.IsSuperAdmin = IsSuperAdmin;
 })(Session || (Session = {}));
 
+/**
+ * Describes the "User Group" concept within Bruce.
+ * A user group is a collection of permissions ("Features") and what users should be in the group.
+ */
 var UserGroup;
 (function (UserGroup) {
     function GetByName(api, accountId, name) {
@@ -4620,6 +4991,13 @@ var UserGroup;
     UserGroup.Update = Update;
 })(UserGroup || (UserGroup = {}));
 
+/**
+ * Describes the "User" concept within Bruce.
+ * A user is either a login-user or an access-token.
+ *
+ * You cannot login using an access-token, but both concepts are-
+ * treated the same way in terms of permissions and user groups.
+ */
 var User;
 (function (User) {
     function GetCacheKey(userId, accountId) {
@@ -4839,6 +5217,12 @@ var EncryptUtils;
 
 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) {
@@ -4852,6 +5236,12 @@ var MathUtils;
         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;
@@ -4864,6 +5254,9 @@ var MathUtils;
     MathUtils.RandInt = RandInt;
 })(MathUtils || (MathUtils = {}));
 
+/**
+ * Utility to help with url manipulation.
+ */
 var UrlUtils;
 (function (UrlUtils) {
     function GetQueryString(doc) {
@@ -4882,6 +5275,9 @@ var UrlUtils;
         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;
@@ -4963,5 +5359,5 @@ var UrlUtils;
     UrlUtils.Handler = Handler;
 })(UrlUtils || (UrlUtils = {}));
 
-export { AnnDocument, AbstractApi, Api, BruceApi, CamApi, IdmApi, Calculator, BruceEvent, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, Geometry, UTC, EntityAttachmentType, EntityAttachment, EntityComment, EntityLink, EntityLod, EntityRelationType, EntityRelation, EntitySource, EntityTag, EntityType, Entity, EntityGlobe, EntityFilterGetter, BatchedDataGetter, ClientFile, ProgramKey, ZoomControl, MenuItem, ProjectViewBookmark, ProjectView, PendingAction, Style, TilesetEntitiesMapTiles, TilesetExtMapTiles, Tileset, Ucs, Permission, Session, UserGroup, User, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils };
+export { AnnDocument, CustomForm, AbstractApi, Api, BruceApi, CamApi, IdmApi, Calculator, BruceEvent, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, Geometry, UTC, EntityAttachmentType, EntityAttachment, EntityComment, EntityLink, EntityLod, EntityRelationType, EntityRelation, EntitySource, EntityTag, EntityType, Entity, EntityGlobe, EntityFilterGetter, BatchedDataGetter, ClientFile, ProgramKey, ZoomControl, MenuItem, ProjectViewBookmark, ProjectView, PendingAction, Style, TilesetEntitiesMapTiles, TilesetExtMapTiles, Tileset, Ucs, Permission, Session, UserGroup, User, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils };
 //# sourceMappingURL=bruce-models.es5.js.map