@inweb/client 25.5.4 → 25.6.0

package/lib/Api/Client.d.ts

@@ -465,9 +465,8 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * @param description - Project description.
      * @param startDate - Project start date.
      * @param endDate - Project end date.
-     * @param avatarUrl - Project preview image URL. Can be <a
-     *   href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
-     *   target="_blank">Data URL</a>.
+     * @param avatarUrl - Project preview image URL. Can be
+     *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
      */
     createProject(name: string, description?: string, startDate?: Date | string, endDate?: Date | string, avatarUrl?: string): Promise<Project>;
     /**

package/lib/Api/HttpClient.d.ts

@@ -3,6 +3,7 @@ export declare class HttpClient implements IHttpClient {
     serverUrl: string;
     headers: HeadersInit;
     signInUserId: string;
+    signInUserIsAdmin: boolean;
     constructor(serverUrl: string);
     get(relativePath: string, signal?: AbortSignal): Promise<Response>;
     post(relativePath: string, body?: BodyInit | object): Promise<Response>;

package/lib/Api/IHttpClient.d.ts

@@ -2,6 +2,7 @@ export interface IHttpClient {
     serverUrl: string;
     headers: HeadersInit;
     signInUserId: string;
+    signInUserIsAdmin: boolean;
     get(relativePath: string, signal?: AbortSignal): Promise<Response>;
     post(relativePath: string, body?: BodyInit | object): Promise<Response>;
     put(relativePath: string, body?: BodyInit | object): Promise<Response>;

package/lib/Api/User.d.ts

@@ -166,14 +166,23 @@ export declare class User {
      * administrator rights, he can only set his own avatar, otherwise an exception will be thrown.
      *
      * @async
-     * @param image - Avatar image. Can be a <a
-     *   href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
-     *   target="_blank">Data URL</a> string, <a
-     *   href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer"
-     *   target="_blank">ArrayBuffer</a>, <a
-     *   href="https://developer.mozilla.org/docs/Web/API/Blob/Blob" target="_blank">Blob</a> or
-     *   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<this>;
+     * @param image - Avatar image. Can be a
+     *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
+     *   string,
+     *   {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
+     *   {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} or Web API
+     *   {@link https://developer.mozilla.org/docs/Web/API/File | File} object. Setting the
+     *   `image` to `null` will remove the avatar.
+     */
+    setAvatar(image?: BodyInit | null): Promise<this>;
+    /**
+     * Remove the user avatar.
+     *
+     * Only admins can remove the avatar of other users, if the current logged in user does not
+     * have administrator rights, they can only remove their own avatar, otherwise an exception
+     * will be thrown.
+     *
+     * @async
+     */
+    deleteAvatar(): Promise<this>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.5.4",
+  "version": "25.6.0",
   "description": "JavaScript REST API client for the Open Cloud Server",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -26,6 +26,6 @@
     "ts-docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/eventemitter2": "~25.4.10"
+    "@inweb/eventemitter2": "~25.6.0"
   }
 }

package/src/Api/Assembly.ts

@@ -22,12 +22,12 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
+import { FetchError } from "./FetchError";
 import { IAssociatedFileData, IAssemblyVersionInfo } from "./IAssembly";
 import { IShortUserDescription } from "./IUser";
 import { Model } from "./Model";
 import { ClashTest } from "./ClashTest";
 import { waitFor, userFullName, userInitials } from "./Utils";
