@fastify/elasticsearch 3.0.0 → 3.1.0

package/.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
           persist-credentials: false
 
       - name: Dependency review
-        uses: actions/dependency-review-action@v2
+        uses: actions/dependency-review-action@v3
 
   test:
     runs-on: ubuntu-latest

package/.taprc

@@ -0,0 +1,2 @@
+files:
+  - test/**/*.test.js

package/index.js

@@ -2,6 +2,7 @@
 
 const fp = require('fastify-plugin')
 const { Client } = require('@elastic/elasticsearch')
+const isElasticsearchClient = require('./lib/isElasticsearchClient')
 
 async function fastifyElasticsearch (fastify, options) {
   const { namespace, healthcheck } = options
@@ -42,3 +43,7 @@ module.exports = fp(fastifyElasticsearch, {
   fastify: '4.x',
   name: '@fastify/elasticsearch'
 })
+module.exports.default = fastifyElasticsearch
+module.exports.fastifyElasticsearch = fastifyElasticsearch
+
+module.exports.isElasticsearchClient = isElasticsearchClient

package/lib/isElasticsearchClient.js

@@ -0,0 +1,7 @@
+'use strict'
+
+const { Client } = require('@elastic/elasticsearch')
+
+module.exports = function isElasticsearchClient (value) {
+  return value instanceof Client
+}

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@fastify/elasticsearch",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Fastify plugin for elastic search",
   "main": "index.js",
+  "types": "types/index.d.ts",
   "scripts": {
-    "lint": "standard | snazzy",
-    "test": "npm run lint && npm run unit",
-    "unit": "tap test.js"
+    "lint": "standard",
+    "test": "npm run test:unit && npm run test:typescript",
+    "test:unit": "tap",
+    "test:typescript": "tsd"
   },
   "repository": {
     "type": "git",
@@ -30,11 +32,12 @@
     "fastify-plugin": "^4.0.0"
   },
   "devDependencies": {
+    "@types/node": "^18.6.4",
+    "@fastify/pre-commit": "^2.0.2",
     "fastify": "^4.0.0-rc.2",
-    "pre-commit": "^1.2.2",
-    "snazzy": "^9.0.0",
     "standard": "^17.0.0",
-    "tap": "^16.0.0"
+    "tap": "^16.0.0",
+    "tsd": "^0.22.0"
   },
   "publishConfig": {
     "access": "public"

package/{test.js → test/index.test.js}

@@ -3,7 +3,8 @@
 const { test } = require('tap')
 const { Client } = require('@elastic/elasticsearch')
 const Fastify = require('fastify')
-const fastifyElasticsearch = require('./index')
+const fastifyElasticsearch = require('..')
+const isElasticsearchClient = require('..').isElasticsearchClient
 
 test('with reachable cluster', async t => {
   const fastify = Fastify()
@@ -52,7 +53,10 @@ test('namespaced', async t => {
   })
 
   await fastify.ready()
-  t.equal(fastify.elastic.cluster.name, 'elasticsearch-js')
+  t.strictEqual(fastify.elastic.cluster.name, 'elasticsearch-js')
+  t.equal(isElasticsearchClient(fastify.elastic), false)
+  t.equal(isElasticsearchClient(fastify.elastic.cluster), true)
+  await fastify.close()
 })
 
 test('namespaced (errored)', async t => {
@@ -87,7 +91,9 @@ test('custom client', async t => {
   fastify.register(fastifyElasticsearch, { client })
 
   await fastify.ready()
-  t.equal(fastify.elastic.name, 'custom')
+  t.equal(isElasticsearchClient(fastify.elastic), true)
+  t.strictEqual(fastify.elastic.name, 'custom')
+  await fastify.close()
 })
 
 test('Missing configuration', async t => {

package/types/index.d.ts

@@ -0,0 +1,27 @@
+import type { FastifyPluginAsync } from 'fastify';
+import type { Client, ClientOptions } from '@elastic/elasticsearch';
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    elastic: Client & Record<string, Client>;
+    isElasticsearchClient(value: unknown): value is Client
+  }
+}
+
+type FastifyElasticsearch = FastifyPluginAsync<fastifyElasticsearch.FastifyElasticsearchOptions> & {
+  isElasticsearchClient: (value: any) => value is Client
+}
+
+declare namespace fastifyElasticsearch {
+  export interface FastifyElasticsearchOptions extends ClientOptions {
+    namespace?: string;
+    healthcheck?: boolean;
+    client?: Client;
+  }
+
+  export const fastifyElasticsearch: FastifyElasticsearch
+  export { fastifyElasticsearch as default }
+}
+
+declare function fastifyElasticsearch(...params: Parameters<FastifyElasticsearch>): ReturnType<FastifyElasticsearch>
+export = fastifyElasticsearch

package/types/index.test-d.ts

@@ -0,0 +1,13 @@
+import fastifyElasticsearch from '..';
+import Fastify from 'fastify';
+import { expectAssignable, expectType } from 'tsd';
+import { Client } from '@elastic/elasticsearch';
+
+
+const fastify = Fastify()
+fastify.register(fastifyElasticsearch, { node: 'http://localhost:9200' })
+
+expectType<boolean>(fastify.isElasticsearchClient(fastify.elastic))
+expectType<boolean>(fastify.isElasticsearchClient(fastify.elastic.asyncSearch))
+expectType<boolean>(fastify.isElasticsearchClient(fastify.elastic.aasdf))
+expectAssignable<(value: any) => value is Client>(fastifyElasticsearch.isElasticsearchClient)