@echoxyz/sonar-core 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @echoxyz/sonar-core
 
+## 0.3.0
+
+### Minor Changes
+
+- c032c29: Strip EntityType param from API requests
+
+## 0.2.1
+
+### Patch Changes
+
+- affa026: Add missing values to PrePurchaseFailureReason enum
+
 ## 0.2.0
 
 ### Minor Changes

package/README.md

@@ -13,7 +13,7 @@ pnpm add @echoxyz/sonar-core
 The default client targets Echo’s hosted API and reads the auth token from `localStorage` under the `sonar:auth-token` key.
 
 ```ts
-import { createClient, buildAuthorizationUrl, generatePKCEParams, EntityType } from "@echoxyz/sonar-core";
+import { createClient, buildAuthorizationUrl, generatePKCEParams } from "@echoxyz/sonar-core";
 
 // Configure once at app startup
 const saleUUID = "<your-sale-uuid>";
@@ -79,7 +79,6 @@ export async function exampleCalls() {
     const pre = await client.prePurchaseCheck({
         saleUUID,
         entityUUID: Entity.EntityUUID,
-        entityType: EntityType.USER, // or EntityType.ORGANIZATION
         walletAddress: "0x1234...abcd" as `0x${string}`,
     });
 
@@ -88,7 +87,6 @@ export async function exampleCalls() {
         const permit = await client.generatePurchasePermit({
             saleUUID,
             entityUUID: Entity.EntityUUID,
-            entityType: EntityType.USER,
             walletAddress: "0x1234...abcd" as `0x${string}`,
         });
         console.log(permit.Signature, permit.Permit);

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,
@@ -277,7 +278,6 @@ var SonarClient = class {
     return this.postJSON("/externalapi.PrePurchaseCheck", {
       SaleUUID: args.saleUUID,
       EntityUUID: args.entityUUID,
-      EntityType: args.entityType,
       PurchasingWalletAddress: args.walletAddress
     });
   }
@@ -285,7 +285,6 @@ var SonarClient = class {
     return this.postJSON("/externalapi.GenerateSalePurchasePermit", {
       SaleUUID: args.saleUUID,
       EntityUUID: args.entityUUID,
-      EntityType: args.entityType,
       PurchasingWalletAddress: args.walletAddress
     });
   }
@@ -376,6 +375,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 +399,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 +432,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 = {
@@ -127,13 +135,11 @@ declare class SonarClient {
     prePurchaseCheck(args: {
         saleUUID: string;
         entityUUID: string;
-        entityType: EntityType;
         walletAddress: string;
     }): Promise<PrePurchaseCheckResponse>;
     generatePurchasePermit(args: {
         saleUUID: string;
         entityUUID: string;
-        entityType: EntityType;
         walletAddress: string;
     }): Promise<GeneratePurchasePermitResponse>;
     fetchAllocation(args: {
@@ -180,4 +186,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 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 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 = {
@@ -127,13 +135,11 @@ declare class SonarClient {
     prePurchaseCheck(args: {
         saleUUID: string;
         entityUUID: string;
-        entityType: EntityType;
         walletAddress: string;
     }): Promise<PrePurchaseCheckResponse>;
     generatePurchasePermit(args: {
         saleUUID: string;
         entityUUID: string;
-        entityType: EntityType;
         walletAddress: string;
     }): Promise<GeneratePurchasePermitResponse>;
     fetchAllocation(args: {
@@ -180,4 +186,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 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 PrePurchaseCheckResponse, PrePurchaseFailureReason, type PurchasePermit, PurchasePermitType, type ReadEntityResponse, SaleEligibility, SonarClient, type StorageLike, buildAuthorizationUrl, createClient, createMemoryStorage, createWebStorage, generatePKCEParams };

package/dist/index.js

@@ -241,7 +241,6 @@ var SonarClient = class {
     return this.postJSON("/externalapi.PrePurchaseCheck", {
       SaleUUID: args.saleUUID,
       EntityUUID: args.entityUUID,
-      EntityType: args.entityType,
       PurchasingWalletAddress: args.walletAddress
     });
   }
@@ -249,7 +248,6 @@ var SonarClient = class {
     return this.postJSON("/externalapi.GenerateSalePurchasePermit", {
       SaleUUID: args.saleUUID,
       EntityUUID: args.entityUUID,
-      EntityType: args.entityType,
       PurchasingWalletAddress: args.walletAddress
     });
   }
@@ -340,6 +338,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 +362,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 +394,7 @@ export {
   APIError,
   EntitySetupState,
   EntityType,
+  InvestingRegion,
   PrePurchaseFailureReason,
   PurchasePermitType,
   SaleEligibility,

package/package.json

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