@fastify/elasticsearch 4.0.1 → 4.0.3

package/.github/dependabot.yml

@@ -2,12 +2,52 @@ version: 2
 updates:
   - package-ecosystem: "github-actions"
     directory: "/"
+    commit-message:
+      # Prefix all commit messages with "chore: "
+      prefix: "chore"
     schedule:
-      interval: "monthly"
+      interval: "weekly"
+    cooldown:
+      default-days: 7
+    allow:
+      - dependency-name: "*"
+        update-types:
+          - "version-update:semver-major"
     open-pull-requests-limit: 10
 
   - package-ecosystem: "npm"
     directory: "/"
+    commit-message:
+      # Prefix all commit messages with "chore: "
+      prefix: "chore"
     schedule:
       interval: "weekly"
+    cooldown:
+      default-days: 7
+    versioning-strategy: "increase-if-necessary"
+    allow:
+      - dependency-name: "*"
+        update-types:
+          - "version-update:semver-major"
+    ignore:
+      # TODO: remove ignore until neostandard support ESLint 10
+      - dependency-name: "eslint"
+      - dependency-name: "neostandard"
+      - dependency-name: "@stylistic/*"
     open-pull-requests-limit: 10
+    groups:
+      # Production dependencies with breaking changes
+      dependencies:
+        dependency-type: "production"
+      # ESLint related dependencies
+      dev-dependencies-eslint:
+        patterns:
+          - "eslint"
+          - "neostandard"
+          - "@stylistic/*"
+      # TypeScript related dependencies
+      dev-dependencies-typescript:
+        patterns:
+          - "@types/*"
+          - "tstyche"
+          - "typescript"

package/.github/workflows/ci.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
      - main
-     - master
      - next
      - 'v*'
     paths-ignore:
@@ -15,9 +14,21 @@ on:
       - 'docs/**'
       - '*.md'
 
+# This allows a subsequently queued workflow run to interrupt previous runs
+concurrency:
+    group: "${{ github.workflow }}-${{ github.event.pull_request.head.label || github.head_ref || github.ref }}"
+    cancel-in-progress: true
+
+permissions:
+  contents: read
+
 jobs:
   test:
-    uses: fastify/workflows/.github/workflows/plugins-ci-elasticsearch.yml@v4.2.0
+    permissions:
+      contents: write
+      pull-requests: write
+    uses: fastify/workflows/.github/workflows/plugins-ci-elasticsearch.yml@ef591e2186785d5ab36b9fe6a79c7ce2f1d94e57 # v7.0.0
     with:
       lint: true
       license-check: true
+      elasticsearch-version: 8.15.2

package/.github/workflows/lock-threads.yml

@@ -0,0 +1,19 @@
+name: Lock Threads
+
+on:
+  schedule:
+    - cron: '0 0 1 * *'
+  workflow_dispatch:
+
+concurrency:
+  group: lock
+
+permissions:
+  contents: read
+
+jobs:
+  lock-threads:
+    permissions:
+      issues: write
+      pull-requests: write
+    uses: fastify/workflows/.github/workflows/lock-threads.yml@ef591e2186785d5ab36b9fe6a79c7ce2f1d94e57 # v7.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2019 Fastify
+Copyright (c) 2018-present The Fastify team <https://github.com/fastify/fastify#team>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,10 +1,10 @@
 # @fastify/elasticsearch
 
