@latticexyz/world 2.0.0 → 2.0.1

package/dist/config/v2.d.ts

@@ -1,4 +1,4 @@
-export { d as defineWorld, r as resolveWorld, v as validateWorld } from '../world-c96a2291.js';
+export { d as defineWorld, r as resolveWorld, v as validateWorld } from '../world-744aa7b1.js';
 import { W as World, M as Module, S as Systems } from '../output-993b3634.js';
 export { C as Codegen, D as Deploy, a as System } from '../output-993b3634.js';
 import { mutable, conform } from '@arktype/util';

package/dist/index.d.ts

@@ -1,11 +1,29 @@
-export { d as defineWorld } from './world-c96a2291.js';
+import { validateTablesWithShorthands, extendedScope, Scope, AbiTypeScope, resolveTablesWithShorthands } from '@latticexyz/store/config/v2';
+import { v as validateWorld, a as validateNamespaces, r as resolveWorld, W as WorldWithShorthandsInput } from './world-744aa7b1.js';
 export { W as World } from './output-993b3634.js';
 import '@arktype/util';
-import '@latticexyz/store/config/v2';
 import './defaults-87a942d7.js';
 import '@latticexyz/store';
 
 declare const worldDeployedEvent = "event WorldDeployed(address indexed newContract, uint256 salt)";
 declare const helloWorldEvent = "event HelloWorld(bytes32 indexed worldVersion)";
 
-export { helloWorldEvent, worldDeployedEvent };
+type validateWorldWithShorthands<world> = {
+    [key in keyof world]: key extends "tables" ? validateTablesWithShorthands<world[key], extendedScope<world>> : key extends "namespaces" ? validateNamespacesWithShorthands<world[key], extendedScope<world>> : validateWorld<world>[key];
+};
+type validateNamespacesWithShorthands<namespaces, scope extends Scope = AbiTypeScope> = {
+    [namespace in keyof namespaces]: {
+        [key in keyof namespaces[namespace]]: key extends "tables" ? validateTablesWithShorthands<namespaces[namespace][key], scope> : validateNamespaces<namespaces[namespace], scope>[key];
+    };
+};
+type resolveWorldWithShorthands<world> = resolveWorld<{
+    [key in keyof world]: key extends "tables" ? resolveTablesWithShorthands<world[key], extendedScope<world>> : key extends "namespaces" ? {
+        [namespaceKey in keyof world[key]]: {
+            [namespaceProp in keyof world[key][namespaceKey]]: namespaceProp extends "tables" ? resolveTablesWithShorthands<world[key][namespaceKey][namespaceProp], extendedScope<world>> : world[key][namespaceKey][namespaceProp];
+        };
+    } : world[key];
+}>;
+declare function resolveWorldWithShorthands<world extends WorldWithShorthandsInput>(world: world): resolveWorldWithShorthands<world>;
+declare function defineWorldWithShorthands<world>(world: validateWorldWithShorthands<world>): resolveWorldWithShorthands<world>;
+
+export { defineWorldWithShorthands as defineWorld, helloWorldEvent, worldDeployedEvent };

package/dist/index.js

