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

# Crop images to a widget’s aspect ratio

> An editor helper: crops each image of an image relationship to widgetOptions.aspectRatio (unless it is already close), and answers the relationship with each image’s crop in its _fields.

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

const site = createSiteClient();
const autocropImages = await site.media().autocropImages({ relationship: [{}] });
```

```json 200 wrap theme={"dark"}
{
  "relationship": [
    {}
  ]
}
```

## 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/autocrop-images.ts theme={"dark"}
import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function autocropImages(site: SiteClient) {
  return site.media().autocropImages({ relationship: [{}] });
}
```

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

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

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

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

Without an aspect ratio it answers the relationship as sent.

> [accordion] Required parameters
>
> One object, e.g. `autocropImages({ relationship })`; leave out the optional fields.
>
> **relationship** `readonly Readonly\<Record\<string, unknown\>\>[]` *required*
>
> **Required.** Image documents as an image relationship holds them, each with its crop and focal point in `_fields`.

> [accordion] Optional parameters
>
> **widgetOptions** `AutocropImagesRequestWidgetOptions | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The image widget’s options.
>
> **AutocropImagesRequestWidgetOptions**
>
> **aspectRatio** `readonly number[]`
>
> Width and height, e.g. `[16, 9]`. 2 to 2 items.
>
> **minSize** `readonly number[]`
>
> The smallest width and height a crop may have, in pixels. 2 to 2 items.

> [accordion] Returns
>
> An `AutocropImagesResponse`. The relationship, cropped. Read its properties (`autocropImages.relationship`): each says whether the site always sends it.
>
> **relationship** `readonly Readonly\<Record\<string, unknown\>\>[]`
>
> **Always sent.** Image documents as an image relationship holds them, each with its crop and focal point in `_fields`.

> [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** `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:images:write` (or a master above it: `content:images: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/media-autocropImages.test.ts theme={"dark"}
import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { autocropImages } from '../src/attract/autocrop-images.ts';

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

## Related

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

> [card] [Create an image](https://docs.fetchski-attract.com/typescript/reference/media/create-image.md)
>
> `site.media().createImage()`

> [card] [Archive images](https://docs.fetchski-attract.com/typescript/reference/media/archive-images.md)
>
> `site.media().archiveImages()`

> [card] [Copy images to another locale](https://docs.fetchski-attract.com/typescript/reference/media/localize-images.md)
>
> `site.media().localizeImages()`

> [card] [Publish images](https://docs.fetchski-attract.com/typescript/reference/media/publish-images.md)
>
> `site.media().publishImages()`

> [card] [Restore images](https://docs.fetchski-attract.com/typescript/reference/media/restore-images.md)
>
> `site.media().restoreImages()`

> [card] [POST /@apostrophecms/image/autocrop](https://docs.fetchski-attract.com/api-reference/media/crop-images-to-a-widget’s-aspect-ratio.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.