@shapediver/viewer.shared.services 3.3.4 → 3.3.7

package/src/settings-engine/SettingsEngine.ts

@@ -1,182 +0,0 @@
-import {
-    convert,
-    Defaults,
-    ISettings,
-    latestVersion,
-    previousVersion,
-    validate
-} from '@shapediver/viewer.settings';
-import { ShapeDiverViewerSettingsError } from '../logger/ShapeDiverViewerErrors';
-
-// #region Type aliases (8)
-
-type IARSettings = ISettings['ar'];
-type ICameraSettings = ISettings['camera'];
-type IEnvironmentGeometrySettings = ISettings['environmentGeometry'];
-type IEnvironmentSettings = ISettings['environment'];
-type IGeneralSettings = ISettings['general'];
-type ILightSettings = ISettings['light'];
-type IRenderingSettings = ISettings['rendering'];
-type ISessionSettings = ISettings['session'];
-
-// #endregion Type aliases (8)
-
-// #region Classes (1)
-
-export class SettingsEngine {
-    // #region Properties (4)
-
-    private _settings: ISettings = Defaults();
-    private _settingsJson: unknown;
-
-    // #endregion Properties (4)
-
-    // #region Public Getters And Setters (11)
-
-    public get ar(): IARSettings {
-        return this._settings.ar;
-    }
-
-    public get camera(): ICameraSettings {
-        return this._settings.camera;
-    }
-
-    public get environment(): IEnvironmentSettings {
-        return this._settings.environment;
-    }
-
-    public get environmentGeometry(): IEnvironmentGeometrySettings {
-        return this._settings.environmentGeometry;
-    }
-
-    public get general(): IGeneralSettings {
-        return this._settings.general;
-    }
-
-    public get light(): ILightSettings {
-        return this._settings.light;
-    }
-
-    public get rendering(): IRenderingSettings {
-        return this._settings.rendering;
-    }
-
-    public get session(): ISessionSettings {
-        return this._settings.session;
-    }
-
-    public set session(value: ISessionSettings) {
-        this._settings.session = value;
-    }
-
-    public get settings(): ISettings {
-        return this._settings;
-    }
-
-    public get settingsJson(): unknown {
-        return this._settingsJson;
-    }
-
-    // #endregion Public Getters And Setters (11)
-
-    // #region Public Methods (2)
-
-    public loadSettings(json: unknown) {
-        this._settingsJson = json;
-        if (JSON.stringify(json) !== JSON.stringify({})) {
-            for (let i = 0; i < previousVersion.length; i++) {
-                const v = previousVersion[i];
-
-                try {
-                    validate(json, v);
-                    this._settings = convert(json, latestVersion) as ISettings;
-                    this.cleanSettings(this._settings);
-                    return;
-                } catch (e) {
-                    // it's ok, we just try the next version
-                    // only the latest version is expected to be valid
-                }
-            }
-
-            try {
-                validate(json, latestVersion);
-                this._settings = convert(json, latestVersion) as ISettings;
-                this.cleanSettings(this._settings);
-                return;
-            } catch (e) {
-                throw new ShapeDiverViewerSettingsError('SettingsEngine.loadSettings: Settings could not be validated. ' + (<Error>e).message, <Error>e);
-            }
-        } else {
-            this._settings = Defaults();
-            return;
-        }
-    }
-
-    public reset() {
-        this._settings = Defaults();
-    }
-
-    // #endregion Public Methods (2)
-
-    // #region Private Methods (1)
-
-    private cleanSettings(json: ISettings) {
-        for (const c in json.camera.cameras) {
-            const camera = json.camera.cameras[c];
-            if (camera.type === 'perspective') {
-                const restrictions = camera.controls.restrictions;
-                if (restrictions.position.cube.min.x === null) restrictions.position.cube.min.x = -Infinity;
-                if (restrictions.position.cube.min.y === null) restrictions.position.cube.min.y = -Infinity;
-                if (restrictions.position.cube.min.z === null) restrictions.position.cube.min.z = -Infinity;
-                if (restrictions.position.cube.max.x === null) restrictions.position.cube.max.x = Infinity;
-                if (restrictions.position.cube.max.y === null) restrictions.position.cube.max.y = Infinity;
-                if (restrictions.position.cube.max.z === null) restrictions.position.cube.max.z = Infinity;
-                if (restrictions.position.sphere.radius === null) restrictions.position.sphere.radius = Infinity;
-                if (restrictions.target.cube.min.x === null) restrictions.target.cube.min.x = -Infinity;
-                if (restrictions.target.cube.min.y === null) restrictions.target.cube.min.y = -Infinity;
-                if (restrictions.target.cube.min.z === null) restrictions.target.cube.min.z = -Infinity;
-                if (restrictions.target.cube.max.x === null) restrictions.target.cube.max.x = Infinity;
-                if (restrictions.target.cube.max.y === null) restrictions.target.cube.max.y = Infinity;
-                if (restrictions.target.cube.max.z === null) restrictions.target.cube.max.z = Infinity;
-                if (restrictions.target.sphere.radius === null) restrictions.target.sphere.radius = Infinity;
-                if (restrictions.rotation.minAzimuthAngle === null) restrictions.rotation.minAzimuthAngle = -Infinity;
-                if (restrictions.rotation.maxAzimuthAngle === null) restrictions.rotation.maxAzimuthAngle = Infinity;
-                if (restrictions.zoom.maxDistance === null) restrictions.zoom.maxDistance = Infinity;
-            }
-        }
-    }
-
-    // #endregion Private Methods (1)
-}
-
-// #endregion Classes (1)
-
-// #region Enums (1)
-
-/**
- * Session settings to be used by a viewport.
- * 
- * The {@link https://help.shapediver.com/doc/Geometry-Backend.1863942173.html|ShapeDiver Geometry Backend} 
- * allows to persist settings of the viewer, individually for each model that it hosts. Persisting the settings
- * of the viewer requires permissions which are typically only granted to the owner of the model. Editing
- * of the settings typically happens on the model edit page of the ShapeDiver Platform.
- * 
- * Whenever an instance of the viewer creates a session with a model, the settings are made available to the viewer.
- * It is possible to use multiple sessions with different models from a single instance of the viewer. 
- * Therefore the viewer offers a choice on which settings to use.
- */
-export enum SESSION_SETTINGS_MODE {
-    /** No settings of a session will be used for the viewport. */
-    NONE = 'none',
-    /** 
-     * The settings of the very first session created will be used for the viewport. 
-     */
-    FIRST = 'first',
-    /** 
-     * Use this mode in case you want to assign a specific session identifier 
-     * to the viewport, whose settings will be used.
-     */
-    MANUAL = 'manual',
-}
-
-// #endregion Enums (1)

