bruce-models 0.7.4 → 0.7.6

package/dist/bruce-models.es5.js

@@ -923,22 +923,30 @@ var BruceApi;
      */
     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 : 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;
@@ -967,10 +975,14 @@ var BruceApi;
                             _b.label = 1;
                         case 1:
                             _b.trys.push([1, 3, , 4]);
-                            camApi = new CamApi.Api(env);
+                            camApi = cam ? cam : new CamApi.Api(env);
                             return [4 /*yield*/, Account.GetAppSettings(camApi, this.accountId, 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("/")) {
@@ -988,14 +1000,28 @@ var BruceApi;
                 });
             });
         };
+        /**
+         * 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 () {
@@ -1593,7 +1619,16 @@ var Entity;
         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(",");
@@ -1606,7 +1641,7 @@ var Entity;
                 }
             }
         }
-        return entity.Bruce.ID;
+        return defaultToId ? entity.Bruce.ID : null;
     }
     Entity.CalculateName = CalculateName;
     var Filter;
@@ -5009,6 +5044,17 @@ var ProjectViewBookmark;
         return "" + Api.ECacheKey.ProjectViewBookmark + 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;
@@ -5140,6 +5186,17 @@ var ProjectView;
         return 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;
@@ -5257,7 +5314,7 @@ function getTemplateSettings(apiGetter) {
         var view;
         return __generator(this, function (_b) {
             switch (_b.label) {
-                case 0: return [4 /*yield*/, ProjectView.Get(apiGetter.getApi(Api.TEMPLATE_ACCOUNT_ID, apiGetter.env), "default")];
+                case 0: return [4 /*yield*/, ProjectView.Get(apiGetter.getApi(Api.TEMPLATE_ACCOUNT_ID), "default")];
                 case 1:
                     view = _b.sent();
                     return [2 /*return*/, (_a = view.Settings) !== null && _a !== void 0 ? _a : {}];
@@ -5282,8 +5339,8 @@ function checkSourceToTemplate(items, templateItem, addIfMissing) {
  * This is a concept we want to trash as we're moving towards storing tileset ids instead.
  * This will help at least understand and manage this dying concept.
  */
-var ProjectViewTileSource;
-(function (ProjectViewTileSource) {
+var ProjectViewLegacyTile;
+(function (ProjectViewLegacyTile) {
     function MergeMapTemplateData(getter, items, addIfMissing) {
         var _a;
         return __awaiter(this, void 0, void 0, function () {
@@ -5303,7 +5360,7 @@ var ProjectViewTileSource;
             });
         });
     }
-    ProjectViewTileSource.MergeMapTemplateData = MergeMapTemplateData;
+    ProjectViewLegacyTile.MergeMapTemplateData = MergeMapTemplateData;
     function MergeTerrainTemplateData(getter, items, addIfMissing) {
         var _a;
         return __awaiter(this, void 0, void 0, function () {
@@ -5323,8 +5380,125 @@ var ProjectViewTileSource;
             });
         });
     }
-    ProjectViewTileSource.MergeTerrainTemplateData = MergeTerrainTemplateData;
-})(ProjectViewTileSource || (ProjectViewTileSource = {}));
+    ProjectViewLegacyTile.MergeTerrainTemplateData = MergeTerrainTemplateData;
+})(ProjectViewLegacyTile || (ProjectViewLegacyTile = {}));
+
+var ProjectViewTile;
+(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",
+        }
+    ];
+})(ProjectViewTile || (ProjectViewTile = {}));
 
 /**
  * Describes the "Pending Action" concept within Bruce.
@@ -6523,5 +6697,5 @@ var ImportedFile;
     ImportedFile.Get = Get;
 })(ImportedFile || (ImportedFile = {}));
 
-export { AnnDocument, CustomForm, AbstractApi, Api, BruceApi, CamApi, IdmApi, GlobalApi, Calculator, BruceEvent, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, Geometry, UTC, EntityAttachmentType, EntityAttachment, EntityComment, EntityLink, EntityLod, EntityRelationType, EntityRelation, EntitySource, EntityTag, EntityType, Entity, EntityGlobe, EntityFilterGetter, BatchedDataGetter, EntityCoords, ClientFile, ProgramKey, ZoomControl, MenuItem, ProjectViewBookmark, ProjectView, ProjectViewTileSource, PendingAction, Style, TilesetEntitiesMapTiles, TilesetExtMapTiles, Tileset, Permission, Session, UserGroup, User, Account, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils, DataLab, ImportCad, ImportCsv, ImportJson, ImportKml, ImportedFile };
+export { AnnDocument, CustomForm, AbstractApi, Api, BruceApi, CamApi, IdmApi, GlobalApi, Calculator, BruceEvent, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, Geometry, UTC, EntityAttachmentType, EntityAttachment, EntityComment, EntityLink, EntityLod, EntityRelationType, EntityRelation, EntitySource, EntityTag, EntityType, Entity, EntityGlobe, EntityFilterGetter, BatchedDataGetter, EntityCoords, ClientFile, ProgramKey, ZoomControl, MenuItem, ProjectViewBookmark, ProjectView, ProjectViewLegacyTile, ProjectViewTile, PendingAction, Style, TilesetEntitiesMapTiles, TilesetExtMapTiles, Tileset, Permission, Session, UserGroup, User, Account, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils, DataLab, ImportCad, ImportCsv, ImportJson, ImportKml, ImportedFile };
 //# sourceMappingURL=bruce-models.es5.js.map