@settlemint/sdk-thegraph 2.3.14-prfdf11875 → 2.4.0-main005a9b57

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +17 -8
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -52,7 +52,7 @@ The SDK offers a type-safe interface for all TheGraph operations, with comprehen
52
52
 
53
53
  > **createTheGraphClient**\<`Setup`\>(`options`, `clientOptions?`): `object`
54
54
 
55
- Defined in: [sdk/thegraph/src/thegraph.ts:91](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/thegraph/src/thegraph.ts#L91)
55
+ Defined in: [sdk/thegraph/src/thegraph.ts:91](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/thegraph/src/thegraph.ts#L91)
56
56
 
57
57
  Creates a TheGraph GraphQL client with proper type safety using gql.tada
58
58
 
@@ -83,8 +83,8 @@ An object containing:
83
83
 
84
84
  | Name | Type | Defined in |
85
85
  | ------ | ------ | ------ |
86
- | `client` | `GraphQLClient` | [sdk/thegraph/src/thegraph.ts:95](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/thegraph/src/thegraph.ts#L95) |
87
- | `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/thegraph/src/thegraph.ts:96](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/thegraph/src/thegraph.ts#L96) |
86
+ | `client` | `GraphQLClient` | [sdk/thegraph/src/thegraph.ts:95](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/thegraph/src/thegraph.ts#L95) |
87
+ | `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/thegraph/src/thegraph.ts:96](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/thegraph/src/thegraph.ts#L96) |
88
88
 
89
89
  ##### Throws
90
90
 
@@ -135,19 +135,28 @@ const result = await client.request(query);
135
135
 
136
136
  #### ClientOptions
137
137
 
138
- > **ClientOptions** = `z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>
138
+ > **ClientOptions** = `object`
139
139
 
140
- Defined in: [sdk/thegraph/src/thegraph.ts:26](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/thegraph/src/thegraph.ts#L26)
140
+ Defined in: [sdk/thegraph/src/thegraph.ts:26](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/thegraph/src/thegraph.ts#L26)
141
141
 
142
142
  Type definition for client options derived from the ClientOptionsSchema
143
143
 
144
+ ##### Type declaration
145
+
146
+ | Name | Type | Defined in |
147
+ | ------ | ------ | ------ |
148
+ | <a id="accesstoken"></a> `accessToken?` | `string` | [sdk/thegraph/src/thegraph.ts:18](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/thegraph/src/thegraph.ts#L18) |
149
+ | <a id="cache"></a> `cache?` | `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"` | [sdk/thegraph/src/thegraph.ts:20](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/thegraph/src/thegraph.ts#L20) |
150
+ | <a id="instances"></a> `instances` | `string`[] | [sdk/thegraph/src/thegraph.ts:17](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/thegraph/src/thegraph.ts#L17) |
151
+ | <a id="subgraphname"></a> `subgraphName` | `string` | [sdk/thegraph/src/thegraph.ts:19](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/thegraph/src/thegraph.ts#L19) |
152
+
144
153
  ***
145
154
 
146
155
  #### RequestConfig
147
156
 
148
157
  > **RequestConfig** = `ConstructorParameters`\<*typeof* `GraphQLClient`\>\[`1`\]
149
158
 
150
- Defined in: [sdk/thegraph/src/thegraph.ts:11](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/thegraph/src/thegraph.ts#L11)
159
+ Defined in: [sdk/thegraph/src/thegraph.ts:11](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/thegraph/src/thegraph.ts#L11)
151
160
 
152
161
  Type definition for GraphQL client configuration options
153
162
 
@@ -155,9 +164,9 @@ Type definition for GraphQL client configuration options
155
164
 
156
165
  #### ClientOptionsSchema
157
166
 
158
- > `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `cache`: `ZodOptional`\<`ZodEnum`\<\{ `default`: `"default"`; `force-cache`: `"force-cache"`; `no-cache`: `"no-cache"`; `no-store`: `"no-store"`; `only-if-cached`: `"only-if-cached"`; `reload`: `"reload"`; \}\>\>; `instances`: `ZodArray`\<`ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>\>; `subgraphName`: `ZodString`; \}, `$strip`\>
167
+ > `const` **ClientOptionsSchema**: `ZodObject`\<[`ClientOptions`](#clientoptions)\>
159
168
 
160
- Defined in: [sdk/thegraph/src/thegraph.ts:16](https://github.com/settlemint/sdk/blob/v2.3.14/sdk/thegraph/src/thegraph.ts#L16)
169
+ Defined in: [sdk/thegraph/src/thegraph.ts:16](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/thegraph/src/thegraph.ts#L16)
161
170
 
162
171
  Schema for validating client options for the TheGraph client.
163
172
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@settlemint/sdk-thegraph",
3
3
  "description": "TheGraph integration module for SettleMint SDK, enabling querying and indexing of blockchain data through subgraphs",
4
- "version": "2.3.14-prfdf11875",
4
+ "version": "2.4.0-main005a9b57",
5
5
  "type": "module",
6
6
  "private": false,
7
7
  "license": "FSL-1.1-MIT",
@@ -52,7 +52,7 @@
52
52
  "devDependencies": {},
53
53
  "dependencies": {
54
54
  "gql.tada": "^1",
55
- "@settlemint/sdk-utils": "2.3.14-prfdf11875",
55
+ "@settlemint/sdk-utils": "2.4.0-main005a9b57",
56
56
  "graphql-request": "^7",
57
57
  "zod": "^3.25.0"
58
58
  },