@openrfid/core 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,407 @@
+/**
+ * OpenRFID Simulator - The Open Source RFID Reader Simulator for Developers.
+ * Copyright (c) 2026 RFID Software India Private Limited - https://rfidsoftwares.com
+ *
+ * Licensed under the MIT License.
+ * For RFID software, enterprise tools, and hardware drivers, visit https://rfidsoftwares.com
+ */
+declare enum ComponentState {
+    UNINITIALIZED = "UNINITIALIZED",
+    INITIALIZED = "INITIALIZED",
+    RUNNING = "RUNNING",
+    STOPPED = "STOPPED",
+    DISPOSED = "DISPOSED",
+    ERROR = "ERROR"
+}
+interface ILifecycle {
+    state: ComponentState;
+    initialize(): Promise<void>;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    dispose(): Promise<void>;
+}
+
+/**
+ * OpenRFID Simulator - The Open Source RFID Reader Simulator for Developers.
+ * Copyright (c) 2026 RFID Software India Private Limited - https://rfidsoftwares.com
+ *
+ * Licensed under the MIT License.
+ * For RFID software, enterprise tools, and hardware drivers, visit https://rfidsoftwares.com
+ */
+interface EventMap {
+    ReaderConnected: {
+        readerId: string;
+        name: string;
+        ip: string;
+        port: number;
+    };
+    ReaderDisconnected: {
+        readerId: string;
+        reason?: string;
+    };
+    TagDetected: {
+        readerId: string;
+        antennaId: number;
+        epc: string;
+        tid?: string;
+        rssi: number;
+        timestamp: number;
+        protocol?: string;
+    };
+    TagRemoved: {
+        epc: string;
+        readerId: string;
+        timestamp: number;
+    };
+    TagMoved: {
+        epc: string;
+        fromZone?: string;
+        toZone?: string;
+        timestamp: number;
+    };
+    ReaderError: {
+        readerId: string;
+        error: string;
+        code?: string;
+    };
+    MQTTPublished: {
+        topic: string;
+        payload: string;
+        qos: number;
+    };
+    HTTPRequestReceived: {
+        method: string;
+        path: string;
+        statusCode: number;
+    };
+    SystemLog: {
+        level: 'debug' | 'info' | 'warn' | 'error';
+        message: string;
+        data?: any;
+    };
+}
+type EventHandler<T = any> = (payload: T) => void | Promise<void>;
+declare class EventBus {
+    private listeners;
+    on<K extends keyof EventMap>(event: K, handler: EventHandler<EventMap[K]>): () => void;
+    off<K extends keyof EventMap>(event: K, handler: EventHandler<EventMap[K]>): void;
+    emit<K extends keyof EventMap>(event: K, payload: EventMap[K]): Promise<void>;
+    removeAllListeners(event?: keyof EventMap): void;
+    listenerCount(event: keyof EventMap): number;
+}
+
+/**
+ * OpenRFID Simulator - The Open Source RFID Reader Simulator for Developers.
+ * Copyright (c) 2026 RFID Software India Private Limited - https://rfidsoftwares.com
+ *
+ * Licensed under the MIT License.
+ * For RFID software, enterprise tools, and hardware drivers, visit https://rfidsoftwares.com
+ */
+type Factory<T> = (container: Container) => T;
+declare class Container {
+    private services;
+    register<T>(key: string, factory: Factory<T>, singleton?: boolean): void;
+    registerInstance<T>(key: string, instance: T): void;
+    resolve<T>(key: string): T;
+    has(key: string): boolean;
+    reset(): void;
+}
+
+/**
+ * OpenRFID Simulator - The Open Source RFID Reader Simulator for Developers.
+ * Copyright (c) 2026 RFID Software India Private Limited - https://rfidsoftwares.com
+ *
+ * Licensed under the MIT License.
+ * For RFID software, enterprise tools, and hardware drivers, visit https://rfidsoftwares.com
+ */
+interface AppConfig {
+    server: {
+        port: number;
+        host: string;
+    };
+    mqtt: {
+        enabled: boolean;
+        brokerUrl: string;
+        topicPrefix: string;
+    };
+    websocket: {
+        port: number;
+    };
+    storage: {
+        dbPath: string;
+        memoryEventLimit: number;
+        eventWarningThreshold: number;
+        autoTrimEnabled: boolean;
+    };
+    simulator: {
+        defaultReadIntervalMs: number;
+        defaultRssi: number;
+    };
+    [key: string]: any;
+}
+declare const defaultConfig: AppConfig;
+type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+declare class ConfigManager {
+    private config;
+    private listeners;
+    constructor(initialConfig?: DeepPartial<AppConfig>);
+    get<T = any>(path: string): T;
+    set(path: string, value: any): void;
+    getAll(): AppConfig;
+    onChange(listener: (config: AppConfig) => void): () => void;
+    private notify;
+    private deepMerge;
+}
+
+/**
+ * OpenRFID Simulator - The Open Source RFID Reader Simulator for Developers.
+ * Copyright (c) 2026 RFID Software India Private Limited - https://rfidsoftwares.com
+ *
+ * Licensed under the MIT License.
+ * For RFID software, enterprise tools, and hardware drivers, visit https://rfidsoftwares.com
+ */
+type LogLevel = 'debug' | 'info' | 'warn' | 'error';
+interface LogEntry {
+    timestamp: string;
+    level: LogLevel;
+    context?: string;
+    message: string;
+    data?: any;
+}
+declare class Logger {
+    private context;
+    private minLevel;
+    private levelWeights;
+    constructor(context?: string, minLevel?: LogLevel);
+    debug(message: string, data?: any): void;
+    info(message: string, data?: any): void;
+    warn(message: string, data?: any): void;
+    error(message: string, data?: any): void;
+    private log;
+}
+
+/**
+ * OpenRFID Simulator - The Open Source RFID Reader Simulator for Developers.
+ * Copyright (c) 2026 RFID Software India Private Limited - https://rfidsoftwares.com
+ *
+ * Licensed under the MIT License.
+ * For RFID software, enterprise tools, and hardware drivers, visit https://rfidsoftwares.com
+ */
+interface ReaderRecord {
+    id: string;
+    name: string;
+    vendor: string;
+    model: string;
+    ip: string;
+    port: number;
+    protocol: string;
+    status: string;
+    createdAt: string;
+    readRate?: number;
+    readMode?: 'continuous' | 'periodic';
+    readIntervalValue?: number;
+    readIntervalUnit?: 'seconds' | 'minutes' | 'hours';
+    epcFilterStart?: string;
+    epcFilterEnd?: string;
+    epcFilterPrefix?: string;
+}
+interface TagRecord {
+    id: string;
+    epc: string;
+    tid?: string;
+    userMemory?: string;
+    accessPassword?: string;
+    killPassword?: string;
+    protocol?: string;
+}
+interface EventRecord {
+    id: string;
+    date: string;
+    timestamp: string;
+    readerId: string;
+    antennaId: number;
+    epc: string;
+    rssi: number;
+    protocol: string;
+    payload?: string;
+}
+/** Options for filtering/paginating event queries */
+interface EventQueryOptions {
+    date?: string;
+    from?: string;
+    to?: string;
+    readerId?: string;
+    epc?: string;
+    protocol?: string;
+    limit?: number;
+    offset?: number;
+}
+/** Storage-level statistics about the event log */
+interface EventStorageStats {
+    totalEvents: number;
+    totalDays: number;
+    oldestEventDate: string | null;
+    newestEventDate: string | null;
+    eventsByDate: {
+        date: string;
+        count: number;
+    }[];
+}
+interface AntennaRecord {
+    id: string;
+    readerId: string;
+    index: number;
+    gain: number;
+    power: number;
+    frequency: number;
+    rssiOffset: number;
+    readZone: string;
+    enabled: boolean;
+}
+interface IStorageDriver {
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    getReaders(): Promise<ReaderRecord[]>;
+    getReaderById(id: string): Promise<ReaderRecord | null>;
+    saveReader(reader: ReaderRecord): Promise<void>;
+    deleteReader(id: string): Promise<void>;
+    saveAntenna(antenna: AntennaRecord): Promise<void>;
+    getAntennasByReaderId(readerId: string): Promise<AntennaRecord[]>;
+    getTags(): Promise<TagRecord[]>;
+    getTagByEpc(epc: string): Promise<TagRecord | null>;
+    saveTag(tag: TagRecord): Promise<void>;
+    deleteTag(id: string): Promise<void>;
+    logEvent(event: EventRecord): Promise<void>;
+    getEvents(options?: EventQueryOptions): Promise<EventRecord[]>;
+    getEventsByDate(date: string, limit?: number, offset?: number): Promise<EventRecord[]>;
+    getEventDates(): Promise<{
+        date: string;
+        count: number;
+    }[]>;
+    getEventStats(): Promise<EventStorageStats>;
+    getEventCount(options?: Omit<EventQueryOptions, 'limit' | 'offset'>): Promise<number>;
+    deleteEventsByDate(date: string): Promise<{
+        deleted: number;
+    }>;
+    clearAllEvents(): Promise<{
+        deleted: number;
+    }>;
+    clearAllData(): Promise<void>;
+}
+
+/**
+ * OpenRFID Simulator - The Open Source RFID Reader Simulator for Developers.
+ * Copyright (c) 2026 RFID Software India Private Limited - https://rfidsoftwares.com
+ *
+ * Licensed under the MIT License.
+ * For RFID software, enterprise tools, and hardware drivers, visit https://rfidsoftwares.com
+ */
+
+declare class MemoryStorageDriver implements IStorageDriver {
+    private config?;
+    private readers;
+    private tags;
+    private antennas;
+    private events;
+    private connected;
+    private maxEvents;
+    private warningThreshold;
+    private autoTrim;
+    private configUnsubscribe?;
+    constructor(config?: ConfigManager | undefined);
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    getReaders(): Promise<ReaderRecord[]>;
+    getReaderById(id: string): Promise<ReaderRecord | null>;
+    saveReader(reader: ReaderRecord): Promise<void>;
+    deleteReader(id: string): Promise<void>;
+    saveAntenna(antenna: AntennaRecord): Promise<void>;
+    getAntennasByReaderId(readerId: string): Promise<AntennaRecord[]>;
+    getTags(): Promise<TagRecord[]>;
+    getTagByEpc(epc: string): Promise<TagRecord | null>;
+    saveTag(tag: TagRecord): Promise<void>;
+    deleteTag(id: string): Promise<void>;
+    logEvent(event: EventRecord): Promise<void>;
+    getEvents(options?: EventQueryOptions): Promise<EventRecord[]>;
+    getEventsByDate(date: string, limit?: number, offset?: number): Promise<EventRecord[]>;
+    getEventDates(): Promise<{
+        date: string;
+        count: number;
+    }[]>;
+    getEventStats(): Promise<EventStorageStats>;
+    getEventCount(options?: Omit<EventQueryOptions, 'limit' | 'offset'>): Promise<number>;
+    deleteEventsByDate(date: string): Promise<{
+        deleted: number;
+    }>;
+    clearAllEvents(): Promise<{
+        deleted: number;
+    }>;
+    clearAllData(): Promise<void>;
+    getMemoryUsage(): {
+        current: number;
+        limit: number;
+        percent: number;
+        isWarning: boolean;
+    };
+    setMemoryLimit(limit: number): void;
+}
+
+/**
+ * OpenRFID Simulator - The Open Source RFID Reader Simulator for Developers.
+ * Copyright (c) 2026 RFID Software India Private Limited - https://rfidsoftwares.com
+ *
+ * Licensed under the MIT License.
+ * For RFID software, enterprise tools, and hardware drivers, visit https://rfidsoftwares.com
+ */
+
+declare class SqliteStorageDriver implements IStorageDriver {
+    private dbPath;
+    private db;
+    constructor(dbPath?: string);
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    private initTables;
+    getReaders(): Promise<ReaderRecord[]>;
+    getReaderById(id: string): Promise<ReaderRecord | null>;
+    saveReader(reader: ReaderRecord): Promise<void>;
+    deleteReader(id: string): Promise<void>;
+    saveAntenna(antenna: AntennaRecord): Promise<void>;
+    getAntennasByReaderId(readerId: string): Promise<AntennaRecord[]>;
+    getTags(): Promise<TagRecord[]>;
+    getTagByEpc(epc: string): Promise<TagRecord | null>;
+    saveTag(tag: TagRecord): Promise<void>;
+    deleteTag(id: string): Promise<void>;
+    logEvent(event: EventRecord): Promise<void>;
+    getEvents(options?: EventQueryOptions): Promise<EventRecord[]>;
+    getEventsByDate(date: string, limit?: number, offset?: number): Promise<EventRecord[]>;
+    getEventDates(): Promise<{
+        date: string;
+        count: number;
+    }[]>;
+    getEventStats(): Promise<EventStorageStats>;
+    getEventCount(options?: Omit<EventQueryOptions, 'limit' | 'offset'>): Promise<number>;
+    deleteEventsByDate(date: string): Promise<{
+        deleted: number;
+    }>;
+    clearAllEvents(): Promise<{
+        deleted: number;
+    }>;
+    clearAllData(): Promise<void>;
+    private checkConnection;
+}
+
+declare const BRAND: {
+    name: string;
+    tagline: string;
+    organization: string;
+    website: string;
+    docsUrl: string;
+    githubUrl: string;
+    license: string;
+    copyright: string;
+    headerBanner: string;
+};
+
+export { type AntennaRecord, type AppConfig, BRAND, ComponentState, ConfigManager, Container, type DeepPartial, EventBus, type EventHandler, type EventMap, type EventQueryOptions, type EventRecord, type EventStorageStats, type Factory, type ILifecycle, type IStorageDriver, type LogEntry, type LogLevel, Logger, MemoryStorageDriver, type ReaderRecord, SqliteStorageDriver, type TagRecord, defaultConfig };