ngx-lift 1.1.0 → 1.3.0

package/lib/signals/combine-from.d.ts

@@ -1,15 +1,25 @@
 import { Injector, Signal } from '@angular/core';
 import { ObservableInput, OperatorFunction } from 'rxjs';
-export type ObservableSignalInput<T> = ObservableInput<T> | Signal<T>;
-export type CombineFromOptions<T> = {
-    readonly injector?: Injector;
-    readonly initialValue?: T | null;
-};
+type ObservableSignalInput<T> = ObservableInput<T> | Signal<T>;
 type ObservableSignalInputTuple<T> = {
     [K in keyof T]: ObservableSignalInput<T[K]> | (() => T[K]);
 };
+export type CombineFromOptions<IValue> = {
+    readonly injector?: Injector;
+    readonly initialValue?: IValue;
+};
+export declare function combineFrom<Input extends readonly unknown[], Output = Input>(sources: readonly [...ObservableSignalInputTuple<Input>]): Signal<Output>;
+export declare function combineFrom<Input extends readonly unknown[], Output = Input>(sources: readonly [...ObservableSignalInputTuple<Input>], operator?: OperatorFunction<Input, Output>, options?: CombineFromOptions<undefined>): Signal<Output | undefined>;
+export declare function combineFrom<Input extends readonly unknown[], Output = Input>(sources: readonly [...ObservableSignalInputTuple<Input>], operator?: OperatorFunction<Input, Output>, options?: CombineFromOptions<null>): Signal<Output | null>;
 export declare function combineFrom<Input extends readonly unknown[], Output = Input>(sources: readonly [...ObservableSignalInputTuple<Input>], operator?: OperatorFunction<Input, Output>, options?: CombineFromOptions<Output>): Signal<Output>;
-export declare function combineFrom<Input extends readonly unknown[], Output = Input>(sources: readonly [...ObservableSignalInputTuple<Input>], options?: CombineFromOptions<Input>): Signal<Output>;
+export declare function combineFrom<Input extends readonly unknown[], Output = Input>(sources: readonly [...ObservableSignalInputTuple<Input>], options?: CombineFromOptions<undefined>): Signal<Output | undefined>;
+export declare function combineFrom<Input extends readonly unknown[], Output = Input>(sources: readonly [...ObservableSignalInputTuple<Input>], options?: CombineFromOptions<null>): Signal<Output | null>;
+export declare function combineFrom<Input extends readonly unknown[], Output = Input>(sources: readonly [...ObservableSignalInputTuple<Input>], options?: CombineFromOptions<Output>): Signal<Output>;
+export declare function combineFrom<Input extends object, Output = Input>(sources: ObservableSignalInputTuple<Input>): Signal<Output>;
+export declare function combineFrom<Input extends object, Output = Input>(sources: ObservableSignalInputTuple<Input>, operator?: OperatorFunction<Input, Output>, options?: CombineFromOptions<undefined>): Signal<Output | undefined>;
+export declare function combineFrom<Input extends object, Output = Input>(sources: ObservableSignalInputTuple<Input>, operator?: OperatorFunction<Input, Output>, options?: CombineFromOptions<null>): Signal<Output | null>;
 export declare function combineFrom<Input extends object, Output = Input>(sources: ObservableSignalInputTuple<Input>, operator?: OperatorFunction<Input, Output>, options?: CombineFromOptions<Output>): Signal<Output>;
-export declare function combineFrom<Input extends object, Output = Input>(sources: ObservableSignalInputTuple<Input>, options?: CombineFromOptions<Input>): Signal<Output>;
+export declare function combineFrom<Input extends object, Output = Input>(sources: ObservableSignalInputTuple<Input>, options?: CombineFromOptions<undefined>): Signal<Output | undefined>;
+export declare function combineFrom<Input extends object, Output = Input>(sources: ObservableSignalInputTuple<Input>, options?: CombineFromOptions<null>): Signal<Output | null>;
+export declare function combineFrom<Input extends object, Output = Input>(sources: ObservableSignalInputTuple<Input>, options?: CombineFromOptions<Output>): Signal<Output>;
 export {};

package/lib/signals/create-trigger.d.ts

@@ -0,0 +1,4 @@
+export declare function createTrigger(): {
+    next: () => void;
+    value: import("@angular/core").Signal<number>;
+};

package/lib/signals/index.d.ts

@@ -1,5 +1,6 @@
 export * from './combine-from';
 export * from './computed-async';
-export * from './create-notifier';
+export * from './create-trigger';
 export * from './inject-params';
 export * from './inject-query-params';
+export * from './merge-from';

package/lib/signals/inject-params.d.ts

@@ -1,5 +1,24 @@
 import { type Signal } from '@angular/core';
 import { type Params } from '@angular/router';
