gRPC client + project setup overhaul (#24)

- Generated gRPC client based on plugins from @bufbuild
- REST client accepts maxConnections now using undici.js agent for fetch
- Updated OAS definitions and improved generated types
- Improved NPM dependency management in monorepo
- Improved linting and tooling setup
- Added CI check to avoid bumping a version of clients too early

Author: Rendez

.changeset/kind-days-explain.md

@@ -0,0 +1,7 @@
+---
+'@qdrant/js-client-grpc': patch
+'@qdrant/js-client-rest': patch
+'@qdrant/qdrant-js': patch
+---
+
+Added gRPC client

.eslintrc.json

@@ -0,0 +1,32 @@
+{
+    "root": true,
+    "env": {
+        "node": true
+    },
+    "ignorePatterns": ["**/node_modules/**", "scripts/*"],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "project": ["./tsconfig.base.json"]
+    },
+    "plugins": ["@typescript-eslint"],
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended-requiring-type-checking",
+        "plugin:@typescript-eslint/strict"
+    ],
+    "rules": {
+        "object-shorthand": "warn",
+        "arrow-body-style": "warn",
+        "no-unused-vars": "off",
+        "@typescript-eslint/no-unused-vars": [
+            "error",
+            {
+                "args": "all",
+                "argsIgnorePattern": "^_",
+                "ignoreRestSiblings": true
+            }
+        ],
+        "@typescript-eslint/consistent-type-definitions": "off"
+    }
+}

.github/workflows/pull_request.yaml

@@ -16,7 +16,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         with:
-          fetch-depth: 0
+          ref: ${{ github.event.pull_request.head.sha }}
 
       - uses: pnpm/action-setup@v2
         with:
@@ -36,18 +36,21 @@ jobs:
         env:
           CI: 1
 
-      - name: Open API schema changes
+      - name: Generated OpenAPI update check
         run: |
           pnpm --filter "@qdrant/js-client-rest" codegen:openapi-typescript
-          if ( git diff-index HEAD | grep -q README.md || exit ) then
-            echo "Generated schema changed. Please update with pnpm -r codegen:openapi-typescript.";
+          if ( git diff --name-only | grep -q packages/js-client-rest/src/openapi/ || exit ) then
+            echo "Generated schema changed. Please update with: 'pnpm -r codegen:openapi-typescript'.";
             exit 1
           fi
         shell: bash
 
-      - name: Run checks
+      - name: Project checks
         run: pnpm -r pre-check
 
-      - name: Open API integration tests
-        run: cd packages/js-client-rest && ./tests/integration-tests.sh
+      - name: Integration tests
+        run: packages/qdrant-js/scripts/integration-tests.sh
         shell: bash
+        env:
+          QDRANT_URL: ${{ secrets.QDRANT_URL }}
+          QDRANT_API_KEY: ${{ secrets.QDRANT_API_KEY }}

.prettierignore

@@ -1,5 +1,2 @@
 **/node_modules/
-**/dist/
-**/src/openapi/
-**/src/proto/
 **/pnpm-lock.yaml

.vscode/settings.json

@@ -1,4 +1,4 @@
 {
     "typescript.tsdk": "node_modules/typescript/lib",
-    "eslint.workingDirectories": ["packages/js-client-rest", "packages/js-client-grpc"]
+    "eslint.workingDirectories": ["packages/qdrant-js", "packages/js-client-rest", "packages/js-client-grpc"]
 }

README.md

@@ -1,4 +1,3 @@
-
 <p align="center">
   <img height="100" src="https://github.com/qdrant/qdrant/raw/master/docs/logo.svg" alt="Qdrant"> 
   &nbsp;
@@ -9,8 +8,7 @@
     <b>JavaScript/TypeScript library for the <a href="https://github.com/qdrant/qdrant">Qdrant</a> vector search engine.</b>
 </p>
 
-
-<p align=center>
+<p align="center">
     <a href="https://www.npmjs.com/package/@qdrant/qdrant-js"><img src="https://badge.fury.io/js/@qdrant%2Fqdrant-js.svg" alt="npm version" height="18"></a>
     <a href="https://qdrant.github.io/qdrant/redoc/index.html"><img src="https://img.shields.io/badge/Docs-OpenAPI%203.0-success" alt="OpenAPI Docs"></a>
     <a href="https://github.com/qdrant/qdrant-client/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-success" alt="Apache 2.0 License"></a>
