@inweb/client 25.4.11 → 25.6.0

package/lib/Api/Client.d.ts

@@ -99,6 +99,13 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * @param token - An access token for authentication request. See {@link User.token} for more details.
      */
     signInWithToken(token: string): Promise<User>;
+    private setCurrentUser;
+    private clearCurrentUser;
+    /**
+     * Returns the current logged in user information. Returns `null` if the user is not logged
+     * in or the logged in user has deleted himself.
+     */
+    getCurrentUser(): User | null;
     /**
      * Get the list of server indentity providers.
      *
@@ -111,32 +118,45 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * @async
      */
     getIdentityProviders(): Promise<any>;
-    private setCurrentUser;
-    private clearCurrentUser;
     /**
-     * Returns the current logged in user information. Returns `null` if the user is not logged
-     * in or the logged in user has deleted himself.
+     * Returns the current server settings.
+     *
+     * @async
      */
-    getCurrentUser(): User | null;
+    getServerSettings(): Promise<any>;
     /**
-     * Returns a list of server users. Only admins can get a list of users, if the current logged
-     * in user does not have administrator rights, an exception will be thrown.
+     * Change server settings.
+     *
+     * Only admins can change server settings, if the current logged in user does not have
+     * administrator rights, an exception will be thrown.
+     *
+     * @async
+     */
+    updateServerSettings(settings: any): Promise<any>;
+    /**
+     * Returns a list of server users.
+     *
+     * Only admins can get a list of users, if the current logged in user does not have
+     * administrator rights, an exception will be thrown.
      *
      * @async
      */
     getUsers(): Promise<User[]>;
     /**
-     * Returns the user information. Only admins can get other users, if the current logged in
-     * user does not have administrator rights, hi can only get himself, otherwise an exception
-     * will be thrown.
+     * Returns the user information.
+     *
+     * Only admins can get other users, if the current logged in user does not have administrator
+     * rights, hi can only get himself, otherwise an exception will be thrown.
      *
      * @async
      * @param userId - User ID.
      */
     getUser(userId: string): Promise<User>;
     /**
-     * Create a new user. Only admins can create users, if the current logged in user does not
-     * have administrator rights, an exception will be thrown.
+     * Create a new user.
+     *
+     * Only admins can create users, if the current logged in user does not have administrator
+     * rights, an exception will be thrown.
      *
      * @async
      * @param email - User email. Cannot be empty.
@@ -150,7 +170,7 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * @param params.lastName - Last name.
      * @param params.canCreateProject - `true` if user is allowed to create a project.
      * @param params.projectsLimit - The maximum number of projects that the user can create.
-     * @param params.storageLimit - The size of the file storage available to the user.
+     * @param params.storageLimit - The size of the file storage available to the user in bytes.
      */
     createUser(email: string, password: string, params?: {
         isAdmin?: boolean;
@@ -162,8 +182,10 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
         storageLimit?: number;
     }): Promise<User>;
     /**
-     * Delete a user from the server. Only admins can delete users, if the current logged in user
-     * does not have administrator rights, an exception will be thrown.
+     * Delete a user from the server.
+     *
+     * Only admins can delete users, if the current logged in user does not have administrator
+     * rights, an exception will be thrown.
      *
      * Admins can delete themselves or other admins. An admin can only delete himself if he is
      * not the last administrator.
@@ -443,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/Job.d.ts

@@ -67,7 +67,7 @@ export declare class Job {
     get lastUpdate(): string;
     /**
      * Job type. Can be `properties`, `geomerty`, `geomertyGltf`, `validation`, `clash`, `dwg`,
-     * `obj`, `gltf`, `glb`, `vsf`, `pdf` or `3dpdf`.
+     * `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` or custom job name.
      *
      * @readonly
      */
