@shapediver/viewer.session-engine.session-engine 3.14.7 → 3.14.9

package/dist/implementation/managers/ModelStateManager.d.ts

@@ -0,0 +1,54 @@
+import { ResGetModelState, ResModelState } from "@shapediver/sdk.geometry-api-sdk-v2";
+import { ITreeNode } from "@shapediver/viewer.shared.node-tree";
+import { SessionEngineCore } from "../SessionEngineCore";
+/**
+ * Manager responsible for model states.
+ *
+ * The manager is created by the SessionEngineCore and can be accessed
+ * via the `modelStateManager` property.
+ */
+export declare class ModelStateManager {
+    private readonly _converter;
+    private readonly _httpClient;
+    private readonly _sessionEngineCore;
+    private _modelState?;
+    private _modelStateId?;
+    private _modelStateValidationMode?;
+    constructor(sessionEngineCore: SessionEngineCore);
+    get modelState(): ResModelState | undefined;
+    set modelState(value: ResModelState | undefined);
+    get modelStateId(): string | undefined;
+    set modelStateId(value: string | undefined);
+    get modelStateValidationMode(): boolean | undefined;
+    set modelStateValidationMode(value: boolean | undefined);
+    /**
+     * Creates a new model state with the given parameter values and optional image and data.
+     *
+     * @param parameterValues Key-value pairs of parameter IDs and their corresponding values
+     * @param omitSessionParameterValues Whether to omit parameters that have not been explicitly set in the session
+     * @param image Optional image to associate with the model state
+     * @param data Optional additional data to associate with the model state
+     * @param arScene Optional AR scene to associate with the model state
+     * @param retry Whether to retry the request in case of failure
+     * @returns Promise with the ID of the created model state
+     */
+    createModelState(parameterValues?: {
+        [key: string]: unknown;
+    }, omitSessionParameterValues?: boolean, image?: (() => string) | (() => Promise<string>) | string | Promise<string> | Blob | File, data?: Record<string, any>, arScene?: (() => Promise<ArrayBuffer>) | ArrayBuffer | (() => Promise<Blob>) | Blob | File, retry?: boolean): Promise<string>;
+    /**
+     * Customizes the session using the provided model state.
+     *
+     * @param modelState The model state ID or the model state response object
+     * @param retry Whether to retry the request in case of failure
+     * @returns Promise with the root tree node of the customized session
+     */
+    customizeWithModelState(modelState: string | ResGetModelState, retry?: boolean): Promise<ITreeNode>;
+    /**
+     * Retrieves a model state by its ID.
+     *
+     * @param modelStateId The ID of the model state to retrieve. If undefined, the current model state ID is used.
+     * @returns Promise with the model state information
+     */
+    getModelState(modelStateId?: string): Promise<ResGetModelState>;
+}
+//# sourceMappingURL=ModelStateManager.d.ts.map

package/dist/implementation/managers/ModelStateManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModelStateManager.d.ts","sourceRoot":"","sources":["../../../src/implementation/managers/ModelStateManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAKN,gBAAgB,EAChB,aAAa,EAEb,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAC,SAAS,EAAW,MAAM,qCAAqC,CAAC;AAOxE,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD;;;;;GAKG;AACH,qBAAa,iBAAiB;IAC7B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAsB;IACjD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAuB;IACnD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAoB;IAEvD,OAAO,CAAC,WAAW,CAAC,CAAgB;IACpC,OAAO,CAAC,aAAa,CAAC,CAAS;IAC/B,OAAO,CAAC,yBAAyB,CAAC,CAAU;gBAEhC,iBAAiB,EAAE,iBAAiB;IAIhD,IAAW,UAAU,IAAI,aAAa,GAAG,SAAS,CAEjD;IAED,IAAW,UAAU,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,EAGrD;IAED,IAAW,YAAY,IAAI,MAAM,GAAG,SAAS,CAE5C;IAED,IAAW,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAEhD;IAED,IAAW,wBAAwB,IAAI,OAAO,GAAG,SAAS,CAEzD;IAED,IAAW,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS,EAE7D;IAED;;;;;;;;;;OAUG;IACU,gBAAgB,CAC5B,eAAe,GAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAM,EAC9C,0BAA0B,GAAE,OAAe,EAC3C,KAAK,CAAC,EACH,CAAC,MAAM,MAAM,CAAC,GACd,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,GACvB,MAAM,GACN,OAAO,CAAC,MAAM,CAAC,GACf,IAAI,GACJ,IAAI,EACP,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC1B,OAAO,CAAC,EACL,CAAC,MAAM,OAAO,CAAC,WAAW,CAAC,CAAC,GAC5B,WAAW,GACX,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,GACrB,IAAI,GACJ,IAAI,EACP,KAAK,UAAQ,GACX,OAAO,CAAC,MAAM,CAAC;IA8GlB;;;;;;OAMG;IACU,uBAAuB,CACnC,UAAU,EAAE,MAAM,GAAG,gBAAgB,EACrC,KAAK,UAAQ,GACX,OAAO,CAAC,SAAS,CAAC;IA+BrB;;;;;OAKG;IACU,aAAa,CACzB,YAAY,CAAC,EAAE,MAAM,GACnB,OAAO,CAAC,gBAAgB,CAAC;CAmB5B"}

