@riverbankcms/sdk 0.129.0 → 0.129.1

package/dist/_dts/sdk/src/cli/merge-remote/sharedBaseSnapshots.d.ts

@@ -1,32 +0,0 @@
-import type { EnvTarget } from '../helpers';
-export type BaseSnapshotTarget = Readonly<{
-    env: EnvTarget;
-    siteId: string;
-}>;
-export type BaseSnapshotStoredTarget = Readonly<{
-    env: EnvTarget;
-    siteIdHash: string;
-}>;
-export type WriteBaseSnapshotsInput<TItem, TSnapshot> = Readonly<{
-    contentDir: string;
-    rootDir: string;
-    snapshotDir: string;
-    items: readonly TItem[];
-    toSnapshot(item: TItem): TSnapshot;
-    fileNameForSnapshot(snapshot: TSnapshot): string;
-    cleanupMissing?: boolean;
-}>;
-export type WriteBaseSnapshotsResult = Readonly<{
-    rootDir: string;
-    count: number;
-}>;
-export declare function baseSnapshotRoot(contentDir: string, baseKind: string): string;
-export declare function baseSnapshotStoredTarget(target: BaseSnapshotTarget): BaseSnapshotStoredTarget;
-export declare function siteScopedSnapshotDir(input: Readonly<{
-    rootDir: string;
-    target: BaseSnapshotTarget;
-    leafDir: string;
-}>): string;
-export declare function writeBaseSnapshots<TItem, TSnapshot>(input: WriteBaseSnapshotsInput<TItem, TSnapshot>): Promise<WriteBaseSnapshotsResult>;
-export declare function readBaseSnapshot<TSnapshot>(snapshotPath: string): Promise<TSnapshot | null>;
-export declare function encodeSnapshotPathPart(value: string): string;

package/dist/_dts/sdk/src/cli/merge-remote/sharedMergePlan.d.ts

@@ -1,27 +0,0 @@
-export type RemoteMergePlanCore<TDecision, TSummary> = Readonly<{
-    decisions: readonly TDecision[];
-    summary: TSummary;
-}>;
-export type RemoteMergePlanConfig<TSubject, TBaseSnapshot, TValue, TDecision, TSummary> = Readonly<{
-    subjects(): readonly TSubject[];
-    readBaseSnapshot(subject: TSubject): Promise<TBaseSnapshot | null>;
-    valueFromBaseSnapshot(snapshot: TBaseSnapshot): TValue | null;
-    localValue(subject: TSubject): TValue | null;
-    remoteValue(subject: TSubject): TValue | null;
-    planDecision(input: Readonly<{
-        subject: TSubject;
-        base: TValue | null;
-        local: TValue | null;
-        remote: TValue | null;
-    }>): TDecision;
-    summarize(decisions: readonly TDecision[]): TSummary;
-}>;
-export declare function buildRemoteMergePlanWithConfig<TSubject, TBaseSnapshot, TValue, TDecision, TSummary>(config: RemoteMergePlanConfig<TSubject, TBaseSnapshot, TValue, TDecision, TSummary>): Promise<RemoteMergePlanCore<TDecision, TSummary>>;
-export type DecisionSummaryKeyMap<TDecisionKind extends string, TSummary> = Readonly<Record<TDecisionKind, NumericKeys<TSummary>>>;
-type NumericKeys<TValue> = {
-    [TKey in keyof TValue]: TValue[TKey] extends number ? TKey : never;
-}[keyof TValue];
-export declare function summarizeMergeDecisions<TDecisionKind extends string, TDecision extends {
-    kind: TDecisionKind;
-}, TSummary>(decisions: readonly TDecision[], initialSummary: TSummary, summaryKeyByDecisionKind: DecisionSummaryKeyMap<TDecisionKind, TSummary>): TSummary;
-export {};

package/dist/_dts/sdk/src/cli/merge-remote/sharedMergeReport.d.ts

