Creating TypeScript CRUD Controllers

TypeScript
import { genRequestInstance } from '@/request';
import { AxiosResponse } from 'axios';

/**
 * Deletes an entity by ID
 * @param id - The entity ID to delete
 * @returns Promise with axios response
 * @throws Error when request fails
 */
export const deleteEntityController = async (
  id: Entity['id'],
): Promise<AxiosResponse<null, any>> => {
  const url = `/api/entity/${id}/`;
  const instance = genRequestInstance();

  try {
    const response = await instance.delete(url);
    return response;
  } catch (error) {
    console.error('Erro na requisição:', error);
    return Promise.reject(error);
  }
};

Progress:

• Identify entity name and endpoint structure
• Determine if controller needs URL parameters
• Create controller function with proper typing
• Add JSDoc documentation
• Implement axios instance and request
• Add error handling pattern

Step-by-step Process:

1. Import Dependencies

   TypeScript
   import { genRequestInstance } from '@/request';
   import { AxiosResponse } from 'axios';

2. Define Function Signature

   • Use camelCase: deleteEntityNameController
   • Parameter order: URL params first, then entity ID
   • Return type: Promise<AxiosResponse<null, any>>

3. Build URL Pattern

   • With parameters: /api/module/versao/${param}/entity/${id}/
   • Without parameters: /api/module/entity/${id}/

4. Add JSDoc

   TypeScript
   /**
    * Operation description
    * @param param1 - Description
    * @param id - The entity ID
    * @returns Promise with axios response
    * @throws Error when request fails
    */

5. Implement Request Logic

   • Create axios instance
   • Make request with try/catch
   • Return response or reject error

Example 1: Delete with URL Parameter Input: Entity "AdicionalNoturno" with versao parameter Output:

TypeScript
export const deleteAdicionalNoturnoController = async (
  versao: Planejamento.Versao.Versao['id'],
  id: Pessoal.Premissas.AdicionalNoturno.AdicionalNoturno['id'],
): Promise<AxiosResponse<null, any>> => {
  const url = `/api/pessoal/versao/${versao}/adicional-noturno/${id}/`;
  const instance = genRequestInstance();

  try {
    const response = await instance.delete(url);
    return response;
  } catch (error) {
    console.error('Erro na requisição:', error);
    return Promise.reject(error);
  }
};

Example 2: Simple Delete Input: Entity "Area" without parameters Output:

TypeScript
export const deleteAreaController = async (
  id: Planejamento.Cadastro.Area.Area['id'],
): Promise<AxiosResponse<null, any>> => {
  const url = `/api/planejamento/area/${id}/`;
  const instance = genRequestInstance();

  try {
    const response = await instance.delete(url);
    return response;
  } catch (error) {
    console.error('Erro na requisição:', error);
    return Promise.reject(error);
  }
};

Example 3: Create/Update with Body

TypeScript
export const createEntityController = async (
  data: Entity.Create,
): Promise<AxiosResponse<Entity.Entity, any>> => {
  const url = `/api/module/entity/`;
  const instance = genRequestInstance();

  try {
    const response = await instance.post(url, data);
    return response;
  } catch (error) {
    console.error('Erro na requisição:', error);
    return Promise.reject(error);
  }
};