@twin.org/nft-models 0.0.3-next.8 → 0.0.3-next.9

package/dist/es/models/IIrc27Metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"IIrc27Metadata.js","sourceRoot":"","sources":["../../../src/models/IIrc27Metadata.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Model defining the IRC27 NFT Standards.\n * https://docs.iota.org/developer/references/framework/stardust/irc27\n */\nexport interface IIrc27Metadata {\n\t/**\n\t * The standard marker.\n\t */\n\tstandard: \"IRC27\";\n\n\t/**\n\t * The version\n\t */\n\tversion: \"v1.0\";\n\n\t/**\n\t * A mime type for the content of the NFT.\n\t */\n\ttype: string;\n\n\t/**\n\t * Url pointing to the NFT file location with MIME type defined in type.\n\t */\n\turi: string;\n\n\t/**\n\t * Alphanumeric text string defining the human identifiable name for the NFT\n\t */\n\tname: string;\n\n\t/**\n\t * Alphanumeric text string defining the human identifiable collection name.\n\t */\n\tcollectionName?: string;\n\n\t/**\n\t * Object containing key value pair where payment address mapped to the payout percentage.\n\t */\n\troyalties?: {\n\t\t[id: string]: number;\n\t};\n\n\t/**\n\t * Alphanumeric text string to define the human identifiable name of the creator.\n\t */\n\tissuerName?: string;\n\n\t/**\n\t * Alphanumeric text string to define a basic description of the NFT.\n\t */\n\tdescription?: string;\n\n\t/**\n\t * Array objects defining additional attributes of the NFT\n\t */\n\tattributes?: {\n\t\ttrait_type: string;\n\t\tvalue: unknown;\n\t}[];\n}\n"]}
+{"version":3,"file":"IIrc27Metadata.js","sourceRoot":"","sources":["../../../src/models/IIrc27Metadata.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Model defining the IRC27 NFT metadata standard.\n * @see https://docs.iota.org/developer/references/framework/stardust/irc27\n */\nexport interface IIrc27Metadata {\n\t/**\n\t * The standard marker.\n\t */\n\tstandard: \"IRC27\";\n\n\t/**\n\t * The version\n\t */\n\tversion: \"v1.0\";\n\n\t/**\n\t * A mime type for the content of the NFT.\n\t */\n\ttype: string;\n\n\t/**\n\t * Url pointing to the NFT file location with MIME type defined in type.\n\t */\n\turi: string;\n\n\t/**\n\t * Alphanumeric text string defining the human identifiable name for the NFT\n\t */\n\tname: string;\n\n\t/**\n\t * Alphanumeric text string defining the human identifiable collection name.\n\t */\n\tcollectionName?: string;\n\n\t/**\n\t * Object containing key value pair where payment address mapped to the payout percentage.\n\t */\n\troyalties?: {\n\t\t[id: string]: number;\n\t};\n\n\t/**\n\t * Alphanumeric text string to define the human identifiable name of the creator.\n\t */\n\tissuerName?: string;\n\n\t/**\n\t * Alphanumeric text string to define a basic description of the NFT.\n\t */\n\tdescription?: string;\n\n\t/**\n\t * Array objects defining additional attributes of the NFT\n\t */\n\tattributes?: {\n\t\ttrait_type: string;\n\t\tvalue: unknown;\n\t}[];\n}\n"]}

package/dist/es/models/INftComponent.js.map

