@hyper-fetch/core/src/managers/request/request.manager.events.ts

Cache, Queue and Persist your requests no matter if you are online or offline!

/* eslint-disable max-params */
import type EventEmitter from "events";

import type {
  RequestEventType,
  RequestLoadingEventType,
  RequestProgressEventType,
  RequestResponseEventType,
  RequestRemovedEventType,
  RequestDeduplicatedEventType,
} from "managers";
import {
  getRequestStarByQueryKey,
  getResponseStartByQueryKey,
  getDownloadProgressByQueryKey,
  getUploadProgressByQueryKey,
  getResponseByIdKey,
  getAbortByAbortKey,
  getAbortByIdKey,
  getResponseByCacheKey,
  getUploadProgressByIdKey,
  getDownloadProgressByIdKey,
  getResponseStartByIdKey,
  getRequestStartByIdKey,
  getLoadingByQueryKey,
  getLoadingByIdKey,
  getRemoveByQueryKey,
  getRemoveByIdKey,
  getLoadingKey,
  getRequestStartKey,
  getUploadProgressKey,
  getDownloadProgressKey,
  getResponseKey,
  getAbortKey,
  getRemoveKey,
  getResponseStartKey,
  getLoadingByCacheKey,
  getRequestDeduplicatedKey,
  getRequestDeduplicatedByIdKey,
  getRequestDeduplicatedByCacheKey,
  getRequestDeduplicatedByQueryKey,
} from "managers";
import type { AdapterInstance } from "adapter";
import type { RequestInstance } from "request";
import type { Client } from "client";
import type { ExtendRequest } from "types";

