@itwin/frontend-devtools 4.0.0-dev.8 → 4.0.0-dev.81

package/lib/esm/tools/SavedViews.js

@@ -1,129 +1,132 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Tools
- */
-import { BentleyError } from "@itwin/core-bentley";
-import { IModelApp, NotifyMessageDetails, OutputMessagePriority, Tool, } from "@itwin/core-frontend";
-import { copyStringToClipboard } from "../ClipboardUtilities";
-import { parseArgs } from "./parseArgs";
-/** Serialize a ViewState to JSON. The returned JSON can later be passed to [deserializeViewState] to reinstantiate the ViewState.
- * @beta
- */
-export function serializeViewState(view) {
-    return view.toProps();
-}
-/** Instantiate a ViewState serialized by [serializeViewState].
- * @beta
- */
-export async function deserializeViewState(props, iModel) {
-    const ctor = await iModel.findClassFor(props.viewDefinitionProps.classFullName, undefined);
-    if (undefined === ctor)
-        throw new Error("Class not found");
-    const view = ctor.createFromProps(props, iModel);
-    if (undefined === view)
-        throw new Error("Failed to construct ViewState");
-    await view.load();
-    return view;
-}
-/** Copies a JSON representation of the active viewport's view to the clipboard.
- *  * Arguments:
- *  * `quote`: format the JSON so it can be parsed directly by [ApplyViewTool].
- * @beta
- */
-export class SaveViewTool extends Tool {
-    constructor() {
-        super(...arguments);
-        this._quote = false;
-    }
-    static get minArgs() { return 0; }
-    static get maxArgs() { return 1; }
-    parse(inputArgs) {
-        const args = parseArgs(inputArgs);
-        function getArg(name) {
-            return args.getBoolean(name) ? true : undefined;
-        }
-        this._quote = true === getArg("q");
-        return true;
-    }
-    async parseAndRun(...args) {
-        if (this.parse(args))
-            return this.run();
-        else
-            return false;
-    }
-    async run() {
-        const vp = IModelApp.viewManager.selectedView;
-        if (undefined === vp) {
-            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, "No viewport"));
-            return true;
-        }
-        try {
-            let json = JSON.stringify(serializeViewState(vp.view));
-            if (this._quote)
-                json = `"${json.replace(/"/g, '""')}"`;
-            copyStringToClipboard(json);
-            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, "JSON copied to clipboard"));
-        }
-        catch (err) {
-            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, BentleyError.getErrorMessage(err) || "An unknown error occurred."));
-        }
-        return true;
-    }
-}
-SaveViewTool.toolId = "SaveView";
-/** Given a string containing a JSON representation of a ViewState, applies that ViewState to the active viewport.
- * The JSON string should be enclosed in double quotes and embedded double quote should be duplicated, example:
- * - "{""viewDefinitionProps"":{""classFullName"":""BisCore:SpatialViewDefinition"",""id"":""0x1a""}}"
- * @beta
- */
-export class ApplyViewTool extends Tool {
-    static get maxArgs() { return 1; }
-    static get minArgs() { return 1; }
-    async run(view) {
-        const vp = IModelApp.viewManager.selectedView;
-        if (undefined !== view && undefined !== vp)
-            vp.changeView(view);
-        return true;
-    }
-    async parseAndRun(...args) {
-        const vp = IModelApp.viewManager.selectedView;
-        if (undefined === vp || 0 === args.length)
-            return true;
-        try {
-            const json = JSON.parse(args[0]);
-            const view = await deserializeViewState(json, vp.iModel);
-            await this.run(view);
-        }
-        catch (err) {
-            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, BentleyError.getErrorMessage(err) || "An unknown error occurred."));
-        }
-        return true;
-    }
-}
-ApplyViewTool.toolId = "ApplyView";
-/** Given the Id of a persistent ViewDefinition, applies that view to the active viewport.
- * @beta
- */
-export class ApplyViewByIdTool extends Tool {
-    static get minArgs() { return 1; }
-    static get maxArgs() { return 1; }
-    async parseAndRun(...args) {
-        return this.run(args[0]);
-    }
-    async run(viewId) {
-        if (typeof viewId !== "string")
-            return false;
-        const vp = IModelApp.viewManager.selectedView;
-        if (!vp)
-            return false;
-        vp.iModel.views.load(viewId).then((view) => {
-            vp.changeView(view);
-        }).catch(() => { });
-        return true;
-    }
-}
-ApplyViewByIdTool.toolId = "ApplyViewById";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Tools
+ */
+import { BentleyError } from "@itwin/core-bentley";
+import { IModelApp, NotifyMessageDetails, OutputMessagePriority, Tool, } from "@itwin/core-frontend";
+import { copyStringToClipboard } from "../ClipboardUtilities";
+import { parseArgs } from "./parseArgs";
+/** Serialize a ViewState to JSON. The returned JSON can later be passed to [deserializeViewState] to reinstantiate the ViewState.
+ * @beta
+ */
+export function serializeViewState(view) {
+    return view.toProps();
+}
+/** Instantiate a ViewState serialized by [serializeViewState].
+ * @beta
+ */
+export async function deserializeViewState(props, iModel) {
+    const ctor = await iModel.findClassFor(props.viewDefinitionProps.classFullName, undefined);
+    if (undefined === ctor)
+        throw new Error("Class not found");
+    const view = ctor.createFromProps(props, iModel);
+    if (undefined === view)
+        throw new Error("Failed to construct ViewState");
+    await view.load();
+    return view;
+}
+/** Copies a JSON representation of the active viewport's view to the clipboard.
+ *  * Arguments:
+ *  * `quote`: format the JSON so it can be parsed directly by [ApplyViewTool].
+ * @beta
+ */
+class SaveViewTool extends Tool {
+    constructor() {
+        super(...arguments);
+        this._quote = false;
+    }
+    static get minArgs() { return 0; }
+    static get maxArgs() { return 1; }
+    parse(inputArgs) {
+        const args = parseArgs(inputArgs);
+        function getArg(name) {
+            return args.getBoolean(name) ? true : undefined;
+        }
+        this._quote = true === getArg("q");
+        return true;
+    }
+    async parseAndRun(...args) {
+        if (this.parse(args))
+            return this.run();
+        else
+            return false;
+    }
+    async run() {
+        const vp = IModelApp.viewManager.selectedView;
+        if (undefined === vp) {
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, "No viewport"));
+            return true;
+        }
+        try {
+            let json = JSON.stringify(serializeViewState(vp.view));
+            if (this._quote)
+                json = `"${json.replace(/"/g, '""')}"`;
+            copyStringToClipboard(json);
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, "JSON copied to clipboard"));
+        }
+        catch (err) {
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, BentleyError.getErrorMessage(err) || "An unknown error occurred."));
+        }
+        return true;
+    }
+}
+SaveViewTool.toolId = "SaveView";
+export { SaveViewTool };
+/** Given a string containing a JSON representation of a ViewState, applies that ViewState to the active viewport.
+ * The JSON string should be enclosed in double quotes and embedded double quote should be duplicated, example:
+ * - "{""viewDefinitionProps"":{""classFullName"":""BisCore:SpatialViewDefinition"",""id"":""0x1a""}}"
+ * @beta
+ */
+class ApplyViewTool extends Tool {
+    static get maxArgs() { return 1; }
+    static get minArgs() { return 1; }
+    async run(view) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (undefined !== view && undefined !== vp)
+            vp.changeView(view);
+        return true;
+    }
+    async parseAndRun(...args) {
+        const vp = IModelApp.viewManager.selectedView;
+        if (undefined === vp || 0 === args.length)
+            return true;
+        try {
+            const json = JSON.parse(args[0]);
+            const view = await deserializeViewState(json, vp.iModel);
+            await this.run(view);
+        }
+        catch (err) {
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, BentleyError.getErrorMessage(err) || "An unknown error occurred."));
+        }
+        return true;
+    }
+}
+ApplyViewTool.toolId = "ApplyView";
+export { ApplyViewTool };
+/** Given the Id of a persistent ViewDefinition, applies that view to the active viewport.
+ * @beta
+ */
+class ApplyViewByIdTool extends Tool {
+    static get minArgs() { return 1; }
+    static get maxArgs() { return 1; }
+    async parseAndRun(...args) {
+        return this.run(args[0]);
+    }
+    async run(viewId) {
+        if (typeof viewId !== "string")
+            return false;
+        const vp = IModelApp.viewManager.selectedView;
+        if (!vp)
+            return false;
+        vp.iModel.views.load(viewId).then((view) => {
+            vp.changeView(view);
+        }).catch(() => { });
+        return true;
+    }
+}
+ApplyViewByIdTool.toolId = "ApplyViewById";
+export { ApplyViewByIdTool };
 //# sourceMappingURL=SavedViews.js.map

