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

package/dist/services/StreamChatService.d.ts

@@ -0,0 +1,259 @@
+/**
+ * Stream Chat Status Service
+ *
+ * Handles chat status operations for streams including
+ * enable/disable chat and engagement statistics.
+ *
+ * **IMPORTANT:** This service is for chat STATUS management only.
+ * For message CRUD operations, use MessagesService instead.
+ *
+ * @category Services
+ * @since 5.1.0
+ * @since 7.0.0 - Removed CRUD and pin methods (moved to MessagesService)
+ */
+import type { JwtAuth } from '../auth/JwtAuth';
+import type { EngagementStatsResult, GetEngagementStatsOptions, GlobalChatStatus } from '../types/stream-chat.dto';
+import type { HttpClient } from '../utils/http';
+import { StreamTokenServiceBase } from './StreamTokenServiceBase';
+/**
+ * Stream Chat Status Service Class
+ *
+ * Provides methods for:
+ * - Chat status management (per-token and global enable/disable)
+ * - Engagement statistics
+ *
+ * **Note:** For message CRUD operations (get, send, delete messages)
+ * and pin operations, use the unified MessagesService.
+ *
+ * @example
+ * ```typescript
+ * const chatService = new StreamChatService(httpClient, 'admin-api-key', undefined, true);
+ *
+ * // Enable/disable chat
+ * await chatService.enableChat('mytoken');
+ * await chatService.disableChat('mytoken');
+ *
+ * // Get engagement stats
+ * const stats = await chatService.getEngagementStats({ tokenName: 'mytoken' });
+ * ```
+ */
+export declare class StreamChatService extends StreamTokenServiceBase {
+    constructor(http: HttpClient, adminApiKey?: string, jwtAuth?: JwtAuth, debugMode?: boolean, userApiKey?: string);
+    /**
+     * Get chat status for a token
+     *
+     * Public endpoint - no authentication required.
+     *
+     * @param tokenName Token name (lowercase)
+     * @returns Chat status with enabled flag and detailed status
+     * @throws ValidationError if token name is invalid
+     *
+     * @since 5.4.0
+     *
+     * @example
+     * ```typescript
+     * const status = await chatService.getChatStatus('mytoken');
+     * console.log('Chat enabled:', status.enabled);
+     * console.log('Status:', status.status); // ENABLED, DISABLED, or ADMIN_DISABLED
+     * ```
+     */
+    getChatStatus(tokenName: string): Promise<{
+        enabled: boolean;
+        tokenName: string;
+        status?: string;
+    }>;
+    /**
+     * Disable chat for a token
+     *
+     * Dual-auth endpoint - supports both Admin API key and JWT (owner) auth.
+     *
+     * Authorization behavior:
+     * - **Admin (API key)**: Sets ADMIN_DISABLED - owner is locked out
+     * - **Owner (JWT)**: Sets DISABLED - owner can re-enable later
+     *
+     * When ADMIN_DISABLED, the owner cannot enable chat until an admin enables it again.
+     *
+     * @param tokenName Token name (lowercase)
+     * @returns Updated enabled status with detailed status
+     * @throws ConfigurationError if neither admin API key nor JWT is configured
+     * @throws ValidationError if token name is invalid
+     * @throws Error if owner tries to disable when ADMIN_DISABLED (403)
+     *
+     * @since 5.4.0 - Added dual-auth support (API key OR JWT)
+     *
+     * @example
+     * ```typescript
+     * // As admin (using API key)
+     * await adminChatService.disableChat('mytoken');
+     * // Sets ADMIN_DISABLED - owner locked out
+     *
+     * // As owner (using JWT)
+     * await ownerChatService.disableChat('mytoken');
+     * // Sets DISABLED - owner can re-enable
+     * ```
+     */
+    disableChat(tokenName: string): Promise<{
+        enabled: boolean;
+        tokenName: string;
+        status?: string;
+    }>;
+    /**
+     * Enable chat for a token
+     *
+     * Dual-auth endpoint - supports both Admin API key and JWT (owner) auth.
+     *
+     * Authorization behavior:
+     * - **Admin (API key)**: Sets ENABLED - clears any lock, owner regains control
+     * - **Owner (JWT)**: Sets ENABLED - only works if not ADMIN_DISABLED
+     *
+     * When ADMIN_DISABLED, only an admin can enable chat.
+     * Owners attempting to enable when ADMIN_DISABLED will get a 403 error.
+     *
+     * @param tokenName Token name (lowercase)
+     * @returns Updated enabled status with detailed status
+     * @throws ConfigurationError if neither admin API key nor JWT is configured
+     * @throws ValidationError if token name is invalid
+     * @throws Error if owner tries to enable when ADMIN_DISABLED (403)
+     *
+     * @since 5.4.0 - Added dual-auth support (API key OR JWT)
+     *
+     * @example
+     * ```typescript
+     * // As admin (using API key) - clears admin lock
+     * await adminChatService.enableChat('mytoken');
+     * // Sets ENABLED - owner can now manage chat
+     *
+     * // As owner (using JWT)
+     * await ownerChatService.enableChat('mytoken');
+     * // Sets ENABLED (fails with 403 if ADMIN_DISABLED)
+     * ```
+     */
+    enableChat(tokenName: string): Promise<{
+        enabled: boolean;
+        tokenName: string;
+        status?: string;
+    }>;
+    /**
+     * Set slow mode interval for a token's chat
+     *
+     * Throttles users to one message per N seconds.
+     * Set to 0 to disable slow mode.
+     *
+     * Dual-auth endpoint - supports both Admin API key and JWT (moderator/manager/owner).
+     *
+     * @param tokenName Token name (lowercase)
+     * @param slowModeSeconds Interval in seconds (0 = disabled, max 600)
+     * @returns Updated slow mode setting
+     * @throws {ValidationError} If token name is invalid or seconds out of range
+     *
+     * @since 8.x.0
+     * @category Chat
+     *
+     * @example
+     * ```typescript
+     * // Enable 30-second slow mode
+     * await chatService.setSlowMode('mytoken', 30);
+     *
+     * // Disable slow mode
+     * await chatService.setSlowMode('mytoken', 0);
+     * ```
+     */
+    setSlowMode(tokenName: string, slowModeSeconds: number): Promise<{
+        tokenName: string;
+        slowModeSeconds: number;
+    }>;
+    /**
+     * Get global chat status
+     *
+     * Public endpoint - no authentication required.
+     *
+     * @returns Global chat enabled status
+     *
+     * @example
+     * ```typescript
+     * const status = await chatService.getGlobalChatStatus();
+     * console.log('Chat enabled globally:', status.enabled);
+     * ```
+     */
+    getGlobalChatStatus(): Promise<GlobalChatStatus>;
+    /**
+     * Disable chat globally
+     *
+     * Admin endpoint - requires admin API key.
+     *
+     * @returns Updated global chat status
+     * @throws ConfigurationError if admin API key is not set
+     *
+     * @example
+     * ```typescript
+     * await chatService.disableGlobalChat();
+     * console.log('Chat disabled globally');
+     * ```
+     */
+    disableGlobalChat(): Promise<GlobalChatStatus>;
+    /**
+     * Enable chat globally
+     *
+     * Admin endpoint - requires admin API key.
+     *
+     * @returns Updated global chat status
+     * @throws ConfigurationError if admin API key is not set
+     *
+     * @example
+     * ```typescript
+     * await chatService.enableGlobalChat();
+     * console.log('Chat enabled globally');
+     * ```
+     */
+    enableGlobalChat(): Promise<GlobalChatStatus>;
+    /**
+     * Set global chat enabled status
+     *
+     * Admin endpoint - requires admin API key.
+     * Convenience method that enables or disables based on the boolean parameter.
+     *
+     * @param enabled Whether chat should be enabled globally
+     * @returns Updated global chat status
+     * @throws ConfigurationError if admin API key is not set
+     *
+     * @since 7.0.0
+     *
+     * @example
+     * ```typescript
+     * await chatService.setGlobalChatEnabled(false);
+     * console.log('Chat disabled globally');
+     * ```
+     */
+    setGlobalChatEnabled(enabled: boolean): Promise<GlobalChatStatus>;
+    /**
+     * Get engagement statistics for a token
+     *
+     * Dual-auth endpoint - supports both Admin API key and JWT auth.
+     * Requires MANAGE_CHAT permission when using JWT auth.
+     *
+     * Returns combined statistics for:
+     * - **Chat**: Message count and unique chatters (scoped to current/last stream session)
+     * - **Comments**: Total count and unique commenters (all-time)
+     *
+     * Used by the Studio analytics dashboard.
+     *
+     * @param options Options including tokenName
+     * @returns Engagement statistics for chat and comments
+     * @throws ValidationError if token name is invalid
+     * @throws Error if user lacks MANAGE_CHAT permission (403)
+     *
+     * @since 5.10.0
+     *
+     * @example
+     * ```typescript
+     * const stats = await chatService.getEngagementStats({ tokenName: 'mytoken' });
+     * console.log('Chat messages:', stats.chat.messageCount);
+     * console.log('Unique chatters:', stats.chat.uniqueChatters);
+     * console.log('Chat since:', stats.chat.since);
+     * console.log('Total comments:', stats.comments.count);
+     * console.log('Unique commenters:', stats.comments.uniqueCommenters);
+     * ```
+     */
+    getEngagementStats(options: GetEngagementStatsOptions): Promise<EngagementStatsResult>;
+}
+//# sourceMappingURL=StreamChatService.d.ts.map

