@riverbankcms/sdk 0.7.2 → 0.7.3

package/dist/server/index.d.mts

@@ -1,6 +1,7 @@
-export { c as createRiverbankClient } from './index-Bkva0WAj.mjs';
-export { E as EntriesResponse, c as EntriesResponseWithMeta, b as EntryResponse, P as PageResponse, d as PaginationMeta, R as RiverbankClient, a as RiverbankClientConfig, S as SiteResponse } from './types-MF2AWoKv.mjs';
-import { A as APIEndpoints, b as APICallParams } from './types-Dsu9wsUh.mjs';
+export { c as createRiverbankClient } from './index-Clm3skz_.mjs';
+import { R as RiverbankClient, S as SiteResponse, P as PageResponse, G as GetEntriesBaseParams, E as EntriesResponse, d as EntriesResponseWithMeta } from './types-C-LShyIg.mjs';
+export { j as CircuitBreakerConfig, C as CircuitState, b as EntryResponse, e as PaginationMeta, f as ResilienceConfig, h as ResilienceSource, g as ResilienceStatus, i as RetryConfig, a as RiverbankClientConfig } from './types-C-LShyIg.mjs';
+import { A as APIEndpoints, b as APICallParams, a as NavigationItemRecord } from './types-BSV6Vc-P.mjs';
 import './schema-Z6-afHJG.mjs';
 export { g as ContainerAlignment, f as ContainerMaxWidth, d as ContainerOptionsConfig, R as RiverbankSiteConfig, b as SectionBackground, c as SectionOptionsConfig, e as SectionSpacing, S as SiteStyleConfig } from './types-BjgZt8xJ.mjs';
 export { B as BlockKind, C as CustomBlockKind, S as SYSTEM_BLOCK_KINDS, a as SystemBlockKind } from './blockKinds-B6MWzNWp.mjs';
@@ -1644,4 +1645,214 @@ declare const API_ENDPOINTS: {
 };
 declare function buildEndpointURL(baseURL: string, endpoint: keyof APIEndpoints): string;
 
