@hyperframes/parsers 0.8.201 → 0.8.202

package/dist/index.d.ts

@@ -130,6 +130,23 @@ declare function checkOutputResolutionCompatibility(input: {
     alphaRequested?: boolean;
     hdrRequested?: boolean;
 }): OutputResolutionCompatibility;
+type OutputSizeResolution = {
+    ok: true;
+    outputResolution: CanvasResolution | undefined;
+} | {
+    ok: false;
+    message: string;
+};
+/**
+ * The preset a requested pixel size stands for on a composition: none when it is the composition's own size,
+ * else the preset of exactly that size when it is a whole-number multiple (3840×2160 on 1920×1080 is scale 2).
+ */
+declare function outputResolutionForSize(input: {
+    compositionWidth: number;
+    compositionHeight: number;
+    width: number;
+    height: number;
+}): OutputSizeResolution;
 
 /** Rewrite top-level helper calls and loops into literal tweens; unchanged when nothing can be unrolled. */
 declare function unrollComputedTimeline(script: string): string;
@@ -168,4 +185,4 @@ interface TimingMismatchReport {
  */
 declare function timingMismatches(html: string): TimingMismatchReport;
 
-export { CanvasResolution, CompositionHtmlParseError, type CompositionMetadata, CompositionVariable, Keyframe, type OutputResolutionCompatibility, type OutputResolutionIssueKind, type ParsedHtml, StageZoomKeyframe, TimelineElement, type TimingFinding, type TimingMismatchReport, type UnresolvedTiming, ValidationResult, addElementToHtml, checkOutputResolutionCompatibility, extractCompositionMetadata, parseHtml, queryByAttr, removeElementFromHtml, removeElementWithGsapCascade, suggestMatchingPreset, timingMismatches, unrollComputedTimeline, updateElementInHtml, validateCompositionHtml };
+export { CanvasResolution, CompositionHtmlParseError, type CompositionMetadata, CompositionVariable, Keyframe, type OutputResolutionCompatibility, type OutputResolutionIssueKind, type OutputSizeResolution, type ParsedHtml, StageZoomKeyframe, TimelineElement, type TimingFinding, type TimingMismatchReport, type UnresolvedTiming, ValidationResult, addElementToHtml, checkOutputResolutionCompatibility, extractCompositionMetadata, outputResolutionForSize, parseHtml, queryByAttr, removeElementFromHtml, removeElementWithGsapCascade, suggestMatchingPreset, timingMismatches, unrollComputedTimeline, updateElementInHtml, validateCompositionHtml };

package/dist/index.js

@@ -3738,6 +3738,34 @@ function checkOutputResolutionCompatibility(input) {
   }
   return OK;
 }
+function outputResolutionForSize(input) {
+  const { compositionWidth, compositionHeight, width, height } = input;
+  if (width === compositionWidth && height === compositionHeight) {
+    return { ok: true, outputResolution: void 0 };
+  }
+  const composition = `${compositionWidth}\xD7${compositionHeight}`;
+  const scale = width / compositionWidth;
+  if (width < compositionWidth || height < compositionHeight) {
+    return {
+      ok: false,
+      message: `${width}\xD7${height} is smaller than the composition (${composition}). Use the composition's size, or a whole-number multiple of it.`
+    };
+  }
+  const preset = VALID_CANVAS_RESOLUTIONS.find(
+    (name) => CANVAS_DIMENSIONS[name].width === width && CANVAS_DIMENSIONS[name].height === height
+  );
+  if (!Number.isInteger(scale) || height !== compositionHeight * scale || !preset || !checkOutputResolutionCompatibility({
+    compositionWidth,
+    compositionHeight,
+    outputResolution: preset
+  }).ok) {
+    return {
+      ok: false,
+      message: `${width}\xD7${height} is not a whole-number multiple of the composition (${composition}) at a supported size. Use ${composition}, or a multiple such as ${compositionWidth * 2}\xD7${compositionHeight * 2} when that is a preset size (${VALID_CANVAS_RESOLUTIONS.map((name) => `${CANVAS_DIMENSIONS[name].width}\xD7${CANVAS_DIMENSIONS[name].height}`).join(", ")}).`
+    };
+  }
+  return { ok: true, outputResolution: preset };
+}
 
 // src/gsapUnroll.ts
 import * as acorn2 from "acorn";
@@ -4643,6 +4671,7 @@ export {
   keyframesToGsapAnimations,
   mintHfId,
   normalizeResolutionFlag,
+  outputResolutionForSize,
   parseCompositionVariables,
   parseGsapScriptAcorn as parseGsapScript,
   parseHtml,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperframes/parsers",
-  "version": "0.8.201",
+  "version": "0.8.202",
   "repository": {
     "type": "git",
     "url": "https://github.com/heygen-com/hyperframes",
@@ -135,7 +135,7 @@
     "tsx": "^4.21.0",
     "typescript": "^5.0.0",
     "vitest": "^4.1.11",
-    "@hyperframes/core": "0.8.201"
+    "@hyperframes/core": "0.8.202"
   },
   "scripts": {
     "build": "tsup",