@ethlete/core 4.21.4 → 4.22.0

package/lib/utils/signal.utils.d.ts

@@ -1,6 +1,7 @@
 import { EffectRef, ElementRef, Injector, QueryList, Signal, WritableSignal } from '@angular/core';
 import { AbstractControl, FormControl } from '@angular/forms';
 import { Observable } from 'rxjs';
+import { RouterState } from '../services';
 import { Breakpoint } from '../types';
 type SignalElementBindingComplexType = HTMLElement | ElementRef<HTMLElement> | QueryList<ElementRef<HTMLElement> | HTMLElement> | Array<ElementRef<HTMLElement> | HTMLElement> | null | undefined;
 type SignalElementBindingType = HTMLElement | ElementRef<HTMLElement> | Observable<SignalElementBindingComplexType> | Signal<SignalElementBindingComplexType> | QueryList<ElementRef<HTMLElement> | HTMLElement> | ElementSignal;
@@ -162,24 +163,50 @@ export type InjectUtilTransformConfig<In, Out> = {
      */
     transform?: (value: In) => Out;
 };
-export declare const injectOrRunInContext: <T>(fn: () => T, config?: InjectUtilConfig) => T;
 export declare const transformOrReturn: <In, Out>(src: Signal<In>, config?: InjectUtilTransformConfig<In, Out>) => Signal<Out>;
+/** Inject the current router event */
+export declare const injectRouterEvent: () => Signal<import("@angular/router").Event | null>;
+/**
+ * Inject the current url.
+ * The url includes query params as well as the fragment. Use `injectRoute` instead if you are not intrusted in those.
+ * @example "/my-page?query=1&param=true#fragment"
+ */
+export declare const injectUrl: () => Signal<string>;
+/**
+ * Inject the current route
+ * @example "/my-page"
+ */
+export declare const injectRoute: () => Signal<string>;
+/**
+ * Inject the complete router state. This includes the current route data, path params, query params, title and fragment.
+ */
+export declare const injectRouterState: () => Signal<RouterState>;
 /** Inject a signal containing the current route fragment (the part after the # inside the url if present) */
 export declare const injectFragment: <T = string | null>(config?: InjectUtilConfig & InjectUtilTransformConfig<string | null, T>) => Signal<T>;
 /** Inject all currently available query parameters as a signal */
-export declare const injectQueryParams: (config?: InjectUtilConfig) => Signal<import("@angular/router").Params>;
+export declare const injectQueryParams: () => Signal<import("@angular/router").Params>;
 /** Inject all currently available route data as a signal */
-export declare const injectRouteData: (config?: InjectUtilConfig) => Signal<import("@angular/router").Data>;
+export declare const injectRouteData: () => Signal<import("@angular/router").Data>;
 /** Inject the current route title as a signal */
-export declare const injectRouteTitle: <T = string | null>(config?: InjectUtilConfig & InjectUtilTransformConfig<string | null, T>) => Signal<T>;
+export declare const injectRouteTitle: <T = string | null>(config?: InjectUtilTransformConfig<string | null, T>) => Signal<T>;
 /** Inject all currently available path parameters as a signal */
-export declare const injectPathParams: (config?: InjectUtilConfig) => Signal<import("@angular/router").Params>;
+export declare const injectPathParams: () => Signal<import("@angular/router").Params>;
 /** Inject a specific query parameter as a signal */
-export declare const injectQueryParam: <T = string | null>(key: string, config?: InjectUtilConfig & InjectUtilTransformConfig<string | null, T>) => Signal<T>;
+export declare const injectQueryParam: <T = string | null>(key: string, config?: InjectUtilTransformConfig<string | null, T>) => Signal<T>;
 /** Inject a specific route data item as a signal */
-export declare const injectRouteDataItem: <T = unknown>(key: string, config?: InjectUtilConfig & InjectUtilTransformConfig<unknown, T>) => Signal<T>;
+export declare const injectRouteDataItem: <T = unknown>(key: string, config?: InjectUtilTransformConfig<unknown, T>) => Signal<T>;
 /** Inject a specific path parameter as a signal */
-export declare const injectPathParam: <T = string | null>(key: string, config?: InjectUtilConfig & InjectUtilTransformConfig<string | null, T>) => Signal<T>;
+export declare const injectPathParam: <T = string | null>(key: string, config?: InjectUtilTransformConfig<string | null, T>) => Signal<T>;
+/**
+ * Inject query params that changed during navigation. Unchanged query params will be ignored.
+ * Removed query params will be represented by the symbol `ET_PROPERTY_REMOVED`.
+ */
+export declare const injectQueryParamChanges: () => Signal<Record<string, unknown>>;
+/**
+ * Inject path params that changed during navigation. Unchanged path params will be ignored.
+ * Removed path params will be represented by the symbol `ET_PROPERTY_REMOVED`.
+ */
+export declare const injectPathParamChanges: () => Signal<Record<string, unknown>>;
 export declare const createIsRenderedSignal: () => {
     state: WritableSignal<boolean>;
     bind: () => EffectRef;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethlete/core",
-  "version": "4.21.4",
+  "version": "4.22.0",
   "peerDependencies": {
     "@angular/cdk": "^18.1.0",
     "@angular/common": "^18.1.0",