-![CI](https://github.com/fastify/fastify-elasticsearch/workflows/CI/badge.svg)
+[![CI](https://github.com/fastify/fastify-elasticsearch/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/fastify/fastify-elasticsearch/actions/workflows/ci.yml)
 [![NPM version](https://img.shields.io/npm/v/@fastify/elasticsearch.svg?style=flat)](https://www.npmjs.com/package/@fastify/elasticsearch)
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
+[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)
 
-Fastify plugin for [Elasticsearch](https://www.elastic.co/elasticsearch/) for sharing the same ES client in every part of your server.  
+Fastify plugin for [Elasticsearch](https://www.elastic.co/elasticsearch/) for sharing the same ES client in every part of your server.
 Under the hood, the official [elasticsearch](https://www.npmjs.com/package/@elastic/elasticsearch) module is used.
 
 
@@ -14,9 +14,23 @@ Under the hood, the official [elasticsearch](https://www.npmjs.com/package/@elas
 npm i @fastify/elasticsearch
 ```
 
+### Compatibility
+| Plugin version | Fastify version |
+| ---------------|-----------------|
+| `>=4.x`        | `^5.x`          |
+| `^3.x`         | `^4.x`          |
+| `^2.x`         | `^3.x`          |
+| `^1.x`         | `^2.x`          |
+| `^1.x`         | `^1.x`          |
+
+
+Please note that if a Fastify version is out of support, then so are the corresponding versions of this plugin
+in the table above.
+See [Fastify's LTS policy](https://github.com/fastify/fastify/blob/main/docs/Reference/LTS.md) for more details.
+
 ## Usage
-Add it to your project with `register` and you are done!  
-The plugin accepts the [same options](https://github.com/elastic/elasticsearch-js#client-options) as the client.
+Add it to your project with `register` and you are done!
+The plugin accepts the [same options](https://github.com/elastic/elasticsearch-js) as the client.
 
 ```js
 const fastify = require('fastify')()
@@ -78,7 +92,7 @@ fastify.listen({ port: 3000 }, err => {
 ```
 
 ## Versioning
-By default the latest and greatest version of the Elasticsearch client is used, see the [compatibility](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/introduction.html#_compatibility) table to understand if the embedded client is correct for you.  
+By default the latest and greatest version of the Elasticsearch client is used, see the [compatibility](https://www.elastic.co/docs/reference/elasticsearch/clients/javascript/installation#nodejs-support) table to understand if the embedded client is correct for you.
 If it is not, you can pass a custom client via the `client` option.
 ```js
 const fastify = require('fastify')()

package/es-docker.sh

@@ -8,4 +8,4 @@ exec docker run \
   -e "discovery.type=single-node" \
   -e "xpack.security.enabled=false" \
   -p 9200:9200 \
-  docker.elastic.co/elasticsearch/elasticsearch:8.3.2
+  docker.elastic.co/elasticsearch/elasticsearch:8.15.2

package/eslint.config.js

@@ -0,0 +1,6 @@
+'use strict'
+
+module.exports = require('neostandard')({
+  ignores: require('neostandard').resolveIgnoresFromGitignore(),
+  ts: true
+})

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "@fastify/elasticsearch",
-  "version": "4.0.1",
+  "version": "4.0.3",
   "description": "Fastify plugin for elastic search",
   "main": "index.js",
   "type": "commonjs",
   "types": "types/index.d.ts",
   "scripts": {
-    "lint": "standard",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
     "test": "npm run test:unit && npm run test:typescript",
-    "test:unit": "tap",
-    "test:typescript": "tsd"
+    "test:unit": "c8 --100 node --test",
+    "test:typescript": "tstyche"
   },
   "repository": {
     "type": "git",
@@ -23,22 +24,51 @@
     "ES"
   ],
   "author": "Tommaso Allevi - @allevo",
+  "contributors": [
+    {
+      "name": "Matteo Collina",
+      "email": "hello@matteocollina.com"
+    },
+    {
+      "name": "James Sumners",
+      "url": "https://james.sumners.info"
+    },
+    {
+      "name": "Tomas Della Vedova",
+      "url": "https://delvedor.dev"
+    },
+    {
+      "name": "Frazer Smith",
+      "email": "frazer.dev@icloud.com",
+      "url": "https://github.com/fdawgs"
+    }
+  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/fastify/fastify-elasticsearch/issues"
   },
   "homepage": "https://github.com/fastify/fastify-elasticsearch#readme",
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/fastify"
+    },
+    {
+      "type": "opencollective",
+      "url": "https://opencollective.com/fastify"
+    }
+  ],
   "dependencies": {
-    "@elastic/elasticsearch": "^8.13.1",
-    "fastify-plugin": "^5.0.0"
+    "@elastic/elasticsearch": "^9.0.2",
+    "fastify-plugin": "^6.0.0"
   },
   "devDependencies": {
-    "@types/node": "^22.0.0",
-    "@fastify/pre-commit": "^2.1.0",
+    "@types/node": "^26.0.1",
+    "c8": "^12.0.0",
+    "eslint": "^9.17.0",
     "fastify": "^5.0.0",
-    "standard": "^17.1.0",
-    "tap": "^18.7.2",
-    "tsd": "^0.31.0"
+    "neostandard": "^0.13.0",
+    "tstyche": "^7.0.0"
   },
   "publishConfig": {
     "access": "public"

package/test/index.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { test } = require('tap')
+const { test } = require('node:test')
 const { Client } = require('@elastic/elasticsearch')
 const Fastify = require('fastify')
 const fastifyElasticsearch = require('..')
@@ -8,29 +8,29 @@ const isElasticsearchClient = require('..').isElasticsearchClient
 
 test('with reachable cluster', async t => {
   const fastify = Fastify()
-  t.teardown(() => fastify.close())
+  t.after(() => fastify.close())
   fastify.register(fastifyElasticsearch, { node: 'http://localhost:9200' })
 
   await fastify.ready()
-  t.equal(fastify.elastic.name, 'elasticsearch-js')
+  t.assert.equal(fastify.elastic.name, 'elasticsearch-js')
 })
 
 test('with unreachable cluster', async t => {
   const fastify = Fastify()
-  t.teardown(() => fastify.close())
+  t.after(() => fastify.close())
   fastify.register(fastifyElasticsearch, { node: 'http://localhost:9201' })
 
   try {
     await fastify.ready()
-    t.fail('should not boot successfully')
+    t.assert.fail('should not boot successfully')
   } catch (err) {
-    t.ok(err)
+    t.assert.ok(err)
   }
 })
 
 test('with unreachable cluster and healthcheck disabled', async t => {
   const fastify = Fastify()
-  t.teardown(() => fastify.close())
+  t.after(() => fastify.close())
   fastify.register(fastifyElasticsearch, {
     node: 'http://localhost:9201',
     healthcheck: false
@@ -38,30 +38,30 @@ test('with unreachable cluster and healthcheck disabled', async t => {
 
   try {
     await fastify.ready()
-    t.equal(fastify.elastic.name, 'elasticsearch-js')
-  } catch (err) {
-    t.fail('should not error')
+    t.assert.equal(fastify.elastic.name, 'elasticsearch-js')
+  } catch {
+    t.assert.fail('should not error')
   }
 })
 
 test('namespaced', async t => {
   const fastify = Fastify()
-  t.teardown(() => fastify.close())
+  t.after(() => fastify.close())
   fastify.register(fastifyElasticsearch, {
     node: 'http://localhost:9200',
     namespace: 'cluster'
   })
 
   await fastify.ready()
-  t.equal(fastify.elastic.cluster.name, 'elasticsearch-js')
-  t.equal(isElasticsearchClient(fastify.elastic), false)
-  t.equal(isElasticsearchClient(fastify.elastic.cluster), true)
+  t.assert.equal(fastify.elastic.cluster.name, 'elasticsearch-js')
+  t.assert.equal(isElasticsearchClient(fastify.elastic), false)
+  t.assert.equal(isElasticsearchClient(fastify.elastic.cluster), true)
   await fastify.close()
 })
 
 test('namespaced (errored)', async t => {
   const fastify = Fastify()
-  t.teardown(() => fastify.close())
+  t.after(() => fastify.close())
   fastify.register(fastifyElasticsearch, {
     node: 'http://localhost:9200',
     namespace: 'cluster'
@@ -74,9 +74,9 @@ test('namespaced (errored)', async t => {
 
   try {
     await fastify.ready()
-    t.fail('should not boot successfully')
+    t.assert.fail('should not boot successfully')
   } catch (err) {
-    t.ok(err)
+    t.assert.ok(err)
   }
 })
 
@@ -87,24 +87,24 @@ test('custom client', async t => {
   })
 
   const fastify = Fastify()
-  t.teardown(() => fastify.close())
+  t.after(() => fastify.close())
   fastify.register(fastifyElasticsearch, { client })
 
   await fastify.ready()
-  t.equal(isElasticsearchClient(fastify.elastic), true)
-  t.equal(fastify.elastic.name, 'custom')
+  t.assert.equal(isElasticsearchClient(fastify.elastic), true)
+  t.assert.equal(fastify.elastic.name, 'custom')
   await fastify.close()
 })
 
 test('Missing configuration', async t => {
   const fastify = Fastify()
-  t.teardown(() => fastify.close())
+  t.after(() => fastify.close())
   fastify.register(fastifyElasticsearch)
 
   try {
     await fastify.ready()
-    t.fail('should not boot successfully')
+    t.assert.fail('should not boot successfully')
   } catch (err) {
-    t.ok(err)
+    t.assert.ok(err)
   }
 })

package/types/index.d.ts

@@ -1,5 +1,5 @@
-import type { FastifyPluginAsync } from 'fastify';
-import type { Client, ClientOptions } from '@elastic/elasticsearch';
+import type { FastifyPluginAsync } from 'fastify'
+import type { Client, ClientOptions } from '@elastic/elasticsearch'
 
 declare module 'fastify' {
   interface FastifyInstance {
@@ -23,5 +23,5 @@ declare namespace fastifyElasticsearch {
   export { fastifyElasticsearch as default }
 }
 
-declare function fastifyElasticsearch(...params: Parameters<FastifyElasticsearch>): ReturnType<FastifyElasticsearch>
+declare function fastifyElasticsearch (...params: Parameters<FastifyElasticsearch>): ReturnType<FastifyElasticsearch>
 export = fastifyElasticsearch

package/types/index.tst.ts

@@ -0,0 +1,19 @@
+import fastifyElasticsearch from '.'
+import Fastify from 'fastify'
+import { expect } from 'tstyche'
+import { Client } from '@elastic/elasticsearch'
+
+const fastify = Fastify()
+fastify.register(fastifyElasticsearch, { node: 'http://localhost:9200' })
+
+expect(fastify.isElasticsearchClient(fastify.elastic)).type.toBe<boolean>()
+expect(
+  fastify.isElasticsearchClient(fastify.elastic.asyncSearch)
+).type.toBe<boolean>()
+expect(
+  fastify.isElasticsearchClient(fastify.elastic.aasdf)
+).type.toBe<boolean>()
+
+expect(fastifyElasticsearch.isElasticsearchClient).type.toBeAssignableTo<
+  (value: any) => value is Client
+>()

package/.taprc

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

package/types/index.test-d.ts

@@ -1,13 +0,0 @@
-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)