@riverbankcms/sdk 0.2.1 → 0.3.0

package/dist/server/types-CLusapsM.d.mts

@@ -0,0 +1,150 @@
+import { A as APIEndpoints } from './types-nVerjjdv.mjs';
+
+type SiteResponse = NonNullable<APIEndpoints['getSite']['response']>;
+type PageResponse = NonNullable<APIEndpoints['getContentByPath']['response']>;
+type EntriesResponse = NonNullable<APIEndpoints['listPublishedEntries']['response']>;
+type EntryResponse = NonNullable<APIEndpoints['getPublishedEntryPreview']['response']>;
+type PublicFormResponse = NonNullable<APIEndpoints['getPublicFormById']['response']>;
+type PublicBookingServicesResponse = NonNullable<APIEndpoints['getPublicBookingServices']['response']>;
+type PublicEventsResponse = NonNullable<APIEndpoints['listPublicEvents']['response']>;
+/**
+ * Configuration for creating a Riverbank CMS client
+ */
+interface RiverbankClientConfig {
+    /**
+     * API key for authentication (format: bld_live_... or bld_test_...)
+     */
+    apiKey: string;
+    /**
+     * Base URL for the Riverbank CMS API (required; e.g. https://dashboard.example.com/api)
+     */
+    baseUrl: string;
+    /**
+     * Cache configuration
+     */
+    cache?: {
+        /**
+         * Enable caching (default: true)
+         */
+        enabled?: boolean;
+        /**
+         * Time-to-live for cached responses in seconds
+         * @default 300 (5 minutes)
+         */
+        ttl?: number;
+        /**
+         * Maximum number of cached responses
+         * @default 100
+         */
+        maxSize?: number;
+    };
+}
+/**
+ * Riverbank CMS client interface
+ */
+interface RiverbankClient {
+    /**
+     * Fetch site data by slug, domain, or ID
+     */
+    getSite(params: {
+        slug?: string;
+        domain?: string;
+        id?: string;
+    }): Promise<SiteResponse>;
+    /**
+     * Fetch a specific page by path
+     *
+     * @param params.preview - If true, returns draft content instead of published content (requires API key with site access)
+     */
+    getPage(params: {
+        siteId: string;
+        path: string;
+        preview?: boolean;
+    }): Promise<PageResponse>;
+    /**
+     * Fetch published content entries with optional pagination, sorting, and preview mode
+     *
+     * @param params.siteId - The site ID
+     * @param params.contentType - The content type key (e.g., 'blog-post', 'product')
+     * @param params.limit - Maximum number of entries to return
+     * @param params.order - Sort order: 'newest' (published_at desc) or 'oldest' (published_at asc)
+     * @param params.preview - If true, includes draft entries (requires API key with site access)
+     * @param params.mode - 'query' for automatic fetching, 'manual' for specific entry IDs
+     * @param params.entryIds - Array of entry IDs to fetch (only used when mode is 'manual')
+     *
+     * @example
+     * ```ts
+     * // Fetch latest 10 blog posts
+     * const entries = await client.getEntries({
+     *   siteId: 'site-id',
+     *   contentType: 'blog-post',
+     *   limit: 10,
+     *   order: 'newest',
+     * });
+     *
+     * // Fetch draft entries for preview
+     * const drafts = await client.getEntries({
+     *   siteId: 'site-id',
+     *   contentType: 'blog-post',
+     *   preview: true,
+     * });
+     *
+     * // Fetch specific entries by ID (manual mode)
+     * const specific = await client.getEntries({
+     *   siteId: 'site-id',
+     *   contentType: 'blog-post',
+     *   mode: 'manual',
+     *   entryIds: ['uuid-1', 'uuid-2'],
+     * });
+     * ```
+     */
+    getEntries(params: {
+        siteId: string;
+        contentType: string;
+        limit?: number;
+        /** Sort order for entries. 'order' uses custom ordering (default behavior). */
+        order?: 'newest' | 'oldest' | 'title' | 'order';
+        preview?: boolean;
+        /** Selection mode: 'query' for automatic, 'manual' for specific entry IDs */
+        mode?: 'query' | 'manual';
+        /** Entry IDs to fetch when mode is 'manual' */
+        entryIds?: string[];
+    }): Promise<EntriesResponse>;
+    /**
+     * Fetch a specific content entry by slug
+     */
+    getEntry(params: {
+        siteId: string;
+        contentType: string;
+        slug: string;
+    }): Promise<EntryResponse>;
+    /**
+     * Fetch a public form definition by ID
+     */
+    getPublicFormById(params: {
+        formId: string;
+    }): Promise<PublicFormResponse>;
+    /**
+     * Fetch public booking services for a site
+     */
+    getPublicBookingServices(params: {
+        siteId: string;
+        ids?: string;
+    }): Promise<PublicBookingServicesResponse>;
+    /**
+     * List public events for a site (optionally time-filtered)
+     */
+    listPublicEvents(params: {
+        siteId: string;
+        limit?: number;
+        from?: string;
+        to?: string;
+        stage?: string;
+    }): Promise<PublicEventsResponse>;
+    /**
+     * Force clear the cache
+     */
+    clearCache(): void;
+}
+
+export type { EntriesResponse as E, PageResponse as P, RiverbankClient as R, SiteResponse as S, RiverbankClientConfig as a, EntryResponse as b };

