@settlemint/sdk-portal 1.2.3 → 1.2.4-main957a32df
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 +6 -6
- 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:110](https://github.com/settlemint/sdk/blob/v1.2.
|
|
57
|
+
Defined in: [sdk/portal/src/portal.ts:110](https://github.com/settlemint/sdk/blob/v1.2.4/sdk/portal/src/portal.ts#L110)
|
|
58
58
|
|
|
59
59
|
Creates a Portal GraphQL client with the provided configuration.
|
|
60
60
|
|
|
@@ -79,8 +79,8 @@ An object containing the configured GraphQL client and graphql helper function
|
|
|
79
79
|
|
|
80
80
|
| Name | Type | Defined in |
|
|
81
81
|
| ------ | ------ | ------ |
|
|
82
|
-
| `client` | `GraphQLClient` | [sdk/portal/src/portal.ts:114](https://github.com/settlemint/sdk/blob/v1.2.
|
|
83
|
-
| `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/portal/src/portal.ts:115](https://github.com/settlemint/sdk/blob/v1.2.
|
|
82
|
+
| `client` | `GraphQLClient` | [sdk/portal/src/portal.ts:114](https://github.com/settlemint/sdk/blob/v1.2.4/sdk/portal/src/portal.ts#L114) |
|
|
83
|
+
| `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/portal/src/portal.ts:115](https://github.com/settlemint/sdk/blob/v1.2.4/sdk/portal/src/portal.ts#L115) |
|
|
84
84
|
|
|
85
85
|
##### Throws
|
|
86
86
|
|
|
@@ -134,7 +134,7 @@ const result = await client.request(query);
|
|
|
134
134
|
|
|
135
135
|
> **ClientOptions** = `z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>
|
|
136
136
|
|
|
137
|
-
Defined in: [sdk/portal/src/portal.ts:32](https://github.com/settlemint/sdk/blob/v1.2.
|
|
137
|
+
Defined in: [sdk/portal/src/portal.ts:32](https://github.com/settlemint/sdk/blob/v1.2.4/sdk/portal/src/portal.ts#L32)
|
|
138
138
|
|
|
139
139
|
Type representing the validated client options.
|
|
140
140
|
|
|
@@ -144,7 +144,7 @@ Type representing the validated client options.
|
|
|
144
144
|
|
|
145
145
|
> **RequestConfig** = `ConstructorParameters`\<*typeof* `GraphQLClient`\>\[`1`\]
|
|
146
146
|
|
|
147
|
-
Defined in: [sdk/portal/src/portal.ts:10](https://github.com/settlemint/sdk/blob/v1.2.
|
|
147
|
+
Defined in: [sdk/portal/src/portal.ts:10](https://github.com/settlemint/sdk/blob/v1.2.4/sdk/portal/src/portal.ts#L10)
|
|
148
148
|
|
|
149
149
|
Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
|
|
150
150
|
|
|
@@ -154,7 +154,7 @@ Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
|
|
|
154
154
|
|
|
155
155
|
> `const` **ClientOptionsSchema**: `ZodDiscriminatedUnion`\<`"runtime"`, \[`ZodObject`\<\{ `accessToken`: `ZodString`; `cache`: `ZodOptional`\<`ZodEnum`\<\[`"default"`, `"force-cache"`, `"no-cache"`, `"no-store"`, `"only-if-cached"`, `"reload"`\]\>\>; `instance`: `ZodUnion`\<\[`ZodString`, `ZodString`\]\>; `runtime`: `ZodLiteral`\<`"server"`\>; \}, `"strip"`, `ZodTypeAny`, \{ `accessToken`: `string`; `cache`: `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"`; `instance`: `string`; `runtime`: `"server"`; \}, \{ `accessToken`: `string`; `cache`: `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"`; `instance`: `string`; `runtime`: `"server"`; \}\>, `ZodObject`\<\{ `cache`: `ZodOptional`\<`ZodEnum`\<\[`"default"`, `"force-cache"`, `"no-cache"`, `"no-store"`, `"only-if-cached"`, `"reload"`\]\>\>; `runtime`: `ZodLiteral`\<`"browser"`\>; \}, `"strip"`, `ZodTypeAny`, \{ `cache`: `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"`; `runtime`: `"browser"`; \}, \{ `cache`: `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"`; `runtime`: `"browser"`; \}\>\]\>
|
|
156
156
|
|
|
157
|
-
Defined in: [sdk/portal/src/portal.ts:16](https://github.com/settlemint/sdk/blob/v1.2.
|
|
157
|
+
Defined in: [sdk/portal/src/portal.ts:16](https://github.com/settlemint/sdk/blob/v1.2.4/sdk/portal/src/portal.ts#L16)
|
|
158
158
|
|
|
159
159
|
Schema for validating Portal client configuration options.
|
|
160
160
|
Discriminates between server and browser runtime environments.
|
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": "1.2.
|
|
4
|
+
"version": "1.2.4-main957a32df",
|
|
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": "1.2.
|
|
55
|
+
"@settlemint/sdk-utils": "1.2.4-main957a32df",
|
|
56
56
|
"graphql-request": "^7",
|
|
57
57
|
"zod": "^3"
|
|
58
58
|
},
|