Version Packages (next)

latticexyz · Oct 31, 2023 · e9a8389 · e9a8389
1 parent de47d69
commit e9a8389
Show file tree

Hide file tree

Showing 63 changed files with 445 additions and 36 deletions.
diff --git a/.changeset/pre.json b/.changeset/pre.json
@@ -67,6 +67,8 @@
     "eighty-pots-report",
     "eighty-tigers-argue",
     "empty-planes-kiss",
+    "empty-starfishes-lick",
+    "fair-buckets-dress",
     "fast-ears-hug",
     "fast-zebras-drum",
     "fast-zebras-promise",
@@ -75,6 +77,7 @@
     "few-mirrors-reflect",
     "few-papayas-leave",
     "fifty-squids-eat",
+    "fifty-suits-itch",
     "fifty-suits-shout",
     "flat-trainers-marry",
     "fluffy-moles-march",
@@ -168,6 +171,7 @@
     "serious-plants-itch",
     "seven-flies-chew",
     "seven-mangos-roll",
+    "sharp-falcons-tie",
     "sharp-worms-kneel",
     "short-ads-jog",
     "short-dragons-shout",
@@ -183,6 +187,7 @@
     "slimy-glasses-tickle",
     "small-boxes-rush",
     "small-chicken-repair",
+    "small-dots-poke",
     "small-pots-press",
     "smooth-elephants-wave",
     "smooth-pots-nail",
@@ -210,6 +215,7 @@
     "thin-terms-lay",
     "thirty-cups-provide",
     "three-lizards-shave",
