simple-ffmpegjs 0.1.0 → 0.1.1

package/README.md

@@ -23,8 +23,8 @@ Built for data pipelines: a tiny helper around FFmpeg that makes common edits tr
 - 🧱 Scales to long scripts via optional multi-pass text batching
 - 🧩 Ships TypeScript definitions without requiring TS
 - 🪶 No external libraries (other than FFmpeg), no bundled fonts; extremely lightweight
-- 🧑‍💻 Actively maintained; PRs and issues welcome
 - 🖼️ Image support with Ken Burns (zoom-in/out, pan-left/right/up/down)
+- 🧑‍💻 Actively maintained; PRs and issues welcome
 
 ## 📦 Install
 
@@ -32,13 +32,25 @@ Built for data pipelines: a tiny helper around FFmpeg that makes common edits tr
 npm install simple-ffmpegjs
 ```
 
+### Import syntax
+
+```js
+// CommonJS
+const SIMPLEFFMPEG = require("simple-ffmpegjs");
+```
+
+```js
+// ESM
+import SIMPLEFFMPEG from "simple-ffmpegjs";
+```
+
 ## ⚙️ Requirements
 
 Make sure you have ffmpeg installed on your system:
 
-**Mac**: brew install ffmpeg
+**Mac**: `brew install ffmpeg`
 
-**Ubuntu/Debian**: apt-get install ffmpeg
+**Ubuntu/Debian**: `apt-get install ffmpeg`
 
 **Windows**: Download from ffmpeg.org
 

package/index.cjs

@@ -0,0 +1,2 @@
+module.exports = require("./src/simpleffmpeg.js");
+module.exports.default = module.exports;

package/index.mjs

@@ -0,0 +1,2 @@
+import SIMPLEFFMPEG from "./src/simpleffmpeg.js";
+export default SIMPLEFFMPEG;

package/package.json

@@ -1,12 +1,24 @@
 {
   "name": "simple-ffmpegjs",
-  "version": "0.1.0",
-  "main": "index.js",
+  "version": "0.1.1",
+  "main": "index.cjs",
+  "module": "index.mjs",
   "types": "types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./types/index.d.mts",
+        "require": "./types/index.d.ts"
+      },
+      "import": "./index.mjs",
+      "require": "./index.cjs"
+    }
+  },
   "files": [
     "src",
     "types",
-    "index.js"
+    "index.cjs",
+    "index.mjs"
   ],
   "keywords": [
     "ffmpeg",
@@ -33,5 +45,8 @@
     "email": "braydenblackwell21@gmail.com"
   },
   "homepage": "https://github.com/Fats403/simple-ffmpeg#readme",
-  "description": "Simple Node.js helper around ffmpeg for video composition, transitions, audio mixing, and text rendering."
+  "description": "Simple Node.js helper around ffmpeg for video composition, transitions, audio mixing, and text rendering.",
+  "engines": {
+    "node": ">=16"
+  }
 }

package/types/index.d.mts

@@ -0,0 +1,132 @@
+declare namespace SIMPLEFFMPEG {
+  type ClipType =
+    | "video"
+    | "audio"
+    | "text"
+    | "music"
+    | "backgroundAudio"
+    | "image";
+
+  interface BaseClip {
+    type: ClipType;
+    url?: string;
+    position: number;
+    end: number;
+  }
+
+  interface VideoClip extends BaseClip {
+    type: "video";
+    url: string;
+    cutFrom?: number;
+    transition?: { type: string; duration: number };
+  }
+
+  interface AudioClip extends BaseClip {
+    type: "audio";
+    url: string;
+    cutFrom?: number;
+    volume?: number;
+  }
+
+  interface BackgroundMusicClip extends BaseClip {
+    type: "music" | "backgroundAudio";
+    url: string;
+    cutFrom?: number;
+    volume?: number;
+  }
+
+  interface ImageClip extends BaseClip {
+    type: "image";
+    url: string;
+    kenBurns?:
+      | "zoom-in"
+      | "zoom-out"
+      | "pan-left"
+      | "pan-right"
+      | "pan-up"
+      | "pan-down";
+  }
+
+  type TextMode = "static" | "word-replace" | "word-sequential";
+  type TextAnimationType =
+    | "none"
+    | "fade-in"
+    | "fade-in-out"
+    | "pop"
+    | "pop-bounce";
+
+  interface TextWordWindow {
+    text: string;
+    start: number;
+    end: number;
+  }
+
+  interface TextClip {
+    type: "text";
+    text?: string;
+    position: number;
+    end: number;
+    mode?: TextMode;
+    words?: TextWordWindow[];
+    wordTimestamps?: number[];
+
+    // Font
+    fontFile?: string;
+    fontFamily?: string;
+    fontSize?: number;
+    fontColor?: string;
+
+    // Position
+    centerX?: number;
+    centerY?: number;
+    x?: number;
+    y?: number;
+
+    // Styling
+    borderColor?: string;
+    borderWidth?: number;
+    shadowColor?: string;
+    shadowX?: number;
+    shadowY?: number;
+    backgroundColor?: string;
+    backgroundOpacity?: number;
+    padding?: number;
+
+    // Animation
+    animation?: {
+      type: TextAnimationType;
+      in?: number;
+      out?: number;
+    };
+  }
+
+  type Clip =
+    | VideoClip
+    | AudioClip
+    | BackgroundMusicClip
+    | ImageClip
+    | TextClip;
+
+  interface SIMPLEFFMPEGOptions {
+    fps?: number;
+    width?: number;
+    height?: number;
+    validationMode?: "warn" | "strict";
+  }
+
+  interface ExportOptions {
+    outputPath?: string;
+    textMaxNodesPerPass?: number;
+    intermediateVideoCodec?: string;
+    intermediateCrf?: number;
+    intermediatePreset?: string;
+  }
+}
+
+declare class SIMPLEFFMPEG {
+  constructor(options: SIMPLEFFMPEG.SIMPLEFFMPEGOptions);
+  load(clips: SIMPLEFFMPEG.Clip[]): Promise<void[]>;
+  export(options: SIMPLEFFMPEG.ExportOptions): Promise<string>;
+}
+
+export default SIMPLEFFMPEG;

package/types/index.d.ts

@@ -1,128 +1,139 @@
-export type ClipType =
-  | "video"
-  | "audio"
-  | "text"
-  | "music"
-  | "backgroundAudio"
-  | "image";
-
-export interface BaseClip {
-  type: ClipType;
-  url?: string;
-  position: number;
-  end: number;
+declare namespace SIMPLEFFMPEG {
+  type ClipType =
+    | "video"
+    | "audio"
+    | "text"
+    | "music"
+    | "backgroundAudio"
+    | "image";
+
+  interface BaseClip {
+    type: ClipType;
+    url?: string;
+    position: number;
+    end: number;
+  }
+
+  interface VideoClip extends BaseClip {
+    type: "video";
+    url: string;
+    cutFrom?: number;
+    transition?: { type: string; duration: number };
+  }
+
+  interface AudioClip extends BaseClip {
+    type: "audio";
+    url: string;
+    cutFrom?: number;
+    volume?: number;
+  }
+
+  interface BackgroundMusicClip extends BaseClip {
+    type: "music" | "backgroundAudio";
+    url: string;
+    cutFrom?: number;
+    volume?: number;
+  }
+
+  interface ImageClip extends BaseClip {
+    type: "image";
+    url: string;
+    kenBurns?:
+      | "zoom-in"
+      | "zoom-out"
+      | "pan-left"
+      | "pan-right"
+      | "pan-up"
+      | "pan-down";
+  }
+
+  type TextMode = "static" | "word-replace" | "word-sequential";
+  type TextAnimationType =
+    | "none"
+    | "fade-in"
+    | "fade-in-out"
+    | "pop"
+    | "pop-bounce";
+
+  interface TextWordWindow {
+    text: string;
+    start: number;
+    end: number;
+  }
+
+  interface TextClip {
+    type: "text";
+    text?: string;
+    position: number;
+    end: number;
+    mode?: TextMode;
+    words?: TextWordWindow[];
+    wordTimestamps?: number[];
+
+    // Font
+    fontFile?: string;
+    fontFamily?: string; // defaults to 'Sans' via fontconfig
+    fontSize?: number; // default 48
+    fontColor?: string; // default '#FFFFFF'
+
+    // Position
+    centerX?: number;
+    centerY?: number;
+    x?: number;
+    y?: number;
+
+    // Styling
+    borderColor?: string;
+    borderWidth?: number;
+    shadowColor?: string;
+    shadowX?: number;
+    shadowY?: number;
+    backgroundColor?: string;
+    backgroundOpacity?: number;
+    padding?: number;
+
+    // Animation
+    animation?: {
+      type: TextAnimationType;
+      in?: number; // seconds
+      out?: number; // seconds
+    };
+  }
+
+  type Clip =
+    | VideoClip
+    | AudioClip
+    | BackgroundMusicClip
+    | ImageClip
+    | TextClip;
+
+  interface SIMPLEFFMPEGOptions {
+    fps?: number;
+    width?: number;
+    height?: number;
+    validationMode?: "warn" | "strict";
+  }
+
+  interface ExportOptions {
+    outputPath?: string;
+    textMaxNodesPerPass?: number;
+    intermediateVideoCodec?: string;
+    intermediateCrf?: number;
+    intermediatePreset?: string;
+  }
 }
 
-export interface VideoClip extends BaseClip {
-  type: "video";
-  url: string;
-  cutFrom?: number;
-  transition?: { type: string; duration: number };
+declare class SIMPLEFFMPEG {
+  constructor(options: SIMPLEFFMPEG.SIMPLEFFMPEGOptions);
+  load(clips: SIMPLEFFMPEG.Clip[]): Promise<void[]>;
+  export(options: SIMPLEFFMPEG.ExportOptions): Promise<string>;
 }
 
-export interface AudioClip extends BaseClip {
-  type: "audio";
-  url: string;
-  cutFrom?: number;
-  volume?: number;
+/**
+ * Synthetic default export type for ESM default-import IntelliSense
+ */
+declare namespace _defaultExportType {
+  export { SIMPLEFFMPEG as default };
 }
 
-export interface BackgroundMusicClip extends BaseClip {
-  type: "music" | "backgroundAudio";
-  url: string;
-  cutFrom?: number;
-  volume?: number;
-}
-
-export interface ImageClip extends BaseClip {
-  type: "image";
-  url: string;
-  kenBurns?:
-    | "zoom-in"
-    | "zoom-out"
-    | "pan-left"
-    | "pan-right"
-    | "pan-up"
-    | "pan-down";
-}
-
-export type TextMode = "static" | "word-replace" | "word-sequential";
-export type TextAnimationType =
-  | "none"
-  | "fade-in"
-  | "fade-in-out"
-  | "pop"
-  | "pop-bounce";
-
-export interface TextWordWindow {
-  text: string;
-  start: number;
-  end: number;
-}
-
-export interface TextClip {
-  type: "text";
-  text?: string;
-  position: number;
-  end: number;
-  mode?: TextMode;
-  words?: TextWordWindow[];
-  wordTimestamps?: number[];
-
-  // Font
-  fontFile?: string;
-  fontFamily?: string; // defaults to 'Sans' via fontconfig
-  fontSize?: number; // default 48
-  fontColor?: string; // default '#FFFFFF'
-
-  // Position
-  centerX?: number;
-  centerY?: number;
-  x?: number;
-  y?: number;
-
-  // Styling
-  borderColor?: string;
-  borderWidth?: number;
-  shadowColor?: string;
-  shadowX?: number;
-  shadowY?: number;
-  backgroundColor?: string;
-  backgroundOpacity?: number;
-  padding?: number;
-
-  // Animation
-  animation?: {
-    type: TextAnimationType;
-    in?: number; // seconds
-    out?: number; // seconds
-  };
-}
-
-export type Clip =
-  | VideoClip
-  | AudioClip
-  | BackgroundMusicClip
-  | ImageClip
-  | TextClip;
-
-export interface SIMPLEFFMPEGOptions {
-  fps?: number;
-  width?: number;
-  height?: number;
-  validationMode?: "warn" | "strict";
-}
-
-export interface ExportOptions {
-  outputPath?: string;
-  textMaxNodesPerPass?: number;
-  intermediateVideoCodec?: string;
-  intermediateCrf?: number;
-  intermediatePreset?: string;
-}
-
-export default class SIMPLEFFMPEG {
-  constructor(options: SIMPLEFFMPEGOptions);
-  load(clips: Clip[]): Promise<void[]>;
-  export(options: ExportOptions): Promise<string>;
-}
+export = SIMPLEFFMPEG;

package/index.js

@@ -1 +0,0 @@
-module.exports = require("./src/simpleffmpeg");