@@ -1,63 +0,0 @@
-import type { OutputContext } from '../output';
-type MergeDecisionSubject<TSubject> = Readonly<{
-    kind: string;
-    subject: TSubject;
-}>;
-type ConflictCode<TDecision> = Extract<TDecision, {
-    kind: 'conflict';
-}> extends {
-    conflict: {
-        code: infer TCode extends string;
-    };
-} ? TCode : string;
-type ReportDecisionLineKind<TDecision extends {
-    kind: string;
-}> = Exclude<TDecision['kind'], 'auto_merge' | 'conflict' | 'unchanged'>;
-export type RemoteMergeDecisionLabels<TDecision extends {
-    kind: string;
-}> = {
-    readonly [TKind in ReportDecisionLineKind<TDecision>]: string;
-};
-export type RemoteMergeDecisionReport<TDecision extends {
-    kind: string;
-}, TSubjectJson extends object> = Readonly<{
-    kind: TDecision['kind'];
-} & TSubjectJson & {
-    localFieldPaths?: readonly string[];
-    remoteFieldPaths?: readonly string[];
-    conflict?: Readonly<{
-        code: ConflictCode<TDecision>;
-        fieldPath?: string;
-        message: string;
-    }>;
-}>;
-export type RemoteMergeJsonReport<TScope extends string, TSummary, TDecision extends {
-    kind: string;
-}, TSubjectJson extends object> = Readonly<{
-    kind: 'push';
-    scope: TScope;
-    mergeRemote: true;
-    dryRun: boolean;
-    summary: TSummary;
-    decisions: readonly RemoteMergeDecisionReport<TDecision, TSubjectJson>[];
-}>;
-export type RemoteMergeReportConfig<TScope extends string, TSummary, TSubject, TSubjectJson extends object, TDecision extends MergeDecisionSubject<TSubject>> = Readonly<{
-    scope: TScope;
-    title: string;
-    summaryLines(summary: TSummary): readonly string[];
-    subjectLabel(subject: TSubject): string;
-    subjectJson(subject: TSubject): TSubjectJson;
-    decisionLabels: RemoteMergeDecisionLabels<TDecision>;
-}>;
-export declare function remoteMergeJsonReport<TScope extends string, TSummary, TSubject, TSubjectJson extends object, TDecision extends MergeDecisionSubject<TSubject>>(input: Readonly<{
-    config: RemoteMergeReportConfig<TScope, TSummary, TSubject, TSubjectJson, TDecision>;
-    decisions: readonly TDecision[];
-    dryRun: boolean;
-    summary: TSummary;
-}>): RemoteMergeJsonReport<TScope, TSummary, TDecision, TSubjectJson>;
-export declare function writeRemoteMergeHumanReport<TScope extends string, TSummary, TSubject, TSubjectJson extends object, TDecision extends MergeDecisionSubject<TSubject>>(output: Pick<OutputContext, 'info'>, config: RemoteMergeReportConfig<TScope, TSummary, TSubject, TSubjectJson, TDecision>, input: Readonly<{
-    decisions: readonly TDecision[];
-    dryRun: boolean;
-    summary: TSummary;
-}>): void;
-export {};

package/dist/_dts/sdk/src/cli/migrations/entries.d.ts

@@ -1,28 +0,0 @@
-/**
- * Entries Migration Utilities
- *
- * Supports migrating legacy SDK entry file formats to the canonical on-disk format:
- *   content/entries/<contentType>/<identifier>.json
- *
- * Also removes the legacy top-level `title` field from entry JSON files and migrates it
- * into `data.title` when possible.
- */
-export interface MigrateEntriesOptions {
-    contentDir: string;
-    /** Limit migration to a single content type */
-    contentType?: string;
-    /** Preview changes without writing or moving files */
-    dryRun?: boolean;
-    /** Overwrite existing entry files if they differ */
-    force?: boolean;
-}
-export interface MigrateEntriesResult {
-    legacyFilesFound: number;
-    legacyFilesMigrated: number;
-    legacyFilesBackedUp: number;
-    entriesWritten: number;
-    entryFilesScanned: number;
-    legacyTitleFilesUpdated: number;
-    legacyTitlesMigratedToDataTitle: number;
-}
-export declare function migrateEntries(options: MigrateEntriesOptions): Promise<MigrateEntriesResult>;

package/dist/_dts/sdk/src/cli/migrations/events.d.ts

