Function getRelatedData

packages/axe-api/src/Handlers/Helpers.ts:269–447

(
  version: IVersion,
  data: any[],
  withArray: IWith[],
  model: IModelService,
  modelList: ModelListService,
  database: Knex | Knex.Transaction,
  handler: HandlerTypes,
  request: AxeRequest,
)

};

export const getRelatedData = async (
  version: IVersion,
  data: any[],
  withArray: IWith[],
  model: IModelService,
  modelList: ModelListService,
  database: Knex | Knex.Transaction,
  handler: HandlerTypes,
  request: AxeRequest,
) => {
  if (withArray.length === 0) {
    return;
  }

  const models = modelList.get();

  for (const clientQuery of withArray) {
    // Find the relation of the model. If the model doesn't have any relationship like the
    // user wants, we can't show anything.
    const definedRelation = model.relations.find(
      (relation) => relation.name === clientQuery.relationship,
    );
    if (!definedRelation) {
      throw new ApiError(`Undefined relation: ${clientQuery.relationship}`);
    }

    // Find the foreign model by the relationship
    const foreignModel = models.find(
      (model) => model.name === definedRelation.model,
    );
    if (!foreignModel) {
      continue;
    }

    // Validating the query limit
    valideteQueryFeature(
      model,
      RelationQueryFeatureMap[definedRelation.type],
      `${model.instance.table}.${definedRelation.name}`,
      `${model.instance.table}.${definedRelation.name}`,
    );

    let dataField = "primaryKey";
    let searchField = "foreignKey";
    if (definedRelation.type !== Relationships.HAS_MANY) {
      dataField = "foreignKey";
      searchField = "primaryKey";
    }

    const dataFieldKey = getPrimaryOrForeignKeyByRelation(
      definedRelation,
      dataField,
    );
    const searchFieldKey = getPrimaryOrForeignKeyByRelation(
      definedRelation,
      searchField,
    );