@bodhveda/react 0.0.3 → 0.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mudgal Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1 +1,80 @@
-# React SDK for Bodhveda
+# @bodhveda/react
+
+Official React SDK for Bodhveda.
+
+It extends the core `bodhveda` SDK with React hooks making it easy to build custom notification experiences.
+
+## Installation
+
+```bash
+npm install @bodhveda/react @tanstack/react-query
+```
+
+## Usage
+
+Wrap your app with the `BodhvedaProvider`:
+
+```tsx
+import { BodhvedaProvider } from "@bodhveda/react";
+
+<BodhvedaProvider apiKey="your-api-key" recipientID="user-123">
+    <App />
+</BodhvedaProvider>;
+```
+
+Or provide an existing Bodhveda client:
+
+```tsx
+import { Bodhveda } from "bodhveda";
+import { BodhvedaProvider } from "@bodhveda/react";
+
+const client = new Bodhveda("your-api-key");
+
+<BodhvedaProvider bodhveda={client} recipientID="user-123">
+    <App />
+</BodhvedaProvider>;
+```
+
+## Hooks
+
+All hooks must be used within a `BodhvedaProvider`.
+
+### `useBodhveda()`
+
+Returns the Bodhveda client instance.
+
+### `useRecipientID()`
+
+Returns the current recipient ID.
+
+### `useNotifications(options?)`
+
+Fetches the list of notifications for the current recipient.
+
+### `useNotificationsUnreadCount(options?)`
+
+Fetches the unread notifications count for the current recipient.
+
+### `useUpdateNotificationsState(options?)`
+
+Returns a mutation hook to update notification state (e.g., mark as read).
+
+### `useDeleteNotifications(options?)`
+
+Returns a mutation hook to delete notifications for the current recipient.
+
+### `usePreferences(options?)`
+
+Fetches the notification preferences for the current recipient.
+
+### `useUpdatePreference(options?)`
+
+Returns a mutation hook to update a notification preference.
+
+### `useCheckPreference(target, options?)`
+
+Checks a specific notification preference for the current recipient.
+
+## License
+
+MIT

package/dist/hooks.d.ts

@@ -2,16 +2,71 @@ import { AnyUseMutationOptions, AnyUseQueryOptions, UseQueryResult } from "@tans
 import { ListNotificationsResponse, ListPreferencesResponse, UpdateNotificationsStateRequest, UpdateNotificationsStateResponse, SetPreferenceRequest, SetPreferenceResponse, DeleteNotificationsResponse, DeleteNotificationsRequest, Target, CheckPreferenceResponse } from "bodhveda";
 type QueryOptions = Omit<AnyUseQueryOptions, "queryKey">;
 type MutationOptions = AnyUseMutationOptions;
+/**
+ * Returns the Bodhveda client instance.
+ *
+ * @throws If used outside a {@link BodhvedaProvider}.
+ * @returns {Bodhveda} The Bodhveda client instance.
+ */
 export declare function useBodhveda(): import("bodhveda").Bodhveda;
+/**
+ * Returns the current recipient ID.
+ *
+ * @throws If used outside a {@link BodhvedaProvider}.
+ * @returns {string} The recipient ID.
+ */
 export declare function useRecipientID(): string;
+/**
+ * Fetches the list of notifications for the current recipient.
+ *
+ * @param options - Optional react-query options.
+ * @returns {UseQueryResult<ListNotificationsResponse>} Query result.
+ */
 export declare function useNotifications(options?: QueryOptions): UseQueryResult<ListNotificationsResponse>;
+/**
+ * Fetches the unread notifications count for the current recipient.
+ *
+ * @param options - Optional react-query options.
+ * @returns {UseQueryResult<{ unread_count: number }>} Query result.
+ */
 export declare function useNotificationsUnreadCount(options?: QueryOptions): UseQueryResult<{
     unread_count: number;
 }>;
+/**
+ * Returns a mutation hook to update notification state (e.g., mark as read).
+ *
+ * @param options - Optional mutation options.
+ * @returns Mutation hook.
+ */
 export declare function useUpdateNotificationsState(options?: MutationOptions): import("@tanstack/react-query").UseMutationResult<UpdateNotificationsStateResponse, unknown, UpdateNotificationsStateRequest, unknown>;