-export { API_ENDPOINTS, type ApiClient, buildEndpointURL };
+/**
+ * Types for prebuild cache functionality
+ *
+ * The prebuild cache generates static JSON files at build time that serve
+ * as a last-resort fallback when the CMS is unavailable.
+ */
+
+/**
+ * Content types that can be included in the prebuild cache.
+ */
+type PrebuildContentType = 'site' | 'pages' | 'entries' | 'navigation';
+/**
+ * Progress callback data for prebuild operations.
+ */
+interface PrebuildProgress {
+    /** Current item number (1-indexed) */
+    current: number;
+    /** Total items to process */
+    total: number;
+    /** Description of current item being processed */
+    item: string;
+    /** Content type being processed */
+    contentType: PrebuildContentType;
+}
+/**
+ * Options for the prebuildCache function.
+ */
+interface PrebuildOptions {
+    /** Configured Riverbank client */
+    client: RiverbankClient;
+    /** Site ID to prebuild */
+    siteId: string;
+    /** Output directory for prebuild cache (e.g., '.riverbank-cache') */
+    outputDir: string;
+    /** Content types to include (default: all) */
+    include?: PrebuildContentType[];
+    /** Filter entries to specific content types (default: all configured) */
+    contentTypes?: string[];
+    /** Gzip compress output files (default: false) */
+    compress?: boolean;
+    /** Progress callback fired during generation */
+    onProgress?: (progress: PrebuildProgress) => void;
+}
+/**
+ * Result from prebuildCache function.
+ */
+interface PrebuildResult {
+    /** Whether prebuild completed successfully */
+    success: boolean;
+    /** Output directory path */
+    outputDir: string;
+    /** List of generated files (relative to outputDir) */
+    files: string[];
+    /** Total size of all files in bytes */
+    totalSize: number;
+    /** ISO timestamp when prebuild was generated */
+    generatedAt: string;
+    /** SHA256 checksum of manifest for validation */
+    checksum: string;
+    /** Any errors encountered (partial success possible) */
+    errors?: string[];
+}
+/**
+ * Manifest file structure for prebuild cache.
+ */
+interface PrebuildManifest {
+    /** Manifest version for compatibility checking */
+    version: string;
+    /** ISO timestamp when prebuild was generated */
+    generatedAt: string;
+    /** SHA256 checksum of manifest contents (excluding checksum field) */
+    checksum: string;
+    /** Site ID this prebuild is for */
+    siteId: string;
+    /** SDK version used to generate prebuild */
+    sdkVersion: string;
+    /** Mapping of cache keys to file paths */
+    keyToFile: Record<string, string>;
+    /** Content types included in this prebuild */
+    includedTypes: PrebuildContentType[];
+    /** Total number of files generated */
+    fileCount: number;
+    /** Total size in bytes */
+    totalSize: number;
+}
+/**
+ * Navigation cache file structure.
+ */
+interface NavigationCacheFile {
+    /** Navigation menu data */
+    menus: Array<{
+        /** Menu identifier (used as lookup key) */
+        identifier: string | null;
+        /** Menu ID (fallback if no identifier) */
+        id: string;
+        /** Menu display name */
+        name: string;
+        /** Navigation items in this menu */
+        items: NavigationItemRecord[];
+    }>;
+    /** When this was generated */
+    generatedAt: string;
+}
+
+/**
+ * Prebuild cache generation
+ *
+ * Exports static content at build time for use as a last-resort fallback
+ * when the CMS is unavailable.
+ */
+
+/**
+ * Generate a prebuild cache for the specified site.
+ *
+ * The prebuild cache contains static JSON files that can serve as a
+ * last-resort fallback when the CMS is unavailable.
+ *
+ * @param options - Prebuild configuration
+ * @returns Result with generated files and metadata
+ *
+ * @example
+ * ```typescript
+ * import { createRiverbankClient, prebuildCache } from '@riverbankcms/sdk';
+ *
+ * const client = createRiverbankClient({ apiKey, baseUrl });
+ *
+ * const result = await prebuildCache({
+ *   client,
+ *   siteId: 'your-site-id',
+ *   outputDir: '.riverbank-cache',
+ *   onProgress: (p) => console.log(`${p.current}/${p.total}: ${p.item}`),
+ * });
+ *
+ * console.log(`Generated ${result.files.length} files (${result.totalSize} bytes)`);
+ * ```
+ */
+declare function prebuildCache(options: PrebuildOptions): Promise<PrebuildResult>;
+
+/**
+ * Prebuild cache loader
+ *
+ * Loads content from the prebuild cache at runtime as a last-resort fallback.
+ */
+
+interface PrebuildLoaderConfig {
+    /** Path to prebuild cache directory */
+    prebuildDir: string;
+    /** Maximum age in seconds for prebuild cache */
+    maxPrebuildAgeSec?: number;
+}
+interface LoadResult<T> {
+    /** Loaded data */
+    data: T;
+    /** Age of prebuild in seconds */
+    prebuildAgeSec: number;
+}
+/**
+ * Check if we're running in a Node.js environment with filesystem access.
+ * Edge runtimes (Vercel Edge, Cloudflare Workers) don't have fs access.
+ */
+declare function canUsePrebuild(): boolean;
+/**
+ * Loader for reading data from the prebuild cache.
+ *
+ * Used as a last-resort fallback when the CMS is unavailable and
+ * there's no cached data.
+ */
+declare class PrebuildLoader {
+    private readonly prebuildDir;
+    private readonly maxPrebuildAgeSec;
+    constructor(config: PrebuildLoaderConfig);
+    /**
+     * Check if prebuild is available and not expired.
+     */
+    isAvailable(): boolean;
+    /**
+     * Load site data from prebuild cache.
+     */
+    loadSite(siteId: string): LoadResult<SiteResponse> | null;
+    /**
+     * Load page data from prebuild cache.
+     */
+    loadPage(siteId: string, pagePath: string): LoadResult<PageResponse> | null;
+    /**
+     * Load entries from prebuild cache with runtime filtering.
+     *
+     * The prebuild stores ALL entries for each content type.
+     * Filtering, ordering, and pagination are applied at runtime.
+     */
+    loadEntries(siteId: string, params: GetEntriesBaseParams & {
+        includeMeta?: boolean;
+    }): LoadResult<EntriesResponse | EntriesResponseWithMeta> | null;
+    /**
+     * Load navigation data from prebuild cache.
+     */
+    loadNavigation(): LoadResult<NavigationCacheFile['menus']> | null;
+    /**
+     * Get the manifest for inspection.
+     */
+    getManifest(): PrebuildManifest | null;
+    /**
+     * Clear the cached manifest (for testing).
+     */
+    clearCache(): void;
+}
+/**
+ * Create a prebuild loader instance.
+ */
+declare function createPrebuildLoader(config: PrebuildLoaderConfig): PrebuildLoader;
+
+export { API_ENDPOINTS, type ApiClient, EntriesResponse, EntriesResponseWithMeta, type LoadResult, PageResponse, type PrebuildContentType, PrebuildLoader, type PrebuildLoaderConfig, type PrebuildManifest, type PrebuildOptions, type PrebuildProgress, type PrebuildResult, RiverbankClient, SiteResponse, buildEndpointURL, canUsePrebuild, createPrebuildLoader, prebuildCache };

