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

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

@@ -0,0 +1,413 @@
+/**
+ * User Ban API Data Transfer Objects and Types
+ *
+ * This module defines all types and interfaces for user ban operations including
+ * creating/removing bans, listing banned users, and active user management.
+ *
+ * @since 5.5.0
+ */
+import { AddressFormat, InternalApiResponse, UserProfileInfo, ListResult, PaginationMeta, BasePaginationOptions } from './common';
+/**
+ * Ban record data
+ *
+ * @since 5.5.0
+ */
+export interface BanData {
+    /** Database ID */
+    id: number;
+    /** Banned user's wallet address */
+    userAddress: AddressFormat;
+    /** Token name (null for global bans) */
+    tokenName: string | null;
+    /** Ban reason (optional, max 500 chars) */
+    reason: string | null;
+    /** Address of user who created the ban, or 'admin' */
+    bannedBy: string;
+    /** Expiration timestamp (ISO 8601, null for permanent) */
+    expiresAt: string | null;
+    /** Creation timestamp (ISO 8601) */
+    createdAt: string;
+    /** Whether this is a permanent ban */
+    isPermanent: boolean;
+    /** Banned user's profile information (may not be present) */
+    user?: UserProfileInfo;
+}
+/**
+ * Duration presets for bans (in seconds)
+ *
+ * @example
+ * ```typescript
+ * // Ban for 24 hours
+ * await sdk.createBan({
+ *   tokenName: 'mytoken',
+ *   userAddress: '0x123...',
+ *   durationSeconds: BAN_DURATIONS.ONE_DAY,
+ * });
+ * ```
+ */
+export declare const BAN_DURATIONS: {
+    /** 1 hour (60 * 60 = 3600 seconds) */
+    readonly ONE_HOUR: number;
+    /** 24 hours (24 * 60 * 60 = 86400 seconds) */
+    readonly ONE_DAY: number;
+    /** 7 days (7 * 24 * 60 * 60 = 604800 seconds) */
+    readonly ONE_WEEK: number;
+    /** 30 days (30 * 24 * 60 * 60 = 2592000 seconds) */
+    readonly ONE_MONTH: number;
+};
+/**
+ * Type for ban duration preset values
+ */
+export type BanDurationValue = (typeof BAN_DURATIONS)[keyof typeof BAN_DURATIONS];
+/**
+ * Options for creating a ban
+ */
+export interface CreateBanOptions {
+    /** Token name for per-token ban */
+    tokenName: string;
+    /** Wallet address to ban */
+    userAddress: string;
+    /** Ban reason (optional, max 500 chars) */
+    reason?: string;
+    /** Duration in seconds (omit for permanent ban) */
+    durationSeconds?: number;
+}
+/**
+ * Result from creating a ban
+ */
+export interface CreateBanResult {
+    /** Created ban data */
+    ban: BanData;
+    /** Token name */
+    tokenName: string;
+}
+/**
+ * Options for removing a ban
+ */
+export interface RemoveBanOptions {
+    /** Token name */
+    tokenName: string;
+    /** Wallet address to unban */
+    userAddress: string;
+}
+/**
+ * Result from removing a ban
+ */
+export interface RemoveBanResult {
+    /** Whether the ban was successfully removed */
+    removed: boolean;
+    /** Token name */
+    tokenName: string;
+    /** User address that was unbanned */
+    userAddress: string;
+}
+/**
+ * Filter options for listing bans
+ *
+ * All filters are combined with AND logic:
+ * - search: Combined search on userAddress OR fullName
+ * - name: Specific filter on fullName only
+ * - userAddress: Specific filter on userAddress only
+ */
+export interface BanFilterOptions {
+    /** Combined search on userAddress OR fullName (case-insensitive, partial match) */
+    search?: string;
+    /** Filter by fullName only (case-insensitive, partial match) */
+    name?: string;
+    /** Filter by userAddress only (case-insensitive, partial match) */
+    userAddress?: string;
+}
+/**
+ * Options for listing bans
+ *
+ * @since 6.11.0 - Now extends BasePaginationOptions for DRY compliance
+ */
+export interface ListBansOptions extends BasePaginationOptions, BanFilterOptions {
+    /** Token name */
+    tokenName: string;
+}
+/**
+ * Result from listing bans
+ *
+ * @since 6.6.0 - Refactored to use generic ListResult<T> pattern
+ *
+ * The field names in pagination metadata align with backend API structure:
+ * - `total`: Total number of items
+ * - `page`: Current page (1-based)
+ * - `limit`: Items per page
+ * - `totalPages`: Total number of pages
+ */
+export type BanListResult = ListResult<BanData>;
+/**
+ * Options for checking ban status
+ */
+export interface GetBanStatusOptions {
+    /** Token name */
+    tokenName: string;
+    /** Wallet address to check */
+    userAddress: string;
+}
+/**
+ * Result from checking ban status
+ *
+ * Aligned with backend BanResponseData for consistent field naming.
+ * @see BanResponseData in backend user-ban.dto.ts
+ */
+export interface BanStatusResult {
+    /** Whether the user is banned */
+    banned: boolean;
+    /** Ban data if banned */
+    ban?: BanData;
+    /** Token name */
+    tokenName: string;
+    /** User address checked */
+    userAddress: string;
+}
+/**
+ * Ban response wrapper for list operations
+ *
+ * Generic wrapper for paginated ban response data.
+ *
+ * @since 6.x.0
+ */
+export interface BanResponseWrapper {
+    /** Array of ban records */
+    bans: BanData[];
+    /** Pagination metadata */
+    meta: PaginationMeta;
+}
+/**
+ * Active user types for filtering
+ */
+export declare const ACTIVE_USER_TYPE: {
+    /** All viewers currently connected */
+    readonly VIEWERS: "viewers";
+    /** Users who have sent chat messages */
+    readonly CHAT_PARTICIPANTS: "chat_participants";
+};
+/**
+ * Type for active user type values
+ */
+export type ActiveUserType = (typeof ACTIVE_USER_TYPE)[keyof typeof ACTIVE_USER_TYPE];
+/**
+ * Active user data
+ */
+export interface ActiveUser {
+    /** User's wallet address */
+    userAddress: AddressFormat;
+    /** User's display name (if available) */
+    fullName?: string;
+    /** User's profile image URL (if available) */
+    profileImage?: string;
+    /** Whether this user has participated in chat */
+    isChatParticipant: boolean;
+    /** When the user joined (timestamp in ms, if available) */
+    joinedAt?: number;
+}
+/**
+ * Options for getting active users
+ */
+export interface GetActiveUsersOptions extends BanFilterOptions {
+    /** Token name */
+    tokenName: string;
+    /** Type of users to fetch */
+    type?: ActiveUserType;
+}
+/**
+ * Result from getting active users
+ */
+export interface ActiveUsersResult {
+    /** Token name */
+    tokenName: string;
+    /** Type of users returned */
+    type: ActiveUserType;
+    /** Array of active users */
+    users: ActiveUser[];
+    /** Total count (may be capped) */
+    total: number;
+    /** Whether the list was truncated (over 1000 users) */
+    truncated: boolean;
+}
+/**
+ * WebSocket event: user_banned
+ *
+ * Emitted when a user is banned from a token
+ *
+ * @since 5.5.0
+ */
+export interface UserBannedEvent {
+    /** Token name (null for global ban) */
+    tokenName: string | null;
+    /** Banned user's address */
+    userAddress: string;
+    /** Ban reason */
+    reason: string | null;
+    /** Expiration timestamp (ISO 8601, null for permanent) */
+    expiresAt: string | null;
+    /** Whether this is a permanent ban */
+    isPermanent: boolean;
+}
+/**
+ * WebSocket event: user_unbanned
+ *
+ * Emitted when a user is unbanned from a token
+ *
+ * @since 5.5.0
+ */
+export interface UserUnbannedEvent {
+    /** Token name (null for global unban) */
+    tokenName: string | null;
+    /** Unbanned user's address */
+    userAddress: string;
+}
+/**
+ * WebSocket event: ban_enforcement
+ *
+ * Emitted to a user when their banned action is blocked
+ *
+ * @since 5.5.0
+ */
+export interface BanEnforcementEvent {
+    /** Token name where enforcement occurred */
+    tokenName: string;
+    /** Action that was blocked */
+    action: 'chat' | 'comment' | 'reaction';
+    /** Ban reason */
+    reason: string | null;
+    /** When the ban expires (ISO 8601, null for permanent) */
+    expiresAt: string | null;
+}
+/**
+ * Standard backend response wrapper for ban endpoints
+ * @internal
+ * @see InternalApiResponse in common.ts for the shared type
+ * @deprecated Use InternalApiResponse from common.ts directly
+ */
+export type InternalBanResponse<T = unknown> = InternalApiResponse<T>;
+/**
+ * Internal response from create ban endpoint
+ * @internal
+ */
+export interface InternalCreateBanResponse extends InternalBanResponse<BanData> {
+}
+/**
+ * Internal response from list bans endpoint
+ * @internal
+ */
+export interface InternalListBansResponse extends InternalBanResponse<{
+    bans: BanData[];
+    meta: PaginationMeta;
+}> {
+}
+/**
+ * Internal response from get ban status endpoint
+ * @internal
+ */
+export interface InternalGetBanResponse extends InternalBanResponse<BanData | null> {
+}
+/**
+ * Internal response from remove ban endpoint
+ * @internal
+ */
+export interface InternalRemoveBanResponse extends InternalBanResponse<{
+    removed: boolean;
+    userAddress: string;
+}> {
+}
+/**
+ * Internal response from get active users endpoint
+ * @internal
+ */
+export interface InternalActiveUsersResponse extends InternalBanResponse<{
+    tokenName: string;
+    type: ActiveUserType;
+    users: ActiveUser[];
+    total: number;
+    truncated: boolean;
+}> {
+}
+/** Check if a value is a valid ActiveUserType */
+export declare const isActiveUserType: (value: unknown) => value is "viewers" | "chat_participants";
+/**
+ * Type guard for BanData
+ *
+ * Validates all required fields of a ban record.
+ * Uses createStructuralTypeGuard factory for DRY compliance.
+ *
+ * @since 6.12.0 - Refactored to use factory pattern
+ */
+export declare const isBanData: (obj: unknown) => obj is BanData;
+/**
+ * Type guard for UserBannedEvent
+ *
+ * @since 6.12.0 - Refactored to use factory pattern
+ */
+export declare const isUserBannedEvent: (obj: unknown) => obj is UserBannedEvent;
+/**
+ * Type guard for UserUnbannedEvent
+ *
+ * @since 6.12.0 - Refactored to use factory pattern
+ */
+export declare const isUserUnbannedEvent: (obj: unknown) => obj is UserUnbannedEvent;
+/**
+ * Type guard for BanEnforcementEvent
+ *
+ * @since 6.12.0 - Refactored to use factory pattern
+ */
+export declare const isBanEnforcementEvent: (obj: unknown) => obj is BanEnforcementEvent;
+/**
+ * Validates ban reason length
+ *
+ * @param reason - Ban reason to validate (undefined/null means no reason provided)
+ * @returns true if reason is valid (undefined, null, or string within length limit)
+ *
+ * @remarks
+ * Accepts null for JavaScript interop - treats null same as undefined (not provided).
+ */
+export declare function isValidBanReason(reason: string | undefined | null): boolean;
+/**
+ * Validates ban duration in seconds
+ *
+ * @param durationSeconds - Duration in seconds (undefined/null means permanent ban)
+ * @returns true if duration is valid (undefined, null, or within min/max range)
+ *
+ * @remarks
+ * Accepts null for JavaScript interop - treats null same as undefined (permanent ban).
+ */
+export declare function isValidBanDuration(durationSeconds: number | undefined | null): boolean;
+/**
+ * Validates CreateBanOptions
+ *
+ * @param options - Options to validate
+ * @throws {ValidationError} If options are invalid
+ */
+export declare function validateCreateBanOptions(options: CreateBanOptions): void;
+/**
+ * Validates RemoveBanOptions
+ *
+ * @param options - Options to validate
+ * @throws {ValidationError} If options are invalid
+ */
+export declare function validateRemoveBanOptions(options: RemoveBanOptions): void;
+/**
+ * Validates ListBansOptions
+ *
+ * @param options - Options to validate
+ * @throws {ValidationError} If options are invalid
+ */
+export declare function validateListBansOptions(options: ListBansOptions): void;
+/**
+ * Validates GetBanStatusOptions
+ *
+ * @param options - Options to validate
+ * @throws {ValidationError} If options are invalid
+ */
+export declare function validateGetBanStatusOptions(options: GetBanStatusOptions): void;
+/**
+ * Validates GetActiveUsersOptions
+ *
+ * @param options - Options to validate
+ * @throws {ValidationError} If options are invalid
+ */
+export declare function validateGetActiveUsersOptions(options: GetActiveUsersOptions): void;
+//# sourceMappingURL=ban.dto.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ban.dto.d.ts","sourceRoot":"","sources":["../../../src/types/ban.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,eAAe,EAAE,UAAU,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAgBlI;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,mCAAmC;IACnC,WAAW,EAAE,aAAa,CAAC;IAC3B,wCAAwC;IACxC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,2CAA2C;IAC3C,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,sDAAsD;IACtD,QAAQ,EAAE,MAAM,CAAC;IACjB,0DAA0D;IAC1D,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,WAAW,EAAE,OAAO,CAAC;IACrB,6DAA6D;IAC7D,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAMD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,aAAa;IACxB,sCAAsC;;IAEtC,8CAA8C;;IAE9C,iDAAiD;;IAEjD,oDAAoD;;CAE5C,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAElF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,4BAA4B;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mDAAmD;IACnD,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,uBAAuB;IACvB,GAAG,EAAE,OAAO,CAAC;IACb,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB;AAMD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,+CAA+C;IAC/C,OAAO,EAAE,OAAO,CAAC;IACjB,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,WAAW,EAAE,MAAM,CAAC;CACrB;AAMD;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B,mFAAmF;IACnF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gEAAgE;IAChE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mEAAmE;IACnE,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAgB,SAAQ,qBAAqB,EAAE,gBAAgB;IAC9E,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;AAMhD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,iCAAiC;IACjC,MAAM,EAAE,OAAO,CAAC;IAChB,yBAAyB;IACzB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,2BAA2B;IAC3B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC,2BAA2B;IAC3B,IAAI,EAAE,OAAO,EAAE,CAAC;IAChB,0BAA0B;IAC1B,IAAI,EAAE,cAAc,CAAC;CACtB;AAMD;;GAEG;AACH,eAAO,MAAM,gBAAgB;IAC3B,sCAAsC;;IAEtC,wCAAwC;;CAEhC,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAEtF;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,4BAA4B;IAC5B,WAAW,EAAE,aAAa,CAAC;IAC3B,yCAAyC;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8CAA8C;IAC9C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iDAAiD;IACjD,iBAAiB,EAAE,OAAO,CAAC;IAC3B,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,IAAI,CAAC,EAAE,cAAc,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,IAAI,EAAE,cAAc,CAAC;IACrB,4BAA4B;IAC5B,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,uDAAuD;IACvD,SAAS,EAAE,OAAO,CAAC;CACpB;AAMD;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,uCAAuC;IACvC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,4BAA4B;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,0DAA0D;IAC1D,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,sCAAsC;IACtC,WAAW,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC,yCAAyC;IACzC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,8BAA8B;IAC9B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC,4CAA4C;IAC5C,SAAS,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,CAAC;IACxC,iBAAiB;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,0DAA0D;IAC1D,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAOD;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,OAAO,IAAI,mBAAmB,CAAC,CAAC,CAAC,CAAC;AAEtE;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,mBAAmB,CAAC,OAAO,CAAC;CAAG;AAElF;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB,CAAC;IACpE,IAAI,EAAE,OAAO,EAAE,CAAC;IAChB,IAAI,EAAE,cAAc,CAAC;CACtB,CAAC;CAAG;AAEL;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB,CAAC,OAAO,GAAG,IAAI,CAAC;CAAG;AAEtF;;;GAGG;AACH,MAAM,WAAW,yBAA0B,SAAQ,mBAAmB,CAAC;IACrE,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;CAAG;AAEL;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,mBAAmB,CAAC;IACvE,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;CAAG;AAML,iDAAiD;AACjD,eAAO,MAAM,gBAAgB,8DAAwC,CAAC;AAEtE;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,kCASpB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,0CAG5B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,4CAE9B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,8CAGhC,CAAC;AAEH;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,CAS3E;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,CAOtF;AAMD;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAmBxE;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAKxE;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI,CAGtE;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAK9E;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,CASlF"}

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

@@ -8,6 +8,12 @@
  * 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
  */
@@ -146,4 +152,19 @@ export declare class BurnError extends Error {
         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/src/types/burn.dto.d.ts.map

@@ -1 +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;AAE/C;;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,CAUpE;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"}
+{"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/src/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 { PaginationMeta, HolderTierInfo, BaseContentItem } 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...',
+ *   page: 2,
+ *   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;
+    /** Page number (1-based, default: 1) */
+    page?: number;
+    /** Results per page (default: 20, max: 50) */
+    limit?: 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[];
+    meta: PaginationMeta;
+}
+/**
+ * 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[];
+        meta: PaginationMeta;
+    };
+}
+/**
+ * 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/src/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,EAAE,cAAc,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAa3E;;;;;;;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,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;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,IAAI,EAAE,cAAc,CAAC;CACtB;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,IAAI,EAAE,cAAc,CAAC;KACtB,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,CAqCpF;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"}