@twin.org/nft-models 0.0.1-next.3 → 0.0.1-next.30

package/dist/types/models/INftComponent.d.ts

@@ -5,7 +5,6 @@ import type { IComponent } from "@twin.org/core";
 export interface INftComponent extends IComponent {
     /**
      * Mint an NFT.
-     * @param issuer The issuer for the NFT, will also be the initial owner.
      * @param tag The tag for the NFT.
      * @param immutableMetadata The immutable metadata for the NFT.
      * @param metadata The metadata for the NFT.
@@ -13,14 +12,14 @@ export interface INftComponent extends IComponent {
      * @param identity The identity to perform the nft operation on.
      * @returns The id of the created NFT in urn format.
      */
-    mint<T = unknown, U = unknown>(issuer: string, tag: string, immutableMetadata?: T, metadata?: U, namespace?: string, identity?: string): Promise<string>;
+    mint<T = unknown, U = unknown>(tag: string, immutableMetadata?: T, metadata?: U, namespace?: string, identity?: string): Promise<string>;
     /**
      * Resolve an NFT.
      * @param id The id of the NFT to resolve.
-     * @param identity The identity to perform the nft operation on.
+     * @param controllerIdentity The identity to perform the nft operation on.
      * @returns The data for the NFT.
      */
-    resolve<T = unknown, U = unknown>(id: string, identity?: string): Promise<{
+    resolve<T = unknown, U = unknown>(id: string, controllerIdentity?: string): Promise<{
         issuer: string;
         owner: string;
         tag: string;
@@ -30,25 +29,26 @@ export interface INftComponent extends IComponent {
     /**
      * Burn an NFT.
      * @param id The id of the NFT to burn in urn format.
-     * @param identity The identity to perform the nft operation on.
+     * @param controllerIdentity The identity to perform the nft operation on.
      * @returns Nothing.
      */
-    burn(id: string, identity?: string): Promise<void>;
+    burn(id: string, controllerIdentity?: string): Promise<void>;
     /**
      * Transfer an NFT.
      * @param id The id of the NFT to transfer in urn format.
-     * @param recipient The recipient of the NFT.
+     * @param recipientIdentity The recipient identity for the NFT.
+     * @param recipientAddress The recipient address for the NFT.
      * @param metadata Optional mutable data to include during the transfer.
-     * @param identity The identity to perform the nft operation on.
+     * @param controllerIdentity The identity to perform the nft operation on.
      * @returns Nothing.
      */
-    transfer<T = unknown>(id: string, recipient: string, metadata?: T, identity?: string): Promise<void>;
+    transfer<U = unknown>(id: string, recipientIdentity: string, recipientAddress: string, metadata?: U, controllerIdentity?: string): Promise<void>;
     /**
      * Update the mutable data of the NFT.
      * @param id The id of the NFT to update in urn format.
      * @param metadata The mutable data to update.
-     * @param identity The identity to perform the nft operation on.
+     * @param controllerIdentity The identity to perform the nft operation on.
      * @returns Nothing.
      */
-    update<T = unknown>(id: string, metadata: T, identity?: string): Promise<void>;
+    update<U = unknown>(id: string, metadata: U, controllerIdentity?: string): Promise<void>;
 }

package/dist/types/models/INftConnector.d.ts

@@ -5,14 +5,13 @@ import type { IComponent } from "@twin.org/core";
 export interface INftConnector extends IComponent {
     /**
      * Mint an NFT.
-     * @param controller The identity of the user to access the vault keys.
-     * @param issuerAddress The issuer for the NFT, will also be the initial owner.
+     * @param controllerIdentity The identity of the user to access the vault keys.
      * @param tag The tag for the NFT.
      * @param immutableMetadata The immutable metadata for the NFT.
      * @param metadata The metadata for the NFT.
      * @returns The id of the created NFT in urn format.
      */
-    mint<T = unknown, U = unknown>(controller: string, issuerAddress: string, tag: string, immutableMetadata?: T, metadata?: U): Promise<string>;
+    mint<T = unknown, U = unknown>(controllerIdentity: string, tag: string, immutableMetadata?: T, metadata?: U): Promise<string>;
     /**
      * Resolve an NFT.
      * @param id The id of the NFT to resolve.
@@ -34,19 +33,20 @@ export interface INftConnector extends IComponent {
     burn(controller: string, id: string): Promise<void>;
     /**
      * Transfer an NFT.
-     * @param controller The controller of the NFT who can make changes.
+     * @param controllerIdentity The controller of the NFT who can make changes.
      * @param id The id of the NFT to transfer in urn format.
-     * @param recipient The recipient of the NFT.
+     * @param recipientIdentity The recipient identity for the NFT.
+     * @param recipientAddress The recipient address for the NFT.
      * @param metadata Optional mutable data to include during the transfer.
      * @returns Nothing.
      */
-    transfer<T = unknown>(controller: string, id: string, recipient: string, metadata?: T): Promise<void>;
+    transfer<U = unknown>(controllerIdentity: string, id: string, recipientIdentity: string, recipientAddress: string, metadata?: U): Promise<void>;
     /**
      * Update the mutable data of the NFT.
-     * @param controller The controller of the NFT who can make changes.
+     * @param controllerIdentity The controller of the NFT who can make changes.
      * @param id The id of the NFT to update in urn format.
      * @param metadata The mutable data to update.
      * @returns Nothing.
      */
-    update<T = unknown>(controller: string, id: string, metadata: T): Promise<void>;
+    update<U = unknown>(controllerIdentity: string, id: string, metadata: U): Promise<void>;
 }

package/dist/types/models/api/INftMintRequest.d.ts

@@ -6,10 +6,6 @@ export interface INftMintRequest {
      * The data to be used in the minting.
      */
     body: {
-        /**
-         * The issuer for the NFT, will also be the initial owner.
-         */
-        issuer: string;
         /**
          * The tag for the NFT.
          */

package/dist/types/models/api/INftTransferRequest.d.ts

@@ -16,9 +16,13 @@ export interface INftTransferRequest {
      */
     body: {
         /**
-         * The recipient for the NFT.
+         * The recipient identity for the NFT.
          */
-        recipient: string;
+        recipientIdentity: string;
+        /**
+         * The recipient address for the NFT.
+         */
+        recipientAddress: string;
         /**
          * The metadata for the NFT.
          */

package/docs/changelog.md

@@ -1,5 +1,54 @@
 # @twin.org/nft-models - Changelog
 
-## v0.0.1-next.3
+## [0.0.1-next.30](https://github.com/twinfoundation/nft/compare/nft-models-v0.0.1-next.29...nft-models-v0.0.1-next.30) (2025-05-22)
+
+
+### Miscellaneous Chores
+
+* **nft-models:** Synchronize repo versions
+
+## [0.0.1-next.29](https://github.com/twinfoundation/nft/compare/nft-models-v0.0.1-next.28...nft-models-v0.0.1-next.29) (2025-05-21)
+
+
+### Miscellaneous Chores
+
+* **nft-models:** Synchronize repo versions
+
+## [0.0.1-next.28](https://github.com/twinfoundation/nft/compare/nft-models-v0.0.1-next.27...nft-models-v0.0.1-next.28) (2025-05-06)
+
+
+### Miscellaneous Chores
+
+* **nft-models:** Synchronize repo versions
+
+## [0.0.1-next.27](https://github.com/twinfoundation/nft/compare/nft-models-v0.0.1-next.26...nft-models-v0.0.1-next.27) (2025-04-24)
+
+
+### Miscellaneous Chores
+
+* **nft-models:** Synchronize repo versions
+
+## [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)
+
+
+### Features
+
+* use shared store mechanism ([#16](https://github.com/twinfoundation/nft/issues/16)) ([897bc78](https://github.com/twinfoundation/nft/commit/897bc7805248ba1388b2dd03df24c33f1633f344))
+
+## [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)
+
+
+### Miscellaneous Chores
+
+* **nft-models:** Synchronize repo versions
+
+## [0.0.1-next.24](https://github.com/twinfoundation/nft/compare/nft-models-v0.0.1-next.23...nft-models-v0.0.1-next.24) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **nft-models:** Synchronize repo versions
+
+## v0.0.1-next.23
 
 - Initial Release

package/docs/reference/interfaces/IIrc27Metadata.md

@@ -61,7 +61,7 @@ Object containing key value pair where payment address mapped to the payout perc
 
 #### Index Signature
 
- \[`id`: `string`\]: `number`
+\[`id`: `string`\]: `number`
 
 ***
 
@@ -86,3 +86,11 @@ Alphanumeric text string to define a basic description of the NFT.
 > `optional` **attributes**: `object`[]
 
 Array objects defining additional attributes of the NFT
+
+#### trait\_type
+
+> **trait\_type**: `string`
+
+#### value
+
+> **value**: `unknown`

package/docs/reference/interfaces/INftComponent.md

@@ -10,39 +10,49 @@ Interface describing an NFT component.
 
 ### mint()
 
-> **mint**\<`T`, `U`\>(`issuer`, `tag`, `immutableMetadata`?, `metadata`?, `namespace`?, `identity`?): `Promise`\<`string`\>
+> **mint**\<`T`, `U`\>(`tag`, `immutableMetadata?`, `metadata?`, `namespace?`, `identity?`): `Promise`\<`string`\>
 
 Mint an NFT.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
 
-• **U** = `unknown`
+`T` = `unknown`
 
-#### Parameters
+##### U
+
+`U` = `unknown`
 
-• **issuer**: `string`
+#### Parameters
 
-The issuer for the NFT, will also be the initial owner.
+##### tag
 
-• **tag**: `string`
+`string`
 
 The tag for the NFT.
 
-• **immutableMetadata?**: `T`
+##### immutableMetadata?
+
+`T`
 
 The immutable metadata for the NFT.
 
-• **metadata?**: `U`
+##### metadata?
+
+`U`
 
 The metadata for the NFT.
 
-• **namespace?**: `string`
+##### namespace?
+
+`string`
 
 The namespace of the connector to use for the NFT, defaults to component configured namespace.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the nft operation on.
 
@@ -56,67 +66,59 @@ The id of the created NFT in urn format.
 
 ### resolve()
 
-> **resolve**\<`T`, `U`\>(`id`, `identity`?): `Promise`\<`object`\>
+> **resolve**\<`T`, `U`\>(`id`, `controllerIdentity?`): `Promise`\<\{ `issuer`: `string`; `owner`: `string`; `tag`: `string`; `immutableMetadata`: `T`; `metadata`: `U`; \}\>
 
 Resolve an NFT.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
-• **U** = `unknown`
+##### U
+
+`U` = `unknown`
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the NFT to resolve.
 
-• **identity?**: `string`
+##### controllerIdentity?
+
+`string`
 
 The identity to perform the nft operation on.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `issuer`: `string`; `owner`: `string`; `tag`: `string`; `immutableMetadata`: `T`; `metadata`: `U`; \}\>
 
 The data for the NFT.
 
-##### issuer
-
-> **issuer**: `string`
-
-##### owner
-
-> **owner**: `string`
-
-##### tag
-
-> **tag**: `string`
-
-##### immutableMetadata?
-
-> `optional` **immutableMetadata**: `T`
-
-##### metadata?
-
-> `optional` **metadata**: `U`
-
 ***
 
 ### burn()
 
-> **burn**(`id`, `identity`?): `Promise`\<`void`\>
+> **burn**(`id`, `controllerIdentity?`): `Promise`\<`void`\>
 
 Burn an NFT.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the NFT to burn in urn format.
 
-• **identity?**: `string`
+##### controllerIdentity?
+
+`string`
 
 The identity to perform the nft operation on.
 
@@ -130,29 +132,45 @@ Nothing.
 
 ### transfer()
 
-> **transfer**\<`T`\>(`id`, `recipient`, `metadata`?, `identity`?): `Promise`\<`void`\>
+> **transfer**\<`U`\>(`id`, `recipientIdentity`, `recipientAddress`, `metadata?`, `controllerIdentity?`): `Promise`\<`void`\>
 
 Transfer an NFT.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### U
+
+`U` = `unknown`
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the NFT to transfer in urn format.
 
-• **recipient**: `string`
+##### recipientIdentity
+
+`string`
 
-The recipient of the NFT.
+The recipient identity for the NFT.
 
-• **metadata?**: `T`
+##### recipientAddress
+
+`string`
+
+The recipient address for the NFT.
+
+##### metadata?
+
+`U`
 
 Optional mutable data to include during the transfer.
 
-• **identity?**: `string`
+##### controllerIdentity?
+
+`string`
 
 The identity to perform the nft operation on.
 
@@ -166,25 +184,33 @@ Nothing.
 
 ### update()
 
-> **update**\<`T`\>(`id`, `metadata`, `identity`?): `Promise`\<`void`\>
+> **update**\<`U`\>(`id`, `metadata`, `controllerIdentity?`): `Promise`\<`void`\>
 
 Update the mutable data of the NFT.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### U
+
+`U` = `unknown`
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the NFT to update in urn format.
 
-• **metadata**: `T`
+##### metadata
+
+`U`
 
 The mutable data to update.
 
-• **identity?**: `string`
+##### controllerIdentity?
+
+`string`
 
 The identity to perform the nft operation on.
 

package/docs/reference/interfaces/INftConnector.md

@@ -10,35 +10,43 @@ Interface describing an NFT connector.
 
 ### mint()
 
-> **mint**\<`T`, `U`\>(`controller`, `issuerAddress`, `tag`, `immutableMetadata`?, `metadata`?): `Promise`\<`string`\>
+> **mint**\<`T`, `U`\>(`controllerIdentity`, `tag`, `immutableMetadata?`, `metadata?`): `Promise`\<`string`\>
 
 Mint an NFT.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
 
-• **U** = `unknown`
+`T` = `unknown`
+
+##### U
+
+`U` = `unknown`
 
 #### Parameters
 
-• **controller**: `string`
+##### controllerIdentity
 
-The identity of the user to access the vault keys.
+`string`
 
-• **issuerAddress**: `string`
+The identity of the user to access the vault keys.
 
-The issuer for the NFT, will also be the initial owner.
+##### tag
 
-• **tag**: `string`
+`string`
 
 The tag for the NFT.
 
-• **immutableMetadata?**: `T`
+##### immutableMetadata?
+
+`T`
 
 The immutable metadata for the NFT.
 
-• **metadata?**: `U`
+##### metadata?
+
+`U`
 
 The metadata for the NFT.
 
@@ -52,48 +60,34 @@ The id of the created NFT in urn format.
 
 ### resolve()
 
-> **resolve**\<`T`, `U`\>(`id`): `Promise`\<`object`\>
+> **resolve**\<`T`, `U`\>(`id`): `Promise`\<\{ `issuer`: `string`; `owner`: `string`; `tag`: `string`; `immutableMetadata`: `T`; `metadata`: `U`; \}\>
 
 Resolve an NFT.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
-• **U** = `unknown`
+##### U
+
+`U` = `unknown`
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the NFT to resolve.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `issuer`: `string`; `owner`: `string`; `tag`: `string`; `immutableMetadata`: `T`; `metadata`: `U`; \}\>
 
 The data for the NFT.
 
-##### issuer
-
-> **issuer**: `string`
-
-##### owner
-
-> **owner**: `string`
-
-##### tag
-
-> **tag**: `string`
-
-##### immutableMetadata?
-
-> `optional` **immutableMetadata**: `T`
-
-##### metadata?
-
-> `optional` **metadata**: `U`
-
 ***
 
 ### burn()
@@ -104,11 +98,15 @@ Burn an NFT.
 
 #### Parameters
 
-• **controller**: `string`
+##### controller
+
+`string`
 
 The controller of the NFT who can make changes.
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the NFT to burn in urn format.
 
@@ -122,29 +120,45 @@ Nothing.
 
 ### transfer()
 
-> **transfer**\<`T`\>(`controller`, `id`, `recipient`, `metadata`?): `Promise`\<`void`\>
+> **transfer**\<`U`\>(`controllerIdentity`, `id`, `recipientIdentity`, `recipientAddress`, `metadata?`): `Promise`\<`void`\>
 
 Transfer an NFT.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### U
+
+`U` = `unknown`
 
 #### Parameters
 
-• **controller**: `string`
+##### controllerIdentity
+
+`string`
 
 The controller of the NFT who can make changes.
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the NFT to transfer in urn format.
 
-• **recipient**: `string`
+##### recipientIdentity
 
-The recipient of the NFT.
+`string`
 
-• **metadata?**: `T`
+The recipient identity for the NFT.
+
+##### recipientAddress
+
+`string`
+
+The recipient address for the NFT.
+
+##### metadata?
+
+`U`
 
 Optional mutable data to include during the transfer.
 
@@ -158,25 +172,33 @@ Nothing.
 
 ### update()
 
-> **update**\<`T`\>(`controller`, `id`, `metadata`): `Promise`\<`void`\>
+> **update**\<`U`\>(`controllerIdentity`, `id`, `metadata`): `Promise`\<`void`\>
 
 Update the mutable data of the NFT.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### U
+
+`U` = `unknown`
 
 #### Parameters
 
-• **controller**: `string`
+##### controllerIdentity
+
+`string`
 
 The controller of the NFT who can make changes.
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the NFT to update in urn format.
 
-• **metadata**: `T`
+##### metadata
+
+`U`
 
 The mutable data to update.
 

package/docs/reference/interfaces/INftMintRequest.md

@@ -10,12 +10,6 @@ Mint the data and return the NFT id.
 
 The data to be used in the minting.
 
-#### issuer
-
-> **issuer**: `string`
-
-The issuer for the NFT, will also be the initial owner.
-
 #### tag
 
 > **tag**: `string`

package/docs/reference/interfaces/INftTransferRequest.md

@@ -24,11 +24,17 @@ The id of the NFT to transfer in urn format.
 
 The data to be used in the transfer.
 
-#### recipient
+#### recipientIdentity
 
-> **recipient**: `string`
+> **recipientIdentity**: `string`
 
-The recipient for the NFT.
+The recipient identity for the NFT.
+
+#### recipientAddress
+
+> **recipientAddress**: `string`
+
+The recipient address for the NFT.
 
 #### metadata?
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/nft-models",
-	"version": "0.0.1-next.3",
+	"version": "0.0.1-next.30",
 	"description": "Contains models and classes for use with NFTs",
 	"repository": {
 		"type": "git",
@@ -13,46 +13,19 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
-	"scripts": {
-		"clean": "rimraf dist coverage",
-		"build": "tspc",
-		"test": "vitest --run --config ./vitest.config.ts --no-cache",
-		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
-		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
-		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
-		"bundle": "npm run bundle:esm && npm run bundle:cjs",
-		"docs:clean": "rimraf docs/reference",
-		"docs:generate": "typedoc",
-		"docs": "npm run docs:clean && npm run docs:generate",
-		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
-	},
 	"dependencies": {
 		"@twin.org/core": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
-	"devDependencies": {
-		"@twin.org/nameof-transformer": "next",
-		"@vitest/coverage-v8": "2.1.1",
-		"@types/node": "22.5.5",
-		"copyfiles": "2.4.1",
-		"rimraf": "6.0.1",
-		"rollup": "4.22.0",
-		"rollup-plugin-typescript2": "0.36.0",
-		"ts-patch": "3.2.1",
-		"typedoc": "0.26.7",
-		"typedoc-plugin-markdown": "4.2.7",
-		"typescript": "5.6.2",
-		"vitest": "2.1.1"
-	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		}
 	},
 	"files": [