@shapediver/viewer.shared.types - npm Package Compare versions

Comparing version 3.5.7 to 3.6.0

dist/index.d.ts

@@ -5,3 +5,4 @@ import { AbstractMaterialData } from './implementation/material/AbstractMaterialData';
 import { BoneData } from './implementation/data/BoneData';
-import { Color, ISessionSettingsSections, ISettingsSections, IViewportSettingsSections, PARAMETER_TYPE, PARAMETER_VISUALIZATION } from './types';
+import { BUSY_MODE_DISPLAY, FLAG_TYPE, RENDERER_TYPE, SPINNER_POSITIONING, TEXTURE_ENCODING, TONE_MAPPING, VISIBILITY_MODE } from './interfaces/renderingEngine/enums';
+import { Color, ISessionSettingsSections, ISettingsSections, IViewportSettingsSections, PARAMETER_TYPE, PARAMETER_VISUALIZATION, SessionCreationDefinition, ViewportCreationDefinition } from './types';
 import { CustomData } from './implementation/data/CustomData';
@@ -69,2 +70,4 @@ import { DraggingParameterValue, IDraggableObject, IDraggingParameterProps } from './interfaces/parameter/IDraggingParameterSettings';
 export { InteractionParameterSettingsType, IInteractionParameterProps, IInteractionParameterSettings, IInteractionParameterJsonSchema, validateInteractionParameterSettings, ISelectionParameterProps, SelectionParameterValue, ISelectionParameterJsonSchema, validateSelectionParameterSettings, IGumballParameterProps, GumballParameterValue, IGumballParameterJsonSchema, validateGumballParameterSettings, IDraggingParameterProps, DraggingParameterValue, IDraggingParameterJsonSchema, validateDraggingParameterSettings, IDrawingParameterSettings, DrawingParameterValue, IDrawingParameterJsonSchema, validateDrawingParameterSettings, IDraggableObject, RestrictionDefinition, Rotation };
+export { BUSY_MODE_DISPLAY, FLAG_TYPE, RENDERER_TYPE, SPINNER_POSITIONING, TEXTURE_ENCODING, TONE_MAPPING, VISIBILITY_MODE };
+export { SessionCreationDefinition, ViewportCreationDefinition };
 //# sourceMappingURL=index.d.ts.map

dist/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateDrawingParameterSettings = exports.IDrawingParameterJsonSchema = exports.validateDraggingParameterSettings = exports.IDraggingParameterJsonSchema = exports.validateGumballParameterSettings = exports.IGumballParameterJsonSchema = exports.validateSelectionParameterSettings = exports.ISelectionParameterJsonSchema = exports.validateInteractionParameterSettings = exports.IInteractionParameterJsonSchema = exports.PARAMETER_VISUALIZATION = exports.PARAMETER_TYPE = exports.SdtfPrimitiveTypeGuard = exports.SDTF_TYPEHINT = exports.SDTFItemData = exports.SDTFAttributeData = exports.SDTFAttributesData = exports.SDTFOverviewData = exports.TASK_TYPE = exports.InstanceData = exports.BoneData = exports.CustomData = exports.HTMLElementAnchorData = exports.HTMLElementAnchorImageData = exports.HTMLElementAnchorTextData = exports.HTMLElementAnchorCustomData = exports.PRIMITIVE_MODE = exports.MaterialVariantsData = exports.PrimitiveData = exports.AttributeData = exports.GeometryData = exports.AnimationData = exports.TEXTURE_FILTERING = exports.TEXTURE_WRAPPING = exports.MATERIAL_TYPE = exports.MATERIAL_SHADING = exports.MATERIAL_ALPHA = exports.MATERIAL_SIDE = exports.MapData = exports.MaterialBasicLineData = exports.MaterialMultiPointData = exports.MaterialPointData = exports.MaterialGemData = exports.MaterialSpecularGlossinessData = exports.MaterialShadowData = exports.MaterialUnlitData = exports.AbstractMaterialData = exports.MaterialStandardData = void 0;
+exports.FLAG_TYPE = exports.BUSY_MODE_DISPLAY = exports.validateDrawingParameterSettings = exports.IDrawingParameterJsonSchema = exports.validateDraggingParameterSettings = exports.IDraggingParameterJsonSchema = exports.validateGumballParameterSettings = exports.IGumballParameterJsonSchema = exports.validateSelectionParameterSettings = exports.ISelectionParameterJsonSchema = exports.validateInteractionParameterSettings = exports.IInteractionParameterJsonSchema = exports.PARAMETER_VISUALIZATION = exports.PARAMETER_TYPE = exports.SdtfPrimitiveTypeGuard = exports.SDTF_TYPEHINT = exports.SDTFItemData = exports.SDTFAttributeData = exports.SDTFAttributesData = exports.SDTFOverviewData = exports.TASK_TYPE = exports.InstanceData = exports.BoneData = exports.CustomData = exports.HTMLElementAnchorData = exports.HTMLElementAnchorImageData = exports.HTMLElementAnchorTextData = exports.HTMLElementAnchorCustomData = exports.PRIMITIVE_MODE = exports.MaterialVariantsData = exports.PrimitiveData = exports.AttributeData = exports.GeometryData = exports.AnimationData = exports.TEXTURE_FILTERING = exports.TEXTURE_WRAPPING = exports.MATERIAL_TYPE = exports.MATERIAL_SHADING = exports.MATERIAL_ALPHA = exports.MATERIAL_SIDE = exports.MapData = exports.MaterialBasicLineData = exports.MaterialMultiPointData = exports.MaterialPointData = exports.MaterialGemData = exports.MaterialSpecularGlossinessData = exports.MaterialShadowData = exports.MaterialUnlitData = exports.AbstractMaterialData = exports.MaterialStandardData = void 0;
+exports.VISIBILITY_MODE = exports.TONE_MAPPING = exports.TEXTURE_ENCODING = exports.SPINNER_POSITIONING = exports.RENDERER_TYPE = void 0;
 const AbstractMaterialData_1 = require("./implementation/material/AbstractMaterialData");
