@settlemint/sdk-thegraph 2.1.0 → 2.1.1-main25da2665

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
@@ -54,7 +54,7 @@ For detailed information about using TheGraph with the SettleMint platform, chec
54
54
 
55
55
  > **createTheGraphClient**\<`Setup`\>(`options`, `clientOptions?`): `object`
56
56
 
57
- Defined in: [sdk/thegraph/src/thegraph.ts:90](https://github.com/settlemint/sdk/blob/v2.1.0/sdk/thegraph/src/thegraph.ts#L90)
57
+ Defined in: [sdk/thegraph/src/thegraph.ts:90](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/thegraph/src/thegraph.ts#L90)
58
58
 
59
59
  Creates a TheGraph GraphQL client with proper type safety using gql.tada
60
60
 
@@ -85,8 +85,8 @@ An object containing:
85
85
 
86
86
  | Name | Type | Defined in |
87
87
  | ------ | ------ | ------ |
88
- | `client` | `GraphQLClient` | [sdk/thegraph/src/thegraph.ts:94](https://github.com/settlemint/sdk/blob/v2.1.0/sdk/thegraph/src/thegraph.ts#L94) |
89
- | `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/thegraph/src/thegraph.ts:95](https://github.com/settlemint/sdk/blob/v2.1.0/sdk/thegraph/src/thegraph.ts#L95) |
88
+ | `client` | `GraphQLClient` | [sdk/thegraph/src/thegraph.ts:94](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/thegraph/src/thegraph.ts#L94) |
89
+ | `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/thegraph/src/thegraph.ts:95](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/thegraph/src/thegraph.ts#L95) |
90
90
 
91
91
  ##### Throws
92
92
 
@@ -137,19 +137,28 @@ const result = await client.request(query);
137
137
 
138
138
  #### ClientOptions
139
139
 
140
- > **ClientOptions** = `z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>
140
+ > **ClientOptions** = `object`
141
141
 
142
- Defined in: [sdk/thegraph/src/thegraph.ts:25](https://github.com/settlemint/sdk/blob/v2.1.0/sdk/thegraph/src/thegraph.ts#L25)
142
+ Defined in: [sdk/thegraph/src/thegraph.ts:25](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/thegraph/src/thegraph.ts#L25)
143
143
 
144
144
  Type definition for client options derived from the ClientOptionsSchema
145
145
 
146
+ ##### Type declaration
147
+
148
+ | Name | Type | Default value | Defined in |
149
+ | ------ | ------ | ------ | ------ |
150
+ | <a id="accesstoken"></a> `accessToken` | `string` | `ApplicationAccessTokenSchema` | [sdk/thegraph/src/thegraph.ts:17](https://github.com/settlemint/sdk/blob/v2.1.1/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.1.1/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.1.1/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.1.1/sdk/thegraph/src/thegraph.ts#L18) |
154
+
146
155
  ***
147
156
 
148
157
  #### RequestConfig
149
158
 
150
159
  > **RequestConfig** = `ConstructorParameters`\<*typeof* `GraphQLClient`\>\[`1`\]
151
160
 
152
- Defined in: [sdk/thegraph/src/thegraph.ts:10](https://github.com/settlemint/sdk/blob/v2.1.0/sdk/thegraph/src/thegraph.ts#L10)
161
+ Defined in: [sdk/thegraph/src/thegraph.ts:10](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/thegraph/src/thegraph.ts#L10)
153
162
 
154
163
  Type definition for GraphQL client configuration options
155
164
 
@@ -157,9 +166,9 @@ Type definition for GraphQL client configuration options
157
166
 
158
167
  #### ClientOptionsSchema
159
168
 
160
- > `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodString`; `cache`: `ZodOptional`\<`ZodEnum`\<\[`"default"`, `"force-cache"`, `"no-cache"`, `"no-store"`, `"only-if-cached"`, `"reload"`\]\>\>; `instances`: `ZodArray`\<`ZodUnion`\<\[`ZodString`, `ZodString`\]\>, `"many"`\>; `subgraphName`: `ZodString`; \}, `"strip"`, `ZodTypeAny`, \{ `accessToken`: `string`; `cache`: `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"`; `instances`: `string`[]; `subgraphName`: `string`; \}, \{ `accessToken`: `string`; `cache`: `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"`; `instances`: `string`[]; `subgraphName`: `string`; \}\>
169
+ > `const` **ClientOptionsSchema**: `ZodObject`\<[`ClientOptions`](#clientoptions)\>
161
170
 
162
- Defined in: [sdk/thegraph/src/thegraph.ts:15](https://github.com/settlemint/sdk/blob/v2.1.0/sdk/thegraph/src/thegraph.ts#L15)
171
+ Defined in: [sdk/thegraph/src/thegraph.ts:15](https://github.com/settlemint/sdk/blob/v2.1.1/sdk/thegraph/src/thegraph.ts#L15)
163
172
 
164
173
  Schema for validating client options for the TheGraph client.
165
174
 
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.1.0",
4
+ "version": "2.1.1-main25da2665",
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.1.0",
55
+ "@settlemint/sdk-utils": "2.1.1-main25da2665",
56
56
  "graphql-request": "^7",
57
57
  "zod": "^3"
58
58
  },