@uniai-fe/uds-templates 0.5.29 → 0.6.1

package/src/weather/types/base.ts

@@ -4,9 +4,13 @@
  * @property {number | null} longitude 경도
  */
 export type GeoCoordinate = {
-  /** 위도 */
+  /**
+   * 위도
+   */
   latitude: number | null;
-  /** 경도 */
+  /**
+   * 경도
+   */
   longitude: number | null;
 };
 
@@ -16,12 +20,32 @@ export type GeoCoordinate = {
  * @property {number | null} lng 경도
  */
 export type WeatherGeoCoordinate = {
-  /** 위도 */
+  /**
+   * 위도
+   */
   lat: number | null;
-  /** 경도 */
+  /**
+   * 경도
+   */
   lng: number | null;
 };
 
+/**
+ * 날씨 backend에서 사용하는 격자 좌표.
+ * @property {number | null} nx 격자 X
+ * @property {number | null} ny 격자 Y
+ */
+export type WeatherGridCoordinate = {
+  /**
+   * 격자 X
+   */
+  nx: number | null;
+  /**
+   * 격자 Y
+   */
+  ny: number | null;
+};
+
 /**
  * 날씨 API locale 요청 옵션.
  * @property {string} [locale] 요청 언어 코드. 기본 지원값은 ko, en, ja이며 타입은 확장 가능한 string으로 유지한다.
@@ -33,38 +57,13 @@ export interface WeatherApiLocaleOptions {
   locale?: string;
 }
 
-/**
- * OpenWeatherMap 요청 파라미터.
- * @property {number | null} lat 위도
- * @property {number | null} lng 경도
- * @property {string} [locale] 요청 언어 코드
- */
-export type WeatherOpenWeatherMapParams = WeatherGeoCoordinate &
-  WeatherApiLocaleOptions;
-
 /**
  * 좌표와 주소 정보를 함께 담는 구조.
  * @property {string | null} address 좌표 주소
  */
 export type WeatherCoordinate = {
-  /** 좌표 주소 */
+  /**
+   * 좌표 주소
+   */
   address: string | null;
 } & WeatherGeoCoordinate;
-
-/**
- * 날씨 로직에서 사용하는 날짜 기준값 모음.
- * @property {Date} now 현재 시각
- * @property {string} today 오늘 날짜(yyyymmdd)
- * @property {string} tomorrow 내일 날짜(yyyymmdd)
- * @property {string} dayAfterTomorrow 모레 날짜(yyyymmdd)
- */
-export type WeatherUtilDateTimeMoments = {
-  /** 현재 시각 */
-  now: Date;
-  /** 오늘 날짜(yyyymmdd) */
-  today: string;
-  /** 내일 날짜(yyyymmdd) */
-  tomorrow: string;
-  /** 모레 날짜(yyyymmdd) */
-  dayAfterTomorrow: string;
-};

package/src/weather/types/index.ts

@@ -1,6 +1,3 @@
 export type * from "./base";
 export type * from "./api";
-export type * from "./korea";
-export type * from "./open-weather-map";
 export type * from "./page-header";
-export type * from "./provider";

package/src/weather/types/page-header.ts

@@ -1,15 +1,12 @@
 import type {
-  API_Res_WeatherKoreaForecast,
-  API_Res_WeatherKoreaNextDays,
-  API_Res_WeatherKoreaNow,
+  API_Res_WeatherAlertItem,
+  API_Res_WeatherForecast,
+  API_Res_WeatherNextDays,
+  API_Res_WeatherNow,
 } from "./api";
-import type {
-  OWM_Res_Weather_Forecast,
-  OWM_Res_Weather_Now,
-} from "./open-weather-map";
 
 /**
- * Weather Page Header; locale 옵션
+ * Weather Page Header; locale 옵션.
  * @property {string} [locale] 표시 언어 코드. 기본 지원값은 ko, en, ja이며 타입은 확장 가능한 string으로 유지한다.
  */
 export interface WeatherLocaleOptions {
@@ -20,7 +17,7 @@ export interface WeatherLocaleOptions {
 }
 
 /**
- * Weather Page Header; 텍스트 옵션
+ * Weather Page Header; 텍스트 옵션.
  * @property {string} currentWeatherLoading 현재 날씨 로딩 문구
  * @property {string} forecastWeatherLoading 예보 날씨 로딩 문구
  * @property {string} alertLoading 특보 로딩 문구
@@ -106,11 +103,15 @@ export interface WeatherPageHeaderTexts {
 }
 
 /**
- * Weather Page Header; locale과 텍스트 override 조합 옵션
+ * Weather Page Header; locale과 텍스트 override 조합 옵션.
  * @property {string} [locale] 표시 언어 코드
  * @property {Partial<WeatherPageHeaderTexts>} [texts] 서비스에서 주입한 표시 문구
  */
 export interface WeatherPageHeaderLocaleOptions extends WeatherLocaleOptions {
+  /**
+   * 표시 언어 코드
+   */
+  locale?: string;
   /**
    * 서비스에서 주입한 표시 문구
    */
@@ -118,47 +119,32 @@ export interface WeatherPageHeaderLocaleOptions extends WeatherLocaleOptions {
 }
 
 /**
- * Weather Page Header; KMA weather query 결과
- * @property {API_Res_WeatherKoreaNow} [now] 현재 날씨 응답
- * @property {API_Res_WeatherKoreaForecast} [forecast] 예보 날씨 응답
+ * Weather Page Header; 통합 weather query 결과.
+ * @property {API_Res_WeatherNow} [now] 현재 날씨 응답
+ * @property {API_Res_WeatherForecast} [forecast] 예보 날씨 응답
+ * @property {API_Res_WeatherAlertItem[]} alert 특보 목록
+ * @property {boolean} isFetching 현재/예보/특보 조회 상태
  * @property {boolean} isFetchingNow 현재 날씨 조회 상태
  * @property {boolean} isFetchingForecast 예보 날씨 조회 상태
+ * @property {boolean} isFetchingAlert 특보 조회 상태
  */
-export interface WeatherPageHeaderKoreaWeather {
+export interface WeatherPageHeaderWeather {
   /**
    * 현재 날씨 응답
    */
-  now?: API_Res_WeatherKoreaNow;
+  now?: API_Res_WeatherNow;
   /**
    * 예보 날씨 응답
    */
-  forecast?: API_Res_WeatherKoreaForecast;
-  /**
-   * 현재 날씨 조회 상태
-   */
-  isFetchingNow: boolean;
-  /**
-   * 예보 날씨 조회 상태
-   */
-  isFetchingForecast: boolean;
-}
-
-/**
- * Weather Page Header; OpenWeatherMap query 결과
- * @property {OWM_Res_Weather_Now} [now] 현재 날씨 응답
- * @property {OWM_Res_Weather_Forecast} [forecast] 예보 날씨 응답
- * @property {boolean} isFetchingNow 현재 날씨 조회 상태
- * @property {boolean} isFetchingForecast 예보 날씨 조회 상태
- */
-export interface WeatherPageHeaderOpenWeatherMapWeather {
+  forecast?: API_Res_WeatherForecast;
   /**
-   * 현재 날씨 응답
+   * 특보 목록
    */
-  now?: OWM_Res_Weather_Now;
+  alert: API_Res_WeatherAlertItem[];
   /**
-   * 예보 날씨 응답
+   * 현재/예보/특보 조회 상태
    */
-  forecast?: OWM_Res_Weather_Forecast;
+  isFetching: boolean;
   /**
    * 현재 날씨 조회 상태
    */
@@ -167,73 +153,137 @@ export interface WeatherPageHeaderOpenWeatherMapWeather {
    * 예보 날씨 조회 상태
    */
   isFetchingForecast: boolean;
+  /**
+   * 특보 조회 상태
+   */
+  isFetchingAlert: boolean;
 }
 
 /**
- * Weather Page Header; 상위 container에서 준비한 weather query 결과
- * @property {WeatherPageHeaderKoreaWeather} [koreaWeather] KMA weather query 결과
- * @property {WeatherPageHeaderOpenWeatherMapWeather} [openWeatherMapWeather] OpenWeatherMap query 결과
+ * Weather Page Header; 상위 container에서 준비한 weather query 결과.
+ * @property {WeatherPageHeaderWeather} [weather] 통합 weather query 결과
  */
 export interface WeatherPageHeaderDataOptions {
   /**
-   * KMA weather query 결과
+   * 통합 weather query 결과
    */
-  koreaWeather?: WeatherPageHeaderKoreaWeather;
-  /**
-   * OpenWeatherMap query 결과
-   */
-  openWeatherMapWeather?: WeatherPageHeaderOpenWeatherMapWeather;
+  weather?: WeatherPageHeaderWeather;
 }
 
 /**
- * Weather Page Header; container props
+ * Weather Page Header; container props.
  * @property {string} [locale] 표시 언어 코드
  * @property {Partial<WeatherPageHeaderTexts>} [texts] 서비스에서 주입한 표시 문구
  */
-export type WeatherPageHeaderContainerProps = WeatherPageHeaderLocaleOptions;
+export interface WeatherPageHeaderContainerProps extends WeatherPageHeaderLocaleOptions {
+  /**
+   * 표시 언어 코드
+   */
+  locale?: string;
+  /**
+   * 서비스에서 주입한 표시 문구
+   */
+  texts?: Partial<WeatherPageHeaderTexts>;
+}
 
 /**
- * Weather Page Header; address props
+ * Weather Page Header; address props.
  * @property {string} [locale] 표시 언어 코드
  * @property {Partial<WeatherPageHeaderTexts>} [texts] 서비스에서 주입한 표시 문구
  */
-export type WeatherPageHeaderAddressProps = WeatherPageHeaderLocaleOptions;
+export interface WeatherPageHeaderAddressProps extends WeatherPageHeaderLocaleOptions {
+  /**
+   * 표시 언어 코드
+   */
+  locale?: string;
+  /**
+   * 서비스에서 주입한 표시 문구
+   */
+  texts?: Partial<WeatherPageHeaderTexts>;
+}
 
 /**
- * Weather Page Header; today props
+ * Weather Page Header; today props.
  * @property {string} [locale] 표시 언어 코드
  * @property {Partial<WeatherPageHeaderTexts>} [texts] 서비스에서 주입한 표시 문구
- * @property {WeatherPageHeaderKoreaWeather} [koreaWeather] KMA weather query 결과
- * @property {WeatherPageHeaderOpenWeatherMapWeather} [openWeatherMapWeather] OpenWeatherMap query 결과
+ * @property {WeatherPageHeaderWeather} [weather] 상위 container에서 준비한 통합 weather query 결과
  */
-export type WeatherPageHeaderTodayProps = WeatherPageHeaderLocaleOptions &
-  WeatherPageHeaderDataOptions;
+export interface WeatherPageHeaderTodayProps
+  extends WeatherPageHeaderLocaleOptions, WeatherPageHeaderDataOptions {
+  /**
+   * 표시 언어 코드
+   */
+  locale?: string;
+  /**
+   * 서비스에서 주입한 표시 문구
+   */
+  texts?: Partial<WeatherPageHeaderTexts>;
+  /**
+   * 통합 weather query 결과
+   */
+  weather?: WeatherPageHeaderWeather;
+}
 
 /**
- * Weather Page Header; forecast props
+ * Weather Page Header; forecast props.
  * @property {string} [locale] 표시 언어 코드
  * @property {Partial<WeatherPageHeaderTexts>} [texts] 서비스에서 주입한 표시 문구
- * @property {WeatherPageHeaderKoreaWeather} [koreaWeather] KMA weather query 결과
- * @property {WeatherPageHeaderOpenWeatherMapWeather} [openWeatherMapWeather] OpenWeatherMap query 결과
+ * @property {WeatherPageHeaderWeather} [weather] 상위 container에서 준비한 통합 weather query 결과
  */
-export type WeatherPageHeaderForecastProps = WeatherPageHeaderLocaleOptions &
-  WeatherPageHeaderDataOptions;
+export interface WeatherPageHeaderForecastProps
+  extends WeatherPageHeaderLocaleOptions, WeatherPageHeaderDataOptions {
+  /**
+   * 표시 언어 코드
+   */
+  locale?: string;
+  /**
+   * 서비스에서 주입한 표시 문구
+   */
+  texts?: Partial<WeatherPageHeaderTexts>;
+  /**
+   * 통합 weather query 결과
+   */
+  weather?: WeatherPageHeaderWeather;
+}
 
 /**
- * Weather Page Header; alert props
+ * Weather Page Header; alert props.
  * @property {string} [locale] 표시 언어 코드
  * @property {Partial<WeatherPageHeaderTexts>} [texts] 서비스에서 주입한 표시 문구
+ * @property {WeatherPageHeaderWeather} [weather] 상위 container에서 준비한 통합 weather query 결과
  */
-export type WeatherPageHeaderAlertProps = WeatherPageHeaderLocaleOptions;
+export interface WeatherPageHeaderAlertProps
+  extends WeatherPageHeaderLocaleOptions, WeatherPageHeaderDataOptions {
+  /**
+   * 표시 언어 코드
+   */
+  locale?: string;
+  /**
+   * 서비스에서 주입한 표시 문구
+   */
+  texts?: Partial<WeatherPageHeaderTexts>;
+  /**
+   * 통합 weather query 결과
+   */
+  weather?: WeatherPageHeaderWeather;
+}
 
 /**
- * Weather Page Header; next days props
+ * Weather Page Header; next days props.
  * @property {string} title 날짜 라벨
- * @property {API_Res_WeatherKoreaNextDays} [data] 예보 데이터
+ * @property {API_Res_WeatherNextDays} [data] 예보 데이터
  * @property {string} [locale] 표시 언어 코드
  * @property {Partial<WeatherPageHeaderTexts>} [texts] 서비스에서 주입한 표시 문구
  */
 export interface WeatherPageHeaderNextDaysProps extends WeatherPageHeaderLocaleOptions {
+  /**
+   * 표시 언어 코드
+   */
+  locale?: string;
+  /**
+   * 서비스에서 주입한 표시 문구
+   */
+  texts?: Partial<WeatherPageHeaderTexts>;
   /**
    * 날짜 라벨
    */
@@ -241,11 +291,11 @@ export interface WeatherPageHeaderNextDaysProps extends WeatherPageHeaderLocaleO
   /**
    * 예보 데이터
    */
-  data?: API_Res_WeatherKoreaNextDays;
+  data?: API_Res_WeatherNextDays;
 }
 
 /**
- * Weather Icon; 날씨 아이콘 props
+ * Weather Icon; 날씨 아이콘 props.
  * @property {string | null} [code] 날씨 아이콘 코드
  * @property {string | null} [name] 날씨 상태 이름
  * @property {string} [alt] 아이콘 대체 텍스트 fallback
@@ -266,7 +316,7 @@ export interface WeatherIconProps {
 }
 
 /**
- * Weather Address Icon; 위치 아이콘 props
+ * Weather Address Icon; 위치 아이콘 props.
  * @property {string} [alt] 아이콘 대체 텍스트
  */
 export interface WeatherAddressIconProps {

package/src/weather/utils/index.ts

@@ -1,5 +1,7 @@
 export * from "./location";
-export * from "./date-time";
-export * from "./weather";
-export * from "./alert";
-export * from "./locale";
+export {
+  isWeatherForecastResponse,
+  isWeatherNowResponse,
+  isWeatherSummaryResponse,
+} from "./weather";
+export { getWeatherLocaleKey, resolveWeatherPageHeaderTexts } from "./locale";

package/src/weather/utils/locale.ts

@@ -1,8 +1,4 @@
-import type {
-  WeatherPageHeaderTexts,
-  WeatherProviderCapabilityRegistry,
-  WeatherProviderKey,
-} from "../types";
+import type { WeatherPageHeaderTexts } from "../types";
 
 const WEATHER_PAGE_HEADER_DEFAULT_TEXTS: WeatherPageHeaderTexts = {
   currentWeatherLoading: "현재 날씨 불러오는 중...",
@@ -23,34 +19,10 @@ const WEATHER_PAGE_HEADER_DEFAULT_TEXTS: WeatherPageHeaderTexts = {
   alertIssueCommandLabel: "발령",
 };
 
-const OPEN_WEATHER_MAP_LANG_BY_LOCALE: Record<string, string> = {
-  ko: "kr",
-  en: "en",
-  ja: "ja",
-};
-
-const WEATHER_DEFAULT_PROVIDER: WeatherProviderKey = "openWeatherMap";
-
-const WEATHER_PROVIDER_BY_LOCALE_KEY: Record<string, WeatherProviderKey> = {
-  ko: "kma",
-};
-
-export const WEATHER_PROVIDER_CAPABILITIES: WeatherProviderCapabilityRegistry =
-  {
-    kma: {
-      now: true,
-      forecast: true,
-      alert: true,
-    },
-    openWeatherMap: {
-      now: true,
-      forecast: true,
-      alert: false,
-    },
-  };
-
 /**
- * Weather Locale; locale 기준 키 정규화
+ * Weather Locale; locale 기준 키 정규화.
+ * @util
+ * @desc service locale 문자열에서 weather API/표시 로직에 사용할 기본 언어 키를 추출한다.
  * @param {string} [locale] locale 코드
  * @return {string} 전달된 locale의 기본 언어 코드
  * @example
@@ -60,30 +32,9 @@ export const getWeatherLocaleKey = (locale?: string): string =>
   locale?.trim().toLowerCase().split(/[-_]/)[0] || "ko";
 
 /**
- * Weather Locale; locale 기준 provider 선택
- * @param {string} [locale] locale 코드
- * @return {WeatherProviderKey} 현재 locale에 사용할 weather provider
- * @example
- * resolveWeatherProvider("ko-KR")
- */
-export const resolveWeatherProvider = (locale?: string): WeatherProviderKey => {
-  const localeKey = getWeatherLocaleKey(locale);
-
-  return WEATHER_PROVIDER_BY_LOCALE_KEY[localeKey] ?? WEATHER_DEFAULT_PROVIDER;
-};
-
-/**
- * Weather Locale; KMA provider 사용 여부
- * @param {string} [locale] locale 코드
- * @return {boolean} KMA provider 대상 locale 여부
- * @example
- * isKoreaWeatherLocale("ko-KR")
- */
-export const isKoreaWeatherLocale = (locale?: string): boolean =>
-  resolveWeatherProvider(locale) === "kma";
-
-/**
- * Weather Locale; page-header 텍스트 병합
+ * Weather Locale; page-header 텍스트 병합.
+ * @util
+ * @desc service가 주입한 일부 표시 문구를 weather page-header 기본 문구와 병합한다.
  * @param {Partial<WeatherPageHeaderTexts>} [texts] 서비스에서 주입한 텍스트
  * @return {WeatherPageHeaderTexts} 기본 fallback과 서비스 주입 텍스트를 병합한 텍스트
  * @example
@@ -95,16 +46,3 @@ export const resolveWeatherPageHeaderTexts = (
   ...WEATHER_PAGE_HEADER_DEFAULT_TEXTS,
   ...texts,
 });
-
-/**
- * Weather Locale; OpenWeatherMap API lang 값 변환
- * @param {string} [locale] locale 코드
- * @return {string} OpenWeatherMap lang 파라미터
- * @example
- * getOpenWeatherMapLang("ko")
- */
-export const getOpenWeatherMapLang = (locale?: string): string => {
-  const localeKey = getWeatherLocaleKey(locale);
-
-  return OPEN_WEATHER_MAP_LANG_BY_LOCALE[localeKey] ?? localeKey;
-};