/**
 * Contains the search interfaces that a property can use
 * these are basically 4, also contains all the utilities and prefixes
 * that are related to these interfaces
 *
 * @module
 */

import { PREFIX_BUILD } from "../../../../../constants";

/**
 * These are all the 4 interfaces
 */
export enum PropertyDefinitionSearchInterfacesType {
  /**
   * uses an instance of the same property type input
   */
  EXACT,
  /**
   * uses an instance of the same property type input, or two for a range
   * provides either an exact value or a range
   */
  EXACT_AND_RANGE,
  /**
   * full text search, uses a simple raw string as search
   */
  TEXT,
  /**
   * string basic text search, uses a simple raw string as search but also enables
   * for multiple matches as a taglist using IN
   */
  STRING,
  /**
   * uses location and radius for searching
   */
  LOCATION_RADIUS,
  /**
   * payment search interface
   */
  PAYMENT,
  /**
   * tags search interface
   */
  TAGS,
}

/**
 * The prefixes for every location search interface
 */
export const PropertyDefinitionSearchInterfacesPrefixes = {
  // REUSABLE
  /**
   * Used to prefix the exact searches when using the exact or exact and range protocol
   */
  EXACT: PREFIX_BUILD("EXACT"),
  /**
   * Used to prefix for the from value when using exact and range protocol
   */
  FROM: PREFIX_BUILD("FROM"),
  /**
   * Used to prefix the value to for the to search
   */
  TO: PREFIX_BUILD("TO"),
  /**
   * Used to prefix FTS queries
   */
  SEARCH: PREFIX_BUILD("SEARCH"),
  /**
   * Used to prefix FTS queries
   */
  IN: PREFIX_BUILD("IN"),

  // LOCATION SPECIFIC

  /**
   * Used to prefix the location when using location radius
   */
  LOCATION: PREFIX_BUILD("LOCATION"),
  /**
   * Used to prefix the radius when using location radius
   */
  RADIUS: PREFIX_BUILD("RADIUS"),

  // PAYMENT SPECIFIC

  /**
   * Used for payment status request
   */
  PAYMENT_TYPE: PREFIX_BUILD("PAYMENT_TYPE"),
  /**
   * Used for payment status request
   */
  PAYMENT_STATUS: PREFIX_BUILD("PAYMENT_STATUS"),
};

/**
 * this correlates to our search interface enum, enums are numbers basically
 * so when we want to get which interfaces each uses, we refer to this
 * array of arrays
 */
export const PropertyDefinitionSearchInterfacesPrefixesList = [
  [
    PropertyDefinitionSearchInterfacesPrefixes.EXACT,
  ],
  [
    PropertyDefinitionSearchInterfacesPrefixes.EXACT,
    PropertyDefinitionSearchInterfacesPrefixes.FROM,
    PropertyDefinitionSearchInterfacesPrefixes.TO,
  ],
  [
    PropertyDefinitionSearchInterfacesPrefixes.SEARCH,
  ],
  [
    PropertyDefinitionSearchInterfacesPrefixes.SEARCH,
    PropertyDefinitionSearchInterfacesPrefixes.IN,
  ],
  [
    PropertyDefinitionSearchInterfacesPrefixes.LOCATION,
    PropertyDefinitionSearchInterfacesPrefixes.RADIUS,
  ],
  [
    PropertyDefinitionSearchInterfacesPrefixes.EXACT,
    PropertyDefinitionSearchInterfacesPrefixes.FROM,
    PropertyDefinitionSearchInterfacesPrefixes.TO,
    PropertyDefinitionSearchInterfacesPrefixes.PAYMENT_TYPE,
    PropertyDefinitionSearchInterfacesPrefixes.PAYMENT_STATUS,
  ],
  [
    PropertyDefinitionSearchInterfacesPrefixes.SEARCH,
  ],
];