academe-kit 0.9.0 → 0.9.1

package/dist/types/types/academe-api.d.ts

@@ -221,6 +221,221 @@ export interface paths {
         };
         trace?: never;
     };
+    "/auth/forgot-password": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Request password reset email
+         * @description Sends a password reset email to the specified address if a user with that email exists.
+         *
+         *     **Security Note:**
+         *     For security reasons, this endpoint always returns a success response regardless of whether
+         *     the email exists in the system. This prevents email enumeration attacks.
+         *
+         *     **Flow:**
+         *     1. Client sends email address
+         *     2. Backend searches for user by email in Keycloak
+         *     3. If user exists, Keycloak sends password reset email with UPDATE_PASSWORD action
+         *     4. User receives email with link valid for 1 hour
+         *     5. Endpoint returns success (regardless of whether email was found)
+         *
+         *     **Email Template:**
+         *     The email sent uses the Keycloak realm's configured email template for password reset.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: email
+                         * @description User's email address
+                         * @example user@example.com
+                         */
+                        email: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Request processed successfully (always returned for security) */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            /** @example If this email is registered, you will receive password reset instructions. */
+                            message?: string;
+                        };
+                    };
+                };
+                /** @description Bad Request - Email not provided */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example error */
+                            status?: string;
+                            /** @example Email is required */
+                            message?: string;
+                        };
+                    };
+                };
+                /** @description Internal Server Error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example error */
+                            status?: string;
+                            /** @example Internal server error */
+                            message?: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/auth/google-exchange": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Exchange Google access token for Keycloak tokens
+         * @description Exchanges a Google access token for Keycloak tokens.
+         *
+         *     **Flow:**
+         *     1. Client sends Google access token
+         *     2. Backend fetches user email from Google Userinfo API
+         *     3. Backend verifies the email exists in the local database
+         *     4. If user exists, performs Keycloak token exchange
+         *     5. Returns Keycloak tokens (access_token, refresh_token, etc.)
+         *
+         *     **Error Cases:**
+         *     - 400: Invalid or expired Google token
+         *     - 404: User email not found in database
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * @description Google OAuth2 access token
+                         * @example ya29.a0AfH6SM...
+                         */
+                        googleAccessToken: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Token exchange successful */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: {
+                                /** @description Keycloak access token */
+                                access_token?: string;
+                                /** @description Keycloak refresh token */
+                                refresh_token?: string;
+                                /** @description Token expiration time in seconds */
+                                expires_in?: number;
+                                /** @description Refresh token expiration time in seconds */
+                                refresh_expires_in?: number;
+                                /** @example Bearer */
+                                token_type?: string;
+                                scope?: string;
+                            };
+                        };
+                    };
+                };
+                /** @description Bad Request - Invalid Google token or missing googleAccessToken */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example error */
+                            status?: string;
+                            /** @example Token do Google inválido ou expirado */
+                            message?: string;
+                        };
+                    };
+                };
+                /** @description Not Found - User email not registered in database */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example error */
+                            status?: string;
+                            /** @example Usuário não encontrado */
+                            message?: string;
+                        };
+                    };
+                };
+                /** @description Internal Server Error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example error */
+                            status?: string;
+                            /** @example Internal server error */
+                            message?: string;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/auth/token": {
         parameters: {
             query?: never;
@@ -832,13 +1047,24 @@ export interface paths {
         };
         /**
          * List all certificates
-         * @description Retrieve a list of all certificates in the system.
+         * @description Retrieve a paginated list of all certificates in the system.
          *     Each certificate includes course information (id, title, description) when available.
          *     Course data is extracted from the related Quiz through QuizAttempt.
          */
         get: {
             parameters: {
-                query?: never;
+                query?: {
+                    /** @description Filter certificates by user ID */
+                    userId?: string;
+                    /** @description Search term */
+                    search?: components["parameters"]["search"];
+                    /** @description Page number */
+                    page?: components["parameters"]["page"];
+                    /** @description Items per page */
+                    limit?: components["parameters"]["limit"];
+                    /** @description Whether to include course data in the response (default true). Pass false to skip course lookup. */
+                    includeCourse?: boolean;
+                };
                 header?: never;
                 path?: never;
                 cookie?: never;
@@ -855,6 +1081,16 @@ export interface paths {
                             /** @example success */
                             status?: string;
                             data?: components["schemas"]["Certificate"][];
+                            meta?: {
+                                /** @example 10 */
+                                total?: number;
+                                /** @example 1 */
+                                page?: number;
+                                /** @example 10 */
+                                limit?: number;
+                                /** @example 1 */
+                                totalPages?: number;
+                            };
                         };
                     };
                 };
@@ -890,8 +1126,6 @@ export interface paths {
                             /** @example success */
                             status?: string;
                             data?: components["schemas"]["Certificate"];
-                            /** @example Certificate created successfully */
-                            message?: string;
                         };
                     };
                 };
