@itwin/appui-react 4.0.0-dev.11 → 4.0.0-dev.13

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;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,EAAgB,MAAM,qBAAqB,CAAC;AAMtE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AA0C7C;;GAEG;AACH,MAAM,OAAO,cAAc;IAGzB;mBACe;IACR,MAAM,CAAC,iBAAiB;QAC7B,cAAc,CAAC,2BAA2B,CAAC,KAAK,EAAE,CAAC;IACrD,CAAC;IAKD,8CAA8C;IACvC,MAAM,KAAK,qBAAqB;QACrC,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,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAkB;;QACjD,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,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,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,YAA0B,EAAE,kBAAsC;QACzI,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,YAAY,EAAE,kBAAkB,CAAC;qBAClF,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,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,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,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;;AApLc,0CAA2B,GAAqC,IAAI,GAAG,EAA+B,CAAC;AAQtH,wEAAwE;AACjD,0CAA2B,GAAG,IAAI,SAAS,EAAsC,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\n\r\n/** UiItemsProvider register event args.\r\n * @beta\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 * @beta\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 * @beta\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 * @beta\r\n */\r\nexport class UiItemsManager {\r\n  private static _registeredUiItemsProviders: Map<string, UiItemProviderEntry> = new Map<string, UiItemProviderEntry>();\r\n\r\n  /** For use in unit testing\r\n   * @internal */\r\n  public static clearAllProviders() {\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 readonly onUiProviderRegisteredEvent = new BeUiEvent<UiItemsProviderRegisteredEventArgs>();\r\n\r\n  /** Return number of registered UiProvider. */\r\n  public static get registeredProviderIds() {\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    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    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    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    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 toolbarUsage usage of the toolbar\r\n   * @param toolbarOrientation 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, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation): ReadonlyArray<ProviderItem<ToolbarItem>> {\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, toolbarUsage, toolbarOrientation)\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    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    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    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"]}
+{"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;AA0C7C;;GAEG;AACH,MAAa,cAAc;IAGzB;mBACe;IACR,MAAM,CAAC,iBAAiB;QAC7B,cAAc,CAAC,2BAA2B,CAAC,KAAK,EAAE,CAAC;IACrD,CAAC;IAKD,8CAA8C;IACvC,MAAM,KAAK,qBAAqB;QACrC,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,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAkB;QACjD,OAAO,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,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,MAAM,UAAU,GAAG,SAAS,EAAE,UAAU,IAAI,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,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,IAAI,SAAS,EAAE,QAAQ,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,IAAI,SAAS,EAAE,WAAW,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,YAA0B,EAAE,kBAAsC;QACzI,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,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,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,YAAY,EAAE,kBAAkB,CAAC;qBAClF,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,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,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,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,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,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,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,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,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,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;;AApLc,0CAA2B,GAAqC,IAAI,GAAG,EAA+B,CAAC;AAQtH,wEAAwE;AACjD,0CAA2B,GAAG,IAAI,SAAS,EAAsC,CAAC;SAV9F,cAAc","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module UiProvider\n */\n\nimport { BeUiEvent, Logger, MarkRequired } from \"@itwin/core-bentley\";\nimport { BackstageItem } from \"../backstage/BackstageItem\";\nimport { StagePanelLocation } from \"../stagepanels/StagePanelLocation\";\nimport { StagePanelSection } from \"../stagepanels/StagePanelSection\";\nimport { StatusBarItem } from \"../statusbar/StatusBarItem\";\nimport { ToolbarItem, ToolbarOrientation, ToolbarUsage } from \"../toolbar/ToolbarItem\";\nimport { UiFramework } from \"../UiFramework\";\nimport { Widget } from \"../widgets/Widget\";\nimport { ProviderItem } from \"./ProviderItem\";\nimport { UiItemsProvider } from \"./UiItemsProvider\";\n\n/** UiItemsProvider register event args.\n * @beta\n */\nexport interface UiItemsProviderRegisteredEventArgs {\n  providerId: string;\n}\n\n/** UiItemsProvider overrides allows the application that registers a provider to limit when it is allowed to provide items\n * @beta\n */\nexport interface AllowedUiItemsProviderOverrides {\n  /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages */\n  providerId?: string;\n  /** if specified then the current stage's Usage will be compared before allowing any items to be provided */\n  stageUsages?: string[];\n  /** if specified then the current stage's Id will be compared before allowing any items to be provided */\n  stageIds?: string[];\n}\n\n/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.\n * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's\n * items are allowed.\n * @beta\n */\nexport type UiItemsProviderOverrides =\n  MarkRequired<AllowedUiItemsProviderOverrides, \"providerId\" | \"stageUsages\"> |\n  MarkRequired<AllowedUiItemsProviderOverrides, \"providerId\" | \"stageIds\"> |\n  MarkRequired<AllowedUiItemsProviderOverrides, \"stageIds\"> |\n  MarkRequired<AllowedUiItemsProviderOverrides, \"stageUsages\"> |\n  MarkRequired<AllowedUiItemsProviderOverrides, \"providerId\" | \"stageUsages\" | \"stageIds\">;\n\n/** Interface that defines an instance of a UiItemsProvider and its application specified overrides. */\ninterface UiItemProviderEntry {\n  provider: UiItemsProvider;\n  overrides?: UiItemsProviderOverrides;\n}\n\n/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.\n * @beta\n */\nexport class UiItemsManager {\n  private static _registeredUiItemsProviders: Map<string, UiItemProviderEntry> = new Map<string, UiItemProviderEntry>();\n\n  /** For use in unit testing\n   * @internal */\n  public static clearAllProviders() {\n    UiItemsManager._registeredUiItemsProviders.clear();\n  }\n\n  /** Event raised any time a UiProvider is registered or unregistered. */\n  public static readonly onUiProviderRegisteredEvent = new BeUiEvent<UiItemsProviderRegisteredEventArgs>();\n\n  /** Return number of registered UiProvider. */\n  public static get registeredProviderIds() {\n    const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];\n    return ids;\n  }\n\n  /** Return true if there is any registered UiProvider. */\n  public static get hasRegisteredProviders(): boolean {\n    return this._registeredUiItemsProviders.size > 0;\n  }\n\n  /**\n   * Retrieves a previously loaded UiItemsProvider.\n   * @param providerId id of the UiItemsProvider to get\n   */\n  public static getUiItemsProvider(providerId: string): UiItemsProvider | undefined {\n    return UiItemsManager._registeredUiItemsProviders.get(providerId)?.provider;\n  }\n\n  private static sendRegisteredEvent(args: UiItemsProviderRegisteredEventArgs) {\n    UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(args);\n  }\n\n  /**\n   * Registers a UiItemsProvider with the UiItemsManager.\n   * @param uiProvider the UI items provider to register.\n   */\n  public static register(uiProvider: UiItemsProvider, overrides?: UiItemsProviderOverrides): void {\n    const providerId = overrides?.providerId ?? uiProvider.id;\n\n    if (UiItemsManager.getUiItemsProvider(providerId)) {\n      Logger.logInfo(UiFramework.loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);\n    } else {\n      UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });\n      Logger.logInfo(UiFramework.loggerCategory(this), `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);\n\n      UiItemsManager.sendRegisteredEvent({ providerId });\n    }\n  }\n\n  /** Remove a specific UiItemsProvider from the list of available providers. */\n  public static unregister(providerId: string): void {\n    const provider = UiItemsManager.getUiItemsProvider(providerId);\n    if (!provider)\n      return;\n\n    provider.onUnregister && provider.onUnregister();\n\n    UiItemsManager._registeredUiItemsProviders.delete(providerId);\n    Logger.logInfo(UiFramework.loggerCategory(this), `UiItemsProvider (${providerId}) unloaded`);\n\n    // trigger a refresh of the ui\n    UiItemsManager.sendRegisteredEvent({ providerId });\n  }\n\n  private static allowItemsFromProvider(entry: UiItemProviderEntry, stageId?: string, stageUsage?: string) {\n    // istanbul ignore else\n    const overrides = entry.overrides;\n    if (undefined !== stageId && overrides?.stageIds && !(overrides.stageIds.some((value: string) => value === stageId)))\n      return false;\n    if (undefined !== stageUsage && overrides?.stageUsages && !(overrides.stageUsages.some((value: string) => value === stageUsage)))\n      return false;\n    return true;\n  }\n\n  /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute\n   * an action or specify a registered ToolId into toolbar.\n   * @param stageId a string identifier the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @param toolbarUsage usage of the toolbar\n   * @param toolbarOrientation orientation of the toolbar\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.\n   */\n  public static getToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation): ReadonlyArray<ProviderItem<ToolbarItem>> {\n    const buttonItems: ProviderItem<ToolbarItem>[] = [];\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n      // istanbul ignore else\n      if (uiProvider.provideToolbarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\n        uiProvider.provideToolbarItems(stageId, stageUsage, toolbarUsage, toolbarOrientation)\n          .forEach((spec: ToolbarItem) => {\n            // ignore duplicate ids\n            if (-1 === buttonItems.findIndex((existingItem) => spec.id === existingItem.id))\n              buttonItems.push({ ...spec, providerId });\n          });\n      }\n    });\n\n    return buttonItems;\n  }\n\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\n   * @param stageId a string identifier the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.\n   */\n  public static getStatusBarItems(stageId: string, stageUsage: string): ReadonlyArray<ProviderItem<StatusBarItem>> {\n    const statusBarItems: ProviderItem<StatusBarItem>[] = [];\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n      // istanbul ignore else\n      if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\n        uiProvider.provideStatusBarItems(stageId, stageUsage)\n          .forEach((item: StatusBarItem) => {\n            // ignore duplicate ids\n            if (-1 === statusBarItems.findIndex((existingItem) => item.id === existingItem.id))\n              statusBarItems.push({ ...item, providerId });\n          });\n      }\n    });\n\n    return statusBarItems;\n  }\n\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\n   * @returns An array of BackstageItem that will be used to create controls for the backstage menu.\n   */\n  public static getBackstageItems(): ReadonlyArray<ProviderItem<BackstageItem>> {\n    const backstageItems: ProviderItem<BackstageItem>[] = [];\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n      // istanbul ignore else\n      if (uiProvider.provideBackstageItems) { // Note: We do not call this.allowItemsFromProvider here as backstage items\n        uiProvider.provideBackstageItems()    //       should not be considered stage specific. If they need to be hidden\n          .forEach((item: BackstageItem) => { //       the isHidden property should be set to a ConditionalBooleanValue\n            // ignore duplicate ids\n            if (-1 === backstageItems.findIndex((existingItem) => item.id === existingItem.id))\n              backstageItems.push({ ...item, providerId });\n          });\n      }\n    });\n\n    return backstageItems;\n  }\n\n  /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets\n   * @param stageId a string identifier the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @param location the location within the stage.\n   * @param section the section within location.\n   * @returns An array of widgets.\n   */\n  public static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection): ReadonlyArray<ProviderItem<Widget>> {\n    const widgets: ProviderItem<Widget>[] = [];\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n      // istanbul ignore else\n      if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\n        uiProvider.provideWidgets(stageId, stageUsage, location, section)\n          .forEach((widget) => {\n            // ignore duplicate ids\n            if (-1 === widgets.findIndex((existingItem) => widget.id === existingItem.id))\n              widgets.push({ ...widget, providerId });\n          });\n      }\n    });\n\n    return widgets;\n  }\n\n}\n"]}

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

@@ -1,27 +1,27 @@
-/** @packageDocumentation
- * @module UiProvider
- */
-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";
-/** Describes interface of objects that want to provide UI component to the running IModelApp.
- * @public
- */
-export interface UiItemsProvider {
-    /** Id of provider. */
-    readonly id: string;
-    /** Provides toolbar items. */
-    readonly provideToolbarItems?: (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation) => ReadonlyArray<ToolbarItem>;
-    /** Provides status bar items. */
-    readonly provideStatusBarItems?: (stageId: string, stageUsage: string) => ReadonlyArray<StatusBarItem>;
-    /** Provides backstage items. */
-    readonly provideBackstageItems?: () => ReadonlyArray<BackstageItem>;
-    /** Provides widgets. */
-    readonly provideWidgets?: (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection) => ReadonlyArray<Widget>;
-    /** Function called when the provider is unregistered. Allows provider to do a cleanup. */
-    readonly onUnregister?: () => void;
-}
+/** @packageDocumentation
+ * @module UiProvider
+ */
+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";
+/** Describes interface of objects that want to provide UI component to the running IModelApp.
+ * @public
+ */
+export interface UiItemsProvider {
+    /** Id of provider. */
+    readonly id: string;
+    /** Provides toolbar items. */
+    readonly provideToolbarItems?: (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation) => ReadonlyArray<ToolbarItem>;
+    /** Provides status bar items. */
+    readonly provideStatusBarItems?: (stageId: string, stageUsage: string) => ReadonlyArray<StatusBarItem>;
+    /** Provides backstage items. */
+    readonly provideBackstageItems?: () => ReadonlyArray<BackstageItem>;
+    /** Provides widgets. */
+    readonly provideWidgets?: (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection) => ReadonlyArray<Widget>;
+    /** Function called when the provider is unregistered. Allows provider to do a cleanup. */
+    readonly onUnregister?: () => void;
+}
 //# sourceMappingURL=UiItemsProvider.d.ts.map

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

@@ -1,9 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-export {};
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+export {};
 //# sourceMappingURL=UiItemsProvider.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"UiItemsProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 { 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 { Widget } from \"../widgets/Widget\";\r\n\r\n/** Describes interface of objects that want to provide UI component to the running IModelApp.\r\n * @public\r\n */\r\nexport interface UiItemsProvider {\r\n  /** Id of provider. */\r\n  readonly id: string;\r\n\r\n  /** Provides toolbar items. */\r\n  readonly provideToolbarItems?: (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation) => ReadonlyArray<ToolbarItem>;\r\n  /** Provides status bar items. */\r\n  readonly provideStatusBarItems?: (stageId: string, stageUsage: string) => ReadonlyArray<StatusBarItem>;\r\n  /** Provides backstage items. */\r\n  readonly provideBackstageItems?: () => ReadonlyArray<BackstageItem>;\r\n  /** Provides widgets. */\r\n  readonly provideWidgets?: (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection) => ReadonlyArray<Widget>;\r\n  /** Function called when the provider is unregistered. Allows provider to do a cleanup. */\r\n  readonly onUnregister?: () => void;\r\n}\r\n"]}
+{"version":3,"file":"UiItemsProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module UiProvider\n */\n\nimport { BackstageItem } from \"../backstage/BackstageItem\";\nimport { StagePanelLocation } from \"../stagepanels/StagePanelLocation\";\nimport { StagePanelSection } from \"../stagepanels/StagePanelSection\";\nimport { StatusBarItem } from \"../statusbar/StatusBarItem\";\nimport { ToolbarItem, ToolbarOrientation, ToolbarUsage } from \"../toolbar/ToolbarItem\";\nimport { Widget } from \"../widgets/Widget\";\n\n/** Describes interface of objects that want to provide UI component to the running IModelApp.\n * @public\n */\nexport interface UiItemsProvider {\n  /** Id of provider. */\n  readonly id: string;\n\n  /** Provides toolbar items. */\n  readonly provideToolbarItems?: (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation) => ReadonlyArray<ToolbarItem>;\n  /** Provides status bar items. */\n  readonly provideStatusBarItems?: (stageId: string, stageUsage: string) => ReadonlyArray<StatusBarItem>;\n  /** Provides backstage items. */\n  readonly provideBackstageItems?: () => ReadonlyArray<BackstageItem>;\n  /** Provides widgets. */\n  readonly provideWidgets?: (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection) => ReadonlyArray<Widget>;\n  /** Function called when the provider is unregistered. Allows provider to do a cleanup. */\n  readonly onUnregister?: () => void;\n}\n"]}

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