package/src/state-engine/ISessionGlobalAccessObjectDefinition.ts

@@ -1,25 +0,0 @@
-import { SettingsEngine } from '../settings-engine/SettingsEngine';
-import { ShapeDiverRequestGltfUploadQueryConversion, ShapeDiverResponseDto } from '@shapediver/sdk.geometry-api-sdk-v2';
-import { StatePromise } from './StatePromise';
-
-/**
- * Interface for the global access definition of a session.
- * This interface is used to define the properties and methods that are available via the state engine for a session.
- * This means that they can be called without having a direct reference to the session engine.
- */
-export interface ISessionGlobalAccessObjectDefinition {
-    // #region Properties (9)
-
-    readonly canUploadGLTF: boolean,
-    readonly id: string,
-    readonly initialOutputsLoaded: StatePromise<boolean>,
-    readonly initialized: StatePromise<boolean>,
-    readonly modelViewUrl: string,
-    readonly settingsEngine: SettingsEngine,
-    readonly settingsRegistered: StatePromise<boolean>,
-
-    isFirstSession: boolean,
-    uploadGLTF: (gltf: Blob, name: ShapeDiverRequestGltfUploadQueryConversion | undefined) => Promise<ShapeDiverResponseDto>,
-
-    // #endregion Properties (9)
-}

