@blinkk/root-cms 3.0.1 → 3.0.3

package/dist/core/api.d.ts

@@ -0,0 +1,21 @@
+import { Server, Request } from '@blinkk/root';
+import { type CMSCheck } from './checks.js';
+import { type CMSTranslationService } from './translations.js';
+type AppModule = typeof import('./app.js');
+export interface ApiOptions {
+    getRenderer: (req: Request) => Promise<AppModule>;
+    /** Checks registered via the CMS plugin config. */
+    checks?: CMSCheck[];
+    /**
+     * Translation services registered via the CMS plugin config.
+     *
+     * NOTE: The translations feature is considered a "beta" feature, its interface
+     * may change from version to version as we add new features.
+     */
+    translations?: CMSTranslationService[];
+}
+/**
+ * Registers API middleware handlers.
+ */
+export declare function api(server: Server, options: ApiOptions): void;
+export {};

package/dist/core/app.d.ts

@@ -0,0 +1,16 @@
+import { Request, Response, RootConfig } from '@blinkk/root';
+import { CMSPluginOptions } from './plugin.js';
+import { Collection } from './schema.js';
+interface RenderOptions {
+    rootConfig: RootConfig;
+    cmsConfig: CMSPluginOptions;
+}
+export declare function renderApp(req: Request, res: Response, options: RenderOptions): Promise<void>;
+export declare function renderSignIn(req: Request, res: Response, options: RenderOptions): Promise<void>;
+export declare function getCollections(): Promise<Record<string, Collection>>;
+/**
+ * Returns a collection's schema definition as defined in
+ * `/collections/<id>.schema.ts`.
+ */
+export declare function getCollection(collectionId: string): Promise<Collection | null>;
+export {};

package/dist/core/checks-translations.d.ts

@@ -0,0 +1,13 @@
+import { type CMSCheck } from './checks.js';
+export 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.
+ */
+export declare function translationsCheck(options?: TranslationsCheckOptions): CMSCheck;

package/dist/core/checks.d.ts

@@ -0,0 +1,48 @@
+import { RootConfig } from '@blinkk/root';
+import { RootCMSClient } from './client.js';
+import * as schema from './schema.js';
+/** The result status of a check. */
+export type CheckStatus = 'success' | 'warning' | 'error';
+/** Result returned by a check function after execution. */
+export 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. */
+export 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: schema.Collection | null;
+}
+/** Configuration for defining a CMS check. */
+export 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>;
+}