@odori/cli 0.0.11 → 0.0.12

package/dist/cli.js

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

package/dist/index.d.ts

@@ -460,6 +460,100 @@ type DeterminismFinding = {
  */
 declare const checkDeterminism: (config: ResolvedConfig) => Promise<DeterminismFinding[]>;
 
+/**
+ * A fact about the project's shape that discovery itself cannot say.
+ *
+ * Discovery answers "what exists": it walks the tree and takes what matches.
+ * That is the right behaviour for a build — an unrecognized file must never
+ * take the project down — and exactly the wrong behaviour for an author,
+ * because everything discovery quietly steps over is a file someone wrote on
+ * purpose. The filesystem is Odori's contract: `video.tsx` is a video,
+ * `*.preview.tsx` is a fixture, a directory under components/ names a
+ * component. This module checks the places where that contract can be almost
+ * met, which is the one distance discovery cannot see.
+ *
+ * An `error` is a promise the project makes and breaks at render or play
+ * time: a sound that will be silence, an override that will never be heard.
+ * A `warn` is a file that works today and will surprise someone later.
+ */
+type StructureFinding = {
+    level: "error" | "warn";
+    /** The file an author would open to fix it, relative to the project root. */
+    file: string;
+    message: string;
+};
+/**
+ * Check the filesystem contract and report every place it is almost met.
+ *
+ * Everything here is answerable in Node from the tree and the loaded
+ * metadata: no browser, no network, no render. That is what makes it cheap
+ * enough to run inside `odori doctor` and first inside `odori test`, before
+ * a browser ever starts.
+ */
+declare const checkStructure: (config: ResolvedConfig, graph: ProjectGraph, videos: LoadedVideo[]) => Promise<StructureFinding[]>;
+
+/**
+ * The whole project as one JSON document: what the filesystem declares,
+ * compiled and answered for. `catalog.json` is what discovery alone can say
+ * about the tree; this is what the tree says once every entry has actually
+ * been loaded — durations, formats, brands, variants, who uses what — plus
+ * every place the filesystem contract is almost met.
+ *
+ * The point is inspectability without execution. An agent, a CI step, or a
+ * teammate's script should be able to ask "what is in this project and is
+ * its shape sound" by reading one file, instead of importing modules or
+ * driving a browser. The videos themselves stay the source of truth; this is
+ * the tree's own testimony, written down where anything can read it.
+ */
+type GraphArtifact = {
+    sourceHash: string;
+    generatedAt: string;
+    videos: Array<{
+        id: string;
+        title: string;
+        description?: string;
+        file: string;
+        format: {
+            width: number;
+            height: number;
+            fps: number;
+        };
+        /** 0 when the composition's scenes decide, which only a browser can total. */
+        durationInFrames: number;
+        seconds: number | null;
+        brand: string;
+        tags: string[];
+        audioVariants: string[];
+        components: string[];
+        prepare: boolean;
+    }>;
+    components: Array<{
+        name: string;
+        file: string;
+        usedBy: string[];
+    }>;
+    brands: Array<{
+        name: string;
+        file: string;
+    }>;
+    audio: Array<{
+        name: string;
+        url: string;
+        file: string;
+        bytes: number;
+    }>;
+    categories: Array<{
+        path: string;
+        name?: string;
+        order?: number;
+    }>;
+    findings: StructureFinding[];
+};
+declare const buildGraphArtifact: (root?: string) => Promise<{
+    artifact: GraphArtifact;
+    outDir: string;
+}>;
+
 /**
  * The two programs a render actually runs.
  *
@@ -737,4 +831,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, 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 };
+export { CHROME_BUILD, type ChunkPlan, type CompileResult, type ComponentStatus, type Context, type DeterminismFinding, type DiffLine, FORMATS, type FrameChunk, type GraphArtifact, JobQueue, type JobRecord, type LoadedVideo, type MixInput, type OdoriConfig, type ProjectGraph, type RenderOptions, type RenderTarget, type RenderTimings, type ResolvedBinary, type ResolvedConfig, type StructureFinding, type StudioServer, type VideoFormat, addCommand, alphaWarning, appendJobLog, buildAudioFilter, buildGraphArtifact, cacheRoot, cancelJob, checkDeterminism, checkStructure, 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

@@ -6,9 +6,11 @@ import {
   alphaWarning,
   appendJobLog,
   buildAudioFilter,
+  buildGraphArtifact,
   cacheRoot,
   cancelJob,
   checkDeterminism,
+  checkStructure,
   chunkFrames,
   clearPrepareCache,
   compileInBrowser,
@@ -75,7 +77,7 @@ import {
   withServer,
   writeGenerated,
   writePrepareCache
-} from "./chunk-77R3UC27.js";
+} from "./chunk-FS2BJU5Q.js";
 export {
   CHROME_BUILD,
   FORMATS,
@@ -84,9 +86,11 @@ export {
   alphaWarning,
   appendJobLog,
   buildAudioFilter,
+  buildGraphArtifact,
   cacheRoot,
   cancelJob,
   checkDeterminism,
+  checkStructure,
   chunkFrames,
   clearPrepareCache,
   compileInBrowser,