typesense/src/Typesense/Aliases.ts

Javascript Library for Typesense

import ApiCall from "./ApiCall";

const RESOURCEPATH = "/aliases";

export interface CollectionAliasCreateSchema {
  collection_name: string;
}

export interface CollectionAliasSchema extends CollectionAliasCreateSchema {
  name: string;
}

export interface CollectionAliasesResponseSchema {
  aliases: CollectionAliasSchema[];
}

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

  async upsert(
    name: string,
    mapping: CollectionAliasCreateSchema
  ): Promise<CollectionAliasSchema> {
    return this.apiCall.put<CollectionAliasSchema>(
      this.endpointPath(name),
      mapping
    );
  }

  async retrieve(): Promise<CollectionAliasesResponseSchema> {
    return this.apiCall.get<CollectionAliasesResponseSchema>(RESOURCEPATH);
  }

  private endpointPath(aliasName): string {
    return `${Aliases.RESOURCEPATH}/${encodeURIComponent(aliasName)}`;
  }

  static get RESOURCEPATH(): string {
    return RESOURCEPATH;
  }
}