@inweb/client 25.9.2 → 25.9.4

package/src/Api/Permission.ts

@@ -22,6 +22,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
+import { IGrantedTo } from "./IFile";
 
 /**
  * Provides properties and methods for obtaining information about {@link File | file} actions
@@ -35,7 +36,7 @@ export class Permission {
   /**
    * @param data - Raw permission data received from the server.
    * @param fileId - Owner file ID.
-   * @param httpClient - HTTP client instance used to send REST API requests to the server.
+   * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
   constructor(data: any, fileId: string, httpClient: IHttpClient) {
     this.httpClient = httpClient;
@@ -95,26 +96,13 @@ export class Permission {
   }
 
   /**
-   * Principials are any entity that can be authenticated by the server, such as a any user or
-   * project that will get access to the file.
-   *
-   * @typedef {any} Principial
-   * @property {any} user - The user entry that get access to the file.
-   * @property {string} user.id - User ID.
-   * @property {string} user.name - User name.
-   * @property {any} project - The project entry that get access to the file.
-   * @property {string} project.id - Project ID.
-   * @property {string} project.name - Project name.
-   */
-
-  /**
-   * A list of principials that will get access to the file.
+   * A list of entities that will get access to the file.
    */
-  get grantedTo(): any[] {
+  get grantedTo(): IGrantedTo[] {
     return this.data.grantedTo;
   }
 
-  set grantedTo(value: any[]) {
+  set grantedTo(value: IGrantedTo[]) {
     this.data.grantedTo = value;
   }
 

package/src/Api/Project.ts

@@ -22,14 +22,15 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
-import { IShortUserDescription } from "./IUser";
+import { IShortUserDesc } from "./IUser";
 import { Role } from "./Role";
+import { IRoleActions } from "./IRole";
 import { Member } from "./Member";
 import { userFullName, userInitials } from "./Utils";
 
 /**
- * Provides properties and methods for obtaining information about a project on the 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 {
   private _data: any;
@@ -37,7 +38,7 @@ export class Project {
 
   /**
    * @param data - Raw project data received from the server.
-   * @param httpClient - HTTP client instance used to send REST API requests to the server.
+   * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
   constructor(data: any, httpClient: IHttpClient) {
     this.httpClient = httpClient;
@@ -182,17 +183,9 @@ export class Project {
   /**
    * Project owner information.
    *
-   * @property {string} userId - User ID.
-   * @property {string} userName - User name.
-   * @property {string} name - First name.
-   * @property {string} lastName - Last name.
-   * @property {string} fullName - Full name.
-   * @property {string} initials - Initials.
-   * @property {string} email - User email.
-   * @property {string} avatarUrl - User avatar image URL.
    * @readonly
    */
-  get owner(): IShortUserDescription {
+  get owner(): IShortUserDesc {
     return this.data.owner;
   }
 
@@ -351,10 +344,9 @@ export class Project {
    *
    * @param name - Role name.
    * @param description - Role description.
-   * @param permissions - Actions are allowed to be performed. See {@link Role.permissions} for
-   *   more details.
+   * @param permissions - Actions are allowed to be performed for the role.
    */
-  createRole(name: string, description: string, permissions: any): Promise<Role> {
+  createRole(name: string, description: string, permissions: IRoleActions): Promise<Role> {
     return this.internalPost("/roles", {
       name,
       description,
@@ -398,7 +390,7 @@ export class Project {
    * Add a user to the project to become a member and have permission to perform actions.
    *
    * @param userId - User ID.
-   * @param role - Role name from the list of project roles.
+   * @param role - Role name from the list of project {@link getRoles | roles}.
    */
   addMember(userId: string, role: string): Promise<Member> {
     return this.internalPost("/members", { userId, role })
@@ -430,8 +422,11 @@ export class Project {
    */
 
   /**
-   * Returns a list of project files. To add a file to this list, create a `project` permission
-   * on the file using {@link File.createPermission | File.createPermission()}.
+   * Returns a list of project files.
+   *
+   * 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[]> {
     return this.httpClient

package/src/Api/Role.ts

@@ -22,6 +22,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
+import { IRoleActions } from "./IRole";
 
 /**
  * A role determines what actions allowed to be performed by {@link User | users} on a
@@ -35,7 +36,7 @@ export class Role {
   /**
    * @param data - Raw role data received from the server.
    * @param projectId - Owner project ID.
-   * @param httpClient - HTTP client instance used to send REST API requests to the server.
+   * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
   constructor(data: any, projectId: string, httpClient: IHttpClient) {
     this.httpClient = httpClient;
@@ -92,26 +93,12 @@ export class Role {
 
   /**
    * Role actions are allowed to be performed.
-   *
-   * @property {string[]} projectActions - Actions are allowed to be performed at the project
-   *   level: `update`, `createTopic`, `createDocument`.
-   * @property {string[]} topicActions - Actions are allowed to be performed at the topic
-   *   level: `update`, `updateBimSnippet`, `updateRelatedTopics`, `updateDocumentReferences`,
-   *   `updateFiles`, `createComment`, `createViewpoint`, `delete`.
-   * @property {string[]} commentActions - Actions are allowed to be performed at the comment
-   *   level: `update`, `delete`.
-   * @property {string[]} viewpointActions - Actions are allowed to be performed at the
-   *   viewpoint level: `delete`.
-   * @property {string[]} odaGroupActions - Actions are allowed to be performed at the members
-   *   level: `update`, `delete`.
-   * @property {string[]} odaRoleActions - Actions are allowed to be performed at the roles
-   *   level: `update`, `delete`.
    */
-  get permissions(): any {
+  get permissions(): IRoleActions {
     return this.data.permissions;
   }
 
-  set permissions(value: any) {
+  set permissions(value: IRoleActions) {
     this.data.permissions = value || {};
   }
 

package/src/Api/User.ts

@@ -26,7 +26,8 @@ import { FetchError } from "./FetchError";
 import { userFullName, userInitials } from "./Utils";
 
 /**
- * Provides properties and methods for obtaining information about a 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 {
   private _data: any;
@@ -34,7 +35,7 @@ export class User {
 
   /**
    * @param data - Raw user data received from the server.
-   * @param httpClient - HTTP client instance used to send REST API requests to the server.
+   * @param httpClient - HTTP client instance used to send requests to the REST API server.
    */
   constructor(data: any, httpClient: IHttpClient) {
     this.httpClient = httpClient;

package/src/index.ts

@@ -28,7 +28,11 @@ export * from "./Api/ClientEvents";
 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 { IGrantedTo } from "./Api/IFile";
+export { IRoleActions } from "./Api/IRole";
+export { IShortUserDesc } from "./Api/IUser";
 export { Member } from "./Api/Member";
 export { Model } from "./Api/Model";
 export { Permission } from "./Api/Permission";