package/dist/server/{types-BprgZt-t.d.ts → types-Cc7lyPkN.d.ts}

@@ -3491,6 +3491,8 @@ type APIEndpoints = {
     importSiteBackup: APIEndpoint<FormData, {
         siteId: string;
     }, BackupImportResponse>;
+    previewBackup: APIEndpoint<FormData, never, BackupPreviewResponse>;
+    importBackupAsNewSite: APIEndpoint<FormData, never, ImportBackupAsNewSiteResponse>;
 };
 type APICallParams<E extends keyof APIEndpoints> = APIEndpoints[E] extends {
     method: 'GET';
@@ -3998,152 +4000,44 @@ type BackupImportResponse = {
     code?: string;
     details?: unknown;
 };
-
-type SiteResponse = NonNullable<APIEndpoints['getSite']['response']>;
-type PageResponse = NonNullable<APIEndpoints['getContentByPath']['response']>;
-type EntriesResponse = NonNullable<APIEndpoints['listPublishedEntries']['response']>;
-type EntryResponse = NonNullable<APIEndpoints['getPublishedEntryPreview']['response']>;
-type PublicFormResponse = NonNullable<APIEndpoints['getPublicFormById']['response']>;
-type PublicBookingServicesResponse = NonNullable<APIEndpoints['getPublicBookingServices']['response']>;
-type PublicEventsResponse = NonNullable<APIEndpoints['listPublicEvents']['response']>;
-/**
- * Configuration for creating a Riverbank CMS client
- */
-interface RiverbankClientConfig {
-    /**
-     * API key for authentication (format: bld_live_... or bld_test_...)
-     */
-    apiKey: string;
-    /**
-     * Base URL for the Riverbank CMS API (required; e.g. https://dashboard.example.com/api)
-     */
-    baseUrl: string;
-    /**
-     * Cache configuration
-     */
-    cache?: {
-        /**
-         * Enable caching (default: true)
-         */
-        enabled?: boolean;
-        /**
-         * Time-to-live for cached responses in seconds
-         * @default 300 (5 minutes)
-         */
-        ttl?: number;
-        /**
-         * Maximum number of cached responses
-         * @default 100
-         */
-        maxSize?: number;
-    };
-}
-/**
- * Riverbank CMS client interface
- */
-interface RiverbankClient {
-    /**
-     * Fetch site data by slug, domain, or ID
-     */
-    getSite(params: {
-        slug?: string;
-        domain?: string;
-        id?: string;
-    }): Promise<SiteResponse>;
-    /**
-     * Fetch a specific page by path
-     *
-     * @param params.preview - If true, returns draft content instead of published content (requires API key with site access)
-     */
-    getPage(params: {
-        siteId: string;
-        path: string;
-        preview?: boolean;
-    }): Promise<PageResponse>;
-    /**
-     * Fetch published content entries with optional pagination, sorting, and preview mode
-     *
-     * @param params.siteId - The site ID
-     * @param params.contentType - The content type key (e.g., 'blog-post', 'product')
-     * @param params.limit - Maximum number of entries to return
-     * @param params.order - Sort order: 'newest' (published_at desc) or 'oldest' (published_at asc)
-     * @param params.preview - If true, includes draft entries (requires API key with site access)
-     * @param params.mode - 'query' for automatic fetching, 'manual' for specific entry IDs
-     * @param params.entryIds - Array of entry IDs to fetch (only used when mode is 'manual')
-     *
-     * @example
-     * ```ts
-     * // Fetch latest 10 blog posts
-     * const entries = await client.getEntries({
-     *   siteId: 'site-id',
-     *   contentType: 'blog-post',
-     *   limit: 10,
-     *   order: 'newest',
-     * });
-     *
-     * // Fetch draft entries for preview
-     * const drafts = await client.getEntries({
-     *   siteId: 'site-id',
-     *   contentType: 'blog-post',
-     *   preview: true,
-     * });
-     *
-     * // Fetch specific entries by ID (manual mode)
-     * const specific = await client.getEntries({
-     *   siteId: 'site-id',
-     *   contentType: 'blog-post',
-     *   mode: 'manual',
-     *   entryIds: ['uuid-1', 'uuid-2'],
-     * });
-     * ```
-     */
-    getEntries(params: {
-        siteId: string;
-        contentType: string;
-        limit?: number;
-        /** Sort order for entries. 'order' uses custom ordering (default behavior). */
-        order?: 'newest' | 'oldest' | 'title' | 'order';
-        preview?: boolean;
-        /** Selection mode: 'query' for automatic, 'manual' for specific entry IDs */
-        mode?: 'query' | 'manual';
-        /** Entry IDs to fetch when mode is 'manual' */
-        entryIds?: string[];
-    }): Promise<EntriesResponse>;
-    /**
-     * Fetch a specific content entry by slug
-     */
-    getEntry(params: {
-        siteId: string;
-        contentType: string;
-        slug: string;
-    }): Promise<EntryResponse>;
-    /**
-     * Fetch a public form definition by ID
-     */
-    getPublicFormById(params: {
-        formId: string;
-    }): Promise<PublicFormResponse>;
-    /**
-     * Fetch public booking services for a site
-     */
-    getPublicBookingServices(params: {
-        siteId: string;
-        ids?: string;
-    }): Promise<PublicBookingServicesResponse>;
-    /**
-     * List public events for a site (optionally time-filtered)
-     */
-    listPublicEvents(params: {
+type BackupPreviewResponse = {
+    ok: boolean;
+    manifest?: {
         siteId: string;
-        limit?: number;
-        from?: string;
-        to?: string;
-        stage?: string;
-    }): Promise<PublicEventsResponse>;
-    /**
-     * Force clear the cache
-     */
-    clearCache(): void;
-}
+        siteSlug: string;
+        siteTitle: string;
+        exportedAt: string;
+        tableCount: number;
+        totalRecords: number;
+        pageCount: number;
+        blockCount: number;
+        contentEntryCount: number;
+        formCount: number;
+        navigationMenuCount: number;
+        mediaCount: number;
+        mediaBytes: number;
+    };
+    error?: string;
+    code?: string;
+};
+type ImportBackupAsNewSiteResponse = {
+    ok: boolean;
+    siteId?: string;
+    slug?: string;
+    title?: string;
+    counts?: Record<string, {
+        created: number;
+        updated: number;
+        failed: number;
+    }>;
+    warnings?: string[];
+    errors?: Array<{
+        table: string;
+        id: string;
+        error: string;
+    }>;
+    error?: string;
+    code?: string;
+};
 
-export type { APIEndpoints as A, CustomLinkValue as C, EntriesResponse as E, HydratedTheme as H, InternalLinkValue as I, LinkValue as L, PageResponse as P, RiverbankClient as R, SiteResponse as S, Theme as T, RiverbankClientConfig as a, EntryResponse as b, APICallParams as c, SiteHeaderContent as d, SiteFooterContent as e, ExternalLinkValue as f, ExpandedPalette as g };
+export type { APIEndpoints as A, CustomLinkValue as C, ExternalLinkValue as E, HydratedTheme as H, InternalLinkValue as I, LinkPayload as L, NavigationMenuWithItems as N, SiteHeaderContent as S, Theme as T, NavigationItemRecord as a, APICallParams as b, SiteFooterContent as c, LinkValue as d, ExpandedPalette as e };

package/dist/server/types-Ls6BkLKg.d.ts

@@ -0,0 +1,150 @@
+import { A as APIEndpoints } from './types-Cc7lyPkN.js';
+
+type SiteResponse = NonNullable<APIEndpoints['getSite']['response']>;
+type PageResponse = NonNullable<APIEndpoints['getContentByPath']['response']>;
+type EntriesResponse = NonNullable<APIEndpoints['listPublishedEntries']['response']>;
+type EntryResponse = NonNullable<APIEndpoints['getPublishedEntryPreview']['response']>;
+type PublicFormResponse = NonNullable<APIEndpoints['getPublicFormById']['response']>;
+type PublicBookingServicesResponse = NonNullable<APIEndpoints['getPublicBookingServices']['response']>;
+type PublicEventsResponse = NonNullable<APIEndpoints['listPublicEvents']['response']>;
+/**
+ * Configuration for creating a Riverbank CMS client
+ */
+interface RiverbankClientConfig {
+    /**
+     * API key for authentication (format: bld_live_... or bld_test_...)
+     */
+    apiKey: string;
+    /**
+     * Base URL for the Riverbank CMS API (required; e.g. https://dashboard.example.com/api)
+     */
+    baseUrl: string;
+    /**
+     * Cache configuration
+     */
+    cache?: {
+        /**
+         * Enable caching (default: true)
+         */
+        enabled?: boolean;
+        /**
+         * Time-to-live for cached responses in seconds
+         * @default 300 (5 minutes)
+         */
+        ttl?: number;
+        /**
+         * Maximum number of cached responses
+         * @default 100
+         */
+        maxSize?: number;
+    };
+}
+/**
+ * Riverbank CMS client interface
+ */
+interface RiverbankClient {
+    /**
+     * Fetch site data by slug, domain, or ID
+     */
+    getSite(params: {
+        slug?: string;
+        domain?: string;
+        id?: string;
+    }): Promise<SiteResponse>;
+    /**
+     * Fetch a specific page by path
+     *
+     * @param params.preview - If true, returns draft content instead of published content (requires API key with site access)
+     */
+    getPage(params: {
+        siteId: string;
+        path: string;
+        preview?: boolean;
+    }): Promise<PageResponse>;
+    /**
+     * Fetch published content entries with optional pagination, sorting, and preview mode
+     *
+     * @param params.siteId - The site ID
+     * @param params.contentType - The content type key (e.g., 'blog-post', 'product')
+     * @param params.limit - Maximum number of entries to return
+     * @param params.order - Sort order: 'newest' (published_at desc) or 'oldest' (published_at asc)
+     * @param params.preview - If true, includes draft entries (requires API key with site access)
+     * @param params.mode - 'query' for automatic fetching, 'manual' for specific entry IDs
+     * @param params.entryIds - Array of entry IDs to fetch (only used when mode is 'manual')
+     *
+     * @example
+     * ```ts
+     * // Fetch latest 10 blog posts
+     * const entries = await client.getEntries({
+     *   siteId: 'site-id',
+     *   contentType: 'blog-post',
+     *   limit: 10,
+     *   order: 'newest',
+     * });
+     *
+     * // Fetch draft entries for preview
+     * const drafts = await client.getEntries({
+     *   siteId: 'site-id',
+     *   contentType: 'blog-post',
+     *   preview: true,
+     * });
+     *
+     * // Fetch specific entries by ID (manual mode)
+     * const specific = await client.getEntries({
+     *   siteId: 'site-id',
+     *   contentType: 'blog-post',
+     *   mode: 'manual',
+     *   entryIds: ['uuid-1', 'uuid-2'],
+     * });
+     * ```
+     */
+    getEntries(params: {
+        siteId: string;
+        contentType: string;
+        limit?: number;
+        /** Sort order for entries. 'order' uses custom ordering (default behavior). */
+        order?: 'newest' | 'oldest' | 'title' | 'order';
+        preview?: boolean;
+        /** Selection mode: 'query' for automatic, 'manual' for specific entry IDs */
+        mode?: 'query' | 'manual';
+        /** Entry IDs to fetch when mode is 'manual' */
+        entryIds?: string[];
+    }): Promise<EntriesResponse>;
+    /**
+     * Fetch a specific content entry by slug
+     */
+    getEntry(params: {
+        siteId: string;
+        contentType: string;
+        slug: string;
+    }): Promise<EntryResponse>;
+    /**
+     * Fetch a public form definition by ID
+     */
+    getPublicFormById(params: {
+        formId: string;
+    }): Promise<PublicFormResponse>;
+    /**
+     * Fetch public booking services for a site
+     */
+    getPublicBookingServices(params: {
+        siteId: string;
+        ids?: string;
+    }): Promise<PublicBookingServicesResponse>;
+    /**
+     * List public events for a site (optionally time-filtered)
+     */
+    listPublicEvents(params: {
+        siteId: string;
+        limit?: number;
+        from?: string;
+        to?: string;
+        stage?: string;
+    }): Promise<PublicEventsResponse>;
+    /**
+     * Force clear the cache
+     */
+    clearCache(): void;
+}
+
+export type { EntriesResponse as E, PageResponse as P, RiverbankClient as R, SiteResponse as S, RiverbankClientConfig as a, EntryResponse as b };