fix(cdk/overlay): remove circular dependency workarounds (#27190)

Removes the `OverlayReference` interface which was introduced as a workaround to avoid circular dependencies.

Fixes #25650.

Author: crisbeto

src/cdk/overlay/dispatchers/base-overlay-dispatcher.ts

@@ -8,7 +8,7 @@
 
 import {DOCUMENT} from '@angular/common';
 import {Inject, Injectable, OnDestroy} from '@angular/core';
-import {OverlayReference} from '../overlay-reference';
+import type {OverlayRef} from '../overlay-ref';
 
 /**
  * Service for dispatching events that land on the body to appropriate overlay ref,
@@ -18,7 +18,7 @@ import {OverlayReference} from '../overlay-reference';
 @Injectable({providedIn: 'root'})
 export abstract class BaseOverlayDispatcher implements OnDestroy {
   /** Currently attached overlays in the order they were attached. */
-  _attachedOverlays: OverlayReference[] = [];
+  _attachedOverlays: OverlayRef[] = [];
 
   protected _document: Document;
   protected _isAttached: boolean;
@@ -32,14 +32,14 @@ export abstract class BaseOverlayDispatcher implements OnDestroy {
   }
 
   /** Add a new overlay to the list of attached overlay refs. */
-  add(overlayRef: OverlayReference): void {
+  add(overlayRef: OverlayRef): void {
     // Ensure that we don't get the same overlay multiple times.
     this.remove(overlayRef);
     this._attachedOverlays.push(overlayRef);
   }
 
   /** Remove an overlay from the list of attached overlay refs. */
-  remove(overlayRef: OverlayReference): void {
+  remove(overlayRef: OverlayRef): void {
     const index = this._attachedOverlays.indexOf(overlayRef);
 
     if (index > -1) {

src/cdk/overlay/dispatchers/overlay-keyboard-dispatcher.ts

@@ -8,8 +8,8 @@
 
 import {DOCUMENT} from '@angular/common';
 import {Inject, Injectable, NgZone, Optional} from '@angular/core';
-import {OverlayReference} from '../overlay-reference';
 import {BaseOverlayDispatcher} from './base-overlay-dispatcher';
+import type {OverlayRef} from '../overlay-ref';
 
 /**
  * Service for dispatching keyboard events that land on the body to appropriate overlay ref,
@@ -27,7 +27,7 @@ export class OverlayKeyboardDispatcher extends BaseOverlayDispatcher {
   }
 
   /** Add a new overlay to the list of attached overlay refs. */
-  override add(overlayRef: OverlayReference): void {
+  override add(overlayRef: OverlayRef): void {
     super.add(overlayRef);
 
     // Lazily start dispatcher once first overlay is added

src/cdk/overlay/dispatchers/overlay-outside-click-dispatcher.ts

@@ -8,9 +8,9 @@
 
 import {DOCUMENT} from '@angular/common';
 import {Inject, Injectable, NgZone, Optional} from '@angular/core';
-import {OverlayReference} from '../overlay-reference';
 import {Platform, _getEventTarget} from '@angular/cdk/platform';
 import {BaseOverlayDispatcher} from './base-overlay-dispatcher';
+import type {OverlayRef} from '../overlay-ref';
 
 /**
  * Service for dispatching mouse click events that land on the body to appropriate overlay ref,
@@ -33,7 +33,7 @@ export class OverlayOutsideClickDispatcher extends BaseOverlayDispatcher {
   }
 
   /** Add a new overlay to the list of attached overlay refs. */
-  override add(overlayRef: OverlayReference): void {
+  override add(overlayRef: OverlayRef): void {
     super.add(overlayRef);
 
     // Safari on iOS does not generate click events for non-interactive

src/cdk/overlay/overlay-ref.ts

@@ -16,7 +16,6 @@ import {OverlayKeyboardDispatcher} from './dispatchers/overlay-keyboard-dispatch
 import {OverlayOutsideClickDispatcher} from './dispatchers/overlay-outside-click-dispatcher';
 import {OverlayConfig} from './overlay-config';
 import {coerceCssPixelValue, coerceArray} from '@angular/cdk/coercion';
-import {OverlayReference} from './overlay-reference';
 import {PositionStrategy} from './position/position-strategy';
 import {ScrollStrategy} from './scroll';
 
@@ -29,7 +28,7 @@ export type ImmutableObject<T> = {
  * Reference to an overlay that has been created with the Overlay service.
  * Used to manipulate or dispose of said overlay.
  */
-export class OverlayRef implements PortalOutlet, OverlayReference {
+export class OverlayRef implements PortalOutlet {
   private _backdropElement: HTMLElement | null = null;
   private _backdropTimeout: number | undefined;
   private readonly _backdropClick = new Subject<MouseEvent>();

src/cdk/overlay/overlay-reference.ts

@@ -30,7 +30,6 @@ import {
   PositionStrategy,
   ScrollStrategy,
 } from './index';
-import {OverlayReference} from './overlay-reference';
 import {NoopAnimationsModule} from '@angular/platform-browser/animations';
 
 describe('Overlay', () => {
@@ -1148,9 +1147,9 @@ class FakePositionStrategy implements PositionStrategy {
 
 class FakeScrollStrategy implements ScrollStrategy {
   isEnabled = false;
-  overlayRef: OverlayReference;
+  overlayRef: OverlayRef;
 
-  attach(overlayRef: OverlayReference) {
+  attach(overlayRef: OverlayRef) {
     this.overlayRef = overlayRef;
   }
 

src/cdk/overlay/overlay.spec.ts

@@ -17,11 +17,11 @@ import {
   validateVerticalPosition,
 } from './connected-position';
 import {Observable, Subscription, Subject} from 'rxjs';
-import {OverlayReference} from '../overlay-reference';
 import {isElementScrolledOutsideView, isElementClippedByScrolling} from './scroll-clip';
 import {coerceCssPixelValue, coerceArray} from '@angular/cdk/coercion';
 import {Platform} from '@angular/cdk/platform';
 import {OverlayContainer} from '../overlay-container';
+import {OverlayRef} from '../overlay-ref';
 
 // TODO: refactor clipping detection into a separate thing (part of scrolling module)
 // TODO: doesn't handle both flexible width and height when it has to scroll along both axis.
@@ -53,7 +53,7 @@ type Dimensions = Omit<ClientRect, 'x' | 'y' | 'toJSON'>;
  */
 export class FlexibleConnectedPositionStrategy implements PositionStrategy {
   /** The overlay to which this strategy is attached. */
-  private _overlayRef: OverlayReference;
+  private _overlayRef: OverlayRef;
 
   /** Whether we're performing the very first positioning of the overlay. */
   private _isInitialRender: boolean;
@@ -155,7 +155,7 @@ export class FlexibleConnectedPositionStrategy implements PositionStrategy {
   }
 
   /** Attaches this position strategy to an overlay. */
-  attach(overlayRef: OverlayReference): void {
+  attach(overlayRef: OverlayRef): void {
     if (
       this._overlayRef &&
       overlayRef !== this._overlayRef &&

src/cdk/overlay/position/flexible-connected-position-strategy.ts

@@ -6,8 +6,8 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
+import {OverlayRef} from '../overlay-ref';
 import {PositionStrategy} from './position-strategy';
-import {OverlayReference} from '../overlay-reference';
 
 /** Class to be added to the overlay pane wrapper. */
 const wrapperClass = 'cdk-global-overlay-wrapper';
@@ -20,7 +20,7 @@ const wrapperClass = 'cdk-global-overlay-wrapper';
  */
 export class GlobalPositionStrategy implements PositionStrategy {
   /** The overlay to which this strategy is attached. */
-  private _overlayRef: OverlayReference;
+  private _overlayRef: OverlayRef;
   private _cssPosition = 'static';
   private _topOffset = '';
   private _bottomOffset = '';
@@ -31,7 +31,7 @@ export class GlobalPositionStrategy implements PositionStrategy {
   private _height = '';
   private _isDisposed = false;
 
-  attach(overlayRef: OverlayReference): void {
+  attach(overlayRef: OverlayRef): void {
     const config = overlayRef.getConfig();
 
     this._overlayRef = overlayRef;

src/cdk/overlay/position/global-position-strategy.ts

@@ -6,12 +6,12 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {OverlayReference} from '../overlay-reference';
+import type {OverlayRef} from '../overlay-ref';
 
 /** Strategy for setting the position on an overlay. */
 export interface PositionStrategy {
   /** Attaches this position strategy to an overlay. */
-  attach(overlayRef: OverlayReference): void;
+  attach(overlayRef: OverlayRef): void;
 
   /** Updates the position of the overlay element. */
   apply(): void;

src/cdk/overlay/position/position-strategy.ts

@@ -7,10 +7,10 @@
  */
 import {NgZone} from '@angular/core';
 import {ScrollStrategy, getMatScrollStrategyAlreadyAttachedError} from './scroll-strategy';
-import {OverlayReference} from '../overlay-reference';
 import {Subscription} from 'rxjs';
 import {ScrollDispatcher, ViewportRuler} from '@angular/cdk/scrolling';
 import {filter} from 'rxjs/operators';
+import type {OverlayRef} from '../overlay-ref';
 
 /**
  * Config options for the CloseScrollStrategy.
@@ -25,7 +25,7 @@ export interface CloseScrollStrategyConfig {
  */
 export class CloseScrollStrategy implements ScrollStrategy {
   private _scrollSubscription: Subscription | null = null;
-  private _overlayRef: OverlayReference;
+  private _overlayRef: OverlayRef;
   private _initialScrollPosition: number;
 
   constructor(
@@ -36,7 +36,7 @@ export class CloseScrollStrategy implements ScrollStrategy {
   ) {}
 
   /** Attaches this scroll strategy to an overlay. */
-  attach(overlayRef: OverlayReference) {
+  attach(overlayRef: OverlayRef) {
     if (this._overlayRef && (typeof ngDevMode === 'undefined' || ngDevMode)) {
       throw getMatScrollStrategyAlreadyAttachedError();
     }