@inweb/client 25.9.4 → 25.9.6

package/dist/client.js

@@ -1108,9 +1108,24 @@
         async downloadFileRange(requestId, records, dataId, onProgress, signal) {
             await this.downloadResourceRange(dataId, requestId, records, onProgress, signal);
         }
-        // Reserved for future use
-        getReferences(signal) {
-            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) {
+            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) => JSON.parse(x)));
+            return { id: "", references };
         }
         /**
          * Waits for assembly to be created. Assembly is created when it changes to `done` or `failed` status.
@@ -1706,6 +1721,17 @@
         /**
          * 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) {
@@ -2633,7 +2659,7 @@
                 .then((data) => new Permission(data, this.id, this.httpClient));
         }
         /**
-         * 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";
@@ -3382,7 +3408,7 @@
                 .then((data) => new Member(data, this.id, this.httpClient));
         }
         /**
-         * 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}.
@@ -3393,7 +3419,7 @@
                 .then((data) => new Member(data, this.id, this.httpClient));
         }
         /**
-         * 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.
@@ -3462,6 +3488,63 @@
                 return items;
             });
         }
+        /**
+         * Returns a list of project models.
+         */
+        getModels() {
+            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, actions, _public) {
+            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) {
+            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) => { var _a; return ((_a = x.project) === null || _a === void 0 ? void 0 : _a.id) === this.id; }))
+                .map((permission) => permission.delete()));
+            return file;
+        }
     }
 
     ///////////////////////////////////////////////////////////////////////////////
@@ -4003,7 +4086,7 @@
                 .then((data) => ({
                 ...data,
                 server: data.version,
-                client: "25.9.4",
+                client: "25.9.6",
             }));
         }
         /**
@@ -4718,7 +4801,7 @@
     // By use of this software, its documentation or related materials, you
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
-    const version = "25.9.4";
+    const version = "25.9.6";
 
     exports.Assembly = Assembly;
     exports.ClashTest = ClashTest;