Get locale path and manage clipboard

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const switchLocale = await site.internationalization().switchLocale({ locale: 'fr' });

{
  "redirectTo": "/fr/page-slug"
}

{
  "redirectTo": "https://fr.example.com/french-example-page?aposCrossDomainSessionToken=generated_token"
}

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const switchLocale = await site.internationalization().switchLocale({ locale: 'fr' });

{
  "redirectTo": "/fr/page-slug"
}

{
  "redirectTo": "https://fr.example.com/french-example-page?aposCrossDomainSessionToken=generated_token"
}

In your app

A function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

Add the function

src/attract/switch-locale.ts

import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function switchLocale(site: SiteClient) {
  return site.internationalization().switchLocale({ locale: 'fr' });
}

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

Call it

A script makes the client once and calls the function:

scripts/switch-locale.ts

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { switchLocale } from '../src/attract/switch-locale.ts';

const site = createSiteClient();
console.log(await switchLocale(site));

Terminal

node --env-file=.env scripts/switch-locale.ts

A route handler, a job or a queue worker calls it the same way.

Used for cross-locale navigation.

Required parameters

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

string

required

Required. Target locale code.

Optional parameters

string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional document ID for the path.

string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional clipboard content for cross-domain situations.

Returns

A SwitchLocaleResponse. Locale path retrieved successfully. One of these: tell them apart by their fields.

Show SameHostnameResponse

string

Always sent. Path to redirect to within same hostname. Matches ^/(?!/).*.

Show DifferentHostnameResponse

string

Always sent. Full URL to redirect to with cross-domain session token. Format: an absolute URL. Matches ^[A-Za-z][A-Za-z0-9+.-]*://.

Errors

Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below; catch only what you want to react to (see Errors and testing).

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 your sites (createSiteClients()) don’t have.Retried first: No: nothing was sent. Read: message, slug.

setup

The client’s settings are wrong: no FETCHSKI_ATTRACT_URL (or baseUrl), or a malformed API key.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) on the client for longer.

Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with node --test.

tests/internationalization-switchLocale.test.ts

import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { switchLocale } from '../src/attract/switch-locale.ts';

test('internationalization.switchLocale', async () => {
  const site = fakeSite();
  await switchLocale(site);
  site.assertCalled('internationalization.switchLocale');
});

List the site’s languages

site.internationalization().getLocales()

Check document existence in locale

site.internationalization().existInLocale()

POST /@apostrophecms/i18n/locale

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

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const switchLocale = await site.internationalization().switchLocale({ locale: 'fr' });

{
  "redirectTo": "/fr/page-slug"
}

{
  "redirectTo": "https://fr.example.com/french-example-page?aposCrossDomainSessionToken=generated_token"
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

Get locale path and manage clipboard

In your app

Behavior

Test it

List the site’s languages

Check document existence in locale

POST /@apostrophecms/i18n/locale

In your app

Behavior

Test it

Related

List the site’s languages

Check document existence in locale

POST /@apostrophecms/i18n/locale