@echoxyz/sonar-core 0.5.0 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @echoxyz/sonar-core
 
+## 0.7.0
+
+### Minor Changes
+
+- 5b96860: Add listAvailableEntities / useSonarEntities
+
+### Patch Changes
+
+- ef7e0f9: Switch to new ExchangeAuthorizationCodeV2 endpoint
+
+## 0.6.0
+
+### Minor Changes
+
+- f47a532: Replace EntityUUID + ObfuscatedEntityID in the API interface with a single EntityID
+
 ## 0.5.0
 
 ### Minor Changes

package/README.md

@@ -71,13 +71,18 @@ export async function completeOAuthFromCallback() {
 // Call APIs (after token is set)
 export async function exampleCalls() {
     const { walletAddress } = useWallet(); // User's connected wallet.
-    // List entities available to this user for the configured sale
+
+    // Read the entity for linked to the wallet for the configured sale.
+    // If the authenticated user has not yet linked the wallet on Sonar, this will return a 404.
     const { Entity } = await client.readEntity({ saleUUID, walletAddress });
 
+    // List entities available to this user for the configured sale
+    const { Entities } = await client.listAvailableEntities({ saleUUD });
+
     // Run a pre-purchase check
     const pre = await client.prePurchaseCheck({
         saleUUID,
-        entityUUID: Entity.EntityUUID,
+        entityID: Entity.EntityID,
         walletAddress: "0x1234...abcd" as `0x${string}`,
     });
 
@@ -85,7 +90,7 @@ export async function exampleCalls() {
         // Generate a purchase permit
         const permit = await client.generatePurchasePermit({
             saleUUID,
-            entityUUID: Entity.EntityUUID,
+            entityID: Entity.EntityID,
             walletAddress: "0x1234...abcd" as `0x${string}`,
         });
         console.log(permit.Signature, permit.Permit);

package/dist/index.cjs

@@ -265,11 +265,11 @@ var SonarClient = class {
   }
   async exchangeAuthorizationCode(args) {
     return this.postJSON(
-      "/oauth.ExchangeAuthorizationCode",
+      "/oauth.ExchangeAuthorizationCodeV2",
       {
-        Code: args.code,
-        CodeVerifier: args.codeVerifier,
-        RedirectURI: args.redirectURI
+        code: args.code,
+        code_verifier: args.codeVerifier,
+        redirect_uri: args.redirectURI
       },
       { includeAuth: false }
     );
@@ -277,14 +277,14 @@ var SonarClient = class {
   async prePurchaseCheck(args) {
     return this.postJSON("/externalapi.PrePurchaseCheck", {
       SaleUUID: args.saleUUID,
-      EntityUUID: args.entityUUID,
+      EntityID: args.entityID,
       PurchasingWalletAddress: args.walletAddress
     });
   }
   async generatePurchasePermit(args) {
     return this.postJSON("/externalapi.GenerateSalePurchasePermit", {
       SaleUUID: args.saleUUID,
-      EntityUUID: args.entityUUID,
+      EntityID: args.entityID,
       PurchasingWalletAddress: args.walletAddress
     });
   }
@@ -300,6 +300,11 @@ var SonarClient = class {
       WalletAddress: args.walletAddress
     });
   }
+  async listAvailableEntities(args) {
+    return this.postJSON("/externalapi.ListAvailableEntities", {
+      SaleUUID: args.saleUUID
+    });
+  }
 };
 var APIError = class extends Error {
   status;

package/dist/index.d.cts

@@ -80,12 +80,11 @@ declare enum InvestingRegion {
 }
 type EntityDetails = {
     Label: string;
-    EntityUUID: string;
+    EntityID: Hex;
     EntityType: EntityType;
     EntitySetupState: EntitySetupState;
     SaleEligibility: SaleEligibility;
     InvestingRegion: InvestingRegion;
-    ObfuscatedEntityID: `0x${string}`;
 };
 
 type FetchLike = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
@@ -106,6 +105,9 @@ type AllocationResponse = {
 type ReadEntityResponse = {
     Entity: EntityDetails;
 };
+type ListAvailableEntitiesResponse = {
+    Entities: EntityDetails[];
+};
 type ClientOptions = {
     auth?: AuthSession;
     fetch?: FetchLike;
@@ -135,12 +137,12 @@ declare class SonarClient {
     }>;
     prePurchaseCheck(args: {
         saleUUID: string;
-        entityUUID: string;
+        entityID: Hex;
         walletAddress: string;
     }): Promise<PrePurchaseCheckResponse>;
     generatePurchasePermit(args: {
         saleUUID: string;
-        entityUUID: string;
+        entityID: Hex;
         walletAddress: string;
     }): Promise<GeneratePurchasePermitResponse>;
     fetchAllocation(args: {
@@ -151,6 +153,9 @@ declare class SonarClient {
         saleUUID: string;
         walletAddress: string;
     }): Promise<ReadEntityResponse>;
+    listAvailableEntities(args: {
+        saleUUID: string;
+    }): Promise<ListAvailableEntitiesResponse>;
 }
 declare class APIError extends Error {
     readonly status: number;
@@ -185,4 +190,4 @@ type CreateClientOptions = {
 };
 declare function createClient(options?: CreateClientOptions): SonarClient;
 
-export { APIError, type AllocationPermit, type AllocationResponse, type BasicPermit, type BuildAuthorizationUrlArgs, type ClientOptions, type CreateClientOptions, type EntityDetails, EntitySetupState, EntityType, type FetchLike, type GeneratePurchasePermitResponse, type Hex, InvestingRegion, type PrePurchaseCheckResponse, PrePurchaseFailureReason, type PurchasePermit, PurchasePermitType, type ReadEntityResponse, SaleEligibility, SonarClient, type StorageLike, buildAuthorizationUrl, createClient, createMemoryStorage, createWebStorage, generatePKCEParams };
+export { APIError, type AllocationPermit, type AllocationResponse, type BasicPermit, type BuildAuthorizationUrlArgs, type ClientOptions, type CreateClientOptions, type EntityDetails, EntitySetupState, EntityType, type FetchLike, type GeneratePurchasePermitResponse, type Hex, InvestingRegion, type ListAvailableEntitiesResponse, type PrePurchaseCheckResponse, PrePurchaseFailureReason, type PurchasePermit, PurchasePermitType, type ReadEntityResponse, SaleEligibility, SonarClient, type StorageLike, buildAuthorizationUrl, createClient, createMemoryStorage, createWebStorage, generatePKCEParams };

package/dist/index.d.ts

@@ -80,12 +80,11 @@ declare enum InvestingRegion {
 }
 type EntityDetails = {
     Label: string;
-    EntityUUID: string;
+    EntityID: Hex;
     EntityType: EntityType;
     EntitySetupState: EntitySetupState;
     SaleEligibility: SaleEligibility;
     InvestingRegion: InvestingRegion;
-    ObfuscatedEntityID: `0x${string}`;
 };
 
 type FetchLike = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
@@ -106,6 +105,9 @@ type AllocationResponse = {
 type ReadEntityResponse = {
     Entity: EntityDetails;
 };
+type ListAvailableEntitiesResponse = {
+    Entities: EntityDetails[];
+};
 type ClientOptions = {
     auth?: AuthSession;
     fetch?: FetchLike;
@@ -135,12 +137,12 @@ declare class SonarClient {
     }>;
     prePurchaseCheck(args: {
         saleUUID: string;
-        entityUUID: string;
+        entityID: Hex;
         walletAddress: string;
     }): Promise<PrePurchaseCheckResponse>;
     generatePurchasePermit(args: {
         saleUUID: string;
-        entityUUID: string;
+        entityID: Hex;
         walletAddress: string;
     }): Promise<GeneratePurchasePermitResponse>;
     fetchAllocation(args: {
@@ -151,6 +153,9 @@ declare class SonarClient {
         saleUUID: string;
         walletAddress: string;
     }): Promise<ReadEntityResponse>;
+    listAvailableEntities(args: {
+        saleUUID: string;
+    }): Promise<ListAvailableEntitiesResponse>;
 }
 declare class APIError extends Error {
     readonly status: number;
@@ -185,4 +190,4 @@ type CreateClientOptions = {
 };
 declare function createClient(options?: CreateClientOptions): SonarClient;
 
-export { APIError, type AllocationPermit, type AllocationResponse, type BasicPermit, type BuildAuthorizationUrlArgs, type ClientOptions, type CreateClientOptions, type EntityDetails, EntitySetupState, EntityType, type FetchLike, type GeneratePurchasePermitResponse, type Hex, InvestingRegion, type PrePurchaseCheckResponse, PrePurchaseFailureReason, type PurchasePermit, PurchasePermitType, type ReadEntityResponse, SaleEligibility, SonarClient, type StorageLike, buildAuthorizationUrl, createClient, createMemoryStorage, createWebStorage, generatePKCEParams };
+export { APIError, type AllocationPermit, type AllocationResponse, type BasicPermit, type BuildAuthorizationUrlArgs, type ClientOptions, type CreateClientOptions, type EntityDetails, EntitySetupState, EntityType, type FetchLike, type GeneratePurchasePermitResponse, type Hex, InvestingRegion, type ListAvailableEntitiesResponse, type PrePurchaseCheckResponse, PrePurchaseFailureReason, type PurchasePermit, PurchasePermitType, type ReadEntityResponse, SaleEligibility, SonarClient, type StorageLike, buildAuthorizationUrl, createClient, createMemoryStorage, createWebStorage, generatePKCEParams };

package/dist/index.js

@@ -228,11 +228,11 @@ var SonarClient = class {
   }
   async exchangeAuthorizationCode(args) {
     return this.postJSON(
-      "/oauth.ExchangeAuthorizationCode",
+      "/oauth.ExchangeAuthorizationCodeV2",
       {
-        Code: args.code,
-        CodeVerifier: args.codeVerifier,
-        RedirectURI: args.redirectURI
+        code: args.code,
+        code_verifier: args.codeVerifier,
+        redirect_uri: args.redirectURI
       },
       { includeAuth: false }
     );
@@ -240,14 +240,14 @@ var SonarClient = class {
   async prePurchaseCheck(args) {
     return this.postJSON("/externalapi.PrePurchaseCheck", {
       SaleUUID: args.saleUUID,
-      EntityUUID: args.entityUUID,
+      EntityID: args.entityID,
       PurchasingWalletAddress: args.walletAddress
     });
   }
   async generatePurchasePermit(args) {
     return this.postJSON("/externalapi.GenerateSalePurchasePermit", {
       SaleUUID: args.saleUUID,
-      EntityUUID: args.entityUUID,
+      EntityID: args.entityID,
       PurchasingWalletAddress: args.walletAddress
     });
   }
@@ -263,6 +263,11 @@ var SonarClient = class {
       WalletAddress: args.walletAddress
     });
   }
+  async listAvailableEntities(args) {
+    return this.postJSON("/externalapi.ListAvailableEntities", {
+      SaleUUID: args.saleUUID
+    });
+  }
 };
 var APIError = class extends Error {
   status;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@echoxyz/sonar-core",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",