@ng-doc/app 22.0.0-beta.1 → 22.0.0

package/fesm2022/ng-doc-app-services-route-preloader.mjs

@@ -0,0 +1,360 @@
+import * as i0 from '@angular/core';
+import { inject, DOCUMENT, Injector, NgZone, PLATFORM_ID, DestroyRef, Service } from '@angular/core';
+import { of, catchError } from 'rxjs';
+import { LocationStrategy, isPlatformBrowser } from '@angular/common';
+import { Router, RouterPreloader, PRIMARY_OUTLET } from '@angular/router';
+import { ɵngDocRouteContentSources as _ngDocRouteContentSources, ɵpreloadNgDocContent as _preloadNgDocContent } from '@ng-doc/app/helpers';
+import { NG_DOC_ROUTE_PREFIX } from '@ng-doc/app/tokens';
+
+/** The events that tell that the reader is about to open a link. */
+const INTENT_EVENTS = ['pointerover', 'mouseover', 'focusin', 'touchstart'];
+/** How long the browser may stay busy before an idle preload runs anyway, in milliseconds. */
+const IDLE_TIMEOUT = 2000;
+/** The delay of an idle preload where the browser has no `requestIdleCallback`. */
+const IDLE_FALLBACK_DELAY = 200;
+/**
+ * Preloads the pages that the reader is about to open, so that opening them shows them at once.
+ *
+ * It preloads a page when the reader points at, focuses or touches a link to it, anywhere in the
+ * document: the sidebar, the previous and next page links, links in the page content, search
+ * results and the table of contents. It also preloads the previous and next pages of a guide once
+ * the browser is idle after the guide has rendered. A preload loads the code of the page's route
+ * and its content, once per page. Nothing is preloaded on the server, when the reader asked the
+ * browser to save data, or on a 2G connection.
+ *
+ * The router loads the code through its preloading strategy, so preloading works only when the
+ * application sets `NgDocPreloadingStrategy` as that strategy:
+ *
+ * ```ts
+ * provideRouter(routes, withPreloading(NgDocPreloadingStrategy));
+ * ```
+ */
+class NgDocRoutePreloader {
+    constructor() {
+        this.document = inject(DOCUMENT);
+        this.injector = inject(Injector);
+        this.ngZone = inject(NgZone);
+        this.router = inject(Router);
+        this.locationStrategy = inject(LocationStrategy);
+        this.browser = isPlatformBrowser(inject(PLATFORM_ID));
+        /** The path segments under which the documentation's routes live (`routePrefix`). */
+        this.prefix = (inject(NG_DOC_ROUTE_PREFIX, { optional: true }) ?? '')
+            .split('/')
+            .filter(Boolean);
+        /** The pages that were asked for, by path, so each page is preloaded once. */
+        this.requested = new Set();
+        /** The paths, as URL segments, whose routes are being loaded. */
+        this.loading = new Map();
+        this.enabled = false;
+        this.destroyed = false;
+        this.intent = (event) => {
+            const target = event.target;
+            const anchor = typeof Element !== 'undefined' && target instanceof Element
+                ? target.closest('a[href]')
+                : null;
+            // Pointer events fire for every element under the pointer, so a link is checked only when
+            // the pointer reaches it.
+            if (!anchor || (anchor === this.lastAnchor && event.type !== 'focusin'))
+                return;
+            this.lastAnchor = anchor;
+            const url = this.linkUrl(anchor);
+            if (url !== undefined)
+                this.preload(url);
+        };
+        inject(DestroyRef).onDestroy(() => this.destroy());
+    }
+    /**
+     * Turns preloading on and starts listening for links the reader is about to open. Called by
+     * `NgDocPreloadingStrategy` when the router creates it; does nothing on the server.
+     * @internal
+     */
+    enable() {
+        if (this.enabled || this.destroyed || !this.browser)
+            return;
+        this.enabled = true;
+        const view = this.document.defaultView;
+        if (!view)
+            return;
+        // A link the reader points at must not run change detection in a zone application.
+        this.ngZone.runOutsideAngular(() => {
+            INTENT_EVENTS.forEach((type) => this.document.addEventListener(type, this.intent, { capture: true, passive: true }));
+        });
+    }
+    /**
+     * Preloads the code and the content of the page at a URL of the application. A page is
+     * preloaded once; the current page is not preloaded.
+     * @param url - The URL, relative to the application's base, for example `/docs/get-started`.
+     * @returns Whether a preload started.
+     */
+    preload(url) {
+        if (!this.active())
+            return false;
+        let segments;
+        try {
+            segments = urlSegments(typeof url === 'string' ? this.router.parseUrl(url) : url);
+        }
+        catch {
+            return false;
+        }
+        // Only the documentation's own pages are preloaded, never the rest of the application.
+        if (this.prefix.some((part, index) => segments[index] !== part))
+            return false;
+        const key = segments.join('/');
+        if (this.requested.has(key) || key === urlSegments(this.currentUrl()).join('/'))
+            return false;
+        this.requested.add(key);
+        this.loading.set(key, segments);
+        this.ngZone.runOutsideAngular(() => {
+            this.injector
+                .get(RouterPreloader)
+                .preload()
+                .subscribe({ complete: () => this.loaded(key, segments) });
+        });
+        return true;
+    }
+    /**
+     * Preloads pages once the browser is idle. A later call replaces the pages of an earlier one
+     * that has not run yet.
+     * @param urls - The URLs of the pages; missing ones are skipped.
+     */
+    preloadWhenIdle(urls) {
+        this.cancelIdle?.();
+        this.cancelIdle = undefined;
+        const view = this.document.defaultView;
+        const pages = urls.filter((url) => !!url);
+        if (!this.active() || !view || !pages.length)
+            return;
+        const run = () => {
+            this.cancelIdle = undefined;
+            pages.forEach((url) => this.preload(url));
+        };
+        this.ngZone.runOutsideAngular(() => {
+            if (typeof view.requestIdleCallback === 'function') {
+                const handle = view.requestIdleCallback(run, { timeout: IDLE_TIMEOUT });
+                this.cancelIdle = () => view.cancelIdleCallback(handle);
+            }
+            else {
+                const handle = view.setTimeout(run, IDLE_FALLBACK_DELAY);
+                this.cancelIdle = () => view.clearTimeout(handle);
+            }
+        });
+    }
+    /**
+     * Whether the router should load a lazy route now: the route leads to a page that is being
+     * preloaded.
+     * @param route - A lazy route that the router has not loaded yet.
+     * @returns Whether to load it.
+     * @internal
+     */
+    shouldPreload(route) {
+        if (!this.enabled || this.destroyed)
+            return false;
+        for (const segments of this.loading.values()) {
+            if (routesOnPath(this.router.config, segments).has(route))
+                return true;
+        }
+        return false;
+    }
+    loaded(key, segments) {
+        this.loading.delete(key);
+        if (this.destroyed)
+            return;
+        const routes = routesOnPath(this.router.config, segments);
+        // The strategy turns a failed load into no load, so the router's own preloading survives
+        // it. A route that is still not loaded failed: a later intent may try again.
+        if ([...routes].some((route) => route.loadChildren && !loadedRoutes(route))) {
+            this.requested.delete(key);
+            return;
+        }
+        // The routes of the page have loaded, so the content sources of their components are known.
+        for (const route of routes) {
+            for (const source of _ngDocRouteContentSources(route)) {
+                _preloadNgDocContent(source).catch(() => undefined);
+            }
+        }
+    }
+    active() {
+        return this.enabled && !this.destroyed && !constrainedConnection(this.document);
+    }
+    currentUrl() {
+        return this.router.parseUrl(this.router.url);
+    }
+    /**
+     * Returns the application URL of a link, or `undefined` for a link that leaves the
+     * application, opens elsewhere, downloads a file or points into the current page.
+     * @param anchor - The link.
+     * @returns The URL relative to the application's base, with its query.
+     */
+    linkUrl(anchor) {
+        const view = this.document.defaultView;
+        const href = anchor.getAttribute('href');
+        const target = anchor.getAttribute('target');
+        if (!view ||
+            !href ||
+            anchor.hasAttribute('download') ||
+            (target && target !== '_self') ||
+            href.startsWith('#')) {
+            return undefined;
+        }
+        let url;
+        try {
+            url = new URL(href, this.document.baseURI);
+        }
+        catch {
+            return undefined;
+        }
+        // Another site, or the current page (an anchor on it, or a link to itself).
+        if (url.origin !== view.location.origin || url.pathname === view.location.pathname) {
+            return undefined;
+        }
+        const base = this.basePath();
+        if (!`${url.pathname}/`.startsWith(base))
+            return undefined;
+        return `/${url.pathname.slice(base.length)}${url.search}`;
+    }
+    /** The base path of the application, ending with a slash. */
+    basePath() {
+        const base = this.locationStrategy.getBaseHref() || '/';
+        const path = new URL(base, this.document.baseURI).pathname;
+        return path.endsWith('/') ? path : `${path}/`;
+    }
+    destroy() {
+        this.destroyed = true;
+        this.cancelIdle?.();
+        this.cancelIdle = undefined;
+        this.loading.clear();
+        INTENT_EVENTS.forEach((type) => this.document.removeEventListener(type, this.intent, { capture: true }));
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.2.1", ngImport: i0, type: NgDocRoutePreloader, deps: [], target: i0.ɵɵFactoryTarget.Service }); }
+    static { this.ɵprov = i0.ɵɵngDeclareService({ minVersion: "22.0.0", version: "22.2.1", ngImport: i0, type: NgDocRoutePreloader }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.2.1", ngImport: i0, type: NgDocRoutePreloader, decorators: [{
+            type: Service
+        }], ctorParameters: () => [] });
+/**
+ * Whether the reader asked the browser to save data or the connection is 2G, where preloading
+ * would compete with what the reader opens.
+ * @param document - The document of the application.
+ * @returns Whether to skip preloading.
+ */
+function constrainedConnection(document) {
+    const navigator = document.defaultView?.navigator;
+    const connection = navigator?.connection;
+    return (!!connection &&
+        (connection.saveData === true || /(^|-)2g$/.test(connection.effectiveType ?? '')));
+}
+/**
+ * Returns the path segments of the primary outlet of a URL.
+ * @param url - The URL.
+ * @returns The segments.
+ */
+function urlSegments(url) {
+    return url.root.children[PRIMARY_OUTLET]?.segments.map(({ path }) => path) ?? [];
+}
+/**
+ * Returns the routes that can match a path: those whose own path matches its start, through
+ * the children the router has loaded so far. A lazy route whose children have not loaded yet
+ * may lead anywhere below its path.
+ * @param routes - The routes to search.
+ * @param segments - The path segments.
+ * @param found - Collects the routes.
+ * @returns The routes.
+ */
+function routesOnPath(routes, segments, found = new Set()) {
+    for (const route of routes) {
+        if ((route.outlet ?? PRIMARY_OUTLET) !== PRIMARY_OUTLET ||
+            route.matcher ||
+            route.redirectTo !== undefined ||
+            // A guarded route may not match for this reader; only opening the page may decide.
+            route.canMatch?.length) {
+            continue;
+        }
+        const consumed = matchedSegments(route.path ?? '', segments);
+        if (consumed === undefined)
+            continue;
+        const rest = segments.slice(consumed);
+        const children = route.children ?? loadedRoutes(route);
+        // A route without children matches only the whole remaining path.
+        const leaf = !route.children && !route.loadChildren;
+        if ((route.pathMatch === 'full' || leaf) && rest.length)
+            continue;
+        found.add(route);
+        if (children)
+            routesOnPath(children, rest, found);
+    }
+    return found;
+}
+/**
+ * Returns how many segments a route path matches at the start of a path.
+ * @param path - The route path.
+ * @param segments - The path segments.
+ * @returns The number of matched segments, or `undefined` when the route does not match.
+ */
+function matchedSegments(path, segments) {
+    if (!path)
+        return 0;
+    const parts = path.split('/');
+    for (let index = 0; index < parts.length; index++) {
+        const part = parts[index];
+        if (part === '**')
+            return segments.length;
+        if (index >= segments.length)
+            return undefined;
+        if (!part.startsWith(':') && part !== segments[index])
+            return undefined;
+    }
+    return parts.length;
+}
+/**
+ * Returns the children that the router loaded for a lazy route. The router keeps them on the
+ * route itself and has no public API for them; its own preloader reads the same property.
+ * Without it, preloading stops at the first lazy route.
+ * @param route - The route.
+ * @returns The loaded children, if any.
+ */
+function loadedRoutes(route) {
+    return route._loadedRoutes;
+}
+
+/**
+ * The router preloading strategy of NgDoc: it loads a lazy route only when the reader is about
+ * to open one of its pages, as `NgDocRoutePreloader` decides, instead of every route at once.
+ *
+ * Set it as the router's preloading strategy to preload pages on intent:
+ *
+ * ```ts
+ * provideRouter(routes, withPreloading(NgDocPreloadingStrategy));
+ * ```
+ */
+class NgDocPreloadingStrategy {
+    constructor() {
+        this.preloader = inject(NgDocRoutePreloader);
+        // The router creates its preloading strategy at start-up, so this is where preloading on
+        // intent starts.
+        this.preloader.enable();
+    }
+    /**
+     * Loads a lazy route when it leads to a page that is being preloaded.
+     * @param route - A lazy route that the router has not loaded yet.
+     * @param load - Loads the route.
+     * @returns The load, or an observable of `null` when the route is not loaded now.
+     */
+    preload(route, load) {
+        if (!this.preloader.shouldPreload(route))
+            return of(null);
+        // A failed preload is not an error: opening the page loads the route again and reports it.
+        return load().pipe(catchError(() => of(null)));
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.2.1", ngImport: i0, type: NgDocPreloadingStrategy, deps: [], target: i0.ɵɵFactoryTarget.Service }); }
+    static { this.ɵprov = i0.ɵɵngDeclareService({ minVersion: "22.0.0", version: "22.2.1", ngImport: i0, type: NgDocPreloadingStrategy }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.2.1", ngImport: i0, type: NgDocPreloadingStrategy, decorators: [{
+            type: Service
+        }], ctorParameters: () => [] });
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { NgDocPreloadingStrategy, NgDocRoutePreloader };
+//# sourceMappingURL=ng-doc-app-services-route-preloader.mjs.map

