frameyard 0.8.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +110 -14
- package/GLOSSARY.md +112 -2
- package/README.md +302 -265
- package/dist/assets/integrations.d.ts +8 -4
- package/dist/assets/integrations.d.ts.map +1 -1
- package/dist/assets/integrations.js +8 -4
- package/dist/assets/integrations.js.map +1 -1
- package/dist/assets/provenance.d.ts +2 -2
- package/dist/assets/provenance.d.ts.map +1 -1
- package/dist/assets/provenance.js +5 -3
- package/dist/assets/provenance.js.map +1 -1
- package/dist/assets/tts-supertonic.d.ts +28 -0
- package/dist/assets/tts-supertonic.d.ts.map +1 -0
- package/dist/assets/tts-supertonic.js +156 -0
- package/dist/assets/tts-supertonic.js.map +1 -0
- package/dist/assets/tts.d.ts +18 -6
- package/dist/assets/tts.d.ts.map +1 -1
- package/dist/assets/tts.js +219 -97
- package/dist/assets/tts.js.map +1 -1
- package/dist/cli.js +1685 -93
- package/dist/cli.js.map +1 -1
- package/dist/composition/format.d.ts +1 -1
- package/dist/composition/format.d.ts.map +1 -1
- package/dist/composition/format.js +1 -1
- package/dist/composition/format.js.map +1 -1
- package/dist/context.d.ts +82 -0
- package/dist/context.d.ts.map +1 -0
- package/dist/context.js +277 -0
- package/dist/context.js.map +1 -0
- package/dist/contracts.d.ts +25 -0
- package/dist/contracts.d.ts.map +1 -1
- package/dist/contracts.js.map +1 -1
- package/dist/doctor.d.ts +14 -1
- package/dist/doctor.d.ts.map +1 -1
- package/dist/doctor.js +166 -7
- package/dist/doctor.js.map +1 -1
- package/dist/errors.d.ts +1 -1
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js.map +1 -1
- package/dist/fonts/add.d.ts +41 -0
- package/dist/fonts/add.d.ts.map +1 -0
- package/dist/fonts/add.js +259 -0
- package/dist/fonts/add.js.map +1 -0
- package/dist/fonts/binary.d.ts +4 -0
- package/dist/fonts/binary.d.ts.map +1 -0
- package/dist/fonts/binary.js +21 -0
- package/dist/fonts/binary.js.map +1 -0
- package/dist/fonts/css.d.ts +4 -0
- package/dist/fonts/css.d.ts.map +1 -0
- package/dist/fonts/css.js +50 -0
- package/dist/fonts/css.js.map +1 -0
- package/dist/fonts/fontsource.d.ts +107 -0
- package/dist/fonts/fontsource.d.ts.map +1 -0
- package/dist/fonts/fontsource.js +565 -0
- package/dist/fonts/fontsource.js.map +1 -0
- package/dist/fonts/index.d.ts +11 -0
- package/dist/fonts/index.d.ts.map +1 -0
- package/dist/fonts/index.js +11 -0
- package/dist/fonts/index.js.map +1 -0
- package/dist/fonts/install.d.ts +24 -0
- package/dist/fonts/install.d.ts.map +1 -0
- package/dist/fonts/install.js +145 -0
- package/dist/fonts/install.js.map +1 -0
- package/dist/fonts/manifest.d.ts +21 -0
- package/dist/fonts/manifest.d.ts.map +1 -0
- package/dist/fonts/manifest.js +96 -0
- package/dist/fonts/manifest.js.map +1 -0
- package/dist/fonts/options.d.ts +9 -0
- package/dist/fonts/options.d.ts.map +1 -0
- package/dist/fonts/options.js +66 -0
- package/dist/fonts/options.js.map +1 -0
- package/dist/fonts/schema.d.ts +4 -0
- package/dist/fonts/schema.d.ts.map +1 -0
- package/dist/fonts/schema.js +316 -0
- package/dist/fonts/schema.js.map +1 -0
- package/dist/fonts/summary.d.ts +16 -0
- package/dist/fonts/summary.d.ts.map +1 -0
- package/dist/fonts/summary.js +22 -0
- package/dist/fonts/summary.js.map +1 -0
- package/dist/fonts/types.d.ts +56 -0
- package/dist/fonts/types.d.ts.map +1 -0
- package/dist/fonts/types.js +8 -0
- package/dist/fonts/types.js.map +1 -0
- package/dist/fonts/verify.d.ts +33 -0
- package/dist/fonts/verify.d.ts.map +1 -0
- package/dist/fonts/verify.js +200 -0
- package/dist/fonts/verify.js.map +1 -0
- package/dist/html/validate.d.ts.map +1 -1
- package/dist/html/validate.js +59 -0
- package/dist/html/validate.js.map +1 -1
- package/dist/index.d.ts +3 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/inspect.d.ts +61 -0
- package/dist/inspect.d.ts.map +1 -0
- package/dist/inspect.js +325 -0
- package/dist/inspect.js.map +1 -0
- package/dist/lint.d.ts +63 -0
- package/dist/lint.d.ts.map +1 -0
- package/dist/lint.js +265 -0
- package/dist/lint.js.map +1 -0
- package/dist/policy.d.ts +69 -0
- package/dist/policy.d.ts.map +1 -0
- package/dist/policy.js +361 -0
- package/dist/policy.js.map +1 -0
- package/dist/preview/timeline-data.d.ts +17 -69
- package/dist/preview/timeline-data.d.ts.map +1 -1
- package/dist/preview/timeline-host.d.ts.map +1 -1
- package/dist/preview/timeline-host.js +70 -45
- package/dist/preview/timeline-host.js.map +1 -1
- package/dist/preview/timeline-main.d.ts.map +1 -1
- package/dist/preview/timeline-main.js +47 -4
- package/dist/preview/timeline-main.js.map +1 -1
- package/dist/project.d.ts +10 -3
- package/dist/project.d.ts.map +1 -1
- package/dist/project.js +20 -17
- package/dist/project.js.map +1 -1
- package/dist/renderer/ffmpeg.d.ts +42 -2
- package/dist/renderer/ffmpeg.d.ts.map +1 -1
- package/dist/renderer/ffmpeg.js +254 -22
- package/dist/renderer/ffmpeg.js.map +1 -1
- package/dist/renderer/index.js +1 -1
- package/dist/renderer/index.js.map +1 -1
- package/dist/renderer/keyframe-expressions.d.ts +39 -0
- package/dist/renderer/keyframe-expressions.d.ts.map +1 -0
- package/dist/renderer/keyframe-expressions.js +180 -0
- package/dist/renderer/keyframe-expressions.js.map +1 -0
- package/dist/renderer/timeline.d.ts +2 -0
- package/dist/renderer/timeline.d.ts.map +1 -1
- package/dist/renderer/timeline.js +89 -116
- package/dist/renderer/timeline.js.map +1 -1
- package/dist/runtime/host.d.ts.map +1 -1
- package/dist/runtime/host.js +4 -0
- package/dist/runtime/host.js.map +1 -1
- package/dist/scaffold.d.ts +3 -0
- package/dist/scaffold.d.ts.map +1 -1
- package/dist/scaffold.js +48 -320
- package/dist/scaffold.js.map +1 -1
- package/dist/server/composition-html.d.ts +2 -0
- package/dist/server/composition-html.d.ts.map +1 -1
- package/dist/server/composition-html.js +7 -0
- package/dist/server/composition-html.js.map +1 -1
- package/dist/server/server.d.ts.map +1 -1
- package/dist/server/server.js +31 -1
- package/dist/server/server.js.map +1 -1
- package/dist/server/timeline-preview-data.d.ts.map +1 -1
- package/dist/server/timeline-preview-data.js +12 -34
- package/dist/server/timeline-preview-data.js.map +1 -1
- package/dist/server/timeline-preview-html.d.ts.map +1 -1
- package/dist/server/timeline-preview-html.js +18 -2
- package/dist/server/timeline-preview-html.js.map +1 -1
- package/dist/templates.d.ts +16 -0
- package/dist/templates.d.ts.map +1 -0
- package/dist/templates.js +186 -0
- package/dist/templates.js.map +1 -0
- package/dist/timeline/easing.d.ts +36 -0
- package/dist/timeline/easing.d.ts.map +1 -0
- package/dist/timeline/easing.js +225 -0
- package/dist/timeline/easing.js.map +1 -0
- package/dist/timeline/keyframes.d.ts +23 -0
- package/dist/timeline/keyframes.d.ts.map +1 -0
- package/dist/timeline/keyframes.js +95 -0
- package/dist/timeline/keyframes.js.map +1 -0
- package/dist/timeline/plan.d.ts +6 -12
- package/dist/timeline/plan.d.ts.map +1 -1
- package/dist/timeline/plan.js +17 -30
- package/dist/timeline/plan.js.map +1 -1
- package/dist/timeline/resolve.d.ts +12 -0
- package/dist/timeline/resolve.d.ts.map +1 -1
- package/dist/timeline/resolve.js +105 -9
- package/dist/timeline/resolve.js.map +1 -1
- package/dist/timeline/scene.d.ts +126 -0
- package/dist/timeline/scene.d.ts.map +1 -0
- package/dist/timeline/scene.js +109 -0
- package/dist/timeline/scene.js.map +1 -0
- package/dist/timeline/schema.d.ts +31 -0
- package/dist/timeline/schema.d.ts.map +1 -1
- package/dist/timeline/schema.js +240 -9
- package/dist/timeline/schema.js.map +1 -1
- package/dist/timeline/transitions.d.ts +21 -0
- package/dist/timeline/transitions.d.ts.map +1 -0
- package/dist/timeline/transitions.js +23 -0
- package/dist/timeline/transitions.js.map +1 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/docs/adr/0007-make-html-documents-the-composition-unit.md +1 -1
- package/docs/adr/0010-make-timelines-the-render-unit.md +3 -2
- package/docs/adr/0014-compose-timeline-clips-with-css-blend-modes.md +2 -1
- package/docs/adr/0015-inherit-composition-format-from-the-project.md +2 -2
- package/docs/adr/0016-author-compositions-as-html-fragments.md +1 -1
- package/docs/adr/0018-animate-timeline-clips-with-keyframes.md +35 -0
- package/docs/adr/0019-make-same-track-overlap-the-transition-window.md +36 -0
- package/docs/adr/0020-crossfade-audio-clips-on-audio-tracks.md +27 -0
- package/docs/adr/0021-project-timeline-scenes-once.md +32 -0
- package/docs/adr/0022-gate-heavy-operations-with-a-workspace-resource-policy.md +35 -0
- package/docs/adr/0023-pin-fonts-as-project-assets.md +98 -0
- package/docs/migration-0.4.md +2 -2
- package/docs/preview-testing.md +19 -6
- package/docs/{v0.1-design.md → v0.x-design.md} +55 -30
- package/examples/blend/README.md +3 -3
- package/examples/demo/README.md +2 -2
- package/examples/intro/README.md +71 -0
- package/examples/intro/assets/fonts/figtree/LICENSE.txt +93 -0
- package/examples/intro/assets/fonts/figtree/figtree-latin-wght-normal.woff2 +0 -0
- package/examples/intro/assets/fonts/instrument-serif/LICENSE.txt +93 -0
- package/examples/intro/assets/fonts/instrument-serif/instrument-serif-latin-400-italic.woff2 +0 -0
- package/examples/intro/assets/fonts/space-mono/LICENSE.txt +93 -0
- package/examples/intro/assets/fonts/space-mono/space-mono-latin-400-normal.woff2 +0 -0
- package/examples/intro/assets/fonts/space-mono/space-mono-latin-700-normal.woff2 +0 -0
- package/examples/intro/assets/grain.png +0 -0
- package/examples/intro/assets/score.ogg +0 -0
- package/examples/intro/compositions/brand.html +412 -0
- package/examples/intro/compositions/chrome.controller.js +63 -0
- package/examples/intro/compositions/chrome.html +256 -0
- package/examples/intro/compositions/lattice.controller.js +148 -0
- package/examples/intro/compositions/lattice.html +308 -0
- package/examples/intro/compositions/opening.html +504 -0
- package/examples/intro/compositions/studio.html +930 -0
- package/examples/intro/compositions/theme.css +218 -0
- package/examples/intro/fy.config.js +13 -0
- package/examples/intro/fy.fonts.json +100 -0
- package/examples/intro/scripts/make-grain.mjs +79 -0
- package/examples/intro/scripts/make-score.mjs +702 -0
- package/examples/intro/timelines/intro.timeline.json +60 -0
- package/examples/keyframes/README.md +76 -0
- package/examples/keyframes/compositions/backdrop.html +60 -0
- package/examples/keyframes/compositions/card.html +99 -0
- package/examples/keyframes/fy.config.js +10 -0
- package/examples/keyframes/timelines/keyframes.timeline.json +60 -0
- package/examples/nested/README.md +112 -0
- package/examples/nested/assets/pulse.wav +0 -0
- package/examples/nested/compositions/backdrop.html +84 -0
- package/examples/nested/compositions/card.html +275 -0
- package/examples/nested/compositions/overlay.html +307 -0
- package/examples/nested/fy.config.js +13 -0
- package/examples/nested/scripts/make-pulse.sh +20 -0
- package/examples/nested/timelines/chapter-a.timeline.json +39 -0
- package/examples/nested/timelines/chapter-b.timeline.json +39 -0
- package/examples/nested/timelines/nested-reel.timeline.json +52 -0
- package/examples/static/README.md +2 -2
- package/examples/transitions/README.md +128 -0
- package/examples/transitions/assets/alpha.wav +0 -0
- package/examples/transitions/assets/beta.wav +0 -0
- package/examples/transitions/assets/gamma.wav +0 -0
- package/examples/transitions/compositions/alpha.html +56 -0
- package/examples/transitions/compositions/beta.html +56 -0
- package/examples/transitions/compositions/gamma.html +56 -0
- package/examples/transitions/fy.config.js +12 -0
- package/examples/transitions/timelines/audio-crossfade.timeline.json +44 -0
- package/examples/transitions/timelines/transitions.timeline.json +31 -0
- package/examples/video/README.md +4 -4
- package/examples/webgl/README.md +1 -1
- package/package.json +12 -5
- package/scaffolds/init/AGENTS.md +131 -0
- package/scaffolds/init/README.md +56 -0
- package/scaffolds/init/compositions/hello.html +79 -0
- package/scaffolds/init/fy.config.js +9 -0
- package/scaffolds/init/gitignore.template +1 -0
- package/scaffolds/init/package.json +11 -0
- package/scaffolds/init/props/hello.json +4 -0
- package/scaffolds/init/props/main.json +6 -0
- package/scaffolds/init/timelines/main.timeline.json +20 -0
- package/scaffolds/local-models/LOCAL-MODELS.md +77 -0
- package/scaffolds/local-models/fy.policy.json +5 -0
- package/scaffolds/local-models/opencode/opencode.jsonc +17 -0
- package/scaffolds/local-models/pi/APPEND_SYSTEM.md +21 -0
- package/scaffolds/local-models/pi/sandbox.json +15 -0
- package/scaffolds/local-models/pi/settings.json +15 -0
- package/skills/frameyard/README.md +1 -0
- package/skills/frameyard/SKILL.md +59 -61
- package/skills/frameyard/references/audio-assets.md +32 -3
- package/skills/frameyard/references/common-mistakes.md +53 -2
- package/skills/frameyard/references/deterministic-authoring.md +10 -3
- package/skills/frameyard/references/diagnostics.md +31 -1
- package/skills/frameyard/references/failure-recovery.md +32 -6
- package/skills/frameyard/references/fonts.md +132 -0
- package/skills/frameyard/references/json-results.md +119 -6
- package/skills/frameyard/references/quick-reference.md +222 -0
- package/skills/frameyard/references/timelines.md +97 -7
- /package/examples/blend/{video.config.js → fy.config.js} +0 -0
- /package/examples/demo/{video.config.js → fy.config.js} +0 -0
- /package/examples/static/{video.config.js → fy.config.js} +0 -0
- /package/examples/video/{video.config.js → fy.config.js} +0 -0
- /package/examples/webgl/{video.config.js → fy.config.js} +0 -0
package/dist/lint.js
ADDED
|
@@ -0,0 +1,265 @@
|
|
|
1
|
+
import { readFile } from "node:fs/promises";
|
|
2
|
+
import path from "node:path";
|
|
3
|
+
import { COMPOSITION_FORMAT_UNRESOLVED_MESSAGE } from "./composition/index.js";
|
|
4
|
+
import { FrameyardError, errorMessage, isFrameyardError } from "./errors.js";
|
|
5
|
+
import { validateHtmlComposition } from "./html/validate.js";
|
|
6
|
+
import { evaluateKeyframeTrack } from "./timeline/keyframes.js";
|
|
7
|
+
import { planTimelineRender } from "./timeline/plan.js";
|
|
8
|
+
import { resolveProjectTimeline } from "./timeline/resolve.js";
|
|
9
|
+
import { projectSceneAtFrame } from "./timeline/scene.js";
|
|
10
|
+
import { KEYFRAME_CHANNELS } from "./timeline/schema.js";
|
|
11
|
+
const DETERMINISM_PATTERNS = [
|
|
12
|
+
{ pattern: /\bMath\.random\s*\(/, label: "Math.random()" },
|
|
13
|
+
{ pattern: /\bDate\.now\s*\(/, label: "Date.now()" },
|
|
14
|
+
{ pattern: /\bnew\s+Date\s*\(\s*\)/, label: "new Date()" },
|
|
15
|
+
{ pattern: /\bperformance\.now\s*\(/, label: "performance.now()" },
|
|
16
|
+
{ pattern: /\bsetTimeout\s*\(/, label: "setTimeout()" },
|
|
17
|
+
{ pattern: /\bsetInterval\s*\(/, label: "setInterval()" },
|
|
18
|
+
{ pattern: /\brequestAnimationFrame\s*\(/, label: "requestAnimationFrame()" },
|
|
19
|
+
];
|
|
20
|
+
function throwIfAborted(signal) {
|
|
21
|
+
if (signal?.aborted) {
|
|
22
|
+
throw new FrameyardError("CANCELLED", "Operation cancelled.");
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
function diagnosticKey(diagnostic) {
|
|
26
|
+
return JSON.stringify([diagnostic.severity, diagnostic.code, diagnostic.message, diagnostic.details ?? null]);
|
|
27
|
+
}
|
|
28
|
+
function addDiagnostic(diagnostics, diagnostic) {
|
|
29
|
+
const key = diagnosticKey(diagnostic);
|
|
30
|
+
if (!diagnostics.some((existing) => diagnosticKey(existing) === key)) {
|
|
31
|
+
diagnostics.push(diagnostic);
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
function lineColumnAt(source, index) {
|
|
35
|
+
const before = source.slice(0, index);
|
|
36
|
+
const lines = before.split("\n");
|
|
37
|
+
return {
|
|
38
|
+
line: lines.length,
|
|
39
|
+
column: (lines[lines.length - 1]?.length ?? 0) + 1,
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
function publicController(controller) {
|
|
43
|
+
if (controller === null) {
|
|
44
|
+
return null;
|
|
45
|
+
}
|
|
46
|
+
if (controller.kind === "external") {
|
|
47
|
+
return {
|
|
48
|
+
kind: "external",
|
|
49
|
+
...(controller.src !== undefined ? { src: controller.src } : {}),
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
return { kind: "inline" };
|
|
53
|
+
}
|
|
54
|
+
async function scanController(controller, entry, projectRoot) {
|
|
55
|
+
if (controller === null) {
|
|
56
|
+
return [];
|
|
57
|
+
}
|
|
58
|
+
let source;
|
|
59
|
+
let sourcePath;
|
|
60
|
+
if (controller.kind === "inline") {
|
|
61
|
+
source = controller.source;
|
|
62
|
+
sourcePath = entry;
|
|
63
|
+
}
|
|
64
|
+
else if (controller.src !== undefined) {
|
|
65
|
+
sourcePath = controller.src;
|
|
66
|
+
try {
|
|
67
|
+
source = await readFile(path.resolve(projectRoot, controller.src), "utf8");
|
|
68
|
+
}
|
|
69
|
+
catch {
|
|
70
|
+
return [];
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
if (source === undefined) {
|
|
74
|
+
return [];
|
|
75
|
+
}
|
|
76
|
+
const diagnostics = [];
|
|
77
|
+
for (const { pattern, label } of DETERMINISM_PATTERNS) {
|
|
78
|
+
const index = source.search(pattern);
|
|
79
|
+
if (index === -1) {
|
|
80
|
+
continue;
|
|
81
|
+
}
|
|
82
|
+
const position = lineColumnAt(source, index);
|
|
83
|
+
const line = controller.kind === "inline" ? (controller.line ?? 1) + position.line - 1 : position.line;
|
|
84
|
+
const column = controller.kind === "inline" && position.line === 1
|
|
85
|
+
? (controller.column ?? 1) + position.column - 1
|
|
86
|
+
: position.column;
|
|
87
|
+
diagnostics.push({
|
|
88
|
+
severity: "warning",
|
|
89
|
+
code: "DETERMINISM_WARNING",
|
|
90
|
+
message: `Controller source uses ${label}; derive animation from frame and props instead.`,
|
|
91
|
+
details: {
|
|
92
|
+
...(sourcePath !== undefined ? { path: sourcePath } : {}),
|
|
93
|
+
line,
|
|
94
|
+
column,
|
|
95
|
+
controller: { kind: controller.kind },
|
|
96
|
+
suggestion: 'Use frame/props or random("stable:key") from frameyard/runtime.',
|
|
97
|
+
},
|
|
98
|
+
});
|
|
99
|
+
}
|
|
100
|
+
return diagnostics;
|
|
101
|
+
}
|
|
102
|
+
function collectCompositionSources(timeline, sources) {
|
|
103
|
+
for (const clip of timeline.clips) {
|
|
104
|
+
if (clip.source.kind === "composition") {
|
|
105
|
+
sources.push(clip.source);
|
|
106
|
+
}
|
|
107
|
+
else if (clip.source.kind === "timeline") {
|
|
108
|
+
collectCompositionSources(clip.source.timeline, sources);
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
function controllerKey(source) {
|
|
113
|
+
const controller = source.controller;
|
|
114
|
+
return [source.entry, controller?.kind ?? "none", controller?.src ?? "", controller?.source ?? ""].join("\u0000");
|
|
115
|
+
}
|
|
116
|
+
/**
|
|
117
|
+
* Validates a resolved timeline and projects every frame without launching
|
|
118
|
+
* Chromium. This catches scene and keyframe channel errors before `check`.
|
|
119
|
+
*/
|
|
120
|
+
export async function lintResolvedTimeline(options) {
|
|
121
|
+
const startedAt = performance.now();
|
|
122
|
+
const { timeline } = options;
|
|
123
|
+
const diagnostics = [...options.diagnostics];
|
|
124
|
+
const sources = [];
|
|
125
|
+
collectCompositionSources(timeline, sources);
|
|
126
|
+
const scanned = new Set();
|
|
127
|
+
for (const source of sources) {
|
|
128
|
+
const key = controllerKey(source);
|
|
129
|
+
if (scanned.has(key)) {
|
|
130
|
+
continue;
|
|
131
|
+
}
|
|
132
|
+
scanned.add(key);
|
|
133
|
+
for (const diagnostic of await scanController(source.controller, source.entry, options.projectRoot)) {
|
|
134
|
+
addDiagnostic(diagnostics, diagnostic);
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
for (let frame = 0; frame < timeline.durationInFrames; frame += 1) {
|
|
138
|
+
throwIfAborted(options.signal);
|
|
139
|
+
let scene;
|
|
140
|
+
try {
|
|
141
|
+
scene = projectSceneAtFrame(timeline, frame);
|
|
142
|
+
}
|
|
143
|
+
catch (error) {
|
|
144
|
+
addDiagnostic(diagnostics, {
|
|
145
|
+
severity: "error",
|
|
146
|
+
code: isFrameyardError(error) ? error.code : "TIMELINE_CLIP_INVALID",
|
|
147
|
+
message: `Timeline frame ${frame}: ${errorMessage(error)}`,
|
|
148
|
+
details: { timeline: timeline.id, timelineFrame: frame },
|
|
149
|
+
});
|
|
150
|
+
continue;
|
|
151
|
+
}
|
|
152
|
+
for (const layer of scene.layers) {
|
|
153
|
+
if (layer.keyframes === undefined) {
|
|
154
|
+
continue;
|
|
155
|
+
}
|
|
156
|
+
const localFrame = frame - layer.clip.start;
|
|
157
|
+
for (const channel of KEYFRAME_CHANNELS) {
|
|
158
|
+
const track = layer.keyframes[channel];
|
|
159
|
+
if (track === undefined) {
|
|
160
|
+
continue;
|
|
161
|
+
}
|
|
162
|
+
try {
|
|
163
|
+
evaluateKeyframeTrack(track, localFrame);
|
|
164
|
+
}
|
|
165
|
+
catch (error) {
|
|
166
|
+
addDiagnostic(diagnostics, {
|
|
167
|
+
severity: "error",
|
|
168
|
+
code: isFrameyardError(error) ? error.code : "TIMELINE_CLIP_INVALID",
|
|
169
|
+
message: `Timeline frame ${frame}, clip "${layer.clip.id}" channel ${channel}: ${errorMessage(error)}`,
|
|
170
|
+
details: {
|
|
171
|
+
timeline: timeline.id,
|
|
172
|
+
clip: layer.clip.id,
|
|
173
|
+
channel,
|
|
174
|
+
timelineFrame: frame,
|
|
175
|
+
frame: localFrame,
|
|
176
|
+
},
|
|
177
|
+
});
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
const plan = planTimelineRender(timeline);
|
|
183
|
+
return {
|
|
184
|
+
kind: "timeline",
|
|
185
|
+
timeline: timeline.id,
|
|
186
|
+
entry: timeline.entry,
|
|
187
|
+
format: timeline.format,
|
|
188
|
+
durationInFrames: timeline.durationInFrames,
|
|
189
|
+
framesProjected: timeline.durationInFrames,
|
|
190
|
+
tracks: timeline.tracks.length,
|
|
191
|
+
clips: timeline.clips.length,
|
|
192
|
+
transitions: timeline.transitions.length,
|
|
193
|
+
segments: plan.segments.length,
|
|
194
|
+
diagnostics,
|
|
195
|
+
elapsedMs: performance.now() - startedAt,
|
|
196
|
+
};
|
|
197
|
+
}
|
|
198
|
+
/** Validates one composition document and its controller source without Chromium. */
|
|
199
|
+
export async function lintComposition(options) {
|
|
200
|
+
throwIfAborted(options.signal);
|
|
201
|
+
const startedAt = performance.now();
|
|
202
|
+
const composition = options.project.compositions.get(options.compositionId);
|
|
203
|
+
if (!composition) {
|
|
204
|
+
const available = [...options.project.compositions.keys()].join(", ") || "(none)";
|
|
205
|
+
throw new FrameyardError("COMPOSITION_NOT_FOUND", `Composition "${options.compositionId}" is not listed in fy.config.js. Available: ${available}.`);
|
|
206
|
+
}
|
|
207
|
+
const validation = await validateHtmlComposition({
|
|
208
|
+
projectRoot: options.project.root,
|
|
209
|
+
entry: composition.entry,
|
|
210
|
+
props: options.props,
|
|
211
|
+
...(options.project.format ? { format: options.project.format } : {}),
|
|
212
|
+
});
|
|
213
|
+
const errors = validation.diagnostics.filter((diagnostic) => diagnostic.severity === "error");
|
|
214
|
+
if (!validation.info || errors.length > 0) {
|
|
215
|
+
const first = errors[0];
|
|
216
|
+
if (!first && validation.formatUnresolved) {
|
|
217
|
+
throw new FrameyardError("COMPOSITION_FORMAT_UNRESOLVED", `Composition "${options.compositionId}": ${COMPOSITION_FORMAT_UNRESOLVED_MESSAGE}`, { diagnostics: validation.diagnostics });
|
|
218
|
+
}
|
|
219
|
+
throw new FrameyardError(first?.code ?? "COMPOSITION_INVALID", `Composition "${options.compositionId}": ${first?.message ?? "static validation failed."}`, { diagnostics: validation.diagnostics });
|
|
220
|
+
}
|
|
221
|
+
const diagnostics = [...validation.diagnostics];
|
|
222
|
+
for (const diagnostic of await scanController(validation.info.controller, composition.entry, options.project.root)) {
|
|
223
|
+
addDiagnostic(diagnostics, diagnostic);
|
|
224
|
+
}
|
|
225
|
+
return {
|
|
226
|
+
kind: "composition",
|
|
227
|
+
composition: options.compositionId,
|
|
228
|
+
entry: composition.entry,
|
|
229
|
+
controller: publicController(validation.info.controller),
|
|
230
|
+
metadata: validation.info.metadata,
|
|
231
|
+
framesProjected: 0,
|
|
232
|
+
diagnostics,
|
|
233
|
+
elapsedMs: performance.now() - startedAt,
|
|
234
|
+
};
|
|
235
|
+
}
|
|
236
|
+
/** Validates a project timeline without capturing frames or launching Chromium. */
|
|
237
|
+
export async function lintTimeline(options) {
|
|
238
|
+
throwIfAborted(options.signal);
|
|
239
|
+
const projectTimeline = options.project.timelines.get(options.timelineId);
|
|
240
|
+
if (!projectTimeline) {
|
|
241
|
+
throw new FrameyardError("TIMELINE_NOT_FOUND", `Timeline "${options.timelineId}" is not listed in fy.config.js.`);
|
|
242
|
+
}
|
|
243
|
+
const resolved = await resolveProjectTimeline({
|
|
244
|
+
project: options.project,
|
|
245
|
+
timeline: projectTimeline,
|
|
246
|
+
...(options.signal ? { signal: options.signal } : {}),
|
|
247
|
+
...(options.propsOverrides ? { propsOverrides: options.propsOverrides } : {}),
|
|
248
|
+
});
|
|
249
|
+
const firstError = resolved.diagnostics.find((diagnostic) => diagnostic.severity === "error");
|
|
250
|
+
if (!resolved.timeline || firstError) {
|
|
251
|
+
throw new FrameyardError(firstError?.code ?? "TIMELINE_INVALID", firstError?.message ?? "Timeline resolution failed.", { diagnostics: resolved.diagnostics });
|
|
252
|
+
}
|
|
253
|
+
const result = await lintResolvedTimeline({
|
|
254
|
+
timeline: resolved.timeline,
|
|
255
|
+
projectRoot: options.project.root,
|
|
256
|
+
diagnostics: resolved.diagnostics,
|
|
257
|
+
...(options.signal ? { signal: options.signal } : {}),
|
|
258
|
+
});
|
|
259
|
+
const lintError = result.diagnostics.find((diagnostic) => diagnostic.severity === "error");
|
|
260
|
+
if (lintError) {
|
|
261
|
+
throw new FrameyardError(lintError.code, lintError.message, { diagnostics: result.diagnostics });
|
|
262
|
+
}
|
|
263
|
+
return result;
|
|
264
|
+
}
|
|
265
|
+
//# sourceMappingURL=lint.js.map
|
package/dist/lint.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"lint.js","sourceRoot":"","sources":["../src/lint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,qCAAqC,EAAE,MAAM,wBAAwB,CAAC;AAE/E,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC7E,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAE7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,sBAAsB,EAAyD,MAAM,uBAAuB,CAAC;AACtH,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AA+BzD,MAAM,oBAAoB,GAAsD;IAC9E,EAAE,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,eAAe,EAAE;IAC1D,EAAE,OAAO,EAAE,kBAAkB,EAAE,KAAK,EAAE,YAAY,EAAE;IACpD,EAAE,OAAO,EAAE,wBAAwB,EAAE,KAAK,EAAE,YAAY,EAAE;IAC1D,EAAE,OAAO,EAAE,yBAAyB,EAAE,KAAK,EAAE,mBAAmB,EAAE;IAClE,EAAE,OAAO,EAAE,mBAAmB,EAAE,KAAK,EAAE,cAAc,EAAE;IACvD,EAAE,OAAO,EAAE,oBAAoB,EAAE,KAAK,EAAE,eAAe,EAAE;IACzD,EAAE,OAAO,EAAE,8BAA8B,EAAE,KAAK,EAAE,yBAAyB,EAAE;CAC9E,CAAC;AAEF,SAAS,cAAc,CAAC,MAA+B;IACrD,IAAI,MAAM,EAAE,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,cAAc,CAAC,WAAW,EAAE,sBAAsB,CAAC,CAAC;IAChE,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,UAAiC;IACtD,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC;AAChH,CAAC;AAED,SAAS,aAAa,CAAC,WAAoC,EAAE,UAAiC;IAC5F,MAAM,GAAG,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC;IACtC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC;QACrE,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC/B,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,MAAc,EAAE,KAAa;IACjD,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACtC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACjC,OAAO;QACL,IAAI,EAAE,KAAK,CAAC,MAAM;QAClB,MAAM,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC;KACnD,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,UAAwC;IAChE,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,UAAU,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QACnC,OAAO;YACL,IAAI,EAAE,UAAU;YAChB,GAAG,CAAC,UAAU,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACjE,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;AAC5B,CAAC;AAED,KAAK,UAAU,cAAc,CAC3B,UAAwC,EACxC,KAAa,EACb,WAAmB;IAEnB,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,MAA0B,CAAC;IAC/B,IAAI,UAA8B,CAAC;IACnC,IAAI,UAAU,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACjC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;QAC3B,UAAU,GAAG,KAAK,CAAC;IACrB,CAAC;SAAM,IAAI,UAAU,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;QACxC,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC;QAC5B,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;QAC7E,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;IAED,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,WAAW,GAA4B,EAAE,CAAC;IAChD,KAAK,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,oBAAoB,EAAE,CAAC;QACtD,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACrC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,SAAS;QACX,CAAC;QACD,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC7C,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;QACvG,MAAM,MAAM,GACV,UAAU,CAAC,IAAI,KAAK,QAAQ,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC;YACjD,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC;YAChD,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;QACtB,WAAW,CAAC,IAAI,CAAC;YACf,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,qBAAqB;YAC3B,OAAO,EAAE,0BAA0B,KAAK,kDAAkD;YAC1F,OAAO,EAAE;gBACP,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACzD,IAAI;gBACJ,MAAM;gBACN,UAAU,EAAE,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE;gBACrC,UAAU,EAAE,iEAAiE;aAC9E;SACF,CAAC,CAAC;IACL,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,yBAAyB,CAAC,QAA0B,EAAE,OAAoC;IACjG,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;QAClC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;YACvC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC3C,yBAAyB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,MAAiC;IACtD,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;IACrC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,IAAI,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,EAAE,UAAU,EAAE,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACpH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,OAK1C;IACC,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IACpC,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;IAC7B,MAAM,WAAW,GAA4B,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEtE,MAAM,OAAO,GAAgC,EAAE,CAAC;IAChD,yBAAyB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7C,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;QAClC,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACrB,SAAS;QACX,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjB,KAAK,MAAM,UAAU,IAAI,MAAM,cAAc,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YACpG,aAAa,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAED,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,gBAAgB,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAClE,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC/B,IAAI,KAAK,CAAC;QACV,IAAI,CAAC;YACH,KAAK,GAAG,mBAAmB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,aAAa,CAAC,WAAW,EAAE;gBACzB,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,uBAAuB;gBACpE,OAAO,EAAE,kBAAkB,KAAK,KAAK,YAAY,CAAC,KAAK,CAAC,EAAE;gBAC1D,OAAO,EAAE,EAAE,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE,aAAa,EAAE,KAAK,EAAE;aACzD,CAAC,CAAC;YACH,SAAS;QACX,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjC,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;gBAClC,SAAS;YACX,CAAC;YACD,MAAM,UAAU,GAAG,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;YAC5C,KAAK,MAAM,OAAO,IAAI,iBAAiB,EAAE,CAAC;gBACxC,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;gBACvC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACxB,SAAS;gBACX,CAAC;gBACD,IAAI,CAAC;oBACH,qBAAqB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;gBAC3C,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,aAAa,CAAC,WAAW,EAAE;wBACzB,QAAQ,EAAE,OAAO;wBACjB,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,uBAAuB;wBACpE,OAAO,EAAE,kBAAkB,KAAK,WAAW,KAAK,CAAC,IAAI,CAAC,EAAE,aAAa,OAAO,KAAK,YAAY,CAAC,KAAK,CAAC,EAAE;wBACtG,OAAO,EAAE;4BACP,QAAQ,EAAE,QAAQ,CAAC,EAAE;4BACrB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE;4BACnB,OAAO;4BACP,aAAa,EAAE,KAAK;4BACpB,KAAK,EAAE,UAAU;yBAClB;qBACF,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,IAAI,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAE1C,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,QAAQ,CAAC,EAAE;QACrB,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB;QAC3C,eAAe,EAAE,QAAQ,CAAC,gBAAgB;QAC1C,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM;QAC9B,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM;QAC5B,WAAW,EAAE,QAAQ,CAAC,WAAW,CAAC,MAAM;QACxC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;QAC9B,WAAW;QACX,SAAS,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;KACzC,CAAC;AACJ,CAAC;AAED,qFAAqF;AACrF,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAKrC;IACC,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/B,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IACpC,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAC5E,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,SAAS,GAAG,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC;QAClF,MAAM,IAAI,cAAc,CACtB,uBAAuB,EACvB,gBAAgB,OAAO,CAAC,aAAa,+CAA+C,SAAS,GAAG,CACjG,CAAC;IACJ,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,uBAAuB,CAAC;QAC/C,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI;QACjC,KAAK,EAAE,WAAW,CAAC,KAAK;QACxB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACtE,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC;IAC9F,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACxB,IAAI,CAAC,KAAK,IAAI,UAAU,CAAC,gBAAgB,EAAE,CAAC;YAC1C,MAAM,IAAI,cAAc,CACtB,+BAA+B,EAC/B,gBAAgB,OAAO,CAAC,aAAa,MAAM,qCAAqC,EAAE,EAClF,EAAE,WAAW,EAAE,UAAU,CAAC,WAAW,EAAE,CACxC,CAAC;QACJ,CAAC;QACD,MAAM,IAAI,cAAc,CACtB,KAAK,EAAE,IAAI,IAAI,qBAAqB,EACpC,gBAAgB,OAAO,CAAC,aAAa,MAAM,KAAK,EAAE,OAAO,IAAI,2BAA2B,EAAE,EAC1F,EAAE,WAAW,EAAE,UAAU,CAAC,WAAW,EAAE,CACxC,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,CAAC,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;IAChD,KAAK,MAAM,UAAU,IAAI,MAAM,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACnH,aAAa,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACzC,CAAC;IAED,OAAO;QACL,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,OAAO,CAAC,aAAa;QAClC,KAAK,EAAE,WAAW,CAAC,KAAK;QACxB,UAAU,EAAE,gBAAgB,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC;QACxD,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,QAAQ;QAClC,eAAe,EAAE,CAAC;QAClB,WAAW;QACX,SAAS,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;KACzC,CAAC;AACJ,CAAC;AAED,mFAAmF;AACnF,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAKlC;IACC,cAAc,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/B,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC1E,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,IAAI,cAAc,CAAC,oBAAoB,EAAE,aAAa,OAAO,CAAC,UAAU,kCAAkC,CAAC,CAAC;IACpH,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,sBAAsB,CAAC;QAC5C,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,QAAQ,EAAE,eAAe;QACzB,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrD,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC9E,CAAC,CAAC;IACH,MAAM,UAAU,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC;IAC9F,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,UAAU,EAAE,CAAC;QACrC,MAAM,IAAI,cAAc,CACtB,UAAU,EAAE,IAAI,IAAI,kBAAkB,EACtC,UAAU,EAAE,OAAO,IAAI,6BAA6B,EACpD,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,CACtC,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC;QACxC,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI;QACjC,WAAW,EAAE,QAAQ,CAAC,WAAW;QACjC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACtD,CAAC,CAAC;IACH,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC;IAC3F,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,IAAI,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;IACnG,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
|
package/dist/policy.d.ts
ADDED
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
/** Project-local resource policy file discovered from the working directory upward. */
|
|
2
|
+
export declare const POLICY_FILE_NAME = "fy.policy.json";
|
|
3
|
+
export declare const POLICY_TIERS: readonly ["light", "authoring", "full"];
|
|
4
|
+
export type PolicyTier = (typeof POLICY_TIERS)[number];
|
|
5
|
+
export declare const RESOURCE_PROFILES: readonly ["shared-cpu"];
|
|
6
|
+
export type ResourceProfile = (typeof RESOURCE_PROFILES)[number];
|
|
7
|
+
export declare const MAX_STILL_FRAMES = 32;
|
|
8
|
+
export declare const SHARED_CPU_MAX_WORKERS = 2;
|
|
9
|
+
export declare const SHARED_CPU_MAX_CONCURRENCY = 1;
|
|
10
|
+
export declare const TIER_DEFAULTS: Record<PolicyTier, {
|
|
11
|
+
maxStillFrames: number;
|
|
12
|
+
allowOverwrite: boolean;
|
|
13
|
+
}>;
|
|
14
|
+
export type PolicyOperation = "lint" | "context" | "doctor" | "init" | "dev" | "check" | "still" | "font" | "tts" | "transcribe" | "render";
|
|
15
|
+
export interface LoadedResourcePolicy {
|
|
16
|
+
tier: PolicyTier;
|
|
17
|
+
profile?: ResourceProfile;
|
|
18
|
+
maxStillFrames: number;
|
|
19
|
+
allowOverwrite: boolean;
|
|
20
|
+
source: "default" | "file" | "env";
|
|
21
|
+
/** Absolute path of the policy file when `source` is `"file"`. */
|
|
22
|
+
path?: string;
|
|
23
|
+
}
|
|
24
|
+
export interface PolicyDescription {
|
|
25
|
+
policy: PolicyTier;
|
|
26
|
+
profile?: ResourceProfile;
|
|
27
|
+
maxStillFrames: number;
|
|
28
|
+
allowOverwrite: boolean;
|
|
29
|
+
source: LoadedResourcePolicy["source"];
|
|
30
|
+
path?: string;
|
|
31
|
+
}
|
|
32
|
+
/** Walks up from a directory until it finds fy.policy.json. */
|
|
33
|
+
export declare function findPolicyFile(start?: string): Promise<string | undefined>;
|
|
34
|
+
/**
|
|
35
|
+
* Loads the resource policy for the current workspace.
|
|
36
|
+
*
|
|
37
|
+
* `FRAMEYARD_POLICY` replaces the policy file entirely, so an explicit human
|
|
38
|
+
* override also resets the file's profile and tightened limits. Without the
|
|
39
|
+
* variable, the nearest `fy.policy.json` from `cwd` upward wins; without
|
|
40
|
+
* a file, the default is `full`.
|
|
41
|
+
*/
|
|
42
|
+
export declare function loadResourcePolicy(options?: {
|
|
43
|
+
cwd?: string;
|
|
44
|
+
env?: NodeJS.ProcessEnv;
|
|
45
|
+
}): Promise<LoadedResourcePolicy>;
|
|
46
|
+
/** Resolves the effective profile from the CLI flag and the policy file. */
|
|
47
|
+
export declare function resolveProfile(policy: LoadedResourcePolicy, requested: string | undefined): ResourceProfile | undefined;
|
|
48
|
+
/** Returns the operation allowlist for a tier. */
|
|
49
|
+
export declare function allowedOperations(tier: PolicyTier): PolicyOperation[];
|
|
50
|
+
export declare function operationAllowed(tier: PolicyTier, operation: PolicyOperation): boolean;
|
|
51
|
+
export declare function assertOperationAllowed(policy: LoadedResourcePolicy, operation: PolicyOperation, options?: {
|
|
52
|
+
dryRun?: boolean;
|
|
53
|
+
}): void;
|
|
54
|
+
/** Requires a minimum tier for subcommands that share one policy operation. */
|
|
55
|
+
export declare function assertPolicyTier(policy: LoadedResourcePolicy, required: PolicyTier, operation: string): void;
|
|
56
|
+
export declare function assertStillFrameLimit(policy: LoadedResourcePolicy, requested: number): void;
|
|
57
|
+
export declare function assertOverwriteAllowed(policy: LoadedResourcePolicy, operation: "overwrite" | "force"): void;
|
|
58
|
+
export declare function assertProfileLimit(profile: ResourceProfile, option: "workers" | "concurrency", requested: number, limit: number): void;
|
|
59
|
+
export declare function shouldLowerPriority(policy: LoadedResourcePolicy, profile: ResourceProfile | undefined, requested: boolean): boolean;
|
|
60
|
+
/**
|
|
61
|
+
* Lowers the current process priority so it yields to a local model. Children
|
|
62
|
+
* inherit the nice value on Unix. This is best effort on platforms that do not
|
|
63
|
+
* expose process priorities.
|
|
64
|
+
*/
|
|
65
|
+
export declare function lowerProcessPriority(): void;
|
|
66
|
+
/** Serializable policy details for JSON results and diagnostics. */
|
|
67
|
+
export declare function policyDetails(policy: LoadedResourcePolicy): PolicyDescription;
|
|
68
|
+
export declare function describePolicy(policy: LoadedResourcePolicy): string;
|
|
69
|
+
//# sourceMappingURL=policy.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"policy.d.ts","sourceRoot":"","sources":["../src/policy.ts"],"names":[],"mappings":"AAMA,uFAAuF;AACvF,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAEjD,eAAO,MAAM,YAAY,YAAI,OAAO,EAAE,WAAW,EAAE,MAAM,CAAU,CAAC;AACpE,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAEvD,eAAO,MAAM,iBAAiB,YAAI,YAAY,CAAU,CAAC;AACzD,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjE,eAAO,MAAM,gBAAgB,KAAK,CAAC;AACnC,eAAO,MAAM,sBAAsB,IAAI,CAAC;AACxC,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAK5C,eAAO,MAAM,aAAa,EAAE,MAAM,CAChC,UAAU,EACV;IACE,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,OAAO,CAAC;CACzB,CAKF,CAAC;AAEF,MAAM,MAAM,eAAe,GACvB,MAAM,GACN,SAAS,GACT,QAAQ,GACR,MAAM,GACN,KAAK,GACL,OAAO,GACP,OAAO,GACP,MAAM,GACN,KAAK,GACL,YAAY,GACZ,QAAQ,CAAC;AAEb,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,OAAO,CAAC;IACxB,MAAM,EAAE,SAAS,GAAG,MAAM,GAAG,KAAK,CAAC;IACnC,kEAAkE;IAClE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,OAAO,CAAC;IACxB,MAAM,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAsBD,+DAA+D;AAC/D,wBAAsB,cAAc,CAAC,KAAK,SAAgB,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAsBvF;AAuID;;;;;;;GAOG;AACH,wBAAsB,kBAAkB,CACtC,OAAO,GAAE;IACP,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;CACpB,GACL,OAAO,CAAC,oBAAoB,CAAC,CA+B/B;AAED,4EAA4E;AAC5E,wBAAgB,cAAc,CAC5B,MAAM,EAAE,oBAAoB,EAC5B,SAAS,EAAE,MAAM,GAAG,SAAS,GAC5B,eAAe,GAAG,SAAS,CAQ7B;AAED,kDAAkD;AAClD,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,UAAU,GAAG,eAAe,EAAE,CASrE;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,GAAG,OAAO,CAEtF;AAeD,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,oBAAoB,EAC5B,SAAS,EAAE,eAAe,EAC1B,OAAO,GAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAO,GACjC,IAAI,CAmBN;AAID,+EAA+E;AAC/E,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,oBAAoB,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAiB5G;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,oBAAoB,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAgB3F;AAED,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,oBAAoB,EAAE,SAAS,EAAE,WAAW,GAAG,OAAO,GAAG,IAAI,CAiB3G;AAED,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,eAAe,EACxB,MAAM,EAAE,SAAS,GAAG,aAAa,EACjC,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,GACZ,IAAI,CAiBN;AAED,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,oBAAoB,EAC5B,OAAO,EAAE,eAAe,GAAG,SAAS,EACpC,SAAS,EAAE,OAAO,GACjB,OAAO,CAET;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAQ3C;AAED,oEAAoE;AACpE,wBAAgB,aAAa,CAAC,MAAM,EAAE,oBAAoB,GAAG,iBAAiB,CAS7E;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,MAAM,CAQnE"}
|