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

package/docs/reference/classes/NftService.md

@@ -8,25 +8,23 @@ Service for performing NFT operations to a connector.
 
 ## Constructors
 
-### new NftService()
+### Constructor
 
-> **new NftService**(`options`?): [`NftService`](NftService.md)
+> **new NftService**(`options?`): `NftService`
 
 Create a new instance of NftService.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The options for the service.
-
-• **options.config?**: [`INftServiceConfig`](../interfaces/INftServiceConfig.md)
+[`INftServiceConstructorOptions`](../interfaces/INftServiceConstructorOptions.md)
 
-The configuration for the service.
+The options for the service.
 
 #### Returns
 
-[`NftService`](NftService.md)
+`NftService`
 
 ## Properties
 
@@ -52,39 +50,49 @@ Runtime name for the class.
 
 ### 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 service configured namespace.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the nft operation on.
 
@@ -102,52 +110,40 @@ The id of the created NFT in urn format.
 
 ### resolve()
 
-> **resolve**\<`T`, `U`\>(`id`, `identity`?): `Promise`\<`object`\>
+> **resolve**\<`T`, `U`\>(`id`, `identity?`): `Promise`\<\{ `issuer`: `string`; `owner`: `string`; `tag`: `string`; `immutableMetadata`: `T`; `metadata`: `U`; \}\>
 
 Resolve an NFT.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
+
+##### U
 
-• **U** = `unknown`
+`U` = `unknown`
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the NFT to resolve.
 
-• **identity?**: `string`
+##### identity?
+
+`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`
-
 #### Implementation of
 
 `INftComponent.resolve`
@@ -156,17 +152,21 @@ The data for the NFT.
 
 ### burn()
 
-> **burn**(`id`, `identity`?): `Promise`\<`void`\>
+> **burn**(`id`, `identity?`): `Promise`\<`void`\>
 
 Burn an NFT.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the NFT to burn in urn format.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the nft operation on.
 
@@ -184,29 +184,45 @@ Nothing.
 
 ### transfer()
 
-> **transfer**\<`T`\>(`id`, `recipient`, `metadata`?, `identity`?): `Promise`\<`void`\>
+> **transfer**\<`U`\>(`id`, `recipientIdentity`, `recipientAddress`, `metadata?`, `identity?`): `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
 
-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.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the nft operation on.
 
@@ -224,25 +240,33 @@ Nothing.
 
 ### update()
 
-> **update**\<`T`\>(`id`, `metadata`, `identity`?): `Promise`\<`void`\>
+> **update**\<`U`\>(`id`, `metadata`, `identity?`): `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.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the nft operation on.
 

package/docs/reference/functions/generateRestRoutesNft.md

@@ -1,21 +1,25 @@
 # Function: generateRestRoutesNft()
 
-> **generateRestRoutesNft**(`baseRouteName`, `componentName`): `IRestRoute`[]
+> **generateRestRoutesNft**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
 
 The REST routes for NFT.
 
 ## Parameters
 
-• **baseRouteName**: `string`
+### baseRouteName
+
+`string`
 
 Prefix to prepend to the paths.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes stored in the ComponentFactory.
 
 ## Returns
 
-`IRestRoute`[]
+`IRestRoute`\<`any`, `any`\>[]
 
 The generated routes.

package/docs/reference/functions/nftBurn.md

@@ -6,15 +6,21 @@ Burn an NFT.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `INftBurnRequest`
+### request
+
+`INftBurnRequest`
 
 The request.
 

package/docs/reference/functions/nftMint.md

@@ -6,15 +6,21 @@ Mint an NFT.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `INftMintRequest`
+### request
+
+`INftMintRequest`
 
 The request.
 

package/docs/reference/functions/nftResolve.md

@@ -6,15 +6,21 @@ Resolve an NFT.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `INftResolveRequest`
+### request
+
+`INftResolveRequest`
 
 The request.
 

package/docs/reference/functions/nftTransfer.md

@@ -6,15 +6,21 @@ Transfer an NFT.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `INftTransferRequest`
+### request
+
+`INftTransferRequest`
 
 The request.
 

package/docs/reference/functions/nftUpdate.md

@@ -6,15 +6,21 @@ Update an NFT.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `INftUpdateRequest`
+### request
+
+`INftUpdateRequest`
 
 The request.
 

package/docs/reference/index.md

@@ -7,6 +7,7 @@
 ## Interfaces
 
 - [INftServiceConfig](interfaces/INftServiceConfig.md)
+- [INftServiceConstructorOptions](interfaces/INftServiceConstructorOptions.md)
 
 ## Variables
 

package/docs/reference/interfaces/INftServiceConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: INftServiceConstructorOptions
+
+Options for the nft service constructor.
+
+## Properties
+
+### config?
+
+> `optional` **config**: [`INftServiceConfig`](INftServiceConfig.md)
+
+The configuration for the service.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/nft-service",
-	"version": "0.0.1-next.3",
+	"version": "0.0.1-next.30",
 	"description": "NFT contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -13,53 +13,24 @@
 	"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:api": "ts-to-openapi ./ts-to-openapi.json ./docs/open-api/spec.json",
-		"docs": "npm run docs:clean && npm run docs:generate && npm run docs:api",
-		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
-	},
 	"dependencies": {
 		"@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",
+		"@twin.org/nft-models": "0.0.1-next.30",
 		"@twin.org/web": "next"
 	},
-	"devDependencies": {
-		"@twin.org/nameof-transformer": "next",
-		"@twin.org/nft-connector-entity-storage": "0.0.1-next.3",
-		"@twin.org/ts-to-openapi": "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"
-	},
 	"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",