@inweb/viewer-visualize 26.7.0 → 26.7.1

package/dist/viewer-visualize.js

@@ -3854,28 +3854,134 @@
     // By use of this software, its documentation or related materials, you
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
-    class VSFBufferLoader extends Loader {
+    class FileLoader {
+        constructor() {
+            this.requestHeader = {};
+            this.withCredentials = false;
+            this.abortSignal = undefined;
+        }
+        setRequestHeader(requestHeader) {
+            this.requestHeader = requestHeader;
+        }
+        setWithCredentials(withCredentials) {
+            this.withCredentials = withCredentials;
+        }
+        setAbortSignal(abortSignal) {
+            this.abortSignal = abortSignal;
+        }
+        load(file, onProgress) {
+            if (typeof file === "string") {
+                const request = new Request(file, {
+                    headers: new Headers(this.requestHeader),
+                    credentials: this.withCredentials ? "include" : "same-origin",
+                    signal: this.abortSignal,
+                });
+                return fetch(request)
+                    .then((response) => {
+                    if (!response.ok)
+                        throw new Error(`Failed to fetch "${response.url}", status ${response.status}`);
+                    const contentLength = response.headers.get("X-File-Size") || response.headers.get("Content-Length");
+                    const total = parseInt(contentLength || "", 10) || 0;
+                    const lengthComputable = total > 0;
+                    const stream = new ReadableStream({
+                        async start(controller) {
+                            const reader = response.body.getReader();
+                            let loaded = 0;
+                            try {
+                                while (true) {
+                                    const { done, value } = await reader.read();
+                                    if (done)
+                                        break;
+                                    if (onProgress) {
+                                        loaded += value.byteLength;
+                                        onProgress(new ProgressEvent("progress", { lengthComputable, loaded, total }));
+                                    }
+                                    controller.enqueue(value);
+                                }
+                                controller.close();
+                            }
+                            catch (e) {
+                                controller.error(e);
+                            }
+                        },
+                    });
+                    return new Response(stream);
+                })
+                    .then((response) => response.arrayBuffer());
+            }
+            if (file instanceof globalThis.File) {
+                return new Promise((resolve, reject) => {
+                    const reader = new FileReader();
+                    reader.onload = () => resolve(reader.result);
+                    reader.onerror = () => reject(reader.error);
+                    reader.onprogress = onProgress;
+                    reader.readAsArrayBuffer(new Blob([file]));
+                });
+            }
+            if (onProgress) {
+                const total = file.byteLength;
+                const lengthComputable = total > 0;
+                const loaded = total;
+                onProgress(new ProgressEvent("progress", { lengthComputable, loaded, total }));
+            }
+            return Promise.resolve(file);
+        }
+    }
+
+    ///////////////////////////////////////////////////////////////////////////////
+    // Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
+    // All rights reserved.
+    //
+    // This software and its documentation and related materials are owned by
+    // the Alliance. The software may only be incorporated into application
+    // programs owned by members of the Alliance, subject to a signed
+    // Membership Agreement and Supplemental Software License Agreement with the
+    // Alliance. The structure and organization of this software are the valuable
+    // trade secrets of the Alliance and its suppliers. The software is also
+    // protected by copyright law and international treaty provisions. Application
+    // programs incorporating this software must include the following statement
+    // with their copyright notices:
+    //
+    //   This application incorporates Open Design Alliance software pursuant to a
+    //   license agreement with Open Design Alliance.
+    //   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance.
+    //   All rights reserved.
+    //
+    // By use of this software, its documentation or related materials, you
+    // acknowledge and accept the above terms.
+    ///////////////////////////////////////////////////////////////////////////////
+    class VSFFileLoader extends Loader {
         constructor(viewer) {
             super();
             this.viewer = viewer;
         }
         isSupport(file, format) {
-            return file instanceof ArrayBuffer && /vsf$/i.test(format);
+            return ((typeof file === "string" || file instanceof globalThis.File || file instanceof ArrayBuffer) &&
+                /vsf$/i.test(format));
         }
-        load(buffer, format) {
+        async load(file, format, params) {
             if (!this.viewer.visualizeJs)
-                return Promise.resolve(this);
+                return this;
+            const progress = (event) => {
+                const { lengthComputable, loaded, total } = event;
+                const progress = lengthComputable ? loaded / total : 1;
+                this.viewer.emitEvent({ type: "geometryprogress", data: progress, file });
+            };
+            const loader = new FileLoader();
+            loader.setRequestHeader(params.requestHeader);
+            loader.setWithCredentials(params.withCredentials);
+            loader.setAbortSignal(this.abortController.signal);
+            const buffer = await loader.load(file, progress);
+            const data = new Uint8Array(buffer);
             const visLib = this.viewer.visLib();
             const visViewer = visLib.getViewer();
-            const data = new Uint8Array(buffer);
             visViewer.parseFile(data);
             this.viewer.syncOpenCloudVisualStyle(false);
             this.viewer.syncOptions();
             this.viewer.syncOverlay();
             this.viewer.resize();
-            this.viewer.emitEvent({ type: "geometryprogress", data: 1, file: buffer });
-            this.viewer.emitEvent({ type: "databasechunk", data, file: buffer });
-            return Promise.resolve(this);
+            this.viewer.emitEvent({ type: "databasechunk", data, file });
+            return this;
         }
     }
 
@@ -3970,28 +4076,38 @@
     // By use of this software, its documentation or related materials, you
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
-    class VSFXBufferLoader extends Loader {
+    class VSFXFileLoader extends Loader {
         constructor(viewer) {
             super();
             this.viewer = viewer;
         }
         isSupport(file, format) {
-            return file instanceof ArrayBuffer && /vsfx$/i.test(format);
+            return ((typeof file === "string" || file instanceof globalThis.File || file instanceof ArrayBuffer) &&
+                /vsfx$/i.test(format));
         }
-        load(buffer, format) {
+        async load(file, format, params) {
             if (!this.viewer.visualizeJs)
-                return Promise.resolve(this);
+                return this;
+            const progress = (event) => {
+                const { lengthComputable, loaded, total } = event;
+                const progress = lengthComputable ? loaded / total : 1;
+                this.viewer.emitEvent({ type: "geometryprogress", data: progress, file });
+            };
+            const loader = new FileLoader();
+            loader.setRequestHeader(params.requestHeader);
+            loader.setWithCredentials(params.withCredentials);
+            loader.setAbortSignal(this.abortController.signal);
+            const buffer = await loader.load(file, progress);
+            const data = new Uint8Array(buffer);
             const visLib = this.viewer.visLib();
             const visViewer = visLib.getViewer();
-            const data = new Uint8Array(buffer);
             visViewer.parseVsfx(data);
             this.viewer.syncOpenCloudVisualStyle(false);
             this.viewer.syncOptions();
             this.viewer.syncOverlay();
             this.viewer.resize();
-            this.viewer.emitEvent({ type: "geometryprogress", data: 1, file: buffer });
-            this.viewer.emitEvent({ type: "databasechunk", data, file: buffer });
-            return Promise.resolve(this);
+            this.viewer.emitEvent({ type: "databasechunk", data, file });
+            return this;
         }
     }
 
@@ -4431,8 +4547,7 @@
      * @example Implementing a custom loader.
      *
      * ```javascript
-     * import { Loader } from "@inweb/viewer-core";
-     * import { loaders, Viewer } from "@inweb/viewer-visualize";
+     * import { Loader, loaders, Viewer } from "@inweb/viewer-visualize";
      *
      * class MyLoader extends Loader {
      *   public viewer: Viewer;
@@ -4459,7 +4574,7 @@
      *     this.viewer.syncOverlay();
      *     this.viewer.resize();
      *
-     *     this.viewer.emitEvent({ type: "databasechunk", data: model, file });
+     *     this.viewer.emitEvent({ type: "databasechunk", data, file });
      *
      *     return Promise.resove(this);
      *   };
@@ -4470,9 +4585,9 @@
      */
     const loaders = loadersRegistry("visualizejs");
     // build-in loaders
-    loaders.registerLoader("vsf-buffer", (viewer) => new VSFBufferLoader(viewer));
+    loaders.registerLoader("vsf-file", (viewer) => new VSFFileLoader(viewer));
     loaders.registerLoader("vsf-cloud", (viewer) => new VSFCloudLoader(viewer));
-    loaders.registerLoader("vsfx-buffer", (viewer) => new VSFXBufferLoader(viewer));
+    loaders.registerLoader("vsfx-file", (viewer) => new VSFXFileLoader(viewer));
     loaders.registerLoader("vsfx-cloud", (viewer) => new VSFXCloudLoader(viewer));
     loaders.registerLoader("vsfx-cloud-streaming", (viewer) => new VSFXCloudStreamingLoader(viewer));
     loaders.registerLoader("vsfx-cloud-partial", (viewer) => new VSFXCloudPartialLoader(viewer));
@@ -19960,6 +20075,68 @@
             device.delete();
             this.update();
         }
+        /**
+         * Loads a file into the viewer.
+         *
+         * The viewer must be {@link initialize | initialized} before opening the file. Otherwise, `open()` does
+         * nothing.
+         *
+         * This method requires a `Client` instance to be specified to load file from the Open Cloud Server.
+         * The file geometry data on the Open Cloud Server must be converted into a `vsfx` format, otherwise an
+         * exception will be thrown.
+         *
+         * For files from Open Cloud Server, the default model will be loaded. If there is no default model,
+         * first availiable model will be loaded. If no models are found in the file, an exception will be
+         * thrown.
+         *
+         * For URLs, the file extension is used to determine the file format. For a `ArrayBuffer` and `Data
+         * URL`, a file format must be specified using `params.format` parameter (see below). If no appropriate
+         * loader is found for the specified format, an exception will be thrown.
+         *
+         * If there was an active dragger before opening the file, it will be deactivated. After opening the
+         * file, you must manually activate the required dragger.
+         *
+         * To open a large files, enable {@link IOptions.enablePartialMode | partial streaming} mode before
+         * opening. Partial streaming is only supported when opening files from an Open Cloud Server, but not
+         * local files and URLs. Example:
+         *
+         * ```javascript
+         * viewer.options.enableStreamingMode = true;
+         * viewer.options.enablePartialMode = true;
+         * await viewer.open(file);
+         * ```
+         *
+         * Fires:
+         *
+         * - {@link OpenEvent | open}
+         * - {@link GeometryStartEvent | geometrystart}
+         * - {@link GeometryProgressEvent | geometryprogress}
+         * - {@link DatabaseChunkEvent | databasechunk}
+         * - {@link GeometryChunkEvent | geometrychunk}
+         * - {@link GeometryEndEvent | geometryend}
+         * - {@link GeometryErrorEvent | geometryerror}
+         *
+         * @param file - File to load. Can be one of:
+         *
+         *   - `File`, `Assembly` or `Model` instance from the Open Cloud Server
+         *   - File `URL` string
+         *   - {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL} string
+         *   - {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object
+         *   - {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer}
+         *       object
+         *
+         * @param params - Loading parameters.
+         * @param params.format - File format string. Required when loading a file as `ArrayBuffer` or `Data
+         *   URL`.
+         * @param params.mode - Reserved for future use.
+         * @param params.requestHeader - The
+         *   {@link https://developer.mozilla.org/docs/Glossary/Request_header | request header} used in HTTP
+         *   request.
+         * @param params.withCredentials - Whether the HTTP request uses credentials such as cookies,
+         *   authorization headers or TLS client certificates. See
+         *   {@link https://developer.mozilla.org/docs/Web/API/XMLHttpRequest/withCredentials | XMLHttpRequest.withCredentials}
+         *   for more details.
+         */
         async open(file, params = {}) {
             if (!this.visualizeJs)
                 return this;
@@ -20002,8 +20179,11 @@
         }
         /**
          * Deprecated since `26.4`. Use {@link open | open()} instead.
+         *
+         * @deprecated
          */
         openVsfFile(buffer) {
+            console.warn("Viewer.openVsfFile() has been deprecated since 26.4 and will be removed in a future release, use Viewer.open() instead.");
             if (!this.visualizeJs)
                 return this;
             this.cancel();
@@ -20030,26 +20210,12 @@
             return this;
         }
         /**
-         * Loads a `VSFX` file into the viewer.
-         *
-         * This method does not support {@link IOptions.enableStreamingMode | streaming} or
-         * {@link IOptions.enablePartialMode | partial streaming} mode.
-         *
-         * If there was an active dragger before opening the file, it will be deactivated. After opening the
-         * file, you must manually activate the required dragger.
-         *
-         * Fires:
-         *
-         * - {@link OpenEvent | open}
-         * - {@link GeometryStartEvent | geometrystart}
-         * - {@link GeometryProgressEvent | geometryprogress}
-         * - {@link DatabaseChunkEvent | databasechunk}
-         * - {@link GeometryEndEvent | geometryend}
-         * - {@link GeometryErrorEvent | geometryerror}
+         * Deprecated since `26.4`. Use {@link open | open()} instead.
          *
-         * @param buffer - Binary data buffer to load.
+         * @deprecated
          */
         openVsfxFile(buffer) {
+            console.warn("Viewer.openVsfxFile() has been deprecated since 26.4 and will be removed in a future release, use Viewer.open() instead.");
             if (!this.visualizeJs)
                 return this;
             this.cancel();
@@ -20293,6 +20459,7 @@
     exports.CanvasEvents = CanvasEvents;
     exports.Component = Component;
     exports.Dragger = Dragger;
+    exports.FileLoader = FileLoader;
     exports.Loader = Loader;
     exports.Markup = KonvaMarkup;
     exports.OdBaseDragger = OdBaseDragger;