@echoxyz/sonar-react 0.6.2 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @echoxyz/sonar-react
 
+## 0.8.0
+
+### Minor Changes
+
+- 5b96860: Add listAvailableEntities / useSonarEntities
+
+### Patch Changes
+
+- Updated dependencies [5b96860]
+- Updated dependencies [ef7e0f9]
+    - @echoxyz/sonar-core@0.7.0
+
+## 0.7.0
+
+### Minor Changes
+
+- f47a532: Replace EntityUUID + ObfuscatedEntityID in the API interface with a single EntityID
+
+### Patch Changes
+
+- Updated dependencies [f47a532]
+    - @echoxyz/sonar-core@0.6.0
+
 ## 0.6.2
 
 ### Patch Changes

package/README.md

@@ -114,22 +114,23 @@ const ExampleEntityPanel = () => {
         </div>
     );
 };
-
 ```
 
+If you want to fetch all entities associated with the logged in user, you can use the `useSonarEntities` hook.
+
 5. Implement the purchase flow
 
 ```tsx
 function Example({
-  entityUUID,
+  entityID,
   walletAddress,
 }: {
-  entityUUID: string;
+  entityID: string;
   walletAddress: string;
 }) {
   const sonarPurchaser = useSonarPurchase({
     saleUUID: sonarConfig.saleUUID,
-    entityUUID,
+    entityID,
     entityType,
     walletAddress,
   });

package/dist/index.cjs

@@ -23,6 +23,7 @@ __export(index_exports, {
   SonarProvider: () => SonarProvider,
   useSonarAuth: () => useSonarAuth,
   useSonarClient: () => useSonarClient,
+  useSonarEntities: () => useSonarEntities,
   useSonarEntity: () => useSonarEntity,
   useSonarPurchase: () => useSonarPurchase
 });
@@ -191,9 +192,66 @@ function useSonarEntity(args) {
     error: state.error
   };
 }
