/**
 * Copyright 2024 Resultium LLC
 *
 * This file is part of @resultium/utils.
 *
 * @resultium/utils is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 *
 * @resultium/utils is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with RCZ. If not, see <https://www.gnu.org/licenses/>.
 */

/**
 * Removes an object from an array by key value object.
 *
 * @remarks
 * This method doesn't support deep comparements.
 * Vulnerable to generic object injection sink
 *
 * @param array - array which shall be manipulated with
 * @param keyValue - key-value object which defines which object shall be removed from the array
 * @returns modified array
 */
export const removeFromArrayByKeyValue = <T>(
  array: Array<T>,
  keyValue: Partial<{ [K in keyof T]: T[K] }>,
) => {
  const keys = Object.keys(keyValue) as Array<keyof T>;

  return array.filter(
    // eslint-disable-next-line security/detect-object-injection -- warned at remarks
    (item) => !keys.every((key) => item[key] === keyValue[key]),
  );
};