GarchiCMS Node SDK

The GarchiCMS Node SDK is a Node package for interacting with the Garchi CMS API. It provides a simple, modular, and intuitive interface for managing categories, data items, reviews, reactions, spaces, and headless CMS features.

📖 API Documentation: Garchi CMS API Docs

📖 Table of Contents

GarchiCMS SDK

GarchiCMS SDK is a TypeScript library for interacting with the Garchi CMS API. It provides a simple, modular, and intuitive interface for managing categories, data items, reviews, reactions, spaces, and headless web APIs.

You can find the API documentation here

Features

  • Manage Data Items: Create, update, delete, and fetch data items.
  • Handle Categories: Create, update, delete, and list categories.
  • Manage Spaces: Create, update, and fetch spaces.
  • Handle Reviews: Create, update, delete, and fetch reviews.
  • Manage Reactions: Add or remove reactions for items or reviews.
  • Perform Compound Queries: Execute complex queries across items, categories, and reviews.
  • Work with Headless CMS: Manage assets, pages, and section templates.

Installation

npm install @garchicms/garchi-node-sdk

Usage

This SDK is a wrapper around the Garchi CMS API. providing easy-to-use modular functions that map directly to API endpoints.

Importing the SDK

import GarchiCMS from '@garchicms/garchi-node-sdk';

Initializing the Client

const garchi = new GarchiCMS({ api_key: 'YOUR_API_KEY' });

Module mapping

Each module corresponds to a specific API group:

Each module return values corresponds to the return value of the respective API Endpoint. The only difference being the excluding the paginated API endpoints, each module return value can be accessed without the .data attribute.

Example usages

Here are some example usages

Data item API

Create a Data Item

const newItem = await garchi.dataItem.create({
  space_uid: 'your_space_uid',
  name: 'New Item',
  categories: [1, 2, 3],
});

Get All Items

const items = await client.dataItem.getAll({ size: 10 });

Category API

Create a Category

const newCategory = await client.category.create({
  category: 'New Category',
  space_uid: 'your_space_uid'
});

Get All Categories

const categories = await client.category.getAll();

Review API

Create a Review

const review = await client.review.create({
  item_id: 1,
  rating: 5,
  review_body: 'Excellent product!',
  user_email: 'user@example.com',
  user_name: 'John Doe'
});

Reaction API

Add or Update Reaction

const reaction = await client.reaction.manage({
  reaction: 'like',
  user_identifier: 'user@example.com',
  review_id: 1,
  item_id: 1,
  reaction_for: 'review'
});

Space API

Create a Space

const newSpace = await client.space.create({
  name: 'New Space',
  logo: yourLogoFile
});

List Pages in a Space

const pages = await client.space.listPages("your_space_uid")

List Section Templates in a Space

const sectionTemplates = await client.space.listSectionTemplates("your_space_uid")

Compound Query API

Perform a Compound Query

const queryResult = await client.compoundQuery.query({
  dataset: 'items',
  fields: ['name', 'price'],
  conditions: ['like', 'gte'],
  values: ['%item%', '10'],
  logic: ['and']
}, { order_key: 'name', order_by: 'asc' });

Headless CMS API

Get a Page

const page = await client.headless.getPage({
  space_uid: 'your_space_uid',
  slug: '/',
  lang: 'en-US',
  mode: 'live'
});

Get an asset

const asset = await client.headless.getAsset("file_name", "your_space_uid" )

Create Page

const page = await client.headless.addPage({
  space_uid: "your_space_uid",
  title: "Home",
  path: "/",
  description: "This is our Headless CMS SaaS"
})

Add blank section to a page

const section = await client.headless.addBlankSectionToPage({
     section_template_id: "section_template_id"
     parent_id: "id of the section if this is being added as nested section",
     page_id: "page_id"
})

Error Handling

All API calls return promises and throw errors if the API call fails.

try {
  const item = await client.dataItem.getItem({ item: 1 });
  console.log(item);
} catch (error) {
  console.error('Error:', error);
}

Types and Interfaces

The SDK exports types and interfaces for better TypeScript support.

import { GarchiItem, GarchiCategory, GarchiReview } from '@garchicms/garchi-sdk-node';