academe-kit 0.12.0 → 0.13.0

package/dist/types/index.d.ts

@@ -20,6 +20,8 @@ export { createAcademeApiClient } from "./services";
 export type { AcademeApiClient, AcademeServices } from "./services";
 export type { ChallengeUserQuizAttempt, ChallengeUserQuizAttemptsResponse, } from "./services/ChallengeService";
 export type { JourneyStepView, JourneyChallengeView, JourneyView, } from "./services/UserProgressService";
+export type { AccessibleSerie, ClassroomSummary, UserEnrollment, } from "./services/userService";
+export type { VitrineHome, VitrinePlaylist, VitrineCard, VitrineCardKind, VitrinePlaylistSource, VitrineCardOrientation, } from "./services/VitrineService";
 export { cn } from "./lib/utils";
 import "./index.css";
 import "./styles/globals.css";

package/dist/types/services/UserProgressService.d.ts

@@ -16,8 +16,15 @@ export declare function createUserProgressService(apiClient: AcademeApiClient):
      * `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.
+     *
+     * `institutionId` é a escola ATUAL: a jornada é POR ESCOLA (o usuário pode
+     * estar em várias). Omitido = 1ª matrícula resolvida no backend.
+     *
+     * ⚠️ Ordem dos parâmetros: `institutionId` foi adicionado como 3º parâmetro
+     * (após `userId`) para NÃO quebrar chamadas posicionais existentes — o
+     * backoffice chama `getJourney(undefined, userId)`.
      */
-    getJourney(serieId?: string, userId?: string): Promise<JourneyView>;
+    getJourney(serieId?: string, userId?: string, institutionId?: 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

package/dist/types/services/VitrineService.d.ts

@@ -0,0 +1,51 @@
+import type { AcademeApiClient } from "./index";
+/**
+ * Vitrine (Home) do aluno — rails/playlists estilo Netflix.
+ * Consome `GET /vitrine/home` do api-academe-v2.
+ *
+ * ⚠️ O endpoint ainda NÃO está no OpenAPI gerado (`academe-api.ts`), então os
+ * tipos abaixo são MANTIDOS À MÃO e a chamada usa cast — mesmo padrão de
+ * `InstitutionService.setUserClassrooms`. Quando o backend expuser o schema,
+ * regenerar os tipos e apertar.
+ */
+export type VitrineCardKind = "course" | "module" | "lesson" | "playlist";
+export type VitrinePlaylistSource = "curated" | "continue_watching" | "trending" | "watchlist" | "recent" | "continue_playlist";
+export type VitrineCardOrientation = "horizontal" | "vertical" | "square" | "fullImage";
+export interface VitrineCard {
+    kind: VitrineCardKind;
+    id: string;
+    courseId?: string | null;
+    title: string;
+    subtitle?: string | null;
+    coverUrl?: string | null;
+    durationSeconds?: number | null;
+    progressPct?: number | null;
+    courseTitle?: string | null;
+    lessonLabel?: string | null;
+    rank?: number | null;
+}
+export interface VitrinePlaylist {
+    id: string;
+    title: string;
+    subtitle: string | null;
+    source: VitrinePlaylistSource;
+    variant: "common" | "featured";
+    cardOrientation: VitrineCardOrientation;
+    itemsPerViewDesktop: number;
+    itemsPerViewMobile: number;
+    autoplay: boolean;
+    style: Record<string, unknown>;
+    items: VitrineCard[];
+}
+export interface VitrineHome {
+    institutionId: string | null;
+    playlists: VitrinePlaylist[];
+}
+export declare function createVitrineService(apiClient: AcademeApiClient): {
+    /**
+     * Home do aluno para a escola atual. `institutionId` omitido = 1ª matrícula
+     * (o backend resolve). Recarregar ao trocar de escola no app.
+     */
+    getHome(institutionId?: string): Promise<VitrineHome>;
+};
+export type VitrineService = ReturnType<typeof createVitrineService>;

package/dist/types/services/index.d.ts

@@ -22,6 +22,7 @@ import { type ChallengeService } from './ChallengeService';
 import { type StepService } from './StepService';
 import { type SubmissionService } from './SubmissionService';
 import { type UserProgressService } from './UserProgressService';
+import { type VitrineService } from './VitrineService';
 export type AcademeApiClient = ReturnType<typeof createClient<paths>>;
 export declare function createAcademeApiClient(baseUrl: string): AcademeApiClient;
 export interface AcademeServices {
@@ -47,6 +48,7 @@ export interface AcademeServices {
     step: StepService;
     submission: SubmissionService;
     userProgress: UserProgressService;
+    vitrine: VitrineService;
 }
 export declare function createAcademeServices(apiClient: AcademeApiClient): AcademeServices;
 export { createUserService, type UserService } from "./userService";
@@ -70,3 +72,4 @@ export { createChallengeService, type ChallengeService } from './ChallengeServic
 export { createStepService, type StepService } from './StepService';
 export { createSubmissionService, type SubmissionService } from './SubmissionService';
 export { createUserProgressService, type UserProgressService } from './UserProgressService';
+export { createVitrineService, type VitrineService } from './VitrineService';

package/dist/types/services/userService.d.ts

@@ -12,6 +12,30 @@ type GetUsersParams = {
     page?: number;
     limit?: number;
 };
+/** Série acessível ao aluno (item do seletor de séries da jornada). */
+export type AccessibleSerie = {
+    serieId: string;
+    serieValue: number;
+    serieLabel: string;
+    level: "fundamental" | "medio";
+};
+/** Turma do aluno (resumo) — para a listagem de turmas no perfil. */
+export type ClassroomSummary = {
+    institutionClassroomId: string;
+    classroomId: string;
+    classroomName: string;
+    shiftName: string | null;
+    serie: AccessibleSerie | null;
+    institutionId: string;
+    institutionName: string | null;
+};
+/** Contexto de matrícula do usuário: turmas + escola atual + séries distintas. */
+export type UserEnrollment = {
+    classrooms: ClassroomSummary[];
+    /** Escola atual resolvida pelo backend (1ª matrícula) — tem turma. */
+    currentInstitutionId: string | null;
+    series: AccessibleSerie[];
+};
 export declare function createUserService(apiClient: AcademeApiClient): {
     /**
      * Get current authenticated user
@@ -63,6 +87,13 @@ export declare function createUserService(apiClient: AcademeApiClient): {
             500: components["responses"]["ServerError"];
         };
     }> | undefined, `${string}/${string}`>>;
+    /**
+     * Contexto de matrícula do usuário: turmas (para o perfil) + séries
+     * distintas (para o seletor de séries da jornada) + escola atual. Fonte
+     * única, deduplicada e ordenada no backend. Normaliza os campos opcionais do
+     * OpenAPI. Espelha o app-academe (user.service.getMyEnrollment).
+     */
+    getMyEnrollment(): Promise<UserEnrollment>;
     /**
      * List all users with optional filters
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "academe-kit",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "type": "module",
   "description": "Official React SDK for Academe ecosystem - Authentication, protected routes, API services, and UI components for educational management applications",
   "main": "dist/index.cjs",