@@ -1 +1 @@
-{"version":3,"file":"INftComponent.js","sourceRoot":"","sources":["../../../src/models/INftComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\n\n/**\n * Interface describing an NFT component.\n */\nexport interface INftComponent extends IComponent {\n\t/**\n\t * Mint an NFT.\n\t * @param tag The tag for the NFT.\n\t * @param immutableMetadata The immutable metadata for the NFT.\n\t * @param metadata The metadata for the NFT.\n\t * @param namespace The namespace of the connector to use for the NFT, defaults to component configured namespace.\n\t * @param identity The identity to perform the nft operation with.\n\t * @returns The id of the created NFT in urn format.\n\t */\n\tmint<T = unknown, U = unknown>(\n\t\ttag: string,\n\t\timmutableMetadata?: T,\n\t\tmetadata?: U,\n\t\tnamespace?: string,\n\t\tidentity?: string\n\t): Promise<string>;\n\n\t/**\n\t * Resolve an NFT.\n\t * @param id The id of the NFT to resolve.\n\t * @param controllerIdentity The identity to perform the nft operation with.\n\t * @returns The data for the NFT.\n\t */\n\tresolve<T = unknown, U = unknown>(\n\t\tid: string,\n\t\tcontrollerIdentity?: string\n\t): Promise<{\n\t\tissuer: string;\n\t\tissuerIdentityId: string;\n\t\ttag: string;\n\t\timmutableMetadata?: T;\n\t\tmetadata?: U;\n\t}>;\n\n\t/**\n\t * Burn an NFT.\n\t * @param id The id of the NFT to burn in urn format.\n\t * @param controllerIdentity The identity to perform the nft operation with.\n\t * @returns Nothing.\n\t */\n\tburn(id: string, controllerIdentity?: string): Promise<void>;\n\n\t/**\n\t * Transfer an NFT.\n\t * @param id The id of the NFT to transfer in urn format.\n\t * @param recipientAddress The recipient address for the NFT.\n\t * @param metadata Optional mutable data to include during the transfer.\n\t * @param controllerIdentity The identity to perform the nft operation with.\n\t * @returns Nothing.\n\t */\n\ttransfer<U = unknown>(\n\t\tid: string,\n\t\trecipientAddress: string,\n\t\tmetadata?: U,\n\t\tcontrollerIdentity?: string\n\t): Promise<void>;\n\n\t/**\n\t * Update the mutable data of the NFT.\n\t * @param id The id of the NFT to update in urn format.\n\t * @param metadata The mutable data to update.\n\t * @param controllerIdentity The identity to perform the nft operation with.\n\t * @returns Nothing.\n\t */\n\tupdate<U = unknown>(id: string, metadata: U, controllerIdentity?: string): Promise<void>;\n}\n"]}
+{"version":3,"file":"INftComponent.js","sourceRoot":"","sources":["../../../src/models/INftComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\n\n/**\n * Interface describing an NFT component.\n */\nexport interface INftComponent extends IComponent {\n\t/**\n\t * Mint an NFT.\n\t * @param tag The tag for the NFT.\n\t * @param immutableMetadata The immutable metadata for the NFT.\n\t * @param metadata The metadata for the NFT.\n\t * @param namespace The namespace of the connector to use for the NFT, defaults to component configured namespace.\n\t * @param identity The identity to perform the nft operation with.\n\t * @returns The id of the created NFT in urn format.\n\t */\n\tmint<T = unknown, U = unknown>(\n\t\ttag: string,\n\t\timmutableMetadata?: T,\n\t\tmetadata?: U,\n\t\tnamespace?: string,\n\t\tidentity?: string\n\t): Promise<string>;\n\n\t/**\n\t * Resolve an NFT.\n\t * @param id The id of the NFT to resolve.\n\t * @param controllerIdentity The identity to perform the nft operation with.\n\t * @returns The data for the NFT.\n\t */\n\tresolve<T = unknown, U = unknown>(\n\t\tid: string,\n\t\tcontrollerIdentity?: string\n\t): Promise<{\n\t\tissuer: string;\n\t\tissuerIdentityId: string;\n\t\ttag: string;\n\t\timmutableMetadata?: T;\n\t\tmetadata?: U;\n\t}>;\n\n\t/**\n\t * Burn an NFT.\n\t * @param id The id of the NFT to burn in urn format.\n\t * @param controllerIdentity The identity to perform the nft operation with.\n\t * @returns A promise that resolves when the NFT has been permanently destroyed.\n\t */\n\tburn(id: string, controllerIdentity?: string): Promise<void>;\n\n\t/**\n\t * Transfer an NFT.\n\t * @param id The id of the NFT to transfer in urn format.\n\t * @param recipientAddress The recipient address for the NFT.\n\t * @param metadata Optional mutable data to include during the transfer.\n\t * @param controllerIdentity The identity to perform the nft operation with.\n\t * @returns A promise that resolves when the NFT ownership has been transferred.\n\t */\n\ttransfer<U = unknown>(\n\t\tid: string,\n\t\trecipientAddress: string,\n\t\tmetadata?: U,\n\t\tcontrollerIdentity?: string\n\t): Promise<void>;\n\n\t/**\n\t * Update the mutable data of the NFT.\n\t * @param id The id of the NFT to update in urn format.\n\t * @param metadata The mutable data to update.\n\t * @param controllerIdentity The identity to perform the nft operation with.\n\t * @returns A promise that resolves when the NFT metadata has been updated.\n\t */\n\tupdate<U = unknown>(id: string, metadata: U, controllerIdentity?: string): Promise<void>;\n}\n"]}

