@odori/cli 0.0.2 → 0.0.4

package/dist/cli.js

@@ -2,7 +2,7 @@ import {
   checkFlags,
   parseArgs,
   run
-} from "./chunk-7XJL2BYO.js";
+} from "./chunk-NYXWEZU2.js";
 export {
   checkFlags,
   parseArgs,

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { ViteDevServer } from 'vite';
 import * as odori from 'odori';
-import { VideoEntry, RenderManifest, AudioCue, ManifestAudioCue, ExportJob } from 'odori';
+import { VideoEntry, RenderManifest, AudioCue, ManifestAudioCue, ExportJob, Duration } from 'odori';
 import { Browser, Page } from 'playwright-core';
 export { parseArgs, run } from './cli.js';
 
@@ -72,6 +72,8 @@ type DiscoveredPreview = {
     relativeFile: string;
     importPath: string;
     identifier: string;
+    /** Video ids whose composition imports this component. Derived, not declared. */
+    usedBy?: string[];
 };
 type DiscoveredBrandModule = {
     name: string;
@@ -87,11 +89,25 @@ type DiscoveredAudio = {
     relativeFile: string;
     bytes: number;
 };
+/**
+ * A directory naming itself, from a `category.json` beside the components it
+ * holds. The path is what the filesystem already says; this is only how that
+ * level should read and where it should sit among its siblings.
+ */
+type DiscoveredCategory = {
+    /** Directory path under the components directory: `product-ui/forms`. */
+    path: string;
+    /** What to call it. Without one, the directory name is read as words. */
+    name?: string;
+    /** Sort position among siblings. Unset sorts after, alphabetically. */
+    order?: number;
+};
 type ProjectGraph = {
     videos: DiscoveredVideo[];
     previews: DiscoveredPreview[];
     brands: DiscoveredBrandModule[];
     audio: DiscoveredAudio[];
+    categories: DiscoveredCategory[];
     sourceHash: string;
 };
 /**
@@ -177,6 +193,16 @@ declare const freezeManifest: (video: LoadedVideo, graph: ProjectGraph, config:
  * concatenated without re-encoding. `chunked: false` says a format has to be
  * encoded in one pass, which is slower and correct.
  */
+/** Compression tiers, named for where the file is going. */
+type Quality = "studio" | "social" | "web";
+type EncodeOptions = {
+    /** x264-style speed preset. Orthogonal to quality: it trades time, not pixels. */
+    preset: string;
+    /** Compression tier. Codecs that are already lossless or mandated ignore it. */
+    quality: Quality;
+    /** Output scale multiplier. 1 is the composition's own size. */
+    scale: number;
+};
 type VideoFormat = {
     name: string;
     extension: string;
@@ -186,8 +212,8 @@ type VideoFormat = {
     chunked: boolean;
     /** Whether the container carries an audio track at all. */
     audio: boolean;
-    /** FFmpeg arguments for the video stream, given the requested preset. */
-    args: (preset: string) => string[];
+    /** FFmpeg arguments for the video stream. */
+    args: (options: EncodeOptions) => string[];
     description: string;
 };
 declare const FORMATS: Record<string, VideoFormat>;
@@ -234,7 +260,10 @@ type RenderPage = {
 declare const openRenderPage: (origin: string, target: RenderTarget, config: ResolvedConfig) => Promise<RenderPage>;
 /** Seek through the readiness handshake instead of guessing with timeouts. */
 declare const seekTo: (page: Page, frame: number) => Promise<void>;
-declare const readTimeline: (page: Page) => Promise<odori.CompiledTimeline>;
+declare const readTimeline: (page: Page) => Promise<odori.CompiledTimeline | {
+    scenes: never[];
+    durationInFrames: number;
+}>;
 declare const readAudio: (page: Page) => Promise<odori.AudioTrack>;
 declare const probeSignatures: (page: Page, frames: number[]) => Promise<string[]>;
 /** Kept for callers that only want to know an encoder exists. */
@@ -254,6 +283,10 @@ type RenderTimings = {
 type RenderOptions = {
     concurrency?: number;
     preset?: string;
+    /** Compression tier. Defaults to studio, which is what the pipeline always was. */
+    quality?: Quality;
+    /** Output scale multiplier. Defaults to 1, the composition's own size. */
+    scale?: number;
     /** Container and codec. Defaults to H.264 in MP4. */
     format?: VideoFormat;
     skipUnchangedFrames?: boolean;
@@ -298,16 +331,24 @@ type CompileResult = {
 declare const compileInBrowser: (origin: string, target: RenderTarget, config: ResolvedConfig) => Promise<CompileResult>;
 declare const withServer: <Value>(config: ResolvedConfig, handler: (server: StudioServer) => Promise<Value>) => Promise<Value>;
 
+/** How a job should be encoded, frozen with it so a retry cannot drift. */
+type JobRender = {
+    format?: string;
+    quality?: string;
+    scale?: number;
+    preset?: string;
+};
 type JobRecord = {
     job: ExportJob;
     manifest: RenderManifest;
     output: string;
+    render?: JobRender;
 };
 /**
  * An export job records the frozen manifest, progress, attempts, and result,
  * so a retry reuses the approved inputs instead of resolving them again.
  */
-declare const createJob: (config: ResolvedConfig, manifest: RenderManifest, output: string) => Promise<JobRecord>;
+declare const createJob: (config: ResolvedConfig, manifest: RenderManifest, output: string, render?: JobRender) => Promise<JobRecord>;
 declare const readJob: (config: ResolvedConfig, id: string) => Promise<JobRecord>;
 declare const updateJob: (config: ResolvedConfig, job: ExportJob) => Promise<ExportJob>;
 declare const appendJobLog: (config: ResolvedConfig, id: string, message: string) => Promise<ExportJob>;
@@ -494,6 +535,8 @@ declare const cancelJob: (id: string) => boolean;
 declare const runJob: (config: ResolvedConfig, origin: string, record: JobRecord, video: LoadedVideo, options?: {
     concurrency?: number;
     preset?: string;
+    quality?: Quality;
+    scale?: number;
     format?: VideoFormat;
     skipUnchangedFrames?: boolean;
     signal?: AbortSignal;
@@ -504,6 +547,8 @@ declare const exportCommand: (id: string, options?: {
     input?: Record<string, unknown>;
     concurrency?: number;
     preset?: string;
+    quality?: string;
+    scale?: number;
     format?: string;
     skipUnchangedFrames?: boolean;
     retry?: string;
@@ -542,8 +587,18 @@ type PlanOptions = {
 declare const planChunks: ({ durationInFrames, scenes, concurrency, maxChunkFrames, }: PlanOptions) => ChunkPlan;
 declare const chunkFrames: (chunk: FrameChunk) => number[];
 
-declare const stillCommand: (id: string, options?: {
-    frame?: number;
+/**
+ * One frame of a video, as a PNG.
+ *
+ * `at` is a duration like everything else in Odori: a bare number is seconds,
+ * and `120f` is frame 120. Which frame that resolves to depends on the
+ * video's frame rate, and the frame rate belongs to the video's layout, so
+ * the position is checked for shape first and resolved once the video is
+ * loaded. A typo still costs nothing: no discovery, no dev server, no
+ * browser.
+ */
+declare const frameCommand: (id: string, options?: {
+    at?: Duration;
     output?: string;
     input?: Record<string, unknown>;
 }) => Promise<string>;
@@ -619,4 +674,4 @@ declare const newCommand: (name: string, options?: {
 /** Add the videos source root and configuration to an existing project. */
 declare const initCommand: (root?: string) => Promise<void>;
 
-export { CHROME_BUILD, type ChunkPlan, type CompileResult, type ComponentStatus, type Context, type DeterminismFinding, type DiffLine, FORMATS, type FrameChunk, JobQueue, type JobRecord, type LoadedVideo, type MixInput, type OdoriConfig, type ProjectGraph, type RenderOptions, type RenderTarget, type RenderTimings, type ResolvedBinary, type ResolvedConfig, type StudioServer, type VideoFormat, addCommand, alphaWarning, appendJobLog, buildAudioFilter, cacheRoot, cancelJob, checkDeterminism, chunkFrames, clearPrepareCache, compileInBrowser, componentStatus, countChanges, createContext, createIntegrityResolver, createJob, defaultConcurrency, defineConfig, devCommand, diffCommand, diffLines, discoverProject, ensureFfmpeg, exportCommand, exportQueue, fileKey, findVideo, formatDiff, formatNames, freezeManifest, generateImports, initCommand, inspectCommand, installBrowser, installFfmpeg, jobsCommand, listCommand, listJobs, loadConfig, loadVideos, localCandidates, newCommand, openRenderPage, outputName, planChunks, prepareCacheKey, probeSignatures, readAudio, readJob, readPrepareCache, readTimeline, reconcileJobs, renderMovie, renderStill, renderToolchain, resolveBrowser, resolveChromePath, resolveCueFile, resolveFfmpeg, resolveFormat, runJob, runPrepare, seekTo, startStudioServer, stillCommand, targetFor, testCommand, updateCommand, updateJob, withServer, writeGenerated, writePrepareCache };
+export { CHROME_BUILD, type ChunkPlan, type CompileResult, type ComponentStatus, type Context, type DeterminismFinding, type DiffLine, FORMATS, type FrameChunk, JobQueue, type JobRecord, type LoadedVideo, type MixInput, type OdoriConfig, type ProjectGraph, type RenderOptions, type RenderTarget, type RenderTimings, type ResolvedBinary, type ResolvedConfig, type StudioServer, type VideoFormat, addCommand, alphaWarning, appendJobLog, buildAudioFilter, cacheRoot, cancelJob, checkDeterminism, chunkFrames, clearPrepareCache, compileInBrowser, componentStatus, countChanges, createContext, createIntegrityResolver, createJob, defaultConcurrency, defineConfig, devCommand, diffCommand, diffLines, discoverProject, ensureFfmpeg, exportCommand, exportQueue, fileKey, findVideo, formatDiff, formatNames, frameCommand, freezeManifest, generateImports, initCommand, inspectCommand, installBrowser, installFfmpeg, jobsCommand, listCommand, listJobs, loadConfig, loadVideos, localCandidates, newCommand, openRenderPage, outputName, planChunks, prepareCacheKey, probeSignatures, readAudio, readJob, readPrepareCache, readTimeline, reconcileJobs, renderMovie, renderStill, renderToolchain, resolveBrowser, resolveChromePath, resolveCueFile, resolveFfmpeg, resolveFormat, runJob, runPrepare, seekTo, startStudioServer, targetFor, testCommand, updateCommand, updateJob, withServer, writeGenerated, writePrepareCache };

package/dist/index.js

@@ -30,6 +30,7 @@ import {
   findVideo,
   formatDiff,
   formatNames,
+  frameCommand,
   freezeManifest,
   generateImports,
   initCommand,
@@ -67,7 +68,6 @@ import {
   runPrepare,
   seekTo,
   startStudioServer,
-  stillCommand,
   targetFor,
   testCommand,
   updateCommand,
@@ -75,7 +75,7 @@ import {
   withServer,
   writeGenerated,
   writePrepareCache
-} from "./chunk-7XJL2BYO.js";
+} from "./chunk-NYXWEZU2.js";
 export {
   CHROME_BUILD,
   FORMATS,
@@ -108,6 +108,7 @@ export {
   findVideo,
   formatDiff,
   formatNames,
+  frameCommand,
   freezeManifest,
   generateImports,
   initCommand,
@@ -145,7 +146,6 @@ export {
   runPrepare,
   seekTo,
   startStudioServer,
-  stillCommand,
   targetFor,
   testCommand,
   updateCommand,