@twin.org/blob-storage-connector-aws-s3 0.0.2-next.4 → 0.0.3-next.1

package/dist/es/index.js

@@ -0,0 +1,6 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./s3BlobStorageConnector.js";
+export * from "./models/IS3BlobStorageConnectorConfig.js";
+export * from "./models/IS3BlobStorageConnectorConstructorOptions.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2CAA2C,CAAC;AAC1D,cAAc,uDAAuD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./s3BlobStorageConnector.js\";\nexport * from \"./models/IS3BlobStorageConnectorConfig.js\";\nexport * from \"./models/IS3BlobStorageConnectorConstructorOptions.js\";\n"]}

package/dist/es/models/IS3BlobStorageConnectorConfig.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IS3BlobStorageConnectorConfig.js.map

package/dist/es/models/IS3BlobStorageConnectorConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IS3BlobStorageConnectorConfig.js","sourceRoot":"","sources":["../../../src/models/IS3BlobStorageConnectorConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Configuration for the S3 Blob Storage Connector.\n */\nexport interface IS3BlobStorageConnectorConfig {\n\t/**\n\t * The AWS region.\n\t */\n\tregion: string;\n\n\t/**\n\t * The S3 bucket name.\n\t */\n\tbucketName: string;\n\n\t/**\n\t * The authentication mode.\n\t * - \"credentials\": Use access key ID and secret access key.\n\t * - \"pod\": Use IAM role attached to the pod (e.g., in EKS).\n\t * @default credentials\n\t */\n\tauthMode?: \"credentials\" | \"pod\";\n\n\t/**\n\t * The AWS access key ID.\n\t */\n\taccessKeyId?: string;\n\n\t/**\n\t * The AWS secret access key.\n\t */\n\tsecretAccessKey?: string;\n\n\t/**\n\t * Optional endpoint for S3-compatible storage (e.g., MinIO).\n\t */\n\tendpoint?: string;\n}\n"]}

package/dist/es/models/IS3BlobStorageConnectorConstructorOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IS3BlobStorageConnectorConstructorOptions.js.map

package/dist/es/models/IS3BlobStorageConnectorConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IS3BlobStorageConnectorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IS3BlobStorageConnectorConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IS3BlobStorageConnectorConfig } from \"./IS3BlobStorageConnectorConfig.js\";\n\n/**\n * Options for the S3 Blob Storage Connector constructor.\n */\nexport interface IS3BlobStorageConnectorConstructorOptions {\n\t/**\n\t * The keys to use from the context ids to create partitions.\n\t */\n\tpartitionContextIds?: string[];\n\n\t/**\n\t * The configuration for the connector.\n\t */\n\tconfig: IS3BlobStorageConnectorConfig;\n}\n"]}

package/dist/{esm/index.mjs → es/s3BlobStorageConnector.js}

@@ -1,14 +1,14 @@
-import { S3Client, ListBucketsCommand, CreateBucketCommand, PutObjectCommand, GetObjectCommand, HeadObjectCommand, DeleteObjectCommand } from '@aws-sdk/client-s3';
-import { Guards, ComponentFactory, BaseError, Converter, Urn, GeneralError } from '@twin.org/core';
-import { Sha256 } from '@twin.org/crypto';
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+import { CreateBucketCommand, DeleteObjectCommand, GetObjectCommand, HeadObjectCommand, ListBucketsCommand, PutObjectCommand, S3Client } from "@aws-sdk/client-s3";
+import { ContextIdHelper, ContextIdStore } from "@twin.org/context";
+import { BaseError, ComponentFactory, Converter, GeneralError, Guards, Urn } from "@twin.org/core";
+import { Sha256 } from "@twin.org/crypto";
 /**
  * Class for performing blob storage operations on S3.
  * See https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/ for more information.
  */
