@blinkk/root-cms 3.0.2 → 3.0.4

package/dist/client-1puwLgNx.d.ts

@@ -1,1552 +0,0 @@
-import { RootConfig, Plugin, Request } from '@blinkk/root';
-import { App } from 'firebase-admin/app';
-import { Firestore, WriteBatch, Timestamp, Query } from 'firebase-admin/firestore';
-import { C as Collection } from './schema-Db_xODoi.js';
-
-/**
- * Provider type for an AI model. Use `openai-compatible` for any OpenAI-style
- * endpoint (e.g. local Ollama, vLLM, OpenRouter).
- */
-type AiProvider = 'openai' | 'openai-compatible' | 'anthropic' | 'google';
-/**
- * Configuration for a single chat model.
- *
- * Inspired by Ollama's `Modelfile` and LiteLLM's model config: each entry maps
- * a CMS-facing id to a provider, model id and credentials.
- */
-interface AiModelConfig {
-    /** Stable id used by the CMS UI and stored alongside chat history. */
-    id: string;
-    /** Optional human-readable label rendered in the model picker. */
-    label?: string;
-    /** Optional description shown under the label. */
-    description?: string;
-    /** AI provider/family to route requests to. */
-    provider: AiProvider;
-    /**
-     * Provider-specific model id (e.g. `gpt-4o`, `claude-opus-4-5`,
-     * `gemini-2.5-pro`). Defaults to `id` if omitted.
-     */
-    modelId?: string;
-    /** API key for the provider. */
-    apiKey?: string;
-    /** Override the provider's base URL (required for `openai-compatible`). */
-    baseURL?: string;
-    /** Custom headers to send with each request. */
-    headers?: Record<string, string>;
-    /** Capabilities advertised to the UI. */
-    capabilities?: {
-        /** Whether the model can call tools. Defaults to `true`. */
-        tools?: boolean;
-        /** Whether the model can stream reasoning/thinking. Defaults to `false`. */
-        reasoning?: boolean;
-        /** Whether the model accepts image attachments. Defaults to `false`. */
-        attachments?: boolean;
-    };
-}
-/**
- * Full AI config registered on the cms plugin.
- */
-interface AiConfig {
-    /** Models exposed in the model picker. The first entry is the default. */
-    models: AiModelConfig[];
-    /** Id of the default model. Defaults to the first model in `models`. */
-    defaultModel?: string;
-    /**
-     * Image generation models. Used by the image generator and any other
-     * features that produce images. Only the `openai` and `google` providers
-     * support image generation.
-     */
-    imageModels?: AiModelConfig[];
-    /** Id of the default image model. Defaults to the first entry in `imageModels`. */
-    defaultImageModel?: string;
-    /**
-     * Optional system prompt prepended to every conversation. If a `ROOT.md`
-     * file exists at the project root, its contents are appended to this
-     * prompt automatically.
-     */
-    systemPrompt?: string;
-    /** Maximum tool-loop steps before stopping. Defaults to 10. */
-    maxSteps?: number;
-}
-
-/** The result status of a check. */
-type CheckStatus = 'success' | 'warning' | 'error';
-/** Result returned by a check function after execution. */
-interface CheckResult {
-    /** Whether the check succeeded, warned, or failed. */
-    status: CheckStatus;
-    /** A message describing the result. Supports markdown. */
-    message: string;
-    /** Optional metadata to include with the result. */
-    metadata?: Record<string, any>;
-}
-/** Context passed to a check function during execution. */
-interface CheckContext {
-    /** The Root.js config. */
-    rootConfig: RootConfig;
-    /** The Root CMS client for accessing the database. */
-    cmsClient: RootCMSClient;
-    /** The document ID, e.g. `Pages/index`. */
-    docId: string;
-    /** The collection ID, e.g. `Pages`. */
-    collectionId: string;
-    /** The slug, e.g. `index`. */
-    slug: string;
-    /** The collection schema. */
-    collectionSchema: Collection | null;
-}
-/** Configuration for defining a CMS check. */
-interface CMSCheck {
-    /** Unique ID for the check. */
-    id: string;
-    /** Human-readable label displayed in the UI. */
-    label: string;
-    /** Optional description explaining what the check does. */
-    description?: string;
-    /**
-     * Optional list of collection IDs to restrict this check to. When set, the
-     * check is only shown and runnable for documents belonging to one of the
-     * listed collections. When omitted, the check applies to all collections.
-     */
-    collections?: string[];
-    /**
-     * Function that runs the check on the server-side and returns a result.
-     */
-    run: (ctx: CheckContext) => Promise<CheckResult>;
-}
-
-/**
- * Base shape for a service registered with the CMS plugin.
- *
- * Services are extension points that let plugins provide capabilities
- * (e.g. email delivery, cache, translations) that root-cms can call into.
- * Every service shares the same identifying fields — `id`, `label`, optional
- * `icon` — and is registered via the `services` option on `cmsPlugin()`.
- *
- * Concrete service interfaces (e.g. `CMSEmailService`,
- * `CMSTranslationService`) extend this base and add the handler functions
- * specific to their capability.
- */
-interface CMSService {
-    /** Unique ID for the service (e.g. `'sendgrid'`, `'crowdin'`). */
-    id: string;
-    /** Human-readable label displayed in the UI (e.g. "SendGrid"). */
-    label: string;
-    /**
-     * Optional icon URL displayed in the UI next to the label. Similar to the
-     * sidebar tools `icon` option, this should be a URL to an image.
-     */
-    icon?: string;
-}
-/**
- * Base context passed to service handler functions. Concrete services may
- * extend this with additional fields specific to the call site (e.g. the
- * translation context adds `docId`, `collectionId`, etc.).
- */
-interface CMSServiceContext {
-    /** The Root.js config. */
-    rootConfig: RootConfig;
-    /** The Root CMS client for accessing the database. */
-    cmsClient: RootCMSClient;
-    /**
-     * Email of the user that triggered the action, if any. Some service calls
-     * are initiated by the system rather than a user, in which case this is
-     * undefined.
-     */
-    user?: {
-        email: string;
-    };
-}
-
-/** Result returned by a notification service `onAction` handler. */
-interface NotificationResult {
-    /**
-     * Delivery status.
-     * - `'success'`: the notification was delivered.
-     * - `'error'`: delivery failed; `message` should describe why.
-     * - `'info'` (default): the service handled the action but did not
-     *   deliver a notification (e.g. the action was filtered out).
-     */
-    status?: 'success' | 'info' | 'error';
-    /** Optional human-readable message describing the result. */
-    message?: string;
-}
-/** Context passed to notification service handler functions. */
-interface NotificationServiceContext extends CMSServiceContext {
-}
-/**
- * Configuration for defining a CMS notification service.
- *
- * Notification services react to actions in the CMS (publishes, schema
- * changes, comments, etc.) and dispatch them to an external channel.
- * Initially this is intended for email, with Slack, webhooks, and other
- * transports planned.
- *
- * Multiple notification services may be registered; each independently
- * decides whether and how to handle a given action.
- *
- * Example:
- * ```ts
- * cmsPlugin({
- *   services: {
- *     notifications: [
- *       {
- *         id: 'sendgrid',
- *         label: 'SendGrid',
- *         onAction: async (ctx, action) => {
- *           if (action.action === 'doc.publish') {
- *             await sendgrid.send({ ... });
- *           }
- *         },
- *       },
- *     ],
- *   },
- * });
- * ```
- */
-interface CMSNotificationService extends CMSService {
-    /**
-     * Async function called when an action occurs in the CMS. Receives the
-     * action and may dispatch a notification (e.g. send email, post to Slack)
-     * via the service's underlying transport. Can optionally return a
-     * `NotificationResult` describing delivery status.
-     */
-    onAction?: (ctx: NotificationServiceContext, action: Action) => Promise<void | NotificationResult>;
-}
-
-/** A row of translation data keyed by locale. */
-interface TranslationRow {
-    /** The source string. */
-    source: string;
-    /** Map of locale code to translated string. */
-    translations: Record<string, string>;
-    /** Optional translator notes/context for the source string. */
-    description?: string;
-}
-/** Context passed to translation service import/export functions. */
-interface TranslationServiceContext extends CMSServiceContext {
-    /** The document ID, e.g. `Pages/index`. */
-    docId: string;
-    /** The collection ID, e.g. `Pages`. */
-    collectionId: string;
-    /** The slug, e.g. `index`. */
-    slug: string;
-    /** The locales configured for the project. */
-    locales: string[];
-    /** The email of the user performing the action. */
-    user: {
-        email: string;
-    };
-}
-/** Result returned by an onExport handler. */
-interface TranslationExportResult {
-    /** Optional title displayed in the notification after export. */
-    title?: string;
-    /** Optional message displayed in the notification after export. */
-    message?: string;
-    /** Optional link displayed in the notification (e.g. to the translation service). */
-    link?: {
-        /** The URL to link to. */
-        url: string;
-        /** Optional label for the link. Defaults to "Open". */
-        label?: string;
-    };
-    /**
-     * Notification status controlling the color of the notification.
-     * - `'success'`: green
-     * - `'error'`: red
-     * - `'info'` (default): neutral
-     */
-    status?: 'success' | 'info' | 'error';
-}
-/** Result returned by an onImport handler when no rows are imported. */
-interface TranslationImportResult {
-    /** Optional title displayed in the notification after import. */
-    title?: string;
-    /** Optional message displayed in the notification after import. */
-    message?: string;
-    /** Optional link displayed in the notification (e.g. to the translation service). */
-    link?: {
-        /** The URL to link to. */
-        url: string;
-        /** Optional label for the link. Defaults to "Open". */
-        label?: string;
-    };
-    /**
-     * Notification status controlling the color of the notification.
-     * - `'success'`: green
-     * - `'error'`: red
-     * - `'info'` (default): neutral
-     */
-    status?: 'success' | 'info' | 'error';
-}
-/** Configuration for defining a CMS translation service. */
-interface CMSTranslationService extends CMSService {
-    /**
-     * Async function to import translations from the service. Should return an
-     * array of translation rows that will be merged into the CMS translations
-     * database, or a `TranslationImportResult` object to display a notification
-     * without importing any rows.
-     */
-    onImport?: (ctx: TranslationServiceContext, data: TranslationRow[]) => Promise<TranslationRow[] | TranslationImportResult>;
-    /**
-     * Async function to export translations to the service. Receives the
-     * current translation rows for the document. Can optionally return an object
-     * with a `message` to display in the success notification.
-     */
-    onExport?: (ctx: TranslationServiceContext, data: TranslationRow[]) => Promise<void | TranslationExportResult>;
-}
-
-interface TranslationsCheckOptions {
-    /**
-     * Optional list of collection IDs to restrict this check to. When set, the
-     * check is only shown and runnable for documents in these collections.
-     */
-    collections?: string[];
-}
-/**
- * A first-party CMS check that verifies all translatable strings in a document
- * have translations for each of the document's enabled locales.
- */
-declare function translationsCheck(options?: TranslationsCheckOptions): CMSCheck;
-
-/**
- * Built-in sidebar tools that can be toggled on/off in the CMS UI.
- */
-type CMSBuiltInSidebarTool = 'home' | 'content' | 'releases' | 'data' | 'assets' | 'translations' | 'ai' | 'settings';
-interface CMSUser {
-    email: string;
-}
-/**
- * @deprecated The `experiments.ai` flag is now used only as a sidebar toggle.
- * Configure chat models on the top-level `ai` plugin option instead.
- */
-interface CMSAIConfig {
-    /** Custom API endpoint for chat prompts. */
-    endpoint?: string;
-    /** Gen AI model to use. */
-    model?: string;
-}
-/**
- * Filters applied to the spotlight / global search indexer. By default every
- * collection and every doc is indexed. Use these options to scope the index to
- * a subset of the project's content.
- *
- * Doc ids use the `<collectionId>/<slug>` format (e.g. `Pages/about`), which
- * matches the format used elsewhere in the CMS.
- */
-interface CMSSearchIndexConfig {
-    /**
-     * Collections to include in the search index. If specified, only these
-     * collections are indexed. If unset, all collections are indexed (subject to
-     * `excludeCollections`).
-     */
-    includeCollections?: string[];
-    /**
-     * Collections to exclude from the search index. Applied after
-     * `includeCollections`.
-     */
-    excludeCollections?: string[];
-    /**
-     * Doc ids to include in the search index. If specified, only these docs are
-     * indexed (within collections that pass the collection filter). Format:
-     * `<collectionId>/<slug>`.
-     */
-    includeDocIds?: string[];
-    /**
-     * Doc ids to exclude from the search index. Applied after `includeDocIds`.
-     * Format: `<collectionId>/<slug>`.
-     */
-    excludeDocIds?: string[];
-}
-interface CMSSidebarTool {
-    /** URL for the sidebar icon image. */
-    icon?: string;
-    /** Label. */
-    label?: string;
-    /** Iframe URL to render for the tool. */
-    iframeUrl?: string;
-    /**
-     * CMS URL that should be opened when the tool is selected. The url must start
-     * with `/cms/`. Use this to create shortcuts to CMS pages instead of
-     * rendering the tool inside an iframe.
-     */
-    cmsUrl?: string;
-    /**
-     * External URL that should open in a new tab when the tool is selected.
-     */
-    externalUrl?: string;
-}
-type CMSPluginOptions = {
-    /**
-     * The ID of the project. Data will be stored under the namespace
-     * `Projects/${id}` in firestore.
-     */
-    id?: string;
-    /**
-     * The name of the project. Used in the header of the CMS to help identify
-     * the project.
-     */
-    name?: string;
-    /**
-     * Firebase config object, which can be obtained in the Firebase Console by
-     * going to "Project Settings".
-     */
-    firebaseConfig: {
-        [key: string]: string | undefined;
-        apiKey: string;
-        authDomain: string;
-        projectId: string;
-        storageBucket: string;
-        databaseId?: string;
-    };
-    /**
-     * GAPI credentials. Include if using Google Drive and Google Sheets features.
-     * See: https://developers.google.com/sheets/api/quickstart/js
-     */
-    gapi?: {
-        /** https://developers.google.com/sheets/api/quickstart/js#create_an_api_key */
-        apiKey: string;
-        /** https://developers.google.com/sheets/api/quickstart/js#authorize_credentials_for_a_web_application */
-        clientId: string;
-    };
-    /**
-     * Secret value(s) used for signing the user authentication cookie.
-     * @deprecated This is now handled directly by root's sessionMiddleware under
-     * `server.sessionCookieSecret` in root.config.ts.
-     */
-    cookieSecret?: string | string[];
-    /** Function called to check if a user should have access to the CMS. */
-    isUserAuthorized?: (req: Request, user: CMSUser) => boolean | Promise<boolean>;
-    /**
-     * Function to call to check if login is required for a particular request.
-     */
-    isLoginRequired?: (req: Request) => boolean;
-    /**
-     * By default, iframing the CMS is disallowed. Setting this value will allow
-     * iframes from the specified origins. Example:
-     * ```
-     * allowedIframeOrigins: ['https://app.example.com']
-     * ```
-     */
-    allowedIframeOrigins?: string[];
-    /**
-     * URL to GCI service for transforming uploaded GCS images to a Google App
-     * Engine Images API serving URL.
-     *
-     * Setting this to `true` uses the default hosted service at
-     * https://services.rootjs.dev.
-     *
-     * To set up GCI:
-     *
-     * - Create a GCS bucket with fine-grained permissions
-     * - Share owner access to the bucket with the service account returned in
-     *   https://services.rootjs.dev/_/service_account
-     *
-     * To disable GCI, leave this value empty or set to `false`, which which will
-     * serve images directly from GCS instead.
-     */
-    gci?: string | boolean;
-    /**
-     * Customization options for the CMS sidebar.
-     */
-    sidebar?: {
-        /**
-         * Sidebar tools, a map of the sidebar id to config options. The sidebar
-         * tool is url-mapped to `/cms/tools/:id` and displays the tool in an
-         * iframe.
-         */
-        tools?: Record<string, CMSSidebarTool>;
-        /**
-         * Hide specific built-in sidebar tools. Hiding a tool also removes its
-         * surfaces from the CMS home page. The underlying routes remain
-         * accessible via direct URL.
-         */
-        hiddenBuiltInTools?: CMSBuiltInSidebarTool[];
-    };
-    /**
-     * URL for a custom favicon used by the CMS UI.
-     */
-    favicon?: string;
-    /**
-     * Enables minimal branding mode in the CMS header. This hides the Root CMS
-     * logo and displays the project name on the top-right.
-     */
-    minimalBranding?: boolean;
-    /**
-     * Callback when an action occurs.
-     */
-    onAction?: (action: Action) => any;
-    /**
-     * Configures the Root CMS AI chat (`/cms/ai`). Provide one or more models
-     * — the CMS proxies user requests directly to the configured providers.
-     *
-     * The shape mirrors open source tools like Ollama and LiteLLM: each entry
-     * declares the provider, model id and credentials. Keys live on the server,
-     * never on the client.
-     *
-     * Example:
-     * ```ts
-     * cmsPlugin({
-     *   ai: {
-     *     models: [
-     *       {
-     *         id: 'gpt-5.5',
-     *         label: 'GPT-5.5',
-     *         provider: 'openai',
-     *         apiKey: process.env.OPENAI_API_KEY,
-     *         capabilities: {tools: true, reasoning: true, attachments: true},
-     *       },
-     *       {
-     *         id: 'claude-opus-4-7',
-     *         label: 'Claude Opus 4.7',
-     *         provider: 'anthropic',
-     *         apiKey: process.env.ANTHROPIC_API_KEY,
-     *         capabilities: {tools: true, reasoning: true, attachments: true},
-     *       },
-     *       {
-     *         id: 'gemini-3.1-pro',
-     *         label: 'Gemini 3.1 Pro',
-     *         provider: 'gemini',
-     *         apiKey: process.env.GEMINI_API_KEY,
-     *         capabilities: {tools: true, reasoning: true, attachments: true},
-     *       },
-     *       {
-     *         id: 'llama3-local',
-     *         label: 'Llama 3 (local)',
-     *         provider: 'openai-compatible',
-     *         baseURL: 'http://localhost:11434/v1',
-     *       },
-     *     ],
-     *     defaultModel: 'gpt-4o',
-     *   },
-     * });
-     * ```
-     *
-     * For project-specific guidance (conventions, patterns, naming rules, etc.),
-     * drop a `ROOT.md` file at the project root. Its contents are appended to
-     * the system prompt for every chat — similar to `AGENTS.md` / `CLAUDE.md`.
-     */
-    ai?: AiConfig;
-    /**
-     * Experimental config options. Note: these are subject to change at any time.
-     */
-    experiments?: {
-        /**
-         * @deprecated Use the top-level `ai` config instead. Setting this to
-         * `true` keeps the AI chat icon visible in the sidebar.
-         */
-        ai?: boolean | CMSAIConfig;
-        /**
-         * Enables the v2 `TranslationsManager`.
-         */
-        v2TranslationsManager?: boolean;
-        /**
-         * Enables the task manager (sidebar entry, home page card, and
-         * `/cms/tasks` routes).
-         */
-        taskManager?: boolean;
-    };
-    /**
-     * Adjust console output verbosity. Default is `'info'`.
-     */
-    logLevel?: 'info' | 'warn' | 'error' | 'silent' | 'debug';
-    /**
-     * Whether to enable/disable file watching in dev (e.g. for generating
-     * `root-cms.d.ts`). Defaults to `true`.
-     */
-    watch?: boolean;
-    /** Options associated with the preview. */
-    preview?: {
-        /**
-         * Whether to send messages to the preview iframe, handle messages from
-         * the preview iframe, enable both (`true`), or disable messages entirely
-         * (`false`). If unspecified, the default is `false`.
-         */
-        channel: boolean | 'to-preview' | 'from-preview';
-    };
-    /**
-     * Checks that can be run on-demand from the CMS UI to validate document
-     * content. Each check defines a server-side function that returns a
-     * success/warning/error result with a markdown message.
-     *
-     * Example:
-     * ```ts
-     * cmsPlugin({
-     *   checks: [
-     *     {
-     *       id: 'my-check',
-     *       label: 'My Check',
-     *       run: async (ctx) => {
-     *         return {status: 'success', message: 'All good!'};
-     *       },
-     *     },
-     *   ],
-     * });
-     * ```
-     *
-     * NOTE: The checks feature is considered a "beta" feature, its interface
-     * may change from version to version as we add new features.
-     */
-    checks?: CMSCheck[];
-    /**
-     * Translation services that appear in the Localization modal's Import and
-     * Export menus. Each service defines server-side import/export functions
-     * that integrate with an external translation platform (e.g. Crowdin).
-     *
-     * Example:
-     * ```ts
-     * cmsPlugin({
-     *   translations: [
-     *     {
-     *       id: 'crowdin',
-     *       label: 'Crowdin',
-     *       onImport: async (ctx, data) => { ... },
-     *       onExport: async (ctx, data) => { ... },
-     *     },
-     *   ],
-     * });
-     * ```
-     */
-    translations?: CMSTranslationService[];
-    /**
-     * Notification services that react to CMS actions and dispatch them to
-     * external channels (email, Slack, webhooks, etc.). Each service defines
-     * an optional server-side `onAction` handler.
-     *
-     * Example:
-     * ```ts
-     * cmsPlugin({
-     *   notifications: [
-     *     {
-     *       id: 'sendgrid',
-     *       label: 'SendGrid',
-     *       onAction: async (ctx, action) => {
-     *         if (action.action === 'doc.publish') {
-     *           await sendgrid.send({ ... });
-     *         }
-     *       },
-     *     },
-     *   ],
-     * });
-     * ```
-     */
-    notifications?: CMSNotificationService[];
-    /**
-     * Configuration for the spotlight / global search indexer. Use this to
-     * include or exclude specific collections or docs from being indexed.
-     */
-    searchIndex?: CMSSearchIndexConfig;
-    /**
-     * Default UI variant for `oneOf` fields. Individual fields can still
-     * override this by setting their own `variant`. Defaults to `'dropdown'`.
-     */
-    defaultOneOfVariant?: 'dropdown' | 'picker';
-};
-type CMSPlugin = Plugin & {
-    name: 'root-cms';
-    getConfig: () => CMSPluginOptions;
-    getFirebaseApp: () => App;
-    getFirestore: (options?: {
-        databaseId?: string;
-    }) => Firestore;
-};
-declare function cmsPlugin(options: CMSPluginOptions): CMSPlugin;
-
-type Locale = string;
-type SourceString = string;
-type TranslatedString = string;
-type TranslationsDocMode = 'draft' | 'published';
-interface TranslationsLocaleDocHashMap {
-    /**
-     * A hash map of a source string's hash fingerprint to the source string and
-     * translated string.
-     */
-    [hash: string]: TranslationsLocaleDocEntry;
-}
-interface TranslationsLocaleDocEntry {
-    source: SourceString;
-    translation: TranslatedString;
-}
-interface TranslationsDbPathOptions {
-    project: string;
-    mode: TranslationsDocMode;
-}
-type TranslationsLocaleDocDbPathOptions = TranslationsDbPathOptions & {
-    id: string;
-    locale: string;
-};
-/**
- * A translations map containing translations for multiple locales.
- *
- * Example:
- * ```
- * {
- *   "one": {"es": "uno", "fr": "un"},
- *   "two": {"es": "dos", "fr": "deux"}
- * }
- * ```
- */
-interface MultiLocaleTranslationsMap {
-    [source: SourceString]: {
-        [locale: Locale]: TranslatedString;
-    };
-}
-/**
- * A translations map containing translations for a single locale.
- *
- * Example:
- * ```
- * {
- *   "one": "uno",
- *   "two": "dos"
- * }
- * ```
- */
-interface SingleLocaleTranslationsMap {
-    [source: SourceString]: TranslatedString;
-}
-declare class TranslationsManager {
-    cmsClient: RootCMSClient;
-    constructor(cmsClient: RootCMSClient);
-    /**
-     * Saves draft translations for a translations doc id.
-     *
-     * Example:
-     * ```
-     * const strings = {
-     *   'one': {es: 'uno', fr: 'un'},
-     *   'two': {es: 'dos', fr: 'deux'},
-     * };
-     * await tm.saveTranslations('Pages/index', strings);
-     * ```
-     */
-    saveTranslations(id: string, strings: MultiLocaleTranslationsMap, options?: {
-        tags?: string[];
-        modifiedBy?: string;
-    }): Promise<void>;
-    /**
-     * Publishes a translations doc.
-     */
-    publishTranslations(id: string, options?: {
-        batch?: WriteBatch;
-        publishedBy?: string;
-    }): Promise<void>;
-    /**
-     * Fetches translations from one or more translations docs in the translations
-     * manager.
-     *
-     * Example:
-     * ```
-     * await tm.loadTranslations();
-     * // =>
-     * // {
-     * //   "one": {"es": "uno", "fr": "un"},
-     * //   "two": {"es": "dos", "fr": "deux"}
-     * // }
-     * ```
-     *
-     * To load a specific set of translations docs by id:
-     * ```
-     * const translationsToLoad = ['Global/strings', 'Global/header', 'Global/footer', 'Pages/index'];
-     * await tm.loadTranslations({ids: translationsToLoad});
-     * // =>
-     * // {
-     * //   "one": {"es": "uno", "fr": "un"},
-     * //   "two": {"es": "dos", "fr": "deux"}
-     * // }
-     * ```
-     *
-     * To load a subset of locales (more performant):
-     * ```
-     * await tm.loadTranslations({locales: ['es']});
-     * // =>
-     * // {
-     * //   "one": {"es": "uno"},
-     * //   "two": {"es": "dos"}
-     * // }
-     * ```
-     */
-    loadTranslations(options?: {
-        ids?: string[];
-        tags?: string[];
-        locales?: Locale[];
-        mode?: TranslationsDocMode;
-    }): Promise<MultiLocaleTranslationsMap>;
-    /**
-     * Fetches translations for a given locale, with optional fallbacks.
-     * The return value is a map of source string to translated string.
-     *
-     * Example:
-     * ```
-     * await translationsDoc.loadTranslationsForLocale('es');
-     * // =>
-     * // {
-     * //   "one": "uno",
-     * //   "two": "dos",
-     * // }
-     * ```
-     */
-    loadTranslationsForLocale(locale: Locale, options?: {
-        mode?: TranslationsDocMode;
-        fallbackLocales?: Locale[];
-    }): Promise<SingleLocaleTranslationsMap>;
-    /**
-     * Converts a multi-locale translations map to a flat single-locale map,
-     * with optional support for fallback locales.
-     *
-     * ```
-     * const multiLocaleStrings = {
-     *   'one': {es: 'uno', fr: 'un'},
-     *   'two': {es: 'dos', fr: 'deux'}
-     * };
-     * translationsDoc.toSingleLocaleMap(multiLocaleStrings, ['es']);
-     * // =>
-     * // {
-     * //   "one": "uno",
-     * //   "two": "dos",
-     * // }
-     * ```
-     */
-    private toSingleLocaleMap;
-    /**
-     * Converts a multi-locale translations map to a single-locale hashed version,
-     * used for storage in in the DB.
-     *
-     * ```
-     * const multiLocaleStrings = {
-     *   'one': {es: 'uno', fr: 'un'},
-     *   'two': {es: 'dos', fr: 'deux'}
-     * };
-     * translationsDoc.toLocaleDocHashMap(multiLocaleStrings, 'es');
-     * // =>
-     * // {
-     * //   "<hash1>": {"source": "one", "translation": "uno"},
-     * //   "<hash2>": {"source": "two", "translation": "dos"},
-     * // }
-     * ```
-     *
-     * One reason for using hashes is because the DB has limits on the number of
-     * chars that can be used as the "key" in a object map.
-     */
-    private toLocaleDocHashMap;
-    /**
-     * Import translations from the v1 system to the TranslationsManager.
-     */
-    importTranslationsFromV1(): Promise<void>;
-}
-declare function buildTranslationsDbPath(options: TranslationsDbPathOptions): string;
-declare function buildTranslationsLocaleDocDbPath(options: TranslationsLocaleDocDbPathOptions): string;
-
-interface Doc<Fields = any> {
-    /** The id of the doc, e.g. "Pages/foo-bar". */
-    id: string;
-    /** The collection id of the doc, e.g. "Pages". */
-    collection: string;
-    /** The slug of the doc, e.g. "foo-bar". */
-    slug: string;
-    sys: {
-        createdAt: number;
-        createdBy: string;
-        modifiedAt: number;
-        modifiedBy: string;
-        firstPublishedAt?: number;
-        firstPublishedBy?: string;
-        publishedAt?: number;
-        publishedBy?: string;
-        publishingLocked: {
-            lockedAt: string;
-            lockedBy: string;
-            reason: string;
-            until?: Timestamp;
-        };
-        locales?: string[];
-    };
-    fields: Fields;
-}
-type DocMode = 'draft' | 'published';
-type UserRole = 'ADMIN' | 'EDITOR' | 'CONTRIBUTOR' | 'VIEWER';
-type HttpMethod = 'GET' | 'POST';
-type CronUnit = 'minutes' | 'hours' | 'days';
-interface DataSourceCron {
-    enabled: boolean;
-    interval: number;
-    unit: CronUnit;
-    autoPublish?: boolean;
-}
-interface DataSource {
-    id: string;
-    description?: string;
-    type: 'http' | 'gsheet';
-    url: string;
-    /**
-     * Currently only used by gsheet. `array` returns the sheet as an array of
-     * arrays, `map` returns the sheet as an array of objects.
-     */
-    dataFormat?: 'array' | 'map';
-    /**
-     * Options for HTTP requests.
-     */
-    httpOptions?: {
-        method: HttpMethod;
-        headers?: Record<string, string>;
-        body?: string;
-    };
-    cron?: DataSourceCron;
-    createdAt: Timestamp;
-    createdBy: string;
-    syncedAt?: Timestamp;
-    syncedBy?: string;
-    publishedAt?: Timestamp;
-    publishedBy?: string;
-    archivedAt?: Timestamp;
-    archivedBy?: string;
-}
-interface DataSourceData<T = any> {
-    dataSource: DataSource;
-    data: T;
-    /** Optional list of column headers (for gsheet sources). */
-    headers?: string[];
-}
-type DataSourceMode = 'draft' | 'published';
-interface GetDocOptions {
-    /** Mode, either "draft" or "published". */
-    mode: DocMode;
-}
-interface SetDocOptions {
-    /** Mode, either "draft" or "published". */
-    mode: DocMode;
-}
-interface SaveDraftOptions {
-    /**
-     * Locales to enable.
-     */
-    locales?: string[];
-    /**
-     * Email of user modifying the doc. If blank, defaults to `root-cms-client`.
-     */
-    modifiedBy?: string;
-    /**
-     * Whether to validate fieldsData against the collection schema before saving.
-     * If validation fails, an error will be thrown with details about the validation errors.
-     */
-    validate?: boolean;
-}
-interface UpdateDraftOptions {
-    /**
-     * Whether to validate the updated field against the collection schema.
-     * If validation fails, an error will be thrown with details about the validation errors.
-     */
-    validate?: boolean;
-}
-interface ListDocsOptions {
-    mode: DocMode;
-    offset?: number;
-    limit?: number;
-    orderBy?: string;
-    orderByDirection?: 'asc' | 'desc';
-    query?: (query: Query) => Query;
-    /**
-     * Whether to fetch the "raw" version of the doc (for use in conjunction with
-     * `setRawDoc()`).
-     */
-    raw?: boolean;
-}
-interface GetCountOptions {
-    mode: DocMode;
-    query?: (query: Query) => Query;
-}
-interface Translation {
-    [locale: string]: string;
-    source: string;
-}
-interface TranslationsMap {
-    [hash: string]: Translation;
-}
-interface LocaleTranslations {
-    [source: string]: string;
-}
-interface LoadTranslationsOptions {
-    tags?: string[];
-}
-interface Release {
-    id: string;
-    description?: string;
-    docIds?: string[];
-    dataSourceIds?: string[];
-    createdAt?: Timestamp;
-    createdBy?: string;
-    scheduledAt?: Timestamp;
-    scheduledBy?: string;
-    publishedAt?: Timestamp;
-    publishedBy?: string;
-}
-interface Action<T = any> {
-    /**
-     * The name of the action.
-     */
-    action: string;
-    /**
-     * The user's email that performed the action (or "system").
-     */
-    by?: string;
-    /**
-     * Timestamp when the action occurred.
-     */
-    timestamp: Timestamp;
-    /**
-     * Metadata for the action.
-     */
-    metadata?: T;
-    /**
-     * Optional list of quick links to display in the UI.
-     */
-    links?: {
-        label: string;
-        url: string;
-        target?: string;
-    }[];
-}
-interface ListActionsOptions {
-    /**
-     * Filter by a specific action. Defaults to all actions.
-     */
-    action?: string;
-    /**
-     * Filter by a specific user. Defaults to all users.
-     */
-    by?: string;
-    /**
-     * Max number of actions to return. Defaults to 100.
-     */
-    limit?: number;
-}
-declare class RootCMSClient {
-    readonly rootConfig: RootConfig;
-    readonly cmsPlugin: CMSPlugin;
-    readonly projectId: string;
-    readonly app: App;
-    readonly db: Firestore;
-    constructor(rootConfig: RootConfig);
-    /**
-     * Converts a doc mode to the Firestore collection name.
-     */
-    private getModeCollection;
-    /**
-     * Retrieves doc data from Root.js CMS.
-     */
-    getDoc<Fields = any>(collectionId: string, slug: string, options: GetDocOptions): Promise<Doc<Fields> | null>;
-    /**
-     * Retrieves raw doc data as stored in the database. Only use this if you know
-     * what you are doing.
-     */
-    getRawDoc(collectionId: string, slug: string, options: GetDocOptions): Promise<any | null>;
-    /**
-     * Firestore path for a collection.
-     */
-    dbCollectionDocsPath(collectionId: string, options: {
-        mode: 'draft' | 'published';
-    }): string;
-    /**
-     * Firestore path for a content doc.
-     */
-    dbDocPath(collectionId: string, slug: string, options: {
-        mode: 'draft' | 'published';
-    }): string;
-    /**
-     * Firestore doc ref for a content doc.
-     */
-    dbDocRef(collectionId: string, slug: string, options: {
-        mode: 'draft' | 'published';
-    }): FirebaseFirestore.DocumentReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>;
-    /**
-     * Returns a collection's schema definition as defined in
-     * `/collections/<id>.schema.ts`.
-     */
-    getCollection(collectionId: string): Promise<Collection | null>;
-    /**
-     * Saves draft data to a doc.
-     *
-     * Note: this saves data to the "fields" attr of the draft doc. If you need to
-     * modify the sys-level attributes of the doc, use `setRawDoc()`.
-     */
-    saveDraftData(docId: string, fieldsData: any, options?: SaveDraftOptions): Promise<void>;
-    /**
-     * Updates a specific field path in a draft doc.
-     *
-     * This allows partial updates to nested fields without replacing the entire document.
-     * For example: `updateDraftData('Pages/home', 'hero.title', 'New Title')`
-     *
-     * @param docId - The document ID (e.g., 'Pages/home')
-     * @param path - JSON path to the field (e.g., 'hero.title' or 'content.0.text')
-     * @param fieldValue - The value to set at the specified path
-     * @param options - Update options including validation
-     */
-    updateDraftData(docId: string, path: string, fieldValue: any, options?: UpdateDraftOptions): Promise<void>;
-    /**
-     * Sets the raw document data directly in Firestore.
-     *
-     * CAUTION Prefer using `saveDraftData('Pages/foo', data)` in most cases.
-     * Only use this method if you need to manipulate system-level (sys) fields
-     * directly or if you're implementing low-level data operations.
-     *
-     * ## Validation & Normalization
-     *
-     * This method automatically validates and normalizes `sys` fields to prevent
-     * data integrity issues that can cause runtime errors like
-     * "e.toMillis is not a function".
-     *
-     * ### Timestamp Fields (auto-converted)
-     * The following fields accept multiple formats and are automatically converted
-     * to Firestore Timestamp objects:
-     * - `sys.createdAt`
-     * - `sys.modifiedAt`
-     * - `sys.publishedAt`
-     * - `sys.firstPublishedAt`
-     *
-     * Accepted formats:
-     * - Firestore `Timestamp` object (unchanged)
-     * - `number` - Interpreted as milliseconds since epoch, converted to Timestamp
-     * - `Date` object - Converted to Timestamp
-     *
-     * ### Required Fields (auto-populated with defaults if missing)
-     * - `sys.createdAt` - Defaults to current time if not provided
-     * - `sys.modifiedAt` - Defaults to current time if not provided
-     * - `sys.createdBy` - Defaults to 'root-cms-client' if not provided
-     * - `sys.modifiedBy` - Defaults to 'root-cms-client' if not provided
-     * - `sys.locales` - Defaults to ['en'] if not provided
-     *
-     * ### Optional Fields (validated if present)
-     * - `sys.publishedBy` - String identifier
-     * - `sys.firstPublishedBy` - String identifier
-     * - `sys.publishingLocked` - Object with optional `until` Timestamp
-     *
-     * ### Document Identity
-     * The `id`, `collection`, and `slug` fields are always set to match the
-     * provided parameters, overwriting any existing values to prevent data
-     * inconsistencies.
-     *
-     * @param collectionId - The collection ID (e.g., 'Pages')
-     * @param slug - The document slug (e.g., 'home')
-     * @param data - The complete document data including sys and fields
-     * @param options - Options specifying mode ('draft' or 'published')
-     *
-     * @throws {Error} If sys fields are invalid or missing required fields
-     * @throws {Error} If timestamp fields have invalid types
-     *
-     * @example
-     * ```typescript
-     * // Minimal example - sys fields use defaults
-     * await client.setRawDoc('Pages', 'home', {
-     *   sys: {},  // All sys fields will be auto-populated with defaults
-     *   fields: {
-     *     title: 'Home Page'
-     *   }
-     * }, { mode: 'draft' });
-     *
-     * // Full example - with number timestamps (auto-converted)
-     * await client.setRawDoc('Pages', 'home', {
-     *   id: 'Pages/home',
-     *   collection: 'Pages',
-     *   slug: 'home',
-     *   sys: {
-     *     createdAt: Date.now(),  // Auto-converted to Timestamp.
-     *     createdBy: 'user@example.com',
-     *     modifiedAt: Date.now(),  // Auto-converted to Timestamp.
-     *     modifiedBy: 'user@example.com',
-     *     locales: ['en', 'es']
-     *   },
-     *   fields: {
-     *     title: 'Home Page'
-     *   }
-     * }, { mode: 'draft' });
-     * ```
-     */
-    setRawDoc(collectionId: string, slug: string, data: any, options: SetDocOptions): Promise<void>;
-    /**
-     * Lists docs from a Root.js CMS collection.
-     */
-    listDocs<T>(collectionId: string, options: ListDocsOptions): Promise<{
-        docs: T[];
-    }>;
-    /**
-     * Returns the number of docs in a Root.js CMS collection.
-     */
-    getDocsCount(collectionId: string, options: GetCountOptions): Promise<number>;
-    /**
-     * Batch publishes a set of docs by id.
-     */
-    publishDocs(docIds: string[], options?: {
-        publishedBy: string;
-        batch?: WriteBatch;
-        releaseId?: string;
-    }): Promise<any[]>;
-    /**
-     * Batch unpublishes a set of docs by id.
-     */
-    unpublishDocs(docIds: string[], options?: {
-        unpublishedBy?: string;
-        batch?: WriteBatch;
-    }): Promise<any[]>;
-    /**
-     * Publishes scheduled docs.
-     */
-    publishScheduledDocs(): Promise<any[]>;
-    /**
-     * Publishes docs in scheduled releases.
-     */
-    publishScheduledReleases(): Promise<void>;
-    /**
-     * Syncs data sources that have cron scheduling enabled and are due for sync.
-     */
-    syncScheduledDataSources(): Promise<void>;
-    /**
-     * Checks if a doc is currently "locked" for publishing.
-     */
-    testPublishingLocked(doc: Doc): boolean;
-    /**
-     * Returns a `TranslationsManager` object for managing translations.
-     *
-     * To get translations:
-     * ```
-     * await tm.loadTranslations({
-     *   ids: ['Global/strings', 'Pages/index'],
-     *   locales: ['es'],
-     * });
-     * ```
-     *
-     * NOTE: The `TranslationsManager` is a v2 feature that will eventually
-     * replace the v1 translations system.
-     */
-    getTranslationsManager(): TranslationsManager;
-    /**
-     * Loads translations saved in the translations collection, optionally
-     * filtered by tag.
-     *
-     * Returns a map like:
-     * ```
-     * {
-     *   "<hash>": {"source": "Hello", "es": "Hola", "fr": "Bonjour"},
-     * }
-     * ```
-     */
-    loadTranslations(options?: LoadTranslationsOptions): Promise<TranslationsMap>;
-    /**
-     * Saves a map of translations, e.g.:
-     * ```
-     * await client.saveTranslations({
-     *   "Hello": {"es": "Hola", "fr": "Bonjour"},
-     * });
-     * ```
-     */
-    saveTranslations(translations: {
-        [source: string]: {
-            [locale: string]: string;
-        };
-    }, tags?: string[]): Promise<void>;
-    /**
-     * Returns the "key" used for a translation as stored in the db. Translations
-     * are stored under `Projects/<project id>/Translations/<sha1 hash>`.
-     */
-    getTranslationKey(source: string): string;
-    /**
-     * Cleans a string that's used for translations. Performs the following:
-     * - Removes any leading/trailing whitespace
-     * - Removes spaces at the end of any line
-     */
-    normalizeString(str: string): string;
-    /**
-     * Loads translations for a particular locale.
-     *
-     * Returns a map like:
-     * ```
-     * {
-     *   "Hello": "Bonjour",
-     * }
-     * ```
-     */
-    loadTranslationsForLocale(locale: string, options?: LoadTranslationsOptions): Promise<LocaleTranslations>;
-    /**
-     * Firestore path for a translations file.
-     */
-    dbTranslationsPath(translationsId: string, options: {
-        mode: 'draft' | 'published';
-    }): string;
-    /**
-     * Firestore doc ref for a translations file.
-     */
-    dbTranslationsRef(translationsId: string, options: {
-        mode: 'draft' | 'published';
-    }): FirebaseFirestore.DocumentReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>;
-    /**
-     * Returns a data source configuration object.
-     */
-    getDataSource(dataSourceId: string): Promise<DataSource | null>;
-    /**
-     * Archives a data source. Archived data sources cannot be synced or published.
-     */
-    archiveDataSource(dataSourceId: string, options?: {
-        archivedBy?: string;
-    }): Promise<void>;
-    /**
-     * Unarchives a data source.
-     */
-    unarchiveDataSource(dataSourceId: string): Promise<void>;
-    /**
-     * Syncs a data source to draft state.
-     */
-    syncDataSource(dataSourceId: string, options?: {
-        syncedBy?: string;
-    }): Promise<void>;
-    publishDataSource(dataSourceId: string, options?: {
-        publishedBy?: string;
-    }): Promise<void>;
-    /**
-     * Unpublishes a data source. Removes the `publishedAt`/`publishedBy`
-     * metadata from the DataSource doc and deletes the `Data/published` doc.
-     */
-    unpublishDataSource(dataSourceId: string): Promise<void>;
-    publishDataSources(dataSourceIds: string[], options?: {
-        publishedBy: string;
-        batch?: WriteBatch;
-        commitBatch?: boolean;
-    }): Promise<void>;
-    private fetchData;
-    private fetchHttpData;
-    /**
-     * Fetches data from a Google Sheet using the Google Sheets API v4.
-     *
-     * ## Setup
-     *
-     * For the server-side service account to access the Google Sheet:
-     *
-     * 1. **Enable the Google Sheets API** in the Google Cloud Console for the
-     *    project associated with the service account.
-     *    https://console.cloud.google.com/apis/library/sheets.googleapis.com
-     *
-     * 2. **Share the Google Sheet** with the service account's email address
-     *    (e.g. `my-service-account@my-project.iam.gserviceaccount.com`).
-     *    Open the sheet in Google Sheets, click "Share", and add the service
-     *    account email as a Viewer.
-     *
-     *    - For **App Engine**: the service account email is typically
-     *      `<project-id>@appspot.gserviceaccount.com`.
-     *    - For **Cloud Run**: check the service account configured for the
-     *      Cloud Run service in the Google Cloud Console.
-     *    - For **local development**: use the service account email from the
-     *      JSON key file specified in `GOOGLE_APPLICATION_CREDENTIALS`.
-     */
-    private fetchGsheetData;
-    /**
-     * Fetches data from a data source.
-     */
-    getFromDataSource<T = any>(dataSourceId: string, options?: {
-        mode?: 'draft' | 'published';
-    }): Promise<DataSourceData<T> | null>;
-    /**
-     * Firestore path for a datasource data.
-     */
-    dbDataSourceDataPath(dataSourceId: string, options: {
-        mode: 'draft' | 'published';
-    }): string;
-    /**
-     * Firestore doc ref for a datasource data.
-     */
-    dbDataSourceDataRef(dataSourceId: string, options: {
-        mode: 'draft' | 'published';
-    }): FirebaseFirestore.DocumentReference<FirebaseFirestore.DocumentData, FirebaseFirestore.DocumentData>;
-    /**
-     * Gets the user's role from the project's ACL.
-     */
-    getUserRole(email: string): Promise<UserRole | null>;
-    /**
-     * Verifies user exists in the ACL list.
-     */
-    userExistsInAcl(email: string): Promise<boolean>;
-    /**
-     * Lists action logs from the database.
-     */
-    listActions(options?: ListActionsOptions): Promise<Action[]>;
-    logAction(action: string, options?: {
-        by?: string;
-        metadata?: any;
-        links?: {
-            label: string;
-            url: string;
-            target?: string;
-        }[];
-    }): Promise<void>;
-    /**
-     * Creates a batch request that is capable of fetching one or more docs,
-     * corresponding translations, and dataSources.
-     */
-    createBatchRequest(options: BatchRequestOptions): BatchRequest;
-}
-/**
- * Returns true if the `data` is a rich text data object.
- */
-declare function isRichTextData(data: any): boolean;
-declare function getCmsPlugin(rootConfig: RootConfig): CMSPlugin;
-/**
- * Walks the data tree and converts any array of objects into "array objects"
- * for storage in firestore.
- */
-declare function marshalData(data: any): any;
-/**
- * Walks the data tree and converts any Timestamp objects to millis and any
- * _array maps to normal arrays.
- *
- * E.g.:
- *
- * normalizeData({
- *   sys: {modifiedAt: Timestamp(123)},
- *   fields: {
- *     _array: ['asdf'],
- *     asdf: {title: 'hello'}
- *   }
- * })
- * // => {sys: {modifiedAt: 123}, fields: {foo: [{title: 'hello'}]}}
- */
-declare function unmarshalData(data: any): any;
-/** @deprecated Use `unmarshalData()` instead. */
-declare function normalizeData(data: any): any;
-interface ArrayObject {
-    [key: string]: any;
-    _array: string[];
-}
-/**
- * Serializes an array into an `ArrayObject`, e.g.:
- *
- * ```
- * marshalArray([1, 2, 3])
- * // => {a: 1, b: 2, c: 3, _array: ['a', 'b', 'c']}
- * ```
- *
- * This database storage method makes it easier to update a single field in a
- * deeply nested array object.
- */
-declare function toArrayObject(arr: any[]): ArrayObject;
-declare const marshalArray: typeof toArrayObject;
-/**
- * Converts an `ArrayObject` to a normal array.
- */
-declare function unmarshalArray(arrObject: ArrayObject): any[];
-/**
- * Converts a translations map from `loadTranslations()` to a map of source to
- * translated string for a particular locale.
- *
- * Returns a map like:
- * ```
- * {
- *   "Hello": "Bonjour",
- * }
- * ```
- */
-declare function translationsForLocale(translationsMap: TranslationsMap, locale: string): LocaleTranslations;
-/**
- * Parses a docId (e.g. `Pages/foo`) and returns the `collection` and `slug`.
- */
-declare function parseDocId(docId: string): {
-    collection: string;
-    slug: string;
-};
-interface BatchRequestOptions {
-    mode: 'draft' | 'published';
-    /**
-     * Whether to automatically fetch translations for the docs retrieved in the
-     * request.
-     */
-    translate?: boolean;
-}
-interface BatchRequestQuery {
-    queryId: string;
-    collectionId: string;
-    queryOptions?: BatchRequestQueryOptions;
-}
-interface BatchRequestQueryOptions {
-    offset?: number;
-    limit?: number;
-    orderBy?: string;
-    orderByDirection?: 'asc' | 'desc';
-    query?: (query: Query) => Query;
-}
-interface TranslationsDoc {
-    id: string;
-    sys: {
-        modifiedAt: Timestamp;
-        modifiedBy: string;
-        publishedAt?: Timestamp;
-        publishedBy?: string;
-        linkedSheet?: {
-            spreadsheetId: string;
-            gid: number;
-            linkedAt: Timestamp;
-            linkedBy: string;
-        };
-        tags?: string[];
-    };
-    strings: TranslationsMap;
-}
-declare class BatchRequest {
-    cmsClient: RootCMSClient;
-    private options;
-    private db;
-    private docIds;
-    private dataSourceIds;
-    private queries;
-    private translationsIds;
-    constructor(cmsClient: RootCMSClient, options: BatchRequestOptions);
-    /**
-     * Adds a doc to the batch request.
-     */
-    addDoc(docId: string): void;
-    /**
-     * Adds a data source to the batch request.
-     */
-    addDataSource(dataSourceId: string): void;
-    /**
-     * Adds a collection-based query to the batch request.
-     */
-    addQuery(queryId: string, collectionId: string, queryOptions?: BatchRequestQueryOptions): void;
-    /**
-     * Adds a translation file to the request.
-     */
-    addTranslations(translationsId: string): void;
-    /**
-     * Fetches data from the DB.
-     */
-    fetch(): Promise<BatchResponse>;
-    private fetchDocs;
-    private fetchQueries;
-    private fetchDataSources;
-    private fetchTranslations;
-}
-declare class BatchResponse {
-    docs: Record<string, Doc>;
-    queries: Record<string, Doc[]>;
-    dataSources: Record<string, DataSourceData>;
-    translations: Record<string, TranslationsDoc>;
-    /**
-     * Returns a map of translations for a given locale or locale fallbacks.
-     *
-     * The input is either a single locale (e.g. "de") or an array of locales
-     * representing the fallback tree, e.g. ["en-CA", "en-GB", "en"].
-     *
-     * TODO(stevenle): support the locale fallback tree.
-     *
-     * The returned value is a flat map of source string to translated string,
-     * e.g.:
-     * {"<source>": "<translation>"}
-     */
-    getTranslations(locale: string): LocaleTranslations;
-    /**
-     * Merges the strings from all translations files retrieved in the request.
-     * The returned value is a map of string to translations, e.g.:
-     *
-     * {"<hash>": {"source": "<source>", "<locale>": "<translation>"}}
-     */
-    private getTranslationsMap;
-}
-
-export { type CMSAIConfig as $, type Action as A, type BatchRequestOptions as B, type CronUnit as C, type DocMode as D, type TranslationsDoc as E, BatchRequest as F, type GetDocOptions as G, type HttpMethod as H, BatchResponse as I, type Locale as J, type SourceString as K, type LoadTranslationsOptions as L, type TranslatedString as M, type TranslationsDocMode as N, type TranslationsLocaleDocHashMap as O, type TranslationsLocaleDocEntry as P, type MultiLocaleTranslationsMap as Q, RootCMSClient as R, type SetDocOptions as S, type TranslationsMap as T, type UserRole as U, type SingleLocaleTranslationsMap as V, TranslationsManager as W, buildTranslationsDbPath as X, buildTranslationsLocaleDocDbPath as Y, type CMSBuiltInSidebarTool as Z, type CMSUser as _, type LocaleTranslations as a, type CMSSearchIndexConfig as a0, type CMSSidebarTool as a1, type CMSPluginOptions as a2, type CMSPlugin as a3, cmsPlugin as a4, type AiConfig as a5, type AiModelConfig as a6, type AiProvider as a7, type CMSCheck as a8, type CheckResult as a9, type CheckContext as aa, type CheckStatus as ab, translationsCheck as ac, type TranslationsCheckOptions as ad, type CMSService as ae, type CMSServiceContext as af, type CMSNotificationService as ag, type NotificationResult as ah, type NotificationServiceContext as ai, type CMSTranslationService as aj, type TranslationExportResult as ak, type TranslationImportResult as al, type TranslationRow as am, type TranslationServiceContext as an, type Doc as b, type DataSourceCron as c, type DataSource as d, type DataSourceData as e, type DataSourceMode as f, type SaveDraftOptions as g, type UpdateDraftOptions as h, type ListDocsOptions as i, type GetCountOptions as j, type Translation as k, type Release as l, type ListActionsOptions as m, isRichTextData as n, getCmsPlugin as o, marshalData as p, normalizeData as q, type ArrayObject as r, marshalArray as s, toArrayObject as t, unmarshalData as u, unmarshalArray as v, translationsForLocale as w, parseDocId as x, type BatchRequestQuery as y, type BatchRequestQueryOptions as z };