@@ -1,2 +1,2 @@
-import{c as e}from"./chunk-3GSLUFHC.js";import"./chunk-RF4HOV37.js";var o="event WorldDeployed(address indexed newContract, uint256 salt)",t="event HelloWorld(bytes32 indexed worldVersion)";export{e as defineWorld,t as helloWorldEvent,o as worldDeployedEvent};
+import{a as d,b as l}from"./chunk-3GSLUFHC.js";import"./chunk-RF4HOV37.js";var S="event WorldDeployed(address indexed newContract, uint256 salt)",v="event HelloWorld(bytes32 indexed worldVersion)";import{extendedScope as m,get as p,hasOwnKey as h,isObject as k,isTableShorthandInput as i,resolveTableShorthand as c,validateTablesWithShorthands as W}from"@latticexyz/store/config/v2";import{mapObject as r}from"@latticexyz/common/utils";function f(e){let s=m(e);if(h(e,"tables")&&W(e.tables,s),h(e,"namespaces")&&k(e.namespaces))for(let t of Object.keys(e.namespaces))W(p(p(e.namespaces,t),"tables")??{},s)}function x(e){let s=m(e),t=r(e.tables??{},o=>i(o)?c(o,s):o),y=r(e.namespaces??{},o=>({...o,tables:r(o.tables??{},a=>i(a)?c(a,s):a)})),n={...e,tables:t,namespaces:y};return d(n),l(n)}function w(e){return f(e),x(e)}export{w as defineWorld,v as helloWorldEvent,S as worldDeployedEvent};
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../ts/worldEvents.ts"],"sourcesContent":["// from WorldFactory\nexport const worldDeployedEvent = \"event WorldDeployed(address indexed newContract, uint256 salt)\";\n\n// from World\nexport const helloWorldEvent = \"event HelloWorld(bytes32 indexed worldVersion)\";\n"],"mappings":"oEACO,IAAMA,EAAqB,iEAGrBC,EAAkB","names":["worldDeployedEvent","helloWorldEvent"]}
+{"version":3,"sources":["../ts/worldEvents.ts","../ts/config/v2/worldWithShorthands.ts"],"sourcesContent":["// from WorldFactory\nexport const worldDeployedEvent = \"event WorldDeployed(address indexed newContract, uint256 salt)\";\n\n// from World\nexport const helloWorldEvent = \"event HelloWorld(bytes32 indexed worldVersion)\";\n","import {\n  AbiTypeScope,\n  extendedScope,\n  get,\n  hasOwnKey,\n  isObject,\n  isTableShorthandInput,\n  resolveTableShorthand,\n  resolveTablesWithShorthands,\n  validateTablesWithShorthands,\n  Scope,\n} from \"@latticexyz/store/config/v2\";\nimport { mapObject } from \"@latticexyz/common/utils\";\nimport { resolveWorld, validateWorld } from \"./world\";\nimport { WorldWithShorthandsInput } from \"./input\";\nimport { validateNamespaces } from \"./namespaces\";\n\nexport type resolveWorldWithShorthands<world> = resolveWorld<{\n  [key in keyof world]: key extends \"tables\"\n    ? resolveTablesWithShorthands<world[key], extendedScope<world>>\n    : key extends \"namespaces\"\n      ? {\n          [namespaceKey in keyof world[key]]: {\n            [namespaceProp in keyof world[key][namespaceKey]]: namespaceProp extends \"tables\"\n              ? resolveTablesWithShorthands<world[key][namespaceKey][namespaceProp], extendedScope<world>>\n              : world[key][namespaceKey][namespaceProp];\n          };\n        }\n      : world[key];\n}>;\n\nexport type validateWorldWithShorthands<world> = {\n  [key in keyof world]: key extends \"tables\"\n    ? validateTablesWithShorthands<world[key], extendedScope<world>>\n    : key extends \"namespaces\"\n      ? validateNamespacesWithShorthands<world[key], extendedScope<world>>\n      : validateWorld<world>[key];\n};\n\nfunction validateWorldWithShorthands(world: unknown): asserts world is WorldWithShorthandsInput {\n  const scope = extendedScope(world);\n  if (hasOwnKey(world, \"tables\")) {\n    validateTablesWithShorthands(world.tables, scope);\n  }\n\n  if (hasOwnKey(world, \"namespaces\") && isObject(world.namespaces)) {\n    for (const namespaceKey of Object.keys(world.namespaces)) {\n      validateTablesWithShorthands(get(get(world.namespaces, namespaceKey), \"tables\") ?? {}, scope);\n    }\n  }\n}\n\nexport type validateNamespacesWithShorthands<namespaces, scope extends Scope = AbiTypeScope> = {\n  [namespace in keyof namespaces]: {\n    [key in keyof namespaces[namespace]]: key extends \"tables\"\n      ? validateTablesWithShorthands<namespaces[namespace][key], scope>\n      : validateNamespaces<namespaces[namespace], scope>[key];\n  };\n};\n\nexport function resolveWorldWithShorthands<world extends WorldWithShorthandsInput>(\n  world: world,\n): resolveWorldWithShorthands<world> {\n  const scope = extendedScope(world);\n  const tables = mapObject(world.tables ?? {}, (table) => {\n    return isTableShorthandInput(table) ? resolveTableShorthand(table, scope) : table;\n  });\n  const namespaces = mapObject(world.namespaces ?? {}, (namespace) => ({\n    ...namespace,\n    tables: mapObject(namespace.tables ?? {}, (table) => {\n      return isTableShorthandInput(table) ? resolveTableShorthand(table, scope) : table;\n    }),\n  }));\n\n  const fullConfig = { ...world, tables, namespaces };\n  validateWorld(fullConfig);\n\n  return resolveWorld(fullConfig) as unknown as resolveWorldWithShorthands<world>;\n}\n\nexport function defineWorldWithShorthands<world>(\n  world: validateWorldWithShorthands<world>,\n): resolveWorldWithShorthands<world> {\n  validateWorldWithShorthands(world);\n  return resolveWorldWithShorthands(world) as unknown as resolveWorldWithShorthands<world>;\n}\n"],"mappings":"2EACO,IAAMA,EAAqB,iEAGrBC,EAAkB,iDCJ/B,OAEE,iBAAAC,EACA,OAAAC,EACA,aAAAC,EACA,YAAAC,EACA,yBAAAC,EACA,yBAAAC,EAEA,gCAAAC,MAEK,8BACP,OAAS,aAAAC,MAAiB,2BA2B1B,SAASC,EAA4BC,EAA2D,CAC9F,IAAMC,EAAQC,EAAcF,CAAK,EAKjC,GAJIG,EAAUH,EAAO,QAAQ,GAC3BI,EAA6BJ,EAAM,OAAQC,CAAK,EAG9CE,EAAUH,EAAO,YAAY,GAAKK,EAASL,EAAM,UAAU,EAC7D,QAAWM,KAAgB,OAAO,KAAKN,EAAM,UAAU,EACrDI,EAA6BG,EAAIA,EAAIP,EAAM,WAAYM,CAAY,EAAG,QAAQ,GAAK,CAAC,EAAGL,CAAK,CAGlG,CAUO,SAASO,EACdR,EACmC,CACnC,IAAMC,EAAQC,EAAcF,CAAK,EAC3BS,EAASC,EAAUV,EAAM,QAAU,CAAC,EAAIW,GACrCC,EAAsBD,CAAK,EAAIE,EAAsBF,EAAOV,CAAK,EAAIU,CAC7E,EACKG,EAAaJ,EAAUV,EAAM,YAAc,CAAC,EAAIe,IAAe,CACnE,GAAGA,EACH,OAAQL,EAAUK,EAAU,QAAU,CAAC,EAAIJ,GAClCC,EAAsBD,CAAK,EAAIE,EAAsBF,EAAOV,CAAK,EAAIU,CAC7E,CACH,EAAE,EAEIK,EAAa,CAAE,GAAGhB,EAAO,OAAAS,EAAQ,WAAAK,CAAW,EAClD,OAAAG,EAAcD,CAAU,EAEjBE,EAAaF,CAAU,CAChC,CAEO,SAASG,EACdnB,EACmC,CACnC,OAAAD,EAA4BC,CAAK,EAC1BQ,EAA2BR,CAAK,CACzC","names":["worldDeployedEvent","helloWorldEvent","extendedScope","get","hasOwnKey","isObject","isTableShorthandInput","resolveTableShorthand","validateTablesWithShorthands","mapObject","validateWorldWithShorthands","world","scope","extendedScope","hasOwnKey","validateTablesWithShorthands","isObject","namespaceKey","get","resolveWorldWithShorthands","tables","mapObject","table","isTableShorthandInput","resolveTableShorthand","namespaces","namespace","fullConfig","validateWorld","resolveWorld","defineWorldWithShorthands"]}