package/dist/implementation/managers/ModelStateManager.js

@@ -0,0 +1,177 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelStateManager = void 0;
+const sdk_geometry_api_sdk_v2_1 = require("@shapediver/sdk.geometry-api-sdk-v2");
+const viewer_shared_node_tree_1 = require("@shapediver/viewer.shared.node-tree");
+const viewer_shared_services_1 = require("@shapediver/viewer.shared.services");
+/**
+ * Manager responsible for model states.
+ *
+ * The manager is created by the SessionEngineCore and can be accessed
+ * via the `modelStateManager` property.
+ */
+class ModelStateManager {
+    constructor(sessionEngineCore) {
+        this._converter = viewer_shared_services_1.Converter.instance;
+        this._httpClient = viewer_shared_services_1.HttpClient.instance;
+        this._sessionEngineCore = sessionEngineCore;
+    }
+    get modelState() {
+        return this._modelState;
+    }
+    set modelState(value) {
+        this._modelState = value;
+        this._modelStateId = value === null || value === void 0 ? void 0 : value.id;
+    }
+    get modelStateId() {
+        return this._modelStateId;
+    }
+    set modelStateId(value) {
+        this._modelStateId = value;
+    }
+    get modelStateValidationMode() {
+        return this._modelStateValidationMode;
+    }
+    set modelStateValidationMode(value) {
+        this._modelStateValidationMode = value;
+    }
+    /**
+     * Creates a new model state with the given parameter values and optional image and data.
+     *
+     * @param parameterValues Key-value pairs of parameter IDs and their corresponding values
+     * @param omitSessionParameterValues Whether to omit parameters that have not been explicitly set in the session
+     * @param image Optional image to associate with the model state
+     * @param data Optional additional data to associate with the model state
+     * @param arScene Optional AR scene to associate with the model state
+     * @param retry Whether to retry the request in case of failure
+     * @returns Promise with the ID of the created model state
+     */
+    createModelState(parameterValues = {}, omitSessionParameterValues = false, image, data, arScene, retry = false) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this._sessionEngineCore.utilsManager.checkAvailability();
+            try {
+                const promises = [];
+                // process the parameters
+                const parameterSet = {};
+                promises.push(this._sessionEngineCore.fileUploadManager
+                    .uploadFileParameters(parameterValues)
+                    .then(() => {
+                    // create a set of the current validated parameter values
+                    for (const parameterId in this._sessionEngineCore
+                        .parameterManager.parameters) {
+                        // if the parameter has not been set, we do not include it in the parameter set if the omitSessionParameterValues flag is set
+                        if (!(omitSessionParameterValues === true &&
+                            parameterValues[parameterId] === undefined)) {
+                            parameterSet[parameterId] = (" " +
+                                this._sessionEngineCore.parameterManager.parameters[parameterId].stringify(parameterValues[parameterId])).slice(1);
+                        }
+                    }
+                }));
+                // process the image input
+                let imageData;
+                let imageArrayBuffer;
+                if (image) {
+                    promises.push(this._sessionEngineCore.utilsManager
+                        .processImageInput(image)
+                        .then((result) => {
+                        imageData = result === null || result === void 0 ? void 0 : result.imageData;
+                        imageArrayBuffer = result === null || result === void 0 ? void 0 : result.arrayBuffer;
+                    }));
+                }
+                // process the arScene input
+                let arSceneId;
+                if (arScene) {
+                    promises.push(this._converter
+                        .convertToBlob(arScene)
+                        .then((arSceneBlob) => new sdk_geometry_api_sdk_v2_1.GltfApi(this._sessionEngineCore.sdkConfig).uploadGltf(this._sessionEngineCore.sessionId, new File([arSceneBlob], "arScene.gltf", {
+                        type: "model/gltf-binary",
+                    }), sdk_geometry_api_sdk_v2_1.QueryGltfConversion.SCENE))
+                        .then((arSceneResponseDto) => {
+                        var _a;
+                        arSceneId = (_a = arSceneResponseDto.data.gltf) === null || _a === void 0 ? void 0 : _a.sceneId;
+                    }));
+                }
+                // wait for all promises to resolve
+                yield Promise.all(promises);
+                // create the model state
+                const response = (yield new sdk_geometry_api_sdk_v2_1.ModelStateApi(this._sessionEngineCore.sdkConfig).createModelState(this._sessionEngineCore.sessionId, {
+                    parameters: parameterSet,
+                    data: data,
+                    image: imageData,
+                    arSceneId: arSceneId,
+                })).data;
+                if (imageData && imageArrayBuffer)
+                    yield new sdk_geometry_api_sdk_v2_1.UtilsApi(this._sessionEngineCore.sdkConfig).uploadAsset(response.asset.modelState.href, imageArrayBuffer, response.asset.modelState.headers);
+                return response.modelState.id;
+            }
+            catch (e) {
+                yield this._sessionEngineCore.utilsManager.handleError(e, retry);
+                return yield this.createModelState(parameterValues, omitSessionParameterValues, image, data, arScene, true);
+            }
+        });
+    }
+    /**
+     * Customizes the session using the provided model state.
+     *
+     * @param modelState The model state ID or the model state response object
+     * @param retry Whether to retry the request in case of failure
+     * @returns Promise with the root tree node of the customized session
+     */
+    customizeWithModelState(modelState, retry = false) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this._sessionEngineCore.utilsManager.checkAvailability();
+            try {
+                // get the model state if it is not already a response
+                let response;
+                if (typeof modelState === "string") {
+                    response = (yield new sdk_geometry_api_sdk_v2_1.ModelStateApi(this._sessionEngineCore.sdkConfig).getModelState(modelState)).data;
+                }
+                else {
+                    response = modelState;
+                }
+                if (!response.modelState)
+                    return new viewer_shared_node_tree_1.TreeNode();
+                // read out the parameter values from the model state
+                for (const parameterId in response.modelState.parameters)
+                    this._sessionEngineCore.parameterManager.parameters[parameterId].value = response.modelState.parameters[parameterId];
+                return this._sessionEngineCore.customizationManager.customize();
+            }
+            catch (e) {
+                yield this._sessionEngineCore.utilsManager.handleError(e, retry);
+                return yield this.customizeWithModelState(modelState, true);
+            }
+        });
+    }
+    /**
+     * Retrieves a model state by its ID.
+     *
+     * @param modelStateId The ID of the model state to retrieve. If undefined, the current model state ID is used.
+     * @returns Promise with the model state information
+     */
+    getModelState(modelStateId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this._sessionEngineCore.utilsManager.checkAvailability();
+            try {
+                const id = modelStateId || this._modelStateId;
+                if (!id)
+                    throw new viewer_shared_services_1.ShapeDiverViewerSessionError("Session.getModelState: No model state id available.");
+                const response = (yield new sdk_geometry_api_sdk_v2_1.ModelStateApi(this._sessionEngineCore.sdkConfig).getModelState(id)).data;
+                return response;
+            }
+            catch (e) {
+                throw this._httpClient.convertError(e);
+            }
+        });
+    }
+}
+exports.ModelStateManager = ModelStateManager;
+//# sourceMappingURL=ModelStateManager.js.map