@@ -1,73 +0,0 @@
-import { type LocalEvent } from '../content/reader';
-export type EventMigrationPlanItem = Readonly<{
-    tag: 'mergeLegacyIntoEvent';
-    legacyFilePath: string;
-    eventFilePath: string;
-    eventIdentifier: string;
-    mergedEvent: LocalEvent;
-    mergedFields: readonly string[];
-}> | Readonly<{
-    tag: 'archiveLegacyOnly';
-    legacyFilePath: string;
-    eventFilePath: string;
-    eventIdentifier: string;
-    reason: string;
-}> | Readonly<{
-    tag: 'conflict';
-    legacyFilePath: string;
-    eventIdentifier: string;
-    conflicts: readonly string[];
-}> | Readonly<{
-    tag: 'ambiguousMatch';
-    legacyFilePath: string;
-    candidateEventIdentifiers: readonly string[];
-}> | Readonly<{
-    tag: 'unmappableLegacyFields';
-    legacyFilePath: string;
-    eventIdentifier?: string;
-    fields: readonly string[];
-}> | Readonly<{
-    tag: 'orphanedLegacy';
-    legacyFilePath: string;
-    legacyIdentifier: string;
-    reason: string;
-}> | Readonly<{
-    tag: 'invalidLegacyShape';
-    legacyFilePath: string;
-    reason: string;
-}>;
-export type WritableEventMigrationPlanItem = Extract<EventMigrationPlanItem, {
-    tag: 'mergeLegacyIntoEvent' | 'archiveLegacyOnly';
-}>;
-export type BlockedEventMigrationPlanItem = Exclude<EventMigrationPlanItem, WritableEventMigrationPlanItem>;
-export type EventMigrationPlan = Readonly<{
-    tag: 'writable';
-    contentDir: string;
-    items: readonly WritableEventMigrationPlanItem[];
-}> | Readonly<{
-    tag: 'blocked';
-    contentDir: string;
-    items: readonly EventMigrationPlanItem[];
-    blockers: readonly BlockedEventMigrationPlanItem[];
-}>;
-export type MigrateEventsResult = Readonly<{
-    status: 'writable' | 'blocked';
-    legacyFilesFound: number;
-    eventsToWrite: number;
-    legacyFilesToArchive: number;
-    merged: number;
-    archiveOnly: number;
-    conflicts: number;
-    ambiguous: number;
-    unmappable: number;
-    orphaned: number;
-    invalid: number;
-    dryRun: boolean;
-    items: readonly EventMigrationPlanItem[];
-}>;
-export type MigrateEventsOptions = Readonly<{
-    contentDir: string;
-    dryRun?: boolean;
-}>;
-export declare function planEventMigration(contentDir: string): Promise<EventMigrationPlan>;
-export declare function migrateEvents(options: MigrateEventsOptions): Promise<MigrateEventsResult>;

package/dist/_dts/sdk/src/cli/navigationIdentity.d.ts

@@ -1,11 +0,0 @@
-import { navigationMenuIdentity, type NavigationMenuIdentity, type NavigationMenuIdentityInput } from '../../../api/src/navigation';
-import { type Result } from '../../../core/src/index';
-export type NavigationIdentityInput = NavigationMenuIdentityInput;
-export type DuplicateNavigationIdentityError = Readonly<{
-    code: 'duplicate_navigation_identity';
-    identity: NavigationMenuIdentity;
-    menuNames: readonly string[];
-}>;
-export declare const navigationIdentity: typeof navigationMenuIdentity;
-export declare function navigationIdentityMap<T extends NavigationIdentityInput>(menus: readonly T[]): Result<ReadonlyMap<NavigationMenuIdentity, T>, DuplicateNavigationIdentityError>;
-export declare function duplicateNavigationIdentityMessage(error: DuplicateNavigationIdentityError): string;

package/dist/_dts/sdk/src/cli/output.d.ts

