@itwin/appui-react 4.0.0-dev.3 → 4.0.0-dev.6

package/lib/esm/appui-react/imodel-components/spatial-tree/SpatialBreakdown.GroupedByClass.json

@@ -0,0 +1,79 @@
+{
+  "$schema": "../../../../node_modules/@itwin/presentation-common/Ruleset.schema.json",
+  "id": "ui-framework/SpatialBreakdown.GroupedByClass",
+  "rules": [
+    {
+      "ruleType": "RootNodes",
+      "specifications": [
+        {
+          "specType": "InstanceNodesOfSpecificClasses",
+          "classes": [
+            {
+              "schemaName": "SpatialComposition",
+              "classNames": [
+                "CompositeElement"
+              ]
+            }
+          ],
+          "arePolymorphic": true,
+          "relatedInstances": [
+            {
+              "relationshipPath": {
+                "relationship": {
+                  "schemaName": "BisCore",
+                  "className": "ModelContainsElements"
+                },
+                "direction": "Backward"
+              },
+              "isRequired": true,
+              "alias": "model"
+            }
+          ],
+          "instanceFilter": "NOT model.IsPrivate AND this.ComposingElement = NULL",
+          "groupByClass": true,
+          "groupByLabel": false
+        }
+      ]
+    },
+    {
+      "ruleType": "ChildNodes",
+      "condition": "ParentNode.IsOfClass(\"CompositeElement\", \"SpatialComposition\")",
+      "specifications": [
+        {
+          "specType": "RelatedInstanceNodes",
+          "relationshipPaths": [
+            {
+              "relationship": {
+                "schemaName": "SpatialComposition",
+                "className": "CompositeComposesSubComposites"
+              },
+              "direction": "Forward"
+            }
+          ],
+          "groupByClass": true,
+          "groupByLabel": false
+        }
+      ]
+    },
+    {
+      "ruleType": "ChildNodes",
+      "condition": "ParentNode.IsOfClass(\"CompositeElement\", \"SpatialComposition\")",
+      "specifications": [
+        {
+          "specType": "RelatedInstanceNodes",
+          "relationshipPaths": [
+            {
+              "relationship": {
+                "schemaName": "SpatialComposition",
+                "className": "CompositeOverlapsSpatialElements"
+              },
+              "direction": "Forward"
+            }
+          ],
+          "groupByClass": true,
+          "groupByLabel": false
+        }
+      ]
+    }
+  ]
+}

package/lib/esm/appui-react/imodel-components/spatial-tree/SpatialBreakdown.json

@@ -0,0 +1,79 @@
+{
+  "$schema": "../../../../node_modules/@itwin/presentation-common/Ruleset.schema.json",
+  "id": "ui-framework/SpatialBreakdown",
+  "rules": [
+    {
+      "ruleType": "RootNodes",
+      "specifications": [
+        {
+          "specType": "InstanceNodesOfSpecificClasses",
+          "classes": [
+            {
+              "schemaName": "SpatialComposition",
+              "classNames": [
+                "CompositeElement"
+              ]
+            }
+          ],
+          "arePolymorphic": true,
+          "relatedInstances": [
+            {
+              "relationshipPath": {
+                "relationship": {
+                  "schemaName": "BisCore",
+                  "className": "ModelContainsElements"
+                },
+                "direction": "Backward"
+              },
+              "isRequired": true,
+              "alias": "model"
+            }
+          ],
+          "instanceFilter": "NOT model.IsPrivate AND this.ComposingElement = NULL",
+          "groupByClass": false,
+          "groupByLabel": false
+        }
+      ]
+    },
+    {
+      "ruleType": "ChildNodes",
+      "condition": "ParentNode.IsOfClass(\"CompositeElement\", \"SpatialComposition\")",
+      "specifications": [
+        {
+          "specType": "RelatedInstanceNodes",
+          "relationshipPaths": [
+            {
+              "relationship": {
+                "schemaName": "SpatialComposition",
+                "className": "CompositeComposesSubComposites"
+              },
+              "direction": "Forward"
+            }
+          ],
+          "groupByClass": false,
+          "groupByLabel": false
+        }
+      ]
+    },
+    {
+      "ruleType": "ChildNodes",
+      "condition": "ParentNode.IsOfClass(\"CompositeElement\", \"SpatialComposition\")",
+      "specifications": [
+        {
+          "specType": "RelatedInstanceNodes",
+          "relationshipPaths": [
+            {
+              "relationship": {
+                "schemaName": "SpatialComposition",
+                "className": "CompositeOverlapsSpatialElements"
+              },
+              "direction": "Forward"
+            }
+          ],
+          "groupByClass": false,
+          "groupByLabel": false
+        }
+      ]
+    }
+  ]
+}

package/lib/esm/appui-react/imodel-components/spatial-tree/SpatialContainmentTree.d.ts

@@ -0,0 +1,36 @@
+/** @packageDocumentation
+ * @module IModelComponents
+ */
+/// <reference types="react" />
+import "./SpatialContainmentTree.scss";
+import { IModelConnection } from "@itwin/core-frontend";
+import { Ruleset } from "@itwin/presentation-common";
+import { ClassGroupingOption } from "../Common";
+/** @internal */
+export declare const RULESET_SPATIAL_BREAKDOWN: Ruleset;
+/** @internal */
+export declare const RULESET_SPATIAL_BREAKDOWN_GROUPED_BY_CLASS: Ruleset;
+/**
+ * Properties for the [[SpatialContainmentTree]] component
+ * @public
+ * @deprecated in 3.6. Use 'SpatialContainmentTree' from `@itwin/breakdown-trees-react` package.
+ */
+export interface SpatialContainmentTreeProps {
+    iModel: IModelConnection;
+    /** Width of the component */
+    width: number;
+    /** Height of the component */
+    height: number;
+    /**
+     * Should the tree group displayed element nodes by class.
+     * @beta
+     */
+    enableElementsClassGrouping?: ClassGroupingOption;
+}
+/**
+ * Tree which displays and manages models or categories contained in an iModel.
+ * @public
+ * @deprecated in 3.6. Use 'SpatialContainmentTree' from `@itwin/breakdown-trees-react` package.
+ */
+export declare function SpatialContainmentTree(props: SpatialContainmentTreeProps): JSX.Element;
+//# sourceMappingURL=SpatialContainmentTree.d.ts.map

package/lib/esm/appui-react/imodel-components/spatial-tree/SpatialContainmentTree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpatialContainmentTree.d.ts","sourceRoot":"","sources":["../../../../../src/appui-react/imodel-components/spatial-tree/SpatialContainmentTree.tsx"],"names":[],"mappings":"AAIA;;GAEG;;AAIH,OAAO,+BAA+B,CAAC;AAEvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAIrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAIhD,gBAAgB;AAChB,eAAO,MAAM,yBAAyB,EAAE,OAA4C,CAAC;AACrF,gBAAgB;AAChB,eAAO,MAAM,0CAA0C,EAAE,OAA2D,CAAC;AAErH;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,gBAAgB,CAAC;IACzB,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,8BAA8B;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,2BAA2B,CAAC,EAAE,mBAAmB,CAAC;CACnD;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,2BAA2B,eA0BxE"}

