@inweb/client 27.1.6 → 27.1.7

package/lib/Api/Assembly.d.ts

@@ -265,21 +265,12 @@ export declare class Assembly extends Endpoint {
         end: number;
         requestId: number;
     }>, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
-    /**
-     * Deprecated since `25.3`. Use {@link downloadResource | downloadResource()} instead.
-     *
-     * @deprecated
-     */
-    partialDownloadResource(dataId: string, onProgress?: (progress: number, chunk: Uint8Array) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
-    /**
-     * Deprecated since `25.3`. Use {@link downloadResourceRange | downloadResourceRange()} instead.
-     */
-    downloadFileRange(requestId: number, records: any | null, dataId: string, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<void>;
     /**
      * Returns a list of assembly references containing references from all the files from which the
      * assembly was created.
      *
-     * References are images, fonts, or any other files to correct rendering of the assembly.
+     * References are images, fonts, external models or any other files to correct rendering of the
+     * assembly.
      *
      * @param signal - An
      *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal, which

package/lib/Api/Client.d.ts

@@ -22,11 +22,9 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
     /**
      * @param params - An object containing client configuration parameters.
      * @param params.serverUrl - Open Cloud REST API server URL.
-     * @param params.url - Deprecated since `25.8`. Use `serverUrl` instead.
      */
     constructor(params?: {
         serverUrl?: string;
-        url?: string;
     });
     /**
      * Open Cloud REST API server URL. Use {@link configure | configure()} to change server URL.
@@ -40,12 +38,6 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * @readonly
      */
     get httpClient(): IHttpClient;
-    /**
-     * Deprecated since `25.3`. Use `Viewer.options()` instead to change `Viewer` parameters.
-     *
-     * @deprecated
-     */
-    get options(): any;
     /**
      * Changes the client parameters.
      *

package/lib/Api/File.d.ts

@@ -390,22 +390,10 @@ export declare class File extends Endpoint {
         end: number;
         requestId: number;
     }>, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
-    /**
-     * Deprecated since `25.3`. Use {@link downloadResource | downloadResource()} instead.
-     *
-     * @deprecated
-     */
-    partialDownloadResource(dataId: string, onProgress?: (progress: number, downloaded: Uint8Array) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
-    /**
-     * Deprecated since `25.3`. Use {@link downloadResourceRange | downloadResourceRange()} instead.
-     *
-     * @deprecated
-     */
-    downloadFileRange(requestId: number, records: any | null, dataId: string, onProgress?: (progress: number, downloaded: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<void>;
     /**
      * Returns a list of file references.
      *
-     * References are images, fonts, or any other files to correct rendering of the file.
+     * References are images, fonts, external models or any other files to correct rendering of the file.
      *
      * @param signal - An
      *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal, which
@@ -415,8 +403,10 @@ export declare class File extends Endpoint {
     /**
      * Sets the file references.
      *
-     * References are images, fonts, or any other files to correct rendering of the file. Reference files
-     * must be uploaded to the server before they can be assigned to the current file.
+     * References are images, fonts, external models or any other files to correct rendering of the file.
+     *
+     * Reference files must be uploaded to the server before they can be assigned to the current file.
+     * Setting reference files must be done before extracting geometry and properties of the main file.
      *
      * @param references - File references.
      */

package/lib/Api/IFile.d.ts

@@ -47,17 +47,17 @@ export interface IFileReference {
     name: string;
 }
 /**
- * References are images, fonts, or any other files to correct rendering of the file.
+ * References are images, fonts, external models or any other files to correct rendering of the file.
  */
 export interface IFileReferences {
     /**
      * The references list ID, changed after each update of the file references.
      */
-    id: string;
+    id?: string;
     /**
-     * List of file references or `null` if there are no references.
+     * List of file references or an empty list if there are no references.
      */
-    references: IFileReference[] | null;
+    references: IFileReference[];
 }
 /**
  * Defines the information about file version.

package/lib/Api/Model.d.ts

@@ -161,22 +161,10 @@ export declare class Model extends Endpoint {
         end: number;
         requestId: number;
     }>, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
-    /**
-     * Deprecated since `25.3`. Use {@link downloadResource | downloadResource()} instead.
-     *
-     * @deprecated
-     */
-    partialDownloadResource(dataId: string, onProgress?: (progress: number, chunk: Uint8Array) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
-    /**
-     * Deprecated since `25.3`. Use {@link downloadResourceRange | downloadResourceRange()} instead.
-     *
-     * @deprecated
-     */
-    downloadFileRange(requestId: number, records: any | null, dataId: string, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<void>;
     /**
      * Returns a list of references of the owner file/assembly.
      *
-     * References are images, fonts, or any other files to correct rendering of the file.
+     * References are images, fonts, external models or any other files to correct rendering of the file.
      *
      * @param signal - An
      *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal, which

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "27.1.6",
+  "version": "27.1.7",
   "description": "JavaScript REST API client for the Open Cloud Server",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -26,7 +26,7 @@
     "docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/eventemitter2": "~27.1.6"
+    "@inweb/eventemitter2": "~27.1.7"
   },
   "devDependencies": {
     "fflate": "^0.8.2"

package/src/Api/Assembly.ts

@@ -463,40 +463,12 @@ export class Assembly extends Endpoint {
       .then((response) => response.arrayBuffer());
   }
 
-  /**
-   * Deprecated since `25.3`. Use {@link downloadResource | downloadResource()} instead.
-   *
-   * @deprecated
-   */
-  partialDownloadResource(
-    dataId: string,
-    onProgress?: (progress: number, chunk: Uint8Array) => void,
-    signal?: AbortSignal
-  ): Promise<ArrayBuffer> {
-    console.warn(
-      "Assembly.partialDownloadResource() has been deprecated since 25.3 and will be removed in a future release, use Assembly.downloadResource() instead."
-    );
-    return this.downloadResource(dataId, onProgress, signal);
-  }
-
-  /**
-   * Deprecated since `25.3`. Use {@link downloadResourceRange | downloadResourceRange()} instead.
-   */
-  async downloadFileRange(
-    requestId: number,
-    records: any | null,
-    dataId: string,
-    onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void,
-    signal?: AbortSignal
-  ): Promise<void> {
-    await this.downloadResourceRange(dataId, requestId, records, onProgress, signal);
-  }
-
   /**
    * Returns a list of assembly references containing references from all the files from which the
    * assembly was created.
    *
-   * References are images, fonts, or any other files to correct rendering of the assembly.
+   * References are images, fonts, external models or any other files to correct rendering of the
+   * assembly.
    *
    * @param signal - An
    *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal, which

package/src/Api/Client.ts

@@ -52,9 +52,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * @param params - An object containing client configuration parameters.
    * @param params.serverUrl - Open Cloud REST API server URL.
-   * @param params.url - Deprecated since `25.8`. Use `serverUrl` instead.
    */
-  constructor(params: { serverUrl?: string; url?: string } = {}) {
+  constructor(params: { serverUrl?: string } = {}) {
     super();
     this.configure(params);
   }
@@ -77,54 +76,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
     return this._httpClient;
   }
 
-  /**
-   * Deprecated since `25.3`. Use `Viewer.options()` instead to change `Viewer` parameters.
-   *
-   * @deprecated
-   */
-  get options(): any {
-    console.warn(
-      "Client.options has been deprecated since 25.3 and will be removed in a future release, use Viewer.options instead."
-    );
-    const data = {
-      showWCS: true,
-      cameraAnimation: true,
-      antialiasing: true,
-      groundShadow: false,
-      shadows: false,
-      cameraAxisXSpeed: 4,
-      cameraAxisYSpeed: 1,
-      ambientOcclusion: false,
-      enableStreamingMode: true,
-      enablePartialMode: false,
-      memoryLimit: 3294967296,
-      cuttingPlaneFillColor: { red: 0xff, green: 0x98, blue: 0x00 },
-      edgesColor: { r: 0xff, g: 0x98, b: 0x00 },
-      facesColor: { r: 0xff, g: 0x98, b: 0x00 },
-      edgesVisibility: true,
-      edgesOverlap: true,
-      facesOverlap: false,
-      facesTransparancy: 200,
-      enableCustomHighlight: true,
-      sceneGraph: false,
-      edgeModel: true,
-      reverseZoomWheel: false,
-      enableZoomWheel: true,
-      enableGestures: true,
-      geometryType: "vsfx",
-      rulerUnit: "Default",
-      cameraMode: "perspective",
-    };
-    return {
-      ...data,
-      data,
-      defaults: () => data,
-      resetToDefaults: () => {},
-      saveToStorage: () => {},
-      loadFromStorage: () => {},
-    };
-  }
-
   /**
    * Changes the client parameters.
    *

package/src/Api/File.ts

@@ -634,41 +634,10 @@ export class File extends Endpoint {
       .then((response) => response.arrayBuffer());
   }
 
-  /**
-   * Deprecated since `25.3`. Use {@link downloadResource | downloadResource()} instead.
-   *
-   * @deprecated
-   */
-  partialDownloadResource(
-    dataId: string,
-    onProgress?: (progress: number, downloaded: Uint8Array) => void,
-    signal?: AbortSignal
-  ): Promise<ArrayBuffer> {
-    console.warn(
-      "File.partialDownloadResource() has been deprecated since 25.3 and will be removed in a future release, use File.downloadResource() instead."
-    );
-    return this.downloadResource(dataId, onProgress, signal);
-  }
-
-  /**
-   * Deprecated since `25.3`. Use {@link downloadResourceRange | downloadResourceRange()} instead.
-   *
-   * @deprecated
-   */
-  async downloadFileRange(
-    requestId: number,
-    records: any | null,
-    dataId: string,
-    onProgress?: (progress: number, downloaded: Uint8Array, requestId: number) => void,
-    signal?: AbortSignal
-  ): Promise<void> {
-    await this.downloadResourceRange(dataId, requestId, records, onProgress, signal);
-  }
-
   /**
    * Returns a list of file references.
    *
-   * References are images, fonts, or any other files to correct rendering of the file.
+   * References are images, fonts, external models or any other files to correct rendering of the file.
    *
    * @param signal - An
    *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal, which
@@ -681,8 +650,10 @@ export class File extends Endpoint {
   /**
    * Sets the file references.
    *
-   * References are images, fonts, or any other files to correct rendering of the file. Reference files
-   * must be uploaded to the server before they can be assigned to the current file.
+   * References are images, fonts, external models or any other files to correct rendering of the file.
+   *
+   * Reference files must be uploaded to the server before they can be assigned to the current file.
+   * Setting reference files must be done before extracting geometry and properties of the main file.
    *
    * @param references - File references.
    */

package/src/Api/IFile.ts

@@ -79,18 +79,18 @@ export interface IFileReference {
 }
 
 /**
- * References are images, fonts, or any other files to correct rendering of the file.
+ * References are images, fonts, external models or any other files to correct rendering of the file.
  */
 export interface IFileReferences {
   /**
    * The references list ID, changed after each update of the file references.
    */
-  id: string;
+  id?: string;
 
   /**
-   * List of file references or `null` if there are no references.
+   * List of file references or an empty list if there are no references.
    */
-  references: IFileReference[] | null;
+  references: IFileReference[];
 }
 
 /**

package/src/Api/Model.ts

@@ -273,58 +273,10 @@ export class Model extends Endpoint {
     return this._file.downloadResourceRange(dataId, requestId, ranges, onProgress, signal);
   }
 
-  /**
-   * Deprecated since `25.3`. Use {@link downloadResource | downloadResource()} instead.
-   *
-   * @deprecated
-   */
-  partialDownloadResource(
-    dataId: string,
-    onProgress?: (progress: number, chunk: Uint8Array) => void,
-    signal?: AbortSignal
-  ): Promise<ArrayBuffer> {
-    console.warn(
-      "Model.partialDownloadResource() has been deprecated since 25.3 and will be removed in a future release, use Model.downloadResource() instead."
-    );
-    return this.downloadResource(dataId, onProgress, signal);
-  }
-
-  /**
-   * Deprecated since `25.3`. Use {@link downloadResourceRange | downloadResourceRange()} instead.
-   *
-   * @deprecated
-   */
-  async downloadFileRange(
-    requestId: number,
-    records: any | null,
-    dataId: string,
-    onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void,
-    signal?: AbortSignal
-  ): Promise<void> {
-    if (!records) return;
-
-    let ranges = [];
-    if (records.length) {
-      ranges = records.map((record) => ({
-        begin: Number(record.begin),
-        end: Number(record.end),
-        requestId: record.reqId,
-      }));
-    } else {
-      for (let i = 0; i < records.size(); i++) {
-        const record = records.get(i);
-        ranges.push({ begin: Number(record.begin), end: Number(record.end), requestId });
-        record.delete();
-      }
-    }
-
-    await this.downloadResourceRange(dataId, requestId, ranges, onProgress, signal);
-  }
-
   /**
    * Returns a list of references of the owner file/assembly.
    *
-   * References are images, fonts, or any other files to correct rendering of the file.
+   * References are images, fonts, external models or any other files to correct rendering of the file.
    *
    * @param signal - An
    *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal, which