bruce-models 0.7.4 → 0.7.6

package/dist/bruce-models.umd.js

@@ -907,22 +907,30 @@
          */
         var Api$$1 = /** @class */ (function (_super) {
             __extends(Api$$1, _super);
-            function Api$$1(accountId, env) {
+            /**
+             * @param accountId
+             * @param env (Optional) environment to use, this will default to PROD.
+             * @param cam (Optional) cam instance to use for loading the regional base url.
+             */
+            function Api$$1(accountId, env, cam) {
                 var _this = _super.call(this, "x-sessionid") || this;
                 _this.baseUrl = "";
+                _this.loadCancelled = false;
                 _this.accountId = accountId;
                 _this.env = env !== null && env !== void 0 ? env : exports.Api.EEnv.PROD;
-                _this.loadProm = _this.setBaseUrl();
+                _this.loadProm = _this.setBaseUrl(cam);
                 return _this;
             }
             Object.defineProperty(Api$$1.prototype, "Loading", {
+                // Indicates if the init process has finished loading.
+                // This means the regional base url has been set.
                 get: function () {
                     return this.loadProm;
                 },
                 enumerable: false,
                 configurable: true
             });
-            Api$$1.prototype.setBaseUrl = function () {
+            Api$$1.prototype.setBaseUrl = function (cam) {
                 var _a;
                 return __awaiter(this, void 0, void 0, function () {
                     var prefix, url, env, camApi, settings, endpoint, e_1;
@@ -951,10 +959,14 @@
                                 _b.label = 1;
                             case 1:
                                 _b.trys.push([1, 3, , 4]);
-                                camApi = new exports.CamApi.Api(env);
+                                camApi = cam ? cam : new exports.CamApi.Api(env);
                                 return [4 /*yield*/, exports.Account.GetAppSettings(camApi, this.accountId, exports.Account.EAppId.BruceApi)];
                             case 2:
                                 settings = _b.sent();
+                                if (this.loadCancelled) {
+                                    console.warn("BruceApi: Loading was cancelled due to SetBaseUrl being called, not setting regional base url.");
+                                    return [2 /*return*/];
+                                }
                                 endpoint = (_a = settings.BruceAPIURL) === null || _a === void 0 ? void 0 : _a[env];
                                 if (typeof endpoint == "string") {
                                     if (!endpoint.endsWith("/")) {
@@ -972,14 +984,28 @@
                     });
                 });
             };
+            /**
+             * Warning: This method does not wait for init to finish loading.
+             * This means the url could be changed once fully initialized.
+             * The url will be valid either way, but the loaded one may be faster as it is region specific.
+             * Await the "Loading" promise if you care about this.
+             * @returns
+             */
             Api$$1.prototype.GetBaseUrl = function () {
                 return this.baseUrl;
             };
+            /**
+             * Warning: This will cancel the init process.
+             * The init process loads a region specific endpoint.
+             * Setting a base url will stop that process from completing.
+             * @param url
+             */
             Api$$1.prototype.SetBaseUrl = function (url) {
                 this.baseUrl = url;
                 if (!this.baseUrl.endsWith("/")) {
                     this.baseUrl += "/";
                 }
+                this.loadCancelled = true;
             };
             Api$$1.prototype.GET = function (url, params) {
                 return __awaiter(this, void 0, void 0, function () {
@@ -1566,7 +1592,16 @@
             return null;
         }
         Entity.GetValue = GetValue;
-        function CalculateName(entity, type) {
+        /**
+         * Calculates an entity's name based on attribute priority set in the type.
+         * @param entity
+         * @param type
+         * @param defaultToId
+         * If true, will return the entity ID if no name can be calculated.
+         * Otherwise it returns null.
+         * @returns
+         */
+        function CalculateName(entity, type, defaultToId) {
             var attrStr = type.DisplayNameAttributePath;
             if (attrStr) {
                 var attrPaths = attrStr.split(",");
@@ -1579,7 +1614,7 @@
                     }
                 }
             }
-            return entity.Bruce.ID;
+            return defaultToId ? entity.Bruce.ID : null;
         }
         Entity.CalculateName = CalculateName;
         var Filter;
@@ -4861,6 +4896,17 @@
             return "" + exports.Api.ECacheKey.ProjectViewBookmark + exports.Api.ECacheKey.Id + viewId;
         }
         ProjectViewBookmark.GetListCacheKey = GetListCacheKey;
+        // This is the expected default version for the DataVersion value.
+        // This value should NOT be changed without looking at our API and seeing what the default value is.
+        ProjectViewBookmark.DEFAULT_DATA_VERSION = 1;
+        var V1;
+        (function (V1) {
+            V1.DATA_VERSION = 1;
+        })(V1 = ProjectViewBookmark.V1 || (ProjectViewBookmark.V1 = {}));
+        var V2;
+        (function (V2) {
+            V2.DATA_VERSION = 2;
+        })(V2 = ProjectViewBookmark.V2 || (ProjectViewBookmark.V2 = {}));
         function Get(api, viewId, bookmarkId) {
             return __awaiter(this, void 0, void 0, function () {
                 var key, cacheData, req;
@@ -4986,6 +5032,17 @@
             return exports.Api.ECacheKey.ProjectView;
         }
         ProjectView.GetListCacheKey = GetListCacheKey;
+        // This is the expected default version for the DataVersion value.
+        // This value should NOT be changed without looking at our API and seeing what the default value is.
+        ProjectView.DEFAULT_DATA_VERSION = 1;
+        var V1;
+        (function (V1) {
+            V1.DATA_VERSION = 1;
+        })(V1 = ProjectView.V1 || (ProjectView.V1 = {}));
+        var V2;
+        (function (V2) {
+            V2.DATA_VERSION = 2;
+        })(V2 = ProjectView.V2 || (ProjectView.V2 = {}));
         function Get(api, viewId) {
             return __awaiter(this, void 0, void 0, function () {
                 var key, cacheData, req;
@@ -5103,7 +5160,7 @@
             var view;
             return __generator(this, function (_b) {
                 switch (_b.label) {
-                    case 0: return [4 /*yield*/, exports.ProjectView.Get(apiGetter.getApi(exports.Api.TEMPLATE_ACCOUNT_ID, apiGetter.env), "default")];
+                    case 0: return [4 /*yield*/, exports.ProjectView.Get(apiGetter.getApi(exports.Api.TEMPLATE_ACCOUNT_ID), "default")];
                     case 1:
                         view = _b.sent();
                         return [2 /*return*/, (_a = view.Settings) !== null && _a !== void 0 ? _a : {}];
@@ -5123,7 +5180,7 @@
             items.push(templateItem);
         }
     }
-    (function (ProjectViewTileSource) {
+    (function (ProjectViewLegacyTile) {
         function MergeMapTemplateData(getter, items, addIfMissing) {
             var _a;
             return __awaiter(this, void 0, void 0, function () {
@@ -5143,7 +5200,7 @@
                 });
             });
         }
-        ProjectViewTileSource.MergeMapTemplateData = MergeMapTemplateData;
+        ProjectViewLegacyTile.MergeMapTemplateData = MergeMapTemplateData;
         function MergeTerrainTemplateData(getter, items, addIfMissing) {
             var _a;
             return __awaiter(this, void 0, void 0, function () {
@@ -5163,8 +5220,124 @@
                 });
             });
         }
-        ProjectViewTileSource.MergeTerrainTemplateData = MergeTerrainTemplateData;
-    })(exports.ProjectViewTileSource || (exports.ProjectViewTileSource = {}));
+        ProjectViewLegacyTile.MergeTerrainTemplateData = MergeTerrainTemplateData;
+    })(exports.ProjectViewLegacyTile || (exports.ProjectViewLegacyTile = {}));
+
+    (function (ProjectViewTile) {
+        var EDefaultImagery;
+        (function (EDefaultImagery) {
+            EDefaultImagery["BingMapsAerial"] = "bingmapsaerial";
+            EDefaultImagery["BingMapsAerialWithLabels"] = "bingmapsaerialwithlabels";
+            EDefaultImagery["BingMapsRoads"] = "bingmapsroads";
+            EDefaultImagery["MapboxSatellite"] = "mapboxsatellite";
+            EDefaultImagery["MapBoxStreets"] = "mapboxstreets";
+            EDefaultImagery["MapBoxStreetsClassic"] = "mapboxstreetsclassic";
+            EDefaultImagery["EsriWorldImagery"] = "esriworldimagery";
+            EDefaultImagery["EsriWorldStreetMap"] = "esriworldstreetmap";
+            EDefaultImagery["EsriNationalGeographic"] = "esrinationalgeographic";
+            EDefaultImagery["OpenStreetMap"] = "openstreetmap";
+            EDefaultImagery["StamenWaterColor"] = "stamenwatercolor";
+            EDefaultImagery["StamenToner"] = "stamentoner";
+            EDefaultImagery["Grid"] = "grid";
+        })(EDefaultImagery = ProjectViewTile.EDefaultImagery || (ProjectViewTile.EDefaultImagery = {}));
+        /**
+         * Prepared array for UI.
+         * TODO: Im not happy with icon urls sitting in the code. I'd prefer we ship these icons in the library as files.
+         */
+        ProjectViewTile.DefaultImagery = [
+            {
+                id: EDefaultImagery.BingMapsAerial,
+                name: "Bing Maps Aerial",
+                iconUrl: "https://template.ui.nextspace.host/Default/media/Cesium/ImageryProviders/bingAerial.png"
+            },
+            {
+                id: EDefaultImagery.BingMapsAerialWithLabels,
+                name: "Bing Maps Aerial with Labels",
+                iconUrl: "https://template.ui.nextspace.host/Default/media/Cesium/ImageryProviders/bingAerialLabels.png"
+            },
+            {
+                id: EDefaultImagery.BingMapsRoads,
+                name: "Bing Maps Roads",
+                iconUrl: "https://template.ui.nextspace.host/Default/media/Cesium/ImageryProviders/bingRoads.png"
+            },
+            {
+                id: EDefaultImagery.MapboxSatellite,
+                name: "Mapbox Satellite",
+                iconUrl: "https://template.ui.nextspace.host/Default/media/Cesium/ImageryProviders/mapboxSatellite.png"
+            },
+            {
+                id: EDefaultImagery.MapBoxStreets,
+                name: "Mapbox Streets",
+                iconUrl: "https://template.ui.nextspace.host/Default/media/Cesium/ImageryProviders/mapboxTerrain.png"
+            },
+            {
+                id: EDefaultImagery.MapBoxStreetsClassic,
+                name: "Mapbox Streets Classic",
+                iconUrl: "https://template.ui.nextspace.host/Default/media/Cesium/ImageryProviders/mapboxStreets.png"
+            },
+            {
+                id: EDefaultImagery.EsriWorldImagery,
+                name: "Esri World Imagery",
+                iconUrl: "https://template.ui.nextspace.host/Default/media/Cesium/ImageryProviders/esriWorldImagery.png"
+            },
+            {
+                id: EDefaultImagery.EsriWorldStreetMap,
+                name: "Esri World Street Map",
+                iconUrl: "https://template.ui.nextspace.host/Default/media/Cesium/ImageryProviders/esriWorldStreetMap.png"
+            },
+            {
+                id: EDefaultImagery.EsriNationalGeographic,
+                name: "Esri National Geographic",
+                iconUrl: "https://template.ui.nextspace.host/Default/media/Cesium/ImageryProviders/esriNationalGeographic.png"
+            },
+            {
+                id: EDefaultImagery.OpenStreetMap,
+                name: "Open Street Map",
+                iconUrl: "https://template.ui.nextspace.host/Default/media/Cesium/ImageryProviders/openStreetMap.png"
+            },
+            {
+                id: EDefaultImagery.StamenWaterColor,
+                name: "Stamen Water Color",
+                iconUrl: "https://template.ui.nextspace.host/Default/media/Cesium/ImageryProviders/stamenWatercolor.png"
+            },
+            {
+                id: EDefaultImagery.StamenToner,
+                name: "Stamen Toner",
+                iconUrl: "https://template.ui.nextspace.host/Default/media/Cesium/ImageryProviders/stamenToner.png"
+            },
+            {
+                id: EDefaultImagery.Grid,
+                name: "Grid",
+                iconUrl: "https://template.api.nextspace-uat.net/file/2885d8df-028b-4f5c-80b3-2634f7e7cf69.png"
+            }
+        ];
+        var EDefaultTerrain;
+        (function (EDefaultTerrain) {
+            EDefaultTerrain["CesiumWorldTerrain"] = "cesiumworldterrain";
+            EDefaultTerrain["FlatTerrain"] = "flatterrain";
+            EDefaultTerrain["LINZ"] = "linz";
+        })(EDefaultTerrain = ProjectViewTile.EDefaultTerrain || (ProjectViewTile.EDefaultTerrain = {}));
+        /**
+         * Prepared array for UI.
+         * TODO: Im not happy with icon urls sitting in the code. I'd prefer we ship these icons in the library as files.
+         */
+        ProjectViewTile.DefaultTerrains = [
+            {
+                id: EDefaultTerrain.CesiumWorldTerrain,
+                name: "Cesium World Terrain",
+                iconUrl: "https://template.ui.nextspace.host/Default/media/Cesium/TerrainProviders/CesiumWorldTerrain.png"
+            },
+            {
+                id: EDefaultTerrain.LINZ,
+                name: "LINZ",
+                iconUrl: "https://template.ui.nextspace.host/media/linz.jpg"
+            },
+            {
+                id: EDefaultTerrain.FlatTerrain,
+                name: "Flat Terrain",
+            }
+        ];
+    })(exports.ProjectViewTile || (exports.ProjectViewTile = {}));
 
     (function (PendingAction) {
         var EStatus;