@echoxyz/sonar-core 0.12.0 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @echoxyz/sonar-core
 
+## 0.14.0
+
+### Minor Changes
+
+- Add wrapper function and hook for ReadCommitmentData endpoint
+
+## 0.13.0
+
+### Minor Changes
+
+- c551d7c: Add BasicPermitV3 type with OpensAt and ClosesAt fields for time-gated commitment windows:
+    - Add `BasicPermitV3` type with new `OpensAt` and `ClosesAt` fields
+    - Add `BASIC_V3` to `PurchasePermitType` enum
+    - Update `PurchasePermit` conditional type to handle V3
+    - Update `GeneratePurchasePermitResponse` to include `BasicPermitV3`
+    - Mark `BasicPermitV2` as deprecated
+
+- b2cd697: Rename Allocation API to Limits API to match backend changes:
+    - `fetchAllocation` → `fetchLimits`
+    - `AllocationResponse` → `LimitsResponse`
+    - Response fields renamed: `HasReservedAllocation` → `HasCustomCommitmentAmountLimit`, `ReservedAmountUSD` removed, `MaxAmountUSD` → `MaxCommitmentAmount`, added `MinCommitmentAmount`
+    - `PrePurchaseFailureReason.NO_RESERVED_ALLOCATION` → `PrePurchaseFailureReason.NO_CUSTOM_COMMITMENT_AMOUNT_LIMIT`
+
+### Patch Changes
+
+- e276112: Add `pnpm fmt` script for running prettier and format check to CI
+- 171a0db: Added support for ReadEntityInvestmentHistory API
+
 ## 0.12.0
 
 ### Minor Changes

package/README.md

