@inweb/client 25.3.19 → 25.3.21

package/src/Api/File.ts

@@ -54,22 +54,22 @@ export class File {
     return `${relativePath}${delimiter}version=${this._useVersion}`;
   }
 
-  private internalGet(relativePath: string, signal?: AbortSignal) {
+  private internalGet(relativePath: string, signal?: AbortSignal): Promise<Response> {
     relativePath = this.appendVersionParam(relativePath);
     return this.httpClient.get(`${this.path}${relativePath}`, signal);
   }
 
-  private internalPost(relativePath: string, body?: BodyInit | object) {
+  private internalPost(relativePath: string, body?: BodyInit | object): Promise<Response> {
     relativePath = this.appendVersionParam(relativePath);
     return this.httpClient.post(`${this.path}${relativePath}`, body);
   }
 
-  private internalPut(relativePath: string, body?: BodyInit | object) {
+  private internalPut(relativePath: string, body?: BodyInit | object): Promise<Response> {
     relativePath = this.appendVersionParam(relativePath);
     return this.httpClient.put(`${this.path}${relativePath}`, body);
   }
 
-  private internalDelete(relativePath: string) {
+  private internalDelete(relativePath: string): Promise<Response> {
     relativePath = this.appendVersionParam(relativePath);
     return this.httpClient.delete(`${this.path}${relativePath}`);
   }
@@ -314,7 +314,7 @@ export class File {
    *
    * @async
    */
-  async checkout(): Promise<File> {
+  async checkout(): Promise<this> {
     const response = await this.internalGet("");
     this.data = await response.json();
     return this;
@@ -326,7 +326,7 @@ export class File {
    * @async
    * @param data - Raw file data.
    */
-  async update(data: any): Promise<File> {
+  async update(data: any): Promise<this> {
     const response = await this.internalPut("", data);
     this.data = await response.json();
     return this;
@@ -348,7 +348,7 @@ export class File {
    *
    * @async
    */
-  save(): Promise<File> {
+  save(): Promise<this> {
     return this.update(this.data);
   }
 
@@ -365,7 +365,7 @@ export 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.
    */
-  async setPreview(image: BodyInit | null): Promise<File> {
+  async setPreview(image: BodyInit | null): Promise<this> {
     const response = await (image ? this.internalPost("/preview", image) : this.internalDelete("/preview"));
     this.data = await response.json();
     return this;
@@ -388,7 +388,7 @@ export class File {
     return undefined;
   }
 
-  setModelTransformMatrix(handle: string, transform: any): Promise<File> {
+  setModelTransformMatrix(handle: string, transform: any): Promise<this> {
     console.warn("File does not support model transformation");
     return Promise.resolve(this);
   }
@@ -483,8 +483,7 @@ export class File {
   }
 
   /**
-   * Add new file viewpoint. To create a new viewpoint use
-   * {@link Viewer#createViewpoint | Viewer.createViewpoint()}.
+   * Add new file viewpoint. To create a new viewpoint use `Viewer.createViewpoint()`.
    *
    * @async
    * @param viewpoint - Viewpoint.
@@ -745,7 +744,7 @@ export class File {
    * @returns {Promise<File>}
    */
   waitForDone(
-    jobs,
+    jobs: string | string[],
     waitAll?: boolean,
     params?: {
       timeout?: number;
@@ -754,15 +753,16 @@ export class File {
       onCheckout?: (file: File, ready: boolean) => boolean;
     }
   ): Promise<this> {
-    if (!Array.isArray(jobs)) jobs = [jobs];
+    const waitJobs = Array.isArray(jobs) ? jobs : [jobs];
     if (waitAll === undefined) waitAll = true;
 
     const checkDone = () =>
       this.checkout().then((file) => {
-        const readyJobs = jobs.filter((x: string) =>
-          ["none", "done", "failed"].includes(file.status[x]?.state ?? "none")
-        );
-        const ready = waitAll ? readyJobs.length === jobs.length : readyJobs.length > 0;
+        const readyJobs = waitJobs.filter((job: string) => {
+          const jobStatus = file.status[job] || { state: none };
+          return ["none", "done", "failed"].includes(jobStatus.state);
+        });
+        const ready = waitAll ? readyJobs.length === waitJobs.length : readyJobs.length > 0;
         const cancel = params?.onCheckout?.(file, ready);
         return cancel || ready;
       });
@@ -923,7 +923,7 @@ export class File {
    * @param version - Desired active version.
    */
 
-  setActiveVersion(version: number): Promise<File> {
+  setActiveVersion(version: number): Promise<this> {
     return this.update({ activeVersion: version });
   }
 

package/src/Api/HttpClient.ts

@@ -27,8 +27,8 @@ import { $xmlhttp } from "./XMLHttp";
 
 export class HttpClient implements IHttpClient {
   serverUrl: string;
-  headers: HeadersInit;
-  signInUserId: string;
+  headers: HeadersInit = {};
+  signInUserId = "";
 
   constructor(serverUrl: string) {
     this.serverUrl = serverUrl;
@@ -90,7 +90,7 @@ export class HttpClient implements IHttpClient {
   ): Promise<Response> {
     const response = await this.get(relativePath, signal);
     const contentLength = response.headers.get("Content-Length");
-    const total = parseInt(contentLength, 10) || 1;
+    const total = parseInt(contentLength || "", 10) || 1;
     return new Response(
       new ReadableStream({
         async start(controller) {
@@ -120,7 +120,7 @@ export class HttpClient implements IHttpClient {
     headers["Range"] = "bytes=" + ranges.map((x) => `${x.begin}-${x.end}`).join(",");
     const response = await $fetch(`${this.serverUrl}${relativePath}`, { method: "GET", headers, signal });
     const contentLength = response.headers.get("content-length");
-    const total = parseInt(contentLength, 10) || 1;
+    const total = parseInt(contentLength || "", 10) || 1;
     return new Response(
       new ReadableStream({
         async start(controller) {

package/src/Api/Job.ts

@@ -41,15 +41,15 @@ export class Job {
     this.data = data;
   }
 
-  protected internalGet() {
+  protected internalGet(): Promise<Response> {
     return this.httpClient.get(`/jobs/${this.data.id}`);
   }
 
-  protected internalPut(body?: BodyInit | object) {
+  protected internalPut(body?: BodyInit | object): Promise<Response> {
     return this.httpClient.put(`/jobs/${this.data.id}`, body);
   }
 
-  protected internalDelete() {
+  protected internalDelete(): Promise<Response> {
     return this.httpClient.delete(`/jobs/${this.data.id}`);
   }
 
@@ -183,7 +183,7 @@ export class Job {
    *
    * @async
    */
-  async checkout(): Promise<Job> {
+  async checkout(): Promise<this> {
     const response = await this.internalGet();
     this.data = await response.json();
     return this;
@@ -195,7 +195,7 @@ export class Job {
    * @async
    * @param data - Raw job data.
    */
-  async update(data: any): Promise<Job> {
+  async update(data: any): Promise<this> {
     const response = await this.internalPut(data);
     this.data = await response.json();
     return this;
@@ -242,7 +242,7 @@ export class Job {
     interval?: number;
     signal?: AbortSignal;
     onCheckout?: (job: Job, ready: boolean) => boolean;
-  }): Promise<Job> {
+  }): Promise<this> {
     const checkDone = () =>
       this.checkout().then((job) => {
         const ready = ["done", "failed"].includes(job.status);

package/src/Api/Member.ts

@@ -44,15 +44,15 @@ export class Member {
     this.data = data;
   }
 
-  private internalGet() {
+  private internalGet(): Promise<Response> {
     return this.httpClient.get(`/projects/${this.projectId}/members/${this.id}`);
   }
 
-  private internalPut(body?: BodyInit | object) {
+  private internalPut(body?: BodyInit | object): Promise<Response> {
     return this.httpClient.put(`/projects/${this.projectId}/members/${this.id}`, body);
   }
 
-  private internalDelete() {
+  private internalDelete(): Promise<Response> {
     return this.httpClient.delete(`/projects/${this.projectId}/members/${this.id}`);
   }
 
@@ -123,7 +123,7 @@ export class Member {
    *
    * @async
    */
-  async checkout(): Promise<Member> {
+  async checkout(): Promise<this> {
     const response = await this.internalGet();
     this.data = await response.json();
     return this;
@@ -135,7 +135,7 @@ export class Member {
    * @async
    * @param data - Raw member data.
    */
-  async update(data: any): Promise<Member> {
+  async update(data: any): Promise<this> {
     const response = await this.internalPut(data);
     this.data = await response.json();
     return this;
@@ -157,7 +157,7 @@ export class Member {
    *
    * @async
    */
-  save(): Promise<Member> {
+  save(): Promise<this> {
     return this.update(this.data);
   }
 }

package/src/Api/Model.ts

@@ -195,8 +195,7 @@ export class Model {
   }
 
   /**
-   * Add new model viewpoint. To create a new viewpoint use
-   * {@link Viewer#createViewpoint | Viewer.createViewpoint()}.
+   * Add new model viewpoint. To create a new viewpoint use `Viewer.createViewpoint()`.
    *
    * _**Note**: Assemblу models do not support viewpoints_.
    *
@@ -339,7 +338,7 @@ export 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) {
+  getReferences(signal?: AbortSignal): Promise<any> {
     return this._file.getReferences(signal);
   }
 }

package/src/Api/Permission.ts

@@ -43,15 +43,15 @@ export class Permission {
     this.data = data;
   }
 
-  private internalGet() {
+  private internalGet(): Promise<Response> {
     return this.httpClient.get(`/files/${this.fileId}/permissions/${this.id}`);
   }
 
-  private internalPut(body?: BodyInit | object) {
+  private internalPut(body?: BodyInit | object): Promise<Response> {
     return this.httpClient.put(`/files/${this.fileId}/permissions/${this.id}`, body);
   }
 
-  private internalDelete() {
+  private internalDelete(): Promise<Response> {
     return this.httpClient.delete(`/files/${this.fileId}/permissions/${this.id}`);
   }
 
@@ -134,7 +134,7 @@ export class Permission {
    *
    * @async
    */
-  async checkout(): Promise<Permission> {
+  async checkout(): Promise<this> {
     const response = await this.internalGet();
     this.data = await response.json();
     return this;
@@ -146,7 +146,7 @@ export class Permission {
    * @async
    * @param data - Raw permission data.
    */
-  async update(data: any): Promise<Permission> {
+  async update(data: any): Promise<this> {
     const response = await this.internalPut(data);
     this.data = await response.json();
     return this;
@@ -168,7 +168,7 @@ export class Permission {
    *
    * @async
    */
-  save(): Promise<Permission> {
+  save(): Promise<this> {
     return this.update(this.data);
   }
 }

package/src/Api/Project.ts

@@ -43,19 +43,19 @@ export class Project {
     this.data = data;
   }
 
-  protected internalGet(relativePath: string) {
+  protected internalGet(relativePath: string): Promise<Response> {
     return this.httpClient.get(`/projects/${this.id}${relativePath}`);
   }
 
-  protected internalPost(relativePath: string, body?: BodyInit | object) {
+  protected internalPost(relativePath: string, body?: BodyInit | object): Promise<Response> {
     return this.httpClient.post(`/projects/${this.id}${relativePath}`, body);
   }
 
-  protected internalPut(relativePath: string, body?: BodyInit | object) {
+  protected internalPut(relativePath: string, body?: BodyInit | object): Promise<Response> {
     return this.httpClient.put(`/projects/${this.id}${relativePath}`, body);
   }
 
-  protected internalDelete(relativePath: string) {
+  protected internalDelete(relativePath: string): Promise<Response> {
     return this.httpClient.delete(`/projects/${this.id}${relativePath}`);
   }
 
@@ -242,7 +242,7 @@ export class Project {
    *
    * @async
    */
-  async checkout(): Promise<Project> {
+  async checkout(): Promise<this> {
     const response = await this.internalGet("");
     this.data = await response.json();
     return this;
@@ -254,7 +254,7 @@ export class Project {
    * @async
    * @param data - Raw project data.
    */
-  async update(data: any): Promise<Project> {
+  async update(data: any): Promise<this> {
     const response = await this.internalPut("", data);
     this.data = await response.json();
     return this;
@@ -285,7 +285,7 @@ export class Project {
    *
    * @async
    */
-  save(): Promise<Project> {
+  save(): Promise<this> {
     return this.update(this.data);
   }
 
@@ -303,7 +303,7 @@ export class Project {
    *   target="_blank">File</a> object. Setting the `image` to `null` will remove the preview.
    */
 
-  async setPreview(image: BodyInit | null) {
+  async setPreview(image: BodyInit | null): Promise<any> {
     const response = await (image ? this.internalPost("/preview", image) : this.internalDelete("/preview"));
     this.data = await response.json();
     return this;

package/src/Api/Role.ts

@@ -42,15 +42,15 @@ export class Role {
     this.data = data;
   }
 
-  private internalGet() {
+  private internalGet(): Promise<Response> {
     return this.httpClient.get(`/projects/${this.projectId}/roles/${this.name}`);
   }
 
-  private internalPut(body?: BodyInit | object) {
+  private internalPut(body?: BodyInit | object): Promise<Response> {
     return this.httpClient.put(`/projects/${this.projectId}/roles/${this.name}`, body);
   }
 
-  private internalDelete() {
+  private internalDelete(): Promise<Response> {
     return this.httpClient.delete(`/projects/${this.projectId}/roles/${this.name}`);
   }
 
@@ -119,7 +119,7 @@ export class Role {
    *
    * @async
    */
-  async checkout(): Promise<Role> {
+  async checkout(): Promise<this> {
     const response = await this.internalGet();
     this.data = await response.json();
     return this;
@@ -131,7 +131,7 @@ export class Role {
    * @async
    * @param data - Raw role data.
    */
-  async update(data: any): Promise<Role> {
+  async update(data: any): Promise<this> {
     const response = await this.internalPut(data);
     this.data = await response.json();
     return this;
@@ -153,7 +153,7 @@ export class Role {
    *
    * @async
    */
-  save(): Promise<Role> {
+  save(): Promise<this> {
     return this.update(this.data);
   }
 }

package/src/Api/User.ts

@@ -257,7 +257,7 @@ export class User {
    * does not have administrator rights, hi can only checkout himself, otherwise an exception
    * will be thrown.
    */
-  async checkout(): Promise<User> {
+  async checkout(): Promise<this> {
     if (this.id === this.httpClient.signInUserId) {
       const response = await this.httpClient.get("/user");
       const data = await response.json();
@@ -278,7 +278,7 @@ export class User {
    * @async
    * @param data - Raw user data.
    */
-  async update(data: any) {
+  async update(data: any): Promise<this> {
     if (this.id === this.httpClient.signInUserId) {
       const response = await this.httpClient.put("/user", data);
       const newData = await response.json();
@@ -322,7 +322,7 @@ export class User {
    *
    * @async
    */
-  save(): Promise<User> {
+  save(): Promise<this> {
     return this.update(this.data);
   }
 
@@ -341,7 +341,7 @@ export 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.
    */
-  async setAvatar(image: BodyInit | null): Promise<User> {
+  async setAvatar(image: BodyInit | null): Promise<this> {
     if (image) {
       if (this.id === this.httpClient.signInUserId) {
         const response = await this.httpClient.post("/user/avatar", image);

package/src/Api/Utils.ts

@@ -21,7 +21,7 @@
 // acknowledge and accept the above terms.
 ///////////////////////////////////////////////////////////////////////////////
 
-function delay(ms: number, signal: AbortSignal) {
+function delay(ms: number, signal: AbortSignal): Promise<boolean> {
   return new Promise((resolve) => {
     let timeoutId = 0;
 
@@ -49,9 +49,9 @@ export async function waitFor(
     timeoutError?: DOMException;
     result?: any;
   } = {}
-) {
-  const timeout = params.timeout ?? 600000;
-  const interval = params.interval ?? 3000;
+): Promise<any> {
+  const timeout = params.timeout || 600000;
+  const interval = params.interval || 3000;
   const signal = params.signal ?? new AbortController().signal;
   const abortError = params.abortError ?? new DOMException("Aborted", "AbortError");
   const timeoutError = params.timeoutError ?? new DOMException("Timeout", "TimeoutError");
@@ -67,7 +67,7 @@ export async function waitFor(
   return Promise.reject(timeoutError);
 }
 
-export function parseArgs(args: string | object): object {
+export function parseArgs(args?: string | object): object {
   if (typeof args === "string") {
     const firstArg = args.indexOf("--");
     if (firstArg !== -1) args = args.slice(firstArg);
@@ -83,7 +83,7 @@ export function parseArgs(args: string | object): object {
       .map((x) => x.concat([""]));
     return Object.fromEntries(argArray);
   }
-  return args ?? {};
+  return args || {};
 }
 
 export function userFullName(firstName: string | any, lastName = "", userName = ""): string {

package/src/Api/XMLHttp.ts

@@ -61,7 +61,7 @@ export function $xmlhttp(
     for (const key in params.headers) {
       xhr.setRequestHeader(key, params.headers[key]);
     }
-    function calcProgress(event: ProgressEvent) {
+    function calcProgress(event: ProgressEvent): number {
       return event.lengthComputable ? event.loaded / event.total : 1;
     }
     xhr.upload.onprogress = (event) => params.uploadProgress && params.uploadProgress(calcProgress(event));