@itwin/appui-react 4.0.0-dev.8 → 4.0.0

package/lib/esm/appui-react/ui-items-provider/StandardStatusbarUiItemsProvider.js

@@ -1,80 +1,59 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module StandardUiItemsProvider
- */
-import * as React from "react";
-import { StatusBarSection } from "@itwin/appui-abstract";
-import { StatusBarItemUtilities } from "../statusbar/StatusBarItemUtilities";
-import { ToolAssistanceField } from "../statusfields/toolassistance/ToolAssistanceField";
-import { withStatusFieldProps } from "../statusbar/withStatusFieldProps";
-import { MessageCenterField } from "../statusfields/MessageCenter";
-import { withMessageCenterFieldProps } from "../statusbar/withMessageCenterFieldProps";
-import { ActivityCenterField } from "../statusfields/ActivityCenter";
-import { SnapModeField } from "../statusfields/SnapMode";
-import { SelectionInfoField } from "../statusfields/SelectionInfo";
-import { TileLoadingIndicator } from "../statusfields/tileloading/TileLoadingIndicator";
-import { SelectionScopeField } from "../statusfields/SelectionScope";
-import { StatusBarSeparator } from "../statusbar/Separator";
-/**
- * Provide standard statusbar fields for the SimpleStatusbarWidget
- * @beta
- */
-export class StandardStatusbarUiItemsProvider {
-    constructor(_defaultItems) {
-        this._defaultItems = _defaultItems;
-    }
-    get id() { return "appui-react:StandardStatusbarUiItemsProvider"; }
-    provideStatusBarItems(_stageId, _stageUsage, _stageAppData) {
-        var _a;
-        const statusBarItems = [];
-        // istanbul ignore else
-        if (!this._defaultItems || this._defaultItems.messageCenter) {
-            // eslint-disable-next-line deprecation/deprecation
-            const MessageCenter = withMessageCenterFieldProps(MessageCenterField);
-            statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.MessageCenter", StatusBarSection.Left, 10, React.createElement(MessageCenter, null)));
-        }
-        // istanbul ignore else
-        if (!this._defaultItems || this._defaultItems.toolAssistance) {
-            if (!this._defaultItems || this._defaultItems.preToolAssistanceSeparator)
-                statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.PreToolAssistance", StatusBarSection.Left, 15, React.createElement(StatusBarSeparator, null)));
-            // eslint-disable-next-line deprecation/deprecation
-            const ToolAssistance = withStatusFieldProps(ToolAssistanceField);
-            statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.ToolAssistance", StatusBarSection.Left, 20, React.createElement(ToolAssistance, null)));
-            if (!this._defaultItems || this._defaultItems.postToolAssistanceSeparator)
-                statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.PostToolAssistance", StatusBarSection.Left, 25, React.createElement(StatusBarSeparator, null)));
-        }
-        // istanbul ignore else
-        if ((_a = this._defaultItems) === null || _a === void 0 ? void 0 : _a.activityCenter) {
-            // eslint-disable-next-line deprecation/deprecation
-            const ActivityCenter = withStatusFieldProps(ActivityCenterField);
-            statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.ActivityCenter", StatusBarSection.Left, 30, React.createElement(ActivityCenter, null)));
-        }
-        // istanbul ignore else
-        if (!this._defaultItems || this._defaultItems.accuSnapModePicker) {
-            statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.SnapMode", StatusBarSection.Center, 10, React.createElement(SnapModeField, null)));
-        }
-        // istanbul ignore else
-        if (!this._defaultItems || this._defaultItems.tileLoadIndicator) {
-            // eslint-disable-next-line deprecation/deprecation
-            const TileLoadIndicator = withStatusFieldProps(TileLoadingIndicator);
-            statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.TileLoadIndicator", StatusBarSection.Right, 10, React.createElement(TileLoadIndicator, null)));
-        }
-        // istanbul ignore else
-        if (!this._defaultItems || this._defaultItems.selectionScope) {
-            // eslint-disable-next-line deprecation/deprecation
-            const SelectionScope = withStatusFieldProps(SelectionScopeField);
-            statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.SelectionScope", StatusBarSection.Right, 20, React.createElement(SelectionScope, null)));
-        }
-        // istanbul ignore else
-        if (!this._defaultItems || this._defaultItems.selectionInfo) {
-            // eslint-disable-next-line deprecation/deprecation
-            const SelectionInfo = withStatusFieldProps(SelectionInfoField);
-            statusBarItems.push(StatusBarItemUtilities.createStatusBarItem("uifw.SelectionInfo", StatusBarSection.Right, 30, React.createElement(SelectionInfo, null)));
-        }
-        return statusBarItems;
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module StandardUiItemsProvider
+ */
+import * as React from "react";
+import { StatusBarItemUtilities } from "../statusbar/StatusBarItemUtilities";
+import { ToolAssistanceField } from "../statusfields/toolassistance/ToolAssistanceField";
+import { MessageCenterField } from "../statusfields/MessageCenter";
+import { ActivityCenterField } from "../statusfields/ActivityCenter";
+import { SnapModeField } from "../statusfields/SnapMode";
+import { SelectionInfoField } from "../statusfields/SelectionInfo";
+import { TileLoadingIndicator } from "../statusfields/tileloading/TileLoadingIndicator";
+import { SelectionScopeField } from "../statusfields/SelectionScope";
+import { StatusBarSeparator } from "../statusbar/Separator";
+import { StatusBarSection } from "../statusbar/StatusBarItem";
+/**
+ * Provide standard statusbar fields for the SimpleStatusbarWidget
+ * @beta
+ */
+export class StandardStatusbarUiItemsProvider {
+    get id() { return "appui-react:StandardStatusbarUiItemsProvider"; }
+    constructor(_defaultItems) {
+        this._defaultItems = _defaultItems;
+    }
+    provideStatusBarItems(_stageId, _stageUsage, _stageAppData) {
+        var _a;
+        const statusBarItems = [];
+        if (!this._defaultItems || this._defaultItems.messageCenter) {
+            statusBarItems.push(StatusBarItemUtilities.createCustomItem("uifw.MessageCenter", StatusBarSection.Left, 10, React.createElement(MessageCenterField, null)));
+        }
+        if (!this._defaultItems || this._defaultItems.toolAssistance) {
+            if (!this._defaultItems || this._defaultItems.preToolAssistanceSeparator)
+                statusBarItems.push(StatusBarItemUtilities.createCustomItem("uifw.PreToolAssistance", StatusBarSection.Left, 15, React.createElement(StatusBarSeparator, null)));
+            statusBarItems.push(StatusBarItemUtilities.createCustomItem("uifw.ToolAssistance", StatusBarSection.Left, 20, React.createElement(ToolAssistanceField, null)));
+            if (!this._defaultItems || this._defaultItems.postToolAssistanceSeparator)
+                statusBarItems.push(StatusBarItemUtilities.createCustomItem("uifw.PostToolAssistance", StatusBarSection.Left, 25, React.createElement(StatusBarSeparator, null)));
+        }
+        if ((_a = this._defaultItems) === null || _a === void 0 ? void 0 : _a.activityCenter) {
+            statusBarItems.push(StatusBarItemUtilities.createCustomItem("uifw.ActivityCenter", StatusBarSection.Left, 30, React.createElement(ActivityCenterField, null)));
+        }
+        if (!this._defaultItems || this._defaultItems.accuSnapModePicker) {
+            statusBarItems.push(StatusBarItemUtilities.createCustomItem("uifw.SnapMode", StatusBarSection.Center, 10, React.createElement(SnapModeField, null)));
+        }
+        if (!this._defaultItems || this._defaultItems.tileLoadIndicator) {
+            statusBarItems.push(StatusBarItemUtilities.createCustomItem("uifw.TileLoadIndicator", StatusBarSection.Right, 10, React.createElement(TileLoadingIndicator, null)));
+        }
+        if (!this._defaultItems || this._defaultItems.selectionScope) {
+            statusBarItems.push(StatusBarItemUtilities.createCustomItem("uifw.SelectionScope", StatusBarSection.Right, 20, React.createElement(SelectionScopeField, null)));
+        }
+        if (!this._defaultItems || this._defaultItems.selectionInfo) {
+            statusBarItems.push(StatusBarItemUtilities.createCustomItem("uifw.SelectionInfo", StatusBarSection.Right, 30, React.createElement(SelectionInfoField, null)));
+        }
+        return statusBarItems;
+    }
+}
 //# sourceMappingURL=StandardStatusbarUiItemsProvider.js.map

package/lib/esm/appui-react/ui-items-provider/StandardStatusbarUiItemsProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"StandardStatusbarUiItemsProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/StandardStatusbarUiItemsProvider.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAuB,gBAAgB,EAAmB,MAAM,uBAAuB,CAAC;AAC/F,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,MAAM,oDAAoD,CAAC;AACzF,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AACvF,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kDAAkD,CAAC;AACxF,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAqB5D;;;GAGG;AACH,MAAM,OAAO,gCAAgC;IAG3C,YAAoB,aAAqC;QAArC,kBAAa,GAAb,aAAa,CAAwB;IAAI,CAAC;IAF9D,IAAW,EAAE,KAAa,OAAO,8CAA8C,CAAC,CAAC,CAAC;IAI3E,qBAAqB,CAAC,QAAgB,EAAE,WAAmB,EAAE,aAAmB;;QACrF,MAAM,cAAc,GAA0B,EAAE,CAAC;QACjD,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE;YAC3D,mDAAmD;YACnD,MAAM,aAAa,GAAG,2BAA2B,CAAC,kBAAkB,CAAC,CAAC;YACtE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,aAAa,OAAG,CAAC,CAAC,CAAC;SACrI;QACD,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;YAC5D,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,0BAA0B;gBACtE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,wBAAwB,EAAE,gBAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,kBAAkB,OAAG,CAAC,CAAC,CAAC;YAE/I,mDAAmD;YACnD,MAAM,cAAc,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;YACjE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,cAAc,OAAG,CAAC,CAAC,CAAC;YAEtI,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,2BAA2B;gBACvE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,kBAAkB,OAAG,CAAC,CAAC,CAAC;SACjJ;QACD,uBAAuB;QACvB,IAAI,MAAA,IAAI,CAAC,aAAa,0CAAE,cAAc,EAAE;YACtC,mDAAmD;YACnD,MAAM,cAAc,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;YACjE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,cAAc,OAAG,CAAC,CAAC,CAAC;SACvI;QACD,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE;YAChE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,eAAe,EAAE,gBAAgB,CAAC,MAAM,EAAE,EAAE,EAAE,oBAAC,aAAa,OAAG,CAAC,CAAC,CAAC;SAClI;QAED,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE;YAC/D,mDAAmD;YACnD,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;YACrE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,wBAAwB,EAAE,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,oBAAC,iBAAiB,OAAG,CAAC,CAAC,CAAC;SAC9I;QAED,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;YAC5D,mDAAmD;YACnD,MAAM,cAAc,GAAG,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;YACjE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,oBAAC,cAAc,OAAG,CAAC,CAAC,CAAC;SACxI;QAED,uBAAuB;QACvB,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE;YAC3D,mDAAmD;YACnD,MAAM,aAAa,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;YAC/D,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,oBAAC,aAAa,OAAG,CAAC,CAAC,CAAC;SACtI;QAED,OAAO,cAAc,CAAC;IACxB,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/** @packageDocumentation\r\n * @module StandardUiItemsProvider\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { CommonStatusBarItem, StatusBarSection, UiItemsProvider } from \"@itwin/appui-abstract\";\r\nimport { StatusBarItemUtilities } from \"../statusbar/StatusBarItemUtilities\";\r\nimport { ToolAssistanceField } from \"../statusfields/toolassistance/ToolAssistanceField\";\r\nimport { withStatusFieldProps } from \"../statusbar/withStatusFieldProps\";\r\nimport { MessageCenterField } from \"../statusfields/MessageCenter\";\r\nimport { withMessageCenterFieldProps } from \"../statusbar/withMessageCenterFieldProps\";\r\nimport { ActivityCenterField } from \"../statusfields/ActivityCenter\";\r\nimport { SnapModeField } from \"../statusfields/SnapMode\";\r\nimport { SelectionInfoField } from \"../statusfields/SelectionInfo\";\r\nimport { TileLoadingIndicator } from \"../statusfields/tileloading/TileLoadingIndicator\";\r\nimport { SelectionScopeField } from \"../statusfields/SelectionScope\";\r\nimport { StatusBarSeparator } from \"../statusbar/Separator\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/**\r\n * Defines what items to include from the provider. If any items are\r\n * specified then only those items will be added to statusbar.\r\n * @public\r\n */\r\nexport interface DefaultStatusbarItems {\r\n  messageCenter?: boolean;\r\n  preToolAssistanceSeparator?: boolean;\r\n  toolAssistance?: boolean;\r\n  postToolAssistanceSeparator?: boolean;\r\n  activityCenter?: boolean;\r\n  accuSnapModePicker?: boolean;\r\n  tileLoadIndicator?: boolean;\r\n  selectionScope?: boolean;\r\n  selectionInfo?: boolean;\r\n}\r\n\r\n/**\r\n * Provide standard statusbar fields for the SimpleStatusbarWidget\r\n * @beta\r\n */\r\nexport class StandardStatusbarUiItemsProvider implements UiItemsProvider {\r\n  public get id(): string { return \"appui-react:StandardStatusbarUiItemsProvider\"; }\r\n\r\n  constructor(private _defaultItems?: DefaultStatusbarItems) { }\r\n\r\n  public provideStatusBarItems(_stageId: string, _stageUsage: string, _stageAppData?: any): CommonStatusBarItem[] {\r\n    const statusBarItems: CommonStatusBarItem[] = [];\r\n    // istanbul ignore else\r\n    if (!this._defaultItems || this._defaultItems.messageCenter) {\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      const MessageCenter = withMessageCenterFieldProps(MessageCenterField);\r\n      statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.MessageCenter\", StatusBarSection.Left, 10, <MessageCenter />));\r\n    }\r\n    // istanbul ignore else\r\n    if (!this._defaultItems || this._defaultItems.toolAssistance) {\r\n      if (!this._defaultItems || this._defaultItems.preToolAssistanceSeparator)\r\n        statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.PreToolAssistance\", StatusBarSection.Left, 15, <StatusBarSeparator />));\r\n\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      const ToolAssistance = withStatusFieldProps(ToolAssistanceField);\r\n      statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.ToolAssistance\", StatusBarSection.Left, 20, <ToolAssistance />));\r\n\r\n      if (!this._defaultItems || this._defaultItems.postToolAssistanceSeparator)\r\n        statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.PostToolAssistance\", StatusBarSection.Left, 25, <StatusBarSeparator />));\r\n    }\r\n    // istanbul ignore else\r\n    if (this._defaultItems?.activityCenter) {\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      const ActivityCenter = withStatusFieldProps(ActivityCenterField);\r\n      statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.ActivityCenter\", StatusBarSection.Left, 30, <ActivityCenter />));\r\n    }\r\n    // istanbul ignore else\r\n    if (!this._defaultItems || this._defaultItems.accuSnapModePicker) {\r\n      statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.SnapMode\", StatusBarSection.Center, 10, <SnapModeField />));\r\n    }\r\n\r\n    // istanbul ignore else\r\n    if (!this._defaultItems || this._defaultItems.tileLoadIndicator) {\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      const TileLoadIndicator = withStatusFieldProps(TileLoadingIndicator);\r\n      statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.TileLoadIndicator\", StatusBarSection.Right, 10, <TileLoadIndicator />));\r\n    }\r\n\r\n    // istanbul ignore else\r\n    if (!this._defaultItems || this._defaultItems.selectionScope) {\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      const SelectionScope = withStatusFieldProps(SelectionScopeField);\r\n      statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.SelectionScope\", StatusBarSection.Right, 20, <SelectionScope />));\r\n    }\r\n\r\n    // istanbul ignore else\r\n    if (!this._defaultItems || this._defaultItems.selectionInfo) {\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      const SelectionInfo = withStatusFieldProps(SelectionInfoField);\r\n      statusBarItems.push(StatusBarItemUtilities.createStatusBarItem(\"uifw.SelectionInfo\", StatusBarSection.Right, 30, <SelectionInfo />));\r\n    }\r\n\r\n    return statusBarItems;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"StandardStatusbarUiItemsProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/StandardStatusbarUiItemsProvider.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,MAAM,oDAAoD,CAAC;AACzF,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kDAAkD,CAAC;AACxF,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAE5D,OAAO,EAAiB,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAoB7E;;;GAGG;AACH,MAAM,OAAO,gCAAgC;IAC3C,IAAW,EAAE,KAAa,OAAO,8CAA8C,CAAC,CAAC,CAAC;IAElF,YAAoB,aAAqC;QAArC,kBAAa,GAAb,aAAa,CAAwB;IAAI,CAAC;IAEvD,qBAAqB,CAAC,QAAgB,EAAE,WAAmB,EAAE,aAAmB;;QACrF,MAAM,cAAc,GAAoB,EAAE,CAAC;QAC3C,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE;YAC3D,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,kBAAkB,OAAG,CAAC,CAAC,CAAC;SACvI;QACD,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;YAC5D,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,0BAA0B;gBACtE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,wBAAwB,EAAE,gBAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,kBAAkB,OAAG,CAAC,CAAC,CAAC;YAE5I,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,mBAAmB,OAAG,CAAC,CAAC,CAAC;YAExI,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,2BAA2B;gBACvE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,kBAAkB,OAAG,CAAC,CAAC,CAAC;SAC9I;QACD,IAAI,MAAA,IAAI,CAAC,aAAa,0CAAE,cAAc,EAAE;YACtC,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,IAAI,EAAE,EAAE,EAAE,oBAAC,mBAAmB,OAAG,CAAC,CAAC,CAAC;SACzI;QACD,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE;YAChE,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,eAAe,EAAE,gBAAgB,CAAC,MAAM,EAAE,EAAE,EAAE,oBAAC,aAAa,OAAG,CAAC,CAAC,CAAC;SAC/H;QAED,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE;YAC/D,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,wBAAwB,EAAE,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,oBAAC,oBAAoB,OAAG,CAAC,CAAC,CAAC;SAC9I;QAED,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE;YAC5D,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,oBAAC,mBAAmB,OAAG,CAAC,CAAC,CAAC;SAC1I;QAED,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE;YAC3D,cAAc,CAAC,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,oBAAC,kBAAkB,OAAG,CAAC,CAAC,CAAC;SACxI;QAED,OAAO,cAAc,CAAC;IACxB,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/** @packageDocumentation\r\n * @module StandardUiItemsProvider\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { StatusBarItemUtilities } from \"../statusbar/StatusBarItemUtilities\";\r\nimport { ToolAssistanceField } from \"../statusfields/toolassistance/ToolAssistanceField\";\r\nimport { MessageCenterField } from \"../statusfields/MessageCenter\";\r\nimport { ActivityCenterField } from \"../statusfields/ActivityCenter\";\r\nimport { SnapModeField } from \"../statusfields/SnapMode\";\r\nimport { SelectionInfoField } from \"../statusfields/SelectionInfo\";\r\nimport { TileLoadingIndicator } from \"../statusfields/tileloading/TileLoadingIndicator\";\r\nimport { SelectionScopeField } from \"../statusfields/SelectionScope\";\r\nimport { StatusBarSeparator } from \"../statusbar/Separator\";\r\nimport { UiItemsProvider } from \"./UiItemsProvider\";\r\nimport { StatusBarItem, StatusBarSection } from \"../statusbar/StatusBarItem\";\r\n\r\n/**\r\n * Defines what items to include from the provider. If any items are\r\n * specified then only those items will be added to statusbar.\r\n * @public\r\n */\r\nexport interface DefaultStatusbarItems {\r\n  messageCenter?: boolean;\r\n  preToolAssistanceSeparator?: boolean;\r\n  toolAssistance?: boolean;\r\n  postToolAssistanceSeparator?: boolean;\r\n  /** Activity center field is hidden by default. */\r\n  activityCenter?: boolean;\r\n  accuSnapModePicker?: boolean;\r\n  tileLoadIndicator?: boolean;\r\n  selectionScope?: boolean;\r\n  selectionInfo?: boolean;\r\n}\r\n\r\n/**\r\n * Provide standard statusbar fields for the SimpleStatusbarWidget\r\n * @beta\r\n */\r\nexport class StandardStatusbarUiItemsProvider implements UiItemsProvider {\r\n  public get id(): string { return \"appui-react:StandardStatusbarUiItemsProvider\"; }\r\n\r\n  constructor(private _defaultItems?: DefaultStatusbarItems) { }\r\n\r\n  public provideStatusBarItems(_stageId: string, _stageUsage: string, _stageAppData?: any): StatusBarItem[] {\r\n    const statusBarItems: StatusBarItem[] = [];\r\n    if (!this._defaultItems || this._defaultItems.messageCenter) {\r\n      statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.MessageCenter\", StatusBarSection.Left, 10, <MessageCenterField />));\r\n    }\r\n    if (!this._defaultItems || this._defaultItems.toolAssistance) {\r\n      if (!this._defaultItems || this._defaultItems.preToolAssistanceSeparator)\r\n        statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.PreToolAssistance\", StatusBarSection.Left, 15, <StatusBarSeparator />));\r\n\r\n      statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.ToolAssistance\", StatusBarSection.Left, 20, <ToolAssistanceField />));\r\n\r\n      if (!this._defaultItems || this._defaultItems.postToolAssistanceSeparator)\r\n        statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.PostToolAssistance\", StatusBarSection.Left, 25, <StatusBarSeparator />));\r\n    }\r\n    if (this._defaultItems?.activityCenter) {\r\n      statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.ActivityCenter\", StatusBarSection.Left, 30, <ActivityCenterField />));\r\n    }\r\n    if (!this._defaultItems || this._defaultItems.accuSnapModePicker) {\r\n      statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.SnapMode\", StatusBarSection.Center, 10, <SnapModeField />));\r\n    }\r\n\r\n    if (!this._defaultItems || this._defaultItems.tileLoadIndicator) {\r\n      statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.TileLoadIndicator\", StatusBarSection.Right, 10, <TileLoadingIndicator />));\r\n    }\r\n\r\n    if (!this._defaultItems || this._defaultItems.selectionScope) {\r\n      statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.SelectionScope\", StatusBarSection.Right, 20, <SelectionScopeField />));\r\n    }\r\n\r\n    if (!this._defaultItems || this._defaultItems.selectionInfo) {\r\n      statusBarItems.push(StatusBarItemUtilities.createCustomItem(\"uifw.SelectionInfo\", StatusBarSection.Right, 30, <SelectionInfoField />));\r\n    }\r\n\r\n    return statusBarItems;\r\n  }\r\n}\r\n"]}

package/lib/esm/appui-react/ui-items-provider/UiItemsManager.d.ts

@@ -1,24 +1,94 @@
-/** @packageDocumentation
- * @module UiProvider
- */
-import { AllowedUiItemProviderOverrides as UIA_AllowedUiItemProviderOverrides, UiItemProviderOverrides as UIA_UiItemProviderOverrides, UiItemProviderRegisteredEventArgs as UIA_UiItemProviderRegisteredEventArgs, UiItemsManager as UIA_UiItemsManager } from "@itwin/appui-abstract";
-/** UiItemsProvider register event args.
- * @beta
- */
-export declare type UiItemsProviderRegisteredEventArgs = UIA_UiItemProviderRegisteredEventArgs;
-/** UiItemsProvider overrides allows the application that registers a provider to limit when it is allowed to provide items
- * @beta
- */
-export declare type AllowedUiItemsProviderOverrides = UIA_AllowedUiItemProviderOverrides;
-/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.
- * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's
- * items are allowed.
- * @beta
- */
-export declare type UiItemsProviderOverrides = UIA_UiItemProviderOverrides;
-/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
- * @beta
- */
-export declare class UiItemsManager extends UIA_UiItemsManager {
-}
+/** @packageDocumentation
+ * @module UiProvider
+ */
+import { BeUiEvent, MarkRequired } from "@itwin/core-bentley";
+import { BackstageItem } from "../backstage/BackstageItem";
+import { StagePanelLocation } from "../stagepanels/StagePanelLocation";
+import { StagePanelSection } from "../stagepanels/StagePanelSection";
+import { StatusBarItem } from "../statusbar/StatusBarItem";
+import { ToolbarItem, ToolbarOrientation, ToolbarUsage } from "../toolbar/ToolbarItem";
+import { Widget } from "../widgets/Widget";
+import { ProviderItem } from "./ProviderItem";
+import { UiItemsProvider } from "./UiItemsProvider";
+/** UiItemsProvider register event args.
+ * @public
+ */
+export interface UiItemsProviderRegisteredEventArgs {
+    providerId: string;
+}
+/** UiItemsProvider overrides allows the application that registers a provider to limit when it is allowed to provide items
+ * @public
+ */
+export interface AllowedUiItemsProviderOverrides {
+    /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages */
+    providerId?: string;
+    /** if specified then the current stage's Usage will be compared before allowing any items to be provided */
+    stageUsages?: string[];
+    /** if specified then the current stage's Id will be compared before allowing any items to be provided */
+    stageIds?: string[];
+}
+/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.
+ * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's
+ * items are allowed.
+ * @public
+ */
+export type UiItemsProviderOverrides = MarkRequired<AllowedUiItemsProviderOverrides, "providerId" | "stageUsages"> | MarkRequired<AllowedUiItemsProviderOverrides, "providerId" | "stageIds"> | MarkRequired<AllowedUiItemsProviderOverrides, "stageIds"> | MarkRequired<AllowedUiItemsProviderOverrides, "stageUsages"> | MarkRequired<AllowedUiItemsProviderOverrides, "providerId" | "stageUsages" | "stageIds">;
+/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
+ * @public
+ */
+export declare class UiItemsManager {
+    private static _registeredUiItemsProviders;
+    private static _onUiProviderRegisteredEvent;
+    private static _abstractAdapter;
+    /** For use in unit testing
+     * @internal */
+    static clearAllProviders(): void;
+    /** Event raised any time a UiProvider is registered or unregistered. */
+    static get onUiProviderRegisteredEvent(): BeUiEvent<UiItemsProviderRegisteredEventArgs>;
+    /** Return number of registered UiProvider. */
+    static get registeredProviderIds(): string[];
+    /** Return true if there is any registered UiProvider. */
+    static get hasRegisteredProviders(): boolean;
+    /**
+     * Retrieves a previously loaded UiItemsProvider.
+     * @param providerId id of the UiItemsProvider to get
+     */
+    static getUiItemsProvider(providerId: string): UiItemsProvider | undefined;
+    private static sendRegisteredEvent;
+    /**
+     * Registers a UiItemsProvider with the UiItemsManager.
+     * @param uiProvider the UI items provider to register.
+     */
+    static register(uiProvider: UiItemsProvider, overrides?: UiItemsProviderOverrides): void;
+    /** Remove a specific UiItemsProvider from the list of available providers. */
+    static unregister(providerId: string): void;
+    private static allowItemsFromProvider;
+    /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute
+     * an action or specify a registered ToolId into toolbar.
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @param usage usage of the toolbar
+     * @param orientation orientation of the toolbar
+     * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.
+     */
+    static getToolbarButtonItems(stageId: string, stageUsage: string, usage: ToolbarUsage, orientation: ToolbarOrientation): ReadonlyArray<ProviderItem<ToolbarItem>>;
+    /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.
+     */
+    static getStatusBarItems(stageId: string, stageUsage: string): ReadonlyArray<ProviderItem<StatusBarItem>>;
+    /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
+     * @returns An array of BackstageItem that will be used to create controls for the backstage menu.
+     */
+    static getBackstageItems(): ReadonlyArray<ProviderItem<BackstageItem>>;
+    /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @param location the location within the stage.
+     * @param section the section within location.
+     * @returns An array of widgets.
+     */
+    static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection): ReadonlyArray<ProviderItem<Widget>>;
+}
 //# sourceMappingURL=UiItemsManager.d.ts.map

package/lib/esm/appui-react/ui-items-provider/UiItemsManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UiItemsManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsManager.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EACL,8BAA8B,IAAI,kCAAkC,EACpE,uBAAuB,IAAI,2BAA2B,EACtD,iCAAiC,IAAI,qCAAqC,EAC1E,cAAc,IAAI,kBAAkB,EACrC,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,oBAAY,kCAAkC,GAAG,qCAAqC,CAAC;AAEvF;;GAEG;AACH,oBAAY,+BAA+B,GAAG,kCAAkC,CAAC;AAEjF;;;;GAIG;AACH,oBAAY,wBAAwB,GAAG,2BAA2B,CAAC;AAEnE;;GAEG;AACH,qBAAa,cAAe,SAAQ,kBAAkB;CACrD"}
+{"version":3,"file":"UiItemsManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAU,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEvF,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGpD;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,uJAAuJ;IACvJ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4GAA4G;IAC5G,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,yGAAyG;IACzG,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAClC,YAAY,CAAC,+BAA+B,EAAE,YAAY,GAAG,aAAa,CAAC,GAC3E,YAAY,CAAC,+BAA+B,EAAE,YAAY,GAAG,UAAU,CAAC,GACxE,YAAY,CAAC,+BAA+B,EAAE,UAAU,CAAC,GACzD,YAAY,CAAC,+BAA+B,EAAE,aAAa,CAAC,GAC5D,YAAY,CAAC,+BAA+B,EAAE,YAAY,GAAG,aAAa,GAAG,UAAU,CAAC,CAAC;AAQ3F;;GAEG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAA4E;IACtH,OAAO,CAAC,MAAM,CAAC,4BAA4B,CAAuD;IAClG,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAyC;IAExE;mBACe;WACD,iBAAiB;IAO/B,wEAAwE;IACxE,WAAkB,2BAA2B,IAAI,SAAS,CAAC,kCAAkC,CAAC,CAK7F;IAED,8CAA8C;IAC9C,WAAkB,qBAAqB,IAAI,MAAM,EAAE,CAMlD;IAED,yDAAyD;IACzD,WAAkB,sBAAsB,IAAI,OAAO,CAKlD;IAED;;;OAGG;WACW,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAOjF,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAIlC;;;OAGG;WACW,QAAQ,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,EAAE,wBAAwB,GAAG,IAAI;IAgB/F,8EAA8E;WAChE,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAiBlD,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAUrC;;;;;;;OAOG;WACW,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,kBAAkB,GAAG,aAAa,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IAuBxK;;;;OAIG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,aAAa,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAwBhH;;OAEG;WACW,iBAAiB,IAAI,aAAa,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAwB7E;;;;;;OAMG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;CAwB9J"}

package/lib/esm/appui-react/ui-items-provider/UiItemsManager.js

@@ -1,15 +1,202 @@
-/*---------------------------------------------------------------------------------------------
-* 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 UiProvider
- */
-import { UiItemsManager as UIA_UiItemsManager, } from "@itwin/appui-abstract";
-/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
- * @beta
- */
-export class UiItemsManager extends UIA_UiItemsManager {
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module UiProvider
+ */
+import { BeUiEvent, Logger } from "@itwin/core-bentley";
+import { UiFramework } from "../UiFramework";
+import { createAbstractUiItemsManagerAdapter } from "./AbstractUiItemsManager";
+/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
+ * @public
+ */
+class UiItemsManager {
+    /** For use in unit testing
+     * @internal */
+    static clearAllProviders() {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.clearAllProviders();
+        UiItemsManager._registeredUiItemsProviders.clear();
+    }
+    /** Event raised any time a UiProvider is registered or unregistered. */
+    static get onUiProviderRegisteredEvent() {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.onUiProviderRegisteredEvent;
+        return this._onUiProviderRegisteredEvent;
+    }
+    /** Return number of registered UiProvider. */
+    static get registeredProviderIds() {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.registeredProviderIds;
+        const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];
+        return ids;
+    }
+    /** Return true if there is any registered UiProvider. */
+    static get hasRegisteredProviders() {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.hasRegisteredProviders;
+        return this._registeredUiItemsProviders.size > 0;
+    }
+    /**
+     * Retrieves a previously loaded UiItemsProvider.
+     * @param providerId id of the UiItemsProvider to get
+     */
+    static getUiItemsProvider(providerId) {
+        var _a;
+        if (this._abstractAdapter)
+            return this._abstractAdapter.getUiItemsProvider(providerId);
+        return (_a = UiItemsManager._registeredUiItemsProviders.get(providerId)) === null || _a === void 0 ? void 0 : _a.provider;
+    }
+    static sendRegisteredEvent(args) {
+        UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(args);
+    }
+    /**
+     * Registers a UiItemsProvider with the UiItemsManager.
+     * @param uiProvider the UI items provider to register.
+     */
+    static register(uiProvider, overrides) {
+        var _a;
+        if (this._abstractAdapter)
+            return this._abstractAdapter.register(uiProvider, overrides);
+        const providerId = (_a = overrides === null || overrides === void 0 ? void 0 : overrides.providerId) !== null && _a !== void 0 ? _a : uiProvider.id;
+        if (UiItemsManager.getUiItemsProvider(providerId)) {
+            Logger.logInfo(UiFramework.loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);
+        }
+        else {
+            UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });
+            Logger.logInfo(UiFramework.loggerCategory(this), `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);
+            UiItemsManager.sendRegisteredEvent({ providerId });
+        }
+    }
+    /** Remove a specific UiItemsProvider from the list of available providers. */
+    static unregister(providerId) {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.unregister(providerId);
+        const provider = UiItemsManager.getUiItemsProvider(providerId);
+        if (!provider)
+            return;
+        provider.onUnregister && provider.onUnregister();
+        UiItemsManager._registeredUiItemsProviders.delete(providerId);
+        Logger.logInfo(UiFramework.loggerCategory(this), `UiItemsProvider (${providerId}) unloaded`);
+        // trigger a refresh of the ui
+        UiItemsManager.sendRegisteredEvent({ providerId });
+    }
+    static allowItemsFromProvider(entry, stageId, stageUsage) {
+        // istanbul ignore else
+        const overrides = entry.overrides;
+        if (undefined !== stageId && (overrides === null || overrides === void 0 ? void 0 : overrides.stageIds) && !(overrides.stageIds.some((value) => value === stageId)))
+            return false;
+        if (undefined !== stageUsage && (overrides === null || overrides === void 0 ? void 0 : overrides.stageUsages) && !(overrides.stageUsages.some((value) => value === stageUsage)))
+            return false;
+        return true;
+    }
+    /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute
+     * an action or specify a registered ToolId into toolbar.
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @param usage usage of the toolbar
+     * @param orientation orientation of the toolbar
+     * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.
+     */
+    static getToolbarButtonItems(stageId, stageUsage, usage, orientation) {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.getToolbarButtonItems(stageId, stageUsage, usage, orientation);
+        const buttonItems = [];
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            var _a, _b;
+            const uiProvider = entry.provider;
+            const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideToolbarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
+                uiProvider.provideToolbarItems(stageId, stageUsage, usage, orientation)
+                    .forEach((spec) => {
+                    // ignore duplicate ids
+                    if (-1 === buttonItems.findIndex((existingItem) => spec.id === existingItem.id))
+                        buttonItems.push({ ...spec, providerId });
+                });
+            }
+        });
+        return buttonItems;
+    }
+    /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.
+     */
+    static getStatusBarItems(stageId, stageUsage) {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.getStatusBarItems(stageId, stageUsage);
+        const statusBarItems = [];
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            var _a, _b;
+            const uiProvider = entry.provider;
+            const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
+                uiProvider.provideStatusBarItems(stageId, stageUsage)
+                    .forEach((item) => {
+                    // ignore duplicate ids
+                    if (-1 === statusBarItems.findIndex((existingItem) => item.id === existingItem.id))
+                        statusBarItems.push({ ...item, providerId });
+                });
+            }
+        });
+        return statusBarItems;
+    }
+    /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
+     * @returns An array of BackstageItem that will be used to create controls for the backstage menu.
+     */
+    static getBackstageItems() {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.getBackstageItems();
+        const backstageItems = [];
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            var _a, _b;
+            const uiProvider = entry.provider;
+            const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideBackstageItems) { // Note: We do not call this.allowItemsFromProvider here as backstage items
+                uiProvider.provideBackstageItems() //       should not be considered stage specific. If they need to be hidden
+                    .forEach((item) => {
+                    // ignore duplicate ids
+                    if (-1 === backstageItems.findIndex((existingItem) => item.id === existingItem.id))
+                        backstageItems.push({ ...item, providerId });
+                });
+            }
+        });
+        return backstageItems;
+    }
+    /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @param location the location within the stage.
+     * @param section the section within location.
+     * @returns An array of widgets.
+     */
+    static getWidgets(stageId, stageUsage, location, section) {
+        if (this._abstractAdapter)
+            return this._abstractAdapter.getWidgets(stageId, stageUsage, location, section);
+        const widgets = [];
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            var _a, _b;
+            const uiProvider = entry.provider;
+            const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
+                uiProvider.provideWidgets(stageId, stageUsage, location, section)
+                    .forEach((widget) => {
+                    // ignore duplicate ids
+                    if (-1 === widgets.findIndex((existingItem) => widget.id === existingItem.id))
+                        widgets.push({ ...widget, providerId });
+                });
+            }
+        });
+        return widgets;
+    }
+}
+UiItemsManager._registeredUiItemsProviders = new Map();
+UiItemsManager._onUiProviderRegisteredEvent = new BeUiEvent();
+UiItemsManager._abstractAdapter = createAbstractUiItemsManagerAdapter();
+export { UiItemsManager };
 //# sourceMappingURL=UiItemsManager.js.map

package/lib/esm/appui-react/ui-items-provider/UiItemsManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"UiItemsManager.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;AAEH,OAAO,EAIL,cAAc,IAAI,kBAAkB,GACrC,MAAM,uBAAuB,CAAC;AAmB/B;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,kBAAkB;CACrD","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 UiProvider\r\n */\r\n\r\nimport {\r\n  AllowedUiItemProviderOverrides as UIA_AllowedUiItemProviderOverrides,\r\n  UiItemProviderOverrides as UIA_UiItemProviderOverrides,\r\n  UiItemProviderRegisteredEventArgs as UIA_UiItemProviderRegisteredEventArgs,\r\n  UiItemsManager as UIA_UiItemsManager,\r\n} from \"@itwin/appui-abstract\";\r\n\r\n/** UiItemsProvider register event args.\r\n * @beta\r\n */\r\nexport type UiItemsProviderRegisteredEventArgs = UIA_UiItemProviderRegisteredEventArgs;\r\n\r\n/** UiItemsProvider overrides allows the application that registers a provider to limit when it is allowed to provide items\r\n * @beta\r\n */\r\nexport type AllowedUiItemsProviderOverrides = UIA_AllowedUiItemProviderOverrides;\r\n\r\n/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.\r\n * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's\r\n * items are allowed.\r\n * @beta\r\n */\r\nexport type UiItemsProviderOverrides = UIA_UiItemProviderOverrides;\r\n\r\n/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.\r\n * @beta\r\n */\r\nexport class UiItemsManager extends UIA_UiItemsManager {\r\n}\r\n"]}
+{"version":3,"file":"UiItemsManager.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,EAAgB,MAAM,qBAAqB,CAAC;AAMtE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAI7C,OAAO,EAAE,mCAAmC,EAAE,MAAM,0BAA0B,CAAC;AAuC/E;;GAEG;AACH,MAAa,cAAc;IAKzB;mBACe;IACR,MAAM,CAAC,iBAAiB;QAC7B,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC;QAEnD,cAAc,CAAC,2BAA2B,CAAC,KAAK,EAAE,CAAC;IACrD,CAAC;IAED,wEAAwE;IACjE,MAAM,KAAK,2BAA2B;QAC3C,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,2BAA2B,CAAC;QAE3D,OAAO,IAAI,CAAC,4BAA4B,CAAC;IAC3C,CAAC;IAED,8CAA8C;IACvC,MAAM,KAAK,qBAAqB;QACrC,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CAAC;QAErD,MAAM,GAAG,GAAG,CAAC,GAAG,cAAc,CAAC,2BAA2B,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,yDAAyD;IAClD,MAAM,KAAK,sBAAsB;QACtC,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,sBAAsB,CAAC;QAEtD,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAkB;;QACjD,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAE9D,OAAO,MAAA,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,0CAAE,QAAQ,CAAC;IAC9E,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,IAAwC;QACzE,cAAc,CAAC,2BAA2B,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,UAA2B,EAAE,SAAoC;;QACtF,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QAE/D,MAAM,UAAU,GAAG,MAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,UAAU,mCAAI,UAAU,CAAC,EAAE,CAAC;QAE1D,IAAI,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;YACjD,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oBAAoB,UAAU,qBAAqB,CAAC,CAAC;SACvG;aAAM;YACL,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;YAChG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,mBAAmB,UAAU,CAAC,EAAE,kBAAkB,UAAU,GAAG,CAAC,CAAC;YAElH,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;SACpD;IACH,CAAC;IAED,8EAA8E;IACvE,MAAM,CAAC,UAAU,CAAC,UAAkB;QACzC,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAEtD,MAAM,QAAQ,GAAG,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,QAAQ;YACX,OAAO;QAET,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;QAEjD,cAAc,CAAC,2BAA2B,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC9D,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oBAAoB,UAAU,YAAY,CAAC,CAAC;QAE7F,8BAA8B;QAC9B,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IACrD,CAAC;IAEO,MAAM,CAAC,sBAAsB,CAAC,KAA0B,EAAE,OAAgB,EAAE,UAAmB;QACrG,uBAAuB;QACvB,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,SAAS,KAAK,OAAO,KAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ,CAAA,IAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC;YAClH,OAAO,KAAK,CAAC;QACf,IAAI,SAAS,KAAK,UAAU,KAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,WAAW,CAAA,IAAI,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC;YAC9H,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB,CAAC,OAAe,EAAE,UAAkB,EAAE,KAAmB,EAAE,WAA+B;QAC3H,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC;QAE9F,MAAM,WAAW,GAAgC,EAAE,CAAC;QAEpD,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,UAAU,mCAAI,UAAU,CAAC,EAAE,CAAC;YAChE,uBAAuB;YACvB,IAAI,UAAU,CAAC,mBAAmB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBAC7F,UAAU,CAAC,mBAAmB,CAAC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,CAAC;qBACpE,OAAO,CAAC,CAAC,IAAiB,EAAE,EAAE;oBAC7B,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAC7E,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC9C,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,UAAkB;QACjE,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QAEtE,MAAM,cAAc,GAAkC,EAAE,CAAC;QAEzD,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,UAAU,mCAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBAC/F,UAAU,CAAC,qBAAqB,CAAC,OAAO,EAAE,UAAU,CAAC;qBAClD,OAAO,CAAC,CAAC,IAAmB,EAAE,EAAE;oBAC/B,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAChF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB;QAC7B,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC;QAEnD,MAAM,cAAc,GAAkC,EAAE,CAAC;QAEzD,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,UAAU,mCAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,EAAE,EAAE,2EAA2E;gBACjH,UAAU,CAAC,qBAAqB,EAAE,CAAI,2EAA2E;qBAC9G,OAAO,CAAC,CAAC,IAAmB,EAAE,EAAE;oBAC/B,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAChF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CAAC,OAAe,EAAE,UAAkB,EAAE,QAA4B,EAAE,OAA2B;QACrH,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAElF,MAAM,OAAO,GAA2B,EAAE,CAAC;QAE3C,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;;YAC3D,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,UAAU,mCAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,cAAc,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBACxF,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC;qBAC9D,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;oBAClB,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;wBAC3E,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC5C,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IACjB,CAAC;;AAzNc,0CAA2B,GAAqC,IAAI,GAAG,EAA+B,CAAC;AACvG,2CAA4B,GAAG,IAAI,SAAS,EAAsC,CAAC;AACnF,+BAAgB,GAAG,mCAAmC,EAAE,CAAC;SAH7D,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 UiProvider\r\n */\r\n\r\nimport { BeUiEvent, Logger, MarkRequired } from \"@itwin/core-bentley\";\r\nimport { BackstageItem } from \"../backstage/BackstageItem\";\r\nimport { StagePanelLocation } from \"../stagepanels/StagePanelLocation\";\r\nimport { StagePanelSection } from \"../stagepanels/StagePanelSection\";\r\nimport { StatusBarItem } from \"../statusbar/StatusBarItem\";\r\nimport { ToolbarItem, ToolbarOrientation, ToolbarUsage } from \"../toolbar/ToolbarItem\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { Widget } from \"../widgets/Widget\";\r\nimport { ProviderItem } from \"./ProviderItem\";\r\nimport { UiItemsProvider } from \"./UiItemsProvider\";\r\nimport { createAbstractUiItemsManagerAdapter } from \"./AbstractUiItemsManager\";\r\n\r\n/** UiItemsProvider register event args.\r\n * @public\r\n */\r\nexport interface UiItemsProviderRegisteredEventArgs {\r\n  providerId: string;\r\n}\r\n\r\n/** UiItemsProvider overrides allows the application that registers a provider to limit when it is allowed to provide items\r\n * @public\r\n */\r\nexport interface AllowedUiItemsProviderOverrides {\r\n  /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages */\r\n  providerId?: string;\r\n  /** if specified then the current stage's Usage will be compared before allowing any items to be provided */\r\n  stageUsages?: string[];\r\n  /** if specified then the current stage's Id will be compared before allowing any items to be provided */\r\n  stageIds?: string[];\r\n}\r\n\r\n/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.\r\n * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's\r\n * items are allowed.\r\n * @public\r\n */\r\nexport type UiItemsProviderOverrides =\r\n  MarkRequired<AllowedUiItemsProviderOverrides, \"providerId\" | \"stageUsages\"> |\r\n  MarkRequired<AllowedUiItemsProviderOverrides, \"providerId\" | \"stageIds\"> |\r\n  MarkRequired<AllowedUiItemsProviderOverrides, \"stageIds\"> |\r\n  MarkRequired<AllowedUiItemsProviderOverrides, \"stageUsages\"> |\r\n  MarkRequired<AllowedUiItemsProviderOverrides, \"providerId\" | \"stageUsages\" | \"stageIds\">;\r\n\r\n/** Interface that defines an instance of a UiItemsProvider and its application specified overrides. */\r\ninterface UiItemProviderEntry {\r\n  provider: UiItemsProvider;\r\n  overrides?: UiItemsProviderOverrides;\r\n}\r\n\r\n/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.\r\n * @public\r\n */\r\nexport class UiItemsManager {\r\n  private static _registeredUiItemsProviders: Map<string, UiItemProviderEntry> = new Map<string, UiItemProviderEntry>();\r\n  private static _onUiProviderRegisteredEvent = new BeUiEvent<UiItemsProviderRegisteredEventArgs>();\r\n  private static _abstractAdapter = createAbstractUiItemsManagerAdapter();\r\n\r\n  /** For use in unit testing\r\n   * @internal */\r\n  public static clearAllProviders() {\r\n    if (this._abstractAdapter)\r\n      return this._abstractAdapter.clearAllProviders();\r\n\r\n    UiItemsManager._registeredUiItemsProviders.clear();\r\n  }\r\n\r\n  /** Event raised any time a UiProvider is registered or unregistered. */\r\n  public static get onUiProviderRegisteredEvent(): BeUiEvent<UiItemsProviderRegisteredEventArgs> {\r\n    if (this._abstractAdapter)\r\n      return this._abstractAdapter.onUiProviderRegisteredEvent;\r\n\r\n    return this._onUiProviderRegisteredEvent;\r\n  }\r\n\r\n  /** Return number of registered UiProvider. */\r\n  public static get registeredProviderIds(): string[] {\r\n    if (this._abstractAdapter)\r\n      return this._abstractAdapter.registeredProviderIds;\r\n\r\n    const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];\r\n    return ids;\r\n  }\r\n\r\n  /** Return true if there is any registered UiProvider. */\r\n  public static get hasRegisteredProviders(): boolean {\r\n    if (this._abstractAdapter)\r\n      return this._abstractAdapter.hasRegisteredProviders;\r\n\r\n    return this._registeredUiItemsProviders.size > 0;\r\n  }\r\n\r\n  /**\r\n   * Retrieves a previously loaded UiItemsProvider.\r\n   * @param providerId id of the UiItemsProvider to get\r\n   */\r\n  public static getUiItemsProvider(providerId: string): UiItemsProvider | undefined {\r\n    if (this._abstractAdapter)\r\n      return this._abstractAdapter.getUiItemsProvider(providerId);\r\n\r\n    return UiItemsManager._registeredUiItemsProviders.get(providerId)?.provider;\r\n  }\r\n\r\n  private static sendRegisteredEvent(args: UiItemsProviderRegisteredEventArgs) {\r\n    UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(args);\r\n  }\r\n\r\n  /**\r\n   * Registers a UiItemsProvider with the UiItemsManager.\r\n   * @param uiProvider the UI items provider to register.\r\n   */\r\n  public static register(uiProvider: UiItemsProvider, overrides?: UiItemsProviderOverrides): void {\r\n    if (this._abstractAdapter)\r\n      return this._abstractAdapter.register(uiProvider, overrides);\r\n\r\n    const providerId = overrides?.providerId ?? uiProvider.id;\r\n\r\n    if (UiItemsManager.getUiItemsProvider(providerId)) {\r\n      Logger.logInfo(UiFramework.loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);\r\n    } else {\r\n      UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });\r\n      Logger.logInfo(UiFramework.loggerCategory(this), `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);\r\n\r\n      UiItemsManager.sendRegisteredEvent({ providerId });\r\n    }\r\n  }\r\n\r\n  /** Remove a specific UiItemsProvider from the list of available providers. */\r\n  public static unregister(providerId: string): void {\r\n    if (this._abstractAdapter)\r\n      return this._abstractAdapter.unregister(providerId);\r\n\r\n    const provider = UiItemsManager.getUiItemsProvider(providerId);\r\n    if (!provider)\r\n      return;\r\n\r\n    provider.onUnregister && provider.onUnregister();\r\n\r\n    UiItemsManager._registeredUiItemsProviders.delete(providerId);\r\n    Logger.logInfo(UiFramework.loggerCategory(this), `UiItemsProvider (${providerId}) unloaded`);\r\n\r\n    // trigger a refresh of the ui\r\n    UiItemsManager.sendRegisteredEvent({ providerId });\r\n  }\r\n\r\n  private static allowItemsFromProvider(entry: UiItemProviderEntry, stageId?: string, stageUsage?: string) {\r\n    // istanbul ignore else\r\n    const overrides = entry.overrides;\r\n    if (undefined !== stageId && overrides?.stageIds && !(overrides.stageIds.some((value: string) => value === stageId)))\r\n      return false;\r\n    if (undefined !== stageUsage && overrides?.stageUsages && !(overrides.stageUsages.some((value: string) => value === stageUsage)))\r\n      return false;\r\n    return true;\r\n  }\r\n\r\n  /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute\r\n   * an action or specify a registered ToolId into toolbar.\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @param usage usage of the toolbar\r\n   * @param orientation orientation of the toolbar\r\n   * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.\r\n   */\r\n  public static getToolbarButtonItems(stageId: string, stageUsage: string, usage: ToolbarUsage, orientation: ToolbarOrientation): ReadonlyArray<ProviderItem<ToolbarItem>> {\r\n    if (this._abstractAdapter)\r\n      return this._abstractAdapter.getToolbarButtonItems(stageId, stageUsage, usage, orientation);\r\n\r\n    const buttonItems: ProviderItem<ToolbarItem>[] = [];\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n      const uiProvider = entry.provider;\r\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n      // istanbul ignore else\r\n      if (uiProvider.provideToolbarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\r\n        uiProvider.provideToolbarItems(stageId, stageUsage, usage, orientation)\r\n          .forEach((spec: ToolbarItem) => {\r\n            // ignore duplicate ids\r\n            if (-1 === buttonItems.findIndex((existingItem) => spec.id === existingItem.id))\r\n              buttonItems.push({ ...spec, providerId });\r\n          });\r\n      }\r\n    });\r\n\r\n    return buttonItems;\r\n  }\r\n\r\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.\r\n   */\r\n  public static getStatusBarItems(stageId: string, stageUsage: string): ReadonlyArray<ProviderItem<StatusBarItem>> {\r\n    if (this._abstractAdapter)\r\n      return this._abstractAdapter.getStatusBarItems(stageId, stageUsage);\r\n\r\n    const statusBarItems: ProviderItem<StatusBarItem>[] = [];\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n      const uiProvider = entry.provider;\r\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n\r\n      // istanbul ignore else\r\n      if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\r\n        uiProvider.provideStatusBarItems(stageId, stageUsage)\r\n          .forEach((item: StatusBarItem) => {\r\n            // ignore duplicate ids\r\n            if (-1 === statusBarItems.findIndex((existingItem) => item.id === existingItem.id))\r\n              statusBarItems.push({ ...item, providerId });\r\n          });\r\n      }\r\n    });\r\n\r\n    return statusBarItems;\r\n  }\r\n\r\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\r\n   * @returns An array of BackstageItem that will be used to create controls for the backstage menu.\r\n   */\r\n  public static getBackstageItems(): ReadonlyArray<ProviderItem<BackstageItem>> {\r\n    if (this._abstractAdapter)\r\n      return this._abstractAdapter.getBackstageItems();\r\n\r\n    const backstageItems: ProviderItem<BackstageItem>[] = [];\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n      const uiProvider = entry.provider;\r\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n\r\n      // istanbul ignore else\r\n      if (uiProvider.provideBackstageItems) { // Note: We do not call this.allowItemsFromProvider here as backstage items\r\n        uiProvider.provideBackstageItems()    //       should not be considered stage specific. If they need to be hidden\r\n          .forEach((item: BackstageItem) => { //       the isHidden property should be set to a ConditionalBooleanValue\r\n            // ignore duplicate ids\r\n            if (-1 === backstageItems.findIndex((existingItem) => item.id === existingItem.id))\r\n              backstageItems.push({ ...item, providerId });\r\n          });\r\n      }\r\n    });\r\n\r\n    return backstageItems;\r\n  }\r\n\r\n  /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @param location the location within the stage.\r\n   * @param section the section within location.\r\n   * @returns An array of widgets.\r\n   */\r\n  public static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection): ReadonlyArray<ProviderItem<Widget>> {\r\n    if (this._abstractAdapter)\r\n      return this._abstractAdapter.getWidgets(stageId, stageUsage, location, section);\r\n\r\n    const widgets: ProviderItem<Widget>[] = [];\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((entry) => {\r\n      const uiProvider = entry.provider;\r\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n\r\n      // istanbul ignore else\r\n      if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\r\n        uiProvider.provideWidgets(stageId, stageUsage, location, section)\r\n          .forEach((widget) => {\r\n            // ignore duplicate ids\r\n            if (-1 === widgets.findIndex((existingItem) => widget.id === existingItem.id))\r\n              widgets.push({ ...widget, providerId });\r\n          });\r\n      }\r\n    });\r\n\r\n    return widgets;\r\n  }\r\n\r\n}\r\n"]}