@@ -1,133 +0,0 @@
-/**
- * CLI Output Formatting
- *
- * Provides consistent output formatting for CLI commands.
- *
- * ## Single JSON envelope contract (Phase 7.1)
- *
- * Under `--json`, EVERY command emits EXACTLY ONE JSON document on stdout:
- *
- *   { ok: boolean, command: string, result: <command-specific>, warnings: [...], errors: [...] }
- *
- * This is enforced structurally: in JSON mode the terminal output methods
- * (`success`/`result`/`json`/`table`) do NOT print — they buffer their payload
- * into the invocation's {@link InvocationEnvelope}. `warn` appends to `warnings`,
- * `error`/`fail` append to `errors`. A single writer (`InvocationEnvelope.flush`)
- * emits the one envelope: on success via the program's `postAction` hook, on
- * failure via `error()` (which throws `CliExit` so `runCli` owns the exit code),
- * and for parse/help/version via `runCli` itself. Commands can therefore never
- * double-print a JSON document, no matter how many output calls they make.
- *
- * Human (non-`--json`) output is unchanged.
- */
-/** A structured warning or error entry inside the JSON envelope. */
-export interface EnvelopeMessage {
-    message: string;
-    code?: string;
-    details?: unknown;
-    suggestion?: unknown;
-}
-/**
- * The single machine-readable document emitted per invocation under `--json`.
- *
- * Closed discriminated final state: an `ok: false` envelope ALWAYS carries at
- * least one typed error (`errors` is a non-empty tuple), and an `ok: true`
- * envelope never carries errors. The invariant is enforced by
- * {@link InvocationEnvelope.flush}, so `{ ok: false, errors: [] }` is
- * unrepresentable in the emitted output.
- */
-export type JsonEnvelope = {
-    ok: true;
-    command: string;
-    result: unknown;
-    warnings: EnvelopeMessage[];
-    errors: [];
-} | {
-    ok: false;
-    command: string;
-    result: unknown;
-    warnings: EnvelopeMessage[];
-    errors: [EnvelopeMessage, ...EnvelopeMessage[]];
-};
-/**
- * Raised by `output.error` (and mapped by `runCli`) to terminate a command with a
- * non-zero exit code WITHOUT calling `process.exit` inside command code — so the
- * single envelope is always flushed first and the exit code is owned in one place.
- */
-export declare class CliExit extends Error {
-    readonly code: number;
-    constructor(code: number);
-}
-/**
- * Accumulates the single JSON envelope for ONE CLI invocation. Created once per
- * invocation (owned by the fresh root program) and threaded to every command's
- * output, so all output — success, warnings, errors, and even parse/help/version
- * handled by `runCli` — funnels into one document. `flush()` is idempotent and is
- * the ONLY writer of the stdout JSON.
- */
-export declare class InvocationEnvelope {
-    private resultValue;
-    private failed;
-    private readonly warnings;
-    private readonly errors;
-    private flushed;
-    setResult(value: unknown): void;
-    addWarning(warning: EnvelopeMessage): void;
-    addError(error: EnvelopeMessage): void;
-    markFailed(): void;
-    hasFlushed(): boolean;
-    /** True once at least one error has been recorded or a failure marked. */
-    isFailed(): boolean;
-    private finalState;
-    /** Emit the single envelope. Idempotent: subsequent calls are no-ops. */
-    flush(command: string): void;
-}
-export interface OutputOptions {
-    /** Output in JSON format for machine parsing */
-    json?: boolean;
-    /** Minimal output (suppress non-essential messages) */
-    quiet?: boolean;
-    /**
-     * In JSON mode, the invocation-scoped envelope all terminal output funnels into
-     * so exactly one document is emitted. Always supplied by `createOutputForCommand`
-     * in JSON mode; if absent, JSON-mode terminal writes are dropped (never a stray
-     * second document).
-     */
-    envelope?: InvocationEnvelope;
-    /** Full command path (e.g. "entry upsert") for the envelope's `command` field. */
-    command?: string;
-}
-export interface OutputContext {
-    success(message: string, data?: unknown): void;
-    /**
-     * Non-fatal failure output. Does not exit the process.
-     * Use when the command should continue but should still be considered failed overall.
-     */
-    fail(message: string, data?: unknown): void;
-    /**
-     * Emit a single "final" result. In JSON mode this prints one JSON envelope to stdout.
-     * In human mode this maps to success/fail formatting.
-     */
-    result(success: boolean, message: string, data?: unknown): void;
-    error(message: string, details?: unknown): never;
-    warn(message: string, data?: unknown): void;
-    info(message: string, data?: unknown): void;
-    table(headers: string[], rows: string[][]): void;
-    json(data: unknown): void;
-    progress(current: number, total: number, message: string): void;
-}
-/**
- * Create output context for CLI command
- *
- * @param options - Output options
- * @returns Output context with formatting methods
- */
-export declare function createOutput(options: OutputOptions): OutputContext;
-/**
- * Format file size for display
- */
-export declare function formatSize(bytes: number): string;
-/**
- * Format duration for display
- */
-export declare function formatDuration(ms: number): string;

