Merge pull request #9 from hypothesis/publish-type-declarations

Emit type declaration files when building library

Author: acelaya

package.json

@@ -3,7 +3,8 @@
   "version": "1.0.1",
   "description": "Frontend testing utilities for Hypothesis projects",
   "type": "module",
-  "main": "lib/index.js",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "repository": "https://github.com/hypothesis/frontend-testing",
   "author": "Hypothesis Developers <eng@list.hypothes.is>",
   "license": "BSD-2-Clause",

src/accessibility.ts

@@ -10,6 +10,12 @@ export type Scenario = {
   /**
    * A function that returns the rendered output to test, or an Enzyme wrapper
    * created using Enzyme's `mount` function.
+   *
+   * Returning a VNode is preferred. An Enzyme wrapper for a component with a
+   * top-level Fragment will result in the test being run for the first DOM
+   * child node only.
+   * Use the Enzyme wrapper only if really needed, and consider wrapping your
+   * component with a `<div />` in that case.
    */
   content: () => VNode | ReactWrapper;
 };

src/index.ts

@@ -1,4 +1,5 @@
 export type { Scenario } from './accessibility.js';
 export { checkAccessibility } from './accessibility.js';
 export { mockImportedComponents } from './mock-imported-components.js';
+export type { TestTimeout, TimeoutSpec } from './wait.js';
 export { delay, waitFor, waitForElement } from './wait.js';

tsconfig.json

@@ -13,6 +13,7 @@
 
     /* Emit */
     "outDir": "./lib",
+    "declaration": true,
 
     /* Interop Constraints */
     "esModuleInterop": true,