bruce-models 3.5.8 → 3.6.0

package/dist/bruce-models.umd.js

@@ -1278,6 +1278,9 @@
             get MessageBroker() {
                 return this.messageBroker;
             }
+            get ConfigLoadAttempted() {
+                return this.configLoadAttempted;
+            }
             get Loading() {
                 return this.loadProm;
             }
@@ -1289,16 +1292,18 @@
                 // Load cancelled indicates the user set a custom base url.
                 // This will stop the regional url from being set if it's still loading.
                 this.loadCancelled = false;
+                // Indicates if loading the regional configuration was already called.
+                this.configLoadAttempted = false;
                 let { accountId, env, guardian, loadRegionalBaseUrl, loadConfig, loadWebSocket } = params;
                 this.accountId = accountId;
                 this.env = env !== null && env !== void 0 ? env : exports.Api.EEnv.PROD;
+                // Backwards compatibility.
                 if (loadRegionalBaseUrl) {
                     loadConfig = true;
                 }
-                if (!guardian && loadConfig) {
-                    guardian = new exports.GuardianApi.Api({
-                        env: this.env
-                    });
+                if (loadConfig) {
+                    // Mark it as attempted right away because we don't want any external calls while it gets to that async point.
+                    this.configLoadAttempted = true;
                 }
                 this.loadProm = this.init(guardian, loadConfig, loadWebSocket);
             }
