@twin.org/blob-storage-connector-ipfs 0.0.1-next.16 → 0.0.1-next.18

package/dist/cjs/index.cjs

@@ -24,7 +24,6 @@ class IpfsBlobStorageConnector {
     /**
      * Create a new instance of IpfsBlobStorageConnector.
      * @param options The options for the connector.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         core.Guards.object(this.CLASS_NAME, "options", options);

package/dist/esm/index.mjs

@@ -22,7 +22,6 @@ class IpfsBlobStorageConnector {
     /**
      * Create a new instance of IpfsBlobStorageConnector.
      * @param options The options for the connector.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         Guards.object(this.CLASS_NAME, "options", options);

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./ipfsBlobStorageConnector";
 export * from "./models/IIpfsBlobStorageConnectorConfig";
+export * from "./models/IIpfsBlobStorageConnectorConstructorOptions";

package/dist/types/ipfsBlobStorageConnector.d.ts

@@ -1,5 +1,5 @@
 import type { IBlobStorageConnector } from "@twin.org/blob-storage-models";
-import type { IIpfsBlobStorageConnectorConfig } from "./models/IIpfsBlobStorageConnectorConfig";
+import type { IIpfsBlobStorageConnectorConstructorOptions } from "./models/IIpfsBlobStorageConnectorConstructorOptions";
 /**
  * Class for performing blob storage operations on IPFS.
  * See https://docs.ipfs.tech/reference/kubo/rpc/ for more information.
@@ -16,11 +16,8 @@ export declare class IpfsBlobStorageConnector implements IBlobStorageConnector {
     /**
      * Create a new instance of IpfsBlobStorageConnector.
      * @param options The options for the connector.
-     * @param options.config The configuration for the connector.
      */
-    constructor(options: {
-        config: IIpfsBlobStorageConnectorConfig;
-    });
+    constructor(options: IIpfsBlobStorageConnectorConstructorOptions);
     /**
      * Set the blob.
      * @param blob The data for the blob.

package/dist/types/models/IIpfsBlobStorageConnectorConstructorOptions.d.ts

@@ -0,0 +1,10 @@
+import type { IIpfsBlobStorageConnectorConfig } from "./IIpfsBlobStorageConnectorConfig";
+/**
+ * Options for the IPFS Blob Storage Connector constructor.
+ */
+export interface IIpfsBlobStorageConnectorConstructorOptions {
+    /**
+     * The configuration for the connector.
+     */
+    config: IIpfsBlobStorageConnectorConfig;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/blob-storage-connector-ipfs - Changelog
 
-## v0.0.1-next.16
+## v0.0.1-next.18
 
 - Initial Release

package/docs/reference/classes/IpfsBlobStorageConnector.md

@@ -17,13 +17,11 @@ Create a new instance of IpfsBlobStorageConnector.
 
 #### Parameters
 
-• **options**
+##### options
 
-The options for the connector.
-
-• **options.config**: [`IIpfsBlobStorageConnectorConfig`](../interfaces/IIpfsBlobStorageConnectorConfig.md)
+[`IIpfsBlobStorageConnectorConstructorOptions`](../interfaces/IIpfsBlobStorageConnectorConstructorOptions.md)
 
-The configuration for the connector.
+The options for the connector.
 
 #### Returns
 
@@ -59,7 +57,9 @@ Set the blob.
 
 #### Parameters
 
-• **blob**: `Uint8Array`
+##### blob
+
+`Uint8Array`
 
 The data for the blob.
 
@@ -83,7 +83,9 @@ Get the blob.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the blob to get in urn format.
 
@@ -107,7 +109,9 @@ Remove the blob.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the blob to remove in urn format.
 

package/docs/reference/index.md

@@ -7,3 +7,4 @@
 ## Interfaces
 
 - [IIpfsBlobStorageConnectorConfig](interfaces/IIpfsBlobStorageConnectorConfig.md)
+- [IIpfsBlobStorageConnectorConstructorOptions](interfaces/IIpfsBlobStorageConnectorConstructorOptions.md)

package/docs/reference/interfaces/IIpfsBlobStorageConnectorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IIpfsBlobStorageConnectorConstructorOptions
+
+Options for the IPFS Blob Storage Connector constructor.
+
+## Properties
+
+### config
+
+> **config**: [`IIpfsBlobStorageConnectorConfig`](IIpfsBlobStorageConnectorConfig.md)
+
+The configuration for the connector.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-connector-ipfs",
-	"version": "0.0.1-next.16",
+	"version": "0.0.1-next.18",
 	"description": "Blob Storage connector implementation using IPFS",
 	"repository": {
 		"type": "git",
@@ -14,7 +14,7 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/blob-storage-models": "0.0.1-next.16",
+		"@twin.org/blob-storage-models": "0.0.1-next.18",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/nameof": "next",