package/lib/esm/appui-react/imodel-components/spatial-tree/SpatialContainmentTree.js

@@ -0,0 +1,40 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module IModelComponents
+ */
+/* eslint-disable deprecation/deprecation */
+import "./SpatialContainmentTree.scss";
+import * as React from "react";
+import { UnifiedSelectionTreeEventHandler, usePresentationTreeNodeLoader } from "@itwin/presentation-components";
+import { ControlledTree, SelectionMode, useTreeModel } from "@itwin/components-react";
+import { useDisposable } from "@itwin/core-react";
+import { ClassGroupingOption } from "../Common";
+const PAGING_SIZE = 20;
+/** @internal */
+export const RULESET_SPATIAL_BREAKDOWN = require("./SpatialBreakdown.json"); // eslint-disable-line @typescript-eslint/no-var-requires
+/** @internal */
+export const RULESET_SPATIAL_BREAKDOWN_GROUPED_BY_CLASS = require("./SpatialBreakdown.GroupedByClass.json"); // eslint-disable-line @typescript-eslint/no-var-requires
+/**
+ * Tree which displays and manages models or categories contained in an iModel.
+ * @public
+ * @deprecated in 3.6. Use 'SpatialContainmentTree' from `@itwin/breakdown-trees-react` package.
+ */
+export function SpatialContainmentTree(props) {
+    const { nodeLoader } = usePresentationTreeNodeLoader({
+        imodel: props.iModel,
+        ruleset: (!props.enableElementsClassGrouping) ? RULESET_SPATIAL_BREAKDOWN : /* istanbul ignore next */ RULESET_SPATIAL_BREAKDOWN_GROUPED_BY_CLASS,
+        appendChildrenCountForGroupingNodes: (props.enableElementsClassGrouping === ClassGroupingOption.YesWithCounts),
+        pagingSize: PAGING_SIZE,
+    });
+    const eventHandler = useDisposable(React.useCallback(() => new UnifiedSelectionTreeEventHandler({
+        nodeLoader,
+        collapsedChildrenDisposalEnabled: true,
+    }), [nodeLoader]));
+    const treeModel = useTreeModel(nodeLoader.modelSource);
+    return (React.createElement("div", { className: "ui-fw-spatial-tree" },
+        React.createElement(ControlledTree, { model: treeModel, nodeLoader: nodeLoader, eventsHandler: eventHandler, selectionMode: SelectionMode.Extended, width: props.width, height: props.height })));
+}
+//# sourceMappingURL=SpatialContainmentTree.js.map

package/lib/esm/appui-react/imodel-components/spatial-tree/SpatialContainmentTree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpatialContainmentTree.js","sourceRoot":"","sources":["../../../../../src/appui-react/imodel-components/spatial-tree/SpatialContainmentTree.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,4CAA4C;AAE5C,OAAO,+BAA+B,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,EAAE,gCAAgC,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AACjH,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACtF,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAEhD,MAAM,WAAW,GAAG,EAAE,CAAC;AAEvB,gBAAgB;AAChB,MAAM,CAAC,MAAM,yBAAyB,GAAY,OAAO,CAAC,yBAAyB,CAAC,CAAC,CAAC,yDAAyD;AAC/I,gBAAgB;AAChB,MAAM,CAAC,MAAM,0CAA0C,GAAY,OAAO,CAAC,wCAAwC,CAAC,CAAC,CAAC,yDAAyD;AAoB/K;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,KAAkC;IACvE,MAAM,EAAE,UAAU,EAAE,GAAG,6BAA6B,CAAC;QACnD,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,0BAA0B,CAAC,0CAA0C;QACjJ,mCAAmC,EAAE,CAAC,KAAK,CAAC,2BAA2B,KAAK,mBAAmB,CAAC,aAAa,CAAC;QAC9G,UAAU,EAAE,WAAW;KACxB,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,gCAAgC,CAAC;QAC9F,UAAU;QACV,gCAAgC,EAAE,IAAI;KACvC,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACnB,MAAM,SAAS,GAAG,YAAY,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IAEvD,OAAO,CACL,6BAAK,SAAS,EAAC,oBAAoB;QACjC,oBAAC,cAAc,IACb,KAAK,EAAE,SAAS,EAChB,UAAU,EAAE,UAAU,EACtB,aAAa,EAAE,YAAY,EAC3B,aAAa,EAAE,aAAa,CAAC,QAAQ,EACrC,KAAK,EAAE,KAAK,CAAC,KAAK,EAClB,MAAM,EAAE,KAAK,CAAC,MAAM,GACpB,CACE,CACP,CAAC;AACJ,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/** @packageDocumentation\r\n * @module IModelComponents\r\n */\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\nimport \"./SpatialContainmentTree.scss\";\r\nimport * as React from \"react\";\r\nimport { IModelConnection } from \"@itwin/core-frontend\";\r\nimport { Ruleset } from \"@itwin/presentation-common\";\r\nimport { UnifiedSelectionTreeEventHandler, usePresentationTreeNodeLoader } from \"@itwin/presentation-components\";\r\nimport { ControlledTree, SelectionMode, useTreeModel } from \"@itwin/components-react\";\r\nimport { useDisposable } from \"@itwin/core-react\";\r\nimport { ClassGroupingOption } from \"../Common\";\r\n\r\nconst PAGING_SIZE = 20;\r\n\r\n/** @internal */\r\nexport const RULESET_SPATIAL_BREAKDOWN: Ruleset = require(\"./SpatialBreakdown.json\"); // eslint-disable-line @typescript-eslint/no-var-requires\r\n/** @internal */\r\nexport const RULESET_SPATIAL_BREAKDOWN_GROUPED_BY_CLASS: Ruleset = require(\"./SpatialBreakdown.GroupedByClass.json\"); // eslint-disable-line @typescript-eslint/no-var-requires\r\n\r\n/**\r\n * Properties for the [[SpatialContainmentTree]] component\r\n * @public\r\n * @deprecated in 3.6. Use 'SpatialContainmentTree' from `@itwin/breakdown-trees-react` package.\r\n */\r\nexport interface SpatialContainmentTreeProps {\r\n  iModel: IModelConnection;\r\n  /** Width of the component */\r\n  width: number;\r\n  /** Height of the component */\r\n  height: number;\r\n  /**\r\n   * Should the tree group displayed element nodes by class.\r\n   * @beta\r\n   */\r\n  enableElementsClassGrouping?: ClassGroupingOption;\r\n}\r\n\r\n/**\r\n * Tree which displays and manages models or categories contained in an iModel.\r\n * @public\r\n * @deprecated in 3.6. Use 'SpatialContainmentTree' from `@itwin/breakdown-trees-react` package.\r\n */\r\nexport function SpatialContainmentTree(props: SpatialContainmentTreeProps) {\r\n  const { nodeLoader } = usePresentationTreeNodeLoader({\r\n    imodel: props.iModel,\r\n    ruleset: (!props.enableElementsClassGrouping) ? RULESET_SPATIAL_BREAKDOWN : /* istanbul ignore next */ RULESET_SPATIAL_BREAKDOWN_GROUPED_BY_CLASS,\r\n    appendChildrenCountForGroupingNodes: (props.enableElementsClassGrouping === ClassGroupingOption.YesWithCounts),\r\n    pagingSize: PAGING_SIZE,\r\n  });\r\n\r\n  const eventHandler = useDisposable(React.useCallback(() => new UnifiedSelectionTreeEventHandler({\r\n    nodeLoader,\r\n    collapsedChildrenDisposalEnabled: true,\r\n  }), [nodeLoader]));\r\n  const treeModel = useTreeModel(nodeLoader.modelSource);\r\n\r\n  return (\r\n    <div className=\"ui-fw-spatial-tree\">\r\n      <ControlledTree\r\n        model={treeModel}\r\n        nodeLoader={nodeLoader}\r\n        eventsHandler={eventHandler}\r\n        selectionMode={SelectionMode.Extended}\r\n        width={props.width}\r\n        height={props.height}\r\n      />\r\n    </div>\r\n  );\r\n}\r\n"]}

