List videos

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

const site = await app.container.make(SiteClient)
const listMediaVideos = await site.fetchskiMedia().listMediaVideos()

{
  "results": [
    {
      "_id": "clx8k2m0a0002abcd1234efgh",
      "slug": "video-product-tour",
      "title": "Product tour",
      "folderPath": "Marketing",
      "extension": "mp4",
      "bytes": 18430211,
      "url": "https://cdn.example.com/attachments/def456-product-tour.mp4",
      "poster": "https://cdn.example.com/attachments/ghi789-tour-poster.full.jpg"
    }
  ],
  "page": 1,
  "perPage": 25,
  "total": 1
}

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

const site = await app.container.make(SiteClient)
const listMediaVideos = await site.fetchskiMedia().listMediaVideos()

{
  "results": [
    {
      "_id": "clx8k2m0a0002abcd1234efgh",
      "slug": "video-product-tour",
      "title": "Product tour",
      "folderPath": "Marketing",
      "extension": "mp4",
      "bytes": 18430211,
      "url": "https://cdn.example.com/attachments/def456-product-tour.mp4",
      "poster": "https://cdn.example.com/attachments/ghi789-tour-poster.full.jpg"
    }
  ],
  "page": 1,
  "perPage": 25,
  "total": 1
}

In your app

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

Add the controller

app/controllers/list_media_videos_controller.ts

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

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

  async handle() {
    return this.site.fetchskiMedia().listMediaVideos()
  }
}

Add the route

start/routes.ts

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

const ListMediaVideosController = () => import('#controllers/list_media_videos_controller')

router.get('/fetchski-media/videos', [ListMediaVideosController])

Call it

Terminal

curl http://localhost:3333/fetchski-media/videos

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

Use a video’s slug to reference it in an MDX blog import.

Optional parameters

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

string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Words matched against each video’s title, alt text and other text: any of the words matches, best match first.

string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. A media folder ID: only what is in that folder.

boolean | null | undefined

Optional. Leave it out and the site uses true. With folder: include its subfolders too.

number | null | undefined

Optional. Leave it out and the site uses 25. Items per page: 1 to 100, 25 when left out (a value outside is brought into that range, never refused).

number | null | undefined

Optional. Leave it out and the site uses 1. Page number, from 1.

Returns

A ListMediaVideosResponse. A page of videos. Read its properties (listMediaVideos.results): each says whether the site always sends it. The example answer is the site’s wire JSON: one key differs from the property names (_id → id).

readonly MediaVideo[]

Always sent. A list of MediaVideo.

Show MediaVideo

One video from the Videos library.

string | null

Always sent, can be null. The video’s document ID (aposDocId).

string | null

Always sent, can be null. Reference a video in an MDX import by it.

string | null

Always sent, can be null. Its title.

string | null

Always sent, can be null. The media folder it sits in.

string | null

Always sent, can be null. File extension, e.g. mp4.

number | null

Always sent, can be null. Size of the file.

string | null

Always sent, can be null. The video file.

string | null

Always sent, can be null. The poster image, when one is set.

number

Always sent.

number

Always sent.

number

Always sent. Every match, across all pages.

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, is used from outside its allowlist, or the caller is anonymous.Retried first: No. Read: siteMessage, errorName, data.

429

The key used up its reads-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 videos:read — or media:all, or admin:all — or any signed-in CMS user (who sees only what they may view). Anonymous callers get 403.
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.
Paging: one page per call. To walk them all, use listMediaVideosAll() (see More examples): it asks for the next page as you iterate, and stops once page × perPage reaches total.

More examples

listMediaVideosAll() takes listMediaVideos()’s arguments except page.

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

const site = await app.container.make(SiteClient)
for await (const mediaVideo of site.fetchskiMedia().listMediaVideosAll()) {
  console.log(mediaVideo) // the next page is fetched as you iterate
}

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/fetchski_media_list_media_videos.spec.ts, then run your tests:

tests/unit/fetchski_media_list_media_videos.spec.ts

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

test('fetchskiMedia.listMediaVideos', async () => {
  const site = fakeAttract()

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

  site.assertCalled('fetchskiMedia.listMediaVideos')
})

Terminal

node ace test

Answer with your own values: fake fetchskiMedia.listMediaVideos with a sequence() of pages, each factories.ListMediaVideosResponse({...}), and walk listMediaVideosAll().

tests/unit/fetchski_media_list_media_videos_answers.spec.ts

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

test('fetchskiMedia.listMediaVideos answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'fetchskiMedia.listMediaVideos': sequence(
      factories.ListMediaVideosResponse({ page: 1, perPage: 1, total: 2 }),
      factories.ListMediaVideosResponse({ page: 2, perPage: 1, total: 2 })
    ),
  })

  const walked: unknown[] = []
  for await (const mediaVideo of site.fetchskiMedia().listMediaVideosAll()) {
    walked.push(mediaVideo)
  }
  assert.lengthOf(walked, 2)
})

To fake listMediaVideosAll(), answer fetchskiMedia.listMediaVideos (the walk calls it page by page): a sequence() of answers for several pages.

List images

site.fetchskiMedia().listMediaImages()

Get one image

site.fetchskiMedia().getMediaImage()

Get one video

site.fetchskiMedia().getMediaVideo()

GET /fetchski-media/videos

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 listMediaVideos = await site.fetchskiMedia().listMediaVideos()

{
  "results": [
    {
      "_id": "clx8k2m0a0002abcd1234efgh",
      "slug": "video-product-tour",
      "title": "Product tour",
      "folderPath": "Marketing",
      "extension": "mp4",
      "bytes": 18430211,
      "url": "https://cdn.example.com/attachments/def456-product-tour.mp4",
      "poster": "https://cdn.example.com/attachments/ghi789-tour-poster.full.jpg"
    }
  ],
  "page": 1,
  "perPage": 25,
  "total": 1
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Behavior

More examples

Test it

List images

Get one image

Get one video

GET /fetchski-media/videos

In your app

Behavior

More examples

Test it

Related

List images

Get one image

Get one video

GET /fetchski-media/videos