/** Create event emitters and listeners for the request lifecycle: loading, progress, response, abort, deduplication, and removal. */
export const getRequestManagerEvents = (emitter: EventEmitter) => ({
  /**
   * Emitters
   */

  /** Emit when a request is deduplicated (skipped because an identical one is in-flight) */
  emitDeduplicated: (data: RequestDeduplicatedEventType<RequestInstance>, isTriggeredExternally = false): void => {
    emitter.emit(getRequestDeduplicatedKey(), data, isTriggeredExternally);
    emitter.emit(getRequestDeduplicatedByIdKey(data.requestId), data, isTriggeredExternally);
    emitter.emit(getRequestDeduplicatedByCacheKey(data.request.cacheKey), data, isTriggeredExternally);
    emitter.emit(getRequestDeduplicatedByQueryKey(data.request.queryKey), data, isTriggeredExternally);
  },

  /** Emit loading state changes for a request */
  emitLoading: (data: RequestLoadingEventType<RequestInstance>, isTriggeredExternally = false): void => {
    emitter.emit(getLoadingKey(), data, isTriggeredExternally);
    emitter.emit(getLoadingByIdKey(data.requestId), data, isTriggeredExternally);
    emitter.emit(getLoadingByCacheKey(data.request.cacheKey), data, isTriggeredExternally);
    emitter.emit(getLoadingByQueryKey(data.request.queryKey), data, isTriggeredExternally);
  },

  /** Emit when a request starts being sent */
  emitRequestStart: (data: RequestEventType<RequestInstance>, isTriggeredExternally = false): void => {
    emitter.emit(getRequestStartKey(), data, isTriggeredExternally);
    emitter.emit(getRequestStartByIdKey(data.requestId), data, isTriggeredExternally);
    emitter.emit(getRequestStarByQueryKey(data.request.queryKey), data, isTriggeredExternally);
  },
  /** Emit when the response starts being received */
  emitResponseStart: (data: RequestEventType<RequestInstance>, isTriggeredExternally = false): void => {
    emitter.emit(getResponseStartKey(), data, isTriggeredExternally);
    emitter.emit(getResponseStartByIdKey(data.requestId), data, isTriggeredExternally);
    emitter.emit(getResponseStartByQueryKey(data.request.queryKey), data, isTriggeredExternally);
  },

  /** Emit upload progress updates */
  emitUploadProgress: (data: RequestProgressEventType<RequestInstance>, isTriggeredExternally = false): void => {
    emitter.emit(getUploadProgressKey(), data, isTriggeredExternally);
    emitter.emit(getUploadProgressByIdKey(data.requestId), data, isTriggeredExternally);
    emitter.emit(getUploadProgressByQueryKey(data.request.queryKey), data, isTriggeredExternally);
  },
  /** Emit download progress updates */
  emitDownloadProgress: (data: RequestProgressEventType<RequestInstance>, isTriggeredExternally = false): void => {
    emitter.emit(getDownloadProgressKey(), data, isTriggeredExternally);
    emitter.emit(getDownloadProgressByIdKey(data.requestId), data, isTriggeredExternally);
    emitter.emit(getDownloadProgressByQueryKey(data.request.queryKey), data, isTriggeredExternally);
  },

  /** Emit when a response is received */
  emitResponse: <Adapter extends AdapterInstance>(
    data: RequestResponseEventType<ExtendRequest<RequestInstance, { client: Client<any, Adapter> }>>,
    isTriggeredExternally = false,
  ): void => {
    emitter.emit(getResponseKey(), data, isTriggeredExternally);
    emitter.emit(getResponseByIdKey(data.requestId), data, isTriggeredExternally);
    emitter.emit(getResponseByCacheKey(data.request.cacheKey), data, isTriggeredExternally);
  },

  /** Emit when a request is aborted */
  emitAbort: (data: RequestEventType<RequestInstance>, isTriggeredExternally = false): void => {
    emitter.emit(getAbortKey(), data, isTriggeredExternally);
    emitter.emit(getAbortByIdKey(data.requestId), data, isTriggeredExternally);
    emitter.emit(getAbortByAbortKey(data.request.abortKey), data, isTriggeredExternally);
  },

  /** Emit when a request is removed from the dispatcher queue */
  emitRemove: (data: RequestRemovedEventType<RequestInstance>, isTriggeredExternally = false): void => {
    emitter.emit(getRemoveKey(), data, isTriggeredExternally);
    emitter.emit(getRemoveByIdKey(data.requestId), data, isTriggeredExternally);
    emitter.emit(getRemoveByQueryKey(data.request.queryKey), data, isTriggeredExternally);
  },

  /**
   * Listeners
   */

  /** Listen for deduplicated request events */
  onDeduplicated: <T extends RequestInstance>(
    callback: (data: RequestDeduplicatedEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getRequestDeduplicatedKey(), callback);
    return () => emitter.removeListener(getRequestDeduplicatedKey(), callback);
  },
  onDeduplicatedByQueue: <T extends RequestInstance>(
    queryKey: string,
    callback: (data: RequestDeduplicatedEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getRequestDeduplicatedByQueryKey(queryKey), callback);
    return () => emitter.removeListener(getRequestDeduplicatedByQueryKey(queryKey), callback);
  },
  onDeduplicatedByCache: <T extends RequestInstance>(
    cacheKey: string,
    callback: (data: RequestDeduplicatedEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getRequestDeduplicatedByCacheKey(cacheKey), callback);
    return () => emitter.removeListener(getRequestDeduplicatedByCacheKey(cacheKey), callback);
  },
  onDeduplicatedById: <T extends RequestInstance>(
    requestId: string,
    callback: (data: RequestDeduplicatedEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getRequestDeduplicatedByIdKey(requestId), callback);
    return () => emitter.removeListener(getRequestDeduplicatedByIdKey(requestId), callback);
  },

  // Loading
  onLoading: <T extends RequestInstance>(callback: (data: RequestLoadingEventType<T>) => void): VoidFunction => {
    emitter.on(getLoadingKey(), callback);
    return () => emitter.removeListener(getLoadingKey(), callback);
  },
  onLoadingByQueue: <T extends RequestInstance>(
    queryKey: string,
    callback: (data: RequestLoadingEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getLoadingByQueryKey(queryKey), callback);
    return () => emitter.removeListener(getLoadingByQueryKey(queryKey), callback);
  },
  onLoadingByCache: <T extends RequestInstance>(
    cacheKey: string,
    callback: (data: RequestLoadingEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getLoadingByCacheKey(cacheKey), callback);
    return () => emitter.removeListener(getLoadingByCacheKey(cacheKey), callback);
  },
  onLoadingById: <T extends RequestInstance>(
    requestId: string,
    callback: (data: RequestLoadingEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getLoadingByIdKey(requestId), callback);
    return () => emitter.removeListener(getLoadingByIdKey(requestId), callback);
  },

  // Request Start
  onRequestStart: <T extends RequestInstance>(callback: (details: RequestEventType<T>) => void): VoidFunction => {
    emitter.on(getRequestStartKey(), callback);
    return () => emitter.removeListener(getRequestStartKey(), callback);
  },
  onRequestStartByQueue: <T extends RequestInstance>(
    queryKey: string,
    callback: (details: RequestEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getRequestStarByQueryKey(queryKey), callback);
    return () => emitter.removeListener(getRequestStarByQueryKey(queryKey), callback);
  },
  onRequestStartById: <T extends RequestInstance>(
    requestId: string,
    callback: (details: RequestEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getRequestStartByIdKey(requestId), callback);
    return () => emitter.removeListener(getRequestStartByIdKey(requestId), callback);
  },

  // Response Start
  onResponseStart: <T extends RequestInstance>(callback: (details: RequestEventType<T>) => void): VoidFunction => {
    emitter.on(getResponseStartKey(), callback);
    return () => emitter.removeListener(getResponseStartKey(), callback);
  },
  onResponseStartByQueue: <T extends RequestInstance>(
    queryKey: string,
    callback: (details: RequestEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getResponseStartByQueryKey(queryKey), callback);
    return () => emitter.removeListener(getResponseStartByQueryKey(queryKey), callback);
  },
  onResponseStartById: <T extends RequestInstance>(
    requestId: string,
    callback: (details: RequestEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getResponseStartByIdKey(requestId), callback);
    return () => emitter.removeListener(getResponseStartByIdKey(requestId), callback);
  },

  // Progress
  onUploadProgress: <T extends RequestInstance = RequestInstance>(
    callback: (data: RequestProgressEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getUploadProgressKey(), callback);
    return () => emitter.removeListener(getUploadProgressKey(), callback);
  },
  onUploadProgressByQueue: <T extends RequestInstance = RequestInstance>(
    queryKey: string,
    callback: (data: RequestProgressEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getUploadProgressByQueryKey(queryKey), callback);
    return () => emitter.removeListener(getUploadProgressByQueryKey(queryKey), callback);
  },
  onUploadProgressById: <T extends RequestInstance = RequestInstance>(
    requestId: string,
    callback: (data: RequestProgressEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getUploadProgressByIdKey(requestId), callback);
    return () => emitter.removeListener(getUploadProgressByIdKey(requestId), callback);
  },

  onDownloadProgress: <T extends RequestInstance = RequestInstance>(
    callback: (data: RequestProgressEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getDownloadProgressKey(), callback);
    return () => emitter.removeListener(getDownloadProgressKey(), callback);
  },
  onDownloadProgressByQueue: <T extends RequestInstance = RequestInstance>(
    queryKey: string,
    callback: (data: RequestProgressEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getDownloadProgressByQueryKey(queryKey), callback);
    return () => emitter.removeListener(getDownloadProgressByQueryKey(queryKey), callback);
  },
  onDownloadProgressById: <T extends RequestInstance = RequestInstance>(
    requestId: string,
    callback: (data: RequestProgressEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getDownloadProgressByIdKey(requestId), callback);
    return () => emitter.removeListener(getDownloadProgressByIdKey(requestId), callback);
  },

  // Response
  onResponse: <T extends RequestInstance>(callback: (data: RequestResponseEventType<T>) => void): VoidFunction => {
    emitter.on(getResponseKey(), callback);
    return () => emitter.removeListener(getResponseKey(), callback);
  },
  onResponseByCache: <T extends RequestInstance>(
    cacheKey: string,
    callback: (data: RequestResponseEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getResponseByCacheKey(cacheKey), callback);
    return () => emitter.removeListener(getResponseByCacheKey(cacheKey), callback);
  },
  onResponseById: <T extends RequestInstance>(
    requestId: string,
    callback: (data: RequestResponseEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getResponseByIdKey(requestId), callback);
    return () => emitter.removeListener(getResponseByIdKey(requestId), callback);
  },

  // Abort
  onAbort: <T extends RequestInstance = RequestInstance>(
    callback: (request: RequestEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getAbortKey(), callback);
    return () => emitter.removeListener(getAbortKey(), callback);
  },
  onAbortByKey: <T extends RequestInstance = RequestInstance>(
    abortKey: string,
    callback: (request: RequestEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getAbortByAbortKey(abortKey), callback);
    return () => emitter.removeListener(getAbortByAbortKey(abortKey), callback);
  },
  onAbortById: <T extends RequestInstance = RequestInstance>(
    requestId: string,
    callback: (data: RequestEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getAbortByIdKey(requestId), callback);
    return () => emitter.removeListener(getAbortByIdKey(requestId), callback);
  },

  // Remove
  onRemove: <T extends RequestInstance = RequestInstance>(
    callback: (data: RequestRemovedEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getRemoveKey(), callback);
    return () => emitter.removeListener(getRemoveKey(), callback);
  },
  onRemoveByQueue: <T extends RequestInstance = RequestInstance>(
    queryKey: string,
    callback: (data: RequestRemovedEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getRemoveByQueryKey(queryKey), callback);
    return () => emitter.removeListener(getRemoveByQueryKey(queryKey), callback);
  },
  onRemoveById: <T extends RequestInstance = RequestInstance>(
    requestId: string,
    callback: (data: RequestRemovedEventType<T>) => void,
  ): VoidFunction => {
    emitter.on(getRemoveByIdKey(requestId), callback);
    return () => emitter.removeListener(getRemoveByIdKey(requestId), callback);
  },
});