@riverbankcms/sdk 0.1.0

package/dist/server/loadContent-CJcbYF3J.d.ts

@@ -0,0 +1,152 @@
+import { Theme } from '@riverbankcms/blocks';
+import { R as RiverbankClient } from './types-C6gmRHLe.js';
+import { b as PageProps } from './loadPage-BYmVMk0V.js';
+import { ResolvedBlockData } from '@riverbankcms/blocks/system/data';
+
+/**
+ * Server-side helper to fetch content (page or entry) by path.
+ *
+ * Use this for dynamic routing where a path could resolve to either
+ * a page or a content entry.
+ */
+
+type LoadContentParams = {
+    client: RiverbankClient;
+    siteId: string;
+    path: string;
+    /**
+     * If true, fetches draft/unpublished content instead of published content.
+     * This affects both pages and entries.
+     * Requires API key with site access.
+     *
+     * @default false
+     */
+    preview?: boolean;
+};
+/**
+ * Content entry data returned when a path resolves to an entry
+ */
+type ContentEntryData = {
+    id: string;
+    /** Content type key (e.g., 'blog-post', 'product') */
+    type: string | null;
+    title: string;
+    slug: string | null;
+    path: string | null;
+    status: string;
+    publishAt: string | null;
+    /** The raw content fields - use these to render your own UI */
+    content: Record<string, unknown>;
+    metaTitle: string | null;
+    metaDescription: string | null;
+    createdAt: string;
+    updatedAt: string;
+};
+/**
+ * Result when path resolves to a page
+ */
+type PageContentResult = {
+    type: 'page';
+    /** Page outline ready for rendering with <Page> component */
+    page: PageProps['page'];
+    /** Site theme for styling */
+    theme: Theme;
+    /** Site ID */
+    siteId: string;
+    /** Pre-fetched block data for data loaders */
+    resolvedData: ResolvedBlockData;
+};
+/**
+ * Result when path resolves to a content entry
+ */
+type EntryContentResult = {
+    type: 'entry';
+    /** Raw entry data - render this however you want */
+    entry: ContentEntryData;
+    /** Template page for rendering the entry (if available) */
+    templatePage: PageProps['page'] | null;
+    /** Pre-fetched block data for template page data loaders */
+    resolvedData: ResolvedBlockData;
+    /** Data context for template blocks (includes entry content for bindings) */
+    dataContext: {
+        contentEntry: Record<string, unknown>;
+    };
+    /** Site theme for styling (useful if rendering with SDK components) */
+    theme: Theme;
+    /** Site ID */
+    siteId: string;
+};
+/**
+ * Discriminated union result from loadContent
+ */
+type LoadContentResult = PageContentResult | EntryContentResult;
+/**
+ * Type guard to check if result is a page
+ */
+declare function isPageContent(result: LoadContentResult): result is PageContentResult;
+/**
+ * Type guard to check if result is an entry
+ */
+declare function isEntryContent(result: LoadContentResult): result is EntryContentResult;
+/**
+ * Server-side helper to fetch content by path.
+ *
+ * Returns a discriminated union - either page data (ready for `<Page>` component)
+ * or raw entry data (for custom rendering).
+ *
+ * @example Dynamic routing with both pages and entries
+ * ```tsx
+ * import { loadContent, Page, isPageContent } from '@riverbankcms/sdk';
+ *
+ * export default async function DynamicRoute({ params }) {
+ *   const content = await loadContent({
+ *     client,
+ *     siteId: 'site-123',
+ *     path: `/${params.slug?.join('/') || ''}`,
+ *   });
+ *
+ *   if (isPageContent(content)) {
+ *     return <Page {...content} />;
+ *   }
+ *
+ *   // Render entry with custom UI
+ *   return (
+ *     <article>
+ *       <h1>{content.entry.title}</h1>
+ *       <div>{content.entry.content.body}</div>
+ *     </article>
+ *   );
+ * }
+ * ```
+ *
+ * @example Entry-specific rendering based on content type
+ * ```tsx
+ * const content = await loadContent({ client, siteId, path });
+ *
+ * if (content.type === 'entry') {
+ *   switch (content.entry.type) {
+ *     case 'blog-post':
+ *       return <BlogPost entry={content.entry} theme={content.theme} />;
+ *     case 'product':
+ *       return <ProductPage entry={content.entry} theme={content.theme} />;
+ *     default:
+ *       return <GenericEntry entry={content.entry} />;
+ *   }
+ * }
+ *
+ * return <Page {...content} />;
+ * ```
+ *
+ * @example Preview mode for draft content
+ * ```tsx
+ * const content = await loadContent({
+ *   client,
+ *   siteId,
+ *   path,
+ *   preview: true, // Fetches draft content for both pages and entries
+ * });
+ * ```
+ */
+declare function loadContent(params: LoadContentParams): Promise<LoadContentResult>;
+
+export { type ContentEntryData as C, type EntryContentResult as E, type LoadContentParams as L, type PageContentResult as P, isEntryContent as a, type LoadContentResult as b, isPageContent as i, loadContent as l };

