@gala-chain/launchpad-sdk 0.4.0

package/dist/types/user.dto.d.ts

@@ -0,0 +1,330 @@
+/**
+ * User API Data Transfer Objects and Types
+ *
+ * This module defines all types and interfaces for user operations including
+ * token list fetching, faucet transfers, and GALA balance retrieval.
+ */
+import { PaginationParams, AddressFormat } from './common';
+/**
+ * User token type enumeration
+ */
+export type UserTokenType = 'all' | 'DEFI' | 'ASSET';
+/**
+ * Options for fetching user token list with filtering
+ */
+export interface GetTokenListOptions extends PaginationParams {
+    /** Token type filter */
+    type?: UserTokenType;
+    /** Optional address filter (eth|[40-hex-chars]) */
+    address?: AddressFormat;
+    /** Optional search filter */
+    search?: string;
+    /** Optional token name filter */
+    tokenName?: string;
+}
+/**
+ * Backend format for get token list options (handles type conversion)
+ */
+export interface BackendGetTokenListOptions {
+    /** Token type filter */
+    type?: string;
+    /** Address filter */
+    address?: string;
+    /** Search filter */
+    search?: string;
+    /** Token name filter */
+    tokenName?: string;
+    /** Page number as string (backend quirk) */
+    page: string;
+    /** Limit as string (backend quirk) */
+    limit: string;
+}
+/**
+ * Token information in user's token list
+ */
+export interface UserTokenInfo {
+    /** Token ID */
+    id: string;
+    /** Token name */
+    name: string;
+    /** Token symbol */
+    symbol: string;
+    /** Token type */
+    type: UserTokenType;
+    /** Token address */
+    address: AddressFormat;
+    /** User's balance */
+    balance: string;
+    /** Token decimals */
+    decimals: number;
+    /** Token metadata */
+    metadata?: {
+        description?: string;
+        image?: string;
+        [key: string]: any;
+    };
+    /** Token creation timestamp */
+    createdAt: string;
+    /** Last update timestamp */
+    updatedAt: string;
+    /** Additional token data */
+    [key: string]: any;
+}
+/**
+ * Response from get token list endpoint
+ */
+export interface GetTokenListResponse {
+    /** Array of user tokens */
+    data: UserTokenInfo[];
+    /** Pagination metadata */
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+    hasNextPage: boolean;
+    hasPrevPage: boolean;
+}
+/**
+ * Data required for transferring faucets to user
+ */
+export interface TransferFaucetsData {
+    /** Wallet address in backend format eth|[40-hex-chars] */
+    walletAddress: AddressFormat;
+    /** Amount to transfer in smallest unit (wei equivalent) */
+    amount: string;
+}
+/**
+ * Response from transfer faucets endpoint
+ */
+export interface TransferFaucetsResponse {
+    /** HTTP status code */
+    status: number;
+    /** Error flag (false for success) */
+    error: boolean;
+    /** Success/error message from backend */
+    message: string;
+    /** Optional transfer details (may be added by backend in future) */
+    data?: {
+        /** Transaction hash */
+        txHash?: string;
+        /** Amount transferred */
+        amount?: string;
+        /** Token address */
+        tokenAddress?: string;
+        /** Transfer timestamp */
+        timestamp?: string;
+        [key: string]: any;
+    };
+}
+/**
+ * Options for fetching GALA balance
+ */
+export interface FetchGalaBalanceOptions {
+    /** Wallet address in backend format eth|[40-hex-chars]. If not provided, uses SDK wallet address */
+    walletAddress?: AddressFormat;
+    /** Whether to refresh the balance from the blockchain */
+    refresh?: boolean;
+}
+/**
+ * GALA balance information
+ */
+export interface GalaBalanceInfo {
+    /** User address */
+    userAddress: AddressFormat;
+    /** GALA balance */
+    balance: string;
+    /** Balance in readable format */
+    formattedBalance?: string;
+    /** Token decimals */
+    decimals: number;
+    /** Last update timestamp */
+    lastUpdated: string;
+    /** Additional balance metadata */
+    [key: string]: any;
+}
+/**
+ * Response from fetch GALA balance endpoint
+ */
+export interface FetchGalaBalanceResponse {
+    /** Success status */
+    success: boolean;
+    /** Balance information */
+    data?: GalaBalanceInfo;
+    /** Error message if fetch failed */
+    message?: string;
+}
+/**
+ * Data required for updating user profile
+ */
+export interface UpdateProfileData {
+    /** Profile image URL or empty string */
+    profileImage: string;
+    /** User's full name */
+    fullName: string;
+    /** Wallet address in backend format eth|[40-hex-chars] */
+    walletAddress: AddressFormat;
+}
+/**
+ * Response from update profile endpoint
+ */
+export interface UpdateProfileResponse {
+    /** Success status */
+    success: boolean;
+    /** Updated profile data */
+    data?: any;
+    /** Success/error message */
+    message?: string;
+}
+/**
+ * Options for uploading profile image
+ */
+export interface UploadProfileImageOptions {
+    /** Image file - can be browser File object or Node.js Buffer */
+    file: File | Buffer;
+    /** Wallet address in backend format eth|[40-hex-chars]. If not provided, uses SDK wallet address */
+    walletAddress?: AddressFormat;
+}
+/**
+ * Response from profile image upload endpoint
+ */
+export interface UploadProfileImageResponse {
+    /** Success status */
+    success: boolean;
+    /** Upload result data */
+    data?: {
+        /** Uploaded image URL or identifier */
+        imageUrl?: string;
+        /** Image metadata */
+        [key: string]: any;
+    };
+    /** Error message if upload failed */
+    message?: string;
+}
+/**
+ * Detailed token balance information for a specific wallet
+ */
+export interface TokenBalanceInfo {
+    /** Token image URL */
+    image: string;
+    /** Token name (lowercase) */
+    name: string;
+    /** Token verification status */
+    verify: boolean;
+    /** Token symbol */
+    symbol: string;
+    /** Token quantity held by the wallet as decimal string */
+    quantity: string;
+    /** Holding price in USD */
+    holdingPriceUsd: number;
+    /** Holding price in GALA */
+    holdingPriceGala: number;
+    /** Whether the token is finalized */
+    isFinalized: boolean;
+    /** Vault address in backend format */
+    vaultAddress: string;
+}
+/**
+ * Response from token balance check endpoint
+ */
+export interface GetTokenBalanceResponse {
+    /** HTTP status code */
+    status: number;
+    /** Error status */
+    error: boolean;
+    /** Response message */
+    message: string;
+    /** Token balance data */
+    data?: {
+        /** Array of token balance information (typically single item) */
+        token: TokenBalanceInfo[];
+        /** Count of tokens returned */
+        count: number;
+    };
+}
+/**
+ * Constraints for user operations
+ */
+export declare const USER_CONSTRAINTS: {
+    /** Pagination constraints */
+    readonly PAGINATION: {
+        readonly MIN_PAGE: 1;
+        readonly MAX_PAGE: 1000;
+        readonly MIN_LIMIT: 1;
+        readonly MAX_LIMIT: 20;
+    };
+    /** User address pattern */
+    readonly USER_ADDRESS: {
+        /** User address pattern: eth|[40-hex-chars] */
+        readonly PATTERN: RegExp;
+    };
+    /** Token name constraints */
+    readonly TOKEN_NAME: {
+        readonly MIN_LENGTH: 1;
+        readonly MAX_LENGTH: 50;
+    };
+    /** Search query constraints */
+    readonly SEARCH: {
+        readonly MIN_LENGTH: 1;
+        readonly MAX_LENGTH: 100;
+    };
+    /** Faucet amount constraints */
+    readonly FAUCET_AMOUNT: {
+        /** Pattern for positive decimal numbers greater than zero */
+        readonly POSITIVE_NON_ZERO_DECIMAL: RegExp;
+    };
+    /** Profile constraints */
+    readonly PROFILE: {
+        readonly FULL_NAME: {
+            readonly MIN_LENGTH: 1;
+            readonly MAX_LENGTH: 100;
+            /** Pattern for alphabets only (first name and optional last name) */
+            readonly ALPHABETS_ONLY_PATTERN: RegExp;
+        };
+    };
+};
+/**
+ * Type guard to check if an object is valid GetTokenListOptions
+ */
+export declare function isGetTokenListOptions(obj: any): obj is GetTokenListOptions;
+/**
+ * Type guard to check if an object is valid TransferFaucetsData
+ */
+export declare function isTransferFaucetsData(obj: any): obj is TransferFaucetsData;
+/**
+ * Type guard to check if an object is valid FetchGalaBalanceOptions
+ */
+export declare function isFetchGalaBalanceOptions(obj: any): obj is FetchGalaBalanceOptions;
+/**
+ * Type guard to check if a string is a valid UserTokenType
+ */
+export declare function isUserTokenType(value: string): value is UserTokenType;
+/**
+ * Validates user address format
+ */
+export declare function isValidUserAddress(address: string): boolean;
+/**
+ * Validates search query format
+ */
+export declare function isValidSearchQuery(search: string): boolean;
+/**
+ * Validates token name format for user operations
+ */
+export declare function isValidUserTokenName(tokenName: string): boolean;
+/**
+ * Validates faucet amount format (positive, non-zero decimal)
+ */
+export declare function isValidFaucetAmount(amount: string): boolean;
+/**
+ * Type guard to check if an object is valid UpdateProfileData
+ */
+export declare function isUpdateProfileData(obj: any): obj is UpdateProfileData;
+/**
+ * Validates full name format
+ * Backend requires: alphabets only (first name and optional last name)
+ */
+export declare function isValidFullName(fullName: string): boolean;
+/**
+ * Type guard to check if an object is valid UploadProfileImageOptions
+ */
+export declare function isUploadProfileImageOptions(obj: any): obj is UploadProfileImageOptions;
+//# sourceMappingURL=user.dto.d.ts.map

