Initial commit for authd ChromaJS

.gitignore

@@ -0,0 +1,2 @@
+*.lock
+node_modules

.npmignore

@@ -0,0 +1 @@
+test

.nvmrc

@@ -0,0 +1 @@
+v18.0.0

.prettierignore

@@ -0,0 +1,2 @@
+dist
+node_modules

.prettierrc.json

@@ -0,0 +1 @@
+{}

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,26 @@
+## chromadb-extended by Mintplex Labs
+
+This is an extension on the [original chromadb npm package](https://www.npmjs.com/package/chromadb) to enable the ability to use private single-instance Chroma instances to utilize authentication during their requests.
+
+
+## Getting started
+
+Chroma needs to be running in order for this client to talk to it. Please see the [🧪 Usage Guide](https://docs.trychroma.com/usage-guide) to learn how to quickly stand this up.
+
+## Small example
+
+```js
+import { ChromaClientExtended } from "chromadb-extended";
+const chroma = new ChromaClient({
+  path: "http://localhost:8000",
+  fetchOptions: {
+    headers: {
+      'X-Api-Token': "sk-live-Hunt3r2", // Works like regular node-fetch headers!
+    }
+  }
+});
+
+```
+## License
+
+Apache 2.0

dist/index.d.ts

@@ -0,0 +1,165 @@
+import { IEmbeddingFunction } from "chromadb/dist/main//embeddings/IEmbeddingFunction";
+import { Api } from "chromadb/dist/main/generated";
+import { Collection } from "chromadb/dist/main/Collection";
+import { CollectionMetadata, CollectionType } from "chromadb/dist/main/types";
+export declare class ChromaClientExtended {
+    /**
+     * @ignore
+     */
+    private api;
+    private options;
+    /**
+     * Creates a new ChromaClient instance.
+     * @param {Object} params - The parameters for creating a new client
+     * @param {string} [params.path] - The base path for the Chroma API.
+     * @returns {ChromaClient} A new ChromaClient instance.
+     *
+     * @example
+     * ```typescript
+     * const client = new ChromaClient({
+     *   path: "http://localhost:8000"
+     * });
+     * ```
+     */
+    constructor({ path, fetchOptions, }?: {
+        path?: string;
+        fetchOptions?: RequestInit;
+    });
+    /**
+     * Resets the state of the object by making an API call to the reset endpoint.
+     *
+     * @returns {Promise<Api.Reset200Response>} A promise that resolves when the reset operation is complete.
+     * @throws {Error} If there is an issue resetting the state.
+     *
+     * @example
+     * ```typescript
+     * await client.reset();
+     * ```
+     */
+    reset(): Promise<Api.Reset200Response>;
+    /**
+     * Returns the version of the Chroma API.
+     * @returns {Promise<string>} A promise that resolves to the version of the Chroma API.
+     *
+     * @example
+     * ```typescript
+     * const version = await client.version();
+     * ```
+     */
+    version(): Promise<string>;
+    /**
+     * Returns a heartbeat from the Chroma API.
+     * @returns {Promise<number>} A promise that resolves to the heartbeat from the Chroma API.
+     *
+     * @example
+     * ```typescript
+     * const heartbeat = await client.heartbeat();
+     * ```
+     */
+    heartbeat(): Promise<number>;
+    /**
+     * @ignore
+     */
+    persist(): Promise<never>;
+    /**
+     * Creates a new collection with the specified properties.
+     *
+     * @param {Object} params - The parameters for creating a new collection.
+     * @param {string} params.name - The name of the collection.
+     * @param {CollectionMetadata} [params.metadata] - Optional metadata associated with the collection.
+     * @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
+     *
+     * @returns {Promise<Collection>} A promise that resolves to the created collection.
+     * @throws {Error} If there is an issue creating the collection.
+     *
+     * @example
+     * ```typescript
+     * const collection = await client.createCollection({
+     *   name: "my_collection",
+     *   metadata: {
+     *     "description": "My first collection"
+     *   }
+     * });
+     * ```
+     */
+    createCollection({ name, metadata, embeddingFunction, }: {
+        name: string;
+        metadata?: CollectionMetadata;
+        embeddingFunction?: IEmbeddingFunction;
+    }): Promise<Collection>;
+    /**
+     * Gets or creates a collection with the specified properties.
+     *
+     * @param {Object} params - The parameters for creating a new collection.
+     * @param {string} params.name - The name of the collection.
+     * @param {CollectionMetadata} [params.metadata] - Optional metadata associated with the collection.
+     * @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
+     *
+     * @returns {Promise<Collection>} A promise that resolves to the got or created collection.
+     * @throws {Error} If there is an issue getting or creating the collection.
+     *
+     * @example
+     * ```typescript
+     * const collection = await client.getOrCreateCollection({
+     *   name: "my_collection",
+     *   metadata: {
+     *     "description": "My first collection"
+     *   }
+     * });
+     * ```
+     */
+    getOrCreateCollection({ name, metadata, embeddingFunction, }: {
+        name: string;
+        metadata?: CollectionMetadata;
+        embeddingFunction?: IEmbeddingFunction;
+    }): Promise<Collection>;
+    /**
+     * Lists all collections.
+     *
+     * @returns {Promise<CollectionType[]>} A promise that resolves to a list of collection names.
+     * @throws {Error} If there is an issue listing the collections.
+     *
+     * @example
+     * ```typescript
+     * const collections = await client.listCollections();
+     * ```
+     */
+    listCollections(): Promise<CollectionType[]>;
+    /**
+     * Gets a collection with the specified name.
+     * @param {Object} params - The parameters for getting a collection.
+     * @param {string} params.name - The name of the collection.
+     * @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
+     * @returns {Promise<Collection>} A promise that resolves to the collection.
+     * @throws {Error} If there is an issue getting the collection.
+     *
+     * @example
+     * ```typescript
+     * const collection = await client.getCollection({
+     *   name: "my_collection"
+     * });
+     * ```
+     */
+    getCollection({ name, embeddingFunction, }: {
+        name: string;
+        embeddingFunction?: IEmbeddingFunction;
+    }): Promise<Collection>;
+    /**
+     * Deletes a collection with the specified name.
+     * @param {Object} params - The parameters for deleting a collection.
+     * @param {string} params.name - The name of the collection.
+     * @returns {Promise<void>} A promise that resolves when the collection is deleted.
+     * @throws {Error} If there is an issue deleting the collection.
+     *
+     * @example
+     * ```typescript
+     * await client.deleteCollection({
+     *  name: "my_collection"
+     * });
+     * ```
+     */
+    deleteCollection({ name }: {
+        name: string;
+    }): Promise<void>;
+}
+//# sourceMappingURL=index.d.ts.map

dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,mDAAmD,CAAC;AACvF,OAAO,EAGL,GAAG,EACJ,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE9E,qBAAa,oBAAoB;IAC/B;;OAEG;IACH,OAAO,CAAC,GAAG,CAAa;IACxB,OAAO,CAAC,OAAO,CAAc;IAE7B;;;;;;;;;;;;OAYG;gBACS,EACV,IAAI,EACJ,YAAY,GACb,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,WAAW,CAAA;KAAO;IASrD;;;;;;;;;;OAUG;IACU,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC;IAInD;;;;;;;;OAQG;IACU,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC;IAKvC;;;;;;;;OAQG;IACU,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAMzC;;OAEG;IACU,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC;IAItC;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,gBAAgB,CAAC,EAC5B,IAAI,EACJ,QAAQ,EACR,iBAAiB,GAClB,EAAE;QACD,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,kBAAkB,CAAC;QAC9B,iBAAiB,CAAC,EAAE,kBAAkB,CAAC;KACxC,GAAG,OAAO,CAAC,UAAU,CAAC;IAyBvB;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,qBAAqB,CAAC,EACjC,IAAI,EACJ,QAAQ,EACR,iBAAiB,GAClB,EAAE;QACD,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,kBAAkB,CAAC;QAC9B,iBAAiB,CAAC,EAAE,kBAAkB,CAAC;KACxC,GAAG,OAAO,CAAC,UAAU,CAAC;IA0BvB;;;;;;;;;;OAUG;IACU,eAAe,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAKzD;;;;;;;;;;;;;;OAcG;IACU,aAAa,CAAC,EACzB,IAAI,EACJ,iBAAiB,GAClB,EAAE;QACD,IAAI,EAAE,MAAM,CAAC;QACb,iBAAiB,CAAC,EAAE,kBAAkB,CAAC;KACxC,GAAG,OAAO,CAAC,UAAU,CAAC;IAmBvB;;;;;;;;;;;;;OAaG;IACU,gBAAgB,CAAC,EAAE,IAAI,EAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAMzE"}

dist/index.js

@@ -0,0 +1,208 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChromaClientExtended = void 0;
+const generated_1 = require("chromadb/dist/main/generated");
+const utils_1 = require("chromadb/dist/main/utils");
+const Collection_1 = require("chromadb/dist/main/Collection");
+class ChromaClientExtended {
+    /**
+     * Creates a new ChromaClient instance.
+     * @param {Object} params - The parameters for creating a new client
+     * @param {string} [params.path] - The base path for the Chroma API.
+     * @returns {ChromaClient} A new ChromaClient instance.
+     *
+     * @example
+     * ```typescript
+     * const client = new ChromaClient({
+     *   path: "http://localhost:8000"
+     * });
+     * ```
+     */
+    constructor({ path, fetchOptions, } = {}) {
+        if (path === undefined)
+            path = "http://localhost:8000";
+        const apiConfig = new generated_1.Configuration({
+            basePath: path,
+        });
+        this.api = new generated_1.ApiApi(apiConfig);
+        this.options = fetchOptions !== null && fetchOptions !== void 0 ? fetchOptions : {};
+    }
+    /**
+     * Resets the state of the object by making an API call to the reset endpoint.
+     *
+     * @returns {Promise<Api.Reset200Response>} A promise that resolves when the reset operation is complete.
+     * @throws {Error} If there is an issue resetting the state.
+     *
+     * @example
+     * ```typescript
+     * await client.reset();
+     * ```
+     */
+    async reset() {
+        return await this.api.reset(this.options);
+    }
+    /**
+     * Returns the version of the Chroma API.
+     * @returns {Promise<string>} A promise that resolves to the version of the Chroma API.
+     *
+     * @example
+     * ```typescript
+     * const version = await client.version();
+     * ```
+     */
+    async version() {
+        const response = await this.api.version(this.options);
+        return await (0, utils_1.handleSuccess)(response);
+    }
+    /**
+     * Returns a heartbeat from the Chroma API.
+     * @returns {Promise<number>} A promise that resolves to the heartbeat from the Chroma API.
+     *
+     * @example
+     * ```typescript
+     * const heartbeat = await client.heartbeat();
+     * ```
+     */
+    async heartbeat() {
+        const response = await this.api.heartbeat(this.options);
+        let ret = await (0, utils_1.handleSuccess)(response);
+        return ret["nanosecond heartbeat"];
+    }
+    /**
+     * @ignore
+     */
+    async persist() {
+        throw new Error("Not implemented in JS client");
+    }
+    /**
+     * Creates a new collection with the specified properties.
+     *
+     * @param {Object} params - The parameters for creating a new collection.
+     * @param {string} params.name - The name of the collection.
+     * @param {CollectionMetadata} [params.metadata] - Optional metadata associated with the collection.
+     * @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
+     *
+     * @returns {Promise<Collection>} A promise that resolves to the created collection.
+     * @throws {Error} If there is an issue creating the collection.
+     *
+     * @example
+     * ```typescript
+     * const collection = await client.createCollection({
+     *   name: "my_collection",
+     *   metadata: {
+     *     "description": "My first collection"
+     *   }
+     * });
+     * ```
+     */
+    async createCollection({ name, metadata, embeddingFunction, }) {
+        const newCollection = await this.api
+            .createCollection({
+            name,
+            metadata,
+        }, this.options)
+            .then(utils_1.handleSuccess)
+            .catch(utils_1.handleError);
+        if (newCollection.error) {
+            throw new Error(newCollection.error);
+        }
+        return new Collection_1.Collection(name, newCollection.id, this.api, metadata, embeddingFunction);
+    }
+    /**
+     * Gets or creates a collection with the specified properties.
+     *
+     * @param {Object} params - The parameters for creating a new collection.
+     * @param {string} params.name - The name of the collection.
+     * @param {CollectionMetadata} [params.metadata] - Optional metadata associated with the collection.
+     * @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
+     *
+     * @returns {Promise<Collection>} A promise that resolves to the got or created collection.
+     * @throws {Error} If there is an issue getting or creating the collection.
+     *
+     * @example
+     * ```typescript
+     * const collection = await client.getOrCreateCollection({
+     *   name: "my_collection",
+     *   metadata: {
+     *     "description": "My first collection"
+     *   }
+     * });
+     * ```
+     */
+    async getOrCreateCollection({ name, metadata, embeddingFunction, }) {
+        const newCollection = await this.api
+            .createCollection({
+            name,
+            metadata,
+            get_or_create: true,
+        }, this.options)
+            .then(utils_1.handleSuccess)
+            .catch(utils_1.handleError);
+        if (newCollection.error) {
+            throw new Error(newCollection.error);
+        }
+        return new Collection_1.Collection(name, newCollection.id, this.api, newCollection.metadata, embeddingFunction);
+    }
+    /**
+     * Lists all collections.
+     *
+     * @returns {Promise<CollectionType[]>} A promise that resolves to a list of collection names.
+     * @throws {Error} If there is an issue listing the collections.
+     *
+     * @example
+     * ```typescript
+     * const collections = await client.listCollections();
+     * ```
+     */
+    async listCollections() {
+        const response = await this.api.listCollections(this.options);
+        return (0, utils_1.handleSuccess)(response);
+    }
+    /**
+     * Gets a collection with the specified name.
+     * @param {Object} params - The parameters for getting a collection.
+     * @param {string} params.name - The name of the collection.
+     * @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
+     * @returns {Promise<Collection>} A promise that resolves to the collection.
+     * @throws {Error} If there is an issue getting the collection.
+     *
+     * @example
+     * ```typescript
+     * const collection = await client.getCollection({
+     *   name: "my_collection"
+     * });
+     * ```
+     */
+    async getCollection({ name, embeddingFunction, }) {
+        const response = await this.api
+            .getCollection(name, this.options)
+            .then(utils_1.handleSuccess)
+            .catch(utils_1.handleError);
+        if (response.error) {
+            throw new Error(response.error);
+        }
+        return new Collection_1.Collection(response.name, response.id, this.api, response.metadata, embeddingFunction);
+    }
+    /**
+     * Deletes a collection with the specified name.
+     * @param {Object} params - The parameters for deleting a collection.
+     * @param {string} params.name - The name of the collection.
+     * @returns {Promise<void>} A promise that resolves when the collection is deleted.
+     * @throws {Error} If there is an issue deleting the collection.
+     *
+     * @example
+     * ```typescript
+     * await client.deleteCollection({
+     *  name: "my_collection"
+     * });
+     * ```
+     */
+    async deleteCollection({ name }) {
+        return await this.api
+            .deleteCollection(name, this.options)
+            .then(utils_1.handleSuccess)
+            .catch(utils_1.handleError);
+    }
+}
+exports.ChromaClientExtended = ChromaClientExtended;
+//# sourceMappingURL=index.js.map

dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,4DAIsC;AACtC,oDAAsE;AACtE,8DAA2D;AAG3D,MAAa,oBAAoB;IAO/B;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,IAAI,EACJ,YAAY,MACqC,EAAE;QACnD,IAAI,IAAI,KAAK,SAAS;YAAE,IAAI,GAAG,uBAAuB,CAAC;QACvD,MAAM,SAAS,GAAkB,IAAI,yBAAa,CAAC;YACjD,QAAQ,EAAE,IAAI;SACf,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,GAAG,IAAI,kBAAU,CAAC,SAAS,CAAC,CAAC;QACrC,IAAI,CAAC,OAAO,GAAG,YAAY,aAAZ,YAAY,cAAZ,YAAY,GAAI,EAAE,CAAC;IACpC,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,KAAK;QAChB,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,OAAO;QAClB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtD,OAAO,MAAM,IAAA,qBAAa,EAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,SAAS;QACpB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxD,IAAI,GAAG,GAAG,MAAM,IAAA,qBAAa,EAAC,QAAQ,CAAC,CAAC;QACxC,OAAO,GAAG,CAAC,sBAAsB,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO;QAClB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,gBAAgB,CAAC,EAC5B,IAAI,EACJ,QAAQ,EACR,iBAAiB,GAKlB;QACC,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,GAAG;aACjC,gBAAgB,CACf;YACE,IAAI;YACJ,QAAQ;SACT,EACD,IAAI,CAAC,OAAO,CACb;aACA,IAAI,CAAC,qBAAa,CAAC;aACnB,KAAK,CAAC,mBAAW,CAAC,CAAC;QAEtB,IAAI,aAAa,CAAC,KAAK,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SACtC;QAED,OAAO,IAAI,uBAAU,CACnB,IAAI,EACJ,aAAa,CAAC,EAAE,EAChB,IAAI,CAAC,GAAG,EACR,QAAQ,EACR,iBAAiB,CAClB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACI,KAAK,CAAC,qBAAqB,CAAC,EACjC,IAAI,EACJ,QAAQ,EACR,iBAAiB,GAKlB;QACC,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,GAAG;aACjC,gBAAgB,CACf;YACE,IAAI;YACJ,QAAQ;YACR,aAAa,EAAE,IAAI;SACpB,EACD,IAAI,CAAC,OAAO,CACb;aACA,IAAI,CAAC,qBAAa,CAAC;aACnB,KAAK,CAAC,mBAAW,CAAC,CAAC;QAEtB,IAAI,aAAa,CAAC,KAAK,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SACtC;QAED,OAAO,IAAI,uBAAU,CACnB,IAAI,EACJ,aAAa,CAAC,EAAE,EAChB,IAAI,CAAC,GAAG,EACR,aAAa,CAAC,QAAQ,EACtB,iBAAiB,CAClB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,eAAe;QAC1B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC9D,OAAO,IAAA,qBAAa,EAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,KAAK,CAAC,aAAa,CAAC,EACzB,IAAI,EACJ,iBAAiB,GAIlB;QACC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG;aAC5B,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC;aACjC,IAAI,CAAC,qBAAa,CAAC;aACnB,KAAK,CAAC,mBAAW,CAAC,CAAC;QAEtB,IAAI,QAAQ,CAAC,KAAK,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SACjC;QAED,OAAO,IAAI,uBAAU,CACnB,QAAQ,CAAC,IAAI,EACb,QAAQ,CAAC,EAAE,EACX,IAAI,CAAC,GAAG,EACR,QAAQ,CAAC,QAAQ,EACjB,iBAAiB,CAClB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAoB;QACtD,OAAO,MAAM,IAAI,CAAC,GAAG;aAClB,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC;aACpC,IAAI,CAAC,qBAAa,CAAC;aACnB,KAAK,CAAC,mBAAW,CAAC,CAAC;IACxB,CAAC;CACF;AA5QD,oDA4QC"}

package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@mintplex-labs/chromadb-extended",
+  "version": "1.0.0",
+  "description": "A chromadb NodeJS extended client that enables you to pass custom authorization headers and options to your chromaDB instance",
+  "main": "dist/index.js",
+  "files": [
+    "src",
+    "dist"
+  ],
+  "scripts": {
+    "lint": "prettier --write ./src",
+    "clean": "rimraf dist",
+    "build": "yarn clean && tsc -p tsconfig.json",
+    "test": "echo \"No tests specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/Mintplex-Labs/chromadb-extended.git"
+  },
+  "keywords": [
+    "chromadb",
+    "auth",
+    "fetch",
+    "nodejs",
+    "vectorstore",
+    "langchain"
+  ],
+  "author": "Timothy Carambat (Mintplex Labs Inc)",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/Mintplex-Labs/chromadb-extended/issues"
+  },
+  "homepage": "https://github.com/Mintplex-Labs/chromadb-extended#readme",
+  "devDependencies": {
+    "prettier": "^2.8.8",
+    "rimraf": "^5.0.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.1.3"
+  },
+  "dependencies": {
+    "chromadb": "^1.5.2"
+  }
+}

