@gala-chain/launchpad-sdk 5.0.4-beta.6 → 5.0.4-beta.60

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

@@ -0,0 +1,170 @@
+/**
+ * Burn API Data Transfer Objects and Types
+ *
+ * This module contains all types and interfaces related to token burning
+ * operations on GalaChain.
+ *
+ * Burn operations permanently destroy tokens. THIS IS IRREVERSIBLE.
+ * Once burned, tokens cannot be recovered or recreated.
+ */
+import type { TokenId } from '../types/common';
+/**
+ * Burn validation constraints
+ */
+export declare const BURN_CONSTRAINTS: {
+    readonly MAX_UNIQUE_KEY_LENGTH: 64;
+};
+/**
+ * Token entry for batch burn operations
+ */
+export interface BurnTokenEntry {
+    /** Flexible token identifier - accepts string, TokenClassKey, or TokenInstanceKey */
+    tokenId?: TokenId;
+    /** Token name for lookup (e.g., 'tinyevil', 'dragnrkti') - used if tokenId not provided */
+    tokenName?: string;
+    /** Amount of tokens to burn in decimal format */
+    amount: string;
+}
+/**
+ * Data required for burning tokens on GalaChain
+ *
+ * IRREVERSIBLE: Burned tokens are permanently destroyed and cannot be recovered.
+ * Use with caution. This operation reduces total supply.
+ *
+ * **Batch Behavior:** Each token in the batch is processed as part of a single GalaChain
+ * transaction. The transaction either succeeds completely (all tokens burned) or fails
+ * completely (no tokens burned). However, network errors after submission may require
+ * checking transaction status to confirm the outcome.
+ *
+ * **Batch Limits:** Maximum {@link MAX_BURN_BATCH_SIZE} tokens per operation (default: 50).
+ * This conservative limit exists due to the irreversible nature of burn operations.
+ */
+export interface BurnTokensData {
+    /** Array of tokens to burn - supports multiple token types in single transaction */
+    tokens: BurnTokenEntry[];
+    /** Optional unique key for idempotency - auto-generated if not provided */
+    uniqueKey?: string;
+    /** Optional private key override for this operation (format: '0x' + 64 hex characters) */
+    privateKey?: string;
+}
+/**
+ * Entry in the burn result showing details of each burned token
+ */
+export interface TokenBurnEntry {
+    /** Token collection (usually 'Token') */
+    collection: string;
+    /** Token category (usually 'Unit') */
+    category: string;
+    /** Token type/symbol */
+    type: string;
+    /** Additional key for the token class */
+    additionalKey: string;
+    /** Instance identifier */
+    instance: string;
+    /** Quantity burned (in base units) */
+    quantity: string;
+    /** Address that burned the tokens */
+    burnedBy: string;
+}
+/**
+ * Result of a burn operation
+ */
+export interface BurnTokensResult {
+    /** Transaction ID if available */
+    transactionId?: string;
+    /** Array of burned token entries */
+    burned: TokenBurnEntry[];
+}
+/**
+ * GalaChain response data item structure for burn operations
+ */
+export interface GalaChainBurnDataItem {
+    additionalKey?: string;
+    category?: string;
+    collection?: string;
+    type?: string;
+    instance?: string;
+    quantity?: string;
+    burnedBy?: string;
+    txnId?: string;
+    transactionId?: string;
+    id?: string;
+    TxnId?: string;
+    [key: string]: unknown;
+}
+/**
+ * GalaChain response format structure for burn operations
+ */
+export interface GalaChainBurnResponse {
+    Status: number;
+    Data: GalaChainBurnDataItem[];
+    Message?: string;
+}
+/**
+ * Internal response from burn endpoint
+ */
+export type InternalBurnResponse = GalaChainBurnResponse;
+/**
+ * Type guard to check if an object is a valid BurnTokenEntry
+ */
+export declare function isBurnTokenEntry(obj: unknown): obj is BurnTokenEntry;
+/**
+ * Type guard to check if an object is valid BurnTokensData
+ */
+export declare function isBurnTokensData(obj: unknown): obj is BurnTokensData;
+/**
+ * Maximum batch size for burn operations
+ *
+ * Burn operations are limited to this many tokens per transaction
+ * to prevent DoS and ensure reasonable transaction sizes.
+ * The limit is conservative due to the irreversible nature of burns.
+ */
+export declare const MAX_BURN_BATCH_SIZE = 50;
+/**
+ * Burn-specific error types
+ */
+export declare enum BurnErrorType {
+    TOKEN_NOT_FOUND = "TOKEN_NOT_FOUND",
+    INVALID_AMOUNT = "INVALID_AMOUNT",
+    INSUFFICIENT_BALANCE = "INSUFFICIENT_BALANCE",
+    SIGNATURE_FAILED = "SIGNATURE_FAILED",
+    NETWORK_ERROR = "NETWORK_ERROR",
+    WALLET_REQUIRED = "WALLET_REQUIRED",
+    VALIDATION_ERROR = "VALIDATION_ERROR"
+}
+/**
+ * Burn error with detailed information
+ */
+export declare class BurnError extends Error {
+    readonly type: BurnErrorType;
+    readonly details?: {
+        tokenName?: string;
+        tokenId?: TokenId;
+        amount?: string;
+        balance?: string;
+        uniqueKey?: string;
+    } | undefined;
+    constructor(message: string, type: BurnErrorType, details?: {
+        tokenName?: string;
+        tokenId?: TokenId;
+        amount?: string;
+        balance?: string;
+        uniqueKey?: string;
+    } | undefined);
+}
+/**
+ * Validates a BurnTokenEntry
+ *
+ * @param entry - Entry to validate
+ * @param index - Index in the tokens array (for error messages)
+ * @throws {ValidationError} If entry is invalid
+ */
+export declare function validateBurnTokenEntry(entry: BurnTokenEntry, index: number): void;
+/**
+ * Validates BurnTokensData
+ *
+ * @param data - Data to validate
+ * @throws {ValidationError} If data is invalid
+ */
+export declare function validateBurnTokensData(data: BurnTokensData): void;
+//# sourceMappingURL=burn.dto.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"burn.dto.d.ts","sourceRoot":"","sources":["../../src/types/burn.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAY/C;;GAEG;AACH,eAAO,MAAM,gBAAgB;;CAEnB,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,qFAAqF;IACrF,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,2FAA2F;IAC3F,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,cAAc;IAC7B,oFAAoF;IACpF,MAAM,EAAE,cAAc,EAAE,CAAC;IAEzB,2EAA2E;IAC3E,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,0FAA0F;IAC1F,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,yCAAyC;IACzC,UAAU,EAAE,MAAM,CAAC;IAEnB,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;IAEjB,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IAEb,yCAAyC;IACzC,aAAa,EAAE,MAAM,CAAC;IAEtB,0BAA0B;IAC1B,QAAQ,EAAE,MAAM,CAAC;IAEjB,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;IAEjB,qCAAqC;IACrC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kCAAkC;IAClC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,oCAAoC;IACpC,MAAM,EAAE,cAAc,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,qBAAqB,EAAE,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,CAAC;AAEzD;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,cAAc,CAQpE;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,cAAc,CAUpE;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,KAAK,CAAC;AAEtC;;GAEG;AACH,oBAAY,aAAa;IACvB,eAAe,oBAAoB;IACnC,cAAc,mBAAmB;IACjC,oBAAoB,yBAAyB;IAC7C,gBAAgB,qBAAqB;IACrC,aAAa,kBAAkB;IAC/B,eAAe,oBAAoB;IACnC,gBAAgB,qBAAqB;CACtC;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;aAGhB,IAAI,EAAE,aAAa;aACnB,OAAO,CAAC,EAAE;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;gBARD,OAAO,EAAE,MAAM,EACC,IAAI,EAAE,aAAa,EACnB,OAAO,CAAC,EAAE;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,YAAA;CAKJ;AAOD;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAajF;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAYjE"}

