@shapediver/viewer.session-engine.session-engine 2.12.8 → 3.0.1

package/dist/implementation/SessionEngine.js

@@ -27,7 +27,6 @@ const sdk_geometry_api_sdk_v2_1 = require("@shapediver/sdk.geometry-api-sdk-v2")
 const viewer_shared_services_1 = require("@shapediver/viewer.shared.services");
 const Export_1 = require("./dto/Export");
 const FileParameter_1 = require("./dto/FileParameter");
-const ISessionEngine_1 = require("../interfaces/ISessionEngine");
 const viewer_shared_types_1 = require("@shapediver/viewer.shared.types");
 const viewer_shared_node_tree_1 = require("@shapediver/viewer.shared.node-tree");
 const Output_1 = require("./dto/Output");
@@ -38,14 +37,14 @@ const SessionData_1 = require("./SessionData");
 const SessionTreeNode_1 = require("./SessionTreeNode");
 /* eslint-disable @typescript-eslint/no-empty-function */
 class SessionEngine {
-    // #endregion Properties (44)
+    // #endregion Properties (46)
     // #region Constructors (1)
     /**
      * Can be use to initialize a session with the ticket/guid and modelViewUrl and returns a scene graph node with the result.
      * Can be use to customize the session with updated parameters to get the updated scene graph node.
      */
     constructor(properties) {
-        // #region Properties (44)
+        // #region Properties (46)
         this._eventEngine = viewer_shared_services_1.EventEngine.instance;
         this._exports = {};
         this._httpClient = viewer_shared_services_1.HttpClient.instance;
@@ -65,6 +64,7 @@ class SessionEngine {
         _SessionEngine_parameterHistory.set(this, []);
         _SessionEngine_parameterHistoryCall.set(this, false);
         _SessionEngine_parameterHistoryForward.set(this, []);
+        this._allowOutputLoading = true;
         this._automaticSceneUpdate = true;
         this._closeOnFailure = () => __awaiter(this, void 0, void 0, function* () { });
         this._closed = false;
@@ -78,6 +78,7 @@ class SessionEngine {
             'X-ShapeDiver-BuildDate': ''
         };
         this._initialized = false;
+        this._loadSdtf = false;
         this._retryCounter = 0;
         this._updateCallback = null;
         this._viewerSettingsVersion = viewer_settings_1.latestVersion;
@@ -89,6 +90,8 @@ class SessionEngine {
         this._modelViewUrl = properties.modelViewUrl;
         this._excludeViewports = properties.excludeViewports || [];
         this._jwtToken = properties.jwtToken;
+        this._allowOutputLoading = properties.allowOutputLoading;
+        this._loadSdtf = properties.loadSdtf;
         this._headers['X-ShapeDiver-BuildDate'] = properties.buildDate;
         this._headers['X-ShapeDiver-BuildVersion'] = properties.buildVersion;
         this._outputLoader = new OutputLoader_1.OutputLoader(this);
@@ -101,7 +104,7 @@ class SessionEngine {
         }
     }
     // #endregion Constructors (1)
-    // #region Public Accessors (25)
+    // #region Public Getters And Setters (26)
     get automaticSceneUpdate() {
         return this._automaticSceneUpdate;
     }
@@ -146,6 +149,20 @@ class SessionEngine {
     get jwtToken() {
         return this._jwtToken;
     }
+    get loadSdtf() {
+        return this._loadSdtf;
+    }
+    set loadSdtf(value) {
+        this._loadSdtf = value;
+        if (this._initialized === true && this._loadSdtf === true) {
+            (() => __awaiter(this, void 0, void 0, function* () {
+                this._outputLoader.reloadSdtf = true;
+                yield this.updateOutputs();
+                this._outputLoader.reloadSdtf = false;
+                this._eventEngine.emitEvent(viewer_shared_services_1.EVENTTYPE.SESSION.SESSION_SDTF_DELAYED_LOADED, { sessionId: this.id });
+            }))();
+        }
+    }
     get modelViewUrl() {
         return this._modelViewUrl;
     }
@@ -185,8 +202,8 @@ class SessionEngine {
     get viewerSettings() {
         return this._viewerSettings;
     }
-    // #endregion Public Accessors (25)
-    // #region Public Methods (27)
+    // #endregion Public Getters And Setters (26)
+    // #region Public Methods (30)
     applySettings(response, sections) {
         sections = sections || {};
         if (sections.session === undefined) {
@@ -323,9 +340,9 @@ class SessionEngine {
         if (__classPrivateFieldGet(this, _SessionEngine_customizationProcess, "f"))
             this.removeBusyMode(__classPrivateFieldGet(this, _SessionEngine_customizationProcess, "f"));
         for (const busyId of __classPrivateFieldGet(this, _SessionEngine_customizationBusyModes, "f")) {
-            for (const r in this._stateEngine.renderingEngines) {
-                if (this._stateEngine.renderingEngines[r].busy.includes(busyId))
-                    this._stateEngine.renderingEngines[r].busy.splice(this._stateEngine.renderingEngines[r].busy.indexOf(busyId), 1);
+            for (const r in this._stateEngine.viewportEngines) {
+                if (this._stateEngine.viewportEngines[r].busy.includes(busyId))
+                    this._stateEngine.viewportEngines[r].busy.splice(this._stateEngine.viewportEngines[r].busy.indexOf(busyId), 1);
             }
         }
         __classPrivateFieldSet(this, _SessionEngine_customizationBusyModes, [], "f");
@@ -375,24 +392,12 @@ class SessionEngine {
                 this.addBusyMode(customizationId);
                 const eventFileUpload = { type: viewer_shared_types_1.TASK_TYPE.SESSION_CUSTOMIZATION, id: eventId, progress: 0.1, data: { sessionId: this.id }, status: 'Uploading file parameters' };
                 this._eventEngine.emitEvent(viewer_shared_services_1.EVENTTYPE.TASK.TASK_PROCESS, eventFileUpload);
-                const fileParameterIds = {};
-                // load file parameter first
-                for (const parameterId in this.parameters) {
-                    if (this.parameters[parameterId] instanceof FileParameter_1.FileParameter) {
-                        fileParameterIds[parameterId] = yield this.parameters[parameterId].upload();
-                        // OPTION TO SKIP - PART 1a
-                        const cancelResult = this.cancelProcess(customizationId, eventId, viewer_shared_types_1.TASK_TYPE.SESSION_CUSTOMIZATION, 1, { sessionId: this.id });
-                        if (cancelResult)
-                            return cancelResult;
-                    }
-                }
+                // upload file parameters
+                yield this.uploadFileParameters();
                 // OPTION TO SKIP - PART 1b
                 const cancelResult = this.cancelProcess(customizationId, eventId, viewer_shared_types_1.TASK_TYPE.SESSION_CUSTOMIZATION, 1, { sessionId: this.id });
                 if (cancelResult)
                     return cancelResult;
-                // assign the uploaded parameters
-                for (const parameterId in fileParameterIds)
-                    this.parameters[parameterId].value = fileParameterIds[parameterId];
                 const parameterSet = {};
                 // create a set of the current validated parameter values
                 for (const parameterId in this.parameters) {
@@ -470,9 +475,9 @@ class SessionEngine {
                 this._eventEngine.emitEvent(viewer_shared_services_1.EVENTTYPE.TASK.TASK_END, eventEnd);
                 // update the viewports
                 if (waitForViewportUpdate) {
-                    for (const r in this._stateEngine.renderingEngines)
-                        if (!this.excludeViewports.includes(this._stateEngine.renderingEngines[r].id))
-                            this._stateEngine.renderingEngines[r].update(`SessionEngine(${this.id}).customize`);
+                    for (const r in this._stateEngine.viewportEngines)
+                        if (!this.excludeViewports.includes(this._stateEngine.viewportEngines[r].id))
+                            this._stateEngine.viewportEngines[r].update(`SessionEngine(${this.id}).customize`);
                     for (const outputId in this.outputs) {
                         if (oldOutputVersions[outputId] !== newOutputVersions[outputId]) {
                             this._eventEngine.emitEvent(viewer_shared_services_1.EVENTTYPE.OUTPUT.OUTPUT_UPDATED, {
@@ -491,9 +496,9 @@ class SessionEngine {
                 }
                 if (!waitForViewportUpdate) {
                     setTimeout(() => {
-                        for (const r in this._stateEngine.renderingEngines)
-                            if (!this.excludeViewports.includes(this._stateEngine.renderingEngines[r].id))
-                                this._stateEngine.renderingEngines[r].update(`SessionEngine(${this.id}).customize`);
+                        for (const r in this._stateEngine.viewportEngines)
+                            if (!this.excludeViewports.includes(this._stateEngine.viewportEngines[r].id))
+                                this._stateEngine.viewportEngines[r].update(`SessionEngine(${this.id}).customize`);
                     }, 0);
                 }
                 return this.node;
@@ -511,10 +516,12 @@ class SessionEngine {
             const eventId = this._uuidGenerator.create();
             const eventStart = { type: viewer_shared_types_1.TASK_TYPE.SESSION_CUSTOMIZATION, id: eventId, progress: 0, data: { sessionId: this.id }, status: 'Customizing session' };
             this._eventEngine.emitEvent(viewer_shared_services_1.EVENTTYPE.TASK.TASK_START, eventStart);
+            // upload file parameters
+            yield this.uploadFileParameters(parameterValues);
             const parameterSet = {};
             // create a set of the current validated parameter values
             for (const parameterId in this.parameters)
-                parameterSet[parameterId] = parameterValues[parameterId] !== undefined ? (' ' + parameterValues[parameterId]).slice(1) : this.parameters[parameterId].stringify();
+                parameterSet[parameterId] = (' ' + this.parameters[parameterId].stringify(parameterValues[parameterId])).slice(1);
             const result = yield this.customizeSession(parameterSet, () => false, {
                 eventId,
                 type: viewer_shared_types_1.TASK_TYPE.SESSION_CUSTOMIZATION,
@@ -793,6 +800,7 @@ class SessionEngine {
         return __awaiter(this, void 0, void 0, function* () {
             this.checkAvailability('export');
             try {
+                yield this.uploadFileParameters(parameters);
                 const requestParameterSet = this.cleanExportParameters(parameters);
                 const responseDto = yield this._sdk.utils.submitAndWaitForExport(this._sdk, this._sessionId, { exports: { id: exportId }, parameters: requestParameterSet }, maxWaitTime);
                 this.updateResponseDto(responseDto);
@@ -806,16 +814,28 @@ class SessionEngine {
     }
     requestExports(body, loadOutputs = false, maxWaitMsec, retry = false) {
         return __awaiter(this, void 0, void 0, function* () {
+            let processId;
             this.checkAvailability('export');
             try {
+                // activate the busy mode if outputs are loaded
+                if (loadOutputs === true && this._allowOutputLoading === true &&
+                    body.outputs && Object.keys(body.outputs).length > 0) {
+                    processId = this._uuidGenerator.create();
+                    this.addBusyMode(processId);
+                }
+                yield this.uploadFileParameters(body.parameters);
                 const requestParameterSet = this.cleanExportParameters(body.parameters);
                 const responseDto = yield this._sdk.utils.submitAndWaitForExport(this._sdk, this._sessionId, { exports: body.exports, parameters: requestParameterSet, outputs: body.outputs, max_wait_time: body.max_wait_time }, maxWaitMsec);
                 this.updateResponseDto(responseDto);
-                if (loadOutputs === true)
+                if (loadOutputs === true && this._allowOutputLoading === true)
                     this.updateOutputs();
+                if (processId)
+                    this.removeBusyMode(processId);
                 return responseDto;
             }
             catch (e) {
+                if (processId)
+                    this.removeBusyMode(processId);
                 yield this.handleError(e, retry);
                 return yield this.requestExports(body, loadOutputs, maxWaitMsec, true);
             }
@@ -1080,9 +1100,9 @@ class SessionEngine {
             }
             // update the viewports
             if (waitForViewportUpdate) {
-                for (const r in this._stateEngine.renderingEngines)
-                    if (!this.excludeViewports.includes(this._stateEngine.renderingEngines[r].id))
-                        this._stateEngine.renderingEngines[r].update(`SessionEngine(${this.id}).updateOutputs`);
+                for (const r in this._stateEngine.viewportEngines)
+                    if (!this.excludeViewports.includes(this._stateEngine.viewportEngines[r].id))
+                        this._stateEngine.viewportEngines[r].update(`SessionEngine(${this.id}).updateOutputs`);
                 for (const outputId in this.outputs) {
                     if (oldOutputVersions[outputId] !== newOutputVersions[outputId]) {
                         this._eventEngine.emitEvent(viewer_shared_services_1.EVENTTYPE.OUTPUT.OUTPUT_UPDATED, {
@@ -1126,6 +1146,35 @@ class SessionEngine {
             }
         });
     }
+    /**
+     * Uploads all file parameters and returns the file parameter values.
+     * If parameterValues is provided, the file parameter values are added to it.
+     *
+     * @param parameterValues
+     * @returns
+     */
+    uploadFileParameters(parameterValues) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const parameterValueSet = parameterValues !== undefined ? this.getFileParameterSet(parameterValues) : undefined;
+            const fileParameterValues = {};
+            // load file parameter first
+            for (const parameterId in this.parameters) {
+                if (this.parameters[parameterId] instanceof FileParameter_1.FileParameter) {
+                    fileParameterValues[parameterId] = yield this.parameters[parameterId].upload(parameterValueSet ? parameterValueSet[parameterId] : undefined);
+                    if (parameterValues) {
+                        parameterValues[parameterId] = fileParameterValues[parameterId];
+                        // if the parameter value of the file parameter was used, set the value to the parameter
+                        if (parameterValues[parameterId] === undefined && this.parameters[parameterId].value !== fileParameterValues[parameterId])
+                            this.parameters[parameterId].value = fileParameterValues[parameterId];
+                    }
+                    else if (this.parameters[parameterId].value !== fileParameterValues[parameterId]) {
+                        this.parameters[parameterId].value = fileParameterValues[parameterId];
+                    }
+                }
+            }
+            return fileParameterValues;
+        });
+    }
     uploadGLTF(blob, conversion = sdk_geometry_api_sdk_v2_1.ShapeDiverRequestGltfUploadQueryConversion.NONE, retry = false) {
         return __awaiter(this, void 0, void 0, function* () {
             this.checkAvailability('gltf-upload');
@@ -1141,8 +1190,8 @@ class SessionEngine {
             }
         });
     }
-    // #endregion Public Methods (27)
-    // #region Private Methods (15)
+    // #endregion Public Methods (30)
+    // #region Private Methods (16)
     _saveSessionSettings() {
         const parameters = this.parameters;
         const exports = this.exports;
@@ -1190,9 +1239,9 @@ class SessionEngine {
         }
     }
     addBusyMode(busyId) {
-        for (const r in this._stateEngine.renderingEngines) {
+        for (const r in this._stateEngine.viewportEngines) {
             if (!this.excludeViewports.includes(r)) {
-                this._stateEngine.renderingEngines[r].busy.push(busyId);
+                this._stateEngine.viewportEngines[r].busy.push(busyId);
                 __classPrivateFieldGet(this, _SessionEngine_customizationBusyModes, "f").push(busyId);
             }
         }
@@ -1248,7 +1297,7 @@ class SessionEngine {
             if (!parameterObject)
                 continue;
             // copy into new dictionary
-            requestParameterSet[parameterObject.id] = parameters[parameterIdOrName];
+            requestParameterSet[parameterObject.id] = (' ' + parameterObject.stringify(parameters[parameterIdOrName])).slice(1);
         }
         // seconds step, fill all other parameter values that are currently not set
         const currentParameters = this.parameterValues;
@@ -1273,7 +1322,7 @@ class SessionEngine {
                 this._performanceEvaluator.startSection('sessionResponse');
                 const responseDto = yield this._sdk.utils.submitAndWaitForCustomization(this._sdk, this._sessionId, parameters);
                 this._performanceEvaluator.endSection('sessionResponse');
-                if (loadOutputs === true) {
+                if (loadOutputs === true && this._allowOutputLoading === true) {
                     if (cancelRequest())
                         return new SessionTreeNode_1.SessionTreeNode();
                     if (parallel === true) {
@@ -1288,7 +1337,9 @@ class SessionEngine {
                 }
                 else {
                     // special case, we don't load the outputs and only return the responseDto
-                    return responseDto;
+                    const node = new SessionTreeNode_1.SessionTreeNode();
+                    node.data.push(new SessionData_1.SessionData(responseDto));
+                    return node;
                 }
             }
             catch (e) {
@@ -1299,6 +1350,22 @@ class SessionEngine {
             }
         });
     }
+    /**
+     * Get all file parameters from the parameter set.
+     * If the parameter is not set in the parameter set, the value from the parameter object is used.
+     *
+     * @param parameters
+     * @returns
+     */
+    getFileParameterSet(parameters) {
+        const fileParameterSet = {};
+        for (const parameterId in this.parameters) {
+            if (this.parameters[parameterId] instanceof FileParameter_1.FileParameter) {
+                fileParameterSet[parameterId] = parameters[parameterId] !== undefined ? parameters[parameterId] : this.parameters[parameterId].value;
+            }
+        }
+        return fileParameterSet;
+    }
     handleError(e, retry = false) {
         return __awaiter(this, void 0, void 0, function* () {
             if ((0, sdk_geometry_api_sdk_v2_1.isGBResponseError)(e)) {
@@ -1366,9 +1433,9 @@ class SessionEngine {
         });
     }
     removeBusyMode(busyId) {
-        for (const r in this._stateEngine.renderingEngines) {
-            if (this._stateEngine.renderingEngines[r].busy.includes(busyId))
-                this._stateEngine.renderingEngines[r].busy.splice(this._stateEngine.renderingEngines[r].busy.indexOf(busyId), 1);
+        for (const r in this._stateEngine.viewportEngines) {
+            if (this._stateEngine.viewportEngines[r].busy.includes(busyId))
+                this._stateEngine.viewportEngines[r].busy.splice(this._stateEngine.viewportEngines[r].busy.indexOf(busyId), 1);
             if (__classPrivateFieldGet(this, _SessionEngine_customizationBusyModes, "f").includes(busyId))
                 __classPrivateFieldGet(this, _SessionEngine_customizationBusyModes, "f").splice(__classPrivateFieldGet(this, _SessionEngine_customizationBusyModes, "f").indexOf(busyId), 1);
         }
@@ -1422,16 +1489,16 @@ class SessionEngine {
                 continue;
             this._responseDto.parameters[parameterId].id = parameterId;
             switch (true) {
-                case this._responseDto.parameters[parameterId].type === ISessionEngine_1.PARAMETER_TYPE.BOOL:
+                case this._responseDto.parameters[parameterId].type === viewer_shared_types_1.PARAMETER_TYPE.BOOL:
                     this.parameters[parameterId] = new Parameter_1.Parameter(this._responseDto.parameters[parameterId], this);
                     break;
-                case this._responseDto.parameters[parameterId].type === ISessionEngine_1.PARAMETER_TYPE.COLOR:
+                case this._responseDto.parameters[parameterId].type === viewer_shared_types_1.PARAMETER_TYPE.COLOR:
                     this.parameters[parameterId] = new Parameter_1.Parameter(this._responseDto.parameters[parameterId], this);
                     break;
-                case this._responseDto.parameters[parameterId].type === ISessionEngine_1.PARAMETER_TYPE.FILE:
+                case this._responseDto.parameters[parameterId].type === viewer_shared_types_1.PARAMETER_TYPE.FILE:
                     this.parameters[parameterId] = new FileParameter_1.FileParameter(this._responseDto.parameters[parameterId], this);
                     break;
-                case this._responseDto.parameters[parameterId].type === ISessionEngine_1.PARAMETER_TYPE.EVEN || this._responseDto.parameters[parameterId].type === ISessionEngine_1.PARAMETER_TYPE.FLOAT || this._responseDto.parameters[parameterId].type === ISessionEngine_1.PARAMETER_TYPE.INT || this._responseDto.parameters[parameterId].type === ISessionEngine_1.PARAMETER_TYPE.ODD:
+                case this._responseDto.parameters[parameterId].type === viewer_shared_types_1.PARAMETER_TYPE.EVEN || this._responseDto.parameters[parameterId].type === viewer_shared_types_1.PARAMETER_TYPE.FLOAT || this._responseDto.parameters[parameterId].type === viewer_shared_types_1.PARAMETER_TYPE.INT || this._responseDto.parameters[parameterId].type === viewer_shared_types_1.PARAMETER_TYPE.ODD:
                     this.parameters[parameterId] = new Parameter_1.Parameter(this._responseDto.parameters[parameterId], this);
                     break;
                 default: