app/services/data/normalizer/hydraNormalizer.ts

import * as _ from 'lodash-es'
import type {
  AnyJson,
  ApiResponse,
  HydraMetadata,
  EnumApiResponse,
} from '~/types/data'
import UrlUtils from '~/services/utils/urlUtils'
import { METADATA_TYPE } from '~/types/enum/data'
import models from '~/models/models'
import type ApiResource from '~/models/ApiResource'

/**
 * Normalisation et dé-normalisation du format de données Hydra
 */
class HydraNormalizer {
  static models = models

  // Private constructor to prevent instantiation
  private constructor() {
    // This utility class is not meant to be instantiated
  }

  /**
   * Normalize the given entity into a Hydra formatted content.
   * @param entity
   */
  public static normalizeEntity(entity: ApiResource): AnyJson {
    const iriEncodedFields =
      Object.getPrototypeOf(entity).constructor.getIriEncodedFields()

    const data = _.cloneDeep(entity)

    for (const field in iriEncodedFields) {
      const value = data[field]
      const targetEntity = iriEncodedFields[field].entity

      if (_.isArray(value)) {
        data[field] = value.map((id: number) => {
          return UrlUtils.makeIRI(targetEntity, id)
        })
      } else {
        data[field] =
          value !== null ? UrlUtils.makeIRI(targetEntity, value) : null
      }
    }

    return data.$toJson()
  }

  /**
   * Parse une réponse Hydra et retourne un objet ApiResponse
   *
   * @param {AnyJson} data
   * @param model
   * @return {AnyJson} réponse parsée
   */
  public static denormalize(
    data: AnyJson,
    model?: typeof ApiResource,
  ): ApiResponse {
    return {
      data: HydraNormalizer.getData(data, model),
      metadata: HydraNormalizer.getMetadata(data),
    }
  }

  protected static getData(
    hydraData: AnyJson,
    model?: typeof ApiResource,
  ): AnyJson | ApiResource | (AnyJson | ApiResource)[] | EnumApiResponse {
    if (hydraData['@type'] === 'Collection') {
      const members = hydraData.member as Array<AnyJson>
      return members.map((item: AnyJson) =>
        HydraNormalizer.denormalizeItem(item, model),
      )
    } else {
      return HydraNormalizer.denormalizeItem(hydraData, model)
    }
  }

  /**
   * Génère les métadonnées d'un item ou d'une collection
   *
   * @param data
   * @protected
   */
  protected static getMetadata(data: AnyJson): HydraMetadata {
    if (data['@type'] !== 'Collection') {
      // A single item, no metadata
      return { type: METADATA_TYPE.ITEM }
    }

    const metadata: HydraMetadata = {
      // @ts-expect-error A ce niveau, on connait la structure de data
      totalItems: data['totalItems'],
    }

    if (data['view']) {
      /**
       * Extract the page number from the IRIs in the hydra:view section
       */
      const extractPageNumber = (
        pos: string,
        default_: number | undefined = undefined,
      ): number | undefined => {
        const iri = data['view'][pos]
        if (!iri) {
          return default_
        }
        return UrlUtils.getParameter(data['view'][pos], 'page', default_) as
          | number
          | undefined
      }

      metadata.first = extractPageNumber('first', 1)
      metadata.last = extractPageNumber('last', 1)
      metadata.next = extractPageNumber('next')
      metadata.previous = extractPageNumber('previous')
    }

    metadata.type = METADATA_TYPE.COLLECTION

    return metadata
  }

  /**
   * Dénormalise un item d'une réponse hydra
   *
   * @param item
   * @param model
   * @protected
   */
  protected static denormalizeItem(
    item: AnyJson,
    model?: typeof ApiResource,
  ): ApiResource | AnyJson | EnumApiResponse {
    if (model) {
      return HydraNormalizer.denormalizeEntity(model, item)
    }

    if (!Object.prototype.hasOwnProperty.call(item, '@id')) {
      // Not hydra formatted
      console.error(
        'De-normalization error : the item is not hydra formatted',
        item,
      )
      return item
    }

    // The previous condition guarantees the correct type
    const itemId = (item as { '@id': string })['@id']

    if (itemId.match(/\/api\/enum\/\w+/)) {
      return HydraNormalizer.denormalizeEnum(item)
    }

    console.error('De-normalization error : unknown item type', item)

    throw new Error(
      'De-normalization error : Could not determine the type of the entity',
    )
  }

  protected static denormalizeEntity(model: typeof ApiResource, item: AnyJson) {
    item.id = this.getItemIdValue(model, item)

    const instance = new model(item)
    const iriEncodedFields = model.getIriEncodedFields()

    for (const field in iriEncodedFields) {
      const value = instance[field]
      if (_.isEmpty(value)) {
        continue
      }

      // @ts-expect-error entity property exists in iriEncodedFields configuration
      const targetEntity = iriEncodedFields[field].entity

      if (_.isArray(value)) {
        instance[field] = value.map((iri: string) => {
          return HydraNormalizer.getIdFromEntityIri(iri, targetEntity)
        })
      } else {
        instance[field] = HydraNormalizer.getIdFromEntityIri(
          value,
          targetEntity,
        )
      }
    }

    return instance
  }

  protected static denormalizeEnum(item: AnyJson): EnumApiResponse {
    return item as unknown as EnumApiResponse
  }

  /**
   * Parse the given IRI
   * @param iri
   * @protected
   */
  protected static parseEntityIRI(iri: string) {
    const rx = /\/api\/(\w+)\/(\d+)/
    const match = rx.exec(iri)
    if (!match) {
      throw new Error('could not parse the IRI : ' + JSON.stringify(iri))
    }

    return {
      entity: match[1],
      id: parseInt(match[2]),
    }
  }

  /**
   * Retrieve the entitie's id from the given IRI
   * Throws an error if the IRI does not match the expected entity
   *
   * @param iri
   * @param expectedEntity
   * @protected
   */
  protected static getIdFromEntityIri(
    iri: string,
    expectedEntity: string,
  ): number | string {
    const { entity, id } = HydraNormalizer.parseEntityIRI(iri)
    if (entity !== expectedEntity) {
      throw new Error(
        "IRI entity does not match the field's target entity (" +
          entity +
          ' != ' +
          expectedEntity +
          ')',
      )
    }
    return id
  }

  /**
   * Get the id value of an item
   * @param model
   * @param item
   * @protected
   */
  protected static getItemIdValue(model: typeof ApiResource, item: AnyJson) {
    if (item.id !== undefined) {
      return item.id
    }

    if (
      model.getIdField() !== undefined &&
      item[model.getIdField()] !== undefined
    ) {
      return item[model.getIdField()]
    }

    throw new Error('Missing id field or @IdField decorator for ' + model)
  }
}

export default HydraNormalizer