@inweb/client 25.4.11 → 25.5.4

package/dist/client.js

@@ -160,8 +160,6 @@
         /**
          * Returns model viewpoint list.
          *
-         * _**Note**: Assemblу models do not support viewpoints_.
-         *
          * @async
          */
         getViewpoints() {
@@ -172,8 +170,6 @@
         /**
          * Add new model viewpoint. To create a new viewpoint use `Viewer.createViewpoint()`.
          *
-         * _**Note**: Assemblу models do not support viewpoints_.
-         *
          * @async
          * @param viewpoint - Viewpoint.
          */
@@ -186,8 +182,6 @@
         /**
          * Delete model viewpoint.
          *
-         * _**Note**: Assemblу models do not support viewpoints_.
-         *
          * @async
          * @param guid - Viewpoint GUID.
          * @returns Returns the raw data of a deleted viewpoint.
@@ -716,6 +710,7 @@
          */
         constructor(status, message) {
             super(message || statusText(status));
+            this.name = "FetchError";
             this.status = status;
             this.statusText = statusText(status);
         }
@@ -1783,7 +1778,7 @@
         }
         /**
          * 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
          */
@@ -1834,7 +1829,10 @@
             return 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.
@@ -3404,8 +3402,8 @@
             return this.data.canCreateProject;
         }
         /**
-         * 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
          */
@@ -3497,8 +3495,8 @@
             return this.data.isEmailConfirmed;
         }
         /**
-         * 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() {
             return this.data.lastModified;
@@ -3513,8 +3511,8 @@
             this._data.lastName = value;
         }
         /**
-         * 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() {
             return this.data.lastSignIn;
@@ -3527,6 +3525,12 @@
         get projectsLimit() {
             return this.data.projectsLimit;
         }
+        /**
+         * The identity provider used to create the account. Can be `ldap`, `oauth`, `saml` or empty.
+         */
+        get providerType() {
+            return this.data.providerType;
+        }
         /**
          * The user's access token (API key). Use {@link Client.signInWithToken()} to log in using token.
          *
@@ -3545,9 +3549,10 @@
             this._data.userName = value;
         }
         /**
-         * 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.
          */
         async checkout() {
             if (this.id === this.httpClient.signInUserId) {
@@ -3563,9 +3568,10 @@
             return 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.
@@ -3584,8 +3590,10 @@
             return 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.
@@ -3617,9 +3625,10 @@
             return this.update(this.data);
         }
         /**
-         * 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 <a
@@ -3759,7 +3768,7 @@
                 .then((data) => ({
                 ...data,
                 server: data.version,
-                client: "25.4.11",
+                client: "25.5.4",
             }));
         }
         /**
@@ -3831,20 +3840,6 @@
             const data = await response.json();
             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() {
-            return this.httpClient.get("/identity").then((response) => response.json());
-        }
         // Save the current logged in user information for internal use.
         setCurrentUser(data) {
             this._user = new User(data, this.httpClient);
@@ -3867,8 +3862,43 @@
             return this._user;
         }
         /**
-         * 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() {
+            return this.httpClient.get("/identity").then((response) => response.json());
+        }
+        /**
+         * Returns the current server settings.
+         *
+         * @async
+         */
+        getServerSettings() {
+            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) {
+            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
          */
@@ -3880,9 +3910,10 @@
                 .then((array) => array.map((data) => new User(data, this.httpClient)));
         }
         /**
-         * 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.
@@ -3904,8 +3935,10 @@
             }
         }
         /**
-         * 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.
@@ -3919,7 +3952,7 @@
          * @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, password, params = {}) {
             const { isAdmin, userName, ...rest } = params;
@@ -3938,8 +3971,10 @@
                 .then((data) => new User(data, this.httpClient));
         }
         /**
-         * 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.
@@ -4452,7 +4487,7 @@
     }
 
     ///////////////////////////////////////////////////////////////////////////////
-    const version = "25.4.11";
+    const version = "25.5.4";
 
     exports.Assembly = Assembly;
     exports.ClashTest = ClashTest;