@odori/cli 0.0.3 → 0.0.5

package/dist/cli.js

@@ -2,7 +2,7 @@ import {
   checkFlags,
   parseArgs,
   run
-} from "./chunk-RXLB2CXH.js";
+} from "./chunk-RHG23EWW.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;
 };
 /**
@@ -244,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. */
@@ -271,6 +290,13 @@ type RenderOptions = {
     /** Container and codec. Defaults to H.264 in MP4. */
     format?: VideoFormat;
     skipUnchangedFrames?: boolean;
+    /**
+     * Mix the composition's cues into the file. Defaults to true, because the
+     * score is part of the video. Set false for a silent cut: a loop for a
+     * landing page, a clip going into an editor that has its own audio, or a
+     * reviewer who just wants the picture.
+     */
+    audio?: boolean;
     /** Reuse encoded chunks whose frames still look identical. */
     cache?: boolean;
     signal?: AbortSignal;
@@ -318,6 +344,7 @@ type JobRender = {
     quality?: string;
     scale?: number;
     preset?: string;
+    audio?: boolean;
 };
 type JobRecord = {
     job: ExportJob;
@@ -519,6 +546,7 @@ declare const runJob: (config: ResolvedConfig, origin: string, record: JobRecord
     quality?: Quality;
     scale?: number;
     format?: VideoFormat;
+    audio?: boolean;
     skipUnchangedFrames?: boolean;
     signal?: AbortSignal;
     onProgress?: (job: ExportJob) => void;
@@ -531,6 +559,8 @@ declare const exportCommand: (id: string, options?: {
     quality?: string;
     scale?: number;
     format?: string;
+    /** False writes the picture with no audio track. */
+    audio?: boolean;
     skipUnchangedFrames?: boolean;
     retry?: string;
 }) => Promise<ExportJob>;
@@ -568,8 +598,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>;
@@ -645,4 +685,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-RXLB2CXH.js";
+} from "./chunk-RHG23EWW.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,