@settlemint/sdk-portal 2.1.5 → 2.2.0-prc00b96af
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.
- package/README.md +9 -9
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -54,7 +54,7 @@ For detailed information about using the Smart Contract Portal Middleware, check
|
|
|
54
54
|
|
|
55
55
|
> **createPortalClient**\<`Setup`\>(`options`, `clientOptions?`): `object`
|
|
56
56
|
|
|
57
|
-
Defined in: [sdk/portal/src/portal.ts:66](https://github.com/settlemint/sdk/blob/v2.
|
|
57
|
+
Defined in: [sdk/portal/src/portal.ts:66](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/portal.ts#L66)
|
|
58
58
|
|
|
59
59
|
Creates a Portal GraphQL client with the provided configuration.
|
|
60
60
|
|
|
@@ -82,8 +82,8 @@ An object containing the configured GraphQL client and graphql helper function
|
|
|
82
82
|
|
|
83
83
|
| Name | Type | Defined in |
|
|
84
84
|
| ------ | ------ | ------ |
|
|
85
|
-
| `client` | `GraphQLClient` | [sdk/portal/src/portal.ts:70](https://github.com/settlemint/sdk/blob/v2.
|
|
86
|
-
| `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/portal/src/portal.ts:71](https://github.com/settlemint/sdk/blob/v2.
|
|
85
|
+
| `client` | `GraphQLClient` | [sdk/portal/src/portal.ts:70](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/portal.ts#L70) |
|
|
86
|
+
| `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/portal/src/portal.ts:71](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/portal.ts#L71) |
|
|
87
87
|
|
|
88
88
|
##### Throws
|
|
89
89
|
|
|
@@ -130,7 +130,7 @@ const result = await client.request(query);
|
|
|
130
130
|
|
|
131
131
|
> **ClientOptions** = `object`
|
|
132
132
|
|
|
133
|
-
Defined in: [sdk/portal/src/portal.ts:24](https://github.com/settlemint/sdk/blob/v2.
|
|
133
|
+
Defined in: [sdk/portal/src/portal.ts:24](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/portal.ts#L24)
|
|
134
134
|
|
|
135
135
|
Type representing the validated client options.
|
|
136
136
|
|
|
@@ -138,9 +138,9 @@ Type representing the validated client options.
|
|
|
138
138
|
|
|
139
139
|
| Name | Type | Default value | Defined in |
|
|
140
140
|
| ------ | ------ | ------ | ------ |
|
|
141
|
-
| <a id="accesstoken"></a> `accessToken` | `string` | `ApplicationAccessTokenSchema` | [sdk/portal/src/portal.ts:17](https://github.com/settlemint/sdk/blob/v2.
|
|
142
|
-
| <a id="cache"></a> `cache?` | `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"` | - | [sdk/portal/src/portal.ts:18](https://github.com/settlemint/sdk/blob/v2.
|
|
143
|
-
| <a id="instance"></a> `instance` | `string` | `UrlOrPathSchema` | [sdk/portal/src/portal.ts:16](https://github.com/settlemint/sdk/blob/v2.
|
|
141
|
+
| <a id="accesstoken"></a> `accessToken` | `string` | `ApplicationAccessTokenSchema` | [sdk/portal/src/portal.ts:17](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/portal.ts#L17) |
|
|
142
|
+
| <a id="cache"></a> `cache?` | `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"` | - | [sdk/portal/src/portal.ts:18](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/portal.ts#L18) |
|
|
143
|
+
| <a id="instance"></a> `instance` | `string` | `UrlOrPathSchema` | [sdk/portal/src/portal.ts:16](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/portal.ts#L16) |
|
|
144
144
|
|
|
145
145
|
***
|
|
146
146
|
|
|
@@ -148,7 +148,7 @@ Type representing the validated client options.
|
|
|
148
148
|
|
|
149
149
|
> **RequestConfig** = `ConstructorParameters`\<*typeof* `GraphQLClient`\>\[`1`\]
|
|
150
150
|
|
|
151
|
-
Defined in: [sdk/portal/src/portal.ts:10](https://github.com/settlemint/sdk/blob/v2.
|
|
151
|
+
Defined in: [sdk/portal/src/portal.ts:10](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/portal.ts#L10)
|
|
152
152
|
|
|
153
153
|
Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
|
|
154
154
|
|
|
@@ -158,7 +158,7 @@ Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
|
|
|
158
158
|
|
|
159
159
|
> `const` **ClientOptionsSchema**: `ZodObject`\<[`ClientOptions`](#clientoptions)\>
|
|
160
160
|
|
|
161
|
-
Defined in: [sdk/portal/src/portal.ts:15](https://github.com/settlemint/sdk/blob/v2.
|
|
161
|
+
Defined in: [sdk/portal/src/portal.ts:15](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/portal.ts#L15)
|
|
162
162
|
|
|
163
163
|
Schema for validating Portal client configuration options.
|
|
164
164
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@settlemint/sdk-portal",
|
|
3
3
|
"description": "Portal API client module for SettleMint SDK, providing access to smart contract portal services and APIs",
|
|
4
|
-
"version": "2.
|
|
4
|
+
"version": "2.2.0-prc00b96af",
|
|
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.
|
|
55
|
+
"@settlemint/sdk-utils": "2.2.0-prc00b96af",
|
|
56
56
|
"graphql-request": "^7",
|
|
57
57
|
"zod": "^3"
|
|
58
58
|
},
|