@inweb/client 26.5.2 → 26.5.4

package/lib/Api/Assembly.d.ts

@@ -48,7 +48,7 @@ export declare class Assembly extends Endpoint {
     /**
      * 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.
      */

package/lib/Api/Client.d.ts

@@ -312,13 +312,17 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      *   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 tool. 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.
@@ -332,6 +336,10 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
     uploadFile(file: globalThis.File, params?: {
         geometry?: boolean | string;
         properties?: boolean;
+        jobParameters?: {
+            geometry?: string | object;
+            properties?: string | object;
+        };
         waitForDone?: boolean;
         timeout?: number;
         interval?: number;
@@ -396,18 +404,17 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * 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 tool or custom job application. Can be given
+     *   as command line arguments in form `--arg=value`.
      */
     createJob(fileId: string, outputFormat: string, parameters?: string | object): Promise<Job>;
     /**
@@ -460,6 +467,9 @@ 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
+     *   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
@@ -472,6 +482,10 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
      */
     createAssembly(files: string[], name: string, params?: {
+        jobParameters?: {
+            geometry?: string | object;
+            properties?: string | object;
+        };
         waitForDone?: boolean;
         timeout?: number;
         interval?: number;

package/lib/Api/File.d.ts

@@ -48,7 +48,7 @@ export declare class File extends Endpoint {
     /**
      * 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()}.
      *
@@ -60,8 +60,8 @@ export declare class File extends Endpoint {
     /**
      * 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.
@@ -329,15 +329,15 @@ export declare class File extends Endpoint {
      * 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);
      * ```
      *
@@ -399,59 +399,59 @@ export declare class File extends Endpoint {
     /**
      * 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 tool or custom job application. Can be given
+     *   as command line arguments in form `--arg=value`.
      */
     createJob(outputFormat: string, parameters?: string | object): Promise<Job>;
     /**
-     * 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 tool. Can be given as command line arguments
+     *   in form `--arg=value`.
      */
     extractGeometry(type?: string, parameters?: string | object): Promise<Job>;
     /**
-     * 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 tool. Can be given as command line arguments
+     *   in form `--arg=value`.
      */
     extractProperties(parameters?: string | object): Promise<Job>;
     /**
-     * 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?: string | object): Promise<Job>;
     /**
      * 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.

package/lib/Api/Job.d.ts

@@ -64,14 +64,21 @@ export declare class Job extends Endpoint {
      */
     get lastUpdate(): string;
     /**
-     * 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
      */
     get outputFormat(): string;
     /**
-     * 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

package/package.json

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

package/src/Api/Assembly.ts

@@ -105,7 +105,7 @@ export class Assembly extends Endpoint {
   /**
    * 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.
    */

package/src/Api/Client.ts

@@ -605,13 +605,17 @@ export class Client extends EventEmitter2<ClientEventMap> {
    *   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 tool. 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.
@@ -627,6 +631,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
     params: {
       geometry?: boolean | string;
       properties?: boolean;
+      jobParameters?: {
+        geometry?: string | object;
+        properties?: string | object;
+      };
       waitForDone?: boolean;
       timeout?: number;
       interval?: number;
@@ -647,10 +655,11 @@ export class Client extends EventEmitter2<ClientEventMap> {
       .then((data) => new File(data, this.httpClient));
 
     const geometryType = typeof params.geometry === "string" ? params.geometry : "vsfx";
+    const jobParameters = params.jobParameters || {};
 
     const jobs: string[] = [];
-    if (params.geometry) jobs.push((await result.extractGeometry(geometryType)).outputFormat);
-    if (params.properties) jobs.push((await result.extractProperties()).outputFormat);
+    if (params.geometry) jobs.push((await result.extractGeometry(geometryType, jobParameters.geometry)).outputFormat);
+    if (params.properties) jobs.push((await result.extractProperties(jobParameters.properties)).outputFormat);
     if (jobs.length > 0)
       if (params.waitForDone) await result.waitForDone(jobs, true, params);
       else await result.checkout();
@@ -760,18 +769,17 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * 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 tool or custom job application. Can be given
+   *   as command line arguments in form `--arg=value`.
    */
   createJob(fileId: string, outputFormat: string, parameters?: string | object): Promise<Job> {
     return this.httpClient
@@ -877,6 +885,9 @@ 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
+   *   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
@@ -891,20 +902,31 @@ export class Client extends EventEmitter2<ClientEventMap> {
   createAssembly(
     files: string[],
     name: string,
-    params?: {
+    params: {
+      jobParameters?: {
+        geometry?: string | object;
+        properties?: string | object;
+      };
       waitForDone?: boolean;
       timeout?: number;
       interval?: number;
       signal?: AbortSignal;
       onCheckout?: (assembly: Assembly, ready: boolean) => boolean;
-    }
+    } = {}
   ): Promise<Assembly> {
-    const { waitForDone } = 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));
   }
 
   /**

package/src/Api/File.ts

@@ -123,7 +123,7 @@ export class File extends Endpoint {
   /**
    * 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()}.
    *
@@ -138,8 +138,8 @@ export class File extends Endpoint {
   /**
    * 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.
@@ -541,15 +541,15 @@ export class File extends Endpoint {
    * 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);
    * ```
    *
@@ -658,20 +658,19 @@ export class File extends Endpoint {
   /**
    * 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 tool or custom job application. 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);
@@ -686,40 +685,40 @@ export class File extends Endpoint {
   }
 
   /**
-   * 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 tool. 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);
   }
 
   /**
-   * 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 tool. Can be given as command line arguments
+   *   in form `--arg=value`.
    */
   extractProperties(parameters?: string | object): Promise<Job> {
     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?: string | object): Promise<Job> {
     return this.createJob("validation", parameters);
@@ -729,8 +728,9 @@ export class File extends Endpoint {
    * 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.

package/src/Api/Job.ts

@@ -121,8 +121,15 @@ export class Job extends Endpoint {
   }
 
   /**
-   * 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
    */
@@ -131,7 +138,7 @@ export class Job extends Endpoint {
   }
 
   /**
-   * 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