@settlemint/sdk-js 2.1.4-prcae01a18 → 2.1.4-prcd260cdb
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 +29 -18
- package/dist/settlemint.cjs +1 -0
- package/dist/settlemint.cjs.map +1 -1
- package/dist/settlemint.d.cts +4 -4
- package/dist/settlemint.d.ts +4 -4
- package/dist/settlemint.mjs +1 -0
- package/dist/settlemint.mjs.map +1 -1
- 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: [sdk/js/src/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: [sdk/js/src/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: [sdk/js/src/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
|
|
|
@@ -128,9 +129,9 @@ Options for the Settlemint client.
|
|
|
128
129
|
|
|
129
130
|
| Property | Type | Default value | Description | Inherited from | Defined in |
|
|
130
131
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
131
|
-
| <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="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) |
|
|
132
|
+
| <a id="accesstoken"></a> `accessToken` | `string` | `AccessTokenSchema` | The access token used to authenticate with the SettleMint platform | `ClientOptions.accessToken` | [sdk/js/src/helpers/client-options.schema.ts:9](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/helpers/client-options.schema.ts#L9) |
|
|
133
|
+
| <a id="anonymous"></a> `anonymous?` | `boolean` | `undefined` | Whether to allow anonymous access (no access token required) | - | [sdk/js/src/settlemint.ts:119](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/settlemint.ts#L119) |
|
|
134
|
+
| <a id="instance"></a> `instance` | `string` | `UrlSchema` | The URL of the SettleMint instance to connect to | `ClientOptions.instance` | [sdk/js/src/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
|
|
136
137
|
|
|
@@ -138,7 +139,7 @@ Options for the Settlemint client.
|
|
|
138
139
|
|
|
139
140
|
> **Application** = `ResultOf`\<*typeof* `ApplicationFragment`\>
|
|
140
141
|
|
|
141
|
-
Defined in: [graphql/application.ts:24](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/application.ts#L24)
|
|
142
|
+
Defined in: [sdk/js/src/graphql/application.ts:24](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/application.ts#L24)
|
|
142
143
|
|
|
143
144
|
Type representing an application entity.
|
|
144
145
|
|
|
@@ -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: [sdk/js/src/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: [sdk/js/src/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
|
|
|
@@ -168,7 +169,7 @@ Type representing a blockchain node entity.
|
|
|
168
169
|
|
|
169
170
|
> **CustomDeployment** = `ResultOf`\<*typeof* `CustomDeploymentFragment`\>
|
|
170
171
|
|
|
171
|
-
Defined in: [graphql/custom-deployment.ts:33](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/custom-deployment.ts#L33)
|
|
172
|
+
Defined in: [sdk/js/src/graphql/custom-deployment.ts:33](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/custom-deployment.ts#L33)
|
|
172
173
|
|
|
173
174
|
Type representing a custom deployment entity.
|
|
174
175
|
|
|
@@ -178,7 +179,7 @@ Type representing a custom deployment entity.
|
|
|
178
179
|
|
|
179
180
|
> **Insights** = `ResultOf`\<*typeof* `InsightsFragment`\>
|
|
180
181
|
|
|
181
|
-
Defined in: [graphql/insights.ts:37](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/insights.ts#L37)
|
|
182
|
+
Defined in: [sdk/js/src/graphql/insights.ts:37](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/insights.ts#L37)
|
|
182
183
|
|
|
183
184
|
Type representing an insights entity.
|
|
184
185
|
|
|
@@ -188,17 +189,27 @@ Type representing an insights entity.
|
|
|
188
189
|
|
|
189
190
|
> **IntegrationTool** = `ResultOf`\<*typeof* `IntegrationFragment`\>
|
|
190
191
|
|
|
191
|
-
Defined in: [graphql/integration-tool.ts:35](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/integration-tool.ts#L35)
|
|
192
|
+
Defined in: [sdk/js/src/graphql/integration-tool.ts:35](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/integration-tool.ts#L35)
|
|
192
193
|
|
|
193
194
|
Type representing an integration tool entity.
|
|
194
195
|
|
|
195
196
|
***
|
|
196
197
|
|
|
198
|
+
#### LoadBalancer
|
|
199
|
+
|
|
200
|
+
> **LoadBalancer** = `ResultOf`\<*typeof* `LoadBalancerFragment`\>
|
|
201
|
+
|
|
202
|
+
Defined in: [sdk/js/src/graphql/load-balancer.ts:31](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/load-balancer.ts#L31)
|
|
203
|
+
|
|
204
|
+
Type representing a load balancer entity.
|
|
205
|
+
|
|
206
|
+
***
|
|
207
|
+
|
|
197
208
|
#### Middleware
|
|
198
209
|
|
|
199
210
|
> **Middleware** = `ResultOf`\<*typeof* `MiddlewareFragment`\>
|
|
200
211
|
|
|
201
|
-
Defined in: [graphql/middleware.ts:43](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/middleware.ts#L43)
|
|
212
|
+
Defined in: [sdk/js/src/graphql/middleware.ts:43](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/middleware.ts#L43)
|
|
202
213
|
|
|
203
214
|
Type representing a middleware entity.
|
|
204
215
|
|
|
@@ -208,7 +219,7 @@ Type representing a middleware entity.
|
|
|
208
219
|
|
|
209
220
|
> **MiddlewareWithSubgraphs** = `ResultOf`\<*typeof* `getGraphMiddlewareSubgraphs`\>\[`"middlewareByUniqueName"`\]
|
|
210
221
|
|
|
211
|
-
Defined in: [graphql/middleware.ts:101](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/middleware.ts#L101)
|
|
222
|
+
Defined in: [sdk/js/src/graphql/middleware.ts:101](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/middleware.ts#L101)
|
|
212
223
|
|
|
213
224
|
Type representing a middleware entity with subgraphs.
|
|
214
225
|
|
|
@@ -218,7 +229,7 @@ Type representing a middleware entity with subgraphs.
|
|
|
218
229
|
|
|
219
230
|
> **PlatformConfig** = `ResultOf`\<*typeof* `getPlatformConfigQuery`\>\[`"config"`\]
|
|
220
231
|
|
|
221
|
-
Defined in: [graphql/platform.ts:51](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/platform.ts#L51)
|
|
232
|
+
Defined in: [sdk/js/src/graphql/platform.ts:51](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/platform.ts#L51)
|
|
222
233
|
|
|
223
234
|
Type representing the platform configuration.
|
|
224
235
|
|
|
@@ -228,7 +239,7 @@ Type representing the platform configuration.
|
|
|
228
239
|
|
|
229
240
|
> **PrivateKey** = `ResultOf`\<*typeof* `PrivateKeyFragment`\>
|
|
230
241
|
|
|
231
|
-
Defined in: [graphql/private-key.ts:27](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/private-key.ts#L27)
|
|
242
|
+
Defined in: [sdk/js/src/graphql/private-key.ts:27](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/private-key.ts#L27)
|
|
232
243
|
|
|
233
244
|
Type representing a private key entity.
|
|
234
245
|
|
|
@@ -238,7 +249,7 @@ Type representing a private key entity.
|
|
|
238
249
|
|
|
239
250
|
> **Storage** = `ResultOf`\<*typeof* `StorageFragment`\>
|
|
240
251
|
|
|
241
|
-
Defined in: [graphql/storage.ts:35](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/storage.ts#L35)
|
|
252
|
+
Defined in: [sdk/js/src/graphql/storage.ts:35](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/storage.ts#L35)
|
|
242
253
|
|
|
243
254
|
Type representing a storage entity.
|
|
244
255
|
|
|
@@ -248,7 +259,7 @@ Type representing a storage entity.
|
|
|
248
259
|
|
|
249
260
|
> **Workspace** = `ResultOf`\<*typeof* `WorkspaceFragment`\>
|
|
250
261
|
|
|
251
|
-
Defined in: [graphql/workspace.ts:26](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/workspace.ts#L26)
|
|
262
|
+
Defined in: [sdk/js/src/graphql/workspace.ts:26](https://github.com/settlemint/sdk/blob/v2.1.4/sdk/js/src/graphql/workspace.ts#L26)
|
|
252
263
|
|
|
253
264
|
Type representing a workspace entity.
|
|
254
265
|
|