@shapediver/viewer.session-engine.session-engine 3.3.4 → 3.3.7

package/src/implementation/SessionOutputData.ts

@@ -1,44 +0,0 @@
-import { AbstractTreeNodeData } from '@shapediver/viewer.shared.node-tree';
-import { ISessionOutputData } from '../interfaces/ISessionOutputData';
-import { ShapeDiverResponseOutput } from '@shapediver/sdk.geometry-api-sdk-v2';
-
-export class SessionOutputData extends AbstractTreeNodeData implements ISessionOutputData {
-    // #region Properties (1)
-
-    #responseOutput: ShapeDiverResponseOutput;
-
-    // #endregion Properties (1)
-
-    // #region Constructors (1)
-
-    constructor(
-        responseOutput: ShapeDiverResponseOutput,
-        id?: string,
-        version?: string
-    ) {
-        super(id, version);
-        this.#responseOutput = responseOutput;
-    }
-
-    // #endregion Constructors (1)
-
-    // #region Public Getters And Setters (2)
-
-    public get responseOutput(): ShapeDiverResponseOutput {
-        return this.#responseOutput;
-    }
-
-    public set responseOutput(value: ShapeDiverResponseOutput) {
-        this.#responseOutput = value;
-    }
-
-    // #endregion Public Getters And Setters (2)
-
-    // #region Public Methods (1)
-
-    public clone(): ISessionOutputData {
-        return new SessionOutputData(this.responseOutput, this.id, this.version);
-    }
-
-    // #endregion Public Methods (1)
-}

package/src/implementation/SessionTreeNode.ts

@@ -1,44 +0,0 @@
-import { ISessionTreeNode } from '../interfaces/ISessionTreeNode';
-import {
-  ITransformation,
-  ITreeNode,
-  ITreeNodeData,
-  TreeNode
-} from '@shapediver/viewer.shared.node-tree';
-
-export class SessionTreeNode extends TreeNode implements ISessionTreeNode {
-  // #region Properties (1)
-
-  readonly #sessionNode: boolean = true;
-
-  // #endregion Properties (1)
-
-  // #region Constructors (1)
-
-  /**
-   * Special scene graph node for session data. Only to be created internally.
-   * 
-   * @param name the name of the node 
-   * @param parent the parent of this node
-   * @param data the array of data 
-   * @param transformation the array of transformations
-   */
-  constructor(
-    name?: string,
-    parent?: ITreeNode,
-    data?: ITreeNodeData[],
-    transformations?: ITransformation[]
-  ) {
-    super(name, parent, data, transformations);
-  }
-
-  // #endregion Constructors (1)
-
-  // #region Public Getters And Setters (1)
-
-  public get sessionNode(): boolean {
-    return this.#sessionNode;
-  }
-
-  // #endregion Public Getters And Setters (1)
-}

package/src/implementation/dto/Export.ts

