@twin.org/nft-service 0.0.1-next.6 → 0.0.1-next.7

package/dist/cjs/index.cjs

@@ -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();

package/dist/esm/index.mjs

@@ -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();

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,11 +15,8 @@ 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.

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/nft-service - Changelog
 
-## v0.0.1-next.6
+## v0.0.1-next.7
 
 - Initial Release

package/docs/reference/classes/NftService.md

@@ -16,13 +16,11 @@ 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
 
@@ -64,27 +62,39 @@ Mint an NFT.
 
 #### Parameters
 
-• **issuer**: `string`
+##### issuer
+
+`string`
 
 The issuer for the NFT, will also be the initial owner.
 
-• **tag**: `string`
+##### tag
+
+`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,7 +112,7 @@ 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.
 
@@ -114,40 +124,24 @@ Resolve an NFT.
 
 #### 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`
@@ -162,11 +156,15 @@ 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.
 
@@ -194,19 +192,27 @@ Transfer an NFT.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the NFT to transfer in urn format.
 
-• **recipient**: `string`
+##### recipient
+
+`string`
 
 The recipient of the NFT.
 
-• **metadata?**: `T`
+##### metadata?
+
+`T`
 
 Optional mutable data to include during the transfer.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the nft operation on.
 
@@ -234,15 +240,21 @@ Update the data of the NFT.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the NFT to update in urn format.
 
-• **metadata**: `T`
+##### metadata
+
+`T`
 
 The mutable data to update.
 
-• **identity?**: `string`
+##### identity?
+
+`string`
 
 The identity to perform the nft operation on.
 

package/docs/reference/functions/generateRestRoutesNft.md

@@ -6,11 +6,15 @@ 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.
 

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.6",
+	"version": "0.0.1-next.7",
 	"description": "NFT contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -18,7 +18,7 @@
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/nft-models": "0.0.1-next.6",
+		"@twin.org/nft-models": "0.0.1-next.7",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/cjs/index.cjs",