feat: typescript types

Author: SaiKumar2121

.eslintignore

@@ -0,0 +1 @@
+**/*.d.ts

package.json

@@ -1,11 +1,11 @@
 {
   "name": "errsole-mysql",
-  "version": "1.0.3",
+  "version": "1.0.0",
   "description": "MySQL storage plugin for Errsole",
   "main": "lib/index.js",
+  "types": "types/index.d.ts",
   "scripts": {
-    "test": "jest --coverage",
-    "coveralls": "jest --coverage && cat ./coverage/lcov.info | coveralls"
+    "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [
     "errsole",
@@ -18,15 +18,11 @@
   "license": "MIT",
   "dependencies": {
     "bcryptjs": "^2.4.3",
-    "mysql2": "^3.10.1",
+    "mysql2": "^2.3.3",
     "node-cron": "^3.0.3"
   },
   "files": [
-    "lib/index.js"
-  ],
-  "devDependencies": {
-    "@jest/globals": "^29.7.0",
-    "coveralls": "^3.1.1",
-    "jest": "^29.7.0"
-  }
+    "lib",
+    "types"
+  ]
 }

tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "commonjs",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": [
+    "lib/**/*",
+    "types/**/*"
+  ]
+}

types/index.d.ts

@@ -0,0 +1,65 @@
+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;
+  }
+
+  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;
+  }
+
+  interface Config {
+    id: number;
+    key: string;
+    value: string;
+  }
+
+  interface User {
+    id: number;
+    name: string;
+    email: string;
+    role: string;
+  }
+
+  class ErrsoleMySQL {
+    constructor(options: PoolOptions);
+
+    getConfig(key: string): Promise<{ item: Config }>;
+    setConfig(key: string, value: string): Promise<{ item: Config }>;
+    deleteConfig(key: string): Promise<{}>;
+
+    postLogs(logEntries: Log[]): Promise<{}>;
+    getLogs(filters?: LogFilter): Promise<{ items: Log[] }>;
+    searchLogs(searchTerms: string[], filters?: LogFilter): Promise<{ items: Log[], filters: LogFilter[] }>;
+
+    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<{}>;
+  }
+
+  export default ErrsoleMySQL;
+}