@@ -14,2 +15,10 @@ Object.defineProperty(exports, "AbstractMaterialData", { enumerable: true, get: function () { return AbstractMaterialData_1.AbstractMaterialData; } });
 Object.defineProperty(exports, "BoneData", { enumerable: true, get: function () { return BoneData_1.BoneData; } });
+const enums_1 = require("./interfaces/renderingEngine/enums");
+Object.defineProperty(exports, "BUSY_MODE_DISPLAY", { enumerable: true, get: function () { return enums_1.BUSY_MODE_DISPLAY; } });
+Object.defineProperty(exports, "FLAG_TYPE", { enumerable: true, get: function () { return enums_1.FLAG_TYPE; } });
+Object.defineProperty(exports, "RENDERER_TYPE", { enumerable: true, get: function () { return enums_1.RENDERER_TYPE; } });
+Object.defineProperty(exports, "SPINNER_POSITIONING", { enumerable: true, get: function () { return enums_1.SPINNER_POSITIONING; } });
+Object.defineProperty(exports, "TEXTURE_ENCODING", { enumerable: true, get: function () { return enums_1.TEXTURE_ENCODING; } });
+Object.defineProperty(exports, "TONE_MAPPING", { enumerable: true, get: function () { return enums_1.TONE_MAPPING; } });
+Object.defineProperty(exports, "VISIBILITY_MODE", { enumerable: true, get: function () { return enums_1.VISIBILITY_MODE; } });
 const types_1 = require("./types");
@@ -16,0 +25,0 @@ Object.defineProperty(exports, "PARAMETER_TYPE", { enumerable: true, get: function () { return types_1.PARAMETER_TYPE; } });

dist/types.d.ts

 import { ShapeDiverResponseParameterType, ShapeDiverResponseParameterVisualization } from '@shapediver/sdk.geometry-api-sdk-v2';
+import { SESSION_SETTINGS_MODE } from '@shapediver/viewer.shared.services';
 import { vec3, vec4 } from 'gl-matrix';
+import { BUSY_MODE_DISPLAY, SPINNER_POSITIONING, VISIBILITY_MODE } from './interfaces/renderingEngine/enums';
 export declare type Color = string | number | number[] | vec3 | vec4;