package/fesm2022/ng-doc-app-services-route-preloader.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ng-doc-app-services-route-preloader.mjs","sources":["../../../../libs/app/services/route-preloader/route-preloader.service.ts","../../../../libs/app/services/route-preloader/preloading-strategy.ts","../../../../libs/app/services/route-preloader/ng-doc-app-services-route-preloader.ts"],"sourcesContent":["import { isPlatformBrowser, LocationStrategy } from '@angular/common';\nimport {\n  DestroyRef,\n  DOCUMENT,\n  inject,\n  Injector,\n  NgZone,\n  PLATFORM_ID,\n  Service,\n} from '@angular/core';\nimport { PRIMARY_OUTLET, Route, Router, RouterPreloader, UrlTree } from '@angular/router';\nimport { ɵngDocRouteContentSources, ɵpreloadNgDocContent } from '@ng-doc/app/helpers';\nimport { NG_DOC_ROUTE_PREFIX } from '@ng-doc/app/tokens';\n\n/** The events that tell that the reader is about to open a link. */\nconst INTENT_EVENTS = ['pointerover', 'mouseover', 'focusin', 'touchstart'] as const;\n\n/** How long the browser may stay busy before an idle preload runs anyway, in milliseconds. */\nconst IDLE_TIMEOUT = 2000;\n/** The delay of an idle preload where the browser has no `requestIdleCallback`. */\nconst IDLE_FALLBACK_DELAY = 200;\n\n/** The parts of the Network Information API that preloading reads. */\ninterface NgDocNetworkInformation {\n  readonly saveData?: boolean;\n  readonly effectiveType?: string;\n}\n\n/**\n * Preloads the pages that the reader is about to open, so that opening them shows them at once.\n *\n * It preloads a page when the reader points at, focuses or touches a link to it, anywhere in the\n * document: the sidebar, the previous and next page links, links in the page content, search\n * results and the table of contents. It also preloads the previous and next pages of a guide once\n * the browser is idle after the guide has rendered. A preload loads the code of the page's route\n * and its content, once per page. Nothing is preloaded on the server, when the reader asked the\n * browser to save data, or on a 2G connection.\n *\n * The router loads the code through its preloading strategy, so preloading works only when the\n * application sets `NgDocPreloadingStrategy` as that strategy:\n *\n * ```ts\n * provideRouter(routes, withPreloading(NgDocPreloadingStrategy));\n * ```\n */\n@Service()\nexport class NgDocRoutePreloader {\n  private readonly document = inject(DOCUMENT);\n  private readonly injector = inject(Injector);\n  private readonly ngZone = inject(NgZone);\n  private readonly router = inject(Router);\n  private readonly locationStrategy = inject(LocationStrategy);\n  private readonly browser = isPlatformBrowser(inject(PLATFORM_ID));\n  /** The path segments under which the documentation's routes live (`routePrefix`). */\n  private readonly prefix = (inject(NG_DOC_ROUTE_PREFIX, { optional: true }) ?? '')\n    .split('/')\n    .filter(Boolean);\n  /** The pages that were asked for, by path, so each page is preloaded once. */\n  private readonly requested = new Set<string>();\n  /** The paths, as URL segments, whose routes are being loaded. */\n  private readonly loading = new Map<string, readonly string[]>();\n  private enabled = false;\n  private destroyed = false;\n  private lastAnchor?: Element;\n  private cancelIdle?: () => void;\n\n  private readonly intent = (event: Event): void => {\n    const target = event.target;\n    const anchor =\n      typeof Element !== 'undefined' && target instanceof Element\n        ? target.closest('a[href]')\n        : null;\n\n    // Pointer events fire for every element under the pointer, so a link is checked only when\n    // the pointer reaches it.\n    if (!anchor || (anchor === this.lastAnchor && event.type !== 'focusin')) return;\n    this.lastAnchor = anchor;\n\n    const url = this.linkUrl(anchor);\n\n    if (url !== undefined) this.preload(url);\n  };\n\n  constructor() {\n    inject(DestroyRef).onDestroy(() => this.destroy());\n  }\n\n  /**\n   * Turns preloading on and starts listening for links the reader is about to open. Called by\n   * `NgDocPreloadingStrategy` when the router creates it; does nothing on the server.\n   * @internal\n   */\n  enable(): void {\n    if (this.enabled || this.destroyed || !this.browser) return;\n    this.enabled = true;\n\n    const view = this.document.defaultView;\n\n    if (!view) return;\n    // A link the reader points at must not run change detection in a zone application.\n    this.ngZone.runOutsideAngular(() => {\n      INTENT_EVENTS.forEach((type: string) =>\n        this.document.addEventListener(type, this.intent, { capture: true, passive: true }),\n      );\n    });\n  }\n\n  /**\n   * Preloads the code and the content of the page at a URL of the application. A page is\n   * preloaded once; the current page is not preloaded.\n   * @param url - The URL, relative to the application's base, for example `/docs/get-started`.\n   * @returns Whether a preload started.\n   */\n  preload(url: string | UrlTree): boolean {\n    if (!this.active()) return false;\n\n    let segments: string[];\n\n    try {\n      segments = urlSegments(typeof url === 'string' ? this.router.parseUrl(url) : url);\n    } catch {\n      return false;\n    }\n\n    // Only the documentation's own pages are preloaded, never the rest of the application.\n    if (this.prefix.some((part, index) => segments[index] !== part)) return false;\n\n    const key = segments.join('/');\n\n    if (this.requested.has(key) || key === urlSegments(this.currentUrl()).join('/')) return false;\n    this.requested.add(key);\n    this.loading.set(key, segments);\n\n    this.ngZone.runOutsideAngular(() => {\n      this.injector\n        .get(RouterPreloader)\n        .preload()\n        .subscribe({ complete: () => this.loaded(key, segments) });\n    });\n\n    return true;\n  }\n\n  /**\n   * Preloads pages once the browser is idle. A later call replaces the pages of an earlier one\n   * that has not run yet.\n   * @param urls - The URLs of the pages; missing ones are skipped.\n   */\n  preloadWhenIdle(urls: ReadonlyArray<string | undefined>): void {\n    this.cancelIdle?.();\n    this.cancelIdle = undefined;\n\n    const view = this.document.defaultView;\n    const pages = urls.filter((url): url is string => !!url);\n\n    if (!this.active() || !view || !pages.length) return;\n\n    const run = (): void => {\n      this.cancelIdle = undefined;\n      pages.forEach((url: string) => this.preload(url));\n    };\n\n    this.ngZone.runOutsideAngular(() => {\n      if (typeof view.requestIdleCallback === 'function') {\n        const handle = view.requestIdleCallback(run, { timeout: IDLE_TIMEOUT });\n\n        this.cancelIdle = () => view.cancelIdleCallback(handle);\n      } else {\n        const handle = view.setTimeout(run, IDLE_FALLBACK_DELAY);\n\n        this.cancelIdle = () => view.clearTimeout(handle);\n      }\n    });\n  }\n\n  /**\n   * Whether the router should load a lazy route now: the route leads to a page that is being\n   * preloaded.\n   * @param route - A lazy route that the router has not loaded yet.\n   * @returns Whether to load it.\n   * @internal\n   */\n  shouldPreload(route: Route): boolean {\n    if (!this.enabled || this.destroyed) return false;\n    for (const segments of this.loading.values()) {\n      if (routesOnPath(this.router.config, segments).has(route)) return true;\n    }\n    return false;\n  }\n\n  private loaded(key: string, segments: readonly string[]): void {\n    this.loading.delete(key);\n    if (this.destroyed) return;\n\n    const routes = routesOnPath(this.router.config, segments);\n\n    // The strategy turns a failed load into no load, so the router's own preloading survives\n    // it. A route that is still not loaded failed: a later intent may try again.\n    if ([...routes].some((route) => route.loadChildren && !loadedRoutes(route))) {\n      this.requested.delete(key);\n      return;\n    }\n    // The routes of the page have loaded, so the content sources of their components are known.\n    for (const route of routes) {\n      for (const source of ɵngDocRouteContentSources(route)) {\n        ɵpreloadNgDocContent(source).catch(() => undefined);\n      }\n    }\n  }\n\n  private active(): boolean {\n    return this.enabled && !this.destroyed && !constrainedConnection(this.document);\n  }\n\n  private currentUrl(): UrlTree {\n    return this.router.parseUrl(this.router.url);\n  }\n\n  /**\n   * Returns the application URL of a link, or `undefined` for a link that leaves the\n   * application, opens elsewhere, downloads a file or points into the current page.\n   * @param anchor - The link.\n   * @returns The URL relative to the application's base, with its query.\n   */\n  private linkUrl(anchor: Element): string | undefined {\n    const view = this.document.defaultView;\n    const href = anchor.getAttribute('href');\n    const target = anchor.getAttribute('target');\n\n    if (\n      !view ||\n      !href ||\n      anchor.hasAttribute('download') ||\n      (target && target !== '_self') ||\n      href.startsWith('#')\n    ) {\n      return undefined;\n    }\n\n    let url: URL;\n\n    try {\n      url = new URL(href, this.document.baseURI);\n    } catch {\n      return undefined;\n    }\n\n    // Another site, or the current page (an anchor on it, or a link to itself).\n    if (url.origin !== view.location.origin || url.pathname === view.location.pathname) {\n      return undefined;\n    }\n\n    const base = this.basePath();\n\n    if (!`${url.pathname}/`.startsWith(base)) return undefined;\n\n    return `/${url.pathname.slice(base.length)}${url.search}`;\n  }\n\n  /** The base path of the application, ending with a slash. */\n  private basePath(): string {\n    const base = this.locationStrategy.getBaseHref() || '/';\n    const path = new URL(base, this.document.baseURI).pathname;\n\n    return path.endsWith('/') ? path : `${path}/`;\n  }\n\n  private destroy(): void {\n    this.destroyed = true;\n    this.cancelIdle?.();\n    this.cancelIdle = undefined;\n    this.loading.clear();\n    INTENT_EVENTS.forEach((type: string) =>\n      this.document.removeEventListener(type, this.intent, { capture: true }),\n    );\n  }\n}\n\n/**\n * Whether the reader asked the browser to save data or the connection is 2G, where preloading\n * would compete with what the reader opens.\n * @param document - The document of the application.\n * @returns Whether to skip preloading.\n */\nfunction constrainedConnection(document: Document): boolean {\n  const navigator = document.defaultView?.navigator as\n    | (Navigator & { connection?: NgDocNetworkInformation })\n    | undefined;\n  const connection = navigator?.connection;\n\n  return (\n    !!connection &&\n    (connection.saveData === true || /(^|-)2g$/.test(connection.effectiveType ?? ''))\n  );\n}\n\n/**\n * Returns the path segments of the primary outlet of a URL.\n * @param url - The URL.\n * @returns The segments.\n */\nfunction urlSegments(url: UrlTree): string[] {\n  return url.root.children[PRIMARY_OUTLET]?.segments.map(({ path }) => path) ?? [];\n}\n\n/**\n * Returns the routes that can match a path: those whose own path matches its start, through\n * the children the router has loaded so far. A lazy route whose children have not loaded yet\n * may lead anywhere below its path.\n * @param routes - The routes to search.\n * @param segments - The path segments.\n * @param found - Collects the routes.\n * @returns The routes.\n */\nfunction routesOnPath(\n  routes: readonly Route[],\n  segments: readonly string[],\n  found: Set<Route> = new Set(),\n): Set<Route> {\n  for (const route of routes) {\n    if (\n      (route.outlet ?? PRIMARY_OUTLET) !== PRIMARY_OUTLET ||\n      route.matcher ||\n      route.redirectTo !== undefined ||\n      // A guarded route may not match for this reader; only opening the page may decide.\n      route.canMatch?.length\n    ) {\n      continue;\n    }\n\n    const consumed = matchedSegments(route.path ?? '', segments);\n\n    if (consumed === undefined) continue;\n\n    const rest = segments.slice(consumed);\n    const children = route.children ?? loadedRoutes(route);\n    // A route without children matches only the whole remaining path.\n    const leaf = !route.children && !route.loadChildren;\n\n    if ((route.pathMatch === 'full' || leaf) && rest.length) continue;\n\n    found.add(route);\n    if (children) routesOnPath(children, rest, found);\n  }\n\n  return found;\n}\n\n/**\n * Returns how many segments a route path matches at the start of a path.\n * @param path - The route path.\n * @param segments - The path segments.\n * @returns The number of matched segments, or `undefined` when the route does not match.\n */\nfunction matchedSegments(path: string, segments: readonly string[]): number | undefined {\n  if (!path) return 0;\n\n  const parts = path.split('/');\n\n  for (let index = 0; index < parts.length; index++) {\n    const part = parts[index];\n\n    if (part === '**') return segments.length;\n    if (index >= segments.length) return undefined;\n    if (!part.startsWith(':') && part !== segments[index]) return undefined;\n  }\n\n  return parts.length;\n}\n\n/**\n * Returns the children that the router loaded for a lazy route. The router keeps them on the\n * route itself and has no public API for them; its own preloader reads the same property.\n * Without it, preloading stops at the first lazy route.\n * @param route - The route.\n * @returns The loaded children, if any.\n */\nfunction loadedRoutes(route: Route): readonly Route[] | undefined {\n  return (route as Route & { _loadedRoutes?: Route[] })._loadedRoutes;\n}\n","import { inject, Service } from '@angular/core';\nimport { PreloadingStrategy, Route } from '@angular/router';\nimport { catchError, Observable, of } from 'rxjs';\n\nimport { NgDocRoutePreloader } from './route-preloader.service';\n\n/**\n * The router preloading strategy of NgDoc: it loads a lazy route only when the reader is about\n * to open one of its pages, as `NgDocRoutePreloader` decides, instead of every route at once.\n *\n * Set it as the router's preloading strategy to preload pages on intent:\n *\n * ```ts\n * provideRouter(routes, withPreloading(NgDocPreloadingStrategy));\n * ```\n */\n@Service()\nexport class NgDocPreloadingStrategy implements PreloadingStrategy {\n  private readonly preloader = inject(NgDocRoutePreloader);\n\n  constructor() {\n    // The router creates its preloading strategy at start-up, so this is where preloading on\n    // intent starts.\n    this.preloader.enable();\n  }\n\n  /**\n   * Loads a lazy route when it leads to a page that is being preloaded.\n   * @param route - A lazy route that the router has not loaded yet.\n   * @param load - Loads the route.\n   * @returns The load, or an observable of `null` when the route is not loaded now.\n   */\n  preload(route: Route, load: () => Observable<unknown>): Observable<unknown> {\n    if (!this.preloader.shouldPreload(route)) return of(null);\n\n    // A failed preload is not an error: opening the page loads the route again and reports it.\n    return load().pipe(catchError(() => of(null)));\n  }\n}\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":["ɵngDocRouteContentSources","ɵpreloadNgDocContent"],"mappings":";;;;;;;;AAcA;AACA,MAAM,aAAa,GAAG,CAAC,aAAa,EAAE,WAAW,EAAE,SAAS,EAAE,YAAY,CAAU;AAEpF;AACA,MAAM,YAAY,GAAG,IAAI;AACzB;AACA,MAAM,mBAAmB,GAAG,GAAG;AAQ/B;;;;;;;;;;;;;;;;AAgBG;MAEU,mBAAmB,CAAA;AAqC9B,IAAA,WAAA,GAAA;AApCiB,QAAA,IAAA,CAAA,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,QAAA,IAAA,CAAA,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;AAC3B,QAAA,IAAA,CAAA,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;AACvB,QAAA,IAAA,CAAA,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;AACvB,QAAA,IAAA,CAAA,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;QAC3C,IAAA,CAAA,OAAO,GAAG,iBAAiB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;;AAEhD,QAAA,IAAA,CAAA,MAAM,GAAG,CAAC,MAAM,CAAC,mBAAmB,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE;aAC7E,KAAK,CAAC,GAAG;aACT,MAAM,CAAC,OAAO,CAAC;;AAED,QAAA,IAAA,CAAA,SAAS,GAAG,IAAI,GAAG,EAAU;;AAE7B,QAAA,IAAA,CAAA,OAAO,GAAG,IAAI,GAAG,EAA6B;QACvD,IAAA,CAAA,OAAO,GAAG,KAAK;QACf,IAAA,CAAA,SAAS,GAAG,KAAK;AAIR,QAAA,IAAA,CAAA,MAAM,GAAG,CAAC,KAAY,KAAU;AAC/C,YAAA,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM;YAC3B,MAAM,MAAM,GACV,OAAO,OAAO,KAAK,WAAW,IAAI,MAAM,YAAY;AAClD,kBAAE,MAAM,CAAC,OAAO,CAAC,SAAS;kBACxB,IAAI;;;AAIV,YAAA,IAAI,CAAC,MAAM,KAAK,MAAM,KAAK,IAAI,CAAC,UAAU,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC;gBAAE;AACzE,YAAA,IAAI,CAAC,UAAU,GAAG,MAAM;YAExB,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;YAEhC,IAAI,GAAG,KAAK,SAAS;AAAE,gBAAA,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;AAC1C,QAAA,CAAC;AAGC,QAAA,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACpD;AAEA;;;;AAIG;IACH,MAAM,GAAA;QACJ,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE;AACrD,QAAA,IAAI,CAAC,OAAO,GAAG,IAAI;AAEnB,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW;AAEtC,QAAA,IAAI,CAAC,IAAI;YAAE;;AAEX,QAAA,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,MAAK;AACjC,YAAA,aAAa,CAAC,OAAO,CAAC,CAAC,IAAY,KACjC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CACpF;AACH,QAAA,CAAC,CAAC;IACJ;AAEA;;;;;AAKG;AACH,IAAA,OAAO,CAAC,GAAqB,EAAA;AAC3B,QAAA,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;AAAE,YAAA,OAAO,KAAK;AAEhC,QAAA,IAAI,QAAkB;AAEtB,QAAA,IAAI;YACF,QAAQ,GAAG,WAAW,CAAC,OAAO,GAAG,KAAK,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;QACnF;AAAE,QAAA,MAAM;AACN,YAAA,OAAO,KAAK;QACd;;AAGA,QAAA,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC;AAAE,YAAA,OAAO,KAAK;QAE7E,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC;QAE9B,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,WAAW,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;AAAE,YAAA,OAAO,KAAK;AAC7F,QAAA,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC;AAE/B,QAAA,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,MAAK;AACjC,YAAA,IAAI,CAAC;iBACF,GAAG,CAAC,eAAe;AACnB,iBAAA,OAAO;AACP,iBAAA,SAAS,CAAC,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,CAAC;AAC9D,QAAA,CAAC,CAAC;AAEF,QAAA,OAAO,IAAI;IACb;AAEA;;;;AAIG;AACH,IAAA,eAAe,CAAC,IAAuC,EAAA;AACrD,QAAA,IAAI,CAAC,UAAU,IAAI;AACnB,QAAA,IAAI,CAAC,UAAU,GAAG,SAAS;AAE3B,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW;AACtC,QAAA,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,KAAoB,CAAC,CAAC,GAAG,CAAC;AAExD,QAAA,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE;QAE9C,MAAM,GAAG,GAAG,MAAW;AACrB,YAAA,IAAI,CAAC,UAAU,GAAG,SAAS;AAC3B,YAAA,KAAK,CAAC,OAAO,CAAC,CAAC,GAAW,KAAK,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AACnD,QAAA,CAAC;AAED,QAAA,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,MAAK;AACjC,YAAA,IAAI,OAAO,IAAI,CAAC,mBAAmB,KAAK,UAAU,EAAE;AAClD,gBAAA,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC;AAEvE,gBAAA,IAAI,CAAC,UAAU,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC;YACzD;iBAAO;gBACL,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,mBAAmB,CAAC;AAExD,gBAAA,IAAI,CAAC,UAAU,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;YACnD;AACF,QAAA,CAAC,CAAC;IACJ;AAEA;;;;;;AAMG;AACH,IAAA,aAAa,CAAC,KAAY,EAAA;AACxB,QAAA,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,SAAS;AAAE,YAAA,OAAO,KAAK;QACjD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE;AAC5C,YAAA,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC;AAAE,gBAAA,OAAO,IAAI;QACxE;AACA,QAAA,OAAO,KAAK;IACd;IAEQ,MAAM,CAAC,GAAW,EAAE,QAA2B,EAAA;AACrD,QAAA,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC;QACxB,IAAI,IAAI,CAAC,SAAS;YAAE;AAEpB,QAAA,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC;;;QAIzD,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,YAAY,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE;AAC3E,YAAA,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC;YAC1B;QACF;;AAEA,QAAA,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;YAC1B,KAAK,MAAM,MAAM,IAAIA,yBAAyB,CAAC,KAAK,CAAC,EAAE;gBACrDC,oBAAoB,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,MAAM,SAAS,CAAC;YACrD;QACF;IACF;IAEQ,MAAM,GAAA;AACZ,QAAA,OAAO,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,QAAQ,CAAC;IACjF;IAEQ,UAAU,GAAA;AAChB,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;IAC9C;AAEA;;;;;AAKG;AACK,IAAA,OAAO,CAAC,MAAe,EAAA;AAC7B,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW;QACtC,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC;QACxC,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC;AAE5C,QAAA,IACE,CAAC,IAAI;AACL,YAAA,CAAC,IAAI;AACL,YAAA,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC;AAC/B,aAAC,MAAM,IAAI,MAAM,KAAK,OAAO,CAAC;AAC9B,YAAA,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EACpB;AACA,YAAA,OAAO,SAAS;QAClB;AAEA,QAAA,IAAI,GAAQ;AAEZ,QAAA,IAAI;AACF,YAAA,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC5C;AAAE,QAAA,MAAM;AACN,YAAA,OAAO,SAAS;QAClB;;QAGA,IAAI,GAAG,CAAC,MAAM,KAAK,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,GAAG,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;AAClF,YAAA,OAAO,SAAS;QAClB;AAEA,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE;QAE5B,IAAI,CAAC,CAAA,EAAG,GAAG,CAAC,QAAQ,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC;AAAE,YAAA,OAAO,SAAS;AAE1D,QAAA,OAAO,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA,EAAG,GAAG,CAAC,MAAM,EAAE;IAC3D;;IAGQ,QAAQ,GAAA;QACd,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,IAAI,GAAG;AACvD,QAAA,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,QAAQ;AAE1D,QAAA,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,CAAA,EAAG,IAAI,GAAG;IAC/C;IAEQ,OAAO,GAAA;AACb,QAAA,IAAI,CAAC,SAAS,GAAG,IAAI;AACrB,QAAA,IAAI,CAAC,UAAU,IAAI;AACnB,QAAA,IAAI,CAAC,UAAU,GAAG,SAAS;AAC3B,QAAA,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;QACpB,aAAa,CAAC,OAAO,CAAC,CAAC,IAAY,KACjC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CACxE;IACH;8GArOW,mBAAmB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,OAAA,EAAA,CAAA,CAAA;+GAAnB,mBAAmB,EAAA,CAAA,CAAA;;2FAAnB,mBAAmB,EAAA,UAAA,EAAA,CAAA;kBAD/B;;AAyOD;;;;;AAKG;AACH,SAAS,qBAAqB,CAAC,QAAkB,EAAA;AAC/C,IAAA,MAAM,SAAS,GAAG,QAAQ,CAAC,WAAW,EAAE,SAE3B;AACb,IAAA,MAAM,UAAU,GAAG,SAAS,EAAE,UAAU;IAExC,QACE,CAAC,CAAC,UAAU;AACZ,SAAC,UAAU,CAAC,QAAQ,KAAK,IAAI,IAAI,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC;AAErF;AAEA;;;;AAIG;AACH,SAAS,WAAW,CAAC,GAAY,EAAA;IAC/B,OAAO,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,IAAI,CAAC,IAAI,EAAE;AAClF;AAEA;;;;;;;;AAQG;AACH,SAAS,YAAY,CACnB,MAAwB,EACxB,QAA2B,EAC3B,KAAA,GAAoB,IAAI,GAAG,EAAE,EAAA;AAE7B,IAAA,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;QAC1B,IACE,CAAC,KAAK,CAAC,MAAM,IAAI,cAAc,MAAM,cAAc;AACnD,YAAA,KAAK,CAAC,OAAO;YACb,KAAK,CAAC,UAAU,KAAK,SAAS;;AAE9B,YAAA,KAAK,CAAC,QAAQ,EAAE,MAAM,EACtB;YACA;QACF;AAEA,QAAA,MAAM,QAAQ,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,EAAE,QAAQ,CAAC;QAE5D,IAAI,QAAQ,KAAK,SAAS;YAAE;QAE5B,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC;QACrC,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,YAAY,CAAC,KAAK,CAAC;;QAEtD,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,YAAY;AAEnD,QAAA,IAAI,CAAC,KAAK,CAAC,SAAS,KAAK,MAAM,IAAI,IAAI,KAAK,IAAI,CAAC,MAAM;YAAE;AAEzD,QAAA,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC;AAChB,QAAA,IAAI,QAAQ;AAAE,YAAA,YAAY,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC;IACnD;AAEA,IAAA,OAAO,KAAK;AACd;AAEA;;;;;AAKG;AACH,SAAS,eAAe,CAAC,IAAY,EAAE,QAA2B,EAAA;AAChE,IAAA,IAAI,CAAC,IAAI;AAAE,QAAA,OAAO,CAAC;IAEnB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;AAE7B,IAAA,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;AACjD,QAAA,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC;QAEzB,IAAI,IAAI,KAAK,IAAI;YAAE,OAAO,QAAQ,CAAC,MAAM;AACzC,QAAA,IAAI,KAAK,IAAI,QAAQ,CAAC,MAAM;AAAE,YAAA,OAAO,SAAS;AAC9C,QAAA,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,KAAK,QAAQ,CAAC,KAAK,CAAC;AAAE,YAAA,OAAO,SAAS;IACzE;IAEA,OAAO,KAAK,CAAC,MAAM;AACrB;AAEA;;;;;;AAMG;AACH,SAAS,YAAY,CAAC,KAAY,EAAA;IAChC,OAAQ,KAA6C,CAAC,aAAa;AACrE;;ACrXA;;;;;;;;;AASG;MAEU,uBAAuB,CAAA;AAGlC,IAAA,WAAA,GAAA;AAFiB,QAAA,IAAA,CAAA,SAAS,GAAG,MAAM,CAAC,mBAAmB,CAAC;;;AAKtD,QAAA,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE;IACzB;AAEA;;;;;AAKG;IACH,OAAO,CAAC,KAAY,EAAE,IAA+B,EAAA;QACnD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC;AAAE,YAAA,OAAO,EAAE,CAAC,IAAI,CAAC;;AAGzD,QAAA,OAAO,IAAI,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAChD;8GApBW,uBAAuB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,OAAA,EAAA,CAAA,CAAA;+GAAvB,uBAAuB,EAAA,CAAA,CAAA;;2FAAvB,uBAAuB,EAAA,UAAA,EAAA,CAAA;kBADnC;;;AChBD;;AAEG;;;;"}

package/fesm2022/ng-doc-app-services-shortcuts.mjs

@@ -0,0 +1,214 @@
+import * as i0 from '@angular/core';
+import { InjectionToken, inject, DOCUMENT, Injector, NgZone, PLATFORM_ID, signal, computed, afterNextRender, DestroyRef, untracked, Service } from '@angular/core';
+import { isPlatformBrowser } from '@angular/common';
+import { NgDocStoreService } from '@ng-doc/app/services/store';
+import { NgDocThemeService } from '@ng-doc/app/services/theme';
+
+/**
+ * Whether single-key shortcuts are on for readers who have not turned them on or off themselves.
+ * The default is true. Set it with the shortcuts option of provideNgDocApp.
+ */
+const NG_DOC_SHORTCUTS = new InjectionToken('NG_DOC_SHORTCUTS', { factory: () => true });
+/**
+ * The local storage key that keeps a reader's choice to turn single-key shortcuts on ("1") or off
+ * ("0").
+ */
+const NG_DOC_STORE_SHORTCUTS_KEY = 'ng-doc-shortcuts';
+
+/**
+ * Elements where a single key types text or drives the widget instead of running a shortcut:
+ * fields, widgets with their own key handling or typeahead, and demos and playgrounds, which
+ * host the reader's components.
+ */
+const OWN_KEYS = [
+    'input',
+    'textarea',
+    'select',
+    '[contenteditable]:not([contenteditable="false"])',
+    ...[
+        'combobox',
+        'listbox',
+        'menu',
+        'menubar',
+        'grid',
+        'tree',
+        'treegrid',
+        'slider',
+        'spinbutton',
+        'application',
+    ].map((role) => `[role="${role}"]`),
+    'ng-doc-demo',
+    'ng-doc-demo-pane',
+    'ng-doc-playground',
+].join(', ');
+/**
+ * Keyboard shortcuts of the documentation.
+ *
+ * Single-key shortcuts (slash opens the search, the square brackets open the previous and next
+ * page, F focuses the filter of the page, L copies the link to the page and T switches between
+ * the light and the dark theme) are on by default. Readers turn them all off with one switch, and
+ * the choice is saved in the browser. A site turns them off by default with the shortcuts option
+ * of provideNgDocApp. They never run while the reader types in a field or holds Command, Control
+ * or Alt. Chords such as Command+K (Control+K) always work.
+ */
+class NgDocShortcutsService {
+    constructor() {
+        this.document = inject(DOCUMENT);
+        this.injector = inject(Injector);
+        this.ngZone = inject(NgZone);
+        this.browser = isPlatformBrowser(inject(PLATFORM_ID));
+        this.appDefault = inject(NG_DOC_SHORTCUTS);
+        this.userChoice = signal(undefined, /* @ts-ignore */
+        ...(ngDevMode ? [{ debugName: "userChoice" }] : /* istanbul ignore next */ []));
+        this.shortcuts = [];
+        /**
+         * Whether single-key shortcuts are on: the reader's saved choice, or the site's default.
+         * Components hide the hints of single-key shortcuts while it is false.
+         */
+        this.enabled = computed(() => this.userChoice() ?? this.appDefault, /* @ts-ignore */
+        ...(ngDevMode ? [{ debugName: "enabled" }] : /* istanbul ignore next */ []));
+        this.registerDefaults();
+        if (!this.browser) {
+            return;
+        }
+        // The saved choice is read after the first render, so a hydrated page first renders exactly
+        // what the server rendered (the site's default) and then switches.
+        afterNextRender(() => this.userChoice.set(this.readChoice()), { injector: this.injector });
+        const listener = (event) => this.onKeydown(event);
+        // One document listener for every shortcut; change detection runs only when one matches.
+        this.ngZone.runOutsideAngular(() => this.document.addEventListener('keydown', listener));
+        inject(DestroyRef).onDestroy(() => this.document.removeEventListener('keydown', listener));
+    }
+    /**
+     * Turns single-key shortcuts on or off for this reader and saves the choice in the browser.
+     * @param enabled - Whether single-key shortcuts should run.
+     */
+    setEnabled(enabled) {
+        this.userChoice.set(enabled);
+        if (this.browser) {
+            try {
+                this.injector.get(NgDocStoreService).set(NG_DOC_STORE_SHORTCUTS_KEY, enabled ? '1' : '0');
+            }
+            catch {
+                // Storage can be unavailable (private mode, blocked cookies); the choice lasts the visit.
+            }
+        }
+    }
+    /** Turns single-key shortcuts off when they are on, and on when they are off. */
+    toggle() {
+        this.setEnabled(!untracked(this.enabled));
+    }
+    /**
+     * Registers a shortcut. When several shortcuts use the same key, the one registered last runs,
+     * so a page can take over a key while it is shown and give it back when it is destroyed.
+     * @param shortcut - The shortcut to register.
+     * @returns A function that removes the shortcut.
+     */
+    register(shortcut) {
+        this.shortcuts.push(shortcut);
+        return () => {
+            const index = this.shortcuts.lastIndexOf(shortcut);
+            if (index !== -1) {
+                this.shortcuts.splice(index, 1);
+            }
+        };
+    }
+    /**
+     * Runs the single-key shortcut registered for a key, as if the reader pressed it, even while
+     * single-key shortcuts are off. The search palette uses it for its actions.
+     * @param key - The key of the shortcut, for example 't'.
+     * @returns Whether a shortcut is registered for the key.
+     */
+    run(key) {
+        const shortcut = this.find(key.toLowerCase(), false);
+        untracked(() => shortcut?.handler());
+        return !!shortcut;
+    }
+    onKeydown(event) {
+        if (event.defaultPrevented || event.isComposing || event.repeat || !event.key) {
+            return;
+        }
+        // AltGr (Control+Alt on Windows) types characters such as [ and ] on many layouts: those
+        // keys are plain characters, not chords.
+        const altGraph = !!event.getModifierState?.('AltGraph');
+        const chord = !altGraph && (event.metaKey || event.ctrlKey) && !event.altKey;
+        const shortcut = this.find(event.key.toLowerCase(), chord);
+        if (!shortcut || (!chord && !this.acceptsSingleKey(event, altGraph))) {
+            return;
+        }
+        event.preventDefault();
+        this.ngZone.run(() => untracked(() => shortcut.handler(event)));
+    }
+    find(key, chord) {
+        for (let index = this.shortcuts.length - 1; index >= 0; index--) {
+            const shortcut = this.shortcuts[index];
+            if (shortcut.key.toLowerCase() === key && !!shortcut.chord === chord) {
+                return shortcut;
+            }
+        }
+        return undefined;
+    }
+    acceptsSingleKey(event, altGraph) {
+        if (!untracked(this.enabled) ||
+            event.metaKey ||
+            (!altGraph && (event.ctrlKey || event.altKey))) {
+            return false;
+        }
+        const target = event.composedPath?.()[0] ?? event.target;
+        return !(target instanceof Element && target.closest(OWN_KEYS));
+    }
+    readChoice() {
+        try {
+            const saved = this.injector.get(NgDocStoreService).get(NG_DOC_STORE_SHORTCUTS_KEY);
+            return saved === '1' ? true : saved === '0' ? false : undefined;
+        }
+        catch {
+            return undefined;
+        }
+    }
+    registerDefaults() {
+        this.register({ key: 't', handler: () => this.toggleDarkTheme() });
+        this.register({ key: 'l', handler: () => this.copyLink() });
+        // Pager links: rel="prev"/"next" is the standard marker; the classes are the NgDoc pager's.
+        this.register({ key: '[', handler: () => this.click('a[rel~="prev"], a.ng-doc-prev-page') });
+        this.register({ key: ']', handler: () => this.click('a[rel~="next"], a.ng-doc-next-page') });
+    }
+    toggleDarkTheme() {
+        const themeService = this.injector.get(NgDocThemeService);
+        const theme = themeService.theme();
+        const toggle = this.themeToggle;
+        // A second T restores the theme the first one replaced (auto or a custom theme), unless the
+        // reader changed the theme in between.
+        if (toggle && toggle.set === theme) {
+            this.themeToggle = undefined;
+            themeService.set(toggle.previous ?? undefined);
+            return;
+        }
+        const dark = theme === 'dark' ||
+            (theme === 'auto' &&
+                !!this.document.defaultView?.matchMedia?.('(prefers-color-scheme: dark)').matches);
+        const next = dark ? null : 'dark';
+        this.themeToggle = { previous: theme, set: next };
+        themeService.set(next ?? undefined);
+    }
+    copyLink() {
+        void this.document.defaultView?.navigator.clipboard
+            ?.writeText(this.document.location.href)
+            .catch(() => undefined);
+    }
+    click(selector) {
+        this.document.querySelector(selector)?.click();
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.2.1", ngImport: i0, type: NgDocShortcutsService, deps: [], target: i0.ɵɵFactoryTarget.Service }); }
+    static { this.ɵprov = i0.ɵɵngDeclareService({ minVersion: "22.0.0", version: "22.2.1", ngImport: i0, type: NgDocShortcutsService }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.2.1", ngImport: i0, type: NgDocShortcutsService, decorators: [{
+            type: Service
+        }], ctorParameters: () => [] });
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { NG_DOC_SHORTCUTS, NG_DOC_STORE_SHORTCUTS_KEY, NgDocShortcutsService };
+//# sourceMappingURL=ng-doc-app-services-shortcuts.mjs.map