Node.js SDK (polylingo)

Cliente oficial TypeScript-first para a API REST do PolyLingo. Usa o runtime fetch (Node.js 18+), é distribuído como ESM e CJS, e não possui dependências em tempo de execução além do Node.

• npm: polylingo
• Fonte: UsePolyLingo/polylingo-node

Para detalhes brutos do HTTP, veja Referência da API.

Instalação

npm install polylingo

Node.js: >= 18

Construtor

import PolyLingo from 'polylingo'

const client = new PolyLingo({
  apiKey: process.env.POLYLINGO_API_KEY!, // obrigatório
  baseURL: 'https://api.usepolylingo.com/v1', // opcional; este é o padrão
  timeout: 120_000, // opcional; tempo limite da requisição em milissegundos (padrão 120_000)
})

Métodos

client.health()

GET /health — não requer autenticação no servidor; o cliente ainda envia o cabeçalho Authorization se configurado.

Retorna { status, timestamp }.

const h = await client.health()

client.languages()

GET /languages — lista de idiomas suportados.

const { languages } = await client.languages()

client.translate(params)

POST /translate

const r = await client.translate({
  content: '# Hello',
  targets: ['es', 'fr'],
  format: 'markdown', // opcional — omitido = detecção automática na API
  source: 'en',       // dica opcional
  model: 'standard',  // opcional: 'standard' | 'advanced'
})

r.translations.es // string
r.usage.total_tokens
r.usage.input_tokens
r.usage.output_tokens

client.batch(params)

POST /translate/batch

const b = await client.batch({
  items: [
    { id: 'a', content: 'Hello' },
    { id: 'b', content: '## Title', format: 'markdown' },
  ],
  targets: ['de'],
  source: 'en',    // opcional
  model: 'standard', // opcional
})

b.results[0].translations.de
b.usage.total_tokens

client.usage()

GET /usage — uso do plano para a chave autenticada.

const u = await client.usage()

Jobs — client.jobs

client.jobs.create(params)

POST /jobs — enfileira trabalho assíncrono. Resolve com o corpo JSON 202 (job_id, status, created_at, …).

const job = await client.jobs.create({
  content: longMarkdown,
  targets: ['de', 'fr'],
  format: 'markdown',
})
console.log(job.job_id)

client.jobs.get(jobId)

GET /jobs/:id — consulta status. Quando status === 'completed', a API retorna translations e usage no nível superior do objeto JSON (não aninhado em result).

const status = await client.jobs.get(job.job_id)

client.jobs.translate(params) — conveniência

Submete um job, depois consulta até completed ou failed, ou até o orçamento de polling se esgotar.

const done = await client.jobs.translate({
  content: longMarkdown,
  targets: ['de', 'fr', 'es'],
  format: 'markdown',
  pollInterval: 10_000, // ms entre polls; padrão 5_000
  timeout: 600_000,     // orçamento **total** em ms para polling; padrão 20 minutos
  onProgress: (pos) => console.log(`Posição na fila: ${pos}`), // opcional; chamado enquanto enfileirado/processando
})

done.translations.de
done.usage.total_tokens

O ciclo de vida do job na API usa os status pending, processing, completed e failed.

Tratamento de erros

Todas as falhas do SDK (exceto bugs) estendem PolyLingoError:

import PolyLingo, {
  PolyLingoError,
  AuthError,
  RateLimitError,
  JobFailedError,
} from 'polylingo'

try {
  await client.translate({ content: 'Hi', targets: ['es'] })
} catch (e) {
  if (e instanceof AuthError) { /* chave inválida */ }
  else if (e instanceof RateLimitError) { /* e.retryAfter */ }
  else if (e instanceof JobFailedError) { /* e.jobId */ }
  else if (e instanceof PolyLingoError) { /* e.status, e.error */ }
}

Padrão de jobs assíncronos (resumo)

1. Polling fire-and-forget: jobs.create → seu worker chama jobs.get em intervalo até completed ou failed.
2. Polling embutido: jobs.translate — mesma semântica, com pollInterval, timeout e onProgress.

Payloads grandes e traduções longas devem preferir jobs ao invés de translate síncrono para evitar timeouts HTTP.

TypeScript

O pacote exporta tipos para opções, resultados e erros. Importe tipos nomeados de polylingo conforme necessário (veja dist/index.d.ts publicado).

Changelog

0.1.0

• Lançamento inicial: health, languages, translate, batch, usage, jobs.create, jobs.get, jobs.translate.