+type ParamsTransformFn<Output> = (params: Params) => Output;
+/**
+ * The `InputOptions` interface defines options for configuring the behavior of the `injectParams` function.
+ *
+ * @template Output - The expected type of the read value.
+ */
+export interface ParamsOptions<Output> {
+    /**
+     * A transformation function to convert the written value to the expected read value.
+     *
+     * @param v - The value to transform.
+     * @returns The transformed value.
+     */
+    transform?: (v: string) => Output;
+    /**
+     * The initial value to use if the parameter is not present or undefined.
+     */
+    initialValue?: Output;
+}
 /**
  * Injects the params from the current route.
  * If a key is provided, returns the value of that key.
@@ -7,12 +26,38 @@ import { type Params } from '@angular/router';
  * Otherwise, returns the entire params object.
  *
  * @example
+ * const params = injectParams(); // Returns the entire params object
  * const userId = injectParams('id'); // Returns the value of the 'id' param
  * const userId = injectParams(p => p['id'] as string); // Returns the 'id' param using a custom transform function
- * const params = injectParams(); // Returns the entire params object
+ * const userId = injectParams('id', { transform: numberAttribute, initialValue: 1 });
  *
- * @param keyOrTransform OPTIONAL The key of the param to return, or a transform function to apply to the params object
+ * @param keyOrParamsTransform OPTIONAL The key of the param to return, or a transform function to apply to the params object
  */
 export declare function injectParams(): Signal<Params>;
+export declare function injectParams<Output>(fn: ParamsTransformFn<Output>): Signal<Output>;
 export declare function injectParams(key: string): Signal<string | null>;
-export declare function injectParams<T>(transform: (params: Params) => T): Signal<T>;
+export declare function injectParams(key: string, options: {
+    transform: (v: string) => boolean;
+    initialValue: boolean;
+}): Signal<boolean>;
+export declare function injectParams(key: string, options: {
+    transform: (v: string) => number;
+    initialValue: number;
+}): Signal<number>;
+export declare function injectParams(key: string, options: {
+    transform?: (v: string) => string;
+    initialValue: string;
+}): Signal<string>;
+export declare function injectParams(key: string, options: {
+    transform: (v: string) => boolean;
+    initialValue?: undefined;
+}): Signal<boolean | null>;
+export declare function injectParams(key: string, options: {
+    transform: (v: string) => number;
+    initialValue?: undefined;
+}): Signal<number | null>;
+export declare function injectParams(key: string, options: {
+    transform: (v: string) => string;
+    initialValue?: undefined;
+}): Signal<string | null>;
+export {};

package/lib/signals/inject-query-params.d.ts

