@settlemint/sdk-js 1.2.2 → 1.2.3-maind06b7984
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 +33 -33
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -59,9 +59,9 @@ The SettleMint JavaScript SDK provides a type-safe wrapper around the SettleMint
|
|
|
59
59
|
|
|
60
60
|
#### createSettleMintClient()
|
|
61
61
|
|
|
62
|
-
> **createSettleMintClient**(`options`): [`SettlemintClient`](
|
|
62
|
+
> **createSettleMintClient**(`options`): [`SettlemintClient`](#settlemintclient)
|
|
63
63
|
|
|
64
|
-
Defined in: [settlemint.ts:216](https://github.com/settlemint/sdk/blob/v1.2.
|
|
64
|
+
Defined in: [settlemint.ts:216](https://github.com/settlemint/sdk/blob/v1.2.3/sdk/js/src/settlemint.ts#L216)
|
|
65
65
|
|
|
66
66
|
Creates a SettleMint client with the provided options. The client provides methods to interact with
|
|
67
67
|
various SettleMint resources like workspaces, applications, blockchain networks, blockchain nodes, middleware,
|
|
@@ -71,11 +71,11 @@ integration tools, storage, private keys, insights and custom deployments.
|
|
|
71
71
|
|
|
72
72
|
| Parameter | Type | Description |
|
|
73
73
|
| ------ | ------ | ------ |
|
|
74
|
-
| `options` | [`SettlemintClientOptions`](
|
|
74
|
+
| `options` | [`SettlemintClientOptions`](#settlemintclientoptions) | Configuration options for the client including access token and instance URL |
|
|
75
75
|
|
|
76
76
|
##### Returns
|
|
77
77
|
|
|
78
|
-
[`SettlemintClient`](
|
|
78
|
+
[`SettlemintClient`](#settlemintclient)
|
|
79
79
|
|
|
80
80
|
A SettleMint client object with resource-specific methods
|
|
81
81
|
|
|
@@ -108,7 +108,7 @@ const workspace = await client.workspace.read('workspace-unique-name');
|
|
|
108
108
|
|
|
109
109
|
#### SettlemintClient
|
|
110
110
|
|
|
111
|
-
Defined in: [settlemint.ts:111](https://github.com/settlemint/sdk/blob/v1.2.
|
|
111
|
+
Defined in: [settlemint.ts:111](https://github.com/settlemint/sdk/blob/v1.2.3/sdk/js/src/settlemint.ts#L111)
|
|
112
112
|
|
|
113
113
|
Client interface for interacting with the SettleMint platform.
|
|
114
114
|
|
|
@@ -116,7 +116,7 @@ Client interface for interacting with the SettleMint platform.
|
|
|
116
116
|
|
|
117
117
|
#### SettlemintClientOptions
|
|
118
118
|
|
|
119
|
-
Defined in: [settlemint.ts:103](https://github.com/settlemint/sdk/blob/v1.2.
|
|
119
|
+
Defined in: [settlemint.ts:103](https://github.com/settlemint/sdk/blob/v1.2.3/sdk/js/src/settlemint.ts#L103)
|
|
120
120
|
|
|
121
121
|
Options for the Settlemint client.
|
|
122
122
|
|
|
@@ -128,17 +128,17 @@ Options for the Settlemint client.
|
|
|
128
128
|
|
|
129
129
|
| Property | Type | Default value | Description | Inherited from | Defined in |
|
|
130
130
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
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/v1.2.
|
|
132
|
-
| <a id="anonymous"></a> `anonymous?` | `boolean` | `undefined` | Whether to allow anonymous access (no access token required) | - | [settlemint.ts:105](https://github.com/settlemint/sdk/blob/v1.2.
|
|
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/v1.2.
|
|
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/v1.2.3/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:105](https://github.com/settlemint/sdk/blob/v1.2.3/sdk/js/src/settlemint.ts#L105) |
|
|
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/v1.2.3/sdk/js/src/helpers/client-options.schema.ts#L11) |
|
|
134
134
|
|
|
135
135
|
### Type Aliases
|
|
136
136
|
|
|
137
137
|
#### Application
|
|
138
138
|
|
|
139
|
-
> **Application
|
|
139
|
+
> **Application** = `ResultOf`\<*typeof* `ApplicationFragment`\>
|
|
140
140
|
|
|
141
|
-
Defined in: [graphql/application.ts:24](https://github.com/settlemint/sdk/blob/v1.2.
|
|
141
|
+
Defined in: [graphql/application.ts:24](https://github.com/settlemint/sdk/blob/v1.2.3/sdk/js/src/graphql/application.ts#L24)
|
|
142
142
|
|
|
143
143
|
Type representing an application entity.
|
|
144
144
|
|
|
@@ -146,9 +146,9 @@ Type representing an application entity.
|
|
|
146
146
|
|
|
147
147
|
#### BlockchainNetwork
|
|
148
148
|
|
|
149
|
-
> **BlockchainNetwork
|
|
149
|
+
> **BlockchainNetwork** = `ResultOf`\<*typeof* `BlockchainNetworkFragment`\>
|
|
150
150
|
|
|
151
|
-
Defined in: [graphql/blockchain-network.ts:32](https://github.com/settlemint/sdk/blob/v1.2.
|
|
151
|
+
Defined in: [graphql/blockchain-network.ts:32](https://github.com/settlemint/sdk/blob/v1.2.3/sdk/js/src/graphql/blockchain-network.ts#L32)
|
|
152
152
|
|
|
153
153
|
Type representing a blockchain network entity.
|
|
154
154
|
|
|
@@ -156,9 +156,9 @@ Type representing a blockchain network entity.
|
|
|
156
156
|
|
|
157
157
|
#### BlockchainNode
|
|
158
158
|
|
|
159
|
-
> **BlockchainNode
|
|
159
|
+
> **BlockchainNode** = `ResultOf`\<*typeof* `BlockchainNodeFragment`\>
|
|
160
160
|
|
|
161
|
-
Defined in: [graphql/blockchain-node.ts:51](https://github.com/settlemint/sdk/blob/v1.2.
|
|
161
|
+
Defined in: [graphql/blockchain-node.ts:51](https://github.com/settlemint/sdk/blob/v1.2.3/sdk/js/src/graphql/blockchain-node.ts#L51)
|
|
162
162
|
|
|
163
163
|
Type representing a blockchain node entity.
|
|
164
164
|
|
|
@@ -166,9 +166,9 @@ Type representing a blockchain node entity.
|
|
|
166
166
|
|
|
167
167
|
#### CustomDeployment
|
|
168
168
|
|
|
169
|
-
> **CustomDeployment
|
|
169
|
+
> **CustomDeployment** = `ResultOf`\<*typeof* `CustomDeploymentFragment`\>
|
|
170
170
|
|
|
171
|
-
Defined in: [graphql/custom-deployment.ts:33](https://github.com/settlemint/sdk/blob/v1.2.
|
|
171
|
+
Defined in: [graphql/custom-deployment.ts:33](https://github.com/settlemint/sdk/blob/v1.2.3/sdk/js/src/graphql/custom-deployment.ts#L33)
|
|
172
172
|
|
|
173
173
|
Type representing a custom deployment entity.
|
|
174
174
|
|
|
@@ -176,9 +176,9 @@ Type representing a custom deployment entity.
|
|
|
176
176
|
|
|
177
177
|
#### Insights
|
|
178
178
|
|
|
179
|
-
> **Insights
|
|
179
|
+
> **Insights** = `ResultOf`\<*typeof* `InsightsFragment`\>
|
|
180
180
|
|
|
181
|
-
Defined in: [graphql/insights.ts:37](https://github.com/settlemint/sdk/blob/v1.2.
|
|
181
|
+
Defined in: [graphql/insights.ts:37](https://github.com/settlemint/sdk/blob/v1.2.3/sdk/js/src/graphql/insights.ts#L37)
|
|
182
182
|
|
|
183
183
|
Type representing an insights entity.
|
|
184
184
|
|
|
@@ -186,9 +186,9 @@ Type representing an insights entity.
|
|
|
186
186
|
|
|
187
187
|
#### IntegrationTool
|
|
188
188
|
|
|
189
|
-
> **IntegrationTool
|
|
189
|
+
> **IntegrationTool** = `ResultOf`\<*typeof* `IntegrationFragment`\>
|
|
190
190
|
|
|
191
|
-
Defined in: [graphql/integration-tool.ts:35](https://github.com/settlemint/sdk/blob/v1.2.
|
|
191
|
+
Defined in: [graphql/integration-tool.ts:35](https://github.com/settlemint/sdk/blob/v1.2.3/sdk/js/src/graphql/integration-tool.ts#L35)
|
|
192
192
|
|
|
193
193
|
Type representing an integration tool entity.
|
|
194
194
|
|
|
@@ -196,9 +196,9 @@ Type representing an integration tool entity.
|
|
|
196
196
|
|
|
197
197
|
#### Middleware
|
|
198
198
|
|
|
199
|
-
> **Middleware
|
|
199
|
+
> **Middleware** = `ResultOf`\<*typeof* `MiddlewareFragment`\>
|
|
200
200
|
|
|
201
|
-
Defined in: [graphql/middleware.ts:43](https://github.com/settlemint/sdk/blob/v1.2.
|
|
201
|
+
Defined in: [graphql/middleware.ts:43](https://github.com/settlemint/sdk/blob/v1.2.3/sdk/js/src/graphql/middleware.ts#L43)
|
|
202
202
|
|
|
203
203
|
Type representing a middleware entity.
|
|
204
204
|
|
|
@@ -206,9 +206,9 @@ Type representing a middleware entity.
|
|
|
206
206
|
|
|
207
207
|
#### MiddlewareWithSubgraphs
|
|
208
208
|
|
|
209
|
-
> **MiddlewareWithSubgraphs
|
|
209
|
+
> **MiddlewareWithSubgraphs** = `ResultOf`\<*typeof* `getGraphMiddlewareSubgraphs`\>\[`"middlewareByUniqueName"`\]
|
|
210
210
|
|
|
211
|
-
Defined in: [graphql/middleware.ts:101](https://github.com/settlemint/sdk/blob/v1.2.
|
|
211
|
+
Defined in: [graphql/middleware.ts:101](https://github.com/settlemint/sdk/blob/v1.2.3/sdk/js/src/graphql/middleware.ts#L101)
|
|
212
212
|
|
|
213
213
|
Type representing a middleware entity with subgraphs.
|
|
214
214
|
|
|
@@ -216,9 +216,9 @@ Type representing a middleware entity with subgraphs.
|
|
|
216
216
|
|
|
217
217
|
#### PlatformConfig
|
|
218
218
|
|
|
219
|
-
> **PlatformConfig
|
|
219
|
+
> **PlatformConfig** = `ResultOf`\<*typeof* `getPlatformConfigQuery`\>\[`"config"`\]
|
|
220
220
|
|
|
221
|
-
Defined in: [graphql/platform.ts:51](https://github.com/settlemint/sdk/blob/v1.2.
|
|
221
|
+
Defined in: [graphql/platform.ts:51](https://github.com/settlemint/sdk/blob/v1.2.3/sdk/js/src/graphql/platform.ts#L51)
|
|
222
222
|
|
|
223
223
|
Type representing the platform configuration.
|
|
224
224
|
|
|
@@ -226,9 +226,9 @@ Type representing the platform configuration.
|
|
|
226
226
|
|
|
227
227
|
#### PrivateKey
|
|
228
228
|
|
|
229
|
-
> **PrivateKey
|
|
229
|
+
> **PrivateKey** = `ResultOf`\<*typeof* `PrivateKeyFragment`\>
|
|
230
230
|
|
|
231
|
-
Defined in: [graphql/private-key.ts:27](https://github.com/settlemint/sdk/blob/v1.2.
|
|
231
|
+
Defined in: [graphql/private-key.ts:27](https://github.com/settlemint/sdk/blob/v1.2.3/sdk/js/src/graphql/private-key.ts#L27)
|
|
232
232
|
|
|
233
233
|
Type representing a private key entity.
|
|
234
234
|
|
|
@@ -236,9 +236,9 @@ Type representing a private key entity.
|
|
|
236
236
|
|
|
237
237
|
#### Storage
|
|
238
238
|
|
|
239
|
-
> **Storage
|
|
239
|
+
> **Storage** = `ResultOf`\<*typeof* `StorageFragment`\>
|
|
240
240
|
|
|
241
|
-
Defined in: [graphql/storage.ts:35](https://github.com/settlemint/sdk/blob/v1.2.
|
|
241
|
+
Defined in: [graphql/storage.ts:35](https://github.com/settlemint/sdk/blob/v1.2.3/sdk/js/src/graphql/storage.ts#L35)
|
|
242
242
|
|
|
243
243
|
Type representing a storage entity.
|
|
244
244
|
|
|
@@ -246,9 +246,9 @@ Type representing a storage entity.
|
|
|
246
246
|
|
|
247
247
|
#### Workspace
|
|
248
248
|
|
|
249
|
-
> **Workspace
|
|
249
|
+
> **Workspace** = `ResultOf`\<*typeof* `WorkspaceFragment`\>
|
|
250
250
|
|
|
251
|
-
Defined in: [graphql/workspace.ts:26](https://github.com/settlemint/sdk/blob/v1.2.
|
|
251
|
+
Defined in: [graphql/workspace.ts:26](https://github.com/settlemint/sdk/blob/v1.2.3/sdk/js/src/graphql/workspace.ts#L26)
|
|
252
252
|
|
|
253
253
|
Type representing a workspace entity.
|
|
254
254
|
|
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": "1.2.
|
|
4
|
+
"version": "1.2.3-maind06b7984",
|
|
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": "1.2.
|
|
58
|
+
"@settlemint/sdk-utils": "1.2.3-maind06b7984"
|
|
59
59
|
},
|
|
60
60
|
"peerDependencies": {},
|
|
61
61
|
"engines": {
|