Copy global documents to another locale

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

const site = createSiteClient();
const job = await site.globalContent().localizeGlobals({ ids: ['clx8m2k4p0000a1b2c3d4e5f6'], toLocales: ['en'] });

{
  "jobId": "clx8m2k4p0000a1b2c3d4e5f6"
}

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/localize-globals.ts

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

export async function localizeGlobals(site: SiteClient) {
  return site.globalContent().localizeGlobals({ ids: ['clx8m2k4p0000a1b2c3d4e5f6'], toLocales: ['en'] });
}

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/localize-globals.ts

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { localizeGlobals } from '../src/attract/localize-globals.ts';

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

Terminal

node --env-file=.env scripts/localize-globals.ts

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

Answers at once with the job’s id.

Required parameters

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

readonly string[]

required

Required. The documents’ _ids: a full id names its own locale and mode (a draft’s …:en:draft, a published …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).

readonly string[]

required

Required. The locales to copy them into (unknown locale names are skipped).

Optional parameters

boolean | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Overwrite a copy that already exists in a target locale (default false: an existing copy is left as it is).

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Related document types to copy along (default none).

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Copy only the related documents, not the listed ones (default false).

BatchRequestMessages | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. The notification texts the CMS shows signed-in users while the job runs ({{ type }} and {{ count }} are filled in). Optional.

Show BatchRequestMessages

string

Shown while the job runs, e.g. Archiving {{ count }} {{ type }}….

string

Shown when it ends, e.g. Archived {{ count }} {{ type }}.

string

An admin-UI event to emit with the job’s results when it ends (for a custom screen); leave it out otherwise.

Returns

PendingJob: the job runs on the site, jobId names it. wait() needs the management client (the job route is management only): on this client it throws SiteConfigurationError. The job started.

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.

500

The site failed. 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

Access: an API key with global:write (or a master above it: global:all, admin:all). A signed-in person may call it as far as their own permissions allow; anyone else gets 403.
Rate limit: the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
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/globalContent-localizeGlobals.test.ts

import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { localizeGlobals } from '../src/attract/localize-globals.ts';

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

Answer with your own values: fake globalContent.localizeGlobals with factories.JobStarted({...}), the fields you give over a valid example.

tests/globalContent-localizeGlobals-answer.test.ts

import assert from 'node:assert/strict';
import { test } from 'node:test';
import { factories, fakeSite } from '@fetchski/attract-cms-sdk/testing';

test('globalContent.localizeGlobals answers your values', async () => {
  const site = fakeSite({
    'globalContent.localizeGlobals': factories.JobStarted({ jobId: 'Your value' })
  });
  const job = await site.globalContent().localizeGlobals({ ids: ['clx8m2k4p0000a1b2c3d4e5f6'], toLocales: ['en'] });
  assert.equal(job.jobId, 'Your value');
});

List global documents

site.globalContent().listGlobalContent()

Create a global document

site.globalContent().createGlobal()

Archive global documents

site.globalContent().archiveGlobals()

Publish global documents

site.globalContent().publishGlobals()

Restore global documents

site.globalContent().restoreGlobals()

Get a global document

site.globalContent().getGlobal()

POST /@apostrophecms/global/localize

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

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

Copy global documents to another locale

In your app

Behavior

Test it

List global documents

Create a global document

Archive global documents

Publish global documents

Restore global documents

Get a global document

POST /@apostrophecms/global/localize