package/dist/types/user.dto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.dto.d.ts","sourceRoot":"","sources":["../../src/types/user.dto.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAM3D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;AAErD;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D,wBAAwB;IACxB,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,mDAAmD;IACnD,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,6BAA6B;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qBAAqB;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oBAAoB;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wBAAwB;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,eAAe;IACf,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB;IACjB,IAAI,EAAE,aAAa,CAAC;IACpB,oBAAoB;IACpB,OAAO,EAAE,aAAa,CAAC;IACvB,qBAAqB;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,qBAAqB;IACrB,QAAQ,CAAC,EAAE;QACT,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;IACF,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,4BAA4B;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,4BAA4B;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,2BAA2B;IAC3B,IAAI,EAAE,aAAa,EAAE,CAAC;IACtB,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;CACtB;AAMD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,0DAA0D;IAC1D,aAAa,EAAE,aAAa,CAAC;IAC7B,2DAA2D;IAC3D,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,KAAK,EAAE,OAAO,CAAC;IACf,yCAAyC;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,oEAAoE;IACpE,IAAI,CAAC,EAAE;QACL,uBAAuB;QACvB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,yBAAyB;QACzB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,oBAAoB;QACpB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,yBAAyB;QACzB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAMD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,oGAAoG;IACpG,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,yDAAyD;IACzD,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,mBAAmB;IACnB,WAAW,EAAE,aAAa,CAAC;IAC3B,mBAAmB;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,iCAAiC;IACjC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,4BAA4B;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,qBAAqB;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,0BAA0B;IAC1B,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAMD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,0DAA0D;IAC1D,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,qBAAqB;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,2BAA2B;IAC3B,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,gEAAgE;IAChE,IAAI,EAAE,IAAI,GAAG,MAAM,CAAC;IACpB,oGAAoG;IACpG,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,qBAAqB;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,yBAAyB;IACzB,IAAI,CAAC,EAAE;QACL,uCAAuC;QACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,qBAAqB;QACrB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;IACF,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAMD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sBAAsB;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,MAAM,EAAE,OAAO,CAAC;IAChB,mBAAmB;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,0DAA0D;IAC1D,QAAQ,EAAE,MAAM,CAAC;IACjB,2BAA2B;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,4BAA4B;IAC5B,gBAAgB,EAAE,MAAM,CAAC;IACzB,qCAAqC;IACrC,WAAW,EAAE,OAAO,CAAC;IACrB,sCAAsC;IACtC,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,yBAAyB;IACzB,IAAI,CAAC,EAAE;QACL,iEAAiE;QACjE,KAAK,EAAE,gBAAgB,EAAE,CAAC;QAC1B,+BAA+B;QAC/B,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAMD;;GAEG;AACH,eAAO,MAAM,gBAAgB;IAC3B,6BAA6B;;;;;;;IAO7B,2BAA2B;;QAEzB,+CAA+C;;;IAGjD,6BAA6B;;;;;IAK7B,+BAA+B;;;;;IAK/B,gCAAgC;;QAE9B,6DAA6D;;;IAG/D,0BAA0B;;;;;YAKtB,qEAAqE;;;;CAIjE,CAAC;AAMX;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,mBAAmB,CAW1E;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,mBAAmB,CAO1E;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,uBAAuB,CAOlF;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,aAAa,CAErE;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAM3D;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAS1D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAS/D;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAM3D;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,iBAAiB,CAQtE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAUzD;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,yBAAyB,CAOtF"}

