Crop image attachment

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 } });

true

In your app

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 } });
}

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { cropAttachment } from '../src/attract/crop-attachment.ts';

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

node --env-file=.env scripts/crop-attachment.ts

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

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