@twin.org/blob-storage-connector-ipfs 0.0.1-next.3 → 0.0.1-next.31

package/README.md

@@ -13,7 +13,7 @@ npm install @twin.org/blob-storage-connector-ipfs
 The tests developed are functional tests and need an instance of IPFS up and running. To run IPFS locally:
 
 ```shell
-docker run -p 4001:4001 -p 4001:4001/udp -p 8080:8080 -p 5001:5001 --name ipfs --hostname ipfs -d ipfs/kubo:latest
+docker run -p 4001:4001 -p 4001:4001/udp -p 8080:8080 -p 5001:5001 --name twin-blob-ipfs --hostname ipfs -d ipfs/kubo:latest
 ```
 
 Afterwards you can run the tests as follows:

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);
@@ -58,9 +57,8 @@ class IpfsBlobStorageConnector {
                 const result = (await response.json());
                 return `blob:${new core.Urn(IpfsBlobStorageConnector.NAMESPACE, result.Hash).toString()}`;
             }
-            throw new core.GeneralError(this.CLASS_NAME, "fetchFail", {
-                message: response.statusText
-            });
+            const error = await response.json();
+            throw new core.GeneralError(this.CLASS_NAME, "fetchFail", error);
         }
         catch (err) {
             throw new core.GeneralError(this.CLASS_NAME, "setBlobFailed", undefined, err);
@@ -93,8 +91,12 @@ class IpfsBlobStorageConnector {
                 const result = await response.arrayBuffer();
                 return new Uint8Array(result);
             }
+            const error = await response.json();
+            throw new core.GeneralError(this.CLASS_NAME, "fetchFail", error);
+        }
+        catch (err) {
+            throw new core.GeneralError(this.CLASS_NAME, "getBlobFailed", undefined, err);
         }
-        catch { }
     }
     /**
      * Remove the blob.
@@ -122,9 +124,12 @@ class IpfsBlobStorageConnector {
             if (response.ok) {
                 return true;
             }
+            const error = await response.json();
+            throw new core.GeneralError(this.CLASS_NAME, "fetchFail", error);
+        }
+        catch (err) {
+            throw new core.GeneralError(this.CLASS_NAME, "removeBlobFailed", undefined, err);
         }
-        catch { }
-        return false;
     }
     /**
      * Add the security to the request.

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);
@@ -56,9 +55,8 @@ class IpfsBlobStorageConnector {
                 const result = (await response.json());
                 return `blob:${new Urn(IpfsBlobStorageConnector.NAMESPACE, result.Hash).toString()}`;
             }
-            throw new GeneralError(this.CLASS_NAME, "fetchFail", {
-                message: response.statusText
-            });
+            const error = await response.json();
+            throw new GeneralError(this.CLASS_NAME, "fetchFail", error);
         }
         catch (err) {
             throw new GeneralError(this.CLASS_NAME, "setBlobFailed", undefined, err);
@@ -91,8 +89,12 @@ class IpfsBlobStorageConnector {
                 const result = await response.arrayBuffer();
                 return new Uint8Array(result);
             }
+            const error = await response.json();
+            throw new GeneralError(this.CLASS_NAME, "fetchFail", error);
+        }
+        catch (err) {
+            throw new GeneralError(this.CLASS_NAME, "getBlobFailed", undefined, err);
         }
-        catch { }
     }
     /**
      * Remove the blob.
@@ -120,9 +122,12 @@ class IpfsBlobStorageConnector {
             if (response.ok) {
                 return true;
             }
+            const error = await response.json();
+            throw new GeneralError(this.CLASS_NAME, "fetchFail", error);
+        }
+        catch (err) {
+            throw new GeneralError(this.CLASS_NAME, "removeBlobFailed", undefined, err);
         }
-        catch { }
-        return false;
     }
     /**
      * Add the security to the request.

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,47 @@
 # @twin.org/blob-storage-connector-ipfs - Changelog
 
-## v0.0.1-next.3
+## [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,8 +2,10 @@
 	"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}\"",
-			"setBlobFailed": "Failed to store blob in IPFS"
+			"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.3",
+	"version": "0.0.1-next.31",
 	"description": "Blob Storage connector implementation using IPFS",
 	"repository": {
 		"type": "git",
@@ -13,51 +13,23 @@
 	"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": "npm run docs:clean && npm run docs:generate",
-		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
-	},
 	"dependencies": {
-		"@twin.org/blob-storage-models": "0.0.1-next.3",
+		"@twin.org/blob-storage-models": "0.0.1-next.31",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
-	"devDependencies": {
-		"@twin.org/nameof-transformer": "next",
-		"@vitest/coverage-v8": "2.1.1",
-		"copyfiles": "2.4.1",
-		"dotenv": "16.4.5",
-		"rimraf": "6.0.1",
-		"rollup": "4.22.0",
-		"rollup-plugin-copy": "3.5.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": {
 		".": {
+			"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",