@@ -48,2 +50,75 @@ /**
 }
+export declare type SessionCreationDefinition = {
+    /** 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. */
+    ticket?: string;
+    /** 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. */
+    guid?: string;
+    /** The modelViewUrl of the {@link https://help.shapediver.com/doc/Geometry-Backend.1863942173.html|ShapeDiver Geometry Backend} hosting the model. */
+    modelViewUrl: string;
+    /** The JWT used for authorizing API calls to the Geometry Backend. */
+    jwtToken?: string;
+    /** The unique identifier of the session that was specified or automatically chosen on creation of the session. */
+    id?: string;
+    /** Option to wait for the outputs to be loaded, or return immediately after creation of the session. (default: true) */
+    waitForOutputs?: boolean;
+    /** Option to allow the outputs to be loaded, or to prevent them from being loaded. (default: true) */
+    allowOutputLoading?: boolean;
+    /** Option to load the outputs, or not load them until the first call of {@link ISession.customize}. (default: true) */
+    loadOutputs?: boolean;
+    /** Option to load the SDTF data. The data is not loaded by default as it can be quite large. (default: false) */
+    loadSdtf?: boolean;
+    /** Option to exclude some viewports from the start. Can be accessed via {@link ISession.excludeViewports}. */
+    excludeViewports?: string[];
+    /** 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. */
+    initialParameterValues?: {
+        [key: string]: string;
+    };
+    /** The optional model state id to use for the session. If not provided, no model state will be loaded. */
+    modelStateId?: string;
+    /** 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. */
+    modelStateValidationMode?: string;
+    /** Option to throw an error if parts of a customization failed. (default: false) */
+    throwOnCustomizationError?: boolean;
+};
+export declare type ViewportCreationDefinition = {
+    /** The canvas element in which the viewport should be created, it is encourage to provide one. If none was provided, a canvas will be created. */
+    canvas?: HTMLCanvasElement;
+    /** The unique identifier of the session that was specified or automatically chosen on creation of the viewport. */
+    id?: string;
+    /** The branding options of the viewport. */
+    branding?: {
+        /**
+         * Optional URL to a logo to be displayed while the viewport is hidden.
+         * A default logo will be used if none is provided.
+         * Supply null to display no logo at all.
+         */
+        logo?: string | null;
+        /**
+         * Optional background color to show while the viewport is hidden, can include alpha channel.
+         * A default color will be used if none is provided.
+         */
+        backgroundColor?: string;
+        /**
+         * Optional URL to a logo to be displayed while the viewport is in busy mode.
+         * A default logo will be used if none is provided.
+         * The positioning of the spinner can be influenced via {@link SPINNER_POSITIONING}.
+         */
+        busyModeSpinner?: string;
+        /**
+         * The mode used to indicate that the viewport is busy. (default: BUSY_MODE_DISPLAY.SPINNER)
+         * Whenever the busy mode gets toggled, the events {@link EVENTTYPE_VIEWPORT.BUSY_MODE_ON} and {@link EVENTTYPE_VIEWPORT.BUSY_MODE_OFF} will be emitted.
+         */
+        busyModeDisplay?: BUSY_MODE_DISPLAY;
+        /**
+         * Where the spinner that is specified by {@link BUSY_MODE_DISPLAY} is displayed on the screen. (default: BUSY_MODE_DISPLAY.BOTTOM_RIGHT)
+         */
+        spinnerPositioning?: SPINNER_POSITIONING;
+    };
+    /** The id of the session of which the settings should be used. Only works when {@link sessionSettingsMode} is set to {@link SESSION_SETTINGS_MODE.SESSION}. */
+    sessionSettingsId?: string;
+    /** The mode in which settings should be applied. (default: SESSION_SETTINGS_MODE.FIRST) */
+    sessionSettingsMode?: SESSION_SETTINGS_MODE;
+    /** The initial visibility of the viewport. (default: VISIBILITY_MODE.SESSION) */
+    visibility?: VISIBILITY_MODE;
+};
 //# sourceMappingURL=types.d.ts.map

package.json

 {
   "name": "@shapediver/viewer.shared.types",
-  "version": "3.5.7",
+  "version": "3.6.0",
   "description": "",
@@ -43,9 +43,9 @@ "keywords": [],
     "@shapediver/sdk.sdtf-v1": "1.5.3",
-    "@shapediver/viewer.shared.math": "3.5.7",
-    "@shapediver/viewer.shared.node-tree": "3.5.7",
-    "@shapediver/viewer.shared.services": "3.5.7",
+    "@shapediver/viewer.shared.math": "3.6.0",
+    "@shapediver/viewer.shared.node-tree": "3.6.0",
+    "@shapediver/viewer.shared.services": "3.6.0",
     "gl-matrix": "3.3.0",
     "zod": "^3.23.8"
   },
-  "gitHead": "59c8cb124d4c562c450102434c7b301df9ff7cb0"
+  "gitHead": "55ab8adc3bb462e58542778431c3cfb01e5fc77c"
 }

No alert changes

Improved metrics

Total package byte prevSize

559733

increased by1.49%

Lines of code

7750

increased by1.14%

Dependency changes

• + Added@shapediver/viewer.shared.build-data@3.6.0(transitive)

• + Added@shapediver/viewer.shared.math@3.6.0(transitive)

• + Added@shapediver/viewer.shared.node-tree@3.6.0(transitive)

• + Added@shapediver/viewer.shared.services@3.6.0(transitive)

• - Removed@shapediver/viewer.shared.build-data@3.5.7(transitive)

• - Removed@shapediver/viewer.shared.math@3.5.7(transitive)

• - Removed@shapediver/viewer.shared.node-tree@3.5.7(transitive)

• - Removed@shapediver/viewer.shared.services@3.5.7(transitive)

• Updated@shapediver/viewer.shared.math@3.6.0

• Updated@shapediver/viewer.shared.node-tree@3.6.0

• Updated@shapediver/viewer.shared.services@3.6.0