@fern-api/generator-cli 0.5.2 → 0.6.0

package/dist/api.d.ts

@@ -1,9 +1,7 @@
+import { BootstrapResult, ReplayReport } from '@fern-api/replay';
+export { ConflictDetail, ReplayReport } from '@fern-api/replay';
 import fs from 'fs';
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
 /**
  * A unique identifier for a feature (e.g. OPTIONALS). This is typed as a freeform string
  * to allow for arbitrary features, but callers are expected to use the StructuredFeatureId
@@ -12,13 +10,19 @@ import fs from 'fs';
 type FeatureId = string | StructuredFeatureId;
 
 /**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Unique identifiers for features that can be demonstrated with snippets.
+ * A specification for a feature supported by a generator. This includes the
+ * feature's ID, a description, and any additional information that should be
+ * included in the README.md.
  */
-type StructuredFeatureId = "AUTHENTICATION" | "ERRORS" | "USAGE" | "PAGINATION" | "RETRIES" | "REQUEST_OPTIONS" | "STREAMING" | "TIMEOUTS" | "CUSTOM_CLIENT" | "CONTRIBUTING";
-declare const StructuredFeatureId: {
+interface FeatureSpec {
+    id: FeatureId;
+    description?: string;
+    addendum?: string;
+    advanced?: boolean;
+}
+
+/** Unique identifiers for features that can be demonstrated with snippets. */
+declare const StructuredFeatureIdValues: {
     readonly Authentication: "AUTHENTICATION";
     readonly Errors: "ERRORS";
     readonly Usage: "USAGE";
@@ -29,7 +33,10 @@ declare const StructuredFeatureId: {
     readonly Timeouts: "TIMEOUTS";
     readonly CustomClient: "CUSTOM_CLIENT";
     readonly Contributing: "CONTRIBUTING";
-    readonly _visit: <R>(value: StructuredFeatureId, visitor: StructuredFeatureId.Visitor<R>) => R;
+};
+type StructuredFeatureId = (typeof StructuredFeatureIdValues)[keyof typeof StructuredFeatureIdValues];
+declare const StructuredFeatureId: typeof StructuredFeatureIdValues & {
+    _visit: <R>(value: StructuredFeatureId, visitor: StructuredFeatureId.Visitor<R>) => R;
 };
 declare namespace StructuredFeatureId {
     interface Visitor<R> {
@@ -47,25 +54,6 @@ declare namespace StructuredFeatureId {
     }
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-/**
- * A specification for a feature supported by a generator. This includes the
- * feature's ID, a description, and any additional information that should be
- * included in the README.md.
- */
-interface FeatureSpec {
-    id: FeatureId;
-    description?: string;
-    addendum?: string;
-    advanced?: boolean;
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * The configuration used to interact with a GitHub repository.
  */
@@ -80,42 +68,30 @@ interface GitHubConfig {
     branch?: string;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+interface CargoPublishInfo {
+    packageName: string;
+    version: string;
+}
 
 /**
- * The configuration used to generate a README.md file.
- * The information described here is a combination of user-defined information
- * (i.e. specified in the generators.yml), and dynamically generated information
- * that comes from each generator (i.e. features, requirements, and more).
+ * A code snippet that will be wrapped in a code fence with the specified language.
+ * If no language is specified, the generator's language will be used.
  */
-interface ReadmeConfig {
-    /** If specified, the original README.md will be fetched from this remote (if it exists). */
-    remote?: Remote;
-    language: LanguageInfo;
-    organization: string;
-    apiName?: string;
-    bannerLink?: string;
-    introduction?: string;
-    apiReferenceLink?: string;
-    referenceMarkdownPath?: string;
-    requirements?: string[];
-    disabledFeatures?: FeatureId[];
-    whiteLabel?: boolean;
-    customSections?: CustomSection[];
-    /**
-     * Specifies the list of features supported by a specific generator.
-     * The features are rendered in the order they're specified.
-     */
-    features?: ReadmeFeature[];
-    /** Controls whether usage examples show only required parameters (minimal) or all parameters (comprehensive). Defaults to comprehensive. */
-    exampleStyle?: ExampleStyle;
+interface CodeSnippet {
+    /** Discriminator field to identify this as a code snippet. */
+    type: "code";
+    content: string;
+    /** The language for the code fence. If not specified, the generator's language will be used. */
+    language?: string;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+interface ComposerPublishInfo {
+    packageName: string;
+}
+
+interface CsharpInfo {
+    publishInfo?: NugetPublishInfo;
+}
 
 interface CustomSection {
     name: string;
@@ -123,36 +99,23 @@ interface CustomSection {
     content: string;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-/**
- * The remote where the README.md is hosted.
- */
-type Remote = Remote.Github;
-declare namespace Remote {
-    interface Github extends GithubRemote, _Utils {
-        type: "github";
-    }
-    interface _Utils {
-        _visit: <_Result>(visitor: Remote._Visitor<_Result>) => _Result;
-    }
-    interface _Visitor<_Result> {
-        github: (value: GithubRemote) => _Result;
-        _other: (value: {
-            type: string;
-        }) => _Result;
+/** Controls the verbosity of usage examples in README generation */
+declare const ExampleStyleValues: {
+    readonly Minimal: "minimal";
+    readonly Comprehensive: "comprehensive";
+};
+type ExampleStyle = (typeof ExampleStyleValues)[keyof typeof ExampleStyleValues];
+declare const ExampleStyle: typeof ExampleStyleValues & {
+    _visit: <R>(value: ExampleStyle, visitor: ExampleStyle.Visitor<R>) => R;
+};
+declare namespace ExampleStyle {
+    interface Visitor<R> {
+        minimal: () => R;
+        comprehensive: () => R;
+        _other: () => R;
     }
 }
-declare const Remote: {
-    readonly github: (value: GithubRemote) => Remote.Github;
-    readonly _visit: <_Result>(value: Remote, visitor: Remote._Visitor<_Result>) => _Result;
-};
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 interface GithubRemote {
     /** A full repo url (i.e. https://github.com/fern-api/fern) */
     repoUrl: string;
@@ -162,65 +125,20 @@ interface GithubRemote {
     branch?: string;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-/**
- * A single feature supported by a generator (e.g. PAGINATION).
- */
-interface ReadmeFeature extends FeatureSpec {
-    snippets?: Snippet[];
-    /**
-     * If true, the feature block should be rendered even if we don't receive a snippet for it.
-     * This is useful for features that are always supported, but might not require a snippet
-     * to explain.
-     */
-    snippetsAreOptional: boolean;
+interface GoInfo {
+    publishInfo?: GoPublishInfo;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-/**
- * A snippet that can be either a plain string (treated as code in the generator's language),
- * markdown content, or a code block with optional language override.
- * Plain strings are supported for backwards compatibility.
- */
-type Snippet = string | MarkdownSnippet | CodeSnippet;
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * A markdown snippet that will be rendered as-is without code fences.
- */
-interface MarkdownSnippet {
-    /** Discriminator field to identify this as a markdown snippet. */
-    type: "markdown";
-    content: string;
+interface GoPublishInfo {
+    owner: string;
+    repo: string;
+    version: string;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * A code snippet that will be wrapped in a code fence with the specified language.
- * If no language is specified, the generator's language will be used.
- */
-interface CodeSnippet {
-    /** Discriminator field to identify this as a code snippet. */
-    type: "code";
-    content: string;
-    /** The language for the code fence. If not specified, the generator's language will be used. */
-    language?: string;
+interface JavaInfo {
+    publishInfo?: MavenPublishInfo;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
 /**
  * The language and its associated publish information (if any).
  * This is used to generate badges, the installation guide, and determine what language to
@@ -287,206 +205,137 @@ declare const LanguageInfo: {
 };
 
 /**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-interface TypescriptInfo {
-    publishInfo?: NpmPublishInfo;
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-interface PythonInfo {
-    publishInfo?: PypiPublishInfo;
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
+ * A markdown snippet that will be rendered as-is without code fences.
  */
-
-interface GoInfo {
-    publishInfo?: GoPublishInfo;
+interface MarkdownSnippet {
+    /** Discriminator field to identify this as a markdown snippet. */
+    type: "markdown";
+    content: string;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-interface JavaInfo {
-    publishInfo?: MavenPublishInfo;
+interface MavenPublishInfo {
+    artifact: string;
+    group: string;
+    version: string;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-interface RubyInfo {
-    publishInfo?: RubyGemsPublishInfo;
+interface NpmPublishInfo {
+    packageName: string;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-interface CsharpInfo {
-    publishInfo?: NugetPublishInfo;
+interface NugetPublishInfo {
+    packageName: string;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
 interface PhpInfo {
     publishInfo?: ComposerPublishInfo;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-interface RustInfo {
-    publishInfo?: CargoPublishInfo;
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-interface SwiftInfo {
-    publishInfo?: SwiftPackageManagerPublishInfo;
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-interface ComposerPublishInfo {
-    packageName: string;
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-interface NpmPublishInfo {
-    packageName: string;
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 interface PypiPublishInfo {
     packageName: string;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-interface GoPublishInfo {
-    owner: string;
-    repo: string;
-    version: string;
+interface PythonInfo {
+    publishInfo?: PypiPublishInfo;
 }
 
 /**
- * This file was auto-generated by Fern from our API Definition.
+ * The configuration used to generate a README.md file.
+ * The information described here is a combination of user-defined information
+ * (i.e. specified in the generators.yml), and dynamically generated information
+ * that comes from each generator (i.e. features, requirements, and more).
  */
-interface MavenPublishInfo {
-    artifact: string;
-    group: string;
-    version: string;
+interface ReadmeConfig {
+    /** If specified, the original README.md will be fetched from this remote (if it exists). */
+    remote?: Remote;
+    language: LanguageInfo;
+    organization: string;
+    apiName?: string;
+    bannerLink?: string;
+    introduction?: string;
+    apiReferenceLink?: string;
+    referenceMarkdownPath?: string;
+    requirements?: string[];
+    disabledFeatures?: FeatureId[];
+    whiteLabel?: boolean;
+    customSections?: CustomSection[];
+    /**
+     * Specifies the list of features supported by a specific generator.
+     * The features are rendered in the order they're specified.
+     */
+    features?: ReadmeFeature[];
+    /** Controls whether usage examples show only required parameters (minimal) or all parameters (comprehensive). Defaults to comprehensive. */
+    exampleStyle?: ExampleStyle;
 }
 
 /**
- * This file was auto-generated by Fern from our API Definition.
+ * A single feature supported by a generator (e.g. PAGINATION).
  */
-interface RubyGemsPublishInfo {
-    packageName: string;
+interface ReadmeFeature extends FeatureSpec {
+    snippets?: Snippet[];
+    /**
+     * If true, the feature block should be rendered even if we don't receive a snippet for it.
+     * This is useful for features that are always supported, but might not require a snippet
+     * to explain.
+     */
+    snippetsAreOptional: boolean;
 }
 
 /**
- * This file was auto-generated by Fern from our API Definition.
+ * The remote where the README.md is hosted.
  */
-interface NugetPublishInfo {
-    packageName: string;
+type Remote = Remote.Github;
+declare namespace Remote {
+    interface Github extends GithubRemote, _Utils {
+        type: "github";
+    }
+    interface _Utils {
+        _visit: <_Result>(visitor: Remote._Visitor<_Result>) => _Result;
+    }
+    interface _Visitor<_Result> {
+        github: (value: GithubRemote) => _Result;
+        _other: (value: {
+            type: string;
+        }) => _Result;
+    }
 }
+declare const Remote: {
+    readonly github: (value: GithubRemote) => Remote.Github;
+    readonly _visit: <_Result>(value: Remote, visitor: Remote._Visitor<_Result>) => _Result;
+};
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-interface CargoPublishInfo {
+interface RubyGemsPublishInfo {
     packageName: string;
-    version: string;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-interface SwiftPackageManagerPublishInfo {
-    gitUrl: string;
-    minVersion: string;
+interface RubyInfo {
+    publishInfo?: RubyGemsPublishInfo;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * Controls the verbosity of usage examples in README generation
- */
-type ExampleStyle = "minimal" | "comprehensive";
-declare const ExampleStyle: {
-    readonly Minimal: "minimal";
-    readonly Comprehensive: "comprehensive";
-    readonly _visit: <R>(value: ExampleStyle, visitor: ExampleStyle.Visitor<R>) => R;
-};
-declare namespace ExampleStyle {
-    interface Visitor<R> {
-        minimal: () => R;
-        comprehensive: () => R;
-        _other: () => R;
-    }
+interface RustInfo {
+    publishInfo?: CargoPublishInfo;
 }
 
 /**
- * This file was auto-generated by Fern from our API Definition.
+ * A snippet that can be either a plain string (treated as code in the generator's language),
+ * markdown content, or a code block with optional language override.
+ * Plain strings are supported for backwards compatibility.
  */
+type Snippet = string | MarkdownSnippet | CodeSnippet;
 
-/**
- * The information to include within the `reference.md` file generated by the CLI.
- * The information here should really be all defined by the generator, and not user provided.
- * We intentionally keep this a bit flexible in the event SDKs structure their package/module
- * references in a unique way for the same API.
- */
-interface ReferenceConfig {
-    rootSection?: RootPackageReferenceSection;
-    sections: ReferenceSection[];
-    /** Similar to in README generation, the language property is used to determine the language to use when generating code blocks in markdown. */
-    language: Language;
+interface SwiftInfo {
+    publishInfo?: SwiftPackageManagerPublishInfo;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-interface RootPackageReferenceSection {
-    description?: string;
-    endpoints: EndpointReference[];
+interface SwiftPackageManagerPublishInfo {
+    gitUrl: string;
+    minVersion: string;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-interface ReferenceSection {
-    title: string;
-    description?: string;
-    endpoints: EndpointReference[];
+interface TypescriptInfo {
+    publishInfo?: NpmPublishInfo;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
 interface EndpointReference {
     /**
      * The title is a code snippet that is shown when the endpoint's reference is collapsed.
@@ -506,9 +355,40 @@ interface EndpointReference {
     parameters: ParameterReference[];
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+declare const LanguageValues: {
+    readonly Java: "JAVA";
+    readonly Python: "PYTHON";
+    readonly Go: "GO";
+    readonly Ruby: "RUBY";
+    readonly Csharp: "CSHARP";
+    readonly Typescript: "TYPESCRIPT";
+    readonly Php: "PHP";
+    readonly Rust: "RUST";
+    readonly Swift: "SWIFT";
+};
+type Language = (typeof LanguageValues)[keyof typeof LanguageValues];
+declare const Language: typeof LanguageValues & {
+    _visit: <R>(value: Language, visitor: Language.Visitor<R>) => R;
+};
+declare namespace Language {
+    interface Visitor<R> {
+        java: () => R;
+        python: () => R;
+        go: () => R;
+        ruby: () => R;
+        csharp: () => R;
+        typescript: () => R;
+        php: () => R;
+        rust: () => R;
+        swift: () => R;
+        _other: () => R;
+    }
+}
+
+interface LinkedText {
+    text: string;
+    location?: RelativeLocation;
+}
 
 /**
  * The method invocation snippet is one which appears when the endpoint's reference is collapsed.
@@ -523,19 +403,6 @@ interface MethodInvocationSnippet {
     returnValue?: LinkedText;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-interface LinkedText {
-    text: string;
-    location?: RelativeLocation;
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
 interface ParameterReference {
     name: string;
     description?: string;
@@ -545,8 +412,24 @@ interface ParameterReference {
 }
 
 /**
- * This file was auto-generated by Fern from our API Definition.
+ * The information to include within the `reference.md` file generated by the CLI.
+ * The information here should really be all defined by the generator, and not user provided.
+ * We intentionally keep this a bit flexible in the event SDKs structure their package/module
+ * references in a unique way for the same API.
  */
+interface ReferenceConfig {
+    rootSection?: RootPackageReferenceSection;
+    sections: ReferenceSection[];
+    /** Similar to in README generation, the language property is used to determine the language to use when generating code blocks in markdown. */
+    language: Language;
+}
+
+interface ReferenceSection {
+    title: string;
+    description?: string;
+    endpoints: EndpointReference[];
+}
+
 interface RelativeLocation {
     /**
      * A relative location is a path to a file or directory relative to the root of the repository.
@@ -555,35 +438,9 @@ interface RelativeLocation {
     path: string;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-type Language = "JAVA" | "PYTHON" | "GO" | "RUBY" | "CSHARP" | "TYPESCRIPT" | "PHP" | "RUST" | "SWIFT";
-declare const Language: {
-    readonly Java: "JAVA";
-    readonly Python: "PYTHON";
-    readonly Go: "GO";
-    readonly Ruby: "RUBY";
-    readonly Csharp: "CSHARP";
-    readonly Typescript: "TYPESCRIPT";
-    readonly Php: "PHP";
-    readonly Rust: "RUST";
-    readonly Swift: "SWIFT";
-    readonly _visit: <R>(value: Language, visitor: Language.Visitor<R>) => R;
-};
-declare namespace Language {
-    interface Visitor<R> {
-        java: () => R;
-        python: () => R;
-        go: () => R;
-        ruby: () => R;
-        csharp: () => R;
-        typescript: () => R;
-        php: () => R;
-        rust: () => R;
-        swift: () => R;
-        _other: () => R;
-    }
+interface RootPackageReferenceSection {
+    description?: string;
+    endpoints: EndpointReference[];
 }
 
 interface GenerateReadmeToStreamParams {
@@ -623,4 +480,224 @@ interface GithubReleaseParams {
 }
 declare function githubRelease(params: GithubReleaseParams): Promise<void>;
 
-export { type GenerateReadmeParams, type GenerateReadmeToStreamParams, type GenerateReferenceParams, type GenerateReferenceToStreamParams, type GithubPrParams, type GithubPushParams, type GithubReleaseParams, generateReadme, generateReadmeToStream, generateReference, generateReferenceToStream, githubPr, githubPush, githubRelease };
+/**
+ * Logger interface for pipeline steps.
+ * Abstracts away the logging implementation so steps work with both
+ * the CLI's TaskContext and the standalone CLI subprocess (console).
+ */
+interface PipelineLogger {
+    debug(message: string): void;
+    info(message: string): void;
+    warn(message: string): void;
+    error(message: string): void;
+}
+/**
+ * Default logger implementation using stderr (to avoid mixing with JSON result output on stdout).
+ */
+declare const consolePipelineLogger: PipelineLogger;
+
+interface PipelineConfig {
+    outputDir: string;
+    replay?: ReplayStepConfig;
+    fernignore?: FernignoreStepConfig;
+    github?: GithubStepConfig;
+    cliVersion?: string;
+    generatorVersions?: Record<string, string>;
+    generatorName?: string;
+}
+interface PipelineContext {
+    previousStepResults: {
+        replay?: ReplayStepResult;
+        fernignore?: FernignoreStepResult;
+    };
+}
+interface ReplayStepConfig {
+    enabled: boolean;
+    stageOnly?: boolean;
+    skipApplication?: boolean;
+}
+interface FernignoreStepConfig {
+    enabled: boolean;
+    customContents?: string;
+}
+interface GithubStepConfig {
+    enabled: boolean;
+    /** GitHub repository URI (e.g. "owner/repo") */
+    uri: string;
+    /** GitHub auth token */
+    token: string;
+    /** Output mode */
+    mode: "push" | "pull-request";
+    /** Target branch (base branch for PRs, push target for push mode) */
+    branch?: string;
+    /** Commit message for the generation */
+    commitMessage?: string;
+    /** Skip push/PR creation, just prepare branches locally */
+    previewMode?: boolean;
+    /** Generator name for namespaced fern-generation-base tag */
+    generatorName?: string;
+    /** Explicit override: whether replay already created commits (derived from replay context if omitted) */
+    skipCommit?: boolean;
+    /** Explicit override: replay conflict info (derived from replay context if omitted) */
+    replayConflictInfo?: {
+        previousGenerationSha: string;
+        currentGenerationSha: string;
+        hasConflicts: boolean;
+        baseBranchHead?: string;
+    };
+}
+interface PipelineResult {
+    success: boolean;
+    steps: {
+        replay?: ReplayStepResult;
+        fernignore?: FernignoreStepResult;
+        github?: GithubStepResult;
+    };
+    errors?: string[];
+    warnings?: string[];
+}
+interface ReplayStepResult extends StepResult {
+    flow?: "first-generation" | "no-patches" | "normal-regeneration" | "skip-application";
+    patchesDetected?: number;
+    patchesApplied?: number;
+    patchesWithConflicts?: number;
+    patchesAbsorbed?: number;
+    patchesRepointed?: number;
+    patchesContentRebased?: number;
+    patchesKeptAsUserOwned?: number;
+    previousGenerationSha?: string;
+    currentGenerationSha?: string;
+    baseBranchHead?: string;
+    conflicts?: ConflictInfo[];
+    conflictDetails?: Array<{
+        patchId: string;
+        patchMessage: string;
+        reason?: string;
+        files: Array<{
+            file: string;
+            status: string;
+            conflictReason?: string;
+        }>;
+    }>;
+    warnings?: string[];
+}
+interface ConflictInfo {
+    filePath: string;
+    conflicts: Array<{
+        startLine: number;
+        endLine: number;
+        ours: string[];
+        theirs: string[];
+    }>;
+}
+interface FernignoreStepResult extends StepResult {
+    pathsPreserved?: string[];
+}
+interface GithubStepResult extends StepResult {
+    commitSha?: string;
+    branchUrl?: string;
+    prUrl?: string;
+    prNumber?: number;
+    updatedExistingPr?: boolean;
+    generationBaseTagSha?: string;
+}
+interface StepResult {
+    executed: boolean;
+    success: boolean;
+    errorMessage?: string;
+}
+
+declare class PostGenerationPipeline {
+    private readonly config;
+    private readonly logger;
+    private steps;
+    constructor(config: PipelineConfig, logger?: PipelineLogger);
+    run(): Promise<PipelineResult>;
+}
+
+declare function logReplaySummary(result: ReplayStepResult, logger: PipelineLogger): void;
+declare function formatReplayPrBody(result: ReplayStepResult | undefined, options?: {
+    branchName?: string;
+}): string | undefined;
+
+interface ReplayInitParams {
+    /** GitHub repo URI (e.g., "fern-demo/fern-replay-testbed-java-sdk") */
+    githubRepo: string;
+    /** GitHub token with push + PR permissions */
+    token: string;
+    /** Report what would happen but don't create PR */
+    dryRun?: boolean;
+    /** Max commits to scan for generation history */
+    maxCommitsToScan?: number;
+    /** Title for the PR */
+    prTitle?: string;
+    /** Body for the PR */
+    prBody?: string;
+    /** Overwrite existing lockfile if present. Default: false */
+    force?: boolean;
+    /** Scan git history for existing patches (migration). Default: false */
+    importHistory?: boolean;
+}
+interface ReplayInitResult {
+    /** Bootstrap result from fern-replay */
+    bootstrap: BootstrapResult;
+    /** URL of the created PR, if not dry-run */
+    prUrl?: string;
+    /** Branch name used for the PR */
+    branch?: string;
+}
+/**
+ * Initialize Replay for an SDK repository.
+ *
+ * Creates a branch and opens a PR with the replay lockfile.
+ *
+ * Flow:
+ * 1. Clone the SDK repo
+ * 2. Run bootstrap() to scan history and create lockfile
+ * 3. Ensure .fernignore has replay entries
+ * 4. Commit with [fern-replay] prefix (recognized by isGenerationCommit)
+ * 5. Push branch and open PR
+ *
+ * The [fern-replay] commit message prefix ensures the bootstrap commit
+ * is NOT treated as a user customization patch by ReplayDetector.
+ */
+declare function replayInit(params: ReplayInitParams): Promise<ReplayInitResult>;
+interface BootstrapLogEntry {
+    level: "info" | "warn";
+    message: string;
+}
+/**
+ * Formats a BootstrapResult into structured log entries.
+ * Used by both the generator-cli CLI and the fern CLI to produce
+ * consistent output without duplicating formatting logic.
+ */
+declare function formatBootstrapSummary(result: ReplayInitResult): BootstrapLogEntry[];
+
+interface ReplayRunParams {
+    outputDir: string;
+    cliVersion?: string;
+    generatorVersions?: Record<string, string>;
+    /** Don't commit, just stage changes. Default: false */
+    stageOnly?: boolean;
+    /** Generator name for namespaced tag lookup (e.g. "fernapi/fern-typescript-node-sdk") */
+    generatorName?: string;
+    /** Commit generation + update lockfile, skip patch detection/application */
+    skipApplication?: boolean;
+    /** Optional logger for diagnostic output */
+    logger?: PipelineLogger;
+}
+interface ReplayRunResult {
+    /** null if replay wasn't initialized (no lockfile) */
+    report: ReplayReport | null;
+    /** Whether .fernignore was updated */
+    fernignoreUpdated: boolean;
+    /** SHA of the [fern-generated] commit before this replay run (null if first generation or unreadable) */
+    previousGenerationSha: string | null;
+    /** SHA of the [fern-generated] commit created by this replay run (null if replay didn't run or unreadable) */
+    currentGenerationSha: string | null;
+    /** SHA of main's HEAD before replay ran. Always on main's lineage, stable after squash merges. */
+    baseBranchHead: string | null;
+}
+declare function replayRun(params: ReplayRunParams): Promise<ReplayRunResult>;
+
+export { type BootstrapLogEntry, type GenerateReadmeParams, type GenerateReadmeToStreamParams, type GenerateReferenceParams, type GenerateReferenceToStreamParams, type GithubPrParams, type GithubPushParams, type GithubReleaseParams, type GithubStepConfig, type GithubStepResult, type PipelineConfig, type PipelineContext, type PipelineLogger, type PipelineResult, PostGenerationPipeline, type ReplayInitParams, type ReplayInitResult, type ReplayRunParams, type ReplayRunResult, type ReplayStepResult, consolePipelineLogger, formatBootstrapSummary, formatReplayPrBody, generateReadme, generateReadmeToStream, generateReference, generateReferenceToStream, githubPr, githubPush, githubRelease, logReplaySummary, replayInit, replayRun };