Fix compatibility with moduleResolution node

Author: arnoud-dv

knip.json

@@ -14,6 +14,9 @@
   ],
   "ignoreWorkspaces": ["examples/**", "integrations/**"],
   "workspaces": {
+    "packages/angular-query-experimental": {
+      "ignore": ["**/production/index.ts"]
+    },
     "packages/query-codemods": {
       "entry": ["src/v4/**/*.cjs", "src/v5/**/*.cjs"],
       "ignore": ["**/__testfixtures__/**"]

packages/angular-query-experimental/DEVELOPMENT.md

@@ -0,0 +1,34 @@
+# Angular adapter development
+
+## Subpath exports and moduleResolution: node
+
+Many applications including NX monorepos and older Angular CLI applications still specify `moduleResolution: node` in their tsconfig.
+To maintain compatibility with these applications,
+exports should strictly export types from the same path as the subpath so that TypeScript can resolve the types.
+
+### ✅ Compatible
+```json
+{
+  "./devtools/production": {
+    "types": "./devtools/production/index.d.ts",
+    "default": "./devtools/index.mjs"
+  }
+}
+```
+
+### ❌ Not compatible: types are exported from the build directory, which is not part of the export path
+```json
+{
+  "./devtools/production": {
+    "types": "./build/devtools/production/index.d.ts",
+    "default": "./devtools/index.mjs"
+  }
+}
+```
+
+### How are these paths correctly configured?
+
+- tsup.config.js is configured to copy package.json and README.md to the build directory
+- the production subpath exports are configured as dts entry points in tsup.config.js. Note that simply copying generated type declarations can result in incorrect relative imports.
+- package.json contains `publishConfig` which overrides `exports` when publishing the package, excluding `build` in the subpath export paths.
+- The build directory is published instead of the containing directory. This is configured in `scripts/publish.js`

packages/angular-query-experimental/package.json

@@ -42,7 +42,7 @@
     "test:types:tscurrent": "tsc --build",
     "test:lib": "vitest",
     "test:lib:dev": "pnpm run test:lib --watch",
-    "test:build": "publint --strict && attw --pack",
+    "test:build": "publint --strict --pack=false ./build && attw --pack ./build",
     "build": "pnpm build:tsup",
     "build:tsup": "tsup --tsconfig tsconfig.prod.json"
   },
@@ -59,7 +59,7 @@
       "default": "./build/devtools/stub.mjs"
     },
     "./devtools/production": {
-      "types": "./build/devtools/index.d.ts",
+      "types": "./build/devtools/production/index.d.ts",
       "default": "./build/devtools/index.mjs"
     },
     "./devtools-panel": {
@@ -68,7 +68,7 @@
       "default": "./build/devtools-panel/stub.mjs"
     },
     "./devtools-panel/production": {
-      "types": "./build/devtools-panel/index.d.ts",
+      "types": "./build/devtools-panel/production/index.d.ts",
       "default": "./build/devtools-panel/index.mjs"
     },
     "./package.json": {
@@ -77,9 +77,10 @@
   },
   "sideEffects": false,
   "files": [
-    "build",
-    "src",
-    "!src/__tests__"
+    "devtools",
+    "devtools-panel",
+    "index.*",
+    "*.d.ts"
   ],
   "dependencies": {
     "@tanstack/query-core": "workspace:*",
@@ -98,5 +99,34 @@
   "peerDependencies": {
     "@angular/common": ">=16.0.0",
     "@angular/core": ">=16.0.0"
+  },
+  "publishConfig": {
+    "exports":{
+      ".": {
+        "types": "./index.d.ts",
+        "default": "./index.mjs"
+      },
+      "./devtools": {
+        "types": "./devtools/index.d.ts",
+        "development": "./devtools/index.mjs",
+        "default": "./devtools/stub.mjs"
+      },
+      "./devtools/production": {
+        "types": "./devtools/production/index.d.ts",
+        "default": "./devtools/index.mjs"
+      },
+      "./devtools-panel": {
+        "types": "./devtools-panel/index.d.ts",
+        "development": "./devtools-panel/index.mjs",
+        "default": "./devtools-panel/stub.mjs"
+      },
+      "./devtools-panel/production": {
+        "types": "./devtools-panel/production/index.d.ts",
+        "default": "./devtools-panel/index.mjs"
+      },
+      "./package.json": {
+        "default": "./package.json"
+      }
+    }
   }
 }

packages/angular-query-experimental/src/devtools-panel/production/index.ts

@@ -0,0 +1 @@
+export * from '../types'

packages/angular-query-experimental/src/devtools/production/index.ts

@@ -0,0 +1 @@
+export * from '../types'

packages/angular-query-experimental/tsup.config.js

@@ -1,3 +1,5 @@
+import { copyFileSync, mkdirSync } from 'node:fs'
+import { dirname } from 'node:path'
 import { defineConfig } from 'tsup'
 
 export default defineConfig({
@@ -14,7 +16,9 @@ export default defineConfig({
   dts: {
     entry: [
       'src/devtools-panel/index.ts',
+      'src/devtools-panel/production/index.ts',
       'src/devtools/index.ts',
+      'src/devtools/production/index.ts',
       'src/index.ts',
     ],
   },
@@ -24,3 +28,20 @@ export default defineConfig({
   },
   splitting: false,
 })
+
+process.on('beforeExit', (code) => {
+  if (code === 0) {
+    const files = [
+      {
+        from: 'package.json',
+        to: 'build/package.json',
+      },
+      { from: 'README.md', to: 'build/README.md' },
+    ]
+
+    for (const { from, to } of files) {
+      mkdirSync(dirname(to), { recursive: true })
+      copyFileSync(from, to)
+    }
+  }
+})

scripts/publish.js

@@ -86,7 +86,7 @@ await publish({
     },
     {
       name: '@tanstack/angular-query-experimental',
-      packageDir: 'packages/angular-query-experimental',
+      packageDir: 'packages/angular-query-experimental/build',
     },
     // publish when angular-query is stable
     // {