@combeenation/3d-viewer 12.4.1 → 12.4.3

package/dist/lib-cjs/api/util/globalTypes.js

@@ -1,2 +1,2 @@
-"use strict";
+"use strict";
 //# sourceMappingURL=globalTypes.js.map

package/dist/lib-cjs/api/util/resourceHelper.d.ts

@@ -1,58 +1,58 @@
-/**
- * Sleeps for a certain amount of microseconds.
- */
-declare const sleep: (ms: number) => Promise<unknown>;
-/**
- * Loads a JSON from a given path.
- * @emits {@link Event.LOADING_START}
- * @emits {@link Event.LOADING_END}
- */
-declare const loadJson: <T>(path: string) => Promise<T>;
-/**
- * Loads a Text from a given path.
- * @emits {@link Event.LOADING_START}
- * @emits {@link Event.LOADING_END}
- */
-declare const loadText: (path: string) => Promise<string>;
-/**
- * Loads a Javascript ressource.\
- * Usefull for including packages via CDN (eg: Babylon.js Inspector)
- */
-declare const loadJavascript: (url: string) => Promise<void>;
-/**
- * Debounces: it limits the rate at which a function can fire.
- */
-declare const debounce: (func: Function, wait: number, immediate?: boolean) => () => void;
-/**
- * Merges multiple maps.
- */
-declare const mergeMaps: <TKey, TValue>(...maps: Map<TKey, TValue>[]) => Map<TKey, TValue>;
-/**
- * Creates a HTML image element based on a SVG string, whereas all the embedded assets in the SVG (eg: fonts, images)
- * are already loaded and exchanged by their base64 representation.\
- * There the output image can exist as "standalone" image and may be used for example as a paintable.
- *
- * !!CAUTION!!: The used functions within this code section are very well evaluated since most alternatives
- * somehow don't work in Safari, as mentioned in the following BJS forum entries:
- * - https://forum.babylonjs.com/t/drawing-svg-content-text-into-dynamictexture-doesnt-work-in-safari-v15/25048
- * - https://forum.babylonjs.com/t/texture-createfrombase64string-doesnt-seem-to-work-for-ios-devices-initially/25502
- */
-declare const createImageFromSvg: (svgSrc: string) => Promise<HTMLImageElement>;
-/**
- * Creates an HTML image element from a dedicated image source.\
- * Also waits until the image has loaded.
- *
- * !!CAUTION!!: The `setTimeout` after loading is finished is required due to a Safari bug:
- * - https://bugs.webkit.org/show_bug.cgi?id=39059
- * - https://bugs.webkit.org/show_bug.cgi?id=219770
- *
- * It's not 100% ensured that the timeout solves the issue in every case, but there is no other way unfortunately.\
- * => Keep an eye on it in future projects
- *
- * @param imgSrc Theoretically every source is valid which is also supported by
- *               [HTMLImageElement.src](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/src).\
- *               Known exceptions are SVGs with embedded assets that are provided as object URL. See comments in
- *               {@link createImageFromSvg} for further details.
- */
-declare const createImageFromImgSrc: (imgSrc: string) => Promise<HTMLImageElement>;
-export { sleep, loadJson, loadText, loadJavascript, debounce, mergeMaps, createImageFromSvg, createImageFromImgSrc };
+/**
+ * Sleeps for a certain amount of microseconds.
+ */
+declare const sleep: (ms: number) => Promise<unknown>;
+/**
+ * Loads a JSON from a given path.
+ * @emits {@link Event.LOADING_START}
+ * @emits {@link Event.LOADING_END}
+ */
+declare const loadJson: <T>(path: string) => Promise<T>;
+/**
+ * Loads a Text from a given path.
+ * @emits {@link Event.LOADING_START}
+ * @emits {@link Event.LOADING_END}
+ */
+declare const loadText: (path: string) => Promise<string>;
+/**
+ * Loads a Javascript ressource.\
+ * Usefull for including packages via CDN (eg: Babylon.js Inspector)
+ */
+declare const loadJavascript: (url: string) => Promise<void>;
+/**
+ * Debounces: it limits the rate at which a function can fire.
+ */
+declare const debounce: (func: Function, wait: number, immediate?: boolean) => () => void;
+/**
+ * Merges multiple maps.
+ */
+declare const mergeMaps: <TKey, TValue>(...maps: Map<TKey, TValue>[]) => Map<TKey, TValue>;
+/**
+ * Creates a HTML image element based on a SVG string, whereas all the embedded assets in the SVG (eg: fonts, images)
+ * are already loaded and exchanged by their base64 representation.\
+ * There the output image can exist as "standalone" image and may be used for example as a paintable.
+ *
+ * !!CAUTION!!: The used functions within this code section are very well evaluated since most alternatives
+ * somehow don't work in Safari, as mentioned in the following BJS forum entries:
+ * - https://forum.babylonjs.com/t/drawing-svg-content-text-into-dynamictexture-doesnt-work-in-safari-v15/25048
+ * - https://forum.babylonjs.com/t/texture-createfrombase64string-doesnt-seem-to-work-for-ios-devices-initially/25502
+ */
+declare const createImageFromSvg: (svgSrc: string) => Promise<HTMLImageElement>;
+/**
+ * Creates an HTML image element from a dedicated image source.\
+ * Also waits until the image has loaded.
+ *
+ * !!CAUTION!!: The `setTimeout` after loading is finished is required due to a Safari bug:
+ * - https://bugs.webkit.org/show_bug.cgi?id=39059
+ * - https://bugs.webkit.org/show_bug.cgi?id=219770
+ *
+ * It's not 100% ensured that the timeout solves the issue in every case, but there is no other way unfortunately.\
+ * => Keep an eye on it in future projects
+ *
+ * @param imgSrc Theoretically every source is valid which is also supported by
+ *               [HTMLImageElement.src](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/src).\
+ *               Known exceptions are SVGs with embedded assets that are provided as object URL. See comments in
+ *               {@link createImageFromSvg} for further details.
+ */
+declare const createImageFromImgSrc: (imgSrc: string) => Promise<HTMLImageElement>;
+export { sleep, loadJson, loadText, loadJavascript, debounce, mergeMaps, createImageFromSvg, createImageFromImgSrc };