package/dist/server/loadContent-zhlL4YSE.d.mts

@@ -0,0 +1,152 @@
+import { Theme } from '@riverbankcms/blocks';
+import { R as RiverbankClient } from './types-C6gmRHLe.mjs';
+import { b as PageProps } from './loadPage-CCf15nt8.mjs';
+import { ResolvedBlockData } from '@riverbankcms/blocks/system/data';
+
+/**
+ * Server-side helper to fetch content (page or entry) by path.
+ *
+ * Use this for dynamic routing where a path could resolve to either
+ * a page or a content entry.
+ */
+
+type LoadContentParams = {
+    client: RiverbankClient;
+    siteId: string;
+    path: string;
+    /**
+     * If true, fetches draft/unpublished content instead of published content.
+     * This affects both pages and entries.
+     * Requires API key with site access.
+     *
+     * @default false
+     */
+    preview?: boolean;
+};
+/**
+ * Content entry data returned when a path resolves to an entry
+ */
+type ContentEntryData = {
+    id: string;
+    /** Content type key (e.g., 'blog-post', 'product') */
+    type: string | null;
+    title: string;
+    slug: string | null;
+    path: string | null;
+    status: string;
+    publishAt: string | null;
+    /** The raw content fields - use these to render your own UI */
+    content: Record<string, unknown>;
+    metaTitle: string | null;
+    metaDescription: string | null;
+    createdAt: string;
+    updatedAt: string;
+};
+/**
+ * Result when path resolves to a page
+ */
+type PageContentResult = {
+    type: 'page';
+    /** Page outline ready for rendering with <Page> component */
+    page: PageProps['page'];
+    /** Site theme for styling */
+    theme: Theme;
+    /** Site ID */
+    siteId: string;
+    /** Pre-fetched block data for data loaders */
+    resolvedData: ResolvedBlockData;
+};
+/**
+ * Result when path resolves to a content entry
+ */
+type EntryContentResult = {
+    type: 'entry';
+    /** Raw entry data - render this however you want */
+    entry: ContentEntryData;
+    /** Template page for rendering the entry (if available) */
+    templatePage: PageProps['page'] | null;
+    /** Pre-fetched block data for template page data loaders */
+    resolvedData: ResolvedBlockData;
+    /** Data context for template blocks (includes entry content for bindings) */
+    dataContext: {
+        contentEntry: Record<string, unknown>;
+    };
+    /** Site theme for styling (useful if rendering with SDK components) */
+    theme: Theme;
+    /** Site ID */
+    siteId: string;
+};
+/**
+ * Discriminated union result from loadContent
+ */
+type LoadContentResult = PageContentResult | EntryContentResult;
+/**
+ * Type guard to check if result is a page
+ */
+declare function isPageContent(result: LoadContentResult): result is PageContentResult;
+/**
+ * Type guard to check if result is an entry
+ */
+declare function isEntryContent(result: LoadContentResult): result is EntryContentResult;
+/**
+ * Server-side helper to fetch content by path.
+ *
+ * Returns a discriminated union - either page data (ready for `<Page>` component)
+ * or raw entry data (for custom rendering).
+ *
+ * @example Dynamic routing with both pages and entries
+ * ```tsx
+ * import { loadContent, Page, isPageContent } from '@riverbankcms/sdk';
+ *
+ * export default async function DynamicRoute({ params }) {
+ *   const content = await loadContent({
+ *     client,
+ *     siteId: 'site-123',
+ *     path: `/${params.slug?.join('/') || ''}`,
+ *   });
+ *
+ *   if (isPageContent(content)) {
+ *     return <Page {...content} />;
+ *   }
+ *
+ *   // Render entry with custom UI
+ *   return (
+ *     <article>
+ *       <h1>{content.entry.title}</h1>
+ *       <div>{content.entry.content.body}</div>
+ *     </article>
+ *   );
+ * }
+ * ```
+ *
+ * @example Entry-specific rendering based on content type
+ * ```tsx
+ * const content = await loadContent({ client, siteId, path });
+ *
+ * if (content.type === 'entry') {
+ *   switch (content.entry.type) {
+ *     case 'blog-post':
+ *       return <BlogPost entry={content.entry} theme={content.theme} />;
+ *     case 'product':
+ *       return <ProductPage entry={content.entry} theme={content.theme} />;
+ *     default:
+ *       return <GenericEntry entry={content.entry} />;
+ *   }
+ * }
+ *
+ * return <Page {...content} />;
+ * ```
+ *
+ * @example Preview mode for draft content
+ * ```tsx
+ * const content = await loadContent({
+ *   client,
+ *   siteId,
+ *   path,
+ *   preview: true, // Fetches draft content for both pages and entries
+ * });
+ * ```
+ */
+declare function loadContent(params: LoadContentParams): Promise<LoadContentResult>;
+
+export { type ContentEntryData as C, type EntryContentResult as E, type LoadContentParams as L, type PageContentResult as P, isEntryContent as a, type LoadContentResult as b, isPageContent as i, loadContent as l };

