@knocklabs/expo 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @knocklabs/expo
+
+## 0.1.0
+
+### Minor Changes
+
+- a82e897: Move KnockExpoPushNotificationProvider to @knocklabs/expo
+
+### Patch Changes
+
+- Updated dependencies [a82e897]
+  - @knocklabs/react-native@0.4.0

package/README.md

@@ -0,0 +1,146 @@
+# Knock Expo SDK
+
+A set of components for integrating [Knock](https://knock.app) in-app notifications into an Expo + React Native application.
+
+> Not using Expo? See our vanilla [React Native SDK](../react-native/README.md).
+
+## Installation
+
+Via NPM:
+
+```
+npm install @knocklabs/expo
+```
+
+Via Yarn:
+
+```
+yarn add @knocklabs/expo
+```
+
+## Migrating from `@knocklabs/react-native`
+
+As of `@knocklabs/react-native` v0.4.0, `KnockExpoPushNotificationProvider` has moved to our Expo SDK. To migrate:
+
+1. Remove `@knocklabs/react-native` from your project
+
+   NPM:
+
+   ```bash
+   npm uninstall @knocklabs/react-native
+   ```
+
+   Yarn:
+
+   ```bash
+   yarn remove @knocklabs/react-native
+   ```
+
+1. Install `@knocklabs/expo`
+
+   NPM:
+
+   ```bash
+   npm install @knocklabs/expo
+   ```
+
+   Yarn:
+
+   ```bash
+   yarn add @knocklabs/expo
+   ```
+
+1. Update any import statements from `@knocklabs/react-native` to `@knocklabs/expo`
+
+   From:
+
+   ```js
+   import {
+     KnockExpoPushNotificationProvider,
+     KnockFeedProvider,
+     KnockProvider,
+     NotificationIconButton,
+   } from "@knocklabs/react-native";
+   ```
+
+   To:
+
+   ```js
+   import {
+     KnockExpoPushNotificationProvider,
+     KnockFeedProvider,
+     KnockProvider,
+     NotificationIconButton,
+   } from "@knocklabs/expo";
+   ```
+
+## Configuration
+
+To configure the feed you will need:
+
+1. A public API key (found in the Knock dashboard)
+1. A user ID, and optionally an auth token for production environments
+1. If integrating an in-app feed, a feed channel ID (found in the Knock dashboard)
+
+## Usage
+
+You can integrate the feed into your app as follows:
+
+```jsx
+import {
+  KnockFeedProvider,
+  KnockProvider,
+  NotificationFeedContainer,
+} from "@knocklabs/expo";
+
+const YourAppLayout = () => {
+  const [isVisible, setIsVisible] = useState(false);
+  const notifButtonRef = useRef(null);
+
+  return (
+    <KnockProvider apiKey={process.env.KNOCK_PUBLIC_API_KEY} userId={userId}>
+      <KnockFeedProvider feedId={process.env.KNOCK_FEED_ID}>
+        <NotificationFeedContainer>
+          <Text>Notifications go in here!</Text>
+        </NotificationFeedContainer>
+      </KnockFeedProvider>
+    </KnockProvider>
+  );
+};
+```
+
+## Headless usage
+
+Alternatively, if you don't want to use our components you can render the feed in a headless mode using our hooks:
+
+```jsx
+import { useAuthenticatedKnockClient, useNotifications } from "@knocklabs/expo";
+import create from "zustand";
+
+const YourAppLayout = () => {
+  const knockClient = useAuthenticatedKnockClient(
+    process.env.KNOCK_PUBLIC_API_KEY,
+    currentUser.id,
+  );
+
+  const notificationFeed = useNotifications(
+    knockClient,
+    process.env.KNOCK_FEED_ID,
+  );
+
+  const useNotificationStore = create(notificationFeed.store);
+  const { metadata } = useNotificationStore();
+
+  useEffect(() => {
+    notificationFeed.fetch();
+  }, [notificationFeed]);
+
+  return <Text>Total unread: {metadata.unread_count}</Text>;
+};
+```
+
+## Related links
+
+- [Signup for Knock](https://knock.app)
+- [Knock documentation](https://docs.knock.app)
+- [Knock dashboard](https://dashboard.knock.app)

package/dist/cjs/index.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("./modules/push/KnockExpoPushNotificationProvider.js"),o=require("@knocklabs/react-native");exports.KnockExpoPushNotificationProvider=t.KnockExpoPushNotificationProvider;exports.useExpoPushNotifications=t.useExpoPushNotifications;Object.keys(o).forEach(e=>{e!=="default"&&!Object.prototype.hasOwnProperty.call(exports,e)&&Object.defineProperty(exports,e,{enumerable:!0,get:()=>o[e]})});
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/cjs/modules/push/KnockExpoPushNotificationProvider.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const w=require("react/jsx-runtime"),_=require("@knocklabs/react-core"),j=require("expo-constants"),D=require("expo-device"),R=require("expo-notifications"),i=require("react"),q=e=>e&&typeof e=="object"&&"default"in e?e:{default:e};function C(e){if(e&&typeof e=="object"&&"default"in e)return e;const a=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(e){for(const c in e)if(c!=="default"){const l=Object.getOwnPropertyDescriptor(e,c);Object.defineProperty(a,c,l.get?l:{enumerable:!0,get:()=>e[c]})}}return a.default=e,Object.freeze(a)}const h=q(j),O=C(D),r=C(R);r.setNotificationHandler({handleNotification:async()=>({shouldShowAlert:!0,shouldPlaySound:!0,shouldSetBadge:!0})});const A=async e=>({shouldShowAlert:!0,shouldPlaySound:!0,shouldSetBadge:!0}),x=i.createContext(void 0);async function H(){const{status:e}=await r.getPermissionsAsync();if(e!=="granted"){const{status:a}=await r.requestPermissionsAsync();return a}return e}async function F(){try{return!h.default.expoConfig||!h.default.expoConfig.extra||!h.default.expoConfig.extra.eas?(console.error("[Knock] Expo Project ID is not defined in the app configuration."),null):await r.getExpoPushTokenAsync({projectId:h.default.expoConfig.extra.eas.projectId})}catch(e){return console.error("[Knock] Error getting Expo push token:",e),null}}async function M(){return O.isDevice?await H()!=="granted"?(console.warn("[Knock] Push notification permission not granted"),null):F():(console.warn("[Knock] Must use physical device for Push Notifications"),null)}const B=({knockExpoChannelId:e,customNotificationHandler:a,children:c,autoRegister:l=!0})=>{const[d,m]=i.useState(null),n=_.useKnockClient(),[g,v]=i.useState(()=>()=>{}),[k,y]=i.useState(()=>()=>{}),S=i.useCallback(t=>{v(()=>t)},[]),b=i.useCallback(t=>{y(()=>t)},[]),p=i.useCallback(async()=>{try{n.log("[Knock] Registering for push notifications");const t=await M();n.log(`[Knock] Token received: ${t==null?void 0:t.data}`),t!=null&&t.data&&(n.log(`[Knock] Setting push token: ${t.data}`),m(t.data))}catch(t){console.error("[Knock] Error registering for push notifications:",t)}},[n]),P=i.useCallback(async(t,s)=>{const o=t.request.content.data.knock_message_id;return n.messages.updateStatus(o,s)},[n]),u=i.useCallback(async(t,s)=>n.user.setChannelData({channelId:s,channelData:{tokens:t}}),[n]),N=i.useCallback(async(t,s)=>{n.user.getChannelData({channelId:s}).then(o=>{const f=o.data.tokens;if(!f.includes(t))return f.push(t),u(f,s);n.log("[Knock] registerPushTokenToChannel success")}).catch(o=>u([t],s))},[n,u]),K=i.useCallback(async(t,s)=>{n.user.getChannelData({channelId:s}).then(o=>{const T=o.data.tokens.filter(E=>E!==t);return n.log("unregisterPushTokenFromChannel success"),u(T,s)}).catch(o=>{console.error("[Knock] Error unregistering push token from channel:",o)})},[n,u]);return i.useEffect(()=>{r.setNotificationHandler({handleNotification:a??A}),l&&p().then(()=>{d&&N(d,e).then(o=>{n.log("[Knock] setChannelData success")}).catch(o=>{console.error("[Knock] Error in setting push token or channel data",o)})}).catch(o=>{console.error("[Knock] Error in setting push token or channel data",o)});const t=r.addNotificationReceivedListener(o=>{n.log("[Knock] Expo Push Notification received in foreground:"),P(o,"interacted"),g(o)}),s=r.addNotificationResponseReceivedListener(o=>{n.log("[Knock] Expo Push Notification was interacted with"),P(o.notification,"interacted"),k(o)});return()=>{r.removeNotificationSubscription(t),r.removeNotificationSubscription(s)}},[p,g,k,a,d,e,n]),w.jsx(x.Provider,{value:{expoPushToken:d,registerForPushNotifications:p,registerPushTokenToChannel:N,unregisterPushTokenFromChannel:K,onNotificationReceived:S,onNotificationTapped:b},children:c})},L=()=>{const e=i.useContext(x);if(e===void 0)throw new Error("[Knock] useExpoPushNotifications must be used within a PushNotificationProvider");return e};exports.KnockExpoPushNotificationProvider=B;exports.useExpoPushNotifications=L;
+//# sourceMappingURL=KnockExpoPushNotificationProvider.js.map

package/dist/cjs/modules/push/KnockExpoPushNotificationProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnockExpoPushNotificationProvider.js","sources":["../../../../src/modules/push/KnockExpoPushNotificationProvider.tsx"],"sourcesContent":["import {\n  ChannelData,\n  Message,\n  MessageEngagementStatus,\n} from \"@knocklabs/client\";\nimport { useKnockClient } from \"@knocklabs/react-core\";\nimport Constants from \"expo-constants\";\nimport * as Device from \"expo-device\";\nimport * as Notifications from \"expo-notifications\";\nimport React, {\n  createContext,\n  useCallback,\n  useContext,\n  useEffect,\n  useState,\n} from \"react\";\n\nexport interface KnockExpoPushNotificationContextType {\n  expoPushToken: string | null;\n  registerForPushNotifications: () => Promise<void>;\n  registerPushTokenToChannel(token: string, channelId: string): Promise<void>;\n  unregisterPushTokenFromChannel(\n    token: string,\n    channelId: string,\n  ): Promise<void>;\n  onNotificationReceived: (\n    handler: (notification: Notifications.Notification) => void,\n  ) => void;\n  onNotificationTapped: (\n    handler: (response: Notifications.NotificationResponse) => void,\n  ) => void;\n}\n\nNotifications.setNotificationHandler({\n  handleNotification: async () => {\n    return {\n      shouldShowAlert: true,\n      shouldPlaySound: true,\n      shouldSetBadge: true,\n    };\n  },\n});\n\nconst defaultNotificationHandler = async (\n  _notification: Notifications.Notification,\n): Promise<Notifications.NotificationBehavior> => {\n  return {\n    shouldShowAlert: true,\n    shouldPlaySound: true,\n    shouldSetBadge: true,\n  };\n};\n\nconst KnockExpoPushNotificationContext = createContext<\n  KnockExpoPushNotificationContextType | undefined\n>(undefined);\n\nexport interface KnockExpoPushNotificationProviderProps {\n  knockExpoChannelId: string;\n  customNotificationHandler?: (\n    notification: Notifications.Notification,\n  ) => Promise<Notifications.NotificationBehavior>;\n  children?: React.ReactElement;\n  autoRegister?: boolean;\n}\n\nasync function requestPushPermissionIfNeeded(): Promise<string> {\n  const { status: existingStatus } = await Notifications.getPermissionsAsync();\n\n  if (existingStatus !== \"granted\") {\n    const { status } = await Notifications.requestPermissionsAsync();\n    return status;\n  }\n\n  return existingStatus;\n}\n\nasync function getExpoPushToken(): Promise<Notifications.ExpoPushToken | null> {\n  try {\n    if (\n      !Constants.expoConfig ||\n      !Constants.expoConfig.extra ||\n      !Constants.expoConfig.extra.eas\n    ) {\n      console.error(\n        \"[Knock] Expo Project ID is not defined in the app configuration.\",\n      );\n      return null;\n    }\n    const token = await Notifications.getExpoPushTokenAsync({\n      projectId: Constants.expoConfig.extra.eas.projectId,\n    });\n    return token;\n  } catch (error) {\n    console.error(\"[Knock] Error getting Expo push token:\", error);\n    return null;\n  }\n}\n\nasync function requestPermissionAndGetPushToken(): Promise<Notifications.ExpoPushToken | null> {\n  // Check for device support\n  if (!Device.isDevice) {\n    console.warn(\"[Knock] Must use physical device for Push Notifications\");\n    return null;\n  }\n\n  const permissionStatus = await requestPushPermissionIfNeeded();\n\n  if (permissionStatus !== \"granted\") {\n    console.warn(\"[Knock] Push notification permission not granted\");\n    return null;\n  }\n\n  return getExpoPushToken();\n}\n\nexport const KnockExpoPushNotificationProvider: React.FC<\n  KnockExpoPushNotificationProviderProps\n> = ({\n  knockExpoChannelId,\n  customNotificationHandler,\n  children,\n  autoRegister = true,\n}) => {\n  const [expoPushToken, setExpoPushToken] = useState<string | null>(null);\n  const knockClient = useKnockClient();\n\n  const [notificationReceivedHandler, setNotificationReceivedHandler] =\n    useState<(notification: Notifications.Notification) => void>(\n      () => () => {},\n    );\n\n  const [notificationTappedHandler, setNotificationTappedHandler] = useState<\n    (response: Notifications.NotificationResponse) => void\n  >(() => () => {});\n\n  const handleNotificationReceived = useCallback(\n    (handler: (notification: Notifications.Notification) => void) => {\n      setNotificationReceivedHandler(() => handler);\n    },\n    [],\n  );\n\n  const handleNotificationTapped = useCallback(\n    (handler: (response: Notifications.NotificationResponse) => void) => {\n      setNotificationTappedHandler(() => handler);\n    },\n    [],\n  );\n\n  const registerForPushNotifications = useCallback(async (): Promise<void> => {\n    try {\n      knockClient.log(`[Knock] Registering for push notifications`);\n      const token = await requestPermissionAndGetPushToken();\n      knockClient.log(`[Knock] Token received: ${token?.data}`);\n      if (token?.data) {\n        knockClient.log(`[Knock] Setting push token: ${token.data}`);\n        setExpoPushToken(token.data);\n      }\n    } catch (error) {\n      console.error(`[Knock] Error registering for push notifications:`, error);\n    }\n  }, [knockClient]);\n\n  const updateKnockMessageStatusFromNotification = useCallback(\n    async (\n      notification: Notifications.Notification,\n      status: MessageEngagementStatus,\n    ): Promise<Message> => {\n      const messageId = notification.request.content.data[\"knock_message_id\"];\n      return knockClient.messages.updateStatus(messageId, status);\n    },\n    [knockClient],\n  );\n\n  const registerNewTokenDataOnServer = useCallback(\n    async (tokens: string[], channelId: string): Promise<ChannelData> => {\n      return knockClient.user.setChannelData({\n        channelId: channelId,\n        channelData: { tokens: tokens },\n      });\n    },\n    [knockClient],\n  );\n\n  const registerPushTokenToChannel = useCallback(\n    async (token: string, channelId: string): Promise<void> => {\n      knockClient.user\n        .getChannelData({ channelId: channelId })\n        .then((result: ChannelData) => {\n          const tokens: string[] = result.data[\"tokens\"];\n          if (!tokens.includes(token)) {\n            tokens.push(token);\n            return registerNewTokenDataOnServer(tokens, channelId);\n          }\n          knockClient.log(\"[Knock] registerPushTokenToChannel success\");\n        })\n        .catch((_) => {\n          // No data registered on that channel for that user, we'll create a new record\n          return registerNewTokenDataOnServer([token], channelId);\n        });\n    },\n    [knockClient, registerNewTokenDataOnServer],\n  );\n\n  const unregisterPushTokenFromChannel = useCallback(\n    async (token: string, channelId: string): Promise<void> => {\n      knockClient.user\n        .getChannelData({ channelId: channelId })\n        .then((result: ChannelData) => {\n          const tokens: string[] = result.data[\"tokens\"];\n          const updatedTokens = tokens.filter(\n            (channelToken) => channelToken !== token,\n          );\n          knockClient.log(\"unregisterPushTokenFromChannel success\");\n          return registerNewTokenDataOnServer(updatedTokens, channelId);\n        })\n        .catch((error) => {\n          console.error(\n            `[Knock] Error unregistering push token from channel:`,\n            error,\n          );\n        });\n    },\n    [knockClient, registerNewTokenDataOnServer],\n  );\n\n  useEffect(() => {\n    Notifications.setNotificationHandler({\n      handleNotification:\n        customNotificationHandler ?? defaultNotificationHandler,\n    });\n\n    if (autoRegister) {\n      registerForPushNotifications()\n        .then(() => {\n          if (expoPushToken) {\n            registerPushTokenToChannel(expoPushToken, knockExpoChannelId)\n              .then((_result) => {\n                knockClient.log(\"[Knock] setChannelData success\");\n              })\n              .catch((_error) => {\n                console.error(\n                  \"[Knock] Error in setting push token or channel data\",\n                  _error,\n                );\n              });\n          }\n        })\n        .catch((_error) => {\n          console.error(\n            \"[Knock] Error in setting push token or channel data\",\n            _error,\n          );\n        });\n    }\n\n    const notificationReceivedSubscription =\n      Notifications.addNotificationReceivedListener((notification) => {\n        knockClient.log(\n          \"[Knock] Expo Push Notification received in foreground:\",\n        );\n        updateKnockMessageStatusFromNotification(notification, \"interacted\");\n        notificationReceivedHandler(notification);\n      });\n\n    const notificationResponseSubscription =\n      Notifications.addNotificationResponseReceivedListener((response) => {\n        knockClient.log(\"[Knock] Expo Push Notification was interacted with\");\n        updateKnockMessageStatusFromNotification(\n          response.notification,\n          \"interacted\",\n        );\n        notificationTappedHandler(response);\n      });\n\n    return () => {\n      Notifications.removeNotificationSubscription(\n        notificationReceivedSubscription,\n      );\n      Notifications.removeNotificationSubscription(\n        notificationResponseSubscription,\n      );\n    };\n\n    // TODO: Remove when possible and ensure dependency array is correct\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [\n    registerForPushNotifications,\n    notificationReceivedHandler,\n    notificationTappedHandler,\n    customNotificationHandler,\n    expoPushToken,\n    knockExpoChannelId,\n    knockClient,\n  ]);\n\n  return (\n    <KnockExpoPushNotificationContext.Provider\n      value={{\n        expoPushToken,\n        registerForPushNotifications,\n        registerPushTokenToChannel,\n        unregisterPushTokenFromChannel,\n        onNotificationReceived: handleNotificationReceived,\n        onNotificationTapped: handleNotificationTapped,\n      }}\n    >\n      {children}\n    </KnockExpoPushNotificationContext.Provider>\n  );\n};\n\nexport const useExpoPushNotifications =\n  (): KnockExpoPushNotificationContextType => {\n    const context = useContext(KnockExpoPushNotificationContext);\n    if (context === undefined) {\n      throw new Error(\n        \"[Knock] useExpoPushNotifications must be used within a PushNotificationProvider\",\n      );\n    }\n    return context;\n  };\n"],"names":["Notifications","defaultNotificationHandler","_notification","KnockExpoPushNotificationContext","createContext","requestPushPermissionIfNeeded","existingStatus","status","getExpoPushToken","Constants","error","requestPermissionAndGetPushToken","Device","KnockExpoPushNotificationProvider","knockExpoChannelId","customNotificationHandler","children","autoRegister","expoPushToken","setExpoPushToken","useState","knockClient","useKnockClient","notificationReceivedHandler","setNotificationReceivedHandler","notificationTappedHandler","setNotificationTappedHandler","handleNotificationReceived","useCallback","handler","handleNotificationTapped","registerForPushNotifications","token","updateKnockMessageStatusFromNotification","notification","messageId","registerNewTokenDataOnServer","tokens","channelId","registerPushTokenToChannel","result","_","unregisterPushTokenFromChannel","updatedTokens","channelToken","useEffect","_result","_error","notificationReceivedSubscription","notificationResponseSubscription","response","jsx","useExpoPushNotifications","context","useContext"],"mappings":"ipBAiCAA,EAAc,uBAAuB,CACnC,mBAAoB,UACX,CACL,gBAAiB,GACjB,gBAAiB,GACjB,eAAgB,EAAA,EAGtB,CAAC,EAED,MAAMC,EAA6B,MACjCC,IAEO,CACL,gBAAiB,GACjB,gBAAiB,GACjB,eAAgB,EAAA,GAIdC,EAAmCC,EAAAA,cAEvC,MAAS,EAWX,eAAeC,GAAiD,CAC9D,KAAM,CAAE,OAAQC,CAAA,EAAmB,MAAMN,EAAc,oBAAoB,EAE3E,GAAIM,IAAmB,UAAW,CAChC,KAAM,CAAE,OAAAC,CAAW,EAAA,MAAMP,EAAc,wBAAwB,EACxD,OAAAO,CACT,CAEO,OAAAD,CACT,CAEA,eAAeE,GAAgE,CACzE,GAAA,CAEA,MAAA,CAACC,EAAU,QAAA,YACX,CAACA,UAAU,WAAW,OACtB,CAACA,EAAA,QAAU,WAAW,MAAM,KAEpB,QAAA,MACN,kEAAA,EAEK,MAEK,MAAMT,EAAc,sBAAsB,CACtD,UAAWS,EAAAA,QAAU,WAAW,MAAM,IAAI,SAAA,CAC3C,QAEMC,EAAO,CACN,eAAA,MAAM,yCAA0CA,CAAK,EACtD,IACT,CACF,CAEA,eAAeC,GAAgF,CAEzF,OAACC,EAAO,SAKa,MAAMP,MAEN,WACvB,QAAQ,KAAK,kDAAkD,EACxD,MAGFG,EAAiB,GAXtB,QAAQ,KAAK,yDAAyD,EAC/D,KAWX,CAEO,MAAMK,EAET,CAAC,CACH,mBAAAC,EACA,0BAAAC,EACA,SAAAC,EACA,aAAAC,EAAe,EACjB,IAAM,CACJ,KAAM,CAACC,EAAeC,CAAgB,EAAIC,WAAwB,IAAI,EAChEC,EAAcC,EAAAA,iBAEd,CAACC,EAA6BC,CAA8B,EAChEJ,EAAA,SACE,IAAM,IAAM,CAAC,CAAA,EAGX,CAACK,EAA2BC,CAA4B,EAAIN,EAAAA,SAEhE,IAAM,IAAM,CAAA,CAAE,EAEVO,EAA6BC,EAAA,YAChCC,GAAgE,CAC/DL,EAA+B,IAAMK,CAAO,CAC9C,EACA,CAAC,CAAA,EAGGC,EAA2BF,EAAA,YAC9BC,GAAoE,CACnEH,EAA6B,IAAMG,CAAO,CAC5C,EACA,CAAC,CAAA,EAGGE,EAA+BH,EAAAA,YAAY,SAA2B,CACtE,GAAA,CACFP,EAAY,IAAI,4CAA4C,EACtD,MAAAW,EAAQ,MAAMrB,IACpBU,EAAY,IAAI,2BAA2BW,GAAA,YAAAA,EAAO,IAAI,EAAE,EACpDA,GAAA,MAAAA,EAAO,OACTX,EAAY,IAAI,+BAA+BW,EAAM,IAAI,EAAE,EAC3Db,EAAiBa,EAAM,IAAI,SAEtBtB,EAAO,CACN,QAAA,MAAM,oDAAqDA,CAAK,CAC1E,CAAA,EACC,CAACW,CAAW,CAAC,EAEVY,EAA2CL,EAAA,YAC/C,MACEM,EACA3B,IACqB,CACrB,MAAM4B,EAAYD,EAAa,QAAQ,QAAQ,KAAK,iBACpD,OAAOb,EAAY,SAAS,aAAac,EAAW5B,CAAM,CAC5D,EACA,CAACc,CAAW,CAAA,EAGRe,EAA+BR,EAAA,YACnC,MAAOS,EAAkBC,IAChBjB,EAAY,KAAK,eAAe,CACrC,UAAAiB,EACA,YAAa,CAAE,OAAAD,CAAe,CAAA,CAC/B,EAEH,CAAChB,CAAW,CAAA,EAGRkB,EAA6BX,EAAA,YACjC,MAAOI,EAAeM,IAAqC,CAC7CjB,EAAA,KACT,eAAe,CAAE,UAAAiB,CAAA,CAAsB,EACvC,KAAME,GAAwB,CACvB,MAAAH,EAAmBG,EAAO,KAAK,OACrC,GAAI,CAACH,EAAO,SAASL,CAAK,EACxB,OAAAK,EAAO,KAAKL,CAAK,EACVI,EAA6BC,EAAQC,CAAS,EAEvDjB,EAAY,IAAI,4CAA4C,CAAA,CAC7D,EACA,MAAOoB,GAECL,EAA6B,CAACJ,CAAK,EAAGM,CAAS,CACvD,CACL,EACA,CAACjB,EAAae,CAA4B,CAAA,EAGtCM,EAAiCd,EAAA,YACrC,MAAOI,EAAeM,IAAqC,CAC7CjB,EAAA,KACT,eAAe,CAAE,UAAAiB,CAAA,CAAsB,EACvC,KAAME,GAAwB,CAE7B,MAAMG,EADmBH,EAAO,KAAK,OACR,OAC1BI,GAAiBA,IAAiBZ,CAAA,EAErC,OAAAX,EAAY,IAAI,wCAAwC,EACjDe,EAA6BO,EAAeL,CAAS,CAAA,CAC7D,EACA,MAAO5B,GAAU,CACR,QAAA,MACN,uDACAA,CAAA,CACF,CACD,CACL,EACA,CAACW,EAAae,CAA4B,CAAA,EAG5CS,OAAAA,EAAAA,UAAU,IAAM,CACd7C,EAAc,uBAAuB,CACnC,mBACEe,GAA6Bd,CAAA,CAChC,EAEGgB,GAC2Bc,EAAA,EAC1B,KAAK,IAAM,CACNb,GACFqB,EAA2BrB,EAAeJ,CAAkB,EACzD,KAAMgC,GAAY,CACjBzB,EAAY,IAAI,gCAAgC,CAAA,CACjD,EACA,MAAO0B,GAAW,CACT,QAAA,MACN,sDACAA,CAAA,CACF,CACD,CACL,CACD,EACA,MAAOA,GAAW,CACT,QAAA,MACN,sDACAA,CAAA,CACF,CACD,EAGL,MAAMC,EACJhD,EAAc,gCAAiCkC,GAAiB,CAClDb,EAAA,IACV,wDAAA,EAEFY,EAAyCC,EAAc,YAAY,EACnEX,EAA4BW,CAAY,CAAA,CACzC,EAEGe,EACJjD,EAAc,wCAAyCkD,GAAa,CAClE7B,EAAY,IAAI,oDAAoD,EACpEY,EACEiB,EAAS,aACT,YAAA,EAEFzB,EAA0ByB,CAAQ,CAAA,CACnC,EAEH,MAAO,IAAM,CACGlD,EAAA,+BACZgD,CAAA,EAEYhD,EAAA,+BACZiD,CAAA,CACF,CACF,EAIC,CACDlB,EACAR,EACAE,EACAV,EACAG,EACAJ,EACAO,CAAA,CACD,EAGC8B,EAAA,IAAChD,EAAiC,SAAjC,CACC,MAAO,CACL,cAAAe,EACA,6BAAAa,EACA,2BAAAQ,EACA,+BAAAG,EACA,uBAAwBf,EACxB,qBAAsBG,CACxB,EAEC,SAAAd,CAAA,CAAA,CAGP,EAEaoC,EACX,IAA4C,CACpC,MAAAC,EAAUC,aAAWnD,CAAgC,EAC3D,GAAIkD,IAAY,OACd,MAAM,IAAI,MACR,iFAAA,EAGG,OAAAA,CACT"}

package/dist/esm/index.mjs

@@ -0,0 +1,7 @@
+import { KnockExpoPushNotificationProvider as r, useExpoPushNotifications as t } from "./modules/push/KnockExpoPushNotificationProvider.mjs";
+export * from "@knocklabs/react-native";
+export {
+  r as KnockExpoPushNotificationProvider,
+  t as useExpoPushNotifications
+};
+//# sourceMappingURL=index.mjs.map

package/dist/esm/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/dist/esm/modules/push/KnockExpoPushNotificationProvider.mjs

@@ -0,0 +1,176 @@
+import { jsx as R } from "react/jsx-runtime";
+import { useKnockClient as D } from "@knocklabs/react-core";
+import f from "expo-constants";
+import * as b from "expo-device";
+import * as s from "expo-notifications";
+import { createContext as A, useState as h, useCallback as r, useEffect as H, useContext as _ } from "react";
+s.setNotificationHandler({
+  handleNotification: async () => ({
+    shouldShowAlert: !0,
+    shouldPlaySound: !0,
+    shouldSetBadge: !0
+  })
+});
+const j = async (n) => ({
+  shouldShowAlert: !0,
+  shouldPlaySound: !0,
+  shouldSetBadge: !0
+}), m = A(void 0);
+async function q() {
+  const { status: n } = await s.getPermissionsAsync();
+  if (n !== "granted") {
+    const { status: c } = await s.requestPermissionsAsync();
+    return c;
+  }
+  return n;
+}
+async function F() {
+  try {
+    return !f.expoConfig || !f.expoConfig.extra || !f.expoConfig.extra.eas ? (console.error(
+      "[Knock] Expo Project ID is not defined in the app configuration."
+    ), null) : await s.getExpoPushTokenAsync({
+      projectId: f.expoConfig.extra.eas.projectId
+    });
+  } catch (n) {
+    return console.error("[Knock] Error getting Expo push token:", n), null;
+  }
+}
+async function B() {
+  return b.isDevice ? await q() !== "granted" ? (console.warn("[Knock] Push notification permission not granted"), null) : F() : (console.warn("[Knock] Must use physical device for Push Notifications"), null);
+}
+const I = ({
+  knockExpoChannelId: n,
+  customNotificationHandler: c,
+  children: N,
+  autoRegister: x = !0
+}) => {
+  const [u, v] = h(null), o = D(), [p, K] = h(
+    () => () => {
+    }
+  ), [g, y] = h(() => () => {
+  }), C = r(
+    (t) => {
+      K(() => t);
+    },
+    []
+  ), S = r(
+    (t) => {
+      y(() => t);
+    },
+    []
+  ), l = r(async () => {
+    try {
+      o.log("[Knock] Registering for push notifications");
+      const t = await B();
+      o.log(`[Knock] Token received: ${t == null ? void 0 : t.data}`), t != null && t.data && (o.log(`[Knock] Setting push token: ${t.data}`), v(t.data));
+    } catch (t) {
+      console.error("[Knock] Error registering for push notifications:", t);
+    }
+  }, [o]), k = r(
+    async (t, i) => {
+      const e = t.request.content.data.knock_message_id;
+      return o.messages.updateStatus(e, i);
+    },
+    [o]
+  ), a = r(
+    async (t, i) => o.user.setChannelData({
+      channelId: i,
+      channelData: { tokens: t }
+    }),
+    [o]
+  ), P = r(
+    async (t, i) => {
+      o.user.getChannelData({ channelId: i }).then((e) => {
+        const d = e.data.tokens;
+        if (!d.includes(t))
+          return d.push(t), a(d, i);
+        o.log("[Knock] registerPushTokenToChannel success");
+      }).catch((e) => a([t], i));
+    },
+    [o, a]
+  ), T = r(
+    async (t, i) => {
+      o.user.getChannelData({ channelId: i }).then((e) => {
+        const E = e.data.tokens.filter(
+          (w) => w !== t
+        );
+        return o.log("unregisterPushTokenFromChannel success"), a(E, i);
+      }).catch((e) => {
+        console.error(
+          "[Knock] Error unregistering push token from channel:",
+          e
+        );
+      });
+    },
+    [o, a]
+  );
+  return H(() => {
+    s.setNotificationHandler({
+      handleNotification: c ?? j
+    }), x && l().then(() => {
+      u && P(u, n).then((e) => {
+        o.log("[Knock] setChannelData success");
+      }).catch((e) => {
+        console.error(
+          "[Knock] Error in setting push token or channel data",
+          e
+        );
+      });
+    }).catch((e) => {
+      console.error(
+        "[Knock] Error in setting push token or channel data",
+        e
+      );
+    });
+    const t = s.addNotificationReceivedListener((e) => {
+      o.log(
+        "[Knock] Expo Push Notification received in foreground:"
+      ), k(e, "interacted"), p(e);
+    }), i = s.addNotificationResponseReceivedListener((e) => {
+      o.log("[Knock] Expo Push Notification was interacted with"), k(
+        e.notification,
+        "interacted"
+      ), g(e);
+    });
+    return () => {
+      s.removeNotificationSubscription(
+        t
+      ), s.removeNotificationSubscription(
+        i
+      );
+    };
+  }, [
+    l,
+    p,
+    g,
+    c,
+    u,
+    n,
+    o
+  ]), /* @__PURE__ */ R(
+    m.Provider,
+    {
+      value: {
+        expoPushToken: u,
+        registerForPushNotifications: l,
+        registerPushTokenToChannel: P,
+        unregisterPushTokenFromChannel: T,
+        onNotificationReceived: C,
+        onNotificationTapped: S
+      },
+      children: N
+    }
+  );
+}, O = () => {
+  const n = _(m);
+  if (n === void 0)
+    throw new Error(
+      "[Knock] useExpoPushNotifications must be used within a PushNotificationProvider"
+    );
+  return n;
+};
+export {
+  I as KnockExpoPushNotificationProvider,
+  O as useExpoPushNotifications
+};
+//# sourceMappingURL=KnockExpoPushNotificationProvider.mjs.map

package/dist/esm/modules/push/KnockExpoPushNotificationProvider.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnockExpoPushNotificationProvider.mjs","sources":["../../../../src/modules/push/KnockExpoPushNotificationProvider.tsx"],"sourcesContent":["import {\n  ChannelData,\n  Message,\n  MessageEngagementStatus,\n} from \"@knocklabs/client\";\nimport { useKnockClient } from \"@knocklabs/react-core\";\nimport Constants from \"expo-constants\";\nimport * as Device from \"expo-device\";\nimport * as Notifications from \"expo-notifications\";\nimport React, {\n  createContext,\n  useCallback,\n  useContext,\n  useEffect,\n  useState,\n} from \"react\";\n\nexport interface KnockExpoPushNotificationContextType {\n  expoPushToken: string | null;\n  registerForPushNotifications: () => Promise<void>;\n  registerPushTokenToChannel(token: string, channelId: string): Promise<void>;\n  unregisterPushTokenFromChannel(\n    token: string,\n    channelId: string,\n  ): Promise<void>;\n  onNotificationReceived: (\n    handler: (notification: Notifications.Notification) => void,\n  ) => void;\n  onNotificationTapped: (\n    handler: (response: Notifications.NotificationResponse) => void,\n  ) => void;\n}\n\nNotifications.setNotificationHandler({\n  handleNotification: async () => {\n    return {\n      shouldShowAlert: true,\n      shouldPlaySound: true,\n      shouldSetBadge: true,\n    };\n  },\n});\n\nconst defaultNotificationHandler = async (\n  _notification: Notifications.Notification,\n): Promise<Notifications.NotificationBehavior> => {\n  return {\n    shouldShowAlert: true,\n    shouldPlaySound: true,\n    shouldSetBadge: true,\n  };\n};\n\nconst KnockExpoPushNotificationContext = createContext<\n  KnockExpoPushNotificationContextType | undefined\n>(undefined);\n\nexport interface KnockExpoPushNotificationProviderProps {\n  knockExpoChannelId: string;\n  customNotificationHandler?: (\n    notification: Notifications.Notification,\n  ) => Promise<Notifications.NotificationBehavior>;\n  children?: React.ReactElement;\n  autoRegister?: boolean;\n}\n\nasync function requestPushPermissionIfNeeded(): Promise<string> {\n  const { status: existingStatus } = await Notifications.getPermissionsAsync();\n\n  if (existingStatus !== \"granted\") {\n    const { status } = await Notifications.requestPermissionsAsync();\n    return status;\n  }\n\n  return existingStatus;\n}\n\nasync function getExpoPushToken(): Promise<Notifications.ExpoPushToken | null> {\n  try {\n    if (\n      !Constants.expoConfig ||\n      !Constants.expoConfig.extra ||\n      !Constants.expoConfig.extra.eas\n    ) {\n      console.error(\n        \"[Knock] Expo Project ID is not defined in the app configuration.\",\n      );\n      return null;\n    }\n    const token = await Notifications.getExpoPushTokenAsync({\n      projectId: Constants.expoConfig.extra.eas.projectId,\n    });\n    return token;\n  } catch (error) {\n    console.error(\"[Knock] Error getting Expo push token:\", error);\n    return null;\n  }\n}\n\nasync function requestPermissionAndGetPushToken(): Promise<Notifications.ExpoPushToken | null> {\n  // Check for device support\n  if (!Device.isDevice) {\n    console.warn(\"[Knock] Must use physical device for Push Notifications\");\n    return null;\n  }\n\n  const permissionStatus = await requestPushPermissionIfNeeded();\n\n  if (permissionStatus !== \"granted\") {\n    console.warn(\"[Knock] Push notification permission not granted\");\n    return null;\n  }\n\n  return getExpoPushToken();\n}\n\nexport const KnockExpoPushNotificationProvider: React.FC<\n  KnockExpoPushNotificationProviderProps\n> = ({\n  knockExpoChannelId,\n  customNotificationHandler,\n  children,\n  autoRegister = true,\n}) => {\n  const [expoPushToken, setExpoPushToken] = useState<string | null>(null);\n  const knockClient = useKnockClient();\n\n  const [notificationReceivedHandler, setNotificationReceivedHandler] =\n    useState<(notification: Notifications.Notification) => void>(\n      () => () => {},\n    );\n\n  const [notificationTappedHandler, setNotificationTappedHandler] = useState<\n    (response: Notifications.NotificationResponse) => void\n  >(() => () => {});\n\n  const handleNotificationReceived = useCallback(\n    (handler: (notification: Notifications.Notification) => void) => {\n      setNotificationReceivedHandler(() => handler);\n    },\n    [],\n  );\n\n  const handleNotificationTapped = useCallback(\n    (handler: (response: Notifications.NotificationResponse) => void) => {\n      setNotificationTappedHandler(() => handler);\n    },\n    [],\n  );\n\n  const registerForPushNotifications = useCallback(async (): Promise<void> => {\n    try {\n      knockClient.log(`[Knock] Registering for push notifications`);\n      const token = await requestPermissionAndGetPushToken();\n      knockClient.log(`[Knock] Token received: ${token?.data}`);\n      if (token?.data) {\n        knockClient.log(`[Knock] Setting push token: ${token.data}`);\n        setExpoPushToken(token.data);\n      }\n    } catch (error) {\n      console.error(`[Knock] Error registering for push notifications:`, error);\n    }\n  }, [knockClient]);\n\n  const updateKnockMessageStatusFromNotification = useCallback(\n    async (\n      notification: Notifications.Notification,\n      status: MessageEngagementStatus,\n    ): Promise<Message> => {\n      const messageId = notification.request.content.data[\"knock_message_id\"];\n      return knockClient.messages.updateStatus(messageId, status);\n    },\n    [knockClient],\n  );\n\n  const registerNewTokenDataOnServer = useCallback(\n    async (tokens: string[], channelId: string): Promise<ChannelData> => {\n      return knockClient.user.setChannelData({\n        channelId: channelId,\n        channelData: { tokens: tokens },\n      });\n    },\n    [knockClient],\n  );\n\n  const registerPushTokenToChannel = useCallback(\n    async (token: string, channelId: string): Promise<void> => {\n      knockClient.user\n        .getChannelData({ channelId: channelId })\n        .then((result: ChannelData) => {\n          const tokens: string[] = result.data[\"tokens\"];\n          if (!tokens.includes(token)) {\n            tokens.push(token);\n            return registerNewTokenDataOnServer(tokens, channelId);\n          }\n          knockClient.log(\"[Knock] registerPushTokenToChannel success\");\n        })\n        .catch((_) => {\n          // No data registered on that channel for that user, we'll create a new record\n          return registerNewTokenDataOnServer([token], channelId);\n        });\n    },\n    [knockClient, registerNewTokenDataOnServer],\n  );\n\n  const unregisterPushTokenFromChannel = useCallback(\n    async (token: string, channelId: string): Promise<void> => {\n      knockClient.user\n        .getChannelData({ channelId: channelId })\n        .then((result: ChannelData) => {\n          const tokens: string[] = result.data[\"tokens\"];\n          const updatedTokens = tokens.filter(\n            (channelToken) => channelToken !== token,\n          );\n          knockClient.log(\"unregisterPushTokenFromChannel success\");\n          return registerNewTokenDataOnServer(updatedTokens, channelId);\n        })\n        .catch((error) => {\n          console.error(\n            `[Knock] Error unregistering push token from channel:`,\n            error,\n          );\n        });\n    },\n    [knockClient, registerNewTokenDataOnServer],\n  );\n\n  useEffect(() => {\n    Notifications.setNotificationHandler({\n      handleNotification:\n        customNotificationHandler ?? defaultNotificationHandler,\n    });\n\n    if (autoRegister) {\n      registerForPushNotifications()\n        .then(() => {\n          if (expoPushToken) {\n            registerPushTokenToChannel(expoPushToken, knockExpoChannelId)\n              .then((_result) => {\n                knockClient.log(\"[Knock] setChannelData success\");\n              })\n              .catch((_error) => {\n                console.error(\n                  \"[Knock] Error in setting push token or channel data\",\n                  _error,\n                );\n              });\n          }\n        })\n        .catch((_error) => {\n          console.error(\n            \"[Knock] Error in setting push token or channel data\",\n            _error,\n          );\n        });\n    }\n\n    const notificationReceivedSubscription =\n      Notifications.addNotificationReceivedListener((notification) => {\n        knockClient.log(\n          \"[Knock] Expo Push Notification received in foreground:\",\n        );\n        updateKnockMessageStatusFromNotification(notification, \"interacted\");\n        notificationReceivedHandler(notification);\n      });\n\n    const notificationResponseSubscription =\n      Notifications.addNotificationResponseReceivedListener((response) => {\n        knockClient.log(\"[Knock] Expo Push Notification was interacted with\");\n        updateKnockMessageStatusFromNotification(\n          response.notification,\n          \"interacted\",\n        );\n        notificationTappedHandler(response);\n      });\n\n    return () => {\n      Notifications.removeNotificationSubscription(\n        notificationReceivedSubscription,\n      );\n      Notifications.removeNotificationSubscription(\n        notificationResponseSubscription,\n      );\n    };\n\n    // TODO: Remove when possible and ensure dependency array is correct\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n  }, [\n    registerForPushNotifications,\n    notificationReceivedHandler,\n    notificationTappedHandler,\n    customNotificationHandler,\n    expoPushToken,\n    knockExpoChannelId,\n    knockClient,\n  ]);\n\n  return (\n    <KnockExpoPushNotificationContext.Provider\n      value={{\n        expoPushToken,\n        registerForPushNotifications,\n        registerPushTokenToChannel,\n        unregisterPushTokenFromChannel,\n        onNotificationReceived: handleNotificationReceived,\n        onNotificationTapped: handleNotificationTapped,\n      }}\n    >\n      {children}\n    </KnockExpoPushNotificationContext.Provider>\n  );\n};\n\nexport const useExpoPushNotifications =\n  (): KnockExpoPushNotificationContextType => {\n    const context = useContext(KnockExpoPushNotificationContext);\n    if (context === undefined) {\n      throw new Error(\n        \"[Knock] useExpoPushNotifications must be used within a PushNotificationProvider\",\n      );\n    }\n    return context;\n  };\n"],"names":["Notifications","defaultNotificationHandler","_notification","KnockExpoPushNotificationContext","createContext","requestPushPermissionIfNeeded","existingStatus","status","getExpoPushToken","Constants","error","requestPermissionAndGetPushToken","Device","KnockExpoPushNotificationProvider","knockExpoChannelId","customNotificationHandler","children","autoRegister","expoPushToken","setExpoPushToken","useState","knockClient","useKnockClient","notificationReceivedHandler","setNotificationReceivedHandler","notificationTappedHandler","setNotificationTappedHandler","handleNotificationReceived","useCallback","handler","handleNotificationTapped","registerForPushNotifications","token","updateKnockMessageStatusFromNotification","notification","messageId","registerNewTokenDataOnServer","tokens","channelId","registerPushTokenToChannel","result","_","unregisterPushTokenFromChannel","updatedTokens","channelToken","useEffect","_result","_error","notificationReceivedSubscription","notificationResponseSubscription","response","jsx","useExpoPushNotifications","context","useContext"],"mappings":";;;;;;AAiCAA,EAAc,uBAAuB;AAAA,EACnC,oBAAoB,aACX;AAAA,IACL,iBAAiB;AAAA,IACjB,iBAAiB;AAAA,IACjB,gBAAgB;AAAA,EAAA;AAGtB,CAAC;AAED,MAAMC,IAA6B,OACjCC,OAEO;AAAA,EACL,iBAAiB;AAAA,EACjB,iBAAiB;AAAA,EACjB,gBAAgB;AAAA,IAIdC,IAAmCC,EAEvC,MAAS;AAWX,eAAeC,IAAiD;AAC9D,QAAM,EAAE,QAAQC,EAAA,IAAmB,MAAMN,EAAc,oBAAoB;AAE3E,MAAIM,MAAmB,WAAW;AAChC,UAAM,EAAE,QAAAC,EAAW,IAAA,MAAMP,EAAc,wBAAwB;AACxD,WAAAO;AAAA,EACT;AAEO,SAAAD;AACT;AAEA,eAAeE,IAAgE;AACzE,MAAA;AAEA,WAAA,CAACC,EAAU,cACX,CAACA,EAAU,WAAW,SACtB,CAACA,EAAU,WAAW,MAAM,OAEpB,QAAA;AAAA,MACN;AAAA,IAAA,GAEK,QAEK,MAAMT,EAAc,sBAAsB;AAAA,MACtD,WAAWS,EAAU,WAAW,MAAM,IAAI;AAAA,IAAA,CAC3C;AAAA,WAEMC,GAAO;AACN,mBAAA,MAAM,0CAA0CA,CAAK,GACtD;AAAA,EACT;AACF;AAEA,eAAeC,IAAgF;AAEzF,SAACC,EAAO,WAKa,MAAMP,QAEN,aACvB,QAAQ,KAAK,kDAAkD,GACxD,QAGFG,EAAiB,KAXtB,QAAQ,KAAK,yDAAyD,GAC/D;AAWX;AAEO,MAAMK,IAET,CAAC;AAAA,EACH,oBAAAC;AAAA,EACA,2BAAAC;AAAA,EACA,UAAAC;AAAA,EACA,cAAAC,IAAe;AACjB,MAAM;AACJ,QAAM,CAACC,GAAeC,CAAgB,IAAIC,EAAwB,IAAI,GAChEC,IAAcC,KAEd,CAACC,GAA6BC,CAA8B,IAChEJ;AAAA,IACE,MAAM,MAAM;AAAA,IAAC;AAAA,EAAA,GAGX,CAACK,GAA2BC,CAA4B,IAAIN,EAEhE,MAAM,MAAM;AAAA,EAAA,CAAE,GAEVO,IAA6BC;AAAA,IACjC,CAACC,MAAgE;AAC/D,MAAAL,EAA+B,MAAMK,CAAO;AAAA,IAC9C;AAAA,IACA,CAAC;AAAA,EAAA,GAGGC,IAA2BF;AAAA,IAC/B,CAACC,MAAoE;AACnE,MAAAH,EAA6B,MAAMG,CAAO;AAAA,IAC5C;AAAA,IACA,CAAC;AAAA,EAAA,GAGGE,IAA+BH,EAAY,YAA2B;AACtE,QAAA;AACF,MAAAP,EAAY,IAAI,4CAA4C;AACtD,YAAAW,IAAQ,MAAMrB;AACpB,MAAAU,EAAY,IAAI,2BAA2BW,KAAA,gBAAAA,EAAO,IAAI,EAAE,GACpDA,KAAA,QAAAA,EAAO,SACTX,EAAY,IAAI,+BAA+BW,EAAM,IAAI,EAAE,GAC3Db,EAAiBa,EAAM,IAAI;AAAA,aAEtBtB,GAAO;AACN,cAAA,MAAM,qDAAqDA,CAAK;AAAA,IAC1E;AAAA,EAAA,GACC,CAACW,CAAW,CAAC,GAEVY,IAA2CL;AAAA,IAC/C,OACEM,GACA3B,MACqB;AACrB,YAAM4B,IAAYD,EAAa,QAAQ,QAAQ,KAAK;AACpD,aAAOb,EAAY,SAAS,aAAac,GAAW5B,CAAM;AAAA,IAC5D;AAAA,IACA,CAACc,CAAW;AAAA,EAAA,GAGRe,IAA+BR;AAAA,IACnC,OAAOS,GAAkBC,MAChBjB,EAAY,KAAK,eAAe;AAAA,MACrC,WAAAiB;AAAA,MACA,aAAa,EAAE,QAAAD,EAAe;AAAA,IAAA,CAC/B;AAAA,IAEH,CAAChB,CAAW;AAAA,EAAA,GAGRkB,IAA6BX;AAAA,IACjC,OAAOI,GAAeM,MAAqC;AAC7C,MAAAjB,EAAA,KACT,eAAe,EAAE,WAAAiB,EAAA,CAAsB,EACvC,KAAK,CAACE,MAAwB;AACvB,cAAAH,IAAmBG,EAAO,KAAK;AACrC,YAAI,CAACH,EAAO,SAASL,CAAK;AACxB,iBAAAK,EAAO,KAAKL,CAAK,GACVI,EAA6BC,GAAQC,CAAS;AAEvD,QAAAjB,EAAY,IAAI,4CAA4C;AAAA,MAAA,CAC7D,EACA,MAAM,CAACoB,MAECL,EAA6B,CAACJ,CAAK,GAAGM,CAAS,CACvD;AAAA,IACL;AAAA,IACA,CAACjB,GAAae,CAA4B;AAAA,EAAA,GAGtCM,IAAiCd;AAAA,IACrC,OAAOI,GAAeM,MAAqC;AAC7C,MAAAjB,EAAA,KACT,eAAe,EAAE,WAAAiB,EAAA,CAAsB,EACvC,KAAK,CAACE,MAAwB;AAE7B,cAAMG,IADmBH,EAAO,KAAK,OACR;AAAA,UAC3B,CAACI,MAAiBA,MAAiBZ;AAAA,QAAA;AAErC,eAAAX,EAAY,IAAI,wCAAwC,GACjDe,EAA6BO,GAAeL,CAAS;AAAA,MAAA,CAC7D,EACA,MAAM,CAAC5B,MAAU;AACR,gBAAA;AAAA,UACN;AAAA,UACAA;AAAA,QAAA;AAAA,MACF,CACD;AAAA,IACL;AAAA,IACA,CAACW,GAAae,CAA4B;AAAA,EAAA;AAG5C,SAAAS,EAAU,MAAM;AACd,IAAA7C,EAAc,uBAAuB;AAAA,MACnC,oBACEe,KAA6Bd;AAAA,IAAA,CAChC,GAEGgB,KAC2Bc,EAAA,EAC1B,KAAK,MAAM;AACV,MAAIb,KACFqB,EAA2BrB,GAAeJ,CAAkB,EACzD,KAAK,CAACgC,MAAY;AACjB,QAAAzB,EAAY,IAAI,gCAAgC;AAAA,MAAA,CACjD,EACA,MAAM,CAAC0B,MAAW;AACT,gBAAA;AAAA,UACN;AAAA,UACAA;AAAA,QAAA;AAAA,MACF,CACD;AAAA,IACL,CACD,EACA,MAAM,CAACA,MAAW;AACT,cAAA;AAAA,QACN;AAAA,QACAA;AAAA,MAAA;AAAA,IACF,CACD;AAGL,UAAMC,IACJhD,EAAc,gCAAgC,CAACkC,MAAiB;AAClD,MAAAb,EAAA;AAAA,QACV;AAAA,MAAA,GAEFY,EAAyCC,GAAc,YAAY,GACnEX,EAA4BW,CAAY;AAAA,IAAA,CACzC,GAEGe,IACJjD,EAAc,wCAAwC,CAACkD,MAAa;AAClE,MAAA7B,EAAY,IAAI,oDAAoD,GACpEY;AAAA,QACEiB,EAAS;AAAA,QACT;AAAA,MAAA,GAEFzB,EAA0ByB,CAAQ;AAAA,IAAA,CACnC;AAEH,WAAO,MAAM;AACG,MAAAlD,EAAA;AAAA,QACZgD;AAAA,MAAA,GAEYhD,EAAA;AAAA,QACZiD;AAAA,MAAA;AAAA,IACF;AAAA,EACF,GAIC;AAAA,IACDlB;AAAA,IACAR;AAAA,IACAE;AAAA,IACAV;AAAA,IACAG;AAAA,IACAJ;AAAA,IACAO;AAAA,EAAA,CACD,GAGC,gBAAA8B;AAAA,IAAChD,EAAiC;AAAA,IAAjC;AAAA,MACC,OAAO;AAAA,QACL,eAAAe;AAAA,QACA,8BAAAa;AAAA,QACA,4BAAAQ;AAAA,QACA,gCAAAG;AAAA,QACA,wBAAwBf;AAAA,QACxB,sBAAsBG;AAAA,MACxB;AAAA,MAEC,UAAAd;AAAA,IAAA;AAAA,EAAA;AAGP,GAEaoC,IACX,MAA4C;AACpC,QAAAC,IAAUC,EAAWnD,CAAgC;AAC3D,MAAIkD,MAAY;AACd,UAAM,IAAI;AAAA,MACR;AAAA,IAAA;AAGG,SAAAA;AACT;"}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './modules/push';
+export * from '@knocklabs/react-native';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,yBAAyB,CAAC"}

