Emulate some CJS and ESM projects as unit test not to break user projects

package.json

@@ -34,7 +34,7 @@
   "scripts": {
     "test": "npm run format && npm run build && vitest run",
     "covtest": "vitest run --coverage",
-    "prettier": "prettier \"{lib,test}/**/*.ts\" \"scripts/**/*.{mjs,cjs,js}\" \"examples/**/*.{ts,js,mjs}\"",
+    "prettier": "prettier \"{lib,test,scripts,examples}/**/*.{ts,js,cjs,mjs}\"",
     "format": "npm run prettier -- --write",
     "format:check": "npm run prettier -- -l",
     "clean": "rm -rf dist/*",

test/consumer/consumer-contract-js.spec.ts

@@ -0,0 +1,65 @@
+import { afterAll, beforeAll, describe, it } from "vitest";
+import {
+  buildPackedTarball,
+  copyDir,
+  installSdkTarball,
+  prepareFixtureDir,
+  removeDir,
+  runCommand,
+} from "./runner";
+
+const repoRoot = process.cwd();
+const tempDirs: string[] = [];
+let tarballPath = "";
+const JS_TIMEOUT_MS = 180_000;
+
+async function runJsFixture(
+  fixtureName: "js-esm" | "js-cjs",
+  scripts: readonly string[],
+): Promise<void> {
+  const fixtureDir = await prepareFixtureDir(tempDirs, fixtureName);
+  await copyDir(
+    `${repoRoot}/test/consumer/fixtures/${fixtureName}`,
+    fixtureDir,
+  );
+  installSdkTarball(fixtureDir, tarballPath);
+
+  for (const script of scripts) {
+    runCommand(fixtureDir, "node", [script]);
+  }
+}
+
+afterAll(async () => {
+  await Promise.allSettled(tempDirs.map(dir => removeDir(dir)));
+});
+
+describe("dual package JS consumer contract", () => {
+  beforeAll(async () => {
+    const packOutDir = await prepareFixtureDir(tempDirs, "js-pack");
+    tarballPath = await buildPackedTarball(repoRoot, packOutDir);
+  });
+
+  it(
+    "runs JS ESM fixture with resolution and behavioral contract checks",
+    async () => {
+      await runJsFixture("js-esm", [
+        "./resolution-load-check.mjs",
+        "./outbound-http-contract.mjs",
+        "./webhook-signature-contract.mjs",
+      ]);
+    },
+    JS_TIMEOUT_MS,
+  );
+
+  it(
+    "runs JS CJS fixture resolution and behavioral contract checks",
+    async () => {
+      await runJsFixture("js-cjs", [
+        "./resolution-load-check.cjs",
+        "./outbound-http-contract.cjs",
+        "./webhook-signature-contract.cjs",
+      ]);
+    },
+    JS_TIMEOUT_MS,
+  );
+});

test/consumer/consumer-contract-packaging.spec.ts

@@ -0,0 +1,69 @@
+import assert from "node:assert/strict";
+import { existsSync } from "node:fs";
+import { afterAll, beforeAll, describe, it } from "vitest";
+import {
+  buildPackedTarball,
+  listTarEntries,
+  prepareFixtureDir,
+  readTarPackageJson,
+  removeDir,
+} from "./runner";
+
+const repoRoot = process.cwd();
+const tempDirs: string[] = [];
+let tarballPath = "";
+
+afterAll(async () => {
+  await Promise.allSettled(tempDirs.map(dir => removeDir(dir)));
+});
+
+describe("dual package packaging contract", () => {
+  beforeAll(async () => {
+    const packOutDir = await prepareFixtureDir(tempDirs, "packaging-pack");
+    tarballPath = await buildPackedTarball(repoRoot, packOutDir);
+    assert.equal(existsSync(tarballPath), true);
+  });
+
+  it("includes required export targets and metadata", async () => {
+    const entries = listTarEntries(repoRoot, tarballPath);
+    const requiredEntries = [
+      "package/dist/index.js",
+      "package/dist/index.d.ts",
+      "package/dist/cjs/index.js",
+      "package/dist/cjs/index.d.ts",
+      "package/dist/cjs/package.json",
+      "package/package.json",
+    ];
+
+    for (const entry of requiredEntries) {
+      assert.equal(
+        entries.includes(entry),
+        true,
+        `${entry} was not found in tarball`,
+      );
+    }
+
+    const packagedJson = await readTarPackageJson(repoRoot, tarballPath);
+    assert.equal(packagedJson.main, "./dist/cjs/index.js");
+    assert.equal(packagedJson.types, "./dist/index.d.ts");
+
+    assert.equal(packagedJson.exports["."].import.types, "./dist/index.d.ts");
+    assert.equal(packagedJson.exports["."].import.default, "./dist/index.js");
+    assert.equal(
+      packagedJson.exports["."].require.types,
+      "./dist/cjs/index.d.ts",
+    );
+    assert.equal(
+      packagedJson.exports["."].require.default,
+      "./dist/cjs/index.js",
+    );
+  });
+
+  it("does not include test artifacts", () => {
+    const entries = listTarEntries(repoRoot, tarballPath);
+    const testArtifacts = entries.filter(entry =>
+      /(^|\/)tests?\//.test(entry.replace(/^package\//, "")),
+    );
+    assert.deepEqual(testArtifacts, []);
+  });
+});

test/consumer/consumer-contract-ts5.spec.ts

@@ -0,0 +1,84 @@
+import { afterAll, beforeAll, describe, it } from "vitest";
+import { buildPackedTarball, prepareFixtureDir, removeDir } from "./runner";
+import { runTsLane } from "./runner/ts-lane";
+
+const repoRoot = process.cwd();
+const tempDirs: string[] = [];
+let tarballPath = "";
+const TS5_VERSION = "5.9.3";
+const TS_TIMEOUT_MS = 240_000;
+
+afterAll(async () => {
+  await Promise.allSettled(tempDirs.map(dir => removeDir(dir)));
+});
+
+describe("dual package TS5 consumer contract", () => {
+  beforeAll(async () => {
+    const packOutDir = await prepareFixtureDir(tempDirs, "ts5-pack");
+    tarballPath = await buildPackedTarball(repoRoot, packOutDir);
+  });
+
+  it(
+    `runs TS ESM modern lane (${TS5_VERSION})`,
+    async () => {
+      await runTsLane(
+        { repoRoot, tarballPath, tsVersion: TS5_VERSION, tempDirs },
+        {
+          fixtureName: "ts5-esm-modern",
+          packageTemplateFile: "package.module.json",
+          tsconfigTemplateFile: "tsconfig.nodenext.json",
+          withRuntime: true,
+        },
+      );
+    },
+    TS_TIMEOUT_MS,
+  );
+
+  it(
+    `runs TS CJS modern lane (${TS5_VERSION})`,
+    async () => {
+      await runTsLane(
+        { repoRoot, tarballPath, tsVersion: TS5_VERSION, tempDirs },
+        {
+          fixtureName: "ts5-cjs-modern",
+          packageTemplateFile: "package.commonjs.json",
+          tsconfigTemplateFile: "tsconfig.nodenext.json",
+          withRuntime: true,
+        },
+      );
+    },
+    TS_TIMEOUT_MS,
+  );
+
+  it(
+    `runs TS CJS legacy lane (${TS5_VERSION})`,
+    async () => {
+      await runTsLane(
+        { repoRoot, tarballPath, tsVersion: TS5_VERSION, tempDirs },
+        {
+          fixtureName: "ts5-cjs-legacy",
+          packageTemplateFile: "package.commonjs.json",
+          tsconfigTemplateFile: "tsconfig.legacy-commonjs.json",
+          withRuntime: true,
+        },
+      );
+    },
+    TS_TIMEOUT_MS,
+  );
+
+  it(
+    `runs TS bundler compile-only lane (${TS5_VERSION})`,
+    async () => {
+      await runTsLane(
+        { repoRoot, tarballPath, tsVersion: TS5_VERSION, tempDirs },
+        {
+          fixtureName: "ts5-bundler",
+          packageTemplateFile: "package.module.json",
+          tsconfigTemplateFile: "tsconfig.bundler.json",
+          withRuntime: false,
+        },
+      );
+    },
+    TS_TIMEOUT_MS,
+  );
+});

test/consumer/consumer-contract-ts6.spec.ts

@@ -0,0 +1,84 @@
+import { afterAll, beforeAll, describe, it } from "vitest";
+import { buildPackedTarball, prepareFixtureDir, removeDir } from "./runner";
+import { runTsLane } from "./runner/ts-lane";
+
+const repoRoot = process.cwd();
+const tempDirs: string[] = [];
+let tarballPath = "";
+const TS6_VERSION = "6.0.3";
+const TS_TIMEOUT_MS = 240_000;
+
+afterAll(async () => {
+  await Promise.allSettled(tempDirs.map(dir => removeDir(dir)));
+});
+
+describe("dual package TS6 consumer contract", () => {
+  beforeAll(async () => {
+    const packOutDir = await prepareFixtureDir(tempDirs, "ts6-pack");
+    tarballPath = await buildPackedTarball(repoRoot, packOutDir);
+  });
+
+  it(
+    `runs TS ESM modern lane (${TS6_VERSION})`,
+    async () => {
+      await runTsLane(
+        { repoRoot, tarballPath, tsVersion: TS6_VERSION, tempDirs },
+        {
+          fixtureName: "ts6-esm-modern",
+          packageTemplateFile: "package.module.json",
+          tsconfigTemplateFile: "tsconfig.nodenext.json",
+          withRuntime: true,
+        },
+      );
+    },
+    TS_TIMEOUT_MS,
+  );
+
+  it(
+    `runs TS CJS modern lane (${TS6_VERSION})`,
+    async () => {
+      await runTsLane(
+        { repoRoot, tarballPath, tsVersion: TS6_VERSION, tempDirs },
+        {
+          fixtureName: "ts6-cjs-modern",
+          packageTemplateFile: "package.commonjs.json",
+          tsconfigTemplateFile: "tsconfig.nodenext.json",
+          withRuntime: true,
+        },
+      );
+    },
+    TS_TIMEOUT_MS,
+  );
+
+  it(
+    `runs TS bundler compile-only lane (${TS6_VERSION})`,
+    async () => {
+      await runTsLane(
+        { repoRoot, tarballPath, tsVersion: TS6_VERSION, tempDirs },
+        {
+          fixtureName: "ts6-bundler",
+          packageTemplateFile: "package.module.json",
+          tsconfigTemplateFile: "tsconfig.bundler.json",
+          withRuntime: false,
+        },
+      );
+    },
+    TS_TIMEOUT_MS,
+  );
+
+  it(
+    `runs TS CJS node16 lane (${TS6_VERSION})`,
+    async () => {
+      await runTsLane(
+        { repoRoot, tarballPath, tsVersion: TS6_VERSION, tempDirs },
+        {
+          fixtureName: "ts6-cjs-node16",
+          packageTemplateFile: "package.commonjs.json",
+          tsconfigTemplateFile: "tsconfig.node16.json",
+          withRuntime: true,
+        },
+      );
+    },
+    TS_TIMEOUT_MS,
+  );
+});