@inweb/viewer-core 26.7.0 → 26.7.2

package/lib/loaders/ILoader.d.ts

@@ -1,7 +1,7 @@
 import type { Assembly, File, Model } from "@inweb/client";
 import type { IViewer } from "../viewer/IViewer";
 /**
- * Defines the file source to load:
+ * Defines the file source to load into the viewer:
  *
  * - `File`, `Assembly` or `Model` instance from the Open Cloud Server
  * - File `URL` string
@@ -9,9 +9,8 @@ import type { IViewer } from "../viewer/IViewer";
  * - {@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
- * - {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} instance
  */
-export type FileSource = File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+export type FileSource = File | Assembly | Model | string | globalThis.File | ArrayBuffer;
 /**
  * Defines the file loading parameters (loader depended).
  */

package/lib/viewer/IViewer.d.ts

@@ -121,22 +121,13 @@ export interface IViewer extends IEventEmitter, ICommandService {
      * first availiable model will be loaded. If no models are found in the file, an exception will be
      * thrown.
      *
-     * The file extension is used to determine the file format. For a `ArrayBuffer`, `Blob` and `Data URL`,
-     * a file format must be specified using `params.format` parameter (see below). If no appropriate
+     * 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. For example:
-     *
-     * ```javascript
-     * viewer.options.enableStreamingMode = true;
-     * viewer.options.enablePartialMode = true;
-     * await viewer.open(file);
-     * ```
-     *
      * Fires:
      *
      * - {@link OpenEvent | open}
@@ -147,18 +138,36 @@ export interface IViewer extends IEventEmitter, ICommandService {
      * - {@link GeometryEndEvent | geometryend}
      * - {@link GeometryErrorEvent | geometryerror}
      *
-     * @param file - File to load.
+     * @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`, `Blob` or
-     *   `Data URL`.
-     * @param params.mode - File opening mode. Can be one of:
+     * @param params.format - File format string. Required when loading a file as `ArrayBuffer` or `Data *
+     *   URL`.
+     * @param params.mode - File opening mode. Viewer specific. Can be one of:
      *
      *   - `open` - Unloads an open file and opens a new one. This is default mode.
      *   - `append` - Appends a file to an already open file. This mode is not supported for all formats.
+     *
+     * @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 mode details.
      */
     open(file: FileSource, params: {
         format?: string;
         mode?: string;
+        requestHeader?: HeadersInit;
+        withCredentials?: boolean;
     }): Promise<this>;
     /**
      * Cancels asynchronous file loading started with {@link open | open()}.

package/lib/viewer/ViewerEvents.d.ts

@@ -110,7 +110,7 @@ export interface DatabaseChunkEvent {
     /**
      * File to load.
      */
-    file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+    file: File | Assembly | Model | string | globalThis.File | ArrayBuffer;
     /**
      * Model from file to load. Only defined when loading a file from the Open Cloud Server.
      */
@@ -170,7 +170,7 @@ export interface GeometryChunkEvent {
     /**
      * File to load.
      */
-    file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+    file: File | Assembly | Model | string | globalThis.File | ArrayBuffer;
     /**
      * Model from file to load. Only defined when loading a file from the Open Cloud Server.
      */
@@ -195,7 +195,7 @@ export interface GeometryEndEvent {
     /**
      * File to load.
      */
-    file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+    file: File | Assembly | Model | string | globalThis.File | ArrayBuffer;
     /**
      * Model from file to load. Only defined when loading a file from the Open Cloud Server.
      */
@@ -224,7 +224,7 @@ export interface GeometryErrorEvent {
     /**
      * File to load.
      */
-    file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+    file: File | Assembly | Model | string | globalThis.File | ArrayBuffer;
     /**
      * Model from file to load. Only defined when loading a file from the Open Cloud Server.
      */
@@ -253,7 +253,7 @@ export interface GeometryProgressEvent {
     /**
      * File to load.
      */
-    file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+    file: File | Assembly | Model | string | globalThis.File | ArrayBuffer;
     /**
      * Model from file to load. Only defined when loading a file from the Open Cloud Server.
      */
@@ -278,7 +278,7 @@ export interface GeometryStartEvent {
     /**
      * File to load.
      */
-    file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+    file: File | Assembly | Model | string | globalThis.File | ArrayBuffer;
     /**
      * Model from file to load. Only defined when loading a file from the Open Cloud Server.
      */
@@ -361,7 +361,7 @@ export interface OpenEvent {
     /**
      * File to load.
      */
-    file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+    file: File | Assembly | Model | string | globalThis.File | ArrayBuffer;
     /**
      * Model from file to load. Only defined when loading a file from the Open Cloud Server.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/viewer-core",
-  "version": "26.7.0",
+  "version": "26.7.2",
   "description": "3D CAD and BIM data Viewer core",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -26,7 +26,7 @@
     "test": "karma start karma.conf.js"
   },
   "dependencies": {
-    "@inweb/client": "~26.7.0",
-    "@inweb/eventemitter2": "~26.7.0"
+    "@inweb/client": "~26.7.2",
+    "@inweb/eventemitter2": "~26.7.2"
   }
 }

package/src/loaders/ILoader.ts

@@ -25,7 +25,7 @@ import type { Assembly, File, Model } from "@inweb/client";
 import type { IViewer } from "../viewer/IViewer";
 
 /**
- * Defines the file source to load:
+ * Defines the file source to load into the viewer:
  *
  * - `File`, `Assembly` or `Model` instance from the Open Cloud Server
  * - File `URL` string
@@ -33,9 +33,8 @@ import type { IViewer } from "../viewer/IViewer";
  * - {@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
- * - {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} instance
  */
-export type FileSource = File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+export type FileSource = File | Assembly | Model | string | globalThis.File | ArrayBuffer;
 
 /**
  * Defines the file loading parameters (loader depended).

package/src/viewer/IViewer.ts

@@ -155,22 +155,13 @@ export interface IViewer extends IEventEmitter, ICommandService {
    * first availiable model will be loaded. If no models are found in the file, an exception will be
    * thrown.
    *
-   * The file extension is used to determine the file format. For a `ArrayBuffer`, `Blob` and `Data URL`,
-   * a file format must be specified using `params.format` parameter (see below). If no appropriate
+   * 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. For example:
-   *
-   * ```javascript
-   * viewer.options.enableStreamingMode = true;
-   * viewer.options.enablePartialMode = true;
-   * await viewer.open(file);
-   * ```
-   *
    * Fires:
    *
    * - {@link OpenEvent | open}
@@ -181,16 +172,40 @@ export interface IViewer extends IEventEmitter, ICommandService {
    * - {@link GeometryEndEvent | geometryend}
    * - {@link GeometryErrorEvent | geometryerror}
    *
-   * @param file - File to load.
+   * @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`, `Blob` or
-   *   `Data URL`.
-   * @param params.mode - File opening mode. Can be one of:
+   * @param params.format - File format string. Required when loading a file as `ArrayBuffer` or `Data *
+   *   URL`.
+   * @param params.mode - File opening mode. Viewer specific. Can be one of:
    *
    *   - `open` - Unloads an open file and opens a new one. This is default mode.
    *   - `append` - Appends a file to an already open file. This mode is not supported for all formats.
+   *
+   * @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 mode details.
    */
-  open(file: FileSource, params: { format?: string; mode?: string }): Promise<this>;
+  open(
+    file: FileSource,
+    params: {
+      format?: string;
+      mode?: string;
+      requestHeader?: HeadersInit;
+      withCredentials?: boolean;
+    }
+  ): Promise<this>;
 
   /**
    * Cancels asynchronous file loading started with {@link open | open()}.

package/src/viewer/ViewerEvents.ts

@@ -120,7 +120,7 @@ export interface DatabaseChunkEvent {
   /**
    * File to load.
    */
-  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer;
 
   /**
    * Model from file to load. Only defined when loading a file from the Open Cloud Server.
@@ -188,7 +188,7 @@ export interface GeometryChunkEvent {
   /**
    * File to load.
    */
-  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer;
 
   /**
    * Model from file to load. Only defined when loading a file from the Open Cloud Server.
@@ -217,7 +217,7 @@ export interface GeometryEndEvent {
   /**
    * File to load.
    */
-  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer;
 
   /**
    * Model from file to load. Only defined when loading a file from the Open Cloud Server.
@@ -251,7 +251,7 @@ export interface GeometryErrorEvent {
   /**
    * File to load.
    */
-  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer;
 
   /**
    * Model from file to load. Only defined when loading a file from the Open Cloud Server.
@@ -285,7 +285,7 @@ export interface GeometryProgressEvent {
   /**
    * File to load.
    */
-  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer;
 
   /**
    * Model from file to load. Only defined when loading a file from the Open Cloud Server.
@@ -314,7 +314,7 @@ export interface GeometryStartEvent {
   /**
    * File to load.
    */
-  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer;
 
   /**
    * Model from file to load. Only defined when loading a file from the Open Cloud Server.
@@ -408,7 +408,7 @@ export interface OpenEvent {
   /**
    * File to load.
    */
-  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer | Blob;
+  file: File | Assembly | Model | string | globalThis.File | ArrayBuffer;
 
   /**
    * Model from file to load. Only defined when loading a file from the Open Cloud Server.