package/dist/utils/VaultCache.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Vault Address Cache Utility
+ *
+ * Provides centralized caching for tokenName → vaultAddress resolution.
+ * Since vault addresses never change after token creation, we can safely
+ * cache them in memory for the lifetime of the SDK instance.
+ *
+ * This eliminates redundant API calls for vault resolution across all SDK methods.
+ */
+import type { LaunchpadAPI } from '../api/LaunchpadAPI';
+/**
+ * Simple in-memory cache for vault address resolution
+ *
+ * Key benefits:
+ * - Eliminates redundant API calls for same tokenName
+ * - Vault addresses are immutable, so safe to cache indefinitely
+ * - Thread-safe singleton pattern
+ * - Process-scoped (resets on SDK restart)
+ */
+export declare class VaultCache {
+    private static cache;
+    /**
+     * Gets cached vault address for a token name
+     *
+     * @param tokenName Token name to lookup
+     * @returns Cached vault address or null if not found
+     */
+    static get(tokenName: string): string | null;
+    /**
+     * Caches vault address for a token name
+     *
+     * @param tokenName Token name (will be normalized to lowercase)
+     * @param vaultAddress Vault address to cache
+     */
+    static set(tokenName: string, vaultAddress: string): void;
+    /**
+     * Clears the entire cache
+     * Useful for testing or memory cleanup
+     */
+    static clear(): void;
+    /**
+     * Gets cache statistics
+     *
+     * @returns Object with cache size and keys
+     */
+    static getStats(): {
+        size: number;
+        keys: string[];
+    };
+    /**
+     * Resolves token name to vault address with intelligent caching
+     *
+     * This is the main method used by all APIs for vault resolution.
+     * It checks the cache first, and only makes an API call if needed.
+     *
+     * @param tokenName Token name to resolve (e.g., 'dragnrkti', 'rocketri')
+     * @param launchpadAPI LaunchpadAPI instance for making the resolution call
+     * @returns Promise<string | null> Vault address if found, null otherwise
+     * @throws ValidationError if LaunchpadAPI is not available
+     */
+    static resolveWithCache(tokenName: string, launchpadAPI?: LaunchpadAPI): Promise<string | null>;
+    /**
+     * Pre-warms the cache with known tokenName → vaultAddress mappings
+     * Useful for batch operations or initialization
+     *
+     * @param mappings Array of {tokenName, vaultAddress} objects
+     */
+    static preWarm(mappings: Array<{
+        tokenName: string;
+        vaultAddress: string;
+    }>): void;
+}
+//# sourceMappingURL=VaultCache.d.ts.map

