@settlemint/sdk-thegraph 2.2.0-prdfa9d68b → 2.2.1-maina13447c3

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 +12 -10
  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:90](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/thegraph/src/thegraph.ts#L90)
55
+ Defined in: [sdk/thegraph/src/thegraph.ts:90](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/thegraph/src/thegraph.ts#L90)
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:94](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/thegraph/src/thegraph.ts#L94) |
87
- | `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/thegraph/src/thegraph.ts:95](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/thegraph/src/thegraph.ts#L95) |
86
+ | `client` | `GraphQLClient` | [sdk/thegraph/src/thegraph.ts:94](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/thegraph/src/thegraph.ts#L94) |
87
+ | `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/thegraph/src/thegraph.ts:95](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/thegraph/src/thegraph.ts#L95) |
88
88
 
89
89
  ##### Throws
90
90
 
@@ -92,6 +92,7 @@ Will throw an error if the options fail validation against ClientOptionsSchema
92
92
 
93
93
  ##### Example
94
94
 
95
+ ```ts
95
96
  import { createTheGraphClient } from '@settlemint/sdk-thegraph';
96
97
  import type { introspection } from '@schemas/the-graph-env-kits';
97
98
  import { createLogger, requestLogger } from '@settlemint/sdk-utils/logging';
@@ -128,6 +129,7 @@ const query = graphql(`
128
129
  `);
129
130
 
130
131
  const result = await client.request(query);
132
+ ```
131
133
 
132
134
  ### Type Aliases
133
135
 
@@ -135,7 +137,7 @@ const result = await client.request(query);
135
137
 
136
138
  > **ClientOptions** = `object`
137
139
 
138
- Defined in: [sdk/thegraph/src/thegraph.ts:25](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/thegraph/src/thegraph.ts#L25)
140
+ Defined in: [sdk/thegraph/src/thegraph.ts:25](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/thegraph/src/thegraph.ts#L25)
139
141
 
140
142
  Type definition for client options derived from the ClientOptionsSchema
141
143
 
@@ -143,10 +145,10 @@ Type definition for client options derived from the ClientOptionsSchema
143
145
 
144
146
  | Name | Type | Default value | Defined in |
145
147
  | ------ | ------ | ------ | ------ |
146
- | <a id="accesstoken"></a> `accessToken` | `string` | `ApplicationAccessTokenSchema` | [sdk/thegraph/src/thegraph.ts:17](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/thegraph/src/thegraph.ts#L17) |
147
- | <a id="cache"></a> `cache?` | `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"` | - | [sdk/thegraph/src/thegraph.ts:19](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/thegraph/src/thegraph.ts#L19) |
148
- | <a id="instances"></a> `instances` | `string`[] | - | [sdk/thegraph/src/thegraph.ts:16](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/thegraph/src/thegraph.ts#L16) |
149
- | <a id="subgraphname"></a> `subgraphName` | `string` | - | [sdk/thegraph/src/thegraph.ts:18](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/thegraph/src/thegraph.ts#L18) |
148
+ | <a id="accesstoken"></a> `accessToken` | `string` | `ApplicationAccessTokenSchema` | [sdk/thegraph/src/thegraph.ts:17](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/thegraph/src/thegraph.ts#L17) |
149
+ | <a id="cache"></a> `cache?` | `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"` | - | [sdk/thegraph/src/thegraph.ts:19](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/thegraph/src/thegraph.ts#L19) |
150
+ | <a id="instances"></a> `instances` | `string`[] | - | [sdk/thegraph/src/thegraph.ts:16](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/thegraph/src/thegraph.ts#L16) |
151
+ | <a id="subgraphname"></a> `subgraphName` | `string` | - | [sdk/thegraph/src/thegraph.ts:18](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/thegraph/src/thegraph.ts#L18) |
150
152
 
151
153
  ***
152
154
 
@@ -154,7 +156,7 @@ Type definition for client options derived from the ClientOptionsSchema
154
156
 
155
157
  > **RequestConfig** = `ConstructorParameters`\<*typeof* `GraphQLClient`\>\[`1`\]
156
158
 
157
- Defined in: [sdk/thegraph/src/thegraph.ts:10](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/thegraph/src/thegraph.ts#L10)
159
+ Defined in: [sdk/thegraph/src/thegraph.ts:10](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/thegraph/src/thegraph.ts#L10)
158
160
 
159
161
  Type definition for GraphQL client configuration options
160
162
 
@@ -164,7 +166,7 @@ Type definition for GraphQL client configuration options
164
166
 
165
167
  > `const` **ClientOptionsSchema**: `ZodObject`\<[`ClientOptions`](#clientoptions)\>
166
168
 
167
- Defined in: [sdk/thegraph/src/thegraph.ts:15](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/thegraph/src/thegraph.ts#L15)
169
+ Defined in: [sdk/thegraph/src/thegraph.ts:15](https://github.com/settlemint/sdk/blob/v2.2.1/sdk/thegraph/src/thegraph.ts#L15)
168
170
 
169
171
  Schema for validating client options for the TheGraph client.
170
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.2.0-prdfa9d68b",
4
+ "version": "2.2.1-maina13447c3",
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.2.0-prdfa9d68b",
55
+ "@settlemint/sdk-utils": "2.2.1-maina13447c3",
56
56
  "graphql-request": "^7",
57
57
  "zod": "^3"
58
58
  },