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

package/dist/cjs/index.cjs

@@ -38,7 +38,6 @@ function generateRestRoutesNft(baseRouteName, componentName) {
                     id: "nftMintExample",
                     request: {
                         body: {
-                            issuer: "tst1prctjk5ck0dutnsunnje6u90jk5htx03qznjjmkd6843pzltlgz87srjzzv",
                             tag: "MY-NFT",
                             immutableMetadata: {
                                 docName: "bill-of-lading",
@@ -98,8 +97,8 @@ function generateRestRoutesNft(baseRouteName, componentName) {
                         id: "nftResolveResponseExample",
                         response: {
                             body: {
-                                issuer: "tst1prctjk5ck0dutnsunnje6u90jk5htx03qznjjmkd6843pzltlgz87srjzzv",
-                                owner: "tst1prctjk5ck0dutnsunnje6u90jk5htx03qznjjmkd6843pzltlgz87srjzzv",
+                                issuer: "did:iota:tst:0x85ef62ea94fc4eeeeeddf6acc3b566e988e613081d0b93cc54ed831ed4c18d44",
+                                owner: "did:iota:tst:0x85ef62ea94fc4eeeeeddf6acc3b566e988e613081d0b93cc54ed831ed4c18d44",
                                 tag: "MY-NFT",
                                 immutableMetadata: {
                                     docName: "bill-of-lading",
@@ -159,7 +158,8 @@ function generateRestRoutesNft(baseRouteName, componentName) {
                             id: "nft:iota:aW90YS1uZnQ6dHN0OjB4NzYyYjljNDllYTg2OWUwZWJkYTliYmZhNzY5Mzk0NDdhNDI4ZGNmMTc4YzVkMTVhYjQ0N2UyZDRmYmJiNGViMg=="
                         },
                         body: {
-                            recipient: "tst1prctjk5ck0dutnsunnje6u90jk5htx03qznjjmkd6843pzltlgz87srjzzv",
+                            recipientIdentity: "did:iota:tst:0x85ef62ea94fc4eeeeeddf6acc3b566e988e613081d0b93cc54ed831ed4c18d44",
+                            recipientAddress: "tst1prctjk5ck0dutnsunnje6u90jk5htx03qznjjmkd6843pzltlgz87srjzzv",
                             metadata: {
                                 data: "AAAAA"
                             }
@@ -217,10 +217,9 @@ function generateRestRoutesNft(baseRouteName, componentName) {
 async function nftMint(httpRequestContext, componentName, request) {
     core.Guards.object(ROUTES_SOURCE, "request", request);
     core.Guards.object(ROUTES_SOURCE, "request.body", request.body);
-    core.Guards.stringValue(ROUTES_SOURCE, "request.body.issuer", request.body.issuer);
     core.Guards.stringValue(ROUTES_SOURCE, "request.body.tag", request.body.tag);
     const component = core.ComponentFactory.get(componentName);
-    const id = await component.mint(request.body.issuer, request.body.tag, request.body.immutableMetadata, request.body.metadata, request.body.namespace, httpRequestContext.userIdentity);
+    const id = await component.mint(request.body.tag, request.body.immutableMetadata, request.body.metadata, request.body.namespace, httpRequestContext.userIdentity);
     return {
         statusCode: web.HttpStatusCode.created,
         headers: {
@@ -274,9 +273,10 @@ async function nftTransfer(httpRequestContext, componentName, request) {
     core.Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
     core.Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
     core.Guards.object(ROUTES_SOURCE, "request.body", request.body);
-    core.Guards.stringValue(ROUTES_SOURCE, "request.body.recipient", request.body.recipient);
+    core.Guards.stringValue(ROUTES_SOURCE, "request.body.recipientAddress", request.body.recipientAddress);
+    core.Guards.stringValue(ROUTES_SOURCE, "request.body.recipientIdentity", request.body.recipientIdentity);
     const component = core.ComponentFactory.get(componentName);
-    await component.transfer(request.pathParams.id, request.body.recipient, request.body.metadata, httpRequestContext.userIdentity);
+    await component.transfer(request.pathParams.id, request.body.recipientIdentity, request.body.recipientAddress, request.body.metadata, httpRequestContext.userIdentity);
     return {
         statusCode: web.HttpStatusCode.noContent
     };
@@ -323,7 +323,6 @@ class NftService {
     /**
      * Create a new instance of NftService.
      * @param options The options for the service.
-     * @param options.config The configuration for the service.
      */
     constructor(options) {
         const names = nftModels.NftConnectorFactory.names();
@@ -334,7 +333,6 @@ class NftService {
     }
     /**
      * 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.
@@ -342,14 +340,13 @@ class NftService {
      * @param identity The identity to perform the nft operation on.
      * @returns The id of the created NFT in urn format.
      */
-    async mint(issuer, tag, immutableMetadata, metadata, namespace, identity) {
-        core.Guards.stringValue(this.CLASS_NAME, "issuer", issuer);
+    async mint(tag, immutableMetadata, metadata, namespace, identity) {
         core.Guards.stringValue(this.CLASS_NAME, "tag", tag);
         core.Guards.stringValue(this.CLASS_NAME, "identity", identity);
         try {
             const connectorNamespace = namespace ?? this._defaultNamespace;
             const nftConnector = nftModels.NftConnectorFactory.get(connectorNamespace);
-            const nftUrn = await nftConnector.mint(identity, issuer, tag, immutableMetadata, metadata);
+            const nftUrn = await nftConnector.mint(identity, tag, immutableMetadata, metadata);
             return nftUrn;
         }
         catch (error) {
@@ -392,18 +389,20 @@ class NftService {
     /**
      * 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.
      * @returns Nothing.
      */
-    async transfer(id, recipient, metadata, identity) {
+    async transfer(id, recipientIdentity, recipientAddress, metadata, identity) {
         core.Urn.guard(this.CLASS_NAME, "id", id);
-        core.Guards.stringValue(this.CLASS_NAME, "recipient", recipient);
+        core.Guards.stringValue(this.CLASS_NAME, "recipientIdentity", recipientIdentity);
+        core.Guards.stringValue(this.CLASS_NAME, "recipientAddress", recipientAddress);
         core.Guards.stringValue(this.CLASS_NAME, "identity", identity);
         try {
             const nftConnector = this.getConnector(id);
-            await nftConnector.transfer(identity, id, recipient, metadata);
+            await nftConnector.transfer(identity, id, recipientIdentity, recipientAddress, metadata);
         }
         catch (error) {
             throw new core.GeneralError(this.CLASS_NAME, "transferFailed", undefined, error);

package/dist/esm/index.mjs

@@ -36,7 +36,6 @@ function generateRestRoutesNft(baseRouteName, componentName) {
                     id: "nftMintExample",
                     request: {
                         body: {
-                            issuer: "tst1prctjk5ck0dutnsunnje6u90jk5htx03qznjjmkd6843pzltlgz87srjzzv",
                             tag: "MY-NFT",
                             immutableMetadata: {
                                 docName: "bill-of-lading",
@@ -96,8 +95,8 @@ function generateRestRoutesNft(baseRouteName, componentName) {
                         id: "nftResolveResponseExample",
                         response: {
                             body: {
-                                issuer: "tst1prctjk5ck0dutnsunnje6u90jk5htx03qznjjmkd6843pzltlgz87srjzzv",
-                                owner: "tst1prctjk5ck0dutnsunnje6u90jk5htx03qznjjmkd6843pzltlgz87srjzzv",
+                                issuer: "did:iota:tst:0x85ef62ea94fc4eeeeeddf6acc3b566e988e613081d0b93cc54ed831ed4c18d44",
+                                owner: "did:iota:tst:0x85ef62ea94fc4eeeeeddf6acc3b566e988e613081d0b93cc54ed831ed4c18d44",
                                 tag: "MY-NFT",
                                 immutableMetadata: {
                                     docName: "bill-of-lading",
@@ -157,7 +156,8 @@ function generateRestRoutesNft(baseRouteName, componentName) {
                             id: "nft:iota:aW90YS1uZnQ6dHN0OjB4NzYyYjljNDllYTg2OWUwZWJkYTliYmZhNzY5Mzk0NDdhNDI4ZGNmMTc4YzVkMTVhYjQ0N2UyZDRmYmJiNGViMg=="
                         },
                         body: {
-                            recipient: "tst1prctjk5ck0dutnsunnje6u90jk5htx03qznjjmkd6843pzltlgz87srjzzv",
+                            recipientIdentity: "did:iota:tst:0x85ef62ea94fc4eeeeeddf6acc3b566e988e613081d0b93cc54ed831ed4c18d44",
+                            recipientAddress: "tst1prctjk5ck0dutnsunnje6u90jk5htx03qznjjmkd6843pzltlgz87srjzzv",
                             metadata: {
                                 data: "AAAAA"
                             }
@@ -215,10 +215,9 @@ function generateRestRoutesNft(baseRouteName, componentName) {
 async function nftMint(httpRequestContext, componentName, request) {
     Guards.object(ROUTES_SOURCE, "request", request);
     Guards.object(ROUTES_SOURCE, "request.body", request.body);
-    Guards.stringValue(ROUTES_SOURCE, "request.body.issuer", request.body.issuer);
     Guards.stringValue(ROUTES_SOURCE, "request.body.tag", request.body.tag);
     const component = ComponentFactory.get(componentName);
-    const id = await component.mint(request.body.issuer, request.body.tag, request.body.immutableMetadata, request.body.metadata, request.body.namespace, httpRequestContext.userIdentity);
+    const id = await component.mint(request.body.tag, request.body.immutableMetadata, request.body.metadata, request.body.namespace, httpRequestContext.userIdentity);
     return {
         statusCode: HttpStatusCode.created,
         headers: {
@@ -272,9 +271,10 @@ async function nftTransfer(httpRequestContext, componentName, request) {
     Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
     Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
     Guards.object(ROUTES_SOURCE, "request.body", request.body);
-    Guards.stringValue(ROUTES_SOURCE, "request.body.recipient", request.body.recipient);
+    Guards.stringValue(ROUTES_SOURCE, "request.body.recipientAddress", request.body.recipientAddress);
+    Guards.stringValue(ROUTES_SOURCE, "request.body.recipientIdentity", request.body.recipientIdentity);
     const component = ComponentFactory.get(componentName);
-    await component.transfer(request.pathParams.id, request.body.recipient, request.body.metadata, httpRequestContext.userIdentity);
+    await component.transfer(request.pathParams.id, request.body.recipientIdentity, request.body.recipientAddress, request.body.metadata, httpRequestContext.userIdentity);
     return {
         statusCode: HttpStatusCode.noContent
     };
@@ -321,7 +321,6 @@ class NftService {
     /**
      * Create a new instance of NftService.
      * @param options The options for the service.
-     * @param options.config The configuration for the service.
      */
     constructor(options) {
         const names = NftConnectorFactory.names();
@@ -332,7 +331,6 @@ class NftService {
     }
     /**
      * 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.
@@ -340,14 +338,13 @@ class NftService {
      * @param identity The identity to perform the nft operation on.
      * @returns The id of the created NFT in urn format.
      */
-    async mint(issuer, tag, immutableMetadata, metadata, namespace, identity) {
-        Guards.stringValue(this.CLASS_NAME, "issuer", issuer);
+    async mint(tag, immutableMetadata, metadata, namespace, identity) {
         Guards.stringValue(this.CLASS_NAME, "tag", tag);
         Guards.stringValue(this.CLASS_NAME, "identity", identity);
         try {
             const connectorNamespace = namespace ?? this._defaultNamespace;
             const nftConnector = NftConnectorFactory.get(connectorNamespace);
-            const nftUrn = await nftConnector.mint(identity, issuer, tag, immutableMetadata, metadata);
+            const nftUrn = await nftConnector.mint(identity, tag, immutableMetadata, metadata);
             return nftUrn;
         }
         catch (error) {
@@ -390,18 +387,20 @@ class NftService {
     /**
      * 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.
      * @returns Nothing.
      */
-    async transfer(id, recipient, metadata, identity) {
+    async transfer(id, recipientIdentity, recipientAddress, metadata, identity) {
         Urn.guard(this.CLASS_NAME, "id", id);
-        Guards.stringValue(this.CLASS_NAME, "recipient", recipient);
+        Guards.stringValue(this.CLASS_NAME, "recipientIdentity", recipientIdentity);
+        Guards.stringValue(this.CLASS_NAME, "recipientAddress", recipientAddress);
         Guards.stringValue(this.CLASS_NAME, "identity", identity);
         try {
             const nftConnector = this.getConnector(id);
-            await nftConnector.transfer(identity, id, recipient, metadata);
+            await nftConnector.transfer(identity, id, recipientIdentity, recipientAddress, metadata);
         }
         catch (error) {
             throw new GeneralError(this.CLASS_NAME, "transferFailed", undefined, error);

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./models/INftServiceConfig";
+export * from "./models/INftServiceConstructorOptions";
 export * from "./nftRoutes";
 export * from "./nftService";
 export * from "./restEntryPoints";

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

@@ -0,0 +1,10 @@
+import type { INftServiceConfig } from "./INftServiceConfig";
+/**
+ * Options for the nft service constructor.
+ */
+export interface INftServiceConstructorOptions {
+    /**
+     * The configuration for the service.
+     */
+    config?: INftServiceConfig;
+}

package/dist/types/nftService.d.ts

@@ -1,5 +1,5 @@
 import { type INftComponent } from "@twin.org/nft-models";
-import type { INftServiceConfig } from "./models/INftServiceConfig";
+import type { INftServiceConstructorOptions } from "./models/INftServiceConstructorOptions";
 /**
  * Service for performing NFT operations to a connector.
  */
@@ -15,14 +15,10 @@ export declare class NftService implements INftComponent {
     /**
      * Create a new instance of NftService.
      * @param options The options for the service.
-     * @param options.config The configuration for the service.
      */
-    constructor(options?: {
-        config?: INftServiceConfig;
-    });
+    constructor(options?: INftServiceConstructorOptions);
     /**
      * 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.
@@ -30,7 +26,7 @@ export declare class NftService implements INftComponent {
      * @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.
@@ -54,12 +50,13 @@ export declare class NftService implements INftComponent {
     /**
      * 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.
      * @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, identity?: string): Promise<void>;
     /**
      * Update the data of the NFT.
      * @param id The id of the NFT to update in urn format.
@@ -67,5 +64,5 @@ export declare class NftService implements INftComponent {
      * @param identity 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, identity?: string): Promise<void>;
 }

package/docs/changelog.md

@@ -1,5 +1,122 @@
 # @twin.org/nft-service - Changelog
 
-## v0.0.1-next.3
+## [0.0.1-next.30](https://github.com/twinfoundation/nft/compare/nft-service-v0.0.1-next.29...nft-service-v0.0.1-next.30) (2025-05-22)
+
+
+### Miscellaneous Chores
+
+* **nft-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nft-models bumped from 0.0.1-next.29 to 0.0.1-next.30
+  * devDependencies
+    * @twin.org/nft-connector-entity-storage bumped from 0.0.1-next.29 to 0.0.1-next.30
+
+## [0.0.1-next.29](https://github.com/twinfoundation/nft/compare/nft-service-v0.0.1-next.28...nft-service-v0.0.1-next.29) (2025-05-21)
+
+
+### Miscellaneous Chores
+
+* **nft-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nft-models bumped from 0.0.1-next.28 to 0.0.1-next.29
+  * devDependencies
+    * @twin.org/nft-connector-entity-storage bumped from 0.0.1-next.28 to 0.0.1-next.29
+
+## [0.0.1-next.28](https://github.com/twinfoundation/nft/compare/nft-service-v0.0.1-next.27...nft-service-v0.0.1-next.28) (2025-05-06)
+
+
+### Features
+
+* iota rebased release ([bfdd233](https://github.com/twinfoundation/nft/commit/bfdd23330e168962f7ad0a6fcd2c9c9a38a11697))
+
+
+### Bug Fixes
+
+* params order modified ([#19](https://github.com/twinfoundation/nft/issues/19)) ([c2ceb30](https://github.com/twinfoundation/nft/commit/c2ceb3040c12286d4fac09d51db77465366ba89d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nft-models bumped from 0.0.1-next.27 to 0.0.1-next.28
+  * devDependencies
+    * @twin.org/nft-connector-entity-storage bumped from 0.0.1-next.27 to 0.0.1-next.28
+
+## [0.0.1-next.27](https://github.com/twinfoundation/nft/compare/nft-service-v0.0.1-next.26...nft-service-v0.0.1-next.27) (2025-04-24)
+
+
+### Miscellaneous Chores
+
+* **nft-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nft-models bumped from 0.0.1-next.26 to 0.0.1-next.27
+  * devDependencies
+    * @twin.org/nft-connector-entity-storage bumped from 0.0.1-next.26 to 0.0.1-next.27
+
+## [0.0.1-next.26](https://github.com/twinfoundation/nft/compare/nft-service-v0.0.1-next.25...nft-service-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))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nft-models bumped from 0.0.1-next.25 to 0.0.1-next.26
+  * devDependencies
+    * @twin.org/nft-connector-entity-storage bumped from 0.0.1-next.25 to 0.0.1-next.26
+
+## [0.0.1-next.25](https://github.com/twinfoundation/nft/compare/nft-service-v0.0.1-next.24...nft-service-v0.0.1-next.25) (2025-04-17)
+
+
+### Miscellaneous Chores
+
+* **nft-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nft-models bumped from 0.0.1-next.24 to 0.0.1-next.25
+  * devDependencies
+    * @twin.org/nft-connector-entity-storage bumped from 0.0.1-next.24 to 0.0.1-next.25
+
+## [0.0.1-next.24](https://github.com/twinfoundation/nft/compare/nft-service-v0.0.1-next.23...nft-service-v0.0.1-next.24) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **nft-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/nft-models bumped from 0.0.1-next.23 to 0.0.1-next.24
+  * devDependencies
+    * @twin.org/nft-connector-entity-storage bumped from 0.0.1-next.23 to 0.0.1-next.24
+
+## v0.0.1-next.23
 
 - Initial Release