-class S3BlobStorageConnector {
+export class S3BlobStorageConnector {
     /**
      * The namespace for the items.
      */
@@ -16,12 +16,17 @@ class S3BlobStorageConnector {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "S3BlobStorageConnector";
+    static CLASS_NAME = "S3BlobStorageConnector";
     /**
      * The configuration for the connector.
      * @internal
      */
     _config;
+    /**
+     * The keys to use from the context ids to create partitions.
+     * @internal
+     */
+    _partitionContextIds;
     /**
      * The S3 client.
      * @internal
@@ -32,20 +37,21 @@ class S3BlobStorageConnector {
      * @param options The options for the connector.
      */
     constructor(options) {
-        Guards.object(this.CLASS_NAME, "options", options);
-        Guards.object(this.CLASS_NAME, "options.config", options.config);
-        Guards.stringValue(this.CLASS_NAME, "options.config.region", options.config.region);
-        Guards.stringValue(this.CLASS_NAME, "options.config.bucketName", options.config.bucketName);
+        Guards.object(S3BlobStorageConnector.CLASS_NAME, "options", options);
+        Guards.object(S3BlobStorageConnector.CLASS_NAME, "options.config", options.config);
+        Guards.stringValue(S3BlobStorageConnector.CLASS_NAME, "options.config.region", options.config.region);
+        Guards.stringValue(S3BlobStorageConnector.CLASS_NAME, "options.config.bucketName", options.config.bucketName);
         options.config.authMode ??= "credentials";
         let credentials;
         if (options.config.authMode === "credentials") {
-            Guards.stringValue(this.CLASS_NAME, "options.config.accessKeyId", options.config.accessKeyId);
-            Guards.stringValue(this.CLASS_NAME, "options.config.secretAccessKey", options.config.secretAccessKey);
+            Guards.stringValue(S3BlobStorageConnector.CLASS_NAME, "options.config.accessKeyId", options.config.accessKeyId);
+            Guards.stringValue(S3BlobStorageConnector.CLASS_NAME, "options.config.secretAccessKey", options.config.secretAccessKey);
             credentials = {
                 accessKeyId: options.config.accessKeyId,
                 secretAccessKey: options.config.secretAccessKey
             };
         }
+        this._partitionContextIds = options.partitionContextIds;
         this._config = options.config;
         this._s3Client = new S3Client({
             region: this._config.region,
@@ -54,6 +60,13 @@ class S3BlobStorageConnector {
             forcePathStyle: true
         });
     }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return S3BlobStorageConnector.CLASS_NAME;
+    }
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
      * @param nodeLoggingComponentType The node logging component type.
@@ -62,21 +75,13 @@ class S3BlobStorageConnector {
     async bootstrap(nodeLoggingComponentType) {
         const nodeLogging = ComponentFactory.getIfExists(nodeLoggingComponentType);
         try {
-            await nodeLogging?.log({
-                level: "info",
-                source: this.CLASS_NAME,
-                message: "bucketCreating",
-                data: {
-                    bucket: this._config.bucketName
-                }
-            });
             const listBucketsCommand = new ListBucketsCommand({});
             const bucketsList = await this._s3Client.send(listBucketsCommand);
             const bucketExists = bucketsList.Buckets?.some(bucket => bucket.Name === this._config.bucketName);
             if (bucketExists) {
                 await nodeLogging?.log({
                     level: "info",
-                    source: this.CLASS_NAME,
+                    source: S3BlobStorageConnector.CLASS_NAME,
                     message: "bucketExists",
                     data: {
                         bucket: this._config.bucketName
@@ -84,21 +89,21 @@ class S3BlobStorageConnector {
                 });
             }
             else {
-                await this._s3Client.send(new CreateBucketCommand({ Bucket: this._config.bucketName }));
                 await nodeLogging?.log({
                     level: "info",
-                    source: this.CLASS_NAME,
-                    message: "bucketCreated",
+                    source: S3BlobStorageConnector.CLASS_NAME,
+                    message: "bucketCreating",
                     data: {
                         bucket: this._config.bucketName
                     }
                 });
+                await this._s3Client.send(new CreateBucketCommand({ Bucket: this._config.bucketName }));
             }
         }
         catch (err) {
             await nodeLogging?.log({
                 level: "error",
-                source: this.CLASS_NAME,
+                source: S3BlobStorageConnector.CLASS_NAME,
                 message: "bucketCreateFailed",
                 data: {
                     bucket: this._config.bucketName
@@ -115,19 +120,21 @@ class S3BlobStorageConnector {
      * @returns The id of the stored blob in urn format.
      */
     async set(blob) {
-        Guards.uint8Array(this.CLASS_NAME, "blob", blob);
+        Guards.uint8Array(S3BlobStorageConnector.CLASS_NAME, "blob", blob);
         try {
             const id = Converter.bytesToHex(Sha256.sum256(blob));
+            const contextIds = await ContextIdStore.getContextIds();
+            const partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);
             const command = new PutObjectCommand({
                 Bucket: this._config.bucketName,
-                Key: id,
+                Key: `${partitionKey ?? "root"}/${id}`,
                 Body: blob
             });
             await this._s3Client.send(command);
             return `blob:${new Urn(S3BlobStorageConnector.NAMESPACE, id).toString()}`;
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "setBlobFailed", undefined, err);
+            throw new GeneralError(S3BlobStorageConnector.CLASS_NAME, "setBlobFailed", undefined, err);
         }
     }
     /**
@@ -136,10 +143,12 @@ class S3BlobStorageConnector {
      * @returns The data for the blob if it can be found or undefined.
      */
     async get(id) {
-        Urn.guard(this.CLASS_NAME, "id", id);
+        Urn.guard(S3BlobStorageConnector.CLASS_NAME, "id", id);
         const urnParsed = Urn.fromValidString(id);
+        const contextIds = await ContextIdStore.getContextIds();
+        const partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);
         if (urnParsed.namespaceMethod() !== S3BlobStorageConnector.NAMESPACE) {
-            throw new GeneralError(this.CLASS_NAME, "namespaceMismatch", {
+            throw new GeneralError(S3BlobStorageConnector.CLASS_NAME, "namespaceMismatch", {
                 namespace: S3BlobStorageConnector.NAMESPACE,
                 id
             });
@@ -148,14 +157,22 @@ class S3BlobStorageConnector {
             const key = urnParsed.namespaceSpecific(1);
             const command = new GetObjectCommand({
                 Bucket: this._config.bucketName,
-                Key: key
+                Key: `${partitionKey ?? "root"}/${key}`
             });
             const response = await this._s3Client.send(command);
             if (response.Body) {
                 return new Uint8Array(await response.Body.transformToByteArray());
             }
         }
-        catch { }
+        catch (err) {
+            if (BaseError.isErrorName(err, "NoSuchKey")) {
+                return undefined;
+            }
+            throw new GeneralError(S3BlobStorageConnector.CLASS_NAME, "getBlobFailed", {
+                id,
+                namespace: S3BlobStorageConnector.NAMESPACE
+            }, err);
+        }
     }
     /**
      * Remove the blob.
@@ -163,10 +180,12 @@ class S3BlobStorageConnector {
      * @returns True if the blob was found.
      */
     async remove(id) {
-        Urn.guard(this.CLASS_NAME, "id", id);
+        Urn.guard(S3BlobStorageConnector.CLASS_NAME, "id", id);
         const urnParsed = Urn.fromValidString(id);
+        const contextIds = await ContextIdStore.getContextIds();
+        const partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);
         if (urnParsed.namespaceMethod() !== S3BlobStorageConnector.NAMESPACE) {
-            throw new GeneralError(this.CLASS_NAME, "namespaceMismatch", {
+            throw new GeneralError(S3BlobStorageConnector.CLASS_NAME, "namespaceMismatch", {
                 namespace: S3BlobStorageConnector.NAMESPACE,
                 id
             });
@@ -175,7 +194,7 @@ class S3BlobStorageConnector {
             const key = urnParsed.namespaceSpecific(1);
             const headCommand = new HeadObjectCommand({
                 Bucket: this._config.bucketName,
-                Key: key
+                Key: `${partitionKey ?? "root"}/${key}`
             });
             try {
                 await this._s3Client.send(headCommand);
@@ -188,15 +207,14 @@ class S3BlobStorageConnector {
             }
             const deleteCommand = new DeleteObjectCommand({
                 Bucket: this._config.bucketName,
-                Key: key
+                Key: `${partitionKey ?? "root"}/${key}`
             });
             await this._s3Client.send(deleteCommand);
             return true;
         }
         catch (err) {
-            throw new GeneralError(this.CLASS_NAME, "removeBlobFailed", { id }, err);
+            throw new GeneralError(S3BlobStorageConnector.CLASS_NAME, "removeBlobFailed", { id }, err);
         }
     }
 }
-
-export { S3BlobStorageConnector };
+//# sourceMappingURL=s3BlobStorageConnector.js.map

package/dist/es/s3BlobStorageConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3BlobStorageConnector.js","sourceRoot":"","sources":["../../src/s3BlobStorageConnector.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EACN,mBAAmB,EACnB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,gBAAgB,EAChB,QAAQ,EACR,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACnG,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAM1C;;;GAGG;AACH,MAAM,OAAO,sBAAsB;IAClC;;OAEG;IACI,MAAM,CAAU,SAAS,GAAW,IAAI,CAAC;IAEhD;;OAEG;IACI,MAAM,CAAU,UAAU,4BAA4C;IAE7E;;;OAGG;IACc,OAAO,CAAgC;IAExD;;;OAGG;IACc,oBAAoB,CAAY;IAEjD;;;OAGG;IACc,SAAS,CAAW;IAErC;;;OAGG;IACH,YAAY,OAAkD;QAC7D,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QAC3E,MAAM,CAAC,MAAM,CACZ,sBAAsB,CAAC,UAAU,oBAEjC,OAAO,CAAC,MAAM,CACd,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,sBAAsB,CAAC,UAAU,2BAEjC,OAAO,CAAC,MAAM,CAAC,MAAM,CACrB,CAAC;QACF,MAAM,CAAC,WAAW,CACjB,sBAAsB,CAAC,UAAU,+BAEjC,OAAO,CAAC,MAAM,CAAC,UAAU,CACzB,CAAC;QAEF,OAAO,CAAC,MAAM,CAAC,QAAQ,KAAK,aAAa,CAAC;QAE1C,IAAI,WAAW,CAAC;QAChB,IAAI,OAAO,CAAC,MAAM,CAAC,QAAQ,KAAK,aAAa,EAAE,CAAC;YAC/C,MAAM,CAAC,WAAW,CACjB,sBAAsB,CAAC,UAAU,gCAEjC,OAAO,CAAC,MAAM,CAAC,WAAW,CAC1B,CAAC;YACF,MAAM,CAAC,WAAW,CACjB,sBAAsB,CAAC,UAAU,oCAEjC,OAAO,CAAC,MAAM,CAAC,eAAe,CAC9B,CAAC;YACF,WAAW,GAAG;gBACb,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW;gBACvC,eAAe,EAAE,OAAO,CAAC,MAAM,CAAC,eAAe;aAC/C,CAAC;QACH,CAAC;QAED,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;QAExD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,SAAS,GAAG,IAAI,QAAQ,CAAC;YAC7B,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;YAC3B,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;YAC/B,WAAW;YACX,cAAc,EAAE,IAAI;SACpB,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,sBAAsB,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,wBAAiC;QACvD,MAAM,WAAW,GAAG,gBAAgB,CAAC,WAAW,CAAoB,wBAAwB,CAAC,CAAC;QAE9F,IAAI,CAAC;YACJ,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,CAAC,EAAE,CAAC,CAAC;YACtD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAClE,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,EAAE,IAAI,CAC7C,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,OAAO,CAAC,UAAU,CACjD,CAAC;YAEF,IAAI,YAAY,EAAE,CAAC;gBAClB,MAAM,WAAW,EAAE,GAAG,CAAC;oBACtB,KAAK,EAAE,MAAM;oBACb,MAAM,EAAE,sBAAsB,CAAC,UAAU;oBACzC,OAAO,EAAE,cAAc;oBACvB,IAAI,EAAE;wBACL,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;qBAC/B;iBACD,CAAC,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACP,MAAM,WAAW,EAAE,GAAG,CAAC;oBACtB,KAAK,EAAE,MAAM;oBACb,MAAM,EAAE,sBAAsB,CAAC,UAAU;oBACzC,OAAO,EAAE,gBAAgB;oBACzB,IAAI,EAAE;wBACL,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;qBAC/B;iBACD,CAAC,CAAC;gBACH,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,mBAAmB,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;YACzF,CAAC;QACF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,WAAW,EAAE,GAAG,CAAC;gBACtB,KAAK,EAAE,OAAO;gBACd,MAAM,EAAE,sBAAsB,CAAC,UAAU;gBACzC,OAAO,EAAE,oBAAoB;gBAC7B,IAAI,EAAE;oBACL,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;iBAC/B;gBACD,KAAK,EAAE,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC;aAC/B,CAAC,CAAC;YAEH,OAAO,KAAK,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,GAAG,CAAC,IAAgB;QAChC,MAAM,CAAC,UAAU,CAAC,sBAAsB,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAEzE,IAAI,CAAC;YACJ,MAAM,EAAE,GAAG,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAErD,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;YACxD,MAAM,YAAY,GAAG,eAAe,CAAC,kBAAkB,CACtD,UAAU,EACV,IAAI,CAAC,oBAAoB,CACzB,CAAC;YAEF,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC;gBACpC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;gBAC/B,GAAG,EAAE,GAAG,YAAY,IAAI,MAAM,IAAI,EAAE,EAAE;gBACtC,IAAI,EAAE,IAAI;aACV,CAAC,CAAC;YAEH,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAEnC,OAAO,QAAQ,IAAI,GAAG,CAAC,sBAAsB,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;QAC3E,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,YAAY,CAAC,sBAAsB,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;QAC5F,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,GAAG,CAAC,EAAU;QAC1B,GAAG,CAAC,KAAK,CAAC,sBAAsB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAC7D,MAAM,SAAS,GAAG,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAE1C,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;QACxD,MAAM,YAAY,GAAG,eAAe,CAAC,kBAAkB,CAAC,UAAU,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAE/F,IAAI,SAAS,CAAC,eAAe,EAAE,KAAK,sBAAsB,CAAC,SAAS,EAAE,CAAC;YACtE,MAAM,IAAI,YAAY,CAAC,sBAAsB,CAAC,UAAU,EAAE,mBAAmB,EAAE;gBAC9E,SAAS,EAAE,sBAAsB,CAAC,SAAS;gBAC3C,EAAE;aACF,CAAC,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACJ,MAAM,GAAG,GAAG,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;YAC3C,MAAM,OAAO,GAAG,IAAI,gBAAgB,CAAC;gBACpC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;gBAC/B,GAAG,EAAE,GAAG,YAAY,IAAI,MAAM,IAAI,GAAG,EAAE;aACvC,CAAC,CAAC;YAEH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAEpD,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACnB,OAAO,IAAI,UAAU,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAC;YACnE,CAAC;QACF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,IAAI,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,WAAW,CAAC,EAAE,CAAC;gBAC7C,OAAO,SAAS,CAAC;YAClB,CAAC;YACD,MAAM,IAAI,YAAY,CACrB,sBAAsB,CAAC,UAAU,EACjC,eAAe,EACf;gBACC,EAAE;gBACF,SAAS,EAAE,sBAAsB,CAAC,SAAS;aAC3C,EACD,GAAG,CACH,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU;QAC7B,GAAG,CAAC,KAAK,CAAC,sBAAsB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAC7D,MAAM,SAAS,GAAG,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAE1C,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,EAAE,CAAC;QACxD,MAAM,YAAY,GAAG,eAAe,CAAC,kBAAkB,CAAC,UAAU,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAE/F,IAAI,SAAS,CAAC,eAAe,EAAE,KAAK,sBAAsB,CAAC,SAAS,EAAE,CAAC;YACtE,MAAM,IAAI,YAAY,CAAC,sBAAsB,CAAC,UAAU,EAAE,mBAAmB,EAAE;gBAC9E,SAAS,EAAE,sBAAsB,CAAC,SAAS;gBAC3C,EAAE;aACF,CAAC,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACJ,MAAM,GAAG,GAAG,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;YAE3C,MAAM,WAAW,GAAG,IAAI,iBAAiB,CAAC;gBACzC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;gBAC/B,GAAG,EAAE,GAAG,YAAY,IAAI,MAAM,IAAI,GAAG,EAAE;aACvC,CAAC,CAAC;YAEH,IAAI,CAAC;gBACJ,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACxC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAChB,IAAI,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,UAAU,CAAC,EAAE,CAAC;oBAC9C,OAAO,KAAK,CAAC;gBACd,CAAC;gBACD,MAAM,KAAK,CAAC;YACb,CAAC;YAED,MAAM,aAAa,GAAG,IAAI,mBAAmB,CAAC;gBAC7C,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;gBAC/B,GAAG,EAAE,GAAG,YAAY,IAAI,MAAM,IAAI,GAAG,EAAE;aACvC,CAAC,CAAC;YAEH,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAEzC,OAAO,IAAI,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,YAAY,CAAC,sBAAsB,CAAC,UAAU,EAAE,kBAAkB,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC;QAC5F,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport {\n\tCreateBucketCommand,\n\tDeleteObjectCommand,\n\tGetObjectCommand,\n\tHeadObjectCommand,\n\tListBucketsCommand,\n\tPutObjectCommand,\n\tS3Client\n} from \"@aws-sdk/client-s3\";\nimport type { IBlobStorageConnector } from \"@twin.org/blob-storage-models\";\nimport { ContextIdHelper, ContextIdStore } from \"@twin.org/context\";\nimport { BaseError, ComponentFactory, Converter, GeneralError, Guards, Urn } from \"@twin.org/core\";\nimport { Sha256 } from \"@twin.org/crypto\";\nimport type { ILoggingComponent } from \"@twin.org/logging-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IS3BlobStorageConnectorConfig } from \"./models/IS3BlobStorageConnectorConfig.js\";\nimport type { IS3BlobStorageConnectorConstructorOptions } from \"./models/IS3BlobStorageConnectorConstructorOptions.js\";\n\n/**\n * Class for performing blob storage operations on S3.\n * See https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/ for more information.\n */\nexport class S3BlobStorageConnector implements IBlobStorageConnector {\n\t/**\n\t * The namespace for the items.\n\t */\n\tpublic static readonly NAMESPACE: string = \"s3\";\n\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<S3BlobStorageConnector>();\n\n\t/**\n\t * The configuration for the connector.\n\t * @internal\n\t */\n\tprivate readonly _config: IS3BlobStorageConnectorConfig;\n\n\t/**\n\t * The keys to use from the context ids to create partitions.\n\t * @internal\n\t */\n\tprivate readonly _partitionContextIds?: string[];\n\n\t/**\n\t * The S3 client.\n\t * @internal\n\t */\n\tprivate readonly _s3Client: S3Client;\n\n\t/**\n\t * Create a new instance of S3BlobStorageConnector.\n\t * @param options The options for the connector.\n\t */\n\tconstructor(options: IS3BlobStorageConnectorConstructorOptions) {\n\t\tGuards.object(S3BlobStorageConnector.CLASS_NAME, nameof(options), options);\n\t\tGuards.object<IS3BlobStorageConnectorConfig>(\n\t\t\tS3BlobStorageConnector.CLASS_NAME,\n\t\t\tnameof(options.config),\n\t\t\toptions.config\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tS3BlobStorageConnector.CLASS_NAME,\n\t\t\tnameof(options.config.region),\n\t\t\toptions.config.region\n\t\t);\n\t\tGuards.stringValue(\n\t\t\tS3BlobStorageConnector.CLASS_NAME,\n\t\t\tnameof(options.config.bucketName),\n\t\t\toptions.config.bucketName\n\t\t);\n\n\t\toptions.config.authMode ??= \"credentials\";\n\n\t\tlet credentials;\n\t\tif (options.config.authMode === \"credentials\") {\n\t\t\tGuards.stringValue(\n\t\t\t\tS3BlobStorageConnector.CLASS_NAME,\n\t\t\t\tnameof(options.config.accessKeyId),\n\t\t\t\toptions.config.accessKeyId\n\t\t\t);\n\t\t\tGuards.stringValue(\n\t\t\t\tS3BlobStorageConnector.CLASS_NAME,\n\t\t\t\tnameof(options.config.secretAccessKey),\n\t\t\t\toptions.config.secretAccessKey\n\t\t\t);\n\t\t\tcredentials = {\n\t\t\t\taccessKeyId: options.config.accessKeyId,\n\t\t\t\tsecretAccessKey: options.config.secretAccessKey\n\t\t\t};\n\t\t}\n\n\t\tthis._partitionContextIds = options.partitionContextIds;\n\n\t\tthis._config = options.config;\n\t\tthis._s3Client = new S3Client({\n\t\t\tregion: this._config.region,\n\t\t\tendpoint: this._config.endpoint,\n\t\t\tcredentials,\n\t\t\tforcePathStyle: true\n\t\t});\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn S3BlobStorageConnector.CLASS_NAME;\n\t}\n\n\t/**\n\t * Bootstrap the component by creating and initializing any resources it needs.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns True if the bootstrapping process was successful.\n\t */\n\tpublic async bootstrap(nodeLoggingComponentType?: string): Promise<boolean> {\n\t\tconst nodeLogging = ComponentFactory.getIfExists<ILoggingComponent>(nodeLoggingComponentType);\n\n\t\ttry {\n\t\t\tconst listBucketsCommand = new ListBucketsCommand({});\n\t\t\tconst bucketsList = await this._s3Client.send(listBucketsCommand);\n\t\t\tconst bucketExists = bucketsList.Buckets?.some(\n\t\t\t\tbucket => bucket.Name === this._config.bucketName\n\t\t\t);\n\n\t\t\tif (bucketExists) {\n\t\t\t\tawait nodeLogging?.log({\n\t\t\t\t\tlevel: \"info\",\n\t\t\t\t\tsource: S3BlobStorageConnector.CLASS_NAME,\n\t\t\t\t\tmessage: \"bucketExists\",\n\t\t\t\t\tdata: {\n\t\t\t\t\t\tbucket: this._config.bucketName\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t} else {\n\t\t\t\tawait nodeLogging?.log({\n\t\t\t\t\tlevel: \"info\",\n\t\t\t\t\tsource: S3BlobStorageConnector.CLASS_NAME,\n\t\t\t\t\tmessage: \"bucketCreating\",\n\t\t\t\t\tdata: {\n\t\t\t\t\t\tbucket: this._config.bucketName\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t\tawait this._s3Client.send(new CreateBucketCommand({ Bucket: this._config.bucketName }));\n\t\t\t}\n\t\t} catch (err) {\n\t\t\tawait nodeLogging?.log({\n\t\t\t\tlevel: \"error\",\n\t\t\t\tsource: S3BlobStorageConnector.CLASS_NAME,\n\t\t\t\tmessage: \"bucketCreateFailed\",\n\t\t\t\tdata: {\n\t\t\t\t\tbucket: this._config.bucketName\n\t\t\t\t},\n\t\t\t\terror: BaseError.fromError(err)\n\t\t\t});\n\n\t\t\treturn false;\n\t\t}\n\n\t\treturn true;\n\t}\n\n\t/**\n\t * Set the blob.\n\t * @param blob The data for the blob.\n\t * @returns The id of the stored blob in urn format.\n\t */\n\tpublic async set(blob: Uint8Array): Promise<string> {\n\t\tGuards.uint8Array(S3BlobStorageConnector.CLASS_NAME, nameof(blob), blob);\n\n\t\ttry {\n\t\t\tconst id = Converter.bytesToHex(Sha256.sum256(blob));\n\n\t\t\tconst contextIds = await ContextIdStore.getContextIds();\n\t\t\tconst partitionKey = ContextIdHelper.combinedContextKey(\n\t\t\t\tcontextIds,\n\t\t\t\tthis._partitionContextIds\n\t\t\t);\n\n\t\t\tconst command = new PutObjectCommand({\n\t\t\t\tBucket: this._config.bucketName,\n\t\t\t\tKey: `${partitionKey ?? \"root\"}/${id}`,\n\t\t\t\tBody: blob\n\t\t\t});\n\n\t\t\tawait this._s3Client.send(command);\n\n\t\t\treturn `blob:${new Urn(S3BlobStorageConnector.NAMESPACE, id).toString()}`;\n\t\t} catch (err) {\n\t\t\tthrow new GeneralError(S3BlobStorageConnector.CLASS_NAME, \"setBlobFailed\", undefined, err);\n\t\t}\n\t}\n\n\t/**\n\t * Get the blob.\n\t * @param id The id of the blob to get in urn format.\n\t * @returns The data for the blob if it can be found or undefined.\n\t */\n\tpublic async get(id: string): Promise<Uint8Array | undefined> {\n\t\tUrn.guard(S3BlobStorageConnector.CLASS_NAME, nameof(id), id);\n\t\tconst urnParsed = Urn.fromValidString(id);\n\n\t\tconst contextIds = await ContextIdStore.getContextIds();\n\t\tconst partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);\n\n\t\tif (urnParsed.namespaceMethod() !== S3BlobStorageConnector.NAMESPACE) {\n\t\t\tthrow new GeneralError(S3BlobStorageConnector.CLASS_NAME, \"namespaceMismatch\", {\n\t\t\t\tnamespace: S3BlobStorageConnector.NAMESPACE,\n\t\t\t\tid\n\t\t\t});\n\t\t}\n\n\t\ttry {\n\t\t\tconst key = urnParsed.namespaceSpecific(1);\n\t\t\tconst command = new GetObjectCommand({\n\t\t\t\tBucket: this._config.bucketName,\n\t\t\t\tKey: `${partitionKey ?? \"root\"}/${key}`\n\t\t\t});\n\n\t\t\tconst response = await this._s3Client.send(command);\n\n\t\t\tif (response.Body) {\n\t\t\t\treturn new Uint8Array(await response.Body.transformToByteArray());\n\t\t\t}\n\t\t} catch (err) {\n\t\t\tif (BaseError.isErrorName(err, \"NoSuchKey\")) {\n\t\t\t\treturn undefined;\n\t\t\t}\n\t\t\tthrow new GeneralError(\n\t\t\t\tS3BlobStorageConnector.CLASS_NAME,\n\t\t\t\t\"getBlobFailed\",\n\t\t\t\t{\n\t\t\t\t\tid,\n\t\t\t\t\tnamespace: S3BlobStorageConnector.NAMESPACE\n\t\t\t\t},\n\t\t\t\terr\n\t\t\t);\n\t\t}\n\t}\n\n\t/**\n\t * Remove the blob.\n\t * @param id The id of the blob to remove in urn format.\n\t * @returns True if the blob was found.\n\t */\n\tpublic async remove(id: string): Promise<boolean> {\n\t\tUrn.guard(S3BlobStorageConnector.CLASS_NAME, nameof(id), id);\n\t\tconst urnParsed = Urn.fromValidString(id);\n\n\t\tconst contextIds = await ContextIdStore.getContextIds();\n\t\tconst partitionKey = ContextIdHelper.combinedContextKey(contextIds, this._partitionContextIds);\n\n\t\tif (urnParsed.namespaceMethod() !== S3BlobStorageConnector.NAMESPACE) {\n\t\t\tthrow new GeneralError(S3BlobStorageConnector.CLASS_NAME, \"namespaceMismatch\", {\n\t\t\t\tnamespace: S3BlobStorageConnector.NAMESPACE,\n\t\t\t\tid\n\t\t\t});\n\t\t}\n\n\t\ttry {\n\t\t\tconst key = urnParsed.namespaceSpecific(1);\n\n\t\t\tconst headCommand = new HeadObjectCommand({\n\t\t\t\tBucket: this._config.bucketName,\n\t\t\t\tKey: `${partitionKey ?? \"root\"}/${key}`\n\t\t\t});\n\n\t\t\ttry {\n\t\t\t\tawait this._s3Client.send(headCommand);\n\t\t\t} catch (error) {\n\t\t\t\tif (BaseError.isErrorName(error, \"NotFound\")) {\n\t\t\t\t\treturn false;\n\t\t\t\t}\n\t\t\t\tthrow error;\n\t\t\t}\n\n\t\t\tconst deleteCommand = new DeleteObjectCommand({\n\t\t\t\tBucket: this._config.bucketName,\n\t\t\t\tKey: `${partitionKey ?? \"root\"}/${key}`\n\t\t\t});\n\n\t\t\tawait this._s3Client.send(deleteCommand);\n\n\t\t\treturn true;\n\t\t} catch (err) {\n\t\t\tthrow new GeneralError(S3BlobStorageConnector.CLASS_NAME, \"removeBlobFailed\", { id }, err);\n\t\t}\n\t}\n}\n"]}

package/dist/types/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./s3BlobStorageConnector";
-export * from "./models/IS3BlobStorageConnectorConfig";
-export * from "./models/IS3BlobStorageConnectorConstructorOptions";
+export * from "./s3BlobStorageConnector.js";
+export * from "./models/IS3BlobStorageConnectorConfig.js";
+export * from "./models/IS3BlobStorageConnectorConstructorOptions.js";

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

@@ -1,8 +1,12 @@
-import type { IS3BlobStorageConnectorConfig } from "./IS3BlobStorageConnectorConfig";
+import type { IS3BlobStorageConnectorConfig } from "./IS3BlobStorageConnectorConfig.js";
 /**
  * Options for the S3 Blob Storage Connector constructor.
  */
 export interface IS3BlobStorageConnectorConstructorOptions {
+    /**
+     * The keys to use from the context ids to create partitions.
+     */
+    partitionContextIds?: string[];
     /**
      * The configuration for the connector.
      */

package/dist/types/s3BlobStorageConnector.d.ts

@@ -1,5 +1,5 @@
 import type { IBlobStorageConnector } from "@twin.org/blob-storage-models";
-import type { IS3BlobStorageConnectorConstructorOptions } from "./models/IS3BlobStorageConnectorConstructorOptions";
+import type { IS3BlobStorageConnectorConstructorOptions } from "./models/IS3BlobStorageConnectorConstructorOptions.js";
 /**
  * Class for performing blob storage operations on S3.
  * See https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/ for more information.
@@ -12,12 +12,17 @@ export declare class S3BlobStorageConnector implements IBlobStorageConnector {
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of S3BlobStorageConnector.
      * @param options The options for the connector.
      */
     constructor(options: IS3BlobStorageConnectorConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
      * @param nodeLoggingComponentType The node logging component type.

package/docs/changelog.md

@@ -1,5 +1,41 @@
 # @twin.org/blob-storage-connector-aws-s3 - Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-aws-s3-v0.0.3-next.0...blob-storage-connector-aws-s3-v0.0.3-next.1) (2025-11-11)
+
+
+### Features
+
+* add AWS pod authentication mode ([c34b11c](https://github.com/twinfoundation/blob-storage/commit/c34b11cb32d3310a9e59840341a2b0b4221bc780))
+* add context id features ([#30](https://github.com/twinfoundation/blob-storage/issues/30)) ([fbf1c92](https://github.com/twinfoundation/blob-storage/commit/fbf1c9276424c841ef5ef3f4de8469ab3fba7e9c))
+* add validate-locales ([f20fcec](https://github.com/twinfoundation/blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
+* Blob storage connector for AWS S3 ([#7](https://github.com/twinfoundation/blob-storage/issues/7)) ([1d7f1e7](https://github.com/twinfoundation/blob-storage/commit/1d7f1e7d323926f7f31229d38eb5de429f6e1554))
+* eslint migration to flat config ([e4239dd](https://github.com/twinfoundation/blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
+* update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
+* update framework core ([ff339fe](https://github.com/twinfoundation/blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
+* update to support fully qualified data type names ([3297d69](https://github.com/twinfoundation/blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
+* 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.3-next.0 to 0.0.3-next.1
+
+## [0.0.2-next.5](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-aws-s3-v0.0.2-next.4...blob-storage-connector-aws-s3-v0.0.2-next.5) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([f20fcec](https://github.com/twinfoundation/blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.2-next.4 to 0.0.2-next.5
+
 ## [0.0.2-next.4](https://github.com/twinfoundation/blob-storage/compare/blob-storage-connector-aws-s3-v0.0.2-next.3...blob-storage-connector-aws-s3-v0.0.2-next.4) (2025-10-02)
 
 

package/docs/reference/classes/S3BlobStorageConnector.md

@@ -39,15 +39,29 @@ The namespace for the items.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`IBlobStorageConnector.CLASS_NAME`
+`IBlobStorageConnector.className`
 
-## Methods
+***
 
 ### bootstrap()
 
@@ -103,7 +117,7 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`): `Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+> **get**(`id`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
 
 Get the blob.
 
@@ -117,7 +131,7 @@ The id of the blob to get in urn format.
 
 #### Returns
 
-`Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
 
 The data for the blob if it can be found or undefined.
 

package/docs/reference/interfaces/IS3BlobStorageConnectorConstructorOptions.md

@@ -4,6 +4,14 @@ Options for the S3 Blob Storage Connector constructor.
 
 ## Properties
 
+### partitionContextIds?
+
+> `optional` **partitionContextIds**: `string`[]
+
+The keys to use from the context ids to create partitions.
+
+***
+
 ### config
 
 > **config**: [`IS3BlobStorageConnectorConfig`](IS3BlobStorageConnectorConfig.md)

package/locales/en.json

@@ -2,7 +2,6 @@
 	"info": {
 		"s3BlobStorageConnector": {
 			"bucketCreating": "Creating bucket \"{bucket}\"",
-			"bucketCreated": "Created bucket \"{bucket}\"",
 			"bucketExists": "Skipping create bucket \"{bucket}\" as it already exists"
 		}
 	},

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-connector-aws-s3",
-	"version": "0.0.2-next.4",
+	"version": "0.0.3-next.1",
 	"description": "Blob Storage connector implementation using AWS S3",
 	"repository": {
 		"type": "git",
@@ -14,27 +14,26 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@aws-sdk/client-s3": "3.896.0",
-		"@twin.org/blob-storage-models": "0.0.2-next.4",
+		"@aws-sdk/client-s3": "3.928.0",
+		"@twin.org/blob-storage-models": "0.0.3-next.1",
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
@@ -53,5 +52,9 @@
 		"connector",
 		"adapter",
 		"integration"
-	]
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/blob-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,204 +0,0 @@
-'use strict';
-
-var clientS3 = require('@aws-sdk/client-s3');
-var core = require('@twin.org/core');
-var crypto = require('@twin.org/crypto');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class for performing blob storage operations on S3.
- * See https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/ for more information.
- */
-class S3BlobStorageConnector {
-    /**
-     * The namespace for the items.
-     */
-    static NAMESPACE = "s3";
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "S3BlobStorageConnector";
-    /**
-     * The configuration for the connector.
-     * @internal
-     */
-    _config;
-    /**
-     * The S3 client.
-     * @internal
-     */
-    _s3Client;
-    /**
-     * Create a new instance of S3BlobStorageConnector.
-     * @param options The options for the connector.
-     */
-    constructor(options) {
-        core.Guards.object(this.CLASS_NAME, "options", options);
-        core.Guards.object(this.CLASS_NAME, "options.config", options.config);
-        core.Guards.stringValue(this.CLASS_NAME, "options.config.region", options.config.region);
-        core.Guards.stringValue(this.CLASS_NAME, "options.config.bucketName", options.config.bucketName);
-        options.config.authMode ??= "credentials";
-        let credentials;
-        if (options.config.authMode === "credentials") {
-            core.Guards.stringValue(this.CLASS_NAME, "options.config.accessKeyId", options.config.accessKeyId);
-            core.Guards.stringValue(this.CLASS_NAME, "options.config.secretAccessKey", options.config.secretAccessKey);
-            credentials = {
-                accessKeyId: options.config.accessKeyId,
-                secretAccessKey: options.config.secretAccessKey
-            };
-        }
-        this._config = options.config;
-        this._s3Client = new clientS3.S3Client({
-            region: this._config.region,
-            endpoint: this._config.endpoint,
-            credentials,
-            forcePathStyle: true
-        });
-    }
-    /**
-     * Bootstrap the component by creating and initializing any resources it needs.
-     * @param nodeLoggingComponentType The node logging component type.
-     * @returns True if the bootstrapping process was successful.
-     */
-    async bootstrap(nodeLoggingComponentType) {
-        const nodeLogging = core.ComponentFactory.getIfExists(nodeLoggingComponentType);
-        try {
-            await nodeLogging?.log({
-                level: "info",
-                source: this.CLASS_NAME,
-                message: "bucketCreating",
-                data: {
-                    bucket: this._config.bucketName
-                }
-            });
-            const listBucketsCommand = new clientS3.ListBucketsCommand({});
-            const bucketsList = await this._s3Client.send(listBucketsCommand);
-            const bucketExists = bucketsList.Buckets?.some(bucket => bucket.Name === this._config.bucketName);
-            if (bucketExists) {
-                await nodeLogging?.log({
-                    level: "info",
-                    source: this.CLASS_NAME,
-                    message: "bucketExists",
-                    data: {
-                        bucket: this._config.bucketName
-                    }
-                });
-            }
-            else {
-                await this._s3Client.send(new clientS3.CreateBucketCommand({ Bucket: this._config.bucketName }));
-                await nodeLogging?.log({
-                    level: "info",
-                    source: this.CLASS_NAME,
-                    message: "bucketCreated",
-                    data: {
-                        bucket: this._config.bucketName
-                    }
-                });
-            }
-        }
-        catch (err) {
-            await nodeLogging?.log({
-                level: "error",
-                source: this.CLASS_NAME,
-                message: "bucketCreateFailed",
-                data: {
-                    bucket: this._config.bucketName
-                },
-                error: core.BaseError.fromError(err)
-            });
-            return false;
-        }
-        return true;
-    }
-    /**
-     * Set the blob.
-     * @param blob The data for the blob.
-     * @returns The id of the stored blob in urn format.
-     */
-    async set(blob) {
-        core.Guards.uint8Array(this.CLASS_NAME, "blob", blob);
-        try {
-            const id = core.Converter.bytesToHex(crypto.Sha256.sum256(blob));
-            const command = new clientS3.PutObjectCommand({
-                Bucket: this._config.bucketName,
-                Key: id,
-                Body: blob
-            });
-            await this._s3Client.send(command);
-            return `blob:${new core.Urn(S3BlobStorageConnector.NAMESPACE, id).toString()}`;
-        }
-        catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "setBlobFailed", undefined, err);
-        }
-    }
-    /**
-     * Get the blob.
-     * @param id The id of the blob to get in urn format.
-     * @returns The data for the blob if it can be found or undefined.
-     */
-    async get(id) {
-        core.Urn.guard(this.CLASS_NAME, "id", id);
-        const urnParsed = core.Urn.fromValidString(id);
-        if (urnParsed.namespaceMethod() !== S3BlobStorageConnector.NAMESPACE) {
-            throw new core.GeneralError(this.CLASS_NAME, "namespaceMismatch", {
-                namespace: S3BlobStorageConnector.NAMESPACE,
-                id
-            });
-        }
-        try {
-            const key = urnParsed.namespaceSpecific(1);
-            const command = new clientS3.GetObjectCommand({
-                Bucket: this._config.bucketName,
-                Key: key
-            });
-            const response = await this._s3Client.send(command);
-            if (response.Body) {
-                return new Uint8Array(await response.Body.transformToByteArray());
-            }
-        }
-        catch { }
-    }
-    /**
-     * Remove the blob.
-     * @param id The id of the blob to remove in urn format.
-     * @returns True if the blob was found.
-     */
-    async remove(id) {
-        core.Urn.guard(this.CLASS_NAME, "id", id);
-        const urnParsed = core.Urn.fromValidString(id);
-        if (urnParsed.namespaceMethod() !== S3BlobStorageConnector.NAMESPACE) {
-            throw new core.GeneralError(this.CLASS_NAME, "namespaceMismatch", {
-                namespace: S3BlobStorageConnector.NAMESPACE,
-                id
-            });
-        }
-        try {
-            const key = urnParsed.namespaceSpecific(1);
-            const headCommand = new clientS3.HeadObjectCommand({
-                Bucket: this._config.bucketName,
-                Key: key
-            });
-            try {
-                await this._s3Client.send(headCommand);
-            }
-            catch (error) {
-                if (core.BaseError.isErrorName(error, "NotFound")) {
-                    return false;
-                }
-                throw error;
-            }
-            const deleteCommand = new clientS3.DeleteObjectCommand({
-                Bucket: this._config.bucketName,
-                Key: key
-            });
-            await this._s3Client.send(deleteCommand);
-            return true;
-        }
-        catch (err) {
-            throw new core.GeneralError(this.CLASS_NAME, "removeBlobFailed", { id }, err);
-        }
-    }
-}
-
-exports.S3BlobStorageConnector = S3BlobStorageConnector;