Merge pull request #281 from quiltt/events-ready

Add bindings for a new onOpen callback event for Connector Modals
quiltt · Jul 31, 2024 · 88a30d8 · 88a30d8
2 parents 597f3fe + 0c5fd75
commit 88a30d8
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 0 deletions.
diff --git a/.changeset/khaki-bulldogs-care.md b/.changeset/khaki-bulldogs-care.md
@@ -0,0 +1,7 @@
+---
+"@quiltt/react": minor
+"@quiltt/core": minor
+"@quiltt/react-native": minor
+---
+
+Add bindings for a new onOpen callback event for Connector Modals
diff --git a/packages/core/src/api/browser.ts b/packages/core/src/api/browser.ts
@@ -1,5 +1,6 @@
 interface CallbackManager {
   onEvent(callback: ConnectorSDKOnEventCallback): void
+  onOpen(callback: ConnectorSDKOnOpenCallback): void
   onLoad(callback: ConnectorSDKOnLoadCallback): void
   onExit(callback: ConnectorSDKOnEventExitCallback): void
   onExitSuccess(callback: ConnectorSDKOnExitSuccessCallback): void
@@ -8,6 +9,7 @@ interface CallbackManager {
 
   // Because it's well within React behavior to try to register a billion functions
   offEvent(callback: ConnectorSDKOnEventCallback): void
+  offOpen(callback: ConnectorSDKOnOpenCallback): void
   offLoad(callback: ConnectorSDKOnLoadCallback): void
   offExit(callback: ConnectorSDKOnEventExitCallback): void
   offExitSuccess(callback: ConnectorSDKOnExitSuccessCallback): void
@@ -35,6 +37,7 @@ export interface ConnectorSDKConnector extends CallbackManager {
  */
 export type ConnectorSDKCallbacks = {
   onEvent?: ConnectorSDKOnEventCallback
+  onOpen?: ConnectorSDKOnOpenCallback
   onLoad?: ConnectorSDKOnLoadCallback
   onExit?: ConnectorSDKOnEventExitCallback
   onExitSuccess?: ConnectorSDKOnExitSuccessCallback
@@ -47,6 +50,7 @@ export type ConnectorSDKOnEventCallback = (
   metadata: ConnectorSDKCallbackMetadata
 ) => void
 
+export type ConnectorSDKOnOpenCallback = (metadata: ConnectorSDKCallbackMetadata) => void
 export type ConnectorSDKOnLoadCallback = (metadata: ConnectorSDKCallbackMetadata) => void
 
 export type ConnectorSDKOnEventExitCallback = (

diff --git a/packages/react/src/components/QuilttButton.tsx b/packages/react/src/components/QuilttButton.tsx
@@ -20,6 +20,7 @@ export const QuilttButton = <T extends AnyTag = 'button'>({
   connectionId,
   institution,
   onEvent,
+  onOpen,
   onLoad,
   onExit,
   onExitSuccess,
@@ -32,6 +33,7 @@ export const QuilttButton = <T extends AnyTag = 'button'>({
     connectionId,
     institution,
     onEvent,
+    onOpen,
     onLoad,
     onExit,
     onExitSuccess,

diff --git a/packages/react/src/hooks/useQuilttConnector.ts b/packages/react/src/hooks/useQuilttConnector.ts
@@ -52,6 +52,15 @@ export const useQuilttConnector = (
     return () => connector.offEvent(options.onEvent as any)
   }, [connector, options?.onEvent])
 
+  // onOpen
+  useEffect(() => {
+    if (!connector || !options?.onOpen) return
+
+    connector.onOpen(options.onOpen)
+    return () => connector.offOpen(options.onOpen as any)
+  }, [connector, options?.onOpen])
+
+
   // onLoad
   useEffect(() => {
     if (!connector || !options?.onLoad) return