fallback to HTMLElement for specific interfaces

close #29
g-plane · Feb 21, 2023 · 4534a0c · 4534a0c
1 parent 822d03a
commit 4534a0c
Show file tree

Hide file tree

Showing 5 changed files with 127 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## Unreleased
 
 - Added fallback support to strict parser.
+- Fallback to `HTMLElement` for `HTMLElement`, `Document` and `DocumentFragment`. (Close [#29](https://github.com/g-plane/typed-query-selector/issues/29))
 
 ## v2.8.1
 

diff --git a/shim.d.ts b/shim.d.ts
@@ -12,4 +12,36 @@ declare global {
   interface Element {
     closest<S extends string>(selector: S): ParseSelector<S> | null
   }
+
+  interface HTMLElement {
+    querySelector<S extends string>(
+      selector: S,
+    ): ParseSelector<S, HTMLElement> | null
+
+    querySelectorAll<S extends string>(
+      selector: S,
+    ): NodeListOf<ParseSelector<S, HTMLElement>>
+
+    closest<S extends string>(selector: S): ParseSelector<S, HTMLElement> | null
+  }
+
+  interface Document {
+    querySelector<S extends string>(
+      selector: S,
+    ): ParseSelector<S, HTMLElement> | null
+
+    querySelectorAll<S extends string>(
+      selector: S,
+    ): NodeListOf<ParseSelector<S, HTMLElement>>
+  }
+
+  interface DocumentFragment {
+    querySelector<S extends string>(
+      selector: S,
+    ): ParseSelector<S, HTMLElement> | null
+
+    querySelectorAll<S extends string>(
+      selector: S,
+    ): NodeListOf<ParseSelector<S, HTMLElement>>
+  }
 }
diff --git a/shim.test.ts b/shim.test.ts
@@ -1,12 +1,15 @@
 import './shim'
 import type { Equal, Expect } from '@type-challenges/utils'
 
-const el = document.querySelector(
+const htmlEl = document.querySelector(
   '.container > #sign-up-form > div#notice, span.tip',
 )
-type TestEl = Expect<Equal<typeof el, HTMLDivElement | HTMLSpanElement | null>>
+type TestEl = Expect<
+  Equal<typeof htmlEl, HTMLDivElement | HTMLSpanElement | null>
+>
 
-const link = document.querySelector<HTMLAnchorElement>(prompt()!)
+declare let selector: string
+const link = document.querySelector<string, HTMLAnchorElement>(selector)
 type TestLink = Expect<Equal<typeof link, HTMLAnchorElement | null>>
 
 // @ts-expect-error
@@ -20,7 +23,20 @@ results.push(document.querySelector('div'))
 // @ts-expect-error
 results.push(document.querySelector('div#app'))
 
-const closest = el!.closest('button.btn-confirm, a.link')
+const closest = htmlEl!.closest('button.btn-confirm, a.link')
 type TestClosest = Expect<
   Equal<typeof closest, HTMLButtonElement | HTMLAnchorElement | null>
 >
+
+const unknownEl = document.querySelector('unknown')
+type TestElement = Expect<Equal<typeof unknownEl, HTMLElement | null>>
+
+declare let btn: HTMLButtonElement
+const elementOfBtn = btn.querySelector('unknown')
+type TestElementOfBtn = Expect<Equal<typeof elementOfBtn, HTMLElement | null>>
+
+declare let element: Element
+const elementOfElement = element.querySelector('unknown')
+type TestElementOfElement = Expect<
+  Equal<typeof elementOfElement, Element | null>
+>
diff --git a/strict.d.ts b/strict.d.ts
@@ -16,4 +16,56 @@ declare global {
       selector: S,
     ): [E] extends [never] ? never : E | null
   }
+
+  interface HTMLElement {
+    querySelector<
+      S extends string,
+      E extends StrictlyParseSelector<S, HTMLElement>,
+    >(
+      selector: S,
+    ): [E] extends [never] ? never : E | null
+
+    querySelectorAll<
+      S extends string,
+      E extends StrictlyParseSelector<S, HTMLElement>,
+    >(
+      selector: S,
+    ): [E] extends [never] ? never : NodeListOf<E>
+
+    closest<S extends string, E extends StrictlyParseSelector<S, HTMLElement>>(
+      selector: S,
+    ): [E] extends [never] ? never : E | null
+  }
+
+  interface Document {
+    querySelector<
+      S extends string,
+      E extends StrictlyParseSelector<S, HTMLElement>,
+    >(
+      selector: S,
+    ): [E] extends [never] ? never : E | null
+
+    querySelectorAll<
+      S extends string,
+      E extends StrictlyParseSelector<S, HTMLElement>,
+    >(
+      selector: S,
+    ): [E] extends [never] ? never : NodeListOf<E>
+  }
+
+  interface DocumentFragment {
+    querySelector<
+      S extends string,
+      E extends StrictlyParseSelector<S, HTMLElement>,
+    >(
+      selector: S,
+    ): [E] extends [never] ? never : E | null
+
+    querySelectorAll<
+      S extends string,
+      E extends StrictlyParseSelector<S, HTMLElement>,
+    >(
+      selector: S,
+    ): [E] extends [never] ? never : NodeListOf<E>
+  }
 }
diff --git a/strict.test.ts b/strict.test.ts
@@ -41,17 +41,23 @@ let variableSelector = 'p a.lnk'
 const e35 = document.querySelector(`${constantSelector}`)
 const e36 = document.querySelector(`${variableSelector}`)
 
+declare let element: Element
+const e37 = element.querySelector('unknown')
+
+declare let btn: HTMLButtonElement
+const e38 = btn.querySelector('unknown')
+
 type Tests = [
-  Expect<Equal<typeof e1, Element | null>>,
-  Expect<Equal<typeof e2, Element | null>>,
-  Expect<Equal<typeof e3, Element | null>>,
-  Expect<Equal<typeof e4, Element | null>>,
+  Expect<Equal<typeof e1, HTMLElement | null>>,
+  Expect<Equal<typeof e2, HTMLElement | null>>,
+  Expect<Equal<typeof e3, HTMLElement | null>>,
+  Expect<Equal<typeof e4, HTMLElement | null>>,
   Expect<Equal<typeof e5, never>>,
   Expect<Equal<typeof e6, never>>,
   Expect<Equal<typeof e7, never>>,
   Expect<Equal<typeof e8, never>>,
-  Expect<Equal<typeof e9, Element | null>>,
-  Expect<Equal<typeof e10, Element | null>>,
+  Expect<Equal<typeof e9, HTMLElement | null>>,
+  Expect<Equal<typeof e10, HTMLElement | null>>,
   Expect<Equal<typeof e11, never>>,
   Expect<Equal<typeof e12, never>>,
   Expect<Equal<typeof e13, never>>,
@@ -60,24 +66,26 @@ type Tests = [
   Expect<Equal<typeof e16, HTMLDivElement | null>>,
   Expect<Equal<typeof e17, HTMLSpanElement | null>>,
   Expect<Equal<typeof e18, never>>,
-  Expect<Equal<typeof e19, Element | null>>,
+  Expect<Equal<typeof e19, HTMLElement | null>>,
   Expect<Equal<typeof e20, never>>,
-  Expect<Equal<typeof e21, Element | null>>,
-  Expect<Equal<typeof e22, Element | null>>,
-  Expect<Equal<typeof e23, Element | null>>,
-  Expect<Equal<typeof e24, Element | null>>,
-  Expect<Equal<typeof e25, Element | null>>,
+  Expect<Equal<typeof e21, HTMLElement | null>>,
+  Expect<Equal<typeof e22, HTMLElement | null>>,
+  Expect<Equal<typeof e23, HTMLElement | null>>,
+  Expect<Equal<typeof e24, HTMLElement | null>>,
+  Expect<Equal<typeof e25, HTMLElement | null>>,
   Expect<Equal<typeof e26, never>>,
   Expect<Equal<typeof e27, never>>,
   Expect<Equal<typeof e28, HTMLDivElement | HTMLSpanElement | null>>,
   Expect<Equal<typeof e29, never>>,
   Expect<Equal<typeof e30, never>>,
   Expect<Equal<typeof e31, never>>,
-  Expect<Equal<typeof e32, HTMLDivElement | Element | null>>,
+  Expect<Equal<typeof e32, HTMLDivElement | HTMLElement | null>>,
   Expect<Equal<typeof e33, never>>,
   Expect<Equal<typeof e34, never>>,
   Expect<Equal<typeof e35, HTMLAnchorElement | null>>,
-  Expect<Equal<typeof e36, Element | null>>,
+  Expect<Equal<typeof e36, HTMLElement | null>>,
+  Expect<Equal<typeof e37, Element | null>>,
+  Expect<Equal<typeof e38, HTMLElement | null>>,
 ]
 
 // @ts-expect-error