@m4k/common 0.2.2 → 0.2.4

package/lib/index.d.ts

@@ -7,6 +7,7 @@ export type QueuePosition = {
 export type ProcessingError = {
     error: string;
 };
+type ImageFormat = "avif" | "jpeg" | "png" | "webp" | "tiff" | "dz" | "ppm" | "fits" | "gif" | "svg" | "heif" | "pdf" | "jp2";
 export type ImageOptions = {
     /** The rotation of the image. If not provided, the image will be auto-rotated, according to the EXIF data. To disable auto-rotation, set to `0`. */
     rotate?: number;
@@ -19,8 +20,10 @@ export type ImageOptions = {
         /** The way to resize the image. */
         fit?: "contain" | "cover" | "fill" | "inside" | "outside";
     };
+    /** The extension of the output file. This is the same as the format. */
+    ext?: ImageFormat;
     /** The format of the output file. */
-    format?: "avif" | "jpeg" | "png" | "webp" | "tiff" | "dz" | "ppm" | "fits" | "gif" | "svg" | "heif" | "pdf" | "jp2";
+    format?: ImageFormat;
     /** The quality of the output file. */
     quality?: number;
     /** Whether to keep the metadata of the image. */
@@ -42,9 +45,11 @@ export type ImageOptions = {
         /** The height of the crop. */
         height: number;
     };
+};
+export type RemoteImageOptions = ImageOptions & {
     /** The name of the output file. */
     name?: string;
-    /** The output path of the file. */
+    /** The output path of the file. This can be a local path or an S3 path. */
     output?: string;
 };
 export type VideoOptions = {
@@ -82,9 +87,13 @@ export type VideoOptions = {
     videoCodec?: string;
     /** The filters to apply to the video. */
     videoFilters?: string;
+    /** Custom ffmpeg arguments to apply to this video processing. */
+    args?: string[];
+};
+export type RemoteVideoOptions = VideoOptions & {
     /** The name of the output file. */
     name?: string;
-    /** The output path of the file. */
+    /** The output path of the file. This can be a local path or an S3 path. */
     output?: string;
 };
 export type AudioOptions = {
@@ -106,9 +115,13 @@ export type AudioOptions = {
     inputFormat?: string;
     /** The seek time of the audio. */
     seek?: number | string;
+    /** Custom ffmpeg arguments to apply to this audio processing. */
+    args?: string[];
+};
+export type RemoteAudioOptions = AudioOptions & {
     /** The name of the output file. */
     name?: string;
-    /** The output path of the file. */
+    /** The output path of the file. This can be a local path or an S3 path. */
     output?: string;
 };
 export declare class ProcessedFile {
@@ -117,4 +130,5 @@ export declare class ProcessedFile {
     readonly stream?: AsyncIterable<Uint8Array> | undefined;
     constructor(name: string, type: string, stream?: AsyncIterable<Uint8Array> | undefined);
 }
+export { mimeTypes } from "./mime";
 //# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -8,4 +8,5 @@ export class ProcessedFile {
         this.stream = stream;
     }
 }
+export { mimeTypes } from "./mime";
 //# sourceMappingURL=index.js.map

package/lib/mime.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Mapping from file extensions to their corresponding MIME types
+ */
+export declare const mimeTypes: Record<string, string>;
+//# sourceMappingURL=mime.d.ts.map

package/lib/mime.js

@@ -0,0 +1,52 @@
+/**
+ * Mapping from file extensions to their corresponding MIME types
+ */
+export const mimeTypes = {
+    // Image formats
+    jpg: "image/jpeg",
+    jpeg: "image/jpeg",
+    png: "image/png",
+    gif: "image/gif",
+    webp: "image/webp",
+    avif: "image/avif",
+    heic: "image/heic",
+    heif: "image/heif",
+    svg: "image/svg+xml",
+    tiff: "image/tiff",
+    tif: "image/tiff",
+    bmp: "image/bmp",
+    ico: "image/x-icon",
+    // Video formats
+    mp4: "video/mp4",
+    asx: "video/x-ms-asf",
+    asf: "video/x-ms-asf",
+    mkv: "video/x-matroska",
+    mov: "video/quicktime",
+    avi: "video/x-msvideo",
+    wmv: "video/x-ms-wmv",
+    flv: "video/x-flv",
+    webm: "video/webm",
+    m4v: "video/x-m4v",
+    mng: "video/x-mng",
+    mpg: "video/mpeg",
+    mpeg: "video/mpeg",
+    ogv: "video/ogg",
+    "3gpp": "video/3gpp",
+    "3gp": "video/3gpp",
+    ts: "video/mp2t",
+    // Audio formats
+    mp3: "audio/mpeg",
+    wav: "audio/wav",
+    ogg: "audio/ogg",
+    oga: "audio/ogg",
+    m4a: "audio/mp4",
+    aac: "audio/aac",
+    flac: "audio/flac",
+    wma: "audio/x-ms-wma",
+    m4b: "audio/mp4",
+    m4p: "audio/mp4",
+    opus: "audio/opus",
+    aiff: "audio/aiff",
+    alac: "audio/alac",
+};
+//# sourceMappingURL=mime.js.map

package/package.json

@@ -1,18 +1,23 @@
 {
   "name": "@m4k/common",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "type": "module",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "module": "./lib/index.js",
   "license": "MIT",
+  "description": "Common types and utilities for m4k",
+  "author": "sv2dev",
   "scripts": {
     "prepublishOnly": "bun run build",
     "build": "tsc -b",
     "typecheck": "tsc --noEmit"
   },
   "devDependencies": {
-    "typescript": "^5.0.0"
+    "typescript": "^5.8.3"
   },
-  "repository": "github:sv2dev/m4k"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sv2dev/m4k.git"
+  }
 }