ngx-lift 1.7.3 → 1.9.0

package/lib/models/kubernetes-object-condition.model.d.ts

@@ -0,0 +1,28 @@
+export interface KubernetesObjectCondition {
+    /**
+     * lastTransitionTime is a string representing the last time the condition transitioned from one status to another.
+     * If the underlying condition change is unknown, the time when the API field changed is used.
+     */
+    lastTransitionTime: string;
+    /**
+     * message is a string providing a human - readable message about the transition. It can be an empty string.
+     */
+    message: string;
+    /**
+     * reason is a string containing a programmatic identifier indicating the reason for the condition's last transition.
+     * Producers of specific condition types may define expected values and meanings for this field.
+     */
+    reason: string;
+    /**
+     * status is an enum with possible values 'True', 'False', or 'Unknown' representing the current status of the condition.
+     */
+    status: 'True' | 'False' | 'Unknown';
+    /**
+     * type is a string representing the type of condition in CamelCase or in foo.example.com/CamelCase format.
+     */
+    type: string;
+    /**
+     * observedGeneration is an integer representing the.metadata.generation that the condition was set based upon.
+     */
+    observedGeneration?: number;
+}

package/lib/models/kubernetes-object-meta.model.d.ts

@@ -0,0 +1,38 @@
+/**
+ * https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#objectmeta-v1-meta
+ */
+export interface KubernetesObjectMetaV1 {
+    name: string;
+    namespace?: string;
+    selfLink?: string;
+    uid?: string;
+    resourceVersion?: string;
+    generation?: number;
+    creationTimestamp?: string;
+    deletionTimestamp?: string;
+    deletionGracePeriodSeconds?: number;
+    labels?: Record<string, string>;
+    annotations?: Record<string, string>;
+    ownerReferences?: OwnerReference[];
+    finalizers?: string[];
+    clusterName?: string;
+    managedFields?: ManagedField[];
+}
+interface OwnerReference {
+    apiVersion: string;
+    kind: string;
+    name: string;
+    uid: string;
+    controller: boolean;
+    blockOwnerDeletion?: boolean;
+}
+interface ManagedField {
+    apiVersion: string;
+    fieldsType: string;
+    fieldsV1: Record<string, unknown>;
+    manager: string;
+    operation: string;
+    subresource?: string;
+    time: string;
+}
+export {};

package/lib/models/kubernetes-object.model.d.ts

@@ -0,0 +1,8 @@
+import { KubernetesObjectMetaV1 } from './kubernetes-object-meta.model';
+export interface KubernetesObject {
+    apiVersion: string;
+    kind: string;
+    metadata: KubernetesObjectMetaV1;
+    spec?: any;
+    status?: any;
+}

package/lib/operators/create-async-state.operator.d.ts

@@ -45,5 +45,20 @@ import { AsyncState } from '../models/async-state.model';
  *   ))
  * )
  *
+ * Usage 3: provide initialValue
+ *
+ * import {createAsyncState} from 'ngx-lift';
+ * import {noop} from 'rxjs';
+ *
+ * private userService = inject(UserService);
+ * private location = inject(Location);
+ *
+ * userState$ = this.userService
+ *   .getUserById(1)
+ *   .pipe(createAsyncState<User>(noop, {loading: false, error: null, data: this.location.getState()}));
  */
-export declare function createAsyncState<T, E = HttpErrorResponse>(observerOrNextForOrigin?: Partial<TapObserver<T>> | ((value: T) => void)): UnaryFunction<Observable<T>, Observable<AsyncState<T, E>>>;
+export declare function createAsyncState<T, E = HttpErrorResponse>(observerOrNextForOrigin?: Partial<TapObserver<T>> | ((value: T) => void), initialValue?: {
+    loading: boolean;
+    error: E | null;
+    data: T | null;
+}): UnaryFunction<Observable<T>, Observable<AsyncState<T, E>>>;

package/lib/operators/index.d.ts

@@ -1,6 +1,7 @@
 export * from './combine-latest-eager.operator';
 export * from './create-async-state.operator';
 export * from './distinct-on-change.operator';
+export * from './kubernetes-pagination.operator';
 export * from './logger.operator';
 export * from './poll.operator';
 export * from './start-with-tap.operator';

package/lib/operators/kubernetes-pagination.operator.d.ts

