@inweb/client 25.3.17 → 25.3.19

package/src/Api/ClashTest.ts

@@ -23,7 +23,7 @@
 
 import { IHttpClient } from "./IHttpClient";
 import { IShortUserDescription } from "./IUser";
-import { waitFor, userFullName, userInitials } from "./impl/Utils";
+import { waitFor, userFullName, userInitials } from "./Utils";
 
 /**
  * The base class provides information about the file/assembly clash detection test and test results.
@@ -48,10 +48,7 @@ export class ClashTest {
     return this.httpClient.get(`${this.basePath}/clashes/${this.id}${relativePath}`);
   }
 
-  protected internalPut(
-    relativePath: string,
-    body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null
-  ): Promise<any> {
+  protected internalPut(relativePath: string, body?: BodyInit | object): Promise<any> {
     return this.httpClient.put(`${this.basePath}/clashes/${this.id}${relativePath}`, body);
   }
 
@@ -217,13 +214,10 @@ export class ClashTest {
    *
    * @async
    */
-  checkout(): Promise<this> {
-    return this.internalGet("")
-      .then((response) => response.json())
-      .then((data) => {
-        this.data = data;
-        return this;
-      });
+  async checkout(): Promise<this> {
+    const response = await this.internalGet("");
+    this.data = await response.json();
+    return this;
   }
 
   /**
@@ -232,13 +226,10 @@ export class ClashTest {
    * @async
    * @param data - Raw test data.
    */
-  update(data: any): Promise<this> {
-    return this.internalPut("", data)
-      .then((response) => response.json())
-      .then((data) => {
-        this.data = data;
-        return this;
-      });
+  async update(data: any): Promise<this> {
+    const response = await this.internalPut("", data);
+    this.data = await response.json();
+    return this;
   }
 
   /**

package/src/Api/Client.ts

@@ -31,7 +31,7 @@ import { File } from "./File";
 import { Job } from "./Job";
 import { Project } from "./Project";
 import { User } from "./User";
-import { downloadProgress, json, text, parseArgs } from "./impl/Utils";
+import { parseArgs } from "./Utils";
 
 /**
  * The `Client.js` library class that provides methods to access the [Open Cloud
@@ -58,7 +58,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
   }
 
   /**
-   * Open Cloud Server URL. Use {@link Client#configure | configure()} to change server URL.
+   * Open Cloud Server URL. Use {@link Client.configure()} to change server URL.
    *
    * @readonly
    */
@@ -67,8 +67,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
   }
 
   /**
-   * Deprecated since `25.3`. Use [Viewer.options]{@link Viewer#options} instead to change
-   * Viewer parameters.
+   * Deprecated since `25.3`. Use {@link Viewer.options()} instead to change Viewer parameters.
    */
   get options(): any {
     console.warn(
@@ -204,7 +203,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   async signInWithEmail(email: string, password: string): Promise<User> {
     const credentials = btoa(unescape(encodeURIComponent(email + ":" + password)));
     this._httpClient.headers = { Authorization: "Basic " + credentials };
-    const data = await json(this._httpClient.get("/token"));
+    const response = await this._httpClient.get("/token");
+    const data = await response.json();
     return this.setCurrentUser(data);
   }
 
@@ -217,7 +217,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
    */
   async signInWithToken(token: string): Promise<User> {
     this._httpClient.headers = { Authorization: token };
-    const data = await json(this._httpClient.get("/user"));
+    const response = await this._httpClient.get("/user");
+    const data = await response.json();
     return this.setCurrentUser(data);
   }
 
@@ -252,7 +253,9 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @async
    */
   getUsers(): Promise<User[]> {
-    return json(this._httpClient.get("/users"))
+    return this._httpClient
+      .get("/users")
+      .then((response) => response.json())
       .then((array) => array.map((data) => ({ id: data.id, ...data.userBrief })))
       .then((array) => array.map((data) => new User(data, this._httpClient)));
   }
@@ -267,11 +270,15 @@ export class Client extends EventEmitter2<ClientEventMap> {
    */
   getUser(userId: string): Promise<User> {
     if (userId === this._httpClient.signInUserId) {
-      return json(this._httpClient.get("/user"))
+      return this._httpClient
+        .get("/user")
+        .then((response) => response.json())
         .then((data) => ({ id: userId, ...data }))
         .then((data) => new User(data, this._httpClient));
     } else {
-      return json(this._httpClient.get(`/users/${userId}`))
+      return this._httpClient
+        .get(`/users/${userId}`)
+        .then((response) => response.json())
         .then((data) => ({ id: data.id, ...data.userBrief }))
         .then((data) => new User(data, this._httpClient));
     }
@@ -309,8 +316,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
     } = {}
   ): Promise<User> {
     const { isAdmin, userName, ...rest } = params;
-    return json(
-      this._httpClient.post("/users", {
+    return this._httpClient
+      .post("/users", {
         isAdmin,
         userBrief: {
           ...rest,
@@ -319,7 +326,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
         },
         password,
       })
-    )
+      .then((response) => response.json())
       .then((data) => ({ id: data.id, ...data.userBrief }))
       .then((data) => new User(data, this._httpClient));
   }
@@ -338,12 +345,15 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @returns Returns the raw data of a deleted user.
    */
   deleteUser(userId: string): Promise<any> {
-    return json(this._httpClient.delete(`/users/${userId}`)).then((data) => {
-      if (userId === this._httpClient.signInUserId) {
-        this.clearCurrentUser();
-      }
-      return data;
-    });
+    return this._httpClient
+      .delete(`/users/${userId}`)
+      .then((response) => response.json())
+      .then((data) => {
+        if (userId === this._httpClient.signInUserId) {
+          this.clearCurrentUser();
+        }
+        return data;
+      });
   }
 
   /**
@@ -402,12 +412,15 @@ export class Client extends EventEmitter2<ClientEventMap> {
     let queryString = searchParams.toString();
     if (queryString) queryString = "?" + queryString;
 
-    return json(this._httpClient.get(`/files${queryString}`)).then((files) => {
-      return {
-        ...files,
-        result: files.result.map((data) => new File(data, this._httpClient)),
-      };
-    });
+    return this._httpClient
+      .get(`/files${queryString}`)
+      .then((response) => response.json())
+      .then((files) => {
+        return {
+          ...files,
+          result: files.result.map((data) => new File(data, this._httpClient)),
+        };
+      });
   }
 
   /**
@@ -417,7 +430,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param fileId - File ID.
    */
   getFile(fileId: string): Promise<File> {
-    return json(this._httpClient.get(`/files/${fileId}`)).then((data) => new File(data, this._httpClient));
+    return this._httpClient
+      .get(`/files/${fileId}`)
+      .then((response) => response.json())
+      .then((data) => new File(data, this._httpClient));
   }
 
   /**
@@ -467,7 +483,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
     }
   ): Promise<File> {
     const result = await this._httpClient
-      .postFile("/files", file, (progress) => {
+      .uploadFile("/files", file, (progress) => {
         this.emitEvent({ type: "uploadprogress", data: progress, file });
         params.onProgress?.(progress, file);
       })
@@ -492,7 +508,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @returns Returns the raw data of a deleted file.
    */
   deleteFile(fileId: string): Promise<any> {
-    return json(this._httpClient.delete(`/files/${fileId}`));
+    return this._httpClient.delete(`/files/${fileId}`).then((response) => response.json());
   }
 
   /**
@@ -507,8 +523,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    */
   downloadFile(fileId: string, onProgress?: (progress: number) => void, signal?: AbortSignal): Promise<ArrayBuffer> {
     return this._httpClient
-      .get(`/files/${fileId}/downloads`, signal)
-      .then((response) => downloadProgress(response, onProgress))
+      .downloadFile(`/files/${fileId}/downloads`, onProgress, signal)
       .then((response) => response.arrayBuffer());
   }
 
@@ -556,10 +571,13 @@ export class Client extends EventEmitter2<ClientEventMap> {
     let queryString = searchParams.toString();
     if (queryString) queryString = "?" + queryString;
 
-    return json(this._httpClient.get(`/jobs${queryString}`)).then((jobs) => ({
-      ...jobs,
-      result: jobs.result.map((data) => new Job(data, this._httpClient)),
-    }));
+    return this._httpClient
+      .get(`/jobs${queryString}`)
+      .then((response) => response.json())
+      .then((jobs) => ({
+        ...jobs,
+        result: jobs.result.map((data) => new Job(data, this._httpClient)),
+      }));
   }
 
   /**
@@ -569,7 +587,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param jobId - Job ID.
    */
   getJob(jobId: string): Promise<Job> {
-    return json(this._httpClient.get(`/jobs/${jobId}`)).then((data) => new Job(data, this._httpClient));
+    return this._httpClient
+      .get(`/jobs/${jobId}`)
+      .then((response) => response.json())
+      .then((data) => new Job(data, this._httpClient));
   }
 
   /**
@@ -610,7 +631,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @returns Returns the raw data of a deleted job.
    */
   deleteJob(jobId: string): Promise<any> {
-    return json(this._httpClient.delete(`/jobs/${jobId}`));
+    return this._httpClient.delete(`/jobs/${jobId}`).then((response) => response.json());
   }
 
   /**
@@ -661,12 +682,15 @@ export class Client extends EventEmitter2<ClientEventMap> {
     let queryString = searchParams.toString();
     if (queryString) queryString = "?" + queryString;
 
-    return json(this._httpClient.get(`/assemblies${queryString}`)).then((assemblies) => {
-      return {
-        ...assemblies,
-        result: assemblies.result.map((data) => new Assembly(data, this._httpClient)),
-      };
-    });
+    return this._httpClient
+      .get(`/assemblies${queryString}`)
+      .then((response) => response.json())
+      .then((assemblies) => {
+        return {
+          ...assemblies,
+          result: assemblies.result.map((data) => new Assembly(data, this._httpClient)),
+        };
+      });
   }
 
   /**
@@ -676,7 +700,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param assemblyId - Assembly ID.
    */
   getAssembly(assemblyId: string): Promise<Assembly> {
-    return json(this._httpClient.get(`/assemblies/${assemblyId}`)).then((data) => new Assembly(data, this._httpClient));
+    return this._httpClient
+      .get(`/assemblies/${assemblyId}`)
+      .then((response) => response.json())
+      .then((data) => new Assembly(data, this._httpClient));
   }
 
   /**
@@ -714,7 +741,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @returns Returns the raw data of a deleted assembly.
    */
   deleteAssembly(assemblyId: string): Promise<any> {
-    return json(this._httpClient.delete(`/assemblies/${assemblyId}`));
+    return this._httpClient.delete(`/assemblies/${assemblyId}`).then((response) => response.json());
   }
 
   /**
@@ -760,7 +787,9 @@ export class Client extends EventEmitter2<ClientEventMap> {
 
     let queryString = searchParams.toString();
     if (queryString) queryString = "?" + queryString;
-    return json(this._httpClient.get(`/projects${queryString}`))
+    return this._httpClient
+      .get(`/projects${queryString}`)
+      .then((response) => response.json())
       .then((projects) => {
         // fix for server 23.5 and below
         if (Array.isArray(projects)) {
@@ -796,7 +825,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param projectId - Project ID.
    */
   getProject(projectId: string): Promise<Project> {
-    return json(this._httpClient.get(`/projects/${projectId}`)).then((data) => new Project(data, this._httpClient));
+    return this._httpClient
+      .get(`/projects/${projectId}`)
+      .then((response) => response.json())
+      .then((data) => new Project(data, this._httpClient));
   }
 
   /**
@@ -818,15 +850,16 @@ export class Client extends EventEmitter2<ClientEventMap> {
     endDate?: Date | string,
     avatarUrl?: string
   ): Promise<Project> {
-    return json(
-      this._httpClient.post("/projects", {
+    return this._httpClient
+      .post("/projects", {
         name,
         description,
         startDate: startDate instanceof Date ? startDate.toISOString() : startDate,
         endDate: endDate instanceof Date ? endDate.toISOString() : endDate,
         avatarUrl,
       })
-    ).then((data) => new Project(data, this._httpClient));
+      .then((response) => response.json())
+      .then((data) => new Project(data, this._httpClient));
   }
 
   /**
@@ -837,13 +870,16 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @returns Returns the raw data of a deleted project.
    */
   deleteProject(projectId: string): Promise<any> {
-    return text(this._httpClient.delete(`/projects/${projectId}`)).then((text) => {
-      // fix for server 23.5 and below
-      try {
-        return JSON.parse(text);
-      } catch {
-        return { id: projectId };
-      }
-    });
+    return this._httpClient
+      .delete(`/projects/${projectId}`)
+      .then((response) => response.text())
+      .then((text) => {
+        // fix for server 23.5 and below
+        try {
+          return JSON.parse(text);
+        } catch {
+          return { id: projectId };
+        }
+      });
   }
 }

package/src/Api/Fetch.ts

@@ -0,0 +1,84 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2002-2021, 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-2021 by Open Design Alliance.
+//   All rights reserved.
+//
+// By use of this software, its documentation or related materials, you
+// acknowledge and accept the above terms.
+///////////////////////////////////////////////////////////////////////////////
+
+import { FetchError, statusText, error400 } from "./FetchError";
+
+function handleFetchError(response: Response): Promise<Response> {
+  if (!response.ok) {
+    switch (response.status) {
+      case 400: {
+        return response.text().then((text) => {
+          console.error(text);
+          return Promise.reject(new FetchError(400, error400(text)));
+        });
+      }
+      case 500: {
+        return response.text().then((text) => {
+          console.error(error400(text, text));
+          return Promise.reject(new FetchError(500));
+        });
+      }
+      default:
+        return Promise.reject(new FetchError(response.status, statusText(response.status)));
+    }
+  }
+  return Promise.resolve(response);
+}
+
+export function $fetch(
+  url: string,
+  params: {
+    method: "GET" | "POST" | "PUT" | "DELETE";
+    headers?: HeadersInit;
+    body?: BodyInit | object;
+    signal?: AbortSignal;
+  } = { method: "GET" }
+): Promise<Response> {
+  const headers = { ...params.headers };
+  delete headers["Content-Type"];
+
+  let body: FormData | string;
+  if (params.method === "POST" || params.method === "PUT") {
+    if (params.body instanceof FormData) {
+      body = params.body;
+    } else if (params.body instanceof Blob) {
+      body = new FormData();
+      body.append("file", params.body);
+    } else if (params.body instanceof ArrayBuffer) {
+      body = new FormData();
+      body.append("file", new Blob([params.body]));
+    } else if (typeof params.body === "object") {
+      body = JSON.stringify(params.body);
+      headers["Content-Type"] = "application/json";
+    } else if (typeof params.body === "string") {
+      body = params.body;
+      headers["Content-Type"] = "text/plain";
+    }
+  }
+
+  const init: RequestInit = { method: params.method, headers };
+  if (body) init.body = body;
+  if (params.signal) init.signal = params.signal;
+
+  return fetch(url, init).then(handleFetchError);
+}

package/src/Api/{impl/http.ts → FetchError.ts}

@@ -21,7 +21,7 @@
 // acknowledge and accept the above terms.
 ///////////////////////////////////////////////////////////////////////////////
 
-export const STATUS_CODES = {
+const STATUS_CODES = {
   100: "Continue",
   101: "Switching Protocols",
   102: "Processing",
@@ -90,3 +90,35 @@ export const STATUS_CODES = {
 export function statusText(status: number): string {
   return STATUS_CODES[status] || `Error ${status}`;
 }
+
+export function error400(text: string, _default = "400") {
+  try {
+    return JSON.parse(text).description;
+  } catch {
+    return _default;
+  }
+}
+
+/**
+ * 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
+ * occurs, access denied, or object not found.
+ */
+
+export class FetchError extends Error {
+  protected status: number;
+  protected statusText: string;
+
+  /**
+   * @property status - The <a href="https://developer.mozilla.org/docs/Web/HTTP/Status" target
+   *   ="_blank">HTTP status code</a> of the response.
+   * @property message - Error message. Inherited from <a
+   *   href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error"
+   *   target ="_blank">Error</a>.
+   */
+  constructor(status: number, message?: string) {
+    super(message || statusText(status));
+    this.status = status;
+    this.statusText = statusText(status);
+  }
+}