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

# Publish forms

> Publishes each listed draft, as a background job.

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

const site = createSiteClient();
const job = await site.forms().publishForms({ ids: ['clx8m2k4p0000a1b2c3d4e5f6'] });
```

```json 200 wrap theme={"dark"}
{
  "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.

**1. Add the function**

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

export async function publishForms(site: SiteClient) {
  return site.forms().publishForms({ ids: ['clx8m2k4p0000a1b2c3d4e5f6'] });
}
```

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/publish-forms.ts theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { publishForms } from '../src/attract/publish-forms.ts';

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

```bash Terminal theme={"dark"}
node --env-file=.env scripts/publish-forms.ts
```

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

Answers at once with the job’s id. Every id must name a document the caller may edit, or no job starts: 404 names the ids that matched nothing.

> [accordion] Required parameters
>
> One object, e.g. `publishForms({ ids })`; leave out the optional fields.
>
> **ids** `readonly string[]` *required*
>
> **Required.** The documents’ `_id`s: 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`).

> [accordion] Optional parameters
>
> **messages** `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.
>
> **BatchRequestMessages**
>
> **progress** `string`
>
> Shown while the job runs, e.g. `Archiving {{ count }} {{ type }}…`.
>
> **completed** `string`
>
> Shown when it ends, e.g. `Archived {{ count }} {{ type }}.`
>
> **resultsEventName** `string`
>
> An admin-UI event to emit with the job’s results when it ends (for a custom screen); leave it out otherwise.

> [accordion] 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.

> [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`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteError** `500`
>
> The site failed. 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

* **Access:** an API key with `content:forms:publish` (or a master above it: `content:forms:all`, `content: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`.

```ts tests/forms-publishForms.test.ts theme={"dark"}
import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { publishForms } from '../src/attract/publish-forms.ts';

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

**Answer with your own values:** fake `forms.publishForms` with `factories.JobStarted({...})`, the fields you give over a valid example.

```ts tests/forms-publishForms-answer.test.ts theme={"dark"}
import assert from 'node:assert/strict';
import { test } from 'node:test';
import { factories, fakeSite } from '@fetchski/attract-cms-sdk/testing';

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

## Related

> [card] [List a form’s locales](https://docs.fetchski-attract.com/typescript/reference/forms/get-form-locales.md)
>
> `site.forms().getFormLocales()`

> [card] [List forms](https://docs.fetchski-attract.com/typescript/reference/forms/list-forms.md)
>
> `site.forms().listForms()`

> [card] [Create a form](https://docs.fetchski-attract.com/typescript/reference/forms/create-form.md)
>
> `site.forms().createForm()`

> [card] [Get a form](https://docs.fetchski-attract.com/typescript/reference/forms/get-form.md)
>
> `site.forms().getForm()`

> [card] [Replace a form](https://docs.fetchski-attract.com/typescript/reference/forms/replace-form.md)
>
> `site.forms().replaceForm()`

> [card] [Delete a form](https://docs.fetchski-attract.com/typescript/reference/forms/delete-form.md)
>
> `site.forms().deleteForm()`

> [card] [POST /@apostrophecms/form/publish](https://docs.fetchski-attract.com/api-reference/forms/publish-forms.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.