package/lib/esm/appui-react/imodel-components/spatial-tree/SpatialContainmentTree.scss

@@ -0,0 +1,9 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+@import "../VisibilityTreeBase";
+
+.ui-fw-spatial-tree {
+  @include ui-fw-visibility-tree-base;
+}

package/lib/esm/appui-react/keyinbrowser/KeyinBrowser.d.ts

@@ -0,0 +1,80 @@
+/** @packageDocumentation
+ * @module Item
+ */
+import "./KeyinBrowser.scss";
+import * as React from "react";
+import { AutoSuggestData, CommonProps } from "@itwin/core-react";
+/** Data for each key-in.
+ @deprecated in 3.0. */
+interface KeyinBrowserData extends AutoSuggestData {
+    /** English key-in - Browser supports both English and localized key-ins */
+    englishKeyin: string;
+}
+/** State of key-in browser.
+ @deprecated in 3.0. */
+interface KeyinBrowserState {
+    keyins: KeyinBrowserData[];
+    currentToolId: string | undefined;
+    currentArgs: string;
+}
+/** Arguments for [[KeyinBrowserProps]] onExecute callback.
+ * @beta @deprecated in 3.0.
+ */
+export interface KeyinBrowserExecuteArgs {
+    /** Id of the tool that was run */
+    toolId: string | undefined;
+    /** Arguments passed to the tool */
+    args: string[];
+    /** Status of the key-in run */
+    runStatus: boolean;
+}
+/** Properties of the [[KeyinBrowser]] component.
+ * @beta @deprecated in 3.0.
+ */
+export interface KeyinBrowserProps extends CommonProps {
+    /** Function called after the key-in is executed */
+    onExecute?: (args: KeyinBrowserExecuteArgs) => void;
+    /** Function called on Escape or popup close */
+    onCancel?: () => void;
+}
+/**
+ * Component used to allow users to select, provide arguments, and execute a key-in.
+ * @beta @deprecated in 3.0.
+ */
+export declare class KeyinBrowser extends React.PureComponent<KeyinBrowserProps, KeyinBrowserState> {
+    private _toolIdLabel;
+    private _argsLabel;
+    private _argsTip;
+    private _executeLabel;
+    private _suggestPlaceholder;
+    private _toolIdKey;
+    private _isMounted;
+    /** @internal */
+    constructor(props: any);
+    /** @internal */
+    componentDidMount(): void;
+    /** @internal */
+    componentWillUnmount(): void;
+    private getArgsKey;
+    private getSavedToolId;
+    private getToolArgs;
+    private getToolKeyinMap;
+    private getArgsArray;
+    private _onClick;
+    private _execute;
+    private _outputMessage;
+    private _onKeyinSelected;
+    private _onArgumentsChange;
+    private _onKeyDown;
+    private _onInputFocus;
+    private _onAutoSuggestEnter;
+    private _onAutoSuggestTab;
+    private _processInputValue;
+    private _onAutoSuggestEscape;
+    /** Calculate suggestions for any given input value. */
+    private _getSuggestions;
+    /** @internal */
+    render(): React.ReactNode;
+}
+export {};
+//# sourceMappingURL=KeyinBrowser.d.ts.map

package/lib/esm/appui-react/keyinbrowser/KeyinBrowser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyinBrowser.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/keyinbrowser/KeyinBrowser.tsx"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,qBAAqB,CAAC;AAE7B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAe,eAAe,EAAE,WAAW,EAAc,MAAM,mBAAmB,CAAC;AAK1F;uBACuB;AACvB,UAAU,gBAAiB,SAAQ,eAAe;IAIhD,2EAA2E;IAC3E,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;uBACuB;AACvB,UAAU,iBAAiB;IACzB,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAC3B,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,kCAAkC;IAClC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,mCAAmC;IACnC,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,+BAA+B;IAC/B,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,mDAAmD;IACnD,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,uBAAuB,KAAK,IAAI,CAAC;IACpD,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;CACvB;AAED;;;GAGG;AACH,qBAAa,YAAa,SAAQ,KAAK,CAAC,aAAa,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IACzF,OAAO,CAAC,YAAY,CAA+C;IACnE,OAAO,CAAC,UAAU,CAA8C;IAChE,OAAO,CAAC,QAAQ,CAAiD;IACjE,OAAO,CAAC,aAAa,CAAiD;IACtE,OAAO,CAAC,mBAAmB,CAAqD;IAChF,OAAO,CAAC,UAAU,CAAwB;IAC1C,OAAO,CAAC,UAAU,CAAS;IAE3B,gBAAgB;gBACJ,KAAK,EAAE,GAAG;IAYtB,gBAAgB;IACA,iBAAiB;IAcjC,gBAAgB;IACA,oBAAoB;IAIpC,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,eAAe;IAOvB,OAAO,CAAC,YAAY;IAQpB,OAAO,CAAC,QAAQ,CAEd;YAEY,QAAQ;IA+CtB,OAAO,CAAC,cAAc,CAGpB;IAGF,OAAO,CAAC,gBAAgB,CAMtB;IAEF,OAAO,CAAC,kBAAkB,CAIxB;IAEF,OAAO,CAAC,UAAU,CAahB;IAEF,OAAO,CAAC,aAAa,CAKnB;IAEF,OAAO,CAAC,mBAAmB,CAUzB;IAEF,OAAO,CAAC,iBAAiB,CAKvB;IAEF,OAAO,CAAC,kBAAkB;IA+B1B,OAAO,CAAC,oBAAoB,CAK1B;IAEF,uDAAuD;IACvD,OAAO,CAAC,eAAe,CAWrB;IAEF,gBAAgB;IACA,MAAM,IAAI,KAAK,CAAC,SAAS;CAiB1C"}

