WIP: chore(typescript): add TypeScript typings

package.json

@@ -3,6 +3,7 @@
   "version": "0.0.0-semantically-released",
   "description": "Simple and complete custom Cypress commands and utilities that encourage good testing practices.",
   "main": "dist/index.js",
+  "typings": "typings",
   "engines": {
     "node": "> 6"
   },
@@ -20,7 +21,8 @@
     "test:cypress:dev": "npm-run-all --silent --parallel --race test:cypress:serve test:cypress:open",
     "validate": "kcd-scripts validate build,lint,test",
     "setup": "npm install && npm run validate -s",
-    "precommit": "kcd-scripts precommit"
+    "precommit": "kcd-scripts precommit",
+    "dtslint": "dtslint typings"
   },
   "files": [
     "dist",
@@ -43,6 +45,7 @@
   },
   "devDependencies": {
     "cypress": "^3.0.1",
+    "dtslint": "^0.3.0",
     "kcd-scripts": "^0.37.0",
     "npm-run-all": "^4.1.2",
     "serve": "^10.0.0",

typings/index.d.ts

@@ -0,0 +1,37 @@
+// TypeScript Version: 2.8
+import {
+  SelectorMatcherOptions,
+  Matcher,
+  MatcherOptions,
+  getByTestId,
+} from 'dom-testing-library'
+
+export namespace Cypress {
+  type GetByAttribute = (id: Matcher, options?: MatcherOptions) => Chainable
+
+  type QueryByText = (
+    id: Matcher,
+    options?: SelectorMatcherOptions,
+  ) => Chainable
+
+  type AllByText = (id: Matcher, options?: SelectorMatcherOptions) => Chainable
+
+  type GetByText = (id: Matcher, options?: SelectorMatcherOptions) => Chainable
+
+  interface Chainable {
+    getByPlaceholderText: GetByAttribute
+    queryByText: QueryByText
+    queryAllByText: AllByText
+    getByText: GetByText
+    getAllByText: AllByText
+    queryByLabelText: QueryByText
+    queryAllByLabelText: AllByText
+    getByLabelText: GetByText
+    getAllByLabelText: AllByText
+    getByAltText: GetByAttribute
+    getByTestId: GetByAttribute
+    getByTitle: GetByAttribute
+    getByValue: GetByAttribute
+    getByTRole: GetByAttribute
+  }
+}

typings/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "lib": ["es6", "dom"],
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictFunctionTypes": true,
+    "strictNullChecks": true,
+    "noEmit": true,
+
+    "baseUrl": ".",
+    "paths": {"cypress-testing-library": ["."]}
+  }
+}

typings/tslint.json

@@ -0,0 +1,7 @@
+{
+  "extends": "dtslint/dtslint.json",
+  "rules": {
+    "semicolon": [true, "never"],
+    "whitespace": [false]
+  }
+}