@inweb/client 25.6.2 → 25.6.3

package/lib/Api/Client.d.ts

@@ -127,8 +127,8 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
     /**
      * 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.
+     * Only administrators can change server settings, if the current logged in user is not an
+     * administrator, an exception will be thrown.
      *
      * @async
      */
@@ -136,8 +136,8 @@ export declare 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.
+     * Only administrators can get a list of users, if the current logged in user is not an
+     * administrator, an exception will be thrown.
      *
      * @async
      */
@@ -145,8 +145,8 @@ export declare 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.
+     * Only administrators can get other users, if the currently logged in user is not an
+     * administrator, they can only get themselves, otherwise an exception will be thrown.
      *
      * @async
      * @param userId - User ID.
@@ -155,8 +155,8 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
     /**
      * 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.
+     * Only administrators can create users, if the current logged in user is not an
+     * administrator, an exception will be thrown.
      *
      * @async
      * @param email - User email. Cannot be empty.
@@ -184,11 +184,11 @@ export declare 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.
+     * Only administrators can delete users, if the current logged in user is not an
+     * administrator, 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.
+     * Administrators can delete themselves or other administrators. An administrator can only
+     * delete themself if they is not the last administrator.
      *
      * You need to re-login to continue working after deleting the current logged in user.
      *

package/lib/Api/Job.d.ts

@@ -106,8 +106,8 @@ export declare class Job {
     /**
      * 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.
+     * Only administrators can update job data, if the current logged in user is not an
+     * administrator, an exception will be thrown.
      *
      * @async
      * @param data - Raw job data.

package/lib/Api/User.d.ts

@@ -75,7 +75,7 @@ export declare class User {
      */
     get initials(): string;
     /**
-     * `true` if user is has an administrator rights.
+     * `true` if user is an administrator.
      */
     get isAdmin(): boolean;
     /**
@@ -123,15 +123,15 @@ export declare class User {
     /**
      * 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.
+     * Only administrators can checkout other users, if the current logged in user is not an
+     * administrator, they can only checkout themselves, 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.
+     * Only administrators can update other users, if the current logged in user is not an
+     * administrator, they can only update themself, otherwise an exception will be thrown.
      *
      * @async
      * @param data - Raw user data.
@@ -140,11 +140,11 @@ export declare class 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.
+     * Only administrators can delete users, if the current logged in user is not an
+     * administrator, 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.
+     * Administrators can delete themselves or other administrators. An administrator can only
+     * delete themself if they is not the last administrator.
      *
      * You need to re-login to continue working after deleting the current logged in user.
      *
@@ -162,8 +162,8 @@ export declare class User {
     /**
      * 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.
+     * Only administrators can set the avatar of other users, if the current logged in user is
+     * not an administrator, they can only set their avatar, otherwise an exception will be thrown.
      *
      * @async
      * @param image - Avatar image. Can be a
@@ -178,11 +178,25 @@ export declare class User {
     /**
      * 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.
+     * Only administrators can remove the avatar of other users, if the current logged in user is
+     * not an administrator, they can only remove their avatar, otherwise an exception will be thrown.
      *
      * @async
      */
     deleteAvatar(): Promise<this>;
+    /**
+     * Change the user password.
+     *
+     * Only administrators can change the passwords of other users, if the current logged in user
+     * is not an administrator, they can only change their password, otherwise an exception will
+     * be thrown.
+     *
+     * To change their password, non-administrator users must provide their old password.
+     *
+     * @async
+     * @param newPassword - New user password.
+     * @param oldPassword - Old user password. Only required for non-administrator users to
+     *   change their password.
+     */
+    changePassword(newPassword: string, oldPassword?: string): Promise<this>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.6.2",
+  "version": "25.6.3",
   "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.6.2"
+    "@inweb/eventemitter2": "~25.6.3"
   }
 }

package/src/Api/Client.ts

@@ -271,8 +271,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * 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.
+   * Only administrators can change server settings, if the current logged in user is not an
+   * administrator, an exception will be thrown.
    *
    * @async
    */
