@beep-it/sdk-core 0.1.7 → 0.3.0

package/README.md

@@ -87,7 +87,7 @@ const beep = new BeepClient({
 
 ### Server-Side Making Money
 
-Let's say you want to charge someone 5 USDT for a pack of 100 magic crystals in your game. Here's the complete server-side flow:
+Let's say you want to charge someone 5 USDC for a pack of 100 magic crystals in your game. Here's the complete server-side flow:
 
 #### The Server-Side Payment Flow
 
@@ -110,7 +110,7 @@ Seriously, all _you_ need to worry about is step 1. We handle 2-7 because we're
 const invoiceDetails = {
   description: 'A pack of 100 magic crystals',
   amount: '5.00',
-  token: SupportedToken.USDT,
+  token: SupportedToken.USDC,
   payerType: 'customer_wallet' as const,
 };
 
@@ -142,7 +142,7 @@ try {
 ```typescript
 const invoice = await beep.invoices.createInvoice({
   amount: '19.99',
-  token: SupportedToken.USDT,
+  token: SupportedToken.USDC,
   description: 'VIP Battle Pass',
   payerType: 'customer_wallet',
 });
@@ -155,7 +155,7 @@ const invoice = await beep.invoices.createInvoice({
 const product = await beep.products.createProduct({
   name: 'Magic Sword',
   price: '9.99',
-  token: SupportedToken.USDT,
+  token: SupportedToken.USDC,
   isSubscription: false,
 });
 
@@ -334,7 +334,7 @@ Clean token enum instead of remembering addresses:
 ```typescript
 import { SupportedToken } from '@beep-it/sdk-core';
 
-const token = SupportedToken.USDT; // Much cleaner!
+const token = SupportedToken.USDC; // Much cleaner!
 ```
 
 ### `TokenUtils`
@@ -345,13 +345,13 @@ Advanced token utilities:
 import { TokenUtils, SupportedToken } from '@beep-it/sdk-core';
 
 // Get the address from a token enum
-const address = TokenUtils.getTokenAddress(SupportedToken.USDT);
+const address = TokenUtils.getTokenAddress(SupportedToken.USDC);
 
 // Check if we support a token
-const isSupported = TokenUtils.isTokenSupported(SupportedToken.USDT);
+const isSupported = TokenUtils.isTokenSupported(SupportedToken.USDC);
 
 // Get a token enum from an address (reverse lookup)
-const token = TokenUtils.getTokenFromAddress('Es9vMFrzaCERmJfrF4H2FYD4KCoNkY11McCe8BenwNYB');
+const token = TokenUtils.getTokenFromAddress('EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyB7u6T');
 ```
 
 ---

package/dist/errors/index.d.ts

@@ -0,0 +1,105 @@
+/**
+ * @fileoverview Enhanced error handling for the BEEP SDK
+ * Provides typed, semantic errors with proper error codes and context
+ */
+export declare enum BeepErrorCode {
+    INVALID_API_KEY = "BEEP_1001",
+    MISSING_API_KEY = "BEEP_1002",
+    UNAUTHORIZED = "BEEP_1003",
+    INVALID_PUBLISHABLE_KEY = "BEEP_1004",
+    NETWORK_ERROR = "BEEP_2001",
+    TIMEOUT = "BEEP_2002",
+    SERVER_ERROR = "BEEP_2003",
+    PAYMENT_FAILED = "BEEP_3001",
+    PAYMENT_EXPIRED = "BEEP_3002",
+    PAYMENT_NOT_FOUND = "BEEP_3003",
+    INSUFFICIENT_FUNDS = "BEEP_3004",
+    PAYMENT_ALREADY_PROCESSED = "BEEP_3005",
+    INVOICE_NOT_FOUND = "BEEP_4001",
+    INVOICE_EXPIRED = "BEEP_4002",
+    INVOICE_ALREADY_PAID = "BEEP_4003",
+    INVALID_PARAMETER = "BEEP_5001",
+    MISSING_PARAMETER = "BEEP_5002",
+    INVALID_AMOUNT = "BEEP_5003",
+    INVALID_TOKEN = "BEEP_5004",
+    RATE_LIMIT_EXCEEDED = "BEEP_6001",
+    UNKNOWN_ERROR = "BEEP_9999"
+}
+/**
+ * Options for creating a BeepError
+ */
+export interface BeepErrorOptions {
+    code: BeepErrorCode;
+    statusCode?: number;
+    details?: Record<string, any>;
+    requestId?: string;
+}
+/**
+ * Base error class for all BEEP SDK errors
+ * Provides structured error information for better debugging and handling
+ */
+export declare class BeepError extends Error {
+    readonly code: BeepErrorCode;
+    readonly statusCode?: number;
+    readonly details?: Record<string, any>;
+    readonly timestamp: Date;
+    readonly requestId?: string;
+    constructor(message: string, options: BeepErrorOptions);
+    /**
+     * Returns a user-friendly error message
+     */
+    getUserMessage(): string;
+    /**
+     * Returns a JSON representation of the error for logging
+     */
+    toJSON(): Record<string, any>;
+}
+/**
+ * Options for specialized error classes
+ */
+export interface SpecializedErrorOptions {
+    code?: BeepErrorCode;
+    details?: Record<string, any>;
+}
+/**
+ * Authentication error - thrown when API key is invalid or missing
+ */
+export declare class BeepAuthenticationError extends BeepError {
+    constructor(message: string, options?: SpecializedErrorOptions);
+}
+/**
+ * Validation error - thrown when request parameters are invalid
+ */
+export declare class BeepValidationError extends BeepError {
+    constructor(message: string, options?: SpecializedErrorOptions);
+}
+/**
+ * Payment error - thrown when payment operations fail
+ */
+export declare class BeepPaymentError extends BeepError {
+    constructor(message: string, options?: SpecializedErrorOptions);
+}
+/**
+ * Network error - thrown when network operations fail
+ */
+export declare class BeepNetworkError extends BeepError {
+    constructor(message: string, options?: SpecializedErrorOptions);
+}
+/**
+ * Options for rate limit error
+ */
+export interface RateLimitErrorOptions extends SpecializedErrorOptions {
+    retryAfter?: number;
+}
+/**
+ * Rate limit error - thrown when API rate limits are exceeded
+ */
+export declare class BeepRateLimitError extends BeepError {
+    readonly retryAfter?: number;
+    constructor(message: string, options?: RateLimitErrorOptions);
+}
+/**
+ * Utility function to create appropriate error from axios error response
+ */
+export declare function createBeepErrorFromAxios(error: any): BeepError;
+//# sourceMappingURL=index.d.ts.map

package/dist/errors/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/errors/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,oBAAY,aAAa;IAEvB,eAAe,cAAc;IAC7B,eAAe,cAAc;IAC7B,YAAY,cAAc;IAC1B,uBAAuB,cAAc;IAGrC,aAAa,cAAc;IAC3B,OAAO,cAAc;IACrB,YAAY,cAAc;IAG1B,cAAc,cAAc;IAC5B,eAAe,cAAc;IAC7B,iBAAiB,cAAc;IAC/B,kBAAkB,cAAc;IAChC,yBAAyB,cAAc;IAGvC,iBAAiB,cAAc;IAC/B,eAAe,cAAc;IAC7B,oBAAoB,cAAc;IAGlC,iBAAiB,cAAc;IAC/B,iBAAiB,cAAc;IAC/B,cAAc,cAAc;IAC5B,aAAa,cAAc;IAG3B,mBAAmB,cAAc;IAGjC,aAAa,cAAc;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,aAAa,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC,SAAgB,IAAI,EAAE,aAAa,CAAC;IACpC,SAAgB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpC,SAAgB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9C,SAAgB,SAAS,EAAE,IAAI,CAAC;IAChC,SAAgB,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEvB,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB;IAetD;;OAEG;IACI,cAAc,IAAI,MAAM;IAmB/B;;OAEG;IACI,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAYrC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,SAAS;gBACxC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,uBAA4B;CAQnE;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,SAAS;gBACpC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,uBAA4B;CAQnE;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,SAAS;gBACjC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,uBAA4B;CAQnE;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,SAAS;gBACjC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,uBAA4B;CAOnE;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,SAAS;IAC/C,SAAgB,UAAU,CAAC,EAAE,MAAM,CAAC;gBAExB,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B;CASjE;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,GAAG,GAAG,SAAS,CA4F9D"}

package/dist/index.d.ts

@@ -7,6 +7,7 @@ import { PaymentsModule } from './modules/payments';
 import { ProductsModule } from './modules/products';
 import { WidgetModule } from './modules/widget';
 import { UserModule } from './modules/user';
+import { BeepDebugOptions } from './utils/debug';
 /**
  * Configuration options for initializing the BeepClient
  */
@@ -18,6 +19,8 @@ export interface BeepClientOptions {
      * @default 'https://api.justbeep.it'
      */
     serverUrl?: string;
+    /** Debug options for enhanced developer experience */
+    debug?: BeepDebugOptions;
 }
 /**
  * The main BEEP SDK client for server-side applications using secret API keys
@@ -43,7 +46,7 @@ export interface BeepClientOptions {
  * // Create a payment request
  * const payment = await beep.requestPayment({
  *   amount: 10.00,
- *   token: SupportedToken.USDT,
+ *   token: SupportedToken.USDC,
  *   description: 'Premium subscription'
  * });
  *
@@ -57,6 +60,7 @@ export interface BeepClientOptions {
  */
 export declare class BeepClient {
     private client;
+    private debugger;
     /** Access to product management functionality (server-side only) */
     readonly products: ProductsModule;
     /** Access to invoice management functionality (server-side only) */
@@ -90,7 +94,7 @@ export declare class BeepClient {
      * const res = await beep.payments.createPayout({
      *   amount: '1000000', // 1.0 USDC with 6 decimals
      *   destinationWalletAddress: 'DEST_ADDRESS',
-     *   chain: 'SOLANA',
+     *   chain: 'SUI',
      *   token: 'USDC',
      * });
      */
@@ -179,4 +183,6 @@ export declare class BeepPublicClient {
     constructor(options: BeepPublicClientOptions);
 }
 export type { PublicPaymentSessionRequest, PublicPaymentSessionResponse, PublicPaymentStatusResponse, EphemeralItem, } from './types/public';
+export * from './errors';
+export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,mFAAmF;IACnF,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAgB;IAE9B,oEAAoE;IACpE,SAAgB,QAAQ,EAAE,cAAc,CAAC;IAEzC,oEAAoE;IACpE,SAAgB,QAAQ,EAAE,cAAc,CAAC;IAEzC;;;;;OAKG;IACH,SAAgB,QAAQ,EAAE,cAAc,CAAC;IACzC,wCAAwC;IACxC,SAAgB,IAAI,EAAE,UAAU,CAAC;IAEjC;;;;;OAKG;gBACS,OAAO,EAAE,iBAAiB;IAoBtC;;;;;;;;;;;;;;;;OAgBG;IAGH;;;;;;;;;;;OAWG;IACU,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;CAW5C;AAOD,YAAY,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAGpG,YAAY,EACV,0BAA0B,EAC1B,+BAA+B,EAC/B,oBAAoB,EACpB,OAAO,EACP,aAAa,EACb,SAAS,GACV,MAAM,iBAAiB,CAAC;AAGzB,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAG3F,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAG3D,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAM5C,MAAM,WAAW,uBAAuB;IACtC,mEAAmE;IACnE,cAAc,EAAE,MAAM,CAAC;IACvB,mCAAmC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,MAAM,CAAgB;IAE9B;;;;;;OAMG;IACH,SAAgB,MAAM,EAAE,YAAY,CAAC;IAErC;;;;;OAKG;gBACS,OAAO,EAAE,uBAAuB;CAgB7C;AAED,YAAY,EACV,2BAA2B,EAC3B,4BAA4B,EAC5B,2BAA2B,EAC3B,aAAa,GACd,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C,OAAO,EAAgB,gBAAgB,EAA2B,MAAM,eAAe,CAAC;AAExF;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,mFAAmF;IACnF,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,KAAK,CAAC,EAAE,gBAAgB,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,QAAQ,CAAe;IAE/B,oEAAoE;IACpE,SAAgB,QAAQ,EAAE,cAAc,CAAC;IAEzC,oEAAoE;IACpE,SAAgB,QAAQ,EAAE,cAAc,CAAC;IAEzC;;;;;OAKG;IACH,SAAgB,QAAQ,EAAE,cAAc,CAAC;IACzC,wCAAwC;IACxC,SAAgB,IAAI,EAAE,UAAU,CAAC;IAEjC;;;;;OAKG;gBACS,OAAO,EAAE,iBAAiB;IA8BtC;;;;;;;;;;;;;;;;OAgBG;IAGH;;;;;;;;;;;OAWG;IACU,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;CAW5C;AAOD,YAAY,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAGpG,YAAY,EACV,0BAA0B,EAC1B,+BAA+B,EAC/B,oBAAoB,EACpB,OAAO,EACP,aAAa,EACb,SAAS,GACV,MAAM,iBAAiB,CAAC;AAGzB,YAAY,EAAE,oBAAoB,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAG3F,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAG3D,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAM5C,MAAM,WAAW,uBAAuB;IACtC,mEAAmE;IACnE,cAAc,EAAE,MAAM,CAAC;IACvB,mCAAmC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,MAAM,CAAgB;IAE9B;;;;;;OAMG;IACH,SAAgB,MAAM,EAAE,YAAY,CAAC;IAErC;;;;;OAKG;gBACS,OAAO,EAAE,uBAAuB;CAqB7C;AAED,YAAY,EACV,2BAA2B,EAC3B,4BAA4B,EAC5B,2BAA2B,EAC3B,aAAa,GACd,MAAM,gBAAgB,CAAC;AAGxB,cAAc,UAAU,CAAC;AAGzB,cAAc,SAAS,CAAC"}