datahub/wherehows-web/app/utils/datasets/lineage.ts

import { Relationships, RelationshipType } from 'wherehows-web/typings/api/datasets/relationships';
import { IDatasetView } from 'wherehows-web/typings/api/datasets/dataset';
import { arrayFilter, take } from 'wherehows-web/utils/array';

/**
 * Constant for the relationship type i.e. nativeType property with an empty string value, intended
 * to signify all nativeType
 * @type {Readonly<{label: string; value: string}>}
 */
const allRelationshipType: RelationshipType = { label: 'All Types', value: '' };

/**
 * Creates a filter function, the will filter an instance of an IDatasetView on it's nativeType
 * property
 * @param {IDatasetView.nativeType} [filter='']
 */
const nativeTypeFilter = (filter: IDatasetView['nativeType'] = '') => ({ nativeType }: IDatasetView): boolean =>
  filter ? nativeType === filter : true;

/**
 * Filters a list of Relationships on the nativeType attribute
 * @param {string} filter
 * @return {(array: Array<IDatasetView>) => Array<IDatasetView>}
 */
const filterRelationshipsByType = (filter: string = ''): ((array: Relationships) => Relationships) =>
  arrayFilter(nativeTypeFilter(filter));

/**
 * Dedupes a list of RelationshipType objects
 * @param {Array<RelationshipType>} set the deduped list
 * @param {RelationshipType} relationshipType a RelationshipType element in the list
 * @returns {Array<RelationshipType>}
 */
const dedupeType = (set: Array<RelationshipType>, relationshipType: RelationshipType): Array<RelationshipType> => {
  const isSameType = ({ value }: RelationshipType): boolean => relationshipType.value === value;
  const hasType = set.find(isSameType);

  return hasType ? set : [...set, relationshipType];
};

/**
 * Takes the first N elements in the list of relationships if the shouldShowAll flag is false
 * @param {boolean} shouldShowAll flag to determine if all relationships should be shown
 * @param {number} [n=10]
 */
const takeNRelationships = (shouldShowAll: boolean, n: number = 10) => (relationships: Relationships): Relationships =>
  shouldShowAll ? relationships : take<IDatasetView>(n)(relationships);

export { allRelationshipType, filterRelationshipsByType, dedupeType, takeNRelationships };