Node.js SDK (polylingo)

Officiell TypeScript-först klient för PolyLingo REST API. Den använder runtime fetch (Node.js 18+), levereras som ESM och CJS, och har inga runtime-beroenden utöver Node.

• npm: polylingo
• Källa: UsePolyLingo/polylingo-node

För råa HTTP-detaljer, se API-referens.

Installation

npm install polylingo

Node.js: >= 18

Konstruktor

import PolyLingo from 'polylingo'

const client = new PolyLingo({
  apiKey: process.env.POLYLINGO_API_KEY!, // obligatoriskt
  baseURL: 'https://api.usepolylingo.com/v1', // valfritt; detta är standard
  timeout: 120_000, // valfritt; förfrågnings-timeout i millisekunder (standard 120_000)
})

Metoder

client.health()

GET /health — kräver ingen autentisering på servern; klienten skickar ändå Authorization-huvudet om det är konfigurerat.

Returnerar { status, timestamp }.

const h = await client.health()

client.languages()

GET /languages — lista över stödda språk.

const { languages } = await client.languages()

client.translate(params)

POST /translate

const r = await client.translate({
  content: '# Hello',
  targets: ['es', 'fr'],
  format: 'markdown', // valfritt — utelämnat = auto-detektering i API
  source: 'en',       // valfri ledtråd
  model: 'standard',  // valfritt: 'standard' | 'advanced'
})

r.translations.es // sträng
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',    // valfritt
  model: 'standard', // valfritt
})

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

client.usage()

GET /usage — plananvändning för den autentiserade nyckeln.

const u = await client.usage()

Jobs — client.jobs

client.jobs.create(params)

POST /jobs — köa asynkront arbete. Returnerar JSON-kropp med status 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 — pollar status. När status === 'completed', returnerar API translations och usage på top-nivå i JSON-objektet (inte inbäddat under result).

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

client.jobs.translate(params) — bekvämlighet

Skickar in ett jobb, sedan pollar tills completed eller failed, eller tills polling-budgeten är slut.

const done = await client.jobs.translate({
  content: longMarkdown,
  targets: ['de', 'fr', 'es'],
  format: 'markdown',
  pollInterval: 10_000, // ms mellan polls; standard 5_000
  timeout: 600_000,     // **total** ms-budget för polling; standard 20 minuter
  onProgress: (pos) => console.log(`Köposition: ${pos}`), // valfritt; anropas medan i kö/behandlas
})

done.translations.de
done.usage.total_tokens

Jobb-livscykeln i API använder statusarna pending, processing, completed och failed.

Felhantering

Alla fel från SDK (utom buggar) ärver från PolyLingoError:

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

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

Asynkrona jobb-mönster (sammanfattning)

1. Fire-and-forget polling: jobs.create → din worker anropar jobs.get med intervall tills completed eller failed.
2. Inbyggd polling: jobs.translate — samma semantik, med pollInterval, timeout och onProgress.

Stora payloads och långvariga översättningar bör föredra jobs framför synkron translate för att undvika HTTP-timeouter.

TypeScript

Paketet exporterar typer för alternativ, resultat och fel. Importera namngivna typer från polylingo vid behov (se publicerad dist/index.d.ts).

Changelog

0.1.0

• Initial release: health, languages, translate, batch, usage, jobs.create, jobs.get, jobs.translate.