feat(cli): use abi types in store config

packages/cli/package.json

@@ -67,8 +67,8 @@
     "typechain": "^8.1.1",
     "typescript": "^4.9.5",
     "yargs": "^17.7.1",
-    "zod": "^3.20.6",
-    "zod-validation-error": "^0.3.2"
+    "zod": "^3.21.4",
+    "zod-validation-error": "^1.0.1"
   },
   "gitHead": "914a1e0ae4a573d685841ca2ea921435057deb8f"
 }

packages/cli/scripts/codegen.ts

@@ -1,41 +1,38 @@
-import { SchemaType } from "@latticexyz/schema-type";
-import { parseStoreConfig, StoreUserConfig } from "../src/config/index.js";
+import { defineStoreUserConfig, parseStoreConfig } from "../src/config/index.js";
 import { tablegen } from "../src/render-solidity/tablegen.js";
 import { logError } from "../src/utils/errors.js";
 import { getSrcDirectory } from "../src/utils/foundry.js";
 
 // This config is used only for tests
-const config: StoreUserConfig = {
+const config = defineStoreUserConfig({
   tables: {
     Table1: {
       primaryKeys: {
-        k1: SchemaType.UINT256,
-        k2: SchemaType.INT32,
-        k3: SchemaType.BYTES16,
-        k4: SchemaType.ADDRESS,
-        k5: SchemaType.BOOL,
+        k1: "uint256",
+        k2: "int32",
+        k3: "bytes16",
+        k4: "address",
+        k5: "bool",
         k6: "Enum1",
         k7: "Enum2",
       },
       schema: {
-        v1: SchemaType.UINT256,
-        v2: SchemaType.INT32,
-        v3: SchemaType.BYTES16,
-        v4: SchemaType.ADDRESS,
-        v5: SchemaType.BOOL,
+        v1: "uint256",
+        v2: "int32",
+        v3: "bytes16",
+        v4: "address",
+        v5: "bool",
         v6: "Enum1",
         v7: "Enum2",
       },
     },
   },
 
-  userTypes: {
-    enums: {
-      Enum1: ["E1", "E2", "E3"],
-      Enum2: ["E1"],
-    },
+  enums: {
+    Enum1: ["E1", "E2", "E3"],
+    Enum2: ["E1"],
   },
-};
+});
 
 // Aside from avoiding `mud.config.mts` in cli package (could cause issues),
 // this also tests that tablegen can work as a standalone function

packages/cli/src/config/commonSchemas.ts

@@ -1,4 +1,4 @@
-import { getStaticByteLength, SchemaType } from "@latticexyz/schema-type";
+import { AbiType, AbiTypes, StaticAbiTypes } from "@latticexyz/schema-type";
 import { z } from "zod";
 import {
   validateBaseRoute,
@@ -31,10 +31,14 @@ export const BaseRoute = z.string().superRefine(validateBaseRoute);
 /** A valid Ethereum address */
 export const EthereumAddress = z.string().superRefine(validateEthereumAddress);
 
+export const zAbiType = z
+  .string()
+  .refine((val): val is AbiType => (AbiTypes as string[]).includes(val), "Invalid abi type");
+
 /** Static subset of SchemaType enum */
-export const StaticSchemaType = z
-  .nativeEnum(SchemaType)
-  .refine((arg) => getStaticByteLength(arg) > 0, "SchemaType must be static");
+export const zStaticAbiType = z
+  .string()
+  .refine((val): val is AbiType => (StaticAbiTypes as string[]).includes(val), "Abi type must be static");
 
 /** A selector for namespace/file/resource */
 export const Selector = z.string().superRefine(validateSelector);

packages/cli/src/config/index.ts

@@ -1,9 +1,18 @@
+import { StringForUnion } from "../utils/typeUtils.js";
 import { StoreUserConfig, StoreConfig } from "./parseStoreConfig.js";
 import { WorldUserConfig, ResolvedWorldConfig } from "./world/index.js";
 
-export type MUDUserConfig = StoreUserConfig & WorldUserConfig;
+export type MUDUserConfig<EnumNames extends StringForUnion = StringForUnion> = StoreUserConfig<EnumNames> &
+  WorldUserConfig;
 export type MUDConfig = StoreConfig & ResolvedWorldConfig;
 
+/** Type helper for defining MUDUserConfig */
+export function defineMUDUserConfig<EnumNames extends StringForUnion = StringForUnion>(
+  config: MUDUserConfig<EnumNames>
+) {
+  return config;
+}
+
 export * from "./commonSchemas.js";
 export * from "./loadConfig.js";
 export * from "./loadStoreConfig.js";

packages/cli/src/config/parseStoreConfig.test-d.ts

@@ -1,14 +1,14 @@
 import { describe, expectTypeOf } from "vitest";
 import { z } from "zod";
-import { StoreConfig, StoreUserConfig, UserTypesConfig } from "./parseStoreConfig.js";
+import { StoreConfig, StoreUserConfig } from "./parseStoreConfig.js";
 
 describe("StoreUserConfig", () => {
   // Typecheck manual interfaces against zod
   expectTypeOf<StoreUserConfig>().toEqualTypeOf<z.input<typeof StoreConfig>>();
   // type equality isn't deep for optionals
   expectTypeOf<StoreUserConfig["tables"][string]>().toEqualTypeOf<z.input<typeof StoreConfig>["tables"][string]>();
-  expectTypeOf<NonNullable<UserTypesConfig["enums"]>[string]>().toEqualTypeOf<
-    NonNullable<NonNullable<UserTypesConfig>["enums"]>[string]
+  expectTypeOf<NonNullable<StoreUserConfig["enums"]>[string]>().toEqualTypeOf<
+    NonNullable<NonNullable<z.input<typeof StoreConfig>>["enums"]>[string]
   >();
   // TODO If more nested schemas are added, provide separate tests for them
 });

packages/cli/src/config/parseStoreConfig.ts

@@ -1,49 +1,57 @@
-import { SchemaType } from "@latticexyz/schema-type";
+import { AbiType, AbiTypes, StaticAbiType } from "@latticexyz/schema-type";
 import { RefinementCtx, z, ZodIssueCode } from "zod";
-import { ObjectName, Selector, StaticSchemaType, UserEnum, ValueName } from "./commonSchemas.js";
+import { RequireKeys, StringForUnion } from "../utils/typeUtils.js";
+import { ObjectName, Selector, zAbiType, zStaticAbiType, UserEnum, ValueName } from "./commonSchemas.js";
 import { getDuplicates } from "./validation.js";
 
 const TableName = ObjectName;
 const KeyName = ValueName;
 const ColumnName = ValueName;
 const UserEnumName = ObjectName;
 
-// Fields can use SchemaType or one of user defined wrapper types
-const FieldData = z.union([z.nativeEnum(SchemaType), UserEnumName]);
+// Fields can use AbiType or one of user-defined wrapper types
+// (user types are refined later, based on the appropriate config options)
+const zFieldData = z.union([zAbiType, z.string()]);
 
-// Primary keys allow only static types, but allow static user defined types
-const PrimaryKey = z.union([StaticSchemaType, UserEnumName]);
-const PrimaryKeys = z.record(KeyName, PrimaryKey).default({ key: SchemaType.BYTES32 });
+type FieldData<UserTypes extends StringForUnion = StringForUnion> = AbiType | UserTypes;
+
+// Primary keys allow only static types
+const zPrimaryKey = z.union([zStaticAbiType, z.string()]);
+const zPrimaryKeys = z.record(KeyName, zPrimaryKey).default({ key: "bytes32" });
+
+type PrimaryKey<StaticUserTypes extends StringForUnion = StringForUnion> = StaticAbiType | StaticUserTypes;
 
 /************************************************************************
  *
  *    TABLE SCHEMA
  *
  ************************************************************************/
 
-export type FullSchemaConfig = Record<string, z.input<typeof FieldData>>;
-export type ShorthandSchemaConfig = z.input<typeof FieldData>;
-export type SchemaConfig = FullSchemaConfig | ShorthandSchemaConfig;
+export type FullSchemaConfig<UserTypes extends StringForUnion = StringForUnion> = Record<string, FieldData<UserTypes>>;
+export type ShorthandSchemaConfig<UserTypes extends StringForUnion = StringForUnion> = FieldData<UserTypes>;
+export type SchemaConfig<UserTypes extends StringForUnion = StringForUnion> =
+  | FullSchemaConfig<UserTypes>
+  | ShorthandSchemaConfig<UserTypes>;
 
-const FullSchemaConfig = z
-  .record(ColumnName, FieldData)
+const zFullSchemaConfig = z
+  .record(ColumnName, zFieldData)
   .refine((arg) => Object.keys(arg).length > 0, "Table schema may not be empty");
 
-const ShorthandSchemaConfig = FieldData.transform((fieldData) => {
-  return FullSchemaConfig.parse({
+const zShorthandSchemaConfig = zFieldData.transform((fieldData) => {
+  return zFullSchemaConfig.parse({
     value: fieldData,
   });
 });
 
-export const SchemaConfig = FullSchemaConfig.or(ShorthandSchemaConfig);
+export const zSchemaConfig = zFullSchemaConfig.or(zShorthandSchemaConfig);
 
 /************************************************************************
  *
  *    TABLE
  *
  ************************************************************************/
 
-export interface TableConfig {
+export interface TableConfig<UserTypes extends StringForUnion = StringForUnion> {
   /** Output directory path for the file. Default is "tables" */
   directory?: string;
   /**
@@ -58,20 +66,20 @@ export interface TableConfig {
   storeArgument?: boolean;
   /** Include a data struct and methods for it. Default is false for 1-column tables; true for multi-column tables. */
   dataStruct?: boolean;
-  /** Table's primary key names mapped to their types. Default is `{ key: SchemaType.BYTES32 }` */
-  primaryKeys?: Record<string, z.input<typeof PrimaryKey>>;
+  /** Table's primary key names mapped to their types. Default is `{ key: "bytes32" }` */
+  primaryKeys?: Record<string, PrimaryKey<UserTypes>>;
   /** Table's column names mapped to their types. Table name's 1st letter should be lowercase. */
-  schema: SchemaConfig;
+  schema: SchemaConfig<UserTypes>;
 }
 
-const FullTableConfig = z
+const zFullTableConfig = z
   .object({
     directory: z.string().default("tables"),
     fileSelector: Selector.optional(),
     tableIdArgument: z.boolean().default(false),
     storeArgument: z.boolean().default(false),
-    primaryKeys: PrimaryKeys,
-    schema: SchemaConfig,
+    primaryKeys: zPrimaryKeys,
+    schema: zSchemaConfig,
     dataStruct: z.boolean().optional(),
   })
   .transform((arg) => {
@@ -84,25 +92,28 @@ const FullTableConfig = z
     return arg as RequireKeys<typeof arg, "dataStruct">;
   });
 
-const ShorthandTableConfig = FieldData.transform((fieldData) => {
-  return FullTableConfig.parse({
+const zShorthandTableConfig = zFieldData.transform((fieldData) => {
+  return zFullTableConfig.parse({
     schema: {
       value: fieldData,
     },
   });
 });
 
-export const TableConfig = FullTableConfig.or(ShorthandTableConfig);
+export const zTableConfig = zFullTableConfig.or(zShorthandTableConfig);
 
 /************************************************************************
  *
  *    TABLES
  *
  ************************************************************************/
 
-export type TablesConfig = Record<string, TableConfig | z.input<typeof FieldData>>;
+export type TablesConfig<UserTypes extends StringForUnion = StringForUnion> = Record<
+  string,
+  TableConfig<UserTypes> | FieldData<UserTypes>
+>;
 
-export const TablesConfig = z.record(TableName, TableConfig).transform((tables) => {
+export const zTablesConfig = z.record(TableName, zTableConfig).transform((tables) => {
   // default fileSelector depends on tableName
   for (const tableName of Object.keys(tables)) {
     const table = tables[tableName];
@@ -119,19 +130,25 @@ export const TablesConfig = z.record(TableName, TableConfig).transform((tables)
  *
  ************************************************************************/
 
-export interface UserTypesConfig<Enums extends Record<string, string[]> = Record<string, string[]>> {
-  /** Path to the file where common types will be generated and imported from. Default is "Types" */
-  path?: string;
-  /** Enum names mapped to lists of their member names */
-  enums?: Enums;
-}
-
-export const UserTypesConfig = z
-  .object({
-    path: z.string().default("Types"),
-    enums: z.record(UserEnumName, UserEnum).default({}),
-  })
-  .default({});
+export type EnumsConfig<EnumNames extends StringForUnion = StringForUnion> = string extends EnumNames
+  ? {
+      /**
+       * Enum names mapped to lists of their member names
+       */
+      enums?: Record<EnumNames, string[]>;
+    }
+  : {
+      /**
+       * Enum names mapped to lists of their member names
+       *
+       * Required if used in tables
+       */
+      enums: Record<EnumNames, string[]>;
+    };
+
+export const zEnumsConfig = z.object({
+  enums: z.record(UserEnumName, UserEnum).default({}),
+});
 
 /************************************************************************
  *
@@ -140,7 +157,7 @@ export const UserTypesConfig = z
  ************************************************************************/
 
 // zod doesn't preserve doc comments
-export interface StoreUserConfig {
+export type StoreUserConfig<EnumNames extends StringForUnion = StringForUnion> = EnumsConfig<EnumNames> & {
   /** The namespace for table ids. Default is "" (empty string) */
   namespace?: string;
   /** Path for store package imports. Default is "@latticexyz/store/src/" */
@@ -151,22 +168,31 @@ export interface StoreUserConfig {
    * The key is the table name (capitalized).
    *
    * The value:
-   *  - `SchemaType | userType` for a single-value table (aka ECS component).
+   *  - abi or user type for a single-value table (aka ECS component).
    *  - FullTableConfig object for multi-value tables (or for customizable options).
    */
-  tables: TablesConfig;
-  /** User-defined types that will be generated and may be used in table schemas instead of `SchemaType` */
-  userTypes?: UserTypesConfig;
+  tables: TablesConfig<EnumNames>;
+  /** Path to the file where common user types will be generated and imported from. Default is "Types" */
+  userTypesPath?: string;
+};
+
+/** Type helper for defining StoreUserConfig */
+export function defineStoreUserConfig<EnumNames extends StringForUnion = StringForUnion>(
+  config: StoreUserConfig<EnumNames>
+) {
+  return config;
 }
 
 export type StoreConfig = z.output<typeof StoreConfig>;
 
-const StoreConfigUnrefined = z.object({
-  namespace: Selector.default(""),
-  storeImportPath: z.string().default("@latticexyz/store/src/"),
-  tables: TablesConfig,
-  userTypes: UserTypesConfig,
-});
+const StoreConfigUnrefined = z
+  .object({
+    namespace: Selector.default(""),
+    storeImportPath: z.string().default("@latticexyz/store/src/"),
+    tables: zTablesConfig,
+    userTypesPath: z.string().default("Types"),
+  })
+  .merge(zEnumsConfig);
 
 // finally validate global conditions
 export const StoreConfig = StoreConfigUnrefined.superRefine(validateStoreConfig);
@@ -197,7 +223,7 @@ function validateStoreConfig(config: z.output<typeof StoreConfigUnrefined>, ctx:
   }
   // Global names must be unique
   const tableNames = Object.keys(config.tables);
-  const userTypeNames = Object.keys(config.userTypes.enums);
+  const userTypeNames = Object.keys(config.enums);
   const globalNames = [...tableNames, ...userTypeNames];
   const duplicateGlobalNames = getDuplicates(globalNames);
   if (duplicateGlobalNames.length > 0) {
@@ -209,25 +235,19 @@ function validateStoreConfig(config: z.output<typeof StoreConfigUnrefined>, ctx:
   // User types must exist
   for (const table of Object.values(config.tables)) {
     for (const primaryKeyType of Object.values(table.primaryKeys)) {
-      validateIfUserType(userTypeNames, primaryKeyType, ctx);
+      validateAbiOrUserType(userTypeNames, primaryKeyType, ctx);
     }
     for (const fieldType of Object.values(table.schema)) {
-      validateIfUserType(userTypeNames, fieldType, ctx);
+      validateAbiOrUserType(userTypeNames, fieldType, ctx);
     }
   }
 }
 
-function validateIfUserType(
-  userTypeNames: string[],
-  type: z.output<typeof FieldData> | z.output<typeof PrimaryKey>,
-  ctx: RefinementCtx
-) {
-  if (typeof type === "string" && !userTypeNames.includes(type)) {
+function validateAbiOrUserType(userTypeNames: string[], type: string, ctx: RefinementCtx) {
+  if (!(AbiTypes as string[]).includes(type) && !userTypeNames.includes(type)) {
     ctx.addIssue({
       code: ZodIssueCode.custom,
-      message: `User type ${type} is not defined in userTypes`,
+      message: `${type} is not a valid abi type, and is not defined in userTypes`,
     });
   }
 }
-
-type RequireKeys<T extends Record<string, unknown>, P extends string> = T & Required<Pick<T, P>>;