academe-kit 0.10.2 → 0.10.3

package/dist/index.d.ts

@@ -10809,7 +10809,7 @@ interface paths {
         get: {
             parameters: {
                 query?: {
-                    /** @description UUID do educational_model_period, OU a string literal `"all"` para considerar todos os bimestres. Omitido = corrente. */
+                    /** @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;
@@ -10836,18 +10836,21 @@ interface paths {
                         };
                     };
                 };
+                /** @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;
@@ -11848,13 +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 */
+                    /** @description Busca por nome ou e-mail do aluno (submissão) */
                     search?: string;
-                    /** @description UUID de um educational_model_period. Recorta as submissões cuja data de envio (submittedAt) cai no intervalo [start, end] do período. Omitido = todos os períodos. */
-                    periodId?: string;
                     /** @description Page number */
                     page?: components["parameters"]["page"];
                     /** @description Items per page */
@@ -11875,16 +11878,7 @@ interface paths {
                         "application/json": {
                             /** @example success */
                             status?: string;
-                            data?: (components["schemas"]["Submission"] & {
-                                /** @description Período letivo cujo intervalo contém a data de envio (submittedAt). Null quando a escola não tem períodos ou o envio caiu fora de qualquer período. */
-                                period?: {
-                                    id?: string;
-                                    /** @description 0-based (0 = 1º período) */
-                                    index?: number;
-                                    /** @example 1º Bimestre */
-                                    label?: string;
-                                } | null;
-                            })[];
+                            data?: components["schemas"]["Submission"][];
                             meta?: components["schemas"]["PaginationMeta"] & {
                                 /**
                                  * @description Contagem por status, ignorando o filtro `status`. Útil para
@@ -11900,14 +11894,6 @@ interface paths {
                                     /** @example 2 */
                                     rejected?: number;
                                 };
-                                /** @description Períodos letivos da escola (ORDER BY start ASC) para o dropdown de filtro. */
-                                periods?: {
-                                    id?: string;
-                                    index?: number;
-                                    /** @example 1º Bimestre */
-                                    label?: string;
-                                    isCurrent?: boolean;
-                                }[];
                             };
                         };
                     };
@@ -12608,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;
@@ -12999,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;
@@ -14844,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 */
@@ -14856,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: {
@@ -16658,30 +16729,6 @@ interface components {
             /** @description Última submissão por (aluno, challenge do bimestre corrente) ainda SEM teacher_score */
             awaitingTeacher?: number;
         };
-        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: {
-            /** @description UUID do bimestre alvo; null quando allPeriods */
-            periodId?: string | null;
-            /** @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"];
-        };
         EncourageClassPerformance: {
             /** Format: uuid */
             classroomId?: string;
@@ -16731,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
@@ -16805,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 */
@@ -16838,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 */
@@ -26391,7 +26468,6 @@ declare function createSubmissionService(apiClient: AcademeApiClient): {
                 serieId?: string;
                 status?: "submitted" | "ai_evaluated" | "approved" | "rejected";
                 search?: string;
-                periodId?: string;
                 page?: components["parameters"]["page"];
                 limit?: components["parameters"]["limit"];
             };
@@ -26408,13 +26484,7 @@ declare function createSubmissionService(apiClient: AcademeApiClient): {
                 content: {
                     "application/json": {
                         status?: string;
-                        data?: (components["schemas"]["Submission"] & {
-                            period?: {
-                                id?: string;
-                                index?: number;
-                                label?: string;
-                            } | null;
-                        })[];
+                        data?: components["schemas"]["Submission"][];
                         meta?: components["schemas"]["PaginationMeta"] & {
                             statusCounts?: {
                                 submitted?: number;
@@ -26422,12 +26492,6 @@ declare function createSubmissionService(apiClient: AcademeApiClient): {
                                 approved?: number;
                                 rejected?: number;
                             };
-                            periods?: {
-                                id?: string;
-                                index?: number;
-                                label?: string;
-                                isCurrent?: boolean;
-                            }[];
                         };
                     };
                 };
@@ -26445,7 +26509,6 @@ declare function createSubmissionService(apiClient: AcademeApiClient): {
                 serieId?: string;
                 status?: "submitted" | "ai_evaluated" | "approved" | "rejected";
                 search?: string;
-                periodId?: string;
                 page?: components["parameters"]["page"];
                 limit?: components["parameters"]["limit"];
             } | undefined;
@@ -26742,6 +26805,8 @@ 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
@@ -26752,8 +26817,12 @@ 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): Promise<JourneyView>;
+    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
@@ -26975,6 +27044,67 @@ declare function createUserProgressService(apiClient: AcademeApiClient): {
             };
         };
     }, `${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>;
 
@@ -27099,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 };

package/dist/index.esm.js

@@ -6369,10 +6369,19 @@ function createUserProgressService(apiClient) {
         /**
          * 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.
          */
-        async getJourney(serieId) {
+        async getJourney(serieId, userId) {
+            const query = {};
+            if (serieId)
+                query.serieId = serieId;
+            if (userId)
+                query.userId = userId;
             const res = await apiClient.GET("/user-challenge-progress/journey", {
-                params: { query: serieId ? { serieId } : undefined },
+                params: { query: Object.keys(query).length > 0 ? query : undefined },
             });
             return res.data.data;
         },
@@ -6433,6 +6442,19 @@ function createUserProgressService(apiClient) {
                 params: { path: { stepId } },
             });
         },
+        /**
+         * [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, userId) {
+            return apiClient.POST("/user-challenge-progress/challenges/{id}/users/{userId}/complete-all", { params: { path: { id: challengeId, userId } } });
+        },
     };
 }