package/dist/lib-cjs/api/util/resourceHelper.js

@@ -1,215 +1,215 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createImageFromImgSrc = exports.createImageFromSvg = exports.mergeMaps = exports.debounce = exports.loadJavascript = exports.loadText = exports.loadJson = exports.sleep = void 0;
-const event_1 = require("../classes/event");
-/**
- * Sleeps for a certain amount of microseconds.
- */
-const sleep = (ms) => new Promise(resolve => window.setTimeout(resolve, ms));
-exports.sleep = sleep;
-/**
- * Loads any kind of response from given path.
- * @emits {@link Event.LOADING_START}
- * @emits {@link Event.LOADING_END}
- */
-const load = function (path) {
-    return __awaiter(this, void 0, void 0, function* () {
-        event_1.emitter.emit(event_1.Event.LOADING_START, path);
-        const data = yield fetch(path);
-        event_1.emitter.emit(event_1.Event.LOADING_END, path);
-        return data;
-    });
-};
-/**
- * Loads a JSON from a given path.
- * @emits {@link Event.LOADING_START}
- * @emits {@link Event.LOADING_END}
- */
-const loadJson = function (path) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const response = yield load(path);
-        return response.json();
-    });
-};
-exports.loadJson = loadJson;
-/**
- * Loads a Text from a given path.
- * @emits {@link Event.LOADING_START}
- * @emits {@link Event.LOADING_END}
- */
-const loadText = function (path) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const response = yield load(path);
-        return response.text();
-    });
-};
-exports.loadText = loadText;
-/**
- * Loads a Javascript ressource.\
- * Usefull for including packages via CDN (eg: Babylon.js Inspector)
- */
-const loadJavascript = (url) => new Promise(resolve => {
-    const scriptEl = document.createElement('script');
-    scriptEl.setAttribute('src', url);
-    scriptEl.setAttribute('type', 'text/javascript');
-    scriptEl.setAttribute('crossorigin', 'anonymous');
-    scriptEl.onload = () => resolve();
-    document.head.appendChild(scriptEl);
-});
-exports.loadJavascript = loadJavascript;
-/**
- * Debounces: it limits the rate at which a function can fire.
- */
-const debounce = function (func, wait, immediate = false) {
-    let timeout;
-    return function () {
-        // @ts-ignore this function is not very "ESLint friendly", also see ESLint disable comment 2 lines below
-        // => take some time to refactor this function when there is time
-        const context = this;
-        // eslint-disable-next-line prefer-rest-params
-        const args = arguments;
-        const later = function () {
-            timeout = null;
-            if (!immediate) {
-                func.apply(context, args);
-            }
-        };
-        const callNow = immediate && !timeout;
-        clearTimeout(timeout);
-        timeout = setTimeout(later, wait);
-        if (callNow) {
-            func.apply(context, args);
-        }
-    };
-};
-exports.debounce = debounce;
-/**
- * Merges multiple maps.
- */
-const mergeMaps = function (...maps) {
-    const resultMap = new Map();
-    maps.forEach(map => {
-        map.forEach((v, k) => {
-            resultMap.set(k, v);
-        });
-    });
-    return resultMap;
-};
-exports.mergeMaps = mergeMaps;
-/**
- * Creates a HTML image element based on a SVG string, whereas all the embedded assets in the SVG (eg: fonts, images)
- * are already loaded and exchanged by their base64 representation.\
- * There the output image can exist as "standalone" image and may be used for example as a paintable.
- *
- * !!CAUTION!!: The used functions within this code section are very well evaluated since most alternatives
- * somehow don't work in Safari, as mentioned in the following BJS forum entries:
- * - https://forum.babylonjs.com/t/drawing-svg-content-text-into-dynamictexture-doesnt-work-in-safari-v15/25048
- * - https://forum.babylonjs.com/t/texture-createfrombase64string-doesnt-seem-to-work-for-ios-devices-initially/25502
- */
-const createImageFromSvg = function (svgSrc) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // replace assets with their base64 versions in svg source code
-        const svgWithAssetsEmbedded = yield _embedAssets(svgSrc);
-        // create data string which can be used as an image source
-        const svgEncoded = 'data:image/svg+xml,' + encodeURIComponent(svgWithAssetsEmbedded);
-        return createImageFromImgSrc(svgEncoded);
-    });
-};
-exports.createImageFromSvg = createImageFromSvg;
-/**
- * Creates an HTML image element from a dedicated image source.\
- * Also waits until the image has loaded.
- *
- * !!CAUTION!!: The `setTimeout` after loading is finished is required due to a Safari bug:
- * - https://bugs.webkit.org/show_bug.cgi?id=39059
- * - https://bugs.webkit.org/show_bug.cgi?id=219770
- *
- * It's not 100% ensured that the timeout solves the issue in every case, but there is no other way unfortunately.\
- * => Keep an eye on it in future projects
- *
- * @param imgSrc Theoretically every source is valid which is also supported by
- *               [HTMLImageElement.src](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/src).\
- *               Known exceptions are SVGs with embedded assets that are provided as object URL. See comments in
- *               {@link createImageFromSvg} for further details.
- */
-const createImageFromImgSrc = function (imgSrc) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const img = new Image();
-        yield new Promise((resolve, reject) => {
-            img.onload = () => {
-                setTimeout(resolve, 0);
-            };
-            img.onerror = () => {
-                reject();
-            };
-            img.crossOrigin = 'anonymous';
-            img.src = imgSrc;
-        });
-        return img;
-    });
-};
-exports.createImageFromImgSrc = createImageFromImgSrc;
-/**
- * Replaces all supported image & font URLs in the given SVG with their base64 representation.
- */
-const _embedAssets = function (svgSrc) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const _imageExtensions = ['png', 'gif', 'jpg', 'jpeg', 'svg', 'bmp'];
-        const _fontExtensions = ['woff2', 'woff', 'ttf', 'otf'];
-        const _assetExtensions = [..._imageExtensions, ..._fontExtensions];
-        // Regex copied from https://stackoverflow.com/a/8943487/1273551, not "stress tested"...
-        const urlRegex = /(\bhttps?:\/\/[-A-Z0-9+&@#/%?=~_|!:,.;]*[-A-Z0-9+&@#/%=~_|])/gi;
-        const allUrls = svgSrc.match(urlRegex);
-        const assetUrls = allUrls.filter(url => {
-            const indexParam = url.indexOf('?');
-            // remove url parameter to recognize extension
-            if (indexParam > -1) {
-                url = url.substring(0, indexParam);
-            }
-            return _assetExtensions.some(extension => url.toLowerCase().endsWith(`.${extension}`));
-        });
-        const assetBase64Fetcher = assetUrls.map(_fetchBase64AssetUrl);
-        const assetFetcherResults = yield Promise.all(assetBase64Fetcher);
-        return assetFetcherResults.reduce((svgSrc, x) => svgSrc.replace(x.url, x.base64), svgSrc);
-    });
-};
-/**
- * Fetch asset (image or font) and convert it to base64 string representation.
- */
-const _fetchBase64AssetUrl = function (assetUrl) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // TODO: Cache known base64 representation and only fetch/convert when not already known.
-        //       Usually the fetch shouldn't hit the network but the browser cache since the SVG was already drawn.
-        //       See comments of "createImageBitmapFromSvg" for some considerations...
-        return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
-            const resp = yield fetch(assetUrl);
-            const blob = yield resp.blob();
-            const reader = new FileReader();
-            reader.onloadend = event => {
-                const target = event.target;
-                if (!target) {
-                    return reject(`Asset with URL "${assetUrl}" could not be loaded.`);
-                }
-                const result = target.result;
-                if (!result) {
-                    return reject(`Asset with URL "${assetUrl}" returned an empty result.`);
-                }
-                resolve({
-                    url: assetUrl,
-                    base64: result.toString(),
-                });
-            };
-            reader.readAsDataURL(blob);
-        }));
-    });
-};
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createImageFromImgSrc = exports.createImageFromSvg = exports.mergeMaps = exports.debounce = exports.loadJavascript = exports.loadText = exports.loadJson = exports.sleep = void 0;
+const event_1 = require("../classes/event");
+/**
+ * Sleeps for a certain amount of microseconds.
+ */
+const sleep = (ms) => new Promise(resolve => window.setTimeout(resolve, ms));
+exports.sleep = sleep;
+/**
+ * Loads any kind of response from given path.
+ * @emits {@link Event.LOADING_START}
+ * @emits {@link Event.LOADING_END}
+ */
+const load = function (path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        event_1.emitter.emit(event_1.Event.LOADING_START, path);
+        const data = yield fetch(path);
+        event_1.emitter.emit(event_1.Event.LOADING_END, path);
+        return data;
+    });
+};
+/**
+ * Loads a JSON from a given path.
+ * @emits {@link Event.LOADING_START}
+ * @emits {@link Event.LOADING_END}
+ */
+const loadJson = function (path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield load(path);
+        return response.json();
+    });
+};
+exports.loadJson = loadJson;
+/**
+ * Loads a Text from a given path.
+ * @emits {@link Event.LOADING_START}
+ * @emits {@link Event.LOADING_END}
+ */
+const loadText = function (path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield load(path);
+        return response.text();
+    });
+};
+exports.loadText = loadText;
+/**
+ * Loads a Javascript ressource.\
+ * Usefull for including packages via CDN (eg: Babylon.js Inspector)
+ */
+const loadJavascript = (url) => new Promise(resolve => {
+    const scriptEl = document.createElement('script');
+    scriptEl.setAttribute('src', url);
+    scriptEl.setAttribute('type', 'text/javascript');
+    scriptEl.setAttribute('crossorigin', 'anonymous');
+    scriptEl.onload = () => resolve();
+    document.head.appendChild(scriptEl);
+});
+exports.loadJavascript = loadJavascript;
+/**
+ * Debounces: it limits the rate at which a function can fire.
+ */
+const debounce = function (func, wait, immediate = false) {
+    let timeout;
+    return function () {
+        // @ts-ignore this function is not very "ESLint friendly", also see ESLint disable comment 2 lines below
+        // => take some time to refactor this function when there is time
+        const context = this;
+        // eslint-disable-next-line prefer-rest-params
+        const args = arguments;
+        const later = function () {
+            timeout = null;
+            if (!immediate) {
+                func.apply(context, args);
+            }
+        };
+        const callNow = immediate && !timeout;
+        clearTimeout(timeout);
+        timeout = setTimeout(later, wait);
+        if (callNow) {
+            func.apply(context, args);
+        }
+    };
+};
+exports.debounce = debounce;
+/**
+ * Merges multiple maps.
+ */
+const mergeMaps = function (...maps) {
+    const resultMap = new Map();
+    maps.forEach(map => {
+        map.forEach((v, k) => {
+            resultMap.set(k, v);
+        });
+    });
+    return resultMap;
+};
+exports.mergeMaps = mergeMaps;
+/**
+ * Creates a HTML image element based on a SVG string, whereas all the embedded assets in the SVG (eg: fonts, images)
+ * are already loaded and exchanged by their base64 representation.\
+ * There the output image can exist as "standalone" image and may be used for example as a paintable.
+ *
+ * !!CAUTION!!: The used functions within this code section are very well evaluated since most alternatives
+ * somehow don't work in Safari, as mentioned in the following BJS forum entries:
+ * - https://forum.babylonjs.com/t/drawing-svg-content-text-into-dynamictexture-doesnt-work-in-safari-v15/25048
+ * - https://forum.babylonjs.com/t/texture-createfrombase64string-doesnt-seem-to-work-for-ios-devices-initially/25502
+ */
+const createImageFromSvg = function (svgSrc) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // replace assets with their base64 versions in svg source code
+        const svgWithAssetsEmbedded = yield _embedAssets(svgSrc);
+        // create data string which can be used as an image source
+        const svgEncoded = 'data:image/svg+xml,' + encodeURIComponent(svgWithAssetsEmbedded);
+        return createImageFromImgSrc(svgEncoded);
+    });
+};
+exports.createImageFromSvg = createImageFromSvg;
+/**
+ * Creates an HTML image element from a dedicated image source.\
+ * Also waits until the image has loaded.
+ *
+ * !!CAUTION!!: The `setTimeout` after loading is finished is required due to a Safari bug:
+ * - https://bugs.webkit.org/show_bug.cgi?id=39059
+ * - https://bugs.webkit.org/show_bug.cgi?id=219770
+ *
+ * It's not 100% ensured that the timeout solves the issue in every case, but there is no other way unfortunately.\
+ * => Keep an eye on it in future projects
+ *
+ * @param imgSrc Theoretically every source is valid which is also supported by
+ *               [HTMLImageElement.src](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/src).\
+ *               Known exceptions are SVGs with embedded assets that are provided as object URL. See comments in
+ *               {@link createImageFromSvg} for further details.
+ */
+const createImageFromImgSrc = function (imgSrc) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const img = new Image();
+        yield new Promise((resolve, reject) => {
+            img.onload = () => {
+                setTimeout(resolve, 0);
+            };
+            img.onerror = () => {
+                reject();
+            };
+            img.crossOrigin = 'anonymous';
+            img.src = imgSrc;
+        });
+        return img;
+    });
+};
+exports.createImageFromImgSrc = createImageFromImgSrc;
+/**
+ * Replaces all supported image & font URLs in the given SVG with their base64 representation.
+ */
+const _embedAssets = function (svgSrc) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const _imageExtensions = ['png', 'gif', 'jpg', 'jpeg', 'svg', 'bmp'];
+        const _fontExtensions = ['woff2', 'woff', 'ttf', 'otf'];
+        const _assetExtensions = [..._imageExtensions, ..._fontExtensions];
+        // Regex copied from https://stackoverflow.com/a/8943487/1273551, not "stress tested"...
+        const urlRegex = /(\bhttps?:\/\/[-A-Z0-9+&@#/%?=~_|!:,.;]*[-A-Z0-9+&@#/%=~_|])/gi;
+        const allUrls = svgSrc.match(urlRegex);
+        const assetUrls = allUrls.filter(url => {
+            const indexParam = url.indexOf('?');
+            // remove url parameter to recognize extension
+            if (indexParam > -1) {
+                url = url.substring(0, indexParam);
+            }
+            return _assetExtensions.some(extension => url.toLowerCase().endsWith(`.${extension}`));
+        });
+        const assetBase64Fetcher = assetUrls.map(_fetchBase64AssetUrl);
+        const assetFetcherResults = yield Promise.all(assetBase64Fetcher);
+        return assetFetcherResults.reduce((svgSrc, x) => svgSrc.replace(x.url, x.base64), svgSrc);
+    });
+};
+/**
+ * Fetch asset (image or font) and convert it to base64 string representation.
+ */
+const _fetchBase64AssetUrl = function (assetUrl) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // TODO: Cache known base64 representation and only fetch/convert when not already known.
+        //       Usually the fetch shouldn't hit the network but the browser cache since the SVG was already drawn.
+        //       See comments of "createImageBitmapFromSvg" for some considerations...
+        return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+            const resp = yield fetch(assetUrl);
+            const blob = yield resp.blob();
+            const reader = new FileReader();
+            reader.onloadend = event => {
+                const target = event.target;
+                if (!target) {
+                    return reject(`Asset with URL "${assetUrl}" could not be loaded.`);
+                }
+                const result = target.result;
+                if (!result) {
+                    return reject(`Asset with URL "${assetUrl}" returned an empty result.`);
+                }
+                resolve({
+                    url: assetUrl,
+                    base64: result.toString(),
+                });
+            };
+            reader.readAsDataURL(blob);
+        }));
+    });
+};
 //# sourceMappingURL=resourceHelper.js.map