@forklaunch/core 0.8.2 → 0.8.4

package/lib/src/cache/index.d.mts

@@ -1,8 +1,3 @@
-import { RedisClientOptions } from 'redis';
-import { O as OpenTelemetryCollector, M as MetricsDefinition, T as TelemetryOptions } from '../../openTelemetryCollector-DQC2FfOu.mjs';
-import '@opentelemetry/api';
-import 'pino';
-
 /**
  * Creates a function that generates cache keys with a given prefix.
  *
@@ -146,175 +141,4 @@ interface TtlCache {
     listKeys(pattern_prefix: string): Promise<string[]>;
 }
 
-/**
- * Class representing a Redis-based TTL (Time-To-Live) cache.
- * Implements the TtlCache interface to provide caching functionality with automatic expiration.
- */
-declare class RedisTtlCache implements TtlCache {
-    private ttlMilliseconds;
-    private openTelemetryCollector;
-    private client;
-    private telemetryOptions;
-    /**
-     * Creates an instance of RedisTtlCache.
-     *
-     * @param {number} ttlMilliseconds - The default Time-To-Live in milliseconds for cache entries
-     * @param {OpenTelemetryCollector<MetricsDefinition>} openTelemetryCollector - Collector for OpenTelemetry metrics
-     * @param {RedisClientOptions} hostingOptions - Configuration options for the Redis client
-     * @param {TelemetryOptions} telemetryOptions - Configuration options for telemetry
-     */
-    constructor(ttlMilliseconds: number, openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>, hostingOptions: RedisClientOptions, telemetryOptions: TelemetryOptions);
-    /**
-     * Parses a raw Redis reply into the expected type.
-     * Handles null values, arrays, buffers, and JSON strings.
-     *
-     * @template T - The expected type of the parsed value
-     * @param {RedisCommandRawReply} value - The raw value from Redis to parse
-     * @returns {T} The parsed value cast to type T
-     */
-    private parseValue;
-    /**
-     * Puts a record into the Redis cache.
-     *
-     * @template T - The type of value being cached
-     * @param {TtlCacheRecord<T>} param0 - The cache record containing key, value and optional TTL
-     * @param {string} param0.key - The key to store the value under
-     * @param {T} param0.value - The value to cache
-     * @param {number} [param0.ttlMilliseconds] - Optional TTL in milliseconds, defaults to constructor value
-     * @returns {Promise<void>} A promise that resolves when the value is cached
-     */
-    putRecord<T>({ key, value, ttlMilliseconds }: TtlCacheRecord<T>): Promise<void>;
-    /**
-     * Puts multiple records into the Redis cache in a single transaction.
-     *
-     * @template T - The type of values being cached
-     * @param {TtlCacheRecord<T>[]} cacheRecords - Array of cache records to store
-     * @returns {Promise<void>} A promise that resolves when all values are cached
-     */
-    putBatchRecords<T>(cacheRecords: TtlCacheRecord<T>[]): Promise<void>;
-    /**
-     * Adds a value to the left end of a Redis list.
-     *
-     * @template T - The type of value being enqueued
-     * @param {string} queueName - The name of the Redis list
-     * @param {T} value - The value to add to the list
-     * @returns {Promise<void>} A promise that resolves when the value is enqueued
-     */
-    enqueueRecord<T>(queueName: string, value: T): Promise<void>;
-    /**
-     * Adds multiple values to the left end of a Redis list in a single transaction.
-     *
-     * @template T - The type of values being enqueued
-     * @param {string} queueName - The name of the Redis list
-     * @param {T[]} values - Array of values to add to the list
-     * @returns {Promise<void>} A promise that resolves when all values are enqueued
-     */
-    enqueueBatchRecords<T>(queueName: string, values: T[]): Promise<void>;
-    /**
-     * Deletes a record from the Redis cache.
-     *
-     * @param {string} cacheRecordKey - The key of the record to delete
-     * @returns {Promise<void>} A promise that resolves when the record is deleted
-     */
-    deleteRecord(cacheRecordKey: string): Promise<void>;
-    /**
-     * Deletes multiple records from the Redis cache in a single transaction.
-     *
-     * @param {string[]} cacheRecordKeys - Array of keys to delete
-     * @returns {Promise<void>} A promise that resolves when all records are deleted
-     */
-    deleteBatchRecords(cacheRecordKeys: string[]): Promise<void>;
-    /**
-     * Removes and returns the rightmost element from a Redis list.
-     *
-     * @template T - The type of value being dequeued
-     * @param {string} queueName - The name of the Redis list
-     * @returns {Promise<T>} A promise that resolves with the dequeued value
-     * @throws {Error} If the queue is empty
-     */
-    dequeueRecord<T>(queueName: string): Promise<T>;
-    /**
-     * Removes and returns multiple elements from the right end of a Redis list.
-     *
-     * @template T - The type of values being dequeued
-     * @param {string} queueName - The name of the Redis list
-     * @param {number} pageSize - Maximum number of elements to dequeue
-     * @returns {Promise<T[]>} A promise that resolves with an array of dequeued values
-     */
-    dequeueBatchRecords<T>(queueName: string, pageSize: number): Promise<T[]>;
-    /**
-     * Reads a record from the Redis cache.
-     *
-     * @template T - The type of value being read
-     * @param {string} cacheRecordKey - The key of the record to read
-     * @returns {Promise<TtlCacheRecord<T>>} A promise that resolves with the cache record
-     * @throws {Error} If the record is not found
-     */
-    readRecord<T>(cacheRecordKey: string): Promise<TtlCacheRecord<T>>;
-    /**
-     * Reads multiple records from the Redis cache.
-     *
-     * @template T - The type of values being read
-     * @param {string[] | string} cacheRecordKeysOrPrefix - Array of keys to read, or a prefix pattern
-     * @returns {Promise<TtlCacheRecord<T>[]>} A promise that resolves with an array of cache records
-     */
-    readBatchRecords<T>(cacheRecordKeysOrPrefix: string[] | string): Promise<TtlCacheRecord<T>[]>;
-    /**
-     * Lists all keys in the Redis cache that match a pattern prefix.
-     *
-     * @param {string} pattern_prefix - The prefix pattern to match keys against
-     * @returns {Promise<string[]>} A promise that resolves with an array of matching keys
-     */
-    listKeys(pattern_prefix: string): Promise<string[]>;
-    /**
-     * Checks if a record exists in the Redis cache.
-     *
-     * @param {string} cacheRecordKey - The key to check
-     * @returns {Promise<boolean>} A promise that resolves with true if the record exists, false otherwise
-     */
-    peekRecord(cacheRecordKey: string): Promise<boolean>;
-    /**
-     * Checks if multiple records exist in the Redis cache.
-     *
-     * @param {string[] | string} cacheRecordKeysOrPrefix - Array of keys to check, or a prefix pattern
-     * @returns {Promise<boolean[]>} A promise that resolves with an array of existence booleans
-     */
-    peekBatchRecords(cacheRecordKeysOrPrefix: string[] | string): Promise<boolean[]>;
-    /**
-     * Peeks at a record in the Redis cache.
-     *
-     * @template T - The type of value being peeked at
-     * @param {string} queueName - The name of the Redis queue
-     * @returns {Promise<T>} A promise that resolves with the peeked value
-     */
-    peekQueueRecord<T>(queueName: string): Promise<T>;
-    /**
-     * Peeks at multiple records in the Redis cache.
-     *
-     * @template T - The type of values being peeked at
-     * @param {string} queueName - The name of the Redis queue
-     * @param {number} pageSize - The number of records to peek at
-     * @returns {Promise<T[]>} A promise that resolves with an array of peeked values
-     */
-    peekQueueRecords<T>(queueName: string, pageSize: number): Promise<T[]>;
-    /**
-     * Gracefully disconnects from the Redis server.
-     *
-     * @returns {Promise<void>} A promise that resolves when the connection is closed
-     */
-    disconnect(): Promise<void>;
-    /**
-     * Gets the default Time-To-Live value in milliseconds.
-     *
-     * @returns {number} The default TTL in milliseconds
-     */
-    getTtlMilliseconds(): number;
-    /**
-     * Gets the underlying Redis client instance.
-     *
-     * @returns {typeof this.client} The Redis client instance
-     */
-    getClient(): typeof this.client;
-}
-
-export { RedisTtlCache, type TtlCache, type TtlCacheRecord, createCacheKey };
+export { type TtlCache, type TtlCacheRecord, createCacheKey };

