@gala-chain/launchpad-sdk 5.0.3 → 5.0.4-beta.0

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

@@ -0,0 +1,180 @@
+/**
+ * Comment Types
+ *
+ * Types for pool comment operations.
+ *
+ * @category Types
+ * @since 5.9.0
+ * @since 6.0.0 - Added messageId and reactions support
+ */
+import { ReactionData } from './content-reactions.dto';
+import { PaginationMeta, HolderTierInfo, ListResult, BasePaginationOptions, UserProfileInfo } from './common';
+/**
+ * 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;
+    /** Pool ID this comment belongs to */
+    poolId: number;
+    /** 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, poolId, 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;
+            poolId: number;
+            createdAt: string;
+            user?: {
+                fullName: string;
+                profileImage?: string;
+            };
+            reactions?: ReactionData;
+            /** @since 6.5.0 */
+            holderTier?: HolderTierInfo;
+        }>;
+        meta: PaginationMeta;
+    };
+}
+/**
+ * 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;
+        poolId: number;
+        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/src/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;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAgB9G;;;;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,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,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,MAAM,EAAE,MAAM,CAAC;YACf,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,IAAI,EAAE,cAAc,CAAC;KACtB,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,MAAM,EAAE,MAAM,CAAC;QACf,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,CAMhF"}

package/dist/src/types/comments.dto.d.ts

@@ -0,0 +1,210 @@
+/**
+ * Comments Types (v6.2.0+)
+ *
+ * Types for the comments endpoints with full CRUD operations.
+ * These endpoints use tokenName-based identification and messageId for updates/deletes.
+ *
+ * @category Types
+ * @since 6.2.0
+ */
+import { PaginationMeta, UserProfileInfo, BaseContentItem } from './common';
+/**
+ * Comments validation constraints
+ */
+export declare const COMMENTS_CONSTRAINTS: {
+    readonly PAGINATION: {
+        readonly MAX_LIMIT: number;
+    };
+    readonly CONTENT: {
+        readonly MAX_LENGTH: 2000;
+    };
+};
+/**
+ * Options for getting comments via /v1/comments
+ *
+ * At least one of tokenName or userAddress must be provided.
+ */
+export interface GetCommentsOptions {
+    /** Filter by token name (e.g., "anime") */
+    tokenName?: string;
+    /** Filter by user wallet address (eth|... or 0x... format) */
+    userAddress?: string;
+    /** Page number (1-based, default: 1) */
+    page?: number;
+    /** Results per page (default: 20, max: 50) */
+    limit?: number;
+}
+/**
+ * Options for creating a comment via /v1/comments
+ */
+export interface CreateCommentOptions {
+    /** Token name to post comment on */
+    tokenName: string;
+    /** Comment content (max 2000 characters) */
+    content: string;
+}
+/**
+ * Options for updating a comment via /v1/comments/:id
+ */
+export interface UpdateCommentOptions {
+    /** New comment content (max 2000 characters) */
+    content: string;
+}
+/**
+ * User profile attached to a comment
+ * @deprecated Use UserProfileInfo from common.ts
+ * @see {@link UserProfileInfo}
+ */
+export type CommentUserProfile = UserProfileInfo;
+/**
+ * Comment item returned from v1 endpoints
+ *
+ * Uses BaseContentItem directly as comments have no additional fields
+ * beyond the base content item structure.
+ *
+ * @since 6.2.0
+ * @since 6.13.0 - Refactored to use BaseContentItem (DRY consolidation)
+ */
+export type CommentItem = BaseContentItem;
+/**
+ * Pagination metadata for comments result
+ * @deprecated Use PaginationMeta from common.ts instead
+ * @see {@link PaginationMeta}
+ */
+export type CommentsPaginationMeta = PaginationMeta;
+/**
+ * Paginated result from getComments
+ */
+export interface CommentsResult {
+    /** Array of comment items */
+    messages: CommentItem[];
+    /** Pagination metadata */
+    meta: CommentsPaginationMeta;
+}
+/**
+ * Result of creating a comment
+ */
+export interface CreateCommentResult {
+    /** The created comment */
+    comment: CommentItem;
+}
+/**
+ * Result of updating a comment
+ */
+export interface UpdateCommentResult {
+    /** The updated comment */
+    comment: CommentItem;
+}
+/**
+ * Result of deleting a comment
+ */
+export interface DeleteCommentResult {
+    /** Deletion success */
+    success: boolean;
+}
+/**
+ * Internal API response for fetching comments
+ * @internal
+ */
+export interface InternalCommentsResponse {
+    status: number;
+    error: boolean;
+    message: string;
+    data: {
+        messages: CommentItem[];
+        meta: CommentsPaginationMeta;
+    };
+}
+/**
+ * Internal API response for creating a comment
+ * Backend returns PoolMessage model fields
+ * @internal
+ */
+export interface InternalCreateCommentResponse {
+    status: number;
+    error: boolean;
+    message: string;
+    data: {
+        id: number;
+        messageId: string;
+        type: 'comment';
+        content: string;
+        userAddress: string;
+        poolId: number;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string | null;
+        pool?: {
+            id: number;
+            tokenName: string;
+            tokenImage?: string | null;
+            vaultAddress: string;
+        };
+        user?: {
+            fullName: string | null;
+            profileImage: string | null;
+        };
+    };
+}
+/**
+ * Internal API response for updating a comment
+ * @internal
+ */
+export interface InternalUpdateCommentResponse {
+    status: number;
+    error: boolean;
+    message: string;
+    data: {
+        id: number;
+        messageId: string;
+        type: 'comment';
+        content: string;
+        userAddress: string;
+        poolId: number;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string | null;
+        pool?: {
+            id: number;
+            tokenName: string;
+            tokenImage?: string | null;
+            vaultAddress: string;
+        };
+        user?: {
+            fullName: string | null;
+            profileImage: string | null;
+        };
+    };
+}
+/**
+ * Internal API response for deleting a comment
+ * @internal
+ */
+export interface InternalDeleteCommentResponse {
+    status: number;
+    error: boolean;
+    message: string;
+    data: null;
+}
+/**
+ * Validate get comments options
+ *
+ * @param options - Options to validate
+ * @throws Error if validation fails
+ */
+export declare function validateGetCommentsOptions(options: GetCommentsOptions): void;
+/**
+ * Validate create comment options
+ *
+ * @param options - Options to validate
+ * @throws Error if validation fails
+ */
+export declare function validateCreateCommentOptions(options: CreateCommentOptions): void;
+/**
+ * Validate update comment options
+ *
+ * @param options - Options to validate
+ * @throws Error if validation fails
+ */
+export declare function validateUpdateCommentOptions(options: UpdateCommentOptions): void;
+//# sourceMappingURL=comments.dto.d.ts.map

