List the site’s languages

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const result = await site.internationalization().getLocales()

{
  "en": {
    "label": "English",
    "direction": "ltr"
  },
  "fr": {
    "label": "Français",
    "prefix": "/fr",
    "direction": "ltr"
  },
  "de": {
    "label": "Deutsch",
    "prefix": "/de",
    "private": true,
    "direction": "ltr"
  }
}

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const result = await site.internationalization().getLocales()

{
  "en": {
    "label": "English",
    "direction": "ltr"
  },
  "fr": {
    "label": "Français",
    "prefix": "/fr",
    "direction": "ltr"
  },
  "de": {
    "label": "Deutsch",
    "prefix": "/de",
    "private": true,
    "direction": "ltr"
  }
}

In your app

A controller answers a route on your app: it calls getLocales() and returns the answer.

Add the controller

app/controllers/get_locales_controller.ts

import { inject } from '@adonisjs/core'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class GetLocalesController {
  constructor(protected site: SiteClient) {}

  async handle() {
    return this.site.internationalization().getLocales()
  }
}

Add the route

start/routes.ts

import router from '@adonisjs/core/services/router'

const GetLocalesController = () => import('#controllers/get_locales_controller')

router.get('/i18n/locales', [GetLocalesController])

Call it

Terminal

curl http://localhost:3333/i18n/locales

With node ace serve running, it prints its answer as JSON.

A visitor gets the public ones; a signed-in person, or an API key with languages:read, also gets the ones not yet public (private: true), so their pages can be translated before they go live. Translate a document into one with its type’s localize route.

Parameters

None: call it with no arguments.

Returns

Readonly<Record<string, LocalesResponseValue>>. The languages, keyed by code.

Show LocalesResponseValue

string

Sometimes sent: undefined when the site leaves it out. The language’s name, as its speakers write it.

string

Sometimes sent: undefined when the site leaves it out. The start of every URL in this language (/fr, so /fr/about); absent for the main language, whose URLs have none.

boolean

Sometimes sent: undefined when the site leaves it out. True for a language not yet public: visitors don’t see it; only signed-in people and API keys with languages:read get it. Absent once it is public.

Direction

Sometimes sent: undefined when the site leaves it out. The text direction. One of ltr, rtl; a newer site may send others, so keep a fallback.

Errors

Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see Map SDK errors to responses); catch only what you want to react to here.

5xx

The site failed (or something in front of it did). Its logs say why.Retried first: A 502, 503 or 504: yes, after 0.5 s then 1 s. A 500: no. Read: siteMessage, errorName, data.

no answer

No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Yes, after 0.5 s then 1 s. Read: reason, neverConnected.

not sent

The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason (what to change).

any other

Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason, status.

setup

sites.forSite('acme') named a slug config/attract.ts doesn’t list (with the keys in the database: no row in attract_api_keys).Retried first: No: nothing was sent. Read: message, slug.

setup

The site’s entry is wrong: a malformed baseUrl or key, a key filed under another slug, or no default site. node ace attract:check names the fix.Retried first: No: nothing was sent. Read: message (what to fix).

Behavior

Retries: a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
Timeout: 15 s per attempt by default; raise timeout (milliseconds) in config/attract.ts for longer.

Test it

It calls the controller above with the SDK faked: fakeAttract() puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as tests/unit/internationalization_get_locales.spec.ts, then run your tests:

tests/unit/internationalization_get_locales.spec.ts

import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import GetLocalesController from '#controllers/get_locales_controller'

test('internationalization.getLocales', async () => {
  const site = fakeAttract()

  const controller = await app.container.make(GetLocalesController)
  await controller.handle()

  site.assertCalled('internationalization.getLocales')
})

Terminal

node ace test

Get locale path and manage clipboard

site.internationalization().switchLocale()

Check document existence in locale

site.internationalization().existInLocale()

GET /@apostrophecms/i18n/locales

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const result = await site.internationalization().getLocales()

{
  "en": {
    "label": "English",
    "direction": "ltr"
  },
  "fr": {
    "label": "Français",
    "prefix": "/fr",
    "direction": "ltr"
  },
  "de": {
    "label": "Deutsch",
    "prefix": "/de",
    "private": true,
    "direction": "ltr"
  }
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Behavior

Test it

Get locale path and manage clipboard

Check document existence in locale

GET /@apostrophecms/i18n/locales

In your app

Behavior

Test it

Related

Get locale path and manage clipboard

Check document existence in locale

GET /@apostrophecms/i18n/locales