@@ -1,231 +0,0 @@
-import {
-  EventEngine,
-  EVENTTYPE,
-  InputValidator,
-  Logger,
-  UuidGenerator
-} from '@shapediver/viewer.shared.services';
-import { IExport } from '../../interfaces/dto/IExport';
-import { ITaskEvent, TASK_TYPE } from '@shapediver/viewer.shared.types';
-import { SessionEngine } from '../SessionEngine';
-import {
-  ShapeDiverResponseExport,
-  ShapeDiverResponseExportContent,
-  ShapeDiverResponseExportDefinitionType,
-  ShapeDiverResponseExportResult,
-  ShapeDiverResponseModelComputationStatus,
-  ShapeDiverResponseParameterGroup
-} from '@shapediver/sdk.geometry-api-sdk-v2';
-
-export class Export implements IExport {
-  // #region Properties (24)
-
-  readonly #eventEngine: EventEngine = EventEngine.instance;
-  readonly #id: string;
-  readonly #inputValidator: InputValidator = InputValidator.instance;
-  readonly #logger: Logger = Logger.instance;
-  readonly #name: string;
-  readonly #sessionEngine: SessionEngine;
-  readonly #type: ShapeDiverResponseExportDefinitionType;
-  readonly #uuidGenerator: UuidGenerator = UuidGenerator.instance;
-
-  #content?: ShapeDiverResponseExportContent[];
-  #delay?: number;
-  #dependency!: string[];
-  #displayname?: string;
-  #filename?: string;
-  #group?: ShapeDiverResponseParameterGroup;
-  #hidden: boolean = false;
-  #maxWaitTime: number = 300000;
-  #msg?: string;
-  #order?: number;
-  #result?: ShapeDiverResponseExportResult;
-  #status_collect?: ShapeDiverResponseModelComputationStatus;
-  #status_computation?: ShapeDiverResponseModelComputationStatus;
-  #tooltip?: string;
-  #uid?: string;
-  #version?: string;
-
-  // #endregion Properties (24)
-
-  // #region Constructors (1)
-
-  constructor(exportDef: ShapeDiverResponseExport, sessionEngine: SessionEngine) {
-    this.#sessionEngine = sessionEngine;
-    this.#id = exportDef.id;
-    this.#name = exportDef.name;
-    this.#type = exportDef.type;
-
-    this.updateExportDefinition(exportDef);
-  }
-
-  // #endregion Constructors (1)
-
-  // #region Public Getters And Setters (24)
-
-  public get content(): ShapeDiverResponseExportContent[] | undefined {
-    return this.#content;
-  }
-
-  public get delay(): number | undefined {
-    return this.#delay;
-  }
-
-  public get dependency(): string[] {
-    return this.#dependency;
-  }
-
-  public get displayname(): string | undefined {
-    return this.#displayname;
-  }
-
-  public set displayname(value: string | undefined) {
-    this.#displayname = value;
-  }
-
-  public get filename(): string | undefined {
-    return this.#filename;
-  }
-
-  public get group(): ShapeDiverResponseParameterGroup | undefined {
-    return this.#group;
-  }
-
-  public get hidden(): boolean {
-    return this.#hidden;
-  }
-
-  public set hidden(value: boolean) {
-    this.#hidden = value;
-  }
-
-  public get id(): string {
-    return this.#id;
-  }
-
-  public get maxWaitTime(): number {
-    return this.#maxWaitTime;
-  }
-
-  public set maxWaitTime(value: number) {
-    this.#maxWaitTime = value;
-  }
-
-  public get msg(): string | undefined {
-    return this.#msg;
-  }
-
-  public get name(): string {
-    return this.#name;
-  }
-
-  public get order(): number | undefined {
-    return this.#order;
-  }
-
-  public set order(value: number | undefined) {
-    this.#order = value;
-  }
-
-  public get result(): ShapeDiverResponseExportResult | undefined {
-    return this.#result;
-  }
-
-  public get status_collect(): ShapeDiverResponseModelComputationStatus | undefined {
-    return this.#status_collect;
-  }
-
-  public get status_computation(): ShapeDiverResponseModelComputationStatus | undefined {
-    return this.#status_computation;
-  }
-
-  public get tooltip(): string | undefined {
-    return this.#tooltip;
-  }
-
-  public set tooltip(value: string | undefined) {
-    this.#tooltip = value;
-  }
-
-  public get type(): ShapeDiverResponseExportDefinitionType {
-    return this.#type;
-  }
-
-  public get uid(): string | undefined {
-    return this.#uid;
-  }
-
-  public get version(): string | undefined {
-    return this.#version;
-  }
-
-  // #endregion Public Getters And Setters (24)
-
-  // #region Public Methods (3)
-
-  public async request(parameterValues: { [key: string]: unknown } = {}): Promise<ShapeDiverResponseExport> {
-    const eventId = this.#uuidGenerator.create();
-    try {
-      const event: ITaskEvent = { type: TASK_TYPE.EXPORT_REQUEST, id: eventId, progress: 0, status: 'Requesting export' };
-      this.#eventEngine.emitEvent(EVENTTYPE.TASK.TASK_START, event);
-
-      if (Object.keys(parameterValues).length === 0) {
-        this.#logger.info(`Export(${this.#id}).request: Sending export request with parameters ${JSON.stringify(parameterValues)}.`);
-      } else {
-        this.#logger.debugLow(`Export(${this.#id}).request: Sending export request.`);
-      }
-
-      const exportDef = await this.#sessionEngine.requestExport(this.id, parameterValues, this.#maxWaitTime);
-      this.updateExportDefinition(exportDef);
-
-      const eventEnd: ITaskEvent = { type: TASK_TYPE.EXPORT_REQUEST, id: eventId, progress: 1, status: 'Returning export' };
-      this.#eventEngine.emitEvent(EVENTTYPE.TASK.TASK_END, eventEnd);
-
-      return exportDef;
-    } catch (e) {
-      const eventEnd: ITaskEvent = { type: TASK_TYPE.EXPORT_REQUEST, id: eventId, progress: 1, status: 'Export request failed' };
-      this.#eventEngine.emitEvent(EVENTTYPE.TASK.TASK_CANCEL, eventEnd);
-
-      throw e;
-    }
-  }
-
-  public updateExport() {
-    const exportDef = this.#sessionEngine.exports[this.id];
-    this.#dependency = exportDef.dependency;
-    this.#uid = exportDef.uid;
-    this.#displayname = exportDef.displayname;
-    this.#order = exportDef.order;
-    this.#hidden = exportDef.hidden;
-    this.#tooltip = exportDef.tooltip;
-    this.#version = exportDef.version;
-    this.#delay = exportDef.delay;
-    this.#content = exportDef.content;
-    this.#msg = exportDef.msg;
-    this.#filename = exportDef.filename;
-    this.#result = exportDef.result;
-    this.#status_computation = exportDef.status_computation;
-    this.#status_collect = exportDef.status_collect;
-    this.#group = exportDef.group;
-  }
-
-  public updateExportDefinition(exportDef: ShapeDiverResponseExport) {
-    this.#dependency = exportDef.dependency;
-    this.#uid = exportDef.uid;
-    this.#displayname = exportDef.displayname;
-    this.#order = exportDef.order;
-    this.#hidden = exportDef.hidden;
-    this.#tooltip = exportDef.tooltip;
-    this.#version = exportDef.version;
-    this.#delay = exportDef.delay;
-    this.#content = exportDef.content;
-    this.#msg = exportDef.msg;
-    this.#filename = exportDef.filename;
-    this.#result = exportDef.result;
-    this.#status_computation = exportDef.status_computation;
-    this.#status_collect = exportDef.status_collect;
-    this.#group = exportDef.group;
-  }
-
-  // #endregion Public Methods (3)
-}

