@shapediver/viewer.session 3.0.0

package/dist/interfaces/IParameterApi.d.ts

@@ -0,0 +1,46 @@
+import { ShapeDiverResponseParameter } from '@shapediver/sdk.geometry-api-sdk-v2';
+/**
+ * The api for a parameter of a corresponding [session]{@link ISessionApi}.
+ *
+ * Parameters represent the channels through which data can be input into the model
+ * represented by a session.
+ *
+ * The current value can be changed by setting the {@link value} property.
+ */
+export interface IParameterApi<T> extends ShapeDiverResponseParameter {
+    /**
+     * The value that corresponds to the latest successful call to {@link ISessionApi.customize}.
+     * This property will be updated immediately before {@link ISessionApi.customize} returns.
+     */
+    sessionValue: T | string;
+    /**
+     * The current value.
+     *
+     * Validation happens immediately when setting this property. An error will be thrown in case
+     * validation fails. Use {@link isValid} to test whether a value passes validation.
+     *
+     * In case {@link ISessionApi.automaticSceneUpdate} is true, setting the value will immediately
+     * trigger a customization (see {@link ISessionApi.customize}).
+     */
+    value: T | string;
+    /**
+     * Evaluates if a given value is valid for this parameter.
+     *
+     * @param value the value to evaluate
+     * @param throwError if true, an error is thrown if validation does not pass (default: false)
+     */
+    isValid(value: unknown, throwError?: boolean): boolean;
+    /**
+     * Resets the value to the default value.
+     */
+    resetToDefaultValue(): void;
+    /**
+     * Resets the value to {@link sessionValue}.
+     */
+    resetToSessionValue(): void;
+    /**
+     * Returns the current value as a string
+     */
+    stringify(): string;
+}
+//# sourceMappingURL=IParameterApi.d.ts.map

package/dist/interfaces/IParameterApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IParameterApi.d.ts","sourceRoot":"","sources":["../../src/interfaces/IParameterApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AAElF;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,CAAE,SAAQ,2BAA2B;IAGjE;;;OAGG;IACH,YAAY,EAAE,CAAC,GAAG,MAAM,CAAC;IACzB;;;;;;;;OAQG;IACH,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC;IAMlB;;;;;OAKG;IACH,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IACvD;;OAEG;IACH,mBAAmB,IAAI,IAAI,CAAC;IAC5B;;OAEG;IACH,mBAAmB,IAAI,IAAI,CAAC;IAC5B;;OAEG;IACH,SAAS,IAAI,MAAM,CAAC;CAGvB"}

package/dist/interfaces/IParameterApi.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IParameterApi.js.map

package/dist/interfaces/IParameterApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IParameterApi.js","sourceRoot":"","sources":["../../src/interfaces/IParameterApi.ts"],"names":[],"mappings":""}

package/dist/interfaces/ISessionApi.d.ts