package/dist/utils/VaultCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VaultCache.d.ts","sourceRoot":"","sources":["../../src/utils/VaultCache.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;;;;;;GAQG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAC,KAAK,CAA6B;IAEjD;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAI5C;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI;IAIzD;;;OAGG;IACH,MAAM,CAAC,KAAK,IAAI,IAAI;IAIpB;;;;OAIG;IACH,MAAM,CAAC,QAAQ,IAAI;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,EAAE,CAAA;KAAE;IAOnD;;;;;;;;;;OAUG;WACU,gBAAgB,CAC3B,SAAS,EAAE,MAAM,EACjB,YAAY,CAAC,EAAE,YAAY,GAC1B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IA4DzB;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC,GAAG,IAAI;CAKnF"}

package/dist/utils/adapters.d.ts

@@ -0,0 +1,111 @@
+import { PaginationParams } from '../types/common';
+/**
+ * Type adapters to handle backend quirks and inconsistencies
+ *
+ * The backend has some type inconsistencies (strings vs numbers) that we need
+ * to handle transparently while providing clean interfaces to SDK users.
+ */
+/**
+ * Converts clean pagination parameters to backend's expected string format
+ *
+ * Backend expects page and limit as strings, but SDK users should use numbers
+ *
+ * @param pagination Clean pagination parameters
+ * @returns Backend-compatible query parameters
+ */
+export declare function adaptPagination(pagination: PaginationParams): Record<string, string>;
+/**
+ * Converts clean query parameters to backend's expected format
+ *
+ * Handles various type conversions the backend expects:
+ * - Numbers to strings
+ * - Booleans to strings
+ * - Arrays to comma-separated strings
+ * - Removes undefined/null values
+ *
+ * @param params Clean query parameters
+ * @returns Backend-compatible query parameters
+ */
+export declare function adaptQueryParams(params: Record<string, any>): Record<string, string>;
+/**
+ * Adapts request data for backend consumption
+ *
+ * Handles common transformations:
+ * - Converts camelCase to snake_case for all fields
+ * - Ensures address formats are correct
+ * - Handles date/timestamp conversions
+ * - Recursively processes nested objects and arrays
+ *
+ * @param data Request data
+ * @param visited Set to track circular references
+ * @returns Backend-compatible request data
+ */
+export declare function adaptRequestData(data: Record<string, any>, visited?: WeakSet<object>): Record<string, any>;
+/**
+ * Adapts backend response data to clean SDK format
+ *
+ * Handles common transformations:
+ * - Converts snake_case to camelCase for all fields
+ * - Parses string numbers back to numbers where appropriate
+ * - Standardizes date formats
+ * - Recursively processes nested objects and arrays
+ *
+ * @param data Backend response data
+ * @param visited Set to track circular references
+ * @returns Clean SDK-compatible data
+ */
+export declare function adaptResponseData<T = any>(data: any, visited?: WeakSet<object>): T;
+/**
+ * Known backend type quirks and their handling
+ *
+ * This documents the specific inconsistencies we've discovered:
+ */
+export declare const BACKEND_TYPE_QUIRKS: {
+    /**
+     * Pagination parameters must be sent as strings
+     * Clean interface: { page: number, limit: number }
+     * Backend expects: { page: string, limit: string }
+     */
+    readonly PAGINATION_AS_STRINGS: true;
+    /**
+     * Some numeric fields are returned as strings
+     * We convert them back to numbers for clean interfaces
+     */
+    readonly NUMERIC_FIELDS_AS_STRINGS: "numeric-strings";
+    /**
+     * Date fields use inconsistent naming
+     * created_at vs createdAt, updated_at vs updatedAt
+     */
+    readonly INCONSISTENT_DATE_NAMING: "date-naming";
+    /**
+     * Array filters may need to be comma-separated strings
+     * Clean interface: string[]
+     * Backend expects: string (comma-separated)
+     */
+    readonly ARRAYS_AS_CSV: "arrays-csv";
+    /**
+     * Backend expects snake_case field names
+     * SDK uses camelCase for clean interfaces
+     */
+    readonly SNAKE_CASE_FIELDS: true;
+    /**
+     * Type parameter handling varies by endpoint
+     */
+    readonly TYPE_PARAMETER_HANDLING: {
+        readonly TOKEN_LIST_ENDPOINT: {
+            readonly includesType: true;
+        };
+        readonly TOKEN_HELD_ENDPOINT: {
+            readonly includesType: false;
+        };
+    };
+};
+/**
+ * Validates that an adapted value matches expected format
+ *
+ * @param adapted The adapted value
+ * @param formatType The expected format ('request' for snake_case, 'response' for camelCase)
+ * @throws Error if format is mixed or incorrect
+ */
+export declare function validateAdaptedFormat(adapted: any, formatType: 'request' | 'response'): void;
+//# sourceMappingURL=adapters.d.ts.map

package/dist/utils/adapters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapters.d.ts","sourceRoot":"","sources":["../../src/utils/adapters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAEnD;;;;;GAKG;AAEH;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAKpF;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CA6BpF;AAWD;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,kBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAiDxG;AAWD;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,kBAAgB,GAAG,CAAC,CAoDhF;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;IAC9B;;;;OAIG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;OAIG;;IAGH;;;OAGG;;IAGH;;OAEG;;;;;;;;;CASK,CAAC;AAEX;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,SAAS,GAAG,UAAU,GAAG,IAAI,CAoB5F"}