pro-editor-schema 0.2.21 → 0.2.24

package/dist/index.js

@@ -244,7 +244,13 @@ var INSERTION_SCHEMA = createSchema({
   tag: SPAN_TAG,
   matchesElement: (element) => element.classList.contains("ins"),
   requiredAttributes: [...TRACK_CHANGES_ATTRS, ...ID_ATTRS],
-  optionalAttributes: [],
+  optionalAttributes: [
+    {
+      name: "role",
+      values: ["web-link", "figure-note-link", "figsource"],
+      defaultValue: ""
+    }
+  ],
   allowedChildrenCodes: [
     ...ATOM_CODES_ALLOWED_CHILDREN,
     ...INLINE_ELEMENT_CODES_ALLOWED_CHILDREN
@@ -2334,8 +2340,8 @@ var URI_SCHEMA = createSchema({
   code: "uri",
   kind: "inline",
   tag: URI_TAG,
-  requiredAttributes: [...ID_ATTRS],
-  optionalAttributes: ["linkend"],
+  requiredAttributes: [],
+  optionalAttributes: ["xlinkhref"],
   allowedChildrenCodes: [...ATOM_CODES_ALLOWED_CHILDREN]
 });
 
@@ -2601,6 +2607,84 @@ var retrieveTextIgnoringNodesWithSelector = (element, selector = ".del") => {
   return clonedElement.textContent || "";
 };
 
+// src/validation/utils/getElementsSelector.ts
+var getElementsSelector = ({
+  element,
+  selector,
+  filterDeletedNodes
+}) => {
+  const elements = element.querySelectorAll(selector);
+  if (filterDeletedNodes) {
+    return Array.from(elements).filter((element2) => {
+      const hasDeletedParent = element2.closest(".del") !== null;
+      if (hasDeletedParent) {
+        return false;
+      }
+      return true;
+    });
+  }
+  return Array.from(elements);
+};
+
+// src/validation/validateLinkend.ts
+var findElementLinkedTo = (linkend, elementsToLink) => {
+  return elementsToLink.includes(linkend);
+};
+var LINK_TO_CROSS_CHECK = [
+  TABLE_LINK_ROLE,
+  FIGURE_LINK_ROLE,
+  EQUATION_LINK_ROLE,
+  FOOTNOTE_LINK_ROLE,
+  REFERENCE_LINK_ROLE
+];
+var LINK_BLOCKER_ROLES = [
+  TABLE_LINK_ROLE,
+  FIGURE_LINK_ROLE,
+  EQUATION_LINK_ROLE,
+  FOOTNOTE_LINK_ROLE
+];
+var validateLinkend = (linkElement, elementsToLink) => {
+  const linkend = linkElement.getAttribute("linkend");
+  if (!linkend) {
+    return [];
+  }
+  const isLinkFootnoteCue = linkElement.tagName.toUpperCase() === FOOTNOTE_LINK_SCHEMA.tag;
+  if (isLinkFootnoteCue) {
+    if (findElementLinkedTo(linkend, elementsToLink)) {
+      return [];
+    }
+    return [
+      createValidationIssue({
+        store: getStore(linkElement),
+        title: "Unlinked footnote cue",
+        kind: "unlinked",
+        description: "This footnote cue is not referenced to any footnote in this chapter. Please link it again manually.",
+        level: "blocker"
+      })
+    ];
+  }
+  const role = linkElement.getAttribute("role");
+  if (!role) {
+    return [];
+  }
+  if (!LINK_TO_CROSS_CHECK.includes(role)) {
+    return [];
+  }
+  if (findElementLinkedTo(linkend, elementsToLink)) {
+    return [];
+  }
+  const isBlocker = LINK_BLOCKER_ROLES.includes(role.toLowerCase());
+  return [
+    createValidationIssue({
+      store: getStore(linkElement),
+      title: "Unlinked element",
+      kind: "unlinked",
+      description: "This link is not referenced to any element in the current chapter or any other chapter. Please link it again manually.",
+      level: isBlocker ? "blocker" : "warning"
+    })
+  ];
+};
+
 // src/validation/validateFootnotes.ts
 var extractFootnoteNumber = (footnote) => {
   if (!footnote) return "no label";
@@ -2611,16 +2695,13 @@ var extractFootnoteNumber = (footnote) => {
   }
   return footnoteNumber;
 };
-var validateFootnoteCue = (footnoteElement, root) => {
+var validateFootnoteCue = (footnoteElement, linkElements) => {
   const errors = [];
   const linkend = footnoteElement.getAttribute("xmlid") || "";
   const footnoteNumber = footnoteElement.querySelector(
     FOOTNOTE_NUMBER_SCHEMA.tag
   );
-  const footnoteLink = root.querySelector(
-    `${FOOTNOTE_LINK_SCHEMA.tag}[linkend='${CSS.escape(linkend)}']`
-  );
-  if (footnoteLink) {
+  if (findElementLinkedTo(linkend, linkElements)) {
     return errors;
   }
   if (!footnoteNumber) {
@@ -2642,8 +2723,12 @@ var validateFootnoteCue = (footnoteElement, root) => {
   });
   return errors;
 };
-var validateConsecutiveFootnotes = (root) => {
-  const footnotes = Array.from(root.querySelectorAll(FOOTNOTE_SCHEMA.tag));
+var validateConsecutiveFootnotes = (element) => {
+  const footnotes = getElementsSelector({
+    element,
+    selector: FOOTNOTE_SCHEMA.tag,
+    filterDeletedNodes: true
+  });
   if (footnotes.length === 0) {
     return [];
   }
@@ -2671,10 +2756,12 @@ var validateConsecutiveFootnotes = (root) => {
   }
   return [];
 };
-var validateConsecutiveFootnoteCues = (root) => {
-  const footnoteLinks = Array.from(
-    root.querySelectorAll(FOOTNOTE_LINK_SCHEMA.tag)
-  );
+var validateConsecutiveFootnoteCues = (element) => {
+  const footnoteLinks = getElementsSelector({
+    element,
+    selector: FOOTNOTE_LINK_SCHEMA.tag,
+    filterDeletedNodes: true
+  });
   if (footnoteLinks.length === 0) {
     return [];
   }
@@ -2697,56 +2784,6 @@ var validateConsecutiveFootnoteCues = (root) => {
   return [];
 };
 
-// src/validation/validateLinkend.ts
-var findElementLinkedTo = (linkend, elementsToLink) => {
-  return elementsToLink.includes(linkend);
-};
-var LINK_BLOCKER_ROLES = [
-  TABLE_LINK_ROLE,
-  FIGURE_LINK_ROLE,
-  EQUATION_LINK_ROLE,
-  FOOTNOTE_LINK_ROLE,
-  CHAPTER_LINK_ROLE
-];
-var validateLinkend = (linkElement, elementsToLink) => {
-  const linkend = linkElement.getAttribute("linkend");
-  if (!linkend) {
-    return [];
-  }
-  const isLinkFootnoteCue = linkElement.tagName.toUpperCase() === FOOTNOTE_LINK_SCHEMA.tag;
-  if (isLinkFootnoteCue) {
-    if (findElementLinkedTo(linkend, elementsToLink)) {
-      return [];
-    }
-    return [
-      createValidationIssue({
-        store: getStore(linkElement),
-        title: "Unlinked footnote cue",
-        kind: "unlinked",
-        description: "This footnote cue is not referenced to any footnote in this chapter. Please link it again manually.",
-        level: "blocker"
-      })
-    ];
-  }
-  const role = linkElement.getAttribute("role");
-  if (!role) {
-    return [];
-  }
-  if (findElementLinkedTo(linkend, elementsToLink)) {
-    return [];
-  }
-  const isBlocker = LINK_BLOCKER_ROLES.includes(role.toLowerCase());
-  return [
-    createValidationIssue({
-      store: getStore(linkElement),
-      title: "Unlinked element",
-      kind: "unlinked",
-      description: "This link is not referenced to any element in the current chapter or any other chapter. Please link it again manually.",
-      level: isBlocker ? "blocker" : "warning"
-    })
-  ];
-};
-
 // src/validation/validateAttributes.ts
 var validateAttributes = (element, schema) => {
   const errors = [];
@@ -2878,21 +2915,6 @@ var validateChildren = (element, schema) => {
   return errors;
 };
 
-// src/validation/utils/getLinkableRoles.ts
-var getLinkableRoles = () => {
-  const linkRoleDefinition = findAttributeDefinitionByName(
-    LINK_SCHEMA.requiredAttributes,
-    "role"
-  );
-  if (!linkRoleDefinition) {
-    return [];
-  }
-  if (isAttributeRestricted(linkRoleDefinition)) {
-    return linkRoleDefinition.values;
-  }
-  return [];
-};
-
 // src/validation/validateReferences.ts
 var findElementLinkedTo2 = (xmlid, linkElements) => {
   return linkElements.includes(xmlid);
@@ -2916,6 +2938,33 @@ var validateReferenceCited = (referenceElement, linkElements) => {
   ];
 };
 
+// src/validation/validateUri.ts
+var WEB_URI_REGEX = /^(?:(?:https?):\/\/)?(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}(?::\d{1,5})?(?:\/[^\s]*)?$/i;
+var isValidUri = (uri) => {
+  if (!uri || /\s/.test(uri)) {
+    return false;
+  }
+  if (/^[a-z][a-z0-9+.-]*:/i.test(uri) && !/^https?:\/\//i.test(uri)) {
+    return false;
+  }
+  return WEB_URI_REGEX.test(uri);
+};
+var validateUri = (uriElement) => {
+  const url = uriElement.textContent.trim();
+  if (isValidUri(url)) {
+    return [];
+  }
+  return [
+    createValidationIssue({
+      store: getStore(uriElement),
+      title: "URL cannot be reached",
+      kind: "unlinked",
+      description: "URL cannot be reached. Please check and adjust.",
+      level: "warning"
+    })
+  ];
+};
+
 // src/validation/validateXml.ts
 var validateElement = (element, root, elementsToLink, linkElements, schemasToValidateAgainst) => {
   if (isIgnoredElement(element)) {
@@ -2927,16 +2976,17 @@ var validateElement = (element, root, elementsToLink, linkElements, schemasToVal
     if (schemasToValidateAgainst.includes(schema.code)) {
       errors.push(...validateElementAgainstSchema(element, schema));
     }
-    const role = element.getAttribute("role");
-    const linkableRoles = getLinkableRoles();
-    if (schema.tag === LINK_SCHEMA.tag && role && linkableRoles.includes(role) || schema.tag === FOOTNOTE_LINK_SCHEMA.tag) {
+    if (schema.tag === LINK_SCHEMA.tag || schema.tag === FOOTNOTE_LINK_SCHEMA.tag) {
       errors.push(...validateLinkend(element, elementsToLink));
     }
     if (schema.tag === BIBLIOMIXED_SCHEMA.tag) {
       errors.push(...validateReferenceCited(element, linkElements));
     }
     if (schema.tag === FOOTNOTE_SCHEMA.tag) {
-      errors.push(...validateFootnoteCue(element, root));
+      errors.push(...validateFootnoteCue(element, linkElements));
+    }
+    if (schema.tag === URI_SCHEMA.tag) {
+      errors.push(...validateUri(element));
     }
     if (isIgnoredValidation(schema.code)) {
       return errors;

package/dist/index.mjs

@@ -176,7 +176,13 @@ var INSERTION_SCHEMA = createSchema({
   tag: SPAN_TAG,
   matchesElement: (element) => element.classList.contains("ins"),
   requiredAttributes: [...TRACK_CHANGES_ATTRS, ...ID_ATTRS],
-  optionalAttributes: [],
+  optionalAttributes: [
+    {
+      name: "role",
+      values: ["web-link", "figure-note-link", "figsource"],
+      defaultValue: ""
+    }
+  ],
   allowedChildrenCodes: [
     ...ATOM_CODES_ALLOWED_CHILDREN,
     ...INLINE_ELEMENT_CODES_ALLOWED_CHILDREN
@@ -2266,8 +2272,8 @@ var URI_SCHEMA = createSchema({
   code: "uri",
   kind: "inline",
   tag: URI_TAG,
-  requiredAttributes: [...ID_ATTRS],
-  optionalAttributes: ["linkend"],
+  requiredAttributes: [],
+  optionalAttributes: ["xlinkhref"],
   allowedChildrenCodes: [...ATOM_CODES_ALLOWED_CHILDREN]
 });
 
@@ -2533,6 +2539,84 @@ var retrieveTextIgnoringNodesWithSelector = (element, selector = ".del") => {
   return clonedElement.textContent || "";
 };
 
+// src/validation/utils/getElementsSelector.ts
+var getElementsSelector = ({
+  element,
+  selector,
+  filterDeletedNodes
+}) => {
+  const elements = element.querySelectorAll(selector);
+  if (filterDeletedNodes) {
+    return Array.from(elements).filter((element2) => {
+      const hasDeletedParent = element2.closest(".del") !== null;
+      if (hasDeletedParent) {
+        return false;
+      }
+      return true;
+    });
+  }
+  return Array.from(elements);
+};
+
+// src/validation/validateLinkend.ts
+var findElementLinkedTo = (linkend, elementsToLink) => {
+  return elementsToLink.includes(linkend);
+};
+var LINK_TO_CROSS_CHECK = [
+  TABLE_LINK_ROLE,
+  FIGURE_LINK_ROLE,
+  EQUATION_LINK_ROLE,
+  FOOTNOTE_LINK_ROLE,
+  REFERENCE_LINK_ROLE
+];
+var LINK_BLOCKER_ROLES = [
+  TABLE_LINK_ROLE,
+  FIGURE_LINK_ROLE,
+  EQUATION_LINK_ROLE,
+  FOOTNOTE_LINK_ROLE
+];
+var validateLinkend = (linkElement, elementsToLink) => {
+  const linkend = linkElement.getAttribute("linkend");
+  if (!linkend) {
+    return [];
+  }
+  const isLinkFootnoteCue = linkElement.tagName.toUpperCase() === FOOTNOTE_LINK_SCHEMA.tag;
+  if (isLinkFootnoteCue) {
+    if (findElementLinkedTo(linkend, elementsToLink)) {
+      return [];
+    }
+    return [
+      createValidationIssue({
+        store: getStore(linkElement),
+        title: "Unlinked footnote cue",
+        kind: "unlinked",
+        description: "This footnote cue is not referenced to any footnote in this chapter. Please link it again manually.",
+        level: "blocker"
+      })
+    ];
+  }
+  const role = linkElement.getAttribute("role");
+  if (!role) {
+    return [];
+  }
+  if (!LINK_TO_CROSS_CHECK.includes(role)) {
+    return [];
+  }
+  if (findElementLinkedTo(linkend, elementsToLink)) {
+    return [];
+  }
+  const isBlocker = LINK_BLOCKER_ROLES.includes(role.toLowerCase());
+  return [
+    createValidationIssue({
+      store: getStore(linkElement),
+      title: "Unlinked element",
+      kind: "unlinked",
+      description: "This link is not referenced to any element in the current chapter or any other chapter. Please link it again manually.",
+      level: isBlocker ? "blocker" : "warning"
+    })
+  ];
+};
+
 // src/validation/validateFootnotes.ts
 var extractFootnoteNumber = (footnote) => {
   if (!footnote) return "no label";
@@ -2543,16 +2627,13 @@ var extractFootnoteNumber = (footnote) => {
   }
   return footnoteNumber;
 };
-var validateFootnoteCue = (footnoteElement, root) => {
+var validateFootnoteCue = (footnoteElement, linkElements) => {
   const errors = [];
   const linkend = footnoteElement.getAttribute("xmlid") || "";
   const footnoteNumber = footnoteElement.querySelector(
     FOOTNOTE_NUMBER_SCHEMA.tag
   );
-  const footnoteLink = root.querySelector(
-    `${FOOTNOTE_LINK_SCHEMA.tag}[linkend='${CSS.escape(linkend)}']`
-  );
-  if (footnoteLink) {
+  if (findElementLinkedTo(linkend, linkElements)) {
     return errors;
   }
   if (!footnoteNumber) {
@@ -2574,8 +2655,12 @@ var validateFootnoteCue = (footnoteElement, root) => {
   });
   return errors;
 };
-var validateConsecutiveFootnotes = (root) => {
-  const footnotes = Array.from(root.querySelectorAll(FOOTNOTE_SCHEMA.tag));
+var validateConsecutiveFootnotes = (element) => {
+  const footnotes = getElementsSelector({
+    element,
+    selector: FOOTNOTE_SCHEMA.tag,
+    filterDeletedNodes: true
+  });
   if (footnotes.length === 0) {
     return [];
   }
@@ -2603,10 +2688,12 @@ var validateConsecutiveFootnotes = (root) => {
   }
   return [];
 };
-var validateConsecutiveFootnoteCues = (root) => {
-  const footnoteLinks = Array.from(
-    root.querySelectorAll(FOOTNOTE_LINK_SCHEMA.tag)
-  );
+var validateConsecutiveFootnoteCues = (element) => {
+  const footnoteLinks = getElementsSelector({
+    element,
+    selector: FOOTNOTE_LINK_SCHEMA.tag,
+    filterDeletedNodes: true
+  });
   if (footnoteLinks.length === 0) {
     return [];
   }
@@ -2629,56 +2716,6 @@ var validateConsecutiveFootnoteCues = (root) => {
   return [];
 };
 
-// src/validation/validateLinkend.ts
-var findElementLinkedTo = (linkend, elementsToLink) => {
-  return elementsToLink.includes(linkend);
-};
-var LINK_BLOCKER_ROLES = [
-  TABLE_LINK_ROLE,
-  FIGURE_LINK_ROLE,
-  EQUATION_LINK_ROLE,
-  FOOTNOTE_LINK_ROLE,
-  CHAPTER_LINK_ROLE
-];
-var validateLinkend = (linkElement, elementsToLink) => {
-  const linkend = linkElement.getAttribute("linkend");
-  if (!linkend) {
-    return [];
-  }
-  const isLinkFootnoteCue = linkElement.tagName.toUpperCase() === FOOTNOTE_LINK_SCHEMA.tag;
-  if (isLinkFootnoteCue) {
-    if (findElementLinkedTo(linkend, elementsToLink)) {
-      return [];
-    }
-    return [
-      createValidationIssue({
-        store: getStore(linkElement),
-        title: "Unlinked footnote cue",
-        kind: "unlinked",
-        description: "This footnote cue is not referenced to any footnote in this chapter. Please link it again manually.",
-        level: "blocker"
-      })
-    ];
-  }
-  const role = linkElement.getAttribute("role");
-  if (!role) {
-    return [];
-  }
-  if (findElementLinkedTo(linkend, elementsToLink)) {
-    return [];
-  }
-  const isBlocker = LINK_BLOCKER_ROLES.includes(role.toLowerCase());
-  return [
-    createValidationIssue({
-      store: getStore(linkElement),
-      title: "Unlinked element",
-      kind: "unlinked",
-      description: "This link is not referenced to any element in the current chapter or any other chapter. Please link it again manually.",
-      level: isBlocker ? "blocker" : "warning"
-    })
-  ];
-};
-
 // src/validation/validateAttributes.ts
 var validateAttributes = (element, schema) => {
   const errors = [];
@@ -2810,21 +2847,6 @@ var validateChildren = (element, schema) => {
   return errors;
 };
 
-// src/validation/utils/getLinkableRoles.ts
-var getLinkableRoles = () => {
-  const linkRoleDefinition = findAttributeDefinitionByName(
-    LINK_SCHEMA.requiredAttributes,
-    "role"
-  );
-  if (!linkRoleDefinition) {
-    return [];
-  }
-  if (isAttributeRestricted(linkRoleDefinition)) {
-    return linkRoleDefinition.values;
-  }
-  return [];
-};
-
 // src/validation/validateReferences.ts
 var findElementLinkedTo2 = (xmlid, linkElements) => {
   return linkElements.includes(xmlid);
@@ -2848,6 +2870,33 @@ var validateReferenceCited = (referenceElement, linkElements) => {
   ];
 };
 
+// src/validation/validateUri.ts
+var WEB_URI_REGEX = /^(?:(?:https?):\/\/)?(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}(?::\d{1,5})?(?:\/[^\s]*)?$/i;
+var isValidUri = (uri) => {
+  if (!uri || /\s/.test(uri)) {
+    return false;
+  }
+  if (/^[a-z][a-z0-9+.-]*:/i.test(uri) && !/^https?:\/\//i.test(uri)) {
+    return false;
+  }
+  return WEB_URI_REGEX.test(uri);
+};
+var validateUri = (uriElement) => {
+  const url = uriElement.textContent.trim();
+  if (isValidUri(url)) {
+    return [];
+  }
+  return [
+    createValidationIssue({
+      store: getStore(uriElement),
+      title: "URL cannot be reached",
+      kind: "unlinked",
+      description: "URL cannot be reached. Please check and adjust.",
+      level: "warning"
+    })
+  ];
+};
+
 // src/validation/validateXml.ts
 var validateElement = (element, root, elementsToLink, linkElements, schemasToValidateAgainst) => {
   if (isIgnoredElement(element)) {
@@ -2859,16 +2908,17 @@ var validateElement = (element, root, elementsToLink, linkElements, schemasToVal
     if (schemasToValidateAgainst.includes(schema.code)) {
       errors.push(...validateElementAgainstSchema(element, schema));
     }
-    const role = element.getAttribute("role");
-    const linkableRoles = getLinkableRoles();
-    if (schema.tag === LINK_SCHEMA.tag && role && linkableRoles.includes(role) || schema.tag === FOOTNOTE_LINK_SCHEMA.tag) {
+    if (schema.tag === LINK_SCHEMA.tag || schema.tag === FOOTNOTE_LINK_SCHEMA.tag) {
       errors.push(...validateLinkend(element, elementsToLink));
     }
     if (schema.tag === BIBLIOMIXED_SCHEMA.tag) {
       errors.push(...validateReferenceCited(element, linkElements));
     }
     if (schema.tag === FOOTNOTE_SCHEMA.tag) {
-      errors.push(...validateFootnoteCue(element, root));
+      errors.push(...validateFootnoteCue(element, linkElements));
+    }
+    if (schema.tag === URI_SCHEMA.tag) {
+      errors.push(...validateUri(element));
     }
     if (isIgnoredValidation(schema.code)) {
       return errors;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pro-editor-schema",
-  "version": "0.2.21",
+  "version": "0.2.24",
   "description": "Pro Editor XML schemas",
   "main": "dist/index.js",
   "module": "dist/index.mjs",