@shapediver/viewer.api.general 3.0.0

package/LICENSE

@@ -0,0 +1,73 @@
+Required Notice: Copyright 2023 ShapeDiver GmbH (https://www.shapediver.com) 
+
+https://polyformproject.org/licenses/noncommercial/1.0.0
+
+Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor’s copyright in it for any permitted purpose. However, you may only distribute the software according to Distribution License and make changes or new works based on the software according to Changes and New Works License.
+
+Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software. Your license to distribute covers distributing the software with changes and new works permitted by Changes and New Works License.
+
+Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with Required Notice: that the licensor provided with the software. For example:
+
+Required Notice: Copyright 2023 ShapeDiver GmbH (https://www.shapediver.com) 
+
+Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, is use for a permitted purpose.
+
+Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution is use for a permitted purpose regardless of the source of funding or obligations resulting from the funding.
+
+Fair Use
+
+You may have “fair use” rights for the software under the law. These terms do not limit them.
+
+No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else. These terms do not imply any other licenses.
+
+Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice. Otherwise, all your licenses end immediately.
+
+No Liability
+
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+Definitions
+
+The licensor is the individual or entity offering these terms, and the software is the software the licensor makes available under these terms.
+
+You refers to the individual or entity agreeing to these terms.
+
+Your company is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. Control means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+Your licenses are all the licenses granted to you for the software under these terms.
+
+Use means anything you do with the software requiring one of your licenses.

package/README.md

@@ -0,0 +1 @@
+# `@shapediver/viewer.api.general`

package/dist/index.d.ts

@@ -0,0 +1,77 @@
+import { IEvent, LOGGING_LEVEL, MainEventTypes } from '@shapediver/viewer.shared.services';
+import { ITree } from '@shapediver/viewer.shared.node-tree';
+export interface IGeneralOptions {
+    /**
+     * Caching options.
+     */
+    caching: {
+        /**
+         * Option to enable/disable the caching. (default: true)
+         */
+        enable: boolean;
+        /**
+         * Query parameters that are excluded when creating the key that is used for the comparison of data entries in the cache. (default: ['Expires', 'Signature', 'Key-Pair-Id'])
+         * Example: by the addition of 'Expires' the URLs https://link.example?Expires=0 and https://link.example?Expires=1 are both reduced to https://link.example for caching.
+         */
+        excludedQueryParameters: string[];
+        /**
+         * The maximum size of the cache in bytes. (default: 1024^3)
+         */
+        maxCacheSize: number;
+    };
+    /**
+     * When set to false, the branding in the viewer console will be limited to a single line.
+     * This will only include the viewer version. (default: true)
+     */
+    consoleBranding: boolean;
+    /**
+     * The logging level that is used.
+     */
+    loggingLevel: LOGGING_LEVEL;
+    /**
+     * The number of glTFs that are downloaded and processed at the same time.
+     * Restricting this number might help if too much data is downloaded at the same time.
+     * (default: Infinity)
+     */
+    parallelGlTFProcessing: number;
+    /**
+     * Option to show/hide messages in the browser console.
+     */
+    showMessages: boolean;
+}
+/**
+ * Adds an event listener.
+ *
+ * @param type The type of event.
+ * @param cb The callback.
+ * @returns
+ */
+export declare const addListener: (type: string | MainEventTypes, cb: (event: IEvent) => void) => string;
+/**
+ * Removes an event listener.
+ *
+ * @param id The id of the listener.
+ * @returns
+ */
+export declare const removeListener: (id: string) => boolean;
+/**
+ * The scene tree that is used to store the scene.
+ * The scene tree contains a unique node and child nodes for each session,
+ * and can also be used to add your own nodes.
+ */
+export declare const sceneTree: ITree;
+/**
+ * The version of the viewer.
+ */
+export declare const version: string;
+export declare const showConsoleMessage: () => void;
+/**
+ * General Viewer options that are used everywhere.
+ * - loggingLevel: The logging level that is used.
+ * - showMessages: Option to show/hide messages in the browser console.
+ * - parallelGlTFProcessing: The number of glTFs that are downloaded and processed at the same time.
+ * - consoleBranding: When set to false, the branding in the viewer console will be limited to a single line.
+ * - caching: Caching Options.
+ */
+export declare const generalOptions: IGeneralOptions;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAGH,MAAM,EAGN,aAAa,EACb,cAAc,EACjB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAAE,KAAK,EAAQ,MAAM,qCAAqC,CAAC;AAIlE,MAAM,WAAW,eAAe;IAG5B;;OAEG;IACH,OAAO,EAAE;QACL;;WAEG;QACH,MAAM,EAAE,OAAO,CAAC;QAEhB;;;WAGG;QACH,uBAAuB,EAAE,MAAM,EAAE,CAAC;QAElC;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;KACxB,CAAA;IAED;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,YAAY,EAAE,aAAa,CAAC;IAC5B;;;;OAIG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAC/B;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;CAGzB;AAiFD;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,SAAU,MAAM,GAAG,cAAc,cAAc,MAAM,KAAK,IAAI,KAAG,MAKxF,CAAC;AACF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,OAAQ,MAAM,KAAG,OAI3C,CAAC;AACF;;;;GAIG;AACH,eAAO,MAAM,SAAS,EAAE,KAAqB,CAAC;AAC9C;;GAEG;AACH,eAAO,MAAM,OAAO,EAAE,MAAmD,CAAC;AAC1E,eAAO,MAAM,kBAAkB,YAkB9B,CAAC;AACF;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,EAAE,eAAsC,CAAC"}

package/dist/index.js

@@ -0,0 +1,140 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generalOptions = exports.showConsoleMessage = exports.version = exports.sceneTree = exports.removeListener = exports.addListener = void 0;
+const viewer_shared_build_data_1 = require("@shapediver/viewer.shared.build-data");
+const viewer_shared_services_1 = require("@shapediver/viewer.shared.services");
+const viewer_data_engine_geometry_engine_1 = require("@shapediver/viewer.data-engine.geometry-engine");
+const viewer_shared_node_tree_1 = require("@shapediver/viewer.shared.node-tree");
+// #endregion Interfaces (1)
+// #region Classes (1)
+class GeneralOptions {
+    // #region Public Getters And Setters (10)
+    get caching() {
+        return {
+            enable: httpClient.enableCaching,
+            excludedQueryParameters: httpClient.excludedQueryParameters,
+            maxCacheSize: httpClient.maxCacheSize
+        };
+    }
+    set caching(value) {
+        inputValidator.validateAndError('caching', value, 'object', true);
+        inputValidator.validateAndError('caching', value.enable, 'boolean');
+        inputValidator.validateAndError('caching', value.excludedQueryParameters, 'stringArray');
+        inputValidator.validateAndError('caching', value.maxCacheSize, 'number');
+        if (value.enable !== undefined)
+            httpClient.enableCaching = value.enable;
+        if (value.excludedQueryParameters !== undefined)
+            httpClient.excludedQueryParameters = value.excludedQueryParameters;
+        if (value.maxCacheSize !== undefined)
+            httpClient.maxCacheSize = value.maxCacheSize;
+        logger.debug(`caching: CoggingLevel was set to: ${value}`);
+    }
+    get consoleBranding() {
+        return consoleBranding;
+    }
+    set consoleBranding(value) {
+        inputValidator.validateAndError('consoleBranding', value, 'boolean');
+        consoleBranding = value;
+        logger.debug(`consoleBranding: ConsoleBranding was set to: ${value}`);
+    }
+    get loggingLevel() {
+        return logger.loggingLevel;
+    }
+    set loggingLevel(value) {
+        inputValidator.validateAndError('loggingLevel', value, 'enum', true, Object.values(viewer_shared_services_1.LOGGING_LEVEL));
+        logger.loggingLevel = value;
+        logger.debug(`loggingLevel: LoggingLevel was set to: ${value}`);
+    }
+    get parallelGlTFProcessing() {
+        return geometryEngine.parallelGlTFProcessing;
+    }
+    set parallelGlTFProcessing(value) {
+        inputValidator.validateAndError('parallelGlTFProcessing', value, 'number');
+        geometryEngine.parallelGlTFProcessing = value;
+        logger.debug(`parallelGlTFProcessing: ParallelGlTFProcessing was set to: ${value}`);
+    }
+    get showMessages() {
+        return logger.showMessages;
+    }
+    set showMessages(value) {
+        inputValidator.validateAndError('showMessages', value, 'boolean');
+        logger.showMessages = value;
+        logger.debug(`showMessages: ShowMessages was set to: ${value}`);
+    }
+}
+// #endregion Classes (1)
+// #region Variables (12)
+const httpClient = viewer_shared_services_1.HttpClient.instance;
+const inputValidator = viewer_shared_services_1.InputValidator.instance;
+const logger = viewer_shared_services_1.Logger.instance;
+const eventEngine = viewer_shared_services_1.EventEngine.instance;
+const geometryEngine = viewer_data_engine_geometry_engine_1.GeometryEngine.instance;
+let createdConsoleMessage = false, consoleBranding = true;
+/**
+ * Adds an event listener.
+ *
+ * @param type The type of event.
+ * @param cb The callback.
+ * @returns
+ */
+const addListener = (type, cb) => {
+    inputValidator.validateAndError('addListener', type, 'string');
+    inputValidator.validateAndError('addListener', cb, 'function');
+    logger.debug(`addListener: Event Listener was registered for ${type}.`);
+    return eventEngine.addListener(type, cb);
+};
+exports.addListener = addListener;
+/**
+ * Removes an event listener.
+ *
+ * @param id The id of the listener.
+ * @returns
+ */
+const removeListener = (id) => {
+    inputValidator.validateAndError('removeListener', id, 'string');
+    logger.debug(`removeListener: Removing event listener with id ${id}.`);
+    return eventEngine.removeListener(id);
+};
+exports.removeListener = removeListener;
+/**
+ * The scene tree that is used to store the scene.
+ * The scene tree contains a unique node and child nodes for each session,
+ * and can also be used to add your own nodes.
+ */
+exports.sceneTree = viewer_shared_node_tree_1.Tree.instance;
+/**
+ * The version of the viewer.
+ */
+exports.version = viewer_shared_build_data_1.build_data.build_version.replace('3.', '');
+const showConsoleMessage = () => {
+    if (createdConsoleMessage === true)
+        return;
+    createdConsoleMessage = true;
+    if (consoleBranding === true) {
+        console.log(`Powered by:
+   _____  __                         ____   _                   
+  / ___/ / /_   ____ _ ____   ___   / __ \\ (_)_   __ ___   _____
+  \\__ \\ / __ \\ / __ '// __ \\ / _ \\ / / / // /| | / // _ \\ / ___/
+ ___/ // / / // /_/ // /_/ //  __// /_/ // / | |/ //  __// /    
+/____//_/ /_/ \\__,_// .___/ \\___//_____//_/  |___/ \\___//_/     
+                   /_/                                          
+ShapeDiver Viewer 3, Version ${viewer_shared_build_data_1.build_data.build_version.replace('3.', '')}
+Visit us at https://shapediver.com/ and find out more!
+`);
+    }
+    else {
+        console.log(`ShapeDiver Viewer 3, Version ${viewer_shared_build_data_1.build_data.build_version.replace('3.', '')}`);
+    }
+};
+exports.showConsoleMessage = showConsoleMessage;
+/**
+ * General Viewer options that are used everywhere.
+ * - loggingLevel: The logging level that is used.
+ * - showMessages: Option to show/hide messages in the browser console.
+ * - parallelGlTFProcessing: The number of glTFs that are downloaded and processed at the same time.
+ * - consoleBranding: When set to false, the branding in the viewer console will be limited to a single line.
+ * - caching: Caching Options.
+ */
+exports.generalOptions = new GeneralOptions();
+// #endregion Variables (12)
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mFAAkE;AAClE,+EAQ4C;AAC5C,uGAAgF;AAChF,iFAAkE;AAmDlE,4BAA4B;AAE5B,sBAAsB;AAEtB,MAAM,cAAc;IAChB,0CAA0C;IAE1C,IAAW,OAAO;QACd,OAAO;YACH,MAAM,EAAE,UAAU,CAAC,aAAa;YAChC,uBAAuB,EAAE,UAAU,CAAC,uBAAuB;YAC3D,YAAY,EAAE,UAAU,CAAC,YAAY;SACxC,CAAC;IACN,CAAC;IAED,IAAW,OAAO,CAAC,KAAmF;QAClG,cAAc,CAAC,gBAAgB,CAAC,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QAClE,cAAc,CAAC,gBAAgB,CAAC,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QACpE,cAAc,CAAC,gBAAgB,CAAC,SAAS,EAAE,KAAK,CAAC,uBAAuB,EAAE,aAAa,CAAC,CAAC;QACzF,cAAc,CAAC,gBAAgB,CAAC,SAAS,EAAE,KAAK,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QACzE,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;YAAE,UAAU,CAAC,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC;QACxE,IAAI,KAAK,CAAC,uBAAuB,KAAK,SAAS;YAAE,UAAU,CAAC,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,CAAC;QACpH,IAAI,KAAK,CAAC,YAAY,KAAK,SAAS;YAAE,UAAU,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QACnF,MAAM,CAAC,KAAK,CAAC,qCAAqC,KAAK,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED,IAAW,eAAe;QACtB,OAAO,eAAe,CAAC;IAC3B,CAAC;IAED,IAAW,eAAe,CAAC,KAAc;QACrC,cAAc,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QACrE,eAAe,GAAG,KAAK,CAAC;QACxB,MAAM,CAAC,KAAK,CAAC,gDAAgD,KAAK,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,IAAW,YAAY;QACnB,OAAO,MAAM,CAAC,YAAY,CAAC;IAC/B,CAAC;IAED,IAAW,YAAY,CAAC,KAAoB;QACxC,cAAc,CAAC,gBAAgB,CAAC,cAAc,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,sCAAa,CAAC,CAAC,CAAC;QACnG,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC;QAC5B,MAAM,CAAC,KAAK,CAAC,0CAA0C,KAAK,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,IAAW,sBAAsB;QAC7B,OAAO,cAAc,CAAC,sBAAsB,CAAC;IACjD,CAAC;IAED,IAAW,sBAAsB,CAAC,KAAa;QAC3C,cAAc,CAAC,gBAAgB,CAAC,wBAAwB,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QAC3E,cAAc,CAAC,sBAAsB,GAAG,KAAK,CAAC;QAC9C,MAAM,CAAC,KAAK,CAAC,8DAA8D,KAAK,EAAE,CAAC,CAAC;IACxF,CAAC;IAED,IAAW,YAAY;QACnB,OAAO,MAAM,CAAC,YAAY,CAAC;IAC/B,CAAC;IAED,IAAW,YAAY,CAAC,KAAc;QAClC,cAAc,CAAC,gBAAgB,CAAC,cAAc,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QAClE,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC;QAC5B,MAAM,CAAC,KAAK,CAAC,0CAA0C,KAAK,EAAE,CAAC,CAAC;IACpE,CAAC;CAGJ;AAED,yBAAyB;AAEzB,yBAAyB;AAEzB,MAAM,UAAU,GAAe,mCAAU,CAAC,QAAQ,CAAC;AACnD,MAAM,cAAc,GAAmB,uCAAc,CAAC,QAAQ,CAAC;AAC/D,MAAM,MAAM,GAAW,+BAAM,CAAC,QAAQ,CAAC;AACvC,MAAM,WAAW,GAAgB,oCAAW,CAAC,QAAQ,CAAC;AACtD,MAAM,cAAc,GAAmB,mDAAc,CAAC,QAAQ,CAAC;AAC/D,IAAI,qBAAqB,GAAG,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC;AAC1D;;;;;;GAMG;AACI,MAAM,WAAW,GAAG,CAAC,IAA6B,EAAE,EAA2B,EAAU,EAAE;IAC9F,cAAc,CAAC,gBAAgB,CAAC,aAAa,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC/D,cAAc,CAAC,gBAAgB,CAAC,aAAa,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;IAC/D,MAAM,CAAC,KAAK,CAAC,kDAAkD,IAAI,GAAG,CAAC,CAAC;IACxE,OAAO,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AAC7C,CAAC,CAAC;AALW,QAAA,WAAW,eAKtB;AACF;;;;;GAKG;AACI,MAAM,cAAc,GAAG,CAAC,EAAU,EAAW,EAAE;IAClD,cAAc,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC;IAChE,MAAM,CAAC,KAAK,CAAC,mDAAmD,EAAE,GAAG,CAAC,CAAC;IACvE,OAAO,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;AAC1C,CAAC,CAAC;AAJW,QAAA,cAAc,kBAIzB;AACF;;;;GAIG;AACU,QAAA,SAAS,GAAU,8BAAI,CAAC,QAAQ,CAAC;AAC9C;;GAEG;AACU,QAAA,OAAO,GAAW,qCAAU,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AACnE,MAAM,kBAAkB,GAAG,GAAG,EAAE;IACnC,IAAI,qBAAqB,KAAK,IAAI;QAAE,OAAO;IAC3C,qBAAqB,GAAG,IAAI,CAAC;IAE7B,IAAI,eAAe,KAAK,IAAI,EAAE;QAC1B,OAAO,CAAC,GAAG,CAAC;;;;;;;+BAOW,qCAAU,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;;CAExE,CAAC,CAAC;KACE;SAAM;QACH,OAAO,CAAC,GAAG,CAAC,gCAAgC,qCAAU,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;KAC7F;AACL,CAAC,CAAC;AAlBW,QAAA,kBAAkB,sBAkB7B;AACF;;;;;;;GAOG;AACU,QAAA,cAAc,GAAoB,IAAI,cAAc,EAAE,CAAC;AAEpE,4BAA4B"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@shapediver/viewer.api.general",
+  "version": "3.0.0",
+  "description": "",
+  "keywords": [],
+  "author": "Michael Oppitz <michael@shapediver.com>",
+  "license": "polyform-noncommercial-1.0.0",
+  "main": "dist/index.js",
+  "directories": {
+    "test": "__tests__"
+  },
+  "files": [
+    "dist",
+    "src",
+    "package.json",
+    "README.md",
+    "tsconfig.json"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shapediver/Viewer.git"
+  },
+  "scripts": {
+    "check": "tsc --noEmit",
+    "build": "bash ../../scripts/building/build.sh",
+    "build-watch": "bash ../../scripts/building/build-watch.sh",
+    "build-dep": "bash ../../scripts/building/build-dep.sh"
+  },
+  "bugs": {
+    "url": "https://github.com/shapediver/Viewer/issues"
+  },
+  "homepage": "https://github.com/shapediver/Viewer#readme",
+  "typings": "dist/index.d.ts",
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node"
+  },
+  "dependencies": {
+    "@shapediver/viewer.data-engine.geometry-engine": "3.0.0",
+    "@shapediver/viewer.shared.build-data": "3.0.0",
+    "@shapediver/viewer.shared.node-tree": "3.0.0",
+    "@shapediver/viewer.shared.services": "3.0.0",
+    "gl-matrix": "3.3.0"
+  },
+  "gitHead": "b6b0010bf5d5652aa338df8016405d97f33fcabb"
+}