+/**
+ * Returns a mutation hook to delete notifications for the current recipient.
+ *
+ * @param options - Optional mutation options.
+ * @returns Mutation hook.
+ */
 export declare function useDeleteNotifications(options?: MutationOptions): import("@tanstack/react-query").UseMutationResult<DeleteNotificationsResponse, unknown, DeleteNotificationsRequest, unknown>;
+/**
+ * Fetches the notification preferences for the current recipient.
+ *
+ * @param options - Optional react-query options.
+ * @returns {UseQueryResult<ListPreferencesResponse>} Query result.
+ */
 export declare function usePreferences(options?: QueryOptions): UseQueryResult<ListPreferencesResponse>;
+/**
+ * Returns a mutation hook to update a notification preference for the current recipient.
+ *
+ * @param options - Optional mutation options.
+ * @returns Mutation hook.
+ */
 export declare function useUpdatePreference(options?: MutationOptions): import("@tanstack/react-query").UseMutationResult<SetPreferenceResponse, unknown, SetPreferenceRequest, unknown>;
+/**
+ * Checks a specific notification preference for the current recipient.
+ *
+ * @param target - The notification target/channel to check.
+ * @param options - Optional react-query options.
+ * @returns {UseQueryResult<CheckPreferenceResponse>} Query result.
+ */
 export declare function useCheckPreference(target: Target, options?: QueryOptions): UseQueryResult<CheckPreferenceResponse>;
 export {};
 //# sourceMappingURL=hooks.d.ts.map

package/dist/hooks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../src/hooks.tsx"],"names":[],"mappings":"AACA,OAAO,EACH,qBAAqB,EACrB,kBAAkB,EAIlB,cAAc,EACjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACH,yBAAyB,EACzB,uBAAuB,EACvB,+BAA+B,EAC/B,gCAAgC,EAChC,oBAAoB,EACpB,qBAAqB,EACrB,2BAA2B,EAC3B,0BAA0B,EAC1B,MAAM,EACN,uBAAuB,EAC1B,MAAM,UAAU,CAAC;AAIlB,KAAK,YAAY,GAAG,IAAI,CAAC,kBAAkB,EAAE,UAAU,CAAC,CAAC;AACzD,KAAK,eAAe,GAAG,qBAAqB,CAAC;AAS7C,wBAAgB,WAAW,gCAQ1B;AAED,wBAAgB,cAAc,WAQ7B;AAED,wBAAgB,gBAAgB,CAC5B,OAAO,GAAE,YAAiB,GAC3B,cAAc,CAAC,yBAAyB,CAAC,CAS3C;AAED,wBAAgB,2BAA2B,CACvC,OAAO,GAAE,YAAiB,GAC3B,cAAc,CAAC;IAAE,YAAY,EAAE,MAAM,CAAA;CAAE,CAAC,CAU1C;AAED,wBAAgB,2BAA2B,CAAC,OAAO,GAAE,eAAoB,0IA6BxE;AAED,wBAAgB,sBAAsB,CAAC,OAAO,GAAE,eAAoB,gIA0BnE;AAED,wBAAgB,cAAc,CAC1B,OAAO,GAAE,YAAiB,GAC3B,cAAc,CAAC,uBAAuB,CAAC,CASzC;AAED,wBAAgB,mBAAmB,CAAC,OAAO,GAAE,eAAoB,oHA0BhE;AAED,wBAAgB,kBAAkB,CAC9B,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,YAAiB,GAC3B,cAAc,CAAC,uBAAuB,CAAC,CAUzC"}
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../src/hooks.tsx"],"names":[],"mappings":"AACA,OAAO,EACH,qBAAqB,EACrB,kBAAkB,EAIlB,cAAc,EACjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACH,yBAAyB,EACzB,uBAAuB,EACvB,+BAA+B,EAC/B,gCAAgC,EAChC,oBAAoB,EACpB,qBAAqB,EACrB,2BAA2B,EAC3B,0BAA0B,EAC1B,MAAM,EACN,uBAAuB,EAC1B,MAAM,UAAU,CAAC;AAIlB,KAAK,YAAY,GAAG,IAAI,CAAC,kBAAkB,EAAE,UAAU,CAAC,CAAC;AACzD,KAAK,eAAe,GAAG,qBAAqB,CAAC;AAS7C;;;;;GAKG;AACH,wBAAgB,WAAW,gCAQ1B;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,WAQ7B;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC5B,OAAO,GAAE,YAAiB,GAC3B,cAAc,CAAC,yBAAyB,CAAC,CAS3C;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACvC,OAAO,GAAE,YAAiB,GAC3B,cAAc,CAAC;IAAE,YAAY,EAAE,MAAM,CAAA;CAAE,CAAC,CAU1C;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,GAAE,eAAoB,0IA6BxE;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,GAAE,eAAoB,gIA0BnE;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC1B,OAAO,GAAE,YAAiB,GAC3B,cAAc,CAAC,uBAAuB,CAAC,CASzC;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,GAAE,eAAoB,oHA0BhE;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAC9B,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,YAAiB,GAC3B,cAAc,CAAC,uBAAuB,CAAC,CAUzC"}

