Skip to content

@fc/cliente-geolocalizacao ​

Cliente local para resolver geolocalização de IPs a partir da base MaxMind GeoLite2-City.

Configuração ​

O cliente lê a base local em:

txt
~/.fc-cache/geolite2/GeoLite2-City.mmdb

Em produção, esse caminho deve ser montado em volume persistente. O download da base usa account_id e license key MaxMind fornecidos pelo backoffice. O cliente recusa bases locais com mais de 30 dias, para evitar uso analítico de dados GeoLite2 desatualizados.

A atualização exige uma data de origem válida e recente, limita o tamanho recebido e tenta novamente apenas falhas transitórias. A nova base é validada antes de substituir o arquivo ativo; se o download ou a validação falhar, a versão anterior permanece disponível.

API ​

ts
import { criarClienteGeolocalizacao } from '@fc/cliente-geolocalizacao/criarClienteGeolocalizacao'

const cliente = await criarClienteGeolocalizacao()
const localidade = cliente.resolverIp('8.8.8.8')

localidade tem o formato { cidade, estado, pais, lat, lon }, adequado para persistência em tabela de dimensão por IP e posterior agregação.

Como consumir ​

O pacote não tem barrel raiz: @fc/cliente-geolocalizacao não resolve. Cada módulo é publicado por subpath, e o consumidor importa o arquivo que declara o símbolo.

SubpathO que exporta
@fc/cliente-geolocalizacao/criarClienteGeolocalizacaocriarClienteGeolocalizacao
@fc/cliente-geolocalizacao/baixarBasebaixarBaseGeoLite2
@fc/cliente-geolocalizacao/obterEstadoBaseGeoLite2obterEstadoBaseGeoLite2
@fc/cliente-geolocalizacao/constantesCAMINHO_BASE_GEOLITE2, CAMINHO_DIRETORIO_GEOLITE2, DIAS_MAXIMOS_BASE_GEOLITE2, EDICAO_BASE_GEOLITE2, URL_DOWNLOAD_GEOLITE2
@fc/cliente-geolocalizacao/tiposClienteGeolocalizacao, EstadoBaseGeoLite2, Localidade, OpcoesBaixarBaseGeoLite2, OpcoesClienteGeolocalizacao, ResultadoBaixarBaseGeoLite2

baixarArquivoComRetomada, requisitarComRetomada, gravarDownload, mapearLeitura e ErroDownloadDefinitivo são detalhe de implementação do download e da leitura e não são publicados.

This product includes GeoLite Data created by MaxMind, available from https://www.maxmind.com.