package/src/implementation/dto/FileParameter.ts

@@ -1,117 +0,0 @@
-import * as MimeTypeUtils from '@shapediver/viewer.utils.mime-type';
-import { IFileParameter } from '../../interfaces/dto/IFileParameter';
-import { Logger, ShapeDiverViewerSessionError, UuidGenerator } from '@shapediver/viewer.shared.services';
-import { Parameter } from './Parameter';
-import { SessionEngine } from '../SessionEngine';
-import { ShapeDiverResponseParameter } from '@shapediver/sdk.geometry-api-sdk-v2';
-
-export class FileParameter extends Parameter<File | Blob | string> implements IFileParameter {
-    // #region Properties (3)
-
-    readonly #logger: Logger = Logger.instance;
-    readonly #sessionEngine: SessionEngine;
-    readonly #uuidGenerator: UuidGenerator = UuidGenerator.instance;
-
-    // #endregion Properties (3)
-
-    // #region Constructors (1)
-
-    constructor(paramDef: ShapeDiverResponseParameter, sessionEngine: SessionEngine) {
-        super(paramDef, sessionEngine);
-        this.#sessionEngine = sessionEngine;
-    }
-
-    // #endregion Constructors (1)
-
-    // #region Public Methods (2)
-
-    public async getFilename(fileId?: string): Promise<string | undefined> {
-        // if fileId is undefined and value is undefined, return undefined
-        if (fileId === undefined && this.value === undefined) return;
-
-        // if fileId is undefined and value is a string and is a valid uuid, use the value as fileId
-        if (fileId === undefined && typeof this.value === 'string' && ((this.value.length === 36 && this.#uuidGenerator.validate(this.value)) || this.value === ''))
-            return (await this.#sessionEngine.getFileInfo(this.id, this.value)).filename;
-
-        // if fileId is undefined, return undefined
-        if (fileId === undefined) return;
-
-        return (await this.#sessionEngine.getFileInfo(this.id, fileId)).filename;
-    }
-
-    public async upload(v?: File | Blob | string): Promise<string> {
-        const value = v !== undefined ? v : this.value;
-
-        if (value === undefined) return this.defval;
-        if (typeof value === 'string' && ((value.length === 36 && this.#uuidGenerator.validate(value)) || value === '')) return value;
-
-        // get the type of the file
-        let fileType: string | string[];
-        if (value instanceof File) {
-            if (value.type === '') {
-                // try to get type from file name
-                const types = MimeTypeUtils.guessMimeTypeFromFilename(value.name);
-                if (types.length === 0) {
-                    throw new ShapeDiverViewerSessionError(`Parameter(${this.id}).upload: Error uploading FileParameter, provided File has no type and could not be guessed from filename. Has to be ${this.format}.`);
-                } else {
-                    fileType = types;
-                }
-            } else {
-                fileType = value.type;
-            }
-        } else if (value instanceof Blob) {
-            if (value.type === '') {
-                throw new ShapeDiverViewerSessionError(`Parameter(${this.id}).upload: Error uploading FileParameter, provided File has no type and could not be guessed from filename. Has to be ${this.format}.`);
-            } else {
-                fileType = value.type;
-            }
-        } else {
-            fileType = 'text/plain';
-        }
-
-        /**
-         * Get all possible mime types for the provided fileType.
-         */
-        let types = typeof fileType === 'string' ? [fileType] : fileType;
-        // get all endings that are possible for this type
-        const endings = MimeTypeUtils.mapMimeTypeToFileEndings(types);
-        // get all mimeTypes that are possible for these endings
-        endings.forEach((e: string) => types = types.concat(MimeTypeUtils.guessMimeTypeFromFilename(e)));
-
-        /**
-         * Check if the provided fileType is allowed for this parameter.
-         * If not, throw an error.
-         */
-        let type: string | undefined = undefined;
-        // check if one of the mime types is allowed
-        let allowedType = false;
-        for (let i = 0; i < types.length; i++) {
-            if (this.format?.includes(types[i])) {
-                allowedType = true;
-                type = types[i];
-                break;
-            }
-        }
-
-        // if the type is not allowed, throw an error
-        if (allowedType === false || type === undefined)
-            throw new ShapeDiverViewerSessionError(`Parameter(${this.id}).upload: Error uploading FileParameter, type of data (${fileType}) is not a valid type. Has to be ${this.format}.`);
-
-        // create a File object
-        const data = new File(
-            [
-                typeof value === 'string' ?
-                    new Blob([value], { type: 'text/plain' }) :
-                    value
-            ],
-            value instanceof File && value.name !== undefined ? value.name : '',
-            { type }
-        );
-
-        this.#logger.debug(`Parameter(${this.id}).upload: Uploading FileParameter.`);
-
-        return await this.#sessionEngine.uploadFile(this.id, data, type!);
-    }
-
-    // #endregion Public Methods (2)
-}

package/src/implementation/dto/Output.ts

@@ -1,223 +0,0 @@
-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)
-
-  readonly #id: string;
-  readonly #inputValidator: InputValidator = InputValidator.instance;
-  readonly #logger: Logger = Logger.instance;
-  readonly #name: string;
-  readonly #sessionEngine: SessionEngine;
-  readonly #uuidGenerator: UuidGenerator = UuidGenerator.instance;
-
-  #bbmax?: number[];
-  #bbmin?: number[];
-  #chunks?: ShapeDiverResponseOutputChunk[];
-  #content?: ShapeDiverResponseOutputContent[];
-  #delay?: number;
-  #dependency!: string[];
-  #displayname?: string;
-  #hidden: boolean = false;
-  #material?: string;
-  #msg?: string;
-  #order?: number;
-  #status_collect?: ShapeDiverResponseModelComputationStatus;
-  #status_computation?: ShapeDiverResponseModelComputationStatus;
-  #tooltip?: string;
-  #uid?: string;
-  #updateCallback: ((newNode?: ITreeNode, oldNode?: ITreeNode) => void) | null = null;
-  #version: string;
-
-  // #endregion Properties (23)
-
-  // #region Constructors (1)
-
-  constructor(outputDef: ShapeDiverResponseOutput, sessionEngine: SessionEngine) {
-    this.#sessionEngine = sessionEngine;
-
-    this.#id = outputDef.id;
-    this.#name = outputDef.name;
-    this.#version = outputDef.version;
-    this.updateOutputDefinition(outputDef);
-  }
-
-  // #endregion Constructors (1)
-
-  // #region Public Getters And Setters (30)
-
-  public get bbmax(): number[] | undefined {
-    return this.#bbmax;
-  }
-
-  public get bbmin(): number[] | undefined {
-    return this.#bbmin;
-  }
-
-  public get chunks(): ShapeDiverResponseOutputChunk[] | undefined {
-    return this.#chunks;
-  }
-
-  public get content(): ShapeDiverResponseOutputContent[] | undefined {
-    return this.#content;
-  }
-
-  public set content(value: ShapeDiverResponseOutputContent[] | undefined) {
-    this.#content = value;
-  }
-
-  public get delay(): number | undefined {
-    return this.#delay;
-  }
-
-  public get dependency(): string[] {
-    return this.#dependency;
-  }
-
-  public get displayname(): string | undefined {
-    return this.#displayname;
-  }
-
-  public set displayname(value: string | undefined) {
-    this.#displayname = value;
-  }
-
-  public get format(): string[] {
-    return this.#content ? this.#content.map(c => c.format) : [];
-  }
-
-  public get freeze(): boolean {
-    return this.#sessionEngine.outputsFreeze[this.#id];
-  }
-
-  public set freeze(value: boolean) {
-    this.#sessionEngine.outputsFreeze[this.#id] = value;
-  }
-
-  public get hidden(): boolean {
-    return this.#hidden;
-  }
-
-  public set hidden(value: boolean) {
-    this.#hidden = value;
-  }
-
-  public get id(): string {
-    return this.#id;
-  }
-
-  public get material(): string | undefined {
-    return this.#material;
-  }
-
-  public get msg(): string | undefined {
-    return this.#msg;
-  }
-
-  public get name(): string {
-    return this.#name;
-  }
-
-  public get node(): ITreeNode {
-    return this.#sessionEngine.node.children.find(c => c.name === this.id)!;
-  }
-
-  public get order(): number | undefined {
-    return this.#order;
-  }
-
-  public set order(value: number | undefined) {
-    this.#order = value;
-  }
-
-  public get status_collect(): ShapeDiverResponseModelComputationStatus | undefined {
-    return this.#status_collect;
-  }
-
-  public get status_computation(): ShapeDiverResponseModelComputationStatus | undefined {
-    return this.#status_computation;
-  }
-
-  public get tooltip(): string | undefined {
-    return this.#tooltip;
-  }
-
-  public set tooltip(value: string | undefined) {
-    this.#tooltip = value;
-  }
-
-  public get uid(): string | undefined {
-    return this.#uid;
-  }
-
-  public get updateCallback(): ((newNode?: ITreeNode, oldNode?: ITreeNode) => void) | null {
-    return this.#updateCallback;
-  }
-
-  public set updateCallback(value: ((newNode?: ITreeNode, oldNode?: ITreeNode) => void) | null) {
-    this.#updateCallback = value;
-  }
-
-  public get version(): string {
-    return this.#version;
-  }
-
-  public set version(value: string) {
-    this.#version = value;
-  }
-
-  // #endregion Public Getters And Setters (30)
-
-  // #region Public Methods (4)
-
-  public async triggerUpdateCallback(newNode?: TreeNode, oldNode?: TreeNode) {
-    if (this.#updateCallback) await Promise.resolve(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);
-
-    // add chunk nodes
-    if (this.chunks && newNode) {
-      for (let i = 0; i < newNode.children.length; i++) {
-        for (let j = 0; j < this.chunks.length; j++) {
-          this.chunks[j].node = newNode.children[i].children.find(child => child.name === this.chunks![j].id);
-        }
-      }
-    }
-  }
-
-  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(undefined, waitForViewportUpdate);
-    return this.node;
-  }
-
-  public updateOutputDefinition(outputDef: ShapeDiverResponseOutput) {
-    this.#dependency = outputDef.dependency;
-    this.#uid = outputDef.uid;
-    this.#material = outputDef.material;
-    this.#chunks = outputDef.chunks;
-    this.#msg = outputDef.msg;
-    if (this.#msg !== undefined)
-      this.#logger.warn(`Output(${this.id}): ${this.#msg}`);
-    this.#bbmin = outputDef.bbmin;
-    this.#bbmax = outputDef.bbmax;
-    this.#status_computation = outputDef.status_computation;
-    this.#status_collect = outputDef.status_collect;
-    this.#content = outputDef.content;
-    this.#delay = outputDef.delay;
-    this.#version = outputDef.version;
-    this.#displayname = outputDef.displayname;
-    this.#order = outputDef.order;
-    this.#hidden = outputDef.hidden;
-  }
-
-  // #endregion Public Methods (4)
-}