Merge pull request #424 from dojoengine/feat/bump-dojo131

feat: add specific control param to query torii types

Author: MartianGreed

.changeset/dry-rivers-give.md

@@ -0,0 +1,15 @@
+---
+"@dojoengine/predeployed-connector": patch
+"@dojoengine/create-burner": patch
+"@dojoengine/torii-client": patch
+"@dojoengine/create-dojo": patch
+"@dojoengine/torii-wasm": patch
+"@dojoengine/react": patch
+"@dojoengine/state": patch
+"@dojoengine/utils": patch
+"@dojoengine/core": patch
+"@dojoengine/sdk": patch
+"@dojoengine/utils-wasm": patch
+---
+
+chore: bump dojo 1.3.1

.changeset/moody-rats-shake.md

@@ -0,0 +1,5 @@
+---
+"@dojoengine/sdk": patch
+---
+
+feat: add way to create specific types to query torii

.github/workflows/ci.yaml

@@ -11,6 +11,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true
       - uses: oven-sh/setup-bun@v1
       - uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
@@ -41,9 +43,6 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-cargo-
 
-      - name: Update Submodules
-        run: git submodule update --init --recursive
-
       - run: curl -L https://install.dojoengine.org | bash
       - uses: software-mansion/setup-scarb@v1
         with:

.github/workflows/docs.yaml

@@ -16,6 +16,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true
       - uses: pnpm/action-setup@v2
         with:
           version: 10.0.0
@@ -30,9 +32,6 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-turbo-
 
-      - name: Update Submodules
-        run: git submodule update --init --recursive
-
       - name: Install Protobuf Compiler
         run: sudo apt-get install -y protobuf-compiler
 

.github/workflows/release.yaml

@@ -19,7 +19,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 0
+          submodules: true
 
       - uses: pnpm/action-setup@v3
         with:
@@ -71,9 +71,6 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-cargo-
 
-      - name: Update Submodules
-        run: git submodule update --init --recursive
-
       - run: curl -L https://install.dojoengine.org | bash
       - uses: software-mansion/setup-scarb@v1
         with:

.gitmodules

@@ -1,11 +1,12 @@
 [submodule "worlds/onchain-dash"]
 	path = worlds/onchain-dash
 	url = https://github.com/MartianGreed/onchain-dash
-  ignore = dirty
+    ignore = dirty
 [submodule "worlds/dojo-starter"]
 	path = worlds/dojo-starter
 	url = https://github.com/dojoengine/dojo-starter
-  ignore = dirty
+	ignore = dirty
 [submodule "packages/torii-wasm/dojo.c"]
 	path = packages/torii-wasm/dojo.c
 	url = https://github.com/dojoengine/dojo.c.git
+	ignore = dirty

examples/example-predeployed-connector/src/starknet-provider.tsx

@@ -23,6 +23,7 @@ export default function StarknetProvider({ children }: PropsWithChildren) {
             explorer={voyager}
             autoConnect
         >
+            {/* @ts-ignore */}
             {children}
         </StarknetConfig>
     );

examples/example-vite-kitchen-sink/package.json

@@ -34,28 +34,28 @@
         "jiti": "^1.21.7",
         "lucide-react": "^0.441.0",
         "next": "14.2.12",
-        "react": "^18.3.1",
-        "react-dom": "^18.3.1",
+        "react": "catalog:",
+        "react-dom": "catalog:",
         "react-hook-form": "^7.54.2",
         "starknet": "catalog:",
         "tailwind-merge": "^2.6.0",
         "tailwindcss-animate": "^1.0.7",
         "vaul": "^0.9.9",
-        "zod": "^3.24.1"
+        "zod": "^3.24.2"
     },
     "devDependencies": {
-        "@types/node": "^20.17.17",
-        "@types/react": "^18.3.18",
-        "@types/react-dom": "^18.3.5",
+        "@types/node": "^20.17.27",
+        "@types/react": "catalog:",
+        "@types/react-dom": "catalog:",
         "@vitejs/plugin-react": "^4.3.4",
         "eslint": "^8.57.1",
         "eslint-config-next": "14.2.12",
-        "postcss": "^8.5.1",
+        "postcss": "^8.5.3",
         "tailwindcss": "^3.4.17",
-        "typescript": "^5.7.3",
-        "vite": "^6.1.0",
-        "vite-plugin-mkcert": "^1.17.6",
-        "vite-plugin-top-level-await": "^1.4.4",
+        "typescript": "^5.8.2",
+        "vite": "^6.2.3",
+        "vite-plugin-mkcert": "^1.17.8",
+        "vite-plugin-top-level-await": "^1.5.0",
         "vite-plugin-wasm": "^3.4.1",
         "vite-preset-react": "^2.3.0"
     }

