grammy-broadcast 2.0.2

package/dist/index.d.mts

@@ -0,0 +1,180 @@
+import * as grammy from 'grammy';
+import { Context, Api } from 'grammy';
+import { Redis } from 'ioredis';
+
+/**
+ * Abstract Storage class that defines the interface for storage operations
+ * Used for broadcast queue management
+ */
+declare abstract class Storage {
+    /**
+     * Get a range of items from a list
+     * @param key List key
+     * @param start Start index (0-based)
+     * @param end End index (-1 for all)
+     * @returns Array of string values
+     */
+    abstract lrange(key: string, start: number, end: number): Promise<string[]>;
+    /**
+     * Get all fields and values from a hash
+     * @param key Hash key
+     * @returns Object with field-value pairs
+     */
+    abstract hgetall(key: string): Promise<Record<string, string>>;
+    /**
+     * Remove items from a list
+     * @param key List key
+     * @param count Number of items to remove (0 for all, positive for first N, negative for last N)
+     * @param value Value to remove
+     * @returns Promise that resolves when done
+     */
+    abstract lrem(key: string, count: number, value: string): Promise<void>;
+    /**
+     * Pop items from the left side of a list
+     * @param key List key
+     * @param count Number of items to pop
+     * @returns Array of popped values or null if list is empty
+     */
+    abstract lpop(key: string, count: number): Promise<string[] | null>;
+    /**
+     * Delete one or more keys
+     * @param keys Key(s) to delete
+     * @returns Promise that resolves when done
+     */
+    abstract del(...keys: string[]): Promise<void>;
+    /**
+     * Increment a hash field by a value
+     * @param key Hash key
+     * @param field Field name
+     * @param increment Increment value
+     * @returns Promise that resolves when done
+     */
+    abstract hincrby(key: string, field: string, increment: number): Promise<void>;
+    /**
+     * Set hash field(s)
+     * @param key Hash key
+     * @param fieldOrObject Field name or object with field-value pairs
+     * @param value Value (if field is a string)
+     * @returns Promise that resolves when done
+     */
+    abstract hset(key: string, fieldOrObject: string | Record<string, string>, value?: string): Promise<void>;
+    /**
+     * Get a hash field value
+     * @param key Hash key
+     * @param field Field name
+     * @returns Field value or null if not found
+     */
+    abstract hget(key: string, field: string): Promise<string | null>;
+    /**
+     * Delete one or more hash fields
+     * @param key Hash key
+     * @param fields Field name(s) to delete
+     * @returns Promise that resolves when done
+     */
+    abstract hdel(key: string, ...fields: string[]): Promise<void>;
+    /**
+     * Push values to the right side of a list
+     * @param key List key
+     * @param values Values to push
+     * @returns Promise that resolves when done
+     */
+    abstract rpush(key: string, ...values: string[]): Promise<void>;
+}
+
+type getBroadcastChats = (botId: number, offset: number, limit: number, filter?: string) => Promise<string[] | number[]>;
+type MaybePromise<T> = T | Promise<T>;
+type setRestricted = (botId: number, chatId: string, type: /*Users: */ 'block' | 'deactivated' | /*Groups: */ 'banned' | 'restricted') => Promise<void>;
+type progressCallback = (id: string, sent: number, error: number, total: number) => void;
+interface BroadcastOptions {
+    storage: Storage;
+    getBroadcastChats: getBroadcastChats;
+    setRestricted?: setRestricted | null;
+    chunkSize?: number;
+    keyPrefix?: string;
+    sudoUsers: number[];
+    hasPermission?: (ctx: Context) => MaybePromise<boolean>;
+    getApi: (botId: number) => MaybePromise<Api>;
+    isMainInstance: boolean;
+    reportFrequency?: number;
+    checkQueueInterval?: number;
+    progressCallback?: progressCallback | null;
+    allowPaidBroadcast?: boolean;
+    cmds?: {
+        broadcast?: string;
+        copy?: string;
+        forward?: string;
+        addmsg?: string;
+    };
+}
+
+/**
+ * Redis storage implementation using ioredis
+ */
+declare class RedisStorage extends Storage {
+    private redis;
+    constructor(redis: Redis);
+    lrange(key: string, start: number, end: number): Promise<string[]>;
+    hgetall(key: string): Promise<Record<string, string>>;
+    lrem(key: string, count: number, value: string): Promise<void>;
+    lpop(key: string, count: number): Promise<string[] | null>;
+    del(...keys: string[]): Promise<void>;
+    hincrby(key: string, field: string, increment: number): Promise<void>;
+    hset(key: string, fieldOrObject: string | Record<string, string>, value?: string): Promise<void>;
+    hget(key: string, field: string): Promise<string | null>;
+    hdel(key: string, ...fields: string[]): Promise<void>;
+    rpush(key: string, ...values: string[]): Promise<void>;
+}
+
+/**
+ * Memory storage implementation using in-memory data structures
+ */
+declare class MemoryStorage extends Storage {
+    private lists;
+    private hashes;
+    lrange(key: string, start: number, end: number): Promise<string[]>;
+    hgetall(key: string): Promise<Record<string, string>>;
+    lrem(key: string, count: number, value: string): Promise<void>;
+    lpop(key: string, count: number): Promise<string[] | null>;
+    del(...keys: string[]): Promise<void>;
+    hincrby(key: string, field: string, increment: number): Promise<void>;
+    hset(key: string, fieldOrObject: string | Record<string, string>, value?: string): Promise<void>;
+    hget(key: string, field: string): Promise<string | null>;
+    hdel(key: string, ...fields: string[]): Promise<void>;
+    rpush(key: string, ...values: string[]): Promise<void>;
+}
+
+/**
+ * File storage implementation using filesystem
+ */
+declare class FileStorage extends Storage {
+    private baseDir;
+    constructor(baseDir?: string);
+    private ensureDir;
+    private getListPath;
+    private getHashPath;
+    private readList;
+    private writeList;
+    private readHash;
+    private writeHash;
+    lrange(key: string, start: number, end: number): Promise<string[]>;
+    hgetall(key: string): Promise<Record<string, string>>;
+    lrem(key: string, count: number, value: string): Promise<void>;
+    lpop(key: string, count: number): Promise<string[] | null>;
+    del(...keys: string[]): Promise<void>;
+    hincrby(key: string, field: string, increment: number): Promise<void>;
+    hset(key: string, fieldOrObject: string | Record<string, string>, value?: string): Promise<void>;
+    hget(key: string, field: string): Promise<string | null>;
+    hdel(key: string, ...fields: string[]): Promise<void>;
+    rpush(key: string, ...values: string[]): Promise<void>;
+}
+
+declare class Broadcaster {
+    private options;
+    static _instance?: Broadcaster;
+    private constructor();
+    static getInstance(options: BroadcastOptions): Broadcaster;
+    getMiddleware(): grammy.Composer<grammy.Context>;
+}
+declare function createBroadcaster(options: BroadcastOptions): Broadcaster;
+
+export { FileStorage, MemoryStorage, RedisStorage, Storage, createBroadcaster };