-import { FetchError } from "./FetchError";
 
 /**
  * The class representing a `assembly` entity.

package/src/Api/Client.ts

@@ -25,6 +25,7 @@ import { EventEmitter2 } from "@inweb/eventemitter2";
 
 import { IHttpClient } from "./IHttpClient";
 import { HttpClient } from "./HttpClient";
+import { FetchError } from "./FetchError";
 import { ClientEventMap } from "./ClientEvents";
 import { Assembly } from "./Assembly";
 import { File } from "./File";
@@ -223,6 +224,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
     this._user = new User(data, this.httpClient);
     this.httpClient.headers = { Authorization: data.tokenInfo.token };
     this.httpClient.signInUserId = this._user.id;
+    this.httpClient.signInUserIsAdmin = this._user.isAdmin;
     return this._user;
   }
 
@@ -230,6 +232,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
     this._user = null;
     this.httpClient.headers = {};
     this.httpClient.signInUserId = "";
+    this.httpClient.signInUserIsAdmin = false;
   }
 
   /**
@@ -303,18 +306,20 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param userId - User ID.
    */
   getUser(userId: string): Promise<User> {
-    if (userId === this.httpClient.signInUserId) {
+    if (this.httpClient.signInUserIsAdmin) {
       return this.httpClient
-        .get("/user")
+        .get(`/users/${userId}`)
         .then((response) => response.json())
-        .then((data) => ({ id: userId, ...data }))
+        .then((data) => ({ id: data.id, ...data.userBrief }))
         .then((data) => new User(data, this.httpClient));
-    } else {
+    } else if (userId === this.httpClient.signInUserId) {
       return this.httpClient
-        .get(`/users/${userId}`)
+        .get("/user")
         .then((response) => response.json())
-        .then((data) => ({ id: data.id, ...data.userBrief }))
+        .then((data) => ({ id: userId, ...data }))
         .then((data) => new User(data, this.httpClient));
+    } else {
+      return Promise.reject(new FetchError(403));
     }
   }
 
@@ -383,15 +388,19 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @returns Returns the raw data of a deleted user.
    */
   deleteUser(userId: string): Promise<any> {
-    return this.httpClient
-      .delete(`/users/${userId}`)
-      .then((response) => response.json())
-      .then((data) => {
-        if (userId === this.httpClient.signInUserId) {
-          this.clearCurrentUser();
-        }
-        return data;
-      });
+    if (this.httpClient.signInUserIsAdmin) {
+      return this.httpClient
+        .delete(`/users/${userId}`)
+        .then((response) => response.json())
+        .then((data) => {
+          if (userId === this.httpClient.signInUserId) {
+            this.clearCurrentUser();
+          }
+          return data;
+        });
+    } else {
+      return Promise.reject(new FetchError(403));
+    }
   }
 
   /**
@@ -879,9 +888,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param description - Project description.
    * @param startDate - Project start date.
    * @param endDate - Project end date.
-   * @param avatarUrl - Project preview image URL. Can be <a
-   *   href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
-   *   target="_blank">Data URL</a>.
+   * @param avatarUrl - Project preview image URL. Can be
+   *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
    */
   createProject(
     name: string,

package/src/Api/HttpClient.ts

@@ -29,6 +29,7 @@ export class HttpClient implements IHttpClient {
   public serverUrl: string;
   public headers: HeadersInit = {};
   public signInUserId = "";
+  public signInUserIsAdmin = false;
 
   constructor(serverUrl: string) {
     this.serverUrl = serverUrl;

package/src/Api/IHttpClient.ts

@@ -25,6 +25,7 @@ export interface IHttpClient {
   serverUrl: string;
   headers: HeadersInit;
   signInUserId: string;
+  signInUserIsAdmin: boolean;
 
   get(relativePath: string, signal?: AbortSignal): Promise<Response>;
 

package/src/Api/User.ts

@@ -22,6 +22,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
+import { FetchError } from "./FetchError";
 import { userFullName, userInitials } from "./Utils";
 
 /**
@@ -236,14 +237,16 @@ export class User {
    * administrator rights, hi can only checkout himself, otherwise an exception will be thrown.
    */
   async checkout(): Promise<this> {
-    if (this.id === this.httpClient.signInUserId) {
+    if (this.httpClient.signInUserIsAdmin) {
+      const response = await this.httpClient.get(`/users/${this.id}`);
+      const data = await response.json();
+      this.data = { id: data.id, ...data.userBrief };
+    } else if (this.id === this.httpClient.signInUserId) {
       const response = await this.httpClient.get("/user");
       const data = await response.json();
       this.data = { id: this.id, ...data };
     } else {
-      const response = await this.httpClient.get(`/users/${this.id}`);
-      const data = await response.json();
-      this.data = { id: data.id, ...data.userBrief };
+      return Promise.reject(new FetchError(403));
     }
     return this;
   }
@@ -258,14 +261,16 @@ export class User {
    * @param data - Raw user data.
    */
   async update(data: any): Promise<this> {
-    if (this.id === this.httpClient.signInUserId) {
+    if (this.httpClient.signInUserIsAdmin) {
+      const response = await this.httpClient.put(`/users/${this.id}`, { userBrief: data });
+      const newData = await response.json();
+      this.data = { id: newData.id, ...newData.userBrief };
+    } else if (this.id === this.httpClient.signInUserId) {
       const response = await this.httpClient.put("/user", data);
       const newData = await response.json();
       this.data = { id: this.id, ...newData };
     } else {
-      const response = await this.httpClient.put(`/users/${this.id}`, { userBrief: data });
-      const newData = await response.json();
-      this.data = { id: newData.id, ...newData.userBrief };
+      return Promise.reject(new FetchError(403));
     }
     return this;
   }
@@ -285,16 +290,21 @@ export class User {
    * @returns Returns the raw data of a deleted user.
    */
   delete(): Promise<any> {
-    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;
-      });
+    if (this.httpClient.signInUserIsAdmin) {
+      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 = "";
+            this.httpClient.signInUserIsAdmin = false;
+          }
+          return data;
+        });
+    } else {
+      return Promise.reject(new FetchError(403));
+    }
   }
 
   /**
@@ -314,36 +324,51 @@ export class User {
    * administrator rights, he can only set his own avatar, otherwise an exception will be thrown.
    *
    * @async
-   * @param image - Avatar image. Can be a <a
-   *   href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
-   *   target="_blank">Data URL</a> string, <a
-   *   href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer"
-   *   target="_blank">ArrayBuffer</a>, <a
-   *   href="https://developer.mozilla.org/docs/Web/API/Blob/Blob" target="_blank">Blob</a> or
-   *   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.
+   * @param image - Avatar image. Can be a
+   *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
+   *   string,
+   *   {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
+   *   {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} or Web API
+   *   {@link https://developer.mozilla.org/docs/Web/API/File | File} object. Setting the
+   *   `image` to `null` will remove the avatar.
+   */
+  async setAvatar(image?: BodyInit | null): Promise<this> {
+    if (!image) {
+      await this.deleteAvatar();
+    } else if (this.httpClient.signInUserIsAdmin) {
+      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 response = await this.httpClient.post("/user/avatar", image);
+      const data = await response.json();
+      this.data = { id: this.id, ...data };
+    } else {
+      return Promise.reject(new FetchError(403));
+    }
+    return this;
+  }
+
+  /**
+   * Remove the user avatar.
+   *
+   * Only admins can remove the avatar of other users, if the current logged in user does not
+   * have administrator rights, they can only remove their own avatar, otherwise an exception
+   * will be thrown.
+   *
+   * @async
    */
-  async setAvatar(image: BodyInit | null): Promise<this> {
-    if (image) {
-      if (this.id === this.httpClient.signInUserId) {
-        const response = await this.httpClient.post("/user/avatar", image);
-        const data = await response.json();
-        this.data = { id: this.id, ...data };
-      } else {
-        const response = await this.httpClient.post(`/users/${this.id}/avatar`, image);
-        const data = await response.json();
-        this.data = { id: data.id, ...data.userBrief };
-      }
+  async deleteAvatar(): Promise<this> {
+    if (this.httpClient.signInUserIsAdmin) {
+      const response = await this.httpClient.delete(`/users/${this.id}/avatar`);
+      const data = await response.json();
+      this.data = { id: data.id, ...data.userBrief };
+    } else if (this.id === this.httpClient.signInUserId) {
+      const response = await this.httpClient.delete("/user/avatar");
+      const data = await response.json();
+      this.data = { id: this.id, ...data };
     } else {
-      if (this.id === this.httpClient.signInUserId) {
-        const response = await this.httpClient.delete("/user/avatar");
-        const data = await response.json();
-        this.data = { id: this.id, ...data };
-      } else {
-        const response = await this.httpClient.delete(`/users/${this.id}/avatar`);
-        const data = await response.json();
-        this.data = { id: data.id, ...data.userBrief };
-      }
+      return Promise.reject(new FetchError(403));
     }
     return this;
   }