adev/src/app/core/services/version-manager.service.ts - main - githubmirror/angular

adev/src/app/core/services/version-manager.service.ts
102 строки3 KB
Matthieu Riegler
docs: update guides to use `@Service`
11 май 2026, 22:38
11 май 2026, 22:3852a8487
/*!
 * @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 {httpResource} from '@angular/common/http';
import {DOCUMENT, Service, VERSION, computed, inject} from '@angular/core';

import versionJson from '../../../assets/others/versions.json';

export interface Version {
  displayName: string;
  url: string;
}

export type VersionMode = 'stable' | 'deprecated' | 'rc' | 'next' | number;

export const INITIAL_ADEV_DOCS_VERSION = 18;
export const VERSION_PLACEHOLDER = '{{version}}';
export const MODE_PLACEHOLDER = '{{prefix}}';

type VersionJson = {version: string; url: string};

/**
 * This service will rely on 2 sources of data for the list of versions.
 *
 * To have an up-to-date list of versions, it will fetch a json from the deployed website.
 * As fallback it will use a local json file that is bundled with the app.
 */
@Service()
export class VersionManager {
  private document = inject(DOCUMENT);

  readonly currentDocsVersionMode = computed<VersionMode>(() => {
    const hostname = this.document.location.hostname;
    if (hostname.startsWith('v')) return 'deprecated';
    if (hostname.startsWith('rc')) return 'rc';
    if (hostname.startsWith('next')) return 'next';

    return 'stable';
  });

  private localVersions = (versionJson as VersionJson[]).map((v) => {
    return {
      displayName: v.version,
      url: v.url,
    };
  });

  // This handle the fallback if the resource fails.
  readonly versions = computed(() => {
    return this.remoteVersions.hasValue() ? this.remoteVersions.value() : this.localVersions;
  });

  // Yes this will trigger a cors error on localhost
  // but this is fine as we'll fallback to the local versions.json
  // which is the most up-to-date anyway.
  remoteVersions = httpResource(
    () => ({
      url: 'https://angular.dev/assets/others/versions.json',
      transferCache: false,
      cache: 'no-cache',
    }),
    {
      parse: (json: unknown) => {
        if (!Array.isArray(json)) {
          throw new Error('Invalid version data');
        }
        return json.map((v: unknown) => {
          if (
            v === undefined ||
            v === null ||
            typeof v !== 'object' ||
            !('version' in v) ||
            !('url' in v) ||
            typeof v.version !== 'string' ||
            typeof v.url !== 'string'
          ) {
            throw new Error('Invalid version data');
          }

          return {
            displayName: v.version,
            url: v.url,
          };
        });
      },
    },
  );

  readonly currentDocsVersion = computed(() => {
    // In devmode the version is 0, so we'll target next (which is first on the list)
    if (VERSION.major === '0' || VERSION.patch.includes('next')) {
      return this.versions()[0];
    }

    return this.versions().find((v) => v.displayName.includes(VERSION.major)) ?? this.versions()[0];
  });
}