> ## 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 image attachment

> Create a cropped version of an existing image attachment.

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

const site = createSiteClient();
const result = await site.attachments().cropAttachment({ id: 'ckj0akbxa003vp39kfbxgb8zg', crop: { top: 10, left: 15, width: 300, height: 200 } });
```

```json 200 wrap theme={"dark"}
true
```

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

export async function cropAttachment(site: SiteClient) {
  return site.attachments().cropAttachment({ id: 'ckj0akbxa003vp39kfbxgb8zg', crop: { top: 10, left: 15, width: 300, height: 200 } });
}
```

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

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

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

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

The crop object
is appended to the crops array property of the attachment document.
The newly uploaded image file will be stored with a filename using the
crop properties: \{\_id}-\{name}.\{top}.\{left}.\{width}.\{height}.\{extension}

> [accordion] Required parameters
>
> One object, e.g. `cropAttachment({ id })`; leave out the optional fields.
>
> **id** `string` *required*
>
> **Required.** The \_id property of an existing image attachment document.
>
> **crop** `CropAttachmentRequestCrop` *required*
>
> **Required.** Crop coordinates and dimensions.
>
> **CropAttachmentRequestCrop**
>
> **top** `number` *required*
>
> **Required.** Top coordinate of the crop area (pixels) At least 0.
>
> **left** `number` *required*
>
> **Required.** Left coordinate of the crop area (pixels) At least 0.
>
> **width** `number` *required*
>
> **Required.** Width of the crop area (pixels) At least 1.
>
> **height** `number` *required*
>
> **Required.** Height of the crop area (pixels) At least 1.

> [accordion] Optional parameters
>
> **aposMode** `AposMode | null | undefined`
>
> **Optional.** Leave it out and the site uses `"published"`. `published` (the default) or `draft`. Drafts need a credential that may see them: an API key with the type’s write scope (`content:<type>:write`), or a signed-in editor. The public and a key with only the read scope get 403. One of `draft`, `published`.
>
> **aposLocale** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. `en` (default: the site’s default locale).

> [accordion] Returns
>
> A `boolean`. Image cropped successfully.

> [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`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **ValidationFailed** `422`
>
> Unprocessable entity - crop coordinates exceed image bounds.
>
> **Retried first:** No. **Read:** `errors` (field → messages), `siteMessage`.
>
> **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 any one of `content:images:write`, `content:files:write` or `content:videos:write` (or a master above one). 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/attachments-cropAttachment.test.ts theme={"dark"}
import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { cropAttachment } from '../src/attract/crop-attachment.ts';

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

## Related

> [card] [Upload media file](https://docs.fetchski-attract.com/typescript/reference/attachments/upload-attachment.md)
>
> `site.attachments().uploadAttachment()`

> [card] [POST /@apostrophecms/attachment/crop](https://docs.fetchski-attract.com/api-reference/attachments/crop-image-attachment.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.