refactor: rename QueryBuilder to Query

tien · Jun 11, 2024 · e871b85 · e871b85
1 parent 29736f9
commit e871b85
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 28 deletions.
diff --git a/packages/core/src/QueryBuilder.ts b/packages/core/src/QueryBuilder.ts
@@ -196,23 +196,17 @@ export type InferInstructionsPayload<
   >;
 };
 
-export type InferQueryBuilderResponse<T extends QueryBuilder> =
-  T extends QueryBuilder<infer Instructions, infer Descriptor>
+export type InferQueryResponse<T extends Query> =
+  T extends Query<infer Instructions, infer Descriptor>
     ? InferInstructionsResponse<Instructions, Descriptor>
     : never;
 
-export type InferQueryBuilderPayload<T extends QueryBuilder> =
-  T extends QueryBuilder<infer Instructions, infer Descriptor>
+export type InferQueryPayload<T extends Query> =
+  T extends Query<infer Instructions, infer Descriptor>
     ? InferInstructionsPayload<Instructions, Descriptor>
     : never;
 
-export type Query<
-  TInstructions extends QueryInstruction[] = QueryInstruction[],
-> = {
-  readonly instructions: TInstructions;
-};
-
-export default class QueryBuilder<
+export default class Query<
   const TInstructions extends QueryInstruction[] = QueryInstruction[],
   TDescriptor extends ChainDefinition = ReDotDescriptor,
 > implements Query<TInstructions>
@@ -231,7 +225,7 @@ export default class QueryBuilder<
     TPallet extends keyof TypedApi<TDescriptor>["constants"],
     TConstant extends keyof TypedApi<TDescriptor>["constants"][TPallet],
   >(pallet: TPallet, constant: TConstant) {
-    return new QueryBuilder([
+    return new Query([
       ...this.#instructions,
       { instruction: "fetch-constant", pallet, constant },
     ]);
@@ -244,7 +238,7 @@ export default class QueryBuilder<
       TypedApi<TDescriptor>["query"][TPallet][TStorage]
     >["args"],
   >(pallet: TPallet, storage: TStorage, args: TArguments) {
-    return new QueryBuilder([
+    return new Query([
       ...this.#instructions,
       { instruction: "read-storage", pallet, storage, args },
     ]);
@@ -257,7 +251,7 @@ export default class QueryBuilder<
       TypedApi<TDescriptor>["query"][TPallet][TStorage]
     >["args"],
   >(pallet: TPallet, storage: TStorage, args: TArguments[]) {
-    return new QueryBuilder([
+    return new Query([
       ...this.#instructions,
       { instruction: "read-storage", pallet, storage, args, multi: true },
     ]);
@@ -272,7 +266,7 @@ export default class QueryBuilder<
       >["args"]
     >,
   >(pallet: TPallet, storage: TStorage, args: TArguments) {
-    return new QueryBuilder([
+    return new Query([
       ...this.#instructions,
       { instruction: "read-storage-entries", pallet, storage, args },
     ]);
@@ -285,7 +279,7 @@ export default class QueryBuilder<
       TypedApi<TDescriptor>["apis"][TPallet][TApi]
     >["args"],
   >(pallet: TPallet, api: TApi, args: TArguments) {
-    return new QueryBuilder([
+    return new Query([
       ...this.#instructions,
       { instruction: "call-api", pallet, api, args },
     ]);
@@ -298,7 +292,7 @@ export default class QueryBuilder<
       TypedApi<TDescriptor>["apis"][TPallet][TApi]
     >["args"],
   >(pallet: TPallet, api: TApi, args: TArguments[]) {
-    return new QueryBuilder([
+    return new Query([
       ...this.#instructions,
       { instruction: "call-api", pallet, api, args, multi: true },
     ]);

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -1,7 +1,7 @@
 export {
-  default as QueryBuilder,
-  type InferQueryBuilderPayload,
-  type InferQueryBuilderResponse,
+  default as Query,
+  type InferQueryPayload,
+  type InferQueryResponse,
   type MultiInstruction,
   type QueryInstruction,
 } from "./QueryBuilder.js";

diff --git a/packages/react/src/hooks/useQuery.ts b/packages/react/src/hooks/useQuery.ts
@@ -4,10 +4,10 @@ import type { Falsy, FalsyGuard, FlatHead } from "../types.js";
 import { flatHead, stringify } from "../utils.js";
 import type { ChainHookOptions } from "./types.js";
 import {
-  QueryBuilder,
+  Query,
   QueryError,
   QueryInstruction,
-  type InferQueryBuilderPayload,
+  type InferQueryPayload,
 } from "@reactive-dot/core";
 import type { ChainId, Chains, ReDotDescriptor } from "@reactive-dot/types";
 import { atom, useAtomValue } from "jotai";
@@ -23,8 +23,8 @@ import { useContext, useMemo } from "react";
 export const useQuery = <
   TQuery extends
     | ((
-        builder: QueryBuilder<[], TDescriptor>,
-      ) => QueryBuilder<QueryInstruction<TDescriptor>[], TDescriptor> | Falsy)
+        builder: Query<[], TDescriptor>,
+      ) => Query<QueryInstruction<TDescriptor>[], TDescriptor> | Falsy)
     | Falsy,
   TDescriptor extends TChainId extends void
     ? ReDotDescriptor
@@ -38,9 +38,7 @@ export const useQuery = <
   : FalsyGuard<
       ReturnType<Exclude<TQuery, Falsy>>,
       FlatHead<
-        InferQueryBuilderPayload<
-          Exclude<ReturnType<Exclude<TQuery, Falsy>>, Falsy>
-        >
+        InferQueryPayload<Exclude<ReturnType<Exclude<TQuery, Falsy>>, Falsy>>
       >
     > => {
   const contextChainId = useContext(ChainIdContext);
@@ -51,7 +49,7 @@ export const useQuery = <
   }
 
   const query = useMemo(
-    () => (!builder ? undefined : builder(new QueryBuilder([]))),
+    () => (!builder ? undefined : builder(new Query([]))),
     [builder],
   );