Generator emits cjs

.changeset/quiet-lions-sort.md

@@ -0,0 +1,5 @@
+---
+"@osdk/foundry-sdk-generator": minor
+---
+
+We now generate osdk libs that support commonjs

packages/e2e.test.foundry-sdk-generator/generateMockOntology.js

@@ -17,6 +17,7 @@
 // @ts-check
 import { __testSeamOnly_NotSemverStable__GeneratePackageCommand as GeneratePackageCommand } from "@osdk/foundry-sdk-generator";
 import { apiServer } from "@osdk/shared.test";
+import { $ } from "execa";
 import * as fs from "node:fs/promises";
 import { tmpdir } from "node:os";
 import * as path from "node:path";
@@ -98,13 +99,28 @@ async function setup() {
   await safeStat(testApp2Dir, "should exist");
   await safeStat(testApp2BetaDir, "should exist");
 
+  await $({
+    stdout: "inherit",
+    stderr: "inherit",
+  })`attw --pack ${
+    path.join(testApp2Dir, "osdk")
+  } --ignore-rules internal-resolution-error`;
+
+  await $({
+    stdout: "inherit",
+    stderr: "inherit",
+  })`attw --pack ${
+    path.join(testApp2BetaDir, "osdk")
+  } --ignore-rules internal-resolution-error`;
+
   const finalOutDir = path.join(
     path.dirname(fileURLToPath(import.meta.url)),
     "src",
     "generatedNoCheck",
   );
 
-  fs.cp(dir, finalOutDir, { recursive: true });
+  await fs.rm(finalOutDir, { recursive: true, force: true });
+  await fs.cp(dir, finalOutDir, { recursive: true });
 }
 
 export async function teardown() {
@@ -121,7 +137,7 @@ await teardown();
  */
 async function rmRf(testAppDir) {
   try {
-    await fs.rm(testAppDir, { recursive: true });
+    await fs.rm(testAppDir, { recursive: true, force: true });
   } catch (e) {
     // console.debug("rm error", e);
     // Only needed for regenerations

packages/foundry-sdk-generator/src/generate/betaClient/compileInMemory.ts

@@ -20,7 +20,6 @@ import {
   createProgram,
   createSourceFile,
   ModuleKind,
-  ModuleResolutionKind,
   ScriptTarget,
 } from "typescript";
 
@@ -31,6 +30,7 @@ export interface CompilerOutput {
 
 export function compileInMemory(
   files: { [fileName: string]: string },
+  type: "cjs" | "esm",
 ): {
   files: {
     [fileName: string]: string;
@@ -39,9 +39,9 @@ export function compileInMemory(
 } {
   const inMemoryOutputFileSystem: { [fileName: string]: string } = {};
   const compilerOptions: CompilerOptions = {
-    module: ModuleKind.NodeNext,
+    module: type === "cjs" ? ModuleKind.CommonJS : ModuleKind.ES2022,
     target: ScriptTarget.ES2020,
-    moduleResolution: ModuleResolutionKind.NodeNext,
+    resolvePackageJsonExports: true,
     declaration: true,
     skipLibCheck: true,
   };

packages/foundry-sdk-generator/src/generate/betaClient/generatePackage.ts

@@ -41,6 +41,7 @@ export async function generatePackage(
   },
 ): Promise<void> {
   const { consola } = await import("consola");
+  let success = true;
 
   const packagePath = join(options.outputDir, options.packageName);
 
@@ -82,16 +83,47 @@ export async function generatePackage(
     beta: options.beta,
   });
 
-  // writes to in memory fs that the compiler will read from
-  await hostFs.writeFile(
-    join(packagePath, "package.json"),
-    JSON.stringify(contents),
-  );
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+  const compilerOutput: Record<
+    "esm" | "cjs",
+    ReturnType<typeof compileInMemory>
+  > = {} as any;
+
+  for (const type of ["esm", "cjs"] as const) {
+    // writes to in memory fs that the compiler will read from
+    await hostFs.writeFile(
+      join(packagePath, "package.json"),
+      JSON.stringify({
+        ...contents,
+        type: type === "cjs" ? "commonjs" : "module",
+      }),
+    );
 
-  const compilerOutput = compileInMemory(inMemoryFileSystem);
-  compilerOutput.diagnostics.forEach(d =>
-    consola.error(`Error compiling file`, d.file?.fileName, d.messageText)
-  );
+    compilerOutput[type] = compileInMemory(inMemoryFileSystem, type);
+    compilerOutput[type].diagnostics.forEach(d => {
+      consola.error(`Error compiling file`, d.file?.fileName, d.messageText);
+      success = false;
+    });
+
+    await mkdir(join(packagePath, "dist", "bundle"), { recursive: true });
+
+    await mkdir(join(packagePath, "esm"), { recursive: true });
+    await mkdir(join(packagePath, "cjs"), { recursive: true });
+
+    for (const [path, contents] of Object.entries(compilerOutput[type].files)) {
+      const newPath = path.replace(
+        packagePath,
+        join(packagePath, type),
+      );
+      await mkdir(dirname(newPath), { recursive: true });
+      await writeFile(newPath, contents, { flag: "w" });
+    }
+
+    void await writeFile(
+      join(packagePath, type, "package.json"),
+      JSON.stringify({ type: type === "esm" ? "module" : "commonjs" }),
+    );
+  }
 
   await mkdir(join(packagePath, "dist", "bundle"), { recursive: true });
 
@@ -107,28 +139,24 @@ export async function generatePackage(
       bundleDts = await bundleDependencies(
         [],
         options.packageName,
-        compilerOutput.files,
+        compilerOutput["esm"].files,
         undefined,
       );
     } catch (e) {
       consola.error("Failed bundling DTS", e);
+      success = false;
     }
   } else {
     consola.error(
       "Could not find node_modules directory, skipping DTS bundling",
     );
+    success = false;
   }
-
-  await Promise.all([
-    ...Object.entries(compilerOutput.files).map(async ([path, contents]) => {
-      await writeFile(path, contents, { flag: "w" });
-    }),
-    await writeFile(
-      join(packagePath, "dist", "bundle", "index.d.ts"),
-      bundleDts,
-      { flag: "w" },
-    ),
-  ]);
+  await writeFile(
+    join(packagePath, "dist", "bundle", "index.d.mts"),
+    bundleDts,
+    { flag: "w" },
+  );
 
   const absolutePackagePath = isAbsolute(options.outputDir)
     ? options.outputDir
@@ -138,5 +166,10 @@ export async function generatePackage(
     await generateBundles(absolutePackagePath, options.packageName);
   } catch (e) {
     consola.error(e);
+    success = false;
+  }
+
+  if (!success) {
+    throw new Error("Failed to generate package");
   }
 }

packages/foundry-sdk-generator/src/generate/betaClient/generatePackageJson.ts

@@ -42,21 +42,29 @@ export async function generatePackageJson(options: {
   const packageJson = {
     name: options.packageName,
     version: options.packageVersion,
-    main: "./index.js",
-    types: "./index.d.ts",
+    main: "./cjs/index.js",
+    types: "./cjs/index.d.ts",
     exports: {
       ".": {
-        types: "./index.d.ts",
         script: {
-          types: "./dist/bundle/index.d.ts",
-          default: "./dist/bundle/index.esm.js",
+          types: "./dist/bundle/index.d.mts",
+          default: "./dist/bundle/index.mjs",
         },
-        default: "./index.js",
+        require: {
+          types: "./cjs/index.d.ts",
+          default: "./cjs/index.js",
+        },
+        import: {
+          types: "./esm/index.d.ts",
+          default: "./esm/index.js",
+        },
+        types: "./cjs/index.d.ts",
+        default: "./cjs/index.js",
       },
     },
     dependencies: packageDeps,
     peerDependencies: packagePeerDeps,
-    type: "module",
+    type: "commonjs",
   };
 
   await writeFile(

packages/foundry-sdk-generator/src/generate/generateBundles.ts

@@ -23,16 +23,16 @@ import nodePolyfill from "rollup-plugin-polyfill-node";
 async function createRollupBuild(
   absolutePackagePath: string,
   packageName: string,
-) {
-  const inputPath = `${absolutePackagePath}/${packageName}/index.js`;
+): Promise<RollupBuild> {
+  const inputPath = `${absolutePackagePath}/${packageName}/esm/index.js`;
 
   const { findUp } = await import("find-up");
   const nodeModulesPath = await findUp("node_modules", {
     cwd: __dirname,
     type: "directory",
   });
 
-  return rollup({
+  return await rollup({
     input: inputPath,
     plugins: [
       nodeResolve({
@@ -64,8 +64,9 @@ async function writeRollupBuild(
   packageName: string,
   format: ModuleFormat,
 ) {
-  const outputPath =
-    `${absolutePackagePath}/${packageName}/dist/bundle/index.${format}.js`;
+  const outputPath = `${absolutePackagePath}/${packageName}/dist/bundle/index.${
+    format === "cjs" ? "cjs" : "mjs"
+  }`;
 
   await Promise.all([
     rollupBuild.write({
@@ -84,13 +85,18 @@ async function generateEsmBuild(
   absolutePackagePath: string,
   packageName: string,
 ) {
-  const umdBuild = await createRollupBuild(absolutePackagePath, packageName);
+  const umdBuild = await createRollupBuild(
+    absolutePackagePath,
+    packageName,
+  );
   await writeRollupBuild(umdBuild, absolutePackagePath, packageName, "esm");
 }
 
 export async function generateBundles(
   absolutePackagePath: string,
   packageName: string,
 ): Promise<void> {
-  await Promise.all([generateEsmBuild(absolutePackagePath, packageName)]);
+  await Promise.all([
+    generateEsmBuild(absolutePackagePath, packageName),
+  ]);
 }