@inweb/client 26.5.3 → 26.5.5

package/dist/client.js

@@ -907,7 +907,7 @@
         /**
          * Assembly geometry data type:
          *
-         * - `vsfx` - `VSFX` format, assembly can be opened in `VisualizeJS` viewer.
+         * - `vsfx` - `VSFX` format, assembly can be opened in `VisualizeJS` 3D viewer.
          *
          * Returns an empty string if the geometry data is not yet ready.
          */
@@ -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.
@@ -1977,8 +2004,15 @@
             return this.data.lastUpdate;
         }
         /**
-         * Job type. Can be `properties`, `geomerty`, `geomertyGltf`, `validation`, `clash`, `dwg`, `obj`,
-         * `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` or custom job name.
+         * Job type. Can be:
+         *
+         * - `geometry` - Convert file geometry data to `VSFX` format.
+         * - `geometryGltf` - Convert file geometry data to `glTF` format.
+         * - `properties` - Extract file properties.
+         * - `validation` - Validate the IFC file.
+         * - `clash` - Create the clash detection report.
+         * - `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` - Export file to the specified format.
+         * - Other custom job name.
          *
          * @readonly
          */
@@ -1986,7 +2020,7 @@
             return this.data.outputFormat;
         }
         /**
-         * Parameters with which the job runner was started. For more information, see
+         * Parameters with which the job was started. For more information, see
          * {@link https://cloud.opendesign.com/docs//pages/server/api.html#Jobs | Open Cloud Jobs API}.
          *
          * @readonly
@@ -2307,7 +2341,7 @@
         /**
          * Returns a list of file formats in which the active version of the file was exported.
          *
-         * To export file to one of the supported formats create File Converter job using
+         * To export file to one of the supported formats run the File Converter job using
          * {@link createJob | createJob()}. To download exported file use
          * {@link downloadResource | downloadResource()}.
          *
@@ -2321,8 +2355,8 @@
         /**
          * Geometry data type of the active file version. Can be one of:
          *
-         * - `vsfx` - `VSFX` format, file can be opened in `VisualizeJS` viewer.
-         * - `gltf` - `glTF` format, file can be opened in `Three.js` viewer.
+         * - `vsfx` - `VSFX` format, file can be opened in `VisualizeJS` 3D viewer.
+         * - `gltf` - `glTF` format, file can be opened in `Three.js` 3D viewer.
          *
          * Returns an empty string if geometry data has not yet been converted. A files without geometry data
          * can be exported to other formas, but cannot be opened in viewer.
@@ -2556,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.
@@ -2687,15 +2756,15 @@
          * Downloads a resource file of the active version of the file. Resource files are files that contain
          * model scene descriptions, or geometry data, or exported files.
          *
-         * @example Export file to DWG.
+         * @example Export file to PDF.
          *
          * ```javascript
-         * const job = await file.crateJob("dwg");
+         * const job = await file.createJob("pdf");
          * await job.waitForDone();
-         * const dwgFileName = file.exports.find((x) => x.endsWith(".dwg"));
-         * const arrayBuffer = await file.downloadResource(dwgFileName);
+         * const pdfResourceName = file.exports.find((x) => x.endsWith(".pdf"));
+         * const arrayBuffer = await file.downloadResource(pdfResourceName);
          * const blob = new Blob([arrayBuffer]);
-         * const fileName = file.name + ".dwg";
+         * const fileName = file.name + ".pdf";
          * FileSaver.saveAs(blob, fileName);
          * ```
          *
@@ -2770,20 +2839,19 @@
         /**
          * Runs a new job on the server for the active version of the file.
          *
-         * @param outputFormat - The job type. Can be one of:
+         * @param outputFormat - The job type. Can be:
          *
-         *   - `geometry` - Convert file geometry data to `VSFX` format suitable for `VisualizeJS` viewer.
-         *   - `geometryGltf` - Convert file geometry data to `glTF` format suitable for `Three.js` viewer.
+         *   - `geometry` - Convert file geometry data to `VSFX` format for opening in `VisualizeJS` 3D viewer.
+         *   - `geometryGltf` - Convert file geometry data to `glTF` format for opening in `Three.js` 3D viewer.
          *   - `properties` - Extract file properties.
-         *   - `validation` - Validate the file. Only for `IFC` files.
-         *   - `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` - Export file to the one of the supported format.
-         *       Use {@link exports | exports()} to get the list of completed file exports. Use
+         *   - `validation` - Validate the IFC file.
+         *   - `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` - Export file to the specified format. Use
+         *       {@link exports} to get the list of completed file exports. Use
          *       {@link downloadResource | downloadResource()} to download the exported file.
-         *   - Other custom job name. Custom job runner must be registered in the job templates before creating a
-         *       job.
+         *   - Other custom job name. Custom job must be registered in the job templates before running.
          *
-         * @param parameters - Parameters for the job runner. Can be given as command line arguments for the
-         *   File Converter tool 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);
@@ -2797,38 +2865,38 @@
                 .then((data) => new Job(data, this.httpClient));
         }
         /**
-         * Runs a job to convert geometry data of active version of the file. This is alias to
-         * {@link createJob | createJob("geometry")}.
+         * Runs a File Converter job to convert geometry data of active version of the file to the specified
+         * format. This is alias to {@link createJob | createJob("geometry")}.
          *
          * @param type - Geometry data type. Can be one of:
          *
-         *   - `vsfx` - `VSFX` format (default), for opening a file in `VisualizeJS` viewer.
-         *   - `gltf` - `glTF` format, for opening a file in `Three.js` viewer.
+         *   - `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 job runner. Can be given as command line arguments for the
-         *   File Converter tool 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);
         }
         /**
-         * Runs a job to extract properties of the active version of the file. This is alias to
+         * 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 job runner. Can be given as command line arguments for the
-         *   File Converter tool 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);
         }
         /**
-         * Runs a job to validate the active version of the file. This is alias to
+         * Runs an IFC validator job to validate the active version of the file. This is alias to
          * {@link createJob | createJob("validation")}.
          *
          * To get validation report use {@link downloadResource | downloadResource("validation_report.json")}.
          *
-         * @param parameters - Parameters for the job runner. Can be given as command line arguments for the
-         *   File Converter tool in form `--arg=value`.
+         * @param parameters - Parameters for the IFC validator tool. Can be given as command line arguments in
+         *   form `--arg=value`.
          */
         validate(parameters) {
             return this.createJob("validation", parameters);
@@ -2837,8 +2905,9 @@
          * Waits for jobs of the active version of the file to be done. Job is done when it changes to `none`,
          * `done` or `failed` status.
          *
-         * @param jobs - Job or job array to wait on. Can be `geometry`, `geometryGltf`, `properties`,
-         *   `validation`, `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` or custom job name.
+         * @param jobs - Job name or array of job names to wait on. Can be `geometry`, `geometryGltf`,
+         *   `properties`, `validation`, `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` or custom job
+         *   name.
          * @param waitAll - If this parameter is `true`, the function returns when all the specified jobs have
          *   done. If `false`, the function returns when any one of the jobs are done.
          * @param params - An object containing waiting parameters.
@@ -4562,7 +4631,7 @@
                 .then((data) => ({
                 ...data,
                 server: data.version,
-                client: "26.5.3",
+                client: "26.5.5",
             }));
         }
         /**
@@ -4971,13 +5040,17 @@
          *   generally retrieved from a {@link https://developer.mozilla.org/docs/Web/API/FileList | FileList}
          *   object returned as a result of a user selecting files using the HTML `<input>` element.
          * @param params - An object containing upload parameters.
-         * @param params.geometry - Create job to convert file geometry data. Can be:
+         * @param params.geometry - Run File Converter job to convert geometry data after uploading the file.
+         *   Can be:
          *
-         *   - `true` - Convert file geometry data to `VSFX` format to open the file in `VisualizeJS` viewer.
-         *   - `vsfx` - Convert file geometry data to `VSFX` format to open the file in `VisualizeJS` viewer.
-         *   - `gltf` - Convert file geometry data to `glTF` format to open the file in `Three.js` viewer.
+         *   - `true` - Convert file geometry data to `VSFX` format for opening in `VisualizeJS` 3D viewer.
+         *   - `vsfx` - Convert file geometry data to `VSFX` format for opening in `VisualizeJS` 3D viewer.
+         *   - `gltf` - Convert file geometry data to `glTF` format for opening in `Three.js` 3D viewer.
          *
-         * @param params.properties - Create job to extract file properties.
+         * @param params.properties - Run File Converter job to extract properties after uploading the file.
+         * @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.
          * @param params.timeout - The time, in milliseconds that the function should wait jobs. If no one jobs
          *   are done during this time, the `TimeoutError` exception will be thrown.
@@ -5002,11 +5075,12 @@
                 .then((xhr) => JSON.parse(xhr.responseText))
                 .then((data) => new File(data, this.httpClient));
             const geometryType = typeof params.geometry === "string" ? params.geometry : "vsfx";
+            const jobParameters = params.jobParameters || {};
             const jobs = [];
             if (params.geometry)
-                jobs.push((await result.extractGeometry(geometryType)).outputFormat);
+                jobs.push((await result.extractGeometry(geometryType, jobParameters.geometry)).outputFormat);
             if (params.properties)
-                jobs.push((await result.extractProperties()).outputFormat);
+                jobs.push((await result.extractProperties(jobParameters.properties)).outputFormat);
             if (jobs.length > 0)
                 if (params.waitForDone)
                     await result.waitForDone(jobs, true, params);
@@ -5105,18 +5179,17 @@
          * Runs a new job on the server for the sepecified file.
          *
          * @param fileId - File ID.
-         * @param outputFormat - The job type. Can be one of:
+         * @param outputFormat - The job type. Can be:
          *
-         *   - `geometry` - Convert file geometry data to `VSFX` format suitable for `VisualizeJS` viewer.
-         *   - `geometryGltf` - Convert file geometry data to `glTF` format suitable for `Three.js` viewer.
+         *   - `geometry` - Convert file geometry data to `VSFX` format for opening in `VisualizeJS` 3D viewer.
+         *   - `geometryGltf` - Convert file geometry data to `glTF` format for opening in `Three.js` 3D viewer.
          *   - `properties` - Extract file properties.
-         *   - `validation` - Validate the file. Only for `IFC` files.
-         *   - `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` - Export file to the one of the supported format.
-         *   - Other custom job name. Custom job runner must be registered in the job templates table before
-         *       creating a job.
+         *   - `validation` - Validate the IFC file.
+         *   - `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 job runner. Can be given as command line arguments for the
-         *   File Converter tool 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
@@ -5211,6 +5284,9 @@
          * @param files - List of file IDs.
          * @param name - Assembly name.
          * @param params - Additional assembly creating parameters.
+         * @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.
          * @param params.timeout - The time, in milliseconds, that the function should wait for the assembly to
          *   be created. If the assembly is not created within this time, a TimeoutError exception will be
@@ -5222,13 +5298,20 @@
          *   can be used to abort waiting as desired.
          * @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
          */
-        createAssembly(files, name, params) {
-            const { waitForDone } = params !== null && params !== undefined ? params : {};
+        createAssembly(files, name, params = {}) {
+            const jobParameters = params.jobParameters || {};
             return this.httpClient
-                .post("/assemblies", { name, files })
+                .post("/assemblies", {
+                name,
+                files,
+                jobParameters: {
+                    geometry: parseArgs(jobParameters.geometry),
+                    properties: parseArgs(jobParameters.properties),
+                },
+            })
                 .then((response) => response.json())
                 .then((data) => new Assembly(data, this.httpClient))
-                .then((result) => (waitForDone ? result.waitForDone(params) : result));
+                .then((result) => (params.waitForDone ? result.waitForDone(params) : result));
         }
         /**
          * Deletes the specified assembly from the server.
@@ -5447,7 +5530,7 @@
     // By use of this software, its documentation or related materials, you
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
-    const version = "26.5.3";
+    const version = "26.5.5";
 
     exports.Assembly = Assembly;
     exports.ClashTest = ClashTest;