@visulima/storage 1.0.0-alpha.9 → 1.0.0

package/dist/transformer/index.d.ts

@@ -1,5 +1,62 @@
-export { default as BaseTransformer } from "./base-transformer.d.ts";
-export { default as MediaTransformer } from "./media-transformer.d.ts";
-export type { AudioChannelMixOptions, AudioResampleOptions, AudioTransformationStep, AudioTransformerConfig, AudioTransformOptions, AudioTransformResult, CropOptions, ImageFormat, ImageTransformerConfig, MediaTransformationStep, MediaTransformerConfig, MediaTransformQuery, MediaTransformResult, ResizeOptions, RotateOptions, TransformationStep, TransformOptions, TransformResult, VideoCropOptions, VideoResizeOptions, VideoRotateOptions, VideoTransformationStep, VideoTransformerConfig, VideoTransformOptions, VideoTransformResult, } from "./types.d.ts";
-export { getFormatFromContentType, isKnownContentType, isValidMediaType, validateMediaFile } from "./utils.d.ts";
-export { default as ValidationError } from "./validation-error.d.ts";
+export { type d as AudioChannelMixOptions, type c as AudioResampleOptions, type e as AudioTransformOptions, type b as AudioTransformResult, type f as AudioTransformationStep, type A as AudioTransformerConfig, B as BaseTransformer, type C as CropOptions, type h as ImageFormat, type I as ImageTransformerConfig, type U as MediaTransformQuery, type a as MediaTransformResult, type W as MediaTransformationStep, type M as MediaTransformerConfig, type R as ResizeOptions, type g as RotateOptions, type i as TransformOptions, type T as TransformResult, type z as TransformationStep, type K as VideoCropOptions, type H as VideoResizeOptions, type N as VideoRotateOptions, type O as VideoTransformOptions, type F as VideoTransformResult, type Q as VideoTransformationStep, type V as VideoTransformerConfig } from "../packem_shared/types.d-CrUWY4On.js";
+export { M as MediaTransformer } from "../packem_shared/media-transformer.d-Quf4ai47.js";
+import { g as FileReturn } from "../packem_shared/storage.d-CEM1upWM.js";
+import 'node:stream';
+import 'node:crypto';
+import 'node:http';
+import 'lru-cache';
+/**
+* Check if a content type is valid for a specific media type.
+* @param contentType MIME content type string to validate
+* @param expectedType Expected media type ('image', 'video', or 'audio')
+* @returns True if the content type is valid for the expected media type
+*/
+declare const isValidMediaType: (contentType: string | undefined, expectedType: "image" | "video" | "audio") => boolean;
+/**
+* Get format (extension) from content type using mime package.
+* @param contentType MIME content type string to extract format from
+* @returns Format string or undefined if not found
+*/
+declare const getFormatFromContentType: (contentType: string | undefined) => string | undefined;
+/**
+* Validate a media file for a specific type with size and format checks.
+* @param file File to validate
+* @param expectedType Expected media type ('image', 'video', or 'audio')
+* @param config Validation configuration with optional maxSize and supportedFormats
+* @param config.maxSize Maximum allowed file size in bytes
+* @param config.supportedFormats Array of supported file formats
+* @throws Error if validation fails (size exceeded, wrong type, or unsupported format)
+*/
+declare const validateMediaFile: (file: FileReturn, expectedType: "image" | "video" | "audio", config?: {
+  maxSize?: number;
+  supportedFormats?: string[];
+}) => void;
+/**
+* Validate that a content type is known and supported by the mime package.
+* @param contentType MIME content type string to check
+* @returns True if the content type is known and has a registered extension
+*/
+declare const isKnownContentType: (contentType: string | undefined) => boolean;
+/**
+* Custom error class for validation failures
+*/
+declare class ValidationError extends Error {
+  readonly code: string;
+  readonly details: {
+    invalidParams: string[];
+    mediaType: string;
+    suggestions?: string[];
+    validParams: string[];
+  };
+  /**
+  * Creates a new ValidationError instance with detailed error information.
+  * @param message Human-readable error message describing the validation failure
+  * @param code Machine-readable error code for programmatic error handling
+  * @param mediaType The media type where validation failed ('image', 'video', or 'audio')
+  * @param invalidParameters Array of parameter names that were invalid
+  * @param validParameters Array of valid parameter names or values
+  * @param suggestions Optional array of suggested corrections or valid values
+  */
+  constructor(message: string, code: string, mediaType: string, invalidParameters: string[], validParameters: string[], suggestions?: string[]);
+}
+export { ValidationError, getFormatFromContentType, isKnownContentType, isValidMediaType, validateMediaFile };

