@adonis-agora/media 0.8.1 → 0.9.0

package/dist/src/transformers/mediabunny_loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mediabunny_loader.js","sourceRoot":"","sources":["../../../src/transformers/mediabunny_loader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAE,MAAM,cAAc,CAAC;AAU9D;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,eAAuB;IAC1D,IAAI,CAAC;QACH,OAAO,MAAM,MAAM,CAAC,iBAAiB,CAAC,CAAC;IACzC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IACG,KAA2B,CAAC,IAAI,KAAK,sBAAsB;YAC5D,KAAK,YAAY,KAAK;YACtB,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,EACpC,CAAC;YACD,MAAM,IAAI,8BAA8B,CACtC,eAAe,EACf,2CAA2C,EAC3C,iEAAiE,CAClE,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/src/transformers/probe.d.ts

@@ -0,0 +1,56 @@
+import type { TransformResult, Transformer, TransformerContext } from '../transformer.js';
+/** What probing a media file yields — persisted verbatim as the conversion's `meta`. */
+export interface MediaProbeSummary {
+    /** Container format name (e.g. `MP4`), when the engine can tell. */
+    format?: string;
+    /** Full MIME type including codecs parameter, when the engine can tell. */
+    mimeType?: string;
+    durationSeconds?: number;
+    width?: number;
+    height?: number;
+    videoCodec?: string | null;
+    audioCodec?: string | null;
+    audioSampleRate?: number;
+    audioChannels?: number;
+    hasVideo: boolean;
+    hasAudio: boolean;
+}
+/**
+ * The engine seam of {@link MetadataProbeTransformer}: local file in, metadata out. Default engine
+ * is mediabunny (lazy); tests inject a fake.
+ */
+export interface MediaProbeEngine {
+    probe(sourcePath: string): Promise<MediaProbeSummary>;
+}
+export interface MetadataProbeTransformerOptions<Name extends string = 'probe'> {
+    /** Conversion name on the record. Default `'probe'`. */
+    name?: Name;
+    /**
+     * Run inside attach. Default `false`: probing is CPU-cheap but reads the original, and on a
+     * remote disk that read is a download. Opt in for collections of small files.
+     */
+    eager?: boolean;
+    /** Replace the mediabunny engine (mainly for tests). */
+    engine?: MediaProbeEngine;
+}
+/**
+ * The built-in **metadata-only** {@link Transformer}: reads a media file's technical metadata —
+ * duration, resolution, codecs, channel layout — and persists it as
+ * `record.conversions['probe'].meta`, writing **no artifact at all**. The reference implementation
+ * of the "derive metadata, not files" transformer shape; the model for a blurhash/thumbhash
+ * placeholder transformer.
+ *
+ * ```ts
+ * await media.library.transform(id, 'probe')
+ * const record = await media.library.find(id)
+ * record.conversions.probe?.meta // { durationSeconds: 41.6, width: 1920, ... }
+ * ```
+ */
+export declare class MetadataProbeTransformer<Name extends string = 'probe'> implements Transformer {
+    readonly name: Name;
+    readonly eager: boolean;
+    private readonly engine;
+    constructor(options?: MetadataProbeTransformerOptions<Name>);
+    transform(context: TransformerContext): Promise<TransformResult>;
+}
+//# sourceMappingURL=probe.d.ts.map

package/dist/src/transformers/probe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"probe.d.ts","sourceRoot":"","sources":["../../../src/transformers/probe.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAK1F,wFAAwF;AACxF,MAAM,WAAW,iBAAiB;IAChC,oEAAoE;IACpE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,+BAA+B,CAAC,IAAI,SAAS,MAAM,GAAG,OAAO;IAC5E,wDAAwD;IACxD,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,wDAAwD;IACxD,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC3B;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,wBAAwB,CAAC,IAAI,SAAS,MAAM,GAAG,OAAO,CAAE,YAAW,WAAW;IACzF,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA+B;gBAE1C,OAAO,GAAE,+BAA+B,CAAC,IAAI,CAAM;IAMzD,SAAS,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC;CAKvE"}

package/dist/src/transformers/probe.js