package/dist/implementation/managers/ModelStateManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModelStateManager.js","sourceRoot":"","sources":["../../../src/implementation/managers/ModelStateManager.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iFAQ6C;AAC7C,iFAAwE;AACxE,+EAI4C;AAI5C;;;;;GAKG;AACH,MAAa,iBAAiB;IAS7B,YAAY,iBAAoC;QAR/B,eAAU,GAAG,kCAAS,CAAC,QAAQ,CAAC;QAChC,gBAAW,GAAG,mCAAU,CAAC,QAAQ,CAAC;QAQlD,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;IAC7C,CAAC;IAED,IAAW,UAAU;QACpB,OAAO,IAAI,CAAC,WAAW,CAAC;IACzB,CAAC;IAED,IAAW,UAAU,CAAC,KAAgC;QACrD,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,aAAa,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,EAAE,CAAC;IAChC,CAAC;IAED,IAAW,YAAY;QACtB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC3B,CAAC;IAED,IAAW,YAAY,CAAC,KAAyB;QAChD,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC;IAC5B,CAAC;IAED,IAAW,wBAAwB;QAClC,OAAO,IAAI,CAAC,yBAAyB,CAAC;IACvC,CAAC;IAED,IAAW,wBAAwB,CAAC,KAA0B;QAC7D,IAAI,CAAC,yBAAyB,GAAG,KAAK,CAAC;IACxC,CAAC;IAED;;;;;;;;;;OAUG;IACU,gBAAgB,CAC5B,kBAA4C,EAAE,EAC9C,6BAAsC,KAAK,EAC3C,KAMO,EACP,IAA0B,EAC1B,OAKO,EACP,KAAK,GAAG,KAAK;;YAEb,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,iBAAiB,EAAE,CAAC;YAEzD,IAAI;gBACH,MAAM,QAAQ,GAAG,EAAE,CAAC;gBAEpB,yBAAyB;gBACzB,MAAM,YAAY,GAEd,EAAE,CAAC;gBACP,QAAQ,CAAC,IAAI,CACZ,IAAI,CAAC,kBAAkB,CAAC,iBAAiB;qBACvC,oBAAoB,CAAC,eAAe,CAAC;qBACrC,IAAI,CAAC,GAAG,EAAE;oBACV,yDAAyD;oBACzD,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,kBAAkB;yBAC/C,gBAAgB,CAAC,UAAU,EAAE;wBAC9B,6HAA6H;wBAC7H,IACC,CAAC,CACA,0BAA0B,KAAK,IAAI;4BACnC,eAAe,CAAC,WAAW,CAAC,KAAK,SAAS,CAC1C,EACA;4BACD,YAAY,CAAC,WAAW,CAAC,GAAG,CAC3B,GAAG;gCACH,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,UAAU,CAClD,WAAW,CACX,CAAC,SAAS,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CACzC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;yBACX;qBACD;gBACF,CAAC,CAAC,CACH,CAAC;gBAEF,0BAA0B;gBAC1B,IAAI,SAAwC,CAAC;gBAC7C,IAAI,gBAAyC,CAAC;gBAC9C,IAAI,KAAK,EAAE;oBACV,QAAQ,CAAC,IAAI,CACZ,IAAI,CAAC,kBAAkB,CAAC,YAAY;yBAClC,iBAAiB,CAAC,KAAK,CAAC;yBACxB,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;wBAChB,SAAS,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,CAAC;wBAC9B,gBAAgB,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,CAAC;oBACxC,CAAC,CAAC,CACH,CAAC;iBACF;gBAED,4BAA4B;gBAC5B,IAAI,SAA6B,CAAC;gBAClC,IAAI,OAAO,EAAE;oBACZ,QAAQ,CAAC,IAAI,CACZ,IAAI,CAAC,UAAU;yBACb,aAAa,CAAC,OAAO,CAAC;yBACtB,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CACrB,IAAI,iCAAO,CACV,IAAI,CAAC,kBAAkB,CAAC,SAAS,CACjC,CAAC,UAAU,CACX,IAAI,CAAC,kBAAkB,CAAC,SAAU,EAClC,IAAI,IAAI,CAAC,CAAC,WAAW,CAAC,EAAE,cAAc,EAAE;wBACvC,IAAI,EAAE,mBAAmB;qBACzB,CAAC,EACF,6CAAmB,CAAC,KAAK,CACzB,CACD;yBACA,IAAI,CAAC,CAAC,kBAAkB,EAAE,EAAE;;wBAC5B,SAAS,GAAG,MAAA,kBAAkB,CAAC,IAAI,CAAC,IAAI,0CAAE,OAAO,CAAC;oBACnD,CAAC,CAAC,CACH,CAAC;iBACF;gBAED,mCAAmC;gBACnC,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBAE5B,yBAAyB;gBACzB,MAAM,QAAQ,GAAG,CAChB,MAAM,IAAI,uCAAa,CACtB,IAAI,CAAC,kBAAkB,CAAC,SAAS,CACjC,CAAC,gBAAgB,CAAC,IAAI,CAAC,kBAAkB,CAAC,SAAU,EAAE;oBACtD,UAAU,EAAE,YAAY;oBACxB,IAAI,EAAE,IAAI;oBACV,KAAK,EAAE,SAAS;oBAChB,SAAS,EAAE,SAAS;iBACpB,CAAC,CACF,CAAC,IAAI,CAAC;gBAEP,IAAI,SAAS,IAAI,gBAAgB;oBAChC,MAAM,IAAI,kCAAQ,CACjB,IAAI,CAAC,kBAAkB,CAAC,SAAS,CACjC,CAAC,WAAW,CACZ,QAAQ,CAAC,KAAM,CAAC,UAAW,CAAC,IAAI,EAChC,gBAAgB,EAChB,QAAQ,CAAC,KAAM,CAAC,UAAW,CAAC,OAAO,CACnC,CAAC;gBAEH,OAAO,QAAQ,CAAC,UAAW,CAAC,EAAG,CAAC;aAChC;YAAC,OAAO,CAAC,EAAE;gBACX,MAAM,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBACjE,OAAO,MAAM,IAAI,CAAC,gBAAgB,CACjC,eAAe,EACf,0BAA0B,EAC1B,KAAK,EACL,IAAI,EACJ,OAAO,EACP,IAAI,CACJ,CAAC;aACF;QACF,CAAC;KAAA;IAED;;;;;;OAMG;IACU,uBAAuB,CACnC,UAAqC,EACrC,KAAK,GAAG,KAAK;;YAEb,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,iBAAiB,EAAE,CAAC;YAEzD,IAAI;gBACH,sDAAsD;gBACtD,IAAI,QAA0B,CAAC;gBAC/B,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;oBACnC,QAAQ,GAAG,CACV,MAAM,IAAI,uCAAa,CACtB,IAAI,CAAC,kBAAkB,CAAC,SAAS,CACjC,CAAC,aAAa,CAAC,UAAU,CAAC,CAC3B,CAAC,IAAI,CAAC;iBACP;qBAAM;oBACN,QAAQ,GAAG,UAAU,CAAC;iBACtB;gBAED,IAAI,CAAC,QAAQ,CAAC,UAAU;oBAAE,OAAO,IAAI,kCAAQ,EAAE,CAAC;gBAEhD,qDAAqD;gBACrD,KAAK,MAAM,WAAW,IAAI,QAAQ,CAAC,UAAU,CAAC,UAAU;oBACvD,IAAI,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,UAAU,CAClD,WAAW,CACX,CAAC,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;gBAEvD,OAAO,IAAI,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,SAAS,EAAE,CAAC;aAChE;YAAC,OAAO,CAAC,EAAE;gBACX,MAAM,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;gBACjE,OAAO,MAAM,IAAI,CAAC,uBAAuB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;aAC5D;QACF,CAAC;KAAA;IAED;;;;;OAKG;IACU,aAAa,CACzB,YAAqB;;YAErB,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,iBAAiB,EAAE,CAAC;YACzD,IAAI;gBACH,MAAM,EAAE,GAAG,YAAY,IAAI,IAAI,CAAC,aAAa,CAAC;gBAC9C,IAAI,CAAC,EAAE;oBACN,MAAM,IAAI,qDAA4B,CACrC,qDAAqD,CACrD,CAAC;gBAEH,MAAM,QAAQ,GAAqB,CAClC,MAAM,IAAI,uCAAa,CACtB,IAAI,CAAC,kBAAkB,CAAC,SAAS,CACjC,CAAC,aAAa,CAAC,EAAE,CAAC,CACnB,CAAC,IAAI,CAAC;gBACP,OAAO,QAAQ,CAAC;aAChB;YAAC,OAAO,CAAC,EAAE;gBACX,MAAM,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;aACvC;QACF,CAAC;KAAA;CACD;AArPD,8CAqPC"}

