@uniai-fe/util-functions 0.1.0 → 0.2.0

package/dist/api/index.d.cts

@@ -1,5 +1,31 @@
 export { D as DateTimeFormatOptionsType } from '../type-CNV_n0-w.cjs';
 
+/**
+ * 콘솔로그; Next.js API Route 디버깅용
+ * @util
+ * @param {string} method GET, POST, DELETE
+ * @param {string} routeUrl Next.js route API route URL
+ * @param {string} [queryUrl] DB API route URL
+ * @param {unknown[]} [messages] 로그 데이터
+ */
+declare const nextAPILog: (method: string, routeUrl: string, queryUrl?: string, ...messages: unknown[]) => void;
+/**
+ * API; 쿼리스트링 생성
+ * @util
+ * @param {unknown} [searchParams] 쿼리스트링으로 변환할 객체
+ * @return {string} 쿼리스트링
+ */
+declare const getQueryString: (searchParams?: unknown) => string;
+/**
+ * API; POST/DELETE method option
+ */
+declare const getFetchOptions: ({ method, headers, body, }: {
+    method: string;
+} & Partial<{
+    headers: HeadersInit;
+    body: BodyInit | null;
+}>) => RequestInit;
+
 type InfraKey = "ai" | "db" | "uniai" | (string & {});
 type CommonPostResponseType = {
     is_ok: boolean;
@@ -8,6 +34,7 @@ type CommonPostResponseType = {
     error: string;
 };
 type DomainResolver<Infra extends InfraKey = InfraKey> = (infra: Infra) => string | undefined;
+type EnvDomainMap<Infra extends InfraKey = InfraKey> = Partial<Record<Infra, string>>;
 type ApiLogger = (method: string, routeUrl: string, queryUrl?: string, ...messages: unknown[]) => void;
 type BackendApiConfig<Infra extends InfraKey = InfraKey> = {
     resolveDomain: DomainResolver<Infra>;
@@ -34,22 +61,182 @@ type FetchBackendQueryOptions<Infra extends InfraKey, FetchRequestType extends o
 };
 
 /**
- * 기본 API 로거.
- * 개발 환경에서만 동작하며 요청/응답 정보를 콘솔에 출력합니다.
+ * API 요청 url 생성; GET 타입
+ * @util
+ * @param {object} props
+ * @param {"ai" | "db" | string} props.domain API 인프라
+ * @param {string} props.routeUrl Next.js /app/api 라우트 주소
+ * @param {string} props.queryUrl 백엔드 API url
+ * @param {URLSearchParams} [props.searchParams] 쿼리 스트링 추출
+ * @param {object} [props.log] 디버깅용 서버 로그 정보
+ * @param {boolean} [props.logDisabled] 로그 비활성화
+ * @return {string} GET API 요청 full url
  */
-declare const defaultLogger: ApiLogger;
+declare const generateBackendQueryUrl_GET: ({ domain, routeUrl, queryUrl, searchParams, log, logDisabled, }: {
+    /**
+     * API 도메인
+     */
+    domain: string;
+    /**
+     * Next.js /app/api 라우트 주소
+     */
+    routeUrl: string;
+    /**
+     * 백엔드 API url
+     */
+    queryUrl: string;
+} & Partial<{
+    /**
+     * 쿼리 스트링
+     * @desc
+     * - URLSearchParams 객체로 가공된 파라미터
+     */
+    searchParams: URLSearchParams | object;
+    /**
+     * 디버깅용 서버 로그 정보
+     */
+    log: object;
+    /**
+     * 로그 비활성화
+     * @default false
+     */
+    logDisabled: boolean;
+}>) => string;
 /**
- * 객체나 URLSearchParams를 쿼리스트링으로 직렬화합니다.
+ * API fetch 요청; POST/DELETE 타입
+ * @util
+ * @param {object} props
+ * @param {"ai" | "db" | string} props.infra API 인프라
+ * @param {"POST" | "DELETE"} props.method POST, DELETE
+ * @param {string} props.routeUrl Next.js /app/api 라우트 주소
+ * @param {string} props.queryUrl 백엔드 API url
+ * @param {HeadersInit} [props.headers] fetch Headers
+ * @param {BodyInit | null} [props.body] post/delete body (이대로 바로 전송됨)
+ * @param {object} [props.bodyData] body로 전송하기 위해 가공이 필요한 데이터 객체
+ * @param {object} [props.queryStringData] url에 쿼리스트링으로 요청하는 경우에 대한 데이터 객체
+ * @param {object} [props.log] 디버깅용 서버 로그 정보
+ * @param {boolean} [props.logDisabled] 로그 비활성화
+ * @param {boolean} [props.fetchDisabled] fetch 실행 비활성화
+ * @return {Promise<MutateAPICommonResponseType>} POST, DELETE 응답
  */
-declare const getQueryString: (searchParams?: unknown) => string;
+declare const fetchBackendQuery: <FetchRequestType extends object, FetchResponseType extends CommonPostResponseType>({ domain, method, routeUrl, queryUrl, headers, body, bodyOriginData, queryStringData, log, logDisabled, fetchDisabled, }: {
+    /**
+     * API 도메인
+     */
+    domain: string;
+    /**
+     * 요청 방식
+     * POST, DELETE
+     */
+    method: "POST" | "DELETE";
+    /**
+     * 프론트 API URL
+     */
+    routeUrl: string;
+    /**
+     * 백엔드 API 요청 URL
+     */
+    queryUrl: string;
+} & Partial<{
+    /**
+     * fetch Headers
+     */
+    headers: HeadersInit;
+    /**
+     * fetch Body
+     */
+    body: BodyInit | null;
+    /**
+     * fetch Body 를 SearchParams 전환할 데이터
+     */
+    bodyOriginData: FetchRequestType;
+    /**
+     * URL 쿼리 스트링
+     */
+    queryStringData: FetchRequestType;
+    /**
+     * 디버그용 로그 객체
+     */
+    log: object;
+    /**
+     * 로그 비활성화
+     */
+    logDisabled: boolean;
+    /**
+     * fetch 비활성화
+     */
+    fetchDisabled: boolean;
+}>) => Promise<FetchResponseType>;
 /**
- * 인프라 도메인 해석기와 로거를 주입받아 API 헬퍼 집합을 생성합니다.
+ * API; POST/DELETE method fetch
+ * @util
+ * @param {object} props
+ * @param {"ai" | "db" | string} props.domain
+ * @param {"POST" | "DELETE"} props.method POST, DELETE
+ * @param {string} props.routeUrl Next.js /app/api 라우트 주소
+ * @param {string} props.queryUrl 백엔드 API url
+ * @param {HeadersInit} [props.headers] fetch Headers
+ * @param {BodyInit | null} [props.body] post/delete body (이대로 바로 전송됨)
+ * @param {object} [props.bodyData] body로 전송하기 위해 가공이 필요한 데이터 객체
+ * @param {object} [props.log] 디버깅용 서버 로그 정보
+ * @param {boolean} [props.logDisabled] 로그 비활성화
+ * @param {boolean} [props.fetchDisabled] fetch 실행 비활성화
+ * @param {object} [props.alternateResponse] fetch 실패 시 대체 응답
+ * @return {Promise<ResponseType>} POST, DELETE 응답
  */
-declare const createBackendApiClient: <Infra extends InfraKey = InfraKey>(config: BackendApiConfig<Infra>) => {
-    getQueryString: (searchParams?: unknown) => string;
-    generateBackendQueryUrl_GET: ({ infra, domain, routeUrl, queryUrl, searchParams, log, logDisabled, logger, }: GenerateBackendQueryUrlOptions<Infra>) => string;
-    fetchBackendQuery: <FetchRequestType extends object, FetchResponseType extends CommonPostResponseType>({ infra, domain, routeUrl, queryUrl, method, headers, body, bodyOriginData, queryStringData, log, logDisabled, fetchDisabled, logger, }: FetchBackendQueryOptions<Infra, FetchRequestType>) => Promise<FetchResponseType>;
-    logger: ApiLogger;
-};
+declare const fetchWithBody: <BodyDataType = object, ResponseType extends object | Response = Response>({ domain, method, routeUrl, queryUrl, searchParams, headers, body, bodyData, isRawResponse, alternateResponse, debug, disabled, disabledLog, }: {
+    /**
+     * API 도메인
+     */
+    domain: string;
+    /**
+     * 요청 방식
+     * POST, DELETE
+     */
+    method: string;
+    /**
+     * 프론트 API URL
+     */
+    routeUrl: string;
+    /**
+     * 백엔드 API 요청 URL
+     */
+    queryUrl: string;
+    /**
+     * fetch 실패 시 대체 응답
+     */
+    alternateResponse: ResponseType;
+} & Partial<{
+    searchParams: URLSearchParams | object;
+    /**
+     * fetch Headers
+     */
+    headers: HeadersInit;
+    /**
+     * fetch Body
+     */
+    body: BodyInit | null;
+    /**
+     * fetch Body Data
+     */
+    bodyData: BodyDataType;
+    /**
+     * 응답값 원본으로 return
+     * const responseRaw = await fetch(api);
+     */
+    isRawResponse: boolean;
+    /**
+     * 디버그용 로그 객체
+     */
+    debug: object;
+    /**
+     * fetch 비활성화
+     */
+    disabled: boolean;
+    /**
+     * 로그 비활성화
+     */
+    disabledLog: boolean;
+}>) => Promise<ResponseType>;
 
-export { type ApiLogger, type BackendApiConfig, type CommonPostResponseType, type DomainResolver, type FetchBackendQueryOptions, type GenerateBackendQueryUrlOptions, type InfraKey, createBackendApiClient, defaultLogger as defaultApiLogger, getQueryString };
+export { type ApiLogger, type BackendApiConfig, type CommonPostResponseType, type DomainResolver, type EnvDomainMap, type FetchBackendQueryOptions, type GenerateBackendQueryUrlOptions, type InfraKey, fetchBackendQuery, fetchWithBody, generateBackendQueryUrl_GET, getFetchOptions, getQueryString, nextAPILog };

package/dist/api/index.d.ts

@@ -1,5 +1,31 @@
 export { D as DateTimeFormatOptionsType } from '../type-CNV_n0-w.js';
 
+/**
+ * 콘솔로그; Next.js API Route 디버깅용
+ * @util
+ * @param {string} method GET, POST, DELETE
+ * @param {string} routeUrl Next.js route API route URL
+ * @param {string} [queryUrl] DB API route URL
+ * @param {unknown[]} [messages] 로그 데이터
+ */
+declare const nextAPILog: (method: string, routeUrl: string, queryUrl?: string, ...messages: unknown[]) => void;
+/**
+ * API; 쿼리스트링 생성
+ * @util
+ * @param {unknown} [searchParams] 쿼리스트링으로 변환할 객체
+ * @return {string} 쿼리스트링
+ */
+declare const getQueryString: (searchParams?: unknown) => string;
+/**
+ * API; POST/DELETE method option
+ */
+declare const getFetchOptions: ({ method, headers, body, }: {
+    method: string;
+} & Partial<{
+    headers: HeadersInit;
+    body: BodyInit | null;
+}>) => RequestInit;
+
 type InfraKey = "ai" | "db" | "uniai" | (string & {});
 type CommonPostResponseType = {
     is_ok: boolean;
@@ -8,6 +34,7 @@ type CommonPostResponseType = {
     error: string;
 };
 type DomainResolver<Infra extends InfraKey = InfraKey> = (infra: Infra) => string | undefined;
+type EnvDomainMap<Infra extends InfraKey = InfraKey> = Partial<Record<Infra, string>>;
 type ApiLogger = (method: string, routeUrl: string, queryUrl?: string, ...messages: unknown[]) => void;
 type BackendApiConfig<Infra extends InfraKey = InfraKey> = {
     resolveDomain: DomainResolver<Infra>;
@@ -34,22 +61,182 @@ type FetchBackendQueryOptions<Infra extends InfraKey, FetchRequestType extends o
 };
 
 /**
- * 기본 API 로거.
- * 개발 환경에서만 동작하며 요청/응답 정보를 콘솔에 출력합니다.
+ * API 요청 url 생성; GET 타입
+ * @util
+ * @param {object} props
+ * @param {"ai" | "db" | string} props.domain API 인프라
+ * @param {string} props.routeUrl Next.js /app/api 라우트 주소
+ * @param {string} props.queryUrl 백엔드 API url
+ * @param {URLSearchParams} [props.searchParams] 쿼리 스트링 추출
+ * @param {object} [props.log] 디버깅용 서버 로그 정보
+ * @param {boolean} [props.logDisabled] 로그 비활성화
+ * @return {string} GET API 요청 full url
  */
-declare const defaultLogger: ApiLogger;
+declare const generateBackendQueryUrl_GET: ({ domain, routeUrl, queryUrl, searchParams, log, logDisabled, }: {
+    /**
+     * API 도메인
+     */
+    domain: string;
+    /**
+     * Next.js /app/api 라우트 주소
+     */
+    routeUrl: string;
+    /**
+     * 백엔드 API url
+     */
+    queryUrl: string;
+} & Partial<{
+    /**
+     * 쿼리 스트링
+     * @desc
+     * - URLSearchParams 객체로 가공된 파라미터
+     */
+    searchParams: URLSearchParams | object;
+    /**
+     * 디버깅용 서버 로그 정보
+     */
+    log: object;
+    /**
+     * 로그 비활성화
+     * @default false
+     */
+    logDisabled: boolean;
+}>) => string;
 /**
- * 객체나 URLSearchParams를 쿼리스트링으로 직렬화합니다.
+ * API fetch 요청; POST/DELETE 타입
+ * @util
+ * @param {object} props
+ * @param {"ai" | "db" | string} props.infra API 인프라
+ * @param {"POST" | "DELETE"} props.method POST, DELETE
+ * @param {string} props.routeUrl Next.js /app/api 라우트 주소
+ * @param {string} props.queryUrl 백엔드 API url
+ * @param {HeadersInit} [props.headers] fetch Headers
+ * @param {BodyInit | null} [props.body] post/delete body (이대로 바로 전송됨)
+ * @param {object} [props.bodyData] body로 전송하기 위해 가공이 필요한 데이터 객체
+ * @param {object} [props.queryStringData] url에 쿼리스트링으로 요청하는 경우에 대한 데이터 객체
+ * @param {object} [props.log] 디버깅용 서버 로그 정보
+ * @param {boolean} [props.logDisabled] 로그 비활성화
+ * @param {boolean} [props.fetchDisabled] fetch 실행 비활성화
+ * @return {Promise<MutateAPICommonResponseType>} POST, DELETE 응답
  */
-declare const getQueryString: (searchParams?: unknown) => string;
+declare const fetchBackendQuery: <FetchRequestType extends object, FetchResponseType extends CommonPostResponseType>({ domain, method, routeUrl, queryUrl, headers, body, bodyOriginData, queryStringData, log, logDisabled, fetchDisabled, }: {
+    /**
+     * API 도메인
+     */
+    domain: string;
+    /**
+     * 요청 방식
+     * POST, DELETE
+     */
+    method: "POST" | "DELETE";
+    /**
+     * 프론트 API URL
+     */
+    routeUrl: string;
+    /**
+     * 백엔드 API 요청 URL
+     */
+    queryUrl: string;
+} & Partial<{
+    /**
+     * fetch Headers
+     */
+    headers: HeadersInit;
+    /**
+     * fetch Body
+     */
+    body: BodyInit | null;
+    /**
+     * fetch Body 를 SearchParams 전환할 데이터
+     */
+    bodyOriginData: FetchRequestType;
+    /**
+     * URL 쿼리 스트링
+     */
+    queryStringData: FetchRequestType;
+    /**
+     * 디버그용 로그 객체
+     */
+    log: object;
+    /**
+     * 로그 비활성화
+     */
+    logDisabled: boolean;
+    /**
+     * fetch 비활성화
+     */
+    fetchDisabled: boolean;
+}>) => Promise<FetchResponseType>;
 /**
- * 인프라 도메인 해석기와 로거를 주입받아 API 헬퍼 집합을 생성합니다.
+ * API; POST/DELETE method fetch
+ * @util
+ * @param {object} props
+ * @param {"ai" | "db" | string} props.domain
+ * @param {"POST" | "DELETE"} props.method POST, DELETE
+ * @param {string} props.routeUrl Next.js /app/api 라우트 주소
+ * @param {string} props.queryUrl 백엔드 API url
+ * @param {HeadersInit} [props.headers] fetch Headers
+ * @param {BodyInit | null} [props.body] post/delete body (이대로 바로 전송됨)
+ * @param {object} [props.bodyData] body로 전송하기 위해 가공이 필요한 데이터 객체
+ * @param {object} [props.log] 디버깅용 서버 로그 정보
+ * @param {boolean} [props.logDisabled] 로그 비활성화
+ * @param {boolean} [props.fetchDisabled] fetch 실행 비활성화
+ * @param {object} [props.alternateResponse] fetch 실패 시 대체 응답
+ * @return {Promise<ResponseType>} POST, DELETE 응답
  */
-declare const createBackendApiClient: <Infra extends InfraKey = InfraKey>(config: BackendApiConfig<Infra>) => {
-    getQueryString: (searchParams?: unknown) => string;
-    generateBackendQueryUrl_GET: ({ infra, domain, routeUrl, queryUrl, searchParams, log, logDisabled, logger, }: GenerateBackendQueryUrlOptions<Infra>) => string;
-    fetchBackendQuery: <FetchRequestType extends object, FetchResponseType extends CommonPostResponseType>({ infra, domain, routeUrl, queryUrl, method, headers, body, bodyOriginData, queryStringData, log, logDisabled, fetchDisabled, logger, }: FetchBackendQueryOptions<Infra, FetchRequestType>) => Promise<FetchResponseType>;
-    logger: ApiLogger;
-};
+declare const fetchWithBody: <BodyDataType = object, ResponseType extends object | Response = Response>({ domain, method, routeUrl, queryUrl, searchParams, headers, body, bodyData, isRawResponse, alternateResponse, debug, disabled, disabledLog, }: {
+    /**
+     * API 도메인
+     */
+    domain: string;
+    /**
+     * 요청 방식
+     * POST, DELETE
+     */
+    method: string;
+    /**
+     * 프론트 API URL
+     */
+    routeUrl: string;
+    /**
+     * 백엔드 API 요청 URL
+     */
+    queryUrl: string;
+    /**
+     * fetch 실패 시 대체 응답
+     */
+    alternateResponse: ResponseType;
+} & Partial<{
+    searchParams: URLSearchParams | object;
+    /**
+     * fetch Headers
+     */
+    headers: HeadersInit;
+    /**
+     * fetch Body
+     */
+    body: BodyInit | null;
+    /**
+     * fetch Body Data
+     */
+    bodyData: BodyDataType;
+    /**
+     * 응답값 원본으로 return
+     * const responseRaw = await fetch(api);
+     */
+    isRawResponse: boolean;
+    /**
+     * 디버그용 로그 객체
+     */
+    debug: object;
+    /**
+     * fetch 비활성화
+     */
+    disabled: boolean;
+    /**
+     * 로그 비활성화
+     */
+    disabledLog: boolean;
+}>) => Promise<ResponseType>;
 
-export { type ApiLogger, type BackendApiConfig, type CommonPostResponseType, type DomainResolver, type FetchBackendQueryOptions, type GenerateBackendQueryUrlOptions, type InfraKey, createBackendApiClient, defaultLogger as defaultApiLogger, getQueryString };
+export { type ApiLogger, type BackendApiConfig, type CommonPostResponseType, type DomainResolver, type EnvDomainMap, type FetchBackendQueryOptions, type GenerateBackendQueryUrlOptions, type InfraKey, fetchBackendQuery, fetchWithBody, generateBackendQueryUrl_GET, getFetchOptions, getQueryString, nextAPILog };