@likecoin/epubcheck-ts 0.2.3 → 0.2.4

package/dist/index.d.cts

@@ -378,6 +378,7 @@ declare enum MessageId {
     OPF_013 = "OPF-013",// Remote resource not allowed
     OPF_014 = "OPF-014",// Invalid manifest item media-type
     OPF_097 = "OPF-097",// Resource not referenced
+    OPF_099 = "OPF-099",// Manifest must not list the package document
     OPF_015 = "OPF-015",// Invalid guide reference
     RSC_001 = "RSC-001",// Could not open resource
     RSC_002 = "RSC-002",// Resource missing from manifest

package/dist/index.d.ts

@@ -378,6 +378,7 @@ declare enum MessageId {
     OPF_013 = "OPF-013",// Remote resource not allowed
     OPF_014 = "OPF-014",// Invalid manifest item media-type
     OPF_097 = "OPF-097",// Resource not referenced
+    OPF_099 = "OPF-099",// Manifest must not list the package document
     OPF_015 = "OPF-015",// Invalid guide reference
     RSC_001 = "RSC-001",// Could not open resource
     RSC_002 = "RSC-002",// Resource missing from manifest

package/dist/index.js

@@ -62,8 +62,61 @@ var CSSValidator = class {
     this.checkDiscouragedProperties(context, ast, resourcePath);
     this.checkAtRules(context, ast, resourcePath, result);
     this.checkMediaOverlayClasses(context, ast, resourcePath);
+    this.extractUrlReferences(context, ast, resourcePath, result);
     return result;
   }
+  extractUrlReferences(context, ast, resourcePath, result) {
+    walk(ast, (node) => {
+      if (node.type === "Atrule") {
+        const atRule = node;
+        if (atRule.name === "font-face") {
+          return;
+        }
+        if (atRule.block) {
+          walk(atRule.block, (blockNode) => {
+            if (blockNode.type === "Declaration") {
+              this.processDeclarationForUrl(blockNode, resourcePath, result);
+            }
+          });
+        }
+      } else if (node.type === "Rule") {
+        const rule = node;
+        walk(rule.block, (blockNode) => {
+          if (blockNode.type === "Declaration") {
+            this.processDeclarationForUrl(blockNode, resourcePath, result);
+          }
+        });
+      }
+    });
+  }
+  processDeclarationForUrl(declaration, resourcePath, result) {
+    const property = declaration.property.toLowerCase();
+    walk(declaration.value, (valueNode) => {
+      if (valueNode.type === "Url") {
+        const urlValue = this.extractUrlValue(valueNode);
+        if (urlValue && !urlValue.startsWith("data:")) {
+          const loc = valueNode.loc;
+          const start = loc?.start;
+          if (start) {
+            start.line;
+            start.column;
+          }
+          let refType = "resource";
+          if (property.includes("font")) {
+            refType = "font";
+          } else if (property.includes("background") || property.includes("list-style") || property.includes("content") || property.includes("border-image") || property.includes("mask")) {
+            refType = "image";
+          }
+          result.references.push({
+            url: urlValue,
+            type: refType,
+            line: start?.line,
+            column: start?.column
+          });
+        }
+      }
+    });
+  }
   /**
    * Check for forbidden and discouraged CSS properties in EPUB
    */
@@ -432,6 +485,104 @@ function isPublicationResourceReference(type) {
 
 // src/content/validator.ts
 var DISCOURAGED_ELEMENTS = /* @__PURE__ */ new Set(["base", "embed"]);
+var HTML_ENTITIES = /* @__PURE__ */ new Set([
+  "nbsp",
+  "iexcl",
+  "cent",
+  "pound",
+  "curren",
+  "yen",
+  "brvbar",
+  "sect",
+  "uml",
+  "copy",
+  "ordf",
+  "laquo",
+  "not",
+  "shy",
+  "reg",
+  "macr",
+  "deg",
+  "plusmn",
+  "sup2",
+  "sup3",
+  "acute",
+  "micro",
+  "para",
+  "middot",
+  "cedil",
+  "sup1",
+  "ordm",
+  "raquo",
+  "frac14",
+  "frac12",
+  "frac34",
+  "iquest",
+  "Agrave",
+  "Aacute",
+  "Acirc",
+  "Atilde",
+  "Auml",
+  "Aring",
+  "AElig",
+  "Ccedil",
+  "Egrave",
+  "Eacute",
+  "Ecirc",
+  "Euml",
+  "Igrave",
+  "Iacute",
+  "Icirc",
+  "Iuml",
+  "ETH",
+  "Ntilde",
+  "Ograve",
+  "Oacute",
+  "Ocirc",
+  "Otilde",
+  "Ouml",
+  "times",
+  "Oslash",
+  "Ugrave",
+  "Uacute",
+  "Ucirc",
+  "Uuml",
+  "Yacute",
+  "THORN",
+  "szlig",
+  "agrave",
+  "aacute",
+  "acirc",
+  "atilde",
+  "auml",
+  "aring",
+  "aelig",
+  "ccedil",
+  "egrave",
+  "eacute",
+  "ecirc",
+  "euml",
+  "igrave",
+  "iacute",
+  "icirc",
+  "iuml",
+  "eth",
+  "ntilde",
+  "ograve",
+  "oacute",
+  "ocirc",
+  "otilde",
+  "ouml",
+  "divide",
+  "oslash",
+  "ugrave",
+  "uacute",
+  "ucirc",
+  "uuml",
+  "yacute",
+  "thorn",
+  "yuml"
+]);
 var ContentValidator = class {
   validate(context, registry, refValidator) {
     const packageDoc = context.packageDocument;
@@ -457,7 +608,31 @@ var ContentValidator = class {
     }
     const cssContent = new TextDecoder().decode(cssData);
     const cssValidator = new CSSValidator();
-    cssValidator.validate(context, cssContent, path);
+    const result = cssValidator.validate(context, cssContent, path);
+    const cssDir = path.includes("/") ? path.substring(0, path.lastIndexOf("/")) : "";
+    for (const ref of result.references) {
+      if (ref.type === "font") {
+        const resolvedPath = this.resolveRelativePath(cssDir, ref.url, opfDir);
+        const hashIndex = resolvedPath.indexOf("#");
+        const targetResource = hashIndex >= 0 ? resolvedPath.slice(0, hashIndex) : resolvedPath;
+        refValidator.addReference({
+          url: ref.url,
+          targetResource,
+          type: "font" /* FONT */,
+          location: { path }
+        });
+      } else if (ref.type === "image") {
+        const resolvedPath = this.resolveRelativePath(cssDir, ref.url, opfDir);
+        const hashIndex = resolvedPath.indexOf("#");
+        const targetResource = hashIndex >= 0 ? resolvedPath.slice(0, hashIndex) : resolvedPath;
+        refValidator.addReference({
+          url: ref.url,
+          targetResource,
+          type: "image" /* IMAGE */,
+          location: { path }
+        });
+      }
+    }
     this.extractCSSImports(path, cssContent, opfDir, refValidator);
   }
   validateXHTMLDocument(context, path, itemId, opfDir, registry, refValidator) {
@@ -477,19 +652,26 @@ var ContentValidator = class {
     } catch (error) {
       if (error instanceof Error) {
         const { message, line, column } = this.parseLibxmlError(error.message);
-        const location = { path };
-        if (line !== void 0) {
-          location.line = line;
-        }
-        if (column !== void 0) {
-          location.column = column;
+        const entityPattern = /Entity '(\w+)' not defined/;
+        const entityExec = entityPattern.exec(error.message);
+        const entityName = entityExec?.[1];
+        const isKnownHtmlEntity = entityName !== void 0 && HTML_ENTITIES.has(entityName);
+        const isEpub2 = context.version === "2.0";
+        if (!isEpub2 || !isKnownHtmlEntity) {
+          const location = { path };
+          if (line !== void 0) {
+            location.line = line;
+          }
+          if (column !== void 0) {
+            location.column = column;
+          }
+          context.messages.push({
+            id: "HTM-004",
+            severity: "error",
+            message,
+            location
+          });
         }
-        context.messages.push({
-          id: "HTM-004",
-          severity: "error",
-          message,
-          location
-        });
       }
       return;
     }
@@ -2556,6 +2738,7 @@ var OPFValidator = class {
     context.packageDocument = this.packageDoc;
     this.validatePackageAttributes(context, opfPath);
     this.validateMetadata(context, opfPath);
+    this.validateLinkElements(context, opfPath);
     this.validateManifest(context, opfPath);
     this.validateSpine(context, opfPath);
     this.validateFallbackChains(context, opfPath);
@@ -2807,6 +2990,34 @@ var OPFValidator = class {
       }
     }
   }
+  /**
+   * Validate EPUB 3 link elements in metadata
+   */
+  validateLinkElements(context, opfPath) {
+    if (!this.packageDoc) return;
+    const opfDir = opfPath.includes("/") ? opfPath.substring(0, opfPath.lastIndexOf("/")) : "";
+    for (const link of this.packageDoc.linkElements) {
+      const href = link.href;
+      const decodedHref = tryDecodeUriComponent(href);
+      const basePath = href.includes("#") ? href.substring(0, href.indexOf("#")) : href;
+      const basePathDecoded = decodedHref.includes("#") ? decodedHref.substring(0, decodedHref.indexOf("#")) : decodedHref;
+      if (href.startsWith("#")) {
+        continue;
+      }
+      const resolvedPath = resolvePath(opfDir, basePath);
+      const resolvedPathDecoded = basePathDecoded !== basePath ? resolvePath(opfDir, basePathDecoded) : resolvedPath;
+      const fileExists = context.files.has(resolvedPath) || context.files.has(resolvedPathDecoded);
+      const inManifest = this.manifestByHref.has(basePath) || this.manifestByHref.has(basePathDecoded);
+      if (!fileExists && !inManifest) {
+        context.messages.push({
+          id: "RSC-007",
+          severity: "warning",
+          message: `Referenced resource "${resolvedPath}" could not be found in the EPUB`,
+          location: { path: opfPath }
+        });
+      }
+    }
+  }
   /**
    * Validate manifest section
    */
@@ -2834,7 +3045,28 @@ var OPFValidator = class {
       }
       seenHrefs.add(item.href);
       const fullPath = resolvePath(opfPath, item.href);
-      if (!context.files.has(fullPath) && !item.href.startsWith("http")) {
+      if (fullPath === opfPath) {
+        context.messages.push({
+          id: "OPF-099",
+          severity: "error",
+          message: "The manifest must not list the package document",
+          location: { path: opfPath }
+        });
+      }
+      if (!item.href.startsWith("http") && !item.href.startsWith("mailto:")) {
+        const leaked = checkUrlLeaking(item.href);
+        if (leaked) {
+          context.messages.push({
+            id: "RSC-026",
+            severity: "error",
+            message: `URL "${item.href}" leaks outside the container (it is not a valid-relative-ocf-URL-with-fragment string)`,
+            location: { path: opfPath }
+          });
+        }
+      }
+      const decodedHref = tryDecodeUriComponent(item.href);
+      const fullPathDecoded = decodedHref !== item.href ? resolvePath(opfPath, decodedHref) : fullPath;
+      if (!context.files.has(fullPath) && !context.files.has(fullPathDecoded) && !item.href.startsWith("http")) {
         context.messages.push({
           id: "RSC-001",
           severity: "error",
@@ -3186,6 +3418,24 @@ function resolvePath(basePath, relativePath) {
   }
   return parts.join("/");
 }
+function tryDecodeUriComponent(encoded) {
+  try {
+    return decodeURIComponent(encoded);
+  } catch {
+    return encoded;
+  }
+}
+function checkUrlLeaking(href) {
+  const TEST_BASE_A = "https://a.example.org/A/";
+  const TEST_BASE_B = "https://b.example.org/B/";
+  try {
+    const urlA = new URL(href, TEST_BASE_A).toString();
+    const urlB = new URL(href, TEST_BASE_B).toString();
+    return !urlA.startsWith(TEST_BASE_A) || !urlB.startsWith(TEST_BASE_B);
+  } catch {
+    return false;
+  }
+}
 function isValidMimeType(mediaType) {
   const mimeTypePattern = /^[a-zA-Z][a-zA-Z0-9!#$&\-^_.]*\/[a-zA-Z0-9][a-zA-Z0-9!#$&\-^_.+]*(?:\s*;\s*[a-zA-Z0-9-]+=[^;]+)?$/;
   if (!mimeTypePattern.test(mediaType)) {
@@ -4166,6 +4416,7 @@ var MessageId = /* @__PURE__ */ ((MessageId2) => {
   MessageId2["OPF_013"] = "OPF-013";
   MessageId2["OPF_014"] = "OPF-014";
   MessageId2["OPF_097"] = "OPF-097";
+  MessageId2["OPF_099"] = "OPF-099";
   MessageId2["OPF_015"] = "OPF-015";
   MessageId2["RSC_001"] = "RSC-001";
   MessageId2["RSC_002"] = "RSC-002";