From 2893de86d0240823507fa6a54a922b4613b1beb2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ren=C3=A9e=20Kooi?= <renee@kooi.me>
Date: Thu, 23 Jan 2020 18:11:06 +0100
Subject: [PATCH] Type improvements (#706)

* use nanobus for the emitter typings

instead of `events`, which is a bit different

* add typings for `cache` option
---
 index.d.ts      | 14 +++++++++-----
 index.test-d.ts | 40 ++++++++++++++++++++++++++++++++++++++++
 package.json    | 16 ++++++++++++----
 3 files changed, 61 insertions(+), 9 deletions(-)
 create mode 100644 index.test-d.ts

diff --git a/index.d.ts b/index.d.ts
index 9203568..fe27037 100644
--- a/index.d.ts
+++ b/index.d.ts
@@ -1,13 +1,11 @@
-/// <reference types="node" />
-
-import * as EventEmitter from 'events'
+import Nanobus = require('nanobus')
 
 export = Choo
 
 declare class Choo {
   constructor (opts?: Choo.IChoo)
-  use (callback: (state: Choo.IState, emitter: EventEmitter, app: this) => void): void
-  route (routeName: string, handler: (state: Choo.IState, emit: (name: string, ...args: any[]) => void) => void): void
+  use (callback: (state: Choo.IState, emitter: Nanobus, app: this) => void): void
+  route (routeName: string, handler: (state: Choo.IState, emit: Nanobus['emit']) => void): void
   mount (selector: string): void
   start (): HTMLElement
   toString (location: string, state?: Choo.IState): string
@@ -18,6 +16,12 @@ declare namespace Choo {
     history?: boolean
     href?: boolean
     hash?: boolean
+    cache?: number | ICache
+  }
+
+  export interface ICache {
+    get(id: string | number): undefined | null | any
+    set(id: string | number, element: any): void
   }
 
   export interface IState {
diff --git a/index.test-d.ts b/index.test-d.ts
new file mode 100644
index 0000000..f024049
--- /dev/null
+++ b/index.test-d.ts
@@ -0,0 +1,40 @@
+import { expectAssignable, expectType } from 'tsd'
+import Choo = require('.')
+
+new Choo({})
+new Choo()
+
+new Choo({ cache: 100 })
+new Choo({
+  cache: new Map()
+})
+new Choo({
+  cache: {
+    get: (id) => null,
+    set: (id, value) => expectType<any>(value)
+  }
+})
+
+const app = new Choo({
+  history: false,
+  href: true,
+})
+
+app.use((state, emitter) => {
+  state.title = 'choo choo'
+  emitter.on(state.events.DOMCONTENTLOADED, () => {
+    emitter.emit('example')
+  })
+})
+
+app.route('/', (state, emit) => {
+  expectAssignable<object>(state.params)
+  expectType<string>(state.href)
+  expectType<string>(state.route)
+  expectType<string>(state.title)
+  emit('example')
+})
+
+expectType<string>(app.toString('/'))
+
+app.mount('body')
diff --git a/package.json b/package.json
index 58ba58c..35f2aa6 100644
--- a/package.json
+++ b/package.json
@@ -23,7 +23,8 @@
     "inspect": "browserify --full-paths index -p tinyify | discify --open",
     "prepublishOnly": "npm run build",
     "start": "bankai start example",
-    "test": "standard && npm run deps && npm run test:node && npm run test:browser",
+    "test": "standard && npm run deps && npm run test:types && npm run test:node && npm run test:browser",
+    "test:types": "tsd",
     "test:node": "node test/node.js | tap-format-spec",
     "test:browser": "browserify test/browser.js | tape-run | tap-format-spec"
   },
@@ -40,7 +41,7 @@
   "dependencies": {
     "document-ready": "^2.0.1",
     "nanoassert": "^1.1.0",
-    "nanobus": "^4.2.0",
+    "nanobus": "^4.4.0",
     "nanocomponent": "^6.5.0",
     "nanohref": "^3.0.0",
     "nanohtml": "^1.1.0",
@@ -54,7 +55,6 @@
   },
   "devDependencies": {
     "@tap-format/spec": "^0.2.0",
-    "@types/node": "^10.3.1",
     "browserify": "^16.2.2",
     "bundle-collapser": "^1.2.1",
     "dependency-check": "^3.1.0",
@@ -65,6 +65,14 @@
     "standard": "^11.0.1",
     "tape": "^4.6.3",
     "tape-run": "^6.0.0",
-    "tinyify": "^2.2.0"
+    "tinyify": "^2.2.0",
+    "tsd": "^0.11.0"
+  },
+  "tsd": {
+    "compilerOptions": {
+      "lib": [
+        "DOM"
+      ]
+    }
   }
 }