@@ -1,7 +1,7 @@
-/** @packageDocumentation
- * @module UiProvider
- */
-import { ProviderItem } from "./ProviderItem";
-/** @internal */
-export declare function isProviderItem<T extends object>(item: T): item is ProviderItem<T>;
+/** @packageDocumentation
+ * @module UiProvider
+ */
+import { ProviderItem } from "./ProviderItem";
+/** @internal */
+export declare function isProviderItem<T extends object>(item: T): item is ProviderItem<T>;
 //# sourceMappingURL=isProviderItem.d.ts.map

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

@@ -1,12 +1,12 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-/** @internal */
-export function isProviderItem(item) {
-    return "providerId" in item;
-}
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/** @internal */
+export function isProviderItem(item) {
+    return "providerId" in item;
+}
 //# sourceMappingURL=isProviderItem.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"isProviderItem.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/isProviderItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH,gBAAgB;AAChB,MAAM,UAAU,cAAc,CAAmB,IAAO;IACtD,OAAO,YAAY,IAAI,IAAI,CAAC;AAC9B,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 { ProviderItem } from \"./ProviderItem\";\r\n\r\n/** @internal */\r\nexport function isProviderItem<T extends object>(item: T): item is ProviderItem<T> {\r\n  return \"providerId\" in item;\r\n}\r\n"]}
+{"version":3,"file":"isProviderItem.js","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/isProviderItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH,gBAAgB;AAChB,MAAM,UAAU,cAAc,CAAmB,IAAO;IACtD,OAAO,YAAY,IAAI,IAAI,CAAC;AAC9B,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module UiProvider\n */\n\nimport { ProviderItem } from \"./ProviderItem\";\n\n/** @internal */\nexport function isProviderItem<T extends object>(item: T): item is ProviderItem<T> {\n  return \"providerId\" in item;\n}\n"]}