Fix UI provider bug and add new provider param to isSupportedStage callback (#3377)

* fix bug where the wrong number of parameters were being passed

* fix missing parameter in provide widgets

* rush change

Author: bsteinbk

common/api/appui-abstract.api.md

@@ -253,11 +253,11 @@ export abstract class BaseQuantityDescription implements PropertyDescription {
 
 // @public
 export class BaseUiItemsProvider implements UiItemsProvider {
-    constructor(_providerId: string, isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any) => boolean) | undefined);
+    constructor(_providerId: string, isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any, provider?: UiItemsProvider | undefined) => boolean) | undefined);
     // (undocumented)
     get id(): string;
     // (undocumented)
-    isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any) => boolean) | undefined;
+    isSupportedStage?: ((stageId: string, stageUsage: string, stageAppData?: any, provider?: UiItemsProvider | undefined) => boolean) | undefined;
     // (undocumented)
     onUnregister(): void;
     provideBackstageItems(): BackstageItem[];

common/changes/@itwin/appui-abstract/fixMiscUiBugs_2022-03-17-22-29.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/appui-abstract",
+      "comment": "Fix missing parameter in UiManager.getWidgets call and pass provider to isSupportedStage function.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/appui-abstract"
+}

common/changes/@itwin/appui-react/fixMiscUiBugs_2022-03-17-22-29.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/appui-react",
+      "comment": "Fix missing parameter in UiManager.getWidgets call and pass provider to isSupportedStage function.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/appui-react"
+}

ui/appui-abstract/src/appui-abstract/UiItemsManager.ts

@@ -62,7 +62,7 @@ export class BaseUiItemsProvider implements UiItemsProvider {
    * @param isSupportedStage - optional function that will be called to determine if tools should be added to current stage. If not set and
    * the current stage's `usage` is set to `StageUsage.General` then the provider will add items to frontstage.
    */
-  constructor(protected _providerId: string, public isSupportedStage?: (stageId: string, stageUsage: string, stageAppData?: any) => boolean) { }
+  constructor(protected _providerId: string, public isSupportedStage?: (stageId: string, stageUsage: string, stageAppData?: any, provider?: UiItemsProvider) => boolean) { }
 
   public get id(): string { return this._providerId; }
   public onUnregister(): void { }
@@ -83,7 +83,7 @@ export class BaseUiItemsProvider implements UiItemsProvider {
     let provideToStage = false;
 
     if (this.isSupportedStage) {
-      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData);
+      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);
     } else {
       provideToStage = (stageUsage === StageUsage.General);
     }
@@ -98,7 +98,7 @@ export class BaseUiItemsProvider implements UiItemsProvider {
     let provideToStage = false;
 
     if (this.isSupportedStage) {
-      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData);
+      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);
     } else {
       provideToStage = (stageUsage === StageUsage.General);
     }
@@ -115,7 +115,7 @@ export class BaseUiItemsProvider implements UiItemsProvider {
     let provideToStage = false;
 
     if (this.isSupportedStage) {
-      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData);
+      provideToStage = this.isSupportedStage(stageId, stageUsage, stageAppData, this);
     } else {
       provideToStage = (stageUsage === StageUsage.General);
     }

ui/appui-react/src/appui-react/widgets/WidgetManager.ts

@@ -156,7 +156,7 @@ export class WidgetManager {
 
     // Consult the UiItemsManager to get any Abstract widgets
     if (location in StagePanelLocation) {
-      const widgets = UiItemsManager.getWidgets(stageId, stageUsage, location as StagePanelLocation, definedSection, frontstageApplicationData);
+      const widgets = UiItemsManager.getWidgets(stageId, stageUsage, location as StagePanelLocation, definedSection, undefined, frontstageApplicationData);
       widgets.forEach((abstractProps: AbstractWidgetProps, index: number) => {
         const props = WidgetDef.createWidgetPropsFromAbstractProps(abstractProps);
         const stableId = getAddonStableWidgetId(stageUsage, location as StagePanelLocation, definedSection, index);