@better-media/plugin-media-processing 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 abenezeratnafu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
+ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,35 @@
+# @better-media/plugin-media-processing
+
+Media processing (image, video) plugin for the Better Media framework.
+
+## Features
+
+- **Image Resizing**: Resize to specific dimensions or percentages.
+- **Transcoding**: Convert to WebP, AVIF, JPEG, or other formats.
+- **Sharp-based**: Uses high-performance Node.js processing.
+- **Background Support**: Supports enqueuing processing jobs via job adapters.
+
+## Installation
+
+```bash
+pnpm add @better-media/plugin-media-processing sharp
+```
+
+## Usage
+
+```ts
+import { mediaProcessingPlugin } from "@better-media/plugin-media-processing";
+
+const media = createBetterMedia({
+  plugins: [
+    mediaProcessingPlugin({
+      outputs: [
+        { suffix: "-thumbnail", width: 200 },
+        { suffix: "-high-res", format: "webp" },
+      ],
+    }),
+  ],
+});
+```
+
+See the [better-media.dev/docs/plugins/media-processing](https://better-media.dev/docs/plugins/media-processing) for more configuration options.

package/dist/index.d.mts

@@ -0,0 +1,19 @@
+import { PipelinePlugin } from '@better-media/core';
+
+/**
+ * Media processing plugin configuration (stub; no image/video processing yet).
+ */
+interface MediaProcessingPluginOptions {
+    /**
+     * Execution mode. Default: "background".
+     */
+    executionMode?: "sync" | "background";
+}
+
+/**
+ * Media processing plugin for the Better Media pipeline (stub).
+ * Currently logs on `process:run`; thumbnail/metadata handling is not implemented.
+ */
+declare function mediaProcessingPlugin(opts?: MediaProcessingPluginOptions): PipelinePlugin;
+
+export { type MediaProcessingPluginOptions, mediaProcessingPlugin };

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import { PipelinePlugin } from '@better-media/core';
+
+/**
+ * Media processing plugin configuration (stub; no image/video processing yet).
+ */
+interface MediaProcessingPluginOptions {
+    /**
+     * Execution mode. Default: "background".
+     */
+    executionMode?: "sync" | "background";
+}
+
+/**
+ * Media processing plugin for the Better Media pipeline (stub).
+ * Currently logs on `process:run`; thumbnail/metadata handling is not implemented.
+ */
+declare function mediaProcessingPlugin(opts?: MediaProcessingPluginOptions): PipelinePlugin;
+
+export { type MediaProcessingPluginOptions, mediaProcessingPlugin };

package/dist/index.js

@@ -0,0 +1,40 @@
+'use strict';
+
+// src/runtime/runner.ts
+async function runMediaProcessing(context, _api, opts) {
+  const { file } = context;
+  console.log("[media-processing] process:run (stub \u2014 sharp/ffmpeg disabled)", {
+    key: file.key,
+    mimeType: file.mimeType,
+    executionMode: opts.executionMode ?? "background"
+  });
+}
+
+// src/index.ts
+function mediaProcessingPlugin(opts = {}) {
+  const executionMode = opts.executionMode ?? "background";
+  const isBackground = executionMode === "background";
+  return {
+    name: "media-processing",
+    runtimeManifest: {
+      id: "better-media-processing",
+      version: "1.0.0",
+      trustLevel: "untrusted",
+      capabilities: ["file.read", "metadata.write.own", "processing.write.own"],
+      namespace: "media-processing"
+    },
+    executionMode,
+    intensive: isBackground,
+    apply(runtime) {
+      runtime.hooks["process:run"].tap(
+        "media-processing",
+        async (context, api) => runMediaProcessing(context, api, opts),
+        { mode: executionMode }
+      );
+    }
+  };
+}
+
+exports.mediaProcessingPlugin = mediaProcessingPlugin;
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/runtime/runner.ts","../src/index.ts"],"names":[],"mappings":";;;AAGA,eAAsB,kBAAA,CACpB,OAAA,EACA,IAAA,EACA,IAAA,EACe;AACf,EAAA,MAAM,EAAE,MAAK,GAAI,OAAA;AACjB,EAAA,OAAA,CAAQ,IAAI,oEAAA,EAAiE;AAAA,IAC3E,KAAK,IAAA,CAAK,GAAA;AAAA,IACV,UAAU,IAAA,CAAK,QAAA;AAAA,IACf,aAAA,EAAe,KAAK,aAAA,IAAiB;AAAA,GACtC,CAAA;AACH;;;ACJO,SAAS,qBAAA,CAAsB,IAAA,GAAqC,EAAC,EAAmB;AAC7F,EAAA,MAAM,aAAA,GAAgB,KAAK,aAAA,IAAiB,YAAA;AAC5C,EAAA,MAAM,eAAe,aAAA,KAAkB,YAAA;AAEvC,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,kBAAA;AAAA,IACN,eAAA,EAAiB;AAAA,MACf,EAAA,EAAI,yBAAA;AAAA,MACJ,OAAA,EAAS,OAAA;AAAA,MACT,UAAA,EAAY,WAAA;AAAA,MACZ,YAAA,EAAc,CAAC,WAAA,EAAa,oBAAA,EAAsB,sBAAsB,CAAA;AAAA,MACxE,SAAA,EAAW;AAAA,KACb;AAAA,IACA,aAAA;AAAA,IACA,SAAA,EAAW,YAAA;AAAA,IACX,MAAM,OAAA,EAAuB;AAC3B,MAAA,OAAA,CAAQ,KAAA,CAAM,aAAa,CAAA,CAAE,GAAA;AAAA,QAC3B,kBAAA;AAAA,QACA,OAAO,OAAA,EAA0B,GAAA,KAAmB,kBAAA,CAAmB,OAAA,EAAS,KAAK,IAAI,CAAA;AAAA,QACzF,EAAE,MAAM,aAAA;AAAc,OACxB;AAAA,IACF;AAAA,GACF;AACF","file":"index.js","sourcesContent":["import type { PipelineContext, PluginApi } from \"@better-media/core\";\nimport type { MediaProcessingPluginOptions } from \"../interfaces/options.interface\";\n\nexport async function runMediaProcessing(\n  context: PipelineContext,\n  _api: PluginApi,\n  opts: MediaProcessingPluginOptions\n): Promise<void> {\n  const { file } = context;\n  console.log(\"[media-processing] process:run (stub — sharp/ffmpeg disabled)\", {\n    key: file.key,\n    mimeType: file.mimeType,\n    executionMode: opts.executionMode ?? \"background\",\n  });\n}\n","import type { PipelinePlugin, MediaRuntime, PipelineContext, PluginApi } from \"@better-media/core\";\nimport type { MediaProcessingPluginOptions } from \"./interfaces/options.interface\";\nimport { runMediaProcessing } from \"./runtime/runner\";\n\nexport type { MediaProcessingPluginOptions } from \"./interfaces/options.interface\";\n\n/**\n * Media processing plugin for the Better Media pipeline (stub).\n * Currently logs on `process:run`; thumbnail/metadata handling is not implemented.\n */\nexport function mediaProcessingPlugin(opts: MediaProcessingPluginOptions = {}): PipelinePlugin {\n  const executionMode = opts.executionMode ?? \"background\";\n  const isBackground = executionMode === \"background\";\n\n  return {\n    name: \"media-processing\",\n    runtimeManifest: {\n      id: \"better-media-processing\",\n      version: \"1.0.0\",\n      trustLevel: \"untrusted\",\n      capabilities: [\"file.read\", \"metadata.write.own\", \"processing.write.own\"],\n      namespace: \"media-processing\",\n    },\n    executionMode,\n    intensive: isBackground,\n    apply(runtime: MediaRuntime) {\n      runtime.hooks[\"process:run\"].tap(\n        \"media-processing\",\n        async (context: PipelineContext, api: PluginApi) => runMediaProcessing(context, api, opts),\n        { mode: executionMode }\n      );\n    },\n  };\n}\n"]}