package/dist/types/modules/push/KnockExpoPushNotificationProvider.d.ts

@@ -0,0 +1,19 @@
+import { default as React } from 'react';
+import * as Notifications from "expo-notifications";
+export interface KnockExpoPushNotificationContextType {
+    expoPushToken: string | null;
+    registerForPushNotifications: () => Promise<void>;
+    registerPushTokenToChannel(token: string, channelId: string): Promise<void>;
+    unregisterPushTokenFromChannel(token: string, channelId: string): Promise<void>;
+    onNotificationReceived: (handler: (notification: Notifications.Notification) => void) => void;
+    onNotificationTapped: (handler: (response: Notifications.NotificationResponse) => void) => void;
+}
+export interface KnockExpoPushNotificationProviderProps {
+    knockExpoChannelId: string;
+    customNotificationHandler?: (notification: Notifications.Notification) => Promise<Notifications.NotificationBehavior>;
+    children?: React.ReactElement;
+    autoRegister?: boolean;
+}
+export declare const KnockExpoPushNotificationProvider: React.FC<KnockExpoPushNotificationProviderProps>;
+export declare const useExpoPushNotifications: () => KnockExpoPushNotificationContextType;
+//# sourceMappingURL=KnockExpoPushNotificationProvider.d.ts.map

package/dist/types/modules/push/KnockExpoPushNotificationProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KnockExpoPushNotificationProvider.d.ts","sourceRoot":"","sources":["../../../../src/modules/push/KnockExpoPushNotificationProvider.tsx"],"names":[],"mappings":"AAQA,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAMN,MAAM,OAAO,CAAC;AAEf,MAAM,WAAW,oCAAoC;IACnD,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,4BAA4B,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD,0BAA0B,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5E,8BAA8B,CAC5B,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,sBAAsB,EAAE,CACtB,OAAO,EAAE,CAAC,YAAY,EAAE,aAAa,CAAC,YAAY,KAAK,IAAI,KACxD,IAAI,CAAC;IACV,oBAAoB,EAAE,CACpB,OAAO,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,oBAAoB,KAAK,IAAI,KAC5D,IAAI,CAAC;CACX;AA0BD,MAAM,WAAW,sCAAsC;IACrD,kBAAkB,EAAE,MAAM,CAAC;IAC3B,yBAAyB,CAAC,EAAE,CAC1B,YAAY,EAAE,aAAa,CAAC,YAAY,KACrC,OAAO,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;IACjD,QAAQ,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC;IAC9B,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAoDD,eAAO,MAAM,iCAAiC,EAAE,KAAK,CAAC,EAAE,CACtD,sCAAsC,CAkMvC,CAAC;AAEF,eAAO,MAAM,wBAAwB,QAC/B,oCAQH,CAAC"}