package/dist/types/cache-management.dto.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Cache Management DTOs
+ *
+ * Types for cache flush operations (Admin/Overseer only).
+ *
+ * @category Types
+ * @since 8.x.0
+ */
+import type { InternalApiResponse } from './common';
+/**
+ * Result of a cache flush operation.
+ */
+export interface FlushResult {
+    /** Number of cache keys that were flushed */
+    flushedCount: number;
+    /** Duration of the flush operation in milliseconds */
+    duration: number;
+    /** Target entity that was flushed (address or tokenName), if applicable */
+    target?: string;
+}
+/**
+ * Internal API response for flush operations.
+ * @internal
+ */
+export type InternalFlushResponse = InternalApiResponse<FlushResult>;
+/**
+ * Validate address for cache flush operation.
+ * @param address Wallet address
+ * @throws ValidationError if address is empty
+ */
+export declare function validateCacheFlushAddress(address: string): void;
+/**
+ * Validate token name for cache flush operation.
+ * @param tokenName Token name
+ * @throws ValidationError if tokenName is empty
+ */
+export declare function validateCacheFlushTokenName(tokenName: string): void;
+/**
+ * Validate flush all confirmation.
+ * @param confirm Confirmation flag
+ * @throws ValidationError if confirm is not true
+ */
+export declare function validateFlushAllConfirmation(confirm: boolean): void;
+//# sourceMappingURL=cache-management.dto.d.ts.map

