List an author’s locales

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

const site = await app.container.make(SiteClient)
const documentLocales = await site.authors().getAuthorLocales({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })

{
  "results": [
    {}
  ]
}

In your app

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

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

  async handle({ params }: HttpContext) {
    return this.site.authors().getAuthorLocales({ id: params.id })
  }
}

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

const GetAuthorLocalesController = () => import('#controllers/get_author_locales_controller')

router.get('/author/:id/locales', [GetAuthorLocalesController])

curl http://localhost:3333/author/clx8m2k4p0000a1b2c3d4e5f6/locales

Find the id

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.authors().listAuthorsPick(['title', 'slug'])).find((each) => each.slug === 'getting-started') // { id, title, slug }, or undefined

Behavior

• Access: an API key with content:authors:read (or a master above it: content:authors:all, content:all, admin:all) reads the published documents; drafts (a draft _id) need content:authors:write (or a master above it). A signed-in person reads as far as their own permissions allow, and anyone else reads the published documents’ public fields.
• 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

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 GetAuthorLocalesController from '#controllers/get_author_locales_controller'

test('authors.getAuthorLocales', async () => {
  const site = fakeAttract()

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

  site.assertCalled('authors.getAuthorLocales', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6')
})

node ace test

Related