@mmstack/router-core 19.3.11 → 20.0.0

package/lib/link.directive.d.ts

@@ -1,51 +0,0 @@
-import { Provider } from '@angular/core';
-import { type ActivatedRoute, type Params, UrlTree } from '@angular/router';
-import * as i0 from "@angular/core";
-import * as i1 from "@angular/router";
-export declare function injectTriggerPreload(): (link: string | any[] | UrlTree | null, relativeTo?: ActivatedRoute, queryParams?: Params, fragment?: string, queryParamsHandling?: "merge" | "preserve" | "") => void;
-/**
- * Configuration for the `mmLink` directive.
- */
-type MMLinkConfig = {
-    /**
-     * The default preload behavior for links.
-     * Can be 'hover', 'visible', or null (no preloading).
-     * @default 'hover'
-     */
-    preloadOn: 'hover' | 'visible' | null;
-    /**
-     * Whether to use mouse down events for preloading.
-     * @default false
-     */
-    useMouseDown: boolean;
-};
-export declare function provideMMLinkDefaultConfig(config: Partial<MMLinkConfig>): Provider;
-export declare class LinkDirective {
-    private readonly routerLink;
-    private readonly svc;
-    private readonly router;
-    readonly target: import("@angular/core").InputSignal<string | undefined>;
-    readonly queryParams: import("@angular/core").InputSignal<Params | undefined>;
-    readonly fragment: import("@angular/core").InputSignal<string | undefined>;
-    readonly queryParamsHandling: import("@angular/core").InputSignal<"" | "merge" | "preserve" | undefined>;
-    readonly state: import("@angular/core").InputSignal<Record<string, any> | undefined>;
-    readonly info: import("@angular/core").InputSignal<unknown>;
-    readonly relativeTo: import("@angular/core").InputSignal<ActivatedRoute | undefined>;
-    readonly skipLocationChange: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
-    readonly replaceUrl: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
-    readonly mmLink: import("@angular/core").InputSignal<string | any[] | UrlTree | null>;
-    readonly preloadOn: import("@angular/core").InputSignal<"hover" | "visible" | null>;
-    readonly useMouseDown: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
-    readonly preloading: import("@angular/core").OutputEmitterRef<void>;
-    private readonly urlTree;
-    private readonly fullPath;
-    onHover(): void;
-    onMouseDown(button: number, ctrlKey: boolean, shiftKey: boolean, altKey: boolean, metaKey: boolean): boolean | undefined;
-    onClick(button: number, ctrlKey: boolean, shiftKey: boolean, altKey: boolean, metaKey: boolean): boolean | undefined;
-    constructor();
-    private requestPreload;
-    private trigger;
-    static ɵfac: i0.ɵɵFactoryDeclaration<LinkDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<LinkDirective, "[mmLink]", ["mmLink"], { "target": { "alias": "target"; "required": false; "isSignal": true; }; "queryParams": { "alias": "queryParams"; "required": false; "isSignal": true; }; "fragment": { "alias": "fragment"; "required": false; "isSignal": true; }; "queryParamsHandling": { "alias": "queryParamsHandling"; "required": false; "isSignal": true; }; "state": { "alias": "state"; "required": false; "isSignal": true; }; "info": { "alias": "info"; "required": false; "isSignal": true; }; "relativeTo": { "alias": "relativeTo"; "required": false; "isSignal": true; }; "skipLocationChange": { "alias": "skipLocationChange"; "required": false; "isSignal": true; }; "replaceUrl": { "alias": "replaceUrl"; "required": false; "isSignal": true; }; "mmLink": { "alias": "mmLink"; "required": false; "isSignal": true; }; "preloadOn": { "alias": "preloadOn"; "required": false; "isSignal": true; }; "useMouseDown": { "alias": "useMouseDown"; "required": false; "isSignal": true; }; }, { "preloading": "preloading"; }, never, never, true, [{ directive: typeof i1.RouterLink; inputs: { "routerLink": "mmLink"; "target": "target"; "queryParams": "queryParams"; "fragment": "fragment"; "queryParamsHandling": "queryParamsHandling"; "state": "state"; "relativeTo": "relativeTo"; "skipLocationChange": "skipLocationChange"; "replaceUrl": "replaceUrl"; }; outputs: {}; }]>;
-}
-export {};

package/lib/preloading/index.d.ts

@@ -1,2 +0,0 @@
-export * from './preload.service';
-export * from './preload.strategy';

package/lib/preloading/preload.service.d.ts