@@ -72,6 +72,13 @@ export async function completeOAuthFromCallback() {
 export async function exampleCalls() {
     const { walletAddress } = useWallet(); // User's connected wallet.
 
+    // Get the authenticated user's profile information
+    const profile = await client.myProfile();
+    console.log(profile.EntityID); // Entity ID for the authenticated user
+    if (profile.EmailAddress) {
+        console.log(profile.EmailAddress); // Email address (only present if authorized with contact:email scope)
+    }
+
     // 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 });
@@ -96,9 +103,9 @@ export async function exampleCalls() {
         console.log(permit.Signature, permit.Permit);
     }
 
-    // Fetch allocation
-    const alloc = await client.fetchAllocation({ saleUUID, walletAddress });
-    console.log(alloc);
+    // Fetch limits
+    const limits = await client.fetchLimits({ saleUUID, walletAddress });
+    console.log(limits);
 }
 ```
 

package/dist/index.cjs

@@ -279,6 +279,12 @@ var SonarClient = class {
       refresh_token: args.refreshToken
     });
   }
+  async myProfile() {
+    return this.postJSON("/externalapi.MyProfile", {});
+  }
+  async readEntityInvestmentHistory() {
+    return this.postJSON("/externalapi.ReadEntityInvestmentHistory", {});
+  }
   async prePurchaseCheck(args) {
     return this.postJSON("/externalapi.PrePurchaseCheck", {
       SaleUUID: args.saleUUID,
@@ -293,8 +299,8 @@ var SonarClient = class {
       PurchasingWalletAddress: args.walletAddress
     });
   }
-  async fetchAllocation(args) {
-    return this.postJSON("/externalapi.Allocation", {
+  async fetchLimits(args) {
+    return this.postJSON("/externalapi.Limits", {
       SaleUUID: args.saleUUID,
       WalletAddress: args.walletAddress
     });
@@ -310,6 +316,16 @@ var SonarClient = class {
       SaleUUID: args.saleUUID
     });
   }
+  // Public API
+  async readCommitmentData(args) {
+    return this.postJSON(
+      "/sales.ReadCommitmentData",
+      {
+        SaleUUID: args.saleUUID
+      },
+      { includeAuth: false }
+    );
+  }
 };
 var APIError = class extends Error {
   status;
@@ -400,6 +416,7 @@ var SaleEligibility = /* @__PURE__ */ ((SaleEligibility2) => {
 var PurchasePermitType = /* @__PURE__ */ ((PurchasePermitType2) => {
   PurchasePermitType2["BASIC"] = "basic";
   PurchasePermitType2["BASIC_V2"] = "basic-v2";
+  PurchasePermitType2["BASIC_V3"] = "basic-v3";
   PurchasePermitType2["ALLOCATION"] = "allocation";
   return PurchasePermitType2;
 })(PurchasePermitType || {});
@@ -408,7 +425,6 @@ var PrePurchaseFailureReason = /* @__PURE__ */ ((PrePurchaseFailureReason2) => {
   PrePurchaseFailureReason2["WALLET_RISK"] = "wallet-risk";
   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;

package/dist/index.d.cts

@@ -72,18 +72,31 @@ type BasicPermitV2 = {
     MaxPrice: number;
     Payload: Hex;
 };
+type BasicPermitV3 = {
+    SaleSpecificEntityID: Hex;
+    SaleUUID: Hex;
+    Wallet: Hex;
+    ExpiresAt: number;
+    MinAmount: string;
+    MaxAmount: string;
+    MinPrice: number;
+    MaxPrice: number;
+    OpensAt: number;
+    ClosesAt: number;
+    Payload: Hex;
+};
 declare enum PurchasePermitType {
     BASIC = "basic",
     BASIC_V2 = "basic-v2",
+    BASIC_V3 = "basic-v3",
     ALLOCATION = "allocation"
 }
-type PurchasePermit<T extends PurchasePermitType> = T extends PurchasePermitType.BASIC ? BasicPermit : T extends PurchasePermitType.BASIC_V2 ? BasicPermitV2 : T extends PurchasePermitType.ALLOCATION ? AllocationPermit : never;
+type PurchasePermit<T extends PurchasePermitType> = T extends PurchasePermitType.BASIC ? BasicPermit : T extends PurchasePermitType.BASIC_V2 ? BasicPermitV2 : T extends PurchasePermitType.BASIC_V3 ? BasicPermitV3 : T extends PurchasePermitType.ALLOCATION ? AllocationPermit : never;
 declare enum PrePurchaseFailureReason {
     UNKNOWN = "unknown",
     WALLET_RISK = "wallet-risk",
     MAX_WALLETS_USED = "max-wallets-used",
     REQUIRES_LIVENESS = "requires-liveness",
-    NO_RESERVED_ALLOCATION = "no-reserved-allocation",
     SALE_NOT_ACTIVE = "sale-not-active",
     WALLET_NOT_LINKED = "wallet-not-linked"
 }
@@ -101,6 +114,34 @@ type EntityDetails = {
     SaleEligibility: SaleEligibility;
     InvestingRegion: InvestingRegion;
 };
+type MyProfileResponse = {
+    EntityID: string;
+    EmailAddress?: string;
+};
+type EntityInvestment = {
+    CompanyName: string;
+    Round: string;
+    InvestedOn: string;
+};
+type EntityInvestmentHistoryResponse = {
+    Investments: EntityInvestment[];
+};
+type Commitment = {
+    CommitmentID: Hex;
+    SaleSpecificEntityID: Hex;
+    PriceNumerator: string;
+    PriceDenominator: string;
+    PriceMicroUSD?: string;
+    Amounts: WalletTokenAmount[];
+    CreatedAt: string;
+    ExtraRaw: Hex;
+    ExtraDataParsed: unknown;
+};
+type WalletTokenAmount = {
+    Wallet: Hex;
+    Token: Hex;
+    Amount: string;
+};
 
 type FetchLike = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
 type PrePurchaseCheckResponse = {
@@ -109,13 +150,13 @@ type PrePurchaseCheckResponse = {
     LivenessCheckURL: string;
 };
 type GeneratePurchasePermitResponse = {
-    PermitJSON: BasicPermit | BasicPermitV2 | AllocationPermit;
+    PermitJSON: BasicPermit | BasicPermitV2 | BasicPermitV3 | AllocationPermit;
     Signature: Hex;
 };
-type AllocationResponse = {
-    HasReservedAllocation: boolean;
-    ReservedAmountUSD: string;
-    MaxAmountUSD: string;
+type LimitsResponse = {
+    HasCustomCommitmentAmountLimit: boolean;
+    MinCommitmentAmount: string;
+    MaxCommitmentAmount: string;
 };
 type ReadEntityResponse = {
     Entity: EntityDetails;
@@ -123,6 +164,16 @@ type ReadEntityResponse = {
 type ListAvailableEntitiesResponse = {
     Entities: EntityDetails[];
 };
+type ReadCommitmentDataResponse = {
+    TotalCommitmentAmount: string;
+    ClearingPriceNumerator?: string;
+    ClearingPriceDenominator?: string;
+    ClearingPriceMicroUSD?: string;
+    PaymentTokenDecimals: number;
+    OfferedTokenDecimals?: number;
+    UniqueCommitmentCount: number;
+    Commitments: Commitment[];
+};
 type TokenResponse = {
     access_token: string;
     refresh_token: string;
@@ -157,6 +208,8 @@ declare class SonarClient {
     refreshToken(args: {
         refreshToken: string;
     }): Promise<TokenResponse>;
+    myProfile(): Promise<MyProfileResponse>;
+    readEntityInvestmentHistory(): Promise<EntityInvestmentHistoryResponse>;
     prePurchaseCheck(args: {
         saleUUID: string;
         entityID: EntityID;
@@ -167,10 +220,10 @@ declare class SonarClient {
         entityID: EntityID;
         walletAddress: string;
     }): Promise<GeneratePurchasePermitResponse>;
-    fetchAllocation(args: {
+    fetchLimits(args: {
         saleUUID: string;
         walletAddress: string;
-    }): Promise<AllocationResponse>;
+    }): Promise<LimitsResponse>;
     readEntity(args: {
         saleUUID: string;
         walletAddress: string;
@@ -178,6 +231,9 @@ declare class SonarClient {
     listAvailableEntities(args: {
         saleUUID: string;
     }): Promise<ListAvailableEntitiesResponse>;
+    readCommitmentData(args: {
+        saleUUID: string;
+    }): Promise<ReadCommitmentDataResponse>;
 }
 declare class APIError extends Error {
     readonly status: number;
@@ -212,4 +268,4 @@ type CreateClientOptions = {
 };
 declare function createClient(options?: CreateClientOptions): SonarClient;
 
-export { APIError, type AllocationPermit, type AllocationResponse, type BasicPermit, type BasicPermitV2, type BuildAuthorizationUrlArgs, type ClientOptions, type CreateClientOptions, type EntityDetails, type EntityID, EntitySetupState, EntityType, type FetchLike, type GeneratePurchasePermitResponse, type Hex, InvestingRegion, type ListAvailableEntitiesResponse, type PrePurchaseCheckResponse, PrePurchaseFailureReason, type PurchasePermit, PurchasePermitType, type ReadEntityResponse, SaleEligibility, SonarClient, type StorageLike, type TokenResponse, buildAuthorizationUrl, createClient, createMemoryStorage, createWebStorage, generatePKCEParams };
+export { APIError, type AllocationPermit, type BasicPermit, type BasicPermitV2, type BasicPermitV3, type BuildAuthorizationUrlArgs, type ClientOptions, type Commitment, type CreateClientOptions, type EntityDetails, type EntityID, type EntityInvestment, type EntityInvestmentHistoryResponse, EntitySetupState, EntityType, type FetchLike, type GeneratePurchasePermitResponse, type Hex, InvestingRegion, type LimitsResponse, type ListAvailableEntitiesResponse, type MyProfileResponse, type PrePurchaseCheckResponse, PrePurchaseFailureReason, type PurchasePermit, PurchasePermitType, type ReadCommitmentDataResponse, type ReadEntityResponse, SaleEligibility, SonarClient, type StorageLike, type TokenResponse, type WalletTokenAmount, buildAuthorizationUrl, createClient, createMemoryStorage, createWebStorage, generatePKCEParams };

package/dist/index.d.ts

@@ -72,18 +72,31 @@ type BasicPermitV2 = {
     MaxPrice: number;
     Payload: Hex;
 };
+type BasicPermitV3 = {
+    SaleSpecificEntityID: Hex;
+    SaleUUID: Hex;
+    Wallet: Hex;
+    ExpiresAt: number;
+    MinAmount: string;
+    MaxAmount: string;
+    MinPrice: number;
+    MaxPrice: number;
+    OpensAt: number;
+    ClosesAt: number;
+    Payload: Hex;
+};
 declare enum PurchasePermitType {
     BASIC = "basic",
     BASIC_V2 = "basic-v2",
+    BASIC_V3 = "basic-v3",
     ALLOCATION = "allocation"
 }
-type PurchasePermit<T extends PurchasePermitType> = T extends PurchasePermitType.BASIC ? BasicPermit : T extends PurchasePermitType.BASIC_V2 ? BasicPermitV2 : T extends PurchasePermitType.ALLOCATION ? AllocationPermit : never;
+type PurchasePermit<T extends PurchasePermitType> = T extends PurchasePermitType.BASIC ? BasicPermit : T extends PurchasePermitType.BASIC_V2 ? BasicPermitV2 : T extends PurchasePermitType.BASIC_V3 ? BasicPermitV3 : T extends PurchasePermitType.ALLOCATION ? AllocationPermit : never;
 declare enum PrePurchaseFailureReason {
     UNKNOWN = "unknown",
     WALLET_RISK = "wallet-risk",
     MAX_WALLETS_USED = "max-wallets-used",
     REQUIRES_LIVENESS = "requires-liveness",
-    NO_RESERVED_ALLOCATION = "no-reserved-allocation",
     SALE_NOT_ACTIVE = "sale-not-active",
     WALLET_NOT_LINKED = "wallet-not-linked"
 }
@@ -101,6 +114,34 @@ type EntityDetails = {
     SaleEligibility: SaleEligibility;
     InvestingRegion: InvestingRegion;
 };
+type MyProfileResponse = {
+    EntityID: string;
+    EmailAddress?: string;
+};
+type EntityInvestment = {
+    CompanyName: string;
+    Round: string;
+    InvestedOn: string;
+};
+type EntityInvestmentHistoryResponse = {
+    Investments: EntityInvestment[];
+};
+type Commitment = {
+    CommitmentID: Hex;
+    SaleSpecificEntityID: Hex;
+    PriceNumerator: string;
+    PriceDenominator: string;
+    PriceMicroUSD?: string;
+    Amounts: WalletTokenAmount[];
+    CreatedAt: string;
+    ExtraRaw: Hex;
+    ExtraDataParsed: unknown;
+};
+type WalletTokenAmount = {
+    Wallet: Hex;
+    Token: Hex;
+    Amount: string;
+};
 
 type FetchLike = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
 type PrePurchaseCheckResponse = {
@@ -109,13 +150,13 @@ type PrePurchaseCheckResponse = {
     LivenessCheckURL: string;
 };
 type GeneratePurchasePermitResponse = {
-    PermitJSON: BasicPermit | BasicPermitV2 | AllocationPermit;
+    PermitJSON: BasicPermit | BasicPermitV2 | BasicPermitV3 | AllocationPermit;
     Signature: Hex;
 };
-type AllocationResponse = {
-    HasReservedAllocation: boolean;
-    ReservedAmountUSD: string;
-    MaxAmountUSD: string;
+type LimitsResponse = {
+    HasCustomCommitmentAmountLimit: boolean;
+    MinCommitmentAmount: string;
+    MaxCommitmentAmount: string;
 };
 type ReadEntityResponse = {
     Entity: EntityDetails;
@@ -123,6 +164,16 @@ type ReadEntityResponse = {
 type ListAvailableEntitiesResponse = {
     Entities: EntityDetails[];
 };
+type ReadCommitmentDataResponse = {
+    TotalCommitmentAmount: string;
+    ClearingPriceNumerator?: string;
+    ClearingPriceDenominator?: string;
+    ClearingPriceMicroUSD?: string;
+    PaymentTokenDecimals: number;
+    OfferedTokenDecimals?: number;
+    UniqueCommitmentCount: number;
+    Commitments: Commitment[];
+};
 type TokenResponse = {
     access_token: string;
     refresh_token: string;
@@ -157,6 +208,8 @@ declare class SonarClient {
     refreshToken(args: {
         refreshToken: string;
     }): Promise<TokenResponse>;
+    myProfile(): Promise<MyProfileResponse>;
+    readEntityInvestmentHistory(): Promise<EntityInvestmentHistoryResponse>;
     prePurchaseCheck(args: {
         saleUUID: string;
         entityID: EntityID;
@@ -167,10 +220,10 @@ declare class SonarClient {
         entityID: EntityID;
         walletAddress: string;
     }): Promise<GeneratePurchasePermitResponse>;
-    fetchAllocation(args: {
+    fetchLimits(args: {
         saleUUID: string;
         walletAddress: string;
-    }): Promise<AllocationResponse>;
+    }): Promise<LimitsResponse>;
     readEntity(args: {
         saleUUID: string;
         walletAddress: string;
@@ -178,6 +231,9 @@ declare class SonarClient {
     listAvailableEntities(args: {
         saleUUID: string;
     }): Promise<ListAvailableEntitiesResponse>;
+    readCommitmentData(args: {
+        saleUUID: string;
+    }): Promise<ReadCommitmentDataResponse>;
 }
 declare class APIError extends Error {
     readonly status: number;
@@ -212,4 +268,4 @@ type CreateClientOptions = {
 };
 declare function createClient(options?: CreateClientOptions): SonarClient;
 
-export { APIError, type AllocationPermit, type AllocationResponse, type BasicPermit, type BasicPermitV2, type BuildAuthorizationUrlArgs, type ClientOptions, type CreateClientOptions, type EntityDetails, type EntityID, EntitySetupState, EntityType, type FetchLike, type GeneratePurchasePermitResponse, type Hex, InvestingRegion, type ListAvailableEntitiesResponse, type PrePurchaseCheckResponse, PrePurchaseFailureReason, type PurchasePermit, PurchasePermitType, type ReadEntityResponse, SaleEligibility, SonarClient, type StorageLike, type TokenResponse, buildAuthorizationUrl, createClient, createMemoryStorage, createWebStorage, generatePKCEParams };
+export { APIError, type AllocationPermit, type BasicPermit, type BasicPermitV2, type BasicPermitV3, type BuildAuthorizationUrlArgs, type ClientOptions, type Commitment, type CreateClientOptions, type EntityDetails, type EntityID, type EntityInvestment, type EntityInvestmentHistoryResponse, EntitySetupState, EntityType, type FetchLike, type GeneratePurchasePermitResponse, type Hex, InvestingRegion, type LimitsResponse, type ListAvailableEntitiesResponse, type MyProfileResponse, type PrePurchaseCheckResponse, PrePurchaseFailureReason, type PurchasePermit, PurchasePermitType, type ReadCommitmentDataResponse, type ReadEntityResponse, SaleEligibility, SonarClient, type StorageLike, type TokenResponse, type WalletTokenAmount, buildAuthorizationUrl, createClient, createMemoryStorage, createWebStorage, generatePKCEParams };

package/dist/index.js

@@ -242,6 +242,12 @@ var SonarClient = class {
       refresh_token: args.refreshToken
     });
   }
+  async myProfile() {
+    return this.postJSON("/externalapi.MyProfile", {});
+  }
+  async readEntityInvestmentHistory() {
+    return this.postJSON("/externalapi.ReadEntityInvestmentHistory", {});
+  }
   async prePurchaseCheck(args) {
     return this.postJSON("/externalapi.PrePurchaseCheck", {
       SaleUUID: args.saleUUID,
@@ -256,8 +262,8 @@ var SonarClient = class {
       PurchasingWalletAddress: args.walletAddress
     });
   }
-  async fetchAllocation(args) {
-    return this.postJSON("/externalapi.Allocation", {
+  async fetchLimits(args) {
+    return this.postJSON("/externalapi.Limits", {
       SaleUUID: args.saleUUID,
       WalletAddress: args.walletAddress
     });
@@ -273,6 +279,16 @@ var SonarClient = class {
       SaleUUID: args.saleUUID
     });
   }
+  // Public API
+  async readCommitmentData(args) {
+    return this.postJSON(
+      "/sales.ReadCommitmentData",
+      {
+        SaleUUID: args.saleUUID
+      },
+      { includeAuth: false }
+    );
+  }
 };
 var APIError = class extends Error {
   status;
@@ -363,6 +379,7 @@ var SaleEligibility = /* @__PURE__ */ ((SaleEligibility2) => {
 var PurchasePermitType = /* @__PURE__ */ ((PurchasePermitType2) => {
   PurchasePermitType2["BASIC"] = "basic";
   PurchasePermitType2["BASIC_V2"] = "basic-v2";
+  PurchasePermitType2["BASIC_V3"] = "basic-v3";
   PurchasePermitType2["ALLOCATION"] = "allocation";
   return PurchasePermitType2;
 })(PurchasePermitType || {});
@@ -371,7 +388,6 @@ var PrePurchaseFailureReason = /* @__PURE__ */ ((PrePurchaseFailureReason2) => {
   PrePurchaseFailureReason2["WALLET_RISK"] = "wallet-risk";
   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;

package/package.json

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