@@ -22,23 +20,22 @@
 
 This repository contains packages of the JS SDK for the [Qdrant](https://github.com/qdrant/qdrant) vector search engine.
 
-There are 3 packages:
-
-* [`@qdrant/qdrant-js`](./packages/qdrant-js) - the main package with the SDK itself.
-* [`@qdrant/js-client-rest`](./packages/js-client-rest) - leightweight REST client for Qdrant.
-* [`@qdrant/js-client-grpc`](./packages/js-client-grpc) - WIP gRPC client for Qdrant.
+There are published 3 packages:
 
+-   [`@qdrant/qdrant-js`](./packages/qdrant-js) - the main package with the SDK itself.
+-   [`@qdrant/js-client-rest`](./packages/js-client-rest) - lightweight REST client for Qdrant.
+-   [`@qdrant/js-client-grpc`](./packages/js-client-grpc) - gRPC client for Qdrant.
 
 ## JS/TS Examples
 
 ### Installation
 
 ```shell
+pnpm i @qdrant/js-client-rest
+# or
 npm install @qdrant/js-client-rest
 # or
 yarn add @qdrant/js-client-rest
-# or
-pnpm i @qdrant/js-client-rest
 ```
 
 ### Usage
@@ -75,19 +72,24 @@ console.log('List of collections:', result.collections);
 
 More examples can be found in the [`examples`](./examples) folder.
 
+## Support
 
+TypeScript types are provided alongside JavaScript sources to be used in:
+
+-   Node.js (ESM and CJS) - `>= 18.0.0`
+-   Deno
+-   Browser (fetch API)
+-   Cloudflare Workers (OpenAPI only)
 
 ## Releases
 
 Major and minor versions align with Qdrant's engine releases, whilst patch are reserved for fixes regarding the current minor release. Check out [RELEASE.md](./RELEASE.md) for more info on release guidelines.
 
 For release automation we use [`changesets`](https://github.com/changesets/changesets) both for pull requests and pushes to the master branch, and their [Github Action](https://github.com/changesets/action) to automate changeset steps.
 
-## Contributions
-
-In order to contribute there are a couple of things you may need to do.
+## Contributing
 
-We make use of [`pnpm`](https://pnpm.io/) instead of `npm` or `yarn` to manage and install packages in this monorepo, make sure it's installed on your local environment.
+In order to [contribute](./CONTRIBUTING.md) there are a couple of things you may need to setup. We make use of [`pnpm`](https://pnpm.io/) instead of `npm` or `yarn` to manage and install packages in this monorepo, make sure it's installed on your local environment.
 
 After checking out the repository and desired branch, run `pnpm install` to install all package's dependencies and run the compilation steps. This will work for the monorepo.
 

RELEASE.md

@@ -13,7 +13,7 @@ New releases are made from the `master` branch following semver. Major and minor
 
 2. (**AC**) Then open a pull request.
 
-3. (**RC**) verifies the **semver** version commitment and turns it into a bump wtih `pnpm run version` on the root directory. This updates the versions on package.json files and updates the CHANGELOG.md files.
+3. (**RC**) verifies the **semver** version commitment and turns it into a bump with `pnpm ci:version` on the root directory. This updates the versions on package.json files and updates the CHANGELOG.md files.
 
 > This last step if skipped could result in an outdated pnpm lock file, and if so, update it manually with: `pnpm install --lockfile-only`.
 

examples/node-js-basic/index.js

@@ -1,4 +1,4 @@
-import {QdrantClient} from '@qdrant/js-client-rest';
+import {QdrantClient} from '@qdrant/qdrant-js';
 
 async function main() {
     const collectionName = 'test_collection';
@@ -69,8 +69,8 @@ async function main() {
     });
 
     const collectionInfo = await client.getCollection(collectionName);
-    console.log(collectionInfo.points_count);
-    // prints: 6
+    console.log('number of points:', collectionInfo.points_count);
+    // prints: number of points: 6
 
     const points = await client.retrieve(collectionName, {
         ids: [1, 2],
@@ -230,9 +230,7 @@ async function main() {
 
 main()
     .then((code) => {
-        if (code !== 0) {
-            process.exit(code);
-        }
+        process.exit(code);
     })
     .catch((err) => {
         console.error(err);

examples/node-js-basic/package.json

@@ -15,6 +15,6 @@
     "author": "Qdrant Team",
     "license": "Apache-2.0",
     "dependencies": {
-        "@qdrant/js-client-rest": "^1.1.3"
+        "@qdrant/qdrant-js": "^1.2.0"
     }
 }

package.json

@@ -8,21 +8,38 @@
     },
     "packageManager": "[email protected]",
     "scripts": {
-        "prepare": "node ./prepare.cjs && pnpm -r build",
+        "prepare": "node scripts/prepare.cjs && pnpm -r build",
         "ci:version": "pnpm changeset version && pnpm install --no-frozen-lockfile && git add .",
-        "ci:release": "pnpm changeset publish"
+        "ci:release": "node scripts/prepublish.mjs && pnpm changeset publish"
+    },
+    "lint-staged": {
+        "*.ts": [
+            "prettier --list-different",
+            "eslint"
+        ],
+        "*.{md,yaml}": "prettier --list-different"
     },
     "devDependencies": {
-        "@changesets/changelog-github": "0.4.8",
-        "@changesets/cli": "2.26.1",
-        "husky": "8.0.3",
-        "is-ci": "3.0.1",
-        "prettier": "2.8.7",
-        "typescript": "5.0.4"
+        "@changesets/changelog-github": "^0.4.8",
+        "@changesets/cli": "^2.26.1",
+        "@rollup/plugin-node-resolve": "^15.0.2",
+        "@rollup/plugin-terser": "^0.4.1",
+        "@types/node": "^20.1.3",
+        "@typescript-eslint/eslint-plugin": "^5.59.5",
+        "@typescript-eslint/parser": "^5.59.5",
+        "eslint": "^8.41.0",
+        "husky": "^8.0.3",
+        "is-ci": "^3.0.1",
+        "lint-staged": "^13.2.2",
+        "prettier": "^2.8.8",
+        "rimraf": "^5.0.0",
+        "rollup": "^3.21.6",
+        "ts-node": "^10.9.1",
+        "typescript": "^5.0.4"
     },
     "pnpm": {
         "overrides": {
-            "[email protected] || 2.x": "^2.2.2"
+            "@bufbuild/protobuf@^1.2.0": "file:./packages/js-client-grpc/includes/bufbuild-protobuf-1.2.1.tgz"
         }
     }
 }