Import a post from Markdown or MDX

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

const site = createSiteClient();
const blogImportResult = await site.blogPosts().importBlogPost({ markdown: '---\ntitle: "Our spring update"\nexcerpt: "What changed this season."\n---\n\n## What’s new\n\nThe body, in Markdown.\n' });

{
  "_id": "clx8k2m0a0011abcd1234efgh:en:draft",
  "type": "@apostrophecms/blog",
  "title": "Five things we learned this year",
  "slug": "five-things-we-learned-this-year",
  "_url": "https://www.example.com/blog/five-things-we-learned-this-year",
  "published": false
}

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

const site = createSiteClient();
const blogImportResult = await site.blogPosts().importBlogPost({ markdown: '---\ntitle: "Our spring update"\nexcerpt: "What changed this season."\n---\n\n## What’s new\n\nThe body, in Markdown.\n' });

{
  "_id": "clx8k2m0a0011abcd1234efgh:en:draft",
  "type": "@apostrophecms/blog",
  "title": "Five things we learned this year",
  "slug": "five-things-we-learned-this-year",
  "_url": "https://www.example.com/blog/five-things-we-learned-this-year",
  "published": false
}

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/import-blog-post.ts

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

export async function importBlogPost(site: SiteClient) {
  return site.blogPosts().importBlogPost({ markdown: '---\ntitle: "Our spring update"\nexcerpt: "What changed this season."\n---\n\n## What’s new\n\nThe body, in Markdown.\n' });
}

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/import-blog-post.ts

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

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

Terminal

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

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

Send JSON, the raw document (text/markdown, at most 5 MB by default), or a multipart upload with the file and its images. Images: featuredImage in the front matter and every image in the body may be an https:// URL (fetched, at most 15 MB by default), a library image’s slug, a filename posted with the file (image, up to 10), or generate: <description> with generateImages (at most 4 per import). Media on an API key: a new image (a URL, a posted file or generate:) needs content:images:write, a new video content:videos:write and content:videos:publish; a library slug needs content:images:read / content:videos:read. The blog scopes don’t cover media, and the refusal names the missing scope. 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. Removing an import: delete the post by the draft _id the import answered. On an API key that needs content:blog:delete.

Required parameters

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

string

required

Required. The whole document: YAML front matter between --- lines, then the Markdown body. title is the one required front matter key; slug, publishedAt, authorName (or authorEmail), category, excerpt, featuredImage (+ featuredImageAlt), seoTitle, seoDescription and splitDepth are optional (the Markdown template, getBlogMarkdownTemplate, names every key). Body headings start at ##: the title is the post’s only <h1>.

Optional parameters

Format | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Read a raw or JSON body as mdx. One of md, mdx.

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 publish.

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.

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 _ai.

Returns

A BlogImportResult. The new post. Read its properties (blogImportResult.id): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (_id → id, _url → url).

string

Always sent.

string

Always sent.

string

Always sent.

string

Always sent.

boolean

Always sent. False when it was saved as a draft.

string

Sometimes sent: undefined when the site leaves it out. The post’s page.

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.

413

The document or a file is over its size limit (the message names it).Retried first: No. Read: reason, status.

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: the SDK gives this call 615 s on its own (your client’s own timeout when that is 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-importBlogPost.test.ts

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

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

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

tests/blogPosts-importBlogPost-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.importBlogPost answers your values', async () => {
  const site = fakeSite({
    'blogPosts.importBlogPost': factories.BlogImportResult({ id: 'Your value' })
  });
  const blogImportResult = await site.blogPosts().importBlogPost({ markdown: '---\ntitle: "Our spring update"\nexcerpt: "What changed this season."\n---\n\n## What’s new\n\nThe body, in Markdown.\n' });
  assert.equal(blogImportResult.id, 'Your value');
});

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

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

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

const site = createSiteClient();
const blogImportResult = await site.blogPosts().importBlogPost({ markdown: '---\ntitle: "Our spring update"\nexcerpt: "What changed this season."\n---\n\n## What’s new\n\nThe body, in Markdown.\n' });

{
  "_id": "clx8k2m0a0011abcd1234efgh:en:draft",
  "type": "@apostrophecms/blog",
  "title": "Five things we learned this year",
  "slug": "five-things-we-learned-this-year",
  "_url": "https://www.example.com/blog/five-things-we-learned-this-year",
  "published": false
}

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

Get the MDX template

List blog posts

Create a blog post

Get a blog post

POST /@apostrophecms/blog/from-markdown

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