@cyberclarence/indie-cms
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published

IndieCMS API client

IndieCMS API client is a TypeScript library for interacting with the API of the headless CMS IndieCMS.io. It provides a simple and intuitive interface for managing blog posts through the IndieCMS platform.

Installation

You can install the IndieCMS API client using npm:

bun install @cyberclarence/indie-cms

Usage

To use the IndieCMS API client in your project, you need to import the library and initialize the client with your API key and secret.

import IndieCMS from "@cyberclarence/indie-cms";

const indieCMS = new IndieCMS({
  apiKey: "your-api-key",
});

Methods

listPosts()

Retrieves a list of all blog posts for the authenticated project.

const posts = await indieCMS.listPosts();

getPost(slug: string)

Retrieves a single blog post by its slug.

const post = await indieCMS.getPost("your-post-slug");

createPost(post: Post)

Creates a new blog post.

const newPost = await indieCMS.createPost({
  title: "New Post",
  content: "This is the content of the new post.",
  tags: ["tag1", "tag2"],
  imgUrl: "https://example.com/image.jpg",
  slug: "new-post",
  description: "This is the description of the new post.",
});

updatePost(id: string, post: Post)

Updates an existing blog post by its ID.

const updatedPost = await indieCMS.updatePost("your-post-id", {
  title: "Updated Post",
  content: "This is the updated content of the post.",
  tags: ["tag1", "tag3"],
  imgUrl: "https://example.com/updated-image.jpg",
  slug: "updated-post",
  description: "This is the updated description of the post.",
});

deletePost(id: string)

Deletes a blog post by its ID.

await indieCMS.deletePost("your-post-id");

License

This project is licensed under the MIT License.

Readme

Keywords

Package Sidebar

Install

npm i @cyberclarence/indie-cms

Weekly Downloads

19

Version

0.2.1

License

MIT

Unpacked Size

14.3 kB

Total Files

10

Last publish

Collaborators

  • webclarence