package/src/state-engine/IViewportGlobalAccessObjectDefinition.ts

@@ -1,29 +0,0 @@
-import { SESSION_SETTINGS_MODE, SettingsEngine } from '../settings-engine/SettingsEngine';
-import { StatePromise } from './StatePromise';
-
-/**
- * Interface for the global access definition of a viewport.
- * This interface is used to define the properties and methods that are available via the state engine for a viewport.
- * This means that they can be called without having a direct reference to the viewport engine.
- */
-export interface IViewportGlobalAccessObjectDefinition {
-    // #region Properties (14)
-
-    readonly boundingBoxCreated: StatePromise<boolean>,
-    readonly busy: string[],
-    readonly id: string,
-    readonly initialized: StatePromise<boolean>,
-    readonly sessionSettingsId?: string,
-    readonly sessionSettingsMode: SESSION_SETTINGS_MODE,
-    readonly settingsAssigned: StatePromise<boolean>,
-
-    applySettings: (sections?: { ar?: boolean, scene?: boolean, camera?: boolean, light?: boolean, environment?: boolean, general?: boolean, postprocessing?: boolean }, settingsEngine?: SettingsEngine, updateViewport?: boolean) => Promise<void>,
-    assignSettingsEngine: (settingsEngine: SettingsEngine) => void,
-    displayErrorMessage: (message: string) => void,
-    environmentMapLoaded: StatePromise<boolean>,
-    reset: () => void,
-    saveSettings: (settingsEngine?: SettingsEngine) => void,
-    update: (id: string) => void,
-
-    // #endregion Properties (14)
-}

package/src/state-engine/StateEngine.ts

@@ -1,47 +0,0 @@
-import { ISessionGlobalAccessObjectDefinition } from './ISessionGlobalAccessObjectDefinition';
-import { IViewportGlobalAccessObjectDefinition } from './IViewportGlobalAccessObjectDefinition';
-import { StatePromise } from './StatePromise';
-
-export class StateEngine {
-    // #region Properties (4)
-
-    private readonly _fontLoaded: StatePromise<boolean> = new StatePromise();
-    private readonly _sessionEngines: { [key: string]: ISessionGlobalAccessObjectDefinition | undefined } = {};
-    private readonly _viewportEngines: { [key: string]: IViewportGlobalAccessObjectDefinition | undefined } = {};
-
-    private static _instance: StateEngine;
-
-    // #endregion Properties (4)
-
-    // #region Constructors (1)
-
-    private constructor() {
-        this._fontLoaded = new StatePromise();
-    }
-
-    // #endregion Constructors (1)
-
-    // #region Public Static Getters And Setters (1)
-
-    public static get instance() {
-        return this._instance || (this._instance = new this());
-    }
-
-    // #endregion Public Static Getters And Setters (1)
-
-    // #region Public Getters And Setters (3)
-
-    public get fontLoaded(): StatePromise<boolean> {
-        return this._fontLoaded;
-    }
-
-    public get sessionEngines(): { [key: string]: ISessionGlobalAccessObjectDefinition | undefined } {
-        return this._sessionEngines;
-    }
-
-    public get viewportEngines(): { [key: string]: IViewportGlobalAccessObjectDefinition | undefined } {
-        return this._viewportEngines;
-    }
-
-    // #endregion Public Getters And Setters (3)
-}

package/src/state-engine/StatePromise.ts

