diff --git a/src/helpers/Api.ts b/src/helpers/Api.ts index a925ede..d61aa7f 100644 --- a/src/helpers/Api.ts +++ b/src/helpers/Api.ts @@ -2,20 +2,42 @@ import ApiResponse from "../interfaces/ApiResponse"; import Embalse from "../interfaces/Embalse"; import Env from "./Env"; +/** + * Wrapper API de la REST de Oracle DB + */ export default class Api { + /** + * Conseguir todos los embalses + */ static async embalses(): Promise { return Api._makeReq('/embalses'); } + /** + * Conseguir embalse a partir de su id + * @param id ID del embalse + * @returns Lista de embalses que coinciden con la búsqueda + */ static async embalseById(id: string): Promise { return Api._makeReq(`/embalses/${id}`); } + /** + * Conseguir todos los embalses cercanos + * @param lat Latitud + * @param lon Longitud + * @returns Lista de embalses cercanos + */ static async embalsesNearby(lat: string, lon: string): Promise { return Api._makeReq(`/embalsesCercanos/${lat}/${lon}`); } - static async _makeReq(endpoint: string): Promise { + /** + * Método privado para enviar solicitudes + * @param endpoint Endpoint requerido + * @returns Lista de elementos + */ + private static async _makeReq(endpoint: string): Promise { let hasMore = true; let url = Env.api_base() + endpoint; diff --git a/src/helpers/Env.ts b/src/helpers/Env.ts index fd17509..0a56768 100644 --- a/src/helpers/Env.ts +++ b/src/helpers/Env.ts @@ -1,5 +1,18 @@ +/** + * Helper para conseguir las variables del entorno + */ export default class Env { + /** + * Base de API + */ static api_base(): string { return import.meta.env.VITE_API_BASE; } + + /** + * Clave API de OpenWeatherMap + */ + static owm_key(): string { + return import.meta.env.VITE_OWM_KEY; + } } diff --git a/src/interfaces/ApiResponse.ts b/src/interfaces/ApiResponse.ts index 7a273b8..f81d03b 100644 --- a/src/interfaces/ApiResponse.ts +++ b/src/interfaces/ApiResponse.ts @@ -1,3 +1,6 @@ +/** + * Respuesta de Oracle DB + */ export default interface ApiResponse { items: T[]; hasMore: boolean; diff --git a/src/interfaces/Embalse.ts b/src/interfaces/Embalse.ts index 8612023..4f5e4c4 100644 --- a/src/interfaces/Embalse.ts +++ b/src/interfaces/Embalse.ts @@ -1,3 +1,6 @@ +/** + * Datos del embalse + */ export default interface Embalse { id: number ambito_nombre: string diff --git a/src/interfaces/OWMResponse.ts b/src/interfaces/OWMResponse.ts index 3ac3cd4..d0c0d0d 100644 --- a/src/interfaces/OWMResponse.ts +++ b/src/interfaces/OWMResponse.ts @@ -1,3 +1,6 @@ +/** + * Respuesta de la API OpenWeatherMap + */ export default interface OWMResponse { cod: string message: number diff --git a/src/styles/bulma.scss b/src/styles/bulma.scss index c3d6938..91e76ff 100644 --- a/src/styles/bulma.scss +++ b/src/styles/bulma.scss @@ -1,3 +1,5 @@ @charset 'utf8'; +// TODO: MODULAR + @forward 'bulma/sass';