package/dist/hooks.js

@@ -7,6 +7,12 @@ const QUERY_KEYS = {
     useCheckPreference: ["useCheckPreference"],
     usePreferences: ["usePreferences"],
 };
+/**
+ * Returns the Bodhveda client instance.
+ *
+ * @throws If used outside a {@link BodhvedaProvider}.
+ * @returns {Bodhveda} The Bodhveda client instance.
+ */
 export function useBodhveda() {
     const context = useContext(BodhvedaContext);
     if (!context) {
@@ -14,6 +20,12 @@ export function useBodhveda() {
     }
     return context.bodhveda;
 }
+/**
+ * Returns the current recipient ID.
+ *
+ * @throws If used outside a {@link BodhvedaProvider}.
+ * @returns {string} The recipient ID.
+ */
 export function useRecipientID() {
     const context = useContext(BodhvedaContext);
     if (!context) {
@@ -21,6 +33,12 @@ export function useRecipientID() {
     }
     return context.recipientID;
 }
+/**
+ * Fetches the list of notifications for the current recipient.
+ *
+ * @param options - Optional react-query options.
+ * @returns {UseQueryResult<ListNotificationsResponse>} Query result.
+ */
 export function useNotifications(options = {}) {
     const bodhveda = useBodhveda();
     const recipientID = useRecipientID();
@@ -30,6 +48,12 @@ export function useNotifications(options = {}) {
         ...options,
     });
 }
+/**
+ * Fetches the unread notifications count for the current recipient.
+ *
+ * @param options - Optional react-query options.
+ * @returns {UseQueryResult<{ unread_count: number }>} Query result.
+ */
 export function useNotificationsUnreadCount(options = {}) {
     const bodhveda = useBodhveda();
     const recipientID = useRecipientID();
@@ -39,6 +63,12 @@ export function useNotificationsUnreadCount(options = {}) {
         ...options,
     });
 }
+/**
+ * Returns a mutation hook to update notification state (e.g., mark as read).
+ *
+ * @param options - Optional mutation options.
+ * @returns Mutation hook.
+ */
 export function useUpdateNotificationsState(options = {}) {
     const bodhveda = useBodhveda();
     const recipientID = useRecipientID();
@@ -60,6 +90,12 @@ export function useUpdateNotificationsState(options = {}) {
         ...rest,
     });
 }
+/**
+ * Returns a mutation hook to delete notifications for the current recipient.
+ *
+ * @param options - Optional mutation options.
+ * @returns Mutation hook.
+ */
 export function useDeleteNotifications(options = {}) {
     const bodhveda = useBodhveda();
     const recipientID = useRecipientID();
@@ -81,6 +117,12 @@ export function useDeleteNotifications(options = {}) {
         ...rest,
     });
 }
+/**
+ * Fetches the notification preferences for the current recipient.
+ *
+ * @param options - Optional react-query options.
+ * @returns {UseQueryResult<ListPreferencesResponse>} Query result.
+ */
 export function usePreferences(options = {}) {
     const bodhveda = useBodhveda();
     const recipientID = useRecipientID();
@@ -90,6 +132,12 @@ export function usePreferences(options = {}) {
         ...options,
     });
 }
