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

package/dist/services/OverseerService.d.ts

@@ -0,0 +1,524 @@
+/**
+ * Overseer Service
+ *
+ * Handles all overseer operations including creating/revoking invites,
+ * claiming invites, listing overseers, and checking status.
+ *
+ * **Key Difference from ModeratorService:**
+ * - Moderators: Token-scoped access (per-token or blanket for owner's tokens)
+ * - Overseers: Global platform access (all tokens, current and future)
+ *
+ * @category Services
+ * @since 5.9.0
+ */
+import type { JwtAuth } from '../auth/JwtAuth';
+import type { FlushResult } from '../types/cache-management.dto';
+import type { BanStatsResponse, CreateOverseerDirectOptions, CreateOverseerInviteOptions, FlagStatsResponse, InviteStatsResponse, ListOverseerInvitesOptions, ListOverseersOptions, ListUsersOptions, Overseer, OverseerInviteWithUrl, OverseerStatusResponse, OverseerSummaryResponse, PaginatedOverseerInvites, PaginatedOverseers, PublicOverseerInviteInfo, TokenBanStatsResponse, UsersListResponse, UserStatsResponse, UserSummaryResponse } from '../types/overseer.dto';
+import type { HttpClient } from '../utils/http';
+import { StreamTokenServiceBase } from './StreamTokenServiceBase';
+/**
+ * Overseer Service Class
+ *
+ * Provides methods for:
+ * - Creating and revoking overseer invites (Admin/Overseer)
+ * - Claiming invites (any authenticated user)
+ * - Listing invites and overseers (Admin/Overseer)
+ * - Getting invite details by code (public - for claim page)
+ * - Checking own overseer status (any authenticated user)
+ *
+ * Most endpoints require dual-auth (Admin API key OR JWT as Overseer).
+ * Public endpoints: getInviteByCode
+ * JWT-only endpoints: claimInvite, getMyStatus
+ *
+ * @remarks
+ * **Security**: Overseer access grants MANAGER-level permissions across ALL tokens.
+ * Be very careful who you grant overseer access to.
+ *
+ * @example
+ * ```typescript
+ * const overseerService = new OverseerService(httpClient, adminApiKey, jwtAuth, true);
+ *
+ * // Create an invite (as admin or existing overseer)
+ * const invite = await overseerService.createInvite({
+ *   description: 'Platform team member'
+ * });
+ * console.log('Share this link:', invite.invite.inviteUrl);
+ *
+ * // Claim an invite (any authenticated user)
+ * await overseerService.claimInvite('abc123...');
+ * console.log('Now an overseer!');
+ *
+ * // Check own status
+ * const status = await overseerService.getMyStatus();
+ * console.log('Is overseer:', status.isOverseer);
+ * ```
+ */
+export declare class OverseerService extends StreamTokenServiceBase {
+    constructor(http: HttpClient, adminApiKey?: string, jwtAuth?: JwtAuth, debugMode?: boolean, userApiKey?: string);
+    /**
+     * Validate invite code format
+     */
+    private validateInviteCodeFormat;
+    /**
+     * Validate wallet address format
+     */
+    private validateWalletAddressFormat;
+    /**
+     * Create an overseer invite
+     *
+     * Dual-auth endpoint - requires Admin API key OR JWT as existing Overseer.
+     *
+     * @param options Create options including optional description and expiration
+     * @returns Created invite data including the invite URL for sharing
+     * @throws ValidationError if parameters are invalid
+     * @throws ConfigurationError if neither auth method is available
+     *
+     * @example
+     * ```typescript
+     * // Create an invite with description
+     * const result = await overseerService.createInvite({
+     *   description: 'John - Platform Support Team'
+     * });
+     * console.log('Share link:', result.invite.inviteUrl);
+     *
+     * // Create invite with expiration
+     * const result = await overseerService.createInvite({
+     *   description: 'Temporary access',
+     *   expiresAt: '2025-12-31T23:59:59Z'
+     * });
+     * ```
+     */
+    createInvite(options?: CreateOverseerInviteOptions): Promise<{
+        invite: OverseerInviteWithUrl;
+    }>;
+    /**
+     * List all overseer invites
+     *
+     * Dual-auth endpoint - requires Admin API key OR JWT as existing Overseer.
+     *
+     * @param options Optional filter and cursor-based pagination options
+     * @returns Paginated list of invites
+     * @throws ConfigurationError if neither auth method is available
+     * @updated 8.1.0 - Migrated to cursor-based pagination
+     *
+     * @example
+     * ```typescript
+     * // Get all invites
+     * const result = await overseerService.listInvites({ pageSize: 20 });
+     * console.log('Total invites:', result.pageInfo.totalCount);
+     *
+     * // Filter by status
+     * const pending = await overseerService.listInvites({
+     *   status: 'PENDING',
+     *   pageSize: 20
+     * });
+     *
+     * // Paginate to next page (cursor-based)
+     * if (result.pageInfo.hasNextPage) {
+     *   const page2 = await overseerService.listInvites({
+     *     pageSize: 20,
+     *     cursor: result.pageInfo.nextCursor
+     *   });
+     * }
+     * ```
+     */
+    listInvites(options?: ListOverseerInvitesOptions): Promise<PaginatedOverseerInvites>;
+    /**
+     * Get invite details by code (public endpoint)
+     *
+     * This is a public endpoint used by the frontend claim page to display
+     * invite information before the user logs in to claim.
+     *
+     * @param inviteCode The invite code from the magic link URL
+     * @returns Public invite information (description, status, inviter info)
+     * @throws ValidationError if invite code format is invalid
+     * @throws Error if invite not found (404)
+     *
+     * @example
+     * ```typescript
+     * const info = await overseerService.getInviteByCode('abc123...');
+     * console.log(`Invited by: ${info.invitedBy.fullName || info.invitedBy.address}`);
+     * console.log(`Status: ${info.status}`);
+     * ```
+     */
+    getInviteByCode(inviteCode: string): Promise<PublicOverseerInviteInfo>;
+    /**
+     * Revoke an overseer invite
+     *
+     * Dual-auth endpoint - requires Admin API key OR JWT as existing Overseer.
+     * This revokes the invite, preventing it from being claimed. If already claimed,
+     * the overseer loses access.
+     *
+     * @param inviteId The ID of the invite to revoke
+     * @throws ValidationError if invite ID is invalid
+     * @throws ConfigurationError if neither auth method is available
+     * @throws Error if invite not found (404)
+     *
+     * @example
+     * ```typescript
+     * await overseerService.revokeInvite(123);
+     * console.log('Invite revoked');
+     * ```
+     */
+    revokeInvite(inviteId: number): Promise<void>;
+    /**
+     * Claim an overseer invite
+     *
+     * JWT-authenticated endpoint - requires the user to be logged in.
+     * The authenticated user's wallet becomes an overseer with global access.
+     *
+     * @param inviteCode The invite code from the magic link URL
+     * @returns The claimed invite data
+     * @throws ValidationError if invite code is invalid or invite already claimed/revoked/expired
+     * @throws ConfigurationError if JWT is not configured
+     *
+     * @example
+     * ```typescript
+     * const result = await overseerService.claimInvite('abc123...');
+     * console.log('Now an overseer! Status:', result.invite.status);
+     * ```
+     */
+    claimInvite(inviteCode: string): Promise<{
+        invite: OverseerInviteWithUrl;
+    }>;
+    /**
+     * List all overseers
+     *
+     * Dual-auth endpoint - requires Admin API key OR JWT as existing Overseer.
+     *
+     * @param options Optional filter and cursor-based pagination options
+     * @returns Paginated list of overseers
+     * @throws ConfigurationError if neither auth method is available
+     * @updated 8.1.0 - Migrated to cursor-based pagination
+     *
+     * @example
+     * ```typescript
+     * // Get all overseers
+     * const result = await overseerService.listOverseers({ pageSize: 20 });
+     * console.log('Total overseers:', result.pageInfo.totalCount);
+     *
+     * // Filter by status
+     * const active = await overseerService.listOverseers({
+     *   status: 'ACTIVE',
+     *   pageSize: 20
+     * });
+     *
+     * // Paginate to next page (cursor-based)
+     * if (result.pageInfo.hasNextPage) {
+     *   const page2 = await overseerService.listOverseers({
+     *     pageSize: 20,
+     *     cursor: result.pageInfo.nextCursor
+     *   });
+     * }
+     * ```
+     */
+    listOverseers(options?: ListOverseersOptions): Promise<PaginatedOverseers>;
+    /**
+     * Create an overseer directly (bypassing invite flow)
+     *
+     * Dual-auth endpoint - requires Admin API key OR JWT as existing Overseer.
+     * This directly promotes a user to overseer status without requiring them
+     * to claim an invite. A synthetic invite record is created for audit trail.
+     *
+     * Use this when you need to promote someone programmatically without
+     * requiring their interaction (e.g., CLI admin tools, automated tests).
+     *
+     * @param options The options for creating the overseer
+     * @returns The created overseer record
+     * @throws ValidationError if address format is invalid
+     * @throws ConfigurationError if neither auth method is available
+     * @throws Error if user is already an overseer (400)
+     *
+     * @since 8.3.0
+     *
+     * @example
+     * ```typescript
+     * // Promote a user to overseer
+     * const result = await overseerService.createOverseerDirect({
+     *   userAddress: 'eth|0x1234567890abcdef1234567890abcdef12345678',
+     *   description: 'Platform team - John'
+     * });
+     * console.log('Overseer created:', result.overseer.userAddress);
+     * ```
+     */
+    createOverseerDirect(options: CreateOverseerDirectOptions): Promise<{
+        overseer: Overseer;
+    }>;
+    /**
+     * Revoke an overseer's access
+     *
+     * Dual-auth endpoint - requires Admin API key OR JWT as existing Overseer.
+     * This revokes the overseer's global platform access.
+     *
+     * @param address The wallet address of the overseer to revoke
+     * @throws ValidationError if address format is invalid
+     * @throws ConfigurationError if neither auth method is available
+     * @throws Error if overseer not found (404)
+     *
+     * @example
+     * ```typescript
+     * await overseerService.revokeOverseer('eth|1234567890abcdef...');
+     * console.log('Overseer access revoked');
+     * ```
+     */
+    revokeOverseer(address: string): Promise<void>;
+    /**
+     * Check own overseer status
+     *
+     * JWT-authenticated endpoint. Returns whether the authenticated user
+     * is currently an active overseer and their details if so.
+     *
+     * @returns Overseer status including details if active
+     * @throws ConfigurationError if JWT is not configured
+     *
+     * @example
+     * ```typescript
+     * const status = await overseerService.getMyStatus();
+     * if (status.isOverseer) {
+     *   console.log('You are an overseer!');
+     *   console.log('Access granted:', status.overseer?.createdAt);
+     * } else {
+     *   console.log('You are not an overseer');
+     * }
+     * ```
+     */
+    getMyStatus(): Promise<OverseerStatusResponse>;
+    /**
+     * Get platform summary for CCTV dashboard
+     *
+     * Dual-auth endpoint - requires Admin API key OR JWT as existing Overseer.
+     * Returns quick counts for the overseer dashboard: active streams, viewers,
+     * pending flags, and total pools.
+     *
+     * @returns Platform summary with counts
+     * @throws ConfigurationError if neither auth method is available
+     *
+     * @example
+     * ```typescript
+     * const summary = await overseerService.getSummary();
+     * console.log('Active streams:', summary.activeStreams);
+     * console.log('Total viewers:', summary.totalViewers);
+     * console.log('Pending flags:', summary.pendingFlags);
+     * console.log('Total pools:', summary.totalPools);
+     * ```
+     */
+    getSummary(): Promise<OverseerSummaryResponse>;
+    /**
+     * Get ban stats for the banned users tab
+     *
+     * @returns Ban counts
+     * @example
+     * ```typescript
+     * const stats = await overseerService.getBanStats();
+     * console.log('Total bans:', stats.total);
+     * ```
+     */
+    getBanStats(): Promise<BanStatsResponse>;
+    /**
+     * Get token ban stats for the delisted tokens tab
+     *
+     * @returns Token ban counts
+     * @example
+     * ```typescript
+     * const stats = await overseerService.getTokenBanStats();
+     * console.log('Delisted tokens:', stats.total);
+     * ```
+     */
+    getTokenBanStats(): Promise<TokenBanStatsResponse>;
+    /**
+     * Get invite stats for the overseer invites tab
+     *
+     * @returns Invite counts by status
+     * @example
+     * ```typescript
+     * const stats = await overseerService.getInviteStats();
+     * console.log('Total:', stats.total, 'Pending:', stats.pending);
+     * ```
+     */
+    getInviteStats(): Promise<InviteStatsResponse>;
+    /**
+     * Get flag stats for the content flags tab
+     *
+     * @returns Flag counts by status
+     * @example
+     * ```typescript
+     * const stats = await overseerService.getFlagStats();
+     * console.log('Pending:', stats.pending, 'Actioned:', stats.actioned);
+     * ```
+     */
+    getFlagStats(): Promise<FlagStatsResponse>;
+    /**
+     * Get user stats for the users management tab
+     *
+     * @returns User counts (total, flagged, banned)
+     * @example
+     * ```typescript
+     * const stats = await overseerService.getUserStats();
+     * console.log('Total:', stats.totalUsers, 'Flagged:', stats.flaggedUsers);
+     * ```
+     */
+    getUserStats(): Promise<UserStatsResponse>;
+    /**
+     * List users with activity metrics (Admin/Overseer only)
+     *
+     * Dual-auth endpoint - requires Admin API key OR JWT as existing Overseer.
+     * Supports filtering and pagination.
+     *
+     * @param options List options including search, sorting, and cursor-based pagination
+     * @returns Paginated list of users with activity metrics
+     * @throws ConfigurationError if neither auth method is available
+     * @throws ValidationError if options are invalid
+     * @updated 8.1.0 - Migrated to cursor-based pagination
+     *
+     * @example
+     * ```typescript
+     * // Get first page of users
+     * const result = await overseerService.listOverseerUsers({ pageSize: 20 });
+     *
+     * // Search for specific user
+     * const result = await overseerService.listOverseerUsers({
+     *   search: 'alice',
+     *   pageSize: 10
+     * });
+     *
+     * // Sort by activity
+     * const result = await overseerService.listOverseerUsers({
+     *   sortBy: 'activity',
+     *   sortOrder: 'desc',
+     *   pageSize: 20
+     * });
+     *
+     * // Paginate to next page (cursor-based)
+     * if (result.pageInfo.hasNextPage) {
+     *   const page2 = await overseerService.listOverseerUsers({
+     *     pageSize: 20,
+     *     cursor: result.pageInfo.nextCursor
+     *   });
+     * }
+     * ```
+     * @since 6.x.0
+     */
+    listOverseerUsers(options?: ListUsersOptions): Promise<UsersListResponse>;
+    /**
+     * Get comprehensive user summary (Admin/Overseer only)
+     *
+     * Dual-auth endpoint - requires Admin API key OR JWT as existing Overseer.
+     * Returns full profile, activity metrics, and ban status for a user.
+     *
+     * @param address User wallet address
+     * @returns User profile with detailed activity metrics
+     * @throws ConfigurationError if neither auth method is available
+     * @throws ValidationError if address is invalid
+     *
+     * @example
+     * ```typescript
+     * const summary = await overseerService.getOverseerUserSummary('eth|...');
+     * console.log('User:', summary.profile?.fullName);
+     * console.log('Flags:', summary.stats.flagsReceived);
+     * console.log('Global ban:', summary.stats.globalBan);
+     * ```
+     * @since 6.x.0
+     */
+    getOverseerUserSummary(address: string): Promise<UserSummaryResponse>;
+    /**
+     * Flush all cache entries for a wallet address
+     *
+     * Dual-auth endpoint - requires Admin API key OR JWT as existing Overseer.
+     * Clears all cached data associated with the specified address including:
+     * - User profile data
+     * - Overseer status
+     * - Owned tokens list
+     * - Ban status
+     * - Moderator access entries
+     *
+     * @param address Wallet address to flush cache for
+     * @returns Flush result with count and duration
+     * @throws ValidationError if address is empty
+     * @throws ConfigurationError if neither auth method is available
+     *
+     * @example
+     * ```typescript
+     * const result = await overseerService.flushCacheByAddress('eth|1234...');
+     * console.log(`Flushed ${result.flushedCount} keys in ${result.duration}ms`);
+     * ```
+     * @since 8.x.0
+     */
+    flushCacheByAddress(address: string): Promise<FlushResult>;
+    /**
+     * Flush all cache entries for a token
+     *
+     * Dual-auth endpoint - requires Admin API key OR JWT as existing Overseer.
+     * Clears all cached data associated with the specified token including:
+     * - Stream chat messages
+     * - Pinned messages
+     * - Recordings list
+     * - Holders data
+     * - Token ban status
+     * - Price data
+     *
+     * @param tokenName Token name to flush cache for
+     * @returns Flush result with count and duration
+     * @throws ValidationError if tokenName is empty
+     * @throws ConfigurationError if neither auth method is available
+     *
+     * @example
+     * ```typescript
+     * const result = await overseerService.flushCacheByToken('MYTOKEN');
+     * console.log(`Flushed ${result.flushedCount} keys in ${result.duration}ms`);
+     * ```
+     * @since 8.x.0
+     */
+    flushCacheByToken(tokenName: string): Promise<FlushResult>;
+    /**
+     * Flush ALL Launchpad cache (nuclear option)
+     *
+     * Dual-auth endpoint - requires Admin API key OR JWT as existing Overseer.
+     * This is the nuclear option that clears ALL cached data across the entire
+     * Launchpad platform. Use with extreme caution.
+     *
+     * **Safety Feature**: Requires `confirm: true` parameter to prevent accidental usage.
+     *
+     * @param confirm Must be `true` to proceed - safety confirmation
+     * @returns Flush result with count and duration
+     * @throws ValidationError if confirm is not true
+     * @throws ConfigurationError if neither auth method is available
+     *
+     * @example
+     * ```typescript
+     * // Safety: must explicitly confirm
+     * const result = await overseerService.flushAllCache(true);
+     * console.log(`⚠️ Flushed ALL ${result.flushedCount} keys in ${result.duration}ms`);
+     * ```
+     * @since 8.x.0
+     */
+    flushAllCache(confirm: true): Promise<FlushResult>;
+    /**
+     * Flush wallet-alias cache entries.
+     *
+     * Clears the cached eth| → client| alias resolution for the given address,
+     * or all alias entries if no address is provided.
+     *
+     * Use this after updating the GalaChain public-key contract URL, or when a
+     * user's alias is stale in Redis (e.g. they registered on GalaChain after
+     * their eth| address was cached).
+     *
+     * @param address - Optional wallet address (eth| or 0x format). If omitted, flushes ALL wallet-alias entries (requires confirm=true semantics, use with care).
+     * @returns Flush result with count and duration
+     *
+     * @example Flush alias for a single address
+     * ```typescript
+     * const result = await overseerService.flushWalletAliasCache('eth|dc1783...');
+     * console.log(`Flushed ${result.flushedCount} alias entries in ${result.duration}ms`);
+     * ```
+     *
+     * @example Flush all alias entries
+     * ```typescript
+     * const result = await overseerService.flushWalletAliasCache();
+     * console.log(`Flushed ${result.flushedCount} alias entries in ${result.duration}ms`);
+     * ```
+     *
+     * @since 8.x.0
+     */
+    flushWalletAliasCache(address?: string): Promise<FlushResult>;
+}
+//# sourceMappingURL=OverseerService.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"OverseerService.d.ts","sourceRoot":"","sources":["../../src/services/OverseerService.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE/C,OAAO,KAAK,EAAE,WAAW,EAAyB,MAAM,+BAA+B,CAAC;AAWxF,OAAO,KAAK,EACV,gBAAgB,EAChB,2BAA2B,EAC3B,2BAA2B,EAC3B,iBAAiB,EAKjB,mBAAmB,EACnB,0BAA0B,EAC1B,oBAAoB,EACpB,gBAAgB,EAChB,QAAQ,EACR,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,wBAAwB,EACxB,kBAAkB,EAClB,wBAAwB,EACxB,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,uBAAuB,CAAC;AAc/B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAGhD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,eAAgB,SAAQ,sBAAsB;gBAEvD,IAAI,EAAE,UAAU,EAChB,WAAW,CAAC,EAAE,MAAM,EACpB,OAAO,CAAC,EAAE,OAAO,EACjB,SAAS,GAAE,OAAe,EAC1B,UAAU,CAAC,EAAE,MAAM;IASrB;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAQhC;;OAEG;IACH,OAAO,CAAC,2BAA2B;IAWnC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,YAAY,CAAC,OAAO,GAAE,2BAAgC,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,qBAAqB,CAAA;KAAE,CAAC;IA4BzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,WAAW,CAAC,OAAO,GAAE,0BAA+B,GAAG,OAAO,CAAC,wBAAwB,CAAC;IA+B9F;;;;;;;;;;;;;;;;;OAiBG;IACG,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAa5E;;;;;;;;;;;;;;;;;OAiBG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBnD;;;;;;;;;;;;;;;;OAgBG;IACG,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,qBAAqB,CAAA;KAAE,CAAC;IAuBjF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,aAAa,CAAC,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IA+BpF;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACG,oBAAoB,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,QAAQ,CAAA;KAAE,CAAC;IA2BjG;;;;;;;;;;;;;;;;OAgBG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBpD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,WAAW,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAgBpD;;;;;;;;;;;;;;;;;;OAkBG;IACG,UAAU,IAAI,OAAO,CAAC,uBAAuB,CAAC;IAgBpD;;;;;;;;;OASG;IACG,WAAW,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAU9C;;;;;;;;;OASG;IACG,gBAAgB,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAUxD;;;;;;;;;OASG;IACG,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAUpD;;;;;;;;;OASG;IACG,YAAY,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAUhD;;;;;;;;;OASG;IACG,YAAY,IAAI,OAAO,CAAC,iBAAiB,CAAC;IAchD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACG,iBAAiB,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAoC/E;;;;;;;;;;;;;;;;;;;OAmBG;IACG,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAsB3E;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAchE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAchE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,aAAa,CAAC,OAAO,EAAE,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC;IAcxD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,qBAAqB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;CAqBpE"}