package/dist/types/cache-management.dto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache-management.dto.d.ts","sourceRoot":"","sources":["../../src/types/cache-management.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAKH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAMpD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC;IACrB,sDAAsD;IACtD,QAAQ,EAAE,MAAM,CAAC;IACjB,2EAA2E;IAC3E,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAMD;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC;AAMrE;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAI/D;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAInE;AAED;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAQnE"}

package/dist/types/chat-messages.dto.d.ts

@@ -0,0 +1,193 @@
+/**
+ * Chat Messages Types (v6.2.0+)
+ *
+ * Types for the v1 chat-messages endpoints with full CRUD operations.
+ * These are the REST API chat types, distinct from stream-chat types
+ * which are for the `/live/:tokenName/chat` WebSocket-oriented endpoints.
+ *
+ * Endpoints:
+ * - GET /v1/chat-messages - Query chat messages with optional filters (Public)
+ * - POST /v1/chat-messages - Send a new chat message (JWT required)
+ * - PUT /v1/chat-messages/:id - Update a chat message (JWT required, author only)
+ * - DELETE /v1/chat-messages/:id - Delete a chat message (JWT or API key, author or moderator)
+ *
+ * @category Types
+ * @since 6.2.0
+ */
+import type { BaseContentItem, HolderTierInfo, PageInfo } from './common';
+/**
+ * Chat message item from API response
+ *
+ * Extends BaseContentItem with chat-specific fields (holderTier).
+ *
+ * @since 6.2.0
+ * @since 6.13.0 - Refactored to extend BaseContentItem (DRY consolidation)
+ */
+export interface ChatMessageItem extends BaseContentItem {
+    /**
+     * Holder tier badge for the message author (token-specific)
+     *
+     * Shows the author's token holding tier based on % of max supply held.
+     * Only present if the user holds tokens. Omitted for non-holders.
+     *
+     * @since 6.5.0
+     */
+    holderTier?: HolderTierInfo;
+}
+/**
+ * Options for querying chat messages via /v1/chat-messages
+ *
+ * At least one of tokenName or userAddress must be provided.
+ *
+ * @example
+ * ```typescript
+ * // Query by token
+ * const result = await sdk.chatMessages.getChatMessages({ tokenName: 'anime' });
+ *
+ * // Query by user
+ * const result = await sdk.chatMessages.getChatMessages({ userAddress: 'eth|123...' });
+ *
+ * // Query by both with pagination
+ * const result = await sdk.chatMessages.getChatMessages({
+ *   tokenName: 'anime',
+ *   userAddress: 'eth|123...',
+ *   offset: 20,
+ *   limit: 20
+ * });
+ * ```
+ */
+export interface GetChatMessagesOptions {
+    /** Filter by token name (e.g., "anime") */
+    tokenName?: string;
+    /** Filter by user wallet address (eth|... or 0x... format) */
+    userAddress?: string;
+    /** Cursor for pagination (omit for first page) */
+    cursor?: string;
+    /** Page size (default: 20, max: 50) */
+    pageSize?: number;
+}
+/**
+ * Options for creating a chat message via /v1/chat-messages
+ *
+ * Note: This uses REST semantics (Create) while stream-chat.dto uses WebSocket
+ * semantics (Send). Use this for the REST API, SendChatMessageOptions for WebSocket.
+ *
+ * @example
+ * ```typescript
+ * const result = await sdk.chatMessages.sendMessage({
+ *   tokenName: 'anime',
+ *   content: 'Hello world!'
+ * });
+ * console.log('Message sent:', result.message.id);
+ * ```
+ */
+export interface CreateChatMessageOptions {
+    /** Token name to post the message to */
+    tokenName: string;
+    /** Message content (max 500 characters) */
+    content: string;
+}
+/**
+ * Options for updating a chat message via /v1/chat-messages/:id
+ *
+ * @example
+ * ```typescript
+ * const result = await sdk.chatMessages.updateMessage(messageId, {
+ *   content: 'Updated message content'
+ * });
+ * ```
+ */
+export interface UpdateChatMessageOptions {
+    /** Updated message content (max 500 characters) */
+    content: string;
+}
+/**
+ * Result of fetching chat messages via /v1/chat-messages
+ *
+ * This includes enriched message data with user profiles and reactions.
+ * For WebSocket-based streaming chat, see stream-chat.dto types.
+ */
+export interface GetChatMessagesResult {
+    messages: ChatMessageItem[];
+    pageInfo: PageInfo;
+}
+/**
+ * Result of creating a chat message via /v1/chat-messages
+ */
+export interface CreateChatMessageResult {
+    message: ChatMessageItem;
+}
+/**
+ * Result of updating a chat message via /v1/chat-messages/:id
+ */
+export interface UpdateChatMessageResult {
+    message: ChatMessageItem;
+}
+/**
+ * Internal API response for fetching chat messages
+ * @internal
+ */
+export interface InternalGetChatMessagesResponse {
+    status: number;
+    error: boolean;
+    message: string;
+    data: {
+        messages: ChatMessageItem[];
+        pageInfo: PageInfo;
+    };
+}
+/**
+ * Internal API response for sending a chat message
+ * @internal
+ */
+export interface InternalSendChatMessageResponse {
+    status: number;
+    error: boolean;
+    message: string;
+    data: ChatMessageItem;
+}
+/**
+ * Internal API response for updating a chat message
+ * @internal
+ */
+export interface InternalUpdateChatMessageResponse {
+    status: number;
+    error: boolean;
+    message: string;
+    data: ChatMessageItem;
+}
+/**
+ * Internal API response for deleting a chat message
+ * @internal
+ */
+export interface InternalDeleteChatMessageResponse {
+    status: number;
+    error: boolean;
+    message: string;
+    data: null;
+}
+/**
+ * Validates get chat messages options
+ * @throws ValidationError if options are invalid
+ */
+export declare function validateGetChatMessagesOptions(options: GetChatMessagesOptions): void;
+/**
+ * Validates create chat message options
+ * @throws ValidationError if options are invalid
+ */
+export declare function validateCreateChatMessageOptions(options: CreateChatMessageOptions): void;
+/**
+ * Validates update chat message options
+ * @throws ValidationError if options are invalid
+ */
+export declare function validateUpdateChatMessageOptions(options: UpdateChatMessageOptions): void;
+/**
+ * Validates a chat message ID format
+ * @throws ValidationError if ID format is invalid
+ */
+export declare function validateChatMessageId(id: string): void;
+/**
+ * Type guard for ChatMessageItem
+ */
+export declare function isChatMessageItem(value: unknown): value is ChatMessageItem;
+//# sourceMappingURL=chat-messages.dto.d.ts.map

