v1.5.0 Add types for this.db and this.context (#69)

Co-authored-by: Charles Burgess <consulting@cvburgess.com>
cvburgess · Aug 9, 2021 · 4e4ab7a · 4e4ab7a
1 parent 2bce444
commit 4e4ab7a
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## v1.5.0 - 08-09-2021
+
+- Add types for `this.db` and `this.context` ( Thanks @astorije )
+
 ## v1.4.1 - 04-09-2021
 
 - Support GraphQL versions >= v14

diff --git a/index.d.ts b/index.d.ts
@@ -7,7 +7,9 @@ declare module "knex" {
   }
 }
 
-export class SQLDataSource extends DataSource {
+export class SQLDataSource<TContext = any> extends DataSource<TContext> {
+  protected context: TContext;
   protected knex: Knex;
+  protected db: Knex;
   constructor(config: Knex.Config | Knex);
 }
diff --git a/index.test-d.ts b/index.test-d.ts
@@ -2,12 +2,24 @@ import { expectError, expectType } from "tsd";
 import Knex from "knex";
 import { SQLDataSource } from "./index";
 
+interface MyTestContext {
+  foo: string;
+}
+
 type MyRow = { id: string; value: number };
-class MyTestDataSource extends SQLDataSource {
+class MyTestDataSource extends SQLDataSource<MyTestContext> {
   public testKnexExists() {
     expectType<Knex>(this.knex);
   }
 
+  public testDbExists() {
+    expectType<Knex>(this.db);
+  }
+
+  public testContextExists() {
+    expectType<MyTestContext>(this.context);
+  }
+
   public async testCacheFunctionPassesResult() {
     expectType<MyRow[]>(
       await this.knex<MyRow>("mytable")

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,9 +1,9 @@
 {
   "name": "datasource-sql",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "SQL DataSource for Apollo GraphQL projects",
   "main": "index.js",
-  "typings": "index.d.ts",
+  "types": "index.d.ts",
   "scripts": {
     "lint": "prettier '**/*.js' && eslint '**/*.js'",
     "lint:fix": "prettier --write '**/*.{js,ts}' && eslint --fix '**/*.js'",