bruce-models 7.1.123 → 7.1.126

package/dist/bruce-models.umd.js

@@ -1222,8 +1222,9 @@
         }
         /**
          * 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;
             }
@@ -1266,7 +1267,7 @@
                 }
                 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
@@ -1288,7 +1289,7 @@
                 }
                 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);
                 }
@@ -1316,7 +1317,7 @@
                 }
                 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 = {};
                 }
@@ -1347,7 +1348,7 @@
                 }
                 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 = {};
                 }
@@ -1377,7 +1378,7 @@
                     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");
@@ -7124,7 +7125,7 @@
         function Update(params) {
             var _a, _b, _c, _d, _e, _f, _g;
             return __awaiter(this, void 0, void 0, function* () {
-                let { api, entity: data, entities, override, req: reqParams, migrated, skipSourcePush } = params;
+                let { api, entity: data, entities, override, req: reqParams, migrated, skipSourcePush, expandLocation } = params;
                 if (migrated == null || migrated == undefined) {
                     // Changed to default = true. 18th April 2025.
                     migrated = true;
@@ -7150,9 +7151,16 @@
                     if (!api) {
                         api = exports.ENVIRONMENT.Api().GetBruceApi();
                     }
-                    let reqUrl = "v3/entities";
+                    const urlParams = new URLSearchParams();
                     if (skipSourcePushParam) {
-                        reqUrl += `?SkipSourcePush=${encodeURIComponent(skipSourcePushParam)}`;
+                        urlParams.set("SkipSourcePush", skipSourcePushParam);
+                    }
+                    if (expandLocation) {
+                        urlParams.set("Expand", "location");
+                    }
+                    let reqUrl = "v3/entities";
+                    if (urlParams.toString()) {
+                        reqUrl += `?${urlParams.toString()}`;
                     }
                     const reqBody = {
                         Items: entities,
@@ -7216,6 +7224,9 @@
                     if (skipSourcePushParam) {
                         reqUrl += `&SkipSourcePush=${encodeURIComponent(skipSourcePushParam)}`;
                     }
+                    if (expandLocation) {
+                        reqUrl += "&Expand=location";
+                    }
                     const res = yield api.POST(reqUrl, data, exports.Api.PrepReqParams(reqParams));
                     api.Cache.RemoveByContains(GetContainsKey(data.Bruce.ID));
                     exports.EntityHistoricData.ClearCacheByEntityIds(api, [data.Bruce.ID]);
@@ -19735,16 +19746,31 @@
          * @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 = exports.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)
                     },
@@ -19752,7 +19778,53 @@
                 })
             };
         }
-        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 = exports.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
@@ -19862,9 +19934,7 @@
                 }
                 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
@@ -19923,6 +19993,13 @@
                 const paramsId = exports.ObjectUtils.UId();
                 window[paramsId] = pluginParams ? pluginParams : {};
                 window["PLUGIN_" + pluginId] = plugin;
+                const loadFileId = exports.ObjectUtils.UId();
+                window[loadFileId] = (filePath) => LoadFile({
+                    api: loaded.api,
+                    plugin,
+                    filePath,
+                    req
+                });
                 const disposeId = exports.ObjectUtils.UId();
                 const elementId = exports.ObjectUtils.UId();
                 let script = `
@@ -19953,7 +20030,8 @@
                     container: container,
                     pluginParams: params,
                     pluginId: "${pluginId}",
-                    plugin: plugin
+                    plugin: plugin,
+                    loadFile: window["${loadFileId}"]
                 });
             }
             run();
@@ -19988,6 +20066,7 @@
                                 }
                             }
                             callDispose();
+                            delete window[loadFileId];
                         };
                     }
                 };
@@ -20015,7 +20094,12 @@
                         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";
@@ -25205,7 +25289,7 @@
     }
 
     // This is updated with the package.json version on build.
-    const VERSION = "7.1.123";
+    const VERSION = "7.1.126";
 
     exports.VERSION = VERSION;
     exports.AbstractApi = AbstractApi;