@latticexyz/cli 2.0.0-alpha.0 → 2.0.0-alpha.1

package/dist/config/index.js

@@ -1,83 +0,0 @@
-import {
-  DynamicResolutionType,
-  getDuplicates,
-  isDynamicResolution,
-  loadConfig,
-  loadStoreConfig,
-  loadWorldConfig,
-  mudConfig,
-  parseStaticArray,
-  parseStoreConfig,
-  parseWorldConfig,
-  resolveSystemConfig,
-  resolveTableId,
-  resolveWithContext,
-  resolveWorldConfig,
-  storeConfig,
-  validateBaseRoute,
-  validateCapitalizedName,
-  validateEnum,
-  validateEthereumAddress,
-  validateName,
-  validateRoute,
-  validateSelector,
-  validateSingleLevelRoute,
-  validateUncapitalizedName,
-  zAnyCaseName,
-  zBaseRoute,
-  zEnumsConfig,
-  zEthereumAddress,
-  zObjectName,
-  zOrdinaryRoute,
-  zSchemaConfig,
-  zSelector,
-  zSingleLevelRoute,
-  zStoreConfig,
-  zTableConfig,
-  zTablesConfig,
-  zUserEnum,
-  zValueName,
-  zWorldConfig
-} from "../chunk-J4DJQNIC.js";
-import "../chunk-O6HOO6WA.js";
-export {
-  DynamicResolutionType,
-  getDuplicates,
-  isDynamicResolution,
-  loadConfig,
-  loadStoreConfig,
-  loadWorldConfig,
-  mudConfig,
-  parseStaticArray,
-  parseStoreConfig,
-  parseWorldConfig,
-  resolveSystemConfig,
-  resolveTableId,
-  resolveWithContext,
-  resolveWorldConfig,
-  storeConfig,
-  validateBaseRoute,
-  validateCapitalizedName,
-  validateEnum,
-  validateEthereumAddress,
-  validateName,
-  validateRoute,
-  validateSelector,
-  validateSingleLevelRoute,
-  validateUncapitalizedName,
-  zAnyCaseName,
-  zBaseRoute,
-  zEnumsConfig,
-  zEthereumAddress,
-  zObjectName,
-  zOrdinaryRoute,
-  zSchemaConfig,
-  zSelector,
-  zSingleLevelRoute,
-  zStoreConfig,
-  zTableConfig,
-  zTablesConfig,
-  zUserEnum,
-  zValueName,
-  zWorldConfig
-};

package/src/config/commonSchemas.ts

@@ -1,34 +0,0 @@
-import { z } from "zod";
-import {
-  validateBaseRoute,
-  validateCapitalizedName,
-  validateEthereumAddress,
-  validateEnum,
-  validateName,
-  validateRoute,
-  validateSingleLevelRoute,
-  validateUncapitalizedName,
-  validateSelector,
-} from "./validation.js";
-
-/** Capitalized names of objects, like tables and systems */
-export const zObjectName = z.string().superRefine(validateCapitalizedName);
-/** Uncapitalized names of values, like keys and columns */
-export const zValueName = z.string().superRefine(validateUncapitalizedName);
-/** Name that can start with any case */
-export const zAnyCaseName = z.string().superRefine(validateName);
-/** List of unique enum member names and 0 < length < 256 */
-export const zUserEnum = z.array(zObjectName).superRefine(validateEnum);
-
-/** Ordinary routes */
-export const zOrdinaryRoute = z.string().superRefine(validateRoute);
-/** Routes with exactly 1 non-empty level */
-export const zSingleLevelRoute = z.string().superRefine(validateSingleLevelRoute);
-/** Base routes (can be an empty string) */
-export const zBaseRoute = z.string().superRefine(validateBaseRoute);
-
-/** A valid Ethereum address */
-export const zEthereumAddress = z.string().superRefine(validateEthereumAddress);
-
-/** A selector for namespace/file/resource */
-export const zSelector = z.string().superRefine(validateSelector);

package/src/config/dynamicResolution.ts

