@fern-api/generator-cli 0.6.11 → 0.8.0

package/dist/api.d.ts

@@ -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 */
@@ -611,16 +617,12 @@ declare function formatReplayPrBody(result: ReplayStepResult | undefined, option
 interface ReplayInitParams {
     /** GitHub repo URI (e.g., "fern-demo/fern-replay-testbed-java-sdk") */
     githubRepo: string;
-    /** GitHub token with push + PR permissions */
+    /** GitHub token for clone (read access) */
     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 */
@@ -629,25 +631,26 @@ interface ReplayInitParams {
 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;
+    /** Raw lockfile YAML content, present when bootstrap succeeded and not dry-run */
+    lockfileContent?: string;
+    /** Raw replay.yml content, present only when fernignore migration created it */
+    replayYmlContent?: string;
+    /** Fernignore entries that the server should ensure exist */
+    fernignoreEntries: string[];
+    /** Generated PR body markdown for the server to use */
+    prBody?: string;
 }
 /**
  * Initialize Replay for an SDK repository.
  *
- * Creates a branch and opens a PR with the replay lockfile.
+ * Runs bootstrap locally (read-only) and returns the lockfile content
+ * for the caller to send to Fiddle for server-side PR creation.
  *
  * Flow:
- * 1. Clone the SDK repo
+ * 1. Clone the SDK repo (read-only)
  * 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.
+ * 4. Read lockfile content from disk and return it
  */
 declare function replayInit(params: ReplayInitParams): Promise<ReplayInitResult>;
 interface BootstrapLogEntry {