@inweb/client 25.3.17 → 25.3.18

package/src/Api/User.ts

@@ -22,7 +22,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
-import { json, userFullName, userInitials } from "./impl/Utils";
+import { userFullName, userInitials } from "./Utils";
 
 export interface UserParams {
   /**
@@ -259,10 +259,12 @@ export class User {
    */
   async checkout(): Promise<User> {
     if (this.id === this.httpClient.signInUserId) {
-      const data = await json(this.httpClient.get("/user"));
+      const response = await this.httpClient.get("/user");
+      const data = await response.json();
       this.data = { id: this.id, ...data };
     } else {
-      const data = await json(this.httpClient.get(`/users/${this.id}`));
+      const response = await this.httpClient.get(`/users/${this.id}`);
+      const data = await response.json();
       this.data = { id: data.id, ...data.userBrief };
     }
     return this;
@@ -278,10 +280,12 @@ export class User {
    */
   async update(data: any) {
     if (this.id === this.httpClient.signInUserId) {
-      const newData = await json(this.httpClient.put("/user", data));
+      const response = await this.httpClient.put("/user", data);
+      const newData = await response.json();
       this.data = { id: this.id, ...newData };
     } else {
-      const newData = await json(this.httpClient.put(`/users/${this.id}`, { userBrief: data }));
+      const response = await this.httpClient.put(`/users/${this.id}`, { userBrief: data });
+      const newData = await response.json();
       this.data = { id: newData.id, ...newData.userBrief };
     }
     return this;
@@ -300,13 +304,16 @@ export class User {
    * @returns Returns the raw data of a deleted user.
    */
   delete(): Promise<any> {
-    return json(this.httpClient.delete(`/users/${this.id}`)).then((data) => {
-      if (this.id === this.httpClient.signInUserId) {
-        this.httpClient.headers = {};
-        this.httpClient.signInUserId = "";
-      }
-      return data;
-    });
+    return this.httpClient
+      .delete(`/users/${this.id}`)
+      .then((response) => response.json())
+      .then((data) => {
+        if (this.id === this.httpClient.signInUserId) {
+          this.httpClient.headers = {};
+          this.httpClient.signInUserId = "";
+        }
+        return data;
+      });
   }
 
   /**
@@ -334,21 +341,25 @@ 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?: ArrayBuffer | Blob | globalThis.File | FormData | string | null): Promise<User> {
+  async setAvatar(image: BodyInit | null): Promise<User> {
     if (image) {
       if (this.id === this.httpClient.signInUserId) {
-        const data = await json(this.httpClient.post("/user/avatar", image));
+        const response = await this.httpClient.post("/user/avatar", image);
+        const data = await response.json();
         this.data = { id: this.id, ...data };
       } else {
-        const data = await json(this.httpClient.post(`/users/${this.id}/avatar`, image));
+        const response = await this.httpClient.post(`/users/${this.id}/avatar`, image);
+        const data = await response.json();
         this.data = { id: data.id, ...data.userBrief };
       }
     } else {
       if (this.id === this.httpClient.signInUserId) {
-        const data = await json(this.httpClient.delete("/user/avatar"));
+        const response = await this.httpClient.delete("/user/avatar");
+        const data = await response.json();
         this.data = { id: this.id, ...data };
       } else {
-        const data = await json(this.httpClient.delete(`/users/${this.id}/avatar`));
+        const response = await this.httpClient.delete(`/users/${this.id}/avatar`);
+        const data = await response.json();
         this.data = { id: data.id, ...data.userBrief };
       }
     }

package/src/Api/Utils.ts

@@ -0,0 +1,104 @@
+///////////////////////////////////////////////////////////////////////////////
+// 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.
+///////////////////////////////////////////////////////////////////////////////
+
+function delay(ms: number, signal: AbortSignal) {
+  return new Promise((resolve) => {
+    let timeoutId = 0;
+
+    const abortHandler = () => {
+      clearTimeout(timeoutId);
+      resolve(true);
+    };
+
+    timeoutId = window.setTimeout(() => {
+      signal.removeEventListener("abort", abortHandler);
+      resolve(false);
+    }, ms);
+
+    signal.addEventListener("abort", abortHandler, { once: true });
+  });
+}
+
+export async function waitFor(
+  func: (params: any) => Promise<boolean>,
+  params: {
+    timeout?: number;
+    interval?: number;
+    signal?: AbortSignal;
+    abortError?: DOMException;
+    timeoutError?: DOMException;
+    result?: 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");
+
+  const end = performance.now() + timeout;
+  let count = timeout / interval;
+
+  do {
+    if (await func(params)) return Promise.resolve(params.result);
+    if ((await delay(interval, signal)) || signal.aborted) return Promise.reject(abortError);
+  } while (performance.now() < end && --count > 0);
+
+  return Promise.reject(timeoutError);
+}
+
+export function parseArgs(args: string | object): object {
+  if (typeof args === "string") {
+    const firstArg = args.indexOf("--");
+    if (firstArg !== -1) args = args.slice(firstArg);
+    const argArray = args
+      .split("--")
+      .map((x) =>
+        x
+          .split("=")
+          .map((y) => y.split(" "))
+          .flat()
+      )
+      .filter((x) => x[0])
+      .map((x) => x.concat([""]));
+    return Object.fromEntries(argArray);
+  }
+  return args ?? {};
+}
+
+export function userFullName(firstName: string | any, lastName = "", userName = ""): string {
+  if (firstName && typeof firstName !== "string") {
+    return userFullName(firstName.firstName ?? firstName.name, firstName.lastName, firstName.userName);
+  }
+  return `${firstName ?? ""} ${lastName ?? ""}`.trim() || userName;
+}
+
+export function userInitials(fullName = ""): string {
+  const names = fullName.split(" ").filter((x) => x);
+  return names
+    .reduce((initials, name, index) => {
+      if (index === 0 || index === names.length - 1) initials += name.charAt(0);
+      return initials;
+    }, "")
+    .toUpperCase();
+}

package/src/Api/XMLHttp.ts

@@ -0,0 +1,72 @@
+///////////////////////////////////////////////////////////////////////////////
+// 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, error400 } from "./FetchError";
+
+function handleXMLHttpError(xhr: XMLHttpRequest): Promise<XMLHttpRequest> {
+  if (xhr.status === 0) {
+    return Promise.reject(new FetchError(0, "Network error"));
+  }
+  if (xhr.status < 200 || xhr.status > 299) {
+    switch (xhr.status) {
+      case 400: {
+        console.error(xhr.responseText);
+        return Promise.reject(new FetchError(400, error400(xhr.responseText)));
+      }
+      case 500: {
+        console.error(error400(xhr.responseText, xhr.responseText));
+        return Promise.reject(new FetchError(500));
+      }
+      default: {
+        return Promise.reject(new FetchError(xhr.status));
+      }
+    }
+  }
+  return Promise.resolve(xhr);
+}
+
+export function $xmlhttp(
+  url: string,
+  params: {
+    method: "GET" | "POST" | "PUT" | "DELETE";
+    headers?: HeadersInit;
+    body?: XMLHttpRequestBodyInit;
+    uploadProgress?: (progress: number) => void;
+    downloadProgress?: (progress: number) => void;
+  } = { method: "GET" }
+): Promise<XMLHttpRequest> {
+  return new Promise((resolve, reject) => {
+    const xhr = new XMLHttpRequest();
+    xhr.open(params.method, url, true);
+    for (const key in params.headers) {
+      xhr.setRequestHeader(key, params.headers[key]);
+    }
+    function calcProgress(event: ProgressEvent) {
+      return event.lengthComputable ? event.loaded / event.total : 1;
+    }
+    xhr.upload.onprogress = (event) => params.uploadProgress && params.uploadProgress(calcProgress(event));
+    xhr.onprogress = (event) => params.downloadProgress && params.downloadProgress(calcProgress(event));
+    xhr.onloadend = (event) => handleXMLHttpError(event.target as XMLHttpRequest).then(resolve, reject);
+    xhr.send(params.body);
+  });
+}

package/src/index.ts

@@ -33,6 +33,6 @@ export { Permission } from "./Api/Permission";
 export { Project } from "./Api/Project";
 export { Role } from "./Api/Role";
 export { User } from "./Api/User";
-export { parseArgs, userFullName, userInitials, waitFor } from "./Api/impl/Utils";
+export { parseArgs, userFullName, userInitials, waitFor } from "./Api/Utils";
 
 export const version = "CLIENT_JS_VERSION";

package/lib/Api/impl/Utils.d.ts

@@ -1,32 +0,0 @@
-export declare function json(request: any): any;
-export declare function text(request: any): any;
-export declare function arrayBuffer(request: any): any;
-export declare function $init(method: "GET" | "POST" | "PUT" | "DELETE", headers?: HeadersInit, body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null, signal?: AbortSignal): RequestInit;
-export declare function $fetch(url: RequestInfo | URL, init?: RequestInit): Promise<Response>;
-export declare function $get(url: RequestInfo | URL, headers?: HeadersInit, signal?: AbortSignal): Promise<Response>;
-export declare function $put(url: RequestInfo | URL, headers?: HeadersInit, body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null): Promise<Response>;
-export declare function $post(url: RequestInfo | URL, headers?: HeadersInit, body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null): Promise<Response>;
-export declare function $delete(url: RequestInfo | URL, headers?: HeadersInit): Promise<Response>;
-export declare function streamProgress(stream: ReadableStream<Uint8Array>, onprogress: (progress: number) => void): ReadableStream<Uint8Array>;
-export declare function downloadProgress(response: Response, onprogress?: (progress: number) => void): Response;
-interface XMLHttpParams {
-    headers: HeadersInit;
-    method: "GET" | "POST" | "PUT" | "DELETE";
-    body?: XMLHttpRequestBodyInit | Document;
-    uploadProgress?: (progress: number) => void;
-    downloadProgress?: (progress: number) => void;
-}
-export declare function $XMLHttp(url: string, { headers, method, body, uploadProgress, downloadProgress }: XMLHttpParams): Promise<XMLHttpRequest>;
-export declare function waitFor(func: (params: any) => Promise<boolean>, params?: {
-    timeout?: number;
-    interval?: number;
-    signal?: AbortSignal;
-    abortError?: DOMException;
-    timeoutError?: DOMException;
-    result?: any;
-}): Promise<any>;
-export declare function downloadPartOfFile(requestId: number, records: any | null, url: string, defHeaders: HeadersInit, onProgress?: (progress: number, downloaded: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<void>;
-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;
-export {};

package/lib/Api/impl/http.d.ts

@@ -1,66 +0,0 @@
-export declare const STATUS_CODES: {
-    100: string;
-    101: string;
-    102: string;
-    103: string;
-    200: string;
-    201: string;
-    202: string;
-    203: string;
-    204: string;
-    205: string;
-    206: string;
-    207: string;
-    208: string;
-    226: string;
-    300: string;
-    301: string;
-    302: string;
-    303: string;
-    304: string;
-    305: string;
-    307: string;
-    308: string;
-    400: string;
-    401: string;
-    402: string;
-    403: string;
-    404: string;
-    405: string;
-    406: string;
-    407: string;
-    408: string;
-    409: string;
-    410: string;
-    411: string;
-    412: string;
-    413: string;
-    414: string;
-    415: string;
-    416: string;
-    417: string;
-    418: string;
-    421: string;
-    422: string;
-    423: string;
-    424: string;
-    425: string;
-    426: string;
-    428: string;
-    429: string;
-    431: string;
-    451: string;
-    500: string;
-    501: string;
-    502: string;
-    503: string;
-    504: string;
-    505: string;
-    506: string;
-    507: string;
-    508: string;
-    509: string;
-    510: string;
-    511: string;
-};
-export declare function statusText(status: number): string;

package/src/Api/impl/FetchError.ts

@@ -1,48 +0,0 @@
-///////////////////////////////////////////////////////////////////////////////
-// 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 { statusText } from "./http";
-
-/**
- * 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);
-  }
-}