List a folder’s photos

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

const site = await app.container.make(SiteClient)
const listImageFolderPhotos = await site.imageFolders().listImageFolderPhotos({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })

{
  "folder": {
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "title": "Example title",
    "folderPath": "marketing/team"
  },
  "results": [
    {
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "title": "Example title",
      "alt": "Example alt",
      "attachment": {
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "name": "Example name",
        "extension": "jpg",
        "width": 1,
        "height": 1,
        "_urls": {
          "key": "https://acme.example/example"
        }
      }
    }
  ]
}

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

const site = await app.container.make(SiteClient)
const listImageFolderPhotos = await site.imageFolders().listImageFolderPhotos({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })

{
  "folder": {
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "title": "Example title",
    "folderPath": "marketing/team"
  },
  "results": [
    {
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "title": "Example title",
      "alt": "Example alt",
      "attachment": {
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "name": "Example name",
        "extension": "jpg",
        "width": 1,
        "height": 1,
        "_urls": {
          "key": "https://acme.example/example"
        }
      }
    }
  ]
}

In your app

A controller answers a route on your app: it calls listImageFolderPhotos() and returns the answer.

Add the controller

app/controllers/list_image_folder_photos_controller.ts

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

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

  async handle({ params }: HttpContext) {
    return this.site.imageFolders().listImageFolderPhotos({ id: params.id })
  }
}

Add the route

start/routes.ts

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

const ListImageFolderPhotosController = () => import('#controllers/list_image_folder_photos_controller')

router.get('/image-folder/:id/photos', [ListImageFolderPhotosController])

Call it

Terminal

curl http://localhost:3333/image-folder/clx8m2k4p0000a1b2c3d4e5f6/photos

With node ace serve running, it prints its answer as JSON.

A reference folder (one whose images never feed a gallery) answers 404.

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.

AdonisJS

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

const site = await app.container.make(SiteClient)
const row = (await site.imageFolders().listImageFoldersPick(['title', 'slug'])).find((each) => each.slug === 'getting-started') // { id, title, slug }, or undefined

Pass row.id as id. See Find an id.

Required parameters

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

string

required

Required. The folder’s document ID.

Optional parameters

string | null | undefined

Optional. Leave it out and the site uses "1". Send 0 for this folder only; anything else includes its subfolders.

number | null | undefined

Optional. Leave it out and the site uses 200. At most this many photos. 1 to 200.

Returns

A ListImageFolderPhotosResponse. The folder and its photos. Read its properties (listImageFolderPhotos.folder): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (_id → id, _urls → urls).

ListImageFolderPhotosResponseFolder

Always sent. A ListImageFolderPhotosResponseFolder.

Show ListImageFolderPhotosResponseFolder

Required.

string

Always sent.

string

Always sent.

string

Sometimes sent: undefined when the site leaves it out.

readonly GalleryPhoto[]

Always sent. A list of GalleryPhoto.

Show GalleryPhoto

string

Always sent. The image’s document ID.

GalleryPhotoFile

Always sent. A GalleryPhotoFile. The image file: its size, and a URL per rendered size.

Show GalleryPhotoFile

string

Always sent.

string

Always sent. The file name, without its extension.

string

Always sent.

Readonly<Record<string, string>>

Always sent. Size name (max, full, two-thirds, one-half, one-third, one-sixth, original) → URL.

number

Sometimes sent: undefined when the site leaves it out.

number

Sometimes sent: undefined when the site leaves it out.

Readonly<Record<string, unknown>>

Always there: {} when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.

string

Sometimes sent: undefined when the site leaves it out.

string

Sometimes sent: undefined when the site leaves it out. Alt text; empty when none is set.

Readonly<Record<string, unknown>>

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.

401

The API key is missing, malformed, unknown, disabled, expired or archived, or a request its signing mode requires to be signed is not.Retried first: No. Read: siteMessage, errorName, data.

403

The API key lacks the scope this route needs (the message names it) or is used from outside its allowlist; or, on a route that answers 403 to everyone it refuses, the caller may not use it.Retried first: No. Read: siteMessage, errorName, data.

404

Nothing matches the identifier, or the caller may not use this route at all (it is not advertised).Retried first: No. Read: siteMessage, errorName, data.

429

The key used up its per-minute limit. Still, after the client’s own waits and retries.Retried first: Yes: the client waits Retry-After (1 s when absent; over 60 s it gives up at once) and retries, up to retries times (2 by default). Read: retryAfter (seconds, or null), siteMessage.

5xx

The site failed (or something in front of it did). Its logs say why.Retried first: A 502, 503 or 504: yes, after 0.5 s then 1 s. A 500: no. Read: siteMessage, errorName, data.

no answer

No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Yes, after 0.5 s then 1 s. 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 images:read, or media:all, or admin:all, or any signed-in CMS user. The site’s own server may call it too. Other callers get 404.
Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
Retries: a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
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/image_folders_list_image_folder_photos.spec.ts, then run your tests:

tests/unit/image_folders_list_image_folder_photos.spec.ts

import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import testUtils from '@adonisjs/core/services/test_utils'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import ListImageFolderPhotosController from '#controllers/list_image_folder_photos_controller'

test('imageFolders.listImageFolderPhotos', async () => {
  const site = fakeAttract()

  const ctx = await testUtils.createHttpContext()
  ctx.params = { id: 'clx8m2k4p0000a1b2c3d4e5f6' }
  const controller = await app.container.make(ListImageFolderPhotosController)
  await controller.handle(ctx)

  site.assertCalled('imageFolders.listImageFolderPhotos', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6')
})

Terminal

node ace test

Answer with your own values: fake imageFolders.listImageFolderPhotos with factories.ListImageFolderPhotosResponse({...}), the fields you give over a valid example (nested ones too).

tests/unit/image_folders_list_image_folder_photos_answers.spec.ts

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

test('imageFolders.listImageFolderPhotos answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'imageFolders.listImageFolderPhotos': factories.ListImageFolderPhotosResponse({ folder: { id: 'Your value' } }),
  })

  const listImageFolderPhotos = await site.imageFolders().listImageFolderPhotos({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })
  assert.containSubset(listImageFolderPhotos, { folder: { id: 'Your value' } })
})

Get the image folder tree

site.imageFolders().getImageFolderTree()

List image folders

site.imageFolders().listImageFolders()

Create an image folder

site.imageFolders().createImageFolder()

Get an image folder

site.imageFolders().getImageFolder()

Replace an image folder

site.imageFolders().replaceImageFolder()

Delete an image folder

site.imageFolders().deleteImageFolder()

GET /image-folder/{_id}/photos

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

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

const site = await app.container.make(SiteClient)
const listImageFolderPhotos = await site.imageFolders().listImageFolderPhotos({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })

{
  "folder": {
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "title": "Example title",
    "folderPath": "marketing/team"
  },
  "results": [
    {
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "title": "Example title",
      "alt": "Example alt",
      "attachment": {
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "name": "Example name",
        "extension": "jpg",
        "width": 1,
        "height": 1,
        "_urls": {
          "key": "https://acme.example/example"
        }
      }
    }
  ]
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Find the id

Behavior

Test it

Get the image folder tree

List image folders

Create an image folder

Get an image folder

Replace an image folder

Delete an image folder

GET /image-folder/{_id}/photos

In your app

Find the id

Behavior

Test it

Related

Get the image folder tree

List image folders

Create an image folder

Get an image folder

Replace an image folder

Delete an image folder

GET /image-folder/{_id}/photos