@shapediver/viewer.shared.services 2.9.11 → 2.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shapediver/viewer.shared.services",
-  "version": "2.9.11",
+  "version": "2.10.0",
   "description": "",
   "keywords": [],
   "author": "Michael Oppitz <michael@shapediver.com>",
@@ -40,9 +40,9 @@
   },
   "dependencies": {
     "@ctrl/tinycolor": "^3.4.0",
-    "@shapediver/sdk.geometry-api-sdk-v2": "1.5.1",
-    "@shapediver/viewer.settings": "0.4.2",
-    "@shapediver/viewer.shared.build-data": "2.9.11",
+    "@shapediver/sdk.geometry-api-sdk-v2": "1.6.0",
+    "@shapediver/viewer.settings": "0.5.5",
+    "@shapediver/viewer.shared.build-data": "2.10.0",
     "@types/dompurify": "^2.3.1",
     "@types/ua-parser-js": "^0.7.36",
     "@types/uuid": "^9.0.0",
@@ -52,5 +52,5 @@
     "ua-parser-js": "^0.7.28",
     "uuid": "^9.0.0"
   },
-  "gitHead": "105aa4b6fb6de2e9d4dfac026030207460551c5b"
+  "gitHead": "3969d2d1c56ac1a6fc8fb86906b10a50c872f6a7"
 }

package/src/event-engine/EventTypes.ts