package/lib/src/cache/index.d.ts

@@ -1,8 +1,3 @@
-import { RedisClientOptions } from 'redis';
-import { O as OpenTelemetryCollector, M as MetricsDefinition, T as TelemetryOptions } from '../../openTelemetryCollector-DQC2FfOu.js';
-import '@opentelemetry/api';
-import 'pino';
-
 /**
  * Creates a function that generates cache keys with a given prefix.
  *
@@ -146,175 +141,4 @@ interface TtlCache {
     listKeys(pattern_prefix: string): Promise<string[]>;
 }
 
-/**
- * Class representing a Redis-based TTL (Time-To-Live) cache.
- * Implements the TtlCache interface to provide caching functionality with automatic expiration.
- */
-declare class RedisTtlCache implements TtlCache {
-    private ttlMilliseconds;
-    private openTelemetryCollector;
-    private client;
-    private telemetryOptions;
-    /**
-     * Creates an instance of RedisTtlCache.
-     *
-     * @param {number} ttlMilliseconds - The default Time-To-Live in milliseconds for cache entries
-     * @param {OpenTelemetryCollector<MetricsDefinition>} openTelemetryCollector - Collector for OpenTelemetry metrics
-     * @param {RedisClientOptions} hostingOptions - Configuration options for the Redis client
-     * @param {TelemetryOptions} telemetryOptions - Configuration options for telemetry
-     */
-    constructor(ttlMilliseconds: number, openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>, hostingOptions: RedisClientOptions, telemetryOptions: TelemetryOptions);
-    /**
-     * Parses a raw Redis reply into the expected type.
-     * Handles null values, arrays, buffers, and JSON strings.
-     *
-     * @template T - The expected type of the parsed value
-     * @param {RedisCommandRawReply} value - The raw value from Redis to parse
-     * @returns {T} The parsed value cast to type T
-     */
-    private parseValue;
-    /**
-     * Puts a record into the Redis cache.
-     *
-     * @template T - The type of value being cached
-     * @param {TtlCacheRecord<T>} param0 - The cache record containing key, value and optional TTL
-     * @param {string} param0.key - The key to store the value under
-     * @param {T} param0.value - The value to cache
-     * @param {number} [param0.ttlMilliseconds] - Optional TTL in milliseconds, defaults to constructor value
-     * @returns {Promise<void>} A promise that resolves when the value is cached
-     */
-    putRecord<T>({ key, value, ttlMilliseconds }: TtlCacheRecord<T>): Promise<void>;
-    /**
-     * Puts multiple records into the Redis cache in a single transaction.
-     *
-     * @template T - The type of values being cached
-     * @param {TtlCacheRecord<T>[]} cacheRecords - Array of cache records to store
-     * @returns {Promise<void>} A promise that resolves when all values are cached
-     */
-    putBatchRecords<T>(cacheRecords: TtlCacheRecord<T>[]): Promise<void>;
-    /**
-     * Adds a value to the left end of a Redis list.
-     *
-     * @template T - The type of value being enqueued
-     * @param {string} queueName - The name of the Redis list
-     * @param {T} value - The value to add to the list
-     * @returns {Promise<void>} A promise that resolves when the value is enqueued
-     */
-    enqueueRecord<T>(queueName: string, value: T): Promise<void>;
-    /**
-     * Adds multiple values to the left end of a Redis list in a single transaction.
-     *
-     * @template T - The type of values being enqueued
-     * @param {string} queueName - The name of the Redis list
-     * @param {T[]} values - Array of values to add to the list
-     * @returns {Promise<void>} A promise that resolves when all values are enqueued
-     */
-    enqueueBatchRecords<T>(queueName: string, values: T[]): Promise<void>;
-    /**
-     * Deletes a record from the Redis cache.
-     *
-     * @param {string} cacheRecordKey - The key of the record to delete
-     * @returns {Promise<void>} A promise that resolves when the record is deleted
-     */
-    deleteRecord(cacheRecordKey: string): Promise<void>;
-    /**
-     * Deletes multiple records from the Redis cache in a single transaction.
-     *
-     * @param {string[]} cacheRecordKeys - Array of keys to delete
-     * @returns {Promise<void>} A promise that resolves when all records are deleted
-     */
-    deleteBatchRecords(cacheRecordKeys: string[]): Promise<void>;
-    /**
-     * Removes and returns the rightmost element from a Redis list.
-     *
-     * @template T - The type of value being dequeued
-     * @param {string} queueName - The name of the Redis list
-     * @returns {Promise<T>} A promise that resolves with the dequeued value
-     * @throws {Error} If the queue is empty
-     */
-    dequeueRecord<T>(queueName: string): Promise<T>;
-    /**
-     * Removes and returns multiple elements from the right end of a Redis list.
-     *
-     * @template T - The type of values being dequeued
-     * @param {string} queueName - The name of the Redis list
-     * @param {number} pageSize - Maximum number of elements to dequeue
-     * @returns {Promise<T[]>} A promise that resolves with an array of dequeued values
-     */
-    dequeueBatchRecords<T>(queueName: string, pageSize: number): Promise<T[]>;
-    /**
-     * Reads a record from the Redis cache.
-     *
-     * @template T - The type of value being read
-     * @param {string} cacheRecordKey - The key of the record to read
-     * @returns {Promise<TtlCacheRecord<T>>} A promise that resolves with the cache record
-     * @throws {Error} If the record is not found
-     */
-    readRecord<T>(cacheRecordKey: string): Promise<TtlCacheRecord<T>>;
-    /**
-     * Reads multiple records from the Redis cache.
-     *
-     * @template T - The type of values being read
-     * @param {string[] | string} cacheRecordKeysOrPrefix - Array of keys to read, or a prefix pattern
-     * @returns {Promise<TtlCacheRecord<T>[]>} A promise that resolves with an array of cache records
-     */
-    readBatchRecords<T>(cacheRecordKeysOrPrefix: string[] | string): Promise<TtlCacheRecord<T>[]>;
-    /**
-     * Lists all keys in the Redis cache that match a pattern prefix.
-     *
-     * @param {string} pattern_prefix - The prefix pattern to match keys against
-     * @returns {Promise<string[]>} A promise that resolves with an array of matching keys
-     */
-    listKeys(pattern_prefix: string): Promise<string[]>;
-    /**
-     * Checks if a record exists in the Redis cache.
-     *
-     * @param {string} cacheRecordKey - The key to check
-     * @returns {Promise<boolean>} A promise that resolves with true if the record exists, false otherwise
-     */
-    peekRecord(cacheRecordKey: string): Promise<boolean>;
-    /**
-     * Checks if multiple records exist in the Redis cache.
-     *
-     * @param {string[] | string} cacheRecordKeysOrPrefix - Array of keys to check, or a prefix pattern
-     * @returns {Promise<boolean[]>} A promise that resolves with an array of existence booleans
-     */
-    peekBatchRecords(cacheRecordKeysOrPrefix: string[] | string): Promise<boolean[]>;
-    /**
-     * Peeks at a record in the Redis cache.
-     *
-     * @template T - The type of value being peeked at
-     * @param {string} queueName - The name of the Redis queue
-     * @returns {Promise<T>} A promise that resolves with the peeked value
-     */
-    peekQueueRecord<T>(queueName: string): Promise<T>;
-    /**
-     * Peeks at multiple records in the Redis cache.
-     *
-     * @template T - The type of values being peeked at
-     * @param {string} queueName - The name of the Redis queue
-     * @param {number} pageSize - The number of records to peek at
-     * @returns {Promise<T[]>} A promise that resolves with an array of peeked values
-     */
-    peekQueueRecords<T>(queueName: string, pageSize: number): Promise<T[]>;
-    /**
-     * Gracefully disconnects from the Redis server.
-     *
-     * @returns {Promise<void>} A promise that resolves when the connection is closed
-     */
-    disconnect(): Promise<void>;
-    /**
-     * Gets the default Time-To-Live value in milliseconds.
-     *
-     * @returns {number} The default TTL in milliseconds
-     */
-    getTtlMilliseconds(): number;
-    /**
-     * Gets the underlying Redis client instance.
-     *
-     * @returns {typeof this.client} The Redis client instance
-     */
-    getClient(): typeof this.client;
-}
-
-export { RedisTtlCache, type TtlCache, type TtlCacheRecord, createCacheKey };
+export { type TtlCache, type TtlCacheRecord, createCacheKey };