diff --git a/.deepsource.toml b/.deepsource.toml
new file mode 100644
index 00000000000..72aefc7b07a
--- /dev/null
+++ b/.deepsource.toml
@@ -0,0 +1,9 @@
+version = 1
+
+[[analyzers]]
+name = "javascript"
+enabled = true
+
+ [analyzers.meta]
+ environment = ["nodejs"]
+ dialect = "typescript"
diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml
new file mode 100644
index 00000000000..2e8db33a0c6
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yml
@@ -0,0 +1,39 @@
+name: Bug Report
+description: Tell us about something that isn't working as expected
+labels: [Bug]
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: Description
+ description: Please enter a detailed description of your issue. If possible, please provide example code to reproduce the issue.
+ validations:
+ required: true
+ - type: input
+ id: node-js-version
+ attributes:
+ label: Node.js Version
+ description: Please enter your Node.js version `node --version`
+ - type: input
+ id: redis-server-version
+ attributes:
+ label: Redis Server Version
+ description: Please enter your Redis server version ([`INFO server`](https://redis.io/commands/info/))
+ - type: input
+ id: node-redis-version
+ attributes:
+ label: Node Redis Version
+ description: Please enter your node redis version `npm ls redis`
+ - type: input
+ id: platform
+ attributes:
+ label: Platform
+ description: Please enter the platform you are using e.g. Linux, macOS, Windows
+ - type: textarea
+ id: logs
+ attributes:
+ label: Logs
+ description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+ render: bash
+ validations:
+ required: false
diff --git a/.github/ISSUE_TEMPLATE/DOCUMENTATION.yml b/.github/ISSUE_TEMPLATE/DOCUMENTATION.yml
new file mode 100644
index 00000000000..b5ece5aeca2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/DOCUMENTATION.yml
@@ -0,0 +1,11 @@
+name: Documentation
+description: Any questions or issues relating to the project documentation.
+labels: [Documentation]
+body:
+ - type: textarea
+ id: description
+ attributes:
+ label: Description
+ description: Ask your question or describe your issue here.
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
new file mode 100644
index 00000000000..ae10cbd7b7a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
@@ -0,0 +1,19 @@
+name: Feature Request
+description: Suggest an idea for this project
+labels: [Feature]
+body:
+ - type: textarea
+ id: motivation
+ attributes:
+ label: Motivation
+ description: How would Node Redis users benefit from this feature?
+ validations:
+ required: true
+ - type: textarea
+ id: basic-code-example
+ attributes:
+ label: Basic Code Example
+ description: Provide examples of how you imagine the API for this feature might be implemented. This will be automatically formatted into code, so no need for backticks.
+ render: JavaScript
+ validations:
+ required: false
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000000..d4f8b8f2d9b
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,20 @@
+### Description
+
+
+
+
+
+> Describe your pull request here
+
+---
+
+### Checklist
+
+
+
+- [ ] Does `npm test` pass with this change (including linting)?
+- [ ] Is the new or changed code fully tested?
+- [ ] Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
+
+
diff --git a/.github/release-drafter-base.yml b/.github/release-drafter-base.yml
new file mode 100644
index 00000000000..ea259fc0d2d
--- /dev/null
+++ b/.github/release-drafter-base.yml
@@ -0,0 +1,50 @@
+name-template: 'json@$NEXT_PATCH_VERSION'
+tag-template: 'json@$NEXT_PATCH_VERSION'
+autolabeler:
+ - label: 'chore'
+ files:
+ - '*.md'
+ - '.github/*'
+ - label: 'bug'
+ branch:
+ - '/bug-.+'
+ - label: 'chore'
+ branch:
+ - '/chore-.+'
+ - label: 'feature'
+ branch:
+ - '/feature-.+'
+categories:
+ - title: 'Breaking Changes'
+ labels:
+ - 'breakingchange'
+ - title: 'π New Features'
+ labels:
+ - 'feature'
+ - 'enhancement'
+ - title: 'π Bug Fixes'
+ labels:
+ - 'fix'
+ - 'bugfix'
+ - 'bug'
+ - title: 'π§° Maintenance'
+ label:
+ - 'chore'
+ - 'maintenance'
+ - 'documentation'
+ - 'docs'
+
+change-template: '- $TITLE (#$NUMBER)'
+include-paths:
+ - 'packages/json'
+exclude-labels:
+ - 'skip-changelog'
+template: |
+ ## Changes
+
+ $CHANGES
+
+ ## Contributors
+ We'd like to thank all the contributors who worked on this release!
+
+ $CONTRIBUTORS
diff --git a/.github/release-drafter/bloom-config.yml b/.github/release-drafter/bloom-config.yml
new file mode 100644
index 00000000000..7734330b95c
--- /dev/null
+++ b/.github/release-drafter/bloom-config.yml
@@ -0,0 +1,50 @@
+name-template: 'bloom@$NEXT_PATCH_VERSION'
+tag-template: 'bloom@$NEXT_PATCH_VERSION'
+autolabeler:
+ - label: 'chore'
+ files:
+ - '*.md'
+ - '.github/*'
+ - label: 'bug'
+ branch:
+ - '/bug-.+'
+ - label: 'chore'
+ branch:
+ - '/chore-.+'
+ - label: 'feature'
+ branch:
+ - '/feature-.+'
+categories:
+ - title: 'Breaking Changes'
+ labels:
+ - 'breakingchange'
+ - title: 'π New Features'
+ labels:
+ - 'feature'
+ - 'enhancement'
+ - title: 'π Bug Fixes'
+ labels:
+ - 'fix'
+ - 'bugfix'
+ - 'bug'
+ - title: 'π§° Maintenance'
+ label:
+ - 'chore'
+ - 'maintenance'
+ - 'documentation'
+ - 'docs'
+
+change-template: '- $TITLE (#$NUMBER)'
+include-paths:
+ - 'packages/bloom'
+exclude-labels:
+ - 'skip-changelog'
+template: |
+ ## Changes
+
+ $CHANGES
+
+ ## Contributors
+ We'd like to thank all the contributors who worked on this release!
+
+ $CONTRIBUTORS
diff --git a/.github/release-drafter/entraid-config.yml b/.github/release-drafter/entraid-config.yml
new file mode 100644
index 00000000000..d0ddd00773a
--- /dev/null
+++ b/.github/release-drafter/entraid-config.yml
@@ -0,0 +1,50 @@
+name-template: 'entraid@$NEXT_PATCH_VERSION'
+tag-template: 'entraid@$NEXT_PATCH_VERSION'
+autolabeler:
+ - label: 'chore'
+ files:
+ - '*.md'
+ - '.github/*'
+ - label: 'bug'
+ branch:
+ - '/bug-.+'
+ - label: 'chore'
+ branch:
+ - '/chore-.+'
+ - label: 'feature'
+ branch:
+ - '/feature-.+'
+categories:
+ - title: 'Breaking Changes'
+ labels:
+ - 'breakingchange'
+ - title: 'π New Features'
+ labels:
+ - 'feature'
+ - 'enhancement'
+ - title: 'π Bug Fixes'
+ labels:
+ - 'fix'
+ - 'bugfix'
+ - 'bug'
+ - title: 'π§° Maintenance'
+ label:
+ - 'chore'
+ - 'maintenance'
+ - 'documentation'
+ - 'docs'
+
+change-template: '- $TITLE (#$NUMBER)'
+include-paths:
+ - 'packages/entraid'
+exclude-labels:
+ - 'skip-changelog'
+template: |
+ ## Changes
+
+ $CHANGES
+
+ ## Contributors
+ We'd like to thank all the contributors who worked on this release!
+
+ $CONTRIBUTORS
diff --git a/.github/release-drafter/json-config.yml b/.github/release-drafter/json-config.yml
new file mode 100644
index 00000000000..ea259fc0d2d
--- /dev/null
+++ b/.github/release-drafter/json-config.yml
@@ -0,0 +1,50 @@
+name-template: 'json@$NEXT_PATCH_VERSION'
+tag-template: 'json@$NEXT_PATCH_VERSION'
+autolabeler:
+ - label: 'chore'
+ files:
+ - '*.md'
+ - '.github/*'
+ - label: 'bug'
+ branch:
+ - '/bug-.+'
+ - label: 'chore'
+ branch:
+ - '/chore-.+'
+ - label: 'feature'
+ branch:
+ - '/feature-.+'
+categories:
+ - title: 'Breaking Changes'
+ labels:
+ - 'breakingchange'
+ - title: 'π New Features'
+ labels:
+ - 'feature'
+ - 'enhancement'
+ - title: 'π Bug Fixes'
+ labels:
+ - 'fix'
+ - 'bugfix'
+ - 'bug'
+ - title: 'π§° Maintenance'
+ label:
+ - 'chore'
+ - 'maintenance'
+ - 'documentation'
+ - 'docs'
+
+change-template: '- $TITLE (#$NUMBER)'
+include-paths:
+ - 'packages/json'
+exclude-labels:
+ - 'skip-changelog'
+template: |
+ ## Changes
+
+ $CHANGES
+
+ ## Contributors
+ We'd like to thank all the contributors who worked on this release!
+
+ $CONTRIBUTORS
diff --git a/.github/release-drafter/search-config.yml b/.github/release-drafter/search-config.yml
new file mode 100644
index 00000000000..a78070aa59c
--- /dev/null
+++ b/.github/release-drafter/search-config.yml
@@ -0,0 +1,50 @@
+name-template: 'search@$NEXT_PATCH_VERSION'
+tag-template: 'search@$NEXT_PATCH_VERSION'
+autolabeler:
+ - label: 'chore'
+ files:
+ - '*.md'
+ - '.github/*'
+ - label: 'bug'
+ branch:
+ - '/bug-.+'
+ - label: 'chore'
+ branch:
+ - '/chore-.+'
+ - label: 'feature'
+ branch:
+ - '/feature-.+'
+categories:
+ - title: 'Breaking Changes'
+ labels:
+ - 'breakingchange'
+ - title: 'π New Features'
+ labels:
+ - 'feature'
+ - 'enhancement'
+ - title: 'π Bug Fixes'
+ labels:
+ - 'fix'
+ - 'bugfix'
+ - 'bug'
+ - title: 'π§° Maintenance'
+ label:
+ - 'chore'
+ - 'maintenance'
+ - 'documentation'
+ - 'docs'
+
+change-template: '- $TITLE (#$NUMBER)'
+include-paths:
+ - 'packages/search'
+exclude-labels:
+ - 'skip-changelog'
+template: |
+ ## Changes
+
+ $CHANGES
+
+ ## Contributors
+ We'd like to thank all the contributors who worked on this release!
+
+ $CONTRIBUTORS
diff --git a/.github/release-drafter/time-series-config.yml b/.github/release-drafter/time-series-config.yml
new file mode 100644
index 00000000000..29aee0cbc95
--- /dev/null
+++ b/.github/release-drafter/time-series-config.yml
@@ -0,0 +1,49 @@
+name-template: 'time-series@$NEXT_PATCH_VERSION'
+tag-template: 'time-series@$NEXT_PATCH_VERSION'
+autolabeler:
+ - label: 'chore'
+ files:
+ - '*.md'
+ - '.github/*'
+ - label: 'bug'
+ branch:
+ - '/bug-.+'
+ - label: 'chore'
+ branch:
+ - '/chore-.+'
+ - label: 'feature'
+ branch:
+ - '/feature-.+'
+categories:
+ - title: 'Breaking Changes'
+ labels:
+ - 'breakingchange'
+ - title: 'π New Features'
+ labels:
+ - 'feature'
+ - 'enhancement'
+ - title: 'π Bug Fixes'
+ labels:
+ - 'fix'
+ - 'bugfix'
+ - 'bug'
+ - title: 'π§° Maintenance'
+ label:
+ - 'chore'
+ - 'maintenance'
+ - 'documentation'
+ - 'docs'
+change-template: '- $TITLE (#$NUMBER)'
+include-paths:
+ - 'packages/time-series'
+exclude-labels:
+ - 'skip-changelog'
+template: |
+ ## Changes
+
+ $CHANGES
+
+ ## Contributors
+ We'd like to thank all the contributors who worked on this release!
+
+ $CONTRIBUTORS
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
new file mode 100644
index 00000000000..47c82baea2c
--- /dev/null
+++ b/.github/workflows/codeql.yml
@@ -0,0 +1,74 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+ push:
+ branches: [ "master" ]
+ pull_request:
+ # The branches below must be a subset of the branches above
+ branches: [ "master" ]
+ schedule:
+ - cron: '43 20 * * 1'
+
+jobs:
+ analyze:
+ name: Analyze
+ runs-on: ubuntu-latest
+ permissions:
+ actions: read
+ contents: read
+ security-events: write
+
+ strategy:
+ fail-fast: false
+ matrix:
+ language: [ 'TypeScript' ]
+ # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+ # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v4
+
+ # Initializes the CodeQL tools for scanning.
+ - name: Initialize CodeQL
+ uses: github/codeql-action/init@v2
+ with:
+ languages: ${{ matrix.language }}
+ # If you wish to specify custom queries, you can do so here or in a config file.
+ # By default, queries listed here will override any specified in a config file.
+ # Prefix the list here with "+" to use these queries and those in the config file.
+
+ # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+ # queries: security-extended,security-and-quality
+
+
+ # Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java).
+ # If this step fails, then you should remove it and run the build manually (see below)
+ - name: Autobuild
+ uses: github/codeql-action/autobuild@v2
+
+ # βΉοΈ Command-line programs to run using the OS shell.
+ # π See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+ # If the Autobuild fails above, remove it and uncomment the following three lines.
+ # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+ # - run: |
+ # echo "Run, Build Application using script"
+ # ./location_of_script_within_repo/buildscript.sh
+
+ - name: Perform CodeQL Analysis
+ uses: github/codeql-action/analyze@v2
+ with:
+ category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
new file mode 100644
index 00000000000..a8c22752423
--- /dev/null
+++ b/.github/workflows/documentation.yml
@@ -0,0 +1,28 @@
+name: Documentation
+
+on:
+ push:
+ branches:
+ - master
+ - v4.0
+
+jobs:
+ documentation:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ fetch-depth: 1
+ - name: Use Node.js
+ uses: actions/setup-node@v3
+ - name: Install Packages
+ run: npm ci
+ - name: Generate Documentation
+ run: npm run documentation
+ - name: Upload
+ run: |
+ git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
+ npm run gh-pages
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
diff --git a/.github/workflows/release-drafter-bloom.yml b/.github/workflows/release-drafter-bloom.yml
new file mode 100644
index 00000000000..4ad525c058f
--- /dev/null
+++ b/.github/workflows/release-drafter-bloom.yml
@@ -0,0 +1,24 @@
+name: Release Drafter
+
+on:
+ push:
+ # branches to consider in the event; optional, defaults to all
+ branches:
+ - master
+
+jobs:
+
+ update_release_draft:
+
+ permissions:
+ contents: write
+ pull-requests: write
+ runs-on: ubuntu-latest
+ steps:
+ # Drafts your next Release notes as Pull Requests are merged into "master"
+ - uses: release-drafter/release-drafter@v5
+ with:
+ # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
+ config-name: release-drafter/bloom-config.yml
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/release-drafter-entraid.yml b/.github/workflows/release-drafter-entraid.yml
new file mode 100644
index 00000000000..d522c6cef6f
--- /dev/null
+++ b/.github/workflows/release-drafter-entraid.yml
@@ -0,0 +1,24 @@
+name: Release Drafter
+
+on:
+ push:
+ # branches to consider in the event; optional, defaults to all
+ branches:
+ - master
+
+jobs:
+
+ update_release_draft:
+
+ permissions:
+ contents: write
+ pull-requests: write
+ runs-on: ubuntu-latest
+ steps:
+ # Drafts your next Release notes as Pull Requests are merged into "master"
+ - uses: release-drafter/release-drafter@v5
+ with:
+ # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
+ config-name: release-drafter/entraid-config.yml
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/release-drafter-json.yml b/.github/workflows/release-drafter-json.yml
new file mode 100644
index 00000000000..a8b3ba4d135
--- /dev/null
+++ b/.github/workflows/release-drafter-json.yml
@@ -0,0 +1,24 @@
+name: Release Drafter
+
+on:
+ push:
+ # branches to consider in the event; optional, defaults to all
+ branches:
+ - master
+
+jobs:
+
+ update_release_draft:
+
+ permissions:
+ contents: write
+ pull-requests: write
+ runs-on: ubuntu-latest
+ steps:
+ # Drafts your next Release notes as Pull Requests are merged into "master"
+ - uses: release-drafter/release-drafter@v5
+ with:
+ # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
+ config-name: release-drafter/json-config.yml
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/release-drafter-search.yml b/.github/workflows/release-drafter-search.yml
new file mode 100644
index 00000000000..c331430353f
--- /dev/null
+++ b/.github/workflows/release-drafter-search.yml
@@ -0,0 +1,24 @@
+name: Release Drafter
+
+on:
+ push:
+ # branches to consider in the event; optional, defaults to all
+ branches:
+ - master
+
+jobs:
+
+ update_release_draft:
+
+ permissions:
+ contents: write
+ pull-requests: write
+ runs-on: ubuntu-latest
+ steps:
+ # Drafts your next Release notes as Pull Requests are merged into "master"
+ - uses: release-drafter/release-drafter@v5
+ with:
+ # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
+ config-name: release-drafter/search-config.yml
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/release-drafter-time-series.yml b/.github/workflows/release-drafter-time-series.yml
new file mode 100644
index 00000000000..71e44a70fd3
--- /dev/null
+++ b/.github/workflows/release-drafter-time-series.yml
@@ -0,0 +1,24 @@
+name: Release Drafter
+
+on:
+ push:
+ # branches to consider in the event; optional, defaults to all
+ branches:
+ - master
+
+jobs:
+
+ update_release_draft:
+
+ permissions:
+ contents: write
+ pull-requests: write
+ runs-on: ubuntu-latest
+ steps:
+ # Drafts your next Release notes as Pull Requests are merged into "master"
+ - uses: release-drafter/release-drafter@v5
+ with:
+ # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
+ config-name: release-drafter/time-series-config.yml
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
new file mode 100644
index 00000000000..e7c9d58fe71
--- /dev/null
+++ b/.github/workflows/release.yml
@@ -0,0 +1,51 @@
+name: Release
+
+on:
+ workflow_dispatch:
+ inputs:
+ version:
+ description: 'Version to release ("major", "minor", "patch", or "pre*" version; or specify version like "5.3.3")'
+ required: true
+ type: string
+ args:
+ description: 'Additional arguments to pass to release-it (e.g. "--dry-run"). See docs: https://github.com/release-it/release-it/blob/main/docs/git.md#configuration-options'
+ required: false
+ type: string
+
+jobs:
+ release:
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write
+ packages: write
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+ ssh-key: ${{ secrets.RELEASE_KEY }}
+
+ - name: Setup Node.js
+ uses: actions/setup-node@v4
+ with:
+ node-version: '22'
+ registry-url: 'https://registry.npmjs.org'
+
+ - name: Install dependencies
+ run: npm ci
+
+ - name: Configure Git
+ run: |
+ git config --local user.email "action@github.com"
+ git config --local user.name "GitHub Action"
+
+ # Build all packages
+ - name: Build packages
+ run: npm run build
+
+ # Release using the monorepo approach
+ - name: Release packages
+ run: npm run release -- --ci -i ${{ github.event.inputs.version }} ${{ github.event.inputs.args }}
+ env:
+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/stale-issues.yml b/.github/workflows/stale-issues.yml
new file mode 100644
index 00000000000..ba0fb5587ed
--- /dev/null
+++ b/.github/workflows/stale-issues.yml
@@ -0,0 +1,95 @@
+name: "Stale Issue Management"
+on:
+ schedule:
+ # Run daily at midnight UTC
+ - cron: "0 0 * * *"
+ workflow_dispatch: # Allow manual triggering
+
+env:
+ # Default stale policy timeframes
+ DAYS_BEFORE_STALE: 365
+ DAYS_BEFORE_CLOSE: 30
+
+ # Accelerated timeline for needs-information issues
+ NEEDS_INFO_DAYS_BEFORE_STALE: 30
+ NEEDS_INFO_DAYS_BEFORE_CLOSE: 7
+
+jobs:
+ stale:
+ runs-on: ubuntu-latest
+ steps:
+ # First step: Handle regular issues (excluding needs-information)
+ - name: Mark regular issues as stale
+ uses: actions/stale@v9
+ with:
+ repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+ # Default stale policy
+ days-before-stale: ${{ env.DAYS_BEFORE_STALE }}
+ days-before-close: ${{ env.DAYS_BEFORE_CLOSE }}
+
+ # Explicit stale label configuration
+ stale-issue-label: "stale"
+ stale-pr-label: "stale"
+
+ stale-issue-message: |
+ This issue has been automatically marked as stale due to inactivity.
+ It will be closed in 30 days if no further activity occurs.
+ If you believe this issue is still relevant, please add a comment to keep it open.
+
+ close-issue-message: |
+ This issue has been automatically closed due to inactivity.
+ If you believe this issue is still relevant, please reopen it or create a new issue with updated information.
+
+ # Exclude needs-information issues from this step
+ exempt-issue-labels: 'no-stale,needs-information'
+
+ # Remove stale label when issue/PR becomes active again
+ remove-stale-when-updated: true
+
+ # Apply to pull requests with same timeline
+ days-before-pr-stale: ${{ env.DAYS_BEFORE_STALE }}
+ days-before-pr-close: ${{ env.DAYS_BEFORE_CLOSE }}
+
+ stale-pr-message: |
+ This pull request has been automatically marked as stale due to inactivity.
+ It will be closed in 30 days if no further activity occurs.
+
+ close-pr-message: |
+ This pull request has been automatically closed due to inactivity.
+ If you would like to continue this work, please reopen the PR or create a new one.
+
+ # Only exclude no-stale PRs (needs-information PRs follow standard timeline)
+ exempt-pr-labels: 'no-stale'
+
+ # Second step: Handle needs-information issues with accelerated timeline
+ - name: Mark needs-information issues as stale
+ uses: actions/stale@v9
+ with:
+ repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+ # Accelerated timeline for needs-information
+ days-before-stale: ${{ env.NEEDS_INFO_DAYS_BEFORE_STALE }}
+ days-before-close: ${{ env.NEEDS_INFO_DAYS_BEFORE_CLOSE }}
+
+ # Explicit stale label configuration
+ stale-issue-label: "stale"
+
+ # Only target ISSUES with needs-information label (not PRs)
+ only-issue-labels: 'needs-information'
+
+ stale-issue-message: |
+ This issue has been marked as stale because it requires additional information
+ that has not been provided for 30 days. It will be closed in 7 days if the
+ requested information is not provided.
+
+ close-issue-message: |
+ This issue has been closed because the requested information was not provided within the specified timeframe.
+ If you can provide the missing information, please reopen this issue or create a new one.
+
+ # Disable PR processing for this step
+ days-before-pr-stale: -1
+ days-before-pr-close: -1
+
+ # Remove stale label when issue becomes active again
+ remove-stale-when-updated: true
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
new file mode 100644
index 00000000000..45ada77197f
--- /dev/null
+++ b/.github/workflows/tests.yml
@@ -0,0 +1,52 @@
+name: Tests
+
+on:
+ push:
+ branches:
+ - master
+ - v4.0
+ - v5
+ paths-ignore:
+ - "**/*.md"
+ pull_request:
+ branches:
+ - master
+ - v4.0
+ - v5
+ paths-ignore:
+ - "**/*.md"
+jobs:
+ tests:
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ matrix:
+ node-version: ["18", "20", "22"]
+ redis-version: ["rs-7.4.0-v1", "8.0.2", "8.2", "8.4-M01-pre"]
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ fetch-depth: 1
+ - name: Use Node.js ${{ matrix.node-version }}
+ uses: actions/setup-node@v4
+ with:
+ node-version: ${{ matrix.node-version }}
+ - name: Update npm
+ run: npm i -g npm
+ if: ${{ matrix.node-version <= 14 }}
+ - name: Install Packages
+ run: npm ci
+ - name: Build
+ run: npm run build
+ - name: Run Tests
+ run: npm run test -ws --if-present -- --forbid-only --redis-version=${{ matrix.redis-version }}
+ - name: Upload to Codecov
+ run: |
+ curl https://keybase.io/codecovsecurity/pgp_keys.asc | gpg --no-default-keyring --keyring trustedkeys.gpg --import
+ curl -Os https://uploader.codecov.io/latest/linux/codecov
+ curl -Os https://uploader.codecov.io/latest/linux/codecov.SHA256SUM
+ curl -Os https://uploader.codecov.io/latest/linux/codecov.SHA256SUM.sig
+ gpgv codecov.SHA256SUM.sig codecov.SHA256SUM
+ shasum -a 256 -c codecov.SHA256SUM
+ chmod +x codecov
+ ./codecov
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 00000000000..ecdef37dffd
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,10 @@
+.idea/
+.nyc_output/
+.vscode/
+coverage/
+dist/
+node_modules/
+.DS_Store
+dump.rdb
+documentation/
+tsconfig.tsbuildinfo
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 00000000000..fbc3070381e
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,958 @@
+# Changelog
+
+## v4.0.2 - 13 Jan, 2022
+
+### Fixes
+
+- Fix v4 commands in legacy mode (#1820)
+- Fix `EXISTS` command reply (#1819)
+- Fix handler for "__redis__:invalidate" messages (#1798)
+- Fix "SEPARATOR" typo in RediSearch (#1823)
+
+### Enhancements
+
+- First release of `@node-redis/bloom`
+- Add support for `Buffer`s
+- Enhance `ASK` and `MOVED` errors handler
+
+## v4.0.1 - 13 Dec, 2021
+
+### Fixes
+
+- Fix `NOAUTH` error when using authentication & database (#1681)
+- Allow to `.quit()` in PubSub mode (#1766)
+- Add an option to configure `name` on a client (#1758)
+- Lowercase commands (`client.hset`) in `legacyMode`
+- Fix PubSub resubscribe (#1764)
+- Fix `RedisSocketOptions` type (#1741)
+
+### Enhancements
+
+- Add support for `number`s and `Buffer`s in `HSET` (#1738 #1739)
+- Export `RedisClientType`, `RedisClusterType` and some more types (#1673)
+- First release of `@node-redis/time-series`
+
+## v4.0.0 - 24 Nov, 2021
+
+This version is a major change and refactor, adding modern JavaScript capabilities and multiple breaking changes. See the [migration guide](./docs/v3-to-v4.md) for tips on how to upgrade.
+
+### Breaking Changes
+
+- All functions return Promises by default
+- Dropped support for Node.js 10.x, the minimum supported Node.js version is now 12.x
+- `createClient` takes new and different arguments
+- The `prefix`, `rename_commands` configuration options to `createClient` have been removed
+- The `enable_offline_queue` configuration option is removed, executing commands on a closed client (without calling `.connect()` or after calling `.disconnect()`) will reject immediately
+- Login credentials are no longer saved when using `.auth()` directly
+
+### Features
+
+- Added support for Promises
+- Added built-in TypeScript declaration files enabling code completion
+- Added support for [clustering](./README.md#cluster)
+- Added idiomatic arguments and responses to [Redis commands](./README.md#redis-commands)
+- Added full support for [Lua Scripts](./README.md#lua-scripts)
+- Added support for [SCAN iterators](./README.md#scan-iterator)
+- Added the ability to extend Node Redis with Redis Module commands
+
+## v3.1.2
+
+### Fixes
+
+- Exclude unnecessary files from tarball
+
+## v3.1.1
+
+### Enhancements
+
+- Upgrade node and dependencies
+
+### Fixes
+
+- Fix a potential exponential regex in monitor mode
+
+## v3.1.0 - 31 Mar, 2021
+
+### Enhancements
+
+- Upgrade node and dependencies and redis-commands to support Redis 6
+- Add support for Redis 6 `auth pass [user]`
+
+## v3.0.0 - 09 Feb, 2020
+
+This version is mainly a release to distribute all the unreleased changes on master since 2017 and additionally removes
+a lot of old deprecated features and old internals in preparation for an upcoming modernization refactor (v4).
+
+### Breaking Changes
+
+- Dropped support for Node.js < 6
+- Dropped support for `hiredis` (no longer required)
+- Removed previously deprecated `drain` event
+- Removed previously deprecated `idle` event
+- Removed previously deprecated `parser` option
+- Removed previously deprecated `max_delay` option
+- Removed previously deprecated `max_attempts` option
+- Removed previously deprecated `socket_no_delay` option
+
+### Bug Fixes
+
+- Removed development files from published package (#1370)
+- Duplicate function now allows db param to be passed (#1311)
+
+### Features
+
+- Upgraded to latest `redis-commands` package
+- Upgraded to latest `redis-parser` package, v3.0.0, which brings performance improvements
+- Replaced `double-ended-queue` with `denque`, which brings performance improvements
+- Add timestamps to debug traces
+- Add `socket_initial_delay` option for `socket.setKeepAlive` (#1396)
+- Add support for `rediss` protocol in url (#1282)
+
+## v2.8.0 - 31 Jul, 2017
+
+Features
+
+- Accept UPPER_CASE commands in send_command
+- Add arbitrary commands to the prototype by using `Redis.addCommand(name)`
+
+Bugfixes
+
+- Fixed not always copying subscribe unsubscribe arguments
+- Fixed emitting internal errors while reconnecting with auth
+- Fixed crashing with invalid url option
+
+## v2.7.1 - 14 Mar, 2017
+
+Bugfixes
+
+- Fixed monitor mode not working in combination with IPv6 (2.6.0 regression)
+
+## v2.7.0 - 11 Mar, 2017
+
+Features
+
+- All returned errors are from now a subclass of `RedisError`.
+
+Bugfixes
+
+- Fixed rename_commands not accepting `null` as value
+- Fixed `AbortError`s and `AggregateError`s not showing the error message in the stack trace
+
+## v2.6.5 - 15 Jan, 2017
+
+Bugfixes
+
+- Fixed parser not being reset in case the redis connection closed ASAP for overcoming of output buffer limits
+- Fixed parser reset if (p)message_buffer listener is attached
+
+## v2.6.4 - 12 Jan, 2017
+
+Bugfixes
+
+- Fixed monitor mode not working in combination with IPv6, sockets or lua scripts (2.6.0 regression)
+
+## v2.6.3 - 31 Oct, 2016
+
+Bugfixes
+
+- Do not change the tls setting to camel_case
+- Fix domain handling in combination with the offline queue (2.5.3 regression)
+
+## v2.6.2 - 16 Jun, 2016
+
+Bugfixes
+
+- Fixed individual callbacks of a transaction not being called (2.6.0 regression)
+
+## v2.6.1 - 02 Jun, 2016
+
+Bugfixes
+
+- Fixed invalid function name being exported
+
+## v2.6.0 - 01 Jun, 2016
+
+In addition to the pre-releases the following changes exist in v.2.6.0:
+
+Features
+
+- Updated [redis-parser](https://github.com/NodeRedis/node-redis-parser) dependency ([changelog](https://github.com/NodeRedis/node-redis-parser/releases/tag/v.2.0.0))
+- The JS parser is from now on the new default as it is a lot faster than the hiredis parser
+- This is no BC as there is no changed behavior for the user at all but just a performance improvement. Explicitly requireing the Hiredis parser is still possible.
+- Added name property to all Redis functions (Node.js >= 4.0)
+- Improved stack traces in development and debug mode
+
+Bugfixes
+
+- Reverted support for `__proto__` (v.2.6.0-2) to prevent and breaking change
+
+Deprecations
+
+- The `parser` option is deprecated and should be removed. The built-in Javascript parser is a lot faster than the hiredis parser and has more features
+
+## v2.6.0-2 - 29 Apr, 2016
+
+Features
+
+- Added support for the new [CLIENT REPLY ON|OFF|SKIP](http://redis.io/commands/client-reply) command (Redis v.3.2)
+- Added support for camelCase
+- The Node.js landscape default is to use camelCase. node_redis is a bit out of the box here
+ but from now on it is possible to use both, just as you prefer!
+- If there's any documented variable missing as camelCased, please open a issue for it
+- Improve error handling significantly
+- Only emit an error if the error has not already been handled in a callback
+- Improved unspecific error messages e.g. "Connection gone from end / close event"
+- Added `args` to command errors to improve identification of the error
+- Added origin to errors if there's e.g. a connection error
+- Added ReplyError class. All Redis errors are from now on going to be of that class
+- Added AbortError class. A subclass of AbortError. All unresolved and by node_redis rejected commands are from now on of that class
+- Added AggregateError class. If a unresolved and by node_redis rejected command has no callback and
+ this applies to more than a single command, the errors for the commands without callback are aggregated
+ to a single error that is emitted in debug_mode in that case.
+- Added `message_buffer` / `pmessage_buffer` events. That event is always going to emit a buffer
+- Listening to the `message` event at the same time is always going to return the same message as string
+- Added callback option to the duplicate function
+- Added support for `__proto__` and other reserved keywords as hgetall field
+- Updated [redis-commands](https://github.com/NodeRedis/redis-commands) dependency ([changelog](https://github.com/NodeRedis/redis-commands/releases/tag/v.1.2.0))
+
+Bugfixes
+
+- Fixed v.2.5.0 auth command regression (under special circumstances a reconnect would not authenticate properly)
+- Fixed v.2.6.0-0 pub sub mode and quit command regressions:
+- Entering pub sub mode not working if a earlier called and still running command returned an error
+- Unsubscribe callback not called if unsubscribing from all channels and resubscribing right away
+- Quit command resulting in an error in some cases
+- Fixed special handled functions in batch and multi context not working the same as without (e.g. select and info)
+- Be aware that not all commands work in combination with transactions but they all work with batch
+- Fixed address always set to 127.0.0.1:6379 in case host / port is set in the `tls` options instead of the general options
+
+## v2.6.0-1 - 01 Apr, 2016
+
+A second pre-release with further fixes. This is likely going to be released as 2.6.0 stable without further changes.
+
+Features
+
+- Added type validations for client.send_command arguments
+
+Bugfixes
+
+- Fixed client.send_command not working properly with every command and every option
+- Fixed pub sub mode unsubscribing from all channels in combination with the new `string_numbers` option crashing
+- Fixed pub sub mode unsubscribing from all channels not respected while reconnecting
+- Fixed pub sub mode events in combination with the `string_numbers` option emitting the number of channels not as number
+
+## v2.6.0-0 - 27 Mar, 2016
+
+This is mainly a very important bug fix release with some smaller features.
+
+Features
+
+- Monitor and pub sub mode now work together with the offline queue
+- All commands that were send after a connection loss are now going to be send after reconnecting
+- Activating monitor mode does now work together with arbitrary commands including pub sub mode
+- Pub sub mode is completely rewritten and all known issues fixed
+- Added `string_numbers` option to get back strings instead of numbers
+- Quit command is from now on always going to end the connection properly
+
+Bugfixes
+
+- Fixed calling monitor command while other commands are still running
+- Fixed monitor and pub sub mode not working together
+- Fixed monitor mode not working in combination with the offline queue
+- Fixed pub sub mode not working in combination with the offline queue
+- Fixed pub sub mode resubscribing not working with non utf8 buffer channels
+- Fixed pub sub mode crashing if calling unsubscribe / subscribe in various combinations
+- Fixed pub sub mode emitting unsubscribe even if no channels were unsubscribed
+- Fixed pub sub mode emitting a message without a message published
+- Fixed quit command not ending the connection and resulting in further reconnection if called while reconnecting
+
+The quit command did not end connections earlier if the connection was down at that time and this could have
+lead to strange situations, therefor this was fixed to end the connection right away in those cases.
+
+## v2.5.3 - 21 Mar, 2016
+
+Bugfixes
+
+- Revert throwing on invalid data types and print a warning instead
+
+## v2.5.2 - 16 Mar, 2016
+
+Bugfixes
+
+- Fixed breaking changes against Redis 2.4 introduced in 2.5.0 / 2.5.1
+
+## v2.5.1 - 15 Mar, 2016
+
+Bugfixes
+
+- Fixed info command not working anymore with optional section argument
+
+## v2.5.0 - 15 Mar, 2016
+
+Same changelog as the pre-release
+
+## v2.5.0-1 - 07 Mar, 2016
+
+This is a big release with some substantial underlining changes. Therefor this is released as a pre-release and I encourage anyone who's able to, to test this out.
+
+It took way to long to release this one and the next release cycles will be shorter again.
+
+This release is also going to deprecate a couple things to prepare for a future v.3 (it'll still take a while to v.3).
+
+Features
+
+- The parsers moved into the [redis-parser](https://github.com/NodeRedis/node-redis-parser) module and will be maintained in there from now on
+- Improve js parser speed significantly for big SUNION/SINTER/LRANGE/ZRANGE
+- Improve redis-url parsing to also accept the database-number and options as query parameters as suggested in [IANA](http://www.iana.org/assignments/uri-schemes/prov/redis)
+- Added a `retry_unfulfilled_commands` option
+- Setting this to 'true' results in retrying all commands that were not fulfilled on a connection loss after the reconnect. Use with caution
+- Added a `db` option to select the database while connecting (this is [not recommended](https://groups.google.com/forum/#!topic/redis-db/vS5wX8X4Cjg))
+- Added a `password` option as alias for auth_pass
+- The client.server_info is from now on updated while using the info command
+- Gracefuly handle redis protocol errors from now on
+- Added a `warning` emitter that receives node_redis warnings like auth not required and deprecation messages
+- Added a `retry_strategy` option that replaces all reconnect options
+- The reconnecting event from now on also receives:
+- The error message why the reconnect happened (params.error)
+- The amount of times the client was connected (params.times_connected)
+- The total reconnecting time since the last time connected (params.total_retry_time)
+- Always respect the command execution order no matter if the reply could be returned sync or not (former exceptions: [#937](https://github.com/NodeRedis/node_redis/issues/937#issuecomment-167525939))
+- redis.createClient is now checking input values stricter and detects more faulty input
+- Started refactoring internals into individual modules
+- Pipelining speed improvements
+
+Bugfixes
+
+- Fixed explicit undefined as a command callback in a multi context
+- Fixed hmset failing to detect the first key as buffer or date if the key is of that type
+- Fixed do not run toString on an array argument and throw a "invalid data" error instead
+- This is not considered as breaking change, as this is likely a error in your code and if you want to have such a behavior you should handle this beforehand
+- The same applies to Map / Set and individual Object types
+- Fixed redis url not accepting the protocol being omitted or protocols other than the redis protocol for convenience
+- Fixed parsing the db keyspace even if the first database does not begin with a zero
+- Fixed handling of errors occurring while receiving pub sub messages
+- Fixed huge string pipelines crashing NodeJS (Pipeline size above 256mb)
+- Fixed rename_commands and prefix option not working together
+- Fixed ready being emitted to early in case a slave is still syncing / master down
+
+Deprecations
+
+- Using any command with a argument being set to null or undefined is deprecated
+- From v.3.0.0 on using a command with such an argument will return an error instead
+- If you want to keep the old behavior please use a precheck in your code that converts the arguments to a string.
+- Using SET or SETEX with a undefined or null value will from now on also result in converting the value to "null" / "undefined" to have a consistent behavior. This is not considered as breaking change, as it returned an error earlier.
+- Using .end(flush) without the flush parameter is deprecated and the flush parameter should explicitly be used
+- From v.3.0.0 on using .end without flush will result in an error
+- Using .end without flush means that any command that did not yet return is going to silently fail. Therefor this is considered harmful and you should explicitly silence such errors if you are sure you want this
+- Depending on the return value of a command to detect the backpressure is deprecated
+- From version 3.0.0 on node_redis might not return true / false as a return value anymore. Please rely on client.should_buffer instead
+- The `socket_nodelay` option is deprecated and will be removed in v.3.0.0
+- If you want to buffer commands you should use [.batch or .multi](./README.md) instead. This is necessary to reduce the amount of different options and this is very likely reducing your throughput if set to false.
+- If you are sure you want to activate the NAGLE algorithm you can still activate it by using client.stream.setNoDelay(false)
+- The `max_attempts` option is deprecated and will be removed in v.3.0.0. Please use the `retry_strategy` instead
+- The `retry_max_delay` option is deprecated and will be removed in v.3.0.0. Please use the `retry_strategy` instead
+- The drain event is deprecated and will be removed in v.3.0.0. Please listen to the stream drain event instead
+- The idle event is deprecated and will likely be removed in v.3.0.0. If you rely on this feature please open a new ticket in node_redis with your use case
+- Redis < v. 2.6 is not officially supported anymore and might not work in all cases. Please update to a newer redis version as it is not possible to test for these old versions
+- Removed non documented command syntax (adding the callback to an arguments array instead of passing it as individual argument)
+
+## v2.4.2 - 27 Nov, 2015
+
+Bugfixes
+
+- Fixed not emitting ready after reconnect with disable_resubscribing ([@maxgalbu](https://github.com/maxgalbu))
+
+## v2.4.1 - 25 Nov, 2015
+
+Bugfixes
+
+- Fixed a js parser regression introduced in 2.4.0 ([@BridgeAR](https://github.com/BridgeAR))
+
+## v2.4.0 - 25 Nov, 2015
+
+Features
+
+- Added `tls` option to initiate a connection to a redis server behind a TLS proxy. Thanks ([@paddybyers](https://github.com/paddybyers))
+- Added `prefix` option to auto key prefix any command with the provided prefix ([@luin](https://github.com/luin) & [@BridgeAR](https://github.com/BridgeAR))
+- Added `url` option to pass the connection url with the options object ([@BridgeAR](https://github.com/BridgeAR))
+- Added `client.duplicate([options])` to duplicate the current client and return a new one with the same options ([@BridgeAR](https://github.com/BridgeAR))
+- Improve performance by up to 20% on almost all use cases ([@BridgeAR](https://github.com/BridgeAR))
+
+Bugfixes
+
+- Fixed js parser handling big values slow ([@BridgeAR](https://github.com/BridgeAR))
+- The speed is now on par with the hiredis parser.
+
+## v2.3.1 - 18 Nov, 2015
+
+Bugfixes
+
+- Fixed saving buffers with charsets other than utf-8 while using multi ([@BridgeAR](https://github.com/BridgeAR))
+- Fixed js parser handling big values very slow ([@BridgeAR](https://github.com/BridgeAR))
+- The speed is up to ~500% faster than before but still up to ~50% slower than the hiredis parser.
+
+## v2.3.0 - 30 Oct, 2015
+
+Features
+
+- Improve speed further for: ([@BridgeAR](https://github.com/BridgeAR))
+- saving big strings (up to +300%)
+- using .multi / .batch (up to +50% / on Node.js 0.10.x +300%)
+- saving small buffers
+- Increased coverage to 99% ([@BridgeAR](https://github.com/BridgeAR))
+- Refactored manual backpressure control ([@BridgeAR](https://github.com/BridgeAR))
+- Removed the high water mark and low water mark. Such a mechanism should be implemented by a user instead
+- The `drain` event is from now on only emitted if the stream really had to buffer
+- Reduced the default connect_timeout to be one hour instead of 24h ([@BridgeAR](https://github.com/BridgeAR))
+- Added .path to redis.createClient(options); ([@BridgeAR](https://github.com/BridgeAR))
+- Ignore info command, if not available on server ([@ivanB1975](https://github.com/ivanB1975))
+
+Bugfixes
+
+- Fixed a js parser error that could result in a timeout ([@BridgeAR](https://github.com/BridgeAR))
+- Fixed .multi / .batch used with Node.js 0.10.x not working properly after a reconnect ([@BridgeAR](https://github.com/BridgeAR))
+- Fixed fired but not yet returned commands not being rejected after a connection loss ([@BridgeAR](https://github.com/BridgeAR))
+- Fixed connect_timeout not respected if no connection has ever been established ([@gagle](https://github.com/gagle) & [@benjie](https://github.com/benjie))
+- Fixed return_buffers in pub sub mode ([@komachi](https://github.com/komachi))
+
+## v2.2.5 - 18 Oct, 2015
+
+Bugfixes
+
+- Fixed undefined options passed to a new instance not accepted (possible with individual .createClient functions) ([@BridgeAR](https://github.com/BridgeAR))
+
+## v2.2.4 - 17 Oct, 2015
+
+Bugfixes
+
+- Fixed unspecific error message for unresolvable commands ([@BridgeAR](https://github.com/BridgeAR))
+- Fixed not allowed command error in pubsub mode not being returned in a provided callback ([@BridgeAR](https://github.com/BridgeAR))
+- Fixed to many commands forbidden in pub sub mode ([@BridgeAR](https://github.com/BridgeAR))
+- Fixed mutation of the arguments array passed to .multi / .batch constructor ([@BridgeAR](https://github.com/BridgeAR))
+- Fixed mutation of the options object passed to createClient ([@BridgeAR](https://github.com/BridgeAR))
+- Fixed error callback in .multi not called if connection in broken mode ([@BridgeAR](https://github.com/BridgeAR))
+
+## v2.2.3 - 14 Oct, 2015
+
+Bugfixes
+
+- Fixed multi not being executed on Node 0.10.x if node_redis not yet ready ([@BridgeAR](https://github.com/BridgeAR))
+
+## v2.2.2 - 14 Oct, 2015
+
+Bugfixes
+
+- Fixed regular commands not being executed after a .multi until .exec was called ([@BridgeAR](https://github.com/BridgeAR))
+
+## v2.2.1 - 12 Oct, 2015
+
+No code change
+
+## v2.2.0 - 12 Oct, 2015 - The peregrino falcon
+
+The peregrino falcon is the fasted bird on earth and this is what this release is all about: Increased performance for heavy usage by up to **400%** [sic!] and increased overall performance for any command as well. Please check the benchmarks in the [README.md](./README.md) for further details.
+
+Features
+
+- Added rename_commands options to handle renamed commands from the redis config ([@digmxl](https://github.com/digmxl) & [@BridgeAR](https://github.com/BridgeAR))
+- Added disable_resubscribing option to prevent a client from resubscribing after reconnecting ([@BridgeAR](https://github.com/BridgeAR))
+- Increased performance ([@BridgeAR](https://github.com/BridgeAR))
+- exchanging built in queue with [@petkaantonov](https://github.com/petkaantonov)'s [double-ended queue](https://github.com/petkaantonov/deque)
+- prevent polymorphism
+- optimize statements
+- Added _.batch_ command, similar to .multi but without transaction ([@BridgeAR](https://github.com/BridgeAR))
+- Improved pipelining to minimize the [RTT](http://redis.io/topics/pipelining) further ([@BridgeAR](https://github.com/BridgeAR))
+
+Bugfixes
+
+- Fixed a javascript parser regression introduced in 2.0 that could result in timeouts on high load. ([@BridgeAR](https://github.com/BridgeAR))
+- I was not able to write a regression test for this, since the error seems to only occur under heavy load with special conditions. So please have a look for timeouts with the js parser, if you use it and report all issues and switch to the hiredis parser in the meanwhile. If you're able to come up with a reproducible test case, this would be even better :)
+- Fixed should_buffer boolean for .exec, .select and .auth commands not being returned and fix a couple special conditions ([@BridgeAR](https://github.com/BridgeAR))
+
+If you do not rely on transactions but want to reduce the RTT you can use .batch from now on. It'll behave just the same as .multi but it does not have any transaction and therefor won't roll back any failed commands.
+Both .multi and .batch are from now on going to cache the commands and release them while calling .exec.
+
+Please consider using .batch instead of looping through a lot of commands one by one. This will significantly improve your performance.
+
+Here are some stats compared to ioredis 1.9.1 (Lenovo T450s i7-5600U):
+
+ simple set
+ 82,496 op/s Β» ioredis
+ 112,617 op/s Β» node_redis
+
+ simple get
+ 82,015 op/s Β» ioredis
+ 105,701 op/s Β» node_redis
+
+ simple get with pipeline
+ 10,233 op/s Β» ioredis
+ 26,541 op/s Β» node_redis (using .batch)
+
+ lrange 100
+ 7,321 op/s Β» ioredis
+ 26,155 op/s Β» node_redis
+
+ publish
+ 90,524 op/s Β» ioredis
+ 112,823 op/s Β» node_redis
+
+ subscribe
+ 43,783 op/s Β» ioredis
+ 61,889 op/s Β» node_redis
+
+To conclude: we can proudly say that node_redis is very likely outperforming any other node redis client.
+
+Known issues
+
+- The pub sub system has some flaws and those will be addressed in the next minor release
+
+## v2.1.0 - Oct 02, 2015
+
+Features:
+
+- Addded optional flush parameter to `.end`. If set to true, commands fired after using .end are going to be rejected instead of being ignored. (@crispy1989)
+- Addded: host and port can now be provided in a single options object. E.g. redis.createClient({ host: 'localhost', port: 1337, max_attempts: 5 }); (@BridgeAR)
+- Speedup common cases (@BridgeAR)
+
+Bugfixes:
+
+- Fix argument mutation while using the array notation with the multi constructor (@BridgeAR)
+- Fix multi.hmset key not being type converted if used with an object and key not being a string (@BridgeAR)
+- Fix parser errors not being caught properly (@BridgeAR)
+- Fix a crash that could occur if a redis server does not return the info command as usual #541 (@BridgeAR)
+- Explicitly passing undefined as a callback statement will work again. E.g. client.publish('channel', 'message', undefined); (@BridgeAR)
+
+## v2.0.1 - Sep 24, 2015
+
+Bugfixes:
+
+- Fix argument mutation while using the array notation in combination with keys / callbacks ([#866](.)). (@BridgeAR)
+
+## v2.0.0 - Sep 21, 2015
+
+This is the biggest release that node_redis had since it was released in 2010. A long list of outstanding bugs has been fixed, so we are very happy to present you redis 2.0 and we highly recommend updating as soon as possible.
+
+# What's new in 2.0
+
+- Implemented a "connection is broken" mode if no connection could be established
+- node_redis no longer throws under any circumstances, preventing it from terminating applications.
+- Multi error handling is now working properly
+- Consistent command behavior including multi
+- Windows support
+- Improved performance
+- A lot of code cleanup
+- Many bug fixes
+- Better user support!
+
+## Features:
+
+- Added a "redis connection is broken" mode after reaching max connection attempts / exceeding connection timeout. (@BridgeAR)
+- Added NODE_DEBUG=redis env to activate the debug_mode (@BridgeAR)
+- Added a default connection timeout of 24h instead of never timing out as a default (@BridgeAR)
+- Added: Network errors and other stream errors will from now on include the error code as `err.code` property (@BridgeAR)
+- Added: Errors thrown by redis will now include the redis error code as `err.code` property. (@skeggse & @BridgeAR)
+- Added: Errors thrown by node_redis will now include a `err.command` property for the command used (@BridgeAR)
+- Added new commands and drop support for deprecated _substr_ (@BridgeAR)
+- Added new possibilities how to provide the command arguments (@BridgeAR)
+- The entries in the keyspace of the server_info is now an object instead of a string. (@SinisterLight & @BridgeAR)
+- Small speedup here and there (e.g. by not using .toLowerCase() anymore) (@BridgeAR)
+- Full windows support (@bcoe)
+- Increased coverage by 10% and add a lot of tests to make sure everything works as it should. We now reached 97% :-) (@BridgeAR)
+- Remove dead code, clean up and refactor very old chunks (@BridgeAR)
+- Don't flush the offline queue if reconnecting (@BridgeAR)
+- Emit all errors instead of throwing sometimes and sometimes emitting them (@BridgeAR)
+- _auth_pass_ passwords are now checked to be a valid password (@jcppman & @BridgeAR)
+
+## Bug fixes:
+
+- Don't kill the app anymore by randomly throwing errors sync instead of emitting them (@BridgeAR)
+- Don't catch user errors anymore occurring in callbacks (no try callback anymore & more fixes for the parser) (@BridgeAR)
+- Early garbage collection of queued items (@dohse)
+- Fix js parser returning errors as strings (@BridgeAR)
+- Do not wrap errors into other errors (@BridgeAR)
+- Authentication failures are now returned in the callback instead of being emitted (@BridgeAR)
+- Fix a memory leak on reconnect (@rahar)
+- Using `send_command` directly may now also be called without the args as stated in the [README.md](./README.md) (@BridgeAR)
+- Fix the multi.exec error handling (@BridgeAR)
+- Fix commands being inconsistent and behaving wrong (@BridgeAR)
+- Channel names with spaces are now properly resubscribed after a reconnection (@pbihler)
+- Do not try to reconnect after the connection timeout has been exceeded (@BridgeAR)
+- Ensure the execution order is observed if using .eval (@BridgeAR)
+- Fix commands not being rejected after calling .quit (@BridgeAR)
+- Fix .auth calling the callback twice if already connected (@BridgeAR)
+- Fix detect_buffers not working in pub sub mode and while monitoring (@BridgeAR)
+- Fix channel names always being strings instead of buffers while return_buffers is true (@BridgeAR)
+- Don't print any debug statements if not asked for (@BridgeAR)
+- Fix a couple small other bugs
+
+## Breaking changes:
+
+1. redis.send_command commands have to be lower case from now on. This does only apply if you use `.send_command` directly instead of the convenient methods like `redis.command`.
+2. Error messages have changed quite a bit. If you depend on a specific wording please check your application carefully.
+3. Errors are from now on always either returned if a callback is present or emitted. They won't be thrown (neither sync, nor async).
+4. The Multi error handling has changed a lot!
+
+- All errors are from now on errors instead of strings (this only applied to the js parser).
+- If an error occurs while queueing the commands an EXECABORT error will be returned including the failed commands as `.errors` property instead of an array with errors.
+- If an error occurs while executing the commands and that command has a callback it'll return the error as first parameter (`err, undefined` instead of `null, undefined`).
+- All the errors occurring while executing the commands will stay in the result value as error instance (if you used the js parser before they would have been strings). Be aware that the transaction won't be aborted if those error occur!
+- If `multi.exec` does not have a callback and an EXECABORT error occurrs, it'll emit that error instead.
+
+5. If redis can't connect to your redis server it'll give up after a certain point of failures (either max connection attempts or connection timeout exceeded). If that is the case it'll emit an CONNECTION_BROKEN error. You'll have to initiate a new client to try again afterwards.
+6. The offline queue is not flushed anymore on a reconnect. It'll stay until node_redis gives up trying to reach the server or until you close the connection.
+7. Before this release node_redis caught user errors and threw them async back. This is not the case anymore! No user behavior of what so ever will be tracked or caught.
+8. The keyspace of `redis.server_info` (db0...) is from now on an object instead of an string.
+
+NodeRedis also thanks @qdb, @tobek, @cvibhagool, @frewsxcv, @davidbanham, @serv, @vitaliylag, @chrishamant, @GamingCoder and all other contributors that I may have missed for their contributions!
+
+From now on we'll push new releases more frequently out and fix further long outstanding things and implement new features.
+
+
+
+## v1.0.0 - Aug 30, 2015
+
+- Huge issue and pull-request cleanup. Thanks Blain! (@blainsmith)
+- [#658](https://github.com/NodeRedis/node_redis/pull/658) Client now parses URL-format connection strings (e.g., redis://foo:pass@127.0.0.1:8080) (@kuwabarahiroshi)
+- [#749](https://github.com/NodeRedis/node_redis/pull/749) Fix reconnection bug when client is in monitoring mode (@danielbprice)
+- [#786](https://github.com/NodeRedis/node_redis/pull/786) Refactor createClient. Fixes #651 (@BridgeAR)
+- [#793](https://github.com/NodeRedis/node_redis/pull/793) Refactor tests and improve test coverage (@erinspice, @bcoe)
+- [#733](https://github.com/NodeRedis/node_redis/pull/733) Fixes detect_buffers functionality in the context of exec. Fixes #732, #263 (@raydog)
+- [#785](https://github.com/NodeRedis/node_redis/pull/785) Tiny speedup by using 'use strict' (@BridgeAR)
+- Fix extraneous error output due to pubsub tests (Mikael Kohlmyr)
+
+## v0.12.1 - Aug 10, 2014
+
+- Fix IPv6/IPv4 family selection in node 0.11+ (Various)
+
+## v0.12.0 - Aug 9, 2014
+
+- Fix unix socket support (Jack Tang)
+- Improve createClient argument handling (Jack Tang)
+
+## v0.11.0 - Jul 10, 2014
+
+- IPv6 Support. (Yann Stephan)
+- Revert error emitting and go back to throwing errors. (Bryce Baril)
+- Set socket_keepalive to prevent long-lived client timeouts. (mohit)
+- Correctly reset retry timer. (ouotuo)
+- Domains protection from bad user exit. (Jake Verbaten)
+- Fix reconnection socket logic to prevent misqueued entries. (Iain Proctor)
+
+## v0.10.3 - May 22, 2014
+
+- Update command list to match Redis 2.8.9 (Charles Feng)
+
+## v0.10.2 - May 18, 2014
+
+- Better binary key handling for HGETALL. (Nick Apperson)
+- Fix test not resetting `error` handler. (CrypticSwarm)
+- Fix SELECT error semantics. (Bryan English)
+
+## v0.10.1 - February 17, 2014
+
+- Skip plucking redis version from the INFO stream if INFO results weren't provided. (Robert SkΓΆld)
+
+## v0.10.0 - December 21, 2013
+
+- Instead of throwing errors asynchronously, emit errors on client. (Bryce Baril)
+
+## v0.9.2 - December 15, 2013
+
+- Regenerate commands for new 2.8.x Redis commands. (Marek Ventur)
+- Correctly time reconnect counts when using 'auth'. (William Hockey)
+
+## v0.9.1 - November 23, 2013
+
+- Allow hmset to accept numeric keys. (Alex Stokes)
+- Fix TypeError for multiple MULTI/EXEC errors. (Kwangsu Kim)
+
+## v0.9.0 - October 17, 2013
+
+- Domains support. (Forrest L Norvell)
+
+## v0.8.6 - October 2, 2013
+
+- If error is already an Error, don't wrap it in another Error. (Mathieu M-Gosselin)
+- Fix retry delay logic (Ian Babrou)
+- Return Errors instead of strings where Errors are expected (Ian Babrou)
+- Add experimental `.unref()` method to RedisClient (Bryce Baril / Olivier Lalonde)
+- Strengthen checking of reply to prevent conflating "message" or "pmessage" fields with pub_sub replies. (Bryce Baril)
+
+## v0.8.5 - September 26, 2013
+
+- Add `auth_pass` option to connect and immediately authenticate (Henrik Peinar)
+
+## v0.8.4 - June 24, 2013
+
+Many contributed features and fixes, including:
+
+- Ignore password set if not needed. (jbergknoff)
+- Improved compatibility with 0.10.X for tests and client.end() (Bryce Baril)
+- Protect connection retries from application exceptions. (Amos Barreto)
+- Better exception handling for Multi/Exec (Thanasis Polychronakis)
+- Renamed pubsub mode to subscriber mode (Luke Plaster)
+- Treat SREM like SADD when passed an array (Martin Ciparelli)
+- Fix empty unsub/punsub TypeError (Jeff Barczewski)
+- Only attempt to run a callback if it one was provided (jifeng)
+
+## v0.8.3 - April 09, 2013
+
+Many contributed features and fixes, including:
+
+- Fix some tests for Node.js version 0.9.x+ changes (Roman Ivanilov)
+- Fix error when commands submitted after idle event handler (roamm)
+- Bypass Redis for no-op SET/SETEX commands (jifeng)
+- Fix HMGET + detect_buffers (Joffrey F)
+- Fix CLIENT LOAD functionality (Jonas Dohse)
+- Add percentage outputs to diff_multi_bench_output.js (Bryce Baril)
+- Add retry_max_delay option (Tomasz Durka)
+- Fix parser off-by-one errors with nested multi-bulk replies (Bryce Baril)
+- Prevent parser from sinking application-side exceptions (Bryce Baril)
+- Fix parser incorrect buffer skip when parsing multi-bulk errors (Bryce Baril)
+- Reverted previous change with throwing on non-string values with HMSET (David Trejo)
+- Fix command queue sync issue when using pubsub (Tom Leach)
+- Fix compatibility with two-word Redis commands (Jonas Dohse)
+- Add EVAL with array syntax (dmoena)
+- Fix tests due to Redis reply order changes in 2.6.5+ (Bryce Baril)
+- Added a test for the SLOWLOG command (Nitesh Sinha)
+- Fix SMEMBERS order dependency in test broken by Redis changes (Garrett Johnson)
+- Update commands for new Redis commands (David Trejo)
+- Prevent exception from SELECT on subscriber reconnection (roamm)
+
+## v0.8.2 - November 11, 2012
+
+Another version bump because 0.8.1 didn't get applied properly for some mysterious reason.
+Sorry about that.
+
+Changed name of "faster" parser to "javascript".
+
+## v0.8.1 - September 11, 2012
+
+Important bug fix for null responses (Jerry Sievert)
+
+## v0.8.0 - September 10, 2012
+
+Many contributed features and fixes, including:
+
+- Pure JavaScript reply parser that is usually faster than hiredis (Jerry Sievert)
+- Remove hiredis as optionalDependency from package.json. It still works if you want it.
+- Restore client state on reconnect, including select, subscribe, and monitor. (Ignacio BurgueΓ±o)
+- Fix idle event (Trae Robrock)
+- Many documentation improvements and bug fixes (David Trejo)
+
+## v0.7.2 - April 29, 2012
+
+Many contributed fixes. Thank you, contributors.
+
+- [GH-190] - pub/sub mode fix (Brian Noguchi)
+- [GH-165] - parser selection fix (TEHEK)
+- numerous documentation and examples updates
+- auth errors emit Errors instead of Strings (David Trejo)
+
+## v0.7.1 - November 15, 2011
+
+Fix regression in reconnect logic.
+
+Very much need automated tests for reconnection and queue logic.
+
+## v0.7.0 - November 14, 2011
+
+Many contributed fixes. Thanks everybody.
+
+- [GH-127] - properly re-initialize parser on reconnect
+- [GH-136] - handle passing undefined as callback (Ian Babrou)
+- [GH-139] - properly handle exceptions thrown in pub/sub event handlers (Felix GeisendΓΆrfer)
+- [GH-141] - detect closing state on stream error (Felix GeisendΓΆrfer)
+- [GH-142] - re-select database on reconnection (Jean-Hugues Pinson)
+- [GH-146] - add sort example (Maksim Lin)
+
+Some more goodies:
+
+- Fix bugs with node 0.6
+- Performance improvements
+- New version of `multi_bench.js` that tests more realistic scenarios
+- [GH-140] - support optional callback for subscribe commands
+- Properly flush and error out command queue when connection fails
+- Initial work on reconnection thresholds
+
+## v0.6.7 - July 30, 2011
+
+(accidentally skipped v0.6.6)
+
+Fix and test for [GH-123]
+
+Passing an Array as as the last argument should expand as users
+expect. The old behavior was to coerce the arguments into Strings,
+which did surprising things with Arrays.
+
+## v0.6.5 - July 6, 2011
+
+Contributed changes:
+
+- Support SlowBuffers (Umair Siddique)
+- Add Multi to exports (Louis-Philippe Perron)
+- Fix for drain event calculation (Vladimir Dronnikov)
+
+Thanks!
+
+## v0.6.4 - June 30, 2011
+
+Fix bug with optional callbacks for hmset.
+
+## v0.6.2 - June 30, 2011
+
+Bugs fixed:
+
+- authentication retry while server is loading db (danmaz74) [GH-101]
+- command arguments processing issue with arrays
+
+New features:
+
+- Auto update of new commands from redis.io (Dave Hoover)
+- Performance improvements and backpressure controls.
+- Commands now return the true/false value from the underlying socket write(s).
+- Implement command_queue high water and low water for more better control of queueing.
+
+See `examples/backpressure_drain.js` for more information.
+
+## v0.6.1 - June 29, 2011
+
+Add support and tests for Redis scripting through EXEC command.
+
+Bug fix for monitor mode. (forddg)
+
+Auto update of new commands from redis.io (Dave Hoover)
+
+## v0.6.0 - April 21, 2011
+
+Lots of bugs fixed.
+
+- connection error did not properly trigger reconnection logic [GH-85]
+- client.hmget(key, [val1, val2]) was not expanding properly [GH-66]
+- client.quit() while in pub/sub mode would throw an error [GH-87]
+- client.multi(['hmset', 'key', {foo: 'bar'}]) fails [GH-92]
+- unsubscribe before subscribe would make things very confused [GH-88]
+- Add BRPOPLPUSH [GH-79]
+
+## v0.5.11 - April 7, 2011
+
+Added DISCARD
+
+I originally didn't think DISCARD would do anything here because of the clever MULTI interface, but somebody
+pointed out to me that DISCARD can be used to flush the WATCH set.
+
+## v0.5.10 - April 6, 2011
+
+Added HVALS
+
+## v0.5.9 - March 14, 2011
+
+Fix bug with empty Array arguments - Andy Ray
+
+## v0.5.8 - March 14, 2011
+
+Add `MONITOR` command and special monitor command reply parsing.
+
+## v0.5.7 - February 27, 2011
+
+Add magical auth command.
+
+Authentication is now remembered by the client and will be automatically sent to the server
+on every connection, including any reconnections.
+
+## v0.5.6 - February 22, 2011
+
+Fix bug in ready check with `return_buffers` set to `true`.
+
+Thanks to Dean Mao and Austin Chau.
+
+## v0.5.5 - February 16, 2011
+
+Add probe for server readiness.
+
+When a Redis server starts up, it might take a while to load the dataset into memory.
+During this time, the server will accept connections, but will return errors for all non-INFO
+commands. Now node_redis will send an INFO command whenever it connects to a server.
+If the info command indicates that the server is not ready, the client will keep trying until
+the server is ready. Once it is ready, the client will emit a "ready" event as well as the
+"connect" event. The client will queue up all commands sent before the server is ready, just
+like it did before. When the server is ready, all offline/non-ready commands will be replayed.
+This should be backward compatible with previous versions.
+
+To disable this ready check behavior, set `options.no_ready_check` when creating the client.
+
+As a side effect of this change, the key/val params from the info command are available as
+`client.server_options`. Further, the version string is decomposed into individual elements
+in `client.server_options.versions`.
+
+## v0.5.4 - February 11, 2011
+
+Fix excess memory consumption from Queue backing store.
+
+Thanks to Gustaf SjΓΆberg.
+
+## v0.5.3 - February 5, 2011
+
+Fix multi/exec error reply callback logic.
+
+Thanks to Stella Laurenzo.
+
+## v0.5.2 - January 18, 2011
+
+Fix bug where unhandled error replies confuse the parser.
+
+## v0.5.1 - January 18, 2011
+
+Fix bug where subscribe commands would not handle redis-server startup error properly.
+
+## v0.5.0 - December 29, 2010
+
+Some bug fixes:
+
+- An important bug fix in reconnection logic. Previously, reply callbacks would be invoked twice after
+ a reconnect.
+- Changed error callback argument to be an actual Error object.
+
+New feature:
+
+- Add friendly syntax for HMSET using an object.
+
+## v0.4.1 - December 8, 2010
+
+Remove warning about missing hiredis. You probably do want it though.
+
+## v0.4.0 - December 5, 2010
+
+Support for multiple response parsers and hiredis C library from Pieter Noordhuis.
+Return Strings instead of Buffers by default.
+Empty nested mb reply bug fix.
+
+## v0.3.9 - November 30, 2010
+
+Fix parser bug on failed EXECs.
+
+## v0.3.8 - November 10, 2010
+
+Fix for null MULTI response when WATCH condition fails.
+
+## v0.3.7 - November 9, 2010
+
+Add "drain" and "idle" events.
+
+## v0.3.6 - November 3, 2010
+
+Add all known Redis commands from Redis master, even ones that are coming in 2.2 and beyond.
+
+Send a friendlier "error" event message on stream errors like connection refused / reset.
+
+## v0.3.5 - October 21, 2010
+
+A few bug fixes.
+
+- Fixed bug with `nil` multi-bulk reply lengths that showed up with `BLPOP` timeouts.
+- Only emit `end` once when connection goes away.
+- Fixed bug in `test.js` where driver finished before all tests completed.
+
+## unversioned wasteland
+
+See the git history for what happened before.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000000..0243cc19359
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,68 @@
+# Introduction
+
+First, thank you for considering contributing to Node Redis! It's people like you that make the open source community such a great community! π
+
+We welcome any type of contribution, not just code. You can help with:
+
+- **QA**: file bug reports, the more details you can give the better (e.g. platform versions, screenshots, SDK versions, logs)
+- **Docs**: improve reference coverage, add more examples, fix typos or anything else you can spot
+- **Code**: take a look at the open issues and help triage them
+
+---
+
+## Project Guidelines
+
+As maintainers of this project, we want to ensure that the project lives and continues to grow. Progress should not be blocked by any one person's availability.
+
+One of the simplest ways of doing this is by encouraging a larger set of contributors. Using this approach we hope to mitigate the challenges of maintaining a project that needs regular updates.
+
+### Getting Comfortable Contributing
+
+It is normal for your first pull request to be a potential fix for a problem but moving on from there to helping the project's direction can be difficult.
+
+We try to help contributors cross that barrier by identifying good first step issues (labelled `good-first-issue`). These issues are considered appropriate for first time contributors. Generally, these should be non-critical issues that are well defined. Established contributors will not work on these, to make space for others.
+
+New contributors may consider picking up issues labelled `needs-triage` or `help-wanted`. These may not necessarily require code changes but rather help with debugging and finding the cause of the issue whether it's a bug or a user's incorrect setup of the library or project.
+
+We keep all project discussion inside GitHub issues. This ensures that valuable information can be searched easily. GitHub issues are the go to tool for questions about how to use the library, or how the project is run.
+
+### Expectations of Contributors
+
+You shouldn't feel bad for not contributing to open source. We want contributors like yourself to provide ideas, keep the ship shipping and to take some of the load from others. It is non-obligatory; weβre here to get things done in an enjoyable way. :trophy:
+
+We only ask that you follow the conduct guidelines set out in our [Code of Conduct](https://redis.com/community/community-guidelines-code-of-conduct/) throughout your contribution journey.
+
+
+#### Special Thanks
+
+A huge thank you to the original author of Node Redis, [Matthew Ranney](https://github.com/mranney).
+
+---
+
+## Code Guidelines
+
+### Testing Code
+
+Node Redis has a full test suite with coverage setup.
+
+To run the tests, run `npm install` to install dependencies, then run `npm run build:tests-tools && npm test`.
+
+Note that the test suite assumes that [`docker`](https://www.docker.com/) is installed in your environment.
+
+### Submitting Code for Review
+
+The bigger the pull request, the longer it will take to review and merge. Where possible try to break down large pull requests into smaller chunks that are easier to review and merge. It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you? What problem are you trying to solve? Tag in any relevant issues.
+
+To assist reviewers, we ask that you fill out the pull request template as much as possible.
+
+> Use a `draft` pull request if your pull request is not complete or ready for review.
+
+### Code Review Process
+
+Pull Requests to the protected branches require peer-review approvals and passing status checks to be able to be merged.
+
+When reviewing a Pull Request please check the following steps as well as the existing automated checks:
+
+- Does your Pull Request provide or update the docs if docs changes are required?
+- Have the tests been updated or new tests been added to test any newly implemented or changed functionality?
+- Is the test coverage at the same level as before (preferably more!)?
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 00000000000..8509ccd678e
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-2023, Redis, inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
index 10b90cfced8..e6332764e4c 100644
--- a/README.md
+++ b/README.md
@@ -1,597 +1,333 @@
-redis - a node.js redis client
-===========================
+# Node-Redis
-This is a complete Redis client for node.js. It supports all Redis commands, including many recently added commands like EVAL from
-experimental Redis server branches.
+[](https://github.com/redis/node-redis/actions/workflows/tests.yml)
+[](https://codecov.io/gh/redis/node-redis)
+[](https://github.com/redis/node-redis/blob/master/LICENSE)
+[](https://discord.gg/redis)
+[](https://www.twitch.tv/redisinc)
+[](https://www.youtube.com/redisinc)
+[](https://twitter.com/redisinc)
-Install with:
+node-redis is a modern, high performance [Redis](https://redis.io) client for Node.js.
- npm install redis
-
-Pieter Noordhuis has provided a binding to the official `hiredis` C library, which is non-blocking and fast. To use `hiredis`, do:
+## How do I Redis?
- npm install hiredis redis
+[Learn for free at Redis University](https://university.redis.com/)
-If `hiredis` is installed, `node_redis` will use it by default. Otherwise, a pure JavaScript parser will be used.
+[Build faster with the Redis Launchpad](https://launchpad.redis.com/)
-If you use `hiredis`, be sure to rebuild it whenever you upgrade your version of node. There are mysterious failures that can
-happen between node and native code modules after a node upgrade.
+[Try the Redis Cloud](https://redis.com/try-free/)
+[Dive in developer tutorials](https://developer.redis.com/)
-## Usage
-
-Simple example, included as `examples/simple.js`:
-
- var redis = require("redis"),
- client = redis.createClient();
-
- client.on("error", function (err) {
- console.log("Error " + err);
- });
-
- client.set("string key", "string val", redis.print);
- client.hset("hash key", "hashtest 1", "some value", redis.print);
- client.hset(["hash key", "hashtest 2", "some other value"], redis.print);
- client.hkeys("hash key", function (err, replies) {
- console.log(replies.length + " replies:");
- replies.forEach(function (reply, i) {
- console.log(" " + i + ": " + reply);
- });
- client.quit();
- });
-
-This will display:
-
- mjr:~/work/node_redis (master)$ node example.js
- Reply: OK
- Reply: 0
- Reply: 0
- 2 replies:
- 0: hashtest 1
- 1: hashtest 2
- mjr:~/work/node_redis (master)$
-
-
-## Performance
-
-Here are typical results of `multi_bench.js` which is similar to `redis-benchmark` from the Redis distribution.
-It uses 50 concurrent connections with no pipelining.
-
-JavaScript parser:
-
- PING: 20000 ops 42283.30 ops/sec 0/5/1.182
- SET: 20000 ops 32948.93 ops/sec 1/7/1.515
- GET: 20000 ops 28694.40 ops/sec 0/9/1.740
- INCR: 20000 ops 39370.08 ops/sec 0/8/1.269
- LPUSH: 20000 ops 36429.87 ops/sec 0/8/1.370
- LRANGE (10 elements): 20000 ops 9891.20 ops/sec 1/9/5.048
- LRANGE (100 elements): 20000 ops 1384.56 ops/sec 10/91/36.072
-
-hiredis parser:
-
- PING: 20000 ops 46189.38 ops/sec 1/4/1.082
- SET: 20000 ops 41237.11 ops/sec 0/6/1.210
- GET: 20000 ops 39682.54 ops/sec 1/7/1.257
- INCR: 20000 ops 40080.16 ops/sec 0/8/1.242
- LPUSH: 20000 ops 41152.26 ops/sec 0/3/1.212
- LRANGE (10 elements): 20000 ops 36563.07 ops/sec 1/8/1.363
- LRANGE (100 elements): 20000 ops 21834.06 ops/sec 0/9/2.287
-
-The performance of `node_redis` improves dramatically with pipelining, which happens automatically in most normal programs.
-
-
-### Sending Commands
-
-Each Redis command is exposed as a function on the `client` object.
-All functions take either take either an `args` Array plus optional `callback` Function or
-a variable number of individual arguments followed by an optional callback.
-Here is an example of passing an array of arguments and a callback:
-
- client.mset(["test keys 1", "test val 1", "test keys 2", "test val 2"], function (err, res) {});
-
-Here is that same call in the second style:
-
- client.mset("test keys 1", "test val 1", "test keys 2", "test val 2", function (err, res) {});
-
-Note that in either form the `callback` is optional:
-
- client.set("some key", "some val");
- client.set(["some other key", "some val"]);
-
-For a list of Redis commands, see [Redis Command Reference](http://redis.io/commands)
-
-The commands can be specified in uppercase or lowercase for convenience. `client.get()` is the same as `client.GET()`.
-
-Minimal parsing is done on the replies. Commands that return a single line reply return JavaScript Strings,
-integer replies return JavaScript Numbers, "bulk" replies return node Buffers, and "multi bulk" replies return a
-JavaScript Array of node Buffers. `HGETALL` returns an Object with Buffers keyed by the hash keys.
-
-# API
-
-## Connection Events
-
-`client` will emit some events about the state of the connection to the Redis server.
-
-### "ready"
-
-`client` will emit `ready` a connection is established to the Redis server and the server reports
-that it is ready to receive commands. Commands issued before the `ready` event are queued,
-then replayed just before this event is emitted.
-
-### "connect"
-
-`client` will emit `connect` at the same time as it emits `ready` unless `client.options.no_ready_check`
-is set. If this options is set, `connect` will be emitted when the stream is connected, and then
-you are free to try to send commands.
-
-### "error"
-
-`client` will emit `error` when encountering an error connecting to the Redis server.
-
-Note that "error" is a special event type in node. If there are no listeners for an
-"error" event, node will exit. This is usually what you want, but it can lead to some
-cryptic error messages like this:
-
- mjr:~/work/node_redis (master)$ node example.js
-
- node.js:50
- throw e;
- ^
- Error: ECONNREFUSED, Connection refused
- at IOWatcher.callback (net:870:22)
- at node.js:607:9
-
-Not very useful in diagnosing the problem, but if your program isn't ready to handle this,
-it is probably the right thing to just exit.
-
-`client` will also emit `error` if an exception is thrown inside of `node_redis` for whatever reason.
-It would be nice to distinguish these two cases.
-
-### "end"
-
-`client` will emit `end` when an established Redis server connection has closed.
-
-### "drain"
-
-`client` will emit `drain` when the TCP connection to the Redis server has been buffering, but is now
-writable. This event can be used to stream commands in to Redis and adapt to backpressure. Right now,
-you need to check `client.command_queue.length` to decide when to reduce your send rate. Then you can
-resume sending when you get `drain`.
-
-### "idle"
+[Join the Redis community](https://redis.com/community/)
-`client` will emit `idle` when there are no outstanding commands that are awaiting a response.
+[Work at Redis](https://redis.com/company/careers/jobs/)
-## redis.createClient(port, host, options)
+## Installation
-Create a new client connection. `port` defaults to `6379` and `host` defaults
-to `127.0.0.1`. If you have `redis-server` running on the same computer as node, then the defaults for
-port and host are probably fine. `options` in an object with the following possible properties:
+Start a redis via docker:
-* `parser`: which Redis protocol reply parser to use. Defaults to `hiredis` if that module is installed.
-This may also be set to `javascript`.
-* `return_buffers`: defaults to `false`. If set to `true`, then all replies will be sent to callbacks as node Buffer
-objects instead of JavaScript Strings.
-* `detect_buffers`: default to `false`. If set to `true`, then replies will be sent to callbacks as node Buffer objects
-if any of the input arguments to the original command were Buffer objects.
-This option lets you switch between Buffers and Strings on a per-command basis, whereas `return_buffers` applies to
-every command on a client.
-* `socket_nodelay`: defaults to `true`. Whether to call setNoDelay() on the TCP stream, which disables the
-Nagle algorithm on the underlying socket. Setting this option to `false` can result in additional throughput at the
-cost of more latency. Most applications will want this set to `true`.
-* `no_ready_check`: defaults to `false`. When a connection is established to the Redis server, the server might still
-be loading the database from disk. While loading, the server not respond to any commands. To work around this,
-`node_redis` has a "ready check" which sends the `INFO` command to the server. The response from the `INFO` command
-indicates whether the server is ready for more commands. When ready, `node_redis` emits a `ready` event.
-Setting `no_ready_check` to `true` will inhibit this check.
+```bash
+docker run -p 6379:6379 -d redis:8.0-rc1
+```
+To install node-redis, simply:
- var redis = require("redis"),
- client = redis.createClient(null, null, {detect_buffers: true});
+```bash
+npm install redis
+```
+> "redis" is the "whole in one" package that includes all the other packages. If you only need a subset of the commands,
+> you can install the individual packages. See the list below.
- client.set("foo_rand000000000000", "OK");
+## Packages
- // This will return a JavaScript String
- client.get("foo_rand000000000000", function (err, reply) {
- console.log(reply.toString()); // Will print `OK`
- });
+| Name | Description |
+| ---------------------------------------------- | ------------------------------------------------------------------------------------------- |
+| [`redis`](https://github.com/redis/node-redis/tree/master/packages/redis) | The client with all the ["redis-stack"](https://github.com/redis-stack/redis-stack) modules |
+| [`@redis/client`](https://github.com/redis/node-redis/tree/master/packages/client) | The base clients (i.e `RedisClient`, `RedisCluster`, etc.) |
+| [`@redis/bloom`](https://github.com/redis/node-redis/tree/master/packages/bloom) | [Redis Bloom](https://redis.io/docs/data-types/probabilistic/) commands |
+| [`@redis/json`](https://github.com/redis/node-redis/tree/master/packages/json) | [Redis JSON](https://redis.io/docs/data-types/json/) commands |
+| [`@redis/search`](https://github.com/redis/node-redis/tree/master/packages/search) | [RediSearch](https://redis.io/docs/interact/search-and-query/) commands |
+| [`@redis/time-series`](https://github.com/redis/node-redis/tree/master/packages/time-series) | [Redis Time-Series](https://redis.io/docs/data-types/timeseries/) commands |
+| [`@redis/entraid`](https://github.com/redis/node-redis/tree/master/packages/entraid) | Secure token-based authentication for Redis clients using Microsoft Entra ID |
- // This will return a Buffer since original key is specified as a Buffer
- client.get(new Buffer("foo_rand000000000000"), function (err, reply) {
- console.log(reply.toString()); // Will print ``
- });
- client.end();
+> Looking for a high-level library to handle object mapping?
+> See [redis-om-node](https://github.com/redis/redis-om-node)!
-`createClient()` returns a `RedisClient` object that is named `client` in all of the examples here.
-## client.auth(password, callback)
-
-When connecting to Redis servers that require authentication, the `AUTH` command must be sent as the
-first command after connecting. This can be tricky to coordinate with reconnections, the ready check,
-etc. To make this easier, `client.auth()` stashes `password` and will send it after each connection,
-including reconnections. `callback` is invoked only once, after the response to the very first
-`AUTH` command sent.
-
-## client.end()
-
-Forcibly close the connection to the Redis server. Note that this does not wait until all replies have been parsed.
-If you want to exit cleanly, call `client.quit()` to send the `QUIT` command after you have handled all replies.
-
-This example closes the connection to the Redis server before the replies have been read. You probably don't
-want to do this:
-
- var redis = require("redis"),
- client = redis.createClient();
-
- client.set("foo_rand000000000000", "some fantastic value");
- client.get("foo_rand000000000000", function (err, reply) {
- console.log(reply.toString());
- });
- client.end();
-
-`client.end()` is useful for timeout cases where something is stuck or taking too long and you want
-to start over.
-
-## Friendlier hash commands
-
-Most Redis commands take a single String or an Array of Strings as arguments, and replies are sent back as a single String or an Array of Strings.
-When dealing with hash values, there are a couple of useful exceptions to this.
-
-### client.hgetall(hash)
-
-The reply from an HGETALL command will be converted into a JavaScript Object by `node_redis`. That way you can interact
-with the responses using JavaScript syntax.
-
-Example:
-
- client.hmset("hosts", "mjr", "1", "another", "23", "home", "1234");
- client.hgetall("hosts", function (err, obj) {
- console.dir(obj);
- });
-
-Output:
-
- { mjr: '1', another: '23', home: '1234' }
-
-### client.hmset(hash, obj, [callback])
-
-Multiple values in a hash can be set by supplying an object:
-
- client.HMSET(key2, {
- "0123456789": "abcdefghij",
- "some manner of key": "a type of value"
- });
-
-The properties and values of this Object will be set as keys and values in the Redis hash.
-
-### client.hmset(hash, key1, val1, ... keyn, valn, [callback])
-
-Multiple values may also be set by supplying a list:
-
- client.HMSET(key1, "0123456789", "abcdefghij", "some manner of key", "a type of value");
-
-
-## Publish / Subscribe
-
-Here is a simple example of the API for publish / subscribe. This program opens two
-client connections, subscribes to a channel on one of them, and publishes to that
-channel on the other:
-
- var redis = require("redis"),
- client1 = redis.createClient(), client2 = redis.createClient(),
- msg_count = 0;
-
- client1.on("subscribe", function (channel, count) {
- client2.publish("a nice channel", "I am sending a message.");
- client2.publish("a nice channel", "I am sending a second message.");
- client2.publish("a nice channel", "I am sending my last message.");
- });
-
- client1.on("message", function (channel, message) {
- console.log("client1 channel " + channel + ": " + message);
- msg_count += 1;
- if (msg_count === 3) {
- client1.unsubscribe();
- client1.end();
- client2.end();
- }
- });
-
- client1.incr("did a thing");
- client1.subscribe("a nice channel");
-
-When a client issues a `SUBSCRIBE` or `PSUBSCRIBE`, that connection is put into "pub/sub" mode.
-At that point, only commands that modify the subscription set are valid. When the subscription
-set is empty, the connection is put back into regular mode.
-
-If you need to send regular commands to Redis while in pub/sub mode, just open another connection.
-
-## Pub / Sub Events
-
-If a client has subscriptions active, it may emit these events:
-
-### "message" (channel, message)
-
-Client will emit `message` for every message received that matches an active subscription.
-Listeners are passed the channel name as `channel` and the message Buffer as `message`.
-
-### "pmessage" (pattern, channel, message)
-
-Client will emit `pmessage` for every message received that matches an active subscription pattern.
-Listeners are passed the original pattern used with `PSUBSCRIBE` as `pattern`, the sending channel
-name as `channel`, and the message Buffer as `message`.
-
-### "subscribe" (channel, count)
-
-Client will emit `subscribe` in response to a `SUBSCRIBE` command. Listeners are passed the
-channel name as `channel` and the new count of subscriptions for this client as `count`.
-
-### "psubscribe" (pattern, count)
-
-Client will emit `psubscribe` in response to a `PSUBSCRIBE` command. Listeners are passed the
-original pattern as `pattern`, and the new count of subscriptions for this client as `count`.
-
-### "unsubscribe" (channel, count)
+## Usage
-Client will emit `unsubscribe` in response to a `UNSUBSCRIBE` command. Listeners are passed the
-channel name as `channel` and the new count of subscriptions for this client as `count`. When
-`count` is 0, this client has left pub/sub mode and no more pub/sub events will be emitted.
+### Basic Example
-### "punsubscribe" (pattern, count)
+```typescript
+import { createClient } from "redis";
-Client will emit `punsubscribe` in response to a `PUNSUBSCRIBE` command. Listeners are passed the
-channel name as `channel` and the new count of subscriptions for this client as `count`. When
-`count` is 0, this client has left pub/sub mode and no more pub/sub events will be emitted.
+const client = await createClient()
+ .on("error", (err) => console.log("Redis Client Error", err))
+ .connect();
-## client.multi([commands])
+await client.set("key", "value");
+const value = await client.get("key");
+client.destroy();
+```
-`MULTI` commands are queued up until an `EXEC` is issued, and then all commands are run atomically by
-Redis. The interface in `node_redis` is to return an individual `Multi` object by calling `client.multi()`.
+The above code connects to localhost on port 6379. To connect to a different host or port, use a connection string in
+the format `redis[s]://[[username][:password]@][host][:port][/db-number]`:
- var redis = require("./index"),
- client = redis.createClient(), set_size = 20;
+```typescript
+createClient({
+ url: "redis://alice:foobared@awesome.redis.server:6380",
+});
+```
- client.sadd("bigset", "a member");
- client.sadd("bigset", "another member");
+You can also use discrete parameters, UNIX sockets, and even TLS to connect. Details can be found in
+the [client configuration guide](https://github.com/redis/node-redis/blob/master/docs/client-configuration.md).
- while (set_size > 0) {
- client.sadd("bigset", "member " + set_size);
- set_size -= 1;
- }
+To check if the the client is connected and ready to send commands, use `client.isReady` which returns a boolean.
+`client.isOpen` is also available. This returns `true` when the client's underlying socket is open, and `false` when it
+isn't (for example when the client is still connecting or reconnecting after a network error).
- // multi chain with an individual callback
- client.multi()
- .scard("bigset")
- .smembers("bigset")
- .keys("*", function (err, replies) {
- client.mget(replies, redis.print);
- })
- .dbsize()
- .exec(function (err, replies) {
- console.log("MULTI got " + replies.length + " replies");
- replies.forEach(function (reply, index) {
- console.log("Reply " + index + ": " + reply.toString());
- });
- });
+### Redis Commands
-`client.multi()` is a constructor that returns a `Multi` object. `Multi` objects share all of the
-same command methods as `client` objects do. Commands are queued up inside the `Multi` object
-until `Multi.exec()` is invoked.
+There is built-in support for all of the [out-of-the-box Redis commands](https://redis.io/commands). They are exposed
+using the raw Redis command names (`HSET`, `HGETALL`, etc.) and a friendlier camel-cased version (`hSet`, `hGetAll`,
+etc.):
-You can either chain together `MULTI` commands as in the above example, or you can queue individual
-commands while still sending regular client command as in this example:
+```typescript
+// raw Redis commands
+await client.HSET("key", "field", "value");
+await client.HGETALL("key");
- var redis = require("redis"),
- client = redis.createClient(), multi;
+// friendly JavaScript commands
+await client.hSet("key", "field", "value");
+await client.hGetAll("key");
+```
- // start a separate multi command queue
- multi = client.multi();
- multi.incr("incr thing", redis.print);
- multi.incr("incr other thing", redis.print);
+Modifiers to commands are specified using a JavaScript object:
- // runs immediately
- client.mset("incr thing", 100, "incr other thing", 1, redis.print);
+```typescript
+await client.set("key", "value", {
+ EX: 10,
+ NX: true,
+});
+```
- // drains multi queue and runs atomically
- multi.exec(function (err, replies) {
- console.log(replies); // 101, 2
- });
+Replies will be transformed into useful data structures:
- // you can re-run the same transaction if you like
- multi.exec(function (err, replies) {
- console.log(replies); // 102, 3
- client.quit();
- });
+```typescript
+await client.hGetAll("key"); // { field1: 'value1', field2: 'value2' }
+await client.hVals("key"); // ['value1', 'value2']
+```
-In addition to adding commands to the `MULTI` queue individually, you can also pass an array
-of commands and arguments to the constructor:
+`Buffer`s are supported as well:
- var redis = require("redis"),
- client = redis.createClient(), multi;
+```typescript
+const client = createClient().withTypeMapping({
+ [RESP_TYPES.BLOB_STRING]: Buffer
+});
- client.multi([
- ["mget", "multifoo", "multibar", redis.print],
- ["incr", "multifoo"],
- ["incr", "multibar"]
- ]).exec(function (err, replies) {
- console.log(replies);
- });
+await client.hSet("key", "field", Buffer.from("value")); // 'OK'
+await client.hGet("key", "field"); // { field: }
+```
-## Monitor mode
+### Unsupported Redis Commands
-Redis supports the `MONITOR` command, which lets you see all commands received by the Redis server
-across all client connections, including from other client libraries and other computers.
+If you want to run commands and/or use arguments that Node Redis doesn't know about (yet!) use `.sendCommand()`:
-After you send the `MONITOR` command, no other commands are valid on that connection. `node_redis`
-will emit a `monitor` event for every new monitor message that comes across. The callback for the
-`monitor` event takes a timestamp from the Redis server and an array of command arguments.
+```typescript
+await client.sendCommand(["SET", "key", "value", "NX"]); // 'OK'
-Here is a simple example:
+await client.sendCommand(["HGETALL", "key"]); // ['key1', 'field1', 'key2', 'field2']
+```
- var client = require("redis").createClient(),
- util = require("util");
+_Note: the [API is different when using a cluster](https://github.com/redis/node-redis/blob/master/docs/clustering.md#unsupported-redis-commands)._
- client.monitor(function (err, res) {
- console.log("Entering monitoring mode.");
- });
+### Transactions (Multi/Exec)
- client.on("monitor", function (time, args) {
- console.log(time + ": " + util.inspect(args));
- });
+Start a [transaction](https://redis.io/topics/transactions) by calling `.multi()`, then chaining your commands. When
+you're done, call `.exec()` and you'll get an array back with your results:
+```typescript
+await client.set("another-key", "another-value");
-# Extras
+const [setKeyReply, otherKeyValue] = await client
+ .multi()
+ .set("key", "value")
+ .get("another-key")
+ .exec(); // ['OK', 'another-value']
+```
-Some other things you might like to know about.
+You can also [watch](https://redis.io/topics/transactions#optimistic-locking-using-check-and-set) keys by calling
+`.watch()`. Your transaction will abort if any of the watched keys change.
-## client.server_info
-After the ready probe completes, the results from the INFO command are saved in the `client.server_info`
-object.
+### Blocking Commands
-The `versions` key contains an array of the elements of the version string for easy comparison.
+In v4, `RedisClient` had the ability to create a pool of connections using an "Isolation Pool" on top of the "main"
+connection. However, there was no way to use the pool without a "main" connection:
- > client.server_info.redis_version
- '2.3.0'
- > client.server_info.versions
- [ 2, 3, 0 ]
+```javascript
+const client = await createClient()
+ .on("error", (err) => console.error(err))
+ .connect();
-## redis.print()
+await client.ping(client.commandOptions({ isolated: true }));
+```
-A handy callback function for displaying return values when testing. Example:
+In v5 we've extracted this pool logic into its own classβ`RedisClientPool`:
- var redis = require("redis"),
- client = redis.createClient();
+```javascript
+const pool = await createClientPool()
+ .on("error", (err) => console.error(err))
+ .connect();
- client.on("connect", function () {
- client.set("foo_rand000000000000", "some fantastic value", redis.print);
- client.get("foo_rand000000000000", redis.print);
- });
+await pool.ping();
+```
-This will print:
- Reply: OK
- Reply: some fantastic value
+### Pub/Sub
-Note that this program will not exit cleanly because the client is still connected.
+See the [Pub/Sub overview](https://github.com/redis/node-redis/blob/master/docs/pub-sub.md).
-## redis.debug_mode
+### Scan Iterator
-Boolean to enable debug mode and protocol tracing.
+[`SCAN`](https://redis.io/commands/scan) results can be looped over
+using [async iterators](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/asyncIterator):
- var redis = require("redis"),
- client = redis.createClient();
+```typescript
+for await (const keys of client.scanIterator()) {
+ console.log(keys, await client.mGet(keys));
+}
+```
- redis.debug_mode = true;
+This works with `HSCAN`, `SSCAN`, and `ZSCAN` too:
- client.on("connect", function () {
- client.set("foo_rand000000000000", "some fantastic value");
- });
+```typescript
+for await (const { field, value } of client.hScanIterator("hash")) {
+}
+for await (const member of client.sScanIterator("set")) {
+}
+for await (const { score, value } of client.zScanIterator("sorted-set")) {
+}
+```
-This will display:
+You can override the default options by providing a configuration object:
- mjr:~/work/node_redis (master)$ node ~/example.js
- send command: *3
- $3
- SET
- $20
- foo_rand000000000000
- $20
- some fantastic value
+```typescript
+client.scanIterator({
+ TYPE: "string", // `SCAN` only
+ MATCH: "patter*",
+ COUNT: 100,
+});
+```
- on_data: +OK
+### Disconnecting
-`send command` is data sent into Redis and `on_data` is data received from Redis.
+The `QUIT` command has been deprecated in Redis 7.2 and should now also be considered deprecated in Node-Redis. Instead
+of sending a `QUIT` command to the server, the client can simply close the network connection.
-## client.send_command(command_name, args, callback)
+`client.QUIT/quit()` is replaced by `client.close()`. and, to avoid confusion, `client.disconnect()` has been renamed to
+`client.destroy()`.
-Used internally to send commands to Redis. For convenience, nearly all commands that are published on the Redis
-Wiki have been added to the `client` object. However, if I missed any, or if new commands are introduced before
-this library is updated, you can use `send_command()` to send arbitrary commands to Redis.
+```typescript
+client.destroy();
+```
+### Client Side Caching
-All commands are sent as multi-bulk commands. `args` can either be an Array of arguments, or individual arguments,
-or omitted completely.
+Node Redis v5 adds support for [Client Side Caching](https://redis.io/docs/manual/client-side-caching/), which enables clients to cache query results locally. The Redis server will notify the client when cached results are no longer valid.
-## client.connected
+```typescript
+// Enable client side caching with RESP3
+const client = createClient({
+ RESP: 3,
+ clientSideCache: {
+ ttl: 0, // Time-to-live (0 = no expiration)
+ maxEntries: 0, // Maximum entries (0 = unlimited)
+ evictPolicy: "LRU" // Eviction policy: "LRU" or "FIFO"
+ }
+});
+```
-Boolean tracking the state of the connection to the Redis server.
+See the [V5 documentation](https://github.com/redis/node-redis/blob/master/docs/v5.md#client-side-caching) for more details and advanced usage.
-## client.command_queue.length
+### Auto-Pipelining
-The number of commands that have been sent to the Redis server but not yet replied to. You can use this to
-enforce some kind of maximum queue depth for commands while connected.
+Node Redis will automatically pipeline requests that are made during the same "tick".
-Don't mess with `client.command_queue` though unless you really know what you are doing.
+```typescript
+client.set("Tm9kZSBSZWRpcw==", "users:1");
+client.sAdd("users:1:tokens", "Tm9kZSBSZWRpcw==");
+```
-## client.offline_queue.length
+Of course, if you don't do something with your Promises you're certain to
+get [unhandled Promise exceptions](https://nodejs.org/api/process.html#process_event_unhandledrejection). To take
+advantage of auto-pipelining and handle your Promises, use `Promise.all()`.
-The number of commands that have been queued up for a future connection. You can use this to enforce
-some kind of maximum queue depth for pre-connection commands.
+```typescript
+await Promise.all([
+ client.set("Tm9kZSBSZWRpcw==", "users:1"),
+ client.sAdd("users:1:tokens", "Tm9kZSBSZWRpcw=="),
+]);
+```
-## client.retry_delay
+### Programmability
-Current delay in milliseconds before a connection retry will be attempted. This starts at `250`.
+See the [Programmability overview](https://github.com/redis/node-redis/blob/master/docs/programmability.md).
-## client.retry_backoff
+### Clustering
-Multiplier for future retry timeouts. This should be larger than 1 to add more time between retries.
-Defaults to 1.7. The default initial connection retry is 250, so the second retry will be 425, followed by 723.5, etc.
+Check out the [Clustering Guide](https://github.com/redis/node-redis/blob/master/docs/clustering.md) when using Node Redis to connect to a Redis Cluster.
+### Events
-## TODO
+The Node Redis client class is an Nodejs EventEmitter and it emits an event each time the network status changes:
-Better tests for auth, disconnect/reconnect, and all combinations thereof.
+| Name | When | Listener arguments |
+| ----------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------- |
+| `connect` | Initiating a connection to the server | _No arguments_ |
+| `ready` | Client is ready to use | _No arguments_ |
+| `end` | Connection has been closed (via `.disconnect()`) | _No arguments_ |
+| `error` | An error has occurredβusually a network issue such as "Socket closed unexpectedly" | `(error: Error)` |
+| `reconnecting` | Client is trying to reconnect to the server | _No arguments_ |
+| `sharded-channel-moved` | See [here](https://github.com/redis/node-redis/blob/master/docs/pub-sub.md#sharded-channel-moved-event) | See [here](https://github.com/redis/node-redis/blob/master/docs/pub-sub.md#sharded-channel-moved-event) |
+| `invalidate` | Client Tracking is on with `emitInvalidate` and a key is invalidated | `(key: RedisItem \| null)` |
-Stream large set/get values into and out of Redis. Otherwise the entire value must be in node's memory.
+> :warning: You **MUST** listen to `error` events. If a client doesn't have at least one `error` listener registered and
+> an `error` occurs, that error will be thrown and the Node.js process will exit. See the [ > `EventEmitter` docs](https://nodejs.org/api/events.html#events_error_events) for more details.
-Performance can be better for very large values.
+> The client will not emit [any other events](https://github.com/redis/node-redis/blob/master/docs/v3-to-v4.md#all-the-removed-events) beyond those listed above.
-I think there are more performance improvements left in there for smaller values, especially for large lists of small values.
+## Supported Redis versions
-## Contributors
+Node Redis is supported with the following versions of Redis:
-Some people have have added features and fixed bugs in `node_redis` other than me.
+| Version | Supported |
+| ------- | ------------------ |
+| 8.2.z | :heavy_check_mark: |
+| 8.0.z | :heavy_check_mark: |
+| 7.4.z | :heavy_check_mark: |
+| 7.2.z | :heavy_check_mark: |
+| < 7.2 | :x: |
-In order of first contribution, they are:
+> Node Redis should work with older versions of Redis, but it is not fully tested and we cannot offer support.
-* [Tim Smart](https://github.com/Tim-Smart)
-* [TJ Holowaychuk](https://github.com/visionmedia)
-* [Rick Olson](https://github.com/technoweenie)
-* [Orion Henry](https://github.com/orionz)
-* [Hank Sims](https://github.com/hanksims)
-* [Aivo Paas](https://github.com/aivopaas)
-* [Paul Carey](https://github.com/paulcarey)
-* [Pieter Noordhuis](https://github.com/pietern)
-* [Vladimir Dronnikov](https://github.com/dvv)
-* [Dave Hoover](https://github.com/redsquirrel)
+## Migration
-Thanks.
+- [From V3 to V4](https://github.com/redis/node-redis/blob/master/docs/v3-to-v4.md)
+- [From V4 to V5](https://github.com/redis/node-redis/blob/master/docs/v4-to-v5.md)
+- [V5](https://github.com/redis/node-redis/blob/master/docs/v5.md)
-## LICENSE - "MIT License"
+## Contributing
-Copyright (c) 2010 Matthew Ranney, http://ranney.com/
+If you'd like to contribute, check out the [contributing guide](https://github.com/redis/node-redis/blob/master/CONTRIBUTING.md).
-Permission is hereby granted, free of charge, to any person
-obtaining a copy of this software and associated documentation
-files (the "Software"), to deal in the Software without
-restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following
-conditions:
+Thank you to all the people who already contributed to Node Redis!
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+[](https://github.com/redis/node-redis/graphs/contributors)
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
+## License
-
+This repository is licensed under the "MIT" license. See [LICENSE](https://github.com/redis/node-redis/blob/master/LICENSE).
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 00000000000..f96aa68dc12
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,16 @@
+# Security Policy
+
+## Supported Versions
+
+Node Redis is generally backwards compatible with very few exceptions, so we recommend users to always use the latest version to experience stability, performance and security.
+
+| Version | Supported |
+|---------|--------------------|
+| 4.0.z | :heavy_check_mark: |
+| 3.1.z | :heavy_check_mark: |
+| < 3.1 | :x: |
+
+## Reporting a Vulnerability
+
+If you believe youβve discovered a serious vulnerability, please contact the Node Redis core team at redis@redis.io. We will evaluate your report and if necessary issue a fix and an advisory. If the issue was previously undisclosed,
+weβll also mention your name in the credits.
diff --git a/benchmark/.gitignore b/benchmark/.gitignore
new file mode 100644
index 00000000000..e493e278fc7
--- /dev/null
+++ b/benchmark/.gitignore
@@ -0,0 +1 @@
+*.js.json
diff --git a/benchmark/lib/defaults.yml b/benchmark/lib/defaults.yml
new file mode 100644
index 00000000000..3fa0f04614c
--- /dev/null
+++ b/benchmark/lib/defaults.yml
@@ -0,0 +1,32 @@
+version: 0.1
+
+remote:
+ - type: oss-standalone
+ - setup: redis-small
+
+setups:
+ - oss-standalone
+
+spec:
+ setups:
+ - name: oss-standalone
+ type: oss-standalone
+ redis_topology:
+ primaries: 1
+ replicas: 0
+ resources:
+ requests:
+ cpus: "1"
+ memory: "10g"
+
+exporter:
+ output_path: "./*.js.json"
+ redistimeseries:
+ timemetric: "$.timestamp"
+ metrics:
+ - "$.p0"
+ - "$.p50"
+ - "$.p95"
+ - "$.p99"
+ - "$.p100"
+ - "$.operationsPerSecond"
\ No newline at end of file
diff --git a/benchmark/lib/index.js b/benchmark/lib/index.js
new file mode 100644
index 00000000000..5576999bfbc
--- /dev/null
+++ b/benchmark/lib/index.js
@@ -0,0 +1,66 @@
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { promises as fs } from 'node:fs';
+import { fork } from 'node:child_process';
+import { URL, fileURLToPath } from 'node:url';
+import { once } from 'node:events';
+import { extname } from 'node:path';
+
+async function getPathChoices() {
+ const dirents = await fs.readdir(new URL('.', import.meta.url), {
+ withFileTypes: true
+ });
+
+ const choices = [];
+ for (const dirent of dirents) {
+ if (!dirent.isDirectory()) continue;
+
+ choices.push(dirent.name);
+ }
+
+ return choices;
+}
+
+const argv = hideBin(process.argv);
+
+async function getName() {
+ return yargs(argv)
+ .option('name', {
+ demandOption: true,
+ choices: await getPathChoices()
+ })
+ .parseSync().name;
+}
+
+const runnerPath = fileURLToPath(new URL('runner.js', import.meta.url)),
+ path = new URL(`${await getName()}/`, import.meta.url);
+
+async function getMetadata() {
+ try {
+ return await import(new URL('index.js', path));
+ } catch (err) {
+ if (err.code === 'ERR_MODULE_NOT_FOUND') return;
+
+ throw err;
+ }
+}
+
+const metadata = await getMetadata(),
+ timestamp = Date.now();
+
+for (const file of await fs.readdir(path)) {
+ if (file === 'index.js' || extname(file) !== '.js') continue;
+
+ const benchmarkProcess = fork(runnerPath, [
+ ...argv,
+ '--path',
+ fileURLToPath(path) + file
+ ]);
+
+ await once(benchmarkProcess, 'message');
+ benchmarkProcess.send({
+ metadata,
+ timestamp
+ });
+ await once(benchmarkProcess, 'close');
+}
diff --git a/benchmark/lib/ping/ioredis-auto-pipeline.js b/benchmark/lib/ping/ioredis-auto-pipeline.js
new file mode 100644
index 00000000000..ee400fe6ca9
--- /dev/null
+++ b/benchmark/lib/ping/ioredis-auto-pipeline.js
@@ -0,0 +1,20 @@
+import Redis from 'ioredis';
+
+export default async (host) => {
+ const client = new Redis({
+ host,
+ lazyConnect: true,
+ enableAutoPipelining: true
+ });
+
+ await client.connect();
+
+ return {
+ benchmark() {
+ return client.ping();
+ },
+ teardown() {
+ return client.disconnect();
+ }
+ }
+};
diff --git a/benchmark/lib/ping/ioredis.js b/benchmark/lib/ping/ioredis.js
new file mode 100644
index 00000000000..5ed0d1dd76b
--- /dev/null
+++ b/benchmark/lib/ping/ioredis.js
@@ -0,0 +1,19 @@
+import Redis from 'ioredis';
+
+export default async (host) => {
+ const client = new Redis({
+ host,
+ lazyConnect: true
+ });
+
+ await client.connect();
+
+ return {
+ benchmark() {
+ return client.ping();
+ },
+ teardown() {
+ return client.disconnect();
+ }
+ }
+};
diff --git a/benchmark/lib/ping/local-resp2.js b/benchmark/lib/ping/local-resp2.js
new file mode 100644
index 00000000000..873698a131f
--- /dev/null
+++ b/benchmark/lib/ping/local-resp2.js
@@ -0,0 +1,21 @@
+import { createClient } from 'redis-local';
+
+export default async (host) => {
+ const client = createClient({
+ socket: {
+ host
+ },
+ RESP: 2
+ });
+
+ await client.connect();
+
+ return {
+ benchmark() {
+ return client.ping();
+ },
+ teardown() {
+ return client.disconnect();
+ }
+ };
+};
diff --git a/benchmark/lib/ping/local-resp3-buffer-proxy.js b/benchmark/lib/ping/local-resp3-buffer-proxy.js
new file mode 100644
index 00000000000..2ded38b21ca
--- /dev/null
+++ b/benchmark/lib/ping/local-resp3-buffer-proxy.js
@@ -0,0 +1,23 @@
+import { createClient, RESP_TYPES } from 'redis-local';
+
+export default async (host) => {
+ const client = createClient({
+ socket: {
+ host
+ },
+ RESP: 3
+ }).withTypeMapping({
+ [RESP_TYPES.SIMPLE_STRING]: Buffer
+ });
+
+ await client.connect();
+
+ return {
+ benchmark() {
+ return client.ping();
+ },
+ teardown() {
+ return client.disconnect();
+ }
+ };
+};
diff --git a/benchmark/lib/ping/local-resp3-buffer.js b/benchmark/lib/ping/local-resp3-buffer.js
new file mode 100644
index 00000000000..624a524ce06
--- /dev/null
+++ b/benchmark/lib/ping/local-resp3-buffer.js
@@ -0,0 +1,24 @@
+import { createClient, RESP_TYPES } from 'redis-local';
+
+export default async (host) => {
+ const client = createClient({
+ socket: {
+ host
+ },
+ commandOptions: {
+ [RESP_TYPES.SIMPLE_STRING]: Buffer
+ },
+ RESP: 3
+ });
+
+ await client.connect();
+
+ return {
+ benchmark() {
+ return client.ping();
+ },
+ teardown() {
+ return client.disconnect();
+ }
+ };
+};
diff --git a/benchmark/lib/ping/local-resp3-module-with-flags.js b/benchmark/lib/ping/local-resp3-module-with-flags.js
new file mode 100644
index 00000000000..e58856dcb9e
--- /dev/null
+++ b/benchmark/lib/ping/local-resp3-module-with-flags.js
@@ -0,0 +1,27 @@
+import { createClient } from 'redis-local';
+import PING from 'redis-local/dist/lib/commands/PING.js';
+
+export default async (host) => {
+ const client = createClient({
+ socket: {
+ host
+ },
+ RESP: 3,
+ modules: {
+ module: {
+ ping: PING.default
+ }
+ }
+ });
+
+ await client.connect();
+
+ return {
+ benchmark() {
+ return client.withTypeMapping({}).module.ping();
+ },
+ teardown() {
+ return client.disconnect();
+ }
+ };
+};
diff --git a/benchmark/lib/ping/local-resp3-module.js b/benchmark/lib/ping/local-resp3-module.js
new file mode 100644
index 00000000000..66f6e3ec291
--- /dev/null
+++ b/benchmark/lib/ping/local-resp3-module.js
@@ -0,0 +1,27 @@
+import { createClient } from 'redis-local';
+import PING from 'redis-local/dist/lib/commands/PING.js';
+
+export default async (host) => {
+ const client = createClient({
+ socket: {
+ host
+ },
+ RESP: 3,
+ modules: {
+ module: {
+ ping: PING.default
+ }
+ }
+ });
+
+ await client.connect();
+
+ return {
+ benchmark() {
+ return client.module.ping();
+ },
+ teardown() {
+ return client.disconnect();
+ }
+ };
+};
diff --git a/benchmark/lib/ping/local-resp3.js b/benchmark/lib/ping/local-resp3.js
new file mode 100644
index 00000000000..a4ee4f24a2a
--- /dev/null
+++ b/benchmark/lib/ping/local-resp3.js
@@ -0,0 +1,21 @@
+import { createClient } from 'redis-local';
+
+export default async (host) => {
+ const client = createClient({
+ socket: {
+ host
+ },
+ RESP: 3
+ });
+
+ await client.connect();
+
+ return {
+ benchmark() {
+ return client.ping();
+ },
+ teardown() {
+ return client.disconnect();
+ }
+ };
+};
diff --git a/benchmark/lib/ping/ping.yml b/benchmark/lib/ping/ping.yml
new file mode 100644
index 00000000000..cfe3c74735a
--- /dev/null
+++ b/benchmark/lib/ping/ping.yml
@@ -0,0 +1,9 @@
+name: "ping"
+
+clientconfig:
+ - command: |
+ npm install -ws
+ npm run build:tests-tools
+ cd benchmark
+ npm install
+ npm run start -- --name ping --redis-server-host ${server_private_ip}
diff --git a/benchmark/lib/ping/v3.js b/benchmark/lib/ping/v3.js
new file mode 100644
index 00000000000..e7e62d3e15a
--- /dev/null
+++ b/benchmark/lib/ping/v3.js
@@ -0,0 +1,21 @@
+import { createClient } from 'redis-v3';
+import { once } from 'node:events';
+import { promisify } from 'node:util';
+
+export default async (host) => {
+ const client = createClient({ host }),
+ pingAsync = promisify(client.ping).bind(client),
+ quitAsync = promisify(client.quit).bind(client);
+
+ await once(client, 'connect');
+
+ return {
+ benchmark() {
+ return pingAsync();
+ },
+ teardown() {
+ return quitAsync();
+ }
+ };
+
+};
diff --git a/benchmark/lib/ping/v4.js b/benchmark/lib/ping/v4.js
new file mode 100644
index 00000000000..c570aa1477f
--- /dev/null
+++ b/benchmark/lib/ping/v4.js
@@ -0,0 +1,20 @@
+import { createClient } from 'redis-v4';
+
+export default async (host) => {
+ const client = createClient({
+ socket: {
+ host
+ }
+ });
+
+ await client.connect();
+
+ return {
+ benchmark() {
+ return client.ping();
+ },
+ teardown() {
+ return client.disconnect();
+ }
+ };
+};
diff --git a/benchmark/lib/runner.js b/benchmark/lib/runner.js
new file mode 100644
index 00000000000..7d81d3bb8c7
--- /dev/null
+++ b/benchmark/lib/runner.js
@@ -0,0 +1,86 @@
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { basename } from 'node:path';
+import { promises as fs } from 'node:fs';
+import * as hdr from 'hdr-histogram-js';
+hdr.initWebAssemblySync();
+
+const { path, times, concurrency, 'redis-server-host': host } = yargs(hideBin(process.argv))
+ .option('path', {
+ type: 'string',
+ demandOption: true
+ })
+ .option('times', {
+ type: 'number',
+ default: 1_000_000,
+ demandOption: true
+ })
+ .option('concurrency', {
+ type: 'number',
+ default: 100,
+ demandOption: true
+ })
+ .option('redis-server-host', {
+ type: 'string'
+ })
+ .parseSync();
+
+const [ { metadata, timestamp }, module ] = await Promise.all([
+ new Promise(resolve => {
+ process.once('message', resolve);
+ process.send('ready');
+ }),
+ import(path)
+ ]),
+ { benchmark, teardown } = await module.default(host, metadata);
+
+async function run(times) {
+ return new Promise(resolve => {
+ const histogram = hdr.build({ useWebAssembly: true });
+ let num = 0,
+ inProgress = 0;
+
+ async function run() {
+ ++inProgress;
+ ++num;
+
+ const start = process.hrtime.bigint();
+ await benchmark(metadata);
+ histogram.recordValue(Number(process.hrtime.bigint() - start));
+ --inProgress;
+
+ if (num < times) {
+ run();
+ } else if (inProgress === 0) {
+ resolve(histogram);
+ }
+ }
+
+ const toInitiate = Math.min(concurrency, times);
+ for (let i = 0; i < toInitiate; i++) {
+ run();
+ }
+ });
+}
+
+// warmup
+await run(Math.min(times * 0.1, 10_000));
+
+// benchmark
+const benchmarkStart = process.hrtime.bigint(),
+ histogram = await run(times),
+ benchmarkNanoseconds = process.hrtime.bigint() - benchmarkStart,
+ json = {
+ // timestamp,
+ operationsPerSecond: times / Number(benchmarkNanoseconds) * 1_000_000_000,
+ p0: histogram.getValueAtPercentile(0),
+ p50: histogram.getValueAtPercentile(50),
+ p95: histogram.getValueAtPercentile(95),
+ p99: histogram.getValueAtPercentile(99),
+ p100: histogram.getValueAtPercentile(100)
+ };
+console.log(`[${basename(path)}]:`);
+console.table(json);
+await fs.writeFile(`${path}.json`, JSON.stringify(json));
+
+await teardown();
diff --git a/benchmark/lib/set-get-delete-string/1KB.yml b/benchmark/lib/set-get-delete-string/1KB.yml
new file mode 100644
index 00000000000..52fb611a24b
--- /dev/null
+++ b/benchmark/lib/set-get-delete-string/1KB.yml
@@ -0,0 +1,9 @@
+name: "set-get-delete-string-1KB"
+
+clientconfig:
+ - command: |
+ npm install -ws
+ npm run build:tests-tools
+ cd benchmark
+ npm install
+ npm run start -- --name set-get-delete-string --size 1024 --redis-server-host ${server_private_ip}
diff --git a/benchmark/lib/set-get-delete-string/1MB.yml b/benchmark/lib/set-get-delete-string/1MB.yml
new file mode 100644
index 00000000000..f16d7c3696a
--- /dev/null
+++ b/benchmark/lib/set-get-delete-string/1MB.yml
@@ -0,0 +1,9 @@
+name: "set-get-delete-string-1MB"
+
+clientconfig:
+ - command: |
+ npm install -ws
+ npm run build:tests-tools
+ cd benchmark
+ npm install
+ npm run start -- --name set-get-delete-string --size 1048576 --redis-server-host ${server_private_ip}
diff --git a/benchmark/lib/set-get-delete-string/8B.yml b/benchmark/lib/set-get-delete-string/8B.yml
new file mode 100644
index 00000000000..f625f74fca1
--- /dev/null
+++ b/benchmark/lib/set-get-delete-string/8B.yml
@@ -0,0 +1,9 @@
+name: "set-get-delete-string-8B"
+
+clientconfig:
+ - command: |
+ npm install -ws
+ npm run build:tests-tools
+ cd benchmark
+ npm install
+ npm run start -- --name set-get-delete-string --size 8 --redis-server-host ${server_private_ip}
diff --git a/benchmark/lib/set-get-delete-string/index.js b/benchmark/lib/set-get-delete-string/index.js
new file mode 100644
index 00000000000..506b222a6cb
--- /dev/null
+++ b/benchmark/lib/set-get-delete-string/index.js
@@ -0,0 +1,13 @@
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { randomBytes } from 'node:crypto';
+
+const { size } = yargs(hideBin(process.argv))
+ .option('size', {
+ type: 'number',
+ default: 1024,
+ demandOption: true
+ })
+ .parseSync();
+
+export const randomString = randomBytes(size).toString('ascii');
diff --git a/benchmark/lib/set-get-delete-string/ioredis.js b/benchmark/lib/set-get-delete-string/ioredis.js
new file mode 100644
index 00000000000..95456233001
--- /dev/null
+++ b/benchmark/lib/set-get-delete-string/ioredis.js
@@ -0,0 +1,23 @@
+import Redis from 'ioredis';
+
+export default async (host, { randomString }) => {
+ const client = new Redis({
+ host,
+ lazyConnect: true
+ });
+
+ await client.connect();
+
+ return {
+ benchmark() {
+ return Promise.all([
+ client.set(randomString, randomString),
+ client.get(randomString),
+ client.del(randomString)
+ ]);
+ },
+ teardown() {
+ return client.disconnect();
+ }
+ }
+};
diff --git a/benchmark/lib/set-get-delete-string/v3.js b/benchmark/lib/set-get-delete-string/v3.js
new file mode 100644
index 00000000000..1e2122a0e49
--- /dev/null
+++ b/benchmark/lib/set-get-delete-string/v3.js
@@ -0,0 +1,27 @@
+import { createClient } from 'redis-v3';
+import { once } from 'node:events';
+import { promisify } from 'node:util';
+
+export default async (host, { randomString }) => {
+ const client = createClient({ host }),
+ setAsync = promisify(client.set).bind(client),
+ getAsync = promisify(client.get).bind(client),
+ delAsync = promisify(client.del).bind(client),
+ quitAsync = promisify(client.quit).bind(client);
+
+ await once(client, 'connect');
+
+ return {
+ benchmark() {
+ return Promise.all([
+ setAsync(randomString, randomString),
+ getAsync(randomString),
+ delAsync(randomString)
+ ]);
+ },
+ teardown() {
+ return quitAsync();
+ }
+ };
+
+};
diff --git a/benchmark/lib/set-get-delete-string/v4.js b/benchmark/lib/set-get-delete-string/v4.js
new file mode 100644
index 00000000000..dd06b1f1036
--- /dev/null
+++ b/benchmark/lib/set-get-delete-string/v4.js
@@ -0,0 +1,24 @@
+import { createClient } from '@redis/client';
+
+export default async (host, { randomString }) => {
+ const client = createClient({
+ socket: {
+ host
+ }
+ });
+
+ await client.connect();
+
+ return {
+ benchmark() {
+ return Promise.all([
+ client.set(randomString, randomString),
+ client.get(randomString),
+ client.del(randomString)
+ ]);
+ },
+ teardown() {
+ return client.disconnect();
+ }
+ };
+};
diff --git a/benchmark/package-lock.json b/benchmark/package-lock.json
new file mode 100644
index 00000000000..30114847134
--- /dev/null
+++ b/benchmark/package-lock.json
@@ -0,0 +1,446 @@
+{
+ "name": "@redis/client-benchmark",
+ "lockfileVersion": 3,
+ "requires": true,
+ "packages": {
+ "": {
+ "name": "@redis/client-benchmark",
+ "dependencies": {
+ "hdr-histogram-js": "3.0.0",
+ "ioredis": "5",
+ "redis-local": "file:../packages/client",
+ "redis-v3": "npm:redis@3",
+ "redis-v4": "npm:redis@4",
+ "yargs": "17.7.1"
+ }
+ },
+ "node_modules/@assemblyscript/loader": {
+ "version": "0.19.23",
+ "resolved": "https://registry.npmjs.org/@assemblyscript/loader/-/loader-0.19.23.tgz",
+ "integrity": "sha512-ulkCYfFbYj01ie1MDOyxv2F6SpRN1TOj7fQxbP07D6HmeR+gr2JLSmINKjga2emB+b1L2KGrFKBTc+e00p54nw=="
+ },
+ "node_modules/@ioredis/commands": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/@ioredis/commands/-/commands-1.2.0.tgz",
+ "integrity": "sha512-Sx1pU8EM64o2BrqNpEO1CNLtKQwyhuXuqyfH7oGKCk+1a33d2r5saW8zNwm3j6BTExtjrv2BxTgzzkMwts6vGg=="
+ },
+ "node_modules/@redis/bloom": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/@redis/bloom/-/bloom-1.2.0.tgz",
+ "integrity": "sha512-HG2DFjYKbpNmVXsa0keLHp/3leGJz1mjh09f2RLGGLQZzSHpkmZWuwJbAvo3QcRY8p80m5+ZdXZdYOSBLlp7Cg==",
+ "peerDependencies": {
+ "@redis/client": "^1.0.0"
+ }
+ },
+ "node_modules/@redis/client": {
+ "version": "1.5.7",
+ "resolved": "https://registry.npmjs.org/@redis/client/-/client-1.5.7.tgz",
+ "integrity": "sha512-gaOBOuJPjK5fGtxSseaKgSvjiZXQCdLlGg9WYQst+/GRUjmXaiB5kVkeQMRtPc7Q2t93XZcJfBMSwzs/XS9UZw==",
+ "dependencies": {
+ "cluster-key-slot": "1.1.2",
+ "generic-pool": "3.9.0",
+ "yallist": "4.0.0"
+ },
+ "engines": {
+ "node": ">=14"
+ }
+ },
+ "node_modules/@redis/graph": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/@redis/graph/-/graph-1.1.0.tgz",
+ "integrity": "sha512-16yZWngxyXPd+MJxeSr0dqh2AIOi8j9yXKcKCwVaKDbH3HTuETpDVPcLujhFYVPtYrngSco31BUcSa9TH31Gqg==",
+ "peerDependencies": {
+ "@redis/client": "^1.0.0"
+ }
+ },
+ "node_modules/@redis/json": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/@redis/json/-/json-1.0.4.tgz",
+ "integrity": "sha512-LUZE2Gdrhg0Rx7AN+cZkb1e6HjoSKaeeW8rYnt89Tly13GBI5eP4CwDVr+MY8BAYfCg4/N15OUrtLoona9uSgw==",
+ "peerDependencies": {
+ "@redis/client": "^1.0.0"
+ }
+ },
+ "node_modules/@redis/search": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/@redis/search/-/search-1.1.2.tgz",
+ "integrity": "sha512-/cMfstG/fOh/SsE+4/BQGeuH/JJloeWuH+qJzM8dbxuWvdWibWAOAHHCZTMPhV3xIlH4/cUEIA8OV5QnYpaVoA==",
+ "peerDependencies": {
+ "@redis/client": "^1.0.0"
+ }
+ },
+ "node_modules/@redis/time-series": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/@redis/time-series/-/time-series-1.0.4.tgz",
+ "integrity": "sha512-ThUIgo2U/g7cCuZavucQTQzA9g9JbDDY2f64u3AbAoz/8vE2lt2U37LamDUVChhaDA3IRT9R6VvJwqnUfTJzng==",
+ "peerDependencies": {
+ "@redis/client": "^1.0.0"
+ }
+ },
+ "node_modules/ansi-regex": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
+ "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/ansi-styles": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
+ "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
+ "dependencies": {
+ "color-convert": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/ansi-styles?sponsor=1"
+ }
+ },
+ "node_modules/base64-js": {
+ "version": "1.5.1",
+ "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz",
+ "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ]
+ },
+ "node_modules/cliui": {
+ "version": "8.0.1",
+ "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz",
+ "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==",
+ "dependencies": {
+ "string-width": "^4.2.0",
+ "strip-ansi": "^6.0.1",
+ "wrap-ansi": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/cluster-key-slot": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/cluster-key-slot/-/cluster-key-slot-1.1.2.tgz",
+ "integrity": "sha512-RMr0FhtfXemyinomL4hrWcYJxmX6deFdCxpJzhDttxgO1+bcCnkk+9drydLVDmAMG7NE6aN/fl4F7ucU/90gAA==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/color-convert": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
+ "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
+ "dependencies": {
+ "color-name": "~1.1.4"
+ },
+ "engines": {
+ "node": ">=7.0.0"
+ }
+ },
+ "node_modules/color-name": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
+ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
+ },
+ "node_modules/debug": {
+ "version": "4.3.4",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.4.tgz",
+ "integrity": "sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==",
+ "dependencies": {
+ "ms": "2.1.2"
+ },
+ "engines": {
+ "node": ">=6.0"
+ },
+ "peerDependenciesMeta": {
+ "supports-color": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/denque": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/denque/-/denque-2.1.0.tgz",
+ "integrity": "sha512-HVQE3AAb/pxF8fQAoiqpvg9i3evqug3hoiwakOyZAwJm+6vZehbkYXZ0l4JxS+I3QxM97v5aaRNhj8v5oBhekw==",
+ "engines": {
+ "node": ">=0.10"
+ }
+ },
+ "node_modules/emoji-regex": {
+ "version": "8.0.0",
+ "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
+ "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A=="
+ },
+ "node_modules/escalade": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz",
+ "integrity": "sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/generic-pool": {
+ "version": "3.9.0",
+ "resolved": "https://registry.npmjs.org/generic-pool/-/generic-pool-3.9.0.tgz",
+ "integrity": "sha512-hymDOu5B53XvN4QT9dBmZxPX4CWhBPPLguTZ9MMFeFa/Kg0xWVfylOVNlJji/E7yTZWFd/q9GO5TxDLq156D7g==",
+ "engines": {
+ "node": ">= 4"
+ }
+ },
+ "node_modules/get-caller-file": {
+ "version": "2.0.5",
+ "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz",
+ "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==",
+ "engines": {
+ "node": "6.* || 8.* || >= 10.*"
+ }
+ },
+ "node_modules/hdr-histogram-js": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/hdr-histogram-js/-/hdr-histogram-js-3.0.0.tgz",
+ "integrity": "sha512-/EpvQI2/Z98mNFYEnlqJ8Ogful8OpArLG/6Tf2bPnkutBVLIeMVNHjk1ZDfshF2BUweipzbk+dB1hgSB7SIakw==",
+ "dependencies": {
+ "@assemblyscript/loader": "^0.19.21",
+ "base64-js": "^1.2.0",
+ "pako": "^1.0.3"
+ },
+ "engines": {
+ "node": ">=14"
+ }
+ },
+ "node_modules/ioredis": {
+ "version": "5.3.2",
+ "resolved": "https://registry.npmjs.org/ioredis/-/ioredis-5.3.2.tgz",
+ "integrity": "sha512-1DKMMzlIHM02eBBVOFQ1+AolGjs6+xEcM4PDL7NqOS6szq7H9jSaEkIUH6/a5Hl241LzW6JLSiAbNvTQjUupUA==",
+ "dependencies": {
+ "@ioredis/commands": "^1.1.1",
+ "cluster-key-slot": "^1.1.0",
+ "debug": "^4.3.4",
+ "denque": "^2.1.0",
+ "lodash.defaults": "^4.2.0",
+ "lodash.isarguments": "^3.1.0",
+ "redis-errors": "^1.2.0",
+ "redis-parser": "^3.0.0",
+ "standard-as-callback": "^2.1.0"
+ },
+ "engines": {
+ "node": ">=12.22.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/ioredis"
+ }
+ },
+ "node_modules/is-fullwidth-code-point": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
+ "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/lodash.defaults": {
+ "version": "4.2.0",
+ "resolved": "https://registry.npmjs.org/lodash.defaults/-/lodash.defaults-4.2.0.tgz",
+ "integrity": "sha512-qjxPLHd3r5DnsdGacqOMU6pb/avJzdh9tFX2ymgoZE27BmjXrNy/y4LoaiTeAb+O3gL8AfpJGtqfX/ae2leYYQ=="
+ },
+ "node_modules/lodash.isarguments": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/lodash.isarguments/-/lodash.isarguments-3.1.0.tgz",
+ "integrity": "sha512-chi4NHZlZqZD18a0imDHnZPrDeBbTtVN7GXMwuGdRH9qotxAjYs3aVLKc7zNOG9eddR5Ksd8rvFEBc9SsggPpg=="
+ },
+ "node_modules/ms": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz",
+ "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w=="
+ },
+ "node_modules/pako": {
+ "version": "1.0.11",
+ "resolved": "https://registry.npmjs.org/pako/-/pako-1.0.11.tgz",
+ "integrity": "sha512-4hLB8Py4zZce5s4yd9XzopqwVv/yGNhV1Bl8NTmCq1763HeK2+EwVTv+leGeL13Dnh2wfbqowVPXCIO0z4taYw=="
+ },
+ "node_modules/redis-commands": {
+ "version": "1.7.0",
+ "resolved": "https://registry.npmjs.org/redis-commands/-/redis-commands-1.7.0.tgz",
+ "integrity": "sha512-nJWqw3bTFy21hX/CPKHth6sfhZbdiHP6bTawSgQBlKOVRG7EZkfHbbHwQJnrE4vsQf0CMNE+3gJ4Fmm16vdVlQ=="
+ },
+ "node_modules/redis-errors": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/redis-errors/-/redis-errors-1.2.0.tgz",
+ "integrity": "sha512-1qny3OExCf0UvUV/5wpYKf2YwPcOqXzkwKKSmKHiE6ZMQs5heeE/c8eXK+PNllPvmjgAbfnsbpkGZWy8cBpn9w==",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/redis-local": {
+ "name": "@redis/client",
+ "version": "1.5.6",
+ "resolved": "file:../packages/client",
+ "license": "MIT",
+ "dependencies": {
+ "cluster-key-slot": "1.1.2",
+ "generic-pool": "3.9.0",
+ "yallist": "4.0.0"
+ },
+ "engines": {
+ "node": ">=14"
+ }
+ },
+ "node_modules/redis-parser": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/redis-parser/-/redis-parser-3.0.0.tgz",
+ "integrity": "sha512-DJnGAeenTdpMEH6uAJRK/uiyEIH9WVsUmoLwzudwGJUwZPp80PDBWPHXSAGNPwNvIXAbe7MSUB1zQFugFml66A==",
+ "dependencies": {
+ "redis-errors": "^1.0.0"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/redis-v3": {
+ "name": "redis",
+ "version": "3.1.2",
+ "resolved": "https://registry.npmjs.org/redis/-/redis-3.1.2.tgz",
+ "integrity": "sha512-grn5KoZLr/qrRQVwoSkmzdbw6pwF+/rwODtrOr6vuBRiR/f3rjSTGupbF90Zpqm2oenix8Do6RV7pYEkGwlKkw==",
+ "dependencies": {
+ "denque": "^1.5.0",
+ "redis-commands": "^1.7.0",
+ "redis-errors": "^1.2.0",
+ "redis-parser": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/node-redis"
+ }
+ },
+ "node_modules/redis-v3/node_modules/denque": {
+ "version": "1.5.1",
+ "resolved": "https://registry.npmjs.org/denque/-/denque-1.5.1.tgz",
+ "integrity": "sha512-XwE+iZ4D6ZUB7mfYRMb5wByE8L74HCn30FBN7sWnXksWc1LO1bPDl67pBR9o/kC4z/xSNAwkMYcGgqDV3BE3Hw==",
+ "engines": {
+ "node": ">=0.10"
+ }
+ },
+ "node_modules/redis-v4": {
+ "name": "redis",
+ "version": "4.6.6",
+ "resolved": "https://registry.npmjs.org/redis/-/redis-4.6.6.tgz",
+ "integrity": "sha512-aLs2fuBFV/VJ28oLBqYykfnhGGkFxvx0HdCEBYdJ99FFbSEMZ7c1nVKwR6ZRv+7bb7JnC0mmCzaqu8frgOYhpA==",
+ "dependencies": {
+ "@redis/bloom": "1.2.0",
+ "@redis/client": "1.5.7",
+ "@redis/graph": "1.1.0",
+ "@redis/json": "1.0.4",
+ "@redis/search": "1.1.2",
+ "@redis/time-series": "1.0.4"
+ }
+ },
+ "node_modules/require-directory": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz",
+ "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/standard-as-callback": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/standard-as-callback/-/standard-as-callback-2.1.0.tgz",
+ "integrity": "sha512-qoRRSyROncaz1z0mvYqIE4lCd9p2R90i6GxW3uZv5ucSu8tU7B5HXUP1gG8pVZsYNVaXjk8ClXHPttLyxAL48A=="
+ },
+ "node_modules/string-width": {
+ "version": "4.2.3",
+ "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
+ "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
+ "dependencies": {
+ "emoji-regex": "^8.0.0",
+ "is-fullwidth-code-point": "^3.0.0",
+ "strip-ansi": "^6.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/strip-ansi": {
+ "version": "6.0.1",
+ "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
+ "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
+ "dependencies": {
+ "ansi-regex": "^5.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/wrap-ansi": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",
+ "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==",
+ "dependencies": {
+ "ansi-styles": "^4.0.0",
+ "string-width": "^4.1.0",
+ "strip-ansi": "^6.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/wrap-ansi?sponsor=1"
+ }
+ },
+ "node_modules/y18n": {
+ "version": "5.0.8",
+ "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz",
+ "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==",
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/yallist": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz",
+ "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A=="
+ },
+ "node_modules/yargs": {
+ "version": "17.7.1",
+ "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.7.1.tgz",
+ "integrity": "sha512-cwiTb08Xuv5fqF4AovYacTFNxk62th7LKJ6BL9IGUpTJrWoU7/7WdQGTP2SjKf1dUNBGzDd28p/Yfs/GI6JrLw==",
+ "dependencies": {
+ "cliui": "^8.0.1",
+ "escalade": "^3.1.1",
+ "get-caller-file": "^2.0.5",
+ "require-directory": "^2.1.1",
+ "string-width": "^4.2.3",
+ "y18n": "^5.0.5",
+ "yargs-parser": "^21.1.1"
+ },
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/yargs-parser": {
+ "version": "21.1.1",
+ "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz",
+ "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==",
+ "engines": {
+ "node": ">=12"
+ }
+ }
+ }
+}
diff --git a/benchmark/package.json b/benchmark/package.json
new file mode 100644
index 00000000000..73acf9d0f1c
--- /dev/null
+++ b/benchmark/package.json
@@ -0,0 +1,17 @@
+{
+ "name": "@redis/client-benchmark",
+ "private": true,
+ "main": "./lib",
+ "type": "module",
+ "scripts": {
+ "start": "node ."
+ },
+ "dependencies": {
+ "hdr-histogram-js": "3.0.0",
+ "ioredis": "5",
+ "redis-local": "file:../packages/client",
+ "redis-v3": "npm:redis@3",
+ "redis-v4": "npm:redis@4",
+ "yargs": "17.7.1"
+ }
+}
diff --git a/benchmark/requirements.txt b/benchmark/requirements.txt
new file mode 100644
index 00000000000..abff11d6abb
--- /dev/null
+++ b/benchmark/requirements.txt
@@ -0,0 +1 @@
+redisbench_admin>=0.5.24
diff --git a/changelog.md b/changelog.md
deleted file mode 100644
index 63a29bc4b76..00000000000
--- a/changelog.md
+++ /dev/null
@@ -1,210 +0,0 @@
-Changelog
-=========
-
-## v0.7.1 - November 15, 2011
-
-Fix regression in reconnect logic.
-
-Very much need automated tests for reconnection and queue logic.
-
-## v0.7.0 - November 14, 2011
-
-Many contributed fixes. Thanks everybody.
-
-* [GH-127] - properly re-initialize parser on reconnect
-* [GH-136] - handle passing undefined as callback (Ian Babrou)
-* [GH-139] - properly handle exceptions thrown in pub/sub event handlers (Felix GeisendΓΆrfer)
-* [GH-141] - detect closing state on stream error (Felix GeisendΓΆrfer)
-* [GH-142] - re-select database on reconnection (Jean-Hugues Pinson)
-* [GH-146] - add sort example (Maksim Lin)
-
-Some more goodies:
-
-* Fix bugs with node 0.6
-* Performance improvements
-* New version of `multi_bench.js` that tests more realistic scenarios
-* [GH-140] - support optional callback for subscribe commands
-* Properly flush and error out command queue when connection fails
-* Initial work on reconnection thresholds
-
-## v0.6.7 - July 30, 2011
-
-(accidentally skipped v0.6.6)
-
-Fix and test for [GH-123]
-
-Passing an Array as as the last argument should expand as users
-expect. The old behavior was to coerce the arguments into Strings,
-which did surprising things with Arrays.
-
-## v0.6.5 - July 6, 2011
-
-Contributed changes:
-
-* Support SlowBuffers (Umair Siddique)
-* Add Multi to exports (Louis-Philippe Perron)
-* Fix for drain event calculation (Vladimir Dronnikov)
-
-Thanks!
-
-## v0.6.4 - June 30, 2011
-
-Fix bug with optional callbacks for hmset.
-
-## v0.6.2 - June 30, 2011
-
-Bugs fixed:
-
-* authentication retry while server is loading db (danmaz74) [GH-101]
-* command arguments processing issue with arrays
-
-New features:
-
-* Auto update of new commands from redis.io (Dave Hoover)
-* Performance improvements and backpressure controls.
-* Commands now return the true/false value from the underlying socket write(s).
-* Implement command_queue high water and low water for more better control of queueing.
-
-See `examples/backpressure_drain.js` for more information.
-
-## v0.6.1 - June 29, 2011
-
-Add support and tests for Redis scripting through EXEC command.
-
-Bug fix for monitor mode. (forddg)
-
-Auto update of new commands from redis.io (Dave Hoover)
-
-## v0.6.0 - April 21, 2011
-
-Lots of bugs fixed.
-
-* connection error did not properly trigger reconnection logic [GH-85]
-* client.hmget(key, [val1, val2]) was not expanding properly [GH-66]
-* client.quit() while in pub/sub mode would throw an error [GH-87]
-* client.multi(['hmset', 'key', {foo: 'bar'}]) fails [GH-92]
-* unsubscribe before subscribe would make things very confused [GH-88]
-* Add BRPOPLPUSH [GH-79]
-
-## v0.5.11 - April 7, 2011
-
-Added DISCARD
-
-I originally didn't think DISCARD would do anything here because of the clever MULTI interface, but somebody
-pointed out to me that DISCARD can be used to flush the WATCH set.
-
-## v0.5.10 - April 6, 2011
-
-Added HVALS
-
-## v0.5.9 - March 14, 2011
-
-Fix bug with empty Array arguments - Andy Ray
-
-## v0.5.8 - March 14, 2011
-
-Add `MONITOR` command and special monitor command reply parsing.
-
-## v0.5.7 - February 27, 2011
-
-Add magical auth command.
-
-Authentication is now remembered by the client and will be automatically sent to the server
-on every connection, including any reconnections.
-
-## v0.5.6 - February 22, 2011
-
-Fix bug in ready check with `return_buffers` set to `true`.
-
-Thanks to Dean Mao and Austin Chau.
-
-## v0.5.5 - February 16, 2011
-
-Add probe for server readiness.
-
-When a Redis server starts up, it might take a while to load the dataset into memory.
-During this time, the server will accept connections, but will return errors for all non-INFO
-commands. Now node_redis will send an INFO command whenever it connects to a server.
-If the info command indicates that the server is not ready, the client will keep trying until
-the server is ready. Once it is ready, the client will emit a "ready" event as well as the
-"connect" event. The client will queue up all commands sent before the server is ready, just
-like it did before. When the server is ready, all offline/non-ready commands will be replayed.
-This should be backward compatible with previous versions.
-
-To disable this ready check behavior, set `options.no_ready_check` when creating the client.
-
-As a side effect of this change, the key/val params from the info command are available as
-`client.server_options`. Further, the version string is decomposed into individual elements
-in `client.server_options.versions`.
-
-## v0.5.4 - February 11, 2011
-
-Fix excess memory consumption from Queue backing store.
-
-Thanks to Gustaf SjΓΆberg.
-
-## v0.5.3 - February 5, 2011
-
-Fix multi/exec error reply callback logic.
-
-Thanks to Stella Laurenzo.
-
-## v0.5.2 - January 18, 2011
-
-Fix bug where unhandled error replies confuse the parser.
-
-## v0.5.1 - January 18, 2011
-
-Fix bug where subscribe commands would not handle redis-server startup error properly.
-
-## v0.5.0 - December 29, 2010
-
-Some bug fixes:
-
-* An important bug fix in reconnection logic. Previously, reply callbacks would be invoked twice after
- a reconnect.
-* Changed error callback argument to be an actual Error object.
-
-New feature:
-
-* Add friendly syntax for HMSET using an object.
-
-## v0.4.1 - December 8, 2010
-
-Remove warning about missing hiredis. You probably do want it though.
-
-## v0.4.0 - December 5, 2010
-
-Support for multiple response parsers and hiredis C library from Pieter Noordhuis.
-Return Strings instead of Buffers by default.
-Empty nested mb reply bug fix.
-
-## v0.3.9 - November 30, 2010
-
-Fix parser bug on failed EXECs.
-
-## v0.3.8 - November 10, 2010
-
-Fix for null MULTI response when WATCH condition fails.
-
-## v0.3.7 - November 9, 2010
-
-Add "drain" and "idle" events.
-
-## v0.3.6 - November 3, 2010
-
-Add all known Redis commands from Redis master, even ones that are coming in 2.2 and beyond.
-
-Send a friendlier "error" event message on stream errors like connection refused / reset.
-
-## v0.3.5 - October 21, 2010
-
-A few bug fixes.
-
-* Fixed bug with `nil` multi-bulk reply lengths that showed up with `BLPOP` timeouts.
-* Only emit `end` once when connection goes away.
-* Fixed bug in `test.js` where driver finished before all tests completed.
-
-## unversioned wasteland
-
-See the git history for what happened before.
diff --git a/docs/FAQ.md b/docs/FAQ.md
new file mode 100644
index 00000000000..5774213da5b
--- /dev/null
+++ b/docs/FAQ.md
@@ -0,0 +1,27 @@
+# F.A.Q.
+
+Nobody has *actually* asked these questions. But, we needed somewhere to put all the important bits and bobs that didn't fit anywhere else. So, here you go!
+
+## What happens when the network goes down?
+
+When a socket closes unexpectedly, all the commands that were already sent will reject as they might have been executed on the server. The rest will remain queued in memory until a new socket is established. If the client is closedβeither by returning an error from [`reconnectStrategy`](./client-configuration.md#reconnect-strategy) or by manually calling `.disconnect()`βthey will be rejected.
+
+If don't want to queue commands in memory until a new socket is established, set the `disableOfflineQueue` option to `true` in the [client configuration](./client-configuration.md). This will result in those commands being rejected.
+
+## How are commands batched?
+
+Commands are pipelined using [`setImmediate`](https://nodejs.org/api/timers.html#setimmediatecallback-args).
+
+If `socket.write()` returns `false`βmeaning that ["all or part of the data was queued in user memory"](https://nodejs.org/api/net.html#net_socket_write_data_encoding_callback:~:text=all%20or%20part%20of%20the%20data%20was%20queued%20in%20user%20memory)βthe commands will stack in memory until the [`drain`](https://nodejs.org/api/net.html#net_event_drain) event is fired.
+
+## `RedisClientType`
+
+Redis has support for [modules](https://redis.io/modules) and running [Lua scripts](../README.md#lua-scripts) within the Redis context. To take advantage of typing within these scenarios, `RedisClient` and `RedisCluster` should be used with [typeof](https://www.typescriptlang.org/docs/handbook/2/typeof-types.html), rather than the base types `RedisClientType` and `RedisClusterType`.
+
+```typescript
+import { createClient } from '@redis/client';
+
+export const client = createClient();
+
+export type RedisClientType = typeof client;
+```
\ No newline at end of file
diff --git a/docs/RESP.md b/docs/RESP.md
new file mode 100644
index 00000000000..f8c2388226b
--- /dev/null
+++ b/docs/RESP.md
@@ -0,0 +1,46 @@
+# Mapping RESP types
+
+RESP, which stands for **R**edis **SE**rialization **P**rotocol, is the protocol used by Redis to communicate with clients. This document shows how RESP types can be mapped to JavaScript types. You can learn more about RESP itself in the [offical documentation](https://redis.io/docs/reference/protocol-spec/).
+
+By default, each type is mapped to the first option in the lists below. To change this, configure a [`typeMapping`](.).
+
+## RESP2
+
+- Integer (`:`) => `number`
+- Simple String (`+`) => `string | Buffer`
+- Blob String (`$`) => `string | Buffer`
+- Simple Error (`-`) => `ErrorReply`
+- Array (`*`) => `Array`
+
+> NOTE: the first type is the default type
+
+## RESP3
+
+- Null (`_`) => `null`
+- Boolean (`#`) => `boolean`
+- Number (`:`) => `number | string`
+- Big Number (`(`) => `BigInt | string`
+- Double (`,`) => `number | string`
+- Simple String (`+`) => `string | Buffer`
+- Blob String (`$`) => `string | Buffer`
+- Verbatim String (`=`) => `string | Buffer | VerbatimString`
+- Simple Error (`-`) => `ErrorReply`
+- Blob Error (`!`) => `ErrorReply`
+- Array (`*`) => `Array`
+- Set (`~`) => `Array | Set`
+- Map (`%`) => `object | Map | Array`
+- Push (`>`) => `Array` => PubSub push/`'push'` event
+
+> NOTE: the first type is the default type
+
+### Map keys and Set members
+
+When decoding a Map to `Map | object` or a Set to `Set`, keys and members of type "Simple String" or "Blob String" will be decoded as `string`s which enables lookups by value, ignoring type mapping. If you want them as `Buffer`s, decode them as `Array`s instead.
+
+### Not Implemented
+
+These parts of RESP3 are not yet implemented in Redis itself (at the time of writing), so are not yet implemented in the Node-Redis client either:
+
+- [Attribute type](https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#attribute-type)
+- [Streamed strings](https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#streamed-strings)
+- [Streamed aggregated data types](https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md#streamed-aggregated-data-types)
diff --git a/docs/client-configuration.md b/docs/client-configuration.md
new file mode 100644
index 00000000000..57af626bf71
--- /dev/null
+++ b/docs/client-configuration.md
@@ -0,0 +1,96 @@
+# `createClient` configuration
+
+| Property | Default | Description |
+|------------------------------|------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| url | | `redis[s]://[[username][:password]@][host][:port][/db-number]` (see [`redis`](https://www.iana.org/assignments/uri-schemes/prov/redis) and [`rediss`](https://www.iana.org/assignments/uri-schemes/prov/rediss) IANA registration for more details) |
+| socket | | Socket connection properties. Unlisted [`net.connect`](https://nodejs.org/api/net.html#socketconnectoptions-connectlistener) properties (and [`tls.connect`](https://nodejs.org/api/tls.html#tlsconnectoptions-callback)) are also supported |
+| socket.port | `6379` | Redis server port |
+| socket.host | `'localhost'` | Redis server hostname |
+| socket.family | `0` | IP Stack version (one of `4 \| 6 \| 0`) |
+| socket.path | | Path to the UNIX Socket |
+| socket.connectTimeout | `5000` | Connection timeout (in milliseconds) |
+| socket.socketTimeout | | The maximum duration (in milliseconds) that the socket can remain idle (i.e., with no data sent or received) before being automatically closed |
+| socket.noDelay | `true` | Toggle [`Nagle's algorithm`](https://nodejs.org/api/net.html#net_socket_setnodelay_nodelay) |
+| socket.keepAlive | `true` | Toggle [`keep-alive`](https://nodejs.org/api/net.html#socketsetkeepaliveenable-initialdelay) functionality |
+| socket.keepAliveInitialDelay | `5000` | If set to a positive number, it sets the initial delay before the first keepalive probe is sent on an idle socket |
+| socket.tls | | See explanation and examples [below](#TLS) |
+| socket.reconnectStrategy | Exponential backoff with a maximum of 2000 ms; plus 0-200 ms random jitter. | A function containing the [Reconnect Strategy](#reconnect-strategy) logic |
+| username | | ACL username ([see ACL guide](https://redis.io/topics/acl)) |
+| password | | ACL password or the old "--requirepass" password |
+| name | | Client name ([see `CLIENT SETNAME`](https://redis.io/commands/client-setname)) |
+| database | | Redis database number (see [`SELECT`](https://redis.io/commands/select) command) |
+| modules | | Included [Redis Modules](../README.md#packages) |
+| scripts | | Script definitions (see [Lua Scripts](../README.md#lua-scripts)) |
+| functions | | Function definitions (see [Functions](../README.md#functions)) |
+| commandsQueueMaxLength | | Maximum length of the client's internal command queue |
+| disableOfflineQueue | `false` | Disables offline queuing, see [FAQ](./FAQ.md#what-happens-when-the-network-goes-down) |
+| readonly | `false` | Connect in [`READONLY`](https://redis.io/commands/readonly) mode |
+| legacyMode | `false` | Maintain some backwards compatibility (see the [Migration Guide](./v3-to-v4.md)) |
+| isolationPoolOptions | | An object that configures a pool of isolated connections, If you frequently need isolated connections, consider using [createClientPool](https://github.com/redis/node-redis/blob/master/docs/pool.md#creating-a-pool) instead |
+| pingInterval | | Send `PING` command at interval (in ms). Useful with ["Azure Cache for Redis"](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-best-practices-connection#idle-timeout) |
+| disableClientInfo | `false` | Disables `CLIENT SETINFO LIB-NAME node-redis` and `CLIENT SETINFO LIB-VER X.X.X` commands |
+
+## Reconnect Strategy
+
+When the socket closes unexpectedly (without calling `.quit()`/`.disconnect()`), the client uses `reconnectStrategy` to decide what to do. The following values are supported:
+1. `false` -> do not reconnect, close the client and flush the command queue.
+2. `number` -> wait for `X` milliseconds before reconnecting.
+3. `(retries: number, cause: Error) => false | number | Error` -> `number` is the same as configuring a `number` directly, `Error` is the same as `false`, but with a custom error.
+
+By default the strategy uses exponential backoff, but it can be overwritten like so:
+
+```javascript
+createClient({
+ socket: {
+ reconnectStrategy: (retries, cause) => {
+ // By default, do not reconnect on socket timeout.
+ if (cause instanceof SocketTimeoutError) {
+ return false;
+ }
+
+ // Generate a random jitter between 0 β 200 ms:
+ const jitter = Math.floor(Math.random() * 200);
+ // Delay is an exponential back off, (times^2) * 50 ms, with a maximum value of 2000 ms:
+ const delay = Math.min(Math.pow(2, retries) * 50, 2000);
+
+ return delay + jitter;
+ }
+ }
+});
+```
+
+## TLS
+
+To enable TLS, set `socket.tls` to `true`. Below are some basic examples.
+
+> For configuration options see [tls.connect](https://nodejs.org/api/tls.html#tlsconnectoptions-callback) and [tls.createSecureContext](https://nodejs.org/api/tls.html#tlscreatesecurecontextoptions), as those are the underlying functions used by this library.
+
+### Create a SSL client
+
+```javascript
+createClient({
+ socket: {
+ tls: true,
+ ca: '...',
+ cert: '...'
+ }
+});
+```
+
+### Create a SSL client using a self-signed certificate
+
+```javascript
+createClient({
+ socket: {
+ tls: true,
+ rejectUnauthorized: false,
+ cert: '...'
+ }
+});
+```
+## Connection Pooling
+
+In most cases, a single Redis connection is sufficient, as the node-redis client efficiently handles commands using an underlying socket. Unlike traditional databases, Redis does not require connection pooling for optimal performance.
+
+However, if your use case requires exclusive connections see [RedisClientPool](https://github.com/redis/node-redis/blob/master/docs/pool.md), which allows you to create and manage multiple dedicated connections.
+
diff --git a/docs/clustering.md b/docs/clustering.md
new file mode 100644
index 00000000000..4afd95afd23
--- /dev/null
+++ b/docs/clustering.md
@@ -0,0 +1,154 @@
+# Clustering
+
+## Basic Example
+
+Connecting to a cluster is a bit different. Create the client by specifying some (or all) of the nodes in your cluster and then use it like a regular client instance:
+
+```javascript
+import { createCluster } from 'redis';
+
+const cluster = await createCluster({
+ rootNodes: [{
+ url: 'redis://10.0.0.1:30001'
+ }, {
+ url: 'redis://10.0.0.2:30002'
+ }]
+ })
+ .on('error', err => console.log('Redis Cluster Error', err))
+ .connect();
+
+await cluster.set('key', 'value');
+const value = await cluster.get('key');
+await cluster.close();
+```
+
+## `createCluster` configuration
+
+> See the [client configuration](./client-configuration.md) page for the `rootNodes` and `defaults` configuration schemas.
+
+| Property | Default | Description |
+|------------------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| rootNodes | | An array of root nodes that are part of the cluster, which will be used to get the cluster topology. Each element in the array is a client configuration object. There is no need to specify every node in the cluster: 3 should be enough to reliably connect and obtain the cluster configuration from the server |
+| defaults | | The default configuration values for every client in the cluster. Use this for example when specifying an ACL user to connect with |
+| useReplicas | `false` | When `true`, distribute load by executing readonly commands (such as `GET`, `GEOSEARCH`, etc.) across all cluster nodes. When `false`, only use master nodes |
+| minimizeConnections | `false` | When `true`, `.connect()` will only discover the cluster topology, without actually connecting to all the nodes. Useful for short-term or Pub/Sub-only connections. |
+| maxCommandRedirections | `16` | The maximum number of times a command will be redirected due to `MOVED` or `ASK` errors |
+| nodeAddressMap | | Defines the [node address mapping](#node-address-map) |
+| modules | | Included [Redis Modules](../README.md#packages) |
+| scripts | | Script definitions (see [Lua Scripts](./programmability.md#lua-scripts)) |
+| functions | | Function definitions (see [Functions](./programmability.md#functions)) |
+
+## Usage
+
+Most redis commands are the same as with individual clients.
+
+### Unsupported Redis Commands
+
+If you want to run commands and/or use arguments that Node Redis doesn't know about (yet!) use `.sendCommand()`.
+
+When clustering, `sendCommand` takes 3 arguments to help with routing to the correct redis node:
+* `firstKey`: the key that is being operated on, or `undefined` to route to a random node.
+* `isReadOnly`: determines if the command needs to go to the master or may go to a replica.
+* `args`: the command and all arguments (including the key), as an array of strings.
+
+```javascript
+await cluster.sendCommand("key", false, ["SET", "key", "value", "NX"]); // 'OK'
+
+await cluster.sendCommand("key", true, ["HGETALL", "key"]); // ['key1', 'field1', 'key2', 'field2']
+```
+
+## Auth with password and username
+
+Specifying the password in the URL or a root node will only affect the connection to that specific node. In case you want to set the password for all the connections being created from a cluster instance, use the `defaults` option.
+
+```javascript
+createCluster({
+ rootNodes: [{
+ url: 'redis://10.0.0.1:30001'
+ }, {
+ url: 'redis://10.0.0.2:30002'
+ }],
+ defaults: {
+ username: 'username',
+ password: 'password'
+ }
+});
+```
+
+## Node Address Map
+
+A mapping between the addresses in the cluster (see `CLUSTER SHARDS`) and the addresses the client should connect to.
+Useful when the cluster is running on a different network to the client.
+
+```javascript
+const rootNodes = [{
+ url: 'external-host-1.io:30001'
+}, {
+ url: 'external-host-2.io:30002'
+}];
+
+// Use either a static mapping:
+createCluster({
+ rootNodes,
+ nodeAddressMap: {
+ '10.0.0.1:30001': {
+ host: 'external-host.io',
+ port: 30001
+ },
+ '10.0.0.2:30002': {
+ host: 'external-host.io',
+ port: 30002
+ }
+ }
+});
+
+// or create the mapping dynamically, as a function:
+createCluster({
+ rootNodes,
+ nodeAddressMap(address) {
+ const indexOfDash = address.lastIndexOf('-'),
+ indexOfDot = address.indexOf('.', indexOfDash),
+ indexOfColons = address.indexOf(':', indexOfDot);
+
+ return {
+ host: `external-host-${address.substring(indexOfDash + 1, indexOfDot)}.io`,
+ port: Number(address.substring(indexOfColons + 1))
+ };
+ }
+});
+```
+
+> This is a common problem when using ElastiCache. See [Accessing ElastiCache from outside AWS](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/accessing-elasticache.html) for more information on that.
+
+### Events
+
+The Node Redis Cluster class extends Node.jsβs EventEmitter and emits the following events:
+
+| Name | When | Listener arguments |
+| ----------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------- |
+| `connect` | The cluster has successfully connected and is ready to us | _No arguments_ |
+| `disconnect` | The cluster has disconnected | _No arguments_ |
+| `error` | The cluster has errored | `(error: Error)` |
+| `node-ready` | A cluster node is ready to establish a connection | `(node: { host: string, port: number })` |
+| `node-connect` | A cluster node has connected | `(node: { host: string, port: number })` |
+| `node-reconnecting` | A cluster node is attempting to reconnect after an error | `(node: { host: string, port: number })` |
+| `node-disconnect` | A cluster node has disconnected | `(node: { host: string, port: number })` |
+| `node-error` | A cluster node has has errored (usually during TCP connection) | `(error: Error, node: { host: string, port: number })` |
+
+> :warning: You **MUST** listen to `error` events. If a cluster doesn't have at least one `error` listener registered and
+> an `error` occurs, that error will be thrown and the Node.js process will exit. See the [ > `EventEmitter` docs](https://nodejs.org/api/events.html#events_error_events) for more details.
+
+## Command Routing
+
+### Commands that operate on Redis Keys
+
+Commands such as `GET`, `SET`, etc. are routed by the first key specified. For example `MGET 1 2 3` will be routed by the key `1`.
+
+### [Server Commands](https://redis.io/commands#server)
+
+Admin commands such as `MEMORY STATS`, `FLUSHALL`, etc. are not attached to the cluster, and must be executed on a specific node via `.getSlotMaster()`.
+
+### "Forwarded Commands"
+
+Certain commands (e.g. `PUBLISH`) are forwarded to other cluster nodes by the Redis server. The client sends these commands to a random node in order to spread the load across the cluster.
+
diff --git a/docs/command-options.md b/docs/command-options.md
new file mode 100644
index 00000000000..8583eae135b
--- /dev/null
+++ b/docs/command-options.md
@@ -0,0 +1,81 @@
+# Command Options
+
+> :warning: The command options API in v5 has breaking changes from the previous version. For more details, refer to the [v4-to-v5 guide](./v4-to-v5.md#command-options).
+
+Command Options are used to create "proxy clients" that change the behavior of executed commands. See the sections below for details.
+
+## Type Mapping
+
+Some [RESP types](./RESP.md) can be mapped to more than one JavaScript type. For example, "Blob String" can be mapped to `string` or `Buffer`. You can override the default type mapping using the `withTypeMapping` function:
+
+```javascript
+await client.get('key'); // `string | null`
+
+const proxyClient = client.withTypeMapping({
+ [TYPES.BLOB_STRING]: Buffer
+});
+
+await proxyClient.get('key'); // `Buffer | null`
+```
+
+See [RESP](./RESP.md) for a full list of types.
+
+## Abort Signal
+
+The client [batches commands](./FAQ.md#how-are-commands-batched) before sending them to Redis. Commands that haven't been written to the socket yet can be aborted using the [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) API:
+
+```javascript
+const controller = new AbortController(),
+ client = client.withAbortSignal(controller.signal);
+
+try {
+ const promise = client.get('key');
+ controller.abort();
+ await promise;
+} catch (err) {
+ // AbortError
+}
+```
+
+
+## Timeout
+
+This option is similar to the Abort Signal one, but provides an easier way to set timeout for commands. Again, this applies to commands that haven't been written to the socket yet.
+
+```javascript
+const client = createClient({
+ commandOptions: {
+ timeout: 1000
+ }
+})
+```
+
+## ASAP
+
+Commands that are executed in the "asap" mode are added to the beginning of the "to sent" queue.
+
+```javascript
+const asapClient = client.asap();
+await asapClient.ping();
+```
+
+## `withCommandOptions`
+
+You can set all of the above command options in a single call with the `withCommandOptions` function:
+
+```javascript
+client.withCommandOptions({
+ typeMapping: ...,
+ abortSignal: ...,
+ asap: ...
+});
+```
+
+If any of the above options are omitted, the default value will be used. For example, the following client would **not** be in ASAP mode:
+
+```javascript
+client.asap().withCommandOptions({
+ typeMapping: ...,
+ abortSignal: ...
+});
+```
diff --git a/docs/pool.md b/docs/pool.md
new file mode 100644
index 00000000000..7121e601d73
--- /dev/null
+++ b/docs/pool.md
@@ -0,0 +1,74 @@
+# `RedisClientPool`
+
+Sometimes you want to run your commands on an exclusive connection. There are a few reasons to do this:
+
+- You want to run a blocking command that will take over the connection, such as `BLPOP` or `BLMOVE`.
+- You're using [transactions](https://redis.io/docs/interact/transactions/) and need to `WATCH` a key or keys for changes.
+- Some more...
+
+For those use cases you'll need to create a connection pool.
+
+## Creating a pool
+
+You can create a pool using the `createClientPool` function:
+
+```javascript
+import { createClientPool } from 'redis';
+
+const pool = await createClientPool()
+ .on('error', err => console.error('Redis Client Pool Error', err));
+```
+
+the function accepts two arguments, the client configuration (see [here](./client-configuration.md) for more details), and the pool configuration:
+
+| Property | Default | Description |
+|----------------|---------|--------------------------------------------------------------------------------------------------------------------------------|
+| minimum | 1 | The minimum clients the pool should hold to. The pool won't close clients if the pool size is less than the minimum. |
+| maximum | 100 | The maximum clients the pool will have at once. The pool won't create any more resources and queue requests in memory. |
+| acquireTimeout | 3000 | The maximum time (in ms) a task can wait in the queue. The pool will reject the task with `TimeoutError` in case of a timeout. |
+| cleanupDelay | 3000 | The time to wait before cleaning up unused clients. |
+
+You can also create a pool from a client (reusing it's configuration):
+```javascript
+const pool = await client.createPool()
+ .on('error', err => console.error('Redis Client Pool Error', err));
+```
+
+## The Simple Scenario
+
+All the client APIs are exposed on the pool instance directly, and will execute the commands using one of the available clients.
+
+```javascript
+await pool.sendCommand(['PING']); // 'PONG'
+await client.ping(); // 'PONG'
+await client.withTypeMapping({
+ [RESP_TYPES.SIMPLE_STRING]: Buffer
+}).ping(); // Buffer
+```
+
+## Transactions
+
+Things get a little more complex with transactions. Here we are `.watch()`ing some keys. If the keys change during the transaction, a `WatchError` is thrown when `.exec()` is called:
+
+```javascript
+try {
+ await pool.execute(async client => {
+ await client.watch('key');
+
+ const multi = client.multi()
+ .ping()
+ .get('key');
+
+ if (Math.random() > 0.5) {
+ await client.watch('another-key');
+ multi.set('another-key', await client.get('another-key') / 2);
+ }
+
+ return multi.exec();
+ });
+} catch (err) {
+ if (err instanceof WatchError) {
+ // the transaction aborted
+ }
+}
+```
diff --git a/docs/programmability.md b/docs/programmability.md
new file mode 100644
index 00000000000..c5917c2387d
--- /dev/null
+++ b/docs/programmability.md
@@ -0,0 +1,85 @@
+# [Programmability](https://redis.io/docs/manual/programmability/)
+
+Redis provides a programming interface allowing code execution on the redis server.
+
+## [Functions](https://redis.io/docs/manual/programmability/functions-intro/)
+
+The following example retrieves a key in redis, returning the value of the key, incremented by an integer. For example, if your key _foo_ has the value _17_ and we run `add('foo', 25)`, it returns the answer to Life, the Universe and Everything.
+
+```lua
+#!lua name=library
+
+redis.register_function {
+ function_name = 'add',
+ callback = function(keys, args) return redis.call('GET', keys[1]) + args[1] end,
+ flags = { 'no-writes' }
+}
+```
+
+Here is the same example, but in a format that can be pasted into the `redis-cli`.
+
+```
+FUNCTION LOAD "#!lua name=library\nredis.register_function{function_name='add', callback=function(keys, args) return redis.call('GET', keys[1])+args[1] end, flags={'no-writes'}}"
+```
+
+Load the prior redis function on the _redis server_ before running the example below.
+
+```typescript
+import { CommandParser, createClient, RedisArgument } from '@redis/client';
+import { NumberReply } from '@redis/client/dist/lib/RESP/types.js';
+
+const client = createClient({
+ functions: {
+ library: {
+ add: {
+ NUMBER_OF_KEYS: 1,
+ parseCommand(
+ parser: CommandParser,
+ key: RedisArgument,
+ toAdd: RedisArgument
+ ) {
+ parser.pushKey(key)
+ parser.push(toAdd)
+ },
+ transformReply: undefined as unknown as () => NumberReply
+ }
+ }
+ }
+});
+
+await client.connect();
+await client.set('key', '1');
+await client.library.add('key', '2'); // 3
+```
+
+## [Lua Scripts](https://redis.io/docs/manual/programmability/eval-intro/)
+
+The following is an end-to-end example of the prior concept.
+
+```typescript
+import { CommandParser, createClient, defineScript, RedisArgument } from '@redis/client';
+import { NumberReply } from '@redis/client/dist/lib/RESP/types.js';
+
+const client = createClient({
+ scripts: {
+ add: defineScript({
+ SCRIPT: 'return redis.call("GET", KEYS[1]) + ARGV[1];',
+ NUMBER_OF_KEYS: 1,
+ FIRST_KEY_INDEX: 1,
+ parseCommand(
+ parser: CommandParser,
+ key: RedisArgument,
+ toAdd: RedisArgument
+ ) {
+ parser.pushKey(key)
+ parser.push(toAdd)
+ },
+ transformReply: undefined as unknown as () => NumberReply
+ })
+ }
+});
+
+await client.connect();
+await client.set('key', '1');
+await client.add('key', '2'); // 3
+```
diff --git a/docs/pub-sub.md b/docs/pub-sub.md
new file mode 100644
index 00000000000..7bbb0733c18
--- /dev/null
+++ b/docs/pub-sub.md
@@ -0,0 +1,92 @@
+# Pub/Sub
+
+The Pub/Sub API is implemented by `RedisClient`, `RedisCluster`, and `RedisSentinel`.
+
+## Pub/Sub with `RedisClient`
+
+### RESP2
+
+Using RESP2, Pub/Sub "takes over" the connection (a client with subscriptions will not execute commands), therefore it requires a dedicated connection. You can easily get one by `.duplicate()`ing an existing `RedisClient`:
+
+```javascript
+const subscriber = client.duplicate();
+subscriber.on('error', err => console.error(err));
+await subscriber.connect();
+```
+
+> When working with either `RedisCluster` or `RedisSentinel`, this is handled automatically for you.
+
+### `sharded-channel-moved` event
+
+`RedisClient` emits the `sharded-channel-moved` event when the ["cluster slot"](https://redis.io/docs/reference/cluster-spec/#key-distribution-model) of a subscribed [Sharded Pub/Sub](https://redis.io/docs/manual/pubsub/#sharded-pubsub) channel has been moved to another shard.
+
+The event listener signature is as follows:
+```typescript
+(
+ channel: string,
+ listeners: {
+ buffers: Set;
+ strings: Set;
+ }
+)
+```
+
+> When working with `RedisCluster`, this is handled automatically for you.
+
+## Subscribing
+
+```javascript
+const listener = (message, channel) => console.log(message, channel);
+await client.subscribe('channel', listener);
+await client.pSubscribe('channe*', listener);
+// Use sSubscribe for sharded Pub/Sub:
+await client.sSubscribe('channel', listener);
+```
+
+> β οΈ Subscribing to the same channel more than once will create multiple listeners, each of which will be called when a message is received.
+
+## Publishing
+
+```javascript
+await client.publish('channel', 'message');
+// Use sPublish for sharded Pub/Sub:
+await client.sPublish('channel', 'message');
+```
+
+## Unsubscribing
+
+The code below unsubscribes all listeners from all channels.
+
+```javascript
+await client.unsubscribe();
+await client.pUnsubscribe();
+// Use sUnsubscribe for sharded Pub/Sub:
+await client.sUnsubscribe();
+```
+
+To unsubscribe from specific channels:
+
+```javascript
+await client.unsubscribe('channel');
+await client.unsubscribe(['1', '2']);
+```
+
+To unsubscribe a specific listener:
+
+```javascript
+await client.unsubscribe('channel', listener);
+```
+
+## Buffers
+
+Publishing and subscribing using `Buffer`s is also supported:
+
+```javascript
+await subscriber.subscribe('channel', message => {
+ console.log(message); //
+}, true); // true = subscribe in `Buffer` mode.
+
+await subscriber.publish(Buffer.from('channel'), Buffer.from('message'));
+```
+
+> NOTE: Buffers and strings are supported both for the channel name and the message. You can mix and match these as desired.
diff --git a/docs/scan-iterators.md b/docs/scan-iterators.md
new file mode 100644
index 00000000000..47c4d6c0567
--- /dev/null
+++ b/docs/scan-iterators.md
@@ -0,0 +1,30 @@
+# Scan Iterators
+
+> :warning: The scan iterators API in v5 has breaking changes from the previous version. For more details, refer to the [v4-to-v5 guide](./v4-to-v5.md#scan-iterators).
+
+[`SCAN`](https://redis.io/commands/scan) results can be looped over using [async iterators](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/asyncIterator):
+
+```javascript
+for await (const keys of client.scanIterator()) {
+ const values = await client.mGet(keys);
+}
+```
+
+This works with `HSCAN`, `SSCAN`, and `ZSCAN` too:
+
+```javascript
+for await (const entries of client.hScanIterator('hash')) {}
+for await (const members of client.sScanIterator('set')) {}
+for await (const membersWithScores of client.zScanIterator('sorted-set')) {}
+```
+
+You can override the default options by providing a configuration object:
+
+```javascript
+client.scanIterator({
+ cursor: '0', // optional, defaults to '0'
+ TYPE: 'string', // `SCAN` only
+ MATCH: 'patter*',
+ COUNT: 100
+});
+```
diff --git a/docs/sentinel.md b/docs/sentinel.md
new file mode 100644
index 00000000000..f10b2953df5
--- /dev/null
+++ b/docs/sentinel.md
@@ -0,0 +1,103 @@
+# Redis Sentinel
+
+The [Redis Sentinel](https://redis.io/docs/management/sentinel/) object of node-redis provides a high level object that provides access to a high availability redis installation managed by Redis Sentinel to provide enumeration of master and replica nodes belonging to an installation as well as reconfigure itself on demand for failover and topology changes.
+
+## Basic Example
+
+```javascript
+import { createSentinel } from 'redis';
+
+const sentinel = await createSentinel({
+ name: 'sentinel-db',
+ sentinelRootNodes: [{
+ host: 'example',
+ port: 1234
+ }]
+ })
+ .on('error', err => console.error('Redis Sentinel Error', err))
+ .connect();
+
+await sentinel.set('key', 'value');
+const value = await sentinel.get('key');
+await sentinel.close();
+```
+
+In the above example, we configure the sentinel object to fetch the configuration for the database Redis Sentinel is monitoring as "sentinel-db" with one of the sentinels being located at `example:1234`, then using it like a regular Redis client.
+
+## `createSentinel` configuration
+
+| Property | Default | Description |
+|----------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| name | | The sentinel identifier for a particular database cluster |
+| sentinelRootNodes | | An array of root nodes that are part of the sentinel cluster, which will be used to get the topology. Each element in the array is a client configuration object. There is no need to specify every node in the cluster: 3 should be enough to reliably connect and obtain the sentinel configuration from the server |
+| maxCommandRediscovers | `16` | The maximum number of times a command will retry due to topology changes. |
+| nodeClientOptions | | The configuration values for every node in the cluster. Use this for example when specifying an ACL user to connect with |
+| sentinelClientOptions | | The configuration values for every sentinel in the cluster. Use this for example when specifying an ACL user to connect with |
+| masterPoolSize | `1` | The number of clients connected to the master node |
+| replicaPoolSize | `0` | The number of clients connected to each replica node. When greater than 0, the client will distribute the load by executing read-only commands (such as `GET`, `GEOSEARCH`, etc.) across all the cluster nodes. |
+| scanInterval | `10000` | Interval in milliseconds to periodically scan for changes in the sentinel topology. The client will query the sentinel for changes at this interval. |
+| passthroughClientErrorEvents | `false` | When `true`, error events from client instances inside the sentinel will be propagated to the sentinel instance. This allows handling all client errors through a single error handler on the sentinel instance. |
+| reserveClient | `false` | When `true`, one client will be reserved for the sentinel object. When `false`, the sentinel object will wait for the first available client from the pool. |
+
+## PubSub
+
+It supports PubSub via the normal mechanisms, including migrating the listeners if the node they are connected to goes down.
+
+```javascript
+await sentinel.subscribe('channel', message => {
+ // ...
+});
+await sentinel.unsubscribe('channel');
+```
+
+see [the PubSub guide](./pub-sub.md) for more details.
+
+## Sentinel as a pool
+
+The sentinel object provides the ability to manage a pool of clients for the master node:
+
+```javascript
+createSentinel({
+ // ...
+ masterPoolSize: 10
+});
+```
+
+In addition, it also provides the ability have a pool of clients connected to the replica nodes, and to direct all read-only commands to them:
+
+```javascript
+createSentinel({
+ // ...
+ replicaPoolSize: 10
+});
+```
+
+## Master client lease
+
+Sometimes multiple commands needs to run on an exclusive client (for example, using `WATCH/MULTI/EXEC`).
+
+There are 2 ways to get a client lease:
+
+`.use()`
+```javascript
+const result = await sentinel.use(async client => {
+ await client.watch('key');
+ return client.multi()
+ .get('key')
+ .exec();
+});
+```
+
+`.acquire()`
+```javascript
+const clientLease = await sentinel.acquire();
+
+try {
+ await clientLease.watch('key');
+ const resp = await clientLease.multi()
+ .get('key')
+ .exec();
+} finally {
+ clientLease.release();
+}
+```
diff --git a/docs/todo.md b/docs/todo.md
new file mode 100644
index 00000000000..49163444986
--- /dev/null
+++ b/docs/todo.md
@@ -0,0 +1,6 @@
+- "Isolation Pool" -> pool
+- Cluster request response policies (either implement, or block "server" commands in cluster)
+
+Docs:
+- [Command Options](./command-options.md)
+- [RESP](./RESP.md)
diff --git a/docs/transactions.md b/docs/transactions.md
new file mode 100644
index 00000000000..6331fef4be5
--- /dev/null
+++ b/docs/transactions.md
@@ -0,0 +1,53 @@
+# [Transactions](https://redis.io/docs/interact/transactions/) ([`MULTI`](https://redis.io/commands/multi/)/[`EXEC`](https://redis.io/commands/exec/))
+
+Start a [transaction](https://redis.io/docs/interact/transactions/) by calling `.multi()`, then chaining your commands. When you're done, call `.exec()` and you'll get an array back with your results:
+
+```javascript
+const [setReply, getReply] = await client.multi()
+ .set('key', 'value')
+ .get('another-key')
+ .exec();
+```
+
+## `exec<'typed'>()`/`execTyped()`
+
+A transaction invoked with `.exec<'typed'>`/`execTyped()` will return types appropriate to the commands in the transaction:
+
+```javascript
+const multi = client.multi().ping();
+await multi.exec(); // Array
+await multi.exec<'typed'>(); // [string]
+await multi.execTyped(); // [string]
+```
+
+> :warning: this only works when all the commands are invoked in a single "call chain"
+
+## [`WATCH`](https://redis.io/commands/watch/)
+
+You can also [watch](https://redis.io/docs/interact/transactions/#optimistic-locking-using-check-and-set) keys by calling `.watch()`. Your transaction will abort if any of the watched keys change or if the client reconnected between the `watch` and `exec` calls.
+
+The `WATCH` state is stored on the connection (by the server). In case you need to run multiple `WATCH` & `MULTI` in parallel you'll need to use a [pool](./pool.md).
+
+## `execAsPipeline`
+
+`execAsPipeline` will execute the commands without "wrapping" it with `MULTI` & `EXEC` (and lose the transactional semantics).
+
+```javascript
+await client.multi()
+ .get('a')
+ .get('b')
+ .execAsPipeline();
+```
+
+the diffrence between the above pipeline and `Promise.all`:
+
+```javascript
+await Promise.all([
+ client.get('a'),
+ client.get('b')
+]);
+```
+
+is that if the socket disconnects during the pipeline, any unwritten commands will be discarded. i.e. if the socket disconnects after `GET a` is written to the socket, but before `GET b` is:
+- using `Promise.all` - the client will try to execute `GET b` when the socket reconnects
+- using `execAsPipeline` - `GET b` promise will be rejected as well
diff --git a/docs/v3-to-v4.md b/docs/v3-to-v4.md
new file mode 100644
index 00000000000..0bf0d269b90
--- /dev/null
+++ b/docs/v3-to-v4.md
@@ -0,0 +1,87 @@
+# v3 to v4 Migration Guide
+
+Version 4 of Node Redis is a major refactor. While we have tried to maintain backwards compatibility where possible, several interfaces have changed. Read this guide to understand the differences and how to implement version 4 in your application.
+
+## All of the Breaking Changes
+
+See the [Change Log](../CHANGELOG.md).
+
+### Promises
+
+Node Redis now uses native [Promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) by default for all functions.
+
+### `createClient`
+
+The configuration object passed to `createClient` has changed significantly with this release. See the [client configuration guide](./client-configuration.md) for details.
+
+### No Auto Connect
+
+In V4, the client does not automatically connect to the server. Instead you need to run `.connect()` after creating the client or you will receive an error: `ClientClosedError: The client is closed`.
+
+```typescript
+import { createClient } from 'redis';
+
+const client = createClient();
+
+await client.connect();
+
+await client.ping();
+```
+
+### All the removed events
+
+The following events that existed in V3 were removed in V4:
+
+1. `warning`
+2. `subscribe`
+3. `psubscribe`
+4. `unsubscribe`
+5. `message`
+6. `message_buffer`
+7. `messageBuffer`
+8. `pmessage`
+9. `pmessage_buffer`
+10. `pmessageBuffer`
+11. `monitor`
+
+#### No `message`-like event
+
+In V4, you don't need to add a listener to the `message`-like events (items 5 to 10 of the above list), you can get the message directly in `subscribe`-like commands.
+
+The second argument of these commands is a callback, which will be triggered every time there is a message published to the channel.
+
+The third argument to these commands is a boolean to set `bufferMode` (default `false`). If it's set to `true` you will receive a buffer instead of a string.
+
+The `subscribe`-like commands return a promise. If the command is executed successfully the promise will be fulfilled, otherwise the promise will be rejected.
+
+```typescript
+import { createClient } from 'redis';
+
+const subscriber = createClient();
+
+await subscriber.connect();
+
+await subscriber.subscribe('channel_name', (message, channelName) => {
+ console.info(message, channelName);
+});
+```
+
+## Legacy Mode
+
+Use legacy mode to preserve the backwards compatibility of commands while still getting access to the updated experience:
+
+```typescript
+const client = createClient({
+ legacyMode: true
+});
+
+// legacy mode
+client.set('key', 'value', 'NX', (err, reply) => {
+ // ...
+});
+
+// version 4 interface is still accessible
+await client.v4.set('key', 'value', {
+ NX: true
+});
+```
diff --git a/docs/v4-to-v5.md b/docs/v4-to-v5.md
new file mode 100644
index 00000000000..fbe02e7c4d6
--- /dev/null
+++ b/docs/v4-to-v5.md
@@ -0,0 +1,245 @@
+# v4 to v5 migration guide
+
+## Client Configuration
+
+### Keep Alive
+
+To better align with Node.js build-in [`net`](https://nodejs.org/api/net.html) and [`tls`](https://nodejs.org/api/tls.html) modules, the `keepAlive` option has been split into 2 options: `keepAlive` (`boolean`) and `keepAliveInitialDelay` (`number`). The defaults remain `true` and `5000`.
+
+### Legacy Mode
+
+In the previous version, you could access "legacy" mode by creating a client and passing in `{ legacyMode: true }`. Now, you can create one off of an existing client by calling the `.legacy()` function. This allows easier access to both APIs and enables better TypeScript support.
+
+```javascript
+// use `client` for the current API
+const client = createClient();
+await client.set('key', 'value');
+
+// use `legacyClient` for the "legacy" API
+const legacyClient = client.legacy();
+legacyClient.set('key', 'value', (err, reply) => {
+ // ...
+});
+```
+
+## Command Options
+
+In v4, command options are passed as a first optional argument:
+
+```javascript
+await client.get('key'); // `string | null`
+await client.get(client.commandOptions({ returnBuffers: true }), 'key'); // `Buffer | null`
+```
+
+This has a couple of flaws:
+1. The argument types are checked in runtime, which is a performance hit.
+2. Code suggestions are less readable/usable, due to "function overloading".
+3. Overall, "user code" is not as readable as it could be.
+
+### The new API for v5
+
+With the new API, instead of passing the options directly to the commands we use a "proxy client" to store them:
+
+```javascript
+await client.get('key'); // `string | null`
+
+const proxyClient = client.withCommandOptions({
+ typeMapping: {
+ [TYPES.BLOB_STRING]: Buffer
+ }
+});
+
+await proxyClient.get('key'); // `Buffer | null`
+```
+
+for more information, see the [Command Options guide](./command-options.md).
+
+## Quit VS Disconnect
+
+The `QUIT` command has been deprecated in Redis 7.2 and should now also be considered deprecated in Node-Redis. Instead of sending a `QUIT` command to the server, the client can simply close the network connection.
+
+`client.QUIT/quit()` is replaced by `client.close()`. and, to avoid confusion, `client.disconnect()` has been renamed to `client.destroy()`.
+
+## Scan Iterators
+
+Iterator commands like `SCAN`, `HSCAN`, `SSCAN`, and `ZSCAN` return collections of elements (depending on the data type). However, v4 iterators loop over these collections and yield individual items:
+
+```javascript
+for await (const key of client.scanIterator()) {
+ console.log(key, await client.get(key));
+}
+```
+
+This mismatch can be awkward and makes "multi-key" commands like `MGET`, `UNLINK`, etc. pointless. So, in v5 the iterators now yield a collection instead of an element:
+
+```javascript
+for await (const keys of client.scanIterator()) {
+ // we can now meaningfully utilize "multi-key" commands
+ console.log(keys, await client.mGet(keys));
+}
+```
+
+for more information, see the [Scan Iterators guide](./scan-iterators.md).
+
+## Isolation Pool
+
+In v4, `RedisClient` had the ability to create a pool of connections using an "Isolation Pool" on top of the "main" connection. However, there was no way to use the pool without a "main" connection:
+```javascript
+const client = await createClient()
+ .on('error', err => console.error(err))
+ .connect();
+
+await client.ping(
+ client.commandOptions({ isolated: true })
+);
+```
+
+In v5 we've extracted this pool logic into its own classβ`RedisClientPool`:
+
+```javascript
+const pool = await createClientPool()
+ .on('error', err => console.error(err))
+ .connect();
+
+await pool.ping();
+```
+
+See the [pool guide](./pool.md) for more information.
+
+## Cluster `MULTI`
+
+In v4, `cluster.multi()` did not support executing commands on replicas, even if they were readonly.
+
+```javascript
+// this might execute on a replica, depending on configuration
+await cluster.sendCommand('key', true, ['GET', 'key']);
+
+// this always executes on a master
+await cluster.multi()
+ .addCommand('key', ['GET', 'key'])
+ .exec();
+```
+
+To support executing commands on replicas, `cluster.multi().addCommand` now requires `isReadonly` as the second argument, which matches the signature of `cluster.sendCommand`:
+
+```javascript
+await cluster.multi()
+ .addCommand('key', true, ['GET', 'key'])
+ .exec();
+```
+
+## `MULTI.execAsPipeline()`
+
+```javascript
+await client.multi()
+ .set('a', 'a')
+ .set('b', 'b')
+ .execAsPipeline();
+```
+
+In older versions, if the socket disconnects during the pipeline execution, i.e. after writing `SET a a` and before `SET b b`, the returned promise is rejected, but `SET b b` will still be executed on the server.
+
+In v5, any unwritten commands (in the same pipeline) will be discarded.
+
+- `RedisFlushModes` -> `REDIS_FLUSH_MODES` [^enum-to-constants]
+
+## Commands
+
+### Redis
+
+- `ACL GETUSER`: `selectors`
+- `COPY`: `destinationDb` -> `DB`, `replace` -> `REPLACE`, `boolean` -> `number` [^boolean-to-number]
+- `CLIENT KILL`: `enum ClientKillFilters` -> `const CLIENT_KILL_FILTERS` [^enum-to-constants]
+- `CLUSTER FAILOVER`: `enum FailoverModes` -> `const FAILOVER_MODES` [^enum-to-constants]
+- `CLIENT TRACKINGINFO`: `flags` in RESP2 - `Set` -> `Array` (to match RESP3 default type mapping)
+- `CLUSTER INFO`:
+- `CLUSTER SETSLOT`: `ClusterSlotStates` -> `CLUSTER_SLOT_STATES` [^enum-to-constants]
+- `CLUSTER RESET`: the second argument is `{ mode: string; }` instead of `string` [^future-proofing]
+- `CLUSTER FAILOVER`: `enum FailoverModes` -> `const FAILOVER_MODES` [^enum-to-constants], the second argument is `{ mode: string; }` instead of `string` [^future-proofing]
+- `CLUSTER LINKS`: `createTime` -> `create-time`, `sendBufferAllocated` -> `send-buffer-allocated`, `sendBufferUsed` -> `send-buffer-used` [^map-keys]
+- `CLUSTER NODES`, `CLUSTER REPLICAS`, `CLUSTER INFO`: returning the raw `VerbatimStringReply`
+- `EXPIRE`: `boolean` -> `number` [^boolean-to-number]
+- `EXPIREAT`: `boolean` -> `number` [^boolean-to-number]
+- `HSCAN`: `tuples` has been renamed to `entries`
+- `HEXISTS`: `boolean` -> `number` [^boolean-to-number]
+- `HRANDFIELD_COUNT_WITHVALUES`: `Record` -> `Array<{ field: BlobString; value: BlobString; }>` (it can return duplicates).
+- `HSETNX`: `boolean` -> `number` [^boolean-to-number]
+- `INFO`:
+- `LCS IDX`: `length` has been changed to `len`, `matches` has been changed from `Array<{ key1: RangeReply; key2: RangeReply; }>` to `Array<[key1: RangeReply, key2: RangeReply]>`
+
+
+- `ZINTER`: instead of `client.ZINTER('key', { WEIGHTS: [1] })` use `client.ZINTER({ key: 'key', weight: 1 }])`
+- `ZINTER_WITHSCORES`: instead of `client.ZINTER_WITHSCORES('key', { WEIGHTS: [1] })` use `client.ZINTER_WITHSCORES({ key: 'key', weight: 1 }])`
+- `ZUNION`: instead of `client.ZUNION('key', { WEIGHTS: [1] })` use `client.ZUNION({ key: 'key', weight: 1 }])`
+- `ZUNION_WITHSCORES`: instead of `client.ZUNION_WITHSCORES('key', { WEIGHTS: [1] })` use `client.ZUNION_WITHSCORES({ key: 'key', weight: 1 }])`
+- `ZMPOP`: `{ elements: Array<{ member: string; score: number; }>; }` -> `{ members: Array<{ value: string; score: number; }>; }` to match other sorted set commands (e.g. `ZRANGE`, `ZSCAN`)
+
+- `MOVE`: `boolean` -> `number` [^boolean-to-number]
+- `PEXPIRE`: `boolean` -> `number` [^boolean-to-number]
+- `PEXPIREAT`: `boolean` -> `number` [^boolean-to-number]
+- `PFADD`: `boolean` -> `number` [^boolean-to-number]
+
+- `RENAMENX`: `boolean` -> `number` [^boolean-to-number]
+- `SETNX`: `boolean` -> `number` [^boolean-to-number]
+- `SCAN`, `HSCAN`, `SSCAN`, and `ZSCAN`: `reply.cursor` will not be converted to number to avoid issues when the number is bigger than `Number.MAX_SAFE_INTEGER`. See [here](https://github.com/redis/node-redis/issues/2561).
+- `SCRIPT EXISTS`: `Array` -> `Array` [^boolean-to-number]
+- `SISMEMBER`: `boolean` -> `number` [^boolean-to-number]
+- `SMISMEMBER`: `Array` -> `Array` [^boolean-to-number]
+- `SMOVE`: `boolean` -> `number` [^boolean-to-number]
+
+- `GEOSEARCH_WITH`/`GEORADIUS_WITH`: `GeoReplyWith` -> `GEO_REPLY_WITH` [^enum-to-constants]
+- `GEORADIUSSTORE` -> `GEORADIUS_STORE`
+- `GEORADIUSBYMEMBERSTORE` -> `GEORADIUSBYMEMBER_STORE`
+- `XACK`: `boolean` -> `number` [^boolean-to-number]
+- `XADD`: the `INCR` option has been removed, use `XADD_INCR` instead
+- `LASTSAVE`: `Date` -> `number` (unix timestamp)
+- `HELLO`: `protover` moved from the options object to it's own argument, `auth` -> `AUTH`, `clientName` -> `SETNAME`
+- `MODULE LIST`: `version` -> `ver` [^map-keys]
+- `MEMORY STATS`: [^map-keys]
+- `FUNCTION RESTORE`: the second argument is `{ mode: string; }` instead of `string` [^future-proofing]
+- `FUNCTION STATS`: `runningScript` -> `running_script`, `durationMs` -> `duration_ms`, `librariesCount` -> `libraries_count`, `functionsCount` -> `functions_count` [^map-keys]
+
+- `TIME`: `Date` -> `[unixTimestamp: string, microseconds: string]`
+
+- `XGROUP_CREATECONSUMER`: [^boolean-to-number]
+- `XGROUP_DESTROY`: [^boolean-to-number]
+- `XINFO GROUPS`: `lastDeliveredId` -> `last-delivered-id` [^map-keys]
+- `XINFO STREAM`: `radixTreeKeys` -> `radix-tree-keys`, `radixTreeNodes` -> `radix-tree-nodes`, `lastGeneratedId` -> `last-generated-id`, `maxDeletedEntryId` -> `max-deleted-entry-id`, `entriesAdded` -> `entries-added`, `recordedFirstEntryId` -> `recorded-first-entry-id`, `firstEntry` -> `first-entry`, `lastEntry` -> `last-entry`
+- `XAUTOCLAIM`, `XCLAIM`, `XRANGE`, `XREVRANGE`: `Array<{ name: string; messages: Array<{ id: string; message: Record }>; }>` -> `Record }>>`
+
+- `COMMAND LIST`: `enum FilterBy` -> `const COMMAND_LIST_FILTER_BY` [^enum-to-constants], the filter argument has been moved from a "top level argument" into ` { FILTERBY: { type: ; value: } }`
+
+### Bloom
+
+- `TOPK.QUERY`: `Array` -> `Array`
+
+### JSON
+
+- `JSON.ARRINDEX`: `start` and `end` arguments moved to `{ range: { start: number; end: number; }; }` [^future-proofing]
+- `JSON.ARRPOP`: `path` and `index` arguments moved to `{ path: string; index: number; }` [^future-proofing]
+- `JSON.ARRLEN`, `JSON.CLEAR`, `JSON.DEBUG MEMORY`, `JSON.DEL`, `JSON.FORGET`, `JSON.OBJKEYS`, `JSON.OBJLEN`, `JSON.STRAPPEND`, `JSON.STRLEN`, `JSON.TYPE`: `path` argument moved to `{ path: string; }` [^future-proofing]
+
+### Search
+
+- `FT.SUGDEL`: [^boolean-to-number]
+- `FT.CURSOR READ`: `cursor` type changed from `number` to `string` (in and out) to avoid issues when the number is bigger than `Number.MAX_SAFE_INTEGER`. See [here](https://github.com/redis/node-redis/issues/2561).
+- `AggregateGroupByReducers` -> `FT_AGGREGATE_GROUP_BY_REDUCERS` [^enum-to-constants]
+- `AggregateSteps` -> `FT_AGGREGATE_STEPS` [^enum-to-constants]
+- `RedisSearchLanguages` -> `REDISEARCH_LANGUAGE` [^enum-to-constants]
+- `SchemaFieldTypes` -> `SCHEMA_FIELD_TYPE` [^enum-to-constants]
+- `SchemaTextFieldPhonetics` -> `SCHEMA_TEXT_FIELD_PHONETIC` [^enum-to-constants]
+- `SearchOptions` -> `FtSearchOptions`
+- `VectorAlgorithms` -> `SCHEMA_VECTOR_FIELD_ALGORITHM` [^enum-to-constants]
+
+### Time Series
+
+- `TS.ADD`: `boolean` -> `number` [^boolean-to-number]
+- `TS.[M][REV]RANGE`: the `ALIGN` argument has been moved into `AGGREGATION`
+- `TS.SYNUPDATE`: `Array>` -> `Record>`
+- `TimeSeriesDuplicatePolicies` -> `TIME_SERIES_DUPLICATE_POLICIES` [^enum-to-constants]
+- `TimeSeriesEncoding` -> `TIME_SERIES_ENCODING` [^enum-to-constants]
+- `TimeSeriesAggregationType` -> `TIME_SERIES_AGGREGATION_TYPE` [^enum-to-constants]
+- `TimeSeriesReducers` -> `TIME_SERIES_REDUCERS` [^enum-to-constants]
+- `TimeSeriesBucketTimestamp` -> `TIME_SERIES_BUCKET_TIMESTAMP` [^enum-to-constants]
+
+[^map-keys]: To avoid unnecessary transformations and confusion, map keys will not be transformed to "js friendly" names (i.e. `number-of-keys` will not be renamed to `numberOfKeys`). See [here](https://github.com/redis/node-redis/discussions/2506).
diff --git a/docs/v5.md b/docs/v5.md
new file mode 100644
index 00000000000..15ef67c14ee
--- /dev/null
+++ b/docs/v5.md
@@ -0,0 +1,188 @@
+# RESP3 Support
+
+Node Redis v5 adds support for [RESP3](https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md), the new Redis serialization protocol. RESP3 offers richer data types and improved type handling compared to RESP2.
+
+To use RESP3, specify it when creating your client:
+
+```javascript
+import { createClient } from 'redis';
+
+const client = createClient({
+ RESP: 3
+});
+```
+
+## Type Mapping
+
+With RESP3, you can leverage the protocol's richer type system. You can customize how different Redis types are represented in JavaScript using type mapping:
+
+```javascript
+import { createClient, RESP_TYPES } from 'redis';
+
+// By default
+await client.hGetAll('key'); // Record
+
+// Use Map instead of plain object
+await client.withTypeMapping({
+ [RESP_TYPES.MAP]: Map
+}).hGetAll('key'); // Map
+
+// Use both Map and Buffer
+await client.withTypeMapping({
+ [RESP_TYPES.MAP]: Map,
+ [RESP_TYPES.BLOB_STRING]: Buffer
+}).hGetAll('key'); // Map
+```
+
+This replaces the previous approach of using `commandOptions({ returnBuffers: true })` in v4.
+
+## PubSub in RESP3
+
+RESP3 uses a different mechanism for handling Pub/Sub messages. Instead of modifying the `onReply` handler as in RESP2, RESP3 provides a dedicated `onPush` handler. When using RESP3, the client automatically uses this more efficient push notification system.
+
+## Known Limitations
+
+### Unstable Commands
+
+Some Redis commands have unstable RESP3 transformations. These commands will throw an error when used with RESP3 unless you explicitly opt in to using them by setting `unstableResp3: true` in your client configuration:
+
+```javascript
+const client = createClient({
+ RESP: 3,
+ unstableResp3: true
+});
+```
+
+The following commands have unstable RESP3 implementations:
+
+1. **Stream Commands**:
+ - `XREAD` and `XREADGROUP` - The response format differs between RESP2 and RESP3
+
+2. **Search Commands (RediSearch)**:
+ - `FT.AGGREGATE`
+ - `FT.AGGREGATE_WITHCURSOR`
+ - `FT.CURSOR_READ`
+ - `FT.INFO`
+ - `FT.PROFILE_AGGREGATE`
+ - `FT.PROFILE_SEARCH`
+ - `FT.SEARCH`
+ - `FT.SEARCH_NOCONTENT`
+ - `FT.SPELLCHECK`
+
+3. **Time Series Commands**:
+ - `TS.INFO`
+ - `TS.INFO_DEBUG`
+
+If you need to use these commands with RESP3, be aware that the response format might change in future versions.
+
+# Sentinel Support
+
+[Sentinel](./sentinel.md)
+
+# `multi.exec<'typed'>` / `multi.execTyped`
+
+We have introduced the ability to perform a "typed" `MULTI`/`EXEC` transaction. Rather than returning `Array`, a transaction invoked with `.exec<'typed'>` will return types appropriate to the commands in the transaction where possible:
+
+```javascript
+const multi = client.multi().ping();
+await multi.exec(); // Array
+await multi.exec<'typed'>(); // [string]
+await multi.execTyped(); // [string]
+```
+
+# Client Side Caching
+
+Node Redis v5 adds support for [Client Side Caching](https://redis.io/docs/manual/client-side-caching/), which enables clients to cache query results locally. The server will notify the client when cached results are no longer valid.
+
+Client Side Caching is only supported with RESP3.
+
+## Usage
+
+There are two ways to implement client side caching:
+
+### Anonymous Cache
+
+```javascript
+const client = createClient({
+ RESP: 3,
+ clientSideCache: {
+ ttl: 0, // Time-to-live in milliseconds (0 = no expiration)
+ maxEntries: 0, // Maximum entries to store (0 = unlimited)
+ evictPolicy: "LRU" // Eviction policy: "LRU" or "FIFO"
+ }
+});
+```
+
+In this instance, the cache is managed internally by the client.
+
+### Controllable Cache
+
+```javascript
+import { BasicClientSideCache } from 'redis';
+
+const cache = new BasicClientSideCache({
+ ttl: 0,
+ maxEntries: 0,
+ evictPolicy: "LRU"
+});
+
+const client = createClient({
+ RESP: 3,
+ clientSideCache: cache
+});
+```
+
+With this approach, you have direct access to the cache object for more control:
+
+```javascript
+// Manually invalidate keys
+cache.invalidate(key);
+
+// Clear the entire cache
+cache.clear();
+
+// Get cache metrics
+// `cache.stats()` returns a `CacheStats` object with comprehensive statistics.
+const statistics = cache.stats();
+
+// Key metrics:
+const hits = statistics.hitCount; // Number of cache hits
+const misses = statistics.missCount; // Number of cache misses
+const hitRate = statistics.hitRate(); // Cache hit rate (0.0 to 1.0)
+
+// Many other metrics are available on the `statistics` object, e.g.:
+// statistics.missRate(), statistics.loadSuccessCount,
+// statistics.averageLoadPenalty(), statistics.requestCount()
+```
+
+## Pooled Caching
+
+Client side caching also works with client pools. For pooled clients, the cache is shared across all clients in the pool:
+
+```javascript
+const client = createClientPool({RESP: 3}, {
+ clientSideCache: {
+ ttl: 0,
+ maxEntries: 0,
+ evictPolicy: "LRU"
+ },
+ minimum: 5
+});
+```
+
+For a controllable pooled cache:
+
+```javascript
+import { BasicPooledClientSideCache } from 'redis';
+
+const cache = new BasicPooledClientSideCache({
+ ttl: 0,
+ maxEntries: 0,
+ evictPolicy: "LRU"
+});
+
+const client = createClientPool({RESP: 3}, {
+ clientSideCache: cache,
+ minimum: 5
+});
+```
diff --git a/doctests/README.md b/doctests/README.md
new file mode 100644
index 00000000000..59d1cb0364c
--- /dev/null
+++ b/doctests/README.md
@@ -0,0 +1,32 @@
+# Command examples for redis.io
+
+## Setup
+
+To set up the examples folder so that you can run an example / develop one of your own:
+
+```
+$ git clone https://github.com/redis/node-redis.git
+$ cd node-redis
+$ npm install -ws && npm run build
+$ cd doctests
+$ npm install
+```
+
+## How to add examples
+
+Create regular node file in the current folder with meaningful name. It makes sense prefix example files with
+command category (e.g. string, set, list, hash, etc) to make navigation in the folder easier.
+
+### Special markup
+
+See https://github.com/redis-stack/redis-stack-website#readme for more details.
+
+## How to test the examples
+
+Just include necessary assertions in the example file and run
+```bash
+sh doctests/run_examples.sh
+```
+to test all examples in the current folder.
+
+See `tests.js` for more details.
diff --git a/doctests/cmds-cnxmgmt.js b/doctests/cmds-cnxmgmt.js
new file mode 100644
index 00000000000..8b616b6f105
--- /dev/null
+++ b/doctests/cmds-cnxmgmt.js
@@ -0,0 +1,49 @@
+// EXAMPLE: cmds_cnxmgmt
+// REMOVE_START
+import assert from "node:assert";
+// REMOVE_END
+
+// HIDE_START
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect().catch(console.error);
+// HIDE_END
+
+// STEP_START auth1
+// REMOVE_START
+await client.sendCommand(['CONFIG', 'SET', 'requirepass', 'temp_pass']);
+// REMOVE_END
+const res1 = await client.auth({ password: 'temp_pass' });
+console.log(res1); // OK
+
+const res2 = await client.auth({ username: 'default', password: 'temp_pass' });
+console.log(res2); // OK
+
+// REMOVE_START
+assert.equal(res1, "OK");
+assert.equal(res2, "OK");
+await client.sendCommand(['CONFIG', 'SET', 'requirepass', '']);
+// REMOVE_END
+// STEP_END
+
+// STEP_START auth2
+// REMOVE_START
+await client.sendCommand([
+ 'ACL', 'SETUSER', 'test-user',
+ 'on', '>strong_password', '+acl'
+]);
+// REMOVE_END
+const res3 = await client.auth({ username: 'test-user', password: 'strong_password' });
+console.log(res3); // OK
+
+// REMOVE_START
+assert.equal(res3, "OK");
+await client.auth({ username: 'default', password: '' })
+await client.sendCommand(['ACL', 'DELUSER', 'test-user']);
+// REMOVE_END
+// STEP_END
+
+// HIDE_START
+await client.close();
+// HIDE_END
diff --git a/doctests/cmds-generic.js b/doctests/cmds-generic.js
new file mode 100644
index 00000000000..50329ede460
--- /dev/null
+++ b/doctests/cmds-generic.js
@@ -0,0 +1,195 @@
+// EXAMPLE: cmds_generic
+// REMOVE_START
+import assert from "node:assert";
+// REMOVE_END
+
+// HIDE_START
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect().catch(console.error);
+// HIDE_END
+
+// STEP_START del
+const delRes1 = await client.set('key1', 'Hello');
+console.log(delRes1); // OK
+
+const delRes2 = await client.set('key2', 'World');
+console.log(delRes2); // OK
+
+const delRes3 = await client.del(['key1', 'key2', 'key3']);
+console.log(delRes3); // 2
+// REMOVE_START
+assert.equal(delRes3, 2);
+// REMOVE_END
+// STEP_END
+
+// STEP_START expire
+const expireRes1 = await client.set('mykey', 'Hello');
+console.log(expireRes1); // OK
+
+const expireRes2 = await client.expire('mykey', 10);
+console.log(expireRes2); // 1
+
+const expireRes3 = await client.ttl('mykey');
+console.log(expireRes3); // 10
+// REMOVE_START
+assert.equal(expireRes3, 10);
+// REMOVE_END
+
+const expireRes4 = await client.set('mykey', 'Hello World');
+console.log(expireRes4); // OK
+
+const expireRes5 = await client.ttl('mykey');
+console.log(expireRes5); // -1
+// REMOVE_START
+assert.equal(expireRes5, -1);
+// REMOVE_END
+
+const expireRes6 = await client.expire('mykey', 10, "XX");
+console.log(expireRes6); // 0
+// REMOVE_START
+assert.equal(expireRes6, 0)
+// REMOVE_END
+
+const expireRes7 = await client.ttl('mykey');
+console.log(expireRes7); // -1
+// REMOVE_START
+assert.equal(expireRes7, -1);
+// REMOVE_END
+
+const expireRes8 = await client.expire('mykey', 10, "NX");
+console.log(expireRes8); // 1
+// REMOVE_START
+assert.equal(expireRes8, 1);
+// REMOVE_END
+
+const expireRes9 = await client.ttl('mykey');
+console.log(expireRes9); // 10
+// REMOVE_START
+assert.equal(expireRes9, 10);
+await client.del('mykey');
+// REMOVE_END
+// STEP_END
+
+// STEP_START ttl
+const ttlRes1 = await client.set('mykey', 'Hello');
+console.log(ttlRes1); // OK
+
+const ttlRes2 = await client.expire('mykey', 10);
+console.log(ttlRes2); // 1
+
+const ttlRes3 = await client.ttl('mykey');
+console.log(ttlRes3); // 10
+// REMOVE_START
+assert.equal(ttlRes3, 10);
+await client.del('mykey');
+// REMOVE_END
+// STEP_END
+
+// STEP_START scan1
+const scan1Res1 = await client.sAdd('myset', ['1', '2', '3', 'foo', 'foobar', 'feelsgood']);
+console.log(scan1Res1); // 6
+
+let scan1Res2 = [];
+for await (const values of client.sScanIterator('myset', { MATCH: 'f*' })) {
+ scan1Res2 = scan1Res2.concat(values);
+}
+console.log(scan1Res2); // ['foo', 'foobar', 'feelsgood']
+// REMOVE_START
+console.assert(scan1Res2.sort().toString() === ['foo', 'foobar', 'feelsgood'].sort().toString());
+await client.del('myset');
+// REMOVE_END
+// STEP_END
+
+// STEP_START scan2
+// REMOVE_START
+for (let i = 1; i <= 1000; i++) {
+ await client.set(`key:${i}`, i);
+}
+// REMOVE_END
+let cursor = '0';
+let scanResult;
+
+scanResult = await client.scan(cursor, { MATCH: '*11*' });
+console.log(scanResult.cursor, scanResult.keys);
+
+scanResult = await client.scan(scanResult.cursor, { MATCH: '*11*' });
+console.log(scanResult.cursor, scanResult.keys);
+
+scanResult = await client.scan(scanResult.cursor, { MATCH: '*11*' });
+console.log(scanResult.cursor, scanResult.keys);
+
+scanResult = await client.scan(scanResult.cursor, { MATCH: '*11*' });
+console.log(scanResult.cursor, scanResult.keys);
+
+scanResult = await client.scan(scanResult.cursor, { MATCH: '*11*', COUNT: 1000 });
+console.log(scanResult.cursor, scanResult.keys);
+// REMOVE_START
+console.assert(scanResult.keys.length === 18);
+cursor = '0';
+const prefix = 'key:*';
+do {
+ scanResult = await client.scan(cursor, { MATCH: prefix, COUNT: 1000 });
+ console.log(scanResult.cursor, scanResult.keys);
+ cursor = scanResult.cursor;
+ const keys = scanResult.keys;
+ if (keys.length) {
+ await client.del(keys);
+ }
+} while (cursor !== '0');
+// REMOVE_END
+// STEP_END
+
+// STEP_START scan3
+const scan3Res1 = await client.geoAdd('geokey', { longitude: 0, latitude: 0, member: 'value' });
+console.log(scan3Res1); // 1
+
+const scan3Res2 = await client.zAdd('zkey', [{ score: 1000, value: 'value' }]);
+console.log(scan3Res2); // 1
+
+const scan3Res3 = await client.type('geokey');
+console.log(scan3Res3); // zset
+// REMOVE_START
+console.assert(scan3Res3 === 'zset');
+// REMOVE_END
+
+const scan3Res4 = await client.type('zkey');
+console.log(scan3Res4); // zset
+// REMOVE_START
+console.assert(scan3Res4 === 'zset');
+// REMOVE_END
+
+const scan3Res5 = await client.scan('0', { TYPE: 'zset' });
+console.log(scan3Res5.keys); // ['zkey', 'geokey']
+// REMOVE_START
+console.assert(scan3Res5.keys.sort().toString() === ['zkey', 'geokey'].sort().toString());
+await client.del(['geokey', 'zkey']);
+// REMOVE_END
+// STEP_END
+
+// STEP_START scan4
+const scan4Res1 = await client.hSet('myhash', { a: 1, b: 2 });
+console.log(scan4Res1); // 2
+
+const scan4Res2 = await client.hScan('myhash', '0');
+console.log(scan4Res2.entries); // [{field: 'a', value: '1'}, {field: 'b', value: '2'}]
+// REMOVE_START
+assert.deepEqual(scan4Res2.entries, [
+ { field: 'a', value: '1' },
+ { field: 'b', value: '2' }
+]);
+// REMOVE_END
+
+const scan4Res3 = await client.hScan('myhash', '0', { COUNT: 10 });
+const items = scan4Res3.entries.map((item) => item.field)
+console.log(items); // ['a', 'b']
+// REMOVE_START
+assert.deepEqual(items, ['a', 'b'])
+await client.del('myhash');
+// REMOVE_END
+// STEP_END
+
+// HIDE_START
+await client.close();
+// HIDE_END
diff --git a/doctests/cmds-hash.js b/doctests/cmds-hash.js
new file mode 100644
index 00000000000..8ce29785763
--- /dev/null
+++ b/doctests/cmds-hash.js
@@ -0,0 +1,109 @@
+// EXAMPLE: cmds_hash
+// HIDE_START
+import assert from 'node:assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect().catch(console.error);
+// HIDE_END
+
+// STEP_START hset
+const res1 = await client.hSet('myhash', 'field1', 'Hello')
+console.log(res1) // 1
+
+const res2 = await client.hGet('myhash', 'field1')
+console.log(res2) // Hello
+
+const res3 = await client.hSet(
+ 'myhash',
+ {
+ 'field2': 'Hi',
+ 'field3': 'World'
+ }
+)
+console.log(res3) // 2
+
+const res4 = await client.hGet('myhash', 'field2')
+console.log(res4) // Hi
+
+const res5 = await client.hGet('myhash', 'field3')
+console.log(res5) // World
+
+const res6 = await client.hGetAll('myhash')
+console.log(res6)
+
+// REMOVE_START
+assert.equal(res1, 1);
+assert.equal(res2, 'Hello');
+assert.equal(res3, 2);
+assert.equal(res4, 'Hi');
+assert.equal(res5, 'World');
+assert.deepEqual(res6, {
+ field1: 'Hello',
+ field2: 'Hi',
+ field3: 'World'
+});
+await client.del('myhash')
+// REMOVE_END
+// STEP_END
+
+// STEP_START hget
+const res7 = await client.hSet('myhash', 'field1', 'foo')
+console.log(res7) // 1
+
+const res8 = await client.hGet('myhash', 'field1')
+console.log(res8) // foo
+
+const res9 = await client.hGet('myhash', 'field2')
+console.log(res9) // null
+
+// REMOVE_START
+assert.equal(res7, 1);
+assert.equal(res8, 'foo');
+assert.equal(res9, null);
+await client.del('myhash')
+// REMOVE_END
+// STEP_END
+
+// STEP_START hgetall
+const res10 = await client.hSet(
+ 'myhash',
+ {
+ 'field1': 'Hello',
+ 'field2': 'World'
+ }
+)
+
+const res11 = await client.hGetAll('myhash')
+console.log(res11) // [Object: null prototype] { field1: 'Hello', field2: 'World' }
+
+// REMOVE_START
+assert.deepEqual(res11, {
+ field1: 'Hello',
+ field2: 'World'
+});
+await client.del('myhash')
+// REMOVE_END
+// STEP_END
+
+// STEP_START hvals
+const res12 = await client.hSet(
+ 'myhash',
+ {
+ 'field1': 'Hello',
+ 'field2': 'World'
+ }
+)
+
+const res13 = await client.hVals('myhash')
+console.log(res13) // [ 'Hello', 'World' ]
+
+// REMOVE_START
+assert.deepEqual(res13, [ 'Hello', 'World' ]);
+await client.del('myhash')
+// REMOVE_END
+// STEP_END
+
+// HIDE_START
+await client.close();
+// HIDE_END
diff --git a/doctests/cmds-list.js b/doctests/cmds-list.js
new file mode 100644
index 00000000000..9d1b4154dfe
--- /dev/null
+++ b/doctests/cmds-list.js
@@ -0,0 +1,129 @@
+// EXAMPLE: cmds_list
+// HIDE_START
+import assert from 'node:assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect().catch(console.error);
+// HIDE_END
+
+// STEP_START lpush
+const res1 = await client.lPush('mylist', 'world');
+console.log(res1); // 1
+
+const res2 = await client.lPush('mylist', 'hello');
+console.log(res2); // 2
+
+const res3 = await client.lRange('mylist', 0, -1);
+console.log(res3); // [ 'hello', 'world' ]
+
+// REMOVE_START
+assert.deepEqual(res3, [ 'hello', 'world' ]);
+await client.del('mylist');
+// REMOVE_END
+// STEP_END
+
+// STEP_START lrange
+const res4 = await client.rPush('mylist', 'one');
+console.log(res4); // 1
+
+const res5 = await client.rPush('mylist', 'two');
+console.log(res5); // 2
+
+const res6 = await client.rPush('mylist', 'three');
+console.log(res6); // 3
+
+const res7 = await client.lRange('mylist', 0, 0);
+console.log(res7); // [ 'one' ]
+
+const res8 = await client.lRange('mylist', -3, 2);
+console.log(res8); // [ 'one', 'two', 'three' ]
+
+const res9 = await client.lRange('mylist', -100, 100);
+console.log(res9); // [ 'one', 'two', 'three' ]
+
+const res10 = await client.lRange('mylist', 5, 10);
+console.log(res10); // []
+
+// REMOVE_START
+assert.deepEqual(res7, [ 'one' ]);
+assert.deepEqual(res8, [ 'one', 'two', 'three' ]);
+assert.deepEqual(res9, [ 'one', 'two', 'three' ]);
+assert.deepEqual(res10, []);
+await client.del('mylist');
+// REMOVE_END
+// STEP_END
+
+// STEP_START llen
+const res11 = await client.lPush('mylist', 'World');
+console.log(res11); // 1
+
+const res12 = await client.lPush('mylist', 'Hello');
+console.log(res12); // 2
+
+const res13 = await client.lLen('mylist');
+console.log(res13); // 2
+
+// REMOVE_START
+assert.equal(res13, 2);
+await client.del('mylist');
+// REMOVE_END
+// STEP_END
+
+// STEP_START rpush
+const res14 = await client.rPush('mylist', 'hello');
+console.log(res14); // 1
+
+const res15 = await client.rPush('mylist', 'world');
+console.log(res15); // 2
+
+const res16 = await client.lRange('mylist', 0, -1);
+console.log(res16); // [ 'hello', 'world' ]
+
+// REMOVE_START
+assert.deepEqual(res16, [ 'hello', 'world' ]);
+await client.del('mylist');
+// REMOVE_END
+// STEP_END
+
+// STEP_START lpop
+const res17 = await client.rPush('mylist', ["one", "two", "three", "four", "five"]);
+console.log(res17); // 5
+
+const res18 = await client.lPop('mylist');
+console.log(res18); // 'one'
+
+const res19 = await client.lPopCount('mylist', 2);
+console.log(res19); // [ 'two', 'three' ]
+
+const res20 = await client.lRange('mylist', 0, -1);
+console.log(res20); // [ 'four', 'five' ]
+
+// REMOVE_START
+assert.deepEqual(res20, [ 'four', 'five' ]);
+await client.del('mylist');
+// REMOVE_END
+// STEP_END
+
+// STEP_START rpop
+const res21 = await client.rPush('mylist', ["one", "two", "three", "four", "five"]);
+console.log(res21); // 5
+
+const res22 = await client.rPop('mylist');
+console.log(res22); // 'five'
+
+const res23 = await client.rPopCount('mylist', 2);
+console.log(res23); // [ 'four', 'three' ]
+
+const res24 = await client.lRange('mylist', 0, -1);
+console.log(res24); // [ 'one', 'two' ]
+
+// REMOVE_START
+assert.deepEqual(res24, [ 'one', 'two' ]);
+await client.del('mylist');
+// REMOVE_END
+// STEP_END
+
+// HIDE_START
+await client.close();
+// HIDE_END
diff --git a/doctests/cmds-servermgmt.js b/doctests/cmds-servermgmt.js
new file mode 100644
index 00000000000..0a53e05919d
--- /dev/null
+++ b/doctests/cmds-servermgmt.js
@@ -0,0 +1,45 @@
+// EXAMPLE: cmds_servermgmt
+// REMOVE_START
+import assert from 'node:assert';
+// REMOVE_END
+
+// HIDE_START
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect().catch(console.error);
+// HIDE_END
+
+// STEP_START flushall
+// REMOVE_START
+await client.set('foo', '1');
+await client.set('bar', '2');
+await client.set('baz', '3');
+// REMOVE_END
+const res1 = await client.flushAll('SYNC'); // or ASYNC
+console.log(res1); // OK
+
+const res2 = await client.keys('*');
+console.log(res2); // []
+
+// REMOVE_START
+assert.equal(res1, 'OK');
+assert.deepEqual(res2, []);
+// REMOVE_END
+// STEP_END
+
+// STEP_START info
+const res3 = await client.info();
+console.log(res3)
+// # Server
+// redis_version:7.4.0
+// redis_git_sha1:c9d29f6a
+// redis_git_dirty:0
+// redis_build_id:4c367a16e3f9616
+// redis_mode:standalone
+// ...
+// STEP_END
+
+// HIDE_START
+await client.close();
+// HIDE_END
diff --git a/doctests/cmds-set.js b/doctests/cmds-set.js
new file mode 100644
index 00000000000..8a9a3837036
--- /dev/null
+++ b/doctests/cmds-set.js
@@ -0,0 +1,44 @@
+// EXAMPLE: cmds_set
+// REMOVE_START
+import assert from 'node:assert';
+// REMOVE_END
+
+// HIDE_START
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect().catch(console.error);
+// HIDE_END
+
+// STEP_START sadd
+const res1 = await client.sAdd('myset', ['Hello', 'World']);
+console.log(res1); // 2
+
+const res2 = await client.sAdd('myset', ['World']);
+console.log(res2); // 0
+
+const res3 = await client.sMembers('myset')
+console.log(res3); // ['Hello', 'World']
+
+// REMOVE_START
+assert.deepEqual(res3, ['Hello', 'World']);
+await client.del('myset');
+// REMOVE_END
+// STEP_END
+
+// STEP_START smembers
+const res4 = await client.sAdd('myset', ['Hello', 'World']);
+console.log(res4); // 2
+
+const res5 = await client.sMembers('myset')
+console.log(res5); // ['Hello', 'World']
+
+// REMOVE_START
+assert.deepEqual(res5, ['Hello', 'World']);
+await client.del('myset');
+// REMOVE_END
+// STEP_END
+
+// HIDE_START
+await client.close();
+// HIDE_END
diff --git a/doctests/cmds-sorted-set.js b/doctests/cmds-sorted-set.js
new file mode 100644
index 00000000000..b718938cc2b
--- /dev/null
+++ b/doctests/cmds-sorted-set.js
@@ -0,0 +1,115 @@
+// EXAMPLE: cmds_sorted_set
+// REMOVE_START
+import assert from "node:assert";
+// REMOVE_END
+
+// HIDE_START
+import { createClient } from 'redis';
+
+const client = createClient();
+client.on('error', err => console.log('Redis Client Error', err));
+await client.connect().catch(console.error);
+// HIDE_END
+
+// STEP_START zadd
+const val1 = await client.zAdd("myzset", [{ value: 'one', score: 1 }]);
+console.log(val1);
+// returns 1
+
+const val2 = await client.zAdd("myzset", [{ value: 'uno', score: 1 }]);
+console.log(val2);
+// returns 1
+
+const val3 = await client.zAdd("myzset", [{ value: 'two', score: 2 }, { value: 'three', score: 3 }]);
+console.log(val3);
+// returns 2
+
+const val4 = await client.zRangeWithScores("myzset", 0, -1);
+console.log(val4);
+// returns [{value: 'one', score: 1}, {value: 'uno', score: 1}, {value: 'two', score: 2}, {value: 'three', score: 3} ]
+
+// REMOVE_START
+assert.equal(val1, 1);
+assert.equal(val2, 1);
+assert.equal(val3, 2);
+assert.deepEqual(val4, [
+ { value: 'one', score: 1 },
+ { value: 'uno', score: 1 },
+ { value: 'two', score: 2 },
+ { value: 'three', score: 3 }
+]);
+await client.del('myzset');
+// REMOVE_END
+// STEP_END
+
+// STEP_START zrange1
+const val5 = await client.zAdd("myzset", [
+ { value: 'one', score: 1 },
+ { value: 'two', score: 2 },
+ { value: 'three', score: 3 }
+]);
+console.log(val5);
+// returns 3
+
+const val6 = await client.zRange('myzset', 0, -1);
+console.log(val6);
+// returns ['one', 'two', 'three']
+// REMOVE_START
+console.assert(JSON.stringify(val6) === JSON.stringify(['one', 'two', 'three']));
+// REMOVE_END
+
+const val7 = await client.zRange('myzset', 2, 3);
+console.log(val7);
+// returns ['three']
+// REMOVE_START
+console.assert(JSON.stringify(val7) === JSON.stringify(['three']));
+// REMOVE_END
+
+const val8 = await client.zRange('myzset', -2, -1);
+console.log(val8);
+// returns ['two', 'three']
+// REMOVE_START
+console.assert(JSON.stringify(val8) === JSON.stringify(['two', 'three']));
+await client.del('myzset');
+// REMOVE_END
+// STEP_END
+
+// STEP_START zrange2
+const val9 = await client.zAdd("myzset", [
+ { value: 'one', score: 1 },
+ { value: 'two', score: 2 },
+ { value: 'three', score: 3 }
+]);
+console.log(val9);
+// returns 3
+
+const val10 = await client.zRangeWithScores('myzset', 0, 1);
+console.log(val10);
+// returns [{value: 'one', score: 1}, {value: 'two', score: 2}]
+// REMOVE_START
+console.assert(JSON.stringify(val10) === JSON.stringify([{value: 'one', score: 1}, {value: 'two', score: 2}]));
+await client.del('myzset');
+// REMOVE_END
+// STEP_END
+
+// STEP_START zrange3
+const val11 = await client.zAdd("myzset", [
+ { value: 'one', score: 1 },
+ { value: 'two', score: 2 },
+ { value: 'three', score: 3 }
+]);
+console.log(val11);
+// returns 3
+
+const val12 = await client.zRange('myzset', 2, 3, { BY: 'SCORE', LIMIT: { offset: 1, count: 1 } });
+console.log(val12);
+// >>> ['three']
+// REMOVE_START
+console.assert(JSON.stringify(val12) === JSON.stringify(['three']));
+await client.del('myzset');
+// REMOVE_END
+// STEP_END
+
+// HIDE_START
+await client.close();
+// HIDE_END
diff --git a/doctests/cmds-string.js b/doctests/cmds-string.js
new file mode 100644
index 00000000000..00b3f738fa3
--- /dev/null
+++ b/doctests/cmds-string.js
@@ -0,0 +1,27 @@
+// EXAMPLE: cmds_string
+// REMOVE_START
+import assert from "node:assert";
+// REMOVE_END
+
+// HIDE_START
+import { createClient } from 'redis';
+
+const client = createClient();
+client.on('error', err => console.log('Redis Client Error', err));
+await client.connect().catch(console.error);
+// HIDE_END
+
+// STEP_START incr
+await client.set("mykey", "10");
+const value1 = await client.incr("mykey");
+console.log(value1);
+// returns 11
+// REMOVE_START
+assert.equal(value1, 11);
+await client.del('mykey');
+// REMOVE_END
+// STEP_END
+
+// HIDE_START
+await client.close();
+// HIDE_END
diff --git a/doctests/data/query_em.json b/doctests/data/query_em.json
new file mode 100644
index 00000000000..bcf908aaf85
--- /dev/null
+++ b/doctests/data/query_em.json
@@ -0,0 +1,92 @@
+[
+ {
+ "pickup_zone": "POLYGON((-74.0610 40.7578, -73.9510 40.7578, -73.9510 40.6678, -74.0610 40.6678, -74.0610 40.7578))",
+ "store_location": "-74.0060,40.7128",
+ "brand": "Velorim",
+ "model": "Jigger",
+ "price": 270,
+ "description": "Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kidsβ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.",
+ "condition": "new"
+ },
+ {
+ "pickup_zone": "POLYGON((-118.2887 34.0972, -118.1987 34.0972, -118.1987 33.9872, -118.2887 33.9872, -118.2887 34.0972))",
+ "store_location": "-118.2437,34.0522",
+ "brand": "Bicyk",
+ "model": "Hillcraft",
+ "price": 1200,
+ "description": "Kids want to ride with as little weight as possible. Especially on an incline! They may be at the age when a 27.5\" wheel bike is just too clumsy coming off a 24\" bike. The Hillcraft 26 is just the solution they need!",
+ "condition": "used"
+ },
+ {
+ "pickup_zone": "POLYGON((-87.6848 41.9331, -87.5748 41.9331, -87.5748 41.8231, -87.6848 41.8231, -87.6848 41.9331))",
+ "store_location": "-87.6298,41.8781",
+ "brand": "Nord",
+ "model": "Chook air 5",
+ "price": 815,
+ "description": "The Chook Air 5 gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. The lower top tube makes it easy to mount and dismount in any situation, giving your kids greater safety on the trails.",
+ "condition": "used"
+ },
+ {
+ "pickup_zone": "POLYGON((-80.2433 25.8067, -80.1333 25.8067, -80.1333 25.6967, -80.2433 25.6967, -80.2433 25.8067))",
+ "store_location": "-80.1918,25.7617",
+ "brand": "Eva",
+ "model": "Eva 291",
+ "price": 3400,
+ "description": "The sister company to Nord, Eva launched in 2005 as the first and only women-dedicated bicycle brand. Designed by women for women, allEva bikes are optimized for the feminine physique using analytics from a body metrics database. If you like 29ers, try the Eva 291. Itβs a brand new bike for 2022.. This full-suspension, cross-country ride has been designed for velocity. The 291 has 100mm of front and rear travel, a superlight aluminum frame and fast-rolling 29-inch wheels. Yippee!",
+ "condition": "used"
+ },
+ {
+ "pickup_zone": "POLYGON((-122.4644 37.8199, -122.3544 37.8199, -122.3544 37.7099, -122.4644 37.7099, -122.4644 37.8199))",
+ "store_location": "-122.4194,37.7749",
+ "brand": "Noka Bikes",
+ "model": "Kahuna",
+ "price": 3200,
+ "description": "Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a womenβs saddle, different bars and unique colourway.",
+ "condition": "used"
+ },
+ {
+ "pickup_zone": "POLYGON((-0.1778 51.5524, 0.0822 51.5524, 0.0822 51.4024, -0.1778 51.4024, -0.1778 51.5524))",
+ "store_location": "-0.1278,51.5074",
+ "brand": "Breakout",
+ "model": "XBN 2.1 Alloy",
+ "price": 810,
+ "description": "The XBN 2.1 Alloy is our entry-level road bike β but thatβs not to say that itβs a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimanoβs, this is a bike which doesnβt break the bank and delivers craved performance.",
+ "condition": "new"
+ },
+ {
+ "pickup_zone": "POLYGON((2.1767 48.9016, 2.5267 48.9016, 2.5267 48.5516, 2.1767 48.5516, 2.1767 48.9016))",
+ "store_location": "2.3522,48.8566",
+ "brand": "ScramBikes",
+ "model": "WattBike",
+ "price": 2300,
+ "description": "The WattBike is the best e-bike for people who still feel young at heart. It has a Bafang 1000W mid-drive system and a 48V 17.5AH Samsung Lithium-Ion battery, allowing you to ride for more than 60 miles on one charge. Itβs great for tackling hilly terrain or if you just fancy a more leisurely ride. With three working modes, you can choose between E-bike, assisted bicycle, and normal bike modes.",
+ "condition": "new"
+ },
+ {
+ "pickup_zone": "POLYGON((13.3260 52.5700, 13.6550 52.5700, 13.6550 52.2700, 13.3260 52.2700, 13.3260 52.5700))",
+ "store_location": "13.4050,52.5200",
+ "brand": "Peaknetic",
+ "model": "Secto",
+ "price": 430,
+ "description": "If you struggle with stiff fingers or a kinked neck or back after a few minutes on the road, this lightweight, aluminum bike alleviates those issues and allows you to enjoy the ride. From the ergonomic grips to the lumbar-supporting seat position, the Roll Low-Entry offers incredible comfort. The rear-inclined seat tube facilitates stability by allowing you to put a foot on the ground to balance at a stop, and the low step-over frame makes it accessible for all ability and mobility levels. The saddle is very soft, with a wide back to support your hip joints and a cutout in the center to redistribute that pressure. Rim brakes deliver satisfactory braking control, and the wide tires provide a smooth, stable ride on paved roads and gravel. Rack and fender mounts facilitate setting up the Roll Low-Entry as your preferred commuter, and the BMX-like handlebar offers space for mounting a flashlight, bell, or phone holder.",
+ "condition": "new"
+ },
+ {
+ "pickup_zone": "POLYGON((1.9450 41.4301, 2.4018 41.4301, 2.4018 41.1987, 1.9450 41.1987, 1.9450 41.4301))",
+ "store_location": "2.1734, 41.3851",
+ "brand": "nHill",
+ "model": "Summit",
+ "price": 1200,
+ "description": "This budget mountain bike from nHill performs well both on bike paths and on the trail. The fork with 100mm of travel absorbs rough terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. The Shimano Tourney drivetrain offered enough gears for finding a comfortable pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. Whether you want an affordable bike that you can take to work, but also take trail in mountains on the weekends or youβre just after a stable, comfortable ride for the bike path, the Summit gives a good value for money.",
+ "condition": "new"
+ },
+ {
+ "pickup_zone": "POLYGON((12.4464 42.1028, 12.5464 42.1028, 12.5464 41.7028, 12.4464 41.7028, 12.4464 42.1028))",
+ "store_location": "12.4964,41.9028",
+ "model": "ThrillCycle",
+ "brand": "BikeShind",
+ "price": 815,
+ "description": "An artsy, retro-inspired bicycle thatβs as functional as it is pretty: The ThrillCycle steel frame offers a smooth ride. A 9-speed drivetrain has enough gears for coasting in the city, but we wouldnβt suggest taking it to the mountains. Fenders protect you from mud, and a rear basket lets you transport groceries, flowers and books. The ThrillCycle comes with a limited lifetime warranty, so this little guy will last you long past graduation.",
+ "condition": "refurbished"
+ }
+]
diff --git a/doctests/data/query_vector.json b/doctests/data/query_vector.json
new file mode 100644
index 00000000000..625479e111b
--- /dev/null
+++ b/doctests/data/query_vector.json
@@ -0,0 +1,3952 @@
+[
+ {
+ "brand": "Velorim",
+ "condition": "new",
+ "description": "Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids\u2019 pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.",
+ "description_embeddings": [
+ -0.026918452233076096,
+ 0.07200391590595245,
+ 0.019199736416339874,
+ -0.024749649688601494,
+ -0.09264523535966873,
+ 0.017702950164675713,
+ 0.11252444237470627,
+ 0.09377790987491608,
+ 0.005099582951515913,
+ 0.07054618746042252,
+ 0.0025260779075324535,
+ -0.04007257893681526,
+ 0.013598357327282429,
+ 0.03940897434949875,
+ -0.0069704861380159855,
+ 0.057934146374464035,
+ 0.15386416018009186,
+ 0.04337097704410553,
+ 0.07119690626859665,
+ -0.048173222690820694,
+ -0.09069827198982239,
+ -0.016886970028281212,
+ -0.04425429925322533,
+ -0.019464140757918358,
+ -0.027470778673887253,
+ 0.005336642265319824,
+ -0.09170512855052948,
+ 0.03556380048394203,
+ 0.023559197783470154,
+ -0.03628315031528473,
+ -0.04448218643665314,
+ 0.011364061385393143,
+ 0.009603296406567097,
+ -0.04861818626523018,
+ -0.03343017399311066,
+ -0.01483147218823433,
+ 0.06086479872465134,
+ 0.02109363302588463,
+ -0.025959225371479988,
+ 0.014000430703163147,
+ -0.00846729427576065,
+ 0.07305800914764404,
+ 0.02457829751074314,
+ -0.12663941085338593,
+ 0.010544337332248688,
+ 0.013315590098500252,
+ 0.07280771434307098,
+ -0.08232685923576355,
+ 0.0040486594662070274,
+ -0.026350753381848335,
+ 0.06408613175153732,
+ -0.01415738184005022,
+ 0.04628903791308403,
+ -0.02050374448299408,
+ 0.04177685081958771,
+ -0.09207800775766373,
+ -0.005421833600848913,
+ -0.005136478692293167,
+ -0.024564260616898537,
+ 0.026354163885116577,
+ -0.05851329490542412,
+ 0.03147275745868683,
+ -0.02183554694056511,
+ 0.03346295654773712,
+ -0.02240697667002678,
+ -0.09603817760944366,
+ -0.02274233102798462,
+ -0.039677977561950684,
+ 0.007695100735872984,
+ 0.039304088801145554,
+ -0.017668871209025383,
+ 0.022897064685821533,
+ -0.039273541420698166,
+ 0.08864572644233704,
+ -0.04432578384876251,
+ -0.06769558042287827,
+ 0.06696884334087372,
+ 0.07118263095617294,
+ -0.024863263592123985,
+ 0.01151553075760603,
+ -0.11591693758964539,
+ -0.025131937116384506,
+ 0.052269868552684784,
+ -0.03035089746117592,
+ 0.00906881783157587,
+ 0.04585501551628113,
+ 0.038361817598342896,
+ 0.03026638925075531,
+ 0.015340524725615978,
+ -0.006911538541316986,
+ 0.022395918145775795,
+ 0.13969141244888306,
+ 0.047686025500297546,
+ 0.05438247323036194,
+ 0.02779674343764782,
+ -0.04191797226667404,
+ -0.021741557866334915,
+ 0.003305602353066206,
+ -0.11100355535745621,
+ 0.016258426010608673,
+ 0.06977421790361404,
+ 0.08189859241247177,
+ 0.0966871827840805,
+ 0.03519754856824875,
+ 0.05674563720822334,
+ 0.034512776881456375,
+ 0.07052291929721832,
+ -0.06342307478189468,
+ 0.051868196576833725,
+ -0.013776403851807117,
+ -0.007541927974671125,
+ -0.043183840811252594,
+ 0.021481933072209358,
+ 0.0380198135972023,
+ -0.07870583236217499,
+ -0.10873759537935257,
+ -0.08491706103086472,
+ 0.03155837208032608,
+ -0.03790571913123131,
+ 0.041968367993831635,
+ -0.00593406381085515,
+ 0.036538854241371155,
+ -0.004705581348389387,
+ 0.004229994490742683,
+ -0.00729013979434967,
+ -0.019296232610940933,
+ -0.014331319369375706,
+ -4.401502220942261e-34,
+ -0.0067550260573625565,
+ 0.07402423769235611,
+ -0.012888211756944656,
+ -0.055266380310058594,
+ 0.04810081049799919,
+ 0.005175809375941753,
+ -0.004325157031416893,
+ -0.10392399877309799,
+ -0.03650582954287529,
+ 0.07477248460054398,
+ 0.0022102247457951307,
+ -0.05040738359093666,
+ -0.003033560933545232,
+ 0.060498371720314026,
+ 0.08619660884141922,
+ -0.04577762633562088,
+ -0.10468175262212753,
+ -0.07177772372961044,
+ -0.05756700038909912,
+ -0.02839704230427742,
+ -0.028650879859924316,
+ -0.010213681496679783,
+ 0.008074316196143627,
+ 0.03448071703314781,
+ -0.025478240102529526,
+ -0.029753824695944786,
+ 0.05397271364927292,
+ -0.0006062929751351476,
+ -0.03292117267847061,
+ 0.040799956768751144,
+ -0.0933983102440834,
+ -0.026921836659312248,
+ 0.00327915046364069,
+ -0.025635670870542526,
+ -0.057946983724832535,
+ -0.06664302200078964,
+ 0.04280361905694008,
+ -0.027111517265439034,
+ -0.08359260112047195,
+ 0.03483080118894577,
+ 0.023318039253354073,
+ -0.08598511666059494,
+ -0.08378149569034576,
+ 0.054067932069301605,
+ -0.014853178523480892,
+ -0.05498708039522171,
+ 0.0711284726858139,
+ 0.12539872527122498,
+ -0.04355800896883011,
+ -0.027553806081414223,
+ -0.009111037477850914,
+ -0.058482203632593155,
+ 0.07053986191749573,
+ -0.009027705527842045,
+ -0.017481567338109016,
+ 0.011404255405068398,
+ 0.06084389239549637,
+ -0.028110956773161888,
+ -0.08594057708978653,
+ 0.05215488001704216,
+ -0.07651112973690033,
+ -0.027076181024312973,
+ -0.01357623003423214,
+ -0.01263132132589817,
+ -0.0193876251578331,
+ 0.013576658442616463,
+ 0.038156066089868546,
+ -0.04309772700071335,
+ -0.04051121696829796,
+ -0.025885144248604774,
+ -0.003073574509471655,
+ -0.0003303807170595974,
+ 0.08043289929628372,
+ -0.039484549313783646,
+ 0.10091833025217056,
+ -0.04735022410750389,
+ 0.027813943102955818,
+ -0.0038837436586618423,
+ -0.05234759673476219,
+ -0.00716474698856473,
+ 0.016360750421881676,
+ -0.025806615129113197,
+ -0.03212691470980644,
+ -0.08456144481897354,
+ -0.019326699897646904,
+ -0.03228791803121567,
+ 0.07633069902658463,
+ -0.07643644511699677,
+ -0.03988131135702133,
+ 0.02396279387176037,
+ -0.055901359766721725,
+ 0.009231535717844963,
+ 0.0344320572912693,
+ 0.07486359030008316,
+ -0.03505600243806839,
+ -2.324423447670953e-34,
+ -0.04453577473759651,
+ 0.06512241810560226,
+ 0.03920532390475273,
+ 0.062222111970186234,
+ -0.015745285898447037,
+ -0.017774563282728195,
+ 0.08228200674057007,
+ -0.05798694118857384,
+ -0.042758435010910034,
+ -0.018822822719812393,
+ -0.07607664912939072,
+ -0.02666221559047699,
+ 0.036936040967702866,
+ -0.034714240580797195,
+ 0.06992944329977036,
+ 0.00530517753213644,
+ -0.0005260169273242354,
+ -0.03961028903722763,
+ 0.08799499273300171,
+ -0.04191635549068451,
+ 0.07468635588884354,
+ -0.010930310003459454,
+ -0.0611649826169014,
+ -0.04100184887647629,
+ 0.07131826132535934,
+ 0.03241356834769249,
+ -0.0545443594455719,
+ -0.005295638460665941,
+ -0.04712966829538345,
+ 0.032524388283491135,
+ -0.05130890756845474,
+ -0.01299980841577053,
+ 0.06523969769477844,
+ -0.011433755978941917,
+ 0.018730396404862404,
+ 0.047184932976961136,
+ -0.043041545897722244,
+ -0.03231072053313255,
+ -0.015864262357354164,
+ 0.03991076350212097,
+ -0.017617924138903618,
+ -0.03504975512623787,
+ 0.027346905320882797,
+ 0.05564267560839653,
+ 0.01610865257680416,
+ 0.0470576174557209,
+ -0.010647954419255257,
+ 0.13047614693641663,
+ -0.011055804789066315,
+ 0.011903814040124416,
+ -0.01350466813892126,
+ -0.0019897734746336937,
+ 0.053073540329933167,
+ 0.0717632919549942,
+ 0.007322370074689388,
+ -0.0206251572817564,
+ 0.061210062354803085,
+ 0.03184640407562256,
+ -0.035093698650598526,
+ -0.0026315131690353155,
+ -0.03291690722107887,
+ -0.04229205846786499,
+ -0.04241437837481499,
+ 0.1091129332780838,
+ 0.02229561097919941,
+ 0.02223002351820469,
+ 0.03949614241719246,
+ 0.031568314880132675,
+ -0.07121116667985916,
+ -0.07664268463850021,
+ -0.04235681891441345,
+ -0.011173299513757229,
+ 0.1190338209271431,
+ -0.09825095534324646,
+ -0.0375107042491436,
+ 0.007167852018028498,
+ 0.047537703067064285,
+ 0.044423725455999374,
+ 0.022106878459453583,
+ -0.02811007760465145,
+ 0.033864255994558334,
+ 0.0643145889043808,
+ 0.03725901246070862,
+ -0.0497952364385128,
+ -0.021733446046710014,
+ 0.023898839950561523,
+ -0.11254694312810898,
+ -0.06519465893507004,
+ 0.04424642026424408,
+ 0.09124527126550674,
+ 0.006083414424210787,
+ 0.09144245833158493,
+ 0.02653978019952774,
+ -0.01318738516420126,
+ 0.0480327382683754,
+ -3.0391063887691416e-08,
+ 0.051376331597566605,
+ -0.0002709411783143878,
+ -0.03103259764611721,
+ -0.018394535407423973,
+ 0.05002995952963829,
+ 0.05086217448115349,
+ -0.07317503541707993,
+ -0.0172730665653944,
+ -0.08379635214805603,
+ 0.1180257499217987,
+ 0.08445936441421509,
+ -0.025030585005879402,
+ -0.01965731382369995,
+ 0.046042654663324356,
+ 0.03724817931652069,
+ 0.028524605557322502,
+ 0.061249297112226486,
+ -0.027382537722587585,
+ -0.0011134583037346601,
+ -0.001871297718025744,
+ -0.04395337030291557,
+ 0.002261978341266513,
+ 0.06950556486845016,
+ -0.024213269352912903,
+ -0.0782783254981041,
+ -0.10320401936769485,
+ -0.022083906456828117,
+ -0.04333319142460823,
+ -0.0334695503115654,
+ 0.007842703722417355,
+ -0.03523677587509155,
+ 0.08107997477054596,
+ 0.00924254022538662,
+ -0.013395791873335838,
+ -0.019067300483584404,
+ -0.008446489460766315,
+ -0.1053837463259697,
+ 0.06697141379117966,
+ 0.06984667479991913,
+ 0.007155571132898331,
+ -0.038544610142707825,
+ 0.0132181691005826,
+ -0.004773592576384544,
+ -0.022143904119729996,
+ -0.09064015746116638,
+ -0.07600560784339905,
+ -0.042070601135492325,
+ -0.08189931511878967,
+ 0.03302472084760666,
+ 0.043238356709480286,
+ -0.01407547201961279,
+ -0.03778013586997986,
+ 0.030578600242733955,
+ 0.021573437377810478,
+ 0.04664295166730881,
+ 0.056082408875226974,
+ -0.07687672227621078,
+ -0.0018553169211372733,
+ -0.051700614392757416,
+ 0.043752558529376984,
+ -0.02636834792792797,
+ 0.05589277669787407,
+ 0.05282546952366829,
+ -0.016411008313298225
+ ],
+ "model": "Jigger",
+ "pickup_zone": "POLYGON((-74.0610 40.7578, -73.9510 40.7578, -73.9510 40.6678, -74.0610 40.6678, -74.0610 40.7578))",
+ "price": 270,
+ "store_location": "-74.0060,40.7128"
+ },
+ {
+ "brand": "Bicyk",
+ "condition": "used",
+ "description": "Kids want to ride with as little weight as possible. Especially on an incline! They may be at the age when a 27.5\" wheel bike is just too clumsy coming off a 24\" bike. The Hillcraft 26 is just the solution they need!",
+ "description_embeddings": [
+ -0.004883771762251854,
+ 0.08099519461393356,
+ -0.022444017231464386,
+ 0.05437565594911575,
+ -0.07422323524951935,
+ 0.0066548739559948444,
+ -0.06268022209405899,
+ 0.042389899492263794,
+ -0.03745086118578911,
+ 0.058961447328329086,
+ 0.025613723322749138,
+ -0.04209878668189049,
+ 0.06861244142055511,
+ 0.01983577199280262,
+ 0.026353053748607635,
+ 0.045618414878845215,
+ 0.040685027837753296,
+ 0.09574265778064728,
+ 0.005801026243716478,
+ -0.027659950777888298,
+ -0.0223013274371624,
+ 0.040641166269779205,
+ 0.06608107686042786,
+ 0.0691058486700058,
+ -0.03629102557897568,
+ 0.035505786538124084,
+ -0.09211395680904388,
+ -0.011358118616044521,
+ -0.025078972801566124,
+ -0.017709167674183846,
+ 0.07587391883134842,
+ 0.08128049969673157,
+ 0.060521550476551056,
+ -0.0845090001821518,
+ -0.03779749944806099,
+ 0.030346086248755455,
+ 0.017926080152392387,
+ 0.003489845432341099,
+ -0.05622200667858124,
+ -0.06886664777994156,
+ -0.051538050174713135,
+ 0.029196197167038918,
+ -0.0028146395925432444,
+ 0.012419342994689941,
+ -0.06346380710601807,
+ -0.011617675423622131,
+ 0.04980290308594704,
+ -0.0799335315823555,
+ 0.016635078936815262,
+ 0.07064730674028397,
+ 0.04530491679906845,
+ -0.04372858256101608,
+ 0.07056037336587906,
+ -0.05052798613905907,
+ -0.01064316462725401,
+ -0.04754374921321869,
+ -0.08878123015165329,
+ 0.005363269243389368,
+ 0.032587066292762756,
+ -0.05610528588294983,
+ -0.0012875061947852373,
+ -0.03215320408344269,
+ -0.0045777312479913235,
+ -0.026692084968090057,
+ -0.09758491814136505,
+ -0.046251099556684494,
+ 0.03897765651345253,
+ -0.06587375700473785,
+ -0.013586618937551975,
+ -0.020807752385735512,
+ 0.023367363959550858,
+ 0.011167124845087528,
+ 0.003386110533028841,
+ -0.024887114763259888,
+ -0.029615335166454315,
+ -0.02571641281247139,
+ -0.03150812163949013,
+ -0.0395360104739666,
+ -0.049686528742313385,
+ -0.023117102682590485,
+ -0.07580453157424927,
+ 0.020851964130997658,
+ 0.0917917937040329,
+ -0.038357049226760864,
+ 0.05106140300631523,
+ -0.03367459401488304,
+ 0.05801103636622429,
+ 0.0628814697265625,
+ 0.024997225031256676,
+ 0.015594316646456718,
+ -0.01490987278521061,
+ 0.07070998847484589,
+ -0.039144083857536316,
+ 0.0657331570982933,
+ -0.053744420409202576,
+ -0.01675831526517868,
+ -0.008745769970119,
+ -0.07664742320775986,
+ -0.06751038879156113,
+ 0.0023392336443066597,
+ 0.018902592360973358,
+ 0.06754770874977112,
+ 0.07430258393287659,
+ 0.0806465670466423,
+ -0.031056180596351624,
+ 0.06557579338550568,
+ 0.06529161334037781,
+ -0.03742394223809242,
+ 0.0007822285988368094,
+ 0.10523669421672821,
+ 0.0038901956286281347,
+ -0.014934191480278969,
+ 0.0647430568933487,
+ 0.03438747301697731,
+ -0.046527378261089325,
+ 0.014247977174818516,
+ -0.020184241235256195,
+ 0.016480082646012306,
+ -0.05491460859775543,
+ 0.07232335209846497,
+ -0.016330908983945847,
+ 0.011368552222847939,
+ -0.001964043825864792,
+ 0.0009170984267257154,
+ 0.019140562042593956,
+ -0.002758787479251623,
+ -0.05629577115178108,
+ 1.7957766384702998e-33,
+ -0.10579885542392731,
+ 0.08271613717079163,
+ 0.03821941837668419,
+ 0.06078806892037392,
+ 0.017647448927164078,
+ -0.07404755055904388,
+ 0.06083450838923454,
+ -0.07097837328910828,
+ -0.01949647255241871,
+ -0.005204185377806425,
+ 0.0160058680921793,
+ -0.03624944016337395,
+ 0.065463587641716,
+ -0.04834574833512306,
+ 0.09314870834350586,
+ -0.022509299218654633,
+ -0.047614336013793945,
+ -0.042122796177864075,
+ 0.0014064351562410593,
+ 0.08215921372175217,
+ 0.0144058121368289,
+ -0.08526691794395447,
+ -0.01885370910167694,
+ 0.020506983622908592,
+ -0.0041589876636862755,
+ -0.0928102508187294,
+ 0.0965222716331482,
+ 0.05469893291592598,
+ 0.002785224001854658,
+ 0.006347258575260639,
+ -0.09394793212413788,
+ -0.08587668836116791,
+ 0.00999284815043211,
+ -0.015109539031982422,
+ 0.035454027354717255,
+ -0.08842843770980835,
+ -0.015698572620749474,
+ 0.05549640208482742,
+ -0.011119373142719269,
+ 0.012295924127101898,
+ 0.007523554377257824,
+ -0.03497130423784256,
+ -0.05309790000319481,
+ -0.021819932386279106,
+ 0.011010204441845417,
+ 0.0778549313545227,
+ 0.122015580534935,
+ 0.0451776348054409,
+ -0.0894458070397377,
+ 0.0031173918396234512,
+ -0.003828236600384116,
+ 0.0010151821188628674,
+ 0.0007775757694616914,
+ -0.0007406148943118751,
+ 0.0005911831394769251,
+ 0.029611686244606972,
+ -0.010095393285155296,
+ -0.015750357881188393,
+ -0.08871200680732727,
+ 0.06563369184732437,
+ 0.052563928067684174,
+ -0.02150006778538227,
+ 0.032858334481716156,
+ -0.039781685918569565,
+ -0.02986454777419567,
+ -0.017254218459129333,
+ 0.013349524699151516,
+ 0.04903600737452507,
+ -0.102760910987854,
+ 0.027411801740527153,
+ -0.007306735496968031,
+ 0.03547230362892151,
+ 0.03793823719024658,
+ -0.014224819839000702,
+ 0.004229242447763681,
+ -0.04914051666855812,
+ -0.05566011741757393,
+ -0.08426816016435623,
+ 0.0378078892827034,
+ -0.02177048847079277,
+ 0.037800222635269165,
+ 0.01145790982991457,
+ -0.03493969514966011,
+ -0.06417357921600342,
+ -0.04812582954764366,
+ -0.030254419893026352,
+ -0.12552082538604736,
+ 0.0017056012293323874,
+ -0.053679559379816055,
+ 0.019939688965678215,
+ -0.04766315221786499,
+ -0.143480584025383,
+ -0.024615854024887085,
+ 0.06507551670074463,
+ 0.01710103265941143,
+ -2.55080180279124e-33,
+ -0.01073896698653698,
+ 0.08023330569267273,
+ 0.028500312939286232,
+ -0.033364687114953995,
+ 0.018465891480445862,
+ -0.018969086930155754,
+ 0.116150863468647,
+ -0.04905116185545921,
+ 0.0067994301207363605,
+ -0.051097989082336426,
+ -0.047208935022354126,
+ 0.003005147911608219,
+ -0.006951641291379929,
+ 0.0299075860530138,
+ 0.023957515135407448,
+ 0.005555577110499144,
+ -0.020836569368839264,
+ 0.013542957603931427,
+ 0.09286782890558243,
+ -0.04009733721613884,
+ 0.05567550286650658,
+ 0.01991306059062481,
+ -0.16575683653354645,
+ -0.003300475887954235,
+ 0.11635366082191467,
+ 0.008300523273646832,
+ -0.1112738847732544,
+ 0.05307481065392494,
+ 0.009467027150094509,
+ 0.11263766884803772,
+ -0.04102758690714836,
+ -0.0505208782851696,
+ 0.1890914887189865,
+ -0.01593983918428421,
+ 0.011381726711988449,
+ 0.01095605455338955,
+ -0.08038999140262604,
+ -0.012621873058378696,
+ -0.005316049326211214,
+ 0.017261112108826637,
+ 0.03283751755952835,
+ -0.04533768445253372,
+ 0.03397509828209877,
+ 0.04211656376719475,
+ 0.024692395702004433,
+ -0.02541458234190941,
+ 0.02313675545156002,
+ 0.02338019199669361,
+ -0.011879520490765572,
+ -0.05438990890979767,
+ 0.03806900233030319,
+ 0.01261812262237072,
+ 0.02512892708182335,
+ -0.0028746703173965216,
+ -0.016077643260359764,
+ -0.032072994858026505,
+ -0.006427581422030926,
+ 0.01777057908475399,
+ 0.02934812381863594,
+ -0.05759994685649872,
+ -2.871774631785229e-05,
+ -0.03137838840484619,
+ -0.06273766607046127,
+ 0.04409930482506752,
+ -0.05993351340293884,
+ 0.007546861190348864,
+ 0.0053585791029036045,
+ 0.042325496673583984,
+ -0.007369876839220524,
+ 0.04489513114094734,
+ -0.12103329598903656,
+ 0.017391694709658623,
+ 0.0304956566542387,
+ -0.034047987312078476,
+ 0.02484256401658058,
+ -0.06834809482097626,
+ 0.06508748978376389,
+ 0.08324999362230301,
+ -0.020252887159585953,
+ -0.014722783118486404,
+ 0.02126440405845642,
+ -0.05160334333777428,
+ 0.045947108417749405,
+ 0.022960059344768524,
+ 0.023375188931822777,
+ -0.060902271419763565,
+ -0.05150751397013664,
+ -0.1094929575920105,
+ -0.04899677261710167,
+ 0.09132419526576996,
+ 0.051848214119672775,
+ -0.0077659315429627895,
+ 0.0012422297149896622,
+ 0.058530740439891815,
+ 0.040777210146188736,
+ -3.354356081786136e-08,
+ 0.025891084223985672,
+ -0.04088461399078369,
+ -0.06885679066181183,
+ 0.01951301097869873,
+ 0.047974348068237305,
+ 0.04472370818257332,
+ 0.004657004959881306,
+ 0.001041706302203238,
+ -0.02763887122273445,
+ 0.03814717009663582,
+ 0.03166148066520691,
+ 0.0063626947812736034,
+ 0.09577886760234833,
+ 0.06234167888760567,
+ 0.0010398400481790304,
+ 0.010609040968120098,
+ 0.020408503711223602,
+ 0.05596008151769638,
+ 0.00923844799399376,
+ 0.011290326714515686,
+ 0.02393697388470173,
+ -0.03378620743751526,
+ 0.010788901709020138,
+ 0.0072112190537154675,
+ -0.03552679717540741,
+ -0.10475718975067139,
+ 0.003995304461568594,
+ -0.002284976886585355,
+ -0.014504319056868553,
+ -0.06887608021497726,
+ 0.03398992121219635,
+ -0.005206231493502855,
+ 0.049566611647605896,
+ 0.00902023445814848,
+ 0.06874160468578339,
+ 0.014804325066506863,
+ -0.07230424880981445,
+ 0.0428827665746212,
+ 0.013657039031386375,
+ 0.027973631396889687,
+ -0.035619381815195084,
+ 0.06485525518655777,
+ -0.06238642707467079,
+ -0.012459578923881054,
+ 0.020500177517533302,
+ -0.0715484470129013,
+ -0.16523504257202148,
+ 0.013638298027217388,
+ 0.07008316367864609,
+ 0.026970835402607918,
+ 0.004871702753007412,
+ -0.0012540861498564482,
+ -0.028708957135677338,
+ 0.05812879279255867,
+ 0.12611250579357147,
+ 0.09877888858318329,
+ -0.04118988662958145,
+ -0.02214396744966507,
+ -0.10328112542629242,
+ 0.029945021495223045,
+ 0.004513312131166458,
+ 0.011272193863987923,
+ 0.03294430673122406,
+ -0.042709026485681534
+ ],
+ "model": "Hillcraft",
+ "pickup_zone": "POLYGON((-118.2887 34.0972, -118.1987 34.0972, -118.1987 33.9872, -118.2887 33.9872, -118.2887 34.0972))",
+ "price": 1200,
+ "store_location": "-118.2437,34.0522"
+ },
+ {
+ "brand": "Nord",
+ "condition": "used",
+ "description": "The Chook Air 5 gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. The lower top tube makes it easy to mount and dismount in any situation, giving your kids greater safety on the trails.",
+ "description_embeddings": [
+ -0.0018494834657758474,
+ 0.057690851390361786,
+ 0.038153987377882004,
+ 0.06570218503475189,
+ 0.028856752440333366,
+ -0.062333013862371445,
+ -0.014953209087252617,
+ 0.046022992581129074,
+ -0.08184631168842316,
+ 0.03648914024233818,
+ 0.03869181126356125,
+ 0.010564669035375118,
+ -0.020310621708631516,
+ -0.04062078520655632,
+ -0.0125962495803833,
+ 0.14169928431510925,
+ 0.03418859466910362,
+ -0.06641822308301926,
+ 0.005633663386106491,
+ -0.09943458437919617,
+ 0.023237863555550575,
+ -0.04369724169373512,
+ 0.016574522480368614,
+ 0.07258585095405579,
+ 0.018674470484256744,
+ -0.05764088034629822,
+ -0.0795072391629219,
+ 0.04034125804901123,
+ -0.036483921110630035,
+ -0.033106740564107895,
+ 0.02980787307024002,
+ -0.0028512384742498398,
+ 0.00786224752664566,
+ -0.03016488254070282,
+ -0.12349128723144531,
+ 0.031072411686182022,
+ 0.08362030982971191,
+ 0.025227056816220284,
+ -0.030982907861471176,
+ -0.006486377213150263,
+ -0.023590318858623505,
+ -0.03374557942152023,
+ -0.04145599156618118,
+ -0.09421771764755249,
+ -0.0013142612297087908,
+ -0.003397064981982112,
+ -0.0031338112894445658,
+ -0.11464792490005493,
+ 0.040542472153902054,
+ 0.02896481193602085,
+ 0.007327641360461712,
+ -0.06064218282699585,
+ 0.049546848982572556,
+ -0.05917377769947052,
+ -0.01963184028863907,
+ -0.002139812568202615,
+ -0.14361988008022308,
+ -0.05401389300823212,
+ 0.12506668269634247,
+ -0.07141950726509094,
+ -0.0032961040269583464,
+ 0.015251584351062775,
+ -0.05507654324173927,
+ -0.009836667217314243,
+ -0.02802908606827259,
+ -0.01053905300796032,
+ -0.03239851072430611,
+ -0.10646941512823105,
+ 0.03140658512711525,
+ 0.028125958517193794,
+ -0.004000179003924131,
+ -0.0018343725241720676,
+ 0.01727917790412903,
+ -0.013935663737356663,
+ -0.02435036562383175,
+ 0.04411163926124573,
+ -0.009158330969512463,
+ -0.023309389129281044,
+ 0.01229795441031456,
+ -0.04689493402838707,
+ -0.02138197235763073,
+ 0.013063939288258553,
+ 0.02832808345556259,
+ 0.031972818076610565,
+ 0.020882662385702133,
+ -0.015083174221217632,
+ 0.002903456799685955,
+ -0.047304242849349976,
+ -0.10658963769674301,
+ -0.06274145841598511,
+ -0.030370736494660378,
+ 0.0539257749915123,
+ 0.00848578754812479,
+ 0.02172423154115677,
+ -0.007691903971135616,
+ -0.10581931471824646,
+ 0.06078812852501869,
+ 0.007988635450601578,
+ -0.116583913564682,
+ 0.05237157270312309,
+ 0.024445366114377975,
+ -0.02832716703414917,
+ 0.04004029557108879,
+ 0.02844531089067459,
+ -0.0455174520611763,
+ -0.07379734516143799,
+ 0.09453199058771133,
+ -0.011599121615290642,
+ -0.0027194281574338675,
+ 0.014355232007801533,
+ -0.059690698981285095,
+ -0.012937567196786404,
+ 0.034315045922994614,
+ -0.047598548233509064,
+ -0.03261064738035202,
+ 0.05839747563004494,
+ -0.12691465020179749,
+ 0.03778312727808952,
+ 0.006131120957434177,
+ 0.04806787148118019,
+ -0.03441976010799408,
+ 0.08042734116315842,
+ 0.008934197947382927,
+ 0.027216315269470215,
+ 0.0016972541343420744,
+ -0.10113930702209473,
+ -0.0003218930505681783,
+ 9.75532108829862e-34,
+ -0.0537416972219944,
+ 0.06875170767307281,
+ -0.01566525548696518,
+ 0.01952524110674858,
+ -0.0005404680850915611,
+ -0.08984242379665375,
+ 0.04537447541952133,
+ -0.1295408457517624,
+ 7.603532867506146e-05,
+ 0.040753066539764404,
+ 0.016371281817555428,
+ 0.029906686395406723,
+ -0.005372706335037947,
+ -0.06687828153371811,
+ 0.11607439070940018,
+ 0.016209086403250694,
+ -0.11238335072994232,
+ -0.057236358523368835,
+ -0.09619198739528656,
+ 0.027146028354763985,
+ -0.09542766213417053,
+ -0.0360424630343914,
+ -0.09913153201341629,
+ 0.04242968559265137,
+ 0.05494842678308487,
+ -0.025294257327914238,
+ 0.06307625770568848,
+ 0.007745219860225916,
+ -0.019641151651740074,
+ 0.07056662440299988,
+ -0.05425839126110077,
+ 0.012385660782456398,
+ -0.006104010157287121,
+ -0.07186716794967651,
+ -0.10919132828712463,
+ -0.0017968777101486921,
+ 0.010471112094819546,
+ -0.011221444234251976,
+ -0.035078633576631546,
+ 0.009300827980041504,
+ 0.0802159234881401,
+ -0.10042990744113922,
+ -0.01718892529606819,
+ 0.05525779724121094,
+ -0.019847391173243523,
+ 0.08405174314975739,
+ 0.06403975188732147,
+ 0.0627448782324791,
+ -0.07871688157320023,
+ 0.0002676364383660257,
+ -0.05110163986682892,
+ 0.006078454665839672,
+ -0.019803548231720924,
+ -0.014253707602620125,
+ 0.039836447685956955,
+ 0.021812820807099342,
+ 0.00014793995069339871,
+ -0.006739508826285601,
+ -0.023166682571172714,
+ 0.05429920181632042,
+ 0.1337796151638031,
+ -0.01773720420897007,
+ 0.024304436519742012,
+ -0.016411837190389633,
+ -0.07777299731969833,
+ 0.042669400572776794,
+ 0.06226645037531853,
+ -0.023803485557436943,
+ 0.00396164134144783,
+ -0.049458179622888565,
+ -0.004774407483637333,
+ 0.036529600620269775,
+ 0.02002328634262085,
+ -0.02465248480439186,
+ -0.024076614528894424,
+ -0.03887653350830078,
+ 0.057176534086465836,
+ -0.03888818621635437,
+ -0.027698175981640816,
+ 0.001469603506848216,
+ 0.04755152389407158,
+ -0.0938708707690239,
+ 0.013991769403219223,
+ -0.026987746357917786,
+ -0.03277081623673439,
+ -0.04837489873170853,
+ 0.02711542509496212,
+ -0.09185922145843506,
+ -0.03453921154141426,
+ 0.03532274439930916,
+ -0.024472877383232117,
+ -0.09732313454151154,
+ 0.008513586595654488,
+ 0.03207352012395859,
+ 0.030766190961003304,
+ -2.5405224720352836e-33,
+ 0.08067575097084045,
+ -0.008160247467458248,
+ 0.03101508319377899,
+ 0.005022854544222355,
+ 0.0010000152979046106,
+ 0.06958161294460297,
+ 0.10594375431537628,
+ -0.06177408620715141,
+ -0.01650322414934635,
+ 0.03043895959854126,
+ -0.018333615735173225,
+ 0.06436911225318909,
+ 0.02439672127366066,
+ -0.01213911734521389,
+ 0.09937868267297745,
+ 0.02093592658638954,
+ -0.003140130080282688,
+ -0.016580305993556976,
+ 0.10430759936571121,
+ -0.019038936123251915,
+ 0.05574416741728783,
+ 0.07455366849899292,
+ -0.029936065897345543,
+ 0.0017704741330817342,
+ 0.07022519409656525,
+ 0.02108696848154068,
+ -0.050372399389743805,
+ 0.027957700192928314,
+ 0.005698348395526409,
+ 0.03494682535529137,
+ -0.02610155940055847,
+ -0.0068950653076171875,
+ 0.1346345692873001,
+ 0.03947756066918373,
+ -0.05966781824827194,
+ -0.010489783249795437,
+ -0.04099087417125702,
+ -0.027186688035726547,
+ -0.04620056599378586,
+ -0.02478279173374176,
+ -0.007060651201754808,
+ -0.023514581844210625,
+ 0.06082035228610039,
+ -0.05849218741059303,
+ -0.0036981222219765186,
+ 0.04169313609600067,
+ 0.09352244436740875,
+ 0.020741308107972145,
+ -0.0019505824893712997,
+ -0.10489305853843689,
+ 0.08789870887994766,
+ 0.039999835193157196,
+ -0.014334832318127155,
+ 0.008347390219569206,
+ 0.03113699145615101,
+ 0.10894497483968735,
+ 0.027165820822119713,
+ 0.0064145540818572044,
+ -0.00803150050342083,
+ -0.055484138429164886,
+ -0.03251631557941437,
+ 0.02290980890393257,
+ 0.04825572296977043,
+ 0.01608354039490223,
+ -0.04969468340277672,
+ -0.004120110999792814,
+ -0.03278858959674835,
+ 0.009696378372609615,
+ -0.04376300796866417,
+ -0.0009336083312518895,
+ -0.0313178189098835,
+ -0.05882050469517708,
+ 0.057815250009298325,
+ -0.02050788328051567,
+ -0.024381538853049278,
+ 0.06283771246671677,
+ 0.06954411417245865,
+ 0.09720556437969208,
+ -0.056403111666440964,
+ -0.04526498168706894,
+ -0.07259991019964218,
+ 0.001844316371716559,
+ 0.04090375825762749,
+ 0.06941819936037064,
+ -0.041316937655210495,
+ 0.002292247023433447,
+ -0.03425106778740883,
+ -0.0628972053527832,
+ 0.0063382769003510475,
+ 0.09668626636266708,
+ 0.062228571623563766,
+ 0.03658486530184746,
+ -0.08789398521184921,
+ 0.0009696391643956304,
+ -0.004108588211238384,
+ -3.183854957455878e-08,
+ 0.09346635639667511,
+ 0.042943451553583145,
+ -0.0005091542261652648,
+ 0.026524608954787254,
+ 0.009858721867203712,
+ 0.03737989068031311,
+ -0.014056878164410591,
+ 0.038327474147081375,
+ -0.010239921510219574,
+ 0.05757640674710274,
+ 0.014411918818950653,
+ 0.038742948323488235,
+ 0.06475342065095901,
+ -0.0011537548853084445,
+ -0.017729472368955612,
+ 0.05167960748076439,
+ 0.024419916793704033,
+ 0.08681508898735046,
+ 0.015235288999974728,
+ 0.036676522344350815,
+ -0.03421042487025261,
+ -0.019762659445405006,
+ 0.09467294812202454,
+ -0.053133491426706314,
+ -0.04356615990400314,
+ -0.03919585049152374,
+ 0.015591761097311974,
+ 0.021372869610786438,
+ -0.0058142030611634254,
+ -0.022864477708935738,
+ -0.02901598811149597,
+ 0.0458187572658062,
+ -0.030826766043901443,
+ -0.008975986391305923,
+ 0.03365883231163025,
+ -0.010484383441507816,
+ -0.1445801854133606,
+ 0.05828193947672844,
+ -0.028194306418299675,
+ 0.05975533276796341,
+ 0.014028828591108322,
+ 0.0036430624313652515,
+ 0.024983061477541924,
+ 0.01454286277294159,
+ -0.006972659844905138,
+ 0.037446193397045135,
+ -0.06949692964553833,
+ -0.09630566090345383,
+ 0.03263894096016884,
+ 0.048720087856054306,
+ -0.06886433064937592,
+ 0.018142051994800568,
+ 0.03894415125250816,
+ 0.05843216925859451,
+ 0.06860719621181488,
+ 0.04971907287836075,
+ -0.025701280683279037,
+ -0.06293400377035141,
+ -0.05422094464302063,
+ 0.01912975125014782,
+ 0.009564549662172794,
+ 0.055643752217292786,
+ -0.0027948219794780016,
+ 0.0329461470246315
+ ],
+ "model": "Chook air 5",
+ "pickup_zone": "POLYGON((-87.6848 41.9331, -87.5748 41.9331, -87.5748 41.8231, -87.6848 41.8231, -87.6848 41.9331))",
+ "price": 815,
+ "store_location": "-87.6298,41.8781"
+ },
+ {
+ "brand": "Eva",
+ "condition": "used",
+ "description": "The sister company to Nord, Eva launched in 2005 as the first and only women-dedicated bicycle brand. Designed by women for women, allEva bikes are optimized for the feminine physique using analytics from a body metrics database. If you like 29ers, try the Eva 291. It\u2019s a brand new bike for 2022.. This full-suspension, cross-country ride has been designed for velocity. The 291 has 100mm of front and rear travel, a superlight aluminum frame and fast-rolling 29-inch wheels. Yippee!",
+ "description_embeddings": [
+ 0.035103436559438705,
+ 0.02666405402123928,
+ -0.06364161521196365,
+ 0.02551678754389286,
+ -0.005281867925077677,
+ -0.04041111096739769,
+ -0.020820949226617813,
+ -0.03485208749771118,
+ -0.07683732360601425,
+ 0.021527189761400223,
+ 0.007516156416386366,
+ -0.0034474905114620924,
+ 0.030465560033917427,
+ -0.06572654843330383,
+ -0.020914506167173386,
+ 0.032637566328048706,
+ 0.0815017819404602,
+ -0.022764643654227257,
+ 0.07385077327489853,
+ 0.058004263788461685,
+ -0.03062591142952442,
+ -0.03927106410264969,
+ 0.01410673838108778,
+ 0.05480317771434784,
+ -0.05647570267319679,
+ -0.008725483901798725,
+ -0.05373937636613846,
+ 0.03546926751732826,
+ -0.026455262675881386,
+ -0.09718386828899384,
+ -0.040623344480991364,
+ 0.03622450679540634,
+ 0.08971034735441208,
+ -0.038574062287807465,
+ -0.05105822533369064,
+ 0.021020587533712387,
+ 0.003312851767987013,
+ -0.008969941176474094,
+ -0.0568903312087059,
+ 0.033502694219350815,
+ -0.0578635074198246,
+ -0.03721226751804352,
+ -0.036668986082077026,
+ 0.0022641047835350037,
+ 0.038053013384342194,
+ 0.03350543603301048,
+ 0.05258995667099953,
+ -0.007619654294103384,
+ -0.05145309492945671,
+ 0.026286069303750992,
+ 0.09238694608211517,
+ -0.06733417510986328,
+ 0.05791507661342621,
+ -0.07623173296451569,
+ -0.0052175214514136314,
+ -0.04393303394317627,
+ -0.15249019861221313,
+ -0.019764462485909462,
+ -0.03331150859594345,
+ -0.11831824481487274,
+ 0.05683637782931328,
+ 0.01903577335178852,
+ -0.023615414276719093,
+ 0.04120348393917084,
+ -0.05669170990586281,
+ 0.002014430705457926,
+ 0.009953595697879791,
+ 0.008390115574002266,
+ -0.025982441380620003,
+ -0.05977262556552887,
+ 0.0611012764275074,
+ 0.010146236047148705,
+ -0.047625984996557236,
+ 0.09061623364686966,
+ 0.02551751770079136,
+ 0.06041749566793442,
+ 0.1113404780626297,
+ 0.017673874273896217,
+ -0.05184035003185272,
+ 0.023109234869480133,
+ -0.04408435523509979,
+ -0.09029985964298248,
+ 0.06733208149671555,
+ 0.049696795642375946,
+ 0.05554559826850891,
+ 0.01563390903174877,
+ -0.019527558237314224,
+ -0.014796985313296318,
+ 0.003595865098759532,
+ 0.012917418964207172,
+ -0.06858907639980316,
+ -0.008697138167917728,
+ 0.04721860587596893,
+ 0.03153855353593826,
+ -0.05275731533765793,
+ 0.019923491403460503,
+ -0.009707989171147346,
+ -0.018920045346021652,
+ 0.03773808106780052,
+ 0.042773403227329254,
+ -0.03819388151168823,
+ 0.04029008001089096,
+ 0.060834936797618866,
+ 0.07531940191984177,
+ -0.04695741459727287,
+ 0.00488079572096467,
+ 0.13518987596035004,
+ -0.014429144561290741,
+ 0.0314130075275898,
+ 0.04135369136929512,
+ -0.021350333467125893,
+ -0.01289785373955965,
+ 0.032701168209314346,
+ -0.037027571350336075,
+ -0.018168980255723,
+ -0.07188623398542404,
+ -0.036501020193099976,
+ 0.03303954005241394,
+ 0.10676111280918121,
+ -0.03277475759387016,
+ -0.06245853006839752,
+ -0.011879103258252144,
+ 0.0533418171107769,
+ -0.01446340698748827,
+ 0.03530410677194595,
+ 0.05820532143115997,
+ -0.0015766610158607364,
+ -8.477015062817539e-34,
+ -0.10837127268314362,
+ 0.015582970343530178,
+ 0.0182977095246315,
+ 0.055213626474142075,
+ -0.03584470599889755,
+ 0.02778925560414791,
+ 0.08698058873414993,
+ -0.04999695345759392,
+ -0.0842076763510704,
+ -0.040448326617479324,
+ -0.06311061233282089,
+ 0.02668358013033867,
+ 0.04676111042499542,
+ -0.006417605560272932,
+ 0.12788759171962738,
+ 0.02197197638452053,
+ 0.07035308331251144,
+ -0.04392284154891968,
+ -0.008788101375102997,
+ -0.001108768628910184,
+ 0.07960236072540283,
+ -0.0019975434988737106,
+ -0.010499294847249985,
+ 0.03599945828318596,
+ 0.02329486794769764,
+ -0.01962442137300968,
+ 0.15486162900924683,
+ 0.027215363457798958,
+ -0.022036811336874962,
+ 0.04227740690112114,
+ -0.07894206047058105,
+ -0.03180933743715286,
+ 0.020022651180624962,
+ -0.05859709531068802,
+ -0.0009564562351442873,
+ 0.009732870385050774,
+ -0.09007531404495239,
+ 0.041766807436943054,
+ 0.003291067900136113,
+ 0.0950121283531189,
+ 0.02693203091621399,
+ -0.01629827171564102,
+ -0.01884087361395359,
+ -0.029889501631259918,
+ -0.003714299062266946,
+ 0.09247232973575592,
+ 0.06151247024536133,
+ 0.09120925515890121,
+ -0.011266379617154598,
+ 0.03680066391825676,
+ -0.1628604233264923,
+ -0.008045083843171597,
+ -0.023876454681158066,
+ 0.046465914696455,
+ 0.01841152086853981,
+ 0.01759498566389084,
+ -0.012628139927983284,
+ 0.02123965509235859,
+ -0.07098977267742157,
+ 0.025028834119439125,
+ -0.032171521335840225,
+ 0.0538402758538723,
+ -0.00211805896833539,
+ -0.019548164680600166,
+ -0.046793293207883835,
+ 0.04394293949007988,
+ 0.022090770304203033,
+ -0.058215122669935226,
+ -0.05101722851395607,
+ 0.014057288877665997,
+ -0.05860457569360733,
+ 0.006166193168610334,
+ 0.04641130194067955,
+ 0.03165149688720703,
+ 0.045289356261491776,
+ 0.038580797612667084,
+ -0.0335664264857769,
+ 0.013378577306866646,
+ 0.058321163058280945,
+ -0.03730795532464981,
+ -0.01996016688644886,
+ 0.025774186477065086,
+ 0.001352976425550878,
+ 0.023636724799871445,
+ 0.026727410033345222,
+ -0.0730309784412384,
+ -0.01613243669271469,
+ -0.009525856003165245,
+ -0.03985843434929848,
+ -0.003976964857429266,
+ -0.006743384525179863,
+ -0.06324627995491028,
+ 0.03959967568516731,
+ 0.021898096427321434,
+ -0.004184887744486332,
+ -3.110083923319741e-34,
+ 0.03726857528090477,
+ -0.016945818439126015,
+ 0.05512943118810654,
+ 0.0471712127327919,
+ 0.097488172352314,
+ 0.02456829510629177,
+ 0.08276744186878204,
+ -0.02230781689286232,
+ -0.03785759210586548,
+ 0.010082835331559181,
+ 0.07151538133621216,
+ -0.04426267370581627,
+ 0.03402319550514221,
+ 0.05808456242084503,
+ 0.07566764950752258,
+ 0.07006501406431198,
+ 0.002404613886028528,
+ -0.10078012198209763,
+ 0.0029093879275023937,
+ -0.12370351701974869,
+ -0.03431423008441925,
+ 0.08334372937679291,
+ 0.001441179309040308,
+ -0.08001153916120529,
+ 0.020076438784599304,
+ 0.011177998036146164,
+ 0.034560561180114746,
+ 0.041609298437833786,
+ -0.04921843111515045,
+ 0.03598331660032272,
+ -0.10671709477901459,
+ 0.02969883382320404,
+ 0.048317357897758484,
+ 0.12375228852033615,
+ 0.040479566901922226,
+ 0.0330270379781723,
+ -0.06994733214378357,
+ 0.008698385208845139,
+ 0.03447363153100014,
+ -0.012882913462817669,
+ -0.02672695368528366,
+ -0.06423910707235336,
+ -0.0506032295525074,
+ 0.0053747911006212234,
+ 0.0682206079363823,
+ -0.005316274706274271,
+ 0.027013784274458885,
+ -0.006269444711506367,
+ 0.08528510481119156,
+ -0.0731915608048439,
+ 0.0046186731196939945,
+ -0.024244142696261406,
+ 0.0360478051006794,
+ 0.020591434091329575,
+ 0.04302601516246796,
+ -0.14392279088497162,
+ 0.05873512104153633,
+ -0.010028650052845478,
+ -0.04548479616641998,
+ -0.013535127975046635,
+ 0.01113649271428585,
+ 0.028603754937648773,
+ -0.04036158323287964,
+ 0.0704532265663147,
+ -0.09373150765895844,
+ -0.07198052108287811,
+ -0.002203285926952958,
+ -0.0855080857872963,
+ -0.08842256665229797,
+ -9.343179408460855e-05,
+ -0.029457710683345795,
+ -0.02197202481329441,
+ -0.048936717212200165,
+ 0.06165122613310814,
+ -0.0626755878329277,
+ 0.009602922946214676,
+ 0.07251632958650589,
+ 0.03113914094865322,
+ -0.0010769155342131853,
+ -0.040936876088380814,
+ -0.04328843951225281,
+ -0.020654935389757156,
+ 0.08143945783376694,
+ 0.03210373967885971,
+ 0.03849901258945465,
+ 0.08388370275497437,
+ -0.04882088676095009,
+ -0.04764509201049805,
+ -0.01594746671617031,
+ 0.08005915582180023,
+ -0.0007682700525037944,
+ 0.04356953501701355,
+ -0.08784972876310349,
+ -0.009003485552966595,
+ -0.012332507409155369,
+ -3.9398202034135466e-08,
+ 0.006421600468456745,
+ 0.04334808140993118,
+ 0.0013437344459816813,
+ -0.009495558217167854,
+ -0.022657591849565506,
+ -0.012704327702522278,
+ 0.018703341484069824,
+ -0.07545771449804306,
+ -0.07807240635156631,
+ 0.0031038280576467514,
+ -0.023932253941893578,
+ 0.040701914578676224,
+ 0.10603249073028564,
+ 0.03773405775427818,
+ 0.05925403907895088,
+ -0.02083730883896351,
+ 0.052759915590286255,
+ 0.08195225894451141,
+ -0.057340435683727264,
+ -0.03538660705089569,
+ 0.04492119327187538,
+ -0.07101765275001526,
+ 0.02868317998945713,
+ -0.11165601015090942,
+ -0.03126508370041847,
+ -0.07953942567110062,
+ -0.022893071174621582,
+ -0.08839578926563263,
+ 0.00727836275473237,
+ -0.08685773611068726,
+ 0.026177138090133667,
+ 0.028831886127591133,
+ 0.03626682609319687,
+ -0.045381225645542145,
+ -0.013574030250310898,
+ 0.028583087027072906,
+ -0.004301569424569607,
+ 0.04326719045639038,
+ -0.023370176553726196,
+ 0.057897310703992844,
+ -0.029195263981819153,
+ -0.001789534231647849,
+ 0.032133687287569046,
+ 0.003419605316594243,
+ 0.028055502101778984,
+ -0.0038284522015601397,
+ -0.022835813462734222,
+ -0.07568305730819702,
+ 0.017481982707977295,
+ 0.013085611164569855,
+ 0.009357997216284275,
+ -0.030347391963005066,
+ -0.0020967889577150345,
+ 0.03544173017144203,
+ 0.004640925209969282,
+ 0.025202661752700806,
+ -0.0916307270526886,
+ -0.06341513246297836,
+ -0.017053432762622833,
+ 0.06747056543827057,
+ 0.0467485710978508,
+ -0.14364545047283173,
+ 0.024641912430524826,
+ -0.04414863884449005
+ ],
+ "model": "Eva 291",
+ "pickup_zone": "POLYGON((-80.2433 25.8067, -80.1333 25.8067, -80.1333 25.6967, -80.2433 25.6967, -80.2433 25.8067))",
+ "price": 3400,
+ "store_location": "-80.1918,25.7617"
+ },
+ {
+ "brand": "Noka Bikes",
+ "condition": "used",
+ "description": "Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women\u2019s saddle, different bars and unique colourway.",
+ "description_embeddings": [
+ 0.07420087605714798,
+ -0.01575474441051483,
+ 0.010670951567590237,
+ 0.07449527084827423,
+ 0.0060751838609576225,
+ 0.03211340680718422,
+ -0.008086569607257843,
+ 0.025549469515681267,
+ -0.07154879719018936,
+ 0.014914358966052532,
+ -0.030715830624103546,
+ -0.0064881909638643265,
+ -0.0071744490414857864,
+ -0.0495535172522068,
+ 0.03856685757637024,
+ 0.056132566183805466,
+ 0.10794447362422943,
+ -0.010181701742112637,
+ 0.0811777114868164,
+ 0.10135157406330109,
+ -0.0769873708486557,
+ -0.019640743732452393,
+ -0.028702793642878532,
+ 0.07654724270105362,
+ -0.07045057415962219,
+ -0.10104052722454071,
+ -0.004679638426750898,
+ -0.0027665267698466778,
+ 0.030919065698981285,
+ -0.05461210012435913,
+ -0.020669877529144287,
+ 0.031864751130342484,
+ 0.0835040882229805,
+ -0.05930671840906143,
+ -0.006361816544085741,
+ -0.044132985174655914,
+ 0.035945694893598557,
+ -0.0027891425415873528,
+ -0.07598478347063065,
+ -0.03105698712170124,
+ -0.059601303189992905,
+ -0.018435664474964142,
+ -0.03314891457557678,
+ 0.06877987831830978,
+ -0.016064301133155823,
+ 0.01545438077300787,
+ 0.056307148188352585,
+ -0.08382677286863327,
+ -0.05274924635887146,
+ 0.01139853335916996,
+ 0.10750263929367065,
+ -0.004042057786136866,
+ 0.003356053726747632,
+ -0.01083006989210844,
+ -0.06153054162859917,
+ -0.054990023374557495,
+ -0.1360272616147995,
+ 0.025806479156017303,
+ 0.043233320116996765,
+ -0.009591769427061081,
+ 0.04422037675976753,
+ 0.02436559833586216,
+ -0.0012137923622503877,
+ -0.015348327346146107,
+ 0.02425999939441681,
+ -0.03409525752067566,
+ -0.08487176895141602,
+ 0.017345253378152847,
+ 0.035498712211847305,
+ -0.05615586042404175,
+ 0.02745831571519375,
+ 0.04017677903175354,
+ -0.0936250239610672,
+ 0.048734042793512344,
+ 0.024287866428494453,
+ -0.030274393036961555,
+ 0.08800201117992401,
+ 0.0879313051700592,
+ -0.0550895519554615,
+ -0.0026407642289996147,
+ -0.09552258998155594,
+ -0.05870680510997772,
+ 0.09009534120559692,
+ 0.05674433708190918,
+ 0.05360940843820572,
+ -0.0023017164785414934,
+ 0.005036584101617336,
+ -0.017987212166190147,
+ -0.05129106715321541,
+ -0.0012550759129226208,
+ -0.05818512290716171,
+ 0.06725005060434341,
+ 0.02540011890232563,
+ 0.054589059203863144,
+ 0.01723511517047882,
+ -0.04752320423722267,
+ 0.10586173087358475,
+ 0.05530202388763428,
+ -0.03287632390856743,
+ 0.05258375406265259,
+ 0.01655220240354538,
+ 0.011849797330796719,
+ 0.032285332679748535,
+ 0.03760116547346115,
+ -0.017522728070616722,
+ -0.05457543954253197,
+ 0.006817341782152653,
+ -0.028400525450706482,
+ -0.0027318967040628195,
+ -0.04200681298971176,
+ -0.026171568781137466,
+ -0.03272707015275955,
+ 0.016305547207593918,
+ 0.01545319240540266,
+ 0.0056663742288947105,
+ -0.0977277085185051,
+ -0.0009383464348502457,
+ -0.005693590268492699,
+ 0.039240892976522446,
+ 0.01645808108150959,
+ -0.01950509287416935,
+ 0.007762903813272715,
+ -0.004406424704939127,
+ 0.016364052891731262,
+ -0.006125410553067923,
+ -0.029666034504771233,
+ 0.044946398586034775,
+ 1.8357034061219326e-33,
+ -0.053835414350032806,
+ 0.03495992720127106,
+ -0.05977822467684746,
+ -0.009059705771505833,
+ 0.004659880883991718,
+ 0.022712793201208115,
+ 0.04409413039684296,
+ -0.10094501823186874,
+ -0.08702167868614197,
+ 0.0066354661248624325,
+ 0.011878615245223045,
+ 0.0033176038414239883,
+ -0.012380938045680523,
+ 0.0010130798909813166,
+ 0.0644172728061676,
+ -0.07130810618400574,
+ -0.0045928386971354485,
+ -0.03375661373138428,
+ -0.022520871832966805,
+ 0.07504180818796158,
+ 0.009861051104962826,
+ 0.07191396504640579,
+ -0.014361198991537094,
+ 0.01449025422334671,
+ -0.010663183405995369,
+ -0.028888769447803497,
+ 0.09297508746385574,
+ 0.04386264830827713,
+ -0.09579017758369446,
+ 0.007718369830399752,
+ -0.11800525337457657,
+ -0.020133504644036293,
+ -0.0034684871789067984,
+ -0.03735410049557686,
+ 0.006975250784307718,
+ -0.012902614660561085,
+ 0.04201272875070572,
+ 0.04273228347301483,
+ -0.07133302837610245,
+ 0.09145014733076096,
+ 0.0048939259722828865,
+ -0.058044496923685074,
+ -0.017591776326298714,
+ -0.03502552956342697,
+ -0.05678534135222435,
+ 0.05471408739686012,
+ 0.09568087011575699,
+ 0.09486310184001923,
+ -0.045761823654174805,
+ 0.018188882619142532,
+ -0.12331638485193253,
+ -0.023129422217607498,
+ -0.05455191433429718,
+ 0.06732556223869324,
+ 0.048286039382219315,
+ -0.0014048831071704626,
+ 0.03308422118425369,
+ -0.009839850477874279,
+ -0.05661558359861374,
+ 0.03290552645921707,
+ 0.03661618381738663,
+ 0.0047610136680305,
+ -0.05254451557993889,
+ 0.006052205804735422,
+ -0.13153813779354095,
+ -0.006893055979162455,
+ 0.037368785589933395,
+ -0.03058353252708912,
+ -0.0017269864911213517,
+ -0.008851475082337856,
+ -0.0740399956703186,
+ 0.057353563606739044,
+ 0.12296456098556519,
+ 0.0413251556456089,
+ 0.09911972284317017,
+ 0.016817500814795494,
+ -0.048074446618556976,
+ 0.05658562108874321,
+ -0.012700358405709267,
+ -0.08663205802440643,
+ 0.0014393541496247053,
+ 0.00613820506259799,
+ -0.04446813836693764,
+ 0.04673916846513748,
+ -0.02757285162806511,
+ -0.05133393779397011,
+ -0.028082016855478287,
+ -0.04668722674250603,
+ -0.03849129378795624,
+ -0.047927819192409515,
+ -0.06503037363290787,
+ -0.08361010253429413,
+ 0.0393000952899456,
+ 0.04658354073762894,
+ 0.009724845178425312,
+ -2.0251938301584547e-33,
+ 0.07265108078718185,
+ -0.04307040572166443,
+ 0.04996086284518242,
+ 0.03520473092794418,
+ 0.1084771379828453,
+ 0.005833788774907589,
+ 0.046216338872909546,
+ -0.04042917117476463,
+ -0.04179416596889496,
+ 0.03598152473568916,
+ 0.04082870855927467,
+ -0.10612837225198746,
+ -0.010728210210800171,
+ 0.03610331192612648,
+ 0.027484672144055367,
+ -0.008130725473165512,
+ 0.026157474145293236,
+ -0.07420457899570465,
+ 0.025218356400728226,
+ -0.0898737907409668,
+ -0.02742879092693329,
+ 0.03535477817058563,
+ -0.062408916652202606,
+ -0.1569257229566574,
+ -0.018789052963256836,
+ 0.04845775291323662,
+ -0.015149657614529133,
+ -0.0018356313230469823,
+ -0.04590461030602455,
+ 0.023325689136981964,
+ -0.13069787621498108,
+ -0.01994006149470806,
+ -0.021577563136816025,
+ -0.0231519415974617,
+ -0.002478161361068487,
+ 0.022444186732172966,
+ -0.04681165888905525,
+ 0.02769998274743557,
+ 0.003438781714066863,
+ 0.03829822316765785,
+ 0.0243418887257576,
+ -0.020368436351418495,
+ -0.005010040942579508,
+ 0.04648580029606819,
+ 0.061260052025318146,
+ 0.03784928843379021,
+ 0.008547516539692879,
+ 0.027585946023464203,
+ 0.043608926236629486,
+ 0.047329846769571304,
+ 0.10433284938335419,
+ 0.0069401939399540424,
+ 0.043503858149051666,
+ 0.06499945372343063,
+ -0.01040438748896122,
+ -0.11596397310495377,
+ 0.06451629102230072,
+ 0.032956890761852264,
+ 0.0007023254293017089,
+ 0.0898808017373085,
+ -0.055529963225126266,
+ -0.006572310347110033,
+ -0.06089714914560318,
+ 0.022685443982481956,
+ -0.0013110691215842962,
+ -0.09440209716558456,
+ -0.03121936321258545,
+ -0.003408250631764531,
+ -0.08051110059022903,
+ 0.01802976056933403,
+ 0.032015636563301086,
+ -9.986010991269723e-05,
+ -0.011806532740592957,
+ 0.06818002462387085,
+ 0.028290249407291412,
+ -0.005312844179570675,
+ 0.06016719341278076,
+ 0.014397598803043365,
+ 0.07122596353292465,
+ 0.007864296436309814,
+ 0.03002011403441429,
+ -0.05413847416639328,
+ 0.09744291007518768,
+ -0.01965983398258686,
+ 0.04150940105319023,
+ 0.14307892322540283,
+ -0.11320102959871292,
+ 0.03503091260790825,
+ 0.003515399992465973,
+ -0.023677969351410866,
+ 0.03955819085240364,
+ 0.0534457303583622,
+ 0.01904974691569805,
+ 0.031267836689949036,
+ -0.018026702105998993,
+ -3.930426117904062e-08,
+ 0.0003057526773773134,
+ 0.013398992829024792,
+ -0.10113491117954254,
+ -0.016498351469635963,
+ -0.00534934364259243,
+ 0.017148228362202644,
+ -0.03217773512005806,
+ -0.030934104695916176,
+ -0.06334194540977478,
+ 0.07242853194475174,
+ -0.0047585368156433105,
+ -0.01996637135744095,
+ -0.0016463182400912046,
+ 0.01777566224336624,
+ -0.04115547239780426,
+ 0.02906038798391819,
+ 0.10273877531290054,
+ 0.022776247933506966,
+ 0.030065912753343582,
+ -0.014570299535989761,
+ 0.047994960099458694,
+ -0.044575825333595276,
+ 0.025753378868103027,
+ -0.002644166350364685,
+ -0.09429919719696045,
+ -0.11280428618192673,
+ 0.021306486800312996,
+ 0.010426397435367107,
+ 0.021093064919114113,
+ -0.00363176385872066,
+ -0.024409662932157516,
+ 0.11473581194877625,
+ 0.0020395806059241295,
+ -0.08371622860431671,
+ -0.03764123469591141,
+ 0.039440982043743134,
+ -0.022172994911670685,
+ 0.0410802997648716,
+ -0.05086303874850273,
+ 0.053952641785144806,
+ -0.06084167957305908,
+ -0.036132071167230606,
+ 0.02080748789012432,
+ -0.043120622634887695,
+ 0.04048219695687294,
+ 0.05917482078075409,
+ 0.04085611552000046,
+ -0.05118294060230255,
+ 0.015727631747722626,
+ 0.01915580965578556,
+ 0.03531794995069504,
+ -0.058007121086120605,
+ 0.08498086780309677,
+ 0.0036822939291596413,
+ 0.018125539645552635,
+ 0.10145474225282669,
+ -0.05804500728845596,
+ -0.008451723493635654,
+ -0.029611116275191307,
+ 0.008798911236226559,
+ -0.03220565244555473,
+ -0.05617227777838707,
+ 0.03482669219374657,
+ -0.03508705273270607
+ ],
+ "model": "Kahuna",
+ "pickup_zone": "POLYGON((-122.4644 37.8199, -122.3544 37.8199, -122.3544 37.7099, -122.4644 37.7099, -122.4644 37.8199))",
+ "price": 3200,
+ "store_location": "-122.4194,37.7749"
+ },
+ {
+ "brand": "Breakout",
+ "condition": "new",
+ "description": "The XBN 2.1 Alloy is our entry-level road bike \u2013 but that\u2019s not to say that it\u2019s a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimano\u2019s, this is a bike which doesn\u2019t break the bank and delivers craved performance.",
+ "description_embeddings": [
+ -0.03482655808329582,
+ -0.024290302768349648,
+ 0.029588153585791588,
+ -0.04068901762366295,
+ 0.006173150148242712,
+ -0.06071849912405014,
+ 0.021348219364881516,
+ 0.032668184489011765,
+ -0.12000397592782974,
+ -0.026135660707950592,
+ -0.0262606181204319,
+ -0.014927615411579609,
+ 0.06986956298351288,
+ -0.006424048915505409,
+ -0.002834598533809185,
+ -0.005902229342609644,
+ 0.07471967488527298,
+ -0.10197333246469498,
+ 0.08836513012647629,
+ 0.0504477359354496,
+ 0.005102860741317272,
+ 0.0359189435839653,
+ -0.0477643720805645,
+ 0.02106260135769844,
+ 0.030146656557917595,
+ 0.04048784077167511,
+ -0.023416390642523766,
+ -0.0016326266340911388,
+ 0.039820387959480286,
+ -0.04475116729736328,
+ -0.03422572463750839,
+ 0.09266746789216995,
+ -0.04106999188661575,
+ -0.02442021667957306,
+ -0.006325263995677233,
+ -0.057226430624723434,
+ 0.12074039876461029,
+ 0.012658749707043171,
+ -0.09748225659132004,
+ -0.048439353704452515,
+ -0.004550903104245663,
+ -0.014449959620833397,
+ 0.03684601932764053,
+ 0.018772389739751816,
+ 0.09577438980340958,
+ 0.04358510673046112,
+ 0.06987427175045013,
+ -0.0561334528028965,
+ -0.03684744983911514,
+ 0.02584502473473549,
+ 0.039536770433187485,
+ -0.061133887618780136,
+ 0.05351594462990761,
+ -0.025124184787273407,
+ 0.09431525319814682,
+ 0.05062168091535568,
+ -0.11715397238731384,
+ 0.044368330389261246,
+ -0.024262988939881325,
+ -0.024561986327171326,
+ 0.036067184060811996,
+ 0.025171849876642227,
+ 0.033648427575826645,
+ 0.046933531761169434,
+ 0.09548858553171158,
+ -0.06253167241811752,
+ -0.045195333659648895,
+ -0.04183578118681908,
+ -0.040385909378528595,
+ -0.027590686455368996,
+ 0.08240272104740143,
+ -0.04743463918566704,
+ 0.004482025280594826,
+ 0.03219064325094223,
+ 0.0007497097249142826,
+ -0.04202196002006531,
+ 0.10904812812805176,
+ -0.06721051037311554,
+ -0.023717032745480537,
+ -0.01718866638839245,
+ -0.11568725854158401,
+ 0.038704562932252884,
+ 0.04929516091942787,
+ -0.03311185538768768,
+ -0.0017465045675635338,
+ -0.06153444945812225,
+ 0.019559966400265694,
+ -0.010708335787057877,
+ -0.06623212993144989,
+ 0.03114122338593006,
+ 0.03581896796822548,
+ 0.05368824675679207,
+ 0.016093581914901733,
+ -0.0077278027310967445,
+ 0.025581376627087593,
+ 0.02375067211687565,
+ -0.024797597900032997,
+ 0.08371419459581375,
+ -0.023117447271943092,
+ 0.04535554349422455,
+ -0.007224411237984896,
+ 0.06131899356842041,
+ 0.02283627539873123,
+ -0.052097078412771225,
+ -0.07922855019569397,
+ 0.0016958570340648293,
+ 0.051785532385110855,
+ 0.06701217591762543,
+ -0.02913537621498108,
+ 0.020526740700006485,
+ 0.03941992297768593,
+ -0.02217993699014187,
+ -0.08051256835460663,
+ -0.10155311226844788,
+ -0.05453299731016159,
+ -0.06470758467912674,
+ 0.002029003808274865,
+ -0.013401892967522144,
+ -0.011006158776581287,
+ 0.045922696590423584,
+ -0.040529411286115646,
+ 0.00991761963814497,
+ -0.06682797521352768,
+ 0.05892198532819748,
+ -0.028617633506655693,
+ -0.06339140236377716,
+ 0.0044001322239637375,
+ -4.362402064591546e-33,
+ -0.10147389024496078,
+ 0.039431530982255936,
+ -0.04599899426102638,
+ -0.049156975001096725,
+ -0.02249804697930813,
+ -0.026725362986326218,
+ 0.04369090870022774,
+ -0.0005211823736317456,
+ -0.030739039182662964,
+ -0.0065231663174927235,
+ 0.025333819910883904,
+ 0.10470504313707352,
+ 0.021332278847694397,
+ 0.05556178465485573,
+ 0.035125020891427994,
+ -0.1538446545600891,
+ 0.007054235320538282,
+ -0.036041803658008575,
+ 0.05932909622788429,
+ 0.0337519533932209,
+ 0.014841740019619465,
+ 0.030220910906791687,
+ 0.04296395927667618,
+ 0.02538421005010605,
+ -0.006869863253086805,
+ -0.0031259972602128983,
+ 0.11390665918588638,
+ -0.046557214111089706,
+ 0.00429841224104166,
+ 0.0428440123796463,
+ -0.1384042203426361,
+ 0.04695465788245201,
+ -0.0574827715754509,
+ -0.030760489404201508,
+ -0.07478123158216476,
+ -0.029447706416249275,
+ -0.06204935908317566,
+ -0.03058161959052086,
+ -0.02502700313925743,
+ -0.019530421122908592,
+ -0.02094511315226555,
+ -0.03218250721693039,
+ -0.05274674668908119,
+ -0.02680223248898983,
+ -0.01955571211874485,
+ 0.018619371578097343,
+ 0.007585515268146992,
+ 0.07155954837799072,
+ -0.018960801884531975,
+ -0.05782055854797363,
+ 0.017819860950112343,
+ 0.04109930992126465,
+ -0.03562675416469574,
+ 0.016705146059393883,
+ 0.0415029413998127,
+ 0.05103381723165512,
+ 0.035572972148656845,
+ -0.015020242892205715,
+ -0.03179502114653587,
+ 0.0891512930393219,
+ 0.007475084625184536,
+ 0.042234599590301514,
+ -0.0542532242834568,
+ 0.05480321869254112,
+ -0.10602187365293503,
+ 0.054763536900281906,
+ 0.04739809036254883,
+ -0.03327919542789459,
+ 0.0082072913646698,
+ -0.0650608167052269,
+ -0.08271145075559616,
+ -0.10922762006521225,
+ 0.03824940696358681,
+ 0.05978637561202049,
+ 0.10005365312099457,
+ 0.029007570818066597,
+ -0.034110404551029205,
+ 0.02545103058218956,
+ 0.05190473049879074,
+ -0.003596875350922346,
+ -0.08473207801580429,
+ 0.012021052651107311,
+ 0.018175840377807617,
+ 0.017920689657330513,
+ -0.03348258137702942,
+ 0.04048585146665573,
+ 0.030843179672956467,
+ 0.019531769677996635,
+ -0.00910205114632845,
+ 0.05721440538764,
+ 0.007200753781944513,
+ -0.11394353210926056,
+ 0.03483451530337334,
+ 0.029621547088027,
+ -0.03755185008049011,
+ 9.393710556981876e-34,
+ -0.009642334654927254,
+ -0.001342272269539535,
+ 0.01180787943303585,
+ 0.026348579674959183,
+ -0.011158440262079239,
+ -0.0019478596514090896,
+ 0.028490403667092323,
+ -0.052807874977588654,
+ -0.029139718040823936,
+ 0.08380713313817978,
+ 0.09657946228981018,
+ 0.00991911068558693,
+ 0.03502354025840759,
+ -0.016754556447267532,
+ 0.017460109665989876,
+ -0.01642783358693123,
+ 0.022211389616131783,
+ -0.008778599090874195,
+ 3.654864485724829e-05,
+ -0.09229966253042221,
+ 0.04083291441202164,
+ 0.08299239724874496,
+ -0.04151370748877525,
+ -0.05360836163163185,
+ -0.07950830459594727,
+ 0.03959093242883682,
+ -0.13340364396572113,
+ 0.054901909083127975,
+ 0.05736061558127403,
+ 0.04770279303193092,
+ -0.11388063430786133,
+ 0.0237369854003191,
+ 0.02305987849831581,
+ -0.013226242735981941,
+ -0.020716888830065727,
+ 0.03368164971470833,
+ -0.002396275522187352,
+ -0.012604329735040665,
+ -0.02715742215514183,
+ 0.0019254887010902166,
+ -0.00887741707265377,
+ -0.028728270903229713,
+ -0.05864499509334564,
+ 0.10937061905860901,
+ -0.004027256276458502,
+ 0.019197454676032066,
+ -0.03928225114941597,
+ -0.018220100551843643,
+ 0.02466396614909172,
+ 0.00980517640709877,
+ 0.05513712763786316,
+ 0.10625418275594711,
+ 0.08366440236568451,
+ -0.02691512741148472,
+ -0.026599230244755745,
+ -0.049529410898685455,
+ -0.05376818776130676,
+ -0.003328752936795354,
+ -0.04345694184303284,
+ 0.11166279017925262,
+ 0.0407760851085186,
+ -0.00792837142944336,
+ 0.03168283402919769,
+ -0.0018123856279999018,
+ 0.0357111431658268,
+ -0.1368872970342636,
+ 0.00755245191976428,
+ -0.010281031019985676,
+ -0.07121222466230392,
+ 0.03101137839257717,
+ 0.0662078782916069,
+ 0.007085337769240141,
+ -0.007063422352075577,
+ -0.05238816514611244,
+ -0.004185437690466642,
+ 0.00880429521203041,
+ 0.05528423562645912,
+ -0.08964741230010986,
+ 0.0042182342149317265,
+ -0.029020531103014946,
+ 0.014597366563975811,
+ 0.0002752764557953924,
+ 0.032267484813928604,
+ 0.11250412464141846,
+ 0.002768452512100339,
+ -0.026546282693743706,
+ 0.017761094495654106,
+ 0.023686127737164497,
+ -0.012699384242296219,
+ 0.018606871366500854,
+ -0.009665136225521564,
+ -0.06902427226305008,
+ -0.04932688549160957,
+ 0.051991984248161316,
+ -0.05918996408581734,
+ -4.18107468647122e-08,
+ -0.06375139951705933,
+ -0.0029491656459867954,
+ 0.032401617616415024,
+ -0.024946069344878197,
+ -0.026347795501351357,
+ 0.020192604511976242,
+ -0.025759287178516388,
+ 0.037004951387643814,
+ 0.043629322201013565,
+ 0.06278910487890244,
+ 0.02097572200000286,
+ -0.07064115256071091,
+ -0.005097216460853815,
+ 0.016486743465065956,
+ -0.0032796994782984257,
+ 0.07957274466753006,
+ 0.03776371479034424,
+ 0.04259084165096283,
+ -0.005312138702720404,
+ -0.11992045491933823,
+ 0.0859612300992012,
+ -0.0500827394425869,
+ 0.02553708106279373,
+ -0.052115052938461304,
+ -0.07368568331003189,
+ -0.11394031345844269,
+ -0.04513951390981674,
+ 0.022121727466583252,
+ -0.010451988317072392,
+ 0.003997989930212498,
+ -0.13713733851909637,
+ 0.030619636178016663,
+ 0.05786789208650589,
+ 0.05840904265642166,
+ 0.04732450470328331,
+ -0.012547117657959461,
+ -0.027409126982092857,
+ 0.049672048538923264,
+ -0.00018399256805423647,
+ -0.004273589234799147,
+ -0.011101006530225277,
+ 0.017240682616829872,
+ -0.002812016289681196,
+ 0.034935809671878815,
+ 0.006601597648113966,
+ 0.014211715199053288,
+ -0.06332860141992569,
+ -0.05397455021739006,
+ -0.038572490215301514,
+ -0.06450864672660828,
+ 0.07963147014379501,
+ 0.029951799660921097,
+ 0.03153093531727791,
+ -0.03852103650569916,
+ -0.025755248963832855,
+ 0.13077980279922485,
+ -0.08185151219367981,
+ -0.09442253410816193,
+ 0.01002975832670927,
+ 0.02509395219385624,
+ -0.029981056228280067,
+ -0.025097224861383438,
+ 0.04001101851463318,
+ 0.006130080670118332
+ ],
+ "model": "XBN 2.1 Alloy",
+ "pickup_zone": "POLYGON((-0.1778 51.5524, 0.0822 51.5524, 0.0822 51.4024, -0.1778 51.4024, -0.1778 51.5524))",
+ "price": 810,
+ "store_location": "-0.1278,51.5074"
+ },
+ {
+ "brand": "ScramBikes",
+ "condition": "new",
+ "description": "The WattBike is the best e-bike for people who still feel young at heart. It has a Bafang 1000W mid-drive system and a 48V 17.5AH Samsung Lithium-Ion battery, allowing you to ride for more than 60 miles on one charge. It\u2019s great for tackling hilly terrain or if you just fancy a more leisurely ride. With three working modes, you can choose between E-bike, assisted bicycle, and normal bike modes.",
+ "description_embeddings": [
+ -0.006927311420440674,
+ 0.15900678932666779,
+ -0.005495064426213503,
+ 0.06652409583330154,
+ 0.027506737038493156,
+ 0.03928178921341896,
+ 0.0212758406996727,
+ 0.08142763376235962,
+ -0.004556896630674601,
+ 0.04261007905006409,
+ 0.0852041020989418,
+ -0.048658017069101334,
+ 0.04896014556288719,
+ 0.008289206773042679,
+ 0.09533551335334778,
+ 0.042673129588365555,
+ 0.11990982294082642,
+ -0.09381455183029175,
+ -0.001154645229689777,
+ -0.009989846497774124,
+ 0.042972203344106674,
+ 0.055328626185655594,
+ 0.044754382222890854,
+ 0.01764347031712532,
+ 0.04503790661692619,
+ -0.003830699948593974,
+ -0.03431522846221924,
+ 0.03080279380083084,
+ -0.07722456008195877,
+ -0.09261710941791534,
+ 0.04810558632016182,
+ 0.04917953535914421,
+ 0.027227703481912613,
+ -0.04199009761214256,
+ -0.11837311834096909,
+ 0.028090154752135277,
+ 0.08678824454545975,
+ -0.052036624401807785,
+ -0.06585966050624847,
+ -0.04037070646882057,
+ -0.08040877431631088,
+ 0.0018185328226536512,
+ 0.043989114463329315,
+ -0.011817573569715023,
+ 0.006730342749506235,
+ -0.011594205163419247,
+ 0.008361537009477615,
+ -0.054372794926166534,
+ 0.033345889300107956,
+ -0.03933562710881233,
+ 0.10115987062454224,
+ -0.08934503048658371,
+ 0.04519934952259064,
+ 0.03582148626446724,
+ -0.021424520760774612,
+ -0.07357319444417953,
+ -0.07426925748586655,
+ 0.018053170293569565,
+ 0.04639451205730438,
+ -0.07499486207962036,
+ 0.057791586965322495,
+ -0.05478687211871147,
+ 0.030340412631630898,
+ -0.0056327772326767445,
+ -0.0452428013086319,
+ -0.044913534075021744,
+ 0.0526629202067852,
+ -0.08259481936693192,
+ -0.05616062134504318,
+ 0.0005400424124673009,
+ -0.04933836683630943,
+ 1.7464293705415912e-05,
+ -0.007984945550560951,
+ 0.009467384777963161,
+ -0.04055757448077202,
+ -0.0056908270344138145,
+ 0.036597516387701035,
+ 0.023873118683695793,
+ 0.00418807053938508,
+ 0.04676923528313637,
+ -0.053795333951711655,
+ -0.015527212992310524,
+ -0.080276258289814,
+ 0.026996882632374763,
+ 0.1144171804189682,
+ -0.011178486980497837,
+ 0.06854862719774246,
+ 0.022201502695679665,
+ -0.01913747377693653,
+ 0.009713435545563698,
+ 0.01423699501901865,
+ 0.04772024229168892,
+ 0.034634001553058624,
+ 0.0756441131234169,
+ -0.01204933412373066,
+ -0.031088251620531082,
+ -0.02462930977344513,
+ -0.04386857897043228,
+ -0.07706759870052338,
+ -0.002071107504889369,
+ -0.019828464835882187,
+ 0.10314348340034485,
+ 0.07235224545001984,
+ 0.03167572245001793,
+ -0.02631053328514099,
+ -0.036559153348207474,
+ 0.012040914967656136,
+ 0.08063311874866486,
+ 0.008269569836556911,
+ -0.012434666976332664,
+ 0.00650354428216815,
+ -0.05601133033633232,
+ -0.028117282316088676,
+ -0.025071244686841965,
+ -0.01907099038362503,
+ 0.003760937135666609,
+ -0.052525606006383896,
+ 0.07173370569944382,
+ 0.09372185170650482,
+ 0.1006019189953804,
+ 0.023999499157071114,
+ 0.041847433894872665,
+ 0.02114962227642536,
+ 0.05726422369480133,
+ 0.008218048140406609,
+ -0.06967302411794662,
+ 0.01968124881386757,
+ 1.844028477519647e-33,
+ -0.031731415539979935,
+ 0.03648626059293747,
+ -0.026035945862531662,
+ -0.026796391233801842,
+ 0.009511047042906284,
+ 0.050696976482868195,
+ -0.03008556365966797,
+ -0.027142174541950226,
+ -0.07182826101779938,
+ -0.02520623430609703,
+ -0.005983793176710606,
+ 0.07632830739021301,
+ 0.09301365166902542,
+ 0.0744069442152977,
+ 0.10173527896404266,
+ -0.08317957073450089,
+ -0.06219454109668732,
+ -0.0776224136352539,
+ 0.013563201762735844,
+ 0.005839265417307615,
+ 0.011761599220335484,
+ -0.0701083242893219,
+ 0.005647188518196344,
+ -0.007439272943884134,
+ -4.4855809392174706e-05,
+ -0.05095696449279785,
+ 0.13620494306087494,
+ 0.017342044040560722,
+ -0.01352923084050417,
+ 0.03086051531136036,
+ -0.0740780308842659,
+ -0.06721310317516327,
+ -0.06769067794084549,
+ 0.01185466069728136,
+ -0.07234086841344833,
+ 0.0020215404219925404,
+ -0.0108563881367445,
+ 0.007788154762238264,
+ 0.07912690192461014,
+ -0.02952556498348713,
+ -0.010350959375500679,
+ 0.025074176490306854,
+ -0.050776757299900055,
+ 0.00947178341448307,
+ 0.03259417414665222,
+ 0.0319671556353569,
+ 0.0379379540681839,
+ 0.05242982879281044,
+ -0.07516643404960632,
+ 0.020074544474482536,
+ -0.08712191134691238,
+ -0.01204316969960928,
+ -0.006554455496370792,
+ -0.005875407252460718,
+ -0.06922540068626404,
+ 0.041081465780735016,
+ -0.003257623640820384,
+ 0.0391659140586853,
+ -0.03731334209442139,
+ -0.03579063341021538,
+ -0.04008869081735611,
+ 0.05648549646139145,
+ -0.01142149232327938,
+ -0.05515728518366814,
+ -0.06406072527170181,
+ -0.013155528344213963,
+ 0.0029902313835918903,
+ -0.020829875022172928,
+ -0.13008210062980652,
+ -0.039412979036569595,
+ 0.05974568799138069,
+ -0.06617670506238937,
+ 0.09968123584985733,
+ -0.04378099367022514,
+ 0.008272947743535042,
+ -0.007245620246976614,
+ -0.05228377878665924,
+ -0.05929296463727951,
+ -0.07816570997238159,
+ 0.04665905237197876,
+ -0.01630396395921707,
+ -0.020880484953522682,
+ -0.06532212346792221,
+ -0.003213261254131794,
+ 0.0416768379509449,
+ -0.05093088001012802,
+ -0.0871049091219902,
+ -0.014571009203791618,
+ 0.0010796786518767476,
+ 0.007087667006999254,
+ 0.05550219491124153,
+ -0.07753361761569977,
+ 0.022848013788461685,
+ 0.02596968039870262,
+ 0.04259824752807617,
+ -2.380165022444961e-33,
+ 0.05820159241557121,
+ 0.046025633811950684,
+ 0.10894608497619629,
+ 0.05244075506925583,
+ 0.15792003273963928,
+ 0.024086199700832367,
+ 0.029237573966383934,
+ -0.023072607815265656,
+ -0.07495220005512238,
+ -0.013094011694192886,
+ -0.004260784015059471,
+ -0.053080882877111435,
+ -0.00895928218960762,
+ -0.03149857744574547,
+ 0.13309381902217865,
+ 0.038643430918455124,
+ -0.02136029675602913,
+ -0.030247559770941734,
+ 0.08822915703058243,
+ -0.026076463982462883,
+ 0.050446517765522,
+ 0.011856893077492714,
+ -0.06957101821899414,
+ -0.02773614600300789,
+ 0.04625667631626129,
+ 0.008786994963884354,
+ -0.07701855897903442,
+ 0.001076446962542832,
+ -0.004858669359236956,
+ 0.0067254831083118916,
+ -0.02791707031428814,
+ -0.019495468586683273,
+ 0.0703381896018982,
+ 0.030558260157704353,
+ -0.05546342208981514,
+ 0.0420801043510437,
+ -0.03730127215385437,
+ -0.01322201732546091,
+ 0.038336288183927536,
+ 0.06427455693483353,
+ 0.028238974511623383,
+ -0.06713984161615372,
+ 0.03150900453329086,
+ 0.024600861594080925,
+ 0.016221575438976288,
+ 0.025838203728199005,
+ -0.02313261851668358,
+ 0.0557485967874527,
+ 0.015211678110063076,
+ 0.029895616695284843,
+ 0.06008606031537056,
+ 0.04473312199115753,
+ -0.050083715468645096,
+ -0.017571061849594116,
+ -0.014091495424509048,
+ -0.06641074270009995,
+ -0.008071008138358593,
+ 0.03312089666724205,
+ -0.09482058882713318,
+ -0.08763624727725983,
+ 0.030528157949447632,
+ 0.013274747878313065,
+ 0.06158939003944397,
+ 0.0748405009508133,
+ -0.12128522247076035,
+ -0.12076683342456818,
+ 0.0464591421186924,
+ 0.0045278542675077915,
+ -0.002574144396930933,
+ -0.028266169130802155,
+ -0.04953430965542793,
+ -0.007604515179991722,
+ -0.01084962673485279,
+ -0.06370151042938232,
+ 0.00812828354537487,
+ -0.027805447578430176,
+ 0.044624149799346924,
+ 0.016610005870461464,
+ -0.027103105559945107,
+ -0.046117331832647324,
+ -0.002852817066013813,
+ 0.05479831248521805,
+ 0.05342277139425278,
+ -0.03752776235342026,
+ -0.0053502353839576244,
+ -0.018950853496789932,
+ -0.07712738960981369,
+ -0.13029317557811737,
+ -0.013171681202948093,
+ 0.02069253847002983,
+ 0.029317859560251236,
+ 0.018668048083782196,
+ -0.061371881514787674,
+ 0.05376929044723511,
+ 0.01483837515115738,
+ -3.964297690117746e-08,
+ 0.03559036925435066,
+ -0.005289694294333458,
+ -0.013635152950882912,
+ -0.020672710612416267,
+ 0.039649732410907745,
+ -0.06206038221716881,
+ 0.04933065176010132,
+ 0.010378899984061718,
+ 0.020493512973189354,
+ 0.027486076578497887,
+ 0.07419533282518387,
+ -0.03473059833049774,
+ 0.05251400172710419,
+ 0.013588557951152325,
+ 0.01814397983253002,
+ -0.024619124829769135,
+ 0.11751414835453033,
+ 0.05483951419591904,
+ 0.022471528500318527,
+ 0.0301313828676939,
+ 0.018649602308869362,
+ -0.06219587102532387,
+ 0.04238469526171684,
+ -0.053293377161026,
+ 0.002427657600492239,
+ -0.0019911346025764942,
+ 0.004944113548845053,
+ -0.061433035880327225,
+ -0.013191037811338902,
+ -0.030179856345057487,
+ -0.051340680569410324,
+ 0.022094713523983955,
+ -0.035341646522283554,
+ -0.007219062652438879,
+ -0.06182244420051575,
+ -0.06059279292821884,
+ -0.041057273745536804,
+ 0.002089729532599449,
+ -0.043397895991802216,
+ 0.07170896232128143,
+ 0.036471735686063766,
+ -0.015439609996974468,
+ -0.01848314143717289,
+ 0.0056609525345265865,
+ -0.0012752920156344771,
+ -0.056571539491415024,
+ -0.01979043148458004,
+ -0.12011151015758514,
+ -0.02223217859864235,
+ 0.029830070212483406,
+ 0.027551136910915375,
+ -0.0010704555315896869,
+ 0.000702365068718791,
+ -0.005173679441213608,
+ -0.019360698759555817,
+ 0.17009279131889343,
+ -0.04601005092263222,
+ -0.04016156122088432,
+ -0.01600208878517151,
+ 0.04198170080780983,
+ 0.02032368630170822,
+ -0.06263051927089691,
+ -0.048464443534612656,
+ 0.009351130574941635
+ ],
+ "model": "WattBike",
+ "pickup_zone": "POLYGON((2.1767 48.9016, 2.5267 48.9016, 2.5267 48.5516, 2.1767 48.5516, 2.1767 48.9016))",
+ "price": 2300,
+ "store_location": "2.3522,48.8566"
+ },
+ {
+ "brand": "Peaknetic",
+ "condition": "new",
+ "description": "If you struggle with stiff fingers or a kinked neck or back after a few minutes on the road, this lightweight, aluminum bike alleviates those issues and allows you to enjoy the ride. From the ergonomic grips to the lumbar-supporting seat position, the Roll Low-Entry offers incredible comfort. The rear-inclined seat tube facilitates stability by allowing you to put a foot on the ground to balance at a stop, and the low step-over frame makes it accessible for all ability and mobility levels. The saddle is very soft, with a wide back to support your hip joints and a cutout in the center to redistribute that pressure. Rim brakes deliver satisfactory braking control, and the wide tires provide a smooth, stable ride on paved roads and gravel. Rack and fender mounts facilitate setting up the Roll Low-Entry as your preferred commuter, and the BMX-like handlebar offers space for mounting a flashlight, bell, or phone holder.",
+ "description_embeddings": [
+ 0.0022135202307254076,
+ 0.0681997612118721,
+ 0.0064607178792357445,
+ 0.007070810534060001,
+ -0.054231829941272736,
+ 0.008059866726398468,
+ 0.040072083473205566,
+ 0.0956423208117485,
+ 0.049143481999635696,
+ 0.0379914790391922,
+ -0.020757146179676056,
+ 0.06460786610841751,
+ 0.07982552796602249,
+ -0.0321788415312767,
+ -0.006194670218974352,
+ 0.0375053696334362,
+ 0.1270381063222885,
+ -0.02341461181640625,
+ -0.007247396744787693,
+ 0.0682845488190651,
+ -0.026470346376299858,
+ 0.005658577661961317,
+ 0.04653697833418846,
+ 0.03987714648246765,
+ -0.12344618886709213,
+ 0.03188862279057503,
+ -0.02708076685667038,
+ 0.06964577734470367,
+ 0.02201199159026146,
+ -0.02890665829181671,
+ -0.040280576795339584,
+ 0.06318672746419907,
+ 0.07309666275978088,
+ -0.08932560682296753,
+ -0.11648543179035187,
+ -0.029937371611595154,
+ 0.10487373173236847,
+ 0.041655637323856354,
+ -0.022871389985084534,
+ -0.04677774757146835,
+ 0.02746077999472618,
+ 0.01847464218735695,
+ 0.08173345029354095,
+ 0.06561841815710068,
+ 0.05970228090882301,
+ -0.024480478838086128,
+ 0.06907600909471512,
+ -0.03947169706225395,
+ 0.024855393916368484,
+ -0.013199429027736187,
+ 0.09996063262224197,
+ 0.0028578736819326878,
+ 0.08506831526756287,
+ 0.014810853637754917,
+ -0.03929787874221802,
+ 0.0018542942125350237,
+ -0.14215077459812164,
+ 0.06970464438199997,
+ 0.0265016071498394,
+ -0.06698428839445114,
+ 0.07732488960027695,
+ -0.04583248123526573,
+ 0.028696633875370026,
+ 0.013155206106603146,
+ 0.02578958310186863,
+ -0.029291296377778053,
+ -0.00031816380214877427,
+ -0.125708669424057,
+ -0.042060736566782,
+ -0.05381627008318901,
+ -0.0538906455039978,
+ 0.0014778936747461557,
+ -0.09889215975999832,
+ -0.0429794080555439,
+ -0.013458915054798126,
+ -0.04558553919196129,
+ 0.09005370736122131,
+ -0.04213777929544449,
+ -0.1349189579486847,
+ 0.055852413177490234,
+ 0.006197084207087755,
+ 0.016338912770152092,
+ 0.032463233917951584,
+ 0.02548987604677677,
+ 0.030681701377034187,
+ -0.0703219398856163,
+ 0.05395807698369026,
+ -0.009628057479858398,
+ -0.031475286930799484,
+ -0.027579376474022865,
+ 0.04098684713244438,
+ 0.03901920095086098,
+ -0.01192146260291338,
+ -0.04101356491446495,
+ -0.08753280341625214,
+ 0.0705665871500969,
+ 0.03578994423151016,
+ 0.032069701701402664,
+ -0.03211764618754387,
+ 0.09590566158294678,
+ 0.0611797571182251,
+ 0.004700345452874899,
+ 0.10438291728496552,
+ 0.07409676164388657,
+ -0.0090691689401865,
+ 0.011407091282308102,
+ 0.05370165407657623,
+ -0.020438825711607933,
+ -0.04398776963353157,
+ 0.032895661890506744,
+ -0.0012730252929031849,
+ 0.018297234550118446,
+ -0.04333885386586189,
+ 0.06208101287484169,
+ -0.08955910801887512,
+ -0.04672509804368019,
+ -0.06376977264881134,
+ 0.022537674754858017,
+ 0.02881341427564621,
+ -0.0030273371376097202,
+ -0.06542699784040451,
+ 0.007231372408568859,
+ 0.01855703443288803,
+ 0.012365416623651981,
+ 0.018434280529618263,
+ -0.04855069890618324,
+ -0.08907819539308548,
+ -2.615521077916409e-34,
+ -0.046131156384944916,
+ -0.028526470065116882,
+ 0.01342072058469057,
+ -0.010418130084872246,
+ -0.019669201225042343,
+ -0.07430055737495422,
+ -0.006000629626214504,
+ -0.03320513665676117,
+ -0.05303066596388817,
+ 0.07680810242891312,
+ -0.0061429338529706,
+ 0.06154831871390343,
+ 0.09432042390108109,
+ 0.0038354273419827223,
+ 0.14506474137306213,
+ -0.07032876461744308,
+ -0.07443196326494217,
+ -0.04439792409539223,
+ -0.005104243289679289,
+ -3.3934433304239064e-05,
+ -0.08257872611284256,
+ -0.056131236255168915,
+ 0.04174238070845604,
+ 0.0017745267832651734,
+ -0.002772972686216235,
+ 0.006998051423579454,
+ 0.09371285885572433,
+ -0.013138788752257824,
+ -0.042773280292749405,
+ 0.00896062795072794,
+ -0.09441300481557846,
+ -0.007952050305902958,
+ -0.015586148016154766,
+ -0.017506571486592293,
+ 0.01347337942570448,
+ 0.027937229722738266,
+ -0.11657726019620895,
+ -0.03324989974498749,
+ -0.018427638337016106,
+ -0.04819897934794426,
+ -0.04077771306037903,
+ -0.0001697312545729801,
+ -0.05697356536984444,
+ 0.07191669940948486,
+ 0.017228955402970314,
+ 0.03711475431919098,
+ 0.042057864367961884,
+ 0.004786928184330463,
+ -0.06956200301647186,
+ 0.06036132574081421,
+ -0.0016305814497172832,
+ 0.02468821406364441,
+ -0.013794313184916973,
+ -0.025994934141635895,
+ -0.07489914447069168,
+ 0.01067660003900528,
+ -0.010298662818968296,
+ -0.022154971957206726,
+ -0.09746527671813965,
+ 0.06335768103599548,
+ -0.022728655487298965,
+ -0.0005628599901683629,
+ -0.04313022270798683,
+ -0.04123309254646301,
+ -0.08378659188747406,
+ 0.020546691492199898,
+ 0.01680913008749485,
+ -0.010155763477087021,
+ 0.008547178469598293,
+ -0.0211178008466959,
+ 0.023050235584378242,
+ 0.06479462236166,
+ 0.061528537422418594,
+ 0.022156352177262306,
+ 0.019619867205619812,
+ 0.07456795871257782,
+ 0.049971628934144974,
+ -0.07878398895263672,
+ 0.04972408711910248,
+ -0.015442566946148872,
+ 0.044758349657058716,
+ -0.037393294274806976,
+ -0.03831558674573898,
+ -0.016534404829144478,
+ -0.05692937225103378,
+ 0.02438316121697426,
+ -0.008604591712355614,
+ -0.06003899499773979,
+ 0.04884570837020874,
+ -0.05407913774251938,
+ -0.004864877089858055,
+ -0.039421387016773224,
+ -0.0335439033806324,
+ 0.05149518698453903,
+ -0.00761334178969264,
+ -4.919814414418271e-34,
+ 0.0605306513607502,
+ 0.013155259191989899,
+ 0.0022042335476726294,
+ -0.016238724812865257,
+ 0.017820321023464203,
+ -0.029504502192139626,
+ 0.1179562360048294,
+ -0.08494631201028824,
+ -0.05847567319869995,
+ -0.03412671759724617,
+ 0.01584434323012829,
+ 0.0205944012850523,
+ 0.011703073978424072,
+ 0.024820921942591667,
+ 0.07683313637971878,
+ 0.016703670844435692,
+ -0.0465223602950573,
+ -0.08929521590471268,
+ 0.013778958469629288,
+ -0.06448621302843094,
+ 0.047237128019332886,
+ 0.11140323430299759,
+ -0.036479681730270386,
+ -0.055252984166145325,
+ -0.08155377954244614,
+ -0.0011454259511083364,
+ -0.07414430379867554,
+ 0.04839516803622246,
+ -0.036127883940935135,
+ 0.04249665141105652,
+ -0.05564387887716293,
+ 0.008439254947006702,
+ 0.056384216994047165,
+ 0.0037136792670935392,
+ -0.06267311424016953,
+ 0.06599505990743637,
+ -0.0944608598947525,
+ -0.01900491677224636,
+ 0.0017078104428946972,
+ 0.018181079998612404,
+ 0.0072936019860208035,
+ 0.03901578113436699,
+ 0.022009696811437607,
+ -0.02042953297495842,
+ 0.04422936588525772,
+ 0.099826380610466,
+ 0.0022175773046910763,
+ 0.05569764971733093,
+ 0.005229232832789421,
+ -0.06281892955303192,
+ 0.06203164905309677,
+ 0.05493532121181488,
+ 0.06598878651857376,
+ 0.06272768974304199,
+ 0.05623844638466835,
+ -0.053184594959020615,
+ 0.012609804049134254,
+ -0.009191329590976238,
+ -0.07956400513648987,
+ -0.005095178727060556,
+ -0.06295286118984222,
+ 0.05799472704529762,
+ 0.004298996180295944,
+ -0.0245245061814785,
+ -0.010027579963207245,
+ -0.02338206022977829,
+ -0.03576310724020004,
+ -0.0735088586807251,
+ -0.10477573424577713,
+ 0.010318689979612827,
+ -0.031293049454689026,
+ -0.06913845986127853,
+ 0.07762496173381805,
+ -0.029345618560910225,
+ 0.03347797319293022,
+ 0.014305013231933117,
+ 0.06321006268262863,
+ -0.09872464835643768,
+ -0.040937263518571854,
+ 0.028350593522191048,
+ -0.08784928917884827,
+ 0.005375882610678673,
+ 0.059733789414167404,
+ 0.027322115376591682,
+ -0.04657347500324249,
+ 0.02783248759806156,
+ -0.12815773487091064,
+ 0.004414730705320835,
+ -0.009058866649866104,
+ 0.06062375009059906,
+ 0.04072198644280434,
+ 0.05082780495285988,
+ -0.036888547241687775,
+ 0.07301440089941025,
+ 0.022250277921557426,
+ -4.836826761334123e-08,
+ -0.02333931438624859,
+ -0.0006597689352929592,
+ -0.011001646518707275,
+ 0.01690472476184368,
+ -0.0037487675435841084,
+ 0.039681874215602875,
+ -0.012263616546988487,
+ 0.010128140449523926,
+ 0.03165998309850693,
+ 0.0028211181052029133,
+ 0.009292887523770332,
+ -0.05068610981106758,
+ -0.05350435897707939,
+ 0.0027450143825262785,
+ -0.02869512513279915,
+ 0.18523184955120087,
+ 0.010015024803578854,
+ 0.04042758792638779,
+ 0.010014397092163563,
+ -0.07638011872768402,
+ -0.04126984626054764,
+ -0.06051325798034668,
+ 0.04609273001551628,
+ -0.00863336119800806,
+ -0.010159372352063656,
+ -0.0686831921339035,
+ -0.022274712100625038,
+ 0.054596077650785446,
+ -0.004217579495161772,
+ 0.005010589957237244,
+ -0.0023027928546071053,
+ 0.054350487887859344,
+ 0.051168326288461685,
+ -0.0005977987311780453,
+ 0.0008231411338783801,
+ -0.005349422339349985,
+ -0.04023698344826698,
+ 0.01875622756779194,
+ 0.051792532205581665,
+ 0.0725129023194313,
+ 0.003990984987467527,
+ -0.0412585511803627,
+ -0.030975697562098503,
+ 0.02229507826268673,
+ -0.023536084219813347,
+ 0.004254089202731848,
+ -0.047596003860235214,
+ 0.054139409214258194,
+ 0.024750487878918648,
+ 0.00830126740038395,
+ 0.04204926639795303,
+ -0.05580601468682289,
+ 0.014396552927792072,
+ 0.0785103291273117,
+ -0.01755904220044613,
+ 0.09679318964481354,
+ -0.01722336746752262,
+ -0.03680667281150818,
+ -0.021823544055223465,
+ 0.044612541794776917,
+ -0.0008680447936058044,
+ 0.027066197246313095,
+ -0.008826435543596745,
+ -0.034606464207172394
+ ],
+ "model": "Secto",
+ "pickup_zone": "POLYGON((13.3260 52.5700, 13.6550 52.5700, 13.6550 52.2700, 13.3260 52.2700, 13.3260 52.5700))",
+ "price": 430,
+ "store_location": "13.4050,52.5200"
+ },
+ {
+ "brand": "nHill",
+ "condition": "new",
+ "description": "This budget mountain bike from nHill performs well both on bike paths and on the trail. The fork with 100mm of travel absorbs rough terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. The Shimano Tourney drivetrain offered enough gears for finding a comfortable pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. Whether you want an affordable bike that you can take to work, but also take trail in mountains on the weekends or you\u2019re just after a stable, comfortable ride for the bike path, the Summit gives a good value for money.",
+ "description_embeddings": [
+ -0.024333441630005836,
+ 0.029308300465345383,
+ -0.012847754172980785,
+ -0.013123984448611736,
+ -0.039905961602926254,
+ -0.04596070945262909,
+ -0.01287133153527975,
+ 0.03984961286187172,
+ -0.043438445776700974,
+ 0.012349214404821396,
+ -0.021342391148209572,
+ -0.027458613738417625,
+ -0.004793129395693541,
+ 0.016479987651109695,
+ 0.02052542380988598,
+ -0.009542089886963367,
+ 0.10066469013690948,
+ 0.017397526651620865,
+ 0.07893014699220657,
+ -0.0765308141708374,
+ -0.007650941610336304,
+ 9.538845188217238e-05,
+ 0.03314477205276489,
+ 0.026631362736225128,
+ -0.01621824875473976,
+ 0.03593063727021217,
+ -0.014871303923428059,
+ 0.05259871482849121,
+ 0.027785824611783028,
+ -0.044416770339012146,
+ -0.026691904291510582,
+ -0.01390022411942482,
+ -0.0573929138481617,
+ -0.08761026710271835,
+ 0.012642575427889824,
+ 0.04252056032419205,
+ 0.04015251249074936,
+ -0.0052475095726549625,
+ -0.08608037978410721,
+ 0.0028531427960842848,
+ -0.003371630096808076,
+ -0.02032443881034851,
+ -0.029511747881770134,
+ -0.043690912425518036,
+ 0.042122989892959595,
+ -0.057133886963129044,
+ 0.019293654710054398,
+ -0.019127611070871353,
+ 0.036713697016239166,
+ -0.00833116751164198,
+ 0.009040397591888905,
+ -0.1087319627404213,
+ 0.09127230197191238,
+ -0.048213958740234375,
+ -0.023604029789566994,
+ 0.0008899428648874164,
+ -0.093184694647789,
+ -0.03436879441142082,
+ 0.00807907897979021,
+ -0.0520450733602047,
+ 0.02262270636856556,
+ -0.03259866312146187,
+ -0.0391012541949749,
+ 0.001295328140258789,
+ 0.06636986881494522,
+ -0.04248524457216263,
+ -0.07093628495931625,
+ -0.06715728342533112,
+ 0.007415436673909426,
+ -0.06185786426067352,
+ 0.036563266068696976,
+ 0.030749274417757988,
+ 0.007705106865614653,
+ 0.0023627770133316517,
+ -0.026215652003884315,
+ -0.020864665508270264,
+ 0.05270038917660713,
+ 0.021477004513144493,
+ 0.0068344962783157825,
+ 0.024355463683605194,
+ -0.03746088594198227,
+ 0.031043346971273422,
+ 0.09879995882511139,
+ -0.050035204738378525,
+ 0.08045479655265808,
+ -0.04274336248636246,
+ 0.02994127944111824,
+ -0.03783947601914406,
+ 0.039749279618263245,
+ 0.046901557594537735,
+ 0.08667739480733871,
+ 0.02831847593188286,
+ -0.008148318156599998,
+ 0.007401767186820507,
+ -0.10989774018526077,
+ -0.014092149212956429,
+ 9.036048140842468e-06,
+ 0.054770372807979584,
+ -0.012413500808179379,
+ 0.01861056312918663,
+ 0.060349978506565094,
+ 0.06291640549898148,
+ 0.007055714726448059,
+ -0.021361181512475014,
+ 0.03852728381752968,
+ -0.018908292055130005,
+ 0.047424111515283585,
+ 0.054501011967659,
+ 0.017648596316576004,
+ 0.11429999768733978,
+ -0.041358742862939835,
+ -0.03363256901502609,
+ 0.0030338421929627657,
+ 0.030056871473789215,
+ 0.008060693740844727,
+ -0.0688784271478653,
+ -0.09984277933835983,
+ 0.030267179012298584,
+ -0.028509166091680527,
+ 0.02268315851688385,
+ -0.07580948621034622,
+ -0.0405895970761776,
+ 0.03384138271212578,
+ 0.07081738114356995,
+ 0.019772004336118698,
+ -0.06172173097729683,
+ 0.008248022757470608,
+ 1.9840379362262432e-33,
+ 0.037930894643068314,
+ 0.04577890411019325,
+ -0.03732670471072197,
+ -0.032416991889476776,
+ 0.014588817022740841,
+ -0.06602118909358978,
+ -0.013814577832818031,
+ -0.10539791733026505,
+ -0.12850415706634521,
+ -0.005076196976006031,
+ -0.07302963733673096,
+ 0.07235066592693329,
+ -0.04646436870098114,
+ 0.059371400624513626,
+ 0.09111672639846802,
+ -0.10133209824562073,
+ -0.05483068525791168,
+ -0.053797587752342224,
+ -0.03709062561392784,
+ 0.08241501450538635,
+ 0.03958267718553543,
+ 0.01433452870696783,
+ 0.05912068858742714,
+ -0.0029660870786756277,
+ 0.01806815154850483,
+ -0.0680701732635498,
+ 0.013625666499137878,
+ 0.015582672320306301,
+ -0.02142208069562912,
+ 0.06357447057962418,
+ -0.12094264477491379,
+ -0.09666852653026581,
+ -0.03333089128136635,
+ -0.06621623784303665,
+ -0.03821765258908272,
+ -0.010776739567518234,
+ -0.08198492974042892,
+ -0.03277386352419853,
+ 0.014794036746025085,
+ 0.013517632149159908,
+ -0.0034003634937107563,
+ 0.005664682947099209,
+ -0.022207774221897125,
+ 0.015086682513356209,
+ -0.06799489259719849,
+ 0.08191754668951035,
+ 0.15600024163722992,
+ 0.07579171657562256,
+ -0.05843832343816757,
+ -0.008412746712565422,
+ -0.07857701182365417,
+ -0.0038521387614309788,
+ -0.02901686355471611,
+ 0.0006679021753370762,
+ -0.0697081908583641,
+ -0.05330892279744148,
+ 0.053166620433330536,
+ 0.004783661104738712,
+ 0.013741954229772091,
+ 0.07203977555036545,
+ -0.015861764550209045,
+ 0.033332549035549164,
+ -0.022547632455825806,
+ -0.011850795708596706,
+ -0.09526507556438446,
+ -0.016078950837254524,
+ -0.004922114312648773,
+ 0.004731250926852226,
+ -0.006536174099892378,
+ 0.004852978512644768,
+ 0.01268527377396822,
+ 0.05300697684288025,
+ 0.11899229139089584,
+ 0.025274425745010376,
+ 0.11763036996126175,
+ -0.08781222999095917,
+ -0.016429787501692772,
+ -0.02661072462797165,
+ -0.01769474893808365,
+ 0.05961911380290985,
+ 0.005877051502466202,
+ -0.03780582174658775,
+ -0.028037618845701218,
+ 0.023397648707032204,
+ -0.006716609466820955,
+ 0.015020519495010376,
+ 0.040884219110012054,
+ -0.06197969987988472,
+ -0.029691174626350403,
+ -0.004976964555680752,
+ -0.03422437235713005,
+ 0.018984060734510422,
+ -0.00813105795532465,
+ -0.020747167989611626,
+ 0.0281930360943079,
+ -3.2326105667872445e-33,
+ 0.12847235798835754,
+ 0.026267321780323982,
+ 0.10983140766620636,
+ 0.011159190908074379,
+ -0.044980239123106,
+ 0.017553674057126045,
+ -0.004794386215507984,
+ -0.015802551060914993,
+ -0.01226617582142353,
+ -0.019019361585378647,
+ 0.011876302771270275,
+ -0.023136194795370102,
+ 0.03209578990936279,
+ 0.07442695647478104,
+ 0.05641649663448334,
+ -0.05300089344382286,
+ -0.03638714924454689,
+ -0.014843880198895931,
+ 0.036886364221572876,
+ -0.1257546991109848,
+ -0.008151554502546787,
+ 0.07542898505926132,
+ -0.11252967268228531,
+ -0.09049033373594284,
+ -0.0030374047346413136,
+ 0.04011000320315361,
+ -0.1538117229938507,
+ 0.07717141509056091,
+ -0.04436258599162102,
+ 0.07290291786193848,
+ -0.0072043901309370995,
+ 0.03950807452201843,
+ 0.002569766016677022,
+ -0.006248284596949816,
+ 0.001176450401544571,
+ 0.12515375018119812,
+ 0.02005600742995739,
+ -0.00013864059292245656,
+ 0.024221621453762054,
+ 0.05465780198574066,
+ 0.09940708428621292,
+ -0.053944025188684464,
+ 0.09602796286344528,
+ 0.00014552564243786037,
+ 0.026602625846862793,
+ 0.016811460256576538,
+ 0.0015170868718996644,
+ 0.08731727302074432,
+ 0.005771235562860966,
+ -0.009904555976390839,
+ 0.06958170980215073,
+ 0.09265917539596558,
+ 0.005830116104334593,
+ 0.10210693627595901,
+ 0.0011325017549097538,
+ -0.006749417632818222,
+ 0.01503710262477398,
+ -0.03714510798454285,
+ -0.0939728170633316,
+ -0.03357759863138199,
+ -0.050196800380945206,
+ -0.006316252052783966,
+ -0.06414957344532013,
+ 0.007235861383378506,
+ -0.01670873910188675,
+ -0.07423098385334015,
+ 0.018221961334347725,
+ -0.05320512503385544,
+ -0.010248126462101936,
+ 0.013013344258069992,
+ -0.12916545569896698,
+ -0.04244375228881836,
+ 0.08774643391370773,
+ -0.03917357325553894,
+ -0.027767449617385864,
+ 0.02099072001874447,
+ 0.0595061257481575,
+ 0.01945589855313301,
+ 0.03815269470214844,
+ -0.028747402131557465,
+ -0.025533201172947884,
+ -0.038349006325006485,
+ -0.014486055821180344,
+ -0.013576257973909378,
+ 0.051731329411268234,
+ 0.06515145301818848,
+ -0.011720783077180386,
+ -0.1163521260023117,
+ -0.03931708261370659,
+ 0.03394515439867973,
+ 0.09380073100328445,
+ 0.00931628793478012,
+ -0.01171857863664627,
+ 0.04104544222354889,
+ -0.008916886523365974,
+ -4.140364140425845e-08,
+ 0.061763226985931396,
+ 0.02101300284266472,
+ -0.019075985997915268,
+ -0.002017116406932473,
+ 0.015830116346478462,
+ -0.009857675060629845,
+ -0.018932191655039787,
+ -0.0007055550813674927,
+ 0.013249439187347889,
+ 0.0642324835062027,
+ 0.12860508263111115,
+ 0.03213700279593468,
+ -0.0670522004365921,
+ 0.041800037026405334,
+ -0.0426088348031044,
+ 0.0437115803360939,
+ 0.021514814347028732,
+ 0.12901803851127625,
+ 0.015236952342092991,
+ -0.02232329733669758,
+ -0.05031055584549904,
+ -0.052778035402297974,
+ 0.000233030179515481,
+ -0.022497626021504402,
+ -0.014370465651154518,
+ 0.017518600448966026,
+ 0.014312495477497578,
+ 0.010902844369411469,
+ 0.0027771666646003723,
+ -0.04195915535092354,
+ -0.06504479050636292,
+ 0.038553908467292786,
+ -0.01374481339007616,
+ 0.03843652829527855,
+ 0.09058628976345062,
+ -0.0230315700173378,
+ -0.11761228740215302,
+ 0.06487669050693512,
+ -0.005885662976652384,
+ 0.06288695335388184,
+ 0.05191958323121071,
+ 0.011840583756566048,
+ -0.027309859171509743,
+ 0.040654800832271576,
+ -0.005980184301733971,
+ 0.03252403438091278,
+ -0.043744225054979324,
+ 0.006068602204322815,
+ -0.00032751375692896545,
+ -0.022902367636561394,
+ -0.050694938749074936,
+ 0.026743048802018166,
+ 0.06005466729402542,
+ 0.02092430181801319,
+ 0.02072584442794323,
+ 0.08342021703720093,
+ -0.05768749862909317,
+ -0.08585236966609955,
+ -0.03160274401307106,
+ 0.05222279205918312,
+ 0.029474787414073944,
+ -0.08763033896684647,
+ -0.01591801643371582,
+ -0.07798203080892563
+ ],
+ "model": "Summit",
+ "pickup_zone": "POLYGON((1.9450 41.4301, 2.4018 41.4301, 2.4018 41.1987, 1.9450 41.1987, 1.9450 41.4301))",
+ "price": 1200,
+ "store_location": "2.1734, 41.3851"
+ },
+ {
+ "brand": "BikeShind",
+ "condition": "refurbished",
+ "description": "An artsy, retro-inspired bicycle that\u2019s as functional as it is pretty: The ThrillCycle steel frame offers a smooth ride. A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn\u2019t suggest taking it to the mountains. Fenders protect you from mud, and a rear basket lets you transport groceries, flowers and books. The ThrillCycle comes with a limited lifetime warranty, so this little guy will last you long past graduation.",
+ "description_embeddings": [
+ -0.005154624115675688,
+ 0.10099548101425171,
+ 0.04890008643269539,
+ 0.0625317171216011,
+ -0.0363173745572567,
+ 0.025850096717476845,
+ 0.032137978821992874,
+ -0.03442877531051636,
+ -0.10096120089292526,
+ -0.007441149093210697,
+ 0.002616145182400942,
+ 0.002316742204129696,
+ 0.042584337294101715,
+ 0.026208963245153427,
+ 0.018415318801999092,
+ 0.050033390522003174,
+ 0.14831797778606415,
+ -0.006160213612020016,
+ 0.05086936056613922,
+ 0.0131875304505229,
+ -0.05973455682396889,
+ 0.045886117964982986,
+ -0.025052331387996674,
+ 0.04576171189546585,
+ -0.006168896332383156,
+ 0.03315199911594391,
+ -0.07763667404651642,
+ 0.05837876722216606,
+ -0.03229084238409996,
+ -0.021293187513947487,
+ -0.008595496416091919,
+ 0.06880632787942886,
+ -0.04528025537729263,
+ -0.020664094015955925,
+ -0.029125794768333435,
+ 0.0445701889693737,
+ 0.023799002170562744,
+ -0.013527574017643929,
+ -0.01646343804895878,
+ 0.027023920789361,
+ 0.0014843698590993881,
+ 0.014952401630580425,
+ -0.010172702372074127,
+ 0.07603776454925537,
+ 0.017975280061364174,
+ -0.08911248296499252,
+ 0.055482957512140274,
+ -0.027819648385047913,
+ 0.019395964220166206,
+ 0.05424710363149643,
+ 0.06634850054979324,
+ -0.05045575276017189,
+ -0.0006240577204152942,
+ -0.06339468061923981,
+ -0.023632608354091644,
+ -0.060364823788404465,
+ -0.11193189769983292,
+ 0.046562716364860535,
+ -0.010353066958487034,
+ -0.043506212532520294,
+ 0.051063187420368195,
+ 0.003231980837881565,
+ 0.027102531865239143,
+ 0.002380193443968892,
+ -0.0056939758360385895,
+ -0.026826998218894005,
+ -0.014482468366622925,
+ -0.0185822993516922,
+ 0.013927196152508259,
+ -0.10704471915960312,
+ 0.0673733651638031,
+ -0.0010599792003631592,
+ -0.07455477863550186,
+ -0.014452059753239155,
+ -0.02294282428920269,
+ -0.010201872326433659,
+ 0.023037923499941826,
+ -0.05595972761511803,
+ -0.09120096266269684,
+ -0.029177049174904823,
+ -0.02343042939901352,
+ -0.029726101085543633,
+ 0.07366959005594254,
+ -0.046458736062049866,
+ 0.006261167582124472,
+ -0.013148028403520584,
+ -0.0014217026764526963,
+ 0.017440352588891983,
+ -0.04511420056223869,
+ 0.008813070133328438,
+ -0.022654451429843903,
+ -0.014097515493631363,
+ -0.020799456164240837,
+ -0.05456947907805443,
+ -0.07338607311248779,
+ 0.017073828727006912,
+ -0.04925030097365379,
+ -0.024428002536296844,
+ -0.00979585014283657,
+ 0.025696750730276108,
+ 0.07033320516347885,
+ 0.0389082096517086,
+ 0.12711860239505768,
+ 0.07472020387649536,
+ -0.019501805305480957,
+ 0.01663217693567276,
+ 0.027799105271697044,
+ 0.039703886955976486,
+ -0.029871169477701187,
+ 0.005997804459184408,
+ -0.0015701024094596505,
+ 0.0411832258105278,
+ 8.85713889147155e-05,
+ -0.029442811384797096,
+ 0.009789851494133472,
+ -0.04723270237445831,
+ -0.09891993552446365,
+ 0.05102938041090965,
+ -0.007144609931856394,
+ 0.01668076030910015,
+ 0.004902719985693693,
+ 0.02218448370695114,
+ 0.03827798366546631,
+ 0.001542922342196107,
+ 0.004610520787537098,
+ -0.12595036625862122,
+ 0.07361572980880737,
+ -1.521196586481568e-33,
+ -0.01484542153775692,
+ 0.024973904713988304,
+ 0.006633534096181393,
+ 0.01254032738506794,
+ 0.06355929374694824,
+ -0.04809075966477394,
+ 0.02005922608077526,
+ -0.06251886487007141,
+ -0.06941430270671844,
+ 0.02304103970527649,
+ -0.020975833758711815,
+ 0.08137834072113037,
+ 0.049319952726364136,
+ 0.11945393681526184,
+ 0.17472721636295319,
+ -0.03430051729083061,
+ -0.07276412844657898,
+ -0.11828659474849701,
+ 0.04918891564011574,
+ -0.07279565185308456,
+ -0.06228293105959892,
+ -0.03494764119386673,
+ 0.004517378751188517,
+ -0.0431801863014698,
+ -0.07457974553108215,
+ -0.0003888327337335795,
+ 0.05853814631700516,
+ 0.05362739413976669,
+ 0.01866878569126129,
+ 0.004751134198158979,
+ -0.07936650514602661,
+ 0.033309247344732285,
+ -0.01660560630261898,
+ -0.08851712942123413,
+ 0.042956508696079254,
+ 0.03460550308227539,
+ -0.054352447390556335,
+ -0.016094308346509933,
+ 0.019760286435484886,
+ -0.03591147065162659,
+ -0.04307156056165695,
+ -0.04029138758778572,
+ -0.09315019100904465,
+ 0.055713504552841187,
+ 0.003642909461632371,
+ 0.0391569547355175,
+ 0.1300928145647049,
+ 0.026774607598781586,
+ -0.054334208369255066,
+ -0.060861144214868546,
+ -0.020662454888224602,
+ -0.034525640308856964,
+ 0.004193050786852837,
+ 0.02453654631972313,
+ -0.09028972685337067,
+ 0.004444751888513565,
+ 0.06320545822381973,
+ 0.01895289309322834,
+ -0.04660886526107788,
+ 0.08611723780632019,
+ 0.05705415457487106,
+ 0.030612647533416748,
+ 0.019753821194171906,
+ -0.061483170837163925,
+ -0.025262145325541496,
+ 0.054222241044044495,
+ 0.017605014145374298,
+ -0.013110420666635036,
+ 0.04744894057512283,
+ -0.004785404074937105,
+ 0.04680679365992546,
+ 0.001831064117141068,
+ 0.07773134112358093,
+ 0.008347200229763985,
+ 0.08674833923578262,
+ 0.024294976145029068,
+ -0.03695613518357277,
+ -0.0440739244222641,
+ 0.00895663257688284,
+ -0.0060102143324911594,
+ -0.0361272394657135,
+ -0.08447428047657013,
+ -0.08971717208623886,
+ 0.03131894767284393,
+ 0.0721370130777359,
+ 0.031180810183286667,
+ 0.039390258491039276,
+ -0.09044987708330154,
+ -0.007888346910476685,
+ 0.008131768554449081,
+ -0.03624662756919861,
+ -0.033649034798145294,
+ 0.031620997935533524,
+ 0.05870470404624939,
+ 0.018141048029065132,
+ -5.7662626416839565e-34,
+ 0.09117024391889572,
+ -0.023953478783369064,
+ 0.080879345536232,
+ 0.0035459804348647594,
+ -0.013222851790487766,
+ -0.025237491354346275,
+ 0.019038159400224686,
+ -0.06588941067457199,
+ -0.11689981818199158,
+ 0.0007165187271311879,
+ -0.0933104082942009,
+ 0.014618181623518467,
+ 0.12644915282726288,
+ 0.0027253602165728807,
+ 0.15038658678531647,
+ 0.0053163510747253895,
+ -0.005645217839628458,
+ 0.009321562945842743,
+ 0.002719732467085123,
+ -0.01651378907263279,
+ 0.0063886744901537895,
+ 0.05738385394215584,
+ -0.14213474094867706,
+ -0.0669025406241417,
+ -0.05766160413622856,
+ 0.0031909833196550608,
+ -0.13478563725948334,
+ -0.03741385415196419,
+ 0.041654907166957855,
+ 0.04030514881014824,
+ -0.05102578178048134,
+ 0.0028968513943254948,
+ 0.0738285705447197,
+ -0.03643025830388069,
+ -0.015445208176970482,
+ 0.06674294173717499,
+ 0.029759766533970833,
+ -0.024196317419409752,
+ -0.009355752728879452,
+ 0.023269686847925186,
+ 0.01623220555484295,
+ -0.08251868188381195,
+ 0.020170293748378754,
+ 0.0749305933713913,
+ 0.08206077665090561,
+ 0.012237507849931717,
+ -0.026570556685328484,
+ 0.016253553330898285,
+ -0.003425935748964548,
+ 0.005059909541159868,
+ 0.12109038233757019,
+ 0.08107315003871918,
+ -0.04097432270646095,
+ 0.0009462210582569242,
+ 0.058092083781957626,
+ -0.03609737753868103,
+ -0.01580999232828617,
+ -0.0342475026845932,
+ 0.012185491621494293,
+ -0.058348096907138824,
+ -0.05934947729110718,
+ 0.026715252548456192,
+ -0.031246516853570938,
+ 0.012632215395569801,
+ -0.01100403256714344,
+ -0.05962579324841499,
+ -0.000801989808678627,
+ -0.06919746845960617,
+ -0.1299775391817093,
+ -0.03721063956618309,
+ -0.03989635780453682,
+ 0.04918158799409866,
+ -0.0022671804763376713,
+ -0.04244564101099968,
+ -0.02631748840212822,
+ -0.04100838303565979,
+ 0.08634430915117264,
+ 0.05031242221593857,
+ 0.06688959896564484,
+ 0.024407675489783287,
+ 0.0018788984743878245,
+ -0.026026425883173943,
+ 0.04438408091664314,
+ 0.02198263816535473,
+ -0.014974343590438366,
+ -0.026490231975913048,
+ -0.09914876520633698,
+ -0.09834708273410797,
+ 0.017346272245049477,
+ 0.00089951854897663,
+ 0.05497178062796593,
+ 0.06180766969919205,
+ -0.050425756722688675,
+ 0.013637324795126915,
+ -0.03599657490849495,
+ -4.404103037813911e-08,
+ -0.0024933917447924614,
+ 0.049585312604904175,
+ -0.020710783079266548,
+ -0.014283453114330769,
+ -0.0064896950498223305,
+ 0.04579087719321251,
+ 0.02242390066385269,
+ 0.02515084482729435,
+ -0.031156959012150764,
+ 0.006718308199197054,
+ 0.061417631804943085,
+ -0.009935885667800903,
+ -0.021248064935207367,
+ 0.011152776889503002,
+ -0.059073783457279205,
+ 0.05840323865413666,
+ 0.06523993611335754,
+ 0.03690555691719055,
+ 0.03174441307783127,
+ 0.02336188219487667,
+ 0.003073832020163536,
+ -0.017117813229560852,
+ 0.02877660095691681,
+ 0.0017827276606112719,
+ -0.07995487004518509,
+ -0.032443612813949585,
+ -0.01474942360073328,
+ -0.016080526635050774,
+ 0.0771399736404419,
+ 0.017354682087898254,
+ -0.02578366920351982,
+ 0.004991421941667795,
+ 0.006590475793927908,
+ -0.032372940331697464,
+ 0.038421064615249634,
+ -0.1204696074128151,
+ -0.05457846075296402,
+ 0.036750562489032745,
+ 0.013932188041508198,
+ 0.0031626380514353514,
+ 0.009978784248232841,
+ -0.0138266421854496,
+ 0.006769631989300251,
+ 0.059896957129240036,
+ 0.00822784099727869,
+ -0.05025117099285126,
+ -0.10305225104093552,
+ -0.07187453657388687,
+ 0.00836241990327835,
+ 0.049537766724824905,
+ 0.007570290472358465,
+ -0.08729138970375061,
+ -0.020592620596289635,
+ 0.04918212443590164,
+ 0.054685790091753006,
+ 0.04091939702630043,
+ -0.05420788377523422,
+ -0.04473182559013367,
+ -0.11178043484687805,
+ 0.09808126091957092,
+ -0.015394269488751888,
+ -0.0039725536480546,
+ 0.03283742815256119,
+ -0.05677533522248268
+ ],
+ "model": "ThrillCycle",
+ "pickup_zone": "POLYGON((12.4464 42.1028, 12.5464 42.1028, 12.5464 41.7028, 12.4464 41.7028, 12.4464 42.1028))",
+ "price": 815,
+ "store_location": "12.4964,41.9028"
+ }
+]
\ No newline at end of file
diff --git a/doctests/dt-bitfield.js b/doctests/dt-bitfield.js
new file mode 100644
index 00000000000..9685372de41
--- /dev/null
+++ b/doctests/dt-bitfield.js
@@ -0,0 +1,76 @@
+// EXAMPLE: bitfield_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START bf
+let res1 = await client.bitField("bike:1:stats", [{
+ operation: 'SET',
+ encoding: 'u32',
+ offset: '#0',
+ value: 1000
+}]);
+console.log(res1); // >>> [0]
+
+let res2 = await client.bitField('bike:1:stats', [
+ {
+ operation: 'INCRBY',
+ encoding: 'u32',
+ offset: '#0',
+ increment: -50
+ },
+ {
+ operation: 'INCRBY',
+ encoding: 'u32',
+ offset: '#1',
+ increment: 1
+ }
+]);
+console.log(res2); // >>> [950, 1]
+
+let res3 = await client.bitField('bike:1:stats', [
+ {
+ operation: 'INCRBY',
+ encoding: 'u32',
+ offset: '#0',
+ increment: 500
+ },
+ {
+ operation: 'INCRBY',
+ encoding: 'u32',
+ offset: '#1',
+ increment: 1
+ }
+]);
+console.log(res3); // >>> [1450, 2]
+
+let res4 = await client.bitField('bike:1:stats', [
+ {
+ operation: 'GET',
+ encoding: 'u32',
+ offset: '#0'
+ },
+ {
+ operation: 'GET',
+ encoding: 'u32',
+ offset: '#1'
+ }
+]);
+console.log(res4); // >>> [1450, 2]
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res1, [0])
+assert.deepEqual(res2, [950, 1])
+assert.deepEqual(res3, [1450, 2])
+assert.deepEqual(res4, [1450, 2])
+await client.close();
+// REMOVE_END
diff --git a/doctests/dt-bitmap.js b/doctests/dt-bitmap.js
new file mode 100644
index 00000000000..0d6a292d0f1
--- /dev/null
+++ b/doctests/dt-bitmap.js
@@ -0,0 +1,159 @@
+// EXAMPLE: bitmap_tutorial
+// REMOVE_START
+import assert from 'assert';
+// REMOVE_END
+import { createClient, RESP_TYPES } from 'redis';
+
+const client = createClient({
+ commandOptions: {
+ typeMapping: {
+ [RESP_TYPES.BLOB_STRING]: Buffer
+ }
+ }
+});
+await client.connect();
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START ping
+const res1 = await client.setBit("pings:2024-01-01-00:00", 123, 1)
+console.log(res1) // >>> 0
+
+const res2 = await client.getBit("pings:2024-01-01-00:00", 123)
+console.log(res2) // >>> 1
+
+const res3 = await client.getBit("pings:2024-01-01-00:00", 456)
+console.log(res3) // >>> 0
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 0)
+// REMOVE_END
+
+// STEP_START bitcount
+// HIDE_START
+await client.setBit("pings:2024-01-01-00:00", 123, 1)
+// HIDE_END
+const res4 = await client.bitCount("pings:2024-01-01-00:00")
+console.log(res4) // >>> 1
+// STEP_END
+// REMOVE_START
+assert.equal(res4, 1)
+// REMOVE_END
+
+// STEP_START bitop_setup
+await client.setBit("A", 0, 1)
+await client.setBit("A", 1, 1)
+await client.setBit("A", 3, 1)
+await client.setBit("A", 4, 1)
+
+const res5 = await client.get("A")
+console.log(res5.readUInt8(0).toString(2).padStart(8, '0'))
+// >>> 11011000
+
+await client.setBit("B", 3, 1)
+await client.setBit("B", 4, 1)
+await client.setBit("B", 7, 1)
+
+const res6 = await client.get("B")
+console.log(res6.readUInt8(0).toString(2).padStart(8, '0'))
+// >>> 00011001
+
+await client.setBit("C", 1, 1)
+await client.setBit("C", 2, 1)
+await client.setBit("C", 4, 1)
+await client.setBit("C", 5, 1)
+
+const res7 = await client.get("C")
+console.log(res7.readUInt8(0).toString(2).padStart(8, '0'))
+// >>> 01101100
+// STEP_END
+// REMOVE_START
+assert.equal(res5.readUInt8(0), 0b11011000)
+assert.equal(res6.readUInt8(0), 0b00011001)
+assert.equal(res7.readUInt8(0), 0b01101100)
+// REMOVE_END
+
+// STEP_START bitop_and
+await client.bitOp("AND", "R", ["A", "B", "C"])
+const res8 = await client.get("R")
+console.log(res8.readUInt8(0).toString(2).padStart(8, '0'))
+// >>> 00001000
+// STEP_END
+// REMOVE_START
+assert.equal(res8.readUInt8(0), 0b00001000)
+// REMOVE_END
+
+// STEP_START bitop_or
+await client.bitOp("OR", "R", ["A", "B", "C"])
+const res9 = await client.get("R")
+console.log(res9.readUInt8(0).toString(2).padStart(8, '0'))
+// >>> 11111101
+// STEP_END
+// REMOVE_START
+assert.equal(res9.readUInt8(0), 0b11111101)
+// REMOVE_END
+
+// STEP_START bitop_xor
+await client.bitOp("XOR", "R", ["A", "B"]) // XOR uses two keys here
+const res10 = await client.get("R")
+console.log(res10.readUInt8(0).toString(2).padStart(8, '0'))
+// >>> 11000001
+// STEP_END
+// REMOVE_START
+assert.equal(res10.readUInt8(0), 0b11000001)
+// REMOVE_END
+
+// STEP_START bitop_not
+await client.bitOp("NOT", "R", "A")
+const res11 = await client.get("R")
+console.log(res11.readUInt8(0).toString(2).padStart(8, '0'))
+// >>> 00100111
+// STEP_END
+// REMOVE_START
+assert.equal(res11.readUInt8(0), 0b00100111)
+// REMOVE_END
+
+// STEP_START bitop_diff
+await client.bitOp("DIFF", "R", ["A", "B", "C"])
+const res12 = await client.get("R")
+console.log(res12.readUInt8(0).toString(2).padStart(8, '0'))
+// >>> 10000000
+// STEP_END
+// REMOVE_START
+assert.equal(res12.readUInt8(0), 0b10000000)
+// REMOVE_END
+
+// STEP_START bitop_diff1
+await client.bitOp("DIFF1", "R", ["A", "B", "C"])
+const res13 = await client.get("R")
+console.log(res13.readUInt8(0).toString(2).padStart(8, '0'))
+// >>> 00100101
+// STEP_END
+// REMOVE_START
+assert.equal(res13.readUInt8(0), 0b00100101)
+// REMOVE_END
+
+// STEP_START bitop_andor
+await client.bitOp("ANDOR", "R", ["A", "B", "C"])
+const res14 = await client.get("R")
+console.log(res14.readUInt8(0).toString(2).padStart(8, '0'))
+// >>> 01011000
+// STEP_END
+// REMOVE_START
+assert.equal(res14.readUInt8(0), 0b01011000)
+// REMOVE_END
+
+// STEP_START bitop_one
+await client.bitOp("ONE", "R", ["A", "B", "C"])
+const res15 = await client.get("R")
+console.log(res15.readUInt8(0).toString(2).padStart(8, '0'))
+// >>> 10100101
+// STEP_END
+// REMOVE_START
+assert.equal(res15.readUInt8(0), 0b10100101)
+
+await client.close();
+// REMOVE_END
\ No newline at end of file
diff --git a/doctests/dt-bloom.js b/doctests/dt-bloom.js
new file mode 100644
index 00000000000..d065937e763
--- /dev/null
+++ b/doctests/dt-bloom.js
@@ -0,0 +1,46 @@
+// EXAMPLE: bf_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START bloom
+const res1 = await client.bf.reserve('bikes:models', 0.01, 1000);
+console.log(res1); // >>> OK
+
+const res2 = await client.bf.add('bikes:models', 'Smoky Mountain Striker');
+console.log(res2); // >>> true
+
+const res3 = await client.bf.exists('bikes:models', 'Smoky Mountain Striker');
+console.log(res3); // >>> true
+
+const res4 = await client.bf.mAdd('bikes:models', [
+ 'Rocky Mountain Racer',
+ 'Cloudy City Cruiser',
+ 'Windy City Wippet'
+]);
+console.log(res4); // >>> [true, true, true]
+
+const res5 = await client.bf.mExists('bikes:models', [
+ 'Rocky Mountain Racer',
+ 'Cloudy City Cruiser',
+ 'Windy City Wippet'
+]);
+console.log(res5); // >>> [true, true, true]
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 'OK')
+assert.equal(res2, true)
+assert.equal(res3, true)
+assert.deepEqual(res4, [true, true, true])
+assert.deepEqual(res5, [true, true, true])
+await client.close();
+// REMOVE_END
diff --git a/doctests/dt-cms.js b/doctests/dt-cms.js
new file mode 100644
index 00000000000..b0d9fa68469
--- /dev/null
+++ b/doctests/dt-cms.js
@@ -0,0 +1,50 @@
+// EXAMPLE: cms_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START cms
+const res1 = await client.cms.initByProb('bikes:profit', 0.001, 0.002);
+console.log(res1); // >>> OK
+
+const res2 = await client.cms.incrBy('bikes:profit', {
+ item: 'Smoky Mountain Striker',
+ incrementBy: 100
+});
+console.log(res2); // >>> [100]
+
+const res3 = await client.cms.incrBy('bikes:profit', [
+ {
+ item: 'Rocky Mountain Racer',
+ incrementBy: 200
+ },
+ {
+ item: 'Cloudy City Cruiser',
+ incrementBy: 150
+ }
+]);
+console.log(res3); // >>> [200, 150]
+
+const res4 = await client.cms.query('bikes:profit', 'Smoky Mountain Striker');
+console.log(res4); // >>> [100]
+
+const res5 = await client.cms.info('bikes:profit');
+console.log(res5.width, res5.depth, res5.count); // >>> 2000 9 450
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 'OK')
+assert.deepEqual(res2, [100])
+assert.deepEqual(res3, [200, 150])
+assert.deepEqual(res4, [100])
+assert.deepEqual(res5, { width: 2000, depth: 9, count: 450 })
+await client.close();
+// REMOVE_END
\ No newline at end of file
diff --git a/doctests/dt-cuckoo.js b/doctests/dt-cuckoo.js
new file mode 100644
index 00000000000..4b11bca2345
--- /dev/null
+++ b/doctests/dt-cuckoo.js
@@ -0,0 +1,38 @@
+// EXAMPLE: cuckoo_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START cuckoo
+const res1 = await client.cf.reserve('bikes:models', 1000000);
+console.log(res1); // >>> OK
+
+const res2 = await client.cf.add('bikes:models', 'Smoky Mountain Striker');
+console.log(res2); // >>> true
+
+const res3 = await client.cf.exists('bikes:models', 'Smoky Mountain Striker');
+console.log(res3); // >>> true
+
+const res4 = await client.cf.exists('bikes:models', 'Terrible Bike Name');
+console.log(res4); // >>> false
+
+const res5 = await client.cf.del('bikes:models', 'Smoky Mountain Striker');
+console.log(res5); // >>> true
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 'OK')
+assert.equal(res2, true)
+assert.equal(res3, true)
+assert.equal(res4, false)
+assert.equal(res5, true)
+await client.close();
+// REMOVE_END
diff --git a/doctests/dt-geo.js b/doctests/dt-geo.js
new file mode 100644
index 00000000000..7ec9376a8a7
--- /dev/null
+++ b/doctests/dt-geo.js
@@ -0,0 +1,59 @@
+// EXAMPLE: geo_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.del('bikes:rentable')
+// REMOVE_END
+
+// STEP_START geoAdd
+const res1 = await client.geoAdd('bikes:rentable', {
+ longitude: -122.27652,
+ latitude: 37.805186,
+ member: 'station:1'
+});
+console.log(res1) // 1
+
+const res2 = await client.geoAdd('bikes:rentable', {
+ longitude: -122.2674626,
+ latitude: 37.8062344,
+ member: 'station:2'
+});
+console.log(res2) // 1
+
+const res3 = await client.geoAdd('bikes:rentable', {
+ longitude: -122.2469854,
+ latitude: 37.8104049,
+ member: 'station:3'
+})
+console.log(res3) // 1
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 1);
+assert.equal(res2, 1);
+assert.equal(res3, 1);
+// REMOVE_END
+
+// STEP_START geoSearch
+const res4 = await client.geoSearch(
+ 'bikes:rentable', {
+ longitude: -122.27652,
+ latitude: 37.805186,
+ },
+ { radius: 5,
+ unit: 'km'
+ }
+);
+console.log(res4) // ['station:1', 'station:2', 'station:3']
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res4, ['station:1', 'station:2', 'station:3']);
+// REMOVE_END
+await client.close()
diff --git a/doctests/dt-hash.js b/doctests/dt-hash.js
new file mode 100644
index 00000000000..e77d6fd7b95
--- /dev/null
+++ b/doctests/dt-hash.js
@@ -0,0 +1,98 @@
+// EXAMPLE: hash_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+// STEP_START set_get_all
+const res1 = await client.hSet(
+ 'bike:1',
+ {
+ 'model': 'Deimos',
+ 'brand': 'Ergonom',
+ 'type': 'Enduro bikes',
+ 'price': 4972,
+ }
+)
+console.log(res1) // 4
+
+const res2 = await client.hGet('bike:1', 'model')
+console.log(res2) // 'Deimos'
+
+const res3 = await client.hGet('bike:1', 'price')
+console.log(res3) // '4972'
+
+const res4 = await client.hGetAll('bike:1')
+console.log(res4)
+/*
+{
+ brand: 'Ergonom',
+ model: 'Deimos',
+ price: '4972',
+ type: 'Enduro bikes'
+}
+*/
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 4);
+assert.equal(res2, 'Deimos');
+assert.equal(res3, '4972');
+assert.deepEqual(res4, {
+ model: 'Deimos',
+ brand: 'Ergonom',
+ type: 'Enduro bikes',
+ price: '4972'
+});
+// REMOVE_END
+
+// STEP_START hmGet
+const res5 = await client.hmGet('bike:1', ['model', 'price'])
+console.log(res5) // ['Deimos', '4972']
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(Object.values(res5), ['Deimos', '4972'])
+// REMOVE_END
+
+// STEP_START hIncrBy
+const res6 = await client.hIncrBy('bike:1', 'price', 100)
+console.log(res6) // 5072
+const res7 = await client.hIncrBy('bike:1', 'price', -100)
+console.log(res7) // 4972
+// STEP_END
+
+// REMOVE_START
+assert.equal(res6, 5072)
+assert.equal(res7, 4972)
+// REMOVE_END
+
+// STEP_START hIncrBy_hGet_hMget
+const res11 = await client.hIncrBy('bike:1:stats', 'rides', 1)
+console.log(res11) // 1
+const res12 = await client.hIncrBy('bike:1:stats', 'rides', 1)
+console.log(res12) // 2
+const res13 = await client.hIncrBy('bike:1:stats', 'rides', 1)
+console.log(res13) // 3
+const res14 = await client.hIncrBy('bike:1:stats', 'crashes', 1)
+console.log(res14) // 1
+const res15 = await client.hIncrBy('bike:1:stats', 'owners', 1)
+console.log(res15) // 1
+const res16 = await client.hGet('bike:1:stats', 'rides')
+console.log(res16) // 3
+const res17 = await client.hmGet('bike:1:stats', ['crashes', 'owners'])
+console.log(res17) // ['1', '1']
+// STEP_END
+
+// REMOVE_START
+assert.equal(res11, 1);
+assert.equal(res12, 2);
+assert.equal(res13, 3);
+assert.equal(res14, 1);
+assert.equal(res15, 1);
+assert.equal(res16, '3');
+assert.deepEqual(res17, ['1', '1']);
+await client.close();
+// REMOVE_END
\ No newline at end of file
diff --git a/doctests/dt-hll.js b/doctests/dt-hll.js
new file mode 100644
index 00000000000..762ce5db15e
--- /dev/null
+++ b/doctests/dt-hll.js
@@ -0,0 +1,38 @@
+// EXAMPLE: hll_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START pfadd
+const res1 = await client.pfAdd('bikes', ['Hyperion', 'Deimos', 'Phoebe', 'Quaoar']);
+console.log(res1); // >>> 1
+
+const res2 = await client.pfCount('bikes');
+console.log(res2); // >>> 4
+
+const res3 = await client.pfAdd('commuter_bikes', ['Salacia', 'Mimas', 'Quaoar']);
+console.log(res3); // >>> 1
+
+const res4 = await client.pfMerge('all_bikes', ['bikes', 'commuter_bikes']);
+console.log(res4); // >>> OK
+
+const res5 = await client.pfCount('all_bikes');
+console.log(res5); // >>> 6
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 1)
+assert.equal(res2, 4)
+assert.equal(res3, 1)
+assert.equal(res4, 'OK')
+assert.equal(res5, 6)
+await client.close();
+// REMOVE_END
diff --git a/doctests/dt-json.js b/doctests/dt-json.js
new file mode 100644
index 00000000000..00578f48f33
--- /dev/null
+++ b/doctests/dt-json.js
@@ -0,0 +1,425 @@
+// EXAMPLE: json_tutorial
+// HIDE_START
+import assert from 'assert';
+import {
+ createClient
+} from 'redis';
+
+const client = await createClient();
+await client.connect();
+// HIDE_END
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START set_get
+const res1 = await client.json.set("bike", "$", '"Hyperion"');
+console.log(res1); // OK
+
+const res2 = await client.json.get("bike", { path: "$" });
+console.log(res2); // ['"Hyperion"']
+
+const res3 = await client.json.type("bike", { path: "$" });
+console.log(res3); // [ 'string' ]
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res2, ['"Hyperion"']);
+// REMOVE_END
+
+// STEP_START str
+const res4 = await client.json.strLen("bike", { path: "$" });
+console.log(res4) // [10]
+
+const res5 = await client.json.strAppend("bike", '" (Enduro bikes)"');
+console.log(res5) // 27
+
+const res6 = await client.json.get("bike", { path: "$" });
+console.log(res6) // ['"Hyperion"" (Enduro bikes)"']
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res6, ['"Hyperion"" (Enduro bikes)"']);
+// REMOVE_END
+
+// STEP_START num
+const res7 = await client.json.set("crashes", "$", 0);
+console.log(res7) // OK
+
+const res8 = await client.json.numIncrBy("crashes", "$", 1);
+console.log(res8) // [1]
+
+const res9 = await client.json.numIncrBy("crashes", "$", 1.5);
+console.log(res9) // [2.5]
+
+const res10 = await client.json.numIncrBy("crashes", "$", -0.75);
+console.log(res10) // [1.75]
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res10, [1.75])
+// REMOVE_END
+
+// STEP_START arr
+const res11 = await client.json.set("newbike", "$", ["Deimos", {"crashes": 0 }, null]);
+console.log(res11); // OK
+
+const res12 = await client.json.get("newbike", { path: "$" });
+console.log(res12); // [[ 'Deimos', { crashes: 0 }, null ]]
+
+const res13 = await client.json.get("newbike", { path: "$[1].crashes" });
+console.log(res13); // [0]
+
+const res14 = await client.json.del("newbike", { path: "$.[-1]"} );
+console.log(res14); // 1
+
+const res15 = await client.json.get("newbike", { path: "$" });
+console.log(res15); // [[ 'Deimos', { crashes: 0 } ]]
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res15, [["Deimos", {
+ "crashes": 0
+}]]);
+// REMOVE_END
+
+// STEP_START arr2
+const res16 = await client.json.set("riders", "$", []);
+console.log(res16); // OK
+
+const res17 = await client.json.arrAppend("riders", "$", "Norem");
+console.log(res17); // [1]
+
+const res18 = await client.json.get("riders", { path: "$" });
+console.log(res18); // [[ 'Norem' ]]
+
+const res19 = await client.json.arrInsert("riders", "$", 1, "Prickett", "Royse", "Castilla");
+console.log(res19); // [4]
+
+const res20 = await client.json.get("riders", { path: "$" });
+console.log(res20); // [[ 'Norem', 'Prickett', 'Royse', 'Castilla' ]]
+
+const res21 = await client.json.arrTrim("riders", "$", 1, 1);
+console.log(res21); // [1]
+
+const res22 = await client.json.get("riders", { path: "$" });
+console.log(res22); // [[ 'Prickett' ]]
+
+const res23 = await client.json.arrPop("riders", { path: "$" });
+console.log(res23); // [ 'Prickett' ]
+
+const res24 = await client.json.arrPop("riders", { path: "$" });
+console.log(res24); // [null]
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res24, [null]);
+// REMOVE_END
+
+// STEP_START obj
+const res25 = await client.json.set(
+ "bike:1", "$", {
+ "model": "Deimos",
+ "brand": "Ergonom",
+ "price": 4972
+ }
+);
+console.log(res25); // OK
+
+const res26 = await client.json.objLen("bike:1", { path: "$" });
+console.log(res26); // [3]
+
+const res27 = await client.json.objKeys("bike:1", { path: "$" });
+console.log(res27); // [['model', 'brand', 'price']]
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res27, [
+ ["model", "brand", "price"]
+]);
+// REMOVE_END
+
+// STEP_START set_bikes
+// HIDE_START
+const inventoryJSON = {
+ "inventory": {
+ "mountain_bikes": [{
+ "id": "bike:1",
+ "model": "Phoebe",
+ "description": "This is a mid-travel trail slayer that is a fantastic daily driver or one bike quiver. The Shimano Claris 8-speed groupset gives plenty of gear range to tackle hills and there\u2019s room for mudguards and a rack too. This is the bike for the rider who wants trail manners with low fuss ownership.",
+ "price": 1920,
+ "specs": {
+ "material": "carbon",
+ "weight": 13.1
+ },
+ "colors": ["black", "silver"],
+ },
+ {
+ "id": "bike:2",
+ "model": "Quaoar",
+ "description": "Redesigned for the 2020 model year, this bike impressed our testers and is the best all-around trail bike we've ever tested. The Shimano gear system effectively does away with an external cassette, so is super low maintenance in terms of wear and teaawait client. All in all it's an impressive package for the price, making it very competitive.",
+ "price": 2072,
+ "specs": {
+ "material": "aluminium",
+ "weight": 7.9
+ },
+ "colors": ["black", "white"],
+ },
+ {
+ "id": "bike:3",
+ "model": "Weywot",
+ "description": "This bike gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. A set of powerful Shimano hydraulic disc brakes provide ample stopping ability. If you're after a budget option, this is one of the best bikes you could get.",
+ "price": 3264,
+ "specs": {
+ "material": "alloy",
+ "weight": 13.8
+ },
+ },
+ ],
+ "commuter_bikes": [{
+ "id": "bike:4",
+ "model": "Salacia",
+ "description": "This bike is a great option for anyone who just wants a bike to get about on With a slick-shifting Claris gears from Shimano\u2019s, this is a bike which doesn\u2019t break the bank and delivers craved performance. It\u2019s for the rider who wants both efficiency and capability.",
+ "price": 1475,
+ "specs": {
+ "material": "aluminium",
+ "weight": 16.6
+ },
+ "colors": ["black", "silver"],
+ },
+ {
+ "id": "bike:5",
+ "model": "Mimas",
+ "description": "A real joy to ride, this bike got very high scores in last years Bike of the year report. The carefully crafted 50-34 tooth chainset and 11-32 tooth cassette give an easy-on-the-legs bottom gear for climbing, and the high-quality Vittoria Zaffiro tires give balance and grip.It includes a low-step frame , our memory foam seat, bump-resistant shocks and conveniently placed thumb throttle. Put it all together and you get a bike that helps redefine what can be done for this price.",
+ "price": 3941,
+ "specs": {
+ "material": "alloy",
+ "weight": 11.6
+ },
+ },
+ ],
+ }
+};
+// HIDE_END
+
+const res28 = await client.json.set("bikes:inventory", "$", inventoryJSON);
+console.log(res28); // OK
+// STEP_END
+
+// STEP_START get_bikes
+const res29 = await client.json.get("bikes:inventory", {
+ path: "$.inventory.*"
+});
+console.log(res29);
+/*
+[
+ [
+ {
+ id: 'bike:1',
+ model: 'Phoebe',
+ description: 'This is a mid-travel trail slayer that is a fantastic daily driver or one bike quiver. The Shimano Claris 8-speed groupset gives plenty of gear range to tackle hills and thereβs room for mudguards and a rack too. This is the bike for the rider who wants trail manners with low fuss ownership.',
+ price: 1920,
+ specs: [Object],
+ colors: [Array]
+ },
+ {
+ id: 'bike:2',
+ model: 'Quaoar',
+ description: "Redesigned for the 2020 model year, this bike impressed our testers and is the best all-around trail bike we've ever tested. The Shimano gear system effectively does away with an external cassette, so is super low maintenance in terms of wear and teaawait client. All in all it's an impressive package for the price, making it very competitive.",
+ price: 2072,
+ specs: [Object],
+ colors: [Array]
+ },
+ {
+ id: 'bike:3',
+ model: 'Weywot',
+ description: "This bike gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. A set of powerful Shimano hydraulic disc brakes provide ample stopping ability. If you're after a budget option, this is one of the best bikes you could get.",
+ price: 3264,
+ specs: [Object]
+ }
+ ],
+ [
+ {
+ id: 'bike:4',
+ model: 'Salacia',
+ description: 'This bike is a great option for anyone who just wants a bike to get about on With a slick-shifting Claris gears from Shimanoβs, this is a bike which doesnβt break the bank and delivers craved performance. Itβs for the rider who wants both efficiency and capability.',
+ price: 1475,
+ specs: [Object],
+ colors: [Array]
+ },
+ {
+ id: 'bike:5',
+ model: 'Mimas',
+ description: 'A real joy to ride, this bike got very high scores in last years Bike of the year report. The carefully crafted 50-34 tooth chainset and 11-32 tooth cassette give an easy-on-the-legs bottom gear for climbing, and the high-quality Vittoria Zaffiro tires give balance and grip.It includes a low-step frame , our memory foam seat, bump-resistant shocks and conveniently placed thumb throttle. Put it all together and you get a bike that helps redefine what can be done for this price.',
+ price: 3941,
+ specs: [Object]
+ }
+ ]
+]
+*/
+// STEP_END
+
+// STEP_START get_mtnbikes
+const res30 = await client.json.get("bikes:inventory", {
+ path: "$.inventory.mountain_bikes[*].model"
+});
+console.log(res30); // ['Phoebe', 'Quaoar', 'Weywot']
+
+const res31 = await client.json.get("bikes:inventory", {
+ path: '$.inventory["mountain_bikes"][*].model'
+});
+console.log(res31); // ['Phoebe', 'Quaoar', 'Weywot']
+
+const res32 = await client.json.get("bikes:inventory", {
+ path: "$..mountain_bikes[*].model"
+});
+console.log(res32); // ['Phoebe', 'Quaoar', 'Weywot']
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res30, ["Phoebe", "Quaoar", "Weywot"]);
+assert.deepEqual(res31, ["Phoebe", "Quaoar", "Weywot"]);
+assert.deepEqual(res32, ["Phoebe", "Quaoar", "Weywot"]);
+// REMOVE_END
+
+// STEP_START get_models
+const res33 = await client.json.get("bikes:inventory", {
+ path: "$..model"
+});
+console.log(res33); // ['Phoebe', 'Quaoar', 'Weywot', 'Salacia', 'Mimas']
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res33, ["Phoebe", "Quaoar", "Weywot", "Salacia", "Mimas"]);
+// REMOVE_END
+
+// STEP_START get2mtnbikes
+const res34 = await client.json.get("bikes:inventory", {
+ path: "$..mountain_bikes[0:2].model"
+});
+console.log(res34); // ['Phoebe', 'Quaoar']
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res34, ["Phoebe", "Quaoar"]);
+// REMOVE_END
+
+// STEP_START filter1
+const res35 = await client.json.get("bikes:inventory", {
+ path: "$..mountain_bikes[?(@.price < 3000 && @.specs.weight < 10)]"
+});
+console.log(res35);
+/*
+[
+ {
+ id: 'bike:2',
+ model: 'Quaoar',
+ description: "Redesigned for the 2020 model year, this bike impressed our testers and is the best all-around trail bike we've ever tested. The Shimano gear system effectively does away with an external cassette, so is super low maintenance in terms of wear and teaawait client. All in all it's an impressive package for the price, making it very competitive.",
+ price: 2072,
+ specs: { material: 'aluminium', weight: 7.9 },
+ colors: [ 'black', 'white' ]
+ }
+]
+*/
+// STEP_END
+
+// STEP_START filter2
+// names of bikes made from an alloy
+const res36 = await client.json.get("bikes:inventory", {
+ path: "$..[?(@.specs.material == 'alloy')].model"
+});
+console.log(res36); // ['Weywot', 'Mimas']
+// STEP_END
+// REMOVE_START
+assert.deepEqual(res36, ["Weywot", "Mimas"]);
+// REMOVE_END
+
+// STEP_START filter3
+const res37 = await client.json.get("bikes:inventory", {
+ path: "$..[?(@.specs.material =~ '(?i)al')].model"
+});
+console.log(res37); // ['Quaoar', 'Weywot', 'Salacia', 'Mimas']
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res37, ["Quaoar", "Weywot", "Salacia", "Mimas"]);
+// REMOVE_END
+
+// STEP_START filter4
+const res37a = await client.json.set(
+ 'bikes:inventory',
+ '$.inventory.mountain_bikes[0].regex_pat',
+ '(?i)al'
+);
+
+const res37b = await client.json.set(
+ 'bikes:inventory',
+ '$.inventory.mountain_bikes[1].regex_pat',
+ '(?i)al'
+);
+
+const res37c = await client.json.set(
+ 'bikes:inventory',
+ '$.inventory.mountain_bikes[2].regex_pat',
+ '(?i)al'
+);
+
+const res37d = await client.json.get(
+ 'bikes:inventory',
+ { path: '$.inventory.mountain_bikes[?(@.specs.material =~ @.regex_pat)].model' }
+);
+console.log(res37d); // ['Quaoar', 'Weywot']
+// STEP_END
+
+// STEP_START update_bikes
+const res38 = await client.json.get("bikes:inventory", {
+ path: "$..price"
+});
+console.log(res38); // [1920, 2072, 3264, 1475, 3941]
+
+const res39 = await client.json.numIncrBy("bikes:inventory", "$..price", -100);
+console.log(res39); // [1820, 1972, 3164, 1375, 3841]
+
+const res40 = await client.json.numIncrBy("bikes:inventory", "$..price", 100);
+console.log(res40); // [1920, 2072, 3264, 1475, 3941]
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res40.sort(), [1475, 1920, 2072, 3264, 3941]);
+// REMOVE_END
+
+// STEP_START update_filters1
+const res40a = await client.json.set(
+ 'bikes:inventory',
+ '$.inventory.*[?(@.price<2000)].price',
+ 1500
+);
+
+// Get all prices from the inventory
+const res40b = await client.json.get(
+ 'bikes:inventory',
+ { path: "$..price" }
+);
+console.log(res40b); // [1500, 2072, 3264, 1500, 3941]
+// STEP_END
+
+// STEP_START update_filters2
+const res41 = await client.json.arrAppend(
+ "bikes:inventory", "$.inventory.*[?(@.price<2000)].colors", "pink"
+);
+console.log(res41); // [3, 3]
+
+const res42 = await client.json.get("bikes:inventory", {
+ path: "$..[*].colors"
+});
+console.log(res42); // [['black', 'silver', 'pink'], ['black', 'white'], ['black', 'silver', 'pink']]
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res42, [
+ ["black", "silver", "pink"],
+ ["black", "white"],
+ ["black", "silver", "pink"],
+]);
+await client.close();
+// REMOVE_END
diff --git a/doctests/dt-list.js b/doctests/dt-list.js
new file mode 100644
index 00000000000..a2d0fb86c66
--- /dev/null
+++ b/doctests/dt-list.js
@@ -0,0 +1,329 @@
+// EXAMPLE: list_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+// REMOVE_START
+await client.del('bikes:repairs');
+await client.del('bikes:finished');
+// REMOVE_END
+
+// STEP_START queue
+const res1 = await client.lPush('bikes:repairs', 'bike:1');
+console.log(res1); // 1
+
+const res2 = await client.lPush('bikes:repairs', 'bike:2');
+console.log(res2); // 2
+
+const res3 = await client.rPop('bikes:repairs');
+console.log(res3); // bike:1
+
+const res4 = await client.rPop('bikes:repairs');
+console.log(res4); // bike:2
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 1);
+assert.equal(res2, 2);
+assert.equal(res3, 'bike:1');
+assert.equal(res4, 'bike:2');
+// REMOVE_END
+
+// STEP_START stack
+const res5 = await client.lPush('bikes:repairs', 'bike:1');
+console.log(res5); // 1
+
+const res6 = await client.lPush('bikes:repairs', 'bike:2');
+console.log(res6); // 2
+
+const res7 = await client.lPop('bikes:repairs');
+console.log(res7); // bike:2
+
+const res8 = await client.lPop('bikes:repairs');
+console.log(res8); // bike:1
+// STEP_END
+
+// REMOVE_START
+assert.equal(res5, 1);
+assert.equal(res6, 2);
+assert.equal(res7, 'bike:2');
+assert.equal(res8, 'bike:1');
+// REMOVE_END
+
+// STEP_START lLen
+const res9 = await client.lLen('bikes:repairs');
+console.log(res9); // 0
+// STEP_END
+
+// REMOVE_START
+assert.equal(res9, 0);
+// REMOVE_END
+
+// STEP_START lMove_lRange
+const res10 = await client.lPush('bikes:repairs', 'bike:1');
+console.log(res10); // 1
+
+const res11 = await client.lPush('bikes:repairs', 'bike:2');
+console.log(res11); // 2
+
+const res12 = await client.lMove('bikes:repairs', 'bikes:finished', 'LEFT', 'LEFT');
+console.log(res12); // 'bike:2'
+
+const res13 = await client.lRange('bikes:repairs', 0, -1);
+console.log(res13); // ['bike:1']
+
+const res14 = await client.lRange('bikes:finished', 0, -1);
+console.log(res14); // ['bike:2']
+// STEP_END
+
+// REMOVE_START
+assert.equal(res10, 1);
+assert.equal(res11, 2);
+assert.equal(res12, 'bike:2');
+assert.deepEqual(res13, ['bike:1']);
+assert.deepEqual(res14, ['bike:2']);
+await client.del('bikes:repairs');
+// REMOVE_END
+
+// STEP_START lPush_rPush
+const res15 = await client.rPush('bikes:repairs', 'bike:1');
+console.log(res15); // 1
+
+const res16 = await client.rPush('bikes:repairs', 'bike:2');
+console.log(res16); // 2
+
+const res17 = await client.lPush('bikes:repairs', 'bike:important_bike');
+console.log(res17); // 3
+
+const res18 = await client.lRange('bikes:repairs', 0, -1);
+console.log(res18); // ['bike:important_bike', 'bike:1', 'bike:2']
+// STEP_END
+
+// REMOVE_START
+assert.equal(res15, 1);
+assert.equal(res16, 2);
+assert.equal(res17, 3);
+assert.deepEqual(res18, ['bike:important_bike', 'bike:1', 'bike:2']);
+await client.del('bikes:repairs');
+// REMOVE_END
+
+// STEP_START variadic
+const res19 = await client.rPush('bikes:repairs', ['bike:1', 'bike:2', 'bike:3']);
+console.log(res19); // 3
+
+const res20 = await client.lPush(
+ 'bikes:repairs', ['bike:important_bike', 'bike:very_important_bike']
+);
+console.log(res20); // 5
+
+const res21 = await client.lRange('bikes:repairs', 0, -1);
+console.log(res21); // ['bike:very_important_bike', 'bike:important_bike', 'bike:1', 'bike:2', 'bike:3']
+// STEP_END
+
+// REMOVE_START
+assert.equal(res19, 3);
+assert.equal(res20, 5);
+assert.deepEqual(res21, [
+ 'bike:very_important_bike',
+ 'bike:important_bike',
+ 'bike:1',
+ 'bike:2',
+ 'bike:3',
+]);
+await client.del('bikes:repairs');
+// REMOVE_END
+
+// STEP_START lPop_rPop
+const res22 = await client.rPush('bikes:repairs', ['bike:1', 'bike:2', 'bike:3']);
+console.log(res22); // 3
+
+const res23 = await client.rPop('bikes:repairs');
+console.log(res23); // 'bike:3'
+
+const res24 = await client.lPop('bikes:repairs');
+console.log(res24); // 'bike:1'
+
+const res25 = await client.rPop('bikes:repairs');
+console.log(res25); // 'bike:2'
+
+const res26 = await client.rPop('bikes:repairs');
+console.log(res26); // null
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res22, 3);
+assert.equal(res23, 'bike:3');
+assert.equal(res24, 'bike:1');
+assert.equal(res25, 'bike:2');
+assert.equal(res26, null);
+// REMOVE_END
+
+// STEP_START lTrim
+const res27 = await client.lPush(
+ 'bikes:repairs', ['bike:1', 'bike:2', 'bike:3', 'bike:4', 'bike:5']
+);
+console.log(res27); // 5
+
+const res28 = await client.lTrim('bikes:repairs', 0, 2);
+console.log(res28); // OK
+
+const res29 = await client.lRange('bikes:repairs', 0, -1);
+console.log(res29); // ['bike:5', 'bike:4', 'bike:3']
+// STEP_END
+
+// REMOVE_START
+assert.equal(res27, 5);
+assert.equal(res28, 'OK');
+assert.deepEqual(res29, ['bike:5', 'bike:4', 'bike:3']);
+await client.del('bikes:repairs');
+// REMOVE_END
+
+// STEP_START lTrim_end_of_list
+const res27eol = await client.rPush(
+ 'bikes:repairs', ['bike:1', 'bike:2', 'bike:3', 'bike:4', 'bike:5']
+);
+console.log(res27eol); // 5
+
+const res28eol = await client.lTrim('bikes:repairs', -3, -1);
+console.log(res28eol); // 'OK'
+
+const res29eol = await client.lRange('bikes:repairs', 0, -1);
+console.log(res29eol); // ['bike:3', 'bike:4', 'bike:5']
+// STEP_END
+
+// REMOVE_START
+assert.equal(res27eol, 5);
+assert.equal(res28eol, 'OK');
+assert.deepEqual(res29eol, ['bike:3', 'bike:4', 'bike:5']);
+await client.del('bikes:repairs');
+// REMOVE_END
+
+// STEP_START brPop
+const res31 = await client.rPush('bikes:repairs', ['bike:1', 'bike:2']);
+console.log(res31); // 2
+
+const res32 = await client.brPop('bikes:repairs', 1);
+console.log(res32); // { key: 'bikes:repairs', element: 'bike:2' }
+
+const res33 = await client.brPop('bikes:repairs', 1);
+console.log(res33); // { key: 'bikes:repairs', element: 'bike:1' }
+
+const res34 = await client.brPop('bikes:repairs', 1);
+console.log(res34); // null
+// STEP_END
+
+// REMOVE_START
+assert.equal(res31, 2);
+assert.deepEqual(res32, { key: 'bikes:repairs', element: 'bike:2' });
+assert.deepEqual(res33, { key: 'bikes:repairs', element: 'bike:1' });
+assert.equal(res34, null);
+await client.del('bikes:repairs');
+await client.del('new_bikes');
+// REMOVE_END
+
+// STEP_START rule_1
+const res35 = await client.del('new_bikes');
+console.log(res35); // 0
+
+const res36 = await client.lPush('new_bikes', ['bike:1', 'bike:2', 'bike:3']);
+console.log(res36); // 3
+// STEP_END
+
+// REMOVE_START
+assert.equal(res35, 0);
+assert.equal(res36, 3);
+await client.del('new_bikes');
+// REMOVE_END
+
+// STEP_START rule_1.1
+const res37 = await client.set('new_bikes', 'bike:1');
+console.log(res37); // 'OK'
+
+const res38 = await client.type('new_bikes');
+console.log(res38); // 'string'
+
+try {
+ const res39 = await client.lPush('new_bikes', 'bike:2', 'bike:3');
+ // redis.exceptions.ResponseError:
+ // [SimpleError: WRONGTYPE Operation against a key holding the wrong kind of value]
+}
+catch(e){
+ console.log(e);
+}
+// STEP_END
+
+// REMOVE_START
+assert.equal(res37, 'OK');
+assert.equal(res38, 'string');
+await client.del('new_bikes');
+// REMOVE_END
+
+// STEP_START rule_2
+await client.lPush('bikes:repairs', ['bike:1', 'bike:2', 'bike:3']);
+console.log(res36); // 3
+
+const res40 = await client.exists('bikes:repairs')
+console.log(res40); // 1
+
+const res41 = await client.lPop('bikes:repairs');
+console.log(res41); // 'bike:3'
+
+const res42 = await client.lPop('bikes:repairs');
+console.log(res42); // 'bike:2'
+
+const res43 = await client.lPop('bikes:repairs');
+console.log(res43); // 'bike:1'
+
+const res44 = await client.exists('bikes:repairs');
+console.log(res44); // 0
+// STEP_END
+
+// REMOVE_START
+assert.equal(res40, 1);
+assert.equal(res41, 'bike:3');
+assert.equal(res42, 'bike:2');
+assert.equal(res43, 'bike:1');
+assert.equal(res44, 0);
+await client.del('bikes:repairs');
+// REMOVE_END
+
+// STEP_START rule_3
+const res45 = await client.del('bikes:repairs');
+console.log(res45); // 0
+
+const res46 = await client.lLen('bikes:repairs');
+console.log(res46); // 0
+
+const res47 = await client.lPop('bikes:repairs');
+console.log(res47); // null
+// STEP_END
+
+// REMOVE_START
+assert.equal(res45, 0);
+assert.equal(res46, 0);
+assert.equal(res47, null);
+// REMOVE_END
+
+// STEP_START lTrim.1
+const res48 = await client.lPush(
+ 'bikes:repairs', ['bike:1', 'bike:2', 'bike:3', 'bike:4', 'bike:5']
+);
+console.log(res48); // 5
+
+const res49 = await client.lTrim('bikes:repairs', 0, 2);
+console.log(res49); // 'OK'
+
+const res50 = await client.lRange('bikes:repairs', 0, -1);
+console.log(res50); // ['bike:5', 'bike:4', 'bike:3']
+// STEP_END
+
+// REMOVE_START
+assert.equal(res48, 5);
+assert.equal(res49, 'OK');
+assert.deepEqual(res50, ['bike:5', 'bike:4', 'bike:3']);
+await client.del('bikes:repairs');
+await client.close();
+// REMOVE_END
\ No newline at end of file
diff --git a/doctests/dt-set.js b/doctests/dt-set.js
new file mode 100644
index 00000000000..e3d34096399
--- /dev/null
+++ b/doctests/dt-set.js
@@ -0,0 +1,176 @@
+// EXAMPLE: sets_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+// REMOVE_START
+await client.del('bikes:racing:france')
+await client.del('bikes:racing:usa')
+// REMOVE_END
+
+// STEP_START sAdd
+const res1 = await client.sAdd('bikes:racing:france', 'bike:1')
+console.log(res1) // >>> 1
+
+const res2 = await client.sAdd('bikes:racing:france', 'bike:1')
+console.log(res2) // >>> 0
+const res3 = await client.sAdd('bikes:racing:france', ['bike:2', 'bike:3'])
+console.log(res3) // >>> 2
+const res4 = await client.sAdd('bikes:racing:usa', ['bike:1', 'bike:4'])
+console.log(res4) // >>> 2
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 1)
+assert.equal(res2, 0)
+assert.equal(res3, 2)
+assert.equal(res4, 2)
+// REMOVE_END
+
+// STEP_START sIsMember
+// HIDE_START
+await client.del('bikes:racing:france')
+await client.del('bikes:racing:usa')
+await client.sAdd('bikes:racing:france', 'bike:1', 'bike:2', 'bike:3')
+await client.sAdd('bikes:racing:usa', 'bike:1', 'bike:4')
+// HIDE_END
+const res5 = await client.sIsMember('bikes:racing:usa', 'bike:1')
+console.log(res5) // >>> 1
+
+const res6 = await client.sIsMember('bikes:racing:usa', 'bike:2')
+console.log(res6) // >>> 0
+// STEP_END
+
+// REMOVE_START
+assert.equal(res5, 1)
+assert.equal(res6, 0)
+// REMOVE_END
+
+// STEP_START sinster
+// HIDE_START
+await client.del('bikes:racing:france')
+await client.del('bikes:racing:usa')
+await client.sAdd('bikes:racing:france', 'bike:1', 'bike:2', 'bike:3')
+await client.sAdd('bikes:racing:usa', 'bike:1', 'bike:4')
+// HIDE_END
+const res7 = await client.sInter('bikes:racing:france', 'bikes:racing:usa')
+console.log(res7) // >>> {'bike:1'}
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res7, [ 'bike:1' ])
+// REMOVE_END
+
+// STEP_START sCard
+// HIDE_START
+await client.del('bikes:racing:france')
+await client.sAdd('bikes:racing:france', ['bike:1', 'bike:2', 'bike:3'])
+// HIDE_END
+const res8 = await client.sCard('bikes:racing:france')
+console.log(res8) // >>> 3
+// STEP_END
+
+// REMOVE_START
+assert.equal(res8, 3)
+await client.del('bikes:racing:france')
+// REMOVE_END
+
+// STEP_START sAdd_sMembers
+const res9 = await client.sAdd('bikes:racing:france', ['bike:1', 'bike:2', 'bike:3'])
+console.log(res9) // >>> 3
+
+const res10 = await client.sMembers('bikes:racing:france')
+console.log(res10) // >>> ['bike:1', 'bike:2', 'bike:3']
+// STEP_END
+
+// REMOVE_START
+assert.equal(res9, 3)
+assert.deepEqual(res10.sort(), ['bike:1', 'bike:2', 'bike:3'])
+// REMOVE_END
+
+// STEP_START smIsMember
+const res11 = await client.sIsMember('bikes:racing:france', 'bike:1')
+console.log(res11) // >>> 1
+
+const res12 = await client.smIsMember('bikes:racing:france', ['bike:2', 'bike:3', 'bike:4'])
+console.log(res12) // >>> [1, 1, 0]
+// STEP_END
+
+// REMOVE_START
+assert.equal(res11, 1)
+assert.deepEqual(res12, [1, 1, 0])
+// REMOVE_END
+
+// STEP_START sDiff
+await client.sAdd('bikes:racing:france', ['bike:1', 'bike:2', 'bike:3'])
+await client.sAdd('bikes:racing:usa', ['bike:1', 'bike:4'])
+const res13 = await client.sDiff(['bikes:racing:france', 'bikes:racing:usa'])
+console.log(res13) // >>> [ 'bike:2', 'bike:3' ]
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res13.sort(), ['bike:2', 'bike:3'].sort())
+await client.del('bikes:racing:france')
+await client.del('bikes:racing:usa')
+// REMOVE_END
+
+// STEP_START multisets
+await client.sAdd('bikes:racing:france', ['bike:1', 'bike:2', 'bike:3'])
+await client.sAdd('bikes:racing:usa', ['bike:1', 'bike:4'])
+await client.sAdd('bikes:racing:italy', ['bike:1', 'bike:2', 'bike:3', 'bike:4'])
+
+const res14 = await client.sInter(
+ ['bikes:racing:france', 'bikes:racing:usa', 'bikes:racing:italy']
+)
+console.log(res14) // >>> ['bike:1']
+
+const res15 = await client.sUnion(
+ ['bikes:racing:france', 'bikes:racing:usa', 'bikes:racing:italy']
+)
+console.log(res15) // >>> ['bike:1', 'bike:2', 'bike:3', 'bike:4']
+
+const res16 = await client.sDiff(['bikes:racing:france', 'bikes:racing:usa', 'bikes:racing:italy'])
+console.log(res16) // >>> []
+
+const res17 = await client.sDiff(['bikes:racing:usa', 'bikes:racing:france'])
+console.log(res17) // >>> ['bike:4']
+
+const res18 = await client.sDiff(['bikes:racing:france', 'bikes:racing:usa'])
+console.log(res18) // >>> ['bike:2', 'bike:3']
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res14, ['bike:1'])
+assert.deepEqual(res15.sort(), ['bike:1', 'bike:2', 'bike:3', 'bike:4'])
+assert.deepEqual(res16, [])
+assert.deepEqual(res17, ['bike:4'])
+assert.deepEqual(res18.sort(), ['bike:2', 'bike:3'].sort())
+await client.del('bikes:racing:france')
+await client.del('bikes:racing:usa')
+await client.del('bikes:racing:italy')
+// REMOVE_END
+
+// STEP_START sRem
+await client.sAdd('bikes:racing:france', ['bike:1', 'bike:2', 'bike:3', 'bike:4', 'bike:5'])
+
+const res19 = await client.sRem('bikes:racing:france', 'bike:1')
+console.log(res19) // >>> 1
+
+const res20 = await client.sPop('bikes:racing:france')
+console.log(res20) // >>> bike:3 or other random value
+
+const res21 = await client.sMembers('bikes:racing:france')
+console.log(res21) // >>> ['bike:2', 'bike:4', 'bike:5']; depends on previous result
+
+const res22 = await client.sRandMember('bikes:racing:france')
+console.log(res22) // >>> bike:4 or other random value
+// STEP_END
+
+// REMOVE_START
+assert.equal(res19, 1)
+await client.close()
+// none of the other results are deterministic
+// REMOVE_END
diff --git a/doctests/dt-ss.js b/doctests/dt-ss.js
new file mode 100644
index 00000000000..bba85b11580
--- /dev/null
+++ b/doctests/dt-ss.js
@@ -0,0 +1,162 @@
+// EXAMPLE: ss_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START zadd
+const res1 = await client.zAdd('racer_scores', { score: 10, value: 'Norem' });
+console.log(res1); // >>> 1
+
+const res2 = await client.zAdd('racer_scores', { score: 12, value: 'Castilla' });
+console.log(res2); // >>> 1
+
+const res3 = await client.zAdd('racer_scores', [
+ { score: 8, value: 'Sam-Bodden' },
+ { score: 10, value: 'Royce' },
+ { score: 6, value: 'Ford' },
+ { score: 14, value: 'Prickett' },
+ { score: 12, value: 'Castilla' }
+]);
+console.log(res3); // >>> 4
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 1)
+assert.equal(res2, 1)
+assert.equal(res3, 4)
+// REMOVE_END
+
+// REMOVE_START
+const count = await client.zCard('racer_scores');
+console.assert(count === 6);
+// REMOVE_END
+
+// STEP_START zrange
+const res4 = await client.zRange('racer_scores', 0, -1);
+console.log(res4); // >>> ['Ford', 'Sam-Bodden', 'Norem', 'Royce', 'Castilla', 'Prickett']
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res4, ['Ford', 'Sam-Bodden', 'Norem', 'Royce', 'Castilla', 'Prickett'])
+// REMOVE_END
+
+// STEP_START zrange_withscores
+const res6 = await client.zRangeWithScores('racer_scores', 0, -1);
+console.log(res6);
+// >>> [
+// { value: 'Ford', score: 6 }, { value: 'Sam-Bodden', score: 8 },
+// { value: 'Norem', score: 10 }, { value: 'Royce', score: 10 },
+// { value: 'Castilla', score: 12 }, { value: 'Prickett', score: 14 }
+// ]
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res6, [ { value: 'Ford', score: 6 }, { value: 'Sam-Bodden', score: 8 }, { value: 'Norem', score: 10 }, { value: 'Royce', score: 10 }, { value: 'Castilla', score: 12 }, { value: 'Prickett', score: 14 } ]
+)
+// REMOVE_END
+
+// STEP_START zrangebyscore
+const res7 = await client.zRangeByScore('racer_scores', '-inf', 10);
+console.log(res7); // >>> ['Ford', 'Sam-Bodden', 'Norem', 'Royce']
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res7, ['Ford', 'Sam-Bodden', 'Norem', 'Royce'])
+// REMOVE_END
+
+// STEP_START zremrangebyscore
+const res8 = await client.zRem('racer_scores', 'Castilla');
+console.log(res8); // >>> 1
+
+const res9 = await client.zRemRangeByScore('racer_scores', '-inf', 9);
+console.log(res9); // >>> 2
+
+// REMOVE_START
+assert.equal(res8, 1)
+assert.equal(res9, 2)
+// REMOVE_END
+
+const res10 = await client.zRange('racer_scores', 0, -1);
+console.log(res10); // >>> ['Norem', 'Royce', 'Prickett']
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res10, ['Norem', 'Royce', 'Prickett'])
+// REMOVE_END
+
+// REMOVE_START
+const count2 = await client.zCard('racer_scores');
+console.assert(count2 === 3);
+// REMOVE_END
+
+// STEP_START zrank
+const res11 = await client.zRank('racer_scores', 'Norem');
+console.log(res11); // >>> 0
+
+const res12 = await client.zRevRank('racer_scores', 'Norem');
+console.log(res12); // >>> 2
+// STEP_END
+
+// STEP_START zadd_lex
+const res13 = await client.zAdd('racer_scores', [
+ { score: 0, value: 'Norem' },
+ { score: 0, value: 'Sam-Bodden' },
+ { score: 0, value: 'Royce' },
+ { score: 0, value: 'Ford' },
+ { score: 0, value: 'Prickett' },
+ { score: 0, value: 'Castilla' }
+]);
+console.log(res13); // >>> 3
+
+// REMOVE_START
+assert.equal(count2, 3)
+assert.equal(res11, 0)
+assert.equal(res12, 2)
+assert.equal(res13, 3)
+// REMOVE_END
+
+const res14 = await client.zRange('racer_scores', 0, -1);
+console.log(res14); // >>> ['Castilla', 'Ford', 'Norem', 'Prickett', 'Royce', 'Sam-Bodden']
+
+const res15 = await client.zRangeByLex('racer_scores', '[A', '[L');
+console.log(res15); // >>> ['Castilla', 'Ford']
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res14, ['Castilla', 'Ford', 'Norem', 'Prickett', 'Royce', 'Sam-Bodden'])
+assert.deepEqual(res15, ['Castilla', 'Ford'])
+// REMOVE_END
+
+// STEP_START leaderboard
+const res16 = await client.zAdd('racer_scores', { score: 100, value: 'Wood' });
+console.log(res16); // >>> 1
+
+const res17 = await client.zAdd('racer_scores', { score: 100, value: 'Henshaw' });
+console.log(res17); // >>> 1
+
+const res18 = await client.zAdd('racer_scores', { score: 150, value: 'Henshaw' }, { nx: true });
+console.log(res18); // >>> 0
+
+const res19 = await client.zIncrBy('racer_scores', 50, 'Wood');
+console.log(res19); // >>> 150.0
+
+const res20 = await client.zIncrBy('racer_scores', 50, 'Henshaw');
+console.log(res20); // >>> 200.0
+// STEP_END
+
+// REMOVE_START
+assert.equal(res16, 1)
+assert.equal(res17, 1)
+assert.equal(res18, 0)
+assert.equal(res19, 150.0)
+assert.equal(res20, 200.0)
+await client.close();
+// REMOVE_END
diff --git a/doctests/dt-streams.js b/doctests/dt-streams.js
new file mode 100644
index 00000000000..00768654730
--- /dev/null
+++ b/doctests/dt-streams.js
@@ -0,0 +1,366 @@
+// EXAMPLE: stream_tutorial
+// HIDE_START
+import assert from 'assert';
+import {
+ createClient
+} from 'redis';
+
+const client = await createClient();
+await client.connect();
+// HIDE_END
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START xAdd
+const res1 = await client.xAdd(
+ 'race:france', '*', {
+ 'rider': 'Castilla',
+ 'speed': '30.2',
+ 'position': '1',
+ 'location_id': '1'
+ }
+);
+console.log(res1); // >>> 1700073067968-0 N.B. actual values will differ from these examples
+
+const res2 = await client.xAdd(
+ 'race:france', '*', {
+ 'rider': 'Norem',
+ 'speed': '28.8',
+ 'position': '3',
+ 'location_id': '1'
+ },
+);
+console.log(res2); // >>> 1692629594113-0
+
+const res3 = await client.xAdd(
+ 'race:france', '*', {
+ 'rider': 'Prickett',
+ 'speed': '29.7',
+ 'position': '2',
+ 'location_id': '1'
+ },
+);
+console.log(res3); // >>> 1692629613374-0
+// STEP_END
+
+// REMOVE_START
+assert.equal(await client.xLen('race:france'), 3);
+// REMOVE_END
+
+// STEP_START xRange
+const res4 = await client.xRange('race:france', '1691765278160-0', '+', {COUNT: 2});
+console.log(res4); // >>> [{ id: '1692629576966-0', message: { rider: 'Castilla', speed: '30.2', position: '1', location_id: '1' } }, { id: '1692629594113-0', message: { rider: 'Norem', speed: '28.8', position: '3', location_id: '1' } }]
+// STEP_END
+
+// STEP_START xread_block
+const res5 = await client.xRead({
+ key: 'race:france',
+ id: '0-0'
+}, {
+ COUNT: 100,
+ BLOCK: 300
+});
+console.log(res5); // >>> [{ name: 'race:france', messages: [{ id: '1692629576966-0', message: { rider: 'Castilla', speed: '30.2', position: '1', location_id: '1' } }, { id: '1692629594113-0', message: { rider: 'Norem', speed: '28.8', position: '3', location_id: '1' } }, { id: '1692629613374-0', message: { rider: 'Prickett', speed: '29.7', position: '2', location_id: '1' } }] }]
+// STEP_END
+
+// STEP_START xAdd_2
+const res6 = await client.xAdd(
+ 'race:france', '*', {
+ 'rider': 'Castilla',
+ 'speed': '29.9',
+ 'position': '1',
+ 'location_id': '2'
+ }
+);
+console.log(res6); // >>> 1692629676124-0
+// STEP_END
+
+// STEP_START xlen
+const res7 = await client.xLen('race:france');
+console.log(res7); // >>> 4
+// STEP_END
+
+
+// STEP_START xAdd_id
+const res8 = await client.xAdd('race:usa', '0-1', {
+ 'racer': 'Castilla'
+});
+console.log(res8); // >>> 0-1
+
+const res9 = await client.xAdd('race:usa', '0-2', {
+ 'racer': 'Norem'
+});
+console.log(res9); // >>> 0-2
+// STEP_END
+
+// STEP_START xAdd_bad_id
+try {
+ const res10 = await client.xAdd('race:usa', '0-1', {
+ 'racer': 'Prickett'
+ });
+ console.log(res10); // >>> 0-1
+} catch (error) {
+ console.error(error); // >>> [SimpleError: ERR The ID specified in XADD is equal or smaller than the target stream top item]
+}
+// STEP_END
+
+// STEP_START xadd_7
+const res11a = await client.xAdd('race:usa', '0-*', { racer: 'Norem' });
+console.log(res11a); // >>> 0-3
+// STEP_END
+
+// STEP_START xRange_all
+const res11 = await client.xRange('race:france', '-', '+');
+console.log(res11); // >>> [{ id: '1692629576966-0', message: { rider: 'Castilla', speed: '30.2', position: '1', location_id: '1' } }, { id: '1692629594113-0', message: { rider: 'Norem', speed: '28.8', position: '3', location_id: '1' } }, { id: '1692629613374-0', message: { rider: 'Prickett', speed: '29.7', position: '2', location_id: '1' } }, { id: '1692629676124-0', message: { rider: 'Castilla', speed: '29.9', position: '1', location_id: '2' } }]
+// STEP_END
+
+// STEP_START xRange_time
+const res12 = await client.xRange('race:france', '1692629576965', '1692629576967');
+console.log(res12); // >>> [{ id: '1692629576966-0', message: { rider: 'Castilla', speed: '30.2', position: '1', location_id: '1' } }]
+// STEP_END
+
+// STEP_START xRange_step_1
+const res13 = await client.xRange('race:france', '-', '+', {COUNT: 2});
+console.log(res13); // >>> [{ id: '1692629576966-0', message: { rider: 'Castilla', speed: '30.2', position: '1', location_id: '1' } }, { id: '1692629594113-0', message: { rider: 'Norem', speed: '28.8', position: '3', location_id: '1' } }]
+// STEP_END
+
+// STEP_START xRange_step_2
+const res14 = await client.xRange('race:france', '(1692629594113-0', '+', {COUNT: 2});
+console.log(res14); // >>> [{ id: '1692629613374-0', message: { rider: 'Prickett', speed: '29.7', position: '2', location_id: '1' } }, { id: '1692629676124-0', message: { rider: 'Castilla', speed: '29.9', position: '1', location_id: '2' } }]
+// STEP_END
+
+// STEP_START xRange_empty
+const res15 = await client.xRange('race:france', '(1692629676124-0', '+', {COUNT: 2});
+console.log(res15); // >>> []
+// STEP_END
+
+// STEP_START xrevrange
+const res16 = await client.xRevRange('race:france', '+', '-', {COUNT: 1});
+console.log(
+ res16
+); // >>> [{ id: '1692629676124-0', message: { rider: 'Castilla', speed: '29.9', position: '1', location_id: '2' } }]
+// STEP_END
+
+// STEP_START xread
+const res17 = await client.xRead({
+ key: 'race:france',
+ id: '0-0'
+}, {
+ COUNT: 2
+});
+console.log(res17); // >>> [{ name: 'race:france', messages: [{ id: '1692629576966-0', message: { rider: 'Castilla', speed: '30.2', position: '1', location_id: '1' } }, { id: '1692629594113-0', message: { rider: 'Norem', speed: '28.8', position: '3', location_id: '1' } }] }]
+// STEP_END
+
+// STEP_START xgroup_create
+const res18 = await client.xGroupCreate('race:france', 'france_riders', '$');
+console.log(res18); // >>> OK
+// STEP_END
+
+// STEP_START xgroup_create_mkstream
+const res19 = await client.xGroupCreate('race:italy', 'italy_riders', '$', {
+ MKSTREAM: true
+});
+console.log(res19); // >>> OK
+// STEP_END
+
+// STEP_START xgroup_read
+await client.xAdd('race:italy', '*', {
+ 'rider': 'Castilla'
+});
+await client.xAdd('race:italy', '*', {
+ 'rider': 'Royce'
+});
+await client.xAdd('race:italy', '*', {
+ 'rider': 'Sam-Bodden'
+});
+await client.xAdd('race:italy', '*', {
+ 'rider': 'Prickett'
+});
+await client.xAdd('race:italy', '*', {
+ 'rider': 'Norem'
+});
+
+const res20 = await client.xReadGroup(
+ 'italy_riders',
+ 'Alice', {
+ key: 'race:italy',
+ id: '>'
+ }, {
+ COUNT: 1
+ }
+);
+console.log(res20); // >>> [{ name: 'race:italy', messages: [{ id: '1692629925771-0', message: { rider: 'Castilla' } }] }]
+// STEP_END
+
+// STEP_START xgroup_read_id
+const res21 = await client.xReadGroup(
+ 'italy_riders',
+ 'Alice', {
+ key: 'race:italy',
+ id: '0'
+ }, {
+ COUNT: 1
+ }
+);
+console.log(res21); // >>> [{ name: 'race:italy', messages: [{ id: '1692629925771-0', message: { rider: 'Castilla' } }] }]
+// STEP_END
+
+// STEP_START xack
+const res22 = await client.xAck('race:italy', 'italy_riders', '1692629925771-0')
+console.log(res22); // >>> 1
+
+const res23 = await client.xReadGroup(
+ 'italy_riders',
+ 'Alice', {
+ key: 'race:italy',
+ id: '0'
+ }, {
+ COUNT: 1
+ }
+);
+console.log(res23); // >>> [{ name: 'race:italy', messages: [] }]
+// STEP_END
+
+// STEP_START xgroup_read_bob
+const res24 = await client.xReadGroup(
+ 'italy_riders',
+ 'Bob', {
+ key: 'race:italy',
+ id: '>'
+ }, {
+ COUNT: 2
+ }
+);
+console.log(res24); // >>> [{ name: 'race:italy', messages: [{ id: '1692629925789-0', message: { rider: 'Royce' } }, { id: '1692629925790-0', message: { rider: 'Sam-Bodden' } }] }]
+// STEP_END
+
+// STEP_START xpending
+const res25 = await client.xPending('race:italy', 'italy_riders');
+console.log(res25); // >>> {'pending': 2, 'firstId': '1692629925789-0', 'lastId': '1692629925790-0', 'consumers': [{'name': 'Bob', 'deliveriesCounter': 2}]}
+// STEP_END
+
+// STEP_START xpending_plus_minus
+const res26 = await client.xPendingRange('race:italy', 'italy_riders', '-', '+', 10);
+console.log(res26); // >>> [{'id': '1692629925789-0', 'consumer': 'Bob', 'millisecondsSinceLastDelivery': 31084, 'deliveriesCounter:': 1}, {'id': '1692629925790-0', 'consumer': 'Bob', 'millisecondsSinceLastDelivery': 31084, 'deliveriesCounter': 1}]
+// STEP_END
+
+// STEP_START xRange_pending
+const res27 = await client.xRange('race:italy', '1692629925789-0', '1692629925789-0');
+console.log(res27); // >>> [{ id: '1692629925789-0', message: { rider: 'Royce' } }]
+// STEP_END
+
+// STEP_START xclaim
+const res28 = await client.xClaim(
+ 'race:italy', 'italy_riders', 'Alice', 60000, ['1692629925789-0']
+);
+console.log(res28); // >>> [{ id: '1692629925789-0', message: { rider: 'Royce' } }]
+// STEP_END
+
+// STEP_START xautoclaim
+const res29 = await client.xAutoClaim('race:italy', 'italy_riders', 'Alice', 1, '0-0', {
+ COUNT: 1
+});
+console.log(res29); // >>> { nextId: '1692629925790-0', messages: [{ id: '1692629925789-0', message: { rider: 'Royce' } }], deletedMessages: [] }
+// STEP_END
+
+// STEP_START xautoclaim_cursor
+const res30 = await client.xAutoClaim(
+ 'race:italy', 'italy_riders', 'Alice', 1, '(1692629925789-0',
+ {
+ COUNT: 1
+ }
+);
+console.log(res30); // >>> { nextId: '0-0', messages: [{ id: '1692629925790-0', message: { rider: 'Sam-Bodden' } }], deletedMessages: [] }
+// STEP_END
+
+// STEP_START xinfo
+const res31 = await client.xInfoStream('race:italy');
+console.log(res31); // >>> { length: 5, 'radix-tree-keys': 1, 'radix-tree-nodes': 2, 'last-generated-id': '1692629926436-0', 'max-deleted-entry-id': '0-0', 'entries-added': 5, 'recorded-first-entry-id': '1692629925771-0', groups: 1, 'first-entry': { id: '1692629925771-0', message: { rider: 'Castilla' } }, 'last-entry': { id: '1692629926436-0', message: { rider: 'Norem' } } }
+// STEP_END
+
+// STEP_START xinfo_groups
+const res32 = await client.xInfoGroups('race:italy');
+console.log(res32); // >>> [{ name: 'italy_riders', consumers: 2, pending: 3, 'last-delivered-id': '1692629925790-0', 'entries-read': 3, lag: 2 }]
+// STEP_END
+
+// STEP_START xinfo_consumers
+const res33 = await client.xInfoConsumers('race:italy', 'italy_riders');
+console.log(res33); // >>> [{ name: 'Alice', pending: 3, idle: 170582, inactive: 170582 }, { name: 'Bob', pending: 0, idle: 489404, inactive: 489404 }]
+// STEP_END
+
+// STEP_START maxlen
+await client.xAdd('race:italy', '*', {
+ 'rider': 'Jones'
+}, {
+ TRIM: {
+ strategy: 'MAXLEN',
+ strategyModifier: '~',
+ threshold: 2
+ }
+});
+await client.xAdd('race:italy', '*', {
+ 'rider': 'Wood'
+}, {
+ TRIM: {
+ strategy: 'MAXLEN',
+ strategyModifier: '~',
+ threshold: 2
+ }
+});
+await client.xAdd('race:italy', '*', {
+ 'rider': 'Henshaw'
+}, {
+ TRIM: {
+ strategy: 'MAXLEN',
+ strategyModifier: '~',
+ threshold: 2
+ }
+});
+
+const res34 = await client.xLen('race:italy');
+console.log(res34); // >>> 8
+
+const res35 = await client.xRange('race:italy', '-', '+');
+console.log(res35); // >>> [{ id: '1692629925771-0', message: { rider: 'Castilla' } }, { id: '1692629925789-0', message: { rider: 'Royce' } }, { id: '1692629925790-0', message: { rider: 'Sam-Bodden' } }, { id: '1692629925791-0', message: { rider: 'Prickett' } }, { id: '1692629926436-0', message: { rider: 'Norem' } }, { id: '1692630612602-0', message: { rider: 'Jones' } }, { id: '1692630641947-0', message: { rider: 'Wood' } }, { id: '1692630648281-0', message: { rider: 'Henshaw' } }]
+
+await client.xAdd('race:italy', '*', {
+ 'rider': 'Smith'
+}, {
+ TRIM: {
+ strategy: 'MAXLEN',
+ strategyModifier: '=',
+ threshold: 2
+ }
+});
+
+const res36 = await client.xRange('race:italy', '-', '+');
+console.log(res36); // >>> [{ id: '1692630648281-0', message: { rider: 'Henshaw' } }, { id: '1692631018238-0', message: { rider: 'Smith' } }]
+// STEP_END
+
+// STEP_START xTrim
+const res37 = await client.xTrim('race:italy', 'MAXLEN', 10, {
+ strategyModifier: '=',
+});
+console.log(res37); // >>> 0
+// STEP_END
+
+// STEP_START xTrim2
+const res38 = await client.xTrim('race:italy', "MAXLEN", 10);
+console.log(res38); // >>> 0
+// STEP_END
+
+// STEP_START xDel
+const res39 = await client.xRange('race:italy', '-', '+');
+console.log(res39); // >>> [{ id: '1692630648281-0', message: { rider: 'Henshaw' } }, { id: '1692631018238-0', message: { rider: 'Smith' } }]
+
+const res40 = await client.xDel('race:italy', '1692631018238-0');
+console.log(res40); // >>> 1
+
+const res41 = await client.xRange('race:italy', '-', '+');
+console.log(res41); // >>> [{ id: '1692630648281-0', message: { rider: 'Henshaw' } }]
+// STEP_END
+
+// REMOVE_START
+await client.quit();
+// REMOVE_END
\ No newline at end of file
diff --git a/doctests/dt-string.js b/doctests/dt-string.js
new file mode 100644
index 00000000000..6f77709abfa
--- /dev/null
+++ b/doctests/dt-string.js
@@ -0,0 +1,68 @@
+// EXAMPLE: set_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START set_get
+const res1 = await client.set("bike:1", "Deimos");
+console.log(res1); // OK
+const res2 = await client.get("bike:1");
+console.log(res2); // Deimos
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 'OK');
+assert.equal(res2, 'Deimos');
+// REMOVE_END
+
+// STEP_START setnx_xx
+const res3 = await client.set("bike:1", "bike", {'NX': true});
+console.log(res3); // null
+console.log(await client.get("bike:1")); // Deimos
+const res4 = await client.set("bike:1", "bike", {'XX': true});
+console.log(res4); // OK
+// STEP_END
+
+// REMOVE_START
+assert.equal(res3, null);
+assert.equal(res4, 'OK');
+// REMOVE_END
+
+// STEP_START mset
+const res5 = await client.mSet([
+ ["bike:1", "Deimos"],
+ ["bike:2", "Ares"],
+ ["bike:3", "Vanth"]
+]);
+
+console.log(res5); // OK
+const res6 = await client.mGet(["bike:1", "bike:2", "bike:3"]);
+console.log(res6); // ['Deimos', 'Ares', 'Vanth']
+// STEP_END
+
+// REMOVE_START
+assert.equal(res5, 'OK');
+assert.deepEqual(res6, ["Deimos", "Ares", "Vanth"]);
+// REMOVE_END
+
+// STEP_START incr
+await client.set("total_crashes", 0);
+const res7 = await client.incr("total_crashes");
+console.log(res7); // 1
+const res8 = await client.incrBy("total_crashes", 10);
+console.log(res8); // 11
+// STEP_END
+
+// REMOVE_START
+assert.equal(res7, 1);
+assert.equal(res8, 11);
+
+await client.close();
+// REMOVE_END
diff --git a/doctests/dt-tdigest.js b/doctests/dt-tdigest.js
new file mode 100644
index 00000000000..c59168076e3
--- /dev/null
+++ b/doctests/dt-tdigest.js
@@ -0,0 +1,85 @@
+// EXAMPLE: tdigest_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START tdig_start
+const res1 = await client.tDigest.create('bikes:sales', 100);
+console.log(res1); // >>> OK
+
+const res2 = await client.tDigest.add('bikes:sales', [21]);
+console.log(res2); // >>> OK
+
+const res3 = await client.tDigest.add('bikes:sales', [150, 95, 75, 34]);
+console.log(res3); // >>> OK
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 'OK')
+assert.equal(res2, 'OK')
+assert.equal(res3, 'OK')
+// REMOVE_END
+
+// STEP_START tdig_cdf
+const res4 = await client.tDigest.create('racer_ages');
+console.log(res4); // >>> OK
+
+const res5 = await client.tDigest.add('racer_ages', [
+ 45.88, 44.2, 58.03, 19.76, 39.84, 69.28, 50.97, 25.41, 19.27, 85.71, 42.63
+]);
+console.log(res5); // >>> OK
+
+const res6 = await client.tDigest.rank('racer_ages', [50]);
+console.log(res6); // >>> [7]
+
+const res7 = await client.tDigest.rank('racer_ages', [50, 40]);
+console.log(res7); // >>> [7, 4]
+// STEP_END
+
+// REMOVE_START
+assert.equal(res4, 'OK')
+assert.equal(res5, 'OK')
+assert.deepEqual(res6, [7])
+assert.deepEqual(res7, [7, 4])
+// REMOVE_END
+
+// STEP_START tdig_quant
+const res8 = await client.tDigest.quantile('racer_ages', [0.5]);
+console.log(res8); // >>> [44.2]
+
+const res9 = await client.tDigest.byRank('racer_ages', [4]);
+console.log(res9); // >>> [42.63]
+// STEP_END
+
+// STEP_START tdig_min
+const res10 = await client.tDigest.min('racer_ages');
+console.log(res10); // >>> 19.27
+
+const res11 = await client.tDigest.max('racer_ages');
+console.log(res11); // >>> 85.71
+// STEP_END
+
+// REMOVE_START
+assert.deepEqual(res8, [44.2])
+assert.deepEqual(res9, [42.63])
+assert.equal(res10, 19.27)
+assert.equal(res11, 85.71)
+// REMOVE_END
+
+// STEP_START tdig_reset
+const res12 = await client.tDigest.reset('racer_ages');
+console.log(res12); // >>> OK
+// STEP_END
+
+// REMOVE_START
+assert.equal(res12, 'OK')
+await client.close();
+// REMOVE_END
diff --git a/doctests/dt-time-series.js b/doctests/dt-time-series.js
new file mode 100644
index 00000000000..d2d94e7dc40
--- /dev/null
+++ b/doctests/dt-time-series.js
@@ -0,0 +1,635 @@
+// EXAMPLE: time_series_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+import { TIME_SERIES_AGGREGATION_TYPE, TIME_SERIES_REDUCERS } from '@redis/time-series';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.del([
+ 'thermometer:1', 'thermometer:2', 'thermometer:3',
+ 'rg:1', 'rg:2', 'rg:3', 'rg:4',
+ 'sensor3',
+ 'wind:1', 'wind:2', 'wind:3', 'wind:4',
+ 'hyg:1', 'hyg:compacted'
+]);
+// REMOVE_END
+
+// STEP_START create
+const res1 = await client.ts.create('thermometer:1');
+console.log(res1); // >>> OK
+
+const res2 = await client.type('thermometer:1');
+console.log(res2); // >>> TSDB-TYPE
+
+const res3 = await client.ts.info('thermometer:1');
+console.log(res3);
+// >>> { rules: [], ... totalSamples: 0, ...
+// STEP_END
+// REMOVE_START
+assert.equal(res1, 'OK');
+assert.equal(res2, 'TSDB-TYPE');
+assert.equal(res3.totalSamples, 0);
+// REMOVE_END
+
+// STEP_START create_retention
+const res4 = await client.ts.add('thermometer:2', 1, 10.8, { RETENTION: 100 });
+console.log(res4); // >>> 1
+
+const res5 = await client.ts.info('thermometer:2');
+console.log(res5);
+// >>> { rules: [], ... retentionTime: 100, ...
+// STEP_END
+// REMOVE_START
+assert.equal(res4, 1);
+assert.equal(res5.retentionTime, 100);
+// REMOVE_END
+
+// STEP_START create_labels
+const res6 = await client.ts.add('thermometer:3', 1, 10.4, {
+ LABELS: { location: 'UK', type: 'Mercury' }
+});
+console.log(res6); // >>> 1
+
+const res7 = await client.ts.info('thermometer:3');
+console.log(res7);
+// >>> { labels: [{ name: 'location', value: 'UK' }, { name: 'type', value: 'Mercury' }], ... }
+// STEP_END
+// REMOVE_START
+assert.equal(res6, 1);
+assert.deepEqual(res7.labels, [
+ { name: 'location', value: 'UK' },
+ { name: 'type', value: 'Mercury' },
+]);
+// REMOVE_END
+
+// STEP_START madd
+const res8 = await client.ts.mAdd([
+ { key: 'thermometer:1', timestamp: 1, value: 9.2 },
+ { key: 'thermometer:1', timestamp: 2, value: 9.9 },
+ { key: 'thermometer:2', timestamp: 2, value: 10.3 }
+]);
+console.log(res8); // >>> [1, 2, 2]
+// STEP_END
+// REMOVE_START
+assert.deepEqual(res8, [1, 2, 2]);
+// REMOVE_END
+
+// STEP_START get
+// The last recorded temperature for thermometer:2
+// was 10.3 at time 2.
+const res9 = await client.ts.get('thermometer:2');
+console.log(res9); // >>> { timestamp: 2, value: 10.3 }
+// STEP_END
+// REMOVE_START
+assert.equal(res9.timestamp, 2);
+assert.equal(res9.value, 10.3);
+// REMOVE_END
+
+// STEP_START range
+// Add 5 data points to a time series named "rg:1".
+const res10 = await client.ts.create('rg:1');
+console.log(res10); // >>> OK
+
+const res11 = await client.ts.mAdd([
+ { key: 'rg:1', timestamp: 0, value: 18 },
+ { key: 'rg:1', timestamp: 1, value: 14 },
+ { key: 'rg:1', timestamp: 2, value: 22 },
+ { key: 'rg:1', timestamp: 3, value: 18 },
+ { key: 'rg:1', timestamp: 4, value: 24 }
+]);
+console.log(res11); // >>> [0, 1, 2, 3, 4]
+
+// Retrieve all the data points in ascending order.
+const res12 = await client.ts.range('rg:1', '-', '+');
+console.log(res12);
+// >>> [{ timestamp: 0, value: 18 }, { timestamp: 1, value: 14 }, ...]
+
+// Retrieve data points up to time 1 (inclusive).
+const res13 = await client.ts.range('rg:1', '-', 1);
+console.log(res13);
+// >>> [{ timestamp: 0, value: 18 }, { timestamp: 1, value: 14 }]
+
+// Retrieve data points from time 3 onwards.
+const res14 = await client.ts.range('rg:1', 3, '+');
+console.log(res14);
+// >>> [{ timestamp: 3, value: 18 }, { timestamp: 4, value: 24 }]
+
+// Retrieve all the data points in descending order.
+const res15 = await client.ts.revRange('rg:1', '-', '+');
+console.log(res15);
+// >>> [{ timestamp: 4, value: 24 }, { timestamp: 3, value: 18 }, ...]
+
+// Retrieve data points up to time 1 (inclusive), but return them
+// in descending order.
+const res16 = await client.ts.revRange('rg:1', '-', 1);
+console.log(res16);
+// >>> [{ timestamp: 1, value: 14 }, { timestamp: 0, value: 18 }]
+// STEP_END
+// REMOVE_START
+assert.equal(res10, 'OK');
+assert.deepEqual(res11, [0, 1, 2, 3, 4]);
+
+assert.deepEqual(res12, [
+ { timestamp: 0, value: 18 },
+ { timestamp: 1, value: 14 },
+ { timestamp: 2, value: 22 },
+ { timestamp: 3, value: 18 },
+ { timestamp: 4, value: 24 }
+]);
+assert.deepEqual(res13, [
+ { timestamp: 0, value: 18 },
+ { timestamp: 1, value: 14 }
+]);
+assert.deepEqual(res14, [
+ { timestamp: 3, value: 18 },
+ { timestamp: 4, value: 24 }
+]);
+assert.deepEqual(res15, [
+ { timestamp: 4, value: 24 },
+ { timestamp: 3, value: 18 },
+ { timestamp: 2, value: 22 },
+ { timestamp: 1, value: 14 },
+ { timestamp: 0, value: 18 }
+]);
+assert.deepEqual(res16, [
+ { timestamp: 1, value: 14 },
+ { timestamp: 0, value: 18 }
+]);
+// REMOVE_END
+
+// STEP_START range_filter
+const res17 = await client.ts.range('rg:1', '-', '+', {
+ FILTER_BY_TS: [0, 2, 4]
+});
+console.log(res17);
+// >>> [{ timestamp: 0, value: 18 }, { timestamp: 2, value: 22 }, { timestamp: 4, value: 24 }]
+
+const res18 = await client.ts.revRange('rg:1', '-', '+', {
+ FILTER_BY_TS: [0, 2, 4],
+ FILTER_BY_VALUE: { min: 20, max: 25 }
+});
+console.log(res18);
+// >>> [{ timestamp: 4, value: 24 }, { timestamp: 2, value: 22 }]
+
+const res19 = await client.ts.revRange('rg:1', '-', '+', {
+ FILTER_BY_TS: [0, 2, 4],
+ FILTER_BY_VALUE: { min: 22, max: 22 },
+ COUNT: 1
+});
+console.log(res19);
+// >>> [{ timestamp: 2, value: 22 }]
+// STEP_END
+// REMOVE_START
+assert.deepEqual(res17, [
+ { timestamp: 0, value: 18 },
+ { timestamp: 2, value: 22 },
+ { timestamp: 4, value: 24 }
+]);
+assert.deepEqual(res18, [
+ { timestamp: 4, value: 24 },
+ { timestamp: 2, value: 22 }
+]);
+assert.deepEqual(res19, [
+ { timestamp: 2, value: 22 }
+]);
+// REMOVE_END
+
+// STEP_START query_multi
+// Create three new "rg:" time series (two in the US
+// and one in the UK, with different units) and add some
+// data points.
+const res20 = await client.ts.create('rg:2', {
+ LABELS: { location: 'us', unit: 'cm' }
+});
+console.log(res20); // >>> OK
+
+const res21 = await client.ts.create('rg:3', {
+ LABELS: { location: 'us', unit: 'in' }
+});
+console.log(res21); // >>> OK
+
+const res22 = await client.ts.create('rg:4', {
+ LABELS: { location: 'uk', unit: 'mm' }
+});
+console.log(res22); // >>> OK
+
+const res23 = await client.ts.mAdd([
+ { key: 'rg:2', timestamp: 0, value: 1.8 },
+ { key: 'rg:3', timestamp: 0, value: 0.9 },
+ { key: 'rg:4', timestamp: 0, value: 25 }
+]);
+console.log(res23); // >>> [0, 0, 0]
+
+const res24 = await client.ts.mAdd([
+ { key: 'rg:2', timestamp: 1, value: 2.1 },
+ { key: 'rg:3', timestamp: 1, value: 0.77 },
+ { key: 'rg:4', timestamp: 1, value: 18 }
+]);
+console.log(res24); // >>> [1, 1, 1]
+
+const res25 = await client.ts.mAdd([
+ { key: 'rg:2', timestamp: 2, value: 2.3 },
+ { key: 'rg:3', timestamp: 2, value: 1.1 },
+ { key: 'rg:4', timestamp: 2, value: 21 }
+]);
+console.log(res25); // >>> [2, 2, 2]
+
+const res26 = await client.ts.mAdd([
+ { key: 'rg:2', timestamp: 3, value: 1.9 },
+ { key: 'rg:3', timestamp: 3, value: 0.81 },
+ { key: 'rg:4', timestamp: 3, value: 19 }
+]);
+console.log(res26); // >>> [3, 3, 3]
+
+const res27 = await client.ts.mAdd([
+ { key: 'rg:2', timestamp: 4, value: 1.78 },
+ { key: 'rg:3', timestamp: 4, value: 0.74 },
+ { key: 'rg:4', timestamp: 4, value: 23 }
+]);
+console.log(res27); // >>> [4, 4, 4]
+
+// Retrieve the last data point from each US time series.
+const res28 = await client.ts.mGet(['location=us']);
+console.log(res28);
+// >>> { "rg:2": { sample: { timestamp: 4, value: 1.78 } }, "rg:3": { sample: { timestamp: 4, value: 0.74 } } }
+
+// Retrieve the same data points, but include the `unit`
+// label in the results.
+const res29 = await client.ts.mGetSelectedLabels(['location=us'], ['unit']);
+console.log(res29);
+// >>> { "rg:2": { labels: { unit: 'cm' }, sample: { timestamp: 4, value: 1.78 } }, "rg:3": { labels: { unit: 'in' }, sample: { timestamp: 4, value: 0.74 } } }
+
+// Retrieve data points up to time 2 (inclusive) from all
+// time series that use millimeters as the unit. Include all
+// labels in the results.
+const res30 = await client.ts.mRangeWithLabels('-', 2, 'unit=mm');
+console.log(res30);
+// >>> { "rg:4": { labels: { location: 'uk', unit: 'mm' }, samples: [
+// { timestamp: 0, value: 25 },
+// { timestamp: 1, value: 18 },
+// { timestamp: 2, value: 21 }
+// ] } }
+
+// Retrieve data points from time 1 to time 3 (inclusive) from
+// all time series that use centimeters or millimeters as the unit,
+// but only return the `location` label. Return the results
+// in descending order of timestamp.
+const res31 = await client.ts.mRevRangeSelectedLabels(
+ 1, 3,
+ ['location'],
+ ['unit=(cm,mm)']
+);
+console.log(res31);
+// >>> { "rg:2": { labels: { location: 'us' }, samples: [
+// { timestamp: 3, value: 1.9 },
+// { timestamp: 2, value: 2.3 },
+// { timestamp: 1, value: 2.1 }
+// ] }, "rg:4": { labels: { location: 'uk' }, samples: [
+// { timestamp: 3, value: 19 },
+// { timestamp: 2, value: 21 },
+// { timestamp: 1, value: 18 }
+// ] } }
+// STEP_END
+// REMOVE_START
+assert.equal(res20, 'OK');
+assert.equal(res21, 'OK');
+assert.equal(res22, 'OK');
+assert.deepEqual(res23, [0, 0, 0]);
+assert.deepEqual(res24, [1, 1, 1]);
+assert.deepEqual(res25, [2, 2, 2]);
+assert.deepEqual(res26, [3, 3, 3]);
+assert.deepEqual(res27, [4, 4, 4]);
+
+assert.deepEqual(res28, {
+ "rg:2": { sample: { timestamp: 4, value: 1.78 } },
+ "rg:3": { sample: { timestamp: 4, value: 0.74 } }
+});
+assert.deepEqual(res29, {
+ "rg:2": { labels: { unit: 'cm' }, sample: { timestamp: 4, value: 1.78 } },
+ "rg:3": { labels: { unit: 'in' }, sample: { timestamp: 4, value: 0.74 } }
+});
+
+assert.deepEqual(res30, {
+ "rg:4": {
+ labels: { location: 'uk', unit: 'mm' },
+ samples: [
+ { timestamp: 0, value: 25 },
+ { timestamp: 1, value: 18 },
+ { timestamp: 2, value: 21 }
+ ]
+ }
+});
+assert.deepEqual(res31, {
+ "rg:2": {
+ labels: { location: 'us' },
+ samples: [
+ { timestamp: 3, value: 1.9 },
+ { timestamp: 2, value: 2.3 },
+ { timestamp: 1, value: 2.1 }
+ ]
+ },
+ "rg:4": {
+ labels: { location: 'uk' },
+ samples: [
+ { timestamp: 3, value: 19 },
+ { timestamp: 2, value: 21 },
+ { timestamp: 1, value: 18 }
+ ]
+ }
+});
+// REMOVE_END
+
+// STEP_START agg
+const res32 = await client.ts.range('rg:2', '-', '+', {
+ AGGREGATION: {
+ type: TIME_SERIES_AGGREGATION_TYPE.AVG,
+ timeBucket: 2
+ }
+});
+console.log(res32);
+// >>> [{ timestamp: 0, value: 1.9500000000000002 },{ timestamp: 2, value: 2.0999999999999996 }, { timestamp: 4, value: 1.78 }]
+// STEP_END
+// REMOVE_START
+assert.deepEqual(res32, [
+ { timestamp: 0, value: 1.9500000000000002 },
+ { timestamp: 2, value: 2.0999999999999996 },
+ { timestamp: 4, value: 1.78 }
+]);
+// REMOVE_END
+
+// STEP_START agg_bucket
+const res33 = await client.ts.create('sensor3');
+console.log(res33); // >>> OK
+
+const res34 = await client.ts.mAdd([
+ { key: 'sensor3', timestamp: 10, value: 1000 },
+ { key: 'sensor3', timestamp: 20, value: 2000 },
+ { key: 'sensor3', timestamp: 30, value: 3000 },
+ { key: 'sensor3', timestamp: 40, value: 4000 },
+ { key: 'sensor3', timestamp: 50, value: 5000 },
+ { key: 'sensor3', timestamp: 60, value: 6000 },
+ { key: 'sensor3', timestamp: 70, value: 7000 }
+]);
+console.log(res34); // >>> [10, 20, 30, 40, 50, 60, 70]
+
+const res35 = await client.ts.range('sensor3', 10, 70, {
+ AGGREGATION: {
+ type: TIME_SERIES_AGGREGATION_TYPE.MIN,
+ timeBucket: 25
+ }
+});
+console.log(res35);
+// >>> [{ timestamp: 0, value: 1000 }, { timestamp: 25, value: 3000 }, { timestamp: 50, value: 5000 }]
+// STEP_END
+// REMOVE_START
+assert.equal(res33, 'OK');
+assert.deepEqual(res34, [10, 20, 30, 40, 50, 60, 70]);
+assert.deepEqual(res35, [
+ { timestamp: 0, value: 1000 },
+ { timestamp: 25, value: 3000 },
+ { timestamp: 50, value: 5000 }
+]);
+// REMOVE_END
+
+// STEP_START agg_align
+const res36 = await client.ts.range('sensor3', 10, 70, {
+ AGGREGATION: {
+ type: TIME_SERIES_AGGREGATION_TYPE.MIN,
+ timeBucket: 25
+ },
+ ALIGN: 'START'
+});
+console.log(res36);
+// >>> [{ timestamp: 10, value: 1000 }, { timestamp: 35, value: 4000 }, { timestamp: 60, value: 6000 }]
+// STEP_END
+// REMOVE_START
+assert.deepEqual(res36, [
+ { timestamp: 10, value: 1000 },
+ { timestamp: 35, value: 4000 },
+ { timestamp: 60, value: 6000 }
+]);
+// REMOVE_END
+
+// STEP_START agg_multi
+const res37 = await client.ts.create('wind:1', {
+ LABELS: { country: 'uk' }
+});
+console.log(res37); // >>> OK
+
+const res38 = await client.ts.create('wind:2', {
+ LABELS: { country: 'uk' }
+});
+console.log(res38); // >>> OK
+
+const res39 = await client.ts.create('wind:3', {
+ LABELS: { country: 'us' }
+});
+console.log(res39); // >>> OK
+
+const res40 = await client.ts.create('wind:4', {
+ LABELS: { country: 'us' }
+});
+console.log(res40); // >>> OK
+
+const res41 = await client.ts.mAdd([
+ { key: 'wind:1', timestamp: 1, value: 12 },
+ { key: 'wind:2', timestamp: 1, value: 18 },
+ { key: 'wind:3', timestamp: 1, value: 5 },
+ { key: 'wind:4', timestamp: 1, value: 20 }
+]);
+console.log(res41); // >>> [1, 1, 1, 1]
+
+const res42 = await client.ts.mAdd([
+ { key: 'wind:1', timestamp: 2, value: 14 },
+ { key: 'wind:2', timestamp: 2, value: 21 },
+ { key: 'wind:3', timestamp: 2, value: 4 },
+ { key: 'wind:4', timestamp: 2, value: 25 }
+]);
+console.log(res42); // >>> [2, 2, 2, 2]
+
+const res43 = await client.ts.mAdd([
+ { key: 'wind:1', timestamp: 3, value: 10 },
+ { key: 'wind:2', timestamp: 3, value: 24 },
+ { key: 'wind:3', timestamp: 3, value: 8 },
+ { key: 'wind:4', timestamp: 3, value: 18 }
+]);
+console.log(res43); // >>> [3, 3, 3, 3]
+
+// The result pairs contain the timestamp and the maximum sample value
+// for the country at that timestamp.
+const res44 = await client.ts.mRangeGroupBy(
+ '-', '+', ['country=(us,uk)'],
+ {label: 'country', REDUCE: TIME_SERIES_REDUCERS.MAX}
+);
+console.log(res44);
+// >>> { "country=uk": { samples: [
+// { timestamp: 1, value: 18 },
+// { timestamp: 2, value: 21 },
+// { timestamp: 3, value: 24 }
+// ] }, "country=us": { samples: [
+// { timestamp: 1, value: 20 },
+// { timestamp: 2, value: 25 },
+// { timestamp: 3, value: 18 }
+// ] } }
+
+// The result pairs contain the timestamp and the average sample value
+// for the country at that timestamp.
+const res45 = await client.ts.mRangeGroupBy(
+ '-', '+', ['country=(us,uk)'],
+ { label: 'country', REDUCE: TIME_SERIES_REDUCERS.AVG}
+);
+console.log(res45);
+// >>> {
+// "country=uk": {
+// samples: [{ timestamp: 1, value: 15 }, { timestamp: 2, value: 17.5 }, { timestamp: 3, value: 17 }]
+// },
+// "country=us": {
+// samples: [{ timestamp: 1, value: 12.5 }, { timestamp: 2, value: 14.5 }, { timestamp: 3, value: 13 }]
+// }
+// }
+// STEP_END
+// REMOVE_START
+assert.equal(res37, 'OK');
+assert.equal(res38, 'OK');
+assert.equal(res39, 'OK');
+assert.equal(res40, 'OK');
+assert.deepEqual(res41, [1, 1, 1, 1]);
+assert.deepEqual(res42, [2, 2, 2, 2]);
+assert.deepEqual(res43, [3, 3, 3, 3]);
+
+assert.deepEqual(res44, {
+ "country=uk": {
+ samples: [
+ { timestamp: 1, value: 18 },
+ { timestamp: 2, value: 21 },
+ { timestamp: 3, value: 24 }
+ ]
+ },
+ "country=us": {
+ samples: [
+ { timestamp: 1, value: 20 },
+ { timestamp: 2, value: 25 },
+ { timestamp: 3, value: 18 }
+ ]
+ }
+});
+assert.deepEqual(res45, {
+ "country=uk": {
+ samples: [
+ { timestamp: 1, value: 15 },
+ { timestamp: 2, value: 17.5 },
+ { timestamp: 3, value: 17 }
+ ]
+ },
+ "country=us": {
+ samples: [
+ { timestamp: 1, value: 12.5 },
+ { timestamp: 2, value: 14.5 },
+ { timestamp: 3, value: 13 }
+ ]
+ }
+});
+// REMOVE_END
+
+// STEP_START create_compaction
+const res46 = await client.ts.create('hyg:1');
+console.log(res46); // >>> OK
+
+const res47 = await client.ts.create('hyg:compacted');
+console.log(res47); // >>> OK
+
+const res48 = await client.ts.createRule('hyg:1', 'hyg:compacted', TIME_SERIES_AGGREGATION_TYPE.MIN, 3);
+console.log(res48); // >>> OK
+
+const res49 = await client.ts.info('hyg:1');
+console.log(res49.rules);
+// >>> [{ aggregationType: 'MIN', key: 'hyg:compacted', timeBucket: 3}]
+
+const res50 = await client.ts.info('hyg:compacted');
+console.log(res50.sourceKey); // >>> 'hyg:1'
+// STEP_END
+// REMOVE_START
+assert.equal(res46, 'OK');
+assert.equal(res47, 'OK');
+assert.equal(res48, 'OK');
+assert.deepEqual(res49.rules, [
+ { aggregationType: 'MIN', key: 'hyg:compacted', timeBucket: 3}
+]);
+assert.equal(res50.sourceKey, 'hyg:1');
+// REMOVE_END
+
+// STEP_START comp_add
+const res51 = await client.ts.mAdd([
+ { key: 'hyg:1', timestamp: 0, value: 75 },
+ { key: 'hyg:1', timestamp: 1, value: 77 },
+ { key: 'hyg:1', timestamp: 2, value: 78 }
+]);
+console.log(res51); // >>> [0, 1, 2]
+
+const res52 = await client.ts.range('hyg:compacted', '-', '+');
+console.log(res52); // >>> []
+
+const res53 = await client.ts.add('hyg:1', 3, 79);
+console.log(res53); // >>> 3
+
+const res54 = await client.ts.range('hyg:compacted', '-', '+');
+console.log(res54); // >>> [{ timestamp: 0, value: 75 }]
+// STEP_END
+// REMOVE_START
+assert.deepEqual(res51, [0, 1, 2]);
+assert.deepEqual(res52, []);
+assert.equal(res53, 3);
+assert.deepEqual(res54, [{ timestamp: 0, value: 75 }]);
+// REMOVE_END
+
+// STEP_START del
+const res55 = await client.ts.info('thermometer:1');
+console.log(res55.totalSamples); // >>> 2
+console.log(res55.firstTimestamp); // >>> 1
+console.log(res55.lastTimestamp); // >>> 2
+
+const res56 = await client.ts.add('thermometer:1', 3, 9.7);
+console.log(res56); // >>> 3
+
+const res57 = await client.ts.info('thermometer:1');
+console.log(res57.totalSamples); // >>> 3
+console.log(res57.firstTimestamp); // >>> 1
+console.log(res57.lastTimestamp); // >>> 3
+
+const res58 = await client.ts.del('thermometer:1', 1, 2);
+console.log(res58); // >>> 2
+
+const res59 = await client.ts.info('thermometer:1');
+console.log(res59.totalSamples); // >>> 1
+console.log(res59.firstTimestamp); // >>> 3
+console.log(res59.lastTimestamp); // >>> 3
+
+const res60 = await client.ts.del('thermometer:1', 3, 3);
+console.log(res60); // >>> 1
+
+const res61 = await client.ts.info('thermometer:1');
+console.log(res61.totalSamples); // >>> 0
+// STEP_END
+// REMOVE_START
+assert.equal(res55.totalSamples, 2);
+assert.equal(res55.firstTimestamp, 1);
+assert.equal(res55.lastTimestamp, 2);
+assert.equal(res56, 3);
+assert.equal(res57.totalSamples, 3);
+assert.equal(res57.firstTimestamp, 1);
+assert.equal(res57.lastTimestamp, 3);
+assert.equal(res58, 2);
+assert.equal(res59.totalSamples, 1);
+assert.equal(res59.firstTimestamp, 3);
+assert.equal(res59.lastTimestamp, 3);
+assert.equal(res60, 1);
+assert.equal(res61.totalSamples, 0);
+// REMOVE_END
+
+// HIDE_START
+await client.quit();
+// HIDE_END
\ No newline at end of file
diff --git a/doctests/dt-topk.js b/doctests/dt-topk.js
new file mode 100644
index 00000000000..49b929aed8a
--- /dev/null
+++ b/doctests/dt-topk.js
@@ -0,0 +1,48 @@
+// EXAMPLE: topk_tutorial
+// HIDE_START
+import assert from 'assert';
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.flushDb();
+// REMOVE_END
+
+// STEP_START topk
+const res1 = await client.topK.reserve('bikes:keywords', 5, {
+ width: 2000,
+ depth: 7,
+ decay: 0.925
+});
+console.log(res1); // >>> OK
+
+const res2 = await client.topK.add('bikes:keywords', [
+ 'store',
+ 'seat',
+ 'handlebars',
+ 'handles',
+ 'pedals',
+ 'tires',
+ 'store',
+ 'seat'
+]);
+console.log(res2); // >>> [null, null, null, null, null, 'handlebars', null, null]
+
+const res3 = await client.topK.list('bikes:keywords');
+console.log(res3); // >>> ['store', 'seat', 'pedals', 'tires', 'handles']
+
+const res4 = await client.topK.query('bikes:keywords', ['store', 'handlebars']);
+console.log(res4); // >>> [true, false]
+// STEP_END
+
+// REMOVE_START
+assert.equal(res1, 'OK')
+assert.deepEqual(res2, [null, null, null, null, null, 'handlebars', null, null])
+assert.deepEqual(res3, ['store', 'seat', 'pedals', 'tires', 'handles'])
+assert.deepEqual(res4, [1, 0])
+await client.close();
+// REMOVE_END
+
diff --git a/doctests/dt-vec-set.js b/doctests/dt-vec-set.js
new file mode 100644
index 00000000000..0e8cb918d7e
--- /dev/null
+++ b/doctests/dt-vec-set.js
@@ -0,0 +1,281 @@
+// EXAMPLE: vecset_tutorial
+// REMOVE_START
+/**
+ * Code samples for Vector set doc pages:
+ * https://redis.io/docs/latest/develop/data-types/vector-sets/
+ */
+
+import assert from 'assert';
+// REMOVE_END
+// HIDE_START
+import { createClient } from 'redis';
+
+const client = createClient({
+ RESP: 3 // Required for vector set commands
+});
+
+await client.connect();
+// HIDE_END
+
+// REMOVE_START
+await client.del([
+ "points", "quantSetQ8", "quantSetNoQ",
+ "quantSetBin", "setNotReduced", "setReduced"
+]);
+// REMOVE_END
+
+// STEP_START vadd
+const res1 = await client.vAdd("points", [1.0, 1.0], "pt:A");
+console.log(res1); // >>> true
+
+const res2 = await client.vAdd("points", [-1.0, -1.0], "pt:B");
+console.log(res2); // >>> true
+
+const res3 = await client.vAdd("points", [-1.0, 1.0], "pt:C");
+console.log(res3); // >>> true
+
+const res4 = await client.vAdd("points", [1.0, -1.0], "pt:D");
+console.log(res4); // >>> true
+
+const res5 = await client.vAdd("points", [1.0, 0], "pt:E");
+console.log(res5); // >>> true
+
+const res6 = await client.type("points");
+console.log(res6); // >>> vectorset
+// STEP_END
+// REMOVE_START
+assert.equal(res1, true);
+assert.equal(res2, true);
+assert.equal(res3, true);
+assert.equal(res4, true);
+assert.equal(res5, true);
+assert.equal(res6, "vectorset");
+// REMOVE_END
+
+// STEP_START vcardvdim
+const res7 = await client.vCard("points");
+console.log(res7); // >>> 5
+
+const res8 = await client.vDim("points");
+console.log(res8); // >>> 2
+// STEP_END
+// REMOVE_START
+assert.equal(res7, 5);
+assert.equal(res8, 2);
+// REMOVE_END
+
+// STEP_START vemb
+const res9 = await client.vEmb("points", "pt:A");
+console.log(res9); // >>> [0.9999999403953552, 0.9999999403953552]
+
+const res10 = await client.vEmb("points", "pt:B");
+console.log(res10); // >>> [-0.9999999403953552, -0.9999999403953552]
+
+const res11 = await client.vEmb("points", "pt:C");
+console.log(res11); // >>> [-0.9999999403953552, 0.9999999403953552]
+
+const res12 = await client.vEmb("points", "pt:D");
+console.log(res12); // >>> [0.9999999403953552, -0.9999999403953552]
+
+const res13 = await client.vEmb("points", "pt:E");
+console.log(res13); // >>> [1, 0]
+// STEP_END
+// REMOVE_START
+assert(Math.abs(1 - res9[0]) < 0.001);
+assert(Math.abs(1 - res9[1]) < 0.001);
+assert(Math.abs(1 + res10[0]) < 0.001);
+assert(Math.abs(1 + res10[1]) < 0.001);
+assert(Math.abs(1 + res11[0]) < 0.001);
+assert(Math.abs(1 - res11[1]) < 0.001);
+assert(Math.abs(1 - res12[0]) < 0.001);
+assert(Math.abs(1 + res12[1]) < 0.001);
+assert.deepEqual(res13, [1, 0]);
+// REMOVE_END
+
+// STEP_START attr
+const res14 = await client.vSetAttr("points", "pt:A", {
+ name: "Point A",
+ description: "First point added"
+});
+console.log(res14); // >>> true
+
+const res15 = await client.vGetAttr("points", "pt:A");
+console.log(res15);
+// >>> {name: 'Point A', description: 'First point added'}
+
+const res16 = await client.vSetAttr("points", "pt:A", "");
+console.log(res16); // >>> true
+
+const res17 = await client.vGetAttr("points", "pt:A");
+console.log(res17); // >>> null
+// STEP_END
+// REMOVE_START
+assert.equal(res14, true);
+assert.deepEqual(res15, {name: "Point A", description: "First point added"});
+assert.equal(res16, true);
+assert.equal(res17, null);
+// REMOVE_END
+
+// STEP_START vrem
+const res18 = await client.vAdd("points", [0, 0], "pt:F");
+console.log(res18); // >>> true
+
+const res19 = await client.vCard("points");
+console.log(res19); // >>> 6
+
+const res20 = await client.vRem("points", "pt:F");
+console.log(res20); // >>> true
+
+const res21 = await client.vCard("points");
+console.log(res21); // >>> 5
+// STEP_END
+// REMOVE_START
+assert.equal(res18, true);
+assert.equal(res19, 6);
+assert.equal(res20, true);
+assert.equal(res21, 5);
+// REMOVE_END
+
+// STEP_START vsim_basic
+const res22 = await client.vSim("points", [0.9, 0.1]);
+console.log(res22);
+// >>> ['pt:E', 'pt:A', 'pt:D', 'pt:C', 'pt:B']
+// STEP_END
+// REMOVE_START
+assert.deepEqual(res22, ["pt:E", "pt:A", "pt:D", "pt:C", "pt:B"]);
+// REMOVE_END
+
+// STEP_START vsim_options
+const res23 = await client.vSimWithScores("points", "pt:A", { COUNT: 4 });
+console.log(res23);
+// >>> {pt:A: 1.0, pt:E: 0.8535534143447876, pt:D: 0.5, pt:C: 0.5}
+// STEP_END
+// REMOVE_START
+assert.equal(res23["pt:A"], 1.0);
+assert.equal(res23["pt:C"], 0.5);
+assert.equal(res23["pt:D"], 0.5);
+assert(Math.abs(res23["pt:E"] - 0.85) < 0.005);
+// REMOVE_END
+
+// STEP_START vsim_filter
+const res24 = await client.vSetAttr("points", "pt:A", {
+ size: "large",
+ price: 18.99
+});
+console.log(res24); // >>> true
+
+const res25 = await client.vSetAttr("points", "pt:B", {
+ size: "large",
+ price: 35.99
+});
+console.log(res25); // >>> true
+
+const res26 = await client.vSetAttr("points", "pt:C", {
+ size: "large",
+ price: 25.99
+});
+console.log(res26); // >>> true
+
+const res27 = await client.vSetAttr("points", "pt:D", {
+ size: "small",
+ price: 21.00
+});
+console.log(res27); // >>> true
+
+const res28 = await client.vSetAttr("points", "pt:E", {
+ size: "small",
+ price: 17.75
+});
+console.log(res28); // >>> true
+
+// Return elements in order of distance from point A whose
+// `size` attribute is `large`.
+const res29 = await client.vSim("points", "pt:A", {
+ FILTER: '.size == "large"'
+});
+console.log(res29); // >>> ['pt:A', 'pt:C', 'pt:B']
+
+// Return elements in order of distance from point A whose size is
+// `large` and whose price is greater than 20.00.
+const res30 = await client.vSim("points", "pt:A", {
+ FILTER: '.size == "large" && .price > 20.00'
+});
+console.log(res30); // >>> ['pt:C', 'pt:B']
+// STEP_END
+// REMOVE_START
+assert.equal(res24, true);
+assert.equal(res25, true);
+assert.equal(res26, true);
+assert.equal(res27, true);
+assert.equal(res28, true);
+assert.deepEqual(res29, ['pt:A', 'pt:C', 'pt:B']);
+assert.deepEqual(res30, ['pt:C', 'pt:B']);
+// REMOVE_END
+
+// STEP_START add_quant
+const res31 = await client.vAdd("quantSetQ8", [1.262185, 1.958231], "quantElement", {
+ QUANT: 'Q8'
+});
+console.log(res31); // >>> true
+
+const res32 = await client.vEmb("quantSetQ8", "quantElement");
+console.log(`Q8: ${res32}`);
+// >>> Q8: [1.2643694877624512, 1.958230972290039]
+
+const res33 = await client.vAdd("quantSetNoQ", [1.262185, 1.958231], "quantElement", {
+ QUANT: 'NOQUANT'
+});
+console.log(res33); // >>> true
+
+const res34 = await client.vEmb("quantSetNoQ", "quantElement");
+console.log(`NOQUANT: ${res34}`);
+// >>> NOQUANT: [1.262184977531433, 1.958230972290039]
+
+const res35 = await client.vAdd("quantSetBin", [1.262185, 1.958231], "quantElement", {
+ QUANT: 'BIN'
+});
+console.log(res35); // >>> true
+
+const res36 = await client.vEmb("quantSetBin", "quantElement");
+console.log(`BIN: ${res36}`);
+// >>> BIN: [1, 1]
+// STEP_END
+// REMOVE_START
+assert.equal(res31, true);
+assert(Math.abs(res32[0] - 1.2643694877624512) < 0.001);
+assert(Math.abs(res32[1] - 1.958230972290039) < 0.001);
+assert.equal(res33, true);
+assert(Math.abs(res34[0] - 1.262184977531433) < 0.001);
+assert(Math.abs(res34[1] - 1.958230972290039) < 0.001);
+assert.equal(res35, true);
+assert.deepEqual(res36, [1, 1]);
+// REMOVE_END
+
+// STEP_START add_reduce
+// Create a list of 300 arbitrary values.
+const values = Array.from({length: 300}, (_, x) => x / 299);
+
+const res37 = await client.vAdd("setNotReduced", values, "element");
+console.log(res37); // >>> true
+
+const res38 = await client.vDim("setNotReduced");
+console.log(res38); // >>> 300
+
+const res39 = await client.vAdd("setReduced", values, "element", {
+ REDUCE: 100
+});
+console.log(res39); // >>> true
+
+const res40 = await client.vDim("setReduced");
+console.log(res40); // >>> 100
+// STEP_END
+// REMOVE_START
+assert.equal(res37, true);
+assert.equal(res38, 300);
+assert.equal(res39, true);
+assert.equal(res40, 100);
+// REMOVE_END
+
+// HIDE_START
+await client.quit();
+// HIDE_END
diff --git a/doctests/package-lock.json b/doctests/package-lock.json
new file mode 100644
index 00000000000..2f30678e529
--- /dev/null
+++ b/doctests/package-lock.json
@@ -0,0 +1,889 @@
+{
+ "name": "node-redis-doctests",
+ "version": "1.0.0",
+ "lockfileVersion": 3,
+ "requires": true,
+ "packages": {
+ "": {
+ "name": "node-redis-doctests",
+ "version": "1.0.0",
+ "dependencies": {
+ "@xenova/transformers": "^2.17.2",
+ "redis": "file:/packages/redis"
+ }
+ },
+ "..": {
+ "name": "redis-monorepo",
+ "extraneous": true,
+ "workspaces": [
+ "./packages/client",
+ "./packages/test-utils",
+ "./packages/bloom",
+ "./packages/json",
+ "./packages/search",
+ "./packages/time-series",
+ "./packages/entraid",
+ "./packages/redis"
+ ],
+ "devDependencies": {
+ "@istanbuljs/nyc-config-typescript": "^1.0.2",
+ "@release-it/bumper": "^7.0.5",
+ "@types/mocha": "^10.0.6",
+ "@types/node": "^20.11.16",
+ "gh-pages": "^6.1.1",
+ "mocha": "^10.2.0",
+ "nyc": "^15.1.0",
+ "release-it": "^19.0.2",
+ "ts-node": "^10.9.2",
+ "tsx": "^4.7.0",
+ "typedoc": "^0.25.7",
+ "typescript": "^5.3.3"
+ }
+ },
+ "../../../../../packages/redis": {},
+ "node_modules/@huggingface/jinja": {
+ "version": "0.2.2",
+ "resolved": "https://registry.npmjs.org/@huggingface/jinja/-/jinja-0.2.2.tgz",
+ "integrity": "sha512-/KPde26khDUIPkTGU82jdtTW9UAuvUTumCAbFs/7giR0SxsvZC4hru51PBvpijH6BVkHcROcvZM/lpy5h1jRRA==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@protobufjs/aspromise": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/@protobufjs/aspromise/-/aspromise-1.1.2.tgz",
+ "integrity": "sha512-j+gKExEuLmKwvz3OgROXtrJ2UG2x8Ch2YZUxahh+s1F2HZ+wAceUNLkvy6zKCPVRkU++ZWQrdxsUeQXmcg4uoQ==",
+ "license": "BSD-3-Clause"
+ },
+ "node_modules/@protobufjs/base64": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/@protobufjs/base64/-/base64-1.1.2.tgz",
+ "integrity": "sha512-AZkcAA5vnN/v4PDqKyMR5lx7hZttPDgClv83E//FMNhR2TMcLUhfRUBHCmSl0oi9zMgDDqRUJkSxO3wm85+XLg==",
+ "license": "BSD-3-Clause"
+ },
+ "node_modules/@protobufjs/codegen": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/@protobufjs/codegen/-/codegen-2.0.4.tgz",
+ "integrity": "sha512-YyFaikqM5sH0ziFZCN3xDC7zeGaB/d0IUb9CATugHWbd1FRFwWwt4ld4OYMPWu5a3Xe01mGAULCdqhMlPl29Jg==",
+ "license": "BSD-3-Clause"
+ },
+ "node_modules/@protobufjs/eventemitter": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/@protobufjs/eventemitter/-/eventemitter-1.1.0.tgz",
+ "integrity": "sha512-j9ednRT81vYJ9OfVuXG6ERSTdEL1xVsNgqpkxMsbIabzSo3goCjDIveeGv5d03om39ML71RdmrGNjG5SReBP/Q==",
+ "license": "BSD-3-Clause"
+ },
+ "node_modules/@protobufjs/fetch": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/@protobufjs/fetch/-/fetch-1.1.0.tgz",
+ "integrity": "sha512-lljVXpqXebpsijW71PZaCYeIcE5on1w5DlQy5WH6GLbFryLUrBD4932W/E2BSpfRJWseIL4v/KPgBFxDOIdKpQ==",
+ "license": "BSD-3-Clause",
+ "dependencies": {
+ "@protobufjs/aspromise": "^1.1.1",
+ "@protobufjs/inquire": "^1.1.0"
+ }
+ },
+ "node_modules/@protobufjs/float": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/@protobufjs/float/-/float-1.0.2.tgz",
+ "integrity": "sha512-Ddb+kVXlXst9d+R9PfTIxh1EdNkgoRe5tOX6t01f1lYWOvJnSPDBlG241QLzcyPdoNTsblLUdujGSE4RzrTZGQ==",
+ "license": "BSD-3-Clause"
+ },
+ "node_modules/@protobufjs/inquire": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/@protobufjs/inquire/-/inquire-1.1.0.tgz",
+ "integrity": "sha512-kdSefcPdruJiFMVSbn801t4vFK7KB/5gd2fYvrxhuJYg8ILrmn9SKSX2tZdV6V+ksulWqS7aXjBcRXl3wHoD9Q==",
+ "license": "BSD-3-Clause"
+ },
+ "node_modules/@protobufjs/path": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/@protobufjs/path/-/path-1.1.2.tgz",
+ "integrity": "sha512-6JOcJ5Tm08dOHAbdR3GrvP+yUUfkjG5ePsHYczMFLq3ZmMkAD98cDgcT2iA1lJ9NVwFd4tH/iSSoe44YWkltEA==",
+ "license": "BSD-3-Clause"
+ },
+ "node_modules/@protobufjs/pool": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/@protobufjs/pool/-/pool-1.1.0.tgz",
+ "integrity": "sha512-0kELaGSIDBKvcgS4zkjz1PeddatrjYcmMWOlAuAPwAeccUrPHdUqo/J6LiymHHEiJT5NrF1UVwxY14f+fy4WQw==",
+ "license": "BSD-3-Clause"
+ },
+ "node_modules/@protobufjs/utf8": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/@protobufjs/utf8/-/utf8-1.1.0.tgz",
+ "integrity": "sha512-Vvn3zZrhQZkkBE8LSuW3em98c0FwgO4nxzv6OdSxPKJIEKY2bGbHn+mhGIPerzI4twdxaP8/0+06HBpwf345Lw==",
+ "license": "BSD-3-Clause"
+ },
+ "node_modules/@types/long": {
+ "version": "4.0.2",
+ "resolved": "https://registry.npmjs.org/@types/long/-/long-4.0.2.tgz",
+ "integrity": "sha512-MqTGEo5bj5t157U6fA/BiDynNkn0YknVdh48CMPkTSpFTVmvao5UQmm7uEF6xBEo7qIMAlY/JSleYaE6VOdpaA==",
+ "license": "MIT"
+ },
+ "node_modules/@types/node": {
+ "version": "24.0.10",
+ "resolved": "https://registry.npmjs.org/@types/node/-/node-24.0.10.tgz",
+ "integrity": "sha512-ENHwaH+JIRTDIEEbDK6QSQntAYGtbvdDXnMXnZaZ6k13Du1dPMmprkEHIL7ok2Wl2aZevetwTAb5S+7yIF+enA==",
+ "license": "MIT",
+ "dependencies": {
+ "undici-types": "~7.8.0"
+ }
+ },
+ "node_modules/@xenova/transformers": {
+ "version": "2.17.2",
+ "resolved": "https://registry.npmjs.org/@xenova/transformers/-/transformers-2.17.2.tgz",
+ "integrity": "sha512-lZmHqzrVIkSvZdKZEx7IYY51TK0WDrC8eR0c5IMnBsO8di8are1zzw8BlLhyO2TklZKLN5UffNGs1IJwT6oOqQ==",
+ "license": "Apache-2.0",
+ "dependencies": {
+ "@huggingface/jinja": "^0.2.2",
+ "onnxruntime-web": "1.14.0",
+ "sharp": "^0.32.0"
+ },
+ "optionalDependencies": {
+ "onnxruntime-node": "1.14.0"
+ }
+ },
+ "node_modules/b4a": {
+ "version": "1.6.7",
+ "resolved": "https://registry.npmjs.org/b4a/-/b4a-1.6.7.tgz",
+ "integrity": "sha512-OnAYlL5b7LEkALw87fUVafQw5rVR9RjwGd4KUwNQ6DrrNmaVaUCgLipfVlzrPQ4tWOR9P0IXGNOx50jYCCdSJg==",
+ "license": "Apache-2.0"
+ },
+ "node_modules/bare-events": {
+ "version": "2.5.4",
+ "resolved": "https://registry.npmjs.org/bare-events/-/bare-events-2.5.4.tgz",
+ "integrity": "sha512-+gFfDkR8pj4/TrWCGUGWmJIkBwuxPS5F+a5yWjOHQt2hHvNZd5YLzadjmDUtFmMM4y429bnKLa8bYBMHcYdnQA==",
+ "license": "Apache-2.0",
+ "optional": true
+ },
+ "node_modules/bare-fs": {
+ "version": "4.1.6",
+ "resolved": "https://registry.npmjs.org/bare-fs/-/bare-fs-4.1.6.tgz",
+ "integrity": "sha512-25RsLF33BqooOEFNdMcEhMpJy8EoR88zSMrnOQOaM3USnOK2VmaJ1uaQEwPA6AQjrv1lXChScosN6CzbwbO9OQ==",
+ "license": "Apache-2.0",
+ "optional": true,
+ "dependencies": {
+ "bare-events": "^2.5.4",
+ "bare-path": "^3.0.0",
+ "bare-stream": "^2.6.4"
+ },
+ "engines": {
+ "bare": ">=1.16.0"
+ },
+ "peerDependencies": {
+ "bare-buffer": "*"
+ },
+ "peerDependenciesMeta": {
+ "bare-buffer": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/bare-os": {
+ "version": "3.6.1",
+ "resolved": "https://registry.npmjs.org/bare-os/-/bare-os-3.6.1.tgz",
+ "integrity": "sha512-uaIjxokhFidJP+bmmvKSgiMzj2sV5GPHaZVAIktcxcpCyBFFWO+YlikVAdhmUo2vYFvFhOXIAlldqV29L8126g==",
+ "license": "Apache-2.0",
+ "optional": true,
+ "engines": {
+ "bare": ">=1.14.0"
+ }
+ },
+ "node_modules/bare-path": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/bare-path/-/bare-path-3.0.0.tgz",
+ "integrity": "sha512-tyfW2cQcB5NN8Saijrhqn0Zh7AnFNsnczRcuWODH0eYAXBsJ5gVxAUuNr7tsHSC6IZ77cA0SitzT+s47kot8Mw==",
+ "license": "Apache-2.0",
+ "optional": true,
+ "dependencies": {
+ "bare-os": "^3.0.1"
+ }
+ },
+ "node_modules/bare-stream": {
+ "version": "2.6.5",
+ "resolved": "https://registry.npmjs.org/bare-stream/-/bare-stream-2.6.5.tgz",
+ "integrity": "sha512-jSmxKJNJmHySi6hC42zlZnq00rga4jjxcgNZjY9N5WlOe/iOoGRtdwGsHzQv2RlH2KOYMwGUXhf2zXd32BA9RA==",
+ "license": "Apache-2.0",
+ "optional": true,
+ "dependencies": {
+ "streamx": "^2.21.0"
+ },
+ "peerDependencies": {
+ "bare-buffer": "*",
+ "bare-events": "*"
+ },
+ "peerDependenciesMeta": {
+ "bare-buffer": {
+ "optional": true
+ },
+ "bare-events": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/base64-js": {
+ "version": "1.5.1",
+ "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz",
+ "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "license": "MIT"
+ },
+ "node_modules/bl": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/bl/-/bl-4.1.0.tgz",
+ "integrity": "sha512-1W07cM9gS6DcLperZfFSj+bWLtaPGSOHWhPiGzXmvVJbRLdG82sH/Kn8EtW1VqWVA54AKf2h5k5BbnIbwF3h6w==",
+ "license": "MIT",
+ "dependencies": {
+ "buffer": "^5.5.0",
+ "inherits": "^2.0.4",
+ "readable-stream": "^3.4.0"
+ }
+ },
+ "node_modules/buffer": {
+ "version": "5.7.1",
+ "resolved": "https://registry.npmjs.org/buffer/-/buffer-5.7.1.tgz",
+ "integrity": "sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "license": "MIT",
+ "dependencies": {
+ "base64-js": "^1.3.1",
+ "ieee754": "^1.1.13"
+ }
+ },
+ "node_modules/chownr": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/chownr/-/chownr-1.1.4.tgz",
+ "integrity": "sha512-jJ0bqzaylmJtVnNgzTeSOs8DPavpbYgEr/b0YL8/2GO3xJEhInFmhKMUnEJQjZumK7KXGFhUy89PrsJWlakBVg==",
+ "license": "ISC"
+ },
+ "node_modules/color": {
+ "version": "4.2.3",
+ "resolved": "https://registry.npmjs.org/color/-/color-4.2.3.tgz",
+ "integrity": "sha512-1rXeuUUiGGrykh+CeBdu5Ie7OJwinCgQY0bc7GCRxy5xVHy+moaqkpL/jqQq0MtQOeYcrqEz4abc5f0KtU7W4A==",
+ "license": "MIT",
+ "dependencies": {
+ "color-convert": "^2.0.1",
+ "color-string": "^1.9.0"
+ },
+ "engines": {
+ "node": ">=12.5.0"
+ }
+ },
+ "node_modules/color-convert": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
+ "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
+ "license": "MIT",
+ "dependencies": {
+ "color-name": "~1.1.4"
+ },
+ "engines": {
+ "node": ">=7.0.0"
+ }
+ },
+ "node_modules/color-name": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
+ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==",
+ "license": "MIT"
+ },
+ "node_modules/color-string": {
+ "version": "1.9.1",
+ "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.9.1.tgz",
+ "integrity": "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg==",
+ "license": "MIT",
+ "dependencies": {
+ "color-name": "^1.0.0",
+ "simple-swizzle": "^0.2.2"
+ }
+ },
+ "node_modules/decompress-response": {
+ "version": "6.0.0",
+ "resolved": "https://registry.npmjs.org/decompress-response/-/decompress-response-6.0.0.tgz",
+ "integrity": "sha512-aW35yZM6Bb/4oJlZncMH2LCoZtJXTRxES17vE3hoRiowU2kWHaJKFkSBDnDR+cm9J+9QhXmREyIfv0pji9ejCQ==",
+ "license": "MIT",
+ "dependencies": {
+ "mimic-response": "^3.1.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/deep-extend": {
+ "version": "0.6.0",
+ "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz",
+ "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=4.0.0"
+ }
+ },
+ "node_modules/detect-libc": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-2.0.4.tgz",
+ "integrity": "sha512-3UDv+G9CsCKO1WKMGw9fwq/SWJYbI0c5Y7LU1AXYoDdbhE2AHQ6N6Nb34sG8Fj7T5APy8qXDCKuuIHd1BR0tVA==",
+ "license": "Apache-2.0",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/end-of-stream": {
+ "version": "1.4.5",
+ "resolved": "https://registry.npmjs.org/end-of-stream/-/end-of-stream-1.4.5.tgz",
+ "integrity": "sha512-ooEGc6HP26xXq/N+GCGOT0JKCLDGrq2bQUZrQ7gyrJiZANJ/8YDTxTpQBXGMn+WbIQXNVpyWymm7KYVICQnyOg==",
+ "license": "MIT",
+ "dependencies": {
+ "once": "^1.4.0"
+ }
+ },
+ "node_modules/expand-template": {
+ "version": "2.0.3",
+ "resolved": "https://registry.npmjs.org/expand-template/-/expand-template-2.0.3.tgz",
+ "integrity": "sha512-XYfuKMvj4O35f/pOXLObndIRvyQ+/+6AhODh+OKWj9S9498pHHn/IMszH+gt0fBCRWMNfk1ZSp5x3AifmnI2vg==",
+ "license": "(MIT OR WTFPL)",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/fast-fifo": {
+ "version": "1.3.2",
+ "resolved": "https://registry.npmjs.org/fast-fifo/-/fast-fifo-1.3.2.tgz",
+ "integrity": "sha512-/d9sfos4yxzpwkDkuN7k2SqFKtYNmCTzgfEpz82x34IM9/zc8KGxQoXg1liNC/izpRM/MBdt44Nmx41ZWqk+FQ==",
+ "license": "MIT"
+ },
+ "node_modules/flatbuffers": {
+ "version": "1.12.0",
+ "resolved": "https://registry.npmjs.org/flatbuffers/-/flatbuffers-1.12.0.tgz",
+ "integrity": "sha512-c7CZADjRcl6j0PlvFy0ZqXQ67qSEZfrVPynmnL+2zPc+NtMvrF8Y0QceMo7QqnSPc7+uWjUIAbvCQ5WIKlMVdQ==",
+ "license": "SEE LICENSE IN LICENSE.txt"
+ },
+ "node_modules/fs-constants": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/fs-constants/-/fs-constants-1.0.0.tgz",
+ "integrity": "sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow==",
+ "license": "MIT"
+ },
+ "node_modules/github-from-package": {
+ "version": "0.0.0",
+ "resolved": "https://registry.npmjs.org/github-from-package/-/github-from-package-0.0.0.tgz",
+ "integrity": "sha512-SyHy3T1v2NUXn29OsWdxmK6RwHD+vkj3v8en8AOBZ1wBQ/hCAQ5bAQTD02kW4W9tUp/3Qh6J8r9EvntiyCmOOw==",
+ "license": "MIT"
+ },
+ "node_modules/guid-typescript": {
+ "version": "1.0.9",
+ "resolved": "https://registry.npmjs.org/guid-typescript/-/guid-typescript-1.0.9.tgz",
+ "integrity": "sha512-Y8T4vYhEfwJOTbouREvG+3XDsjr8E3kIr7uf+JZ0BYloFsttiHU0WfvANVsR7TxNUJa/WpCnw/Ino/p+DeBhBQ==",
+ "license": "ISC"
+ },
+ "node_modules/ieee754": {
+ "version": "1.2.1",
+ "resolved": "https://registry.npmjs.org/ieee754/-/ieee754-1.2.1.tgz",
+ "integrity": "sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "license": "BSD-3-Clause"
+ },
+ "node_modules/inherits": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz",
+ "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==",
+ "license": "ISC"
+ },
+ "node_modules/ini": {
+ "version": "1.3.8",
+ "resolved": "https://registry.npmjs.org/ini/-/ini-1.3.8.tgz",
+ "integrity": "sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==",
+ "license": "ISC"
+ },
+ "node_modules/is-arrayish": {
+ "version": "0.3.2",
+ "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.3.2.tgz",
+ "integrity": "sha512-eVRqCvVlZbuw3GrM63ovNSNAeA1K16kaR/LRY/92w0zxQ5/1YzwblUX652i4Xs9RwAGjW9d9y6X88t8OaAJfWQ==",
+ "license": "MIT"
+ },
+ "node_modules/long": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/long/-/long-4.0.0.tgz",
+ "integrity": "sha512-XsP+KhQif4bjX1kbuSiySJFNAehNxgLb6hPRGJ9QsUr8ajHkuXGdrHmFUTUUXhDwVX2R5bY4JNZEwbUiMhV+MA==",
+ "license": "Apache-2.0"
+ },
+ "node_modules/mimic-response": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/mimic-response/-/mimic-response-3.1.0.tgz",
+ "integrity": "sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/minimist": {
+ "version": "1.2.8",
+ "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
+ "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==",
+ "license": "MIT",
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/mkdirp-classic": {
+ "version": "0.5.3",
+ "resolved": "https://registry.npmjs.org/mkdirp-classic/-/mkdirp-classic-0.5.3.tgz",
+ "integrity": "sha512-gKLcREMhtuZRwRAfqP3RFW+TK4JqApVBtOIftVgjuABpAtpxhPGaDcfvbhNvD0B8iD1oUr/txX35NjcaY6Ns/A==",
+ "license": "MIT"
+ },
+ "node_modules/napi-build-utils": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/napi-build-utils/-/napi-build-utils-2.0.0.tgz",
+ "integrity": "sha512-GEbrYkbfF7MoNaoh2iGG84Mnf/WZfB0GdGEsM8wz7Expx/LlWf5U8t9nvJKXSp3qr5IsEbK04cBGhol/KwOsWA==",
+ "license": "MIT"
+ },
+ "node_modules/node-abi": {
+ "version": "3.75.0",
+ "resolved": "https://registry.npmjs.org/node-abi/-/node-abi-3.75.0.tgz",
+ "integrity": "sha512-OhYaY5sDsIka7H7AtijtI9jwGYLyl29eQn/W623DiN/MIv5sUqc4g7BIDThX+gb7di9f6xK02nkp8sdfFWZLTg==",
+ "license": "MIT",
+ "dependencies": {
+ "semver": "^7.3.5"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/node-addon-api": {
+ "version": "6.1.0",
+ "resolved": "https://registry.npmjs.org/node-addon-api/-/node-addon-api-6.1.0.tgz",
+ "integrity": "sha512-+eawOlIgy680F0kBzPUNFhMZGtJ1YmqM6l4+Crf4IkImjYrO/mqPwRMh352g23uIaQKFItcQ64I7KMaJxHgAVA==",
+ "license": "MIT"
+ },
+ "node_modules/once": {
+ "version": "1.4.0",
+ "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz",
+ "integrity": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==",
+ "license": "ISC",
+ "dependencies": {
+ "wrappy": "1"
+ }
+ },
+ "node_modules/onnx-proto": {
+ "version": "4.0.4",
+ "resolved": "https://registry.npmjs.org/onnx-proto/-/onnx-proto-4.0.4.tgz",
+ "integrity": "sha512-aldMOB3HRoo6q/phyB6QRQxSt895HNNw82BNyZ2CMh4bjeKv7g/c+VpAFtJuEMVfYLMbRx61hbuqnKceLeDcDA==",
+ "license": "MIT",
+ "dependencies": {
+ "protobufjs": "^6.8.8"
+ }
+ },
+ "node_modules/onnxruntime-common": {
+ "version": "1.14.0",
+ "resolved": "https://registry.npmjs.org/onnxruntime-common/-/onnxruntime-common-1.14.0.tgz",
+ "integrity": "sha512-3LJpegM2iMNRX2wUmtYfeX/ytfOzNwAWKSq1HbRrKc9+uqG/FsEA0bbKZl1btQeZaXhC26l44NWpNUeXPII7Ew==",
+ "license": "MIT"
+ },
+ "node_modules/onnxruntime-node": {
+ "version": "1.14.0",
+ "resolved": "https://registry.npmjs.org/onnxruntime-node/-/onnxruntime-node-1.14.0.tgz",
+ "integrity": "sha512-5ba7TWomIV/9b6NH/1x/8QEeowsb+jBEvFzU6z0T4mNsFwdPqXeFUM7uxC6QeSRkEbWu3qEB0VMjrvzN/0S9+w==",
+ "license": "MIT",
+ "optional": true,
+ "os": [
+ "win32",
+ "darwin",
+ "linux"
+ ],
+ "dependencies": {
+ "onnxruntime-common": "~1.14.0"
+ }
+ },
+ "node_modules/onnxruntime-web": {
+ "version": "1.14.0",
+ "resolved": "https://registry.npmjs.org/onnxruntime-web/-/onnxruntime-web-1.14.0.tgz",
+ "integrity": "sha512-Kcqf43UMfW8mCydVGcX9OMXI2VN17c0p6XvR7IPSZzBf/6lteBzXHvcEVWDPmCKuGombl997HgLqj91F11DzXw==",
+ "license": "MIT",
+ "dependencies": {
+ "flatbuffers": "^1.12.0",
+ "guid-typescript": "^1.0.9",
+ "long": "^4.0.0",
+ "onnx-proto": "^4.0.4",
+ "onnxruntime-common": "~1.14.0",
+ "platform": "^1.3.6"
+ }
+ },
+ "node_modules/platform": {
+ "version": "1.3.6",
+ "resolved": "https://registry.npmjs.org/platform/-/platform-1.3.6.tgz",
+ "integrity": "sha512-fnWVljUchTro6RiCFvCXBbNhJc2NijN7oIQxbwsyL0buWJPG85v81ehlHI9fXrJsMNgTofEoWIQeClKpgxFLrg==",
+ "license": "MIT"
+ },
+ "node_modules/prebuild-install": {
+ "version": "7.1.3",
+ "resolved": "https://registry.npmjs.org/prebuild-install/-/prebuild-install-7.1.3.tgz",
+ "integrity": "sha512-8Mf2cbV7x1cXPUILADGI3wuhfqWvtiLA1iclTDbFRZkgRQS0NqsPZphna9V+HyTEadheuPmjaJMsbzKQFOzLug==",
+ "license": "MIT",
+ "dependencies": {
+ "detect-libc": "^2.0.0",
+ "expand-template": "^2.0.3",
+ "github-from-package": "0.0.0",
+ "minimist": "^1.2.3",
+ "mkdirp-classic": "^0.5.3",
+ "napi-build-utils": "^2.0.0",
+ "node-abi": "^3.3.0",
+ "pump": "^3.0.0",
+ "rc": "^1.2.7",
+ "simple-get": "^4.0.0",
+ "tar-fs": "^2.0.0",
+ "tunnel-agent": "^0.6.0"
+ },
+ "bin": {
+ "prebuild-install": "bin.js"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/prebuild-install/node_modules/tar-fs": {
+ "version": "2.1.3",
+ "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-2.1.3.tgz",
+ "integrity": "sha512-090nwYJDmlhwFwEW3QQl+vaNnxsO2yVsd45eTKRBzSzu+hlb1w2K9inVq5b0ngXuLVqQ4ApvsUHHnu/zQNkWAg==",
+ "license": "MIT",
+ "dependencies": {
+ "chownr": "^1.1.1",
+ "mkdirp-classic": "^0.5.2",
+ "pump": "^3.0.0",
+ "tar-stream": "^2.1.4"
+ }
+ },
+ "node_modules/prebuild-install/node_modules/tar-stream": {
+ "version": "2.2.0",
+ "resolved": "https://registry.npmjs.org/tar-stream/-/tar-stream-2.2.0.tgz",
+ "integrity": "sha512-ujeqbceABgwMZxEJnk2HDY2DlnUZ+9oEcb1KzTVfYHio0UE6dG71n60d8D2I4qNvleWrrXpmjpt7vZeF1LnMZQ==",
+ "license": "MIT",
+ "dependencies": {
+ "bl": "^4.0.3",
+ "end-of-stream": "^1.4.1",
+ "fs-constants": "^1.0.0",
+ "inherits": "^2.0.3",
+ "readable-stream": "^3.1.1"
+ },
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/protobufjs": {
+ "version": "6.11.4",
+ "resolved": "https://registry.npmjs.org/protobufjs/-/protobufjs-6.11.4.tgz",
+ "integrity": "sha512-5kQWPaJHi1WoCpjTGszzQ32PG2F4+wRY6BmAT4Vfw56Q2FZ4YZzK20xUYQH4YkfehY1e6QSICrJquM6xXZNcrw==",
+ "hasInstallScript": true,
+ "license": "BSD-3-Clause",
+ "dependencies": {
+ "@protobufjs/aspromise": "^1.1.2",
+ "@protobufjs/base64": "^1.1.2",
+ "@protobufjs/codegen": "^2.0.4",
+ "@protobufjs/eventemitter": "^1.1.0",
+ "@protobufjs/fetch": "^1.1.0",
+ "@protobufjs/float": "^1.0.2",
+ "@protobufjs/inquire": "^1.1.0",
+ "@protobufjs/path": "^1.1.2",
+ "@protobufjs/pool": "^1.1.0",
+ "@protobufjs/utf8": "^1.1.0",
+ "@types/long": "^4.0.1",
+ "@types/node": ">=13.7.0",
+ "long": "^4.0.0"
+ },
+ "bin": {
+ "pbjs": "bin/pbjs",
+ "pbts": "bin/pbts"
+ }
+ },
+ "node_modules/pump": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/pump/-/pump-3.0.3.tgz",
+ "integrity": "sha512-todwxLMY7/heScKmntwQG8CXVkWUOdYxIvY2s0VWAAMh/nd8SoYiRaKjlr7+iCs984f2P8zvrfWcDDYVb73NfA==",
+ "license": "MIT",
+ "dependencies": {
+ "end-of-stream": "^1.1.0",
+ "once": "^1.3.1"
+ }
+ },
+ "node_modules/rc": {
+ "version": "1.2.8",
+ "resolved": "https://registry.npmjs.org/rc/-/rc-1.2.8.tgz",
+ "integrity": "sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==",
+ "license": "(BSD-2-Clause OR MIT OR Apache-2.0)",
+ "dependencies": {
+ "deep-extend": "^0.6.0",
+ "ini": "~1.3.0",
+ "minimist": "^1.2.0",
+ "strip-json-comments": "~2.0.1"
+ },
+ "bin": {
+ "rc": "cli.js"
+ }
+ },
+ "node_modules/readable-stream": {
+ "version": "3.6.2",
+ "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz",
+ "integrity": "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==",
+ "license": "MIT",
+ "dependencies": {
+ "inherits": "^2.0.3",
+ "string_decoder": "^1.1.1",
+ "util-deprecate": "^1.0.1"
+ },
+ "engines": {
+ "node": ">= 6"
+ }
+ },
+ "node_modules/redis": {
+ "resolved": "../../../../../packages/redis",
+ "link": true
+ },
+ "node_modules/safe-buffer": {
+ "version": "5.2.1",
+ "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz",
+ "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "license": "MIT"
+ },
+ "node_modules/semver": {
+ "version": "7.7.2",
+ "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.2.tgz",
+ "integrity": "sha512-RF0Fw+rO5AMf9MAyaRXI4AV0Ulj5lMHqVxxdSgiVbixSCXoEmmX/jk0CuJw4+3SqroYO9VoUh+HcuJivvtJemA==",
+ "license": "ISC",
+ "bin": {
+ "semver": "bin/semver.js"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/sharp": {
+ "version": "0.32.6",
+ "resolved": "https://registry.npmjs.org/sharp/-/sharp-0.32.6.tgz",
+ "integrity": "sha512-KyLTWwgcR9Oe4d9HwCwNM2l7+J0dUQwn/yf7S0EnTtb0eVS4RxO0eUSvxPtzT4F3SY+C4K6fqdv/DO27sJ/v/w==",
+ "hasInstallScript": true,
+ "license": "Apache-2.0",
+ "dependencies": {
+ "color": "^4.2.3",
+ "detect-libc": "^2.0.2",
+ "node-addon-api": "^6.1.0",
+ "prebuild-install": "^7.1.1",
+ "semver": "^7.5.4",
+ "simple-get": "^4.0.1",
+ "tar-fs": "^3.0.4",
+ "tunnel-agent": "^0.6.0"
+ },
+ "engines": {
+ "node": ">=14.15.0"
+ },
+ "funding": {
+ "url": "https://opencollective.com/libvips"
+ }
+ },
+ "node_modules/simple-concat": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/simple-concat/-/simple-concat-1.0.1.tgz",
+ "integrity": "sha512-cSFtAPtRhljv69IK0hTVZQ+OfE9nePi/rtJmw5UjHeVyVroEqJXP1sFztKUy1qU+xvz3u/sfYJLa947b7nAN2Q==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "license": "MIT"
+ },
+ "node_modules/simple-get": {
+ "version": "4.0.1",
+ "resolved": "https://registry.npmjs.org/simple-get/-/simple-get-4.0.1.tgz",
+ "integrity": "sha512-brv7p5WgH0jmQJr1ZDDfKDOSeWWg+OVypG99A/5vYGPqJ6pxiaHLy8nxtFjBA7oMa01ebA9gfh1uMCFqOuXxvA==",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "license": "MIT",
+ "dependencies": {
+ "decompress-response": "^6.0.0",
+ "once": "^1.3.1",
+ "simple-concat": "^1.0.0"
+ }
+ },
+ "node_modules/simple-swizzle": {
+ "version": "0.2.2",
+ "resolved": "https://registry.npmjs.org/simple-swizzle/-/simple-swizzle-0.2.2.tgz",
+ "integrity": "sha512-JA//kQgZtbuY83m+xT+tXJkmJncGMTFT+C+g2h2R9uxkYIrE2yy9sgmcLhCnw57/WSD+Eh3J97FPEDFnbXnDUg==",
+ "license": "MIT",
+ "dependencies": {
+ "is-arrayish": "^0.3.1"
+ }
+ },
+ "node_modules/streamx": {
+ "version": "2.22.1",
+ "resolved": "https://registry.npmjs.org/streamx/-/streamx-2.22.1.tgz",
+ "integrity": "sha512-znKXEBxfatz2GBNK02kRnCXjV+AA4kjZIUxeWSr3UGirZMJfTE9uiwKHobnbgxWyL/JWro8tTq+vOqAK1/qbSA==",
+ "license": "MIT",
+ "dependencies": {
+ "fast-fifo": "^1.3.2",
+ "text-decoder": "^1.1.0"
+ },
+ "optionalDependencies": {
+ "bare-events": "^2.2.0"
+ }
+ },
+ "node_modules/string_decoder": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz",
+ "integrity": "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==",
+ "license": "MIT",
+ "dependencies": {
+ "safe-buffer": "~5.2.0"
+ }
+ },
+ "node_modules/strip-json-comments": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-2.0.1.tgz",
+ "integrity": "sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/tar-fs": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-3.1.0.tgz",
+ "integrity": "sha512-5Mty5y/sOF1YWj1J6GiBodjlDc05CUR8PKXrsnFAiSG0xA+GHeWLovaZPYUDXkH/1iKRf2+M5+OrRgzC7O9b7w==",
+ "license": "MIT",
+ "dependencies": {
+ "pump": "^3.0.0",
+ "tar-stream": "^3.1.5"
+ },
+ "optionalDependencies": {
+ "bare-fs": "^4.0.1",
+ "bare-path": "^3.0.0"
+ }
+ },
+ "node_modules/tar-stream": {
+ "version": "3.1.7",
+ "resolved": "https://registry.npmjs.org/tar-stream/-/tar-stream-3.1.7.tgz",
+ "integrity": "sha512-qJj60CXt7IU1Ffyc3NJMjh6EkuCFej46zUqJ4J7pqYlThyd9bO0XBTmcOIhSzZJVWfsLks0+nle/j538YAW9RQ==",
+ "license": "MIT",
+ "dependencies": {
+ "b4a": "^1.6.4",
+ "fast-fifo": "^1.2.0",
+ "streamx": "^2.15.0"
+ }
+ },
+ "node_modules/text-decoder": {
+ "version": "1.2.3",
+ "resolved": "https://registry.npmjs.org/text-decoder/-/text-decoder-1.2.3.tgz",
+ "integrity": "sha512-3/o9z3X0X0fTupwsYvR03pJ/DjWuqqrfwBgTQzdWDiQSm9KitAyz/9WqsT2JQW7KV2m+bC2ol/zqpW37NHxLaA==",
+ "license": "Apache-2.0",
+ "dependencies": {
+ "b4a": "^1.6.4"
+ }
+ },
+ "node_modules/tunnel-agent": {
+ "version": "0.6.0",
+ "resolved": "https://registry.npmjs.org/tunnel-agent/-/tunnel-agent-0.6.0.tgz",
+ "integrity": "sha512-McnNiV1l8RYeY8tBgEpuodCC1mLUdbSN+CYBL7kJsJNInOP8UjDDEwdk6Mw60vdLLrr5NHKZhMAOSrR2NZuQ+w==",
+ "license": "Apache-2.0",
+ "dependencies": {
+ "safe-buffer": "^5.0.1"
+ },
+ "engines": {
+ "node": "*"
+ }
+ },
+ "node_modules/undici-types": {
+ "version": "7.8.0",
+ "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.8.0.tgz",
+ "integrity": "sha512-9UJ2xGDvQ43tYyVMpuHlsgApydB8ZKfVYTsLDhXkFL/6gfkp+U8xTGdh8pMJv1SpZna0zxG1DwsKZsreLbXBxw==",
+ "license": "MIT"
+ },
+ "node_modules/util-deprecate": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",
+ "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==",
+ "license": "MIT"
+ },
+ "node_modules/wrappy": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
+ "integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==",
+ "license": "ISC"
+ }
+ }
+}
diff --git a/doctests/package.json b/doctests/package.json
new file mode 100644
index 00000000000..ee07eb44fb8
--- /dev/null
+++ b/doctests/package.json
@@ -0,0 +1,12 @@
+{
+ "name": "node-redis-doctests",
+ "version": "1.0.0",
+ "description": "Code examples for redis.io",
+ "main": "index.js",
+ "private": true,
+ "type": "module",
+ "dependencies": {
+ "redis": "file:/packages/redis",
+ "@xenova/transformers": "^2.17.2"
+ }
+}
diff --git a/doctests/query-agg.js b/doctests/query-agg.js
new file mode 100644
index 00000000000..82d378b86b2
--- /dev/null
+++ b/doctests/query-agg.js
@@ -0,0 +1,139 @@
+// EXAMPLE: query_agg
+// HIDE_START
+import assert from 'node:assert';
+import fs from 'node:fs';
+import { createClient } from 'redis';
+import { SCHEMA_FIELD_TYPE, FT_AGGREGATE_STEPS, FT_AGGREGATE_GROUP_BY_REDUCERS } from '@redis/search';
+
+const client = createClient();
+
+await client.connect().catch(console.error);
+
+// create index
+await client.ft.create('idx:bicycle', {
+ '$.condition': {
+ type: SCHEMA_FIELD_TYPE.TAG,
+ AS: 'condition'
+ },
+ '$.price': {
+ type: SCHEMA_FIELD_TYPE.NUMERIC,
+ AS: 'price'
+ }
+}, {
+ ON: 'JSON',
+ PREFIX: 'bicycle:'
+})
+
+// load data
+const bicycles = JSON.parse(fs.readFileSync('data/query_em.json', 'utf8'));
+
+await Promise.all(
+ bicycles.map((bicycle, bid) => {
+ return client.json.set(`bicycle:${bid}`, '$', bicycle);
+ })
+);
+// HIDE_END
+
+// STEP_START agg1
+const res1 = await client.ft.aggregate('idx:bicycle', '@condition:{new}', {
+ LOAD: ['__key', 'price'],
+ APPLY: {
+ expression: '@price - (@price * 0.1)',
+ AS: 'discounted'
+ }
+});
+
+console.log(res1.results.length); // >>> 5
+console.log(res1.results); // >>>
+//[
+// [Object: null prototype] { __key: 'bicycle:0', price: '270' },
+// [Object: null prototype] { __key: 'bicycle:5', price: '810' },
+// [Object: null prototype] { __key: 'bicycle:6', price: '2300' },
+// [Object: null prototype] { __key: 'bicycle:7', price: '430' },
+// [Object: null prototype] { __key: 'bicycle:8', price: '1200' }
+//]
+// REMOVE_START
+assert.strictEqual(res1.results.length, 5);
+// REMOVE_END
+// STEP_END
+
+// STEP_START agg2
+const res2 = await client.ft.aggregate('idx:bicycle', '*', {
+ LOAD: ['@price'],
+ STEPS: [{
+ type: FT_AGGREGATE_STEPS.APPLY,
+ expression: '@price<1000',
+ AS: 'price_category'
+ },{
+ type: FT_AGGREGATE_STEPS.GROUPBY,
+ properties: '@condition',
+ REDUCE:[{
+ type: FT_AGGREGATE_GROUP_BY_REDUCERS.SUM,
+ property: '@price_category',
+ AS: 'num_affordable'
+ }]
+ }]
+});
+console.log(res2.results.length); // >>> 3
+console.log(res2.results); // >>>
+//[[Object: null prototype] { condition: 'refurbished', num_affordable: '1' },
+// [Object: null prototype] { condition: 'used', num_affordable: '1' },
+// [Object: null prototype] { condition: 'new', num_affordable: '3' }
+//]
+// REMOVE_START
+assert.strictEqual(res2.results.length, 3);
+// REMOVE_END
+// STEP_END
+
+// STEP_START agg3
+const res3 = await client.ft.aggregate('idx:bicycle', '*', {
+ STEPS: [{
+ type: FT_AGGREGATE_STEPS.APPLY,
+ expression: "'bicycle'",
+ AS: 'type'
+ }, {
+ type: FT_AGGREGATE_STEPS.GROUPBY,
+ properties: '@type',
+ REDUCE: [{
+ type: FT_AGGREGATE_GROUP_BY_REDUCERS.COUNT,
+ property: null,
+ AS: 'num_total'
+ }]
+ }]
+});
+console.log(res3.results.length); // >>> 1
+console.log(res3.results); // >>>
+//[ [Object: null prototype] { type: 'bicycle', num_total: '10' } ]
+// REMOVE_START
+assert.strictEqual(res3.results.length, 1);
+// REMOVE_END
+// STEP_END
+
+// STEP_START agg4
+const res4 = await client.ft.aggregate('idx:bicycle', '*', {
+ LOAD: ['__key'],
+ STEPS: [{
+ type: FT_AGGREGATE_STEPS.GROUPBY,
+ properties: '@condition',
+ REDUCE: [{
+ type: FT_AGGREGATE_GROUP_BY_REDUCERS.TOLIST,
+ property: '__key',
+ AS: 'bicycles'
+ }]
+ }]
+});
+console.log(res4.results.length); // >>> 3
+console.log(res4.results); // >>>
+//[[Object: null prototype] {condition: 'refurbished', bicycles: [ 'bicycle:9' ]},
+// [Object: null prototype] {condition: 'used', bicycles: [ 'bicycle:1', 'bicycle:2', 'bicycle:3', 'bicycle:4' ]},
+// [Object: null prototype] {condition: 'new', bicycles: [ 'bicycle:5', 'bicycle:6', 'bicycle:7', 'bicycle:0', 'bicycle:8' ]}]
+// REMOVE_START
+assert.strictEqual(res4.results.length, 3);
+// REMOVE_END
+// STEP_END
+
+// REMOVE_START
+// destroy index and data
+await client.ft.dropIndex('idx:bicycle', { DD: true });
+await client.close();
+// REMOVE_END
\ No newline at end of file
diff --git a/doctests/query-combined.js b/doctests/query-combined.js
new file mode 100644
index 00000000000..a2ad8d43c93
--- /dev/null
+++ b/doctests/query-combined.js
@@ -0,0 +1,191 @@
+// EXAMPLE: query_combined
+// HIDE_START
+import assert from 'node:assert';
+import fs from 'node:fs';
+import { createClient } from 'redis';
+import { SCHEMA_FIELD_TYPE, SCHEMA_VECTOR_FIELD_ALGORITHM } from '@redis/search';
+import { pipeline } from '@xenova/transformers';
+
+function float32Buffer(arr) {
+ const floatArray = new Float32Array(arr);
+ const float32Buffer = Buffer.from(floatArray.buffer);
+ return float32Buffer;
+}
+
+async function embedText(sentence) {
+ let modelName = 'Xenova/all-MiniLM-L6-v2';
+ let pipe = await pipeline('feature-extraction', modelName);
+
+ let vectorOutput = await pipe(sentence, {
+ pooling: 'mean',
+ normalize: true,
+ });
+
+ if (vectorOutput == null) {
+ throw new Error('vectorOutput is undefined');
+ }
+
+ const embedding = Object.values(vectorOutput.data);
+
+ return embedding;
+}
+
+let vector_query = float32Buffer(await embedText('That is a very happy person'));
+
+const client = createClient();
+await client.connect().catch(console.error);
+
+// create index
+await client.ft.create('idx:bicycle', {
+ '$.description': {
+ type: SCHEMA_FIELD_TYPE.TEXT,
+ AS: 'description'
+ },
+ '$.condition': {
+ type: SCHEMA_FIELD_TYPE.TAG,
+ AS: 'condition'
+ },
+ '$.price': {
+ type: SCHEMA_FIELD_TYPE.NUMERIC,
+ AS: 'price'
+ },
+ '$.description_embeddings': {
+ type: SCHEMA_FIELD_TYPE.VECTOR,
+ TYPE: 'FLOAT32',
+ ALGORITHM: SCHEMA_VECTOR_FIELD_ALGORITHM.FLAT,
+ DIM: 384,
+ DISTANCE_METRIC: 'COSINE',
+ AS: 'vector',
+ }
+}, {
+ ON: 'JSON',
+ PREFIX: 'bicycle:'
+});
+
+// load data
+const bicycles = JSON.parse(fs.readFileSync('data/query_vector.json', 'utf8'));
+
+await Promise.all(
+ bicycles.map((bicycle, bid) => {
+ return client.json.set(`bicycle:${bid}`, '$', bicycle);
+ })
+);
+// HIDE_END
+
+// STEP_START combined1
+const res1 = await client.ft.search('idx:bicycle', '@price:[500 1000] @condition:{new}');
+console.log(res1.total); // >>> 1
+console.log(res1); // >>>
+//{
+// total: 1,
+// documents: [ { id: 'bicycle:5', value: [Object: null prototype] } ]
+//}
+// REMOVE_START
+assert.strictEqual(res1.total, 1);
+// REMOVE_END
+// STEP_END
+
+// STEP_START combined2
+const res2 = await client.ft.search('idx:bicycle', 'kids @price:[500 1000] @condition:{used}');
+console.log(res2.total); // >>> 1
+console.log(res2); // >>>
+// {
+// total: 1,
+// documents: [ { id: 'bicycle:2', value: [Object: null prototype] } ]
+// }
+// REMOVE_START
+assert.strictEqual(res2.total, 1);
+// REMOVE_END
+// STEP_END
+
+// STEP_START combined3
+const res3 = await client.ft.search('idx:bicycle', '(kids | small) @condition:{used}');
+console.log(res3.total); // >>> 2
+console.log(res3); // >>>
+//{
+// total: 2,
+// documents: [
+// { id: 'bicycle:2', value: [Object: null prototype] },
+// { id: 'bicycle:1', value: [Object: null prototype] }
+// ]
+//}
+// REMOVE_START
+assert.strictEqual(res3.total, 2);
+// REMOVE_END
+// STEP_END
+
+// STEP_START combined4
+const res4 = await client.ft.search('idx:bicycle', '@description:(kids | small) @condition:{used}');
+console.log(res4.total); // >>> 2
+console.log(res4); // >>>
+//{
+// total: 2,
+// documents: [
+// { id: 'bicycle:2', value: [Object: null prototype] },
+// { id: 'bicycle:1', value: [Object: null prototype] }
+// ]
+//}
+// REMOVE_START
+assert.strictEqual(res4.total, 2);
+// REMOVE_END
+// STEP_END
+
+// STEP_START combined5
+const res5 = await client.ft.search('idx:bicycle', '@description:(kids | small) @condition:{new | used}');
+console.log(res5.total); // >>> 3
+console.log(res5); // >>>
+//{
+// total: 3,
+// documents: [
+// { id: 'bicycle:1', value: [Object: null prototype] },
+// { id: 'bicycle:0', value: [Object: null prototype] },
+// { id: 'bicycle:2', value: [Object: null prototype] }
+// ]
+//}
+// REMOVE_START
+assert.strictEqual(res5.total, 3);
+// REMOVE_END
+// STEP_END
+
+// STEP_START combined6
+const res6 = await client.ft.search('idx:bicycle', '@price:[500 1000] -@condition:{new}');
+console.log(res6.total); // >>> 2
+console.log(res6); // >>>
+//{
+// total: 2,
+// documents: [
+// { id: 'bicycle:2', value: [Object: null prototype] },
+// { id: 'bicycle:9', value: [Object: null prototype] }
+// ]
+//}
+// REMOVE_START
+assert.strictEqual(res6.total, 2);
+// REMOVE_END
+// STEP_END
+
+// STEP_START combined7
+const res7 = await client.ft.search('idx:bicycle',
+ '(@price:[500 1000] -@condition:{new})=>[KNN 3 @vector $query_vector]', {
+ PARAMS: { query_vector: vector_query },
+ DIALECT: 2
+ }
+);
+console.log(res7.total); // >>> 2
+console.log(res7); // >>>
+//{
+// total: 2,
+// documents: [
+// { id: 'bicycle:2', value: [Object: null prototype] },
+// { id: 'bicycle:9', value: [Object: null prototype] }
+// ]
+//}
+// REMOVE_START
+assert.strictEqual(res7.total, 2);
+// REMOVE_END
+// STEP_END
+
+// REMOVE_START
+// destroy index and data
+await client.ft.dropIndex('idx:bicycle', { DD: true });
+await client.close();
+// REMOVE_END
\ No newline at end of file
diff --git a/doctests/query-em.js b/doctests/query-em.js
new file mode 100644
index 00000000000..9b5782e09ce
--- /dev/null
+++ b/doctests/query-em.js
@@ -0,0 +1,121 @@
+// EXAMPLE: query_em
+// HIDE_START
+import assert from 'node:assert';
+import fs from 'node:fs';
+import { createClient, SCHEMA_FIELD_TYPE } from 'redis';
+
+const client = createClient();
+
+await client.connect().catch(console.error);
+
+// create index
+await client.ft.create('idx:bicycle', {
+ '$.description': {
+ type: SCHEMA_FIELD_TYPE.TEXT,
+ AS: 'description'
+ },
+ '$.price': {
+ type: SCHEMA_FIELD_TYPE.NUMERIC,
+ AS: 'price'
+ },
+ '$.condition': {
+ type: SCHEMA_FIELD_TYPE.TAG,
+ AS: 'condition'
+ }
+}, {
+ ON: 'JSON',
+ PREFIX: 'bicycle:'
+})
+
+// load data
+const bicycles = JSON.parse(fs.readFileSync('data/query_em.json', 'utf8'));
+
+await Promise.all(
+ bicycles.map((bicycle, bid) => {
+ return client.json.set(`bicycle:${bid}`, '$', bicycle);
+ })
+);
+// HIDE_END
+
+// STEP_START em1
+const res1 = await client.ft.search('idx:bicycle', '@price:[270 270]');
+console.log(res1.total); // >>> 1
+// REMOVE_START
+assert.strictEqual(res1.total, 1);
+// REMOVE_END
+
+try {
+ const res2 = await client.ft.search('idx:bicycle', '@price:[270]');
+ console.log(res2.total); // >>> 1
+ assert.strictEqual(res2.total, 1);
+} catch (err) {
+ console.log("'@price:[270]' syntax not yet supported.");
+}
+
+try {
+ const res3 = await client.ft.search('idx:bicycle', '@price==270');
+ console.log(res3.total); // >>> 1
+ assert.strictEqual(res3.total, 1);
+} catch (err) {
+ console.log("'@price==270' syntax not yet supported.");
+}
+
+// FILTER is not supported
+// const res4 = await client.ft.search('idx:bicycle', '*', {
+// FILTER: {
+// field: 'price',
+// min: 270,
+// max: 270,
+// }
+// });
+// console.log(res4.total); // >>> 1
+// REMOVE_START
+// assert.strictEqual(res4.total, 10);
+// REMOVE_END
+// STEP_END
+
+// STEP_START em2
+const res5 = await client.ft.search('idx:bicycle', '@condition:{new}');
+console.log(res5.total); // >>> 5
+// REMOVE_START
+assert.strictEqual(res5.total, 5);
+// REMOVE_END
+// STEP_END
+
+// STEP_START em3
+await client.ft.create('idx:email', {
+ '$.email': {
+ type: SCHEMA_FIELD_TYPE.TAG,
+ AS: 'email'
+ }
+}, {
+ ON: 'JSON',
+ PREFIX: 'key:'
+})
+
+await client.json.set('key:1', '$', { email: 'test@redis.com' });
+
+try {
+ const res6 = await client.ft.search('idx:email', 'test@redis.com', { DIALECT: 2 });
+ console.log(res6);
+} catch (err) {
+ console.log("'test@redis.com' syntax not yet supported.");
+}
+// REMOVE_START
+await client.ft.dropIndex('idx:email', { DD: true });
+// REMOVE_END
+// STEP_END
+
+// STEP_START em4
+const res7 = await client.ft.search('idx:bicycle', '@description:"rough terrain"');
+console.log(res7.total); // >>> 1 (Result{1 total, docs: [Document {'id': 'bicycle:8'...)
+// REMOVE_START
+assert.strictEqual(res7.total, 1);
+// REMOVE_END
+// STEP_END
+
+// REMOVE_START
+// destroy index and data
+await client.ft.dropIndex('idx:bicycle', { DD: true });
+await client.close();
+// REMOVE_END
diff --git a/doctests/query-ft.js b/doctests/query-ft.js
new file mode 100644
index 00000000000..a70b2ea3f5d
--- /dev/null
+++ b/doctests/query-ft.js
@@ -0,0 +1,84 @@
+// EXAMPLE: query_ft
+// HIDE_START
+import assert from 'node:assert';
+import fs from 'node:fs';
+import { createClient, SCHEMA_FIELD_TYPE } from 'redis';
+
+const client = createClient();
+
+await client.connect().catch(console.error);
+
+// create index
+await client.ft.create('idx:bicycle', {
+ '$.model': {
+ type: SCHEMA_FIELD_TYPE.TEXT,
+ AS: 'model'
+ },
+ '$.brand': {
+ type: SCHEMA_FIELD_TYPE.TEXT,
+ AS: 'brand'
+ },
+ '$.description': {
+ type: SCHEMA_FIELD_TYPE.TEXT,
+ AS: 'description'
+ }
+}, {
+ ON: 'JSON',
+ PREFIX: 'bicycle:'
+})
+
+// load data
+const bicycles = JSON.parse(fs.readFileSync('data/query_em.json', 'utf8'));
+
+await Promise.all(
+ bicycles.map((bicycle, bid) => {
+ return client.json.set(`bicycle:${bid}`, '$', bicycle);
+ })
+);
+// HIDE_END
+
+// STEP_START ft1
+const res1 = await client.ft.search('idx:bicycle', '@description: kids');
+console.log(res1.total); // >>> 2
+// REMOVE_START
+assert.strictEqual(res1.total, 2);
+// REMOVE_END
+// STEP_END
+
+// STEP_START ft2
+const res2 = await client.ft.search('idx:bicycle', '@model: ka*');
+console.log(res2.total); // >>> 1
+// REMOVE_START
+assert.strictEqual(res2.total, 1);
+// REMOVE_END
+// STEP_END
+
+// STEP_START ft3
+const res3 = await client.ft.search('idx:bicycle', '@brand: *bikes');
+console.log(res3.total); // >>> 2
+// REMOVE_START
+assert.strictEqual(res3.total, 2);
+// REMOVE_END
+// STEP_END
+
+// STEP_START ft4
+const res4 = await client.ft.search('idx:bicycle', '%optamized%');
+console.log(res4); // >>> { total: 1, documents: [ { id: 'bicycle:3', value: [Object: null prototype] } ]}
+// REMOVE_START
+assert.strictEqual(res4.total, 1);
+// REMOVE_END
+// STEP_END
+
+// STEP_START ft5
+const res5 = await client.ft.search('idx:bicycle', '%%optamised%%');
+console.log(res5); // >>> { total: 1, documents: [ { id: 'bicycle:3', value: [Object: null prototype] } ]}
+// REMOVE_START
+assert.strictEqual(res5.total, 1);
+// REMOVE_END
+// STEP_END
+
+// REMOVE_START
+// destroy index and data
+await client.ft.dropIndex('idx:bicycle', { DD: true });
+await client.close();
+// REMOVE_END
\ No newline at end of file
diff --git a/doctests/query-geo.js b/doctests/query-geo.js
new file mode 100644
index 00000000000..41ef2141eb8
--- /dev/null
+++ b/doctests/query-geo.js
@@ -0,0 +1,82 @@
+// EXAMPLE: query_geo
+// HIDE_START
+import assert from 'node:assert';
+import fs from 'node:fs';
+import { createClient } from 'redis';
+import { SCHEMA_FIELD_TYPE } from '@redis/search';
+
+const client = createClient();
+
+await client.connect().catch(console.error);
+
+// create index
+await client.ft.create('idx:bicycle', {
+ '$.store_location': {
+ type: SCHEMA_FIELD_TYPE.GEO,
+ AS: 'store_location'
+ },
+ '$.pickup_zone': {
+ type: SCHEMA_FIELD_TYPE.GEOSHAPE,
+ AS: 'pickup_zone'
+ }
+}, {
+ ON: 'JSON',
+ PREFIX: 'bicycle:'
+})
+
+// load data
+const bicycles = JSON.parse(fs.readFileSync('data/query_em.json', 'utf8'));
+
+await Promise.all(
+ bicycles.map((bicycle, bid) => {
+ return client.json.set(`bicycle:${bid}`, '$', bicycle);
+ })
+);
+// HIDE_END
+
+// STEP_START geo1
+const res1= await client.ft.search('idx:bicycle', '@store_location:[-0.1778 51.5524 20 mi]');
+console.log(res1.total); // >>> 1
+console.log(res1); // >>> {total: 1, documents: [ { id: 'bicycle:5', value: [Object: null prototype] } ]}
+// REMOVE_START
+assert.strictEqual(res1.total, 1);
+// REMOVE_END
+// STEP_END
+
+// STEP_START geo2
+const params_dict_geo2 = { bike: 'POINT(-0.1278 51.5074)' };
+const q_geo2 = '@pickup_zone:[CONTAINS $bike]';
+const res2 = await client.ft.search('idx:bicycle', q_geo2, { PARAMS: params_dict_geo2, DIALECT: 3 });
+console.log(res2.total); // >>> 1
+console.log(res2); // >>> {total: 1, documents: [ { id: 'bicycle:5', value: [Object: null prototype] } ]}
+// REMOVE_START
+assert.strictEqual(res2.total, 1);
+// REMOVE_END
+// STEP_END
+
+// STEP_START geo3
+const params_dict_geo3 = { europe: 'POLYGON((-25 35, 40 35, 40 70, -25 70, -25 35))' };
+const q_geo3 = '@pickup_zone:[WITHIN $europe]';
+const res3 = await client.ft.search('idx:bicycle', q_geo3, { PARAMS: params_dict_geo3, DIALECT: 3 });
+console.log(res3.total); // >>> 5
+console.log(res3); // >>>
+// {
+// total: 5,
+// documents: [
+// { id: 'bicycle:5', value: [Object: null prototype] },
+// { id: 'bicycle:6', value: [Object: null prototype] },
+// { id: 'bicycle:7', value: [Object: null prototype] },
+// { id: 'bicycle:8', value: [Object: null prototype] },
+// { id: 'bicycle:9', value: [Object: null prototype] }
+// ]
+// }
+// REMOVE_START
+assert.strictEqual(res3.total, 5);
+// REMOVE_END
+// STEP_END
+
+// REMOVE_START
+// destroy index and data
+await client.ft.dropIndex('idx:bicycle', { DD: true });
+await client.close();
+// REMOVE_END
\ No newline at end of file
diff --git a/doctests/query-range.js b/doctests/query-range.js
new file mode 100644
index 00000000000..29b269e37b5
--- /dev/null
+++ b/doctests/query-range.js
@@ -0,0 +1,98 @@
+// EXAMPLE: query_range
+// HIDE_START
+import assert from 'node:assert';
+import fs from 'node:fs';
+import { createClient, SCHEMA_FIELD_TYPE,} from 'redis';
+
+const client = createClient();
+
+await client.connect().catch(console.error);
+
+// create index
+await client.ft.create('idx:bicycle', {
+ '$.description': {
+ type: SCHEMA_FIELD_TYPE.TEXT,
+ AS: 'description'
+ },
+ '$.price': {
+ type: SCHEMA_FIELD_TYPE.NUMERIC,
+ AS: 'price'
+ },
+ '$.condition': {
+ type: SCHEMA_FIELD_TYPE.TAG,
+ AS: 'condition'
+ }
+}, {
+ ON: 'JSON',
+ PREFIX: 'bicycle:'
+})
+
+// load data
+const bicycles = JSON.parse(fs.readFileSync('data/query_em.json', 'utf8'));
+
+await Promise.all(
+ bicycles.map((bicycle, bid) => {
+ return client.json.set(`bicycle:${bid}`, '$', bicycle);
+ })
+);
+// HIDE_END
+
+// STEP_START range1
+const res1 = await client.ft.search('idx:bicycle', '@price:[500 1000]');
+console.log(res1.total); // >>> 3
+// REMOVE_START
+assert.strictEqual(res1.total, 3);
+// REMOVE_END
+// STEP_END
+
+// STEP_START range2
+// FILTER is not supported
+// const res2 = await client.ft.search('idx:bicycle', '*', {
+// FILTER: {
+// field: 'price',
+// min: 500,
+// max: 1000,
+// }
+// });
+// console.log(res2.total); // >>> 3
+// REMOVE_START
+// assert.strictEqual(res2.total, 3);
+// REMOVE_END
+// STEP_END
+
+// STEP_START range3
+// FILTER is not supported
+// const res3 = await client.ft.search('idx:bicycle', '*', {
+// FILTER: {
+// field: 'price',
+// min: '(1000',
+// max: '+inf,
+// }
+// });
+// console.log(res3.total); // >>> 5
+// REMOVE_START
+// assert.strictEqual(res3.total, 5);
+// REMOVE_END
+// STEP_END
+
+// STEP_START range4
+const res4 = await client.ft.search(
+ 'idx:bicycle',
+ '@price:[-inf 2000]',
+ {
+ SORTBY: 'price',
+ LIMIT: { from: 0, size: 5 }
+ }
+);
+console.log(res4.total); // >>> 7
+console.log(res4); // >>> { total: 7, documents: [ { id: 'bicycle:0', value: [Object: null prototype] }, { id: 'bicycle:7', value: [Object: null prototype] }, { id: 'bicycle:5', value: [Object: null prototype] }, { id: 'bicycle:2', value: [Object: null prototype] }, { id: 'bicycle:9', value: [Object: null prototype] } ] }
+// REMOVE_START
+assert.strictEqual(res4.total, 7);
+// REMOVE_END
+// STEP_END
+
+// REMOVE_START
+// destroy index and data
+await client.ft.dropIndex('idx:bicycle', { DD: true });
+await client.close();
+// REMOVE_END
\ No newline at end of file
diff --git a/doctests/query-vector.js b/doctests/query-vector.js
new file mode 100644
index 00000000000..91ee63120d3
--- /dev/null
+++ b/doctests/query-vector.js
@@ -0,0 +1,110 @@
+// EXAMPLE: query_vector
+// HIDE_START
+import assert from 'node:assert';
+import fs from 'node:fs';
+import { createClient } from 'redis';
+import { SCHEMA_FIELD_TYPE, SCHEMA_VECTOR_FIELD_ALGORITHM } from '@redis/search';
+import { pipeline } from '@xenova/transformers';
+
+function float32Buffer(arr) {
+ const floatArray = new Float32Array(arr);
+ const float32Buffer = Buffer.from(floatArray.buffer);
+ return float32Buffer;
+}
+
+async function embedText(sentence) {
+ let modelName = 'Xenova/all-MiniLM-L6-v2';
+ let pipe = await pipeline('feature-extraction', modelName);
+
+ let vectorOutput = await pipe(sentence, {
+ pooling: 'mean',
+ normalize: true,
+ });
+
+ const embedding = Object.values(vectorOutput?.data);
+
+ return embedding;
+}
+
+const vector_query = float32Buffer(await embedText('That is a very happy person'));
+
+const client = createClient();
+await client.connect().catch(console.error);
+
+// create index
+await client.ft.create('idx:bicycle', {
+ '$.description': {
+ type: SCHEMA_FIELD_TYPE.TEXT,
+ AS: 'description'
+ },
+ '$.description_embeddings': {
+ type: SCHEMA_FIELD_TYPE.VECTOR,
+ TYPE: 'FLOAT32',
+ ALGORITHM: SCHEMA_VECTOR_FIELD_ALGORITHM.FLAT,
+ DIM: 384,
+ DISTANCE_METRIC: 'COSINE',
+ AS: 'vector'
+ }
+}, {
+ ON: 'JSON',
+ PREFIX: 'bicycle:'
+});
+
+// load data
+const bicycles = JSON.parse(fs.readFileSync('data/query_vector.json', 'utf8'));
+
+await Promise.all(
+ bicycles.map((bicycle, bid) => {
+ return client.json.set(`bicycle:${bid}`, '$', bicycle);
+ })
+);
+// HIDE_END
+
+// STEP_START vector1
+const res1 = await client.ft.search('idx:bicycle',
+ '*=>[KNN 3 @vector $query_vector AS score]', {
+ PARAMS: { query_vector: vector_query },
+ RETURN: ['description'],
+ DIALECT: 2
+ }
+);
+console.log(res1.total); // >>> 3
+console.log(res1); // >>>
+//{
+// total: 3,
+// documents: [
+// { id: 'bicycle:0', value: [Object: null prototype] {} },
+// { id: 'bicycle:2', value: [Object: null prototype] {} },
+// { id: 'bicycle:9', value: [Object: null prototype] {} }
+// ]
+//}
+// REMOVE_START
+assert.strictEqual(res1.total, 3);
+// REMOVE_END
+// STEP_END
+
+// STEP_START vector2
+const res2 = await client.ft.search('idx:bicycle',
+ '@vector:[VECTOR_RANGE 0.9 $query_vector]=>{$YIELD_DISTANCE_AS: vector_dist}', {
+ PARAMS: { query_vector: vector_query },
+ SORTBY: 'vector_dist',
+ RETURN: ['vector_dist', 'description'],
+ DIALECT: 2
+ }
+);
+console.log(res2.total); // >>> 1
+console.log(res2); // >>>
+//{
+// total: 1,
+// documents: [ { id: 'bicycle:0', value: [Object: null prototype] } ]
+//}
+// REMOVE_START
+assert.strictEqual(res2.total, 1);
+// REMOVE_END
+// STEP_END
+
+// REMOVE_START
+// destroy index and data
+await client.ft.dropIndex('idx:bicycle', { DD: true });
+await client.close();
+// REMOVE_END
\ No newline at end of file
diff --git a/doctests/run_examples.sh b/doctests/run_examples.sh
new file mode 100755
index 00000000000..ee7b50dc69a
--- /dev/null
+++ b/doctests/run_examples.sh
@@ -0,0 +1,15 @@
+#!/bin/sh
+
+
+basepath=`readlink -f $1`
+if [ $? -ne 0 ]; then
+basepath=`readlink -f $(dirname $0)`
+fi
+echo "No path specified, using ${basepath}"
+
+set -e
+cd ${basepath}
+for i in `ls ${basepath}/*.js`; do
+ redis-cli flushdb
+ node $i
+done
\ No newline at end of file
diff --git a/doctests/search-quickstart.js b/doctests/search-quickstart.js
new file mode 100644
index 00000000000..ec3f65a5e3a
--- /dev/null
+++ b/doctests/search-quickstart.js
@@ -0,0 +1,231 @@
+// EXAMPLE: search_quickstart
+// REMOVE_START
+import assert from 'assert';
+// REMOVE_END
+// HIDE_START
+import { createClient, SCHEMA_FIELD_TYPE } from 'redis';
+// HIDE_END
+// STEP_START connect
+const client = createClient();
+client.on('error', err => console.log('Redis Client Error', err));
+
+await client.connect();
+// STEP_END
+
+// STEP_START data_sample
+const bicycle1 = {
+ brand: 'Velorim',
+ model: 'Jigger',
+ price: 270,
+ description:
+ 'Small and powerful, the Jigger is the best ' +
+ 'ride for the smallest of tikes! This is the tiniest kids\u2019 ' +
+ 'pedal bike on the market available without a coaster brake, the ' +
+ 'Jigger is the vehicle of choice for the rare tenacious little' +
+ 'rider raring to go.',
+ condition: 'new'
+};
+// STEP_END
+const bicycles = [
+ bicycle1,
+ {
+ brand: 'Bicyk',
+ model: 'Hillcraft',
+ price: 1200,
+ description: 'Kids want to ride with as little weight as possible. Especially on an incline! They may be at the age when a 27.5\" wheel bike is just too clumsy coming off a 24\" bike. The Hillcraft 26 is just the solution they need!',
+ condition: 'used'
+ },
+ {
+ brand: 'Nord',
+ model: 'Chook air 5',
+ price: 815,
+ description: 'The Chook Air 5 gives kids aged six years and older a durable and uberlight mountain bike for their first experience on tracks and easy cruising through forests and fields. The lower top tube makes it easy to mount and dismount in any situation, giving your kids greater safety on the trails.',
+ condition: 'used'
+ },
+ {
+ brand: 'Eva',
+ model: 'Eva 291',
+ price: 3400,
+ description: 'The sister company to Nord, Eva launched in 2005 as the first and only women-dedicated bicycle brand. Designed by women for women, allEva bikes are optimized for the feminine physique using analytics from a body metrics database. If you like 29ers, try the Eva 291. It\u2019s a brand new bike for 2022.. This full-suspension, cross-country ride has been designed for velocity. The 291 has 100mm of front and rear travel, a superlight aluminum frame and fast-rolling 29-inch wheels. Yippee!',
+ condition: 'used'
+ },
+ {
+ brand: 'Noka Bikes',
+ model: 'Kahuna',
+ price: 3200,
+ description: 'Whether you want to try your hand at XC racing or are looking for a lively trail bike that\'s just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women\u2019s saddle, different bars and unique colourway.',
+ condition: 'used'
+ },
+ {
+ brand: 'Breakout',
+ model: 'XBN 2.1 Alloy',
+ price: 810,
+ description: 'The XBN 2.1 Alloy is our entry-level road bike \u2013 but that\u2019s not to say that it\u2019s a basic machine. With an internal weld aluminium frame, a full carbon fork, and the slick-shifting Claris gears from Shimano\u2019s, this is a bike which doesn\u2019t break the bank and delivers craved performance.',
+ condition: 'new'
+ },
+ {
+ brand: 'ScramBikes',
+ model: 'WattBike',
+ price: 2300,
+ description: 'The WattBike is the best e-bike for people who still feel young at heart. It has a Bafang 1000W mid-drive system and a 48V 17.5AH Samsung Lithium-Ion battery, allowing you to ride for more than 60 miles on one charge. It\u2019s great for tackling hilly terrain or if you just fancy a more leisurely ride. With three working modes, you can choose between E-bike, assisted bicycle, and normal bike modes.',
+ condition: 'new'
+ },
+ {
+ brand: 'Peaknetic',
+ model: 'Secto',
+ price: 430,
+ description: 'If you struggle with stiff fingers or a kinked neck or back after a few minutes on the road, this lightweight, aluminum bike alleviates those issues and allows you to enjoy the ride. From the ergonomic grips to the lumbar-supporting seat position, the Roll Low-Entry offers incredible comfort. The rear-inclined seat tube facilitates stability by allowing you to put a foot on the ground to balance at a stop, and the low step-over frame makes it accessible for all ability and mobility levels. The saddle is very soft, with a wide back to support your hip joints and a cutout in the center to redistribute that pressure. Rim brakes deliver satisfactory braking control, and the wide tires provide a smooth, stable ride on paved roads and gravel. Rack and fender mounts facilitate setting up the Roll Low-Entry as your preferred commuter, and the BMX-like handlebar offers space for mounting a flashlight, bell, or phone holder.',
+ condition: 'new'
+ },
+ {
+ brand: 'nHill',
+ model: 'Summit',
+ price: 1200,
+ description: 'This budget mountain bike from nHill performs well both on bike paths and on the trail. The fork with 100mm of travel absorbs rough terrain. Fat Kenda Booster tires give you grip in corners and on wet trails. The Shimano Tourney drivetrain offered enough gears for finding a comfortable pace to ride uphill, and the Tektro hydraulic disc brakes break smoothly. Whether you want an affordable bike that you can take to work, but also take trail in mountains on the weekends or you\u2019re just after a stable, comfortable ride for the bike path, the Summit gives a good value for money.',
+ condition: 'new'
+ },
+ {
+ model: 'ThrillCycle',
+ brand: 'BikeShind',
+ price: 815,
+ description: 'An artsy, retro-inspired bicycle that\u2019s as functional as it is pretty: The ThrillCycle steel frame offers a smooth ride. A 9-speed drivetrain has enough gears for coasting in the city, but we wouldn\u2019t suggest taking it to the mountains. Fenders protect you from mud, and a rear basket lets you transport groceries, flowers and books. The ThrillCycle comes with a limited lifetime warranty, so this little guy will last you long past graduation.',
+ condition: 'refurbished'
+ }
+];
+// STEP_START create_index
+const schema = {
+ '$.brand': {
+ type: SCHEMA_FIELD_TYPE.TEXT,
+ SORTABLE: true,
+ AS: 'brand'
+ },
+ '$.model': {
+ type: SCHEMA_FIELD_TYPE.TEXT,
+ AS: 'model'
+ },
+ '$.description': {
+ type: SCHEMA_FIELD_TYPE.TEXT,
+ AS: 'description'
+ },
+ '$.price': {
+ type: SCHEMA_FIELD_TYPE.NUMERIC,
+ AS: 'price'
+ },
+ '$.condition': {
+ type: SCHEMA_FIELD_TYPE.TAG,
+ AS: 'condition'
+ }
+};
+
+try {
+ await client.ft.create('idx:bicycle', schema, {
+ ON: 'JSON',
+ PREFIX: 'bicycle:'
+ });
+} catch (e) {
+ if (e.message === 'Index already exists') {
+ console.log('Index exists already, skipped creation.');
+ } else {
+ // Something went wrong, perhaps RediSearch isn't installed...
+ console.error(e);
+ process.exit(1);
+ }
+}
+// STEP_END
+
+// STEP_START add_documents
+await Promise.all(
+ bicycles.map((bicycle, i) => client.json.set(`bicycle:${i}`, '$', bicycle))
+);
+// STEP_END
+
+// STEP_START wildcard_query
+let result = await client.ft.search('idx:bicycle', '*', {
+ LIMIT: {
+ from: 0,
+ size: 10
+ }
+});
+
+console.log(JSON.stringify(result, null, 2));
+
+/*
+{
+ "total": 10,
+ "documents": ...
+}
+*/
+// STEP_END
+
+// REMOVE_START
+assert.equal(result.documents[0].id, 'bicycle:0');
+// REMOVE_END
+
+// STEP_START query_single_term
+result = await client.ft.search(
+ 'idx:bicycle',
+ '@model:Jigger',
+ {
+ LIMIT: {
+ from: 0,
+ size: 10
+ }
+});
+
+console.log(JSON.stringify(result, null, 2));
+/*
+{
+ "total": 1,
+ "documents": [{
+ "id": "bicycle:0",
+ "value": {
+ "brand": "Velorim",
+ "model": "Jigger",
+ "price": 270,
+ "description": "Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kidsβ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.",
+ "condition": "new"
+ }
+ }]
+}
+ */
+// STEP_END
+// REMOVE_START
+assert.equal(result.documents[0].id, 'bicycle:0');
+// REMOVE_END
+
+// STEP_START query_exact_matching
+result = await client.ft.search(
+ 'idx:bicycle',
+ '@brand:"Noka Bikes"',
+ {
+ LIMIT: {
+ from: 0,
+ size: 10
+ }
+ }
+);
+
+console.log(JSON.stringify(result, null, 2));
+
+/*
+{
+ "total": 1,
+ "documents": [{
+ "id": "bicycle:4",
+ "value": {
+ "brand": "Noka Bikes",
+ "model": "Kahuna",
+ "price": 3200,
+ "description": "Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a womenβs saddle, different bars and unique colourway.",
+ "condition": "used"
+ }
+ }]
+}
+*/
+// STEP_END
+
+// REMOVE_START
+assert.equal(result.documents[0].id, 'bicycle:4');
+// REMOVE END
+
+await client.close();
diff --git a/doctests/string-set-get-example.js b/doctests/string-set-get-example.js
new file mode 100644
index 00000000000..b9be382285e
--- /dev/null
+++ b/doctests/string-set-get-example.js
@@ -0,0 +1,27 @@
+// EXAMPLE: set_and_get
+// REMOVE_START
+import assert from "node:assert";
+// REMOVE_END
+
+// HIDE_START
+import { createClient } from 'redis';
+
+const client = createClient();
+
+client.on('error', err => console.log('Redis Client Error', err));
+
+await client.connect().catch(console.error);
+
+// HIDE_END
+await client.set('bike:1', 'Process 134');
+const value = await client.get('bike:1');
+console.log(value);
+// returns 'Process 134'
+//REMOVE_START
+assert.equal(value, 'Process 134');
+await client.del('bike:1');
+//REMOVE_END
+
+// HIDE_START
+await client.close();
+// HIDE_END
diff --git a/examples/.gitignore b/examples/.gitignore
new file mode 100644
index 00000000000..d8b83df9cdb
--- /dev/null
+++ b/examples/.gitignore
@@ -0,0 +1 @@
+package-lock.json
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 00000000000..47c9912fd31
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,95 @@
+# Node Redis: Examples
+
+This folder contains example scripts showing how to use Node Redis in different scenarios.
+
+| File Name | Description |
+|------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `blocking-list-pop.js` | Block until an element is pushed to a list. |
+| `bloom-filter.js` | Space efficient set membership checks with a [Bloom Filter](https://en.wikipedia.org/wiki/Bloom_filter) using [RedisBloom](https://redisbloom.io). |
+| `check-connection-status.js` | Check the client's connection status. |
+| `command-with-modifiers.js` | Define a script that allows to run a command with several modifiers. |
+| `connect-as-acl-user.js` | Connect to Redis 6 using an ACL user. |
+| `connect-to-cluster.js` | Connect to a Redis cluster. |
+| `count-min-sketch.js` | Estimate the frequency of a given event using the [RedisBloom](https://redisbloom.io) Count-Min Sketch. |
+| `cuckoo-filter.js` | Space efficient set membership checks with a [Cuckoo Filter](https://en.wikipedia.org/wiki/Cuckoo_filter) using [RedisBloom](https://redisbloom.io). |
+| `dump-and-restore.js` | Demonstrates the use of the [`DUMP`](https://redis.io/commands/dump/) and [`RESTORE`](https://redis.io/commands/restore/) commands |
+| `get-server-time.js` | Get the time from the Redis server. |
+| `hyperloglog.js` | Showing use of Hyperloglog commands [PFADD, PFCOUNT and PFMERGE](https://redis.io/commands/?group=hyperloglog). |
+| `lua-multi-incr.js` | Define a custom lua script that allows you to perform INCRBY on multiple keys. |
+| `managing-json.js` | Store, retrieve and manipulate JSON data atomically with [RedisJSON](https://redisjson.io/). |
+| `pubsub-publisher.js` | Adds multiple messages on 2 different channels messages to Redis. |
+| `pubsub-subscriber.js` | Reads messages from channels using `PSUBSCRIBE` command. |
+| `search-hashes.js` | Uses [RediSearch](https://redisearch.io) to index and search data in hashes. |
+| `search-json.js` | Uses [RediSearch](https://redisearch.io/) and [RedisJSON](https://redisjson.io/) to index and search JSON data. |
+| `search-knn.js` | Uses [RediSearch vector similarity]([https://redisearch.io/](https://redis.io/docs/stack/search/reference/vectors/)) to index and run KNN queries. |
+| `set-scan.js` | An example script that shows how to use the SSCAN iterator functionality. |
+| `sorted-set.js` | Add members with scores to a Sorted Set and retrieve them using the ZSCAN iteractor functionality. |
+| `stream-producer.js` | Adds entries to a [Redis Stream](https://redis.io/topics/streams-intro) using the `XADD` command. |
+| `stream-consumer.js` | Reads entries from a [Redis Stream](https://redis.io/topics/streams-intro) using the blocking `XREAD` command. |
+| `time-series.js` | Create, populate and query timeseries data with [Redis Timeseries](https://redistimeseries.io). |
+| `topk.js` | Use the [RedisBloom](https://redisbloom.io) TopK to track the most frequently seen items. |
+| `stream-consumer-group.js` | Reads entries from a [Redis Stream](https://redis.io/topics/streams-intro) as part of a consumer group using the blocking `XREADGROUP` command. |
+| `transaction-with-arbitrary-commands.js` | Mix and match supported commands with arbitrary command strings in a Redis transaction. |
+| `transaction-with-watch.js` | An Example of [Redis transaction](https://redis.io/docs/manual/transactions) with `WATCH` command on isolated connection with optimistic locking. |
+
+## Contributing
+
+We'd love to see more examples here. If you have an idea that you'd like to see included here, submit a Pull Request and we'll be sure to review it! Don't forget to check out our [contributing guide](../CONTRIBUTING.md).
+
+## Setup
+
+To set up the examples folder so that you can run an example / develop one of your own:
+
+```bash
+git clone https://github.com/redis/node-redis.git
+cd node-redis
+npm install -ws && npm run build
+cd examples
+npm install
+```
+
+### Coding Guidelines for Examples
+
+When adding a new example, please follow these guidelines:
+
+- Add your code in a single JavaScript or TypeScript file per example, directly in the `examples` folder
+- Do not introduce other dependencies in your example
+- Give your `.js` file a meaningful name using `-` separators e.g. `adding-to-a-stream.js` / `adding-to-a-stream.ts`
+- Indent your code using 2 spaces
+- Use the single line `//` comment style and comment your code
+- Add a comment at the top of your `.js` / `.ts` file describing what your example does
+- Add a comment at the top of your `.js` / `.ts` file describing any Redis commands that need to be run to set up data for your example (try and keep this minimal)
+- Use semicolons
+- Use `async` and `await`
+- Use single quotes, `'hello'` not `"hello"`
+- Use [template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals) when embedding expressions in strings
+- Unless your example requires a connection string, assume Redis is on the default localhost port 6379 with no password
+- Use meaningful example data, let's not use `foo`, `bar`, `baz` etc!
+- Leave an empty line at the end of your `.js` file
+- Update this `README.md` file to add your example to the table
+
+Use [connect-as-acl-user.js](./connect-as-acl-user.js) as a guide to develop a well formatted example script.
+
+### Example Template
+
+Here's a starter template for adding a new example, imagine this is stored in `do-something.js`:
+
+```javascript
+// This comment should describe what the example does
+// and can extend to multiple lines.
+
+// Set up the data in redis-cli using these commands:
+//
+//
+// Alternatively, add code that sets up the data.
+
+import { createClient } from 'redis';
+
+const client = createClient();
+
+await client.connect();
+
+// Add your example code here...
+
+client.close();
+```
diff --git a/examples/auth.js b/examples/auth.js
deleted file mode 100644
index 6c0a563cd8b..00000000000
--- a/examples/auth.js
+++ /dev/null
@@ -1,5 +0,0 @@
-var redis = require("redis"),
- client = redis.createClient();
-
-// This command is magical. Client stashes the password and will issue on every connect.
-client.auth("somepass");
diff --git a/examples/backpressure_drain.js b/examples/backpressure_drain.js
deleted file mode 100644
index 3488ef4d3f7..00000000000
--- a/examples/backpressure_drain.js
+++ /dev/null
@@ -1,33 +0,0 @@
-var redis = require("../index"),
- client = redis.createClient(null, null, {
- command_queue_high_water: 5,
- command_queue_low_water: 1
- }),
- remaining_ops = 100000, paused = false;
-
-function op() {
- if (remaining_ops <= 0) {
- console.error("Finished.");
- process.exit(0);
- }
-
- remaining_ops--;
- if (client.hset("test hash", "val " + remaining_ops, remaining_ops) === false) {
- console.log("Pausing at " + remaining_ops);
- paused = true;
- } else {
- process.nextTick(op);
- }
-}
-
-client.on("drain", function () {
- if (paused) {
- console.log("Resuming at " + remaining_ops);
- paused = false;
- process.nextTick(op);
- } else {
- console.log("Got drain while not paused at " + remaining_ops);
- }
-});
-
-op();
diff --git a/examples/blocking-list-pop.js b/examples/blocking-list-pop.js
new file mode 100644
index 00000000000..f29a409398c
--- /dev/null
+++ b/examples/blocking-list-pop.js
@@ -0,0 +1,29 @@
+// This example shows how to use the blocking LPUSH command.
+
+// This code shows how to run with isolation the blPop Command to block the script while waiting for a value to be pushed to the list.
+// The script will be blocked until the LPUSH command is executed.
+// After which we log the list and quit the client.
+
+import { createClientPool } from 'redis';
+
+const client = createClientPool();
+
+await client.connect();
+
+const keyName = 'keyName';
+
+const blpopPromise = client.blPop(
+ keyName,
+ 0
+);
+
+await client.lPush(keyName, 'value');
+
+const listItem = await blpopPromise;
+
+console.log('blpopPromise resolved');
+// listItem will be:
+// {"key":"keyName","element":"value"}
+console.log(`listItem is '${JSON.stringify(listItem)}'`);
+
+client.destroy();
diff --git a/examples/bloom-filter.js b/examples/bloom-filter.js
new file mode 100644
index 00000000000..a133b0274f2
--- /dev/null
+++ b/examples/bloom-filter.js
@@ -0,0 +1,80 @@
+// This example demonstrates the use of the Bloom Filter
+// in the RedisBloom module (https://redis.io/docs/stack/bloom/)
+
+import { createClient } from 'redis';
+
+const client = createClient();
+
+await client.connect();
+
+// Delete any pre-existing Bloom Filter.
+await client.del('mybloom');
+
+// Reserve a Bloom Filter with configurable error rate and capacity.
+// https://redis.io/commands/bf.reserve/
+try {
+ await client.bf.reserve('mybloom', 0.01, 1000);
+ console.log('Reserved Bloom Filter.');
+} catch (e) {
+ if (e.message.endsWith('item exists')) {
+ console.log('Bloom Filter already reserved.');
+ } else {
+ console.log('Error, maybe RedisBloom is not installed?:');
+ console.log(e);
+ }
+}
+
+// Add items to Bloom Filter individually with BF.ADD command.
+// https://redis.io/commands/bf.add/
+await Promise.all([
+ client.bf.add('mybloom', 'leibale'),
+ client.bf.add('mybloom', 'simon'),
+ client.bf.add('mybloom', 'guy'),
+ client.bf.add('mybloom', 'suze'),
+ client.bf.add('mybloom', 'brian'),
+ client.bf.add('mybloom', 'steve'),
+ client.bf.add('mybloom', 'kyle'),
+ client.bf.add('mybloom', 'josefin'),
+ client.bf.add('mybloom', 'alex'),
+ client.bf.add('mybloom', 'nava'),
+]);
+
+// Add multiple items to Bloom Filter at once with BF.MADD command.
+// https://redis.io/commands/bf.madd/
+await client.bf.mAdd('mybloom', [
+ 'kaitlyn',
+ 'rachel'
+]);
+
+console.log('Added members to Bloom Filter.');
+
+// Check whether a member exists with the BF.EXISTS command.
+// https://redis.io/commands/bf.exists/
+const simonExists = await client.bf.exists('mybloom', 'simon');
+console.log(`simon ${simonExists ? 'may' : 'does not'} exist in the Bloom Filter.`);
+
+// Check whether multiple members exist with the BF.MEXISTS command.
+// https://redis.io/commands/bf.mexists/
+const [ lanceExists, leibaleExists ] = await client.bf.mExists('mybloom', [
+ 'lance',
+ 'leibale'
+]);
+
+console.log(`lance ${lanceExists ? 'may' : 'does not'} exist in the Bloom Filter.`);
+console.log(`leibale ${leibaleExists ? 'may' : 'does not'} exist in the Bloom Filter.`);
+
+// Get stats for the Bloom Filter with the BF.INFO command.
+// https://redis.io/commands/bf.info/
+const info = await client.bf.info('mybloom');
+// info looks like this:
+//
+// {
+// capacity: 1000,
+// size: 1531,
+// numberOfFilters: 1,
+// numberOfInsertedItems: 12,
+// expansionRate: 2
+// }
+console.log(info);
+
+client.destroy();
diff --git a/examples/check-connection-status.js b/examples/check-connection-status.js
new file mode 100644
index 00000000000..ae3c863fb14
--- /dev/null
+++ b/examples/check-connection-status.js
@@ -0,0 +1,28 @@
+// Check the connection status of the Redis client instance.
+import { createClient } from 'redis';
+
+const client = createClient();
+
+console.log('Before client.connect()...');
+
+// isOpen will return False here as the client's socket is not open yet.
+// isReady will return False here, client is not yet ready to use.
+console.log(`client.isOpen: ${client.isOpen}, client.isReady: ${client.isReady}`);
+
+// Begin connection process...
+const connectPromise = client.connect();
+
+console.log('After client.connect()...');
+
+// isOpen will return True here as the client's socket is open now.
+// isReady will return False here as the promise hasn't resolved yet.
+console.log(`client.isOpen: ${client.isOpen}, client.isReady: ${client.isReady}`);
+
+await connectPromise;
+console.log('Afer connectPromise has resolved...');
+
+// isOpen will return True here as the client's socket is open now.
+// isReady will return True here, client is ready to use.
+console.log(`client.isOpen: ${client.isOpen}, client.isReady: ${client.isReady}`);
+
+client.destroy();
diff --git a/examples/command-with-modifiers.js b/examples/command-with-modifiers.js
new file mode 100644
index 00000000000..356304722c0
--- /dev/null
+++ b/examples/command-with-modifiers.js
@@ -0,0 +1,31 @@
+// Define a custom script that shows example of SET command
+// with several modifiers.
+
+import { createClient } from 'redis';
+
+const client = createClient();
+
+await client.connect();
+await client.del('mykey');
+
+console.log(
+ await client.set('mykey', 'myvalue', {
+ expiration: {
+ type: 'EX',
+ value: 60
+ },
+ GET: true
+ })
+); // null
+
+console.log(
+ await client.set('mykey', 'newvalue', {
+ expiration: {
+ type: 'EX',
+ value: 60
+ },
+ GET: true
+ })
+); // 'myvalue'
+
+await client.close();
diff --git a/examples/connect-as-acl-user.js b/examples/connect-as-acl-user.js
new file mode 100644
index 00000000000..bc3069b5bbc
--- /dev/null
+++ b/examples/connect-as-acl-user.js
@@ -0,0 +1,26 @@
+// Connect to Redis 6.x as an ACL user. Attempt to run a command
+// that the user is allowed to execute, and a command that the
+// user is not allowed to execute.
+
+// Create the test user in redis-cli with this command:
+// acl setuser testuser on >testpassword +ping
+
+import { createClient } from 'redis';
+
+const client = createClient({
+ url: 'redis://testuser:testpassword@127.0.0.1:6379'
+});
+
+await client.connect();
+
+// Returns PONG
+console.log(`Response from PING command: ${await client.ping()}`);
+
+try {
+ // This will error as this user is not allowed to run this command...
+ console.log(`Response from GET command: ${await client.get('somekey')}`);
+} catch (e) {
+ console.log(`GET command failed: ${e.message}`);
+}
+
+client.destroy();
diff --git a/examples/connect-to-cluster.js b/examples/connect-to-cluster.js
new file mode 100644
index 00000000000..86e45b87968
--- /dev/null
+++ b/examples/connect-to-cluster.js
@@ -0,0 +1,32 @@
+// This is an example script to connect to a running cluster.
+// After connecting to the cluster the code sets and get a value.
+
+// To setup this cluster you can follow the guide here:
+// https://redis.io/docs/manual/scaling/
+// In this guide the ports which are being used are 7000 - 7005
+
+
+import { createCluster } from 'redis';
+
+const cluster = createCluster({
+ rootNodes : [
+ {
+ url : 'redis://127.0.0.1:7001'
+ },
+ {
+ url : 'redis://127.0.0.1:7002'
+ },
+ {
+ url : 'redis://127.0.0.1:7003'
+ }
+ ]
+});
+
+cluster.on('error', (err) => console.log('Redis Client Error', err));
+
+await cluster.connect();
+
+await cluster.set('hello', 'cluster');
+const value = await cluster.get('hello');
+console.log(value);
+await cluster.close();
diff --git a/examples/count-min-sketch.js b/examples/count-min-sketch.js
new file mode 100644
index 00000000000..ffbe13a7c27
--- /dev/null
+++ b/examples/count-min-sketch.js
@@ -0,0 +1,80 @@
+// This example demonstrates the use of the Count-Min Sketch
+// in the RedisBloom module (https://redis.io/docs/stack/bloom/)
+
+import { createClient } from 'redis';
+
+const client = createClient();
+
+await client.connect();
+
+// Delete any pre-existing Count-Min Sketch.
+await client.del('mycms');
+
+// Initialize a Count-Min Sketch with error rate and probability:
+// https://redis.io/commands/cms.initbyprob/
+try {
+ await client.cms.initByProb('mycms', 0.001, 0.01);
+ console.log('Reserved Count Min Sketch.');
+} catch (e) {
+ console.log('Error, maybe RedisBloom is not installed?:');
+ console.log(e);
+}
+
+const teamMembers = [
+ 'leibale',
+ 'simon',
+ 'guy',
+ 'suze',
+ 'brian',
+ 'steve',
+ 'kyleb',
+ 'kyleo',
+ 'josefin',
+ 'alex',
+ 'nava',
+ 'lance',
+ 'rachel',
+ 'kaitlyn'
+];
+
+// Store actual counts for comparison with CMS.
+let actualCounts = {};
+
+// Randomly emit a team member and count them with the CMS.
+// https://redis.io/commands/cms.incrby/
+for (let n = 0; n < 1000; n++) {
+ const teamMember = teamMembers[Math.floor(Math.random() * teamMembers.length)];
+ await client.cms.incrBy('mycms', {
+ item: teamMember,
+ incrementBy: 1
+ });
+
+ actualCounts[teamMember] = actualCounts[teamMember] ? actualCounts[teamMember] + 1 : 1;
+
+ console.log(`Incremented score for ${teamMember}.`);
+}
+
+// Get count estimate for some team members:
+// https://redis.io/commands/cms.query/
+const [ alexCount, rachelCount ] = await client.cms.query('mycms', [
+ 'alex',
+ 'rachel'
+]);
+
+console.log(`Count estimate for alex: ${alexCount} (actual ${actualCounts.alex}).`);
+console.log(`Count estimate for rachel: ${rachelCount} (actual ${actualCounts.rachel}).`);
+
+// Get overall information about the Count-Min Sketch:
+// https://redis.io/commands/cms.info/
+const info = await client.cms.info('mycms');
+console.log('Count-Min Sketch info:');
+
+// info looks like this:
+// {
+// width: 2000,
+// depth: 7,
+// count: 1000
+// }
+console.log(info);
+
+client.destroy();
diff --git a/examples/cuckoo-filter.js b/examples/cuckoo-filter.js
new file mode 100644
index 00000000000..6ab58fbfa5c
--- /dev/null
+++ b/examples/cuckoo-filter.js
@@ -0,0 +1,79 @@
+// This example demonstrates the use of the Cuckoo Filter
+// in the RedisBloom module (https://redis.io/docs/stack/bloom/)
+
+import { createClient } from 'redis';
+
+const client = createClient();
+
+await client.connect();
+
+// Delete any pre-existing Cuckoo Filter.
+await client.del('mycuckoo');
+
+// Reserve a Cuckoo Filter with a capacity of 10000 items.
+// https://redis.io/commands/cf.reserve/
+try {
+ await client.cf.reserve('mycuckoo', 10000);
+ console.log('Reserved Cuckoo Filter.');
+} catch (e) {
+ console.log('Error, maybe RedisBloom is not installed?:');
+ console.log(e);
+}
+
+// Add items to Cuckoo Filter individually with CF.ADD command.
+// https://redis.io/commands/cf.add/
+await Promise.all([
+ client.cf.add('mycuckoo', 'leibale'),
+ client.cf.add('mycuckoo', 'simon'),
+ client.cf.add('mycuckoo', 'guy'),
+ client.cf.add('mycuckoo', 'suze'),
+ client.cf.add('mycuckoo', 'brian'),
+ client.cf.add('mycuckoo', 'steve'),
+ client.cf.add('mycuckoo', 'kyle'),
+ client.cf.add('mycuckoo', 'josefin'),
+ client.cf.add('mycuckoo', 'alex'),
+ client.cf.add('mycuckoo', 'nava'),
+]);
+
+// Add items to the Cuckoo Filter only if they don't exist in it...
+// https://redis.io/commands/cf.addnx/
+const nxReply = await Promise.all([
+ client.cf.addNX('mycuckoo', 'kaitlyn'), // New
+ client.cf.addNX('mycuckoo', 'rachel'), // New
+ client.cf.addNX('mycuckoo', 'brian') // Previously added
+]);
+
+console.log('Added members to Cuckoo Filter.');
+console.log('nxReply:');
+
+// nxReply looks like this:
+// [
+// true,
+// true,
+// false
+// ]
+console.log(nxReply);
+
+// Check whether a member exists with the CF.EXISTS command.
+// https://redis.io/commands/cf.exists/
+const simonExists = await client.bf.exists('mycuckoo', 'simon');
+console.log(`simon ${simonExists ? 'may' : 'does not'} exist in the Cuckoo Filter.`);
+
+// Get stats for the Cuckoo Filter with the CF.INFO command:
+// https://redis.io/commands/cf.info/
+const info = await client.cf.info('mycuckoo');
+
+// info looks like this:
+// {
+// size: 16440,
+// numberOfBuckets: 8192,
+// numberOfFilters: 1,
+// numberOfInsertedItems: 12,
+// numberOfDeletedItems: 0,
+// bucketSize: 2,
+// expansionRate: 1,
+// maxIteration: 20
+// }
+console.log(info);
+
+client.destroy();
diff --git a/examples/dump-and-restore.js b/examples/dump-and-restore.js
new file mode 100644
index 00000000000..f464fd38be1
--- /dev/null
+++ b/examples/dump-and-restore.js
@@ -0,0 +1,32 @@
+// This example demonstrates the use of the DUMP and RESTORE commands
+
+import { createClient, RESP_TYPES } from 'redis';
+
+const client = await createClient({
+ commandOptions: {
+ typeMapping: {
+ [RESP_TYPES.BLOB_STRING]: Buffer
+ }
+ }
+}).on('error', err => {
+ console.log('Redis Client Error', err);
+}).connect();
+
+// Make sure the source key exists
+await client.set('source', 'value');
+
+// Make sure destination doesnt exist
+await client.del('destination');
+
+// DUMP a specific key into a local variable
+const dump = await client.dump('source');
+
+// RESTORE into a new key
+await client.restore('destination', 0, dump);
+
+// RESTORE and REPLACE an existing key
+await client.restore('destination', 0, dump, {
+ REPLACE: true
+});
+
+await client.close();
diff --git a/examples/eval.js b/examples/eval.js
deleted file mode 100644
index c1fbf8a5568..00000000000
--- a/examples/eval.js
+++ /dev/null
@@ -1,9 +0,0 @@
-var redis = require("./index"),
- client = redis.createClient();
-
-redis.debug_mode = true;
-
-client.eval("return 100.5", 0, function (err, res) {
- console.dir(err);
- console.dir(res);
-});
diff --git a/examples/extend.js b/examples/extend.js
deleted file mode 100644
index 488b8c2dc5d..00000000000
--- a/examples/extend.js
+++ /dev/null
@@ -1,24 +0,0 @@
-var redis = require("redis"),
- client = redis.createClient();
-
-// Extend the RedisClient prototype to add a custom method
-// This one converts the results from "INFO" into a JavaScript Object
-
-redis.RedisClient.prototype.parse_info = function (callback) {
- this.info(function (err, res) {
- var lines = res.toString().split("\r\n").sort();
- var obj = {};
- lines.forEach(function (line) {
- var parts = line.split(':');
- if (parts[1]) {
- obj[parts[0]] = parts[1];
- }
- });
- callback(obj)
- });
-};
-
-client.parse_info(function (info) {
- console.dir(info);
- client.quit();
-});
diff --git a/examples/file.js b/examples/file.js
deleted file mode 100644
index 4d2b5d1c987..00000000000
--- a/examples/file.js
+++ /dev/null
@@ -1,32 +0,0 @@
-// Read a file from disk, store it in Redis, then read it back from Redis.
-
-var redis = require("redis"),
- client = redis.createClient(),
- fs = require("fs"),
- filename = "kids_in_cart.jpg";
-
-// Get the file I use for testing like this:
-// curl http://ranney.com/kids_in_cart.jpg -o kids_in_cart.jpg
-// or just use your own file.
-
-// Read a file from fs, store it in Redis, get it back from Redis, write it back to fs.
-fs.readFile(filename, function (err, data) {
- if (err) throw err
- console.log("Read " + data.length + " bytes from filesystem.");
-
- client.set(filename, data, redis.print); // set entire file
- client.get(filename, function (err, reply) { // get entire file
- if (err) {
- console.log("Get error: " + err);
- } else {
- fs.writeFile("duplicate_" + filename, reply, function (err) {
- if (err) {
- console.log("Error on write: " + err)
- } else {
- console.log("File written.");
- }
- client.end();
- });
- }
- });
-});
diff --git a/examples/get-server-time.js b/examples/get-server-time.js
new file mode 100644
index 00000000000..752264df349
--- /dev/null
+++ b/examples/get-server-time.js
@@ -0,0 +1,18 @@
+// Get the time from the Redis Server.
+
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+
+const serverTime = await client.time();
+// In v5, TIME returns [unixTimestamp: string, microseconds: string] instead of Date
+// Example: ['1708956789', '123456']
+console.log(serverTime);
+
+// Convert to JavaScript Date if needed
+const [seconds, microseconds] = serverTime;
+const date = new Date(parseInt(seconds) * 1000 + parseInt(microseconds) / 1000);
+console.log('Converted to Date:', date);
+
+client.close();
diff --git a/examples/hyperloglog.js b/examples/hyperloglog.js
new file mode 100644
index 00000000000..1f8f04f2a6c
--- /dev/null
+++ b/examples/hyperloglog.js
@@ -0,0 +1,51 @@
+// Example to log traffic data at intersections for the city of San Francisco.
+// Log license plates of each car scanned at each intersection and add to the intersections Hyperloglog.
+// Reference: https://www.youtube.com/watch?v=MunL8nnwscQ
+
+import { createClient } from 'redis';
+
+const client = createClient();
+
+await client.connect();
+
+// Use `pfAdd` to add an element to a Hyperloglog, creating the Hyperloglog if necessary.
+// await client.pfAdd(key, value) // returns 1 or 0
+
+// To get a count, the `pfCount` method is used.
+// await client.pfCount(key)
+
+try {
+ // Corner of Market Street (ID: 12) and 10th street (ID:27).
+ await client.pfAdd('count:sf:12:27', 'GHN34X');
+ await client.pfAdd('count:sf:12:27', 'ECN94Y');
+ await client.pfAdd('count:sf:12:27', 'VJL12V');
+ await client.pfAdd('count:sf:12:27', 'ORV87O');
+
+ // To get the count of Corner of Market Street (ID: 12) and 10th street (ID:27).
+ const countForMarket10thStreet = await client.pfCount('count:sf:12:27');
+ console.log(`Count for Market Street & 10th Street is ${countForMarket10thStreet}`);
+ // Count for Market Street & 10th Street is 4.
+
+ // Corner of Market Street (ID: 12) and 11 street (ID:26).
+ await client.pfAdd('count:sf:12:26', 'GHN34X');
+ await client.pfAdd('count:sf:12:26', 'ECN94Y');
+ await client.pfAdd('count:sf:12:26', 'IRV84E');
+ await client.pfAdd('count:sf:12:26', 'ORV87O');
+ await client.pfAdd('count:sf:12:26', 'TEY34S');
+
+ // To get the count of Corner of Market Street (ID: 12) and 11th street (ID:26).
+ const countForMarket11thStreet = await client.pfCount('count:sf:12:26');
+ console.log(`Count for Market Street & 11th Street is ${countForMarket11thStreet}`);
+ // Count for Market Street & 11th Street is 5.
+
+ // To merge the Hyperloglogs `count:sf:12:26` and `count:sf:12:27`.
+ await client.pfMerge('count:merge', ['count:sf:12:27', 'count:sf:12:26']);
+ const countMerge = await client.pfCount('count:merge');
+ console.log(`Count for the merge is ${countMerge}`);
+ // Count for the merge is 6.
+} catch (e) {
+ // something went wrong.
+ console.error(e);
+}
+
+client.close();
diff --git a/examples/lua-multi-incr.js b/examples/lua-multi-incr.js
new file mode 100644
index 00000000000..71b12bdab0f
--- /dev/null
+++ b/examples/lua-multi-incr.js
@@ -0,0 +1,29 @@
+// Define a custome lua script that accepts two keys and an amount to
+// increment each of them by
+
+import { createClient, defineScript } from 'redis';
+
+const client = createClient({
+ scripts: {
+ mincr: defineScript({
+ NUMBER_OF_KEYS: 2,
+ SCRIPT:
+ 'return {' +
+ 'redis.pcall("INCRBY", KEYS[1], ARGV[1]),' +
+ 'redis.pcall("INCRBY", KEYS[2], ARGV[1])' +
+ '}',
+ parseCommand(parser, key1, key2, increment) {
+ parser.pushKey(key1);
+ parser.pushKey(key2);
+ parser.push(increment.toString());
+ },
+ }),
+ },
+});
+
+await client.connect();
+
+await client.set('mykey', '5');
+console.log(await client.mincr('mykey', 'myotherkey', 10)); // [ 15, 10 ]
+
+client.destroy();
diff --git a/examples/managing-json.js b/examples/managing-json.js
new file mode 100644
index 00000000000..0f1eb3b3c21
--- /dev/null
+++ b/examples/managing-json.js
@@ -0,0 +1,81 @@
+// Store, retrieve and manipulate JSON data atomically with RedisJSON.
+
+import { createClient } from 'redis';
+
+const client = createClient();
+
+await client.connect();
+await client.del('noderedis:jsondata');
+
+// Store a JSON object...
+await client.json.set('noderedis:jsondata', '$', {
+ name: 'Roberta McDonald',
+ pets: [
+ {
+ name: 'Fluffy',
+ species: 'dog',
+ age: 5,
+ isMammal: true
+ },
+ {
+ name: 'Rex',
+ species: 'dog',
+ age: 3,
+ isMammal: true
+ },
+ {
+ name: 'Goldie',
+ species: 'fish',
+ age: 2,
+ isMammal: false
+ }
+ ],
+ address: {
+ number: 99,
+ street: 'Main Street',
+ city: 'Springfield',
+ state: 'OH',
+ country: 'USA'
+ }
+});
+
+// Retrieve the name and age of the second pet in the pets array.
+let results = await client.json.get('noderedis:jsondata', {
+ path: [
+ '$.pets[1].name',
+ '$.pets[1].age'
+ ]
+});
+
+// { '$.pets[1].name': [ 'Rex' ], '$.pets[1].age': [ 3 ] }
+console.log(results);
+
+// Goldie had a birthday, increment the age...
+await client.json.numIncrBy('noderedis:jsondata', '$.pets[2].age', 1);
+results = await client.json.get('noderedis:jsondata', {
+ path: '$.pets[2].age'
+});
+
+// Goldie is 3 years old now.
+console.log(`Goldie is ${JSON.parse(results)[0]} years old now.`);
+
+// Add a new pet...
+await client.json.arrAppend('noderedis:jsondata', '$.pets', {
+ name: 'Robin',
+ species: 'bird',
+ isMammal: false,
+ age: 1
+});
+
+// How many pets do we have now?
+const numPets = await client.json.arrLen('noderedis:jsondata', { path: '$.pets' });
+
+// We now have 4 pets.
+console.log(`We now have ${numPets} pets.`);
+
+const rex = { name: 'Rex', species: 'dog', age: 3, isMammal: true }
+
+const index = await client.json.arrIndex( 'noderedis:jsondata', '$.pets', rex);
+console.log(`Rex is at index ${index}`);
+
+client.close();
diff --git a/examples/mget.js b/examples/mget.js
deleted file mode 100644
index 936740d32f3..00000000000
--- a/examples/mget.js
+++ /dev/null
@@ -1,5 +0,0 @@
-var client = require("redis").createClient();
-
-client.mget(["sessions started", "sessions started", "foo"], function (err, res) {
- console.dir(res);
-});
\ No newline at end of file
diff --git a/examples/monitor.js b/examples/monitor.js
deleted file mode 100644
index 2cb6a4e1ecb..00000000000
--- a/examples/monitor.js
+++ /dev/null
@@ -1,10 +0,0 @@
-var client = require("../index").createClient(),
- util = require("util");
-
-client.monitor(function (err, res) {
- console.log("Entering monitoring mode.");
-});
-
-client.on("monitor", function (time, args) {
- console.log(time + ": " + util.inspect(args));
-});
diff --git a/examples/multi.js b/examples/multi.js
deleted file mode 100644
index 35c08e18403..00000000000
--- a/examples/multi.js
+++ /dev/null
@@ -1,46 +0,0 @@
-var redis = require("redis"),
- client = redis.createClient(), set_size = 20;
-
-client.sadd("bigset", "a member");
-client.sadd("bigset", "another member");
-
-while (set_size > 0) {
- client.sadd("bigset", "member " + set_size);
- set_size -= 1;
-}
-
-// multi chain with an individual callback
-client.multi()
- .scard("bigset")
- .smembers("bigset")
- .keys("*", function (err, replies) {
- client.mget(replies, redis.print);
- })
- .dbsize()
- .exec(function (err, replies) {
- console.log("MULTI got " + replies.length + " replies");
- replies.forEach(function (reply, index) {
- console.log("Reply " + index + ": " + reply.toString());
- });
- });
-
-client.mset("incr thing", 100, "incr other thing", 1, redis.print);
-
-// start a separate multi command queue
-var multi = client.multi();
-multi.incr("incr thing", redis.print);
-multi.incr("incr other thing", redis.print);
-
-// runs immediately
-client.get("incr thing", redis.print); // 100
-
-// drains multi queue and runs atomically
-multi.exec(function (err, replies) {
- console.log(replies); // 101, 2
-});
-
-// you can re-run the same transaction if you like
-multi.exec(function (err, replies) {
- console.log(replies); // 102, 3
- client.quit();
-});
diff --git a/examples/multi2.js b/examples/multi2.js
deleted file mode 100644
index 8be4d7313cc..00000000000
--- a/examples/multi2.js
+++ /dev/null
@@ -1,29 +0,0 @@
-var redis = require("redis"),
- client = redis.createClient(), multi;
-
-// start a separate command queue for multi
-multi = client.multi();
-multi.incr("incr thing", redis.print);
-multi.incr("incr other thing", redis.print);
-
-// runs immediately
-client.mset("incr thing", 100, "incr other thing", 1, redis.print);
-
-// drains multi queue and runs atomically
-multi.exec(function (err, replies) {
- console.log(replies); // 101, 2
-});
-
-// you can re-run the same transaction if you like
-multi.exec(function (err, replies) {
- console.log(replies); // 102, 3
- client.quit();
-});
-
-client.multi([
- ["mget", "multifoo", "multibar", redis.print],
- ["incr", "multifoo"],
- ["incr", "multibar"]
-]).exec(function (err, replies) {
- console.log(replies.toString());
-});
diff --git a/examples/package.json b/examples/package.json
new file mode 100644
index 00000000000..c350c0b248b
--- /dev/null
+++ b/examples/package.json
@@ -0,0 +1,12 @@
+{
+ "name": "node-redis-examples",
+ "version": "1.0.0",
+ "description": "node-redis 5 example script",
+ "main": "index.js",
+ "private": true,
+ "type": "module",
+ "dependencies": {
+ "redis": "../packages/redis"
+ }
+}
+
diff --git a/examples/psubscribe.js b/examples/psubscribe.js
deleted file mode 100644
index c57117b8a63..00000000000
--- a/examples/psubscribe.js
+++ /dev/null
@@ -1,33 +0,0 @@
-var redis = require("redis"),
- client1 = redis.createClient(),
- client2 = redis.createClient(),
- client3 = redis.createClient(),
- client4 = redis.createClient(),
- msg_count = 0;
-
-redis.debug_mode = false;
-
-client1.on("psubscribe", function (pattern, count) {
- console.log("client1 psubscribed to " + pattern + ", " + count + " total subscriptions");
- client2.publish("channeltwo", "Me!");
- client3.publish("channelthree", "Me too!");
- client4.publish("channelfour", "And me too!");
-});
-
-client1.on("punsubscribe", function (pattern, count) {
- console.log("client1 punsubscribed from " + pattern + ", " + count + " total subscriptions");
- client4.end();
- client3.end();
- client2.end();
- client1.end();
-});
-
-client1.on("pmessage", function (pattern, channel, message) {
- console.log("("+ pattern +")" + " client1 received message on " + channel + ": " + message);
- msg_count += 1;
- if (msg_count === 3) {
- client1.punsubscribe();
- }
-});
-
-client1.psubscribe("channel*");
diff --git a/examples/pub_sub.js b/examples/pub_sub.js
deleted file mode 100644
index aa508d6c9d2..00000000000
--- a/examples/pub_sub.js
+++ /dev/null
@@ -1,41 +0,0 @@
-var redis = require("redis"),
- client1 = redis.createClient(), msg_count = 0,
- client2 = redis.createClient();
-
-redis.debug_mode = false;
-
-// Most clients probably don't do much on "subscribe". This example uses it to coordinate things within one program.
-client1.on("subscribe", function (channel, count) {
- console.log("client1 subscribed to " + channel + ", " + count + " total subscriptions");
- if (count === 2) {
- client2.publish("a nice channel", "I am sending a message.");
- client2.publish("another one", "I am sending a second message.");
- client2.publish("a nice channel", "I am sending my last message.");
- }
-});
-
-client1.on("unsubscribe", function (channel, count) {
- console.log("client1 unsubscribed from " + channel + ", " + count + " total subscriptions");
- if (count === 0) {
- client2.end();
- client1.end();
- }
-});
-
-client1.on("message", function (channel, message) {
- console.log("client1 channel " + channel + ": " + message);
- msg_count += 1;
- if (msg_count === 3) {
- client1.unsubscribe();
- }
-});
-
-client1.on("ready", function () {
- // if you need auth, do it here
- client1.incr("did a thing");
- client1.subscribe("a nice channel", "another one");
-});
-
-client2.on("ready", function () {
- // if you need auth, do it here
-});
diff --git a/examples/pubsub-publisher.js b/examples/pubsub-publisher.js
new file mode 100644
index 00000000000..354e0ae2f0a
--- /dev/null
+++ b/examples/pubsub-publisher.js
@@ -0,0 +1,20 @@
+// A sample publisher using the publish function to put message on different channels.
+// https://redis.io/commands/publish/
+import { createClient } from 'redis';
+
+const client = createClient();
+
+await client.connect();
+
+// Declare constant variables for the name of the clients we will publish to as they will be required for logging.
+const channel1 = 'chan1nel';
+const channel2 = 'chan2nel';
+
+for (let i = 0; i < 10000; i++) {
+ // 1st channel created to publish 10000 messages.
+ await client.publish(channel1, `channel1_message_${i}`);
+ console.log(`publishing message on ${channel1}`);
+ // 2nd channel created to publish 10000 messages.
+ await client.publish(channel2, `channel2_message_${i}`);
+ console.log(`publishing message on ${channel2}`);
+}
diff --git a/examples/pubsub-subscriber.js b/examples/pubsub-subscriber.js
new file mode 100644
index 00000000000..ff4c05f083e
--- /dev/null
+++ b/examples/pubsub-subscriber.js
@@ -0,0 +1,41 @@
+// A sample subscriber showing how the subscribe method and pSubscribe method work.
+// https://redis.io/commands/subscribe/
+// https://redis.io/commands/pSubscribe/
+// This consumes messages published by pubsub-publisher.js
+
+import { createClient} from 'redis';
+
+// Create and connect client before executing any Redis commands.
+const client = createClient();
+await client.connect();
+
+// Each subscriber needs to connect individually therefore we duplicate the client.
+const channel1Sub = client.duplicate();
+const channel2Sub = client.duplicate();
+const noChannelsSub = client.duplicate();
+const allChannelsSub = client.duplicate();
+
+await channel1Sub.connect();
+await channel2Sub.connect();
+await noChannelsSub.connect();
+await allChannelsSub.connect();
+
+// This subscriber only will receive messages from channel 1 as they are using the subscribe method and subscribed to chan1nel.
+await channel1Sub.subscribe('chan1nel', (message) => {
+ console.log(`Channel1 subscriber collected message: ${message}`);
+},true);
+
+// This subscriber only will receive messages from channel 2 as they are using the subscribe method and subscribed to chan2nel.
+await channel2Sub.subscribe('chan2nel', (message) => {
+ console.log(`Channel2 subscriber collected message: ${message}`);
+},true);
+
+// This subscriber will not receive any messages as its channel does not exist.
+await noChannelsSub.subscribe('chan*nel', (message) => {
+ console.log(`This message will never be seen as we are not using pSubscribe here. ${message}`);
+},true);
+
+// This subscriber receive messages from both channel 1 and channel 2 using the pSubscribe method.
+await allChannelsSub.pSubscribe('chan*nel', (message, channel) => {
+ console.log(`Channel ${channel} sent message: ${message}`);
+},true);
\ No newline at end of file
diff --git a/examples/search-hashes.js b/examples/search-hashes.js
new file mode 100644
index 00000000000..a496fec823a
--- /dev/null
+++ b/examples/search-hashes.js
@@ -0,0 +1,88 @@
+// This example demonstrates how to use RediSearch to index and query data
+// stored in Redis hashes.
+
+import { createClient, SCHEMA_FIELD_TYPE } from 'redis';
+
+const client = createClient();
+
+await client.connect();
+
+// Create an index...
+try {
+ // Documentation: https://redis.io/commands/ft.create/
+ await client.ft.create('idx:animals', {
+ name: {
+ type: SCHEMA_FIELD_TYPE.TEXT,
+ SORTABLE: true
+ },
+ species: SCHEMA_FIELD_TYPE.TAG,
+ age: SCHEMA_FIELD_TYPE.NUMERIC
+ }, {
+ ON: 'HASH',
+ PREFIX: 'noderedis:animals'
+ });
+} catch (e) {
+ if (e.message === 'Index already exists') {
+ console.log('Index exists already, skipped creation.');
+ } else {
+ // Something went wrong, perhaps RediSearch isn't installed...
+ console.error(e);
+ process.exit(1);
+ }
+}
+
+// Add some sample data...
+// https://redis.io/commands/hset/
+await Promise.all([
+ client.hSet('noderedis:animals:1', {name: 'Fluffy', species: 'cat', age: 3}),
+ client.hSet('noderedis:animals:2', {name: 'Ginger', species: 'cat', age: 4}),
+ client.hSet('noderedis:animals:3', {name: 'Rover', species: 'dog', age: 9}),
+ client.hSet('noderedis:animals:4', {name: 'Fido', species: 'dog', age: 7})
+]);
+
+// Perform a search query, find all the dogs... sort by age, descending.
+// Documentation: https://redis.io/commands/ft.search/
+// Query syntax: https://redis.io/docs/stack/search/reference/query_syntax/
+const results = await client.ft.search(
+ 'idx:animals',
+ '@species:{dog}',
+ {
+ SORTBY: {
+ BY: 'age',
+ DIRECTION: 'DESC' // or 'ASC (default if DIRECTION is not present)
+ }
+ }
+);
+
+// results:
+// {
+// total: 2,
+// documents: [
+// {
+// id: 'noderedis:animals:3',
+// value: {
+// name: 'Rover',
+// species: 'dog',
+// age: '9'
+// }
+// },
+// {
+// id: 'noderedis:animals:4',
+// value: {
+// name: 'Fido',
+// species: 'dog',
+// age: '7'
+// }
+// }
+// ]
+// }
+
+console.log(`Results found: ${results.total}.`);
+
+for (const doc of results.documents) {
+ // noderedis:animals:3: Rover, 9 years old.
+ // noderedis:animals:4: Fido, 7 years old.
+ console.log(`${doc.id}: ${doc.value.name}, ${doc.value.age} years old.`);
+}
+
+client.destroy();
diff --git a/examples/search-json.js b/examples/search-json.js
new file mode 100644
index 00000000000..60f2ff095ed
--- /dev/null
+++ b/examples/search-json.js
@@ -0,0 +1,148 @@
+// This example demonstrates how to use RediSearch and RedisJSON together.
+// Requires both the RediSearch and RedisJSON modules:
+// https://redis.io/docs/stack/search/
+// https://redis.io/docs/stack/json/
+
+import { createClient, SCHEMA_FIELD_TYPE, FT_AGGREGATE_GROUP_BY_REDUCERS, FT_AGGREGATE_STEPS } from 'redis';
+
+const client = createClient();
+
+await client.connect();
+
+// Create an index.
+// https://redis.io/commands/ft.create/
+try {
+ await client.ft.create('idx:users', {
+ '$.name': {
+ type: SCHEMA_FIELD_TYPE.TEXT,
+ SORTABLE: true
+ },
+ '$.age': {
+ type: SCHEMA_FIELD_TYPE.NUMERIC,
+ AS: 'age'
+ },
+ '$.coins': {
+ type: SCHEMA_FIELD_TYPE.NUMERIC,
+ AS: 'coins'
+ },
+ '$.email': {
+ type: SCHEMA_FIELD_TYPE.TAG,
+ AS: 'email'
+ }
+ }, {
+ ON: 'JSON',
+ PREFIX: 'noderedis:users'
+ });
+} catch (e) {
+ if (e.message === 'Index already exists') {
+ console.log('Index exists already, skipped creation.');
+ } else {
+ // Something went wrong, perhaps RediSearch isn't installed...
+ console.error(e);
+ process.exit(1);
+ }
+}
+
+// Add some users.
+// https://redis.io/commands/json.set/
+await Promise.all([
+ client.json.set('noderedis:users:1', '$', {
+ name: 'Alice',
+ age: 32,
+ coins: 100,
+ email: 'alice@nonexist.com'
+ }),
+ client.json.set('noderedis:users:2', '$', {
+ name: 'Bob',
+ age: 23,
+ coins: 15,
+ email: 'bob@somewhere.gov'
+ })
+]);
+
+// Search all users under 30
+console.log('Users under 30 years old:');
+console.log(
+ // https://redis.io/commands/ft.search/
+ JSON.stringify(
+ await client.ft.search('idx:users', '@age:[0 30]'),
+ null,
+ 2
+ )
+);
+// {
+// "total": 1,
+// "documents": [
+// {
+// "id": "noderedis:users:2",
+// "value": {
+// "name": "Bob",
+// "age": 23,
+// "coins": 15,
+// "email": "bob@somewhere.gov"
+// }
+// }
+// ]
+// }
+
+// Find a user by email - note we need to escape . and @ characters
+// in the email address. This applies for other punctuation too.
+// https://redis.io/docs/stack/search/reference/tags/#including-punctuation-in-tags
+console.log('Users with email "bob@somewhere.gov":');
+const emailAddress = 'bob@somewhere.gov'.replace(/[.@\\]/g, '\\$&');
+console.log(
+ JSON.stringify(
+ await client.ft.search('idx:users', `@email:{${emailAddress}}`),
+ null,
+ 2
+ )
+);
+// {
+// "total": 1,
+// "documents": [
+// {
+// "id": "noderedis:users:2",
+// "value": {
+// "name": "Bob",
+// "age": 23,
+// "coins": 15,
+// "email": "bob@somewhere.gov"
+// }
+// }
+// ]
+// }
+
+// Some aggregrations, what's the average age and total number of coins...
+// https://redis.io/commands/ft.aggregate/
+console.log('Aggregation Demo:');
+console.log(
+ JSON.stringify(
+ await client.ft.aggregate('idx:users', '*', {
+ STEPS: [{
+ type: FT_AGGREGATE_STEPS.GROUPBY,
+ REDUCE: [{
+ type: FT_AGGREGATE_GROUP_BY_REDUCERS.AVG,
+ property: 'age',
+ AS: 'averageAge'
+ }, {
+ type: FT_AGGREGATE_GROUP_BY_REDUCERS.SUM,
+ property: 'coins',
+ AS: 'totalCoins'
+ }]
+ }]
+ }),
+ null,
+ 2
+ )
+);
+// {
+// "total": 1,
+// "results": [
+// {
+// "averageAge": "27.5",
+// "totalCoins": "115"
+// }
+// ]
+// }
+
+client.destroy();
diff --git a/examples/search-knn.js b/examples/search-knn.js
new file mode 100644
index 00000000000..abfce990189
--- /dev/null
+++ b/examples/search-knn.js
@@ -0,0 +1,91 @@
+// This example demonstrates how to use RediSearch to index and query data
+// stored in Redis hashes using vector similarity search.
+//
+// Inspired by RediSearch Python tests:
+// https://github.com/RediSearch/RediSearch/blob/06e36d48946ea08bd0d8b76394a4e82eeb919d78/tests/pytests/test_vecsim.py#L96
+
+import { createClient, SCHEMA_FIELD_TYPE, SCHEMA_VECTOR_FIELD_ALGORITHM } from 'redis';
+
+const client = createClient();
+
+await client.connect();
+
+// Create an index...
+try {
+ // Documentation: https://redis.io/docs/stack/search/reference/vectors/
+ await client.ft.create('idx:knn-example', {
+ v: {
+ type: SCHEMA_FIELD_TYPE.VECTOR,
+ ALGORITHM: SCHEMA_VECTOR_FIELD_ALGORITHM.HNSW,
+ TYPE: 'FLOAT32',
+ DIM: 2,
+ DISTANCE_METRIC: 'COSINE'
+ }
+ }, {
+ ON: 'HASH',
+ PREFIX: 'noderedis:knn'
+ });
+} catch (e) {
+ if (e.message === 'Index already exists') {
+ console.log('Index exists already, skipped creation.');
+ } else {
+ // Something went wrong, perhaps RediSearch isn't installed...
+ console.error(e);
+ process.exit(1);
+ }
+}
+
+function float32Buffer(arr) {
+ return Buffer.from(new Float32Array(arr).buffer);
+}
+
+// Add some sample data...
+// https://redis.io/commands/hset/
+await Promise.all([
+ client.hSet('noderedis:knn:a', { v: float32Buffer([0.1, 0.1]) }),
+ client.hSet('noderedis:knn:b', { v: float32Buffer([0.1, 0.2]) }),
+ client.hSet('noderedis:knn:c', { v: float32Buffer([0.1, 0.3]) }),
+ client.hSet('noderedis:knn:d', { v: float32Buffer([0.1, 0.4]) }),
+]);
+// Perform a K-Nearest Neighbors vector similarity search
+// Documentation: https://redis.io/docs/stack/search/reference/vectors/#pure-knn-queries
+const results = await client.ft.search('idx:knn-example', '*=>[KNN 4 @v $BLOB AS dist]', {
+ PARAMS: {
+ BLOB: float32Buffer([0.1, 0.1])
+ },
+ SORTBY: 'dist',
+ DIALECT: 2,
+ RETURN: ['dist']
+});
+console.log(JSON.stringify(results, null, 2));
+// results:
+// {
+// "total": 4,
+// "documents": [
+// {
+// "id": "noderedis:knn:a",
+// "value": {
+// "dist": "5.96046447754e-08"
+// }
+// },
+// {
+// "id": "noderedis:knn:b",
+// "value": {
+// "dist": "0.0513167381287"
+// }
+// },
+// {
+// "id": "noderedis:knn:c",
+// "value": {
+// "dist": "0.10557281971"
+// }
+// },
+// {
+// "id": "noderedis:knn:d",
+// "value": {
+// "dist": "0.142507016659"
+// }
+// }
+// ]
+// }
+client.destroy();
diff --git a/examples/set-scan.js b/examples/set-scan.js
new file mode 100644
index 00000000000..698b05983b0
--- /dev/null
+++ b/examples/set-scan.js
@@ -0,0 +1,21 @@
+// An example script that shows how to use the SSCAN iterator functionality to retrieve the contents of a Redis set.
+// Create the set in redis-cli with this command:
+// sadd setName a b c d e f g h i j k l m n o p q
+
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+
+const setName = 'setName';
+
+for await (const members of client.sScanIterator(setName)) {
+ console.log('Batch of members:', members);
+
+ // Process each member in the batch if needed
+ for (const member of members) {
+ console.log('Individual member:', member);
+ }
+}
+
+client.close();
diff --git a/examples/simple.js b/examples/simple.js
deleted file mode 100644
index f1f2e3209b8..00000000000
--- a/examples/simple.js
+++ /dev/null
@@ -1,24 +0,0 @@
-var redis = require("redis"),
- client = redis.createClient();
-
-client.on("error", function (err) {
- console.log("error event - " + client.host + ":" + client.port + " - " + err);
-});
-
-client.set("string key", "string val", redis.print);
-client.hset("hash key", "hashtest 1", "some value", redis.print);
-client.hset(["hash key", "hashtest 2", "some other value"], redis.print);
-client.hkeys("hash key", function (err, replies) {
- if (err) {
- return console.error("error response - " + err);
- }
-
- console.log(replies.length + " replies:");
- replies.forEach(function (reply, i) {
- console.log(" " + i + ": " + reply);
- });
-});
-
-client.quit(function (err, res) {
- console.log("Exiting from quit command.");
-});
diff --git a/examples/sort.js b/examples/sort.js
deleted file mode 100644
index e7c6249e405..00000000000
--- a/examples/sort.js
+++ /dev/null
@@ -1,17 +0,0 @@
-var redis = require("redis"),
- client = redis.createClient();
-
-client.sadd("mylist", 1);
-client.sadd("mylist", 2);
-client.sadd("mylist", 3);
-
-client.set("weight_1", 5);
-client.set("weight_2", 500);
-client.set("weight_3", 1);
-
-client.set("object_1", "foo");
-client.set("object_2", "bar");
-client.set("object_3", "qux");
-
-client.sort("mylist", "by", "weight_*", "get", "object_*", redis.print);
-// Prints Reply: qux,foo,bar
\ No newline at end of file
diff --git a/examples/sorted-set.js b/examples/sorted-set.js
new file mode 100644
index 00000000000..830427bea9a
--- /dev/null
+++ b/examples/sorted-set.js
@@ -0,0 +1,53 @@
+// Add several values with their scores to a Sorted Set,
+// then retrieve them all using ZSCAN.
+
+import { createClient } from 'redis';
+
+const client = createClient();
+await client.connect();
+
+await client.zAdd('mysortedset', [
+ {
+ score: 99,
+ value: 'Ninety Nine'
+ },
+ {
+ score: 100,
+ value: 'One Hundred'
+ },
+ {
+ score: 101,
+ value: 'One Hundred and One'
+ }
+]);
+
+// Get all of the values/scores from the sorted set using
+// the scan approach:
+// https://redis.io/commands/zscan
+for await (const membersWithScores of client.zScanIterator('mysortedset')) {
+ console.log('Batch of members with scores:', membersWithScores);
+
+ for (const memberWithScore of membersWithScores) {
+ console.log('Individual member with score:', memberWithScore);
+ }
+}
+
+await client.zAdd('anothersortedset', [
+ {
+ score: 99,
+ value: 'Ninety Nine'
+ },
+ {
+ score: 102,
+ value: 'One Hundred and Two'
+ }
+]);
+
+// Intersection of two sorted sets
+const intersection = await client.zInter([
+ { key: 'mysortedset', weight: 1 },
+ { key: 'anothersortedset', weight: 1 }
+]);
+console.log('Intersection:', intersection);
+
+client.close();
diff --git a/examples/stream-consumer-group.js b/examples/stream-consumer-group.js
new file mode 100644
index 00000000000..cf82b5e96af
--- /dev/null
+++ b/examples/stream-consumer-group.js
@@ -0,0 +1,105 @@
+// A sample stream consumer using the blocking variant of XREADGROUP.
+// https://redis.io/commands/xreadgroup/
+
+// This consumer works in collaboration with other instances of itself
+// in the same consumer group such that the group as a whole receives
+// every entry from the stream.
+//
+// This consumes entries from a stream created by stream-producer.js
+//
+// Run this as follows:
+//
+// $ node stream-consumer-group.js
+//
+// Run multiple instances with different values of
+// to see them processing the stream as a group:
+//
+// $ node stream-consumer-group.js consumer1
+//
+// In another terminal:
+//
+// $ node stream-consumer-group.js consumer2
+
+import { createClient } from 'redis';
+
+const client = createClient();
+
+if (process.argv.length !== 3) {
+ console.log(`usage: node stream-consumer-group.js `);
+ process.exit(1);
+}
+
+const consumerName = process.argv[2];
+
+await client.connect();
+
+// Create the consumer group (and stream) if needed...
+try {
+ // https://redis.io/commands/xgroup-create/
+ await client.xGroupCreate('mystream', 'myconsumergroup', '0', {
+ MKSTREAM: true
+ });
+ console.log('Created consumer group.');
+} catch (e) {
+ console.log('Consumer group already exists, skipped creation.');
+}
+
+console.log(`Starting consumer ${consumerName}.`);
+
+const pool = client.createPool();
+
+while (true) {
+ try {
+ // https://redis.io/commands/xreadgroup/
+ let response = await pool.xReadGroup(
+ 'myconsumergroup',
+ consumerName, [
+ // XREADGROUP can read from multiple streams, starting at a
+ // different ID for each...
+ {
+ key: 'mystream',
+ id: '>' // Next entry ID that no consumer in this group has read
+ }
+ ], {
+ // Read 1 entry at a time, block for 5 seconds if there are none.
+ COUNT: 1,
+ BLOCK: 5000
+ }
+ );
+
+ if (response) {
+ // Response is an array of streams, each containing an array of
+ // entries:
+ //
+ // [
+ // {
+ // "name": "mystream",
+ // "messages": [
+ // {
+ // "id": "1642088708425-0",
+ // "message": {
+ // "num": "999"
+ // }
+ // }
+ // ]
+ // }
+ // ]
+ console.log(JSON.stringify(response));
+
+ // Use XACK to acknowledge successful processing of this
+ // stream entry.
+ // https://redis.io/commands/xack/
+ const entryId = response[0].messages[0].id;
+ const ackResult = await pool.xAck('mystream', 'myconsumergroup', entryId);
+
+ // ackResult will be 1 if the message was successfully acknowledged, 0 otherwise
+ console.log(`Acknowledged processing of entry ${entryId}. Result: ${ackResult}`);
+ } else {
+ // Response is null, we have read everything that is
+ // in the stream right now...
+ console.log('No new stream entries.');
+ }
+ } catch (err) {
+ console.error(err);
+ }
+}
diff --git a/examples/stream-consumer.js b/examples/stream-consumer.js
new file mode 100644
index 00000000000..3d5fc20fb43
--- /dev/null
+++ b/examples/stream-consumer.js
@@ -0,0 +1,61 @@
+// A sample stream consumer using the blocking variant of XREAD.
+// https://redis.io/commands/xread/
+// This consumes entries from a stream created by stream-producer.js
+
+import { createClient, commandOptions } from 'redis';
+
+const client = createClient();
+
+await client.connect();
+
+let currentId = '0-0'; // Start at lowest possible stream ID
+
+while (true) {
+ try {
+ let response = await client.xRead(
+ commandOptions({
+ isolated: true
+ }), [
+ // XREAD can read from multiple streams, starting at a
+ // different ID for each...
+ {
+ key: 'mystream',
+ id: currentId
+ }
+ ], {
+ // Read 1 entry at a time, block for 5 seconds if there are none.
+ COUNT: 1,
+ BLOCK: 5000
+ }
+ );
+
+ if (response) {
+ // Response is an array of streams, each containing an array of
+ // entries:
+ // [
+ // {
+ // "name": "mystream",
+ // "messages": [
+ // {
+ // "id": "1642088708425-0",
+ // "message": {
+ // "num": "999"
+ // }
+ // }
+ // ]
+ // }
+ // ]
+ console.log(JSON.stringify(response));
+
+ // Get the ID of the first (only) entry returned.
+ currentId = response[0].messages[0].id;
+ console.log(currentId);
+ } else {
+ // Response is null, we have read everything that is
+ // in the stream right now...
+ console.log('No new stream entries.');
+ }
+ } catch (err) {
+ console.error(err);
+ }
+}
diff --git a/examples/stream-producer.js b/examples/stream-producer.js
new file mode 100644
index 00000000000..113265dbd40
--- /dev/null
+++ b/examples/stream-producer.js
@@ -0,0 +1,50 @@
+// A sample stream producer using XADD.
+// https://redis.io/commands/xadd/
+import { createClient } from 'redis';
+
+const client = createClient();
+
+await client.connect();
+
+for (let i = 0; i < 10000; i++) {
+ await client.xAdd(
+ 'mystream',
+ '*', // * = Let Redis generate a timestamp ID for this new entry.
+ // Payload to add to the stream:
+ {
+ i: i.toString()
+ // Other name/value pairs can go here as required...
+ }
+ );
+
+ // Also add to a stream whose length we will cap at approximately
+ // 1000 entries using the MAXLEN trimming strategy:
+ // https://redis.io/commands/xadd/
+
+ await client.xAdd(
+ 'mytrimmedstream',
+ '*',
+ // Payload to add to the stream:
+ {
+ i: i.toString()
+ // Other name/value pairs can go here as required...
+ },
+ // Specify a trimming strategy...
+ {
+ TRIM: {
+ strategy: 'MAXLEN', // Trim by length.
+ strategyModifier: '~', // Approximate trimming.
+ threshold: 1000 // Retain around 1000 entries.
+ }
+ }
+ );
+}
+
+// Take a look at how many entries are in the streams...
+// https://redis.io/commands/xlen/
+// Should be 10000:
+console.log(`Length of mystream: ${await client.xLen('mystream')}.`);
+// Should be approximately 1000:
+console.log(`Length of mytrimmedstream: ${await client.xLen('mytrimmedstream')}.`);
+
+client.destroy();
diff --git a/examples/subqueries.js b/examples/subqueries.js
deleted file mode 100644
index 560db2404e1..00000000000
--- a/examples/subqueries.js
+++ /dev/null
@@ -1,15 +0,0 @@
-// Sending commands in response to other commands.
-// This example runs "type" against every key in the database
-//
-var client = require("redis").createClient();
-
-client.keys("*", function (err, keys) {
- keys.forEach(function (key, pos) {
- client.type(key, function (err, keytype) {
- console.log(key + " is " + keytype);
- if (pos === (keys.length - 1)) {
- client.quit();
- }
- });
- });
-});
diff --git a/examples/subquery.js b/examples/subquery.js
deleted file mode 100644
index 861657e1f3a..00000000000
--- a/examples/subquery.js
+++ /dev/null
@@ -1,19 +0,0 @@
-var client = require("redis").createClient();
-
-function print_results(obj) {
- console.dir(obj);
-}
-
-// build a map of all keys and their types
-client.keys("*", function (err, all_keys) {
- var key_types = {};
-
- all_keys.forEach(function (key, pos) { // use second arg of forEach to get pos
- client.type(key, function (err, type) {
- key_types[key] = type;
- if (pos === all_keys.length - 1) { // callbacks all run in order
- print_results(key_types);
- }
- });
- });
-});
diff --git a/examples/time-series.js b/examples/time-series.js
new file mode 100644
index 00000000000..75df2736f81
--- /dev/null
+++ b/examples/time-series.js
@@ -0,0 +1,122 @@
+// Add data to a Redis TimeSeries and query it.
+// Requires the RedisTimeSeries module: https://redis.io/docs/stack/timeseries/
+
+import { createClient } from 'redis';
+import { TIME_SERIES_DUPLICATE_POLICIES, TIME_SERIES_ENCODING, TIME_SERIES_AGGREGATION_TYPE } from '@redis/time-series';
+
+const client = createClient();
+
+await client.connect();
+await client.del('mytimeseries');
+
+try {
+ // Create a timeseries
+ // https://redis.io/commands/ts.create/
+ const created = await client.ts.create('mytimeseries', {
+ RETENTION: 86400000, // 1 day in milliseconds
+ ENCODING: TIME_SERIES_ENCODING.UNCOMPRESSED, // No compression
+ DUPLICATE_POLICY: TIME_SERIES_DUPLICATE_POLICIES.BLOCK // No duplicates
+ });
+
+ if (created === 'OK') {
+ console.log('Created timeseries.');
+ } else {
+ console.log('Error creating timeseries :(');
+ process.exit(1);
+ }
+
+ let value = Math.floor(Math.random() * 1000) + 1; // Random data point value
+ let currentTimestamp = 1640995200000; // Jan 1 2022 00:00:00
+ let num = 0;
+
+ while (num < 10000) {
+ // Add a new value to the timeseries, providing our own timestamp:
+ // https://redis.io/commands/ts.add/
+ await client.ts.add('mytimeseries', currentTimestamp, value);
+ console.log(`Added timestamp ${currentTimestamp}, value ${value}.`);
+
+ num += 1;
+ value = Math.floor(Math.random() * 1000) + 1; // Get another random value
+ currentTimestamp += 1000; // Move on one second.
+ }
+
+ // Add multiple values to the timeseries in round trip to the server:
+ // https://redis.io/commands/ts.madd/
+ const response = await client.ts.mAdd([{
+ key: 'mytimeseries',
+ timestamp: currentTimestamp + 60000,
+ value: Math.floor(Math.random() * 1000) + 1
+ }, {
+ key: 'mytimeseries',
+ timestamp: currentTimestamp + 120000,
+ value: Math.floor(Math.random() * 1000) + 1
+ }]);
+
+ // response = array of timestamps added by TS.MADD command.
+ if (response.length === 2) {
+ console.log('Added 2 entries to timeseries with TS.MADD.');
+ }
+
+ // Update timeseries retention with TS.ALTER:
+ // https://redis.io/commands/ts.alter/
+ const alterResponse = await client.ts.alter('mytimeseries', {
+ RETENTION: 0 // Keep the entries forever
+ });
+
+ if (alterResponse === 'OK') {
+ console.log('Timeseries retention settings altered successfully.');
+ }
+
+ // Query the timeseries with TS.RANGE:
+ // https://redis.io/commands/ts.range/
+ const fromTimestamp = 1640995200000; // Jan 1 2022 00:00:00
+ const toTimestamp = 1640995260000; // Jan 1 2022 00:01:00
+ const rangeResponse = await client.ts.range('mytimeseries', fromTimestamp, toTimestamp, {
+ // Group into 10 second averages.
+ AGGREGATION: {
+ type: TIME_SERIES_AGGREGATION_TYPE.AVG,
+ timeBucket: 10000
+ }
+ });
+
+ console.log('RANGE RESPONSE:');
+ // rangeResponse looks like:
+ // [
+ // { timestamp: 1640995200000, value: 356.8 },
+ // { timestamp: 1640995210000, value: 534.8 },
+ // { timestamp: 1640995220000, value: 481.3 },
+ // { timestamp: 1640995230000, value: 437 },
+ // { timestamp: 1640995240000, value: 507.3 },
+ // { timestamp: 1640995250000, value: 581.2 },
+ // { timestamp: 1640995260000, value: 600 }
+ // ]
+
+ console.log(rangeResponse);
+
+ // Get some information about the state of the timeseries.
+ // https://redis.io/commands/ts.info/
+ const tsInfo = await client.ts.info('mytimeseries');
+
+ // tsInfo looks like this:
+ // {
+ // totalSamples: 1440,
+ // memoryUsage: 28904,
+ // firstTimestamp: 1641508920000,
+ // lastTimestamp: 1641595320000,
+ // retentionTime: 86400000,
+ // chunkCount: 7,
+ // chunkSize: 4096,
+ // chunkType: 'uncompressed',
+ // duplicatePolicy: 'block',
+ // labels: [],
+ // sourceKey: null,
+ // rules: []
+ // }
+
+ console.log('Timeseries info:');
+ console.log(tsInfo);
+} catch (e) {
+ console.error(e);
+}
+
+client.close();
diff --git a/examples/topk.js b/examples/topk.js
new file mode 100644
index 00000000000..10cc29950ed
--- /dev/null
+++ b/examples/topk.js
@@ -0,0 +1,113 @@
+// This example demonstrates the use of the Top K
+// in the RedisBloom module (https://redis.io/docs/stack/bloom/)
+
+import { createClient } from 'redis';
+
+const client = createClient();
+
+await client.connect();
+
+// Delete any pre-existing Top K.
+await client.del('mytopk');
+
+// Reserve a Top K to track the 10 most common items.
+// https://redis.io/commands/topk.reserve/
+try {
+ await client.topK.reserve('mytopk', 10, { width: 400, depth: 10, decay: 0.9 });
+ console.log('Reserved Top K.');
+} catch (e) {
+ if (e.message.endsWith('key already exists')) {
+ console.log('Top K already reserved.');
+ } else {
+ console.log('Error, maybe RedisBloom is not installed?:');
+ console.log(e);
+ }
+}
+
+const teamMembers = [
+ 'leibale',
+ 'simon',
+ 'guy',
+ 'suze',
+ 'brian',
+ 'steve',
+ 'kyleb',
+ 'kyleo',
+ 'josefin',
+ 'alex',
+ 'nava',
+ 'lance',
+ 'rachel',
+ 'kaitlyn'
+];
+
+// Add random counts for random team members with TOPK.INCRBY
+// https://redis.io/commands/topk.incrby/
+for (let n = 0; n < 1000; n++) {
+ const teamMember = teamMembers[Math.floor(Math.random() * teamMembers.length)];
+ const points = Math.floor(Math.random() * 1000) + 1;
+ await client.topK.incrBy('mytopk', {
+ item: teamMember,
+ incrementBy: points
+ });
+ console.log(`Added ${points} points for ${teamMember}.`);
+}
+
+// List out the top 10 with TOPK.LIST
+// https://redis.io/commands/topk.list/
+const top10 = await client.topK.list('mytopk');
+console.log('The top 10:');
+// top10 looks like this:
+// [
+// 'guy', 'nava',
+// 'kaitlyn', 'brian',
+// 'simon', 'suze',
+// 'lance', 'alex',
+// 'steve', 'kyleo'
+// ]
+console.log(top10);
+
+// List out the top 10 with their counts (requires RedisBloom >=2.2.9)
+// https://redis.io/commands/topk.list/
+const top10WithCounts = await client.topK.listWithCount('mytopk');
+console.log('The top 10 with counts:');
+console.log(top10WithCounts);
+// top10WithCounts looks like this:
+// [
+// { item: 'suze', count: 42363 },
+// { item: 'lance', count: 41982 },
+// { item: 'simon', count: 41831 },
+// { item: 'steve', count: 39237 },
+// { item: 'guy', count: 39078 },
+// { item: 'kyleb', count: 37338 },
+// { item: 'leibale', count: 34230 },
+// { item: 'kyleo', count: 33812 },
+// { item: 'alex', count: 33679 },
+// { item: 'nava', count: 32663 }
+// ]
+
+// Check if a few team members are in the top 10 with TOPK.QUERY:
+// https://redis.io/commands/topk.query/
+const [ steve, suze, leibale, frederick ] = await client.topK.query('mytopk', [
+ 'steve',
+ 'suze',
+ 'leibale',
+ 'frederick'
+]);
+
+console.log(`steve ${steve ? 'is': 'is not'} in the top 10.`);
+console.log(`suze ${suze ? 'is': 'is not'} in the top 10.`);
+console.log(`leibale ${leibale ? 'is': 'is not'} in the top 10.`);
+console.log(`frederick ${frederick ? 'is': 'is not'} in the top 10.`);
+
+// Get count estimate for some team members with TOPK.COUNT:
+// https://redis.io/commands/topk.count/
+const [ simonCount, lanceCount ] = await client.topK.count('mytopk', [
+ 'simon',
+ 'lance'
+]);
+
+console.log(`Count estimate for simon: ${simonCount}.`);
+console.log(`Count estimate for lance: ${lanceCount}.`);
+
+client.close();
diff --git a/examples/transaction-with-arbitrary-commands.js b/examples/transaction-with-arbitrary-commands.js
new file mode 100644
index 00000000000..cc22a659678
--- /dev/null
+++ b/examples/transaction-with-arbitrary-commands.js
@@ -0,0 +1,51 @@
+// How to mix and match supported commands that have named functions with
+// commands sent as arbitrary strings in the same transaction context.
+// Use this when working with new Redis commands that haven't been added to
+// node-redis yet, or when working with commands that have been added to Redis
+// by modules other than those directly supported by node-redis.
+
+import { createClient } from 'redis';
+
+const client = createClient();
+
+await client.connect();
+
+// Build some data fixtures.
+await Promise.all([
+ client.hSet('hash1', { name: 'hash1', number: 1}),
+ client.hSet('hash2', { name: 'hash2', number: 1}),
+ client.hSet('hash3', { name: 'hash3', number: 3})
+]);
+
+// Outside of a transaction, use sendCommand to send arbitrary commands.
+await client.sendCommand(['hset', 'hash2', 'number', '3']);
+
+// In a transaction context, use addCommand to send arbitrary commands.
+// addCommand can be mixed and matched with named command functions as
+// shown.
+const multi = client.multi()
+ .hGetAll('hash2')
+ .addCommand(['hset', 'hash3', 'number', '4'])
+ .hGet('hash3', 'number');
+
+// exec() returns Array
+const responses = await multi.exec();
+
+// responses will be:
+// [ [Object: null prototype] { name: 'hash2', number: '3' }, 0, '4' ]
+console.log('Using exec():', responses);
+
+// This is equivalent to multi.exec<'typed'>()
+const typedResponses = await multi
+ .hGetAll('hash2')
+ .addCommand(['hset', 'hash3', 'number', '4'])
+ .hGet('hash3', 'number')
+ .execTyped();
+
+// typedResponses will have more specific types
+console.log('Using execTyped():', typedResponses);
+
+// Clean up fixtures.
+await client.del(['hash1', 'hash2', 'hash3']);
+
+client.close();
diff --git a/examples/transaction-with-watch.js b/examples/transaction-with-watch.js
new file mode 100644
index 00000000000..752d0b6a4e3
--- /dev/null
+++ b/examples/transaction-with-watch.js
@@ -0,0 +1,42 @@
+import { createClient, WatchError } from 'redis';
+
+const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+const client = createClient();
+await client.connect();
+
+function restrictFunctionCalls(fn, maxCalls) {
+ let count = 1;
+ return function (...args) {
+ return count++ < maxCalls ? fn(...args) : false;
+ };
+}
+
+const fn = restrictFunctionCalls(transaction, 4);
+
+const pool = await client.createPool();
+
+async function transaction() {
+ try {
+ await pool.execute(async (isolatedClient) => {
+ await isolatedClient.watch('paymentId:1259');
+ const multi = isolatedClient
+ .multi()
+ .set('paymentId:1259', 'Payment Successfully Completed!')
+ .set('paymentId:1260', 'Refund Processed Successfully!');
+ await delay(5000); // Do some changes to the watched key during this time...
+ await multi.exec();
+ console.log('Transaction completed Successfully!');
+ client.quit();
+ });
+ } catch (error) {
+ if (error instanceof WatchError) {
+ console.log('Transaction Failed Due To Concurrent Modification!');
+ fn();
+ } else {
+ console.log(`Error: ${error}`);
+ client.quit();
+ }
+ }
+}
+
+transaction();
diff --git a/examples/unix_socket.js b/examples/unix_socket.js
deleted file mode 100644
index 4a5e0bb0e84..00000000000
--- a/examples/unix_socket.js
+++ /dev/null
@@ -1,29 +0,0 @@
-var redis = require("redis"),
- client = redis.createClient("/tmp/redis.sock"),
- profiler = require("v8-profiler");
-
-client.on("connect", function () {
- console.log("Got Unix socket connection.")
-});
-
-client.on("error", function (err) {
- console.log(err.message);
-});
-
-client.set("space chars", "space value");
-
-setInterval(function () {
- client.get("space chars");
-}, 100);
-
-function done() {
- client.info(function (err, reply) {
- console.log(reply.toString());
- client.quit();
- });
-}
-
-setTimeout(function () {
- console.log("Taking snapshot.");
- var snap = profiler.takeSnapshot();
-}, 5000);
diff --git a/examples/web_server.js b/examples/web_server.js
deleted file mode 100644
index 9fd85923de1..00000000000
--- a/examples/web_server.js
+++ /dev/null
@@ -1,31 +0,0 @@
-// A simple web server that generates dyanmic content based on responses from Redis
-
-var http = require("http"), server,
- redis_client = require("redis").createClient();
-
-server = http.createServer(function (request, response) {
- response.writeHead(200, {
- "Content-Type": "text/plain"
- });
-
- var redis_info, total_requests;
-
- redis_client.info(function (err, reply) {
- redis_info = reply; // stash response in outer scope
- });
- redis_client.incr("requests", function (err, reply) {
- total_requests = reply; // stash response in outer scope
- });
- redis_client.hincrby("ip", request.connection.remoteAddress, 1);
- redis_client.hgetall("ip", function (err, reply) {
- // This is the last reply, so all of the previous replies must have completed already
- response.write("This page was generated after talking to redis.\n\n" +
- "Redis info:\n" + redis_info + "\n" +
- "Total requests: " + total_requests + "\n\n" +
- "IP count: \n");
- Object.keys(reply).forEach(function (ip) {
- response.write(" " + ip + ": " + reply[ip] + "\n");
- });
- response.end();
- });
-}).listen(80);
diff --git a/generate_commands.js b/generate_commands.js
deleted file mode 100644
index e6949d3a141..00000000000
--- a/generate_commands.js
+++ /dev/null
@@ -1,39 +0,0 @@
-var http = require("http"),
- fs = require("fs");
-
-function prettyCurrentTime() {
- var date = new Date();
- return date.toLocaleString();
-}
-
-function write_file(commands, path) {
- var file_contents, out_commands;
-
- console.log("Writing " + Object.keys(commands).length + " commands to " + path);
-
- file_contents = "// This file was generated by ./generate_commands.js on " + prettyCurrentTime() + "\n";
-
- out_commands = Object.keys(commands).map(function (key) {
- return key.toLowerCase();
- });
-
- file_contents += "module.exports = " + JSON.stringify(out_commands, null, " ") + ";\n";
-
- fs.writeFile(path, file_contents);
-}
-
-http.get({host: "redis.io", path: "/commands.json"}, function (res) {
- var body = "";
-
- console.log("Response from redis.io/commands.json: " + res.statusCode);
-
- res.on('data', function (chunk) {
- body += chunk;
- });
-
- res.on('end', function () {
- write_file(JSON.parse(body), "lib/commands.js");
- });
-}).on('error', function (e) {
- console.log("Error fetching command list from redis.io: " + e.message);
-});
diff --git a/index.js b/index.js
deleted file mode 100644
index 5c7799a8f83..00000000000
--- a/index.js
+++ /dev/null
@@ -1,1027 +0,0 @@
-/*global Buffer require exports console setTimeout */
-
-var net = require("net"),
- util = require("./lib/util"),
- Queue = require("./lib/queue"),
- to_array = require("./lib/to_array"),
- events = require("events"),
- parsers = [], commands,
- connection_id = 0,
- default_port = 6379,
- default_host = "127.0.0.1";
-
-// can set this to true to enable for all connections
-exports.debug_mode = false;
-
-// hiredis might not be installed
-try {
- require("./lib/parser/hiredis");
- parsers.push(require("./lib/parser/hiredis"));
-} catch (err) {
- if (exports.debug_mode) {
- console.warn("hiredis parser not installed.");
- }
-}
-
-parsers.push(require("./lib/parser/javascript"));
-
-function RedisClient(stream, options) {
- this.stream = stream;
- this.options = options = options || {};
-
- this.connection_id = ++connection_id;
- this.connected = false;
- this.ready = false;
- this.connections = 0;
- if (this.options.socket_nodelay === undefined) {
- this.options.socket_nodelay = true;
- }
- this.should_buffer = false;
- this.command_queue_high_water = this.options.command_queue_high_water || 1000;
- this.command_queue_low_water = this.options.command_queue_low_water || 0;
- this.max_attempts = null;
- if (options.max_attempts && !isNaN(options.max_attempts) && options.max_attempts > 0) {
- this.max_attempts = +options.max_attempts;
- }
- this.command_queue = new Queue(); // holds sent commands to de-pipeline them
- this.offline_queue = new Queue(); // holds commands issued but not able to be sent
- this.commands_sent = 0;
- this.connect_timeout = false;
- if (options.connect_timeout && !isNaN(options.connect_timeout) && options.connect_timeout > 0) {
- this.connect_timeout = +options.connect_timeout;
- }
- this.initialize_retry_vars();
- this.pub_sub_mode = false;
- this.subscription_set = {};
- this.monitoring = false;
- this.closing = false;
- this.server_info = {};
- this.auth_pass = null;
- this.parser_module = null;
- this.selected_db = null; // save the selected db here, used when reconnecting
-
- var self = this;
-
- this.stream.on("connect", function () {
- self.on_connect();
- });
-
- this.stream.on("data", function (buffer_from_socket) {
- self.on_data(buffer_from_socket);
- });
-
- this.stream.on("error", function (msg) {
- self.on_error(msg.message);
- });
-
- this.stream.on("close", function () {
- self.connection_gone("close");
- });
-
- this.stream.on("end", function () {
- self.connection_gone("end");
- });
-
- this.stream.on("drain", function () {
- self.should_buffer = false;
- self.emit("drain");
- });
-
- events.EventEmitter.call(this);
-}
-util.inherits(RedisClient, events.EventEmitter);
-exports.RedisClient = RedisClient;
-
-RedisClient.prototype.initialize_retry_vars = function () {
- this.retry_timer = null;
- this.retry_totaltime = 0;
- this.retry_delay = 150;
- this.retry_backoff = 1.7;
- this.attempts = 1;
-};
-
-// flush offline_queue and command_queue, erroring any items with a callback first
-RedisClient.prototype.flush_and_error = function (message) {
- var command_obj;
- while (this.offline_queue.length > 0) {
- command_obj = this.offline_queue.shift();
- if (typeof command_obj.callback === "function") {
- command_obj.callback(message);
- }
- }
- this.offline_queue = new Queue();
-
- while (this.command_queue.length > 0) {
- command_obj = this.command_queue.shift();
- if (typeof command_obj.callback === "function") {
- command_obj.callback(message);
- }
- }
- this.command_queue = new Queue();
-};
-
-RedisClient.prototype.on_error = function (msg) {
- var message = "Redis connection to " + this.host + ":" + this.port + " failed - " + msg,
- self = this, command_obj;
-
- if (this.closing) {
- return;
- }
-
- if (exports.debug_mode) {
- console.warn(message);
- }
-
- this.flush_and_error(message);
-
- this.connected = false;
- this.ready = false;
-
- this.emit("error", new Error(message));
- // "error" events get turned into exceptions if they aren't listened for. If the user handled this error
- // then we should try to reconnect.
- this.connection_gone("error");
-};
-
-RedisClient.prototype.do_auth = function () {
- var self = this;
-
- if (exports.debug_mode) {
- console.log("Sending auth to " + self.host + ":" + self.port + " id " + self.connection_id);
- }
- self.send_anyway = true;
- self.send_command("auth", [this.auth_pass], function (err, res) {
- if (err) {
- if (err.toString().match("LOADING")) {
- // if redis is still loading the db, it will not authenticate and everything else will fail
- console.log("Redis still loading, trying to authenticate later");
- setTimeout(function () {
- self.do_auth();
- }, 2000); // TODO - magic number alert
- return;
- } else {
- return self.emit("error", "Auth error: " + err);
- }
- }
- if (res.toString() !== "OK") {
- return self.emit("error", "Auth failed: " + res.toString());
- }
- if (exports.debug_mode) {
- console.log("Auth succeeded " + self.host + ":" + self.port + " id " + self.connection_id);
- }
- if (self.auth_callback) {
- self.auth_callback(err, res);
- self.auth_callback = null;
- }
-
- // now we are really connected
- self.emit("connect");
- if (self.options.no_ready_check) {
- self.on_ready();
- } else {
- self.ready_check();
- }
- });
- self.send_anyway = false;
-};
-
-RedisClient.prototype.on_connect = function () {
- if (exports.debug_mode) {
- console.log("Stream connected " + this.host + ":" + this.port + " id " + this.connection_id);
- }
- var self = this;
-
- this.connected = true;
- this.ready = false;
- this.attempts = 0;
- this.connections += 1;
- this.command_queue = new Queue();
- this.emitted_end = false;
- this.initialize_retry_vars();
- if (this.options.socket_nodelay) {
- this.stream.setNoDelay();
- }
- this.stream.setTimeout(0);
-
- this.init_parser();
-
- if (this.auth_pass) {
- this.do_auth();
- } else {
- this.emit("connect");
-
- if (this.options.no_ready_check) {
- this.on_ready();
- } else {
- this.ready_check();
- }
- }
-};
-
-RedisClient.prototype.init_parser = function () {
- var self = this;
-
- if (this.options.parser) {
- if (! parsers.some(function (parser) {
- if (parser.name === self.options.parser) {
- this.parser_module = parser;
- if (exports.debug_mode) {
- console.log("Using parser module: " + self.parser_module.name);
- }
- return true;
- }
- })) {
- throw new Error("Couldn't find named parser " + self.options.parser + " on this system");
- }
- } else {
- if (exports.debug_mode) {
- console.log("Using default parser module: " + parsers[0].name);
- }
- this.parser_module = parsers[0];
- }
-
- this.parser_module.debug_mode = exports.debug_mode;
-
- // return_buffers sends back Buffers from parser to callback. detect_buffers sends back Buffers from parser, but
- // converts to Strings if the input arguments are not Buffers.
- this.reply_parser = new this.parser_module.Parser({
- return_buffers: self.options.return_buffers || self.options.detect_buffers || false
- });
-
- // "reply error" is an error sent back by Redis
- this.reply_parser.on("reply error", function (reply) {
- self.return_error(new Error(reply));
- });
- this.reply_parser.on("reply", function (reply) {
- self.return_reply(reply);
- });
- // "error" is bad. Somehow the parser got confused. It'll try to reset and continue.
- this.reply_parser.on("error", function (err) {
- self.emit("error", new Error("Redis reply parser error: " + err.stack));
- });
-};
-
-RedisClient.prototype.on_ready = function () {
- var self = this;
-
- this.ready = true;
-
- // magically restore any modal commands from a previous connection
- if (this.selected_db !== null) {
- this.send_command('select', [this.selected_db]);
- }
- if (this.pub_sub_mode === true) {
- Object.keys(this.subscription_set).forEach(function (key) {
- var parts = key.split(" ");
- if (exports.debug_mode) {
- console.warn("sending pub/sub on_ready " + parts[0] + ", " + parts[1]);
- }
- self.send_command(parts[0], [parts[1]]);
- });
- } else if (this.monitoring) {
- this.send_command("monitor");
- } else {
- this.send_offline_queue();
- }
- this.emit("ready");
-};
-
-RedisClient.prototype.on_info_cmd = function (err, res) {
- var self = this, obj = {}, lines, retry_time;
-
- if (err) {
- return self.emit("error", "Ready check failed: " + err);
- }
-
- lines = res.toString().split("\r\n");
-
- lines.forEach(function (line) {
- var parts = line.split(':');
- if (parts[1]) {
- obj[parts[0]] = parts[1];
- }
- });
-
- obj.versions = [];
- obj.redis_version.split('.').forEach(function (num) {
- obj.versions.push(+num);
- });
-
- // expose info key/vals to users
- this.server_info = obj;
-
- if (!obj.loading || (obj.loading && obj.loading === "0")) {
- if (exports.debug_mode) {
- console.log("Redis server ready.");
- }
- this.on_ready();
- } else {
- retry_time = obj.loading_eta_seconds * 1000;
- if (retry_time > 1000) {
- retry_time = 1000;
- }
- if (exports.debug_mode) {
- console.log("Redis server still loading, trying again in " + retry_time);
- }
- setTimeout(function () {
- self.ready_check();
- }, retry_time);
- }
-};
-
-RedisClient.prototype.ready_check = function () {
- var self = this;
-
- if (exports.debug_mode) {
- console.log("checking server ready state...");
- }
-
- this.send_anyway = true; // secret flag to send_command to send something even if not "ready"
- this.info(function (err, res) {
- self.on_info_cmd(err, res);
- });
- this.send_anyway = false;
-};
-
-RedisClient.prototype.send_offline_queue = function () {
- var command_obj, buffered_writes = 0;
-
- while (this.offline_queue.length > 0) {
- command_obj = this.offline_queue.shift();
- if (exports.debug_mode) {
- console.log("Sending offline command: " + command_obj.command);
- }
- buffered_writes += !this.send_command(command_obj.command, command_obj.args, command_obj.callback);
- }
- this.offline_queue = new Queue();
- // Even though items were shifted off, Queue backing store still uses memory until next add, so just get a new Queue
-
- if (!buffered_writes) {
- this.should_buffer = false;
- this.emit("drain");
- }
-};
-
-RedisClient.prototype.connection_gone = function (why) {
- var self = this, message;
-
- // If a retry is already in progress, just let that happen
- if (this.retry_timer) {
- return;
- }
-
- if (exports.debug_mode) {
- console.warn("Redis connection is gone from " + why + " event.");
- }
- this.connected = false;
- this.ready = false;
-
- // since we are collapsing end and close, users don't expect to be called twice
- if (! this.emitted_end) {
- this.emit("end");
- this.emitted_end = true;
- }
-
- this.flush_and_error("Redis connection gone from " + why + " event.");
-
- // If this is a requested shutdown, then don't retry
- if (this.closing) {
- this.retry_timer = null;
- if (exports.debug_mode) {
- console.warn("connection ended from quit command, not retrying.");
- }
- return;
- }
-
- this.retry_delay = Math.floor(this.retry_delay * this.retry_backoff);
-
- if (exports.debug_mode) {
- console.log("Retry connection in " + this.current_retry_delay + " ms");
- }
-
- if (this.max_attempts && this.attempts >= this.max_attempts) {
- this.retry_timer = null;
- // TODO - some people need a "Redis is Broken mode" for future commands that errors immediately, and others
- // want the program to exit. Right now, we just log, which doesn't really help in either case.
- console.error("node_redis: Couldn't get Redis connection after " + this.max_attempts + " attempts.");
- return;
- }
-
- this.attempts += 1;
- this.emit("reconnecting", {
- delay: self.retry_delay,
- attempt: self.attempts
- });
- this.retry_timer = setTimeout(function () {
- if (exports.debug_mode) {
- console.log("Retrying connection...");
- }
-
- self.retry_totaltime += self.current_retry_delay;
-
- if (self.connect_timeout && self.retry_totaltime >= self.connect_timeout) {
- self.retry_timer = null;
- // TODO - engage Redis is Broken mode for future commands, or whatever
- console.error("node_redis: Couldn't get Redis connection after " + self.retry_totaltime + "ms.");
- return;
- }
-
- self.stream.connect(self.port, self.host);
- self.retry_timer = null;
- }, this.retry_delay);
-};
-
-RedisClient.prototype.on_data = function (data) {
- if (exports.debug_mode) {
- console.log("net read " + this.host + ":" + this.port + " id " + this.connection_id + ": " + data.toString());
- }
-
- try {
- this.reply_parser.execute(data);
- } catch (err) {
- // This is an unexpected parser problem, an exception that came from the parser code itself.
- // Parser should emit "error" events if it notices things are out of whack.
- // Callbacks that throw exceptions will land in return_reply(), below.
- // TODO - it might be nice to have a different "error" event for different types of errors
- this.emit("error", err);
- }
-};
-
-RedisClient.prototype.return_error = function (err) {
- var command_obj = this.command_queue.shift(), queue_len = this.command_queue.getLength();
-
- if (this.pub_sub_mode === false && queue_len === 0) {
- this.emit("idle");
- this.command_queue = new Queue();
- }
- if (this.should_buffer && queue_len <= this.command_queue_low_water) {
- this.emit("drain");
- this.should_buffer = false;
- }
-
- if (command_obj && typeof command_obj.callback === "function") {
- try {
- command_obj.callback(err);
- } catch (callback_err) {
- // if a callback throws an exception, re-throw it on a new stack so the parser can keep going
- process.nextTick(function () {
- throw callback_err;
- });
- }
- } else {
- console.log("node_redis: no callback to send error: " + err.message);
- // this will probably not make it anywhere useful, but we might as well throw
- process.nextTick(function () {
- throw err;
- });
- }
-};
-
-// if a callback throws an exception, re-throw it on a new stack so the parser can keep going.
-// put this try/catch in its own function because V8 doesn't optimize this well yet.
-function try_callback(callback, reply) {
- try {
- callback(null, reply);
- } catch (err) {
- process.nextTick(function () {
- throw err;
- });
- }
-}
-
-// hgetall converts its replies to an Object. If the reply is empty, null is returned.
-function reply_to_object(reply) {
- var obj = {}, j, jl, key, val;
-
- if (reply.length === 0) {
- return null;
- }
-
- for (j = 0, jl = reply.length; j < jl; j += 2) {
- key = reply[j].toString();
- val = reply[j + 1];
- obj[key] = val;
- }
-
- return obj;
-}
-
-function reply_to_strings(reply) {
- var i;
-
- if (Buffer.isBuffer(reply)) {
- return reply.toString();
- }
-
- if (Array.isArray(reply)) {
- for (i = 0; i < reply.length; i++) {
- reply[i] = reply[i].toString();
- }
- return reply;
- }
-
- return reply;
-}
-
-RedisClient.prototype.return_reply = function (reply) {
- var command_obj, obj, i, len, type, timestamp, argindex, args, queue_len;
-
- queue_len = this.command_queue.getLength();
-
- if (this.pub_sub_mode === false && queue_len === 0) {
- this.emit("idle");
- this.command_queue = new Queue(); // explicitly reclaim storage from old Queue
- }
- if (this.should_buffer && queue_len <= this.command_queue_low_water) {
- this.emit("drain");
- this.should_buffer = false;
- }
-
- command_obj = this.command_queue.shift();
-
- if (command_obj && !command_obj.sub_command) {
- if (typeof command_obj.callback === "function") {
- if (this.options.detect_buffers && command_obj.buffer_args === false) {
- // If detect_buffers option was specified, then the reply from the parser will be Buffers.
- // If this command did not use Buffer arguments, then convert the reply to Strings here.
- reply = reply_to_strings(reply);
- }
-
- // TODO - confusing and error-prone that hgetall is special cased in two places
- if (reply && 'hgetall' === command_obj.command.toLowerCase()) {
- reply = reply_to_object(reply);
- }
-
- try_callback(command_obj.callback, reply);
- } else if (exports.debug_mode) {
- console.log("no callback for reply: " + (reply && reply.toString && reply.toString()));
- }
- } else if (this.pub_sub_mode || (command_obj && command_obj.sub_command)) {
- if (Array.isArray(reply)) {
- type = reply[0].toString();
-
- if (type === "message") {
- this.emit("message", reply[1].toString(), reply[2]); // channel, message
- } else if (type === "pmessage") {
- this.emit("pmessage", reply[1].toString(), reply[2].toString(), reply[3]); // pattern, channel, message
- } else if (type === "subscribe" || type === "unsubscribe" || type === "psubscribe" || type === "punsubscribe") {
- if (reply[2] === 0) {
- this.pub_sub_mode = false;
- if (this.debug_mode) {
- console.log("All subscriptions removed, exiting pub/sub mode");
- }
- }
- // subscribe commands take an optional callback and also emit an event, but only the first response is included in the callback
- // TODO - document this or fix it so it works in a more obvious way
- if (command_obj && typeof command_obj.callback === "function") {
- try_callback(command_obj.callback, reply[1].toString());
- }
- this.emit(type, reply[1].toString(), reply[2]); // channel, count
- } else {
- throw new Error("subscriptions are active but got unknown reply type " + type);
- }
- } else if (! this.closing) {
- throw new Error("subscriptions are active but got an invalid reply: " + reply);
- }
- } else if (this.monitoring) {
- len = reply.indexOf(" ");
- timestamp = reply.slice(0, len);
- argindex = reply.indexOf('"');
- args = reply.slice(argindex + 1, -1).split('" "').map(function (elem) {
- return elem.replace(/\\"/g, '"');
- });
- this.emit("monitor", timestamp, args);
- } else {
- throw new Error("node_redis command queue state error. If you can reproduce this, please report it.");
- }
-};
-
-// This Command constructor is ever so slightly faster than using an object literal, but more importantly, using
-// a named constructor helps it show up meaningfully in the V8 CPU profiler and in heap snapshots.
-function Command(command, args, sub_command, buffer_args, callback) {
- this.command = command;
- this.args = args;
- this.sub_command = sub_command;
- this.buffer_args = buffer_args;
- this.callback = callback;
-}
-
-RedisClient.prototype.send_command = function (command, args, callback) {
- var arg, this_args, command_obj, i, il, elem_count, buffer_args, stream = this.stream, command_str = "", buffered_writes = 0, last_arg_type;
-
- if (typeof command !== "string") {
- throw new Error("First argument to send_command must be the command name string, not " + typeof command);
- }
-
- if (Array.isArray(args)) {
- if (typeof callback === "function") {
- // probably the fastest way:
- // client.command([arg1, arg2], cb); (straight passthrough)
- // send_command(command, [arg1, arg2], cb);
- } else if (! callback) {
- // most people find this variable argument length form more convenient, but it uses arguments, which is slower
- // client.command(arg1, arg2, cb); (wraps up arguments into an array)
- // send_command(command, [arg1, arg2, cb]);
- // client.command(arg1, arg2); (callback is optional)
- // send_command(command, [arg1, arg2]);
- // client.command(arg1, arg2, undefined); (callback is undefined)
- // send_command(command, [arg1, arg2, undefined]);
- last_arg_type = typeof args[args.length - 1];
- if (last_arg_type === "function" || last_arg_type === "undefined") {
- callback = args.pop();
- }
- } else {
- throw new Error("send_command: last argument must be a callback or undefined");
- }
- } else {
- throw new Error("send_command: second argument must be an array");
- }
-
- // if the last argument is an array, expand it out. This allows commands like this:
- // client.command(arg1, [arg2, arg3, arg4], cb);
- // and converts to:
- // client.command(arg1, arg2, arg3, arg4, cb);
- // which is convenient for some things like sadd
- if (args.length > 0 && Array.isArray(args[args.length - 1])) {
- args = args.slice(0, -1).concat(args[args.length - 1]);
- }
-
- buffer_args = false;
- for (i = 0, il = args.length, arg; i < il; i += 1) {
- if (Buffer.isBuffer(args[i])) {
- buffer_args = true;
- }
- }
-
- command_obj = new Command(command, args, false, buffer_args, callback);
-
- if ((!this.ready && !this.send_anyway) || !stream.writable) {
- if (exports.debug_mode) {
- if (!stream.writable) {
- console.log("send command: stream is not writeable.");
- }
-
- console.log("Queueing " + command + " for next server connection.");
- }
- this.offline_queue.push(command_obj);
- this.should_buffer = true;
- return false;
- }
-
- if (command === "subscribe" || command === "psubscribe" || command === "unsubscribe" || command === "punsubscribe") {
- this.pub_sub_command(command_obj);
- } else if (command === "monitor") {
- this.monitoring = true;
- } else if (command === "quit") {
- this.closing = true;
- } else if (this.pub_sub_mode === true) {
- throw new Error("Connection in pub/sub mode, only pub/sub commands may be used");
- }
- this.command_queue.push(command_obj);
- this.commands_sent += 1;
-
- elem_count = args.length + 1;
-
- // Always use "Multi bulk commands", but if passed any Buffer args, then do multiple writes, one for each arg.
- // This means that using Buffers in commands is going to be slower, so use Strings if you don't already have a Buffer.
-
- command_str = "*" + elem_count + "\r\n$" + command.length + "\r\n" + command + "\r\n";
-
- if (! buffer_args) { // Build up a string and send entire command in one write
- for (i = 0, il = args.length, arg; i < il; i += 1) {
- arg = args[i];
- if (typeof arg !== "string") {
- arg = String(arg);
- }
- command_str += "$" + Buffer.byteLength(arg) + "\r\n" + arg + "\r\n";
- }
- if (exports.debug_mode) {
- console.log("send " + this.host + ":" + this.port + " id " + this.connection_id + ": " + command_str);
- }
- buffered_writes += !stream.write(command_str);
- } else {
- if (exports.debug_mode) {
- console.log("send command (" + command_str + ") has Buffer arguments");
- }
- buffered_writes += !stream.write(command_str);
-
- for (i = 0, il = args.length, arg; i < il; i += 1) {
- arg = args[i];
- if (!(Buffer.isBuffer(arg) || arg instanceof String)) {
- arg = String(arg);
- }
-
- if (Buffer.isBuffer(arg)) {
- if (arg.length === 0) {
- if (exports.debug_mode) {
- console.log("send_command: using empty string for 0 length buffer");
- }
- buffered_writes += !stream.write("$0\r\n\r\n");
- } else {
- buffered_writes += !stream.write("$" + arg.length + "\r\n");
- buffered_writes += !stream.write(arg);
- buffered_writes += !stream.write("\r\n");
- if (exports.debug_mode) {
- console.log("send_command: buffer send " + arg.length + " bytes");
- }
- }
- } else {
- if (exports.debug_mode) {
- console.log("send_command: string send " + Buffer.byteLength(arg) + " bytes: " + arg);
- }
- buffered_writes += !stream.write("$" + Buffer.byteLength(arg) + "\r\n" + arg + "\r\n");
- }
- }
- }
- if (exports.debug_mode) {
- console.log("send_command buffered_writes: " + buffered_writes, " should_buffer: " + this.should_buffer);
- }
- if (buffered_writes || this.command_queue.getLength() >= this.command_queue_high_water) {
- this.should_buffer = true;
- }
- return !this.should_buffer;
-};
-
-RedisClient.prototype.pub_sub_command = function (command_obj) {
- var i, key, command, args;
-
- if (this.pub_sub_mode === false && exports.debug_mode) {
- console.log("Entering pub/sub mode from " + command_obj.command);
- }
- this.pub_sub_mode = true;
- command_obj.sub_command = true;
-
- command = command_obj.command;
- args = command_obj.args;
- if (command === "subscribe" || command === "psubscribe") {
- if (command === "subscribe") {
- key = "sub";
- } else {
- key = "psub";
- }
- for (i = 0; i < args.length; i++) {
- this.subscription_set[key + " " + args[i]] = true;
- }
- } else {
- if (command === "unsubscribe") {
- key = "sub";
- } else {
- key = "psub";
- }
- for (i = 0; i < args.length; i++) {
- delete this.subscription_set[key + " " + args[i]];
- }
- }
-};
-
-RedisClient.prototype.end = function () {
- this.stream._events = {};
- this.connected = false;
- this.ready = false;
- return this.stream.end();
-};
-
-function Multi(client, args) {
- this.client = client;
- this.queue = [["MULTI"]];
- if (Array.isArray(args)) {
- this.queue = this.queue.concat(args);
- }
-}
-
-exports.Multi = Multi;
-
-// take 2 arrays and return the union of their elements
-function set_union(seta, setb) {
- var obj = {};
-
- seta.forEach(function (val) {
- obj[val] = true;
- });
- setb.forEach(function (val) {
- obj[val] = true;
- });
- return Object.keys(obj);
-}
-
-// This static list of commands is updated from time to time. ./lib/commands.js can be updated with generate_commands.js
-commands = set_union(["get", "set", "setnx", "setex", "append", "strlen", "del", "exists", "setbit", "getbit", "setrange", "getrange", "substr",
- "incr", "decr", "mget", "rpush", "lpush", "rpushx", "lpushx", "linsert", "rpop", "lpop", "brpop", "brpoplpush", "blpop", "llen", "lindex",
- "lset", "lrange", "ltrim", "lrem", "rpoplpush", "sadd", "srem", "smove", "sismember", "scard", "spop", "srandmember", "sinter", "sinterstore",
- "sunion", "sunionstore", "sdiff", "sdiffstore", "smembers", "zadd", "zincrby", "zrem", "zremrangebyscore", "zremrangebyrank", "zunionstore",
- "zinterstore", "zrange", "zrangebyscore", "zrevrangebyscore", "zcount", "zrevrange", "zcard", "zscore", "zrank", "zrevrank", "hset", "hsetnx",
- "hget", "hmset", "hmget", "hincrby", "hdel", "hlen", "hkeys", "hvals", "hgetall", "hexists", "incrby", "decrby", "getset", "mset", "msetnx",
- "randomkey", "select", "move", "rename", "renamenx", "expire", "expireat", "keys", "dbsize", "auth", "ping", "echo", "save", "bgsave",
- "bgrewriteaof", "shutdown", "lastsave", "type", "multi", "exec", "discard", "sync", "flushdb", "flushall", "sort", "info", "monitor", "ttl",
- "persist", "slaveof", "debug", "config", "subscribe", "unsubscribe", "psubscribe", "punsubscribe", "publish", "watch", "unwatch", "cluster",
- "restore", "migrate", "dump", "object", "client", "eval", "evalsha"], require("./lib/commands"));
-
-commands.forEach(function (command) {
- RedisClient.prototype[command] = function (args, callback) {
- if (Array.isArray(args) && typeof callback === "function") {
- return this.send_command(command, args, callback);
- } else {
- return this.send_command(command, to_array(arguments));
- }
- };
- RedisClient.prototype[command.toUpperCase()] = RedisClient.prototype[command];
-
- Multi.prototype[command] = function () {
- this.queue.push([command].concat(to_array(arguments)));
- return this;
- };
- Multi.prototype[command.toUpperCase()] = Multi.prototype[command];
-});
-
-// store db in this.select_db to restore it on reconnect
-RedisClient.prototype.select = function (db, callback) {
- var self = this;
-
- this.send_command('select', [db], function (err, res) {
- if (err === null) {
- self.selected_db = db;
- }
- if (typeof(callback) === 'function') {
- callback(err, res);
- }
- });
-};
-RedisClient.prototype.SELECT = RedisClient.prototype.select;
-
-// Stash auth for connect and reconnect. Send immediately if already connected.
-RedisClient.prototype.auth = function () {
- var args = to_array(arguments);
- this.auth_pass = args[0];
- this.auth_callback = args[1];
- if (exports.debug_mode) {
- console.log("Saving auth as " + this.auth_pass);
- }
-
- if (this.connected) {
- this.send_command("auth", args);
- }
-};
-RedisClient.prototype.AUTH = RedisClient.prototype.auth;
-
-RedisClient.prototype.hmget = function (arg1, arg2, arg3) {
- if (Array.isArray(arg2) && typeof arg3 === "function") {
- return this.send_command("hmget", [arg1].concat(arg2), arg3);
- } else if (Array.isArray(arg1) && typeof arg2 === "function") {
- return this.send_command("hmget", arg1, arg2);
- } else {
- return this.send_command("hmget", to_array(arguments));
- }
-};
-RedisClient.prototype.HMGET = RedisClient.prototype.hmget;
-
-RedisClient.prototype.hmset = function (args, callback) {
- var tmp_args, tmp_keys, i, il, key;
-
- if (Array.isArray(args) && typeof callback === "function") {
- return this.send_command("hmset", args, callback);
- }
-
- args = to_array(arguments);
- if (typeof args[args.length - 1] === "function") {
- callback = args[args.length - 1];
- args.length -= 1;
- } else {
- callback = null;
- }
-
- if (args.length === 2 && typeof args[0] === "string" && typeof args[1] === "object") {
- // User does: client.hmset(key, {key1: val1, key2: val2})
- tmp_args = [ args[0] ];
- tmp_keys = Object.keys(args[1]);
- for (i = 0, il = tmp_keys.length; i < il ; i++) {
- key = tmp_keys[i];
- tmp_args.push(key);
- tmp_args.push(args[1][key]);
- }
- args = tmp_args;
- }
-
- return this.send_command("hmset", args, callback);
-};
-RedisClient.prototype.HMSET = RedisClient.prototype.hmset;
-
-Multi.prototype.hmset = function () {
- var args = to_array(arguments), tmp_args;
- if (args.length >= 2 && typeof args[0] === "string" && typeof args[1] === "object") {
- tmp_args = [ "hmset", args[0] ];
- Object.keys(args[1]).map(function (key) {
- tmp_args.push(key);
- tmp_args.push(args[1][key]);
- });
- if (args[2]) {
- tmp_args.push(args[2]);
- }
- args = tmp_args;
- } else {
- args.unshift("hmset");
- }
-
- this.queue.push(args);
- return this;
-};
-Multi.prototype.HMSET = Multi.prototype.hmset;
-
-Multi.prototype.exec = function (callback) {
- var self = this;
-
- // drain queue, callback will catch "QUEUED" or error
- // TODO - get rid of all of these anonymous functions which are elegant but slow
- this.queue.forEach(function (args, index) {
- var command = args[0], obj;
- if (typeof args[args.length - 1] === "function") {
- args = args.slice(1, -1);
- } else {
- args = args.slice(1);
- }
- if (args.length === 1 && Array.isArray(args[0])) {
- args = args[0];
- }
- if (command === 'hmset' && typeof args[1] === 'object') {
- obj = args.pop();
- Object.keys(obj).forEach(function (key) {
- args.push(key);
- args.push(obj[key]);
- });
- }
- this.client.send_command(command, args, function (err, reply) {
- if (err) {
- var cur = self.queue[index];
- if (typeof cur[cur.length - 1] === "function") {
- cur[cur.length - 1](err);
- } else {
- throw new Error(err);
- }
- self.queue.splice(index, 1);
- }
- });
- }, this);
-
- // TODO - make this callback part of Multi.prototype instead of creating it each time
- return this.client.send_command("EXEC", [], function (err, replies) {
- if (err) {
- if (callback) {
- callback(new Error(err));
- return;
- } else {
- throw new Error(err);
- }
- }
-
- var i, il, j, jl, reply, args;
-
- if (replies) {
- for (i = 1, il = self.queue.length; i < il; i += 1) {
- reply = replies[i - 1];
- args = self.queue[i];
-
- // TODO - confusing and error-prone that hgetall is special cased in two places
- if (reply && args[0].toLowerCase() === "hgetall") {
- replies[i - 1] = reply = reply_to_object(reply);
- }
-
- if (typeof args[args.length - 1] === "function") {
- args[args.length - 1](null, reply);
- }
- }
- }
-
- if (callback) {
- callback(null, replies);
- }
- });
-};
-
-RedisClient.prototype.multi = function (args) {
- return new Multi(this, args);
-};
-RedisClient.prototype.MULTI = function (args) {
- return new Multi(this, args);
-};
-
-exports.createClient = function (port_arg, host_arg, options) {
- var port = port_arg || default_port,
- host = host_arg || default_host,
- redis_client, net_client;
-
- net_client = net.createConnection(port, host);
-
- redis_client = new RedisClient(net_client, options);
-
- redis_client.port = port;
- redis_client.host = host;
-
- return redis_client;
-};
-
-exports.print = function (err, reply) {
- if (err) {
- console.log("Error: " + err);
- } else {
- console.log("Reply: " + reply);
- }
-};
diff --git a/lib/commands.js b/lib/commands.js
deleted file mode 100644
index 0293ae8d37b..00000000000
--- a/lib/commands.js
+++ /dev/null
@@ -1,126 +0,0 @@
-// This file was generated by ./generate_commands.js on Tue Jun 28 2011 22:37:02 GMT-0700 (PDT)
-module.exports = [
- "append",
- "auth",
- "bgrewriteaof",
- "bgsave",
- "blpop",
- "brpop",
- "brpoplpush",
- "config get",
- "config set",
- "config resetstat",
- "dbsize",
- "debug object",
- "debug segfault",
- "decr",
- "decrby",
- "del",
- "discard",
- "echo",
- "exec",
- "exists",
- "expire",
- "expireat",
- "flushall",
- "flushdb",
- "get",
- "getbit",
- "getrange",
- "getset",
- "hdel",
- "hexists",
- "hget",
- "hgetall",
- "hincrby",
- "hkeys",
- "hlen",
- "hmget",
- "hmset",
- "hset",
- "hsetnx",
- "hvals",
- "incr",
- "incrby",
- "info",
- "keys",
- "lastsave",
- "lindex",
- "linsert",
- "llen",
- "lpop",
- "lpush",
- "lpushx",
- "lrange",
- "lrem",
- "lset",
- "ltrim",
- "mget",
- "monitor",
- "move",
- "mset",
- "msetnx",
- "multi",
- "object",
- "persist",
- "ping",
- "psubscribe",
- "publish",
- "punsubscribe",
- "quit",
- "randomkey",
- "rename",
- "renamenx",
- "rpop",
- "rpoplpush",
- "rpush",
- "rpushx",
- "sadd",
- "save",
- "scard",
- "sdiff",
- "sdiffstore",
- "select",
- "set",
- "setbit",
- "setex",
- "setnx",
- "setrange",
- "shutdown",
- "sinter",
- "sinterstore",
- "sismember",
- "slaveof",
- "smembers",
- "smove",
- "sort",
- "spop",
- "srandmember",
- "srem",
- "strlen",
- "subscribe",
- "sunion",
- "sunionstore",
- "sync",
- "ttl",
- "type",
- "unsubscribe",
- "unwatch",
- "watch",
- "zadd",
- "zcard",
- "zcount",
- "zincrby",
- "zinterstore",
- "zrange",
- "zrangebyscore",
- "zrank",
- "zrem",
- "zremrangebyrank",
- "zremrangebyscore",
- "zrevrange",
- "zrevrangebyscore",
- "zrevrank",
- "zscore",
- "zunionstore"
-];
diff --git a/lib/parser/hiredis.js b/lib/parser/hiredis.js
deleted file mode 100644
index cbb15ba387e..00000000000
--- a/lib/parser/hiredis.js
+++ /dev/null
@@ -1,46 +0,0 @@
-/*global Buffer require exports console setTimeout */
-
-var events = require("events"),
- util = require("../util"),
- hiredis = require("hiredis");
-
-exports.debug_mode = false;
-exports.name = "hiredis";
-
-function HiredisReplyParser(options) {
- this.name = exports.name;
- this.options = options || {};
- this.reset();
- events.EventEmitter.call(this);
-}
-
-util.inherits(HiredisReplyParser, events.EventEmitter);
-
-exports.Parser = HiredisReplyParser;
-
-HiredisReplyParser.prototype.reset = function () {
- this.reader = new hiredis.Reader({
- return_buffers: this.options.return_buffers || false
- });
-};
-
-HiredisReplyParser.prototype.execute = function (data) {
- var reply;
- this.reader.feed(data);
- while (true) {
- try {
- reply = this.reader.get();
- } catch (err) {
- this.emit("error", err);
- break;
- }
-
- if (reply === undefined) break;
-
- if (reply && reply.constructor === Error) {
- this.emit("reply error", reply);
- } else {
- this.emit("reply", reply);
- }
- }
-};
diff --git a/lib/parser/javascript.js b/lib/parser/javascript.js
deleted file mode 100644
index b8f5bc68298..00000000000
--- a/lib/parser/javascript.js
+++ /dev/null
@@ -1,317 +0,0 @@
-/*global Buffer require exports console setTimeout */
-
-// TODO - incorporate these V8 pro tips:
-// pre-allocate Arrays if length is known in advance
-// do not use delete
-// use numbers for parser state
-
-var events = require("events"),
- util = require("../util");
-
-exports.debug_mode = false;
-exports.name = "javascript";
-
-function RedisReplyParser(options) {
- this.name = exports.name;
- this.options = options || {};
- this.reset();
- events.EventEmitter.call(this);
-}
-
-util.inherits(RedisReplyParser, events.EventEmitter);
-
-exports.Parser = RedisReplyParser;
-
-// Buffer.toString() is quite slow for small strings
-function small_toString(buf, len) {
- var tmp = "", i;
-
- for (i = 0; i < len; i += 1) {
- tmp += String.fromCharCode(buf[i]);
- }
-
- return tmp;
-}
-
-// Reset parser to it's original state.
-RedisReplyParser.prototype.reset = function () {
- this.return_buffer = new Buffer(16384); // for holding replies, might grow
- this.return_string = "";
- this.tmp_string = ""; // for holding size fields
-
- this.multi_bulk_length = 0;
- this.multi_bulk_replies = null;
- this.multi_bulk_pos = 0;
- this.multi_bulk_nested_length = 0;
- this.multi_bulk_nested_replies = null;
-
- this.states = {
- TYPE: 1,
- SINGLE_LINE: 2,
- MULTI_BULK_COUNT: 3,
- INTEGER_LINE: 4,
- BULK_LENGTH: 5,
- ERROR_LINE: 6,
- BULK_DATA: 7,
- UNKNOWN_TYPE: 8,
- FINAL_CR: 9,
- FINAL_LF: 10,
- MULTI_BULK_COUNT_LF: 11,
- BULK_LF: 12
- };
-
- this.state = this.states.TYPE;
-};
-
-RedisReplyParser.prototype.parser_error = function (message) {
- this.emit("error", message);
- this.reset();
-};
-
-RedisReplyParser.prototype.execute = function (incoming_buf) {
- var pos = 0, bd_tmp, bd_str, i, il, states = this.states;
- //, state_times = {}, start_execute = new Date(), start_switch, end_switch, old_state;
- //start_switch = new Date();
-
- while (pos < incoming_buf.length) {
- // old_state = this.state;
- // console.log("execute: " + this.state + ", " + pos + "/" + incoming_buf.length + ", " + String.fromCharCode(incoming_buf[pos]));
-
- switch (this.state) {
- case 1: // states.TYPE
- this.type = incoming_buf[pos];
- pos += 1;
-
- switch (this.type) {
- case 43: // +
- this.state = states.SINGLE_LINE;
- this.return_buffer.end = 0;
- this.return_string = "";
- break;
- case 42: // *
- this.state = states.MULTI_BULK_COUNT;
- this.tmp_string = "";
- break;
- case 58: // :
- this.state = states.INTEGER_LINE;
- this.return_buffer.end = 0;
- this.return_string = "";
- break;
- case 36: // $
- this.state = states.BULK_LENGTH;
- this.tmp_string = "";
- break;
- case 45: // -
- this.state = states.ERROR_LINE;
- this.return_buffer.end = 0;
- this.return_string = "";
- break;
- default:
- this.state = states.UNKNOWN_TYPE;
- }
- break;
- case 4: // states.INTEGER_LINE
- if (incoming_buf[pos] === 13) {
- this.send_reply(+small_toString(this.return_buffer, this.return_buffer.end));
- this.state = states.FINAL_LF;
- } else {
- this.return_buffer[this.return_buffer.end] = incoming_buf[pos];
- this.return_buffer.end += 1;
- }
- pos += 1;
- break;
- case 6: // states.ERROR_LINE
- if (incoming_buf[pos] === 13) {
- this.send_error(this.return_buffer.toString("ascii", 0, this.return_buffer.end));
- this.state = states.FINAL_LF;
- } else {
- this.return_buffer[this.return_buffer.end] = incoming_buf[pos];
- this.return_buffer.end += 1;
- }
- pos += 1;
- break;
- case 2: // states.SINGLE_LINE
- if (incoming_buf[pos] === 13) {
- this.send_reply(this.return_string);
- this.state = states.FINAL_LF;
- } else {
- this.return_string += String.fromCharCode(incoming_buf[pos]);
- }
- pos += 1;
- break;
- case 3: // states.MULTI_BULK_COUNT
- if (incoming_buf[pos] === 13) { // \r
- this.state = states.MULTI_BULK_COUNT_LF;
- } else {
- this.tmp_string += String.fromCharCode(incoming_buf[pos]);
- }
- pos += 1;
- break;
- case 11: // states.MULTI_BULK_COUNT_LF
- if (incoming_buf[pos] === 10) { // \n
- if (this.multi_bulk_length) { // nested multi-bulk
- this.multi_bulk_nested_length = this.multi_bulk_length;
- this.multi_bulk_nested_replies = this.multi_bulk_replies;
- this.multi_bulk_nested_pos = this.multi_bulk_pos;
- }
- this.multi_bulk_length = +this.tmp_string;
- this.multi_bulk_pos = 0;
- this.state = states.TYPE;
- if (this.multi_bulk_length < 0) {
- this.send_reply(null);
- this.multi_bulk_length = 0;
- } else if (this.multi_bulk_length === 0) {
- this.multi_bulk_pos = 0;
- this.multi_bulk_replies = null;
- this.send_reply([]);
- } else {
- this.multi_bulk_replies = new Array(this.multi_bulk_length);
- }
- } else {
- this.parser_error(new Error("didn't see LF after NL reading multi bulk count"));
- return;
- }
- pos += 1;
- break;
- case 5: // states.BULK_LENGTH
- if (incoming_buf[pos] === 13) { // \r
- this.state = states.BULK_LF;
- } else {
- this.tmp_string += String.fromCharCode(incoming_buf[pos]);
- }
- pos += 1;
- break;
- case 12: // states.BULK_LF
- if (incoming_buf[pos] === 10) { // \n
- this.bulk_length = +this.tmp_string;
- if (this.bulk_length === -1) {
- this.send_reply(null);
- this.state = states.TYPE;
- } else if (this.bulk_length === 0) {
- this.send_reply(new Buffer(""));
- this.state = states.FINAL_CR;
- } else {
- this.state = states.BULK_DATA;
- if (this.bulk_length > this.return_buffer.length) {
- if (exports.debug_mode) {
- console.log("Growing return_buffer from " + this.return_buffer.length + " to " + this.bulk_length);
- }
- this.return_buffer = new Buffer(this.bulk_length);
- }
- this.return_buffer.end = 0;
- }
- } else {
- this.parser_error(new Error("didn't see LF after NL while reading bulk length"));
- return;
- }
- pos += 1;
- break;
- case 7: // states.BULK_DATA
- this.return_buffer[this.return_buffer.end] = incoming_buf[pos];
- this.return_buffer.end += 1;
- pos += 1;
- if (this.return_buffer.end === this.bulk_length) {
- bd_tmp = new Buffer(this.bulk_length);
- // When the response is small, Buffer.copy() is a lot slower.
- if (this.bulk_length > 10) {
- this.return_buffer.copy(bd_tmp, 0, 0, this.bulk_length);
- } else {
- for (i = 0, il = this.bulk_length; i < il; i += 1) {
- bd_tmp[i] = this.return_buffer[i];
- }
- }
- this.send_reply(bd_tmp);
- this.state = states.FINAL_CR;
- }
- break;
- case 9: // states.FINAL_CR
- if (incoming_buf[pos] === 13) { // \r
- this.state = states.FINAL_LF;
- pos += 1;
- } else {
- this.parser_error(new Error("saw " + incoming_buf[pos] + " when expecting final CR"));
- return;
- }
- break;
- case 10: // states.FINAL_LF
- if (incoming_buf[pos] === 10) { // \n
- this.state = states.TYPE;
- pos += 1;
- } else {
- this.parser_error(new Error("saw " + incoming_buf[pos] + " when expecting final LF"));
- return;
- }
- break;
- default:
- this.parser_error(new Error("invalid state " + this.state));
- }
- // end_switch = new Date();
- // if (state_times[old_state] === undefined) {
- // state_times[old_state] = 0;
- // }
- // state_times[old_state] += (end_switch - start_switch);
- // start_switch = end_switch;
- }
- // console.log("execute ran for " + (Date.now() - start_execute) + " ms, on " + incoming_buf.length + " Bytes. ");
- // Object.keys(state_times).forEach(function (state) {
- // console.log(" " + state + ": " + state_times[state]);
- // });
-};
-
-RedisReplyParser.prototype.send_error = function (reply) {
- if (this.multi_bulk_length > 0 || this.multi_bulk_nested_length > 0) {
- // TODO - can this happen? Seems like maybe not.
- this.add_multi_bulk_reply(reply);
- } else {
- this.emit("reply error", reply);
- }
-};
-
-RedisReplyParser.prototype.send_reply = function (reply) {
- if (this.multi_bulk_length > 0 || this.multi_bulk_nested_length > 0) {
- if (!this.options.return_buffers && Buffer.isBuffer(reply)) {
- this.add_multi_bulk_reply(reply.toString("utf8"));
- } else {
- this.add_multi_bulk_reply(reply);
- }
- } else {
- if (!this.options.return_buffers && Buffer.isBuffer(reply)) {
- this.emit("reply", reply.toString("utf8"));
- } else {
- this.emit("reply", reply);
- }
- }
-};
-
-RedisReplyParser.prototype.add_multi_bulk_reply = function (reply) {
- if (this.multi_bulk_replies) {
- this.multi_bulk_replies[this.multi_bulk_pos] = reply;
- this.multi_bulk_pos += 1;
- if (this.multi_bulk_pos < this.multi_bulk_length) {
- return;
- }
- } else {
- this.multi_bulk_replies = reply;
- }
-
- if (this.multi_bulk_nested_length > 0) {
- this.multi_bulk_nested_replies[this.multi_bulk_nested_pos] = this.multi_bulk_replies;
- this.multi_bulk_nested_pos += 1;
-
- this.multi_bulk_length = 0;
- this.multi_bulk_replies = null;
- this.multi_bulk_pos = 0;
-
- if (this.multi_bulk_nested_length === this.multi_bulk_nested_pos) {
- this.emit("reply", this.multi_bulk_nested_replies);
- this.multi_bulk_nested_length = 0;
- this.multi_bulk_nested_pos = 0;
- this.multi_bulk_nested_replies = null;
- }
- } else {
- this.emit("reply", this.multi_bulk_replies);
- this.multi_bulk_length = 0;
- this.multi_bulk_replies = null;
- this.multi_bulk_pos = 0;
- }
-};
diff --git a/lib/queue.js b/lib/queue.js
deleted file mode 100644
index 56254e1ca40..00000000000
--- a/lib/queue.js
+++ /dev/null
@@ -1,61 +0,0 @@
-var to_array = require("./to_array");
-
-// Queue class adapted from Tim Caswell's pattern library
-// http://github.com/creationix/pattern/blob/master/lib/pattern/queue.js
-
-function Queue() {
- this.tail = [];
- this.head = [];
- this.offset = 0;
-}
-
-Queue.prototype.shift = function () {
- if (this.offset === this.head.length) {
- var tmp = this.head;
- tmp.length = 0;
- this.head = this.tail;
- this.tail = tmp;
- this.offset = 0;
- if (this.head.length === 0) {
- return;
- }
- }
- return this.head[this.offset++]; // sorry, JSLint
-};
-
-Queue.prototype.push = function (item) {
- return this.tail.push(item);
-};
-
-Queue.prototype.forEach = function (fn, thisv) {
- var array = this.head.slice(this.offset), i, il;
-
- array.push.apply(array, this.tail);
-
- if (thisv) {
- for (i = 0, il = array.length; i < il; i += 1) {
- fn.call(thisv, array[i], i, array);
- }
- } else {
- for (i = 0, il = array.length; i < il; i += 1) {
- fn(array[i], i, array);
- }
- }
-
- return array;
-};
-
-Queue.prototype.getLength = function () {
- return this.head.length - this.offset + this.tail.length;
-};
-
-Object.defineProperty(Queue.prototype, 'length', {
- get: function () {
- return this.getLength();
- }
-});
-
-
-if(typeof module !== 'undefined' && module.exports) {
- module.exports = Queue;
-}
diff --git a/lib/to_array.js b/lib/to_array.js
deleted file mode 100644
index 88a57e18a42..00000000000
--- a/lib/to_array.js
+++ /dev/null
@@ -1,12 +0,0 @@
-function to_array(args) {
- var len = args.length,
- arr = new Array(len), i;
-
- for (i = 0; i < len; i += 1) {
- arr[i] = args[i];
- }
-
- return arr;
-}
-
-module.exports = to_array;
diff --git a/lib/util.js b/lib/util.js
deleted file mode 100644
index fc255ae9536..00000000000
--- a/lib/util.js
+++ /dev/null
@@ -1,11 +0,0 @@
-// Support for very old versions of node where the module was called "sys". At some point, we should abandon this.
-
-var util;
-
-try {
- util = require("util");
-} catch (err) {
- util = require("sys");
-}
-
-module.exports = util;
diff --git a/multi_bench.js b/multi_bench.js
deleted file mode 100644
index 5be2e564fda..00000000000
--- a/multi_bench.js
+++ /dev/null
@@ -1,225 +0,0 @@
-var redis = require("./index"),
- metrics = require("metrics"),
- num_clients = parseInt(process.argv[2], 10) || 5,
- num_requests = 20000,
- tests = [],
- versions_logged = false,
- client_options = {
- return_buffers: false
- },
- small_str, large_str, small_buf, large_buf;
-
-redis.debug_mode = false;
-
-function lpad(input, len, chr) {
- var str = input.toString();
- chr = chr || " ";
-
- while (str.length < len) {
- str = chr + str;
- }
- return str;
-}
-
-metrics.Histogram.prototype.print_line = function () {
- var obj = this.printObj();
-
- return lpad(obj.min, 4) + "/" + lpad(obj.max, 4) + "/" + lpad(obj.mean.toFixed(2), 7) + "/" + lpad(obj.p95.toFixed(2), 7);
-};
-
-function Test(args) {
- var self = this;
-
- this.args = args;
-
- this.callback = null;
- this.clients = [];
- this.clients_ready = 0;
- this.commands_sent = 0;
- this.commands_completed = 0;
- this.max_pipeline = this.args.pipeline || num_requests;
- this.client_options = args.client_options || client_options;
-
- this.connect_latency = new metrics.Histogram();
- this.ready_latency = new metrics.Histogram();
- this.command_latency = new metrics.Histogram();
-}
-
-Test.prototype.run = function (callback) {
- var self = this, i;
-
- this.callback = callback;
-
- for (i = 0; i < num_clients ; i++) {
- this.new_client(i);
- }
-};
-
-Test.prototype.new_client = function (id) {
- var self = this, new_client;
-
- new_client = redis.createClient(6379, "127.0.0.1", this.client_options);
- new_client.create_time = Date.now();
-
- new_client.on("connect", function () {
- self.connect_latency.update(Date.now() - new_client.create_time);
- });
-
- new_client.on("ready", function () {
- if (! versions_logged) {
- console.log("Client count: " + num_clients + ", node version: " + process.versions.node + ", server version: " +
- new_client.server_info.redis_version + ", parser: " + new_client.reply_parser.name);
- versions_logged = true;
- }
- self.ready_latency.update(Date.now() - new_client.create_time);
- self.clients_ready++;
- if (self.clients_ready === self.clients.length) {
- self.on_clients_ready();
- }
- });
-
- self.clients[id] = new_client;
-};
-
-Test.prototype.on_clients_ready = function () {
- process.stdout.write(lpad(this.args.descr, 13) + ", " + lpad(this.args.pipeline, 5) + "/" + this.clients_ready + " ");
- this.test_start = Date.now();
-
- this.fill_pipeline();
-};
-
-Test.prototype.fill_pipeline = function () {
- var pipeline = this.commands_sent - this.commands_completed;
-
- while (this.commands_sent < num_requests && pipeline < this.max_pipeline) {
- this.commands_sent++;
- pipeline++;
- this.send_next();
- }
-
- if (this.commands_completed === num_requests) {
- this.print_stats();
- this.stop_clients();
- }
-};
-
-Test.prototype.stop_clients = function () {
- var self = this;
-
- this.clients.forEach(function (client, pos) {
- if (pos === self.clients.length - 1) {
- client.quit(function (err, res) {
- self.callback();
- });
- } else {
- client.quit();
- }
- });
-};
-
-Test.prototype.send_next = function () {
- var self = this,
- cur_client = this.commands_sent % this.clients.length,
- command_num = this.commands_sent,
- start = Date.now();
-
- this.clients[cur_client][this.args.command](this.args.args, function (err, res) {
- if (err) {
- throw err;
- }
- self.commands_completed++;
- self.command_latency.update(Date.now() - start);
- self.fill_pipeline();
- });
-};
-
-Test.prototype.print_stats = function () {
- var duration = Date.now() - this.test_start;
-
- console.log("min/max/avg/p95: " + this.command_latency.print_line() + " " + lpad(duration, 6) + "ms total, " +
- lpad((num_requests / (duration / 1000)).toFixed(2), 8) + " ops/sec");
-};
-
-small_str = "1234";
-small_buf = new Buffer(small_str);
-large_str = (new Array(4097).join("-"));
-large_buf = new Buffer(large_str);
-
-tests.push(new Test({descr: "PING", command: "ping", args: [], pipeline: 1}));
-tests.push(new Test({descr: "PING", command: "ping", args: [], pipeline: 50}));
-tests.push(new Test({descr: "PING", command: "ping", args: [], pipeline: 200}));
-tests.push(new Test({descr: "PING", command: "ping", args: [], pipeline: 20000}));
-
-tests.push(new Test({descr: "SET small str", command: "set", args: ["foo_rand000000000000", small_str], pipeline: 1}));
-tests.push(new Test({descr: "SET small str", command: "set", args: ["foo_rand000000000000", small_str], pipeline: 50}));
-tests.push(new Test({descr: "SET small str", command: "set", args: ["foo_rand000000000000", small_str], pipeline: 200}));
-tests.push(new Test({descr: "SET small str", command: "set", args: ["foo_rand000000000000", small_str], pipeline: 20000}));
-
-tests.push(new Test({descr: "SET small buf", command: "set", args: ["foo_rand000000000000", small_buf], pipeline: 1}));
-tests.push(new Test({descr: "SET small buf", command: "set", args: ["foo_rand000000000000", small_buf], pipeline: 50}));
-tests.push(new Test({descr: "SET small buf", command: "set", args: ["foo_rand000000000000", small_buf], pipeline: 200}));
-tests.push(new Test({descr: "SET small buf", command: "set", args: ["foo_rand000000000000", small_buf], pipeline: 20000}));
-
-tests.push(new Test({descr: "GET small str", command: "get", args: ["foo_rand000000000000"], pipeline: 1}));
-tests.push(new Test({descr: "GET small str", command: "get", args: ["foo_rand000000000000"], pipeline: 50}));
-tests.push(new Test({descr: "GET small str", command: "get", args: ["foo_rand000000000000"], pipeline: 200}));
-tests.push(new Test({descr: "GET small str", command: "get", args: ["foo_rand000000000000"], pipeline: 20000}));
-
-tests.push(new Test({descr: "GET small buf", command: "get", args: ["foo_rand000000000000"], pipeline: 1, client_opts: { return_buffers: true} }));
-tests.push(new Test({descr: "GET small buf", command: "get", args: ["foo_rand000000000000"], pipeline: 50, client_opts: { return_buffers: true} }));
-tests.push(new Test({descr: "GET small buf", command: "get", args: ["foo_rand000000000000"], pipeline: 200, client_opts: { return_buffers: true} }));
-tests.push(new Test({descr: "GET small buf", command: "get", args: ["foo_rand000000000000"], pipeline: 20000, client_opts: { return_buffers: true} }));
-
-tests.push(new Test({descr: "SET large str", command: "set", args: ["foo_rand000000000001", large_str], pipeline: 1}));
-tests.push(new Test({descr: "SET large str", command: "set", args: ["foo_rand000000000001", large_str], pipeline: 50}));
-tests.push(new Test({descr: "SET large str", command: "set", args: ["foo_rand000000000001", large_str], pipeline: 200}));
-tests.push(new Test({descr: "SET large str", command: "set", args: ["foo_rand000000000001", large_str], pipeline: 20000}));
-
-tests.push(new Test({descr: "SET large buf", command: "set", args: ["foo_rand000000000001", large_buf], pipeline: 1}));
-tests.push(new Test({descr: "SET large buf", command: "set", args: ["foo_rand000000000001", large_buf], pipeline: 50}));
-tests.push(new Test({descr: "SET large buf", command: "set", args: ["foo_rand000000000001", large_buf], pipeline: 200}));
-tests.push(new Test({descr: "SET large buf", command: "set", args: ["foo_rand000000000001", large_buf], pipeline: 20000}));
-
-tests.push(new Test({descr: "GET large str", command: "get", args: ["foo_rand000000000001"], pipeline: 1}));
-tests.push(new Test({descr: "GET large str", command: "get", args: ["foo_rand000000000001"], pipeline: 50}));
-tests.push(new Test({descr: "GET large str", command: "get", args: ["foo_rand000000000001"], pipeline: 200}));
-tests.push(new Test({descr: "GET large str", command: "get", args: ["foo_rand000000000001"], pipeline: 20000}));
-
-tests.push(new Test({descr: "GET large buf", command: "get", args: ["foo_rand000000000001"], pipeline: 1, client_opts: { return_buffers: true} }));
-tests.push(new Test({descr: "GET large buf", command: "get", args: ["foo_rand000000000001"], pipeline: 50, client_opts: { return_buffers: true} }));
-tests.push(new Test({descr: "GET large buf", command: "get", args: ["foo_rand000000000001"], pipeline: 200, client_opts: { return_buffers: true} }));
-tests.push(new Test({descr: "GET large buf", command: "get", args: ["foo_rand000000000001"], pipeline: 20000, client_opts: { return_buffers: true} }));
-
-tests.push(new Test({descr: "INCR", command: "incr", args: ["counter_rand000000000000"], pipeline: 1}));
-tests.push(new Test({descr: "INCR", command: "incr", args: ["counter_rand000000000000"], pipeline: 50}));
-tests.push(new Test({descr: "INCR", command: "incr", args: ["counter_rand000000000000"], pipeline: 200}));
-tests.push(new Test({descr: "INCR", command: "incr", args: ["counter_rand000000000000"], pipeline: 20000}));
-
-tests.push(new Test({descr: "LPUSH", command: "lpush", args: ["mylist", small_str], pipeline: 1}));
-tests.push(new Test({descr: "LPUSH", command: "lpush", args: ["mylist", small_str], pipeline: 50}));
-tests.push(new Test({descr: "LPUSH", command: "lpush", args: ["mylist", small_str], pipeline: 200}));
-tests.push(new Test({descr: "LPUSH", command: "lpush", args: ["mylist", small_str], pipeline: 20000}));
-
-tests.push(new Test({descr: "LRANGE 10", command: "lrange", args: ["mylist", "0", "9"], pipeline: 1}));
-tests.push(new Test({descr: "LRANGE 10", command: "lrange", args: ["mylist", "0", "9"], pipeline: 50}));
-tests.push(new Test({descr: "LRANGE 10", command: "lrange", args: ["mylist", "0", "9"], pipeline: 200}));
-tests.push(new Test({descr: "LRANGE 10", command: "lrange", args: ["mylist", "0", "9"], pipeline: 20000}));
-
-tests.push(new Test({descr: "LRANGE 100", command: "lrange", args: ["mylist", "0", "99"], pipeline: 1}));
-tests.push(new Test({descr: "LRANGE 100", command: "lrange", args: ["mylist", "0", "99"], pipeline: 50}));
-tests.push(new Test({descr: "LRANGE 100", command: "lrange", args: ["mylist", "0", "99"], pipeline: 200}));
-tests.push(new Test({descr: "LRANGE 100", command: "lrange", args: ["mylist", "0", "99"], pipeline: 20000}));
-
-function next() {
- var test = tests.shift();
- if (test) {
- test.run(function () {
- next();
- });
- } else {
- console.log("End of tests.");
- process.exit(0);
- }
-}
-
-next();
diff --git a/package-lock.json b/package-lock.json
new file mode 100644
index 00000000000..a95a6d1bff9
--- /dev/null
+++ b/package-lock.json
@@ -0,0 +1,7529 @@
+{
+ "name": "redis-monorepo",
+ "lockfileVersion": 3,
+ "requires": true,
+ "packages": {
+ "": {
+ "name": "redis-monorepo",
+ "workspaces": [
+ "./packages/client",
+ "./packages/test-utils",
+ "./packages/bloom",
+ "./packages/json",
+ "./packages/search",
+ "./packages/time-series",
+ "./packages/entraid",
+ "./packages/redis"
+ ],
+ "devDependencies": {
+ "@istanbuljs/nyc-config-typescript": "^1.0.2",
+ "@release-it/bumper": "^7.0.5",
+ "@types/mocha": "^10.0.6",
+ "@types/node": "^20.11.16",
+ "gh-pages": "^6.1.1",
+ "mocha": "^10.2.0",
+ "nyc": "^15.1.0",
+ "release-it": "^19.0.2",
+ "ts-node": "^10.9.2",
+ "tsx": "^4.7.0",
+ "typedoc": "^0.25.7",
+ "typescript": "^5.3.3"
+ }
+ },
+ "node_modules/@ampproject/remapping": {
+ "version": "2.2.1",
+ "dev": true,
+ "license": "Apache-2.0",
+ "dependencies": {
+ "@jridgewell/gen-mapping": "^0.3.0",
+ "@jridgewell/trace-mapping": "^0.3.9"
+ },
+ "engines": {
+ "node": ">=6.0.0"
+ }
+ },
+ "node_modules/@azure/abort-controller": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/@azure/abort-controller/-/abort-controller-2.1.2.tgz",
+ "integrity": "sha512-nBrLsEWm4J2u5LpAPjxADTlq3trDgVZZXHNKabeXZtpq3d3AbN/KGO82R87rdDz5/lYB024rtEf10/q0urNgsA==",
+ "license": "MIT",
+ "dependencies": {
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/core-auth": {
+ "version": "1.9.0",
+ "resolved": "https://registry.npmjs.org/@azure/core-auth/-/core-auth-1.9.0.tgz",
+ "integrity": "sha512-FPwHpZywuyasDSLMqJ6fhbOK3TqUdviZNF8OqRGA4W5Ewib2lEEZ+pBsYcBa88B2NGO/SEnYPGhyBqNlE8ilSw==",
+ "license": "MIT",
+ "dependencies": {
+ "@azure/abort-controller": "^2.0.0",
+ "@azure/core-util": "^1.11.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/core-client": {
+ "version": "1.9.2",
+ "resolved": "https://registry.npmjs.org/@azure/core-client/-/core-client-1.9.2.tgz",
+ "integrity": "sha512-kRdry/rav3fUKHl/aDLd/pDLcB+4pOFwPPTVEExuMyaI5r+JBbMWqRbCY1pn5BniDaU3lRxO9eaQ1AmSMehl/w==",
+ "license": "MIT",
+ "dependencies": {
+ "@azure/abort-controller": "^2.0.0",
+ "@azure/core-auth": "^1.4.0",
+ "@azure/core-rest-pipeline": "^1.9.1",
+ "@azure/core-tracing": "^1.0.0",
+ "@azure/core-util": "^1.6.1",
+ "@azure/logger": "^1.0.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/core-rest-pipeline": {
+ "version": "1.19.0",
+ "resolved": "https://registry.npmjs.org/@azure/core-rest-pipeline/-/core-rest-pipeline-1.19.0.tgz",
+ "integrity": "sha512-bM3308LRyg5g7r3Twprtqww0R/r7+GyVxj4BafcmVPo4WQoGt5JXuaqxHEFjw2o3rvFZcUPiqJMg6WuvEEeVUA==",
+ "license": "MIT",
+ "dependencies": {
+ "@azure/abort-controller": "^2.0.0",
+ "@azure/core-auth": "^1.8.0",
+ "@azure/core-tracing": "^1.0.1",
+ "@azure/core-util": "^1.11.0",
+ "@azure/logger": "^1.0.0",
+ "http-proxy-agent": "^7.0.0",
+ "https-proxy-agent": "^7.0.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/core-tracing": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/@azure/core-tracing/-/core-tracing-1.2.0.tgz",
+ "integrity": "sha512-UKTiEJPkWcESPYJz3X5uKRYyOcJD+4nYph+KpfdPRnQJVrZfk0KJgdnaAWKfhsBBtAf/D58Az4AvCJEmWgIBAg==",
+ "license": "MIT",
+ "dependencies": {
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/core-util": {
+ "version": "1.11.0",
+ "resolved": "https://registry.npmjs.org/@azure/core-util/-/core-util-1.11.0.tgz",
+ "integrity": "sha512-DxOSLua+NdpWoSqULhjDyAZTXFdP/LKkqtYuxxz1SCN289zk3OG8UOpnCQAz/tygyACBtWp/BoO72ptK7msY8g==",
+ "license": "MIT",
+ "dependencies": {
+ "@azure/abort-controller": "^2.0.0",
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/identity": {
+ "version": "4.7.0",
+ "resolved": "https://registry.npmjs.org/@azure/identity/-/identity-4.7.0.tgz",
+ "integrity": "sha512-6z/S2KorkbKaZ0DgZFVRdu7RCuATmMSTjKpuhj7YpjxkJ0vnJ7kTM3cpNgzFgk9OPYfZ31wrBEtC/iwAS4jQDA==",
+ "license": "MIT",
+ "dependencies": {
+ "@azure/abort-controller": "^2.0.0",
+ "@azure/core-auth": "^1.9.0",
+ "@azure/core-client": "^1.9.2",
+ "@azure/core-rest-pipeline": "^1.17.0",
+ "@azure/core-tracing": "^1.0.0",
+ "@azure/core-util": "^1.11.0",
+ "@azure/logger": "^1.0.0",
+ "@azure/msal-browser": "^4.2.0",
+ "@azure/msal-node": "^3.2.1",
+ "events": "^3.0.0",
+ "jws": "^4.0.0",
+ "open": "^10.1.0",
+ "stoppable": "^1.1.0",
+ "tslib": "^2.2.0"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/identity/node_modules/@azure/msal-common": {
+ "version": "15.2.0",
+ "resolved": "https://registry.npmjs.org/@azure/msal-common/-/msal-common-15.2.0.tgz",
+ "integrity": "sha512-HiYfGAKthisUYqHG1nImCf/uzcyS31wng3o+CycWLIM9chnYJ9Lk6jZ30Y6YiYYpTQ9+z/FGUpiKKekd3Arc0A==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.8.0"
+ }
+ },
+ "node_modules/@azure/identity/node_modules/@azure/msal-node": {
+ "version": "3.2.3",
+ "resolved": "https://registry.npmjs.org/@azure/msal-node/-/msal-node-3.2.3.tgz",
+ "integrity": "sha512-0eaPqBIWEAizeYiXdeHb09Iq0tvHJ17ztvNEaLdr/KcJJhJxbpkkEQf09DB+vKlFE0tzYi7j4rYLTXtES/InEQ==",
+ "license": "MIT",
+ "dependencies": {
+ "@azure/msal-common": "15.2.0",
+ "jsonwebtoken": "^9.0.0",
+ "uuid": "^8.3.0"
+ },
+ "engines": {
+ "node": ">=16"
+ }
+ },
+ "node_modules/@azure/identity/node_modules/jwa": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/jwa/-/jwa-2.0.0.tgz",
+ "integrity": "sha512-jrZ2Qx916EA+fq9cEAeCROWPTfCwi1IVHqT2tapuqLEVVDKFDENFw1oL+MwrTvH6msKxsd1YTDVw6uKEcsrLEA==",
+ "license": "MIT",
+ "dependencies": {
+ "buffer-equal-constant-time": "1.0.1",
+ "ecdsa-sig-formatter": "1.0.11",
+ "safe-buffer": "^5.0.1"
+ }
+ },
+ "node_modules/@azure/identity/node_modules/jws": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/jws/-/jws-4.0.0.tgz",
+ "integrity": "sha512-KDncfTmOZoOMTFG4mBlG0qUIOlc03fmzH+ru6RgYVZhPkyiy/92Owlt/8UEN+a4TXR1FQetfIpJE8ApdvdVxTg==",
+ "license": "MIT",
+ "dependencies": {
+ "jwa": "^2.0.0",
+ "safe-buffer": "^5.0.1"
+ }
+ },
+ "node_modules/@azure/logger": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/@azure/logger/-/logger-1.1.4.tgz",
+ "integrity": "sha512-4IXXzcCdLdlXuCG+8UKEwLA1T1NHqUfanhXYHiQTn+6sfWCZXduqbtXDGceg3Ce5QxTGo7EqmbV6Bi+aqKuClQ==",
+ "license": "MIT",
+ "dependencies": {
+ "tslib": "^2.6.2"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ }
+ },
+ "node_modules/@azure/msal-browser": {
+ "version": "4.4.0",
+ "resolved": "https://registry.npmjs.org/@azure/msal-browser/-/msal-browser-4.4.0.tgz",
+ "integrity": "sha512-rU6juYXk67CKQmpgi6fDgZoPQ9InZ1760z1BSAH7RbeIc4lHZM/Tu+H0CyRk7cnrfvTkexyYE4pjYhMghpzheA==",
+ "license": "MIT",
+ "dependencies": {
+ "@azure/msal-common": "15.2.0"
+ },
+ "engines": {
+ "node": ">=0.8.0"
+ }
+ },
+ "node_modules/@azure/msal-browser/node_modules/@azure/msal-common": {
+ "version": "15.2.0",
+ "resolved": "https://registry.npmjs.org/@azure/msal-common/-/msal-common-15.2.0.tgz",
+ "integrity": "sha512-HiYfGAKthisUYqHG1nImCf/uzcyS31wng3o+CycWLIM9chnYJ9Lk6jZ30Y6YiYYpTQ9+z/FGUpiKKekd3Arc0A==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.8.0"
+ }
+ },
+ "node_modules/@azure/msal-common": {
+ "version": "14.16.0",
+ "resolved": "https://registry.npmjs.org/@azure/msal-common/-/msal-common-14.16.0.tgz",
+ "integrity": "sha512-1KOZj9IpcDSwpNiQNjt0jDYZpQvNZay7QAEi/5DLubay40iGYtLzya/jbjRPLyOTZhEKyL1MzPuw2HqBCjceYA==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.8.0"
+ }
+ },
+ "node_modules/@azure/msal-node": {
+ "version": "2.16.2",
+ "resolved": "https://registry.npmjs.org/@azure/msal-node/-/msal-node-2.16.2.tgz",
+ "integrity": "sha512-An7l1hEr0w1HMMh1LU+rtDtqL7/jw74ORlc9Wnh06v7TU/xpG39/Zdr1ZJu3QpjUfKJ+E0/OXMW8DRSWTlh7qQ==",
+ "license": "MIT",
+ "dependencies": {
+ "@azure/msal-common": "14.16.0",
+ "jsonwebtoken": "^9.0.0",
+ "uuid": "^8.3.0"
+ },
+ "engines": {
+ "node": ">=16"
+ }
+ },
+ "node_modules/@babel/code-frame": {
+ "version": "7.23.5",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@babel/highlight": "^7.23.4",
+ "chalk": "^2.4.2"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/code-frame/node_modules/ansi-styles": {
+ "version": "3.2.1",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "color-convert": "^1.9.0"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/@babel/code-frame/node_modules/chalk": {
+ "version": "2.4.2",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ansi-styles": "^3.2.1",
+ "escape-string-regexp": "^1.0.5",
+ "supports-color": "^5.3.0"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/@babel/code-frame/node_modules/color-convert": {
+ "version": "1.9.3",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "color-name": "1.1.3"
+ }
+ },
+ "node_modules/@babel/code-frame/node_modules/color-name": {
+ "version": "1.1.3",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@babel/code-frame/node_modules/escape-string-regexp": {
+ "version": "1.0.5",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.8.0"
+ }
+ },
+ "node_modules/@babel/code-frame/node_modules/has-flag": {
+ "version": "3.0.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/@babel/code-frame/node_modules/supports-color": {
+ "version": "5.5.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "has-flag": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/@babel/compat-data": {
+ "version": "7.23.5",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/core": {
+ "version": "7.23.9",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@ampproject/remapping": "^2.2.0",
+ "@babel/code-frame": "^7.23.5",
+ "@babel/generator": "^7.23.6",
+ "@babel/helper-compilation-targets": "^7.23.6",
+ "@babel/helper-module-transforms": "^7.23.3",
+ "@babel/helpers": "^7.23.9",
+ "@babel/parser": "^7.23.9",
+ "@babel/template": "^7.23.9",
+ "@babel/traverse": "^7.23.9",
+ "@babel/types": "^7.23.9",
+ "convert-source-map": "^2.0.0",
+ "debug": "^4.1.0",
+ "gensync": "^1.0.0-beta.2",
+ "json5": "^2.2.3",
+ "semver": "^6.3.1"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/babel"
+ }
+ },
+ "node_modules/@babel/core/node_modules/convert-source-map": {
+ "version": "2.0.0",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@babel/generator": {
+ "version": "7.23.6",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@babel/types": "^7.23.6",
+ "@jridgewell/gen-mapping": "^0.3.2",
+ "@jridgewell/trace-mapping": "^0.3.17",
+ "jsesc": "^2.5.1"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/helper-compilation-targets": {
+ "version": "7.23.6",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@babel/compat-data": "^7.23.5",
+ "@babel/helper-validator-option": "^7.23.5",
+ "browserslist": "^4.22.2",
+ "lru-cache": "^5.1.1",
+ "semver": "^6.3.1"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/helper-environment-visitor": {
+ "version": "7.22.20",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/helper-function-name": {
+ "version": "7.23.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@babel/template": "^7.22.15",
+ "@babel/types": "^7.23.0"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/helper-hoist-variables": {
+ "version": "7.22.5",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@babel/types": "^7.22.5"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/helper-module-imports": {
+ "version": "7.22.15",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@babel/types": "^7.22.15"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/helper-module-transforms": {
+ "version": "7.23.3",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@babel/helper-environment-visitor": "^7.22.20",
+ "@babel/helper-module-imports": "^7.22.15",
+ "@babel/helper-simple-access": "^7.22.5",
+ "@babel/helper-split-export-declaration": "^7.22.6",
+ "@babel/helper-validator-identifier": "^7.22.20"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ },
+ "peerDependencies": {
+ "@babel/core": "^7.0.0"
+ }
+ },
+ "node_modules/@babel/helper-simple-access": {
+ "version": "7.22.5",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@babel/types": "^7.22.5"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/helper-split-export-declaration": {
+ "version": "7.22.6",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@babel/types": "^7.22.5"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/helper-string-parser": {
+ "version": "7.23.4",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/helper-validator-identifier": {
+ "version": "7.22.20",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/helper-validator-option": {
+ "version": "7.23.5",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/helpers": {
+ "version": "7.23.9",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@babel/template": "^7.23.9",
+ "@babel/traverse": "^7.23.9",
+ "@babel/types": "^7.23.9"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/highlight": {
+ "version": "7.23.4",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@babel/helper-validator-identifier": "^7.22.20",
+ "chalk": "^2.4.2",
+ "js-tokens": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/highlight/node_modules/ansi-styles": {
+ "version": "3.2.1",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "color-convert": "^1.9.0"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/@babel/highlight/node_modules/chalk": {
+ "version": "2.4.2",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ansi-styles": "^3.2.1",
+ "escape-string-regexp": "^1.0.5",
+ "supports-color": "^5.3.0"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/@babel/highlight/node_modules/color-convert": {
+ "version": "1.9.3",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "color-name": "1.1.3"
+ }
+ },
+ "node_modules/@babel/highlight/node_modules/color-name": {
+ "version": "1.1.3",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@babel/highlight/node_modules/escape-string-regexp": {
+ "version": "1.0.5",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.8.0"
+ }
+ },
+ "node_modules/@babel/highlight/node_modules/has-flag": {
+ "version": "3.0.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/@babel/highlight/node_modules/supports-color": {
+ "version": "5.5.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "has-flag": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/@babel/parser": {
+ "version": "7.23.9",
+ "dev": true,
+ "license": "MIT",
+ "bin": {
+ "parser": "bin/babel-parser.js"
+ },
+ "engines": {
+ "node": ">=6.0.0"
+ }
+ },
+ "node_modules/@babel/template": {
+ "version": "7.23.9",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@babel/code-frame": "^7.23.5",
+ "@babel/parser": "^7.23.9",
+ "@babel/types": "^7.23.9"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/traverse": {
+ "version": "7.23.9",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@babel/code-frame": "^7.23.5",
+ "@babel/generator": "^7.23.6",
+ "@babel/helper-environment-visitor": "^7.22.20",
+ "@babel/helper-function-name": "^7.23.0",
+ "@babel/helper-hoist-variables": "^7.22.5",
+ "@babel/helper-split-export-declaration": "^7.22.6",
+ "@babel/parser": "^7.23.9",
+ "@babel/types": "^7.23.9",
+ "debug": "^4.3.1",
+ "globals": "^11.1.0"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@babel/types": {
+ "version": "7.23.9",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@babel/helper-string-parser": "^7.23.4",
+ "@babel/helper-validator-identifier": "^7.22.20",
+ "to-fast-properties": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/@cspotcode/source-map-support": {
+ "version": "0.8.1",
+ "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz",
+ "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@jridgewell/trace-mapping": "0.3.9"
+ },
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@cspotcode/source-map-support/node_modules/@jridgewell/trace-mapping": {
+ "version": "0.3.9",
+ "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz",
+ "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@jridgewell/resolve-uri": "^3.0.3",
+ "@jridgewell/sourcemap-codec": "^1.4.10"
+ }
+ },
+ "node_modules/@esbuild/linux-x64": {
+ "version": "0.19.12",
+ "cpu": [
+ "x64"
+ ],
+ "dev": true,
+ "license": "MIT",
+ "optional": true,
+ "os": [
+ "linux"
+ ],
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/@iarna/toml": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/@iarna/toml/-/toml-3.0.0.tgz",
+ "integrity": "sha512-td6ZUkz2oS3VeleBcN+m//Q6HlCFCPrnI0FZhrt/h4XqLEdOyYp2u21nd8MdsR+WJy5r9PTDaHTDDfhf4H4l6Q==",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/@inquirer/checkbox": {
+ "version": "4.1.7",
+ "resolved": "https://registry.npmjs.org/@inquirer/checkbox/-/checkbox-4.1.7.tgz",
+ "integrity": "sha512-VEr2vnI4TSM2Q50fAck98mzWJGAoxbF0rb48tcSEjkJ2kn3mM6c/YsJwnyu45PlXd6aNWObMGWmQVleL2BJy6w==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@inquirer/core": "^10.1.12",
+ "@inquirer/figures": "^1.0.12",
+ "@inquirer/type": "^3.0.7",
+ "ansi-escapes": "^4.3.2",
+ "yoctocolors-cjs": "^2.1.2"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "peerDependencies": {
+ "@types/node": ">=18"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@inquirer/confirm": {
+ "version": "5.1.11",
+ "resolved": "https://registry.npmjs.org/@inquirer/confirm/-/confirm-5.1.11.tgz",
+ "integrity": "sha512-HgVha2B1lurfZ8u7cBWmu60HpkpnnIT/1IrreBx5g2oxQOVYU15WQDl6oZqjuXVbzteFKSpmMkLTMf2OmbUjaw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@inquirer/core": "^10.1.12",
+ "@inquirer/type": "^3.0.7"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "peerDependencies": {
+ "@types/node": ">=18"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@inquirer/core": {
+ "version": "10.1.12",
+ "resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.1.12.tgz",
+ "integrity": "sha512-uoaDadeJCYSVKYCMPwJi3AjCF9w+l9aWbHYA4iskKX84cVW/A2M6bJlWBoy3k81GpFp6EX3IElV1Z5xKw0g1QQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@inquirer/figures": "^1.0.12",
+ "@inquirer/type": "^3.0.7",
+ "ansi-escapes": "^4.3.2",
+ "cli-width": "^4.1.0",
+ "mute-stream": "^2.0.0",
+ "signal-exit": "^4.1.0",
+ "wrap-ansi": "^6.2.0",
+ "yoctocolors-cjs": "^2.1.2"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "peerDependencies": {
+ "@types/node": ">=18"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@inquirer/core/node_modules/signal-exit": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz",
+ "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==",
+ "dev": true,
+ "license": "ISC",
+ "engines": {
+ "node": ">=14"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/isaacs"
+ }
+ },
+ "node_modules/@inquirer/editor": {
+ "version": "4.2.12",
+ "resolved": "https://registry.npmjs.org/@inquirer/editor/-/editor-4.2.12.tgz",
+ "integrity": "sha512-YNOCY79iqI/ksWohdudGtnO02N/a2j82b6akK/+hy1/C6xoU07dsKFUBfQ36nLCxE98ICS74Uyandq7nBS31Mw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@inquirer/core": "^10.1.12",
+ "@inquirer/type": "^3.0.7",
+ "external-editor": "^3.1.0"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "peerDependencies": {
+ "@types/node": ">=18"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@inquirer/expand": {
+ "version": "4.0.14",
+ "resolved": "https://registry.npmjs.org/@inquirer/expand/-/expand-4.0.14.tgz",
+ "integrity": "sha512-aon4yACMp4Qwc/2f6xafcC6jzAJ5vXBwL5+z4bS2y4YIOGF+QOe+Jzd5hLz1hOo+bhzVS7q07dNXTeBjaFAqRA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@inquirer/core": "^10.1.12",
+ "@inquirer/type": "^3.0.7",
+ "yoctocolors-cjs": "^2.1.2"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "peerDependencies": {
+ "@types/node": ">=18"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@inquirer/figures": {
+ "version": "1.0.12",
+ "resolved": "https://registry.npmjs.org/@inquirer/figures/-/figures-1.0.12.tgz",
+ "integrity": "sha512-MJttijd8rMFcKJC8NYmprWr6hD3r9Gd9qUC0XwPNwoEPWSMVJwA2MlXxF+nhZZNMY+HXsWa+o7KY2emWYIn0jQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/@inquirer/input": {
+ "version": "4.1.11",
+ "resolved": "https://registry.npmjs.org/@inquirer/input/-/input-4.1.11.tgz",
+ "integrity": "sha512-gzcBWLWMiBaY507HFg4B1NJ18InnHhLjj4DTLfyoz9Rv7dSPpJ9JSj7Of8ea5QE2D+ms3ESTl/4MdzrC1//B0Q==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@inquirer/core": "^10.1.12",
+ "@inquirer/type": "^3.0.7"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "peerDependencies": {
+ "@types/node": ">=18"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@inquirer/number": {
+ "version": "3.0.14",
+ "resolved": "https://registry.npmjs.org/@inquirer/number/-/number-3.0.14.tgz",
+ "integrity": "sha512-8B4jX8ArK9zvb8/tB04jGLja4XoFfjvrTLJ5YeLlFnJh3jPa9VTQt2kxJZubGKc8YHX68e1XQxv4Nu/WZUnXIw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@inquirer/core": "^10.1.12",
+ "@inquirer/type": "^3.0.7"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "peerDependencies": {
+ "@types/node": ">=18"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@inquirer/password": {
+ "version": "4.0.14",
+ "resolved": "https://registry.npmjs.org/@inquirer/password/-/password-4.0.14.tgz",
+ "integrity": "sha512-/N/5PeI+QWE23dTn2D4erD9Y3yYeh0bUDkO9tt2d11mAVuCswiOKzoHrV9KYGQhoD6ae+Nff1G8TPqbfUUh8Ag==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@inquirer/core": "^10.1.12",
+ "@inquirer/type": "^3.0.7",
+ "ansi-escapes": "^4.3.2"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "peerDependencies": {
+ "@types/node": ">=18"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@inquirer/prompts": {
+ "version": "7.5.2",
+ "resolved": "https://registry.npmjs.org/@inquirer/prompts/-/prompts-7.5.2.tgz",
+ "integrity": "sha512-+jsUm6G9X5PUD97HkcGojzwyPsz5oSB2FUbj+D+NOYFQUj0XqvhDcDfk9mhMxFG/RDIgT9Kq4x0rm5pC5zVHUg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@inquirer/checkbox": "^4.1.7",
+ "@inquirer/confirm": "^5.1.11",
+ "@inquirer/editor": "^4.2.12",
+ "@inquirer/expand": "^4.0.14",
+ "@inquirer/input": "^4.1.11",
+ "@inquirer/number": "^3.0.14",
+ "@inquirer/password": "^4.0.14",
+ "@inquirer/rawlist": "^4.1.2",
+ "@inquirer/search": "^3.0.14",
+ "@inquirer/select": "^4.2.2"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "peerDependencies": {
+ "@types/node": ">=18"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@inquirer/rawlist": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/@inquirer/rawlist/-/rawlist-4.1.2.tgz",
+ "integrity": "sha512-VDuhV58w3FuKNl24GR9ygdbu3NkGfuaK7D2gyMWeY79Lr4GVbj7ySxw1isAnelSzU1ecZC/TwICa5rCy0za2OA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@inquirer/core": "^10.1.12",
+ "@inquirer/type": "^3.0.7",
+ "yoctocolors-cjs": "^2.1.2"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "peerDependencies": {
+ "@types/node": ">=18"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@inquirer/search": {
+ "version": "3.0.14",
+ "resolved": "https://registry.npmjs.org/@inquirer/search/-/search-3.0.14.tgz",
+ "integrity": "sha512-+VdtRD5nVR50K5fEMq/qbtHGH08vfqm69NJtojavlMXj6fsYymQZrNqjxEISPs2PDvtsemTJVFGs0uI6Zti6Dw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@inquirer/core": "^10.1.12",
+ "@inquirer/figures": "^1.0.12",
+ "@inquirer/type": "^3.0.7",
+ "yoctocolors-cjs": "^2.1.2"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "peerDependencies": {
+ "@types/node": ">=18"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@inquirer/select": {
+ "version": "4.2.2",
+ "resolved": "https://registry.npmjs.org/@inquirer/select/-/select-4.2.2.tgz",
+ "integrity": "sha512-3X8AAPE1WPUwY3IawT19BapD0kKpAUP7SVUu5mxmRjnl/f4q0MQz8CU8ToCC6Im0SzyOTWmSauE3GBgyOv1rBw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@inquirer/core": "^10.1.12",
+ "@inquirer/figures": "^1.0.12",
+ "@inquirer/type": "^3.0.7",
+ "ansi-escapes": "^4.3.2",
+ "yoctocolors-cjs": "^2.1.2"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "peerDependencies": {
+ "@types/node": ">=18"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@inquirer/type": {
+ "version": "3.0.7",
+ "resolved": "https://registry.npmjs.org/@inquirer/type/-/type-3.0.7.tgz",
+ "integrity": "sha512-PfunHQcjwnju84L+ycmcMKB/pTPIngjUJvfnRhKY6FKPuYXlM4aQCb/nIdTFR6BEhMjFvngzvng/vBAJMZpLSA==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=18"
+ },
+ "peerDependencies": {
+ "@types/node": ">=18"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/@istanbuljs/load-nyc-config": {
+ "version": "1.1.0",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "camelcase": "^5.3.1",
+ "find-up": "^4.1.0",
+ "get-package-type": "^0.1.0",
+ "js-yaml": "^3.13.1",
+ "resolve-from": "^5.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/@istanbuljs/load-nyc-config/node_modules/argparse": {
+ "version": "1.0.10",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "sprintf-js": "~1.0.2"
+ }
+ },
+ "node_modules/@istanbuljs/load-nyc-config/node_modules/find-up": {
+ "version": "4.1.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "locate-path": "^5.0.0",
+ "path-exists": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/@istanbuljs/load-nyc-config/node_modules/js-yaml": {
+ "version": "3.14.1",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "argparse": "^1.0.7",
+ "esprima": "^4.0.0"
+ },
+ "bin": {
+ "js-yaml": "bin/js-yaml.js"
+ }
+ },
+ "node_modules/@istanbuljs/load-nyc-config/node_modules/locate-path": {
+ "version": "5.0.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "p-locate": "^4.1.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/@istanbuljs/load-nyc-config/node_modules/p-limit": {
+ "version": "2.3.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "p-try": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/@istanbuljs/load-nyc-config/node_modules/p-locate": {
+ "version": "4.1.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "p-limit": "^2.2.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/@istanbuljs/nyc-config-typescript": {
+ "version": "1.0.2",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "@istanbuljs/schema": "^0.1.2"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "peerDependencies": {
+ "nyc": ">=15"
+ }
+ },
+ "node_modules/@istanbuljs/schema": {
+ "version": "0.1.3",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/@jridgewell/gen-mapping": {
+ "version": "0.3.3",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@jridgewell/set-array": "^1.0.1",
+ "@jridgewell/sourcemap-codec": "^1.4.10",
+ "@jridgewell/trace-mapping": "^0.3.9"
+ },
+ "engines": {
+ "node": ">=6.0.0"
+ }
+ },
+ "node_modules/@jridgewell/resolve-uri": {
+ "version": "3.1.1",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=6.0.0"
+ }
+ },
+ "node_modules/@jridgewell/set-array": {
+ "version": "1.1.2",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=6.0.0"
+ }
+ },
+ "node_modules/@jridgewell/sourcemap-codec": {
+ "version": "1.4.15",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@jridgewell/trace-mapping": {
+ "version": "0.3.22",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@jridgewell/resolve-uri": "^3.1.0",
+ "@jridgewell/sourcemap-codec": "^1.4.14"
+ }
+ },
+ "node_modules/@nodelib/fs.scandir": {
+ "version": "2.1.5",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz",
+ "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@nodelib/fs.stat": "2.0.5",
+ "run-parallel": "^1.1.9"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/@nodelib/fs.stat": {
+ "version": "2.0.5",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz",
+ "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/@nodelib/fs.walk": {
+ "version": "1.2.8",
+ "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz",
+ "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@nodelib/fs.scandir": "2.1.5",
+ "fastq": "^1.6.0"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/@nodeutils/defaults-deep": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/@nodeutils/defaults-deep/-/defaults-deep-1.1.0.tgz",
+ "integrity": "sha512-gG44cwQovaOFdSR02jR9IhVRpnDP64VN6JdjYJTfNz4J4fWn7TQnmrf22nSjRqlwlxPcW8PL/L3KbJg3tdwvpg==",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "lodash": "^4.15.0"
+ }
+ },
+ "node_modules/@octokit/auth-token": {
+ "version": "5.1.2",
+ "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-5.1.2.tgz",
+ "integrity": "sha512-JcQDsBdg49Yky2w2ld20IHAlwr8d/d8N6NiOXbtuoPCqzbsiJgF633mVUw3x4mo0H5ypataQIX7SFu3yy44Mpw==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 18"
+ }
+ },
+ "node_modules/@octokit/core": {
+ "version": "6.1.5",
+ "resolved": "https://registry.npmjs.org/@octokit/core/-/core-6.1.5.tgz",
+ "integrity": "sha512-vvmsN0r7rguA+FySiCsbaTTobSftpIDIpPW81trAmsv9TGxg3YCujAxRYp/Uy8xmDgYCzzgulG62H7KYUFmeIg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@octokit/auth-token": "^5.0.0",
+ "@octokit/graphql": "^8.2.2",
+ "@octokit/request": "^9.2.3",
+ "@octokit/request-error": "^6.1.8",
+ "@octokit/types": "^14.0.0",
+ "before-after-hook": "^3.0.2",
+ "universal-user-agent": "^7.0.0"
+ },
+ "engines": {
+ "node": ">= 18"
+ }
+ },
+ "node_modules/@octokit/endpoint": {
+ "version": "10.1.4",
+ "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-10.1.4.tgz",
+ "integrity": "sha512-OlYOlZIsfEVZm5HCSR8aSg02T2lbUWOsCQoPKfTXJwDzcHQBrVBGdGXb89dv2Kw2ToZaRtudp8O3ZIYoaOjKlA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@octokit/types": "^14.0.0",
+ "universal-user-agent": "^7.0.2"
+ },
+ "engines": {
+ "node": ">= 18"
+ }
+ },
+ "node_modules/@octokit/graphql": {
+ "version": "8.2.2",
+ "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-8.2.2.tgz",
+ "integrity": "sha512-Yi8hcoqsrXGdt0yObxbebHXFOiUA+2v3n53epuOg1QUgOB6c4XzvisBNVXJSl8RYA5KrDuSL2yq9Qmqe5N0ryA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@octokit/request": "^9.2.3",
+ "@octokit/types": "^14.0.0",
+ "universal-user-agent": "^7.0.0"
+ },
+ "engines": {
+ "node": ">= 18"
+ }
+ },
+ "node_modules/@octokit/openapi-types": {
+ "version": "25.0.0",
+ "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-25.0.0.tgz",
+ "integrity": "sha512-FZvktFu7HfOIJf2BScLKIEYjDsw6RKc7rBJCdvCTfKsVnx2GEB/Nbzjr29DUdb7vQhlzS/j8qDzdditP0OC6aw==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@octokit/plugin-paginate-rest": {
+ "version": "11.6.0",
+ "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-11.6.0.tgz",
+ "integrity": "sha512-n5KPteiF7pWKgBIBJSk8qzoZWcUkza2O6A0za97pMGVrGfPdltxrfmfF5GucHYvHGZD8BdaZmmHGz5cX/3gdpw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@octokit/types": "^13.10.0"
+ },
+ "engines": {
+ "node": ">= 18"
+ },
+ "peerDependencies": {
+ "@octokit/core": ">=6"
+ }
+ },
+ "node_modules/@octokit/plugin-paginate-rest/node_modules/@octokit/openapi-types": {
+ "version": "24.2.0",
+ "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-24.2.0.tgz",
+ "integrity": "sha512-9sIH3nSUttelJSXUrmGzl7QUBFul0/mB8HRYl3fOlgHbIWG+WnYDXU3v/2zMtAvuzZ/ed00Ei6on975FhBfzrg==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@octokit/plugin-paginate-rest/node_modules/@octokit/types": {
+ "version": "13.10.0",
+ "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.10.0.tgz",
+ "integrity": "sha512-ifLaO34EbbPj0Xgro4G5lP5asESjwHracYJvVaPIyXMuiuXLlhic3S47cBdTb+jfODkTE5YtGCLt3Ay3+J97sA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@octokit/openapi-types": "^24.2.0"
+ }
+ },
+ "node_modules/@octokit/plugin-request-log": {
+ "version": "5.3.1",
+ "resolved": "https://registry.npmjs.org/@octokit/plugin-request-log/-/plugin-request-log-5.3.1.tgz",
+ "integrity": "sha512-n/lNeCtq+9ofhC15xzmJCNKP2BWTv8Ih2TTy+jatNCCq/gQP/V7rK3fjIfuz0pDWDALO/o/4QY4hyOF6TQQFUw==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 18"
+ },
+ "peerDependencies": {
+ "@octokit/core": ">=6"
+ }
+ },
+ "node_modules/@octokit/plugin-rest-endpoint-methods": {
+ "version": "13.5.0",
+ "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-13.5.0.tgz",
+ "integrity": "sha512-9Pas60Iv9ejO3WlAX3maE1+38c5nqbJXV5GrncEfkndIpZrJ/WPMRd2xYDcPPEt5yzpxcjw9fWNoPhsSGzqKqw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@octokit/types": "^13.10.0"
+ },
+ "engines": {
+ "node": ">= 18"
+ },
+ "peerDependencies": {
+ "@octokit/core": ">=6"
+ }
+ },
+ "node_modules/@octokit/plugin-rest-endpoint-methods/node_modules/@octokit/openapi-types": {
+ "version": "24.2.0",
+ "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-24.2.0.tgz",
+ "integrity": "sha512-9sIH3nSUttelJSXUrmGzl7QUBFul0/mB8HRYl3fOlgHbIWG+WnYDXU3v/2zMtAvuzZ/ed00Ei6on975FhBfzrg==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@octokit/plugin-rest-endpoint-methods/node_modules/@octokit/types": {
+ "version": "13.10.0",
+ "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.10.0.tgz",
+ "integrity": "sha512-ifLaO34EbbPj0Xgro4G5lP5asESjwHracYJvVaPIyXMuiuXLlhic3S47cBdTb+jfODkTE5YtGCLt3Ay3+J97sA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@octokit/openapi-types": "^24.2.0"
+ }
+ },
+ "node_modules/@octokit/request": {
+ "version": "9.2.3",
+ "resolved": "https://registry.npmjs.org/@octokit/request/-/request-9.2.3.tgz",
+ "integrity": "sha512-Ma+pZU8PXLOEYzsWf0cn/gY+ME57Wq8f49WTXA8FMHp2Ps9djKw//xYJ1je8Hm0pR2lU9FUGeJRWOtxq6olt4w==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@octokit/endpoint": "^10.1.4",
+ "@octokit/request-error": "^6.1.8",
+ "@octokit/types": "^14.0.0",
+ "fast-content-type-parse": "^2.0.0",
+ "universal-user-agent": "^7.0.2"
+ },
+ "engines": {
+ "node": ">= 18"
+ }
+ },
+ "node_modules/@octokit/request-error": {
+ "version": "6.1.8",
+ "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-6.1.8.tgz",
+ "integrity": "sha512-WEi/R0Jmq+IJKydWlKDmryPcmdYSVjL3ekaiEL1L9eo1sUnqMJ+grqmC9cjk7CA7+b2/T397tO5d8YLOH3qYpQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@octokit/types": "^14.0.0"
+ },
+ "engines": {
+ "node": ">= 18"
+ }
+ },
+ "node_modules/@octokit/rest": {
+ "version": "21.1.1",
+ "resolved": "https://registry.npmjs.org/@octokit/rest/-/rest-21.1.1.tgz",
+ "integrity": "sha512-sTQV7va0IUVZcntzy1q3QqPm/r8rWtDCqpRAmb8eXXnKkjoQEtFe3Nt5GTVsHft+R6jJoHeSiVLcgcvhtue/rg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@octokit/core": "^6.1.4",
+ "@octokit/plugin-paginate-rest": "^11.4.2",
+ "@octokit/plugin-request-log": "^5.3.1",
+ "@octokit/plugin-rest-endpoint-methods": "^13.3.0"
+ },
+ "engines": {
+ "node": ">= 18"
+ }
+ },
+ "node_modules/@octokit/types": {
+ "version": "14.0.0",
+ "resolved": "https://registry.npmjs.org/@octokit/types/-/types-14.0.0.tgz",
+ "integrity": "sha512-VVmZP0lEhbo2O1pdq63gZFiGCKkm8PPp8AUOijlwPO6hojEVjspA0MWKP7E4hbvGxzFKNqKr6p0IYtOH/Wf/zA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@octokit/openapi-types": "^25.0.0"
+ }
+ },
+ "node_modules/@phun-ky/typeof": {
+ "version": "1.2.8",
+ "resolved": "https://registry.npmjs.org/@phun-ky/typeof/-/typeof-1.2.8.tgz",
+ "integrity": "sha512-7J6ca1tK0duM2BgVB+CuFMh3idlIVASOP2QvOCbNWDc6JnvjtKa9nufPoJQQ4xrwBonwgT1TIhRRcEtzdVgWsA==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": "^20.9.0 || >=22.0.0",
+ "npm": ">=10.8.2"
+ },
+ "funding": {
+ "url": "https://github.com/phun-ky/typeof?sponsor=1"
+ }
+ },
+ "node_modules/@redis/bloom": {
+ "resolved": "packages/bloom",
+ "link": true
+ },
+ "node_modules/@redis/client": {
+ "resolved": "packages/client",
+ "link": true
+ },
+ "node_modules/@redis/entraid": {
+ "resolved": "packages/entraid",
+ "link": true
+ },
+ "node_modules/@redis/json": {
+ "resolved": "packages/json",
+ "link": true
+ },
+ "node_modules/@redis/search": {
+ "resolved": "packages/search",
+ "link": true
+ },
+ "node_modules/@redis/test-utils": {
+ "resolved": "packages/test-utils",
+ "link": true
+ },
+ "node_modules/@redis/time-series": {
+ "resolved": "packages/time-series",
+ "link": true
+ },
+ "node_modules/@release-it/bumper": {
+ "version": "7.0.5",
+ "resolved": "https://registry.npmjs.org/@release-it/bumper/-/bumper-7.0.5.tgz",
+ "integrity": "sha512-HCFMqDHreLYg4jjTWL//pW1GzZZMn3p7HDbwS2y7y5m0L6p8hEaOEixC3tEzwyVV7VP1VGjqxMvxfa360q8+Tg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@iarna/toml": "^3.0.0",
+ "cheerio": "^1.0.0",
+ "detect-indent": "7.0.1",
+ "fast-glob": "^3.3.3",
+ "ini": "^5.0.0",
+ "js-yaml": "^4.1.0",
+ "lodash-es": "^4.17.21",
+ "semver": "^7.7.1"
+ },
+ "engines": {
+ "node": "^20.9.0 || >=22.0.0"
+ },
+ "peerDependencies": {
+ "release-it": ">=18.0.0 || >=19.0.0"
+ }
+ },
+ "node_modules/@release-it/bumper/node_modules/semver": {
+ "version": "7.7.2",
+ "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.2.tgz",
+ "integrity": "sha512-RF0Fw+rO5AMf9MAyaRXI4AV0Ulj5lMHqVxxdSgiVbixSCXoEmmX/jk0CuJw4+3SqroYO9VoUh+HcuJivvtJemA==",
+ "dev": true,
+ "license": "ISC",
+ "bin": {
+ "semver": "bin/semver.js"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/@sinonjs/commons": {
+ "version": "3.0.1",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "dependencies": {
+ "type-detect": "4.0.8"
+ }
+ },
+ "node_modules/@sinonjs/fake-timers": {
+ "version": "11.2.2",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "dependencies": {
+ "@sinonjs/commons": "^3.0.0"
+ }
+ },
+ "node_modules/@sinonjs/samsam": {
+ "version": "8.0.0",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "dependencies": {
+ "@sinonjs/commons": "^2.0.0",
+ "lodash.get": "^4.4.2",
+ "type-detect": "^4.0.8"
+ }
+ },
+ "node_modules/@sinonjs/samsam/node_modules/@sinonjs/commons": {
+ "version": "2.0.0",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "dependencies": {
+ "type-detect": "4.0.8"
+ }
+ },
+ "node_modules/@sinonjs/text-encoding": {
+ "version": "0.7.2",
+ "dev": true,
+ "license": "(Unlicense OR Apache-2.0)"
+ },
+ "node_modules/@tootallnate/quickjs-emscripten": {
+ "version": "0.23.0",
+ "resolved": "https://registry.npmjs.org/@tootallnate/quickjs-emscripten/-/quickjs-emscripten-0.23.0.tgz",
+ "integrity": "sha512-C5Mc6rdnsaJDjO3UpGW/CQTHtCKaYlScZTly4JIu97Jxo/odCiH0ITnDXSJPTOrEKk/ycSZ0AOgTmkDtkOsvIA==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@tsconfig/node10": {
+ "version": "1.0.11",
+ "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.11.tgz",
+ "integrity": "sha512-DcRjDCujK/kCk/cUe8Xz8ZSpm8mS3mNNpta+jGCA6USEDfktlNvm1+IuZ9eTcDbNk41BHwpHHeW+N1lKCz4zOw==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@tsconfig/node12": {
+ "version": "1.0.11",
+ "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz",
+ "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@tsconfig/node14": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz",
+ "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@tsconfig/node16": {
+ "version": "1.0.4",
+ "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.4.tgz",
+ "integrity": "sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@types/body-parser": {
+ "version": "1.19.5",
+ "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.5.tgz",
+ "integrity": "sha512-fB3Zu92ucau0iQ0JMCFQE7b/dv8Ot07NI3KaZIkIUNXq82k4eBAqUaneXfleGY9JWskeS9y+u0nXMyspcuQrCg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@types/connect": "*",
+ "@types/node": "*"
+ }
+ },
+ "node_modules/@types/connect": {
+ "version": "3.4.38",
+ "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.38.tgz",
+ "integrity": "sha512-K6uROf1LD88uDQqJCktA4yzL1YYAK6NgfsI0v/mTgyPKWsX1CnJ0XPSDhViejru1GcRkLWb8RlzFYJRqGUbaug==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@types/node": "*"
+ }
+ },
+ "node_modules/@types/express": {
+ "version": "4.17.21",
+ "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.21.tgz",
+ "integrity": "sha512-ejlPM315qwLpaQlQDTjPdsUFSc6ZsP4AN6AlWnogPjQ7CVi7PYF3YVz+CY3jE2pwYf7E/7HlDAN0rV2GxTG0HQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@types/body-parser": "*",
+ "@types/express-serve-static-core": "^4.17.33",
+ "@types/qs": "*",
+ "@types/serve-static": "*"
+ }
+ },
+ "node_modules/@types/express-serve-static-core": {
+ "version": "4.19.6",
+ "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.19.6.tgz",
+ "integrity": "sha512-N4LZ2xG7DatVqhCZzOGb1Yi5lMbXSZcmdLDe9EzSndPV2HpWYWzRbaerl2n27irrm94EPpprqa8KpskPT085+A==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@types/node": "*",
+ "@types/qs": "*",
+ "@types/range-parser": "*",
+ "@types/send": "*"
+ }
+ },
+ "node_modules/@types/express-session": {
+ "version": "1.18.1",
+ "resolved": "https://registry.npmjs.org/@types/express-session/-/express-session-1.18.1.tgz",
+ "integrity": "sha512-S6TkD/lljxDlQ2u/4A70luD8/ZxZcrU5pQwI1rVXCiaVIywoFgbA+PIUNDjPhQpPdK0dGleLtYc/y7XWBfclBg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@types/express": "*"
+ }
+ },
+ "node_modules/@types/http-errors": {
+ "version": "2.0.4",
+ "resolved": "https://registry.npmjs.org/@types/http-errors/-/http-errors-2.0.4.tgz",
+ "integrity": "sha512-D0CFMMtydbJAegzOyHjtiKPLlvnm3iTZyZRSZoLq2mRhDdmLfIWOCYPfQJ4cu2erKghU++QvjcUjp/5h7hESpA==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@types/mime": {
+ "version": "1.3.5",
+ "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.5.tgz",
+ "integrity": "sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@types/mocha": {
+ "version": "10.0.6",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@types/node": {
+ "version": "20.11.16",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "undici-types": "~5.26.4"
+ }
+ },
+ "node_modules/@types/parse-path": {
+ "version": "7.0.3",
+ "resolved": "https://registry.npmjs.org/@types/parse-path/-/parse-path-7.0.3.tgz",
+ "integrity": "sha512-LriObC2+KYZD3FzCrgWGv/qufdUy4eXrxcLgQMfYXgPbLIecKIsVBaQgUPmxSSLcjmYbDTQbMgr6qr6l/eb7Bg==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@types/qs": {
+ "version": "6.9.17",
+ "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.9.17.tgz",
+ "integrity": "sha512-rX4/bPcfmvxHDv0XjfJELTTr+iB+tn032nPILqHm5wbthUUUuVtNGGqzhya9XUxjTP8Fpr0qYgSZZKxGY++svQ==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@types/range-parser": {
+ "version": "1.2.7",
+ "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.7.tgz",
+ "integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@types/send": {
+ "version": "0.17.4",
+ "resolved": "https://registry.npmjs.org/@types/send/-/send-0.17.4.tgz",
+ "integrity": "sha512-x2EM6TJOybec7c52BX0ZspPodMsQUd5L6PRwOunVyVUhXiBSKf3AezDL8Dgvgt5o0UfKNfuA0eMLr2wLT4AiBA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@types/mime": "^1",
+ "@types/node": "*"
+ }
+ },
+ "node_modules/@types/serve-static": {
+ "version": "1.15.7",
+ "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.15.7.tgz",
+ "integrity": "sha512-W8Ym+h8nhuRwaKPaDw34QUkwsGi6Rc4yYqvKFo5rm2FUEhCFbzVWrxXUxuKK8TASjWsysJY0nsmNCGhCOIsrOw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@types/http-errors": "*",
+ "@types/node": "*",
+ "@types/send": "*"
+ }
+ },
+ "node_modules/@types/sinon": {
+ "version": "17.0.3",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@types/sinonjs__fake-timers": "*"
+ }
+ },
+ "node_modules/@types/sinonjs__fake-timers": {
+ "version": "8.1.5",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/@types/yargs": {
+ "version": "17.0.32",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@types/yargs-parser": "*"
+ }
+ },
+ "node_modules/@types/yargs-parser": {
+ "version": "21.0.3",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/accepts": {
+ "version": "1.3.8",
+ "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz",
+ "integrity": "sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "mime-types": "~2.1.34",
+ "negotiator": "0.6.3"
+ },
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/acorn": {
+ "version": "8.14.1",
+ "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.14.1.tgz",
+ "integrity": "sha512-OvQ/2pUDKmgfCg++xsTX1wGxfTaszcHVcTctW4UJB4hibJx2HXxxO5UmVgyjMa+ZDsiaf5wWLXYpRWMmBI0QHg==",
+ "dev": true,
+ "license": "MIT",
+ "bin": {
+ "acorn": "bin/acorn"
+ },
+ "engines": {
+ "node": ">=0.4.0"
+ }
+ },
+ "node_modules/acorn-walk": {
+ "version": "8.3.4",
+ "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.4.tgz",
+ "integrity": "sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "acorn": "^8.11.0"
+ },
+ "engines": {
+ "node": ">=0.4.0"
+ }
+ },
+ "node_modules/agent-base": {
+ "version": "7.1.3",
+ "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.3.tgz",
+ "integrity": "sha512-jRR5wdylq8CkOe6hei19GGZnxM6rBGwFl3Bg0YItGDimvjGtAvdZk4Pu6Cl4u4Igsws4a1fd1Vq3ezrhn4KmFw==",
+ "license": "MIT",
+ "engines": {
+ "node": ">= 14"
+ }
+ },
+ "node_modules/aggregate-error": {
+ "version": "3.1.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "clean-stack": "^2.0.0",
+ "indent-string": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/ansi-colors": {
+ "version": "4.1.1",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/ansi-escapes": {
+ "version": "4.3.2",
+ "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-4.3.2.tgz",
+ "integrity": "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "type-fest": "^0.21.3"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/ansi-escapes/node_modules/type-fest": {
+ "version": "0.21.3",
+ "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz",
+ "integrity": "sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==",
+ "dev": true,
+ "license": "(MIT OR CC0-1.0)",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/ansi-regex": {
+ "version": "5.0.1",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/ansi-sequence-parser": {
+ "version": "1.1.1",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/ansi-styles": {
+ "version": "4.3.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "color-convert": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/ansi-styles?sponsor=1"
+ }
+ },
+ "node_modules/anymatch": {
+ "version": "3.1.3",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "normalize-path": "^3.0.0",
+ "picomatch": "^2.0.4"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/append-transform": {
+ "version": "2.0.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "default-require-extensions": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/archy": {
+ "version": "1.0.0",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/arg": {
+ "version": "4.1.3",
+ "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz",
+ "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/argparse": {
+ "version": "2.0.1",
+ "dev": true,
+ "license": "Python-2.0"
+ },
+ "node_modules/array-flatten": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz",
+ "integrity": "sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/array-union": {
+ "version": "1.0.2",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "array-uniq": "^1.0.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/array-uniq": {
+ "version": "1.0.3",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/ast-types": {
+ "version": "0.13.4",
+ "resolved": "https://registry.npmjs.org/ast-types/-/ast-types-0.13.4.tgz",
+ "integrity": "sha512-x1FCFnFifvYDDzTaLII71vG5uvDwgtmDTEVWAxrgeiR8VjMONcCXJx7E+USjDtHlwFmt9MysbqgF9b9Vjr6w+w==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "tslib": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/async": {
+ "version": "3.2.5",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/async-retry": {
+ "version": "1.3.3",
+ "resolved": "https://registry.npmjs.org/async-retry/-/async-retry-1.3.3.tgz",
+ "integrity": "sha512-wfr/jstw9xNi/0teMHrRW7dsz3Lt5ARhYNZ2ewpadnhaIp5mbALhOAP+EAdsC7t4Z6wqsDVv9+W6gm1Dk9mEyw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "retry": "0.13.1"
+ }
+ },
+ "node_modules/balanced-match": {
+ "version": "1.0.2",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/basic-ftp": {
+ "version": "5.0.5",
+ "resolved": "https://registry.npmjs.org/basic-ftp/-/basic-ftp-5.0.5.tgz",
+ "integrity": "sha512-4Bcg1P8xhUuqcii/S0Z9wiHIrQVPMermM1any+MX5GeGD7faD3/msQUDGLol9wOcz4/jbg/WJnGqoJF6LiBdtg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=10.0.0"
+ }
+ },
+ "node_modules/before-after-hook": {
+ "version": "3.0.2",
+ "resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-3.0.2.tgz",
+ "integrity": "sha512-Nik3Sc0ncrMK4UUdXQmAnRtzmNQTAAXmXIopizwZ1W1t8QmfJj+zL4OA2I7XPTPW5z5TDqv4hRo/JzouDJnX3A==",
+ "dev": true,
+ "license": "Apache-2.0"
+ },
+ "node_modules/binary-extensions": {
+ "version": "2.2.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/body-parser": {
+ "version": "1.20.3",
+ "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.3.tgz",
+ "integrity": "sha512-7rAxByjUMqQ3/bHJy7D6OGXvx/MMc4IqBn/X0fcM1QUcAItpZrBEYhWGem+tzXH90c+G01ypMcYJBO9Y30203g==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "bytes": "3.1.2",
+ "content-type": "~1.0.5",
+ "debug": "2.6.9",
+ "depd": "2.0.0",
+ "destroy": "1.2.0",
+ "http-errors": "2.0.0",
+ "iconv-lite": "0.4.24",
+ "on-finished": "2.4.1",
+ "qs": "6.13.0",
+ "raw-body": "2.5.2",
+ "type-is": "~1.6.18",
+ "unpipe": "1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.8",
+ "npm": "1.2.8000 || >= 1.4.16"
+ }
+ },
+ "node_modules/body-parser/node_modules/debug": {
+ "version": "2.6.9",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz",
+ "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ms": "2.0.0"
+ }
+ },
+ "node_modules/body-parser/node_modules/ms": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
+ "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/boolbase": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz",
+ "integrity": "sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww==",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/brace-expansion": {
+ "version": "1.1.11",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "balanced-match": "^1.0.0",
+ "concat-map": "0.0.1"
+ }
+ },
+ "node_modules/braces": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz",
+ "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "fill-range": "^7.1.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/browser-stdout": {
+ "version": "1.3.1",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/browserslist": {
+ "version": "4.22.3",
+ "dev": true,
+ "funding": [
+ {
+ "type": "opencollective",
+ "url": "https://opencollective.com/browserslist"
+ },
+ {
+ "type": "tidelift",
+ "url": "https://tidelift.com/funding/github/npm/browserslist"
+ },
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/ai"
+ }
+ ],
+ "license": "MIT",
+ "dependencies": {
+ "caniuse-lite": "^1.0.30001580",
+ "electron-to-chromium": "^1.4.648",
+ "node-releases": "^2.0.14",
+ "update-browserslist-db": "^1.0.13"
+ },
+ "bin": {
+ "browserslist": "cli.js"
+ },
+ "engines": {
+ "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7"
+ }
+ },
+ "node_modules/buffer-equal-constant-time": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/buffer-equal-constant-time/-/buffer-equal-constant-time-1.0.1.tgz",
+ "integrity": "sha512-zRpUiDwd/xk6ADqPMATG8vc9VPrkck7T07OIx0gnjmJAnHnTVXNQG3vfvWNuiZIkwu9KrKdA1iJKfsfTVxE6NA==",
+ "license": "BSD-3-Clause"
+ },
+ "node_modules/bundle-name": {
+ "version": "4.1.0",
+ "license": "MIT",
+ "dependencies": {
+ "run-applescript": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/bytes": {
+ "version": "3.1.2",
+ "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz",
+ "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/c12": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/c12/-/c12-3.0.3.tgz",
+ "integrity": "sha512-uC3MacKBb0Z15o5QWCHvHWj5Zv34pGQj9P+iXKSpTuSGFS0KKhUWf4t9AJ+gWjYOdmWCPEGpEzm8sS0iqbpo1w==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "chokidar": "^4.0.3",
+ "confbox": "^0.2.2",
+ "defu": "^6.1.4",
+ "dotenv": "^16.4.7",
+ "exsolve": "^1.0.4",
+ "giget": "^2.0.0",
+ "jiti": "^2.4.2",
+ "ohash": "^2.0.11",
+ "pathe": "^2.0.3",
+ "perfect-debounce": "^1.0.0",
+ "pkg-types": "^2.1.0",
+ "rc9": "^2.1.2"
+ },
+ "peerDependencies": {
+ "magicast": "^0.3.5"
+ },
+ "peerDependenciesMeta": {
+ "magicast": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/c12/node_modules/chokidar": {
+ "version": "4.0.3",
+ "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-4.0.3.tgz",
+ "integrity": "sha512-Qgzu8kfBvo+cA4962jnP1KkS6Dop5NS6g7R5LFYJr4b8Ub94PPQXUksCw9PvXoeXPRRddRNC5C1JQUR2SMGtnA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "readdirp": "^4.0.1"
+ },
+ "engines": {
+ "node": ">= 14.16.0"
+ },
+ "funding": {
+ "url": "https://paulmillr.com/funding/"
+ }
+ },
+ "node_modules/c12/node_modules/readdirp": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/readdirp/-/readdirp-4.1.2.tgz",
+ "integrity": "sha512-GDhwkLfywWL2s6vEjyhri+eXmfH6j1L7JE27WhqLeYzoh/A3DBaYGEj2H/HFZCn/kMfim73FXxEJTw06WtxQwg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 14.18.0"
+ },
+ "funding": {
+ "type": "individual",
+ "url": "https://paulmillr.com/funding/"
+ }
+ },
+ "node_modules/caching-transform": {
+ "version": "4.0.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "hasha": "^5.0.0",
+ "make-dir": "^3.0.0",
+ "package-hash": "^4.0.0",
+ "write-file-atomic": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/call-bind": {
+ "version": "1.0.8",
+ "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.8.tgz",
+ "integrity": "sha512-oKlSFMcMwpUg2ednkhQ454wfWiU/ul3CkJe/PEHcTKuiX6RpbehUiFMXu13HalGZxfUwCQzZG747YXBn1im9ww==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "call-bind-apply-helpers": "^1.0.0",
+ "es-define-property": "^1.0.0",
+ "get-intrinsic": "^1.2.4",
+ "set-function-length": "^1.2.2"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/call-bind-apply-helpers": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/call-bind-apply-helpers/-/call-bind-apply-helpers-1.0.1.tgz",
+ "integrity": "sha512-BhYE+WDaywFg2TBWYNXAE+8B1ATnThNBqXHP5nQu0jWJdVvY2hvkpyB3qOmtmDePiS5/BDQ8wASEWGMWRG148g==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "es-errors": "^1.3.0",
+ "function-bind": "^1.1.2"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/camelcase": {
+ "version": "5.3.1",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/caniuse-lite": {
+ "version": "1.0.30001584",
+ "dev": true,
+ "funding": [
+ {
+ "type": "opencollective",
+ "url": "https://opencollective.com/browserslist"
+ },
+ {
+ "type": "tidelift",
+ "url": "https://tidelift.com/funding/github/npm/caniuse-lite"
+ },
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/ai"
+ }
+ ],
+ "license": "CC-BY-4.0"
+ },
+ "node_modules/chalk": {
+ "version": "4.1.2",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ansi-styles": "^4.1.0",
+ "supports-color": "^7.1.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/chalk?sponsor=1"
+ }
+ },
+ "node_modules/chalk/node_modules/supports-color": {
+ "version": "7.2.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "has-flag": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/chardet": {
+ "version": "0.7.0",
+ "resolved": "https://registry.npmjs.org/chardet/-/chardet-0.7.0.tgz",
+ "integrity": "sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/cheerio": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.0.0.tgz",
+ "integrity": "sha512-quS9HgjQpdaXOvsZz82Oz7uxtXiy6UIsIQcpBj7HRw2M63Skasm9qlDocAM7jNuaxdhpPU7c4kJN+gA5MCu4ww==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "cheerio-select": "^2.1.0",
+ "dom-serializer": "^2.0.0",
+ "domhandler": "^5.0.3",
+ "domutils": "^3.1.0",
+ "encoding-sniffer": "^0.2.0",
+ "htmlparser2": "^9.1.0",
+ "parse5": "^7.1.2",
+ "parse5-htmlparser2-tree-adapter": "^7.0.0",
+ "parse5-parser-stream": "^7.1.2",
+ "undici": "^6.19.5",
+ "whatwg-mimetype": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=18.17"
+ },
+ "funding": {
+ "url": "https://github.com/cheeriojs/cheerio?sponsor=1"
+ }
+ },
+ "node_modules/cheerio-select": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/cheerio-select/-/cheerio-select-2.1.0.tgz",
+ "integrity": "sha512-9v9kG0LvzrlcungtnJtpGNxY+fzECQKhK4EGJX2vByejiMX84MFNQw4UxPJl3bFbTMw+Dfs37XaIkCwTZfLh4g==",
+ "dev": true,
+ "license": "BSD-2-Clause",
+ "dependencies": {
+ "boolbase": "^1.0.0",
+ "css-select": "^5.1.0",
+ "css-what": "^6.1.0",
+ "domelementtype": "^2.3.0",
+ "domhandler": "^5.0.3",
+ "domutils": "^3.0.1"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/fb55"
+ }
+ },
+ "node_modules/chokidar": {
+ "version": "3.5.3",
+ "dev": true,
+ "funding": [
+ {
+ "type": "individual",
+ "url": "https://paulmillr.com/funding/"
+ }
+ ],
+ "license": "MIT",
+ "dependencies": {
+ "anymatch": "~3.1.2",
+ "braces": "~3.0.2",
+ "glob-parent": "~5.1.2",
+ "is-binary-path": "~2.1.0",
+ "is-glob": "~4.0.1",
+ "normalize-path": "~3.0.0",
+ "readdirp": "~3.6.0"
+ },
+ "engines": {
+ "node": ">= 8.10.0"
+ },
+ "optionalDependencies": {
+ "fsevents": "~2.3.2"
+ }
+ },
+ "node_modules/ci-info": {
+ "version": "4.2.0",
+ "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-4.2.0.tgz",
+ "integrity": "sha512-cYY9mypksY8NRqgDB1XD1RiJL338v/551niynFTGkZOO2LHuB2OmOYxDIe/ttN9AHwrqdum1360G3ald0W9kCg==",
+ "dev": true,
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/sibiraj-s"
+ }
+ ],
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/citty": {
+ "version": "0.1.6",
+ "resolved": "https://registry.npmjs.org/citty/-/citty-0.1.6.tgz",
+ "integrity": "sha512-tskPPKEs8D2KPafUypv2gxwJP8h/OaJmC82QQGGDQcHvXX43xF2VDACcJVmZ0EuSxkpO9Kc4MlrA3q0+FG58AQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "consola": "^3.2.3"
+ }
+ },
+ "node_modules/clean-stack": {
+ "version": "2.2.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/cli-cursor": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-5.0.0.tgz",
+ "integrity": "sha512-aCj4O5wKyszjMmDT4tZj93kxyydN/K5zPWSCe6/0AV/AA1pqe5ZBIw0a2ZfPQV7lL5/yb5HsUreJ6UFAF1tEQw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "restore-cursor": "^5.0.0"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/cli-spinners": {
+ "version": "2.9.2",
+ "resolved": "https://registry.npmjs.org/cli-spinners/-/cli-spinners-2.9.2.tgz",
+ "integrity": "sha512-ywqV+5MmyL4E7ybXgKys4DugZbX0FC6LnwrhjuykIjnK9k8OQacQ7axGKnjDXWNhns0xot3bZI5h55H8yo9cJg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/cli-width": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-4.1.0.tgz",
+ "integrity": "sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ==",
+ "dev": true,
+ "license": "ISC",
+ "engines": {
+ "node": ">= 12"
+ }
+ },
+ "node_modules/cliui": {
+ "version": "7.0.4",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "string-width": "^4.2.0",
+ "strip-ansi": "^6.0.0",
+ "wrap-ansi": "^7.0.0"
+ }
+ },
+ "node_modules/cliui/node_modules/wrap-ansi": {
+ "version": "7.0.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ansi-styles": "^4.0.0",
+ "string-width": "^4.1.0",
+ "strip-ansi": "^6.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/wrap-ansi?sponsor=1"
+ }
+ },
+ "node_modules/cluster-key-slot": {
+ "version": "1.1.2",
+ "license": "Apache-2.0",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/color-convert": {
+ "version": "2.0.1",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "color-name": "~1.1.4"
+ },
+ "engines": {
+ "node": ">=7.0.0"
+ }
+ },
+ "node_modules/color-name": {
+ "version": "1.1.4",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/commander": {
+ "version": "11.1.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=16"
+ }
+ },
+ "node_modules/commondir": {
+ "version": "1.0.1",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/concat-map": {
+ "version": "0.0.1",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/confbox": {
+ "version": "0.2.2",
+ "resolved": "https://registry.npmjs.org/confbox/-/confbox-0.2.2.tgz",
+ "integrity": "sha512-1NB+BKqhtNipMsov4xI/NnhCKp9XG9NamYp5PVm9klAT0fsrNPjaFICsCFhNhwZJKNh7zB/3q8qXz0E9oaMNtQ==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/consola": {
+ "version": "3.4.2",
+ "resolved": "https://registry.npmjs.org/consola/-/consola-3.4.2.tgz",
+ "integrity": "sha512-5IKcdX0nnYavi6G7TtOhwkYzyjfJlatbjMjuLSfE2kYT5pMDOilZ4OvMhi637CcDICTmz3wARPoyhqyX1Y+XvA==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": "^14.18.0 || >=16.10.0"
+ }
+ },
+ "node_modules/content-disposition": {
+ "version": "0.5.4",
+ "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.4.tgz",
+ "integrity": "sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "safe-buffer": "5.2.1"
+ },
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/content-type": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.5.tgz",
+ "integrity": "sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/convert-source-map": {
+ "version": "1.9.0",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/cookie": {
+ "version": "0.7.1",
+ "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.1.tgz",
+ "integrity": "sha512-6DnInpx7SJ2AK3+CTUE/ZM0vWTUboZCegxhC2xiIydHR9jNuTAASBrfEpHhiGOZw/nX51bHt6YQl8jsGo4y/0w==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/cookie-signature": {
+ "version": "1.0.6",
+ "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.0.6.tgz",
+ "integrity": "sha512-QADzlaHc8icV8I7vbaJXJwod9HWYp8uCqf1xa4OfNu1T7JVxQIrUgOWtHdNDtPiywmFbiS12VjotIXLrKM3orQ==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/create-require": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz",
+ "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/cross-spawn": {
+ "version": "7.0.3",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "path-key": "^3.1.0",
+ "shebang-command": "^2.0.0",
+ "which": "^2.0.1"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/css-select": {
+ "version": "5.1.0",
+ "resolved": "https://registry.npmjs.org/css-select/-/css-select-5.1.0.tgz",
+ "integrity": "sha512-nwoRF1rvRRnnCqqY7updORDsuqKzqYJ28+oSMaJMMgOauh3fvwHqMS7EZpIPqK8GL+g9mKxF1vP/ZjSeNjEVHg==",
+ "dev": true,
+ "license": "BSD-2-Clause",
+ "dependencies": {
+ "boolbase": "^1.0.0",
+ "css-what": "^6.1.0",
+ "domhandler": "^5.0.2",
+ "domutils": "^3.0.1",
+ "nth-check": "^2.0.1"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/fb55"
+ }
+ },
+ "node_modules/css-what": {
+ "version": "6.1.0",
+ "resolved": "https://registry.npmjs.org/css-what/-/css-what-6.1.0.tgz",
+ "integrity": "sha512-HTUrgRJ7r4dsZKU6GjmpfRK1O76h97Z8MfS1G0FozR+oF2kG6Vfe8JE6zwrkbxigziPHinCJ+gCPjA9EaBDtRw==",
+ "dev": true,
+ "license": "BSD-2-Clause",
+ "engines": {
+ "node": ">= 6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/fb55"
+ }
+ },
+ "node_modules/data-uri-to-buffer": {
+ "version": "6.0.2",
+ "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-6.0.2.tgz",
+ "integrity": "sha512-7hvf7/GW8e86rW0ptuwS3OcBGDjIi6SZva7hCyWC0yYry2cOPmLIjXAUHI6DK2HsnwJd9ifmt57i8eV2n4YNpw==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 14"
+ }
+ },
+ "node_modules/debug": {
+ "version": "4.3.4",
+ "license": "MIT",
+ "dependencies": {
+ "ms": "2.1.2"
+ },
+ "engines": {
+ "node": ">=6.0"
+ },
+ "peerDependenciesMeta": {
+ "supports-color": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/debug/node_modules/ms": {
+ "version": "2.1.2",
+ "license": "MIT"
+ },
+ "node_modules/decamelize": {
+ "version": "1.2.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/default-browser": {
+ "version": "5.2.1",
+ "license": "MIT",
+ "dependencies": {
+ "bundle-name": "^4.1.0",
+ "default-browser-id": "^5.0.0"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/default-browser-id": {
+ "version": "5.0.0",
+ "license": "MIT",
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/default-require-extensions": {
+ "version": "3.0.1",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "strip-bom": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/define-data-property": {
+ "version": "1.1.4",
+ "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz",
+ "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "es-define-property": "^1.0.0",
+ "es-errors": "^1.3.0",
+ "gopd": "^1.0.1"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/define-lazy-prop": {
+ "version": "3.0.0",
+ "license": "MIT",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/defu": {
+ "version": "6.1.4",
+ "resolved": "https://registry.npmjs.org/defu/-/defu-6.1.4.tgz",
+ "integrity": "sha512-mEQCMmwJu317oSz8CwdIOdwf3xMif1ttiM8LTufzc3g6kR+9Pe236twL8j3IYT1F7GfRgGcW6MWxzZjLIkuHIg==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/degenerator": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/degenerator/-/degenerator-5.0.1.tgz",
+ "integrity": "sha512-TllpMR/t0M5sqCXfj85i4XaAzxmS5tVA16dqvdkMwGmzI+dXLXnw3J+3Vdv7VKw+ThlTMboK6i9rnZ6Nntj5CQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ast-types": "^0.13.4",
+ "escodegen": "^2.1.0",
+ "esprima": "^4.0.1"
+ },
+ "engines": {
+ "node": ">= 14"
+ }
+ },
+ "node_modules/depd": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz",
+ "integrity": "sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/destr": {
+ "version": "2.0.5",
+ "resolved": "https://registry.npmjs.org/destr/-/destr-2.0.5.tgz",
+ "integrity": "sha512-ugFTXCtDZunbzasqBxrK93Ik/DRYsO6S/fedkWEMKqt04xZ4csmnmwGDBAb07QWNaGMAmnTIemsYZCksjATwsA==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/destroy": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.2.0.tgz",
+ "integrity": "sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.8",
+ "npm": "1.2.8000 || >= 1.4.16"
+ }
+ },
+ "node_modules/detect-indent": {
+ "version": "7.0.1",
+ "resolved": "https://registry.npmjs.org/detect-indent/-/detect-indent-7.0.1.tgz",
+ "integrity": "sha512-Mc7QhQ8s+cLrnUfU/Ji94vG/r8M26m8f++vyres4ZoojaRDpZ1eSIh/EpzLNwlWuvzSZ3UbDFspjFvTDXe6e/g==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=12.20"
+ }
+ },
+ "node_modules/diff": {
+ "version": "5.0.0",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "engines": {
+ "node": ">=0.3.1"
+ }
+ },
+ "node_modules/dom-serializer": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-2.0.0.tgz",
+ "integrity": "sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "domelementtype": "^2.3.0",
+ "domhandler": "^5.0.2",
+ "entities": "^4.2.0"
+ },
+ "funding": {
+ "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1"
+ }
+ },
+ "node_modules/domelementtype": {
+ "version": "2.3.0",
+ "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-2.3.0.tgz",
+ "integrity": "sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw==",
+ "dev": true,
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/fb55"
+ }
+ ],
+ "license": "BSD-2-Clause"
+ },
+ "node_modules/domhandler": {
+ "version": "5.0.3",
+ "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-5.0.3.tgz",
+ "integrity": "sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==",
+ "dev": true,
+ "license": "BSD-2-Clause",
+ "dependencies": {
+ "domelementtype": "^2.3.0"
+ },
+ "engines": {
+ "node": ">= 4"
+ },
+ "funding": {
+ "url": "https://github.com/fb55/domhandler?sponsor=1"
+ }
+ },
+ "node_modules/domutils": {
+ "version": "3.2.2",
+ "resolved": "https://registry.npmjs.org/domutils/-/domutils-3.2.2.tgz",
+ "integrity": "sha512-6kZKyUajlDuqlHKVX1w7gyslj9MPIXzIFiz/rGu35uC1wMi+kMhQwGhl4lt9unC9Vb9INnY9Z3/ZA3+FhASLaw==",
+ "dev": true,
+ "license": "BSD-2-Clause",
+ "dependencies": {
+ "dom-serializer": "^2.0.0",
+ "domelementtype": "^2.3.0",
+ "domhandler": "^5.0.3"
+ },
+ "funding": {
+ "url": "https://github.com/fb55/domutils?sponsor=1"
+ }
+ },
+ "node_modules/dotenv": {
+ "version": "16.4.7",
+ "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.4.7.tgz",
+ "integrity": "sha512-47qPchRCykZC03FhkYAhrvwU4xDBFIj1QPqaarj6mdM/hgUzfPHcpkHJOn3mJAufFeeAxAzeGsr5X0M4k6fLZQ==",
+ "dev": true,
+ "license": "BSD-2-Clause",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://dotenvx.com"
+ }
+ },
+ "node_modules/dunder-proto": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/dunder-proto/-/dunder-proto-1.0.0.tgz",
+ "integrity": "sha512-9+Sj30DIu+4KvHqMfLUGLFYL2PkURSYMVXJyXe92nFRvlYq5hBjLEhblKB+vkd/WVlUYMWigiY07T91Fkk0+4A==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "call-bind-apply-helpers": "^1.0.0",
+ "es-errors": "^1.3.0",
+ "gopd": "^1.2.0"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/ecdsa-sig-formatter": {
+ "version": "1.0.11",
+ "resolved": "https://registry.npmjs.org/ecdsa-sig-formatter/-/ecdsa-sig-formatter-1.0.11.tgz",
+ "integrity": "sha512-nagl3RYrbNv6kQkeJIpt6NJZy8twLB/2vtz6yN9Z4vRKHN4/QZJIEbqohALSgwKdnksuY3k5Addp5lg8sVoVcQ==",
+ "license": "Apache-2.0",
+ "dependencies": {
+ "safe-buffer": "^5.0.1"
+ }
+ },
+ "node_modules/ee-first": {
+ "version": "1.1.1",
+ "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz",
+ "integrity": "sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/electron-to-chromium": {
+ "version": "1.4.656",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/email-addresses": {
+ "version": "5.0.0",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/emoji-regex": {
+ "version": "8.0.0",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/encodeurl": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-2.0.0.tgz",
+ "integrity": "sha512-Q0n9HRi4m6JuGIV1eFlmvJB7ZEVxu93IrMyiMsGC0lrMJMWzRgx6WGquyfQgZVb31vhGgXnfmPNNXmxnOkRBrg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/encoding-sniffer": {
+ "version": "0.2.0",
+ "resolved": "https://registry.npmjs.org/encoding-sniffer/-/encoding-sniffer-0.2.0.tgz",
+ "integrity": "sha512-ju7Wq1kg04I3HtiYIOrUrdfdDvkyO9s5XM8QAj/bN61Yo/Vb4vgJxy5vi4Yxk01gWHbrofpPtpxM8bKger9jhg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "iconv-lite": "^0.6.3",
+ "whatwg-encoding": "^3.1.1"
+ },
+ "funding": {
+ "url": "https://github.com/fb55/encoding-sniffer?sponsor=1"
+ }
+ },
+ "node_modules/encoding-sniffer/node_modules/iconv-lite": {
+ "version": "0.6.3",
+ "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz",
+ "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "safer-buffer": ">= 2.1.2 < 3.0.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/entities": {
+ "version": "4.5.0",
+ "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz",
+ "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==",
+ "dev": true,
+ "license": "BSD-2-Clause",
+ "engines": {
+ "node": ">=0.12"
+ },
+ "funding": {
+ "url": "https://github.com/fb55/entities?sponsor=1"
+ }
+ },
+ "node_modules/es-define-property": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz",
+ "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/es-errors": {
+ "version": "1.3.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/es6-error": {
+ "version": "4.1.1",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/esbuild": {
+ "version": "0.19.12",
+ "dev": true,
+ "hasInstallScript": true,
+ "license": "MIT",
+ "bin": {
+ "esbuild": "bin/esbuild"
+ },
+ "engines": {
+ "node": ">=12"
+ },
+ "optionalDependencies": {
+ "@esbuild/aix-ppc64": "0.19.12",
+ "@esbuild/android-arm": "0.19.12",
+ "@esbuild/android-arm64": "0.19.12",
+ "@esbuild/android-x64": "0.19.12",
+ "@esbuild/darwin-arm64": "0.19.12",
+ "@esbuild/darwin-x64": "0.19.12",
+ "@esbuild/freebsd-arm64": "0.19.12",
+ "@esbuild/freebsd-x64": "0.19.12",
+ "@esbuild/linux-arm": "0.19.12",
+ "@esbuild/linux-arm64": "0.19.12",
+ "@esbuild/linux-ia32": "0.19.12",
+ "@esbuild/linux-loong64": "0.19.12",
+ "@esbuild/linux-mips64el": "0.19.12",
+ "@esbuild/linux-ppc64": "0.19.12",
+ "@esbuild/linux-riscv64": "0.19.12",
+ "@esbuild/linux-s390x": "0.19.12",
+ "@esbuild/linux-x64": "0.19.12",
+ "@esbuild/netbsd-x64": "0.19.12",
+ "@esbuild/openbsd-x64": "0.19.12",
+ "@esbuild/sunos-x64": "0.19.12",
+ "@esbuild/win32-arm64": "0.19.12",
+ "@esbuild/win32-ia32": "0.19.12",
+ "@esbuild/win32-x64": "0.19.12"
+ }
+ },
+ "node_modules/escalade": {
+ "version": "3.1.1",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/escape-html": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz",
+ "integrity": "sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/escape-string-regexp": {
+ "version": "4.0.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/escodegen": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/escodegen/-/escodegen-2.1.0.tgz",
+ "integrity": "sha512-2NlIDTwUWJN0mRPQOdtQBzbUHvdGY2P1VXSyU83Q3xKxM7WHX2Ql8dKq782Q9TgQUNOLEzEYu9bzLNj1q88I5w==",
+ "dev": true,
+ "license": "BSD-2-Clause",
+ "dependencies": {
+ "esprima": "^4.0.1",
+ "estraverse": "^5.2.0",
+ "esutils": "^2.0.2"
+ },
+ "bin": {
+ "escodegen": "bin/escodegen.js",
+ "esgenerate": "bin/esgenerate.js"
+ },
+ "engines": {
+ "node": ">=6.0"
+ },
+ "optionalDependencies": {
+ "source-map": "~0.6.1"
+ }
+ },
+ "node_modules/esprima": {
+ "version": "4.0.1",
+ "dev": true,
+ "license": "BSD-2-Clause",
+ "bin": {
+ "esparse": "bin/esparse.js",
+ "esvalidate": "bin/esvalidate.js"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/estraverse": {
+ "version": "5.3.0",
+ "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz",
+ "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==",
+ "dev": true,
+ "license": "BSD-2-Clause",
+ "engines": {
+ "node": ">=4.0"
+ }
+ },
+ "node_modules/esutils": {
+ "version": "2.0.3",
+ "resolved": "https://registry.npmjs.org/esutils/-/esutils-2.0.3.tgz",
+ "integrity": "sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==",
+ "dev": true,
+ "license": "BSD-2-Clause",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/eta": {
+ "version": "3.5.0",
+ "resolved": "https://registry.npmjs.org/eta/-/eta-3.5.0.tgz",
+ "integrity": "sha512-e3x3FBvGzeCIHhF+zhK8FZA2vC5uFn6b4HJjegUbIWrDb4mJ7JjTGMJY9VGIbRVpmSwHopNiaJibhjIr+HfLug==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=6.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/eta-dev/eta?sponsor=1"
+ }
+ },
+ "node_modules/etag": {
+ "version": "1.8.1",
+ "resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz",
+ "integrity": "sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/events": {
+ "version": "3.3.0",
+ "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz",
+ "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.8.x"
+ }
+ },
+ "node_modules/execa": {
+ "version": "8.0.1",
+ "resolved": "https://registry.npmjs.org/execa/-/execa-8.0.1.tgz",
+ "integrity": "sha512-VyhnebXciFV2DESc+p6B+y0LjSm0krU4OgJN44qFAhBY0TJ+1V61tYD2+wHusZ6F9n5K+vl8k0sTy7PEfV4qpg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "cross-spawn": "^7.0.3",
+ "get-stream": "^8.0.1",
+ "human-signals": "^5.0.0",
+ "is-stream": "^3.0.0",
+ "merge-stream": "^2.0.0",
+ "npm-run-path": "^5.1.0",
+ "onetime": "^6.0.0",
+ "signal-exit": "^4.1.0",
+ "strip-final-newline": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=16.17"
+ },
+ "funding": {
+ "url": "https://github.com/sindresorhus/execa?sponsor=1"
+ }
+ },
+ "node_modules/execa/node_modules/is-stream": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-3.0.0.tgz",
+ "integrity": "sha512-LnQR4bZ9IADDRSkvpqMGvt/tEJWclzklNgSw48V5EAaAeDd6qGvN8ei6k5p0tvxSR171VmGyHuTiAOfxAbr8kA==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/execa/node_modules/onetime": {
+ "version": "6.0.0",
+ "resolved": "https://registry.npmjs.org/onetime/-/onetime-6.0.0.tgz",
+ "integrity": "sha512-1FlR+gjXK7X+AsAHso35MnyN5KqGwJRi/31ft6x0M194ht7S+rWAvd7PHss9xSKMzE0asv1pyIHaJYq+BbacAQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "mimic-fn": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/execa/node_modules/signal-exit": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz",
+ "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==",
+ "dev": true,
+ "license": "ISC",
+ "engines": {
+ "node": ">=14"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/isaacs"
+ }
+ },
+ "node_modules/express": {
+ "version": "4.21.2",
+ "resolved": "https://registry.npmjs.org/express/-/express-4.21.2.tgz",
+ "integrity": "sha512-28HqgMZAmih1Czt9ny7qr6ek2qddF4FclbMzwhCREB6OFfH+rXAnuNCwo1/wFvrtbgsQDb4kSbX9de9lFbrXnA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "accepts": "~1.3.8",
+ "array-flatten": "1.1.1",
+ "body-parser": "1.20.3",
+ "content-disposition": "0.5.4",
+ "content-type": "~1.0.4",
+ "cookie": "0.7.1",
+ "cookie-signature": "1.0.6",
+ "debug": "2.6.9",
+ "depd": "2.0.0",
+ "encodeurl": "~2.0.0",
+ "escape-html": "~1.0.3",
+ "etag": "~1.8.1",
+ "finalhandler": "1.3.1",
+ "fresh": "0.5.2",
+ "http-errors": "2.0.0",
+ "merge-descriptors": "1.0.3",
+ "methods": "~1.1.2",
+ "on-finished": "2.4.1",
+ "parseurl": "~1.3.3",
+ "path-to-regexp": "0.1.12",
+ "proxy-addr": "~2.0.7",
+ "qs": "6.13.0",
+ "range-parser": "~1.2.1",
+ "safe-buffer": "5.2.1",
+ "send": "0.19.0",
+ "serve-static": "1.16.2",
+ "setprototypeof": "1.2.0",
+ "statuses": "2.0.1",
+ "type-is": "~1.6.18",
+ "utils-merge": "1.0.1",
+ "vary": "~1.1.2"
+ },
+ "engines": {
+ "node": ">= 0.10.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/express"
+ }
+ },
+ "node_modules/express-session": {
+ "version": "1.18.1",
+ "resolved": "https://registry.npmjs.org/express-session/-/express-session-1.18.1.tgz",
+ "integrity": "sha512-a5mtTqEaZvBCL9A9aqkrtfz+3SMDhOVUnjafjo+s7A9Txkq+SVX2DLvSp1Zrv4uCXa3lMSK3viWnh9Gg07PBUA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "cookie": "0.7.2",
+ "cookie-signature": "1.0.7",
+ "debug": "2.6.9",
+ "depd": "~2.0.0",
+ "on-headers": "~1.0.2",
+ "parseurl": "~1.3.3",
+ "safe-buffer": "5.2.1",
+ "uid-safe": "~2.1.5"
+ },
+ "engines": {
+ "node": ">= 0.8.0"
+ }
+ },
+ "node_modules/express-session/node_modules/cookie": {
+ "version": "0.7.2",
+ "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.7.2.tgz",
+ "integrity": "sha512-yki5XnKuf750l50uGTllt6kKILY4nQ1eNIQatoXEByZ5dWgnKqbnqmTrBE5B4N7lrMJKQ2ytWMiTO2o0v6Ew/w==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/express-session/node_modules/cookie-signature": {
+ "version": "1.0.7",
+ "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.0.7.tgz",
+ "integrity": "sha512-NXdYc3dLr47pBkpUCHtKSwIOQXLVn8dZEuywboCOJY/osA0wFSLlSawr3KN8qXJEyX66FcONTH8EIlVuK0yyFA==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/express-session/node_modules/debug": {
+ "version": "2.6.9",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz",
+ "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ms": "2.0.0"
+ }
+ },
+ "node_modules/express-session/node_modules/ms": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
+ "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/express/node_modules/debug": {
+ "version": "2.6.9",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz",
+ "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ms": "2.0.0"
+ }
+ },
+ "node_modules/express/node_modules/ms": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
+ "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/express/node_modules/path-to-regexp": {
+ "version": "0.1.12",
+ "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.12.tgz",
+ "integrity": "sha512-RA1GjUVMnvYFxuqovrEqZoxxW5NUZqbwKtYz/Tt7nXerk0LbLblQmrsgdeOxV5SFHf0UDggjS/bSeOZwt1pmEQ==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/exsolve": {
+ "version": "1.0.5",
+ "resolved": "https://registry.npmjs.org/exsolve/-/exsolve-1.0.5.tgz",
+ "integrity": "sha512-pz5dvkYYKQ1AHVrgOzBKWeP4u4FRb3a6DNK2ucr0OoNwYIU4QWsJ+NM36LLzORT+z845MzKHHhpXiUF5nvQoJg==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/external-editor": {
+ "version": "3.1.0",
+ "resolved": "https://registry.npmjs.org/external-editor/-/external-editor-3.1.0.tgz",
+ "integrity": "sha512-hMQ4CX1p1izmuLYyZqLMO/qGNw10wSv9QDCPfzXfyFrOaCSSoRfqE1Kf1s5an66J5JZC62NewG+mK49jOCtQew==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "chardet": "^0.7.0",
+ "iconv-lite": "^0.4.24",
+ "tmp": "^0.0.33"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/fast-content-type-parse": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/fast-content-type-parse/-/fast-content-type-parse-2.0.1.tgz",
+ "integrity": "sha512-nGqtvLrj5w0naR6tDPfB4cUmYCqouzyQiz6C5y/LtcDllJdrcc6WaWW6iXyIIOErTa/XRybj28aasdn4LkVk6Q==",
+ "dev": true,
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/fastify"
+ },
+ {
+ "type": "opencollective",
+ "url": "https://opencollective.com/fastify"
+ }
+ ],
+ "license": "MIT"
+ },
+ "node_modules/fast-glob": {
+ "version": "3.3.3",
+ "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.3.tgz",
+ "integrity": "sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@nodelib/fs.stat": "^2.0.2",
+ "@nodelib/fs.walk": "^1.2.3",
+ "glob-parent": "^5.1.2",
+ "merge2": "^1.3.0",
+ "micromatch": "^4.0.8"
+ },
+ "engines": {
+ "node": ">=8.6.0"
+ }
+ },
+ "node_modules/fastq": {
+ "version": "1.19.1",
+ "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.19.1.tgz",
+ "integrity": "sha512-GwLTyxkCXjXbxqIhTsMI2Nui8huMPtnxg7krajPJAjnEG/iiOS7i+zCtWGZR9G0NBKbXKh6X9m9UIsYX/N6vvQ==",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "reusify": "^1.0.4"
+ }
+ },
+ "node_modules/filename-reserved-regex": {
+ "version": "2.0.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/filenamify": {
+ "version": "4.3.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "filename-reserved-regex": "^2.0.0",
+ "strip-outer": "^1.0.1",
+ "trim-repeated": "^1.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/fill-range": {
+ "version": "7.1.1",
+ "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz",
+ "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "to-regex-range": "^5.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/finalhandler": {
+ "version": "1.3.1",
+ "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.3.1.tgz",
+ "integrity": "sha512-6BN9trH7bp3qvnrRyzsBz+g3lZxTNZTbVO2EV1CS0WIcDbawYVdYvGflME/9QP0h0pYlCDBCTjYa9nZzMDpyxQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "debug": "2.6.9",
+ "encodeurl": "~2.0.0",
+ "escape-html": "~1.0.3",
+ "on-finished": "2.4.1",
+ "parseurl": "~1.3.3",
+ "statuses": "2.0.1",
+ "unpipe": "~1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/finalhandler/node_modules/debug": {
+ "version": "2.6.9",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz",
+ "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ms": "2.0.0"
+ }
+ },
+ "node_modules/finalhandler/node_modules/ms": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
+ "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/find-cache-dir": {
+ "version": "3.3.2",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "commondir": "^1.0.1",
+ "make-dir": "^3.0.2",
+ "pkg-dir": "^4.1.0"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/avajs/find-cache-dir?sponsor=1"
+ }
+ },
+ "node_modules/find-up": {
+ "version": "5.0.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "locate-path": "^6.0.0",
+ "path-exists": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/flat": {
+ "version": "5.0.2",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "bin": {
+ "flat": "cli.js"
+ }
+ },
+ "node_modules/foreground-child": {
+ "version": "2.0.0",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "cross-spawn": "^7.0.0",
+ "signal-exit": "^3.0.2"
+ },
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/forwarded": {
+ "version": "0.2.0",
+ "resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.2.0.tgz",
+ "integrity": "sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/fresh": {
+ "version": "0.5.2",
+ "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz",
+ "integrity": "sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/fromentries": {
+ "version": "1.3.2",
+ "dev": true,
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "license": "MIT"
+ },
+ "node_modules/fs-extra": {
+ "version": "11.2.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "graceful-fs": "^4.2.0",
+ "jsonfile": "^6.0.1",
+ "universalify": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=14.14"
+ }
+ },
+ "node_modules/fs.realpath": {
+ "version": "1.0.0",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/function-bind": {
+ "version": "1.1.2",
+ "dev": true,
+ "license": "MIT",
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/gensync": {
+ "version": "1.0.0-beta.2",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=6.9.0"
+ }
+ },
+ "node_modules/get-caller-file": {
+ "version": "2.0.5",
+ "dev": true,
+ "license": "ISC",
+ "engines": {
+ "node": "6.* || 8.* || >= 10.*"
+ }
+ },
+ "node_modules/get-east-asian-width": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/get-east-asian-width/-/get-east-asian-width-1.3.0.tgz",
+ "integrity": "sha512-vpeMIQKxczTD/0s2CdEWHcb0eeJe6TFjxb+J5xgX7hScxqrGuyjmv4c1D4A/gelKfyox0gJJwIHF+fLjeaM8kQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/get-intrinsic": {
+ "version": "1.2.5",
+ "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.5.tgz",
+ "integrity": "sha512-Y4+pKa7XeRUPWFNvOOYHkRYrfzW07oraURSvjDmRVOJ748OrVmeXtpE4+GCEHncjCjkTxPNRt8kEbxDhsn6VTg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "call-bind-apply-helpers": "^1.0.0",
+ "dunder-proto": "^1.0.0",
+ "es-define-property": "^1.0.1",
+ "es-errors": "^1.3.0",
+ "function-bind": "^1.1.2",
+ "gopd": "^1.2.0",
+ "has-symbols": "^1.1.0",
+ "hasown": "^2.0.2"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/get-package-type": {
+ "version": "0.1.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=8.0.0"
+ }
+ },
+ "node_modules/get-stream": {
+ "version": "8.0.1",
+ "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-8.0.1.tgz",
+ "integrity": "sha512-VaUJspBffn/LMCJVoMvSAdmscJyS1auj5Zulnn5UoYcY531UWmdwhRWkcGKnGU93m5HSXP9LP2usOryrBtQowA==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=16"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/get-tsconfig": {
+ "version": "4.7.2",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "resolve-pkg-maps": "^1.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/privatenumber/get-tsconfig?sponsor=1"
+ }
+ },
+ "node_modules/get-uri": {
+ "version": "6.0.4",
+ "resolved": "https://registry.npmjs.org/get-uri/-/get-uri-6.0.4.tgz",
+ "integrity": "sha512-E1b1lFFLvLgak2whF2xDBcOy6NLVGZBqqjJjsIhvopKfWWEi64pLVTWWehV8KlLerZkfNTA95sTe2OdJKm1OzQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "basic-ftp": "^5.0.2",
+ "data-uri-to-buffer": "^6.0.2",
+ "debug": "^4.3.4"
+ },
+ "engines": {
+ "node": ">= 14"
+ }
+ },
+ "node_modules/gh-pages": {
+ "version": "6.1.1",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "async": "^3.2.4",
+ "commander": "^11.0.0",
+ "email-addresses": "^5.0.0",
+ "filenamify": "^4.3.0",
+ "find-cache-dir": "^3.3.1",
+ "fs-extra": "^11.1.1",
+ "globby": "^6.1.0"
+ },
+ "bin": {
+ "gh-pages": "bin/gh-pages.js",
+ "gh-pages-clean": "bin/gh-pages-clean.js"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/giget": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/giget/-/giget-2.0.0.tgz",
+ "integrity": "sha512-L5bGsVkxJbJgdnwyuheIunkGatUF/zssUoxxjACCseZYAVbaqdh9Tsmmlkl8vYan09H7sbvKt4pS8GqKLBrEzA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "citty": "^0.1.6",
+ "consola": "^3.4.0",
+ "defu": "^6.1.4",
+ "node-fetch-native": "^1.6.6",
+ "nypm": "^0.6.0",
+ "pathe": "^2.0.3"
+ },
+ "bin": {
+ "giget": "dist/cli.mjs"
+ }
+ },
+ "node_modules/git-up": {
+ "version": "8.1.1",
+ "resolved": "https://registry.npmjs.org/git-up/-/git-up-8.1.1.tgz",
+ "integrity": "sha512-FDenSF3fVqBYSaJoYy1KSc2wosx0gCvKP+c+PRBht7cAaiCeQlBtfBDX9vgnNOHmdePlSFITVcn4pFfcgNvx3g==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "is-ssh": "^1.4.0",
+ "parse-url": "^9.2.0"
+ }
+ },
+ "node_modules/git-url-parse": {
+ "version": "16.1.0",
+ "resolved": "https://registry.npmjs.org/git-url-parse/-/git-url-parse-16.1.0.tgz",
+ "integrity": "sha512-cPLz4HuK86wClEW7iDdeAKcCVlWXmrLpb2L+G9goW0Z1dtpNS6BXXSOckUTlJT/LDQViE1QZKstNORzHsLnobw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "git-up": "^8.1.0"
+ }
+ },
+ "node_modules/glob": {
+ "version": "7.2.3",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "fs.realpath": "^1.0.0",
+ "inflight": "^1.0.4",
+ "inherits": "2",
+ "minimatch": "^3.1.1",
+ "once": "^1.3.0",
+ "path-is-absolute": "^1.0.0"
+ },
+ "engines": {
+ "node": "*"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/isaacs"
+ }
+ },
+ "node_modules/glob-parent": {
+ "version": "5.1.2",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "is-glob": "^4.0.1"
+ },
+ "engines": {
+ "node": ">= 6"
+ }
+ },
+ "node_modules/globals": {
+ "version": "11.12.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/globby": {
+ "version": "6.1.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "array-union": "^1.0.1",
+ "glob": "^7.0.3",
+ "object-assign": "^4.0.1",
+ "pify": "^2.0.0",
+ "pinkie-promise": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/gopd": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz",
+ "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/graceful-fs": {
+ "version": "4.2.11",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/has-flag": {
+ "version": "4.0.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/has-property-descriptors": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz",
+ "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "es-define-property": "^1.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/has-symbols": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.1.0.tgz",
+ "integrity": "sha512-1cDNdwJ2Jaohmb3sg4OmKaMBwuC48sYni5HUw2DvsC8LjGTLK9h+eb1X6RyuOHe4hT0ULCW68iomhjUoKUqlPQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/hasha": {
+ "version": "5.2.2",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "is-stream": "^2.0.0",
+ "type-fest": "^0.8.0"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/hasown": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz",
+ "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "function-bind": "^1.1.2"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/he": {
+ "version": "1.2.0",
+ "dev": true,
+ "license": "MIT",
+ "bin": {
+ "he": "bin/he"
+ }
+ },
+ "node_modules/html-escaper": {
+ "version": "2.0.2",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/htmlparser2": {
+ "version": "9.1.0",
+ "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-9.1.0.tgz",
+ "integrity": "sha512-5zfg6mHUoaer/97TxnGpxmbR7zJtPwIYFMZ/H5ucTlPZhKvtum05yiPK3Mgai3a0DyVxv7qYqoweaEd2nrYQzQ==",
+ "dev": true,
+ "funding": [
+ "https://github.com/fb55/htmlparser2?sponsor=1",
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/fb55"
+ }
+ ],
+ "license": "MIT",
+ "dependencies": {
+ "domelementtype": "^2.3.0",
+ "domhandler": "^5.0.3",
+ "domutils": "^3.1.0",
+ "entities": "^4.5.0"
+ }
+ },
+ "node_modules/http-errors": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.0.tgz",
+ "integrity": "sha512-FtwrG/euBzaEjYeRqOgly7G0qviiXoJWnvEH2Z1plBdXgbyjv34pHTSb9zoeHMyDy33+DWy5Wt9Wo+TURtOYSQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "depd": "2.0.0",
+ "inherits": "2.0.4",
+ "setprototypeof": "1.2.0",
+ "statuses": "2.0.1",
+ "toidentifier": "1.0.1"
+ },
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/http-proxy-agent": {
+ "version": "7.0.2",
+ "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-7.0.2.tgz",
+ "integrity": "sha512-T1gkAiYYDWYx3V5Bmyu7HcfcvL7mUrTWiM6yOfa3PIphViJ/gFPbvidQ+veqSOHci/PxBcDabeUNCzpOODJZig==",
+ "license": "MIT",
+ "dependencies": {
+ "agent-base": "^7.1.0",
+ "debug": "^4.3.4"
+ },
+ "engines": {
+ "node": ">= 14"
+ }
+ },
+ "node_modules/https-proxy-agent": {
+ "version": "7.0.6",
+ "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz",
+ "integrity": "sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw==",
+ "license": "MIT",
+ "dependencies": {
+ "agent-base": "^7.1.2",
+ "debug": "4"
+ },
+ "engines": {
+ "node": ">= 14"
+ }
+ },
+ "node_modules/human-signals": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/human-signals/-/human-signals-5.0.0.tgz",
+ "integrity": "sha512-AXcZb6vzzrFAUE61HnN4mpLqd/cSIwNQjtNWR0euPm6y0iqx3G4gOXaIDdtdDwZmhwe82LA6+zinmW4UBWVePQ==",
+ "dev": true,
+ "license": "Apache-2.0",
+ "engines": {
+ "node": ">=16.17.0"
+ }
+ },
+ "node_modules/iconv-lite": {
+ "version": "0.4.24",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "safer-buffer": ">= 2.1.2 < 3"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/imurmurhash": {
+ "version": "0.1.4",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.8.19"
+ }
+ },
+ "node_modules/indent-string": {
+ "version": "4.0.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/inflight": {
+ "version": "1.0.6",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "once": "^1.3.0",
+ "wrappy": "1"
+ }
+ },
+ "node_modules/inherits": {
+ "version": "2.0.4",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/ini": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/ini/-/ini-5.0.0.tgz",
+ "integrity": "sha512-+N0ngpO3e7cRUWOJAS7qw0IZIVc6XPrW4MlFBdD066F2L4k1L6ker3hLqSq7iXxU5tgS4WGkIUElWn5vogAEnw==",
+ "dev": true,
+ "license": "ISC",
+ "engines": {
+ "node": "^18.17.0 || >=20.5.0"
+ }
+ },
+ "node_modules/inquirer": {
+ "version": "12.6.0",
+ "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-12.6.0.tgz",
+ "integrity": "sha512-3zmmccQd/8o65nPOZJZ+2wqt76Ghw3+LaMrmc6JE/IzcvQhJ1st+QLCOo/iLS85/tILU0myG31a2TAZX0ysAvg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@inquirer/core": "^10.1.10",
+ "@inquirer/prompts": "^7.5.0",
+ "@inquirer/type": "^3.0.6",
+ "ansi-escapes": "^4.3.2",
+ "mute-stream": "^2.0.0",
+ "run-async": "^3.0.0",
+ "rxjs": "^7.8.2"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "peerDependencies": {
+ "@types/node": ">=18"
+ },
+ "peerDependenciesMeta": {
+ "@types/node": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/ip-address": {
+ "version": "9.0.5",
+ "resolved": "https://registry.npmjs.org/ip-address/-/ip-address-9.0.5.tgz",
+ "integrity": "sha512-zHtQzGojZXTwZTHQqra+ETKd4Sn3vgi7uBmlPoXVWZqYvuKmtI0l/VZTjqGmJY9x88GGOaZ9+G9ES8hC4T4X8g==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "jsbn": "1.1.0",
+ "sprintf-js": "^1.1.3"
+ },
+ "engines": {
+ "node": ">= 12"
+ }
+ },
+ "node_modules/ip-address/node_modules/sprintf-js": {
+ "version": "1.1.3",
+ "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.1.3.tgz",
+ "integrity": "sha512-Oo+0REFV59/rz3gfJNKQiBlwfHaSESl1pcGyABQsnnIfWOFt6JNj5gCog2U6MLZ//IGYD+nA8nI+mTShREReaA==",
+ "dev": true,
+ "license": "BSD-3-Clause"
+ },
+ "node_modules/ipaddr.js": {
+ "version": "1.9.1",
+ "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz",
+ "integrity": "sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.10"
+ }
+ },
+ "node_modules/is-binary-path": {
+ "version": "2.1.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "binary-extensions": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/is-docker": {
+ "version": "3.0.0",
+ "license": "MIT",
+ "bin": {
+ "is-docker": "cli.js"
+ },
+ "engines": {
+ "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/is-extglob": {
+ "version": "2.1.1",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-fullwidth-code-point": {
+ "version": "3.0.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/is-glob": {
+ "version": "4.0.3",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "is-extglob": "^2.1.1"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-inside-container": {
+ "version": "1.0.0",
+ "license": "MIT",
+ "dependencies": {
+ "is-docker": "^3.0.0"
+ },
+ "bin": {
+ "is-inside-container": "cli.js"
+ },
+ "engines": {
+ "node": ">=14.16"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/is-interactive": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/is-interactive/-/is-interactive-2.0.0.tgz",
+ "integrity": "sha512-qP1vozQRI+BMOPcjFzrjXuQvdak2pHNUMZoeG2eRbiSqyvbEf/wQtEOTOX1guk6E3t36RkaqiSt8A/6YElNxLQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/is-number": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz",
+ "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.12.0"
+ }
+ },
+ "node_modules/is-plain-obj": {
+ "version": "2.1.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/is-ssh": {
+ "version": "1.4.1",
+ "resolved": "https://registry.npmjs.org/is-ssh/-/is-ssh-1.4.1.tgz",
+ "integrity": "sha512-JNeu1wQsHjyHgn9NcWTaXq6zWSR6hqE0++zhfZlkFBbScNkyvxCdeV8sRkSBaeLKxmbpR21brail63ACNxJ0Tg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "protocols": "^2.0.1"
+ }
+ },
+ "node_modules/is-stream": {
+ "version": "2.0.1",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/is-typedarray": {
+ "version": "1.0.0",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/is-unicode-supported": {
+ "version": "0.1.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/is-windows": {
+ "version": "1.0.2",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/is-wsl": {
+ "version": "3.1.0",
+ "license": "MIT",
+ "dependencies": {
+ "is-inside-container": "^1.0.0"
+ },
+ "engines": {
+ "node": ">=16"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/isexe": {
+ "version": "2.0.0",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/issue-parser": {
+ "version": "7.0.1",
+ "resolved": "https://registry.npmjs.org/issue-parser/-/issue-parser-7.0.1.tgz",
+ "integrity": "sha512-3YZcUUR2Wt1WsapF+S/WiA2WmlW0cWAoPccMqne7AxEBhCdFeTPjfv/Axb8V2gyCgY3nRw+ksZ3xSUX+R47iAg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "lodash.capitalize": "^4.2.1",
+ "lodash.escaperegexp": "^4.1.2",
+ "lodash.isplainobject": "^4.0.6",
+ "lodash.isstring": "^4.0.1",
+ "lodash.uniqby": "^4.7.0"
+ },
+ "engines": {
+ "node": "^18.17 || >=20.6.1"
+ }
+ },
+ "node_modules/istanbul-lib-coverage": {
+ "version": "3.2.2",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/istanbul-lib-hook": {
+ "version": "3.0.0",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "dependencies": {
+ "append-transform": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/istanbul-lib-instrument": {
+ "version": "4.0.3",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "dependencies": {
+ "@babel/core": "^7.7.5",
+ "@istanbuljs/schema": "^0.1.2",
+ "istanbul-lib-coverage": "^3.0.0",
+ "semver": "^6.3.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/istanbul-lib-processinfo": {
+ "version": "2.0.3",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "archy": "^1.0.0",
+ "cross-spawn": "^7.0.3",
+ "istanbul-lib-coverage": "^3.2.0",
+ "p-map": "^3.0.0",
+ "rimraf": "^3.0.0",
+ "uuid": "^8.3.2"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/istanbul-lib-report": {
+ "version": "3.0.1",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "dependencies": {
+ "istanbul-lib-coverage": "^3.0.0",
+ "make-dir": "^4.0.0",
+ "supports-color": "^7.1.0"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/istanbul-lib-report/node_modules/lru-cache": {
+ "version": "6.0.0",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "yallist": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/istanbul-lib-report/node_modules/make-dir": {
+ "version": "4.0.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "semver": "^7.5.3"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/istanbul-lib-report/node_modules/semver": {
+ "version": "7.5.4",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "lru-cache": "^6.0.0"
+ },
+ "bin": {
+ "semver": "bin/semver.js"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/istanbul-lib-report/node_modules/supports-color": {
+ "version": "7.2.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "has-flag": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/istanbul-lib-report/node_modules/yallist": {
+ "version": "4.0.0",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/istanbul-lib-source-maps": {
+ "version": "4.0.1",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "dependencies": {
+ "debug": "^4.1.1",
+ "istanbul-lib-coverage": "^3.0.0",
+ "source-map": "^0.6.1"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/istanbul-reports": {
+ "version": "3.1.6",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "dependencies": {
+ "html-escaper": "^2.0.0",
+ "istanbul-lib-report": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/jiti": {
+ "version": "2.4.2",
+ "resolved": "https://registry.npmjs.org/jiti/-/jiti-2.4.2.tgz",
+ "integrity": "sha512-rg9zJN+G4n2nfJl5MW3BMygZX56zKPNVEYYqq7adpmMh4Jn2QNEwhvQlFy6jPVdcod7txZtKHWnyZiA3a0zP7A==",
+ "dev": true,
+ "license": "MIT",
+ "bin": {
+ "jiti": "lib/jiti-cli.mjs"
+ }
+ },
+ "node_modules/js-tokens": {
+ "version": "4.0.0",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/js-yaml": {
+ "version": "4.1.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "argparse": "^2.0.1"
+ },
+ "bin": {
+ "js-yaml": "bin/js-yaml.js"
+ }
+ },
+ "node_modules/jsbn": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/jsbn/-/jsbn-1.1.0.tgz",
+ "integrity": "sha512-4bYVV3aAMtDTTu4+xsDYa6sy9GyJ69/amsu9sYF2zqjiEoZA5xJi3BrfX3uY+/IekIu7MwdObdbDWpoZdBv3/A==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/jsesc": {
+ "version": "2.5.2",
+ "dev": true,
+ "license": "MIT",
+ "bin": {
+ "jsesc": "bin/jsesc"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/json5": {
+ "version": "2.2.3",
+ "dev": true,
+ "license": "MIT",
+ "bin": {
+ "json5": "lib/cli.js"
+ },
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/jsonc-parser": {
+ "version": "3.2.1",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/jsonfile": {
+ "version": "6.1.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "universalify": "^2.0.0"
+ },
+ "optionalDependencies": {
+ "graceful-fs": "^4.1.6"
+ }
+ },
+ "node_modules/jsonwebtoken": {
+ "version": "9.0.2",
+ "resolved": "https://registry.npmjs.org/jsonwebtoken/-/jsonwebtoken-9.0.2.tgz",
+ "integrity": "sha512-PRp66vJ865SSqOlgqS8hujT5U4AOgMfhrwYIuIhfKaoSCZcirrmASQr8CX7cUg+RMih+hgznrjp99o+W4pJLHQ==",
+ "license": "MIT",
+ "dependencies": {
+ "jws": "^3.2.2",
+ "lodash.includes": "^4.3.0",
+ "lodash.isboolean": "^3.0.3",
+ "lodash.isinteger": "^4.0.4",
+ "lodash.isnumber": "^3.0.3",
+ "lodash.isplainobject": "^4.0.6",
+ "lodash.isstring": "^4.0.1",
+ "lodash.once": "^4.0.0",
+ "ms": "^2.1.1",
+ "semver": "^7.5.4"
+ },
+ "engines": {
+ "node": ">=12",
+ "npm": ">=6"
+ }
+ },
+ "node_modules/jsonwebtoken/node_modules/semver": {
+ "version": "7.6.3",
+ "resolved": "https://registry.npmjs.org/semver/-/semver-7.6.3.tgz",
+ "integrity": "sha512-oVekP1cKtI+CTDvHWYFUcMtsK/00wmAEfyqKfNdARm8u1wNVhSgaX7A8d4UuIlUI5e84iEwOhs7ZPYRmzU9U6A==",
+ "license": "ISC",
+ "bin": {
+ "semver": "bin/semver.js"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/just-extend": {
+ "version": "6.2.0",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/jwa": {
+ "version": "1.4.1",
+ "resolved": "https://registry.npmjs.org/jwa/-/jwa-1.4.1.tgz",
+ "integrity": "sha512-qiLX/xhEEFKUAJ6FiBMbes3w9ATzyk5W7Hvzpa/SLYdxNtng+gcurvrI7TbACjIXlsJyr05/S1oUhZrc63evQA==",
+ "license": "MIT",
+ "dependencies": {
+ "buffer-equal-constant-time": "1.0.1",
+ "ecdsa-sig-formatter": "1.0.11",
+ "safe-buffer": "^5.0.1"
+ }
+ },
+ "node_modules/jws": {
+ "version": "3.2.2",
+ "resolved": "https://registry.npmjs.org/jws/-/jws-3.2.2.tgz",
+ "integrity": "sha512-YHlZCB6lMTllWDtSPHz/ZXTsi8S00usEV6v1tjq8tOUZzw7DpSDWVXjXDre6ed1w/pd495ODpHZYSdkRTsa0HA==",
+ "license": "MIT",
+ "dependencies": {
+ "jwa": "^1.4.1",
+ "safe-buffer": "^5.0.1"
+ }
+ },
+ "node_modules/locate-path": {
+ "version": "6.0.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "p-locate": "^5.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/lodash": {
+ "version": "4.17.21",
+ "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
+ "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/lodash-es": {
+ "version": "4.17.21",
+ "resolved": "https://registry.npmjs.org/lodash-es/-/lodash-es-4.17.21.tgz",
+ "integrity": "sha512-mKnC+QJ9pWVzv+C4/U3rRsHapFfHvQFoFB92e52xeyGMcX6/OlIl78je1u8vePzYZSkkogMPJ2yjxxsb89cxyw==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/lodash.capitalize": {
+ "version": "4.2.1",
+ "resolved": "https://registry.npmjs.org/lodash.capitalize/-/lodash.capitalize-4.2.1.tgz",
+ "integrity": "sha512-kZzYOKspf8XVX5AvmQF94gQW0lejFVgb80G85bU4ZWzoJ6C03PQg3coYAUpSTpQWelrZELd3XWgHzw4Ck5kaIw==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/lodash.escaperegexp": {
+ "version": "4.1.2",
+ "resolved": "https://registry.npmjs.org/lodash.escaperegexp/-/lodash.escaperegexp-4.1.2.tgz",
+ "integrity": "sha512-TM9YBvyC84ZxE3rgfefxUWiQKLilstD6k7PTGt6wfbtXF8ixIJLOL3VYyV/z+ZiPLsVxAsKAFVwWlWeb2Y8Yyw==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/lodash.flattendeep": {
+ "version": "4.4.0",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/lodash.get": {
+ "version": "4.4.2",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/lodash.includes": {
+ "version": "4.3.0",
+ "resolved": "https://registry.npmjs.org/lodash.includes/-/lodash.includes-4.3.0.tgz",
+ "integrity": "sha512-W3Bx6mdkRTGtlJISOvVD/lbqjTlPPUDTMnlXZFnVwi9NKJ6tiAk6LVdlhZMm17VZisqhKcgzpO5Wz91PCt5b0w==",
+ "license": "MIT"
+ },
+ "node_modules/lodash.isboolean": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/lodash.isboolean/-/lodash.isboolean-3.0.3.tgz",
+ "integrity": "sha512-Bz5mupy2SVbPHURB98VAcw+aHh4vRV5IPNhILUCsOzRmsTmSQ17jIuqopAentWoehktxGd9e/hbIXq980/1QJg==",
+ "license": "MIT"
+ },
+ "node_modules/lodash.isinteger": {
+ "version": "4.0.4",
+ "resolved": "https://registry.npmjs.org/lodash.isinteger/-/lodash.isinteger-4.0.4.tgz",
+ "integrity": "sha512-DBwtEWN2caHQ9/imiNeEA5ys1JoRtRfY3d7V9wkqtbycnAmTvRRmbHKDV4a0EYc678/dia0jrte4tjYwVBaZUA==",
+ "license": "MIT"
+ },
+ "node_modules/lodash.isnumber": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/lodash.isnumber/-/lodash.isnumber-3.0.3.tgz",
+ "integrity": "sha512-QYqzpfwO3/CWf3XP+Z+tkQsfaLL/EnUlXWVkIk5FUPc4sBdTehEqZONuyRt2P67PXAk+NXmTBcc97zw9t1FQrw==",
+ "license": "MIT"
+ },
+ "node_modules/lodash.isplainobject": {
+ "version": "4.0.6",
+ "license": "MIT"
+ },
+ "node_modules/lodash.isstring": {
+ "version": "4.0.1",
+ "license": "MIT"
+ },
+ "node_modules/lodash.merge": {
+ "version": "4.6.2",
+ "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz",
+ "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/lodash.once": {
+ "version": "4.1.1",
+ "resolved": "https://registry.npmjs.org/lodash.once/-/lodash.once-4.1.1.tgz",
+ "integrity": "sha512-Sb487aTOCr9drQVL8pIxOzVhafOjZN9UU54hiN8PU3uAiSV7lx1yYNpbNmex2PK6dSJoNTSJUUswT651yww3Mg==",
+ "license": "MIT"
+ },
+ "node_modules/lodash.uniqby": {
+ "version": "4.7.0",
+ "resolved": "https://registry.npmjs.org/lodash.uniqby/-/lodash.uniqby-4.7.0.tgz",
+ "integrity": "sha512-e/zcLx6CSbmaEgFHCA7BnoQKyCtKMxnuWrJygbwPs/AIn+IMKl66L8/s+wBUn5LRw2pZx3bUHibiV1b6aTWIww==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/log-symbols": {
+ "version": "4.1.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "chalk": "^4.1.0",
+ "is-unicode-supported": "^0.1.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/lru-cache": {
+ "version": "5.1.1",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "yallist": "^3.0.2"
+ }
+ },
+ "node_modules/lunr": {
+ "version": "2.3.9",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/macos-release": {
+ "version": "3.3.0",
+ "resolved": "https://registry.npmjs.org/macos-release/-/macos-release-3.3.0.tgz",
+ "integrity": "sha512-tPJQ1HeyiU2vRruNGhZ+VleWuMQRro8iFtJxYgnS4NQe+EukKF6aGiIT+7flZhISAt2iaXBCfFGvAyif7/f8nQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/make-dir": {
+ "version": "3.1.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "semver": "^6.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/make-error": {
+ "version": "1.3.6",
+ "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz",
+ "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/marked": {
+ "version": "4.3.0",
+ "dev": true,
+ "license": "MIT",
+ "bin": {
+ "marked": "bin/marked.js"
+ },
+ "engines": {
+ "node": ">= 12"
+ }
+ },
+ "node_modules/media-typer": {
+ "version": "0.3.0",
+ "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz",
+ "integrity": "sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/merge-descriptors": {
+ "version": "1.0.3",
+ "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.3.tgz",
+ "integrity": "sha512-gaNvAS7TZ897/rVaZ0nMtAyxNyi/pdbjbAwUpFQpN70GqnVfOiXpeUUMKRBmzXaSQ8DdTX4/0ms62r2K+hE6mQ==",
+ "dev": true,
+ "license": "MIT",
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/merge-stream": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz",
+ "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/merge2": {
+ "version": "1.4.1",
+ "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz",
+ "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/methods": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz",
+ "integrity": "sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/micromatch": {
+ "version": "4.0.8",
+ "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz",
+ "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "braces": "^3.0.3",
+ "picomatch": "^2.3.1"
+ },
+ "engines": {
+ "node": ">=8.6"
+ }
+ },
+ "node_modules/mime": {
+ "version": "1.6.0",
+ "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz",
+ "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==",
+ "dev": true,
+ "license": "MIT",
+ "bin": {
+ "mime": "cli.js"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/mime-db": {
+ "version": "1.52.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/mime-types": {
+ "version": "2.1.35",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "mime-db": "1.52.0"
+ },
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/mimic-fn": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/mimic-fn/-/mimic-fn-4.0.0.tgz",
+ "integrity": "sha512-vqiC06CuhBTUdZH+RYl8sFrL096vA45Ok5ISO6sE/Mr1jRbGH4Csnhi8f3wKVl7x8mO4Au7Ir9D3Oyv1VYMFJw==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/mimic-function": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/mimic-function/-/mimic-function-5.0.1.tgz",
+ "integrity": "sha512-VP79XUPxV2CigYP3jWwAUFSku2aKqBH7uTAapFWCBqutsbmDo96KY5o8uh6U+/YSIn5OxJnXp73beVkpqMIGhA==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/minimatch": {
+ "version": "3.1.2",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "brace-expansion": "^1.1.7"
+ },
+ "engines": {
+ "node": "*"
+ }
+ },
+ "node_modules/mocha": {
+ "version": "10.2.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ansi-colors": "4.1.1",
+ "browser-stdout": "1.3.1",
+ "chokidar": "3.5.3",
+ "debug": "4.3.4",
+ "diff": "5.0.0",
+ "escape-string-regexp": "4.0.0",
+ "find-up": "5.0.0",
+ "glob": "7.2.0",
+ "he": "1.2.0",
+ "js-yaml": "4.1.0",
+ "log-symbols": "4.1.0",
+ "minimatch": "5.0.1",
+ "ms": "2.1.3",
+ "nanoid": "3.3.3",
+ "serialize-javascript": "6.0.0",
+ "strip-json-comments": "3.1.1",
+ "supports-color": "8.1.1",
+ "workerpool": "6.2.1",
+ "yargs": "16.2.0",
+ "yargs-parser": "20.2.4",
+ "yargs-unparser": "2.0.0"
+ },
+ "bin": {
+ "_mocha": "bin/_mocha",
+ "mocha": "bin/mocha.js"
+ },
+ "engines": {
+ "node": ">= 14.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/mochajs"
+ }
+ },
+ "node_modules/mocha/node_modules/glob": {
+ "version": "7.2.0",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "fs.realpath": "^1.0.0",
+ "inflight": "^1.0.4",
+ "inherits": "2",
+ "minimatch": "^3.0.4",
+ "once": "^1.3.0",
+ "path-is-absolute": "^1.0.0"
+ },
+ "engines": {
+ "node": "*"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/isaacs"
+ }
+ },
+ "node_modules/mocha/node_modules/glob/node_modules/minimatch": {
+ "version": "3.1.2",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "brace-expansion": "^1.1.7"
+ },
+ "engines": {
+ "node": "*"
+ }
+ },
+ "node_modules/mocha/node_modules/minimatch": {
+ "version": "5.0.1",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "brace-expansion": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/mocha/node_modules/minimatch/node_modules/brace-expansion": {
+ "version": "2.0.1",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "balanced-match": "^1.0.0"
+ }
+ },
+ "node_modules/ms": {
+ "version": "2.1.3",
+ "license": "MIT"
+ },
+ "node_modules/mute-stream": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-2.0.0.tgz",
+ "integrity": "sha512-WWdIxpyjEn+FhQJQQv9aQAYlHoNVdzIzUySNV1gHUPDSdZJ3yZn7pAAbQcV7B56Mvu881q9FZV+0Vx2xC44VWA==",
+ "dev": true,
+ "license": "ISC",
+ "engines": {
+ "node": "^18.17.0 || >=20.5.0"
+ }
+ },
+ "node_modules/nanoid": {
+ "version": "3.3.3",
+ "dev": true,
+ "license": "MIT",
+ "bin": {
+ "nanoid": "bin/nanoid.cjs"
+ },
+ "engines": {
+ "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1"
+ }
+ },
+ "node_modules/negotiator": {
+ "version": "0.6.3",
+ "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz",
+ "integrity": "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/netmask": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/netmask/-/netmask-2.0.2.tgz",
+ "integrity": "sha512-dBpDMdxv9Irdq66304OLfEmQ9tbNRFnFTuZiLo+bD+r332bBmMJ8GBLXklIXXgxd3+v9+KUnZaUR5PJMa75Gsg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.4.0"
+ }
+ },
+ "node_modules/new-github-release-url": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/new-github-release-url/-/new-github-release-url-2.0.0.tgz",
+ "integrity": "sha512-NHDDGYudnvRutt/VhKFlX26IotXe1w0cmkDm6JGquh5bz/bDTw0LufSmH/GxTjEdpHEO+bVKFTwdrcGa/9XlKQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "type-fest": "^2.5.1"
+ },
+ "engines": {
+ "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/new-github-release-url/node_modules/type-fest": {
+ "version": "2.19.0",
+ "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-2.19.0.tgz",
+ "integrity": "sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA==",
+ "dev": true,
+ "license": "(MIT OR CC0-1.0)",
+ "engines": {
+ "node": ">=12.20"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/nise": {
+ "version": "5.1.9",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "dependencies": {
+ "@sinonjs/commons": "^3.0.0",
+ "@sinonjs/fake-timers": "^11.2.2",
+ "@sinonjs/text-encoding": "^0.7.2",
+ "just-extend": "^6.2.0",
+ "path-to-regexp": "^6.2.1"
+ }
+ },
+ "node_modules/node-fetch-native": {
+ "version": "1.6.6",
+ "resolved": "https://registry.npmjs.org/node-fetch-native/-/node-fetch-native-1.6.6.tgz",
+ "integrity": "sha512-8Mc2HhqPdlIfedsuZoc3yioPuzp6b+L5jRCRY1QzuWZh2EGJVQrGppC6V6cF0bLdbW0+O2YpqCA25aF/1lvipQ==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/node-preload": {
+ "version": "0.2.1",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "process-on-spawn": "^1.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/node-releases": {
+ "version": "2.0.14",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/normalize-path": {
+ "version": "3.0.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/npm-run-path": {
+ "version": "5.3.0",
+ "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.3.0.tgz",
+ "integrity": "sha512-ppwTtiJZq0O/ai0z7yfudtBpWIoxM8yE6nHi1X47eFR2EWORqfbu6CnPlNsjeN683eT0qG6H/Pyf9fCcvjnnnQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "path-key": "^4.0.0"
+ },
+ "engines": {
+ "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/npm-run-path/node_modules/path-key": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/path-key/-/path-key-4.0.0.tgz",
+ "integrity": "sha512-haREypq7xkM7ErfgIyA0z+Bj4AGKlMSdlQE2jvJo6huWD1EdkKYV+G/T4nq0YEF2vgTT8kqMFKo1uHn950r4SQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/nth-check": {
+ "version": "2.1.1",
+ "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-2.1.1.tgz",
+ "integrity": "sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w==",
+ "dev": true,
+ "license": "BSD-2-Clause",
+ "dependencies": {
+ "boolbase": "^1.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/fb55/nth-check?sponsor=1"
+ }
+ },
+ "node_modules/nyc": {
+ "version": "15.1.0",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "@istanbuljs/load-nyc-config": "^1.0.0",
+ "@istanbuljs/schema": "^0.1.2",
+ "caching-transform": "^4.0.0",
+ "convert-source-map": "^1.7.0",
+ "decamelize": "^1.2.0",
+ "find-cache-dir": "^3.2.0",
+ "find-up": "^4.1.0",
+ "foreground-child": "^2.0.0",
+ "get-package-type": "^0.1.0",
+ "glob": "^7.1.6",
+ "istanbul-lib-coverage": "^3.0.0",
+ "istanbul-lib-hook": "^3.0.0",
+ "istanbul-lib-instrument": "^4.0.0",
+ "istanbul-lib-processinfo": "^2.0.2",
+ "istanbul-lib-report": "^3.0.0",
+ "istanbul-lib-source-maps": "^4.0.0",
+ "istanbul-reports": "^3.0.2",
+ "make-dir": "^3.0.0",
+ "node-preload": "^0.2.1",
+ "p-map": "^3.0.0",
+ "process-on-spawn": "^1.0.0",
+ "resolve-from": "^5.0.0",
+ "rimraf": "^3.0.0",
+ "signal-exit": "^3.0.2",
+ "spawn-wrap": "^2.0.0",
+ "test-exclude": "^6.0.0",
+ "yargs": "^15.0.2"
+ },
+ "bin": {
+ "nyc": "bin/nyc.js"
+ },
+ "engines": {
+ "node": ">=8.9"
+ }
+ },
+ "node_modules/nyc/node_modules/cliui": {
+ "version": "6.0.0",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "string-width": "^4.2.0",
+ "strip-ansi": "^6.0.0",
+ "wrap-ansi": "^6.2.0"
+ }
+ },
+ "node_modules/nyc/node_modules/find-up": {
+ "version": "4.1.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "locate-path": "^5.0.0",
+ "path-exists": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/nyc/node_modules/locate-path": {
+ "version": "5.0.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "p-locate": "^4.1.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/nyc/node_modules/p-limit": {
+ "version": "2.3.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "p-try": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/nyc/node_modules/p-locate": {
+ "version": "4.1.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "p-limit": "^2.2.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/nyc/node_modules/y18n": {
+ "version": "4.0.3",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/nyc/node_modules/yargs": {
+ "version": "15.4.1",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "cliui": "^6.0.0",
+ "decamelize": "^1.2.0",
+ "find-up": "^4.1.0",
+ "get-caller-file": "^2.0.1",
+ "require-directory": "^2.1.1",
+ "require-main-filename": "^2.0.0",
+ "set-blocking": "^2.0.0",
+ "string-width": "^4.2.0",
+ "which-module": "^2.0.0",
+ "y18n": "^4.0.0",
+ "yargs-parser": "^18.1.2"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/nyc/node_modules/yargs-parser": {
+ "version": "18.1.3",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "camelcase": "^5.0.0",
+ "decamelize": "^1.2.0"
+ },
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/nypm": {
+ "version": "0.6.0",
+ "resolved": "https://registry.npmjs.org/nypm/-/nypm-0.6.0.tgz",
+ "integrity": "sha512-mn8wBFV9G9+UFHIrq+pZ2r2zL4aPau/by3kJb3cM7+5tQHMt6HGQB8FDIeKFYp8o0D2pnH6nVsO88N4AmUxIWg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "citty": "^0.1.6",
+ "consola": "^3.4.0",
+ "pathe": "^2.0.3",
+ "pkg-types": "^2.0.0",
+ "tinyexec": "^0.3.2"
+ },
+ "bin": {
+ "nypm": "dist/cli.mjs"
+ },
+ "engines": {
+ "node": "^14.16.0 || >=16.10.0"
+ }
+ },
+ "node_modules/nypm/node_modules/tinyexec": {
+ "version": "0.3.2",
+ "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-0.3.2.tgz",
+ "integrity": "sha512-KQQR9yN7R5+OSwaK0XQoj22pwHoTlgYqmUscPYoknOoWCWfj/5/ABTMRi69FrKU5ffPVh5QcFikpWJI/P1ocHA==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/object-assign": {
+ "version": "4.1.1",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/object-inspect": {
+ "version": "1.13.1",
+ "dev": true,
+ "license": "MIT",
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/ohash": {
+ "version": "2.0.11",
+ "resolved": "https://registry.npmjs.org/ohash/-/ohash-2.0.11.tgz",
+ "integrity": "sha512-RdR9FQrFwNBNXAr4GixM8YaRZRJ5PUWbKYbE5eOsrwAjJW0q2REGcf79oYPsLyskQCZG1PLN+S/K1V00joZAoQ==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/on-finished": {
+ "version": "2.4.1",
+ "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz",
+ "integrity": "sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ee-first": "1.1.1"
+ },
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/on-headers": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/on-headers/-/on-headers-1.0.2.tgz",
+ "integrity": "sha512-pZAE+FJLoyITytdqK0U5s+FIpjN0JP3OzFi/u8Rx+EV5/W+JTWGXG8xFzevE7AjBfDqHv/8vL8qQsIhHnqRkrA==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/once": {
+ "version": "1.4.0",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "wrappy": "1"
+ }
+ },
+ "node_modules/onetime": {
+ "version": "7.0.0",
+ "resolved": "https://registry.npmjs.org/onetime/-/onetime-7.0.0.tgz",
+ "integrity": "sha512-VXJjc87FScF88uafS3JllDgvAm+c/Slfz06lorj2uAY34rlUu0Nt+v8wreiImcrgAjjIHp1rXpTDlLOGw29WwQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "mimic-function": "^5.0.0"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/open": {
+ "version": "10.1.2",
+ "resolved": "https://registry.npmjs.org/open/-/open-10.1.2.tgz",
+ "integrity": "sha512-cxN6aIDPz6rm8hbebcP7vrQNhvRcveZoJU72Y7vskh4oIm+BZwBECnx5nTmrlres1Qapvx27Qo1Auukpf8PKXw==",
+ "license": "MIT",
+ "dependencies": {
+ "default-browser": "^5.2.1",
+ "define-lazy-prop": "^3.0.0",
+ "is-inside-container": "^1.0.0",
+ "is-wsl": "^3.1.0"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/ora": {
+ "version": "8.2.0",
+ "resolved": "https://registry.npmjs.org/ora/-/ora-8.2.0.tgz",
+ "integrity": "sha512-weP+BZ8MVNnlCm8c0Qdc1WSWq4Qn7I+9CJGm7Qali6g44e/PUzbjNqJX5NJ9ljlNMosfJvg1fKEGILklK9cwnw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "chalk": "^5.3.0",
+ "cli-cursor": "^5.0.0",
+ "cli-spinners": "^2.9.2",
+ "is-interactive": "^2.0.0",
+ "is-unicode-supported": "^2.0.0",
+ "log-symbols": "^6.0.0",
+ "stdin-discarder": "^0.2.2",
+ "string-width": "^7.2.0",
+ "strip-ansi": "^7.1.0"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/ora/node_modules/ansi-regex": {
+ "version": "6.1.0",
+ "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.1.0.tgz",
+ "integrity": "sha512-7HSX4QQb4CspciLpVFwyRe79O3xsIZDDLER21kERQ71oaPodF8jL725AgJMFAYbooIqolJoRLuM81SpeUkpkvA==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/ansi-regex?sponsor=1"
+ }
+ },
+ "node_modules/ora/node_modules/chalk": {
+ "version": "5.4.1",
+ "resolved": "https://registry.npmjs.org/chalk/-/chalk-5.4.1.tgz",
+ "integrity": "sha512-zgVZuo2WcZgfUEmsn6eO3kINexW8RAE4maiQ8QNs8CtpPCSyMiYsULR3HQYkm3w8FIA3SberyMJMSldGsW+U3w==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": "^12.17.0 || ^14.13 || >=16.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/chalk?sponsor=1"
+ }
+ },
+ "node_modules/ora/node_modules/emoji-regex": {
+ "version": "10.4.0",
+ "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.4.0.tgz",
+ "integrity": "sha512-EC+0oUMY1Rqm4O6LLrgjtYDvcVYTy7chDnM4Q7030tP4Kwj3u/pR6gP9ygnp2CJMK5Gq+9Q2oqmrFJAz01DXjw==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/ora/node_modules/is-unicode-supported": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-2.1.0.tgz",
+ "integrity": "sha512-mE00Gnza5EEB3Ds0HfMyllZzbBrmLOX3vfWoj9A9PEnTfratQ/BcaJOuMhnkhjXvb2+FkY3VuHqtAGpTPmglFQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/ora/node_modules/log-symbols": {
+ "version": "6.0.0",
+ "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-6.0.0.tgz",
+ "integrity": "sha512-i24m8rpwhmPIS4zscNzK6MSEhk0DUWa/8iYQWxhffV8jkI4Phvs3F+quL5xvS0gdQR0FyTCMMH33Y78dDTzzIw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "chalk": "^5.3.0",
+ "is-unicode-supported": "^1.3.0"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/ora/node_modules/log-symbols/node_modules/is-unicode-supported": {
+ "version": "1.3.0",
+ "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-1.3.0.tgz",
+ "integrity": "sha512-43r2mRvz+8JRIKnWJ+3j8JtjRKZ6GmjzfaE/qiBJnikNnYv/6bagRJ1kUhNk8R5EX/GkobD+r+sfxCPJsiKBLQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/ora/node_modules/string-width": {
+ "version": "7.2.0",
+ "resolved": "https://registry.npmjs.org/string-width/-/string-width-7.2.0.tgz",
+ "integrity": "sha512-tsaTIkKW9b4N+AEj+SVA+WhJzV7/zMhcSu78mLKWSk7cXMOSHsBKFWUs0fWwq8QyK3MgJBQRX6Gbi4kYbdvGkQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "emoji-regex": "^10.3.0",
+ "get-east-asian-width": "^1.0.0",
+ "strip-ansi": "^7.1.0"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/ora/node_modules/strip-ansi": {
+ "version": "7.1.0",
+ "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz",
+ "integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ansi-regex": "^6.0.1"
+ },
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/strip-ansi?sponsor=1"
+ }
+ },
+ "node_modules/os-name": {
+ "version": "6.0.0",
+ "resolved": "https://registry.npmjs.org/os-name/-/os-name-6.0.0.tgz",
+ "integrity": "sha512-bv608E0UX86atYi2GMGjDe0vF/X1TJjemNS8oEW6z22YW1Rc3QykSYoGfkQbX0zZX9H0ZB6CQP/3GTf1I5hURg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "macos-release": "^3.2.0",
+ "windows-release": "^6.0.0"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/os-tmpdir": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/os-tmpdir/-/os-tmpdir-1.0.2.tgz",
+ "integrity": "sha512-D2FR03Vir7FIu45XBY20mTb+/ZSWB00sjU9jdQXt83gDrI4Ztz5Fs7/yy74g2N5SVQY4xY1qDr4rNddwYRVX0g==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/p-limit": {
+ "version": "3.1.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "yocto-queue": "^0.1.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/p-locate": {
+ "version": "5.0.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "p-limit": "^3.0.2"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/p-map": {
+ "version": "3.0.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "aggregate-error": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/p-try": {
+ "version": "2.2.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/pac-proxy-agent": {
+ "version": "7.2.0",
+ "resolved": "https://registry.npmjs.org/pac-proxy-agent/-/pac-proxy-agent-7.2.0.tgz",
+ "integrity": "sha512-TEB8ESquiLMc0lV8vcd5Ql/JAKAoyzHFXaStwjkzpOpC5Yv+pIzLfHvjTSdf3vpa2bMiUQrg9i6276yn8666aA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@tootallnate/quickjs-emscripten": "^0.23.0",
+ "agent-base": "^7.1.2",
+ "debug": "^4.3.4",
+ "get-uri": "^6.0.1",
+ "http-proxy-agent": "^7.0.0",
+ "https-proxy-agent": "^7.0.6",
+ "pac-resolver": "^7.0.1",
+ "socks-proxy-agent": "^8.0.5"
+ },
+ "engines": {
+ "node": ">= 14"
+ }
+ },
+ "node_modules/pac-resolver": {
+ "version": "7.0.1",
+ "resolved": "https://registry.npmjs.org/pac-resolver/-/pac-resolver-7.0.1.tgz",
+ "integrity": "sha512-5NPgf87AT2STgwa2ntRMr45jTKrYBGkVU36yT0ig/n/GMAa3oPqhZfIQ2kMEimReg0+t9kZViDVZ83qfVUlckg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "degenerator": "^5.0.0",
+ "netmask": "^2.0.2"
+ },
+ "engines": {
+ "node": ">= 14"
+ }
+ },
+ "node_modules/package-hash": {
+ "version": "4.0.0",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "graceful-fs": "^4.1.15",
+ "hasha": "^5.0.0",
+ "lodash.flattendeep": "^4.4.0",
+ "release-zalgo": "^1.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/parse-path": {
+ "version": "7.1.0",
+ "resolved": "https://registry.npmjs.org/parse-path/-/parse-path-7.1.0.tgz",
+ "integrity": "sha512-EuCycjZtfPcjWk7KTksnJ5xPMvWGA/6i4zrLYhRG0hGvC3GPU/jGUj3Cy+ZR0v30duV3e23R95T1lE2+lsndSw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "protocols": "^2.0.0"
+ }
+ },
+ "node_modules/parse-url": {
+ "version": "9.2.0",
+ "resolved": "https://registry.npmjs.org/parse-url/-/parse-url-9.2.0.tgz",
+ "integrity": "sha512-bCgsFI+GeGWPAvAiUv63ZorMeif3/U0zaXABGJbOWt5OH2KCaPHF6S+0ok4aqM9RuIPGyZdx9tR9l13PsW4AYQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@types/parse-path": "^7.0.0",
+ "parse-path": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=14.13.0"
+ }
+ },
+ "node_modules/parse5": {
+ "version": "7.3.0",
+ "resolved": "https://registry.npmjs.org/parse5/-/parse5-7.3.0.tgz",
+ "integrity": "sha512-IInvU7fabl34qmi9gY8XOVxhYyMyuH2xUNpb2q8/Y+7552KlejkRvqvD19nMoUW/uQGGbqNpA6Tufu5FL5BZgw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "entities": "^6.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/inikulin/parse5?sponsor=1"
+ }
+ },
+ "node_modules/parse5-htmlparser2-tree-adapter": {
+ "version": "7.1.0",
+ "resolved": "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-7.1.0.tgz",
+ "integrity": "sha512-ruw5xyKs6lrpo9x9rCZqZZnIUntICjQAd0Wsmp396Ul9lN/h+ifgVV1x1gZHi8euej6wTfpqX8j+BFQxF0NS/g==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "domhandler": "^5.0.3",
+ "parse5": "^7.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/inikulin/parse5?sponsor=1"
+ }
+ },
+ "node_modules/parse5-parser-stream": {
+ "version": "7.1.2",
+ "resolved": "https://registry.npmjs.org/parse5-parser-stream/-/parse5-parser-stream-7.1.2.tgz",
+ "integrity": "sha512-JyeQc9iwFLn5TbvvqACIF/VXG6abODeB3Fwmv/TGdLk2LfbWkaySGY72at4+Ty7EkPZj854u4CrICqNk2qIbow==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "parse5": "^7.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/inikulin/parse5?sponsor=1"
+ }
+ },
+ "node_modules/parse5/node_modules/entities": {
+ "version": "6.0.0",
+ "resolved": "https://registry.npmjs.org/entities/-/entities-6.0.0.tgz",
+ "integrity": "sha512-aKstq2TDOndCn4diEyp9Uq/Flu2i1GlLkc6XIDQSDMuaFE3OPW5OphLCyQ5SpSJZTb4reN+kTcYru5yIfXoRPw==",
+ "dev": true,
+ "license": "BSD-2-Clause",
+ "engines": {
+ "node": ">=0.12"
+ },
+ "funding": {
+ "url": "https://github.com/fb55/entities?sponsor=1"
+ }
+ },
+ "node_modules/parseurl": {
+ "version": "1.3.3",
+ "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz",
+ "integrity": "sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/path-exists": {
+ "version": "4.0.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/path-is-absolute": {
+ "version": "1.0.1",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/path-key": {
+ "version": "3.1.1",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/path-to-regexp": {
+ "version": "6.2.1",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/pathe": {
+ "version": "2.0.3",
+ "resolved": "https://registry.npmjs.org/pathe/-/pathe-2.0.3.tgz",
+ "integrity": "sha512-WUjGcAqP1gQacoQe+OBJsFA7Ld4DyXuUIjZ5cc75cLHvJ7dtNsTugphxIADwspS+AraAUePCKrSVtPLFj/F88w==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/perfect-debounce": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/perfect-debounce/-/perfect-debounce-1.0.0.tgz",
+ "integrity": "sha512-xCy9V055GLEqoFaHoC1SoLIaLmWctgCUaBaWxDZ7/Zx4CTyX7cJQLJOok/orfjZAh9kEYpjJa4d0KcJmCbctZA==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/picocolors": {
+ "version": "1.0.0",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/picomatch": {
+ "version": "2.3.1",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=8.6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/jonschlinkert"
+ }
+ },
+ "node_modules/pify": {
+ "version": "2.3.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/pinkie": {
+ "version": "2.0.4",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/pinkie-promise": {
+ "version": "2.0.1",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "pinkie": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/pkg-dir": {
+ "version": "4.2.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "find-up": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/pkg-dir/node_modules/find-up": {
+ "version": "4.1.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "locate-path": "^5.0.0",
+ "path-exists": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/pkg-dir/node_modules/locate-path": {
+ "version": "5.0.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "p-locate": "^4.1.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/pkg-dir/node_modules/p-limit": {
+ "version": "2.3.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "p-try": "^2.0.0"
+ },
+ "engines": {
+ "node": ">=6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/pkg-dir/node_modules/p-locate": {
+ "version": "4.1.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "p-limit": "^2.2.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/pkg-types": {
+ "version": "2.1.0",
+ "resolved": "https://registry.npmjs.org/pkg-types/-/pkg-types-2.1.0.tgz",
+ "integrity": "sha512-wmJwA+8ihJixSoHKxZJRBQG1oY8Yr9pGLzRmSsNms0iNWyHHAlZCa7mmKiFR10YPZuz/2k169JiS/inOjBCZ2A==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "confbox": "^0.2.1",
+ "exsolve": "^1.0.1",
+ "pathe": "^2.0.3"
+ }
+ },
+ "node_modules/process-on-spawn": {
+ "version": "1.0.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "fromentries": "^1.2.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/protocols": {
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/protocols/-/protocols-2.0.2.tgz",
+ "integrity": "sha512-hHVTzba3wboROl0/aWRRG9dMytgH6ow//STBZh43l/wQgmMhYhOFi0EHWAPtoCz9IAUymsyP0TSBHkhgMEGNnQ==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/proxy-addr": {
+ "version": "2.0.7",
+ "resolved": "https://registry.npmjs.org/proxy-addr/-/proxy-addr-2.0.7.tgz",
+ "integrity": "sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "forwarded": "0.2.0",
+ "ipaddr.js": "1.9.1"
+ },
+ "engines": {
+ "node": ">= 0.10"
+ }
+ },
+ "node_modules/proxy-agent": {
+ "version": "6.5.0",
+ "resolved": "https://registry.npmjs.org/proxy-agent/-/proxy-agent-6.5.0.tgz",
+ "integrity": "sha512-TmatMXdr2KlRiA2CyDu8GqR8EjahTG3aY3nXjdzFyoZbmB8hrBsTyMezhULIXKnC0jpfjlmiZ3+EaCzoInSu/A==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "agent-base": "^7.1.2",
+ "debug": "^4.3.4",
+ "http-proxy-agent": "^7.0.1",
+ "https-proxy-agent": "^7.0.6",
+ "lru-cache": "^7.14.1",
+ "pac-proxy-agent": "^7.1.0",
+ "proxy-from-env": "^1.1.0",
+ "socks-proxy-agent": "^8.0.5"
+ },
+ "engines": {
+ "node": ">= 14"
+ }
+ },
+ "node_modules/proxy-agent/node_modules/lru-cache": {
+ "version": "7.18.3",
+ "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.18.3.tgz",
+ "integrity": "sha512-jumlc0BIUrS3qJGgIkWZsyfAM7NCWiBcCDhnd+3NNM5KbBmLTgHVfWBcg6W+rLUsIpzpERPsvwUP7CckAQSOoA==",
+ "dev": true,
+ "license": "ISC",
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/proxy-from-env": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz",
+ "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/qs": {
+ "version": "6.13.0",
+ "resolved": "https://registry.npmjs.org/qs/-/qs-6.13.0.tgz",
+ "integrity": "sha512-+38qI9SOr8tfZ4QmJNplMUxqjbe7LKvvZgWdExBOmd+egZTtjLB67Gu0HRX3u/XOq7UU2Nx6nsjvS16Z9uwfpg==",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "dependencies": {
+ "side-channel": "^1.0.6"
+ },
+ "engines": {
+ "node": ">=0.6"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/queue-microtask": {
+ "version": "1.2.3",
+ "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz",
+ "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==",
+ "dev": true,
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "license": "MIT"
+ },
+ "node_modules/random-bytes": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/random-bytes/-/random-bytes-1.0.0.tgz",
+ "integrity": "sha512-iv7LhNVO047HzYR3InF6pUcUsPQiHTM1Qal51DcGSuZFBil1aBBWG5eHPNek7bvILMaYJ/8RU1e8w1AMdHmLQQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/randombytes": {
+ "version": "2.1.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "safe-buffer": "^5.1.0"
+ }
+ },
+ "node_modules/range-parser": {
+ "version": "1.2.1",
+ "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz",
+ "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/raw-body": {
+ "version": "2.5.2",
+ "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.5.2.tgz",
+ "integrity": "sha512-8zGqypfENjCIqGhgXToC8aB2r7YrBX+AQAfIPs/Mlk+BtPTztOvTS01NRW/3Eh60J+a48lt8qsCzirQ6loCVfA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "bytes": "3.1.2",
+ "http-errors": "2.0.0",
+ "iconv-lite": "0.4.24",
+ "unpipe": "1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/rc9": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/rc9/-/rc9-2.1.2.tgz",
+ "integrity": "sha512-btXCnMmRIBINM2LDZoEmOogIZU7Qe7zn4BpomSKZ/ykbLObuBdvG+mFq11DL6fjH1DRwHhrlgtYWG96bJiC7Cg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "defu": "^6.1.4",
+ "destr": "^2.0.3"
+ }
+ },
+ "node_modules/readdirp": {
+ "version": "3.6.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "picomatch": "^2.2.1"
+ },
+ "engines": {
+ "node": ">=8.10.0"
+ }
+ },
+ "node_modules/redis": {
+ "resolved": "packages/redis",
+ "link": true
+ },
+ "node_modules/release-it": {
+ "version": "19.0.2",
+ "resolved": "https://registry.npmjs.org/release-it/-/release-it-19.0.2.tgz",
+ "integrity": "sha512-tGRCcKeXNOMrK9Qe+ZIgQiMlQgjV8PLxZjTq1XGlCk5u1qPgx+Pps0i8HIt667FDt0wLjFtvn5o9ItpitKnVUA==",
+ "dev": true,
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/webpro"
+ },
+ {
+ "type": "opencollective",
+ "url": "https://opencollective.com/webpro"
+ }
+ ],
+ "license": "MIT",
+ "dependencies": {
+ "@nodeutils/defaults-deep": "1.1.0",
+ "@octokit/rest": "21.1.1",
+ "@phun-ky/typeof": "1.2.8",
+ "async-retry": "1.3.3",
+ "c12": "3.0.3",
+ "ci-info": "^4.2.0",
+ "eta": "3.5.0",
+ "git-url-parse": "16.1.0",
+ "inquirer": "12.6.0",
+ "issue-parser": "7.0.1",
+ "lodash.get": "4.4.2",
+ "lodash.merge": "4.6.2",
+ "mime-types": "3.0.1",
+ "new-github-release-url": "2.0.0",
+ "open": "10.1.2",
+ "ora": "8.2.0",
+ "os-name": "6.0.0",
+ "proxy-agent": "6.5.0",
+ "semver": "7.7.1",
+ "tinyexec": "1.0.1",
+ "tinyglobby": "0.2.13",
+ "undici": "6.21.2",
+ "url-join": "5.0.0",
+ "wildcard-match": "5.1.4",
+ "yargs-parser": "21.1.1"
+ },
+ "bin": {
+ "release-it": "bin/release-it.js"
+ },
+ "engines": {
+ "node": "^20.12.0 || >=22.0.0"
+ }
+ },
+ "node_modules/release-it/node_modules/mime-db": {
+ "version": "1.54.0",
+ "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.54.0.tgz",
+ "integrity": "sha512-aU5EJuIN2WDemCcAp2vFBfp/m4EAhWJnUNSSw0ixs7/kXbd6Pg64EmwJkNdFhB8aWt1sH2CTXrLxo/iAGV3oPQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/release-it/node_modules/mime-types": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-3.0.1.tgz",
+ "integrity": "sha512-xRc4oEhT6eaBpU1XF7AjpOFD+xQmXNB5OVKwp4tqCuBpHLS/ZbBDrc07mYTDqVMg6PfxUjjNp85O6Cd2Z/5HWA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "mime-db": "^1.54.0"
+ },
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/release-it/node_modules/semver": {
+ "version": "7.7.1",
+ "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.1.tgz",
+ "integrity": "sha512-hlq8tAfn0m/61p4BVRcPzIGr6LKiMwo4VM6dGi6pt4qcRkmNzTcWq6eCEjEh+qXjkMDvPlOFFSGwQjoEa6gyMA==",
+ "dev": true,
+ "license": "ISC",
+ "bin": {
+ "semver": "bin/semver.js"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/release-it/node_modules/undici": {
+ "version": "6.21.2",
+ "resolved": "https://registry.npmjs.org/undici/-/undici-6.21.2.tgz",
+ "integrity": "sha512-uROZWze0R0itiAKVPsYhFov9LxrPMHLMEQFszeI2gCN6bnIIZ8twzBCJcN2LJrBBLfrP0t1FW0g+JmKVl8Vk1g==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=18.17"
+ }
+ },
+ "node_modules/release-it/node_modules/yargs-parser": {
+ "version": "21.1.1",
+ "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz",
+ "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==",
+ "dev": true,
+ "license": "ISC",
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "node_modules/release-zalgo": {
+ "version": "1.0.0",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "es6-error": "^4.0.1"
+ },
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/require-directory": {
+ "version": "2.1.1",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/require-main-filename": {
+ "version": "2.0.0",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/resolve-from": {
+ "version": "5.0.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/resolve-pkg-maps": {
+ "version": "1.0.0",
+ "dev": true,
+ "license": "MIT",
+ "funding": {
+ "url": "https://github.com/privatenumber/resolve-pkg-maps?sponsor=1"
+ }
+ },
+ "node_modules/restore-cursor": {
+ "version": "5.1.0",
+ "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-5.1.0.tgz",
+ "integrity": "sha512-oMA2dcrw6u0YfxJQXm342bFKX/E4sG9rbTzO9ptUcR/e8A33cHuvStiYOwH7fszkZlZ1z/ta9AAoPk2F4qIOHA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "onetime": "^7.0.0",
+ "signal-exit": "^4.1.0"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/restore-cursor/node_modules/signal-exit": {
+ "version": "4.1.0",
+ "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz",
+ "integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==",
+ "dev": true,
+ "license": "ISC",
+ "engines": {
+ "node": ">=14"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/isaacs"
+ }
+ },
+ "node_modules/retry": {
+ "version": "0.13.1",
+ "resolved": "https://registry.npmjs.org/retry/-/retry-0.13.1.tgz",
+ "integrity": "sha512-XQBQ3I8W1Cge0Seh+6gjj03LbmRFWuoszgK9ooCpwYIrhhoO80pfq4cUkU5DkknwfOfFteRwlZ56PYOGYyFWdg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 4"
+ }
+ },
+ "node_modules/reusify": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.1.0.tgz",
+ "integrity": "sha512-g6QUff04oZpHs0eG5p83rFLhHeV00ug/Yf9nZM6fLeUrPguBTkTQOdpAWWspMh55TZfVQDPaN3NQJfbVRAxdIw==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "iojs": ">=1.0.0",
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/rimraf": {
+ "version": "3.0.2",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "glob": "^7.1.3"
+ },
+ "bin": {
+ "rimraf": "bin.js"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/isaacs"
+ }
+ },
+ "node_modules/run-applescript": {
+ "version": "7.0.0",
+ "license": "MIT",
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/run-async": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/run-async/-/run-async-3.0.0.tgz",
+ "integrity": "sha512-540WwVDOMxA6dN6We19EcT9sc3hkXPw5mzRNGM3FkdN/vtE9NFvj5lFAPNwUDmJjXidm3v7TC1cTE7t17Ulm1Q==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.12.0"
+ }
+ },
+ "node_modules/run-parallel": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz",
+ "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==",
+ "dev": true,
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "license": "MIT",
+ "dependencies": {
+ "queue-microtask": "^1.2.2"
+ }
+ },
+ "node_modules/rxjs": {
+ "version": "7.8.2",
+ "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-7.8.2.tgz",
+ "integrity": "sha512-dhKf903U/PQZY6boNNtAGdWbG85WAbjT/1xYoZIC7FAY0yWapOBQVsVrDl58W86//e1VpMNBtRV4MaXfdMySFA==",
+ "dev": true,
+ "license": "Apache-2.0",
+ "dependencies": {
+ "tslib": "^2.1.0"
+ }
+ },
+ "node_modules/safe-buffer": {
+ "version": "5.2.1",
+ "funding": [
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/feross"
+ },
+ {
+ "type": "patreon",
+ "url": "https://www.patreon.com/feross"
+ },
+ {
+ "type": "consulting",
+ "url": "https://feross.org/support"
+ }
+ ],
+ "license": "MIT"
+ },
+ "node_modules/safer-buffer": {
+ "version": "2.1.2",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/semver": {
+ "version": "6.3.1",
+ "dev": true,
+ "license": "ISC",
+ "bin": {
+ "semver": "bin/semver.js"
+ }
+ },
+ "node_modules/send": {
+ "version": "0.19.0",
+ "resolved": "https://registry.npmjs.org/send/-/send-0.19.0.tgz",
+ "integrity": "sha512-dW41u5VfLXu8SJh5bwRmyYUbAoSB3c9uQh6L8h/KtsFREPWpbX1lrljJo186Jc4nmci/sGUZ9a0a0J2zgfq2hw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "debug": "2.6.9",
+ "depd": "2.0.0",
+ "destroy": "1.2.0",
+ "encodeurl": "~1.0.2",
+ "escape-html": "~1.0.3",
+ "etag": "~1.8.1",
+ "fresh": "0.5.2",
+ "http-errors": "2.0.0",
+ "mime": "1.6.0",
+ "ms": "2.1.3",
+ "on-finished": "2.4.1",
+ "range-parser": "~1.2.1",
+ "statuses": "2.0.1"
+ },
+ "engines": {
+ "node": ">= 0.8.0"
+ }
+ },
+ "node_modules/send/node_modules/debug": {
+ "version": "2.6.9",
+ "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz",
+ "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ms": "2.0.0"
+ }
+ },
+ "node_modules/send/node_modules/debug/node_modules/ms": {
+ "version": "2.0.0",
+ "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
+ "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/send/node_modules/encodeurl": {
+ "version": "1.0.2",
+ "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-1.0.2.tgz",
+ "integrity": "sha512-TPJXq8JqFaVYm2CWmPvnP2Iyo4ZSM7/QKcSmuMLDObfpH5fi7RUGmd/rTDf+rut/saiDiQEeVTNgAmJEdAOx0w==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/serialize-javascript": {
+ "version": "6.0.0",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "dependencies": {
+ "randombytes": "^2.1.0"
+ }
+ },
+ "node_modules/serve-static": {
+ "version": "1.16.2",
+ "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.16.2.tgz",
+ "integrity": "sha512-VqpjJZKadQB/PEbEwvFdO43Ax5dFBZ2UECszz8bQ7pi7wt//PWe1P6MN7eCnjsatYtBT6EuiClbjSWP2WrIoTw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "encodeurl": "~2.0.0",
+ "escape-html": "~1.0.3",
+ "parseurl": "~1.3.3",
+ "send": "0.19.0"
+ },
+ "engines": {
+ "node": ">= 0.8.0"
+ }
+ },
+ "node_modules/set-blocking": {
+ "version": "2.0.0",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/set-function-length": {
+ "version": "1.2.2",
+ "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz",
+ "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "define-data-property": "^1.1.4",
+ "es-errors": "^1.3.0",
+ "function-bind": "^1.1.2",
+ "get-intrinsic": "^1.2.4",
+ "gopd": "^1.0.1",
+ "has-property-descriptors": "^1.0.2"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ }
+ },
+ "node_modules/setprototypeof": {
+ "version": "1.2.0",
+ "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.2.0.tgz",
+ "integrity": "sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/shebang-command": {
+ "version": "2.0.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "shebang-regex": "^3.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/shebang-regex": {
+ "version": "3.0.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/shiki": {
+ "version": "0.14.7",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ansi-sequence-parser": "^1.1.0",
+ "jsonc-parser": "^3.2.0",
+ "vscode-oniguruma": "^1.7.0",
+ "vscode-textmate": "^8.0.0"
+ }
+ },
+ "node_modules/side-channel": {
+ "version": "1.0.6",
+ "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.6.tgz",
+ "integrity": "sha512-fDW/EZ6Q9RiO8eFG8Hj+7u/oW+XrPTIChwCOM2+th2A6OblDtYYIpve9m+KvI9Z4C9qSEXlaGR6bTEYHReuglA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "call-bind": "^1.0.7",
+ "es-errors": "^1.3.0",
+ "get-intrinsic": "^1.2.4",
+ "object-inspect": "^1.13.1"
+ },
+ "engines": {
+ "node": ">= 0.4"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/ljharb"
+ }
+ },
+ "node_modules/signal-exit": {
+ "version": "3.0.7",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/sinon": {
+ "version": "17.0.1",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "dependencies": {
+ "@sinonjs/commons": "^3.0.0",
+ "@sinonjs/fake-timers": "^11.2.2",
+ "@sinonjs/samsam": "^8.0.0",
+ "diff": "^5.1.0",
+ "nise": "^5.1.5",
+ "supports-color": "^7.2.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/sinon"
+ }
+ },
+ "node_modules/sinon/node_modules/diff": {
+ "version": "5.1.0",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "engines": {
+ "node": ">=0.3.1"
+ }
+ },
+ "node_modules/sinon/node_modules/supports-color": {
+ "version": "7.2.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "has-flag": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/smart-buffer": {
+ "version": "4.2.0",
+ "resolved": "https://registry.npmjs.org/smart-buffer/-/smart-buffer-4.2.0.tgz",
+ "integrity": "sha512-94hK0Hh8rPqQl2xXc3HsaBoOXKV20MToPkcXvwbISWLEs+64sBq5kFgn2kJDHb1Pry9yrP0dxrCI9RRci7RXKg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 6.0.0",
+ "npm": ">= 3.0.0"
+ }
+ },
+ "node_modules/socks": {
+ "version": "2.8.4",
+ "resolved": "https://registry.npmjs.org/socks/-/socks-2.8.4.tgz",
+ "integrity": "sha512-D3YaD0aRxR3mEcqnidIs7ReYJFVzWdd6fXJYUM8ixcQcJRGTka/b3saV0KflYhyVJXKhb947GndU35SxYNResQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ip-address": "^9.0.5",
+ "smart-buffer": "^4.2.0"
+ },
+ "engines": {
+ "node": ">= 10.0.0",
+ "npm": ">= 3.0.0"
+ }
+ },
+ "node_modules/socks-proxy-agent": {
+ "version": "8.0.5",
+ "resolved": "https://registry.npmjs.org/socks-proxy-agent/-/socks-proxy-agent-8.0.5.tgz",
+ "integrity": "sha512-HehCEsotFqbPW9sJ8WVYB6UbmIMv7kUUORIF2Nncq4VQvBfNBLibW9YZR5dlYCSUhwcD628pRllm7n+E+YTzJw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "agent-base": "^7.1.2",
+ "debug": "^4.3.4",
+ "socks": "^2.8.3"
+ },
+ "engines": {
+ "node": ">= 14"
+ }
+ },
+ "node_modules/source-map": {
+ "version": "0.6.1",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/spawn-wrap": {
+ "version": "2.0.0",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "foreground-child": "^2.0.0",
+ "is-windows": "^1.0.2",
+ "make-dir": "^3.0.0",
+ "rimraf": "^3.0.0",
+ "signal-exit": "^3.0.2",
+ "which": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/sprintf-js": {
+ "version": "1.0.3",
+ "dev": true,
+ "license": "BSD-3-Clause"
+ },
+ "node_modules/statuses": {
+ "version": "2.0.1",
+ "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz",
+ "integrity": "sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/stdin-discarder": {
+ "version": "0.2.2",
+ "resolved": "https://registry.npmjs.org/stdin-discarder/-/stdin-discarder-0.2.2.tgz",
+ "integrity": "sha512-UhDfHmA92YAlNnCfhmq0VeNL5bDbiZGg7sZ2IvPsXubGkiNa9EC+tUTsjBRsYUAz87btI6/1wf4XoVvQ3uRnmQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/stoppable": {
+ "version": "1.1.0",
+ "resolved": "https://registry.npmjs.org/stoppable/-/stoppable-1.1.0.tgz",
+ "integrity": "sha512-KXDYZ9dszj6bzvnEMRYvxgeTHU74QBFL54XKtP3nyMuJ81CFYtABZ3bAzL2EdFUaEwJOBOgENyFj3R7oTzDyyw==",
+ "license": "MIT",
+ "engines": {
+ "node": ">=4",
+ "npm": ">=6"
+ }
+ },
+ "node_modules/string-width": {
+ "version": "4.2.3",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "emoji-regex": "^8.0.0",
+ "is-fullwidth-code-point": "^3.0.0",
+ "strip-ansi": "^6.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/strip-ansi": {
+ "version": "6.0.1",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ansi-regex": "^5.0.1"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/strip-bom": {
+ "version": "4.0.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/strip-final-newline": {
+ "version": "3.0.0",
+ "resolved": "https://registry.npmjs.org/strip-final-newline/-/strip-final-newline-3.0.0.tgz",
+ "integrity": "sha512-dOESqjYr96iWYylGObzd39EuNTa5VJxyvVAEm5Jnh7KGo75V43Hk1odPQkNDyXNmUR6k+gEiDVXnjB8HJ3crXw==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/strip-json-comments": {
+ "version": "3.1.1",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=8"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/strip-outer": {
+ "version": "1.0.1",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "escape-string-regexp": "^1.0.2"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/strip-outer/node_modules/escape-string-regexp": {
+ "version": "1.0.5",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.8.0"
+ }
+ },
+ "node_modules/supports-color": {
+ "version": "8.1.1",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "has-flag": "^4.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/supports-color?sponsor=1"
+ }
+ },
+ "node_modules/test-exclude": {
+ "version": "6.0.0",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "@istanbuljs/schema": "^0.1.2",
+ "glob": "^7.1.4",
+ "minimatch": "^3.0.4"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/tinyexec": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/tinyexec/-/tinyexec-1.0.1.tgz",
+ "integrity": "sha512-5uC6DDlmeqiOwCPmK9jMSdOuZTh8bU39Ys6yidB+UTt5hfZUPGAypSgFRiEp+jbi9qH40BLDvy85jIU88wKSqw==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/tinyglobby": {
+ "version": "0.2.13",
+ "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.13.tgz",
+ "integrity": "sha512-mEwzpUgrLySlveBwEVDMKk5B57bhLPYovRfPAXD5gA/98Opn0rCDj3GtLwFvCvH5RK9uPCExUROW5NjDwvqkxw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "fdir": "^6.4.4",
+ "picomatch": "^4.0.2"
+ },
+ "engines": {
+ "node": ">=12.0.0"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/SuperchupuDev"
+ }
+ },
+ "node_modules/tinyglobby/node_modules/fdir": {
+ "version": "6.4.4",
+ "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.4.4.tgz",
+ "integrity": "sha512-1NZP+GK4GfuAv3PqKvxQRDMjdSRZjnkq7KfhlNrCNNlZ0ygQFpebfrnfnq/W7fpUnAv9aGWmY1zKx7FYL3gwhg==",
+ "dev": true,
+ "license": "MIT",
+ "peerDependencies": {
+ "picomatch": "^3 || ^4"
+ },
+ "peerDependenciesMeta": {
+ "picomatch": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/tinyglobby/node_modules/picomatch": {
+ "version": "4.0.2",
+ "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.2.tgz",
+ "integrity": "sha512-M7BAV6Rlcy5u+m6oPhAPFgJTzAioX/6B0DxyvDlo9l8+T3nLKbrczg2WLUyzd45L8RqfUMyGPzekbMvX2Ldkwg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=12"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/jonschlinkert"
+ }
+ },
+ "node_modules/tmp": {
+ "version": "0.0.33",
+ "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.0.33.tgz",
+ "integrity": "sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "os-tmpdir": "~1.0.2"
+ },
+ "engines": {
+ "node": ">=0.6.0"
+ }
+ },
+ "node_modules/to-fast-properties": {
+ "version": "2.0.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/to-regex-range": {
+ "version": "5.0.1",
+ "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz",
+ "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "is-number": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=8.0"
+ }
+ },
+ "node_modules/toidentifier": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz",
+ "integrity": "sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.6"
+ }
+ },
+ "node_modules/trim-repeated": {
+ "version": "1.0.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "escape-string-regexp": "^1.0.2"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/trim-repeated/node_modules/escape-string-regexp": {
+ "version": "1.0.5",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=0.8.0"
+ }
+ },
+ "node_modules/ts-node": {
+ "version": "10.9.2",
+ "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz",
+ "integrity": "sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "@cspotcode/source-map-support": "^0.8.0",
+ "@tsconfig/node10": "^1.0.7",
+ "@tsconfig/node12": "^1.0.7",
+ "@tsconfig/node14": "^1.0.0",
+ "@tsconfig/node16": "^1.0.2",
+ "acorn": "^8.4.1",
+ "acorn-walk": "^8.1.1",
+ "arg": "^4.1.0",
+ "create-require": "^1.1.0",
+ "diff": "^4.0.1",
+ "make-error": "^1.1.1",
+ "v8-compile-cache-lib": "^3.0.1",
+ "yn": "3.1.1"
+ },
+ "bin": {
+ "ts-node": "dist/bin.js",
+ "ts-node-cwd": "dist/bin-cwd.js",
+ "ts-node-esm": "dist/bin-esm.js",
+ "ts-node-script": "dist/bin-script.js",
+ "ts-node-transpile-only": "dist/bin-transpile.js",
+ "ts-script": "dist/bin-script-deprecated.js"
+ },
+ "peerDependencies": {
+ "@swc/core": ">=1.2.50",
+ "@swc/wasm": ">=1.2.50",
+ "@types/node": "*",
+ "typescript": ">=2.7"
+ },
+ "peerDependenciesMeta": {
+ "@swc/core": {
+ "optional": true
+ },
+ "@swc/wasm": {
+ "optional": true
+ }
+ }
+ },
+ "node_modules/ts-node/node_modules/diff": {
+ "version": "4.0.2",
+ "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz",
+ "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==",
+ "dev": true,
+ "license": "BSD-3-Clause",
+ "engines": {
+ "node": ">=0.3.1"
+ }
+ },
+ "node_modules/tslib": {
+ "version": "2.6.2",
+ "license": "0BSD"
+ },
+ "node_modules/tsx": {
+ "version": "4.7.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "esbuild": "~0.19.10",
+ "get-tsconfig": "^4.7.2"
+ },
+ "bin": {
+ "tsx": "dist/cli.mjs"
+ },
+ "engines": {
+ "node": ">=18.0.0"
+ },
+ "optionalDependencies": {
+ "fsevents": "~2.3.3"
+ }
+ },
+ "node_modules/type-detect": {
+ "version": "4.0.8",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=4"
+ }
+ },
+ "node_modules/type-fest": {
+ "version": "0.8.1",
+ "dev": true,
+ "license": "(MIT OR CC0-1.0)",
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/type-is": {
+ "version": "1.6.18",
+ "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz",
+ "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "media-typer": "0.3.0",
+ "mime-types": "~2.1.24"
+ },
+ "engines": {
+ "node": ">= 0.6"
+ }
+ },
+ "node_modules/typedarray-to-buffer": {
+ "version": "3.1.5",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "is-typedarray": "^1.0.0"
+ }
+ },
+ "node_modules/typedoc": {
+ "version": "0.25.7",
+ "dev": true,
+ "license": "Apache-2.0",
+ "dependencies": {
+ "lunr": "^2.3.9",
+ "marked": "^4.3.0",
+ "minimatch": "^9.0.3",
+ "shiki": "^0.14.7"
+ },
+ "bin": {
+ "typedoc": "bin/typedoc"
+ },
+ "engines": {
+ "node": ">= 16"
+ },
+ "peerDependencies": {
+ "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x"
+ }
+ },
+ "node_modules/typedoc/node_modules/brace-expansion": {
+ "version": "2.0.1",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "balanced-match": "^1.0.0"
+ }
+ },
+ "node_modules/typedoc/node_modules/minimatch": {
+ "version": "9.0.3",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "brace-expansion": "^2.0.1"
+ },
+ "engines": {
+ "node": ">=16 || 14 >=14.17"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/isaacs"
+ }
+ },
+ "node_modules/typescript": {
+ "version": "5.3.3",
+ "dev": true,
+ "license": "Apache-2.0",
+ "bin": {
+ "tsc": "bin/tsc",
+ "tsserver": "bin/tsserver"
+ },
+ "engines": {
+ "node": ">=14.17"
+ }
+ },
+ "node_modules/uid-safe": {
+ "version": "2.1.5",
+ "resolved": "https://registry.npmjs.org/uid-safe/-/uid-safe-2.1.5.tgz",
+ "integrity": "sha512-KPHm4VL5dDXKz01UuEd88Df+KzynaohSL9fBh096KWAxSKZQDI2uBrVqtvRM4rwrIrRRKsdLNML/lnaaVSRioA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "random-bytes": "~1.0.0"
+ },
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/undici": {
+ "version": "6.21.3",
+ "resolved": "https://registry.npmjs.org/undici/-/undici-6.21.3.tgz",
+ "integrity": "sha512-gBLkYIlEnSp8pFbT64yFgGE6UIB9tAkhukC23PmMDCe5Nd+cRqKxSjw5y54MK2AZMgZfJWMaNE4nYUHgi1XEOw==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=18.17"
+ }
+ },
+ "node_modules/undici-types": {
+ "version": "5.26.5",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/universal-user-agent": {
+ "version": "7.0.3",
+ "resolved": "https://registry.npmjs.org/universal-user-agent/-/universal-user-agent-7.0.3.tgz",
+ "integrity": "sha512-TmnEAEAsBJVZM/AADELsK76llnwcf9vMKuPz8JflO1frO8Lchitr0fNaN9d+Ap0BjKtqWqd/J17qeDnXh8CL2A==",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/universalify": {
+ "version": "2.0.1",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 10.0.0"
+ }
+ },
+ "node_modules/unpipe": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz",
+ "integrity": "sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/update-browserslist-db": {
+ "version": "1.0.13",
+ "dev": true,
+ "funding": [
+ {
+ "type": "opencollective",
+ "url": "https://opencollective.com/browserslist"
+ },
+ {
+ "type": "tidelift",
+ "url": "https://tidelift.com/funding/github/npm/browserslist"
+ },
+ {
+ "type": "github",
+ "url": "https://github.com/sponsors/ai"
+ }
+ ],
+ "license": "MIT",
+ "dependencies": {
+ "escalade": "^3.1.1",
+ "picocolors": "^1.0.0"
+ },
+ "bin": {
+ "update-browserslist-db": "cli.js"
+ },
+ "peerDependencies": {
+ "browserslist": ">= 4.21.0"
+ }
+ },
+ "node_modules/url-join": {
+ "version": "5.0.0",
+ "resolved": "https://registry.npmjs.org/url-join/-/url-join-5.0.0.tgz",
+ "integrity": "sha512-n2huDr9h9yzd6exQVnH/jU5mr+Pfx08LRXXZhkLLetAMESRj+anQsTAh940iMrIetKAmry9coFuZQ2jY8/p3WA==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+ }
+ },
+ "node_modules/utils-merge": {
+ "version": "1.0.1",
+ "resolved": "https://registry.npmjs.org/utils-merge/-/utils-merge-1.0.1.tgz",
+ "integrity": "sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.4.0"
+ }
+ },
+ "node_modules/uuid": {
+ "version": "8.3.2",
+ "license": "MIT",
+ "bin": {
+ "uuid": "dist/bin/uuid"
+ }
+ },
+ "node_modules/v8-compile-cache-lib": {
+ "version": "3.0.1",
+ "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz",
+ "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/vary": {
+ "version": "1.1.2",
+ "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz",
+ "integrity": "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">= 0.8"
+ }
+ },
+ "node_modules/vscode-oniguruma": {
+ "version": "1.7.0",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/vscode-textmate": {
+ "version": "8.0.0",
+ "dev": true,
+ "license": "MIT"
+ },
+ "node_modules/whatwg-encoding": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/whatwg-encoding/-/whatwg-encoding-3.1.1.tgz",
+ "integrity": "sha512-6qN4hJdMwfYBtE3YBTTHhoeuUrDBPZmbQaxWAqSALV/MeEnR5z1xd8UKud2RAkFoPkmB+hli1TZSnyi84xz1vQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "iconv-lite": "0.6.3"
+ },
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/whatwg-encoding/node_modules/iconv-lite": {
+ "version": "0.6.3",
+ "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz",
+ "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "safer-buffer": ">= 2.1.2 < 3.0.0"
+ },
+ "engines": {
+ "node": ">=0.10.0"
+ }
+ },
+ "node_modules/whatwg-mimetype": {
+ "version": "4.0.0",
+ "resolved": "https://registry.npmjs.org/whatwg-mimetype/-/whatwg-mimetype-4.0.0.tgz",
+ "integrity": "sha512-QaKxh0eNIi2mE9p2vEdzfagOKHCcj1pJ56EEHGQOVxp8r9/iszLUUV7v89x9O1p/T+NlTM5W7jW6+cz4Fq1YVg==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=18"
+ }
+ },
+ "node_modules/which": {
+ "version": "2.0.2",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "isexe": "^2.0.0"
+ },
+ "bin": {
+ "node-which": "bin/node-which"
+ },
+ "engines": {
+ "node": ">= 8"
+ }
+ },
+ "node_modules/which-module": {
+ "version": "2.0.1",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/wildcard-match": {
+ "version": "5.1.4",
+ "resolved": "https://registry.npmjs.org/wildcard-match/-/wildcard-match-5.1.4.tgz",
+ "integrity": "sha512-wldeCaczs8XXq7hj+5d/F38JE2r7EXgb6WQDM84RVwxy81T/sxB5e9+uZLK9Q9oNz1mlvjut+QtvgaOQFPVq/g==",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/windows-release": {
+ "version": "6.1.0",
+ "resolved": "https://registry.npmjs.org/windows-release/-/windows-release-6.1.0.tgz",
+ "integrity": "sha512-1lOb3qdzw6OFmOzoY0nauhLG72TpWtb5qgYPiSh/62rjc1XidBSDio2qw0pwHh17VINF217ebIkZJdFLZFn9SA==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "execa": "^8.0.1"
+ },
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/workerpool": {
+ "version": "6.2.1",
+ "dev": true,
+ "license": "Apache-2.0"
+ },
+ "node_modules/wrap-ansi": {
+ "version": "6.2.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ansi-styles": "^4.0.0",
+ "string-width": "^4.1.0",
+ "strip-ansi": "^6.0.0"
+ },
+ "engines": {
+ "node": ">=8"
+ }
+ },
+ "node_modules/wrappy": {
+ "version": "1.0.2",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/write-file-atomic": {
+ "version": "3.0.3",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "imurmurhash": "^0.1.4",
+ "is-typedarray": "^1.0.0",
+ "signal-exit": "^3.0.2",
+ "typedarray-to-buffer": "^3.1.5"
+ }
+ },
+ "node_modules/y18n": {
+ "version": "5.0.8",
+ "dev": true,
+ "license": "ISC",
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/yallist": {
+ "version": "3.1.1",
+ "dev": true,
+ "license": "ISC"
+ },
+ "node_modules/yargs": {
+ "version": "16.2.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "cliui": "^7.0.2",
+ "escalade": "^3.1.1",
+ "get-caller-file": "^2.0.5",
+ "require-directory": "^2.1.1",
+ "string-width": "^4.2.0",
+ "y18n": "^5.0.5",
+ "yargs-parser": "^20.2.2"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/yargs-parser": {
+ "version": "20.2.4",
+ "dev": true,
+ "license": "ISC",
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/yargs-unparser": {
+ "version": "2.0.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "camelcase": "^6.0.0",
+ "decamelize": "^4.0.0",
+ "flat": "^5.0.2",
+ "is-plain-obj": "^2.1.0"
+ },
+ "engines": {
+ "node": ">=10"
+ }
+ },
+ "node_modules/yargs-unparser/node_modules/camelcase": {
+ "version": "6.3.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/yargs-unparser/node_modules/decamelize": {
+ "version": "4.0.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/yn": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz",
+ "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=6"
+ }
+ },
+ "node_modules/yocto-queue": {
+ "version": "0.1.0",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "node_modules/yoctocolors-cjs": {
+ "version": "2.1.2",
+ "resolved": "https://registry.npmjs.org/yoctocolors-cjs/-/yoctocolors-cjs-2.1.2.tgz",
+ "integrity": "sha512-cYVsTjKl8b+FrnidjibDWskAv7UKOfcwaVZdp/it9n1s9fU3IkgDbhdIRKCW4JDsAlECJY0ytoVPT3sK6kideA==",
+ "dev": true,
+ "license": "MIT",
+ "engines": {
+ "node": ">=18"
+ },
+ "funding": {
+ "url": "https://github.com/sponsors/sindresorhus"
+ }
+ },
+ "packages/bloom": {
+ "name": "@redis/bloom",
+ "version": "5.9.0-beta.2",
+ "license": "MIT",
+ "devDependencies": {
+ "@redis/test-utils": "*"
+ },
+ "engines": {
+ "node": ">= 18"
+ },
+ "peerDependencies": {
+ "@redis/client": "^5.9.0-beta.2"
+ }
+ },
+ "packages/client": {
+ "name": "@redis/client",
+ "version": "5.9.0-beta.2",
+ "license": "MIT",
+ "dependencies": {
+ "cluster-key-slot": "1.1.2"
+ },
+ "devDependencies": {
+ "@redis/test-utils": "*",
+ "@types/sinon": "^17.0.3",
+ "sinon": "^17.0.1"
+ },
+ "engines": {
+ "node": ">= 18"
+ }
+ },
+ "packages/entraid": {
+ "name": "@redis/entraid",
+ "version": "5.9.0-beta.2",
+ "license": "MIT",
+ "dependencies": {
+ "@azure/identity": "^4.7.0",
+ "@azure/msal-node": "^2.16.1"
+ },
+ "devDependencies": {
+ "@redis/test-utils": "*",
+ "@types/express": "^4.17.21",
+ "@types/express-session": "^1.18.0",
+ "@types/node": "^22.9.0",
+ "dotenv": "^16.3.1",
+ "express": "^4.21.1",
+ "express-session": "^1.18.1"
+ },
+ "engines": {
+ "node": ">= 18"
+ },
+ "peerDependencies": {
+ "@redis/client": "^5.9.0-beta.2"
+ }
+ },
+ "packages/entraid/node_modules/@types/node": {
+ "version": "22.10.2",
+ "resolved": "https://registry.npmjs.org/@types/node/-/node-22.10.2.tgz",
+ "integrity": "sha512-Xxr6BBRCAOQixvonOye19wnzyDiUtTeqldOOmj3CkeblonbccA12PFwlufvRdrpjXxqnmUaeiU5EOA+7s5diUQ==",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "undici-types": "~6.20.0"
+ }
+ },
+ "packages/entraid/node_modules/undici-types": {
+ "version": "6.20.0",
+ "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.20.0.tgz",
+ "integrity": "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg==",
+ "dev": true,
+ "license": "MIT"
+ },
+ "packages/graph": {
+ "name": "@redis/graph",
+ "version": "5.0.0-next.6",
+ "extraneous": true,
+ "license": "MIT",
+ "devDependencies": {
+ "@redis/test-utils": "*"
+ },
+ "engines": {
+ "node": ">= 18"
+ },
+ "peerDependencies": {
+ "@redis/client": "^5.0.0-next.6"
+ }
+ },
+ "packages/json": {
+ "name": "@redis/json",
+ "version": "5.9.0-beta.2",
+ "license": "MIT",
+ "devDependencies": {
+ "@redis/test-utils": "*"
+ },
+ "engines": {
+ "node": ">= 18"
+ },
+ "peerDependencies": {
+ "@redis/client": "^5.9.0-beta.2"
+ }
+ },
+ "packages/redis": {
+ "version": "5.9.0-beta.2",
+ "license": "MIT",
+ "dependencies": {
+ "@redis/bloom": "5.9.0-beta.2",
+ "@redis/client": "5.9.0-beta.2",
+ "@redis/json": "5.9.0-beta.2",
+ "@redis/search": "5.9.0-beta.2",
+ "@redis/time-series": "5.9.0-beta.2"
+ },
+ "engines": {
+ "node": ">= 18"
+ }
+ },
+ "packages/search": {
+ "name": "@redis/search",
+ "version": "5.9.0-beta.2",
+ "license": "MIT",
+ "devDependencies": {
+ "@redis/test-utils": "*"
+ },
+ "engines": {
+ "node": ">= 18"
+ },
+ "peerDependencies": {
+ "@redis/client": "^5.9.0-beta.2"
+ }
+ },
+ "packages/test-utils": {
+ "name": "@redis/test-utils",
+ "devDependencies": {
+ "@types/yargs": "^17.0.32",
+ "yargs": "^17.7.2"
+ },
+ "peerDependencies": {
+ "@redis/client": "*"
+ }
+ },
+ "packages/test-utils/node_modules/cliui": {
+ "version": "8.0.1",
+ "dev": true,
+ "license": "ISC",
+ "dependencies": {
+ "string-width": "^4.2.0",
+ "strip-ansi": "^6.0.1",
+ "wrap-ansi": "^7.0.0"
+ },
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "packages/test-utils/node_modules/wrap-ansi": {
+ "version": "7.0.0",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "ansi-styles": "^4.0.0",
+ "string-width": "^4.1.0",
+ "strip-ansi": "^6.0.0"
+ },
+ "engines": {
+ "node": ">=10"
+ },
+ "funding": {
+ "url": "https://github.com/chalk/wrap-ansi?sponsor=1"
+ }
+ },
+ "packages/test-utils/node_modules/yargs": {
+ "version": "17.7.2",
+ "dev": true,
+ "license": "MIT",
+ "dependencies": {
+ "cliui": "^8.0.1",
+ "escalade": "^3.1.1",
+ "get-caller-file": "^2.0.5",
+ "require-directory": "^2.1.1",
+ "string-width": "^4.2.3",
+ "y18n": "^5.0.5",
+ "yargs-parser": "^21.1.1"
+ },
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "packages/test-utils/node_modules/yargs-parser": {
+ "version": "21.1.1",
+ "dev": true,
+ "license": "ISC",
+ "engines": {
+ "node": ">=12"
+ }
+ },
+ "packages/time-series": {
+ "name": "@redis/time-series",
+ "version": "5.9.0-beta.2",
+ "license": "MIT",
+ "devDependencies": {
+ "@redis/test-utils": "*"
+ },
+ "engines": {
+ "node": ">= 18"
+ },
+ "peerDependencies": {
+ "@redis/client": "^5.9.0-beta.2"
+ }
+ }
+ }
+}
diff --git a/package.json b/package.json
index cf1248cd18e..e192e69d55e 100644
--- a/package.json
+++ b/package.json
@@ -1,29 +1,36 @@
-{ "name" : "redis",
- "version" : "0.7.1",
- "description" : "Redis client library",
- "author": "Matt Ranney ",
- "contributors": [
- "Rick Olson",
- "Tim-Smart",
- "TJ Holowaychuk",
- "Orion Henry",
- "Hank Sims",
- "Aivo Paas",
- "Paul Carey",
- "Pieter Noordhuis",
- "Andy Ray",
- "Vladimir Dronnikov",
- "Dave Hoover"
- ],
- "main": "./index.js",
- "scripts": {
- "test": "node ./test.js"
- },
- "devDependencies": {
- "metrics": ">=0.1.5"
- },
- "repository": {
- "type": "git",
- "url": "git://github.com/mranney/node_redis.git"
- }
+{
+ "name": "redis-monorepo",
+ "private": true,
+ "workspaces": [
+ "./packages/client",
+ "./packages/test-utils",
+ "./packages/bloom",
+ "./packages/json",
+ "./packages/search",
+ "./packages/time-series",
+ "./packages/entraid",
+ "./packages/redis"
+ ],
+ "scripts": {
+ "test-single": "TS_NODE_PROJECT='./packages/test-utils/tsconfig.json' mocha --require ts-node/register/transpile-only ",
+ "test": "npm run test -ws --if-present",
+ "build": "tsc --build",
+ "documentation": "typedoc --out ./documentation",
+ "gh-pages": "gh-pages -d ./documentation -e ./documentation -u 'documentation-bot '",
+ "release": "npm run release --workspaces --if-present --"
+ },
+ "devDependencies": {
+ "@istanbuljs/nyc-config-typescript": "^1.0.2",
+ "@release-it/bumper": "^7.0.5",
+ "@types/mocha": "^10.0.6",
+ "@types/node": "^20.11.16",
+ "gh-pages": "^6.1.1",
+ "mocha": "^10.2.0",
+ "nyc": "^15.1.0",
+ "release-it": "^19.0.2",
+ "ts-node": "^10.9.2",
+ "tsx": "^4.7.0",
+ "typedoc": "^0.25.7",
+ "typescript": "^5.3.3"
+ }
}
diff --git a/packages/bloom/.nycrc.json b/packages/bloom/.nycrc.json
new file mode 100644
index 00000000000..367a89ad32c
--- /dev/null
+++ b/packages/bloom/.nycrc.json
@@ -0,0 +1,4 @@
+{
+ "extends": "@istanbuljs/nyc-config-typescript",
+ "exclude": ["dist", "**/*.spec.ts", "lib/test-utils.ts"]
+}
diff --git a/packages/bloom/.release-it.json b/packages/bloom/.release-it.json
new file mode 100644
index 00000000000..23e1cf09078
--- /dev/null
+++ b/packages/bloom/.release-it.json
@@ -0,0 +1,22 @@
+{
+ "npm": {
+ "publish": true,
+ "publishArgs": ["--access", "public"]
+ },
+ "git": {
+ "tagName": "bloom@${version}",
+ "tagMatch": "bloom@*",
+ "commitMessage": "Release ${tagName}",
+ "tagAnnotation": "Release ${tagName}",
+ "commitArgs": "--all"
+ },
+ "plugins": {
+ "@release-it/bumper": {
+ "out": {
+ "file": "package.json",
+ "path": ["peerDependencies.@redis/client"],
+ "versionPrefix": "^"
+ }
+ }
+ }
+}
diff --git a/packages/bloom/README.md b/packages/bloom/README.md
new file mode 100644
index 00000000000..e527ff5552c
--- /dev/null
+++ b/packages/bloom/README.md
@@ -0,0 +1,17 @@
+# @redis/bloom
+
+This package provides support for the [RedisBloom](https://redis.io/docs/data-types/probabilistic/) module, which adds additional probabilistic data structures to Redis.
+
+Should be used with [`redis`/`@redis/client`](https://github.com/redis/node-redis).
+
+:warning: To use these extra commands, your Redis server must have the RedisBloom module installed.
+
+RedisBloom provides the following probabilistic data structures:
+
+* Bloom Filter: for checking set membership with a high degree of certainty.
+* Cuckoo Filter: for checking set membership with a high degree of certainty.
+* T-Digest: for estimating the quantiles of a stream of data.
+* Top-K: Maintain a list of k most frequently seen items.
+* Count-Min Sketch: Determine the frequency of events in a stream.
+
+For some examples, see [`bloom-filter.js`](https://github.com/redis/node-redis/tree/master/examples/bloom-filter.js), [`cuckoo-filter.js`](https://github.com/redis/node-redis/tree/master/examples/cuckoo-filter.js), [`count-min-sketch.js`](https://github.com/redis/node-redis/tree/master/examples/count-min-sketch.js) and [`topk.js`](https://github.com/redis/node-redis/tree/master/examples/topk.js) in the [examples folder](https://github.com/redis/node-redis/tree/master/examples).
diff --git a/packages/bloom/lib/commands/bloom/ADD.spec.ts b/packages/bloom/lib/commands/bloom/ADD.spec.ts
new file mode 100644
index 00000000000..a229936c7df
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/ADD.spec.ts
@@ -0,0 +1,20 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import ADD from './ADD';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('BF.ADD', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(ADD, 'key', 'item'),
+ ['BF.ADD', 'key', 'item']
+ );
+ });
+
+ testUtils.testWithClient('client.bf.add', async client => {
+ assert.equal(
+ await client.bf.add('key', 'item'),
+ true
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/bloom/ADD.ts b/packages/bloom/lib/commands/bloom/ADD.ts
new file mode 100644
index 00000000000..bf976606997
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/ADD.ts
@@ -0,0 +1,19 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
+import { transformBooleanReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Adds an item to a Bloom Filter
+ * @param parser - The command parser
+ * @param key - The name of the Bloom filter
+ * @param item - The item to add to the filter
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, item: RedisArgument) {
+ parser.push('BF.ADD');
+ parser.pushKey(key);
+ parser.push(item);
+ },
+ transformReply: transformBooleanReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/bloom/CARD.spec.ts b/packages/bloom/lib/commands/bloom/CARD.spec.ts
new file mode 100644
index 00000000000..32a28cdf6f7
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/CARD.spec.ts
@@ -0,0 +1,20 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import CARD from './CARD';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('BF.CARD', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(CARD, 'bloom'),
+ ['BF.CARD', 'bloom']
+ );
+ });
+
+ testUtils.testWithClient('client.bf.card', async client => {
+ assert.equal(
+ await client.bf.card('key'),
+ 0
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/bloom/CARD.ts b/packages/bloom/lib/commands/bloom/CARD.ts
new file mode 100644
index 00000000000..e1873e1faf1
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/CARD.ts
@@ -0,0 +1,16 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, NumberReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns the cardinality (number of items) in a Bloom Filter
+ * @param parser - The command parser
+ * @param key - The name of the Bloom filter to query
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument) {
+ parser.push('BF.CARD');
+ parser.pushKey(key);
+ },
+ transformReply: undefined as unknown as () => NumberReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/bloom/EXISTS.spec.ts b/packages/bloom/lib/commands/bloom/EXISTS.spec.ts
new file mode 100644
index 00000000000..4d2cc70074a
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/EXISTS.spec.ts
@@ -0,0 +1,20 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import EXISTS from './EXISTS';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('BF.EXISTS', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(EXISTS, 'key', 'item'),
+ ['BF.EXISTS', 'key', 'item']
+ );
+ });
+
+ testUtils.testWithClient('client.bf.exists', async client => {
+ assert.equal(
+ await client.bf.exists('key', 'item'),
+ false
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/bloom/EXISTS.ts b/packages/bloom/lib/commands/bloom/EXISTS.ts
new file mode 100644
index 00000000000..db16253e2c7
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/EXISTS.ts
@@ -0,0 +1,19 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
+import { transformBooleanReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Checks if an item exists in a Bloom Filter
+ * @param parser - The command parser
+ * @param key - The name of the Bloom filter
+ * @param item - The item to check for existence
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, item: RedisArgument) {
+ parser.push('BF.EXISTS');
+ parser.pushKey(key);
+ parser.push(item);
+ },
+ transformReply: transformBooleanReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/bloom/INFO.spec.ts b/packages/bloom/lib/commands/bloom/INFO.spec.ts
new file mode 100644
index 00000000000..0dbe5cb1f43
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/INFO.spec.ts
@@ -0,0 +1,27 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import INFO from './INFO';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('BF.INFO', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(INFO, 'bloom'),
+ ['BF.INFO', 'bloom']
+ );
+ });
+
+ testUtils.testWithClient('client.bf.info', async client => {
+ const [, reply] = await Promise.all([
+ client.bf.reserve('key', 0.01, 100),
+ client.bf.info('key')
+ ]);
+
+ assert.equal(typeof reply, 'object');
+ assert.equal(reply['Capacity'], 100);
+ assert.equal(typeof reply['Size'], 'number');
+ assert.equal(typeof reply['Number of filters'], 'number');
+ assert.equal(typeof reply['Number of items inserted'], 'number');
+ assert.equal(typeof reply['Expansion rate'], 'number');
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/bloom/INFO.ts b/packages/bloom/lib/commands/bloom/INFO.ts
new file mode 100644
index 00000000000..bdf7d0fda9b
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/INFO.ts
@@ -0,0 +1,30 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command, UnwrapReply, NullReply, NumberReply, TuplesToMapReply, Resp2Reply, SimpleStringReply, TypeMapping } from '@redis/client/dist/lib/RESP/types';
+import { transformInfoV2Reply } from './helpers';
+
+export type BfInfoReplyMap = TuplesToMapReply<[
+ [SimpleStringReply<'Capacity'>, NumberReply],
+ [SimpleStringReply<'Size'>, NumberReply],
+ [SimpleStringReply<'Number of filters'>, NumberReply],
+ [SimpleStringReply<'Number of items inserted'>, NumberReply],
+ [SimpleStringReply<'Expansion rate'>, NullReply | NumberReply]
+]>;
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns information about a Bloom Filter, including capacity, size, number of filters, items inserted, and expansion rate
+ * @param parser - The command parser
+ * @param key - The name of the Bloom filter to get information about
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument) {
+ parser.push('BF.INFO');
+ parser.pushKey(key);
+ },
+ transformReply: {
+ 2: (reply: UnwrapReply>, _, typeMapping?: TypeMapping): BfInfoReplyMap => {
+ return transformInfoV2Reply(reply, typeMapping);
+ },
+ 3: undefined as unknown as () => BfInfoReplyMap
+ }
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/bloom/INSERT.spec.ts b/packages/bloom/lib/commands/bloom/INSERT.spec.ts
new file mode 100644
index 00000000000..a9b544a51ae
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/INSERT.spec.ts
@@ -0,0 +1,70 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import INSERT from './INSERT';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('BF.INSERT', () => {
+ describe('transformArguments', () => {
+ it('simple', () => {
+ assert.deepEqual(
+ parseArgs(INSERT, 'key', 'item'),
+ ['BF.INSERT', 'key', 'ITEMS', 'item']
+ );
+ });
+
+ it('with CAPACITY', () => {
+ assert.deepEqual(
+ parseArgs(INSERT, 'key', 'item', { CAPACITY: 100 }),
+ ['BF.INSERT', 'key', 'CAPACITY', '100', 'ITEMS', 'item']
+ );
+ });
+
+ it('with ERROR', () => {
+ assert.deepEqual(
+ parseArgs(INSERT, 'key', 'item', { ERROR: 0.01 }),
+ ['BF.INSERT', 'key', 'ERROR', '0.01', 'ITEMS', 'item']
+ );
+ });
+
+ it('with EXPANSION', () => {
+ assert.deepEqual(
+ parseArgs(INSERT, 'key', 'item', { EXPANSION: 1 }),
+ ['BF.INSERT', 'key', 'EXPANSION', '1', 'ITEMS', 'item']
+ );
+ });
+
+ it('with NOCREATE', () => {
+ assert.deepEqual(
+ parseArgs(INSERT, 'key', 'item', { NOCREATE: true }),
+ ['BF.INSERT', 'key', 'NOCREATE', 'ITEMS', 'item']
+ );
+ });
+
+ it('with NONSCALING', () => {
+ assert.deepEqual(
+ parseArgs(INSERT, 'key', 'item', { NONSCALING: true }),
+ ['BF.INSERT', 'key', 'NONSCALING', 'ITEMS', 'item']
+ );
+ });
+
+ it('with CAPACITY, ERROR, EXPANSION, NOCREATE and NONSCALING', () => {
+ assert.deepEqual(
+ parseArgs(INSERT, 'key', 'item', {
+ CAPACITY: 100,
+ ERROR: 0.01,
+ EXPANSION: 1,
+ NOCREATE: true,
+ NONSCALING: true
+ }),
+ ['BF.INSERT', 'key', 'CAPACITY', '100', 'ERROR', '0.01', 'EXPANSION', '1', 'NOCREATE', 'NONSCALING', 'ITEMS', 'item']
+ );
+ });
+ });
+
+ testUtils.testWithClient('client.bf.insert', async client => {
+ assert.deepEqual(
+ await client.bf.insert('key', 'item'),
+ [true]
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/bloom/INSERT.ts b/packages/bloom/lib/commands/bloom/INSERT.ts
new file mode 100644
index 00000000000..c607e015694
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/INSERT.ts
@@ -0,0 +1,61 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
+import { RedisVariadicArgument } from '@redis/client/dist/lib/commands/generic-transformers';
+import { transformBooleanArrayReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export interface BfInsertOptions {
+ CAPACITY?: number;
+ ERROR?: number;
+ EXPANSION?: number;
+ NOCREATE?: boolean;
+ NONSCALING?: boolean;
+}
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Adds one or more items to a Bloom Filter, creating it if it does not exist
+ * @param parser - The command parser
+ * @param key - The name of the Bloom filter
+ * @param items - One or more items to add to the filter
+ * @param options - Optional parameters for filter creation
+ * @param options.CAPACITY - Desired capacity for a new filter
+ * @param options.ERROR - Desired error rate for a new filter
+ * @param options.EXPANSION - Expansion rate for a new filter
+ * @param options.NOCREATE - If true, prevents automatic filter creation
+ * @param options.NONSCALING - Prevents the filter from creating additional sub-filters
+ */
+ parseCommand(
+ parser: CommandParser,
+ key: RedisArgument,
+ items: RedisVariadicArgument,
+ options?: BfInsertOptions
+ ) {
+ parser.push('BF.INSERT');
+ parser.pushKey(key);
+
+ if (options?.CAPACITY !== undefined) {
+ parser.push('CAPACITY', options.CAPACITY.toString());
+ }
+
+ if (options?.ERROR !== undefined) {
+ parser.push('ERROR', options.ERROR.toString());
+ }
+
+ if (options?.EXPANSION !== undefined) {
+ parser.push('EXPANSION', options.EXPANSION.toString());
+ }
+
+ if (options?.NOCREATE) {
+ parser.push('NOCREATE');
+ }
+
+ if (options?.NONSCALING) {
+ parser.push('NONSCALING');
+ }
+
+ parser.push('ITEMS');
+ parser.pushVariadic(items);
+ },
+ transformReply: transformBooleanArrayReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/bloom/LOADCHUNK.spec.ts b/packages/bloom/lib/commands/bloom/LOADCHUNK.spec.ts
new file mode 100644
index 00000000000..40e24f96c39
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/LOADCHUNK.spec.ts
@@ -0,0 +1,36 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import LOADCHUNK from './LOADCHUNK';
+import { RESP_TYPES } from '@redis/client';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('BF.LOADCHUNK', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(LOADCHUNK, 'key', 0, ''),
+ ['BF.LOADCHUNK', 'key', '0', '']
+ );
+ });
+
+ testUtils.testWithClient('client.bf.loadChunk', async client => {
+ const [, { iterator, chunk }] = await Promise.all([
+ client.bf.reserve('source', 0.01, 100),
+ client.bf.scanDump('source', 0)
+ ]);
+
+ assert.equal(
+ await client.bf.loadChunk('destination', iterator, chunk),
+ 'OK'
+ );
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ ...GLOBAL.SERVERS.OPEN.clientOptions,
+ commandOptions: {
+ typeMapping: {
+ [RESP_TYPES.BLOB_STRING]: Buffer
+ }
+ }
+ }
+ });
+});
diff --git a/packages/bloom/lib/commands/bloom/LOADCHUNK.ts b/packages/bloom/lib/commands/bloom/LOADCHUNK.ts
new file mode 100644
index 00000000000..d0af9d7a644
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/LOADCHUNK.ts
@@ -0,0 +1,19 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, SimpleStringReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Restores a Bloom Filter chunk previously saved using SCANDUMP
+ * @param parser - The command parser
+ * @param key - The name of the Bloom filter to restore
+ * @param iterator - Iterator value from the SCANDUMP command
+ * @param chunk - Data chunk from the SCANDUMP command
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, iterator: number, chunk: RedisArgument) {
+ parser.push('BF.LOADCHUNK');
+ parser.pushKey(key);
+ parser.push(iterator.toString(), chunk);
+ },
+ transformReply: undefined as unknown as () => SimpleStringReply<'OK'>
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/bloom/MADD.spec.ts b/packages/bloom/lib/commands/bloom/MADD.spec.ts
new file mode 100644
index 00000000000..5eb39ee73d4
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/MADD.spec.ts
@@ -0,0 +1,20 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import MADD from './MADD';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('BF.MADD', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(MADD, 'key', ['1', '2']),
+ ['BF.MADD', 'key', '1', '2']
+ );
+ });
+
+ testUtils.testWithClient('client.ts.mAdd', async client => {
+ assert.deepEqual(
+ await client.bf.mAdd('key', ['1', '2']),
+ [true, true]
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/bloom/MADD.ts b/packages/bloom/lib/commands/bloom/MADD.ts
new file mode 100644
index 00000000000..adef0aee3e2
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/MADD.ts
@@ -0,0 +1,20 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
+import { RedisVariadicArgument } from '@redis/client/dist/lib/commands/generic-transformers';
+import { transformBooleanArrayReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Adds multiple items to a Bloom Filter in a single call
+ * @param parser - The command parser
+ * @param key - The name of the Bloom filter
+ * @param items - One or more items to add to the filter
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, items: RedisVariadicArgument) {
+ parser.push('BF.MADD');
+ parser.pushKey(key);
+ parser.pushVariadic(items);
+ },
+ transformReply: transformBooleanArrayReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/bloom/MEXISTS.spec.ts b/packages/bloom/lib/commands/bloom/MEXISTS.spec.ts
new file mode 100644
index 00000000000..60c09b00f17
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/MEXISTS.spec.ts
@@ -0,0 +1,20 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import MEXISTS from './MEXISTS';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('BF.MEXISTS', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(MEXISTS, 'key', ['1', '2']),
+ ['BF.MEXISTS', 'key', '1', '2']
+ );
+ });
+
+ testUtils.testWithClient('client.bf.mExists', async client => {
+ assert.deepEqual(
+ await client.bf.mExists('key', ['1', '2']),
+ [false, false]
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/bloom/MEXISTS.ts b/packages/bloom/lib/commands/bloom/MEXISTS.ts
new file mode 100644
index 00000000000..658f9b01229
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/MEXISTS.ts
@@ -0,0 +1,20 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
+import { RedisVariadicArgument } from '@redis/client/dist/lib/commands/generic-transformers';
+import { transformBooleanArrayReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Checks if multiple items exist in a Bloom Filter in a single call
+ * @param parser - The command parser
+ * @param key - The name of the Bloom filter
+ * @param items - One or more items to check for existence
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, items: RedisVariadicArgument) {
+ parser.push('BF.MEXISTS');
+ parser.pushKey(key);
+ parser.pushVariadic(items);
+ },
+ transformReply: transformBooleanArrayReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/bloom/RESERVE.spec.ts b/packages/bloom/lib/commands/bloom/RESERVE.spec.ts
new file mode 100644
index 00000000000..803577b350b
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/RESERVE.spec.ts
@@ -0,0 +1,50 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import RESERVE from './RESERVE';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('BF.RESERVE', () => {
+ describe('transformArguments', () => {
+ it('simple', () => {
+ assert.deepEqual(
+ parseArgs(RESERVE, 'key', 0.01, 100),
+ ['BF.RESERVE', 'key', '0.01', '100']
+ );
+ });
+
+ it('with EXPANSION', () => {
+ assert.deepEqual(
+ parseArgs(RESERVE, 'key', 0.01, 100, {
+ EXPANSION: 1
+ }),
+ ['BF.RESERVE', 'key', '0.01', '100', 'EXPANSION', '1']
+ );
+ });
+
+ it('with NONSCALING', () => {
+ assert.deepEqual(
+ parseArgs(RESERVE, 'key', 0.01, 100, {
+ NONSCALING: true
+ }),
+ ['BF.RESERVE', 'key', '0.01', '100', 'NONSCALING']
+ );
+ });
+
+ it('with EXPANSION and NONSCALING', () => {
+ assert.deepEqual(
+ parseArgs(RESERVE, 'key', 0.01, 100, {
+ EXPANSION: 1,
+ NONSCALING: true
+ }),
+ ['BF.RESERVE', 'key', '0.01', '100', 'EXPANSION', '1', 'NONSCALING']
+ );
+ });
+ });
+
+ testUtils.testWithClient('client.bf.reserve', async client => {
+ assert.equal(
+ await client.bf.reserve('bloom', 0.01, 100),
+ 'OK'
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/bloom/RESERVE.ts b/packages/bloom/lib/commands/bloom/RESERVE.ts
new file mode 100644
index 00000000000..d0b3fb906a9
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/RESERVE.ts
@@ -0,0 +1,41 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, SimpleStringReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+export interface BfReserveOptions {
+ EXPANSION?: number;
+ NONSCALING?: boolean;
+}
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Creates an empty Bloom Filter with a given desired error ratio and initial capacity
+ * @param parser - The command parser
+ * @param key - The name of the Bloom filter to create
+ * @param errorRate - The desired probability for false positives (between 0 and 1)
+ * @param capacity - The number of entries intended to be added to the filter
+ * @param options - Optional parameters to tune the filter
+ * @param options.EXPANSION - Expansion rate for the filter
+ * @param options.NONSCALING - Prevents the filter from creating additional sub-filters
+ */
+ parseCommand(
+ parser: CommandParser,
+ key: RedisArgument,
+ errorRate: number,
+ capacity: number,
+ options?: BfReserveOptions
+ ) {
+ parser.push('BF.RESERVE');
+ parser.pushKey(key);
+ parser.push(errorRate.toString(), capacity.toString());
+
+ if (options?.EXPANSION) {
+ parser.push('EXPANSION', options.EXPANSION.toString());
+ }
+
+ if (options?.NONSCALING) {
+ parser.push('NONSCALING');
+ }
+ },
+ transformReply: undefined as unknown as () => SimpleStringReply<'OK'>
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/bloom/SCANDUMP.spec.ts b/packages/bloom/lib/commands/bloom/SCANDUMP.spec.ts
new file mode 100644
index 00000000000..a41a6e8e466
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/SCANDUMP.spec.ts
@@ -0,0 +1,23 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import SCANDUMP from './SCANDUMP';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('BF.SCANDUMP', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(SCANDUMP, 'key', 0),
+ ['BF.SCANDUMP', 'key', '0']
+ );
+ });
+
+ testUtils.testWithClient('client.bf.scanDump', async client => {
+ const [, dump] = await Promise.all([
+ client.bf.reserve('key', 0.01, 100),
+ client.bf.scanDump('key', 0)
+ ]);
+ assert.equal(typeof dump, 'object');
+ assert.equal(typeof dump.iterator, 'number');
+ assert.equal(typeof dump.chunk, 'string');
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/bloom/SCANDUMP.ts b/packages/bloom/lib/commands/bloom/SCANDUMP.ts
new file mode 100644
index 00000000000..4aebc5c9fc3
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/SCANDUMP.ts
@@ -0,0 +1,23 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, TuplesReply, NumberReply, BlobStringReply, UnwrapReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Begins an incremental save of a Bloom Filter. This is useful for large filters that can't be saved at once
+ * @param parser - The command parser
+ * @param key - The name of the Bloom filter to save
+ * @param iterator - Iterator value; Start at 0, and use the iterator from the response for the next chunk
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, iterator: number) {
+ parser.push('BF.SCANDUMP');
+ parser.pushKey(key);
+ parser.push(iterator.toString());
+ },
+ transformReply(reply: UnwrapReply>) {
+ return {
+ iterator: reply[0],
+ chunk: reply[1]
+ };
+ }
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/bloom/helpers.ts b/packages/bloom/lib/commands/bloom/helpers.ts
new file mode 100644
index 00000000000..f5b39c71aa8
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/helpers.ts
@@ -0,0 +1,29 @@
+import { RESP_TYPES, TypeMapping } from "@redis/client";
+
+export function transformInfoV2Reply(reply: Array, typeMapping?: TypeMapping): T {
+ const mapType = typeMapping ? typeMapping[RESP_TYPES.MAP] : undefined;
+
+ switch (mapType) {
+ case Array: {
+ return reply as unknown as T;
+ }
+ case Map: {
+ const ret = new Map();
+
+ for (let i = 0; i < reply.length; i += 2) {
+ ret.set(reply[i].toString(), reply[i + 1]);
+ }
+
+ return ret as unknown as T;
+ }
+ default: {
+ const ret = Object.create(null);
+
+ for (let i = 0; i < reply.length; i += 2) {
+ ret[reply[i].toString()] = reply[i + 1];
+ }
+
+ return ret as unknown as T;
+ }
+ }
+}
\ No newline at end of file
diff --git a/packages/bloom/lib/commands/bloom/index.ts b/packages/bloom/lib/commands/bloom/index.ts
new file mode 100644
index 00000000000..d49ac63b2ea
--- /dev/null
+++ b/packages/bloom/lib/commands/bloom/index.ts
@@ -0,0 +1,37 @@
+import type { RedisCommands } from '@redis/client/dist/lib/RESP/types';
+
+import ADD from './ADD';
+import CARD from './CARD';
+import EXISTS from './EXISTS';
+import INFO from './INFO';
+import INSERT from './INSERT';
+import LOADCHUNK from './LOADCHUNK';
+import MADD from './MADD';
+import MEXISTS from './MEXISTS';
+import RESERVE from './RESERVE';
+import SCANDUMP from './SCANDUMP';
+
+export * from './helpers';
+
+export default {
+ ADD,
+ add: ADD,
+ CARD,
+ card: CARD,
+ EXISTS,
+ exists: EXISTS,
+ INFO,
+ info: INFO,
+ INSERT,
+ insert: INSERT,
+ LOADCHUNK,
+ loadChunk: LOADCHUNK,
+ MADD,
+ mAdd: MADD,
+ MEXISTS,
+ mExists: MEXISTS,
+ RESERVE,
+ reserve: RESERVE,
+ SCANDUMP,
+ scanDump: SCANDUMP
+} as const satisfies RedisCommands;
diff --git a/packages/bloom/lib/commands/count-min-sketch/INCRBY.spec.ts b/packages/bloom/lib/commands/count-min-sketch/INCRBY.spec.ts
new file mode 100644
index 00000000000..44ccaf6046d
--- /dev/null
+++ b/packages/bloom/lib/commands/count-min-sketch/INCRBY.spec.ts
@@ -0,0 +1,43 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import INCRBY from './INCRBY';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CMS.INCRBY', () => {
+ describe('transformArguments', () => {
+ it('single item', () => {
+ assert.deepEqual(
+ parseArgs(INCRBY, 'key', {
+ item: 'item',
+ incrementBy: 1
+ }),
+ ['CMS.INCRBY', 'key', 'item', '1']
+ );
+ });
+
+ it('multiple items', () => {
+ assert.deepEqual(
+ parseArgs(INCRBY, 'key', [{
+ item: 'a',
+ incrementBy: 1
+ }, {
+ item: 'b',
+ incrementBy: 2
+ }]),
+ ['CMS.INCRBY', 'key', 'a', '1', 'b', '2']
+ );
+ });
+ });
+
+ testUtils.testWithClient('client.cms.incrBy', async client => {
+ const [, reply] = await Promise.all([
+ client.cms.initByDim('key', 1000, 5),
+ client.cms.incrBy('key', {
+ item: 'item',
+ incrementBy: 1
+ })
+ ]);
+
+ assert.deepEqual(reply, [1]);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/count-min-sketch/INCRBY.ts b/packages/bloom/lib/commands/count-min-sketch/INCRBY.ts
new file mode 100644
index 00000000000..145047b207a
--- /dev/null
+++ b/packages/bloom/lib/commands/count-min-sketch/INCRBY.ts
@@ -0,0 +1,38 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, ArrayReply, NumberReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+export interface BfIncrByItem {
+ item: RedisArgument;
+ incrementBy: number;
+}
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Increases the count of one or more items in a Count-Min Sketch
+ * @param parser - The command parser
+ * @param key - The name of the sketch
+ * @param items - A single item or array of items to increment, each with an item and increment value
+ */
+ parseCommand(
+ parser: CommandParser,
+ key: RedisArgument,
+ items: BfIncrByItem | Array
+ ) {
+ parser.push('CMS.INCRBY');
+ parser.pushKey(key);
+
+ if (Array.isArray(items)) {
+ for (const item of items) {
+ pushIncrByItem(parser, item);
+ }
+ } else {
+ pushIncrByItem(parser, items);
+ }
+ },
+ transformReply: undefined as unknown as () => ArrayReply
+} as const satisfies Command;
+
+function pushIncrByItem(parser: CommandParser, { item, incrementBy }: BfIncrByItem): void {
+ parser.push(item, incrementBy.toString());
+}
diff --git a/packages/bloom/lib/commands/count-min-sketch/INFO.spec.ts b/packages/bloom/lib/commands/count-min-sketch/INFO.spec.ts
new file mode 100644
index 00000000000..cbc8065016a
--- /dev/null
+++ b/packages/bloom/lib/commands/count-min-sketch/INFO.spec.ts
@@ -0,0 +1,29 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import INFO from './INFO';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CMS.INFO', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(INFO, 'key'),
+ ['CMS.INFO', 'key']
+ );
+ });
+
+ testUtils.testWithClient('client.cms.info', async client => {
+ const width = 1000,
+ depth = 5,
+ [, reply] = await Promise.all([
+ client.cms.initByDim('key', width, depth),
+ client.cms.info('key')
+ ]);
+
+ const expected = Object.create(null);
+ expected['width'] = width;
+ expected['depth'] = depth;
+ expected['count'] = 0;
+
+ assert.deepEqual(reply, expected);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/count-min-sketch/INFO.ts b/packages/bloom/lib/commands/count-min-sketch/INFO.ts
new file mode 100644
index 00000000000..1f188bda013
--- /dev/null
+++ b/packages/bloom/lib/commands/count-min-sketch/INFO.ts
@@ -0,0 +1,34 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, TuplesToMapReply, NumberReply, UnwrapReply, Resp2Reply, Command, SimpleStringReply, TypeMapping } from '@redis/client/dist/lib/RESP/types';
+import { transformInfoV2Reply } from '../bloom';
+
+export type CmsInfoReplyMap = TuplesToMapReply<[
+ [SimpleStringReply<'width'>, NumberReply],
+ [SimpleStringReply<'depth'>, NumberReply],
+ [SimpleStringReply<'count'>, NumberReply]
+]>;
+
+export interface CmsInfoReply {
+ width: NumberReply;
+ depth: NumberReply;
+ count: NumberReply;
+}
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns width, depth, and total count of items in a Count-Min Sketch
+ * @param parser - The command parser
+ * @param key - The name of the sketch to get information about
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument) {
+ parser.push('CMS.INFO');
+ parser.pushKey(key);
+ },
+ transformReply: {
+ 2: (reply: UnwrapReply>, _, typeMapping?: TypeMapping): CmsInfoReply => {
+ return transformInfoV2Reply(reply, typeMapping);
+ },
+ 3: undefined as unknown as () => CmsInfoReply
+ }
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/count-min-sketch/INITBYDIM.spec.ts b/packages/bloom/lib/commands/count-min-sketch/INITBYDIM.spec.ts
new file mode 100644
index 00000000000..9fa1652a2e8
--- /dev/null
+++ b/packages/bloom/lib/commands/count-min-sketch/INITBYDIM.spec.ts
@@ -0,0 +1,20 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import INITBYDIM from './INITBYDIM';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CMS.INITBYDIM', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(INITBYDIM, 'key', 1000, 5),
+ ['CMS.INITBYDIM', 'key', '1000', '5']
+ );
+ });
+
+ testUtils.testWithClient('client.cms.initByDim', async client => {
+ assert.equal(
+ await client.cms.initByDim('key', 1000, 5),
+ 'OK'
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/count-min-sketch/INITBYDIM.ts b/packages/bloom/lib/commands/count-min-sketch/INITBYDIM.ts
new file mode 100644
index 00000000000..2bf9d97f208
--- /dev/null
+++ b/packages/bloom/lib/commands/count-min-sketch/INITBYDIM.ts
@@ -0,0 +1,19 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, SimpleStringReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Initialize a Count-Min Sketch using width and depth parameters
+ * @param parser - The command parser
+ * @param key - The name of the sketch
+ * @param width - Number of counters in each array (must be a multiple of 2)
+ * @param depth - Number of counter arrays (determines accuracy of estimates)
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, width: number, depth: number) {
+ parser.push('CMS.INITBYDIM');
+ parser.pushKey(key);
+ parser.push(width.toString(), depth.toString());
+ },
+ transformReply: undefined as unknown as () => SimpleStringReply<'OK'>
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/count-min-sketch/INITBYPROB.spec.ts b/packages/bloom/lib/commands/count-min-sketch/INITBYPROB.spec.ts
new file mode 100644
index 00000000000..b59bc14494f
--- /dev/null
+++ b/packages/bloom/lib/commands/count-min-sketch/INITBYPROB.spec.ts
@@ -0,0 +1,20 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import INITBYPROB from './INITBYPROB';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CMS.INITBYPROB', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(INITBYPROB, 'key', 0.001, 0.01),
+ ['CMS.INITBYPROB', 'key', '0.001', '0.01']
+ );
+ });
+
+ testUtils.testWithClient('client.cms.initByProb', async client => {
+ assert.equal(
+ await client.cms.initByProb('key', 0.001, 0.01),
+ 'OK'
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/count-min-sketch/INITBYPROB.ts b/packages/bloom/lib/commands/count-min-sketch/INITBYPROB.ts
new file mode 100644
index 00000000000..180781d91e8
--- /dev/null
+++ b/packages/bloom/lib/commands/count-min-sketch/INITBYPROB.ts
@@ -0,0 +1,19 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, SimpleStringReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Initialize a Count-Min Sketch using error rate and probability parameters
+ * @param parser - The command parser
+ * @param key - The name of the sketch
+ * @param error - Estimate error, as a decimal between 0 and 1
+ * @param probability - The desired probability for inflated count, as a decimal between 0 and 1
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, error: number, probability: number) {
+ parser.push('CMS.INITBYPROB');
+ parser.pushKey(key);
+ parser.push(error.toString(), probability.toString());
+ },
+ transformReply: undefined as unknown as () => SimpleStringReply<'OK'>
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/count-min-sketch/MERGE.spec.ts b/packages/bloom/lib/commands/count-min-sketch/MERGE.spec.ts
new file mode 100644
index 00000000000..03e3d5c6364
--- /dev/null
+++ b/packages/bloom/lib/commands/count-min-sketch/MERGE.spec.ts
@@ -0,0 +1,35 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import MERGE from './MERGE';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CMS.MERGE', () => {
+ describe('transformArguments', () => {
+ it('without WEIGHTS', () => {
+ assert.deepEqual(
+ parseArgs(MERGE, 'destination', ['source']),
+ ['CMS.MERGE', 'destination', '1', 'source']
+ );
+ });
+
+ it('with WEIGHTS', () => {
+ assert.deepEqual(
+ parseArgs(MERGE, 'destination', [{
+ name: 'source',
+ weight: 1
+ }]),
+ ['CMS.MERGE', 'destination', '1', 'source', 'WEIGHTS', '1']
+ );
+ });
+ });
+
+ testUtils.testWithClient('client.cms.merge', async client => {
+ const [, , reply] = await Promise.all([
+ client.cms.initByDim('source', 1000, 5),
+ client.cms.initByDim('destination', 1000, 5),
+ client.cms.merge('destination', ['source'])
+ ]);
+
+ assert.equal(reply, 'OK');
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/count-min-sketch/MERGE.ts b/packages/bloom/lib/commands/count-min-sketch/MERGE.ts
new file mode 100644
index 00000000000..e4921c7975f
--- /dev/null
+++ b/packages/bloom/lib/commands/count-min-sketch/MERGE.ts
@@ -0,0 +1,45 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, SimpleStringReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+interface BfMergeSketch {
+ name: RedisArgument;
+ weight: number;
+}
+
+export type BfMergeSketches = Array | Array;
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Merges multiple Count-Min Sketches into a single sketch, with optional weights
+ * @param parser - The command parser
+ * @param destination - The name of the destination sketch
+ * @param source - Array of sketch names or array of sketches with weights
+ */
+ parseCommand(
+ parser: CommandParser,
+ destination: RedisArgument,
+ source: BfMergeSketches
+ ) {
+ parser.push('CMS.MERGE');
+ parser.pushKey(destination);
+ parser.push(source.length.toString());
+
+ if (isPlainSketches(source)) {
+ parser.pushVariadic(source);
+ } else {
+ for (let i = 0; i < source.length; i++) {
+ parser.push(source[i].name);
+ }
+ parser.push('WEIGHTS');
+ for (let i = 0; i < source.length; i++) {
+ parser.push(source[i].weight.toString())
+ }
+ }
+ },
+ transformReply: undefined as unknown as () => SimpleStringReply<'OK'>
+} as const satisfies Command;
+
+function isPlainSketches(src: BfMergeSketches): src is Array {
+ return typeof src[0] === 'string' || src[0] instanceof Buffer;
+}
diff --git a/packages/bloom/lib/commands/count-min-sketch/QUERY.spec.ts b/packages/bloom/lib/commands/count-min-sketch/QUERY.spec.ts
new file mode 100644
index 00000000000..e12a519e962
--- /dev/null
+++ b/packages/bloom/lib/commands/count-min-sketch/QUERY.spec.ts
@@ -0,0 +1,22 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import QUERY from './QUERY';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CMS.QUERY', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(QUERY, 'key', 'item'),
+ ['CMS.QUERY', 'key', 'item']
+ );
+ });
+
+ testUtils.testWithClient('client.cms.query', async client => {
+ const [, reply] = await Promise.all([
+ client.cms.initByDim('key', 1000, 5),
+ client.cms.query('key', 'item')
+ ]);
+
+ assert.deepEqual(reply, [0]);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/count-min-sketch/QUERY.ts b/packages/bloom/lib/commands/count-min-sketch/QUERY.ts
new file mode 100644
index 00000000000..4322b0470c0
--- /dev/null
+++ b/packages/bloom/lib/commands/count-min-sketch/QUERY.ts
@@ -0,0 +1,19 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { ArrayReply, NumberReply, Command, RedisArgument } from '@redis/client/dist/lib/RESP/types';
+import { RedisVariadicArgument } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns the count for one or more items in a Count-Min Sketch
+ * @param parser - The command parser
+ * @param key - The name of the sketch
+ * @param items - One or more items to get counts for
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, items: RedisVariadicArgument) {
+ parser.push('CMS.QUERY');
+ parser.pushKey(key);
+ parser.pushVariadic(items);
+ },
+ transformReply: undefined as unknown as () => ArrayReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/count-min-sketch/index.ts b/packages/bloom/lib/commands/count-min-sketch/index.ts
new file mode 100644
index 00000000000..4f0f395ca3d
--- /dev/null
+++ b/packages/bloom/lib/commands/count-min-sketch/index.ts
@@ -0,0 +1,22 @@
+import type { RedisCommands } from '@redis/client/dist/lib/RESP/types';
+import INCRBY from './INCRBY';
+import INFO from './INFO';
+import INITBYDIM from './INITBYDIM';
+import INITBYPROB from './INITBYPROB';
+import MERGE from './MERGE';
+import QUERY from './QUERY';
+
+export default {
+ INCRBY,
+ incrBy: INCRBY,
+ INFO,
+ info: INFO,
+ INITBYDIM,
+ initByDim: INITBYDIM,
+ INITBYPROB,
+ initByProb: INITBYPROB,
+ MERGE,
+ merge: MERGE,
+ QUERY,
+ query: QUERY
+} as const satisfies RedisCommands;
diff --git a/packages/bloom/lib/commands/cuckoo/ADD.spec.ts b/packages/bloom/lib/commands/cuckoo/ADD.spec.ts
new file mode 100644
index 00000000000..7fa518fea84
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/ADD.spec.ts
@@ -0,0 +1,20 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import ADD from './ADD';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CF.ADD', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(ADD, 'key', 'item'),
+ ['CF.ADD', 'key', 'item']
+ );
+ });
+
+ testUtils.testWithClient('client.cf.add', async client => {
+ assert.equal(
+ await client.cf.add('key', 'item'),
+ true
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/cuckoo/ADD.ts b/packages/bloom/lib/commands/cuckoo/ADD.ts
new file mode 100644
index 00000000000..db16acdea5a
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/ADD.ts
@@ -0,0 +1,19 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
+import { transformBooleanReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Adds an item to a Cuckoo Filter, creating the filter if it does not exist
+ * @param parser - The command parser
+ * @param key - The name of the Cuckoo filter
+ * @param item - The item to add to the filter
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, item: RedisArgument) {
+ parser.push('CF.ADD');
+ parser.pushKey(key);
+ parser.push(item);
+ },
+ transformReply: transformBooleanReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/cuckoo/ADDNX.spec.ts b/packages/bloom/lib/commands/cuckoo/ADDNX.spec.ts
new file mode 100644
index 00000000000..c142733ce40
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/ADDNX.spec.ts
@@ -0,0 +1,20 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import ADDNX from './ADDNX';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CF.ADDNX', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(ADDNX, 'key', 'item'),
+ ['CF.ADDNX', 'key', 'item']
+ );
+ });
+
+ testUtils.testWithClient('client.cf.add', async client => {
+ assert.equal(
+ await client.cf.addNX('key', 'item'),
+ true
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/cuckoo/ADDNX.ts b/packages/bloom/lib/commands/cuckoo/ADDNX.ts
new file mode 100644
index 00000000000..ef6e1222e7f
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/ADDNX.ts
@@ -0,0 +1,19 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
+import { transformBooleanReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Adds an item to a Cuckoo Filter only if it does not exist
+ * @param parser - The command parser
+ * @param key - The name of the Cuckoo filter
+ * @param item - The item to add to the filter if it doesn't exist
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, item: RedisArgument) {
+ parser.push('CF.ADDNX');
+ parser.pushKey(key);
+ parser.push(item);
+ },
+ transformReply: transformBooleanReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/cuckoo/COUNT.spec.ts b/packages/bloom/lib/commands/cuckoo/COUNT.spec.ts
new file mode 100644
index 00000000000..9393494d852
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/COUNT.spec.ts
@@ -0,0 +1,20 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import COUNT from './COUNT';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CF.COUNT', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(COUNT, 'key', 'item'),
+ ['CF.COUNT', 'key', 'item']
+ );
+ });
+
+ testUtils.testWithClient('client.cf.count', async client => {
+ assert.equal(
+ await client.cf.count('key', 'item'),
+ 0
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/cuckoo/COUNT.ts b/packages/bloom/lib/commands/cuckoo/COUNT.ts
new file mode 100644
index 00000000000..e06d71f73e9
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/COUNT.ts
@@ -0,0 +1,18 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, NumberReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns the number of times an item appears in a Cuckoo Filter
+ * @param parser - The command parser
+ * @param key - The name of the Cuckoo filter
+ * @param item - The item to count occurrences of
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, item: RedisArgument) {
+ parser.push('CF.COUNT');
+ parser.pushKey(key);
+ parser.push(item);
+ },
+ transformReply: undefined as unknown as () => NumberReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/cuckoo/DEL.spec.ts b/packages/bloom/lib/commands/cuckoo/DEL.spec.ts
new file mode 100644
index 00000000000..41ed653bfc9
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/DEL.spec.ts
@@ -0,0 +1,22 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import DEL from './DEL';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CF.DEL', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(DEL, 'key', 'item'),
+ ['CF.DEL', 'key', 'item']
+ );
+ });
+
+ testUtils.testWithClient('client.cf.del', async client => {
+ const [, reply] = await Promise.all([
+ client.cf.reserve('key', 4),
+ client.cf.del('key', 'item')
+ ]);
+
+ assert.equal(reply, false);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/cuckoo/DEL.ts b/packages/bloom/lib/commands/cuckoo/DEL.ts
new file mode 100644
index 00000000000..651a5bd8a8a
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/DEL.ts
@@ -0,0 +1,19 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
+import { transformBooleanReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Removes an item from a Cuckoo Filter if it exists
+ * @param parser - The command parser
+ * @param key - The name of the Cuckoo filter
+ * @param item - The item to remove from the filter
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, item: RedisArgument) {
+ parser.push('CF.DEL');
+ parser.pushKey(key);
+ parser.push(item);
+ },
+ transformReply: transformBooleanReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/cuckoo/EXISTS.spec.ts b/packages/bloom/lib/commands/cuckoo/EXISTS.spec.ts
new file mode 100644
index 00000000000..f77a9d69eff
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/EXISTS.spec.ts
@@ -0,0 +1,20 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import EXISTS from './EXISTS';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CF.EXISTS', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(EXISTS, 'key', 'item'),
+ ['CF.EXISTS', 'key', 'item']
+ );
+ });
+
+ testUtils.testWithClient('client.cf.exists', async client => {
+ assert.equal(
+ await client.cf.exists('key', 'item'),
+ false
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/cuckoo/EXISTS.ts b/packages/bloom/lib/commands/cuckoo/EXISTS.ts
new file mode 100644
index 00000000000..820143ae886
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/EXISTS.ts
@@ -0,0 +1,19 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
+import { transformBooleanReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Checks if an item exists in a Cuckoo Filter
+ * @param parser - The command parser
+ * @param key - The name of the Cuckoo filter
+ * @param item - The item to check for existence
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, item: RedisArgument) {
+ parser.push('CF.EXISTS');
+ parser.pushKey(key);
+ parser.push(item);
+ },
+ transformReply: transformBooleanReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/cuckoo/INFO.spec.ts b/packages/bloom/lib/commands/cuckoo/INFO.spec.ts
new file mode 100644
index 00000000000..c5503ed113b
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/INFO.spec.ts
@@ -0,0 +1,30 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import INFO from './INFO';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CF.INFO', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(INFO, 'cuckoo'),
+ ['CF.INFO', 'cuckoo']
+ );
+ });
+
+ testUtils.testWithClient('client.cf.info', async client => {
+ const [, reply] = await Promise.all([
+ client.cf.reserve('key', 4),
+ client.cf.info('key')
+ ]);
+
+ assert.equal(typeof reply, 'object');
+ assert.equal(typeof reply['Size'], 'number');
+ assert.equal(typeof reply['Number of buckets'], 'number');
+ assert.equal(typeof reply['Number of filters'], 'number');
+ assert.equal(typeof reply['Number of items inserted'], 'number');
+ assert.equal(typeof reply['Number of items deleted'], 'number');
+ assert.equal(typeof reply['Bucket size'], 'number');
+ assert.equal(typeof reply['Expansion rate'], 'number');
+ assert.equal(typeof reply['Max iterations'], 'number');
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/cuckoo/INFO.ts b/packages/bloom/lib/commands/cuckoo/INFO.ts
new file mode 100644
index 00000000000..88622b5cb19
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/INFO.ts
@@ -0,0 +1,33 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command, NumberReply, TuplesToMapReply, UnwrapReply, Resp2Reply, SimpleStringReply, TypeMapping } from '@redis/client/dist/lib/RESP/types';
+import { transformInfoV2Reply } from '../bloom';
+
+export type CfInfoReplyMap = TuplesToMapReply<[
+ [SimpleStringReply<'Size'>, NumberReply],
+ [SimpleStringReply<'Number of buckets'>, NumberReply],
+ [SimpleStringReply<'Number of filters'>, NumberReply],
+ [SimpleStringReply<'Number of items inserted'>, NumberReply],
+ [SimpleStringReply<'Number of items deleted'>, NumberReply],
+ [SimpleStringReply<'Bucket size'>, NumberReply],
+ [SimpleStringReply<'Expansion rate'>, NumberReply],
+ [SimpleStringReply<'Max iterations'>, NumberReply]
+]>;
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns detailed information about a Cuckoo Filter including size, buckets, filters count, items statistics and configuration
+ * @param parser - The command parser
+ * @param key - The name of the Cuckoo filter to get information about
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument) {
+ parser.push('CF.INFO');
+ parser.pushKey(key);
+ },
+ transformReply: {
+ 2: (reply: UnwrapReply>, _, typeMapping?: TypeMapping): CfInfoReplyMap => {
+ return transformInfoV2Reply(reply, typeMapping);
+ },
+ 3: undefined as unknown as () => CfInfoReplyMap
+ }
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/cuckoo/INSERT.spec.ts b/packages/bloom/lib/commands/cuckoo/INSERT.spec.ts
new file mode 100644
index 00000000000..dc2bd574517
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/INSERT.spec.ts
@@ -0,0 +1,23 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import INSERT from './INSERT';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CF.INSERT', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(INSERT, 'key', 'item', {
+ CAPACITY: 100,
+ NOCREATE: true
+ }),
+ ['CF.INSERT', 'key', 'CAPACITY', '100', 'NOCREATE', 'ITEMS', 'item']
+ );
+ });
+
+ testUtils.testWithClient('client.cf.insert', async client => {
+ assert.deepEqual(
+ await client.cf.insert('key', 'item'),
+ [true]
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/cuckoo/INSERT.ts b/packages/bloom/lib/commands/cuckoo/INSERT.ts
new file mode 100644
index 00000000000..277c820cbcd
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/INSERT.ts
@@ -0,0 +1,46 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { Command, RedisArgument } from '@redis/client/dist/lib/RESP/types';
+import { RedisVariadicArgument, transformBooleanArrayReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export interface CfInsertOptions {
+ CAPACITY?: number;
+ NOCREATE?: boolean;
+}
+
+export function parseCfInsertArguments(
+ parser: CommandParser,
+ key: RedisArgument,
+ items: RedisVariadicArgument,
+ options?: CfInsertOptions
+) {
+ parser.pushKey(key);
+
+ if (options?.CAPACITY !== undefined) {
+ parser.push('CAPACITY', options.CAPACITY.toString());
+ }
+
+ if (options?.NOCREATE) {
+ parser.push('NOCREATE');
+ }
+
+ parser.push('ITEMS');
+ parser.pushVariadic(items);
+}
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Adds one or more items to a Cuckoo Filter, creating it if it does not exist
+ * @param parser - The command parser
+ * @param key - The name of the Cuckoo filter
+ * @param items - One or more items to add to the filter
+ * @param options - Optional parameters for filter creation
+ * @param options.CAPACITY - The number of entries intended to be added to the filter
+ * @param options.NOCREATE - If true, prevents automatic filter creation
+ */
+ parseCommand(...args: Parameters) {
+ args[0].push('CF.INSERT');
+ parseCfInsertArguments(...args);
+ },
+ transformReply: transformBooleanArrayReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/cuckoo/INSERTNX.spec.ts b/packages/bloom/lib/commands/cuckoo/INSERTNX.spec.ts
new file mode 100644
index 00000000000..648d9be7ac8
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/INSERTNX.spec.ts
@@ -0,0 +1,23 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import INSERTNX from './INSERTNX';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CF.INSERTNX', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(INSERTNX, 'key', 'item', {
+ CAPACITY: 100,
+ NOCREATE: true
+ }),
+ ['CF.INSERTNX', 'key', 'CAPACITY', '100', 'NOCREATE', 'ITEMS', 'item']
+ );
+ });
+
+ testUtils.testWithClient('client.cf.insertnx', async client => {
+ assert.deepEqual(
+ await client.cf.insertNX('key', 'item'),
+ [true]
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/cuckoo/INSERTNX.ts b/packages/bloom/lib/commands/cuckoo/INSERTNX.ts
new file mode 100644
index 00000000000..bf99db6c3f7
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/INSERTNX.ts
@@ -0,0 +1,20 @@
+import { Command } from '@redis/client/dist/lib/RESP/types';
+import INSERT, { parseCfInsertArguments } from './INSERT';
+
+/**
+ * Adds one or more items to a Cuckoo Filter only if they do not exist yet, creating the filter if needed
+ * @param parser - The command parser
+ * @param key - The name of the Cuckoo filter
+ * @param items - One or more items to add to the filter
+ * @param options - Optional parameters for filter creation
+ * @param options.CAPACITY - The number of entries intended to be added to the filter
+ * @param options.NOCREATE - If true, prevents automatic filter creation
+ */
+export default {
+ IS_READ_ONLY: INSERT.IS_READ_ONLY,
+ parseCommand(...args: Parameters) {
+ args[0].push('CF.INSERTNX');
+ parseCfInsertArguments(...args);
+ },
+ transformReply: INSERT.transformReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/cuckoo/LOADCHUNK.spec.ts b/packages/bloom/lib/commands/cuckoo/LOADCHUNK.spec.ts
new file mode 100644
index 00000000000..5415c787dda
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/LOADCHUNK.spec.ts
@@ -0,0 +1,37 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import LOADCHUNK from './LOADCHUNK';
+import { RESP_TYPES } from '@redis/client';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CF.LOADCHUNK', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(LOADCHUNK, 'item', 0, ''),
+ ['CF.LOADCHUNK', 'item', '0', '']
+ );
+ });
+
+ testUtils.testWithClient('client.cf.loadChunk', async client => {
+ const [, , { iterator, chunk }] = await Promise.all([
+ client.cf.reserve('source', 4),
+ client.cf.add('source', 'item'),
+ client.cf.scanDump('source', 0)
+ ]);
+
+ assert.equal(
+ await client.cf.loadChunk('destination', iterator, chunk!),
+ 'OK'
+ );
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ ...GLOBAL.SERVERS.OPEN.clientOptions,
+ commandOptions: {
+ typeMapping: {
+ [RESP_TYPES.BLOB_STRING]: Buffer
+ }
+ }
+ }
+ });
+});
diff --git a/packages/bloom/lib/commands/cuckoo/LOADCHUNK.ts b/packages/bloom/lib/commands/cuckoo/LOADCHUNK.ts
new file mode 100644
index 00000000000..3a966e5145a
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/LOADCHUNK.ts
@@ -0,0 +1,19 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { SimpleStringReply, Command, RedisArgument } from '@redis/client/dist/lib/RESP/types';
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Restores a Cuckoo Filter chunk previously saved using SCANDUMP
+ * @param parser - The command parser
+ * @param key - The name of the Cuckoo filter to restore
+ * @param iterator - Iterator value from the SCANDUMP command
+ * @param chunk - Data chunk from the SCANDUMP command
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, iterator: number, chunk: RedisArgument) {
+ parser.push('CF.LOADCHUNK');
+ parser.pushKey(key);
+ parser.push(iterator.toString(), chunk);
+ },
+ transformReply: undefined as unknown as () => SimpleStringReply<'OK'>
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/cuckoo/RESERVE.spec.ts b/packages/bloom/lib/commands/cuckoo/RESERVE.spec.ts
new file mode 100644
index 00000000000..53546e4156e
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/RESERVE.spec.ts
@@ -0,0 +1,49 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import RESERVE from './RESERVE';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CF.RESERVE', () => {
+ describe('transformArguments', () => {
+ it('simple', () => {
+ assert.deepEqual(
+ parseArgs(RESERVE, 'key', 4),
+ ['CF.RESERVE', 'key', '4']
+ );
+ });
+
+ it('with EXPANSION', () => {
+ assert.deepEqual(
+ parseArgs(RESERVE, 'key', 4, {
+ EXPANSION: 1
+ }),
+ ['CF.RESERVE', 'key', '4', 'EXPANSION', '1']
+ );
+ });
+
+ it('with BUCKETSIZE', () => {
+ assert.deepEqual(
+ parseArgs(RESERVE, 'key', 4, {
+ BUCKETSIZE: 2
+ }),
+ ['CF.RESERVE', 'key', '4', 'BUCKETSIZE', '2']
+ );
+ });
+
+ it('with MAXITERATIONS', () => {
+ assert.deepEqual(
+ parseArgs(RESERVE, 'key', 4, {
+ MAXITERATIONS: 1
+ }),
+ ['CF.RESERVE', 'key', '4', 'MAXITERATIONS', '1']
+ );
+ });
+ });
+
+ testUtils.testWithClient('client.cf.reserve', async client => {
+ assert.equal(
+ await client.cf.reserve('key', 4),
+ 'OK'
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/cuckoo/RESERVE.ts b/packages/bloom/lib/commands/cuckoo/RESERVE.ts
new file mode 100644
index 00000000000..26e31a1c645
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/RESERVE.ts
@@ -0,0 +1,45 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, SimpleStringReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+export interface CfReserveOptions {
+ BUCKETSIZE?: number;
+ MAXITERATIONS?: number;
+ EXPANSION?: number;
+}
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Creates an empty Cuckoo Filter with specified capacity and parameters
+ * @param parser - The command parser
+ * @param key - The name of the Cuckoo filter to create
+ * @param capacity - The number of entries intended to be added to the filter
+ * @param options - Optional parameters to tune the filter
+ * @param options.BUCKETSIZE - Number of items in each bucket
+ * @param options.MAXITERATIONS - Maximum number of iterations before declaring filter full
+ * @param options.EXPANSION - Number of additional buckets per expansion
+ */
+ parseCommand(
+ parser: CommandParser,
+ key: RedisArgument,
+ capacity: number,
+ options?: CfReserveOptions
+ ) {
+ parser.push('CF.RESERVE');
+ parser.pushKey(key);
+ parser.push(capacity.toString());
+
+ if (options?.BUCKETSIZE !== undefined) {
+ parser.push('BUCKETSIZE', options.BUCKETSIZE.toString());
+ }
+
+ if (options?.MAXITERATIONS !== undefined) {
+ parser.push('MAXITERATIONS', options.MAXITERATIONS.toString());
+ }
+
+ if (options?.EXPANSION !== undefined) {
+ parser.push('EXPANSION', options.EXPANSION.toString());
+ }
+ },
+ transformReply: undefined as unknown as () => SimpleStringReply<'OK'>
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/cuckoo/SCANDUMP.spec.ts b/packages/bloom/lib/commands/cuckoo/SCANDUMP.spec.ts
new file mode 100644
index 00000000000..60a57ac46ab
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/SCANDUMP.spec.ts
@@ -0,0 +1,25 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import SCANDUMP from './SCANDUMP';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('CF.SCANDUMP', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(SCANDUMP, 'key', 0),
+ ['CF.SCANDUMP', 'key', '0']
+ );
+ });
+
+ testUtils.testWithClient('client.cf.scanDump', async client => {
+ const [, reply] = await Promise.all([
+ client.cf.reserve('key', 4),
+ client.cf.scanDump('key', 0)
+ ]);
+
+ assert.deepEqual(reply, {
+ iterator: 0,
+ chunk: null
+ });
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/cuckoo/SCANDUMP.ts b/packages/bloom/lib/commands/cuckoo/SCANDUMP.ts
new file mode 100644
index 00000000000..96a036671f4
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/SCANDUMP.ts
@@ -0,0 +1,23 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, TuplesReply, NumberReply, BlobStringReply, NullReply, UnwrapReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Begins an incremental save of a Cuckoo Filter. This is useful for large filters that can't be saved at once
+ * @param parser - The command parser
+ * @param key - The name of the Cuckoo filter to save
+ * @param iterator - Iterator value; Start at 0, and use the iterator from the response for the next chunk
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, iterator: number) {
+ parser.push('CF.SCANDUMP');
+ parser.pushKey(key);
+ parser.push(iterator.toString());
+ },
+ transformReply(reply: UnwrapReply>) {
+ return {
+ iterator: reply[0],
+ chunk: reply[1]
+ };
+ }
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/cuckoo/index.ts b/packages/bloom/lib/commands/cuckoo/index.ts
new file mode 100644
index 00000000000..62c63fe8d19
--- /dev/null
+++ b/packages/bloom/lib/commands/cuckoo/index.ts
@@ -0,0 +1,37 @@
+import type { RedisCommands } from '@redis/client/dist/lib/RESP/types';
+import ADD from './ADD';
+import ADDNX from './ADDNX';
+import COUNT from './COUNT';
+import DEL from './DEL';
+import EXISTS from './EXISTS';
+import INFO from './INFO';
+import INSERT from './INSERT';
+import INSERTNX from './INSERTNX';
+import LOADCHUNK from './LOADCHUNK';
+import RESERVE from './RESERVE';
+import SCANDUMP from './SCANDUMP';
+
+export default {
+ ADD,
+ add: ADD,
+ ADDNX,
+ addNX: ADDNX,
+ COUNT,
+ count: COUNT,
+ DEL,
+ del: DEL,
+ EXISTS,
+ exists: EXISTS,
+ INFO,
+ info: INFO,
+ INSERT,
+ insert: INSERT,
+ INSERTNX,
+ insertNX: INSERTNX,
+ LOADCHUNK,
+ loadChunk: LOADCHUNK,
+ RESERVE,
+ reserve: RESERVE,
+ SCANDUMP,
+ scanDump: SCANDUMP
+} as const satisfies RedisCommands;
diff --git a/packages/bloom/lib/commands/index.ts b/packages/bloom/lib/commands/index.ts
new file mode 100644
index 00000000000..6f91089460a
--- /dev/null
+++ b/packages/bloom/lib/commands/index.ts
@@ -0,0 +1,14 @@
+import { RedisModules } from '@redis/client';
+import bf from './bloom';
+import cms from './count-min-sketch';
+import cf from './cuckoo';
+import tDigest from './t-digest';
+import topK from './top-k';
+
+export default {
+ bf,
+ cms,
+ cf,
+ tDigest,
+ topK
+} as const satisfies RedisModules;
diff --git a/packages/bloom/lib/commands/t-digest/ADD.spec.ts b/packages/bloom/lib/commands/t-digest/ADD.spec.ts
new file mode 100644
index 00000000000..7578fb9378b
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/ADD.spec.ts
@@ -0,0 +1,22 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import ADD from './ADD';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TDIGEST.ADD', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(ADD, 'key', [1, 2]),
+ ['TDIGEST.ADD', 'key', '1', '2']
+ );
+ });
+
+ testUtils.testWithClient('client.tDigest.add', async client => {
+ const [, reply] = await Promise.all([
+ client.tDigest.create('key'),
+ client.tDigest.add('key', [1])
+ ]);
+
+ assert.equal(reply, 'OK');
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/t-digest/ADD.ts b/packages/bloom/lib/commands/t-digest/ADD.ts
new file mode 100644
index 00000000000..30e745f8f47
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/ADD.ts
@@ -0,0 +1,21 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { SimpleStringReply, Command, RedisArgument } from '@redis/client/dist/lib/RESP/types';
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Adds one or more observations to a t-digest sketch
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch
+ * @param values - Array of numeric values to add to the sketch
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, values: Array) {
+ parser.push('TDIGEST.ADD');
+ parser.pushKey(key);
+
+ for (const value of values) {
+ parser.push(value.toString());
+ }
+ },
+ transformReply: undefined as unknown as () => SimpleStringReply<'OK'>
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/t-digest/BYRANK.spec.ts b/packages/bloom/lib/commands/t-digest/BYRANK.spec.ts
new file mode 100644
index 00000000000..81a2c75dff5
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/BYRANK.spec.ts
@@ -0,0 +1,22 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import BYRANK from './BYRANK';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TDIGEST.BYRANK', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(BYRANK, 'key', [1, 2]),
+ ['TDIGEST.BYRANK', 'key', '1', '2']
+ );
+ });
+
+ testUtils.testWithClient('client.tDigest.byRank', async client => {
+ const [, reply] = await Promise.all([
+ client.tDigest.create('key'),
+ client.tDigest.byRank('key', [1])
+ ]);
+
+ assert.deepEqual(reply, [NaN]);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/t-digest/BYRANK.ts b/packages/bloom/lib/commands/t-digest/BYRANK.ts
new file mode 100644
index 00000000000..9ac855bfeab
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/BYRANK.ts
@@ -0,0 +1,31 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
+import { transformDoubleArrayReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export function transformByRankArguments(
+ parser: CommandParser,
+ key: RedisArgument,
+ ranks: Array
+) {
+ parser.pushKey(key);
+
+ for (const rank of ranks) {
+ parser.push(rank.toString());
+ }
+}
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns value estimates for one or more ranks in a t-digest sketch
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch
+ * @param ranks - Array of ranks to get value estimates for (ascending order)
+ */
+ parseCommand(...args: Parameters) {
+ args[0].push('TDIGEST.BYRANK');
+ transformByRankArguments(...args);
+ },
+ transformReply: transformDoubleArrayReply
+} as const satisfies Command;
+
diff --git a/packages/bloom/lib/commands/t-digest/BYREVRANK.spec.ts b/packages/bloom/lib/commands/t-digest/BYREVRANK.spec.ts
new file mode 100644
index 00000000000..c8f794bef57
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/BYREVRANK.spec.ts
@@ -0,0 +1,22 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import BYREVRANK from './BYREVRANK';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TDIGEST.BYREVRANK', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(BYREVRANK, 'key', [1, 2]),
+ ['TDIGEST.BYREVRANK', 'key', '1', '2']
+ );
+ });
+
+ testUtils.testWithClient('client.tDigest.byRevRank', async client => {
+ const [, reply] = await Promise.all([
+ client.tDigest.create('key'),
+ client.tDigest.byRevRank('key', [1])
+ ]);
+
+ assert.deepEqual(reply, [NaN]);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/t-digest/BYREVRANK.ts b/packages/bloom/lib/commands/t-digest/BYREVRANK.ts
new file mode 100644
index 00000000000..a94e5566bb1
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/BYREVRANK.ts
@@ -0,0 +1,17 @@
+import { Command } from '@redis/client/dist/lib/RESP/types';
+import BYRANK, { transformByRankArguments } from './BYRANK';
+
+/**
+ * Returns value estimates for one or more ranks in a t-digest sketch, starting from highest rank
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch
+ * @param ranks - Array of ranks to get value estimates for (descending order)
+ */
+export default {
+ IS_READ_ONLY: BYRANK.IS_READ_ONLY,
+ parseCommand(...args: Parameters) {
+ args[0].push('TDIGEST.BYREVRANK');
+ transformByRankArguments(...args);
+ },
+ transformReply: BYRANK.transformReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/t-digest/CDF.spec.ts b/packages/bloom/lib/commands/t-digest/CDF.spec.ts
new file mode 100644
index 00000000000..2689bf2fc9a
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/CDF.spec.ts
@@ -0,0 +1,22 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import CDF from './CDF';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TDIGEST.CDF', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(CDF, 'key', [1, 2]),
+ ['TDIGEST.CDF', 'key', '1', '2']
+ );
+ });
+
+ testUtils.testWithClient('client.tDigest.cdf', async client => {
+ const [, reply] = await Promise.all([
+ client.tDigest.create('key'),
+ client.tDigest.cdf('key', [1])
+ ]);
+
+ assert.deepEqual(reply, [NaN]);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/t-digest/CDF.ts b/packages/bloom/lib/commands/t-digest/CDF.ts
new file mode 100644
index 00000000000..a3d3b884a34
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/CDF.ts
@@ -0,0 +1,22 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
+import { transformDoubleArrayReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Estimates the cumulative distribution function for values in a t-digest sketch
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch
+ * @param values - Array of values to get CDF estimates for
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, values: Array) {
+ parser.push('TDIGEST.CDF');
+ parser.pushKey(key);
+
+ for (const item of values) {
+ parser.push(item.toString());
+ }
+ },
+ transformReply: transformDoubleArrayReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/t-digest/CREATE.spec.ts b/packages/bloom/lib/commands/t-digest/CREATE.spec.ts
new file mode 100644
index 00000000000..0f218e07ab8
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/CREATE.spec.ts
@@ -0,0 +1,31 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import CREATE from './CREATE';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TDIGEST.CREATE', () => {
+ describe('transformArguments', () => {
+ it('without options', () => {
+ assert.deepEqual(
+ parseArgs(CREATE, 'key'),
+ ['TDIGEST.CREATE', 'key']
+ );
+ });
+
+ it('with COMPRESSION', () => {
+ assert.deepEqual(
+ parseArgs(CREATE, 'key', {
+ COMPRESSION: 100
+ }),
+ ['TDIGEST.CREATE', 'key', 'COMPRESSION', '100']
+ );
+ });
+ });
+
+ testUtils.testWithClient('client.tDigest.create', async client => {
+ assert.equal(
+ await client.tDigest.create('key'),
+ 'OK'
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/t-digest/CREATE.ts b/packages/bloom/lib/commands/t-digest/CREATE.ts
new file mode 100644
index 00000000000..25eb9c4f425
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/CREATE.ts
@@ -0,0 +1,26 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, SimpleStringReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+export interface TDigestCreateOptions {
+ COMPRESSION?: number;
+}
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Creates a new t-digest sketch for storing distributions
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch
+ * @param options - Optional parameters for sketch creation
+ * @param options.COMPRESSION - Compression parameter that affects performance and accuracy
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, options?: TDigestCreateOptions) {
+ parser.push('TDIGEST.CREATE');
+ parser.pushKey(key);
+
+ if (options?.COMPRESSION !== undefined) {
+ parser.push('COMPRESSION', options.COMPRESSION.toString());
+ }
+ },
+ transformReply: undefined as unknown as () => SimpleStringReply<'OK'>
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/t-digest/INFO.spec.ts b/packages/bloom/lib/commands/t-digest/INFO.spec.ts
new file mode 100644
index 00000000000..d5b8b3e13ed
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/INFO.spec.ts
@@ -0,0 +1,31 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import INFO from './INFO';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TDIGEST.INFO', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(INFO, 'key'),
+ ['TDIGEST.INFO', 'key']
+ );
+ });
+
+ testUtils.testWithClient('client.tDigest.info', async client => {
+ const [, reply] = await Promise.all([
+ client.tDigest.create('key'),
+ client.tDigest.info('key')
+ ]);
+
+ assert(typeof reply, 'object');
+ assert(typeof reply['Compression'], 'number');
+ assert(typeof reply['Capacity'], 'number');
+ assert(typeof reply['Merged nodes'], 'number');
+ assert(typeof reply['Unmerged nodes'], 'number');
+ assert(typeof reply['Merged weight'], 'number');
+ assert(typeof reply['Unmerged weight'], 'number');
+ assert(typeof reply['Observations'], 'number');
+ assert(typeof reply['Total compressions'], 'number');
+ assert(typeof reply['Memory usage'], 'number');
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/t-digest/INFO.ts b/packages/bloom/lib/commands/t-digest/INFO.ts
new file mode 100644
index 00000000000..96ae420886c
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/INFO.ts
@@ -0,0 +1,34 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command, NumberReply, TuplesToMapReply, UnwrapReply, Resp2Reply, SimpleStringReply, TypeMapping } from '@redis/client/dist/lib/RESP/types';
+import { transformInfoV2Reply } from '../bloom';
+
+export type TdInfoReplyMap = TuplesToMapReply<[
+ [SimpleStringReply<'Compression'>, NumberReply],
+ [SimpleStringReply<'Capacity'>, NumberReply],
+ [SimpleStringReply<'Merged nodes'>, NumberReply],
+ [SimpleStringReply<'Unmerged nodes'>, NumberReply],
+ [SimpleStringReply<'Merged weight'>, NumberReply],
+ [SimpleStringReply<'Unmerged weight'>, NumberReply],
+ [SimpleStringReply<'Observations'>, NumberReply],
+ [SimpleStringReply<'Total compressions'>, NumberReply],
+ [SimpleStringReply<'Memory usage'>, NumberReply]
+]>;
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns information about a t-digest sketch including compression, capacity, nodes, weights, observations and memory usage
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch to get information about
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument) {
+ parser.push('TDIGEST.INFO');
+ parser.pushKey(key);
+ },
+ transformReply: {
+ 2: (reply: UnwrapReply>, _, typeMapping?: TypeMapping): TdInfoReplyMap => {
+ return transformInfoV2Reply(reply, typeMapping);
+ },
+ 3: undefined as unknown as () => TdInfoReplyMap
+ }
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/t-digest/MAX.spec.ts b/packages/bloom/lib/commands/t-digest/MAX.spec.ts
new file mode 100644
index 00000000000..920c9d11391
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/MAX.spec.ts
@@ -0,0 +1,22 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import MAX from './MAX';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TDIGEST.MAX', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(MAX, 'key'),
+ ['TDIGEST.MAX', 'key']
+ );
+ });
+
+ testUtils.testWithClient('client.tDigest.max', async client => {
+ const [, reply] = await Promise.all([
+ client.tDigest.create('key'),
+ client.tDigest.max('key')
+ ]);
+
+ assert.deepEqual(reply, NaN);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/t-digest/MAX.ts b/packages/bloom/lib/commands/t-digest/MAX.ts
new file mode 100644
index 00000000000..2353c60cdc6
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/MAX.ts
@@ -0,0 +1,17 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
+import { transformDoubleReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns the maximum value from a t-digest sketch
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument) {
+ parser.push('TDIGEST.MAX');
+ parser.pushKey(key);
+ },
+ transformReply: transformDoubleReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/t-digest/MERGE.spec.ts b/packages/bloom/lib/commands/t-digest/MERGE.spec.ts
new file mode 100644
index 00000000000..f2a7c1a1192
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/MERGE.spec.ts
@@ -0,0 +1,51 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import MERGE from './MERGE';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TDIGEST.MERGE', () => {
+ describe('transformArguments', () => {
+ describe('source', () => {
+ it('string', () => {
+ assert.deepEqual(
+ parseArgs(MERGE, 'destination', 'source'),
+ ['TDIGEST.MERGE', 'destination', '1', 'source']
+ );
+ });
+
+ it('Array', () => {
+ assert.deepEqual(
+ parseArgs(MERGE, 'destination', ['1', '2']),
+ ['TDIGEST.MERGE', 'destination', '2', '1', '2']
+ );
+ });
+ });
+
+ it('with COMPRESSION', () => {
+ assert.deepEqual(
+ parseArgs(MERGE, 'destination', 'source', {
+ COMPRESSION: 100
+ }),
+ ['TDIGEST.MERGE', 'destination', '1', 'source', 'COMPRESSION', '100']
+ );
+ });
+
+ it('with OVERRIDE', () => {
+ assert.deepEqual(
+ parseArgs(MERGE, 'destination', 'source', {
+ OVERRIDE: true
+ }),
+ ['TDIGEST.MERGE', 'destination', '1', 'source', 'OVERRIDE']
+ );
+ });
+ });
+
+ testUtils.testWithClient('client.tDigest.merge', async client => {
+ const [, reply] = await Promise.all([
+ client.tDigest.create('source'),
+ client.tDigest.merge('destination', 'source')
+ ]);
+
+ assert.equal(reply, 'OK');
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/t-digest/MERGE.ts b/packages/bloom/lib/commands/t-digest/MERGE.ts
new file mode 100644
index 00000000000..f34d30a7cef
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/MERGE.ts
@@ -0,0 +1,40 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, SimpleStringReply, Command } from '@redis/client/dist/lib/RESP/types';
+import { RedisVariadicArgument } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export interface TDigestMergeOptions {
+ COMPRESSION?: number;
+ OVERRIDE?: boolean;
+}
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Merges multiple t-digest sketches into one, with optional compression and override settings
+ * @param parser - The command parser
+ * @param destination - The name of the destination t-digest sketch
+ * @param source - One or more source sketch names to merge from
+ * @param options - Optional parameters for merge operation
+ * @param options.COMPRESSION - New compression value for merged sketch
+ * @param options.OVERRIDE - If true, override destination sketch if it exists
+ */
+ parseCommand(
+ parser: CommandParser,
+ destination: RedisArgument,
+ source: RedisVariadicArgument,
+ options?: TDigestMergeOptions
+ ) {
+ parser.push('TDIGEST.MERGE');
+ parser.pushKey(destination);
+ parser.pushKeysLength(source);
+
+ if (options?.COMPRESSION !== undefined) {
+ parser.push('COMPRESSION', options.COMPRESSION.toString());
+ }
+
+ if (options?.OVERRIDE) {
+ parser.push('OVERRIDE');
+ }
+ },
+ transformReply: undefined as unknown as () => SimpleStringReply<'OK'>
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/t-digest/MIN.spec.ts b/packages/bloom/lib/commands/t-digest/MIN.spec.ts
new file mode 100644
index 00000000000..278248ea465
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/MIN.spec.ts
@@ -0,0 +1,22 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import MIN from './MIN';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TDIGEST.MIN', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(MIN, 'key'),
+ ['TDIGEST.MIN', 'key']
+ );
+ });
+
+ testUtils.testWithClient('client.tDigest.min', async client => {
+ const [, reply] = await Promise.all([
+ client.tDigest.create('key'),
+ client.tDigest.min('key')
+ ]);
+
+ assert.equal(reply, NaN);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/t-digest/MIN.ts b/packages/bloom/lib/commands/t-digest/MIN.ts
new file mode 100644
index 00000000000..9b8ea2a0cfc
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/MIN.ts
@@ -0,0 +1,17 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
+import { transformDoubleReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns the minimum value from a t-digest sketch
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument) {
+ parser.push('TDIGEST.MIN');
+ parser.pushKey(key);
+ },
+ transformReply: transformDoubleReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/t-digest/QUANTILE.spec.ts b/packages/bloom/lib/commands/t-digest/QUANTILE.spec.ts
new file mode 100644
index 00000000000..ac7249d12d9
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/QUANTILE.spec.ts
@@ -0,0 +1,25 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import QUANTILE from './QUANTILE';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TDIGEST.QUANTILE', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(QUANTILE, 'key', [1, 2]),
+ ['TDIGEST.QUANTILE', 'key', '1', '2']
+ );
+ });
+
+ testUtils.testWithClient('client.tDigest.quantile', async client => {
+ const [, reply] = await Promise.all([
+ client.tDigest.create('key'),
+ client.tDigest.quantile('key', [1])
+ ]);
+
+ assert.deepEqual(
+ reply,
+ [NaN]
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/t-digest/QUANTILE.ts b/packages/bloom/lib/commands/t-digest/QUANTILE.ts
new file mode 100644
index 00000000000..772172b84d5
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/QUANTILE.ts
@@ -0,0 +1,22 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
+import { transformDoubleArrayReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns value estimates at requested quantiles from a t-digest sketch
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch
+ * @param quantiles - Array of quantiles (between 0 and 1) to get value estimates for
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, quantiles: Array) {
+ parser.push('TDIGEST.QUANTILE');
+ parser.pushKey(key);
+
+ for (const quantile of quantiles) {
+ parser.push(quantile.toString());
+ }
+ },
+ transformReply: transformDoubleArrayReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/t-digest/RANK.spec.ts b/packages/bloom/lib/commands/t-digest/RANK.spec.ts
new file mode 100644
index 00000000000..f1747662f0a
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/RANK.spec.ts
@@ -0,0 +1,22 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import RANK from './RANK';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TDIGEST.RANK', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(RANK, 'key', [1, 2]),
+ ['TDIGEST.RANK', 'key', '1', '2']
+ );
+ });
+
+ testUtils.testWithClient('client.tDigest.rank', async client => {
+ const [, reply] = await Promise.all([
+ client.tDigest.create('key'),
+ client.tDigest.rank('key', [1])
+ ]);
+
+ assert.deepEqual(reply, [-2]);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/t-digest/RANK.ts b/packages/bloom/lib/commands/t-digest/RANK.ts
new file mode 100644
index 00000000000..55dd3c636ce
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/RANK.ts
@@ -0,0 +1,29 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, ArrayReply, NumberReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+export function transformRankArguments(
+ parser: CommandParser,
+ key: RedisArgument,
+ values: Array
+) {
+ parser.pushKey(key);
+
+ for (const value of values) {
+ parser.push(value.toString());
+ }
+}
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns the rank of one or more values in a t-digest sketch (number of values that are lower than each value)
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch
+ * @param values - Array of values to get ranks for
+ */
+ parseCommand(...args: Parameters) {
+ args[0].push('TDIGEST.RANK');
+ transformRankArguments(...args);
+ },
+ transformReply: undefined as unknown as () => ArrayReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/t-digest/RESET.spec.ts b/packages/bloom/lib/commands/t-digest/RESET.spec.ts
new file mode 100644
index 00000000000..8e1fc12e6e3
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/RESET.spec.ts
@@ -0,0 +1,22 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import RESET from './RESET';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TDIGEST.RESET', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(RESET, 'key'),
+ ['TDIGEST.RESET', 'key']
+ );
+ });
+
+ testUtils.testWithClient('client.tDigest.reset', async client => {
+ const [, reply] = await Promise.all([
+ client.tDigest.create('key'),
+ client.tDigest.reset('key')
+ ]);
+
+ assert.equal(reply, 'OK');
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/t-digest/RESET.ts b/packages/bloom/lib/commands/t-digest/RESET.ts
new file mode 100644
index 00000000000..8e1cefe9ff8
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/RESET.ts
@@ -0,0 +1,16 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, SimpleStringReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Resets a t-digest sketch, clearing all previously added observations
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch to reset
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument) {
+ parser.push('TDIGEST.RESET');
+ parser.pushKey(key);
+ },
+ transformReply: undefined as unknown as () => SimpleStringReply<'OK'>
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/t-digest/REVRANK.spec.ts b/packages/bloom/lib/commands/t-digest/REVRANK.spec.ts
new file mode 100644
index 00000000000..be7b23b2238
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/REVRANK.spec.ts
@@ -0,0 +1,22 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import REVRANK from './REVRANK';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TDIGEST.REVRANK', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(REVRANK, 'key', [1, 2]),
+ ['TDIGEST.REVRANK', 'key', '1', '2']
+ );
+ });
+
+ testUtils.testWithClient('client.tDigest.revRank', async client => {
+ const [, reply] = await Promise.all([
+ client.tDigest.create('key'),
+ client.tDigest.revRank('key', [1])
+ ]);
+
+ assert.deepEqual(reply, [-2]);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/t-digest/REVRANK.ts b/packages/bloom/lib/commands/t-digest/REVRANK.ts
new file mode 100644
index 00000000000..e323e10190a
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/REVRANK.ts
@@ -0,0 +1,17 @@
+import { Command } from '@redis/client/dist/lib/RESP/types';
+import RANK, { transformRankArguments } from './RANK';
+
+/**
+ * Returns the reverse rank of one or more values in a t-digest sketch (number of values that are higher than each value)
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch
+ * @param values - Array of values to get reverse ranks for
+ */
+export default {
+ IS_READ_ONLY: RANK.IS_READ_ONLY,
+ parseCommand(...args: Parameters) {
+ args[0].push('TDIGEST.REVRANK');
+ transformRankArguments(...args);
+ },
+ transformReply: RANK.transformReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/t-digest/TRIMMED_MEAN.spec.ts b/packages/bloom/lib/commands/t-digest/TRIMMED_MEAN.spec.ts
new file mode 100644
index 00000000000..8e83c736476
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/TRIMMED_MEAN.spec.ts
@@ -0,0 +1,22 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import TRIMMED_MEAN from './TRIMMED_MEAN';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TDIGEST.TRIMMED_MEAN', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(TRIMMED_MEAN, 'key', 0, 1),
+ ['TDIGEST.TRIMMED_MEAN', 'key', '0', '1']
+ );
+ });
+
+ testUtils.testWithClient('client.tDigest.trimmedMean', async client => {
+ const [, reply] = await Promise.all([
+ client.tDigest.create('key'),
+ client.tDigest.trimmedMean('key', 0, 1)
+ ]);
+
+ assert.equal(reply, NaN);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/t-digest/TRIMMED_MEAN.ts b/packages/bloom/lib/commands/t-digest/TRIMMED_MEAN.ts
new file mode 100644
index 00000000000..f65f37a95de
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/TRIMMED_MEAN.ts
@@ -0,0 +1,25 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
+import { transformDoubleReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns the mean value from a t-digest sketch after trimming values at specified percentiles
+ * @param parser - The command parser
+ * @param key - The name of the t-digest sketch
+ * @param lowCutPercentile - Lower percentile cutoff (between 0 and 100)
+ * @param highCutPercentile - Higher percentile cutoff (between 0 and 100)
+ */
+ parseCommand(
+ parser: CommandParser,
+ key: RedisArgument,
+ lowCutPercentile: number,
+ highCutPercentile: number
+ ) {
+ parser.push('TDIGEST.TRIMMED_MEAN');
+ parser.pushKey(key);
+ parser.push(lowCutPercentile.toString(), highCutPercentile.toString());
+ },
+ transformReply: transformDoubleReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/t-digest/index.ts b/packages/bloom/lib/commands/t-digest/index.ts
new file mode 100644
index 00000000000..d180911dbf9
--- /dev/null
+++ b/packages/bloom/lib/commands/t-digest/index.ts
@@ -0,0 +1,46 @@
+import type { RedisCommands } from '@redis/client/dist/lib/RESP/types';
+import ADD from './ADD';
+import BYRANK from './BYRANK';
+import BYREVRANK from './BYREVRANK';
+import CDF from './CDF';
+import CREATE from './CREATE';
+import INFO from './INFO';
+import MAX from './MAX';
+import MERGE from './MERGE';
+import MIN from './MIN';
+import QUANTILE from './QUANTILE';
+import RANK from './RANK';
+import RESET from './RESET';
+import REVRANK from './REVRANK';
+import TRIMMED_MEAN from './TRIMMED_MEAN';
+
+export default {
+ ADD,
+ add: ADD,
+ BYRANK,
+ byRank: BYRANK,
+ BYREVRANK,
+ byRevRank: BYREVRANK,
+ CDF,
+ cdf: CDF,
+ CREATE,
+ create: CREATE,
+ INFO,
+ info: INFO,
+ MAX,
+ max: MAX,
+ MERGE,
+ merge: MERGE,
+ MIN,
+ min: MIN,
+ QUANTILE,
+ quantile: QUANTILE,
+ RANK,
+ rank: RANK,
+ RESET,
+ reset: RESET,
+ REVRANK,
+ revRank: REVRANK,
+ TRIMMED_MEAN,
+ trimmedMean: TRIMMED_MEAN
+} as const satisfies RedisCommands;
diff --git a/packages/bloom/lib/commands/top-k/ADD.spec.ts b/packages/bloom/lib/commands/top-k/ADD.spec.ts
new file mode 100644
index 00000000000..15a7a9ce1dd
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/ADD.spec.ts
@@ -0,0 +1,22 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import ADD from './ADD';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TOPK.ADD', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(ADD, 'key', 'item'),
+ ['TOPK.ADD', 'key', 'item']
+ );
+ });
+
+ testUtils.testWithClient('client.topK.add', async client => {
+ const [, reply] = await Promise.all([
+ client.topK.reserve('topK', 3),
+ client.topK.add('topK', 'item')
+ ]);
+
+ assert.deepEqual(reply, [null]);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/top-k/ADD.ts b/packages/bloom/lib/commands/top-k/ADD.ts
new file mode 100644
index 00000000000..8eab7dd5241
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/ADD.ts
@@ -0,0 +1,19 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, ArrayReply, BlobStringReply, Command } from '@redis/client/dist/lib/RESP/types';
+import { RedisVariadicArgument } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Adds one or more items to a Top-K filter and returns items dropped from the top-K list
+ * @param parser - The command parser
+ * @param key - The name of the Top-K filter
+ * @param items - One or more items to add to the filter
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, items: RedisVariadicArgument) {
+ parser.push('TOPK.ADD');
+ parser.pushKey(key);
+ parser.pushVariadic(items);
+ },
+ transformReply: undefined as unknown as () => ArrayReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/top-k/COUNT.spec.ts b/packages/bloom/lib/commands/top-k/COUNT.spec.ts
new file mode 100644
index 00000000000..a242edfef8a
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/COUNT.spec.ts
@@ -0,0 +1,22 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import COUNT from './COUNT';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TOPK.COUNT', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(COUNT, 'key', 'item'),
+ ['TOPK.COUNT', 'key', 'item']
+ );
+ });
+
+ testUtils.testWithClient('client.topK.count', async client => {
+ const [, reply] = await Promise.all([
+ client.topK.reserve('key', 3),
+ client.topK.count('key', 'item')
+ ]);
+
+ assert.deepEqual(reply, [0]);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/top-k/COUNT.ts b/packages/bloom/lib/commands/top-k/COUNT.ts
new file mode 100644
index 00000000000..b72641471cd
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/COUNT.ts
@@ -0,0 +1,19 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, ArrayReply, NumberReply, Command } from '@redis/client/dist/lib/RESP/types';
+import { RedisVariadicArgument } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns the count of occurrences for one or more items in a Top-K filter
+ * @param parser - The command parser
+ * @param key - The name of the Top-K filter
+ * @param items - One or more items to get counts for
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, items: RedisVariadicArgument) {
+ parser.push('TOPK.COUNT');
+ parser.pushKey(key);
+ parser.pushVariadic(items);
+ },
+ transformReply: undefined as unknown as () => ArrayReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/top-k/INCRBY.spec.ts b/packages/bloom/lib/commands/top-k/INCRBY.spec.ts
new file mode 100644
index 00000000000..94e5b1d7058
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/INCRBY.spec.ts
@@ -0,0 +1,43 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import INCRBY from './INCRBY';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TOPK.INCRBY', () => {
+ describe('transformArguments', () => {
+ it('single item', () => {
+ assert.deepEqual(
+ parseArgs(INCRBY, 'key', {
+ item: 'item',
+ incrementBy: 1
+ }),
+ ['TOPK.INCRBY', 'key', 'item', '1']
+ );
+ });
+
+ it('multiple items', () => {
+ assert.deepEqual(
+ parseArgs(INCRBY, 'key', [{
+ item: 'a',
+ incrementBy: 1
+ }, {
+ item: 'b',
+ incrementBy: 2
+ }]),
+ ['TOPK.INCRBY', 'key', 'a', '1', 'b', '2']
+ );
+ });
+ });
+
+ testUtils.testWithClient('client.topK.incrby', async client => {
+ const [, reply] = await Promise.all([
+ client.topK.reserve('key', 5),
+ client.topK.incrBy('key', {
+ item: 'item',
+ incrementBy: 1
+ })
+ ]);
+
+ assert.deepEqual(reply, [null]);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/top-k/INCRBY.ts b/packages/bloom/lib/commands/top-k/INCRBY.ts
new file mode 100644
index 00000000000..ef93653bd3c
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/INCRBY.ts
@@ -0,0 +1,38 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, ArrayReply, SimpleStringReply, NullReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+export interface TopKIncrByItem {
+ item: string;
+ incrementBy: number;
+}
+
+function pushIncrByItem(parser: CommandParser, { item, incrementBy }: TopKIncrByItem) {
+ parser.push(item, incrementBy.toString());
+}
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Increases the score of one or more items in a Top-K filter by specified increments
+ * @param parser - The command parser
+ * @param key - The name of the Top-K filter
+ * @param items - A single item or array of items to increment, each with an item name and increment value
+ */
+ parseCommand(
+ parser: CommandParser,
+ key: RedisArgument,
+ items: TopKIncrByItem | Array
+ ) {
+ parser.push('TOPK.INCRBY');
+ parser.pushKey(key);
+
+ if (Array.isArray(items)) {
+ for (const item of items) {
+ pushIncrByItem(parser, item);
+ }
+ } else {
+ pushIncrByItem(parser, items);
+ }
+ },
+ transformReply: undefined as unknown as () => ArrayReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/top-k/INFO.spec.ts b/packages/bloom/lib/commands/top-k/INFO.spec.ts
new file mode 100644
index 00000000000..2efbf0bdbef
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/INFO.spec.ts
@@ -0,0 +1,27 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import INFO from './INFO';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TOPK INFO', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(INFO, 'key'),
+ ['TOPK.INFO', 'key']
+ );
+ });
+
+ testUtils.testWithClient('client.topK.info', async client => {
+ const k = 3,
+ [, reply] = await Promise.all([
+ client.topK.reserve('key', 3),
+ client.topK.info('key')
+ ]);
+
+ assert.equal(typeof reply, 'object');
+ assert.equal(reply.k, k);
+ assert.equal(typeof reply.width, 'number');
+ assert.equal(typeof reply.depth, 'number');
+ assert.equal(typeof reply.decay, 'number');
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/top-k/INFO.ts b/packages/bloom/lib/commands/top-k/INFO.ts
new file mode 100644
index 00000000000..60ee3939324
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/INFO.ts
@@ -0,0 +1,32 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, TuplesToMapReply, NumberReply, DoubleReply, UnwrapReply, Resp2Reply, Command, SimpleStringReply, TypeMapping } from '@redis/client/dist/lib/RESP/types';
+import { transformDoubleReply } from '@redis/client/dist/lib/commands/generic-transformers';
+import { transformInfoV2Reply } from '../bloom';
+
+export type TopKInfoReplyMap = TuplesToMapReply<[
+ [SimpleStringReply<'k'>, NumberReply],
+ [SimpleStringReply<'width'>, NumberReply],
+ [SimpleStringReply<'depth'>, NumberReply],
+ [SimpleStringReply<'decay'>, DoubleReply]
+]>;
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns configuration and statistics of a Top-K filter, including k, width, depth, and decay parameters
+ * @param parser - The command parser
+ * @param key - The name of the Top-K filter to get information about
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument) {
+ parser.push('TOPK.INFO');
+ parser.pushKey(key);
+ },
+ transformReply: {
+ 2: (reply: UnwrapReply>, preserve?: any, typeMapping?: TypeMapping): TopKInfoReplyMap => {
+ reply[7] = transformDoubleReply[2](reply[7], preserve, typeMapping) as any;
+
+ return transformInfoV2Reply(reply, typeMapping);
+ },
+ 3: undefined as unknown as () => TopKInfoReplyMap
+ }
+} as const satisfies Command
diff --git a/packages/bloom/lib/commands/top-k/LIST.spec.ts b/packages/bloom/lib/commands/top-k/LIST.spec.ts
new file mode 100644
index 00000000000..8f5d0efa4db
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/LIST.spec.ts
@@ -0,0 +1,22 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import LIST from './LIST';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TOPK.LIST', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(LIST, 'key'),
+ ['TOPK.LIST', 'key']
+ );
+ });
+
+ testUtils.testWithClient('client.topK.list', async client => {
+ const [, reply] = await Promise.all([
+ client.topK.reserve('key', 3),
+ client.topK.list('key')
+ ]);
+
+ assert.deepEqual(reply, []);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/top-k/LIST.ts b/packages/bloom/lib/commands/top-k/LIST.ts
new file mode 100644
index 00000000000..e030ff02efa
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/LIST.ts
@@ -0,0 +1,16 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, ArrayReply, BlobStringReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns all items in a Top-K filter
+ * @param parser - The command parser
+ * @param key - The name of the Top-K filter
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument) {
+ parser.push('TOPK.LIST');
+ parser.pushKey(key);
+ },
+ transformReply: undefined as unknown as () => ArrayReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/top-k/LIST_WITHCOUNT.spec.ts b/packages/bloom/lib/commands/top-k/LIST_WITHCOUNT.spec.ts
new file mode 100644
index 00000000000..852170e8cd3
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/LIST_WITHCOUNT.spec.ts
@@ -0,0 +1,28 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import LIST_WITHCOUNT from './LIST_WITHCOUNT';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TOPK.LIST WITHCOUNT', () => {
+ testUtils.isVersionGreaterThanHook([2, 2, 9]);
+
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(LIST_WITHCOUNT, 'key'),
+ ['TOPK.LIST', 'key', 'WITHCOUNT']
+ );
+ });
+
+ testUtils.testWithClient('client.topK.listWithCount', async client => {
+ const [, , list] = await Promise.all([
+ client.topK.reserve('key', 3),
+ client.topK.add('key', 'item'),
+ client.topK.listWithCount('key')
+ ]);
+
+ assert.deepEqual(list, [{
+ item: 'item',
+ count: 1
+ }]);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/top-k/LIST_WITHCOUNT.ts b/packages/bloom/lib/commands/top-k/LIST_WITHCOUNT.ts
new file mode 100644
index 00000000000..bed58a36b70
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/LIST_WITHCOUNT.ts
@@ -0,0 +1,31 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, ArrayReply, BlobStringReply, NumberReply, UnwrapReply, Command } from '@redis/client/dist/lib/RESP/types';
+
+export default {
+ IS_READ_ONLY: true,
+ /**
+ * Returns all items in a Top-K filter with their respective counts
+ * @param parser - The command parser
+ * @param key - The name of the Top-K filter
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument) {
+ parser.push('TOPK.LIST');
+ parser.pushKey(key);
+ parser.push('WITHCOUNT');
+ },
+ transformReply(rawReply: UnwrapReply>) {
+ const reply: Array<{
+ item: BlobStringReply;
+ count: NumberReply;
+ }> = [];
+
+ for (let i = 0; i < rawReply.length; i++) {
+ reply.push({
+ item: rawReply[i] as BlobStringReply,
+ count: rawReply[++i] as NumberReply
+ });
+ }
+
+ return reply;
+ }
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/top-k/QUERY.spec.ts b/packages/bloom/lib/commands/top-k/QUERY.spec.ts
new file mode 100644
index 00000000000..3651ec5d37b
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/QUERY.spec.ts
@@ -0,0 +1,22 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import QUERY from './QUERY';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TOPK.QUERY', () => {
+ it('transformArguments', () => {
+ assert.deepEqual(
+ parseArgs(QUERY, 'key', 'item'),
+ ['TOPK.QUERY', 'key', 'item']
+ );
+ });
+
+ testUtils.testWithClient('client.topK.query', async client => {
+ const [, reply] = await Promise.all([
+ client.topK.reserve('key', 3),
+ client.topK.query('key', 'item')
+ ]);
+
+ assert.deepEqual(reply, [false]);
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/top-k/QUERY.ts b/packages/bloom/lib/commands/top-k/QUERY.ts
new file mode 100644
index 00000000000..8976e211979
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/QUERY.ts
@@ -0,0 +1,19 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
+import { RedisVariadicArgument, transformBooleanArrayReply } from '@redis/client/dist/lib/commands/generic-transformers';
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Checks if one or more items are in the Top-K list
+ * @param parser - The command parser
+ * @param key - The name of the Top-K filter
+ * @param items - One or more items to check in the filter
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, items: RedisVariadicArgument) {
+ parser.push('TOPK.QUERY');
+ parser.pushKey(key);
+ parser.pushVariadic(items);
+ },
+ transformReply: transformBooleanArrayReply
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/top-k/RESERVE.spec.ts b/packages/bloom/lib/commands/top-k/RESERVE.spec.ts
new file mode 100644
index 00000000000..aa8d194f940
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/RESERVE.spec.ts
@@ -0,0 +1,33 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL } from '../../test-utils';
+import RESERVE from './RESERVE';
+import { parseArgs } from '@redis/client/lib/commands/generic-transformers';
+
+describe('TOPK.RESERVE', () => {
+ describe('transformArguments', () => {
+ it('simple', () => {
+ assert.deepEqual(
+ parseArgs(RESERVE, 'topK', 3),
+ ['TOPK.RESERVE', 'topK', '3']
+ );
+ });
+
+ it('with options', () => {
+ assert.deepEqual(
+ parseArgs(RESERVE, 'topK', 3, {
+ width: 8,
+ depth: 7,
+ decay: 0.9
+ }),
+ ['TOPK.RESERVE', 'topK', '3', '8', '7', '0.9']
+ );
+ });
+ });
+
+ testUtils.testWithClient('client.topK.reserve', async client => {
+ assert.equal(
+ await client.topK.reserve('topK', 3),
+ 'OK'
+ );
+ }, GLOBAL.SERVERS.OPEN);
+});
diff --git a/packages/bloom/lib/commands/top-k/RESERVE.ts b/packages/bloom/lib/commands/top-k/RESERVE.ts
new file mode 100644
index 00000000000..e31c2ceb99c
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/RESERVE.ts
@@ -0,0 +1,36 @@
+import { CommandParser } from '@redis/client/dist/lib/client/parser';
+import { SimpleStringReply, Command, RedisArgument } from '@redis/client/dist/lib/RESP/types';
+
+export interface TopKReserveOptions {
+ width: number;
+ depth: number;
+ decay: number;
+}
+
+export default {
+ IS_READ_ONLY: false,
+ /**
+ * Creates a new Top-K filter with specified parameters
+ * @param parser - The command parser
+ * @param key - The name of the Top-K filter
+ * @param topK - Number of top occurring items to keep
+ * @param options - Optional parameters for filter configuration
+ * @param options.width - Number of counters in each array
+ * @param options.depth - Number of counter-arrays
+ * @param options.decay - Counter decay factor
+ */
+ parseCommand(parser: CommandParser, key: RedisArgument, topK: number, options?: TopKReserveOptions) {
+ parser.push('TOPK.RESERVE');
+ parser.pushKey(key);
+ parser.push(topK.toString());
+
+ if (options) {
+ parser.push(
+ options.width.toString(),
+ options.depth.toString(),
+ options.decay.toString()
+ );
+ }
+ },
+ transformReply: undefined as unknown as () => SimpleStringReply<'OK'>
+} as const satisfies Command;
diff --git a/packages/bloom/lib/commands/top-k/index.ts b/packages/bloom/lib/commands/top-k/index.ts
new file mode 100644
index 00000000000..fb5de543cab
--- /dev/null
+++ b/packages/bloom/lib/commands/top-k/index.ts
@@ -0,0 +1,28 @@
+import type { RedisCommands } from '@redis/client/dist/lib/RESP/types';
+import ADD from './ADD';
+import COUNT from './COUNT';
+import INCRBY from './INCRBY';
+import INFO from './INFO';
+import LIST_WITHCOUNT from './LIST_WITHCOUNT';
+import LIST from './LIST';
+import QUERY from './QUERY';
+import RESERVE from './RESERVE';
+
+export default {
+ ADD,
+ add: ADD,
+ COUNT,
+ count: COUNT,
+ INCRBY,
+ incrBy: INCRBY,
+ INFO,
+ info: INFO,
+ LIST_WITHCOUNT,
+ listWithCount: LIST_WITHCOUNT,
+ LIST,
+ list: LIST,
+ QUERY,
+ query: QUERY,
+ RESERVE,
+ reserve: RESERVE
+} as const satisfies RedisCommands;
diff --git a/packages/bloom/lib/index.ts b/packages/bloom/lib/index.ts
new file mode 100644
index 00000000000..bc0e103e8c8
--- /dev/null
+++ b/packages/bloom/lib/index.ts
@@ -0,0 +1 @@
+export { default } from './commands';
diff --git a/packages/bloom/lib/test-utils.ts b/packages/bloom/lib/test-utils.ts
new file mode 100644
index 00000000000..2bad3e07617
--- /dev/null
+++ b/packages/bloom/lib/test-utils.ts
@@ -0,0 +1,19 @@
+import TestUtils from '@redis/test-utils';
+import RedisBloomModules from '.';
+
+export default TestUtils.createFromConfig({
+ dockerImageName: 'redislabs/client-libs-test',
+ dockerImageVersionArgument: 'redis-version',
+ defaultDockerVersion: '8.4-M01-pre'
+});
+
+export const GLOBAL = {
+ SERVERS: {
+ OPEN: {
+ serverArguments: [],
+ clientOptions: {
+ modules: RedisBloomModules
+ }
+ }
+ }
+};
diff --git a/packages/bloom/package.json b/packages/bloom/package.json
new file mode 100644
index 00000000000..d6e6eb39364
--- /dev/null
+++ b/packages/bloom/package.json
@@ -0,0 +1,36 @@
+{
+ "name": "@redis/bloom",
+ "version": "5.9.0-beta.2",
+ "license": "MIT",
+ "main": "./dist/lib/index.js",
+ "types": "./dist/lib/index.d.ts",
+ "files": [
+ "dist/",
+ "!dist/tsconfig.tsbuildinfo"
+ ],
+ "scripts": {
+ "test": "nyc -r text-summary -r lcov mocha -r tsx './lib/**/*.spec.ts'",
+ "release": "release-it"
+ },
+ "peerDependencies": {
+ "@redis/client": "^5.9.0-beta.2"
+ },
+ "devDependencies": {
+ "@redis/test-utils": "*"
+ },
+ "engines": {
+ "node": ">= 18"
+ },
+ "repository": {
+ "type": "git",
+ "url": "git://github.com/redis/node-redis.git"
+ },
+ "bugs": {
+ "url": "https://github.com/redis/node-redis/issues"
+ },
+ "homepage": "https://github.com/redis/node-redis/tree/master/packages/bloom",
+ "keywords": [
+ "redis",
+ "RedisBloom"
+ ]
+}
diff --git a/packages/bloom/tsconfig.json b/packages/bloom/tsconfig.json
new file mode 100644
index 00000000000..da6b76e89be
--- /dev/null
+++ b/packages/bloom/tsconfig.json
@@ -0,0 +1,20 @@
+{
+ "extends": "../../tsconfig.base.json",
+ "compilerOptions": {
+ "outDir": "./dist"
+ },
+ "include": [
+ "./lib/**/*.ts"
+ ],
+ "exclude": [
+ "./lib/test-utils.ts",
+ "./lib/**/*.spec.ts"
+ ],
+ "typedocOptions": {
+ "entryPoints": [
+ "./lib"
+ ],
+ "entryPointStrategy": "expand",
+ "out": "../../documentation/bloom"
+ }
+}
diff --git a/packages/client/.nycrc.json b/packages/client/.nycrc.json
new file mode 100644
index 00000000000..51e807f9cef
--- /dev/null
+++ b/packages/client/.nycrc.json
@@ -0,0 +1,4 @@
+{
+ "extends": "@istanbuljs/nyc-config-typescript",
+ "exclude": ["dist", "**/*.spec.ts", "lib/test-utils.ts", "examples/*"]
+}
diff --git a/packages/client/.release-it.json b/packages/client/.release-it.json
new file mode 100644
index 00000000000..fe1a6ad0d0d
--- /dev/null
+++ b/packages/client/.release-it.json
@@ -0,0 +1,13 @@
+{
+ "npm": {
+ "publish": true,
+ "publishArgs": ["--access", "public"]
+ },
+ "git": {
+ "tagName": "client@${version}",
+ "tagMatch": "client@*",
+ "commitMessage": "Release ${tagName}",
+ "tagAnnotation": "Release ${tagName}",
+ "commitArgs": "--all"
+ }
+}
diff --git a/packages/client/README.md b/packages/client/README.md
new file mode 100644
index 00000000000..4b5d15088fa
--- /dev/null
+++ b/packages/client/README.md
@@ -0,0 +1,3 @@
+# @redis/client
+
+The source code and documentation for this package are in the main [node-redis](https://github.com/redis/node-redis) repo.
diff --git a/packages/client/index.ts b/packages/client/index.ts
new file mode 100644
index 00000000000..09426cb50a3
--- /dev/null
+++ b/packages/client/index.ts
@@ -0,0 +1,37 @@
+export {
+ /* CommandPolicies, */
+ RedisArgument,
+ RedisFunctions,
+ RedisModules,
+ RedisScripts,
+ RespVersions,
+ TypeMapping,
+} from './lib/RESP/types';
+export { RESP_TYPES } from './lib/RESP/decoder';
+export { VerbatimString } from './lib/RESP/verbatim-string';
+export { defineScript } from './lib/lua-script';
+export * from './lib/errors';
+
+import RedisClient, { RedisClientOptions, RedisClientType } from './lib/client';
+export { RedisClientOptions, RedisClientType };
+export const createClient = RedisClient.create;
+export { CommandParser } from './lib/client/parser';
+
+import { RedisClientPool, RedisPoolOptions, RedisClientPoolType } from './lib/client/pool';
+export { RedisClientPoolType, RedisPoolOptions };
+export const createClientPool = RedisClientPool.create;
+
+import RedisCluster, { RedisClusterOptions, RedisClusterType } from './lib/cluster';
+export { RedisClusterType, RedisClusterOptions };
+export const createCluster = RedisCluster.create;
+
+import RedisSentinel from './lib/sentinel';
+export { RedisSentinelOptions, RedisSentinelType } from './lib/sentinel/types';
+export const createSentinel = RedisSentinel.create;
+
+export { GEO_REPLY_WITH, GeoReplyWith } from './lib/commands/GEOSEARCH_WITH';
+
+
+export { SetOptions, CLIENT_KILL_FILTERS, FAILOVER_MODES, CLUSTER_SLOT_STATES, COMMAND_LIST_FILTER_BY, REDIS_FLUSH_MODES } from './lib/commands'
+
+export { BasicClientSideCache, BasicPooledClientSideCache } from './lib/client/cache';
diff --git a/packages/client/lib/RESP/decoder.spec.ts b/packages/client/lib/RESP/decoder.spec.ts
new file mode 100644
index 00000000000..c034815c9cd
--- /dev/null
+++ b/packages/client/lib/RESP/decoder.spec.ts
@@ -0,0 +1,426 @@
+import { strict as assert } from 'node:assert';
+import { SinonSpy, spy } from 'sinon';
+import { Decoder, RESP_TYPES } from './decoder';
+import { BlobError, SimpleError } from '../errors';
+import { TypeMapping } from './types';
+import { VerbatimString } from './verbatim-string';
+
+interface Test {
+ toWrite: Buffer;
+ typeMapping?: TypeMapping;
+ replies?: Array;
+ errorReplies?: Array;
+ pushReplies?: Array;
+}
+
+function test(name: string, config: Test) {
+ describe(name, () => {
+ it('single chunk', () => {
+ const setup = setupTest(config);
+ setup.decoder.write(config.toWrite);
+ assertSpiesCalls(config, setup);
+ });
+
+ it('byte by byte', () => {
+ const setup = setupTest(config);
+ for (let i = 0; i < config.toWrite.length; i++) {
+ setup.decoder.write(config.toWrite.subarray(i, i + 1));
+ }
+ assertSpiesCalls(config, setup);
+ });
+ })
+}
+
+function setupTest(config: Test) {
+ const onReplySpy = spy(),
+ onErrorReplySpy = spy(),
+ onPushSpy = spy();
+
+ return {
+ decoder: new Decoder({
+ getTypeMapping: () => config.typeMapping ?? {},
+ onReply: onReplySpy,
+ onErrorReply: onErrorReplySpy,
+ onPush: onPushSpy
+ }),
+ onReplySpy,
+ onErrorReplySpy,
+ onPushSpy
+ };
+}
+
+function assertSpiesCalls(config: Test, spies: ReturnType) {
+ assertSpyCalls(spies.onReplySpy, config.replies);
+ assertSpyCalls(spies.onErrorReplySpy, config.errorReplies);
+ assertSpyCalls(spies.onPushSpy, config.pushReplies);
+}
+
+function assertSpyCalls(spy: SinonSpy, replies?: Array) {
+ if (!replies) {
+ assert.equal(spy.callCount, 0);
+ return;
+ }
+
+ assert.equal(spy.callCount, replies.length);
+ for (const [i, reply] of replies.entries()) {
+ assert.deepEqual(
+ spy.getCall(i).args,
+ [reply]
+ );
+ }
+}
+
+describe('RESP Decoder', () => {
+ test('Null', {
+ toWrite: Buffer.from('_\r\n'),
+ replies: [null]
+ });
+
+ describe('Boolean', () => {
+ test('true', {
+ toWrite: Buffer.from('#t\r\n'),
+ replies: [true]
+ });
+
+ test('false', {
+ toWrite: Buffer.from('#f\r\n'),
+ replies: [false]
+ });
+ });
+
+ describe('Number', () => {
+ test('0', {
+ toWrite: Buffer.from(':0\r\n'),
+ replies: [0]
+ });
+
+ test('1', {
+ toWrite: Buffer.from(':+1\r\n'),
+ replies: [1]
+ });
+
+ test('+1', {
+ toWrite: Buffer.from(':+1\r\n'),
+ replies: [1]
+ });
+
+ test('-1', {
+ toWrite: Buffer.from(':-1\r\n'),
+ replies: [-1]
+ });
+
+ test('1 as string', {
+ typeMapping: {
+ [RESP_TYPES.NUMBER]: String
+ },
+ toWrite: Buffer.from(':1\r\n'),
+ replies: ['1']
+ });
+ });
+
+ describe('BigNumber', () => {
+ test('0', {
+ toWrite: Buffer.from('(0\r\n'),
+ replies: [0n]
+ });
+
+ test('1', {
+ toWrite: Buffer.from('(1\r\n'),
+ replies: [1n]
+ });
+
+ test('+1', {
+ toWrite: Buffer.from('(+1\r\n'),
+ replies: [1n]
+ });
+
+ test('-1', {
+ toWrite: Buffer.from('(-1\r\n'),
+ replies: [-1n]
+ });
+
+ test('1 as string', {
+ typeMapping: {
+ [RESP_TYPES.BIG_NUMBER]: String
+ },
+ toWrite: Buffer.from('(1\r\n'),
+ replies: ['1']
+ });
+ });
+
+ describe('Double', () => {
+ test('0', {
+ toWrite: Buffer.from(',0\r\n'),
+ replies: [0]
+ });
+
+ test('1', {
+ toWrite: Buffer.from(',1\r\n'),
+ replies: [1]
+ });
+
+ test('+1', {
+ toWrite: Buffer.from(',+1\r\n'),
+ replies: [1]
+ });
+
+ test('-1', {
+ toWrite: Buffer.from(',-1\r\n'),
+ replies: [-1]
+ });
+
+ test('1.1', {
+ toWrite: Buffer.from(',1.1\r\n'),
+ replies: [1.1]
+ });
+
+ test('nan', {
+ toWrite: Buffer.from(',nan\r\n'),
+ replies: [NaN]
+ });
+
+ test('inf', {
+ toWrite: Buffer.from(',inf\r\n'),
+ replies: [Infinity]
+ });
+
+ test('+inf', {
+ toWrite: Buffer.from(',+inf\r\n'),
+ replies: [Infinity]
+ });
+
+ test('-inf', {
+ toWrite: Buffer.from(',-inf\r\n'),
+ replies: [-Infinity]
+ });
+
+ test('1e1', {
+ toWrite: Buffer.from(',1e1\r\n'),
+ replies: [1e1]
+ });
+
+ test('-1.1E+1', {
+ toWrite: Buffer.from(',-1.1E+1\r\n'),
+ replies: [-1.1E+1]
+ });
+
+ test('1 as string', {
+ typeMapping: {
+ [RESP_TYPES.DOUBLE]: String
+ },
+ toWrite: Buffer.from(',1\r\n'),
+ replies: ['1']
+ });
+ });
+
+ describe('SimpleString', () => {
+ test("'OK'", {
+ toWrite: Buffer.from('+OK\r\n'),
+ replies: ['OK']
+ });
+
+ test("'OK' as Buffer", {
+ typeMapping: {
+ [RESP_TYPES.SIMPLE_STRING]: Buffer
+ },
+ toWrite: Buffer.from('+OK\r\n'),
+ replies: [Buffer.from('OK')]
+ });
+ });
+
+ describe('BlobString', () => {
+ test("''", {
+ toWrite: Buffer.from('$0\r\n\r\n'),
+ replies: ['']
+ });
+
+ test("'1234567890'", {
+ toWrite: Buffer.from('$10\r\n1234567890\r\n'),
+ replies: ['1234567890']
+ });
+
+ test('null (RESP2 backwards compatibility)', {
+ toWrite: Buffer.from('$-1\r\n'),
+ replies: [null]
+ });
+
+ test("'OK' as Buffer", {
+ typeMapping: {
+ [RESP_TYPES.BLOB_STRING]: Buffer
+ },
+ toWrite: Buffer.from('$2\r\nOK\r\n'),
+ replies: [Buffer.from('OK')]
+ });
+ });
+
+ describe('VerbatimString', () => {
+ test("''", {
+ toWrite: Buffer.from('=4\r\ntxt:\r\n'),
+ replies: ['']
+ });
+
+ test("'123456'", {
+ toWrite: Buffer.from('=10\r\ntxt:123456\r\n'),
+ replies: ['123456']
+ });
+
+ test("'OK' as VerbatimString", {
+ typeMapping: {
+ [RESP_TYPES.VERBATIM_STRING]: VerbatimString
+ },
+ toWrite: Buffer.from('=6\r\ntxt:OK\r\n'),
+ replies: [new VerbatimString('txt', 'OK')]
+ });
+
+ test("'OK' as Buffer", {
+ typeMapping: {
+ [RESP_TYPES.VERBATIM_STRING]: Buffer
+ },
+ toWrite: Buffer.from('=6\r\ntxt:OK\r\n'),
+ replies: [Buffer.from('OK')]
+ });
+ });
+
+ test('SimpleError', {
+ toWrite: Buffer.from('-ERROR\r\n'),
+ errorReplies: [new SimpleError('ERROR')]
+ });
+
+ test('BlobError', {
+ toWrite: Buffer.from('!5\r\nERROR\r\n'),
+ errorReplies: [new BlobError('ERROR')]
+ });
+
+ describe('Array', () => {
+ test('[]', {
+ toWrite: Buffer.from('*0\r\n'),
+ replies: [[]]
+ });
+
+ test('[0..9]', {
+ toWrite: Buffer.from(`*10\r\n:0\r\n:1\r\n:2\r\n:3\r\n:4\r\n:5\r\n:6\r\n:7\r\n:8\r\n:9\r\n`),
+ replies: [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]]
+ });
+
+ test('with all types', {
+ toWrite: Buffer.from([
+ '*13\r\n',
+ '_\r\n',
+ '#f\r\n',
+ ':0\r\n',
+ '(0\r\n',
+ ',0\r\n',
+ '+\r\n',
+ '$0\r\n\r\n',
+ '=4\r\ntxt:\r\n',
+ '-\r\n',
+ '!0\r\n\r\n',
+ '*0\r\n',
+ '~0\r\n',
+ '%0\r\n'
+ ].join('')),
+ replies: [[
+ null,
+ false,
+ 0,
+ 0n,
+ 0,
+ '',
+ '',
+ '',
+ new SimpleError(''),
+ new BlobError(''),
+ [],
+ [],
+ Object.create(null)
+ ]]
+ });
+
+ test('null (RESP2 backwards compatibility)', {
+ toWrite: Buffer.from('*-1\r\n'),
+ replies: [null]
+ });
+ });
+
+ describe('Set', () => {
+ test('empty', {
+ toWrite: Buffer.from('~0\r\n'),
+ replies: [[]]
+ });
+
+ test('of 0..9', {
+ toWrite: Buffer.from(`~10\r\n:0\r\n:1\r\n:2\r\n:3\r\n:4\r\n:5\r\n:6\r\n:7\r\n:8\r\n:9\r\n`),
+ replies: [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]]
+ });
+
+ test('0..9 as Set', {
+ typeMapping: {
+ [RESP_TYPES.SET]: Set
+ },
+ toWrite: Buffer.from(`~10\r\n:0\r\n:1\r\n:2\r\n:3\r\n:4\r\n:5\r\n:6\r\n:7\r\n:8\r\n:9\r\n`),
+ replies: [new Set([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])]
+ });
+ });
+
+ describe('Map', () => {
+ test('{}', {
+ toWrite: Buffer.from('%0\r\n'),
+ replies: [Object.create(null)]
+ });
+
+ test("{ '0'..'9': }", {
+ toWrite: Buffer.from(`%10\r\n+0\r\n+0\r\n+1\r\n+1\r\n+2\r\n+2\r\n+3\r\n+3\r\n+4\r\n+4\r\n+5\r\n+5\r\n+6\r\n+6\r\n+7\r\n+7\r\n+8\r\n+8\r\n+9\r\n+9\r\n`),
+ replies: [Object.create(null, {
+ 0: { value: '0', enumerable: true },
+ 1: { value: '1', enumerable: true },
+ 2: { value: '2', enumerable: true },
+ 3: { value: '3', enumerable: true },
+ 4: { value: '4', enumerable: true },
+ 5: { value: '5', enumerable: true },
+ 6: { value: '6', enumerable: true },
+ 7: { value: '7', enumerable: true },
+ 8: { value: '8', enumerable: true },
+ 9: { value: '9', enumerable: true }
+ })]
+ });
+
+ test("{ '0'..'9': } as Map", {
+ typeMapping: {
+ [RESP_TYPES.MAP]: Map
+ },
+ toWrite: Buffer.from(`%10\r\n+0\r\n+0\r\n+1\r\n+1\r\n+2\r\n+2\r\n+3\r\n+3\r\n+4\r\n+4\r\n+5\r\n+5\r\n+6\r\n+6\r\n+7\r\n+7\r\n+8\r\n+8\r\n+9\r\n+9\r\n`),
+ replies: [new Map([
+ ['0', '0'],
+ ['1', '1'],
+ ['2', '2'],
+ ['3', '3'],
+ ['4', '4'],
+ ['5', '5'],
+ ['6', '6'],
+ ['7', '7'],
+ ['8', '8'],
+ ['9', '9']
+ ])]
+ });
+
+ test("{ '0'..'9': } as Array", {
+ typeMapping: {
+ [RESP_TYPES.MAP]: Array
+ },
+ toWrite: Buffer.from(`%10\r\n+0\r\n+0\r\n+1\r\n+1\r\n+2\r\n+2\r\n+3\r\n+3\r\n+4\r\n+4\r\n+5\r\n+5\r\n+6\r\n+6\r\n+7\r\n+7\r\n+8\r\n+8\r\n+9\r\n+9\r\n`),
+ replies: [['0', '0', '1', '1', '2', '2', '3', '3', '4', '4', '5', '5', '6', '6', '7', '7', '8', '8', '9', '9']]
+ });
+ });
+
+ describe('Push', () => {
+ test('[]', {
+ toWrite: Buffer.from('>0\r\n'),
+ pushReplies: [[]]
+ });
+
+ test('[0..9]', {
+ toWrite: Buffer.from(`>10\r\n:0\r\n:1\r\n:2\r\n:3\r\n:4\r\n:5\r\n:6\r\n:7\r\n:8\r\n:9\r\n`),
+ pushReplies: [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9]]
+ });
+ });
+});
diff --git a/packages/client/lib/RESP/decoder.ts b/packages/client/lib/RESP/decoder.ts
new file mode 100644
index 00000000000..2485ea23b37
--- /dev/null
+++ b/packages/client/lib/RESP/decoder.ts
@@ -0,0 +1,1178 @@
+// @ts-nocheck
+import { VerbatimString } from './verbatim-string';
+import { SimpleError, BlobError, ErrorReply } from '../errors';
+import { TypeMapping } from './types';
+
+// https://github.com/redis/redis-specifications/blob/master/protocol/RESP3.md
+export const RESP_TYPES = {
+ NULL: 95, // _
+ BOOLEAN: 35, // #
+ NUMBER: 58, // :
+ BIG_NUMBER: 40, // (
+ DOUBLE: 44, // ,
+ SIMPLE_STRING: 43, // +
+ BLOB_STRING: 36, // $
+ VERBATIM_STRING: 61, // =
+ SIMPLE_ERROR: 45, // -
+ BLOB_ERROR: 33, // !
+ ARRAY: 42, // *
+ SET: 126, // ~
+ MAP: 37, // %
+ PUSH: 62 // >
+} as const;
+
+const ASCII = {
+ '\r': 13,
+ 't': 116,
+ '+': 43,
+ '-': 45,
+ '0': 48,
+ '.': 46,
+ 'i': 105,
+ 'n': 110,
+ 'E': 69,
+ 'e': 101
+} as const;
+
+export const PUSH_TYPE_MAPPING = {
+ [RESP_TYPES.BLOB_STRING]: Buffer
+};
+
+// this was written with performance in mind, so it's not very readable... sorry :(
+
+interface DecoderOptions {
+ onReply(reply: any): unknown;
+ onErrorReply(err: ErrorReply): unknown;
+ onPush(push: Array): unknown;
+ getTypeMapping(): TypeMapping;
+}
+
+export class Decoder {
+ onReply;
+ onErrorReply;
+ onPush;
+ getTypeMapping;
+ #cursor = 0;
+ #next;
+
+ constructor(config: DecoderOptions) {
+ this.onReply = config.onReply;
+ this.onErrorReply = config.onErrorReply;
+ this.onPush = config.onPush;
+ this.getTypeMapping = config.getTypeMapping;
+ }
+
+ reset() {
+ this.#cursor = 0;
+ this.#next = undefined;
+ }
+
+ write(chunk) {
+ if (this.#cursor >= chunk.length) {
+ this.#cursor -= chunk.length;
+ return;
+ }
+
+ if (this.#next) {
+ if (this.#next(chunk) || this.#cursor >= chunk.length) {
+ this.#cursor -= chunk.length;
+ return;
+ }
+ }
+
+ do {
+ const type = chunk[this.#cursor];
+ if (++this.#cursor === chunk.length) {
+ this.#next = this.#continueDecodeTypeValue.bind(this, type);
+ break;
+ }
+
+ if (this.#decodeTypeValue(type, chunk)) {
+ break;
+ }
+ } while (this.#cursor < chunk.length);
+ this.#cursor -= chunk.length;
+ }
+
+ #continueDecodeTypeValue(type, chunk) {
+ this.#next = undefined;
+ return this.#decodeTypeValue(type, chunk);
+ }
+
+ #decodeTypeValue(type, chunk) {
+ switch (type) {
+ case RESP_TYPES.NULL:
+ this.onReply(this.#decodeNull());
+ return false;
+
+ case RESP_TYPES.BOOLEAN:
+ return this.#handleDecodedValue(
+ this.onReply,
+ this.#decodeBoolean(chunk)
+ );
+
+ case RESP_TYPES.NUMBER:
+ return this.#handleDecodedValue(
+ this.onReply,
+ this.#decodeNumber(
+ this.getTypeMapping()[RESP_TYPES.NUMBER],
+ chunk
+ )
+ );
+
+ case RESP_TYPES.BIG_NUMBER:
+ return this.#handleDecodedValue(
+ this.onReply,
+ this.#decodeBigNumber(
+ this.getTypeMapping()[RESP_TYPES.BIG_NUMBER],
+ chunk
+ )
+ );
+
+ case RESP_TYPES.DOUBLE:
+ return this.#handleDecodedValue(
+ this.onReply,
+ this.#decodeDouble(
+ this.getTypeMapping()[RESP_TYPES.DOUBLE],
+ chunk
+ )
+ );
+
+ case RESP_TYPES.SIMPLE_STRING:
+ return this.#handleDecodedValue(
+ this.onReply,
+ this.#decodeSimpleString(
+ this.getTypeMapping()[RESP_TYPES.SIMPLE_STRING],
+ chunk
+ )
+ );
+
+ case RESP_TYPES.BLOB_STRING:
+ return this.#handleDecodedValue(
+ this.onReply,
+ this.#decodeBlobString(
+ this.getTypeMapping()[RESP_TYPES.BLOB_STRING],
+ chunk
+ )
+ );
+
+ case RESP_TYPES.VERBATIM_STRING:
+ return this.#handleDecodedValue(
+ this.onReply,
+ this.#decodeVerbatimString(
+ this.getTypeMapping()[RESP_TYPES.VERBATIM_STRING],
+ chunk
+ )
+ );
+
+ case RESP_TYPES.SIMPLE_ERROR:
+ return this.#handleDecodedValue(
+ this.onErrorReply,
+ this.#decodeSimpleError(chunk)
+ );
+
+ case RESP_TYPES.BLOB_ERROR:
+ return this.#handleDecodedValue(
+ this.onErrorReply,
+ this.#decodeBlobError(chunk)
+ );
+
+ case RESP_TYPES.ARRAY:
+ return this.#handleDecodedValue(
+ this.onReply,
+ this.#decodeArray(this.getTypeMapping(), chunk)
+ );
+
+ case RESP_TYPES.SET:
+ return this.#handleDecodedValue(
+ this.onReply,
+ this.#decodeSet(this.getTypeMapping(), chunk)
+ );
+
+ case RESP_TYPES.MAP:
+ return this.#handleDecodedValue(
+ this.onReply,
+ this.#decodeMap(this.getTypeMapping(), chunk)
+ );
+
+ case RESP_TYPES.PUSH:
+ return this.#handleDecodedValue(
+ this.onPush,
+ this.#decodeArray(PUSH_TYPE_MAPPING, chunk)
+ );
+
+ default:
+ throw new Error(`Unknown RESP type ${type} "${String.fromCharCode(type)}"`);
+ }
+ }
+
+ #handleDecodedValue(cb, value) {
+ if (typeof value === 'function') {
+ this.#next = this.#continueDecodeValue.bind(this, cb, value);
+ return true;
+ }
+
+ cb(value);
+ return false;
+ }
+
+ #continueDecodeValue(cb, next, chunk) {
+ this.#next = undefined;
+ return this.#handleDecodedValue(cb, next(chunk));
+ }
+
+ #decodeNull() {
+ this.#cursor += 2; // skip \r\n
+ return null;
+ }
+
+ #decodeBoolean(chunk) {
+ const boolean = chunk[this.#cursor] === ASCII.t;
+ this.#cursor += 3; // skip {t | f}\r\n
+ return boolean;
+ }
+
+ #decodeNumber(type, chunk) {
+ if (type === String) {
+ return this.#decodeSimpleString(String, chunk);
+ }
+
+ switch (chunk[this.#cursor]) {
+ case ASCII['+']:
+ return this.#maybeDecodeNumberValue(false, chunk);
+
+ case ASCII['-']:
+ return this.#maybeDecodeNumberValue(true, chunk);
+
+ default:
+ return this.#decodeNumberValue(
+ false,
+ this.#decodeUnsingedNumber.bind(this, 0),
+ chunk
+ );
+ }
+ }
+
+ #maybeDecodeNumberValue(isNegative, chunk) {
+ const cb = this.#decodeUnsingedNumber.bind(this, 0);
+ return ++this.#cursor === chunk.length ?
+ this.#decodeNumberValue.bind(this, isNegative, cb) :
+ this.#decodeNumberValue(isNegative, cb, chunk);
+ }
+
+ #decodeNumberValue(isNegative, numberCb, chunk) {
+ const number = numberCb(chunk);
+ return typeof number === 'function' ?
+ this.#decodeNumberValue.bind(this, isNegative, number) :
+ isNegative ? -number : number;
+ }
+
+ #decodeUnsingedNumber(number, chunk) {
+ let cursor = this.#cursor;
+ do {
+ const byte = chunk[cursor];
+ if (byte === ASCII['\r']) {
+ this.#cursor = cursor + 2; // skip \r\n
+ return number;
+ }
+ number = number * 10 + byte - ASCII['0'];
+ } while (++cursor < chunk.length);
+
+ this.#cursor = cursor;
+ return this.#decodeUnsingedNumber.bind(this, number);
+ }
+
+ #decodeBigNumber(type, chunk) {
+ if (type === String) {
+ return this.#decodeSimpleString(String, chunk);
+ }
+
+ switch (chunk[this.#cursor]) {
+ case ASCII['+']:
+ return this.#maybeDecodeBigNumberValue(false, chunk);
+
+ case ASCII['-']:
+ return this.#maybeDecodeBigNumberValue(true, chunk);
+
+ default:
+ return this.#decodeBigNumberValue(
+ false,
+ this.#decodeUnsingedBigNumber.bind(this, 0n),
+ chunk
+ );
+ }
+ }
+
+ #maybeDecodeBigNumberValue(isNegative, chunk) {
+ const cb = this.#decodeUnsingedBigNumber.bind(this, 0n);
+ return ++this.#cursor === chunk.length ?
+ this.#decodeBigNumberValue.bind(this, isNegative, cb) :
+ this.#decodeBigNumberValue(isNegative, cb, chunk);
+ }
+
+ #decodeBigNumberValue(isNegative, bigNumberCb, chunk) {
+ const bigNumber = bigNumberCb(chunk);
+ return typeof bigNumber === 'function' ?
+ this.#decodeBigNumberValue.bind(this, isNegative, bigNumber) :
+ isNegative ? -bigNumber : bigNumber;
+ }
+
+ #decodeUnsingedBigNumber(bigNumber, chunk) {
+ let cursor = this.#cursor;
+ do {
+ const byte = chunk[cursor];
+ if (byte === ASCII['\r']) {
+ this.#cursor = cursor + 2; // skip \r\n
+ return bigNumber;
+ }
+ bigNumber = bigNumber * 10n + BigInt(byte - ASCII['0']);
+ } while (++cursor < chunk.length);
+
+ this.#cursor = cursor;
+ return this.#decodeUnsingedBigNumber.bind(this, bigNumber);
+ }
+
+ #decodeDouble(type, chunk) {
+ if (type === String) {
+ return this.#decodeSimpleString(String, chunk);
+ }
+
+ switch (chunk[this.#cursor]) {
+ case ASCII.n:
+ this.#cursor += 5; // skip nan\r\n
+ return NaN;
+
+ case ASCII['+']:
+ return this.#maybeDecodeDoubleInteger(false, chunk);
+
+ case ASCII['-']:
+ return this.#maybeDecodeDoubleInteger(true, chunk);
+
+ default:
+ return this.#decodeDoubleInteger(false, 0, chunk);
+ }
+ }
+
+ #maybeDecodeDoubleInteger(isNegative, chunk) {
+ return ++this.#cursor === chunk.length ?
+ this.#decodeDoubleInteger.bind(this, isNegative, 0) :
+ this.#decodeDoubleInteger(isNegative, 0, chunk);
+ }
+
+ #decodeDoubleInteger(isNegative, integer, chunk) {
+ if (chunk[this.#cursor] === ASCII.i) {
+ this.#cursor += 5; // skip inf\r\n
+ return isNegative ? -Infinity : Infinity;
+ }
+
+ return this.#continueDecodeDoubleInteger(isNegative, integer, chunk);
+ }
+
+ #continueDecodeDoubleInteger(isNegative, integer, chunk) {
+ let cursor = this.#cursor;
+ do {
+ const byte = chunk[cursor];
+ switch (byte) {
+ case ASCII['.']:
+ this.#cursor = cursor + 1; // skip .
+ return this.#cursor < chunk.length ?
+ this.#decodeDoubleDecimal(isNegative, 0, integer, chunk) :
+ this.#decodeDoubleDecimal.bind(this, isNegative, 0, integer);
+
+ case ASCII.E:
+ case ASCII.e:
+ this.#cursor = cursor + 1; // skip E/e
+ const i = isNegative ? -integer : integer;
+ return this.#cursor < chunk.length ?
+ this.#decodeDoubleExponent(i, chunk) :
+ this.#decodeDoubleExponent.bind(this, i);
+
+ case ASCII['\r']:
+ this.#cursor = cursor + 2; // skip \r\n
+ return isNegative ? -integer : integer;
+
+ default:
+ integer = integer * 10 + byte - ASCII['0'];
+ }
+ } while (++cursor < chunk.length);
+
+ this.#cursor = cursor;
+ return this.#continueDecodeDoubleInteger.bind(this, isNegative, integer);
+ }
+
+ // Precalculated multipliers for decimal points to improve performance
+ // "... about 15 to 17 decimal places ..."
+ // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number#:~:text=about%2015%20to%2017%20decimal%20places
+ static #DOUBLE_DECIMAL_MULTIPLIERS = [
+ 1e-1, 1e-2, 1e-3, 1e-4, 1e-5, 1e-6,
+ 1e-7, 1e-8, 1e-9, 1e-10, 1e-11, 1e-12,
+ 1e-13, 1e-14, 1e-15, 1e-16, 1e-17
+ ];
+
+ #decodeDoubleDecimal(isNegative, decimalIndex, double, chunk) {
+ let cursor = this.#cursor;
+ do {
+ const byte = chunk[cursor];
+ switch (byte) {
+ case ASCII.E:
+ case ASCII.e:
+ this.#cursor = cursor + 1; // skip E/e
+ const d = isNegative ? -double : double;
+ return this.#cursor === chunk.length ?
+ this.#decodeDoubleExponent.bind(this, d) :
+ this.#decodeDoubleExponent(d, chunk);
+
+ case ASCII['\r']:
+ this.#cursor = cursor + 2; // skip \r\n
+ return isNegative ? -double : double;
+ }
+
+ if (decimalIndex < Decoder.#DOUBLE_DECIMAL_MULTIPLIERS.length) {
+ double += (byte - ASCII['0']) * Decoder.#DOUBLE_DECIMAL_MULTIPLIERS[decimalIndex++];
+ }
+ } while (++cursor < chunk.length);
+
+ this.#cursor = cursor;
+ return this.#decodeDoubleDecimal.bind(this, isNegative, decimalIndex, double);
+ }
+
+ #decodeDoubleExponent(double, chunk) {
+ switch (chunk[this.#cursor]) {
+ case ASCII['+']:
+ return ++this.#cursor === chunk.length ?
+ this.#continueDecodeDoubleExponent.bind(this, false, double, 0) :
+ this.#continueDecodeDoubleExponent(false, double, 0, chunk);
+
+ case ASCII['-']:
+ return ++this.#cursor === chunk.length ?
+ this.#continueDecodeDoubleExponent.bind(this, true, double, 0) :
+ this.#continueDecodeDoubleExponent(true, double, 0, chunk);
+ }
+
+ return this.#continueDecodeDoubleExponent(false, double, 0, chunk);
+ }
+
+ #continueDecodeDoubleExponent(isNegative, double, exponent, chunk) {
+ let cursor = this.#cursor;
+ do {
+ const byte = chunk[cursor];
+ if (byte === ASCII['\r']) {
+ this.#cursor = cursor + 2; // skip \r\n
+ return double * 10 ** (isNegative ? -exponent : exponent);
+ }
+
+ exponent = exponent * 10 + byte - ASCII['0'];
+ } while (++cursor < chunk.length);
+
+ this.#cursor = cursor;
+ return this.#continueDecodeDoubleExponent.bind(this, isNegative, double, exponent);
+ }
+
+ #findCRLF(chunk, cursor) {
+ while (chunk[cursor] !== ASCII['\r']) {
+ if (++cursor === chunk.length) {
+ this.#cursor = chunk.length;
+ return -1;
+ }
+ }
+
+ this.#cursor = cursor + 2; // skip \r\n
+ return cursor;
+ }
+
+ #decodeSimpleString(type, chunk) {
+ const start = this.#cursor,
+ crlfIndex = this.#findCRLF(chunk, start);
+ if (crlfIndex === -1) {
+ return this.#continueDecodeSimpleString.bind(
+ this,
+ [chunk.subarray(start)],
+ type
+ );
+ }
+
+ const slice = chunk.subarray(start, crlfIndex);
+ return type === Buffer ?
+ slice :
+ slice.toString();
+ }
+
+ #continueDecodeSimpleString(chunks, type, chunk) {
+ const start = this.#cursor,
+ crlfIndex = this.#findCRLF(chunk, start);
+ if (crlfIndex === -1) {
+ chunks.push(chunk.subarray(start));
+ return this.#continueDecodeSimpleString.bind(this, chunks, type);
+ }
+
+ chunks.push(chunk.subarray(start, crlfIndex));
+ return type === Buffer ?
+ Buffer.concat(chunks) :
+ chunks.join('');
+ }
+
+ #decodeBlobString(type, chunk) {
+ // RESP 2 bulk string null
+ // https://github.com/redis/redis-specifications/blob/master/protocol/RESP2.md#resp-bulk-strings
+ if (chunk[this.#cursor] === ASCII['-']) {
+ this.#cursor += 4; // skip -1\r\n
+ return null;
+ }
+
+ const length = this.#decodeUnsingedNumber(0, chunk);
+ if (typeof length === 'function') {
+ return this.#continueDecodeBlobStringLength.bind(this, length, type);
+ } else if (this.#cursor >= chunk.length) {
+ return this.#decodeBlobStringWithLength.bind(this, length, type);
+ }
+
+ return this.#decodeBlobStringWithLength(length, type, chunk);
+ }
+
+ #continueDecodeBlobStringLength(lengthCb, type, chunk) {
+ const length = lengthCb(chunk);
+ if (typeof length === 'function') {
+ return this.#continueDecodeBlobStringLength.bind(this, length, type);
+ } else if (this.#cursor >= chunk.length) {
+ return this.#decodeBlobStringWithLength.bind(this, length, type);
+ }
+
+ return this.#decodeBlobStringWithLength(length, type, chunk);
+ }
+
+ #decodeStringWithLength(length, skip, type, chunk) {
+ const end = this.#cursor + length;
+ if (end >= chunk.length) {
+ const slice = chunk.subarray(this.#cursor);
+ this.#cursor = chunk.length;
+ return this.#continueDecodeStringWithLength.bind(
+ this,
+ length - slice.length,
+ [slice],
+ skip,
+ type
+ );
+ }
+
+ const slice = chunk.subarray(this.#cursor, end);
+ this.#cursor = end + skip;
+ return type === Buffer ?
+ slice :
+ slice.toString();
+ }
+
+ #continueDecodeStringWithLength(length, chunks, skip, type, chunk) {
+ const end = this.#cursor + length;
+ if (end >= chunk.length) {
+ const slice = chunk.subarray(this.#cursor);
+ chunks.push(slice);
+ this.#cursor = chunk.length;
+ return this.#continueDecodeStringWithLength.bind(
+ this,
+ length - slice.length,
+ chunks,
+ skip,
+ type
+ );
+ }
+
+ chunks.push(chunk.subarray(this.#cursor, end));
+ this.#cursor = end + skip;
+ return type === Buffer ?
+ Buffer.concat(chunks) :
+ chunks.join('');
+ }
+
+ #decodeBlobStringWithLength(length, type, chunk) {
+ return this.#decodeStringWithLength(length, 2, type, chunk);
+ }
+
+ #decodeVerbatimString(type, chunk) {
+ return this.#continueDecodeVerbatimStringLength(
+ this.#decodeUnsingedNumber.bind(this, 0),
+ type,
+ chunk
+ );
+ }
+
+ #continueDecodeVerbatimStringLength(lengthCb, type, chunk) {
+ const length = lengthCb(chunk);
+ return typeof length === 'function' ?
+ this.#continueDecodeVerbatimStringLength.bind(this, length, type) :
+ this.#decodeVerbatimStringWithLength(length, type, chunk);
+ }
+
+ #decodeVerbatimStringWithLength(length, type, chunk) {
+ const stringLength = length - 4; // skip :
+ if (type === VerbatimString) {
+ return this.#decodeVerbatimStringFormat(stringLength, chunk);
+ }
+
+ this.#cursor += 4; // skip :
+ return this.#cursor >= chunk.length ?
+ this.#decodeBlobStringWithLength.bind(this, stringLength, type) :
+ this.#decodeBlobStringWithLength(stringLength, type, chunk);
+ }
+
+ #decodeVerbatimStringFormat(stringLength, chunk) {
+ const formatCb = this.#decodeStringWithLength.bind(this, 3, 1, String);
+ return this.#cursor >= chunk.length ?
+ this.#continueDecodeVerbatimStringFormat.bind(this, stringLength, formatCb) :
+ this.#continueDecodeVerbatimStringFormat(stringLength, formatCb, chunk);
+ }
+
+ #continueDecodeVerbatimStringFormat(stringLength, formatCb, chunk) {
+ const format = formatCb(chunk);
+ return typeof format === 'function' ?
+ this.#continueDecodeVerbatimStringFormat.bind(this, stringLength, format) :
+ this.#decodeVerbatimStringWithFormat(stringLength, format, chunk);
+ }
+
+ #decodeVerbatimStringWithFormat(stringLength, format, chunk) {
+ return this.#continueDecodeVerbatimStringWithFormat(
+ format,
+ this.#decodeBlobStringWithLength.bind(this, stringLength, String),
+ chunk
+ );
+ }
+
+ #continueDecodeVerbatimStringWithFormat(format, stringCb, chunk) {
+ const string = stringCb(chunk);
+ return typeof string === 'function' ?
+ this.#continueDecodeVerbatimStringWithFormat.bind(this, format, string) :
+ new VerbatimString(format, string);
+ }
+
+ #decodeSimpleError(chunk) {
+ const string = this.#decodeSimpleString(String, chunk);
+ return typeof string === 'function' ?
+ this.#continueDecodeSimpleError.bind(this, string) :
+ new SimpleError(string);
+ }
+
+ #continueDecodeSimpleError(stringCb, chunk) {
+ const string = stringCb(chunk);
+ return typeof string === 'function' ?
+ this.#continueDecodeSimpleError.bind(this, string) :
+ new SimpleError(string);
+ }
+
+ #decodeBlobError(chunk) {
+ const string = this.#decodeBlobString(String, chunk);
+ return typeof string === 'function' ?
+ this.#continueDecodeBlobError.bind(this, string) :
+ new BlobError(string);
+ }
+
+ #continueDecodeBlobError(stringCb, chunk) {
+ const string = stringCb(chunk);
+ return typeof string === 'function' ?
+ this.#continueDecodeBlobError.bind(this, string) :
+ new BlobError(string);
+ }
+
+ #decodeNestedType(typeMapping, chunk) {
+ const type = chunk[this.#cursor];
+ return ++this.#cursor === chunk.length ?
+ this.#decodeNestedTypeValue.bind(this, type, typeMapping) :
+ this.#decodeNestedTypeValue(type, typeMapping, chunk);
+ }
+
+ #decodeNestedTypeValue(type, typeMapping, chunk) {
+ switch (type) {
+ case RESP_TYPES.NULL:
+ return this.#decodeNull();
+
+ case RESP_TYPES.BOOLEAN:
+ return this.#decodeBoolean(chunk);
+
+ case RESP_TYPES.NUMBER:
+ return this.#decodeNumber(typeMapping[RESP_TYPES.NUMBER], chunk);
+
+ case RESP_TYPES.BIG_NUMBER:
+ return this.#decodeBigNumber(typeMapping[RESP_TYPES.BIG_NUMBER], chunk);
+
+ case RESP_TYPES.DOUBLE:
+ return this.#decodeDouble(typeMapping[RESP_TYPES.DOUBLE], chunk);
+
+ case RESP_TYPES.SIMPLE_STRING:
+ return this.#decodeSimpleString(typeMapping[RESP_TYPES.SIMPLE_STRING], chunk);
+
+ case RESP_TYPES.BLOB_STRING:
+ return this.#decodeBlobString(typeMapping[RESP_TYPES.BLOB_STRING], chunk);
+
+ case RESP_TYPES.VERBATIM_STRING:
+ return this.#decodeVerbatimString(typeMapping[RESP_TYPES.VERBATIM_STRING], chunk);
+
+ case RESP_TYPES.SIMPLE_ERROR:
+ return this.#decodeSimpleError(chunk);
+
+ case RESP_TYPES.BLOB_ERROR:
+ return this.#decodeBlobError(chunk);
+
+ case RESP_TYPES.ARRAY:
+ return this.#decodeArray(typeMapping, chunk);
+
+ case RESP_TYPES.SET:
+ return this.#decodeSet(typeMapping, chunk);
+
+ case RESP_TYPES.MAP:
+ return this.#decodeMap(typeMapping, chunk);
+
+ default:
+ throw new Error(`Unknown RESP type ${type} "${String.fromCharCode(type)}"`);
+ }
+ }
+
+ #decodeArray(typeMapping, chunk) {
+ // RESP 2 null
+ // https://github.com/redis/redis-specifications/blob/master/protocol/RESP2.md#resp-arrays
+ if (chunk[this.#cursor] === ASCII['-']) {
+ this.#cursor += 4; // skip -1\r\n
+ return null;
+ }
+
+ return this.#decodeArrayWithLength(
+ this.#decodeUnsingedNumber(0, chunk),
+ typeMapping,
+ chunk
+ );
+ }
+
+ #decodeArrayWithLength(length, typeMapping, chunk) {
+ return typeof length === 'function' ?
+ this.#continueDecodeArrayLength.bind(this, length, typeMapping) :
+ this.#decodeArrayItems(
+ new Array(length),
+ 0,
+ typeMapping,
+ chunk
+ );
+ }
+
+ #continueDecodeArrayLength(lengthCb, typeMapping, chunk) {
+ return this.#decodeArrayWithLength(
+ lengthCb(chunk),
+ typeMapping,
+ chunk
+ );
+ }
+
+ #decodeArrayItems(array, filled, typeMapping, chunk) {
+ for (let i = filled; i < array.length; i++) {
+ if (this.#cursor >= chunk.length) {
+ return this.#decodeArrayItems.bind(
+ this,
+ array,
+ i,
+ typeMapping
+ );
+ }
+
+ const item = this.#decodeNestedType(typeMapping, chunk);
+ if (typeof item === 'function') {
+ return this.#continueDecodeArrayItems.bind(
+ this,
+ array,
+ i,
+ item,
+ typeMapping
+ );
+ }
+
+ array[i] = item;
+ }
+
+ return array;
+ }
+
+ #continueDecodeArrayItems(array, filled, itemCb, typeMapping, chunk) {
+ const item = itemCb(chunk);
+ if (typeof item === 'function') {
+ return this.#continueDecodeArrayItems.bind(
+ this,
+ array,
+ filled,
+ item,
+ typeMapping
+ );
+ }
+
+ array[filled++] = item;
+
+ return this.#decodeArrayItems(array, filled, typeMapping, chunk);
+ }
+
+ #decodeSet(typeMapping, chunk) {
+ const length = this.#decodeUnsingedNumber(0, chunk);
+ if (typeof length === 'function') {
+ return this.#continueDecodeSetLength.bind(this, length, typeMapping);
+ }
+
+ return this.#decodeSetItems(
+ length,
+ typeMapping,
+ chunk
+ );
+ }
+
+ #continueDecodeSetLength(lengthCb, typeMapping, chunk) {
+ const length = lengthCb(chunk);
+ return typeof length === 'function' ?
+ this.#continueDecodeSetLength.bind(this, length, typeMapping) :
+ this.#decodeSetItems(length, typeMapping, chunk);
+ }
+
+ #decodeSetItems(length, typeMapping, chunk) {
+ return typeMapping[RESP_TYPES.SET] === Set ?
+ this.#decodeSetAsSet(
+ new Set(),
+ length,
+ typeMapping,
+ chunk
+ ) :
+ this.#decodeArrayItems(
+ new Array(length),
+ 0,
+ typeMapping,
+ chunk
+ );
+ }
+
+ #decodeSetAsSet(set, remaining, typeMapping, chunk) {
+ // using `remaining` instead of `length` & `set.size` to make it work even if the set contains duplicates
+ while (remaining > 0) {
+ if (this.#cursor >= chunk.length) {
+ return this.#decodeSetAsSet.bind(
+ this,
+ set,
+ remaining,
+ typeMapping
+ );
+ }
+
+ const item = this.#decodeNestedType(typeMapping, chunk);
+ if (typeof item === 'function') {
+ return this.#continueDecodeSetAsSet.bind(
+ this,
+ set,
+ remaining,
+ item,
+ typeMapping
+ );
+ }
+
+ set.add(item);
+ --remaining;
+ }
+
+ return set;
+ }
+
+ #continueDecodeSetAsSet(set, remaining, itemCb, typeMapping, chunk) {
+ const item = itemCb(chunk);
+ if (typeof item === 'function') {
+ return this.#continueDecodeSetAsSet.bind(
+ this,
+ set,
+ remaining,
+ item,
+ typeMapping
+ );
+ }
+
+ set.add(item);
+
+ return this.#decodeSetAsSet(set, remaining - 1, typeMapping, chunk);
+ }
+
+ #decodeMap(typeMapping, chunk) {
+ const length = this.#decodeUnsingedNumber(0, chunk);
+ if (typeof length === 'function') {
+ return this.#continueDecodeMapLength.bind(this, length, typeMapping);
+ }
+
+ return this.#decodeMapItems(
+ length,
+ typeMapping,
+ chunk
+ );
+ }
+
+ #continueDecodeMapLength(lengthCb, typeMapping, chunk) {
+ const length = lengthCb(chunk);
+ return typeof length === 'function' ?
+ this.#continueDecodeMapLength.bind(this, length, typeMapping) :
+ this.#decodeMapItems(length, typeMapping, chunk);
+ }
+
+ #decodeMapItems(length, typeMapping, chunk) {
+ switch (typeMapping[RESP_TYPES.MAP]) {
+ case Map:
+ return this.#decodeMapAsMap(
+ new Map(),
+ length,
+ typeMapping,
+ chunk
+ );
+
+ case Array:
+ return this.#decodeArrayItems(
+ new Array(length * 2),
+ 0,
+ typeMapping,
+ chunk
+ );
+
+ default:
+ return this.#decodeMapAsObject(
+ Object.create(null),
+ length,
+ typeMapping,
+ chunk
+ );
+ }
+ }
+
+ #decodeMapAsMap(map, remaining, typeMapping, chunk) {
+ // using `remaining` instead of `length` & `map.size` to make it work even if the map contains duplicate keys
+ while (remaining > 0) {
+ if (this.#cursor >= chunk.length) {
+ return this.#decodeMapAsMap.bind(
+ this,
+ map,
+ remaining,
+ typeMapping
+ );
+ }
+
+ const key = this.#decodeMapKey(typeMapping, chunk);
+ if (typeof key === 'function') {
+ return this.#continueDecodeMapKey.bind(
+ this,
+ map,
+ remaining,
+ key,
+ typeMapping
+ );
+ }
+
+ if (this.#cursor >= chunk.length) {
+ return this.#continueDecodeMapValue.bind(
+ this,
+ map,
+ remaining,
+ key,
+ this.#decodeNestedType.bind(this, typeMapping),
+ typeMapping
+ );
+ }
+
+ const value = this.#decodeNestedType(typeMapping, chunk);
+ if (typeof value === 'function') {
+ return this.#continueDecodeMapValue.bind(
+ this,
+ map,
+ remaining,
+ key,
+ value,
+ typeMapping
+ );
+ }
+
+ map.set(key, value);
+ --remaining;
+ }
+
+ return map;
+ }
+
+ #decodeMapKey(typeMapping, chunk) {
+ const type = chunk[this.#cursor];
+ return ++this.#cursor === chunk.length ?
+ this.#decodeMapKeyValue.bind(this, type, typeMapping) :
+ this.#decodeMapKeyValue(type, typeMapping, chunk);
+ }
+
+ #decodeMapKeyValue(type, typeMapping, chunk) {
+ switch (type) {
+ // decode simple string map key as string (and not as buffer)
+ case RESP_TYPES.SIMPLE_STRING:
+ return this.#decodeSimpleString(String, chunk);
+
+ // decode blob string map key as string (and not as buffer)
+ case RESP_TYPES.BLOB_STRING:
+ return this.#decodeBlobString(String, chunk);
+
+ default:
+ return this.#decodeNestedTypeValue(type, typeMapping, chunk);
+ }
+ }
+
+ #continueDecodeMapKey(map, remaining, keyCb, typeMapping, chunk) {
+ const key = keyCb(chunk);
+ if (typeof key === 'function') {
+ return this.#continueDecodeMapKey.bind(
+ this,
+ map,
+ remaining,
+ key,
+ typeMapping
+ );
+ }
+
+ if (this.#cursor >= chunk.length) {
+ return this.#continueDecodeMapValue.bind(
+ this,
+ map,
+ remaining,
+ key,
+ this.#decodeNestedType.bind(this, typeMapping),
+ typeMapping
+ );
+ }
+
+ const value = this.#decodeNestedType(typeMapping, chunk);
+ if (typeof value === 'function') {
+ return this.#continueDecodeMapValue.bind(
+ this,
+ map,
+ remaining,
+ key,
+ value,
+ typeMapping
+ );
+ }
+
+ map.set(key, value);
+ return this.#decodeMapAsMap(map, remaining - 1, typeMapping, chunk);
+ }
+
+ #continueDecodeMapValue(map, remaining, key, valueCb, typeMapping, chunk) {
+ const value = valueCb(chunk);
+ if (typeof value === 'function') {
+ return this.#continueDecodeMapValue.bind(
+ this,
+ map,
+ remaining,
+ key,
+ value,
+ typeMapping
+ );
+ }
+
+ map.set(key, value);
+
+ return this.#decodeMapAsMap(map, remaining - 1, typeMapping, chunk);
+ }
+
+ #decodeMapAsObject(object, remaining, typeMapping, chunk) {
+ while (remaining > 0) {
+ if (this.#cursor >= chunk.length) {
+ return this.#decodeMapAsObject.bind(
+ this,
+ object,
+ remaining,
+ typeMapping
+ );
+ }
+
+ const key = this.#decodeMapKey(typeMapping, chunk);
+ if (typeof key === 'function') {
+ return this.#continueDecodeMapAsObjectKey.bind(
+ this,
+ object,
+ remaining,
+ key,
+ typeMapping
+ );
+ }
+
+ if (this.#cursor >= chunk.length) {
+ return this.#continueDecodeMapAsObjectValue.bind(
+ this,
+ object,
+ remaining,
+ key,
+ this.#decodeNestedType.bind(this, typeMapping),
+ typeMapping
+ );
+ }
+
+ const value = this.#decodeNestedType(typeMapping, chunk);
+ if (typeof value === 'function') {
+ return this.#continueDecodeMapAsObjectValue.bind(
+ this,
+ object,
+ remaining,
+ key,
+ value,
+ typeMapping
+ );
+ }
+
+ object[key] = value;
+ --remaining;
+ }
+
+ return object;
+ }
+
+ #continueDecodeMapAsObjectKey(object, remaining, keyCb, typeMapping, chunk) {
+ const key = keyCb(chunk);
+ if (typeof key === 'function') {
+ return this.#continueDecodeMapAsObjectKey.bind(
+ this,
+ object,
+ remaining,
+ key,
+ typeMapping
+ );
+ }
+
+ if (this.#cursor >= chunk.length) {
+ return this.#continueDecodeMapAsObjectValue.bind(
+ this,
+ object,
+ remaining,
+ key,
+ this.#decodeNestedType.bind(this, typeMapping),
+ typeMapping
+ );
+ }
+
+ const value = this.#decodeNestedType(typeMapping, chunk);
+ if (typeof value === 'function') {
+ return this.#continueDecodeMapAsObjectValue.bind(
+ this,
+ object,
+ remaining,
+ key,
+ value,
+ typeMapping
+ );
+ }
+
+ object[key] = value;
+
+ return this.#decodeMapAsObject(object, remaining - 1, typeMapping, chunk);
+ }
+
+ #continueDecodeMapAsObjectValue(object, remaining, key, valueCb, typeMapping, chunk) {
+ const value = valueCb(chunk);
+ if (typeof value === 'function') {
+ return this.#continueDecodeMapAsObjectValue.bind(
+ this,
+ object,
+ remaining,
+ key,
+ value,
+ typeMapping
+ );
+ }
+
+ object[key] = value;
+
+ return this.#decodeMapAsObject(object, remaining - 1, typeMapping, chunk);
+ }
+}
diff --git a/packages/client/lib/RESP/encoder.spec.ts b/packages/client/lib/RESP/encoder.spec.ts
new file mode 100644
index 00000000000..2cbdc7d0b24
--- /dev/null
+++ b/packages/client/lib/RESP/encoder.spec.ts
@@ -0,0 +1,33 @@
+import { strict as assert } from 'node:assert';
+import { describe } from 'mocha';
+import encodeCommand from './encoder';
+
+describe('RESP Encoder', () => {
+ it('1 byte', () => {
+ assert.deepEqual(
+ encodeCommand(['a', 'z']),
+ ['*2\r\n$1\r\na\r\n$1\r\nz\r\n']
+ );
+ });
+
+ it('2 bytes', () => {
+ assert.deepEqual(
+ encodeCommand(['Χ', 'Χͺ']),
+ ['*2\r\n$2\r\nΧ\r\n$2\r\nΧͺ\r\n']
+ );
+ });
+
+ it('4 bytes', () => {
+ assert.deepEqual(
+ [...encodeCommand(['π£', 'π€'])],
+ ['*2\r\n$4\r\nπ£\r\n$4\r\nπ€\r\n']
+ );
+ });
+
+ it('buffer', () => {
+ assert.deepEqual(
+ encodeCommand([Buffer.from('string')]),
+ ['*1\r\n$6\r\n', Buffer.from('string'), '\r\n']
+ );
+ });
+});
diff --git a/packages/client/lib/RESP/encoder.ts b/packages/client/lib/RESP/encoder.ts
new file mode 100644
index 00000000000..995650627f1
--- /dev/null
+++ b/packages/client/lib/RESP/encoder.ts
@@ -0,0 +1,28 @@
+import { RedisArgument } from './types';
+
+const CRLF = '\r\n';
+
+export default function encodeCommand(args: ReadonlyArray): ReadonlyArray {
+ const toWrite: Array = [];
+
+ let strings = '*' + args.length + CRLF;
+
+ for (let i = 0; i < args.length; i++) {
+ const arg = args[i];
+ if (typeof arg === 'string') {
+ strings += '$' + Buffer.byteLength(arg) + CRLF + arg + CRLF;
+ } else if (arg instanceof Buffer) {
+ toWrite.push(
+ strings + '$' + arg.length.toString() + CRLF,
+ arg
+ );
+ strings = CRLF;
+ } else {
+ throw new TypeError(`"arguments[${i}]" must be of type "string | Buffer", got ${typeof arg} instead.`);
+ }
+ }
+
+ toWrite.push(strings);
+
+ return toWrite;
+}
diff --git a/packages/client/lib/RESP/types.ts b/packages/client/lib/RESP/types.ts
new file mode 100644
index 00000000000..8749bbdc7b0
--- /dev/null
+++ b/packages/client/lib/RESP/types.ts
@@ -0,0 +1,407 @@
+import { CommandParser } from '../client/parser';
+import { Tail } from '../commands/generic-transformers';
+import { BlobError, SimpleError } from '../errors';
+import { RedisScriptConfig, SHA1 } from '../lua-script';
+import { RESP_TYPES } from './decoder';
+import { VerbatimString } from './verbatim-string';
+
+export type RESP_TYPES = typeof RESP_TYPES;
+
+export type RespTypes = RESP_TYPES[keyof RESP_TYPES];
+
+// using interface(s) to allow circular references
+// type X = BlobStringReply | ArrayReply;
+
+export interface RespType<
+ RESP_TYPE extends RespTypes,
+ DEFAULT,
+ TYPES = never,
+ TYPE_MAPPING = DEFAULT | TYPES
+> {
+ RESP_TYPE: RESP_TYPE;
+ DEFAULT: DEFAULT;
+ TYPES: TYPES;
+ TYPE_MAPPING: MappedType;
+}
+
+export interface NullReply extends RespType<
+ RESP_TYPES['NULL'],
+ null
+> {}
+
+export interface BooleanReply<
+ T extends boolean = boolean
+> extends RespType<
+ RESP_TYPES['BOOLEAN'],
+ T
+> {}
+
+export interface NumberReply<
+ T extends number = number
+> extends RespType<
+ RESP_TYPES['NUMBER'],
+ T,
+ `${T}`,
+ number | string
+> {}
+
+export interface BigNumberReply<
+ T extends bigint = bigint
+> extends RespType<
+ RESP_TYPES['BIG_NUMBER'],
+ T,
+ number | `${T}`,
+ bigint | number | string
+> {}
+
+export interface DoubleReply<
+ T extends number = number
+> extends RespType<
+ RESP_TYPES['DOUBLE'],
+ T,
+ `${T}`,
+ number | string
+> {}
+
+export interface SimpleStringReply<
+ T extends string = string
+> extends RespType<
+ RESP_TYPES['SIMPLE_STRING'],
+ T,
+ Buffer,
+ string | Buffer
+> {}
+
+export interface BlobStringReply<
+ T extends string = string
+> extends RespType<
+ RESP_TYPES['BLOB_STRING'],
+ T,
+ Buffer,
+ string | Buffer
+> {
+ toString(): string
+}
+
+export interface VerbatimStringReply<
+ T extends string = string
+> extends RespType<
+ RESP_TYPES['VERBATIM_STRING'],
+ T,
+ Buffer | VerbatimString,
+ string | Buffer | VerbatimString
+> {}
+
+export interface SimpleErrorReply extends RespType<
+ RESP_TYPES['SIMPLE_ERROR'],
+ SimpleError,
+ Buffer
+> {}
+
+export interface BlobErrorReply extends RespType<
+ RESP_TYPES['BLOB_ERROR'],
+ BlobError,
+ Buffer
+> {}
+
+export interface ArrayReply extends RespType<
+ RESP_TYPES['ARRAY'],
+ Array,
+ never,
+ Array
+> {}
+
+export interface TuplesReply]> extends RespType<
+ RESP_TYPES['ARRAY'],
+ T,
+ never,
+ Array
+> {}
+
+export interface SetReply extends RespType<
+ RESP_TYPES['SET'],
+ Array,
+ Set,
+ Array | Set
+> {}
+
+export interface MapReply extends RespType<
+ RESP_TYPES['MAP'],
+ { [key: string]: V },
+ Map | Array,
+ Map | Array
+> {}
+
+type MapKeyValue = [key: BlobStringReply | SimpleStringReply, value: unknown];
+
+type MapTuples = Array;
+
+type ExtractMapKey = (
+ T extends BlobStringReply ? S :
+ T extends SimpleStringReply ? S :
+ never
+);
+
+export interface TuplesToMapReply extends RespType<
+ RESP_TYPES['MAP'],
+ {
+ [P in T[number] as ExtractMapKey]: P[1];
+ },
+ Map, T[number][1]> | FlattenTuples
+> {}
+
+type FlattenTuples = (
+ T extends [] ? [] :
+ T extends [MapKeyValue] ? T[0] :
+ T extends [MapKeyValue, ...infer R] ? [
+ ...T[0],
+ ...FlattenTuples
+ ] :
+ never
+);
+
+export type ReplyUnion = (
+ NullReply |
+ BooleanReply |
+ NumberReply |
+ BigNumberReply |
+ DoubleReply |
+ SimpleStringReply |
+ BlobStringReply |
+ VerbatimStringReply |
+ SimpleErrorReply |
+ BlobErrorReply |
+ ArrayReply |
+ SetReply |
+ MapReply
+);
+
+export type MappedType = ((...args: any) => T) | (new (...args: any) => T);
+
+type InferTypeMapping = T extends RespType ? FLAG_TYPES : never;
+
+export type TypeMapping = {
+ [P in RespTypes]?: MappedType>>>;
+};
+
+type MapKey<
+ T,
+ TYPE_MAPPING extends TypeMapping
+> = ReplyWithTypeMapping;
+
+export type UnwrapReply> = REPLY['DEFAULT' | 'TYPES'];
+
+export type ReplyWithTypeMapping<
+ REPLY,
+ TYPE_MAPPING extends TypeMapping
+> = (
+ // if REPLY is a type, extract the coresponding type from TYPE_MAPPING or use the default type
+ REPLY extends RespType ?
+ TYPE_MAPPING[RESP_TYPE] extends MappedType ?
+ ReplyWithTypeMapping, TYPE_MAPPING> :
+ ReplyWithTypeMapping
+ : (
+ // if REPLY is a known generic type, convert its generic arguments
+ // TODO: tuples?
+ REPLY extends Array ? Array> :
+ REPLY extends Set ? Set> :
+ REPLY extends Map ? Map, ReplyWithTypeMapping> :
+ // `Date | Buffer | Error` are supersets of `Record`, so they need to be checked first
+ REPLY extends Date | Buffer | Error ? REPLY :
+ REPLY extends Record ? {
+ [P in keyof REPLY]: ReplyWithTypeMapping;
+ } :
+ // otherwise, just return the REPLY as is
+ REPLY
+ )
+);
+
+export type TransformReply = (this: void, reply: any, preserve?: any, typeMapping?: TypeMapping) => any; // TODO;
+
+export type RedisArgument = string | Buffer;
+
+export type CommandArguments = Array & { preserve?: unknown };
+
+// export const REQUEST_POLICIES = {
+// /**
+// * TODO
+// */
+// ALL_NODES: 'all_nodes',
+// /**
+// * TODO
+// */
+// ALL_SHARDS: 'all_shards',
+// /**
+// * TODO
+// */
+// SPECIAL: 'special'
+// } as const;
+
+// export type REQUEST_POLICIES = typeof REQUEST_POLICIES;
+
+// export type RequestPolicies = REQUEST_POLICIES[keyof REQUEST_POLICIES];
+
+// export const RESPONSE_POLICIES = {
+// /**
+// * TODO
+// */
+// ONE_SUCCEEDED: 'one_succeeded',
+// /**
+// * TODO
+// */
+// ALL_SUCCEEDED: 'all_succeeded',
+// /**
+// * TODO
+// */
+// LOGICAL_AND: 'agg_logical_and',
+// /**
+// * TODO
+// */
+// SPECIAL: 'special'
+// } as const;
+
+// export type RESPONSE_POLICIES = typeof RESPONSE_POLICIES;
+
+// export type ResponsePolicies = RESPONSE_POLICIES[keyof RESPONSE_POLICIES];
+
+// export type CommandPolicies = {
+// request?: RequestPolicies | null;
+// response?: ResponsePolicies | null;
+// };
+
+export type Command = {
+ CACHEABLE?: boolean;
+ IS_READ_ONLY?: boolean;
+ /**
+ * @internal
+ * TODO: remove once `POLICIES` is implemented
+ */
+ IS_FORWARD_COMMAND?: boolean;
+ NOT_KEYED_COMMAND?: true;
+ // POLICIES?: CommandPolicies;
+ parseCommand(this: void, parser: CommandParser, ...args: Array): void;
+ TRANSFORM_LEGACY_REPLY?: boolean;
+ transformReply: TransformReply | Record;
+ unstableResp3?: boolean;
+};
+
+export type RedisCommands = Record;
+
+export type RedisModules = Record;
+
+export interface RedisFunction extends Command {
+ NUMBER_OF_KEYS?: number;
+}
+
+export type RedisFunctions = Record>;
+
+export type RedisScript = RedisScriptConfig & SHA1;
+
+export type RedisScripts = Record;
+
+// TODO: move to Commander?
+export interface CommanderConfig<
+ M extends RedisModules,
+ F extends RedisFunctions,
+ S extends RedisScripts,
+ RESP extends RespVersions
+> {
+ modules?: M;
+ functions?: F;
+ scripts?: S;
+ /**
+ * Specifies the Redis Serialization Protocol version to use.
+ * RESP2 is the default (value 2), while RESP3 (value 3) provides
+ * additional data types and features introduced in Redis 6.0.
+ */
+ RESP?: RESP;
+ /**
+ * When set to true, enables commands that have unstable RESP3 implementations.
+ * When using RESP3 protocol, commands marked as having unstable RESP3 support
+ * will throw an error unless this flag is explicitly set to true.
+ * This primarily affects modules like Redis Search where response formats
+ * in RESP3 mode may change in future versions.
+ */
+ unstableResp3?: boolean;
+}
+
+type Resp2Array = (
+ T extends [] ? [] :
+ T extends [infer ITEM] ? [Resp2Reply- ] :
+ T extends [infer ITEM, ...infer REST] ? [
+ Resp2Reply
- ,
+ ...Resp2Array
+ ] :
+ T extends Array ? Array> :
+ never
+);
+
+export type Resp2Reply = (
+ RESP3REPLY extends RespType ?
+ // TODO: RESP3 only scalar types
+ RESP_TYPE extends RESP_TYPES['DOUBLE'] ? BlobStringReply :
+ RESP_TYPE extends RESP_TYPES['ARRAY'] | RESP_TYPES['SET'] ? RespType<
+ RESP_TYPE,
+ Resp2Array
+ > :
+ RESP_TYPE extends RESP_TYPES['MAP'] ? RespType<
+ RESP_TYPES['ARRAY'],
+ Resp2Array>>
+ > :
+ RESP3REPLY :
+ RESP3REPLY
+);
+
+export type RespVersions = 2 | 3;
+
+export type CommandReply<
+ COMMAND extends Command,
+ RESP extends RespVersions
+> = (
+ // if transformReply is a function, use its return type
+ COMMAND['transformReply'] extends (...args: any) => infer T ? T :
+ // if transformReply[RESP] is a function, use its return type
+ COMMAND['transformReply'] extends Record infer T> ? T :
+ // otherwise use the generic reply type
+ ReplyUnion
+);
+
+export type CommandSignature<
+ COMMAND extends Command,
+ RESP extends RespVersions,
+ TYPE_MAPPING extends TypeMapping
+> = (...args: Tail>) => Promise, TYPE_MAPPING>>;
+
+// export type CommandWithPoliciesSignature<
+// COMMAND extends Command,
+// RESP extends RespVersions,
+// TYPE_MAPPING extends TypeMapping,
+// POLICIES extends CommandPolicies
+// > = (...args: Parameters) => Promise<
+// ReplyWithPolicy<
+// ReplyWithTypeMapping, TYPE_MAPPING>,
+// MergePolicies
+// >
+// >;
+
+// export type MergePolicies<
+// COMMAND extends Command,
+// POLICIES extends CommandPolicies
+// > = Omit & POLICIES;
+
+// type ReplyWithPolicy<
+// REPLY,
+// POLICIES extends CommandPolicies,
+// > = (
+// POLICIES['request'] extends REQUEST_POLICIES['SPECIAL'] ? never :
+// POLICIES['request'] extends null | undefined ? REPLY :
+// unknown extends POLICIES['request'] ? REPLY :
+// POLICIES['response'] extends RESPONSE_POLICIES['SPECIAL'] ? never :
+// POLICIES['response'] extends RESPONSE_POLICIES['ALL_SUCCEEDED' | 'ONE_SUCCEEDED' | 'LOGICAL_AND'] ? REPLY :
+// // otherwise, return array of replies
+// Array
+// );
diff --git a/packages/client/lib/RESP/verbatim-string.ts b/packages/client/lib/RESP/verbatim-string.ts
new file mode 100644
index 00000000000..92ff4fe3fb1
--- /dev/null
+++ b/packages/client/lib/RESP/verbatim-string.ts
@@ -0,0 +1,8 @@
+export class VerbatimString extends String {
+ constructor(
+ public format: string,
+ value: string
+ ) {
+ super(value);
+ }
+}
diff --git a/packages/client/lib/authx/credentials-provider.ts b/packages/client/lib/authx/credentials-provider.ts
new file mode 100644
index 00000000000..667795be9b3
--- /dev/null
+++ b/packages/client/lib/authx/credentials-provider.ts
@@ -0,0 +1,102 @@
+import { Disposable } from './disposable';
+/**
+ * Provides credentials asynchronously.
+ */
+export interface AsyncCredentialsProvider {
+ readonly type: 'async-credentials-provider';
+ credentials: () => Promise
+}
+
+/**
+ * Provides credentials asynchronously with support for continuous updates via a subscription model.
+ * This is useful for environments where credentials are frequently rotated or updated or can be revoked.
+ */
+export interface StreamingCredentialsProvider {
+ readonly type: 'streaming-credentials-provider';
+
+ /**
+ * Provides initial credentials and subscribes to subsequent updates. This is used internally by the node-redis client
+ * to handle credential rotation and re-authentication.
+ *
+ * Note: The node-redis client manages the subscription lifecycle automatically. Users only need to implement
+ * onReAuthenticationError if they want to be notified about authentication failures.
+ *
+ * Error handling:
+ * - Errors received via onError indicate a fatal issue with the credentials stream
+ * - The stream is automatically closed(disposed) when onError occurs
+ * - onError typically mean the provider failed to fetch new credentials after retrying
+ *
+ * @example
+ * ```ts
+ * const provider = getStreamingProvider();
+ * const [initialCredentials, disposable] = await provider.subscribe({
+ * onNext: (newCredentials) => {
+ * // Handle credential update
+ * },
+ * onError: (error) => {
+ * // Handle fatal stream error
+ * }
+ * });
+ *
+ * @param listener - Callbacks to handle credential updates and errors
+ * @returns A Promise resolving to [initial credentials, cleanup function]
+ */
+ subscribe: (listener: StreamingCredentialsListener) => Promise<[BasicAuth, Disposable]>
+
+ /**
+ * Called when authentication fails or credentials cannot be renewed in time.
+ * Implement this to handle authentication errors in your application.
+ *
+ * @param error - Either a CredentialsError (invalid/expired credentials) or
+ * UnableToObtainNewCredentialsError (failed to fetch new credentials on time)
+ */
+ onReAuthenticationError: (error: ReAuthenticationError) => void;
+
+}
+
+/**
+ * Type representing basic authentication credentials.
+ */
+export type BasicAuth = { username?: string, password?: string }
+
+/**
+ * Callback to handle credential updates and errors.
+ */
+export type StreamingCredentialsListener = {
+ onNext: (credentials: T) => void;
+ onError: (e: Error) => void;
+}
+
+
+/**
+ * Providers that can supply authentication credentials
+ */
+export type CredentialsProvider = AsyncCredentialsProvider | StreamingCredentialsProvider
+
+/**
+ * Errors that can occur during re-authentication.
+ */
+export type ReAuthenticationError = CredentialsError | UnableToObtainNewCredentialsError
+
+/**
+ * Thrown when re-authentication fails with provided credentials .
+ * e.g. when the credentials are invalid, expired or revoked.
+ *
+ */
+export class CredentialsError extends Error {
+ constructor(message: string) {
+ super(`Re-authentication with latest credentials failed: ${message}`);
+ this.name = 'CredentialsError';
+ }
+
+}
+
+/**
+ * Thrown when new credentials cannot be obtained before current ones expire
+ */
+export class UnableToObtainNewCredentialsError extends Error {
+ constructor(message: string) {
+ super(`Unable to obtain new credentials : ${message}`);
+ this.name = 'UnableToObtainNewCredentialsError';
+ }
+}
\ No newline at end of file
diff --git a/packages/client/lib/authx/disposable.ts b/packages/client/lib/authx/disposable.ts
new file mode 100644
index 00000000000..ee4526a37bd
--- /dev/null
+++ b/packages/client/lib/authx/disposable.ts
@@ -0,0 +1,6 @@
+/**
+ * Represents a resource that can be disposed.
+ */
+export interface Disposable {
+ dispose(): void;
+}
\ No newline at end of file
diff --git a/packages/client/lib/authx/identity-provider.ts b/packages/client/lib/authx/identity-provider.ts
new file mode 100644
index 00000000000..a2d25c8f9db
--- /dev/null
+++ b/packages/client/lib/authx/identity-provider.ts
@@ -0,0 +1,22 @@
+/**
+ * An identity provider is responsible for providing a token that can be used to authenticate with a service.
+ */
+
+/**
+ * The response from an identity provider when requesting a token.
+ *
+ * note: "native" refers to the type of the token that the actual identity provider library is using.
+ *
+ * @type T The type of the native idp token.
+ * @property token The token.
+ * @property ttlMs The time-to-live of the token in epoch milliseconds extracted from the native token in local time.
+ */
+export type TokenResponse = { token: T, ttlMs: number };
+
+export interface IdentityProvider {
+ /**
+ * Request a token from the identity provider.
+ * @returns A promise that resolves to an object containing the token and the time-to-live in epoch milliseconds.
+ */
+ requestToken(): Promise>;
+}
\ No newline at end of file
diff --git a/packages/client/lib/authx/index.ts b/packages/client/lib/authx/index.ts
new file mode 100644
index 00000000000..ce611e1497f
--- /dev/null
+++ b/packages/client/lib/authx/index.ts
@@ -0,0 +1,15 @@
+export { TokenManager, TokenManagerConfig, TokenStreamListener, RetryPolicy, IDPError } from './token-manager';
+export {
+ CredentialsProvider,
+ StreamingCredentialsProvider,
+ UnableToObtainNewCredentialsError,
+ CredentialsError,
+ StreamingCredentialsListener,
+ AsyncCredentialsProvider,
+ ReAuthenticationError,
+ BasicAuth
+} from './credentials-provider';
+export { Token } from './token';
+export { IdentityProvider, TokenResponse } from './identity-provider';
+
+export { Disposable } from './disposable'
\ No newline at end of file
diff --git a/packages/client/lib/authx/token-manager.spec.ts b/packages/client/lib/authx/token-manager.spec.ts
new file mode 100644
index 00000000000..1cc2a207edc
--- /dev/null
+++ b/packages/client/lib/authx/token-manager.spec.ts
@@ -0,0 +1,588 @@
+import { strict as assert } from 'node:assert';
+import { Token } from './token';
+import { IDPError, RetryPolicy, TokenManager, TokenManagerConfig, TokenStreamListener } from './token-manager';
+import { IdentityProvider, TokenResponse } from './identity-provider';
+import { setTimeout } from 'timers/promises';
+
+describe('TokenManager', () => {
+
+ /**
+ * Helper function to delay execution for a given number of milliseconds.
+ * @param ms
+ */
+ const delay = (ms: number) => {
+ return setTimeout(ms);
+ }
+
+ /**
+ * IdentityProvider that returns a fixed test token for testing and doesn't handle TTL.
+ */
+ class TestIdentityProvider implements IdentityProvider {
+ requestToken(): Promise> {
+ return Promise.resolve({ token: 'test-token 1', ttlMs: 1000 });
+ }
+ }
+
+ /**
+ * Helper function to create a test token with a given TTL .
+ * @param ttlMs Time-to-live in milliseconds
+ */
+ const createToken = (ttlMs: number): Token => {
+ return new Token('test-token', ttlMs, 0);
+ };
+
+ /**
+ * Listener that records received tokens and errors for testing.
+ */
+ class TestListener implements TokenStreamListener {
+
+ public readonly receivedTokens: Token[] = [];
+ public readonly errors: IDPError[] = [];
+
+ onNext(token: Token): void {
+ this.receivedTokens.push(token);
+ }
+
+ onError(error: IDPError): void {
+ this.errors.push(error);
+ }
+ }
+
+ /**
+ * IdentityProvider that returns a sequence of tokens with a fixed delay simulating network latency.
+ * Used for testing token refresh scenarios.
+ */
+ class ControlledIdentityProvider implements IdentityProvider {
+ private tokenIndex = 0;
+ private readonly delayMs: number;
+ private readonly ttlMs: number;
+
+ constructor(
+ private readonly tokens: string[],
+ delayMs: number = 0,
+ tokenTTlMs: number = 100
+ ) {
+ this.delayMs = delayMs;
+ this.ttlMs = tokenTTlMs;
+ }
+
+ async requestToken(): Promise> {
+
+ if (this.tokenIndex >= this.tokens.length) {
+ throw new Error('No more test tokens available');
+ }
+
+ if (this.delayMs > 0) {
+ await setTimeout(this.delayMs);
+ }
+
+ return { token: this.tokens[this.tokenIndex++], ttlMs: this.ttlMs };
+ }
+
+ }
+
+ /**
+ * IdentityProvider that simulates various error scenarios with configurable behavior
+ */
+ class ErrorSimulatingProvider implements IdentityProvider {
+ private requestCount = 0;
+
+ constructor(
+ private readonly errorSequence: Array,
+ private readonly delayMs: number = 0,
+ private readonly ttlMs: number = 100
+ ) {}
+
+ async requestToken(): Promise> {
+
+ if (this.delayMs > 0) {
+ await delay(this.delayMs);
+ }
+
+ const result = this.errorSequence[this.requestCount];
+ this.requestCount++;
+
+ if (result instanceof Error) {
+ throw result;
+ } else if (typeof result === 'string') {
+ return { token: result, ttlMs: this.ttlMs };
+ } else {
+ throw new Error('No more responses configured');
+ }
+ }
+
+ getRequestCount(): number {
+ return this.requestCount;
+ }
+ }
+
+ describe('constructor validation', () => {
+ it('should throw error if ratio is greater than 1', () => {
+ const config: TokenManagerConfig = {
+ expirationRefreshRatio: 1.1
+ };
+
+ assert.throws(
+ () => new TokenManager(new TestIdentityProvider(), config),
+ /expirationRefreshRatio must be less than or equal to 1/
+ );
+ });
+
+ it('should throw error if ratio is negative', () => {
+ const config: TokenManagerConfig = {
+ expirationRefreshRatio: -0.1
+ };
+
+ assert.throws(
+ () => new TokenManager(new TestIdentityProvider(), config),
+ /expirationRefreshRatio must be greater or equal to 0/
+ );
+ });
+
+ it('should accept ratio of 1', () => {
+ const config: TokenManagerConfig = {
+ expirationRefreshRatio: 1
+ };
+
+ assert.doesNotThrow(
+ () => new TokenManager(new TestIdentityProvider(), config)
+ );
+ });
+
+ it('should accept ratio of 0', () => {
+ const config: TokenManagerConfig = {
+ expirationRefreshRatio: 0
+ };
+
+ assert.doesNotThrow(
+ () => new TokenManager(new TestIdentityProvider(), config)
+ );
+ });
+ });
+
+ describe('calculateRefreshTime', () => {
+ it('should calculate correct refresh time with 0.8 ratio', () => {
+ const config: TokenManagerConfig = {
+ expirationRefreshRatio: 0.8
+ };
+
+ const manager = new TokenManager(new TestIdentityProvider(), config);
+ const token = createToken(1000);
+ const refreshTime = manager.calculateRefreshTime(token, 0);
+
+ // With 1000s TTL and 0.8 ratio, should refresh at 800s
+ assert.equal(refreshTime, 800);
+ });
+
+ it('should return 0 for ratio of 0', () => {
+ const config: TokenManagerConfig = {
+ expirationRefreshRatio: 0
+ };
+
+ const manager = new TokenManager(new TestIdentityProvider(), config);
+ const token = createToken(1000);
+ const refreshTime = manager.calculateRefreshTime(token, 0);
+
+ assert.equal(refreshTime, 0);
+ });
+
+ it('should refresh at expiration time with ratio of 1', () => {
+ const config: TokenManagerConfig = {
+ expirationRefreshRatio: 1
+ };
+
+ const manager = new TokenManager(new TestIdentityProvider(), config);
+ const token = createToken(1000);
+ const refreshTime = manager.calculateRefreshTime(token, 0);
+
+ assert.equal(refreshTime, 1000);
+ });
+
+ it('should handle short TTL tokens', () => {
+ const config: TokenManagerConfig = {
+ expirationRefreshRatio: 0.8
+ };
+
+ const manager = new TokenManager(new TestIdentityProvider(), config);
+ const token = createToken(5);
+ const refreshTime = manager.calculateRefreshTime(token, 0);
+
+ assert.equal(refreshTime, 4);
+ });
+
+ it('should handle expired tokens', () => {
+ const config: TokenManagerConfig = {
+ expirationRefreshRatio: 0.8
+ };
+
+ const manager = new TokenManager(new TestIdentityProvider(), config);
+ // Create token that expired 100s ago
+ const token = createToken(-100);
+ const refreshTime = manager.calculateRefreshTime(token, 0);
+
+ // Should return refresh time of 0 for expired tokens
+ assert.equal(refreshTime, 0);
+ });
+ describe('token refresh scenarios', () => {
+
+ describe('token refresh', () => {
+ it('should handle token refresh', async () => {
+ const networkDelay = 20;
+ const tokenTtl = 100;
+
+ const config: TokenManagerConfig = {
+ expirationRefreshRatio: 0.8
+ };
+
+ const identityProvider = new ControlledIdentityProvider(['token1', 'token2', 'token3'], networkDelay, tokenTtl);
+ const manager = new TokenManager(identityProvider, config);
+ const listener = new TestListener();
+ const disposable = manager.start(listener);
+
+ assert.equal(manager.getCurrentToken(), null, 'Should not have token yet');
+ // Wait for the first token request to complete ( it should be immediate, and we should wait only for the network delay)
+ await delay(networkDelay)
+
+ assert.equal(listener.receivedTokens.length, 1, 'Should receive initial token');
+ assert.equal(listener.receivedTokens[0].value, 'token1', 'Should have correct token value');
+ assert.equal(listener.receivedTokens[0].expiresAtMs - listener.receivedTokens[0].receivedAtMs,
+ tokenTtl, 'Should have correct TTL');
+ assert.equal(listener.errors.length, 0, 'Should not have any errors: ' + listener.errors);
+ assert.equal(manager.getCurrentToken().value, 'token1', 'Should have current token');
+
+ await delay(80);
+
+ assert.equal(listener.receivedTokens.length, 1, 'Should not receive new token yet');
+ assert.equal(listener.errors.length, 0, 'Should not have any errors');
+
+ await delay(networkDelay);
+
+ assert.equal(listener.receivedTokens.length, 2, 'Should receive second token');
+ assert.equal(listener.receivedTokens[1].value, 'token2', 'Should have correct token value');
+ assert.equal(listener.receivedTokens[1].expiresAtMs - listener.receivedTokens[1].receivedAtMs,
+ tokenTtl, 'Should have correct TTL');
+ assert.equal(listener.errors.length, 0, 'Should not have any errors');
+ assert.equal(manager.getCurrentToken().value, 'token2', 'Should have current token');
+
+ await delay(80);
+
+ assert.equal(listener.receivedTokens.length, 2, 'Should not receive new token yet');
+ assert.equal(listener.errors.length, 0, 'Should not have any errors');
+
+ await delay(networkDelay);
+
+ assert.equal(listener.receivedTokens.length, 3, 'Should receive third token');
+ assert.equal(listener.receivedTokens[2].value, 'token3', 'Should have correct token value');
+ assert.equal(listener.receivedTokens[2].expiresAtMs - listener.receivedTokens[2].receivedAtMs,
+ tokenTtl, 'Should have correct TTL');
+ assert.equal(listener.errors.length, 0, 'Should not have any errors');
+ assert.equal(manager.getCurrentToken().value, 'token3', 'Should have current token');
+
+ disposable?.dispose();
+ });
+ });
+ });
+ });
+
+ describe('TokenManager error handling', () => {
+
+ describe('error scenarios', () => {
+ it('should not recover if retries are not enabled', async () => {
+
+ const networkDelay = 20;
+ const tokenTtl = 100;
+
+ const config: TokenManagerConfig = {
+ expirationRefreshRatio: 0.8
+ };
+
+ const identityProvider = new ErrorSimulatingProvider(
+ [
+ 'token1',
+ new Error('Fatal error'),
+ 'token3'
+ ],
+ networkDelay,
+ tokenTtl
+ );
+
+ const manager = new TokenManager(identityProvider, config);
+ const listener = new TestListener();
+ const disposable = manager.start(listener);
+
+ await delay(networkDelay);
+
+ assert.equal(listener.receivedTokens.length, 1, 'Should receive initial token');
+ assert.equal(listener.receivedTokens[0].value, 'token1', 'Should have correct initial token');
+ assert.equal(listener.receivedTokens[0].expiresAtMs - listener.receivedTokens[0].receivedAtMs,
+ tokenTtl, 'Should have correct TTL');
+ assert.equal(listener.errors.length, 0, 'Should not have errors yet');
+
+ await delay(80);
+
+ assert.equal(listener.receivedTokens.length, 1, 'Should not receive new token yet');
+ assert.equal(listener.errors.length, 0, 'Should not have any errors');
+
+ await delay(networkDelay);
+
+ assert.equal(listener.receivedTokens.length, 1, 'Should not receive new token after failure');
+ assert.equal(listener.errors.length, 1, 'Should receive error');
+ assert.equal(listener.errors[0].message, 'Fatal error', 'Should have correct error message');
+ assert.equal(listener.errors[0].isRetryable, false, 'Should be a fatal error');
+
+ // verify that the token manager is stopped and no more requests are made after the error and expected refresh time
+ await delay(80);
+
+ assert.equal(identityProvider.getRequestCount(), 2, 'Should not make more requests after error');
+ assert.equal(listener.receivedTokens.length, 1, 'Should not receive new token after error');
+ assert.equal(listener.errors.length, 1, 'Should not receive more errors after error');
+ assert.equal(manager.isRunning(), false, 'Should stop token manager after error');
+
+ disposable?.dispose();
+ });
+
+ it('should handle retries with exponential backoff', async () => {
+ const networkDelay = 20;
+ const tokenTtl = 100;
+
+ const config: TokenManagerConfig = {
+ expirationRefreshRatio: 0.8,
+ retry: {
+ maxAttempts: 3,
+ initialDelayMs: 100,
+ maxDelayMs: 1000,
+ backoffMultiplier: 2,
+ isRetryable: (error: unknown) => error instanceof Error && error.message === 'Temporary failure'
+ }
+ };
+
+ const identityProvider = new ErrorSimulatingProvider(
+ [
+ 'initial-token',
+ new Error('Temporary failure'), // First attempt fails
+ new Error('Temporary failure'), // First retry fails
+ 'recovery-token' // Second retry succeeds
+ ],
+ networkDelay,
+ tokenTtl
+ );
+
+ const manager = new TokenManager(identityProvider, config);
+ const listener = new TestListener();
+ const disposable = manager.start(listener);
+
+ // Wait for initial token
+ await delay(networkDelay);
+ assert.equal(listener.receivedTokens.length, 1, 'Should receive initial token');
+ assert.equal(listener.receivedTokens[0].value, 'initial-token', 'Should have correct initial token');
+ assert.equal(listener.receivedTokens[0].expiresAtMs - listener.receivedTokens[0].receivedAtMs,
+ tokenTtl, 'Should have correct TTL');
+ assert.equal(listener.errors.length, 0, 'Should not have errors yet');
+
+ await delay(80);
+
+ assert.equal(listener.receivedTokens.length, 1, 'Should not receive new token yet');
+ assert.equal(listener.errors.length, 0, 'Should not have any errors');
+
+ await delay(networkDelay);
+
+ // Should have first error but not stop due to retry config
+ assert.equal(listener.errors.length, 1, 'Should have first error');
+ assert.ok(listener.errors[0].message.includes('attempt 1'), 'Error should indicate first attempt');
+ assert.equal(listener.errors[0].isRetryable, true, 'Should not be a fatal error');
+ assert.equal(manager.isRunning(), true, 'Should continue running during retries');
+
+ // Advance past first retry (delay: 100ms due to backoff)
+ await delay(100);
+
+ assert.equal(listener.errors.length, 1, 'Should not have the second error yet');
+
+ await delay(networkDelay);
+
+ assert.equal(listener.errors.length, 2, 'Should have second error');
+ assert.ok(listener.errors[1].message.includes('attempt 2'), 'Error should indicate second attempt');
+ assert.equal(listener.errors[0].isRetryable, true, 'Should not be a fatal error');
+ assert.equal(manager.isRunning(), true, 'Should continue running during retries');
+
+ // Advance past second retry (delay: 200ms due to backoff)
+ await delay(200);
+
+ assert.equal(listener.errors.length, 2, 'Should not have another error');
+ assert.equal(listener.receivedTokens.length, 1, 'Should not receive new token yet');
+
+ await delay(networkDelay);
+
+ // Should have recovered
+ assert.equal(listener.receivedTokens.length, 2, 'Should receive recovery token');
+ assert.equal(listener.receivedTokens[1].value, 'recovery-token', 'Should have correct recovery token');
+ assert.equal(listener.receivedTokens[1].expiresAtMs - listener.receivedTokens[1].receivedAtMs,
+ tokenTtl, 'Should have correct TTL');
+ assert.equal(manager.isRunning(), true, 'Should continue running after recovery');
+ assert.equal(identityProvider.getRequestCount(), 4, 'Should have made exactly 4 requests');
+
+ disposable?.dispose();
+ });
+
+ it('should stop after max retries exceeded', async () => {
+ const networkDelay = 20;
+ const tokenTtl = 100;
+
+ const config: TokenManagerConfig = {
+ expirationRefreshRatio: 0.8,
+ retry: {
+ maxAttempts: 2, // Only allow 2 retries
+ initialDelayMs: 100,
+ maxDelayMs: 1000,
+ backoffMultiplier: 2,
+ jitterPercentage: 0,
+ isRetryable: (error: unknown) => error instanceof Error && error.message === 'Temporary failure'
+ }
+ };
+
+ // All attempts must fail
+ const identityProvider = new ErrorSimulatingProvider(
+ [
+ 'initial-token',
+ new Error('Temporary failure'),
+ new Error('Temporary failure'),
+ new Error('Temporary failure')
+ ],
+ networkDelay,
+ tokenTtl
+ );
+
+ const manager = new TokenManager(identityProvider, config);
+ const listener = new TestListener();
+ const disposable = manager.start(listener);
+
+ // Wait for initial token
+ await delay(networkDelay);
+ assert.equal(listener.receivedTokens.length, 1, 'Should receive initial token');
+
+ await delay(80);
+
+ assert.equal(listener.receivedTokens.length, 1, 'Should not receive new token yet');
+ assert.equal(listener.errors.length, 0, 'Should not have any errors');
+
+ //wait for the "network call" to complete
+ await delay(networkDelay);
+
+ // First error
+ assert.equal(listener.errors.length, 1, 'Should have first error');
+ assert.equal(manager.isRunning(), true, 'Should continue running after first error');
+ assert.equal(listener.errors[0].isRetryable, true, 'Should not be a fatal error');
+
+ // Advance past first retry
+ await delay(100);
+
+ assert.equal(listener.errors.length, 1, 'Should not have second error yet');
+
+ //wait for the "network call" to complete
+ await delay(networkDelay);
+
+ // Second error
+ assert.equal(listener.errors.length, 2, 'Should have second error');
+ assert.equal(manager.isRunning(), true, 'Should continue running after second error');
+ assert.equal(listener.errors[1].isRetryable, true, 'Should not be a fatal error');
+
+ // Advance past second retry
+ await delay(200);
+
+ assert.equal(listener.errors.length, 2, 'Should not have third error yet');
+
+ //wait for the "network call" to complete
+ await delay(networkDelay);
+
+ // Should stop after max retries
+ assert.equal(listener.errors.length, 3, 'Should have final error');
+ assert.equal(listener.errors[2].isRetryable, false, 'Should be a fatal error');
+ assert.equal(manager.isRunning(), false, 'Should stop after max retries exceeded');
+ assert.equal(identityProvider.getRequestCount(), 4, 'Should have made exactly 4 requests');
+
+ disposable?.dispose();
+
+ });
+ });
+ });
+
+ describe('TokenManager retry delay calculations', () => {
+ const createManager = (retryConfig: Partial) => {
+ const config: TokenManagerConfig = {
+ expirationRefreshRatio: 0.8,
+ retry: {
+ maxAttempts: 3,
+ initialDelayMs: 100,
+ maxDelayMs: 1000,
+ backoffMultiplier: 2,
+ ...retryConfig
+ }
+ };
+ return new TokenManager(new TestIdentityProvider(), config);
+ };
+
+ describe('calculateRetryDelay', () => {
+
+ it('should apply exponential backoff', () => {
+ const manager = createManager({
+ initialDelayMs: 100,
+ backoffMultiplier: 2,
+ jitterPercentage: 0
+ });
+
+ // Test multiple retry attempts
+ const expectedDelays = [
+ [1, 100], // First attempt: initialDelay * (2^0) = 100
+ [2, 200], // Second attempt: initialDelay * (2^1) = 200
+ [3, 400], // Third attempt: initialDelay * (2^2) = 400
+ [4, 800], // Fourth attempt: initialDelay * (2^3) = 800
+ [5, 1000] // Fifth attempt: would be 1600, but capped at maxDelay (1000)
+ ];
+
+ for (const [attempt, expectedDelay] of expectedDelays) {
+ manager['retryAttempt'] = attempt;
+ assert.equal(
+ manager.calculateRetryDelay(),
+ expectedDelay,
+ `Incorrect delay for attempt ${attempt}`
+ );
+ }
+ });
+
+ it('should respect maxDelayMs', () => {
+ const manager = createManager({
+ initialDelayMs: 100,
+ maxDelayMs: 300,
+ backoffMultiplier: 2,
+ jitterPercentage: 0
+ });
+
+ // Test that delays are capped at maxDelayMs
+ const expectedDelays = [
+ [1, 100], // First attempt: 100
+ [2, 200], // Second attempt: 200
+ [3, 300], // Third attempt: would be 400, capped at 300
+ [4, 300], // Fourth attempt: would be 800, capped at 300
+ [5, 300] // Fifth attempt: would be 1600, capped at 300
+ ];
+
+ for (const [attempt, expectedDelay] of expectedDelays) {
+ manager['retryAttempt'] = attempt;
+ assert.equal(
+ manager.calculateRetryDelay(),
+ expectedDelay,
+ `Incorrect delay for attempt ${attempt}`
+ );
+ }
+ });
+
+ it('should return 0 when no retry config is present', () => {
+ const manager = new TokenManager(new TestIdentityProvider(), {
+ expirationRefreshRatio: 0.8
+ });
+ manager['retryAttempt'] = 1;
+ assert.equal(manager.calculateRetryDelay(), 0);
+ });
+ });
+ });
+});
+
diff --git a/packages/client/lib/authx/token-manager.ts b/packages/client/lib/authx/token-manager.ts
new file mode 100644
index 00000000000..6532d88317b
--- /dev/null
+++ b/packages/client/lib/authx/token-manager.ts
@@ -0,0 +1,318 @@
+import { IdentityProvider, TokenResponse } from './identity-provider';
+import { Token } from './token';
+import {Disposable} from './disposable';
+
+/**
+ * The configuration for retrying token refreshes.
+ */
+export interface RetryPolicy {
+ /**
+ * The maximum number of attempts to retry token refreshes.
+ */
+ maxAttempts: number;
+
+ /**
+ * The initial delay in milliseconds before the first retry.
+ */
+ initialDelayMs: number;
+
+ /**
+ * The maximum delay in milliseconds between retries.
+ * The calculated delay will be capped at this value.
+ */
+ maxDelayMs: number;
+
+ /**
+ * The multiplier for exponential backoff between retries.
+ * @example
+ * A value of 2 will double the delay each time:
+ * - 1st retry: initialDelayMs
+ * - 2nd retry: initialDelayMs * 2
+ * - 3rd retry: initialDelayMs * 4
+ */
+ backoffMultiplier: number;
+
+ /**
+ * The percentage of jitter to apply to the delay.
+ * @example
+ * A value of 0.1 will add or subtract up to 10% of the delay.
+ */
+ jitterPercentage?: number;
+
+ /**
+ * Function to classify errors from the identity provider as retryable or non-retryable.
+ * Used to determine if a token refresh failure should be retried based on the type of error.
+ *
+ * The default behavior is to retry all types of errors if no function is provided.
+ *
+ * Common use cases:
+ * - Network errors that may be transient (should retry)
+ * - Invalid credentials (should not retry)
+ * - Rate limiting responses (should retry)
+ *
+ * @param error - The error from the identity provider3
+ * @param attempt - Current retry attempt (0-based)
+ * @returns `true` if the error is considered transient and the operation should be retried
+ *
+ * @example
+ * ```typescript
+ * const retryPolicy: RetryPolicy = {
+ * maxAttempts: 3,
+ * initialDelayMs: 1000,
+ * maxDelayMs: 5000,
+ * backoffMultiplier: 2,
+ * isRetryable: (error) => {
+ * // Retry on network errors or rate limiting
+ * return error instanceof NetworkError ||
+ * error instanceof RateLimitError;
+ * }
+ * };
+ * ```
+ */
+ isRetryable?: (error: unknown, attempt: number) => boolean;
+}
+
+/**
+ * the configuration for the TokenManager.
+ */
+export interface TokenManagerConfig {
+
+ /**
+ * Represents the ratio of a token's lifetime at which a refresh should be triggered.
+ * For example, a value of 0.75 means the token should be refreshed when 75% of its lifetime has elapsed (or when
+ * 25% of its lifetime remains).
+ */
+ expirationRefreshRatio: number;
+
+ // The retry policy for token refreshes. If not provided, no retries will be attempted.
+ retry?: RetryPolicy;
+}
+
+/**
+ * IDPError indicates a failure from the identity provider.
+ *
+ * The `isRetryable` flag is determined by the RetryPolicy's error classification function - if an error is
+ * classified as retryable, it will be marked as transient and the token manager will attempt to recover.
+ */
+export class IDPError extends Error {
+ constructor(public readonly message: string, public readonly isRetryable: boolean) {
+ super(message);
+ this.name = 'IDPError';
+ }
+}
+
+/**
+ * TokenStreamListener is an interface for objects that listen to token changes.
+ */
+export type TokenStreamListener = {
+ /**
+ * Called each time a new token is received.
+ * @param token
+ */
+ onNext: (token: Token) => void;
+
+ /**
+ * Called when an error occurs while calling the underlying IdentityProvider. The error can be
+ * transient and the token manager will attempt to obtain a token again if retry policy is configured.
+ *
+ * Only fatal errors will terminate the stream and stop the token manager.
+ *
+ * @param error
+ */
+ onError: (error: IDPError) => void;
+
+}
+
+/**
+ * TokenManager is responsible for obtaining/refreshing tokens and notifying listeners about token changes.
+ * It uses an IdentityProvider to request tokens. The token refresh is scheduled based on the token's TTL and
+ * the expirationRefreshRatio configuration.
+ *
+ * The TokenManager should be disposed when it is no longer needed by calling the dispose method on the Disposable
+ * returned by start.
+ */
+export class TokenManager {
+ private currentToken: Token | null = null;
+ private refreshTimeout: NodeJS.Timeout | null = null;
+ private listener: TokenStreamListener | null = null;
+ private retryAttempt: number = 0;
+
+ constructor(
+ private readonly identityProvider: IdentityProvider,
+ private readonly config: TokenManagerConfig
+ ) {
+ if (this.config.expirationRefreshRatio > 1) {
+ throw new Error('expirationRefreshRatio must be less than or equal to 1');
+ }
+ if (this.config.expirationRefreshRatio < 0) {
+ throw new Error('expirationRefreshRatio must be greater or equal to 0');
+ }
+ }
+
+ /**
+ * Starts the token manager and returns a Disposable that can be used to stop the token manager.
+ *
+ * @param listener The listener that will receive token updates.
+ * @param initialDelayMs The initial delay in milliseconds before the first token refresh.
+ */
+ public start(listener: TokenStreamListener, initialDelayMs: number = 0): Disposable {
+ if (this.listener) {
+ this.stop();
+ }
+
+ this.listener = listener;
+ this.retryAttempt = 0;
+
+ this.scheduleNextRefresh(initialDelayMs);
+
+ return {
+ dispose: () => this.stop()
+ };
+ }
+
+ public calculateRetryDelay(): number {
+ if (!this.config.retry) return 0;
+
+ const { initialDelayMs, maxDelayMs, backoffMultiplier, jitterPercentage } = this.config.retry;
+
+ let delay = initialDelayMs * Math.pow(backoffMultiplier, this.retryAttempt - 1);
+
+ delay = Math.min(delay, maxDelayMs);
+
+ if (jitterPercentage) {
+ const jitterRange = delay * (jitterPercentage / 100);
+ const jitterAmount = Math.random() * jitterRange - (jitterRange / 2);
+ delay += jitterAmount;
+ }
+
+ let result = Math.max(0, Math.floor(delay));
+
+ return result;
+ }
+
+ private shouldRetry(error: unknown): boolean {
+ if (!this.config.retry) return false;
+
+ const { maxAttempts, isRetryable } = this.config.retry;
+
+ if (this.retryAttempt >= maxAttempts) {
+ return false;
+ }
+
+ if (isRetryable) {
+ return isRetryable(error, this.retryAttempt);
+ }
+
+ return false;
+ }
+
+ public isRunning(): boolean {
+ return this.listener !== null;
+ }
+
+ private async refresh(): Promise {
+ if (!this.listener) {
+ throw new Error('TokenManager is not running, but refresh was called');
+ }
+
+ try {
+ await this.identityProvider.requestToken().then(this.handleNewToken);
+ this.retryAttempt = 0;
+ } catch (error) {
+
+ if (this.shouldRetry(error)) {
+ this.retryAttempt++;
+ const retryDelay = this.calculateRetryDelay();
+ this.notifyError(`Token refresh failed (attempt ${this.retryAttempt}), retrying in ${retryDelay}ms: ${error}`, true)
+ this.scheduleNextRefresh(retryDelay);
+ } else {
+ this.notifyError(error, false);
+ this.stop();
+ }
+ }
+ }
+
+ private handleNewToken = async ({ token: nativeToken, ttlMs }: TokenResponse): Promise => {
+ if (!this.listener) {
+ throw new Error('TokenManager is not running, but a new token was received');
+ }
+ const token = this.wrapAndSetCurrentToken(nativeToken, ttlMs);
+ this.listener.onNext(token);
+
+ this.scheduleNextRefresh(this.calculateRefreshTime(token));
+ }
+
+ /**
+ * Creates a Token object from a native token and sets it as the current token.
+ *
+ * @param nativeToken - The raw token received from the identity provider
+ * @param ttlMs - Time-to-live in milliseconds for the token
+ *
+ * @returns A new Token instance containing the wrapped native token and expiration details
+ *
+ */
+ public wrapAndSetCurrentToken(nativeToken: T, ttlMs: number): Token {
+ const now = Date.now();
+ const token = new Token(
+ nativeToken,
+ now + ttlMs,
+ now
+ );
+ this.currentToken = token;
+ return token;
+ }
+
+ private scheduleNextRefresh(delayMs: number): void {
+ if (this.refreshTimeout) {
+ clearTimeout(this.refreshTimeout);
+ this.refreshTimeout = null;
+ }
+ if (delayMs === 0) {
+ this.refresh();
+ } else {
+ this.refreshTimeout = setTimeout(() => this.refresh(), delayMs);
+ }
+
+ }
+
+ /**
+ * Calculates the time in milliseconds when the token should be refreshed
+ * based on the token's TTL and the expirationRefreshRatio configuration.
+ *
+ * @param token The token to calculate the refresh time for.
+ * @param now The current time in milliseconds. Defaults to Date.now().
+ */
+ public calculateRefreshTime(token: Token, now: number = Date.now()): number {
+ const ttlMs = token.getTtlMs(now);
+ return Math.floor(ttlMs * this.config.expirationRefreshRatio);
+ }
+
+ private stop(): void {
+
+ if (this.refreshTimeout) {
+ clearTimeout(this.refreshTimeout);
+ this.refreshTimeout = null;
+ }
+
+ this.listener = null;
+ this.currentToken = null;
+ this.retryAttempt = 0;
+ }
+
+ /**
+ * Returns the current token or null if no token is available.
+ */
+ public getCurrentToken(): Token | null {
+ return this.currentToken;
+ }
+
+ private notifyError(error: unknown, isRetryable: boolean): void {
+ const errorMessage = error instanceof Error ? error.message : String(error);
+
+ if (!this.listener) {
+ throw new Error(`TokenManager is not running but received an error: ${errorMessage}`);
+ }
+
+ this.listener.onError(new IDPError(errorMessage, isRetryable));
+ }
+}
\ No newline at end of file
diff --git a/packages/client/lib/authx/token.ts b/packages/client/lib/authx/token.ts
new file mode 100644
index 00000000000..3d6e6867d84
--- /dev/null
+++ b/packages/client/lib/authx/token.ts
@@ -0,0 +1,23 @@
+/**
+ * A token that can be used to authenticate with a service.
+ */
+export class Token {
+ constructor(
+ public readonly value: T,
+ //represents the token deadline - the time in milliseconds since the Unix epoch at which the token expires
+ public readonly expiresAtMs: number,
+ //represents the time in milliseconds since the Unix epoch at which the token was received
+ public readonly receivedAtMs: number
+ ) {}
+
+ /**
+ * Returns the time-to-live of the token in milliseconds.
+ * @param now The current time in milliseconds since the Unix epoch.
+ */
+ getTtlMs(now: number): number {
+ if (this.expiresAtMs < now) {
+ return 0;
+ }
+ return this.expiresAtMs - now;
+ }
+}
\ No newline at end of file
diff --git a/packages/client/lib/client/cache.spec.ts b/packages/client/lib/client/cache.spec.ts
new file mode 100644
index 00000000000..55f2672c26c
--- /dev/null
+++ b/packages/client/lib/client/cache.spec.ts
@@ -0,0 +1,700 @@
+import assert from "assert";
+import testUtils, { GLOBAL } from "../test-utils"
+import { BasicClientSideCache, BasicPooledClientSideCache, CacheStats } from "./cache"
+import { REDIS_FLUSH_MODES } from "../commands/FLUSHALL";
+import { once } from 'events';
+
+describe("Client Side Cache", () => {
+ describe('Basic Cache', () => {
+ const csc = new BasicClientSideCache({ maxEntries: 10 });
+
+ testUtils.testWithClient('Basic Cache Miss', async client => {
+ csc.clear();
+
+ await client.set("x", 1);
+ await client.get("x");
+
+ assert.equal(csc.stats().missCount, 1, "Cache Misses");
+ assert.equal(csc.stats().hitCount, 0, "Cache Hits");
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ RESP: 3,
+ clientSideCache: csc
+ }
+ });
+
+ testUtils.testWithClient('Basic Cache Hit', async client => {
+ csc.clear();
+
+ await client.set("x", 1);
+ assert.equal(await client.get("x"), '1');
+ assert.equal(await client.get("x"), '1');
+
+ assert.equal(csc.stats().missCount, 1, "Cache Misses");
+ assert.equal(csc.stats().hitCount, 1, "Cache Hits");
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ RESP: 3,
+ clientSideCache: csc
+ }
+ });
+
+ testUtils.testWithClient('Max Cache Entries', async client => {
+ csc.clear();
+
+ await client.set('1', 1);
+ assert.equal(await client.get('1'), '1');
+ assert.equal(await client.get('2'), null);
+ assert.equal(await client.get('3'), null);
+ assert.equal(await client.get('4'), null);
+ assert.equal(await client.get('5'), null);
+ assert.equal(await client.get('6'), null);
+ assert.equal(await client.get('7'), null);
+ assert.equal(await client.get('8'), null);
+ assert.equal(await client.get('9'), null);
+ assert.equal(await client.get('10'), null);
+ assert.equal(await client.get('11'), null);
+ assert.equal(await client.get('1'), '1');
+
+ assert.equal(csc.stats().missCount, 12, "Cache Misses");
+ assert.equal(csc.stats().hitCount, 0, "Cache Hits");
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ RESP: 3,
+ clientSideCache: csc
+ }
+ });
+
+ testUtils.testWithClient('LRU works correctly', async client => {
+ csc.clear();
+
+ await client.set('1', 1);
+ assert.equal(await client.get('1'), '1');
+ assert.equal(await client.get('2'), null);
+ assert.equal(await client.get('3'), null);
+ assert.equal(await client.get('4'), null);
+ assert.equal(await client.get('5'), null);
+ assert.equal(await client.get('1'), '1');
+ assert.equal(await client.get('6'), null);
+ assert.equal(await client.get('7'), null);
+ assert.equal(await client.get('8'), null);
+ assert.equal(await client.get('9'), null);
+ assert.equal(await client.get('10'), null);
+ assert.equal(await client.get('11'), null);
+ assert.equal(await client.get('1'), '1');
+
+ assert.equal(csc.stats().missCount, 11, "Cache Misses");
+ assert.equal(csc.stats().hitCount, 2, "Cache Hits");
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ RESP: 3,
+ clientSideCache: csc
+ }
+ });
+
+ testUtils.testWithClient('Basic Cache Clear', async client => {
+ csc.clear();
+
+ await client.set("x", 1);
+ await client.get("x");
+ csc.clear();
+ await client.get("x");
+
+ assert.equal(csc.stats().missCount, 1, "Cache Misses");
+ assert.equal(csc.stats().hitCount, 0, "Cache Hits");
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ RESP: 3,
+ clientSideCache: csc
+ }
+ });
+
+ testUtils.testWithClient('Null Invalidate acts as clear', async client => {
+ csc.clear();
+
+ await client.set("x", 1);
+ await client.get("x");
+ csc.invalidate(null);
+ await client.get("x");
+
+ assert.equal(2, csc.stats().missCount, "Cache Misses");
+ assert.equal(0, csc.stats().hitCount, "Cache Hits");
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ RESP: 3,
+ clientSideCache: csc
+ }
+ });
+
+ testUtils.testWithClient('flushdb causes an invalidate null', async client => {
+ csc.clear();
+
+ await client.set("x", 1);
+ assert.equal(await client.get("x"), '1');
+ await client.flushDb(REDIS_FLUSH_MODES.SYNC);
+ assert.equal(await client.get("x"), null);
+
+ assert.equal(csc.stats().missCount, 2, "Cache Misses");
+ assert.equal(csc.stats().hitCount, 0, "Cache Hits");
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ RESP: 3,
+ clientSideCache: csc
+ }
+ });
+
+ testUtils.testWithClient('Basic Cache Invalidate', async client => {
+ csc.clear();
+
+ await client.set("x", 1);
+ assert.equal(await client.get("x"), '1', 'first get');
+ await client.set("x", 2);
+ assert.equal(await client.get("x"), '2', 'second get');
+ await client.set("x", 3);
+ assert.equal(await client.get("x"), '3', 'third get');
+
+ assert.equal(csc.stats().missCount, 3, "Cache Misses");
+ assert.equal(csc.stats().hitCount, 0, "Cache Hits");
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ RESP: 3,
+ clientSideCache: csc
+ }
+ });
+
+ testUtils.testWithClient("Cached Replies Don't Mutate", async client => {
+ csc.clear();
+
+ await client.set("x", 1);
+ await client.set('y', 2);
+ const ret1 = await client.mGet(['x', 'y']);
+ assert.deepEqual(ret1, ['1', '2'], 'first mGet');
+ ret1[0] = '4';
+ const ret2 = await client.mGet(['x', 'y']);
+ assert.deepEqual(ret2, ['1', '2'], 'second mGet');
+ ret2[0] = '8';
+ const ret3 = await client.mGet(['x', 'y']);
+ assert.deepEqual(ret3, ['1', '2'], 'third mGet');
+
+ assert.equal(csc.stats().missCount, 1, "Cache Misses");
+ assert.equal(csc.stats().hitCount, 2, "Cache Hits");
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ RESP: 3,
+ clientSideCache: csc
+ }
+ });
+
+ testUtils.testWithClient("Cached cleared on disconnect", async client => {
+ csc.clear();
+
+ await client.set("x", 1);
+ await client.set('y', 2);
+ const ret1 = await client.mGet(['x', 'y']);
+ assert.deepEqual(ret1, ['1', '2'], 'first mGet');
+
+ assert.equal(csc.stats().missCount, 1, "first Cache Misses");
+ assert.equal(csc.stats().hitCount, 0, "first Cache Hits");
+
+ await client.close();
+
+ await client.connect();
+
+ const ret2 = await client.mGet(['x', 'y']);
+ assert.deepEqual(ret2, ['1', '2'], 'second mGet');
+
+ assert.equal(csc.stats().missCount, 1, "second Cache Misses");
+ assert.equal(csc.stats().hitCount, 0, "second Cache Hits");
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ RESP: 3,
+ clientSideCache: csc
+ }
+ });
+ });
+
+ describe("Pooled Cache", () => {
+ const csc = new BasicPooledClientSideCache();
+
+ testUtils.testWithClient('Virtual Pool Disconnect', async client1 => {
+ const client2 = client1.duplicate();
+ await client2.connect()
+
+ assert.equal(await client2.get("x"), null);
+ assert.equal(await client1.get("x"), null);
+
+ assert.equal(1, csc.stats().missCount, "Cache Misses");
+ assert.equal(1, csc.stats().hitCount, "Cache Hits");
+
+ await client2.close();
+
+ assert.equal(await client1.get("x"), null);
+ assert.equal(await client1.get("x"), null);
+
+ assert.equal(2, csc.stats().missCount, "Cache Misses");
+ assert.equal(2, csc.stats().hitCount, "Cache Hits");
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ RESP: 3,
+ clientSideCache: csc
+ }
+ });
+
+ testUtils.testWithClientPool('Basic Cache Miss and Clear', async client => {
+ csc.clear();
+
+ await client.set("x", 1);
+ assert.equal(await client.get("x"), '1');
+
+ assert.equal(1, csc.stats().missCount, "Cache Misses");
+ assert.equal(0, csc.stats().hitCount, "Cache Hits");
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ RESP: 3,
+ },
+ poolOptions: {
+ minimum: 5,
+ maximum: 5,
+ acquireTimeout: 0,
+ cleanupDelay: 1,
+ clientSideCache: csc
+ }
+ })
+
+ testUtils.testWithClientPool('Basic Cache Hit', async client => {
+ csc.clear();
+
+ await client.set("x", 1);
+ assert.equal(await client.get("x"), '1');
+ assert.equal(await client.get("x"), '1');
+ assert.equal(await client.get("x"), '1');
+
+ assert.equal(csc.stats().missCount, 1, "Cache Misses");
+ assert.equal(csc.stats().hitCount, 2, "Cache Hits");
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ RESP: 3,
+ },
+ poolOptions: {
+ minimum: 5,
+ maximum: 5,
+ acquireTimeout: 0,
+ cleanupDelay: 1,
+ clientSideCache: csc
+ }
+ })
+
+ testUtils.testWithClientPool('Basic Cache Manually Invalidate', async client => {
+ csc.clear();
+
+ await client.set("x", 1);
+
+ assert.equal(await client.get("x"), '1', 'first get');
+
+ let p: Promise> = once(csc, 'invalidate');
+ await client.set("x", 2);
+ let [i] = await p;
+
+ assert.equal(await client.get("x"), '2', 'second get');
+
+ p = once(csc, 'invalidate');
+ await client.set("x", 3);
+ [i] = await p;
+
+ assert.equal(await client.get("x"), '3');
+
+ assert.equal(csc.stats().missCount, 3, "Cache Misses");
+ assert.equal(csc.stats().hitCount, 0, "Cache Hits");
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ RESP: 3,
+ },
+ poolOptions: {
+ minimum: 5,
+ maximum: 5,
+ acquireTimeout: 0,
+ cleanupDelay: 1,
+ clientSideCache: csc
+ }
+ })
+
+ testUtils.testWithClientPool('Basic Cache Invalidate via message', async client => {
+ csc.clear();
+
+ await client.set('x', 1);
+ await client.set('y', 2);
+
+ assert.deepEqual(await client.mGet(['x', 'y']), ['1', '2'], 'first mGet');
+
+ assert.equal(csc.stats().missCount, 1, "Cache Misses");
+ assert.equal(csc.stats().hitCount, 0, "Cache Hits");
+
+ let p: Promise> = once(csc, 'invalidate');
+ await client.set("x", 3);
+ let [i] = await p;
+
+ assert.equal(i, 'x');
+
+ assert.deepEqual(await client.mGet(['x', 'y']), ['3', '2'], 'second mGet');
+
+ assert.equal(csc.stats().missCount, 2, "Cache Misses");
+ assert.equal(csc.stats().hitCount, 0, "Cache Hits");
+
+ p = once(csc, 'invalidate');
+ await client.set("y", 4);
+ [i] = await p;
+
+ assert.equal(i, 'y');
+
+ assert.deepEqual(await client.mGet(['x', 'y']), ['3', '4'], 'second mGet');
+
+ assert.equal(csc.stats().missCount, 3, "Cache Misses");
+ assert.equal(csc.stats().hitCount, 0, "Cache Hits");
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ RESP: 3,
+ },
+ poolOptions: {
+ minimum: 5,
+ maximum: 5,
+ acquireTimeout: 0,
+ cleanupDelay: 1,
+ clientSideCache: csc
+ }
+ })
+ });
+
+ describe('Cluster Caching', () => {
+ const csc = new BasicPooledClientSideCache();
+
+ testUtils.testWithCluster('Basic Cache Miss and Clear', async client => {
+ csc.clear();
+
+ await client.set("x", 1);
+ await client.get("x");
+ await client.set("y", 1);
+ await client.get("y");
+
+ assert.equal(2, csc.stats().missCount, "Cache Misses");
+ assert.equal(0, csc.stats().hitCount, "Cache Hits");
+ }, {
+ ...GLOBAL.CLUSTERS.OPEN,
+ clusterConfiguration: {
+ RESP: 3,
+ clientSideCache: csc
+ }
+ })
+
+ testUtils.testWithCluster('Basic Cache Hit', async client => {
+ csc.clear();
+
+ await client.set("x", 1);
+ assert.equal(await client.get("x"), '1');
+ assert.equal(await client.get("x"), '1');
+ assert.equal(await client.get("x"), '1');
+ await client.set("y", 1);
+ assert.equal(await client.get("y"), '1');
+ assert.equal(await client.get("y"), '1');
+ assert.equal(await client.get("y"), '1');
+
+ assert.equal(2, csc.stats().missCount, "Cache Misses");
+ assert.equal(4, csc.stats().hitCount, "Cache Hits");
+ }, {
+ ...GLOBAL.CLUSTERS.OPEN,
+ clusterConfiguration: {
+ RESP: 3,
+ clientSideCache: csc
+ }
+ })
+
+ testUtils.testWithCluster('Basic Cache Invalidate', async client => {
+ csc.clear();
+
+ await client.set("x", 1);
+ assert.equal(await client.get("x"), '1');
+ await client.set("x", 2);
+ assert.equal(await client.get("x"), '2');
+ await client.set("x", 3);
+ assert.equal(await client.get("x"), '3');
+
+ await client.set("y", 1);
+ assert.equal(await client.get("y"), '1');
+ await client.set("y", 2);
+ assert.equal(await client.get("y"), '2');
+ await client.set("y", 3);
+ assert.equal(await client.get("y"), '3');
+
+ assert.equal(6, csc.stats().missCount, "Cache Misses");
+ assert.equal(0, csc.stats().hitCount, "Cache Hits");
+ }, {
+ ...GLOBAL.CLUSTERS.OPEN,
+ clusterConfiguration: {
+ RESP: 3,
+ clientSideCache: csc
+ }
+ })
+ });
+ describe("CacheStats", () => {
+ describe("CacheStats.of()", () => {
+ it("should correctly initialize stats and calculate derived values", () => {
+ const stats = CacheStats.of(10, 5, 8, 2, 100, 3);
+ assert.strictEqual(stats.hitCount, 10, "hitCount should be 10");
+ assert.strictEqual(stats.missCount, 5, "missCount should be 5");
+ assert.strictEqual(stats.loadSuccessCount, 8, "loadSuccessCount should be 8");
+ assert.strictEqual(stats.loadFailureCount, 2, "loadFailureCount should be 2");
+ assert.strictEqual(stats.totalLoadTime, 100, "totalLoadTime should be 100");
+ assert.strictEqual(stats.evictionCount, 3, "evictionCount should be 3");
+
+ assert.strictEqual(stats.requestCount(), 15, "requestCount should be 15 (10 hits + 5 misses)");
+ assert.strictEqual(stats.hitRate(), 10 / 15, "hitRate should be 10/15");
+ assert.strictEqual(stats.missRate(), 5 / 15, "missRate should be 5/15");
+ assert.strictEqual(stats.loadCount(), 10, "loadCount should be 10 (8 success + 2 failure)");
+ assert.strictEqual(stats.loadFailureRate(), 2 / 10, "loadFailureRate should be 2/10");
+ assert.strictEqual(stats.averageLoadPenalty(), 100 / 10, "averageLoadPenalty should be 10 (100 time / 10 loads)");
+ });
+
+ it("should handle zero values and division by zero for derived values", () => {
+ const stats = CacheStats.of(0, 0, 0, 0, 0, 0);
+ assert.strictEqual(stats.hitCount, 0, "hitCount");
+ assert.strictEqual(stats.missCount, 0, "missCount");
+ assert.strictEqual(stats.loadSuccessCount, 0, "loadSuccessCount");
+ assert.strictEqual(stats.loadFailureCount, 0, "loadFailureCount");
+ assert.strictEqual(stats.totalLoadTime, 0, "totalLoadTime");
+ assert.strictEqual(stats.evictionCount, 0, "evictionCount");
+
+ assert.strictEqual(stats.requestCount(), 0, "requestCount should be 0");
+ assert.strictEqual(stats.hitRate(), 1, "hitRate should be 1 for 0 requests");
+ assert.strictEqual(stats.missRate(), 0, "missRate should be 0 for 0 requests");
+ assert.strictEqual(stats.loadCount(), 0, "loadCount should be 0");
+ assert.strictEqual(stats.loadFailureRate(), 0, "loadFailureRate should be 0 for 0 loads");
+ assert.strictEqual(stats.averageLoadPenalty(), 0, "averageLoadPenalty should be 0 for 0 loads");
+ });
+ });
+
+ describe("CacheStats.empty()", () => {
+ it("should return stats with all zero counts and 0 for rates/penalties", () => {
+ const stats = CacheStats.empty();
+ assert.strictEqual(stats.hitCount, 0, "empty.hitCount");
+ assert.strictEqual(stats.missCount, 0, "empty.missCount");
+ assert.strictEqual(stats.loadSuccessCount, 0, "empty.loadSuccessCount");
+ assert.strictEqual(stats.loadFailureCount, 0, "empty.loadFailureCount");
+ assert.strictEqual(stats.totalLoadTime, 0, "empty.totalLoadTime");
+ assert.strictEqual(stats.evictionCount, 0, "empty.evictionCount");
+
+ assert.strictEqual(stats.requestCount(), 0, "empty.requestCount");
+ assert.strictEqual(stats.hitRate(), 1, "empty.hitRate should be 1");
+ assert.strictEqual(stats.missRate(), 0, "empty.missRate should be 0");
+ assert.strictEqual(stats.loadCount(), 0, "empty.loadCount");
+ assert.strictEqual(stats.loadFailureRate(), 0, "empty.loadFailureRate should be 0");
+ assert.strictEqual(stats.averageLoadPenalty(), 0, "empty.averageLoadPenalty should be 0");
+ });
+ });
+
+ describe("instance methods", () => {
+ const stats1 = CacheStats.of(10, 5, 8, 2, 100, 3);
+ const stats2 = CacheStats.of(20, 10, 12, 3, 200, 5);
+
+ describe("plus()", () => {
+ it("should correctly add two CacheStats instances", () => {
+ const sum = stats1.plus(stats2);
+ assert.strictEqual(sum.hitCount, 30);
+ assert.strictEqual(sum.missCount, 15);
+ assert.strictEqual(sum.loadSuccessCount, 20);
+ assert.strictEqual(sum.loadFailureCount, 5);
+ assert.strictEqual(sum.totalLoadTime, 300);
+ assert.strictEqual(sum.evictionCount, 8);
+ });
+
+ it("should correctly sum large numbers", () => {
+ const statsC = CacheStats.of(Number.MAX_VALUE, 1, 1, 1, 1, 1);
+ const statsD = CacheStats.of(Number.MAX_VALUE, 1, 1, 1, 1, 1);
+ const sum = statsC.plus(statsD);
+ assert.strictEqual(sum.hitCount, Infinity, "Summing MAX_VALUE should result in Infinity");
+ });
+ });
+
+ describe("minus()", () => {
+ it("should correctly subtract one CacheStats instance from another, flooring at 0", () => {
+ const diff = stats2.minus(stats1);
+ assert.strictEqual(diff.hitCount, 10);
+ assert.strictEqual(diff.missCount, 5);
+ assert.strictEqual(diff.loadSuccessCount, 4);
+ assert.strictEqual(diff.loadFailureCount, 1);
+ assert.strictEqual(diff.totalLoadTime, 100);
+ assert.strictEqual(diff.evictionCount, 2);
+ });
+
+ it("should floor results at 0 if minuend is smaller than subtrahend", () => {
+ const sSmall = CacheStats.of(5, 2, 1, 0, 10, 1);
+ const sLarge = CacheStats.of(10, 5, 2, 1, 20, 2);
+ const diff = sSmall.minus(sLarge);
+ assert.strictEqual(diff.hitCount, 0, "hitCount should be floored at 0 (5 - 10)");
+ assert.strictEqual(diff.missCount, 0, "missCount should be floored at 0 (2 - 5)");
+ assert.strictEqual(diff.loadSuccessCount, 0, "loadSuccessCount should be floored at 0 (1 - 2)");
+ assert.strictEqual(diff.loadFailureCount, 0, "loadFailureCount should be floored at 0 (0 - 1)");
+ assert.strictEqual(diff.totalLoadTime, 0, "totalLoadTime should be floored at 0 (10 - 20)");
+ assert.strictEqual(diff.evictionCount, 0, "evictionCount should be floored at 0 (1 - 2)");
+ });
+ });
+
+ describe("hitRate()", () => {
+ it("should return 0 if requestCount is 0", () => {
+ const stats = CacheStats.of(0, 0, 0, 0, 0, 0);
+ assert.strictEqual(stats.hitRate(), 1);
+ });
+ it("should return 0 if hitCount is 0 but missCount > 0", () => {
+ const stats = CacheStats.of(0, 1, 0, 0, 0, 0);
+ assert.strictEqual(stats.hitRate(), 0);
+ });
+ it("should return 1 if missCount is 0 but hitCount > 0", () => {
+ const stats = CacheStats.of(1, 0, 0, 0, 0, 0);
+ assert.strictEqual(stats.hitRate(), 1);
+ });
+ });
+
+ describe("missRate()", () => {
+ it("should return 0 if requestCount is 0", () => {
+ const stats = CacheStats.of(0, 0, 0, 0, 0, 0);
+ assert.strictEqual(stats.missRate(), 0);
+ });
+ it("should return 1 if hitCount is 0 but missCount > 0", () => {
+ const stats = CacheStats.of(0, 1, 0, 0, 0, 0);
+ assert.strictEqual(stats.missRate(), 1);
+ });
+ it("should return 0 if missCount is 0 but hitCount > 0", () => {
+ const stats = CacheStats.of(1, 0, 0, 0, 0, 0);
+ assert.strictEqual(stats.missRate(), 0);
+ });
+ });
+
+ describe("loadFailureRate()", () => {
+ it("should return 0 if loadCount is 0", () => {
+ const stats = CacheStats.of(0, 0, 0, 0, 0, 0);
+ assert.strictEqual(stats.loadFailureRate(), 0);
+ });
+ it("should return 0 if loadFailureCount is 0 but loadSuccessCount > 0", () => {
+ const stats = CacheStats.of(0, 0, 1, 0, 10, 0);
+ assert.strictEqual(stats.loadFailureRate(), 0);
+ });
+ it("should return 1 if loadSuccessCount is 0 but loadFailureCount > 0", () => {
+ const stats = CacheStats.of(0, 0, 0, 1, 10, 0);
+ assert.strictEqual(stats.loadFailureRate(), 1);
+ });
+ });
+
+ describe("averageLoadPenalty()", () => {
+ it("should return 0 if loadCount is 0, even if totalLoadTime > 0", () => {
+ const stats = CacheStats.of(0, 0, 0, 0, 100, 0);
+ assert.strictEqual(stats.averageLoadPenalty(), 0);
+ });
+ it("should return 0 if totalLoadTime is 0 and loadCount > 0", () => {
+ const stats = CacheStats.of(0, 0, 1, 1, 0, 0);
+ assert.strictEqual(stats.averageLoadPenalty(), 0);
+ });
+ });
+ });
+ });
+ it('should reflect comprehensive cache operations in stats via BasicClientSideCache', async function () {
+
+ const csc = new BasicClientSideCache({
+ maxEntries: 2, // Small size to easily trigger evictions
+ });
+
+ testUtils.testWithClient('comprehensive_stats_run', async client => {
+
+ // --- Phase 1: Initial misses and loads ---
+ await client.set('keyA', 'valueA_1');
+ assert.strictEqual(await client.get('keyA'), 'valueA_1', "Get keyA first time");
+ assert.strictEqual(csc.stats().missCount, 1);
+ assert.strictEqual(csc.stats().loadSuccessCount, 1);
+
+ await client.set('keyB', 'valueB_1');
+ assert.strictEqual(await client.get('keyB'), 'valueB_1', "Get keyB first time");
+ assert.strictEqual(csc.stats().missCount, 2);
+ assert.strictEqual(csc.stats().loadSuccessCount, 2);
+
+ // --- Phase 2: Cache hits ---
+ assert.strictEqual(await client.get('keyA'), 'valueA_1', "Get keyA second time (hit)");
+ assert.strictEqual(csc.stats().hitCount, 1);
+
+ assert.strictEqual(await client.get('keyB'), 'valueB_1', "Get keyB second time (hit)");
+ assert.strictEqual(csc.stats().hitCount, 2);
+
+
+ // --- Phase 3: Trigger evictions and more misses/loads ---
+ await client.set('keyC', 'valueC_1');
+ assert.strictEqual(await client.get('keyC'), 'valueC_1', "Get keyC first time (evicts keyA)");
+ assert.strictEqual(csc.stats().missCount, 3);
+ assert.strictEqual(csc.stats().loadSuccessCount, 3);
+ assert.strictEqual(csc.stats().evictionCount, 1);
+
+
+ assert.strictEqual(await client.get('keyA'), 'valueA_1', "Get keyA again (miss after eviction)");
+ assert.strictEqual(csc.stats().missCount, 4);
+ assert.strictEqual(csc.stats().loadSuccessCount, 4);
+ assert.strictEqual(csc.stats().evictionCount, 2);
+
+
+ // --- Phase 4: More hits ---
+ assert.strictEqual(await client.get('keyC'), 'valueC_1', "Get keyC again (hit)");
+ assert.strictEqual(csc.stats().hitCount, 3);
+
+ // --- Phase 5: Update a key (results in invalidation, then miss/load on next GET) ---
+ // Note: A SET operation on an existing cached key should invalidate it.
+ // The invalidation itself isn't directly a "hit" or "miss" for stats,
+ // but the *next* GET will be a miss.
+ await client.set('keyA', 'valueA_2');
+ assert.strictEqual(await client.get('keyA'), 'valueA_2', "Get keyA after SET (miss due to invalidation)");
+
+ assert.strictEqual(csc.stats().hitCount, 3);
+ assert.strictEqual(csc.stats().loadSuccessCount, 5);
+
+
+
+ const stats = csc.stats()
+
+ assert.strictEqual(stats.hitCount, 3, "Final hitCount");
+ assert.strictEqual(stats.missCount, 5, "Final missCount");
+ assert.strictEqual(stats.loadSuccessCount, 5, "Final loadSuccessCount");
+ assert.strictEqual(stats.loadFailureCount, 0, "Final loadFailureCount (expected 0 for this test)");
+ assert.strictEqual(stats.evictionCount, 2, "Final evictionCount");
+ assert.ok(stats.totalLoadTime >= 0, "Final totalLoadTime should be non-negative");
+
+ assert.strictEqual(stats.requestCount(), 8, "Final requestCount (5 misses + 3 hits)");
+ assert.strictEqual(stats.hitRate(), 3 / 8, "Final hitRate");
+ assert.strictEqual(stats.missRate(), 5 / 8, "Final missRate");
+
+ assert.strictEqual(stats.loadCount(), 5, "Final loadCount (5 success + 0 failure)");
+ assert.strictEqual(stats.loadFailureRate(), 0, "Final loadFailureRate (0 failures / 5 loads)");
+
+ if (stats.loadCount() > 0) {
+ assert.ok(stats.averageLoadPenalty() >= 0, "Final averageLoadPenalty should be non-negative");
+ assert.strictEqual(stats.averageLoadPenalty(), stats.totalLoadTime / stats.loadCount(), "Average load penalty calculation");
+ } else {
+ assert.strictEqual(stats.averageLoadPenalty(), 0, "Final averageLoadPenalty should be 0 if no loads");
+ }
+
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ RESP: 3,
+ clientSideCache: csc
+ }
+ });
+ });
+});
diff --git a/packages/client/lib/client/cache.ts b/packages/client/lib/client/cache.ts
new file mode 100644
index 00000000000..7254352ee8f
--- /dev/null
+++ b/packages/client/lib/client/cache.ts
@@ -0,0 +1,870 @@
+import { EventEmitter } from 'stream';
+import RedisClient from '.';
+import { RedisArgument, ReplyUnion, TransformReply, TypeMapping } from '../RESP/types';
+import { BasicCommandParser } from './parser';
+
+/**
+ * A snapshot of cache statistics.
+ *
+ * This class provides an immutable view of the cache's operational statistics at a particular
+ * point in time. It is heavily inspired by the statistics reporting capabilities found in
+ * Ben Manes's Caffeine cache (https://github.com/ben-manes/caffeine).
+ *
+ * Instances of `CacheStats` are typically obtained from a {@link StatsCounter} and can be used
+ * for performance monitoring, debugging, or logging. It includes metrics such as hit rate,
+ * miss rate, load success/failure rates, average load penalty, and eviction counts.
+ *
+ * All statistics are non-negative. Rates and averages are typically in the range `[0.0, 1.0]`,
+ * or `0` if the an operation has not occurred (e.g. hit rate is 0 if there are no requests).
+ *
+ * Cache statistics are incremented according to specific rules:
+ * - When a cache lookup encounters an existing entry, hitCount is incremented.
+ * - When a cache lookup encounters a missing entry, missCount is incremented.
+ * - When a new entry is successfully loaded, loadSuccessCount is incremented and the
+ * loading time is added to totalLoadTime.
+ * - When an entry fails to load, loadFailureCount is incremented and the
+ * loading time is added to totalLoadTime.
+ * - When an entry is evicted due to size constraints or expiration,
+ * evictionCount is incremented.
+ */
+export class CacheStats {
+ /**
+ * Creates a new CacheStats instance with the specified statistics.
+ */
+ private constructor(
+ public readonly hitCount: number,
+ public readonly missCount: number,
+ public readonly loadSuccessCount: number,
+ public readonly loadFailureCount: number,
+ public readonly totalLoadTime: number,
+ public readonly evictionCount: number
+ ) {
+ if (
+ hitCount < 0 ||
+ missCount < 0 ||
+ loadSuccessCount < 0 ||
+ loadFailureCount < 0 ||
+ totalLoadTime < 0 ||
+ evictionCount < 0
+ ) {
+ throw new Error('All statistics values must be non-negative');
+ }
+ }
+
+ /**
+ * Creates a new CacheStats instance with the specified statistics.
+ *
+ * @param hitCount - Number of cache hits
+ * @param missCount - Number of cache misses
+ * @param loadSuccessCount - Number of successful cache loads
+ * @param loadFailureCount - Number of failed cache loads
+ * @param totalLoadTime - Total load time in milliseconds
+ * @param evictionCount - Number of cache evictions
+ */
+ static of(
+ hitCount = 0,
+ missCount = 0,
+ loadSuccessCount = 0,
+ loadFailureCount = 0,
+ totalLoadTime = 0,
+ evictionCount = 0
+ ): CacheStats {
+ return new CacheStats(
+ hitCount,
+ missCount,
+ loadSuccessCount,
+ loadFailureCount,
+ totalLoadTime,
+ evictionCount
+ );
+ }
+
+ /**
+ * Returns a statistics instance where no cache events have been recorded.
+ *
+ * @returns An empty statistics instance
+ */
+ static empty(): CacheStats {
+ return CacheStats.EMPTY_STATS;
+ }
+
+ /**
+ * An empty stats instance with all counters set to zero.
+ */
+ private static readonly EMPTY_STATS = new CacheStats(0, 0, 0, 0, 0, 0);
+
+ /**
+ * Returns the total number of times cache lookup methods have returned
+ * either a cached or uncached value.
+ *
+ * @returns Total number of requests (hits + misses)
+ */
+ requestCount(): number {
+ return this.hitCount + this.missCount;
+ }
+
+ /**
+ * Returns the hit rate of the cache.
+ * This is defined as hitCount / requestCount, or 1.0 when requestCount is 0.
+ *
+ * @returns The ratio of cache requests that were hits (between 0.0 and 1.0)
+ */
+ hitRate(): number {
+ const requestCount = this.requestCount();
+ return requestCount === 0 ? 1.0 : this.hitCount / requestCount;
+ }
+
+ /**
+ * Returns the miss rate of the cache.
+ * This is defined as missCount / requestCount, or 0.0 when requestCount is 0.
+ *
+ * @returns The ratio of cache requests that were misses (between 0.0 and 1.0)
+ */
+ missRate(): number {
+ const requestCount = this.requestCount();
+ return requestCount === 0 ? 0.0 : this.missCount / requestCount;
+ }
+
+ /**
+ * Returns the total number of load operations (successful + failed).
+ *
+ * @returns Total number of load operations
+ */
+ loadCount(): number {
+ return this.loadSuccessCount + this.loadFailureCount;
+ }
+
+ /**
+ * Returns the ratio of cache loading attempts that failed.
+ * This is defined as loadFailureCount / loadCount, or 0.0 when loadCount is 0.
+ *
+ * @returns Ratio of load operations that failed (between 0.0 and 1.0)
+ */
+ loadFailureRate(): number {
+ const loadCount = this.loadCount();
+ return loadCount === 0 ? 0.0 : this.loadFailureCount / loadCount;
+ }
+
+ /**
+ * Returns the average time spent loading new values, in milliseconds.
+ * This is defined as totalLoadTime / loadCount, or 0.0 when loadCount is 0.
+ *
+ * @returns Average load time in milliseconds
+ */
+ averageLoadPenalty(): number {
+ const loadCount = this.loadCount();
+ return loadCount === 0 ? 0.0 : this.totalLoadTime / loadCount;
+ }
+
+ /**
+ * Returns a new CacheStats representing the difference between this CacheStats
+ * and another. Negative values are rounded up to zero.
+ *
+ * @param other - The statistics to subtract from this instance
+ * @returns The difference between this instance and other
+ */
+ minus(other: CacheStats): CacheStats {
+ return CacheStats.of(
+ Math.max(0, this.hitCount - other.hitCount),
+ Math.max(0, this.missCount - other.missCount),
+ Math.max(0, this.loadSuccessCount - other.loadSuccessCount),
+ Math.max(0, this.loadFailureCount - other.loadFailureCount),
+ Math.max(0, this.totalLoadTime - other.totalLoadTime),
+ Math.max(0, this.evictionCount - other.evictionCount)
+ );
+ }
+
+ /**
+ * Returns a new CacheStats representing the sum of this CacheStats and another.
+ *
+ * @param other - The statistics to add to this instance
+ * @returns The sum of this instance and other
+ */
+ plus(other: CacheStats): CacheStats {
+ return CacheStats.of(
+ this.hitCount + other.hitCount,
+ this.missCount + other.missCount,
+ this.loadSuccessCount + other.loadSuccessCount,
+ this.loadFailureCount + other.loadFailureCount,
+ this.totalLoadTime + other.totalLoadTime,
+ this.evictionCount + other.evictionCount
+ );
+ }
+}
+
+/**
+ * An accumulator for cache statistics.
+ *
+ * This interface defines the contract for objects that record cache-related events
+ * such as hits, misses, loads (successes and failures), and evictions. The design
+ * is inspired by the statistics collection mechanisms in Ben Manes's Caffeine cache
+ * (https://github.com/ben-manes/caffeine).
+ *
+ * Implementations of this interface are responsible for aggregating these events.
+ * A snapshot of the current statistics can be obtained by calling the `snapshot()`
+ * method, which returns an immutable {@link CacheStats} object.
+ *
+ * Common implementations include `DefaultStatsCounter` for active statistics collection
+ * and `DisabledStatsCounter` for a no-op version when stats are not needed.
+ */
+export interface StatsCounter {
+ /**
+ * Records cache hits. This should be called when a cache request returns a cached value.
+ *
+ * @param count - The number of hits to record
+ */
+ recordHits(count: number): void;
+
+ /**
+ * Records cache misses. This should be called when a cache request returns a value that was not
+ * found in the cache.
+ *
+ * @param count - The number of misses to record
+ */
+ recordMisses(count: number): void;
+
+ /**
+ * Records the successful load of a new entry. This method should be called when a cache request
+ * causes an entry to be loaded and the loading completes successfully.
+ *
+ * @param loadTime - The number of milliseconds the cache spent computing or retrieving the new value
+ */
+ recordLoadSuccess(loadTime: number): void;
+
+ /**
+ * Records the failed load of a new entry. This method should be called when a cache request
+ * causes an entry to be loaded, but an exception is thrown while loading the entry.
+ *
+ * @param loadTime - The number of milliseconds the cache spent computing or retrieving the new value
+ * prior to the failure
+ */
+ recordLoadFailure(loadTime: number): void;
+
+ /**
+ * Records the eviction of an entry from the cache. This should only be called when an entry is
+ * evicted due to the cache's eviction strategy, and not as a result of manual invalidations.
+ *
+ * @param count - The number of evictions to record
+ */
+ recordEvictions(count: number): void;
+
+ /**
+ * Returns a snapshot of this counter's values. Note that this may be an inconsistent view, as it
+ * may be interleaved with update operations.
+ *
+ * @return A snapshot of this counter's values
+ */
+ snapshot(): CacheStats;
+}
+
+/**
+ * A StatsCounter implementation that does nothing and always returns empty stats.
+ */
+class DisabledStatsCounter implements StatsCounter {
+ static readonly INSTANCE = new DisabledStatsCounter();
+
+ private constructor() { }
+
+ recordHits(count: number): void { }
+ recordMisses(count: number): void { }
+ recordLoadSuccess(loadTime: number): void { }
+ recordLoadFailure(loadTime: number): void { }
+ recordEvictions(count: number): void { }
+ snapshot(): CacheStats { return CacheStats.empty(); }
+}
+
+/**
+ * Returns a StatsCounter that does not record any cache events.
+ *
+ * @return A StatsCounter that does not record metrics
+ */
+function disabledStatsCounter(): StatsCounter {
+ return DisabledStatsCounter.INSTANCE;
+}
+
+/**
+ * A StatsCounter implementation that maintains cache statistics.
+ */
+class DefaultStatsCounter implements StatsCounter {
+ #hitCount = 0;
+ #missCount = 0;
+ #loadSuccessCount = 0;
+ #loadFailureCount = 0;
+ #totalLoadTime = 0;
+ #evictionCount = 0;
+
+ /**
+ * Records cache hits.
+ *
+ * @param count - The number of hits to record
+ */
+ recordHits(count: number): void {
+ this.#hitCount += count;
+ }
+
+ /**
+ * Records cache misses.
+ *
+ * @param count - The number of misses to record
+ */
+ recordMisses(count: number): void {
+ this.#missCount += count;
+ }
+
+ /**
+ * Records the successful load of a new entry.
+ *
+ * @param loadTime - The number of milliseconds spent loading the entry
+ */
+ recordLoadSuccess(loadTime: number): void {
+ this.#loadSuccessCount++;
+ this.#totalLoadTime += loadTime;
+ }
+
+ /**
+ * Records the failed load of a new entry.
+ *
+ * @param loadTime - The number of milliseconds spent attempting to load the entry
+ */
+ recordLoadFailure(loadTime: number): void {
+ this.#loadFailureCount++;
+ this.#totalLoadTime += loadTime;
+ }
+
+ /**
+ * Records cache evictions.
+ *
+ * @param count - The number of evictions to record
+ */
+ recordEvictions(count: number): void {
+ this.#evictionCount += count;
+ }
+
+ /**
+ * Returns a snapshot of the current statistics.
+ *
+ * @returns A snapshot of the current statistics
+ */
+ snapshot(): CacheStats {
+ return CacheStats.of(
+ this.#hitCount,
+ this.#missCount,
+ this.#loadSuccessCount,
+ this.#loadFailureCount,
+ this.#totalLoadTime,
+ this.#evictionCount
+ );
+ }
+
+ /**
+ * Creates a new DefaultStatsCounter.
+ *
+ * @returns A new DefaultStatsCounter instance
+ */
+ static create(): DefaultStatsCounter {
+ return new DefaultStatsCounter();
+ }
+}
+
+type CachingClient = RedisClient;
+type CmdFunc = () => Promise;
+
+type EvictionPolicy = "LRU" | "FIFO"
+
+/**
+ * Configuration options for Client Side Cache
+ */
+export interface ClientSideCacheConfig {
+ /**
+ * Time-to-live in milliseconds for cached entries.
+ * Use 0 for no expiration.
+ * @default 0
+ */
+ ttl?: number;
+
+ /**
+ * Maximum number of entries to store in the cache.
+ * Use 0 for unlimited entries.
+ * @default 0
+ */
+ maxEntries?: number;
+
+ /**
+ * Eviction policy to use when the cache reaches its capacity.
+ * - "LRU" (Least Recently Used): Evicts least recently accessed entries first
+ * - "FIFO" (First In First Out): Evicts oldest entries first
+ * @default "LRU"
+ */
+ evictPolicy?: EvictionPolicy;
+
+ /**
+ * Whether to collect statistics about cache operations.
+ * @default true
+ */
+ recordStats?: boolean;
+}
+
+interface CacheCreator {
+ epoch: number;
+ client: CachingClient;
+}
+
+interface ClientSideCacheEntry {
+ invalidate(): void;
+ validate(): boolean;
+}
+
+/**
+ * Generates a unique cache key from Redis command arguments
+ *
+ * @param redisArgs - Array of Redis command arguments
+ * @returns A unique string key for caching
+ */
+function generateCacheKey(redisArgs: ReadonlyArray): string {
+ const tmp = new Array(redisArgs.length * 2);
+
+ for (let i = 0; i < redisArgs.length; i++) {
+ tmp[i] = redisArgs[i].length;
+ tmp[i + redisArgs.length] = redisArgs[i];
+ }
+
+ return tmp.join('_');
+}
+
+abstract class ClientSideCacheEntryBase implements ClientSideCacheEntry {
+ #invalidated = false;
+ readonly #expireTime: number;
+
+ constructor(ttl: number) {
+ if (ttl == 0) {
+ this.#expireTime = 0;
+ } else {
+ this.#expireTime = Date.now() + ttl;
+ }
+ }
+
+ invalidate(): void {
+ this.#invalidated = true;
+ }
+
+ validate(): boolean {
+ return !this.#invalidated && (this.#expireTime == 0 || (Date.now() < this.#expireTime))
+ }
+}
+
+class ClientSideCacheEntryValue extends ClientSideCacheEntryBase {
+ readonly #value: any;
+
+ get value() {
+ return this.#value;
+ }
+
+ constructor(ttl: number, value: any) {
+ super(ttl);
+ this.#value = value;
+ }
+}
+
+class ClientSideCacheEntryPromise extends ClientSideCacheEntryBase {
+ readonly #sendCommandPromise: Promise;
+
+ get promise() {
+ return this.#sendCommandPromise;
+ }
+
+ constructor(ttl: number, sendCommandPromise: Promise) {
+ super(ttl);
+ this.#sendCommandPromise = sendCommandPromise;
+ }
+}
+
+export abstract class ClientSideCacheProvider extends EventEmitter {
+ abstract handleCache(client: CachingClient, parser: BasicCommandParser, fn: CmdFunc, transformReply: TransformReply | undefined, typeMapping: TypeMapping | undefined): Promise;
+ abstract trackingOn(): Array;
+ abstract invalidate(key: RedisArgument | null): void;
+ abstract clear(): void;
+ abstract stats(): CacheStats;
+ abstract onError(): void;
+ abstract onClose(): void;
+}
+
+export class BasicClientSideCache extends ClientSideCacheProvider {
+ #cacheKeyToEntryMap: Map;
+ #keyToCacheKeySetMap: Map>;
+ readonly ttl: number;
+ readonly maxEntries: number;
+ readonly lru: boolean;
+ #statsCounter: StatsCounter;
+
+
+ recordEvictions(count: number): void {
+ this.#statsCounter.recordEvictions(count);
+ }
+
+ recordHits(count: number): void {
+ this.#statsCounter.recordHits(count);
+ }
+
+ recordMisses(count: number): void {
+ this.#statsCounter.recordMisses(count);
+ }
+
+ constructor(config?: ClientSideCacheConfig) {
+ super();
+
+ this.#cacheKeyToEntryMap = new Map();
+ this.#keyToCacheKeySetMap = new Map>();
+ this.ttl = config?.ttl ?? 0;
+ this.maxEntries = config?.maxEntries ?? 0;
+ this.lru = config?.evictPolicy !== "FIFO";
+
+ const recordStats = config?.recordStats !== false;
+ this.#statsCounter = recordStats ? DefaultStatsCounter.create() : disabledStatsCounter();
+ }
+
+ /* logic of how caching works:
+
+ 1. commands use a CommandParser
+ it enables us to define/retrieve
+ cacheKey - a unique key that corresponds to this command and its arguments
+ redisKeys - an array of redis keys as strings that if the key is modified, will cause redis to invalidate this result when cached
+ 2. check if cacheKey is in our cache
+ 2b1. if its a value cacheEntry - return it
+ 2b2. if it's a promise cache entry - wait on promise and then go to 3c.
+ 3. if cacheEntry is not in cache
+ 3a. send the command save the promise into a a cacheEntry and then wait on result
+ 3b. transform reply (if required) based on transformReply
+ 3b. check the cacheEntry is still valid - in cache and hasn't been deleted)
+ 3c. if valid - overwrite with value entry
+ 4. return previously non cached result
+ */
+ override async handleCache(
+ client: CachingClient,
+ parser: BasicCommandParser,
+ fn: CmdFunc,
+ transformReply?: TransformReply,
+ typeMapping?: TypeMapping
+ ) {
+ let reply: ReplyUnion;
+
+ const cacheKey = generateCacheKey(parser.redisArgs);
+
+ // "2"
+ let cacheEntry = this.get(cacheKey);
+ if (cacheEntry) {
+ // If instanceof is "too slow", can add a "type" and then use an "as" cast to call proper getters.
+ if (cacheEntry instanceof ClientSideCacheEntryValue) { // "2b1"
+ this.#statsCounter.recordHits(1);
+
+ return structuredClone(cacheEntry.value);
+ } else if (cacheEntry instanceof ClientSideCacheEntryPromise) { // 2b2
+ // This counts as a miss since the value hasn't been fully loaded yet.
+ this.#statsCounter.recordMisses(1);
+ reply = await cacheEntry.promise;
+ } else {
+ throw new Error("unknown cache entry type");
+ }
+ } else { // 3/3a
+ this.#statsCounter.recordMisses(1);
+
+ const startTime = performance.now();
+ const promise = fn();
+
+ cacheEntry = this.createPromiseEntry(client, promise);
+ this.set(cacheKey, cacheEntry, parser.keys);
+
+ try {
+ reply = await promise;
+ const loadTime = performance.now() - startTime;
+ this.#statsCounter.recordLoadSuccess(loadTime);
+ } catch (err) {
+ const loadTime = performance.now() - startTime;
+ this.#statsCounter.recordLoadFailure(loadTime);
+
+ if (cacheEntry.validate()) {
+ this.delete(cacheKey!);
+ }
+
+ throw err;
+ }
+ }
+
+ // 3b
+ let val;
+ if (transformReply) {
+ val = transformReply(reply, parser.preserve, typeMapping);
+ } else {
+ val = reply;
+ }
+
+ // 3c
+ if (cacheEntry.validate()) { // revalidating promise entry (dont save value, if promise entry has been invalidated)
+ // 3d
+ cacheEntry = this.createValueEntry(client, val);
+ this.set(cacheKey, cacheEntry, parser.keys);
+ this.emit("cached-key", cacheKey);
+ } else {
+ // cache entry for key got invalidated between execution and saving, so not saving
+ }
+
+ return structuredClone(val);
+ }
+
+ override trackingOn() {
+ return ['CLIENT', 'TRACKING', 'ON'];
+ }
+
+ override invalidate(key: RedisArgument | null) {
+ if (key === null) {
+ this.clear(false);
+ this.emit("invalidate", key);
+
+ return;
+ }
+
+ const keySet = this.#keyToCacheKeySetMap.get(key.toString());
+ if (keySet) {
+ for (const cacheKey of keySet) {
+ const entry = this.#cacheKeyToEntryMap.get(cacheKey);
+ if (entry) {
+ entry.invalidate();
+ }
+ this.#cacheKeyToEntryMap.delete(cacheKey);
+ }
+ this.#keyToCacheKeySetMap.delete(key.toString());
+ }
+
+ this.emit('invalidate', key);
+ }
+
+ override clear(resetStats = true) {
+ const oldSize = this.#cacheKeyToEntryMap.size;
+ this.#cacheKeyToEntryMap.clear();
+ this.#keyToCacheKeySetMap.clear();
+
+ if (resetStats) {
+ if (!(this.#statsCounter instanceof DisabledStatsCounter)) {
+ this.#statsCounter = DefaultStatsCounter.create();
+ }
+ } else {
+ // If old entries were evicted due to clear, record them as evictions
+ if (oldSize > 0) {
+ this.#statsCounter.recordEvictions(oldSize);
+ }
+ }
+ }
+
+ get(cacheKey: string) {
+ const val = this.#cacheKeyToEntryMap.get(cacheKey);
+
+ if (val && !val.validate()) {
+ this.delete(cacheKey);
+ this.#statsCounter.recordEvictions(1);
+ this.emit("cache-evict", cacheKey);
+
+ return undefined;
+ }
+
+ if (val !== undefined && this.lru) {
+ this.#cacheKeyToEntryMap.delete(cacheKey);
+ this.#cacheKeyToEntryMap.set(cacheKey, val);
+ }
+
+ return val;
+ }
+
+ delete(cacheKey: string) {
+ const entry = this.#cacheKeyToEntryMap.get(cacheKey);
+ if (entry) {
+ entry.invalidate();
+ this.#cacheKeyToEntryMap.delete(cacheKey);
+ }
+ }
+
+ has(cacheKey: string) {
+ return this.#cacheKeyToEntryMap.has(cacheKey);
+ }
+
+ set(cacheKey: string, cacheEntry: ClientSideCacheEntry, keys: Array) {
+ let count = this.#cacheKeyToEntryMap.size;
+ const oldEntry = this.#cacheKeyToEntryMap.get(cacheKey);
+
+ if (oldEntry) {
+ count--; // overwriting, so not incrementig
+ oldEntry.invalidate();
+ }
+
+ if (this.maxEntries > 0 && count >= this.maxEntries) {
+ this.deleteOldest();
+ this.#statsCounter.recordEvictions(1);
+ }
+
+ this.#cacheKeyToEntryMap.set(cacheKey, cacheEntry);
+
+ for (const key of keys) {
+ if (!this.#keyToCacheKeySetMap.has(key.toString())) {
+ this.#keyToCacheKeySetMap.set(key.toString(), new Set());
+ }
+
+ const cacheKeySet = this.#keyToCacheKeySetMap.get(key.toString());
+ cacheKeySet!.add(cacheKey);
+ }
+ }
+
+ size() {
+ return this.#cacheKeyToEntryMap.size;
+ }
+
+ createValueEntry(client: CachingClient, value: any): ClientSideCacheEntryValue {
+ return new ClientSideCacheEntryValue(this.ttl, value);
+ }
+
+ createPromiseEntry(client: CachingClient, sendCommandPromise: Promise): ClientSideCacheEntryPromise {
+ return new ClientSideCacheEntryPromise(this.ttl, sendCommandPromise);
+ }
+
+ override stats(): CacheStats {
+ return this.#statsCounter.snapshot();
+ }
+
+ override onError(): void {
+ this.clear();
+ }
+
+ override onClose() {
+ this.clear();
+ }
+
+ /**
+ * @internal
+ */
+ deleteOldest() {
+ const it = this.#cacheKeyToEntryMap[Symbol.iterator]();
+ const n = it.next();
+ if (!n.done) {
+ const key = n.value[0];
+ const entry = this.#cacheKeyToEntryMap.get(key);
+ if (entry) {
+ entry.invalidate();
+ }
+ this.#cacheKeyToEntryMap.delete(key);
+ }
+ }
+
+ /**
+ * Get cache entries for debugging
+ * @internal
+ */
+ entryEntries(): IterableIterator<[string, ClientSideCacheEntry]> {
+ return this.#cacheKeyToEntryMap.entries();
+ }
+
+ /**
+ * Get key set entries for debugging
+ * @internal
+ */
+ keySetEntries(): IterableIterator<[string, Set]> {
+ return this.#keyToCacheKeySetMap.entries();
+ }
+}
+
+export abstract class PooledClientSideCacheProvider extends BasicClientSideCache {
+ #disabled = false;
+
+ disable(): void {
+ this.#disabled = true;
+ }
+
+ enable(): void {
+ this.#disabled = false;
+ }
+
+ override get(cacheKey: string): ClientSideCacheEntry | undefined {
+ if (this.#disabled) {
+ return undefined;
+ }
+
+ return super.get(cacheKey);
+ }
+
+ override has(cacheKey: string): boolean {
+ if (this.#disabled) {
+ return false;
+ }
+
+ return super.has(cacheKey);
+ }
+
+ onPoolClose(): void {
+ this.clear();
+ }
+}
+
+export class BasicPooledClientSideCache extends PooledClientSideCacheProvider {
+ override onError() {
+ this.clear(false);
+ }
+
+ override onClose() {
+ this.clear(false);
+ }
+}
+
+class PooledClientSideCacheEntryValue extends ClientSideCacheEntryValue {
+ #creator: CacheCreator;
+
+ constructor(ttl: number, creator: CacheCreator, value: any) {
+ super(ttl, value);
+
+ this.#creator = creator;
+ }
+
+ override validate(): boolean {
+ let ret = super.validate();
+ if (this.#creator) {
+ ret = ret && this.#creator.client.isReady && this.#creator.client.socketEpoch == this.#creator.epoch
+ }
+
+ return ret;
+ }
+}
+
+class PooledClientSideCacheEntryPromise extends ClientSideCacheEntryPromise {
+ #creator: CacheCreator;
+
+ constructor(ttl: number, creator: CacheCreator, sendCommandPromise: Promise) {
+ super(ttl, sendCommandPromise);
+
+ this.#creator = creator;
+ }
+
+ override validate(): boolean {
+ let ret = super.validate();
+
+ return ret && this.#creator.client.isReady && this.#creator.client.socketEpoch == this.#creator.epoch
+ }
+}
+
+export class PooledNoRedirectClientSideCache extends BasicPooledClientSideCache {
+ override createValueEntry(client: CachingClient, value: any): ClientSideCacheEntryValue {
+ const creator = {
+ epoch: client.socketEpoch,
+ client: client
+ };
+
+ return new PooledClientSideCacheEntryValue(this.ttl, creator, value);
+ }
+
+ override createPromiseEntry(client: CachingClient, sendCommandPromise: Promise): ClientSideCacheEntryPromise {
+ const creator = {
+ epoch: client.socketEpoch,
+ client: client
+ };
+
+ return new PooledClientSideCacheEntryPromise(this.ttl, creator, sendCommandPromise);
+ }
+
+ override onError() { }
+
+ override onClose() { }
+}
diff --git a/packages/client/lib/client/commands-queue.ts b/packages/client/lib/client/commands-queue.ts
new file mode 100644
index 00000000000..9b7f737113b
--- /dev/null
+++ b/packages/client/lib/client/commands-queue.ts
@@ -0,0 +1,544 @@
+import { DoublyLinkedNode, DoublyLinkedList, EmptyAwareSinglyLinkedList } from './linked-list';
+import encodeCommand from '../RESP/encoder';
+import { Decoder, PUSH_TYPE_MAPPING, RESP_TYPES } from '../RESP/decoder';
+import { TypeMapping, ReplyUnion, RespVersions, RedisArgument } from '../RESP/types';
+import { ChannelListeners, PubSub, PubSubCommand, PubSubListener, PubSubType, PubSubTypeListeners } from './pub-sub';
+import { AbortError, ErrorReply, CommandTimeoutDuringMaintenanceError, TimeoutError } from '../errors';
+import { MonitorCallback } from '.';
+import { dbgMaintenance } from './enterprise-maintenance-manager';
+
+export interface CommandOptions {
+ chainId?: symbol;
+ asap?: boolean;
+ abortSignal?: AbortSignal;
+ /**
+ * Maps between RESP and JavaScript types
+ */
+ typeMapping?: T;
+ /**
+ * Timeout for the command in milliseconds
+ */
+ timeout?: number;
+}
+
+export interface CommandToWrite extends CommandWaitingForReply {
+ args: ReadonlyArray;
+ chainId: symbol | undefined;
+ abort: {
+ signal: AbortSignal;
+ listener: () => unknown;
+ } | undefined;
+ timeout: {
+ signal: AbortSignal;
+ listener: () => unknown;
+ originalTimeout: number | undefined;
+ } | undefined;
+}
+
+interface CommandWaitingForReply {
+ resolve(reply?: unknown): void;
+ reject(err: unknown): void;
+ channelsCounter: number | undefined;
+ typeMapping: TypeMapping | undefined;
+}
+
+export type OnShardedChannelMoved = (channel: string, listeners: ChannelListeners) => void;
+
+const PONG = Buffer.from('pong'),
+ RESET = Buffer.from('RESET');
+
+const RESP2_PUSH_TYPE_MAPPING = {
+ ...PUSH_TYPE_MAPPING,
+ [RESP_TYPES.SIMPLE_STRING]: Buffer
+};
+
+// Try to handle a push notification. Return whether you
+// successfully consumed the notification or not. This is
+// important in order for the queue to be able to pass the
+// notification to another handler if the current one did not
+// succeed.
+type PushHandler = (pushItems: Array) => boolean;
+
+export default class RedisCommandsQueue {
+ readonly #respVersion;
+ readonly #maxLength;
+ readonly #toWrite = new DoublyLinkedList();
+ readonly #waitingForReply = new EmptyAwareSinglyLinkedList();
+ readonly #onShardedChannelMoved;
+ #chainInExecution: symbol | undefined;
+ readonly decoder;
+ readonly #pubSub = new PubSub();
+
+ #pushHandlers: PushHandler[] = [this.#onPush.bind(this)];
+
+ #maintenanceCommandTimeout: number | undefined
+
+ setMaintenanceCommandTimeout(ms: number | undefined) {
+ // Prevent possible api misuse
+ if (this.#maintenanceCommandTimeout === ms) {
+ dbgMaintenance(`Queue already set maintenanceCommandTimeout to ${ms}, skipping`);
+ return;
+ };
+
+ dbgMaintenance(`Setting maintenance command timeout to ${ms}`);
+ this.#maintenanceCommandTimeout = ms;
+
+ if(this.#maintenanceCommandTimeout === undefined) {
+ dbgMaintenance(`Queue will keep maintenanceCommandTimeout for exisitng commands, just to be on the safe side. New commands will receive normal timeouts`);
+ return;
+ }
+
+ let counter = 0;
+ const total = this.#toWrite.length;
+
+ // Overwrite timeouts of all eligible toWrite commands
+ for(const node of this.#toWrite.nodes()) {
+ const command = node.value;
+
+ // Remove timeout listener if it exists
+ RedisCommandsQueue.#removeTimeoutListener(command)
+
+ counter++;
+ const newTimeout = this.#maintenanceCommandTimeout;
+
+ // Overwrite the command's timeout
+ const signal = AbortSignal.timeout(newTimeout);
+ command.timeout = {
+ signal,
+ listener: () => {
+ this.#toWrite.remove(node);
+ command.reject(new CommandTimeoutDuringMaintenanceError(newTimeout));
+ },
+ originalTimeout: command.timeout?.originalTimeout
+ };
+ signal.addEventListener('abort', command.timeout.listener, { once: true });
+ };
+ dbgMaintenance(`Total of ${counter} of ${total} timeouts reset to ${ms}`);
+ }
+
+ get isPubSubActive() {
+ return this.#pubSub.isActive;
+ }
+
+ constructor(
+ respVersion: RespVersions,
+ maxLength: number | null | undefined,
+ onShardedChannelMoved: OnShardedChannelMoved
+ ) {
+ this.#respVersion = respVersion;
+ this.#maxLength = maxLength;
+ this.#onShardedChannelMoved = onShardedChannelMoved;
+ this.decoder = this.#initiateDecoder();
+ }
+
+ #onReply(reply: ReplyUnion) {
+ this.#waitingForReply.shift()!.resolve(reply);
+ }
+
+ #onErrorReply(err: ErrorReply) {
+ this.#waitingForReply.shift()!.reject(err);
+ }
+
+ #onPush(push: Array) {
+ // TODO: type
+ if (this.#pubSub.handleMessageReply(push)) return true;
+
+ const isShardedUnsubscribe = PubSub.isShardedUnsubscribe(push);
+ if (isShardedUnsubscribe && !this.#waitingForReply.length) {
+ const channel = push[1].toString();
+ this.#onShardedChannelMoved(
+ channel,
+ this.#pubSub.removeShardedListeners(channel)
+ );
+ return true;
+ } else if (isShardedUnsubscribe || PubSub.isStatusReply(push)) {
+ const head = this.#waitingForReply.head!.value;
+ if (
+ (Number.isNaN(head.channelsCounter!) && push[2] === 0) ||
+ --head.channelsCounter! === 0
+ ) {
+ this.#waitingForReply.shift()!.resolve();
+ }
+ return true;
+ }
+ return false
+ }
+
+ #getTypeMapping() {
+ return this.#waitingForReply.head!.value.typeMapping ?? {};
+ }
+
+ #initiateDecoder() {
+ return new Decoder({
+ onReply: reply => this.#onReply(reply),
+ onErrorReply: err => this.#onErrorReply(err),
+ //TODO: we can shave off a few cycles by not adding onPush handler at all if CSC is not used
+ onPush: push => {
+ for(const pushHandler of this.#pushHandlers) {
+ if(pushHandler(push)) return
+ }
+ },
+ getTypeMapping: () => this.#getTypeMapping()
+ });
+ }
+
+ addPushHandler(handler: PushHandler): void {
+ this.#pushHandlers.push(handler);
+ }
+
+ async waitForInflightCommandsToComplete(): Promise {
+ // In-flight commands already completed
+ if(this.#waitingForReply.length === 0) {
+ return
+ };
+ // Otherwise wait for in-flight commands to fire `empty` event
+ return new Promise(resolve => {
+ this.#waitingForReply.events.on('empty', resolve)
+ });
+ }
+
+ addCommand(
+ args: ReadonlyArray,
+ options?: CommandOptions
+ ): Promise {
+ if (this.#maxLength && this.#toWrite.length + this.#waitingForReply.length >= this.#maxLength) {
+ return Promise.reject(new Error('The queue is full'));
+ } else if (options?.abortSignal?.aborted) {
+ return Promise.reject(new AbortError());
+ }
+
+ return new Promise((resolve, reject) => {
+ let node: DoublyLinkedNode;
+ const value: CommandToWrite = {
+ args,
+ chainId: options?.chainId,
+ abort: undefined,
+ timeout: undefined,
+ resolve,
+ reject,
+ channelsCounter: undefined,
+ typeMapping: options?.typeMapping
+ };
+
+ // If #maintenanceCommandTimeout was explicitly set, we should
+ // use it instead of the timeout provided by the command
+ const timeout = this.#maintenanceCommandTimeout ?? options?.timeout;
+ const wasInMaintenance = this.#maintenanceCommandTimeout !== undefined;
+ if (timeout) {
+
+ const signal = AbortSignal.timeout(timeout);
+ value.timeout = {
+ signal,
+ listener: () => {
+ this.#toWrite.remove(node);
+ value.reject(wasInMaintenance ? new CommandTimeoutDuringMaintenanceError(timeout) : new TimeoutError());
+ },
+ originalTimeout: options?.timeout
+ };
+ signal.addEventListener('abort', value.timeout.listener, { once: true });
+ }
+
+ const signal = options?.abortSignal;
+ if (signal) {
+ value.abort = {
+ signal,
+ listener: () => {
+ this.#toWrite.remove(node);
+ value.reject(new AbortError());
+ }
+ };
+ signal.addEventListener('abort', value.abort.listener, { once: true });
+ }
+
+ node = this.#toWrite.add(value, options?.asap);
+ });
+ }
+
+ #addPubSubCommand(command: PubSubCommand, asap = false, chainId?: symbol) {
+ return new Promise((resolve, reject) => {
+ this.#toWrite.add({
+ args: command.args,
+ chainId,
+ abort: undefined,
+ timeout: undefined,
+ resolve() {
+ command.resolve();
+ resolve();
+ },
+ reject(err) {
+ command.reject?.();
+ reject(err);
+ },
+ channelsCounter: command.channelsCounter,
+ typeMapping: PUSH_TYPE_MAPPING
+ }, asap);
+ });
+ }
+
+ #setupPubSubHandler() {
+ // RESP3 uses `onPush` to handle PubSub, so no need to modify `onReply`
+ if (this.#respVersion !== 2) return;
+
+ this.decoder.onReply = (reply => {
+ if (Array.isArray(reply)) {
+ if (this.#onPush(reply)) return;
+
+ if (PONG.equals(reply[0] as Buffer)) {
+ const { resolve, typeMapping } = this.#waitingForReply.shift()!,
+ buffer = ((reply[1] as Buffer).length === 0 ? reply[0] : reply[1]) as Buffer;
+ resolve(typeMapping?.[RESP_TYPES.SIMPLE_STRING] === Buffer ? buffer : buffer.toString());
+ return;
+ }
+ }
+
+ return this.#onReply(reply);
+ }) as Decoder['onReply'];
+ this.decoder.getTypeMapping = () => RESP2_PUSH_TYPE_MAPPING;
+ }
+
+ subscribe(
+ type: PubSubType,
+ channels: string | Array,
+ listener: PubSubListener,
+ returnBuffers?: T
+ ) {
+ const command = this.#pubSub.subscribe(type, channels, listener, returnBuffers);
+ if (!command) return;
+
+ this.#setupPubSubHandler();
+ return this.#addPubSubCommand(command);
+ }
+
+ #resetDecoderCallbacks() {
+ this.decoder.onReply = (reply => this.#onReply(reply)) as Decoder['onReply'];
+ this.decoder.getTypeMapping = () => this.#getTypeMapping();
+ }
+
+ unsubscribe(
+ type: PubSubType,
+ channels?: string | Array,
+ listener?: PubSubListener,
+ returnBuffers?: T
+ ) {
+ const command = this.#pubSub.unsubscribe(type, channels, listener, returnBuffers);
+ if (!command) return;
+
+ if (command && this.#respVersion === 2) {
+ // RESP2 modifies `onReply` to handle PubSub (see #setupPubSubHandler)
+ const { resolve } = command;
+ command.resolve = () => {
+ if (!this.#pubSub.isActive) {
+ this.#resetDecoderCallbacks();
+ }
+
+ resolve();
+ };
+ }
+
+ return this.#addPubSubCommand(command);
+ }
+
+ removeAllPubSubListeners() {
+ return this.#pubSub.removeAllListeners();
+ }
+
+ resubscribe(chainId?: symbol) {
+ const commands = this.#pubSub.resubscribe();
+ if (!commands.length) return;
+
+ this.#setupPubSubHandler();
+ return Promise.all(
+ commands.map(command => this.#addPubSubCommand(command, true, chainId))
+ );
+ }
+
+ extendPubSubChannelListeners(
+ type: PubSubType,
+ channel: string,
+ listeners: ChannelListeners
+ ) {
+ const command = this.#pubSub.extendChannelListeners(type, channel, listeners);
+ if (!command) return;
+
+ this.#setupPubSubHandler();
+ return this.#addPubSubCommand(command);
+ }
+
+ extendPubSubListeners(type: PubSubType, listeners: PubSubTypeListeners) {
+ const command = this.#pubSub.extendTypeListeners(type, listeners);
+ if (!command) return;
+
+ this.#setupPubSubHandler();
+ return this.#addPubSubCommand(command);
+ }
+
+ getPubSubListeners(type: PubSubType) {
+ return this.#pubSub.listeners[type];
+ }
+
+ monitor(callback: MonitorCallback, options?: CommandOptions) {
+ return new Promise((resolve, reject) => {
+ const typeMapping = options?.typeMapping ?? {};
+ this.#toWrite.add({
+ args: ['MONITOR'],
+ chainId: options?.chainId,
+ abort: undefined,
+ timeout: undefined,
+ // using `resolve` instead of using `.then`/`await` to make sure it'll be called before processing the next reply
+ resolve: () => {
+ // after running `MONITOR` only `MONITOR` and `RESET` replies are expected
+ // any other command should cause an error
+
+ // if `RESET` already overrides `onReply`, set monitor as it's fallback
+ if (this.#resetFallbackOnReply) {
+ this.#resetFallbackOnReply = callback;
+ } else {
+ this.decoder.onReply = callback;
+ }
+
+ this.decoder.getTypeMapping = () => typeMapping;
+ resolve();
+ },
+ reject,
+ channelsCounter: undefined,
+ typeMapping
+ }, options?.asap);
+ });
+ }
+
+ resetDecoder() {
+ this.#resetDecoderCallbacks();
+ this.decoder.reset();
+ }
+
+ #resetFallbackOnReply?: Decoder['onReply'];
+
+ async reset(chainId: symbol, typeMapping?: T) {
+ return new Promise((resolve, reject) => {
+ // overriding onReply to handle `RESET` while in `MONITOR` or PubSub mode
+ this.#resetFallbackOnReply = this.decoder.onReply;
+ this.decoder.onReply = (reply => {
+ if (
+ (typeof reply === 'string' && reply === 'RESET') ||
+ (reply instanceof Buffer && RESET.equals(reply))
+ ) {
+ this.#resetDecoderCallbacks();
+ this.#resetFallbackOnReply = undefined;
+ this.#pubSub.reset();
+
+ this.#waitingForReply.shift()!.resolve(reply);
+ return;
+ }
+
+ this.#resetFallbackOnReply!(reply);
+ }) as Decoder['onReply'];
+
+ this.#toWrite.push({
+ args: ['RESET'],
+ chainId,
+ abort: undefined,
+ timeout: undefined,
+ resolve,
+ reject,
+ channelsCounter: undefined,
+ typeMapping
+ });
+ });
+ }
+
+ isWaitingToWrite() {
+ return this.#toWrite.length > 0;
+ }
+
+ *commandsToWrite() {
+ let toSend = this.#toWrite.shift();
+ while (toSend) {
+ let encoded: ReadonlyArray
+ try {
+ encoded = encodeCommand(toSend.args);
+ } catch (err) {
+ toSend.reject(err);
+ toSend = this.#toWrite.shift();
+ continue;
+ }
+
+ // TODO reuse `toSend` or create new object?
+ (toSend as any).args = undefined;
+ if (toSend.abort) {
+ RedisCommandsQueue.#removeAbortListener(toSend);
+ toSend.abort = undefined;
+ }
+ if (toSend.timeout) {
+ RedisCommandsQueue.#removeTimeoutListener(toSend);
+ toSend.timeout = undefined;
+ }
+ this.#chainInExecution = toSend.chainId;
+ toSend.chainId = undefined;
+ this.#waitingForReply.push(toSend);
+
+ yield encoded;
+ toSend = this.#toWrite.shift();
+ }
+ }
+
+ #flushWaitingForReply(err: Error): void {
+ for (const node of this.#waitingForReply) {
+ node.reject(err);
+ }
+ this.#waitingForReply.reset();
+ }
+
+ static #removeAbortListener(command: CommandToWrite) {
+ command.abort!.signal.removeEventListener('abort', command.abort!.listener);
+ }
+
+ static #removeTimeoutListener(command: CommandToWrite) {
+ command.timeout?.signal.removeEventListener('abort', command.timeout!.listener);
+ }
+
+ static #flushToWrite(toBeSent: CommandToWrite, err: Error) {
+ if (toBeSent.abort) {
+ RedisCommandsQueue.#removeAbortListener(toBeSent);
+ }
+ if (toBeSent.timeout) {
+ RedisCommandsQueue.#removeTimeoutListener(toBeSent);
+ }
+
+ toBeSent.reject(err);
+ }
+
+ flushWaitingForReply(err: Error): void {
+ this.resetDecoder();
+ this.#pubSub.reset();
+
+ this.#flushWaitingForReply(err);
+
+ if (!this.#chainInExecution) return;
+
+ while (this.#toWrite.head?.value.chainId === this.#chainInExecution) {
+ RedisCommandsQueue.#flushToWrite(
+ this.#toWrite.shift()!,
+ err
+ );
+ }
+
+ this.#chainInExecution = undefined;
+ }
+
+ flushAll(err: Error): void {
+ this.resetDecoder();
+ this.#pubSub.reset();
+ this.#flushWaitingForReply(err);
+ for (const node of this.#toWrite) {
+ RedisCommandsQueue.#flushToWrite(node, err);
+ }
+ this.#toWrite.reset();
+ }
+
+ isEmpty() {
+ return (
+ this.#toWrite.length === 0 &&
+ this.#waitingForReply.length === 0
+ );
+ }
+}
diff --git a/packages/client/lib/client/enterprise-maintenance-manager.spec.ts b/packages/client/lib/client/enterprise-maintenance-manager.spec.ts
new file mode 100644
index 00000000000..59e2bfe8c0a
--- /dev/null
+++ b/packages/client/lib/client/enterprise-maintenance-manager.spec.ts
@@ -0,0 +1,49 @@
+import assert from "node:assert";
+import { createClient } from "../../";
+
+describe("EnterpriseMaintenanceManager does not prevent proper options parsing", () => {
+ it("should not throw when initializing without options", async () => {
+ const client = createClient();
+ assert.doesNotThrow(async () => {
+ //Expected to reject because there is no url or socket provided and there is no running server on localhost
+ await assert.rejects(client.connect);
+ });
+ });
+
+ it("should not throw when initializing without url/socket and with maint", async () => {
+ const client = createClient({
+ maintNotifications: "enabled",
+ RESP: 3,
+ });
+ assert.doesNotThrow(async () => {
+ //Expected to reject because there is no url or socket provided and there is no running server on localhost
+ await assert.rejects(client.connect);
+ });
+ });
+ it("should not throw when initializing with url and with maint", async () => {
+ const client = createClient({
+ maintNotifications: "enabled",
+ RESP: 3,
+ url: "redis://localhost:6379",
+ });
+ assert.doesNotThrow(async () => {
+ //Expected to reject because there is no url or socket provided and there is no running server on localhost
+ await assert.rejects(client.connect);
+ });
+ });
+
+ it("should not throw when initializing with socket and with maint", async () => {
+ const client = createClient({
+ maintNotifications: "enabled",
+ RESP: 3,
+ socket: {
+ host: "localhost",
+ port: 6379,
+ },
+ });
+ assert.doesNotThrow(async () => {
+ //Expected to reject because there is no url or socket provided and there is no running server on localhost
+ await assert.rejects(client.connect);
+ });
+ });
+});
diff --git a/packages/client/lib/client/enterprise-maintenance-manager.ts b/packages/client/lib/client/enterprise-maintenance-manager.ts
new file mode 100644
index 00000000000..9892a5be8a4
--- /dev/null
+++ b/packages/client/lib/client/enterprise-maintenance-manager.ts
@@ -0,0 +1,359 @@
+import { RedisClientOptions } from ".";
+import RedisCommandsQueue from "./commands-queue";
+import { RedisArgument } from "../..";
+import { isIP } from "net";
+import { lookup } from "dns/promises";
+import assert from "node:assert";
+import { setTimeout } from "node:timers/promises";
+import RedisSocket, { RedisTcpSocketOptions } from "./socket";
+import diagnostics_channel from "node:diagnostics_channel";
+
+export const MAINTENANCE_EVENTS = {
+ PAUSE_WRITING: "pause-writing",
+ RESUME_WRITING: "resume-writing",
+ TIMEOUTS_UPDATE: "timeouts-update",
+} as const;
+
+const PN = {
+ MOVING: "MOVING",
+ MIGRATING: "MIGRATING",
+ MIGRATED: "MIGRATED",
+ FAILING_OVER: "FAILING_OVER",
+ FAILED_OVER: "FAILED_OVER",
+};
+
+export type DiagnosticsEvent = {
+ type: string;
+ timestamp: number;
+ data?: Object;
+};
+
+export const dbgMaintenance = (...args: any[]) => {
+ if (!process.env.REDIS_DEBUG_MAINTENANCE) return;
+ return console.log("[MNT]", ...args);
+};
+
+export const emitDiagnostics = (event: DiagnosticsEvent) => {
+ if (!process.env.REDIS_EMIT_DIAGNOSTICS) return;
+
+ const channel = diagnostics_channel.channel("redis.maintenance");
+ channel.publish(event);
+};
+
+export interface MaintenanceUpdate {
+ relaxedCommandTimeout?: number;
+ relaxedSocketTimeout?: number;
+}
+
+interface Client {
+ _ejectSocket: () => RedisSocket;
+ _insertSocket: (socket: RedisSocket) => void;
+ _pause: () => void;
+ _unpause: () => void;
+ _maintenanceUpdate: (update: MaintenanceUpdate) => void;
+ duplicate: () => Client;
+ connect: () => Promise;
+ destroy: () => void;
+ on: (event: string, callback: (value: unknown) => void) => void;
+}
+
+export default class EnterpriseMaintenanceManager {
+ #commandsQueue: RedisCommandsQueue;
+ #options: RedisClientOptions;
+ #isMaintenance = 0;
+ #client: Client;
+
+ static setupDefaultMaintOptions(options: RedisClientOptions) {
+ if (options.maintNotifications === undefined) {
+ options.maintNotifications =
+ options?.RESP === 3 ? "auto" : "disabled";
+ }
+ if (options.maintEndpointType === undefined) {
+ options.maintEndpointType = "auto";
+ }
+ if (options.maintRelaxedSocketTimeout === undefined) {
+ options.maintRelaxedSocketTimeout = 10000;
+ }
+ if (options.maintRelaxedCommandTimeout === undefined) {
+ options.maintRelaxedCommandTimeout = 10000;
+ }
+ }
+
+ static async getHandshakeCommand(
+ options: RedisClientOptions,
+ ): Promise<
+ | { cmd: Array; errorHandler: (error: Error) => void }
+ | undefined
+ > {
+ if (options.maintNotifications === "disabled") return;
+
+ const host = options.url
+ ? new URL(options.url).hostname
+ : (options.socket as RedisTcpSocketOptions | undefined)?.host;
+
+ if (!host) return;
+
+ const tls = options.socket?.tls ?? false
+
+ const movingEndpointType = await determineEndpoint(tls, host, options);
+ return {
+ cmd: [
+ "CLIENT",
+ "MAINT_NOTIFICATIONS",
+ "ON",
+ "moving-endpoint-type",
+ movingEndpointType,
+ ],
+ errorHandler: (error: Error) => {
+ dbgMaintenance("handshake failed:", error);
+ if (options.maintNotifications === "enabled") {
+ throw error;
+ }
+ },
+ };
+ }
+
+ constructor(
+ commandsQueue: RedisCommandsQueue,
+ client: Client,
+ options: RedisClientOptions,
+ ) {
+ this.#commandsQueue = commandsQueue;
+ this.#options = options;
+ this.#client = client;
+
+ this.#commandsQueue.addPushHandler(this.#onPush);
+ }
+
+ #onPush = (push: Array): boolean => {
+ dbgMaintenance("ONPUSH:", push.map(String));
+
+ if (!Array.isArray(push) || !["MOVING", "MIGRATING", "MIGRATED", "FAILING_OVER", "FAILED_OVER"].includes(String(push[0]))) {
+ return false;
+ }
+
+ const type = String(push[0]);
+
+ emitDiagnostics({
+ type,
+ timestamp: Date.now(),
+ data: {
+ push: push.map(String),
+ },
+ });
+ switch (type) {
+ case PN.MOVING: {
+ // [ 'MOVING', '17', '15', '54.78.247.156:12075' ]
+ // ^seq ^after ^new ip
+ const afterSeconds = push[2];
+ const url: string | null = push[3] ? String(push[3]) : null;
+ dbgMaintenance("Received MOVING:", afterSeconds, url);
+ this.#onMoving(afterSeconds, url);
+ return true;
+ }
+ case PN.MIGRATING:
+ case PN.FAILING_OVER: {
+ dbgMaintenance("Received MIGRATING|FAILING_OVER");
+ this.#onMigrating();
+ return true;
+ }
+ case PN.MIGRATED:
+ case PN.FAILED_OVER: {
+ dbgMaintenance("Received MIGRATED|FAILED_OVER");
+ this.#onMigrated();
+ return true;
+ }
+ }
+ return false;
+ };
+
+ // Queue:
+ // toWrite [ C D E ]
+ // waitingForReply [ A B ] - aka In-flight commands
+ //
+ // time: ---1-2---3-4-5-6---------------------------
+ //
+ // 1. [EVENT] MOVING PN received
+ // 2. [ACTION] Pause writing ( we need to wait for new socket to connect and for all in-flight commands to complete )
+ // 3. [EVENT] New socket connected
+ // 4. [EVENT] In-flight commands completed
+ // 5. [ACTION] Destroy old socket
+ // 6. [ACTION] Resume writing -> we are going to write to the new socket from now on
+ #onMoving = async (
+ afterSeconds: number,
+ url: string | null,
+ ): Promise => {
+ // 1 [EVENT] MOVING PN received
+ this.#onMigrating();
+
+ let host: string;
+ let port: number;
+
+ // The special value `none` indicates that the `MOVING` message doesnβt need
+ // to contain an endpoint. Instead it contains the value `null` then. In
+ // such a corner case, the client is expected to schedule a graceful
+ // reconnect to its currently configured endpoint after half of the grace
+ // period that was communicated by the server is over.
+ if (url === null) {
+ assert(this.#options.maintEndpointType === "none");
+ assert(this.#options.socket !== undefined);
+ assert("host" in this.#options.socket);
+ assert(typeof this.#options.socket.host === "string");
+ host = this.#options.socket.host;
+ assert(typeof this.#options.socket.port === "number");
+ port = this.#options.socket.port;
+ const waitTime = (afterSeconds * 1000) / 2;
+ dbgMaintenance(`Wait for ${waitTime}ms`);
+ await setTimeout(waitTime);
+ } else {
+ const split = url.split(":");
+ host = split[0];
+ port = Number(split[1]);
+ }
+
+ // 2 [ACTION] Pause writing
+ dbgMaintenance("Pausing writing of new commands to old socket");
+ this.#client._pause();
+
+ dbgMaintenance("Creating new tmp client");
+ let start = performance.now();
+
+ // If the URL is provided, it takes precedense
+ // the options object could just be mutated
+ if(this.#options.url) {
+ const u = new URL(this.#options.url);
+ u.hostname = host;
+ u.port = String(port);
+ this.#options.url = u.toString();
+ } else {
+ this.#options.socket = {
+ ...this.#options.socket,
+ host,
+ port
+ }
+ }
+ const tmpClient = this.#client.duplicate();
+ tmpClient.on('error', (error: unknown) => {
+ //We dont know how to handle tmp client errors
+ dbgMaintenance(`[ERR]`, error)
+ });
+ dbgMaintenance(`Tmp client created in ${( performance.now() - start ).toFixed(2)}ms`);
+ dbgMaintenance(
+ `Set timeout for tmp client to ${this.#options.maintRelaxedSocketTimeout}`,
+ );
+ tmpClient._maintenanceUpdate({
+ relaxedCommandTimeout: this.#options.maintRelaxedCommandTimeout,
+ relaxedSocketTimeout: this.#options.maintRelaxedSocketTimeout,
+ });
+ dbgMaintenance(`Connecting tmp client: ${host}:${port}`);
+ start = performance.now();
+ await tmpClient.connect();
+ dbgMaintenance(`Connected to tmp client in ${(performance.now() - start).toFixed(2)}ms`);
+ // 3 [EVENT] New socket connected
+
+ dbgMaintenance(`Wait for all in-flight commands to complete`);
+ await this.#commandsQueue.waitForInflightCommandsToComplete();
+ dbgMaintenance(`In-flight commands completed`);
+ // 4 [EVENT] In-flight commands completed
+
+ dbgMaintenance("Swap client sockets...");
+ const oldSocket = this.#client._ejectSocket();
+ const newSocket = tmpClient._ejectSocket();
+ this.#client._insertSocket(newSocket);
+ tmpClient._insertSocket(oldSocket);
+ tmpClient.destroy();
+ dbgMaintenance("Swap client sockets done.");
+ // 5 + 6
+ dbgMaintenance("Resume writing");
+ this.#client._unpause();
+ this.#onMigrated();
+ };
+
+ #onMigrating = () => {
+ this.#isMaintenance++;
+ if (this.#isMaintenance > 1) {
+ dbgMaintenance(`Timeout relaxation already done`);
+ return;
+ }
+
+ const update: MaintenanceUpdate = {
+ relaxedCommandTimeout: this.#options.maintRelaxedCommandTimeout,
+ relaxedSocketTimeout: this.#options.maintRelaxedSocketTimeout,
+ };
+
+ this.#client._maintenanceUpdate(update);
+ };
+
+ #onMigrated = () => {
+ //ensure that #isMaintenance doesnt go under 0
+ this.#isMaintenance = Math.max(this.#isMaintenance - 1, 0);
+ if (this.#isMaintenance > 0) {
+ dbgMaintenance(`Not ready to unrelax timeouts yet`);
+ return;
+ }
+
+ const update: MaintenanceUpdate = {
+ relaxedCommandTimeout: undefined,
+ relaxedSocketTimeout: undefined
+ };
+
+ this.#client._maintenanceUpdate(update);
+ };
+}
+
+export type MovingEndpointType =
+ | "auto"
+ | "internal-ip"
+ | "internal-fqdn"
+ | "external-ip"
+ | "external-fqdn"
+ | "none";
+
+function isPrivateIP(ip: string): boolean {
+ const version = isIP(ip);
+ if (version === 4) {
+ const octets = ip.split(".").map(Number);
+ return (
+ octets[0] === 10 ||
+ (octets[0] === 172 && octets[1] >= 16 && octets[1] <= 31) ||
+ (octets[0] === 192 && octets[1] === 168)
+ );
+ }
+ if (version === 6) {
+ return (
+ ip.startsWith("fc") || // Unique local
+ ip.startsWith("fd") || // Unique local
+ ip === "::1" || // Loopback
+ ip.startsWith("fe80") // Link-local unicast
+ );
+ }
+ return false;
+}
+
+async function determineEndpoint(
+ tlsEnabled: boolean,
+ host: string,
+ options: RedisClientOptions,
+): Promise {
+ assert(options.maintEndpointType !== undefined);
+ if (options.maintEndpointType !== "auto") {
+ dbgMaintenance(
+ `Determine endpoint type: ${options.maintEndpointType}`,
+ );
+ return options.maintEndpointType;
+ }
+
+ const ip = isIP(host) ? host : (await lookup(host, { family: 0 })).address;
+
+ const isPrivate = isPrivateIP(ip);
+
+ let result: MovingEndpointType;
+ if (tlsEnabled) {
+ result = isPrivate ? "internal-fqdn" : "external-fqdn";
+ } else {
+ result = isPrivate ? "internal-ip" : "external-ip";
+ }
+
+ dbgMaintenance(`Determine endpoint type: ${result}`);
+ return result;
+}
diff --git a/packages/client/lib/client/index.spec.ts b/packages/client/lib/client/index.spec.ts
new file mode 100644
index 00000000000..d7ce00f38ae
--- /dev/null
+++ b/packages/client/lib/client/index.spec.ts
@@ -0,0 +1,1031 @@
+import { strict as assert } from 'node:assert';
+import testUtils, { GLOBAL, waitTillBeenCalled } from '../test-utils';
+import RedisClient, { RedisClientOptions, RedisClientType } from '.';
+import { AbortError, ClientClosedError, ClientOfflineError, ConnectionTimeoutError, DisconnectsClientError, ErrorReply, MultiErrorReply, TimeoutError, WatchError } from '../errors';
+import { defineScript } from '../lua-script';
+import { spy, stub } from 'sinon';
+import { once } from 'node:events';
+import { MATH_FUNCTION, loadMathFunction } from '../commands/FUNCTION_LOAD.spec';
+import { RESP_TYPES } from '../RESP/decoder';
+import { BlobStringReply, NumberReply } from '../RESP/types';
+import { SortedSetMember } from '../commands/generic-transformers';
+import { CommandParser } from './parser';
+
+export const SQUARE_SCRIPT = defineScript({
+ SCRIPT:
+ `local number = redis.call('GET', KEYS[1])
+ return number * number`,
+ NUMBER_OF_KEYS: 1,
+ FIRST_KEY_INDEX: 0,
+ parseCommand(parser: CommandParser, key: string) {
+ parser.pushKey(key);
+ },
+ transformReply: undefined as unknown as () => NumberReply
+});
+
+describe('Client', () => {
+ describe('initialization', () => {
+ describe('clientSideCache validation', () => {
+ const clientSideCacheConfig = { ttl: 0, maxEntries: 0 };
+
+ it('should throw error when clientSideCache is enabled with RESP 2', () => {
+ assert.throws(
+ () => new RedisClient({
+ clientSideCache: clientSideCacheConfig,
+ RESP: 2,
+ }),
+ new Error('Client Side Caching is only supported with RESP3')
+ );
+ });
+
+ it('should throw error when clientSideCache is enabled with RESP undefined', () => {
+ assert.throws(
+ () => new RedisClient({
+ clientSideCache: clientSideCacheConfig,
+ }),
+ new Error('Client Side Caching is only supported with RESP3')
+ );
+ });
+
+ it('should not throw when clientSideCache is enabled with RESP 3', () => {
+ assert.doesNotThrow(() =>
+ new RedisClient({
+ clientSideCache: clientSideCacheConfig,
+ RESP: 3,
+ })
+ );
+ });
+ });
+ });
+
+ describe('parseURL', () => {
+ it('redis://user:secret@localhost:6379/0', async () => {
+ const result = RedisClient.parseURL('redis://user:secret@localhost:6379/0');
+ const expected: RedisClientOptions = {
+ socket: {
+ host: 'localhost',
+ port: 6379,
+ tls: false
+ },
+ username: 'user',
+ password: 'secret',
+ database: 0,
+ credentialsProvider: {
+ type: 'async-credentials-provider',
+ credentials: async () => ({
+ password: 'secret',
+ username: 'user'
+ })
+ }
+ };
+
+ // Compare everything except the credentials function
+ const { credentialsProvider: resultCredProvider, ...resultRest } = result;
+ const { credentialsProvider: expectedCredProvider, ...expectedRest } = expected;
+
+ // Compare non-function properties
+ assert.deepEqual(resultRest, expectedRest);
+
+ if (result?.credentialsProvider?.type === 'async-credentials-provider'
+ && expected?.credentialsProvider?.type === 'async-credentials-provider') {
+
+ // Compare the actual output of the credentials functions
+ const resultCreds = await result.credentialsProvider?.credentials();
+ const expectedCreds = await expected.credentialsProvider?.credentials();
+ assert.deepEqual(resultCreds, expectedCreds);
+ } else {
+ assert.fail('Credentials provider type mismatch');
+ }
+
+
+ });
+
+ it('rediss://user:secret@localhost:6379/0', async () => {
+ const result = RedisClient.parseURL('rediss://user:secret@localhost:6379/0');
+ const expected: RedisClientOptions = {
+ socket: {
+ host: 'localhost',
+ port: 6379,
+ tls: true
+ },
+ username: 'user',
+ password: 'secret',
+ database: 0,
+ credentialsProvider: {
+ credentials: async () => ({
+ password: 'secret',
+ username: 'user'
+ }),
+ type: 'async-credentials-provider'
+ }
+ };
+
+ // Compare everything except the credentials function
+ const { credentialsProvider: resultCredProvider, ...resultRest } = result;
+ const { credentialsProvider: expectedCredProvider, ...expectedRest } = expected;
+
+ // Compare non-function properties
+ assert.deepEqual(resultRest, expectedRest);
+ assert.equal(resultCredProvider?.type, expectedCredProvider?.type);
+
+ if (result?.credentialsProvider?.type === 'async-credentials-provider' &&
+ expected?.credentialsProvider?.type === 'async-credentials-provider') {
+
+ // Compare the actual output of the credentials functions
+ const resultCreds = await result.credentialsProvider.credentials();
+ const expectedCreds = await expected.credentialsProvider.credentials();
+ assert.deepEqual(resultCreds, expectedCreds);
+
+ } else {
+ assert.fail('Credentials provider type mismatch');
+ }
+
+ })
+
+ it('Invalid protocol', () => {
+ assert.throws(
+ () => RedisClient.parseURL('redi://user:secret@localhost:6379/0'),
+ TypeError
+ );
+ });
+
+ it('Invalid pathname', () => {
+ assert.throws(
+ () => RedisClient.parseURL('redis://user:secret@localhost:6379/NaN'),
+ TypeError
+ );
+ });
+
+ it('redis://localhost', () => {
+ assert.deepEqual(
+ RedisClient.parseURL('redis://localhost'),
+ {
+ socket: {
+ host: 'localhost',
+ tls: false
+ }
+ }
+ );
+ });
+
+ it('DB in URL should be parsed', async () => {
+ const client = RedisClient.create({
+ url: 'redis://user:secret@localhost:6379/5'
+ });
+
+ assert.equal(client?.options?.database, 5);
+ })
+ });
+
+ describe('parseOptions', () => {
+ it('should throw error if tls socket option is set to true and the url protocol is "redis:"', () => {
+ assert.throws(
+ () => RedisClient.parseOptions({
+ url: 'redis://localhost',
+ socket: {
+ tls: true
+ }
+ }),
+ TypeError
+ );
+ });
+ it('should throw error if tls socket option is set to false and the url protocol is "rediss:"', () => {
+ assert.throws(
+ () => RedisClient.parseOptions({
+ url: 'rediss://localhost',
+ socket: {
+ tls: false
+ }
+ }),
+ TypeError
+ );
+ });
+ it('should not throw when tls socket option and url protocol matches"', () => {
+ assert.equal(
+ RedisClient.parseOptions({
+ url: 'rediss://localhost',
+ socket: {
+ tls: true
+ }
+ }).socket.tls,
+ true
+ );
+ assert.equal(
+ RedisClient.parseOptions({
+ url: 'redis://localhost',
+ socket: {
+ tls: false
+ }
+ }).socket.tls,
+ false
+ );
+ });
+ });
+
+ describe('authentication', () => {
+ testUtils.testWithClient('Client should be authenticated', async client => {
+ assert.equal(
+ await client.ping(),
+ 'PONG'
+ );
+ }, GLOBAL.SERVERS.PASSWORD);
+
+ testUtils.testWithClient('Client can authenticate asynchronously ', async client => {
+ assert.equal(
+ await client.ping(),
+ 'PONG'
+ );
+ }, GLOBAL.SERVERS.ASYNC_BASIC_AUTH);
+
+ testUtils.testWithClient('Client can authenticate using the streaming credentials provider for initial token acquisition',
+ async client => {
+ assert.equal(
+ await client.ping(),
+ 'PONG'
+ );
+ }, GLOBAL.SERVERS.STREAMING_AUTH);
+
+ testUtils.testWithClient('should execute AUTH before SELECT', async client => {
+ assert.equal(
+ (await client.clientInfo()).db,
+ 2
+ );
+ }, {
+ ...GLOBAL.SERVERS.PASSWORD,
+ clientOptions: {
+ ...GLOBAL.SERVERS.PASSWORD.clientOptions,
+ database: 2
+ },
+ minimumDockerVersion: [6, 2]
+ });
+ });
+
+ testUtils.testWithClient('should set connection name', async client => {
+ assert.equal(
+ await client.clientGetName(),
+ 'name'
+ );
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ name: 'name'
+ }
+ });
+
+ // TODO: fix & uncomment
+ // testUtils.testWithClient('connect, ready and end events', async client => {
+ // await Promise.all([
+ // once(client, 'connect'),
+ // once(client, 'ready'),
+ // client.connect()
+ // ]);
+
+ // await Promise.all([
+ // once(client, 'end'),
+ // client.close()
+ // ]);
+ // }, {
+ // ...GLOBAL.SERVERS.OPEN,
+ // disableClientSetup: true
+ // });
+
+ describe('sendCommand', () => {
+ testUtils.testWithClient('PING', async client => {
+ assert.equal(await client.sendCommand(['PING']), 'PONG');
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('Unactivated AbortController should not abort', async client => {
+ await client.sendCommand(['PING'], {
+ abortSignal: new AbortController().signal
+ });
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('AbortError', async client => {
+ await blockSetImmediate(async () => {
+ await assert.rejects(client.sendCommand(['PING'], {
+ abortSignal: AbortSignal.timeout(5)
+ }), AbortError);
+ })
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('Timeout with custom timeout config', async client => {
+ await blockSetImmediate(async () => {
+ await assert.rejects(client.sendCommand(['PING'], {
+ timeout: 5
+ }), TimeoutError);
+ })
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithCluster('Timeout with custom timeout config (cluster)', async cluster => {
+ await blockSetImmediate(async () => {
+ await assert.rejects(cluster.sendCommand(undefined, true, ['PING'], {
+ timeout: 5
+ }), TimeoutError);
+ })
+ }, GLOBAL.CLUSTERS.OPEN);
+
+ testUtils.testWithClientSentinel('Timeout with custom timeout config (sentinel)', async sentinel => {
+ await blockSetImmediate(async () => {
+ await assert.rejects(sentinel.sendCommand(true, ['PING'], {
+ timeout: 5
+ }), TimeoutError);
+ })
+ }, GLOBAL.CLUSTERS.OPEN);
+
+ testUtils.testWithClient('Timeout with global timeout config', async client => {
+ await blockSetImmediate(async () => {
+ await assert.rejects(client.ping(), TimeoutError);
+ await assert.rejects(client.sendCommand(['PING']), TimeoutError);
+ });
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ commandOptions: {
+ timeout: 5
+ }
+ }
+ });
+
+ testUtils.testWithCluster('Timeout with global timeout config (cluster)', async cluster => {
+ await blockSetImmediate(async () => {
+ await assert.rejects(cluster.HSET('key', 'foo', 'value'), TimeoutError);
+ await assert.rejects(cluster.sendCommand(undefined, true, ['PING']), TimeoutError);
+ });
+ }, {
+ ...GLOBAL.CLUSTERS.OPEN,
+ clusterConfiguration: {
+ commandOptions: {
+ timeout: 5
+ }
+ }
+ });
+
+ testUtils.testWithClientSentinel('Timeout with global timeout config (sentinel)', async sentinel => {
+ await blockSetImmediate(async () => {
+ await assert.rejects(sentinel.HSET('key', 'foo', 'value'), TimeoutError);
+ await assert.rejects(sentinel.sendCommand(true, ['PING']), TimeoutError);
+ });
+ }, {
+ ...GLOBAL.SENTINEL.OPEN,
+ clientOptions: {
+ commandOptions: {
+ timeout: 5
+ }
+ }
+ });
+
+ testUtils.testWithClient('undefined and null should not break the client', async client => {
+ await assert.rejects(
+ client.sendCommand([null as any, undefined as any]),
+ TypeError
+ );
+
+ assert.equal(
+ await client.ping(),
+ 'PONG'
+ );
+ }, GLOBAL.SERVERS.OPEN);
+ });
+
+ describe('multi', () => {
+ testUtils.testWithClient('simple', async client => {
+ assert.deepEqual(
+ await client.multi()
+ .ping()
+ .set('key', 'value')
+ .get('key')
+ .exec(),
+ ['PONG', 'OK', 'value']
+ );
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('should reject the whole chain on error', client => {
+ return assert.rejects(
+ client.multi()
+ .ping()
+ .addCommand(['INVALID COMMAND'])
+ .ping()
+ .exec()
+ );
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('should reject the whole chain upon client disconnect', async client => {
+ await client.close();
+
+ return assert.rejects(
+ client.multi()
+ .ping()
+ .set('key', 'value')
+ .get('key')
+ .exec(),
+ ClientClosedError
+ );
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('with script', async client => {
+ assert.deepEqual(
+ await client.multi()
+ .set('key', '2')
+ .square('key')
+ .exec(),
+ ['OK', 4]
+ );
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ scripts: {
+ square: SQUARE_SCRIPT
+ }
+ }
+ });
+
+ testUtils.testWithClient('WatchError', async client => {
+ await client.watch('key');
+
+ const duplicate = await client.duplicate().connect();
+ try {
+ await client.set(
+ 'key',
+ '1'
+ );
+ } finally {
+ duplicate.destroy();
+ }
+
+ await assert.rejects(
+ client.multi()
+ .decr('key')
+ .exec(),
+ WatchError
+ );
+ }, GLOBAL.SERVERS.OPEN);
+
+ describe('execAsPipeline', () => {
+ testUtils.testWithClient('exec(true)', async client => {
+ assert.deepEqual(
+ await client.multi()
+ .ping()
+ .exec(true),
+ ['PONG']
+ );
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('empty execAsPipeline', async client => {
+ assert.deepEqual(
+ await client.multi().execAsPipeline(),
+ []
+ );
+ }, GLOBAL.SERVERS.OPEN);
+ });
+
+ testUtils.testWithClient('should remember selected db', async client => {
+ await client.multi()
+ .select(1)
+ .exec();
+ await killClient(client);
+ assert.equal(
+ (await client.clientInfo()).db,
+ 1
+ );
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ minimumDockerVersion: [6, 2] // CLIENT INFO
+ });
+
+ testUtils.testWithClient('should handle error replies (#2665)', async client => {
+ await assert.rejects(
+ client.multi()
+ .set('key', 'value')
+ .hGetAll('key')
+ .exec(),
+ err => {
+ assert.ok(err instanceof MultiErrorReply);
+ assert.equal(err.replies.length, 2);
+ assert.deepEqual(err.errorIndexes, [1]);
+ assert.ok(err.replies[1] instanceof ErrorReply);
+ // @ts-ignore TS2802
+ assert.deepEqual([...err.errors()], [err.replies[1]]);
+ return true;
+ }
+ );
+ }, GLOBAL.SERVERS.OPEN);
+ });
+
+ testUtils.testWithClient('scripts', async client => {
+ const [, reply] = await Promise.all([
+ client.set('key', '2'),
+ client.square('key')
+ ]);
+
+ assert.equal(reply, 4);
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ scripts: {
+ square: SQUARE_SCRIPT
+ }
+ }
+ });
+
+ const module = {
+ echo: {
+ parseCommand(parser: CommandParser, message: string) {
+ parser.push('ECHO', message);
+ },
+ transformReply: undefined as unknown as () => BlobStringReply
+ }
+ };
+
+ testUtils.testWithClient('modules', async client => {
+ assert.equal(
+ await client.module.echo('message'),
+ 'message'
+ );
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ modules: {
+ module
+ }
+ }
+ });
+
+ testUtils.testWithClient('functions', async client => {
+ const [, , reply] = await Promise.all([
+ loadMathFunction(client),
+ client.set('key', '2'),
+ client.math.square('key')
+ ]);
+
+ assert.equal(reply, 4);
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ minimumDockerVersion: [7, 0],
+ clientOptions: {
+ functions: {
+ math: MATH_FUNCTION.library
+ }
+ }
+ });
+
+ testUtils.testWithClient('duplicate should reuse command options', async client => {
+ const duplicate = client.duplicate();
+
+ await duplicate.connect();
+
+ try {
+ assert.deepEqual(
+ await duplicate.ping(),
+ Buffer.from('PONG')
+ );
+ } finally {
+ duplicate.close();
+ }
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ commandOptions: {
+ typeMapping: {
+ [RESP_TYPES.SIMPLE_STRING]: Buffer
+ }
+ }
+ },
+ disableClientSetup: true,
+ });
+
+ async function killClient(
+ client: RedisClientType,
+ errorClient: RedisClientType = client
+ ): Promise {
+ const onceErrorPromise = once(errorClient, 'error');
+ await client.sendCommand(['QUIT']);
+ await Promise.all([
+ onceErrorPromise,
+ assert.rejects(client.ping())
+ ]);
+ }
+
+ testUtils.testWithClient('should reconnect when socket disconnects', async client => {
+ await killClient(client);
+ await assert.doesNotReject(client.ping());
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('should remember selected db', async client => {
+ await client.select(1);
+ await killClient(client);
+ assert.equal(
+ (await client.clientInfo()).db,
+ 1
+ );
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ minimumDockerVersion: [6, 2] // CLIENT INFO
+ });
+
+ testUtils.testWithClient('scanIterator', async client => {
+ const entries: Array = [],
+ keys = new Set();
+ for (let i = 0; i < 100; i++) {
+ const key = i.toString();
+ keys.add(key);
+ entries.push(key, '');
+ }
+
+ await client.mSet(entries);
+
+ const results = new Set();
+ for await (const keys of client.scanIterator()) {
+ for (const key of keys) {
+ results.add(key);
+ }
+ }
+
+ assert.deepEqual(keys, results);
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('hScanIterator', async client => {
+ const hash: Record = {};
+ for (let i = 0; i < 100; i++) {
+ hash[i.toString()] = i.toString();
+ }
+
+ await client.hSet('key', hash);
+
+ const results: Record = {};
+ for await (const entries of client.hScanIterator('key')) {
+ for (const { field, value } of entries) {
+ results[field] = value;
+ }
+ }
+
+ assert.deepEqual(hash, results);
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('hScanNoValuesIterator', async client => {
+ const hash: Record = {};
+ const expectedFields: Array = [];
+ for (let i = 0; i < 100; i++) {
+ hash[i.toString()] = i.toString();
+ expectedFields.push(i.toString());
+ }
+
+ await client.hSet('key', hash);
+
+ const actualFields: Array = [];
+ for await (const fields of client.hScanNoValuesIterator('key')) {
+ for (const field of fields) {
+ actualFields.push(field);
+ }
+ }
+
+ function sort(a: string, b: string) {
+ return Number(a) - Number(b);
+ }
+
+ assert.deepEqual(actualFields.sort(sort), expectedFields);
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ minimumDockerVersion: [7, 4]
+ });
+
+ testUtils.testWithClient('sScanIterator', async client => {
+ const members = new Set();
+ for (let i = 0; i < 100; i++) {
+ members.add(i.toString());
+ }
+
+ await client.sAdd('key', Array.from(members));
+
+ const results = new Set();
+ for await (const members of client.sScanIterator('key')) {
+ for (const member of members) {
+ results.add(member);
+ }
+ }
+
+ assert.deepEqual(members, results);
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('zScanIterator', async client => {
+ const members: Array = [],
+ map = new Map();
+ for (let i = 0; i < 100; i++) {
+ const member = {
+ value: i.toString(),
+ score: 1
+ };
+ map.set(member.value, member.score);
+ members.push(member);
+ }
+
+ await client.zAdd('key', members);
+
+ const results = new Map();
+ for await (const members of client.zScanIterator('key')) {
+ for (const { value, score } of members) {
+ results.set(value, score);
+ }
+ }
+
+ assert.deepEqual(map, results);
+ }, GLOBAL.SERVERS.OPEN);
+
+ describe('PubSub', () => {
+ testUtils.testWithClient('should be able to publish and subscribe to messages', async publisher => {
+ function assertStringListener(message: string, channel: string) {
+ assert.equal(typeof message, 'string');
+ assert.equal(typeof channel, 'string');
+ }
+
+ function assertBufferListener(message: Buffer, channel: Buffer) {
+ assert.ok(message instanceof Buffer);
+ assert.ok(channel instanceof Buffer);
+ }
+
+ const subscriber = await publisher.duplicate().connect();
+
+ try {
+ const channelListener1 = spy(assertBufferListener),
+ channelListener2 = spy(assertStringListener),
+ patternListener = spy(assertStringListener);
+
+ await Promise.all([
+ subscriber.subscribe('channel', channelListener1, true),
+ subscriber.subscribe('channel', channelListener2),
+ subscriber.pSubscribe('channel*', patternListener)
+ ]);
+ await Promise.all([
+ waitTillBeenCalled(channelListener1),
+ waitTillBeenCalled(channelListener2),
+ waitTillBeenCalled(patternListener),
+ publisher.publish(Buffer.from('channel'), Buffer.from('message'))
+ ]);
+ assert.ok(channelListener1.calledOnceWithExactly(Buffer.from('message'), Buffer.from('channel')));
+ assert.ok(channelListener2.calledOnceWithExactly('message', 'channel'));
+ assert.ok(patternListener.calledOnceWithExactly('message', 'channel'));
+
+ await subscriber.unsubscribe('channel', channelListener1, true);
+ await Promise.all([
+ waitTillBeenCalled(channelListener2),
+ waitTillBeenCalled(patternListener),
+ publisher.publish('channel', 'message')
+ ]);
+ assert.ok(channelListener1.calledOnce);
+ assert.ok(channelListener2.calledTwice);
+ assert.ok(channelListener2.secondCall.calledWithExactly('message', 'channel'));
+ assert.ok(patternListener.calledTwice);
+ assert.ok(patternListener.secondCall.calledWithExactly('message', 'channel'));
+ await subscriber.unsubscribe('channel');
+ await Promise.all([
+ waitTillBeenCalled(patternListener),
+ publisher.publish('channel', 'message')
+ ]);
+ assert.ok(channelListener1.calledOnce);
+ assert.ok(channelListener2.calledTwice);
+ assert.ok(patternListener.calledThrice);
+ assert.ok(patternListener.thirdCall.calledWithExactly('message', 'channel'));
+
+ await subscriber.pUnsubscribe();
+ await publisher.publish('channel', 'message');
+ assert.ok(channelListener1.calledOnce);
+ assert.ok(channelListener2.calledTwice);
+ assert.ok(patternListener.calledThrice);
+
+ // should be able to send commands when unsubsribed from all channels (see #1652)
+ await assert.doesNotReject(subscriber.ping());
+ } finally {
+ subscriber.destroy();
+ }
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('should resubscribe', async publisher => {
+ const subscriber = await publisher.duplicate().connect();
+
+ try {
+ const channelListener = spy();
+ await subscriber.subscribe('channel', channelListener);
+
+ const patternListener = spy();
+ await subscriber.pSubscribe('channe*', patternListener);
+
+ await Promise.all([
+ once(subscriber, 'error'),
+ publisher.clientKill({
+ filter: 'SKIPME',
+ skipMe: true
+ })
+ ]);
+
+ await once(subscriber, 'ready');
+
+ await Promise.all([
+ waitTillBeenCalled(channelListener),
+ waitTillBeenCalled(patternListener),
+ publisher.publish('channel', 'message')
+ ]);
+ } finally {
+ subscriber.destroy();
+ }
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('should not fail when message arrives right after subscribe', async publisher => {
+ const subscriber = await publisher.duplicate().connect();
+
+ try {
+ await assert.doesNotReject(Promise.all([
+ subscriber.subscribe('channel', () => {
+ // noop
+ }),
+ publisher.publish('channel', 'message')
+ ]));
+ } finally {
+ subscriber.destroy();
+ }
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('should be able to quit in PubSub mode', async client => {
+ await client.subscribe('channel', () => {
+ // noop
+ });
+
+ await assert.doesNotReject(client.quit());
+
+ assert.equal(client.isOpen, false);
+ }, GLOBAL.SERVERS.OPEN);
+ });
+
+ testUtils.testWithClient('ConnectionTimeoutError', async client => {
+ const promise = assert.rejects(client.connect(), ConnectionTimeoutError),
+ start = process.hrtime.bigint();
+
+ while (process.hrtime.bigint() - start < 1_000_000) {
+ // block the event loop for 1ms, to make sure the connection will timeout
+ }
+
+ await promise;
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ socket: {
+ connectTimeout: 1
+ }
+ },
+ disableClientSetup: true
+ });
+
+ testUtils.testWithClient('client.quit', async client => {
+ await client.connect();
+
+ const pingPromise = client.ping(),
+ quitPromise = client.quit();
+ assert.equal(client.isOpen, false);
+
+ const [ping, quit] = await Promise.all([
+ pingPromise,
+ quitPromise,
+ assert.rejects(client.ping(), ClientClosedError)
+ ]);
+
+ assert.equal(ping, 'PONG');
+ assert.equal(quit, 'OK');
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ disableClientSetup: true
+ });
+
+ testUtils.testWithClient('client.disconnect', async client => {
+ const pingPromise = client.ping(),
+ disconnectPromise = client.disconnect();
+ assert.equal(client.isOpen, false);
+ await Promise.all([
+ assert.rejects(pingPromise, DisconnectsClientError),
+ assert.doesNotReject(disconnectPromise),
+ assert.rejects(client.ping(), ClientClosedError)
+ ]);
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('should be able to connect after disconnect (see #1801)', async client => {
+ await client.disconnect();
+ await client.connect();
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('should be able to use ref and unref', client => {
+ client.unref();
+ client.ref();
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('pingInterval', async client => {
+ assert.deepEqual(
+ await once(client, 'ping-interval'),
+ ['PONG']
+ );
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ pingInterval: 1
+ }
+ });
+
+ testUtils.testWithClient('should reject commands in connect phase when `disableOfflineQueue`', async client => {
+ const connectPromise = client.connect();
+ await assert.rejects(
+ client.ping(),
+ ClientOfflineError
+ );
+ await connectPromise;
+ await client.disconnect();
+ }, {
+ ...GLOBAL.SERVERS.OPEN,
+ clientOptions: {
+ disableOfflineQueue: true
+ },
+ disableClientSetup: true
+ });
+
+ describe('MONITOR', () => {
+ testUtils.testWithClient('should be able to monitor commands', async client => {
+ const duplicate = await client.duplicate().connect(),
+ listener = spy(message => assert.equal(typeof message, 'string'));
+ await duplicate.monitor(listener);
+
+ try {
+ await Promise.all([
+ waitTillBeenCalled(listener),
+ client.ping()
+ ]);
+ } finally {
+ duplicate.destroy();
+ }
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('should keep monitoring after reconnection', async client => {
+ const duplicate = await client.duplicate().connect(),
+ listener = spy(message => assert.equal(typeof message, 'string'));
+ await duplicate.monitor(listener);
+
+ try {
+ await Promise.all([
+ once(duplicate, 'error'),
+ client.clientKill({
+ filter: 'SKIPME',
+ skipMe: true
+ })
+ ]);
+
+ await once(duplicate, 'ready');
+
+ await Promise.all([
+ waitTillBeenCalled(listener),
+ client.ping()
+ ]);
+ } finally {
+ duplicate.destroy();
+ }
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('should be able to go back to "normal mode"', async client => {
+ await Promise.all([
+ client.monitor(() => { }),
+ client.reset()
+ ]);
+ await assert.doesNotReject(client.ping());
+ }, GLOBAL.SERVERS.OPEN);
+
+ testUtils.testWithClient('should respect type mapping', async client => {
+ const duplicate = await client.duplicate().connect(),
+ listener = spy(message => assert.ok(message instanceof Buffer));
+ await duplicate.withTypeMapping({
+ [RESP_TYPES.SIMPLE_STRING]: Buffer
+ }).monitor(listener);
+
+ try {
+ await Promise.all([
+ waitTillBeenCalled(listener),
+ client.ping()
+ ]);
+ } finally {
+ duplicate.destroy();
+ }
+ }, GLOBAL.SERVERS.OPEN);
+ });
+});
+
+/**
+ * Executes the provided function in a context where setImmediate is stubbed to not do anything.
+ * This blocks setImmediate callbacks from executing
+ */
+async function blockSetImmediate(fn: () => Promise) {
+ let setImmediateStub: any;
+
+ try {
+ setImmediateStub = stub(global, 'setImmediate');
+ setImmediateStub.callsFake(() => {
+ //Dont call the callback, effectively blocking execution
+ });
+ await fn();
+ } finally {
+ if (setImmediateStub) {
+ setImmediateStub.restore();
+ }
+ }
+}
diff --git a/packages/client/lib/client/index.ts b/packages/client/lib/client/index.ts
new file mode 100644
index 00000000000..ea2102c37fd
--- /dev/null
+++ b/packages/client/lib/client/index.ts
@@ -0,0 +1,1567 @@
+import COMMANDS from '../commands';
+import RedisSocket, { RedisSocketOptions } from './socket';
+import { BasicAuth, CredentialsError, CredentialsProvider, StreamingCredentialsProvider, UnableToObtainNewCredentialsError, Disposable } from '../authx';
+import RedisCommandsQueue, { CommandOptions } from './commands-queue';
+import { EventEmitter } from 'node:events';
+import { attachConfig, functionArgumentsPrefix, getTransformReply, scriptArgumentsPrefix } from '../commander';
+import { ClientClosedError, ClientOfflineError, DisconnectsClientError, WatchError } from '../errors';
+import { URL } from 'node:url';
+import { TcpSocketConnectOpts } from 'node:net';
+import { PUBSUB_TYPE, PubSubType, PubSubListener, PubSubTypeListeners, ChannelListeners } from './pub-sub';
+import { Command, CommandSignature, TypeMapping, CommanderConfig, RedisFunction, RedisFunctions, RedisModules, RedisScript, RedisScripts, ReplyUnion, RespVersions, RedisArgument, ReplyWithTypeMapping, SimpleStringReply, TransformReply, CommandArguments } from '../RESP/types';
+import RedisClientMultiCommand, { RedisClientMultiCommandType } from './multi-command';
+import { MULTI_MODE, MultiMode, RedisMultiQueuedCommand } from '../multi-command';
+import HELLO, { HelloOptions } from '../commands/HELLO';
+import { ScanOptions, ScanCommonOptions } from '../commands/SCAN';
+import { RedisLegacyClient, RedisLegacyClientType } from './legacy-mode';
+import { RedisPoolOptions, RedisClientPool } from './pool';
+import { RedisVariadicArgument, parseArgs, pushVariadicArguments } from '../commands/generic-transformers';
+import { BasicClientSideCache, ClientSideCacheConfig, ClientSideCacheProvider } from './cache';
+import { BasicCommandParser, CommandParser } from './parser';
+import SingleEntryCache from '../single-entry-cache';
+import { version } from '../../package.json'
+import EnterpriseMaintenanceManager, { MaintenanceUpdate, MovingEndpointType } from './enterprise-maintenance-manager';
+
+export interface RedisClientOptions<
+ M extends RedisModules = RedisModules,
+ F extends RedisFunctions = RedisFunctions,
+ S extends RedisScripts = RedisScripts,
+ RESP extends RespVersions = RespVersions,
+ TYPE_MAPPING extends TypeMapping = TypeMapping,
+ SocketOptions extends RedisSocketOptions = RedisSocketOptions
+> extends CommanderConfig