@shapediver/viewer.session-engine.session-engine 2.10.0 → 2.11.0

package/src/implementation/dto/Output.ts

@@ -1,8 +1,8 @@
-import { ShapeDiverResponseModelComputationStatus, ShapeDiverResponseOutput } from "@shapediver/sdk.geometry-api-sdk-v2";
-import { ITreeNode, TreeNode } from "@shapediver/viewer.shared.node-tree";
-import { InputValidator, UuidGenerator, Logger } from "@shapediver/viewer.shared.services";
-import { IOutput, ShapeDiverResponseOutputContent, ShapeDiverResponseOutputChunk } from "../../interfaces/dto/IOutput";
-import { SessionEngine } from "../SessionEngine";
+import { InputValidator, Logger, UuidGenerator } from '@shapediver/viewer.shared.services';
+import { IOutput, ShapeDiverResponseOutputChunk, ShapeDiverResponseOutputContent } from '../../interfaces/dto/IOutput';
+import { ITreeNode, TreeNode } from '@shapediver/viewer.shared.node-tree';
+import { SessionEngine } from '../SessionEngine';
+import { ShapeDiverResponseModelComputationStatus, ShapeDiverResponseOutput } from '@shapediver/sdk.geometry-api-sdk-v2';
 
 export class Output implements IOutput {
   // #region Properties (23)
@@ -47,7 +47,7 @@ export class Output implements IOutput {
 
   // #endregion Constructors (1)
 
-  // #region Public Accessors (28)
+  // #region Public Accessors (30)
 
   public get bbmax(): number[] | undefined {
     return this.#bbmax;
@@ -169,10 +169,15 @@ export class Output implements IOutput {
     this.#version = value;
   }
 
-  // #endregion Public Accessors (28)
+  // #endregion Public Accessors (30)
 
-  // #region Public Methods (3)
+  // #region Public Methods (4)
 
+  public triggerUpdateCallback(newNode?: TreeNode, oldNode?: TreeNode) {
+    if (this.#updateCallback) this.#updateCallback(newNode, oldNode);
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   public updateOutput(newNode?: TreeNode, oldNode?: TreeNode) {
     const outputDef = this.#sessionEngine.outputs[this.id];
     this.updateOutputDefinition(outputDef);
@@ -187,14 +192,10 @@ export class Output implements IOutput {
     }
   }
 
-  public triggerUpdateCallback(newNode?: TreeNode, oldNode?: TreeNode) {
-    if (this.#updateCallback) this.#updateCallback(newNode, oldNode);
-  }
-
-  public async updateOutputContent(outputContent: ShapeDiverResponseOutputContent[], preventUpdate: boolean = false): Promise<ITreeNode | undefined> {
+  public async updateOutputContent(outputContent: ShapeDiverResponseOutputContent[], preventUpdate: boolean = false, waitForViewportUpdate: boolean = false): Promise<ITreeNode | undefined> {
     this.#sessionEngine.outputs[this.id].content = outputContent;
     this.#sessionEngine.outputs[this.id].version = this.#uuidGenerator.create();
-    if (!preventUpdate) await this.#sessionEngine.updateOutputs();
+    if (!preventUpdate) await this.#sessionEngine.updateOutputs(undefined, waitForViewportUpdate);
     return this.node;
   }
 
@@ -218,5 +219,5 @@ export class Output implements IOutput {
     this.#hidden = outputDef.hidden;
   }
 
-  // #endregion Public Methods (3)
+  // #endregion Public Methods (4)
 }

package/src/interfaces/ISessionEngine.ts

@@ -1,5 +1,5 @@
-import { ShapeDiverRequestGltfUploadQueryConversion, ShapeDiverResponseDto, ShapeDiverResponseExport, ShapeDiverResponseOutput, ShapeDiverResponseParameter } from '@shapediver/sdk.geometry-api-sdk-v2';
-import { ITreeNode, TreeNode } from '@shapediver/viewer.shared.node-tree'
+import { ShapeDiverRequestCustomization, ShapeDiverRequestExport, ShapeDiverRequestGltfUploadQueryConversion, ShapeDiverResponseDto, ShapeDiverResponseExport } from '@shapediver/sdk.geometry-api-sdk-v2';
+import { ITreeNode } from '@shapediver/viewer.shared.node-tree';
 import { SettingsEngine } from '@shapediver/viewer.shared.services';
 import { OutputLoaderTaskEventInfo } from '../implementation/OutputLoader';
 import { IExport } from './dto/IExport';
@@ -62,48 +62,53 @@ export enum PARAMETER_VISUALIZATION {
 }
 
 export interface ISettingsSections {
+  // #region Properties (2)
+
   session?: {
-      parameter?: { 
-          /** Option to update the displayname of the parameters (default: false) */
-          displayname?: boolean, 
-          /** Option to update the order of the parameters (default: false) */
-          order?: boolean, 
-          /** Option to update the hidden state of the parameters (default: false) */
-          hidden?: boolean, 
-          /** Option to update the value of the parameters (default: false) */
-          value?: boolean 
-      },
-      export?: { 
-          /** Option to update the displayname of the exports (default: false) */
-          displayname?: boolean, 
-          /** Option to update the order of the exports (default: false) */
-          order?: boolean, 
-          /** Option to update the hidden state of the exports (default: false) */
-          hidden?: boolean 
-      }
+    parameter?: {
+      /** Option to update the displayname of the parameters (default: false) */
+      displayname?: boolean,
+      /** Option to update the order of the parameters (default: false) */
+      order?: boolean,
+      /** Option to update the hidden state of the parameters (default: false) */
+      hidden?: boolean,
+      /** Option to update the value of the parameters (default: false) */
+      value?: boolean
+    },
+    export?: {
+      /** Option to update the displayname of the exports (default: false) */
+      displayname?: boolean,
+      /** Option to update the order of the exports (default: false) */
+      order?: boolean,
+      /** Option to update the hidden state of the exports (default: false) */
+      hidden?: boolean
+    }
   },
   viewport?: {
-      /** Option to update the ar settings (default: false) */
-      ar?: boolean,
-      /** Option to update the scene settings (default: false) */
-      scene?: boolean,
-      /** Option to update the camera settings (default: false) */
-      camera?: boolean,
-      /** Option to update the light settings (default: false) */
-      light?: boolean,
-      /** Option to update the environment settings (default: false) */
-      environment?: boolean
-      /** Option to update the general settings (default: false) */
-      general?: boolean
-      /** Option to update the postprocessing settings (default: false) */
-      postprocessing?: boolean
+    /** Option to update the ar settings (default: false) */
+    ar?: boolean,
+    /** Option to update the scene settings (default: false) */
+    scene?: boolean,
+    /** Option to update the camera settings (default: false) */
+    camera?: boolean,
+    /** Option to update the light settings (default: false) */
+    light?: boolean,
+    /** Option to update the environment settings (default: false) */
+    environment?: boolean
+    /** Option to update the general settings (default: false) */
+    general?: boolean
+    /** Option to update the postprocessing settings (default: false) */
+    postprocessing?: boolean
   }
-};
+
+  // #endregion Properties (2)
+}
 
 export interface ISessionEngine {
-  // #region Properties (11)
+  // #region Properties (13)
 
   readonly jwtToken?: string;
+
   canUploadGLTF: boolean;
   exports: { [key: string]: IExport };
   guid?: string;
@@ -111,36 +116,37 @@ export interface ISessionEngine {
   initialized: boolean;
   modelViewUrl: string;
   outputs: { [key: string]: IOutput };
-  parameters: { [key: string]: IParameter<any> };
+  parameters: { [key: string]: IParameter<unknown> };
   refreshJwtToken: (() => Promise<string>) | undefined;
   settingsEngine: SettingsEngine;
   ticket?: string;
   updateCallback: ((newNode: ITreeNode, oldNode: ITreeNode) => void) | null;
 
-  // #endregion Properties (11)
+  // #endregion Properties (13)
 
-  // #region Public Methods (18)
+  // #region Public Methods (21)
 
   applySettings(response: ShapeDiverResponseDto, sections?: ISettingsSections): void;
   canGoBack(): boolean;
   canGoForward(): boolean;
   close(): Promise<void>;
-  customize(force: boolean): Promise<ITreeNode>;
+  customize(force: boolean, waitForViewportUpdate?: boolean): Promise<ITreeNode>;
   customizeParallel(parameterValues: { [key: string]: string }): Promise<ITreeNode>;
   goBack(): Promise<ITreeNode>;
   goForward(): Promise<ITreeNode>;
   init(parameterValues?: { [key: string]: string; }): Promise<void>;
   loadOutputs(cancelRequest: () => boolean, taskEventInfo: OutputLoaderTaskEventInfo): Promise<ITreeNode>;
   loadOutputsParallel(responseDto: ShapeDiverResponseDto, cancelRequest: () => boolean, taskEventInfo: OutputLoaderTaskEventInfo): Promise<ITreeNode>;
-  requestExport(exportId: string, parameters: { [key: string]: string }, maxWaitTime: number): Promise<ShapeDiverResponseExport>;
+  requestExport(exportId: string, parameters: ShapeDiverRequestCustomization, maxWaitTime: number): Promise<ShapeDiverResponseExport>;
+  requestExports(body: ShapeDiverRequestExport, maxWaitMsec?: number): Promise<ShapeDiverResponseDto>;
   resetSettings(sections?: ISettingsSections): void;
   saveDefaultParameterValues(): Promise<boolean>;
   saveSettings(viewportId?: string): Promise<boolean>;
   saveUiProperties(): Promise<boolean>;
   setJwtToken(token: string): Promise<void>;
-  updateOutputs(taskEventInfo?: OutputLoaderTaskEventInfo): Promise<ITreeNode>;
+  updateOutputs(taskEventInfo?: OutputLoaderTaskEventInfo, waitForViewportUpdate?: boolean): Promise<ITreeNode>;
   uploadFile(parameterId: string, data: File, type: string): Promise<string>;
   uploadGLTF(blob: Blob, conversion?: ShapeDiverRequestGltfUploadQueryConversion): Promise<ShapeDiverResponseDto>;
 
-  // #endregion Public Methods (18)
+  // #endregion Public Methods (21)
 }

package/src/interfaces/dto/IOutput.ts

@@ -39,7 +39,7 @@ export interface IOutput extends ShapeDiverResponseOutput {
     
     triggerUpdateCallback(newNode?: ITreeNode, oldNode?: ITreeNode): void;
     updateOutput(newNode?: ITreeNode, oldNode?: ITreeNode): void;
-    updateOutputContent(content: ShapeDiverResponseOutputContent[], preventUpdate?: boolean): Promise<ITreeNode | undefined>;
+    updateOutputContent(content: ShapeDiverResponseOutputContent[], preventUpdate?: boolean, waitForViewportUpdate?: boolean): Promise<ITreeNode | undefined>;
     updateOutputDefinition(outputDef: ShapeDiverResponseOutput): void;
 
     // #endregion Public Methods (1)