package/dist/mud.config.d.ts

@@ -24,7 +24,7 @@ declare const _default: {
                     readonly namespaceId: "ResourceId";
                     readonly owner: "address";
                 };
-                key: ["namespaceId"];
+                key: readonly ["namespaceId"];
                 name: "NamespaceOwner";
             }>;
             readonly deploy: {
@@ -58,7 +58,7 @@ declare const _default: {
                     readonly caller: "address";
                     readonly access: "bool";
                 };
-                key: ["resourceId", "caller"];
+                key: readonly ["resourceId", "caller"];
                 name: "ResourceAccess";
             }>;
             readonly deploy: {
@@ -92,7 +92,7 @@ declare const _default: {
                     readonly argumentsHash: "bytes32";
                     readonly isInstalled: "bool";
                 };
-                key: ["moduleAddress", "argumentsHash"];
+                key: readonly ["moduleAddress", "argumentsHash"];
                 name: "InstalledModules";
             }>;
             readonly deploy: {
@@ -126,7 +126,7 @@ declare const _default: {
                     readonly delegatee: "address";
                     readonly delegationControlId: "ResourceId";
                 };
-                key: ["delegator", "delegatee"];
+                key: readonly ["delegator", "delegatee"];
                 name: "UserDelegationControl";
             }>;
             readonly deploy: {
@@ -155,7 +155,7 @@ declare const _default: {
                     readonly namespaceId: "ResourceId";
                     readonly delegationControlId: "ResourceId";
                 };
-                key: ["namespaceId"];
+                key: readonly ["namespaceId"];
                 name: "NamespaceDelegationControl";
             }>;
             readonly deploy: {
@@ -184,7 +184,7 @@ declare const _default: {
                     readonly namespaceId: "ResourceId";
                     readonly balance: "uint256";
                 };
-                key: ["namespaceId"];
+                key: readonly ["namespaceId"];
                 name: "Balances";
             }>;
             readonly deploy: {
@@ -221,7 +221,7 @@ declare const _default: {
                     readonly system: "address";
                     readonly publicAccess: "bool";
                 };
-                key: ["systemId"];
+                key: readonly ["systemId"];
                 name: "Systems";
             }>;
             readonly deploy: {
@@ -250,7 +250,7 @@ declare const _default: {
                     readonly system: "address";
                     readonly systemId: "ResourceId";
                 };
-                key: ["system"];
+                key: readonly ["system"];
                 name: "SystemRegistry";
             }>;
             readonly deploy: {
@@ -279,7 +279,7 @@ declare const _default: {
                     readonly systemId: "ResourceId";
                     readonly value: "bytes21[]";
                 };
-                key: ["systemId"];
+                key: readonly ["systemId"];
                 name: "SystemHooks";
             }>;
             readonly deploy: {
@@ -316,7 +316,7 @@ declare const _default: {
                     readonly systemId: "ResourceId";
                     readonly systemFunctionSelector: "bytes4";
                 };
-                key: ["worldFunctionSelector"];
+                key: readonly ["worldFunctionSelector"];
                 name: "FunctionSelectors";
             }>;
             readonly deploy: {
@@ -345,7 +345,7 @@ declare const _default: {
                     readonly functionSelector: "bytes4";
                     readonly functionSignature: "string";
                 };
-                key: ["functionSelector"];
+                key: readonly ["functionSelector"];
                 type: "offchainTable";
                 name: "FunctionSignatures";
             }>;
