Utility Functions

Overview

EducaStream provides a comprehensive set of utility functions for managing users, courses, payments, and data validation. All API calls use Axios and are configured to work with the backend endpoints.

Data Fetching Functions

getAllCourses

Fetches all courses from the database and stores them in local storage, sorted by creation date (newest first).

none

void

This function takes no parameters

data

array

Array of course objects sorted by createdAt in descending order

string

Unique course identifier

title

string

Course title

description

string

Course description

createdAt

string

ISO timestamp of course creation

Source: src/utils/getAllCourses.js:3

import { getAllCourses } from './utils/getAllCourses';

// Fetch and store all courses
const courses = await getAllCourses();
console.log(courses); // Sorted by newest first

getAllCategories

Retrieves all course categories from the database, sorted alphabetically by name.

none

void

This function takes no parameters

data

array

Array of category objects sorted alphabetically

name

string

Category name

string

Category identifier

Source: src/utils/getAllCategories.js:3

import { getAllCategories } from './utils/getAllCategories';

// Used in App.jsx on initial load
useEffect(() => {
  getAllCategories();
}, []);

getAllUser

Fetches all users from the database.

none

void

This function takes no parameters

data

array

Array of user objects

Source: src/utils/getAllUser.js:3

import { getAllUser } from './utils/getAllUser';

// Example from App.jsx
useEffect(() => {
  getAllUser();
  getAllCourses();
  getAllCategories();
}, []);

getUserById

Retrieves a specific user by their unique ID.

string

required

The unique identifier of the user to fetch

data

object

User object with all user details

string

Unique user identifier

string

User email address

user_name

string

Username

Payments

array

Array of user’s payment records

Source: src/utils/getUserById.js:3

import { getUserById } from './utils/getUserById';

const user = await getUserById('ab518b48-1a30-4d10-b525-479167e4fdd4');

getUser

Fetches a user by their email address.

string

required

The email address of the user to retrieve

data

object

User object matching the email

Source: src/utils/getUser.js:3

import { getUser } from './utils/getUser';

const user = await getUser('[email protected]');

getOnSaleCourses

Retrieves all courses currently on sale.

none

void

This function takes no parameters

data

array

Array of course objects with active sales/discounts

Source: src/utils/getOnSaleCourses.js:3

import { getOnSaleCourses } from './utils/getOnSaleCourses';

const saleCourses = await getOnSaleCourses();

getAllPayments

Fetches all payment records from the database.

none

void

This function takes no parameters

data

array

Array of payment objects

Courses

array

Courses included in the payment

Source: src/utils/getAllPayments.js:3

import { getAllPayments } from './utils/getAllPayments';

const payments = await getAllPayments();

Data Mutation Functions

User Operations
Course Operations
Lesson & Payment

postUser

Creates a new user in the database.

user

object

required

User object containing registration data

string

required

User’s email address

password

string

required

User’s password

user_name

string

Username

first_name

string

User’s first name

last_name

string

User’s last name

birthdate

string

User’s birthdate in ISO format

role_instructor

boolean

Whether user has instructor role

role_student

boolean

Whether user has student role

data

object

Created user object

Source: src/utils/postUser.js:3

import { postUser } from './utils/postUser';

const newUser = await postUser({
  email: "[email protected]",
  password: "securePassword123",
  user_name: "johndoe",
  first_name: "John",
  last_name: "Doe",
  role_student: true,
  role_instructor: false
});

updateUser

Updates an existing user’s information.

user

object

required

User object containing fields to update (must include user ID)

data

object

Updated user object

Source: src/utils/updateUser.js:3

import { updateUser } from './utils/updateUser';

const updated = await updateUser({
  id: "ab518b48-1a30-4d10-b525-479167e4fdd4",
  first_name: "UpdatedName"
});

sendData (Create Course)

Creates a new course in the database.

course

object

required

Course object containing course details

title

string

required

Course title (minimum 3 characters)

description

string

required

Course description (20-90 characters)

updateCourse

Updates an existing course with new data.

newDataCourse

object

required

Course update object

string

required

Course ID to update

title

string

Updated course title

image

string

Updated course image URL

enabled

boolean

Whether course is enabled

onSale

boolean

Whether course is on sale

percentageDiscount

number

Discount percentage if on sale

