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

package/docs/reference/classes/NftService.md

@@ -0,0 +1,257 @@
+# Class: NftService
+
+Service for performing NFT operations to a connector.
+
+## Implements
+
+- `INftComponent`
+
+## Constructors
+
+### new NftService()
+
+> **new NftService**(`options`?): [`NftService`](NftService.md)
+
+Create a new instance of NftService.
+
+#### Parameters
+
+• **options?**
+
+The options for the service.
+
+• **options.config?**: [`INftServiceConfig`](../interfaces/INftServiceConfig.md)
+
+The configuration for the service.
+
+#### Returns
+
+[`NftService`](NftService.md)
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"nft"`
+
+The namespace supported by the nft service.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`INftComponent.CLASS_NAME`
+
+## Methods
+
+### mint()
+
+> **mint**\<`T`, `U`\>(`issuer`, `tag`, `immutableMetadata`?, `metadata`?, `namespace`?, `identity`?): `Promise`\<`string`\>
+
+Mint an NFT.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+• **U** = `unknown`
+
+#### Parameters
+
+• **issuer**: `string`
+
+The issuer for the NFT, will also be the initial owner.
+
+• **tag**: `string`
+
+The tag for the NFT.
+
+• **immutableMetadata?**: `T`
+
+The immutable metadata for the NFT.
+
+• **metadata?**: `U`
+
+The metadata for the NFT.
+
+• **namespace?**: `string`
+
+The namespace of the connector to use for the NFT, defaults to service configured namespace.
+
+• **identity?**: `string`
+
+The identity to perform the nft operation on.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The id of the created NFT in urn format.
+
+#### Implementation of
+
+`INftComponent.mint`
+
+***
+
+### resolve()
+
+> **resolve**\<`T`, `U`\>(`id`, `identity`?): `Promise`\<`object`\>
+
+Resolve an NFT.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+• **U** = `unknown`
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the NFT to resolve.
+
+• **identity?**: `string`
+
+The identity to perform the nft operation on.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+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`
+
+***
+
+### burn()
+
+> **burn**(`id`, `identity`?): `Promise`\<`void`\>
+
+Burn an NFT.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the NFT to burn in urn format.
+
+• **identity?**: `string`
+
+The identity to perform the nft operation on.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`INftComponent.burn`
+
+***
+
+### transfer()
+
+> **transfer**\<`T`\>(`id`, `recipient`, `metadata`?, `identity`?): `Promise`\<`void`\>
+
+Transfer an NFT.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the NFT to transfer in urn format.
+
+• **recipient**: `string`
+
+The recipient of the NFT.
+
+• **metadata?**: `T`
+
+Optional mutable data to include during the transfer.
+
+• **identity?**: `string`
+
+The identity to perform the nft operation on.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`INftComponent.transfer`
+
+***
+
+### update()
+
+> **update**\<`T`\>(`id`, `metadata`, `identity`?): `Promise`\<`void`\>
+
+Update the data of the NFT.
+
+#### Type Parameters
+
+• **T** = `unknown`
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the NFT to update in urn format.
+
+• **metadata**: `T`
+
+The mutable data to update.
+
+• **identity?**: `string`
+
+The identity to perform the nft operation on.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`INftComponent.update`

package/docs/reference/functions/generateRestRoutesNft.md

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

package/docs/reference/functions/nftBurn.md

@@ -0,0 +1,25 @@
+# Function: nftBurn()
+
+> **nftBurn**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Burn an NFT.
+
+## Parameters
+
+• **httpRequestContext**: `IHttpRequestContext`
+
+The request context for the API.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes.
+
+• **request**: `INftBurnRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/nftMint.md

@@ -0,0 +1,25 @@
+# Function: nftMint()
+
+> **nftMint**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`ICreatedResponse`\>
+
+Mint an NFT.
+
+## Parameters
+
+• **httpRequestContext**: `IHttpRequestContext`
+
+The request context for the API.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes.
+
+• **request**: `INftMintRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`ICreatedResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/nftResolve.md

@@ -0,0 +1,25 @@
+# Function: nftResolve()
+
+> **nftResolve**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INftResolveResponse`\>
+
+Resolve an NFT.
+
+## Parameters
+
+• **httpRequestContext**: `IHttpRequestContext`
+
+The request context for the API.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes.
+
+• **request**: `INftResolveRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INftResolveResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/nftTransfer.md

@@ -0,0 +1,25 @@
+# Function: nftTransfer()
+
+> **nftTransfer**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Transfer an NFT.
+
+## Parameters
+
+• **httpRequestContext**: `IHttpRequestContext`
+
+The request context for the API.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes.
+
+• **request**: `INftTransferRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/nftUpdate.md

@@ -0,0 +1,25 @@
+# Function: nftUpdate()
+
+> **nftUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Update an NFT.
+
+## Parameters
+
+• **httpRequestContext**: `IHttpRequestContext`
+
+The request context for the API.
+
+• **componentName**: `string`
+
+The name of the component to use in the routes.
+
+• **request**: `INftUpdateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -0,0 +1,23 @@
+# @twin.org/nft-service
+
+## Classes
+
+- [NftService](classes/NftService.md)
+
+## Interfaces
+
+- [INftServiceConfig](interfaces/INftServiceConfig.md)
+
+## Variables
+
+- [tagsNft](variables/tagsNft.md)
+- [restEntryPoints](variables/restEntryPoints.md)
+
+## Functions
+
+- [generateRestRoutesNft](functions/generateRestRoutesNft.md)
+- [nftMint](functions/nftMint.md)
+- [nftResolve](functions/nftResolve.md)
+- [nftBurn](functions/nftBurn.md)
+- [nftTransfer](functions/nftTransfer.md)
+- [nftUpdate](functions/nftUpdate.md)

package/docs/reference/interfaces/INftServiceConfig.md

@@ -0,0 +1,11 @@
+# Interface: INftServiceConfig
+
+Configuration for the NFT Service.
+
+## Properties
+
+### defaultNamespace?
+
+> `optional` **defaultNamespace**: `string`
+
+What is the default connector to use for NFT. If not provided the first connector from the factory will be used.

package/docs/reference/variables/restEntryPoints.md

@@ -0,0 +1,3 @@
+# Variable: restEntryPoints
+
+> `const` **restEntryPoints**: `IRestRouteEntryPoint`[]

package/docs/reference/variables/tagsNft.md

@@ -0,0 +1,5 @@
+# Variable: tagsNft
+
+> `const` **tagsNft**: `ITag`[]
+
+The tag to associate with the routes.

package/locales/en.json

@@ -0,0 +1,13 @@
+{
+	"error": {
+		"nftService": {
+			"namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the NFT service \"{namespace}\"",
+			"noConnectors": "There are no connectors registered with the nft factory",
+			"mintFailed": "The minting of the NFT failed",
+			"resolveFailed": "The resolving of the NFT failed",
+			"burnFailed": "The burning of the NFT failed",
+			"transferFailed": "The transfer of the NFT failed",
+			"updateFailed": "The update of the NFT failed"
+		}
+	}
+}

package/package.json

@@ -0,0 +1,71 @@
+{
+	"name": "@twin.org/nft-service",
+	"version": "0.0.1-next.3",
+	"description": "NFT contract implementation and REST endpoint definitions",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/nft.git",
+		"directory": "packages/nft-service"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"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/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": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}