package/dist/server/index.d.ts

@@ -1,6 +1,7 @@
-export { c as createRiverbankClient } from './index-CSBWKA3r.js';
-export { E as EntriesResponse, c as EntriesResponseWithMeta, b as EntryResponse, P as PageResponse, d as PaginationMeta, R as RiverbankClient, a as RiverbankClientConfig, S as SiteResponse } from './types-DnkRh0UL.js';
-import { A as APIEndpoints, b as APICallParams } from './types-CVykEqXN.js';
+export { c as createRiverbankClient } from './index-DLvNddi-.js';
+import { R as RiverbankClient, S as SiteResponse, P as PageResponse, G as GetEntriesBaseParams, E as EntriesResponse, d as EntriesResponseWithMeta } from './types-BRQyLrQU.js';
+export { j as CircuitBreakerConfig, C as CircuitState, b as EntryResponse, e as PaginationMeta, f as ResilienceConfig, h as ResilienceSource, g as ResilienceStatus, i as RetryConfig, a as RiverbankClientConfig } from './types-BRQyLrQU.js';
+import { A as APIEndpoints, b as APICallParams, a as NavigationItemRecord } from './types-Dt98DeYa.js';
 import './schema-Z6-afHJG.js';
 export { g as ContainerAlignment, f as ContainerMaxWidth, d as ContainerOptionsConfig, R as RiverbankSiteConfig, b as SectionBackground, c as SectionOptionsConfig, e as SectionSpacing, S as SiteStyleConfig } from './types-DLBhEPSt.js';
 export { B as BlockKind, C as CustomBlockKind, S as SYSTEM_BLOCK_KINDS, a as SystemBlockKind } from './blockKinds-B6MWzNWp.js';
@@ -1644,4 +1645,214 @@ declare const API_ENDPOINTS: {
 };
 declare function buildEndpointURL(baseURL: string, endpoint: keyof APIEndpoints): string;
 
