@inweb/client 25.9.6 → 25.9.7

package/src/Api/File.ts

@@ -40,7 +40,8 @@ export class File {
   public path: string;
 
   /**
-   * @param data - Raw file data received from the server.
+   * @param data - Raw file data received from the server. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
   constructor(data: any, httpClient: IHttpClient) {
@@ -108,7 +109,8 @@ export class File {
   }
 
   /**
-   * Raw file data received from the server.
+   * Raw file data received from the server. For more information, see
+   * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
    *
    * @readonly
    */
@@ -327,7 +329,8 @@ export class File {
   /**
    * Updates file data on the server.
    *
-   * @param data - Raw file data.
+   * @param data - Raw file data. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
    */
   async update(data: any): Promise<this> {
     const response = await this.internalPut("", data);
@@ -341,7 +344,8 @@ export class File {
    * 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.
+   * @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}.
    */
   delete(): Promise<any> {
     return this.internalDelete("").then((response) => response.json());
@@ -400,7 +404,7 @@ export class File {
     return undefined;
   }
 
-  setModelTransformMatrix(handle: string, transform: any): Promise<this> {
+  setModelTransformMatrix(handle: string, transform?: any): Promise<this> {
     console.warn("File does not support model transformation");
     return Promise.resolve(this);
   }
@@ -410,7 +414,7 @@ export class File {
    *
    * @typedef {any} Properties
    * @property {string} handle - Object original handle.
-   * @property {string | any} * - Object property. Can be `any` for nested properties.
+   * @property {string | any} - Object property. Can be `any` for nested properties.
    */
 
   /**
@@ -480,7 +484,8 @@ export class File {
   }
 
   /**
-   * Returns a list of file viewpoints.
+   * Returns a list of file viewpoints. For more information, see
+   * {@link https://cloud.opendesign.com/docs//pages/server/api.html#FileViewpoints | Open Cloud File Viewpoints API}.
    */
   getViewpoints(): Promise<any[]> {
     return this.internalGet("/viewpoints")
@@ -491,7 +496,8 @@ export class File {
   /**
    * Saves a new file viewpoint to the server. To create a viewpoint use `Viewer.createViewpoint()`.
    *
-   * @param viewpoint - Viewpoint.
+   * @param viewpoint - Viewpoint object. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#FileViewpoints | Open Cloud File Viewpoints API}.
    */
   saveViewpoint(viewpoint: any): Promise<any> {
     return this.internalPost("/viewpoints", viewpoint).then((response) => response.json());
@@ -501,7 +507,8 @@ export class File {
    * Deletes the specified file viewpoint.
    *
    * @param guid - Viewpoint GUID.
-   * @returns Returns the raw data of a deleted viewpoint.
+   * @returns Returns the raw data of a deleted viewpoint. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#FileViewpoints | Open Cloud File Viewpoints API}.
    */
   deleteViewpoint(guid: string): Promise<any> {
     return this.internalDelete(`/viewpoints/${guid}`).then((response) => response.json());
@@ -827,7 +834,8 @@ export class File {
    * Removes the specified permission from the file.
    *
    * @param permissionId - Permission ID.
-   * @returns Returns the raw data of a deleted permission.
+   * @returns Returns the raw data of a deleted permission. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Permission | Open Cloud File Permissions API}.
    */
   deletePermission(permissionId: string): Promise<any> {
     return this.internalDelete(`/permissions/${permissionId}`).then((response) => response.json());
@@ -921,6 +929,8 @@ export class File {
    * Deletes the specified version file.
    *
    * @param version - Version to delete.
+   * @returns Returns the raw data of a deleted version file. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Files | Open Cloud Files API}.
    */
   async deleteVersion(version: number): Promise<any> {
     const response = await this.internalDelete(`/versions/${version}`);

package/src/Api/IAssembly.ts

@@ -21,9 +21,22 @@
 // acknowledge and accept the above terms.
 ///////////////////////////////////////////////////////////////////////////////
 
+import { IShortUserDesc } from "./IUser";
+
+/**
+ * Defines the information about file from which the assembly was created.
+ */
 export interface IAssociatedFileData {
+  /**
+   * File ID.
+   */
   fileId: string;
+
+  /**
+   * File name.
+   */
   name: string;
+
   link: string;
   version?: number;
 }
@@ -62,3 +75,23 @@ export interface IModelTransformMatrix {
    */
   scale: number;
 }
+
+/**
+ * Defines the information about the clash of two objects.
+ */
+export interface IClashItem {
+  /**
+   * Handle of the first object, including the assembly model index in the form "model_object".
+   */
+  first: string;
+
+  /**
+   * Handle of the second object, including the assembly model index in the form "model_object".
+   */
+  second: string;
+
+  /**
+   * The distance between objects.
+   */
+  distance: number;
+}

package/src/Api/IFile.ts

@@ -93,17 +93,43 @@ export interface IFileReferences {
   references: IFileReference[] | null;
 }
 
+/**
+ * Defines the information about file version.
+ */
 export interface IFileVersionInfo {
+  /**
+   * Version file ID.
+   */
   fileId: string;
+
+  /**
+   * Version file data status.
+   */
   status: IFileStatus;
+
+  /**
+   * Zero-based version number. The original file has version `0`.
+   */
   version: number;
+
+  /**
+   * Version creation time (UTC).
+   */
   createdAt: string;
+
+  /**
+   * Size of the version file in bytes.
+   */
   size: number;
+
+  /**
+   * ID of the user who created the version.
+   */
   ownerId: string;
 }
 
 /**
- * Defines the entity, that will have access to the {@link File | file}.
+ * Defines the user, project, or group that will have access to the {@link File | file}.
  */
 export interface IGrantedTo {
   /**

package/src/Api/Job.ts

@@ -32,7 +32,8 @@ export class Job {
   public httpClient: IHttpClient;
 
   /**
-   * @param data - Raw job data received from the server.
+   * @param data - Raw job data received from the server. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
   constructor(data: any, httpClient: IHttpClient) {
@@ -81,7 +82,8 @@ export class Job {
   }
 
   /**
-   * Raw job data received from the server.
+   * Raw job data received from the server. For more information, see
+   * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
    *
    * @readonly
    */
@@ -141,7 +143,8 @@ export class Job {
   }
 
   /**
-   * Parameters for the job runner.
+   * Parameters with which the job runner was started. For more information, see
+   * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
    *
    * @readonly
    */
@@ -192,7 +195,8 @@ export class Job {
    * 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.
+   * @param data - Raw job data. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
    */
   async update(data: any): Promise<this> {
     const response = await this.internalPut(data);
@@ -204,7 +208,8 @@ export class Job {
    * 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.
+   * @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}.
    */
   delete(): Promise<any> {
     return this.internalDelete().then((response) => response.json());

package/src/Api/Member.ts

@@ -35,7 +35,8 @@ export class Member {
   public httpClient: IHttpClient;
 
   /**
-   * @param data - Raw member data received from the server.
+   * @param data - Raw member data received from the server. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    * @param projectId - Owner project ID.
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
@@ -58,7 +59,8 @@ export class Member {
   }
 
   /**
-   * Raw member data received from the server.
+   * Raw member data received from the server. For more information, see
+   * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    *
    * @readonly
    */
@@ -124,7 +126,8 @@ export class Member {
   /**
    * Updates member data on the server.
    *
-   * @param data - Raw member data.
+   * @param data - Raw member data. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    */
   async update(data: any): Promise<this> {
     const response = await this.internalPut(data);
@@ -135,7 +138,8 @@ export class Member {
   /**
    * Removes a member from the project.
    *
-   * @returns Returns the raw data of a deleted member.
+   * @returns Returns the raw data of a deleted member. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    */
   delete(): Promise<any> {
     return this.internalDelete().then((response) => response.json());

package/src/Api/Model.ts

@@ -24,11 +24,13 @@
 import { IHttpClient } from "./IHttpClient";
 import type { File } from "./File";
 import type { Assembly } from "./Assembly";
+import type { IFileReferences } from "./IFile";
 import type { IModelTransformMatrix } from "./IAssembly";
 
 /**
- * Provides properties and methods for working with view of the file or assembly. For example,
- * for `dwg` it is a `Model` space or layout, and for `rvt` files it is a `3D` view.
+ * 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.
  */
 export class Model {
   private _data: any;
@@ -171,7 +173,7 @@ export class Model {
    * @param handle - Model handle.
    * @param transform - Transformation matrix. Specify `undefined` to remove transformation.
    */
-  setModelTransformMatrix(handle: string, transform: IModelTransformMatrix): Promise<this> {
+  setModelTransformMatrix(handle: string, transform?: IModelTransformMatrix): Promise<this> {
     return this.file.setModelTransformMatrix(handle, transform).then(() => this);
   }
 
@@ -192,7 +194,7 @@ export class Model {
    * Saves a new model owner file/assembly viewpoint to the server. To create a new viewpoint
    * use `Viewer.createViewpoint()`.
    *
-   * @param viewpoint - Viewpoint.
+   * @param viewpoint - Viewpoint object.
    */
   saveViewpoint(viewpoint: any): Promise<any> {
     return this._file.saveViewpoint({
@@ -328,7 +330,7 @@ export class Model {
    *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
    *   signal, which can be used to abort waiting as desired.
    */
-  getReferences(signal?: AbortSignal): Promise<any> {
+  getReferences(signal?: AbortSignal): Promise<IFileReferences> {
     return this._file.getReferences(signal);
   }
 }

package/src/Api/Permission.ts

@@ -26,7 +26,7 @@ import { IGrantedTo } from "./IFile";
 
 /**
  * Provides properties and methods for obtaining information about {@link File | file} actions
- * granted to a specific {@link User | users}, or project {@link Member | member}.
+ * granted to a specific user, project, or group.
  */
 export class Permission {
   private _data: any;
@@ -34,7 +34,8 @@ export class Permission {
   public httpClient: IHttpClient;
 
   /**
-   * @param data - Raw permission data received from the server.
+   * @param data - Raw permission data received from the server. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Permission | Open Cloud Permissions API}.
    * @param fileId - Owner file ID.
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
@@ -64,6 +65,20 @@ export class Permission {
    * - `write` - The ability to modify file name, description and references.
    * - `readViewpoint` - The ability to read file viewpoints.
    * - `createViewpoint` - The ability to create file viewpoints.
+   *
+   * @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;
@@ -74,7 +89,8 @@ export class Permission {
   }
 
   /**
-   * Raw permission data received from the server.
+   * Raw permission data received from the server. For more information, see
+   * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Permission | Open Cloud Permissions API}.
    *
    * @readonly
    */
@@ -96,7 +112,7 @@ export class Permission {
   }
 
   /**
-   * A list of entities that will get access to the file.
+   * A list of users, projects, or groups that will get access to the file.
    */
   get grantedTo(): IGrantedTo[] {
     return this.data.grantedTo;
@@ -129,18 +145,8 @@ export class Permission {
   /**
    * Updates permission data on the server.
    *
-   * @example <caption>Update 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.allSettled(
-   *     projectPermissions.map((permission) => permission.update({ newActions }))
-   *   );
-   *
-   * @param data - Raw permission data.
+   * @param data - Raw permission data. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Permission | Open Cloud Permissions API}.
    */
   async update(data: any): Promise<this> {
     const response = await this.internalPut(data);
@@ -151,7 +157,8 @@ export class Permission {
   /**
    * Removes a permission from the file.
    *
-   * @returns Returns the raw data of a deleted permission.
+   * @returns Returns the raw data of a deleted permission. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Permission | Open Cloud Permissions API}.
    */
   delete(): Promise<any> {
     return this.internalDelete().then((response) => response.json());

package/src/Api/Project.ts

@@ -38,7 +38,8 @@ export class Project {
   public httpClient: IHttpClient;
 
   /**
-   * @param data - Raw project data received from the server.
+   * @param data - Raw project data received from the server. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
   constructor(data: any, httpClient: IHttpClient) {
@@ -102,7 +103,8 @@ export class Project {
   }
 
   /**
-   * Raw project data received from the server.
+   * Raw project data received from the server. For more information, see
+   * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    *
    * @readonly
    */
@@ -254,7 +256,8 @@ export class Project {
   /**
    * Updates project data on the server.
    *
-   * @param data - Raw project data.
+   * @param data - Raw project data. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    */
   async update(data: any): Promise<this> {
     const response = await this.internalPut("", data);
@@ -265,7 +268,8 @@ export class Project {
   /**
    * Deletes a project from the server.
    *
-   * @returns Returns the raw data of a deleted project.
+   * @returns Returns the raw data of a deleted project. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    */
   delete(): Promise<any> {
     return this.internalDelete("")
@@ -300,7 +304,7 @@ export class Project {
    *   the `image` to `null` will remove the preview.
    */
 
-  async setPreview(image?: BodyInit | null): Promise<any> {
+  async setPreview(image?: BodyInit | null): Promise<this> {
     if (!image) {
       await this.deletePreview();
     } else {
@@ -361,7 +365,8 @@ export class Project {
    * Deletes the specified project role.
    *
    * @param name - Role name.
-   * @returns Returns the raw data of a deleted role.
+   * @returns Returns the raw data of a deleted role. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    */
   deleteRole(name: string): Promise<any> {
     return this.internalDelete(`/roles/${name}`).then((response) => response.json());
@@ -403,7 +408,8 @@ export class Project {
    * Removes the specified member from a project.
    *
    * @param memberId - Member ID.
-   * @returns Returns the raw data of a deleted member.
+   * @returns Returns the raw data of a deleted member. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    */
   removeMember(memberId: string): Promise<any> {
     return this.internalDelete(`/members/${memberId}`).then((response) => response.json());
@@ -423,7 +429,8 @@ export class Project {
    */
 
   /**
-   * Returns a list of project files.
+   * 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
@@ -500,7 +507,7 @@ export class Project {
   /**
    * Adds a file to the project with specified permissions.
    *
-   * To change file permissions for the project use {@link Permission.update | Permissions.update()}.
+   * To change file permissions for the project use {@link Permission.actions}.
    *
    * @param fileId - File ID.
    * @param actions - Actions are allowed to be performed on a file:

package/src/Api/Role.ts

@@ -34,7 +34,8 @@ export class Role {
   public httpClient: IHttpClient;
 
   /**
-   * @param data - Raw role data received from the server.
+   * @param data - Raw role data received from the server. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    * @param projectId - Owner project ID.
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
@@ -68,7 +69,8 @@ export class Role {
   }
 
   /**
-   * Raw role data received from the server.
+   * Raw role data received from the server. For more information, see
+   * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    *
    * @readonly
    */
@@ -114,7 +116,8 @@ export class Role {
   /**
    * Updates role data on the server.
    *
-   * @param data - Raw role data.
+   * @param data - Raw role data. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    */
   async update(data: any): Promise<this> {
     const response = await this.internalPut(data);
@@ -125,7 +128,8 @@ export class Role {
   /**
    * Deletes a role from the project.
    *
-   * @returns Returns the raw data of a deleted role.
+   * @returns Returns the raw data of a deleted role. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Project | Open Cloud Projects API}.
    */
   delete(): Promise<any> {
     return this.internalDelete().then((response) => response.json());

package/src/Api/User.ts

@@ -34,7 +34,8 @@ export class User {
   public httpClient: IHttpClient;
 
   /**
-   * @param data - Raw user data received from the server.
+   * @param data - Raw user data received from the server. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Users | Open Cloud Users API}.
    * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
   constructor(data: any, httpClient: IHttpClient) {
@@ -87,7 +88,8 @@ export class User {
   }
 
   /**
-   * Raw user data received from the server.
+   * Raw user data received from the server. For more information, see
+   * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Users | Open Cloud Users API}.
    *
    * @readonly
    */
@@ -119,6 +121,9 @@ export class User {
   /**
    * The user's email confirmation code, or an empty string if the email has already been confirmed.
    *
+   * To send the confirmation code to the server, use
+   * {@link Client.confirmUserEmail | Client.confirmUserEmail()}.
+   *
    * @readonly
    */
   get emailConfirmationId(): string {
@@ -307,7 +312,8 @@ export class User {
    * 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.
+   * @param data - Raw user data. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Users | Open Cloud Users API}.
    */
   async update(data: any): Promise<this> {
     if (this.httpClient.signInUserIsAdmin) {
@@ -335,7 +341,8 @@ export class User {
    *
    * You need to re-login after deleting the current logged in user.
    *
-   * @returns Returns the raw data of a deleted user.
+   * @returns Returns the raw data of a deleted user. For more information, see
+   *   {@link https://cloud.opendesign.com/docs//pages/server/api.html#Users | Open Cloud Users API}.
    */
   delete(): Promise<any> {
     if (this.httpClient.signInUserIsAdmin) {

package/src/index.ts

@@ -29,8 +29,15 @@ export { File } from "./Api/File";
 export { FetchError, statusText } from "./Api/FetchError";
 export { Job } from "./Api/Job";
 export { IHttpClient } from "./Api/IHttpClient";
-export { IModelTransformMatrix } from "./Api/IAssembly";
-export { IFileDataStatus, IFileReference, IFileReferences, IFileStatus, IGrantedTo } from "./Api/IFile";
+export { IAssociatedFileData, IClashItem, IModelTransformMatrix } from "./Api/IAssembly";
+export {
+  IFileDataStatus,
+  IFileReference,
+  IFileReferences,
+  IFileStatus,
+  IFileVersionInfo,
+  IGrantedTo,
+} from "./Api/IFile";
 export { IRoleActions } from "./Api/IRole";
 export { IShortUserDesc } from "./Api/IUser";
 export { Member } from "./Api/Member";