@@ -0,0 +1,477 @@
+import { IExportApi } from './IExportApi';
+import { IOutputApi } from './IOutputApi';
+import { IParameterApi } from './IParameterApi';
+import { ISettingsSections } from '@shapediver/viewer.shared.types';
+import { ITreeNode } from '@shapediver/viewer.shared.node-tree';
+import { ShapeDiverRequestExport, ShapeDiverResponseDto } from '@shapediver/sdk.geometry-api-sdk-v2';
+/**
+ * The api for sessions.
+ *
+ * A session represents an instance of a model hosted on a
+ * {@link https://help.shapediver.com/doc/Geometry-Backend.1863942173.html|ShapeDiver Geometry Backend}.
+ *
+ * Sessions are created by calling {@link createSession}.
+ *
+ * The session contains representations of the model's {@link parameters}, {@link outputs} and {@link exports}.
+ * Each session corresponds to a {@link node} in the scene tree, which reflects the status of the outputs
+ * for the current parameter values.
+ *
+ * On change of parameter values (aka _customizations_), the session makes the necessary calls to the Geometry Backend
+ * to trigger a computation of the model (if required), wait for its completion, download the resulting assets,
+ * and create an updated scene tree.
+ *
+ * A model may define {@link exports}, whose data is not reflected in the scene tree, but can
+ * be requested by functionality of the session.
+ */
+export interface ISessionApi {
+    /**
+     * The [exports]{@link IExportApi} defined by the model.
+     * This object maps export ids to export definitions.
+     */
+    readonly exports: {
+        [key: string]: IExportApi;
+    };
+    /**
+     * The geometry backend model id (guid).
+     * This identifies the model on the Geometry Backend. A {@link jwtToken} is needed for authentication.
+     */
+    readonly guid?: string;
+    /**
+     * The unique identifier of the session that was specified
+     * or automatically chosen on creation of the session.
+     */
+    readonly id: string;
+    /**
+     * The JWT used for authorizing API calls to the Geometry Backend.
+     *
+     * @see setJwtToken
+     */
+    readonly jwtToken: string | undefined;
+    /**
+     * The modelViewUrl of the
+     * {@link https://help.shapediver.com/doc/Geometry-Backend.1863942173.html|ShapeDiver Geometry Backend}
+     * hosting the model.
+     */
+    readonly modelViewUrl: string;
+    /**
+     * The node of the session in the [scene tree]{@link ITree}.
+     */
+    readonly node: ITreeNode;
+    /**
+     * The [outputs]{@link IOutputApi} defined by the model.
+     * This object maps output ids to output definitions.
+     */
+    readonly outputs: {
+        [key: string]: IOutputApi;
+    };
+    /**
+     * The parameter values that are the defaults of the session.
+     * Changing these values does not have any affect. The values in this dictionary only reflect the _defval_ of the [parameters]{@link IParameterApi}.
+     */
+    readonly parameterDefaultValues: {
+        [key: string]: unknown;
+    };
+    /**
+     * The parameter values that were used in the last successful session customization.
+     * These values may not reflect the current state in the [parameters]{@link IParameterApi} if there was a change in parameters after the last customization call.
+     * Changing these values does not have any affect. The values in this dictionary only reflect the _sessionValue_ of the [parameters]{@link IParameterApi}.
+     */
+    readonly parameterSessionValues: {
+        [key: string]: unknown;
+    };
+    /**
+     * The parameter values that are currently set in the API.
+     * These values may not reflect the current state in the scene if there was a change in parameters after the last customization call.
+     * Changing these values does not have any affect. The values in this dictionary only reflect the _value_ of the [parameters]{@link IParameterApi}.
+     */
+    readonly parameterValues: {
+        [key: string]: unknown;
+    };
+    /**
+     * The [parameters]{@link IParameterApi} defined by the model.
+     * This object maps parameter ids to parameter definitions.
+     */
+    readonly parameters: {
+        [key: string]: IParameterApi<unknown>;
+    };
+    /**
+     * The ticket for direct embedding of the model represented by the session.
+     * This identifies the model on the Geometry Backend.
+     */
+    readonly ticket?: string;
+    /**
+     * Option to automatically update the session's scene tree node whenever a customization finishes. (default: true)
+     *
+     * In case this is set to false, the session's scene tree {@link node} will not be automatically replaced
+     * by the node returned from {@link customize}. This can be used to plug the result of {@link customize}
+     * into other parts of the scene tree.
+     */
+    automaticSceneUpdate: boolean;
+    /**
+     * (Platform specific) Option to enable commit-mode for parameters.
+     * This setting is used purely for UI purposes, it does not have any influence on the session itself.
+     */
+    commitParameters: boolean;
+    /**
+     * (Platform specific) Option to enable commit-mode for settings.
+     * This setting is used purely for UI purposes, it does not have any influence on the session itself.
+     */
+    commitSettings: boolean;
+    /**
+     * Option to trigger a call to {@link customize} whenever a parameter value is changed.
+     *
+     * Use this with care as this might max out the rate limit for your model on the Geometry Backend.
+     */
+    customizeOnParameterChange: boolean;
+    /**
+     * The ids of the viewports in which the session's scene tree {@link node} should not be shown.
+     */
+    excludeViewports: string[];
+    /**
+     * Option to load the SDTF data. The data is not loaded by default as it can be quite large. (default: false)
+     */
+    loadSdtf: boolean;
+    /**
+     * Optional callback which can be specified for refreshing the JWT.
+     * This will be called by the session once the JWT expires.
+     * The callback is required to provide a fresh JWT.
+     */
+    refreshJwtToken: (() => Promise<string>) | undefined;
+    /**
+     * A callback that is executed whenever a session's {@link node} is to be replaced
+     * due to an update of the session's content.
+     * Provides the new scene tree node and the old one, so that data can be carried over.
+     * If the callback is a promise it will be awaited in the execution chain.
+     */
+    updateCallback: ((newNode: ITreeNode, oldNode: ITreeNode) => void | Promise<void>) | null;
+    /**
+     * Update all or some settings of the current session and the viewports based on the Geometry Backend
+     * response object of another model.
+     *
+     * @see {@link IViewportApi.sessionSettingsMode}
+     * @see {@link IViewportApi.sessionSettingsId}
+     *
+     * @param response the ShapeDiverResponseDto of the model whose settings shall be applied
+     * @param sections specify true for those parts of the settings that should be applied
+     *
+     * @throws {@link ShapeDiverViewerError}
+     */
+    applySettings(response: ShapeDiverResponseDto, sections?: ISettingsSections): Promise<void>;
+    /**
+     * Check if the session's history allows to go back to a previous state of parameter values.
+     * The session history is recorded whenever {@link customize} is called.
+     *
+     * A further state of parameter values is recorded whenever a successful _customization_ happens.
+     *
+     * @see {@link customize}
+     * @see {@link canGoBack}
+     * @see {@link canGoForward}
+     * @see {@link goBack}
+     * @see {@link goForward}
+     */
+    canGoBack(): boolean;
+    /**
+     * Check if the session's history allows to go forward to a next state of parameter values.
+     * The session history is recorded whenever {@link customize} is called.
+     *
+     * A further state of parameter values is recorded whenever a successful _customization_ happens.
+     *
+     * @see {@link customize}
+     * @see {@link canGoBack}
+     * @see {@link canGoForward}
+     * @see {@link goBack}
+     * @see {@link goForward}
+     */
+    canGoForward(): boolean;
+    /**
+     * Cancel the current customization if there is one in progress.
+     * Requests that were already sent will still be received, but not further processed.
+     */
+    cancelCustomization(): void;
+    /**
+     * Close the session.
+     * This removes the {@link node} from the scene tree and closes the session
+     * with the Geometry Backend.
+     *
+     * @throws {@type ShapeDiverViewerError}
+     */
+    close(): Promise<void>;
+    /**
+     * Convert the session into a glTF file.
+     *
+     * The ground plane and grid will not be included, as well as additionally added data that was added to the scene other than through a {@link GeometryData} property.
+     *
+     * @throws {@type ShapeDiverViewerError}
+     */
+    convertToGlTF(): Promise<Blob>;
+    /**
+     * Customize the session.
+     *
+     * The current state of parameter values is used to request the outputs
+     * of the model from the Geometry Backend. The specific version of an
+     * output for a given set of parameter values is called _output version_.
+     * In case the Geometry Backend has already cached the requested output versions,
+     * it will reply immediately, otherwise a computation request for the missing
+     * output versions of the model will be triggered and awaited.
+     * Once the output versions are available, the resulting assets will be
+     * downloaded, extracted, and the resulting scene tree node will be created.
+     *
+     * Unless {@link automaticSceneUpdate} is set to false, the session's {@link node}
+     * will be updated and viewports will be rendered.
+     *
+     * Independent of {@link automaticSceneUpdate}, right before returning the following
+     * will happen:
+     *
+     *   * for each parameter {@link IParameterApi.sessionValue} will be updated.
+     *   * for each output affected by the customization, {@link IOutputApi.updateCallback}
+     *     will be invoked, and {@link IOutputApi.node} will be updated (outputs for which
+     *     {@link IOutputApi.freeze} is true will be skipped).
+     *
+     * @param parameterValues The set of parameter values to use. Map from parameter id to parameter value. The current value will be used for any parameter not specified.
+     * @param force If force is set to true, the customization call will even be called if no parameters have changed. (Default: false)
+     * @param waitForViewportUpdate If waitForViewportUpdate is set to true, the promise will only resolve when the geometry was processed by the viewport(s) and is visible in the scene. (Default: false)
+     *
+     * @throws {@type ShapeDiverViewerError}
+     */
+    customize(parameterValues?: {
+        [key: string]: unknown;
+    }, force?: boolean, waitForViewportUpdate?: boolean): Promise<ITreeNode>;
+    /**
+     * Customize the session, parallel mode.
+     *
+     * Use this instead of {@link customize} in case you want to run several
+     * _customizations_ in parallel, or you do not want the customization to
+     * affect the current state of the {@link outputs} or {@link parameters}.
+     * The node resulting from this call has to be manually inserted into the scene.
+     *
+     * Calls to this function will not update the session's {@link node}
+     * nor the outputs' {@link IOutputApi.node|nodes}, and also not update
+     * {@link IParameterApi.sessionValue} of the parameters.
+     * Note that {@link IOutputApi.updateCallback} will not be called, and
+     * {@link IOutputApi.freeze} will be ignored.
+     *
+     * @param parameterValues The set of parameter values to use. Map from parameter id to parameter value. The current value will be used for any parameter not specified.
+     *
+     * @throws {@type ShapeDiverViewerError}
+     */
+    customizeParallel(parameterValues: {
+        [key: string]: unknown;
+    }): Promise<ITreeNode>;
+    /**
+     * Customize the session and only receive the result of the customization call.
+     *
+     * Use this instead of {@link customize} in case you want to run
+     * _customizations_ and only work with the data of the customization result
+     *
+     * Calls to this function will not update the session's {@link node}
+     * nor the outputs' {@link IOutputApi.node|nodes}, and also not update
+     * {@link IParameterApi.sessionValue} of the parameters.
+     * Note that {@link IOutputApi.updateCallback} will not be called, and
+     * {@link IOutputApi.freeze} will be ignored.
+     *
+     * @param parameterValues The set of parameter values to use. Map from parameter id to parameter value. The current value will be used for any parameter not specified.
+     *
+     * @throws {@type ShapeDiverViewerError}
+     */
+    customizeResult(parameterValues: {
+        [key: string]: unknown;
+    }): Promise<ShapeDiverResponseDto>;
+    /**
+     * Get an export definition by id.
+     *
+     * @param id The id of the export.
+     */
+    getExportById(id: string): IExportApi | null;
+    /**
+     * Get export definitions by name.
+     * Please note that a model may define multiple exports for a given name.
+     *
+     * @param name The name of the exports.
+     */
+    getExportByName(name: string): IExportApi[];
+    /**
+     * Get export definitions by type.
+     * Please note that a model may define multiple exports for a given type.
+     *
+     * @param type The type of the exports.
+     */
+    getExportByType(type: string): IExportApi[];
+    /**
+     * Get output definitions by format of the output's current content.
+     *
+     * This function filters output definitions by the format of the output's
+     * current content, which depends on the current state of the output's {@link IOutputApi.node}.
+     * The results of this function may vary depending on this state.
+     *
+     * @param format The format of the output's content.
+     */
+    getOutputByFormat(format: string): IOutputApi[];
+    /**
+     * Get an output definition by id.
+     *
+     * @param id The id of the output.
+     */
+    getOutputById(id: string): IOutputApi | null;
+    /**
+     * Get output definitions by name.
+     * Please note that a model may define multiple outputs for a given name.
+     *
+     * @param name The name of the outputs.
+     */
+    getOutputByName(name: string): IOutputApi[];
+    /**
+     * Get parameter definition by id.
+     *
+     * @param id The id of the parameters.
+     */
+    getParameterById(id: string): IParameterApi<unknown> | null;
+    /**
+     * Get parameter definitions by name.
+     * Note that a model may define multiple parameters for a given name.
+     *
+     * @param name The name of the parameters.
+     */
+    getParameterByName(name: string): IParameterApi<unknown>[];
+    /**
+     * Get parameter definitions by type.
+     * Note that a model may define multiple parameters for a given type.
+     *
+     * @param type The type of the parameters.
+     */
+    getParameterByType(type: string): IParameterApi<unknown>[];
+    /**
+     * Go back to the previous recorded state of parameter values.
+     * The session history is recorded whenever {@link customize} is called.
+     *
+     * @see {@link customize}
+     * @see {@link canGoBack}
+     * @see {@link canGoForward}
+     * @see {@link goBack}
+     * @see {@link goForward}
+     *
+     * @throws {@type ShapeDiverViewerError}
+     */
+    goBack(): Promise<ITreeNode>;
+    /**
+     * Go forward to the next recorded state of parameter values.
+     * The session history is recorded whenever {@link customize} is called.
+     *
+     * @see {@link customize}
+     * @see {@link canGoBack}
+     * @see {@link canGoForward}
+     * @see {@link goBack}
+     * @see {@link goForward}
+     *
+     * @throws {@type ShapeDiverViewerError}
+     */
+    goForward(): Promise<ITreeNode>;
+    /**
+     * Load cached outputs to be able to insert them into the scene manually.
+     *
+     * Only outputs that are cached on the backend are loaded.
+     * If an output is not cached, undefined is returned instead.
+     *
+     * @param outputs The set of outputs. Map from output id to output version.
+     *
+     * @throws {@type ShapeDiverViewerError}
+     */
+    loadCachedOutputs(outputs: {
+        [key: string]: string;
+    }): Promise<{
+        [key: string]: ITreeNode | undefined;
+    }>;
+    /**
+     * Request one or multiple exports.
+     *
+     * @param body The body of the export request.
+     * @param body.parameters Parameter values to be used for this export request. Map from parameter id to parameter value. The current value will be used for any parameter not specified.
+     * @param body.exports The ids of the exports to request.
+     * @param body.outputs The ids of the outputs to request.
+     * @param body.max_wait_time Maximum amount of milliseconds to wait for completion of export request before responding.
+     * @param loadOutputs If loadOutputs is set to true, if result of the export request contains outputs, they will be loaded into the session. (Default: false)
+     * @param maxWaitTime Maximum amount of milliseconds to wait for completion of the complete request.
+     *
+     * @throws {@type ShapeDiverViewerError}
+     */
+    requestExports(body: ShapeDiverRequestExport, loadOutputs?: boolean, maxWaitMsec?: number): Promise<ShapeDiverResponseDto>;
+    /**
+     * Reset the parameters to their stored default values and customize the scene.
+     *
+     * @param force If force is set to true, the customization call will even be called if no parameters have changed. (Default: false)
+     *
+     * @throws {@type ShapeDiverViewerError}
+     */
+    resetParameterValues(force?: boolean): Promise<ITreeNode>;
+    /**
+     * Reset all or some settings of the current session and the viewports.
+     *
+     * @param sections specify false for those parts of the settings that should not be applied
+     *
+     * @throws {@type ShapeDiverViewerError}
+     */
+    resetSettings(sections?: ISettingsSections): Promise<void>;
+    /**
+     * Save the current state of parameter values of this session as the default parameter values of the model.
+     *
+     * This call will throw an exception if the ticket and JWT do not grant the required permission to
+     * save parameter default values for the model.
+     *
+     * @throws {@type ShapeDiverViewerError}
+     */
+    saveDefaultParameterValues(): Promise<boolean>;
+    /**
+     * Save the 3D viewport related settings of this session to the model hosted on the Geometry Backend.
+     *
+     * If a viewportId is provided, the settings of that viewport will be used for saving.
+     *
+     * This call will throw an exception if the ticket and JWT do not grant the required permission to
+     * save viewport settings for the model.
+     *
+     * @param viewportId The optional viewport id.
+     *
+     * @throws {@type ShapeDiverViewerError}
+     */
+    saveSettings(viewportId?: string): Promise<boolean>;
+    /**
+     * Save UI-related properties of parameter, output, and export definitions (displayname, order, hidden and tooltip, etc).
+     *
+     * This call will throw an exception if the ticket and JWT do not grant the required permissions for the model.
+     *
+     * @throws {@type ShapeDiverViewerError}
+     */
+    saveUiProperties(): Promise<boolean>;
+    /**
+     * Set a new JWT used for authorizing API calls to the Geometry Backend.
+     * If a change of the JWT would result in different parameters / exports / outputs of the model,
+     * please create a new session with that token instead.
+     *
+     * @see jwtToken
+     * @param token
+     */
+    setJwtToken(token: string): Promise<void>;
+    /**
+     * Update the current available outputs.
+     * Calling this function makes sense if you have updated one of
+     * the outputs manually by calling {@link IOutputApi.updateOutputContent}.
+     *
+     * @param waitForViewportUpdate If waitForViewportUpdate is set to true, the promise will only resolve when the geometry was processed by the viewport(s) and is visible in the scene. (Default: false)
+     *
+     * @throws {@type ShapeDiverViewerError}
+     */
+    updateOutputs(waitForViewportUpdate?: boolean): Promise<ITreeNode>;
+    /**
+     * Upload the files that are specified in the provided values.
+     * If a file parameter is not specified in the values, the current value will be used.
+     * The ids of the uploaded files are returned in a map from parameter id to file id.
+     *
+     * Note: The currently set file parameters will be uploaded automatically by {@link customize}, {@link customizeParallel}, {@link requestExports}, and {@link requestExport}.
+
+    * @param values The set of file parameters to upload. If a parameter is not a file parameter, the current value will be used.
+     */
+    uploadFileParameters(values: {
+        [key: string]: string | File | Blob;
+    }): Promise<{
+        [key: string]: string;
+    }>;
+}
+//# sourceMappingURL=ISessionApi.d.ts.map