package/dist/index.mjs

@@ -0,0 +1,38 @@
+// src/runtime/runner.ts
+async function runMediaProcessing(context, _api, opts) {
+  const { file } = context;
+  console.log("[media-processing] process:run (stub \u2014 sharp/ffmpeg disabled)", {
+    key: file.key,
+    mimeType: file.mimeType,
+    executionMode: opts.executionMode ?? "background"
+  });
+}
+
+// src/index.ts
+function mediaProcessingPlugin(opts = {}) {
+  const executionMode = opts.executionMode ?? "background";
+  const isBackground = executionMode === "background";
+  return {
+    name: "media-processing",
+    runtimeManifest: {
+      id: "better-media-processing",
+      version: "1.0.0",
+      trustLevel: "untrusted",
+      capabilities: ["file.read", "metadata.write.own", "processing.write.own"],
+      namespace: "media-processing"
+    },
+    executionMode,
+    intensive: isBackground,
+    apply(runtime) {
+      runtime.hooks["process:run"].tap(
+        "media-processing",
+        async (context, api) => runMediaProcessing(context, api, opts),
+        { mode: executionMode }
+      );
+    }
+  };
+}
+
+export { mediaProcessingPlugin };
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/runtime/runner.ts","../src/index.ts"],"names":[],"mappings":";AAGA,eAAsB,kBAAA,CACpB,OAAA,EACA,IAAA,EACA,IAAA,EACe;AACf,EAAA,MAAM,EAAE,MAAK,GAAI,OAAA;AACjB,EAAA,OAAA,CAAQ,IAAI,oEAAA,EAAiE;AAAA,IAC3E,KAAK,IAAA,CAAK,GAAA;AAAA,IACV,UAAU,IAAA,CAAK,QAAA;AAAA,IACf,aAAA,EAAe,KAAK,aAAA,IAAiB;AAAA,GACtC,CAAA;AACH;;;ACJO,SAAS,qBAAA,CAAsB,IAAA,GAAqC,EAAC,EAAmB;AAC7F,EAAA,MAAM,aAAA,GAAgB,KAAK,aAAA,IAAiB,YAAA;AAC5C,EAAA,MAAM,eAAe,aAAA,KAAkB,YAAA;AAEvC,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,kBAAA;AAAA,IACN,eAAA,EAAiB;AAAA,MACf,EAAA,EAAI,yBAAA;AAAA,MACJ,OAAA,EAAS,OAAA;AAAA,MACT,UAAA,EAAY,WAAA;AAAA,MACZ,YAAA,EAAc,CAAC,WAAA,EAAa,oBAAA,EAAsB,sBAAsB,CAAA;AAAA,MACxE,SAAA,EAAW;AAAA,KACb;AAAA,IACA,aAAA;AAAA,IACA,SAAA,EAAW,YAAA;AAAA,IACX,MAAM,OAAA,EAAuB;AAC3B,MAAA,OAAA,CAAQ,KAAA,CAAM,aAAa,CAAA,CAAE,GAAA;AAAA,QAC3B,kBAAA;AAAA,QACA,OAAO,OAAA,EAA0B,GAAA,KAAmB,kBAAA,CAAmB,OAAA,EAAS,KAAK,IAAI,CAAA;AAAA,QACzF,EAAE,MAAM,aAAA;AAAc,OACxB;AAAA,IACF;AAAA,GACF;AACF","file":"index.mjs","sourcesContent":["import type { PipelineContext, PluginApi } from \"@better-media/core\";\nimport type { MediaProcessingPluginOptions } from \"../interfaces/options.interface\";\n\nexport async function runMediaProcessing(\n  context: PipelineContext,\n  _api: PluginApi,\n  opts: MediaProcessingPluginOptions\n): Promise<void> {\n  const { file } = context;\n  console.log(\"[media-processing] process:run (stub — sharp/ffmpeg disabled)\", {\n    key: file.key,\n    mimeType: file.mimeType,\n    executionMode: opts.executionMode ?? \"background\",\n  });\n}\n","import type { PipelinePlugin, MediaRuntime, PipelineContext, PluginApi } from \"@better-media/core\";\nimport type { MediaProcessingPluginOptions } from \"./interfaces/options.interface\";\nimport { runMediaProcessing } from \"./runtime/runner\";\n\nexport type { MediaProcessingPluginOptions } from \"./interfaces/options.interface\";\n\n/**\n * Media processing plugin for the Better Media pipeline (stub).\n * Currently logs on `process:run`; thumbnail/metadata handling is not implemented.\n */\nexport function mediaProcessingPlugin(opts: MediaProcessingPluginOptions = {}): PipelinePlugin {\n  const executionMode = opts.executionMode ?? \"background\";\n  const isBackground = executionMode === \"background\";\n\n  return {\n    name: \"media-processing\",\n    runtimeManifest: {\n      id: \"better-media-processing\",\n      version: \"1.0.0\",\n      trustLevel: \"untrusted\",\n      capabilities: [\"file.read\", \"metadata.write.own\", \"processing.write.own\"],\n      namespace: \"media-processing\",\n    },\n    executionMode,\n    intensive: isBackground,\n    apply(runtime: MediaRuntime) {\n      runtime.hooks[\"process:run\"].tap(\n        \"media-processing\",\n        async (context: PipelineContext, api: PluginApi) => runMediaProcessing(context, api, opts),\n        { mode: executionMode }\n      );\n    },\n  };\n}\n"]}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@better-media/plugin-media-processing",
+  "version": "0.1.0",
+  "description": "Media processing plugin for Better Media pipeline",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "@better-media/core": "0.1.0"
+  },
+  "keywords": [],
+  "author": "Abenezer Atnafu",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AbenezerAtnafu/better-media.git"
+  },
+  "homepage": "https://better-media.dev",
+  "bugs": {
+    "url": "https://github.com/AbenezerAtnafu/better-media/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "test": "jest"
+  }
+}