@echoxyz/sonar-core 0.1.5 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @echoxyz/sonar-core
 
+## 0.2.1
+
+### Patch Changes
+
+- affa026: Add missing values to PrePurchaseFailureReason enum
+
+## 0.2.0
+
+### Minor Changes
+
+- a043774: Replace listEntities with readEntity function
+
 ## 0.1.5
 
 ### Patch Changes

package/README.md

@@ -71,13 +71,14 @@ 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
-    const { Entities } = await client.listAvailableEntities({ saleUUID });
+    const { Entity } = await client.readEntity({ saleUUID, walletAddress });
 
     // Run a pre-purchase check
     const pre = await client.prePurchaseCheck({
         saleUUID,
-        entityUUID: Entities[0].EntityUUID,
+        entityUUID: Entity.EntityUUID,
         entityType: EntityType.USER, // or EntityType.ORGANIZATION
         walletAddress: "0x1234...abcd" as `0x${string}`,
     });
@@ -86,7 +87,7 @@ export async function exampleCalls() {
         // Generate a purchase permit
         const permit = await client.generatePurchasePermit({
             saleUUID,
-            entityUUID: Entities[0].EntityUUID,
+            entityUUID: Entity.EntityUUID,
             entityType: EntityType.USER,
             walletAddress: "0x1234...abcd" as `0x${string}`,
         });
@@ -94,7 +95,7 @@ export async function exampleCalls() {
     }
 
     // Fetch allocation
-    const alloc = await client.fetchAllocation({ saleUUID, walletAddress: "0x1234...abcd" as `0x${string}` });
+    const alloc = await client.fetchAllocation({ saleUUID, walletAddress });
     console.log(alloc);
 }
 ```

package/dist/index.cjs

@@ -22,6 +22,7 @@ __export(index_exports, {
   APIError: () => APIError,
   EntitySetupState: () => EntitySetupState,
   EntityType: () => EntityType,
+  InvestingRegion: () => InvestingRegion,
   PrePurchaseFailureReason: () => PrePurchaseFailureReason,
   PurchasePermitType: () => PurchasePermitType,
   SaleEligibility: () => SaleEligibility,
@@ -295,11 +296,11 @@ var SonarClient = class {
       WalletAddress: args.walletAddress
     });
   }
-  async listAvailableEntities(args) {
-    const data = await this.postJSON("/externalapi.ListAvailableEntities", {
-      SaleUUID: args.saleUUID
+  async readEntity(args) {
+    return this.postJSON("/externalapi.ReadEntity", {
+      SaleUUID: args.saleUUID,
+      WalletAddress: args.walletAddress
     });
-    return data;
   }
 };
 var APIError = class extends Error {
@@ -376,6 +377,7 @@ var EntityType = /* @__PURE__ */ ((EntityType2) => {
 var EntitySetupState = /* @__PURE__ */ ((EntitySetupState2) => {
   EntitySetupState2["NOT_STARTED"] = "not-started";
   EntitySetupState2["IN_PROGRESS"] = "in-progress";
+  EntitySetupState2["READY_FOR_REVIEW"] = "ready-for-review";
   EntitySetupState2["IN_REVIEW"] = "in-review";
   EntitySetupState2["FAILURE"] = "failure";
   EntitySetupState2["FAILURE_FINAL"] = "failure-final";
@@ -399,8 +401,16 @@ var PrePurchaseFailureReason = /* @__PURE__ */ ((PrePurchaseFailureReason2) => {
   PrePurchaseFailureReason2["MAX_WALLETS_USED"] = "max-wallets-used";
   PrePurchaseFailureReason2["REQUIRES_LIVENESS"] = "requires-liveness";
   PrePurchaseFailureReason2["NO_RESERVED_ALLOCATION"] = "no-reserved-allocation";
+  PrePurchaseFailureReason2["SALE_NOT_ACTIVE"] = "sale-not-active";
+  PrePurchaseFailureReason2["WALLET_NOT_LINKED"] = "wallet-not-linked";
   return PrePurchaseFailureReason2;
 })(PrePurchaseFailureReason || {});
+var InvestingRegion = /* @__PURE__ */ ((InvestingRegion2) => {
+  InvestingRegion2["UNKNOWN"] = "unknown";
+  InvestingRegion2["OTHER"] = "other";
+  InvestingRegion2["US"] = "us";
+  return InvestingRegion2;
+})(InvestingRegion || {});
 
 // src/index.ts
 var DEFAULT_API_URL = "https://api.echo.xyz";
@@ -424,6 +434,7 @@ function createClient(options) {
   APIError,
   EntitySetupState,
   EntityType,
+  InvestingRegion,
   PrePurchaseFailureReason,
   PurchasePermitType,
   SaleEligibility,

package/dist/index.d.cts

@@ -35,6 +35,7 @@ declare enum EntityType {
 declare enum EntitySetupState {
     NOT_STARTED = "not-started",
     IN_PROGRESS = "in-progress",
+    READY_FOR_REVIEW = "ready-for-review",
     IN_REVIEW = "in-review",
     FAILURE = "failure",
     FAILURE_FINAL = "failure-final",
@@ -67,15 +68,22 @@ declare enum PrePurchaseFailureReason {
     WALLET_RISK = "wallet-risk",
     MAX_WALLETS_USED = "max-wallets-used",
     REQUIRES_LIVENESS = "requires-liveness",
-    NO_RESERVED_ALLOCATION = "no-reserved-allocation"
+    NO_RESERVED_ALLOCATION = "no-reserved-allocation",
+    SALE_NOT_ACTIVE = "sale-not-active",
+    WALLET_NOT_LINKED = "wallet-not-linked"
+}
+declare enum InvestingRegion {
+    UNKNOWN = "unknown",
+    OTHER = "other",
+    US = "us"
 }
 type EntityDetails = {
     Label: string;
     EntityUUID: string;
     EntityType: EntityType;
-    EntitySetupState: string;
-    SaleEligibility: string;
-    InvestingRegion: string;
+    EntitySetupState: EntitySetupState;
+    SaleEligibility: SaleEligibility;
+    InvestingRegion: InvestingRegion;
     ObfuscatedEntityID: `0x${string}`;
 };
 
@@ -86,7 +94,7 @@ type PrePurchaseCheckResponse = {
     LivenessCheckURL: string;
 };
 type GeneratePurchasePermitResponse = {
-    Permit: BasicPermit | AllocationPermit;
+    PermitJSON: BasicPermit | AllocationPermit;
     Signature: string;
 };
 type AllocationResponse = {
@@ -94,8 +102,8 @@ type AllocationResponse = {
     ReservedAmountUSD: string;
     MaxAmountUSD: string;
 };
-type ListAvailableEntitiesResponse = {
-    Entities: EntityDetails[];
+type ReadEntityResponse = {
+    Entity: EntityDetails;
 };
 type ClientOptions = {
     auth?: AuthSession;
@@ -140,9 +148,10 @@ declare class SonarClient {
         saleUUID: string;
         walletAddress: string;
     }): Promise<AllocationResponse>;
-    listAvailableEntities(args: {
+    readEntity(args: {
         saleUUID: string;
-    }): Promise<ListAvailableEntitiesResponse>;
+        walletAddress: string;
+    }): Promise<ReadEntityResponse>;
 }
 declare class APIError extends Error {
     readonly status: number;
@@ -179,4 +188,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, type ListAvailableEntitiesResponse, type PrePurchaseCheckResponse, PrePurchaseFailureReason, type PurchasePermit, PurchasePermitType, 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 PrePurchaseCheckResponse, PrePurchaseFailureReason, type PurchasePermit, PurchasePermitType, type ReadEntityResponse, SaleEligibility, SonarClient, type StorageLike, buildAuthorizationUrl, createClient, createMemoryStorage, createWebStorage, generatePKCEParams };

package/dist/index.d.ts

@@ -35,6 +35,7 @@ declare enum EntityType {
 declare enum EntitySetupState {
     NOT_STARTED = "not-started",
     IN_PROGRESS = "in-progress",
+    READY_FOR_REVIEW = "ready-for-review",
     IN_REVIEW = "in-review",
     FAILURE = "failure",
     FAILURE_FINAL = "failure-final",
@@ -67,15 +68,22 @@ declare enum PrePurchaseFailureReason {
     WALLET_RISK = "wallet-risk",
     MAX_WALLETS_USED = "max-wallets-used",
     REQUIRES_LIVENESS = "requires-liveness",
-    NO_RESERVED_ALLOCATION = "no-reserved-allocation"
+    NO_RESERVED_ALLOCATION = "no-reserved-allocation",
+    SALE_NOT_ACTIVE = "sale-not-active",
+    WALLET_NOT_LINKED = "wallet-not-linked"
+}
+declare enum InvestingRegion {
+    UNKNOWN = "unknown",
+    OTHER = "other",
+    US = "us"
 }
 type EntityDetails = {
     Label: string;
     EntityUUID: string;
     EntityType: EntityType;
-    EntitySetupState: string;
-    SaleEligibility: string;
-    InvestingRegion: string;
+    EntitySetupState: EntitySetupState;
+    SaleEligibility: SaleEligibility;
+    InvestingRegion: InvestingRegion;
     ObfuscatedEntityID: `0x${string}`;
 };
 
@@ -86,7 +94,7 @@ type PrePurchaseCheckResponse = {
     LivenessCheckURL: string;
 };
 type GeneratePurchasePermitResponse = {
-    Permit: BasicPermit | AllocationPermit;
+    PermitJSON: BasicPermit | AllocationPermit;
     Signature: string;
 };
 type AllocationResponse = {
@@ -94,8 +102,8 @@ type AllocationResponse = {
     ReservedAmountUSD: string;
     MaxAmountUSD: string;
 };
-type ListAvailableEntitiesResponse = {
-    Entities: EntityDetails[];
+type ReadEntityResponse = {
+    Entity: EntityDetails;
 };
 type ClientOptions = {
     auth?: AuthSession;
@@ -140,9 +148,10 @@ declare class SonarClient {
         saleUUID: string;
         walletAddress: string;
     }): Promise<AllocationResponse>;
-    listAvailableEntities(args: {
+    readEntity(args: {
         saleUUID: string;
-    }): Promise<ListAvailableEntitiesResponse>;
+        walletAddress: string;
+    }): Promise<ReadEntityResponse>;
 }
 declare class APIError extends Error {
     readonly status: number;
@@ -179,4 +188,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, type ListAvailableEntitiesResponse, type PrePurchaseCheckResponse, PrePurchaseFailureReason, type PurchasePermit, PurchasePermitType, 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 PrePurchaseCheckResponse, PrePurchaseFailureReason, type PurchasePermit, PurchasePermitType, type ReadEntityResponse, SaleEligibility, SonarClient, type StorageLike, buildAuthorizationUrl, createClient, createMemoryStorage, createWebStorage, generatePKCEParams };

package/dist/index.js

@@ -259,11 +259,11 @@ var SonarClient = class {
       WalletAddress: args.walletAddress
     });
   }
-  async listAvailableEntities(args) {
-    const data = await this.postJSON("/externalapi.ListAvailableEntities", {
-      SaleUUID: args.saleUUID
+  async readEntity(args) {
+    return this.postJSON("/externalapi.ReadEntity", {
+      SaleUUID: args.saleUUID,
+      WalletAddress: args.walletAddress
     });
-    return data;
   }
 };
 var APIError = class extends Error {
@@ -340,6 +340,7 @@ var EntityType = /* @__PURE__ */ ((EntityType2) => {
 var EntitySetupState = /* @__PURE__ */ ((EntitySetupState2) => {
   EntitySetupState2["NOT_STARTED"] = "not-started";
   EntitySetupState2["IN_PROGRESS"] = "in-progress";
+  EntitySetupState2["READY_FOR_REVIEW"] = "ready-for-review";
   EntitySetupState2["IN_REVIEW"] = "in-review";
   EntitySetupState2["FAILURE"] = "failure";
   EntitySetupState2["FAILURE_FINAL"] = "failure-final";
@@ -363,8 +364,16 @@ var PrePurchaseFailureReason = /* @__PURE__ */ ((PrePurchaseFailureReason2) => {
   PrePurchaseFailureReason2["MAX_WALLETS_USED"] = "max-wallets-used";
   PrePurchaseFailureReason2["REQUIRES_LIVENESS"] = "requires-liveness";
   PrePurchaseFailureReason2["NO_RESERVED_ALLOCATION"] = "no-reserved-allocation";
+  PrePurchaseFailureReason2["SALE_NOT_ACTIVE"] = "sale-not-active";
+  PrePurchaseFailureReason2["WALLET_NOT_LINKED"] = "wallet-not-linked";
   return PrePurchaseFailureReason2;
 })(PrePurchaseFailureReason || {});
+var InvestingRegion = /* @__PURE__ */ ((InvestingRegion2) => {
+  InvestingRegion2["UNKNOWN"] = "unknown";
+  InvestingRegion2["OTHER"] = "other";
+  InvestingRegion2["US"] = "us";
+  return InvestingRegion2;
+})(InvestingRegion || {});
 
 // src/index.ts
 var DEFAULT_API_URL = "https://api.echo.xyz";
@@ -387,6 +396,7 @@ export {
   APIError,
   EntitySetupState,
   EntityType,
+  InvestingRegion,
   PrePurchaseFailureReason,
   PurchasePermitType,
   SaleEligibility,

package/package.json

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