@shapediver/viewer.session 3.0.0

package/dist/main.js

@@ -0,0 +1,96 @@
+"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.createSession = exports.sessions = void 0;
+const viewer_creation_control_center_session_1 = require("@shapediver/viewer.creation-control-center.session");
+const viewer_shared_services_1 = require("@shapediver/viewer.shared.services");
+const SessionApi_1 = require("./implementation/SessionApi");
+const viewer_api_general_1 = require("@shapediver/viewer.api.general");
+const creationControlCenterSession = viewer_creation_control_center_session_1.CreationControlCenterSession.instance;
+const inputValidator = viewer_shared_services_1.InputValidator.instance;
+const logger = viewer_shared_services_1.Logger.instance;
+/**
+ * The sessions that are currently being used.
+ */
+exports.sessions = {};
+// Whenever a session or viewport is added or removed, this update is called.
+creationControlCenterSession.updateSessions = (sessionEngines) => {
+    for (const s in sessionEngines)
+        if (!exports.sessions[s])
+            exports.sessions[s] = new SessionApi_1.SessionApi(sessionEngines[s]);
+    for (const s in exports.sessions)
+        if (!sessionEngines[s])
+            delete exports.sessions[s];
+};
+/**
+ * Create and initialize a session with a model hosted on a
+ * {@link https://help.shapediver.com/doc/Geometry-Backend.1863942173.html|ShapeDiver Geometry Backend},
+ * using the provided ticket/guid and modelViewUrl.
+ * Returns a session api object allowing to control the session.
+ *
+ * A JWT can be specified for authorizing the API calls to the Geometry Backend.
+ * The model's settings on the Geometry Backend might require a JWT to be provided.
+ *
+ * By default the outputs of the model for its default parameter values will be loaded.
+ *
+ * An optional identifier for the session can be provided. This identifier can be used to retrieve the
+ * api object from {@link sessions}. In case no identifier is provided, a unique one will be generated.
+ *
+ * @param properties.ticket The ticket for direct embedding of the model represented by the session. This identifies the model on the Geometry Backend. If no ticket was provided, a {@link guid} has to be provided instead.
+ * @param properties.guid The geometry backend model id (guid). This identifies the model on the Geometry Backend. A {@link jwtToken} is needed for authentication. If no guid was provided, a {@link ticket} has to be provided instead.
+ * @param properties.modelViewUrl The modelViewUrl of the {@link https://help.shapediver.com/doc/Geometry-Backend.1863942173.html|ShapeDiver Geometry Backend} hosting the model.
+ * @param properties.jwtToken The JWT to use for authorizing the API calls to the Geometry Backend.
+ * @param properties.id The unique identifier to use for the session.
+ * @param properties.waitForOutputs Option to wait for the outputs to be loaded, or return immediately after creation of the session. (default: true)
+ * @param properties.loadOutputs Option to load the outputs, or not load them until the first call of {@link ISession.customize}. (default: true)
+ * @param properties.loadSdtf Option to load the SDTF data. The data is not loaded by default as it can be quite large. (default: false)
+ * @param properties.excludeViewports Option to exclude some viewports from the start. Can be accessed via {@link ISession.excludeViewports}.
+ * @param properties.initialParameterValues The initial set of parameter values to use. Map from parameter id to parameter value. The default value will be used for any parameter not specified.
+ * @param properties.allowOutputLoading Option to allow the outputs to be loaded, or to prevent them from being loaded. (default: true)
+ * @returns
+ */
+const createSession = (properties) => __awaiter(void 0, void 0, void 0, function* () {
+    (0, viewer_api_general_1.showConsoleMessage)();
+    logger.debug(`createSession: Creating and initializing session with properties ${JSON.stringify(properties)}.`);
+    // input validation
+    inputValidator.validateAndError('createSession', properties, 'object');
+    inputValidator.validateAndError('createSession', properties.ticket, 'string', false);
+    inputValidator.validateAndError('createSession', properties.guid, 'string', false);
+    inputValidator.validateAndError('createSession', properties.modelViewUrl, 'string');
+    inputValidator.validateAndError('createSession', properties.jwtToken, 'string', false);
+    inputValidator.validateAndError('createSession', properties.id, 'string', false);
+    inputValidator.validateAndError('createSession', properties.waitForOutputs, 'boolean', false);
+    inputValidator.validateAndError('createSession', properties.loadOutputs, 'boolean', false);
+    inputValidator.validateAndError('createSession', properties.loadSdtf, 'boolean', false);
+    inputValidator.validateAndError('createSession', properties.excludeViewports, 'stringArray', false);
+    inputValidator.validateAndError('createSession', properties.initialParameterValues, 'object', false);
+    if (properties.initialParameterValues)
+        for (const p in properties.initialParameterValues)
+            inputValidator.validateAndError('createSession', properties.initialParameterValues[p], 'string');
+    // we either expect a ticket or guid + jwtToken, error if we get both
+    if (properties.ticket !== undefined && properties.guid !== undefined)
+        throw new viewer_shared_services_1.ShapeDiverViewerSessionError('createSession: A ticket and a guid were provided for the session creation. Please only provide one or the other. The session was not created.');
+    // we either expect a ticket or guid + jwtToken, error if we get none
+    if (properties.ticket === undefined && properties.guid === undefined)
+        throw new viewer_shared_services_1.ShapeDiverViewerSessionError('createSession: Neither a ticket nor a guid were provided for the session creation. Please provide one or the other. The session was not created.');
+    // we either expect a guid + jwtToken, error if the jwtToken is missing
+    if (properties.guid !== undefined && properties.jwtToken === undefined)
+        throw new viewer_shared_services_1.ShapeDiverViewerSessionError('createSession: When creating a session with a guid, a jwtToken is required, please provide one. The session was not created.');
+    if (properties.waitForOutputs === undefined)
+        properties.waitForOutputs = true;
+    if (properties.loadOutputs === undefined)
+        properties.loadOutputs = true;
+    const sessionEngine = yield creationControlCenterSession.createSessionEngine(properties);
+    exports.sessions[sessionEngine.id] = new SessionApi_1.SessionApi(sessionEngine);
+    return exports.sessions[sessionEngine.id];
+});
+exports.createSession = createSession;
+//# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+GAA4J;AAC5J,+EAA0G;AAE1G,4DAAyD;AAEzD,uEAAoE;AAEpE,MAAM,4BAA4B,GAAkC,qEAA4B,CAAC,QAAQ,CAAC;AAC1G,MAAM,cAAc,GAAmB,uCAAc,CAAC,QAAQ,CAAC;AAC/D,MAAM,MAAM,GAAW,+BAAM,CAAC,QAAQ,CAAC;AAEvC;;GAEG;AACU,QAAA,QAAQ,GAAoC,EAAE,CAAC;AAE5D,6EAA6E;AAC7E,4BAA4B,CAAC,cAAc,GAAG,CAC1C,cAAiD,EACnD,EAAE;IACA,KAAK,MAAM,CAAC,IAAI,cAAc;QAC1B,IAAI,CAAC,gBAAQ,CAAC,CAAC,CAAC;YACZ,gBAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,uBAAU,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;IAExD,KAAK,MAAM,CAAC,IAAI,gBAAQ;QACpB,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;YAClB,OAAO,gBAAQ,CAAC,CAAC,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACI,MAAM,aAAa,GAAG,CAAO,UAAqC,EAAwB,EAAE;IAC/F,IAAA,uCAAkB,GAAE,CAAC;IAErB,MAAM,CAAC,KAAK,CAAC,oEAAoE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAChH,mBAAmB;IACnB,cAAc,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IACvE,cAAc,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IACrF,cAAc,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IACnF,cAAc,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IACpF,cAAc,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IACvF,cAAc,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,CAAC,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IACjF,cAAc,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,CAAC,cAAc,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;IAC9F,cAAc,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,CAAC,WAAW,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;IAC3F,cAAc,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,CAAC,QAAQ,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;IACxF,cAAc,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,CAAC,gBAAgB,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;IACpG,cAAc,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,CAAC,sBAAsB,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IACrG,IAAI,UAAU,CAAC,sBAAsB;QACjC,KAAK,MAAM,CAAC,IAAI,UAAU,CAAC,sBAAsB;YAC7C,cAAc,CAAC,gBAAgB,CAAC,eAAe,EAAE,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;IAEzG,qEAAqE;IACrE,IAAI,UAAU,CAAC,MAAM,KAAK,SAAS,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS;QAChE,MAAM,IAAI,qDAA4B,CAAC,+IAA+I,CAAC,CAAC;IAE5L,qEAAqE;IACrE,IAAI,UAAU,CAAC,MAAM,KAAK,SAAS,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS;QAChE,MAAM,IAAI,qDAA4B,CAAC,kJAAkJ,CAAC,CAAC;IAE/L,uEAAuE;IACvE,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS;QAClE,MAAM,IAAI,qDAA4B,CAAC,8HAA8H,CAAC,CAAC;IAE3K,IAAI,UAAU,CAAC,cAAc,KAAK,SAAS;QAAE,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC;IAC9E,IAAI,UAAU,CAAC,WAAW,KAAK,SAAS;QAAE,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC;IAExE,MAAM,aAAa,GAAG,MAAM,4BAA4B,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IACzF,gBAAQ,CAAC,aAAa,CAAC,EAAE,CAAC,GAAG,IAAI,uBAAU,CAAC,aAAa,CAAC,CAAC;IAC3D,OAAO,gBAAQ,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;AACtC,CAAC,CAAA,CAAC;AAtCW,QAAA,aAAa,iBAsCxB"}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@shapediver/viewer.session",
+  "version": "3.0.0",
+  "description": "",
+  "keywords": [
+    "webgl",
+    "shapediver",
+    "viewer",
+    "augumented-reality",
+    "webgl",
+    "grasshopper",
+    "typescript",
+    "3d"
+  ],
+  "author": "Michael Oppitz <michael@shapediver.com>",
+  "license": "polyform-noncommercial-1.0.0",
+  "main": "dist/index.js",
+  "directories": {
+    "test": "__tests__"
+  },
+  "files": [
+    "dist",
+    "src",
+    "package.json",
+    "README.md",
+    "tsconfig.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shapediver/Viewer.git"
+  },
+  "scripts": {
+    "check": "tsc --noEmit",
+    "build": "bash ../../scripts/building/build.sh",
+    "build-watch": "bash ../../scripts/building/build-watch.sh",
+    "build-dep": "bash ../../scripts/building/build-dep.sh",
+    "doc": "typedoc"
+  },
+  "bugs": {
+    "url": "https://github.com/shapediver/Viewer/issues"
+  },
+  "homepage": "https://github.com/shapediver/Viewer#readme",
+  "typings": "dist/index.d.ts",
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "jsdom"
+  },
+  "dependencies": {
+    "@shapediver/sdk.geometry-api-sdk-v2": "1.8.2",
+    "@shapediver/viewer.api.general": "3.0.0",
+    "@shapediver/viewer.creation-control-center.session": "3.0.0",
+    "@shapediver/viewer.data-engine.gltf-converter": "3.0.0",
+    "@shapediver/viewer.data-engine.shared-types": "3.0.0",
+    "@shapediver/viewer.session-engine.session-engine": "3.0.0",
+    "@shapediver/viewer.shared.math": "3.0.0",
+    "@shapediver/viewer.shared.node-tree": "3.0.0",
+    "@shapediver/viewer.shared.services": "3.0.0"
+  },
+  "gitHead": "b6b0010bf5d5652aa338df8016405d97f33fcabb"
+}