package/dist/server/loadPage-BYmVMk0V.d.ts

@@ -0,0 +1,216 @@
+import { R as RiverbankClient, S as SiteResponse } from './types-C6gmRHLe.js';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { PageOutline, Theme, ThemeTokens, RouteMap, OccurrenceContextData, PageRenderer, BlockOverrides } from '@riverbankcms/blocks';
+import { ResolvedBlockData } from '@riverbankcms/blocks/system/data';
+import { D as DataLoaderOverrides } from './types-Bbo01M7P.js';
+
+type PageProps = {
+    page: PageOutline;
+    theme: Theme;
+    siteId: string;
+    themeTokens?: ThemeTokens;
+    resolvedData?: ResolvedBlockData;
+    routeMap?: RouteMap;
+    /**
+     * SDK site configuration containing theme palette overrides.
+     * When provided, the SDK palette tokens are merged into the theme tokens,
+     * allowing blocks to use SDK-defined color tokens for section backgrounds.
+     */
+    sdkConfig?: RuntimeSdkConfig | null;
+    /**
+     * Additional context data for content entry pages.
+     * Used to pass occurrence context and content entry data to blocks.
+     */
+    dataContext?: {
+        /** Occurrence context for event pages (from URL like /events/yoga/2025-01-15) */
+        occurrenceContext?: OccurrenceContextData | null;
+        /** Content entry data for template pages */
+        contentEntry?: Record<string, unknown> | null;
+    };
+    wrapBlock?: (blockId: string, rendered: React.ReactNode) => React.ReactNode;
+    registry?: Parameters<typeof PageRenderer>[0]['registry'];
+    usePlaceholders?: boolean;
+    /**
+     * Custom components to override default block rendering.
+     * Keys can be full block kind ("block.hero") or short form ("hero").
+     *
+     * This is SSR-safe - no context or hooks required.
+     *
+     * @example
+     * ```tsx
+     * <Page
+     *   {...pageData}
+     *   blockOverrides={{
+     *     'hero': MyCustomHero,
+     *     'block.testimonials': MyCustomTestimonials,
+     *   }}
+     * />
+     * ```
+     */
+    blockOverrides?: BlockOverrides;
+};
+/**
+ * Pure renderer for Riverbank CMS pages.
+ *
+ * This component expects all data to be provided via props.
+ * For data fetching, use:
+ * - Server-side: `await loadPage({ client, siteId, path })`
+ * - Client-side: `usePage({ client, siteId, path })`
+ *
+ * @example Server-side (Next.js App Router)
+ * ```tsx
+ * import { createRiverbankClient } from '@riverbankcms/sdk';
+ * import { loadPage, Page } from '@riverbankcms/sdk/rendering';
+ *
+ * const client = createRiverbankClient({ apiKey, baseUrl });
+ *
+ * export default async function PageRoute({ params }) {
+ *   const pageData = await loadPage({
+ *     client,
+ *     siteId: 'site-id',
+ *     path: `/${params.slug}`,
+ *   });
+ *
+ *   return <Page {...pageData} />;
+ * }
+ * ```
+ *
+ * @example Client-side
+ * ```tsx
+ * import { createRiverbankClient } from '@riverbankcms/sdk';
+ * import { usePage, Page } from '@riverbankcms/sdk/rendering';
+ *
+ * const client = createRiverbankClient({ apiKey, baseUrl });
+ *
+ * function MyPage({ path }) {
+ *   const pageData = usePage({ client, siteId: 'site-id', path });
+ *
+ *   if (pageData.loading) return <LoadingState />;
+ *   if (pageData.error) return <ErrorState error={pageData.error} />;
+ *   if (!pageData.page) return <NotFound />;
+ *
+ *   return <Page {...pageData} />;
+ * }
+ * ```
+ */
+declare function Page({ page, theme, themeTokens: providedTokens, siteId, resolvedData, routeMap, wrapBlock, registry, usePlaceholders, blockOverrides, sdkConfig, dataContext, }: PageProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Server-side helper to fetch all data needed for <Page> component.
+ *
+ * Use this in server components, getServerSideProps, or API routes.
+ */
+
+/**
+ * SDK config from API response (without siteId which is stripped at storage).
+ * This is the runtime representation - for defining configs, use RiverbankSiteConfig.
+ */
+type RuntimeSdkConfig = NonNullable<SiteResponse['sdkConfig']>;
+type LoadPageParams = {
+    client: RiverbankClient;
+    siteId: string;
+    path: string;
+    pageId?: string;
+    /**
+     * If true, fetches draft/unpublished content instead of published content.
+     * This affects both the page structure and block data loaders.
+     * Requires API key with site access.
+     *
+     * @default false
+     */
+    preview?: boolean;
+    /**
+     * Code-based data loaders for custom blocks.
+     *
+     * Use this to fetch data from external APIs (not just whitelisted CMS endpoints).
+     * Keys are block kinds (e.g., 'custom.featured-products').
+     *
+     * Config-based loaders (defined in riverbank.config.ts) run first.
+     * Code loaders run second and take precedence on key conflicts.
+     *
+     * @example
+     * ```typescript
+     * const pageData = await loadPage({
+     *   client,
+     *   siteId: 'site-123',
+     *   path: '/',
+     *   dataLoaderOverrides: {
+     *     'custom.featured-products': {
+     *       products: async (ctx) => {
+     *         const res = await fetch(`https://api.shop.com/products?category=${ctx.content.categoryId}`);
+     *         return res.json();
+     *       },
+     *     },
+     *   },
+     * });
+     * ```
+     */
+    dataLoaderOverrides?: DataLoaderOverrides;
+};
+type LoadPageResult = Omit<PageProps, 'registry' | 'wrapBlock' | 'usePlaceholders' | 'blockOverrides'> & {
+    /**
+     * SDK site configuration, if available.
+     * Contains SDK-defined theme palette, section backgrounds, and style options.
+     */
+    sdkConfig: RuntimeSdkConfig | null;
+};
+/**
+ * Server-side helper to fetch all data needed for <Page> component.
+ *
+ * Fetches site data, page data, and prefetches block data loaders in parallel.
+ *
+ * @example Next.js App Router (published content)
+ * ```tsx
+ * import { createRiverbankClient } from '@riverbankcms/sdk';
+ * import { loadPage, Page } from '@riverbankcms/sdk/rendering';
+ *
+ * const client = createRiverbankClient({
+ *   apiKey: process.env.RIVERBANK_API_KEY!,
+ *   baseUrl: process.env.NEXT_PUBLIC_DASHBOARD_URL + '/api',
+ * });
+ *
+ * export default async function PageRoute({ params }) {
+ *   const pageData = await loadPage({
+ *     client,
+ *     siteId: 'site-123',
+ *     path: `/${params.slug || ''}`,
+ *   });
+ *
+ *   return <Page {...pageData} />;
+ * }
+ * ```
+ *
+ * @example Next.js App Router (preview/draft content)
+ * ```tsx
+ * export default async function PreviewRoute({ params, searchParams }) {
+ *   const pageData = await loadPage({
+ *     client,
+ *     siteId: searchParams.siteId,
+ *     path: `/${params.slug || ''}`,
+ *     preview: true, // Fetch draft content
+ *   });
+ *
+ *   return <Page {...pageData} />;
+ * }
+ * ```
+ *
+ * @example Next.js Pages Router (getServerSideProps)
+ * ```tsx
+ * export async function getServerSideProps({ params }) {
+ *   const pageData = await loadPage({
+ *     client,
+ *     siteId: 'site-123',
+ *     path: `/${params.slug || ''}`,
+ *   });
+ *
+ *   return { props: pageData };
+ * }
+ *
+ * export default function PageRoute(props) {
+ *   return <Page {...props} />;
+ * }
+ * ```
+ */
+declare function loadPage(params: LoadPageParams): Promise<LoadPageResult>;
+
+export { type LoadPageParams as L, Page as P, type RuntimeSdkConfig as R, type LoadPageResult as a, type PageProps as b, loadPage as l };