@blinkk/root-cms 3.0.1-alpha.1 → 3.0.1-beta.3

package/dist/{client-DdB4xpM6.d.ts → client-1puwLgNx.d.ts}

@@ -1,12 +1,74 @@
 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-rjBOZk-j.js';
+import { C as Collection } from './schema-Db_xODoi.js';
 
 /**
- * Supported Root AI models. Defaults to 'gemini-3-flash-preview'.
+ * Provider type for an AI model. Use `openai-compatible` for any OpenAI-style
+ * endpoint (e.g. local Ollama, vLLM, OpenRouter).
  */
-type RootAiModel = 'gemini-3-pro-preview' | 'gemini-3-flash-preview' | 'gemini-2.5-flash' | 'gemini-2.0-pro' | string;
+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';
@@ -252,15 +314,51 @@ declare function translationsCheck(options?: TranslationsCheckOptions): CMSCheck
 /**
  * Built-in sidebar tools that can be toggled on/off in the CMS UI.
  */
-type CMSBuiltInSidebarTool = 'home' | 'content' | 'tasks' | 'releases' | 'data' | 'assets' | 'translations' | 'ai' | 'settings';
+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?: RootAiModel;
+    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. */
@@ -338,13 +436,13 @@ type CMSPluginOptions = {
      * Engine Images API serving URL.
      *
      * Setting this to `true` uses the default hosted service at
-     * https://gci.rootjs.dev.
+     * 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://gci.rootjs.dev/_/service_account
+     *   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.
@@ -361,7 +459,9 @@ type CMSPluginOptions = {
          */
         tools?: Record<string, CMSSidebarTool>;
         /**
-         * Hide specific built-in sidebar tools.
+         * 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[];
     };
@@ -378,18 +478,75 @@ type CMSPluginOptions = {
      * 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?: {
         /**
-         * Enables the Root CMS AI page.
+         * @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'`.
@@ -476,6 +633,16 @@ type CMSPluginOptions = {
      * ```
      */
     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';
@@ -733,6 +900,8 @@ interface DataSource {
     syncedBy?: string;
     publishedAt?: Timestamp;
     publishedBy?: string;
+    archivedAt?: Timestamp;
+    archivedBy?: string;
 }
 interface DataSourceData<T = any> {
     dataSource: DataSource;
@@ -1114,6 +1283,16 @@ declare class RootCMSClient {
      * 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.
      */
@@ -1123,6 +1302,11 @@ declare class RootCMSClient {
     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;
@@ -1365,4 +1549,4 @@ declare class BatchResponse {
     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 CMSSidebarTool as a0, type CMSPluginOptions as a1, type CMSPlugin as a2, cmsPlugin as a3, type CMSCheck as a4, type CheckResult as a5, type CheckContext as a6, type CheckStatus as a7, translationsCheck as a8, type TranslationsCheckOptions as a9, type CMSService as aa, type CMSServiceContext as ab, type CMSNotificationService as ac, type NotificationResult as ad, type NotificationServiceContext as ae, type CMSTranslationService as af, type TranslationExportResult as ag, type TranslationImportResult as ah, type TranslationRow as ai, type TranslationServiceContext as aj, 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 };
+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 };

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import '@blinkk/root';
 import 'firebase-admin/app';
 import 'firebase-admin/firestore';
-export { A as Action, r as ArrayObject, F as BatchRequest, B as BatchRequestOptions, y as BatchRequestQuery, z as BatchRequestQueryOptions, I as BatchResponse, C as CronUnit, d as DataSource, c as DataSourceCron, e as DataSourceData, f as DataSourceMode, b as Doc, D as DocMode, j as GetCountOptions, G as GetDocOptions, H as HttpMethod, m as ListActionsOptions, i as ListDocsOptions, L as LoadTranslationsOptions, a as LocaleTranslations, l as Release, R as RootCMSClient, g as SaveDraftOptions, S as SetDocOptions, k as Translation, E as TranslationsDoc, T as TranslationsMap, h as UpdateDraftOptions, U as UserRole, o as getCmsPlugin, n as isRichTextData, s as marshalArray, p as marshalData, q as normalizeData, x as parseDocId, t as toArrayObject, w as translationsForLocale, v as unmarshalArray, u as unmarshalData } from './client-DdB4xpM6.js';
-import './schema-rjBOZk-j.js';
+export { A as Action, r as ArrayObject, F as BatchRequest, B as BatchRequestOptions, y as BatchRequestQuery, z as BatchRequestQueryOptions, I as BatchResponse, C as CronUnit, d as DataSource, c as DataSourceCron, e as DataSourceData, f as DataSourceMode, b as Doc, D as DocMode, j as GetCountOptions, G as GetDocOptions, H as HttpMethod, m as ListActionsOptions, i as ListDocsOptions, L as LoadTranslationsOptions, a as LocaleTranslations, l as Release, R as RootCMSClient, g as SaveDraftOptions, S as SetDocOptions, k as Translation, E as TranslationsDoc, T as TranslationsMap, h as UpdateDraftOptions, U as UserRole, o as getCmsPlugin, n as isRichTextData, s as marshalArray, p as marshalData, q as normalizeData, x as parseDocId, t as toArrayObject, w as translationsForLocale, v as unmarshalArray, u as unmarshalData } from './client-1puwLgNx.js';
+import './schema-Db_xODoi.js';

package/dist/client.js

@@ -12,7 +12,8 @@ import {
   translationsForLocale,
   unmarshalArray,
   unmarshalData
-} from "./chunk-SNZ4S4IC.js";
+} from "./chunk-F4SODS5S.js";
+import "./chunk-CRK7N6RR.js";
 import "./chunk-MLKGABMK.js";
 export {
   BatchRequest,

package/dist/core.d.ts

@@ -1,8 +1,8 @@
-import { R as RootCMSClient, D as DocMode, L as LoadTranslationsOptions, T as TranslationsMap, a as LocaleTranslations } from './client-DdB4xpM6.js';
-export { A as Action, r as ArrayObject, F as BatchRequest, B as BatchRequestOptions, y as BatchRequestQuery, z as BatchRequestQueryOptions, I as BatchResponse, C as CronUnit, d as DataSource, c as DataSourceCron, e as DataSourceData, f as DataSourceMode, b as Doc, j as GetCountOptions, G as GetDocOptions, H as HttpMethod, m as ListActionsOptions, i as ListDocsOptions, J as Locale, Q as MultiLocaleTranslationsMap, l as Release, g as SaveDraftOptions, S as SetDocOptions, V as SingleLocaleTranslationsMap, K as SourceString, M as TranslatedString, k as Translation, E as TranslationsDoc, N as TranslationsDocMode, P as TranslationsLocaleDocEntry, O as TranslationsLocaleDocHashMap, W as TranslationsManager, h as UpdateDraftOptions, U as UserRole, X as buildTranslationsDbPath, Y as buildTranslationsLocaleDocDbPath, o as getCmsPlugin, n as isRichTextData, s as marshalArray, p as marshalData, q as normalizeData, x as parseDocId, t as toArrayObject, w as translationsForLocale, v as unmarshalArray, u as unmarshalData } from './client-DdB4xpM6.js';
+import { R as RootCMSClient, D as DocMode, L as LoadTranslationsOptions, T as TranslationsMap, a as LocaleTranslations } from './client-1puwLgNx.js';
+export { A as Action, r as ArrayObject, F as BatchRequest, B as BatchRequestOptions, y as BatchRequestQuery, z as BatchRequestQueryOptions, I as BatchResponse, C as CronUnit, d as DataSource, c as DataSourceCron, e as DataSourceData, f as DataSourceMode, b as Doc, j as GetCountOptions, G as GetDocOptions, H as HttpMethod, m as ListActionsOptions, i as ListDocsOptions, J as Locale, Q as MultiLocaleTranslationsMap, l as Release, g as SaveDraftOptions, S as SetDocOptions, V as SingleLocaleTranslationsMap, K as SourceString, M as TranslatedString, k as Translation, E as TranslationsDoc, N as TranslationsDocMode, P as TranslationsLocaleDocEntry, O as TranslationsLocaleDocHashMap, W as TranslationsManager, h as UpdateDraftOptions, U as UserRole, X as buildTranslationsDbPath, Y as buildTranslationsLocaleDocDbPath, o as getCmsPlugin, n as isRichTextData, s as marshalArray, p as marshalData, q as normalizeData, x as parseDocId, t as toArrayObject, w as translationsForLocale, v as unmarshalArray, u as unmarshalData } from './client-1puwLgNx.js';
 import { Request, RootConfig, Response, RouteParams, GetStaticProps, GetStaticPaths } from '@blinkk/root';
 import { Query } from 'firebase-admin/firestore';
-export { s as schema } from './schema-rjBOZk-j.js';
+export { s as schema } from './schema-Db_xODoi.js';
 import 'firebase-admin/app';
 
 /**

package/dist/core.js

@@ -16,7 +16,8 @@ import {
   translationsForLocale,
   unmarshalArray,
   unmarshalData
-} from "./chunk-SNZ4S4IC.js";
+} from "./chunk-F4SODS5S.js";
+import "./chunk-CRK7N6RR.js";
 import {
   __export
 } from "./chunk-MLKGABMK.js";

package/dist/functions.js

@@ -1,7 +1,8 @@
 import {
   runCronJobs
-} from "./chunk-UTSL2E2P.js";
-import "./chunk-SNZ4S4IC.js";
+} from "./chunk-TRM4MQHU.js";
+import "./chunk-F4SODS5S.js";
+import "./chunk-CRK7N6RR.js";
 import "./chunk-MLKGABMK.js";
 
 // core/functions.ts

package/dist/{generate-types-MHWSSOWV.js → generate-types-SPV7I3A5.js}

@@ -1,7 +1,7 @@
 import {
   generateSchemaDts,
   generateTypes
-} from "./chunk-KDXHFMIH.js";
+} from "./chunk-XLX37FRL.js";
 import "./chunk-MLKGABMK.js";
 export {
   generateSchemaDts,

package/dist/plugin.d.ts

@@ -1,5 +1,5 @@
 import '@blinkk/root';
 import 'firebase-admin/app';
 import 'firebase-admin/firestore';
-export { $ as CMSAIConfig, Z as CMSBuiltInSidebarTool, a4 as CMSCheck, ac as CMSNotificationService, a2 as CMSPlugin, a1 as CMSPluginOptions, aa as CMSService, ab as CMSServiceContext, a0 as CMSSidebarTool, af as CMSTranslationService, _ as CMSUser, a6 as CheckContext, a5 as CheckResult, a7 as CheckStatus, ad as NotificationResult, ae as NotificationServiceContext, ag as TranslationExportResult, ah as TranslationImportResult, ai as TranslationRow, aj as TranslationServiceContext, a9 as TranslationsCheckOptions, a3 as cmsPlugin, a8 as translationsCheck } from './client-DdB4xpM6.js';
-import './schema-rjBOZk-j.js';
+export { a5 as AiConfig, a6 as AiModelConfig, a7 as AiProvider, $ as CMSAIConfig, Z as CMSBuiltInSidebarTool, a8 as CMSCheck, ag as CMSNotificationService, a3 as CMSPlugin, a2 as CMSPluginOptions, a0 as CMSSearchIndexConfig, ae as CMSService, af as CMSServiceContext, a1 as CMSSidebarTool, aj as CMSTranslationService, _ as CMSUser, aa as CheckContext, a9 as CheckResult, ab as CheckStatus, ah as NotificationResult, ai as NotificationServiceContext, ak as TranslationExportResult, al as TranslationImportResult, am as TranslationRow, an as TranslationServiceContext, ad as TranslationsCheckOptions, a4 as cmsPlugin, ac as translationsCheck } from './client-1puwLgNx.js';
+import './schema-Db_xODoi.js';