@fastify/elasticsearch 4.0.2 → 4.0.4

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,10 +14,32 @@ 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@v5
+  test-elasticsearch-8:
+    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
+      elasticsearch-version: '8.19.19'
+
+  test-elasticsearch-9:
+    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: '9.4.4'
+

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,6 +1,6 @@
 # @fastify/elasticsearch
 
-[![CI](https://github.com/fastify/fastify-elasticsearch/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/fastify/fastify-elasticsearch/actions/workflows/ci.yml)
+[![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)
 [![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)
 
@@ -11,13 +11,13 @@ Under the hood, the official [elasticsearch](https://www.npmjs.com/package/@elas
 ## Install
 
 ```
-npm i @fastify/elasticsearch
+npm i @fastify/elasticsearch @elastic/elasticsearch
 ```
 
 ### Compatibility
 | Plugin version | Fastify version |
 | ---------------|-----------------|
-| `^4.x`         | `^5.x`          |
+| `>=4.x`        | `^5.x`          |
 | `^3.x`         | `^4.x`          |
 | `^2.x`         | `^3.x`          |
 | `^1.x`         | `^2.x`          |
@@ -30,7 +30,7 @@ See [Fastify's LTS policy](https://github.com/fastify/fastify/blob/main/docs/Ref
 
 ## 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.
+The plugin accepts the [same options](https://github.com/elastic/elasticsearch-js) as the client.
 
 ```js
 const fastify = require('fastify')()
@@ -92,7 +92,10 @@ 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.
+
+`@fastify/elasticsearch` supports Elasticsearch client versions 8 and 9.
+
+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

@@ -3,9 +3,15 @@
 # run this file to get a working ES instance
 # for running the test locally
 
+# ES_VERSION can be overridden:
+# ES_VERSION=8.19.19 ./es-docker.sh
+# ES_VERSION=9.4.4 ./es-docker.sh
+
+ES_VERSION="${ES_VERSION:-8.19.19}"
+
 exec docker run \
   --rm \
   -e "discovery.type=single-node" \
   -e "xpack.security.enabled=false" \
   -p 9200:9200 \
-  docker.elastic.co/elasticsearch/elasticsearch:8.15.2
+  "docker.elastic.co/elasticsearch/elasticsearch:${ES_VERSION}"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastify/elasticsearch",
-  "version": "4.0.2",
+  "version": "4.0.4",
   "description": "Fastify plugin for elastic search",
   "main": "index.js",
   "type": "commonjs",
@@ -10,7 +10,7 @@
     "lint:fix": "eslint --fix",
     "test": "npm run test:unit && npm run test:typescript",
     "test:unit": "c8 --100 node --test",
-    "test:typescript": "tsd"
+    "test:typescript": "tstyche"
   },
   "repository": {
     "type": "git",
@@ -35,7 +35,7 @@
     },
     {
       "name": "Tomas Della Vedova",
-      "url": "http://delved.org"
+      "url": "https://delvedor.dev"
     },
     {
       "name": "Frazer Smith",
@@ -59,17 +59,19 @@
     }
   ],
   "dependencies": {
-    "@elastic/elasticsearch": "^8.13.1",
-    "fastify-plugin": "^5.0.0"
+    "fastify-plugin": "^6.0.0"
   },
   "devDependencies": {
-    "@fastify/pre-commit": "^2.1.0",
-    "@types/node": "^22.0.0",
-    "c8": "^10.1.2",
+    "@elastic/elasticsearch": "^9.0.2",
+    "@types/node": "^26.0.1",
+    "c8": "^12.0.0",
     "eslint": "^9.17.0",
     "fastify": "^5.0.0",
-    "neostandard": "^0.12.0",
-    "tsd": "^0.31.0"
+    "neostandard": "^0.13.0",
+    "tstyche": "^7.0.0"
+  },
+  "peerDependencies": {
+    "@elastic/elasticsearch": "^8 || ^9"
   },
   "publishConfig": {
     "access": "public"

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/types/index.test-d.ts

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