academe-kit 0.10.1 → 0.10.3

package/dist/index.d.ts

@@ -10793,6 +10793,80 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/reports/students-journey-status/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Status de jornada dos alunos por bimestre (cards de /students)
+         * @description Recorta os alunos ativos da escola em 4 categorias mutuamente exclusivas
+         *     (notStarted, inJourney, inReview, completed) considerando os challenges
+         *     do bimestre alvo. Cada aluno cai na categoria mais avançada que alcançou.
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description UUID do educational_model_period, OU a string literal `"all"` para considerar todos os bimestres do ano letivo. Omitido = corrente. */
+                    periodId?: string;
+                    /** @description Quando presente, restringe o cálculo a UM challenge específico dentro do recorte temporal. */
+                    challengeId?: string;
+                };
+                header?: never;
+                path: {
+                    /** @description UUID da instituição */
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Status agregado */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["StudentsJourneyStatusResponse"];
+                        };
+                    };
+                };
+                /** @description institutionId inválido ou querystring inválida */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Não autenticado */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Erro interno */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/roles": {
         parameters: {
             query?: never;
@@ -11777,7 +11851,13 @@ interface paths {
                     userId?: string;
                     groupId?: string;
                     institutionId?: string;
+                    /** @description Filtra por turma (institution_classroom) do aluno na instituição */
+                    institutionClassroomId?: string;
+                    /** @description Filtra por série (serie) da turma do aluno na instituição */
+                    serieId?: string;
                     status?: "submitted" | "ai_evaluated" | "approved" | "rejected";
+                    /** @description Busca por nome ou e-mail do aluno (submissão) */
+                    search?: string;
                     /** @description Page number */
                     page?: components["parameters"]["page"];
                     /** @description Items per page */
@@ -12514,6 +12594,11 @@ interface paths {
                      *     Útil para pré-visualização administrativa ou quando o aluno pertence a múltiplas séries.
                      */
                     serieId?: string;
+                    /**
+                     * @description [Admin] Quando presente, retorna a jornada do usuário-alvo em vez da do
+                     *     autenticado. Usado pelo backoffice para visualizar a jornada de um aluno.
+                     */
+                    userId?: string;
                 };
                 header?: never;
                 path?: never;
@@ -12905,6 +12990,86 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/user-challenge-progress/challenges/{id}/users/{userId}/complete-all": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * [Admin] Force-complete ALL steps of a challenge for a target user
+         * @description Marks every active step (challenges_steps) of the challenge as completed for the
+         *     given target user, creating the user_challenge_progress row when it does not exist.
+         *     Idempotent: steps already completed are left untouched.
+         *
+         *     Unlike POST /challenges/{id}/advance (which advances one tick at a time for the
+         *     authenticated user), this endpoint completes the whole challenge at once for the
+         *     user identified in the path. For group challenges, only the target user's progress
+         *     is completed — other group members are not affected.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description ID of the challenge */
+                    id: string;
+                    /** @description ID of the target user whose progress will be completed */
+                    userId: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description All steps completed for the target user */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: {
+                                /** Format: uuid */
+                                challengeId?: string;
+                                /** Format: uuid */
+                                userId?: string;
+                                /** @description Number of active steps in the challenge */
+                                total?: number;
+                                completedSteps?: {
+                                    /** Format: uuid */
+                                    id?: string;
+                                    index?: number;
+                                    name?: string;
+                                    /** Format: date-time */
+                                    completedAt?: string | null;
+                                }[];
+                            };
+                        };
+                    };
+                };
+                401: components["responses"]["Unauthorized"];
+                /** @description Challenge not found or has no active steps */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/user-creation-requests": {
         parameters: {
             query?: never;
@@ -14750,10 +14915,10 @@ interface components {
             maxStudents: number;
             /** @example true */
             isActive: boolean;
-            /** Format: uri */
-            logoUrl?: string | null;
-            /** Format: uri */
-            capaUrl?: string | null;
+            /** Format: uuid */
+            logoFileId?: string | null;
+            /** Format: uuid */
+            capaFileId?: string | null;
             /** Format: uuid */
             addressId?: string | null;
             /** Format: uuid */
@@ -14762,8 +14927,8 @@ interface components {
             createdAt: string;
             /** Format: date-time */
             updatedAt: string;
-            organization?: components["schemas"]["Organization"] | null;
-            address?: components["schemas"]["Address"] | null;
+            organization?: components["schemas"]["Organization"];
+            address?: components["schemas"]["Address"];
             institutionReward?: Record<string, never> | null;
         };
         Organization: {
@@ -16557,10 +16722,12 @@ interface components {
             courses?: components["schemas"]["EncourageJourneyCourse"][];
         };
         EncourageSubmissions: {
+            /** @description Total de alunos ativos da escola (denominador para % concluído) */
             total?: number;
-            evaluated?: number;
+            /** @description Última submissão por (aluno, challenge do bimestre corrente) com teacher_score preenchido */
+            finalized?: number;
+            /** @description Última submissão por (aluno, challenge do bimestre corrente) ainda SEM teacher_score */
             awaitingTeacher?: number;
-            awaitingAi?: number;
         };
         EncourageClassPerformance: {
             /** Format: uuid */
@@ -16611,6 +16778,36 @@ interface components {
             topStudents?: components["schemas"]["EncourageTopStudent"][];
             topTeachers?: components["schemas"]["EncourageTopTeacher"][];
         };
+        StudentsJourneyStatusSummary: {
+            /** @description Alunos sem step concluído nos challenges do recorte */
+            notStarted?: number;
+            /** @description Tem step concluído mas sem submissão */
+            inJourney?: number;
+            /** @description Submissão pendente de avaliação (teacher_score nulo) */
+            inReview?: number;
+            /** @description Submissão já avaliada (teacher_score preenchido) */
+            completed?: number;
+        };
+        StudentsJourneyStatusScope: {
+            /**
+             * Format: uuid
+             * @description UUID do bimestre alvo; null quando allPeriods
+             */
+            periodId?: string | null;
+            /**
+             * Format: uuid
+             * @description UUID do challenge alvo; null quando todos do recorte
+             */
+            challengeId?: string | null;
+            /** @description Quantidade de challenges no recorte */
+            challengesCount?: number;
+            /** @description Total de alunos ativos da escola — fecha com a soma dos 4 status */
+            totalStudents?: number;
+        };
+        StudentsJourneyStatusResponse: {
+            summary?: components["schemas"]["StudentsJourneyStatusSummary"];
+            scope?: components["schemas"]["StudentsJourneyStatusScope"];
+        };
         UserCreationRequest: {
             /**
              * Format: uuid
@@ -16685,15 +16882,15 @@ interface components {
              */
             isActive: boolean;
             /**
-             * Format: uri
-             * @example https://example.com/logo.png
+             * Format: uuid
+             * @description ID do storage_file usado como logo
              */
-            logoUrl?: string;
+            logoFileId?: string;
             /**
-             * Format: uri
-             * @example https://example.com/capa.png
+             * Format: uuid
+             * @description ID do storage_file usado como capa/banner
              */
-            capaUrl?: string;
+            capaFileId?: string;
             /** Format: uuid */
             addressId?: string;
             /** Format: uuid */
@@ -16718,15 +16915,15 @@ interface components {
             /** @example true */
             isActive?: boolean;
             /**
-             * Format: uri
-             * @example https://example.com/logo.png
+             * Format: uuid
+             * @description ID do storage_file usado como logo
              */
-            logoUrl?: string;
+            logoFileId?: string;
             /**
-             * Format: uri
-             * @example https://example.com/capa.png
+             * Format: uuid
+             * @description ID do storage_file usado como capa/banner
              */
-            capaUrl?: string;
+            capaFileId?: string;
             /** Format: uuid */
             addressId?: string;
             /** Format: uuid */
@@ -20276,6 +20473,73 @@ declare function createReportService(apiClient: AcademeApiClient): {
             } | undefined;
         };
     }, `${string}/${string}`>>;
+    /**
+     * Status de jornada dos alunos para os summary cards da rota /students.
+     *
+     * @param id                  UUID da instituição.
+     * @param params.periodId     UUID do bimestre, ou `"all"` para todos os bimestres
+     *                            do ano letivo. Omitido = bimestre corrente.
+     * @param params.challengeId  UUID de UM challenge específico para restringir o
+     *                            cálculo dentro do recorte temporal.
+     */
+    getStudentsJourneyStatusByInstitution(id: string, params?: {
+        periodId?: string;
+        challengeId?: string;
+    }): Promise<openapi_fetch.FetchResponse<{
+        parameters: {
+            query?: {
+                periodId?: string;
+                challengeId?: string;
+            };
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        status?: string;
+                        data?: components["schemas"]["StudentsJourneyStatusResponse"];
+                    };
+                };
+            };
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    }, {
+        params: {
+            path: {
+                id: string;
+            };
+            query: {
+                periodId?: string;
+                challengeId?: string;
+            } | undefined;
+        };
+    }, `${string}/${string}`>>;
 };
 type ReportService = ReturnType<typeof createReportService>;
 
@@ -26200,7 +26464,10 @@ declare function createSubmissionService(apiClient: AcademeApiClient): {
                 userId?: string;
                 groupId?: string;
                 institutionId?: string;
+                institutionClassroomId?: string;
+                serieId?: string;
                 status?: "submitted" | "ai_evaluated" | "approved" | "rejected";
+                search?: string;
                 page?: components["parameters"]["page"];
                 limit?: components["parameters"]["limit"];
             };
@@ -26238,7 +26505,10 @@ declare function createSubmissionService(apiClient: AcademeApiClient): {
                 userId?: string;
                 groupId?: string;
                 institutionId?: string;
+                institutionClassroomId?: string;
+                serieId?: string;
                 status?: "submitted" | "ai_evaluated" | "approved" | "rejected";
+                search?: string;
                 page?: components["parameters"]["page"];
                 limit?: components["parameters"]["limit"];
             } | undefined;
@@ -26535,6 +26805,309 @@ declare function createSubmissionService(apiClient: AcademeApiClient): {
 };
 type SubmissionService = ReturnType<typeof createSubmissionService>;
 
+type JourneyStepView = components["schemas"]["JourneyStepView"];
+type JourneyChallengeView = components["schemas"]["JourneyChallengeView"];
+type JourneyView = components["schemas"]["JourneyView"];
+/**
+ * Service do agregado `user-challenge-progress` — o caminho oficial para os
+ * clientes (web/mobile) montarem a jornada e o progresso do usuário. Espelha
+ * app-academe-v2/src/services/academe/user-progress.service.ts.
+ */
+declare function createUserProgressService(apiClient: AcademeApiClient): {
+    /**
+     * Jornada pré-computada do usuário (status, progress, color, icon,
+     * isUpcoming, série) — base de renderização direta da tela de jornada.
+     *
+     * `userId` é [Admin]: quando informado, retorna a jornada do usuário-alvo
+     * (ex.: backoffice visualizando a jornada de um aluno); omitido = jornada
+     * do próprio usuário autenticado.
+     */
+    getJourney(serieId?: string, userId?: string): Promise<JourneyView>;
+    /**
+     * Visão step-by-step do progresso do usuário em um desafio. Cada step traz
+     * `myStartedAt`, `myCompletedAt` e (em desafios em grupo) os agregados do
+     * grupo.
+     */
+    getChallengeProgress(challengeId: string): Promise<openapi_fetch.FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: components["parameters"]["id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        status?: string;
+                        data?: {
+                            challengeStepId?: string;
+                            stepName?: string;
+                            index?: number;
+                            totalMembers?: number;
+                            completedMembers?: number;
+                            groupCompleted?: boolean;
+                            myStartedAt?: string | null;
+                            myCompletedAt?: string | null;
+                        }[];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+        };
+    }, {
+        params: {
+            path: {
+                id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    /**
+     * Avança um tick na jornada do usuário no desafio, agnóstico do tipo da
+     * etapa. Cada chamada executa UMA ação:
+     *   - Sem progresso na etapa atual → action='started'
+     *   - Etapa iniciada (sem completedAt) → action='completed'
+     *   - Todas as etapas concluídas → action='finished' (no-op)
+     *
+     * Caminho oficial para clientes (web/mobile). Não usar os endpoints
+     * internos `/steps/{stepId}/start` ou `/steps/{stepId}/complete`.
+     */
+    advance(challengeId: string): Promise<openapi_fetch.FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: components["parameters"]["id"];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        status?: string;
+                        data?: {
+                            action?: "started" | "completed" | "finished";
+                            challengeId?: string;
+                            currentStep?: {
+                                id?: string;
+                                index?: number;
+                                name?: string;
+                                startedAt?: string | null;
+                                completedAt?: string | null;
+                            } | null;
+                            nextStep?: {
+                                id?: string;
+                                index?: number;
+                                name?: string;
+                                startedAt?: string | null;
+                            } | null;
+                        };
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+        };
+    }, {
+        params: {
+            path: {
+                id: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    /**
+     * Status de conclusão do grupo numa etapa. Em desafios em grupo: retorna a
+     * agregação (`canAdvance=true` quando todos concluíram). Em desafios
+     * individuais: retorna o status do próprio usuário.
+     */
+    getStepGroupStatus(stepId: string): Promise<openapi_fetch.FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                stepId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        status?: string;
+                        data?: {
+                            isGroupChallenge?: boolean;
+                            totalMembers?: number;
+                            completedMembers?: number;
+                            canAdvance?: boolean;
+                        };
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+        };
+    }, {
+        params: {
+            path: {
+                stepId: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    /**
+     * Progresso agregado do usuário em um módulo (ou no curso inteiro quando
+     * `moduleId` é omitido). Usado pelos steps do tipo `course` da jornada.
+     */
+    getCourseProgress(courseId: string, moduleId?: string | null): Promise<openapi_fetch.FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                courseId: string;
+                moduleId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        status?: string;
+                        data?: components["schemas"]["UsersCourseLogProgress"];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+        };
+    }, {
+        params: {
+            path: {
+                courseId: string;
+                moduleId: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    /**
+     * [Interno] Força o início de uma etapa específica (idempotente). Clientes
+     * devem preferir `advance`; mantido para casos pontuais (ex.: iniciar a
+     * próxima etapa após concluir um curso aberto a partir da jornada).
+     */
+    start(stepId: string): Promise<openapi_fetch.FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                stepId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        status?: string;
+                        data?: components["schemas"]["UserChallengeProgress"];
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: components["responses"]["NotFound"];
+        };
+    }, {
+        params: {
+            path: {
+                stepId: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+    /**
+     * [Admin] Conclui de uma vez TODAS as etapas ativas de um desafio para um
+     * usuário-alvo, criando a linha de progresso quando não existir. Idempotente
+     * — etapas já concluídas não são alteradas.
+     *
+     * Diferente de `advance` (que avança um tick por vez para o usuário
+     * autenticado), aqui o desafio inteiro é concluído de uma vez para o usuário
+     * identificado no path. Em desafios em grupo, apenas o progresso do
+     * usuário-alvo é concluído; os demais membros não são afetados.
+     */
+    completeAllForUser(challengeId: string, userId: string): Promise<openapi_fetch.FetchResponse<{
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+                userId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        status?: string;
+                        data?: {
+                            challengeId?: string;
+                            userId?: string;
+                            total?: number;
+                            completedSteps?: {
+                                id?: string;
+                                index?: number;
+                                name?: string;
+                                completedAt?: string | null;
+                            }[];
+                        };
+                    };
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    }, {
+        params: {
+            path: {
+                id: string;
+                userId: string;
+            };
+        };
+    }, `${string}/${string}`>>;
+};
+type UserProgressService = ReturnType<typeof createUserProgressService>;
+
 type AcademeApiClient = ReturnType<typeof openapi_fetch__default<paths>>;
 declare function createAcademeApiClient(baseUrl: string): AcademeApiClient;
 interface AcademeServices {
@@ -26559,6 +27132,7 @@ interface AcademeServices {
     challenge: ChallengeService;
     step: StepService;
     submission: SubmissionService;
+    userProgress: UserProgressService;
 }
 
 type AcademeKeycloakContextProps = {
@@ -26655,4 +27229,4 @@ declare enum NINA_ROLES {
 }
 
 export { AcademeAuthProvider, BACKOFFICE_ROLES, Button, CosmicDecor, CosmicStarsCanvas, DASHBOARD_ROLES, GLOBAL_ROLES, JourneyCrystalPin, JourneyStep, MIKE_ROLES, NINA_ROLES, ProtectedApp, ProtectedComponent, ProtectedRouter, STREAMING_ROLES, Spinner, WIDGET_ROLES, academeApi_d as apiTypes, cn, createAcademeApiClient, index_d as types, useAcademeAuth, useProtectedAppColors };
-export type { AcademeApiClient, AcademeKeycloakContextProps, AcademeServices, AcademeUser, ButtonProps, ChallengeUserQuizAttempt, ChallengeUserQuizAttemptsResponse, CosmicDecorProps, CosmicDecorVariant, CosmicPlanet, CosmicStarsCanvasProps, FrameKind, JourneyCrystalPinProps, JourneyStepProps, JourneyStepSize, JourneyStepType, KeycloakUser, RequiredClientRoles, SecurityContextType, SecurityProviderProps };
+export type { AcademeApiClient, AcademeKeycloakContextProps, AcademeServices, AcademeUser, ButtonProps, ChallengeUserQuizAttempt, ChallengeUserQuizAttemptsResponse, CosmicDecorProps, CosmicDecorVariant, CosmicPlanet, CosmicStarsCanvasProps, FrameKind, JourneyChallengeView, JourneyCrystalPinProps, JourneyStepProps, JourneyStepSize, JourneyStepType, JourneyStepView, JourneyView, KeycloakUser, RequiredClientRoles, SecurityContextType, SecurityProviderProps };