feat(core): move DOCUMENT token into core (#60663)

crisbeto · thePunderWoman · commit 7ccec1494f86 · 2025-04-01T12:48:06.000Z
Moves the `DOCUMENT` token from `common` into `core` since it's relevant for lots of SSR use cases and users shouldn't have to install `common` for it. The token is still exported through `common` for backwards compatibility. PR Close #60663
diff --git a/goldens/public-api/common/index.api.md b/goldens/public-api/common/index.api.md
@@ -6,6 +6,7 @@
 
 import { ChangeDetectorRef } from '@angular/core';
 import { DoCheck } from '@angular/core';
+import { DOCUMENT } from '@angular/core';
 import { ElementRef } from '@angular/core';
 import * as i0 from '@angular/core';
 import { ɵIMAGE_CONFIG as IMAGE_CONFIG } from '@angular/core';
@@ -163,8 +164,7 @@ export class DecimalPipe implements PipeTransform {
     static ɵpipe: i0.ɵɵPipeDeclaration<DecimalPipe, "number", true>;
 }
 
-// @public
-export const DOCUMENT: InjectionToken<Document>;
+export { DOCUMENT }
 
 // @public
 export function formatCurrency(value: number, locale: string, currency: string, currencyCode?: string, digitsInfo?: string): string;
diff --git a/goldens/public-api/core/index.api.md b/goldens/public-api/core/index.api.md
@@ -648,6 +648,9 @@ export interface DoCheck {
     ngDoCheck(): void;
 }
 
+// @public
+export const DOCUMENT: InjectionToken<Document>;
+
 // @public
 export function effect(effectFn: (onCleanup: EffectCleanupRegisterFn) => void, options?: CreateEffectOptions): EffectRef;
 
diff --git a/packages/common/src/common.ts b/packages/common/src/common.ts
@@ -66,7 +66,6 @@ export {
   NgTemplateOutlet,
   NgComponentOutlet,
 } from './directives/index';
-export {DOCUMENT} from './dom_tokens';
 export {
   AsyncPipe,
   DatePipe,
@@ -111,3 +110,6 @@ export {
   provideNetlifyLoader,
 } from './directives/ng_optimized_image';
 export {normalizeQueryParams as ɵnormalizeQueryParams} from './location/util';
+
+// Backwards compatibility re-export.
+export {DOCUMENT} from '@angular/core';
diff --git a/packages/common/src/directives/ng_optimized_image/lcp_image_observer.ts b/packages/common/src/directives/ng_optimized_image/lcp_image_observer.ts
@@ -12,9 +12,9 @@ import {
   OnDestroy,
   ɵformatRuntimeError as formatRuntimeError,
   PLATFORM_ID,
+  DOCUMENT,
 } from '@angular/core';
 
-import {DOCUMENT} from '../../dom_tokens';
 import {RuntimeErrorCode} from '../../errors';
 
 import {assertDevMode} from './asserts';
diff --git a/packages/common/src/directives/ng_optimized_image/preconnect_link_checker.ts b/packages/common/src/directives/ng_optimized_image/preconnect_link_checker.ts
@@ -11,9 +11,9 @@ import {
   Injectable,
   InjectionToken,
   ɵformatRuntimeError as formatRuntimeError,
+  DOCUMENT,
 } from '@angular/core';
 
-import {DOCUMENT} from '../../dom_tokens';
 import {RuntimeErrorCode} from '../../errors';
 
 import {assertDevMode} from './asserts';
diff --git a/packages/common/src/directives/ng_optimized_image/preload-link-creator.ts b/packages/common/src/directives/ng_optimized_image/preload-link-creator.ts
@@ -6,9 +6,14 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import {inject, Injectable, Renderer2, ɵRuntimeError as RuntimeError} from '@angular/core';
+import {
+  inject,
+  Injectable,
+  Renderer2,
+  ɵRuntimeError as RuntimeError,
+  DOCUMENT,
+} from '@angular/core';
 
-import {DOCUMENT} from '../../dom_tokens';
 import {RuntimeErrorCode} from '../../errors';
 
 import {DEFAULT_PRELOADED_IMAGES_LIMIT, PRELOADED_IMAGES} from './tokens';
diff --git a/packages/common/src/location/location_strategy.ts b/packages/common/src/location/location_strategy.ts
@@ -6,9 +6,15 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import {Inject, inject, Injectable, InjectionToken, OnDestroy, Optional} from '@angular/core';
-
-import {DOCUMENT} from '../dom_tokens';
+import {
+  Inject,
+  inject,
+  Injectable,
+  InjectionToken,
+  OnDestroy,
+  Optional,
+  DOCUMENT,
+} from '@angular/core';
 
 import {LocationChangeListener, PlatformLocation} from './platform_location';
 import {joinWithSlash, normalizeQueryParams} from './util';
diff --git a/packages/common/src/location/platform_location.ts b/packages/common/src/location/platform_location.ts
@@ -6,10 +6,9 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import {inject, Injectable, InjectionToken} from '@angular/core';
+import {inject, Injectable, InjectionToken, DOCUMENT} from '@angular/core';
 
 import {getDOM} from '../dom_adapter';
-import {DOCUMENT} from '../dom_tokens';
 
 /**
  * This class should not be used directly by an application developer. Instead, use
diff --git a/packages/common/src/viewport_scroller.ts b/packages/common/src/viewport_scroller.ts
@@ -6,9 +6,7 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import {inject, ɵɵdefineInjectable} from '@angular/core';
-
-import {DOCUMENT} from './dom_tokens';
+import {inject, ɵɵdefineInjectable, DOCUMENT} from '@angular/core';
 
 /**
  * Defines a scroll position manager. Implemented by `BrowserViewportScroller`.
diff --git a/packages/core/src/core.ts b/packages/core/src/core.ts
@@ -117,6 +117,7 @@ export {ApplicationConfig, mergeApplicationConfig} from './application/applicati
 export {makeStateKey, StateKey, TransferState} from './transfer_state';
 export {booleanAttribute, numberAttribute} from './util/coercion';
 export {REQUEST, REQUEST_CONTEXT, RESPONSE_INIT} from './application/platform_tokens';
+export {DOCUMENT} from './document';
 
 import {global} from './util/global';
 if (typeof ngDevMode !== 'undefined' && ngDevMode) {
diff --git a/packages/core/src/document.ts b/packages/core/src/document.ts
@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.dev/license
  */
 
-import {InjectionToken} from '@angular/core';
+import {InjectionToken} from './di';
 
 /**
  * A DI Token representing the main rendering context.
diff --git a/packages/core/test/test_bed_spec.ts b/packages/core/test/test_bed_spec.ts
@@ -39,6 +39,7 @@ import {
   ɵɵelementStart as elementStart,
   ɵɵsetNgModuleScope as setNgModuleScope,
   ɵɵtext as text,
+  DOCUMENT,
 } from '../src/core';
 import {DeferBlockBehavior} from '../testing';
 import {TestBed, TestBedImpl} from '../testing/src/test_bed';
@@ -53,7 +54,6 @@ import {
   THROW_ON_UNKNOWN_ELEMENTS_DEFAULT,
   THROW_ON_UNKNOWN_PROPERTIES_DEFAULT,
 } from '../testing/src/test_bed_common';
-import {DOCUMENT} from '@angular/common/src/dom_tokens';
 
 const NAME = new InjectionToken<string>('name');
 

Original file line number	Diff line number	Diff line change
`@@ -648,6 +648,9 @@ export interface DoCheck {`
`648`	`648`	`ngDoCheck(): void;`
`649`	`649`	`}`
`650`	`650`
	`651`	`+// @public`
	`652`	`+export const DOCUMENT: InjectionToken<Document>;`
	`653`	`+`
`651`	`654`	`// @public`
`652`	`655`	`export function effect(effectFn: (onCleanup: EffectCleanupRegisterFn) => void, options?: CreateEffectOptions): EffectRef;`
`653`	`656`