+    "three-scissors-smile",
     "tough-flowers-breathe",
     "tricky-beds-kiss",
     "tricky-carrots-talk",

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,83 @@
+## Version 2.0.0-next.13
+
+Release date: Tue Oct 31 2023
+
+### Major changes
+
+**[feat(store-indexer,store-sync): filter by table and key (#1794)](https://github.com/latticexyz/mud/commit/f6d214e3d79f9591fddd3687aa987a57f417256c)** (@latticexyz/store-indexer)
+
+Removed `tableIds` filter option in favor of the more flexible `filters` option that accepts `tableId` and an optional `key0` and/or `key1` to filter data by tables and keys.
+
+If you were using an indexer client directly, you'll need to update your query:
+
+```diff
+  await indexer.findAll.query({
+    chainId,
+    address,
+-   tableIds: ['0x...'],
++   filters: [{ tableId: '0x...' }],
+  });
+```
+
+### Minor changes
+
+**[feat(store-sync): extra table definitions (#1840)](https://github.com/latticexyz/mud/commit/de47d698f031a28ef8d9e329e3cffc85e904c6a1)** (@latticexyz/store-sync)
+
+Added an optional `tables` option to `syncToRecs` to allow you to sync from tables that may not be expressed by your MUD config. This will be useful for namespaced tables used by [ERC20](https://github.com/latticexyz/mud/pull/1789) and [ERC721](https://github.com/latticexyz/mud/pull/1844) token modules until the MUD config gains [namespace support](https://github.com/latticexyz/mud/issues/994).
+
+Here's how we use this in our example project with the `KeysWithValue` module:
+
+```ts
+syncToRecs({
+  ...
+  tables: {
+    KeysWithValue: {
+      namespace: "keywval",
+      name: "Inventory",
+      tableId: resourceToHex({ type: "table", namespace: "keywval", name: "Inventory" }),
+      keySchema: {
+        valueHash: { type: "bytes32" },
+      },
+      valueSchema: {
+        keysWithValue: { type: "bytes32[]" },
+      },
+    },
+  },
+  ...
+});
+```
+
+**[feat(store-indexer,store-sync): filter by table and key (#1794)](https://github.com/latticexyz/mud/commit/f6d214e3d79f9591fddd3687aa987a57f417256c)** (@latticexyz/store-sync)
+
+Added a `filters` option to store sync to allow filtering client data on tables and keys. Previously, it was only possible to filter on `tableIds`, but the new filter option allows for more flexible filtering by key.
+
+If you are building a large MUD application, you can use positional keys as a way to shard data and make it possible to load only the data needed in the client for a particular section of your app. We're using this already in Sky Strife to load match-specific data into match pages without having to load data for all matches, greatly improving load time and client performance.
+
+```ts
+syncToRecs({
+  ...
+  filters: [{ tableId: '0x...', key0: '0x...' }],
+});
+```
+
+The `tableIds` option is now deprecated and will be removed in the future, but is kept here for backwards compatibility.
+
+**[feat(store): add experimental config resolve helper (#1826)](https://github.com/latticexyz/mud/commit/b1d41727d4b1964ad3cd907c1c2126b02172b413)** (@latticexyz/common)
+
+Added a `mapObject` helper to map the value of each property of an object to a new value.
+
+### Patch changes
+
+**[fix(create-mud): set store address in PostDeploy script (#1817)](https://github.com/latticexyz/mud/commit/c5148da763645e0adc1250245ea447904014bef2)** (create-mud)
+
+Updated templates' PostDeploy script to set store address so that tables can be used directly inside PostDeploy.
+
+**[fix(common,config): remove chalk usage (#1824)](https://github.com/latticexyz/mud/commit/3e057061da17dd2d0c5fd23e6f5a027bdf9a9223)** (@latticexyz/common, @latticexyz/config)
+
+Removed chalk usage from modules imported in client fix downstream client builds (vite in particular).
+
+---
+
 ## Version 2.0.0-next.12
 
 Release date: Fri Oct 20 2023

diff --git a/docs/pages/changelog.mdx b/docs/pages/changelog.mdx
@@ -1,3 +1,83 @@
+## Version 2.0.0-next.13
+
+Release date: Tue Oct 31 2023
+
+### Major changes
+
+**[feat(store-indexer,store-sync): filter by table and key (#1794)](https://github.com/latticexyz/mud/commit/f6d214e3d79f9591fddd3687aa987a57f417256c)** (@latticexyz/store-indexer)
+
+Removed `tableIds` filter option in favor of the more flexible `filters` option that accepts `tableId` and an optional `key0` and/or `key1` to filter data by tables and keys.
+
+If you were using an indexer client directly, you'll need to update your query:
+
+```diff
+  await indexer.findAll.query({
+    chainId,
+    address,
+-   tableIds: ['0x...'],
++   filters: [{ tableId: '0x...' }],
+  });
+```
+
+### Minor changes
+
+**[feat(store-sync): extra table definitions (#1840)](https://github.com/latticexyz/mud/commit/de47d698f031a28ef8d9e329e3cffc85e904c6a1)** (@latticexyz/store-sync)
+
+Added an optional `tables` option to `syncToRecs` to allow you to sync from tables that may not be expressed by your MUD config. This will be useful for namespaced tables used by [ERC20](https://github.com/latticexyz/mud/pull/1789) and [ERC721](https://github.com/latticexyz/mud/pull/1844) token modules until the MUD config gains [namespace support](https://github.com/latticexyz/mud/issues/994).
+
+Here's how we use this in our example project with the `KeysWithValue` module:
+
+```ts
+syncToRecs({
+  ...
+  tables: {
+    KeysWithValue: {
+      namespace: "keywval",
+      name: "Inventory",
+      tableId: resourceToHex({ type: "table", namespace: "keywval", name: "Inventory" }),
+      keySchema: {
+        valueHash: { type: "bytes32" },
+      },
+      valueSchema: {
+        keysWithValue: { type: "bytes32[]" },
+      },
+    },
+  },
+  ...
+});
+```
+
+**[feat(store-indexer,store-sync): filter by table and key (#1794)](https://github.com/latticexyz/mud/commit/f6d214e3d79f9591fddd3687aa987a57f417256c)** (@latticexyz/store-sync)
+
+Added a `filters` option to store sync to allow filtering client data on tables and keys. Previously, it was only possible to filter on `tableIds`, but the new filter option allows for more flexible filtering by key.
+
+If you are building a large MUD application, you can use positional keys as a way to shard data and make it possible to load only the data needed in the client for a particular section of your app. We're using this already in Sky Strife to load match-specific data into match pages without having to load data for all matches, greatly improving load time and client performance.
+
+```ts
+syncToRecs({
+  ...
+  filters: [{ tableId: '0x...', key0: '0x...' }],
+});
+```
+
+The `tableIds` option is now deprecated and will be removed in the future, but is kept here for backwards compatibility.
+
+**[feat(store): add experimental config resolve helper (#1826)](https://github.com/latticexyz/mud/commit/b1d41727d4b1964ad3cd907c1c2126b02172b413)** (@latticexyz/common)
+
+Added a `mapObject` helper to map the value of each property of an object to a new value.
+
+### Patch changes
+
+**[fix(create-mud): set store address in PostDeploy script (#1817)](https://github.com/latticexyz/mud/commit/c5148da763645e0adc1250245ea447904014bef2)** (create-mud)
+
+Updated templates' PostDeploy script to set store address so that tables can be used directly inside PostDeploy.
+
+**[fix(common,config): remove chalk usage (#1824)](https://github.com/latticexyz/mud/commit/3e057061da17dd2d0c5fd23e6f5a027bdf9a9223)** (@latticexyz/common, @latticexyz/config)
+
+Removed chalk usage from modules imported in client fix downstream client builds (vite in particular).
+
+---
+
 ## Version 2.0.0-next.12
 
 Release date: Fri Oct 20 2023

diff --git a/packages/abi-ts/CHANGELOG.md b/packages/abi-ts/CHANGELOG.md
@@ -1,5 +1,7 @@
 # @latticexyz/abi-ts
 
+## 2.0.0-next.13
+
 ## 2.0.0-next.12
 
 ### Minor Changes

diff --git a/packages/abi-ts/package.json b/packages/abi-ts/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/abi-ts",
-  "version": "2.0.0-next.12",
+  "version": "2.0.0-next.13",
   "description": "Create TypeScript type declaration files (`.d.ts`) for your ABI JSON files.",
   "repository": {
     "type": "git",

diff --git a/packages/block-logs-stream/CHANGELOG.md b/packages/block-logs-stream/CHANGELOG.md
@@ -1,5 +1,13 @@
 # @latticexyz/block-logs-stream
 
+## 2.0.0-next.13
+
+### Patch Changes
+
+- Updated dependencies [3e057061]
+- Updated dependencies [b1d41727]
+  - @latticexyz/common@2.0.0-next.13
+
 ## 2.0.0-next.12
 
 ### Patch Changes

diff --git a/packages/block-logs-stream/package.json b/packages/block-logs-stream/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/block-logs-stream",
-  "version": "2.0.0-next.12",
+  "version": "2.0.0-next.13",
   "description": "Create a stream of EVM block logs for events",
   "repository": {
     "type": "git",

diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
@@ -1,5 +1,23 @@
 # Change Log
 
+## 2.0.0-next.13
+
+### Patch Changes
+
+- Updated dependencies [3e057061]
+- Updated dependencies [b1d41727]
+  - @latticexyz/common@2.0.0-next.13
+  - @latticexyz/config@2.0.0-next.13
+  - @latticexyz/protocol-parser@2.0.0-next.13
+  - @latticexyz/store@2.0.0-next.13
+  - @latticexyz/world@2.0.0-next.13
+  - @latticexyz/world-modules@2.0.0-next.13
+  - @latticexyz/abi-ts@2.0.0-next.13
+  - @latticexyz/gas-report@2.0.0-next.13
+  - @latticexyz/schema-type@2.0.0-next.13
+  - @latticexyz/services@2.0.0-next.13
+  - @latticexyz/utils@2.0.0-next.13
+
 ## 2.0.0-next.12
 
 ### Major Changes

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/cli",
-  "version": "2.0.0-next.12",
+  "version": "2.0.0-next.13",
   "description": "Command line interface for mud",
   "repository": {
     "type": "git",

diff --git a/packages/common/CHANGELOG.md b/packages/common/CHANGELOG.md
@@ -1,5 +1,16 @@
 # Change Log
 
+## 2.0.0-next.13
+
+### Minor Changes
+
+- b1d41727: Added a `mapObject` helper to map the value of each property of an object to a new value.
+
+### Patch Changes
+
+- 3e057061: Removed chalk usage from modules imported in client fix downstream client builds (vite in particular).
+  - @latticexyz/schema-type@2.0.0-next.13
+
 ## 2.0.0-next.12
 
 ### Minor Changes

diff --git a/packages/common/package.json b/packages/common/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/common",
-  "version": "2.0.0-next.12",
+  "version": "2.0.0-next.13",
   "description": "Common low level logic shared between packages",
   "repository": {
     "type": "git",

diff --git a/packages/config/CHANGELOG.md b/packages/config/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Change Log
 
+## 2.0.0-next.13
+
+### Patch Changes
+
+- 3e057061: Removed chalk usage from modules imported in client fix downstream client builds (vite in particular).
+- Updated dependencies [3e057061]
+- Updated dependencies [b1d41727]
+  - @latticexyz/common@2.0.0-next.13
+  - @latticexyz/schema-type@2.0.0-next.13
+
 ## 2.0.0-next.12
 
 ### Patch Changes

diff --git a/packages/config/package.json b/packages/config/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/config",
-  "version": "2.0.0-next.12",
+  "version": "2.0.0-next.13",
   "description": "Config for Store and World",
   "repository": {
     "type": "git",

diff --git a/packages/create-mud/CHANGELOG.md b/packages/create-mud/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Change Log
 
+## 2.0.0-next.13
+
+### Patch Changes
+
+- c5148da7: Updated templates' PostDeploy script to set store address so that tables can be used directly inside PostDeploy.
+
 ## 2.0.0-next.12
 
 ### Patch Changes

diff --git a/packages/create-mud/package.json b/packages/create-mud/package.json
@@ -1,6 +1,6 @@
 {
   "name": "create-mud",
-  "version": "2.0.0-next.12",
+  "version": "2.0.0-next.13",
   "description": "Create a new MUD project",
   "license": "MIT",
   "author": "Lattice <[email protected]>",

diff --git a/packages/dev-tools/CHANGELOG.md b/packages/dev-tools/CHANGELOG.md
@@ -1,5 +1,21 @@
 # @latticexyz/dev-tools
 
+## 2.0.0-next.13
+
+### Patch Changes
+
+- Updated dependencies [de47d698]
+- Updated dependencies [f6d214e3]
+- Updated dependencies [3e057061]
+- Updated dependencies [b1d41727]
+  - @latticexyz/store-sync@2.0.0-next.13
+  - @latticexyz/common@2.0.0-next.13
+  - @latticexyz/store@2.0.0-next.13
+  - @latticexyz/world@2.0.0-next.13
+  - @latticexyz/react@2.0.0-next.13
+  - @latticexyz/recs@2.0.0-next.13
+  - @latticexyz/utils@2.0.0-next.13
+
 ## 2.0.0-next.12
 
 ### Patch Changes

diff --git a/packages/dev-tools/package.json b/packages/dev-tools/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/dev-tools",
-  "version": "2.0.0-next.12",
+  "version": "2.0.0-next.13",
   "description": "MUD developer tools",
   "repository": {
     "type": "git",
@@ -50,12 +50,12 @@
     "vitest": "0.31.4"
   },
   "peerDependencies": {
-    "@latticexyz/common": "2.0.0-next.12",
-    "@latticexyz/recs": "2.0.0-next.12",
-    "@latticexyz/store": "2.0.0-next.12",
-    "@latticexyz/store-sync": "2.0.0-next.12",
-    "@latticexyz/utils": "2.0.0-next.12",
-    "@latticexyz/world": "2.0.0-next.12"
+    "@latticexyz/common": "2.0.0-next.13",
+    "@latticexyz/recs": "2.0.0-next.13",
+    "@latticexyz/store": "2.0.0-next.13",
+    "@latticexyz/store-sync": "2.0.0-next.13",
+    "@latticexyz/utils": "2.0.0-next.13",
+    "@latticexyz/world": "2.0.0-next.13"
   },
   "publishConfig": {
     "access": "public"