package/dist/interfaces/ISessionApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISessionApi.d.ts","sourceRoot":"","sources":["../../src/interfaces/ISessionApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAC;AAChE,OAAO,EAAE,uBAAuB,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAErG;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,WAAW;IAGxB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC;KAAE,CAAC;IACjD;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC;KAAE,CAAC;IACjD;;;OAGG;IACH,QAAQ,CAAC,sBAAsB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAC5D;;;;OAIG;IACH,QAAQ,CAAC,sBAAsB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAC5D;;;;OAIG;IACH,QAAQ,CAAC,eAAe,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IACrD;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;KAAE,CAAC;IAChE;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;;;OAMG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;;;OAIG;IACH,0BAA0B,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,eAAe,EAAE,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC;IACrD;;;;;OAKG;IACH,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC;IAM1F;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,QAAQ,EAAE,qBAAqB,EAAE,QAAQ,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5F;;;;;;;;;;;OAWG;IACH,SAAS,IAAI,OAAO,CAAC;IACrB;;;;;;;;;;;OAWG;IACH,YAAY,IAAI,OAAO,CAAC;IACxB;;;OAGG;IACH,mBAAmB,IAAI,IAAI,CAAC;IAC5B;;;;;;OAMG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB;;;;;;OAMG;IACH,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,SAAS,CAAC,eAAe,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,qBAAqB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAC9H;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CAAC,eAAe,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACnF;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CAAC,eAAe,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC9F;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;IAC7C;;;;;OAKG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,EAAE,CAAC;IAC5C;;;;;OAKG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,EAAE,CAAC;IAC5C;;;;;;;;OAQG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE,CAAC;IAChD;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;IAC7C;;;;;OAKG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,EAAE,CAAC;IAC5C;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IAC5D;;;;;OAKG;IACH,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;IAC3D;;;;;OAKG;IACH,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;IAC3D;;;;;;;;;;;OAWG;IACH,MAAM,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC;IAC7B;;;;;;;;;;;OAWG;IACH,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC;IAChC;;;;;;;;;OASG;IACH,iBAAiB,CAAC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAA;KAAE,CAAC,CAAC;IACzG;;;;;;;;;;;;OAYG;IACH,cAAc,CAAC,IAAI,EAAE,uBAAuB,EAAE,WAAW,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC3H;;;;;;OAMG;IACH,oBAAoB,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAC1D;;;;;;OAMG;IACH,aAAa,CAAC,QAAQ,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3D;;;;;;;OAOG;IACH,0BAA0B,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/C;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACpD;;;;;;OAMG;IACH,gBAAgB,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IACrC;;;;;;;OAOG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C;;;;;;;;OAQG;IACH,aAAa,CAAC,qBAAqB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IACnE;;;;;;;;OAQG;IACH,oBAAoB,CAAC,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC,CAAC;CAG7G"}

