@blinkk/root-cms 1.3.12 → 2.0.0-rc.1

package/dist/core.d.ts

@@ -1,11 +1,86 @@
-import { L as LoadTranslationsOptions, T as TranslationsMap, a as LocaleTranslations } from './client-98Le1XxF.js';
-export { A as Action, p as ArrayObject, c as DataSource, d as DataSourceData, e as DataSourceMode, D as Doc, b as DocMode, h as GetCountOptions, G as GetDocOptions, H as HttpMethod, j as ListActionsOptions, g as ListDocsOptions, R as Release, k as RootCMSClient, f as SaveDraftOptions, S as SetDocOptions, i as Translation, U as UserRole, m as getCmsPlugin, l as isRichTextData, q as marshalArray, n as marshalData, o as normalizeData, v as parseDocId, t as toArrayObject, s as translationsForLocale, r as unmarshalArray, u as unmarshalData } from './client-98Le1XxF.js';
-import { RootConfig } from '@blinkk/root';
+import { R as RootCMSClient, B as BatchRequest, L as LoadTranslationsOptions, T as TranslationsMap, a as LocaleTranslations } from './client-AKOLkEwt.js';
+export { A as Action, v as ArrayObject, n as BatchRequestOptions, o as BatchRequestQuery, p as BatchRequestQueryOptions, q as BatchResponse, d as DataSource, e as DataSourceData, f as DataSourceMode, D as Doc, c as DocMode, j as GetCountOptions, G as GetDocOptions, H as HttpMethod, m as ListActionsOptions, i as ListDocsOptions, l as Release, h as SaveDraftOptions, S as SetDocOptions, k as Translation, b as TranslationsDoc, U as UserRole, g as getCmsPlugin, r as isRichTextData, x as marshalArray, s as marshalData, t as normalizeData, C as parseDocId, w as toArrayObject, z as translationsForLocale, y as unmarshalArray, u as unmarshalData } from './client-AKOLkEwt.js';
+import { Request, Response, GetStaticPaths, GetStaticProps, RootConfig } from '@blinkk/root';
 import { Query } from 'firebase-admin/firestore';
 export { s as schema } from './schema-ix967Ud0.js';
 import 'firebase-admin/app';
 import 'preact';
 
+type CMSRequest = Request & {
+    cmsClient: RootCMSClient;
+};
+interface CMSRouteContext {
+    /** HTTP request object. Only available in SSR mode. */
+    req?: CMSRequest;
+    slug: string;
+    mode: 'draft' | 'published';
+    cmsClient: RootCMSClient;
+}
+interface CMSRouteOptions {
+    /**
+     * Collection mapped to the route.
+     */
+    collection: string;
+    /**
+     * Route param name used for the slug. Used for dynamic routes, e.g.
+     * `[...slug].tsx`. Defaults to "slug".
+     */
+    slugParam?: string;
+    /**
+     * Slug to use for the route. Used for non-dynamic, single-document routes.
+     */
+    slug?: string;
+    /**
+     * Hook that allows callers to modify the Root CMS `BatchRequest` object. If a
+     * new `BatchRequest` is returned, it will replace the default one created by
+     * `cmsRoute()`.
+     */
+    preRequestHook?: (batchRequest: BatchRequest, context: CMSRouteContext) => void | BatchRequest;
+    /**
+     * Callback function that returns a map of Promises that contain fetched data.
+     * Once the promise is resolved, the values are injected into page's props
+     * for rendering.
+     */
+    fetchData?: (context: CMSRouteContext) => Record<string, Promise<any>>;
+    /**
+     * Hook for amending any props values before being passed to the page
+     * component.
+     */
+    preRenderHook?: (props: any, context: CMSRouteContext) => any | Promise<any>;
+    /**
+     * Hook for setting any response headers.
+     */
+    setResponseHeaders?: (req: Request, res: Response) => void;
+    /**
+     * Sets Cache-Control header to `private`.
+     */
+    disableCacheControl?: boolean;
+    /**
+     * Enables SSG mode for sites that serve on SCS or other static servers.
+     */
+    enableSSG?: boolean;
+}
+interface CMSDoc {
+    id: string;
+    slug: string;
+    sys?: {
+        locales?: string[];
+    };
+}
+/**
+ * Utility for generating SSR and SSG handlers in a Root route file.
+ */
+declare function cmsRoute(options: CMSRouteOptions): {
+    getStaticPaths: GetStaticPaths | null;
+    getStaticProps: GetStaticProps | null;
+    handle: (req: CMSRequest, res: Response) => Promise<void>;
+};
+declare function resolvePromisesMap(promisesMap: Record<string, Promise<any>>): Promise<Record<string, any>>;
+/**
+ * Issues an HTTP redirect, preserving any query params from the original req.
+ */
+declare function redirectWithQuery(req: Request, res: Response, redirectCode: number, redirectPath: string): void;
+
 /** @deprecated Use client.ts instead. */
 
 /**
@@ -51,4 +126,4 @@ declare function loadTranslations(rootConfig: RootConfig, options?: LoadTranslat
  */
 declare function loadTranslationsForLocale(rootConfig: RootConfig, locale: string, options?: LoadTranslationsOptions): Promise<LocaleTranslations>;
 
-export { LoadTranslationsOptions, LocaleTranslations, TranslationsMap, getDoc, listDocs, loadTranslations, loadTranslationsForLocale, numDocs, publishScheduledDocs };
+export { BatchRequest, type CMSDoc, type CMSRequest, type CMSRouteContext, type CMSRouteOptions, LoadTranslationsOptions, LocaleTranslations, RootCMSClient, TranslationsMap, cmsRoute, getDoc, listDocs, loadTranslations, loadTranslationsForLocale, numDocs, publishScheduledDocs, redirectWithQuery, resolvePromisesMap };