@@ -1,49 +0,0 @@
-import { MUDError } from "../utils/errors.js";
-import { ValueWithType } from "./world/userTypes.js";
-
-export enum DynamicResolutionType {
-  TABLE_ID,
-  SYSTEM_ADDRESS,
-}
-
-export type DynamicResolution = {
-  type: DynamicResolutionType;
-  input: string;
-};
-
-/**
- * Dynamically resolve a table name to a table id at deploy time
- */
-export function resolveTableId(tableName: string) {
-  return {
-    type: DynamicResolutionType.TABLE_ID,
-    input: tableName,
-  };
-}
-
-/** Type guard for DynamicResolution */
-export function isDynamicResolution(value: unknown): value is DynamicResolution {
-  return typeof value === "object" && value !== null && "type" in value && "input" in value;
-}
-
-/**
- * Turn a DynamicResolution object into a ValueWithType based on the provided context
- */
-export async function resolveWithContext(
-  unresolved: any,
-  context: { systemAddresses?: Record<string, Promise<string>>; tableIds?: Record<string, Uint8Array> }
-): Promise<ValueWithType> {
-  if (!isDynamicResolution(unresolved)) return unresolved;
-  let resolved: ValueWithType | undefined = undefined;
-
-  if (unresolved.type === DynamicResolutionType.TABLE_ID) {
-    const tableId = context.tableIds?.[unresolved.input];
-    resolved = tableId && { value: tableId, type: "bytes32" };
-  }
-
-  if (resolved === undefined) {
-    throw new MUDError(`Could not resolve dynamic resolution: \n${JSON.stringify(unresolved, null, 2)}`);
-  }
-
-  return resolved;
-}

package/src/config/index.ts

@@ -1,24 +0,0 @@
-import { ExtractUserTypes, StringForUnion } from "../utils/typeUtils.js";
-import { StoreUserConfig, StoreConfig } from "./parseStoreConfig.js";
-import { WorldUserConfig, ResolvedWorldConfig } from "./world/index.js";
-
-export type MUDUserConfig<
-  EnumNames extends StringForUnion = StringForUnion,
-  StaticUserTypes extends ExtractUserTypes<EnumNames> = ExtractUserTypes<EnumNames>
-> = StoreUserConfig<EnumNames, StaticUserTypes> & WorldUserConfig;
-export type MUDConfig = StoreConfig & ResolvedWorldConfig;
-
-export function mudConfig<
-  EnumNames extends StringForUnion = never,
-  StaticUserTypes extends ExtractUserTypes<EnumNames> = ExtractUserTypes<EnumNames>
->(config: MUDUserConfig<EnumNames, StaticUserTypes>) {
-  return config;
-}
-
-export * from "./commonSchemas.js";
-export * from "./loadConfig.js";
-export * from "./loadStoreConfig.js";
-export * from "./parseStoreConfig.js";
-export * from "./world/index.js";
-export * from "./validation.js";
-export * from "./dynamicResolution.js";

package/src/config/loadConfig.ts

@@ -1,39 +0,0 @@
-import { findUp } from "find-up";
-import path from "path";
-import { NotESMConfigError, NotInsideProjectError } from "../utils/errors.js";
-
-// In order of preference files are checked
-const configFiles = ["mud.config.ts", "mud.config.mts"];
-
-export async function loadConfig(configPath?: string): Promise<unknown> {
-  configPath = await resolveConfigPath(configPath);
-  try {
-    return (await import(configPath)).default;
-  } catch (error) {
-    if (error instanceof SyntaxError && error.message === "Cannot use import statement outside a module") {
-      throw new NotESMConfigError();
-    } else {
-      throw error;
-    }
-  }
-}
-
-async function resolveConfigPath(configPath: string | undefined) {
-  if (configPath === undefined) {
-    configPath = await getUserConfigPath();
-  } else {
-    if (!path.isAbsolute(configPath)) {
-      configPath = path.join(process.cwd(), configPath);
-      configPath = path.normalize(configPath);
-    }
-  }
-  return configPath;
-}
-
-async function getUserConfigPath() {
-  const tsConfigPath = await findUp(configFiles);
-  if (tsConfigPath === undefined) {
-    throw new NotInsideProjectError();
-  }
-  return tsConfigPath;
-}

package/src/config/loadStoreConfig.ts

@@ -1,18 +0,0 @@
-import { ZodError } from "zod";
-import { fromZodErrorCustom } from "../utils/errors.js";
-import { loadConfig } from "./loadConfig.js";
-import { parseStoreConfig } from "./parseStoreConfig.js";
-
-export async function loadStoreConfig(configPath?: string) {
-  const config = await loadConfig(configPath);
-
-  try {
-    return parseStoreConfig(config as any);
-  } catch (error) {
-    if (error instanceof ZodError) {
-      throw fromZodErrorCustom(error, "StoreConfig Validation Error");
-    } else {
-      throw error;
-    }
-  }
-}