package/dist/es/models/INftConnector.js.map

@@ -1 +1 @@
-{"version":3,"file":"INftConnector.js","sourceRoot":"","sources":["../../../src/models/INftConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\n\n/**\n * Interface describing an NFT connector.\n */\nexport interface INftConnector extends IComponent {\n\t/**\n\t * Mint an NFT.\n\t * @param controllerIdentity The identity of the user to access the vault keys.\n\t * @param tag The tag for the NFT.\n\t * @param immutableMetadata The immutable metadata for the NFT.\n\t * @param metadata The metadata for the NFT.\n\t * @returns The id of the created NFT in urn format.\n\t */\n\tmint<T = unknown, U = unknown>(\n\t\tcontrollerIdentity: string,\n\t\ttag: string,\n\t\timmutableMetadata?: T,\n\t\tmetadata?: U\n\t): Promise<string>;\n\n\t/**\n\t * Resolve an NFT.\n\t * @param id The id of the NFT to resolve.\n\t * @returns The data for the NFT.\n\t */\n\tresolve<T = unknown, U = unknown>(\n\t\tid: string\n\t): Promise<{\n\t\tissuer: string;\n\t\tissuerIdentityId: string;\n\t\ttag: string;\n\t\timmutableMetadata?: T;\n\t\tmetadata?: U;\n\t}>;\n\n\t/**\n\t * Burn an NFT.\n\t * @param controller The controller of the NFT who can make changes.\n\t * @param id The id of the NFT to burn in urn format.\n\t * @returns Nothing.\n\t */\n\tburn(controller: string, id: string): Promise<void>;\n\n\t/**\n\t * Transfer an NFT.\n\t * @param controllerIdentity The controller of the NFT who can make changes.\n\t * @param id The id of the NFT to transfer in urn format.\n\t * @param recipientAddress The recipient address for the NFT.\n\t * @param metadata Optional mutable data to include during the transfer.\n\t * @returns Nothing.\n\t */\n\ttransfer<U = unknown>(\n\t\tcontrollerIdentity: string,\n\t\tid: string,\n\t\trecipientAddress: string,\n\t\tmetadata?: U\n\t): Promise<void>;\n\n\t/**\n\t * Update the mutable data of the NFT.\n\t * @param controllerIdentity The controller of the NFT who can make changes.\n\t * @param id The id of the NFT to update in urn format.\n\t * @param metadata The mutable data to update.\n\t * @returns Nothing.\n\t */\n\tupdate<U = unknown>(controllerIdentity: string, id: string, metadata: U): Promise<void>;\n}\n"]}
+{"version":3,"file":"INftConnector.js","sourceRoot":"","sources":["../../../src/models/INftConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\n\n/**\n * Interface describing an NFT connector.\n */\nexport interface INftConnector extends IComponent {\n\t/**\n\t * Mint an NFT.\n\t * @param controllerIdentity The identity of the user to access the vault keys.\n\t * @param tag The tag for the NFT.\n\t * @param immutableMetadata The immutable metadata for the NFT.\n\t * @param metadata The metadata for the NFT.\n\t * @returns The id of the created NFT in urn format.\n\t */\n\tmint<T = unknown, U = unknown>(\n\t\tcontrollerIdentity: string,\n\t\ttag: string,\n\t\timmutableMetadata?: T,\n\t\tmetadata?: U\n\t): Promise<string>;\n\n\t/**\n\t * Resolve an NFT.\n\t * @param id The id of the NFT to resolve.\n\t * @returns The data for the NFT.\n\t */\n\tresolve<T = unknown, U = unknown>(\n\t\tid: string\n\t): Promise<{\n\t\tissuer: string;\n\t\tissuerIdentityId: string;\n\t\ttag: string;\n\t\timmutableMetadata?: T;\n\t\tmetadata?: U;\n\t}>;\n\n\t/**\n\t * Burn an NFT.\n\t * @param controller The controller of the NFT who can make changes.\n\t * @param id The id of the NFT to burn in urn format.\n\t * @returns A promise that resolves when the NFT has been permanently destroyed.\n\t */\n\tburn(controller: string, id: string): Promise<void>;\n\n\t/**\n\t * Transfer an NFT.\n\t * @param controllerIdentity The controller of the NFT who can make changes.\n\t * @param id The id of the NFT to transfer in urn format.\n\t * @param recipientAddress The recipient address for the NFT.\n\t * @param metadata Optional mutable data to include during the transfer.\n\t * @returns A promise that resolves when the NFT ownership has been transferred.\n\t */\n\ttransfer<U = unknown>(\n\t\tcontrollerIdentity: string,\n\t\tid: string,\n\t\trecipientAddress: string,\n\t\tmetadata?: U\n\t): Promise<void>;\n\n\t/**\n\t * Update the mutable data of the NFT.\n\t * @param controllerIdentity The controller of the NFT who can make changes.\n\t * @param id The id of the NFT to update in urn format.\n\t * @param metadata The mutable data to update.\n\t * @returns A promise that resolves when the NFT metadata has been updated.\n\t */\n\tupdate<U = unknown>(controllerIdentity: string, id: string, metadata: U): Promise<void>;\n}\n"]}

