Generating TypeScript PATCH Controllers

Progress:

• Identify entity name and namespace
• Determine URL parameters (beyond entity ID)
• Generate function signature with proper TypeScript types
• Create JSDoc documentation
• Build URL pattern based on parameters
• Implement PATCH request with error handling

Example 1: Entity with additional URL parameter Input: Create update controller for "AdicionalNoturno" entity with "versao" parameter

Output:

TypeScript
/**
 * Updates an AdicionalNoturno entity
 * @param versao - The version ID for the planning
 * @param id - The AdicionalNoturno entity ID to update
 * @param params - The update parameters
 * @returns Promise resolving to the updated AdicionalNoturno entity
 * @throws Error when request fails or validation errors occur
 */
export const updateAdicionalNoturnoController = async (
  versao: Planejamento.Versao.Versao['id'],
  id: Pessoal.Premissas.AdicionalNoturno.AdicionalNoturno['id'],
  params: Pessoal.Premissas.AdicionalNoturno.UpdateAdicionalNoturnoParams,
): Promise<
  AxiosResponse<Pessoal.Premissas.AdicionalNoturno.AdicionalNoturno, any>
> => {
  const url = `/api/pessoal/versao/${versao}/adicional-noturno/${id}/`;
  const instance = genRequestInstance();

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

Example 2: Simple entity without additional parameters Input: Create update controller for "Area" entity

Output:

TypeScript
/**
 * Updates an Area entity
 * @param id - The Area entity ID to update
 * @param params - The update parameters
 * @returns Promise resolving to the updated Area entity
 * @throws Error when request fails or validation errors occur
 */
export const updateAreaController = async (
  id: Planejamento.Cadastro.Area.Area['id'],
  params: Planejamento.Cadastro.Area.UpdateAreaParams,
): Promise<AxiosResponse<Planejamento.Cadastro.Area.Area, any>> => {
  const url = `/api/planejamento/area/${id}/`;
  const instance = genRequestInstance();

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