@yext/search-core/src/provideEndpoints.ts

Typescript Networking Library for the Yext Search API

import { Endpoints } from './models/core/Endpoints';
import { Environment } from './models/core/Environment';
import { CloudRegion } from './models/core/CloudRegion';
import { ServingConfig } from './models/core/SearchConfig';
import { CloudChoice } from './models/core/CloudChoice';

export const defaultApiVersion = 20220511;

/**
 * Provides methods for getting various endpoints.
 *
 * @internal
 */
export class EndpointsFactory {
  private readonly environment: Environment;
  private readonly cloudRegion: CloudRegion;
  private readonly cloudChoice: CloudChoice;

  constructor(config?: ServingConfig) {
    this.environment = config?.environment || Environment.PROD;
    this.cloudRegion = config?.cloudRegion || CloudRegion.US;
    this.cloudChoice = config?.cloudChoice || CloudChoice.GLOBAL_MULTI;
  }

  /** Provides the domain based on environment and cloud region. */
  getDomain() {
    if (this.isInternalTestEnvironment() && this.cloudRegion === CloudRegion.US) {
      return `https://liveapi-${this.environment}.yext.com`;
    }
    switch (this.cloudChoice){
      case CloudChoice.GLOBAL_GCP:
        return `https://${this.environment}-cdn-gcp.${this.cloudRegion}.yextapis.com`;
      case CloudChoice.GLOBAL_MULTI:
      default:
        return `https://${this.environment}-cdn.${this.cloudRegion}.yextapis.com`;
    }
  }

  /** Provides the cached domain based on environment and cloud region. */
  getCachedDomain() {
    if (this.isInternalTestEnvironment() && this.cloudRegion === CloudRegion.US) {
      return `https://liveapi-${this.environment}.yext.com`;
    }
    switch (this.cloudChoice){
      case CloudChoice.GLOBAL_GCP:
        return `https://${this.environment}-cdn-cached-gcp.${this.cloudRegion}.yextapis.com`;
      case CloudChoice.GLOBAL_MULTI:
      default:
        return `https://${this.environment}-cdn-cached.${this.cloudRegion}.yextapis.com`;
    }
  }

  /** Provides all endpoints based on environment and cloud region. */
  getEndpoints() {
    return {
      universalSearch: `${this.getDomain()}/v2/accounts/me/search/query`,
      verticalSearch: `${this.getDomain()}/v2/accounts/me/search/vertical/query`,
      questionSubmission: `${this.getDomain()}/v2/accounts/me/createQuestion`,
      status: 'https://answersstatus.pagescdn.com',
      universalAutocomplete: `${this.getCachedDomain()}/v2/accounts/me/search/autocomplete`,
      verticalAutocomplete: `${this.getCachedDomain()}/v2/accounts/me/search/vertical/autocomplete`,
      filterSearch: `${this.getDomain()}/v2/accounts/me/search/filtersearch`,
      generativeDirectAnswer: `${this.getDomain()}/v2/accounts/me/search/generateAnswer`,
    };
  }

  private isInternalTestEnvironment() {
    return this.environment === Environment.DEV || this.environment === Environment.QA;
  }
}

/**
 * The endpoints to use for sandbox experiences.
 *
 * @deprecated Set the appropriate environment and cloud region in {@link ServingConfig} instead.
 *
 * @public
 */
export const SandboxEndpoints: Required<Endpoints> =
  new EndpointsFactory({
    environment: Environment.SANDBOX,
    cloudRegion: CloudRegion.US,
    cloudChoice: CloudChoice.GLOBAL_MULTI })
    .getEndpoints();