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

package/dist/cjs/index.cjs

@@ -2,6 +2,7 @@
 
 var apiCore = require('@twin.org/api-core');
 var core = require('@twin.org/core');
+var web = require('@twin.org/web');
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -22,26 +23,23 @@ class NftClient extends apiCore.BaseRestClient {
     }
     /**
      * 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.
      * @param namespace The namespace of the connector to use for the NFT, defaults to component configured namespace.
      * @returns The id of the created NFT in urn format.
      */
-    async mint(issuer, tag, immutableMetadata, metadata, namespace) {
-        core.Guards.stringValue(this.CLASS_NAME, "issuer", issuer);
+    async mint(tag, immutableMetadata, metadata, namespace) {
         core.Guards.stringValue(this.CLASS_NAME, "tag", tag);
         const response = await this.fetch("/", "POST", {
             body: {
-                issuer,
                 tag,
                 immutableMetadata,
                 metadata,
                 namespace
             }
         });
-        return response.headers.Location;
+        return response.headers[web.HeaderTypes.Location];
     }
     /**
      * Resolve an NFT.
@@ -73,19 +71,22 @@ class NftClient extends apiCore.BaseRestClient {
     /**
      * 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.
      * @returns Nothing.
      */
-    async transfer(id, recipient, metadata) {
+    async transfer(id, recipientIdentity, recipientAddress, metadata) {
         core.Guards.stringValue(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);
         await this.fetch("/:id/transfer", "POST", {
             pathParams: {
                 id
             },
             body: {
-                recipient,
+                recipientIdentity,
+                recipientAddress,
                 metadata
             }
         });

package/dist/esm/index.mjs

@@ -1,5 +1,6 @@
 import { BaseRestClient } from '@twin.org/api-core';
 import { Guards, Urn } from '@twin.org/core';
+import { HeaderTypes } from '@twin.org/web';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -20,26 +21,23 @@ class NftClient extends BaseRestClient {
     }
     /**
      * 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.
      * @param namespace The namespace of the connector to use for the NFT, defaults to component configured namespace.
      * @returns The id of the created NFT in urn format.
      */
-    async mint(issuer, tag, immutableMetadata, metadata, namespace) {
-        Guards.stringValue(this.CLASS_NAME, "issuer", issuer);
+    async mint(tag, immutableMetadata, metadata, namespace) {
         Guards.stringValue(this.CLASS_NAME, "tag", tag);
         const response = await this.fetch("/", "POST", {
             body: {
-                issuer,
                 tag,
                 immutableMetadata,
                 metadata,
                 namespace
             }
         });
-        return response.headers.Location;
+        return response.headers[HeaderTypes.Location];
     }
     /**
      * Resolve an NFT.
@@ -71,19 +69,22 @@ class NftClient extends BaseRestClient {
     /**
      * 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.
      * @returns Nothing.
      */
-    async transfer(id, recipient, metadata) {
+    async transfer(id, recipientIdentity, recipientAddress, metadata) {
         Guards.stringValue(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);
         await this.fetch("/:id/transfer", "POST", {
             pathParams: {
                 id
             },
             body: {
-                recipient,
+                recipientIdentity,
+                recipientAddress,
                 metadata
             }
         });

package/dist/types/nftClient.d.ts

@@ -16,14 +16,13 @@ export declare class NftClient extends BaseRestClient implements INftComponent {
     constructor(config: IBaseRestClientConfig);
     /**
      * 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.
      * @param namespace The namespace of the connector to use for the NFT, defaults to component configured namespace.
      * @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): Promise<string>;
+    mint<T = unknown, U = unknown>(tag: string, immutableMetadata?: T, metadata?: U, namespace?: string): Promise<string>;
     /**
      * Resolve an NFT.
      * @param id The id of the NFT to resolve.
@@ -45,16 +44,17 @@ export declare class NftClient extends BaseRestClient 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.
      * @returns Nothing.
      */
-    transfer<T = unknown>(id: string, recipient: string, metadata?: T): Promise<void>;
+    transfer<T = unknown>(id: string, recipientIdentity: string, recipientAddress: string, metadata?: T): Promise<void>;
     /**
      * Update the data of the NFT.
      * @param id The id of the NFT to update in urn format.
      * @param metadata The mutable data to update.
      * @returns Nothing.
      */
-    update<T = unknown>(id: string, metadata: T): Promise<void>;
+    update<U = unknown>(id: string, metadata: U): Promise<void>;
 }

package/docs/changelog.md

@@ -1,5 +1,103 @@
 # @twin.org/nft-rest-client - Changelog
 
-## v0.0.1-next.3
+## [0.0.1-next.30](https://github.com/twinfoundation/nft/compare/nft-rest-client-v0.0.1-next.29...nft-rest-client-v0.0.1-next.30) (2025-05-22)
+
+
+### Miscellaneous Chores
+
+* **nft-rest-client:** 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
+
+## [0.0.1-next.29](https://github.com/twinfoundation/nft/compare/nft-rest-client-v0.0.1-next.28...nft-rest-client-v0.0.1-next.29) (2025-05-21)
+
+
+### Miscellaneous Chores
+
+* **nft-rest-client:** 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
+
+## [0.0.1-next.28](https://github.com/twinfoundation/nft/compare/nft-rest-client-v0.0.1-next.27...nft-rest-client-v0.0.1-next.28) (2025-05-06)
+
+
+### Miscellaneous Chores
+
+* **nft-rest-client:** Synchronize repo versions
+
+
+### 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
+
+## [0.0.1-next.27](https://github.com/twinfoundation/nft/compare/nft-rest-client-v0.0.1-next.26...nft-rest-client-v0.0.1-next.27) (2025-04-24)
+
+
+### Miscellaneous Chores
+
+* **nft-rest-client:** 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
+
+## [0.0.1-next.26](https://github.com/twinfoundation/nft/compare/nft-rest-client-v0.0.1-next.25...nft-rest-client-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
+
+## [0.0.1-next.25](https://github.com/twinfoundation/nft/compare/nft-rest-client-v0.0.1-next.24...nft-rest-client-v0.0.1-next.25) (2025-04-17)
+
+
+### Miscellaneous Chores
+
+* **nft-rest-client:** 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
+
+## [0.0.1-next.24](https://github.com/twinfoundation/nft/compare/nft-rest-client-v0.0.1-next.23...nft-rest-client-v0.0.1-next.24) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **nft-rest-client:** 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
+
+## v0.0.1-next.23
 
 - Initial Release

package/docs/reference/classes/NftClient.md

@@ -12,21 +12,23 @@ Client for performing NFT through to REST endpoints.
 
 ## Constructors
 
-### new NftClient()
+### Constructor
 
-> **new NftClient**(`config`): [`NftClient`](NftClient.md)
+> **new NftClient**(`config`): `NftClient`
 
 Create a new instance of NftClient.
 
 #### Parameters
 
-• **config**: `IBaseRestClientConfig`
+##### config
+
+`IBaseRestClientConfig`
 
 The configuration for the client.
 
 #### Returns
 
-[`NftClient`](NftClient.md)
+`NftClient`
 
 #### Overrides
 
@@ -48,35 +50,43 @@ Runtime name for the class.
 
 ### mint()
 
-> **mint**\<`T`, `U`\>(`issuer`, `tag`, `immutableMetadata`?, `metadata`?, `namespace`?): `Promise`\<`string`\>
+> **mint**\<`T`, `U`\>(`tag`, `immutableMetadata?`, `metadata?`, `namespace?`): `Promise`\<`string`\>
 
 Mint an NFT.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
 
-• **U** = `unknown`
+`T` = `unknown`
 
-#### Parameters
+##### U
 
-• **issuer**: `string`
+`U` = `unknown`
 
-The issuer for the NFT, will also be the initial owner.
+#### Parameters
+
+##### 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.
 
@@ -94,48 +104,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
 
-• **U** = `unknown`
+`T` = `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`
-
 #### Implementation of
 
 `INftComponent.resolve`
@@ -150,7 +146,9 @@ Burn an NFT.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the NFT to burn in urn format.
 
@@ -168,25 +166,39 @@ Nothing.
 
 ### transfer()
 
-> **transfer**\<`T`\>(`id`, `recipient`, `metadata`?): `Promise`\<`void`\>
+> **transfer**\<`T`\>(`id`, `recipientIdentity`, `recipientAddress`, `metadata?`): `Promise`\<`void`\>
 
 Transfer an NFT.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **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?
+
+`T`
 
 Optional mutable data to include during the transfer.
 
@@ -204,21 +216,27 @@ Nothing.
 
 ### update()
 
-> **update**\<`T`\>(`id`, `metadata`): `Promise`\<`void`\>
+> **update**\<`U`\>(`id`, `metadata`): `Promise`\<`void`\>
 
 Update the 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.
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/nft-rest-client",
-	"version": "0.0.1-next.3",
+	"version": "0.0.1-next.30",
 	"description": "NFT contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -13,50 +13,25 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
-	"scripts": {
-		"clean": "rimraf dist coverage docs/reference",
-		"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/api-models": "next",
 		"@twin.org/api-core": "next",
+		"@twin.org/api-models": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/nft-models": "0.0.1-next.3"
-	},
-	"devDependencies": {
-		"@twin.org/nameof-transformer": "next",
-		"@vitest/coverage-v8": "2.1.1",
-		"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"
+		"@twin.org/nft-models": "0.0.1-next.30",
+		"@twin.org/web": "next"
 	},
 	"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"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",