@twin.org/nft-models 0.0.1-next.25 → 0.0.1-next.26

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 (4) hide show
  1. package/docs/changelog.md +7 -0
  2. package/docs/reference/interfaces/INftComponent.md +23 -11
  3. package/docs/reference/interfaces/INftConnector.md +20 -8
  4. package/package.json +1 -1
package/docs/changelog.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # @twin.org/nft-models - Changelog
2
2
 
3
+ ## [0.0.1-next.26](https://github.com/twinfoundation/nft/compare/nft-models-v0.0.1-next.25...nft-models-v0.0.1-next.26) (2025-04-17)
4
+
5
+
6
+ ### Features
7
+
8
+ * use shared store mechanism ([#16](https://github.com/twinfoundation/nft/issues/16)) ([897bc78](https://github.com/twinfoundation/nft/commit/897bc7805248ba1388b2dd03df24c33f1633f344))
9
+
3
10
  ## [0.0.1-next.25](https://github.com/twinfoundation/nft/compare/nft-models-v0.0.1-next.24...nft-models-v0.0.1-next.25) (2025-04-17)
4
11
 
5
12
 
package/docs/reference/interfaces/INftComponent.md CHANGED
@@ -10,15 +10,19 @@ Interface describing an NFT component.
10
10
 
11
11
  ### mint()
12
12
 
13
- > **mint**\<`T`, `U`\>(`tag`, `immutableMetadata`?, `metadata`?, `namespace`?, `identity`?): `Promise`\<`string`\>
13
+ > **mint**\<`T`, `U`\>(`tag`, `immutableMetadata?`, `metadata?`, `namespace?`, `identity?`): `Promise`\<`string`\>
14
14
 
15
15
  Mint an NFT.
16
16
 
17
17
  #### Type Parameters
18
18
 
19
- • **T** = `unknown`
19
+ ##### T
20
20
 
21
- • **U** = `unknown`
21
+ `T` = `unknown`
22
+
23
+ ##### U
24
+
25
+ `U` = `unknown`
22
26
 
23
27
  #### Parameters
24
28
 
@@ -62,15 +66,19 @@ The id of the created NFT in urn format.
62
66
 
63
67
  ### resolve()
64
68
 
65
- > **resolve**\<`T`, `U`\>(`id`, `controllerIdentity`?): `Promise`\<\{ `issuer`: `string`; `owner`: `string`; `tag`: `string`; `immutableMetadata`: `T`; `metadata`: `U`; \}\>
69
+ > **resolve**\<`T`, `U`\>(`id`, `controllerIdentity?`): `Promise`\<\{ `issuer`: `string`; `owner`: `string`; `tag`: `string`; `immutableMetadata`: `T`; `metadata`: `U`; \}\>
66
70
 
67
71
  Resolve an NFT.
68
72
 
69
73
  #### Type Parameters
70
74
 
71
- • **T** = `unknown`
75
+ ##### T
76
+
77
+ `T` = `unknown`
72
78
 
73
- • **U** = `unknown`
79
+ ##### U
80
+
81
+ `U` = `unknown`
74
82
 
75
83
  #### Parameters
76
84
 
@@ -96,7 +104,7 @@ The data for the NFT.
96
104
 
97
105
  ### burn()
98
106
 
99
- > **burn**(`id`, `controllerIdentity`?): `Promise`\<`void`\>
107
+ > **burn**(`id`, `controllerIdentity?`): `Promise`\<`void`\>
100
108
 
101
109
  Burn an NFT.
102
110
 
@@ -124,13 +132,15 @@ Nothing.
124
132
 
125
133
  ### transfer()
126
134
 
127
- > **transfer**\<`U`\>(`id`, `recipientIdentity`, `recipientAddress`, `metadata`?, `controllerIdentity`?): `Promise`\<`void`\>
135
+ > **transfer**\<`U`\>(`id`, `recipientIdentity`, `recipientAddress`, `metadata?`, `controllerIdentity?`): `Promise`\<`void`\>
128
136
 
129
137
  Transfer an NFT.
130
138
 
131
139
  #### Type Parameters
132
140
 
133
- • **U** = `unknown`
141
+ ##### U
142
+
143
+ `U` = `unknown`
134
144
 
135
145
  #### Parameters
136
146
 
@@ -174,13 +184,15 @@ Nothing.
174
184
 
175
185
  ### update()
176
186
 
177
- > **update**\<`U`\>(`id`, `metadata`, `controllerIdentity`?): `Promise`\<`void`\>
187
+ > **update**\<`U`\>(`id`, `metadata`, `controllerIdentity?`): `Promise`\<`void`\>
178
188
 
179
189
  Update the mutable data of the NFT.
180
190
 
181
191
  #### Type Parameters
182
192
 
183
- • **U** = `unknown`
193
+ ##### U
194
+
195
+ `U` = `unknown`
184
196
 
185
197
  #### Parameters
186
198
 
package/docs/reference/interfaces/INftConnector.md CHANGED
@@ -10,15 +10,19 @@ Interface describing an NFT connector.
10
10
 
11
11
  ### mint()
12
12
 
13
- > **mint**\<`T`, `U`\>(`controllerIdentity`, `tag`, `immutableMetadata`?, `metadata`?): `Promise`\<`string`\>
13
+ > **mint**\<`T`, `U`\>(`controllerIdentity`, `tag`, `immutableMetadata?`, `metadata?`): `Promise`\<`string`\>
14
14
 
15
15
  Mint an NFT.
16
16
 
17
17
  #### Type Parameters
18
18
 
19
- • **T** = `unknown`
19
+ ##### T
20
20
 
21
- • **U** = `unknown`
21
+ `T` = `unknown`
22
+
23
+ ##### U
24
+
25
+ `U` = `unknown`
22
26
 
23
27
  #### Parameters
24
28
 
@@ -62,9 +66,13 @@ Resolve an NFT.
62
66
 
63
67
  #### Type Parameters
64
68
 
65
- • **T** = `unknown`
69
+ ##### T
70
+
71
+ `T` = `unknown`
66
72
 
67
- • **U** = `unknown`
73
+ ##### U
74
+
75
+ `U` = `unknown`
68
76
 
69
77
  #### Parameters
70
78
 
@@ -112,13 +120,15 @@ Nothing.
112
120
 
113
121
  ### transfer()
114
122
 
115
- > **transfer**\<`U`\>(`controllerIdentity`, `id`, `recipientIdentity`, `recipientAddress`, `metadata`?): `Promise`\<`void`\>
123
+ > **transfer**\<`U`\>(`controllerIdentity`, `id`, `recipientIdentity`, `recipientAddress`, `metadata?`): `Promise`\<`void`\>
116
124
 
117
125
  Transfer an NFT.
118
126
 
119
127
  #### Type Parameters
120
128
 
121
- • **U** = `unknown`
129
+ ##### U
130
+
131
+ `U` = `unknown`
122
132
 
123
133
  #### Parameters
124
134
 
@@ -168,7 +178,9 @@ Update the mutable data of the NFT.
168
178
 
169
179
  #### Type Parameters
170
180
 
171
- • **U** = `unknown`
181
+ ##### U
182
+
183
+ `U` = `unknown`
172
184
 
173
185
  #### Parameters
174
186
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/nft-models",
3
- "version": "0.0.1-next.25",
3
+ "version": "0.0.1-next.26",
4
4
  "description": "Contains models and classes for use with NFTs",
5
5
  "repository": {
6
6
  "type": "git",