Merge remote-tracking branch 'origin/main' into account-kit

.changeset/flat-swans-turn.md

@@ -0,0 +1,5 @@
+---
+"@latticexyz/store-sync": patch
+---
+
+Refactored `syncToZustand` to use new Store config under the hood, removing compatibility layers and improving performance.

.changeset/good-rice-bathe.md

@@ -0,0 +1,8 @@
+---
+"@latticexyz/config": patch
+"@latticexyz/query": patch
+"@latticexyz/store": patch
+"@latticexyz/world": patch
+---
+
+Bumped `@arktype/util` and moved `evaluate`/`satisfy` usages to its `show`/`satisfy` helpers.

.changeset/ninety-mirrors-pretend.md

@@ -0,0 +1,5 @@
+---
+"@latticexyz/common": patch
+---
+
+Removed `evaluate` and `satisfy` type utils in favor of `show` and `satisfy` from `@arktype/util`.

.changeset/orange-beans-allow.md

@@ -0,0 +1,5 @@
+---
+"@latticexyz/dev-tools": patch
+---
+
+Updated Zustand components after changes to `syncToZustand`.

.changeset/real-pigs-work.md

@@ -0,0 +1,5 @@
+---
+"@latticexyz/store-sync": patch
+---
+
+Refactored `syncToRecs` to use new Store config under the hood, removing compatibility layers and improving performance.

.github/actions/setup-prerequisites/action.yml

@@ -4,7 +4,7 @@ runs:
   using: composite
   steps:
     - name: Setup pnpm
-      uses: pnpm/action-setup@v2
+      uses: pnpm/action-setup@v4
 
     - name: Setup node
       uses: actions/setup-node@v3

.github/workflows/remove-npm-tag.yml

@@ -2,6 +2,11 @@ name: Remove npm tag
 
 on:
   workflow_dispatch:
+    inputs:
+      tag:
+        description: "Tag name in npm"
+        type: string
+        required: true
 
 jobs:
   remove-npm-tag:
@@ -14,11 +19,15 @@ jobs:
           submodules: recursive
           fetch-depth: 0
 
+      - name: Setup
+        uses: ./.github/actions/setup
+
       - name: Set deployment token
         run: npm config set '//registry.npmjs.org/:_authToken' "${NPM_TOKEN}"
         env:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
       - name: Remove npm dist tag
-        run: pnpm dist-tag-rm
-        env: TAG=${{ github.ref_name }}
+        run: pnpm run dist-tag-rm
+        env:
+          TAG: ${{ github.event.inputs.tag }}

package.json

