Logotipo Hedhog

Receba novidades do Hedhog no seu e-mail

Novos lançamentos, receitas e breaking changes — sem spam.

Submódulo address

addresses

CRUD de endereços postais normalizados, incluindo endereços tipados e a garantia de um endereço principal por tipo.

Caminho de origem: libraries/address/src

Arquivo do módulo: address.module.ts

Introdução

O módulo Address é uma biblioteca de infraestrutura enxuta, usada por módulos de negócio de nível mais alto que precisam de registros de endereço reutilizáveis. Ele oferece listagem paginada, consulta direta, fluxos de criação/atualização e exclusão em massa.

Uma regra de negócio importante deste pacote é o tratamento do endereço principal: quando um endereço é marcado como principal para um determinado tipo, o serviço é responsável por manter o estado de principal desse tipo consistente, em vez de deixar múltiplos principais conflitantes no espaço do usuário. O módulo também expõe a mesma superfície de CRUD por meio de ferramentas MCP para automações conduzidas por IA.

Endpoints HTTP

5 endpoints

Lista endereços com paginação, busca, ordenação e seleção de campos.

Query
page, pageSize, search, sortField, sortOrder, fields

Obtém um único endereço pelo ID.

Params
id (int)

Cria um novo registro de endereço.

Atualiza um endereço existente.

Params
id (int)

Exclui um ou mais endereços.

Body

FieldTypeRequiredNotes
idsnumber[]yesBulk delete payload

Ferramentas MCP

Ferramentas nomeadas que podem ser chamadas por modelos de IA através do Model Context Protocol (MCP).

  • address.list

    Lista endereços com paginação e busca

  • address.get

    Obtém um único endereço pelo ID

  • address.create

    Cria um novo endereço

  • address.update

    Atualiza um endereço existente

  • address.delete

    Exclui um ou mais endereços