package/dist/types/chat-messages.dto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chat-messages.dto.d.ts","sourceRoot":"","sources":["../../src/types/chat-messages.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAKH,OAAO,KAAK,EAAE,eAAe,EAAC,cAAc,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAazE;;;;;;;GAOG;AACH,MAAM,WAAW,eAAgB,SAAQ,eAAe;IACtD;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC;CAC7B;AAOD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,sBAAsB;IACrC,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8DAA8D;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kDAAkD;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,wBAAwB;IACvC,wCAAwC;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,wBAAwB;IACvC,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;CACjB;AAMD;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,eAAe,EAAE,CAAC;IAC5B,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,eAAe,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,eAAe,CAAC;CAC1B;AAMD;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE;QACJ,QAAQ,EAAE,eAAe,EAAE,CAAC;QAC5B,QAAQ,EAAE,QAAQ,CAAC;KACpB,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,eAAe,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,eAAe,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,IAAI,CAAC;CACZ;AAMD;;;GAGG;AACH,wBAAgB,8BAA8B,CAAC,OAAO,EAAE,sBAAsB,GAAG,IAAI,CA0CpF;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CA0BxF;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CAexF;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAWtD;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,eAAe,CAY1E"}

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

@@ -0,0 +1,176 @@
+/**
+ * Comment Types
+ *
+ * Types for pool comment operations.
+ *
+ * @category Types
+ * @since 5.9.0
+ * @since 6.0.0 - Added messageId and reactions support
+ */
+import type { BasePaginationOptions, HolderTierInfo, ListResult, PageInfo, UserProfileInfo } from './common';
+import type { ReactionData } from './content-reactions.dto';
+/**
+ * Comment data returned from API
+ *
+ * @since 6.0.0 - Added messageId and reactions fields for unified pool messages
+ */
+export interface CommentData {
+    /** Unique comment ID (database auto-increment) */
+    id: number;
+    /**
+     * Unique message identifier for reactions integration
+     *
+     * Format: `msg-{timestamp13}-{uuid32}`
+     * Use this ID when adding/removing reactions via the content reactions API.
+     *
+     * @since 6.0.0
+     */
+    messageId: string;
+    /** Comment text content */
+    content: string;
+    /** Comment author's wallet address */
+    userAddress: string;
+    /** Comment creation timestamp */
+    createdAt: string;
+    /** User profile info (optional) */
+    user?: UserProfileInfo;
+    /**
+     * Reaction data for this comment (grouped by type with counts and user previews)
+     *
+     * @since 6.0.0
+     */
+    reactions?: ReactionData;
+    /**
+     * Holder tier badge for the comment author (token-specific)
+     *
+     * Shows the author's token holding tier based on % of max supply held.
+     * Only present if the user holds tokens. Omitted for non-holders.
+     *
+     * @since 6.5.0
+     */
+    holderTier?: HolderTierInfo;
+}
+/**
+ * Options for fetching comments
+ *
+ * @since 6.11.0 - Now extends BasePaginationOptions for DRY compliance
+ */
+export interface FetchCommentsOptions extends BasePaginationOptions {
+    /** Token name to fetch comments for */
+    tokenName: string;
+}
+/**
+ * Options for posting a comment
+ *
+ * Requires tokenName to identify the pool.
+ */
+export interface PostCommentOptions {
+    /** Token name to post comment on (required) */
+    tokenName: string;
+    /** Comment content */
+    content: string;
+}
+/**
+ * Options for deleting a comment
+ */
+export interface DeleteCommentOptions {
+    /** Comment ID to delete */
+    commentId: number;
+}
+/**
+ * Result of fetching comments
+ *
+ * @since 6.6.0 - Refactored to use generic ListResult<T> pattern
+ */
+export type FetchCommentsResult = ListResult<CommentData>;
+/**
+ * Result of posting a comment
+ */
+export interface PostCommentResult {
+    /** The created comment */
+    comment: CommentData;
+}
+/**
+ * Result of deleting a comment
+ */
+export interface DeleteCommentResult {
+    /** Deletion success */
+    success: boolean;
+}
+/**
+ * Internal API response for fetching comments
+ * @internal
+ * @since 6.0.0 - Added messageId and reactions fields
+ * @since 6.3.0 - Changed from count to meta object
+ */
+export interface InternalFetchCommentsResponse {
+    status: number;
+    error: boolean;
+    message: string;
+    data: {
+        comments: Array<{
+            id: number;
+            messageId: string;
+            content: string;
+            userAddress: string;
+            createdAt: string;
+            user?: {
+                fullName: string;
+                profileImage?: string;
+            };
+            reactions?: ReactionData;
+            /** @since 6.5.0 */
+            holderTier?: HolderTierInfo;
+        }>;
+        pageInfo: PageInfo;
+    };
+}
+/**
+ * Internal API response for posting a comment
+ * @internal
+ * @since 6.0.0 - Added messageId field
+ */
+export interface InternalPostCommentResponse {
+    status: number;
+    error: boolean;
+    message: string;
+    data: {
+        id: number;
+        messageId: string;
+        content: string;
+        userAddress: string;
+        createdAt: string;
+    };
+}
+/**
+ * Internal API response for deleting a comment
+ * @internal
+ */
+export interface InternalDeleteCommentResponse {
+    status: number;
+    error: boolean;
+    message: string;
+    data: null;
+}
+/**
+ * Validates FetchCommentsOptions
+ *
+ * @param options - Options to validate
+ * @throws {ValidationError} If options are invalid
+ */
+export declare function validateFetchCommentsOptions(options: FetchCommentsOptions): void;
+/**
+ * Validates PostCommentOptions
+ *
+ * @param options - Options to validate
+ * @throws {ValidationError} If options are invalid
+ */
+export declare function validatePostCommentOptions(options: PostCommentOptions): void;
+/**
+ * Validates DeleteCommentOptions
+ *
+ * @param options - Options to validate
+ * @throws {ValidationError} If options are invalid
+ */
+export declare function validateDeleteCommentOptions(options: DeleteCommentOptions): void;
+//# sourceMappingURL=comment.dto.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"comment.dto.d.ts","sourceRoot":"","sources":["../../src/types/comment.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAMH,OAAO,KAAK,EAAE,qBAAqB,EAAE,cAAc,EAAE,UAAU,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAM7G,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAO5D;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,kDAAkD;IAClD,EAAE,EAAE,MAAM,CAAC;IACX;;;;;;;OAOG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,2BAA2B;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,WAAW,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,mCAAmC;IACnC,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB;;;;OAIG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;IACzB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC;CAC7B;AAMD;;;;GAIG;AACH,MAAM,WAAW,oBAAqB,SAAQ,qBAAqB;IACjE,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,+CAA+C;IAC/C,SAAS,EAAE,MAAM,CAAC;IAClB,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAC;CACnB;AAMD;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,0BAA0B;IAC1B,OAAO,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,uBAAuB;IACvB,OAAO,EAAE,OAAO,CAAC;CAClB;AAOD;;;;;GAKG;AACH,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE;QACJ,QAAQ,EAAE,KAAK,CAAC;YACd,EAAE,EAAE,MAAM,CAAC;YACX,SAAS,EAAE,MAAM,CAAC;YAClB,OAAO,EAAE,MAAM,CAAC;YAChB,WAAW,EAAE,MAAM,CAAC;YACpB,SAAS,EAAE,MAAM,CAAC;YAClB,IAAI,CAAC,EAAE;gBACL,QAAQ,EAAE,MAAM,CAAC;gBACjB,YAAY,CAAC,EAAE,MAAM,CAAC;aACvB,CAAC;YACF,SAAS,CAAC,EAAE,YAAY,CAAC;YACzB,mBAAmB;YACnB,UAAU,CAAC,EAAE,cAAc,CAAC;SAC7B,CAAC,CAAC;QACH,QAAQ,EAAE,QAAQ,CAAC;KACpB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,IAAI,CAAC;CACZ;AAMD;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAGhF;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI,CAa5E;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAOhF"}