@xfilecom/xframe 0.1.36 → 0.1.37

package/defaults.json

@@ -1,4 +1,4 @@
 {
-  "backendCore": "^1.0.16",
-  "frontCore": "^0.2.22"
+  "backendCore": "^1.0.17",
+  "frontCore": "^0.2.23"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xfilecom/xframe",
-  "version": "0.1.36",
+  "version": "0.1.37",
   "description": "Scaffold full-stack app: Nest + @xfilecom/backend-core, Vite/React + @xfilecom/front-core",
   "license": "UNLICENSED",
   "bin": {

package/template/shared/endpoint/endpoint.ts

@@ -49,7 +49,7 @@ export const healthEndpoint: EndpointDef = {
 export const appMetaEndpoint: EndpointDef = {
   method: 'GET',
   path: '/app-meta',
-  post: unwrapResponseData,
+  /** 공통 `{ code, data, error }` 는 axios 인터셉터에서 `data` 로 치환 */
   showIndicator: false,
   timeoutMs: 10_000,
 };

package/template/web/shared/src/api/client.ts

@@ -1,5 +1,6 @@
 /**
  * Axios — baseURL, 로깅 인터셉터, 전역 훅(onRequestStart/End), Bearer
+ * HTTP 200/201 본문이 `{ code, data, error }` 이면 code 검사 후 data 로 치환 또는 토스트+reject
  */
 
 import axios, {
@@ -8,25 +9,43 @@ import axios, {
   type InternalAxiosRequestConfig,
 } from 'axios';
 import { sessionStore } from '../store/session-store';
+import {
+  applyCommonResponseEnvelope,
+  CommonResponseRejectedError,
+  formatCommonErrorField,
+  isCommonResponsePayload,
+} from './commonResponse';
 
 const LOG_PREFIX = '[xframe/http]';
 
 export type OnRequestStart = () => void;
 export type OnRequestEnd = () => void;
 export type OnError = (message: string, code?: string | number) => void;
+export type OnCommonBusinessError = (message: string, appCode: number) => void;
 
 let onRequestStart: OnRequestStart = () => {};
 let onRequestEnd: OnRequestEnd = () => {};
 let onError: OnError = () => {};
+let onCommonBusinessError: OnCommonBusinessError = () => {};
+
+export { CommonResponseRejectedError } from './commonResponse';
+export {
+  COMMON_RESPONSE_SUCCESS_CODE,
+  formatCommonErrorField,
+  isCommonResponsePayload,
+} from './commonResponse';
 
 export function setApiHooks(hooks: {
   onRequestStart?: OnRequestStart;
   onRequestEnd?: OnRequestEnd;
   onError?: OnError;
+  /** HTTP 정상(2xx)인데 body.code !== 0 일 때 (토스트 등) */
+  onCommonBusinessError?: OnCommonBusinessError;
 }) {
   if (hooks.onRequestStart) onRequestStart = hooks.onRequestStart;
   if (hooks.onRequestEnd) onRequestEnd = hooks.onRequestEnd;
   if (hooks.onError) onError = hooks.onError;
+  if (hooks.onCommonBusinessError) onCommonBusinessError = hooks.onCommonBusinessError;
 }
 
 export const apiClient = axios.create({
@@ -104,28 +123,37 @@ apiClient.interceptors.response.use(
     const c = response.config as ExtConfig;
     if (!c.skipGlobalIndicator) onRequestEnd();
     logResponseSuccess(response);
+    try {
+      applyCommonResponseEnvelope(response, onCommonBusinessError);
+    } catch (e) {
+      return Promise.reject(e);
+    }
     return response;
   },
   (err: AxiosError) => {
     const c = err.config as ExtConfig | undefined;
     if (!c?.skipGlobalIndicator) onRequestEnd();
     logResponseError(err);
-    const res = err?.response as
-      | { data?: { message?: unknown; error?: unknown; code?: string | number }; status?: number }
-      | undefined;
-    const raw = res?.data?.message ?? res?.data?.error ?? (err as Error)?.message ?? 'Request failed';
+    const resData = err.response?.data;
+    let raw: unknown =
+      isCommonResponsePayload(resData) ? resData.error : undefined;
+    if (raw === undefined) {
+      raw =
+        (err.response?.data as { message?: unknown; error?: unknown } | undefined)?.message ??
+        (err.response?.data as { message?: unknown; error?: unknown } | undefined)?.error ??
+        (err as Error)?.message ??
+        'Request failed';
+    }
     const message =
       typeof raw === 'string'
         ? raw
         : Array.isArray(raw)
           ? raw.map((x) => (typeof x === 'string' ? x : String(x))).join(', ')
-          : typeof raw === 'object' &&
-              raw != null &&
-              'message' in raw &&
-              typeof (raw as { message: unknown }).message === 'string'
-            ? (raw as { message: string }).message
-            : JSON.stringify(raw);
-    const code = res?.status ?? (res?.data?.code as string | number | undefined);
+          : formatCommonErrorField(raw);
+    const code =
+      err.response?.status ??
+      (isCommonResponsePayload(resData) ? resData.code : undefined) ??
+      (err.response?.data as { code?: string | number } | undefined)?.code;
     onError(message, code);
     return Promise.reject(err);
   },

package/template/web/shared/src/api/commonResponse.ts

@@ -0,0 +1,80 @@
+/**
+ * 서버 공통 본문: HTTP 200/201 + body `{ code, data, error }`
+ * — 비즈니스 실패는 code !== 0 (HTTP는 정상).
+ */
+
+import type { AxiosResponse } from 'axios';
+
+/** 백엔드와 동일한 “성공” 코드 */
+export const COMMON_RESPONSE_SUCCESS_CODE = 0 as const;
+
+export class CommonResponseRejectedError extends Error {
+  readonly appCode: number;
+  readonly payload: unknown;
+
+  constructor(message: string, appCode: number, payload: unknown) {
+    super(message);
+    this.name = 'CommonResponseRejectedError';
+    this.appCode = appCode;
+    this.payload = payload;
+  }
+}
+
+export function isCommonResponsePayload(
+  body: unknown,
+): body is { code: number; data: unknown; error?: unknown } {
+  if (body === null || typeof body !== 'object') return false;
+  const b = body as Record<string, unknown>;
+  return typeof b.code === 'number' && 'data' in b;
+}
+
+function extractMessageString(value: unknown): string | null {
+  if (value == null) return null;
+  if (typeof value === 'string') return value;
+  if (Array.isArray(value)) {
+    const first = value.find((x) => typeof x === 'string');
+    return first ?? (value.map((x) => (typeof x === 'string' ? x : String(x))).join(', ') || null);
+  }
+  if (typeof value === 'object' && 'message' in value) {
+    const inner = (value as { message: unknown }).message;
+    return extractMessageString(inner);
+  }
+  return null;
+}
+
+/** `error` 필드를 사용자용 문구로 */
+export function formatCommonErrorField(error: unknown): string {
+  const extracted = extractMessageString(error);
+  if (extracted) return extracted;
+  if (typeof error === 'string') return error;
+  if (error != null && typeof error === 'object') {
+    try {
+      return JSON.stringify(error);
+    } catch {
+      return 'Request failed';
+    }
+  }
+  return 'Request failed';
+}
+
+export type OnCommonBusinessError = (message: string, appCode: number) => void;
+
+/**
+ * 성공 인터셉터에서 호출: 공통 래핑이면 code 검사 후 data 로 치환하거나 reject.
+ */
+export function applyCommonResponseEnvelope(
+  response: AxiosResponse,
+  onBusinessError: OnCommonBusinessError,
+): unknown {
+  const body = response.data;
+  if (!isCommonResponsePayload(body)) {
+    return response;
+  }
+  if (body.code !== COMMON_RESPONSE_SUCCESS_CODE) {
+    const msg = formatCommonErrorField(body.error);
+    onBusinessError(msg, body.code);
+    throw new CommonResponseRejectedError(msg, body.code, body);
+  }
+  response.data = body.data;
+  return response;
+}

package/template/web/shared/src/api/methods/health.method.ts

@@ -1,9 +1,9 @@
-import type { CommonEnvelope, HealthData } from '../../types/api';
+import type { HealthData } from '../../types/api';
 import type { ApiMethodConfig, ApiMethodStore } from '../types';
 import { healthEndpoint } from '@shared/endpoint';
 
 /** GET /health — params·body 없음, 스토어는 validate/post 에서 사용 가능 */
-export const healthMethod: ApiMethodConfig<void, CommonEnvelope<HealthData>, ApiMethodStore> = {
+export const healthMethod: ApiMethodConfig<void, HealthData, ApiMethodStore> = {
   schema: {},
   endpoint: healthEndpoint,
   ui: {

package/template/web/shared/src/index.ts

@@ -10,7 +10,16 @@ export {
   useSessionStore,
 } from './context/StoreProvider';
 
-export { configureApi, getApiBaseUrl, setApiHooks, apiClient } from './api/client';
+export {
+  configureApi,
+  getApiBaseUrl,
+  setApiHooks,
+  apiClient,
+  CommonResponseRejectedError,
+  COMMON_RESPONSE_SUCCESS_CODE,
+  formatCommonErrorField,
+  isCommonResponsePayload,
+} from './api/client';
 export { sendRequest, type RequestTransportOptions } from './api/request';
 export type { EndpointDef, HttpMethod } from '@shared/endpoint';
 export { healthEndpoint, appMetaEndpoint, unwrapResponseData } from '@shared/endpoint';

package/template/web/shared/src/methods/health.ts

@@ -1,8 +1,8 @@
 import { sendRequest } from '../api/request';
 import { healthEndpoint } from '@shared/endpoint';
-import type { CommonEnvelope, HealthData } from '../types/api';
+import type { HealthData } from '../types/api';
 
 /** 직접 호출용 (토스트 없음) — UI 훅은 보통 이 함수 사용 */
-export async function fetchHealth(): Promise<CommonEnvelope<HealthData>> {
-  return sendRequest<unknown, CommonEnvelope<HealthData>>(healthEndpoint, {});
+export async function fetchHealth(): Promise<HealthData> {
+  return sendRequest<unknown, HealthData>(healthEndpoint, {});
 }

package/template/web/shared/src/store/root-store.ts

@@ -4,6 +4,11 @@
 
 import { makeAutoObservable, runInAction } from 'mobx';
 import { setApiHooks } from '../api/client';
+import {
+  CommonResponseRejectedError,
+  formatCommonErrorField,
+  isCommonResponsePayload,
+} from '../api/commonResponse';
 import { sendRequest } from '../api/request';
 import type {
   ApiMethodConfig,
@@ -53,8 +58,14 @@ function extractMessageString(value: unknown): string | null {
 }
 
 function getErrorMessage(e: unknown): string {
-  const err = e as { response?: { data?: { message?: unknown; error?: unknown } }; message?: string };
-  const raw = err?.response?.data?.message ?? err?.response?.data?.error ?? err?.message;
+  if (e instanceof CommonResponseRejectedError) return e.message;
+  const err = e as { response?: { data?: unknown }; message?: string };
+  const resData = err?.response?.data;
+  if (isCommonResponsePayload(resData)) {
+    return formatCommonErrorField(resData.error);
+  }
+  const d = resData as { message?: unknown; error?: unknown } | undefined;
+  const raw = d?.message ?? d?.error ?? err?.message;
   const extracted = extractMessageString(raw);
   if (extracted) return extracted;
   if (raw != null && typeof raw === 'string') return raw;
@@ -94,6 +105,9 @@ export class RootStore {
         runInAction(() => this._endRequest());
       },
       onError: () => {},
+      onCommonBusinessError: (message) => {
+        runInAction(() => this.addToast(message, 'error'));
+      },
     });
   }
 
@@ -225,7 +239,7 @@ export class RootStore {
         }
         return result;
       } catch (e) {
-        if (showErrorToast) {
+        if (showErrorToast && !(e instanceof CommonResponseRejectedError)) {
           runInAction(() => this.addToast(getErrorMessage(e), 'error'));
         }
         throw e;
@@ -344,7 +358,9 @@ export class RootStore {
       return data;
     } catch (e) {
       runInAction(() => {
-        if (showErrorToast) this.addToast(getErrorMessage(e), 'error');
+        if (showErrorToast && !(e instanceof CommonResponseRejectedError)) {
+          this.addToast(getErrorMessage(e), 'error');
+        }
       });
       throw e;
     } finally {