Merge branch 'iipbs/fo/dev'

apps/fo/app/pages/(with-layout)/dashboard/drainageEquipment/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ * 대시보드 - 표로보기 - 배수설비 정비현황
+ * 
+ * - 배수설비 현황을 조회하는 화면. 2차사업 때 예정인 화면으로 현재 사용되지 않음.
+ */
+
+"use client"
 
 import { useFoStore } from '@/app/store';
 import type { DrainageEquipmentListProps, TableUpperProps } from '@/app/store/dashboard';

apps/fo/app/pages/(with-layout)/dashboard/facilityInfo/modal/page.tsx

@@ -1,4 +1,11 @@
-"use client"
+/**
+ * 대시보드 - 표로보기 - 시설정보 및 운영현황(모달)
+ * 
+ * - 유량, 수질, 총인시설의 연간, 하절기, 동절기 단위로 값을 차트로 시각화하여 보여주는 모달화면
+ * - 막대그래프로 모달을 그려준다.
+ */
+
+"use client"
 import type { OperationalStatusListProps } from "@/app/store/dashboard";
 import { CHART_FORM, MainChart, type ChartConfig } from "@common/business_components";
 import { Button } from "@common/business_components/ui/table/lib/button";

apps/fo/app/pages/(with-layout)/dashboard/facilityInfo/page.tsx

@@ -1,4 +1,13 @@
-"use client"
+/**
+ * 대시보드 - 표로보기 - 시설정보 및 운영현황
+ * 
+ * - 시설정보 및 운영현황 탭의 메인 페이지
+ * - 중앙상단에는 시설에 대한 요약정보가, 좌측 상단은 시설계획에 대한 정보, 좌측하단에는 물사용량에 대한 정보, 
+ *   우측에는 조회년도 및 시설에 해당하는 유량 및 수질정보를 연간,하절기,동절기별 추출하여 데이터를 보여준다.
+ * - 우측 운영실태는 연간, 하절기, 동절기별로 색이 칠해져있는데 어떤항목들끼리 차트로 그려지는지 확인하기 위해서다.
+ */
+
+"use client"
 import { roundNumber } from "@/app/components/common/DataForm";
 import { useFoStore } from "@/app/store";
 import type { TableUpperProps } from "@/app/store/processFacility";
@@ -13,7 +22,12 @@ export type facilityInfoProps = {
   fcltyList?: { bscFctCd: string, bscFctNm: string, fcltyCpc: number | '', trtFrfNm: string, efflWqltStndrdNm: string }[];
 };
 
