Check document existence in locale

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

const site = await app.container.make(SiteClient)
const existInLocale = await site.internationalization().existInLocale({ ids: ['cloydg3ka0005qcls5vmg8sb9', 'cloydg3ka0005qcls5vmg8sb8'], locale: 'fr', mode: 'published' })

{
  "originalLocaleIds": [
    "cloydg3ka0005qcls5vmg8sb9:en:published",
    "cloydg3ka0005qcls5vmg8sb8:en:published"
  ],
  "newLocaleIds": [
    "cloydg3ka0005qcls5vmg8sb9:fr:published",
    "cloydg3ka0005qcls5vmg8sb8:fr:published"
  ],
  "aposDocIds": [
    "cloydg3ka0005qcls5vmg8sb9",
    "cloydg3ka0005qcls5vmg8sb8"
  ]
}

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

const site = await app.container.make(SiteClient)
const existInLocale = await site.internationalization().existInLocale({ ids: ['cloydg3ka0005qcls5vmg8sb9', 'cloydg3ka0005qcls5vmg8sb8'], locale: 'fr', mode: 'published' })

{
  "originalLocaleIds": [
    "cloydg3ka0005qcls5vmg8sb9:en:published",
    "cloydg3ka0005qcls5vmg8sb8:en:published"
  ],
  "newLocaleIds": [
    "cloydg3ka0005qcls5vmg8sb9:fr:published",
    "cloydg3ka0005qcls5vmg8sb8:fr:published"
  ],
  "aposDocIds": [
    "cloydg3ka0005qcls5vmg8sb9",
    "cloydg3ka0005qcls5vmg8sb8"
  ]
}

In your app

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

Add the controller

app/controllers/exist_in_locale_controller.ts

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

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

  async handle() {
    return this.site.internationalization().existInLocale({ ids: ['cloydg3ka0005qcls5vmg8sb9', 'cloydg3ka0005qcls5vmg8sb8'], locale: 'fr', mode: 'published' })
  }
}

The other values are the example’s: take yours from the request, a form or your database.

Add the route

start/routes.ts

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

const ExistInLocaleController = () => import('#controllers/exist_in_locale_controller')

router.post('/i18n/exist-in-locale', [ExistInLocaleController])

Put it behind your auth middleware (.use(middleware.auth())): it acts with your key’s access.

Call it

Your own page’s form or script sends POST /i18n/exist-in-locale and gets back its answer as JSON. Test it, below, calls it.

Required parameters

One object, e.g. existInLocale({ ids }); leave out the optional fields.

readonly string[]

required

Required. Array of document IDs to check.

string

required

Required. Locale to check documents in.

ExistInLocaleRequestMode

required

Required. Mode to check documents in. One of draft, published.

Returns

An ExistInLocaleResponse. Document existence check completed successfully. Read its properties (existInLocale.originalLocaleIds): each says whether the site always sends it.

readonly string[]

Always sent. Array of document IDs in the original locale and mode.

readonly string[]

Always sent. Array of document IDs in the new locale.

readonly string[]

Always sent. Array of aposDocId values for the documents.

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.

400

The site refused what was sent: errors lists each field’s problem, siteMessage the first.Retried first: No. Read: errors (field → messages), siteMessage.

401

The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.Retried first: No. Read: siteMessage, errorName, data.

403

The key may not do this: a scope it lacks, or an address outside its allowlist. siteMessage names it.Retried first: No. Read: siteMessage, errorName, data.

5xx

The site failed (or something in front of it did). Its logs say why.Retried first: No: a write may have landed. Read: siteMessage, errorName, data.

no answer

No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Only when nothing reached the site (neverConnected()); never after a timeout, when it may have landed. 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 write is sent again only after a 429 (refused before it acted) or when it never reached the site. After a timeout or a 5xx it may have landed: check before you send it again.
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_exist_in_locale.spec.ts, then run your tests:

tests/unit/internationalization_exist_in_locale.spec.ts

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

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

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

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

Terminal

node ace test

List the site’s languages

site.internationalization().getLocales()

Get locale path and manage clipboard

site.internationalization().switchLocale()

POST /@apostrophecms/i18n/exist-in-locale

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 existInLocale = await site.internationalization().existInLocale({ ids: ['cloydg3ka0005qcls5vmg8sb9', 'cloydg3ka0005qcls5vmg8sb8'], locale: 'fr', mode: 'published' })

{
  "originalLocaleIds": [
    "cloydg3ka0005qcls5vmg8sb9:en:published",
    "cloydg3ka0005qcls5vmg8sb8:en:published"
  ],
  "newLocaleIds": [
    "cloydg3ka0005qcls5vmg8sb9:fr:published",
    "cloydg3ka0005qcls5vmg8sb8:fr:published"
  ],
  "aposDocIds": [
    "cloydg3ka0005qcls5vmg8sb9",
    "cloydg3ka0005qcls5vmg8sb8"
  ]
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Behavior

Test it

List the site’s languages

Get locale path and manage clipboard

POST /@apostrophecms/i18n/exist-in-locale

In your app

Behavior

Test it

Related

List the site’s languages

Get locale path and manage clipboard

POST /@apostrophecms/i18n/exist-in-locale