@alepha/bucket-azure 0.12.1 → 0.13.1

package/package.json

@@ -10,7 +10,7 @@
     "storage-blob"
   ],
   "author": "Nicolas Foures",
-  "version": "0.12.1",
+  "version": "0.13.1",
   "type": "module",
   "engines": {
     "node": ">=22.0.0"
@@ -26,12 +26,12 @@
     "@azure/storage-blob": "^12.29.1"
   },
   "devDependencies": {
-    "alepha": "0.12.1",
+    "alepha": "0.13.1",
     "tsdown": "^0.16.7",
     "vitest": "^4.0.14"
   },
   "peerDependencies": {
-    "alepha": "0.12.1"
+    "alepha": "0.13.1"
   },
   "scripts": {
     "lint": "alepha lint",

package/dist/chunk-MC1wKe0N.js

@@ -1,27 +0,0 @@
-//#region rolldown:runtime
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-	if (from && typeof from === "object" || typeof from === "function") {
-		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
-			key = keys[i];
-			if (!__hasOwnProp.call(to, key) && key !== except) {
-				__defProp(to, key, {
-					get: ((k) => from[k]).bind(null, key),
-					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
-				});
-			}
-		}
-	}
-	return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
-	value: mod,
-	enumerable: true
-}) : target, mod));
-
-//#endregion

package/dist/index.cjs

