@twin.org/nft-rest-client 0.0.1-next.6 → 0.0.1-next.7

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.
Files changed (3) hide show
  1. package/docs/changelog.md +1 -1
  2. package/docs/reference/classes/NftClient.md +41 -35
  3. package/package.json +2 -2
package/docs/changelog.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # @twin.org/nft-rest-client - Changelog
2
2
 
3
- ## v0.0.1-next.6
3
+ ## v0.0.1-next.7
4
4
 
5
5
  - Initial Release
package/docs/reference/classes/NftClient.md CHANGED
@@ -20,7 +20,9 @@ Create a new instance of NftClient.
20
20
 
21
21
  #### Parameters
22
22
 
23
- • **config**: `IBaseRestClientConfig`
23
+ ##### config
24
+
25
+ `IBaseRestClientConfig`
24
26
 
25
27
  The configuration for the client.
26
28
 
@@ -60,23 +62,33 @@ Mint an NFT.
60
62
 
61
63
  #### Parameters
62
64
 
63
- • **issuer**: `string`
65
+ ##### issuer
66
+
67
+ `string`
64
68
 
65
69
  The issuer for the NFT, will also be the initial owner.
66
70
 
67
- • **tag**: `string`
71
+ ##### tag
72
+
73
+ `string`
68
74
 
69
75
  The tag for the NFT.
70
76
 
71
- • **immutableMetadata?**: `T`
77
+ ##### immutableMetadata?
78
+
79
+ `T`
72
80
 
73
81
  The immutable metadata for the NFT.
74
82
 
75
- • **metadata?**: `U`
83
+ ##### metadata?
84
+
85
+ `U`
76
86
 
77
87
  The metadata for the NFT.
78
88
 
79
- • **namespace?**: `string`
89
+ ##### namespace?
90
+
91
+ `string`
80
92
 
81
93
  The namespace of the connector to use for the NFT, defaults to component configured namespace.
82
94
 
@@ -94,7 +106,7 @@ The id of the created NFT in urn format.
94
106
 
95
107
  ### resolve()
96
108
 
97
- > **resolve**\<`T`, `U`\>(`id`): `Promise`\<`object`\>
109
+ > **resolve**\<`T`, `U`\>(`id`): `Promise`\<\{ `issuer`: `string`; `owner`: `string`; `tag`: `string`; `immutableMetadata`: `T`; `metadata`: `U`; \}\>
98
110
 
99
111
  Resolve an NFT.
100
112
 
@@ -106,36 +118,18 @@ Resolve an NFT.
106
118
 
107
119
  #### Parameters
108
120
 
109
- • **id**: `string`
121
+ ##### id
122
+
123
+ `string`
110
124
 
111
125
  The id of the NFT to resolve.
112
126
 
113
127
  #### Returns
114
128
 
115
- `Promise`\<`object`\>
129
+ `Promise`\<\{ `issuer`: `string`; `owner`: `string`; `tag`: `string`; `immutableMetadata`: `T`; `metadata`: `U`; \}\>
116
130
 
117
131
  The data for the NFT.
118
132
 
119
- ##### issuer
120
-
121
- > **issuer**: `string`
122
-
123
- ##### owner
124
-
125
- > **owner**: `string`
126
-
127
- ##### tag
128
-
129
- > **tag**: `string`
130
-
131
- ##### immutableMetadata?
132
-
133
- > `optional` **immutableMetadata**: `T`
134
-
135
- ##### metadata?
136
-
137
- > `optional` **metadata**: `U`
138
-
139
133
  #### Implementation of
140
134
 
141
135
  `INftComponent.resolve`
@@ -150,7 +144,9 @@ Burn an NFT.
150
144
 
151
145
  #### Parameters
152
146
 
153
- • **id**: `string`
147
+ ##### id
148
+
149
+ `string`
154
150
 
155
151
  The id of the NFT to burn in urn format.
156
152
 
@@ -178,15 +174,21 @@ Transfer an NFT.
178
174
 
179
175
  #### Parameters
180
176
 
181
- • **id**: `string`
177
+ ##### id
178
+
179
+ `string`
182
180
 
183
181
  The id of the NFT to transfer in urn format.
184
182
 
185
- • **recipient**: `string`
183
+ ##### recipient
184
+
185
+ `string`
186
186
 
187
187
  The recipient of the NFT.
188
188
 
189
- • **metadata?**: `T`
189
+ ##### metadata?
190
+
191
+ `T`
190
192
 
191
193
  Optional mutable data to include during the transfer.
192
194
 
@@ -214,11 +216,15 @@ Update the data of the NFT.
214
216
 
215
217
  #### Parameters
216
218
 
217
- • **id**: `string`
219
+ ##### id
220
+
221
+ `string`
218
222
 
219
223
  The id of the NFT to update in urn format.
220
224
 
221
- • **metadata**: `T`
225
+ ##### metadata
226
+
227
+ `T`
222
228
 
223
229
  The mutable data to update.
224
230
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/nft-rest-client",
3
- "version": "0.0.1-next.6",
3
+ "version": "0.0.1-next.7",
4
4
  "description": "NFT contract implementation which can connect to REST endpoints",
5
5
  "repository": {
6
6
  "type": "git",
@@ -19,7 +19,7 @@
19
19
  "@twin.org/core": "next",
20
20
  "@twin.org/entity": "next",
21
21
  "@twin.org/nameof": "next",
22
- "@twin.org/nft-models": "0.0.1-next.6",
22
+ "@twin.org/nft-models": "0.0.1-next.7",
23
23
  "@twin.org/web": "next"
24
24
  },
25
25
  "main": "./dist/cjs/index.cjs",