bruce-models 7.1.123 → 7.1.124

package/dist/bruce-models.es5.js

@@ -1227,8 +1227,9 @@ class AbstractApi {
     }
     /**
      * Injects auth header into the headers object.
+     * Use this for a request made outside the GET/POST/PUT/DELETE/UPLOAD methods, such as a raw fetch.
      */
-    applyAuthHeader(headers) {
+    ApplyAuthHeader(headers) {
         if (!this.ssidHeader) {
             return;
         }
@@ -1271,7 +1272,7 @@ class AbstractApi {
             }
             params.headers = params.headers || {};
             params.headers = Object.assign({ "Content-Type": "application/json;" }, params.headers);
-            this.applyAuthHeader(params.headers);
+            this.ApplyAuthHeader(params.headers);
             const res = yield fetch(url, {
                 headers: params.headers,
                 signal: params.abortSignal
@@ -1293,7 +1294,7 @@ class AbstractApi {
             }
             params.headers = params.headers || {};
             params.headers = Object.assign({ "Content-Type": "application/json;" }, params.headers);
-            this.applyAuthHeader(params.headers);
+            this.ApplyAuthHeader(params.headers);
             if (data != null && typeof data != "string") {
                 data = JSON.stringify(data);
             }
@@ -1321,7 +1322,7 @@ class AbstractApi {
             }
             params.headers = params.headers || {};
             params.headers = Object.assign({ "Content-Type": "application/json;" }, params.headers);
-            this.applyAuthHeader(params.headers);
+            this.ApplyAuthHeader(params.headers);
             if (!data) {
                 data = {};
             }
@@ -1352,7 +1353,7 @@ class AbstractApi {
             }
             params.headers = params.headers || {};
             params.headers = Object.assign({ "Content-Type": "application/json;" }, params.headers);
-            this.applyAuthHeader(params.headers);
+            this.ApplyAuthHeader(params.headers);
             if (!data) {
                 data = {};
             }
@@ -1382,7 +1383,7 @@ class AbstractApi {
                 params = {};
             }
             params.headers = Object.assign({}, params.headers);
-            this.applyAuthHeader(params.headers);
+            this.ApplyAuthHeader(params.headers);
             const formData = params.formData instanceof FormData ? params.formData : new FormData();
             if (formData.has("file")) {
                 formData.delete("file");
@@ -20024,16 +20025,31 @@ var Plugin;
      * @returns
      */
     function GetLoadUrl(params) {
-        let { api, pluginId, cacheKey, viaCdn } = params;
+        const { fileUrl } = GetFileUrl(Object.assign(Object.assign({}, params), { filePath: "index.jsc" }));
+        return {
+            indexFileUrl: fileUrl
+        };
+    }
+    Plugin.GetLoadUrl = GetLoadUrl;
+    /**
+     * Returns a URL to a file within a plugin's ZIP.
+     * @param params
+     * @returns
+     */
+    function GetFileUrl(params) {
+        let { api, pluginId, filePath, cacheKey, viaCdn } = params;
         if (!api) {
             api = ENVIRONMENT.Api().GetBruceApi();
         }
         if (!cacheKey) {
             cacheKey = 0;
         }
+        if (filePath.startsWith("/")) {
+            filePath = filePath.substring(1);
+        }
         return {
-            indexFileUrl: api.ConstructUrl({
-                url: `ui.plugin/${pluginId}/file/index.jsc`,
+            fileUrl: api.ConstructUrl({
+                url: `ui.plugin/${pluginId}/file/${filePath}`,
                 urlParams: {
                     "version": String(cacheKey)
                 },
@@ -20041,7 +20057,53 @@ var Plugin;
             })
         };
     }
-    Plugin.GetLoadUrl = GetLoadUrl;
+    Plugin.GetFileUrl = GetFileUrl;
+    /**
+     * Fetches a file within a plugin's ZIP, with the session attached.
+     * Read the returned response as text, blob or JSON depending on the file.
+     * @param params
+     * @returns
+     */
+    function LoadFile(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let { api, pluginId, plugin, filePath, req } = params;
+            if (!filePath) {
+                throw ("File path is required.");
+            }
+            if (!api) {
+                api = ENVIRONMENT.Api().GetBruceApi();
+            }
+            yield api.Loading;
+            if (!plugin && pluginId) {
+                plugin = (yield Plugin.Get({
+                    pluginId,
+                    api,
+                    req
+                })).plugin;
+            }
+            if (plugin && !pluginId) {
+                pluginId = plugin.ID;
+            }
+            const { fileUrl } = GetFileUrl({
+                api,
+                pluginId,
+                filePath,
+                cacheKey: plugin.Version,
+                viaCdn: !plugin.IsLoginRequired
+            });
+            const headers = {};
+            api.ApplyAuthHeader(headers);
+            const res = yield fetch(fileUrl, {
+                headers: headers,
+                signal: req === null || req === void 0 ? void 0 : req.abortSignal
+            });
+            if (!res.ok) {
+                throw new Error(`Failed to load "${filePath}" from plugin "${pluginId}" (${res.status}).`);
+            }
+            return res;
+        });
+    }
+    Plugin.LoadFile = LoadFile;
     /**
      * Creates or updates a plugin.
      * @param params
@@ -20151,9 +20213,7 @@ var Plugin;
             }
             else {
                 const headers = {};
-                if (plugin.IsLoginRequired) {
-                    headers[api.GetSessionHeader()] = api.GetSessionId();
-                }
+                api.ApplyAuthHeader(headers);
                 // A refusal must not be cached and run as if it were the plugin's code.
                 fileContentProm = fetch(indexFileUrl, {
                     headers: headers
@@ -20212,6 +20272,13 @@ var Plugin;
             const paramsId = ObjectUtils.UId();
             window[paramsId] = pluginParams ? pluginParams : {};
             window["PLUGIN_" + pluginId] = plugin;
+            const loadFileId = ObjectUtils.UId();
+            window[loadFileId] = (filePath) => LoadFile({
+                api: loaded.api,
+                plugin,
+                filePath,
+                req
+            });
             const disposeId = ObjectUtils.UId();
             const elementId = ObjectUtils.UId();
             let script = `
@@ -20242,7 +20309,8 @@ var Plugin;
                     container: container,
                     pluginParams: params,
                     pluginId: "${pluginId}",
-                    plugin: plugin
+                    plugin: plugin,
+                    loadFile: window["${loadFileId}"]
                 });
             }
             run();
@@ -20277,6 +20345,7 @@ var Plugin;
                             }
                         }
                         callDispose();
+                        delete window[loadFileId];
                     };
                 }
             };
@@ -20304,7 +20373,12 @@ var Plugin;
                     const contextId = "PLUGIN_CONTEXT_" + callId;
                     const resultId = "PLUGIN_RESULT_" + callId;
                     window[argsId] = args ? args : {};
-                    window[contextId] = Object.assign({ config: loaded.plugin.Settings ? loaded.plugin.Settings.config : undefined, plugin: loaded.plugin }, (context ? context : {}));
+                    window[contextId] = Object.assign({ config: loaded.plugin.Settings ? loaded.plugin.Settings.config : undefined, plugin: loaded.plugin, loadFile: (filePath) => LoadFile({
+                            api: loaded.api,
+                            plugin: loaded.plugin,
+                            filePath,
+                            req
+                        }) }, (context ? context : {}));
                     const script = `
                     function invoke() {
                         "use strict";
@@ -25598,7 +25672,7 @@ function getFirstWrappedArray(data, wrapperKeys) {
 }
 
 // This is updated with the package.json version on build.
-const VERSION = "7.1.123";
+const VERSION = "7.1.124";
 
 export { VERSION, Account, AccountAudit, AccountConcept, AccountFeatures, AccountInvite, AccountLimits, AccountTemplate, AccountType, AnnDocument, AbstractApi, Api, ApiGetters, BruceApi, GlobalApi, GuardianApi, Assembly, Calculator, ChangeSet, ClientFile, ClientFileFolder, ClientFileValueMap, Bounds, BruceEvent, BruceVariable, CacheControl, Camera, Cartes, Carto, Color, DelayQueue, RequestLane, GeoJson, Geometry, LRUCache, UTC, CustomForm, DashboardView, DataFeed, DataLab, DataLabGroup, DataSource, DataTransform, Comment, Entity, EntityAttachment, EntityAttachmentType, EntityAttribute, EntityComment, EntityCoords, EntityHistoricData, EntityLink, EntityLod, EntityLodCategory, EntityRelation, EntityRelationType, EntitySource, EntityTableView, EntityTag, EntityType, EntityTypeRelation, EntityTypeSource, EntityTypeTrigger, Ontology, OntologyDocument, ENVIRONMENT, ExportBrz, ExportCsv, ExportNsx, ExportUsd, Hexbin, ImportAssembly, ImportCad, ImportCsv, ImportGeoJson, ImportJson, ImportKml, ImportLcc, ImportTif, ImportedFile, Uploader, Markup, UIMarkup, NAVIGATOR_CHAT_EVENT_ENTITY_HIGHLIGHT_APPLIED, NAVIGATOR_CHAT_EVENT_SCENE_CONTEXT_PREFETCHED, NavigatorChatClient, NavigatorMcpWebSocketClient, Plugin, PluginAiTool, ProgramKey, MenuItem, ProjectView, ProjectViewBookmark, ProjectViewBookmarkGroup, ProjectViewLegacy, ProjectViewLegacyBookmark, ProjectViewLegacyTile, ProjectViewTile, ZoomControl, Scenario, HostingLocation, MessageBroker, PendingAction, RecordChangeFeed, Style, Tileset, Tracking, Permission, Session, User, UserGroup, UserMfaMethod, EncryptUtils, MathUtils, ObjectUtils, PathUtils, UrlUtils, WorkflowItem, WorkflowSchedule, WorkflowType, WorkflowItemType };
 //# sourceMappingURL=bruce-models.es5.js.map