package/dist/services/PlatformConfigService.d.ts

@@ -0,0 +1,149 @@
+/**
+ * Platform Configuration Service
+ *
+ * Handles all platform configuration operations including global settings
+ * for streaming, chat, comments, and webhooks, as well as role management.
+ *
+ * @category Services
+ * @since 7.3.0
+ */
+import type { JwtAuth } from '../auth/JwtAuth';
+import type { AvailableRolesResponse, PlatformConfig, UpdatePlatformConfigOptions } from '../types/platform-config.dto';
+import type { HttpClient } from '../utils/http';
+import { BaseService } from './BaseService';
+/**
+ * Platform Configuration Service Class
+ *
+ * Provides methods for managing global platform configuration:
+ * - Get current platform config (public)
+ * - Update platform config (admin/overseer only)
+ * - Get available roles and permissions (public)
+ *
+ * @example
+ * ```typescript
+ * const configService = new PlatformConfigService(httpClient, jwtAuth, true);
+ *
+ * // Get current configuration
+ * const config = await configService.getPlatformConfig();
+ * console.log('Streaming enabled:', config.streamingEnabled);
+ *
+ * // Update configuration (requires admin/overseer)
+ * const updated = await configService.updatePlatformConfig({
+ *   streamingEnabled: false
+ * });
+ *
+ * // Get available roles
+ * const { roles, permissions } = await configService.getAvailableRoles();
+ * roles.forEach(role => {
+ *   console.log(`${role.name}: ${role.description}`);
+ * });
+ * ```
+ */
+export declare class PlatformConfigService extends BaseService {
+    constructor(http: HttpClient, jwtAuth?: JwtAuth, debugMode?: boolean);
+    /**
+     * Extract data from API response wrapper.
+     * @throws Error if response indicates failure or has no data
+     */
+    private extractData;
+    /**
+     * Get current platform configuration
+     *
+     * Public endpoint - no authentication required.
+     *
+     * Returns global platform settings affecting all tokens and streams:
+     * - Whether streaming is enabled globally
+     * - Whether chat is enabled globally
+     * - Whether comments are enabled globally
+     * - Whether webhooks are enabled globally
+     *
+     * @returns Current platform configuration
+     *
+     * @example
+     * ```typescript
+     * const config = await configService.getPlatformConfig();
+     *
+     * if (!config.streamingEnabled) {
+     *   console.log('Platform streaming is disabled');
+     * }
+     *
+     * if (!config.chatEnabled) {
+     *   console.log('Platform chat is disabled');
+     * }
+     * ```
+     */
+    getPlatformConfig(): Promise<PlatformConfig>;
+    /**
+     * Update platform configuration
+     *
+     * Requires JWT authentication with admin or overseer role.
+     *
+     * Performs a partial update - only provide fields to change.
+     * Other fields remain unchanged.
+     *
+     * @param options - Configuration fields to update
+     * @returns Updated platform configuration
+     * @throws ValidationError if options are invalid or missing
+     * @throws ConfigurationError if JWT auth is not configured
+     * @throws Error if user is not authorized (not admin or overseer)
+     *
+     * @example
+     * ```typescript
+     * // Disable streaming platform-wide
+     * const updated = await configService.updatePlatformConfig({
+     *   streamingEnabled: false
+     * });
+     *
+     * // Disable multiple features
+     * const updated = await configService.updatePlatformConfig({
+     *   streamingEnabled: false,
+     *   chatEnabled: false,
+     *   commentsEnabled: false
+     * });
+     * ```
+     */
+    updatePlatformConfig(options: UpdatePlatformConfigOptions): Promise<PlatformConfig>;
+    /**
+     * Get all available roles and permissions
+     *
+     * Public endpoint - no authentication required.
+     *
+     * Returns reference data about the role system, including:
+     * - All available roles (OWNER, MANAGER, TECHNICAL_PRODUCER, MODERATOR)
+     * - Role descriptions and hierarchy levels
+     * - Permissions assigned to each role
+     * - Complete list of all available permissions
+     *
+     * This is useful for:
+     * - Building role selection UIs
+     * - Understanding permission hierarchies
+     * - Validating role-based access control
+     *
+     * **Note:** This is static reference data. It does not change per user or token.
+     *
+     * @returns Available roles and permissions
+     *
+     * @example
+     * ```typescript
+     * const { roles, permissions } = await configService.getAvailableRoles();
+     *
+     * // List all roles
+     * roles.forEach(role => {
+     *   console.log(`${role.name} (level ${role.level}): ${role.description}`);
+     *   console.log('  Permissions:', role.permissions.join(', '));
+     * });
+     *
+     * // List all permissions
+     * console.log('All permissions:', permissions);
+     *
+     * // Build a role selector dropdown
+     * const roleOptions = roles.map(role => ({
+     *   value: role.name,
+     *   label: role.description,
+     *   level: role.level,
+     * }));
+     * ```
+     */
+    getAvailableRoles(): Promise<AvailableRolesResponse>;
+}
+//# sourceMappingURL=PlatformConfigService.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PlatformConfigService.d.ts","sourceRoot":"","sources":["../../src/services/PlatformConfigService.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAG/C,OAAO,KAAK,EACV,sBAAsB,EACtB,cAAc,EACd,2BAA2B,EAC5B,MAAM,8BAA8B,CAAC;AAGtC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,qBAAsB,SAAQ,WAAW;gBACxC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,SAAS,GAAE,OAAe;IAI3E;;;OAGG;IACH,OAAO,CAAC,WAAW;IAiCnB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,iBAAiB,IAAI,OAAO,CAAC,cAAc,CAAC;IAQlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,oBAAoB,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,cAAc,CAAC;IAoBzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACG,iBAAiB,IAAI,OAAO,CAAC,sBAAsB,CAAC;CAO3D"}