npm - @hyperframes/parsers - Versions diffs - 0.7.22 → 0.7.23 - Mend

@hyperframes/parsers 0.7.22 → 0.7.23

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.

Files changed (7) hide show

package/dist/index.d.ts +14 -1
package/dist/index.js +86 -0
package/dist/index.js.map +1 -1
package/dist/subCompositionValidity.d.ts +79 -0
package/dist/subCompositionValidity.js +47 -0
package/dist/subCompositionValidity.js.map +1 -0
package/package.json +6 -2

package/dist/index.d.ts CHANGED Viewed

@@ -6,8 +6,21 @@ export { PROPERTY_GROUPS, PropertyGroupName, SUPPORTED_EASES, SUPPORTED_PROPS, c
 export { SPRING_PRESETS, SpringPreset, generateSpringEaseData } from './springEase.js';
 export { parseGsapScriptAcorn as parseGsapScript } from './gsapParserAcorn.js';
 export { EXCLUDED_TAGS, ensureHfIds, mintHfId } from './hfIds.js';
+export { ParsableDocumentLike, SubCompositionValidity, SubCompositionValidityReason, checkSubCompositionUsability } from './subCompositionValidity.js';
 export { CANONICAL_FONT_DISPLAY_NAMES, FONT_ALIAS_KEYS, FONT_ALIAS_MAP, decodeUrlPathVariants, resolveAliasDisplayName } from './composition.js';
+/**
+ * Thrown by htmlParser functions when the input HTML is empty or does not
+ * parse to a document with a `documentElement` — the condition that,
+ * unguarded, previously surfaced as a raw
+ * `Cannot read properties of null (reading '...')` /
+ * `Cannot destructure property 'firstElementChild' of 'documentElement' as
+ * it is null` crash deep inside the DOM implementation instead of a clear,
+ * catchable error naming which function received bad input.
+ */
+declare class CompositionHtmlParseError extends Error {
+    constructor(message: string);
+}
 interface ParsedHtml {
     elements: TimelineElement[];
     gsapScript: string | null;
@@ -42,4 +55,4 @@ declare function unrollComputedTimeline(script: string): string;
 declare function queryByAttr(root: ParentNode, attr: string, value: string, tag?: string): Element | null;
-export { CanvasResolution, type CompositionMetadata, CompositionVariable, Keyframe, type ParsedHtml, StageZoomKeyframe, TimelineElement, ValidationResult, addElementToHtml, extractCompositionMetadata, parseHtml, queryByAttr, removeElementFromHtml, unrollComputedTimeline, updateElementInHtml, validateCompositionHtml };
+export { CanvasResolution, CompositionHtmlParseError, type CompositionMetadata, CompositionVariable, Keyframe, type ParsedHtml, StageZoomKeyframe, TimelineElement, ValidationResult, addElementToHtml, extractCompositionMetadata, parseHtml, queryByAttr, removeElementFromHtml, unrollComputedTimeline, updateElementInHtml, validateCompositionHtml };

package/dist/index.js CHANGED Viewed

@@ -1787,6 +1787,12 @@ function removeAnimationFromScript(script, animationId) {
 // src/htmlParser.ts
 var MEDIA_TYPES = /* @__PURE__ */ new Set(["video", "image", "audio"]);
+var CompositionHtmlParseError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "CompositionHtmlParseError";
+  }
+};
 function getElementType(el) {
   const tag = el.tagName.toLowerCase();
   if (tag === "video") return "video";
@@ -1856,6 +1862,7 @@ function parseResolutionFromCss(doc, cssText) {
 }
 function parseResolutionFromHtml(doc) {
   const htmlEl = doc.documentElement;
+  if (!htmlEl) return null;
   const resolutionAttr = htmlEl.getAttribute("data-resolution");
   if (resolutionAttr === "landscape" || resolutionAttr === "portrait" || resolutionAttr === "landscape-4k" || resolutionAttr === "portrait-4k" || resolutionAttr === "square" || resolutionAttr === "square-4k") {
     return resolutionAttr;
@@ -1891,6 +1898,9 @@ function parseHtml(html) {
   const keyframes = {};
   let idCounter = 0;
   const htmlEl = doc.documentElement;
+  if (!htmlEl) {
+    throw new CompositionHtmlParseError("parseHtml: input HTML is empty or could not be parsed");
+  }
   const customStylesAttr = htmlEl.getAttribute("data-custom-styles");
   let customStyles = null;
   if (customStylesAttr) {
@@ -2201,12 +2211,25 @@ function updateElementInHtml(html, elementId, updates) {
       el.removeAttribute("data-has-audio");
     }
   }
+  if (!doc.documentElement) {
+    throw new CompositionHtmlParseError(
+      "updateElementInHtml: input HTML is empty or could not be parsed"
+    );
+  }
   return "<!DOCTYPE html>\n" + doc.documentElement.outerHTML;
 }
 function addElementToHtml(html, element) {
   const parser = new DOMParser();
   const doc = parser.parseFromString(html, "text/html");
+  if (!doc.documentElement) {
+    throw new CompositionHtmlParseError(
+      "addElementToHtml: input HTML is empty or could not be parsed"
+    );
+  }
   const container = doc.querySelector("#stage-zoom-container") || doc.querySelector(".container") || doc.querySelector("#stage") || doc.body;
+  if (!container) {
+    throw new CompositionHtmlParseError("addElementToHtml: input HTML has no <body>");
+  }
   const id = element.id || `element-${Date.now()}`;
   let newEl;
   function applyMediaAttrs(el, mediaEl) {
@@ -2295,6 +2318,11 @@ function cascadeRemoveGsapById(doc, elementId) {
 function removeElementFromHtml(html, elementId) {
   const parser = new DOMParser();
   const doc = parser.parseFromString(html, "text/html");
+  if (!doc.documentElement) {
+    throw new CompositionHtmlParseError(
+      "removeElementFromHtml: input HTML is empty or could not be parsed"
+    );
+  }
   doc.getElementById(elementId)?.remove();
   cascadeRemoveGsapById(doc, elementId);
   return "<!DOCTYPE html>\n" + doc.documentElement.outerHTML;
@@ -2303,6 +2331,11 @@ function extractCompositionMetadata(html) {
   const parser = new DOMParser();
   const doc = parser.parseFromString(html, "text/html");
   const htmlEl = doc.documentElement;
+  if (!htmlEl) {
+    throw new CompositionHtmlParseError(
+      "extractCompositionMetadata: input HTML is empty or could not be parsed"
+    );
+  }
   const compositionId = htmlEl.getAttribute("data-composition-id");
   const durationStr = htmlEl.getAttribute("data-composition-duration");
   const compositionDuration = durationStr ? parseFloat(durationStr) : null;
@@ -2357,6 +2390,13 @@ function validateCompositionHtml(html) {
   const parser = new DOMParser();
   const doc = parser.parseFromString(html, "text/html");
   const htmlEl = doc.documentElement;
+  if (!htmlEl) {
+    return {
+      valid: false,
+      errors: ["Composition HTML is empty or could not be parsed"],
+      warnings: []
+    };
+  }
   const compositionId = htmlEl.getAttribute("data-composition-id");
   if (!compositionId) {
     errors.push("Missing data-composition-id attribute on <html> element");
@@ -2407,6 +2447,50 @@ function extractGsapScript(doc) {
   return null;
 }
+// src/subCompositionValidity.ts
+function checkSubCompositionUsability(html, parseHtml2) {
+  if (html == null || !html.trim()) {
+    return {
+      ok: false,
+      reason: "empty",
+      detail: "the file is empty (0 bytes or whitespace-only)"
+    };
+  }
+  const compDoc = parseHtml2(html);
+  if (!compDoc.documentElement) {
+    return {
+      ok: false,
+      reason: "unparsable",
+      detail: "the file's contents could not be parsed as HTML"
+    };
+  }
+  const contentRoot = compDoc.querySelector("template");
+  const contentHtml = contentRoot ? contentRoot.innerHTML || "" : compDoc.body?.innerHTML || "";
+  if (!contentHtml.trim()) {
+    return {
+      ok: false,
+      reason: "no-content",
+      detail: "the file has no <template> or <body> content to render"
+    };
+  }
+  const contentDoc = parseHtml2(contentHtml);
+  if (!contentDoc.documentElement) {
+    return {
+      ok: false,
+      reason: "unparsable",
+      detail: "the file's <template>/<body> contents could not be parsed as HTML"
+    };
+  }
+  if (!contentDoc.querySelector("[data-composition-id]")) {
+    return {
+      ok: false,
+      reason: "no-composition-root",
+      detail: "the file's <template>/<body> content has no element with a data-composition-id attribute"
+    };
+  }
+  return { ok: true };
+}
 // src/gsapUnroll.ts
 import * as acorn2 from "acorn";
 import MagicString2 from "magic-string";
@@ -2622,6 +2706,7 @@ export {
   CANONICAL_FONT_DISPLAY_NAMES,
   CANVAS_DIMENSIONS,
   COMPOSITION_VARIABLE_TYPES,
+  CompositionHtmlParseError,
   DEFAULT_DURATIONS,
   EXCLUDED_TAGS,
   FONT_ALIAS_KEYS,
@@ -2633,6 +2718,7 @@ export {
   TIMELINE_COLORS,
   VALID_CANVAS_RESOLUTIONS,
   addElementToHtml,
+  checkSubCompositionUsability,
   classifyPropertyGroup,
   classifyTweenPropertyGroup,
   decodeUrlPathVariants,