package/dist/services/StreamChatService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StreamChatService.d.ts","sourceRoot":"","sources":["../../src/services/StreamChatService.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAG/C,OAAO,KAAK,EACV,qBAAqB,EAErB,yBAAyB,EACzB,gBAAgB,EAKjB,MAAM,0BAA0B,CAAC;AAMlC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,iBAAkB,SAAQ,sBAAsB;gBAEzD,IAAI,EAAE,UAAU,EAChB,WAAW,CAAC,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,OAAO,EACjB,SAAS,GAAE,OAAe,EAC1B,UAAU,CAAC,EAAE,MAAM;IASrB;;;;;;;;;;;;;;;;;OAiBG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IA6BzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAiCvG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAqCtG;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,WAAW,CACf,SAAS,EAAE,MAAM,EACjB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,CAAA;KAAE,CAAC;IAgC1D;;;;;;;;;;;;OAYG;IACG,mBAAmB,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAQtD;;;;;;;;;;;;;OAaG;IACG,iBAAiB,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAUpD;;;;;;;;;;;;;OAaG;IACG,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAUnD;;;;;;;;;;;;;;;;;OAiBG;IACG,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAgC7F"}

package/dist/services/StreamTokenServiceBase.d.ts

@@ -0,0 +1,404 @@
+/**
+ * Stream Token Service Base
+ *
+ * Abstract base class providing shared functionality for streaming-related services.
+ * Contains common helper methods for token validation, endpoint building,
+ * admin authentication, JWT authentication, and response handling.
+ *
+ * @category Services
+ * @since 5.1.1
+ * @internal
+ */
+import type { JwtAuth } from '../auth/JwtAuth';
+import type { InternalApiResponse, TokenNameConstraint } from '../types/common';
+import type { HttpClient } from '../utils/http';
+import { BaseService } from './BaseService';
+/**
+ * Admin API key header name
+ */
+export declare const ADMIN_API_KEY_HEADER = "x-api-key";
+/**
+ * Stream Token Service Base Class
+ *
+ * Provides shared functionality for StreamingService and StreamChatService:
+ * - Token name validation
+ * - Endpoint URL building with path parameters
+ * - Admin header management
+ * - JWT authentication support
+ * - Response data extraction
+ *
+ * @example
+ * ```typescript
+ * class MyStreamService extends StreamTokenServiceBase {
+ *   constructor(http: HttpClient, adminApiKey?: string, jwtAuth?: JwtAuth) {
+ *     super(http, adminApiKey, jwtAuth, false);
+ *   }
+ *
+ *   async getStatus(tokenName: string) {
+ *     this.validateTokenName(tokenName, MY_CONSTRAINTS.TOKEN_NAME);
+ *     const endpoint = this.buildEndpoint('/api/:tokenName/status', { tokenName });
+ *     const response = await this.http.get(endpoint, this.getAdminHeaders());
+ *     return this.extractData(response);
+ *   }
+ *
+ *   async startStream(tokenName: string) {
+ *     // JWT-protected endpoint
+ *     const endpoint = this.buildEndpoint('/api/:tokenName/start', { tokenName });
+ *     const response = await this.http.post(endpoint, {}, { headers: this.getJwtHeaders() });
+ *     return this.extractData(response);
+ *   }
+ * }
+ * ```
+ */
+export declare abstract class StreamTokenServiceBase extends BaseService {
+    /**
+     * Admin API key for authenticated endpoints
+     */
+    protected readonly adminApiKey: string | undefined;
+    /**
+     * JWT authentication manager for session-based auth
+     */
+    protected jwtAuth: JwtAuth | undefined;
+    /**
+     * Per-user API key for MultiAuthGuard endpoints
+     */
+    protected readonly userApiKey: string | undefined;
+    /**
+     * Create a new stream token service instance
+     *
+     * @param http - HTTP client for API requests
+     * @param adminApiKey - Optional admin API key for admin-only endpoints
+     * @param jwtAuth - Optional JWT auth manager for session-based auth
+     * @param debugMode - Enable debug logging
+     * @param userApiKey - Optional per-user API key for MultiAuthGuard endpoints
+     */
+    constructor(http: HttpClient, adminApiKey?: string, jwtAuth?: JwtAuth, debugMode?: boolean, userApiKey?: string);
+    /**
+     * Set the JWT authentication manager
+     *
+     * This allows dynamic configuration of JWT auth after service creation.
+     *
+     * @param jwtAuth - JWT auth manager instance
+     */
+    setJwtAuth(jwtAuth: JwtAuth): void;
+    /**
+     * Validate token name format against provided constraints
+     *
+     * @param tokenName - Token name to validate
+     * @param constraints - Token name validation constraints
+     * @throws {ValidationError} If token name is invalid
+     */
+    protected validateTokenName(tokenName: string, constraints: TokenNameConstraint): void;
+    /**
+     * Validate a required string parameter
+     *
+     * @param value - Value to validate
+     * @param fieldName - Technical field name for error details
+     * @param displayName - Human-readable name for error message
+     * @throws {ValidationError} If value is missing or not a string
+     *
+     * @example
+     * ```typescript
+     * this.validateRequiredString(assetId, 'assetId', 'Asset ID');
+     * // Throws: ValidationError('Asset ID is required', 'assetId', 'REQUIRED')
+     * ```
+     */
+    protected validateRequiredString(value: string | undefined, fieldName: string, displayName: string): void;
+    /**
+     * Validate an optional string parameter with max length constraint
+     *
+     * @param value - Value to validate (undefined/null allowed)
+     * @param fieldName - Technical field name for error details
+     * @param displayName - Human-readable name for error message
+     * @param maxLength - Maximum allowed string length
+     * @throws {ValidationError} If value is not a string or exceeds maxLength
+     *
+     * @example
+     * ```typescript
+     * this.validateOptionalString(description, 'description', 'Description', 255);
+     * this.validateOptionalString(reason, 'reason', 'Reason', 500);
+     * ```
+     */
+    protected validateOptionalString(value: string | undefined | null, fieldName: string, displayName: string, maxLength: number): void;
+    /**
+     * Validate an optional number parameter with min/max constraints
+     *
+     * @param value - Value to validate (undefined/null allowed)
+     * @param fieldName - Technical field name for error details
+     * @param displayName - Human-readable name for error message
+     * @param min - Minimum allowed value
+     * @param max - Maximum allowed value
+     * @param minMessage - Custom message suffix for minimum violation
+     * @param maxMessage - Custom message suffix for maximum violation
+     * @throws {ValidationError} If value is not a number or out of range
+     *
+     * @example
+     * ```typescript
+     * this.validateOptionalNumber(durationSeconds, 'durationSeconds', 'Duration', 60, 31536000, '1 minute', '1 year');
+     * ```
+     */
+    protected validateOptionalNumber(value: number | undefined | null, fieldName: string, displayName: string, min: number, max: number, minMessage?: string, maxMessage?: string): void;
+    /**
+     * Validate an optional ISO 8601 date string
+     *
+     * @param value - Value to validate (undefined/null allowed)
+     * @param fieldName - Technical field name for error details
+     * @param displayName - Human-readable name for error message
+     * @throws {ValidationError} If value is not a valid ISO 8601 date
+     *
+     * @example
+     * ```typescript
+     * this.validateOptionalDate(expiresAt, 'expiresAt', 'Expiration date');
+     * ```
+     */
+    protected validateOptionalDate(value: string | undefined | null, fieldName: string, displayName: string): void;
+    /**
+     * Validate a positive integer (for IDs)
+     *
+     * @param value - Value to validate
+     * @param fieldName - Technical field name for error details
+     * @param displayName - Human-readable name for error message
+     * @throws {ValidationError} If value is not a positive integer
+     *
+     * @example
+     * ```typescript
+     * this.validatePositiveInteger(id, 'id', 'API key ID');
+     * this.validatePositiveInteger(inviteId, 'inviteId', 'Invite ID');
+     * ```
+     */
+    protected validatePositiveInteger(value: number, fieldName: string, displayName: string): void;
+    /**
+     * Validate a status filter against an enum object
+     *
+     * Generic validator for status filters used in list operations.
+     * Works with any enum-like const object (OVERSEER_STATUS, INVITE_STATUS, etc.)
+     *
+     * @param status - Status value to validate (undefined allowed)
+     * @param validStatusEnum - Enum-like const object to validate against
+     * @param fieldName - Field name for error message (default: 'status')
+     * @throws {ValidationError} If status is not a valid enum value
+     *
+     * @example
+     * ```typescript
+     * this.validateStatusFilter(options.status, OVERSEER_INVITE_STATUS);
+     * this.validateStatusFilter(options.status, OVERSEER_STATUS);
+     * ```
+     */
+    protected validateStatusFilter<T extends Record<string, string>>(status: string | undefined, validStatusEnum: T, fieldName?: string): void;
+    /**
+     * Build pagination query parameters with max limit enforcement
+     *
+     * Consolidates the common pagination building pattern used across services:
+     * - Supports cursor-based pagination
+     * - Enforces max page size constraint
+     * - Only includes params that are defined
+     *
+     * @param options - Options object with optional cursor and pageSize
+     * @param maxLimit - Maximum allowed page size
+     * @returns Query params object with stringified cursor and pageSize
+     *
+     * @example
+     * ```typescript
+     * const params = this.buildPaginationParams(
+     *   { cursor: undefined, pageSize: 50 },
+     *   CONSTRAINTS.PAGINATION.MAX_LIMIT
+     * );
+     * // Result: { pageSize: '50' } (or capped at MAX_LIMIT)
+     * ```
+     *
+     * @updated 8.1.0 - Migrated to cursor-based pagination
+     */
+    protected buildPaginationParams(options: {
+        cursor?: string;
+        pageSize?: number;
+    }, maxLimit: number): Record<string, string>;
+    /**
+     * Add optional filter parameters to a query params object
+     *
+     * Consolidates the common pattern of conditionally adding filter params.
+     * Only adds params that have truthy values (not undefined, null, or empty string).
+     *
+     * @param params - Query params object to add to (mutated)
+     * @param options - Options object containing filter values
+     * @param fields - Array of field names to extract from options
+     * @returns The mutated params object (for chaining)
+     *
+     * @example
+     * ```typescript
+     * const params = this.buildPaginationParams(options, MAX_LIMIT);
+     * this.addOptionalFilterParams(params, options, ['search', 'name', 'userAddress']);
+     * ```
+     */
+    protected addOptionalFilterParams<T>(params: Record<string, string>, options: T, fields: (keyof T & string)[]): Record<string, string>;
+    /**
+     * Build endpoint URL with path parameters
+     *
+     * @param template - URL template with :param placeholders
+     * @param params - Parameters to substitute (values are lowercased and encoded)
+     * @returns Built URL with substituted parameters
+     *
+     * @example
+     * ```typescript
+     * const url = this.buildEndpoint('/api/:tokenName/status', { tokenName: 'MyToken' });
+     * // Returns: '/api/mytoken/status'
+     * ```
+     */
+    protected buildEndpoint(template: string, params: Record<string, string>): string;
+    /**
+     * Build endpoint URL with an ID parameter (case-preserved)
+     *
+     * Unlike buildEndpoint which lowercases values (for tokenName),
+     * this preserves the ID case for message IDs and other identifiers.
+     *
+     * This consolidates the duplicate buildEndpointWithId methods found in
+     * CommentsService and ChatMessagesService.
+     *
+     * @param template - URL template with :id placeholder
+     * @param id - ID value to substitute (case-preserved, URI-encoded)
+     * @returns Built URL with ID substituted
+     *
+     * @example
+     * ```typescript
+     * const url = this.buildEndpointWithId('/api/messages/:id', 'msg-1234567890123-abc');
+     * // Returns: '/api/messages/msg-1234567890123-abc'
+     * ```
+     */
+    protected buildEndpointWithId(template: string, id: string): string;
+    /**
+     * Validate token name and build endpoint URL in one step
+     *
+     * Consolidates the common pattern of validating token name then building endpoint:
+     * ```typescript
+     * this.validateTokenName(tokenName, constraints);
+     * const endpoint = this.buildEndpoint(template, { tokenName });
+     * ```
+     *
+     * @param tokenName - Token name to validate
+     * @param constraints - Token name validation constraints
+     * @param template - URL template with :tokenName placeholder
+     * @returns Built endpoint URL with validated, normalized token name
+     * @throws {ValidationError} If token name is invalid
+     *
+     * @example
+     * ```typescript
+     * const endpoint = this.validateAndBuildTokenEndpoint(
+     *   tokenName,
+     *   STREAMING_CONSTRAINTS.TOKEN_NAME,
+     *   STREAMING_ENDPOINTS.GET_STREAM_INFO
+     * );
+     * ```
+     */
+    protected validateAndBuildTokenEndpoint(tokenName: string, constraints: TokenNameConstraint, template: string): string;
+    /**
+     * Get admin headers for admin-only endpoints
+     *
+     * @returns Headers object with admin API key
+     * @throws {ConfigurationError} If admin API key is not configured
+     */
+    protected getAdminHeaders(): Record<string, string>;
+    /**
+     * Get JWT headers for session-authenticated endpoints
+     *
+     * @returns Headers object with Authorization: Bearer token
+     * @throws {ConfigurationError} If JWT auth is not configured or no token
+     */
+    protected getJwtHeaders(): Record<string, string>;
+    /**
+     * Check if JWT authentication is available
+     *
+     * @returns true if JWT auth is configured with a valid token
+     */
+    protected hasJwtAuth(): boolean;
+    /**
+     * Check if admin API key is configured
+     *
+     * @returns true if admin API key is set
+     */
+    protected hasAdminApiKey(): boolean;
+    /**
+     * Get headers for dual-auth endpoints (API key OR JWT).
+     *
+     * Dual-auth endpoints accept either admin API key or JWT authentication.
+     * This allows both admins and owners to perform the same operation with
+     * different authorization levels.
+     *
+     * Priority:
+     * 1. Admin API key (if configured) - takes precedence
+     * 2. JWT auth (if authenticated) - fallback for owners
+     *
+     * @returns Headers for authentication
+     * @throws ConfigurationError if neither auth method is available
+     *
+     * @example
+     * ```typescript
+     * // In a subclass
+     * async toggleFeatureWithDualAuth(tokenName: string) {
+     *   const headers = this.getDualAuthHeaders();
+     *   // If admin API key is set, uses admin headers
+     *   // Otherwise, requires valid JWT authentication
+     *   return this.http.post(endpoint, {}, headers);
+     * }
+     * ```
+     */
+    protected getDualAuthHeaders(): Record<string, string>;
+    /**
+     * Get headers for MultiAuthGuard endpoints (per-user API key OR JWT).
+     *
+     * MultiAuthGuard endpoints accept either a per-user API key or JWT session.
+     * This differs from getDualAuthHeaders() which uses the admin/stream API key.
+     *
+     * Priority:
+     * 1. Per-user API key (if configured) - takes precedence
+     * 2. JWT auth (if authenticated) - fallback
+     *
+     * @returns Headers for authentication
+     * @throws ConfigurationError if neither auth method is available
+     *
+     * @since 9.1.0
+     */
+    protected getMultiAuthHeaders(): Record<string, string>;
+    /**
+     * Extract data from backend response wrapper
+     *
+     * @param response - Response object with data, error, and message fields
+     * @returns Extracted data
+     * @throws {Error} If response indicates an error or has no data
+     */
+    protected extractData<T>(response: InternalApiResponse<T>): T;
+    /**
+     * Extract data from backend response, allowing null data
+     *
+     * Use this for endpoints where null data is valid (e.g., token not banned).
+     *
+     * @param response - Response object with data, error, and message fields
+     * @returns Extracted data or null
+     * @throws {Error} If response indicates an error
+     */
+    protected extractDataOrNull<T>(response: InternalApiResponse<T>): T | null;
+    /**
+     * Toggle a feature (enable/disable) for a token
+     *
+     * Shared implementation for enable/disable patterns in streaming services.
+     * Handles validation, endpoint building, admin auth, and response extraction.
+     *
+     * @param tokenName - Token name to toggle feature for
+     * @param endpoint - API endpoint template with :tokenName placeholder
+     * @param constraints - Token name validation constraints
+     * @returns Toggle result with enabled status and token name
+     * @throws {ValidationError} If token name is invalid
+     * @throws {ConfigurationError} If admin API key is not configured
+     *
+     * @example
+     * ```typescript
+     * // In StreamingService
+     * async disableStream(tokenName: string) {
+     *   return this.toggleFeature(tokenName, STREAMING_ENDPOINTS.DISABLE_STREAM, STREAMING_CONSTRAINTS.TOKEN_NAME);
+     * }
+     * ```
+     */
+    protected toggleFeature(tokenName: string, endpoint: string, constraints: TokenNameConstraint): Promise<{
+        enabled: boolean;
+        tokenName: string;
+    }>;
+}
+//# sourceMappingURL=StreamTokenServiceBase.d.ts.map

