@m4k/common 0.1.0

package/README.md

@@ -0,0 +1,3 @@
+# m4k - common
+
+Common types and utilities for the media kit.

package/lib/index.d.ts

@@ -0,0 +1,92 @@
+export type Progress = {
+    progress: number;
+};
+export type QueuePosition = {
+    position: number;
+};
+export type ProcessingError = {
+    error: string;
+};
+export type ImageOptimizerOptions = {
+    /** 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;
+    /** Resizing options. */
+    resize?: {
+        /** The width of the image. */
+        width?: number;
+        /** The height of the image. */
+        height?: number;
+        /** The way to resize the image. */
+        fit?: "contain" | "cover" | "fill" | "inside" | "outside";
+    };
+    /** The format of the output file. */
+    format?: "avif" | "jpeg" | "png" | "webp" | "tiff" | "dz" | "ppm" | "fits" | "gif" | "svg" | "heif" | "pdf" | "jp2";
+    /** The quality of the output file. */
+    quality?: number;
+    /** Whether to keep the metadata of the image. */
+    keepMetadata?: boolean;
+    /** Whether to keep the EXIF data of the image. */
+    keepExif?: boolean;
+    /** Whether to keep the ICC profile of the image. */
+    keepIcc?: boolean;
+    /** The colorspace of the image. */
+    colorspace?: string;
+    /** The cropping options. */
+    crop?: {
+        /** The left position of the crop. */
+        left?: number;
+        /** The top position of the crop. */
+        top?: number;
+        /** The width of the crop. */
+        width: number;
+        /** The height of the crop. */
+        height: number;
+    };
+    /** The name of the output file. */
+    name?: string;
+    /** The output path of the file. */
+    output?: string;
+};
+export type VideoOptimizerOptions = {
+    /** The aspect ratio of the output file. */
+    aspect?: number | string;
+    /** The bitrate of the audio. */
+    audioBitrate?: number | string;
+    /** The codec of the audio. */
+    audioCodec?: string;
+    /** The filters to apply to the audio. */
+    audioFilters?: string;
+    /** The complex filters to apply to the video. */
+    complexFilters?: string;
+    /** The duration of the output file. */
+    duration?: number | string;
+    /** The format of the output file. */
+    format?: string;
+    /** The frames per second of the output file. */
+    fps?: number;
+    /** The input format of the video. */
+    inputFormat?: string;
+    /** The padding of the output file. */
+    pad?: string;
+    /** The position in the input file to start processing from. */
+    seek?: number | string;
+    /** The resolution of the output file. */
+    size?: string;
+    /** The bitrate of the video. */
+    videoBitrate?: number | string;
+    /** The codec of the video. */
+    videoCodec?: string;
+    /** The filters to apply to the video. */
+    videoFilters?: string;
+    /** The name of the output file. */
+    name?: string;
+    /** The output path of the file. */
+    output?: string;
+};
+export declare class ConvertedFile {
+    readonly name: string;
+    readonly type: string;
+    readonly stream?: AsyncIterable<Uint8Array> | undefined;
+    constructor(name: string, type: string, stream?: AsyncIterable<Uint8Array> | undefined);
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -0,0 +1,11 @@
+export class ConvertedFile {
+    name;
+    type;
+    stream;
+    constructor(name, type, stream) {
+        this.name = name;
+        this.type = type;
+        this.stream = stream;
+    }
+}
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@m4k/common",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "module": "./lib/index.js",
+  "license": "MIT",
+  "scripts": {
+    "prepublishOnly": "bun run build",
+    "build": "tsc -b",
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "repository": "github:sv2dev/m4k"
+}