build: allow use by TypeScript projects with bundler/node16 config (

#2084) Co-authored-by: Kevin Ingersoll <[email protected]>
latticexyz · Jan 2, 2024 · 5905420 · 5905420
1 parent 6672838
commit 5905420
Show file tree

Hide file tree

Showing 22 changed files with 63 additions and 21 deletions.
diff --git a/.changeset/poor-beans-beg.md b/.changeset/poor-beans-beg.md
@@ -0,0 +1,23 @@
+---
+"@latticexyz/abi-ts": patch
+"@latticexyz/block-logs-stream": patch
+"@latticexyz/common": patch
+"@latticexyz/config": patch
+"@latticexyz/dev-tools": patch
+"@latticexyz/faucet": patch
+"@latticexyz/gas-report": patch
+"@latticexyz/noise": patch
+"@latticexyz/phaserx": patch
+"@latticexyz/protocol-parser": patch
+"@latticexyz/react": patch
+"@latticexyz/recs": patch
+"@latticexyz/schema-type": patch
+"@latticexyz/services": patch
+"@latticexyz/store-sync": patch
+"@latticexyz/store": patch
+"@latticexyz/utils": patch
+"@latticexyz/world-modules": patch
+"@latticexyz/world": patch
+---
+
+TS packages now generate their respective `.d.ts` type definition files for better compatibility when using MUD with `moduleResolution` set to `bundler` or `node16` and fixes issues around missing type declarations for dependent packages.
diff --git a/packages/abi-ts/tsup.config.ts b/packages/abi-ts/tsup.config.ts
@@ -4,7 +4,7 @@ export default defineConfig({
   entry: ["src/index.ts", "src/abi-ts.ts"],
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/block-logs-stream/tsup.config.ts b/packages/block-logs-stream/tsup.config.ts
@@ -4,7 +4,7 @@ export default defineConfig({
   entry: ["src/index.ts"],
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/common/src/codegen/modules.d.ts b/packages/common/src/codegen/modules.d.ts
@@ -1 +1 @@
-declare module "prettier-plugin-solidity";
+declare module "prettier-plugin-solidity" {}
diff --git a/packages/common/tsup.config.ts b/packages/common/tsup.config.ts
@@ -12,7 +12,7 @@ export default defineConfig({
   },
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/config/tsup.config.ts b/packages/config/tsup.config.ts
@@ -4,7 +4,7 @@ export default defineConfig({
   entry: ["src/library/index.ts", "src/register/index.ts", "src/node/index.ts"],
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/dev-tools/src/router.tsx b/packages/dev-tools/src/router.tsx
@@ -9,7 +9,26 @@ import { ComponentData } from "./recs/ComponentData";
 import { TablesPage } from "./zustand/TablesPage";
 import { TableData } from "./zustand/TableData";
 
-export const router = createMemoryRouter(
+/*
+This workaround is necessary to pass `tsc --declaration`. Without it, the following error occurs:
+
+```
+error TS2742: The inferred type of 'router' cannot be named without a reference to '.pnpm/@[email protected]/node_modules/@remix-run/router'.
+This is likely not portable. A type annotation is necessary.
+```
+
+This `tsc --declaration` issue arises under the following combined conditions:
+
+1. pnpm is the package manager.
+2. The source uses a function from the dependency package (this time, react-router-dom's createMemoryRouter) and relies on type inference for its return type.
+3. The inferred return type originates from a package that is not a direct dependency of the source (this time, @remix-run/router's Router).
+4. The dependency package containing the function (react-router-dom) does not re-export the function's return type (Router).
+
+See https://github.com/microsoft/TypeScript/issues/47663#issuecomment-1519138189
+*/
+type Router = ReturnType<typeof createMemoryRouter>;
+
+export const router: Router = createMemoryRouter(
   createRoutesFromElements(
     <Route path="/" element={<RootPage />} errorElement={<RouteError />}>
       <Route index element={<SummaryPage />} />

diff --git a/packages/dev-tools/tsup.config.ts b/packages/dev-tools/tsup.config.ts
@@ -16,7 +16,7 @@ export default defineConfig({
   entry: ["src/index.ts"],
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/faucet/tsup.config.ts b/packages/faucet/tsup.config.ts
@@ -4,7 +4,7 @@ export default defineConfig({
   entry: ["src/index.ts", "bin/faucet-server.ts"],
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/gas-report/tsup.config.ts b/packages/gas-report/tsup.config.ts
@@ -4,7 +4,7 @@ export default defineConfig({
   entry: ["ts/index.ts", "ts/gas-report.ts"],
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/noise/tsup.config.ts b/packages/noise/tsup.config.ts
@@ -4,7 +4,7 @@ export default defineConfig({
   entry: ["ts/index.ts"],
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/phaserx/tsup.config.ts b/packages/phaserx/tsup.config.ts
@@ -4,7 +4,7 @@ export default defineConfig({
   entry: ["src/index.ts"],
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/protocol-parser/tsup.config.ts b/packages/protocol-parser/tsup.config.ts
@@ -4,7 +4,7 @@ export default defineConfig({
   entry: ["src/index.ts"],
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/react/tsup.config.ts b/packages/react/tsup.config.ts
@@ -4,7 +4,7 @@ export default defineConfig({
   entry: ["src/index.ts"],
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/recs/tsup.config.ts b/packages/recs/tsup.config.ts
@@ -4,7 +4,7 @@ export default defineConfig({
   entry: ["src/index.ts", "src/deprecated/index.ts"],
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/schema-type/tsup.config.ts b/packages/schema-type/tsup.config.ts
@@ -5,7 +5,7 @@ export default defineConfig({
   outDir: "dist/typescript",
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/services/tsup.config.ts b/packages/services/tsup.config.ts
@@ -6,7 +6,7 @@ export default defineConfig({
   },
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
 });
diff --git a/packages/store-sync/tsup.config.ts b/packages/store-sync/tsup.config.ts
@@ -13,7 +13,7 @@ export default defineConfig({
   ],
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/store/tsup.config.ts b/packages/store/tsup.config.ts
@@ -4,7 +4,7 @@ export default defineConfig({
   entry: ["mud.config.ts", "ts/index.ts", "ts/codegen/index.ts", "ts/config/index.ts", "ts/register/index.ts"],
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/utils/tsup.config.ts b/packages/utils/tsup.config.ts
@@ -4,7 +4,7 @@ export default defineConfig({
   entry: ["src/index.ts"],
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/world-modules/tsup.config.ts b/packages/world-modules/tsup.config.ts
@@ -4,7 +4,7 @@ export default defineConfig({
   entry: ["mud.config.ts"],
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,

diff --git a/packages/world/tsup.config.ts b/packages/world/tsup.config.ts
@@ -4,7 +4,7 @@ export default defineConfig({
   entry: ["mud.config.ts", "ts/index.ts", "ts/register/index.ts", "ts/node/index.ts"],
   target: "esnext",
   format: ["esm"],
-  dts: false,
+  dts: true,
   sourcemap: true,
   clean: true,
   minify: true,
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		declare module "prettier-plugin-solidity";
		declare module "prettier-plugin-solidity" {}