CMS

The CMS module provides flexible content management through nodes. Nodes hold structured content made of blocks and can be classified with taxonomies.

Content Nodes

Nodes are the building blocks of your content. Each node has a key identifier and contains structured content via blocks.

Create Node

Create a new content node.

const result = await sdk.cms.createNode({
key: 'getting-started-with-arky',
parentId: 'node_blog_root',
slug: {
  en: 'getting-started-with-arky',
  es: 'comenzando-con-arky'
},
blocks: [
  {
    key: 'title',
    type: 'LOCALIZED_TEXT',
    properties: { label: { en: 'Title' } },
    value: [{ en: 'Welcome to Arky', es: 'Bienvenido a Arky' }]
  },
  {
    key: 'body',
    type: 'MARKDOWN',
    properties: {},
    value: [{ en: 'This is the introduction paragraph...', es: 'Este es el párrafo de introducción...' }]
  },
  {
    key: 'featured',
    type: 'BOOLEAN',
    properties: {},
    value: [true]
  }
],
taxonomies: [
  {
    taxonomyId: 'tax_blog_categories',
    fields: [
      { type: 'text', id: 'fld_category', key: 'category', value: ['tutorials'] }
    ]
  }
]
});

Get Node

Retrieve a node by ID, slug, or key.

// By ID
const result = await sdk.cms.getNode({
id: 'node_xyz789'
});

// By slug (locale-aware)
const result = await sdk.cms.getNode({
slug: 'getting-started-with-arky'
});

// By key (unique lookup)
const result = await sdk.cms.getNode({
key: 'homepage'
});

// Access blocks with helper methods
const heroBlock = result.getBlock('hero');
const heroValues = result.getBlockValues('hero');
const imageUrl = result.getImage('hero-image');

List Nodes

List nodes with filtering and pagination.

const result = await sdk.cms.getNodes({
parentId: 'node_blog_root',
type: 'BLOG_POST',
key: 'featured-post',
statuses: ['ACTIVE'],
query: 'arky',
sortField: 'createdAt',
sortDirection: 'desc',
cursor: null,
limit: 10,
createdAtFrom: '2024-01-01',
createdAtTo: '2024-12-31'
});

result.items.forEach(node => {
console.log(node.key, node.slug);
});

Get Node Children

Get child nodes of a parent node.

const result = await sdk.cms.getNodeChildren({
  id: 'node_parent123',
  cursor: null,
  limit: 20
});

result.items.forEach(child => {
  console.log(child.key);
});

Update Node

Update an existing node.

const result = await sdk.cms.updateNode({
id: 'node_xyz789',
key: 'updated-post-key',
parentId: 'node_new_parent',
slug: {
  en: 'updated-slug',
  es: 'slug-actualizado'
},
status: 'ACTIVE',
blocks: [
  // Updated blocks
],
taxonomies: [
  {
    taxonomyId: 'tax_blog_categories',
    fields: [
      { type: 'text', id: 'fld_category', key: 'category', value: ['news'] }
    ]
  }
]
});

Delete Node

Delete a node.

await sdk.cms.deleteNode({
  id: 'node_xyz789'
});

Content Blocks

Blocks are reusable content components within nodes.

Block Types

Complete Blog Example

// Create a blog post
const post = await sdk.cms.createNode({
  key: '10-tips-for-better-code',
  parentId: 'node_blog_root',
  slug: {
    en: '10-tips-for-better-code',
    es: '10-consejos-para-mejor-codigo'
  },
  blocks: [
    {
      key: 'title',
      type: 'LOCALIZED_TEXT',
      properties: {},
      value: [{ en: '10 Tips for Better Code', es: '10 Consejos para Mejor Código' }]
    },
    {
      key: 'subtitle',
      type: 'LOCALIZED_TEXT',
      properties: {},
      value: [{ en: 'Improve your code quality today' }]
    },
    {
      key: 'hero-image',
      type: 'RELATIONSHIP_MEDIA',
      properties: {},
      value: ['media:media_hero123']
    },
    {
      key: 'content',
      type: 'MARKDOWN',
      properties: {},
      value: [{
        en: `## Introduction

Writing clean code is essential for maintainability...

## Tip 1: Use Descriptive Names

Variable names should describe their purpose...`
      }]
    },
    {
      key: 'author-email',
      type: 'EMAIL',
      properties: {},
      value: ['author@example.com']
    }
  ]
});

// Archive the post later
await sdk.cms.updateNode({
  id: post.id,
  status: 'ARCHIVED'
});