@ecashlib/shared-message 1.0.2 → 1.0.3

package/dist/redis.repository.d.ts

@@ -0,0 +1,213 @@
+import { FastifyInstance } from "fastify";
+import { Redis } from "ioredis";
+declare module "fastify" {
+    interface FastifyInstance {
+        redis: Redis;
+        redisRepository: RedisRepository;
+    }
+}
+export declare class RedisRepository {
+    private readonly redis;
+    private readonly logger;
+    constructor(fastify: FastifyInstance);
+    /**
+     * Set a string value with TTL (Time To Live)
+     * @param key Redis key
+     * @param value String value to store
+     * @param ttlSeconds TTL in seconds
+     */
+    setString(key: string, value: string, ttlSeconds?: number): Promise<void>;
+    /**
+     * Get a string value by key
+     * @param key Redis key
+     * @returns Promise<string | null> The stored value or null if not found
+     */
+    getString(key: string): Promise<string | null>;
+    /**
+     * Set an object as JSON string with optional TTL
+     * @param key Redis key
+     * @param object Object to store
+     * @param ttlSeconds Optional TTL in seconds
+     */
+    setObject<T>(key: string, object: T, ttlSeconds?: number): Promise<void>;
+    /**
+     * Get an object by key and parse as JSON
+     * @param key Redis key
+     * @returns Promise<T | null> The parsed object or null if not found
+     */
+    getObject<T>(key: string): Promise<T | null>;
+    /**
+     * Get a Redis hash map operations
+     * @param mapName Hash map name
+     * @returns RedisHashMap instance for operations
+     */
+    getMap(mapName: string): RedisHashMap;
+    /**
+     * Delete a key from Redis
+     * @param key Redis key to delete
+     * @returns Promise<boolean> true if key was deleted, false if key didn't exist
+     */
+    delete(key: string): Promise<boolean>;
+    /**
+     * Check if a key exists in Redis
+     * @param key Redis key to check
+     * @returns Promise<boolean> true if key exists, false otherwise
+     */
+    exists(key: string): Promise<boolean>;
+    /**
+     * Set expiry time for an existing key
+     * @param key Redis key
+     * @param ttlSeconds TTL in seconds
+     * @returns Promise<boolean> true if expiry was set, false if key doesn't exist
+     */
+    expire(key: string, ttlSeconds: number): Promise<boolean>;
+    /**
+     * Get TTL (time to live) for a key
+     * @param key Redis key
+     * @returns Promise<number> TTL in seconds, -1 if no expiry, -2 if key doesn't exist
+     */
+    getTTL(key: string): Promise<number>;
+    /**
+     * Increment a numeric value stored at key
+     * @param key Redis key
+     * @param increment Amount to increment by (default: 1)
+     * @returns Promise<number> The new value after increment
+     */
+    increment(key: string, increment?: number): Promise<number>;
+    /**
+     * Get multiple keys at once
+     * @param keys Array of Redis keys
+     * @returns Promise<(string | null)[]> Array of values corresponding to keys
+     */
+    getMultiple(keys: string[]): Promise<(string | null)[]>;
+    /**
+     * Set multiple key-value pairs at once
+     * @param keyValues Object containing key-value pairs
+     * @returns Promise<void>
+     */
+    setMultiple(keyValues: Record<string, string>): Promise<void>;
+    /**
+     * Find keys matching a pattern using KEYS command
+     * WARNING: This command can be slow on large datasets. Consider using SCAN for production.
+     * @param pattern Pattern to match keys (supports wildcards: *, ?, [])
+     * @returns Promise<string[]> Array of matching key names
+     *
+     * Pattern examples:
+     * - "user:*" - matches all keys starting with "user:"
+     * - "session:*:data" - matches keys like "session:123:data"
+     * - "cache:user:[0-9]*" - matches keys like "cache:user:123"
+     */
+    keys(pattern: string): Promise<string[]>;
+    /**
+     * Scan keys matching a pattern using SCAN command (recommended for production)
+     * This is more efficient than KEYS for large datasets as it doesn't block Redis
+     * @param pattern Pattern to match keys
+     * @param count Number of keys to return per iteration (default: 10)
+     * @returns Promise<string[]> Array of matching key names
+     */
+    scanKeys(pattern: string, count?: number): Promise<string[]>;
+    /**
+     * Add one or more members to a Redis set
+     * @param key Redis set key
+     * @param members Members to add to the set
+     * @returns Promise<number> Number of members that were added (excluding already existing members)
+     */
+    setAdd(key: string, ...members: string[]): Promise<number>;
+    /**
+     * Remove one or more members from a Redis set
+     * @param key Redis set key
+     * @param members Members to remove from the set
+     * @returns Promise<number> Number of members that were removed
+     */
+    setRemove(key: string, ...members: string[]): Promise<number>;
+    /**
+     * Get the number of members in a Redis set
+     * @param key Redis set key
+     * @returns Promise<number> Number of members in the set
+     */
+    setSize(key: string): Promise<number>;
+    /**
+     * Check if a member exists in a Redis set
+     * @param key Redis set key
+     * @param member Member to check
+     * @returns Promise<boolean> true if member exists in the set
+     */
+    setContains(key: string, member: string): Promise<boolean>;
+    /**
+     * Get all members of a Redis set
+     * @param key Redis set key
+     * @returns Promise<string[]> Array of all members in the set
+     */
+    setMembers(key: string): Promise<string[]>;
+    /**
+     * Get a random member from a Redis set
+     * @param key Redis set key
+     * @param count Number of random members to return (default: 1)
+     * @returns Promise<string[]> Array of random members
+     */
+    setRandomMembers(key: string, count?: number): Promise<string[]>;
+    /**
+     * Pop (remove and return) a random member from a Redis set
+     * @param key Redis set key
+     * @param count Number of members to pop (default: 1)
+     * @returns Promise<string[]> Array of popped members
+     */
+    setPop(key: string, count?: number): Promise<string[]>;
+    hSet<T>(key: string, field: string, value: T): Promise<void>;
+    hSetMultiple(key: string, values: Record<string, any>): Promise<void>;
+    hGet<T>(key: string, field: string): Promise<T | null>;
+    hGetAll<T>(key: string): Promise<T>;
+    hDel(key: string): Promise<void>;
+    hDelItem(key: string, field: string): Promise<void>;
+}
+/**
+ * Helper class for Redis Hash Map operations
+ */
+export declare class RedisHashMap {
+    private mapName;
+    private redis;
+    private logger;
+    constructor(mapName: string, redis: FastifyInstance["redis"], logger: FastifyInstance["log"]);
+    /**
+     * Set a field in the hash map
+     * @param field Hash field name
+     * @param value Value to set
+     */
+    set<T>(field: string, value: T): Promise<void>;
+    /**
+     * Get a field from the hash map
+     * @param field Hash field name
+     * @returns Promise<T | null> The field value or null if not found
+     */
+    get<T>(field: string): Promise<T | null>;
+    /**
+     * Get all fields and values from the hash map
+     * @returns Promise<Record<string, string>> All field-value pairs
+     */
+    getAll(): Promise<Record<string, string>>;
+    /**
+     * Delete a field from the hash map
+     * @param field Hash field name
+     * @returns Promise<boolean> true if field was deleted
+     */
+    delete(field: string): Promise<boolean>;
+    /**
+     * Check if a field exists in the hash map
+     * @param field Hash field name
+     * @returns Promise<boolean> true if field exists
+     */
+    exists(field: string): Promise<boolean>;
+    /**
+     * Get all field names in the hash map
+     * @returns Promise<string[]> Array of field names
+     */
+    getKeys(): Promise<string[]>;
+    /**
+     * Get the number of fields in the hash map
+     * @returns Promise<number> Number of fields
+     */
+    size(): Promise<number>;
+}
+declare const _default: (fastify: FastifyInstance) => Promise<void>;
+export default _default;
+//# sourceMappingURL=redis.repository.d.ts.map

