@twin.org/nft-rest-client 0.0.2-next.8 → 0.0.3-next.1

package/dist/es/index.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./nftRestClient.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,oBAAoB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./nftRestClient.js\";\n"]}

package/dist/{esm/index.mjs → es/nftRestClient.js}

@@ -1,24 +1,30 @@
-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.
+import { BaseRestClient } from "@twin.org/api-core";
+import { Guards, Urn } from "@twin.org/core";
+import { HeaderTypes } from "@twin.org/web";
 /**
  * Client for performing NFT through to REST endpoints.
  */
-class NftRestClient extends BaseRestClient {
+export class NftRestClient extends BaseRestClient {
     /**
      * Runtime name for the class.
      */
     static CLASS_NAME = "NftRestClient";
     /**
-     * Create a new instance of NftClient.
+     * Create a new instance of NftRestClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
         super("NftRestClient", config, "nft");
     }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return NftRestClient.CLASS_NAME;
+    }
     /**
      * Mint an NFT.
      * @param tag The tag for the NFT.
@@ -108,5 +114,4 @@ class NftRestClient extends BaseRestClient {
         });
     }
 }
-
-export { NftRestClient };
+//# sourceMappingURL=nftRestClient.js.map

package/dist/es/nftRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nftRestClient.js","sourceRoot":"","sources":["../../src/nftRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAW7C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,cAAc;IAChD;;OAEG;IACI,MAAM,CAAU,UAAU,mBAAmC;IAEpE;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,kBAA0B,MAAM,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,aAAa,CAAC,UAAU,CAAC;IACjC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,IAAI,CAChB,GAAW,EACX,iBAAqB,EACrB,QAAY,EACZ,SAAkB;QAElB,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAE/D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAoC,GAAG,EAAE,MAAM,EAAE;YACjF,IAAI,EAAE;gBACL,GAAG;gBACH,iBAAiB;gBACjB,QAAQ;gBACR,SAAS;aACT;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CACnB,EAAU;QAQV,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAE7D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAA0C,MAAM,EAAE,KAAK,EAAE;YACzF,UAAU,EAAE;gBACX,EAAE;aACF;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAMf,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,EAAU;QAC3B,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAEpD,MAAM,IAAI,CAAC,KAAK,CAAyB,MAAM,EAAE,QAAQ,EAAE;YAC1D,UAAU,EAAE;gBACX,EAAE;aACF;SACD,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,QAAQ,CACpB,EAAU,EACV,iBAAyB,EACzB,gBAAwB,EACxB,QAAY;QAEZ,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAC7D,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,UAAU,uBAA6B,iBAAiB,CAAC,CAAC;QAC3F,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,UAAU,sBAA4B,gBAAgB,CAAC,CAAC;QAEzF,MAAM,IAAI,CAAC,KAAK,CAA6B,eAAe,EAAE,MAAM,EAAE;YACrE,UAAU,EAAE;gBACX,EAAE;aACF;YACD,IAAI,EAAE;gBACL,iBAAiB;gBACjB,gBAAgB;gBAChB,QAAQ;aACR;SACD,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAc,EAAU,EAAE,QAAW;QACvD,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAC7D,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAEpE,MAAM,IAAI,CAAC,KAAK,CAA2B,MAAM,EAAE,KAAK,EAAE;YACzD,UAAU,EAAE;gBACX,EAAE;aACF;YACD,IAAI,EAAE;gBACL,QAAQ;aACR;SACD,CAAC,CAAC;IACJ,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport type { IBaseRestClientConfig, ICreatedResponse } from \"@twin.org/api-models\";\nimport { Guards, Urn } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type {\n\tINftBurnRequest,\n\tINftComponent,\n\tINftMintRequest,\n\tINftResolveRequest,\n\tINftResolveResponse,\n\tINftTransferRequest,\n\tINftUpdateRequest\n} from \"@twin.org/nft-models\";\nimport { HeaderTypes } from \"@twin.org/web\";\n\n/**\n * Client for performing NFT through to REST endpoints.\n */\nexport class NftRestClient extends BaseRestClient implements INftComponent {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<NftRestClient>();\n\n\t/**\n\t * Create a new instance of NftRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(nameof<NftRestClient>(), config, \"nft\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn NftRestClient.CLASS_NAME;\n\t}\n\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 * @returns The id of the created NFT in urn format.\n\t */\n\tpublic async mint<T = unknown, U = unknown>(\n\t\ttag: string,\n\t\timmutableMetadata?: T,\n\t\tmetadata?: U,\n\t\tnamespace?: string\n\t): Promise<string> {\n\t\tGuards.stringValue(NftRestClient.CLASS_NAME, nameof(tag), tag);\n\n\t\tconst response = await this.fetch<INftMintRequest, ICreatedResponse>(\"/\", \"POST\", {\n\t\t\tbody: {\n\t\t\t\ttag,\n\t\t\t\timmutableMetadata,\n\t\t\t\tmetadata,\n\t\t\t\tnamespace\n\t\t\t}\n\t\t});\n\n\t\treturn response.headers[HeaderTypes.Location];\n\t}\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\tpublic async resolve<T = unknown, U = unknown>(\n\t\tid: string\n\t): Promise<{\n\t\tissuer: string;\n\t\towner: string;\n\t\ttag: string;\n\t\timmutableMetadata?: T;\n\t\tmetadata?: U;\n\t}> {\n\t\tGuards.stringValue(NftRestClient.CLASS_NAME, nameof(id), id);\n\n\t\tconst response = await this.fetch<INftResolveRequest, INftResolveResponse>(\"/:id\", \"GET\", {\n\t\t\tpathParams: {\n\t\t\t\tid\n\t\t\t}\n\t\t});\n\n\t\treturn response.body as {\n\t\t\tissuer: string;\n\t\t\towner: string;\n\t\t\ttag: string;\n\t\t\timmutableMetadata?: T;\n\t\t\tmetadata?: U;\n\t\t};\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 * @returns Nothing.\n\t */\n\tpublic async burn(id: string): Promise<void> {\n\t\tUrn.guard(NftRestClient.CLASS_NAME, nameof(id), id);\n\n\t\tawait this.fetch<INftBurnRequest, never>(\"/:id\", \"DELETE\", {\n\t\t\tpathParams: {\n\t\t\t\tid\n\t\t\t}\n\t\t});\n\t}\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 recipientIdentity The recipient identity for the NFT.\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\tpublic async transfer<T = unknown>(\n\t\tid: string,\n\t\trecipientIdentity: string,\n\t\trecipientAddress: string,\n\t\tmetadata?: T\n\t): Promise<void> {\n\t\tGuards.stringValue(NftRestClient.CLASS_NAME, nameof(id), id);\n\t\tGuards.stringValue(NftRestClient.CLASS_NAME, nameof(recipientIdentity), recipientIdentity);\n\t\tGuards.stringValue(NftRestClient.CLASS_NAME, nameof(recipientAddress), recipientAddress);\n\n\t\tawait this.fetch<INftTransferRequest, never>(\"/:id/transfer\", \"POST\", {\n\t\t\tpathParams: {\n\t\t\t\tid\n\t\t\t},\n\t\t\tbody: {\n\t\t\t\trecipientIdentity,\n\t\t\t\trecipientAddress,\n\t\t\t\tmetadata\n\t\t\t}\n\t\t});\n\t}\n\n\t/**\n\t * Update the 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 * @returns Nothing.\n\t */\n\tpublic async update<U = unknown>(id: string, metadata: U): Promise<void> {\n\t\tGuards.stringValue(NftRestClient.CLASS_NAME, nameof(id), id);\n\t\tGuards.object(NftRestClient.CLASS_NAME, nameof(metadata), metadata);\n\n\t\tawait this.fetch<INftUpdateRequest, never>(\"/:id\", \"PUT\", {\n\t\t\tpathParams: {\n\t\t\t\tid\n\t\t\t},\n\t\t\tbody: {\n\t\t\t\tmetadata\n\t\t\t}\n\t\t});\n\t}\n}\n"]}

package/dist/types/index.d.ts

@@ -1 +1 @@
-export * from "./nftRestClient";
+export * from "./nftRestClient.js";

package/dist/types/nftRestClient.d.ts

@@ -10,10 +10,15 @@ export declare class NftRestClient extends BaseRestClient implements INftCompone
      */
     static readonly CLASS_NAME: string;
     /**
-     * Create a new instance of NftClient.
+     * Create a new instance of NftRestClient.
      * @param config The configuration for the client.
      */
     constructor(config: IBaseRestClientConfig);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Mint an NFT.
      * @param tag The tag for the NFT.

package/docs/changelog.md

@@ -1,5 +1,24 @@
 # @twin.org/nft-rest-client - Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/nft/compare/nft-rest-client-v0.0.3-next.0...nft-rest-client-v0.0.3-next.1) (2025-11-12)
+
+
+### Features
+
+* add context id features ([#50](https://github.com/twinfoundation/nft/issues/50)) ([56c31c7](https://github.com/twinfoundation/nft/commit/56c31c7ba10e3ef8ad44f6463153f90888e64711))
+* add validate-locales ([0055a56](https://github.com/twinfoundation/nft/commit/0055a56ed166946f1db860aa0725ad53248b3427))
+* eslint migration to flat config ([0e6fc12](https://github.com/twinfoundation/nft/commit/0e6fc128c3c8f6cd34db793787437dd4af2c9994))
+* update dependencies ([8660f76](https://github.com/twinfoundation/nft/commit/8660f76ca324b0f476e45544cac6bee4b3146c3b))
+* update framework core ([f3496b6](https://github.com/twinfoundation/nft/commit/f3496b61bfebbb3479bb92df39ecfa9ac8d90b9b))
+* 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.3-next.0 to 0.0.3-next.1
+
 ## [0.0.2-next.8](https://github.com/twinfoundation/nft/compare/nft-rest-client-v0.0.2-next.7...nft-rest-client-v0.0.2-next.8) (2025-10-09)
 
 

package/docs/reference/classes/NftRestClient.md

@@ -16,7 +16,7 @@ Client for performing NFT through to REST endpoints.
 
 > **new NftRestClient**(`config`): `NftRestClient`
 
-Create a new instance of NftClient.
+Create a new instance of NftRestClient.
 
 #### Parameters
 
@@ -44,6 +44,24 @@ Runtime name for the class.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`INftComponent.className`
+
+***
+
 ### mint()
 
 > **mint**\<`T`, `U`\>(`tag`, `immutableMetadata?`, `metadata?`, `namespace?`): `Promise`\<`string`\>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/nft-rest-client",
-	"version": "0.0.2-next.8",
+	"version": "0.0.3-next.1",
 	"description": "NFT contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -19,23 +19,21 @@
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/nft-models": "0.0.2-next.8",
+		"@twin.org/nft-models": "0.0.3-next.1",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"

package/dist/cjs/index.cjs

@@ -1,114 +0,0 @@
-'use strict';
-
-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.
-/**
- * Client for performing NFT through to REST endpoints.
- */
-class NftRestClient extends apiCore.BaseRestClient {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "NftRestClient";
-    /**
-     * Create a new instance of NftClient.
-     * @param config The configuration for the client.
-     */
-    constructor(config) {
-        super("NftRestClient", config, "nft");
-    }
-    /**
-     * Mint an NFT.
-     * @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(tag, immutableMetadata, metadata, namespace) {
-        core.Guards.stringValue(NftRestClient.CLASS_NAME, "tag", tag);
-        const response = await this.fetch("/", "POST", {
-            body: {
-                tag,
-                immutableMetadata,
-                metadata,
-                namespace
-            }
-        });
-        return response.headers[web.HeaderTypes.Location];
-    }
-    /**
-     * Resolve an NFT.
-     * @param id The id of the NFT to resolve.
-     * @returns The data for the NFT.
-     */
-    async resolve(id) {
-        core.Guards.stringValue(NftRestClient.CLASS_NAME, "id", id);
-        const response = await this.fetch("/:id", "GET", {
-            pathParams: {
-                id
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Burn an NFT.
-     * @param id The id of the NFT to burn in urn format.
-     * @returns Nothing.
-     */
-    async burn(id) {
-        core.Urn.guard(NftRestClient.CLASS_NAME, "id", id);
-        await this.fetch("/:id", "DELETE", {
-            pathParams: {
-                id
-            }
-        });
-    }
-    /**
-     * Transfer an NFT.
-     * @param id The id of the NFT to transfer in urn format.
-     * @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, recipientIdentity, recipientAddress, metadata) {
-        core.Guards.stringValue(NftRestClient.CLASS_NAME, "id", id);
-        core.Guards.stringValue(NftRestClient.CLASS_NAME, "recipientIdentity", recipientIdentity);
-        core.Guards.stringValue(NftRestClient.CLASS_NAME, "recipientAddress", recipientAddress);
-        await this.fetch("/:id/transfer", "POST", {
-            pathParams: {
-                id
-            },
-            body: {
-                recipientIdentity,
-                recipientAddress,
-                metadata
-            }
-        });
-    }
-    /**
-     * 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.
-     */
-    async update(id, metadata) {
-        core.Guards.stringValue(NftRestClient.CLASS_NAME, "id", id);
-        core.Guards.object(NftRestClient.CLASS_NAME, "metadata", metadata);
-        await this.fetch("/:id", "PUT", {
-            pathParams: {
-                id
-            },
-            body: {
-                metadata
-            }
-        });
-    }
-}
-
-exports.NftRestClient = NftRestClient;