package/src/implementation/ExportApi.ts

@@ -0,0 +1,158 @@
+import { IExport } from '@shapediver/viewer.session-engine.session-engine';
+import { IExportApi } from '../interfaces/IExportApi';
+import { InputValidator, Logger } from '@shapediver/viewer.shared.services';
+import {
+    ShapeDiverResponseExport,
+    ShapeDiverResponseExportContent,
+    ShapeDiverResponseExportDefinitionType,
+    ShapeDiverResponseExportResult,
+    ShapeDiverResponseModelComputationStatus,
+    ShapeDiverResponseParameterGroup
+} from '@shapediver/sdk.geometry-api-sdk-v2';
+
+export class ExportApi implements IExportApi {
+    // #region Properties (3)
+
+    readonly #export: IExport;
+    readonly #inputValidator: InputValidator = InputValidator.instance;
+    readonly #logger: Logger = Logger.instance;
+
+    // #endregion Properties (3)
+
+    // #region Constructors (1)
+
+    constructor(exportD: IExport) {
+        this.#export = exportD;
+    }
+
+    // #endregion Constructors (1)
+
+    // #region Public Getters And Setters (24)
+
+    public get content(): ShapeDiverResponseExportContent[] | undefined {
+        return this.#export.content;
+    }
+
+    public get delay(): number | undefined {
+        return this.#export.delay;
+    }
+
+    public get dependency(): string[] {
+        return this.#export.dependency;
+    }
+
+    public get displayname(): string | undefined {
+        return this.#export.displayname;
+    }
+
+    public set displayname(value: string | undefined) {
+        const scope = 'displayname';
+        this.#inputValidator.validateAndError(`ExportApi.${scope}`, value, 'string', false);
+        this.#export.displayname = value;
+        this.#logger.debug(`ExportApi.${scope}: ${scope} was updated to ${this.#export.displayname}.`);
+    }
+
+    public get filename(): string | undefined {
+        return this.#export.filename;
+    }
+
+    public get group(): ShapeDiverResponseParameterGroup | undefined {
+        return this.#export.group;
+    }
+
+    public get hidden(): boolean {
+        return this.#export.hidden;
+    }
+
+    public set hidden(value: boolean) {
+        const scope = 'hidden';
+        this.#inputValidator.validateAndError(`ExportApi.${scope}`, value, 'boolean');
+        this.#export.hidden = value;
+        this.#logger.debug(`ExportApi.${scope}: ${scope} was updated to ${this.#export.hidden}.`);
+    }
+
+    public get id(): string {
+        return this.#export.id;
+    }
+
+    public get maxWaitTime(): number {
+        return this.#export.maxWaitTime;
+    }
+
+    public set maxWaitTime(value: number) {
+        const scope = 'maxWaitTime';
+        this.#inputValidator.validateAndError(`ExportApi.${scope}`, value, 'number');
+        this.#export.maxWaitTime = value;
+        this.#logger.debug(`ExportApi.${scope}: ${scope} was updated to ${this.#export.maxWaitTime}.`);
+    }
+
+    public get msg(): string | undefined {
+        return this.#export.msg;
+    }
+
+    public get name(): string {
+        return this.#export.name;
+    }
+
+    public get order(): number | undefined {
+        return this.#export.order;
+    }
+
+    public set order(value: number | undefined) {
+        const scope = 'order';
+        this.#inputValidator.validateAndError(`ExportApi.${scope}`, value, 'number', false);
+        this.#export.order = value;
+        this.#logger.debug(`ExportApi.${scope}: ${scope} was updated to ${this.#export.order}.`);
+    }
+
+    public get result(): ShapeDiverResponseExportResult | undefined {
+        return this.#export.result;
+    }
+
+    public get status_collect(): ShapeDiverResponseModelComputationStatus | undefined {
+        return this.#export.status_collect;
+    }
+
+    public get status_computation(): ShapeDiverResponseModelComputationStatus | undefined {
+        return this.#export.status_computation;
+    }
+
+    public get tooltip(): string | undefined {
+        return this.#export.tooltip;
+    }
+
+    public set tooltip(value: string | undefined) {
+        const scope = 'tooltip';
+        this.#inputValidator.validateAndError(`ExportApi.${scope}`, value, 'string', false);
+        this.#export.tooltip = value;
+        this.#logger.debug(`ExportApi.${scope}: ${scope} was updated to ${this.#export.tooltip}.`);
+    }
+
+    public get type(): ShapeDiverResponseExportDefinitionType {
+        return this.#export.type;
+    }
+
+    public get uid(): string | undefined {
+        return this.#export.uid;
+    }
+
+    public get version(): string | undefined {
+        return this.#export.version;
+    }
+
+    // #endregion Public Getters And Setters (24)
+
+    // #region Public Methods (2)
+
+    public async request(parameters: { [key: string]: unknown } = {}): Promise<ShapeDiverResponseExport> {
+        const scope = 'request';
+        this.#inputValidator.validateAndError(`ExportApi.${scope}`, parameters, 'object');
+        return this.#export.request(parameters);
+    }
+
+    public updateExport() {
+        this.#export.updateExport();
+    }
+
+    // #endregion Public Methods (2)
+}

