@inweb/client 26.5.4 → 26.6.0

package/dist/client.js

@@ -1056,17 +1056,44 @@
          *
          * @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 group properties.
          */
         /**
          * Returns the properties for an objects in the assembly.
          *
          * @param handles - Object original handle or handles array. Specify `undefined` to get properties for
          *   all objects in the assembly.
+         * @param group - If the `group` parameter is `true`, properties are returned grouped by category. By
+         *   default, or if `group` is set to `false`, properties are returned ungrouped.
+         *
+         *   To get grouped properties, the `--properties_group` command line argument must be specified for the
+         *   `properties` File Converter job when {@link Client.createAssembly | creating the assembly}.
+         *
+         *   ```javascript
+         *   await client.createAssembly([file1.id, file2.id], "AssemblyName", {
+         *     jobParameters: { properties: "--properties_group" },
+         *     waitForDone: true,
+         *   });
+         *   ```
+         *
+         *   Otherwise, the properties will be returned ungrouped, even if the `group` is `true`.
          */
-        getProperties(handles) {
-            const relativePath = handles !== undefined ? `/properties?handles=${handles}` : "/properties";
-            return this.get(relativePath).then((response) => response.json());
+        getProperties(handles, group = false) {
+            const searchParams = new URLSearchParams();
+            if (handles) {
+                if (Array.isArray(handles))
+                    handles = handles.join(",");
+                if (typeof handles === "string")
+                    handles = handles.trim();
+                if (handles)
+                    searchParams.set("handles", handles);
+            }
+            if (group)
+                searchParams.set("group", "true");
+            let queryString = searchParams.toString();
+            if (queryString)
+                queryString = "?" + queryString;
+            return this.get(`/properties${queryString}`).then((response) => response.json());
         }
         /**
          * Returns the list of original handles for an objects in the file that match the specified patterns.
@@ -2563,17 +2590,52 @@
          *
          * @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 group properties.
          */
         /**
          * 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 group - If the `group` parameter is `true`, properties are returned grouped by category. By
+         *   default, or if `group` is set to `false`, properties are returned ungrouped.
+         *
+         *   To get grouped properties, the `--properties_group` command line argument must be specified for the
+         *   `properties` File Converter job when {@link Client.uploadFile | uploading the file}:
+         *
+         *   ```javascript
+         *   await client.uploadFile(file, {
+         *     geometry: true,
+         *     properties: true,
+         *     jobParameters: { properties: "--properties_group" },
+         *     waitForDone: true,
+         *   });
+         *   ```
+         *
+         *   or when running the {@link extractProperties | extract file properties} job:
+         *
+         *   ```javascript
+         *   await file.extractProperties("--properties_group");
+         *   ```
+         *
+         *   Otherwise, the properties will be returned ungrouped, even if the `group` is `true`.
          */
-        getProperties(handles) {
-            const relativePath = handles !== undefined ? `/properties?handles=${handles}` : "/properties";
-            return this.get(relativePath).then((response) => response.json());
+        getProperties(handles, group = false) {
+            const searchParams = new URLSearchParams();
+            if (handles) {
+                if (Array.isArray(handles))
+                    handles = handles.join(",");
+                if (typeof handles === "string")
+                    handles = handles.trim();
+                if (handles)
+                    searchParams.set("handles", handles);
+            }
+            if (group)
+                searchParams.set("group", "true");
+            let queryString = searchParams.toString();
+            if (queryString)
+                queryString = "?" + queryString;
+            return this.get(`/properties${queryString}`).then((response) => response.json());
         }
         /**
          * Search pattern.
@@ -2788,8 +2850,8 @@
          *       {@link downloadResource | downloadResource()} to download the exported file.
          *   - Other custom job name. Custom job must be registered in the job templates before running.
          *
-         * @param parameters - Parameters for the File Converter tool or custom job application. Can be given
-         *   as command line arguments in form `--arg=value`.
+         * @param parameters - Parameters for the File Converter jobs or custom job. Can be given as command
+         *   line arguments in form `--arg=value`.
          */
         createJob(outputFormat, parameters) {
             const jobs = new Endpoint("/jobs", this.httpClient, this.headers);
@@ -2811,8 +2873,8 @@
          *   - `vsfx` - `VSFX` format (default), for opening a file in `VisualizeJS` 3D viewer.
          *   - `gltf` - `glTF` format, for opening a file in `Three.js` 3D viewer.
          *
-         * @param parameters - Parameters for the File Converter tool. Can be given as command line arguments
-         *   in form `--arg=value`.
+         * @param parameters - Parameters for the File Converter job. Can be given as command line arguments in
+         *   form `--arg=value`.
          */
         extractGeometry(type, parameters) {
             return this.createJob(type === "gltf" ? "geometryGltf" : "geometry", parameters);
@@ -2821,8 +2883,8 @@
          * Runs a File Converter job to extract properties of the active version of the file. This is alias to
          * {@link createJob | createJob("properties")}.
          *
-         * @param parameters - Parameters for the File Converter tool. Can be given as command line arguments
-         *   in form `--arg=value`.
+         * @param parameters - Parameters for the File Converter job. Can be given as command line arguments in
+         *   form `--arg=value`.
          */
         extractProperties(parameters) {
             return this.createJob("properties", parameters);
@@ -4569,7 +4631,7 @@
                 .then((data) => ({
                 ...data,
                 server: data.version,
-                client: "26.5.4",
+                client: "26.6.0",
             }));
         }
         /**
@@ -4986,7 +5048,7 @@
          *   - `gltf` - Convert file geometry data to `glTF` format for opening in `Three.js` 3D viewer.
          *
          * @param params.properties - Run File Converter job to extract properties after uploading the file.
-         * @param params.jobParameters - Parameters for the File Converter tool. Use this to specify aditional
+         * @param params.jobParameters - Parameters for the File Converter jobs. Use this to specify aditional
          *   parameters for retrieving the geometry and properties of uploaded file. Can be given as command
          *   line arguments in form `--arg=value`.
          * @param params.waitForDone - Wait for geometry and properties jobs to complete.
@@ -5126,8 +5188,8 @@
          *   - `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` - Export file to the specified format.
          *   - Other custom job name. Custom job must be registered in the job templates before running.
          *
-         * @param parameters - Parameters for the File Converter tool or custom job application. Can be given
-         *   as command line arguments in form `--arg=value`.
+         * @param parameters - Parameters for the File Converter jobs or custom job. Can be given as command
+         *   line arguments in form `--arg=value`.
          */
         createJob(fileId, outputFormat, parameters) {
             return this.httpClient
@@ -5222,7 +5284,7 @@
          * @param files - List of file IDs.
          * @param name - Assembly name.
          * @param params - Additional assembly creating parameters.
-         * @param params.jobParameters - Parameters for the File Converter tool. Use this to specify aditional
+         * @param params.jobParameters - Parameters for the File Converter jobs. Use this to specify aditional
          *   parameters for generating the geometry and properties of the new assembly. Can be given as command
          *   line arguments in form `--arg=value`.
          * @param params.waitForDone - Wait for assembly to be created.
@@ -5468,7 +5530,7 @@
     // By use of this software, its documentation or related materials, you
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
-    const version = "26.5.4";
+    const version = "26.6.0";
 
     exports.Assembly = Assembly;
     exports.ClashTest = ClashTest;