@@ -370,7 +370,7 @@ declare const _default: {
                 schema: {
                     readonly value: "address";
                 };
-                key: [];
+                key: readonly [];
                 name: "InitModuleAddress";
             }>;
             readonly deploy: {

package/dist/{world-c96a2291.d.ts → world-744aa7b1.d.ts}

@@ -1,5 +1,5 @@
 import { evaluate, narrow, ErrorMessage, conform } from '@arktype/util';
-import { StoreInput, mergeIfUndefined, resolveTable, get, extendedScope, validateTables, UserTypes, resolveStore, Store } from '@latticexyz/store/config/v2';
+import { StoreInput, StoreWithShorthandsInput, mergeIfUndefined, resolveTable, get, extendedScope, Scope, AbiTypeScope, validateTables, UserTypes, resolveStore, Store } from '@latticexyz/store/config/v2';
 import { M as Module } from './output-993b3634.js';
 import { S as SYSTEM_DEFAULTS } from './defaults-87a942d7.js';
 
@@ -15,7 +15,7 @@ type SystemInput = {
      */
     registerFunctionSelectors?: boolean;
     /** If openAccess is true, any address can call the system */
-    openAccess?: true;
+    openAccess?: boolean;
     /** An array of addresses or system names that can access the system */
     accessList?: string[];
 };
@@ -64,6 +64,8 @@ type NamespacesInput = {
     [key: string]: NamespaceInput;
 };
 type NamespaceInput = Pick<StoreInput, "tables">;
+/******** Variations with shorthands ********/
+type WorldWithShorthandsInput = Omit<WorldInput, "tables"> & Pick<StoreWithShorthandsInput, "tables">;
 
 declare const CODEGEN_DEFAULTS: {
     readonly worldInterfaceName: "IWorld";
@@ -100,6 +102,12 @@ type resolveSystems<systems extends SystemsInput> = {
 declare function resolveSystems<systems extends SystemsInput>(systems: systems): resolveSystems<systems>;
 
 type namespacedTableKeys<world> = "namespaces" extends keyof world ? "tables" extends keyof world["namespaces"][keyof world["namespaces"]] ? `${keyof world["namespaces"] & string}__${keyof world["namespaces"][keyof world["namespaces"]]["tables"] & string}` : never : never;
+type validateNamespaces<namespaces, scope extends Scope = AbiTypeScope> = {
+    [namespace in keyof namespaces]: {
+        [key in keyof namespaces[namespace]]: key extends "tables" ? validateTables<namespaces[namespace][key], scope> : namespaces[namespace][key];
+    };
+};
+declare function validateNamespaces<scope extends Scope = AbiTypeScope>(namespaces: unknown, scope: scope): asserts namespaces is NamespacesInput;
 type resolveNamespacedTables<world> = "namespaces" extends keyof world ? {
     readonly [key in namespacedTableKeys<world>]: key extends `${infer namespace}__${infer table}` ? resolveTable<mergeIfUndefined<get<get<get<get<world, "namespaces">, namespace>, "tables">, table>, {
         name: table;
@@ -125,4 +133,4 @@ type resolveWorld<world> = evaluate<resolveStore<world> & mergeIfUndefined<{
 declare function resolveWorld<const world extends WorldInput>(world: world): resolveWorld<world>;
 declare function defineWorld<const world>(world: validateWorld<world>): resolveWorld<world>;
 
-export { defineWorld as d, resolveWorld as r, validateWorld as v };
+export { WorldWithShorthandsInput as W, validateNamespaces as a, defineWorld as d, resolveWorld as r, validateWorld as v };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@latticexyz/world",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "World framework",
   "repository": {
     "type": "git",
@@ -38,15 +38,15 @@
     }
   },
   "dependencies": {
-    "@arktype/util": "0.0.25",
+    "@arktype/util": "0.0.27",
     "abitype": "1.0.0",
     "arktype": "1.0.29-alpha",
     "viem": "2.7.12",
     "zod": "^3.21.4",
-    "@latticexyz/common": "2.0.0",
-    "@latticexyz/config": "2.0.0",
-    "@latticexyz/schema-type": "2.0.0",
-    "@latticexyz/store": "2.0.0"
+    "@latticexyz/common": "2.0.1",
+    "@latticexyz/config": "2.0.1",
+    "@latticexyz/schema-type": "2.0.1",
+    "@latticexyz/store": "2.0.1"
   },
   "devDependencies": {
     "@types/ejs": "^3.1.1",
@@ -61,8 +61,8 @@
     "tsup": "^6.7.0",
     "tsx": "^3.12.6",
     "vitest": "0.34.6",
-    "@latticexyz/abi-ts": "2.0.0",
-    "@latticexyz/gas-report": "2.0.0"
+    "@latticexyz/abi-ts": "2.0.1",
+    "@latticexyz/gas-report": "2.0.1"
   },
   "scripts": {
     "build": "pnpm run build:mud && pnpm run build:abi && pnpm run build:abi-ts && pnpm run build:js",

package/ts/config/v2/input.ts

@@ -14,7 +14,7 @@ export type SystemInput = {
    */
   registerFunctionSelectors?: boolean;
   /** If openAccess is true, any address can call the system */
-  openAccess?: true;
+  openAccess?: boolean;
   /** An array of addresses or system names that can access the system */
   accessList?: string[];
 };

package/ts/config/v2/world.test.ts

@@ -727,4 +727,29 @@ describe("defineWorld", () => {
       }),
     ).type.errors("Namespaces config will be enabled soon.");
   });
+
+  it("should allow setting openAccess of a system to false", () => {
+    const config = defineWorld({
+      systems: {
+        Example: {
+          openAccess: false,
+        },
+      },
+    });
+
+    attest<false>(config.systems.Example.openAccess).equals(false);
+  });
+
+  it("should allow a const config as input", () => {
+    const config = {
+      tables: {
+        Example: {
+          schema: { id: "address", name: "string", age: "uint256" },
+          key: ["age"],
+        },
+      },
+    } as const;
+
+    defineWorld(config);
+  });
 });

package/ts/config/v2/worldWithShorthands.test.ts

@@ -321,4 +321,17 @@ describe("defineWorldWithShorthands", () => {
       "Invalid schema. Expected an `id` field with a static ABI type or an explicit `key` option.",
     );
   });
+
+  it("should allow a const config as input", () => {
+    const config = {
+      tables: {
+        Example: {
+          schema: { id: "address", name: "string", age: "uint256" },
+          key: ["age"],
+        },
+      },
+    } as const;
+
+    defineWorldWithShorthands(config);
+  });
 });

package/ts/exports/index.ts

@@ -6,5 +6,5 @@
 
 export { helloWorldEvent, worldDeployedEvent } from "../worldEvents";
 
-export { defineWorld } from "../config/v2/world";
+export { defineWorldWithShorthands as defineWorld } from "../config/v2/worldWithShorthands";
 export type { World } from "../config/v2/output";