Archive redirects

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const job = await site.redirects().archiveRedirects({ ids: ['clx8m2k4p0000a1b2c3d4e5f6'] })

{
  "jobId": "clx8m2k4p0000a1b2c3d4e5f6"
}

In your app

A controller answers a route on your app: it calls archiveRedirects() and returns the job’s id.

Add the controller

app/controllers/archive_redirects_controller.ts

import { inject } from '@adonisjs/core'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class ArchiveRedirectsController {
  constructor(protected site: SiteClient) {}

  async handle() {
    return this.site.redirects().archiveRedirects({ ids: ['clx8m2k4p0000a1b2c3d4e5f6'] })
  }
}

The other values are the example’s: take yours from the request, a form or your database.

Add the route

start/routes.ts

import router from '@adonisjs/core/services/router'

const ArchiveRedirectsController = () => import('#controllers/archive_redirects_controller')

router.post('/redirect/archive', [ArchiveRedirectsController])

Put it behind your auth middleware (.use(middleware.auth())): it acts with your key’s access.

Call it

Your own page’s form or script sends POST /redirect/archive and gets back the job it started (jobId). Test it, below, calls it.

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.

Required parameters

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

readonly string[]

required

Required. The documents’ _ids: 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).

Optional parameters

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.

Show BatchRequestMessages

string

Shown while the job runs, e.g. Archiving {{ count }} {{ type }}….

string

Shown when it ends, e.g. Archived {{ count }} {{ type }}.

string

An admin-UI event to emit with the job’s results when it ends (for a custom screen); leave it out otherwise.

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.

Errors

Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see Map SDK errors to responses); catch only what you want to react to here.

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 config/attract.ts doesn’t list (with the keys in the database: no row in attract_api_keys).Retried first: No: nothing was sent. Read: message, slug.

setup

The site’s entry is wrong: a malformed baseUrl or key, a key filed under another slug, or no default site. node ace attract:check names the fix.Retried first: No: nothing was sent. Read: message (what to fix).

Behavior

Access: an API key with content:redirects:delete (or a master above it: content:redirects: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) in config/attract.ts for longer.

Test it

It calls the controller above with the SDK faked: fakeAttract() puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as tests/unit/redirects_archive_redirects.spec.ts, then run your tests:

tests/unit/redirects_archive_redirects.spec.ts

import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import ArchiveRedirectsController from '#controllers/archive_redirects_controller'

test('redirects.archiveRedirects', async () => {
  const site = fakeAttract()

  const controller = await app.container.make(ArchiveRedirectsController)
  await controller.handle()

  site.assertCalled('redirects.archiveRedirects')
})

Terminal

node ace test

Answer with your own values: fake redirects.archiveRedirects with factories.JobStarted({...}), the fields you give over a valid example.

tests/unit/redirects_archive_redirects_answers.spec.ts

import { test } from '@japa/runner'
import { factories, fakeAttract } from '@fetchski/attract-cms-adonis/testing'

test('redirects.archiveRedirects answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'redirects.archiveRedirects': factories.JobStarted({ jobId: 'Your value' }),
  })

  const job = await site.redirects().archiveRedirects({ ids: ['clx8m2k4p0000a1b2c3d4e5f6'] })
  assert.containSubset(job, { jobId: 'Your value' })
})

List redirects

site.redirects().listRedirects()

Create a redirect

site.redirects().createRedirect()

Get a redirect

site.redirects().getRedirect()

Replace a redirect

site.redirects().replaceRedirect()

Delete a redirect

site.redirects().deleteRedirect()

Update a redirect

site.redirects().updateRedirect()

POST /@apostrophecms/redirect/archive

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

Behavior

Test it

List redirects

Create a redirect

Get a redirect

Replace a redirect

Delete a redirect

Update a redirect

POST /@apostrophecms/redirect/archive

In your app

Behavior

Test it

Related

List redirects

Create a redirect

Get a redirect

Replace a redirect

Delete a redirect

Update a redirect

POST /@apostrophecms/redirect/archive