@@ -1,54 +0,0 @@
-export class StatePromise<T> {
-    private _resolved: boolean = false;
-    private _resolve!: (value: T | PromiseLike<T>) => void;
-    private _reject!: (value: T | PromiseLike<T>) => void;
-
-    private _promise: Promise<T>;
-    private _callbacks: (() => void)[] = [];
-
-    constructor() {
-        this._promise = new Promise((resolve, reject) => {
-            this._resolve = resolve;
-            this._reject = reject;
-        });
-        
-        this._promise.finally(() => {
-            this._resolved = true;
-        });
-    }
-
-    public get resolved(): boolean {
-        return this._resolved;
-    }
-
-    public get resolve(): (value: T | PromiseLike<T>) => void {
-        return this._resolve;
-    }
-
-    public get reject(): (value: T | PromiseLike<T>) => void {
-        return this._reject;
-    }
-
-    public async then(callback: () => void ) {
-        this._callbacks.push(callback);
-        this.resolved === true ? callback() : this._promise.then(callback);
-    }
-
-    public reset() {
-        this._resolved = false;
-        
-        this._promise = new Promise((resolve, reject) => {
-            this._resolve = resolve;
-            this._reject = reject;
-        });
-        
-        this._promise.finally(() => {
-            this._resolved = true;
-        });
-
-        const callbackCopy = [...this._callbacks];
-        this._callbacks = [];
-        for(let i = 0; i < callbackCopy.length; i++)
-            this.then(callbackCopy[i])
-    }
-}

package/src/system-info/SystemInfo.ts

@@ -1,143 +0,0 @@
-import UAParser from 'ua-parser-js';
-
-export class SystemInfo {
-    // #region Properties (5)
-
-    private readonly _isBrowser: boolean;
-    private readonly _isIframe: boolean;
-    private readonly _origin: string;
-    private readonly _parser: UAParser;
-
-    private static _instance: SystemInfo;
-
-    // #endregion Properties (5)
-
-    // #region Constructors (1)
-
-    private constructor() {
-        this._parser = new UAParser();
-        const isInternetExplorer = typeof window !== 'undefined' && window.navigator && window.navigator.userAgent.indexOf('Trident') > -1;
-        this._isBrowser = isInternetExplorer ||
-            (typeof document !== 'undefined'
-                && typeof document.getElementById === 'function'
-                && window
-                && typeof window.Event === 'function'
-            );
-        this._isIframe = false;
-        if (this._isBrowser) {
-            // in case we are running in an iframe, parent and window are different, in
-            // that case we use the referrer
-            this._isIframe = parent !== window;
-            this._origin = this._isIframe ? document.referrer : window.location.origin;
-        } else {
-            this._origin = 'direct';
-        }
-    }
-
-    // #endregion Constructors (1)
-
-    // #region Public Static Accessors (1)
-
-    public static get instance() {
-        return this._instance || (this._instance = new this());
-    }
-
-    // #endregion Public Static Accessors (1)
-
-    // #region Public Accessors (11)
-
-    /**
-     * Check if we are on an Android device
-     */
-    public get isAndroid(): boolean {
-        const osName = this._parser.getOS().name;
-        return osName === 'Android';
-    }
-
-    /**
-     * Check if we are running in a browser
-     */
-    public get isBrowser(): boolean {
-        return this._isBrowser;
-    }
-
-    /**
-     * Check if we are running in Safari
-     */
-    public get isChrome(): boolean {
-        const browserName = this._parser.getBrowser().name;
-        return !!(browserName && browserName.includes('Chrome'));
-    }
-
-    /**
-     * Check if we are running in Firefox
-     */
-    public get isFirefox(): boolean {
-        const browserName = this._parser.getBrowser().name;
-        return !!(browserName && browserName.includes('Firefox'));
-    }
-
-    /**
-     * Check if we are running in internet explorer (arrrggghhhh!!!!)
-     */
-    public get isIE(): boolean {
-        const browserName = this._parser.getBrowser().name;
-        return !!(browserName && browserName.includes('IE'));
-    }
-
-    /**
-     * Check if we are on an IOS device
-     */
-    public get isIOS(): boolean {
-        const osName = this._parser.getOS().name;
-        return osName === 'iOS' || 
-        (typeof window !== undefined && window.navigator && window.navigator.maxTouchPoints === 5 && window.navigator.platform === 'MacIntel');
-    }
-
-    /**
-     * Check if we are running in an iframe
-     */
-    public get isIframe(): boolean {
-        return this._isIframe;
-    }
-
-    /**
-     * Check if we are running in an instagram browser
-     */
-    public get isInstagram(): boolean {
-        return this._parser.getBrowser().name === "Instagram";
-    }
-
-    /**
-     * Check if we are on a Mac OS device
-     */
-    public get isMacOS(): boolean {
-        const osName = this._parser.getOS().name;
-        return osName === 'Mac OS';
-    }
-
-    /**
-     * Check if we are on a mobile device
-     */
-    public get isMobile(): boolean {
-        const type = this._parser.getDevice().type;
-        return type === 'mobile' || type === 'tablet';
-    }
-
-    /**
-     * Check if we are running in Safari
-     */
-    public get isSafari(): boolean {
-        const browserName = this._parser.getBrowser().name;
-        return !!(browserName && browserName.includes('Safari'));
-    }
-
-    /**
-     * Get guessed origin of embedding website
-     */
-    public get origin(): string {
-        return this._origin + '';
-    }
-
-    // #endregion Public Accessors (11)
-}

