feat: define types for events emitted by query builder

adonis-typings/database.ts

@@ -635,6 +635,19 @@ declare module '@ioc:Adonis/Lucid/Database' {
 		profiler: ProfilerRowContract | ProfilerContract
 	}>
 
+	/**
+	 * Shape of the data emitted by the `db:query event`
+	 */
+	export type DbQueryEventNode = {
+		connection: string
+		model?: string
+		ddl?: boolean
+		duration?: [number, number]
+		method: string
+		sql: string
+		bindings?: any[]
+	}
+
 	/**
 	 * Database contract serves as the main API to interact with multiple
 	 * database connections
@@ -657,7 +670,7 @@ declare module '@ioc:Adonis/Lucid/Database' {
 		/**
 		 * Pretty print query logs
 		 */
-		prettyPrint: (queryLog: any) => void
+		prettyPrint: (queryLog: DbQueryEventNode) => void
 
 		/**
 		 * Name of the primary connection defined inside `config/database.ts`

adonis-typings/events.ts

@@ -0,0 +1,15 @@
+/*
+ * @adonisjs/lucid
+ *
+ * (c) Harminder Virk <virk@adonisjs.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare module '@ioc:Adonis/Core/Event' {
+	import { DbQueryEventNode } from '@ioc:Adonis/Lucid/Database'
+	interface EventsList {
+		'db:query': DbQueryEventNode
+	}
+}

adonis-typings/index.ts

@@ -8,6 +8,7 @@
  */
 
 /// <reference path="./database.ts" />
+/// <reference path="./events.ts" />
 /// <reference path="./querybuilder.ts" />
 /// <reference path="./model.ts" />
 /// <reference path="./orm.ts" />

npm-audit.html

@@ -55,7 +55,7 @@ <h5 class="card-title">
                 <div class="card">
                     <div class="card-body">
                         <h5 class="card-title">
-                            October 14th 2020, 8:27:13 am
+                            October 14th 2020, 8:27:38 am
                         </h5>
                         <p class="card-text">Last updated</p>
                     </div>

src/Helpers/prettyPrint.ts

@@ -7,8 +7,9 @@
  * file that was distributed with this source code.
  */
 
-import kleur from 'kleur'
+import type kleur from 'kleur'
 import { inspect } from 'util'
+import { DbQueryEventNode } from '@ioc:Adonis/Lucid/Database'
 
 /**
  * Colorizes the sql query based upon the method
@@ -34,7 +35,7 @@ function colorizeQuery(color: typeof kleur, method: string, sql: string) {
 /**
  * Pretty print queries
  */
-export function prettyPrint(queryLog: any) {
+export function prettyPrint(queryLog: DbQueryEventNode) {
 	/**
 	 * Lazy loading pretty printed dependencies
 	 */

src/QueryRunner/index.ts

@@ -80,7 +80,7 @@ export class QueryRunner {
 		 * toSQL too many times and also get the actual time it took to
 		 * execute the query
 		 */
-		query['once']('query', (sql) => this.reporter.begin({ ...this.logData, ...sql }))
+		query['once']('query', (sql: any) => this.reporter.begin({ ...this.logData, ...sql }))
 
 		const [error, result] = await this.executeQuery(query)
 		this.reporter.end(error)
@@ -110,7 +110,7 @@ export class QueryRunner {
 		 * toSQL too many times and also get the actual time it took to
 		 * execute the query
 		 */
-		query['once']('query', (sql) => this.reporter.begin({ ...this.logData, ...sql }))
+		query['once']('query', (sql: any) => this.reporter.begin({ ...this.logData, ...sql }))
 
 		/**
 		 * Execute query and report event and profiler data