@@ -8,7 +8,7 @@
     "url": "https://github.com/latticexyz/mud.git"
   },
   "scripts": {
-    "all-codegen": "for dir in packages/store packages/world packages/world-modules packages/cli test/mock-game-contracts e2e/packages/contracts examples/*/packages/contracts templates/*/packages/contracts; do (cd \"$dir\" && pwd && pnpm build); done",
+    "all-build": "for dir in packages/store packages/world packages/world-modules packages/cli test/mock-game-contracts e2e/packages/contracts examples/*/packages/contracts templates/*/packages/contracts; do (cd \"$dir\" && pwd && pnpm build); done",
     "all-install": "for dir in . docs e2e examples/* templates/*; do (cd \"$dir\" && pwd && pnpm install); done",
     "bench": "pnpm run --recursive bench",
     "build": "turbo run build",
@@ -37,8 +37,6 @@
     "package.json": "pnpm sort-package-json"
   },
   "devDependencies": {
-    "@arktype/attest": "0.7.5",
-    "@arktype/util": "0.0.43",
     "@changesets/cli": "^2.26.1",
     "@types/node": "^18.15.11",
     "@typescript-eslint/eslint-plugin": "7.1.1",

packages/cli/scripts/generate-test-tables.ts

@@ -2,6 +2,7 @@ import { tablegen } from "@latticexyz/store/codegen";
 import { defineStore } from "@latticexyz/store";
 import { getRemappings } from "@latticexyz/common/foundry";
 import { fileURLToPath } from "node:url";
+import path from "node:path";
 
 const configPath = fileURLToPath(import.meta.url);
 
@@ -97,4 +98,4 @@ const config = defineStore({
 
 const remappings = await getRemappings();
 
-await tablegen({ configPath, config, remappings });
+await tablegen({ rootDir: path.dirname(configPath), config, remappings });

packages/cli/src/build.ts

@@ -10,16 +10,16 @@ type BuildOptions = {
   foundryProfile?: string;
   srcDir: string;
   /**
-   * Path to `mud.config.ts`. We use this as the "project root" to resolve other relative paths.
+   * MUD project root directory where all other relative paths are resolved from.
    *
-   * Defaults to finding the nearest `mud.config.ts`, looking in `process.cwd()` and moving up the directory tree.
+   * Defaults to the directory of the nearest `mud.config.ts`, looking in `process.cwd()` and moving up the directory tree.
    */
-  configPath: string;
+  rootDir: string;
   config: WorldConfig;
 };
 
 export async function build({
-  configPath,
+  rootDir,
   config,
   srcDir,
   foundryProfile = process.env.FOUNDRY_PROFILE,
@@ -28,7 +28,7 @@ export async function build({
   const remappings = await getRemappings(foundryProfile);
 
   await Promise.all([
-    tablegen({ configPath, config, remappings }),
+    tablegen({ rootDir, config, remappings }),
     worldgen(config, getExistingContracts(srcDir), outPath),
   ]);
 

packages/cli/src/commands/build.ts

@@ -1,9 +1,9 @@
 import type { CommandModule } from "yargs";
 import { loadConfig, resolveConfigPath } from "@latticexyz/config/node";
 import { World as WorldConfig } from "@latticexyz/world";
-
 import { getSrcDirectory } from "@latticexyz/common/foundry";
 import { build } from "../build";
+import path from "node:path";
 
 type Options = {
   configPath?: string;
@@ -27,7 +27,7 @@ const commandModule: CommandModule<Options, Options> = {
     const config = (await loadConfig(configPath)) as WorldConfig;
     const srcDir = await getSrcDirectory();
 
-    await build({ configPath, config, srcDir, foundryProfile: opts.profile });
+    await build({ rootDir: path.dirname(configPath), config, srcDir, foundryProfile: opts.profile });
 
     process.exit(0);
   },

packages/cli/src/commands/tablegen.ts

@@ -3,6 +3,7 @@ import { loadConfig, resolveConfigPath } from "@latticexyz/config/node";
 import { Store as StoreConfig } from "@latticexyz/store";
 import { tablegen } from "@latticexyz/store/codegen";
 import { getRemappings } from "@latticexyz/common/foundry";
+import path from "node:path";
 
 type Options = {
   configPath?: string;
@@ -24,7 +25,7 @@ const commandModule: CommandModule<Options, Options> = {
     const config = (await loadConfig(configPath)) as StoreConfig;
     const remappings = await getRemappings();
 
-    await tablegen({ configPath, config, remappings });
+    await tablegen({ rootDir: path.dirname(configPath), config, remappings });
 
     process.exit(0);
   },

packages/cli/src/runDeploy.ts

@@ -83,7 +83,7 @@ export async function runDeploy(opts: DeployOptions): Promise<WorldDeploy> {
 
   // Run build
   if (!opts.skipBuild) {
-    await build({ configPath, config: configV2, srcDir, foundryProfile: profile });
+    await build({ rootDir: path.dirname(configPath), config: configV2, srcDir, foundryProfile: profile });
   }
 
   const resolvedConfig = resolveConfig({ config, forgeSourceDir: srcDir, forgeOutDir: outDir });

packages/common/src/type-utils/index.ts

@@ -1,4 +1,2 @@
 export * from "./abi";
 export * from "./common";
-export * from "./evaluate";
-export * from "./satisfy";

packages/config/package.json

@@ -48,6 +48,7 @@
     "test:ci": "pnpm run test"
   },
   "dependencies": {
+    "@arktype/util": "0.0.40",
     "@latticexyz/common": "workspace:*",
     "@latticexyz/schema-type": "workspace:*",
     "esbuild": "^0.17.15",

packages/config/src/common.ts

@@ -1,7 +1,7 @@
 import { Hex } from "viem";
 import { DynamicAbiType, StaticAbiType } from "@latticexyz/schema-type/internal";
 import { ResourceType } from "@latticexyz/common";
-import { satisfy } from "@latticexyz/common/type-utils";
+import { satisfy } from "@arktype/util";
 
 /**
  * Common output types of a MUD config. We use these types as inputs for libraries.
@@ -31,3 +31,7 @@ export type Table = {
   readonly schema: Schema;
   readonly key: readonly string[];
 };
+
+export type Tables = {
+  readonly [label: string]: Table;
+};

packages/config/src/deprecated/node/loadConfig.ts

@@ -40,7 +40,7 @@ export async function loadConfig(configPath?: string): Promise<unknown> {
 }
 
 /** @deprecated */
-export async function resolveConfigPath(configPath: string | undefined, toFileURL?: boolean) {
+export async function resolveConfigPath(configPath?: string, toFileURL?: boolean) {
   if (configPath === undefined) {
     configPath = await getUserConfigPath();
   } else {

packages/config/src/exports/index.ts

@@ -4,4 +4,4 @@
  * Be sure we're ready to commit to these being supported and changes made backward compatible!
  */
 
-export type { AbiType, StaticAbiType, DynamicAbiType, Schema, Table } from "../common";
+export type { AbiType, StaticAbiType, DynamicAbiType, Schema, Table, Tables } from "../common";

packages/dev-tools/src/zustand/TableDataTable.tsx

@@ -1,6 +1,6 @@
-import { Table } from "@latticexyz/store/internal";
 import { useRecords } from "./useRecords";
 import { FieldValue } from "./FieldValue";
+import { Table } from "@latticexyz/store-sync/zustand";
 
 // TODO: use react-table or similar for better perf with lots of logs
 
@@ -15,12 +15,7 @@ export function TableDataTable({ table }: Props) {
     <table className="w-full -mx-1">
       <thead className="sticky top-0 z-10 bg-slate-800 text-left">
         <tr className="text-amber-200/80 font-mono">
-          {Object.keys(table.keySchema).map((name) => (
-            <th key={name} className="px-1.5 pt-1.5 font-normal">
-              {name}
-            </th>
-          ))}
-          {Object.keys(table.valueSchema).map((name) => (
+          {Object.keys(table.schema).map((name) => (
             <th key={name} className="px-1.5 pt-1.5 font-normal">
               {name}
             </th>
@@ -31,14 +26,9 @@ export function TableDataTable({ table }: Props) {
         {records.map((record) => {
           return (
             <tr key={record.id}>
-              {Object.keys(table.keySchema).map((name) => (
-                <td key={name} className="px-1.5 whitespace-nowrap overflow-hidden text-ellipsis">
-                  <FieldValue value={record.key[name]} />
-                </td>
-              ))}
-              {Object.keys(table.valueSchema).map((name) => (
+              {Object.keys(table.schema).map((name) => (
                 <td key={name} className="px-1.5 whitespace-nowrap overflow-hidden text-ellipsis">
-                  <FieldValue value={record.value[name]} />
+                  <FieldValue value={record.fields[name]} />
                 </td>
               ))}
             </tr>

packages/dev-tools/src/zustand/useRecords.ts

@@ -1,7 +1,6 @@
-import { Table } from "@latticexyz/store/internal";
 import { useDevToolsContext } from "../DevToolsContext";
 import { useEffect, useState } from "react";
-import { TableRecord } from "@latticexyz/store-sync/zustand";
+import { Table, TableRecord } from "@latticexyz/store-sync/zustand";
 
 export function useRecords<table extends Table>(table: table): TableRecord<table>[] {
   const { useStore } = useDevToolsContext();

packages/dev-tools/src/zustand/useTables.ts

@@ -1,6 +1,6 @@
-import { Table } from "@latticexyz/store/internal";
 import { useDevToolsContext } from "../DevToolsContext";
 import { useEffect, useState } from "react";
+import { Table } from "@latticexyz/store-sync/zustand";
 
 export function useTables(): Table[] {
   const { useStore } = useDevToolsContext();

packages/protocol-parser/src/common.ts

@@ -30,6 +30,7 @@ export type KeySchema<userTypes extends UserTypes | undefined = undefined> = Rec
   string,
   userTypes extends UserTypes ? StaticAbiType | keyof userTypes : StaticAbiType
 >;
+
 export type ValueSchema<userTypes extends UserTypes | undefined = undefined> = Record<
   string,
   userTypes extends UserTypes ? SchemaAbiType | keyof userTypes : SchemaAbiType

packages/query/package.json

@@ -34,6 +34,7 @@
     "test:ci": "pnpm run test"
   },
   "dependencies": {
+    "@arktype/util": "0.0.40",
     "@latticexyz/common": "workspace:*",
     "@latticexyz/config": "workspace:*",
     "@latticexyz/schema-type": "workspace:*",

packages/query/src/api.ts

@@ -1,6 +1,6 @@
 import { Hex } from "viem";
+import { satisfy } from "@arktype/util";
 import { StaticPrimitiveType, DynamicPrimitiveType, SchemaAbiType } from "@latticexyz/schema-type/internal";
-import { satisfy } from "@latticexyz/common/type-utils";
 import { SchemaToPrimitives } from "@latticexyz/store/internal";
 import { Table } from "@latticexyz/config";