@twin.org/nft-service - npm Package Compare versions

Comparing version 0.0.1-next.6 to 0.0.1-next.7

dist/types/index.d.ts

 export * from "./models/INftServiceConfig";
+export * from "./models/INftServiceConstructorOptions";
 export * from "./nftRoutes";
 export * from "./nftService";
 export * from "./restEntryPoints";

dist/types/nftService.d.ts

 import { type INftComponent } from "@twin.org/nft-models";
-import type { INftServiceConfig } from "./models/INftServiceConfig";
+import type { INftServiceConstructorOptions } from "./models/INftServiceConstructorOptions";
 /**
@@ -18,7 +18,4 @@ * Service for performing NFT operations to a connector.
      * @param options The options for the service.
-     * @param options.config The configuration for the service.
      */
-    constructor(options?: {
-        config?: INftServiceConfig;
-    });
+    constructor(options?: INftServiceConstructorOptions);
     /**
@@ -25,0 +22,0 @@ * Mint an NFT.

docs/changelog.md

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

docs/reference/classes/NftService.md

@@ -19,10 +19,8 @@ # Class: NftService
 
-• **options?**
+##### options?
 
+[`INftServiceConstructorOptions`](../interfaces/INftServiceConstructorOptions.md)
+
 The options for the service.
 
-• **options.config?**: [`INftServiceConfig`](../interfaces/INftServiceConfig.md)
-
-The configuration for the service.
-
 #### Returns
@@ -68,24 +66,36 @@
 
-• **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.
@@ -107,3 +117,3 @@
 
-> **resolve**\<`T`, `U`\>(`id`, `identity`?): `Promise`\<`object`\>
+> **resolve**\<`T`, `U`\>(`id`, `identity`?): `Promise`\<\{ `issuer`: `string`; `owner`: `string`; `tag`: `string`; `immutableMetadata`: `T`; `metadata`: `U`; \}\>
 
@@ -120,8 +130,12 @@ Resolve an NFT.
 
-• **id**: `string`
+##### id
 
+`string`
+
 The id of the NFT to resolve.
 
-• **identity?**: `string`
+##### identity?
 
+`string`
+
 The identity to perform the nft operation on.
@@ -131,26 +145,6 @@
 
-`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
@@ -170,8 +164,12 @@
 
-• **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.
@@ -203,16 +201,24 @@
 
-• **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.
@@ -244,12 +250,18 @@
 
-• **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.
@@ -256,0 +268,0 @@

docs/reference/functions/generateRestRoutesNft.md

@@ -9,8 +9,12 @@ # Function: generateRestRoutesNft()
 
-• **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.
@@ -17,0 +21,0 @@

docs/reference/functions/nftBurn.md

@@ -9,12 +9,18 @@ # Function: nftBurn()
 
-• **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.
@@ -21,0 +27,0 @@

docs/reference/functions/nftMint.md

@@ -9,12 +9,18 @@ # Function: nftMint()
 
-• **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.
@@ -21,0 +27,0 @@

docs/reference/functions/nftResolve.md

@@ -9,12 +9,18 @@ # Function: nftResolve()
 
-• **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.
@@ -21,0 +27,0 @@

docs/reference/functions/nftTransfer.md

@@ -9,12 +9,18 @@ # Function: nftTransfer()
 
-• **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.
@@ -21,0 +27,0 @@

docs/reference/functions/nftUpdate.md

@@ -9,12 +9,18 @@ # Function: nftUpdate()
 
-• **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.
@@ -21,0 +27,0 @@

docs/reference/index.md

@@ -10,2 +10,3 @@ # @twin.org/nft-service
 - [INftServiceConfig](interfaces/INftServiceConfig.md)
+- [INftServiceConstructorOptions](interfaces/INftServiceConstructorOptions.md)
 
@@ -12,0 +13,0 @@ ## Variables

package.json

 {
 	"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",
@@ -21,3 +21,3 @@ "repository": {
 		"@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"
@@ -24,0 +24,0 @@ },

No alert changes

Improved metrics

Total package byte prevSize

92975

increased by0.28%

Number of package files

27

increased by8%

Lines of code

1755

increased by0.34%

Dependency changes

• + [e-mail]/nft-models@0.0.1-next.7(transitive)

• - [e-mail]/nft-models@0.0.1-next.6(transitive)

• [e-mail]/nft-models@0.0.1-next.7