Post body as raw HTML.
', excerpt: 'Short summary shown in listings.', status: 'publish', // 'publish' | 'draft' | 'pending' | 'private' | 'future' slug: 'full-example', date: '2026-03-01T10:00:00', // ISO 8601 — used for scheduled posts author: 1, // user ID featured_media: 42, // attachment ID categories: [3, 7], tags: [12], sticky: false, format: 'standard', // 'standard' | 'aside' | 'gallery' | 'video' | … comment_status: 'open', ping_status: 'closed', }); ``` -------------------------------- ### Run Tests in Watch Mode Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/README.md Starts the test runner in watch mode, automatically re-running tests on file changes. ```bash npm run test:watch ``` -------------------------------- ### Build Project Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/README.md Builds the Astro project for production deployment. ```bash npm run build ``` -------------------------------- ### Create WordPress Client from Resolved Config Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/auth-action-bridge.mdx Use this when you need to manually create the WordPress client. It first resolves the client configuration and then instantiates the client. ```typescript import { WordPressClient } from 'fluent-wp-client'; const clientConfig = await wordPressAuthBridge.getClientConfig(Astro); if (!clientConfig) { return Astro.redirect('/login'); } const wp = new WordPressClient(clientConfig); ``` -------------------------------- ### Set WordPress Catalog URL Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/catalog.mdx Define the `WP_CATALOG_URL` environment variable in your `.env` file to specify the WordPress API endpoint. This variable is used during Astro setup. ```bash WP_CATALOG_URL=https://cms.example.com ``` -------------------------------- ### Import WordPress Schema Functions Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/catalog.mdx Import functions to get Zod schemas for WordPress resources, content, and terms. Use these to validate data fetched from WordPress. ```typescript import { getWordPressContentSchemas, getWordPressResourceSchemas, getWordPressTermSchemas, withWordPressActionSchemas, } from 'virtual:wp-astrojs/schemas'; ``` -------------------------------- ### Create Catalog-Backed WordPress Client Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/catalog.mdx Import and create a WordPress client using the virtual module, seeded with the stored catalog. This client can be used with loaders and actions. ```typescript import { createWordPressClient } from 'virtual:wp-astrojs/catalog'; export const wp = createWordPressClient({ baseUrl: import.meta.env.WP_CATALOG_URL, }); ``` -------------------------------- ### Run All Test Projects Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/README.md Executes all test suites for the project. ```bash npm test ``` -------------------------------- ### Login Payload Schema Definition Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/auth-action-bridge.mdx Define the login payload schema using Zod for input validation. This example shows how to import and type the login input schema. ```typescript import { z } from 'astro/zod'; import { wordPressLoginInputSchema } from 'wp-astrojs-integration'; type LoginPayload = z.inputBody.
", "status": "publish", "meta": { "reading_time": 5, "source_url": "https://example.com/original" } } ``` ### Response #### Success Response (200) - **data** (object) - Contains the result of the create operation. ``` -------------------------------- ### Static Client with Request-Aware Auth Headers Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/actions/index.mdx Configuring a static client with dynamic authentication headers based on request details. ```APIDOC ## Static Client with Request-Aware Auth Headers ### Description This setup uses a static `WordPressClient` but employs a custom `authHeaders` function to dynamically generate authentication headers for each request. This is useful for integrations requiring custom signing or token generation based on request parameters. ### Usage ```ts import { WordPressClient } from 'fluent-wp-client'; const wp = new WordPressClient({ baseUrl: import.meta.env.WP_URL, authHeaders: ({ method, url, body }) => { // Replace with your signer implementation const signature = createSignedAuthHeader({ method, url: url.toString(), body }); return { Authorization: signature, }; }, }); // Note: `createSignedAuthHeader` is a user-defined function and not part of the package. ``` ``` -------------------------------- ### Session-Based Auth for Authenticated Routes Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/reading-content.mdx Access user-specific content and drafts within an Astro page using session-based authentication. This example assumes Astro.locals.wp is already configured with an authenticated WordPressClient. ```astro --- Astro.cache.set(false); const wp = Astro.locals.wp; const user = await wp.users().me(); const drafts = await wp.content('posts').list({ status: 'draft' }); ---{drafts.length} drafts
``` -------------------------------- ### Define WordPress Collection with Catalog Loader Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/catalog.mdx Configure Astro content collections using the WordPress integration's loader and schema, which are derived from the catalog. This example shows defining a 'posts' collection. ```typescript import { defineCollection } from 'astro:content'; import { postSchema } from 'fluent-wp-client/zod'; import { wordPressPostStaticLoader } from 'wp-astrojs-integration'; import { wp } from './lib/wp'; export const collections = { posts: defineCollection({ loader: wordPressPostStaticLoader(wp), schema: postSchema, }), }; ``` -------------------------------- ### Create Published Post with Astro Action Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/actions/posts.mdx Create a live published post by calling the `actions.createPost` action with `status: 'publish'`. You can optionally include excerpt, categories, and tags. ```typescript const { data } = await Astro.callAction(actions.createPost, { title: 'Hello World', content: 'My first post.
', excerpt: 'A short summary.', status: 'publish', categories: [3], // category IDs tags: [12, 15], // tag IDs }); ``` -------------------------------- ### Use Generated Schemas in Astro Actions Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/typesafe-integration.mdx Create Astro actions with type safety by using generated Zod schemas for request and response validation. This example demonstrates creating posts and books. ```typescript import { createCreatePostAction } from 'wp-astrojs-integration'; import { wp } from '../lib/wp'; import { postsCreateSchema, postsItemSchema, booksCreateSchema, booksItemSchema, } from '../generated/wp-schemas'; export const server = { createPost: createCreatePostAction(wp, { schema: postsCreateSchema, responseSchema: postsItemSchema, }), createBook: createCreatePostAction(wp, { resource: 'books', schema: booksCreateSchema, responseSchema: booksItemSchema, }), }; ``` -------------------------------- ### Static Client with JWT Token Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/actions/index.mdx Set up a static WordPress client using a JWT token for authentication. Requires the WP_URL and WP_JWT_TOKEN environment variables. ```typescript import { WordPressClient } from 'fluent-wp-client'; const wp = new WordPressClient({ baseUrl: import.meta.env.WP_URL, auth: { token: import.meta.env.WP_JWT_TOKEN, }, }); ``` -------------------------------- ### Use Generated Schemas in Astro Content Collections Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/typesafe-integration.mdx Define Astro content collections using generated Zod schemas for type safety. This example shows how to configure collections for posts and books. ```typescript import { defineCollection, defineLiveCollection } from 'astro:content'; import { wordPressPostStaticLoader, wordPressContentLoader, } from 'wp-astrojs-integration'; import { wp } from './lib/wp'; import { postsItemSchema, booksItemSchema, } from './generated/wp-schemas'; export const collections = { posts: defineCollection({ loader: wordPressPostStaticLoader(wp), schema: postsItemSchema, }), books: defineLiveCollection({ loader: wordPressContentLoader(wp, { resource: 'books' }), schema: booksItemSchema, }), }; ``` -------------------------------- ### Call Cache Invalidation Action Examples Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/caching.mdx Demonstrates how to call the `wpCacheInvalidate` action with different entity types. Provide the `id`, `entity`, and specific type information like `post_type` or `taxonomy` as needed. ```typescript await actions.wpCacheInvalidate({ id: 42, entity: 'post', post_type: 'book', }); await actions.wpCacheInvalidate({ id: 8, entity: 'term', taxonomy: 'genre', }); await actions.wpCacheInvalidate({ id: 3, entity: 'user', }); ``` -------------------------------- ### Create a User Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/actions/users.mdx Call the `createUser` action with the necessary user details. Required fields include `username`, `email`, and `password`. ```typescript const { data, error } = await Astro.callAction(actions.createUser, { username: 'editor-jane', email: 'jane@example.com', password: 'strong-password', name: 'Jane Editor', roles: ['editor'], }); ``` -------------------------------- ### Static Client with Request-Aware Auth Headers Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/actions/index.mdx Configure a static WordPress client with custom authentication headers generated dynamically. The `createSignedAuthHeader` function must be implemented by the user. ```typescript import { WordPressClient } from 'fluent-wp-client'; const wp = new WordPressClient({ baseUrl: import.meta.env.WP_URL, authHeaders: ({ method, url, body }) => { // Replace with your signer implementation const signature = createSignedAuthHeader({ method, url: url.toString(), body }); return { Authorization: signature, }; }, }); ``` -------------------------------- ### Execute Term Helpers Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/actions/terms.mdx Utilize raw execute helpers for direct term manipulation, useful in testing or custom integrations. This example demonstrates creating, updating, and deleting a tag using these helpers. ```typescript import { executeCreateTerm, executeUpdateTerm, executeDeleteTerm, } from 'wp-astrojs-integration'; import { WordPressClient } from 'fluent-wp-client'; const wp = new WordPressClient({ baseUrl: 'https://example.com', auth: { username: 'admin', password: 'app-password' }, }); const created = await executeCreateTerm(wp, { name: 'Release Notes' }, { resource: 'tags' }); await executeUpdateTerm(wp, { id: created.id, slug: 'release-notes' }, { resource: 'tags' }); await executeDeleteTerm(wp, { id: created.id, force: true }, { resource: 'tags' }); ``` -------------------------------- ### Verify Published npm Package Contents Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/AGENTS.md Use this command to preview the contents of the npm package before publishing. This helps ensure the correct files are included in the distribution. ```bash npm pack --dry-run ``` -------------------------------- ### Run Integration and Build Tests Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/testing.mdx Execute integration tests, static build validation, or run all tests. The `npm test` command covers both integration and build projects. ```bash npm run test:integration npm run test:build # or run both projects npm test ``` -------------------------------- ### Define Typed Collections with WordPress Loaders Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/typesafe-integration.mdx Use generated `*ItemSchema` for collection entry validation. This example shows how to define static and live collections for posts, pages, and custom resources like books, integrating WordPress data loaders. ```typescript import { defineCollection, defineLiveCollection } from 'astro:content'; import { wordPressPostStaticLoader, wordPressPageLoader, wordPressContentLoader, } from 'wp-astrojs-integration'; import { wp } from './lib/wp'; import { postsItemSchema, pagesItemSchema, booksItemSchema, } from './generated/wp-schemas'; export const collections = { posts: defineCollection({ loader: wordPressPostStaticLoader(wp), schema: postsItemSchema, }), pages: defineLiveCollection({ loader: wordPressPageLoader(wp), schema: pagesItemSchema, }), books: defineLiveCollection({ loader: wordPressContentLoader(wp, { resource: 'books' }), schema: booksItemSchema, }), }; ``` -------------------------------- ### Fetch Single Post by Slug Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/reading-content.mdx Use `getLiveEntry` with a slug parameter to fetch a single post for a detail page. Includes a redirect to a 404 page if the post is not found. ```astro --- // src/pages/blog/[slug].astro import { getLiveEntry } from 'astro:content'; import WPContent from 'wp-astrojs-integration/components/WPContent.astro'; const { slug } = Astro.params; const { entry: post } = await getLiveEntry('posts', { slug }); if (!post) { return Astro.redirect('/404'); } ---Body.
', status: 'publish', meta: { reading_time: 5, source_url: 'https://example.com/original', }, }); ``` -------------------------------- ### Display Product Catalog Grouped by Category Source: https://github.com/juvojustin/astrojs-wp-integration/blob/main/docs/reading-content.mdx Fetches products and custom product categories from content collections to create a shop layout. Products are filtered and displayed under their respective categories. Assumes 'products' and 'product-categories' collections exist and products have a 'product_categories' field. ```astro ---// src/pages/shop/index.astro import { getLiveCollection } from 'astro:content'; const { entries: products } = await getLiveCollection('products', { orderby: 'title', order: 'asc' }); // Group by category if using custom taxonomies const { entries: categories } = await getLiveCollection('product-categories'); ---