package/lib/esm/appui-react/keyinbrowser/KeyinBrowser.js

@@ -0,0 +1,235 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/* eslint-disable deprecation/deprecation */
+/** @packageDocumentation
+ * @module Item
+ */
+import "./KeyinBrowser.scss";
+// cSpell:ignore Modeless keyins keyinbrowser testid
+import * as React from "react";
+import { IModelApp, NotifyMessageDetails, OutputMessagePriority, OutputMessageType } from "@itwin/core-frontend";
+import { AutoSuggest, InputLabel } from "@itwin/core-react";
+import { Button, LabeledInput } from "@itwin/itwinui-react";
+import { UiFramework } from "../UiFramework";
+import { SpecialKey } from "@itwin/appui-abstract";
+/**
+ * Component used to allow users to select, provide arguments, and execute a key-in.
+ * @beta @deprecated in 3.0.
+ */
+export class KeyinBrowser extends React.PureComponent {
+    /** @internal */
+    constructor(props) {
+        super(props);
+        this._toolIdLabel = UiFramework.translate("keyinbrowser.keyin");
+        this._argsLabel = UiFramework.translate("keyinbrowser.args");
+        this._argsTip = UiFramework.translate("keyinbrowser.argsTip");
+        this._executeLabel = UiFramework.translate("keyinbrowser.execute");
+        this._suggestPlaceholder = UiFramework.translate("keyinbrowser.placeholder");
+        this._toolIdKey = "keyinbrowser:keyin";
+        this._isMounted = false;
+        this._onClick = async () => {
+            return this._execute();
+        };
+        this._outputMessage = (msg) => {
+            const details = new NotifyMessageDetails(OutputMessagePriority.Error, msg, undefined, OutputMessageType.Alert);
+            IModelApp.notifications.outputMessage(details);
+        };
+        // istanbul ignore next
+        this._onKeyinSelected = (selected) => {
+            const currentToolId = selected.value;
+            const currentArgs = this.getToolArgs(currentToolId);
+            // istanbul ignore else
+            if (this._isMounted)
+                this.setState({ currentToolId, currentArgs });
+        };
+        this._onArgumentsChange = (event) => {
+            // istanbul ignore else
+            if (this._isMounted)
+                this.setState({ currentArgs: event.target.value });
+        };
+        this._onKeyDown = async (event) => {
+            if (SpecialKey.Enter === event.key) {
+                event.stopPropagation();
+                return this._execute();
+            }
+            // istanbul ignore else
+            if (SpecialKey.Escape === event.key) {
+                // istanbul ignore else
+                if (this.props.onCancel)
+                    this.props.onCancel();
+                return;
+            }
+        };
+        this._onInputFocus = (event) => {
+            // istanbul ignore else
+            if (event.target) {
+                event.target.select();
+            }
+        };
+        this._onAutoSuggestEnter = (event) => {
+            event.stopPropagation();
+            const inputValue = event.target.value;
+            // istanbul ignore else
+            if (this._processInputValue(inputValue)) {
+                setTimeout(async () => {
+                    await this._execute();
+                });
+            }
+        };
+        this._onAutoSuggestTab = (event) => {
+            event.stopPropagation();
+            const inputValue = event.target.value;
+            this._processInputValue(inputValue);
+        };
+        this._onAutoSuggestEscape = (event) => {
+            event.stopPropagation();
+            // istanbul ignore else
+            if (this.props.onCancel)
+                this.props.onCancel();
+        };
+        /** Calculate suggestions for any given input value. */
+        this._getSuggestions = async (value) => {
+            const inputValue = value.trim().toLowerCase();
+            const inputLength = inputValue.length;
+            return Promise.resolve(inputLength === 0 ?
+                /* istanbul ignore next */ [] :
+                this.state.keyins.filter((data) => {
+                    return data.label.toLowerCase().includes(inputValue) || data.englishKeyin.toLowerCase().includes(inputValue);
+                }));
+        };
+        const currentToolId = this.getSavedToolId();
+        const currentArgs = this.getToolArgs(currentToolId);
+        this.state = {
+            keyins: [],
+            currentToolId,
+            currentArgs,
+        };
+    }
+    /** @internal */
+    componentDidMount() {
+        this._isMounted = true;
+        let keyins = this.getToolKeyinMap();
+        this.setState({ keyins });
+        setTimeout(() => {
+            keyins = keyins.sort((a, b) => a.label.localeCompare(b.label));
+            // istanbul ignore else
+            if (this._isMounted)
+                this.setState({ keyins });
+        });
+    }
+    /** @internal */
+    componentWillUnmount() {
+        this._isMounted = false;
+    }
+    getArgsKey(toolId) {
+        if (toolId && toolId.length > 0)
+            return `keyinbrowser:${toolId}`;
+        return undefined;
+    }
+    getSavedToolId() {
+        const toolId = window.localStorage.getItem(this._toolIdKey);
+        return toolId ? toolId : undefined;
+    }
+    getToolArgs(toolId) {
+        const argsKey = this.getArgsKey(toolId);
+        if (argsKey && argsKey.length > 0) {
+            const args = window.localStorage.getItem(argsKey);
+            // istanbul ignore if
+            if (args && /* istanbul ignore next */ args.length > 0 && /* istanbul ignore next */ args[0] === "[") {
+                return JSON.parse(args).join("|");
+            }
+        }
+        return "";
+    }
+    getToolKeyinMap() {
+        const keyins = [];
+        IModelApp.tools.getToolList()
+            .forEach((tool) => keyins.push({ value: tool.toolId, label: tool.keyin, englishKeyin: tool.englishKeyin }));
+        return keyins;
+    }
+    getArgsArray() {
+        // istanbul ignore else
+        if (this.state.currentArgs.length > 0) {
+            return this.state.currentArgs.split("|");
+        }
+        return [];
+    }
+    async _execute() {
+        let toolId;
+        let args = [];
+        let runStatus = false;
+        // istanbul ignore else
+        if (this.state.currentToolId && this.state.currentToolId.length > 0) {
+            const foundTool = IModelApp.tools.find(this.state.currentToolId);
+            // istanbul ignore else
+            if (foundTool) {
+                toolId = foundTool.toolId;
+                args = this.getArgsArray();
+                const maxArgs = foundTool.maxArgs;
+                if (args.length < foundTool.minArgs || (undefined !== maxArgs && args.length > maxArgs)) {
+                    this._outputMessage(UiFramework.translate("keyinbrowser.incorrectArgs"));
+                    return;
+                }
+                let key = "keyinbrowser:keyin";
+                window.localStorage.setItem(key, toolId);
+                // istanbul ignore if
+                if (args && args.length > 0) {
+                    key = `keyinbrowser:${toolId}`;
+                    const objectAsString = JSON.stringify(args);
+                    window.localStorage.setItem(key, objectAsString);
+                }
+                const tool = new foundTool();
+                runStatus = false;
+                try {
+                    runStatus = args.length > 0 ? /* istanbul ignore next */ await tool.parseAndRun(...args) : await tool.run();
+                    !runStatus && this._outputMessage(UiFramework.translate("keyinbrowser.failedToRun"));
+                }
+                catch (e) {
+                    // istanbul ignore next
+                    this._outputMessage(`${UiFramework.translate("keyinbrowser.exceptionOccurred")}: ${e}`);
+                }
+            }
+        }
+        // istanbul ignore else
+        if (this.props.onExecute)
+            this.props.onExecute({ toolId, args, runStatus });
+    }
+    _processInputValue(inputValue) {
+        let currentKeyin = "";
+        let foundTool;
+        if (this.state.currentToolId && this.state.currentToolId.length > 0) {
+            foundTool = IModelApp.tools.find(this.state.currentToolId);
+            // istanbul ignore else
+            if (foundTool)
+                currentKeyin = foundTool.keyin;
+        }
+        // istanbul ignore next
+        if (inputValue !== currentKeyin) {
+            const inputValueLower = inputValue.trim().toLowerCase();
+            foundTool = IModelApp.tools.getToolList()
+                .find((tool) => tool.keyin.toLowerCase() === inputValueLower || tool.englishKeyin.toLowerCase() === inputValueLower);
+            if (!foundTool) {
+                this._outputMessage(UiFramework.translate("keyinbrowser.couldNotFindTool"));
+                return false;
+            }
+            else {
+                const currentToolId = foundTool.toolId;
+                // istanbul ignore else
+                if (this._isMounted)
+                    this.setState({ currentToolId });
+            }
+        }
+        return true;
+    }
+    /** @internal */
+    render() {
+        return (React.createElement("div", { className: "uif-keyinbrowser-div" },
+            React.createElement(InputLabel, { label: this._toolIdLabel },
+                React.createElement(AutoSuggest, { value: this.state.currentToolId, style: { width: "250px" }, placeholder: this._suggestPlaceholder, options: this.state.keyins, onSuggestionSelected: this._onKeyinSelected, onPressEnter: this._onAutoSuggestEnter, onPressTab: this._onAutoSuggestTab, onPressEscape: this._onAutoSuggestEscape, onInputFocus: this._onInputFocus, getSuggestions: this._getSuggestions, "data-testid": "uif-keyin-autosuggest" })),
+            React.createElement(LabeledInput, { label: this._argsLabel, title: this._argsTip, value: this.state.currentArgs, "data-testid": "uif-keyin-arguments", id: "uif-keyin-arguments", onKeyDown: this._onKeyDown, onChange: this._onArgumentsChange, onFocus: this._onInputFocus, size: "small" }),
+            React.createElement(Button, { styleType: "cta", "data-testid": "uif-keyin-browser-execute", onClick: this._onClick }, this._executeLabel)));
+    }
+}
+//# sourceMappingURL=KeyinBrowser.js.map

