@fern-api/generator-cli 0.1.8 → 0.3.0

package/dist/cli.cjs

@@ -5846,7 +5846,7 @@ function resolve(...paths) {
 
 // src/cli.ts
 var import_fs6 = __toESM(require("fs"), 1);
-var import_promises6 = require("fs/promises");
+var import_promises7 = require("fs/promises");
 var import_path7 = __toESM(require("path"), 1);
 
 // ../../node_modules/.pnpm/yargs@17.7.2/node_modules/yargs/build/lib/yerror.js
@@ -7435,32 +7435,8 @@ Yargs.hideBin = processArgv.hideBin;
 Yargs.Parser = Parser2;
 var yargs_default = Yargs;
 
-// src/configuration/loadGitHubConfig.ts
-var import_promises2 = require("fs/promises");
-async function loadGitHubConfig({
-  absolutePathToConfig
-}) {
-  const rawContents = await (0, import_promises2.readFile)(absolutePathToConfig, "utf8");
-  return JSON.parse(rawContents);
-}
-
-// src/configuration/loadReadmeConfig.ts
-var import_promises3 = require("fs/promises");
-async function loadReadmeConfig({
-  absolutePathToConfig
-}) {
-  const rawContents = await (0, import_promises3.readFile)(absolutePathToConfig, "utf8");
-  return JSON.parse(rawContents);
-}
-
-// src/configuration/loadReferenceConfig.ts
-var import_promises4 = require("fs/promises");
-async function loadReferenceConfig({
-  absolutePathToConfig
-}) {
-  const rawContents = await (0, import_promises4.readFile)(absolutePathToConfig, "utf8");
-  return JSON.parse(rawContents);
-}
+// src/api/generate-readme.ts
+var import_node_stream = require("stream");
 
 // ../../node_modules/.pnpm/simple-git@3.24.0/node_modules/simple-git/dist/esm/index.js
 var import_file_exists = __toESM(require_dist(), 1);
@@ -11969,7 +11945,7 @@ var esm_default2 = gitInstanceFactory;
 var import_tmp_promise = __toESM(require_tmp_promise(), 1);
 
 // ../commons/github/dist/ClonedRepository.js
-var import_promises5 = require("fs/promises");
+var import_promises2 = require("fs/promises");
 var import_path6 = __toESM(require("path"), 1);
 
 // ../commons/github/dist/constants.js
@@ -12046,18 +12022,18 @@ var ClonedRepository = class {
   }
   async overwriteLocalContents(sourceDirectoryPath) {
     const [sourceContents, destContents] = await Promise.all([
-      (0, import_promises5.readdir)(sourceDirectoryPath),
-      (0, import_promises5.readdir)(this.clonePath)
+      (0, import_promises2.readdir)(sourceDirectoryPath),
+      (0, import_promises2.readdir)(this.clonePath)
     ]);
     await Promise.all(destContents.filter((content) => !DEFAULT_IGNORED_FILES.includes(content)).map(async (content) => {
-      await (0, import_promises5.rm)((0, import_path6.resolve)(this.clonePath, content), {
+      await (0, import_promises2.rm)((0, import_path6.resolve)(this.clonePath, content), {
         recursive: true,
         force: true
       });
     }));
     await Promise.all(sourceContents.filter((content) => !DEFAULT_IGNORED_FILES.includes(content)).map(async (content) => {
       const path4 = (0, import_path6.resolve)(sourceDirectoryPath, content);
-      await (0, import_promises5.cp)(path4, (0, import_path6.resolve)(this.clonePath, content), { recursive: true });
+      await (0, import_promises2.cp)(path4, (0, import_path6.resolve)(this.clonePath, content), { recursive: true });
     }));
   }
   async readFile({ relativeFilePath }) {
@@ -12065,12 +12041,12 @@ var ClonedRepository = class {
     if (!await doesPathExist2(absoluteFilePath)) {
       return void 0;
     }
-    return await (0, import_promises5.readFile)(absoluteFilePath, "utf-8");
+    return await (0, import_promises2.readFile)(absoluteFilePath, "utf-8");
   }
 };
 async function doesPathExist2(filepath) {
   try {
-    await (0, import_promises5.lstat)(filepath);
+    await (0, import_promises2.lstat)(filepath);
     return true;
   } catch {
     return false;
@@ -12133,115 +12109,6 @@ async function cloneRepository({ githubRepository, installationToken }) {
   });
 }
 
-// src/github/GitHub.ts
-var import_rest = require("@octokit/rest");
-var GitHub = class {
-  githubConfig;
-  constructor({
-    githubConfig
-  }) {
-    this.githubConfig = githubConfig;
-  }
-  async push() {
-    try {
-      const wd = cwd();
-      const sourceDirectory = resolve(wd, this.githubConfig.sourceDirectory);
-      const repository = await cloneRepository({
-        githubRepository: this.githubConfig.uri,
-        installationToken: this.githubConfig.token
-      });
-      const branch = this.githubConfig.branch ?? await repository.getDefaultBranch();
-      await repository.checkout(branch);
-      await repository.pull(branch);
-      const fernIgnoreFiles = await this.getFernignoreFiles(repository);
-      await repository.overwriteLocalContents(sourceDirectory);
-      await repository.add(".");
-      await this.restoreFiles(repository, fernIgnoreFiles);
-      await repository.commit("SDK Generation");
-      await repository.push();
-    } catch (error) {
-      console.error("Error during GitHub push:", error);
-      throw error;
-    }
-  }
-  async pr() {
-    try {
-      const wd = cwd();
-      const sourceDirectory = resolve(wd, this.githubConfig.sourceDirectory);
-      const repository = await cloneRepository({
-        githubRepository: this.githubConfig.uri,
-        installationToken: this.githubConfig.token
-      });
-      const baseBranch = this.githubConfig.branch ?? await repository.getDefaultBranch();
-      const now = /* @__PURE__ */ new Date();
-      const formattedDate = now.toISOString().replace("T", "_").replace(/:/g, "-").replace(/\..+/, "");
-      const prBranch = `fern-bot/${formattedDate}`;
-      await repository.checkout(baseBranch);
-      await repository.pull(baseBranch);
-      await repository.checkout(prBranch);
-      const fernIgnoreFiles = await this.getFernignoreFiles(repository);
-      await repository.overwriteLocalContents(sourceDirectory);
-      await repository.add(".");
-      await this.restoreFiles(repository, fernIgnoreFiles);
-      await repository.commit("SDK Generation");
-      await repository.push();
-      const octokit = new import_rest.Octokit({
-        auth: this.githubConfig.token
-      });
-      const [owner, repo] = this.githubConfig.uri.split("/");
-      if (!owner || !repo) {
-        throw new Error(`Invalid repository URI: ${this.githubConfig.uri}`);
-      }
-      const head = `${owner}:${prBranch}`;
-      try {
-        await octokit.pulls.create({
-          owner,
-          repo,
-          title: "SDK Generation",
-          body: "Automated SDK generation by Fern",
-          head,
-          base: baseBranch,
-          draft: false
-        });
-      } catch (e) {
-        if (typeof e?.message === "string" && e.message.includes("A pull request already exists for")) {
-          console.error(`A pull request already exists for ${head}`);
-        } else {
-          throw e;
-        }
-      }
-    } catch (error) {
-      console.error("Error during GitHub PR flow:", error);
-      throw error;
-    }
-  }
-  async release() {
-    console.log("TODO: Implement release");
-  }
-  async getFernignoreFiles(repository) {
-    const fernignore = await repository.getFernignore();
-    if (fernignore === void 0) {
-      return [];
-    }
-    const fernignoreLines = fernignore.split("\n");
-    const fernignoreFiles = [];
-    for (const line of fernignoreLines) {
-      const trimmedLine = line.trim();
-      if (!trimmedLine.startsWith("#") && trimmedLine.length > 0 && await repository.fileExists({ relativeFilePath: trimmedLine })) {
-        fernignoreFiles.push(trimmedLine);
-      }
-    }
-    return fernignoreFiles;
-  }
-  async restoreFiles(repository, files) {
-    if (files.length === 0) {
-      return;
-    }
-    await repository.restoreFiles({ files, staged: true });
-    await repository.restoreFiles({ files });
-  }
-};
-
 // src/readme/ReadmeGenerator.ts
 var import_compat = require("es-toolkit/compat");
 var import_string = require("es-toolkit/string");
@@ -13491,6 +13358,22 @@ function sectionNameToID(sectionName) {
   ).toUpperCase();
 }
 
+// src/api/generate-readme.ts
+async function generateReadmeToStream(params) {
+  const { originalReadmeContent, readmeConfig, outputStream } = params;
+  const generator = new ReadmeGenerator({
+    readmeParser: new ReadmeParser(),
+    readmeConfig,
+    originalReadme: originalReadmeContent
+  });
+  await generator.generateReadme({
+    output: outputStream
+  });
+}
+
+// src/api/generate-reference.ts
+var import_node_stream2 = require("stream");
+
 // src/reference/ReferenceGenerator.ts
 var ReferenceGenerator = class {
   referenceConfig;
@@ -13595,6 +13478,183 @@ ${content}
   }
 };
 
+// src/api/generate-reference.ts
+async function generateReferenceToStream(params) {
+  const { referenceConfig, outputStream } = params;
+  const generator = new ReferenceGenerator({
+    referenceConfig
+  });
+  await generator.generate({
+    output: outputStream
+  });
+}
+
+// src/github/GitHub.ts
+var import_rest = require("@octokit/rest");
+var GitHub = class {
+  githubConfig;
+  constructor({
+    githubConfig
+  }) {
+    this.githubConfig = githubConfig;
+  }
+  async push() {
+    try {
+      const wd = cwd();
+      const sourceDirectory = resolve(wd, this.githubConfig.sourceDirectory);
+      const repository = await cloneRepository({
+        githubRepository: this.githubConfig.uri,
+        installationToken: this.githubConfig.token
+      });
+      const branch = this.githubConfig.branch ?? await repository.getDefaultBranch();
+      await repository.checkout(branch);
+      await repository.pull(branch);
+      const fernIgnoreFiles = await this.getFernignoreFiles(repository);
+      await repository.overwriteLocalContents(sourceDirectory);
+      await repository.add(".");
+      await this.restoreFiles(repository, fernIgnoreFiles);
+      await repository.commit("SDK Generation");
+      await repository.push();
+    } catch (error) {
+      console.error("Error during GitHub push:", error);
+      throw error;
+    }
+  }
+  async pr() {
+    try {
+      const wd = cwd();
+      const sourceDirectory = resolve(wd, this.githubConfig.sourceDirectory);
+      const repository = await cloneRepository({
+        githubRepository: this.githubConfig.uri,
+        installationToken: this.githubConfig.token
+      });
+      const baseBranch = this.githubConfig.branch ?? await repository.getDefaultBranch();
+      const now = /* @__PURE__ */ new Date();
+      const formattedDate = now.toISOString().replace("T", "_").replace(/:/g, "-").replace(/\..+/, "");
+      const prBranch = `fern-bot/${formattedDate}`;
+      await repository.checkout(baseBranch);
+      await repository.pull(baseBranch);
+      await repository.checkout(prBranch);
+      const fernIgnoreFiles = await this.getFernignoreFiles(repository);
+      await repository.overwriteLocalContents(sourceDirectory);
+      await repository.add(".");
+      await this.restoreFiles(repository, fernIgnoreFiles);
+      await repository.commit("SDK Generation");
+      await repository.push();
+      const octokit = new import_rest.Octokit({
+        auth: this.githubConfig.token
+      });
+      const [owner, repo] = this.githubConfig.uri.split("/");
+      if (!owner || !repo) {
+        throw new Error(`Invalid repository URI: ${this.githubConfig.uri}`);
+      }
+      const head = `${owner}:${prBranch}`;
+      try {
+        await octokit.pulls.create({
+          owner,
+          repo,
+          title: "SDK Generation",
+          body: "Automated SDK generation by Fern",
+          head,
+          base: baseBranch,
+          draft: false
+        });
+      } catch (e) {
+        if (typeof e?.message === "string" && e.message.includes("A pull request already exists for")) {
+          console.error(`A pull request already exists for ${head}`);
+        } else {
+          throw e;
+        }
+      }
+    } catch (error) {
+      console.error("Error during GitHub PR flow:", error);
+      throw error;
+    }
+  }
+  async release() {
+    console.log("TODO: Implement release");
+  }
+  async getFernignoreFiles(repository) {
+    const fernignore = await repository.getFernignore();
+    if (fernignore === void 0) {
+      return [];
+    }
+    const fernignoreLines = fernignore.split("\n");
+    const fernignoreFiles = [];
+    for (const line of fernignoreLines) {
+      const trimmedLine = line.trim();
+      if (!trimmedLine.startsWith("#") && trimmedLine.length > 0 && await repository.fileExists({ relativeFilePath: trimmedLine })) {
+        fernignoreFiles.push(trimmedLine);
+      }
+    }
+    return fernignoreFiles;
+  }
+  async restoreFiles(repository, files) {
+    if (files.length === 0) {
+      return;
+    }
+    await repository.restoreFiles({ files, staged: true });
+    await repository.restoreFiles({ files });
+  }
+};
+
+// src/api/github-pr.ts
+async function githubPr(params) {
+  const { githubConfig } = params;
+  const github = new GitHub({ githubConfig });
+  await github.pr();
+}
+
+// src/api/github-push.ts
+async function githubPush(params) {
+  const { githubConfig } = params;
+  const github = new GitHub({ githubConfig });
+  await github.push();
+}
+
+// src/api/github-release.ts
+async function githubRelease(params) {
+  const { githubConfig } = params;
+  const github = new GitHub({ githubConfig });
+  await github.release();
+}
+
+// src/configuration/loadGitHubConfig.ts
+var import_promises3 = require("fs/promises");
+async function loadGitHubConfig({
+  absolutePathToConfig
+}) {
+  const rawContents = await (0, import_promises3.readFile)(absolutePathToConfig, "utf8");
+  return JSON.parse(rawContents);
+}
+
+// src/configuration/loadMetadataConfig.ts
+var import_promises4 = require("fs/promises");
+async function loadMetadataConfig({
+  absolutePathToConfig
+}) {
+  const rawContents = await (0, import_promises4.readFile)(absolutePathToConfig, "utf8");
+  return JSON.parse(rawContents);
+}
+
+// src/configuration/loadReadmeConfig.ts
+var import_promises5 = require("fs/promises");
+async function loadReadmeConfig({
+  absolutePathToConfig
+}) {
+  const rawContents = await (0, import_promises5.readFile)(absolutePathToConfig, "utf8");
+  return JSON.parse(rawContents);
+}
+
+// src/configuration/loadReferenceConfig.ts
+var import_promises6 = require("fs/promises");
+async function loadReferenceConfig({
+  absolutePathToConfig
+}) {
+  const rawContents = await (0, import_promises6.readFile)(absolutePathToConfig, "utf8");
+  return JSON.parse(rawContents);
+}
+
 // src/cli.ts
 void yargs_default(hideBin(process.argv)).scriptName(process.env.CLI_NAME ?? "generator-cli").strict().command(
   "generate readme",
@@ -13618,13 +13678,11 @@ void yargs_default(hideBin(process.argv)).scriptName(process.env.CLI_NAME ?? "ge
     const readmeConfig = await loadReadmeConfig({
       absolutePathToConfig: resolve(wd, argv.config)
     });
-    const generator = new ReadmeGenerator({
-      readmeParser: new ReadmeParser(),
+    const originalReadmeContent = argv.originalReadme != null ? await (0, import_promises7.readFile)(argv.originalReadme, "utf8") : void 0;
+    await generateReadmeToStream({
+      originalReadmeContent,
       readmeConfig,
-      originalReadme: argv.originalReadme != null ? await (0, import_promises6.readFile)(argv.originalReadme, "utf8") : void 0
-    });
-    await generator.generateReadme({
-      output: await createWriteStream(argv.output)
+      outputStream: await createWriteStream(argv.output)
     });
     process.exit(0);
   }
@@ -13647,12 +13705,35 @@ void yargs_default(hideBin(process.argv)).scriptName(process.env.CLI_NAME ?? "ge
     const referenceConfig = await loadReferenceConfig({
       absolutePathToConfig: resolve(wd, argv.config)
     });
-    const generator = new ReferenceGenerator({
-      referenceConfig
+    await generateReferenceToStream({
+      referenceConfig,
+      outputStream: await createWriteStream(argv.output)
     });
-    await generator.generate({
-      output: await createWriteStream(argv.output)
+    process.exit(0);
+  }
+).command(
+  "write-metadata",
+  "Write metadata to the output directory using the provided configuration file.",
+  (argv) => argv.option("config", {
+    string: true,
+    required: true
+  }).option("output", {
+    string: true,
+    required: false
+  }),
+  async (argv) => {
+    if (argv.config == null) {
+      process.stderr.write("missing required arguments; please specify the --config flag\n");
+      process.exit(1);
+    }
+    const wd = cwd();
+    const metadata = await loadMetadataConfig({
+      absolutePathToConfig: resolve(wd, argv.config)
     });
+    const outputPath = argv.output != null ? resolve(wd, argv.output) : resolve(wd, ".fern/metadata.json");
+    const formattedMetadata = JSON.stringify(metadata, null, 2);
+    await (0, import_promises7.mkdir)(import_path7.default.dirname(outputPath), { recursive: true });
+    await (0, import_promises7.writeFile)(outputPath, formattedMetadata, "utf8");
     process.exit(0);
   }
 ).command("github", "GitHub operations", (yargs) => {
@@ -13675,10 +13756,7 @@ void yargs_default(hideBin(process.argv)).scriptName(process.env.CLI_NAME ?? "ge
       const githubConfig = await loadGitHubConfig({
         absolutePathToConfig: resolve(wd, argv.config)
       });
-      const github = new GitHub({
-        githubConfig
-      });
-      await github.push();
+      await githubPush({ githubConfig });
       process.exit(0);
     }
   ).command(
@@ -13700,10 +13778,7 @@ void yargs_default(hideBin(process.argv)).scriptName(process.env.CLI_NAME ?? "ge
       const githubConfig = await loadGitHubConfig({
         absolutePathToConfig: resolve(wd, argv.config)
       });
-      const github = new GitHub({
-        githubConfig
-      });
-      await github.pr();
+      await githubPr({ githubConfig });
       process.stderr.write(`Creating PR on GitHub with config: ${resolve(wd, argv.config)}
 `);
       process.exit(0);
@@ -13725,10 +13800,7 @@ void yargs_default(hideBin(process.argv)).scriptName(process.env.CLI_NAME ?? "ge
         const githubConfig = await loadGitHubConfig({
           absolutePathToConfig: resolve(wd2, argv.config)
         });
-        const github = new GitHub({
-          githubConfig
-        });
-        await github.release();
+        await githubRelease({ githubConfig });
         process.exit(1);
       }
       const wd = cwd();
@@ -13743,7 +13815,7 @@ async function createWriteStream(outputPath) {
 }
 async function createWriteStreamFromFile(filepath) {
   if (!await doesPathExist(filepath)) {
-    await (0, import_promises6.mkdir)(import_path7.default.dirname(filepath), { recursive: true });
+    await (0, import_promises7.mkdir)(import_path7.default.dirname(filepath), { recursive: true });
   }
   return import_fs6.default.createWriteStream(filepath);
 }

package/package.json

@@ -1,20 +1,23 @@
 {
   "name": "@fern-api/generator-cli",
-  "version": "0.1.8",
+  "version": "0.3.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/fern-api/fern-platform"
   },
   "type": "module",
-  "main": "dist/cli.cjs",
+  "main": "dist/api.cjs",
   "source": "src/index.ts",
+  "types": "dist/api.d.cts",
   "bin": {
     "generator-cli": "dist/cli.cjs"
   },
   "files": ["dist"],
   "scripts": {
     "clean": "rm -rf ./dist && tsc --build --clean",
-    "compile": "tsup ./src/cli.ts --format cjs && echo '#!/usr/bin/env node' | cat - dist/cli.cjs > dist/tmp && mv dist/tmp dist/cli.cjs",
+    "compile": "pnpm compile:api && pnpm compile:cli",
+    "compile:api": "tsup ./src/api.ts --format cjs --dts",
+    "compile:cli": "tsup ./src/cli.ts --format cjs && echo '#!/usr/bin/env node' | cat - dist/cli.cjs > dist/tmp && mv dist/tmp dist/cli.cjs",
     "depcheck": "depcheck",
     "format": "prettier --write --ignore-unknown \"**\"",
     "format:check": "prettier --check --ignore-unknown \"**\"",