banned

boolean

Whether course is banned

data

object

Updated course object

Source: src/utils/updateCourse.js:3

import updateCourse from './utils/updateCourse';

const updated = await updateCourse({
  id: "course-uuid",
  onSale: true,
  percentageDiscount: 20,
  enabled: true
});

updateLesson

Updates lesson information for a course.

newDataLesson

object

required

Lesson update object containing fields to modify

string

required

Lesson ID to update

title

string

Lesson title

description

string

Lesson description

video_url

string

Video URL for the lesson

section

number

Section number

data

object

Updated lesson object

Source: src/utils/updateLesson.js:3

import updateLesson from './utils/updateLesson';

const updatedLesson = await updateLesson({
  id: "lesson-uuid",
  title: "Updated Lesson Title",
  video_url: "https://youtube.com/watch?v=new-video"
});

postRating

Submits a rating and comment for a course.

course_id

string

required

UUID of the course being rated

user_id

string

required

UUID of the user submitting the rating

rating

number

required

Rating value (typically 1-5)

comment

string

required

Review comment text

data

object

Created rating object

Source: src/utils/postRating.js:3

import { postRating } from './utils/postRating';

const rating = await postRating(
  "course-uuid",
  "user-uuid",
  5,
  "Excellent course! Highly recommended."
);

postPaymentCart

Processes payment for courses in the cart and enrolls the user.

cart

array

required

Array of course objects to purchase

string

required

User ID making the purchase

string

required

User’s email address

id_payment

string

required

Payment transaction ID from payment gateway

data

object

Payment confirmation object

Source: src/utils/postPaymentCart.js:3

import { postPaymentCart } from './utils/postPaymentCart';

const payment = await postPaymentCart(
  [{ id: "course-1", title: "JavaScript" }],
  "user-uuid",
  "[email protected]",
  "payment-transaction-id"
);

Validation Functions

validation

Validates course creation/update form data.

props

object

required

Object containing course form fields

title

string

required

Course title (min 3 characters)

description

string

required

Course description (20-90 characters)

validationLesson

Validates lesson creation/update form data.

props

object

required

Object containing lesson form fields

title

string

required

Lesson title (min 3 characters)

description

string

required

Lesson description (min 20 characters)

section

number

required

Section number (must be >= 1)

video_url

string

required

Video URL for the lesson

errors

object

Object containing validation error messages keyed by field name

Source: src/utils/validation.js:39

import { validationLesson } from './utils/validation';

const lessonData = {
  title: "Introduction",
  description: "This lesson covers the basics of JavaScript",
  section: 1,
  video_url: "https://youtube.com/watch?v=abc123"
};

const errors = validationLesson(lessonData);
if (Object.keys(errors).length === 0) {
  // Validation passed
}

clear

Clears all user session data from localStorage and reloads the page. Used for logout functionality.

none

void

This function takes no parameters

Source: src/utils/clear.js:1

import { clear } from './utils/clear';

// Logout user and clear session
clear();
// Removes: userOnSession, logged, payment
// Then reloads the page

filterBack

Filters courses by a specific parameter on the backend.

params

object

Filter parameters object

type

string

Filter type (e.g., “category”, “instructor”)

value

string

Filter value

Source: src/utils/FiltersBc.js:3

import { filterBack } from './utils/FiltersBc';

// Filter courses by category
await filterBack({
  type: "category",
  value: "Programación"
});

Error Handling

All API functions implement try-catch error handling:

try {
  const response = await axios.get('/endpoint');
  if (response.status !== 200) {
    throw new Error(`HTTP error! Status: ${response.status}`);
  }
  return response.data;
} catch (error) {
  console.error("Error fetching data:", error);
  throw error;
}

Payment functions include user-friendly alerts:

try {
  const { data } = await axios.post("payment/enrollment", payload);
  return data;
} catch (error) {
  window.alert("Error en la pasarela de pago");
}

Development

Components

API Reference

Utility Functions

Overview

Data Fetching Functions

getAllCourses

getAllCategories

getAllUser

getUserById

getUser

getOnSaleCourses

getAllPayments

Data Mutation Functions

postUser

updateUser

sendData (Create Course)

updateCourse

updateLesson

postRating

postPaymentCart

Validation Functions

validation

validationLesson