Check a document before importing it

import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const blogValidateResult = await site.blogPosts().validateBlogImport({ markdown: 'Example markdown' });

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

In your app

A function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

Add the function

src/attract/validate-blog-import.ts

import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function validateBlogImport(site: SiteClient) {
  return site.blogPosts().validateBlogImport({ markdown: 'Example markdown' });
}

The other values are the example’s: take yours from the request, a form or your database.

Call it

A script makes the client once and calls the function:

scripts/validate-blog-import.ts

import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { validateBlogImport } from '../src/attract/validate-blog-import.ts';

const site = createSiteClient();
console.log(await validateBlogImport(site));

Terminal

node --env-file=.env scripts/validate-blog-import.ts

A route handler, a job or a queue worker calls it the same way.

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; catch only what you want to react to (see Errors and testing).

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 your sites (createSiteClients()) don’t have.Retried first: No: nothing was sent. Read: message, slug.

setup

The client’s settings are wrong: no FETCHSKI_ATTRACT_URL (or baseUrl), or a malformed API key.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) on the client for longer.

Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with node --test.

tests/blogPosts-validateBlogImport.test.ts

import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { validateBlogImport } from '../src/attract/validate-blog-import.ts';

test('blogPosts.validateBlogImport', async () => {
  const site = fakeSite();
  await validateBlogImport(site);
  site.assertCalled('blogPosts.validateBlogImport');
});

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

tests/blogPosts-validateBlogImport-answer.test.ts

import assert from 'node:assert/strict';
import { test } from 'node:test';
import { factories, fakeSite } from '@fetchski/attract-cms-sdk/testing';

test('blogPosts.validateBlogImport answers your values', async () => {
  const site = fakeSite({
    'blogPosts.validateBlogImport': factories.BlogValidateResult({ valid: false })
  });
  const blogValidateResult = await site.blogPosts().validateBlogImport({ markdown: 'Example markdown' });
  assert.equal(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