@settlemint/sdk-js 2.1.4-prcae01a18 → 2.1.4-prcda675ba
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 +17 -6
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -40,6 +40,7 @@
|
|
|
40
40
|
- [CustomDeployment](#customdeployment)
|
|
41
41
|
- [Insights](#insights)
|
|
42
42
|
- [IntegrationTool](#integrationtool)
|
|
43
|
+
- [LoadBalancer](#loadbalancer)
|
|
43
44
|
- [Middleware](#middleware)
|
|
44
45
|
- [MiddlewareWithSubgraphs](#middlewarewithsubgraphs)
|
|
45
46
|
- [PlatformConfig](#platformconfig)
|
|
@@ -61,7 +62,7 @@ The SettleMint JavaScript SDK provides a type-safe wrapper around the SettleMint
|
|
|
61
62
|
|
|
62
63
|
> **createSettleMintClient**(`options`): [`SettlemintClient`](#settlemintclient)
|
|
63
64
|
|
|
64
|
-
Defined in: [settlemint.ts:
|
|
65
|
+
Defined in: [settlemint.ts:237](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/settlemint.ts#L237)
|
|
65
66
|
|
|
66
67
|
Creates a SettleMint client with the provided options. The client provides methods to interact with
|
|
67
68
|
various SettleMint resources like workspaces, applications, blockchain networks, blockchain nodes, middleware,
|
|
@@ -108,7 +109,7 @@ const workspace = await client.workspace.read('workspace-unique-name');
|
|
|
108
109
|
|
|
109
110
|
#### SettlemintClient
|
|
110
111
|
|
|
111
|
-
Defined in: [settlemint.ts:
|
|
112
|
+
Defined in: [settlemint.ts:125](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/settlemint.ts#L125)
|
|
112
113
|
|
|
113
114
|
Client interface for interacting with the SettleMint platform.
|
|
114
115
|
|
|
@@ -116,7 +117,7 @@ Client interface for interacting with the SettleMint platform.
|
|
|
116
117
|
|
|
117
118
|
#### SettlemintClientOptions
|
|
118
119
|
|
|
119
|
-
Defined in: [settlemint.ts:
|
|
120
|
+
Defined in: [settlemint.ts:117](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/settlemint.ts#L117)
|
|
120
121
|
|
|
121
122
|
Options for the Settlemint client.
|
|
122
123
|
|
|
@@ -129,7 +130,7 @@ Options for the Settlemint client.
|
|
|
129
130
|
| Property | Type | Default value | Description | Inherited from | Defined in |
|
|
130
131
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
131
132
|
| <a id="accesstoken"></a> `accessToken` | `string` | `AccessTokenSchema` | The access token used to authenticate with the SettleMint platform | `ClientOptions.accessToken` | [helpers/client-options.schema.ts:9](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/helpers/client-options.schema.ts#L9) |
|
|
132
|
-
| <a id="anonymous"></a> `anonymous?` | `boolean` | `undefined` | Whether to allow anonymous access (no access token required) | - | [settlemint.ts:
|
|
133
|
+
| <a id="anonymous"></a> `anonymous?` | `boolean` | `undefined` | Whether to allow anonymous access (no access token required) | - | [settlemint.ts:119](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/settlemint.ts#L119) |
|
|
133
134
|
| <a id="instance"></a> `instance` | `string` | `UrlSchema` | The URL of the SettleMint instance to connect to | `ClientOptions.instance` | [helpers/client-options.schema.ts:11](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/helpers/client-options.schema.ts#L11) |
|
|
134
135
|
|
|
135
136
|
### Type Aliases
|
|
@@ -148,7 +149,7 @@ Type representing an application entity.
|
|
|
148
149
|
|
|
149
150
|
> **BlockchainNetwork** = `ResultOf`\<*typeof* `BlockchainNetworkFragment`\>
|
|
150
151
|
|
|
151
|
-
Defined in: [graphql/blockchain-network.ts:
|
|
152
|
+
Defined in: [graphql/blockchain-network.ts:82](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/blockchain-network.ts#L82)
|
|
152
153
|
|
|
153
154
|
Type representing a blockchain network entity.
|
|
154
155
|
|
|
@@ -158,7 +159,7 @@ Type representing a blockchain network entity.
|
|
|
158
159
|
|
|
159
160
|
> **BlockchainNode** = `ResultOf`\<*typeof* `BlockchainNodeFragment`\>
|
|
160
161
|
|
|
161
|
-
Defined in: [graphql/blockchain-node.ts:
|
|
162
|
+
Defined in: [graphql/blockchain-node.ts:96](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/blockchain-node.ts#L96)
|
|
162
163
|
|
|
163
164
|
Type representing a blockchain node entity.
|
|
164
165
|
|
|
@@ -194,6 +195,16 @@ Type representing an integration tool entity.
|
|
|
194
195
|
|
|
195
196
|
***
|
|
196
197
|
|
|
198
|
+
#### LoadBalancer
|
|
199
|
+
|
|
200
|
+
> **LoadBalancer** = `ResultOf`\<*typeof* `LoadBalancerFragment`\>
|
|
201
|
+
|
|
202
|
+
Defined in: [graphql/load-balancer.ts:30](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/load-balancer.ts#L30)
|
|
203
|
+
|
|
204
|
+
Type representing a load balancer entity.
|
|
205
|
+
|
|
206
|
+
***
|
|
207
|
+
|
|
197
208
|
#### Middleware
|
|
198
209
|
|
|
199
210
|
> **Middleware** = `ResultOf`\<*typeof* `MiddlewareFragment`\>
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@settlemint/sdk-js",
|
|
3
3
|
"description": "Core JavaScript SDK for integrating SettleMint's blockchain platform services into your applications",
|
|
4
|
-
"version": "2.1.4-
|
|
4
|
+
"version": "2.1.4-prcda675ba",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"private": false,
|
|
7
7
|
"license": "FSL-1.1-MIT",
|
|
@@ -55,7 +55,7 @@
|
|
|
55
55
|
"gql.tada": "^1",
|
|
56
56
|
"graphql-request": "^7",
|
|
57
57
|
"zod": "^3",
|
|
58
|
-
"@settlemint/sdk-utils": "2.1.4-
|
|
58
|
+
"@settlemint/sdk-utils": "2.1.4-prcda675ba"
|
|
59
59
|
},
|
|
60
60
|
"peerDependencies": {},
|
|
61
61
|
"engines": {
|