@maravilla-labs/platform 0.3.11 → 0.4.1

package/dist/transforms-KzpoYW43.d.ts

@@ -1,156 +0,0 @@
-/**
- * @fileoverview Media transforms — async ffmpeg / image / OCR jobs.
- *
- * Mirrors the Rust `platform.media.transforms` surface. All mutating
- * methods (transcode/thumbnail/resize/ocr) return a {@link JobHandle}
- * whose `outputKey` is content-addressed via {@link keyFor} and known
- * up front — clients can render placeholder UI for the derived asset
- * before the worker even starts the job.
- *
- * The runtime injects the live JS object as `platform.media.transforms`
- * (see `crates/runtime/src/ops/platform/js_bindings/platform_js.rs`).
- * The static helper {@link keyFor} is exported separately and runs
- * client-side — it must produce byte-for-byte identical output to the
- * Rust `derive_key`. The shared golden-vector fixture
- * `crates/platform/tests/derive_key_vectors.json` is consumed from both
- * the Rust integration test (`crates/platform/tests/derive_key_golden.rs`)
- * and the TS test (`packages/platform/tests/derive-key.test.ts`) to keep
- * the two in lockstep.
- */
-/** Video container targets supported by v1. */
-type VideoFormat = 'mp4' | 'webm';
-/** Image output formats supported by v1. */
-type ImageFormat = 'jpg' | 'png' | 'webp';
-/** Lifecycle state of a transform job. */
-type JobStatus = 'pending' | 'running' | 'complete' | 'failed';
-/** Options for `transforms.transcode`. */
-interface TranscodeOpts {
-    format: VideoFormat;
-    codec?: string;
-    max_width?: number;
-    max_height?: number;
-    audio_codec?: string;
-    bitrate_kbps?: number;
-}
-/** Options for `transforms.thumbnail` — extract a single video frame. */
-interface ThumbnailOpts {
-    /** Offset into the source. Accepts `"00:00:01"`, `"1s"`, or a plain number-as-string. */
-    at: string;
-    width?: number;
-    height?: number;
-    /** Defaults to `"jpg"` server-side when omitted. */
-    format?: ImageFormat;
-    quality?: number;
-}
-/** Options for `transforms.resize`. */
-interface ResizeOpts {
-    width?: number;
-    height?: number;
-    format: ImageFormat;
-    quality?: number;
-    strip_metadata?: boolean;
-}
-/** Options for `transforms.ocr`. */
-interface OcrOpts {
-    /** Tesseract language code(s). Defaults to `"eng"` server-side when omitted. */
-    lang?: string;
-}
-/** Tagged union of all transform requests — matches the Rust `TransformSpec`. */
-type TransformSpec = ({
-    kind: 'transcode';
-} & TranscodeOpts) | ({
-    kind: 'thumbnail';
-} & ThumbnailOpts) | ({
-    kind: 'resize';
-} & ResizeOpts) | ({
-    kind: 'ocr';
-} & OcrOpts);
-/** Probe output. All fields optional — ffprobe doesn't fill every one for every input. */
-interface MediaInfo {
-    duration_secs?: number;
-    width?: number;
-    height?: number;
-    video_codec?: string;
-    audio_codec?: string;
-    bitrate_bps?: number;
-    container?: string;
-}
-/** Returned by every mutating transforms method. */
-interface JobHandle {
-    id: string;
-    src_key: string;
-    output_key: string;
-    status: JobStatus;
-}
-/** Returned by `transforms.job(id)`. */
-interface JobStatusResponse {
-    id: string;
-    status: JobStatus;
-}
-interface TransformsService {
-    transcode(srcKey: string, opts: TranscodeOpts): Promise<JobHandle>;
-    thumbnail(srcKey: string, opts: ThumbnailOpts): Promise<JobHandle>;
-    resize(srcKey: string, opts: ResizeOpts): Promise<JobHandle>;
-    probe(srcKey: string): Promise<MediaInfo>;
-    ocr(srcKey: string, opts?: OcrOpts | null): Promise<JobHandle>;
-    job(id: string): Promise<JobStatusResponse>;
-}
-/**
- * Compute the canonical derived-asset key for `(srcKey, spec)`.
- *
- * Shape: `__derived/<srcHash>/<variantHash>.<ext>` where each hash is
- * the first 16 hex chars (8 bytes / 64 bits) of `SHA-256(...)`.
- *
- * **MUST** match Rust `platform::media::transforms::derive_key` byte-for-byte.
- * Cross-language golden vectors live at
- * `crates/platform/tests/derive_key_vectors.json`.
- */
-declare function keyFor(srcKey: string, spec: TransformSpec): string;
-/** Convenience namespace mirroring the Rust `transforms::keyFor` re-export. */
-declare const transforms: {
-    keyFor: typeof keyFor;
-};
-/**
- * Per-pattern transforms declaration used inside the `transforms` block of
- * `maravilla.config.ts`. Each field accepts a single opts object or an array.
- *
- * `variants` is sugar for `resize` arrays — convenient for the common
- * "image → multiple resized renditions" case.
- */
-interface TransformsPatternSpec {
-    transcode?: TranscodeOpts | TranscodeOpts[];
-    thumbnail?: ThumbnailOpts | ThumbnailOpts[];
-    resize?: ResizeOpts | ResizeOpts[];
-    /** Sugar for `resize` arrays — same shape, same semantics. */
-    variants?: ResizeOpts[];
-    ocr?: OcrOpts | OcrOpts[];
-}
-/**
- * Top-level `transforms` block. Keys are glob path patterns matched against
- * the storage key of every uploaded object. The adapter compiles each entry
- * into a synthetic `storage.put` event handler that fans out the declared
- * transforms via `Promise.all`.
- *
- * @example
- * ```ts
- * import { defineConfig } from '@maravilla-labs/platform/config';
- *
- * export default defineConfig({
- *   transforms: {
- *     'uploads/videos/**': {
- *       transcode: [{ format: 'mp4' }, { format: 'webm' }],
- *       thumbnail: { at: '1s', width: 640, format: 'jpg' },
- *     },
- *     'uploads/photos/**': {
- *       variants: [
- *         { width: 1600, format: 'webp', quality: 85 },
- *         { width: 400,  format: 'webp', quality: 80 },
- *       ],
- *     },
- *   },
- * });
- * ```
- */
-type TransformsConfig = Record<string, TransformsPatternSpec>;
-
-export { type ImageFormat as I, type JobHandle as J, type MediaInfo as M, type OcrOpts as O, type ResizeOpts as R, type TransformsConfig as T, type VideoFormat as V, type TransformsPatternSpec as a, type JobStatus as b, type JobStatusResponse as c, type ThumbnailOpts as d, type TranscodeOpts as e, type TransformSpec as f, type TransformsService as g, keyFor as k, transforms as t };