[Bug]: IncludeEnum not exported from TS package

[simonsmith]

What happened?

Using version 1.10.4 of the chromadb package

You cannot pass strings to include, so I try to use IncludeEnum (which is undocumented)

import {ChromaClient, DefaultEmbeddingFunction, IncludeEnum} from 'chromadb'

This works fine from the TS compiler perspective. It shows up correctly in my editor and when creating a build. But at runtime it seems the enum is not exported correctly

import { ChromaClient, DefaultEmbeddingFunction, IncludeEnum } from 'chromadb';
                                                 ^^^^^^^^^^^
SyntaxError: The requested module 'chromadb' does not provide an export named 'IncludeEnum'
    at ModuleJob._instantiate (node:internal/modules/esm/module_job:180:21)

Currently I have to just ignore the TS errors like so:

    include: [
      // @ts-expect-error IncludeEnum not exported
      'metadatas',
      // @ts-expect-error IncludeEnum not exported
      'documents',
      // @ts-expect-error IncludeEnum not exported
      'distances',
    ],

What is the recommended approach here? Perhaps easier to just use a type?

  type Include = 'documents' | 'metadatas' | 'distances'

  const example: Include[] = ['documents', 'metadatas', 'distances']

Thanks!

Versions

chromadb 0.6.2, installed using Python 3.13.1
version 1.10.4 of the chromadb JS package

Relates to #1332

Relevant log output

[tazarov]

@simonsmith, have you tried this:

chroma/clients/js/test/add.collections.test.ts

Lines 42 to 45 in b028309

	var res = await collection.get({
	ids: id,
	include: [IncludeEnum.Embeddings],
	});

Note

The above is from our tests and it works fine without using any compiler hacks

[simonsmith]

@tazarov Yes. My issue is as highlighted above, where it isn't exported from the package correctly. In your test example it's being imported locally, which isn't quite the same:

import { IncludeEnum } from "../src/types";

[tazarov]

@simonsmith, so this doesn't work

chroma/clients/js/src/index.ts

Lines 15 to 16 in cfc330e

	export type {
	IncludeEnum,

Is your project CJS or ESM so that I can debug this?

[eliasbiondo]

Same error here.

[simonsmith]

I'll try and create a reproducible example for you

[tazarov]

@simonsmith, @eliasbiondo, we found a problem with our exports using export type causing an issue in CJS projects as type info gets erased. Making it a regular export seems to fix the problem.

#3666 should address your issue. But while we release the JS client you can also refer to resolution here - #3661 (comment)

[simonsmith]

@tazarov Thanks!