chore: migrate matches.js to typescript

Author: marcosvega91

src/__tests__/matches.js

@@ -1,4 +1,4 @@
-import {fuzzyMatches, matches} from '../matches'
+import {fuzzyMatches, matches} from '../matches.ts'
 
 // unit tests for text match utils
 

src/index.js

@@ -7,7 +7,7 @@ export * from './wait-for'
 export * from './wait-for-element'
 export * from './wait-for-element-to-be-removed'
 export * from './wait-for-dom-change'
-export {getDefaultNormalizer} from './matches'
+export {getDefaultNormalizer} from './matches.ts'
 export * from './get-node-text'
 export * from './events'
 export * from './get-queries-for-element'

src/matches.js renamed to src/matches.ts

@@ -1,19 +1,61 @@
-function assertNotNullOrUndefined(matcher) {
-  if (matcher == null) {
+import {ARIARole} from 'aria-query'
+import {Nullish} from './types'
+
+export type ByRoleMatcher = ARIARole | MatcherFunction | {}
+
+export type Matcher = MatcherFunction | RegExp | string
+
+export type MatcherFunction = (
+  content: string,
+  element: Nullish<Element>,
+) => boolean
+
+export type NormalizerFn = (text: string) => string
+
+export interface DefaultNormalizerOptions {
+  trim?: boolean
+  collapseWhitespace?: boolean
+}
+
+export interface MatcherOptions {
+  exact?: boolean
+  /** Use normalizer with getDefaultNormalizer instead */
+  trim?: boolean
+  /** Use normalizer with getDefaultNormalizer instead */
+  collapseWhitespace?: boolean
+  normalizer?: NormalizerFn
+  /** suppress suggestions for a specific query */
+  suggest?: boolean
+}
+
+export type NormalizerOptions = DefaultNormalizerOptions & {
+  normalizer?: NormalizerFn
+}
+
+function assertNotNullOrUndefined<T>(
+  matcher: T,
+): asserts matcher is NonNullable<T> {
+  if (matcher === null || matcher === undefined) {
     throw new Error(
+      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
       `It looks like ${matcher} was passed instead of a matcher. Did you do something like getByText(${matcher})?`,
     )
   }
 }
 
-function fuzzyMatches(textToMatch, node, matcher, normalizer) {
+function fuzzyMatches(
+  textToMatch: Nullish<string>,
+  node: Nullish<Element>,
+  matcher: Nullish<Matcher>,
+  normalizer: NormalizerFn,
+) {
   if (typeof textToMatch !== 'string') {
     return false
   }
-
   assertNotNullOrUndefined(matcher)
 
   const normalizedText = normalizer(textToMatch)
+
   if (typeof matcher === 'string') {
     return normalizedText.toLowerCase().includes(matcher.toLowerCase())
   } else if (typeof matcher === 'function') {
@@ -23,7 +65,12 @@ function fuzzyMatches(textToMatch, node, matcher, normalizer) {
   }
 }
 
-function matches(textToMatch, node, matcher, normalizer) {
+function matches(
+  textToMatch: Nullish<string>,
+  node: Nullish<Element>,
+  matcher: Nullish<Matcher>,
+  normalizer: NormalizerFn,
+) {
   if (typeof textToMatch !== 'string') {
     return false
   }
@@ -40,7 +87,10 @@ function matches(textToMatch, node, matcher, normalizer) {
   }
 }
 
-function getDefaultNormalizer({trim = true, collapseWhitespace = true} = {}) {
+function getDefaultNormalizer({
+  trim = true,
+  collapseWhitespace = true,
+}: DefaultNormalizerOptions = {}): NormalizerFn {
   return text => {
     let normalizedText = text
     normalizedText = trim ? normalizedText.trim() : normalizedText
@@ -60,7 +110,12 @@ function getDefaultNormalizer({trim = true, collapseWhitespace = true} = {}) {
  * @param {Function|undefined} normalizer The user-specified normalizer
  * @returns {Function} A normalizer
  */
-function makeNormalizer({trim, collapseWhitespace, normalizer}) {
+
+function makeNormalizer({
+  trim,
+  collapseWhitespace,
+  normalizer,
+}: NormalizerOptions) {
   if (normalizer) {
     // User has specified a custom normalizer
     if (

src/queries/all-utils.js

@@ -1,4 +1,4 @@
-export * from '../matches'
+export * from '../matches.ts'
 export * from '../get-node-text'
 export * from '../query-helpers'
 export * from '../config.ts'

src/query-helpers.js

@@ -1,5 +1,5 @@
 import {getSuggestedQuery} from './suggestions'
-import {fuzzyMatches, matches, makeNormalizer} from './matches'
+import {fuzzyMatches, matches, makeNormalizer} from './matches.ts'
 import {waitFor} from './wait-for'
 import {getConfig} from './config.ts'
 

src/suggestions.js

@@ -1,5 +1,5 @@
 import {computeAccessibleName} from 'dom-accessibility-api'
-import {getDefaultNormalizer} from './matches'
+import {getDefaultNormalizer} from './matches.ts'
 import {getNodeText} from './get-node-text'
 import {DEFAULT_IGNORE_TAGS, getConfig} from './config.ts'
 import {getImplicitAriaRoles, isInaccessible} from './role-helpers'

src/types.ts

@@ -1 +1,3 @@
+export type Nullish<T> = T | null | undefined
+
 export type Callback<T> = () => T