package/lib/esm/appui-react/keyinbrowser/KeyinBrowser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyinBrowser.js","sourceRoot":"","sources":["../../../../src/appui-react/keyinbrowser/KeyinBrowser.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;AAEH,OAAO,qBAAqB,CAAC;AAC7B,oDAAoD;AACpD,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,iBAAiB,EAAQ,MAAM,sBAAsB,CAAC;AACvH,OAAO,EAAE,WAAW,EAAgC,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC1F,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AA0CnD;;;GAGG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK,CAAC,aAAmD;IASzF,gBAAgB;IAChB,YAAY,KAAU;QACpB,KAAK,CAAC,KAAK,CAAC,CAAC;QAVP,iBAAY,GAAG,WAAW,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;QAC3D,eAAU,GAAG,WAAW,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;QACxD,aAAQ,GAAG,WAAW,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;QACzD,kBAAa,GAAG,WAAW,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;QAC9D,wBAAmB,GAAG,WAAW,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;QACxE,eAAU,GAAG,oBAAoB,CAAC;QAClC,eAAU,GAAG,KAAK,CAAC;QAyEnB,aAAQ,GAAG,KAAK,IAAI,EAAE;YAC5B,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;QACzB,CAAC,CAAC;QAiDM,mBAAc,GAAG,CAAC,GAAW,EAAE,EAAE;YACvC,MAAM,OAAO,GAAG,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,CAAC,KAAK,CAAC,CAAC;YAC/G,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACjD,CAAC,CAAC;QAEF,uBAAuB;QACf,qBAAgB,GAAG,CAAC,QAAyB,EAAQ,EAAE;YAC7D,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC;YACrC,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;YACpD,uBAAuB;YACvB,IAAI,IAAI,CAAC,UAAU;gBACjB,IAAI,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC,CAAC;QAClD,CAAC,CAAC;QAEM,uBAAkB,GAAG,CAAC,KAA0C,EAAQ,EAAE;YAChF,uBAAuB;YACvB,IAAI,IAAI,CAAC,UAAU;gBACjB,IAAI,CAAC,QAAQ,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QACvD,CAAC,CAAC;QAEM,eAAU,GAAG,KAAK,EAAE,KAA4C,EAAiB,EAAE;YACzF,IAAI,UAAU,CAAC,KAAK,KAAK,KAAK,CAAC,GAAG,EAAE;gBAClC,KAAK,CAAC,eAAe,EAAE,CAAC;gBACxB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;aACxB;YAED,uBAAuB;YACvB,IAAI,UAAU,CAAC,MAAM,KAAK,KAAK,CAAC,GAAG,EAAE;gBACnC,uBAAuB;gBACvB,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ;oBACrB,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACxB,OAAO;aACR;QACH,CAAC,CAAC;QAEM,kBAAa,GAAG,CAAC,KAAyC,EAAQ,EAAE;YAC1E,uBAAuB;YACvB,IAAI,KAAK,CAAC,MAAM,EAAE;gBAChB,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;aACvB;QACH,CAAC,CAAC;QAEM,wBAAmB,GAAG,CAAC,KAA0B,EAAQ,EAAE;YACjE,KAAK,CAAC,eAAe,EAAE,CAAC;YAExB,MAAM,UAAU,GAAI,KAAK,CAAC,MAA2B,CAAC,KAAK,CAAC;YAC5D,uBAAuB;YACvB,IAAI,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;gBACvC,UAAU,CAAC,KAAK,IAAI,EAAE;oBACpB,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACxB,CAAC,CAAC,CAAC;aACJ;QACH,CAAC,CAAC;QAEM,sBAAiB,GAAG,CAAC,KAA0B,EAAQ,EAAE;YAC/D,KAAK,CAAC,eAAe,EAAE,CAAC;YAExB,MAAM,UAAU,GAAI,KAAK,CAAC,MAA2B,CAAC,KAAK,CAAC;YAC5D,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QACtC,CAAC,CAAC;QAiCM,yBAAoB,GAAG,CAAC,KAA0B,EAAQ,EAAE;YAClE,KAAK,CAAC,eAAe,EAAE,CAAC;YACxB,uBAAuB;YACvB,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ;gBACrB,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;QAC1B,CAAC,CAAC;QAEF,uDAAuD;QAC/C,oBAAe,GAAG,KAAK,EAAE,KAAa,EAA8B,EAAE;YAC5E,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YAC9C,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC;YAEtC,OAAO,OAAO,CAAC,OAAO,CACpB,WAAW,KAAK,CAAC,CAAC,CAAC;gBACjB,0BAA0B,CAAA,EAAE,CAAC,CAAC;gBAC9B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAsB,EAAE,EAAE;oBAClD,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBAC/G,CAAC,CAAC,CACL,CAAC;QACJ,CAAC,CAAC;QAtOA,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5C,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QAEpD,IAAI,CAAC,KAAK,GAAG;YACX,MAAM,EAAE,EAAE;YACV,aAAa;YACb,WAAW;SACZ,CAAC;IACJ,CAAC;IAED,gBAAgB;IACA,iBAAiB;QAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvB,IAAI,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACpC,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAE1B,UAAU,CAAC,GAAG,EAAE;YACd,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAkB,EAAE,CAAkB,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YACjG,uBAAuB;YACvB,IAAI,IAAI,CAAC,UAAU;gBACjB,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gBAAgB;IACA,oBAAoB;QAClC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;IAC1B,CAAC;IAEO,UAAU,CAAC,MAA0B;QAC3C,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YAC7B,OAAO,gBAAgB,MAAM,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,cAAc;QACpB,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5D,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IACrC,CAAC;IAEO,WAAW,CAAC,MAA0B;QAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAClD,qBAAqB;YACrB,IAAI,IAAI,IAAI,0BAA0B,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,0BAA0B,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;gBACpG,OAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,CAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACjD;SACF;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAEO,eAAe;QACrB,MAAM,MAAM,GAAuB,EAAE,CAAC;QACtC,SAAS,CAAC,KAAK,CAAC,WAAW,EAAE;aAC1B,OAAO,CAAC,CAAC,IAAiB,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;QAC3H,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,YAAY;QAClB,uBAAuB;QACvB,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;YACrC,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SAC1C;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAMO,KAAK,CAAC,QAAQ;QACpB,IAAI,MAA0B,CAAC;QAC/B,IAAI,IAAI,GAAa,EAAE,CAAC;QACxB,IAAI,SAAS,GAAG,KAAK,CAAC;QAEtB,uBAAuB;QACvB,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YACnE,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YACjE,uBAAuB;YACvB,IAAI,SAAS,EAAE;gBACb,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;gBAC1B,IAAI,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;gBAC3B,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC;gBAElC,IAAI,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,OAAO,IAAI,CAAC,SAAS,KAAK,OAAO,IAAI,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,EAAE;oBACvF,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC,CAAC;oBACzE,OAAO;iBACR;gBAED,IAAI,GAAG,GAAG,oBAAoB,CAAC;gBAC/B,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;gBAEzC,qBAAqB;gBACrB,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC3B,GAAG,GAAG,gBAAgB,MAAM,EAAE,CAAC;oBAC/B,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;oBAC5C,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;iBAClD;gBAED,MAAM,IAAI,GAAG,IAAI,SAAS,EAAE,CAAC;gBAC7B,SAAS,GAAG,KAAK,CAAC;gBAElB,IAAI;oBACF,SAAS,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;oBAC5G,CAAC,SAAS,IAAI,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC,CAAC;iBACtF;gBAAC,OAAO,CAAC,EAAE;oBACV,uBAAuB;oBACvB,IAAI,CAAC,cAAc,CAAC,GAAG,WAAW,CAAC,SAAS,CAAC,gCAAgC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;iBACzF;aACF;SACF;QAED,uBAAuB;QACvB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS;YACtB,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;IACtD,CAAC;IA+DO,kBAAkB,CAAC,UAAkB;QAC3C,IAAI,YAAY,GAAG,EAAE,CAAC;QACtB,IAAI,SAAkC,CAAC;QAEvC,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YACnE,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAC3D,uBAAuB;YACvB,IAAI,SAAS;gBACX,YAAY,GAAG,SAAS,CAAC,KAAK,CAAC;SAClC;QAED,uBAAuB;QACvB,IAAI,UAAU,KAAK,YAAY,EAAE;YAC/B,MAAM,eAAe,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YACxD,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,WAAW,EAAE;iBACtC,IAAI,CAAC,CAAC,IAAiB,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,eAAe,IAAI,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,KAAK,eAAe,CAAC,CAAC;YAEpI,IAAI,CAAC,SAAS,EAAE;gBACd,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,SAAS,CAAC,+BAA+B,CAAC,CAAC,CAAC;gBAC5E,OAAO,KAAK,CAAC;aACd;iBAAM;gBACL,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC;gBACvC,uBAAuB;gBACvB,IAAI,IAAI,CAAC,UAAU;oBACjB,IAAI,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC;aACpC;SACF;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAuBD,gBAAgB;IACA,MAAM;QACpB,OAAO,CACL,6BAAK,SAAS,EAAC,sBAAsB;YACnC,oBAAC,UAAU,IAAC,KAAK,EAAE,IAAI,CAAC,YAAY;gBAClC,oBAAC,WAAW,IAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EACrE,WAAW,EAAE,IAAI,CAAC,mBAAmB,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EACjE,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAAE,YAAY,EAAE,IAAI,CAAC,mBAAmB,EACnF,UAAU,EAAE,IAAI,CAAC,iBAAiB,EAAE,aAAa,EAAE,IAAI,CAAC,oBAAoB,EAAE,YAAY,EAAE,IAAI,CAAC,aAAa,EAC9G,cAAc,EAAE,IAAI,CAAC,eAAe,iBAAc,uBAAuB,GAAG,CACnE;YACb,oBAAC,YAAY,IAAC,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,iBAC3E,qBAAqB,EAAC,EAAE,EAAC,qBAAqB,EAC1D,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,IAAI,CAAC,kBAAkB,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,EAAC,OAAO,GAAG;YAC7G,oBAAC,MAAM,IAAC,SAAS,EAAC,KAAK,iBAAa,2BAA2B,EAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,IAAG,IAAI,CAAC,aAAa,CAAU,CACjH,CACP,CAAC;IACJ,CAAC;CACF","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/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module Item\r\n */\r\n\r\nimport \"./KeyinBrowser.scss\";\r\n// cSpell:ignore Modeless keyins keyinbrowser testid\r\nimport * as React from \"react\";\r\nimport { IModelApp, NotifyMessageDetails, OutputMessagePriority, OutputMessageType, Tool } from \"@itwin/core-frontend\";\r\nimport { AutoSuggest, AutoSuggestData, CommonProps, InputLabel } from \"@itwin/core-react\";\r\nimport { Button, LabeledInput } from \"@itwin/itwinui-react\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { SpecialKey } from \"@itwin/appui-abstract\";\r\n\r\n/** Data for each key-in.\r\n @deprecated in 3.0. */\r\ninterface KeyinBrowserData extends AutoSuggestData {\r\n  // AutoSuggestData.value is the toolId\r\n  // AutoSuggestData.label is the keyin\r\n\r\n  /** English key-in - Browser supports both English and localized key-ins */\r\n  englishKeyin: string;\r\n}\r\n\r\n/** State of key-in browser.\r\n @deprecated in 3.0. */\r\ninterface KeyinBrowserState {\r\n  keyins: KeyinBrowserData[];\r\n  currentToolId: string | undefined;\r\n  currentArgs: string;\r\n}\r\n\r\n/** Arguments for [[KeyinBrowserProps]] onExecute callback.\r\n * @beta @deprecated in 3.0.\r\n */\r\nexport interface KeyinBrowserExecuteArgs {\r\n  /** Id of the tool that was run */\r\n  toolId: string | undefined;\r\n  /** Arguments passed to the tool */\r\n  args: string[];\r\n  /** Status of the key-in run */\r\n  runStatus: boolean;\r\n}\r\n\r\n/** Properties of the [[KeyinBrowser]] component.\r\n * @beta @deprecated in 3.0.\r\n */\r\nexport interface KeyinBrowserProps extends CommonProps {\r\n  /** Function called after the key-in is executed */\r\n  onExecute?: (args: KeyinBrowserExecuteArgs) => void;\r\n  /** Function called on Escape or popup close */\r\n  onCancel?: () => void;\r\n}\r\n\r\n/**\r\n * Component used to allow users to select, provide arguments, and execute a key-in.\r\n * @beta @deprecated in 3.0.\r\n */\r\nexport class KeyinBrowser extends React.PureComponent<KeyinBrowserProps, KeyinBrowserState> {\r\n  private _toolIdLabel = UiFramework.translate(\"keyinbrowser.keyin\");\r\n  private _argsLabel = UiFramework.translate(\"keyinbrowser.args\");\r\n  private _argsTip = UiFramework.translate(\"keyinbrowser.argsTip\");\r\n  private _executeLabel = UiFramework.translate(\"keyinbrowser.execute\");\r\n  private _suggestPlaceholder = UiFramework.translate(\"keyinbrowser.placeholder\");\r\n  private _toolIdKey = \"keyinbrowser:keyin\";\r\n  private _isMounted = false;\r\n\r\n  /** @internal */\r\n  constructor(props: any) {\r\n    super(props);\r\n    const currentToolId = this.getSavedToolId();\r\n    const currentArgs = this.getToolArgs(currentToolId);\r\n\r\n    this.state = {\r\n      keyins: [],\r\n      currentToolId,\r\n      currentArgs,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  public override componentDidMount() {\r\n    this._isMounted = true;\r\n\r\n    let keyins = this.getToolKeyinMap();\r\n    this.setState({ keyins });\r\n\r\n    setTimeout(() => {\r\n      keyins = keyins.sort((a: AutoSuggestData, b: AutoSuggestData) => a.label.localeCompare(b.label));\r\n      // istanbul ignore else\r\n      if (this._isMounted)\r\n        this.setState({ keyins });\r\n    });\r\n  }\r\n\r\n  /** @internal */\r\n  public override componentWillUnmount() {\r\n    this._isMounted = false;\r\n  }\r\n\r\n  private getArgsKey(toolId: string | undefined): string | undefined {\r\n    if (toolId && toolId.length > 0)\r\n      return `keyinbrowser:${toolId}`;\r\n    return undefined;\r\n  }\r\n\r\n  private getSavedToolId(): string | undefined {\r\n    const toolId = window.localStorage.getItem(this._toolIdKey);\r\n    return toolId ? toolId : undefined;\r\n  }\r\n\r\n  private getToolArgs(toolId: string | undefined): string {\r\n    const argsKey = this.getArgsKey(toolId);\r\n    if (argsKey && argsKey.length > 0) {\r\n      const args = window.localStorage.getItem(argsKey);\r\n      // istanbul ignore if\r\n      if (args && /* istanbul ignore next */ args.length > 0 && /* istanbul ignore next */ args[0] === \"[\") {\r\n        return (JSON.parse(args) as string[]).join(\"|\");\r\n      }\r\n    }\r\n    return \"\";\r\n  }\r\n\r\n  private getToolKeyinMap(): KeyinBrowserData[] {\r\n    const keyins: KeyinBrowserData[] = [];\r\n    IModelApp.tools.getToolList()\r\n      .forEach((tool: typeof Tool) => keyins.push({ value: tool.toolId, label: tool.keyin, englishKeyin: tool.englishKeyin }));\r\n    return keyins;\r\n  }\r\n\r\n  private getArgsArray(): string[] {\r\n    // istanbul ignore else\r\n    if (this.state.currentArgs.length > 0) {\r\n      return this.state.currentArgs.split(\"|\");\r\n    }\r\n    return [];\r\n  }\r\n\r\n  private _onClick = async () => {\r\n    return this._execute();\r\n  };\r\n\r\n  private async _execute(): Promise<void> {\r\n    let toolId: string | undefined;\r\n    let args: string[] = [];\r\n    let runStatus = false;\r\n\r\n    // istanbul ignore else\r\n    if (this.state.currentToolId && this.state.currentToolId.length > 0) {\r\n      const foundTool = IModelApp.tools.find(this.state.currentToolId);\r\n      // istanbul ignore else\r\n      if (foundTool) {\r\n        toolId = foundTool.toolId;\r\n        args = this.getArgsArray();\r\n        const maxArgs = foundTool.maxArgs;\r\n\r\n        if (args.length < foundTool.minArgs || (undefined !== maxArgs && args.length > maxArgs)) {\r\n          this._outputMessage(UiFramework.translate(\"keyinbrowser.incorrectArgs\"));\r\n          return;\r\n        }\r\n\r\n        let key = \"keyinbrowser:keyin\";\r\n        window.localStorage.setItem(key, toolId);\r\n\r\n        // istanbul ignore if\r\n        if (args && args.length > 0) {\r\n          key = `keyinbrowser:${toolId}`;\r\n          const objectAsString = JSON.stringify(args);\r\n          window.localStorage.setItem(key, objectAsString);\r\n        }\r\n\r\n        const tool = new foundTool();\r\n        runStatus = false;\r\n\r\n        try {\r\n          runStatus = args.length > 0 ? /* istanbul ignore next */ await tool.parseAndRun(...args) : await tool.run();\r\n          !runStatus && this._outputMessage(UiFramework.translate(\"keyinbrowser.failedToRun\"));\r\n        } catch (e) {\r\n          // istanbul ignore next\r\n          this._outputMessage(`${UiFramework.translate(\"keyinbrowser.exceptionOccurred\")}: ${e}`);\r\n        }\r\n      }\r\n    }\r\n\r\n    // istanbul ignore else\r\n    if (this.props.onExecute)\r\n      this.props.onExecute({ toolId, args, runStatus });\r\n  }\r\n\r\n  private _outputMessage = (msg: string) => {\r\n    const details = new NotifyMessageDetails(OutputMessagePriority.Error, msg, undefined, OutputMessageType.Alert);\r\n    IModelApp.notifications.outputMessage(details);\r\n  };\r\n\r\n  // istanbul ignore next\r\n  private _onKeyinSelected = (selected: AutoSuggestData): void => {\r\n    const currentToolId = selected.value;\r\n    const currentArgs = this.getToolArgs(currentToolId);\r\n    // istanbul ignore else\r\n    if (this._isMounted)\r\n      this.setState({ currentToolId, currentArgs });\r\n  };\r\n\r\n  private _onArgumentsChange = (event: React.ChangeEvent<HTMLInputElement>): void => {\r\n    // istanbul ignore else\r\n    if (this._isMounted)\r\n      this.setState({ currentArgs: event.target.value });\r\n  };\r\n\r\n  private _onKeyDown = async (event: React.KeyboardEvent<HTMLInputElement>): Promise<void> => {\r\n    if (SpecialKey.Enter === event.key) {\r\n      event.stopPropagation();\r\n      return this._execute();\r\n    }\r\n\r\n    // istanbul ignore else\r\n    if (SpecialKey.Escape === event.key) {\r\n      // istanbul ignore else\r\n      if (this.props.onCancel)\r\n        this.props.onCancel();\r\n      return;\r\n    }\r\n  };\r\n\r\n  private _onInputFocus = (event: React.FocusEvent<HTMLInputElement>): void => {\r\n    // istanbul ignore else\r\n    if (event.target) {\r\n      event.target.select();\r\n    }\r\n  };\r\n\r\n  private _onAutoSuggestEnter = (event: React.KeyboardEvent): void => {\r\n    event.stopPropagation();\r\n\r\n    const inputValue = (event.target as HTMLInputElement).value;\r\n    // istanbul ignore else\r\n    if (this._processInputValue(inputValue)) {\r\n      setTimeout(async () => {\r\n        await this._execute();\r\n      });\r\n    }\r\n  };\r\n\r\n  private _onAutoSuggestTab = (event: React.KeyboardEvent): void => {\r\n    event.stopPropagation();\r\n\r\n    const inputValue = (event.target as HTMLInputElement).value;\r\n    this._processInputValue(inputValue);\r\n  };\r\n\r\n  private _processInputValue(inputValue: string): boolean {\r\n    let currentKeyin = \"\";\r\n    let foundTool: typeof Tool | undefined;\r\n\r\n    if (this.state.currentToolId && this.state.currentToolId.length > 0) {\r\n      foundTool = IModelApp.tools.find(this.state.currentToolId);\r\n      // istanbul ignore else\r\n      if (foundTool)\r\n        currentKeyin = foundTool.keyin;\r\n    }\r\n\r\n    // istanbul ignore next\r\n    if (inputValue !== currentKeyin) {\r\n      const inputValueLower = inputValue.trim().toLowerCase();\r\n      foundTool = IModelApp.tools.getToolList()\r\n        .find((tool: typeof Tool) => tool.keyin.toLowerCase() === inputValueLower || tool.englishKeyin.toLowerCase() === inputValueLower);\r\n\r\n      if (!foundTool) {\r\n        this._outputMessage(UiFramework.translate(\"keyinbrowser.couldNotFindTool\"));\r\n        return false;\r\n      } else {\r\n        const currentToolId = foundTool.toolId;\r\n        // istanbul ignore else\r\n        if (this._isMounted)\r\n          this.setState({ currentToolId });\r\n      }\r\n    }\r\n\r\n    return true;\r\n  }\r\n\r\n  private _onAutoSuggestEscape = (event: React.KeyboardEvent): void => {\r\n    event.stopPropagation();\r\n    // istanbul ignore else\r\n    if (this.props.onCancel)\r\n      this.props.onCancel();\r\n  };\r\n\r\n  /** Calculate suggestions for any given input value. */\r\n  private _getSuggestions = async (value: string): Promise<AutoSuggestData[]> => {\r\n    const inputValue = value.trim().toLowerCase();\r\n    const inputLength = inputValue.length;\r\n\r\n    return Promise.resolve(\r\n      inputLength === 0 ?\r\n        /* istanbul ignore next */[] :\r\n        this.state.keyins.filter((data: KeyinBrowserData) => {\r\n          return data.label.toLowerCase().includes(inputValue) || data.englishKeyin.toLowerCase().includes(inputValue);\r\n        })\r\n    );\r\n  };\r\n\r\n  /** @internal */\r\n  public override render(): React.ReactNode {\r\n    return (\r\n      <div className=\"uif-keyinbrowser-div\">\r\n        <InputLabel label={this._toolIdLabel}>\r\n          <AutoSuggest value={this.state.currentToolId} style={{ width: \"250px\" }}\r\n            placeholder={this._suggestPlaceholder} options={this.state.keyins}\r\n            onSuggestionSelected={this._onKeyinSelected} onPressEnter={this._onAutoSuggestEnter}\r\n            onPressTab={this._onAutoSuggestTab} onPressEscape={this._onAutoSuggestEscape} onInputFocus={this._onInputFocus}\r\n            getSuggestions={this._getSuggestions} data-testid=\"uif-keyin-autosuggest\" />\r\n        </InputLabel>\r\n        <LabeledInput label={this._argsLabel} title={this._argsTip} value={this.state.currentArgs}\r\n          data-testid=\"uif-keyin-arguments\" id=\"uif-keyin-arguments\"\r\n          onKeyDown={this._onKeyDown} onChange={this._onArgumentsChange} onFocus={this._onInputFocus} size=\"small\" />\r\n        <Button styleType=\"cta\" data-testid=\"uif-keyin-browser-execute\" onClick={this._onClick}>{this._executeLabel}</Button>\r\n      </div>\r\n    );\r\n  }\r\n}\r\n"]}

package/lib/esm/appui-react/keyinbrowser/KeyinBrowser.scss

@@ -0,0 +1,11 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+.uif-keyinbrowser-div {
+  display: grid;
+  align-items: center;
+  justify-content: center;
+  grid-template-columns: 100%;
+  padding: 6px;
+}