package/dist/types/modules/push/index.d.ts

@@ -0,0 +1,2 @@
+export * from './KnockExpoPushNotificationProvider';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/modules/push/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/modules/push/index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAC"}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@knocklabs/expo",
+  "version": "0.1.0",
+  "author": "@knocklabs",
+  "license": "MIT",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.mjs",
+  "types": "dist/types/index.d.ts",
+  "typings": "dist/types/index.d.ts",
+  "react-native": "./src/index.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts",
+      "react-native": "./src/index.ts",
+      "default": "./dist/esm/index.mjs"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
+  "scripts": {
+    "clean": "rimraf dist",
+    "dev": "tsc && vite build --watch",
+    "build": "yarn clean && yarn build:esm && yarn build:cjs",
+    "build:esm": "BUILD_TARGET=esm; tsc && vite build",
+    "build:cjs": "BUILD_TARGET=cjs; tsc && vite build",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "format": "prettier \"src/**/*.{js,ts,tsx}\" --write",
+    "format:check": "prettier \"src/**/*.{js,ts,tsx}\" --check",
+    "type:check": "tsc --noEmit",
+    "preview": "vite preview"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/knocklabs/javascript.git"
+  },
+  "bugs": {
+    "url": "https://github.com/knocklabs/javascript/issues"
+  },
+  "peerDependencies": {
+    "expo": "*",
+    "expo-constants": "*",
+    "expo-device": "*",
+    "expo-notifications": "*",
+    "react": "*",
+    "react-native": "*"
+  },
+  "dependencies": {
+    "@knocklabs/client": "^0.10.13",
+    "@knocklabs/react-core": "^0.2.25",
+    "@knocklabs/react-native": "^0.4.0",
+    "react-native-gesture-handler": "^2.19.0",
+    "react-native-render-html": "^6.3.4",
+    "react-native-svg": "^15.6.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.3.6",
+    "@types/react-native-htmlview": "^0.16.5",
+    "@typescript-eslint/eslint-plugin": "^6.20.0",
+    "@typescript-eslint/parser": "^8.8.1",
+    "@vitejs/plugin-react": "^4.3.2",
+    "eslint": "^8.56.0",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.4",
+    "expo": ">=51.0.24",
+    "expo-constants": ">=16.0.2",
+    "expo-device": ">=6.0.2",
+    "expo-notifications": ">=0.28.16",
+    "react": "^18.2.0",
+    "react-native": "^0.73.4",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.6.2",
+    "vite": "^5.0.0",
+    "vite-plugin-dts": "^3.6.3",
+    "vite-plugin-no-bundle": "^4.0.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./modules/push";
+export * from "@knocklabs/react-native";

package/src/modules/push/KnockExpoPushNotificationProvider.tsx

@@ -0,0 +1,323 @@
+import {
+  ChannelData,
+  Message,
+  MessageEngagementStatus,
+} from "@knocklabs/client";
+import { useKnockClient } from "@knocklabs/react-core";
+import Constants from "expo-constants";
+import * as Device from "expo-device";
+import * as Notifications from "expo-notifications";
+import React, {
+  createContext,
+  useCallback,
+  useContext,
+  useEffect,
+  useState,
+} from "react";
+
+export interface KnockExpoPushNotificationContextType {
+  expoPushToken: string | null;
+  registerForPushNotifications: () => Promise<void>;
+  registerPushTokenToChannel(token: string, channelId: string): Promise<void>;
+  unregisterPushTokenFromChannel(
+    token: string,
+    channelId: string,
+  ): Promise<void>;
+  onNotificationReceived: (
+    handler: (notification: Notifications.Notification) => void,
+  ) => void;
+  onNotificationTapped: (
+    handler: (response: Notifications.NotificationResponse) => void,
+  ) => void;
+}
+
+Notifications.setNotificationHandler({
+  handleNotification: async () => {
+    return {
+      shouldShowAlert: true,
+      shouldPlaySound: true,
+      shouldSetBadge: true,
+    };
+  },
+});
+
+const defaultNotificationHandler = async (
+  _notification: Notifications.Notification,
+): Promise<Notifications.NotificationBehavior> => {
+  return {
+    shouldShowAlert: true,
+    shouldPlaySound: true,
+    shouldSetBadge: true,
+  };
+};
+
+const KnockExpoPushNotificationContext = createContext<
+  KnockExpoPushNotificationContextType | undefined
+>(undefined);
+
+export interface KnockExpoPushNotificationProviderProps {
+  knockExpoChannelId: string;
+  customNotificationHandler?: (
+    notification: Notifications.Notification,
+  ) => Promise<Notifications.NotificationBehavior>;
+  children?: React.ReactElement;
+  autoRegister?: boolean;
+}
+
+async function requestPushPermissionIfNeeded(): Promise<string> {
+  const { status: existingStatus } = await Notifications.getPermissionsAsync();
+
+  if (existingStatus !== "granted") {
+    const { status } = await Notifications.requestPermissionsAsync();
+    return status;
+  }
+
+  return existingStatus;
+}
+
+async function getExpoPushToken(): Promise<Notifications.ExpoPushToken | null> {
+  try {
+    if (
+      !Constants.expoConfig ||
+      !Constants.expoConfig.extra ||
+      !Constants.expoConfig.extra.eas
+    ) {
+      console.error(
+        "[Knock] Expo Project ID is not defined in the app configuration.",
+      );
+      return null;
+    }
+    const token = await Notifications.getExpoPushTokenAsync({
+      projectId: Constants.expoConfig.extra.eas.projectId,
+    });
+    return token;
+  } catch (error) {
+    console.error("[Knock] Error getting Expo push token:", error);
+    return null;
+  }
+}
+
+async function requestPermissionAndGetPushToken(): Promise<Notifications.ExpoPushToken | null> {
+  // Check for device support
+  if (!Device.isDevice) {
+    console.warn("[Knock] Must use physical device for Push Notifications");
+    return null;
+  }
+
+  const permissionStatus = await requestPushPermissionIfNeeded();
+
+  if (permissionStatus !== "granted") {
+    console.warn("[Knock] Push notification permission not granted");
+    return null;
+  }
+
+  return getExpoPushToken();
+}
+
+export const KnockExpoPushNotificationProvider: React.FC<
+  KnockExpoPushNotificationProviderProps
+> = ({
+  knockExpoChannelId,
+  customNotificationHandler,
+  children,
+  autoRegister = true,
+}) => {
+  const [expoPushToken, setExpoPushToken] = useState<string | null>(null);
+  const knockClient = useKnockClient();
+
+  const [notificationReceivedHandler, setNotificationReceivedHandler] =
+    useState<(notification: Notifications.Notification) => void>(
+      () => () => {},
+    );
+
+  const [notificationTappedHandler, setNotificationTappedHandler] = useState<
+    (response: Notifications.NotificationResponse) => void
+  >(() => () => {});
+
+  const handleNotificationReceived = useCallback(
+    (handler: (notification: Notifications.Notification) => void) => {
+      setNotificationReceivedHandler(() => handler);
+    },
+    [],
+  );
+
+  const handleNotificationTapped = useCallback(
+    (handler: (response: Notifications.NotificationResponse) => void) => {
+      setNotificationTappedHandler(() => handler);
+    },
+    [],
+  );
+
+  const registerForPushNotifications = useCallback(async (): Promise<void> => {
+    try {
+      knockClient.log(`[Knock] Registering for push notifications`);
+      const token = await requestPermissionAndGetPushToken();
+      knockClient.log(`[Knock] Token received: ${token?.data}`);
+      if (token?.data) {
+        knockClient.log(`[Knock] Setting push token: ${token.data}`);
+        setExpoPushToken(token.data);
+      }
+    } catch (error) {
+      console.error(`[Knock] Error registering for push notifications:`, error);
+    }
+  }, [knockClient]);
+
+  const updateKnockMessageStatusFromNotification = useCallback(
+    async (
+      notification: Notifications.Notification,
+      status: MessageEngagementStatus,
+    ): Promise<Message> => {
+      const messageId = notification.request.content.data["knock_message_id"];
+      return knockClient.messages.updateStatus(messageId, status);
+    },
+    [knockClient],
+  );
+
+  const registerNewTokenDataOnServer = useCallback(
+    async (tokens: string[], channelId: string): Promise<ChannelData> => {
+      return knockClient.user.setChannelData({
+        channelId: channelId,
+        channelData: { tokens: tokens },
+      });
+    },
+    [knockClient],
+  );
+
+  const registerPushTokenToChannel = useCallback(
+    async (token: string, channelId: string): Promise<void> => {
+      knockClient.user
+        .getChannelData({ channelId: channelId })
+        .then((result: ChannelData) => {
+          const tokens: string[] = result.data["tokens"];
+          if (!tokens.includes(token)) {
+            tokens.push(token);
+            return registerNewTokenDataOnServer(tokens, channelId);
+          }
+          knockClient.log("[Knock] registerPushTokenToChannel success");
+        })
+        .catch((_) => {
+          // No data registered on that channel for that user, we'll create a new record
+          return registerNewTokenDataOnServer([token], channelId);
+        });
+    },
+    [knockClient, registerNewTokenDataOnServer],
+  );
+
+  const unregisterPushTokenFromChannel = useCallback(
+    async (token: string, channelId: string): Promise<void> => {
+      knockClient.user
+        .getChannelData({ channelId: channelId })
+        .then((result: ChannelData) => {
+          const tokens: string[] = result.data["tokens"];
+          const updatedTokens = tokens.filter(
+            (channelToken) => channelToken !== token,
+          );
+          knockClient.log("unregisterPushTokenFromChannel success");
+          return registerNewTokenDataOnServer(updatedTokens, channelId);
+        })
+        .catch((error) => {
+          console.error(
+            `[Knock] Error unregistering push token from channel:`,
+            error,
+          );
+        });
+    },
+    [knockClient, registerNewTokenDataOnServer],
+  );
+
+  useEffect(() => {
+    Notifications.setNotificationHandler({
+      handleNotification:
+        customNotificationHandler ?? defaultNotificationHandler,
+    });
+
+    if (autoRegister) {
+      registerForPushNotifications()
+        .then(() => {
+          if (expoPushToken) {
+            registerPushTokenToChannel(expoPushToken, knockExpoChannelId)
+              .then((_result) => {
+                knockClient.log("[Knock] setChannelData success");
+              })
+              .catch((_error) => {
+                console.error(
+                  "[Knock] Error in setting push token or channel data",
+                  _error,
+                );
+              });
+          }
+        })
+        .catch((_error) => {
+          console.error(
+            "[Knock] Error in setting push token or channel data",
+            _error,
+          );
+        });
+    }
+
+    const notificationReceivedSubscription =
+      Notifications.addNotificationReceivedListener((notification) => {
+        knockClient.log(
+          "[Knock] Expo Push Notification received in foreground:",
+        );
+        updateKnockMessageStatusFromNotification(notification, "interacted");
+        notificationReceivedHandler(notification);
+      });
+
+    const notificationResponseSubscription =
+      Notifications.addNotificationResponseReceivedListener((response) => {
+        knockClient.log("[Knock] Expo Push Notification was interacted with");
+        updateKnockMessageStatusFromNotification(
+          response.notification,
+          "interacted",
+        );
+        notificationTappedHandler(response);
+      });
+
+    return () => {
+      Notifications.removeNotificationSubscription(
+        notificationReceivedSubscription,
+      );
+      Notifications.removeNotificationSubscription(
+        notificationResponseSubscription,
+      );
+    };
+
+    // TODO: Remove when possible and ensure dependency array is correct
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [
+    registerForPushNotifications,
+    notificationReceivedHandler,
+    notificationTappedHandler,
+    customNotificationHandler,
+    expoPushToken,
+    knockExpoChannelId,
+    knockClient,
+  ]);
+
+  return (
+    <KnockExpoPushNotificationContext.Provider
+      value={{
+        expoPushToken,
+        registerForPushNotifications,
+        registerPushTokenToChannel,
+        unregisterPushTokenFromChannel,
+        onNotificationReceived: handleNotificationReceived,
+        onNotificationTapped: handleNotificationTapped,
+      }}
+    >
+      {children}
+    </KnockExpoPushNotificationContext.Provider>
+  );
+};
+
+export const useExpoPushNotifications =
+  (): KnockExpoPushNotificationContextType => {
+    const context = useContext(KnockExpoPushNotificationContext);
+    if (context === undefined) {
+      throw new Error(
+        "[Knock] useExpoPushNotifications must be used within a PushNotificationProvider",
+      );
+    }
+    return context;
+  };

package/src/modules/push/index.ts

@@ -0,0 +1 @@
+export * from "./KnockExpoPushNotificationProvider";