package/lib/esm/tools/SavedViews.js.map

@@ -1 +1 @@
-{"version":3,"file":"SavedViews.js","sourceRoot":"","sources":["../../../src/tools/SavedViews.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EACQ,SAAS,EAAoB,oBAAoB,EAAE,qBAAqB,EAAE,IAAI,GAC5F,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAe;IAChD,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;AACxB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,KAAqB,EAAE,MAAwB;IACxF,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,YAAY,CAAqB,KAAK,CAAC,mBAAmB,CAAC,aAAa,EAAE,SAAS,CAAiC,CAAC;IAC/I,IAAI,SAAS,KAAK,IAAI;QACpB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAErC,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACjD,IAAI,SAAS,KAAK,IAAI;QACpB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAEnD,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;IAClB,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,YAAa,SAAQ,IAAI;IAAtC;;QACU,WAAM,GAAG,KAAK,CAAC;IA0CzB,CAAC;IAzCQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAG3C,KAAK,CAAC,SAAmB;QAC9B,MAAM,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;QAClC,SAAS,MAAM,CAAC,IAAY;YAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;QAClD,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,IAAI,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC;QAEnC,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YAClB,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;;YAElB,OAAO,KAAK,CAAC;IACjB,CAAC;IAEe,KAAK,CAAC,GAAG;QACvB,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE,EAAE;YACpB,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;YAC5G,OAAO,IAAI,CAAC;SACb;QAED,IAAI;YACF,IAAI,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;YACvD,IAAI,IAAI,CAAC,MAAM;gBACb,IAAI,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC;YACzC,qBAAqB,CAAC,IAAI,CAAC,CAAC;YAC5B,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAE,0BAA0B,CAAC,CAAC,CAAC;SACzH;QAAC,OAAO,GAAG,EAAE;YACZ,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,KAAK,EAAE,YAAY,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,4BAA4B,CAAC,CAAC,CAAC;SACjK;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AAtCsB,mBAAM,GAAG,UAAU,CAAC;AAyC7C;;;;GAIG;AACH,MAAM,OAAO,aAAc,SAAQ,IAAI;IAE9B,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,IAAgB;QACxC,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,EAAE;YACxC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAEtB,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM;YACvC,OAAO,IAAI,CAAC;QAEd,IAAI;YACF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAEjC,MAAM,IAAI,GAAG,MAAM,oBAAoB,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;YACzD,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;SACtB;QAAC,OAAO,GAAG,EAAE;YACZ,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAE,YAAY,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,4BAA4B,CAAC,CAAC,CAAC;SAChK;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AA3BsB,oBAAM,GAAG,WAAW,CAAC;AA8B9C;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,IAAI;IAElC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IAEe,KAAK,CAAC,GAAG,CAAC,MAAe;QACvC,IAAI,OAAO,MAAM,KAAK,QAAQ;YAC5B,OAAO,KAAK,CAAC;QAEf,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,CAAC,EAAE;YACL,OAAO,KAAK,CAAC;QAEf,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACzC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QAEpB,OAAO,IAAI,CAAC;IACd,CAAC;;AArBsB,wBAAM,GAAG,eAAe,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\n/** @packageDocumentation\r\n * @module Tools\r\n */\r\n\r\nimport { BentleyError } from \"@itwin/core-bentley\";\r\nimport { ViewStateProps } from \"@itwin/core-common\";\r\nimport {\r\n  EntityState, IModelApp, IModelConnection, NotifyMessageDetails, OutputMessagePriority, Tool, ViewState,\r\n} from \"@itwin/core-frontend\";\r\nimport { copyStringToClipboard } from \"../ClipboardUtilities\";\r\nimport { parseArgs } from \"./parseArgs\";\r\n\r\n/** Serialize a ViewState to JSON. The returned JSON can later be passed to [deserializeViewState] to reinstantiate the ViewState.\r\n * @beta\r\n */\r\nexport function serializeViewState(view: ViewState): ViewStateProps {\r\n  return view.toProps();\r\n}\r\n\r\n/** Instantiate a ViewState serialized by [serializeViewState].\r\n * @beta\r\n */\r\nexport async function deserializeViewState(props: ViewStateProps, iModel: IModelConnection): Promise<ViewState> {\r\n  const ctor = await iModel.findClassFor<typeof EntityState>(props.viewDefinitionProps.classFullName, undefined) as typeof ViewState | undefined;\r\n  if (undefined === ctor)\r\n    throw new Error(\"Class not found\");\r\n\r\n  const view = ctor.createFromProps(props, iModel);\r\n  if (undefined === view)\r\n    throw new Error(\"Failed to construct ViewState\");\r\n\r\n  await view.load();\r\n  return view;\r\n}\r\n\r\n/** Copies a JSON representation of the active viewport's view to the clipboard.\r\n *  * Arguments:\r\n *  * `quote`: format the JSON so it can be parsed directly by [ApplyViewTool].\r\n * @beta\r\n */\r\nexport class SaveViewTool extends Tool {\r\n  private _quote = false;\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n  public static override toolId = \"SaveView\";\r\n\r\n  public parse(inputArgs: string[]) {\r\n    const args = parseArgs(inputArgs);\r\n    function getArg(name: string): true | undefined {\r\n      return args.getBoolean(name) ? true : undefined;\r\n    }\r\n\r\n    this._quote = true === getArg(\"q\");\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    if (this.parse(args))\r\n      return this.run();\r\n    else\r\n      return false;\r\n  }\r\n\r\n  public override async run(): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined === vp) {\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, \"No viewport\"));\r\n      return true;\r\n    }\r\n\r\n    try {\r\n      let json = JSON.stringify(serializeViewState(vp.view));\r\n      if (this._quote)\r\n        json = `\"${json.replace(/\"/g, '\"\"')}\"`;\r\n      copyStringToClipboard(json);\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, \"JSON copied to clipboard\"));\r\n    } catch (err) {\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, BentleyError.getErrorMessage(err) || \"An unknown error occurred.\"));\r\n    }\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\n/** Given a string containing a JSON representation of a ViewState, applies that ViewState to the active viewport.\r\n * The JSON string should be enclosed in double quotes and embedded double quote should be duplicated, example:\r\n * - \"{\"\"viewDefinitionProps\"\":{\"\"classFullName\"\":\"\"BisCore:SpatialViewDefinition\"\",\"\"id\"\":\"\"0x1a\"\"}}\"\r\n * @beta\r\n */\r\nexport class ApplyViewTool extends Tool {\r\n  public static override toolId = \"ApplyView\";\r\n  public static override get maxArgs() { return 1; }\r\n  public static override get minArgs() { return 1; }\r\n\r\n  public override async run(view?: ViewState): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined !== view && undefined !== vp)\r\n      vp.changeView(view);\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined === vp || 0 === args.length)\r\n      return true;\r\n\r\n    try {\r\n      const json = JSON.parse(args[0]);\r\n\r\n      const view = await deserializeViewState(json, vp.iModel);\r\n      await this.run(view);\r\n    } catch (err) {\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, BentleyError.getErrorMessage(err) || \"An unknown error occurred.\"));\r\n    }\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\n/** Given the Id of a persistent ViewDefinition, applies that view to the active viewport.\r\n * @beta\r\n */\r\nexport class ApplyViewByIdTool extends Tool {\r\n  public static override toolId = \"ApplyViewById\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    return this.run(args[0]);\r\n  }\r\n\r\n  public override async run(viewId?: string): Promise<boolean> {\r\n    if (typeof viewId !== \"string\")\r\n      return false;\r\n\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (!vp)\r\n      return false;\r\n\r\n    vp.iModel.views.load(viewId).then((view) => {\r\n      vp.changeView(view);\r\n    }).catch(() => { });\r\n\r\n    return true;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SavedViews.js","sourceRoot":"","sources":["../../../src/tools/SavedViews.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,OAAO,EACQ,SAAS,EAAoB,oBAAoB,EAAE,qBAAqB,EAAE,IAAI,GAC5F,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAe;IAChD,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;AACxB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,KAAqB,EAAE,MAAwB;IACxF,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,YAAY,CAAqB,KAAK,CAAC,mBAAmB,CAAC,aAAa,EAAE,SAAS,CAAiC,CAAC;IAC/I,IAAI,SAAS,KAAK,IAAI;QACpB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAErC,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACjD,IAAI,SAAS,KAAK,IAAI;QACpB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAEnD,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;IAClB,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAa,YAAa,SAAQ,IAAI;IAAtC;;QACU,WAAM,GAAG,KAAK,CAAC;IA0CzB,CAAC;IAzCQ,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAG3C,KAAK,CAAC,SAAmB;QAC9B,MAAM,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;QAClC,SAAS,MAAM,CAAC,IAAY;YAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;QAClD,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,IAAI,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC;QAEnC,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YAClB,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;;YAElB,OAAO,KAAK,CAAC;IACjB,CAAC;IAEe,KAAK,CAAC,GAAG;QACvB,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE,EAAE;YACpB,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC;YAC5G,OAAO,IAAI,CAAC;SACb;QAED,IAAI;YACF,IAAI,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;YACvD,IAAI,IAAI,CAAC,MAAM;gBACb,IAAI,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC;YACzC,qBAAqB,CAAC,IAAI,CAAC,CAAC;YAC5B,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAE,0BAA0B,CAAC,CAAC,CAAC;SACzH;QAAC,OAAO,GAAG,EAAE;YACZ,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,KAAK,EAAE,YAAY,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,4BAA4B,CAAC,CAAC,CAAC;SACjK;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AAtCsB,mBAAM,GAAG,UAAU,AAAb,CAAc;SAJhC,YAAY;AA6CzB;;;;GAIG;AACH,MAAa,aAAc,SAAQ,IAAI;IAE9B,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,GAAG,CAAC,IAAgB;QACxC,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,EAAE;YACxC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAEtB,OAAO,IAAI,CAAC;IACd,CAAC;IAEe,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,SAAS,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM;YACvC,OAAO,IAAI,CAAC;QAEd,IAAI;YACF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAEjC,MAAM,IAAI,GAAG,MAAM,oBAAoB,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC;YACzD,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;SACtB;QAAC,OAAO,GAAG,EAAE;YACZ,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAE,YAAY,CAAC,eAAe,CAAC,GAAG,CAAC,IAAI,4BAA4B,CAAC,CAAC,CAAC;SAChK;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AA3BsB,oBAAM,GAAG,WAAW,CAAC;SADjC,aAAa;AA+B1B;;GAEG;AACH,MAAa,iBAAkB,SAAQ,IAAI;IAElC,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAC3C,MAAM,KAAc,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAElC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAc;QACjD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IAEe,KAAK,CAAC,GAAG,CAAC,MAAe;QACvC,IAAI,OAAO,MAAM,KAAK,QAAQ;YAC5B,OAAO,KAAK,CAAC;QAEf,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;QAC9C,IAAI,CAAC,EAAE;YACL,OAAO,KAAK,CAAC;QAEf,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YACzC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QAEpB,OAAO,IAAI,CAAC;IACd,CAAC;;AArBsB,wBAAM,GAAG,eAAe,CAAC;SADrC,iBAAiB","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\n/** @packageDocumentation\r\n * @module Tools\r\n */\r\n\r\nimport { BentleyError } from \"@itwin/core-bentley\";\r\nimport { ViewStateProps } from \"@itwin/core-common\";\r\nimport {\r\n  EntityState, IModelApp, IModelConnection, NotifyMessageDetails, OutputMessagePriority, Tool, ViewState,\r\n} from \"@itwin/core-frontend\";\r\nimport { copyStringToClipboard } from \"../ClipboardUtilities\";\r\nimport { parseArgs } from \"./parseArgs\";\r\n\r\n/** Serialize a ViewState to JSON. The returned JSON can later be passed to [deserializeViewState] to reinstantiate the ViewState.\r\n * @beta\r\n */\r\nexport function serializeViewState(view: ViewState): ViewStateProps {\r\n  return view.toProps();\r\n}\r\n\r\n/** Instantiate a ViewState serialized by [serializeViewState].\r\n * @beta\r\n */\r\nexport async function deserializeViewState(props: ViewStateProps, iModel: IModelConnection): Promise<ViewState> {\r\n  const ctor = await iModel.findClassFor<typeof EntityState>(props.viewDefinitionProps.classFullName, undefined) as typeof ViewState | undefined;\r\n  if (undefined === ctor)\r\n    throw new Error(\"Class not found\");\r\n\r\n  const view = ctor.createFromProps(props, iModel);\r\n  if (undefined === view)\r\n    throw new Error(\"Failed to construct ViewState\");\r\n\r\n  await view.load();\r\n  return view;\r\n}\r\n\r\n/** Copies a JSON representation of the active viewport's view to the clipboard.\r\n *  * Arguments:\r\n *  * `quote`: format the JSON so it can be parsed directly by [ApplyViewTool].\r\n * @beta\r\n */\r\nexport class SaveViewTool extends Tool {\r\n  private _quote = false;\r\n  public static override get minArgs() { return 0; }\r\n  public static override get maxArgs() { return 1; }\r\n  public static override toolId = \"SaveView\";\r\n\r\n  public parse(inputArgs: string[]) {\r\n    const args = parseArgs(inputArgs);\r\n    function getArg(name: string): true | undefined {\r\n      return args.getBoolean(name) ? true : undefined;\r\n    }\r\n\r\n    this._quote = true === getArg(\"q\");\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    if (this.parse(args))\r\n      return this.run();\r\n    else\r\n      return false;\r\n  }\r\n\r\n  public override async run(): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined === vp) {\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, \"No viewport\"));\r\n      return true;\r\n    }\r\n\r\n    try {\r\n      let json = JSON.stringify(serializeViewState(vp.view));\r\n      if (this._quote)\r\n        json = `\"${json.replace(/\"/g, '\"\"')}\"`;\r\n      copyStringToClipboard(json);\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, \"JSON copied to clipboard\"));\r\n    } catch (err) {\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, BentleyError.getErrorMessage(err) || \"An unknown error occurred.\"));\r\n    }\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\n/** Given a string containing a JSON representation of a ViewState, applies that ViewState to the active viewport.\r\n * The JSON string should be enclosed in double quotes and embedded double quote should be duplicated, example:\r\n * - \"{\"\"viewDefinitionProps\"\":{\"\"classFullName\"\":\"\"BisCore:SpatialViewDefinition\"\",\"\"id\"\":\"\"0x1a\"\"}}\"\r\n * @beta\r\n */\r\nexport class ApplyViewTool extends Tool {\r\n  public static override toolId = \"ApplyView\";\r\n  public static override get maxArgs() { return 1; }\r\n  public static override get minArgs() { return 1; }\r\n\r\n  public override async run(view?: ViewState): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined !== view && undefined !== vp)\r\n      vp.changeView(view);\r\n\r\n    return true;\r\n  }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (undefined === vp || 0 === args.length)\r\n      return true;\r\n\r\n    try {\r\n      const json = JSON.parse(args[0]);\r\n\r\n      const view = await deserializeViewState(json, vp.iModel);\r\n      await this.run(view);\r\n    } catch (err) {\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, BentleyError.getErrorMessage(err) || \"An unknown error occurred.\"));\r\n    }\r\n\r\n    return true;\r\n  }\r\n}\r\n\r\n/** Given the Id of a persistent ViewDefinition, applies that view to the active viewport.\r\n * @beta\r\n */\r\nexport class ApplyViewByIdTool extends Tool {\r\n  public static override toolId = \"ApplyViewById\";\r\n  public static override get minArgs() { return 1; }\r\n  public static override get maxArgs() { return 1; }\r\n\r\n  public override async parseAndRun(...args: string[]): Promise<boolean> {\r\n    return this.run(args[0]);\r\n  }\r\n\r\n  public override async run(viewId?: string): Promise<boolean> {\r\n    if (typeof viewId !== \"string\")\r\n      return false;\r\n\r\n    const vp = IModelApp.viewManager.selectedView;\r\n    if (!vp)\r\n      return false;\r\n\r\n    vp.iModel.views.load(viewId).then((view) => {\r\n      vp.changeView(view);\r\n    }).catch(() => { });\r\n\r\n    return true;\r\n  }\r\n}\r\n"]}

package/lib/esm/tools/ScheduleScriptTools.d.ts

@@ -1,38 +1,38 @@
-import { Viewport } from "@itwin/core-frontend";
-import { DisplayStyleTool } from "./DisplayStyleTools";
-/** Query the schedule script JSON from an element.
- * @beta
- */
-export declare class QueryScheduleScriptTool extends DisplayStyleTool {
-    private _sourceId?;
-    private _action;
-    private _includeElementIds;
-    private _countElementIds;
-    private _expandElementIds;
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    parse(input: string[], vp: Viewport): Promise<boolean>;
-    execute(vp: Viewport): Promise<boolean>;
-}
-/** A tool that modifies the [RenderSchedule.Script]($common), if any, associated with the selected [Viewport]($frontend) such that the entries in each
- * of its [RenderSchedule.ElementTimeline]($common)s are reversed.
- * @beta
- */
-export declare class ReverseScheduleScriptTool extends DisplayStyleTool {
-    static toolId: string;
-    execute(vp: Viewport): Promise<boolean>;
-    parse(): Promise<boolean>;
-}
-/** A tool that changes or removes the [RenderSchedule.Script]($common) associated with the selected [Viewport]($frontend).
- * @beta
- */
-export declare class SetScheduleScriptTool extends DisplayStyleTool {
-    static toolId: string;
-    static get minArgs(): number;
-    static get maxArgs(): number;
-    private _script?;
-    parse(args: string[]): Promise<boolean>;
-    execute(vp: Viewport): Promise<boolean>;
-}
+import { Viewport } from "@itwin/core-frontend";
+import { DisplayStyleTool } from "./DisplayStyleTools";
+/** Query the schedule script JSON from an element.
+ * @beta
+ */
+export declare class QueryScheduleScriptTool extends DisplayStyleTool {
+    private _sourceId?;
+    private _action;
+    private _includeElementIds;
+    private _countElementIds;
+    private _expandElementIds;
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    parse(input: string[], vp: Viewport): Promise<boolean>;
+    execute(vp: Viewport): Promise<boolean>;
+}
+/** A tool that modifies the [RenderSchedule.Script]($common), if any, associated with the selected [Viewport]($frontend) such that the entries in each
+ * of its [RenderSchedule.ElementTimeline]($common)s are reversed.
+ * @beta
+ */
+export declare class ReverseScheduleScriptTool extends DisplayStyleTool {
+    static toolId: string;
+    execute(vp: Viewport): Promise<boolean>;
+    parse(): Promise<boolean>;
+}
+/** A tool that changes or removes the [RenderSchedule.Script]($common) associated with the selected [Viewport]($frontend).
+ * @beta
+ */
+export declare class SetScheduleScriptTool extends DisplayStyleTool {
+    static toolId: string;
+    static get minArgs(): number;
+    static get maxArgs(): number;
+    private _script?;
+    parse(args: string[]): Promise<boolean>;
+    execute(vp: Viewport): Promise<boolean>;
+}
 //# sourceMappingURL=ScheduleScriptTools.d.ts.map