@@ -1,8 +0,0 @@
-import * as i0 from "@angular/core";
-export declare class PreloadService {
-    private readonly preloadOnDemand$;
-    readonly preloadRequested$: import("rxjs").Observable<string>;
-    startPreload(routePath: string): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<PreloadService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<PreloadService>;
-}

package/lib/preloading/preload.strategy.d.ts

@@ -1,11 +0,0 @@
-import { PreloadingStrategy, type Route } from '@angular/router';
-import { Observable } from 'rxjs';
-import * as i0 from "@angular/core";
-export declare class PreloadStrategy implements PreloadingStrategy {
-    private readonly loading;
-    private readonly router;
-    private readonly svc;
-    preload(route: Route, load: () => Observable<any>): Observable<any>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<PreloadStrategy, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<PreloadStrategy>;
-}

package/lib/preloading/public_api.d.ts

@@ -1 +0,0 @@
-export { PreloadStrategy } from './preload.strategy';

package/lib/query-param.d.ts

@@ -1,78 +0,0 @@
-import { type WritableSignal } from '@angular/core';
-/**
- * Creates a WritableSignal that synchronizes with a specific URL query parameter,
- * enabling two-way binding between the signal's state and the URL.
- *
- * Reading the signal provides the current value of the query parameter (or null if absent).
- * Setting the signal updates the URL query parameter using `Router.navigate`, triggering
- * navigation and causing the signal to update reactively if the navigation is successful.
- *
- * @param key The key of the query parameter to synchronize with.
- * Can be a static string (e.g., `'search'`) or a function/signal returning a string
- * for dynamic keys (e.g., `() => this.userId() + '_filter'` or `computed(() => this.category() + '_sort')`).
- * The signal will reactively update if the key returned by the function/signal changes.
- * @returns {WritableSignal<string | null>} A signal representing the query parameter's value.
- * - Reading returns the current value string, or `null` if the parameter is absent in the URL.
- * - Setting the signal to a string updates the query parameter in the URL (e.g., `signal.set('value')` results in `?key=value`).
- * - Setting the signal to `null` removes the query parameter from the URL (e.g., `signal.set(null)` results in `?otherParam=...`).
- * - Automatically reflects changes if the query parameters update due to external navigation.
- * @remarks
- * - Requires Angular's `ActivatedRoute` and `Router` to be available in the injection context.
- * - Uses `Router.navigate` with `queryParamsHandling: 'merge'` to preserve other existing query parameters during updates.
- * - Handles dynamic keys reactively. If the result of the `key` function/signal changes, the signal will start reflecting the value of the *new* query parameter key.
- * - During Server-Side Rendering (SSR), it reads the initial value from the route snapshot. Write operations (`set`) might have limited or no effect on the server depending on the platform configuration.
- *
- * @example
- * ```ts
- * import { Component, computed, effect, signal } from '@angular/core';
- * import { queryParam } from '@mmstack/router-core'; // Adjust import path as needed
- * // import { FormsModule } from '@angular/forms'; // If using ngModel
- *
- * @Component({
- * selector: 'app-product-list',
- * standalone: true,
- * // imports: [FormsModule], // If using ngModel
- * template: `
- * <div>
- * Sort By:
- * <select [value]="sortSignal() ?? ''" (change)="sortSignal.set($any($event.target).value || null)">
- * <option value="">Default</option>
- * <option value="price_asc">Price Asc</option>
- * <option value="price_desc">Price Desc</option>
- * <option value="name">Name</option>
- * </select>
- * <button (click)="sortSignal.set(null)" [disabled]="!sortSignal()">Clear Sort</button>
- * </div>
- * <div>
- * Page:
- * <input type="number" min="1" [value]="pageSignal() ?? '1'" #p (input)="setPage(p.value)"/>
- * </div>
- * * `
- * })
- * export class ProductListComponent {
- * // Two-way bind the 'sort' query parameter (?sort=...)
- * // Defaults to null if param is missing
- * sortSignal = queryParam('sort');
- *
- * // Example with a different type (needs serialization or separate logic)
- * // For simplicity, we treat page as string | null here
- * pageSignal = queryParam('page');
- *
- * constructor() {
- * effect(() => {
- * const currentSort = this.sortSignal();
- * const currentPage = this.pageSignal(); // Read as string | null
- * console.log('Sort/Page changed, reloading products for:', { sort: currentSort, page: currentPage });
- * // --- Fetch data based on currentSort and currentPage ---
- * });
- * }
- *
- * setPage(value: string): void {
- * const pageNum = parseInt(value, 10);
- * // Set to null if page is 1 (to remove param), otherwise set string value
- * this.pageSignal.set(isNaN(pageNum) || pageNum <= 1 ? null : pageNum.toString());
- * }
- * }
- * ```
- */
-export declare function queryParam(key: string | (() => string)): WritableSignal<string | null>;

