zigap-utils 3.1.0-preview.1 → 3.1.0-preview.4

package/dist/hooks/index.d.ts

@@ -1 +1,2 @@
-export { default as useZigap } from './useZigap';
+export { default as useZigap, clearSession } from './useZigap';
+export { default as useRoomExpiry } from './useRoomExpiry';

package/dist/hooks/useAddressProvideReceive.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 데스크톱 QR 경로에서 앱이 회신하는 주소를 1회 수신해 onReceive 로 통지하는 훅.
+ *
+ * qrAddressProvide 가 'addressProvide' 소켓 리스너를 등록하고 회신을 await 한다.
+ * cleanup 에서 같은 리스너를 회수해 싱글톤 소켓에 리스너가 누적되는 것을 막는다.
+ *
+ * onReceive 는 매 렌더 새 함수라 deps 에 넣으면 effect 가 재실행되어 수신 대기가 리셋된다.
+ * ref 로 최신 콜백만 유지하고 deps 에서 제외한다.
+ */
+interface UseAddressProvideReceiveArgs {
+    roomId: string;
+    onReceive: (res: {
+        isSuccess: boolean;
+    }) => void;
+}
+export declare const useAddressProvideReceive: ({ roomId, onReceive }: UseAddressProvideReceiveArgs) => void;
+export default useAddressProvideReceive;

package/dist/hooks/useDeeplinkAppSwitch.d.ts

@@ -0,0 +1,10 @@
+export declare const shouldNavigateToApp: (isValid: boolean, isMobile: boolean, hasNavigated: boolean, resumeFromReload: boolean) => boolean;
+interface UseDeeplinkAppSwitchArgs {
+    qrCode: string;
+    isMobile: boolean;
+    isValid: boolean;
+    /** 리로드 복귀면 앱 재전환을 억제한다(무한 바운스 방지). 기본 false. */
+    resumeFromReload?: boolean;
+}
+export declare const useDeeplinkAppSwitch: ({ qrCode, isMobile, isValid, resumeFromReload, }: UseDeeplinkAppSwitchArgs) => void;
+export default useDeeplinkAppSwitch;

package/dist/hooks/useDeeplinkLogin.d.ts

@@ -0,0 +1,22 @@
+import { LoginQRProps } from 'src/components/LoginQR/LoginQR.types';
+
+/**
+ * 모바일(같은 폰) 딥링크 로그인 전담 훅 — 앱 전환 + 복귀 재개를 한 곳에 묶는다.
+ * 데스크톱은 하위 훅이 isMobile=false 로 알아서 비활성화된다(라이브 QR 흐름은 컴포넌트 담당).
+ */
+interface UseDeeplinkLoginArgs {
+    roomId: string;
+    nonce: string;
+    qrCode: string;
+    sigMessage: string;
+    expire: LoginQRProps['expire'];
+    validSeconds: number;
+    isMobile: boolean;
+    isValid: boolean;
+    resumeFromReload: boolean;
+    onReceive: LoginQRProps['onReceive'];
+}
+export declare const useDeeplinkLogin: ({ roomId, nonce, qrCode, sigMessage, expire, validSeconds, isMobile, isValid, resumeFromReload, onReceive, }: UseDeeplinkLoginArgs) => {
+    isResuming: boolean;
+};
+export default useDeeplinkLogin;

package/dist/hooks/useDeeplinkPayment.d.ts

@@ -0,0 +1,23 @@
+import { PaymentQRProps } from 'src/components/PaymentQR/PaymentQR.types';
+
+/**
+ * 모바일(같은 폰) 딥링크 결제 전담 훅 — 앱 전환 + 복귀 재개를 한 곳에 묶는다.
+ * 데스크톱은 하위 훅이 isMobile=false 로 알아서 비활성화된다(라이브 QR 흐름은 컴포넌트 담당).
+ */
+interface UseDeeplinkPaymentArgs {
+    roomId: string;
+    nonce: string;
+    qrCode: string;
+    network: string;
+    address: string;
+    amount: string;
+    validSeconds: number;
+    isMobile: boolean;
+    isValid: boolean;
+    resumeFromReload: boolean;
+    onReceive: PaymentQRProps['onReceive'];
+}
+export declare const useDeeplinkPayment: ({ roomId, nonce, qrCode, network, address, amount, validSeconds, isMobile, isValid, resumeFromReload, onReceive, }: UseDeeplinkPaymentArgs) => {
+    isResuming: boolean;
+};
+export default useDeeplinkPayment;

package/dist/hooks/useDeeplinkResume.d.ts

@@ -0,0 +1,27 @@
+import { DeeplinkEnvelopeType } from 'src/utils/deeplinkTransport';
+
+/** 딥링크로 앱에 다녀온 뒤 끊겼던 연결을 이어주는 훅. type 만 바꾸면 login 외 sendTransaction/payment 에도 쓴다. */
+export type ResumeResult = {
+    status: 'SUCCESS';
+    result: any;
+} | {
+    status: 'TIMEOUT';
+};
+/** type 별 완료 이벤트명. 서버가 같은 채널로 replay 하므로 단일 구독이 LIVE 완료와 RESUME 복귀를 모두 받는다. */
+export declare const completeEventForType: (type?: DeeplinkEnvelopeType | string) => string;
+interface UseDeeplinkResumeArgs {
+    roomId: string;
+    nonce: string;
+    type: DeeplinkEnvelopeType | string;
+    payload?: any;
+    onResult: (result: ResumeResult) => void;
+    /** resume 액션 시점(화면 복귀 후 서버 보관분 pull 직전)에 호출. optional. */
+    onResume?: () => void;
+    timeoutMs?: number;
+    /** false 면 훅 비활성(예: roomId 미정 시). 기본 true. */
+    enabled?: boolean;
+    /** 풀 리로드 복귀로 보관 스냅샷을 재사용한 경우. 재등록 없이 마운트 즉시 resume 1회를 발동한다. 기본 false. */
+    resumeFromReload?: boolean;
+}
+export declare const useDeeplinkResume: ({ roomId, nonce, type, payload, onResult, onResume, timeoutMs, enabled, resumeFromReload, }: UseDeeplinkResumeArgs) => void;
+export default useDeeplinkResume;

