import { type SessionCreationDefinition } from "@shapediver/viewer.shared.types"; import { type 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.ignoreUnknownParams Option to allow relaxed validation of parameter identifiers. When set to `true`, unrecognized parameters will be ignored rather than causing an error. (default: false) * @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 ISessionApi.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.directTextureDownload Fetch texture URLs directly in the browser. Texture URLs that are not ShapeDiver assets are downloaded through the Geometry Backend unless this is set. The texture host must allow cross-origin reads. (default: false) * @param properties.excludeViewports Option to exclude some viewports from the start. Can be accessed via {@link ISessionApi.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) * @param properties.modelStateId The optional model state id to use for the session. If not provided, no model state will be loaded. * @param properties.modelStateValidationMode The optional model state validation mode to use for the session. If not provided, the default validation mode of the Geometry SDK will be used. * @returns */ export declare const createSession: (properties: SessionCreationDefinition) => Promise; //# sourceMappingURL=main.d.ts.map