@@ -27,7 +27,9 @@ export enum EVENTTYPE_VIEWPORT {
     VIEWPORT_CREATED = "viewport.created",
     VIEWPORT_UPDATED = "viewport.updated",
     VIEWPORT_CLOSED = "viewport.closed",
-    VIEWPORT_SETTINGS_LOADED = "viewport.settingsLoaded"
+    VIEWPORT_SETTINGS_LOADED = "viewport.settingsLoaded",
+    VIEWPORT_VISIBLE = "viewport.visible",
+    VIEWPORT_HIDDEN = "viewport.hidden",
 }
 
 export enum EVENTTYPE_SESSION {

package/src/http-client/HttpClient.ts

@@ -1,6 +1,6 @@
 import axios, { AxiosRequestConfig } from 'axios'
-import { ShapeDiverError as ShapeDiverBackendError, ShapeDiverResponseError, ShapeDiverRequestError, isGBResponseError, isGBRequestError } from '@shapediver/sdk.geometry-api-sdk-v2'
-import { ShapeDiverGeometryBackendRequestError, ShapeDiverGeometryBackendResponseError } from '../logger/ShapeDiverBackendErrors';
+import { ShapeDiverError as ShapeDiverBackendError, isGBResponseError, isGBRequestError, isGBError } from '@shapediver/sdk.geometry-api-sdk-v2'
+import { ShapeDiverGeometryBackendError, ShapeDiverGeometryBackendRequestError, ShapeDiverGeometryBackendResponseError } from '../logger/ShapeDiverBackendErrors';
 import { HttpResponse } from './HttpResponse';
 
 export class HttpClient {
@@ -54,8 +54,8 @@ export class HttpClient {
             throw new ShapeDiverGeometryBackendResponseError(e.message, e.status, e.error, e.desc);
         } else if (isGBRequestError(e)) {
             throw new ShapeDiverGeometryBackendRequestError(e.message, e.desc)
-        } else {
-            throw e;
+        } else if(isGBError(e)) {
+            throw new ShapeDiverGeometryBackendError(e.message)
         }
     }
 

package/src/index.ts

@@ -14,11 +14,12 @@ import { UuidGenerator } from './uuid-generator/UuidGenerator'
 import { PerformanceEvaluator } from './performance-evaluator/PerformanceEvaluator'
 import { Logger, LOGGING_LEVEL } from './logger/Logger'
 import { StatePromise } from './state-engine/StatePromise'
-import { ShapeDiverViewerArError, ShapeDiverViewerCameraError, ShapeDiverViewerDataProcessingError, ShapeDiverViewerEnvironmentMapError, ShapeDiverViewerLightError, ShapeDiverViewerSessionError, ShapeDiverViewerSettingsError, ShapeDiverViewerUnknownError, ShapeDiverViewerValidationError, ShapeDiverViewerGeneralError, ShapeDiverViewerWebGLError, ShapeDiverViewerInteractionError, ShapeDiverViewerViewportError } from './logger/ShapeDiverViewerErrors'
+import { ShapeDiverViewerArError, ShapeDiverViewerCameraError, ShapeDiverViewerDataProcessingError, ShapeDiverViewerEnvironmentMapError, ShapeDiverViewerLightError, ShapeDiverViewerSessionError, ShapeDiverViewerSettingsError, ShapeDiverViewerUnknownError, ShapeDiverViewerValidationError, ShapeDiverViewerWebGLError, ShapeDiverViewerInteractionError, ShapeDiverViewerViewportError } from './logger/ShapeDiverViewerErrors'
 import { ShapeDiverViewerError, ShapeDiverViewerErrorType } from './logger/ShapeDiverError'
 import { HttpResponse } from './http-client/HttpResponse'
-import { ShapeDiverGeometryBackendRequestError, ShapeDiverGeometryBackendResponseError } from './logger/ShapeDiverBackendErrors'
+import { ShapeDiverGeometryBackendError, ShapeDiverGeometryBackendRequestError, ShapeDiverGeometryBackendResponseError } from './logger/ShapeDiverBackendErrors'
 import { ShapeDiverResponseErrorType as ShapeDiverGeometryBackendResponseErrorType } from "@shapediver/sdk.geometry-api-sdk-v2";
+import { isViewerError, isViewerUnknownError, isViewerDataProcessingError, isViewerEnvironmentMapError, isViewerWebGLError, isViewerSettingsError, isViewerSessionError, isViewerViewportError, isViewerLightError, isViewerCameraError, isARError, isViewerValidationError, isViewerInteractionError, isViewerGeometryBackendError, isViewerGeometryBackendGenericError, isViewerGeometryBackendRequestError, isViewerGeometryBackendResponseError } from './logger/ErrorTypeGuards'
 
 export {
   EventEngine, EVENTTYPE, MainEventTypes, IEvent,
@@ -71,18 +72,38 @@ export {
     ShapeDiverViewerSettingsError,
     ShapeDiverViewerSessionError,
     ShapeDiverViewerViewportError,
-    ShapeDiverViewerGeneralError,
     ShapeDiverViewerUnknownError, 
     ShapeDiverViewerArError,
     ShapeDiverViewerLightError,
     ShapeDiverViewerCameraError,
     ShapeDiverViewerValidationError,
     ShapeDiverViewerInteractionError,
+    ShapeDiverGeometryBackendError,
     ShapeDiverGeometryBackendRequestError,
     ShapeDiverGeometryBackendResponseError,
     ShapeDiverGeometryBackendResponseErrorType
 }
 
+export {
+    isViewerError,
+    isViewerUnknownError,
+    isViewerDataProcessingError,
+    isViewerEnvironmentMapError,
+    isViewerWebGLError,
+    isViewerSettingsError,
+    isViewerSessionError,
+    isViewerViewportError,
+    isViewerLightError,
+    isViewerCameraError,
+    isARError,
+    isViewerValidationError,
+    isViewerInteractionError,
+    isViewerGeometryBackendError,
+    isViewerGeometryBackendGenericError,
+    isViewerGeometryBackendRequestError,
+    isViewerGeometryBackendResponseError
+}
+
 export {
     PerformanceEvaluator
 }

package/src/logger/ErrorTypeGuards.ts

@@ -0,0 +1,123 @@
+import { ShapeDiverGeometryBackendError, ShapeDiverGeometryBackendRequestError, ShapeDiverGeometryBackendResponseError } from "./ShapeDiverBackendErrors"
+import { ShapeDiverViewerError, ShapeDiverViewerErrorType } from "./ShapeDiverError"
+import { ShapeDiverViewerArError, ShapeDiverViewerCameraError, ShapeDiverViewerDataProcessingError, ShapeDiverViewerEnvironmentMapError, ShapeDiverViewerInteractionError, ShapeDiverViewerLightError, ShapeDiverViewerSessionError, ShapeDiverViewerSettingsError, ShapeDiverViewerUnknownError, ShapeDiverViewerValidationError, ShapeDiverViewerViewportError, ShapeDiverViewerWebGLError } from "./ShapeDiverViewerErrors"
+
+/** Type guard for all error types of the viewer package. */
+export function isViewerError(e: any): e is ShapeDiverViewerError {
+    return e instanceof Error &&
+        "errorType" in e &&
+        Object.values(ShapeDiverViewerErrorType).includes((<ShapeDiverViewerError>e).errorType as any)
+}
+
+/** Type guard for an unknown viewer error. */
+export function isViewerUnknownError(e: any): e is ShapeDiverViewerUnknownError {
+    return e instanceof Error &&
+        "errorType" in e &&
+        (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.UNKNOWN
+}
+
+/** Type guard for a data processing viewer error. */
+export function isViewerDataProcessingError(e: any): e is ShapeDiverViewerDataProcessingError {
+    return e instanceof Error &&
+        "errorType" in e &&
+        (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.DATA_PROCESSING_ERROR
+}
+
+/** Type guard for a environment map viewer error. */
+export function isViewerEnvironmentMapError(e: any): e is ShapeDiverViewerEnvironmentMapError {
+    return e instanceof Error &&
+        "errorType" in e &&
+        (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.ENVIRONMENT_MAP_ERROR
+}
+
+/** Type guard for a webGL viewer error. */
+export function isViewerWebGLError(e: any): e is ShapeDiverViewerWebGLError {
+    return e instanceof Error &&
+        "errorType" in e &&
+        (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.WEBGL_ERROR
+}
+
+/** Type guard for a settings viewer error. */
+export function isViewerSettingsError(e: any): e is ShapeDiverViewerSettingsError {
+    return e instanceof Error &&
+        "errorType" in e &&
+        (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.SETTINGS_ERROR
+}
+
+/** Type guard for a session viewer error. */
+export function isViewerSessionError(e: any): e is ShapeDiverViewerSessionError {
+    return e instanceof Error &&
+        "errorType" in e &&
+        (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.SESSION_ERROR
+}
+
+/** Type guard for a viewport viewer error. */
+export function isViewerViewportError(e: any): e is ShapeDiverViewerViewportError {
+    return e instanceof Error &&
+        "errorType" in e &&
+        (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.VIEWPORT_ERROR
+}
+
+/** Type guard for a light viewer error. */
+export function isViewerLightError(e: any): e is ShapeDiverViewerLightError {
+    return e instanceof Error &&
+        "errorType" in e &&
+        (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.LIGHT_ERROR
+}
+
+/** Type guard for a camera viewer error. */
+export function isViewerCameraError(e: any): e is ShapeDiverViewerCameraError {
+    return e instanceof Error &&
+        "errorType" in e &&
+        (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.CAMERA_ERROR
+}
+
+/** Type guard for an AR viewer error. */
+export function isARError(e: any): e is ShapeDiverViewerArError {
+    return e instanceof Error &&
+        "errorType" in e &&
+        (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.AR_ERROR
+}
+
+/** Type guard for a validation viewer error. */
+export function isViewerValidationError(e: any): e is ShapeDiverViewerValidationError {
+    return e instanceof Error &&
+        "errorType" in e &&
+        (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.VALIDATION_ERROR
+}
+
+/** Type guard for a interaction viewer error. */
+export function isViewerInteractionError(e: any): e is ShapeDiverViewerInteractionError {
+    return e instanceof Error &&
+        "errorType" in e &&
+        (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.INTERACTION_ERROR
+}
+
+/** Type guard for all error types of the Geometry Backend SDK package that are mapped to viewer errors. */
+export function isViewerGeometryBackendError(e: any): e is
+    (ShapeDiverGeometryBackendError & ShapeDiverGeometryBackendRequestError & ShapeDiverGeometryBackendResponseError) {
+    return e instanceof Error &&
+        "errorType" in e &&
+        (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.GEOMETRY_BACKEND_ERROR || (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.GEOMETRY_BACKEND_REQUEST_ERROR || (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.GEOMETRY_BACKEND_REQUEST_ERROR
+}
+
+/** Type guard for a Geometry Backend SDK generic error that is mapped to a viewer error. */
+export function isViewerGeometryBackendGenericError(e: any): e is ShapeDiverGeometryBackendError {
+    return e instanceof Error &&
+        "errorType" in e &&
+        (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.GEOMETRY_BACKEND_ERROR
+}
+
+/** Type guard for a Geometry Backend SDK request error that is mapped to a viewer error. */
+export function isViewerGeometryBackendRequestError(e: any): e is ShapeDiverGeometryBackendRequestError {
+    return e instanceof Error &&
+        "errorType" in e &&
+        (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.GEOMETRY_BACKEND_REQUEST_ERROR
+}
+
+/** Type guard for a Geometry Backend SDK response error that is mapped to a viewer error. */
+export function isViewerGeometryBackendResponseError(e: any): e is ShapeDiverGeometryBackendResponseError {
+    return e instanceof Error &&
+        "errorType" in e &&
+        (<ShapeDiverViewerError>e).errorType === ShapeDiverViewerErrorType.GEOMETRY_BACKEND_RESPONSE_ERROR
+}

package/src/logger/ShapeDiverBackendErrors.ts

@@ -26,5 +26,15 @@ export class ShapeDiverGeometryBackendResponseError extends ShapeDiverViewerErro
         super(ShapeDiverViewerErrorType.GEOMETRY_BACKEND_RESPONSE_ERROR, desc, message);
     }
 
+    // #endregion Constructors (1)
+}
+
+export class ShapeDiverGeometryBackendError extends ShapeDiverViewerError {
+    // #region Constructors (1)
+
+    constructor(message: string) {
+        super(ShapeDiverViewerErrorType.GEOMETRY_BACKEND_ERROR, "A generic geometry backend error occurred.", message);
+    }
+
     // #endregion Constructors (1)
 }

package/src/logger/ShapeDiverError.ts

@@ -1,17 +1,18 @@
 export enum ShapeDiverViewerErrorType {
     AR_ERROR = 'SdARError',
+    GEOMETRY_BACKEND_ERROR = 'SdGeometryBackendError',
     GEOMETRY_BACKEND_REQUEST_ERROR = 'SdGeometryBackendRequestError',
     GEOMETRY_BACKEND_RESPONSE_ERROR = 'SdGeometryBackendResponseError',
     CAMERA_ERROR = 'SdCameraError',
     CONNECTION_ERROR = 'SdConnectionError',
     DATA_PROCESSING_ERROR = 'SdDataProcessingError',
     ENVIRONMENT_MAP_ERROR = 'SdEnvironmentMapError',
-    GENERAL_VIEWPORT_ERROR = 'SdGeneralViewerError',
     INTERACTION_ERROR = 'SdInteractionError',
     LIGHT_ERROR = 'SdLightError',
     SESSION_ERROR = 'SdSessionError',
     SETTINGS_ERROR = 'SdSettingsError',
     VALIDATION_ERROR = 'SdValidationError',
+    VIEWPORT_ERROR = 'SdViewerError',
     WEBGL_ERROR = 'SdWebGLError',
     UNKNOWN = "",
 }
@@ -38,9 +39,10 @@ export class ShapeDiverError extends Error {
 
 export class ShapeDiverViewerError extends ShapeDiverError implements IShapeDiverViewerError {
     // #region Constructors (1)
+    public readonly errorType: ShapeDiverViewerErrorType = ShapeDiverViewerErrorType.UNKNOWN;
 
     constructor(
-        public readonly errorType: ShapeDiverViewerErrorType,
+        errorType: ShapeDiverViewerErrorType,
         public readonly desc: string,
         message: string
     ) {

package/src/logger/ShapeDiverViewerErrors.ts

@@ -62,7 +62,7 @@ export class ShapeDiverViewerViewportError extends ShapeDiverViewerError {
         public readonly message: string,
         public readonly errorObject?: Error | unknown
     ) {
-        super(ShapeDiverViewerErrorType.SESSION_ERROR, 'An error occurred while working with the viewport.', message);
+        super(ShapeDiverViewerErrorType.VIEWPORT_ERROR, 'An error occurred while working with the viewport.', message);
     }
 }
 
@@ -84,15 +84,6 @@ export class ShapeDiverViewerCameraError extends ShapeDiverViewerError {
     }
 }
 
-export class ShapeDiverViewerGeneralError extends ShapeDiverViewerError {
-    constructor(
-        public readonly message: string,
-        public readonly errorObject?: Error | unknown
-    ) {
-        super(ShapeDiverViewerErrorType.GENERAL_VIEWPORT_ERROR, 'An error occurred while working with the viewer.', message);
-    }
-}
-
 export class ShapeDiverViewerArError extends ShapeDiverViewerError {
     constructor(
         public readonly message: string,

package/src/settings-engine/SettingsEngine.ts

@@ -1,4 +1,4 @@
-import { convert, validate, DefaultsV3_4 as Defaults, ISettingsV3_4 as ISettings, versions, latestVersion } from '@shapediver/viewer.settings';
+import { convert, validate, Defaults, ISettings, versions, latestVersion } from '@shapediver/viewer.settings';
 
 import { EventEngine } from '../event-engine/EventEngine'
 import { Logger } from '../logger/Logger';
@@ -97,7 +97,7 @@ export class SettingsEngine {
         this._settingsJson = json;
         if (JSON.stringify(json) !== JSON.stringify({})) {
 
-            const prevVersions = ['1.0', '2.0', '3.0', '3.1', '3.2', '3.3'];
+            const prevVersions = ['1.0', '2.0', '3.0', '3.1', '3.2', '3.3', '3.4'];
             for(let i = 0; i < prevVersions.length; i++) {
                 const v = prevVersions[i];
 

package/src/state-engine/StateEngine.ts

@@ -11,7 +11,8 @@ export class StateEngine {
             settingsAssigned: StatePromise<boolean>,
             environmentMapLoaded: StatePromise<boolean>,
             boundingBoxCreated: StatePromise<boolean>,
-            busy: string[]
+            busy: string[],
+            update: (id: string) => void
         }
     } = {};
     private readonly _sessionEngines: {
@@ -55,7 +56,8 @@ export class StateEngine {
             settingsAssigned: StatePromise<boolean>,
             environmentMapLoaded: StatePromise<boolean>,
             boundingBoxCreated: StatePromise<boolean>,
-            busy: string[]
+            busy: string[],
+            update: (id: string) => void
         }
     } {
         return this._renderingEngines;