package/src/implementation/FileParameterApi.ts

@@ -0,0 +1,34 @@
+import { IFileParameter } from '@shapediver/viewer.session-engine.session-engine';
+import { IFileParameterApi } from '../interfaces/IFileParameterApi';
+import { Logger } from '@shapediver/viewer.shared.services';
+import { ParameterApi } from './ParameterApi';
+
+export class FileParameterApi extends ParameterApi<File | Blob | string> implements IFileParameterApi {
+    // #region Properties (2)
+
+    readonly #logger: Logger = Logger.instance;
+    readonly #parameter: IFileParameter;
+
+    // #endregion Properties (2)
+
+    // #region Constructors (1)
+
+    constructor(parameter: IFileParameter) {
+        super(parameter);
+        this.#parameter = parameter;
+    }
+
+    // #endregion Constructors (1)
+
+    // #region Public Methods (2)
+
+    public async getFilename(fileId?: string): Promise<string | undefined> {
+        return this.#parameter.getFilename(fileId);
+    }
+
+    public upload(): Promise<string> {
+        return this.#parameter.upload();
+    }
+
+    // #endregion Public Methods (2)
+}

package/src/implementation/OutputApi.ts

@@ -0,0 +1,178 @@
+import { InputValidator, Logger } from '@shapediver/viewer.shared.services';
+import { IOutput, ShapeDiverResponseOutputChunk, ShapeDiverResponseOutputContent } from '@shapediver/viewer.session-engine.session-engine';
+import { IOutputApi } from '../interfaces/IOutputApi';
+import { ITreeNode } from '@shapediver/viewer.shared.node-tree';
+import { OutputApiData } from './data/OutputApiData';
+import { ShapeDiverResponseModelComputationStatus } from '@shapediver/sdk.geometry-api-sdk-v2';
+
+export class OutputApi implements IOutputApi {
+    // #region Properties (3)
+
+    readonly #inputValidator: InputValidator = InputValidator.instance;
+    readonly #logger: Logger = Logger.instance;
+    readonly #output: IOutput;
+
+    // #endregion Properties (3)
+
+    // #region Constructors (1)
+
+    constructor(output: IOutput) {
+        this.#output = output;
+        this.#output.updateCallback = (newNode?: ITreeNode) => {
+            if (newNode && newNode.data.findIndex(d => d instanceof OutputApiData) === -1)
+                newNode.addData(new OutputApiData(this));
+        };
+        this.#output.updateCallback(this.node);
+    }
+
+    // #endregion Constructors (1)
+
+    // #region Public Getters And Setters (28)
+
+    public get bbmax(): number[] | undefined {
+        return this.#output.bbmax;
+    }
+
+    public get bbmin(): number[] | undefined {
+        return this.#output.bbmin;
+    }
+
+    public get chunks(): ShapeDiverResponseOutputChunk[] | undefined {
+        return this.#output.chunks;
+    }
+
+    public get content(): ShapeDiverResponseOutputContent[] | undefined {
+        return this.#output.content;
+    }
+
+    public get delay(): number | undefined {
+        return this.#output.delay;
+    }
+
+    public get dependency(): string[] {
+        return this.#output.dependency;
+    }
+
+    public get displayname(): string | undefined {
+        return this.#output.displayname;
+    }
+
+    public set displayname(value: string | undefined) {
+        const scope = 'displayname';
+        this.#inputValidator.validateAndError(`OutputApi.${scope}`, value, 'string', false);
+        this.#output.displayname = value;
+        this.#logger.debug(`OutputApi.${scope}: ${scope} was updated to ${this.#output.displayname}.`);
+    }
+
+    public get format(): string[] {
+        return this.#output.format;
+    }
+
+    public get freeze(): boolean {
+        return this.#output.freeze;
+    }
+
+    public set freeze(value: boolean) {
+        const scope = 'freeze';
+        this.#inputValidator.validateAndError(`OutputApi.${scope}`, value, 'boolean');
+        this.#output.freeze = value;
+        this.#logger.debug(`OutputApi.${scope}: ${scope} was updated to ${this.#output.freeze}.`);
+    }
+
+    public get hidden(): boolean {
+        return this.#output.hidden;
+    }
+
+    public set hidden(value: boolean) {
+        const scope = 'hidden';
+        this.#inputValidator.validateAndError(`OutputApi.${scope}`, value, 'boolean');
+        this.#output.hidden = value;
+        this.#logger.debug(`OutputApi.${scope}: ${scope} was updated to ${this.#output.hidden}.`);
+    }
+
+    public get id(): string {
+        return this.#output.id;
+    }
+
+    public get material(): string | undefined {
+        return this.#output.material;
+    }
+
+    public get msg(): string | undefined {
+        return this.#output.msg;
+    }
+
+    public get name(): string {
+        return this.#output.name;
+    }
+
+    public get node(): ITreeNode | undefined {
+        return this.#output.node;
+    }
+
+    public get order(): number | undefined {
+        return this.#output.order;
+    }
+
+    public set order(value: number | undefined) {
+        const scope = 'order';
+        this.#inputValidator.validateAndError(`OutputApi.${scope}`, value, 'number', false);
+        this.#output.order = value;
+        this.#logger.debug(`OutputApi.${scope}: ${scope} was updated to ${this.#output.order}.`);
+    }
+
+    public get status_collect(): ShapeDiverResponseModelComputationStatus | undefined {
+        return this.#output.status_collect;
+    }
+
+    public get status_computation(): ShapeDiverResponseModelComputationStatus | undefined {
+        return this.#output.status_computation;
+    }
+
+    public get tooltip(): string | undefined {
+        return this.#output.tooltip;
+    }
+
+    public set tooltip(value: string | undefined) {
+        const scope = 'tooltip';
+        this.#inputValidator.validateAndError(`OutputApi.${scope}`, value, 'string', false);
+        this.#output.tooltip = value;
+        this.#logger.debug(`OutputApi.${scope}: ${scope} was updated to ${this.#output.tooltip}.`);
+    }
+
+    public get uid(): string | undefined {
+        return this.#output.uid;
+    }
+
+    public get updateCallback(): ((newNode?: ITreeNode, oldNode?: ITreeNode) => void | Promise<void>) | null {
+        return this.#output.updateCallback;
+    }
+
+    public set updateCallback(value: ((newNode?: ITreeNode, oldNode?: ITreeNode) => void | Promise<void>) | null) {
+        const scope = 'updateCallback';
+        if (value) this.#inputValidator.validateAndError(`OutputApi.${scope}`, value, 'function', false);
+        this.#output.updateCallback = async (newNode?: ITreeNode, oldNode?: ITreeNode) => {
+            if (newNode && newNode.data.findIndex(d => d instanceof OutputApiData) === -1)
+                newNode.addData(new OutputApiData(this));
+            if (value) await Promise.resolve(value(newNode, oldNode));
+        };
+        this.#logger.debug(`OutputApi.${scope}: ${scope} was updated to ${value}.`);
+    }
+
+    public get version(): string {
+        return this.#output.version;
+    }
+
+    // #endregion Public Getters And Setters (28)
+
+    // #region Public Methods (1)
+
+    public async updateOutputContent(outputContent: ShapeDiverResponseOutputContent[], preventUpdate: boolean = false): Promise<ITreeNode | undefined> {
+        const scope = 'updateOutputContent';
+        this.#inputValidator.validateAndError(`OutputApi.${scope}`, outputContent, 'array');
+        this.#inputValidator.validateAndError(`OutputApi.${scope}`, preventUpdate, 'boolean');
+        return this.#output.updateOutputContent(outputContent, preventUpdate);
+    }
+
+    // #endregion Public Methods (1)
+}