@ponder/react 0.11.28 → 0.11.30

package/dist/esm/utils.js

@@ -2,6 +2,7 @@ import { compileQuery } from "@ponder/client";
 import { stringify } from "superjson";
 export function getPonderQueryOptions(client, queryFn) {
     const queryPromise = queryFn(client.db);
+    // @ts-expect-error
     if ("getSQL" in queryPromise === false) {
         throw new Error('"queryFn" must return SQL');
     }

package/dist/esm/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAItC,MAAM,UAAU,qBAAqB,CACnC,MAAc,EACd,OAA8C;IAK9C,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAExC,IAAI,QAAQ,IAAI,YAAY,KAAK,KAAK,EAAE;QACtC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;KAC9C;IAED,MAAM,KAAK,GAAG,YAAY,CAAC,YAAqC,CAAC,CAAC;IAClE,MAAM,QAAQ,GAAG,CAAC,gBAAgB,EAAE,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IAExE,OAAO;QACL,QAAQ;QACR,OAAO,EAAE,GAAG,EAAE,CAAC,YAAY;KAC5B,CAAC;AACJ,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAKtC,MAAM,UAAU,qBAAqB,CACnC,MAA8B,EAC9B,OAAgD;IAKhD,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAExC,mBAAmB;IACnB,IAAI,QAAQ,IAAI,YAAY,KAAK,KAAK,EAAE;QACtC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;KAC9C;IAED,MAAM,KAAK,GAAG,YAAY,CAAC,YAAqC,CAAC,CAAC;IAClE,MAAM,QAAQ,GAAG,CAAC,gBAAgB,EAAE,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IAExE,OAAO;QACL,QAAQ;QACR,OAAO,EAAE,GAAG,EAAE,CAAC,YAAY;KAC5B,CAAC;AACJ,CAAC"}

package/dist/types/context.d.ts

@@ -1,9 +1,14 @@
 /// <reference types="react" />
 import type { Client } from "@ponder/client";
-export declare const PonderContext: import("react").Context<Client | undefined>;
+import type { ResolvedSchema } from "./index.js";
+export declare const PonderContext: import("react").Context<Client<{
+    [name: string]: unknown;
+}> | undefined>;
 type PonderProviderProps = {
-    client: Client;
+    client: Client<ResolvedSchema>;
 };
-export declare function PonderProvider(parameters: React.PropsWithChildren<PonderProviderProps>): import("react").FunctionComponentElement<import("react").ProviderProps<Client | undefined>>;
+export declare function PonderProvider(parameters: React.PropsWithChildren<PonderProviderProps>): import("react").FunctionComponentElement<import("react").ProviderProps<Client<{
+    [name: string]: unknown;
+}> | undefined>>;
 export {};
 //# sourceMappingURL=context.d.ts.map

package/dist/types/context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/context.ts"],"names":[],"mappings":";AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAG7C,eAAO,MAAM,aAAa,6CAA+C,CAAC;AAE1E,KAAK,mBAAmB,GAAG;IACzB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,wBAAgB,cAAc,CAC5B,UAAU,EAAE,KAAK,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,+FAKzD"}
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/context.ts"],"names":[],"mappings":";AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,eAAO,MAAM,aAAa;;eAEzB,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACzB,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC;CAChC,CAAC;AAEF,wBAAgB,cAAc,CAC5B,UAAU,EAAE,KAAK,CAAC,iBAAiB,CAAC,mBAAmB,CAAC;;iBAKzD"}

package/dist/types/hook.d.ts

@@ -1,7 +1,13 @@
 import type { Client, Status } from "@ponder/client";
-import { type UseQueryOptions, type UseQueryResult } from "@tanstack/react-query";
+import { type QueryKey, type UseQueryOptions, type UseQueryResult } from "@tanstack/react-query";
+import type { ResolvedSchema } from "./index.js";
 export declare function usePonderQuery<result>(params: {
-    queryFn: (db: Client["db"]) => Promise<result>;
+    queryFn: (db: Client<ResolvedSchema>["db"]) => Promise<result>;
 } & Omit<UseQueryOptions<result>, "queryFn" | "queryKey">): UseQueryResult<result>;
+export declare function usePonderClient(): Client<ResolvedSchema>;
+export declare function usePonderQueryOptions<T>(queryFn: (db: Client<ResolvedSchema>["db"]) => T): {
+    queryKey: QueryKey;
+    queryFn: () => T;
+};
 export declare function usePonderStatus(params: Omit<UseQueryOptions<Status>, "queryFn" | "queryKey">): UseQueryResult<Status>;
 //# sourceMappingURL=hook.d.ts.map

package/dist/types/hook.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hook.d.ts","sourceRoot":"","sources":["../../src/hook.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,cAAc,EAGpB,MAAM,uBAAuB,CAAC;AAK/B,wBAAgB,cAAc,CAAC,MAAM,EACnC,MAAM,EAAE;IACN,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CAChD,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC,GACxD,cAAc,CAAC,MAAM,CAAC,CA4BxB;AAID,wBAAgB,eAAe,CAC7B,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC,GAC5D,cAAc,CAAC,MAAM,CAAC,CAsBxB"}
+{"version":3,"file":"hook.d.ts","sourceRoot":"","sources":["../../src/hook.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,eAAe,EACpB,KAAK,cAAc,EAGpB,MAAM,uBAAuB,CAAC;AAG/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAGjD,wBAAgB,cAAc,CAAC,MAAM,EACnC,MAAM,EAAE;IACN,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CAChE,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC,GACxD,cAAc,CAAC,MAAM,CAAC,CAyBxB;AAED,wBAAgB,eAAe,IAAI,MAAM,CAAC,cAAc,CAAC,CAMxD;AAED,wBAAgB,qBAAqB,CAAC,CAAC,EACrC,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAC/C;IACD,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,CAAC;CAClB,CAGA;AAID,wBAAgB,eAAe,CAC7B,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC,GAC5D,cAAc,CAAC,MAAM,CAAC,CAsBxB"}

package/dist/types/index.d.ts

@@ -1,4 +1,11 @@
 export { PonderProvider, PonderContext } from "./context.js";
-export { usePonderQuery, usePonderStatus } from "./hook.js";
+export { usePonderQuery, usePonderStatus, usePonderClient, usePonderQueryOptions, } from "./hook.js";
 export { getPonderQueryOptions } from "./utils.js";
+export interface Register {
+}
+export type ResolvedSchema = Register extends {
+    schema: infer schema;
+} ? schema : {
+    [name: string]: unknown;
+};
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EACL,cAAc,EACd,eAAe,EACf,eAAe,EACf,qBAAqB,GACtB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAGnD,MAAM,WAAW,QAAQ;CAAG;AAE5B,MAAM,MAAM,cAAc,GAAG,QAAQ,SAAS;IAAE,MAAM,EAAE,MAAM,MAAM,CAAA;CAAE,GAClE,MAAM,GACN;IACE,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;CACzB,CAAC"}

package/dist/types/utils.d.ts

@@ -1,8 +1,9 @@
 import { type Client, compileQuery } from "@ponder/client";
 import type { QueryKey } from "@tanstack/react-query";
+import type { ResolvedSchema } from "./index.js";
 export type SQLWrapper = Exclude<Parameters<typeof compileQuery>[0], string>;
-export declare function getPonderQueryOptions<result>(client: Client, queryFn: (db: Client["db"]) => Promise<result>): {
+export declare function getPonderQueryOptions<T>(client: Client<ResolvedSchema>, queryFn: (db: Client<ResolvedSchema>["db"]) => T): {
     queryKey: QueryKey;
-    queryFn: () => Promise<result>;
+    queryFn: () => T;
 };
 //# sourceMappingURL=utils.d.ts.map

package/dist/types/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAGtD,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAE7E,wBAAgB,qBAAqB,CAAC,MAAM,EAC1C,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,GAC7C;IACD,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;CAChC,CAcA"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEtD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAE7E,wBAAgB,qBAAqB,CAAC,CAAC,EACrC,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC,EAC9B,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAC/C;IACD,QAAQ,EAAE,QAAQ,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,CAAC;CAClB,CAeA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ponder/react",
-  "version": "0.11.28",
+  "version": "0.11.30",
   "description": "React hooks for Ponder",
   "license": "MIT",
   "repository": {
@@ -31,7 +31,7 @@
     "superjson": "^2.2.2"
   },
   "peerDependencies": {
-    "@ponder/client": ">=0.11.28",
+    "@ponder/client": ">=0.11.30",
     "@tanstack/react-query": ">=5.0.0",
     "react": ">=18",
     "typescript": ">=5.0.4"
@@ -51,7 +51,7 @@
     "react": "^18.2.0",
     "rimraf": "^5.0.5",
     "tsx": "^4.19.2",
-    "@ponder/client": "0.11.28"
+    "@ponder/client": "0.11.30"
   },
   "scripts": {
     "build": "tsx build.ts",

package/src/context.ts

@@ -2,11 +2,14 @@
 
 import type { Client } from "@ponder/client";
 import { createContext, createElement } from "react";
+import type { ResolvedSchema } from "./index.js";
 
-export const PonderContext = createContext<Client | undefined>(undefined);
+export const PonderContext = createContext<Client<ResolvedSchema> | undefined>(
+  undefined,
+);
 
 type PonderProviderProps = {
-  client: Client;
+  client: Client<ResolvedSchema>;
 };
 
 export function PonderProvider(

package/src/hook.ts

@@ -2,6 +2,7 @@
 
 import type { Client, Status } from "@ponder/client";
 import {
+  type QueryKey,
   type UseQueryOptions,
   type UseQueryResult,
   useQuery,
@@ -9,19 +10,17 @@ import {
 } from "@tanstack/react-query";
 import { useContext, useEffect, useMemo } from "react";
 import { PonderContext } from "./context.js";
+import type { ResolvedSchema } from "./index.js";
 import { getPonderQueryOptions } from "./utils.js";
 
 export function usePonderQuery<result>(
   params: {
-    queryFn: (db: Client["db"]) => Promise<result>;
+    queryFn: (db: Client<ResolvedSchema>["db"]) => Promise<result>;
   } & Omit<UseQueryOptions<result>, "queryFn" | "queryKey">,
 ): UseQueryResult<result> {
   const queryClient = useQueryClient();
 
-  const client = useContext(PonderContext);
-  if (client === undefined) {
-    throw new Error("PonderProvider not found");
-  }
+  const client = usePonderClient();
 
   // biome-ignore lint/correctness/useExhaustiveDependencies: <explanation>
   const queryOptions = useMemo(
@@ -45,6 +44,24 @@ export function usePonderQuery<result>(
   });
 }
 
+export function usePonderClient(): Client<ResolvedSchema> {
+  const client = useContext(PonderContext);
+  if (client === undefined) {
+    throw new Error("PonderProvider not found");
+  }
+  return client;
+}
+
+export function usePonderQueryOptions<T>(
+  queryFn: (db: Client<ResolvedSchema>["db"]) => T,
+): {
+  queryKey: QueryKey;
+  queryFn: () => T;
+} {
+  const client = usePonderClient();
+  return getPonderQueryOptions(client, queryFn);
+}
+
 const statusQueryKey = ["status"];
 
 export function usePonderStatus(

package/src/index.ts

@@ -1,3 +1,17 @@
 export { PonderProvider, PonderContext } from "./context.js";
-export { usePonderQuery, usePonderStatus } from "./hook.js";
+export {
+  usePonderQuery,
+  usePonderStatus,
+  usePonderClient,
+  usePonderQueryOptions,
+} from "./hook.js";
 export { getPonderQueryOptions } from "./utils.js";
+
+// biome-ignore lint/suspicious/noEmptyInterface: <explanation>
+export interface Register {}
+
+export type ResolvedSchema = Register extends { schema: infer schema }
+  ? schema
+  : {
+      [name: string]: unknown;
+    };

package/src/utils.ts

@@ -1,18 +1,20 @@
 import { type Client, compileQuery } from "@ponder/client";
 import type { QueryKey } from "@tanstack/react-query";
 import { stringify } from "superjson";
+import type { ResolvedSchema } from "./index.js";
 
 export type SQLWrapper = Exclude<Parameters<typeof compileQuery>[0], string>;
 
-export function getPonderQueryOptions<result>(
-  client: Client,
-  queryFn: (db: Client["db"]) => Promise<result>,
+export function getPonderQueryOptions<T>(
+  client: Client<ResolvedSchema>,
+  queryFn: (db: Client<ResolvedSchema>["db"]) => T,
 ): {
   queryKey: QueryKey;
-  queryFn: () => Promise<result>;
+  queryFn: () => T;
 } {
   const queryPromise = queryFn(client.db);
 
+  // @ts-expect-error
   if ("getSQL" in queryPromise === false) {
     throw new Error('"queryFn" must return SQL');
   }