@fastify/elasticsearch 3.0.0 → 4.0.0-pre.fv5.1

package/.gitattributes

@@ -0,0 +1,2 @@
+# Set default behavior to automatically convert line endings
+* text=auto eol=lf

package/.github/workflows/ci.yml

@@ -2,6 +2,11 @@ name: CI
 
 on:
   push:
+    branches:
+     - main
+     - master
+     - next
+     - 'v*'
     paths-ignore:
       - 'docs/**'
       - '*.md'
@@ -11,70 +16,8 @@ on:
       - '*.md'
 
 jobs:
-  dependency-review:
-    name: Dependency Review
-    if: github.event_name == 'pull_request'
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-    steps:
-      - name: Check out repo
-        uses: actions/checkout@v3
-        with:
-          persist-credentials: false
-
-      - name: Dependency review
-        uses: actions/dependency-review-action@v2
-
   test:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-    strategy:
-      matrix:
-        node-version: [14, 16, 18]
-    steps:
-      - name: Check out repo
-        uses: actions/checkout@v3
-        with:
-          persist-credentials: false
-
-      - name: Setup Node ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Configure sysctl limits
-        run: |
-          sudo swapoff -a
-          sudo sysctl -w vm.swappiness=1
-          sudo sysctl -w fs.file-max=262144
-          sudo sysctl -w vm.max_map_count=262144
-
-      - name: Runs Elasticsearch
-        uses: elastic/elastic-github-actions/elasticsearch@562b8b6ae4677da97273ff6bc4d630ce96ecbaa5
-        with:
-          stack-version: 8.3.2
-          security-enabled: false
-
-      - name: Install dependencies
-        run: npm i --ignore-scripts
-
-      - name: Run tests
-        run: npm test
-
-  automerge:
-    name: Automerge Dependabot PRs
-    if: >
-        github.event_name == 'pull_request' &&
-        github.event.pull_request.user.login == 'dependabot[bot]'
-    needs: test
-    permissions:
-      pull-requests: write
-      contents: write
-    runs-on: ubuntu-latest
-    steps:
-      - uses: fastify/github-action-merge-dependabot@v3
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          target: major
+    uses: fastify/workflows/.github/workflows/plugins-ci-elasticsearch.yml@v4.2.0
+    with:
+      lint: true
+      license-check: true

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,15 @@
 {
   "name": "@fastify/elasticsearch",
-  "version": "3.0.0",
+  "version": "4.0.0-pre.fv5.1",
   "description": "Fastify plugin for elastic search",
   "main": "index.js",
+  "type": "commonjs",
+  "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",
@@ -26,15 +29,16 @@
   },
   "homepage": "https://github.com/fastify/fastify-elasticsearch#readme",
   "dependencies": {
-    "@elastic/elasticsearch": "^8.2.1",
-    "fastify-plugin": "^4.0.0"
+    "@elastic/elasticsearch": "^8.13.1",
+    "fastify-plugin": "^4.5.1"
   },
   "devDependencies": {
-    "fastify": "^4.0.0-rc.2",
-    "pre-commit": "^1.2.2",
-    "snazzy": "^9.0.0",
-    "standard": "^17.0.0",
-    "tap": "^16.0.0"
+    "@types/node": "^20.12.7",
+    "@fastify/pre-commit": "^2.1.0",
+    "fastify": "^4.26.2",
+    "standard": "^17.1.0",
+    "tap": "^18.7.2",
+    "tsd": "^0.31.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()
@@ -53,6 +54,9 @@ test('namespaced', async t => {
 
   await fastify.ready()
   t.equal(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(isElasticsearchClient(fastify.elastic), true)
   t.equal(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)