package/src/config/parseStoreConfig.test-d.ts

@@ -1,40 +0,0 @@
-import { describe, expectTypeOf } from "vitest";
-import { z } from "zod";
-import { storeConfig, zStoreConfig, StoreUserConfig } from "./parseStoreConfig.js";
-
-describe("StoreUserConfig", () => {
-  // Typecheck manual interfaces against zod
-  expectTypeOf<StoreUserConfig>().toEqualTypeOf<z.input<typeof zStoreConfig>>();
-  // type equality isn't deep for optionals
-  expectTypeOf<StoreUserConfig["tables"][string]>().toEqualTypeOf<z.input<typeof zStoreConfig>["tables"][string]>();
-  expectTypeOf<NonNullable<StoreUserConfig["enums"]>[string]>().toEqualTypeOf<
-    NonNullable<NonNullable<z.input<typeof zStoreConfig>>["enums"]>[string]
-  >();
-  // TODO If more nested schemas are added, provide separate tests for them
-
-  // Test possible inference confusion.
-  // This would fail if you remove `AsDependent` from `StoreUserConfig`
-  expectTypeOf(
-    storeConfig({
-      tables: {
-        Table1: {
-          primaryKeys: {
-            a: "Enum1",
-          },
-          schema: {
-            b: "Enum2",
-          },
-        },
-        Table2: {
-          schema: {
-            a: "uint32",
-          },
-        },
-      },
-      enums: {
-        Enum1: ["E1"],
-        Enum2: ["E1"],
-      },
-    })
-  ).toEqualTypeOf<StoreUserConfig<"Enum1" | "Enum2", "Enum1" | "Enum2">>();
-});

package/src/config/parseStoreConfig.ts

