Referência de subpaths
O pacote @pilutech/botai-core 0.4.1 tem 25 entradas em exports: 23 módulos (a raiz e 22 subpaths), o esquema JSON do envelope e o navegador.iife.js. Os 23 módulos foram importados no Node 22.22.3, no Bun 1.3.14 e no Deno 2.7.14.
Importe pelo nome do pacote mais o subpath:
import { gerarPessoa } from '@pilutech/botai-core'
import { validarCPF } from '@pilutech/botai-core/cpf'
A raiz e os dados da pessoa
| Subpath | Exporta | Página |
|---|---|---|
| (raiz) | gerarPessoa, gerarPessoas, gerarEnvelopeDaPessoa, gerarEnvelopeDasPessoas, hojeEmSaoPaulo, rngDeSemente, sementeAleatoria, ErroDeOpcao, LIMITE_DO_LOTE, FORMATO, MOTOR, DOMINIO_EMAIL_PADRAO | Gerar uma pessoa, Gerar um lote |
/pessoa | montarPessoa | — |
/cpf | gerarCPF, validarCPF | Documentos |
/cnpj | gerarCNPJ, validarCNPJ | Documentos |
/rg | gerarRG, validarRG, dvRGSP, formatarRG | Documentos |
/pis | gerarPIS, validarPIS, dvPIS | Documentos |
/titulo-eleitor | gerarTituloEleitor, validarTituloEleitor, dvsTitulo | Documentos |
/celular | gerarCelular | Documentos |
/endereco | gerarEndereco, LOGRADOUROS, sortearNumero | Documentos |
/cartao | gerarCartao, luhnValido, CARTOES_TESTE, formatarNumeroCartao | Documentos |
/nascimento | gerarNascimento, lerDataISO, calcularIdade, formatarISO, formatarBR | Documentos |
/senha | gerarSenha, senhaAtendeRegrasComuns, MAIUSCULAS, MINUSCULAS, DIGITOS, SIMBOLOS | Documentos |
/nome | gerarNome, gerarEmail, nomeNoCartao, slugNome, removerAcentos, PRENOMES_F, PRENOMES_M, SOBRENOMES, DOMINIO_EMAIL | Documentos |
/empresa | gerarEmpresa, RAMOS, SUFIXOS_FANTASIA | Documentos |
/uf | UFS, REGIAO_FISCAL_CPF, CODIGO_UF_TITULO, UF_NOME | Documentos |
/aleatorio | escolher, embaralhar, digitosAleatorios, somenteDigitos, rngPadrao | — |
/prng | sfc32, seedFromBytes | — |
Saídas, classificador e servidor
| Subpath | Exporta | Página |
|---|---|---|
/plano | pessoaPlana, COLUNAS, lerCampos, paraCsv, cabecalhoCsv, linhaCsv, paraSql, insertSql, lerTabela, lerDialeto, FORMATOS, DIALETOS, ErroDoPlano | Visão plana, CSV e SQL |
/campos | classificarFormulario, classificarCampo, LIMIAR, campoAutocomplete, normalizar | Classificador de campos |
/campos-formatar | valorPara, caber, escolherOpcao | Classificador de campos |
/atalhos | ATALHOS, TECLAS_DO_MANIFESTO, teclaNoMac | Preencher a página |
/servidor | responder, criarServidor, iniciarServidor, PORTA_PADRAO, HOST_PADRAO, LIMITE_DE_PESSOAS, ROTAS, TIPO_POR_FORMATO (só Node) | Servidor como biblioteca |
O motor no navegador
| Entrada | Exporta | Página |
|---|---|---|
/navegador | preencherNaPagina, preencherDocumento, criarRegistro, SEM_CONTORNOS, instalarNoGlobal, NOME_DO_GLOBAL, SEGUNDA_PASSADA_MS e as funções de baixo nível do DOM (campos, descrever, escrever, visivel…) | ESM com bundler, Shadow DOM |
/navegador.iife.js | um script, não um módulo: cria o global __botaiNavegador | O navegador.iife.js |
O esquema do envelope
| Entrada | O que é | Página |
|---|---|---|
/esquema/envelope-v1.schema.json | o JSON Schema 2020-12 do envelope (formato é a const 1; additionalProperties: false em todos os objetos; sem $id) | Envelope e esquema |
Documentado
Os nomes das tabelas acima são a lista de exportações do próprio pacote 0.4.1, conferida importando cada subpath. Os que não aparecem em nenhuma página desta documentação (como montarPessoa, slugNome, seedFromBytes, TECLAS_DO_MANIFESTO e as funções de baixo nível do /navegador) foram importados, mas nenhum teste desta documentação os exercitou.