feat: convert config.js to typescript

Author: marcosvega91

src/__tests__/config.js

@@ -1,4 +1,4 @@
-import {configure, getConfig} from '../config'
+import {configure, getConfig} from '../config.ts'
 
 describe('configuration API', () => {
   let originalConfig

src/__tests__/element-queries.js

@@ -1,4 +1,4 @@
-import {configure} from '../config'
+import {configure} from '../config.ts'
 import {render, renderIntoDocument} from './helpers/test-utils'
 
 beforeEach(() => {

src/__tests__/get-by-errors.js

@@ -1,6 +1,6 @@
 import cases from 'jest-in-case'
 import {screen} from '../'
-import {configure, getConfig} from '../config'
+import {configure, getConfig} from '../config.ts'
 import {render} from './helpers/test-utils'
 
 const originalConfig = getConfig()

src/__tests__/query-helper.js

@@ -1,5 +1,5 @@
 import * as queryHelpers from '../query-helpers'
-import {configure, getConfig} from '../config'
+import {configure, getConfig} from '../config.ts'
 
 const originalConfig = getConfig()
 beforeEach(() => {

src/__tests__/role.js

@@ -1,4 +1,4 @@
-import {configure, getConfig} from '../config'
+import {configure, getConfig} from '../config.ts'
 import {getQueriesForElement} from '../get-queries-for-element'
 import {render, renderIntoDocument} from './helpers/test-utils'
 

src/__tests__/suggestions.js

@@ -1,4 +1,4 @@
-import {configure} from '../config'
+import {configure} from '../config.ts'
 import {screen, getSuggestedQuery} from '..'
 import {renderIntoDocument, render} from './helpers/test-utils'
 

src/__tests__/wait-for.js

@@ -1,5 +1,5 @@
 import {waitFor} from '../'
-import {configure, getConfig} from '../config'
+import {configure, getConfig} from '../config.ts'
 import {renderIntoDocument} from './helpers/test-utils'
 
 function deferred() {

src/config.js renamed to src/config.ts

@@ -1,9 +1,32 @@
 import {prettyDOM} from './pretty-dom'
+import {Callback} from './types'
+
+export interface Config {
+  testIdAttribute: string
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  asyncWrapper(cb: (...args: any[]) => any): Promise<any>
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  eventWrapper(cb: (...args: any[]) => any): void
+  asyncUtilTimeout: number
+  computedStyleSupportsPseudoElements: boolean
+  defaultHidden: boolean
+  showOriginalStackTrace: boolean
+  throwSuggestions: boolean
+  getElementError: (message: string | null, container: Element) => Error
+}
+
+export interface ConfigFn {
+  (existingConfig: Config): Partial<Config>
+}
+
+interface InternalConfig {
+  _disableExpensiveErrorDiagnostics: boolean
+}
 
 // It would be cleaner for this to live inside './queries', but
 // other parts of the code assume that all exports from
 // './queries' are query functions.
-let config = {
+let config: Config & InternalConfig = {
   testIdAttribute: 'data-testid',
   asyncUtilTimeout: 1000,
   // this is to support React's async `act` function.
@@ -36,7 +59,9 @@ let config = {
 }
 
 export const DEFAULT_IGNORE_TAGS = 'script, style'
-export function runWithExpensiveErrorDiagnosticsDisabled(callback) {
+export function runWithExpensiveErrorDiagnosticsDisabled<T>(
+  callback: Callback<T>,
+) {
   try {
     config._disableExpensiveErrorDiagnostics = true
     return callback()
@@ -45,7 +70,7 @@ export function runWithExpensiveErrorDiagnosticsDisabled(callback) {
   }
 }
 
-export function configure(newConfig) {
+export function configure(newConfig: Partial<Config> | ConfigFn) {
   if (typeof newConfig === 'function') {
     // Pass the existing config out to the provided function
     // and accept a delta in return

src/events.js

@@ -1,4 +1,4 @@
-import {getConfig} from './config'
+import {getConfig} from './config.ts'
 import {getWindowFromNode} from './helpers'
 import {eventMap, eventAliasMap} from './event-map'
 
@@ -71,12 +71,15 @@ function createEvent(
       /* istanbul ignore if  */
       if (typeof window.DataTransfer === 'function') {
         Object.defineProperty(event, dataTransferKey, {
-          value: Object
-            .getOwnPropertyNames(dataTransferValue)
-            .reduce((acc, propName) => {
-              Object.defineProperty(acc, propName, {value: dataTransferValue[propName]});
-              return acc;
-            }, new window.DataTransfer())
+          value: Object.getOwnPropertyNames(dataTransferValue).reduce(
+            (acc, propName) => {
+              Object.defineProperty(acc, propName, {
+                value: dataTransferValue[propName],
+              })
+              return acc
+            },
+            new window.DataTransfer(),
+          ),
         })
       } else {
         Object.defineProperty(event, dataTransferKey, {

src/index.js

@@ -15,7 +15,7 @@ export * from './screen'
 export * from './query-helpers'
 export {getRoles, logRoles, isInaccessible} from './role-helpers'
 export * from './pretty-dom'
-export {configure, getConfig} from './config'
+export {configure, getConfig} from './config.ts'
 export * from './suggestions'
 
 export {

src/queries/all-utils.js

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

src/queries/label-text.js

@@ -1,4 +1,4 @@
-import {getConfig} from '../config'
+import {getConfig} from '../config.ts'
 import {checkContainerType} from '../helpers'
 import {getLabels, getRealLabels, getLabelContent} from '../label-helpers'
 import {

src/queries/text.js

@@ -1,6 +1,6 @@
 import {wrapAllByQueryWithSuggestion} from '../query-helpers'
 import {checkContainerType} from '../helpers'
-import {DEFAULT_IGNORE_TAGS} from '../config'
+import {DEFAULT_IGNORE_TAGS} from '../config.ts'
 import {
   fuzzyMatches,
   matches,

src/query-helpers.js

@@ -1,7 +1,7 @@
 import {getSuggestedQuery} from './suggestions'
 import {fuzzyMatches, matches, makeNormalizer} from './matches'
 import {waitFor} from './wait-for'
-import {getConfig} from './config'
+import {getConfig} from './config.ts'
 
 function getElementError(message, container) {
   return getConfig().getElementError(message, container)

src/role-helpers.js

@@ -1,7 +1,7 @@
 import {elementRoles} from 'aria-query'
 import {computeAccessibleName} from 'dom-accessibility-api'
 import {prettyDOM} from './pretty-dom'
-import {getConfig} from './config'
+import {getConfig} from './config.ts'
 
 const elementRoleList = buildElementRoleList(elementRoles)
 

src/suggestions.js

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

src/types.ts

@@ -0,0 +1 @@
+export type Callback<T> = () => T

src/wait-for-dom-change.js

@@ -6,7 +6,7 @@ import {
   clearTimeout,
   runWithRealTimers,
 } from './helpers'
-import {getConfig} from './config'
+import {getConfig} from './config.ts'
 
 let hasWarned = false
 

src/wait-for.js

@@ -9,7 +9,7 @@ import {
   setTimeout,
   clearTimeout,
 } from './helpers'
-import {getConfig, runWithExpensiveErrorDiagnosticsDisabled} from './config'
+import {getConfig, runWithExpensiveErrorDiagnosticsDisabled} from './config.ts'
 
 // This is so the stack trace the developer sees is one that's
 // closer to their code (because async stack traces are hard to follow).