@echoxyz/sonar-react 0.12.2 → 0.13.1

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @echoxyz/sonar-react
 
+## 0.13.1
+
+### Patch Changes
+
+- Updated dependencies [7101949]
+    - @echoxyz/sonar-core@0.14.1
+
+## 0.13.0
+
+### Minor Changes
+
+- Add wrapper function and hook for ReadCommitmentData endpoint
+
+### Patch Changes
+
+- Updated dependencies
+    - @echoxyz/sonar-core@0.14.0
+
 ## 0.12.2
 
 ### Patch Changes

package/README.md

@@ -231,6 +231,12 @@ function PurchaseButton({
 
 - `useSonarEntities()` → `{ authenticated, loading, entities?, error? }` high-level hook for fetching all entities available to the authenticated user.
 
+- `useSonarPurchase()` → `{ loading, readyToPurchase, error?, generatePurchasePermit() }` high-level hook to check if the user is ready to purchase and generate a purchase permit.
+
+- `useEntityInvestmentHistory()` → `{ loading, investmentHistory?, error? }` high-level hook to fetch Echo private group investment history for a given entity.
+
+- `useCommitmentData()` → `{ loading, commitmentData?, error? }` high-level hook to poll for commitment data for a given sale. Note this calls a public API endpoint so the client does not need to be authenticated.
+
 ## Notes
 
 - Tokens are not auto-refreshed. On expiry, call `logout()` and re-run the OAuth flow.

package/dist/index.cjs

@@ -21,6 +21,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   SonarProvider: () => SonarProvider,
+  useCommitmentData: () => useCommitmentData,
   useEntityInvestmentHistory: () => useEntityInvestmentHistory,
   useSonarAuth: () => useSonarAuth,
   useSonarClient: () => useSonarClient,
@@ -406,9 +407,49 @@ function useEntityInvestmentHistory() {
     error: state.error
   };
 }
+var MIN_POLLING_INTERVAL_MS = 1e3;
+function useCommitmentData(args) {
+  const saleUUID = args.saleUUID;
+  const pollingIntervalMs = args.pollingIntervalMs;
+  if (pollingIntervalMs !== void 0 && pollingIntervalMs < MIN_POLLING_INTERVAL_MS) {
+    throw new Error(`pollingIntervalMs must be at least ${MIN_POLLING_INTERVAL_MS}ms`);
+  }
+  const client = useSonarClient();
+  const [state, setState] = (0, import_react2.useState)({
+    loading: false
+  });
+  const refetch = (0, import_react2.useCallback)(async () => {
+    setState((s) => ({ ...s, loading: true }));
+    try {
+      const resp = await client.readCommitmentData({ saleUUID });
+      setState({
+        loading: false,
+        commitmentData: resp,
+        error: void 0
+      });
+    } catch (err) {
+      const error = err instanceof Error ? err : new Error(String(err));
+      setState({ loading: false, commitmentData: void 0, error });
+    }
+  }, [client, saleUUID]);
+  (0, import_react2.useEffect)(() => {
+    refetch();
+    if (pollingIntervalMs === void 0) {
+      return;
+    }
+    const intervalId = setInterval(() => {
+      refetch();
+    }, pollingIntervalMs);
+    return () => {
+      clearInterval(intervalId);
+    };
+  }, [refetch, pollingIntervalMs]);
+  return state;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   SonarProvider,
+  useCommitmentData,
   useEntityInvestmentHistory,
   useSonarAuth,
   useSonarClient,

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
-import { SonarClient, EntityDetails, GeneratePurchasePermitResponse, PrePurchaseFailureReason, EntityID, MyProfileResponse, EntityInvestmentHistoryResponse } from '@echoxyz/sonar-core';
+import { SonarClient, EntityDetails, GeneratePurchasePermitResponse, PrePurchaseFailureReason, EntityID, MyProfileResponse, EntityInvestmentHistoryResponse, ReadCommitmentDataResponse } from '@echoxyz/sonar-core';
 
 type SonarProviderProps = {
     children: React.ReactNode;
@@ -91,5 +91,17 @@ type UseEntityInvestmentHistoryResult = {
     error?: Error;
 };
 declare function useEntityInvestmentHistory(): UseEntityInvestmentHistoryResult;
+type UseCommitmentDataResult = {
+    loading: boolean;
+    commitmentData?: ReadCommitmentDataResponse;
+    error?: Error;
+};
+/**
+ * Fetches commitment data for a sale and optionally polls for updates. Polling is disabled by default.
+ */
+declare function useCommitmentData(args: {
+    saleUUID: string;
+    pollingIntervalMs?: number;
+}): UseCommitmentDataResult;
 
-export { SonarProvider, type SonarProviderConfig, type UseEntityInvestmentHistoryResult, type UseSonarEntitiesResult, type UseSonarEntityResult, type UseSonarProfileResult, type UseSonarPurchaseResult, type UseSonarPurchaseResultError, type UseSonarPurchaseResultLoading, type UseSonarPurchaseResultNotReadyToPurchase, type UseSonarPurchaseResultReadyToPurchase, useEntityInvestmentHistory, useSonarAuth, useSonarClient, useSonarEntities, useSonarEntity, useSonarProfile, useSonarPurchase };
+export { SonarProvider, type SonarProviderConfig, type UseCommitmentDataResult, type UseEntityInvestmentHistoryResult, type UseSonarEntitiesResult, type UseSonarEntityResult, type UseSonarProfileResult, type UseSonarPurchaseResult, type UseSonarPurchaseResultError, type UseSonarPurchaseResultLoading, type UseSonarPurchaseResultNotReadyToPurchase, type UseSonarPurchaseResultReadyToPurchase, useCommitmentData, useEntityInvestmentHistory, useSonarAuth, useSonarClient, useSonarEntities, useSonarEntity, useSonarProfile, useSonarPurchase };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
-import { SonarClient, EntityDetails, GeneratePurchasePermitResponse, PrePurchaseFailureReason, EntityID, MyProfileResponse, EntityInvestmentHistoryResponse } from '@echoxyz/sonar-core';
+import { SonarClient, EntityDetails, GeneratePurchasePermitResponse, PrePurchaseFailureReason, EntityID, MyProfileResponse, EntityInvestmentHistoryResponse, ReadCommitmentDataResponse } from '@echoxyz/sonar-core';
 
 type SonarProviderProps = {
     children: React.ReactNode;
@@ -91,5 +91,17 @@ type UseEntityInvestmentHistoryResult = {
     error?: Error;
 };
 declare function useEntityInvestmentHistory(): UseEntityInvestmentHistoryResult;
+type UseCommitmentDataResult = {
+    loading: boolean;
+    commitmentData?: ReadCommitmentDataResponse;
+    error?: Error;
+};
+/**
+ * Fetches commitment data for a sale and optionally polls for updates. Polling is disabled by default.
+ */
+declare function useCommitmentData(args: {
+    saleUUID: string;
+    pollingIntervalMs?: number;
+}): UseCommitmentDataResult;
 
-export { SonarProvider, type SonarProviderConfig, type UseEntityInvestmentHistoryResult, type UseSonarEntitiesResult, type UseSonarEntityResult, type UseSonarProfileResult, type UseSonarPurchaseResult, type UseSonarPurchaseResultError, type UseSonarPurchaseResultLoading, type UseSonarPurchaseResultNotReadyToPurchase, type UseSonarPurchaseResultReadyToPurchase, useEntityInvestmentHistory, useSonarAuth, useSonarClient, useSonarEntities, useSonarEntity, useSonarProfile, useSonarPurchase };
+export { SonarProvider, type SonarProviderConfig, type UseCommitmentDataResult, type UseEntityInvestmentHistoryResult, type UseSonarEntitiesResult, type UseSonarEntityResult, type UseSonarProfileResult, type UseSonarPurchaseResult, type UseSonarPurchaseResultError, type UseSonarPurchaseResultLoading, type UseSonarPurchaseResultNotReadyToPurchase, type UseSonarPurchaseResultReadyToPurchase, useCommitmentData, useEntityInvestmentHistory, useSonarAuth, useSonarClient, useSonarEntities, useSonarEntity, useSonarProfile, useSonarPurchase };

package/dist/index.js

@@ -375,8 +375,48 @@ function useEntityInvestmentHistory() {
     error: state.error
   };
 }
+var MIN_POLLING_INTERVAL_MS = 1e3;
+function useCommitmentData(args) {
+  const saleUUID = args.saleUUID;
+  const pollingIntervalMs = args.pollingIntervalMs;
+  if (pollingIntervalMs !== void 0 && pollingIntervalMs < MIN_POLLING_INTERVAL_MS) {
+    throw new Error(`pollingIntervalMs must be at least ${MIN_POLLING_INTERVAL_MS}ms`);
+  }
+  const client = useSonarClient();
+  const [state, setState] = useState2({
+    loading: false
+  });
+  const refetch = useCallback2(async () => {
+    setState((s) => ({ ...s, loading: true }));
+    try {
+      const resp = await client.readCommitmentData({ saleUUID });
+      setState({
+        loading: false,
+        commitmentData: resp,
+        error: void 0
+      });
+    } catch (err) {
+      const error = err instanceof Error ? err : new Error(String(err));
+      setState({ loading: false, commitmentData: void 0, error });
+    }
+  }, [client, saleUUID]);
+  useEffect2(() => {
+    refetch();
+    if (pollingIntervalMs === void 0) {
+      return;
+    }
+    const intervalId = setInterval(() => {
+      refetch();
+    }, pollingIntervalMs);
+    return () => {
+      clearInterval(intervalId);
+    };
+  }, [refetch, pollingIntervalMs]);
+  return state;
+}
 export {
   SonarProvider,
+  useCommitmentData,
   useEntityInvestmentHistory,
   useSonarAuth,
   useSonarClient,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@echoxyz/sonar-react",
-  "version": "0.12.2",
+  "version": "0.13.1",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -16,7 +16,7 @@
     "react": ">=18"
   },
   "dependencies": {
-    "@echoxyz/sonar-core": "0.13.0"
+    "@echoxyz/sonar-core": "0.14.1"
   },
   "devDependencies": {
     "@testing-library/react": "^16.0.0",