typesense/src/Typesense/Collections.ts

Javascript Library for Typesense

import ApiCall from "./ApiCall";
import type { CollectionFieldSchema, CollectionSchema } from "./Collection";

export interface BaseCollectionCreateSchema {
  name: string;
  default_sorting_field?: string;
  symbols_to_index?: string[];
  token_separators?: string[];
  enable_nested_fields?: boolean;
  metadata?: object;
  voice_query_model?: {
    model_name?: string;
  };
}

interface CollectionCreateSchemaWithSrc
  extends Pick<BaseCollectionCreateSchema, "name"> {
  fields?: CollectionFieldSchema[];
}

interface CollectionCreateSchemaWithoutSrc extends BaseCollectionCreateSchema {
  fields: CollectionFieldSchema[];
}

/**
 * Defines the schema for creating a collection in Typesense.
 *
 * If the `src_name` property in `Options` is a string, the `fields` prop is optional, and only used for embedding fields.
 * Otherwise, `fields` will be required.
 */
export type CollectionCreateSchema<
  Options extends CollectionCreateOptions = CollectionCreateOptions,
> = Options["src_name"] extends string
  ? CollectionCreateSchemaWithSrc
  : CollectionCreateSchemaWithoutSrc;

export interface CollectionCreateOptions {
  src_name?: string;
}

export interface CollectionsRetrieveOptions {
  exclude_fields?: string;
}

const RESOURCEPATH = "/collections";

export default class Collections {
  constructor(private apiCall: ApiCall) {}

  async create<const Options extends CollectionCreateOptions>(
    schema: CollectionCreateSchema<Options>,
    options?: Options,
  ): Promise<CollectionSchema> {
    return this.apiCall.post<CollectionSchema>(RESOURCEPATH, schema, options);
  }

  async retrieve(
    options: CollectionsRetrieveOptions = {},
  ): Promise<CollectionSchema[]> {
    return this.apiCall.get<CollectionSchema[]>(RESOURCEPATH, options);
  }

  static get RESOURCEPATH() {
    return RESOURCEPATH;
  }
}