+/**
+ * Returns a mutation hook to update a notification preference for the current recipient.
+ *
+ * @param options - Optional mutation options.
+ * @returns Mutation hook.
+ */
 export function useUpdatePreference(options = {}) {
     const bodhveda = useBodhveda();
     const recipientID = useRecipientID();
@@ -111,6 +159,13 @@ export function useUpdatePreference(options = {}) {
         ...rest,
     });
 }
+/**
+ * Checks a specific notification preference for the current recipient.
+ *
+ * @param target - The notification target/channel to check.
+ * @param options - Optional react-query options.
+ * @returns {UseQueryResult<CheckPreferenceResponse>} Query result.
+ */
 export function useCheckPreference(target, options = {}) {
     const bodhveda = useBodhveda();
     const recipientID = useRecipientID();

package/dist/hooks.js.map

@@ -1 +1 @@
-{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../src/hooks.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACnC,OAAO,EAGH,WAAW,EACX,QAAQ,EACR,cAAc,GAEjB,MAAM,uBAAuB,CAAC;AAc/B,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAK5C,MAAM,UAAU,GAAG;IACf,gBAAgB,EAAE,CAAC,kBAAkB,CAAC;IACtC,2BAA2B,EAAE,CAAC,6BAA6B,CAAC;IAC5D,kBAAkB,EAAE,CAAC,oBAAoB,CAAC;IAC1C,cAAc,EAAE,CAAC,gBAAgB,CAAC;CACrC,CAAC;AAEF,MAAM,UAAU,WAAW;IACvB,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;IAE5C,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IAC5E,CAAC;IAED,OAAO,OAAO,CAAC,QAAQ,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,cAAc;IAC1B,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;IAE5C,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IAC5E,CAAC;IAED,OAAO,OAAO,CAAC,WAAW,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC5B,UAAwB,EAAE;IAE1B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IAErC,OAAO,QAAQ,CAAC;QACZ,QAAQ,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC;QACvC,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC;QAClE,GAAG,OAAO;KACb,CAAC,CAAC;AACP,CAAC;AAED,MAAM,UAAU,2BAA2B,CACvC,UAAwB,EAAE;IAE1B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IAErC,OAAO,QAAQ,CAAC;QACZ,QAAQ,EAAE,CAAC,UAAU,CAAC,2BAA2B,CAAC;QAClD,OAAO,EAAE,GAAG,EAAE,CACV,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC;QAC9D,GAAG,OAAO;KACb,CAAC,CAAC;AACP,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,UAA2B,EAAE;IACrE,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IAEvC,OAAO,WAAW,CAKhB;QACE,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE;YAChB,OAAO,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,WAAW,CAChD,WAAW,EACX,GAAG,CACN,CAAC;QACN,CAAC;QACD,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACnB,WAAW,CAAC,iBAAiB,CAAC;gBAC1B,QAAQ,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC;aAC1C,CAAC,CAAC;YACH,WAAW,CAAC,iBAAiB,CAAC;gBAC1B,QAAQ,EAAE,CAAC,UAAU,CAAC,2BAA2B,CAAC;aACrD,CAAC,CAAC;YACH,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAG,GAAG,IAAI,CAAC,CAAC;QACzB,CAAC;QACD,GAAG,IAAI;KACV,CAAC,CAAC;AACP,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,UAA2B,EAAE;IAChE,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IAEvC,OAAO,WAAW,CAKhB;QACE,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE;YAChB,OAAO,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QACtE,CAAC;QACD,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACnB,WAAW,CAAC,iBAAiB,CAAC;gBAC1B,QAAQ,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC;aAC1C,CAAC,CAAC;YACH,WAAW,CAAC,iBAAiB,CAAC;gBAC1B,QAAQ,EAAE,CAAC,UAAU,CAAC,2BAA2B,CAAC;aACrD,CAAC,CAAC;YACH,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAG,GAAG,IAAI,CAAC,CAAC;QACzB,CAAC;QACD,GAAG,IAAI;KACV,CAAC,CAAC;AACP,CAAC;AAED,MAAM,UAAU,cAAc,CAC1B,UAAwB,EAAE;IAE1B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IAErC,OAAO,QAAQ,CAAC;QACZ,QAAQ,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC;QACrC,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC;QAChE,GAAG,OAAO;KACb,CAAC,CAAC;AACP,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,UAA2B,EAAE;IAC7D,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IAEvC,OAAO,WAAW,CAKhB;QACE,UAAU,EAAE,CAAC,GAAyB,EAAE,EAAE;YACtC,OAAO,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QACjE,CAAC;QACD,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACnB,WAAW,CAAC,iBAAiB,CAAC;gBAC1B,QAAQ,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC;aACxC,CAAC,CAAC;YACH,WAAW,CAAC,iBAAiB,CAAC;gBAC1B,QAAQ,EAAE,CAAC,UAAU,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;aAC5D,CAAC,CAAC;YACH,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAG,GAAG,IAAI,CAAC,CAAC;QACzB,CAAC;QACD,GAAG,IAAI;KACV,CAAC,CAAC;AACP,CAAC;AAED,MAAM,UAAU,kBAAkB,CAC9B,MAAc,EACd,UAAwB,EAAE;IAE1B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IAErC,OAAO,QAAQ,CAAC;QACZ,QAAQ,EAAE,CAAC,UAAU,CAAC,kBAAkB,EAAE,MAAM,CAAC;QACjD,OAAO,EAAE,GAAG,EAAE,CACV,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,MAAM,EAAE,CAAC;QAClE,GAAG,OAAO;KACb,CAAC,CAAC;AACP,CAAC"}
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../src/hooks.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACnC,OAAO,EAGH,WAAW,EACX,QAAQ,EACR,cAAc,GAEjB,MAAM,uBAAuB,CAAC;AAc/B,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAK5C,MAAM,UAAU,GAAG;IACf,gBAAgB,EAAE,CAAC,kBAAkB,CAAC;IACtC,2BAA2B,EAAE,CAAC,6BAA6B,CAAC;IAC5D,kBAAkB,EAAE,CAAC,oBAAoB,CAAC;IAC1C,cAAc,EAAE,CAAC,gBAAgB,CAAC;CACrC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,WAAW;IACvB,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;IAE5C,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IAC5E,CAAC;IAED,OAAO,OAAO,CAAC,QAAQ,CAAC;AAC5B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc;IAC1B,MAAM,OAAO,GAAG,UAAU,CAAC,eAAe,CAAC,CAAC;IAE5C,IAAI,CAAC,OAAO,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IAC5E,CAAC;IAED,OAAO,OAAO,CAAC,WAAW,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAC5B,UAAwB,EAAE;IAE1B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IAErC,OAAO,QAAQ,CAAC;QACZ,QAAQ,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC;QACvC,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC;QAClE,GAAG,OAAO;KACb,CAAC,CAAC;AACP,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACvC,UAAwB,EAAE;IAE1B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IAErC,OAAO,QAAQ,CAAC;QACZ,QAAQ,EAAE,CAAC,UAAU,CAAC,2BAA2B,CAAC;QAClD,OAAO,EAAE,GAAG,EAAE,CACV,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC;QAC9D,GAAG,OAAO;KACb,CAAC,CAAC;AACP,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CAAC,UAA2B,EAAE;IACrE,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IAEvC,OAAO,WAAW,CAKhB;QACE,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE;YAChB,OAAO,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,WAAW,CAChD,WAAW,EACX,GAAG,CACN,CAAC;QACN,CAAC;QACD,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACnB,WAAW,CAAC,iBAAiB,CAAC;gBAC1B,QAAQ,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC;aAC1C,CAAC,CAAC;YACH,WAAW,CAAC,iBAAiB,CAAC;gBAC1B,QAAQ,EAAE,CAAC,UAAU,CAAC,2BAA2B,CAAC;aACrD,CAAC,CAAC;YACH,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAG,GAAG,IAAI,CAAC,CAAC;QACzB,CAAC;QACD,GAAG,IAAI;KACV,CAAC,CAAC;AACP,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,UAA2B,EAAE;IAChE,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IAEvC,OAAO,WAAW,CAKhB;QACE,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE;YAChB,OAAO,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QACtE,CAAC;QACD,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACnB,WAAW,CAAC,iBAAiB,CAAC;gBAC1B,QAAQ,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC;aAC1C,CAAC,CAAC;YACH,WAAW,CAAC,iBAAiB,CAAC;gBAC1B,QAAQ,EAAE,CAAC,UAAU,CAAC,2BAA2B,CAAC;aACrD,CAAC,CAAC;YACH,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAG,GAAG,IAAI,CAAC,CAAC;QACzB,CAAC;QACD,GAAG,IAAI;KACV,CAAC,CAAC;AACP,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAC1B,UAAwB,EAAE;IAE1B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IAErC,OAAO,QAAQ,CAAC;QACZ,QAAQ,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC;QACrC,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC;QAChE,GAAG,OAAO;KACb,CAAC,CAAC;AACP,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,UAA2B,EAAE;IAC7D,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IAEvC,OAAO,WAAW,CAKhB;QACE,UAAU,EAAE,CAAC,GAAyB,EAAE,EAAE;YACtC,OAAO,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QACjE,CAAC;QACD,SAAS,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE;YACnB,WAAW,CAAC,iBAAiB,CAAC;gBAC1B,QAAQ,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC;aACxC,CAAC,CAAC;YACH,WAAW,CAAC,iBAAiB,CAAC;gBAC1B,QAAQ,EAAE,CAAC,UAAU,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;aAC5D,CAAC,CAAC;YACH,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAG,GAAG,IAAI,CAAC,CAAC;QACzB,CAAC;QACD,GAAG,IAAI;KACV,CAAC,CAAC;AACP,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAC9B,MAAc,EACd,UAAwB,EAAE;IAE1B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAC/B,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IAErC,OAAO,QAAQ,CAAC;QACZ,QAAQ,EAAE,CAAC,UAAU,CAAC,kBAAkB,EAAE,MAAM,CAAC;QACjD,OAAO,EAAE,GAAG,EAAE,CACV,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,MAAM,EAAE,CAAC;QAClE,GAAG,OAAO;KACb,CAAC,CAAC;AACP,CAAC"}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export * from "./provider";
 export * from "./hooks";
-export type * from "bodhveda";
+export * from "bodhveda";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AAGxB,mBAAmB,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AAGxB,cAAc,UAAU,CAAC"}

package/dist/index.js

@@ -1,3 +1,5 @@
 export * from "./provider";
 export * from "./hooks";
+// Export Bodhveda class and types from core package for convenience.
+export * from "bodhveda";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AAExB,qEAAqE;AACrE,cAAc,UAAU,CAAC"}

package/dist/provider.d.ts

@@ -1,16 +1,65 @@
 import { Bodhveda } from "bodhveda";
+/**
+ * Props for {@link BodhvedaProvider}.
+ *
+ * You must provide `recipientID` along with either a `bodhveda` client instance, or an `apiKey` (with optional `options`).
+ *
+ * @example
+ * ```tsx
+ * <BodhvedaProvider bodhveda={bodhvedaClient} recipientID="user-123">
+ *   <App />
+ * </BodhvedaProvider>
+ * ```
+ *
+ * @example
+ * ```tsx
+ * <BodhvedaProvider apiKey="your-api-key" recipientID="user-123">
+ *   <App />
+ * </BodhvedaProvider>
+ * ```
+ */
 type BodhvedaProviderProps = {
+    /**
+     * An existing Bodhveda client instance.
+     */
     bodhveda: Bodhveda;
+    /**
+     * The recipient's ID.
+     */
     recipientID: string;
+    /**
+     * React children.
+     */
     children: React.ReactNode;
 } | {
+    /**
+     * API key for Bodhveda.
+     */
     apiKey: string;
+    /**
+     * The recipient's ID.
+     */
     recipientID: string;
+    /**
+     * Optional configuration.
+     */
     options?: {
+        /**
+         * Override the API URL.
+         */
         apiURL?: string;
     };
+    /**
+     * React children.
+     */
     children: React.ReactNode;
 };
+/**
+ * Use this at the root of your React app to be able to use the hooks provided.
+ *
+ * @param props - {@link BodhvedaProviderProps}
+ * @returns React provider component.
+ */
 export declare function BodhvedaProvider(props: BodhvedaProviderProps): import("react/jsx-runtime").JSX.Element;
 export {};
 //# sourceMappingURL=provider.d.ts.map

package/dist/provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAIpC,KAAK,qBAAqB,GACpB;IACI,QAAQ,EAAE,QAAQ,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC7B,GACD;IACI,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE;QACN,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC7B,CAAC;AAER,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,2CAsC5D"}
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../src/provider.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAIpC;;;;;;;;;;;;;;;;;;GAkBG;AACH,KAAK,qBAAqB,GACpB;IACI;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC7B,GACD;IACI;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE;QACN;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC7B,CAAC;AAER;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,2CAsC5D"}

package/dist/provider.js

@@ -2,6 +2,12 @@ import { jsx as _jsx } from "react/jsx-runtime";
 import { useMemo } from "react";
 import { Bodhveda } from "bodhveda";
 import { BodhvedaContext } from "./context";
+/**
+ * Use this at the root of your React app to be able to use the hooks provided.
+ *
+ * @param props - {@link BodhvedaProviderProps}
+ * @returns React provider component.
+ */
 export function BodhvedaProvider(props) {
     const hasClient = "bodhveda" in props;
     const hasApiKey = "apiKey" in props;

package/dist/provider.js.map

@@ -1 +1 @@
-{"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAiB5C,MAAM,UAAU,gBAAgB,CAAC,KAA4B;IACzD,MAAM,SAAS,GAAG,UAAU,IAAI,KAAK,CAAC;IACtC,MAAM,SAAS,GAAG,QAAQ,IAAI,KAAK,CAAC;IACpC,MAAM,UAAU,GAAG,SAAS,IAAI,KAAK,CAAC;IAEtC,IAAI,SAAS,IAAI,CAAC,SAAS,IAAI,UAAU,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,KAAK,CACX,8EAA8E,CACjF,CAAC;IACN,CAAC;IAED,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CACX,4EAA4E,CAC/E,CAAC;IACN,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE;;QAC1B,IAAI,UAAU,IAAI,KAAK,EAAE,CAAC;YACtB,OAAO,KAAK,CAAC,QAAQ,CAAC;QAC1B,CAAC;QAED,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE;YAC9B,MAAM,EAAE,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM;SAChC,CAAC,CAAC;IACP,CAAC,EAAE;QACC,iEAAiE;QACjE,UAAU,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM;QACnD,UAAU,IAAI,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO;KAClD,CAAC,CAAC;IAEH,OAAO,CACH,KAAC,eAAe,CAAC,QAAQ,IACrB,KAAK,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,YAElD,KAAK,CAAC,QAAQ,GACQ,CAC9B,CAAC;AACN,CAAC"}
+{"version":3,"file":"provider.js","sourceRoot":"","sources":["../src/provider.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AA4D5C;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAA4B;IACzD,MAAM,SAAS,GAAG,UAAU,IAAI,KAAK,CAAC;IACtC,MAAM,SAAS,GAAG,QAAQ,IAAI,KAAK,CAAC;IACpC,MAAM,UAAU,GAAG,SAAS,IAAI,KAAK,CAAC;IAEtC,IAAI,SAAS,IAAI,CAAC,SAAS,IAAI,UAAU,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,KAAK,CACX,8EAA8E,CACjF,CAAC;IACN,CAAC;IAED,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CACX,4EAA4E,CAC/E,CAAC;IACN,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE;;QAC1B,IAAI,UAAU,IAAI,KAAK,EAAE,CAAC;YACtB,OAAO,KAAK,CAAC,QAAQ,CAAC;QAC1B,CAAC;QAED,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE;YAC9B,MAAM,EAAE,MAAA,KAAK,CAAC,OAAO,0CAAE,MAAM;SAChC,CAAC,CAAC;IACP,CAAC,EAAE;QACC,iEAAiE;QACjE,UAAU,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM;QACnD,UAAU,IAAI,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO;KAClD,CAAC,CAAC;IAEH,OAAO,CACH,KAAC,eAAe,CAAC,QAAQ,IACrB,KAAK,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,YAElD,KAAK,CAAC,QAAQ,GACQ,CAC9B,CAAC;AACN,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@bodhveda/react",
-    "version": "0.0.3",
+    "version": "0.0.4",
     "description": "React SDK for Bodhveda",
     "license": "MIT",
     "repository": {
@@ -50,6 +50,6 @@
         "typescript": "^5.9.2"
     },
     "dependencies": {
-        "bodhveda": "^0.0.3"
+        "bodhveda": "^0.0.4"
     }
 }