packages/core/src/application/application_tokens.ts - main - githubmirror/angular

packages/core/src/application/application_tokens.ts
191 строка7 KB
Anuj Chhajed
refactor(core): correct all `typeof ngDevMode` comparison patterns introduced by #63875
08 дек 2025, 21:30
08 дек 2025, 21:3096b79fc
/**
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.dev/license
 */

import {ENVIRONMENT_INITIALIZER, inject, StaticProvider} from '../di';
import {InjectionToken} from '../di/injection_token';
import {DOCUMENT} from '../document';
import {RuntimeError, RuntimeErrorCode} from '../errors';

/**
 * A DI token representing a string ID, used
 * primarily for prefixing application attributes and CSS styles when
 * {@link ViewEncapsulation#Emulated} is being used.
 *
 * The token is needed in cases when multiple applications are bootstrapped on a page
 * (for example, using `bootstrapApplication` calls). In this case, ensure that those applications
 * have different `APP_ID` value setup. For example:
 *
 * ```ts
 * bootstrapApplication(ComponentA, {
 *   providers: [
 *     { provide: APP_ID, useValue: 'app-a' },
 *     // ... other providers ...
 *   ]
 * });
 *
 * bootstrapApplication(ComponentB, {
 *   providers: [
 *     { provide: APP_ID, useValue: 'app-b' },
 *     // ... other providers ...
 *   ]
 * });
 * ```
 *
 * By default, when there is only one application bootstrapped, you don't need to provide the
 * `APP_ID` token (the `ng` will be used as an app ID).
 *
 * @publicApi
 */
export const APP_ID = new InjectionToken<string>(
  typeof ngDevMode !== 'undefined' && ngDevMode ? 'AppId' : '',
  {
    factory: () => DEFAULT_APP_ID,
  },
);

/** Default value of the `APP_ID` token. */
const DEFAULT_APP_ID = 'ng';

/** Initializer check for the validity of the APP_ID */
export const validAppIdInitializer: StaticProvider = {
  provide: ENVIRONMENT_INITIALIZER,
  multi: true,
  useValue: () => {
    const appId = inject(APP_ID);
    const isAlphanumeric = /^[a-zA-Z0-9\-_]+$/.test(appId);

    if (!isAlphanumeric) {
      throw new RuntimeError(
        RuntimeErrorCode.INVALID_APP_ID,
        `APP_ID value "${appId}" is not alphanumeric. ` +
          `The APP_ID must be a string of alphanumeric characters. (a-zA-Z0-9), hyphens (-) and underscores (_) are allowed.`,
      );
    }
  },
};

/**
 * A function that is executed when a platform is initialized.
 *
 * @deprecated from v19.0.0, use providePlatformInitializer instead
 *
 * @see {@link providePlatformInitializer}
 *
 * @publicApi
 */
export const PLATFORM_INITIALIZER = new InjectionToken<ReadonlyArray<() => void>>(
  typeof ngDevMode !== 'undefined' && ngDevMode ? 'Platform Initializer' : '',
);

/**
 * A token that indicates an opaque platform ID.
 * @publicApi
 */
export const PLATFORM_ID = new InjectionToken<Object>(
  typeof ngDevMode !== 'undefined' && ngDevMode ? 'Platform ID' : '',
  {
    providedIn: 'platform',
    factory: () => 'unknown', // set a default platform name, when none set explicitly
  },
);

// We keep this token here, rather than the animations package, so that modules that only care
// about which animations module is loaded (e.g. the CDK) can retrieve it without having to
// include extra dependencies. See #44970 for more context.

/**
 * A [DI token](api/core/InjectionToken) that indicates which animations
 * module has been loaded.
 * @publicApi
 */
export const ANIMATION_MODULE_TYPE = new InjectionToken<'NoopAnimations' | 'BrowserAnimations'>(
  typeof ngDevMode !== 'undefined' && ngDevMode ? 'AnimationModuleType' : '',
);

// TODO(crisbeto): link to CSP guide here.
/**
 * Token used to configure the [Content Security Policy](https://web.dev/strict-csp/) nonce that
 * Angular will apply when inserting inline styles. If not provided, Angular will look up its value
 * from the `ngCspNonce` attribute of the application root node.
 *
 * @see [Content security policy](best-practices/security#content-security-policy)
 *
 * @publicApi
 */
export const CSP_NONCE = new InjectionToken<string | null>(
  typeof ngDevMode !== 'undefined' && ngDevMode ? 'CSP nonce' : '',
  {
    factory: () => {
      // Ideally we wouldn't have to use `querySelector` here since we know that the nonce will be on
      // the root node, but because the token value is used in renderers, it has to be available
      // *very* early in the bootstrapping process. This should be a fairly shallow search, because
      // the app won't have been added to the DOM yet. Some approaches that were considered:
      // 1. Find the root node through `ApplicationRef.components[i].location` - normally this would
      // be enough for our purposes, but the token is injected very early so the `components` array
      // isn't populated yet.
      // 2. Find the root `LView` through the current `LView` - renderers are a prerequisite to
      // creating the `LView`. This means that no `LView` will have been entered when this factory is
      // invoked for the root component.
      // 3. Have the token factory return `() => string` which is invoked when a nonce is requested -
      // the slightly later execution does allow us to get an `LView` reference, but the fact that
      // it is a function means that it could be executed at *any* time (including immediately) which
      // may lead to weird bugs.
      // 4. Have the `ComponentFactory` read the attribute and provide it to the injector under the
      // hood - has the same problem as #1 and #2 in that the renderer is used to query for the root
      // node and the nonce value needs to be available when the renderer is created.
      return (
        inject(DOCUMENT).body?.querySelector('[ngCspNonce]')?.getAttribute('ngCspNonce') || null
      );
    },
  },
);

/**
 * A configuration object for the image-related options. Contains:
 * - breakpoints: An array of integer breakpoints used to generate
 *      srcsets for responsive images.
 * - disableImageSizeWarning: A boolean value. Setting this to true will
 *      disable console warnings about oversized images.
 * - disableImageLazyLoadWarning: A boolean value. Setting this to true will
 *      disable console warnings about LCP images configured with `loading="lazy"`.
 * Learn more about the responsive image configuration in [the NgOptimizedImage
 * guide](guide/image-optimization).
 * Learn more about image warning options in [the related error page](errors/NG0913).
 * @publicApi
 */
export type ImageConfig = {
  breakpoints?: number[];
  placeholderResolution?: number;
  disableImageSizeWarning?: boolean;
  disableImageLazyLoadWarning?: boolean;
};

export const IMAGE_CONFIG_DEFAULTS: ImageConfig = {
  breakpoints: [16, 32, 48, 64, 96, 128, 256, 384, 640, 750, 828, 1080, 1200, 1920, 2048, 3840],
  placeholderResolution: 30,
  disableImageSizeWarning: false,
  disableImageLazyLoadWarning: false,
};

/**
 * Injection token that configures the image optimized image functionality.
 * See {@link ImageConfig} for additional information about parameters that
 * can be used.
 *
 * @see {@link NgOptimizedImage}
 * @see {@link ImageConfig}
 * @see [Responsive images](guide/image-optimization#responsive-images)
 * @see [Using placeholders](guide/image-optimization#using-placeholders)
 * @publicApi
 */
export const IMAGE_CONFIG = new InjectionToken<ImageConfig>(
  typeof ngDevMode !== 'undefined' && ngDevMode ? 'ImageConfig' : '',
  {
    factory: () => IMAGE_CONFIG_DEFAULTS,
  },
);