@bootkit/ng0 0.0.0-alpha.4 → 0.0.0-alpha.41

package/routing/index.d.ts

@@ -0,0 +1,124 @@
+import { Observable } from 'rxjs';
+import { ActivatedRouteSnapshot, UrlTree, RouterStateSnapshot, Route as Route$1 } from '@angular/router';
+import { ClaimLike } from '@bootkit/ng0/common';
+import * as i0 from '@angular/core';
+
+/**
+ * A function that resolves a title from the route and router state
+ */
+type RouteTitleResolver = (route: ActivatedRouteSnapshot, state: RouterStateSnapshot) => string;
+/**
+ * A router link value.
+ */
+type RouterLinkValue = any[] | string | UrlTree | null | undefined;
+/**
+ * A function that resolves a router link.
+ * @param route The activated route snapshot
+ * @param state The router state snapshot
+ * @returns The resolved link (RouteDataLink)
+ */
+type RouterLinkValueResolver = (route: ActivatedRouteSnapshot, state: RouterStateSnapshot) => RouterLinkValue;
+/**
+ * A function that resolves a meta description.
+ * @param route The activated route snapshot
+ * @param state The router state snapshot
+ * @returns The resolved meta description string
+ */
+type RouteMetaDescriptionResolver = (route: ActivatedRouteSnapshot, state: RouterStateSnapshot) => string;
+/**
+ * A function that resolves meta tags from the route and router state
+ */
+type RouteMetaTagResolver = (route: ActivatedRouteSnapshot, state: RouterStateSnapshot) => {
+    [metaTagName: string]: string;
+};
+/**
+ * Route data
+ */
+interface RouteData {
+    /**
+     * The title of the route, or a function that resolves the title.
+     */
+    title?: string | RouteTitleResolver;
+    /**
+     * A Router link defined for the route.
+     */
+    link?: RouterLinkValue | RouterLinkValueResolver;
+    /**
+     * linkTarget
+     */
+    linkTarget?: '_self' | '_blank' | '_parent' | '_top';
+    /**
+     * meta
+     */
+    meta?: string | RouteMetaTagResolver | RouteMetaDescriptionResolver;
+    /**
+     * Route security claim.
+     */
+    claim?: ClaimLike;
+    /**
+     * Route childreen.
+     */
+    children?: RouteData[];
+    [key: string]: any;
+}
+/**
+ * Router Activated Route Snapshot.
+ * Represents the state of an activated route in the router.
+ */
+interface RouterActivatedRouteSnapshot {
+    /**
+     * The original ActivatedRouteSnapshot
+     */
+    activatedRoute: ActivatedRouteSnapshot;
+    /**
+     * Resolved title, if any
+     */
+    title?: string;
+    /**
+     * Resolved link, if any
+     */
+    link: RouterLinkValue;
+    /**
+     * Children routes
+     */
+    children: RouterActivatedRouteSnapshot[];
+}
+/**
+ * Extended Angular Route interface with additional data property.
+ */
+interface Route extends Route$1 {
+    children?: Routes;
+    data?: RouteData;
+}
+type Routes = Route[];
+
+/**
+ * Service to interact with Angular Router.
+ */
+declare class RouterService {
+    private readonly _router;
+    /**
+     * Get activated route tree.
+     * @param outlets List of outlets to include, default is ['primary']
+     * @returns Observable of the activated route tree
+     */
+    getActivatedRouteTree(outlets?: string[]): Observable<RouterActivatedRouteSnapshot>;
+    /**
+     * Get activated routes as a flat array from root to the deepest child for a specific outlet.
+     * @param outlet The outlet to include, default is 'primary'
+     * @returns Observable of the activated routes array
+     */
+    getActivatedRoutes(outlet?: string): Observable<RouterActivatedRouteSnapshot[]>;
+    /**
+     * Map a route to RouterRouteSnapshot
+     * @param route The route to map
+     * @param outlets The outlets to include
+     * @returns The mapped RouterRouteSnapshot
+     */
+    private _mapRoute;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RouterService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<RouterService>;
+}
+
+export { RouterService };
+export type { Route, RouteData, RouteMetaDescriptionResolver, RouteMetaTagResolver, RouteTitleResolver, RouterActivatedRouteSnapshot, RouterLinkValue, RouterLinkValueResolver, Routes };

package/utils/index.d.ts

@@ -0,0 +1,42 @@
+import * as _angular_core from '@angular/core';
+
+/**
+ * Easing function type definition.
+ */
+type EasingFn = (t: number) => number;
+/**
+ * A counter that animates a numeric value from a start to an end value over a specified duration using an easing function.
+ */
+declare class Counter {
+    readonly from: number;
+    readonly to: number;
+    readonly duration: number;
+    private _subscription?;
+    readonly value: _angular_core.WritableSignal<number>;
+    readonly running: _angular_core.WritableSignal<boolean>;
+    readonly easing: EasingFn;
+    constructor(from: number, to: number, duration?: number, easing?: EasingFn, currentValue?: number);
+    /**
+     * Resets the counter and starts it.
+     * This method should be called in a browser environment.
+     * @returns void
+     */
+    start(): void;
+    /**
+     * Stops the counter animation.
+     */
+    stop(): void;
+}
+/**
+ * A collection of common easing functions for animations.
+ */
+declare const easingFunctions: {
+    linear: (t: number) => number;
+    easeIn: (t: number) => number;
+    easeOut: (t: number) => number;
+    easeInOut: (t: number) => number;
+    smooth: (t: number) => number;
+};
+
+export { Counter, easingFunctions };
+export type { EasingFn };