Automatically fetch changeset id if exists in the iModel for Cesium Sandcastle view (#80)

Author: wolfo951

docs/imodel/view/cesium-sandcastle.md

@@ -19,11 +19,14 @@ Setup iModel and get URL to view it in Cesium Sandcastle.
 ## Examples
 
 ```bash
-# Example 1: Get a link to a specific changeset of an iModel in Cesium Sandcastle
-itp imodel view cesium-sandcastle --imodel-id "5e19bee0-3aea-4355-a9f0-c6df9989ee7d" --changeset-id "2f3b4a8c92d747d5c8a8b2f9cde6742e5d74b3b5"
+# Example 1: Get a link to an iModel in Cesium Sandcastle
+itp imodel view cesium-sandcastle --imodel-id 5e19bee0-3aea-4355-a9f0-c6df9989ee7d
 
-# Example 2: Get a link to a specific changeset of an iModel in Cesium Sandcastle and open the URL in the browser
-itp imodel view cesium-sandcastle --imodel-id "5e19bee0-3aea-4355-a9f0-c6df9989ee7d" --changeset-id "2f3b4a8c92d747d5c8a8b2f9cde6742e5d74b3b5" --open
+# Example 2: Get a link to a specific changeset of an iModel in Cesium Sandcastle
+itp imodel view cesium-sandcastle --imodel-id 5e19bee0-3aea-4355-a9f0-c6df9989ee7d --changeset-id 2f3b4a8c92d747d5c8a8b2f9cde6742e5d74b3b5
+
+# Example 3: Get a link to a specific changeset of an iModel in Cesium Sandcastle and open the URL in the browser
+itp imodel view cesium-sandcastle --imodel-id 5e19bee0-3aea-4355-a9f0-c6df9989ee7d --changeset-id 2f3b4a8c92d747d5c8a8b2f9cde6742e5d74b3b5 --open
 ```
 
 ## API Reference

src/commands/imodel/changeset/list.ts

@@ -3,7 +3,7 @@
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 
-import { Changeset, ChangesetOrderByProperty, OrderBy, OrderByOperator } from "@itwin/imodels-client-management";
+import { Changeset, ChangesetOrderByProperty, OrderBy, OrderByOperator, take, toArray } from "@itwin/imodels-client-management";
 import { Flags } from "@oclif/core";
 
 import BaseCommand from "../../../extensions/base-command.js";
@@ -70,23 +70,22 @@ export default class ListChangesets extends BaseCommand {
         property: ChangesetOrderByProperty.Index
       } : undefined;
 
+      const urlParams = {
+        $orderBy: orderBy,
+        $skip: flags.skip,
+        $top: flags.top,
+        afterIndex: flags["after-index"],
+        lastIndex: flags["last-index"]
+      };
+
       const changesetList = client.changesets.getRepresentationList({
           authorization,
           iModelId: flags["imodel-id"],
-          urlParams: {
-              $orderBy: orderBy,
-              $skip: flags.skip,
-              $top: flags.top,
-              afterIndex: flags["after-index"],
-              lastIndex: flags["last-index"]
-          },
+          urlParams
       });
 
-      const result: Changeset[] = [];
-      for await (const changeset of changesetList) {
-        result.push(changeset);
-      }
-  
+      const result : Changeset[] = await (flags.top ? take(changesetList, flags.top) : toArray(changesetList));
+
       return this.logAndReturnResult(result);
     }
   }

src/commands/imodel/view/cesium-sandcastle.ts

@@ -3,6 +3,7 @@
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 
+import { Changeset } from "@itwin/imodels-client-management";
 import { Flags } from "@oclif/core";
 import open from 'open';
 import { deflate } from "pako";
@@ -15,19 +16,23 @@ export default class CesiumSandcastle extends BaseCommand {
 
     static examples = [
       {
-        command: `<%= config.bin %> <%= command.id %> --imodel-id "5e19bee0-3aea-4355-a9f0-c6df9989ee7d" --changeset-id "2f3b4a8c92d747d5c8a8b2f9cde6742e5d74b3b5"`,
-        description: 'Example 1: Get a link to a specific changeset of an iModel in Cesium Sandcastle'
+        command: `<%= config.bin %> <%= command.id %> --imodel-id 5e19bee0-3aea-4355-a9f0-c6df9989ee7d`,
+        description: 'Example 1: Get a link to an iModel in Cesium Sandcastle'
       },
       {
-        command: `<%= config.bin %> <%= command.id %> --imodel-id "5e19bee0-3aea-4355-a9f0-c6df9989ee7d" --changeset-id "2f3b4a8c92d747d5c8a8b2f9cde6742e5d74b3b5" --open`,
-        description: 'Example 2: Get a link to a specific changeset of an iModel in Cesium Sandcastle and open the URL in the browser'
+        command: `<%= config.bin %> <%= command.id %> --imodel-id 5e19bee0-3aea-4355-a9f0-c6df9989ee7d --changeset-id 2f3b4a8c92d747d5c8a8b2f9cde6742e5d74b3b5`,
+        description: 'Example 2: Get a link to a specific changeset of an iModel in Cesium Sandcastle'
+      },
+      {
+        command: `<%= config.bin %> <%= command.id %> --imodel-id 5e19bee0-3aea-4355-a9f0-c6df9989ee7d --changeset-id 2f3b4a8c92d747d5c8a8b2f9cde6742e5d74b3b5 --open`,
+        description: 'Example 3: Get a link to a specific changeset of an iModel in Cesium Sandcastle and open the URL in the browser'
       }
     ];
 
     static flags = {
       "changeset-id": Flags.string({
-        description: "Changeset id to be viewed in Cesium Sandcastle.",
-        required: true
+        description: "Changeset id to be viewed in Cesium Sandcastle. If not provided, the latest changeset will be used.",
+        required: false
       }),
       "imodel-id": Flags.string({ 
         char: "m", 
@@ -96,7 +101,17 @@ export default class CesiumSandcastle extends BaseCommand {
     async run() {
       const { flags } = await this.parse(CesiumSandcastle);
 
-      const exportInfo : ExportInfo = await this.getOrCreateExport(flags["imodel-id"], flags["changeset-id"]);      
+      let changesetId = flags["changeset-id"];
+      if (changesetId === undefined) {
+        const existingChangesets = await this.runCommand<Changeset[]>("imodel:changeset:list", ["-m", flags["imodel-id"], "--top", "1", "--order-by", "desc"]);
+        if (existingChangesets.length === 0) {
+          this.error(`No changesets found for iModel: ${flags["imodel-id"]}`);
+        }
+
+        changesetId = existingChangesets[0].id;
+      }
+
+      const exportInfo : ExportInfo = await this.getOrCreateExport(flags["imodel-id"], changesetId);      
 
       this.log(`Extracting tileset URL from export info`);
       const tilesetUrl : string = extractTileSetUrl(exportInfo);