package/src/type-check/TypeChecker.ts

@@ -1,27 +0,0 @@
-export class TypeChecker {
-    // #region Properties (1)
-
-    private static _instance: TypeChecker;
-
-    // #endregion Properties (1)
-
-    // #region Public Static Accessors (1)
-
-    public static get instance() {
-        return this._instance || (this._instance = new this());
-    }
-
-    // #endregion Public Static Accessors (1)
-
-    // #region Public Methods (2)
-
-    public isHTMLCanvasElement(value: any): boolean {
-        return value instanceof HTMLCanvasElement;
-    }
-
-    public isTypeOf(value: any, type: string): boolean {
-        return typeof value === type;
-    }
-
-    // #endregion Public Methods (2)
-}

package/src/utilities/base64.ts

@@ -1,15 +0,0 @@
-export const atobCustom = (str: string): string => {
-    if(typeof window !== 'undefined' && window.atob) {
-        return window.atob(str);
-    } else {
-        return Buffer.from(str, 'base64').toString();
-    }
-};
-
-export const btoaCustom = (str: string): string => {
-    if(typeof window !== 'undefined' && window.btoa) {
-        return window.btoa(str);
-    } else {
-        return Buffer.from(str).toString('base64');
-    }
-};

package/src/uuid-generator/UuidGenerator.ts

@@ -1,57 +0,0 @@
-import { parse as parseUUID, stringify as stringifyUUID, v4, validate as validateUUID } from 'uuid'
-
-export class UuidGenerator {
-    // #region Properties (1)
-
-    private static _instance: UuidGenerator;
-
-    // #endregion Properties (1)
-
-    // #region Public Static Accessors (1)
-
-    public static get instance() {
-        return this._instance || (this._instance = new this());
-    }
-
-    // #endregion Public Static Accessors (1)
-
-    // #region Public Methods (4)
-
-    /**
-     * Creates a new uuid v4.
-     */
-    public create(): string {
-        return v4();
-    }
-
-    /**
-     * Parse the uuid to array of bytes
-     * 
-     * @param uuid the uuid to convert
-     * @returns ArrayLike collection of 16 values
-     */
-    public parse(uuid: string): ArrayLike<number> {
-        return parseUUID(uuid);
-    }
-
-    /**
-     * Stringify an array of bytes to an uuid
-     * 
-     * @param uuid the array of bytes
-     * @returns the converted uuid
-     */
-    public stringify(uuid: ArrayLike<number>): string {
-        return stringifyUUID(uuid);
-    }
-
-    /**
-     * Checks if the provided string is a valid uuid.
-     * 
-     * @param uuid the uuid to check
-     */
-    public validate(uuid: string): boolean {
-        return validateUUID(uuid);
-    }
-
-    // #endregion Public Methods (4)
-}

package/tsconfig.json

@@ -1,17 +0,0 @@
-{
-    "extends": "../../tsconfig.json",
-    "include": [
-        "./**/*.ts"
-    ],
-    "compilerOptions": {
-        "rootDir": "src",
-        "outDir": "dist"
-    },
-    "exclude": [
-        "__tests__",
-        "node_modules",
-        "dist",
-        "dist-dev",
-        "dist-prod"
-    ]
-}