@@ -0,0 +1,30 @@
+import { HttpClient } from '@angular/common/http';
+import { Observable, OperatorFunction } from 'rxjs';
+import { KubernetesList, KubernetesObject } from '../models';
+/**
+ * Fetches paginated Kubernetes resources by continually making requests
+ * until all pages have been retrieved, and aggregates the items from all pages
+ * into a single KubernetesList.
+ *
+ * @template T The type of the items contained within the KubernetesList.
+ * @param http The HttpClient instance used to make the HTTP requests.
+ * @param endpoint The API endpoint to fetch the resources from.
+ * @param initialParams Optional initial parameters to include in the request.
+ *                      Can include query parameters like filters and pagination settings.
+ * `limit` and `continue` parameters are parameters for kubernetes
+ * @returns An observable that emits a single KubernetesList containing all items from all pages.
+ */
+export declare function aggregatePaginatedKubernetesResources<T extends KubernetesObject>(http: HttpClient, endpoint: string, initialParams?: Record<string, string | number | boolean | (string | number | boolean)[]>): OperatorFunction<KubernetesList<T>, KubernetesList<T>>;
+/**
+ * Fetches paginated Kubernetes resources by continually making requests
+ * until all pages have been retrieved.
+ *
+ * @template T The type of the items contained within the KubernetesList.
+ * @param http The HttpClient instance used to make the HTTP requests.
+ * @param endpoint The API endpoint to fetch the resources from.
+ * @param initialParams Optional initial parameters to include in the request.
+ *                      Can include query parameters like filters and pagination settings.
+ * `limit` and `continue` parameters are parameters for kubernetes
+ * @returns An observable that emits a single KubernetesList containing all items from all pages.
+ */
+export declare function fetchPaginatedKubernetesResources<T extends KubernetesObject>(http: HttpClient, endpoint: string, initialParams?: Record<string, string | number | boolean | (string | number | boolean)[]>): Observable<KubernetesList<T>>;

package/lib/operators/poll.operator.d.ts

@@ -9,8 +9,8 @@ import { AsyncState } from '../models';
  * @param {object} options - The configuration options for polling.
  * @param {number} options.interval - The interval in milliseconds between each poll.
  * @param {(params: any) => Observable<Data> | Data} options.pollingFn - A function that returns an Observable, Promise, or primitive value.
- * @param {Observable<Input> | Signal<Input>} [options.trigger] - An optional Observable or Signal that triggers a manual poll.
- * @param {(input: Input) => any} [options.paramsBuilder] - An optional function that builds parameters for the polling function based on the input. The value emitted by the trigger observable will serve as the parameter.
+ * @param {Observable<Input> | Signal<Input>} [options.forceRefresh] - An optional Observable or Signal that triggers a manual refresh of the polling function.
+ * @param {(input: Input) => any} [options.paramsBuilder] - An optional function that builds parameters for the polling function based on the input. The value emitted by the forceRefresh observable will serve as the parameter.
  * @returns {Observable<AsyncState<Data>>} An Observable emitting objects representing the state of the asynchronous operation.
  */
 export declare function poll<Data>(options: {
@@ -20,11 +20,11 @@ export declare function poll<Data>(options: {
 export declare function poll<Data, Input>(options: {
     interval: number;
     pollingFn: (params: Input) => Observable<Data> | Promise<Data> | Data;
-    trigger: Observable<Input> | Signal<Input>;
+    forceRefresh: Observable<Input> | Signal<Input>;
 }): Observable<AsyncState<Data>>;
 export declare function poll<Data, Input>(options: {
     interval: number;
     pollingFn: (params: any) => Observable<Data> | Promise<Data> | Data;
-    trigger: Observable<Input> | Signal<Input>;
+    forceRefresh: Observable<Input> | Signal<Input>;
     paramsBuilder: (input: Input) => any;
 }): Observable<AsyncState<Data>>;

package/lib/utils/idle-detection/idle-detection.service.d.ts

@@ -56,8 +56,11 @@ export declare class IdleDetectionService {
     startWatching(): void;
     /**
      * Resets the idle timer when user activity is detected.
+     * @param withCountdownReset - Flag to indicate if countdown should be reset.
+     * By default, it only reset the idle-detection timer. If you enter the countdown phase, it won't stop the countdown.
+     * Pass true when you want to reset the countdown as well. This is useful when you click "Keep Me Signed In" button in cll-idle-detection component
      */
-    resetTimer(): void;
+    resetTimer(withCountdownReset?: boolean): void;
     /**
      * Sets up the interruption events that will end the idle detection.
      * Listens to a set of events on the document (e.g. click, keydown, mousemove, etc.).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-lift",
-  "version": "1.7.3",
+  "version": "1.9.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": {