@inweb/client 25.3.18 → 25.3.20

package/lib/Api/Assembly.d.ts

@@ -110,14 +110,14 @@ export declare class Assembly {
      *
      * @async
      */
-    checkout(): Promise<Assembly>;
+    checkout(): Promise<this>;
     /**
      * Updates assembly data on the server.
      *
      * @async
      * @param data - Raw assembly data.
      */
-    update(data: any): Promise<Assembly>;
+    update(data: any): Promise<this>;
     /**
      * Delete the assembly from the server.
      *
@@ -131,8 +131,8 @@ export declare class Assembly {
      *
      * @async
      */
-    save(): Promise<Assembly>;
-    setPreview(image: BodyInit | null): Promise<Awaited<this>>;
+    save(): Promise<this>;
+    setPreview(image: BodyInit | null): Promise<this>;
     /**
      * Returns list of assembly models.
      *
@@ -168,7 +168,7 @@ export declare class Assembly {
      * @param handle - Model handle.
      * @param transform - Transformation matrix. To delete transformation provide this to `undefined`.
      */
-    setModelTransformMatrix(handle: string, transform: any): Promise<Assembly>;
+    setModelTransformMatrix(handle: string, transform: any): Promise<this>;
     /**
      * Returns the properties for an objects in the assembly.
      *
@@ -240,11 +240,11 @@ export declare class Assembly {
      *   ="_blank">AbortSignal</a> object instance. Allows to communicate with a fetch request
      *   and abort it if desired.
      */
-    downloadResourceRange(dataId: string, ranges: Array<{
+    downloadResourceRange(dataId: string, requestId: number, ranges: Array<{
         begin: number;
         end: number;
         requestId: number;
-    }>, requestId: number, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
+    }>, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
     /**
      * Deprecated since `25.3`. Use {@link Assembly.downloadResource()} instead.
      */
@@ -253,10 +253,7 @@ export declare class Assembly {
      * Deprecated since `25.3`. Use {@link Assembly.downloadResourceRange()} instead.
      */
     downloadFileRange(requestId: number, records: any | null, dataId: string, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<void>;
-    getReferences(signal?: AbortSignal): Promise<{
-        fileId: string;
-        references: any[];
-    }>;
+    getReferences(signal?: AbortSignal): Promise<any>;
     /**
      * Wait for assembly to be created. Assembly is created when it changes to `done` or `failed` status.
      *
@@ -270,14 +267,13 @@ export declare class Assembly {
      *   href="https://developer.mozilla.org/docs/Web/API/AbortController">AbortController</a>
      *   signal object instance, which can be used to abort waiting as desired.
      * @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
-     * @returns {Promise<Assembly>}
      */
     waitForDone(params?: {
         timeout?: number;
         interval?: number;
         signal?: AbortSignal;
         onCheckout?: (assembly: Assembly, ready: boolean) => boolean;
-    }): Promise<Assembly>;
+    }): Promise<this>;
     /**
      * Returns a list of assembly clash tests.
      *
@@ -357,6 +353,6 @@ export declare class Assembly {
     getVersions(): Promise<Assembly[] | undefined>;
     getVersion(version: number): Promise<Assembly>;
     deleteVersion(version: number): Promise<any>;
-    setActiveVersion(version: number): Promise<Assembly>;
+    setActiveVersion(version: number): Promise<this>;
     useVersion(version?: number): this;
 }

package/lib/Api/ClashTest.d.ts

@@ -13,9 +13,9 @@ export declare class ClashTest {
      * @param httpClient - Http client.
      */
     constructor(data: any, basePath: string, httpClient: IHttpClient);
-    protected internalGet(relativePath: string): Promise<any>;
-    protected internalPut(relativePath: string, body?: BodyInit | object): Promise<any>;
-    protected internalDelete(relativePath: string): Promise<any>;
+    protected internalGet(relativePath: string): Promise<Response>;
+    protected internalPut(relativePath: string, body?: BodyInit | object): Promise<Response>;
+    protected internalDelete(relativePath: string): Promise<Response>;
     /**
      * The type of the clashes that the test detects:
      *

package/lib/Api/FetchError.d.ts

@@ -1,5 +1,5 @@
 export declare function statusText(status: number): string;
-export declare function error400(text: string, _default?: string): any;
+export declare function error400(text: string, _default?: string): string;
 /**
  * The `FetchError` object indicates an error when request to Open Cloud Server could not be
  * performed. A `FetchError` is typically (but not exclusively) thrown when a network error

package/lib/Api/File.d.ts

@@ -174,14 +174,14 @@ export declare class File {
      *
      * @async
      */
-    checkout(): Promise<File>;
+    checkout(): Promise<this>;
     /**
      * Update file data on the server.
      *
      * @async
      * @param data - Raw file data.
      */
-    update(data: any): Promise<File>;
+    update(data: any): Promise<this>;
     /**
      * Delete the file and all its versions from the server.
      *
@@ -195,7 +195,7 @@ export declare class File {
      *
      * @async
      */
-    save(): Promise<File>;
+    save(): Promise<this>;
     /**
      * Set or remove the file preview.
      *
@@ -209,7 +209,7 @@ export declare class File {
      *   Web API <a href="https://developer.mozilla.org/docs/Web/API/File"
      *   target="_blank">File</a> object. Setting the `image` to `null` will remove the preview.
      */
-    setPreview(image: BodyInit | null): Promise<File>;
+    setPreview(image: BodyInit | null): Promise<this>;
     /**
      * Returns a list of models of the active version of the file.
      *
@@ -217,7 +217,7 @@ export declare class File {
      */
     getModels(): Promise<Model[]>;
     getModelTransformMatrix(handle: string): any;
-    setModelTransformMatrix(handle: string, transform: any): Promise<File>;
+    setModelTransformMatrix(handle: string, transform: any): Promise<this>;
     /**
      * Object properties.
      *
@@ -363,11 +363,11 @@ export declare class File {
      *   ="_blank">AbortSignal</a> object instance. Allows to communicate with a fetch request
      *   and abort it if desired.
      */
-    downloadResourceRange(dataId: string, ranges: Array<{
+    downloadResourceRange(dataId: string, requestId: number, ranges: Array<{
         begin: number;
         end: number;
         requestId: number;
-    }>, requestId: number, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
+    }>, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
     /**
      * Deprecated since `25.3`. Use {@link File.downloadResource()} instead.
      */
@@ -469,7 +469,7 @@ export declare class File {
      * @param {function} [params.onCheckout] - Waiting progress callback. Return `true` to cancel waiting.
      * @returns {Promise<File>}
      */
-    waitForDone(jobs: any, waitAll?: boolean, params?: {
+    waitForDone(jobs: string | string[], waitAll?: boolean, params?: {
         timeout?: number;
         interval?: number;
         signal?: AbortSignal;
@@ -563,7 +563,7 @@ export declare class File {
      * @async
      * @param version - Desired active version.
      */
-    setActiveVersion(version: number): Promise<File>;
+    setActiveVersion(version: number): Promise<this>;
     /**
      * Use given version instead of active version for current file on client side. This version
      * change will affect the result:

package/lib/Api/HttpClient.d.ts

@@ -10,7 +10,7 @@ export declare class HttpClient implements IHttpClient {
     delete(relativePath: string): Promise<Response>;
     uploadFile(relativePath: string, file: File, onProgress?: (progress: number) => void): Promise<XMLHttpRequest>;
     downloadFile(relativePath: string, onProgress?: (progress: number, chunk: Uint8Array) => void, signal?: AbortSignal): Promise<Response>;
-    downloadFileRange(relativePath: string, ranges: Array<{
+    downloadFileRange(relativePath: string, requestId: number, ranges: Array<{
         begin: number;
         end: number;
         requestId: number;

package/lib/Api/IHttpClient.d.ts

@@ -8,7 +8,7 @@ export interface IHttpClient {
     delete(relativePath: string): Promise<Response>;
     uploadFile(relativePath: string, file: globalThis.File, onProgress?: (progress: number) => void): Promise<XMLHttpRequest>;
     downloadFile(relativePath: string, onProgress?: (progress: number, chunk: Uint8Array) => void, signal?: AbortSignal): Promise<Response>;
-    downloadFileRange(relativePath: string, ranges: Array<{
+    downloadFileRange(relativePath: string, requestId: number, ranges: Array<{
         begin: number;
         end: number;
         requestId: number;

package/lib/Api/Job.d.ts

@@ -102,14 +102,14 @@ export declare class Job {
      *
      * @async
      */
-    checkout(): Promise<Job>;
+    checkout(): Promise<this>;
     /**
      * Update job data on the server. Only admins can update job data.
      *
      * @async
      * @param data - Raw job data.
      */
-    update(data: any): Promise<Job>;
+    update(data: any): Promise<this>;
     /**
      * Remove a job from the server job list. Jobs that are in progress or have already been
      * completed cannot be deleted.
@@ -137,5 +137,5 @@ export declare class Job {
         interval?: number;
         signal?: AbortSignal;
         onCheckout?: (job: Job, ready: boolean) => boolean;
-    }): Promise<Job>;
+    }): Promise<this>;
 }

package/lib/Api/Member.d.ts

@@ -59,14 +59,14 @@ export declare class Member {
      *
      * @async
      */
-    checkout(): Promise<Member>;
+    checkout(): Promise<this>;
     /**
      * Update member data on the server.
      *
      * @async
      * @param data - Raw member data.
      */
-    update(data: any): Promise<Member>;
+    update(data: any): Promise<this>;
     /**
      * Remove a member from a project.
      *
@@ -80,5 +80,5 @@ export declare class Member {
      *
      * @async
      */
-    save(): Promise<Member>;
+    save(): Promise<this>;
 }

package/lib/Api/Model.d.ts

@@ -169,11 +169,11 @@ export declare class Model {
      *   ="_blank">AbortSignal</a> object instance. Allows to communicate with a fetch request
      *   and abort it if desired.
      */
-    downloadResourceRange(dataId: string, ranges: Array<{
+    downloadResourceRange(dataId: string, requestId: number, ranges: Array<{
         begin: number;
         end: number;
         requestId: number;
-    }>, requestId: number, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
+    }>, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
     /**
      * Deprecated since `25.3`. Use {@link Model.downloadResource()} instead.
      */
@@ -190,8 +190,5 @@ export declare class Model {
      *   href="https://developer.mozilla.org/docs/Web/API/AbortController">AbortController</a>
      *   signal object instance, which can be used to abort waiting as desired.
      */
-    getReferences(signal?: AbortSignal): Promise<import("./IFile").IFileReferences> | Promise<{
-        fileId: string;
-        references: any[];
-    }>;
+    getReferences(signal?: AbortSignal): Promise<any>;
 }

package/lib/Api/Permission.d.ts

@@ -67,14 +67,14 @@ export declare class Permission {
      *
      * @async
      */
-    checkout(): Promise<Permission>;
+    checkout(): Promise<this>;
     /**
      * Update permission data on the server.
      *
      * @async
      * @param data - Raw permission data.
      */
-    update(data: any): Promise<Permission>;
+    update(data: any): Promise<this>;
     /**
      * Remove a permission from a file.
      *
@@ -88,5 +88,5 @@ export declare class Permission {
      *
      * @async
      */
-    save(): Promise<Permission>;
+    save(): Promise<this>;
 }

package/lib/Api/Project.d.ts

@@ -127,14 +127,14 @@ export declare class Project {
      *
      * @async
      */
-    checkout(): Promise<Project>;
+    checkout(): Promise<this>;
     /**
      * Update project data on the server.
      *
      * @async
      * @param data - Raw project data.
      */
-    update(data: any): Promise<Project>;
+    update(data: any): Promise<this>;
     /**
      * Delete the project from the server.
      *
@@ -148,7 +148,7 @@ export declare class Project {
      *
      * @async
      */
-    save(): Promise<Project>;
+    save(): Promise<this>;
     /**
      * Set or remove the project preview.
      *
@@ -162,7 +162,7 @@ export declare class Project {
      *   Web API <a href="https://developer.mozilla.org/docs/Web/API/File"
      *   target="_blank">File</a> object. Setting the `image` to `null` will remove the preview.
      */
-    setPreview(image: BodyInit | null): Promise<this>;
+    setPreview(image: BodyInit | null): Promise<any>;
     /**
      * Returns a list of project roles. Project {@link Member | members} have different abilities
      * depending on the role they have in a project.

package/lib/Api/Role.d.ts

@@ -56,14 +56,14 @@ export declare class Role {
      *
      * @async
      */
-    checkout(): Promise<Role>;
+    checkout(): Promise<this>;
     /**
      * Update role data on the server.
      *
      * @async
      * @param data - Raw role data.
      */
-    update(data: any): Promise<Role>;
+    update(data: any): Promise<this>;
     /**
      * Delete a role from the project.
      *
@@ -77,5 +77,5 @@ export declare class Role {
      *
      * @async
      */
-    save(): Promise<Role>;
+    save(): Promise<this>;
 }

package/lib/Api/User.d.ts

@@ -147,7 +147,7 @@ export declare class User {
      * does not have administrator rights, hi can only checkout himself, otherwise an exception
      * will be thrown.
      */
-    checkout(): Promise<User>;
+    checkout(): Promise<this>;
     /**
      * Update user data on the server. Only admins can update other users, if the current logged
      * in user does not have administrator rights, hi can only update himself, otherwise an
@@ -176,7 +176,7 @@ export declare class User {
      *
      * @async
      */
-    save(): Promise<User>;
+    save(): Promise<this>;
     /**
      * Set or remove the user avatar. Only admins can set the avatar of other users, if the
      * current logged in user does not have administrator rights, he can only set his own avatar,
@@ -192,5 +192,5 @@ export declare class User {
      *   Web API <a href="https://developer.mozilla.org/docs/Web/API/File"
      *   target="_blank">File</a> object. Setting the `image` to `null` will remove the avatar.
      */
-    setAvatar(image: BodyInit | null): Promise<User>;
+    setAvatar(image: BodyInit | null): Promise<this>;
 }

package/lib/Api/Utils.d.ts

@@ -6,6 +6,6 @@ export declare function waitFor(func: (params: any) => Promise<boolean>, params?
     timeoutError?: DOMException;
     result?: any;
 }): Promise<any>;
-export declare function parseArgs(args: string | object): object;
+export declare function parseArgs(args?: string | object): object;
 export declare function userFullName(firstName: string | any, lastName?: string, userName?: string): string;
 export declare function userInitials(fullName?: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.3.18",
+  "version": "25.3.20",
   "description": "JavaScript REST API client for the Open Cloud Server",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -27,6 +27,6 @@
     "ts-docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/eventemitter2": "^25.3.13"
+    "@inweb/eventemitter2": "^25.3.19"
   }
 }

package/src/Api/Assembly.ts

@@ -54,22 +54,22 @@ export class Assembly {
     return `${relativePath}${delimiter}version=${this._useVersion}`;
   }
 
-  protected internalGet(relativePath: string, signal?: AbortSignal) {
+  protected internalGet(relativePath: string, signal?: AbortSignal): Promise<Response> {
     relativePath = this.appendVersionParam(relativePath);
     return this.httpClient.get(`${this.path}${relativePath}`, signal);
   }
 
-  protected internalPost(relativePath: string, body?: BodyInit | object) {
+  protected internalPost(relativePath: string, body?: BodyInit | object): Promise<Response> {
     relativePath = this.appendVersionParam(relativePath);
     return this.httpClient.post(`${this.path}${relativePath}`, body);
   }
 
-  protected internalPut(relativePath: string, body?: BodyInit | object) {
+  protected internalPut(relativePath: string, body?: BodyInit | object): Promise<Response> {
     relativePath = this.appendVersionParam(relativePath);
     return this.httpClient.put(`${this.path}${relativePath}`, body);
   }
 
-  protected internalDelete(relativePath: string) {
+  protected internalDelete(relativePath: string): Promise<Response> {
     relativePath = this.appendVersionParam(relativePath);
     return this.httpClient.delete(`${this.path}${relativePath}`);
   }
@@ -184,7 +184,7 @@ export class Assembly {
   // Reserved for future use
 
   get previewUrl(): string {
-    return this.data.previewUrl ?? "";
+    return this.data.previewUrl || "";
   }
 
   /**
@@ -231,7 +231,7 @@ export class Assembly {
    *
    * @async
    */
-  async checkout(): Promise<Assembly> {
+  async checkout(): Promise<this> {
     const response = await this.internalGet("");
     this.data = await response.json();
     return this;
@@ -243,7 +243,7 @@ export class Assembly {
    * @async
    * @param data - Raw assembly data.
    */
-  async update(data: any): Promise<Assembly> {
+  async update(data: any): Promise<this> {
     const response = await this.internalPut("", data);
     this.data = await response.json();
     return this;
@@ -265,13 +265,13 @@ export class Assembly {
    *
    * @async
    */
-  save(): Promise<Assembly> {
+  save(): Promise<this> {
     return this.update(this.data);
   }
 
   // Reserved for future use
 
-  setPreview(image: BodyInit | null) {
+  setPreview(image: BodyInit | null): Promise<this> {
     console.warn("Assembly does not support preview");
     return Promise.resolve(this);
   }
@@ -320,7 +320,7 @@ export class Assembly {
    * @param handle - Model handle.
    * @param transform - Transformation matrix. To delete transformation provide this to `undefined`.
    */
-  setModelTransformMatrix(handle: string, transform: any): Promise<Assembly> {
+  setModelTransformMatrix(handle: string, transform: any): Promise<this> {
     const obj = { ...this.data.transform };
     obj[handle] = transform;
     return this.update({ transform: obj });
@@ -441,14 +441,14 @@ export class Assembly {
    */
   downloadResourceRange(
     dataId: string,
-    ranges: Array<{ begin: number; end: number; requestId: number }>,
     requestId: number,
+    ranges: Array<{ begin: number; end: number; requestId: number }>,
     onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void,
     signal?: AbortSignal
   ): Promise<ArrayBuffer> {
     const relativePath = this.appendVersionParam(`/downloads/${dataId}?requestId=${requestId}`);
     return this.httpClient
-      .downloadFileRange(`${this.path}${relativePath}`, ranges, onProgress, signal)
+      .downloadFileRange(`${this.path}${relativePath}`, requestId, ranges, onProgress, signal)
       .then((response) => response.arrayBuffer());
   }
 
@@ -476,12 +476,12 @@ export class Assembly {
     onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void,
     signal?: AbortSignal
   ): Promise<void> {
-    await this.downloadResourceRange(dataId, records, requestId, onProgress, signal);
+    await this.downloadResourceRange(dataId, requestId, records, onProgress, signal);
   }
 
   // Reserved for future use
 
-  getReferences(signal?: AbortSignal) {
+  getReferences(signal?: AbortSignal): Promise<any> {
     return Promise.resolve({ fileId: "", references: [] });
   }
 
@@ -498,14 +498,13 @@ export class Assembly {
    *   href="https://developer.mozilla.org/docs/Web/API/AbortController">AbortController</a>
    *   signal object instance, which can be used to abort waiting as desired.
    * @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
-   * @returns {Promise<Assembly>}
    */
   waitForDone(params?: {
     timeout?: number;
     interval?: number;
     signal?: AbortSignal;
     onCheckout?: (assembly: Assembly, ready: boolean) => boolean;
-  }): Promise<Assembly> {
+  }): Promise<this> {
     const checkDone = () =>
       this.checkout().then((assembly) => {
         const ready = ["done", "failed"].includes(assembly.status);
@@ -673,11 +672,11 @@ export class Assembly {
     return Promise.reject(new FetchError(404));
   }
 
-  setActiveVersion(version: number) {
+  setActiveVersion(version: number): Promise<this> {
     return this.update({ activeVersion: version });
   }
 
-  useVersion(version?: number) {
+  useVersion(version?: number): this {
     this._useVersion = undefined;
     return this;
   }

package/src/Api/ClashTest.ts

@@ -44,15 +44,15 @@ export class ClashTest {
     this.data = data;
   }
 
-  protected internalGet(relativePath: string): Promise<any> {
+  protected internalGet(relativePath: string): Promise<Response> {
     return this.httpClient.get(`${this.basePath}/clashes/${this.id}${relativePath}`);
   }
 
-  protected internalPut(relativePath: string, body?: BodyInit | object): Promise<any> {
+  protected internalPut(relativePath: string, body?: BodyInit | object): Promise<Response> {
     return this.httpClient.put(`${this.basePath}/clashes/${this.id}${relativePath}`, body);
   }
 
-  protected internalDelete(relativePath: string): Promise<any> {
+  protected internalDelete(relativePath: string): Promise<Response> {
     return this.httpClient.delete(`${this.basePath}/clashes/${this.id}${relativePath}`);
   }
 
@@ -265,7 +265,7 @@ export class ClashTest {
    *   href="https://developer.mozilla.org/docs/Web/API/AbortController">AbortController</a>
    *   signal object instance, which can be used to abort waiting as desired.
    */
-  waitForDone(params?: { timeout?: number; interval?: number; signal?: AbortSignal }) {
+  waitForDone(params?: { timeout?: number; interval?: number; signal?: AbortSignal }): Promise<this> {
     const checkDone = () => this.checkout().then((test) => ["done", "failed"].includes(test.status));
     return waitFor(checkDone, params).then(() => this);
   }

package/src/Api/Client.ts

@@ -39,12 +39,10 @@ import { parseArgs } from "./Utils";
  * Projects, Files, Issues etc.
  */
 export class Client extends EventEmitter2<ClientEventMap> {
-  private _serverUrl: string;
-
-  private _httpClient: IHttpClient;
-  private _user: User | null;
-
-  public eventEmitter: EventEmitter2;
+  private _serverUrl = "";
+  private _httpClient: IHttpClient = new HttpClient("");
+  private _user: User | null = null;
+  public eventEmitter: EventEmitter2 = this;
 
   /**
    * @param params - An object containing client configuration parameters.
@@ -53,8 +51,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
   constructor(params: { serverUrl?: string; url?: string } = {}) {
     super();
     this.configure(params);
-    this.eventEmitter = this;
-    this._user = null;
   }
 
   /**

package/src/Api/Fetch.ts

@@ -57,7 +57,7 @@ export function $fetch(
   const headers = { ...params.headers };
   delete headers["Content-Type"];
 
-  let body: FormData | string;
+  let body: FormData | string | undefined = undefined;
   if (params.method === "POST" || params.method === "PUT") {
     if (params.body instanceof FormData) {
       body = params.body;

package/src/Api/FetchError.ts

@@ -91,7 +91,7 @@ export function statusText(status: number): string {
   return STATUS_CODES[status] || `Error ${status}`;
 }
 
-export function error400(text: string, _default = "400") {
+export function error400(text: string, _default = "400"): string {
   try {
     return JSON.parse(text).description;
   } catch {