academe-kit 0.9.7 → 0.9.8

package/dist/index.d.ts

@@ -2109,6 +2109,12 @@ interface paths {
                     templatesOnly?: boolean;
                     /** @description Search by title */
                     search?: string;
+                    /**
+                     * @description Comma-separated list of extra relations to load. Currently supported:
+                     *     `steps` — embeds each challenge's `steps` (with their catalog `step`).
+                     *     Opt-in to avoid penalizing list views that don't need them.
+                     */
+                    include?: "steps";
                     /** @description Page number */
                     page?: components["parameters"]["page"];
                     /** @description Items per page */
@@ -2163,6 +2169,11 @@ interface paths {
                         maxGroupMembers?: number;
                         /** @default false */
                         isInviteOnly?: boolean;
+                        /**
+                         * Format: uuid
+                         * @description Curso ao qual o desafio está associado (agrupa a jornada no dashboard)
+                         */
+                        courseId: string;
                         /** Format: uuid */
                         institutionId?: string | null;
                         /** Format: uuid */
@@ -2305,6 +2316,8 @@ interface paths {
                         maxGroupMembers?: number;
                         isInviteOnly?: boolean;
                         /** Format: uuid */
+                        courseId?: string;
+                        /** Format: uuid */
                         serieId?: string;
                         index?: number;
                         /** @enum {string} */
@@ -2411,9 +2424,10 @@ interface paths {
         /**
          * Add a step to the challenge
          * @description Polymorphic validation:
-         *     - When step.type=course, courseId is required
          *     - When step.type=tutorial, tutorialVideoUrl is required
-         *     - Other types must not have these specialized fields
+         *     - The course of a step is determined by the parent challenge's courseId.
+         *       Optionally, courseModuleId pinpoints a specific module within that course.
+         *     - tutorial fields are optional on any step type.
          */
         post: {
             parameters: {
@@ -2437,8 +2451,6 @@ interface paths {
                         description?: string;
                         index: number;
                         /** Format: uuid */
-                        courseId?: string;
-                        /** Format: uuid */
                         courseModuleId?: string;
                         tutorialTitle?: string;
                         tutorialDescription?: string;
@@ -9566,6 +9578,8 @@ interface paths {
                     page?: number;
                     /** @description Items per page */
                     limit?: number;
+                    /** @description When true, returns questions in random order with shuffled answer alternatives. Each request reshuffles independently. */
+                    randomize?: boolean;
                 };
                 header?: never;
                 path?: never;
@@ -10619,6 +10633,76 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/reports/encourage-dashboard/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Payload completo da nova tela /new-dashboard
+         * @description Retorna o dashboard agregado por instituição: overview, KPIs,
+         *     licenças (apenas tipo aluno), jornada (cursos deduplicados),
+         *     submissões, desempenho por turma, top 10 alunos (por certificados,
+         *     desempate por nota) e top 10 professores (por avaliações).
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description ID da instituição */
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Payload completo do encourage dashboard */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: components["schemas"]["EncourageDashboardResponse"];
+                        };
+                    };
+                };
+                /** @description institutionId inválido */
+                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;
@@ -12287,6 +12371,86 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/user-challenge-progress/challenges/{id}/advance": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Advance one tick in the user's journey on a challenge
+         * @description Unified journey advancement, agnostic of step type. Each call performs ONE action:
+         *
+         *     1. Resolves the current step = first active step (by index) not yet completed by the user.
+         *     2. If no progress row exists for that step → creates one (action='started').
+         *     3. If progress row exists with completed_at IS NULL → sets completed_at (action='completed').
+         *     4. If all steps are completed → no-op (action='finished').
+         *
+         *     Web and mobile clients must use this endpoint regardless of the step type
+         *     (challenge, course, tutorial, publication, evaluation, certificate).
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Resource ID */
+                    id: components["parameters"]["id"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Tick result */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: {
+                                /** @enum {string} */
+                                action?: "started" | "completed" | "finished";
+                                /** Format: uuid */
+                                challengeId?: string;
+                                currentStep?: {
+                                    /** Format: uuid */
+                                    id?: string;
+                                    index?: number;
+                                    name?: string;
+                                    /** Format: date-time */
+                                    startedAt?: string | null;
+                                    /** Format: date-time */
+                                    completedAt?: string | null;
+                                } | null;
+                                /** @description Next step in the journey. When action='completed', this step is also auto-started on the same call (startedAt populated). */
+                                nextStep?: {
+                                    /** Format: uuid */
+                                    id?: string;
+                                    index?: number;
+                                    name?: string;
+                                    /** Format: date-time */
+                                    startedAt?: string | null;
+                                } | null;
+                            };
+                        };
+                    };
+                };
+                401: components["responses"]["Unauthorized"];
+                404: components["responses"]["NotFound"];
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/user-challenge-progress/steps/{stepId}/start": {
         parameters: {
             query?: never;
@@ -12297,9 +12461,12 @@ interface paths {
         get?: never;
         put?: never;
         /**
-         * Start a challenge step (idempotent)
-         * @description Creates a user_challenge_progress row. If one already exists for this user/step,
+         * [Internal/Admin] Force-start a specific challenge step (idempotent)
+         * @description Creates a user_challenge_progress row for the given step. If one already exists,
          *     returns the existing row (idempotent).
+         *
+         *     Client apps (web/mobile) should use POST /user-challenge-progress/challenges/{id}/advance
+         *     instead. This endpoint is retained for internal/admin tooling that needs to force a state.
          */
         post: {
             parameters: {
@@ -12346,8 +12513,12 @@ interface paths {
         get?: never;
         put?: never;
         /**
-         * Mark step as completed
-         * @description Sets completed_at on the user's progress row. Idempotent (no-op if already completed)
+         * [Internal/Admin] Force-complete a specific challenge step
+         * @description Sets completed_at on the user's progress row for the given step. Idempotent
+         *     (no-op if already completed).
+         *
+         *     Client apps (web/mobile) should use POST /user-challenge-progress/challenges/{id}/advance
+         *     instead. This endpoint is retained for internal/admin tooling that needs to force a state.
          */
         post: {
             parameters: {
@@ -14909,6 +15080,11 @@ interface components {
             maxGroupMembers?: number;
             /** @example false */
             isInviteOnly?: boolean;
+            /**
+             * Format: uuid
+             * @description Curso ao qual o desafio está associado (agrupa a jornada no dashboard)
+             */
+            courseId?: string;
             /**
              * Format: uuid
              * @description Null para template global
@@ -14944,6 +15120,8 @@ interface components {
             createdAt?: string;
             /** Format: date-time */
             updatedAt?: string;
+            /** @description Populado quando `include=steps` é informado no GET /challenges, ou via GET /challenges/{id} */
+            steps?: components["schemas"]["ChallengeStep"][];
         };
         ChallengeMedia: {
             /** Format: uuid */
@@ -14972,10 +15150,8 @@ interface components {
             index?: number;
             /**
              * Format: uuid
-             * @description Obrigatório quando step type=course
+             * @description Opcional. Quando step type=course, aponta para o módulo específico do curso do challenge.
              */
-            courseId?: string | null;
-            /** Format: uuid */
             courseModuleId?: string | null;
             tutorialTitle?: string | null;
             tutorialDescription?: string | null;
@@ -14986,6 +15162,8 @@ interface components {
             createdAt?: string;
             /** Format: date-time */
             updatedAt?: string;
+            /** @description Catálogo do step (cor, ícone, tipo). Populado junto com o relation `steps.step`. */
+            step?: components["schemas"]["Step"];
         };
         /** @description Item do checklist descritivo de entrega */
         ChallengeDeliveryStep: {
@@ -15995,6 +16173,121 @@ interface components {
             totalStudents?: number;
             year?: number;
         };
+        EncourageActivePeriod: {
+            /** Format: uuid */
+            id?: string;
+            /** Format: date-time */
+            start?: string;
+            /** Format: date-time */
+            end?: string;
+            /** @example Bimestre */
+            label?: string;
+            /** @example 4 */
+            periodsPerYear?: number;
+        };
+        EncourageOverview: {
+            userFirstName?: string;
+            institutionName?: string;
+            activePeriod?: components["schemas"]["EncourageActivePeriod"];
+            /** Format: float */
+            globalProgressPct?: number;
+        };
+        EncourageKpis: {
+            totalStudents?: number;
+            /** Format: float */
+            totalStudentsDeltaPct?: number;
+            completedProjects?: number;
+            /** Format: float */
+            completedProjectsDeltaPct?: number;
+            /** Format: float */
+            engagementRatePct?: number;
+            /** Format: float */
+            engagementRateDeltaPct?: number;
+            neverLoggedIn?: number;
+            neverLoggedInDelta?: number;
+        };
+        /** @description Licenças do tipo aluno (seats.group_id → group.type = 'student') */
+        EncourageLicenses: {
+            used?: number;
+            total?: number;
+            /** Format: float */
+            pct?: number;
+            available?: number;
+        };
+        EncourageJourneyCourse: {
+            /** Format: uuid */
+            courseId?: string;
+            title?: string;
+            /** Format: date-time */
+            dueDate?: string;
+            /** Format: float */
+            progressPct?: number;
+            challengesCount?: number;
+            color?: string;
+        };
+        EncourageJourney: {
+            totalCourses?: number;
+            /** Format: float */
+            averageProgressPct?: number;
+            /** @enum {string} */
+            periodKind?: "semester" | "trimester" | "bimester";
+            courses?: components["schemas"]["EncourageJourneyCourse"][];
+        };
+        EncourageSubmissions: {
+            total?: number;
+            evaluated?: number;
+            awaitingTeacher?: number;
+            awaitingAi?: number;
+        };
+        EncourageClassPerformance: {
+            /** Format: uuid */
+            classroomId?: string;
+            /** @example 2º A — Médio */
+            name?: string;
+            /** @example Manhã */
+            meta?: string;
+            /** @description Total de alunos cadastrados na turma */
+            studentsCount?: number;
+            /** @description Alunos que submeteram pelo menos 1 challenge do período ativo */
+            submittedCount?: number;
+            /** Format: float */
+            progressPct?: number;
+            /** @enum {string} */
+            level?: "high" | "medium" | "low";
+        };
+        EncourageTopStudent: {
+            /** Format: uuid */
+            userId?: string;
+            rank?: number;
+            name?: string;
+            initials?: string;
+            avatarColor?: string;
+            certificates?: number;
+            /** Format: float */
+            averageScore?: number;
+        };
+        EncourageTopTeacher: {
+            /** Format: uuid */
+            userId?: string;
+            rank?: number;
+            name?: string;
+            initials?: string;
+            avatarColor?: string;
+            evaluationsCount?: number;
+            averageEvaluationSeconds?: number;
+            /** Format: float */
+            averageScore?: number;
+        };
+        EncourageDashboardResponse: {
+            overview?: components["schemas"]["EncourageOverview"];
+            kpis?: components["schemas"]["EncourageKpis"];
+            licenses?: components["schemas"]["EncourageLicenses"];
+            journey?: components["schemas"]["EncourageJourney"];
+            submissions?: components["schemas"]["EncourageSubmissions"];
+            classes?: components["schemas"]["EncourageClassPerformance"][];
+            topStudents?: components["schemas"]["EncourageTopStudent"][];
+            topTeachers?: components["schemas"]["EncourageTopTeacher"][];
+        };
         UserCreationRequest: {
             /**
              * Format: uuid
@@ -21720,6 +22013,7 @@ declare function createQuizService(apiClient: AcademeApiClient): {
                 search?: string;
                 page?: number;
                 limit?: number;
+                randomize?: boolean;
             };
             header?: never;
             path?: never;
@@ -21750,6 +22044,7 @@ declare function createQuizService(apiClient: AcademeApiClient): {
                 search?: string;
                 page?: number;
                 limit?: number;
+                randomize?: boolean;
             } | undefined;
         };
     }, `${string}/${string}`>>;
@@ -24500,7 +24795,6 @@ interface UpdateChallengeStepBody {
     name?: string;
     description?: string;
     index?: number;
-    courseId?: string;
     courseModuleId?: string;
     tutorialTitle?: string;
     tutorialDescription?: string;
@@ -24532,6 +24826,7 @@ declare function createChallengeService(apiClient: AcademeApiClient): {
                 isActive?: boolean;
                 templatesOnly?: boolean;
                 search?: string;
+                include?: "steps";
                 page?: components["parameters"]["page"];
                 limit?: components["parameters"]["limit"];
             };
@@ -24564,6 +24859,7 @@ declare function createChallengeService(apiClient: AcademeApiClient): {
                 isActive?: boolean;
                 templatesOnly?: boolean;
                 search?: string;
+                include?: "steps";
                 page?: components["parameters"]["page"];
                 limit?: components["parameters"]["limit"];
             } | undefined;
@@ -24628,6 +24924,7 @@ declare function createChallengeService(apiClient: AcademeApiClient): {
                     isGroup?: boolean;
                     maxGroupMembers?: number;
                     isInviteOnly?: boolean;
+                    courseId: string;
                     institutionId?: string | null;
                     serieId?: string;
                     index?: number;
@@ -24666,6 +24963,7 @@ declare function createChallengeService(apiClient: AcademeApiClient): {
             isGroup?: boolean;
             maxGroupMembers?: number;
             isInviteOnly?: boolean;
+            courseId: string;
             institutionId?: string | null;
             serieId?: string;
             index?: number;
@@ -24699,6 +24997,7 @@ declare function createChallengeService(apiClient: AcademeApiClient): {
                     isGroup?: boolean;
                     maxGroupMembers?: number;
                     isInviteOnly?: boolean;
+                    courseId?: string;
                     serieId?: string;
                     index?: number;
                     submissionType?: "images" | "videos" | "audio" | "files" | "links";
@@ -24739,6 +25038,7 @@ declare function createChallengeService(apiClient: AcademeApiClient): {
             isGroup?: boolean;
             maxGroupMembers?: number;
             isInviteOnly?: boolean;
+            courseId?: string;
             serieId?: string;
             index?: number;
             submissionType?: "images" | "videos" | "audio" | "files" | "links";
@@ -24844,7 +25144,6 @@ declare function createChallengeService(apiClient: AcademeApiClient): {
                     name: string;
                     description?: string;
                     index: number;
-                    courseId?: string;
                     courseModuleId?: string;
                     tutorialTitle?: string;
                     tutorialDescription?: string;
@@ -24879,7 +25178,6 @@ declare function createChallengeService(apiClient: AcademeApiClient): {
             name: string;
             description?: string;
             index: number;
-            courseId?: string;
             courseModuleId?: string;
             tutorialTitle?: string;
             tutorialDescription?: string;