package/dist/interfaces/ISessionApi.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ISessionApi.js.map

package/dist/interfaces/ISessionApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISessionApi.js","sourceRoot":"","sources":["../../src/interfaces/ISessionApi.ts"],"names":[],"mappings":""}

package/dist/interfaces/data/IOutputApiData.d.ts

@@ -0,0 +1,7 @@
+import { IOutputApi } from '../IOutputApi';
+import { ITreeNodeData } from '@shapediver/viewer.shared.node-tree';
+export interface IOutputApiData extends ITreeNodeData {
+    api: IOutputApi;
+    clone(): IOutputApiData;
+}
+//# sourceMappingURL=IOutputApiData.d.ts.map

package/dist/interfaces/data/IOutputApiData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IOutputApiData.d.ts","sourceRoot":"","sources":["../../../src/interfaces/data/IOutputApiData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAEpE,MAAM,WAAW,cAAe,SAAQ,aAAa;IAGjD,GAAG,EAAE,UAAU,CAAC;IAMhB,KAAK,IAAI,cAAc,CAAC;CAG3B"}

package/dist/interfaces/data/IOutputApiData.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IOutputApiData.js.map

package/dist/interfaces/data/IOutputApiData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IOutputApiData.js","sourceRoot":"","sources":["../../../src/interfaces/data/IOutputApiData.ts"],"names":[],"mappings":""}