+function useSonarEntities(args) {
+  const { authenticated, ready } = useSonarAuth();
+  const client = useSonarClient();
+  if (!args.saleUUID) {
+    throw new Error("saleUUID is required");
+  }
+  const saleUUID = args.saleUUID;
+  const [state, setState] = (0, import_react2.useState)({
+    loading: false,
+    hasFetched: false
+  });
+  const fullyConnected = ready && authenticated;
+  const refetch = (0, import_react2.useCallback)(async () => {
+    if (!fullyConnected) {
+      return;
+    }
+    setState((s) => ({ ...s, loading: true }));
+    try {
+      const resp = await client.listAvailableEntities({
+        saleUUID
+      });
+      setState({
+        loading: false,
+        entities: resp.Entities,
+        error: void 0,
+        hasFetched: true
+      });
+    } catch (err) {
+      const error = err instanceof Error ? err : new Error(String(err));
+      setState({ loading: false, entities: void 0, error, hasFetched: true });
+    }
+  }, [client, saleUUID, fullyConnected]);
+  const reset = (0, import_react2.useCallback)(() => {
+    setState({
+      loading: false,
+      hasFetched: false,
+      entities: void 0,
+      error: void 0
+    });
+  }, []);
+  (0, import_react2.useEffect)(() => {
+    if (fullyConnected) {
+      refetch();
+    }
+  }, [fullyConnected, refetch]);
+  (0, import_react2.useEffect)(() => {
+    if (ready && !authenticated) {
+      reset();
+    }
+  }, [ready, authenticated, reset]);
+  return {
+    authenticated,
+    loading: state.loading,
+    entities: state.entities,
+    error: state.error
+  };
+}
 function useSonarPurchase(args) {
   const saleUUID = args.saleUUID;
-  const entityUUID = args.entityUUID;
+  const entityID = args.entityID;
   const walletAddress = args.walletAddress;
   const client = useSonarClient();
   const [state, setState] = (0, import_react2.useState)({
@@ -204,10 +262,10 @@ function useSonarPurchase(args) {
   const generatePurchasePermit = (0, import_react2.useCallback)(() => {
     return client.generatePurchasePermit({
       saleUUID,
-      entityUUID,
+      entityID,
       walletAddress
     });
-  }, [client, saleUUID, entityUUID, walletAddress]);
+  }, [client, saleUUID, entityID, walletAddress]);
   (0, import_react2.useEffect)(() => {
     const fetchPurchaseData = async () => {
       setState({
@@ -218,7 +276,7 @@ function useSonarPurchase(args) {
       try {
         const response = await client.prePurchaseCheck({
           saleUUID,
-          entityUUID,
+          entityID,
           walletAddress
         });
         if (response.ReadyToPurchase) {
@@ -247,7 +305,7 @@ function useSonarPurchase(args) {
       }
     };
     fetchPurchaseData();
-  }, [saleUUID, entityUUID, walletAddress, client, generatePurchasePermit]);
+  }, [saleUUID, entityID, walletAddress, client, generatePurchasePermit]);
   return state;
 }
 // Annotate the CommonJS export names for ESM import in node:
@@ -255,6 +313,7 @@ function useSonarPurchase(args) {
   SonarProvider,
   useSonarAuth,
   useSonarClient,
+  useSonarEntities,
   useSonarEntity,
   useSonarPurchase
 });

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 } from '@echoxyz/sonar-core';
+import { SonarClient, EntityDetails, GeneratePurchasePermitResponse, PrePurchaseFailureReason, Hex } from '@echoxyz/sonar-core';
 
 type SonarProviderProps = {
     children: React.ReactNode;
@@ -38,6 +38,16 @@ declare function useSonarEntity(args: {
     saleUUID: string;
     walletAddress?: string;
 }): UseSonarEntityResult;
+type UseSonarEntitiesResult = {
+    authenticated: boolean;
+    loading: boolean;
+    entities?: EntityDetails[];
+    error?: Error;
+};
+declare function useSonarEntities(args: {
+    saleUUID: string;
+    walletAddress?: string;
+}): UseSonarEntitiesResult;
 type UseSonarPurchaseResultReadyToPurchase = {
     loading: false;
     readyToPurchase: true;
@@ -64,8 +74,8 @@ type UseSonarPurchaseResultLoading = {
 type UseSonarPurchaseResult = UseSonarPurchaseResultLoading | UseSonarPurchaseResultReadyToPurchase | UseSonarPurchaseResultNotReadyToPurchase | UseSonarPurchaseResultError;
 declare function useSonarPurchase(args: {
     saleUUID: string;
-    entityUUID: string;
+    entityID: Hex;
     walletAddress: string;
 }): UseSonarPurchaseResult;
 
-export { SonarProvider, type SonarProviderConfig, type UseSonarEntityResult, type UseSonarPurchaseResult, type UseSonarPurchaseResultError, type UseSonarPurchaseResultLoading, type UseSonarPurchaseResultNotReadyToPurchase, type UseSonarPurchaseResultReadyToPurchase, useSonarAuth, useSonarClient, useSonarEntity, useSonarPurchase };
+export { SonarProvider, type SonarProviderConfig, type UseSonarEntitiesResult, type UseSonarEntityResult, type UseSonarPurchaseResult, type UseSonarPurchaseResultError, type UseSonarPurchaseResultLoading, type UseSonarPurchaseResultNotReadyToPurchase, type UseSonarPurchaseResultReadyToPurchase, useSonarAuth, useSonarClient, useSonarEntities, useSonarEntity, 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 } from '@echoxyz/sonar-core';
+import { SonarClient, EntityDetails, GeneratePurchasePermitResponse, PrePurchaseFailureReason, Hex } from '@echoxyz/sonar-core';
 
 type SonarProviderProps = {
     children: React.ReactNode;
@@ -38,6 +38,16 @@ declare function useSonarEntity(args: {
     saleUUID: string;
     walletAddress?: string;
 }): UseSonarEntityResult;
+type UseSonarEntitiesResult = {
+    authenticated: boolean;
+    loading: boolean;
+    entities?: EntityDetails[];
+    error?: Error;
+};
+declare function useSonarEntities(args: {
+    saleUUID: string;
+    walletAddress?: string;
+}): UseSonarEntitiesResult;
 type UseSonarPurchaseResultReadyToPurchase = {
     loading: false;
     readyToPurchase: true;
@@ -64,8 +74,8 @@ type UseSonarPurchaseResultLoading = {
 type UseSonarPurchaseResult = UseSonarPurchaseResultLoading | UseSonarPurchaseResultReadyToPurchase | UseSonarPurchaseResultNotReadyToPurchase | UseSonarPurchaseResultError;
 declare function useSonarPurchase(args: {
     saleUUID: string;
-    entityUUID: string;
+    entityID: Hex;
     walletAddress: string;
 }): UseSonarPurchaseResult;
 
-export { SonarProvider, type SonarProviderConfig, type UseSonarEntityResult, type UseSonarPurchaseResult, type UseSonarPurchaseResultError, type UseSonarPurchaseResultLoading, type UseSonarPurchaseResultNotReadyToPurchase, type UseSonarPurchaseResultReadyToPurchase, useSonarAuth, useSonarClient, useSonarEntity, useSonarPurchase };
+export { SonarProvider, type SonarProviderConfig, type UseSonarEntitiesResult, type UseSonarEntityResult, type UseSonarPurchaseResult, type UseSonarPurchaseResultError, type UseSonarPurchaseResultLoading, type UseSonarPurchaseResultNotReadyToPurchase, type UseSonarPurchaseResultReadyToPurchase, useSonarAuth, useSonarClient, useSonarEntities, useSonarEntity, useSonarPurchase };

package/dist/index.js

@@ -163,9 +163,66 @@ function useSonarEntity(args) {
     error: state.error
   };
 }
+function useSonarEntities(args) {
+  const { authenticated, ready } = useSonarAuth();
+  const client = useSonarClient();
+  if (!args.saleUUID) {
+    throw new Error("saleUUID is required");
+  }
+  const saleUUID = args.saleUUID;
+  const [state, setState] = useState2({
+    loading: false,
+    hasFetched: false
+  });
+  const fullyConnected = ready && authenticated;
+  const refetch = useCallback2(async () => {
+    if (!fullyConnected) {
+      return;
+    }
+    setState((s) => ({ ...s, loading: true }));
+    try {
+      const resp = await client.listAvailableEntities({
+        saleUUID
+      });
+      setState({
+        loading: false,
+        entities: resp.Entities,
+        error: void 0,
+        hasFetched: true
+      });
+    } catch (err) {
+      const error = err instanceof Error ? err : new Error(String(err));
+      setState({ loading: false, entities: void 0, error, hasFetched: true });
+    }
+  }, [client, saleUUID, fullyConnected]);
+  const reset = useCallback2(() => {
+    setState({
+      loading: false,
+      hasFetched: false,
+      entities: void 0,
+      error: void 0
+    });
+  }, []);
+  useEffect2(() => {
+    if (fullyConnected) {
+      refetch();
+    }
+  }, [fullyConnected, refetch]);
+  useEffect2(() => {
+    if (ready && !authenticated) {
+      reset();
+    }
+  }, [ready, authenticated, reset]);
+  return {
+    authenticated,
+    loading: state.loading,
+    entities: state.entities,
+    error: state.error
+  };
+}
 function useSonarPurchase(args) {
   const saleUUID = args.saleUUID;
-  const entityUUID = args.entityUUID;
+  const entityID = args.entityID;
   const walletAddress = args.walletAddress;
   const client = useSonarClient();
   const [state, setState] = useState2({
@@ -176,10 +233,10 @@ function useSonarPurchase(args) {
   const generatePurchasePermit = useCallback2(() => {
     return client.generatePurchasePermit({
       saleUUID,
-      entityUUID,
+      entityID,
       walletAddress
     });
-  }, [client, saleUUID, entityUUID, walletAddress]);
+  }, [client, saleUUID, entityID, walletAddress]);
   useEffect2(() => {
     const fetchPurchaseData = async () => {
       setState({
@@ -190,7 +247,7 @@ function useSonarPurchase(args) {
       try {
         const response = await client.prePurchaseCheck({
           saleUUID,
-          entityUUID,
+          entityID,
           walletAddress
         });
         if (response.ReadyToPurchase) {
@@ -219,13 +276,14 @@ function useSonarPurchase(args) {
       }
     };
     fetchPurchaseData();
-  }, [saleUUID, entityUUID, walletAddress, client, generatePurchasePermit]);
+  }, [saleUUID, entityID, walletAddress, client, generatePurchasePermit]);
   return state;
 }
 export {
   SonarProvider,
   useSonarAuth,
   useSonarClient,
+  useSonarEntities,
   useSonarEntity,
   useSonarPurchase
 };

package/package.json

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