package/dist/_dts/sdk/src/cli/program.d.ts

@@ -1,29 +0,0 @@
-/**
- * Riverbank CMS SDK CLI — program construction and invocation.
- *
- * `createProgram()` builds the full Commander command tree; `runCli()` drives it
- * so that under `--json` EXACTLY ONE envelope reaches stdout for EVERY outcome,
- * including the paths Commander itself owns — parse errors, `--help`, and
- * `--version` (which would otherwise bypass command actions entirely).
- *
- * `runCli`:
- *  - runs `parseAsync` inside an AsyncLocalStorage invocation scope so all output
- *    (actions, and the parse/help/version handling below) funnels into ONE
- *    envelope, isolated per concurrent invocation;
- *  - installs `exitOverride` + `configureOutput` on every command so Commander's
- *    exits and its help/version/error text are intercepted rather than written
- *    raw or exiting the process; and
- *  - owns the process exit code (commands never call `process.exit`).
- */
-import { Command } from 'commander';
-export declare function createProgram(): Command;
-/**
- * Parse and run the CLI. Returns the process exit code (the caller sets
- * `process.exitCode`); it never calls `process.exit` itself, so it is safe to
- * drive from tests. Under `--json`, exactly one envelope is written to stdout for
- * every outcome — success, non-fatal failure, thrown error, parse error, `--help`,
- * and `--version`.
- */
-export declare function runCli(argv: string[], options?: {
-    program?: Command;
-}): Promise<number>;

package/dist/_dts/sdk/src/cli/push-config.d.ts

@@ -1,49 +0,0 @@
-/**
- * push-config CLI command
- *
- * Pushes SDK site configuration from a riverbank.config.ts file to the dashboard API.
- */
-import { Command } from 'commander';
-import type { OutputContext } from './output';
-import type { APIEndpoints } from '../../../api/src/public/index';
-interface PushConfigOptions {
-    config?: string;
-    apiKey?: string;
-    dashboard: string;
-    forceContentTypes?: boolean;
-    dryRun?: boolean;
-}
-export type PushConfigActionResult = Readonly<{
-    success: true;
-}> | Readonly<{
-    success: false;
-}>;
-type PushConfigResponse = NonNullable<APIEndpoints['pushSdkConfig']['response']>;
-type PushConfigSync = NonNullable<PushConfigResponse['configSync']>;
-type LegacyPushConfigSync = NonNullable<PushConfigResponse['sync']>;
-type PushConfigDisplaySync = PushConfigSync | LegacyPushConfigSync;
-type PushConfigSyncArea = 'contentTypes' | 'customBlocks' | 'templateBlocks' | 'settings' | 'ignoredDocuments' | 'pages' | 'entries' | 'navigationMenus';
-export type PushConfigSyncMessage = {
-    area: PushConfigSyncArea;
-    message: string;
-};
-export declare function collectPushConfigSyncErrors(sync: PushConfigDisplaySync): PushConfigSyncMessage[];
-export declare function collectPushConfigSyncWarnings(sync: PushConfigDisplaySync): PushConfigSyncMessage[];
-export declare function groupPushConfigSyncWarningsForHuman(warnings: readonly PushConfigSyncMessage[]): PushConfigSyncMessage[];
-export declare function isPushConfigActionSuccess(result: PushConfigActionResult): result is Extract<PushConfigActionResult, {
-    success: true;
-}>;
-export declare function markFailedPushConfigCommandResult(result: PushConfigActionResult): void;
-/**
- * Main push-config action.
- * Exported for reuse by `push --with-config`.
- */
-export declare function pushConfigAction(output: OutputContext, options: PushConfigOptions & {
-    isRemote: boolean;
-    isJsonOutput?: boolean;
-}): Promise<PushConfigActionResult>;
-/**
- * push-config command definition
- */
-export declare const createPushConfigCommand: () => Command;
-export {};