examples/example-vite-kitchen-sink/src/components/theme-switch.tsx

@@ -21,7 +21,7 @@ import {
     DropdownMenuTrigger,
 } from "@/components/ui/dropdown";
 import { CairoCustomEnum } from "starknet";
-import { useDojoSDK } from "@dojoengine/sdk/react";
+import { useDojoSDK, useEntityId } from "@dojoengine/sdk/react";
 import { setupWorld } from "@/typescript/contracts.gen";
 
 interface ThemeState {
@@ -50,7 +50,7 @@ export default function ThemeSwitchButton() {
         next: null,
     });
     const [isLoading, setIsLoading] = useState(false);
-    const [entityId, setEntityId] = useState<string | null>(null);
+    const entityId = useEntityId(9999999);
     const { account } = useAccount();
     const [sub, setSub] = useState<Subscription | null>(null);
     const { sdk: db, client: actions } = useDojoSDK<
@@ -120,8 +120,7 @@ export default function ThemeSwitchButton() {
             setSub(sub);
 
             const theme =
-                initialTheme[0].models?.onchain_dash?.Theme?.value?.unwrap();
-            setEntityId(initialTheme[0].entityId);
+                initialTheme[0]?.models?.onchain_dash?.Theme?.value?.unwrap();
             let th = null;
             if (undefined === theme) {
                 th = AvailableTheme.Light;

examples/example-vite-react-sql/src/components/playground/direction-count.tsx

@@ -1,8 +1,7 @@
 import { SchemaType } from "@/typescript/models.gen";
-import { DojoContext } from "@dojoengine/sdk/react";
+import { useDojoSDK } from "@dojoengine/sdk/react";
 import { useToriiSQLQuery } from "@dojoengine/sdk/sql";
 import { useQueryClient } from "@tanstack/react-query";
-import { useContext } from "react";
 
 type QueryResponse = Array<{
     count: number;
@@ -41,8 +40,9 @@ function formatFn(rows: QueryResponse): DirectionCount {
 
 export function DirectionCount() {
     // use queryClient to invalidateQuery when state is changing.
-    const { useDojoStore } = useContext(DojoContext);
+    const { useDojoStore } = useDojoSDK();
     const queryClient = useQueryClient();
+    // @ts-expect-error it's ok if I dont use this variable compiler, react needs it
     useDojoStore.subscribe(
         (s: SchemaType) => s.entities,
         () => {

packages/core/package.json

@@ -24,14 +24,14 @@
         "@dojoengine/torii-client": "workspace:*",
         "@types/elliptic": "^6.4.18",
         "@vitest/coverage-v8": "^1.6.0",
-        "tsup": "^8.3.0",
+        "tsup": "^8.3.5",
         "typescript": "^5.6.2",
         "vitest": "^1.6.0"
     },
     "dependencies": {
         "@dojoengine/recs": "2.0.13",
-        "zod": "^3.23.8",
-        "starknet": "catalog:"
+        "starknet": "catalog:",
+        "zod": "^3.23.8"
     },
     "bin": {
         "create-components": "./dist/bin/generateComponents.cjs"

packages/create-burner/package.json

@@ -39,7 +39,7 @@
         "@types/web": "^0.0.114",
         "@vitest/coverage-v8": "^1.6.0",
         "jsdom": "^24.1.3",
-        "tsup": "^8.3.0",
+        "tsup": "^8.3.5",
         "typescript": "^5.6.2",
         "vitest": "^1.6.0"
     },

packages/create-dojo/package.json

@@ -38,7 +38,7 @@
         "@types/cross-spawn": "^6.0.6",
         "@types/js-yaml": "^4.0.9",
         "@types/node-fetch": "^2.6.12",
-        "tsup": "^8.3.0",
+        "tsup": "^8.3.5",
         "typescript": "^5.6.2",
         "vitest": "^2.1.1"
     }

packages/predeployed-connector/package.json

@@ -29,21 +29,21 @@
     },
     "devDependencies": {
         "@rollup/plugin-commonjs": "^28.0.0",
-        "@vitest/coverage-v8": "^1.6.0",
         "@types/react": "catalog:",
         "@types/react-dom": "catalog:",
+        "@vitest/coverage-v8": "^1.6.0",
         "eslint": "^8.57.1",
         "prettier": "^2.8.8",
-        "tsup": "^8.3.0",
+        "tsup": "^8.4.0",
         "typescript": "^5.6.2",
         "vite": "^3.2.11",
         "vitest": "^1.6.0"
     },
     "peerDependencies": {
         "@starknet-react/core": "catalog:",
-        "starknet": "catalog:",
         "react": "catalog:",
-        "react-dom": "catalog:"
+        "react-dom": "catalog:",
+        "starknet": "catalog:"
     },
     "repository": {
         "type": "git",

packages/react/package.json

@@ -34,7 +34,7 @@
         "@types/react": "^18.3.9",
         "@types/react-dom": "^18.3.0",
         "@types/web": "^0.0.114",
-        "tsup": "^8.3.0",
+        "tsup": "^8.3.5",
         "typescript": "^5.6.2"
     },
     "dependencies": {

packages/sdk/src/__tests__/convertClauseToEntityKeysClause.test.ts

@@ -20,7 +20,7 @@ describe("convertClauseToEntityKeysClause", () => {
         ]);
     });
 
-    it("HashedKeys has priority over keys", () => {
+    it("if keys clause and HashedKeys are present, keys has priority", () => {
         const clause = new ClauseBuilder()
             .keys(["dojo_starter-Position"], ["0x123"])
             .build();
@@ -33,7 +33,11 @@ describe("convertClauseToEntityKeysClause", () => {
             ])
         ).toEqual([
             {
-                HashedKeys: ["0xentityHashedKey"],
+                Keys: {
+                    keys: ["0x123"],
+                    pattern_matching: "VariableLen",
+                    models: ["dojo_starter-Position"],
+                },
             },
         ]);
     });

packages/sdk/src/clauseBuilder.ts

@@ -5,7 +5,7 @@ import {
     PatternMatching,
 } from "@dojoengine/torii-client";
 
-import { convertToPrimitive } from "./convertToMemberValue";
+import { convertToPrimitive, MemberValueParam } from "./convertToMemberValue";
 import { SchemaType } from "./types";
 
 type ClauseBuilderInterface = {
@@ -66,7 +66,10 @@ export function MemberClause<
     model: Path,
     member: M & string,
     operator: ComparisonOperator,
-    value: GetModelType<T, Path>[M] | GetModelType<T, Path>[M][]
+    value:
+        | GetModelType<T, Path>[M]
+        | GetModelType<T, Path>[M][]
+        | MemberValueParam
 ): ClauseBuilder<T> {
     return new ClauseBuilder<T>().where(model, member, operator, value);
 }
@@ -132,7 +135,10 @@ export class ClauseBuilder<T extends SchemaType> {
         model: Path,
         member: M & string,
         operator: ComparisonOperator,
-        value: GetModelType<T, Path>[M] | GetModelType<T, Path>[M][]
+        value:
+            | GetModelType<T, Path>[M]
+            | GetModelType<T, Path>[M][]
+            | MemberValueParam
     ): ClauseBuilder<T> {
         const memberValue: MemberValue = Array.isArray(value)
             ? { List: value.map(convertToPrimitive) }

packages/sdk/src/convertClauseToEntityKeysClause.ts

@@ -9,16 +9,18 @@ export function intoEntityKeysClause<T extends SchemaType>(
     if (!clause) {
         return [];
     }
+
+    // if we have keys clause, we can move forward to query those keys directly
+    if (Object.hasOwn(clause, "Keys")) {
+        return [clause as unknown as EntityKeysClause];
+    }
+
     // if we have initial wih query.dont_include_hash_keys = false
     // we can move forward to query those hashed keys directly
     if (initialData && initialData.length > 0) {
         return [{ HashedKeys: initialData.map((e) => e.entityId) }];
     }
 
-    if (Object.hasOwn(clause, "Keys")) {
-        return [clause as unknown as EntityKeysClause];
-    }
-
     // We want to avoid those kind of weird cases where we are guessing what data should be retrieved
     if (
         (Object.hasOwn(clause, "Member") ||

packages/sdk/src/convertToMemberValue.ts

@@ -1,13 +1,24 @@
 import * as torii from "@dojoengine/torii-client";
 
+type ToUnion<T> = T extends infer U ? U : never;
+type ExtractPrimitiveKeys<T> = T extends Record<infer K, any> ? K : never;
+type PrimitiveTypeKeys = ToUnion<ExtractPrimitiveKeys<torii.Primitive>>;
+
+export type MemberValueParam = { type: PrimitiveTypeKeys; value: any } | any;
+
 /**
  * Converts a value to a Torii primitive type.
  *
- * @param {any} value - The value to convert.
+ * @param {MemberValue} value - The value to convert.
  * @returns {torii.MemberValue} - The converted primitive value.
  * @throws {Error} - If the value type is unsupported.
  */
-export function convertToPrimitive(value: any): torii.MemberValue {
+export function convertToPrimitive(value: MemberValueParam): torii.MemberValue {
+    // if you want to have more control over type passed to torii
+    if (Object.hasOwn(value, "type") && Object.hasOwn(value, "value")) {
+        return { Primitive: { [value.type]: value.value } as torii.Primitive };
+    }
+
     if (typeof value === "number") {
         return { Primitive: { U32: value } };
     } else if (typeof value === "boolean") {