@inweb/client 26.1.2 → 26.1.4

package/src/Api/Model.ts

@@ -29,8 +29,8 @@ import type { IModelTransformMatrix } from "./IAssembly";
 
 /**
  * Provides properties and methods for working with view of the {@link File | file} or
- * {@link Assembly| assembly}. For example, for `dwg` it is a `Model` space or layout, and for `rvt` files
- * it is a `3D` view.
+ * {@link Assembly| assembly}. For example, for `dwg` it is a `Model` space or layout, and for
+ * `rvt` files it is a `3D` view.
  */
 export class Model extends Endpoint {
   private _data: any;
@@ -69,8 +69,8 @@ export class Model extends Endpoint {
   }
 
   /**
-   * Scene description resource file name. Use {@link downloadResource | downloadResource()} to download
-   * scene description file.
+   * Scene description resource file name. Use {@link downloadResource | downloadResource()} to
+   * download scene description file.
    *
    * @readonly
    */
@@ -106,8 +106,8 @@ export class Model extends Endpoint {
   }
 
   /**
-   * The list of geometry data resource files. Use {@link downloadResource | downloadResource()} to
-   * download geometry data files.
+   * The list of geometry data resource files. Use {@link downloadResource | downloadResource()}
+   * to download geometry data files.
    *
    * @readonly
    */
@@ -188,8 +188,8 @@ export class Model extends Endpoint {
   }
 
   /**
-   * Saves a new model owner file/assembly viewpoint to the server. To create a new viewpoint use
-   * `Viewer.createViewpoint()`.
+   * Saves a new model owner file/assembly viewpoint to the server. To create a new viewpoint
+   * use `Viewer.createViewpoint()`.
    *
    * @param viewpoint - Viewpoint object.
    */
@@ -231,14 +231,14 @@ export class Model extends Endpoint {
   }
 
   /**
-   * Downloads a resource file. Resource files are files that contain model scene descriptions, or
-   * geometry data.
+   * Downloads a resource file. Resource files are files that contain model scene descriptions,
+   * or geometry data.
    *
    * @param dataId - Resource file name.
    * @param onProgress - Download progress callback.
    * @param signal - An
-   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal. Allows
-   *   to communicate with a fetch request and abort it if desired.
+   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+   *   signal. Allows to communicate with a fetch request and abort it if desired.
    */
   downloadResource(
     dataId: string,
@@ -249,16 +249,16 @@ export class Model extends Endpoint {
   }
 
   /**
-   * Downloads a part of resource file. Resource files are files that contain model scene descriptions,
-   * or geometry data.
+   * Downloads a part of resource file. Resource files are files that contain model scene
+   * descriptions, or geometry data.
    *
    * @param dataId - Resource file name.
    * @param ranges - A range of resource file contents to download.
    * @param requestId - Request ID for download progress callback.
    * @param onProgress - Download progress callback.
    * @param signal - An
-   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal. Allows
-   *   to communicate with a fetch request and abort it if desired.
+   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+   *   signal. Allows to communicate with a fetch request and abort it if desired.
    */
   downloadResourceRange(
     dataId: string,
@@ -324,8 +324,8 @@ export class Model extends Endpoint {
    * References are images, fonts, or any other files to correct rendering of the file.
    *
    * @param signal - An
-   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal, which
-   *   can be used to abort waiting as desired.
+   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+   *   signal, which can be used to abort waiting as desired.
    */
   getReferences(signal?: AbortSignal): Promise<IFileReferences> {
     return this._file.getReferences(signal);

package/src/Api/OAuthClient.ts

@@ -25,8 +25,8 @@ import { IHttpClient } from "./IHttpClient";
 import { Endpoint } from "./Endpoint";
 
 /**
- * Provides properties and methods for obtaining information about a OAuth 2.0 client that have access
- * the Open Cloud Server API.
+ * Provides properties and methods for obtaining information about a OAuth 2.0 client that have
+ * access the Open Cloud Server API.
  */
 export class OAuthClient extends Endpoint {
   private _data: any;
@@ -148,8 +148,8 @@ export class OAuthClient extends Endpoint {
   /**
    * Updates client data on the server.
    *
-   * Only administrators can update OAuth clients. If the current logged in user is not an administrator,
-   * an exception will be thrown.
+   * Only administrators can update OAuth clients. If the current logged in user is not an
+   * administrator, an exception will be thrown.
    *
    * @param data - Raw client data. For more information, see
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#OAuthClient | Open Cloud OAuth Clients API}.
@@ -163,8 +163,8 @@ export class OAuthClient extends Endpoint {
   /**
    * Deletes a client from the server.
    *
-   * Only administrators can delete OAuth clients. If the current logged in user is not an administrator,
-   * an exception will be thrown.
+   * Only administrators can delete OAuth clients. If the current logged in user is not an
+   * administrator, an exception will be thrown.
    *
    * @returns Returns the raw data of a deleted client. For more information, see
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#OAuthClient | Open Cloud OAuth Clients API}.
@@ -174,11 +174,11 @@ export class OAuthClient extends Endpoint {
   }
 
   /**
-   * Saves client properties changes to the server. Call this method to update client data on the server
-   * after any property changes.
+   * Saves client properties changes to the server. Call this method to update client data on
+   * the server after any property changes.
    *
-   * Only administrators can update OAuth clients. If the current logged in user is not an administrator,
-   * an exception will be thrown.
+   * Only administrators can update OAuth clients. If the current logged in user is not an
+   * administrator, an exception will be thrown.
    */
   save(): Promise<this> {
     return this.update(this.data);

package/src/Api/Permission.ts

@@ -26,8 +26,8 @@ import { Endpoint } from "./Endpoint";
 import { IGrantedTo } from "./IFile";
 
 /**
- * Provides properties and methods for obtaining information about {@link File | file} actions granted to
- * a specific user, project, or group.
+ * Provides properties and methods for obtaining information about {@link File | file} actions
+ * granted to a specific user, project, or group.
  */
 export class Permission extends Endpoint {
   private _data: any;
@@ -52,22 +52,19 @@ export class Permission extends Endpoint {
    * - `readViewpoint` - The ability to read file viewpoints.
    * - `createViewpoint` - The ability to create file viewpoints.
    *
-   * @example Change file permissions for the the specified project.
-   *
-   * ```javascript
-   * const myFile = client.getFile(myFileId);
-   * const permissions = await myFile.getPermissions();
-   * const projectPermissions = permissions.filter((permission) =>
-   *   permission.grantedTo.some((x) => x.project?.id === myProjectId)
-   * );
-   * const newActions = ["read", "readSourceFile", "update"];
-   * await Promise.all(
-   *   projectPermissions.map((permission) => {
-   *     permission.actions = newActions;
-   *     return permission.save();
-   *   })
-   * );
-   * ```
+   * @example <caption>Change file permissions for the the specified project.</caption>
+   *   const myFile = client.getFile(myFileId);
+   *   const permissions = await myFile.getPermissions();
+   *   const projectPermissions = permissions.filter((permission) =>
+   *     permission.grantedTo.some((x) => x.project?.id === myProjectId)
+   *   );
+   *   const newActions = ["read", "readSourceFile", "update"];
+   *   await Promise.all(
+   *     projectPermissions.map((permission) => {
+   *       permission.actions = newActions;
+   *       return permission.save();
+   *     })
+   *   );
    */
   get actions(): string[] {
     return this.data.actions;
@@ -154,8 +151,8 @@ export class Permission extends Endpoint {
   }
 
   /**
-   * Saves permission properties changes to the server. Call this method to update permission data on the
-   * server after any property changes.
+   * Saves permission properties changes to the server. Call this method to update permission
+   * data on the server after any property changes.
    */
   save(): Promise<this> {
     return this.update(this.data);

package/src/Api/Project.ts

@@ -31,8 +31,8 @@ import { File } from "./File";
 import { userFullName, userInitials } from "./Utils";
 
 /**
- * Provides properties and methods for obtaining information about a project on the Open Cloud Server and
- * managing its {@link Role | roles}, {@link Member | members} and models.
+ * Provides properties and methods for obtaining information about a project on the Open Cloud
+ * Server and managing its {@link Role | roles}, {@link Member | members} and models.
  */
 export class Project extends Endpoint {
   private _data: any;
@@ -270,8 +270,8 @@ export class Project extends Endpoint {
   }
 
   /**
-   * Saves project properties changes to the server. Call this method to update project data on the
-   * server after any property changes.
+   * Saves project properties changes to the server. Call this method to update project data on
+   * the server after any property changes.
    */
   save(): Promise<this> {
     return this.update(this.data);
@@ -281,11 +281,12 @@ export class Project extends Endpoint {
    * Sets or removes the project preview.
    *
    * @param image - Preview 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/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
-   *   {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting the `image`
-   *   to `null` will remove the preview.
+   *   {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting
+   *   the `image` to `null` will remove the preview.
    */
 
   async setPreview(image?: BodyInit | null): Promise<this> {
@@ -308,8 +309,8 @@ export class Project extends Endpoint {
   }
 
   /**
-   * Returns a list of project roles. Project members have different abilities depending on the role they
-   * have in a project.
+   * Returns a list of project roles. Project members have different abilities depending on the
+   * role they have in a project.
    */
   getRoles(): Promise<Role[]> {
     return this.get("/roles")
@@ -403,8 +404,8 @@ export class Project extends Endpoint {
    * Information about the file (model) that can be reference in the project topics.
    *
    * @typedef {any} FileInformation
-   * @property {any[]} display_information - The list of fields to allow users to associate the file with
-   *   a server model.
+   * @property {any[]} display_information - The list of fields to allow users to associate the
+   *   file with a server model.
    * @property {string} display_information.field_display_name - Field display name.
    * @property {string} display_information.field_value - Field value.
    * @property {any} file - The file reference object.
@@ -416,8 +417,8 @@ export class Project extends Endpoint {
    * Returns a list of project files. For more information, see
    * {@link https://cloud.opendesign.com/docs//pages/server/bcf3.html#ProjectFilesInformation | Open Cloud BCF3 API}.
    *
-   * This list contains all files that the project has access to. To add a file to this list, create a
-   * {@link IGrantedTo.project | project} permission on the file using
+   * This list contains all files that the project has access to. To add a file to this list,
+   * create a {@link IGrantedTo.project | project} permission on the file using
    * {@link File.createPermission | File.createPermission()}.
    */
   getFilesInformation(): Promise<any[]> {

package/src/Api/Role.ts

@@ -125,8 +125,8 @@ export class Role extends Endpoint {
   }
 
   /**
-   * Saves role properties changes to the server. Call this method to update role data on the server
-   * after any property changes.
+   * Saves role properties changes to the server. Call this method to update role data on the
+   * server after any property changes.
    */
   save(): Promise<this> {
     return this.update(this.data);

package/src/Api/SharedLink.ts

@@ -126,8 +126,8 @@ export class SharedLink extends Endpoint {
   }
 
   /**
-   * Saves shared link properties changes to the server. Call this method to update shared link data on
-   * the server after any property changes.
+   * Saves shared link properties changes to the server. Call this method to update shared link
+   * data on the server after any property changes.
    */
   save(): Promise<this> {
     return this.update(this.data);

package/src/Api/User.ts

@@ -27,8 +27,8 @@ import { FetchError } from "./FetchError";
 import { userFullName, userInitials } from "./Utils";
 
 /**
- * Provides properties and methods for obtaining information about a Open Cloud Server user and manage
- * its data.
+ * Provides properties and methods for obtaining information about a Open Cloud Server user and
+ * manage its data.
  */
 export class User extends Endpoint {
   private _data: any;
@@ -142,8 +142,8 @@ export class User extends Endpoint {
   }
 
   /**
-   * Full name. Returns the user's first and last name. If first name and last names are empty, returns
-   * the user name.
+   * Full name. Returns the user's first and last name. If first name and last names are empty,
+   * returns the user name.
    *
    * @readonly
    */
@@ -161,8 +161,8 @@ export class User extends Endpoint {
   }
 
   /**
-   * User initials. Returns a first letters of the user's first and last names. If first name and last
-   * names are empty, returns the first letter of the user name.
+   * User initials. Returns a first letters of the user's first and last names. If first name
+   * and last names are empty, returns the first letter of the user name.
    *
    * @readonly
    */
@@ -233,8 +233,8 @@ export class User extends Endpoint {
   }
 
   /**
-   * The identity provider used to create the account. Can be `ldap`, `oauth`, `saml` or empty for local
-   * accounts.
+   * The identity provider used to create the account. Can be `ldap`, `oauth`, `saml` or empty
+   * for local accounts.
    *
    * @readonly
    */
@@ -265,8 +265,8 @@ export class User extends Endpoint {
   }
 
   /**
-   * The user's access token (API key). Use {@link Client.signInWithToken | Client.signInWithToken()} to
-   * sign in to the server using this token.
+   * The user's access token (API key). Use
+   * {@link Client.signInWithToken | Client.signInWithToken()} to sign in to the server using this token.
    *
    * @readonly
    */
@@ -288,8 +288,8 @@ export class User extends Endpoint {
   /**
    * Reloads user data from the server.
    *
-   * 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.
+   * 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) {
@@ -309,8 +309,8 @@ export class User extends Endpoint {
   /**
    * Updates user data on the server.
    *
-   * 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.
+   * 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.
    *
    * @param data - Raw user data. For more information, see
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Users | Open Cloud Users API}.
@@ -333,11 +333,11 @@ export class User extends Endpoint {
   /**
    * Deletes a user from the server.
    *
-   * Only administrators can delete users. If the current logged in user is not an administrator, 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.
    *
-   * Administrators can delete themselves or other administrators. An administrator can only delete
-   * themself if they 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 after deleting the current logged in user.
    *
@@ -363,8 +363,8 @@ export class User extends Endpoint {
   }
 
   /**
-   * Saves user properties changes to the server. Call this method to update user data on the server
-   * after any property changes.
+   * Saves user properties changes to the server. Call this method to update user data on the
+   * server after any property changes.
    */
   save(): Promise<this> {
     return this.update(this.data);
@@ -373,15 +373,16 @@ export class User extends Endpoint {
   /**
    * Sets or removes the user avatar.
    *
-   * 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.
+   * 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.
    *
    * @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/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
-   *   {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting the `image`
-   *   to `null` will remove the avatar.
+   *   {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting
+   *   the `image` to `null` will remove the avatar.
    */
   async setAvatar(image?: BodyInit | null): Promise<this> {
     if (!image) {
@@ -403,8 +404,8 @@ export class User extends Endpoint {
   /**
    * Removes the user avatar.
    *
-   * 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.
+   * 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> {
     if (this.httpClient.signInUserIsAdmin) {
@@ -424,14 +425,15 @@ export class User extends Endpoint {
   /**
    * Changes 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.
+   * 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 specify their old password.
    *
    * @param newPassword - New user password.
-   * @param oldPassword - Old user password. Only required for non-administrator users to change their
-   *   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) {