package/dist/_dts/sdk/src/cli/setup/setupPlan.d.ts

@@ -1,51 +0,0 @@
-import type { EnvTarget } from '../helpers';
-export type SetupOperation = 'create_site' | 'create_management_key' | 'grant_user_access' | 'configure_env' | 'verify_access';
-export type SetupAuthority = 'dashboard_admin' | 'cms_repo_script' | 'sdk_management_key';
-export type SetupPlanStep = Readonly<{
-    tag: 'admin_action';
-    operation: Exclude<SetupOperation, 'configure_env' | 'verify_access'>;
-    title: string;
-    detail: string;
-    allowedAuthorities: readonly Exclude<SetupAuthority, 'sdk_management_key'>[];
-}> | Readonly<{
-    tag: 'local_env';
-    operation: 'configure_env';
-    title: string;
-    detail: string;
-    missingVariables: readonly string[];
-    exampleLines: readonly string[];
-}> | Readonly<{
-    tag: 'cli_check';
-    operation: 'verify_access';
-    title: string;
-    detail: string;
-    commands: readonly string[];
-}>;
-export type SetupCapability = Readonly<{
-    authority: 'dashboard_admin';
-    can: readonly ('create_site' | 'create_management_key' | 'grant_user_access')[];
-}> | Readonly<{
-    authority: 'cms_repo_script';
-    can: readonly ('create_site' | 'create_management_key' | 'grant_user_access')[];
-    requirement: string;
-}> | Readonly<{
-    authority: 'sdk_management_key';
-    can: readonly ('verify_access')[];
-    cannot: readonly ('create_site' | 'create_management_key' | 'grant_user_access')[];
-}>;
-export interface SetupTargetStatus {
-    target: EnvTarget;
-    siteId: string | null;
-    dashboardUrl: string | null;
-    managementApiKeySet: boolean;
-}
-export interface SdkSetupPlan {
-    target: EnvTarget;
-    configured: boolean;
-    canMutatePrivilegedResources: false;
-    capabilities: readonly SetupCapability[];
-    steps: readonly SetupPlanStep[];
-    securityNotes: readonly string[];
-}
-export declare function planSdkSetup(status: SetupTargetStatus): SdkSetupPlan;
-export declare function formatSdkSetupPlan(plan: SdkSetupPlan): string;

package/dist/_dts/sdk/src/cli/site-commands/commandKeys.d.ts

@@ -1,13 +0,0 @@
-import type { Brand } from '../../../../core/src/index';
-export type CliContentTypeKey = Brand<string, 'SdkCliContentTypeKey'>;
-export type CliEntryIdentifier = Brand<string, 'SdkCliEntryIdentifier'>;
-export type CliPageIdentifier = Brand<string, 'SdkCliPageIdentifier'>;
-export type CliBlockIdentifier = Brand<string, 'SdkCliBlockIdentifier'>;
-export type CliFormSlug = Brand<string, 'SdkCliFormSlug'>;
-export type CliNavigationMenuName = Brand<string, 'SdkCliNavigationMenuName'>;
-export declare const unsafeAsCliContentTypeKey: (value: string) => CliContentTypeKey;
-export declare const unsafeAsCliEntryIdentifier: (value: string) => CliEntryIdentifier;
-export declare const unsafeAsCliPageIdentifier: (value: string) => CliPageIdentifier;
-export declare const unsafeAsCliBlockIdentifier: (value: string) => CliBlockIdentifier;
-export declare const unsafeAsCliFormSlug: (value: string) => CliFormSlug;
-export declare const unsafeAsCliNavigationMenuName: (value: string) => CliNavigationMenuName;