package/dist/services/StreamTokenServiceBase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StreamTokenServiceBase.d.ts","sourceRoot":"","sources":["../../src/services/StreamTokenServiceBase.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,KAAK,EAAE,mBAAmB,EAAC,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAE/E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAGhD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAgB5C;;GAEG;AACH,eAAO,MAAM,oBAAoB,cAAc,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,8BAAsB,sBAAuB,SAAQ,WAAW;IAC9D;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnD;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC;IAEvC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAElD;;;;;;;;OAQG;gBAED,IAAI,EAAE,UAAU,EAChB,WAAW,CAAC,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,OAAO,EACjB,SAAS,GAAE,OAAe,EAC1B,UAAU,CAAC,EAAE,MAAM;IAQrB;;;;;;OAMG;IACH,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAQlC;;;;;;OAMG;IACH,SAAS,CAAC,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,mBAAmB,GAAG,IAAI;IAItF;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI;IAIzG;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,sBAAsB,CAC9B,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EAChC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,GAChB,IAAI;IAIP;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,sBAAsB,CAC9B,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EAChC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,UAAU,CAAC,EAAE,MAAM,EACnB,UAAU,CAAC,EAAE,MAAM,GAClB,IAAI;IAIP;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,oBAAoB,CAC5B,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EAChC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,GAClB,IAAI;IAIP;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI;IAI9F;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,oBAAoB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC7D,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,eAAe,EAAE,CAAC,EAClB,SAAS,GAAE,MAAiB,GAC3B,IAAI;IAIP;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,SAAS,CAAC,qBAAqB,CAC7B,OAAO,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,EAC/C,QAAQ,EAAE,MAAM,GACf,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAIzB;;;;;;;;;;;;;;;;OAgBG;IACH,SAAS,CAAC,uBAAuB,CAAC,CAAC,EACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC9B,OAAO,EAAE,CAAC,EACV,MAAM,EAAE,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,EAAE,GAC3B,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAIzB;;;;;;;;;;;;OAYG;IACH,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM;IAIjF;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CAAC,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM;IAInE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,SAAS,CAAC,6BAA6B,CACrC,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,mBAAmB,EAChC,QAAQ,EAAE,MAAM,GACf,MAAM;IAKT;;;;;OAKG;IACH,SAAS,CAAC,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IASnD;;;;;OAKG;IACH,SAAS,CAAC,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IASjD;;;;OAIG;IACH,SAAS,CAAC,UAAU,IAAI,OAAO;IAI/B;;;;OAIG;IACH,SAAS,CAAC,cAAc,IAAI,OAAO;IAInC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,SAAS,CAAC,kBAAkB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAStD;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,mBAAmB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IASvD;;;;;;OAMG;IACH,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,CAAC;IAK7D;;;;;;;;OAQG;IACH,SAAS,CAAC,iBAAiB,CAAC,CAAC,EAAE,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI;IAK1E;;;;;;;;;;;;;;;;;;;;OAoBG;cACa,aAAa,CAC3B,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,mBAAmB,GAC/B,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;CAapD"}