@settlemint/sdk-thegraph 2.2.0 → 2.2.1

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 +10 -12
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -44,8 +44,6 @@ The SettleMint TheGraph SDK provides a seamless way to interact with TheGraph AP
44
44
 
45
45
  The SDK offers a type-safe interface for all TheGraph operations, with comprehensive error handling and validation. It integrates smoothly with modern TypeScript applications while providing a simple and intuitive developer experience.
46
46
 
47
- For detailed information about using TheGraph with the SettleMint platform, check out our [official documentation](https://console.settlemint.com/documentation).
48
-
49
47
  ## API Reference
50
48
 
51
49
  ### Functions
@@ -54,7 +52,7 @@ For detailed information about using TheGraph with the SettleMint platform, chec
54
52
 
55
53
  > **createTheGraphClient**\<`Setup`\>(`options`, `clientOptions?`): `object`
56
54
 
57
- 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)
58
56
 
59
57
  Creates a TheGraph GraphQL client with proper type safety using gql.tada
60
58
 
@@ -85,8 +83,8 @@ An object containing:
85
83
 
86
84
  | Name | Type | Defined in |
87
85
  | ------ | ------ | ------ |
88
- | `client` | `GraphQLClient` | [sdk/thegraph/src/thegraph.ts:94](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/thegraph/src/thegraph.ts#L94) |
89
- | `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) |
90
88
 
91
89
  ##### Throws
92
90
 
@@ -139,7 +137,7 @@ const result = await client.request(query);
139
137
 
140
138
  > **ClientOptions** = `object`
141
139
 
142
- 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)
143
141
 
144
142
  Type definition for client options derived from the ClientOptionsSchema
145
143
 
@@ -147,10 +145,10 @@ Type definition for client options derived from the ClientOptionsSchema
147
145
 
148
146
  | Name | Type | Default value | Defined in |
149
147
  | ------ | ------ | ------ | ------ |
150
- | <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) |
151
- | <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) |
152
- | <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) |
153
- | <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) |
154
152
 
155
153
  ***
156
154
 
@@ -158,7 +156,7 @@ Type definition for client options derived from the ClientOptionsSchema
158
156
 
159
157
  > **RequestConfig** = `ConstructorParameters`\<*typeof* `GraphQLClient`\>\[`1`\]
160
158
 
161
- 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)
162
160
 
163
161
  Type definition for GraphQL client configuration options
164
162
 
@@ -168,7 +166,7 @@ Type definition for GraphQL client configuration options
168
166
 
169
167
  > `const` **ClientOptionsSchema**: `ZodObject`\<[`ClientOptions`](#clientoptions)\>
170
168
 
171
- 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)
172
170
 
173
171
  Schema for validating client options for the TheGraph client.
174
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",
4
+ "version": "2.2.1",
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",
55
+ "@settlemint/sdk-utils": "2.2.1",
56
56
  "graphql-request": "^7",
57
57
  "zod": "^3"
58
58
  },