@@ -0,0 +1,32 @@
+import { compactMeta } from './hls.js';
+import { loadMediabunny } from './mediabunny_loader.js';
+import { withSourceFile } from './source_file.js';
+/**
+ * The built-in **metadata-only** {@link Transformer}: reads a media file's technical metadata —
+ * duration, resolution, codecs, channel layout — and persists it as
+ * `record.conversions['probe'].meta`, writing **no artifact at all**. The reference implementation
+ * of the "derive metadata, not files" transformer shape; the model for a blurhash/thumbhash
+ * placeholder transformer.
+ *
+ * ```ts
+ * await media.library.transform(id, 'probe')
+ * const record = await media.library.find(id)
+ * record.conversions.probe?.meta // { durationSeconds: 41.6, width: 1920, ... }
+ * ```
+ */
+export class MetadataProbeTransformer {
+    name;
+    eager;
+    engine;
+    constructor(options = {}) {
+        this.name = options.name ?? 'probe';
+        this.eager = options.eager ?? false;
+        this.engine = options.engine;
+    }
+    async transform(context) {
+        const engine = this.engine ?? (await loadMediabunny(this.name)).createProbeEngine();
+        const summary = await withSourceFile(context, ({ sourcePath }) => engine.probe(sourcePath));
+        return { meta: compactMeta({ ...summary }) };
+    }
+}
+//# sourceMappingURL=probe.js.map

package/dist/src/transformers/probe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"probe.js","sourceRoot":"","sources":["../../../src/transformers/probe.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAuClD;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,wBAAwB;IAC1B,IAAI,CAAO;IACX,KAAK,CAAU;IACP,MAAM,CAA+B;IAEtD,YAAY,UAAiD,EAAE;QAC7D,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAK,OAAgB,CAAC;QAC9C,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,OAA2B;QACzC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB,EAAE,CAAC;QACpF,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;QAC5F,OAAO,EAAE,IAAI,EAAE,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC,EAAE,CAAC;IAC/C,CAAC;CACF"}

package/dist/src/transformers/source_file.d.ts

@@ -0,0 +1,20 @@
+import type { TransformerContext } from '../transformer.js';
+/** What {@link withSourceFile} hands its callback. */
+export interface MaterializedSource {
+    /** Local path of the original's bytes. */
+    sourcePath: string;
+    /** The temp directory the source lives in — free scratch space, removed when the callback ends. */
+    tempDir: string;
+}
+/**
+ * Materialize a media original into a local temp file for the duration of `fn`, then remove the
+ * whole temp directory — success or failure.
+ *
+ * File-based media engines (mediabunny, and most others) want random access to a local path, while
+ * a disk object only offers bytes/stream — so file-shaped transformers all start with this same
+ * dance. The bytes are **streamed** to disk, never buffered whole: the typical subject is a video.
+ * The file keeps the original's extension purely as a debugging nicety; engines detect the real
+ * format from content.
+ */
+export declare function withSourceFile<T>(context: TransformerContext, fn: (source: MaterializedSource) => Promise<T>): Promise<T>;
+//# sourceMappingURL=source_file.d.ts.map

package/dist/src/transformers/source_file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"source_file.d.ts","sourceRoot":"","sources":["../../../src/transformers/source_file.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAE5D,sDAAsD;AACtD,MAAM,WAAW,kBAAkB;IACjC,0CAA0C;IAC1C,UAAU,EAAE,MAAM,CAAC;IACnB,mGAAmG;IACnG,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;GASG;AACH,wBAAsB,cAAc,CAAC,CAAC,EACpC,OAAO,EAAE,kBAAkB,EAC3B,EAAE,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,OAAO,CAAC,CAAC,CAAC,GAC7C,OAAO,CAAC,CAAC,CAAC,CAYZ"}

package/dist/src/transformers/source_file.js

@@ -0,0 +1,30 @@
+import { createWriteStream } from 'node:fs';
+import { mkdtemp, rm } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import { extname, join } from 'node:path';
+import { pipeline } from 'node:stream/promises';
+/**
+ * Materialize a media original into a local temp file for the duration of `fn`, then remove the
+ * whole temp directory — success or failure.
+ *
+ * File-based media engines (mediabunny, and most others) want random access to a local path, while
+ * a disk object only offers bytes/stream — so file-shaped transformers all start with this same
+ * dance. The bytes are **streamed** to disk, never buffered whole: the typical subject is a video.
+ * The file keeps the original's extension purely as a debugging nicety; engines detect the real
+ * format from content.
+ */
+export async function withSourceFile(context, fn) {
+    const tempDir = await mkdtemp(join(tmpdir(), 'agora-media-transform-'));
+    try {
+        const extension = extname(context.record.fileName);
+        const sourcePath = join(tempDir, `source${extension || '.bin'}`);
+        await pipeline(await context.getStream(), createWriteStream(sourcePath));
+        return await fn({ sourcePath, tempDir });
+    }
+    finally {
+        await rm(tempDir, { recursive: true, force: true }).catch(() => {
+            // best-effort: temp cleanup must never mask the transform's own outcome
+        });
+    }
+}
+//# sourceMappingURL=source_file.js.map