package/dist/implementation/managers/OutputManager.d.ts

@@ -0,0 +1,99 @@
+import { ResBase } from "@shapediver/sdk.geometry-api-sdk-v2";
+import { ITreeNode } from "@shapediver/viewer.shared.node-tree";
+import { ITaskEventDescription } from "@shapediver/viewer.shared.types";
+import { IOutput } from "../../interfaces/dto/IOutput";
+import { ISessionTreeNode } from "../../interfaces/ISessionTreeNode";
+import { SessionEngineCore } from "../SessionEngineCore";
+/**
+ * Manager responsible for outputs.
+ *
+ * The manager is created by the SessionEngineCore and can be accessed
+ * via the `outputManager` property.
+ */
+export declare class OutputManager {
+    private readonly _eventEngine;
+    private readonly _logger;
+    private readonly _outputLoader;
+    private readonly _outputs;
+    private readonly _outputsFreeze;
+    private readonly _sessionEngineCore;
+    private readonly _stateEngine;
+    private readonly _uuidGenerator;
+    private _allowOutputLoading;
+    constructor(sessionEngineCore: SessionEngineCore);
+    init(): void;
+    get allowOutputLoading(): boolean;
+    set allowOutputLoading(value: boolean);
+    get jwtToken(): string | undefined;
+    get loadSdtf(): boolean;
+    get outputs(): {
+        [key: string]: IOutput;
+    };
+    get outputsFreeze(): {
+        [key: string]: boolean;
+    };
+    get reloadSdtf(): boolean;
+    set reloadSdtf(value: boolean);
+    /**
+     * Create outputs from the response DTO.
+     */
+    createOutputsFromDto(): void;
+    getCurrentOutputVersions(): {
+        [key: string]: string;
+    };
+    /**
+     * Load cached outputs in parallel.
+     *
+     * @param outputMapping mapping of output ids to their versions
+     * @param taskEventInfo optional task event info
+     * @param retry whether to retry the request in case of failure
+     * @returns promise with a mapping of output ids to their scene graph nodes
+     */
+    loadCachedOutputsParallel(outputMapping: {
+        [key: string]: string;
+    }, taskEventInfo?: ITaskEventDescription, retry?: boolean): Promise<{
+        [key: string]: ITreeNode | undefined;
+    }>;
+    /**
+     * Load the outputs and return the scene graph node of the result.
+     * In case the outputs have a delay property, another customization request with the parameter set is sent.
+     *
+     * @param parameters the parameter set to update the session
+     * @param outputs the outputs to load
+     * @returns promise with a scene graph node
+     */
+    loadOutputs(cancelRequest: (() => boolean) | undefined, taskEventInfo: ITaskEventDescription, retry?: boolean): Promise<ISessionTreeNode>;
+    /**
+     * Load the outputs and return the scene graph node of the result.
+     * In case the outputs have a delay property, another customization request with the parameter set is sent.
+     *
+     * @param parameters the parameter set to update the session
+     * @param outputs the outputs to load
+     * @returns promise with a scene graph node
+     */
+    loadOutputsParallel(responseDto: ResBase, cancelRequest: (() => boolean) | undefined, taskEventInfo: ITaskEventDescription, retry?: boolean): Promise<ISessionTreeNode>;
+    /**
+     * Save the output properties for displayname, order, tooltip and hidden
+     *
+     * @param outputs
+     * @returns
+     */
+    saveOutputProperties(outputs: {
+        [key: string]: {
+            displayname: string;
+            hidden: boolean;
+            order: number;
+            tooltip: string;
+        };
+    }, retry?: boolean): Promise<boolean>;
+    /**
+     * Update the outputs and return the scene graph node of the result.
+     * In case the outputs have a delay property, another customization request with the parameter set is sent.
+     *
+     * @param taskEventInfo optional task event info
+     * @param waitForViewportUpdate whether to wait for the viewport update callbacks before returning
+     * @returns promise with a scene graph node
+     */
+    updateOutputs(taskEventInfo?: ITaskEventDescription, waitForViewportUpdate?: boolean): Promise<ITreeNode>;
+}
+//# sourceMappingURL=OutputManager.d.ts.map

