@alepha/bucket-azure 0.13.1 → 0.13.2

package/dist/index.d.ts

@@ -11,7 +11,7 @@ import "node:fs";
 
 //#region ../alepha/src/core/constants/KIND.d.ts
 /**
- * Used for identifying descriptors.
+ * Used for identifying primitives.
  *
  * @internal
  */
@@ -64,34 +64,50 @@ interface ServiceSubstitution<T extends object = any> {
  */
 type ServiceEntry<T extends object = any> = Service<T> | ServiceSubstitution<T>;
 //#endregion
-//#region ../alepha/src/core/helpers/descriptor.d.ts
-interface DescriptorArgs<T extends object = {}> {
+//#region ../alepha/src/core/helpers/primitive.d.ts
+interface PrimitiveArgs<T extends object = {}> {
   options: T;
   alepha: Alepha;
   service: InstantiableClass<Service>;
   module?: Service;
 }
-interface DescriptorConfig {
+interface PrimitiveConfig {
   propertyKey: string;
   service: InstantiableClass<Service>;
   module?: Service;
 }
-declare abstract class Descriptor<T extends object = {}> {
+declare abstract class Primitive<T extends object = {}> {
   protected readonly alepha: Alepha;
   readonly options: T;
-  readonly config: DescriptorConfig;
-  constructor(args: DescriptorArgs<T>);
+  readonly config: PrimitiveConfig;
+  constructor(args: PrimitiveArgs<T>);
   /**
-   * Called automatically by Alepha after the descriptor is created.
+   * Called automatically by Alepha after the primitive is created.
    */
   protected onInit(): void;
 }
-type DescriptorFactoryLike<T extends object = any> = {
+type PrimitiveFactoryLike<T extends object = any> = {
   (options: T): any;
   [KIND]: any;
 };
 //#endregion
-//#region ../alepha/src/core/descriptors/$inject.d.ts
+//#region ../alepha/src/core/interfaces/Async.d.ts
+/**
+ * Represents a value that can be either a value or a promise of value.
+ */
+type Async<T> = T | Promise<T>;
+//#endregion
+//#region ../alepha/src/core/interfaces/LoggerInterface.d.ts
+type LogLevel = "ERROR" | "WARN" | "INFO" | "DEBUG" | "TRACE" | "SILENT";
+interface LoggerInterface {
+  trace(message: string, data?: unknown): void;
+  debug(message: string, data?: unknown): void;
+  info(message: string, data?: unknown): void;
+  warn(message: string, data?: unknown): void;
+  error(message: string, data?: unknown): void;
+}
+//#endregion
+//#region ../alepha/src/core/primitives/$inject.d.ts
 interface InjectOptions<T extends object = any> {
   /**
    * - 'transient' → Always a new instance on every inject. Zero caching.
@@ -116,8 +132,8 @@ interface InjectOptions<T extends object = any> {
   parent?: Service | null;
 }
 //#endregion
-//#region ../alepha/src/core/descriptors/$module.d.ts
-interface ModuleDescriptorOptions {
+//#region ../alepha/src/core/primitives/$module.d.ts
+interface ModulePrimitiveOptions {
   /**
    * Name of the module.
    *
@@ -132,9 +148,9 @@ interface ModuleDescriptorOptions {
    */
   services?: Array<Service>;
   /**
-   * List of $descriptors to register in the module.
+   * List of $primitives to register in the module.
    */
-  descriptors?: Array<DescriptorFactoryLike>;
+  primitives?: Array<PrimitiveFactoryLike>;
   /**
    * By default, module will register ALL services.
    * You can override this behavior by providing a register function.
@@ -148,7 +164,7 @@ interface ModuleDescriptorOptions {
  * Base class for all modules.
  */
 declare abstract class Module {
-  abstract readonly options: ModuleDescriptorOptions;
+  abstract readonly options: ModulePrimitiveOptions;
   abstract register(alepha: Alepha): void;
   static NAME_REGEX: RegExp;
   /**
@@ -163,22 +179,6 @@ declare abstract class Module {
   static of(ctor: Service): Service<Module> | undefined;
 }
 //#endregion
-//#region ../alepha/src/core/interfaces/Async.d.ts
-/**
- * Represents a value that can be either a value or a promise of value.
- */
-type Async<T> = T | Promise<T>;
-//#endregion
-//#region ../alepha/src/core/interfaces/LoggerInterface.d.ts
-type LogLevel = "ERROR" | "WARN" | "INFO" | "DEBUG" | "TRACE" | "SILENT";
-interface LoggerInterface {
-  trace(message: string, data?: unknown): void;
-  debug(message: string, data?: unknown): void;
-  info(message: string, data?: unknown): void;
-  warn(message: string, data?: unknown): void;
-  error(message: string, data?: unknown): void;
-}
-//#endregion
 //#region ../alepha/src/core/providers/AlsProvider.d.ts
 type AsyncLocalStorageData = any;
 declare class AlsProvider {
@@ -440,7 +440,7 @@ declare class EventManager {
   }): Promise<void>;
 }
 //#endregion
-//#region ../alepha/src/core/descriptors/$atom.d.ts
+//#region ../alepha/src/core/primitives/$atom.d.ts
 type AtomOptions<T extends TAtomObject, N extends string> = {
   name: N;
   schema: T;
@@ -569,7 +569,7 @@ type OnlyArray<T extends object> = { [K in keyof T]: NonNullable<T[K]> extends A
  * // You can access the environment variables using alepha.env
  * console.log(alepha.env.MY_VAR); // "value"
  *
- * // But you should use $env() descriptor to get typed values from the environment.
+ * // But you should use $env() primitive to get typed values from the environment.
  * class App {
  *   env = $env(
  *     t.object({
@@ -582,7 +582,7 @@ type OnlyArray<T extends object> = { [K in keyof T]: NonNullable<T[K]> extends A
  * ### Modules
  *
  * Modules are a way to group services together.
- * You can register a module using the `$module` descriptor.
+ * You can register a module using the `$module` primitive.
  *
  * ```ts
  * import { $module } from "alepha";
@@ -600,7 +600,7 @@ type OnlyArray<T extends object> = { [K in keyof T]: NonNullable<T[K]> extends A
  * ### Hooks
  *
  * Hooks are a way to run async functions from all registered providers/services.
- * You can register a hook using the `$hook` descriptor.
+ * You can register a hook using the `$hook` primitive.
  *
  * ```ts
  * import { $hook } from "alepha";
@@ -697,9 +697,9 @@ declare class Alepha {
     use: Service;
   }>;
   /**
-   * Registry of descriptors.
+   * Registry of primitives.
    */
-  protected descriptorRegistry: Map<Service<Descriptor<{}>>, Descriptor<{}>[]>;
+  protected primitiveRegistry: Map<Service<Primitive<{}>>, Primitive<{}>[]>;
   /**
    *  List of all services + how they are provided.
    */
@@ -719,7 +719,7 @@ declare class Alepha {
   /**
    * State manager to store arbitrary values.
    */
-  get state(): StateManager<State>;
+  get store(): StateManager<State>;
   /**
    * Codec manager for encoding and decoding data with different formats.
    *
@@ -792,7 +792,7 @@ declare class Alepha {
    * Starts the App.
    *
    * - Lock any further changes to the container.
-   * - Run "configure" hook for all services. Descriptors will be processed.
+   * - Run "configure" hook for all services. Primitives will be processed.
    * - Run "start" hook for all services. Providers will connect/listen/...
    * - Run "ready" hook for all services. This is the point where the App is ready to serve requests.
    *
@@ -897,13 +897,13 @@ declare class Alepha {
   }>;
   services<T extends object>(base: Service<T>): Array<T>;
   /**
-   * Get all descriptors of the specified type.
+   * Get all primitives of the specified type.
    */
-  descriptors<TDescriptor extends Descriptor>(factory: {
-    [KIND]: InstantiableClass<TDescriptor>;
-  } | string): Array<TDescriptor>;
+  primitives<TPrimitive extends Primitive>(factory: {
+    [KIND]: InstantiableClass<TPrimitive>;
+  } | string): Array<TPrimitive>;
   protected new<T extends object>(service: Service<T>, args?: any[]): T;
-  protected processDescriptor(value: Descriptor, propertyKey?: string): void;
+  protected processPrimitive(value: Primitive, propertyKey?: string): void;
 }
 interface Hook<T extends keyof Hooks = any> {
   caller?: Service;
@@ -1030,34 +1030,6 @@ interface Hooks {
   };
 }
 //#endregion
-//#region ../alepha/src/core/descriptors/$hook.d.ts
-interface HookOptions<T extends keyof Hooks> {
-  /**
-   * The name of the hook. "configure", "start", "ready", "stop", ...
-   */
-  on: T;
-  /**
-   * The handler to run when the hook is triggered.
-   */
-  handler: (args: Hooks[T]) => Async<any>;
-  /**
-   * Force the hook to run first or last on the list of hooks.
-   */
-  priority?: "first" | "last";
-  /**
-   * Empty placeholder, not implemented yet. :-)
-   */
-  before?: object | Array<object>;
-  /**
-   * Empty placeholder, not implemented yet. :-)
-   */
-  after?: object | Array<object>;
-}
-declare class HookDescriptor<T extends keyof Hooks> extends Descriptor<HookOptions<T>> {
-  called: number;
-  protected onInit(): void;
-}
-//#endregion
 //#region ../alepha/src/core/schemas/pageSchema.d.ts
 declare const pageMetadataSchema: TObject$1<{
   number: TInteger;
@@ -1090,6 +1062,34 @@ declare module "alepha" {
   }
 }
 //#endregion
+//#region ../alepha/src/core/primitives/$hook.d.ts
+interface HookOptions<T extends keyof Hooks> {
+  /**
+   * The name of the hook. "configure", "start", "ready", "stop", ...
+   */
+  on: T;
+  /**
+   * The handler to run when the hook is triggered.
+   */
+  handler: (args: Hooks[T]) => Async<any>;
+  /**
+   * Force the hook to run first or last on the list of hooks.
+   */
+  priority?: "first" | "last";
+  /**
+   * Empty placeholder, not implemented yet. :-)
+   */
+  before?: object | Array<object>;
+  /**
+   * Empty placeholder, not implemented yet. :-)
+   */
+  after?: object | Array<object>;
+}
+declare class HookPrimitive<T extends keyof Hooks> extends Primitive<HookOptions<T>> {
+  called: number;
+  protected onInit(): void;
+}
+//#endregion
 //#region ../alepha/src/logger/schemas/logEntrySchema.d.ts
 declare const logEntrySchema: TObject$1<{
   level: TUnsafe<"SILENT" | "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR">;
@@ -1114,8 +1114,8 @@ declare class DateTimeProvider {
   protected readonly timeouts: Timeout[];
   protected readonly intervals: Interval[];
   constructor();
-  protected readonly onStart: HookDescriptor<"start">;
-  protected readonly onStop: HookDescriptor<"stop">;
+  protected readonly onStart: HookPrimitive<"start">;
+  protected readonly onStop: HookPrimitive<"stop">;
   setLocale(locale: string): void;
   isDateTime(value: unknown): value is DateTime;
   /**
@@ -1733,8 +1733,8 @@ declare class MemoryFileStorageProvider implements FileStorageProvider {
   protected createId(): string;
 }
 //#endregion
-//#region ../alepha/src/bucket/descriptors/$bucket.d.ts
-interface BucketDescriptorOptions extends BucketFileOptions {
+//#region ../alepha/src/bucket/primitives/$bucket.d.ts
+interface BucketPrimitiveOptions extends BucketFileOptions {
   /**
    * File storage provider configuration for the bucket.
    *
@@ -1866,7 +1866,7 @@ interface BucketFileOptions {
    */
   maxSize?: number;
 }
-declare class BucketDescriptor extends Descriptor<BucketDescriptorOptions> {
+declare class BucketPrimitive extends Primitive<BucketPrimitiveOptions> {
   readonly provider: FileStorageProvider | MemoryFileStorageProvider;
   private readonly fileSystem;
   get name(): string;
@@ -1929,7 +1929,7 @@ declare module "alepha" {
     "bucket:file:uploaded": {
       id: string;
       file: FileLike;
-      bucket: BucketDescriptor;
+      bucket: BucketPrimitive;
       options: BucketFileOptions;
     };
     /**
@@ -1937,14 +1937,14 @@ declare module "alepha" {
      */
     "bucket:file:deleted": {
       id: string;
-      bucket: BucketDescriptor;
+      bucket: BucketPrimitive;
     };
   }
 }
 /**
- * Provides file storage capabilities through declarative bucket descriptors with support for multiple storage backends.
+ * Provides file storage capabilities through declarative bucket primitives with support for multiple storage backends.
  *
- * The bucket module enables unified file operations across different storage systems using the `$bucket` descriptor
+ * The bucket module enables unified file operations across different storage systems using the `$bucket` primitive
  * on class properties. It abstracts storage provider differences, offering consistent APIs for local filesystem,
  * cloud storage, or in-memory storage for testing environments.
  *
@@ -1975,7 +1975,7 @@ declare class AzureFileStorageProvider implements FileStorageProvider {
   protected readonly blobServiceClient: BlobServiceClient;
   readonly options: StoragePipelineOptions;
   constructor();
-  protected readonly onStart: HookDescriptor<"start">;
+  protected readonly onStart: HookPrimitive<"start">;
   convertName(name: string): string;
   upload(bucketName: string, file: FileLike, fileId?: string): Promise<string>;
   download(bucketName: string, fileId: string): Promise<FileLike>;

package/dist/index.js

@@ -27,7 +27,7 @@ var AzureFileStorageProvider = class {
 	onStart = $hook({
 		on: "start",
 		handler: async () => {
-			for (const bucket of this.alepha.descriptors($bucket)) {
+			for (const bucket of this.alepha.primitives($bucket)) {
 				if (bucket.provider !== this) continue;
 				const containerName = this.convertName(bucket.name);
 				this.log.debug(`Prepare container '${containerName}' ...`);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"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,YAAY,EAAE,OAAO,EACzB,8BAA8B,EAAE,QAAQ,EACzC,CAAC;;;;AASF,IAAa,2BAAb,MAAqE;CACnE,AAAmB,MAAM,SAAS;CAClC,AAAmB,MAAM,KAAK,UAAU;CACxC,AAAmB,SAAS,QAAQ,OAAO;CAC3C,AAAmB,OAAO,QAAQ,iBAAiB;CACnD,AAAmB,aAAa,QAAQ,mBAAmB;CAC3D,AAAmB,aAA8C,EAAE;CACnE,AAAmB;CAEnB,AAAgB,UAAkC,EAAE;CAEpD,cAAc;AACZ,OAAK,oBAAoB,kBAAkB,qBACzC,KAAK,IAAI,8BACT,KAAK,QACN;;CAGH,AAAmB,UAAU,MAAM;EACjC,IAAI;EACJ,SAAS,YAAY;AACnB,QAAK,MAAM,UAAU,KAAK,OAAO,YAAY,QAAQ,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,aACV,SAAS,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,IAAI,kBAAkB,0BAA0B,EAAE,OAAO,OAAO,CAAC;AAGzE,SAAM;IACN;AAEF,MAAI,CAAC,KAAK,mBACR,OAAM,IAAI,kBAAkB,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,IAAI,kBAAkB,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,IAAI,kBACR,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,SAAO,YAAY;;;;;;;;;;;;AC3LvB,MAAa,oBAAoB,QAAQ;CACvC,MAAM;CACN,UAAU,CAAC,yBAAyB;CACpC,WAAW,WACT,OACG,KAAK;EACJ,UAAU;EACV,SAAS;EACT,KAAK;EACN,CAAC,CACD,KAAK,aAAa;CACxB,CAAC"}
+{"version":3,"file":"index.js","names":[],"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.primitives($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,YAAY,EAAE,OAAO,EACzB,8BAA8B,EAAE,QAAQ,EACzC,CAAC;;;;AASF,IAAa,2BAAb,MAAqE;CACnE,AAAmB,MAAM,SAAS;CAClC,AAAmB,MAAM,KAAK,UAAU;CACxC,AAAmB,SAAS,QAAQ,OAAO;CAC3C,AAAmB,OAAO,QAAQ,iBAAiB;CACnD,AAAmB,aAAa,QAAQ,mBAAmB;CAC3D,AAAmB,aAA8C,EAAE;CACnE,AAAmB;CAEnB,AAAgB,UAAkC,EAAE;CAEpD,cAAc;AACZ,OAAK,oBAAoB,kBAAkB,qBACzC,KAAK,IAAI,8BACT,KAAK,QACN;;CAGH,AAAmB,UAAU,MAAM;EACjC,IAAI;EACJ,SAAS,YAAY;AACnB,QAAK,MAAM,UAAU,KAAK,OAAO,WAAW,QAAQ,EAAE;AACpD,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,aACV,SAAS,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,IAAI,kBAAkB,0BAA0B,EAAE,OAAO,OAAO,CAAC;AAGzE,SAAM;IACN;AAEF,MAAI,CAAC,KAAK,mBACR,OAAM,IAAI,kBAAkB,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,IAAI,kBAAkB,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,IAAI,kBACR,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,SAAO,YAAY;;;;;;;;;;;;AC3LvB,MAAa,oBAAoB,QAAQ;CACvC,MAAM;CACN,UAAU,CAAC,yBAAyB;CACpC,WAAW,WACT,OACG,KAAK;EACJ,UAAU;EACV,SAAS;EACT,KAAK;EACN,CAAC,CACD,KAAK,aAAa;CACxB,CAAC"}

package/package.json

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

package/src/providers/AzureFileStorageProvider.ts

@@ -56,7 +56,7 @@ export class AzureFileStorageProvider implements FileStorageProvider {
   protected readonly onStart = $hook({
     on: "start",
     handler: async () => {
-      for (const bucket of this.alepha.descriptors($bucket)) {
+      for (const bucket of this.alepha.primitives($bucket)) {
         if (bucket.provider !== this) {
           continue;
         }