alepha 0.15.0 → 0.15.2

package/dist/sms/index.d.ts

@@ -1,7 +1,7 @@
 import * as alepha0 from "alepha";
-import { InstantiableClass, KIND, Primitive } from "alepha";
+import { FileLike, InstantiableClass, Json, KIND, Primitive, StreamLike } from "alepha";
 import * as alepha_logger0 from "alepha/logger";
-import { FileSystemProvider } from "alepha/file";
+import { Readable } from "node:stream";
 
 //#region ../../src/sms/providers/SmsProvider.d.ts
 /**
@@ -11,10 +11,10 @@ import { FileSystemProvider } from "alepha/file";
  */
 declare abstract class SmsProvider {
   /**
-       * Send an SMS.
-       *
-       * @return Promise that resolves when the SMS is sent.
-       */
+   * Send an SMS.
+   *
+   * @return Promise that resolves when the SMS is sent.
+   */
   abstract send(options: SmsSendOptions): Promise<void>;
 }
 type SmsSendOptions = {
@@ -57,18 +57,308 @@ declare class SmsPrimitive extends Primitive<SmsPrimitiveOptions> {
   protected readonly provider: SmsProvider;
   get name(): string;
   /**
-       * Send an SMS using the configured provider.
-       */
+   * Send an SMS using the configured provider.
+   */
   send(options: SmsSendOptions): Promise<void>;
   protected $provider(): SmsProvider;
 }
 //#endregion
+//#region ../../src/system/providers/FileSystemProvider.d.ts
+/**
+ * Options for creating a file from a URL
+ */
+interface CreateFileFromUrlOptions {
+  /**
+   * The URL to load the file from (file://, http://, or https://)
+   */
+  url: string;
+  /**
+   * The MIME type of the file (optional, will be detected from filename if not provided)
+   */
+  type?: string;
+  /**
+   * The name of the file (optional, will be extracted from URL if not provided)
+   */
+  name?: string;
+}
+/**
+ * Options for creating a file from a path (URL with file:// scheme)
+ */
+interface CreateFileFromPathOptions {
+  /**
+   * The path to the file on the local filesystem
+   */
+  path: string;
+  /**
+   * The MIME type of the file (optional, will be detected from filename if not provided)
+   */
+  type?: string;
+  /**
+   * The name of the file (optional, will be extracted from URL if not provided)
+   */
+  name?: string;
+}
+/**
+ * Options for creating a file from a Buffer
+ */
+interface CreateFileFromBufferOptions {
+  /**
+   * The Buffer containing the file data
+   */
+  buffer: Buffer;
+  /**
+   * The MIME type of the file (optional, will be detected from name if not provided)
+   */
+  type?: string;
+  /**
+   * The name of the file (required for proper content type detection)
+   */
+  name?: string;
+}
+/**
+ * Options for creating a file from a stream
+ */
+interface CreateFileFromStreamOptions {
+  /**
+   * The readable stream containing the file data
+   */
+  stream: StreamLike;
+  /**
+   * The MIME type of the file (optional, will be detected from name if not provided)
+   */
+  type?: string;
+  /**
+   * The name of the file (required for proper content type detection)
+   */
+  name?: string;
+  /**
+   * The size of the file in bytes (optional)
+   */
+  size?: number;
+}
+/**
+ * Options for creating a file from text content
+ */
+interface CreateFileFromTextOptions {
+  /**
+   * The text content to create the file from
+   */
+  text: string;
+  /**
+   * The MIME type of the file (default: text/plain)
+   */
+  type?: string;
+  /**
+   * The name of the file (default: "file.txt")
+   */
+  name?: string;
+}
+interface CreateFileFromResponseOptions {
+  /**
+   * The Response object containing the file data
+   */
+  response: Response;
+  /**
+   * Override the name (optional, uses filename from Content-Disposition header if not provided)
+   */
+  name?: string;
+  /**
+   * Override the MIME type (optional, uses file.type if not provided)
+   */
+  type?: string;
+}
+/**
+ * Options for creating a file from a Web File object
+ */
+interface CreateFileFromWebFileOptions {
+  /**
+   * The Web File object
+   */
+  file: File;
+  /**
+   * Override the MIME type (optional, uses file.type if not provided)
+   */
+  type?: string;
+  /**
+   * Override the name (optional, uses file.name if not provided)
+   */
+  name?: string;
+  /**
+   * Override the size (optional, uses file.size if not provided)
+   */
+  size?: number;
+}
+/**
+ * Options for creating a file from an ArrayBuffer
+ */
+interface CreateFileFromArrayBufferOptions {
+  /**
+   * The ArrayBuffer containing the file data
+   */
+  arrayBuffer: ArrayBuffer;
+  /**
+   * The MIME type of the file (optional, will be detected from name if not provided)
+   */
+  type?: string;
+  /**
+   * The name of the file (required for proper content type detection)
+   */
+  name?: string;
+}
+/**
+ * Union type for all createFile options
+ */
+type CreateFileOptions = CreateFileFromUrlOptions | CreateFileFromPathOptions | CreateFileFromBufferOptions | CreateFileFromStreamOptions | CreateFileFromTextOptions | CreateFileFromWebFileOptions | CreateFileFromResponseOptions | CreateFileFromArrayBufferOptions;
+/**
+ * Options for rm (remove) operation
+ */
+interface RmOptions {
+  /**
+   * If true, removes directories and their contents recursively
+   */
+  recursive?: boolean;
+  /**
+   * If true, no error will be thrown if the path does not exist
+   */
+  force?: boolean;
+}
+/**
+ * Options for cp (copy) operation
+ */
+interface CpOptions {
+  /**
+   * If true, copy directories recursively
+   */
+  recursive?: boolean;
+  /**
+   * If true, overwrite existing destination
+   */
+  force?: boolean;
+}
+/**
+ * Options for mkdir operation
+ */
+interface MkdirOptions {
+  /**
+   * If true, creates parent directories as needed
+   */
+  recursive?: boolean;
+  /**
+   * File mode (permission and sticky bits)
+   */
+  mode?: number;
+}
+/**
+ * Options for ls (list) operation
+ */
+interface LsOptions {
+  /**
+   * If true, list contents of directories recursively
+   */
+  recursive?: boolean;
+  /**
+   * If true, include hidden files (starting with .)
+   */
+  hidden?: boolean;
+}
+/**
+ * FileSystem interface providing utilities for working with files.
+ */
+declare abstract class FileSystemProvider {
+  /**
+   * Joins multiple path segments into a single path.
+   *
+   * @param paths - The path segments to join
+   * @returns The joined path
+   */
+  abstract join(...paths: string[]): string;
+  /**
+   * Creates a FileLike object from various sources.
+   *
+   * @param options - Options for creating the file
+   * @returns A FileLike object
+   */
+  abstract createFile(options: CreateFileOptions): FileLike;
+  /**
+   * Removes a file or directory.
+   *
+   * @param path - The path to remove
+   * @param options - Remove options
+   */
+  abstract rm(path: string, options?: RmOptions): Promise<void>;
+  /**
+   * Copies a file or directory.
+   *
+   * @param src - Source path
+   * @param dest - Destination path
+   * @param options - Copy options
+   */
+  abstract cp(src: string, dest: string, options?: CpOptions): Promise<void>;
+  /**
+   * Moves/renames a file or directory.
+   *
+   * @param src - Source path
+   * @param dest - Destination path
+   */
+  abstract mv(src: string, dest: string): Promise<void>;
+  /**
+   * Creates a directory.
+   *
+   * @param path - The directory path to create
+   * @param options - Mkdir options
+   */
+  abstract mkdir(path: string, options?: MkdirOptions): Promise<void>;
+  /**
+   * Lists files in a directory.
+   *
+   * @param path - The directory path to list
+   * @param options - List options
+   * @returns Array of filenames
+   */
+  abstract ls(path: string, options?: LsOptions): Promise<string[]>;
+  /**
+   * Checks if a file or directory exists.
+   *
+   * @param path - The path to check
+   * @returns True if the path exists, false otherwise
+   */
+  abstract exists(path: string): Promise<boolean>;
+  /**
+   * Reads the content of a file.
+   *
+   * @param path - The file path to read
+   * @returns The file content as a Buffer
+   */
+  abstract readFile(path: string): Promise<Buffer>;
+  /**
+   * Writes data to a file.
+   *
+   * @param path - The file path to write to
+   * @param data - The data to write (Buffer or string)
+   */
+  abstract writeFile(path: string, data: Uint8Array | Buffer | string | FileLike): Promise<void>;
+  /**
+   * Reads the content of a file as a string.
+   *
+   * @param path - The file path to read
+   * @returns The file content as a string
+   */
+  abstract readTextFile(path: string): Promise<string>;
+  /**
+   * Reads the content of a file as JSON.
+   *
+   * @param path - The file path to read
+   * @returns The parsed JSON content
+   */
+  abstract readJsonFile<T = unknown>(path: string): Promise<T>;
+}
+//#endregion
 //#region ../../src/sms/providers/LocalSmsProvider.d.ts
 interface LocalSmsProviderOptions {
   /**
-       * Directory to save SMS files.
-       * @default "node_modules/.alepha/sms" (relative to project root)
-       */
+   * Directory to save SMS files.
+   * @default "node_modules/.alepha/sms" (relative to project root)
+   */
   directory?: string;
 }
 declare class LocalSmsProvider implements SmsProvider {
@@ -94,8 +384,8 @@ declare class MemorySmsProvider implements SmsProvider {
   records: SmsRecord[];
   send(options: SmsSendOptions): Promise<void>;
   /**
-       * Get the last SMS sent (for testing purposes).
-       */
+   * Get the last SMS sent (for testing purposes).
+   */
   get last(): SmsRecord | undefined;
 }
 //#endregion
@@ -117,13 +407,17 @@ declare module "alepha" {
   }
 }
 /**
- * Provides SMS sending capabilities for Alepha applications with multiple provider backends.
+ * | type | quality | stability |
+ * |------|---------|-----------|
+ * | backend | rare | stable |
+ *
+ * SMS delivery with multiple provider support.
  *
- * The SMS module enables declarative SMS sending through the `$sms` primitive, allowing you to send
- * text messages through different providers: memory (for testing) or local file system.
- * It supports automatic provider selection based on environment configuration.
+ * **Features:**
+ * - Send SMS with templates
+ * - Multiple recipients
+ * - Provider abstraction
  *
- * @see {@link SmsProvider}
  * @module alepha.sms
  */
 declare const AlephaSms: alepha0.Service<alepha0.Module>;

package/dist/sms/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/sms/providers/SmsProvider.ts","../../src/sms/errors/SmsError.ts","../../src/sms/primitives/$sms.ts","../../src/sms/providers/LocalSmsProvider.ts","../../src/sms/providers/MemorySmsProvider.ts","../../src/sms/index.ts"],"mappings":";;;;;;;AAKA;AASA;;;uBATsB,WAAA;EAAA;AAStB;;;;EATsB,SAAA,KAAA,OAAA,EAMU,cAAA,GAAiB,OAAA;AAAA;AAAA,KAGrC,cAAA;EAAA,EAAA;EAAA,OAAA;AAAA;;;cCdC,QAAA,SAAiB,KAAA;EAAA,YAAA,OAAA,UAAA,KAAA,GACS,KAAA;AAAA;;;cCW1B,IAAA;EAAA,CAAA,OAAA,GAAiB,mBAAA,GAAmB,YAAA;EAAA;;UAKhC,mBAAA;EAAA,IAAA;EAAA,QAAA,GAEJ,iBAAA,CAAkB,WAAA;AAAA;AAAA;AAsB/B;;;;;;;;;;;ACnCA;AAQA;;;;ADK+B,cAsBlB,YAAA,SAAqB,SAAA,CAAU,mBAAA;EAAA,mBAAA,QAAA,EACf,WAAA;EAAA,IAAA,KAAA;EAAA;;;EAAA,KAAA,OAAA,EASA,cAAA,GAAiB,OAAA;EAAA,UAAA,UAAA,GAoBrB,WAAA;AAAA;;;UCjER,uBAAA;EAAA;AAQjB;;;EARiB,SAAA;AAAA;AAAA,cAQJ,gBAAA,YAA4B,WAAA;EAAA,mBAAA,GAAA,EAAX,cAAA,CACN,MAAA;EAAA,mBAAA,EAAA,EACD,kBAAA;EAAA,mBAAA,SAAA;EAAA,YAAA,OAAA,GAGA,uBAAA;EAAA,KAAA,OAAA,EAIM,cAAA,GAAiB,OAAA;EAAA,cAAA,OAAA;IAAA,EAAA;IAAA,OAAA;EAAA;AAAA;;;UCpB7B,SAAA;EAAA,EAAA;EAAA,OAAA;EAAA,MAAA,EAGP,IAAA;AAAA;AAAA,cAGG,iBAAA,YAA6B,WAAA;EAAA,mBAAA,GAAA,EAAX,cAAA,CACP,MAAA;EAAA,OAAA,EACN,SAAA;EAAA,KAAA,OAAA,EAEW,cAAA,GAAiB,OAAA;EAAA;;;EAAA,IAAA,KAAA,GAgBzB,SAAA;AAAA;;;;;;;;iBCRJ,MAAA;MAAA,QAAA,EACD,WAAA;MAAA,KAAA;IAAA;IAAA;MAAA,EAAA;MAAA,QAAA;MAAA,QAAA,EAMA,WAAA;IAAA;EAAA;AAAA;AAAA;;;;AAiBhB;;;;;;AAjBgB,cAiBH,SAAA,EAAS,OAAA,CAAA,OAAA,CAUpB,OAAA,CAVoB,MAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/sms/providers/SmsProvider.ts","../../src/sms/errors/SmsError.ts","../../src/sms/primitives/$sms.ts","../../src/system/providers/FileSystemProvider.ts","../../src/sms/providers/LocalSmsProvider.ts","../../src/sms/providers/MemorySmsProvider.ts","../../src/sms/index.ts"],"mappings":";;;;;;;;;;;uBAKsB,WAAA;EAAA;;;;;EAAA,SAMJ,IAAA,CAAK,OAAA,EAAS,cAAA,GAAiB,OAAA;AAAA;AAAA,KAGrC,cAAA;EACV,EAAA;EACA,OAAA;AAAA;;;cChBW,QAAA,SAAiB,KAAA;cAChB,OAAA,UAAiB,KAAA,GAAQ,KAAA;AAAA;;;cCW1B,IAAA;EAAA,WAAiB,mBAAA,GAAmB,YAAA;EAAA;;UAKhC,mBAAA;EACf,IAAA;EACA,QAAA,GAAW,iBAAA,CAAkB,WAAA;AAAA;;;;;;AFL/B;;;;;;;;ACdA;;;;cCyCa,YAAA,SAAqB,SAAA,CAAU,mBAAA;EAAA,mBACvB,QAAA,EAAQ,WAAA;EAAA,IAEhB,IAAA,CAAA;ED3C0B;;;ECkDxB,IAAA,CAAK,OAAA,EAAS,cAAA,GAAiB,OAAA;EAAA,UAoBlC,SAAA,CAAA,GAAa,WAAA;AAAA;;;;;;UClER,wBAAA;;AHAjB;;EGIE,GAAA;EHEsD;;;EGEtD,IAAA;EHF+C;;;EGM/C,IAAA;AAAA;;;;UAMe,yBAAA;;;AFvBjB;EE2BE,IAAA;;;;EAIA,IAAA;EF9BY;;;EEkCZ,IAAA;AAAA;;;;UAMe,2BAAA;ED5BuB;;;ECgCtC,MAAA,EAAQ,MAAA;;;;EAIR,IAAA;EDrC4B;;;ECyC5B,IAAA;AAAA;;;ADpCF;UC0CiB,2BAAA;;;;EAIf,MAAA,EAAQ,UAAA;ED5CG;;;ECgDX,IAAA;ED1BW;;;EC8BX,IAAA;ED7B2B;;;ECiC3B,IAAA;AAAA;;;;UAMe,yBAAA;EDvCI;;;EC2CnB,IAAA;EDlC2B;;;ECsC3B,IAAA;EDlBuB;;;ECsBvB,IAAA;AAAA;AAAA,UAGe,6BAAA;EA3FA;;;EA+Ff,QAAA,EAAU,QAAA;EA3FV;;;EA+FA,IAAA;EAvFI;AAMN;;EAqFE,IAAA;AAAA;;;;UAMe,4BAAA;EA/EX;AAMN;;EA6EE,IAAA,EAAM,IAAA;EAzEQ;;;EA6Ed,IAAA;EArEA;;;EAyEA,IAAA;EAnE0C;;;EAuE1C,IAAA;AAAA;;;;UAMe,gCAAA;EA7DX;AAMN;;EA2DE,WAAA,EAAa,WAAA;EA3D2B;;;EA+DxC,IAAA;EAnDI;;AAGN;EAoDE,IAAA;AAAA;;;;KAMU,iBAAA,GACR,wBAAA,GACA,yBAAA,GACA,2BAAA,GACA,2BAAA,GACA,yBAAA,GACA,4BAAA,GACA,6BAAA,GACA,gCAAA;;;;UAKa,SAAA;EArD4B;;;EAyD3C,SAAA;EArDM;;;EAyDN,KAAA;AAAA;;AAvCF;;UA6CiB,SAAA;EAzCS;;;EA6CxB,SAAA;EArCA;;;EAyCA,KAAA;AAAA;;;;UAMe,YAAA;EArCb;;;EAyCF,SAAA;EArCE;;;EAyCF,IAAA;AAAA;;;;UAMe,SAAA;EAhDb;;;EAoDF,SAAA;EA9Ce;;;EAkDf,MAAA;AAAA;AApCF;;;AAAA,uBA0CsB,kBAAA;EAlCf;AAMP;;;;;EANO,SAyCI,IAAA,CAAA,GAAQ,KAAA;EArBO;;;;AAc1B;;EAd0B,SA6Bf,UAAA,CAAW,OAAA,EAAS,iBAAA,GAAoB,QAAA;EAApB;;;;;;EAAA,SAQpB,EAAA,CAAG,IAAA,UAAc,OAAA,GAAU,SAAA,GAAY,OAAA;EAyBT;;;;;;;EAAA,SAhB9B,EAAA,CAAG,GAAA,UAAa,IAAA,UAAc,OAAA,GAAU,SAAA,GAAY,OAAA;EAmDxC;;;;;;EAAA,SA3CZ,EAAA,CAAG,GAAA,UAAa,IAAA,WAAe,OAAA;EA4DiB;;;;;;EAAA,SApDhD,KAAA,CAAM,IAAA,UAAc,OAAA,GAAU,YAAA,GAAe,OAAA;EAzB7C;;;;;;;EAAA,SAkCA,EAAA,CAAG,IAAA,UAAc,OAAA,GAAU,SAAA,GAAY,OAAA;EAzBC;;;;;;EAAA,SAiCxC,MAAA,CAAO,IAAA,WAAe,OAAA;EAjBtB;;;;;;EAAA,SAyBA,QAAA,CAAS,IAAA,WAAe,OAAA,CAAQ,MAAA;EAhBL;;;;;;EAAA,SAwB3B,SAAA,CACP,IAAA,UACA,IAAA,EAAM,UAAA,GAAa,MAAA,YAAkB,QAAA,GACpC,OAAA;EAXe;;;;;;EAAA,SAmBT,YAAA,CAAa,IAAA,WAAe,OAAA;EATE;;;;;;EAAA,SAiB9B,YAAA,aAAA,CAA0B,IAAA,WAAe,OAAA,CAAQ,CAAA;AAAA;;;UC7T3C,uBAAA;;;;AJDjB;EIME,SAAA;AAAA;AAAA,cAGW,gBAAA,YAA4B,WAAA;EAAA,mBACpB,GAAA,EADS,cAAA,CACN,MAAA;EAAA,mBACH,EAAA,EAAE,kBAAA;EAAA,mBACF,SAAA;cAEP,OAAA,GAAS,uBAAA;EAIR,IAAA,CAAK,OAAA,EAAS,cAAA,GAAiB,OAAA;EAsCrC,aAAA,CAAc,OAAA;IAAW,EAAA;IAAY,OAAA;EAAA;AAAA;;;UC1D7B,SAAA;EACf,EAAA;EACA,OAAA;EACA,MAAA,EAAQ,IAAA;AAAA;AAAA,cAGG,iBAAA,YAA6B,WAAA;EAAA,mBACrB,GAAA,EADU,cAAA,CACP,MAAA;EACf,OAAA,EAAS,SAAA;EAEH,IAAA,CAAK,OAAA,EAAS,cAAA,GAAiB,OAAA;ELF5B;;;EAAA,IKkBL,IAAA,CAAA,GAAQ,SAAA;AAAA;;;;YCZT,KAAA;IACR,aAAA;MACE,EAAA;MACA,QAAA;MACA,SAAA,EAAW,MAAA;MACX,QAAA,EAAU,WAAA;MACV,KAAA;IAAA;IAEF,UAAA;MACE,EAAA;MACA,QAAA;MACA,QAAA,EAAU,WAAA;IAAA;EAAA;AAAA;;;AL5BhB;;;;;;;;;;;;cKiDa,SAAA,EAAS,OAAA,CAAA,OAAA,CAUpB,OAAA,CAVoB,MAAA"}