@@ -25,37 +25,6 @@ export interface QueryParamsOptions<Output> {
  * @returns A `Signal` that emits the entire query parameters object.
  */
 export declare function injectQueryParams(): Signal<Params>;
-/**
- * The `injectQueryParams` function allows you to access and manipulate query parameters from the current route.
- *
- * @param {string} key - The name of the query parameter to retrieve.
- * @returns {Signal} A `Signal` that emits the value of the specified query parameter, or `null` if it's not present.
- */
-export declare function injectQueryParams(key: string): Signal<string | null>;
-/**
- * The `injectQueryParams` function allows you to access and manipulate query parameters from the current route.
- *
- * @param {string} key - The name of the query parameter to retrieve.
- * @param {QueryParamsOptions} options - Optional configuration options for the query parameter.
- * @returns {Signal} A `Signal` that emits the transformed value of the specified query parameter, or `null` if it's not present.
- */
-export declare function injectQueryParams(key?: string, options?: QueryParamsOptions<boolean>): Signal<boolean | null>;
-/**
- * The `injectQueryParams` function allows you to access and manipulate query parameters from the current route.
- *
- * @param {string} key - The name of the query parameter to retrieve.
- * @param {QueryParamsOptions} options - Optional configuration options for the query parameter.
- * @returns {Signal} A `Signal` that emits the transformed value of the specified query parameter, or `null` if it's not present.
- */
-export declare function injectQueryParams(key?: string, options?: QueryParamsOptions<number>): Signal<number | null>;
-/**
- * The `injectQueryParams` function allows you to access and manipulate query parameters from the current route.
- *
- * @param {string} key - The name of the query parameter to retrieve.
- * @param {QueryParamsOptions} options - Optional configuration options for the query parameter.
- * @returns {Signal} A `Signal` that emits the transformed value of the specified query parameter, or `null` if it's not present.
- */
-export declare function injectQueryParams(key?: string, options?: QueryParamsOptions<string>): Signal<string | null>;
 /**
  * The `injectQueryParams` function allows you to access and manipulate query parameters from the current route.
  * It retrieves the value of a query parameter based on a custom transform function applied to the query parameters object.
@@ -68,4 +37,35 @@ export declare function injectQueryParams(key?: string, options?: QueryParamsOpt
  * const searchValue = injectQueryParams((params) => params['search'] as string);
  */
 export declare function injectQueryParams<Output>(fn: QueryParamsTransformFn<Output>): Signal<Output>;
+/**
+ * The `injectQueryParams` function allows you to access and manipulate query parameters from the current route.
+ *
+ * @param {string} key - The name of the query parameter to retrieve.
+ * @returns {Signal} A `Signal` that emits the value of the specified query parameter, or `null` if it's not present.
+ */
+export declare function injectQueryParams(key: string): Signal<string | null>;
+export declare function injectQueryParams(key: string, options: {
+    transform: (v: string) => boolean;
+    initialValue: boolean;
+}): Signal<boolean>;
+export declare function injectQueryParams(key: string, options: {
+    transform: (v: string) => number;
+    initialValue: number;
+}): Signal<number>;
+export declare function injectQueryParams(key: string, options: {
+    transform?: (v: string) => string;
+    initialValue: string;
+}): Signal<string>;
+export declare function injectQueryParams(key: string, options: {
+    transform: (v: string) => boolean;
+    initialValue?: undefined;
+}): Signal<boolean | null>;
+export declare function injectQueryParams(key: string, options: {
+    transform: (v: string) => number;
+    initialValue?: undefined;
+}): Signal<number | null>;
+export declare function injectQueryParams(key: string, options: {
+    transform: (v: string) => string;
+    initialValue?: undefined;
+}): Signal<string | null>;
 export {};

package/lib/signals/merge-from.d.ts

@@ -0,0 +1,13 @@
+import { Injector, Signal } from '@angular/core';
+import { ObservableInput, OperatorFunction } from 'rxjs';
+type ObservableSignalInput<T> = ObservableInput<T> | Signal<T>;
+type ObservableSignalInputTuple<T> = {
+    [K in keyof T]: ObservableSignalInput<T[K]>;
+};
+export type MergeFromOptions<T> = {
+    readonly injector?: Injector;
+    readonly initialValue?: T | null;
+};
+export declare function mergeFrom<Input extends readonly unknown[], Output = Input[number]>(sources: readonly [...ObservableSignalInputTuple<Input>], operator?: OperatorFunction<Input[number], Output>, options?: MergeFromOptions<Output>): Signal<Output>;
+export declare function mergeFrom<Input extends readonly unknown[], Output = Input[number]>(sources: readonly [...ObservableSignalInputTuple<Input>], options?: MergeFromOptions<Output>): Signal<Output>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-lift",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "A project has been crafted with the goal of enhancing and simplifying your Angular development experience.",
   "author": "Guanghui Wang <guanghui-wang@foxmail.com>",
   "peerDependencies": {

package/esm2022/lib/signals/create-notifier.mjs

@@ -1,11 +0,0 @@
-import { signal } from '@angular/core';
-export function createNotifier() {
-    const sourceSignal = signal(0);
-    return {
-        notify: () => {
-            sourceSignal.update((v) => v + 1);
-        },
-        listen: sourceSignal.asReadonly(),
-    };
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY3JlYXRlLW5vdGlmaWVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vcHJvamVjdHMvbmd4LWxpZnQvc3JjL2xpYi9zaWduYWxzL2NyZWF0ZS1ub3RpZmllci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUMsTUFBTSxFQUFDLE1BQU0sZUFBZSxDQUFDO0FBRXJDLE1BQU0sVUFBVSxjQUFjO0lBQzVCLE1BQU0sWUFBWSxHQUFHLE1BQU0sQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUUvQixPQUFPO1FBQ0wsTUFBTSxFQUFFLEdBQUcsRUFBRTtZQUNYLFlBQVksQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLEVBQUUsRUFBRSxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztRQUNwQyxDQUFDO1FBQ0QsTUFBTSxFQUFFLFlBQVksQ0FBQyxVQUFVLEVBQUU7S0FDbEMsQ0FBQztBQUNKLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQge3NpZ25hbH0gZnJvbSAnQGFuZ3VsYXIvY29yZSc7XG5cbmV4cG9ydCBmdW5jdGlvbiBjcmVhdGVOb3RpZmllcigpIHtcbiAgY29uc3Qgc291cmNlU2lnbmFsID0gc2lnbmFsKDApO1xuXG4gIHJldHVybiB7XG4gICAgbm90aWZ5OiAoKSA9PiB7XG4gICAgICBzb3VyY2VTaWduYWwudXBkYXRlKCh2KSA9PiB2ICsgMSk7XG4gICAgfSxcbiAgICBsaXN0ZW46IHNvdXJjZVNpZ25hbC5hc1JlYWRvbmx5KCksXG4gIH07XG59XG4iXX0=

package/lib/signals/create-notifier.d.ts

@@ -1,4 +0,0 @@
-export declare function createNotifier(): {
-    notify: () => void;
-    listen: import("@angular/core").Signal<number>;
-};