package/dist/redis.repository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis.repository.d.ts","sourceRoot":"","sources":["../src/redis.repository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAoBhC,OAAO,QAAQ,SAAS,CAAC;IACrB,UAAU,eAAe;QACrB,KAAK,EAAE,KAAK,CAAC;QACb,eAAe,EAAE,eAAe,CAAC;KACpC;CACJ;AAED,qBAAa,eAAe;IACxB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA2B;IACjD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAyB;gBAEpC,OAAO,EAAE,eAAe;IAKpC;;;;;OAKG;IACG,SAAS,CACX,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;;OAIG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAWpD;;;;;OAKG;IACG,SAAS,CAAC,CAAC,EACb,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,CAAC,EACT,UAAU,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;;OAIG;IACG,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAkBlD;;;;OAIG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY;IAIrC;;;;OAIG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAY3C;;;;OAIG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAY3C;;;;;OAKG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAa/D;;;;OAIG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAW1C;;;;;OAKG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,GAAE,MAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IAapE;;;;OAIG;IACG,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC;IAa7D;;;;OAIG;IACG,WAAW,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBnE;;;;;;;;;;OAUG;IACG,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAW9C;;;;;;OAMG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IA6BtE;;;;;OAKG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAahE;;;;;OAKG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAanE;;;;OAIG;IACG,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAW3C;;;;;OAKG;IACG,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAchE;;;;OAIG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAWhD;;;;;OAKG;IACG,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,GAAE,MAAU,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAgBzE;;;;;OAKG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,GAAE,MAAU,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAgBzD,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAc5D,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAWrE,IAAI,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAatD,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAYnC,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUhC,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAS5D;AAED;;GAEG;AACH,qBAAa,YAAY;IAEjB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,MAAM;gBAFN,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,EAC/B,MAAM,EAAE,eAAe,CAAC,KAAK,CAAC;IAG1C;;;;OAIG;IACG,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBpD;;;;OAIG;IACG,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAiC9C;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAgB/C;;;;OAIG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAiB7C;;;;OAIG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAgB7C;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAalC;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC;CAUhC;kCAGmB,eAAe;AADnC,wBAME"}