alepha 0.15.1 → 0.15.3

package/dist/server/static/index.d.ts

@@ -1,9 +1,9 @@
 import * as alepha1 from "alepha";
-import { Alepha, KIND, Primitive } from "alepha";
+import { Alepha, Json, KIND, Primitive } from "alepha";
 import { ServerHandler, ServerRouterProvider } from "alepha/server";
 import { DateTimeProvider, DurationLike } from "alepha/datetime";
-import { FileDetector } from "alepha/file";
 import * as alepha_logger0 from "alepha/logger";
+import { Readable } from "node:stream";
 
 //#region ../../src/server/static/primitives/$serve.d.ts
 /**
@@ -85,6 +85,133 @@ interface CacheControlOptions {
 }
 declare class ServePrimitive extends Primitive<ServePrimitiveOptions> {}
 //#endregion
+//#region ../../src/system/services/FileDetector.d.ts
+interface FileTypeResult {
+  /**
+   * The detected MIME type
+   */
+  mimeType: string;
+  /**
+   * The detected file extension
+   */
+  extension: string;
+  /**
+   * Whether the file type was verified by magic bytes
+   */
+  verified: boolean;
+  /**
+   * The stream (potentially wrapped to allow re-reading)
+   */
+  stream: Readable;
+}
+/**
+ * Service for detecting file types and getting content types.
+ *
+ * @example
+ * ```typescript
+ * const detector = alepha.inject(FileDetector);
+ *
+ * // Get content type from filename
+ * const mimeType = detector.getContentType("image.png"); // "image/png"
+ *
+ * // Detect file type by magic bytes
+ * const stream = createReadStream('image.png');
+ * const result = await detector.detectFileType(stream, 'image.png');
+ * console.log(result.mimeType); // 'image/png'
+ * console.log(result.verified); // true if magic bytes match
+ * ```
+ */
+declare class FileDetector {
+  /**
+   * Magic byte signatures for common file formats.
+   * Each signature is represented as an array of bytes or null (wildcard).
+   */
+  protected static readonly MAGIC_BYTES: Record<string, {
+    signature: (number | null)[];
+    mimeType: string;
+  }[]>;
+  /**
+   * All possible format signatures for checking against actual file content
+   */
+  protected static readonly ALL_SIGNATURES: {
+    signature: (number | null)[];
+    mimeType: string;
+    ext: string;
+  }[];
+  /**
+   * MIME type map for file extensions.
+   *
+   * Can be used to get the content type of file based on its extension.
+   * Feel free to add more mime types in your project!
+   */
+  static readonly mimeMap: Record<string, string>;
+  /**
+   * Reverse MIME type map for looking up extensions from MIME types.
+   * Prefers shorter, more common extensions when multiple exist.
+   */
+  protected static readonly reverseMimeMap: Record<string, string>;
+  /**
+   * Returns the file extension for a given MIME type.
+   *
+   * @param mimeType - The MIME type to look up
+   * @returns The file extension (without dot), or "bin" if not found
+   *
+   * @example
+   * ```typescript
+   * const detector = alepha.inject(FileDetector);
+   * const ext = detector.getExtensionFromMimeType("image/png"); // "png"
+   * const ext2 = detector.getExtensionFromMimeType("application/octet-stream"); // "bin"
+   * ```
+   */
+  getExtensionFromMimeType(mimeType: string): string;
+  /**
+   * Returns the content type of file based on its filename.
+   *
+   * @param filename - The filename to check
+   * @returns The MIME type
+   *
+   * @example
+   * ```typescript
+   * const detector = alepha.inject(FileDetector);
+   * const mimeType = detector.getContentType("image.png"); // "image/png"
+   * ```
+   */
+  getContentType(filename: string): string;
+  /**
+   * Detects the file type by checking magic bytes against the stream content.
+   *
+   * @param stream - The readable stream to check
+   * @param filename - The filename (used to get the extension)
+   * @returns File type information including MIME type, extension, and verification status
+   *
+   * @example
+   * ```typescript
+   * const detector = alepha.inject(FileDetector);
+   * const stream = createReadStream('image.png');
+   * const result = await detector.detectFileType(stream, 'image.png');
+   * console.log(result.mimeType); // 'image/png'
+   * console.log(result.verified); // true if magic bytes match
+   * ```
+   */
+  detectFileType(stream: Readable, filename: string): Promise<FileTypeResult>;
+  /**
+   * Reads all bytes from a stream and returns the first N bytes along with a new stream containing all data.
+   * This approach reads the entire stream upfront to avoid complex async handling issues.
+   *
+   * @protected
+   */
+  protected peekBytes(stream: Readable, numBytes: number): Promise<{
+    buffer: Buffer;
+    stream: Readable;
+  }>;
+  /**
+   * Checks if a buffer matches a magic byte signature.
+   *
+   * @protected
+   */
+  protected matchesSignature(buffer: Buffer, signature: (number | null)[]): boolean;
+}
+//#endregion
 //#region ../../src/server/static/providers/ServerStaticProvider.d.ts
 declare class ServerStaticProvider {
   protected readonly alepha: Alepha;
@@ -110,9 +237,15 @@ interface ServeDirectory {
 //#endregion
 //#region ../../src/server/static/index.d.ts
 /**
- * Create static file server with `$static()`.
+ * | type | quality | stability |
+ * |------|---------|-----------|
+ * | backend | standard | stable |
+ *
+ * Static file serving.
+ *
+ * **Features:**
+ * - Serve static files from directory
  *
- * @see {@link ServerStaticProvider}
  * @module alepha.server.static
  */
 declare const AlephaServerStatic: alepha1.Service<alepha1.Module>;

package/dist/server/static/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../../../src/server/static/primitives/$serve.ts","../../../src/server/static/providers/ServerStaticProvider.ts","../../../src/server/static/index.ts"],"mappings":";;;;;;;;;;;cAMa,MAAA;EAAA,WAAmB,qBAAA,GAA6B,cAAA;EAAA;;UAI5C,qBAAA;;;;;;EAMf,IAAA;;;;;;EAOA,IAAA;;;AAbF;;;EAoBE,QAAA;EAdA;;;;;EAqBA,iBAAA;EAqBA;;;;;EAdA,aAAA;EAwBe;;;;EAlBf,kBAAA;EA+BA;;;;;AAUF;EAjCE,IAAA;;;;;;EAOA,YAAA,GAAe,OAAA,CAAQ,mBAAA;AAAA;AAAA,UAGR,mBAAA;;;;;;EAMf,SAAA;ECzDgC;;;;;EDgEhC,MAAA,EAAQ,YAAA;ECoCL;;;;;ED7BH,SAAA;AAAA;AAAA,cAGW,cAAA,SAAuB,SAAA,CAAU,qBAAA;;;cChFjC,oBAAA;EAAA,mBACQ,MAAA,EAAM,MAAA;EAAA,mBACN,cAAA,EAAc,oBAAA;EAAA,mBACd,gBAAA,EAAgB,gBAAA;EAAA,mBAChB,YAAA,EAAY,YAAA;EAAA,mBACZ,GAAA,EADY,cAAA,CACT,MAAA;EAAA,mBACH,WAAA,EAAa,cAAA;EAAA,mBAEb,SAAA,EAF2B,OAAA,CAElB,aAAA;EAWf,kBAAA,CACX,OAAA,EAAS,qBAAA,GACR,OAAA;EAkFU,iBAAA,CACX,QAAA,UACA,OAAA,EAAS,qBAAA,GACR,OAAA,CAAQ,aAAA;EAAA,UA2ED,iBAAA,CAAA;EAAA,UAiBA,eAAA,CACR,QAAA,UACA,OAAA,EAAS,qBAAA;IACN,MAAA;IAAgB,SAAA;EAAA;EAoBR,WAAA,CACX,GAAA,UACA,iBAAA,aACC,OAAA;AAAA;AAAA,UAmBY,cAAA;EACf,OAAA,EAAS,qBAAA;EACT,KAAA;AAAA;;;;;;;;;cC9OW,kBAAA,EAAkB,OAAA,CAAA,OAAA,CAI7B,OAAA,CAJ6B,MAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../../src/server/static/primitives/$serve.ts","../../../src/system/services/FileDetector.ts","../../../src/server/static/providers/ServerStaticProvider.ts","../../../src/server/static/index.ts"],"mappings":";;;;;;;;;;;cAMa,MAAA;EAAA,WAAmB,qBAAA,GAA6B,cAAA;EAAA;;UAI5C,qBAAA;;;;;;EAMf,IAAA;;;;;;EAOA,IAAA;;;AAbF;;;EAoBE,QAAA;EAdA;;;;;EAqBA,iBAAA;EAqBA;;;;;EAdA,aAAA;EAwBe;;;;EAlBf,kBAAA;EA+BA;;;;;AAUF;EAjCE,IAAA;;;;;;EAOA,YAAA,GAAe,OAAA,CAAQ,mBAAA;AAAA;AAAA,UAGR,mBAAA;;;;;;EAMf,SAAA;ECxDQ;;;AAoBV;;ED2CE,MAAA,EAAQ,YAAA;ECtC+B;;;;;ED6CvC,SAAA;AAAA;AAAA,cAGW,cAAA,SAAuB,SAAA,CAAU,qBAAA;;;UCzF7B,cAAA;;;;EAIf,QAAA;;;ADAF;ECIE,SAAA;;;;EAIA,QAAA;;;;EAIA,MAAA,EAAQ,QAAA;AAAA;;;;;;ADRV;;;;;;;;;;;;cC4Ba,YAAA;ED2BY;;;AAGzB;EAHyB,0BCtBG,WAAA,EAAa,MAAA;IAEnC,SAAA;IAA8B,QAAA;EAAA;EDoClC;;;EAAA,0BC4N0B,cAAA;;;;;EDlNQ;;;;;ACzFpC;EDyFoC,gBC4NX,OAAA,EAAS,MAAA;;;;;4BA8EN,cAAA,EAAgB,MAAA;EAnX1C;;;;AAoBF;;;;;;;;;EAwXE,wBAAA,CAAyB,QAAA;EAuGJ;;;;;;;;;;;;EAxFrB,cAAA,CAAe,QAAA;;;;;;;;;;;;;;;;;EAqBT,cAAA,CACJ,MAAA,EAAQ,QAAA,EACR,QAAA,WACC,OAAA,CAAQ,cAAA;EA8DT;;;;;;EAAA,UADc,SAAA,CACd,MAAA,EAAQ,QAAA,EACR,QAAA,WACC,OAAA;IAAU,MAAA,EAAQ,MAAA;IAAQ,MAAA,EAAQ,QAAA;EAAA;EAwBnC;;;;;EAAA,UAFQ,gBAAA,CACR,MAAA,EAAQ,MAAA,EACR,SAAA;AAAA;;;cClhBS,oBAAA;EAAA,mBACQ,MAAA,EAAM,MAAA;EAAA,mBACN,cAAA,EAAc,oBAAA;EAAA,mBACd,gBAAA,EAAgB,gBAAA;EAAA,mBAChB,YAAA,EAAY,YAAA;EAAA,mBACZ,GAAA,EADY,cAAA,CACT,MAAA;EAAA,mBACH,WAAA,EAAa,cAAA;EAAA,mBAEb,SAAA,EAF2B,OAAA,CAElB,aAAA;EAWf,kBAAA,CACX,OAAA,EAAS,qBAAA,GACR,OAAA;EAkFU,iBAAA,CACX,QAAA,UACA,OAAA,EAAS,qBAAA,GACR,OAAA,CAAQ,aAAA;EAAA,UA2ED,iBAAA,CAAA;EAAA,UAiBA,eAAA,CACR,QAAA,UACA,OAAA,EAAS,qBAAA;IACN,MAAA;IAAgB,SAAA;EAAA;EAoBR,WAAA,CACX,GAAA,UACA,iBAAA,aACC,OAAA;AAAA;AAAA,UAmBY,cAAA;EACf,OAAA,EAAS,qBAAA;EACT,KAAA;AAAA;;;;;;;;;AF1PF;;;;;;cGkBa,kBAAA,EAAkB,OAAA,CAAA,OAAA,CAI7B,OAAA,CAJ6B,MAAA"}