[ENH]: fix typings on JS client

clients/js/src/AdminClient.ts

@@ -16,8 +16,9 @@ interface Tenant {
   name: string;
 }
 
-// interface for tenant
 interface Database {
+  id: string;
+  tenant: string;
   name: string;
 }
 
@@ -203,7 +204,7 @@ export class AdminClient {
   }: {
     name: string;
     tenantName: string;
-  }): Promise<Database> {
+  }): Promise<{ name: string }> {
     await this.api.createDatabase(tenantName, { name }, this.api.options);
 
     return { name };
@@ -234,13 +235,13 @@ export class AdminClient {
     name: string;
     tenantName: string;
   }): Promise<Database> {
-    const getDatabase = (await this.api.getDatabase(
+    const result = (await this.api.getDatabase(
       name,
       tenantName,
       this.api.options,
     )) as Database;
 
-    return { name: getDatabase.name } as Database;
+    return result;
   }
 
   /**
@@ -282,13 +283,11 @@ export class AdminClient {
     offset?: number;
     tenantName: string;
   }): Promise<Database[]> {
-    const listDatabases = (await this.api.listDatabases(
+    return (await this.api.listDatabases(
       tenantName,
       limit,
       offset,
       this.api.options,
     )) as Database[];
-
-    return listDatabases.map((db) => ({ name: db.name }));
   }
 }

clients/js/src/ChromaClient.ts

@@ -6,6 +6,7 @@ import { DefaultEmbeddingFunction } from "./embeddings/DefaultEmbeddingFunction"
 import { Configuration, ApiApi as DefaultApi } from "./generated";
 import type {
   ChromaClientParams,
+  CollectionMetadata,
   CollectionParams,
   ConfigOptions,
   CreateCollectionParams,
@@ -288,7 +289,7 @@ export class ChromaClient {
   }
 
   /**
-   * Lists all collections.
+   * Get all collection names.
    *
    * @returns {Promise<string[]>} A promise that resolves to a list of collection names.
    * @param {PositiveInteger} [params.limit] - Optional limit on the number of items to get.
@@ -314,7 +315,42 @@ export class ChromaClient {
       offset,
       this.api.options,
     )) as Collection[];
-    return collections.map((collection: Collection) => collection.name);
+    return collections.map((collection) => collection.name);
+  }
+
+  /**
+   * List collection names, IDs, and metadata.
+   *
+   * @param {PositiveInteger} [params.limit] - Optional limit on the number of items to get.
+   * @param {PositiveInteger} [params.offset] - Optional offset on the items to get.
+   * @throws {Error} If there is an issue listing the collections.
+   * @returns {Promise<{ name: string, id: string, metadata?: CollectionMetadata }[]>} A promise that resolves to a list of collection names, IDs, and metadata.
+   *
+   * @example
+   * ```typescript
+   * const collections = await client.listCollectionsAndMetadata({
+   *    limit: 10,
+   *    offset: 0,
+   * });
+   */
+  async listCollectionsAndMetadata({
+    limit,
+    offset,
+  }: ListCollectionsParams = {}): Promise<
+    {
+      name: string;
+      id: string;
+      metadata?: CollectionMetadata;
+    }[]
+  > {
+    await this.init();
+    return (await this.api.listCollections(
+      this.tenant,
+      this.database,
+      limit,
+      offset,
+      this.api.options,
+    )) as CollectionParams[];
   }
 
   /**

clients/js/src/index.ts

@@ -43,3 +43,5 @@ export type {
   DeleteParams,
   CollectionParams,
 } from "./types";
+
+export * from "./Errors";

clients/js/test/collection.client.test.ts

@@ -1,9 +1,4 @@
-import {
-  expect,
-  test,
-  beforeEach,
-  describe,
-} from "@jest/globals";
+import { expect, test, beforeEach, describe } from "@jest/globals";
 import { DefaultEmbeddingFunction } from "../src";
 import { ChromaClient } from "../src";
 
@@ -27,6 +22,16 @@ describe("collection operations", () => {
     expect(collections).toHaveLength(1);
   });
 
+  test("it should list collections with metadata", async () => {
+    await client.createCollection({ name: "test", metadata: { test: "test" } });
+    const collections = await client.listCollectionsAndMetadata();
+    expect(collections).toHaveLength(1);
+    const [collection] = collections;
+    expect(collection).toHaveProperty("metadata");
+    expect(collection.metadata).toHaveProperty("test");
+    expect(collection.metadata).toEqual({ test: "test" });
+  });
+
   test("it should create a collection", async () => {
     const collection = await client.createCollection({ name: "test" });
     expect(collection).toBeDefined();
@@ -38,7 +43,7 @@ describe("collection operations", () => {
 
     const [returnedCollection] = collections;
 
-    expect(returnedCollection).toEqual("test")
+    expect(returnedCollection).toEqual("test");
 
     expect([{ name: "test2", metadata: null }]).not.toEqual(
       expect.arrayContaining(collections),