@yext/search-headless/src/http-manager.ts

A library for powering UI components for Yext Search integrations

type ServiceType = 'universalQuery' | 'verticalQuery' | 'generativeDirectAnswer';

type ServiceIds = {
  [key in ServiceType]: number;
};

/**
 * Assigns numeric IDs to every http request and the corresponding response
 * through {@link SearchCore}. This helps track the received order of requests
 * and responses. {@link SearchHeadless} uses it to ensure dispatch events for
 * state updates are triggered with up-to-date responses (e.g. if the newly received
 * response has a higher ID number than the recorded received response).
 */
export default class HttpManager {
  private latestRequestIds: ServiceIds;
  private latestResponseIds: ServiceIds;

  constructor() {
    this.latestRequestIds = {
      universalQuery: 0,
      verticalQuery: 0,
      generativeDirectAnswer: 0
    };

    this.latestResponseIds = {
      universalQuery: 0,
      verticalQuery: 0,
      generativeDirectAnswer: 0
    };
  }

  updateRequestId(requestName: ServiceType): number {
    return ++this.latestRequestIds[requestName];
  }

  setResponseId(responseName: ServiceType, responseId: number): void {
    this.latestResponseIds[responseName] = responseId;
  }

  getLatestResponseId(responseName: ServiceType): number {
    return this.latestResponseIds[responseName];
  }

  /**
   * Update the latest saved response id of the given service type if
   * the given request id is newer than the latest saved response id.
   *
   * @param requestName - the request type.
   * @param requestId - the request id of a received response.
   *
   * @returns Whether the response of the given request id is the latest response.
   */
  processRequestId(requestName: ServiceType, requestId: number): boolean {
    const latestResponseId = this.getLatestResponseId(requestName);
    if (requestId > latestResponseId) {
      this.setResponseId(requestName, requestId);
      return true;
    }
    return false;
  }
}