@@ -1,126 +0,0 @@
-let alepha = require("alepha");
-let alepha_bucket = require("alepha/bucket");
-let node_crypto = require("node:crypto");
-let node_stream = require("node:stream");
-let __azure_storage_blob = require("@azure/storage-blob");
-let alepha_datetime = require("alepha/datetime");
-let alepha_file = require("alepha/file");
-let alepha_logger = require("alepha/logger");
-
-//#region src/providers/AzureFileStorageProvider.ts
-const envSchema = alepha.t.object({ AZ_STORAGE_CONNECTION_STRING: alepha.t.string() });
-/**
-* Azure Blog Storage implementation of File Storage Provider.
-*/
-var AzureFileStorageProvider = class {
-	log = (0, alepha_logger.$logger)();
-	env = (0, alepha.$env)(envSchema);
-	alepha = (0, alepha.$inject)(alepha.Alepha);
-	time = (0, alepha.$inject)(alepha_datetime.DateTimeProvider);
-	fileSystem = (0, alepha.$inject)(alepha_file.FileSystemProvider);
-	containers = {};
-	blobServiceClient;
-	options = {};
-	constructor() {
-		this.blobServiceClient = __azure_storage_blob.BlobServiceClient.fromConnectionString(this.env.AZ_STORAGE_CONNECTION_STRING, this.options);
-	}
-	onStart = (0, alepha.$hook)({
-		on: "start",
-		handler: async () => {
-			for (const bucket of this.alepha.descriptors(alepha_bucket.$bucket)) {
-				if (bucket.provider !== this) continue;
-				const containerName = this.convertName(bucket.name);
-				this.log.debug(`Prepare container '${containerName}' ...`);
-				if (!this.containers[containerName]) this.containers[containerName] = await this.createContainerClient(containerName);
-				this.log.info(`Container '${bucket.name}' OK`);
-			}
-		}
-	});
-	convertName(name) {
-		return name.replaceAll("/", "-").toLowerCase();
-	}
-	async upload(bucketName, file, fileId) {
-		fileId ??= this.createId();
-		this.log.trace(`Uploading file '${file.name}' to bucket '${bucketName}' with id '${fileId}'...`);
-		const block = this.getBlock(bucketName, fileId);
-		const metadata = {
-			name: file.name,
-			type: file.type
-		};
-		if (file.filepath) await block.uploadFile(file.filepath, {
-			metadata,
-			blobHTTPHeaders: { blobContentType: file.type }
-		});
-		else if (file.size > 0) await block.uploadData(await file.arrayBuffer(), {
-			metadata,
-			blobHTTPHeaders: { blobContentType: file.type }
-		});
-		else await block.uploadStream(node_stream.Readable.from(file.stream()), file.size || void 0, 5, {
-			metadata,
-			blobHTTPHeaders: { blobContentType: file.type }
-		});
-		return fileId;
-	}
-	async download(bucketName, fileId) {
-		this.log.trace(`Downloading file '${fileId}' from bucket '${bucketName}'...`);
-		const blob = await this.getBlock(bucketName, fileId).download().catch((error) => {
-			if (error instanceof Error) throw new alepha_bucket.FileNotFoundError("Error downloading file", { cause: error });
-			throw error;
-		});
-		if (!blob.readableStreamBody) throw new alepha_bucket.FileNotFoundError("File not found - empty stream body");
-		return this.fileSystem.createFile({
-			stream: blob.readableStreamBody,
-			...blob.metadata,
-			size: blob.contentLength
-		});
-	}
-	async exists(bucketName, fileId) {
-		this.log.trace(`Checking existence of file '${fileId}' in bucket '${bucketName}'...`);
-		return await this.getBlock(bucketName, fileId).exists();
-	}
-	async delete(bucketName, fileId) {
-		this.log.trace(`Deleting file '${fileId}' from bucket '${bucketName}'...`);
-		try {
-			await this.getBlock(bucketName, fileId).delete();
-		} catch (error) {
-			if (error instanceof Error) throw new alepha_bucket.FileNotFoundError("Error deleting file", { cause: error });
-			throw error;
-		}
-	}
-	getBlock(container, fileId) {
-		const containerName = this.convertName(container);
-		if (!this.containers[containerName]) throw new alepha_bucket.FileNotFoundError(`File '${fileId}' not found - container '${container}' does not exists`);
-		return this.containers[containerName].getBlockBlobClient(fileId);
-	}
-	async createContainerClient(name) {
-		const container = this.blobServiceClient.getContainerClient(name);
-		await this.time.deadline((abortSignal) => container.createIfNotExists({ abortSignal }), [5, "seconds"]);
-		return container;
-	}
-	createId() {
-		return (0, node_crypto.randomUUID)();
-	}
-};
-
-//#endregion
-//#region src/index.ts
-/**
-* Plugin for Alepha Bucket that provides Azure Blob Storage capabilities.
-*
-* @see {@link AzureFileStorageProvider}
-* @module alepha.bucket.azure
-*/
-const AlephaBucketAzure = (0, alepha.$module)({
-	name: "alepha.bucket.azure",
-	services: [AzureFileStorageProvider],
-	register: (alepha$1) => alepha$1.with({
-		optional: true,
-		provide: alepha_bucket.FileStorageProvider,
-		use: AzureFileStorageProvider
-	}).with(alepha_bucket.AlephaBucket)
-});
-
-//#endregion
-exports.AlephaBucketAzure = AlephaBucketAzure;
-exports.AzureFileStorageProvider = AzureFileStorageProvider;
-//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","names":["t","Alepha","DateTimeProvider","FileSystemProvider","BlobServiceClient","$bucket","Readable","FileNotFoundError","alepha","FileStorageProvider","AlephaBucket"],"sources":["../src/providers/AzureFileStorageProvider.ts","../src/index.ts"],"sourcesContent":["import { randomUUID } from \"node:crypto\";\nimport { Readable } from \"node:stream\";\nimport {\n  BlobServiceClient,\n  type BlockBlobClient,\n  type ContainerClient,\n  type StoragePipelineOptions,\n} from \"@azure/storage-blob\";\nimport {\n  $env,\n  $hook,\n  $inject,\n  Alepha,\n  type FileLike,\n  type Static,\n  t,\n} from \"alepha\";\nimport {\n  $bucket,\n  FileNotFoundError,\n  type FileStorageProvider,\n} from \"alepha/bucket\";\nimport { DateTimeProvider } from \"alepha/datetime\";\nimport { FileSystemProvider } from \"alepha/file\";\nimport { $logger } from \"alepha/logger\";\n\nconst envSchema = t.object({\n  AZ_STORAGE_CONNECTION_STRING: t.string(),\n});\n\ndeclare module \"alepha\" {\n  interface Env extends Partial<Static<typeof envSchema>> {}\n}\n\n/**\n * Azure Blog Storage implementation of File Storage Provider.\n */\nexport class AzureFileStorageProvider implements FileStorageProvider {\n  protected readonly log = $logger();\n  protected readonly env = $env(envSchema);\n  protected readonly alepha = $inject(Alepha);\n  protected readonly time = $inject(DateTimeProvider);\n  protected readonly fileSystem = $inject(FileSystemProvider);\n  protected readonly containers: Record<string, ContainerClient> = {};\n  protected readonly blobServiceClient: BlobServiceClient;\n\n  public readonly options: StoragePipelineOptions = {};\n\n  constructor() {\n    this.blobServiceClient = BlobServiceClient.fromConnectionString(\n      this.env.AZ_STORAGE_CONNECTION_STRING,\n      this.options,\n    );\n  }\n\n  protected readonly onStart = $hook({\n    on: \"start\",\n    handler: async () => {\n      for (const bucket of this.alepha.descriptors($bucket)) {\n        if (bucket.provider !== this) {\n          continue;\n        }\n\n        const containerName = this.convertName(bucket.name);\n\n        this.log.debug(`Prepare container '${containerName}' ...`);\n\n        if (!this.containers[containerName]) {\n          this.containers[containerName] =\n            await this.createContainerClient(containerName);\n        }\n\n        this.log.info(`Container '${bucket.name}' OK`);\n      }\n    },\n  });\n\n  public convertName(name: string): string {\n    // Azure Blob Storage does not allow uppercase letters in container names\n    return name.replaceAll(\"/\", \"-\").toLowerCase();\n  }\n\n  public async upload(\n    bucketName: string,\n    file: FileLike,\n    fileId?: string,\n  ): Promise<string> {\n    fileId ??= this.createId();\n\n    this.log.trace(\n      `Uploading file '${file.name}' to bucket '${bucketName}' with id '${fileId}'...`,\n    );\n\n    const block = this.getBlock(bucketName, fileId);\n\n    const metadata = {\n      name: file.name,\n      type: file.type,\n    };\n\n    if (file.filepath) {\n      await block.uploadFile(file.filepath, {\n        metadata,\n        blobHTTPHeaders: {\n          blobContentType: file.type,\n        },\n      });\n    } else if (file.size > 0) {\n      await block.uploadData(await file.arrayBuffer(), {\n        metadata,\n        blobHTTPHeaders: {\n          blobContentType: file.type,\n        },\n      });\n    } else {\n      await block.uploadStream(\n        Readable.from(file.stream()),\n        file.size || undefined,\n        5,\n        {\n          metadata,\n          blobHTTPHeaders: {\n            blobContentType: file.type,\n          },\n        },\n      );\n    }\n\n    return fileId;\n  }\n\n  public async download(bucketName: string, fileId: string): Promise<FileLike> {\n    this.log.trace(\n      `Downloading file '${fileId}' from bucket '${bucketName}'...`,\n    );\n    const block = this.getBlock(bucketName, fileId);\n\n    const blob = await block.download().catch((error) => {\n      if (error instanceof Error) {\n        throw new FileNotFoundError(\"Error downloading file\", { cause: error });\n      }\n\n      throw error;\n    });\n\n    if (!blob.readableStreamBody) {\n      throw new FileNotFoundError(\"File not found - empty stream body\");\n    }\n\n    return this.fileSystem.createFile({\n      stream: blob.readableStreamBody,\n      ...blob.metadata,\n      size: blob.contentLength,\n    });\n  }\n\n  public async exists(bucketName: string, fileId: string): Promise<boolean> {\n    this.log.trace(\n      `Checking existence of file '${fileId}' in bucket '${bucketName}'...`,\n    );\n    return await this.getBlock(bucketName, fileId).exists();\n  }\n\n  public async delete(bucketName: string, fileId: string): Promise<void> {\n    this.log.trace(`Deleting file '${fileId}' from bucket '${bucketName}'...`);\n    try {\n      await this.getBlock(bucketName, fileId).delete();\n    } catch (error) {\n      if (error instanceof Error) {\n        throw new FileNotFoundError(\"Error deleting file\", { cause: error });\n      }\n      throw error;\n    }\n  }\n\n  public getBlock(container: string, fileId: string): BlockBlobClient {\n    const containerName = this.convertName(container);\n\n    if (!this.containers[containerName]) {\n      throw new FileNotFoundError(\n        `File '${fileId}' not found - container '${container}' does not exists`,\n      );\n    }\n\n    return this.containers[containerName].getBlockBlobClient(fileId);\n  }\n\n  protected async createContainerClient(\n    name: string,\n  ): Promise<ContainerClient> {\n    const container = this.blobServiceClient.getContainerClient(name);\n\n    await this.time.deadline(\n      (abortSignal) => container.createIfNotExists({ abortSignal }),\n      [5, \"seconds\"],\n    );\n\n    return container;\n  }\n\n  protected createId(): string {\n    return randomUUID();\n  }\n}\n","import { $module } from \"alepha\";\nimport { AlephaBucket, FileStorageProvider } from \"alepha/bucket\";\nimport { AzureFileStorageProvider } from \"./providers/AzureFileStorageProvider.ts\";\n\nexport * from \"./providers/AzureFileStorageProvider.ts\";\n\n// ---------------------------------------------------------------------------------------------------------------------\n\n/**\n * Plugin for Alepha Bucket that provides Azure Blob Storage capabilities.\n *\n * @see {@link AzureFileStorageProvider}\n * @module alepha.bucket.azure\n */\nexport const AlephaBucketAzure = $module({\n  name: \"alepha.bucket.azure\",\n  services: [AzureFileStorageProvider],\n  register: (alepha) =>\n    alepha\n      .with({\n        optional: true,\n        provide: FileStorageProvider,\n        use: AzureFileStorageProvider,\n      })\n      .with(AlephaBucket),\n});\n"],"mappings":";;;;;;;;;;AA0BA,MAAM,YAAYA,SAAE,OAAO,EACzB,8BAA8BA,SAAE,QAAQ,EACzC,CAAC;;;;AASF,IAAa,2BAAb,MAAqE;CACnE,AAAmB,kCAAe;CAClC,AAAmB,uBAAW,UAAU;CACxC,AAAmB,6BAAiBC,cAAO;CAC3C,AAAmB,2BAAeC,iCAAiB;CACnD,AAAmB,iCAAqBC,+BAAmB;CAC3D,AAAmB,aAA8C,EAAE;CACnE,AAAmB;CAEnB,AAAgB,UAAkC,EAAE;CAEpD,cAAc;AACZ,OAAK,oBAAoBC,uCAAkB,qBACzC,KAAK,IAAI,8BACT,KAAK,QACN;;CAGH,AAAmB,4BAAgB;EACjC,IAAI;EACJ,SAAS,YAAY;AACnB,QAAK,MAAM,UAAU,KAAK,OAAO,YAAYC,sBAAQ,EAAE;AACrD,QAAI,OAAO,aAAa,KACtB;IAGF,MAAM,gBAAgB,KAAK,YAAY,OAAO,KAAK;AAEnD,SAAK,IAAI,MAAM,sBAAsB,cAAc,OAAO;AAE1D,QAAI,CAAC,KAAK,WAAW,eACnB,MAAK,WAAW,iBACd,MAAM,KAAK,sBAAsB,cAAc;AAGnD,SAAK,IAAI,KAAK,cAAc,OAAO,KAAK,MAAM;;;EAGnD,CAAC;CAEF,AAAO,YAAY,MAAsB;AAEvC,SAAO,KAAK,WAAW,KAAK,IAAI,CAAC,aAAa;;CAGhD,MAAa,OACX,YACA,MACA,QACiB;AACjB,aAAW,KAAK,UAAU;AAE1B,OAAK,IAAI,MACP,mBAAmB,KAAK,KAAK,eAAe,WAAW,aAAa,OAAO,MAC5E;EAED,MAAM,QAAQ,KAAK,SAAS,YAAY,OAAO;EAE/C,MAAM,WAAW;GACf,MAAM,KAAK;GACX,MAAM,KAAK;GACZ;AAED,MAAI,KAAK,SACP,OAAM,MAAM,WAAW,KAAK,UAAU;GACpC;GACA,iBAAiB,EACf,iBAAiB,KAAK,MACvB;GACF,CAAC;WACO,KAAK,OAAO,EACrB,OAAM,MAAM,WAAW,MAAM,KAAK,aAAa,EAAE;GAC/C;GACA,iBAAiB,EACf,iBAAiB,KAAK,MACvB;GACF,CAAC;MAEF,OAAM,MAAM,aACVC,qBAAS,KAAK,KAAK,QAAQ,CAAC,EAC5B,KAAK,QAAQ,QACb,GACA;GACE;GACA,iBAAiB,EACf,iBAAiB,KAAK,MACvB;GACF,CACF;AAGH,SAAO;;CAGT,MAAa,SAAS,YAAoB,QAAmC;AAC3E,OAAK,IAAI,MACP,qBAAqB,OAAO,iBAAiB,WAAW,MACzD;EAGD,MAAM,OAAO,MAFC,KAAK,SAAS,YAAY,OAAO,CAEtB,UAAU,CAAC,OAAO,UAAU;AACnD,OAAI,iBAAiB,MACnB,OAAM,IAAIC,gCAAkB,0BAA0B,EAAE,OAAO,OAAO,CAAC;AAGzE,SAAM;IACN;AAEF,MAAI,CAAC,KAAK,mBACR,OAAM,IAAIA,gCAAkB,qCAAqC;AAGnE,SAAO,KAAK,WAAW,WAAW;GAChC,QAAQ,KAAK;GACb,GAAG,KAAK;GACR,MAAM,KAAK;GACZ,CAAC;;CAGJ,MAAa,OAAO,YAAoB,QAAkC;AACxE,OAAK,IAAI,MACP,+BAA+B,OAAO,eAAe,WAAW,MACjE;AACD,SAAO,MAAM,KAAK,SAAS,YAAY,OAAO,CAAC,QAAQ;;CAGzD,MAAa,OAAO,YAAoB,QAA+B;AACrE,OAAK,IAAI,MAAM,kBAAkB,OAAO,iBAAiB,WAAW,MAAM;AAC1E,MAAI;AACF,SAAM,KAAK,SAAS,YAAY,OAAO,CAAC,QAAQ;WACzC,OAAO;AACd,OAAI,iBAAiB,MACnB,OAAM,IAAIA,gCAAkB,uBAAuB,EAAE,OAAO,OAAO,CAAC;AAEtE,SAAM;;;CAIV,AAAO,SAAS,WAAmB,QAAiC;EAClE,MAAM,gBAAgB,KAAK,YAAY,UAAU;AAEjD,MAAI,CAAC,KAAK,WAAW,eACnB,OAAM,IAAIA,gCACR,SAAS,OAAO,2BAA2B,UAAU,mBACtD;AAGH,SAAO,KAAK,WAAW,eAAe,mBAAmB,OAAO;;CAGlE,MAAgB,sBACd,MAC0B;EAC1B,MAAM,YAAY,KAAK,kBAAkB,mBAAmB,KAAK;AAEjE,QAAM,KAAK,KAAK,UACb,gBAAgB,UAAU,kBAAkB,EAAE,aAAa,CAAC,EAC7D,CAAC,GAAG,UAAU,CACf;AAED,SAAO;;CAGT,AAAU,WAAmB;AAC3B,sCAAmB;;;;;;;;;;;;AC3LvB,MAAa,wCAA4B;CACvC,MAAM;CACN,UAAU,CAAC,yBAAyB;CACpC,WAAW,aACTC,SACG,KAAK;EACJ,UAAU;EACV,SAASC;EACT,KAAK;EACN,CAAC,CACD,KAAKC,2BAAa;CACxB,CAAC"}