allow custom queries

.gitignore

@@ -8,3 +8,6 @@ yarn-error.log
 
 # Generated resources (all regenerated at build time)
 src/resources/
+
+# Published copy of the schema (regenerated by fetch:schema)
+/schema.graphql

examples/README.md

@@ -176,15 +176,19 @@ sdk.subscriptions.onPriceUpdated(
 
 ### Custom GraphQL Query
 
+Custom queries let you request only the fields you need — you're billed for the fields your query requests, so this is the recommended pattern for production. Wrap the SDK's exported query types in `DeepPartial` so the compiler stays honest about fields your query didn't select:
+
 ```typescript
-import { GetNetworksQuery } from "@codex-data/sdk";
+import { DeepPartial, GetNetworksQuery } from "@codex-data/sdk";
 
-const result = await sdk.send<GetNetworksQuery>(
+const result = await sdk.send<DeepPartial<GetNetworksQuery>>(
   `query GetNetworks { getNetworks { id name } }`,
   {},
 );
 ```
 
+For exact types inferred from your query (no `DeepPartial` needed), see the [codegen example](./codegen/).
+
 ### Mutation Example
 
 ```typescript

examples/codegen/codegen.ts

@@ -2,7 +2,9 @@ import type { CodegenConfig } from "@graphql-codegen/cli";
 
 const config: CodegenConfig = {
   overwrite: true,
-  schema: "../../src/resources/schema.graphql",
+  // The SDK ships its schema, so codegen runs offline against the exact
+  // schema version you have installed.
+  schema: "./node_modules/@codex-data/sdk/schema.graphql",
   documents: "src/**/*.ts",
   generates: {
     "src/gql/": {

examples/codegen/src/index.ts

@@ -1,7 +1,8 @@
 import { Codex } from "@codex-data/sdk";
-import { graphql } from "./gql/gql";
-import { NetworksQuery, NetworksQueryVariables } from "./gql/graphql";
+import { graphql } from "./gql";
 
+// The result type is inferred from exactly the fields selected here —
+// and you're only billed for the fields you request.
 const doc = graphql(`
   query Networks {
     getNetworks {
@@ -13,6 +14,6 @@ const doc = graphql(`
 
 const sdk = new Codex(process.env.CODEX_API_KEY || "");
 
-sdk.query<NetworksQuery, NetworksQueryVariables>(doc).then((res) => {
-  console.log("Fetched res", res);
+sdk.query(doc).then((res) => {
+  console.log("Fetched res", res.getNetworks);
 });

package.json

@@ -12,7 +12,8 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
       "require": "./dist/index.js"
-    }
+    },
+    "./schema.graphql": "./schema.graphql"
   },
   "sideEffects": false,
   "scripts": {
@@ -23,7 +24,7 @@
     "build:cjs": "tsc",
     "build:esm": "tsc -p tsconfig.esm.json",
     "build:rename-esm": "find dist-esm -name '*.js' -exec sh -c 'mv \"$1\" \"${1%.js}.mjs\"' _ {} \\; && cp -r dist-esm/* dist/ && rm -rf dist-esm",
-    "fetch:schema": "curl -s https://graph.codex.io/schema/latest.graphql --output src/resources/schema.graphql",
+    "fetch:schema": "curl -s https://graph.codex.io/schema/latest.graphql --output src/resources/schema.graphql && cp src/resources/schema.graphql schema.graphql",
     "generate:configs": "tsx src/scripts/generateNetworkConfigs.ts",
     "generate:graphql": "tsx src/scripts/generateGraphql.ts",
     "build:sdk": "tsx src/scripts/buildSdk.ts",
@@ -40,6 +41,7 @@
     "dist/index.mjs",
     "dist/index.d.ts",
     "dist/sdk/",
+    "schema.graphql",
     "README.md"
   ],
   "keywords": [

src/index.ts

@@ -4,3 +4,22 @@ export type { ApiConfig, CleanupFunction } from "./sdk";
 
 // Export GraphQL types for use in applications
 export * from "./sdk/generated/graphql";
+
+/**
+ * Recursively marks every field of a type as optional.
+ *
+ * Useful with `sdk.send()` when your query selects a subset of a type's
+ * fields: the exported query types (e.g. `FilterTokensQuery`) describe the
+ * full selection, so wrapping them in `DeepPartial` keeps the compiler honest
+ * about fields your query didn't ask for.
+ *
+ * @example
+ * const result = await sdk.send<DeepPartial<FilterTokensQuery>>(
+ *   `query { filterTokens(limit: 10) { results { priceUSD } } }`,
+ * );
+ */
+export type DeepPartial<T> = T extends (infer U)[]
+  ? DeepPartial<U>[]
+  : T extends object
+    ? { [K in keyof T]?: DeepPartial<T[K]> }
+    : T;