refactor: move table ID and field layout constants into table library (…

…#2327)

.changeset/few-berries-tickle.md

@@ -0,0 +1,21 @@
+---
+"create-mud": patch
+"@latticexyz/cli": major
+"@latticexyz/common": major
+"@latticexyz/store": patch
+"@latticexyz/world": patch
+"@latticexyz/world-modules": patch
+---
+
+Moved table ID and field layout constants in code-generated table libraries from the file level into the library, for clearer access and cleaner imports.
+
+```diff
+-import { SomeTable, SomeTableTableId } from "./codegen/tables/SomeTable.sol";
++import { SomeTable } from "./codegen/tables/SomeTable.sol";
+
+-console.log(SomeTableTableId);
++console.log(SomeTable._tableId);
+
+-console.log(SomeTable.getFieldLayout());
++console.log(SomeTable._fieldLayout);
+```

e2e/packages/contracts/src/systems/NumberListSystem.sol

@@ -4,7 +4,7 @@ pragma solidity >=0.8.24;
 import { StoreSwitch } from "@latticexyz/store/src/StoreSwitch.sol";
 import { EncodeArray } from "@latticexyz/store/src/tightcoder/EncodeArray.sol";
 import { System } from "@latticexyz/world/src/System.sol";
-import { NumberList, NumberListTableId } from "../codegen/index.sol";
+import { NumberList } from "../codegen/index.sol";
 
 contract NumberListSystem is System {
   function set(uint32[] memory list) public {
@@ -22,7 +22,7 @@ contract NumberListSystem is System {
     }
 
     bytes32[] memory emptyKey;
-    StoreSwitch.pushToDynamicField(NumberListTableId, emptyKey, 0, EncodeArray.encode(list));
+    StoreSwitch.pushToDynamicField(NumberList._tableId, emptyKey, 0, EncodeArray.encode(list));
   }
 
   function pop() public {

examples/minimal/packages/contracts/script/PostDeploy.s.sol

@@ -7,7 +7,7 @@ import { StoreSwitch } from "@latticexyz/store/src/StoreSwitch.sol";
 import { ResourceId, WorldResourceIdLib, WorldResourceIdInstance } from "@latticexyz/world/src/WorldResourceId.sol";
 import { RESOURCE_SYSTEM } from "@latticexyz/world/src/worldResourceTypes.sol";
 
-import { MessageTable, MessageTableTableId } from "../src/codegen/index.sol";
+import { MessageTable } from "../src/codegen/index.sol";
 import { IWorld } from "../src/codegen/world/IWorld.sol";
 import { ChatNamespacedSystem } from "../src/systems/ChatNamespacedSystem.sol";
 
@@ -36,7 +36,7 @@ contract PostDeploy is Script {
     IWorld(worldAddress).registerFunctionSelector(systemId, "sendMessage(string)");
 
     // Grant this system access to MessageTable
-    IWorld(worldAddress).grantAccess(MessageTableTableId, address(chatNamespacedSystem));
+    IWorld(worldAddress).grantAccess(MessageTable._tableId, address(chatNamespacedSystem));
 
     // ------------------ EXAMPLES ------------------
 

examples/minimal/packages/contracts/test/ChatNamespaced.t.sol

@@ -7,7 +7,7 @@ import { getKeysWithValue } from "@latticexyz/world-modules/src/modules/keyswith
 import { StoreCore } from "@latticexyz/store/src/StoreCore.sol";
 
 import { IWorld } from "../src/codegen/world/IWorld.sol";
-import { MessageTable, MessageTableTableId } from "../src/codegen/index.sol";
+import { MessageTable } from "../src/codegen/index.sol";
 import { IChatNamespacedSystem } from "../src/interfaces/IChatNamespacedSystem.sol";
 
 contract ChatNamespacedTest is MudTest {
@@ -16,7 +16,7 @@ contract ChatNamespacedTest is MudTest {
     string memory value = "test";
     vm.expectEmit(true, true, true, true);
     emit StoreCore.Store_SetRecord(
-      MessageTableTableId,
+      MessageTable._tableId,
       keyTuple,
       new bytes(0),
       MessageTable.encodeLengths(value),

examples/minimal/packages/contracts/test/CounterTest.t.sol

@@ -6,7 +6,7 @@ import { MudTest } from "@latticexyz/world/test/MudTest.t.sol";
 import { getKeysWithValue } from "@latticexyz/world-modules/src/modules/keyswithvalue/getKeysWithValue.sol";
 
 import { IWorld } from "../src/codegen/world/IWorld.sol";
-import { CounterTable, CounterTableTableId } from "../src/codegen/index.sol";
+import { CounterTable } from "../src/codegen/index.sol";
 
 contract CounterTest is MudTest {
   function testWorldExists() public {
@@ -32,7 +32,7 @@ contract CounterTest is MudTest {
   // TODO: re-enable the KeysWithValueModule in mud.config.ts once it supports singleton keys
   // function testKeysWithValue() public {
   //   uint32 counter = CounterTable.get();
-  //   bytes32[] memory keysWithValue = getKeysWithValue(CounterTableTableId, CounterTable.encode(counter));
+  //   bytes32[] memory keysWithValue = getKeysWithValue(CounterTable._tableId, CounterTable.encode(counter));
   //   assertEq(keysWithValue.length, 1);
   // }
 }

examples/minimal/packages/contracts/test/StructTest.t.sol

@@ -6,7 +6,7 @@ import { MudTest } from "@latticexyz/world/test/MudTest.t.sol";
 import { getKeysWithValue } from "@latticexyz/world-modules/src/modules/keyswithvalue/getKeysWithValue.sol";
 
 import { IWorld } from "../src/codegen/world/IWorld.sol";
-import { CounterTable, CounterTableTableId } from "../src/codegen/index.sol";
+import { CounterTable } from "../src/codegen/index.sol";
 import { BytesStruct, StringStruct } from "../src/systems/structs.sol";
 
 contract StructTest is MudTest {