tempest-react-sdk 0.60.0 → 0.62.0

package/dist/ws/use-web-socket.js.map

@@ -1 +1 @@
-{"version":3,"file":"use-web-socket.js","names":[],"sources":["../../src/ws/use-web-socket.ts"],"sourcesContent":["import { useCallback, useEffect, useRef, useState } from \"react\";\nimport { useLatestRef } from \"@/hooks/use-latest-ref\";\nimport {\n    createWebSocket,\n    type CreateWebSocketOptions,\n    type WebSocketController,\n    type WebSocketMessage,\n    type WebSocketStatus,\n} from \"./create-web-socket\";\n\nexport interface UseWebSocketOptions<T> extends Omit<CreateWebSocketOptions<T>, \"onStatusChange\"> {\n    /** When false, the socket is not opened. Default: true. */\n    enabled?: boolean;\n}\n\nexport interface UseWebSocketResult<T> {\n    status: WebSocketStatus;\n    /**\n     * Last decoded frame received.\n     *\n     * A snapshot, not a stream: two frames arriving in the same tick collapse\n     * into a single render and only the later one is ever visible. One server\n     * action often emits several frames in a row, so anything that must see\n     * every message has to use `onMessage`, which fires once per frame. Read\n     * `lastMessage` for \"what is the current state\" rendering only.\n     */\n    lastMessage: WebSocketMessage<T> | null;\n    /** Send a payload through the active connection. Returns false when not open. */\n    send: (payload: string | Blob | BufferSource) => boolean;\n    /** Force a reconnect, resetting the retry counter. */\n    reconnect: () => void;\n    /**\n     * Change the silence watchdog at runtime, in ms. `0` disables it.\n     *\n     * For a server that announces its own heartbeat interval in the first frame,\n     * so the tolerated silence is not hard-coded on both ends.\n     */\n    setSilenceTimeout: (ms: number) => void;\n}\n\n/**\n * React hook around {@link createWebSocket}. Manages the connection lifecycle\n * for the host component and tears it down on unmount.\n *\n * Every callback is read through a ref, so `onOpen` / `onMessage` / `onClose` /\n * `onError` / `onReconnecting` / `onReconnected` / `onLost` always run the\n * latest closure — an inline arrow function is fine and never reopens the\n * socket. Connection-shaping options (`protocols`, `maxRetries`,\n * `initialBackoff`, `maxBackoff`, `jitter`, `handshakeTimeout`,\n * `silenceTimeout`, `waitForOnline`, `pingInterval`, `queueWhileClosed`) are\n * baked into the connection, so changing one reopens it with the new value\n * rather than being silently ignored.\n *\n * @param url - Full ws:// or wss:// URL.\n * @param options - Connection configuration and callbacks.\n * @returns Status, last frame, and the `send` / `reconnect` controls.\n */\nexport function useWebSocket<T = unknown>(\n    url: string,\n    options: UseWebSocketOptions<T> = {},\n): UseWebSocketResult<T> {\n    const {\n        enabled = true,\n        protocols,\n        maxRetries,\n        initialBackoff,\n        maxBackoff,\n        jitter,\n        handshakeTimeout,\n        silenceTimeout,\n        waitForOnline,\n        pingInterval,\n        respondToPing,\n        queueWhileClosed,\n        maxQueuedMessages,\n    } = options;\n    const [status, setStatus] = useState<WebSocketStatus>(\"idle\");\n    const [lastMessage, setLastMessage] = useState<WebSocketMessage<T> | null>(null);\n    const controllerRef = useRef<WebSocketController | null>(null);\n\n    const optionsRef = useLatestRef(options);\n\n    const protocolsKey = Array.isArray(protocols) ? protocols.join(\",\") : (protocols ?? \"\");\n\n    useEffect(() => {\n        if (!enabled || !url) {\n            setStatus(\"idle\");\n            return;\n        }\n\n        /*\n         * Presence is read once, when the socket opens, and decides whether the\n         * forwarder is passed at all. A forwarder is always truthy, so wrapping\n         * an absent `parser` — or an absent `onParseError` — would tell\n         * `decodeFrame` the caller had supplied one and silently pick the wrong\n         * branch.\n         */\n        const hasParser = optionsRef.current.parser !== undefined;\n        const hasParseError = optionsRef.current.onParseError !== undefined;\n\n        const controller = createWebSocket<T>(url, {\n            protocols: optionsRef.current.protocols,\n            maxRetries,\n            initialBackoff,\n            maxBackoff,\n            jitter,\n            handshakeTimeout,\n            silenceTimeout,\n            waitForOnline,\n            pingInterval,\n            pingPayload: optionsRef.current.pingPayload,\n            respondToPing,\n            pongPayload: optionsRef.current.pongPayload,\n            queueWhileClosed,\n            maxQueuedMessages,\n            parser: hasParser ? (raw) => optionsRef.current.parser?.(raw) as T : undefined,\n            onParseError: hasParseError\n                ? (error, raw) => optionsRef.current.onParseError?.(error, raw)\n                : undefined,\n            onStatusChange: setStatus,\n            onOpen: (event) => optionsRef.current.onOpen?.(event),\n            onClose: (event) => optionsRef.current.onClose?.(event),\n            onError: (event) => optionsRef.current.onError?.(event),\n            onReconnecting: (attempt, total) => optionsRef.current.onReconnecting?.(attempt, total),\n            onReconnected: () => optionsRef.current.onReconnected?.(),\n            onLost: (reason) => optionsRef.current.onLost?.(reason),\n            onMessage: (message) => {\n                setLastMessage(message);\n                optionsRef.current.onMessage?.(message);\n            },\n        });\n        controllerRef.current = controller;\n\n        return () => {\n            controller.close();\n            controllerRef.current = null;\n        };\n    }, [\n        url,\n        enabled,\n        protocolsKey,\n        maxRetries,\n        initialBackoff,\n        maxBackoff,\n        jitter,\n        handshakeTimeout,\n        silenceTimeout,\n        waitForOnline,\n        pingInterval,\n        respondToPing,\n        queueWhileClosed,\n        maxQueuedMessages,\n        optionsRef,\n    ]);\n\n    const send = useCallback((payload: string | Blob | BufferSource): boolean => {\n        return controllerRef.current?.send(payload) ?? false;\n    }, []);\n\n    const reconnect = useCallback((): void => {\n        controllerRef.current?.reconnect();\n    }, []);\n\n    const setSilenceTimeout = useCallback((ms: number): void => {\n        controllerRef.current?.setSilenceTimeout(ms);\n    }, []);\n\n    return { status, lastMessage, send, reconnect, setSilenceTimeout };\n}\n"],"mappings":";;;;AAyDA,SAAgB,EACZ,GACA,IAAkC,CAAC,GACd;CACrB,IAAM,EACF,aAAU,IACV,cACA,eACA,mBACA,eACA,WACA,qBACA,mBACA,kBACA,iBACA,kBACA,qBACA,yBACA,GACE,CAAC,GAAQ,KAAa,EAA0B,MAAM,GACtD,CAAC,GAAa,KAAkB,EAAqC,IAAI,GACzE,IAAgB,EAAmC,IAAI,GAEvD,IAAa,EAAa,CAAO,GAEjC,IAAe,MAAM,QAAQ,CAAS,IAAI,EAAU,KAAK,GAAG,IAAK,KAAa;CAqFpF,OAnFA,QAAgB;EACZ,IAAI,CAAC,KAAW,CAAC,GAAK;GAClB,EAAU,MAAM;GAChB;EACJ;EASA,IAAM,IAAY,EAAW,QAAQ,WAAW,KAAA,GAC1C,IAAgB,EAAW,QAAQ,iBAAiB,KAAA,GAEpD,IAAa,EAAmB,GAAK;GACvC,WAAW,EAAW,QAAQ;GAC9B;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA,aAAa,EAAW,QAAQ;GAChC;GACA,aAAa,EAAW,QAAQ;GAChC;GACA;GACA,QAAQ,KAAa,MAAQ,EAAW,QAAQ,SAAS,CAAG,IAAS,KAAA;GACrE,cAAc,KACP,GAAO,MAAQ,EAAW,QAAQ,eAAe,GAAO,CAAG,IAC5D,KAAA;GACN,gBAAgB;GAChB,SAAS,MAAU,EAAW,QAAQ,SAAS,CAAK;GACpD,UAAU,MAAU,EAAW,QAAQ,UAAU,CAAK;GACtD,UAAU,MAAU,EAAW,QAAQ,UAAU,CAAK;GACtD,iBAAiB,GAAS,MAAU,EAAW,QAAQ,iBAAiB,GAAS,CAAK;GACtF,qBAAqB,EAAW,QAAQ,gBAAgB;GACxD,SAAS,MAAW,EAAW,QAAQ,SAAS,CAAM;GACtD,YAAY,MAAY;IAEpB,AADA,EAAe,CAAO,GACtB,EAAW,QAAQ,YAAY,CAAO;GAC1C;EACJ,CAAC;EAGD,OAFA,EAAc,UAAU,SAEX;GAET,AADA,EAAW,MAAM,GACjB,EAAc,UAAU;EAC5B;CACJ,GAAG;EACC;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;CACJ,CAAC,GAcM;EAAE;EAAQ;EAAa,MAZjB,GAAa,MACf,EAAc,SAAS,KAAK,CAAO,KAAK,IAChD,CAAC,CAU0B;EAAM,WARlB,QAAwB;GACtC,EAAc,SAAS,UAAU;EACrC,GAAG,CAAC,CAMgC;EAAW,mBAJrB,GAAa,MAAqB;GACxD,EAAc,SAAS,kBAAkB,CAAE;EAC/C,GAAG,CAAC,CAE2C;CAAkB;AACrE"}
+{"version":3,"file":"use-web-socket.js","names":[],"sources":["../../src/ws/use-web-socket.ts"],"sourcesContent":["import { useCallback, useEffect, useRef, useState } from \"react\";\nimport { useLatestRef } from \"@/hooks/use-latest-ref\";\nimport {\n    createWebSocket,\n    type CreateWebSocketOptions,\n    type WebSocketController,\n    type WebSocketMessage,\n    type WebSocketStatus,\n} from \"./create-web-socket\";\n\nexport interface UseWebSocketOptions<T> extends Omit<CreateWebSocketOptions<T>, \"onStatusChange\"> {\n    /** When false, the socket is not opened. Default: true. */\n    enabled?: boolean;\n}\n\nexport interface UseWebSocketResult<T> {\n    status: WebSocketStatus;\n    /**\n     * Last decoded frame received.\n     *\n     * A snapshot, not a stream: two frames arriving in the same tick collapse\n     * into a single render and only the later one is ever visible. One server\n     * action often emits several frames in a row, so anything that must see\n     * every message has to use `onMessage`, which fires once per frame. Read\n     * `lastMessage` for \"what is the current state\" rendering only.\n     */\n    lastMessage: WebSocketMessage<T> | null;\n    /** Send a payload through the active connection. Returns false when not open. */\n    send: (payload: string | Blob | BufferSource) => boolean;\n    /** Force a reconnect, resetting the retry counter. */\n    reconnect: () => void;\n    /**\n     * Change the silence watchdog at runtime, in ms. `0` disables it.\n     *\n     * For a server that announces its own heartbeat interval in the first frame,\n     * so the tolerated silence is not hard-coded on both ends.\n     */\n    setSilenceTimeout: (ms: number) => void;\n}\n\n/**\n * React hook around {@link createWebSocket}. Manages the connection lifecycle\n * for the host component and tears it down on unmount.\n *\n * Every callback is read through a ref, so `onOpen` / `onMessage` / `onClose` /\n * `onError` / `onReconnecting` / `onReconnected` / `onLost` always run the\n * latest closure — an inline arrow function is fine and never reopens the\n * socket. Connection-shaping options (`protocols`, `maxRetries`,\n * `initialBackoff`, `maxBackoff`, `jitter`, `handshakeTimeout`,\n * `silenceTimeout`, `waitForOnline`, `pingInterval`, `queueWhileClosed`) are\n * baked into the connection, so changing one reopens it with the new value\n * rather than being silently ignored.\n *\n * `schema` is read when the socket opens, so declare it outside the component\n * (or memoize it): a schema built inline is a new object on every render, and\n * the one in force is whichever existed at the last open.\n *\n * @param url - Full ws:// or wss:// URL.\n * @param options - Connection configuration and callbacks.\n * @returns Status, last frame, and the `send` / `reconnect` controls.\n */\nexport function useWebSocket<T = unknown>(\n    url: string,\n    options: UseWebSocketOptions<T> = {},\n): UseWebSocketResult<T> {\n    const {\n        enabled = true,\n        protocols,\n        maxRetries,\n        initialBackoff,\n        maxBackoff,\n        jitter,\n        handshakeTimeout,\n        silenceTimeout,\n        waitForOnline,\n        pingInterval,\n        respondToPing,\n        queueWhileClosed,\n        maxQueuedMessages,\n    } = options;\n    const [status, setStatus] = useState<WebSocketStatus>(\"idle\");\n    const [lastMessage, setLastMessage] = useState<WebSocketMessage<T> | null>(null);\n    const controllerRef = useRef<WebSocketController | null>(null);\n\n    const optionsRef = useLatestRef(options);\n\n    const protocolsKey = Array.isArray(protocols) ? protocols.join(\",\") : (protocols ?? \"\");\n\n    useEffect(() => {\n        if (!enabled || !url) {\n            setStatus(\"idle\");\n            return;\n        }\n\n        /*\n         * Presence is read once, when the socket opens, and decides whether the\n         * forwarder is passed at all. A forwarder is always truthy, so wrapping\n         * an absent `parser` — or an absent `onParseError` — would tell\n         * `decodeFrame` the caller had supplied one and silently pick the wrong\n         * branch.\n         */\n        const hasParser = optionsRef.current.parser !== undefined;\n        const hasParseError = optionsRef.current.onParseError !== undefined;\n        const hasValidationError = optionsRef.current.onValidationError !== undefined;\n\n        const controller = createWebSocket<T>(url, {\n            protocols: optionsRef.current.protocols,\n            maxRetries,\n            initialBackoff,\n            maxBackoff,\n            jitter,\n            handshakeTimeout,\n            silenceTimeout,\n            waitForOnline,\n            pingInterval,\n            pingPayload: optionsRef.current.pingPayload,\n            respondToPing,\n            pongPayload: optionsRef.current.pongPayload,\n            queueWhileClosed,\n            maxQueuedMessages,\n            parser: hasParser ? (raw) => optionsRef.current.parser?.(raw) as T : undefined,\n            onParseError: hasParseError\n                ? (error, raw) => optionsRef.current.onParseError?.(error, raw)\n                : undefined,\n            schema: optionsRef.current.schema,\n            onValidationError: hasValidationError\n                ? (issues, raw) => optionsRef.current.onValidationError?.(issues, raw)\n                : undefined,\n            onStatusChange: setStatus,\n            onOpen: (event) => optionsRef.current.onOpen?.(event),\n            onClose: (event) => optionsRef.current.onClose?.(event),\n            onError: (event) => optionsRef.current.onError?.(event),\n            onReconnecting: (attempt, total) => optionsRef.current.onReconnecting?.(attempt, total),\n            onReconnected: () => optionsRef.current.onReconnected?.(),\n            onLost: (reason) => optionsRef.current.onLost?.(reason),\n            onMessage: (message) => {\n                setLastMessage(message);\n                optionsRef.current.onMessage?.(message);\n            },\n        });\n        controllerRef.current = controller;\n\n        return () => {\n            controller.close();\n            controllerRef.current = null;\n        };\n    }, [\n        url,\n        enabled,\n        protocolsKey,\n        maxRetries,\n        initialBackoff,\n        maxBackoff,\n        jitter,\n        handshakeTimeout,\n        silenceTimeout,\n        waitForOnline,\n        pingInterval,\n        respondToPing,\n        queueWhileClosed,\n        maxQueuedMessages,\n        optionsRef,\n    ]);\n\n    const send = useCallback((payload: string | Blob | BufferSource): boolean => {\n        return controllerRef.current?.send(payload) ?? false;\n    }, []);\n\n    const reconnect = useCallback((): void => {\n        controllerRef.current?.reconnect();\n    }, []);\n\n    const setSilenceTimeout = useCallback((ms: number): void => {\n        controllerRef.current?.setSilenceTimeout(ms);\n    }, []);\n\n    return { status, lastMessage, send, reconnect, setSilenceTimeout };\n}\n"],"mappings":";;;;AA6DA,SAAgB,EACZ,GACA,IAAkC,CAAC,GACd;CACrB,IAAM,EACF,aAAU,IACV,cACA,eACA,mBACA,eACA,WACA,qBACA,mBACA,kBACA,iBACA,kBACA,qBACA,yBACA,GACE,CAAC,GAAQ,KAAa,EAA0B,MAAM,GACtD,CAAC,GAAa,KAAkB,EAAqC,IAAI,GACzE,IAAgB,EAAmC,IAAI,GAEvD,IAAa,EAAa,CAAO,GAEjC,IAAe,MAAM,QAAQ,CAAS,IAAI,EAAU,KAAK,GAAG,IAAK,KAAa;CA0FpF,OAxFA,QAAgB;EACZ,IAAI,CAAC,KAAW,CAAC,GAAK;GAClB,EAAU,MAAM;GAChB;EACJ;EASA,IAAM,IAAY,EAAW,QAAQ,WAAW,KAAA,GAC1C,IAAgB,EAAW,QAAQ,iBAAiB,KAAA,GACpD,IAAqB,EAAW,QAAQ,sBAAsB,KAAA,GAE9D,IAAa,EAAmB,GAAK;GACvC,WAAW,EAAW,QAAQ;GAC9B;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA,aAAa,EAAW,QAAQ;GAChC;GACA,aAAa,EAAW,QAAQ;GAChC;GACA;GACA,QAAQ,KAAa,MAAQ,EAAW,QAAQ,SAAS,CAAG,IAAS,KAAA;GACrE,cAAc,KACP,GAAO,MAAQ,EAAW,QAAQ,eAAe,GAAO,CAAG,IAC5D,KAAA;GACN,QAAQ,EAAW,QAAQ;GAC3B,mBAAmB,KACZ,GAAQ,MAAQ,EAAW,QAAQ,oBAAoB,GAAQ,CAAG,IACnE,KAAA;GACN,gBAAgB;GAChB,SAAS,MAAU,EAAW,QAAQ,SAAS,CAAK;GACpD,UAAU,MAAU,EAAW,QAAQ,UAAU,CAAK;GACtD,UAAU,MAAU,EAAW,QAAQ,UAAU,CAAK;GACtD,iBAAiB,GAAS,MAAU,EAAW,QAAQ,iBAAiB,GAAS,CAAK;GACtF,qBAAqB,EAAW,QAAQ,gBAAgB;GACxD,SAAS,MAAW,EAAW,QAAQ,SAAS,CAAM;GACtD,YAAY,MAAY;IAEpB,AADA,EAAe,CAAO,GACtB,EAAW,QAAQ,YAAY,CAAO;GAC1C;EACJ,CAAC;EAGD,OAFA,EAAc,UAAU,SAEX;GAET,AADA,EAAW,MAAM,GACjB,EAAc,UAAU;EAC5B;CACJ,GAAG;EACC;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;CACJ,CAAC,GAcM;EAAE;EAAQ;EAAa,MAZjB,GAAa,MACf,EAAc,SAAS,KAAK,CAAO,KAAK,IAChD,CAAC,CAU0B;EAAM,WARlB,QAAwB;GACtC,EAAc,SAAS,UAAU;EACrC,GAAG,CAAC,CAMgC;EAAW,mBAJrB,GAAa,MAAqB;GACxD,EAAc,SAAS,kBAAkB,CAAE;EAC/C,GAAG,CAAC,CAE2C;CAAkB;AACrE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tempest-react-sdk",
-  "version": "0.60.0",
+  "version": "0.62.0",
   "description": "SDK público da Tempest com componentes, hooks e integrações para projetos React.",
   "type": "module",
   "license": "MIT",