-export { API_ENDPOINTS, type ApiClient, buildEndpointURL };
+/**
+ * Types for prebuild cache functionality
+ *
+ * The prebuild cache generates static JSON files at build time that serve
+ * as a last-resort fallback when the CMS is unavailable.
+ */
+
+/**
+ * Content types that can be included in the prebuild cache.
+ */
+type PrebuildContentType = 'site' | 'pages' | 'entries' | 'navigation';
+/**
+ * Progress callback data for prebuild operations.
+ */
+interface PrebuildProgress {
+    /** Current item number (1-indexed) */
+    current: number;
+    /** Total items to process */
+    total: number;
+    /** Description of current item being processed */
+    item: string;
+    /** Content type being processed */
+    contentType: PrebuildContentType;
+}
+/**
+ * Options for the prebuildCache function.
+ */
+interface PrebuildOptions {
+    /** Configured Riverbank client */
+    client: RiverbankClient;
+    /** Site ID to prebuild */
+    siteId: string;
+    /** Output directory for prebuild cache (e.g., '.riverbank-cache') */
+    outputDir: string;
+    /** Content types to include (default: all) */
+    include?: PrebuildContentType[];
+    /** Filter entries to specific content types (default: all configured) */
+    contentTypes?: string[];
+    /** Gzip compress output files (default: false) */
+    compress?: boolean;
+    /** Progress callback fired during generation */
+    onProgress?: (progress: PrebuildProgress) => void;
+}
+/**
+ * Result from prebuildCache function.
+ */
+interface PrebuildResult {
+    /** Whether prebuild completed successfully */
+    success: boolean;
+    /** Output directory path */
+    outputDir: string;
+    /** List of generated files (relative to outputDir) */
+    files: string[];
+    /** Total size of all files in bytes */
+    totalSize: number;
+    /** ISO timestamp when prebuild was generated */
+    generatedAt: string;
+    /** SHA256 checksum of manifest for validation */
+    checksum: string;
+    /** Any errors encountered (partial success possible) */
+    errors?: string[];
+}
+/**
+ * Manifest file structure for prebuild cache.
+ */
+interface PrebuildManifest {
+    /** Manifest version for compatibility checking */
+    version: string;
+    /** ISO timestamp when prebuild was generated */
+    generatedAt: string;
+    /** SHA256 checksum of manifest contents (excluding checksum field) */
+    checksum: string;
+    /** Site ID this prebuild is for */
+    siteId: string;
+    /** SDK version used to generate prebuild */
+    sdkVersion: string;
+    /** Mapping of cache keys to file paths */
+    keyToFile: Record<string, string>;
+    /** Content types included in this prebuild */
+    includedTypes: PrebuildContentType[];
+    /** Total number of files generated */
+    fileCount: number;
+    /** Total size in bytes */
+    totalSize: number;
+}
+/**
+ * Navigation cache file structure.
+ */
+interface NavigationCacheFile {
+    /** Navigation menu data */
+    menus: Array<{
+        /** Menu identifier (used as lookup key) */
+        identifier: string | null;
+        /** Menu ID (fallback if no identifier) */
+        id: string;
+        /** Menu display name */
+        name: string;
+        /** Navigation items in this menu */
+        items: NavigationItemRecord[];
+    }>;
+    /** When this was generated */
+    generatedAt: string;
+}
+
+/**
+ * Prebuild cache generation
+ *
+ * Exports static content at build time for use as a last-resort fallback
+ * when the CMS is unavailable.
+ */
+
+/**
+ * Generate a prebuild cache for the specified site.
+ *
+ * The prebuild cache contains static JSON files that can serve as a
+ * last-resort fallback when the CMS is unavailable.
+ *
+ * @param options - Prebuild configuration
+ * @returns Result with generated files and metadata
+ *
+ * @example
+ * ```typescript
+ * import { createRiverbankClient, prebuildCache } from '@riverbankcms/sdk';
+ *
+ * const client = createRiverbankClient({ apiKey, baseUrl });
+ *
+ * const result = await prebuildCache({
+ *   client,
+ *   siteId: 'your-site-id',
+ *   outputDir: '.riverbank-cache',
+ *   onProgress: (p) => console.log(`${p.current}/${p.total}: ${p.item}`),
+ * });
+ *
+ * console.log(`Generated ${result.files.length} files (${result.totalSize} bytes)`);
+ * ```
+ */
+declare function prebuildCache(options: PrebuildOptions): Promise<PrebuildResult>;
+
+/**
+ * Prebuild cache loader
+ *
+ * Loads content from the prebuild cache at runtime as a last-resort fallback.
+ */
+
+interface PrebuildLoaderConfig {
+    /** Path to prebuild cache directory */
+    prebuildDir: string;
+    /** Maximum age in seconds for prebuild cache */
+    maxPrebuildAgeSec?: number;
+}
+interface LoadResult<T> {
+    /** Loaded data */
+    data: T;
+    /** Age of prebuild in seconds */
+    prebuildAgeSec: number;
+}
+/**
+ * Check if we're running in a Node.js environment with filesystem access.
+ * Edge runtimes (Vercel Edge, Cloudflare Workers) don't have fs access.
+ */
+declare function canUsePrebuild(): boolean;
+/**
+ * Loader for reading data from the prebuild cache.
+ *
+ * Used as a last-resort fallback when the CMS is unavailable and
+ * there's no cached data.
+ */
+declare class PrebuildLoader {
+    private readonly prebuildDir;
+    private readonly maxPrebuildAgeSec;
+    constructor(config: PrebuildLoaderConfig);
+    /**
+     * Check if prebuild is available and not expired.
+     */
+    isAvailable(): boolean;
+    /**
+     * Load site data from prebuild cache.
+     */
+    loadSite(siteId: string): LoadResult<SiteResponse> | null;
+    /**
+     * Load page data from prebuild cache.
+     */
+    loadPage(siteId: string, pagePath: string): LoadResult<PageResponse> | null;
+    /**
+     * Load entries from prebuild cache with runtime filtering.
+     *
+     * The prebuild stores ALL entries for each content type.
+     * Filtering, ordering, and pagination are applied at runtime.
+     */
+    loadEntries(siteId: string, params: GetEntriesBaseParams & {
+        includeMeta?: boolean;
+    }): LoadResult<EntriesResponse | EntriesResponseWithMeta> | null;
+    /**
+     * Load navigation data from prebuild cache.
+     */
+    loadNavigation(): LoadResult<NavigationCacheFile['menus']> | null;
+    /**
+     * Get the manifest for inspection.
+     */
+    getManifest(): PrebuildManifest | null;
+    /**
+     * Clear the cached manifest (for testing).
+     */
+    clearCache(): void;
+}
+/**
+ * Create a prebuild loader instance.
+ */
+declare function createPrebuildLoader(config: PrebuildLoaderConfig): PrebuildLoader;
+
+export { API_ENDPOINTS, type ApiClient, EntriesResponse, EntriesResponseWithMeta, type LoadResult, PageResponse, type PrebuildContentType, PrebuildLoader, type PrebuildLoaderConfig, type PrebuildManifest, type PrebuildOptions, type PrebuildProgress, type PrebuildResult, RiverbankClient, SiteResponse, buildEndpointURL, canUsePrebuild, createPrebuildLoader, prebuildCache };