-// 시설계획 table header 변경
+/**
+ * 시설계획 table header 변경
+ * @param upHeadList 
+ * @param planYearList 
+ * @returns 
+ */
 const headMakeColSpanPlanFclty = (upHeadList: TableUpperProps[], planYearList: string[]) => {
   return  ( <>
     <TableRow>{
@@ -29,6 +43,12 @@ const headMakeColSpanPlanFclty = (upHeadList: TableUpperProps[], planYearList: s
 }
 
 // 시설계획 table header 변경
+/**
+ * 
+ * @param upHeadList 
+ * @param searchYear 
+ * @returns 
+ */
 const headMakeColSpanOperationStatus = (upHeadList: TableUpperProps[], searchYear: string) => {
   return  ( <>
     <TableRow>

apps/fo/app/pages/(with-layout)/dashboard/maingraph/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ * 대시보드 - 표로보기 - 주요그래프
+ * 
+ * - 시설의 조회년도에 해당하는 수질정보, 강우량, 유입량 등을 특정 항목별로 묶어서 차트로 시각화해주는 화면
+ */
+
+"use client"
 import { useFoStore } from "@/app/store";
 import type { lineChartDataProps } from "@/app/store/dashboard";
 import { CHART_FORM, type ChartConfig, ContentsDiv, MainChart } from "@common/business_components";

apps/fo/app/pages/(with-layout)/dashboard/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ * 대시보드 - 표로보기(메인)
+ * 
+ * - 대시보드 - 표로보기 메인페이지로 상단영역의 제어 및 탭 전환 시 보여주는 페이지를 지정해준다.
+ */
+
+"use client"
 import { useFoStore } from "@/app/store";
 import { ContentsDiv, downloadExcel, downloadMultipleExcel, filePickedBlobArray, MainDiv, SelectBox, UITab, type SelectDataType } from "@common/business_components";
 import { Button, TabsContent } from "@common/components/ui";

apps/fo/app/pages/(with-layout)/dashboard/rainManage/page.tsx

@@ -1,4 +1,11 @@
-"use client"
+/**
+ * 대시보드 - 표로보기 - 강우일 운영현황
+ * 
+ * - 시설의 강우량 구간별(3~10mm미만..10~20mm미만 등) 강우일수 및 수질정보를 표로 보여주는 화면
+ * - 강우영향일 계산후 바뀌는 tobe강우일을 계산해야 한다.
+ */
+
+"use client"
 import { useFoStore } from "@/app/store";
 import { UiTable } from "@common/business_components/ui/table";
 import { useEffect, useState } from "react";

apps/fo/app/pages/(with-layout)/dashboardMain/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ * 대시보드 - 표로보기 상단구역 페에지
+ * 
+ * - 대시보드 - 표로보기의 3개의 탭 상단에 조회년도, 행정정보, 시설명의 구역을 컴포넌트
+ */
+
+"use client"
 import { useFoStore } from "@/app/store";
 import { useEffect, useState } from "react";
 import SearchInput from "../../../components/common/SearchInput";

apps/fo/app/pages/(with-layout)/facilityPrecipitation/modal/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ *  처리시설 연간 운영현황 - 강수현황(모달)
+ * 
+ * - 선택한 시설을 조회한 년도의 하루단위로 강우량 및 강우영향일 정보를 보여주는 화면.
+ */
+
+"use client"
 import CalcRainEffect from "@/app/components/common/CalcRainEffect";
 import { roundNumber } from "@/app/components/common/DataForm";
 import { useFoStore } from "@/app/store";

apps/fo/app/pages/(with-layout)/facilityPrecipitation/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ *  처리시설 연간 운영현황 - 강수현황(메인)
+ * 
+ * - 시설별 강수 현황을 조회조건대로 추출하여 표로 보여주는 화면.
+ */
+
+"use client"
 import { useFoStore } from "@/app/store";
 import type { TableUpperProps } from "@/app/store/common";
 import { ContentsDiv, downloadExcel, MainDiv, SearchBaseForm, SearchInput, SelectBox, Title, UiModal, UiTable, type ReturnType } from "@common/business_components";

apps/fo/app/pages/(with-layout)/facilityWaterQlty/HeadMakeColSpan.tsx

@@ -1,3 +1,9 @@
+/**
+ *  처리시설 연간 운영현황 - 수질현황
+ * 
+ * - 수질현황의 헤더를 만들어주는 컴포넌트
+ */
+
 import { TableHead, TableRow } from "@common/components/ui";
 
 interface TableUpperProps {

apps/fo/app/pages/(with-layout)/facilityWaterQlty/modal/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ *  처리시설 연간 운영현황 - 수질현황
+ * 
+ * - 메인화면에서 선택한 시설의 수질정보를 하루단위로 보여주는 모달.
+ */
+
+"use client"
 import { useFoStore } from "@/app/store";
 import type { FacilityWaterQltyProps, modalExcelType } from "@/app/store/facilityWaterQlty";
 import { downloadExcel, UITab, UiTable } from "@common/business_components/ui";

apps/fo/app/pages/(with-layout)/facilityWaterQlty/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ *  처리시설 연간 운영현황 - 수질현황
+ * 
+ * - 시설별 수질 현황을 조회조건대로 추출하여 표로 보여주는 화면.
+ */
+
+"use client"
 
 import { useFoStore } from "@/app/store";
 import type { TableUpperProps } from "@/app/store/common";

apps/fo/app/pages/(with-layout)/flowRate/modal/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ *  처리시설 연간 운영현황 - 유량현황(모달))
+ * 
+ * - 선택한 시설의 유량 정보를 하루 단위로 표로 출력해주는 모달
+ */
+
+"use client"
 import FacilityTermModalHeader from "@/app/components/common/FacilityTermModalHeader";
 import { useFoStore } from "@/app/store";
 import type { FlowRateModalInterface, modalExcelType } from "@/app/store/flowRate";

apps/fo/app/pages/(with-layout)/flowRate/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ *  처리시설 연간 운영현황 - 유량현황
+ * 
+ * - 시설별 유량 현황을 조회조건대로 추출하여 표로 보여주는 화면.
+ */
+
+"use client"
 import { useFoStore } from "@/app/store";
 import type { TableUpperProps } from "@/app/store/common";
 import { ContentsDiv, downloadExcel, MainDiv, SearchBaseForm, SearchInput, SelectBox, Title, UiModal, UiTable, type ReturnType } from "@common/business_components";

apps/fo/app/pages/(with-layout)/planSewage/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ *  처리시설 연간 운영현황 - 계획하수량 산정지표 현황
+ * 
+ * - 시설별 여유용량, 변동부하율, 분류식화율을 조회조건대로 추출하여 표로 보여주는 화면.
+ */
+
+"use client"
 import { useFoStore } from "@/app/store";
 import type { TableUpperProps } from "@/app/store/common";
 import { downloadExcel, MainDiv, SearchBaseForm, SearchInput, SelectBox, Title, UiTable, type ReturnType } from "@common/business_components";

apps/fo/app/pages/(with-layout)/processArea/modal/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ *  처리시설 현황 - 처리구역정보(모달)
+ * 
+ * - 선택한 시설의 계획정보를 가져와 표로 출력해주는 모달
+ */
+
+"use client"
 import { useFoStore } from "@/app/store";
 import { UiTable } from "@common/business_components/ui";
 import ListDiv from "@common/business_components/ui/list_div";

apps/fo/app/pages/(with-layout)/processArea/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ *  처리시설 현황 - 처리구역정보(메인)
+ * 
+ * - 시설계획 정보를 조회조건대로 추출하여 표로 보여주는 화면.
+ */
+
+"use client"
 import { useFoStore } from "@/app/store";
 import { ContentsDiv, downloadExcel, MainDiv, SearchBaseForm, SelectBox, Title, UiModal, UiTable, type ReturnType } from "@common/business_components";
 import ListDiv from "@common/business_components/ui/list_div";

apps/fo/app/pages/(with-layout)/processFacility/modal/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ *  처리시설 현황 - 처리시설 시설정보(모달))
+ * 
+ * - 선택한 시설의 정보와 시설이력정보를 보여주는 모달.
+ */
+
+"use client"
 import { roundNumber } from "@/app/components/common/DataForm";
 import { useFoStore } from "@/app/store";
 import type { TableUpperProps } from "@/app/store/dashboard";

apps/fo/app/pages/(with-layout)/processFacility/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ *  처리시설 현황 - 처리시설 시설정보(메인)
+ * 
+ * - 시설별 정보를 조회조건대로 추출하여 표로 보여주는 화면.
+ */
+
+"use client"
 import UnderComment from "@/app/components/common/UnderComment";
 import { useFoStore } from "@/app/store";
 import { ContentsDiv, downloadExcel, MainDiv, SearchBaseForm, SearchInput, SelectBox, Title, UiModal, UiTable, type ReturnType } from "@common/business_components";

apps/fo/app/pages/(with-layout)/rdi/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ *  운영실태 - RDII 추정
+ * 
+ * - 시설별 유입량과 하절기 최저 유입 BOD 정보를 통해 RDII를 추정치를 보여주는 화면
+ */
+
+"use client"
 import { useFoStore } from "@/app/store";
 import type { TableUpperProps } from "@/app/store/common";
 import { ContentsDiv, downloadExcel, MainDiv, SearchBaseForm, SearchInput, SelectBox, Title, UiTable, type ReturnType } from "@common/business_components";

apps/fo/app/pages/(with-layout)/sewageOccur/modal/page.tsx

@@ -1,4 +1,10 @@
-"use client"
+/**
+ *  운영실태 - 오수발생량 추정(모달)
+ * 
+ * - 선택한 시설의 물사용량과 오수전환율을 가지고 오수발생량 추정 데이터를 월별로 보여주는 모달.
+ */
+
+"use client"
 import { roundNumber } from "@/app/components/common/DataForm";
 import { useFoStore } from "@/app/store";
 import type { modalTableType } from "@/app/store/sewageOccur";

apps/fo/app/pages/(with-layout)/sewageOccur/page.tsx

@@ -1,4 +1,11 @@
-"use client"
+/**
+ *  운영실태 - 오수발생량 추정(메인)
+ * 
+ * - 조회조건대로 시설별 물 사용량과 오수전환율을 기반으로 오수발생량 추정치를 표로 보여주는 화면
+ * - 현재 물사용량의 경우 연계받는 데이터가 아닌 연 하수유입량의 65%로 가정하고 계산함
+ */
+
+"use client"
 import { useFoStore } from "@/app/store";
 import type { TableUpperProps } from "@/app/store/common";
 import { ContentsDiv, downloadExcel, MainDiv, SearchBaseForm, SearchInput, SelectBox, Title, UiModal, UiTable, type ReturnType } from "@common/business_components";

apps/fo/app/pages/(with-layout)/underWaterInput/modal/page.tsx

@@ -1,4 +1,11 @@
-"use client"
+/**
+ *  운영실태 - 지하수 유입량 추정(모달)
+ * 
+ * - 선택한 시설의 월별 청천시 실제 하수유입량, 오수발생량으로 지하수 유입량을 보여주는 모달
+ * - 청천시 실제 하수유입량 - 오수발생량으로 지하수유입량을 추정한다.
+ */
+
+"use client"
 import { roundNumber } from "@/app/components/common/DataForm";
 import { useFoStore } from "@/app/store";
 import type { UnderWaterInputModalProps } from "@/app/store/underWaterInput/types";

apps/fo/app/pages/(with-layout)/underWaterInput/page.tsx

@@ -1,4 +1,12 @@
-"use client"
+/**
+ *  운영실태 - 지하수 유입량 추정(메인)
+ * 
+ * - 조회조건대로 시설별 연간, 하절기, 동절기 단위로 지하수 유입량 추정을 표로 보여주는 화면
+ * - 청천시 실제 하수유입량 - 오수발생량으로 지하수유입량을 추정한다.
+ * - 연간 지하수 유입량이 하수유입량보다 20% 클 경우 초과유입으로 아닌 경우 적정으로 적정여부를 표시한다. 
+ */
+
+"use client"
 import { useFoStore } from "@/app/store";
 import type { TableUpperProps } from "@/app/store/common";
 import { ContentsDiv, downloadExcel, MainDiv, SearchBaseForm, SearchInput, SelectBox, Title, UiModal, UiTable, type ReturnType } from "@common/business_components";