Check a document before importing it

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

const site = await app.container.make(SiteClient)
const blogValidateResult = await site.blogPosts().validateBlogImport({ markdown: 'Example markdown' })

{
  "valid": false,
  "errors": [
    {
      "message": "Front matter must include a \"title\"."
    }
  ]
}

In your app

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

Add the controller

app/controllers/validate_blog_import_controller.ts

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

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

  async handle() {
    return this.site.blogPosts().validateBlogImport({ markdown: 'Example markdown' })
  }
}

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 ValidateBlogImportController = () => import('#controllers/validate_blog_import_controller')

router.post('/blog/from-markdown/validate', [ValidateBlogImportController])

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 /blog/from-markdown/validate and gets back its answer as JSON. Test it, below, calls it.

Findings are the answer: a document with problems still returns 200 with valid: false. Publishing: publish=true publishes only when the caller may (a key needs content:blog:publish); otherwise the post is saved as a draft. An MDX import is always a draft.

Required parameters

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

string

required

Required. The whole document, exactly as the import would take it.

Optional parameters

boolean | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. The same as the body’s generateImages.

Format | null | undefined

Optional. Leave it out and the site uses "md". How to read markdown: plain Markdown (md) or MDX (mdx). One of md, mdx.

readonly string[] | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. The image filenames the real import will post, so references to them count as found. At most 10 items.

Returns

A BlogValidateResult. The findings. Read its properties (blogValidateResult.valid): each says whether the site always sends it.

boolean

Always sent.

readonly BlogValidateResultErrorsItem[]

Always sent. A list of BlogValidateResultErrorsItem.

Show BlogValidateResultErrorsItem

string

Always sent. What is wrong and how to fix it.

number

Sometimes sent: undefined when the site leaves it out. The body line, when known.

string

Sometimes sent: undefined when the site leaves it out. The MDX component, when one is at fault.

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 request is not valid; the message says which part and how to fix it.Retried first: No. Read: errors (field → messages), siteMessage.

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: 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: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 writes-per-minute limit, set when the key is created (default 120), and 30 imports and validations a minute per caller: whichever runs out first answers 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/blog_posts_validate_blog_import.spec.ts, then run your tests:

tests/unit/blog_posts_validate_blog_import.spec.ts

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

test('blogPosts.validateBlogImport', async () => {
  const site = fakeAttract()

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

  site.assertCalled('blogPosts.validateBlogImport')
})

Terminal

node ace test

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

tests/unit/blog_posts_validate_blog_import_answers.spec.ts

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

test('blogPosts.validateBlogImport answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'blogPosts.validateBlogImport': factories.BlogValidateResult({ valid: false }),
  })

  const blogValidateResult = await site.blogPosts().validateBlogImport({ markdown: 'Example markdown' })
  assert.containSubset(blogValidateResult, { valid: false })
})

List a blog post’s locales

site.blogPosts().getBlogLocales()

Get the Markdown template

site.blogPosts().getBlogMarkdownTemplate()

Get the MDX template

site.blogPosts().getBlogMdxTemplate()

List blog posts

site.blogPosts().listBlogs()

Create a blog post

site.blogPosts().createBlog()

Get a blog post

site.blogPosts().getBlog()

POST /@apostrophecms/blog/from-markdown/validate

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

Check a document before importing it

In your app

Behavior

Test it

List a blog post’s locales

Get the Markdown template

Get the MDX template

List blog posts

Create a blog post

Get a blog post

POST /@apostrophecms/blog/from-markdown/validate

In your app

Behavior

Test it

Related

List a blog post’s locales

Get the Markdown template

Get the MDX template

List blog posts

Create a blog post

Get a blog post

POST /@apostrophecms/blog/from-markdown/validate