@twin.org/blob-storage-connector-ipfs 0.0.1-next.9 → 0.0.2-next.1

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,160 @@
 # @twin.org/blob-storage-connector-ipfs - Changelog
 
-## v0.0.1-next.9
+## [0.0.2-next.1](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-ipfs-v0.0.2-next.0...blob-storage-connector-ipfs-v0.0.2-next.1) (2025-07-24)
+
+
+### Features
+
+* update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
+* use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.2-next.0 to 0.0.2-next.1
+
+## 0.0.1 (2025-07-04)
+
+
+### Features
+
+* release to production ([eacfe75](https://github.com/twinfoundation/blob-storage/commit/eacfe754a0dcd9243d9e13d86422327d0a605164))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from ^0.0.0 to ^0.0.1
+
+## [0.0.1-next.37](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-ipfs-v0.0.1-next.36...blob-storage-connector-ipfs-v0.0.1-next.37) (2025-06-20)
+
+
+### Miscellaneous Chores
+
+* **blob-storage-connector-ipfs:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.36 to 0.0.1-next.37
+
+## [0.0.1-next.36](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-ipfs-v0.0.1-next.35...blob-storage-connector-ipfs-v0.0.1-next.36) (2025-06-19)
+
+
+### Miscellaneous Chores
+
+* **blob-storage-connector-ipfs:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.35 to 0.0.1-next.36
+
+## [0.0.1-next.35](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-ipfs-v0.0.1-next.34...blob-storage-connector-ipfs-v0.0.1-next.35) (2025-06-17)
+
+
+### Miscellaneous Chores
+
+* **blob-storage-connector-ipfs:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.34 to 0.0.1-next.35
+
+## [0.0.1-next.34](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-ipfs-v0.0.1-next.33...blob-storage-connector-ipfs-v0.0.1-next.34) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.33 to 0.0.1-next.34
+
+## [0.0.1-next.33](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-ipfs-v0.0.1-next.32...blob-storage-connector-ipfs-v0.0.1-next.33) (2025-06-03)
+
+
+### Miscellaneous Chores
+
+* **blob-storage-connector-ipfs:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.32 to 0.0.1-next.33
+
+## [0.0.1-next.32](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-ipfs-v0.0.1-next.31...blob-storage-connector-ipfs-v0.0.1-next.32) (2025-05-28)
+
+
+### Miscellaneous Chores
+
+* **blob-storage-connector-ipfs:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.31 to 0.0.1-next.32
+
+## [0.0.1-next.31](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-ipfs-v0.0.1-next.30...blob-storage-connector-ipfs-v0.0.1-next.31) (2025-05-08)
+
+
+### Miscellaneous Chores
+
+* **blob-storage-connector-ipfs:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.30 to 0.0.1-next.31
+
+## [0.0.1-next.30](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-ipfs-v0.0.1-next.29...blob-storage-connector-ipfs-v0.0.1-next.30) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.29 to 0.0.1-next.30
+
+## [0.0.1-next.29](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-ipfs-v0.0.1-next.28...blob-storage-connector-ipfs-v0.0.1-next.29) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **blob-storage-connector-ipfs:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.28 to 0.0.1-next.29
+
+## v0.0.1-next.28
 
 - Initial Release

package/docs/reference/classes/IpfsBlobStorageConnector.md

@@ -9,25 +9,23 @@ See https://docs.ipfs.tech/reference/kubo/rpc/ for more information.
 
 ## Constructors
 
-### new IpfsBlobStorageConnector()
+### Constructor
 
-> **new IpfsBlobStorageConnector**(`options`): [`IpfsBlobStorageConnector`](IpfsBlobStorageConnector.md)
+> **new IpfsBlobStorageConnector**(`options`): `IpfsBlobStorageConnector`
 
 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
 
-[`IpfsBlobStorageConnector`](IpfsBlobStorageConnector.md)
+`IpfsBlobStorageConnector`
 
 ## Properties
 
@@ -59,7 +57,9 @@ Set the blob.
 
 #### Parameters
 
-• **blob**: `Uint8Array`
+##### blob
+
+`Uint8Array`
 
 The data for the blob.
 
@@ -77,19 +77,21 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`): `Promise`\<`undefined` \| `Uint8Array`\>
+> **get**(`id`): `Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
 
 Get the blob.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the blob to get in urn format.
 
 #### Returns
 
-`Promise`\<`undefined` \| `Uint8Array`\>
+`Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
 
 The data for the blob if it can be found or undefined.
 
@@ -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/locales/en.json

@@ -2,7 +2,7 @@
 	"error": {
 		"ipfsBlobStorageConnector": {
 			"namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the blob storage \"{namespace}\"",
-			"fetchFail": "Failure during IPFS fetch \"{message}\"",
+			"fetchFail": "Failure during IPFS request",
 			"setBlobFailed": "Failed to store blob in IPFS",
 			"getBlobFailed": "Failed to get blob from IPFS",
 			"removeBlobFailed": "Failed to remove blob from IPFS"

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-connector-ipfs",
-	"version": "0.0.1-next.9",
+	"version": "0.0.2-next.1",
 	"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.9",
+		"@twin.org/blob-storage-models": "0.0.2-next.1",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/nameof": "next",
@@ -25,11 +25,11 @@
 	"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",