@fern-api/generator-cli 0.6.10 → 0.6.14

package/dist/api.d.ts

@@ -1,5 +1,5 @@
-import { BootstrapResult, ReplayReport } from '@fern-api/replay';
-export { ConflictDetail, ReplayReport } from '@fern-api/replay';
+import { BootstrapResult, ResolveResult, ReplayReport } from '@fern-api/replay';
+export { ConflictDetail, ReplayReport, ResolveResult } from '@fern-api/replay';
 import fs from 'fs';
 
 /**
@@ -532,6 +532,12 @@ interface GithubStepConfig {
     branch?: string;
     /** Commit message for the generation */
     commitMessage?: string;
+    /** User-facing changelog entry for PR body. When present, used instead of commit message body. */
+    changelogEntry?: string;
+    /** Structured PR description with Before/After code fences for breaking changes. Takes priority over changelogEntry for PR body. */
+    prDescription?: string;
+    /** One-sentence justification for WHY the version bump was chosen. Prepended to PR body when present. */
+    versionBumpReason?: string;
     /** Skip push/PR creation, just prepare branches locally */
     previewMode?: boolean;
     /** Generator name for namespaced fern-generation-base tag */
@@ -542,8 +548,6 @@ interface GithubStepConfig {
     replayConflictInfo?: {
         previousGenerationSha: string;
         currentGenerationSha: string;
-        hasConflicts: boolean;
-        baseBranchHead?: string;
     };
 }
 interface PipelineResult {
@@ -568,28 +572,17 @@ interface ReplayStepResult extends StepResult {
     previousGenerationSha?: string;
     currentGenerationSha?: string;
     baseBranchHead?: string;
-    conflicts?: ConflictInfo[];
-    conflictDetails?: Array<{
+    unresolvedPatches?: Array<{
         patchId: string;
         patchMessage: string;
-        reason?: string;
-        files: Array<{
+        files: string[];
+        conflictDetails: 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[];
 }
@@ -618,6 +611,7 @@ declare class PostGenerationPipeline {
 declare function logReplaySummary(result: ReplayStepResult, logger: PipelineLogger): void;
 declare function formatReplayPrBody(result: ReplayStepResult | undefined, options?: {
     branchName?: string;
+    repoUri?: string;
 }): string | undefined;
 
 interface ReplayInitParams {
@@ -673,6 +667,14 @@ interface BootstrapLogEntry {
  */
 declare function formatBootstrapSummary(result: ReplayInitResult): BootstrapLogEntry[];
 
+interface ReplayResolveParams {
+    /** Directory containing the SDK (where .fern/replay.lock lives) */
+    outputDir: string;
+    /** Check for remaining conflict markers before committing. Default: true */
+    checkMarkers?: boolean;
+}
+declare function replayResolve(params: ReplayResolveParams): Promise<ResolveResult>;
+
 interface ReplayRunParams {
     outputDir: string;
     cliVersion?: string;
@@ -700,4 +702,4 @@ interface ReplayRunResult {
 }
 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 };
+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 ReplayResolveParams, type ReplayRunParams, type ReplayRunResult, type ReplayStepResult, consolePipelineLogger, formatBootstrapSummary, formatReplayPrBody, generateReadme, generateReadmeToStream, generateReference, generateReferenceToStream, githubPr, githubPush, githubRelease, logReplaySummary, replayInit, replayResolve, replayRun };