@inweb/client 26.1.0 → 26.1.2

package/src/Api/Endpoint.ts

@@ -33,8 +33,8 @@ export class Endpoint {
   public path: string;
 
   /**
-   * Endpoint-specific HTTP headers for the `GET`, `POST`, `PUT` and `DELETE` requests. You can
-   * add custom headers at any time.
+   * Endpoint-specific HTTP headers for the `GET`, `POST`, `PUT` and `DELETE` requests. You can add
+   * custom headers at any time.
    */
   public headers: HeadersInit;
 
@@ -43,8 +43,8 @@ export class Endpoint {
 
   /**
    * @ignore
-   * @param path - The API path of the endpoint relative to the REST API server URL of the
-   *   specified HTTP client.
+   * @param path - The API path of the endpoint relative to the REST API server URL of the specified HTTP
+   *   client.
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    * @param headers - Endpoint-specific HTTP headers.
    */
@@ -76,8 +76,8 @@ export class Endpoint {
    * @ignore
    * @param relativePath - Nested endpoint relative path.
    * @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.
    */
   get(relativePath: string, signal?: AbortSignal): Promise<Response> {
     return this.httpClient.get(this.getEndpointPath(relativePath), { signal, headers: this.headers });

package/src/Api/FetchError.ts

@@ -100,9 +100,9 @@ export function error400(text: string, _default = "400"): string {
 }
 
 /**
- * The `FetchError` object indicates an error when request to Open Cloud Server could not be
- * performed. A `FetchError` is typically (but not exclusively) thrown when a network error
- * occurs, access denied, or object not found.
+ * The `FetchError` object indicates an error when request to Open Cloud Server could not be performed. A
+ * `FetchError` is typically (but not exclusively) thrown when a network error occurs, access denied, or
+ * object not found.
  */
 
 export class FetchError extends Error {
@@ -117,8 +117,8 @@ export class FetchError extends Error {
   public statusText: string;
 
   /**
-   * @property status - The
-   *   {@link https://developer.mozilla.org/docs/Web/HTTP/Status | HTTP status code} of the response.
+   * @property status - The {@link https://developer.mozilla.org/docs/Web/HTTP/Status | HTTP status code}
+   *   of the response.
    * @property message - Error message.
    */
   constructor(status: number, message?: string) {

package/src/Api/File.ts

@@ -33,8 +33,8 @@ import { ISharedLinkPermissions } from "./ISharedLink";
 import { waitFor, parseArgs, userFullName, userInitials } from "./Utils";
 
 /**
- * Provides properties and methods for obtaining information about a file on the Open Cloud
- * Server and managing its data and versions.
+ * Provides properties and methods for obtaining information about a file on the Open Cloud Server and
+ * managing its data and versions.
  */
 export class File extends Endpoint {
   private _data: any;
@@ -141,8 +141,8 @@ export class File extends Endpoint {
    * - `vsfx` - `VSFX` format, file can be opened in `VisualizeJS` viewer.
    * - `gltf` - `glTF` format, file can be opened in `Three.js` viewer.
    *
-   * Returns an empty string if geometry data has not yet been converted. A files without
-   * geometry data can be exported to other formas, but cannot be opened in viewer.
+   * Returns an empty string if geometry data has not yet been converted. A files without geometry data
+   * can be exported to other formas, but cannot be opened in viewer.
    */
   get geometryType(): string {
     if (this.status.geometryGltf.state === "done") return "gltf";
@@ -162,8 +162,8 @@ export class File extends Endpoint {
   /**
    * Returns `true` if the source file of the active file version has been deleted.
    *
-   * A files with deleted source file can be opened in the viewer, but cannot be exported to
-   * other formats.
+   * A files with deleted source file can be opened in the viewer, but cannot be exported to other
+   * formats.
    *
    * @readonly
    */
@@ -325,8 +325,8 @@ export class File extends Endpoint {
   /**
    * Deletes a file and all its versions from the server.
    *
-   * You cannot delete a version file using `delete()`, only the original file. To delete a
-   * version file use {@link deleteVersion | deleteVersion()}.
+   * You cannot delete a version file using `delete()`, only the original file. To delete a version file
+   * use {@link deleteVersion | deleteVersion()}.
    *
    * @returns Returns the raw data of a deleted file. For more information, see
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
@@ -336,8 +336,8 @@ export class File extends Endpoint {
   }
 
   /**
-   * Saves file properties changes to the server. Call this method to update file data on the
-   * server after any property changes.
+   * Saves file properties changes to the server. Call this method to update file data on the server
+   * after any property changes.
    */
   save(): Promise<this> {
     return this.update(this.data);
@@ -347,12 +347,11 @@ export class File extends Endpoint {
    * Sets or removes the file 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> {
     if (!image) {
@@ -404,8 +403,8 @@ export class File extends Endpoint {
   /**
    * Returns the properties for an objects in the active version of the file.
    *
-   * @param handles - Object original handle or handles array. Specify `undefined` to get
-   *   properties for all objects in the file.
+   * @param handles - Object original handle or handles array. Specify `undefined` to get properties for
+   *   all objects in the file.
    */
   getProperties(handles?: string | string[]): Promise<any[]> {
     const relativePath = handles !== undefined ? `/properties?handles=${handles}` : "/properties";
@@ -424,35 +423,41 @@ export class File extends Endpoint {
    * Query operator. Operator name can be `$and`, `$or`, `$not`, `$eq`, `$regex`.
    *
    * @typedef {any} QueryOperator
-   * @property {string | SearchPattern[] | QueryOperator[]} * - Array of the query values or
-   *   patterns for operator.
-   */
-
-  /**
-   * Returns the list of original handles for an objects in the active version of the file that
-   * match the specified patterns. Search patterns may be combined using query operators.
-   *
-   * @example <caption>Simple search pattern.</caption>
-   *   searchPattern = {
-   *     key: "Category",
-   *     value: "OST_Stairs",
-   *   };
-   *
-   * @example <caption>Search patterns combination.</caption>
-   *   searchPattern = {
-   *     $or: [
-   *       {
-   *         $and: [
-   *           { key: "Category", value: "OST_GenericModel" },
-   *           { key: "Level", value: "03 - Floor" },
-   *         ],
-   *       },
-   *       { key: "Category", value: "OST_Stairs" },
-   *     ],
-   *   };
-   *
-   * @param {SeacrhPattern | QueryOperator} searchPattern - Search pattern or combination of
-   *   the patterns, see example below.
+   * @property {string | SearchPattern[] | QueryOperator[]} * - Array of the query values or patterns for
+   *   operator.
+   */
+
+  /**
+   * Returns the list of original handles for an objects in the active version of the file that match the
+   * specified patterns. Search patterns may be combined using query operators.
+   *
+   * @example Simple search pattern.
+   *
+   * ```javascript
+   * searchPattern = {
+   *   key: "Category",
+   *   value: "OST_Stairs",
+   * };
+   * ```
+   *
+   * @example Search patterns combination.
+   *
+   * ```javascript
+   * searchPattern = {
+   *   $or: [
+   *     {
+   *       $and: [
+   *         { key: "Category", value: "OST_GenericModel" },
+   *         { key: "Level", value: "03 - Floor" },
+   *       ],
+   *     },
+   *     { key: "Category", value: "OST_Stairs" },
+   *   ],
+   * };
+   * ```
+   *
+   * @param {SeacrhPattern | QueryOperator} searchPattern - Search pattern or combination of the
+   *   patterns, see example below.
    * @returns {Promise<Properties[]>}
    */
 
@@ -523,8 +528,8 @@ export class File extends Endpoint {
    *
    * @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.
    */
   download(onProgress?: (progress: number) => void, signal?: AbortSignal): Promise<ArrayBuffer> {
     return this.httpClient
@@ -533,23 +538,26 @@ export class File extends Endpoint {
   }
 
   /**
-   * Downloads a resource file of the active version of the file. Resource files are files that
-   * contain model scene descriptions, or geometry data, or exported files.
+   * Downloads a resource file of the active version of the file. Resource files are files that contain
+   * model scene descriptions, or geometry data, or exported files.
    *
-   * @example <caption>Export file to DWG.</caption>
-   *   const job = await file.crateJob("dwg");
-   *   await job.waitForDone();
-   *   const dwgFileName = file.exports.find((x) => x.endsWith(".dwg"));
-   *   const arrayBuffer = await file.downloadResource(dwgFileName);
-   *   const blob = new Blob([arrayBuffer]);
-   *   const fileName = file.name + ".dwg";
-   *   FileSaver.saveAs(blob, fileName);
+   * @example Export file to DWG.
+   *
+   * ```javascript
+   * const job = await file.crateJob("dwg");
+   * await job.waitForDone();
+   * const dwgFileName = file.exports.find((x) => x.endsWith(".dwg"));
+   * const arrayBuffer = await file.downloadResource(dwgFileName);
+   * const blob = new Blob([arrayBuffer]);
+   * const fileName = file.name + ".dwg";
+   * FileSaver.saveAs(blob, fileName);
+   * ```
    *
    * @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,
@@ -562,16 +570,16 @@ export class File extends Endpoint {
   }
 
   /**
-   * Downloads a part of resource file of the active version of the file. Resource files are
-   * files that contain model scene descriptions, or geometry data, or exported files.
+   * Downloads a part of resource file of the active version of the file. Resource files are files that
+   * contain model scene descriptions, or geometry data, or exported files.
    *
    * @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,
@@ -628,8 +636,8 @@ export class File 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.get("/references", signal).then((response) => response.json());
@@ -638,8 +646,8 @@ export class File extends Endpoint {
   /**
    * Sets the file references.
    *
-   * References are images, fonts, or any other files to correct rendering of the file.
-   * Reference files must be uploaded to the server before they can be assigned to the current file.
+   * References are images, fonts, or any other files to correct rendering of the file. Reference files
+   * must be uploaded to the server before they can be assigned to the current file.
    *
    * @param references - File references.
    */
@@ -656,14 +664,14 @@ export class File extends Endpoint {
    *   - `geometryGltf` - Convert file geometry data to `glTF` format suitable for `Three.js` viewer.
    *   - `properties` - Extract file properties.
    *   - `validation` - Validate the file. Only for `IFC` files.
-   *   - `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` - Export file to the one of the
-   *       supported format. Use {@link exports | exports()} to get the list of completed file
-   *       exports. Use {@link downloadResource | downloadResource()} to download the exported file.
-   *   - Other custom job name. Custom job runner must be registered in the job templates before
-   *       creating a job.
+   *   - `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` - Export file to the one of the supported format.
+   *       Use {@link exports | exports()} to get the list of completed file exports. Use
+   *       {@link downloadResource | downloadResource()} to download the exported file.
+   *   - Other custom job name. Custom job runner must be registered in the job templates before creating a
+   *       job.
    *
-   * @param parameters - Parameters for the job runner. Can be given as command line arguments
-   *   for the File Converter tool in form `--arg=value`.
+   * @param parameters - Parameters for the job runner. Can be given as command line arguments for the
+   *   File Converter tool in form `--arg=value`.
    */
   createJob(outputFormat: string, parameters?: string | object): Promise<Job> {
     const jobs = new Endpoint("/jobs", this.httpClient, this.headers);
@@ -686,8 +694,8 @@ export class File extends Endpoint {
    *   - `vsfx` - `VSFX` format (default), for opening a file in `VisualizeJS` viewer.
    *   - `gltf` - `glTF` format, for opening a file in `Three.js` viewer.
    *
-   * @param parameters - Parameters for the job runner. Can be given as command line arguments
-   *   for the File Converter tool in form `--arg=value`.
+   * @param parameters - Parameters for the job runner. Can be given as command line arguments for the
+   *   File Converter tool in form `--arg=value`.
    */
   extractGeometry(type?: string, parameters?: string | object): Promise<Job> {
     return this.createJob(type === "gltf" ? "geometryGltf" : "geometry", parameters);
@@ -697,8 +705,8 @@ export class File extends Endpoint {
    * Runs a job to extract properties of the active version of the file. This is alias to
    * {@link createJob | createJob("properties")}.
    *
-   * @param parameters - Parameters for the job runner. Can be given as command line arguments
-   *   for the File Converter tool in form `--arg=value`.
+   * @param parameters - Parameters for the job runner. Can be given as command line arguments for the
+   *   File Converter tool in form `--arg=value`.
    */
   extractProperties(parameters?: string | object): Promise<Job> {
     return this.createJob("properties", parameters);
@@ -710,30 +718,29 @@ export class File extends Endpoint {
    *
    * To get validation report use {@link downloadResource | downloadResource("validation_report.json")}.
    *
-   * @param parameters - Parameters for the job runner. Can be given as command line arguments
-   *   for the File Converter tool in form `--arg=value`.
+   * @param parameters - Parameters for the job runner. Can be given as command line arguments for the
+   *   File Converter tool in form `--arg=value`.
    */
   validate(parameters?: string | object): Promise<Job> {
     return this.createJob("validation", parameters);
   }
 
   /**
-   * Waits for jobs of the active version of the file to be done. Job is done when it changes
-   * to `none`, `done` or `failed` status.
+   * Waits for jobs of the active version of the file to be done. Job is done when it changes to `none`,
+   * `done` or `failed` status.
    *
-   * @param jobs - Job or job array to wait on. Can be `geometry`, `geometryGltf`,
-   *   `properties`, `validation`, `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` or custom
-   *   job name.
-   * @param waitAll - If this parameter is `true`, the function returns when all the specified
-   *   jobs have done. If `false`, the function returns when any one of the jobs are done.
+   * @param jobs - Job or job array to wait on. Can be `geometry`, `geometryGltf`, `properties`,
+   *   `validation`, `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` or custom job name.
+   * @param waitAll - If this parameter is `true`, the function returns when all the specified jobs have
+   *   done. If `false`, the function returns when any one of the jobs are done.
    * @param params - An object containing waiting parameters.
-   * @param params.timeout - The time, in milliseconds that the function should wait jobs. If
-   *   no one jobs are done during this time, the `TimeoutError` exception will be thrown.
-   * @param params.interval - The time, in milliseconds, the function should delay in between
-   *   checking jobs status.
+   * @param params.timeout - The time, in milliseconds that the function should wait jobs. If no one jobs
+   *   are done during this time, the `TimeoutError` exception will be thrown.
+   * @param params.interval - The time, in milliseconds, the function should delay in between checking
+   *   jobs status.
    * @param params.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.
    * @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
    */
   waitForDone(
@@ -786,15 +793,21 @@ export class File extends Endpoint {
   /**
    * Creates a new file permission for a user, project, or group.
    *
-   * @example <caption>Grant the specified user permission to "update" the file.</caption>
-   *   const action = "update";
-   *   const grantedTo = [{ user: { id: myUser.id, email: myUser.email } }];
-   *   await file.createPermission(action, grantedTo);
+   * @example Grant the specified user permission to "update" the file.
+   *
+   * ```javascript
+   * const action = "update";
+   * const grantedTo = [{ user: { id: myUser.id, email: myUser.email } }];
+   * await file.createPermission(action, grantedTo);
+   * ```
+   *
+   * @example Add a file to the specified project in "read-only" mode.
    *
-   * @example <caption>Add a file to the specified project in `read-only` mode.</caption>
-   *   const actions = ["read", "readSourceFile"];
-   *   const grantedTo = [{ project: { id: myProject.id, name: myProject.name } }];
-   *   await file.createPermission(actions, grantedTo);
+   * ```javascript
+   * const actions = ["read", "readSourceFile"];
+   * const grantedTo = [{ project: { id: myProject.id, name: myProject.name } }];
+   * await file.createPermission(actions, grantedTo);
+   * ```
    *
    * @param actions - Actions are allowed to be performed on a file with this permission:
    *
@@ -829,25 +842,24 @@ export class File extends Endpoint {
   }
 
   /**
-   * Uploads the new version of the file to the server, convert the geometry data and extract
-   * properties as needed.
+   * Uploads the new version of the file to the server, convert the geometry data and extract properties
+   * as needed.
    *
-   * @param file - {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object
-   *   are generally retrieved from a
-   *   {@link https://developer.mozilla.org/docs/Web/API/FileList | FileList} object returned as
-   *   a result of a user selecting files using the HTML `<input>` element.
+   * @param file - {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object are
+   *   generally retrieved from a {@link https://developer.mozilla.org/docs/Web/API/FileList | FileList}
+   *   object returned as a result of a user selecting files using the HTML `<input>` element.
    * @param params - An object containing upload parameters.
-   * @param params.geometry - Create job to convert file geometry data. The geometry data type
-   *   is the same as the original file.
+   * @param params.geometry - Create job to convert file geometry data. The geometry data type is the
+   *   same as the original file.
    * @param params.properties - Create job to extract file properties.
    * @param params.waitForDone - Wait for geometry and properties jobs to complete.
-   * @param params.timeout - The time, in milliseconds that the function should wait jobs. If
-   *   no one jobs are done during this time, the `TimeoutError` exception will be thrown.
-   * @param params.interval - The time, in milliseconds, the function should delay in between
-   *   checking jobs status.
+   * @param params.timeout - The time, in milliseconds that the function should wait jobs. If no one jobs
+   *   are done during this time, the `TimeoutError` exception will be thrown.
+   * @param params.interval - The time, in milliseconds, the function should delay in between checking
+   *   jobs status.
    * @param params.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.
    * @param params.onProgress - Upload progress callback.
    */
 
@@ -939,8 +951,8 @@ export class File extends Endpoint {
   }
 
   /**
-   * Makes the given version active on client side. Does not change the active file version on
-   * the server.
+   * Makes the given version active on client side. Does not change the active file version on the
+   * server.
    *
    * This version change will affect the result:
    *
@@ -957,11 +969,11 @@ export class File extends Endpoint {
    * - {@link waitForDone | waitForDone()}
    * - Viewer.open()
    *
-   * Other clients will still continue to use the current active version of the file. Use
-   * `undefined` to revert back to the active version.
+   * Other clients will still continue to use the current active version of the file. Use `undefined` to
+   * revert back to the active version.
    *
-   * You need to reload the file data using {@link checkout | checkout()} to match the size and
-   * status fields to the version you selected.
+   * You need to reload the file data using {@link checkout | checkout()} to match the size and status
+   * fields to the version you selected.
    */
   override useVersion(version?: number): this {
     return super.useVersion(version);

package/src/Api/IHttpClient.ts

@@ -98,10 +98,9 @@ export interface IHttpClient {
    * Upload a file to the server.
    *
    * @param relativePath - Upload endpoint relative path.
-   * @param file - {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object
-   *   are generally retrieved from a
-   *   {@link https://developer.mozilla.org/docs/Web/API/FileList | FileList} object returned as
-   *   a result of a user selecting files using the HTML `<input>` element.
+   * @param file - {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object are
+   *   generally retrieved from a {@link https://developer.mozilla.org/docs/Web/API/FileList | FileList}
+   *   object returned as a result of a user selecting files using the HTML `<input>` element.
    * @param onProgress - Upload progress callback.
    * @param init - A set of options that can be used to configure a fetch request. See
    *   {@link https://developer.mozilla.org/docs/Web/API/RequestInit | RequestInit} for more details.

package/src/Api/IRole.ts

@@ -26,8 +26,8 @@
  */
 export interface IRoleActions {
   /**
-   * Defines what actions are allowed to be performed at the project level. The available
-   * actions include:
+   * Defines what actions are allowed to be performed at the project level. The available actions
+   * include:
    *
    * - `update` - The ability to update the project details.
    * - `createTopic` - The ability to create a new topic.
@@ -49,8 +49,8 @@ export interface IRoleActions {
   topicActions?: string[];
 
   /**
-   * Defines what actions are allowed to be performed at the comment level. The available
-   * actions include:
+   * Defines what actions are allowed to be performed at the comment level. The available actions
+   * include:
    *
    * - `update` - The ability to update the comment.
    * - `delete` - The ability to delete the comment.
@@ -58,8 +58,8 @@ export interface IRoleActions {
   commentActions?: string[];
 
   /**
-   * Defines what actions are allowed to be performed at the viewpoint level. The available
-   * actions include:
+   * Defines what actions are allowed to be performed at the viewpoint level. The available actions
+   * include:
    *
    * - `update` - The ability to update the viewpoint.
    * - `delete` - The ability to delete the viewpoint.

package/src/Api/ISharedLink.ts

@@ -53,7 +53,7 @@ export interface ISharedLinkPermissions {
   /**
    * true if the shared link is password protected.
    */
-  readonly passwordProtected?: string;
+  readonly passwordProtected?: boolean;
 
   /**
    * Link expiration time (UTC) in the format specified in

package/src/Api/IUser.ts

@@ -56,14 +56,14 @@ export interface IShortUserDesc {
   avatarUrl?: string;
 
   /**
-   * User full name. Contains the user's first and last name. If first name and last names are
-   * empty, contains the user name.
+   * User full name. Contains the user's first and last name. If first name and last names are empty,
+   * contains the user name.
    */
   fullName?: string;
 
   /**
-   * User initials. Contains a first letters of the user's first and last names. If first name
-   * and last names are empty, contains the first letter of the user name.
+   * User initials. Contains a first letters of the user's first and last names. If first name and last
+   * names are empty, contains the first letter of the user name.
    */
   initials?: string;
 }

package/src/Api/Job.ts

@@ -121,8 +121,8 @@ export class Job extends Endpoint {
   }
 
   /**
-   * Job type. Can be `properties`, `geomerty`, `geomertyGltf`, `validation`, `clash`, `dwg`,
-   * `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` or custom job name.
+   * Job type. Can be `properties`, `geomerty`, `geomertyGltf`, `validation`, `clash`, `dwg`, `obj`,
+   * `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` or custom job name.
    *
    * @readonly
    */
@@ -180,8 +180,8 @@ export class Job extends Endpoint {
   /**
    * Updates job data on the server.
    *
-   * Only administrators can update job data. If the current logged in user is not an
-   * administrator, 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.
    *
    * @param data - Raw job data. For more information, see
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
@@ -193,8 +193,8 @@ export class Job extends Endpoint {
   }
 
   /**
-   * Deletes a job from the server job list. Jobs that are in progress or have already been
-   * completed cannot be deleted.
+   * Deletes a job from the server job list. Jobs that are in progress or have already been completed
+   * cannot be deleted.
    *
    * @returns Returns the raw data of a deleted job. For more information, see
    *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
@@ -215,13 +215,13 @@ export class Job extends Endpoint {
    * Waits for job to be done. Job is done when it changes to `done` or `failed` status.
    *
    * @param params - An object containing waiting parameters.
-   * @param params.timeout - The time, in milliseconds that the function should wait job. If
-   *   jobs is not done during this time, the `TimeoutError` exception will be thrown.
-   * @param params.interval - The time, in milliseconds, the function should delay in between
-   *   checking job status.
+   * @param params.timeout - The time, in milliseconds that the function should wait job. If jobs is not
+   *   done during this time, the `TimeoutError` exception will be thrown.
+   * @param params.interval - The time, in milliseconds, the function should delay in between checking
+   *   job status.
    * @param params.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.
    * @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
    */
   waitForDone(params?: {

package/src/Api/Member.ts

@@ -27,8 +27,8 @@ import { IShortUserDesc } from "./IUser";
 import { userFullName, userInitials } from "./Utils";
 
 /**
- * Provides properties and methods for obtaining information about a {@link User | user} who has
- * access to the {@link Project | project}.
+ * Provides properties and methods for obtaining information about a {@link User | user} who has access to
+ * the {@link Project | project}.
  */
 export class Member extends Endpoint {
   private _data: any;
@@ -71,8 +71,8 @@ export class Member extends Endpoint {
   }
 
   /**
-   * Member role name in the project. See {@link Project.getRoles | Project.getRoles()} for list
-   * of project roles.
+   * Member role name in the project. See {@link Project.getRoles | Project.getRoles()} for list of
+   * project roles.
    */
   get role(): string {
     return this.data.role;
@@ -132,8 +132,8 @@ export class Member extends Endpoint {
   }
 
   /**
-   * Saves member properties changes to the server. Call this method to update member data on
-   * the server after any property changes.
+   * Saves member properties changes to the server. Call this method to update member data on the server
+   * after any property changes.
    */
   save(): Promise<this> {
     return this.update(this.data);