@inweb/client 26.5.4 → 26.5.6

package/lib/Api/Assembly.d.ts

@@ -141,15 +141,29 @@ export declare class Assembly extends Endpoint {
      *
      * @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?: string | string[]): Promise<any[]>;
+    getProperties(handles?: string | string[], group?: boolean): Promise<any[]>;
     /**
      * Returns the list of original handles for an objects in the file that match the specified patterns.
      * Search patterns may be combined using query operators.

package/lib/Api/Client.d.ts

@@ -320,7 +320,7 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      *   - `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.
@@ -413,8 +413,8 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      *   - `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: string, outputFormat: string, parameters?: string | object): Promise<Job>;
     /**
@@ -467,7 +467,7 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * @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.

package/lib/Api/File.d.ts

@@ -221,15 +221,37 @@ export declare class File extends Endpoint {
      *
      * @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?: string | string[]): Promise<any[]>;
+    getProperties(handles?: string | string[], group?: boolean): Promise<any[]>;
     /**
      * Search pattern.
      *
@@ -410,8 +432,8 @@ export declare class File extends Endpoint {
      *       {@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: string, parameters?: string | object): Promise<Job>;
     /**
@@ -423,16 +445,16 @@ export declare class File extends Endpoint {
      *   - `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?: string, parameters?: string | object): Promise<Job>;
     /**
      * 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?: string | object): Promise<Job>;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "26.5.4",
+  "version": "26.5.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": "~26.5.4"
+    "@inweb/eventemitter2": "~26.5.6"
   }
 }

package/src/Api/Assembly.ts

@@ -279,7 +279,7 @@ export class Assembly extends Endpoint {
    *
    * @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.
    */
 
   /**
@@ -287,10 +287,34 @@ export class Assembly extends Endpoint {
    *
    * @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?: string | string[]): Promise<any[]> {
-    const relativePath = handles !== undefined ? `/properties?handles=${handles}` : "/properties";
-    return this.get(relativePath).then((response) => response.json());
+  getProperties(handles?: string | string[], group = false): Promise<any[]> {
+    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());
   }
 
   /**

package/src/Api/Client.ts

@@ -613,7 +613,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    *   - `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.
@@ -778,8 +778,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
    *   - `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: string, outputFormat: string, parameters?: string | object): Promise<Job> {
     return this.httpClient
@@ -885,7 +885,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @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.

package/src/Api/File.ts

@@ -397,7 +397,7 @@ export class File extends Endpoint {
    *
    * @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.
    */
 
   /**
@@ -405,10 +405,42 @@ export class File extends Endpoint {
    *
    * @param handles - Object original handle or handles array. Specify `undefined` to get properties for
    *   all objects in the file.
-   */
-  getProperties(handles?: string | string[]): Promise<any[]> {
-    const relativePath = handles !== undefined ? `/properties?handles=${handles}` : "/properties";
-    return this.get(relativePath).then((response) => response.json());
+   * @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?: string | string[], group = false): Promise<any[]> {
+    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());
   }
 
   /**
@@ -669,8 +701,8 @@ export class File extends Endpoint {
    *       {@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: string, parameters?: string | object): Promise<Job> {
     const jobs = new Endpoint("/jobs", this.httpClient, this.headers);
@@ -693,8 +725,8 @@ export class File extends Endpoint {
    *   - `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?: string, parameters?: string | object): Promise<Job> {
     return this.createJob(type === "gltf" ? "geometryGltf" : "geometry", parameters);
@@ -704,8 +736,8 @@ export class File extends Endpoint {
    * 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?: string | object): Promise<Job> {
     return this.createJob("properties", parameters);