Node.js SDK (polylingo)

Oficiální klient zaměřený primárně na TypeScript pro PolyLingo REST API. Používá runtime fetch (Node.js 18+), dodává se jako ESM a CJS a nemá žádné runtime závislosti kromě Node.

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

Pro podrobnosti o surovém HTTP viz API reference.

Instalace

npm install polylingo

Node.js: >= 18

Konstruktor

import PolyLingo from 'polylingo'

const client = new PolyLingo({
  apiKey: process.env.POLYLINGO_API_KEY!, // povinné
  baseURL: 'https://api.usepolylingo.com/v1', // nepovinné; toto je výchozí hodnota
  timeout: 120_000, // nepovinné; timeout požadavku v milisekundách (výchozí 120_000)
})

Metody

client.health()

GET /health — na serveru není vyžadována autentizace; klient přesto odešle hlavičku Authorization, pokud je nakonfigurována.

Vrací { status, timestamp }.

const h = await client.health()

client.languages()

GET /languages — seznam podporovaných jazyků.

const { languages } = await client.languages()

client.translate(params)

POST /translate

const r = await client.translate({
  content: '# Hello',
  targets: ['es', 'fr'],
  format: 'markdown', // nepovinné — vynechání = automatická detekce v API
  source: 'en',       // nepovinná nápověda
  model: 'standard',  // nepovinné: 'standard' | 'advanced'
})

r.translations.es // řetězec
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',    // nepovinné
  model: 'standard', // nepovinné
})

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

client.usage()

GET /usage — využití plánu pro autentizovaný klíč.

const u = await client.usage()

Úlohy — client.jobs

client.jobs.create(params)

POST /jobs — zařadí asynchronní práci do fronty. Vrací JSON tělo 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 — dotazuje stav. Když status === 'completed', API vrací translations a usage na nejvyšší úrovni JSON objektu (ne vnořené pod result).

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

client.jobs.translate(params) — pohodlnost

Odesílá úlohu, pak dotazuje, dokud není completed nebo failed, nebo dokud není vyčerpán rozpočet dotazování.

const done = await client.jobs.translate({
  content: longMarkdown,
  targets: ['de', 'fr', 'es'],
  format: 'markdown',
  pollInterval: 10_000, // ms mezi dotazy; výchozí 5_000
  timeout: 600_000,     // **celkový** ms rozpočet pro dotazování; výchozí 20 minut
  onProgress: (pos) => console.log(`Queue position: ${pos}`), // nepovinné; volá se během čekání/zpracování
})

done.translations.de
done.usage.total_tokens

Životní cyklus úlohy v API používá stavy pending, processing, completed a failed.

Zpracování chyb

Všechny chyby ze SDK (kromě chyb v kódu) rozšiřují PolyLingoError:

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

try {
  await client.translate({ content: 'Hi', targets: ['es'] })
} catch (e) {
  if (e instanceof AuthError) { /* neplatný klíč */ }
  else if (e instanceof RateLimitError) { /* e.retryAfter */ }
  else if (e instanceof JobFailedError) { /* e.jobId */ }
  else if (e instanceof PolyLingoError) { /* e.status, e.error */ }
}

Vzor asynchronních úloh (shrnutí)

1. Fire-and-forget polling: jobs.create → váš pracovník volá jobs.get v intervalu, dokud není completed nebo failed.
2. Vestavěné dotazování: jobs.translate — stejná sémantika, s pollInterval, timeout a onProgress.

Velké payloady a dlouhotrvající překlady by měly preferovat jobs před synchronním translate, aby se zabránilo HTTP timeoutům.

TypeScript

Balíček exportuje typy pro možnosti, výsledky a chyby. Importujte pojmenované typy z polylingo podle potřeby (viz publikovaný dist/index.d.ts).

Změny

0.1.0

• První vydání: health, languages, translate, batch, usage, jobs.create, jobs.get, jobs.translate.