package/dist/hooks/useDeeplinkRoom.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 마운트당 1회 roomId/nonce/qrCode 를 결정하는 훅. 4개 스캔전용 QR 컴포넌트가 공유한다.
+ *
+ * 모바일 풀 리로드 복귀 시 보관된 pending 스냅샷이 있으면 그 roomId/nonce 를 재사용한다
+ * (새로 생성하면 결과가 보관된 "원래 방"을 잃는다). 그 외(첫 진입/데스크톱)에는 generate() 로
+ * 새 roomId/qrCode 를 만들고 nonce 를 새로 발급한다.
+ */
+export interface DeeplinkRoom {
+    roomId: string;
+    nonce: string;
+    qrCode: string;
+    resumeFromReload: boolean;
+}
+export declare const useDeeplinkRoom: (isMobile: boolean, generate: () => {
+    qrCode: string;
+    roomId: string;
+}) => DeeplinkRoom;
+export default useDeeplinkRoom;

package/dist/hooks/useDeeplinkSendTransaction.d.ts

@@ -0,0 +1,21 @@
+import { SendTransactionQRProps } from 'src/components/SendTransactionQR/SendTransactionQR.types';
+
+/**
+ * 모바일(같은 폰) 딥링크 트랜잭션 전송 전담 훅 — 앱 전환 + 복귀 재개를 한 곳에 묶는다.
+ * 데스크톱은 하위 훅이 isMobile=false 로 알아서 비활성화된다(라이브 QR 흐름은 컴포넌트 담당).
+ */
+interface UseDeeplinkSendTransactionArgs {
+    roomId: string;
+    nonce: string;
+    qrCode: string;
+    transaction: SendTransactionQRProps['transaction'];
+    validSeconds: number;
+    isMobile: boolean;
+    isValid: boolean;
+    resumeFromReload: boolean;
+    onReceive: SendTransactionQRProps['onReceive'];
+}
+export declare const useDeeplinkSendTransaction: ({ roomId, nonce, qrCode, transaction, validSeconds, isMobile, isValid, resumeFromReload, onReceive, }: UseDeeplinkSendTransactionArgs) => {
+    isResuming: boolean;
+};
+export default useDeeplinkSendTransaction;

package/dist/hooks/useDeeplinkSignature.d.ts

@@ -0,0 +1,22 @@
+import { SignatureQRProps } from 'src/components/SignatureQR/SignatureQR.types';
+
+/**
+ * 모바일(같은 폰) 딥링크 서명 전담 훅 — 앱 전환 + 복귀 재개를 한 곳에 묶는다.
+ * 데스크톱은 하위 훅이 isMobile=false 로 알아서 비활성화된다(라이브 QR 흐름은 컴포넌트 담당).
+ */
+interface UseDeeplinkSignatureArgs {
+    roomId: string;
+    nonce: string;
+    qrCode: string;
+    sigMessage: string;
+    expire: SignatureQRProps['expire'];
+    validSeconds: number;
+    isMobile: boolean;
+    isValid: boolean;
+    resumeFromReload: boolean;
+    onReceive: SignatureQRProps['onReceive'];
+}
+export declare const useDeeplinkSignature: ({ roomId, nonce, qrCode, sigMessage, expire, validSeconds, isMobile, isValid, resumeFromReload, onReceive, }: UseDeeplinkSignatureArgs) => {
+    isResuming: boolean;
+};
+export default useDeeplinkSignature;

package/dist/hooks/useRoomExpiry.d.ts

@@ -0,0 +1,2 @@
+declare const useRoomExpiry: (roomId: string, validSeconds: number) => boolean;
+export default useRoomExpiry;

package/dist/hooks/useSocketRoom.d.ts

@@ -0,0 +1,7 @@
+/**
+ * roomId 방에 마운트 시 입장하고 언마운트 시 퇴장한다.
+ *
+ * 싱글톤 소켓이라 cleanup 의 leaveRoom 으로 유령 멤버가 남지 않게 한다.
+ */
+export declare const useSocketRoom: (roomId: string) => void;
+export default useSocketRoom;

package/dist/hooks/useZigap.d.ts

@@ -1,5 +1,6 @@
 export declare const LOGIN_RES_KEY = "userInfo";
 export declare const TIME_FORMAT = "YYYY-MM-DD HH:mm:ss";
+export declare const clearSession: () => void;
 declare const useZigap: () => {
     userInfo: {
         address: string | undefined;

package/dist/index.d.ts

@@ -2,4 +2,3 @@ export * from './components';
 export * from './xphere';
 export * from './zigap';
 export * from './hooks';
-export * from './utils/session';