@jetit/publisher 4.1.1 → 5.0.0

package/src/lib/redis/streams.d.ts

@@ -1,15 +1,24 @@
 import { Observable } from 'rxjs';
-import { EventData, PublishData } from './types';
+import { IAggregatedMetrics, TQueryableMetrics } from '../monitoring/types';
+import { CircuitState } from '../performance/circuit_breaker';
+import { EventData, IListenOptions, IStreamsConfig, PublishData } from './types';
 export declare class Streams {
     private _redisPublisher?;
     private _redisGroups?;
+    private config;
+    private dlq;
+    private metricsCollector;
     private consumerGroupName;
     private instanceId;
     private instanceUniqueId;
     private cleanUpTimer;
     private eventsListened;
+    private subscriptions;
+    private duplicateChecker;
+    private circuitBreaker;
     private get redisPublisher();
     private get redisGroups();
+    private DEFAULT_STREAMS_CONFIG;
     /**
      * Creates a new Streams instance for a given service.
      *
@@ -24,7 +33,8 @@ export declare class Streams {
      * // Create a new Streams instance for the "POS" service
      * const streams = new Streams('POS');
      */
-    constructor(serviceName: string);
+    constructor(serviceName: string, config?: Partial<IStreamsConfig>);
+    private setupCircuitBreakerListeners;
     private runClear;
     /**
      * Publishes an event with the given data to the Redis event stream.
@@ -96,7 +106,7 @@ export declare class Streams {
      *   PUBLISHER_LOGGER.log('New order created:', event.data);
      * });
      */
-    listen<T = unknown, const TName extends string = string>(eventName: TName, maxRetries?: number, initialDelay?: number): Observable<EventData<T, TName>>;
+    listen<T = unknown, const TName extends string = string>(eventName: TName, listenerOptions?: IListenOptions<T>): Observable<EventData<T, TName>>;
     private createConsumerAndRegister;
     private listenInternals;
     /**
@@ -142,4 +152,52 @@ export declare class Streams {
         }[];
         message: string;
     }>;
+    private logPerformance;
+    /**
+     * @description
+     * This method is use to retry an event that has ended in the dead letter queue,
+     * which happens after the first retry.
+     */
+    retryFromDLQ(eventId: string): Promise<boolean>;
+    /**
+     * @description
+     * This returns the number of items and the rate at which events are added
+     * to the queue. The queue is global and hence remains as is
+     */
+    getDLQStats(): Promise<{
+        size: number;
+        additionRate: number;
+    }>;
+    private removeSubscription;
+    /**
+     * @description
+     * This is a simple helper utility that can be used externally to create alerts based
+     * on thresholds that can be provided into the function. It returns true/false for each
+     * key that is provided. Not all keys are required
+     */
+    checkThresholds(thresholds: Partial<TQueryableMetrics>): Promise<Record<string, boolean>>;
+    /**
+     * @description
+     * This will return you the stats of the publisher for the last 6 hours after cleaning
+     */
+    getMetrics(startTime: number, endTime: number): Promise<IAggregatedMetrics[]>;
+    /**
+     * @description
+     * This will return you the latest stats of the publisher
+     */
+    getLatestMetrics(): Promise<IAggregatedMetrics | null>;
+    /**
+     * @description
+     * This returns the status of the performance control setup. This includes
+     * the circuit breaker
+     */
+    getPerformanceControlStatus(): Promise<{
+        circuitBreakerState: CircuitState;
+    }>;
+    /**
+     * @description
+     * This is a manual control to process stored events in case the
+     * circuit is OPEN
+     */
+    processStoredEvents(): Promise<void>;
 }