@astracms/nuxt

Nuxt 3 module for AstraCMS with auto-imports and SSR support.

Installation

npm install @astracms/nuxt
# or
pnpm add @astracms/nuxt

Setup

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@astracms/nuxt'],
  
  astracms: {
    apiKey: process.env.ASTRACMS_API_KEY,
  },
});

Or use runtime config:

// nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@astracms/nuxt'],
  
  runtimeConfig: {
    public: {
      astracms: {
        apiKey: '', // Set via NUXT_PUBLIC_ASTRACMS_API_KEY
      },
    },
  },
});

Usage

All composables are auto-imported:

<script setup>
// Fetch all posts (SSR-ready)
const { data: posts, pending } = await usePosts();

// With filters
const { data: techPosts } = await usePosts({
  categories: ['technology'],
  format: 'html',
});

// Single post
const route = useRoute();
const { data: post } = await usePost(route.params.slug);

// Categories, tags, authors
const { data: categories } = await useCategories();
const { data: tags } = await useTags();
const { data: authors } = await useAuthors();

// Search with debounce
const query = ref('');
const { data: results } = usePostSearch(query);
</script>

<template>
  <div v-if="pending">Loading...</div>
  <ul v-else>
    <li v-for="post in posts" :key="post.id">
      {{ post.title }}
    </li>
  </ul>
</template>

API

Auto-imported Composables

All use Nuxt's useAsyncData for SSR:

• usePosts(options?) - Fetch posts
• usePost(slug, options?) - Fetch single post
• useCategories() - Fetch categories
• useTags() - Fetch tags
• useAuthors() - Fetch authors
• usePostSearch(query, options?) - Search with debounce
• useAstraCMS() - Get client instance

Module Options

interface ModuleOptions {
  apiKey?: string;       // API key for v2 authentication (recommended)
  workspaceId?: string;  // Workspace ID for v1 authentication
  apiVersion?: 'v1' | 'v2'; // API version (defaults to 'v2')
  autoImport?: boolean;  // default: true
}

License

MIT