src/index.ts

@@ -0,0 +1,279 @@
+import { IEmbeddingFunction } from "chromadb/dist/main//embeddings/IEmbeddingFunction";
+import {
+  Configuration,
+  ApiApi as DefaultApi,
+  Api,
+} from "chromadb/dist/main/generated";
+import { handleSuccess, handleError } from "chromadb/dist/main/utils";
+import { Collection } from "chromadb/dist/main/Collection";
+import { CollectionMetadata, CollectionType } from "chromadb/dist/main/types";
+
+export class ChromaClientExtended {
+  /**
+   * @ignore
+   */
+  private api: DefaultApi;
+  private options: RequestInit;
+
+  /**
+   * Creates a new ChromaClient instance.
+   * @param {Object} params - The parameters for creating a new client
+   * @param {string} [params.path] - The base path for the Chroma API.
+   * @returns {ChromaClient} A new ChromaClient instance.
+   *
+   * @example
+   * ```typescript
+   * const client = new ChromaClient({
+   *   path: "http://localhost:8000"
+   * });
+   * ```
+   */
+  constructor({
+    path,
+    fetchOptions,
+  }: { path?: string; fetchOptions?: RequestInit } = {}) {
+    if (path === undefined) path = "http://localhost:8000";
+    const apiConfig: Configuration = new Configuration({
+      basePath: path,
+    });
+    this.api = new DefaultApi(apiConfig);
+    this.options = fetchOptions ?? {};
+  }
+
+  /**
+   * Resets the state of the object by making an API call to the reset endpoint.
+   *
+   * @returns {Promise<Api.Reset200Response>} A promise that resolves when the reset operation is complete.
+   * @throws {Error} If there is an issue resetting the state.
+   *
+   * @example
+   * ```typescript
+   * await client.reset();
+   * ```
+   */
+  public async reset(): Promise<Api.Reset200Response> {
+    return await this.api.reset(this.options);
+  }
+
+  /**
+   * Returns the version of the Chroma API.
+   * @returns {Promise<string>} A promise that resolves to the version of the Chroma API.
+   *
+   * @example
+   * ```typescript
+   * const version = await client.version();
+   * ```
+   */
+  public async version(): Promise<string> {
+    const response = await this.api.version(this.options);
+    return await handleSuccess(response);
+  }
+
+  /**
+   * Returns a heartbeat from the Chroma API.
+   * @returns {Promise<number>} A promise that resolves to the heartbeat from the Chroma API.
+   *
+   * @example
+   * ```typescript
+   * const heartbeat = await client.heartbeat();
+   * ```
+   */
+  public async heartbeat(): Promise<number> {
+    const response = await this.api.heartbeat(this.options);
+    let ret = await handleSuccess(response);
+    return ret["nanosecond heartbeat"];
+  }
+
+  /**
+   * @ignore
+   */
+  public async persist(): Promise<never> {
+    throw new Error("Not implemented in JS client");
+  }
+
+  /**
+   * Creates a new collection with the specified properties.
+   *
+   * @param {Object} params - The parameters for creating a new collection.
+   * @param {string} params.name - The name of the collection.
+   * @param {CollectionMetadata} [params.metadata] - Optional metadata associated with the collection.
+   * @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
+   *
+   * @returns {Promise<Collection>} A promise that resolves to the created collection.
+   * @throws {Error} If there is an issue creating the collection.
+   *
+   * @example
+   * ```typescript
+   * const collection = await client.createCollection({
+   *   name: "my_collection",
+   *   metadata: {
+   *     "description": "My first collection"
+   *   }
+   * });
+   * ```
+   */
+  public async createCollection({
+    name,
+    metadata,
+    embeddingFunction,
+  }: {
+    name: string;
+    metadata?: CollectionMetadata;
+    embeddingFunction?: IEmbeddingFunction;
+  }): Promise<Collection> {
+    const newCollection = await this.api
+      .createCollection(
+        {
+          name,
+          metadata,
+        },
+        this.options
+      )
+      .then(handleSuccess)
+      .catch(handleError);
+
+    if (newCollection.error) {
+      throw new Error(newCollection.error);
+    }
+
+    return new Collection(
+      name,
+      newCollection.id,
+      this.api,
+      metadata,
+      embeddingFunction
+    );
+  }
+
+  /**
+   * Gets or creates a collection with the specified properties.
+   *
+   * @param {Object} params - The parameters for creating a new collection.
+   * @param {string} params.name - The name of the collection.
+   * @param {CollectionMetadata} [params.metadata] - Optional metadata associated with the collection.
+   * @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
+   *
+   * @returns {Promise<Collection>} A promise that resolves to the got or created collection.
+   * @throws {Error} If there is an issue getting or creating the collection.
+   *
+   * @example
+   * ```typescript
+   * const collection = await client.getOrCreateCollection({
+   *   name: "my_collection",
+   *   metadata: {
+   *     "description": "My first collection"
+   *   }
+   * });
+   * ```
+   */
+  public async getOrCreateCollection({
+    name,
+    metadata,
+    embeddingFunction,
+  }: {
+    name: string;
+    metadata?: CollectionMetadata;
+    embeddingFunction?: IEmbeddingFunction;
+  }): Promise<Collection> {
+    const newCollection = await this.api
+      .createCollection(
+        {
+          name,
+          metadata,
+          get_or_create: true,
+        },
+        this.options
+      )
+      .then(handleSuccess)
+      .catch(handleError);
+
+    if (newCollection.error) {
+      throw new Error(newCollection.error);
+    }
+
+    return new Collection(
+      name,
+      newCollection.id,
+      this.api,
+      newCollection.metadata,
+      embeddingFunction
+    );
+  }
+
+  /**
+   * Lists all collections.
+   *
+   * @returns {Promise<CollectionType[]>} A promise that resolves to a list of collection names.
+   * @throws {Error} If there is an issue listing the collections.
+   *
+   * @example
+   * ```typescript
+   * const collections = await client.listCollections();
+   * ```
+   */
+  public async listCollections(): Promise<CollectionType[]> {
+    const response = await this.api.listCollections(this.options);
+    return handleSuccess(response);
+  }
+
+  /**
+   * Gets a collection with the specified name.
+   * @param {Object} params - The parameters for getting a collection.
+   * @param {string} params.name - The name of the collection.
+   * @param {IEmbeddingFunction} [params.embeddingFunction] - Optional custom embedding function for the collection.
+   * @returns {Promise<Collection>} A promise that resolves to the collection.
+   * @throws {Error} If there is an issue getting the collection.
+   *
+   * @example
+   * ```typescript
+   * const collection = await client.getCollection({
+   *   name: "my_collection"
+   * });
+   * ```
+   */
+  public async getCollection({
+    name,
+    embeddingFunction,
+  }: {
+    name: string;
+    embeddingFunction?: IEmbeddingFunction;
+  }): Promise<Collection> {
+    const response = await this.api
+      .getCollection(name, this.options)
+      .then(handleSuccess)
+      .catch(handleError);
+
+    if (response.error) {
+      throw new Error(response.error);
+    }
+
+    return new Collection(
+      response.name,
+      response.id,
+      this.api,
+      response.metadata,
+      embeddingFunction
+    );
+  }
+
+  /**
+   * Deletes a collection with the specified name.
+   * @param {Object} params - The parameters for deleting a collection.
+   * @param {string} params.name - The name of the collection.
+   * @returns {Promise<void>} A promise that resolves when the collection is deleted.
+   * @throws {Error} If there is an issue deleting the collection.
+   *
+   * @example
+   * ```typescript
+   * await client.deleteCollection({
+   *  name: "my_collection"
+   * });
+   * ```
+   */
+  public async deleteCollection({ name }: { name: string }): Promise<void> {
+    return await this.api
+      .deleteCollection(name, this.options)
+      .then(handleSuccess)
+      .catch(handleError);
+  }
+}

