@inweb/client 25.9.4 → 25.9.6

package/lib/Api/Assembly.d.ts

@@ -1,4 +1,5 @@
 import { IHttpClient } from "./IHttpClient";
+import { IFileReferences } from "./IFile";
 import { IAssociatedFileData, IAssemblyVersionInfo, IModelTransformMatrix } from "./IAssembly";
 import { IShortUserDesc } from "./IUser";
 import { Model } from "./Model";
@@ -245,7 +246,17 @@ export declare class Assembly {
      * Deprecated since `25.3`. Use {@link downloadResourceRange | downloadResourceRange()} instead.
      */
     downloadFileRange(requestId: number, records: any | null, dataId: string, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<void>;
-    getReferences(signal?: AbortSignal): Promise<any>;
+    /**
+     * Returns a list of assembly references containing references from all the files from which
+     * the assembly was created.
+     *
+     * References are images, fonts, or any other files to correct rendering of the assembly.
+     *
+     * @param signal - An
+     *   {@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>;
     /**
      * Waits for assembly to be created. Assembly is created when it changes to `done` or `failed` status.
      *

package/lib/Api/FetchError.d.ts

@@ -6,8 +6,14 @@ export declare function error400(text: string, _default?: string): string;
  * occurs, access denied, or object not found.
  */
 export declare class FetchError extends Error {
-    protected status: number;
-    protected statusText: string;
+    /**
+     * {@link https://developer.mozilla.org/docs/Web/HTTP/Status | HTTP status code} of the response.
+     */
+    status: number;
+    /**
+     * Status message corresponding to the {@link status | status code}.
+     */
+    statusText: string;
     /**
      * @property status - The
      *   {@link https://developer.mozilla.org/docs/Web/HTTP/Status | HTTP status code} of the response.

package/lib/Api/File.d.ts

@@ -466,7 +466,7 @@ export declare class File {
      */
     getPermission(permissionId: string): Promise<Permission>;
     /**
-     * Creates a new file permission.
+     * 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";

package/lib/Api/IFile.d.ts

@@ -1,12 +1,36 @@
+/**
+ * Defines the data status.
+ */
 export interface IFileDataStatus {
+    /**
+     * Data state. Can be `none`, `waiting`, `inprogress`, `done` or `failed`.
+     */
     state: string;
+    /**
+     * Unique ID of the data job.
+     */
     jobId?: string;
     jobUrl?: string;
 }
+/**
+ * Defines the file status.
+ */
 export interface IFileStatus {
+    /**
+     * Status of geometry data of `vsfx` type.
+     */
     geometry: IFileDataStatus;
+    /**
+     * Status of geometry data of `gltf` type.
+     */
     geometryGltf: IFileDataStatus;
+    /**
+     * Status of the properties.
+     */
     properties: IFileDataStatus;
+    /**
+     * Status of the validation.
+     */
     validation: IFileDataStatus;
 }
 /**
@@ -44,11 +68,11 @@ export interface IFileVersionInfo {
     ownerId: string;
 }
 /**
- * Defines the entity, that will have access to the file.
+ * Defines the entity, that will have access to the {@link File | file}.
  */
 export interface IGrantedTo {
     /**
-     * The user entry that has access to the file.
+     * The user that has access to the file.
      */
     user?: {
         /**
@@ -61,7 +85,7 @@ export interface IGrantedTo {
         email: string;
     };
     /**
-     * The project entry that has access to the file.
+     * The project that has access to the file.
      */
     project?: {
         /**
@@ -73,4 +97,21 @@ export interface IGrantedTo {
          */
         name: string;
     };
+    /**
+     * The group that has access to the file.
+     */
+    group?: {
+        /**
+         * Project ID.
+         */
+        projectId: string;
+        /**
+         * Group ID.
+         */
+        groupId: string;
+        /**
+         * Group name.
+         */
+        name: string;
+    };
 }

package/lib/Api/Permission.d.ts

@@ -58,6 +58,17 @@ export declare 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.
      */
     update(data: any): Promise<this>;

package/lib/Api/Project.d.ts

@@ -3,6 +3,7 @@ import { IShortUserDesc } from "./IUser";
 import { Role } from "./Role";
 import { IRoleActions } from "./IRole";
 import { Member } from "./Member";
+import { File } from "./File";
 /**
  * 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.
@@ -198,14 +199,14 @@ export declare class Project {
      */
     getMember(memberId: string): Promise<Member>;
     /**
-     * Add a user to the project to become a member and have permission to perform actions.
+     * Adds 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 {@link getRoles | roles}.
      */
     addMember(userId: string, role: string): Promise<Member>;
     /**
-     * Remove the specified member from a project.
+     * Removes the specified member from a project.
      *
      * @param memberId - Member ID.
      * @returns Returns the raw data of a deleted member.
@@ -231,4 +232,33 @@ export declare class Project {
      * {@link File.createPermission | File.createPermission()}.
      */
     getFilesInformation(): Promise<any[]>;
+    /**
+     * Returns a list of project models.
+     */
+    getModels(): Promise<File[]>;
+    /**
+     * Adds a file to the project with specified permissions.
+     *
+     * To change file permissions for the project use {@link Permission.update | Permissions.update()}.
+     *
+     * @param fileId - File ID.
+     * @param actions - Actions are allowed to be performed on a file:
+     *
+     *   - `read` - The ability to read file description, geometry data and properties.
+     *   - `readSourceFile` - The ability to read source file.
+     *   - `write` - The ability to modify file name, description and references.
+     *   - `readViewpoint` - The ability to read file viewpoints.
+     *   - `createViewpoint` - The ability to create file viewpoints.
+     *
+     * @param _public - Specifies whether all users have access to the file or not.
+     * @returns Returns a file instance added to the project.
+     */
+    addModel(fileId: string, actions: string | string[], _public: boolean): Promise<File>;
+    /**
+     * Removes the specified file from a project.
+     *
+     * @param fileId - File ID.
+     * @returns Returns a file instance removed from the project.
+     */
+    removeModel(fileId: string): Promise<File>;
 }

package/lib/index.d.ts

@@ -7,7 +7,7 @@ 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 { IFileDataStatus, IFileReference, IFileReferences, IFileStatus, IGrantedTo } from "./Api/IFile";
 export { IRoleActions } from "./Api/IRole";
 export { IShortUserDesc } from "./Api/IUser";
 export { Member } from "./Api/Member";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.9.4",
+  "version": "25.9.6",
   "description": "JavaScript REST API client for the Open Cloud Server",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -26,6 +26,6 @@
     "docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/eventemitter2": "~25.9.4"
+    "@inweb/eventemitter2": "~25.9.6"
   }
 }

package/src/Api/Assembly.ts

@@ -23,6 +23,7 @@
 
 import { IHttpClient } from "./IHttpClient";
 import { FetchError } from "./FetchError";
+import { IFileReferences } from "./IFile";
 import { IAssociatedFileData, IAssemblyVersionInfo, IModelTransformMatrix } from "./IAssembly";
 import { IShortUserDesc } from "./IUser";
 import { Model } from "./Model";
@@ -469,10 +470,26 @@ export class Assembly {
     await this.downloadResourceRange(dataId, requestId, records, onProgress, signal);
   }
 
-  // Reserved for future use
-
-  getReferences(signal?: AbortSignal): Promise<any> {
-    return Promise.resolve({ fileId: "", references: [] });
+  /**
+   * Returns a list of assembly references containing references from all the files from which
+   * the assembly was created.
+   *
+   * References are images, fonts, or any other files to correct rendering of the assembly.
+   *
+   * @param signal - An
+   *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+   *   signal, which can be used to abort waiting as desired.
+   */
+  async getReferences(signal?: AbortSignal): Promise<IFileReferences> {
+    const references = await Promise.all(
+      this.associatedFiles
+        .map((file) => `/files/${file.fileId}/references`)
+        .map((link) => this.httpClient.get(link, signal).then((response) => response.json()))
+    )
+      .then((references) => references.map((x) => x.references))
+      .then((references) => references.reduce((x, v) => [...v, ...x], []))
+      .then((references) => [...new Set(references.map(JSON.stringify))].map((x: string) => JSON.parse(x)));
+    return { id: "", references };
   }
 
   /**

package/src/Api/FetchError.ts

@@ -106,8 +106,15 @@ export function error400(text: string, _default = "400"): string {
  */
 
 export class FetchError extends Error {
-  protected status: number;
-  protected statusText: string;
+  /**
+   * {@link https://developer.mozilla.org/docs/Web/HTTP/Status | HTTP status code} of the response.
+   */
+  public status: number;
+
+  /**
+   * Status message corresponding to the {@link status | status code}.
+   */
+  public statusText: string;
 
   /**
    * @property status - The

package/src/Api/File.ts

@@ -790,7 +790,7 @@ export class File {
   }
 
   /**
-   * Creates a new file permission.
+   * 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";

package/src/Api/IFile.ts

@@ -21,16 +21,45 @@
 // acknowledge and accept the above terms.
 ///////////////////////////////////////////////////////////////////////////////
 
+/**
+ * Defines the data status.
+ */
 export interface IFileDataStatus {
+  /**
+   * Data state. Can be `none`, `waiting`, `inprogress`, `done` or `failed`.
+   */
   state: string;
+
+  /**
+   * Unique ID of the data job.
+   */
   jobId?: string;
+
   jobUrl?: string;
 }
 
+/**
+ * Defines the file status.
+ */
 export interface IFileStatus {
+  /**
+   * Status of geometry data of `vsfx` type.
+   */
   geometry: IFileDataStatus;
+
+  /**
+   * Status of geometry data of `gltf` type.
+   */
   geometryGltf: IFileDataStatus;
+
+  /**
+   * Status of the properties.
+   */
   properties: IFileDataStatus;
+
+  /**
+   * Status of the validation.
+   */
   validation: IFileDataStatus;
 }
 
@@ -74,11 +103,11 @@ export interface IFileVersionInfo {
 }
 
 /**
- * Defines the entity, that will have access to the file.
+ * Defines the entity, that will have access to the {@link File | file}.
  */
 export interface IGrantedTo {
   /**
-   * The user entry that has access to the file.
+   * The user that has access to the file.
    */
   user?: {
     /**
@@ -93,7 +122,7 @@ export interface IGrantedTo {
   };
 
   /**
-   * The project entry that has access to the file.
+   * The project that has access to the file.
    */
   project?: {
     /**
@@ -106,4 +135,24 @@ export interface IGrantedTo {
      */
     name: string;
   };
+
+  /**
+   * The group that has access to the file.
+   */
+  group?: {
+    /**
+     * Project ID.
+     */
+    projectId: string;
+
+    /**
+     * Group ID.
+     */
+    groupId: string;
+
+    /**
+     * Group name.
+     */
+    name: string;
+  };
 }

package/src/Api/Permission.ts

@@ -129,6 +129,17 @@ 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.
    */
   async update(data: any): Promise<this> {

package/src/Api/Project.ts

@@ -26,6 +26,7 @@ import { IShortUserDesc } from "./IUser";
 import { Role } from "./Role";
 import { IRoleActions } from "./IRole";
 import { Member } from "./Member";
+import { File } from "./File";
 import { userFullName, userInitials } from "./Utils";
 
 /**
@@ -387,7 +388,7 @@ export class Project {
   }
 
   /**
-   * Add a user to the project to become a member and have permission to perform actions.
+   * Adds 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 {@link getRoles | roles}.
@@ -399,7 +400,7 @@ export class Project {
   }
 
   /**
-   * Remove the specified member from a project.
+   * Removes the specified member from a project.
    *
    * @param memberId - Member ID.
    * @returns Returns the raw data of a deleted member.
@@ -480,4 +481,70 @@ export class Project {
         return items;
       });
   }
+
+  /**
+   * Returns a list of project models.
+   */
+  getModels(): Promise<File[]> {
+    return this.getFilesInformation()
+      .then((filesInformation) => filesInformation.map((item) => item.file.reference))
+      .then((ids) => {
+        const searchParams = new URLSearchParams();
+        searchParams.set("id", ids.join("|"));
+        return this.httpClient.get(`/files?${searchParams.toString()}`);
+      })
+      .then((response) => response.json())
+      .then((files) => files.result.map((data) => new File(data, this.httpClient)));
+  }
+
+  /**
+   * Adds a file to the project with specified permissions.
+   *
+   * To change file permissions for the project use {@link Permission.update | Permissions.update()}.
+   *
+   * @param fileId - File ID.
+   * @param actions - Actions are allowed to be performed on a file:
+   *
+   *   - `read` - The ability to read file description, geometry data and properties.
+   *   - `readSourceFile` - The ability to read source file.
+   *   - `write` - The ability to modify file name, description and references.
+   *   - `readViewpoint` - The ability to read file viewpoints.
+   *   - `createViewpoint` - The ability to create file viewpoints.
+   *
+   * @param _public - Specifies whether all users have access to the file or not.
+   * @returns Returns a file instance added to the project.
+   */
+  async addModel(fileId: string, actions: string | string[], _public: boolean): Promise<File> {
+    const file = await this.httpClient
+      .get(`/files/${fileId}`)
+      .then((response) => response.json())
+      .then((data) => new File(data, this.httpClient));
+
+    const grantedTo = [{ project: { id: this.id, name: this.name } }];
+    await file.createPermission(actions, grantedTo, _public);
+
+    return file;
+  }
+
+  /**
+   * Removes the specified file from a project.
+   *
+   * @param fileId - File ID.
+   * @returns Returns a file instance removed from the project.
+   */
+  async removeModel(fileId: string): Promise<File> {
+    const file = await this.httpClient
+      .get(`/files/${fileId}`)
+      .then((response) => response.json())
+      .then((data) => new File(data, this.httpClient));
+
+    const permissions = await file.getPermissions();
+    await Promise.allSettled(
+      permissions
+        .filter((permission) => permission.grantedTo.some((x) => x.project?.id === this.id))
+        .map((permission) => permission.delete())
+    );
+
+    return file;
+  }
 }

package/src/index.ts

@@ -30,7 +30,7 @@ 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 { IFileDataStatus, IFileReference, IFileReferences, IFileStatus, IGrantedTo } from "./Api/IFile";
 export { IRoleActions } from "./Api/IRole";
 export { IShortUserDesc } from "./Api/IUser";
 export { Member } from "./Api/Member";