Simplify internal types (#30190)

Simplify internal types setup by adding an export condition for them.

GitOrigin-RevId: 10224f310264de74bf437e8ffe926fd08bf82811

Author: thomasballinger

.npmignore

@@ -16,7 +16,8 @@ dist/internal-types/test
 dist/types/test
 test_fixtures
 src/test
-custom-vitest-environment
+custom-vitest-environment.ts
+vitest.config.js
 
 .eslintrc.*
 .prettierignore
@@ -30,9 +31,10 @@ build.py
 build.cjs
 tmpPackage*
 tmpDist*
-api-extractor-configs/temp/
+api-extractor-configs/
 *.log
 .knip.json
+.github
 
 # rush output
 *.chunks.jsonl

package.json

@@ -16,91 +16,139 @@
   "exports": {
     ".": {
       "require": {
-        "types": "./dist/internal-cjs-types/index.d.ts",
+        "convex-internal-types": {
+          "types": "./dist/internal-cjs-types/index.d.ts"
+        },
+        "types": "./dist/cjs-types/index.d.ts",
         "require": "./dist/cjs/index.js"
       },
       "import": {
-        "types": "./dist/internal-esm-types/index.d.ts",
+        "convex-internal-types": {
+          "types": "./dist/internal-esm-types/index.d.ts"
+        },
+        "types": "./dist/esm-types/index.d.ts",
         "import": "./dist/esm/index.js"
       }
     },
     "./server": {
       "require": {
-        "types": "./dist/internal-cjs-types/server/index.d.ts",
+        "convex-internal-types": {
+          "types": "./dist/internal-cjs-types/server/index.d.ts"
+        },
+        "types": "./dist/cjs-types/server/index.d.ts",
         "require": "./dist/cjs/server/index.js"
       },
       "import": {
-        "types": "./dist/internal-esm-types/server/index.d.ts",
+        "convex-internal-types": {
+          "types": "./dist/internal-esm-types/server/index.d.ts"
+        },
+        "types": "./dist/esm-types/server/index.d.ts",
         "import": "./dist/esm/server/index.js"
       }
     },
     "./react": {
       "require": {
-        "types": "./dist/internal-cjs-types/react/index.d.ts",
+        "convex-internal-types": {
+          "types": "./dist/internal-cjs-types/react/index.d.ts"
+        },
+        "types": "./dist/cjs-types/react/index.d.ts",
         "require": "./dist/cjs/react/index.js"
       },
       "import": {
-        "types": "./dist/internal-esm-types/react/index.d.ts",
+        "convex-internal-types": {
+          "types": "./dist/internal-esm-types/react/index.d.ts"
+        },
+        "types": "./dist/esm-types/react/index.d.ts",
         "import": "./dist/esm/react/index.js"
       }
     },
     "./react-auth0": {
       "require": {
-        "types": "./dist/internal-cjs-types/react-auth0/index.d.ts",
+        "convex-internal-types": {
+          "types": "./dist/internal-cjs-types/react-auth0/index.d.ts"
+        },
+        "types": "./dist/cjs-types/react-auth0/index.d.ts",
         "require": "./dist/cjs/react-auth0/index.js"
       },
       "import": {
-        "types": "./dist/internal-esm-types/react-auth0/index.d.ts",
+        "convex-internal-types": {
+          "types": "./dist/internal-esm-types/react-auth0/index.d.ts"
+        },
+        "types": "./dist/esm-types/react-auth0/index.d.ts",
         "import": "./dist/esm/react-auth0/index.js"
       }
     },
     "./react-clerk": {
       "require": {
-        "types": "./dist/internal-cjs-types/react-clerk/index.d.ts",
+        "convex-internal-types": {
+          "types": "./dist/internal-cjs-types/react-clerk/index.d.ts"
+        },
+        "types": "./dist/cjs-types/react-clerk/index.d.ts",
         "require": "./dist/cjs/react-clerk/index.js"
       },
       "import": {
-        "types": "./dist/internal-esm-types/react-clerk/index.d.ts",
+        "convex-internal-types": {
+          "types": "./dist/internal-esm-types/react-clerk/index.d.ts"
+        },
+        "types": "./dist/esm-types/react-clerk/index.d.ts",
         "import": "./dist/esm/react-clerk/index.js"
       }
     },
     "./nextjs": {
       "require": {
-        "types": "./dist/internal-cjs-types/nextjs/index.d.ts",
+        "convex-internal-types": {
+          "types": "./dist/internal-cjs-types/nextjs/index.d.ts"
+        },
+        "types": "./dist/cjs-types/nextjs/index.d.ts",
         "require": "./dist/cjs/nextjs/index.js"
       },
       "import": {
-        "types": "./dist/internal-esm-types/nextjs/index.d.ts",
+        "convex-internal-types": {
+          "types": "./dist/internal-esm-types/nextjs/index.d.ts"
+        },
+        "types": "./dist/esm-types/nextjs/index.d.ts",
         "import": "./dist/esm/nextjs/index.js"
       }
     },
     "./browser": {
       "require": {
-        "types": "./dist/internal-cjs-types/browser/index.d.ts",
+        "convex-internal-types": {
+          "types": "./dist/internal-cjs-types/browser/index.d.ts"
+        },
+        "types": "./dist/cjs-types/browser/index.d.ts",
         "node": "./dist/cjs/browser/index-node.js",
         "require": "./dist/cjs/browser/index.js"
       },
       "import": {
-        "types": "./dist/internal-esm-types/browser/index.d.ts",
+        "convex-internal-types": {
+          "types": "./dist/internal-esm-types/browser/index.d.ts"
+        },
+        "types": "./dist/esm-types/browser/index.d.ts",
         "node": "./dist/esm/browser/index-node.js",
         "import": "./dist/esm/browser/index.js"
       }
     },
     "./values": {
       "require": {
-        "types": "./dist/internal-cjs-types/values/index.d.ts",
+        "convex-internal-types": {
+          "types": "./dist/internal-cjs-types/values/index.d.ts"
+        },
+        "types": "./dist/cjs-types/values/index.d.ts",
         "require": "./dist/cjs/values/index.js"
       },
       "import": {
-        "types": "./dist/internal-esm-types/values/index.d.ts",
+        "convex-internal-types": {
+          "types": "./dist/internal-esm-types/values/index.d.ts"
+        },
+        "types": "./dist/esm-types/values/index.d.ts",
         "import": "./dist/esm/values/index.js"
       }
     },
     "./package.json": "./package.json"
   },
   "@comment typesVersions": [
-    "This type field in exports is only supported with moduleResolution",
-    "set to node16 or nodenext, which are not yet widely used. "
+    "Thi types field in exports is only supported with moduleResolution",
+    "set to node16 or nodenext so typesVersions is still useful."
   ],
   "typesVersions": {
     "*": {

scripts/postpack.mjs

@@ -25,7 +25,7 @@ console.log("modifying package.json");
 let packageJson = JSON.parse(
   fs.readFileSync(path.join(tmpPackage, "package.json")),
 );
-pointToPublic(packageJson.exports);
+removeInternal(packageJson.exports);
 pointToPublic(packageJson.typesVersions);
 
 console.log("removing dev-only ts-node CLI script");
@@ -56,8 +56,6 @@ fs.rmSync(path.join(tmpPackage, "dist", "internal-esm-types"), {
   recursive: true,
 });
 
-// Remove a few more @internal types
-console.log("modifying types to remove remaining @internal types");
 auditInternal(tmpPackage);
 
 run("tar", "czvf", tarball, "-C", tmpDir, "package");
@@ -75,6 +73,18 @@ function getOnlyTarball(dirname) {
   return path.join(dirname, tarballs[0]);
 }
 
+function removeInternal(obj) {
+  for (const key of Object.keys(obj)) {
+    let value = obj[key];
+    if (key === "convex-internal-types") {
+      delete obj[key];
+    }
+    if (typeof value === "object") {
+      removeInternal(value);
+    }
+  }
+}
+
 function pointToPublic(obj) {
   for (const key of Object.keys(obj)) {
     let value = obj[key];