Delete a file

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
await site.media().deleteFile({ id: 'ckitdo5oq004pu69kr6oxo6fr:en:published' });

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.

Add the function

src/attract/delete-file.ts

import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function deleteFile(site: SiteClient, id: string): Promise<void> {
  await site.media().deleteFile({ id });
}

Call it

A script makes the client once and calls the function:

scripts/delete-file.ts

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { deleteFile } from '../src/attract/delete-file.ts';

const site = createSiteClient();
await deleteFile(site, 'ckitdo5oq004pu69kr6oxo6fr:en:published');
console.log('Done.');

Terminal

node --env-file=.env scripts/delete-file.ts

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

Find the id

id is the document’s _id, from a list. Ask the list for only the fields you need: each row is a document’s id and those fields.

TypeScript

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const row = (await site.media().listFilesPick(['title', 'slug'])).find((each) => each.slug === 'getting-started'); // { id, title, slug }, or undefined

Pass row.id as id. Drafts: list with { aposMode: 'draft' } to get the draft’s id (Find an id).

Required parameters

One object, e.g. deleteFile({ id }); leave out the optional fields.

string

required

Required. Computed document ID (can optionally include mode and locale, e.g., id:en:published) Matches ^\S+$.

Optional parameters

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.

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

Returns

Nothing: the promise resolves once the site has answered. Deleted, for good (not moved to the archive). No body.

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

400

The site refused what was sent: errors lists each field’s problem, siteMessage the first.Retried first: No. Read: errors (field → messages), siteMessage.

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.

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.

404

Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage, errorName, data.

500

The site failed. Its logs say why.Retried first: No: a write may have landed. Read: siteMessage, errorName, data.

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.

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

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.

setup

sites.forSite('acme') named a slug your sites (createSiteClients()) don’t have.Retried first: No: nothing was sent. Read: message, slug.

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:files:delete (or a master above it: content:files: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.

tests/media-deleteFile.test.ts

import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { deleteFile } from '../src/attract/delete-file.ts';

test('media.deleteFile', async () => {
  const site = fakeSite();
  await deleteFile(site, 'ckitdo5oq004pu69kr6oxo6fr:en:published');
  site.assertCalled('media.deleteFile', (args) => args.id === 'ckitdo5oq004pu69kr6oxo6fr:en:published');
});

List images

site.media().listImages()

Create an image

site.media().createImage()

Archive images

site.media().archiveImages()

Crop images to a widget’s aspect ratio

site.media().autocropImages()

Copy images to another locale

site.media().localizeImages()

Publish images

site.media().publishImages()

DELETE /@apostrophecms/file/{_id}

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Find the id

Behavior

Test it

List images

Create an image

Archive images

Crop images to a widget’s aspect ratio

Copy images to another locale

Publish images

DELETE /@apostrophecms/file/{_id}

In your app

Find the id

Behavior

Test it

Related

List images

Create an image

Archive images

Crop images to a widget’s aspect ratio

Copy images to another locale

Publish images

DELETE /@apostrophecms/file/{_id}