errsole-mysql/types/index.d.ts

MySQL storage plugin for Errsole

declare module 'errsole-mysql' {
  import { PoolOptions } from 'mysql2';

  interface Log {
    id?: number;
    hostname: string;
    pid: number;
    source: string;
    timestamp: Date;
    level: string;
    message: string;
    meta?: string;
    errsole_id?: number;

  }

  interface LogFilter {
    hostname?: string;
    pid?: number;
    level_json?: { source: string; level: string }[];
    sources?: string[];
    levels?: string[];
    lt_id?: number;
    gt_id?: number;
    lte_timestamp?: Date;
    gte_timestamp?: Date;
    limit?: number;
    errsole_id?: number;
  }

  interface Config {
    id: number;
    key: string;
    value: string;
  }

  interface User {
    id: number;
    name: string;
    email: string;
    role: string;
  }

  interface Notification {
    id?: number;
    errsole_id: number;
    hostname: string;
    hashed_message: string;
    created_at?: Date;
    updated_at?: Date;
  }

  class ErrsoleMySQL {
    constructor(options: PoolOptions);

    getConfig(key: string): Promise<{ item: Config }>;
    setConfig(key: string, value: string): Promise<{ item: Config }>;
    deleteConfig(key: string): Promise<{}>;
    getHostnames(): Promise<{ items: string[] }>;
    postLogs(logEntries: Log[]): Promise<{}>;
    getLogs(filters?: LogFilter): Promise<{ items: Log[] }>;
    searchLogs(searchTerms: string[], filters?: LogFilter): Promise<{ items: Log[], filters: LogFilter[] }>;
    DeleteAllLogs(): Promise<void>;
    getMeta(id: number): Promise<{ item: { id: number; meta: string } }>;

    createUser(user: { name: string; email: string; password: string; role: string }): Promise<{ item: User }>;
    verifyUser(email: string, password: string): Promise<{ item: User }>;
    getUserCount(): Promise<{ count: number }>;
    getAllUsers(): Promise<{ items: User[] }>;
    getUserByEmail(email: string): Promise<{ item: User }>;
    updateUserByEmail(email: string, updates: Partial<User>): Promise<{ item: User }>;
    updatePassword(email: string, currentPassword: string, newPassword: string): Promise<{ item: User }>;
    deleteUser(userId: number): Promise<{}>;
    insertNotificationItem(notification: Notification): Promise<{ previousNotificationItem: Notification | null, todayNotificationCount: number }>;


  }

  export default ErrsoleMySQL;
}