package/src/index.ts

@@ -0,0 +1,205 @@
+import { build_data } from '@shapediver/viewer.shared.build-data';
+import {
+    EventEngine,
+    HttpClient,
+    IEvent,
+    InputValidator,
+    Logger,
+    LOGGING_LEVEL,
+    MainEventTypes
+} from '@shapediver/viewer.shared.services';
+import { GeometryEngine } from '@shapediver/viewer.data-engine.geometry-engine';
+import { ITree, Tree } from '@shapediver/viewer.shared.node-tree';
+
+// #region Interfaces (1)
+
+export interface IGeneralOptions {
+    // #region Properties (5)
+
+    /**
+     * Caching options.
+     */
+    caching: {
+        /**
+         * Option to enable/disable the caching. (default: true)
+         */
+        enable: boolean;
+
+        /**
+         * Query parameters that are excluded when creating the key that is used for the comparison of data entries in the cache. (default: ['Expires', 'Signature', 'Key-Pair-Id'])
+         * Example: by the addition of 'Expires' the URLs https://link.example?Expires=0 and https://link.example?Expires=1 are both reduced to https://link.example for caching.
+         */
+        excludedQueryParameters: string[];
+
+        /**
+         * The maximum size of the cache in bytes. (default: 1024^3)
+         */
+        maxCacheSize: number;
+    }
+
+    /**
+     * When set to false, the branding in the viewer console will be limited to a single line.
+     * This will only include the viewer version. (default: true)
+     */
+    consoleBranding: boolean;
+    /**
+     * The logging level that is used.
+     */
+    loggingLevel: LOGGING_LEVEL;
+    /**
+     * The number of glTFs that are downloaded and processed at the same time.
+     * Restricting this number might help if too much data is downloaded at the same time.
+     * (default: Infinity)
+     */
+    parallelGlTFProcessing: number;
+    /**
+     * Option to show/hide messages in the browser console.
+     */
+    showMessages: boolean;
+
+    // #endregion Properties (5)
+}
+
+// #endregion Interfaces (1)
+
+// #region Classes (1)
+
+class GeneralOptions {
+    // #region Public Getters And Setters (10)
+
+    public get caching(): { enable: boolean, excludedQueryParameters: string[], maxCacheSize: number } {
+        return {
+            enable: httpClient.enableCaching,
+            excludedQueryParameters: httpClient.excludedQueryParameters,
+            maxCacheSize: httpClient.maxCacheSize
+        };
+    }
+
+    public set caching(value: { enable: boolean, excludedQueryParameters: string[], maxCacheSize: number }) {
+        inputValidator.validateAndError('caching', value, 'object', true);
+        inputValidator.validateAndError('caching', value.enable, 'boolean');
+        inputValidator.validateAndError('caching', value.excludedQueryParameters, 'stringArray');
+        inputValidator.validateAndError('caching', value.maxCacheSize, 'number');
+        if (value.enable !== undefined) httpClient.enableCaching = value.enable;
+        if (value.excludedQueryParameters !== undefined) httpClient.excludedQueryParameters = value.excludedQueryParameters;
+        if (value.maxCacheSize !== undefined) httpClient.maxCacheSize = value.maxCacheSize;
+        logger.debug(`caching: CoggingLevel was set to: ${value}`);
+    }
+
+    public get consoleBranding(): boolean {
+        return consoleBranding;
+    }
+
+    public set consoleBranding(value: boolean) {
+        inputValidator.validateAndError('consoleBranding', value, 'boolean');
+        consoleBranding = value;
+        logger.debug(`consoleBranding: ConsoleBranding was set to: ${value}`);
+    }
+
+    public get loggingLevel(): LOGGING_LEVEL {
+        return logger.loggingLevel;
+    }
+
+    public set loggingLevel(value: LOGGING_LEVEL) {
+        inputValidator.validateAndError('loggingLevel', value, 'enum', true, Object.values(LOGGING_LEVEL));
+        logger.loggingLevel = value;
+        logger.debug(`loggingLevel: LoggingLevel was set to: ${value}`);
+    }
+
+    public get parallelGlTFProcessing(): number {
+        return geometryEngine.parallelGlTFProcessing;
+    }
+
+    public set parallelGlTFProcessing(value: number) {
+        inputValidator.validateAndError('parallelGlTFProcessing', value, 'number');
+        geometryEngine.parallelGlTFProcessing = value;
+        logger.debug(`parallelGlTFProcessing: ParallelGlTFProcessing was set to: ${value}`);
+    }
+
+    public get showMessages(): boolean {
+        return logger.showMessages;
+    }
+
+    public set showMessages(value: boolean) {
+        inputValidator.validateAndError('showMessages', value, 'boolean');
+        logger.showMessages = value;
+        logger.debug(`showMessages: ShowMessages was set to: ${value}`);
+    }
+
+    // #endregion Public Getters And Setters (10)
+}
+
+// #endregion Classes (1)
+
+// #region Variables (12)
+
+const httpClient: HttpClient = HttpClient.instance;
+const inputValidator: InputValidator = InputValidator.instance;
+const logger: Logger = Logger.instance;
+const eventEngine: EventEngine = EventEngine.instance;
+const geometryEngine: GeometryEngine = GeometryEngine.instance;
+let createdConsoleMessage = false, consoleBranding = true;
+/**
+ * Adds an event listener.
+ * 
+ * @param type The type of event.
+ * @param cb The callback.
+ * @returns 
+ */
+export const addListener = (type: string | MainEventTypes, cb: (event: IEvent) => void): string => {
+    inputValidator.validateAndError('addListener', type, 'string');
+    inputValidator.validateAndError('addListener', cb, 'function');
+    logger.debug(`addListener: Event Listener was registered for ${type}.`);
+    return eventEngine.addListener(type, cb);
+};
+/**
+ * Removes an event listener.
+ * 
+ * @param id The id of the listener.
+ * @returns 
+ */
+export const removeListener = (id: string): boolean => {
+    inputValidator.validateAndError('removeListener', id, 'string');
+    logger.debug(`removeListener: Removing event listener with id ${id}.`);
+    return eventEngine.removeListener(id);
+};
+/**
+ * The scene tree that is used to store the scene.
+ * The scene tree contains a unique node and child nodes for each session, 
+ * and can also be used to add your own nodes.
+ */
+export const sceneTree: ITree = Tree.instance;
+/**
+ * The version of the viewer.
+ */
+export const version: string = build_data.build_version.replace('3.', '');
+export const showConsoleMessage = () => {
+    if (createdConsoleMessage === true) return;
+    createdConsoleMessage = true;
+
+    if (consoleBranding === true) {
+        console.log(`Powered by:
+   _____  __                         ____   _                   
+  / ___/ / /_   ____ _ ____   ___   / __ \\ (_)_   __ ___   _____
+  \\__ \\ / __ \\ / __ '// __ \\ / _ \\ / / / // /| | / // _ \\ / ___/
+ ___/ // / / // /_/ // /_/ //  __// /_/ // / | |/ //  __// /    
+/____//_/ /_/ \\__,_// .___/ \\___//_____//_/  |___/ \\___//_/     
+                   /_/                                          
+ShapeDiver Viewer 3, Version ${build_data.build_version.replace('3.', '')}
+Visit us at https://shapediver.com/ and find out more!
+`);
+    } else {
+        console.log(`ShapeDiver Viewer 3, Version ${build_data.build_version.replace('3.', '')}`);
+    }
+};
+/**
+ * General Viewer options that are used everywhere.
+ * - loggingLevel: The logging level that is used.
+ * - showMessages: Option to show/hide messages in the browser console.
+ * - parallelGlTFProcessing: The number of glTFs that are downloaded and processed at the same time.
+ * - consoleBranding: When set to false, the branding in the viewer console will be limited to a single line.
+ * - caching: Caching Options.
+ */
+export const generalOptions: IGeneralOptions = new GeneralOptions();
+
+// #endregion Variables (12)

package/tsconfig.json

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