@@ -1,314 +0,0 @@
-import { AbiType, AbiTypes, StaticAbiType, StaticAbiTypes } from "@latticexyz/schema-type";
-import { RefinementCtx, z, ZodIssueCode } from "zod";
-import { AsDependent, ExtractUserTypes, RequireKeys, StaticArray, StringForUnion } from "../utils/typeUtils.js";
-import { zObjectName, zSelector, zUserEnum, zValueName } from "./commonSchemas.js";
-import { getDuplicates, parseStaticArray } from "./validation.js";
-
-const zTableName = zObjectName;
-const zKeyName = zValueName;
-const zColumnName = zValueName;
-const zUserEnumName = zObjectName;
-
-// 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.string();
-
-type FieldData<UserTypes extends StringForUnion> = AbiType | StaticArray | UserTypes;
-
-// Primary keys allow only static types
-// (user types are refined later, based on the appropriate config options)
-const zPrimaryKey = z.string();
-const zPrimaryKeys = z.record(zKeyName, zPrimaryKey).default({ key: "bytes32" });
-
-type PrimaryKey<StaticUserTypes extends StringForUnion> = StaticAbiType | StaticUserTypes;
-
-/************************************************************************
- *
- *    TABLE SCHEMA
- *
- ************************************************************************/
-
-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 zFullSchemaConfig = z
-  .record(zColumnName, zFieldData)
-  .refine((arg) => Object.keys(arg).length > 0, "Table schema may not be empty");
-
-const zShorthandSchemaConfig = zFieldData.transform((fieldData) => {
-  return zFullSchemaConfig.parse({
-    value: fieldData,
-  });
-});
-
-export const zSchemaConfig = zFullSchemaConfig.or(zShorthandSchemaConfig);
-
-/************************************************************************
- *
- *    TABLE
- *
- ************************************************************************/
-
-export interface TableConfig<
-  UserTypes extends StringForUnion = StringForUnion,
-  StaticUserTypes extends StringForUnion = StringForUnion
-> {
-  /** Output directory path for the file. Default is "tables" */
-  directory?: string;
-  /**
-   * The fileSelector is used with the namespace to register the table and construct its id.
-   * The table id will be uint256(bytes32(abi.encodePacked(bytes16(namespace), bytes16(fileSelector)))).
-   * Default is "<tableName>"
-   * */
-  fileSelector?: string;
-  /** Make methods accept `tableId` argument instead of it being a hardcoded constant. Default is false */
-  tableIdArgument?: boolean;
-  /** Include methods that accept a manual `IStore` argument. Default is false. */
-  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: "bytes32" }` */
-  primaryKeys?: Record<string, PrimaryKey<StaticUserTypes>>;
-  /** Table's column names mapped to their types. Table name's 1st letter should be lowercase. */
-  schema: SchemaConfig<UserTypes>;
-}
-
-const zFullTableConfig = z
-  .object({
-    directory: z.string().default("tables"),
-    fileSelector: zSelector.optional(),
-    tableIdArgument: z.boolean().default(false),
-    storeArgument: z.boolean().default(false),
-    primaryKeys: zPrimaryKeys,
-    schema: zSchemaConfig,
-    dataStruct: z.boolean().optional(),
-  })
-  .transform((arg) => {
-    // default dataStruct value depends on schema's length
-    if (Object.keys(arg.schema).length === 1) {
-      arg.dataStruct ??= false;
-    } else {
-      arg.dataStruct ??= true;
-    }
-    return arg as RequireKeys<typeof arg, "dataStruct">;
-  });
-
-const zShorthandTableConfig = zFieldData.transform((fieldData) => {
-  return zFullTableConfig.parse({
-    schema: {
-      value: fieldData,
-    },
-  });
-});
-
-export const zTableConfig = zFullTableConfig.or(zShorthandTableConfig);
-
-/************************************************************************
- *
- *    TABLES
- *
- ************************************************************************/
-
-export type TablesConfig<
-  UserTypes extends StringForUnion = StringForUnion,
-  StaticUserTypes extends StringForUnion = StringForUnion
-> = Record<string, TableConfig<UserTypes, StaticUserTypes> | FieldData<UserTypes>>;
-
-export const zTablesConfig = z.record(zTableName, zTableConfig).transform((tables) => {
-  // default fileSelector depends on tableName
-  for (const tableName of Object.keys(tables)) {
-    const table = tables[tableName];
-    table.fileSelector ??= tableName;
-
-    tables[tableName] = table;
-  }
-  return tables as Record<string, RequireKeys<(typeof tables)[string], "fileSelector">>;
-});
-
-/************************************************************************
- *
- *    USER TYPES
- *
- ************************************************************************/
-
-export type EnumsConfig<EnumNames extends StringForUnion> = never extends EnumNames
-  ? {
-      /**
-       * Enum names mapped to lists of their member names
-       *
-       * (enums are inferred to be absent)
-       */
-      enums?: Record<EnumNames, string[]>;
-    }
-  : StringForUnion extends EnumNames
-  ? {
-      /**
-       * Enum names mapped to lists of their member names
-       *
-       * (enums aren't inferred - use `mudConfig` or `storeConfig` helper, and `as const` for variables)
-       */
-      enums?: Record<EnumNames, string[]>;
-    }
-  : {
-      /**
-       * Enum names mapped to lists of their member names
-       *
-       * Enums defined here can be used as types in table schemas/keys
-       */
-      enums: Record<EnumNames, string[]>;
-    };
-
-export const zEnumsConfig = z.object({
-  enums: z.record(zUserEnumName, zUserEnum).default({}),
-});
-
-/************************************************************************
- *
- *    FINAL
- *
- ************************************************************************/
-
-// zod doesn't preserve doc comments
-export type StoreUserConfig<
-  EnumNames extends StringForUnion = StringForUnion,
-  StaticUserTypes extends ExtractUserTypes<EnumNames> = ExtractUserTypes<EnumNames>
-> = EnumsConfig<EnumNames> & {
-  /** The namespace for table ids. Default is "" (empty string) */
-  namespace?: string;
-  /** Path for store package imports. Default is "@latticexyz/store/src/" */
-  storeImportPath?: string;
-  /**
-   * Configuration for each table.
-   *
-   * The key is the table name (capitalized).
-   *
-   * The value:
-   *  - abi or user type for a single-value table.
-   *  - FullTableConfig object for multi-value tables (or for customizable options).
-   */
-  tables: TablesConfig<AsDependent<StaticUserTypes>, AsDependent<StaticUserTypes>>;
-  /** 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 storeConfig<
-  // (`never` is overridden by inference, so only the defined enums can be used by default)
-  EnumNames extends StringForUnion = never,
-  StaticUserTypes extends ExtractUserTypes<EnumNames> = ExtractUserTypes<EnumNames>
->(config: StoreUserConfig<EnumNames, StaticUserTypes>) {
-  return config;
-}
-
-export type StoreConfig = z.output<typeof zStoreConfig>;
-
-const StoreConfigUnrefined = z
-  .object({
-    namespace: zSelector.default(""),
-    storeImportPath: z.string().default("@latticexyz/store/src/"),
-    tables: zTablesConfig,
-    userTypesPath: z.string().default("Types"),
-  })
-  .merge(zEnumsConfig);
-
-// finally validate global conditions
-export const zStoreConfig = StoreConfigUnrefined.superRefine(validateStoreConfig);
-
-export function parseStoreConfig(config: unknown) {
-  return zStoreConfig.parse(config);
-}
-
-/************************************************************************
- *
- *    HELPERS
- *
- ************************************************************************/
-
-// Validate conditions that check multiple different config options simultaneously
-function validateStoreConfig(config: z.output<typeof StoreConfigUnrefined>, ctx: RefinementCtx) {
-  // Local table variables must be unique within the table
-  for (const table of Object.values(config.tables)) {
-    const primaryKeyNames = Object.keys(table.primaryKeys);
-    const fieldNames = Object.keys(table.schema);
-    const duplicateVariableNames = getDuplicates([...primaryKeyNames, ...fieldNames]);
-    if (duplicateVariableNames.length > 0) {
-      ctx.addIssue({
-        code: ZodIssueCode.custom,
-        message: `Field and primary key names within one table must be unique: ${duplicateVariableNames.join(", ")}`,
-      });
-    }
-  }
-  // Global names must be unique
-  const tableNames = Object.keys(config.tables);
-  const staticUserTypeNames = Object.keys(config.enums);
-  const userTypeNames = staticUserTypeNames;
-  const globalNames = [...tableNames, ...userTypeNames];
-  const duplicateGlobalNames = getDuplicates(globalNames);
-  if (duplicateGlobalNames.length > 0) {
-    ctx.addIssue({
-      code: ZodIssueCode.custom,
-      message: `Table, enum names must be globally unique: ${duplicateGlobalNames.join(", ")}`,
-    });
-  }
-  // User types must exist
-  for (const table of Object.values(config.tables)) {
-    for (const primaryKeyType of Object.values(table.primaryKeys)) {
-      validateStaticAbiOrUserType(staticUserTypeNames, primaryKeyType, ctx);
-    }
-    for (const fieldType of Object.values(table.schema)) {
-      validateAbiOrUserType(userTypeNames, staticUserTypeNames, fieldType, ctx);
-    }
-  }
-}
-
-function validateAbiOrUserType(
-  userTypeNames: string[],
-  staticUserTypeNames: string[],
-  type: string,
-  ctx: RefinementCtx
-) {
-  if (!(AbiTypes as string[]).includes(type) && !userTypeNames.includes(type)) {
-    const staticArray = parseStaticArray(type);
-    if (staticArray) {
-      validateStaticArray(staticUserTypeNames, staticArray.elementType, staticArray.staticLength, ctx);
-    } else {
-      ctx.addIssue({
-        code: ZodIssueCode.custom,
-        message: `${type} is not a valid abi type, and is not defined in userTypes`,
-      });
-    }
-  }
-}
-
-function validateStaticAbiOrUserType(staticUserTypeNames: string[], type: string, ctx: RefinementCtx) {
-  if (!(StaticAbiTypes as string[]).includes(type) && !staticUserTypeNames.includes(type)) {
-    ctx.addIssue({
-      code: ZodIssueCode.custom,
-      message: `${type} is not a static type`,
-    });
-  }
-}
-
-function validateStaticArray(
-  staticUserTypeNames: string[],
-  elementType: string,
-  staticLength: number,
-  ctx: RefinementCtx
-) {
-  validateStaticAbiOrUserType(staticUserTypeNames, elementType, ctx);
-
-  if (staticLength === 0) {
-    ctx.addIssue({
-      code: ZodIssueCode.custom,
-      message: `Static array length must not be 0`,
-    });
-  } else if (staticLength >= 2 ** 16) {
-    ctx.addIssue({
-      code: ZodIssueCode.custom,
-      message: `Static array length must be less than 2**16`,
-    });
-  }
-}