add weaviate embedding service headers

Author: augustas1

package-lock.json

@@ -24,8 +24,8 @@
     "test:coverage": "npm run test -- --coverage",
     "build": "npm run build:node",
     "build:web": "tsup",
-    "build:cjs": "tsc --module commonjs --outDir dist/node/cjs && touch dist/node/cjs/package.json && echo '{\"type\": \"commonjs\"}' > dist/node/cjs/package.json",
-    "build:esm": "tsc --module esnext --outDir dist/node/esm && touch dist/node/esm/package.json && echo '{\"type\": \"module\"}' > dist/node/esm/package.json",
+    "build:cjs": "tsc --module commonjs --moduleResolution node10 --outDir dist/node/cjs && touch dist/node/cjs/package.json && echo '{\"type\": \"commonjs\"}' > dist/node/cjs/package.json",
+    "build:esm": "tsc --outDir dist/node/esm && touch dist/node/esm/package.json && echo '{\"type\": \"module\"}' > dist/node/esm/package.json",
     "build:node": "npm run lint && npm run build:cjs && npm run build:esm && prettier --write --no-error-on-unmatched-pattern '**/dist/**/*.{ts,js}'",
     "prepack": "npm run build",
     "lint": "eslint --ext .ts,.js .",
@@ -96,7 +96,7 @@
     "tsup": "^8.0.2",
     "typedoc": "^0.25.12",
     "typedoc-plugin-extras": "^3.0.0",
-    "typescript": "5.1.3",
+    "typescript": "^5.3.3",
     "uuid": "^9.0.1"
   },
   "lint-staged": {

package.json

@@ -1,4 +1,5 @@
 import weaviate from '../index.js';
+import { connectToWeaviateCloud } from './helpers.js';
 
 const WCD_URL = 'https://piblpmmdsiknacjnm1ltla.c1.europe-west3.gcp.weaviate.cloud';
 const WCD_KEY = 'cy4ua772mBlMdfw3YnclqAWzFhQt0RLIN0sl';
@@ -18,6 +19,40 @@ describe('Testing of the connection helper methods', () => {
       });
   });
 
+  describe('adds Weaviate Embedding Service headers', () => {
+    it('to empty headers', async () => {
+      const clientMakerMock = jest.fn().mockResolvedValue(undefined);
+
+      await connectToWeaviateCloud(WCD_URL, clientMakerMock, {
+        authCredentials: new weaviate.ApiKey(WCD_KEY),
+      });
+
+      expect(clientMakerMock.mock.calls[0][0]).toMatchObject({
+        headers: {
+          'X-Weaviate-Api-Key': WCD_KEY,
+          'X-Weaviate-Cluster-Url': WCD_URL,
+        },
+      });
+    });
+
+    it('to existing headers', async () => {
+      const clientMakerMock = jest.fn().mockResolvedValue(undefined);
+
+      await connectToWeaviateCloud(WCD_URL, clientMakerMock, {
+        authCredentials: new weaviate.ApiKey(WCD_KEY),
+        headers: { existingHeader: 'existingValue' },
+      });
+
+      expect(clientMakerMock.mock.calls[0][0]).toMatchObject({
+        headers: {
+          existingHeader: 'existingValue',
+          'X-Weaviate-Api-Key': WCD_KEY,
+          'X-Weaviate-Cluster-Url': WCD_URL,
+        },
+      });
+    });
+  });
+
   it('should connect to a local cluster', () => {
     return weaviate
       .connectToLocal()

src/connection/helpers.test.ts

@@ -1,6 +1,6 @@
 import { WeaviateStartUpError } from '../errors.js';
 import { ClientParams, WeaviateClient } from '../index.js';
-import { AuthCredentials } from './auth.js';
+import { AuthCredentials, isApiKey, mapApiKey } from './auth.js';
 import { ProxiesParams, TimeoutParams } from './http.js';
 
 /** The options available to the `weaviate.connectToWeaviateCloud` method. */
@@ -100,7 +100,7 @@ export function connectToWeaviateCloud(
       },
     },
     auth: options?.authCredentials,
-    headers: options?.headers,
+    headers: addWeaviateEmbeddingServiceHeaders(clusterURL, options),
   }).catch((e) => {
     throw new WeaviateStartUpError(`Weaviate failed to startup with message: ${e.message}`);
   });
@@ -155,3 +155,15 @@ export function connectToCustom(
     throw new WeaviateStartUpError(`Weaviate failed to startup with message: ${e.message}`);
   });
 }
+
+function addWeaviateEmbeddingServiceHeaders(clusterURL: string, options?: ConnectToWeaviateCloudOptions) {
+  if (!isApiKey(options?.authCredentials)) {
+    return options?.headers;
+  }
+
+  return {
+    ...options.headers,
+    'X-Weaviate-Api-Key': mapApiKey(options.authCredentials).apiKey,
+    'X-Weaviate-Cluster-Url': clusterURL,
+  };
+}