@@ -104,7 +104,10 @@ export declare class Job {
      */
     checkout(): Promise<this>;
     /**
-     * Update job data on the server. Only admins can update job data.
+     * Update job data on the server.
+     *
+     * Only admins can update job data, if the current logged in user does not have administrator
+     * rights, an exception will be thrown.
      *
      * @async
      * @param data - Raw job data.

package/lib/Api/Model.d.ts

@@ -1,6 +1,6 @@
 import { IHttpClient } from "./IHttpClient";
-import { File } from "./File";
-import { Assembly } from "./Assembly";
+import type { File } from "./File";
+import type { Assembly } from "./Assembly";
 /**
  * The class representing the is a description of view of the file or assembly. For example,
  * for `dwg` it is a `Model` space or layout, and for `rvt` files it is a `3D` view.
@@ -103,16 +103,12 @@ export declare class Model {
     /**
      * Returns model viewpoint list.
      *
-     * _**Note**: Assemblу models do not support viewpoints_.
-     *
      * @async
      */
     getViewpoints(): Promise<any[]>;
     /**
      * Add new model viewpoint. To create a new viewpoint use `Viewer.createViewpoint()`.
      *
-     * _**Note**: Assemblу models do not support viewpoints_.
-     *
      * @async
      * @param viewpoint - Viewpoint.
      */
@@ -120,8 +116,6 @@ export declare class Model {
     /**
      * Delete model viewpoint.
      *
-     * _**Note**: Assemblу models do not support viewpoints_.
-     *
      * @async
      * @param guid - Viewpoint GUID.
      * @returns Returns the raw data of a deleted viewpoint.

package/lib/Api/User.d.ts

@@ -23,8 +23,8 @@ export declare class User {
      */
     get canCreateProject(): boolean;
     /**
-     * User account registration time (UTC) in the format specified in <a
-     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     * Account registration time (UTC) in the format specified in
+     * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
      *
      * @readonly
      */
@@ -85,8 +85,8 @@ export declare class User {
      */
     get isEmailConfirmed(): boolean;
     /**
-     * User last update time (UTC) in the format specified in <a
-     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     * User last update time (UTC) in the format specified in
+     * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
      */
     get lastModified(): string;
     /**
@@ -95,8 +95,8 @@ export declare class User {
     get lastName(): string;
     set lastName(value: string);
     /**
-     * User last sign in time (UTC) in the format specified in <a
-     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     * User last sign in time (UTC) in the format specified in
+     * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
      */
     get lastSignIn(): string;
     /**
@@ -105,6 +105,10 @@ export declare class User {
      * @readonly
      */
     get projectsLimit(): number;
+    /**
+     * The identity provider used to create the account. Can be `ldap`, `oauth`, `saml` or empty.
+     */
+    get providerType(): string;
     /**
      * The user's access token (API key). Use {@link Client.signInWithToken()} to log in using token.
      *
@@ -117,23 +121,27 @@ export declare class User {
     get userName(): string;
     set userName(value: string);
     /**
-     * Refresh user data. Only admins can checkout other users, if the current logged in user
-     * does not have administrator rights, hi can only checkout himself, otherwise an exception
-     * will be thrown.
+     * Refresh user data.
+     *
+     * Only admins can checkout other users, if the current logged in user does not have
+     * administrator rights, hi can only checkout himself, otherwise an exception will be thrown.
      */
     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
-     * exception will be thrown.
+     * 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 exception will be thrown.
      *
      * @async
      * @param data - Raw user data.
      */
     update(data: any): Promise<this>;
     /**
-     * Delete a user from the server. Only admins can delete users, if the current logged in user
-     * does not have administrator rights, an exception will be thrown.
+     * Delete a user from the server.
+     *
+     * Only admins can delete users, if the current logged in user does not have administrator
+     * rights, an exception will be thrown.
      *
      * Admins can delete themselves or other admins. An admin can only delete himself if he is
      * not the last administrator.
@@ -152,19 +160,29 @@ export declare class 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,
-     * otherwise an exception will be thrown.
+     * 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, otherwise an exception will be thrown.
+     *
+     * @async
+     * @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
-     * @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>;
+     */
+    deleteAvatar(): Promise<this>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.4.11",
+  "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.7"
+    "@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";
@@ -217,27 +218,13 @@ export class Client extends EventEmitter2<ClientEventMap> {
     return this.setCurrentUser(data);
   }
 
-  /**
-   * Get the list of server indentity providers.
-   *
-   * To sign in with the provider in your web application:
-   *
-   * - Open the `provider.url` link using `window.open()`.
-   * - Add a `/oauth` path (server-defined) handler to the router. In this handler, show an error
-   *   message if the `error` search parameter is present, or log in with the `token` search parameter.
-   *
-   * @async
-   */
-  getIdentityProviders(): Promise<any> {
-    return this.httpClient.get("/identity").then((response) => response.json());
-  }
-
   // Save the current logged in user information for internal use.
 
   private setCurrentUser(data: any): User {
     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;
   }
 
@@ -245,6 +232,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
     this._user = null;
     this.httpClient.headers = {};
     this.httpClient.signInUserId = "";
+    this.httpClient.signInUserIsAdmin = false;
   }
 
   /**
@@ -257,8 +245,46 @@ export class Client extends EventEmitter2<ClientEventMap> {
   }
 
   /**
-   * Returns a list of server users. Only admins can get a list of users, if the current logged
-   * in user does not have administrator rights, an exception will be thrown.
+   * Get the list of server indentity providers.
+   *
+   * To sign in with the provider in your web application:
+   *
+   * - Open the `provider.url` link using `window.open()`.
+   * - Add a `/oauth` path (server-defined) handler to the router. In this handler, show an error
+   *   message if the `error` search parameter is present, or log in with the `token` search parameter.
+   *
+   * @async
+   */
+  getIdentityProviders(): Promise<any> {
+    return this.httpClient.get("/identity").then((response) => response.json());
+  }
+
+  /**
+   * Returns the current server settings.
+   *
+   * @async
+   */
+  getServerSettings(): Promise<any> {
+    return this.httpClient.get("/settings").then((response) => response.json());
+  }
+
+  /**
+   * Change server settings.
+   *
+   * Only admins can change server settings, if the current logged in user does not have
+   * administrator rights, an exception will be thrown.
+   *
+   * @async
+   */
+  updateServerSettings(settings: any): Promise<any> {
+    return this.httpClient.put("/settings", settings).then((response) => response.json());
+  }
+
+  /**
+   * Returns a list of server users.
+   *
+   * Only admins can get a list of users, if the current logged in user does not have
+   * administrator rights, an exception will be thrown.
    *
    * @async
    */
@@ -271,32 +297,37 @@ export class Client extends EventEmitter2<ClientEventMap> {
   }
 
   /**
-   * Returns the user information. Only admins can get other users, if the current logged in
-   * user does not have administrator rights, hi can only get himself, otherwise an exception
-   * will be thrown.
+   * Returns the user information.
+   *
+   * Only admins can get other users, if the current logged in user does not have administrator
+   * rights, hi can only get himself, otherwise an exception will be thrown.
    *
    * @async
    * @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));
     }
   }
 
   /**
-   * Create a new user. Only admins can create users, if the current logged in user does not
-   * have administrator rights, an exception will be thrown.
+   * Create a new user.
+   *
+   * Only admins can create users, if the current logged in user does not have administrator
+   * rights, an exception will be thrown.
    *
    * @async
    * @param email - User email. Cannot be empty.
@@ -310,7 +341,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @param params.lastName - Last name.
    * @param params.canCreateProject - `true` if user is allowed to create a project.
    * @param params.projectsLimit - The maximum number of projects that the user can create.
-   * @param params.storageLimit - The size of the file storage available to the user.
+   * @param params.storageLimit - The size of the file storage available to the user in bytes.
    */
   createUser(
     email: string,
@@ -342,8 +373,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
   }
 
   /**
-   * Delete a user from the server. Only admins can delete users, if the current logged in user
-   * does not have administrator rights, an exception will be thrown.
+   * Delete a user from the server.
+   *
+   * Only admins can delete users, if the current logged in user does not have administrator
+   * rights, an exception will be thrown.
    *
    * Admins can delete themselves or other admins. An admin can only delete himself if he is
    * not the last administrator.
@@ -355,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));
+    }
   }
 
   /**
@@ -851,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/FetchError.ts

@@ -118,6 +118,7 @@ export class FetchError extends Error {
    */
   constructor(status: number, message?: string) {
     super(message || statusText(status));
+    this.name = "FetchError";
     this.status = status;
     this.statusText = statusText(status);
   }

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/Job.ts

@@ -133,7 +133,7 @@ export class Job {
 
   /**
    * Job type. Can be `properties`, `geomerty`, `geomertyGltf`, `validation`, `clash`, `dwg`,
-   * `obj`, `gltf`, `glb`, `vsf`, `pdf` or `3dpdf`.
+   * `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` or custom job name.
    *
    * @readonly
    */
@@ -190,7 +190,10 @@ export class Job {
   }
 
   /**
-   * Update job data on the server. Only admins can update job data.
+   * Update job data on the server.
+   *
+   * Only admins can update job data, if the current logged in user does not have administrator
+   * rights, an exception will be thrown.
    *
    * @async
    * @param data - Raw job data.

package/src/Api/Model.ts

@@ -22,8 +22,8 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
-import { File } from "./File";
-import { Assembly } from "./Assembly";
+import type { File } from "./File";
+import type { Assembly } from "./Assembly";
 
 /**
  * The class representing the is a description of view of the file or assembly. For example,
@@ -180,8 +180,6 @@ export class Model {
   /**
    * Returns model viewpoint list.
    *
-   * _**Note**: Assemblу models do not support viewpoints_.
-   *
    * @async
    */
   getViewpoints(): Promise<any[]> {
@@ -197,8 +195,6 @@ export class Model {
   /**
    * Add new model viewpoint. To create a new viewpoint use `Viewer.createViewpoint()`.
    *
-   * _**Note**: Assemblу models do not support viewpoints_.
-   *
    * @async
    * @param viewpoint - Viewpoint.
    */
@@ -212,8 +208,6 @@ export class Model {
   /**
    * Delete model viewpoint.
    *
-   * _**Note**: Assemblу models do not support viewpoints_.
-   *
    * @async
    * @param guid - Viewpoint GUID.
    * @returns Returns the raw data of a deleted viewpoint.