package/dist/src/types/comments.dto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"comments.dto.d.ts","sourceRoot":"","sources":["../../../src/types/comments.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAsB5E;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;CAOvB,CAAC;AAMX;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,2CAA2C;IAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8DAA8D;IAC9D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAMD;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;CACjB;AAMD;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,gDAAgD;IAChD,OAAO,EAAE,MAAM,CAAC;CACjB;AAMD;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,eAAe,CAAC;AAEjD;;;;;;;;GAQG;AACH,MAAM,MAAM,WAAW,GAAG,eAAe,CAAC;AAM1C;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,cAAc,CAAC;AAMpD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,6BAA6B;IAC7B,QAAQ,EAAE,WAAW,EAAE,CAAC;IACxB,0BAA0B;IAC1B,IAAI,EAAE,sBAAsB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,0BAA0B;IAC1B,OAAO,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,0BAA0B;IAC1B,OAAO,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,uBAAuB;IACvB,OAAO,EAAE,OAAO,CAAC;CAClB;AAMD;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE;QACJ,QAAQ,EAAE,WAAW,EAAE,CAAC;QACxB,IAAI,EAAE,sBAAsB,CAAC;KAC9B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC5C,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,IAAI,EAAE,SAAS,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,EAAE;YACL,EAAE,EAAE,MAAM,CAAC;YACX,SAAS,EAAE,MAAM,CAAC;YAClB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAC3B,YAAY,EAAE,MAAM,CAAC;SACtB,CAAC;QACF,IAAI,CAAC,EAAE;YACL,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YACxB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B,CAAC;KACH,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;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,SAAS,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,EAAE;YACL,EAAE,EAAE,MAAM,CAAC;YACX,SAAS,EAAE,MAAM,CAAC;YAClB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAC3B,YAAY,EAAE,MAAM,CAAC;SACtB,CAAC;QACF,IAAI,CAAC,EAAE;YACL,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YACxB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B,CAAC;KACH,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,0BAA0B,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI,CAwB5E;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAgChF;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAchF"}