@alepha/bucket-azure 0.13.3 → 0.13.5

package/dist/{index.d.ts → index.d.mts}

@@ -2,12 +2,11 @@ import { Readable } from "node:stream";
 import { BlobServiceClient, BlockBlobClient, ContainerClient, StoragePipelineOptions } from "@azure/storage-blob";
 import * as typebox0 from "typebox";
 import { Static, StaticDecode as Static$1, StaticEncode, TAny, TArray, TArray as TArray$1, TBoolean, TInteger, TNumber, TObject, TObject as TObject$1, TOptional, TOptionalAdd, TRecord, TSchema, TSchema as TSchema$1, TString, TUnsafe } from "typebox";
-import { AsyncLocalStorage } from "node:async_hooks";
 import { ReadableStream as ReadableStream$1 } from "node:stream/web";
+import { AsyncLocalStorage } from "node:async_hooks";
 import { Validator } from "typebox/compile";
 import dayjsDuration from "dayjs/plugin/duration.js";
 import DayjsApi, { Dayjs, ManipulateType, PluginFunc } from "dayjs";
-import "node:fs";
 
 //#region ../alepha/src/core/constants/KIND.d.ts
 /**
@@ -107,6 +106,93 @@ interface LoggerInterface {
   error(message: string, data?: unknown): void;
 }
 //#endregion
+//#region ../alepha/src/core/helpers/FileLike.d.ts
+interface FileLike {
+  /**
+   * Filename.
+   * @default "file"
+   */
+  name: string;
+  /**
+   * Mandatory MIME type of the file.
+   * @default "application/octet-stream"
+   */
+  type: string;
+  /**
+   * Size of the file in bytes.
+   *
+   * Always 0 for streams, as the size is not known until the stream is fully read.
+   *
+   * @default 0
+   */
+  size: number;
+  /**
+   * Last modified timestamp in milliseconds since epoch.
+   *
+   * Always the current timestamp for streams, as the last modified time is not known.
+   * We use this field to ensure compatibility with File API.
+   *
+   * @default Date.now()
+   */
+  lastModified: number;
+  /**
+   * Returns a ReadableStream or Node.js Readable stream of the file content.
+   *
+   * For streams, this is the original stream.
+   */
+  stream(): StreamLike;
+  /**
+   * Returns the file content as an ArrayBuffer.
+   *
+   * For streams, this reads the entire stream into memory.
+   */
+  arrayBuffer(): Promise<ArrayBuffer>;
+  /**
+   * Returns the file content as a string.
+   *
+   * For streams, this reads the entire stream into memory and converts it to a string.
+   */
+  text(): Promise<string>;
+  /**
+   * Optional file path, if the file is stored on disk.
+   *
+   * This is not from the File API, but rather a custom field to indicate where the file is stored.
+   */
+  filepath?: string;
+}
+type StreamLike = ReadableStream | ReadableStream$1 | Readable | NodeJS.ReadableStream;
+//#endregion
+//#region ../alepha/src/core/providers/TypeProvider.d.ts
+declare module "typebox" {
+  interface TString {
+    format?: string;
+    minLength?: number;
+    maxLength?: number;
+  }
+  interface TNumber {
+    format?: "int64";
+  }
+}
+//#endregion
+//#region ../alepha/src/core/primitives/$atom.d.ts
+type AtomOptions<T extends TAtomObject, N extends string> = {
+  name: N;
+  schema: T;
+  description?: string;
+} & (T extends TOptionalAdd<T> ? {
+  default?: Static$1<T>;
+} : {
+  default: Static$1<T>;
+});
+declare class Atom<T extends TAtomObject = TObject$1, N extends string = string> {
+  readonly options: AtomOptions<T, N>;
+  get schema(): T;
+  get key(): N;
+  constructor(options: AtomOptions<T, N>);
+}
+type TAtomObject = TObject$1<any> | TArray;
+type AtomStatic<T extends TAtomObject> = T extends TOptionalAdd<T> ? Static$1<T> | undefined : Static$1<T>;
+//#endregion
 //#region ../alepha/src/core/primitives/$inject.d.ts
 interface InjectOptions<T extends object = any> {
   /**
@@ -203,74 +289,6 @@ declare class Json {
   parse(text: string, reviver?: (this: any, key: string, value: any) => any): any;
 }
 //#endregion
-//#region ../alepha/src/core/helpers/FileLike.d.ts
-interface FileLike {
-  /**
-   * Filename.
-   * @default "file"
-   */
-  name: string;
-  /**
-   * Mandatory MIME type of the file.
-   * @default "application/octet-stream"
-   */
-  type: string;
-  /**
-   * Size of the file in bytes.
-   *
-   * Always 0 for streams, as the size is not known until the stream is fully read.
-   *
-   * @default 0
-   */
-  size: number;
-  /**
-   * Last modified timestamp in milliseconds since epoch.
-   *
-   * Always the current timestamp for streams, as the last modified time is not known.
-   * We use this field to ensure compatibility with File API.
-   *
-   * @default Date.now()
-   */
-  lastModified: number;
-  /**
-   * Returns a ReadableStream or Node.js Readable stream of the file content.
-   *
-   * For streams, this is the original stream.
-   */
-  stream(): StreamLike;
-  /**
-   * Returns the file content as an ArrayBuffer.
-   *
-   * For streams, this reads the entire stream into memory.
-   */
-  arrayBuffer(): Promise<ArrayBuffer>;
-  /**
-   * Returns the file content as a string.
-   *
-   * For streams, this reads the entire stream into memory and converts it to a string.
-   */
-  text(): Promise<string>;
-  /**
-   * Optional file path, if the file is stored on disk.
-   *
-   * This is not from the File API, but rather a custom field to indicate where the file is stored.
-   */
-  filepath?: string;
-}
-type StreamLike = ReadableStream | ReadableStream$1 | Readable | NodeJS.ReadableStream;
-//#endregion
-//#region ../alepha/src/core/providers/TypeProvider.d.ts
-declare module "typebox" {
-  interface TString {
-    format?: string;
-    minLength?: number;
-    maxLength?: number;
-  }
-  interface TNumber {
-    format?: "int64";
-  }
-}
-//#endregion
 //#region ../alepha/src/core/providers/SchemaCodec.d.ts
 declare abstract class SchemaCodec {
   /**
@@ -440,25 +458,6 @@ declare class EventManager {
   }): Promise<void>;
 }
 //#endregion
-//#region ../alepha/src/core/primitives/$atom.d.ts
-type AtomOptions<T extends TAtomObject, N extends string> = {
-  name: N;
-  schema: T;
-  description?: string;
-} & (T extends TOptionalAdd<T> ? {
-  default?: Static$1<T>;
-} : {
-  default: Static$1<T>;
-});
-declare class Atom<T extends TAtomObject = TObject$1, N extends string = string> {
-  readonly options: AtomOptions<T, N>;
-  get schema(): T;
-  get key(): N;
-  constructor(options: AtomOptions<T, N>);
-}
-type TAtomObject = TObject$1<any> | TArray;
-type AtomStatic<T extends TAtomObject> = T extends TOptionalAdd<T> ? Static$1<T> | undefined : Static$1<T>;
-//#endregion
 //#region ../alepha/src/core/providers/StateManager.d.ts
 interface AtomWithValue {
   atom: Atom;
@@ -735,6 +734,8 @@ declare class Alepha {
    */
   get env(): Readonly<Env>;
   constructor(init?: Partial<State>);
+  set<T extends TAtomObject>(target: Atom<T>, value: AtomStatic<T>): this;
+  set<Key extends keyof State>(target: Key, value: State[Key] | undefined): this;
   /**
    * True when start() is called.
    *
@@ -1995,5 +1996,4 @@ declare class AzureFileStorageProvider implements FileStorageProvider {
  */
 declare const AlephaBucketAzure: Service<Module>;
 //#endregion
-export { AlephaBucketAzure, AzureFileStorageProvider };
-//# sourceMappingURL=index.d.ts.map
+export { AlephaBucketAzure, AzureFileStorageProvider };

package/dist/{index.js → index.mjs}

@@ -121,5 +121,4 @@ const AlephaBucketAzure = $module({
 });
 
 //#endregion
-export { AlephaBucketAzure, AzureFileStorageProvider };
-//# sourceMappingURL=index.js.map
+export { AlephaBucketAzure, AzureFileStorageProvider };

package/package.json

@@ -10,7 +10,7 @@
     "storage-blob"
   ],
   "author": "Nicolas Foures",
-  "version": "0.13.3",
+  "version": "0.13.5",
   "type": "module",
   "engines": {
     "node": ">=22.0.0"
@@ -26,18 +26,18 @@
     "@azure/storage-blob": "^12.29.1"
   },
   "devDependencies": {
-    "alepha": "0.13.3",
-    "tsdown": "^0.16.8",
+    "alepha": "0.13.5",
+    "tsdown": "^0.17.0",
     "vitest": "^4.0.15"
   },
   "peerDependencies": {
-    "alepha": "0.13.3"
+    "alepha": "0.13.5"
   },
   "scripts": {
     "lint": "alepha lint",
     "typecheck": "alepha typecheck",
     "test": "alepha test",
-    "build": "tsdown -c=../../tsdown.config.ts"
+    "build": "tsdown"
   },
   "repository": {
     "type": "git",

package/dist/index.js.map

@@ -1 +0,0 @@
-{"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"}