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

package/dist/types/ai-moderation.dto.d.ts

@@ -0,0 +1,294 @@
+/**
+ * AI Content Moderation Types
+ *
+ * Types for the AI-powered content moderation system that analyzes
+ * flagged content and provides automated recommendations.
+ *
+ * @module ai-moderation.dto
+ * @since 6.15.0
+ */
+import type { InternalApiResponse } from './common';
+/**
+ * Status of an AI analysis request
+ */
+export declare enum AnalysisStatus {
+    PENDING = "PENDING",
+    PROCESSING = "PROCESSING",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED"
+}
+/**
+ * Type of content being analyzed
+ */
+export declare enum AnalysisType {
+    TEXT = "TEXT",
+    IMAGE = "IMAGE",
+    VIDEO = "VIDEO"
+}
+/**
+ * AI recommendation for moderation action
+ */
+export declare enum AIRecommendation {
+    NO_ACTION = "NO_ACTION",
+    REVIEW_REQUIRED = "REVIEW_REQUIRED",
+    DELETE_CONTENT = "DELETE_CONTENT",
+    BAN_USER = "BAN_USER",
+    DELETE_AND_BAN = "DELETE_AND_BAN"
+}
+/**
+ * Category of content violation detected
+ */
+export declare enum AnalysisCategory {
+    VIOLENCE = "VIOLENCE",
+    HATE_SPEECH = "HATE_SPEECH",
+    SEXUAL_CONTENT = "SEXUAL_CONTENT",
+    HARASSMENT = "HARASSMENT",
+    SPAM = "SPAM",
+    SCAM = "SCAM",
+    SELF_HARM = "SELF_HARM",
+    ILLEGAL_ACTIVITY = "ILLEGAL_ACTIVITY",
+    MISINFORMATION = "MISINFORMATION",
+    COPYRIGHT = "COPYRIGHT",
+    SAFE = "SAFE"
+}
+/**
+ * Analysis tier for tiered video scanning (cost optimization)
+ * @since 6.15.0
+ */
+export declare enum AnalysisTier {
+    /** Quick scan: fewer frames, lower resolution (~75% cost savings) */
+    QUICK = "QUICK",
+    /** Detailed scan: full frame count, higher resolution */
+    DETAILED = "DETAILED"
+}
+/**
+ * AI moderation mode
+ */
+export declare enum AIModerationMode {
+    /** AI moderation is completely disabled */
+    DISABLED = "DISABLED",
+    /** AI provides recommendations but human always makes final decision */
+    ADVISORY = "ADVISORY"
+}
+/**
+ * Per-category detection result from AI analysis
+ */
+export interface CategoryResult {
+    category: AnalysisCategory;
+    confidence: number;
+    detected: boolean;
+}
+/**
+ * AI moderation data returned from API
+ */
+export interface AIModerationData {
+    id: number;
+    flagId: number;
+    status: AnalysisStatus;
+    analysisType: AnalysisType;
+    provider: string;
+    recommendation: AIRecommendation | null;
+    confidence: number | null;
+    categories: CategoryResult[] | null;
+    summary: string | null;
+    reasoning: string | null;
+    processingTimeMs: number | null;
+    framesAnalyzed: number | null;
+    errorMessage: string | null;
+    retryCount: number;
+    /** Analysis tier used (QUICK or DETAILED). Null for text analysis. */
+    analysisTier: AnalysisTier | null;
+    /** Result from quick scan before escalation (if escalated) */
+    quickScanResult: AIRecommendation | null;
+    /** Whether this was escalated from a quick scan */
+    escalatedFromQuick: boolean;
+    /** Estimated token usage for cost tracking */
+    tokensUsed: number | null;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * AI moderation settings configuration
+ */
+export interface AIModerationSettings {
+    enabled: boolean;
+    mode: AIModerationMode;
+    provider: string;
+    maxFrames: number;
+    frameInterval: number;
+    /** Whether tiered video analysis is enabled */
+    tieredAnalysisEnabled: boolean;
+    /** Number of frames for quick scan tier */
+    quickScanFrames: number;
+    /** Width in pixels for quick scan frames */
+    quickScanWidth: number;
+    /** Confidence threshold below which quick scan escalates */
+    escalationConfidenceThreshold: number;
+    /** Recommendations that always trigger escalation */
+    escalationRecommendations: string[];
+}
+/**
+ * AI system status information
+ */
+export interface AISystemStatus {
+    enabled: boolean;
+    mode: AIModerationMode;
+    providerAvailable: boolean;
+    providers: Array<{
+        name: string;
+        available: boolean;
+    }>;
+}
+/**
+ * Options for getting AI moderation for a flag
+ */
+export interface GetAIModerationOptions {
+    /** Flag ID to get moderation for */
+    flagId: number;
+}
+/**
+ * Options for triggering AI moderation
+ */
+export interface TriggerAIModerationOptions {
+    /** Flag ID to moderate */
+    flagId: number;
+}
+/**
+ * Options for updating AI moderation settings
+ */
+export interface UpdateAIModerationSettingsOptions {
+    /** Enable or disable AI moderation */
+    enabled?: boolean;
+    /** AI moderation mode */
+    mode?: AIModerationMode;
+    /** AI provider (e.g., 'claude') */
+    provider?: string;
+}
+/**
+ * Result from getting AI moderation
+ */
+export interface GetAIModerationResult {
+    moderation: AIModerationData;
+}
+/**
+ * Result from triggering AI moderation
+ */
+export interface TriggerAIModerationResult {
+    queued: boolean;
+    message: string;
+}
+/**
+ * Result from getting AI settings
+ */
+export interface GetAIModerationSettingsResult {
+    settings: AIModerationSettings;
+}
+/**
+ * Result from updating AI settings
+ */
+export interface UpdateAIModerationSettingsResult {
+    settings: AIModerationSettings;
+}
+/**
+ * Result from getting AI system status
+ */
+export interface GetAIModerationStatusResult {
+    status: AISystemStatus;
+}
+/**
+ * Internal response from get moderation endpoint
+ * @internal
+ */
+export type InternalGetModerationResponse = InternalApiResponse<AIModerationData>;
+/**
+ * Internal response from trigger moderation endpoint
+ * @internal
+ */
+export type InternalTriggerModerationResponse = InternalApiResponse<{
+    queued: boolean;
+}>;
+/**
+ * Internal response from get settings endpoint
+ * @internal
+ */
+export type InternalGetModerationSettingsResponse = InternalApiResponse<AIModerationSettings>;
+/**
+ * Internal response from get status endpoint
+ * @internal
+ */
+export type InternalGetModerationStatusResponse = InternalApiResponse<AISystemStatus>;
+/**
+ * Payload sent when AI moderation completes
+ */
+export interface AIModerationCompletePayload {
+    flagId: number;
+    tokenName?: string;
+    moderation: AIModerationData;
+}
+/**
+ * Payload sent when AI moderation fails
+ */
+export interface AIModerationFailedPayload {
+    flagId: number;
+    tokenName?: string;
+    error: string;
+}
+/**
+ * Analysis status display labels
+ */
+export declare const ANALYSIS_STATUS_LABELS: Record<AnalysisStatus, string>;
+/**
+ * AI recommendation display labels
+ */
+export declare const AI_RECOMMENDATION_LABELS: Record<AIRecommendation, string>;
+/**
+ * Analysis category display labels
+ */
+export declare const ANALYSIS_CATEGORY_LABELS: Record<AnalysisCategory, string>;
+/**
+ * Analysis tier display labels
+ * @since 6.15.0
+ */
+export declare const ANALYSIS_TIER_LABELS: Record<AnalysisTier, string>;
+/**
+ * Analysis type display labels
+ */
+export declare const ANALYSIS_TYPE_LABELS: Record<AnalysisType, string>;
+/**
+ * AI moderation mode display labels
+ */
+export declare const AI_MODE_LABELS: Record<AIModerationMode, string>;
+/** Check if a value is a valid AnalysisStatus */
+export declare const isAnalysisStatus: (value: unknown) => value is AnalysisStatus;
+/** Check if a value is a valid AnalysisType */
+export declare const isAnalysisType: (value: unknown) => value is AnalysisType;
+/** Check if a value is a valid AIRecommendation */
+export declare const isAIRecommendation: (value: unknown) => value is AIRecommendation;
+/** Check if a value is a valid AnalysisCategory */
+export declare const isAnalysisCategory: (value: unknown) => value is AnalysisCategory;
+/** Check if a value is a valid AnalysisTier */
+export declare const isAnalysisTier: (value: unknown) => value is AnalysisTier;
+/** Check if a value is a valid AIModerationMode */
+export declare const isAIModerationMode: (value: unknown) => value is AIModerationMode;
+/**
+ * Check if a value is valid AIModerationData
+ */
+export declare const isAIModerationData: (obj: unknown) => obj is AIModerationData;
+/**
+ * Check if a value is valid AIModerationSettings
+ */
+export declare const isAIModerationSettings: (obj: unknown) => obj is AIModerationSettings;
+/**
+ * Check if moderation used tiered scanning
+ */
+export declare function isModerationTiered(moderation: AIModerationData): boolean;
+/**
+ * Check if moderation was escalated from quick scan
+ */
+export declare function wasModerationEscalated(moderation: AIModerationData): boolean;
+/**
+ * Get estimated cost savings from using tiered analysis
+ * Returns percentage of tokens saved vs full detailed scan
+ */
+export declare function getTieredModerationSavings(moderation: AIModerationData, settings: AIModerationSettings): number;
+//# sourceMappingURL=ai-moderation.dto.d.ts.map

package/dist/types/ai-moderation.dto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai-moderation.dto.d.ts","sourceRoot":"","sources":["../../src/types/ai-moderation.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAGH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAMpD;;GAEG;AACH,oBAAY,cAAc;IACxB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,MAAM,WAAW;CAClB;AAED;;GAEG;AACH,oBAAY,YAAY;IACtB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,KAAK,UAAU;CAChB;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,SAAS,cAAc;IACvB,eAAe,oBAAoB;IACnC,cAAc,mBAAmB;IACjC,QAAQ,aAAa;IACrB,cAAc,mBAAmB;CAClC;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,QAAQ,aAAa;IACrB,WAAW,gBAAgB;IAC3B,cAAc,mBAAmB;IACjC,UAAU,eAAe;IACzB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,gBAAgB,qBAAqB;IACrC,cAAc,mBAAmB;IACjC,SAAS,cAAc;IACvB,IAAI,SAAS;CACd;AAED;;;GAGG;AACH,oBAAY,YAAY;IACtB,qEAAqE;IACrE,KAAK,UAAU;IACf,yDAAyD;IACzD,QAAQ,aAAa;CACtB;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B,2CAA2C;IAC3C,QAAQ,aAAa;IACrB,wEAAwE;IACxE,QAAQ,aAAa;CACtB;AAMD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,cAAc,CAAC;IACvB,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACxC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;IACpC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IAEnB,sEAAsE;IACtE,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAClC,8DAA8D;IAC9D,eAAe,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACzC,mDAAmD;IACnD,kBAAkB,EAAE,OAAO,CAAC;IAC5B,8CAA8C;IAC9C,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IAEtB,+CAA+C;IAC/C,qBAAqB,EAAE,OAAO,CAAC;IAC/B,2CAA2C;IAC3C,eAAe,EAAE,MAAM,CAAC;IACxB,4CAA4C;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,4DAA4D;IAC5D,6BAA6B,EAAE,MAAM,CAAC;IACtC,qDAAqD;IACrD,yBAAyB,EAAE,MAAM,EAAE,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,gBAAgB,CAAC;IACvB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,SAAS,EAAE,KAAK,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,OAAO,CAAC;KACpB,CAAC,CAAC;CACJ;AAMD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,sCAAsC;IACtC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,yBAAyB;IACzB,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAMD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,gBAAgB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,EAAE,oBAAoB,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,QAAQ,EAAE,oBAAoB,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,cAAc,CAAC;CACxB;AAMD;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;AAElF;;;GAGG;AACH,MAAM,MAAM,iCAAiC,GAAG,mBAAmB,CAAC;IAAE,MAAM,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAEzF;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAAG,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;AAE9F;;;GAGG;AACH,MAAM,MAAM,mCAAmC,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;AAMtF;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,gBAAgB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACf;AAMD;;GAEG;AACH,eAAO,MAAM,sBAAsB,EAAE,MAAM,CAAC,cAAc,EAAE,MAAM,CAKjE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAMrE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAYrE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAG7D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAI7D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAG3D,CAAC;AAMF,iDAAiD;AACjD,eAAO,MAAM,gBAAgB,6CAAsC,CAAC;AAEpE,+CAA+C;AAC/C,eAAO,MAAM,cAAc,2CAAoC,CAAC;AAEhE,mDAAmD;AACnD,eAAO,MAAM,kBAAkB,+CAAwC,CAAC;AAExE,mDAAmD;AACnD,eAAO,MAAM,kBAAkB,+CAAwC,CAAC;AAExE,+CAA+C;AAC/C,eAAO,MAAM,cAAc,2CAAoC,CAAC;AAEhE,mDAAmD;AACnD,eAAO,MAAM,kBAAkB,+CAAwC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,kBAAkB,2CAM7B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,sBAAsB,+CAIjC,CAAC;AAMH;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,gBAAgB,GAAG,OAAO,CAExE;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,gBAAgB,GAAG,OAAO,CAE5E;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CAAC,UAAU,EAAE,gBAAgB,EAAE,QAAQ,EAAE,oBAAoB,GAAG,MAAM,CAe/G"}

package/dist/types/api-key.dto.d.ts

@@ -0,0 +1,373 @@
+/**
+ * API Key Types and DTOs
+ *
+ * Type definitions for user-managed API keys with role-based permissions.
+ * API keys enable delegation of specific permissions to third-party services
+ * or automated systems.
+ *
+ * @since 5.6.0
+ * @category Types
+ * @module api-key
+ */
+import type { PageInfo } from './common';
+/**
+ * API Key Role Values
+ *
+ * Hierarchical roles determining permissions:
+ * - OWNER: Full access (indistinguishable from normal auth)
+ * - MANAGER: Moderator + Technical Producer + recordings + stream settings
+ * - TECHNICAL_PRODUCER: Simulcast targets, stream key, stop/start stream
+ * - MODERATOR: Manage comments, chat messages, ban/unban users
+ */
+export declare const API_KEY_ROLE: {
+    /** Manage comments, chat messages, ban/unban users */
+    readonly MODERATOR: "MODERATOR";
+    /** Setup simulcast targets, get stream key, stop/start stream, prep work */
+    readonly TECHNICAL_PRODUCER: "TECHNICAL_PRODUCER";
+    /** Overseer: Moderator + Technical Producer + recordings + stream settings */
+    readonly MANAGER: "MANAGER";
+    /** Full access, indistinguishable from normal auth session */
+    readonly OWNER: "OWNER";
+};
+/**
+ * API Key Role Type
+ */
+export type ApiKeyRole = (typeof API_KEY_ROLE)[keyof typeof API_KEY_ROLE];
+/**
+ * All available API key roles as an array (for validation)
+ */
+export declare const API_KEY_ROLES: ApiKeyRole[];
+/**
+ * API Key permission enumeration
+ *
+ * Fine-grained permissions that can be assigned to API keys.
+ * Permissions vary based on the role assigned to the key.
+ *
+ * @since 6.x.0
+ */
+export declare const API_KEY_PERMISSION: {
+    /** Manage comments (create/delete) */
+    readonly MANAGE_COMMENTS: "MANAGE_COMMENTS";
+    /** Manage chat messages (send/delete) */
+    readonly MANAGE_CHAT: "MANAGE_CHAT";
+    /** Ban users from streams */
+    readonly BAN_USERS: "BAN_USERS";
+    /** Unban users from streams */
+    readonly UNBAN_USERS: "UNBAN_USERS";
+    /** Manage simulcast targets */
+    readonly MANAGE_SIMULCAST: "MANAGE_SIMULCAST";
+    /** Get stream key */
+    readonly GET_STREAM_KEY: "GET_STREAM_KEY";
+    /** Stop active stream */
+    readonly STOP_STREAM: "STOP_STREAM";
+    /** Reset stream key */
+    readonly RESET_STREAM_KEY: "RESET_STREAM_KEY";
+    /** Start new stream */
+    readonly START_STREAM: "START_STREAM";
+    /** Delete stream recordings */
+    readonly DELETE_RECORDINGS: "DELETE_RECORDINGS";
+    /** Manage stream settings (countdown, language) */
+    readonly MANAGE_STREAM_SETTINGS: "MANAGE_STREAM_SETTINGS";
+};
+export type ApiKeyPermissionType = (typeof API_KEY_PERMISSION)[keyof typeof API_KEY_PERMISSION];
+/**
+ * Consolidated Permission System (v5.8.0)
+ *
+ * Fine-grained permissions consolidated into 5 logical groupings:
+ * - MANAGE_COMMUNITY: Chat/comments moderation + banning
+ * - MANAGE_STREAM: Stream operations (start/stop, credentials, simulcasts)
+ * - MANAGE_SETTINGS: Token profile, branding, scheduling, toggles
+ * - MANAGE_RECORDINGS: Recording view/delete/download
+ * - VIEW_ANALYTICS: Analytics access
+ *
+ * Used for per-token permission overrides in API keys.
+ *
+ * @since 5.8.0
+ */
+export declare const PERMISSION: {
+    /** Community moderation (chat, comments, banning) */
+    readonly MANAGE_COMMUNITY: "MANAGE_COMMUNITY";
+    /** Stream operations (start/stop, credentials, simulcasts) */
+    readonly MANAGE_STREAM: "MANAGE_STREAM";
+    /** Token settings (socials, description, image, language, countdown, toggles) */
+    readonly MANAGE_SETTINGS: "MANAGE_SETTINGS";
+    /** Recording management (view, delete, download) */
+    readonly MANAGE_RECORDINGS: "MANAGE_RECORDINGS";
+    /** Analytics access */
+    readonly VIEW_ANALYTICS: "VIEW_ANALYTICS";
+};
+/**
+ * Permission type for consolidated permission system.
+ * @since 5.8.0
+ */
+export type Permission = (typeof PERMISSION)[keyof typeof PERMISSION];
+/**
+ * All valid permission values as an array (for validation).
+ * @since 5.8.0
+ */
+export declare const ALL_PERMISSIONS: Permission[];
+/**
+ * Options for creating a new API key.
+ *
+ * @example
+ * ```typescript
+ * const options: CreateApiKeyOptions = {
+ *   role: 'MODERATOR',
+ *   description: 'Chat moderation bot',
+ *   delegateAllTokens: false,
+ *   tokenNames: ['mytoken', 'othertoken'],
+ *   expiresAt: '2025-12-31T23:59:59Z'
+ * };
+ * ```
+ */
+export interface CreateApiKeyOptions {
+    /**
+     * Role determining permissions for this API key.
+     * Required.
+     */
+    role: ApiKeyRole;
+    /**
+     * User's description/label for this API key.
+     * Max 255 characters.
+     */
+    description?: string;
+    /**
+     * If true, key has access to ALL tokens owned by the user (current and future).
+     * If false, only tokens in `tokenNames` are accessible.
+     * @default false
+     */
+    delegateAllTokens?: boolean;
+    /**
+     * Specific tokens to delegate access to.
+     * Ignored if `delegateAllTokens` is true.
+     * Token names are case-insensitive.
+     */
+    tokenNames?: string[];
+    /**
+     * Optional expiration date in ISO 8601 format.
+     * If not provided, key never expires.
+     * @example "2025-12-31T23:59:59Z"
+     */
+    expiresAt?: string;
+    /**
+     * Per-token permission overrides. Maps tokenName to Permission[].
+     * Only applies to tokens in tokenNames. Tokens not in this map
+     * use the API key's role-based default permissions.
+     *
+     * @example { "mytoken": ["MANAGE_COMMUNITY"] }
+     * @since 5.8.0
+     */
+    tokenPermissions?: Record<string, Permission[]>;
+}
+/**
+ * Options for updating an existing API key.
+ * All fields are optional - only provided fields are updated.
+ *
+ * @example
+ * ```typescript
+ * // Update description and add more tokens
+ * const updates: UpdateApiKeyOptions = {
+ *   description: 'Updated description',
+ *   tokenNames: ['token1', 'token2', 'token3']
+ * };
+ *
+ * // Upgrade role and extend expiration
+ * const roleUpdate: UpdateApiKeyOptions = {
+ *   role: 'MANAGER',
+ *   expiresAt: '2026-12-31T23:59:59Z'
+ * };
+ * ```
+ */
+export interface UpdateApiKeyOptions {
+    /**
+     * New role for the API key.
+     */
+    role?: ApiKeyRole;
+    /**
+     * Updated description/label.
+     * Max 255 characters.
+     */
+    description?: string;
+    /**
+     * If true, key has access to ALL tokens owned by the user.
+     */
+    delegateAllTokens?: boolean;
+    /**
+     * Updated list of specific tokens to delegate.
+     * Replaces existing token delegations.
+     */
+    tokenNames?: string[];
+    /**
+     * Updated expiration date in ISO 8601 format.
+     * Pass null to remove expiration.
+     */
+    expiresAt?: string | null;
+    /**
+     * Per-token permission overrides. Maps tokenName to Permission[].
+     * Replaces existing per-token permissions for the specified tokens.
+     * @since 5.8.0
+     */
+    tokenPermissions?: Record<string, Permission[]>;
+}
+/**
+ * Pagination options for listing API keys.
+ * Uses cursor-based pagination for efficient navigation.
+ * @updated 8.1.0 - Migrated to cursor-based pagination
+ */
+export interface ListApiKeysOptions {
+    /**
+     * Cursor token for fetching the next page (omit for first page).
+     * Use the `nextCursor` from the previous response's `pageInfo`.
+     */
+    cursor?: string;
+    /**
+     * Page size for pagination (defaults to 50, max 100).
+     * The maximum allowed page size is 100 items per page.
+     * @default 50
+     */
+    pageSize?: number;
+}
+/**
+ * Source type indicating how the API key holder relates to their tokens.
+ * OWNER = key holder owns the tokens directly.
+ * MODERATOR = key holder only has moderator access to tokens.
+ */
+export type ApiKeySource = 'OWNER' | 'MODERATOR';
+/**
+ * API key data returned in responses.
+ * Note: The raw key is NOT included - it's only returned on creation.
+ */
+export interface ApiKeyData {
+    /** Unique identifier */
+    id: number;
+    /** First 8 characters for identification (e.g., "glp_abc1") */
+    keyPrefix: string;
+    /** User's description/label */
+    description: string | null;
+    /** Role determining permissions */
+    role: ApiKeyRole;
+    /**
+     * Indicates whether the key holder owns tokens (OWNER) or only has moderator access (MODERATOR).
+     * @since 9.1.0
+     */
+    sourceType: ApiKeySource;
+    /** Whether key has access to all owner's tokens */
+    delegateAllTokens: boolean;
+    /** List of specifically delegated token names (null if delegateAllTokens is true) */
+    tokenNames: string[] | null;
+    /**
+     * Per-token permission overrides (null if no overrides set).
+     * Maps tokenName to Permission[].
+     * @since 5.8.0
+     */
+    tokenPermissions?: Record<string, Permission[]> | null;
+    /** Expiration timestamp (ISO 8601) or null if never expires */
+    expiresAt: string | null;
+    /** Last time key was used (ISO 8601) or null if never used */
+    lastUsedAt: string | null;
+    /** Creation timestamp (ISO 8601) */
+    createdAt: string;
+    /** Last update timestamp (ISO 8601) */
+    updatedAt: string;
+}
+/**
+ * Response when creating a new API key.
+ * CRITICAL: `rawKey` is ONLY returned on creation and never again!
+ *
+ * @example
+ * ```typescript
+ * const result = await sdk.createApiKey({ role: 'MODERATOR' });
+ * console.log('Save this key:', result.rawKey); // Only chance to see it!
+ * // rawKey format: "glp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+ * ```
+ */
+export interface CreateApiKeyResponse extends ApiKeyData {
+    /**
+     * The full API key - ONLY shown once on creation!
+     * Format: glp_{base64url_encoded_random_bytes}
+     * Example: "glp_abc1234defghijklmnopqrstuvwxyz012345678"
+     *
+     * CRITICAL: Store this securely - it cannot be retrieved again!
+     */
+    rawKey: string;
+}
+/**
+ * Paginated list of API keys.
+ */
+export interface ApiKeyListResponse {
+    /** Array of API key data */
+    apiKeys: ApiKeyData[];
+    /** Pagination metadata */
+    pageInfo: PageInfo;
+}
+/**
+ * Check if a string is a valid API key role.
+ *
+ * @param role - The role string to validate
+ * @returns True if the role is valid
+ *
+ * @example
+ * ```typescript
+ * isValidApiKeyRole('MODERATOR') // true
+ * isValidApiKeyRole('ADMIN')     // false
+ * ```
+ */
+export declare function isValidApiKeyRole(role: string): role is ApiKeyRole;
+/**
+ * Validate CreateApiKeyOptions.
+ *
+ * @param options - The options to validate
+ * @returns Array of validation error messages (empty if valid)
+ *
+ * @example
+ * ```typescript
+ * const errors = validateCreateApiKeyOptions({ role: 'INVALID' });
+ * if (errors.length > 0) {
+ *   console.error('Validation failed:', errors);
+ * }
+ * ```
+ */
+export declare function validateCreateApiKeyOptions(options: CreateApiKeyOptions): string[];
+/**
+ * Validate UpdateApiKeyOptions.
+ *
+ * @param options - The options to validate
+ * @returns Array of validation error messages (empty if valid)
+ */
+export declare function validateUpdateApiKeyOptions(options: UpdateApiKeyOptions): string[];
+/**
+ * Validate ListApiKeysOptions.
+ *
+ * @param options - The options to validate
+ * @throws ValidationError if pagination parameters are invalid
+ *
+ * @example
+ * ```typescript
+ * validateListApiKeysOptions({ pageSize: 20, cursor: 'abc123' });
+ * // No error - valid options
+ * ```
+ *
+ * @updated 8.1.0 - Migrated to cursor-based pagination validation
+ */
+export declare function validateListApiKeysOptions(options: ListApiKeysOptions): void;
+/**
+ * API key role hierarchy for permission checks.
+ * Higher index = more permissions.
+ */
+export declare const API_KEY_ROLE_HIERARCHY: Record<ApiKeyRole, number>;
+/**
+ * Check if a role has sufficient permissions for another role.
+ *
+ * @param actualRole - The role the API key has
+ * @param requiredRole - The minimum role required
+ * @returns True if actualRole >= requiredRole in hierarchy
+ *
+ * @example
+ * ```typescript
+ * roleHasSufficientPermission('OWNER', 'MODERATOR')   // true
+ * roleHasSufficientPermission('MODERATOR', 'MANAGER') // false
+ * roleHasSufficientPermission('MANAGER', 'TECHNICAL_PRODUCER') // true
+ * ```
+ */
+export declare function roleHasSufficientPermission(actualRole: ApiKeyRole, requiredRole: ApiKeyRole): boolean;
+//# sourceMappingURL=api-key.dto.d.ts.map

package/dist/types/api-key.dto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key.dto.d.ts","sourceRoot":"","sources":["../../src/types/api-key.dto.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAWH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAOzC;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY;IACvB,sDAAsD;;IAEtD,4EAA4E;;IAE5E,8EAA8E;;IAE9E,8DAA8D;;CAEtD,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,UAAU,EAA6B,CAAC;AAEpE;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB;IAC7B,sCAAsC;;IAEtC,yCAAyC;;IAEzC,6BAA6B;;IAE7B,+BAA+B;;IAE/B,+BAA+B;;IAE/B,qBAAqB;;IAErB,yBAAyB;;IAEzB,uBAAuB;;IAEvB,uBAAuB;;IAEvB,+BAA+B;;IAE/B,mDAAmD;;CAE3C,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,OAAO,kBAAkB,CAAC,CAAC;AAEhG;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU;IACrB,qDAAqD;;IAErD,8DAA8D;;IAE9D,iFAAiF;;IAEjF,oDAAoD;;IAEpD,uBAAuB;;CAEf,CAAC;AAEX;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAC;AAEtE;;;GAGG;AACH,eAAO,MAAM,eAAe,EAAE,UAAU,EAA8B,CAAC;AAMvE;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;CACjD;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;CACjD;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAMD;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,WAAW,CAAC;AAEjD;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,wBAAwB;IACxB,EAAE,EAAE,MAAM,CAAC;IAEX,+DAA+D;IAC/D,SAAS,EAAE,MAAM,CAAC;IAElB,+BAA+B;IAC/B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,mCAAmC;IACnC,IAAI,EAAE,UAAU,CAAC;IAEjB;;;OAGG;IACH,UAAU,EAAE,YAAY,CAAC;IAEzB,mDAAmD;IACnD,iBAAiB,EAAE,OAAO,CAAC;IAE3B,qFAAqF;IACrF,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE5B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,GAAG,IAAI,CAAC;IAEvD,+DAA+D;IAC/D,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,8DAA8D;IAC9D,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,oCAAoC;IACpC,SAAS,EAAE,MAAM,CAAC;IAElB,uCAAuC;IACvC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,oBAAqB,SAAQ,UAAU;IACtD;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAGD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,4BAA4B;IAC5B,OAAO,EAAE,UAAU,EAAE,CAAC;IAEtB,0BAA0B;IAC1B,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAMD;;;;;;;;;;;GAWG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,UAAU,CAElE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,mBAAmB,GAAG,MAAM,EAAE,CAyDlF;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,mBAAmB,GAAG,MAAM,EAAE,CA8DlF;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,kBAAkB,GAAG,IAAI,CAc5E;AAED;;;GAGG;AACH,eAAO,MAAM,sBAAsB,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,CAK7D,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,2BAA2B,CAAC,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,UAAU,GAAG,OAAO,CAkBrG"}