Merge pull request #4 from elastic/add-types

Added type definitions

Author: delvedor

index.d.ts

@@ -0,0 +1,23 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+import { Connection } from '@elastic/elasticsearch'
+
+declare class ClientMock {
+  constructor()
+  add(pattern: MockPattern, resolver: ResolverFn): ClientMock
+  get(pattern: MockPattern): ResolverFn | null
+  getConnection(): typeof Connection
+}
+
+export declare type ResolverFn = (params: MockPattern) => Record<string, any> | string
+
+export interface MockPattern {
+  method: string
+  path: string
+  querystring?: Record<string, string>
+  body?: Record<string, any>
+}
+
+export default ClientMock

index.test-d.ts

@@ -0,0 +1,67 @@
+// Licensed to Elasticsearch B.V under one or more agreements.
+// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+// See the LICENSE file in the project root for more information
+
+import { expectType, expectError } from 'tsd'
+import { Client } from '@elastic/elasticsearch'
+import Mock, { MockPattern } from './'
+
+const mock = new Mock()
+const client = new Client({
+  node: 'http://localhost:9200',
+  Connection: mock.getConnection()
+})
+
+mock.add({
+  method: 'GET',
+  path: '/'
+}, params => {
+  expectType<MockPattern>(params)
+  return { status: 'ok' }
+})
+
+mock.add({
+  method: 'GET',
+  path: '/',
+  querystring: { pretty: 'true' }
+}, params => {
+  expectType<MockPattern>(params)
+  return { status: 'ok' }
+})
+
+mock.add({
+  method: 'POST',
+  path: '/',
+  querystring: { pretty: 'true' },
+  body: { foo: 'bar' }
+}, params => {
+  expectType<MockPattern>(params)
+  return { status: 'ok' }
+})
+
+mock.add({
+  method: 'GET',
+  path: '/'
+}, params => {
+  expectType<MockPattern>(params)
+  return 'ok'
+})
+
+// querystring should only have string values
+expectError(
+  mock.add({
+    method: 'GET',
+    path: '/',
+    querystring: { pretty: true }
+  }, () => {
+    return { status: 'ok' }
+  })
+)
+
+// missing resolver function
+expectError(
+  mock.add({
+    method: 'GET',
+    path: '/'
+  })
+)

package.json

@@ -3,8 +3,9 @@
   "version": "0.1.0",
   "description": "",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
-    "test": "standard && ava -v",
+    "test": "standard && ava -v && tsd",
     "coverage:report": "nyc ava && nyc report --reporter=lcov && echo \"\n==> open coverage/lcov-report/index.html\"",
     "coverage:check": "nyc ava && nyc check-coverage --branches=100 --lines=100 --functions=100 --statements=100"
   },
@@ -23,7 +24,8 @@
     "@elastic/elasticsearch": "^7.7.0-rc.2",
     "ava": "^3.6.0",
     "nyc": "^15.0.1",
-    "standard": "^14.3.3"
+    "standard": "^14.3.3",
+    "tsd": "^0.11.0"
   },
   "dependencies": {
     "fast-deep-equal": "^3.1.1",