Merge pull request #292 from weaviate/connection-details

expose connection details

Author: tsmith023

src/connection/http.ts

@@ -52,8 +52,15 @@ export type InternalConnectionParams = {
   skipInitChecks?: boolean;
 };
 
+export interface ConnectionDetails {
+  host: string;
+  bearerToken?: string;
+  headers?: HeadersInit;
+}
+
 export default class ConnectionREST {
   private apiKey?: string;
+  private headers?: HeadersInit;
   protected authEnabled: boolean;
   public readonly host: string;
   public readonly http: HttpClient;
@@ -62,6 +69,7 @@ export default class ConnectionREST {
   constructor(params: InternalConnectionParams) {
     params = this.sanitizeParams(params);
     this.host = params.host;
+    this.headers = params.headers;
     this.http = httpClient(params);
     this.authEnabled = this.parseAuthParams(params);
   }
@@ -183,6 +191,12 @@ export default class ConnectionREST {
     }
     return this.oidcAuth.getAccessToken();
   };
+
+  getDetails = async (): Promise<ConnectionDetails> => ({
+    host: new URL(this.host).host, // removes default port
+    bearerToken: this.authEnabled ? await this.login().then((token) => `Bearer ${token}`) : undefined,
+    headers: this.headers,
+  });
 }
 
 export * from './auth.js';

src/index.ts

@@ -25,7 +25,7 @@ import {
   ConnectToWCSOptions,
   ConnectToWeaviateCloudOptions,
 } from './connection/helpers.js';
-import { ProxiesParams, TimeoutParams } from './connection/http.js';
+import { ConnectionDetails, ProxiesParams, TimeoutParams } from './connection/http.js';
 import { ConnectionGRPC } from './connection/index.js';
 import MetaGetter from './misc/metaGetter.js';
 import { Meta } from './openapi/types.js';
@@ -110,6 +110,7 @@ export interface WeaviateClient {
 
   close: () => Promise<void>;
   getMeta: () => Promise<Meta>;
+  getConnectionDetails: () => Promise<ConnectionDetails>;
   getOpenIDConfig?: () => Promise<any>;
   getWeaviateVersion: () => Promise<DbVersion>;
   isLive: () => Promise<boolean>;
@@ -229,6 +230,7 @@ async function client(params: ClientParams): Promise<WeaviateClient> {
     users: users(connection),
     close: () => Promise.resolve(connection.close()), // hedge against future changes to add I/O to .close()
     getMeta: () => new MetaGetter(connection).do(),
+    getConnectionDetails: connection.getDetails,
     getOpenIDConfig: () => new OpenidConfigurationGetter(connection.http).do(),
     getWeaviateVersion: () => dbVersionSupport.getVersion(),
     isLive: () => new LiveChecker(connection, dbVersionProvider).do(),