package/dist/interfaces/data/ISessionApiData.d.ts

@@ -0,0 +1,7 @@
+import { ISessionApi } from '../ISessionApi';
+import { ITreeNodeData } from '@shapediver/viewer.shared.node-tree';
+export interface ISessionApiData extends ITreeNodeData {
+    api: ISessionApi;
+    clone(): ISessionApiData;
+}
+//# sourceMappingURL=ISessionApiData.d.ts.map

package/dist/interfaces/data/ISessionApiData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISessionApiData.d.ts","sourceRoot":"","sources":["../../../src/interfaces/data/ISessionApiData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAEpE,MAAM,WAAW,eAAgB,SAAQ,aAAa;IAGlD,GAAG,EAAE,WAAW,CAAC;IAMjB,KAAK,IAAI,eAAe,CAAC;CAG5B"}

package/dist/interfaces/data/ISessionApiData.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ISessionApiData.js.map

package/dist/interfaces/data/ISessionApiData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISessionApiData.js","sourceRoot":"","sources":["../../../src/interfaces/data/ISessionApiData.ts"],"names":[],"mappings":""}

package/dist/main.d.ts

@@ -0,0 +1,37 @@
+import { SessionCreationDefinition } from '@shapediver/viewer.creation-control-center.session';
+import { ISessionApi } from './interfaces/ISessionApi';
+/**
+ * The sessions that are currently being used.
+ */
+export declare const sessions: {
+    [key: string]: ISessionApi;
+};
+/**
+ * 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
+ */
+export declare const createSession: (properties: SessionCreationDefinition) => Promise<ISessionApi>;
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+D,yBAAyB,EAAE,MAAM,oDAAoD,CAAC;AAE5J,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AASvD;;GAEG;AACH,eAAO,MAAM,QAAQ,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC;CAAO,CAAC;AAe5D;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,aAAa,eAAsB,yBAAyB,KAAG,QAAQ,WAAW,CAsC9F,CAAC"}