@@ -1309,110 +1314,142 @@
              * @returns
              */
             init(guardian, loadConfig, loadWebSocket) {
-                var _a, _b, _c;
                 return __awaiter(this, void 0, void 0, function* () {
                     if (!this.accountId) {
                         throw ("accountId is required.");
                     }
-                    const env = this.env.toUpperCase();
-                    let domain = "nextspace.host";
-                    switch (env) {
-                        case exports.Api.EEnv.DEV:
-                            domain = "nextspace-dev.net";
-                            break;
-                        case exports.Api.EEnv.STG:
-                            domain = "nextspace-stg.net";
-                            break;
-                        case exports.Api.EEnv.UAT:
-                            domain = "nextspace-uat.net";
-                            break;
-                        case exports.Api.EEnv.PROD:
-                            domain = "nextspace.host";
-                            break;
-                        default:
-                            console.error("Specified Environment is not valid. SuppliedEnv=" + env);
-                    }
                     // Set using a stable default.
+                    const domain = this.getDomain();
                     this.baseUrl = `https://${this.accountId}.api.${domain}/`;
-                    if (guardian && loadConfig) {
+                    // Attempt to load regional configuration.
+                    if (loadConfig) {
+                        yield this.LoadConfig({
+                            guardian: guardian,
+                            // We marked it as attempted to load outside this method to fight any external calls.
+                            // So we'll force load it now.
+                            forceLoad: true
+                        });
+                    }
+                    // Start web socket connection.
+                    if (loadWebSocket != false) {
                         try {
-                            const host = yield exports.HostingLocation.GetByAccountId({
-                                accountId: this.accountId,
-                                api: guardian
+                            this.messageBroker = new exports.MessageBroker.WebSocketBroker(this.baseUrl, this.env);
+                        }
+                        catch (e) {
+                            console.warn("BruceApi: Failed to create message broker.", e);
+                        }
+                    }
+                });
+            }
+            getDomain() {
+                const env = this.env.toUpperCase();
+                let domain = "nextspace.host";
+                switch (env) {
+                    case exports.Api.EEnv.DEV:
+                        domain = "nextspace-dev.net";
+                        break;
+                    case exports.Api.EEnv.STG:
+                        domain = "nextspace-stg.net";
+                        break;
+                    case exports.Api.EEnv.UAT:
+                        domain = "nextspace-uat.net";
+                        break;
+                    case exports.Api.EEnv.PROD:
+                        domain = "nextspace.host";
+                        break;
+                    default:
+                        console.error("Specified Environment is not valid. SuppliedEnv=" + env);
+                }
+                return domain;
+            }
+            /**
+             * Loads the regional configuration for the account.
+             * If the config is already loaded then this will do nothing.
+             */
+            LoadConfig(params) {
+                var _a, _b, _c;
+                return __awaiter(this, void 0, void 0, function* () {
+                    let { guardian, forceLoad } = (params !== null && params !== void 0 ? params : {});
+                    if (this.configLoadAttempted && forceLoad != true) {
+                        return;
+                    }
+                    this.configLoadAttempted = true;
+                    try {
+                        if (!guardian) {
+                            guardian = new exports.GuardianApi.Api({
+                                env: this.env
                             });
-                            if (host === null || host === void 0 ? void 0 : host.location) {
-                                const settings = host.location.Settings;
-                                if (!this.loadCancelled) {
-                                    // Attempt to load regional base url.
-                                    // First try go through settings.
-                                    let urlSet = false;
-                                    if (settings === null || settings === void 0 ? void 0 : settings.BruceAPIURL) {
-                                        let envUrl = settings.BruceAPIURL[env];
-                                        if (envUrl) {
-                                            envUrl = envUrl
-                                                .replace("<ACCOUNTID>", this.accountId)
-                                                .replace("<ACCOUNT>", this.accountId);
-                                            if (envUrl && envUrl.length > 1) {
-                                                this.baseUrl = envUrl;
-                                                urlSet = true;
-                                            }
-                                        }
-                                    }
-                                    // Try go through host location's base url.
-                                    // This may be wrong env which is why it's used as fallback right now.
-                                    if (!urlSet && host.location.BruceAPIURL) {
-                                        const regionalUrl = host.location.BruceAPIURL
+                        }
+                        const env = this.env.toUpperCase();
+                        const domain = this.getDomain();
+                        const host = yield exports.HostingLocation.GetByAccountId({
+                            accountId: this.accountId,
+                            api: guardian
+                        });
+                        if (host === null || host === void 0 ? void 0 : host.location) {
+                            const settings = host.location.Settings;
+                            if (!this.loadCancelled) {
+                                // Attempt to load regional base url.
+                                // First try go through settings.
+                                let urlSet = false;
+                                if (settings === null || settings === void 0 ? void 0 : settings.BruceAPIURL) {
+                                    let envUrl = settings.BruceAPIURL[env];
+                                    if (envUrl) {
+                                        envUrl = envUrl
                                             .replace("<ACCOUNTID>", this.accountId)
-                                            .replace("<ACCOUNT>", this.accountId)
-                                            .replace("<DOMAIN>", domain);
-                                        if (regionalUrl && regionalUrl.length > 1) {
-                                            this.baseUrl = regionalUrl;
+                                            .replace("<ACCOUNT>", this.accountId);
+                                        if (envUrl && envUrl.length > 1) {
+                                            this.baseUrl = envUrl;
                                             urlSet = true;
                                         }
                                     }
                                 }
-                                // Attempt to load CDN settings.
-                                if (settings === null || settings === void 0 ? void 0 : settings.CDN) {
-                                    this.EntityCdnUrl = (_a = settings.CDN.entityURL) === null || _a === void 0 ? void 0 : _a[env];
-                                    // We need to fix our configs.
-                                    if (this.EntityCdnUrl) {
-                                        if (this.EntityCdnUrl.includes("entitiesListForCDN")) {
-                                            this.EntityCdnUrl = this.EntityCdnUrl.replace("<ACCOUNT>", this.accountId);
-                                        }
-                                        else {
-                                            this.EntityCdnUrl = this.EntityCdnUrl.replace("<ACCOUNT>", "entitiesListForCDN/" + this.accountId);
-                                        }
+                                // Try go through host location's base url.
+                                // This may be wrong env which is why it's used as fallback right now.
+                                if (!urlSet && host.location.BruceAPIURL) {
+                                    const regionalUrl = host.location.BruceAPIURL
+                                        .replace("<ACCOUNTID>", this.accountId)
+                                        .replace("<ACCOUNT>", this.accountId)
+                                        .replace("<DOMAIN>", domain);
+                                    if (regionalUrl && regionalUrl.length > 1) {
+                                        this.baseUrl = regionalUrl;
+                                        urlSet = true;
                                     }
-                                    this.LegacyTilesetCdnUrl = (_b = settings.CDN.legacyTilesetURL) === null || _b === void 0 ? void 0 : _b[env];
-                                    this.TilesetCdnUrl = (_c = settings.CDN.tilesetURL) === null || _c === void 0 ? void 0 : _c[env];
-                                    if (this.TilesetCdnUrl) {
-                                        this.TilesetCdnUrl = this.TilesetCdnUrl.replace("<ACCOUNT>", this.accountId);
+                                }
+                            }
+                            // Attempt to load CDN settings.
+                            if (settings === null || settings === void 0 ? void 0 : settings.CDN) {
+                                this.EntityCdnUrl = (_a = settings.CDN.entityURL) === null || _a === void 0 ? void 0 : _a[env];
+                                // We need to fix our configs.
+                                if (this.EntityCdnUrl) {
+                                    if (this.EntityCdnUrl.includes("entitiesListForCDN")) {
+                                        this.EntityCdnUrl = this.EntityCdnUrl.replace("<ACCOUNT>", this.accountId);
                                     }
-                                    // TilesetCdnUrl example: "https://blah.cloudfront.net/tilesets/<TILESETID>/files/<FILEPATH>?accountId=<ACCOUNT>".
-                                    // Lazy at the moment to go around updating every region we have, I'll interpret the url from tilesetCdnUrl.
-                                    if (this.TilesetCdnUrl) {
-                                        try {
-                                            const url = new URL(this.TilesetCdnUrl);
-                                            this.cdnBaseUrl = `${url.protocol}//${url.hostname}/`;
-                                        }
-                                        catch (e) {
-                                            console.error(e);
-                                        }
+                                    else {
+                                        this.EntityCdnUrl = this.EntityCdnUrl.replace("<ACCOUNT>", "entitiesListForCDN/" + this.accountId);
+                                    }
+                                }
+                                this.LegacyTilesetCdnUrl = (_b = settings.CDN.legacyTilesetURL) === null || _b === void 0 ? void 0 : _b[env];
+                                this.TilesetCdnUrl = (_c = settings.CDN.tilesetURL) === null || _c === void 0 ? void 0 : _c[env];
+                                if (this.TilesetCdnUrl) {
+                                    this.TilesetCdnUrl = this.TilesetCdnUrl.replace("<ACCOUNT>", this.accountId);
+                                }
+                                // TilesetCdnUrl example: "https://blah.cloudfront.net/tilesets/<TILESETID>/files/<FILEPATH>?accountId=<ACCOUNT>".
+                                // Lazy at the moment to go around updating every region we have, I'll interpret the url from tilesetCdnUrl.
+                                if (this.TilesetCdnUrl) {
+                                    try {
+                                        const url = new URL(this.TilesetCdnUrl);
+                                        this.cdnBaseUrl = `${url.protocol}//${url.hostname}/`;
+                                    }
+                                    catch (e) {
+                                        console.error(e);
                                     }
                                 }
                             }
                         }
-                        catch (e) {
-                            console.error(e);
-                        }
                     }
-                    if (loadWebSocket != false) {
-                        try {
-                            this.messageBroker = new exports.MessageBroker.WebSocketBroker(this.baseUrl, this.env);
-                        }
-                        catch (e) {
-                            console.warn("BruceApi: Failed to create message broker.", e);
-                        }
+                    catch (e) {
+                        console.error(e);
                     }
                 });
             }
@@ -1721,6 +1758,17 @@
          */
         SetAccountId(accountId) {
             this.accountId = accountId;
+            // Queue load of regional config in case an instance was made earlier without it.
+            // We want the default account to always go through the fastest regional endpoint.
+            const api = this.GetBruceApi({
+                accountId: accountId,
+                loadConfig: true
+            });
+            api.LoadConfig({
+                guardian: this.GetGuardianApi({
+                    env: this.env
+                })
+            });
         }
         /**
          * Returns the default account ID to use when one is unspecified.
@@ -1785,7 +1833,9 @@
                 this.bruce[key] = new exports.BruceApi.Api({
                     accountId,
                     env,
-                    loadConfig: loadConfig,
+                    // We'll load regional config if the accountId matches the default accountId.
+                    // We'll also load if it no default is known.
+                    loadConfig: loadConfig != null ? loadConfig : (this.accountId == accountId || !this.accountId),
                     loadWebSocket: loadWebSocket,
                     guardian: this.GetGuardianApi({
                         env
@@ -1809,8 +1859,9 @@
                     return this.GetBruceApi({
                         accountId,
                         env,
-                        loadWebSocket: this.accountId == accountId,
-                        loadConfig: this.accountId == accountId
+                        // We'll load regional config if the accountId matches the default accountId.
+                        // We'll also load if it no default is known.
+                        loadConfig: this.accountId == accountId || !this.accountId
                     });
                 }
             };
@@ -3963,7 +4014,7 @@
                         str: value,
                         entity: entity
                     });
-                    const isJsEval = typeof value == "string" && value.startsWith("JS:");
+                    const isJsEval = value.startsWith("JS:");
                     const MATH_REGEX = /(\d+\.?\d*|\.\d+)([+\-*/])(\d+\.?\d*|\.\d+)/;
                     const isMathEval = isJsEval || MATH_REGEX.test(value);
                     if (isJsEval || isMathEval) {
@@ -7637,22 +7688,44 @@
          */
         let EType;
         (function (EType) {
+            // Container for other menu items.
             EType["None"] = "NONE";
+            // Renders Nextspace Entities based on an Entity Type ID and optional attribute filter.
             EType["Entities"] = "BruceEntity";
+            // Renders a single Entity by ID.
             EType["Entity"] = "SingleEntity";
+            // Renders Cesium OSM Buildings.
             EType["Osm"] = "OSMBuildingsTileset";
+            // Renders a Cesium Tileset made from importing an assembly file into Nextspace.
             EType["CadTileset"] = "ModelTileset";
+            // Renders legacy Nextspace tilesets.
+            // This is primarily used for static Tilesets as they don't have an upgraded version yet.
             EType["ArbTileset"] = "ArbitraryTileset";
+            // Renders a Cesium Tileset by Ion asset ID.
             EType["IonTileset"] = "Cesium3DTileset";
+            // Renders a KML file in Cesium.
+            // No data is managed, this is purely visual.
             EType["Kml"] = "StaticKML";
+            // Renders rows of a CSV as Cesium Entities.
+            // This a single-purpose proof of concept feature. Avoid using.
+            EType["Csv"] = "StaticCSV";
+            // Renders a Cesium Tileset made from arbitrary Nextspace Entities.
             EType["EntityTileset"] = "EntitiesTileset";
+            // Renders a Cesium Imagery made from arbitrary Nextspace Entities.
+            // @deprecated.
             EType["EntityRaster"] = "RasterEntitiesTileset";
+            // Renders a Cesium Point Cloud imported from LAS/LAZ file into Nextspace.
             EType["PointCloud"] = "PointCloudTileset";
+            // Renders preloaded Entity records.
             EType["EntitiesLoaded"] = "LoadedEntities";
+            // Renders Entities matching specific IDs.
             EType["EntitiesIds"] = "EntitiesIds";
-            // Deprecated. Use Relationships instead.
+            // @deprecated. Use Relationships instead.
             EType["Relations"] = "Relations";
+            // Renders Entity relationships.
+            // This renders specified downstream relationship types for specified Entity IDs.
             EType["Relationships"] = "Relationships";
+            // Renders the Cesium Google photogrammetry tileset.
             EType["GooglePhotoTileset"] = "GooglePhotoTileset";
         })(EType = MenuItem.EType || (MenuItem.EType = {}));
         /**
@@ -10639,7 +10712,7 @@
     })(exports.DataSource || (exports.DataSource = {}));
 
     // This is updated with the package.json version on build.
-    const VERSION = "3.5.8";
+    const VERSION = "3.6.0";
 
     exports.VERSION = VERSION;
     exports.AbstractApi = AbstractApi;