@@ -969,18 +1203,11 @@ export interface paths {
             requestBody?: never;
             responses: {
                 /** @description Certificate deleted successfully */
-                200: {
+                204: {
                     headers: {
                         [name: string]: unknown;
                     };
-                    content: {
-                        "application/json": {
-                            /** @example success */
-                            status?: string;
-                            /** @example Certificate deleted successfully */
-                            message?: string;
-                        };
-                    };
+                    content?: never;
                 };
                 400: components["responses"]["BadRequest"];
                 401: components["responses"]["Unauthorized"];
@@ -1020,8 +1247,6 @@ export interface paths {
                             /** @example success */
                             status?: string;
                             data?: components["schemas"]["Certificate"];
-                            /** @example Certificate updated successfully */
-                            message?: string;
                         };
                     };
                 };
@@ -1033,6 +1258,109 @@ export interface paths {
         };
         trace?: never;
     };
+    "/certificates/{id}/download": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Download certificate PDF
+         * @description Download the PDF of a specific certificate.
+         *     Acts as a proxy to download from S3, avoiding CORS issues.
+         *     Only the certificate owner can download their certificate.
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Resource ID */
+                    id: components["parameters"]["id"];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Certificate PDF file */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/pdf": string;
+                    };
+                };
+                401: components["responses"]["Unauthorized"];
+                403: components["responses"]["Forbidden"];
+                404: components["responses"]["NotFound"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/certificates/generate": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Generate a certificate PDF server-side
+         * @description Generates a certificate PDF on the server and creates the certificate record.
+         *     This eliminates CORS issues by downloading the template image on the server.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": components["schemas"]["GenerateCertificateDto"];
+                };
+            };
+            responses: {
+                /** @description Certificate generated and created successfully */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            data?: {
+                                certificate?: components["schemas"]["Certificate"];
+                                /** @example https://s3.amazonaws.com/bucket/certificate.pdf */
+                                pdfUrl?: string;
+                            };
+                        };
+                    };
+                };
+                400: components["responses"]["BadRequest"];
+                401: components["responses"]["Unauthorized"];
+                500: components["responses"]["ServerError"];
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/classrooms": {
         parameters: {
             query?: never;
@@ -9540,6 +9868,8 @@ export interface paths {
             requestBody: {
                 content: {
                     "application/json": {
+                        /** @example sa@academe.com.br */
+                        email?: string;
                         /** @example John */
                         firstName?: string;
                         /** @example Doe */
@@ -9939,7 +10269,19 @@ export interface paths {
         head?: never;
         /**
          * Update user
-         * @description Update user information
+         * @description Update user information.
+         *
+         *     **Profile and seat code behavior:**
+         *     - Send `groupId` to change the user's profile/group.
+         *     - When `groupId` changes, the system will:
+         *       1. Release the previous seat code used by the user (`isReserved = false`)
+         *       2. Allocate a seat code for the new group in the same institution registration
+         *       3. Create a new seat code automatically if none is available for that group
+         *
+         *     **Important:**
+         *     - The target group must exist.
+         *     - The institution must have a seat configured for the target group.
+         *     - If any institution registration cannot be migrated to the new group, the operation fails.
          */
         patch: {
             parameters: {
@@ -10255,6 +10597,165 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/users/register-hotmart": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Hotmart webhook for user registration and lifecycle
+         * @description Public endpoint that receives webhook events from Hotmart.
+         *     Handles user creation and deactivation based on purchase events.
+         *
+         *     **Supported Events:**
+         *
+         *     | Event | Action |
+         *     |-------|--------|
+         *     | `PURCHASE_APPROVED` | Enqueues user creation with buyer data |
+         *     | `PURCHASE_CANCELED` | Deactivates (soft deletes) the user |
+         *     | `PURCHASE_REFUNDED` | Deactivates (soft deletes) the user |
+         *     | `PURCHASE_CHARGEBACK` | Deactivates (soft deletes) the user |
+         *
+         *     **User Creation Flow (PURCHASE_APPROVED):**
+         *     1. Extracts buyer information from the Hotmart payload
+         *     2. Determines institution based on offer code
+         *     3. Enqueues user creation request for async processing
+         *     4. User is created in Keycloak and database by the worker
+         *
+         *     **Offer-based Institution Assignment:**
+         *     - Offer code `d9to7y3w` → Institution `580268b1-458d-4f4c-901d-281eccf3b40d`
+         *
+         *     **User Deactivation Flow:**
+         *     1. Looks up the user by buyer email
+         *     2. Soft deletes the user (marks as inactive)
+         *     3. Disables the user in Keycloak
+         *
+         *     All events return HTTP 200 to acknowledge receipt.
+         *     Unrecognized events are logged and ignored.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Unique webhook event ID
+                         * @example d96fafd0-75ed-4ca7-8fa8-c6a57f48e384
+                         */
+                        id: string;
+                        /**
+                         * @description Hotmart event type
+                         * @example PURCHASE_APPROVED
+                         * @enum {string}
+                         */
+                        event: "PURCHASE_APPROVED" | "PURCHASE_CANCELED" | "PURCHASE_REFUNDED" | "PURCHASE_CHARGEBACK" | "PURCHASE_COMPLETE" | "PURCHASE_PROTEST" | "PURCHASE_DELAYED";
+                        /**
+                         * @description Event creation timestamp (Unix milliseconds)
+                         * @example 1773161133350
+                         */
+                        creation_date: number;
+                        /**
+                         * @description Webhook payload version
+                         * @example 2.0.0
+                         */
+                        version: string;
+                        data: {
+                            buyer: {
+                                /**
+                                 * Format: email
+                                 * @example buyer@example.com
+                                 */
+                                email: string;
+                                /** @example Teste */
+                                first_name: string;
+                                /** @example Comprador */
+                                last_name: string;
+                                /** @example Teste Comprador */
+                                name?: string;
+                                /** @example 69526128664 */
+                                document?: string;
+                                /** @example CPF */
+                                document_type?: string;
+                                /** @example 99999999900 */
+                                checkout_phone?: string;
+                            };
+                            purchase: {
+                                /** @example HP16015479281022 */
+                                transaction: string;
+                                /** @example APPROVED */
+                                status: string;
+                                offer?: {
+                                    /**
+                                     * @description Offer code used to determine institution assignment
+                                     * @example d9to7y3w
+                                     */
+                                    code?: string;
+                                };
+                            };
+                            product: {
+                                id?: number;
+                                name?: string;
+                                /** Format: uuid */
+                                ucode?: string;
+                            };
+                            subscription?: {
+                                subscriber?: {
+                                    code?: string;
+                                };
+                                plan?: {
+                                    name?: string;
+                                    id?: number;
+                                };
+                                status?: string;
+                            };
+                        };
+                    };
+                };
+            };
+            responses: {
+                /** @description Webhook event processed successfully */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @example success */
+                            status?: string;
+                            /**
+                             * @description Action taken for the event
+                             * @example user_creation_enqueued
+                             * @enum {string}
+                             */
+                            action?: "user_creation_enqueued" | "user_deactivated" | "user_not_found" | "event_ignored";
+                            /**
+                             * Format: uuid
+                             * @description Request ID for tracking (only on user_creation_enqueued)
+                             * @example 550e8400-e29b-41d4-a716-446655440000
+                             */
+                            requestId?: string;
+                        };
+                    };
+                };
+                500: components["responses"]["ServerError"];
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -11500,6 +12001,20 @@ export interface components {
                 };
             };
         };
+        ForgotPasswordRequest: {
+            /**
+             * Format: email
+             * @description User's email address for password reset
+             * @example user@example.com
+             */
+            email: string;
+        };
+        ForgotPasswordResponse: {
+            /** @example success */
+            status?: string;
+            /** @example If this email is registered, you will receive password reset instructions. */
+            message?: string;
+        };
         CreateInstitutionClassroomDto: {
             /**
              * Format: uuid
@@ -11680,10 +12195,14 @@ export interface components {
              * @description Product ID associated with this seat
              */
             productId?: string;
+            /** @description Total number of seat codes for this seat */
+            total?: number;
             /** @description Available quantity for this group in the institution */
             availableQuantity?: number;
             /** @description Number of users currently assigned to this group in the institution */
             usedQuantity?: number;
+            /** @description Number of reserved seat codes without active registration */
+            reservedQuantity?: number;
             /** Format: date-time */
             createdAt?: string;
             /** Format: date-time */
@@ -12172,6 +12691,27 @@ export interface components {
             /** Format: uri */
             url?: string;
         };
+        GenerateCertificateDto: {
+            /** Format: uuid */
+            userId: string;
+            /** Format: uuid */
+            quizAttemptId?: string;
+            /** Format: uuid */
+            certificateTemplateId: string;
+            /** @example João Silva */
+            studentName: string;
+            /** @example Introdução ao JavaScript */
+            quizTitle: string;
+            /** @example 85 */
+            score?: number;
+            /** @example CERT-2024-000001 */
+            certificateNumber?: string;
+            /**
+             * Format: date-time
+             * @example 2024-01-01T00:00:00.000Z
+             */
+            issuedAt?: string;
+        };
         CreateGuardianDto: {
             /**
              * Format: email

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "academe-kit",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "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",