package/dist/index.d.ts

@@ -0,0 +1,180 @@
+import * as grammy from 'grammy';
+import { Context, Api } from 'grammy';
+import { Redis } from 'ioredis';
+
+/**
+ * Abstract Storage class that defines the interface for storage operations
+ * Used for broadcast queue management
+ */
+declare abstract class Storage {
+    /**
+     * Get a range of items from a list
+     * @param key List key
+     * @param start Start index (0-based)
+     * @param end End index (-1 for all)
+     * @returns Array of string values
+     */
+    abstract lrange(key: string, start: number, end: number): Promise<string[]>;
+    /**
+     * Get all fields and values from a hash
+     * @param key Hash key
+     * @returns Object with field-value pairs
+     */
+    abstract hgetall(key: string): Promise<Record<string, string>>;
+    /**
+     * Remove items from a list
+     * @param key List key
+     * @param count Number of items to remove (0 for all, positive for first N, negative for last N)
+     * @param value Value to remove
+     * @returns Promise that resolves when done
+     */
+    abstract lrem(key: string, count: number, value: string): Promise<void>;
+    /**
+     * Pop items from the left side of a list
+     * @param key List key
+     * @param count Number of items to pop
+     * @returns Array of popped values or null if list is empty
+     */
+    abstract lpop(key: string, count: number): Promise<string[] | null>;
+    /**
+     * Delete one or more keys
+     * @param keys Key(s) to delete
+     * @returns Promise that resolves when done
+     */
+    abstract del(...keys: string[]): Promise<void>;
+    /**
+     * Increment a hash field by a value
+     * @param key Hash key
+     * @param field Field name
+     * @param increment Increment value
+     * @returns Promise that resolves when done
+     */
+    abstract hincrby(key: string, field: string, increment: number): Promise<void>;
+    /**
+     * Set hash field(s)
+     * @param key Hash key
+     * @param fieldOrObject Field name or object with field-value pairs
+     * @param value Value (if field is a string)
+     * @returns Promise that resolves when done
+     */
+    abstract hset(key: string, fieldOrObject: string | Record<string, string>, value?: string): Promise<void>;
+    /**
+     * Get a hash field value
+     * @param key Hash key
+     * @param field Field name
+     * @returns Field value or null if not found
+     */
+    abstract hget(key: string, field: string): Promise<string | null>;
+    /**
+     * Delete one or more hash fields
+     * @param key Hash key
+     * @param fields Field name(s) to delete
+     * @returns Promise that resolves when done
+     */
+    abstract hdel(key: string, ...fields: string[]): Promise<void>;
+    /**
+     * Push values to the right side of a list
+     * @param key List key
+     * @param values Values to push
+     * @returns Promise that resolves when done
+     */
+    abstract rpush(key: string, ...values: string[]): Promise<void>;
+}
+
+type getBroadcastChats = (botId: number, offset: number, limit: number, filter?: string) => Promise<string[] | number[]>;
+type MaybePromise<T> = T | Promise<T>;
+type setRestricted = (botId: number, chatId: string, type: /*Users: */ 'block' | 'deactivated' | /*Groups: */ 'banned' | 'restricted') => Promise<void>;
+type progressCallback = (id: string, sent: number, error: number, total: number) => void;
+interface BroadcastOptions {
+    storage: Storage;
+    getBroadcastChats: getBroadcastChats;
+    setRestricted?: setRestricted | null;
+    chunkSize?: number;
+    keyPrefix?: string;
+    sudoUsers: number[];
+    hasPermission?: (ctx: Context) => MaybePromise<boolean>;
+    getApi: (botId: number) => MaybePromise<Api>;
+    isMainInstance: boolean;
+    reportFrequency?: number;
+    checkQueueInterval?: number;
+    progressCallback?: progressCallback | null;
+    allowPaidBroadcast?: boolean;
+    cmds?: {
+        broadcast?: string;
+        copy?: string;
+        forward?: string;
+        addmsg?: string;
+    };
+}
+
+/**
+ * Redis storage implementation using ioredis
+ */
+declare class RedisStorage extends Storage {
+    private redis;
+    constructor(redis: Redis);
+    lrange(key: string, start: number, end: number): Promise<string[]>;
+    hgetall(key: string): Promise<Record<string, string>>;
+    lrem(key: string, count: number, value: string): Promise<void>;
+    lpop(key: string, count: number): Promise<string[] | null>;
+    del(...keys: string[]): Promise<void>;
+    hincrby(key: string, field: string, increment: number): Promise<void>;
+    hset(key: string, fieldOrObject: string | Record<string, string>, value?: string): Promise<void>;
+    hget(key: string, field: string): Promise<string | null>;
+    hdel(key: string, ...fields: string[]): Promise<void>;
+    rpush(key: string, ...values: string[]): Promise<void>;
+}
+
+/**
+ * Memory storage implementation using in-memory data structures
+ */
+declare class MemoryStorage extends Storage {
+    private lists;
+    private hashes;
+    lrange(key: string, start: number, end: number): Promise<string[]>;
+    hgetall(key: string): Promise<Record<string, string>>;
+    lrem(key: string, count: number, value: string): Promise<void>;
+    lpop(key: string, count: number): Promise<string[] | null>;
+    del(...keys: string[]): Promise<void>;
+    hincrby(key: string, field: string, increment: number): Promise<void>;
+    hset(key: string, fieldOrObject: string | Record<string, string>, value?: string): Promise<void>;
+    hget(key: string, field: string): Promise<string | null>;
+    hdel(key: string, ...fields: string[]): Promise<void>;
+    rpush(key: string, ...values: string[]): Promise<void>;
+}
+
+/**
+ * File storage implementation using filesystem
+ */
+declare class FileStorage extends Storage {
+    private baseDir;
+    constructor(baseDir?: string);
+    private ensureDir;
+    private getListPath;
+    private getHashPath;
+    private readList;
+    private writeList;
+    private readHash;
+    private writeHash;
+    lrange(key: string, start: number, end: number): Promise<string[]>;
+    hgetall(key: string): Promise<Record<string, string>>;
+    lrem(key: string, count: number, value: string): Promise<void>;
+    lpop(key: string, count: number): Promise<string[] | null>;
+    del(...keys: string[]): Promise<void>;
+    hincrby(key: string, field: string, increment: number): Promise<void>;
+    hset(key: string, fieldOrObject: string | Record<string, string>, value?: string): Promise<void>;
+    hget(key: string, field: string): Promise<string | null>;
+    hdel(key: string, ...fields: string[]): Promise<void>;
+    rpush(key: string, ...values: string[]): Promise<void>;
+}
+
+declare class Broadcaster {
+    private options;
+    static _instance?: Broadcaster;
+    private constructor();
+    static getInstance(options: BroadcastOptions): Broadcaster;
+    getMiddleware(): grammy.Composer<grammy.Context>;
+}
+declare function createBroadcaster(options: BroadcastOptions): Broadcaster;
+
+export { FileStorage, MemoryStorage, RedisStorage, Storage, createBroadcaster };