package/dist/src/transformers/source_file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"source_file.js","sourceRoot":"","sources":["../../../src/transformers/source_file.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAWhD;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,OAA2B,EAC3B,EAA8C;IAE9C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,wBAAwB,CAAC,CAAC,CAAC;IACxE,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACnD,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,EAAE,SAAS,SAAS,IAAI,MAAM,EAAE,CAAC,CAAC;QACjE,MAAM,QAAQ,CAAC,MAAM,OAAO,CAAC,SAAS,EAAE,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC;QACzE,OAAO,MAAM,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3C,CAAC;YAAS,CAAC;QACT,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE;YAC7D,wEAAwE;QAC1E,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}

package/dist/stubs/config/media.stub

@@ -55,5 +55,17 @@ export default defineConfig({
   //     sessionTtlSeconds: 24 * 60 * 60,
   //     routes: { enabled: true, prefix: '/media/uploads/tus' },
   //   },
+  //
+  //   // Session-backed direct uploads — the browser PUTs multipart parts straight to S3 through
+  //   // presigned URLs (bytes never pass through the app), and the session (uploadId, part size,
+  //   // confirmed ETags) persists server-side so an interrupted upload resumes after a page
+  //   // reload. Needs a multipart-capable disk (disks.s3()); shares the session tables above.
+  //   direct: {
+  //     store: 'lucid',
+  //     stores: { lucid: uploadSessions.lucid() },
+  //     partSize: 20 * 1024 * 1024,
+  //     sessionTtlSeconds: 24 * 60 * 60,
+  //     routes: { enabled: true, prefix: '/media/uploads/direct/sessions', collection: 'videos' },
+  //   },
   // },
 })

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adonis-agora/media",
-  "version": "0.8.1",
-  "description": "Media-library for AdonisJS — owner collections (MIME whitelist, single-file replace, ordering), image conversions (eager/lazy), and column attachments, all on top of @adonisjs/drive. Pluggable MediaStore (in-memory + Lucid) and ImageProcessor (sharp). Part of the Agora ecosystem.",
+  "version": "0.9.0",
+  "description": "Media-library for AdonisJS — owner collections (MIME whitelist, single-file replace, ordering), image conversions (eager/lazy), pluggable content transformers (HLS video via mediabunny, metadata probe), and column attachments, all on top of @adonisjs/drive. Pluggable MediaStore (in-memory + Lucid) and ImageProcessor (sharp). Part of the Agora ecosystem.",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -86,20 +86,20 @@
     "@adonisjs/drive": "^3.0.0",
     "@adonisjs/lucid": "^22.4.0",
     "@aws-sdk/client-s3": "^3.0.0",
-    "@aws-sdk/s3-request-presigner": "^3.0.0",
+    "mediabunny": "^1.45.4",
     "sharp": "^0.33.0"
   },
   "peerDependenciesMeta": {
     "@adonis-agora/telescope": {
       "optional": true
     },
-    "@adonisjs/lucid": {
+    "mediabunny": {
       "optional": true
     },
-    "@aws-sdk/client-s3": {
+    "@adonisjs/lucid": {
       "optional": true
     },
-    "@aws-sdk/s3-request-presigner": {
+    "@aws-sdk/client-s3": {
       "optional": true
     },
     "sharp": {
@@ -112,13 +112,13 @@
     "@adonisjs/drive": "^3.0.0",
     "@adonisjs/lucid": "^22.4.0",
     "@aws-sdk/client-s3": "^3.726.1",
-    "@aws-sdk/s3-request-presigner": "^3.726.1",
     "@smithy/util-stream": "^3.3.1",
     "@types/better-sqlite3": "^7.6.0",
     "@types/node": "^20.0.0",
     "aws-sdk-client-mock": "^4.1.0",
     "better-sqlite3": "^11.0.0",
     "luxon": "^3.4.0",
+    "mediabunny": "^1.50.9",
     "sharp": "^0.33.0",
     "tempura": "0.4.1",
     "typescript": "^5.4.0",
@@ -137,6 +137,10 @@
     "uploads",
     "image",
     "conversions",
+    "transformers",
+    "video",
+    "hls",
+    "mediabunny",
     "sharp",
     "attachment",
     "agora"

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2026 Davi Carvalho
-
-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, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.