@@ -283,8 +283,8 @@ 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.
+   * Only administrators can get a list of users, if the current logged in user is not an
+   * administrator, an exception will be thrown.
    *
    * @async
    */
@@ -299,8 +299,8 @@ 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.
+   * Only administrators can get other users, if the currently logged in user is not an
+   * administrator, they can only get themselves, otherwise an exception will be thrown.
    *
    * @async
    * @param userId - User ID.
@@ -326,8 +326,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * 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.
+   * Only administrators can create users, if the current logged in user is not an
+   * administrator, an exception will be thrown.
    *
    * @async
    * @param email - User email. Cannot be empty.
@@ -375,11 +375,11 @@ 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.
+   * Only administrators can delete users, if the current logged in user is not an
+   * administrator, 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.
+   * Administrators can delete themselves or other administrators. An administrator can only
+   * delete themself if they is not the last administrator.
    *
    * You need to re-login to continue working after deleting the current logged in user.
    *

package/src/Api/Job.ts

@@ -192,8 +192,8 @@ export class Job {
   /**
    * 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.
+   * Only administrators can update job data, if the current logged in user is not an
+   * administrator, an exception will be thrown.
    *
    * @async
    * @param data - Raw job data.

package/src/Api/User.ts

@@ -152,7 +152,7 @@ export class User {
   }
 
   /**
-   * `true` if user is has an administrator rights.
+   * `true` if user is an administrator.
    */
   get isAdmin(): boolean {
     return this.data.isAdmin;
@@ -233,8 +233,8 @@ export class User {
   /**
    * 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.
+   * Only administrators can checkout other users, if the current logged in user is not an
+   * administrator, they can only checkout themselves, otherwise an exception will be thrown.
    */
   async checkout(): Promise<this> {
     if (this.httpClient.signInUserIsAdmin) {
@@ -254,8 +254,8 @@ export class User {
   /**
    * 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.
+   * Only administrators can update other users, if the current logged in user is not an
+   * administrator, they can only update themself, otherwise an exception will be thrown.
    *
    * @async
    * @param data - Raw user data.
@@ -278,11 +278,11 @@ export class 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.
+   * Only administrators can delete users, if the current logged in user is not an
+   * administrator, 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.
+   * Administrators can delete themselves or other administrators. An administrator can only
+   * delete themself if they is not the last administrator.
    *
    * You need to re-login to continue working after deleting the current logged in user.
    *
@@ -320,8 +320,8 @@ export class User {
   /**
    * 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.
+   * Only administrators can set the avatar of other users, if the current logged in user is
+   * not an administrator, they can only set their avatar, otherwise an exception will be thrown.
    *
    * @async
    * @param image - Avatar image. Can be a
@@ -352,9 +352,8 @@ export class User {
   /**
    * 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.
+   * Only administrators can remove the avatar of other users, if the current logged in user is
+   * not an administrator, they can only remove their avatar, otherwise an exception will be thrown.
    *
    * @async
    */
@@ -372,4 +371,33 @@ export class User {
     }
     return this;
   }
+
+  /**
+   * Change the user password.
+   *
+   * Only administrators can change the passwords of other users, if the current logged in user
+   * is not an administrator, they can only change their password, otherwise an exception will
+   * be thrown.
+   *
+   * To change their password, non-administrator users must provide their old password.
+   *
+   * @async
+   * @param newPassword - New user password.
+   * @param oldPassword - Old user password. Only required for non-administrator users to
+   *   change their password.
+   */
+  async changePassword(newPassword: string, oldPassword?: string): Promise<this> {
+    if (this.httpClient.signInUserIsAdmin) {
+      const response = await this.httpClient.put(`/users/${this.id}/password`, { new: newPassword });
+      const data = await response.json();
+      this.data = { id: data.id, ...data.userBrief };
+    } else if (this.id === this.httpClient.signInUserId) {
+      const response = await this.httpClient.put("/user/password", { old: oldPassword, new: newPassword });
+      const data = await response.json();
+      this.data = { id: this.id, ...data };
+    } else {
+      return Promise.reject(new FetchError(403));
+    }
+    return this;
+  }
 }