package/dist/es/models/api/INftBurnRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"INftBurnRequest.js","sourceRoot":"","sources":["../../../../src/models/api/INftBurnRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Burn the NFT.\n */\nexport interface INftBurnRequest {\n\t/**\n\t * The data to be used for resolving.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the NFT to burn.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}
+{"version":3,"file":"INftBurnRequest.js","sourceRoot":"","sources":["../../../../src/models/api/INftBurnRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to burn an NFT.\n */\nexport interface INftBurnRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the NFT to burn.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

package/dist/es/models/api/INftMintRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"INftMintRequest.js","sourceRoot":"","sources":["../../../../src/models/api/INftMintRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Mint the data and return the NFT id.\n */\nexport interface INftMintRequest {\n\t/**\n\t * The data to be used in the minting.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The tag for the NFT.\n\t\t */\n\t\ttag: string;\n\n\t\t/**\n\t\t * The immutable metadata for the NFT.\n\t\t */\n\t\timmutableMetadata?: unknown;\n\n\t\t/**\n\t\t * The metadata for the NFT.\n\t\t */\n\t\tmetadata?: unknown;\n\n\t\t/**\n\t\t * The namespace of the connector to use for the NFT, defaults to component configured namespace.\n\t\t */\n\t\tnamespace?: string;\n\t};\n}\n"]}
+{"version":3,"file":"INftMintRequest.js","sourceRoot":"","sources":["../../../../src/models/api/INftMintRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to mint a new NFT.\n */\nexport interface INftMintRequest {\n\t/**\n\t * The request body containing minting parameters.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The tag for the NFT.\n\t\t */\n\t\ttag: string;\n\n\t\t/**\n\t\t * The immutable metadata for the NFT.\n\t\t */\n\t\timmutableMetadata?: unknown;\n\n\t\t/**\n\t\t * The metadata for the NFT.\n\t\t */\n\t\tmetadata?: unknown;\n\n\t\t/**\n\t\t * The namespace of the connector to use for the NFT, defaults to component configured namespace.\n\t\t */\n\t\tnamespace?: string;\n\t};\n}\n"]}

package/dist/es/models/api/INftResolveRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"INftResolveRequest.js","sourceRoot":"","sources":["../../../../src/models/api/INftResolveRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Resolve the NFT.\n */\nexport interface INftResolveRequest {\n\t/**\n\t * The data to be used for resolving.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the NFT to resolve.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}
+{"version":3,"file":"INftResolveRequest.js","sourceRoot":"","sources":["../../../../src/models/api/INftResolveRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to resolve an NFT by its id.\n */\nexport interface INftResolveRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the NFT to resolve.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

package/dist/es/models/api/INftResolveResponse.js.map

@@ -1 +1 @@
-{"version":3,"file":"INftResolveResponse.js","sourceRoot":"","sources":["../../../../src/models/api/INftResolveResponse.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Response to resolving the NFT.\n */\nexport interface INftResolveResponse {\n\t/**\n\t * The data that was resolved.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The issuer of the NFT.\n\t\t */\n\t\tissuer: string;\n\n\t\t/**\n\t\t * The on-chain Object ID of the verified IOTA Identity that minted this NFT.\n\t\t * Empty string when not minted with identity verification.\n\t\t */\n\t\tissuerIdentityId: string;\n\n\t\t/**\n\t\t * The tag data for the NFT.\n\t\t */\n\t\ttag: string;\n\n\t\t/**\n\t\t * The immutable data for the NFT.\n\t\t */\n\t\timmutableMetadata?: unknown;\n\n\t\t/**\n\t\t * The metadata for the NFT.\n\t\t */\n\t\tmetadata?: unknown;\n\t};\n}\n"]}
+{"version":3,"file":"INftResolveResponse.js","sourceRoot":"","sources":["../../../../src/models/api/INftResolveResponse.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Response returned after resolving an NFT.\n */\nexport interface INftResolveResponse {\n\t/**\n\t * The resolved NFT data.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The issuer of the NFT.\n\t\t */\n\t\tissuer: string;\n\n\t\t/**\n\t\t * The on-chain Object ID of the verified IOTA Identity that minted this NFT.\n\t\t * Empty string when not minted with identity verification.\n\t\t */\n\t\tissuerIdentityId: string;\n\n\t\t/**\n\t\t * The tag data for the NFT.\n\t\t */\n\t\ttag: string;\n\n\t\t/**\n\t\t * The immutable data for the NFT.\n\t\t */\n\t\timmutableMetadata?: unknown;\n\n\t\t/**\n\t\t * The metadata for the NFT.\n\t\t */\n\t\tmetadata?: unknown;\n\t};\n}\n"]}

package/dist/es/models/api/INftTransferRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"INftTransferRequest.js","sourceRoot":"","sources":["../../../../src/models/api/INftTransferRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Transfer the NFT and update the metadata.\n */\nexport interface INftTransferRequest {\n\t/**\n\t * The data to be used in the transfer.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the NFT to transfer in urn format.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The data to be used in the transfer.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The recipient address for the NFT.\n\t\t */\n\t\trecipientAddress: string;\n\n\t\t/**\n\t\t * The metadata for the NFT.\n\t\t */\n\t\tmetadata?: unknown;\n\t};\n}\n"]}
+{"version":3,"file":"INftTransferRequest.js","sourceRoot":"","sources":["../../../../src/models/api/INftTransferRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to transfer an NFT to a new owner.\n */\nexport interface INftTransferRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the NFT to transfer in urn format.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The request body containing transfer parameters.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The recipient address for the NFT.\n\t\t */\n\t\trecipientAddress: string;\n\n\t\t/**\n\t\t * The metadata for the NFT.\n\t\t */\n\t\tmetadata?: unknown;\n\t};\n}\n"]}

package/dist/es/models/api/INftUpdateRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"INftUpdateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/INftUpdateRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Update the mutable data for the NFT.\n */\nexport interface INftUpdateRequest {\n\t/**\n\t * The data to be used in the update.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the NFT to transfer in urn format.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The data to be used in the update.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The metadata for the NFT.\n\t\t */\n\t\tmetadata?: unknown;\n\t};\n}\n"]}
+{"version":3,"file":"INftUpdateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/INftUpdateRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to update the mutable metadata of an NFT.\n */\nexport interface INftUpdateRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the NFT to update in urn format.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The request body containing update parameters.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The metadata for the NFT.\n\t\t */\n\t\tmetadata?: unknown;\n\t};\n}\n"]}

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

@@ -1,6 +1,6 @@
 /**
- * Model defining the IRC27 NFT Standards.
- * https://docs.iota.org/developer/references/framework/stardust/irc27
+ * Model defining the IRC27 NFT metadata standard.
+ * @see https://docs.iota.org/developer/references/framework/stardust/irc27
  */
 export interface IIrc27Metadata {
     /**

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

@@ -30,7 +30,7 @@ export interface INftComponent extends IComponent {
      * Burn an NFT.
      * @param id The id of the NFT to burn in urn format.
      * @param controllerIdentity The identity to perform the nft operation with.
-     * @returns Nothing.
+     * @returns A promise that resolves when the NFT has been permanently destroyed.
      */
     burn(id: string, controllerIdentity?: string): Promise<void>;
     /**
@@ -39,7 +39,7 @@ export interface INftComponent extends IComponent {
      * @param recipientAddress The recipient address for the NFT.
      * @param metadata Optional mutable data to include during the transfer.
      * @param controllerIdentity The identity to perform the nft operation with.
-     * @returns Nothing.
+     * @returns A promise that resolves when the NFT ownership has been transferred.
      */
     transfer<U = unknown>(id: string, recipientAddress: string, metadata?: U, controllerIdentity?: string): Promise<void>;
     /**
@@ -47,7 +47,7 @@ export interface INftComponent extends IComponent {
      * @param id The id of the NFT to update in urn format.
      * @param metadata The mutable data to update.
      * @param controllerIdentity The identity to perform the nft operation with.
-     * @returns Nothing.
+     * @returns A promise that resolves when the NFT metadata has been updated.
      */
     update<U = unknown>(id: string, metadata: U, controllerIdentity?: string): Promise<void>;
 }

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

@@ -28,7 +28,7 @@ export interface INftConnector extends IComponent {
      * Burn an NFT.
      * @param controller The controller of the NFT who can make changes.
      * @param id The id of the NFT to burn in urn format.
-     * @returns Nothing.
+     * @returns A promise that resolves when the NFT has been permanently destroyed.
      */
     burn(controller: string, id: string): Promise<void>;
     /**
@@ -37,7 +37,7 @@ export interface INftConnector extends IComponent {
      * @param id The id of the NFT to transfer in urn format.
      * @param recipientAddress The recipient address for the NFT.
      * @param metadata Optional mutable data to include during the transfer.
-     * @returns Nothing.
+     * @returns A promise that resolves when the NFT ownership has been transferred.
      */
     transfer<U = unknown>(controllerIdentity: string, id: string, recipientAddress: string, metadata?: U): Promise<void>;
     /**
@@ -45,7 +45,7 @@ export interface INftConnector extends IComponent {
      * @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.
+     * @returns A promise that resolves when the NFT metadata has been updated.
      */
     update<U = unknown>(controllerIdentity: string, id: string, metadata: U): Promise<void>;
 }

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

@@ -1,9 +1,9 @@
 /**
- * Burn the NFT.
+ * Request to burn an NFT.
  */
 export interface INftBurnRequest {
     /**
-     * The data to be used for resolving.
+     * The path parameters for the request.
      */
     pathParams: {
         /**

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

@@ -1,9 +1,9 @@
 /**
- * Mint the data and return the NFT id.
+ * Request to mint a new NFT.
  */
 export interface INftMintRequest {
     /**
-     * The data to be used in the minting.
+     * The request body containing minting parameters.
      */
     body: {
         /**

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

@@ -1,9 +1,9 @@
 /**
- * Resolve the NFT.
+ * Request to resolve an NFT by its id.
  */
 export interface INftResolveRequest {
     /**
-     * The data to be used for resolving.
+     * The path parameters for the request.
      */
     pathParams: {
         /**

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

@@ -1,9 +1,9 @@
 /**
- * Response to resolving the NFT.
+ * Response returned after resolving an NFT.
  */
 export interface INftResolveResponse {
     /**
-     * The data that was resolved.
+     * The resolved NFT data.
      */
     body: {
         /**

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

@@ -1,9 +1,9 @@
 /**
- * Transfer the NFT and update the metadata.
+ * Request to transfer an NFT to a new owner.
  */
 export interface INftTransferRequest {
     /**
-     * The data to be used in the transfer.
+     * The path parameters for the request.
      */
     pathParams: {
         /**
@@ -12,7 +12,7 @@ export interface INftTransferRequest {
         id: string;
     };
     /**
-     * The data to be used in the transfer.
+     * The request body containing transfer parameters.
      */
     body: {
         /**

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

@@ -1,18 +1,18 @@
 /**
- * Update the mutable data for the NFT.
+ * Request to update the mutable metadata of an NFT.
  */
 export interface INftUpdateRequest {
     /**
-     * The data to be used in the update.
+     * The path parameters for the request.
      */
     pathParams: {
         /**
-         * The id of the NFT to transfer in urn format.
+         * The id of the NFT to update in urn format.
          */
         id: string;
     };
     /**
-     * The data to be used in the update.
+     * The request body containing update parameters.
      */
     body: {
         /**

package/docs/changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.0.3-next.9](https://github.com/iotaledger/twin-nft/compare/nft-models-v0.0.3-next.8...nft-models-v0.0.3-next.9) (2026-06-17)
+
+
+### Miscellaneous Chores
+
+* **nft-models:** Synchronize repo versions
+
 ## [0.0.3-next.8](https://github.com/iotaledger/twin-nft/compare/nft-models-v0.0.3-next.7...nft-models-v0.0.3-next.8) (2026-06-11)
 
 

package/docs/reference/interfaces/IIrc27Metadata.md

@@ -1,6 +1,9 @@
 # Interface: IIrc27Metadata
 
-Model defining the IRC27 NFT Standards.
+Model defining the IRC27 NFT metadata standard.
+
+## See
+
 https://docs.iota.org/developer/references/framework/stardust/irc27
 
 ## Properties

package/docs/reference/interfaces/INftBurnRequest.md

@@ -1,6 +1,6 @@
 # Interface: INftBurnRequest
 
-Burn the NFT.
+Request to burn an NFT.
 
 ## Properties
 
@@ -8,7 +8,7 @@ Burn the NFT.
 
 > **pathParams**: `object`
 
-The data to be used for resolving.
+The path parameters for the request.
 
 #### id
 

package/docs/reference/interfaces/INftComponent.md

@@ -126,7 +126,7 @@ The identity to perform the nft operation with.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the NFT has been permanently destroyed.
 
 ***
 
@@ -172,7 +172,7 @@ The identity to perform the nft operation with.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the NFT ownership has been transferred.
 
 ***
 
@@ -212,4 +212,4 @@ The identity to perform the nft operation with.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the NFT metadata has been updated.

package/docs/reference/interfaces/INftConnector.md

@@ -114,7 +114,7 @@ The id of the NFT to burn in urn format.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the NFT has been permanently destroyed.
 
 ***
 
@@ -160,7 +160,7 @@ Optional mutable data to include during the transfer.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the NFT ownership has been transferred.
 
 ***
 
@@ -200,4 +200,4 @@ The mutable data to update.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the NFT metadata has been updated.

package/docs/reference/interfaces/INftMintRequest.md

@@ -1,6 +1,6 @@
 # Interface: INftMintRequest
 
-Mint the data and return the NFT id.
+Request to mint a new NFT.
 
 ## Properties
 
@@ -8,7 +8,7 @@ Mint the data and return the NFT id.
 
 > **body**: `object`
 
-The data to be used in the minting.
+The request body containing minting parameters.
 
 #### tag
 

package/docs/reference/interfaces/INftResolveRequest.md

@@ -1,6 +1,6 @@
 # Interface: INftResolveRequest
 
-Resolve the NFT.
+Request to resolve an NFT by its id.
 
 ## Properties
 
@@ -8,7 +8,7 @@ Resolve the NFT.
 
 > **pathParams**: `object`
 
-The data to be used for resolving.
+The path parameters for the request.
 
 #### id
 

package/docs/reference/interfaces/INftResolveResponse.md

@@ -1,6 +1,6 @@
 # Interface: INftResolveResponse
 
-Response to resolving the NFT.
+Response returned after resolving an NFT.
 
 ## Properties
 
@@ -8,7 +8,7 @@ Response to resolving the NFT.
 
 > **body**: `object`
 
-The data that was resolved.
+The resolved NFT data.
 
 #### issuer
 

package/docs/reference/interfaces/INftTransferRequest.md

@@ -1,6 +1,6 @@
 # Interface: INftTransferRequest
 
-Transfer the NFT and update the metadata.
+Request to transfer an NFT to a new owner.
 
 ## Properties
 
@@ -8,7 +8,7 @@ Transfer the NFT and update the metadata.
 
 > **pathParams**: `object`
 
-The data to be used in the transfer.
+The path parameters for the request.
 
 #### id
 
@@ -22,7 +22,7 @@ The id of the NFT to transfer in urn format.
 
 > **body**: `object`
 
-The data to be used in the transfer.
+The request body containing transfer parameters.
 
 #### recipientAddress
 

package/docs/reference/interfaces/INftUpdateRequest.md

@@ -1,6 +1,6 @@
 # Interface: INftUpdateRequest
 
-Update the mutable data for the NFT.
+Request to update the mutable metadata of an NFT.
 
 ## Properties
 
@@ -8,13 +8,13 @@ Update the mutable data for the NFT.
 
 > **pathParams**: `object`
 
-The data to be used in the update.
+The path parameters for the request.
 
 #### id
 
 > **id**: `string`
 
-The id of the NFT to transfer in urn format.
+The id of the NFT to update in urn format.
 
 ***
 
@@ -22,7 +22,7 @@ The id of the NFT to transfer in urn format.
 
 > **body**: `object`
 
-The data to be used in the update.
+The request body containing update parameters.
 
 #### metadata?
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/nft-models",
-	"version": "0.0.3-next.8",
+	"version": "0.0.3-next.9",
 	"description": "Shared NFT interfaces, request and response models, and connector contracts.",
 	"repository": {
 		"type": "git",