package/lib/title/public_api.d.ts

@@ -1,2 +0,0 @@
-export { provideTitleConfig, TitleConfig } from './title.config';
-export { createTitle } from './title.store';

package/lib/title/title.config.d.ts

@@ -1,31 +0,0 @@
-import { Provider } from '@angular/core';
-/**
- * Title configuration interface.
- * Defines how createTitle should behave
- * @see {createTitle}
- */
-export type TitleConfig = {
-    /**
-     * The title to be used when no title is set.
-     * If not provided it defaults to an empty string
-     * @default ''
-     */
-    prefix?: string | ((title: string) => string);
-    /**
-     * if false, the title will change to the url, otherwise default to true as that is standard behavior
-     * @default true
-     */
-    keepLastKnownTitle?: boolean;
-};
-/**
- * @internal
- */
-export type InternalTitleConfig = {
-    parser: (title: string) => string;
-    keepLastKnown: boolean;
-};
-/**
- * used to provide the title configuration, will not be applied unless a `createTitle` resolver is used
- */
-export declare function provideTitleConfig(config?: TitleConfig): Provider;
-export declare function injectTitleConfig(): InternalTitleConfig;

package/lib/title/title.store.d.ts

@@ -1,23 +0,0 @@
-import { Signal } from '@angular/core';
-import { ResolveFn } from '@angular/router';
-import * as i0 from "@angular/core";
-export declare class TitleStore {
-    private readonly title;
-    private readonly map;
-    private readonly leafRoutes;
-    constructor();
-    register(id: string, titleFn: Signal<string>): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TitleStore, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<TitleStore>;
-}
-/**
- *
- * Creates a title resolver function that can be used in Angular's router.
- *
- * @param fn
- * A function that returns a string or a Signal<string> representing the title.
- * @param awaitValue
- * If `true`, the resolver will wait until the title signal has a value before resolving.
- * Defaults to `false`.
- */
-export declare function createTitle(fn: () => string | (() => string), awaitValue?: boolean): ResolveFn<string>;

package/lib/url.d.ts

@@ -1,32 +0,0 @@
-import { type Signal } from '@angular/core';
-/**
- * Creates a Signal that tracks the current router URL.
- *
- * The signal emits the URL string reflecting the router state *after* redirects
- * have completed for each successful navigation. It initializes with the router's
- * current URL state.
- *
- * @returns {Signal<string>} A Signal emitting the `urlAfterRedirects` upon successful navigation.
- *
- * @example
- * ```ts
- * import { Component, effect } from '@angular/core';
- * import { url } from '@mmstack/router-core'; // Adjust import path
- *
- * @Component({
- * selector: 'app-root',
- * template: `Current URL: {{ currentUrl() }}`
- * })
- * export class AppComponent {
- * currentUrl = url();
- *
- * constructor() {
- * effect(() => {
- * console.log('Navigation ended. New URL:', this.currentUrl());
- * // e.g., track page view with analytics
- * });
- * }
- * }
- * ```
- */
-export declare function url(): Signal<string>;

package/lib/util/create-route-predicate.d.ts

@@ -1 +0,0 @@
-export declare function createRoutePredicate(path: string): (linkPath: string) => boolean;

package/lib/util/find-path.d.ts

@@ -1,2 +0,0 @@
-import { Route } from '@angular/router';
-export declare const findPath: (config: Route[], route: Route) => string;

package/lib/util/index.d.ts

@@ -1,4 +0,0 @@
-export * from './create-route-predicate';
-export * from './find-path';
-export * from './leaf.store';
-export * from './snapshot-path';

package/lib/util/leaf.store.d.ts

@@ -1,21 +0,0 @@
-import { Signal } from '@angular/core';
-import { ActivatedRouteSnapshot } from '@angular/router';
-import * as i0 from "@angular/core";
-/**
- * @internal
- */
-export type ResolvedLeafRoute = {
-    route: ActivatedRouteSnapshot;
-    segment: {
-        path: string;
-        resolved: string;
-    };
-    path: string;
-    link: string;
-};
-export declare class RouteLeafStore {
-    readonly leaves: Signal<ResolvedLeafRoute[]>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<RouteLeafStore, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<RouteLeafStore>;
-}
-export declare function injectLeafRoutes(): Signal<ResolvedLeafRoute[]>;

package/lib/util/snapshot-path.d.ts

@@ -1,2 +0,0 @@
-import { ActivatedRouteSnapshot } from '@angular/router';
-export declare function injectSnapshotPathResolver(): (route: ActivatedRouteSnapshot) => string;