diff --git a/.changeset/chatty-pigs-shake.md b/.changeset/chatty-pigs-shake.md new file mode 100644 index 0000000000..aa672452bd --- /dev/null +++ b/.changeset/chatty-pigs-shake.md @@ -0,0 +1,11 @@ +--- +"@latticexyz/stash": patch +--- + +Added `@latticexyz/stash` package, a TypeScript client state library optimized for the MUD Store data model. +It uses the MUD store config to define local tables, which support writing, reading and subscribing to table updates. +It comes with a query engine optimized for "ECS-style" queries (similar to `@latticexyz/recs`) but with native support for composite keys. + +You can find usage examples in the [`@latticexyz/stash` README.md](https://github.com/latticexyz/mud/blob/main/packages/stash/README.md). + +This package is experimental and will have breaking changes while we refine its APIs and implementation. All of its exports are temporarily under `@latticexyz/stash/internal` until we consider it stable. diff --git a/packages/stash/README.md b/packages/stash/README.md index 843c74caf1..18cb615c3d 100644 --- a/packages/stash/README.md +++ b/packages/stash/README.md @@ -1,5 +1,8 @@ # Stash +> [!WARNING] +> This package is experimental and will have breaking changes while we refine its APIs and implementation. All of its exports are temporarily under `@latticexyz/stash/internal` until we consider it stable. + Stash is a client state library optimized for the MUD data model. It uses the MUD store config to define local tables, which support writing, reading and subscribing to table updates. It comes with a query engine optimized for ["ECS-style"](https://mud.dev/ecs) queries (similar to `@latticexyz/recs`) but with native support for composite keys. diff --git a/packages/stash/package.json b/packages/stash/package.json index 640132f190..056653dab2 100644 --- a/packages/stash/package.json +++ b/packages/stash/package.json @@ -1,7 +1,6 @@ { "name": "@latticexyz/stash", "version": "2.2.5", - "private": true, "description": "High performance client store and query engine for MUD", "repository": { "type": "git",