build working, jest not working

.changeset/late-trainers-peel.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+dropped the deprecated `DEV` export from `@apollo/client/utilities` and `@apollo/client/utilities/globals`

config/build.ts

@@ -11,6 +11,7 @@ import { postprocessDist } from "./postprocessDist.ts";
 import { verifySourceMaps } from "./verifySourceMaps.ts";
 import { prepareChangesetsRelease } from "./prepareChangesetsRelease.ts";
 import { babelTransform } from "./babel.ts";
+import { addExports } from "./exports.ts";
 
 export interface BuildStepOptions {
   type: "esm" | "cjs";
@@ -32,6 +33,8 @@ $.cwd = join(import.meta.dirname, "..");
 $.verbose = true;
 
 const buildSteps = {
+  prepareDist,
+  addExports,
   typescript: compileTs,
   babelTransform,
   updateVersion,
@@ -40,7 +43,6 @@ const buildSteps = {
   postprocessDist,
   verifyVersion,
   verifySourceMaps,
-  prepareDist,
 } satisfies BuildSteps;
 const additionalSteps = {
   prepareChangesetsRelease,

config/compileTs.ts

@@ -7,7 +7,8 @@ export const compileTs: BuildStep = async (options) => {
   if (options.type === "esm") {
     await $`npx tsc --outDir ${options.targetDir}`;
   } else {
-    await $`npx tsc --outDir ${options.targetDir} --module commonjs`;
+    // for a `commonjs` output, we have to specify `moduleResulution: node`, and as that will error because it cannot verify some imports, we add `--noCheck`
+    await $`npx tsc --outDir ${options.targetDir} --module commonjs --moduleResolution node --noCheck`;
     await renameJsFilesToCjs(options);
   }
 };

config/exports.ts

@@ -0,0 +1,78 @@
+import { readFile, writeFile } from "node:fs/promises";
+import type { BuildStep } from "./build.ts";
+import { entryPoints } from "./entryPoints.ts";
+import path, { join } from "node:path";
+import assert from "node:assert";
+
+type ConditionRoot = {
+  types: {
+    import?: string;
+    require?: string;
+  };
+  import?: string;
+  "module-sync"?: string;
+  module?: string;
+  require?: string;
+  default?: string;
+};
+
+export const addExports: BuildStep = async (options) => {
+  const pkgFileName = join(options.packageRoot, "package.json");
+  const pkg = JSON.parse(await readFile(pkgFileName, "utf-8"));
+  for (const entryPoint of entryPoints) {
+    if (typeof entryPoint.value === "string") {
+      pkg.exports[entryPoint.key] = processEntryPoint(
+        entryPoint.value,
+        pkg.exports[entryPoint.key]
+      );
+    } else {
+      for (const [key, value] of Object.entries(entryPoint.value)) {
+        if (!pkg.exports[entryPoint.key]) {
+          pkg.exports[entryPoint.key] = {};
+        }
+        assert(
+          typeof value === "string",
+          "nesting of this complexity is not supported yet"
+        );
+        pkg.exports[entryPoint.key][key] = processEntryPoint(
+          value,
+          pkg.exports[entryPoint.key][key]
+        );
+      }
+    }
+    await writeFile(pkgFileName, JSON.stringify(pkg, null, 2));
+  }
+
+  function processEntryPoint(
+    value: string,
+    existing: ConditionRoot = { types: {} }
+  ) {
+    value = value.replace(
+      /^.\/src/,
+      `.${options.targetDir.replace(/^dist/, "")}`
+    );
+
+    if (options.type === "esm") {
+      existing.types.import = value.replace(/\.ts$/, `.d.${options.tsExt}`);
+      const target = value.replace(/\.ts$/, `.${options.jsExt}`);
+      existing.module = target;
+      existing["module-sync"] = target;
+      //existing.import = target;
+      existing.default = target;
+    } else {
+      existing.types.require = value.replace(/\.ts$/, `.d.${options.tsExt}`);
+      existing.require = value.replace(/\.ts$/, `.${options.jsExt}`);
+    }
+    return JSON.parse(
+      JSON.stringify(existing, [
+        // ensure the order of keys is consistent
+        "types",
+        "module",
+        "module-sync",
+        "require",
+        "import",
+        "default",
+      ])
+    );
+  }
+};

config/prepareDist.ts

@@ -17,18 +17,20 @@ import path from "node:path";
 /* @apollo/client */
 
 import pkg from "../package.json" with { type: "json" };
-import * as entryPoints from "./entryPoints.ts";
 import type { JSONSchemaForNPMPackageJsonFiles } from "./schema.package.json.ts";
 import type { BuildStep } from "./build.ts";
+import { mkdir } from "node:fs/promises";
 
 // the generated `Person` type is a bit weird - `author` as a string is valid
 const packageJson: Omit<JSONSchemaForNPMPackageJsonFiles, "author"> & {
   author: string;
 } = pkg;
 
-export const prepareDist: BuildStep = (options) => {
+export const prepareDist: BuildStep = async (options) => {
   if (!options.first) return;
 
+  await mkdir(options.packageRoot, { recursive: true });
+
   // The root package.json is marked as private to prevent publishing
   // from happening in the root of the project. This sets the package back to
   // public so it can be published from the "dist" directory.
@@ -40,7 +42,9 @@ export const prepareDist: BuildStep = (options) => {
   delete packageJson.devEngines;
   delete packageJson.devDependencies;
 
-  packageJson.exports = {};
+  packageJson.exports = {
+    "./package.json": "./package.json",
+  };
 
   // The root package.json points to the CJS/ESM source in "dist", to support
   // on-going package development (e.g. running tests, supporting npm link, etc.).

config/processInvariants.ts

@@ -214,7 +214,13 @@ export async function processInvariants(options: BuildStepOptions) {
 
     if (
       ![
-        osPathJoin("utilities", "globals", `index.${options.jsExt}`),
+        osPathJoin(
+          `utilities`,
+          `globals`,
+          `environment`,
+          `index.${options.jsExt}`
+        ),
+        osPathJoin(`utilities`, `globals`, `index.${options.jsExt}`),
         osPathJoin("config", "jest", `setup.js`),
       ].includes(relativeSourcePath)
     )

package.json

@@ -63,7 +63,12 @@
     "./utilities": "./src/utilities/index.ts",
     "./utilities/subscriptions/relay": "./src/utilities/subscriptions/relay/index.ts",
     "./utilities/subscriptions/urql": "./src/utilities/subscriptions/urql/index.ts",
-    "./utilities/globals": "./src/utilities/globals/index.ts"
+    "./utilities/globals": "./src/utilities/globals/index.ts",
+    "./utilities/globals/environment": {
+      "production": "./src/utilities/globals/environment/index.production.ts",
+      "development": "./src/utilities/globals/environment/index.development.ts",
+      "default": "./src/utilities/globals/environment/index.ts"
+    }
   },
   "scripts": {
     "prebuild": "npm run clean",

src/utilities/globals/environment/index.development.ts

@@ -0,0 +1 @@
+export const __DEV__ = true;

src/utilities/globals/environment/index.production.ts

@@ -0,0 +1 @@
+export const __DEV__ = false;

src/utilities/globals/environment/index.ts

@@ -0,0 +1,2 @@
+// @ts-ignore
+export const __DEV__ = globalThis.__DEV__ !== false;

src/utilities/globals/index.ts

@@ -1,19 +1,9 @@
-import {
+export {
   invariant,
   newInvariantError,
   InvariantError,
 } from "./invariantWrappers.js";
+export { __DEV__ } from "@apollo/client/utilities/globals/environment";
 
 export { maybe } from "./maybe.js";
 export { default as global } from "./global.js";
-export { invariant, newInvariantError, InvariantError };
-
-/**
- * @deprecated we do not use this internally anymore,
- * it is just exported for backwards compatibility
- */
-// this file is extempt from automatic `__DEV__` replacement
-// so we have to write it out here
-// @ts-ignore
-export const DEV = globalThis.__DEV__ !== false;
-export { DEV as __DEV__ };

src/utilities/index.ts

@@ -1,4 +1,4 @@
-export { DEV, maybe } from "./globals/index.js";
+export { maybe } from "./globals/index.js";
 
 export type {
   DirectiveInfo,

tsconfig.json

@@ -5,21 +5,30 @@
     "noUnusedParameters": false,
     "noUnusedLocals": true,
     "skipLibCheck": true,
-    "moduleResolution": "node",
+    "moduleResolution": "NodeNext",
     "importHelpers": true,
     "sourceMap": true,
     "inlineSources": true,
     "declaration": true,
     "declarationMap": true,
     "target": "ESNext",
-    "module": "ESNext",
+    "module": "NodeNext",
     "esModuleInterop": true,
     "experimentalDecorators": true,
     "outDir": "./dist",
-    "lib": ["es2015", "esnext.asynciterable"],
+    "rootDir": "./src",
+    "lib": [
+      "es2015",
+      "esnext.asynciterable"
+    ],
     "jsx": "react",
     "strict": true
   },
-  "include": ["src/**/*.ts", "src/**/*.tsx"],
-  "exclude": ["src/**/__tests__/**/*"]
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.tsx"
+  ],
+  "exclude": [
+    "src/**/__tests__/**/*"
+  ]
 }