@inweb/client 27.2.1 → 27.2.3

package/lib/Api/Client.d.ts

@@ -52,7 +52,7 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
     /**
      * Returns client and server versions.
      *
-     * No login is required to obtain the version.
+     * No authorization is required to obtain the version.
      */
     version(): Promise<{
         server: string;
@@ -60,7 +60,9 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
         hash: string;
     }>;
     /**
-     * Registers a new user on the server. No authorization is required to register a new user.
+     * Registers a new user on the server.
+     *
+     * No authorization is required to register a new user.
      *
      * @param email - User email. Cannot be empty. Must be unique within the server.
      * @param password - User password. Cannot be empty. Password can only contain letters (a-z, A-Z),
@@ -73,6 +75,12 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * Resends a Confirmation Email to the new user. If the user's email is already confirmed, an exception
      * will be thrown.
      *
+     * No authorization is required to register a new user.
+     *
+     * A user must provide their email and password to resend their own confirmation email. An authorized
+     * administrator can resend the email for any user by providing the user's email only; a password is
+     * not required.
+     *
      * @param email - User email.
      * @param password - User password.
      */
@@ -112,8 +120,9 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      */
     getCurrentUser(): User | null;
     /**
-     * Returns the list of server enabled identity providers. No authorization is required to obtain a list
-     * of providers.
+     * Returns the list of server enabled identity providers.
+     *
+     * No authorization is required to obtain a list of providers.
      */
     getIdentityProviders(): Promise<{
         name: string;
@@ -122,6 +131,9 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
     /**
      * Returns the current server settings.
      *
+     * Only administrators can get server settings. If the current logged in user is not an administrator,
+     * an exception will be thrown.
+     *
      * @returns Returns an object with server settings. For more information, see
      *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Settings | Open Cloud Settings API}.
      */
@@ -218,7 +230,7 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * exception will be thrown.
      *
      * @param email - User email. Cannot be empty. Must be unique within the server.
-     * @param password - User password. Cannot be empty. Password can only contain latin letters (a-z,
+     * @param password - User password. Cannot be empty. Password can only contain Latin letters (a-z,
      *   A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
      * @param params - Additional user data.
      * @param params.isAdmin - `true` if user is an administrator.

package/lib/Api/User.d.ts

@@ -218,7 +218,8 @@ export declare class User extends Endpoint {
      *
      * To change their password, non-administrator users must specify their old password.
      *
-     * @param newPassword - New user password.
+     * @param newPassword - New user password. Cannot be empty. Password can only contain Latin letters
+     *   (a-z, A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
      * @param oldPassword - Old user password. Only required for non-administrator users to change their
      *   password.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "27.2.1",
+  "version": "27.2.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,7 +26,7 @@
     "docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/eventemitter2": "~27.2.1"
+    "@inweb/eventemitter2": "~27.2.3"
   },
   "devDependencies": {
     "fflate": "^0.8.2"

package/src/Api/Client.ts

@@ -94,7 +94,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Returns client and server versions.
    *
-   * No login is required to obtain the version.
+   * No authorization is required to obtain the version.
    */
   version(): Promise<{ server: string; client: string; hash: string }> {
     return this.httpClient
@@ -108,7 +108,9 @@ export class Client extends EventEmitter2<ClientEventMap> {
   }
 
   /**
-   * Registers a new user on the server. No authorization is required to register a new user.
+   * Registers a new user on the server.
+   *
+   * No authorization is required to register a new user.
    *
    * @param email - User email. Cannot be empty. Must be unique within the server.
    * @param password - User password. Cannot be empty. Password can only contain letters (a-z, A-Z),
@@ -130,6 +132,12 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * Resends a Confirmation Email to the new user. If the user's email is already confirmed, an exception
    * will be thrown.
    *
+   * No authorization is required to register a new user.
+   *
+   * A user must provide their email and password to resend their own confirmation email. An authorized
+   * administrator can resend the email for any user by providing the user's email only; a password is
+   * not required.
+   *
    * @param email - User email.
    * @param password - User password.
    */
@@ -214,8 +222,9 @@ export class Client extends EventEmitter2<ClientEventMap> {
   }
 
   /**
-   * Returns the list of server enabled identity providers. No authorization is required to obtain a list
-   * of providers.
+   * Returns the list of server enabled identity providers.
+   *
+   * No authorization is required to obtain a list of providers.
    */
   getIdentityProviders(): Promise<{ name: string; url: string }[]> {
     return this.httpClient.get("/identity").then((response) => response.json());
@@ -224,6 +233,9 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Returns the current server settings.
    *
+   * Only administrators can get server settings. If the current logged in user is not an administrator,
+   * an exception will be thrown.
+   *
    * @returns Returns an object with server settings. For more information, see
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Settings | Open Cloud Settings API}.
    */
@@ -391,7 +403,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * exception will be thrown.
    *
    * @param email - User email. Cannot be empty. Must be unique within the server.
-   * @param password - User password. Cannot be empty. Password can only contain latin letters (a-z,
+   * @param password - User password. Cannot be empty. Password can only contain Latin letters (a-z,
    *   A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
    * @param params - Additional user data.
    * @param params.isAdmin - `true` if user is an administrator.

package/src/Api/User.ts

@@ -429,7 +429,8 @@ export class User extends Endpoint {
    *
    * To change their password, non-administrator users must specify their old password.
    *
-   * @param newPassword - New user password.
+   * @param newPassword - New user password. Cannot be empty. Password can only contain Latin letters
+   *   (a-z, A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
    * @param oldPassword - Old user password. Only required for non-administrator users to change their
    *   password.
    */