Get the MDX template

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

const site = await app.container.make(SiteClient)
const blogTemplate = await site.blogPosts().getBlogMdxTemplate()
await blogTemplate.saveTo(app.makePath('content/blog/')) // …/content/blog/template_blog_post.mdx

{
  "filename": "template_blog_post.mdx",
  "content": "---\ntitle: …\n---\n"
}

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

const site = await app.container.make(SiteClient)
const blogTemplate = await site.blogPosts().getBlogMdxTemplate()
await blogTemplate.saveTo(app.makePath('content/blog/')) // …/content/blog/template_blog_post.mdx

{
  "filename": "template_blog_post.mdx",
  "content": "---\ntitle: …\n---\n"
}

In your app

A controller answers a route on your app: it calls getBlogMdxTemplate() and answers the file as a download.

Add the controller

app/controllers/get_blog_mdx_template_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 GetBlogMdxTemplateController {
  constructor(protected site: SiteClient) {}

  async handle({ response }: HttpContext) {
    const blogTemplate = await this.site.blogPosts().getBlogMdxTemplate()
    response.header('Content-Type', 'text/markdown; charset=utf-8')
    response.header('Content-Disposition', `attachment; filename="${blogTemplate.filename}"`)
    return blogTemplate.content
  }
}

Add the route

start/routes.ts

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

const GetBlogMdxTemplateController = () => import('#controllers/get_blog_mdx_template_controller')

router.get('/blog/mdx-template', [GetBlogMdxTemplateController])

Call it

Terminal

curl -OJ http://localhost:3333/blog/mdx-template

With node ace serve running, it saves template_blog_post.mdx in the folder you run it from (-O saves the answer, -J under the name the download gives).

Parameters

None: call it with no arguments.

Returns

A BlogTemplate. The template. Read its properties (blogTemplate.filename): each says whether the site always sends it. Save it with saveTo(path) (a folder keeps the site’s file name, template_blog_post.mdx; Node, Bun or Deno).

string

Always sent. The file name to save the template under.

string

Always sent. The template: front matter naming every field, then guidance for the body.

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.

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 content:blog:write, or content:blog:all, or content:all, or admin:all, or a signed-in user holding the blog:import-markdown permission. Other callers get 403.
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/blog_posts_get_blog_mdx_template.spec.ts, then run your tests:

tests/unit/blog_posts_get_blog_mdx_template.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 GetBlogMdxTemplateController from '#controllers/get_blog_mdx_template_controller'

test('blogPosts.getBlogMdxTemplate', async ({ assert }) => {
  const site = fakeAttract()

  const ctx = await testUtils.createHttpContext()
  const controller = await app.container.make(GetBlogMdxTemplateController)
  await controller.handle(ctx)

  site.assertCalled('blogPosts.getBlogMdxTemplate')
  assert.include(String(ctx.response.getHeader('content-disposition')), 'template_blog_post.md')
})

Terminal

node ace test

Answer with your own values: fake blogPosts.getBlogMdxTemplate with factories.BlogTemplate({...}), the fields you give over a valid example.

tests/unit/blog_posts_get_blog_mdx_template_answers.spec.ts

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

test('blogPosts.getBlogMdxTemplate answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'blogPosts.getBlogMdxTemplate': factories.BlogTemplate({ filename: 'Your value' }),
  })

  const blogTemplate = await site.blogPosts().getBlogMdxTemplate()
  assert.containSubset(blogTemplate, { filename: 'Your value' })
})

List a blog post’s locales

site.blogPosts().getBlogLocales()

Get the Markdown template

site.blogPosts().getBlogMarkdownTemplate()

List blog posts

site.blogPosts().listBlogs()

Create a blog post

site.blogPosts().createBlog()

Get a blog post

site.blogPosts().getBlog()

Replace a blog post

site.blogPosts().replaceBlog()

GET /@apostrophecms/blog/mdx-template

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 blogTemplate = await site.blogPosts().getBlogMdxTemplate()
await blogTemplate.saveTo(app.makePath('content/blog/')) // …/content/blog/template_blog_post.mdx

{
  "filename": "template_blog_post.mdx",
  "content": "---\ntitle: …\n---\n"
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Behavior

Test it

List a blog post’s locales

Get the Markdown template

List blog posts

Create a blog post

Get a blog post

Replace a blog post

GET /@apostrophecms/blog/mdx-template

In your app

Behavior

Test it

Related

List a blog post’s locales

Get the Markdown template

List blog posts

Create a blog post

Get a blog post

Replace a blog post

GET /@apostrophecms/blog/mdx-template