package/dist/transformer/index.js

@@ -1,4 +1 @@
-export { default as BaseTransformer } from '../packem_shared/BaseTransformer-C2gLib6v.js';
-export { default as MediaTransformer } from '../packem_shared/MediaTransformer-D6658DL1.js';
-export { getFormatFromContentType, isKnownContentType, isValidMediaType, validateMediaFile } from '../packem_shared/isValidMediaType-BeDgiObq.js';
-export { default as ValidationError } from '../packem_shared/ValidationError-BfF1aE4h.js';
+import{default as a}from"../packem_shared/BaseTransformer-Buw5lX_3.js";import{default as t}from"../packem_shared/MediaTransformer-D2kUsklW.js";import{getFormatFromContentType as d,isKnownContentType as f,isValidMediaType as n,validateMediaFile as m}from"../packem_shared/getFormatFromContentType-DCTTPQHm.js";import{default as l}from"../packem_shared/ValidationError-3B06DFyE.js";export{a as BaseTransformer,t as MediaTransformer,l as ValidationError,d as getFormatFromContentType,f as isKnownContentType,n as isValidMediaType,m as validateMediaFile};

package/dist/transformer/video-transformer.d.ts

@@ -1,145 +1,147 @@
-import type { BaseStorage } from "../storage/storage.d.ts";
-import type { File, FileReturn } from "../storage/utils/index.d.ts";
-import BaseTransformer from "./base-transformer.d.ts";
-import type { VideoCropOptions, VideoResizeOptions, VideoRotateOptions, VideoTransformationStep, VideoTransformerConfig, VideoTransformOptions, VideoTransformResult } from "./types.d.ts";
+import { F as File, g as FileReturn, B as BaseStorage } from "../packem_shared/storage.d-CEM1upWM.js";
+import { V as VideoTransformerConfig, F as VideoTransformResult, H as VideoResizeOptions, K as VideoCropOptions, N as VideoRotateOptions, O as VideoTransformOptions, Q as VideoTransformationStep, B as BaseTransformer } from "../packem_shared/types.d-CrUWY4On.js";
+import 'node:stream';
+import 'node:crypto';
+import 'node:http';
+import 'lru-cache';
 /**
- * Video transformer that uses storage backends and Mediabunny library to retrieve and transform videos.
- * @template TFile The file type used by this transformer.
- * @template TFileReturn The return type for file retrieval operations.
- *
- * Supports video transformations with query parameters for on-demand video processing.
- * @example
- * ```ts
- * const transformer = new VideoTransformer(storage, {
- *   maxVideoSize: 100 * 1024 * 1024, // 100MB
- *   cache: new Map()
- * });
- *
- * // Programmatic usage - resize a video
- * const result = await transformer.resize('video-id', {
- *   width: 1920,
- *   height: 1080,
- *   fit: 'contain'
- * });
- *
- * // URL-based transformations
- * // GET /files/video-id?width=1280&height=720&fit=cover&bitrate=2000000
- * // GET /files/video-id?codec=vp9&bitrate=1000000
- * ```
- *
- * ## Supported Query Parameters
- *
- * - `width`: Width in pixels (Number)
- * - `height`: Height in pixels (Number)
- * - `fit`: Resize fit mode - cover/contain/fill/inside/outside
- * - `codec`: Video codec - avc/hevc/vp8/vp9/av1
- * - `bitrate`: Video bitrate in bits per second (Number)
- * - `frameRate`: Frame rate in Hz (Number)
- * - `format`: Output format - mp4/webm/mkv/ogg
- */
+* Video transformer that uses storage backends and Mediabunny library to retrieve and transform videos.
+* @template TFile The file type used by this transformer.
+* @template TFileReturn The return type for file retrieval operations.
+*
+* Supports video transformations with query parameters for on-demand video processing.
+* @example
+* ```ts
+* const transformer = new VideoTransformer(storage, {
+*   maxVideoSize: 100 * 1024 * 1024, // 100MB
+*   cache: new Map()
+* });
+*
+* // Programmatic usage - resize a video
+* const result = await transformer.resize('video-id', {
+*   width: 1920,
+*   height: 1080,
+*   fit: 'contain'
+* });
+*
+* // URL-based transformations
+* // GET /files/video-id?width=1280&height=720&fit=cover&bitrate=2000000
+* // GET /files/video-id?codec=vp9&bitrate=1000000
+* ```
+*
+* ## Supported Query Parameters
+*
+* - `width`: Width in pixels (Number)
+* - `height`: Height in pixels (Number)
+* - `fit`: Resize fit mode - cover/contain/fill/inside/outside
+* - `codec`: Video codec - avc/hevc/vp8/vp9/av1
+* - `bitrate`: Video bitrate in bits per second (Number)
+* - `frameRate`: Frame rate in Hz (Number)
+* - `format`: Output format - mp4/webm/mkv/ogg
+*/
 declare class VideoTransformer<TFile extends File = File, TFileReturn extends FileReturn = FileReturn> extends BaseTransformer<VideoTransformerConfig, VideoTransformResult<TFileReturn>, TFile, TFileReturn> {
-    /**
-     * Creates a new VideoTransformer instance.
-     * @param storage The storage backend for retrieving and storing video files.
-     * @param config Configuration options for video transformation including cache settings, codec defaults, and size limits.
-     */
-    constructor(storage: BaseStorage<TFile, TFileReturn>, config?: VideoTransformerConfig);
-    /**
-     * Resizes a video to specified dimensions with optional fit mode.
-     * @param fileId Unique identifier of the video file to resize.
-     * @param options Resize options including width, height, and fit mode.
-     * @returns Promise resolving to transformed video result.
-     */
-    resize(fileId: string, options: VideoResizeOptions): Promise<VideoTransformResult<TFileReturn>>;
-    /**
-     * Crops a video to the specified region.
-     * @param fileId Unique identifier of the video file to crop.
-     * @param options Crop options including region coordinates.
-     * @returns Promise resolving to transformed video result.
-     */
-    crop(fileId: string, options: VideoCropOptions): Promise<VideoTransformResult<TFileReturn>>;
-    /**
-     * Rotates a video by the specified angle.
-     * @param fileId Unique identifier of the video file to rotate.
-     * @param options Rotation configuration with angle in degrees and optional background color.
-     * @returns Promise resolving to transformed video result.
-     */
-    rotate(fileId: string, options: VideoRotateOptions): Promise<VideoTransformResult<TFileReturn>>;
-    /**
-     * Converts video format or codec.
-     * @param fileId Unique identifier of the video file to convert.
-     * @param format Target video format (e.g., "mp4", "webm", "mkv").
-     * @param options Video transformation options including quality, bitrate, and codec settings.
-     * @returns Promise resolving to transformed video result with updated format metadata.
-     */
-    convertFormat(fileId: string, format: string, options?: VideoTransformOptions): Promise<VideoTransformResult<TFileReturn>>;
-    /**
-     * Transcodes video to different codec.
-     * @param fileId Unique identifier of the video file to transcode.
-     * @param codec Target video codec (e.g., "avc", "hevc", "vp9").
-     * @param options Additional transform options.
-     * @returns Promise resolving to transformed video result.
-     */
-    transcode(fileId: string, codec: VideoTransformOptions["codec"], options?: Omit<VideoTransformOptions, "codec">): Promise<VideoTransformResult<TFileReturn>>;
-    /**
-     * Applies a custom transformation pipeline to a video.
-     * @param fileId Unique identifier of the video file to transform.
-     * @param steps Array of transformation steps to apply in sequence.
-     * @returns Promise resolving to transformed video result.
-     */
-    transform(fileId: string, steps: VideoTransformationStep[]): Promise<VideoTransformResult<TFileReturn>>;
-    /**
-     * Applies multiple transformations in sequence using Mediabunny.
-     * @param buffer The original video buffer.
-     * @param steps Array of video transformation steps to apply.
-     * @returns Promise resolving to transformed video buffer.
-     * @private
-     */
-    private applyTransformations;
-    /**
-     * Converts transformation steps to Mediabunny video options.
-     * @param steps Array of video transformation steps to convert.
-     * @returns Mediabunny video options object for conversion.
-     * @private
-     */
-    private stepsToVideoOptions;
-    /**
-     * Determines output format based on transformation steps.
-     * @param steps Array of video transformation steps.
-     * @returns Mediabunny output format instance (defaults to MP4).
-     * @private
-     */
-    private determineOutputFormat;
-    /**
-     * Converts format string to Mediabunny output format.
-     * @param format Video format string (mp4, webm, mkv, ogg).
-     * @returns Mediabunny output format instance.
-     * @private
-     */
-    private formatStringToOutputFormat;
-    /**
-     * Validates that the file is a supported video.
-     * @param file The file to validate.
-     * @returns Promise that resolves if validation passes.
-     * @throws Error if file size exceeds limits, wrong content type, unsupported format, or invalid video.
-     * @private
-     */
-    private validateVideo;
-    /**
-     * Creates transformation result with metadata.
-     * @param buffer The transformed video buffer.
-     * @param originalFile The original file information.
-     * @returns Video transformation result with metadata.
-     * @private
-     */
-    private createTransformResult;
-    /**
-     * Generates cache key for transformation.
-     * @param fileId The file identifier.
-     * @param steps Array of transformation steps.
-     * @returns Unique cache key string.
-     * @private
-     */
-    private generateCacheKey;
+  /**
+  * Creates a new VideoTransformer instance.
+  * @param storage The storage backend for retrieving and storing video files.
+  * @param config Configuration options for video transformation including cache settings, codec defaults, and size limits.
+  */
+  constructor(storage: BaseStorage<TFile, TFileReturn>, config?: VideoTransformerConfig);
+  /**
+  * Resizes a video to specified dimensions with optional fit mode.
+  * @param fileId Unique identifier of the video file to resize.
+  * @param options Resize options including width, height, and fit mode.
+  * @returns Promise resolving to transformed video result.
+  */
+  resize(fileId: string, options: VideoResizeOptions): Promise<VideoTransformResult<TFileReturn>>;
+  /**
+  * Crops a video to the specified region.
+  * @param fileId Unique identifier of the video file to crop.
+  * @param options Crop options including region coordinates.
+  * @returns Promise resolving to transformed video result.
+  */
+  crop(fileId: string, options: VideoCropOptions): Promise<VideoTransformResult<TFileReturn>>;
+  /**
+  * Rotates a video by the specified angle.
+  * @param fileId Unique identifier of the video file to rotate.
+  * @param options Rotation configuration with angle in degrees and optional background color.
+  * @returns Promise resolving to transformed video result.
+  */
+  rotate(fileId: string, options: VideoRotateOptions): Promise<VideoTransformResult<TFileReturn>>;
+  /**
+  * Converts video format or codec.
+  * @param fileId Unique identifier of the video file to convert.
+  * @param format Target video format (e.g., "mp4", "webm", "mkv").
+  * @param options Video transformation options including quality, bitrate, and codec settings.
+  * @returns Promise resolving to transformed video result with updated format metadata.
+  */
+  convertFormat(fileId: string, format: string, options?: VideoTransformOptions): Promise<VideoTransformResult<TFileReturn>>;
+  /**
+  * Transcodes video to different codec.
+  * @param fileId Unique identifier of the video file to transcode.
+  * @param codec Target video codec (e.g., "avc", "hevc", "vp9").
+  * @param options Additional transform options.
+  * @returns Promise resolving to transformed video result.
+  */
+  transcode(fileId: string, codec: VideoTransformOptions["codec"], options?: Omit<VideoTransformOptions, "codec">): Promise<VideoTransformResult<TFileReturn>>;
+  /**
+  * Applies a custom transformation pipeline to a video.
+  * @param fileId Unique identifier of the video file to transform.
+  * @param steps Array of transformation steps to apply in sequence.
+  * @returns Promise resolving to transformed video result.
+  */
+  transform(fileId: string, steps: VideoTransformationStep[]): Promise<VideoTransformResult<TFileReturn>>;
+  /**
+  * Applies multiple transformations in sequence using Mediabunny.
+  * @param buffer The original video buffer.
+  * @param steps Array of video transformation steps to apply.
+  * @returns Promise resolving to transformed video buffer.
+  * @private
+  */
+  private applyTransformations;
+  /**
+  * Converts transformation steps to Mediabunny video options.
+  * @param steps Array of video transformation steps to convert.
+  * @returns Mediabunny video options object for conversion.
+  * @private
+  */
+  private stepsToVideoOptions;
+  /**
+  * Determines output format based on transformation steps.
+  * @param steps Array of video transformation steps.
+  * @returns Mediabunny output format instance (defaults to MP4).
+  * @private
+  */
+  private determineOutputFormat;
+  /**
+  * Converts format string to Mediabunny output format.
+  * @param format Video format string (mp4, webm, mkv, ogg).
+  * @returns Mediabunny output format instance.
+  * @private
+  */
+  private formatStringToOutputFormat;
+  /**
+  * Validates that the file is a supported video.
+  * @param file The file to validate.
+  * @returns Promise that resolves if validation passes.
+  * @throws Error if file size exceeds limits, wrong content type, unsupported format, or invalid video.
+  * @private
+  */
+  private validateVideo;
+  /**
+  * Creates transformation result with metadata.
+  * @param buffer The transformed video buffer.
+  * @param originalFile The original file information.
+  * @returns Video transformation result with metadata.
+  * @private
+  */
+  private createTransformResult;
+  /**
+  * Generates cache key for transformation.
+  * @param fileId The file identifier.
+  * @param steps Array of transformation steps.
+  * @returns Unique cache key string.
+  * @private
+  */
+  private generateCacheKey;
 }
-export default VideoTransformer;
+export { VideoTransformer as default };