@camunda/ccma-api 0.0.2 → 0.0.3

package/dist/services/accounts/challenge.service.d.ts

@@ -0,0 +1,296 @@
+import type { RequestBaseParams } from '../../types/general.types.js';
+/**
+ * Challenge game types
+ */
+export interface SlackProfile {
+    displayName: string;
+    imageUrl: string;
+    timezone: string;
+    timezoneLabel: string;
+}
+export interface QuestionChoice {
+    value: string;
+    isCorrect: boolean;
+    avatar?: string;
+}
+export interface Question {
+    type: 'name' | 'avatar' | 'team' | 'timezone' | 'avatarTimezone' | 'notInTimezone' | 'creationYear' | 'duration' | 'version' | 'pmDri' | 'engineeringDri' | 'designDri' | 'theme';
+    employeeId: string;
+    question: string;
+    choices: QuestionChoice[];
+    correctAnswer: string;
+    slackProfile?: SlackProfile;
+    employee?: {
+        name: string;
+        avatar: string;
+    };
+}
+export interface PlayerAnswer {
+    questionIndex: number;
+    answer: string;
+    isCorrect: boolean;
+    timestamp: number;
+}
+export interface Player {
+    userId: string;
+    email: string;
+    answers: PlayerAnswer[];
+    score: number;
+    completed: boolean;
+    slackProfile?: SlackProfile;
+}
+export interface Match {
+    id: string;
+    type: 'department' | 'division' | 'subdivision' | 'company' | 'product-features';
+    value: string;
+    creator: Player;
+    opponent?: Player;
+    questions: Question[];
+    status: 'waiting' | 'ready' | 'started' | 'completed';
+    startTime?: number;
+    endTime?: number;
+    createdAt: number;
+}
+export interface HighscoreEntry {
+    userId: string;
+    email: string;
+    wins: number;
+    totalGames: number;
+    averageScore: number;
+}
+export interface PlayerStats {
+    email: string;
+    totalMatches: number;
+    wins: number;
+    losses: number;
+    totalCorrectAnswers: number;
+    totalQuestions: number;
+    totalPlayTimeSeconds: number;
+    averageScore: number;
+}
+export interface GameInfo {
+    name: string;
+    objective: string;
+    rules: string[];
+    howToPlay: string[];
+}
+/**
+ * Request/Response interfaces
+ */
+export interface GetGameInfoParams extends RequestBaseParams {
+}
+export interface GetOrganizationalGroupsParams extends RequestBaseParams {
+}
+export interface GetOrganizationalGroupsResponse {
+    departments: string[];
+    divisions: string[];
+    subdivisions: string[];
+    company: string[];
+    'product-features': string[];
+}
+export interface InitiateMatchParams extends RequestBaseParams {
+    body: {
+        type: 'department' | 'division' | 'subdivision' | 'company' | 'product-features';
+        value: string;
+        isSolo?: boolean;
+    };
+}
+export interface InitiateMatchResponse {
+    matchId: string;
+    type: string;
+    value: string;
+    status: string;
+    questionCount: number;
+    createdAt: number;
+    isSolo?: boolean;
+    countdownMessages?: string[];
+}
+export interface JoinMatchParams extends RequestBaseParams {
+    params: {
+        matchId: string;
+    };
+}
+export interface JoinMatchResponse {
+    matchId: string;
+    status: string;
+    creator: {
+        userId: string;
+        email: string;
+    };
+    opponent: {
+        userId: string;
+        email: string;
+    } | null;
+}
+export interface StartMatchParams extends RequestBaseParams {
+    params: {
+        matchId: string;
+    };
+}
+export interface StartMatchResponse {
+    matchId: string;
+    status: string;
+    startTime?: number;
+    message: string;
+}
+export interface GetMatchStateParams extends RequestBaseParams {
+    params: {
+        matchId: string;
+    };
+}
+export interface SubmitAnswerParams extends RequestBaseParams {
+    params: {
+        matchId: string;
+    };
+    body: {
+        questionIndex: number;
+        answer: string;
+    };
+}
+export interface SubmitAnswerResponse {
+    correct: boolean;
+    score: number;
+}
+export interface GetRunningMatchesParams extends RequestBaseParams {
+}
+export interface GetRunningMatchesResponse {
+    count: number;
+    matches: Array<{
+        matchId: string;
+        type: string;
+        value: string;
+        status: string;
+        creator: {
+            userId: string;
+            email: string;
+        };
+        opponent: {
+            userId: string;
+            email: string;
+        } | null;
+        createdAt: number;
+    }>;
+}
+export interface GetHighscoresParams extends RequestBaseParams {
+    params?: {
+        timeframe?: 'today' | 'alltime';
+    };
+}
+export interface GetHighscoresResponse {
+    count: number;
+    timeframe: 'today' | 'alltime';
+    highscores: HighscoreEntry[];
+}
+export interface GetActiveMatchesParams extends RequestBaseParams {
+}
+export interface GetActiveMatchesResponse {
+    count: number;
+    matches: Array<{
+        matchId: string;
+        type: string;
+        value: string;
+        creator: {
+            userId: string;
+            email: string;
+        };
+        opponent: {
+            userId: string;
+            email: string;
+        };
+        startTime: number;
+    }>;
+}
+export interface GetPlayerStatsParams extends RequestBaseParams {
+}
+export interface GetWaitingMatchesParams extends RequestBaseParams {
+}
+export interface CancelMatchParams extends RequestBaseParams {
+    params: {
+        matchId: string;
+    };
+}
+export interface CancelMatchResponse {
+    success: boolean;
+    message: string;
+}
+export interface WaitingMatchEntry {
+    matchId: string;
+    type: string;
+    value: string;
+    creator: {
+        userId: string;
+        email: string;
+        slackProfile?: SlackProfile;
+    };
+    createdAt: number;
+}
+export interface GetWaitingMatchesResponse {
+    count: number;
+    matches: WaitingMatchEntry[];
+}
+export interface JoinRandomMatchParams extends RequestBaseParams {
+}
+/**
+ * Challenge Game Service
+ *
+ * Provides methods to interact with the employee challenge game API.
+ * Only available when NODE_ENV=dev.
+ */
+export declare class ChallengeService {
+    /**
+     * Get game information and rules
+     */
+    static getGameInfo(params: GetGameInfoParams): Promise<GameInfo>;
+    /**
+     * Get available organizational groups (departments, divisions, subdivisions)
+     */
+    static getOrganizationalGroups(params: GetOrganizationalGroupsParams): Promise<GetOrganizationalGroupsResponse>;
+    /**
+     * Initiate a new match
+     */
+    static initiateMatch(params: InitiateMatchParams): Promise<InitiateMatchResponse>;
+    /**
+     * Join an existing match
+     */
+    static joinMatch(params: JoinMatchParams): Promise<JoinMatchResponse>;
+    /**
+     * Start the match (both players must call this)
+     */
+    static startMatch(params: StartMatchParams): Promise<StartMatchResponse>;
+    /**
+     * Get match state (full details for players, limited for others)
+     */
+    static getMatchState(params: GetMatchStateParams): Promise<Match>;
+    /**
+     * Submit an answer to a question
+     */
+    static submitAnswer(params: SubmitAnswerParams): Promise<SubmitAnswerResponse>;
+    /**
+     * Get all running matches
+     */
+    static getRunningMatches(params: GetRunningMatchesParams): Promise<GetRunningMatchesResponse>;
+    /**
+     * Get highscores/leaderboard
+     */
+    static getHighscores(params: GetHighscoresParams): Promise<GetHighscoresResponse>;
+    /**
+     * Get active (watchable) matches
+     */
+    static getActiveMatches(params: GetActiveMatchesParams): Promise<GetActiveMatchesResponse>;
+    /**
+     * Get player statistics
+     */
+    static getPlayerStats(params: GetPlayerStatsParams): Promise<PlayerStats>;
+    /**
+     * Get waiting matches (matches looking for opponents)
+     */
+    static getWaitingMatches(params: GetWaitingMatchesParams): Promise<GetWaitingMatchesResponse>;
+    /**
+     * Join a random waiting match
+     */
+    static joinRandomMatch(params: JoinRandomMatchParams): Promise<JoinMatchResponse>;
+    /**
+     * Cancel/abandon a match (only creator can cancel, and only in waiting state)
+     */
+    static cancelMatch(params: CancelMatchParams): Promise<CancelMatchResponse>;
+}