upstream-plane/apps/web/helpers/dashboard.helper.ts

/**
 * Copyright (c) 2023-present Plane Software, Inc. and contributors
 * SPDX-License-Identifier: AGPL-3.0-only
 * See the LICENSE file for details.
 */

import { endOfMonth, endOfWeek, endOfYear, startOfMonth, startOfWeek, startOfYear } from "date-fns";
// helpers
// types
import { DURATION_FILTER_OPTIONS, EDurationFilters } from "@plane/constants";
import type { TIssuesListTypes } from "@plane/types";
// constants
import { renderFormattedDate, renderFormattedPayloadDate } from "@plane/utils";

// -------------------- DEPRECATED --------------------

/**
 * @description returns date range based on the duration filter
 * @param duration
 */
export const getCustomDates = (duration: EDurationFilters, customDates: string[]): string => {
  const today = new Date();
  let firstDay, lastDay;

  switch (duration) {
    case EDurationFilters.NONE:
      return "";
    case EDurationFilters.TODAY:
      firstDay = renderFormattedPayloadDate(today);
      lastDay = renderFormattedPayloadDate(today);
      return `${firstDay};after,${lastDay};before`;
    case EDurationFilters.THIS_WEEK:
      firstDay = renderFormattedPayloadDate(startOfWeek(today));
      lastDay = renderFormattedPayloadDate(endOfWeek(today));
      return `${firstDay};after,${lastDay};before`;
    case EDurationFilters.THIS_MONTH:
      firstDay = renderFormattedPayloadDate(startOfMonth(today));
      lastDay = renderFormattedPayloadDate(endOfMonth(today));
      return `${firstDay};after,${lastDay};before`;
    case EDurationFilters.THIS_YEAR:
      firstDay = renderFormattedPayloadDate(startOfYear(today));
      lastDay = renderFormattedPayloadDate(endOfYear(today));
      return `${firstDay};after,${lastDay};before`;
    case EDurationFilters.CUSTOM:
      return customDates.join(",");
  }
};

/**
 * @description returns redirection filters for the issues list
 * @param type
 */
export const getRedirectionFilters = (type: TIssuesListTypes): string => {
  const today = renderFormattedPayloadDate(new Date());

  const filterParams =
    type === "pending"
      ? "?state_group=backlog,unstarted,started"
      : type === "upcoming"
        ? `?target_date=${today};after`
        : type === "overdue"
          ? `?target_date=${today};before`
          : "?state_group=completed";

  return filterParams;
};

/**
 * @description returns the tab key based on the duration filter
 * @param duration
 * @param tab
 */
export const getTabKey = (duration: EDurationFilters, tab: TIssuesListTypes | undefined): TIssuesListTypes => {
  if (!tab) return "completed";

  if (tab === "completed") return tab;

  if (duration === "none") return "pending";
  else {
    if (["upcoming", "overdue"].includes(tab)) return tab;
    else return "upcoming";
  }
};

/**
 * @description returns the label for the duration filter dropdown
 * @param duration
 * @param customDates
 */
export const getDurationFilterDropdownLabel = (duration: EDurationFilters, customDates: string[]): string => {
  if (duration !== "custom") return DURATION_FILTER_OPTIONS.find((option) => option.key === duration)?.label ?? "";
  else {
    const afterDate = customDates.find((date) => date.includes("after"))?.split(";")[0];
    const beforeDate = customDates.find((date) => date.includes("before"))?.split(";")[0];

    if (afterDate && beforeDate) return `${renderFormattedDate(afterDate)} - ${renderFormattedDate(beforeDate)}`;
    else if (afterDate) return `After ${renderFormattedDate(afterDate)}`;
    else if (beforeDate) return `Before ${renderFormattedDate(beforeDate)}`;
    else return "";
  }
};