sales-frontend-bridge 0.0.21 → 0.0.23

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import * as react from 'react';
 import { CSSProperties } from 'react';
 
 interface ICommonBridge {
@@ -120,6 +121,9 @@ interface OnAuthenticationResultRequest {
 interface OnAuthenticationResultResponse {
     nlcCtfnId: string;
 }
+interface GetAccessTokenResponse {
+    accessToken: string;
+}
 
 interface ShowWebPopupOptions {
     /**   0: fullscreen, 1: title bar, 2: size 지정 가능 팝업, 3: wk webview */
@@ -155,6 +159,170 @@ interface CreateReportExOptions extends CreateReportOptions {
      */
     delimiter?: string;
 }
+type NonEmptyArray$1<T> = [T, ...T[]];
+/**
+ * 전자청약에서 관리할 문서 데이터 구조
+ * ```tsx
+ * [
+ *   { name: "문서1", file: ["doc1.ozd"], complete: true },
+ *   { name: "문서2", file: ["doc2.ozd", "doc3.ozd"], complete: true }
+ * ]
+ * ```
+ */
+type DocumentInfo$1 = {
+    /** 서식이름(복수의 OZD) */
+    name: string;
+    /** 서식에 매핑된 OZD 목록 */
+    file: NonEmptyArray$1<string>;
+    /** 서식 입력완료 여부 */
+    complete: boolean;
+    /** 현재 서식 포커스 여부 */
+    focus: boolean;
+    /** 전체보고서에서 서식의 시작페이지 */
+    startPage: number;
+    /** 전체보고서에서 서식의 시작페이지 */
+    endPage: number;
+};
+/**
+ * OZD를 다운받을때 사용하는 브릿지의 옵션
+ */
+type DownloadOzdOptions$1 = {
+    data: Array<DocumentInfo$1>;
+};
+/**
+ * OZ 관련 브릿지 통신에서 기본적으로 사용되는 리턴 타입 구조.
+ * 제네릭 타입 T는 리턴되는 데이터의 형태를 나타냅니다.
+ */
+interface CommonOzBridgetResponseType$1<T> {
+    /** 실행된 브릿지 액션의 이름 */
+    action: string;
+    /** stringify된 리턴 데이터 */
+    data: T;
+}
+
+/**
+ * 네이티브 브릿지 구현 함수
+ */
+interface INativeBridge {
+    getParameterMap<T>(): Promise<T>;
+    dismissPopup<T>(option: any): Promise<T>;
+    showWebPopup<T>(options: ShowWebPopupOptions): Promise<T>;
+    jumpSafari<T>(options: ShowWebPopupOptions): Promise<T>;
+    createOZViewer<T>(options: CreateReportExOptions): Promise<CommonOzBridgetResponseType$1<T>>;
+    hideOZViewer<T>(): Promise<CommonOzBridgetResponseType$1<T>>;
+    downloadDocument<T>(options: DownloadOzdOptions$1): Promise<CommonOzBridgetResponseType$1<T>>;
+    getAccessToken(): Promise<GetAccessTokenResponse>;
+    onAuthenticationResult(options: OnAuthenticationResultRequest): Promise<OnAuthenticationResultResponse>;
+}
+
+/**
+ * App - Web Bridge
+ */
+declare class NativeBridge extends CommonBridge implements INativeBridge {
+    private core;
+    constructor();
+    /**
+     * Iframe, App 공통으로 구현해야할 함수
+     */
+    hello(): void;
+    /**
+     * getParameterMap
+     * @returns
+     */
+    getParameterMap<T = any>(): Promise<T>;
+    dismissPopup<T = any>(options?: any): Promise<T>;
+    /**
+     *
+     * @param options
+     * @returns
+     */
+    showWebPopup<T = any>(options: ShowWebPopupOptions): Promise<T>;
+    /**
+     *
+     * @param options
+     * @returns
+     */
+    jumpSafari<T = any>(options: ShowWebPopupOptions): Promise<T>;
+    /**
+     * 기능명: 본인인증 결과 정보 넘기기
+     * 목적: NXL One 에서 본인인증 결과 값을 네이티브로 넘기기 위함
+     * @param options
+     * @returns
+     */
+    onAuthenticationResult(options: OnAuthenticationResultRequest): Promise<OnAuthenticationResultResponse>;
+    /**
+     * Access Token 가져오기
+     * @returns
+     */
+    getAccessToken(): Promise<GetAccessTokenResponse>;
+    /**
+     * ### Bridge for Oz
+     * 설정한 뷰어 파라미터를 기준으로 뷰어에 새로운 보고서를 바인딩합니다.
+     * @example
+     * ```tsx
+     * // 사용 예시
+     * Bridge.native.createReportEx({ param: "connection.openfile=sample.ozd" });
+     * ```
+     */
+    createOZViewer<T = any>(options: CreateReportExOptions): Promise<CommonOzBridgetResponseType$1<T>>;
+    /**
+     * ### Bridge for Oz
+     * OZ 뷰어를 닫습니다
+     * @example
+     * ```tsx
+     * // 사용 예시
+     * Bridge.native.hideViewer();
+     * ```
+     */
+    hideOZViewer<T = any>(): Promise<CommonOzBridgetResponseType$1<T>>;
+    /**
+     * ### Bridge for Oz
+     * 오즈 파라미터에서 사용할 OZD를 다운받는 브릿지입니다
+     * @example
+     * ```tsx
+     * const data = [
+     *   { name: "문서1", file: ["doc1.ozd"], complete: true },
+     *   { name: "문서2", file: ["doc2.ozd", "doc3.ozd"], complete: true }
+     * ]
+     * await Bridge.native.downloadDocument(data)
+     * ```
+     * returnData는 file 경로가 절대경로로 매핑되어 돌아온다
+     * ```json
+     * {
+     *    "action":"downloadDocument",
+     *    "data":[
+     *       {
+     *          "name":"aaa",
+     *          "file":[
+     *             "/data/user/0/com.hanwhalife.ssp.stg/files/A0010.ozd",
+     *             "/data/user/0/com.hanwhalife.ssp.stg/files/C0401.ozd"
+     *          ],
+     *          "complete":false
+     *       },
+     *       {
+     *          "name":"bbb",
+     *          "file":[
+     *             "/data/user/0/com.hanwhalife.ssp.stg/files/A1500.ozd"
+     *          ],
+     *          "complete":false
+     *       }
+     *    ]
+     * }
+     * ```
+     */
+    downloadDocument<T = any>(options: DownloadOzdOptions$1): Promise<CommonOzBridgetResponseType$1<T>>;
+}
+
+/**
+ * OZ 관련 브릿지 통신에서 기본적으로 사용되는 리턴 타입 구조.
+ * 제네릭 타입 T는 리턴되는 데이터의 형태를 나타냅니다.
+ */
+interface CommonOzBridgetResponseType<T> {
+    /** 실행된 브릿지 액션의 이름 */
+    action: string;
+    /** stringify된 리턴 데이터 */
+    data: T;
+}
 /**
  * 오즈 뷰어 함수 `CreateReport`를 호출할 때 사용하는 브릿지용 입력 옵션
  */
@@ -253,9 +421,6 @@ type DocumentInfo = {
     /** 전체보고서에서 서식의 시작페이지 */
     endPage: number;
 };
-/**
- * OZD를 다운받을때 사용하는 브릿지의 옵션
- */
 type DownloadOzdOptions = {
     data: Array<DocumentInfo>;
 };
@@ -277,31 +442,15 @@ interface SaveSignImgOptions {
     /** 추출할 서명의 FORM ID */
     signImageKey: string;
 }
-/**
- * OZ 관련 브릿지 통신에서 기본적으로 사용되는 리턴 타입 구조.
- * 제네릭 타입 T는 리턴되는 데이터의 형태를 나타냅니다.
- */
-interface CommonOzBridgetResponseType<T> {
-    /** 실행된 브릿지 액션의 이름 */
-    action: string;
-    /** stringify된 리턴 데이터 */
-    data: T;
-}
 interface createOzPdfViewerOptions {
     /** PDF 경로 + 파일이름 */
     filePath: string;
 }
 
 /**
- * 네이티브 브릿지 구현 함수
+ * 네이티브(오즈 전용) 브릿지 구현 함수
  */
-interface INativeBridge {
-    getParameterMap<T>(): Promise<T>;
-    dismissPopup<T>(option: any): Promise<T>;
-    showWebPopup<T>(options: ShowWebPopupOptions): Promise<T>;
-    jumpSafari<T>(options: ShowWebPopupOptions): Promise<T>;
-    createReportEx<T>(options: CreateReportExOptions): Promise<CommonOzBridgetResponseType<T>>;
-    hideViewer<T>(): Promise<CommonOzBridgetResponseType<T>>;
+interface INativeBridgeOz {
     getInformation<T>(options: GetInformationOptions): Promise<CommonOzBridgetResponseType<T>>;
     getGlobal<T>(options: GetGlobalOptions): Promise<CommonOzBridgetResponseType<T>>;
     setGlobal<T>(options: SetGlobalOptions): Promise<CommonOzBridgetResponseType<T>>;
@@ -310,63 +459,25 @@ interface INativeBridge {
     triggerExternalEvent<T>(options: TriggerExternalEventOptions): Promise<CommonOzBridgetResponseType<T>>;
     triggerExternalEventByDocIndex<T>(options: TriggerExternalEventByDocIndexOptions): Promise<CommonOzBridgetResponseType<T>>;
     getOzFontParam<T>(): Promise<CommonOzBridgetResponseType<T>>;
-    downloadDocument<T>(options: DownloadOzdOptions): Promise<CommonOzBridgetResponseType<T>>;
     updateOzDocumentStatus<T>(options: UpdateOzdOptions): Promise<CommonOzBridgetResponseType<T>>;
     savePdf<T>(options: SavePdfOptions): Promise<CommonOzBridgetResponseType<T>>;
     saveSignImg<T>(options: SaveSignImgOptions): Promise<CommonOzBridgetResponseType<T>>;
     createOzPdfViewer<T>(options: createOzPdfViewerOptions): Promise<CommonOzBridgetResponseType<T>>;
     hideOzPdfViewer<T>(): Promise<CommonOzBridgetResponseType<T>>;
-    onAuthenticationResult(options: OnAuthenticationResultRequest): Promise<OnAuthenticationResultResponse>;
+    showLoader<T>(): Promise<CommonOzBridgetResponseType<T>>;
+    hideLoader<T>(): Promise<CommonOzBridgetResponseType<T>>;
 }
 
 /**
- * App - Web Bridge
+ * App - Web Bridge(for OZ)
  */
-declare class NativeBridge extends CommonBridge implements INativeBridge {
+declare class NativeBridgeOz extends CommonBridge implements INativeBridgeOz {
     private core;
     constructor();
     /**
      * Iframe, App 공통으로 구현해야할 함수
      */
     hello(): void;
-    /**
-     * getParameterMap
-     * @returns
-     */
-    getParameterMap<T = any>(): Promise<T>;
-    dismissPopup<T = any>(options?: any): Promise<T>;
-    /**
-     *
-     * @param options
-     * @returns
-     */
-    showWebPopup<T = any>(options: ShowWebPopupOptions): Promise<T>;
-    /**
-     *
-     * @param options
-     * @returns
-     */
-    jumpSafari<T = any>(options: ShowWebPopupOptions): Promise<T>;
-    /**
-     * ### Bridge for Oz
-     * 설정한 뷰어 파라미터를 기준으로 뷰어에 새로운 보고서를 바인딩합니다.
-     * @example
-     * ```tsx
-     * // 사용 예시
-     * Bridge.native.createReportEx({ param: "connection.openfile=sample.ozd" });
-     * ```
-     */
-    createReportEx<T = any>(options: CreateReportExOptions): Promise<CommonOzBridgetResponseType<T>>;
-    /**
-     * ### Bridge for Oz
-     * OZ 뷰어를 닫습니다
-     * @example
-     * ```tsx
-     * // 사용 예시
-     * Bridge.native.hideViewer();
-     * ```
-     */
-    hideViewer<T = any>(): Promise<CommonOzBridgetResponseType<T>>;
     /**
      * ### Bridge for Oz
      * 오즈 뷰어의 정보를 가져옵니다
@@ -454,42 +565,6 @@ declare class NativeBridge extends CommonBridge implements INativeBridge {
      * ```
      */
     getOzFontParam<T = any>(): Promise<CommonOzBridgetResponseType<T>>;
-    /**
-     * ### Bridge for Oz
-     * 오즈 파라미터에서 사용할 OZD를 다운받는 브릿지입니다
-     * @example
-     * ```tsx
-     * const data = [
-     *   { name: "문서1", file: ["doc1.ozd"], complete: true },
-     *   { name: "문서2", file: ["doc2.ozd", "doc3.ozd"], complete: true }
-     * ]
-     * await Bridge.native.downloadDocument(data)
-     * ```
-     * returnData는 file 경로가 절대경로로 매핑되어 돌아온다
-     * ```json
-     * {
-     *    "action":"downloadDocument",
-     *    "data":[
-     *       {
-     *          "name":"aaa",
-     *          "file":[
-     *             "/data/user/0/com.hanwhalife.ssp.stg/files/A0010.ozd",
-     *             "/data/user/0/com.hanwhalife.ssp.stg/files/C0401.ozd"
-     *          ],
-     *          "complete":false
-     *       },
-     *       {
-     *          "name":"bbb",
-     *          "file":[
-     *             "/data/user/0/com.hanwhalife.ssp.stg/files/A1500.ozd"
-     *          ],
-     *          "complete":false
-     *       }
-     *    ]
-     * }
-     * ```
-     */
-    downloadDocument<T = any>(options: DownloadOzdOptions): Promise<CommonOzBridgetResponseType<T>>;
     /**
      * ### Bridge for Oz
      * 서식의 진행중/완료 상태를 업데이트하는 브릿지
@@ -536,34 +611,84 @@ declare class NativeBridge extends CommonBridge implements INativeBridge {
      */
     hideOzPdfViewer<T>(): Promise<CommonOzBridgetResponseType<T>>;
     /**
-     * 기능명: 본인인증 결과 정보 넘기기
-     * 목적: NXL One 에서 본인인증 결과 값을 네이티브로 넘기기 위함
-     * @param options
-     * @returns
+     * 로더 컴포넌트 show
+     * @example
+     * ```tsx
+     * // 사용 예시
+     * await Bridge.native.showLoader()
+     * ```
      */
-    onAuthenticationResult(options: OnAuthenticationResultRequest): Promise<OnAuthenticationResultResponse>;
+    showLoader<T>(): Promise<CommonOzBridgetResponseType<T>>;
+    /**
+     * 로더 컴포넌트 hide
+     * @example
+     * ```tsx
+     * // 사용 예시
+     * await Bridge.native.hideLoader()
+     * ```
+     */
+    hideLoader<T>(): Promise<CommonOzBridgetResponseType<T>>;
 }
 
-type NativeAction = keyof INativeBridge;
-type RetainCallback<T = any> = (params: T) => void;
 /**
  * Command의 옵션
  */
-interface NativeBridgeOptions {
-    retainCallback?: RetainCallback;
-    [key: string]: any;
+type NativeBridgeOptions = Record<string, any>;
+/**
+ * Promise를 위한 타입
+ */
+interface NativeBridgePromise<T = any> {
+    resolve: (value: T) => void;
+    reject: (reason?: any) => void;
+}
+interface PromiseHandleBridge {
+    promises: Record<string, NativeBridgePromise>;
+    resolvePromise: (promiseId: string, data?: any, error?: any) => void;
+    finallyResolvePromise: (promiseId: string, data?: any, error?: any) => void;
+}
+interface CallBridge {
+    callFromWeb?: (command: string) => void;
+}
+interface CombinedBridge extends PromiseHandleBridge, CallBridge {
+}
+declare global {
+    interface Window {
+        n2bridge: PromiseHandleBridge;
+        n2Bridge: CallBridge;
+        n2OzBridge: CombinedBridge;
+        webkit: {
+            messageHandlers: {
+                n2Bridge: {
+                    postMessage: (command: string) => void;
+                };
+                n2OzBridge: {
+                    postMessage: (command: string) => void;
+                };
+            };
+        };
+    }
 }
 
 /**
- * Native Bridge 통신 위한 핵심 클래스
+ * Native <-> Web 처리를 위한 핵심 클래스
  * 담당: 앱 호출, Promise 관리
  */
-declare class NativeBridgeCore extends CommonBridgeCore {
-    constructor();
+declare class NativeBridgeCore<TAction extends string> extends CommonBridgeCore {
+    private promiseHandleName;
+    private callBridgeName;
+    constructor(callBridgeName?: string, promiseHandleName?: string);
     /**
-     * 네이티브 통신을 위해 window.n2bridge 객체 초기화
+     * Promise 관리용 브릿지 객체 가져오기 (window.n2bridge)
      */
-    private initializeWindowBridge;
+    private getPromiseHandleBridge;
+    /**
+     * 앱 호출용 브릿지 객체 가져오기 (window.n2Bridge)
+     */
+    private getCallBridge;
+    /**
+     * 네이티브 통신을 위해 window.n2OzBridge 객체 초기화
+     */
+    private initializeWindowOzBridge;
     /**
      * Promise 처리 함수(Native에서 호출)
      * @returns
@@ -574,19 +699,13 @@ declare class NativeBridgeCore extends CommonBridgeCore {
      * @returns
      */
     private createFinallyResolvePromiseHandler;
-    /**
-     * Native 에서 웹으로 호출하는 함수
-     * TODO: 필요시 추가 코딩
-     * @returns
-     */
-    private createCallFromNativeHandler;
     /**
      * 네이티브 통신
      * @param action
      * @param options
      * @returns
      */
-    callToTarget<T>(action: NativeAction, options?: NativeBridgeOptions): Promise<T>;
+    callToTarget<T>(action: TAction, option?: NativeBridgeOptions): Promise<T>;
     /**
      * promiseId를 초기화 해줍니다.
      * @param promiseId
@@ -596,8 +715,9 @@ declare class NativeBridgeCore extends CommonBridgeCore {
 
 declare const Bridge: {
     native: NativeBridge;
+    nativeOz: NativeBridgeOz;
     iframe: IframeBridge;
-    nativeCore: NativeBridgeCore;
+    nativeCore: NativeBridgeCore<string>;
     iframeCore: IframeBridgeCore;
 };
 
@@ -832,14 +952,23 @@ type ExtraDataType = Record<string, {
     extraParam?: string[];
 }>;
 type Props$1 = {
-    documentInfo: DocumentInfo[];
+    documentList: string[];
     extraData?: ExtraDataType;
 };
-declare function useCreateReport({ documentInfo, extraData }: Props$1): {
-    documentList: string[];
+declare function useCreateReport({ documentList, extraData }: Props$1): {
     CreateReport: () => Promise<void>;
 };
 
+declare function useDocumentInfo(initialValue: DocumentInfo$1[]): {
+    setDocumentInfo: react.Dispatch<react.SetStateAction<DocumentInfo$1[]>>;
+    documentInfo: DocumentInfo$1[];
+    documentList: string[];
+    documentTemplateMap: Record<string, DocumentInfo$1>;
+    documentIndexMap: Record<string, number>;
+    nameTemplateMap: Record<string, DocumentInfo$1>;
+    groupIndexes: number[][];
+};
+
 type Props<T, R = void> = {
     event: OZViewerEvent;
     handler: (e: CustomEvent<T>) => Promise<R>;
@@ -849,16 +978,16 @@ type Props<T, R = void> = {
  */
 declare function useOzEventListener<T, R = void>({ event, handler }: Props<T, R>): void;
 
-declare function fetchDocument(options: Array<DocumentInfo>): Promise<{
+declare function fetchDocument(options: Array<DocumentInfo$1>): Promise<{
     startPage: number;
     endPage: number;
     name: string;
-    file: NonEmptyArray<string>;
+    file: NonEmptyArray$1<string>;
     complete: boolean;
     focus: boolean;
 }[]>;
 declare function fetchFont(): Promise<string[]>;
-declare function categorizeByPageRange(data: DocumentInfo[], pageCounts: number[]): DocumentInfo[];
+declare function categorizeByPageRange(data: DocumentInfo$1[], pageCounts: number[]): DocumentInfo$1[];
 /**
  * 주어진 파일 경로에서 파일 이름만 추출합니다.
  * @param filePath 파일 경로 (예: `/a/b/c/file.ext`)
@@ -866,6 +995,6 @@ declare function categorizeByPageRange(data: DocumentInfo[], pageCounts: number[
  * @throws {Error} 유효하지 않은 파일 경로일 경우 예외 처리
  */
 declare function extractFileName(filePath: string): string;
-declare function getFileListByGlobalIndex(index: number, data: DocumentInfo[]): DocumentInfo | null;
+declare function getFileListByGlobalIndex(index: number, data: DocumentInfo$1[]): DocumentInfo$1 | null;
 
-export { Bridge, type ExtraDataType, type OZBtnTouchEvent, type OZEFormInputEvent, type OZExportEvent, type OZViewerChangeEvent, type OZViewerErrorEvent, OZViewerEvent, type OZViewerPageBindEvent, type OZViewerProgressEvent, type OZViewerUserEvent, btnStyle, categorizeByPageRange, commonOzParam, commonPdfExportParam, extractFileName, fetchDocument, fetchFont, getFileListByGlobalIndex, useCreateReport, useOzEventListener, wrapperStyle };
+export { Bridge, type ExtraDataType, type OZBtnTouchEvent, type OZEFormInputEvent, type OZExportEvent, type OZViewerChangeEvent, type OZViewerErrorEvent, OZViewerEvent, type OZViewerPageBindEvent, type OZViewerProgressEvent, type OZViewerUserEvent, btnStyle, categorizeByPageRange, commonOzParam, commonPdfExportParam, extractFileName, fetchDocument, fetchFont, getFileListByGlobalIndex, useCreateReport, useDocumentInfo, useOzEventListener, wrapperStyle };