@uniai-fe/uds-templates 0.5.28 → 0.6.0

package/src/weather/utils/weather.ts

@@ -1,460 +1,57 @@
 import type {
-  API_Res_WeatherKoreaBase,
-  API_Res_WeatherKoreaForecast,
-  API_Res_WeatherKoreaNextDays,
-  API_Res_WeatherKoreaNow,
-  KMA_Res_WeatherItem,
-  KMA_Res_WeatherForecast,
-  KMA_Res_WeatherNow,
-  OWM_Res_Weather_Forecast,
-  OWM_Res_Weather_Forecast_Item,
+  API_Res_WeatherForecast,
+  API_Res_WeatherNow,
+  API_Res_WeatherSummary,
 } from "../types";
-import { getMoments } from "./date-time";
 
 /**
- * 날씨 도구; 현재 날씨/예보 값 추출
- * @param {KMA_Res_WeatherItem[]} items - 현재 날씨 아이템
- * @param {string} category - 카테고리
- * @return {string | null} 현재 날씨 값
- */
-const getValueNow = (
-  items: KMA_Res_WeatherItem[],
-  category: string,
-): string | null => items.find(i => i.category === category)?.fcstValue || null;
-
-/**
- * 날씨 도구; 예보 값 추출
- * @param {KMA_Res_WeatherItem[]} items - 예보 아이템
- * @param {string} date - 날짜
- * @param {string} category - 카테고리
- * @return {string | null} 예보 값
- */
-const getValueForecast = (
-  items: KMA_Res_WeatherItem[],
-  date: string,
-  category: string,
-): string | null =>
-  items.find(i => i.fcstDate === date && i.category === category)?.fcstValue ||
-  null;
-
-/**
- * 강수량 코드
- * @desc
- * - 1(약한 비); 3mm/h 미만
- * - 2(보통 비); 3mm/h 이상 15mm/h 미만
- * - 3(강한 비); 15mm/h 이상
- * @param {string} props.pty - 강수형태 코드
- * @param {string} props.pcp - 1시간 강수량
- * @return {string | null} 강수량 코드; 1(약한비), 2(보통비), 3(강한비)
- */
-const getRainAmount = ({
-  pty,
-  pcp,
-}: {
-  pty: string | null;
-  pcp: string | null;
-}): string | null => {
-  if (!pty || !pcp) return null;
-
-  if (Number(pcp) < 3) return "1";
-  else if (3 <= Number(pcp) && Number(pcp) < 15) return "2";
-  else return "3";
-};
-
-/**
- * 강설량 코드
- * @desc
- * - 1(보통 눈); 1cm/h 미만
- * - 2(많은 눈); 1cm/h 이상
- * @param {string} props.pty - 강수형태 코드
- * @param {string} props.snow - 1시간 신적설
- * @return {string | null} 강설량 코드; 1(보통눈), 2(많은눈)
- */
-const getSnowAmount = ({
-  pty,
-  snow,
-}: {
-  pty: string | null;
-  snow: string | null;
-}): string | null => {
-  if (!pty || !snow) return null;
-
-  if (Number(snow) < 1) return "1";
-  else return "2";
-};
-
-/**
- * 풍속 코드
- * @desc
- * - 1(약한 바람); 4m/s 미만
- * - 2(약간 강한 바람); 4m/s 이상 9m/s 미만
- * - 3(강한 바람); 9m/s 이상
- * @param {string} props.wind - 풍속
- * @return {string | null} 풍속 코드; 1(약한바람), 2(약간강한바람), 3(강한바람)
- */
-const getWindSpeed = ({ wind }: { wind: string | null }): string | null => {
-  if (!wind) return null;
-  if (Number(wind) < 4) return "1";
-  else if (4 <= Number(wind) && Number(wind) < 9) return "2";
-  else return "3";
-};
-
-/**
- * 날씨 상태 코드
- * @desc
- * - sky-1(맑음)
- * - sky-2(구름조금)
- * - sky-3(구름많음)
- * - sky-4(흐림)
- * - drop-rain-shower(소나기)
- * - drop-rain(비)
- * - drop-rain-1(약한 비)
- * - drop-rain-2(보통 비)
- * - drop-rain-3(강한 비)
- * - drop-rain-snow(비/눈)
- * - drop-rain-snow-1(약한 비/눈)
- * - drop-rain-snow-2(보통 비/눈)
- * - drop-rain-snow-3(강한 비/눈)
- * - drop-snow(눈)
- * - drop-snow-1(보통 눈)
- * - drop-snow-2(많은 눈)
- * @param {string} props.sky - 하늘상태 코드; 1(맑음), 2(구름조금), 3(구름많음), 4(흐림)
- * @param {string} props.pty - 강수형태 코드; 0(없음), 1(비), 2(비/눈), 3(눈), 4(소나기)
- * @param {string} props.pcp - 1시간 강수량
- * @param {string} props.snow - 1시간 신적설
- */
-const getWeatherCondition = ({
-  sky,
-  pty,
-  pcp,
-  snow,
-}: {
-  sky: string | null;
-  pty: string | null;
-  pcp: string | null;
-  snow: string | null;
-}): { code: string | null; name: string | null } => {
-  const dropType = () => {
-    if (!pty || isNaN(Number(pty)) || pty === "0") return null;
-    switch (Number(pty)) {
-      case 1:
-        return "rain";
-      case 2:
-        return "rain-snow";
-      case 3:
-        return "snow";
-      case 4:
-        return "shower";
-      default:
-        return null;
-    }
-  };
-
-  if (!dropType()) {
-    const skyCode = sky === null ? null : sky;
-    const skyName = () => {
-      switch (Number(skyCode)) {
-        case 1:
-          return "맑음";
-        case 2:
-          return "구름조금";
-        case 3:
-          return "구름많음";
-        case 4:
-          return "흐림";
-        default:
-          return null;
-      }
-    };
-
-    return {
-      code: `sky-${skyCode}`,
-      name: skyName(),
-    };
-  }
-
-  const rainAmount = getRainAmount({ pty, pcp });
-  const snowAmount = getSnowAmount({ pty, snow });
-
-  const dropStrength = (): string | null => {
-    const type = dropType();
-    if (type === "rain") return rainAmount;
-    else if (type === "snow") return snowAmount;
-    else if (type === "rain-snow") {
-      if (rainAmount === null) return snowAmount;
-      if (snowAmount === null) return rainAmount;
-      // rainAmount와 snowAmount 중 큰 값을 선택
-      return Math.max(Number(rainAmount), Number(snowAmount)).toString();
-    }
-    // 소나기
-    else if (type === "shower") return type;
-    return null;
-  };
-
-  const dropCode = `drop-${dropType()}${dropStrength() ? `-${dropStrength()}` : ""}`;
-  const dropName = () => {
-    const type = dropType();
-    if (type === "rain") {
-      if (dropStrength() === null) return "비";
-      if (rainAmount === "1") return "약한 비";
-      else if (rainAmount === "2") return "보통 비";
-      else if (rainAmount === "3") return "강한 비";
-    } else if (type === "snow") {
-      if (dropStrength() === null) return "눈";
-      if (snowAmount === "1") return "보통 눈";
-      else if (snowAmount === "2") return "많은 눈";
-    } else if (type === "rain-snow") {
-      if (dropStrength() === null) return "비/눈";
-      if (dropStrength() === "1") return "약한 비/눈";
-      else if (dropStrength() === "2") return "보통 비/눈";
-      else if (dropStrength() === "3") return "강한 비/눈";
-    } else if (type === "shower") {
-      return "소나기";
-    }
-    return null;
-  };
-
-  return {
-    code: dropCode,
-    name: dropName(),
-  };
-};
-
-/**
- * 날씨 도구; OpenWeatherMap 아이콘 코드를 weather icon 코드로 변환
- * @param {string} [icon] OpenWeatherMap icon 코드
- * @return {string} weather icon 코드
- */
-export const getOpenWeatherMapConditionCode = (icon?: string): string => {
-  switch (icon) {
-    case "01d":
-    case "01n":
-      return "sky-1";
-    case "02d":
-    case "02n":
-    case "03d":
-    case "03n":
-    case "04d":
-    case "04n":
-      return "sky-2";
-    case "09d":
-    case "09n":
-      return "drop-rain-3";
-    case "10d":
-    case "10n":
-      return "drop-rain-1";
-    case "11d":
-    case "11n":
-      return "drop-rain-thunder";
-    case "13d":
-    case "13n":
-      return "drop-snow";
-    case "50d":
-    case "50n":
-      return "sky-4";
-    default:
-      return "sky-1";
-  }
-};
-
-const getLocalDateKey = (date: Date): string => {
-  const month = String(date.getMonth() + 1).padStart(2, "0");
-  const day = String(date.getDate()).padStart(2, "0");
-
-  return `${date.getFullYear()}-${month}-${day}`;
-};
-
-const getTimeZoneDateKey = (dateTimeSeconds: number, timezoneSeconds: number) =>
-  new Date((dateTimeSeconds + timezoneSeconds) * 1000)
-    .toISOString()
-    .slice(0, 10);
-
-const getOpenWeatherMapDateKey = (
-  forecast?: OWM_Res_Weather_Forecast,
-): string => {
-  const timezoneSeconds = forecast?.city?.timezone;
-
-  if (typeof timezoneSeconds === "number" && Number.isFinite(timezoneSeconds)) {
-    return getTimeZoneDateKey(Math.floor(Date.now() / 1000), timezoneSeconds);
-  }
-
-  return getLocalDateKey(new Date());
-};
-
-const getForecastItemDateKey = (
-  item: OWM_Res_Weather_Forecast_Item,
-  timezoneSeconds = 0,
-): string =>
-  Number.isFinite(item.dt)
-    ? getTimeZoneDateKey(item.dt, timezoneSeconds)
-    : item.dt_txt?.slice(0, 10) || getLocalDateKey(new Date(item.dt * 1000));
-
-const toOpenWeatherMapDayForecast = (
-  items: OWM_Res_Weather_Forecast_Item[],
-): API_Res_WeatherKoreaNextDays | undefined => {
-  if (items.length === 0) return undefined;
-
-  const conditionItem =
-    items.find(item => item.dt_txt?.includes("12:00")) ||
-    items[Math.floor(items.length / 2)];
-  const temperatures = items
-    .flatMap(item => [item.main.temp_min, item.main.temp_max, item.main.temp])
-    .filter((temperature): temperature is number =>
-      Number.isFinite(temperature),
-    );
-
-  return {
-    sky: null,
-    drop: null,
-    rainAmount: null,
-    snowAmount: null,
-    windSpeed: null,
-    condition: getOpenWeatherMapConditionCode(
-      conditionItem?.weather?.[0]?.icon,
-    ),
-    conditionName: conditionItem?.weather?.[0]?.description || null,
-    max_temperature:
-      temperatures.length > 0 ? Math.round(Math.max(...temperatures)) : null,
-    min_temperature:
-      temperatures.length > 0 ? Math.round(Math.min(...temperatures)) : null,
-  };
-};
-
-/**
- * 날씨 도구; OpenWeatherMap 예보 응답을 page-header next days 형태로 변환
- * @param {OWM_Res_Weather_Forecast} [forecast] OpenWeatherMap 예보 응답
- * @return {{ day_1?: API_Res_WeatherKoreaNextDays; day_2?: API_Res_WeatherKoreaNextDays }} 내일/모레 예보
- */
-export const getOpenWeatherMapNextDays = (
-  forecast?: OWM_Res_Weather_Forecast,
-): {
-  day_1?: API_Res_WeatherKoreaNextDays;
-  day_2?: API_Res_WeatherKoreaNextDays;
-} => {
-  if (!Array.isArray(forecast?.list)) return {};
-
-  const timezoneSeconds = forecast.city?.timezone ?? 0;
-  const todayKey = getOpenWeatherMapDateKey(forecast);
-  const grouped = forecast.list.reduce<
-    Record<string, OWM_Res_Weather_Forecast_Item[]>
-  >((days, item) => {
-    const dateKey = getForecastItemDateKey(item, timezoneSeconds);
-    if (dateKey === todayKey) return days;
-
-    days[dateKey] = [...(days[dateKey] || []), item];
-    return days;
-  }, {});
-  const [day1Key, day2Key] = Object.keys(grouped).sort();
-
-  return {
-    day_1: day1Key ? toOpenWeatherMapDayForecast(grouped[day1Key]) : undefined,
-    day_2: day2Key ? toOpenWeatherMapDayForecast(grouped[day2Key]) : undefined,
-  };
-};
-
-/**
- * 날씨 도구; OpenWeatherMap 예보 응답을 오늘 최고/최저 형태로 변환
- * @param {OWM_Res_Weather_Forecast} [forecast] OpenWeatherMap 예보 응답
- * @return {API_Res_WeatherKoreaNextDays | undefined} 오늘 최고/최저 예보
- */
-export const getOpenWeatherMapTodayForecast = (
-  forecast?: OWM_Res_Weather_Forecast,
-): API_Res_WeatherKoreaNextDays | undefined => {
-  if (!Array.isArray(forecast?.list)) return undefined;
-
-  const timezoneSeconds = forecast.city?.timezone ?? 0;
-  const todayKey = getOpenWeatherMapDateKey(forecast);
-  const todayItems = forecast.list.filter(
-    item => getForecastItemDateKey(item, timezoneSeconds) === todayKey,
-  );
-
-  return toOpenWeatherMapDayForecast(todayItems);
-};
-
-export function now(
-  outputResponse: API_Res_WeatherKoreaNow,
-  apiResponse: KMA_Res_WeatherNow,
-): API_Res_WeatherKoreaNow {
-  const res: API_Res_WeatherKoreaNow = { ...outputResponse };
-
-  const items = apiResponse?.response?.body?.items?.item;
-  if (!items || !Array.isArray(items) || items.length === 0) return res;
-
-  const sky = getValueNow(items, "SKY"); // 없음
-  const pty = getValueNow(items, "PTY"); // 강수형태
-  const pcp = getValueNow(items, "RN1"); // 1시간 강수량 PCP없음
-  const snow = getValueNow(items, "SNO"); // 없음
-  const wind = getValueNow(items, "WSD");
-
-  const condition = getWeatherCondition({ sky, pty, pcp, snow });
-
-  const getDailyState: API_Res_WeatherKoreaBase = {
-    sky,
-    drop: pty,
-    rainAmount: getRainAmount({ pty, pcp }),
-    snowAmount: getSnowAmount({ pty, snow }),
-    windSpeed: getWindSpeed({ wind }),
-    condition: condition.code,
-    conditionName: condition.name,
-  };
-
-  res.today.temperature = getValueNow(items, "T1H");
-  res.today.humidity = getValueNow(items, "REH");
-
-  Object.assign(res.today, getDailyState);
-
-  return res;
-}
-
-export function forecast(
-  outputResponse: API_Res_WeatherKoreaForecast,
-  apiResponse: KMA_Res_WeatherForecast,
-): API_Res_WeatherKoreaForecast {
-  const res: API_Res_WeatherKoreaForecast = { ...outputResponse };
-
-  const items = apiResponse?.response?.body?.items?.item;
-  if (!items || !Array.isArray(items) || items.length === 0) return res;
-
-  const { today, tomorrow, dayAfterTomorrow } = getMoments();
-
-  const getDailyState = (date: string): API_Res_WeatherKoreaBase => {
-    const sky = getValueForecast(items, date, "SKY");
-    const pty = getValueForecast(items, date, "PTY");
-    const pcp = getValueForecast(items, date, "PCP");
-    const snow = getValueForecast(items, date, "SNO");
-    const wind = getValueForecast(items, date, "WSD");
-
-    const condition = getWeatherCondition({ sky, pty, pcp, snow });
-
-    return {
-      sky,
-      drop: pty,
-      rainAmount: getRainAmount({ pty, pcp }),
-      snowAmount: getSnowAmount({ pty, snow }),
-      windSpeed: getWindSpeed({ wind }),
-      condition: condition.code,
-      conditionName: condition.name,
-    };
-  };
-
-  res.today.temperature = getValueForecast(items, today, "TMP");
-  res.today.max_temperature = getValueForecast(items, today, "TMX");
-  res.today.min_temperature = getValueForecast(items, today, "TMN");
-  res.today.humidity = getValueForecast(items, today, "REH");
-  Object.assign(res.today, getDailyState(today));
-
-  res.day_1.max_temperature = getValueForecast(items, tomorrow, "TMX");
-  res.day_1.min_temperature = getValueForecast(items, tomorrow, "TMN");
-  Object.assign(res.day_1, getDailyState(tomorrow));
-
-  res.day_2.max_temperature = getValueForecast(items, dayAfterTomorrow, "TMX");
-  res.day_2.min_temperature = getValueForecast(items, dayAfterTomorrow, "TMN");
-  Object.assign(res.day_2, getDailyState(dayAfterTomorrow));
-
-  return res;
-}
-
-export const extractWeatherSummary = {
-  forecast,
-  now,
-};
+ * 날씨 도구; record shape 여부 확인.
+ * @util
+ * @desc unknown 값을 null이 아닌 object record로 좁힌다.
+ * @param {unknown} value 확인할 값
+ * @return {boolean} record shape 여부
+ */
+const isRecord = (value: unknown): value is Record<string, unknown> =>
+  typeof value === "object" && value !== null;
+
+/**
+ * 날씨 도구; backend normalized 현재 날씨 응답 여부 확인.
+ * @util
+ * @desc unknown 응답이 weather now shape로 사용할 수 있는지 좁힌다.
+ * @param {unknown} response 날씨 응답
+ * @return {boolean} normalized 현재 날씨 응답 여부
+ */
+export const isWeatherNowResponse = (
+  response?: unknown,
+): response is API_Res_WeatherNow =>
+  isRecord(response) && isRecord(response.today);
+
+/**
+ * 날씨 도구; backend normalized 예보 날씨 응답 여부 확인.
+ * @util
+ * @desc unknown 응답이 weather forecast shape로 사용할 수 있는지 좁힌다.
+ * @param {unknown} response 날씨 응답
+ * @return {boolean} normalized 예보 날씨 응답 여부
+ */
+export const isWeatherForecastResponse = (
+  response?: unknown,
+): response is API_Res_WeatherForecast =>
+  isRecord(response) &&
+  isRecord(response.today) &&
+  isRecord(response.day_1) &&
+  isRecord(response.day_2);
+
+/**
+ * 날씨 도구; backend normalized summary 응답 여부 확인.
+ * @util
+ * @desc unknown 응답이 weather summary shape로 사용할 수 있는지 좁힌다.
+ * @param {unknown} response 날씨 응답
+ * @return {boolean} normalized summary 응답 여부
+ */
+export const isWeatherSummaryResponse = (
+  response?: unknown,
+): response is API_Res_WeatherSummary =>
+  isRecord(response) &&
+  isWeatherNowResponse(response.now) &&
+  isWeatherForecastResponse(response.forecast) &&
+  isRecord(response.alert);