test/test.js

@@ -0,0 +1,37 @@
+const { ChromaClientExtended } = require("../dist/index.js");
+
+async function run() {
+  const PATH = 'http://localhost:8000'
+  const reachable = await fetch(`${PATH}/api/v1`).then((res) => res.ok).catch(() => false);
+  if (!reachable) {
+    console.log(`\nService is not online at ${PATH} - cannot test. Exiting\n`)
+    process.exit(1);
+  }
+
+  const client = new ChromaClientExtended({
+    path: PATH,
+    fetchOptions: {
+      headers: {
+        'X-Api-Token': "sk-live-Hunt3r2"
+      }
+    }
+  });
+
+  console.log(await client.reset())
+  console.log(await client.heartbeat())
+
+  await client.createCollection({ name: "test" });
+  console.log(await client.listCollections())
+
+  const collection = await client.getCollection({ name: 'test' })
+  console.log({ count: await collection.count() })
+
+  const ids = 'test1'
+  const embeddings = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+  const metadatas = { test: 'test' }
+  await collection.add({ ids, embeddings, metadatas })
+  console.log(await collection.count())
+  console.log('Tests completed.')
+}
+
+run()

tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "include": [
+    "src"
+  ],
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "module": "CommonJS",
+    "outDir": "dist",
+    "sourceMap": true,
+    "target": "ES2017",
+    "strict": true,
+    "esModuleInterop": true,
+    "moduleResolution": "Node",
+    "forceConsistentCasingInFileNames": true,
+    "stripInternal": true
+  }
+}