package/dist/implementation/managers/OutputManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OutputManager.d.ts","sourceRoot":"","sources":["../../../src/implementation/managers/OutputManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,OAAO,EAIP,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAC,SAAS,EAAC,MAAM,qCAAqC,CAAC;AAQ9D,OAAO,EAEN,qBAAqB,EAErB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAC,OAAO,EAAC,MAAM,8BAA8B,CAAC;AACrD,OAAO,EAAC,gBAAgB,EAAC,MAAM,mCAAmC,CAAC;AAKnE,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAGvD;;;;;GAKG;AACH,qBAAa,aAAa;IACzB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAwB;IACrD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA2B;IACnD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAe;IAC7C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgC;IACzD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgC;IAC/D,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAoB;IACvD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqC;IAClE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA0B;IAEzD,OAAO,CAAC,mBAAmB,CAAiB;gBAEhC,iBAAiB,EAAE,iBAAiB;IAKzC,IAAI,IAAI,IAAI;IAInB,IAAW,kBAAkB,IAAI,OAAO,CAEvC;IAED,IAAW,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAE3C;IAED,IAAW,QAAQ,IAAI,MAAM,GAAG,SAAS,CAExC;IAED,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED,IAAW,OAAO,IAAI;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAE7C;IAED,IAAW,aAAa,IAAI;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAEnD;IAED,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED,IAAW,UAAU,CAAC,KAAK,EAAE,OAAO,EAEnC;IAED;;OAEG;IACI,oBAAoB,IAAI,IAAI;IA0B5B,wBAAwB,IAAI;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC;IAI1D;;;;;;;OAOG;IACU,yBAAyB,CACrC,aAAa,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,EACtC,aAAa,CAAC,EAAE,qBAAqB,EACrC,KAAK,UAAQ,GACX,OAAO,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAA;KAAC,CAAC;IAwFlD;;;;;;;OAOG;IACU,WAAW,CACvB,aAAa,SAAQ,OAAO,aAAc,EAC1C,aAAa,EAAE,qBAAqB,EACpC,KAAK,UAAQ,GACX,OAAO,CAAC,gBAAgB,CAAC;IAmE5B;;;;;;;OAOG;IACU,mBAAmB,CAC/B,WAAW,EAAE,OAAO,EACpB,aAAa,SAAQ,OAAO,aAAc,EAC1C,aAAa,EAAE,qBAAqB,EACpC,KAAK,UAAQ,GACX,OAAO,CAAC,gBAAgB,CAAC;IAsF5B;;;;;OAKG;IACU,oBAAoB,CAChC,OAAO,EAAE;QACR,CAAC,GAAG,EAAE,MAAM,GAAG;YACd,WAAW,EAAE,MAAM,CAAC;YACpB,MAAM,EAAE,OAAO,CAAC;YAChB,KAAK,EAAE,MAAM,CAAC;YACd,OAAO,EAAE,MAAM,CAAC;SAChB,CAAC;KACF,EACD,KAAK,UAAQ,GACX,OAAO,CAAC,OAAO,CAAC;IAmBnB;;;;;;;OAOG;IACU,aAAa,CACzB,aAAa,CAAC,EAAE,qBAAqB,EACrC,qBAAqB,GAAE,OAAe,GACpC,OAAO,CAAC,SAAS,CAAC;CAwQrB"}