> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Check document existence in locale

> Returns arrays of original document IDs, new locale IDs, and aposDocIds for an array of document IDs in a specified locale and mode.

```ts TypeScript wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const existInLocale = await site.internationalization().existInLocale({ ids: ['cloydg3ka0005qcls5vmg8sb9', 'cloydg3ka0005qcls5vmg8sb8'], locale: 'fr', mode: 'published' });
```

```json 200 wrap theme={"dark"}
{
  "originalLocaleIds": [
    "cloydg3ka0005qcls5vmg8sb9:en:published",
    "cloydg3ka0005qcls5vmg8sb8:en:published"
  ],
  "newLocaleIds": [
    "cloydg3ka0005qcls5vmg8sb9:fr:published",
    "cloydg3ka0005qcls5vmg8sb8:fr:published"
  ],
  "aposDocIds": [
    "cloydg3ka0005qcls5vmg8sb9",
    "cloydg3ka0005qcls5vmg8sb8"
  ]
}
```

## 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.

**1. Add the function**

```ts src/attract/exist-in-locale.ts theme={"dark"}
import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function existInLocale(site: SiteClient) {
  return 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.

**2. Call it**

A script makes the client once and calls the function:

```ts scripts/exist-in-locale.ts theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { existInLocale } from '../src/attract/exist-in-locale.ts';

const site = createSiteClient();
console.log(await existInLocale(site));
```

```bash Terminal theme={"dark"}
node --env-file=.env scripts/exist-in-locale.ts
```

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

> [accordion] Required parameters
>
> One object, e.g. `existInLocale({ ids })`; leave out the optional fields.
>
> **ids** `readonly string[]` *required*
>
> **Required.** Array of document IDs to check.
>
> **locale** `string` *required*
>
> **Required.** Locale to check documents in.
>
> **mode** `ExistInLocaleRequestMode` *required*
>
> **Required.** Mode to check documents in. One of `draft`, `published`.

> [accordion] Returns
>
> An `ExistInLocaleResponse`. Document existence check completed successfully. Read its properties (`existInLocale.originalLocaleIds`): each says whether the site always sends it.
>
> **originalLocaleIds** `readonly string[]`
>
> **Always sent.** Array of document IDs in the original locale and mode.
>
> **newLocaleIds** `readonly string[]`
>
> **Always sent.** Array of document IDs in the new locale.
>
> **aposDocIds** `readonly string[]`
>
> **Always sent.** Array of aposDocId values for the documents.

> [accordion] 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](https://docs.fetchski-attract.com/typescript/errors.md)).
>
> **ValidationFailed** `400`
>
> The site refused what was sent: `errors` lists each field’s problem, `siteMessage` the first.
>
> **Retried first:** No. **Read:** `errors` (field → messages), `siteMessage`.
>
> **AuthenticationFailed** `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`.
>
> **Forbidden** `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`.
>
> **SiteError** `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`.
>
> **SiteUnreachable** `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`.
>
> **RequestNotSent** `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).
>
> **SiteRequestFailed** `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`.
>
> **UnknownSite** `setup`
>
> `sites.forSite('acme')` named a slug your sites (`createSiteClients()`) don’t have.
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `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`.

```ts tests/internationalization-existInLocale.test.ts theme={"dark"}
import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { existInLocale } from '../src/attract/exist-in-locale.ts';

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

## Related

> [card] [List the site’s languages](https://docs.fetchski-attract.com/typescript/reference/internationalization/get-locales.md)
>
> `site.internationalization().getLocales()`

> [card] [Get locale path and manage clipboard](https://docs.fetchski-attract.com/typescript/reference/internationalization/switch-locale.md)
>
> `site.internationalization().switchLocale()`

> [card] [POST /@apostrophecms/i18n/exist-in-locale](https://docs.fetchski-attract.com/api-reference/internationalization/check-document-existence-in-locale.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.