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

package/dist/cjs/index.cjs

@@ -1,6 +1,5 @@
 'use strict';
 
-var node_stream = require('node:stream');
 var storageBlob = require('@azure/storage-blob');
 var core = require('@twin.org/core');
 var crypto = require('@twin.org/crypto');
@@ -39,7 +38,6 @@ class AzureBlobStorageConnector {
     /**
      * Create a new instance of AzureBlobStorageConnector.
      * @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);
@@ -114,18 +112,7 @@ class AzureBlobStorageConnector {
         try {
             const id = core.Converter.bytesToHex(crypto.Sha256.sum256(blob));
             const blockBlobClient = this._azureContainerClient.getBlockBlobClient(id);
-            const readableStream = new node_stream.Readable({
-                /**
-                 * Reads data from the blob and pushes it into the stream.
-                 * This method is automatically called when the stream is read from.
-                 * It pushes the blob data and signals the end of the stream.
-                 */
-                read() {
-                    this.push(blob);
-                    this.push(null);
-                }
-            });
-            await blockBlobClient.uploadStream(readableStream);
+            await blockBlobClient.uploadData(blob);
             return `blob:${new core.Urn(AzureBlobStorageConnector.NAMESPACE, id).toString()}`;
         }
         catch (err) {
@@ -149,17 +136,8 @@ class AzureBlobStorageConnector {
         try {
             const key = urnParsed.namespaceSpecific(1);
             const blobClient = this._azureContainerClient.getBlobClient(key);
-            const downloadResponse = await blobClient.download();
-            if (!downloadResponse.errorCode && downloadResponse?.readableStreamBody) {
-                const readableStream = downloadResponse.readableStreamBody;
-                const chunks = [];
-                for await (const chunk of readableStream) {
-                    chunks.push(chunk);
-                }
-                const buffer = Buffer.concat(chunks);
-                return new Uint8Array(buffer);
-            }
-            return undefined;
+            const buffer = await blobClient.downloadToBuffer();
+            return new Uint8Array(buffer);
         }
         catch (err) {
             throw new core.GeneralError(this.CLASS_NAME, "getBlobFailed", {

package/dist/esm/index.mjs

@@ -1,4 +1,3 @@
-import { Readable } from 'node:stream';
 import { BlobServiceClient, StorageSharedKeyCredential } from '@azure/storage-blob';
 import { Guards, BaseError, Converter, Urn, GeneralError } from '@twin.org/core';
 import { Sha256 } from '@twin.org/crypto';
@@ -37,7 +36,6 @@ class AzureBlobStorageConnector {
     /**
      * Create a new instance of AzureBlobStorageConnector.
      * @param options The options for the connector.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         Guards.object(this.CLASS_NAME, "options", options);
@@ -112,18 +110,7 @@ class AzureBlobStorageConnector {
         try {
             const id = Converter.bytesToHex(Sha256.sum256(blob));
             const blockBlobClient = this._azureContainerClient.getBlockBlobClient(id);
-            const readableStream = new Readable({
-                /**
-                 * Reads data from the blob and pushes it into the stream.
-                 * This method is automatically called when the stream is read from.
-                 * It pushes the blob data and signals the end of the stream.
-                 */
-                read() {
-                    this.push(blob);
-                    this.push(null);
-                }
-            });
-            await blockBlobClient.uploadStream(readableStream);
+            await blockBlobClient.uploadData(blob);
             return `blob:${new Urn(AzureBlobStorageConnector.NAMESPACE, id).toString()}`;
         }
         catch (err) {
@@ -147,17 +134,8 @@ class AzureBlobStorageConnector {
         try {
             const key = urnParsed.namespaceSpecific(1);
             const blobClient = this._azureContainerClient.getBlobClient(key);
-            const downloadResponse = await blobClient.download();
-            if (!downloadResponse.errorCode && downloadResponse?.readableStreamBody) {
-                const readableStream = downloadResponse.readableStreamBody;
-                const chunks = [];
-                for await (const chunk of readableStream) {
-                    chunks.push(chunk);
-                }
-                const buffer = Buffer.concat(chunks);
-                return new Uint8Array(buffer);
-            }
-            return undefined;
+            const buffer = await blobClient.downloadToBuffer();
+            return new Uint8Array(buffer);
         }
         catch (err) {
             throw new GeneralError(this.CLASS_NAME, "getBlobFailed", {

package/dist/types/azureBlobStorageConnector.d.ts

@@ -1,5 +1,5 @@
 import type { IBlobStorageConnector } from "@twin.org/blob-storage-models";
-import type { IAzureBlobStorageConnectorConfig } from "./models/IAzureBlobStorageConnectorConfig";
+import type { IAzureBlobStorageConnectorConstructorOptions } from "./models/IAzureBlobStorageConnectorConstructorOptions";
 /**
  * Class for performing blob storage operations on Azure.
  * See https://learn.microsoft.com/en-us/azure/storage/common/storage-samples-javascript?toc=%2Fazure%2Fstorage%2Fblobs%2Ftoc.json for more information.
@@ -16,11 +16,8 @@ export declare class AzureBlobStorageConnector implements IBlobStorageConnector
     /**
      * Create a new instance of AzureBlobStorageConnector.
      * @param options The options for the connector.
-     * @param options.config The configuration for the connector.
      */
-    constructor(options: {
-        config: IAzureBlobStorageConnectorConfig;
-    });
+    constructor(options: IAzureBlobStorageConnectorConstructorOptions);
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
      * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./azureBlobStorageConnector";
 export * from "./models/IAzureBlobStorageConnectorConfig";
+export * from "./models/IAzureBlobStorageConnectorConstructorOptions";

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

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

package/docs/changelog.md

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

package/docs/reference/classes/AzureBlobStorageConnector.md

@@ -17,13 +17,11 @@ Create a new instance of AzureBlobStorageConnector.
 
 #### Parameters
 
-• **options**
+##### options
 
-The options for the connector.
-
-• **options.config**: [`IAzureBlobStorageConnectorConfig`](../interfaces/IAzureBlobStorageConnectorConfig.md)
+[`IAzureBlobStorageConnectorConstructorOptions`](../interfaces/IAzureBlobStorageConnectorConstructorOptions.md)
 
-The configuration for the connector.
+The options for the connector.
 
 #### Returns
 
@@ -59,7 +57,9 @@ Bootstrap the component by creating and initializing any resources it needs.
 
 #### Parameters
 
-• **nodeLoggingConnectorType?**: `string`
+##### nodeLoggingConnectorType?
+
+`string`
 
 The node logging connector type, defaults to "node-logging".
 
@@ -83,7 +83,9 @@ Set the blob.
 
 #### Parameters
 
-• **blob**: `Uint8Array`
+##### blob
+
+`Uint8Array`
 
 The data for the blob.
 
@@ -107,7 +109,9 @@ Get the blob.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the blob to get in urn format.
 
@@ -131,7 +135,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
 
 - [IAzureBlobStorageConnectorConfig](interfaces/IAzureBlobStorageConnectorConfig.md)
+- [IAzureBlobStorageConnectorConstructorOptions](interfaces/IAzureBlobStorageConnectorConstructorOptions.md)

package/docs/reference/interfaces/IAzureBlobStorageConnectorConstructorOptions.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-connector-azure",
-	"version": "0.0.1-next.16",
+	"version": "0.0.1-next.18",
 	"description": "Blob Storage connector implementation using Azure",
 	"repository": {
 		"type": "git",
@@ -14,8 +14,8 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@azure/storage-blob": "^12.25.0",
-		"@twin.org/blob-storage-models": "0.0.1-next.16",
+		"@azure/storage-blob": "^12.26.0",
+		"@twin.org/blob-storage-models": "0.0.1-next.18",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/logging-models": "next",