pro-editor-schema 1.1.9 → 1.2.1

package/README.md

@@ -197,12 +197,14 @@ const errors = validateXml(rootElement, elementsToLink, linkElements, [
 
 - Consecutive footnote number checks
 - Consecutive footnote cue checks
+- Possible weblink checks
 
 It also runs per-element checks for:
 
 - Link targets (`linkend`) on linkable elements
 - Uncited bibliographic references
 - Unreferenced footnotes
+- Heading hierarchy
 
 Schema-based attribute and child validation only runs for codes listed in `schemasToValidateAgainst`.
 

package/dist/index.d.mts

@@ -86,21 +86,9 @@ declare const SCHEMAS: {
     email: Schema<readonly ["store", "ele-id"], readonly []>;
     org: Schema<readonly ["store", "ele-id"], readonly []>;
     degrees: Schema<readonly ["store", "ele-id"], readonly []>;
-    dialogue: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", {
-        readonly name: "role";
-        readonly values: readonly ["add-element"];
-        readonly defaultValue: "add-element";
-    }]>;
-    line: Schema<readonly ["store", "ele-id"], readonly [{
-        readonly name: "role";
-        readonly values: readonly ["add-element"];
-        readonly defaultValue: "add-element";
-    }]>;
-    speaker: Schema<readonly ["store", "ele-id"], readonly [{
-        readonly name: "role";
-        readonly values: readonly ["add-element"];
-        readonly defaultValue: "add-element";
-    }]>;
+    dialogue: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "role", "trackmsg"]>;
+    line: Schema<readonly ["store", "ele-id"], readonly ["role"]>;
+    speaker: Schema<readonly ["store", "ele-id"], readonly ["role"]>;
     equation: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", {
         readonly name: "eqn-data";
         readonly values: readonly ["new", "updated"];
@@ -251,7 +239,7 @@ declare const SCHEMAS: {
         readonly values: readonly ["add-element", "change-element"];
         readonly defaultValue: "add-element";
     }]>;
-    poem: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "role"]>;
+    poem: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "role", "trackmsg"]>;
     blockquote: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "xmlid", "data-tagname", "element-change-description", {
         readonly name: "role";
         readonly values: readonly ["add-element", "extract_group", "change-element"];
@@ -441,21 +429,9 @@ declare const ELEMENT_SCHEMAS: {
     email: Schema<readonly ["store", "ele-id"], readonly []>;
     org: Schema<readonly ["store", "ele-id"], readonly []>;
     degrees: Schema<readonly ["store", "ele-id"], readonly []>;
-    dialogue: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", {
-        readonly name: "role";
-        readonly values: readonly ["add-element"];
-        readonly defaultValue: "add-element";
-    }]>;
-    line: Schema<readonly ["store", "ele-id"], readonly [{
-        readonly name: "role";
-        readonly values: readonly ["add-element"];
-        readonly defaultValue: "add-element";
-    }]>;
-    speaker: Schema<readonly ["store", "ele-id"], readonly [{
-        readonly name: "role";
-        readonly values: readonly ["add-element"];
-        readonly defaultValue: "add-element";
-    }]>;
+    dialogue: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "role", "trackmsg"]>;
+    line: Schema<readonly ["store", "ele-id"], readonly ["role"]>;
+    speaker: Schema<readonly ["store", "ele-id"], readonly ["role"]>;
     equation: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", {
         readonly name: "eqn-data";
         readonly values: readonly ["new", "updated"];
@@ -606,7 +582,7 @@ declare const ELEMENT_SCHEMAS: {
         readonly values: readonly ["add-element", "change-element"];
         readonly defaultValue: "add-element";
     }]>;
-    poem: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "role"]>;
+    poem: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "role", "trackmsg"]>;
     blockquote: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "xmlid", "data-tagname", "element-change-description", {
         readonly name: "role";
         readonly values: readonly ["add-element", "extract_group", "change-element"];

package/dist/index.d.ts

@@ -86,21 +86,9 @@ declare const SCHEMAS: {
     email: Schema<readonly ["store", "ele-id"], readonly []>;
     org: Schema<readonly ["store", "ele-id"], readonly []>;
     degrees: Schema<readonly ["store", "ele-id"], readonly []>;
-    dialogue: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", {
-        readonly name: "role";
-        readonly values: readonly ["add-element"];
-        readonly defaultValue: "add-element";
-    }]>;
-    line: Schema<readonly ["store", "ele-id"], readonly [{
-        readonly name: "role";
-        readonly values: readonly ["add-element"];
-        readonly defaultValue: "add-element";
-    }]>;
-    speaker: Schema<readonly ["store", "ele-id"], readonly [{
-        readonly name: "role";
-        readonly values: readonly ["add-element"];
-        readonly defaultValue: "add-element";
-    }]>;
+    dialogue: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "role", "trackmsg"]>;
+    line: Schema<readonly ["store", "ele-id"], readonly ["role"]>;
+    speaker: Schema<readonly ["store", "ele-id"], readonly ["role"]>;
     equation: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", {
         readonly name: "eqn-data";
         readonly values: readonly ["new", "updated"];
@@ -251,7 +239,7 @@ declare const SCHEMAS: {
         readonly values: readonly ["add-element", "change-element"];
         readonly defaultValue: "add-element";
     }]>;
-    poem: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "role"]>;
+    poem: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "role", "trackmsg"]>;
     blockquote: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "xmlid", "data-tagname", "element-change-description", {
         readonly name: "role";
         readonly values: readonly ["add-element", "extract_group", "change-element"];
@@ -441,21 +429,9 @@ declare const ELEMENT_SCHEMAS: {
     email: Schema<readonly ["store", "ele-id"], readonly []>;
     org: Schema<readonly ["store", "ele-id"], readonly []>;
     degrees: Schema<readonly ["store", "ele-id"], readonly []>;
-    dialogue: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", {
-        readonly name: "role";
-        readonly values: readonly ["add-element"];
-        readonly defaultValue: "add-element";
-    }]>;
-    line: Schema<readonly ["store", "ele-id"], readonly [{
-        readonly name: "role";
-        readonly values: readonly ["add-element"];
-        readonly defaultValue: "add-element";
-    }]>;
-    speaker: Schema<readonly ["store", "ele-id"], readonly [{
-        readonly name: "role";
-        readonly values: readonly ["add-element"];
-        readonly defaultValue: "add-element";
-    }]>;
+    dialogue: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "role", "trackmsg"]>;
+    line: Schema<readonly ["store", "ele-id"], readonly ["role"]>;
+    speaker: Schema<readonly ["store", "ele-id"], readonly ["role"]>;
     equation: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", {
         readonly name: "eqn-data";
         readonly values: readonly ["new", "updated"];
@@ -606,7 +582,7 @@ declare const ELEMENT_SCHEMAS: {
         readonly values: readonly ["add-element", "change-element"];
         readonly defaultValue: "add-element";
     }]>;
-    poem: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "role"]>;
+    poem: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "role", "trackmsg"]>;
     blockquote: Schema<readonly ["store", "ele-id"], readonly ["data-username", "data-userid", "data-time", "data-date", "xmlid", "data-tagname", "element-change-description", {
         readonly name: "role";
         readonly values: readonly ["add-element", "extract_group", "change-element"];

package/dist/index.js

@@ -839,13 +839,7 @@ var LINE_SCHEMA = createSchema({
   kind: "element",
   tag: LINE_TAG,
   requiredAttributes: [...ID_ATTRS],
-  optionalAttributes: [
-    {
-      name: "role",
-      values: ["add-element"],
-      defaultValue: "add-element"
-    }
-  ],
+  optionalAttributes: ["role"],
   allowedChildrenCodes: [
     ...ATOM_CODES_ALLOWED_CHILDREN,
     ...INLINE_ELEMENT_CODES_ALLOWED_CHILDREN
@@ -858,13 +852,7 @@ var SPEAKER_SCHEMA = createSchema({
   kind: "element",
   tag: SPEAKER_TAG,
   requiredAttributes: [...ID_ATTRS],
-  optionalAttributes: [
-    {
-      name: "role",
-      values: ["add-element"],
-      defaultValue: "add-element"
-    }
-  ],
+  optionalAttributes: ["role"],
   allowedChildrenCodes: [...ATOM_CODES_ALLOWED_CHILDREN]
 });
 
@@ -874,16 +862,10 @@ var DIALOGUE_SCHEMA = createSchema({
   kind: "element",
   tag: DIALOGUE_TAG,
   requiredAttributes: [...ID_ATTRS],
-  optionalAttributes: [
-    ...TRACK_CHANGES_ATTRS,
-    {
-      name: "role",
-      values: ["add-element"],
-      defaultValue: "add-element"
-    }
-  ],
+  optionalAttributes: [...TRACK_CHANGES_ATTRS, "role", "trackmsg"],
+  defaultChildCode: "line",
   allowedChildrenCodes: [
-    { code: "line", required: false },
+    { code: "line", required: true },
     { code: "speaker", required: true }
   ]
 });
@@ -2030,7 +2012,8 @@ var FOOTNOTE_SECTION_SCHEMA = createSchema({
 });
 
 // src/schema/elementSchemas/elements/heading.ts
-var HEADING_ROLES = ["H1", "H2", "H3", "H4", "H5", "H6", "vignette_group"];
+var HEADING_LEVEL = ["H1", "H2", "H3", "H4", "H5", "H6"];
+var HEADING_ROLES = [...HEADING_LEVEL, "vignette_group"];
 var HEADING_SCHEMA = createSchema({
   code: "heading",
   kind: "element",
@@ -2097,7 +2080,7 @@ var POEM_SCHEMA = createSchema({
   kind: "element",
   tag: POEM_TAG,
   requiredAttributes: [...ID_ATTRS],
-  optionalAttributes: [...TRACK_CHANGES_ATTRS, "role"],
+  optionalAttributes: [...TRACK_CHANGES_ATTRS, "role", "trackmsg"],
   defaultChildCode: "line",
   allowedChildrenCodes: [
     { code: "line", required: true },
@@ -2655,23 +2638,22 @@ var retrieveTextIgnoringNodesWithSelector = (element, selector = ".del") => {
   return clonedElement.textContent || "";
 };
 
+// src/validation/utils/isDeletedElement.ts
+var isDeletedElement = (element) => {
+  return !!element.closest(".del");
+};
+
 // src/validation/utils/getElementsSelector.ts
 var getElementsSelector = ({
   element,
   selector,
   filterDeletedNodes
 }) => {
-  const elements = element.querySelectorAll(selector);
+  const elements = Array.from(element.querySelectorAll(selector));
   if (filterDeletedNodes) {
-    return Array.from(elements).filter((element2) => {
-      const hasDeletedParent = element2.closest(".del") !== null;
-      if (hasDeletedParent) {
-        return false;
-      }
-      return true;
-    });
+    return elements.filter((element2) => !isDeletedElement(element2));
   }
-  return Array.from(elements);
+  return elements;
 };
 
 // src/validation/validateLinkend.ts
@@ -3056,6 +3038,97 @@ var validatePossibleWeblinks = (root) => {
   return errors;
 };
 
+// src/validation/utils/getParentElement.ts
+var getParentElement = ({
+  element,
+  schemaCode,
+  filterDeletedNodes
+}) => {
+  let current = element.parentElement;
+  while (current) {
+    const isValidParent = findSchemaByElement(current)?.code === schemaCode;
+    const isFilterDeleted = filterDeletedNodes && isDeletedElement(current);
+    if (isValidParent || isFilterDeleted) {
+      return current;
+    }
+    current = current.parentElement;
+  }
+  return void 0;
+};
+
+// src/validation/validateHeadingHierarchy.ts
+var getHierarchyLevel = (element) => {
+  const role = element.getAttribute("role");
+  if (!role) return void 0;
+  const validHeadingLevel = HEADING_LEVEL.indexOf(role) + 1;
+  if (!validHeadingLevel) return void 0;
+  return validHeadingLevel;
+};
+var validateHeadingHierarchy = (element) => {
+  const errors = [];
+  if (isDeletedElement(element)) {
+    return errors;
+  }
+  const level = getHierarchyLevel(element);
+  if (level === void 0) {
+    return errors;
+  }
+  const parentHeading = getParentElement({
+    element,
+    schemaCode: HEADING_SCHEMA.code,
+    filterDeletedNodes: true
+  });
+  if (!parentHeading) {
+    if (level !== 1) {
+      addValidationIssue(errors, {
+        store: getStore(element),
+        title: "Missing heading H1",
+        kind: "missing",
+        description: `H${level} is not under an H1. Please check the heading hierarchy.`,
+        level: "warning"
+      });
+    }
+    return errors;
+  }
+  const parentLevel = getHierarchyLevel(parentHeading);
+  if (parentLevel === void 0) {
+    return errors;
+  }
+  const expectedLevel = parentLevel + 1;
+  if (level === expectedLevel) {
+    return errors;
+  }
+  addValidationIssue(errors, {
+    store: getStore(element),
+    title: "Invalid heading hierarchy",
+    kind: "forbidden",
+    description: `H${level} cannot follow H${parentLevel} directly. Please check the heading hierarchy.`,
+    level: "warning"
+  });
+  return errors;
+};
+
+// src/validation/validateOlink.ts
+var ORCID_PATTERN = /^\d{4}-\d{4}-\d{4}-\d{4}$/;
+var validateOlink = (element) => {
+  const errors = [];
+  if (isDeletedElement(element)) {
+    return errors;
+  }
+  const text = retrieveTextIgnoringNodesWithSelector(element).trim();
+  if (ORCID_PATTERN.test(text)) {
+    return errors;
+  }
+  addValidationIssue(errors, {
+    store: getStore(element.parentElement ?? element),
+    title: "Invalid ORCID",
+    kind: "forbidden",
+    description: "The ORCiD is not the correct format. Please check it and adjust.",
+    level: "warning"
+  });
+  return errors;
+};
+
 // src/validation/validateXml.ts
 var validateElement = (element, root, elementsToLink, linkElements, schemasToValidateAgainst) => {
   if (isIgnoredElement(element)) {
@@ -3076,6 +3149,12 @@ var validateElement = (element, root, elementsToLink, linkElements, schemasToVal
     if (schema.tag === FOOTNOTE_SCHEMA.tag) {
       errors.push(...validateFootnoteCue(element, linkElements));
     }
+    if (schema.code === HEADING_SCHEMA.code) {
+      errors.push(...validateHeadingHierarchy(element));
+    }
+    if (schema.code === OLINK_SCHEMA.code) {
+      errors.push(...validateOlink(element));
+    }
     if (isIgnoredValidation(schema.code)) {
       return errors;
     }

package/dist/index.mjs

@@ -759,13 +759,7 @@ var LINE_SCHEMA = createSchema({
   kind: "element",
   tag: LINE_TAG,
   requiredAttributes: [...ID_ATTRS],
-  optionalAttributes: [
-    {
-      name: "role",
-      values: ["add-element"],
-      defaultValue: "add-element"
-    }
-  ],
+  optionalAttributes: ["role"],
   allowedChildrenCodes: [
     ...ATOM_CODES_ALLOWED_CHILDREN,
     ...INLINE_ELEMENT_CODES_ALLOWED_CHILDREN
@@ -778,13 +772,7 @@ var SPEAKER_SCHEMA = createSchema({
   kind: "element",
   tag: SPEAKER_TAG,
   requiredAttributes: [...ID_ATTRS],
-  optionalAttributes: [
-    {
-      name: "role",
-      values: ["add-element"],
-      defaultValue: "add-element"
-    }
-  ],
+  optionalAttributes: ["role"],
   allowedChildrenCodes: [...ATOM_CODES_ALLOWED_CHILDREN]
 });
 
@@ -794,16 +782,10 @@ var DIALOGUE_SCHEMA = createSchema({
   kind: "element",
   tag: DIALOGUE_TAG,
   requiredAttributes: [...ID_ATTRS],
-  optionalAttributes: [
-    ...TRACK_CHANGES_ATTRS,
-    {
-      name: "role",
-      values: ["add-element"],
-      defaultValue: "add-element"
-    }
-  ],
+  optionalAttributes: [...TRACK_CHANGES_ATTRS, "role", "trackmsg"],
+  defaultChildCode: "line",
   allowedChildrenCodes: [
-    { code: "line", required: false },
+    { code: "line", required: true },
     { code: "speaker", required: true }
   ]
 });
@@ -1950,7 +1932,8 @@ var FOOTNOTE_SECTION_SCHEMA = createSchema({
 });
 
 // src/schema/elementSchemas/elements/heading.ts
-var HEADING_ROLES = ["H1", "H2", "H3", "H4", "H5", "H6", "vignette_group"];
+var HEADING_LEVEL = ["H1", "H2", "H3", "H4", "H5", "H6"];
+var HEADING_ROLES = [...HEADING_LEVEL, "vignette_group"];
 var HEADING_SCHEMA = createSchema({
   code: "heading",
   kind: "element",
@@ -2017,7 +2000,7 @@ var POEM_SCHEMA = createSchema({
   kind: "element",
   tag: POEM_TAG,
   requiredAttributes: [...ID_ATTRS],
-  optionalAttributes: [...TRACK_CHANGES_ATTRS, "role"],
+  optionalAttributes: [...TRACK_CHANGES_ATTRS, "role", "trackmsg"],
   defaultChildCode: "line",
   allowedChildrenCodes: [
     { code: "line", required: true },
@@ -2575,23 +2558,22 @@ var retrieveTextIgnoringNodesWithSelector = (element, selector = ".del") => {
   return clonedElement.textContent || "";
 };
 
+// src/validation/utils/isDeletedElement.ts
+var isDeletedElement = (element) => {
+  return !!element.closest(".del");
+};
+
 // src/validation/utils/getElementsSelector.ts
 var getElementsSelector = ({
   element,
   selector,
   filterDeletedNodes
 }) => {
-  const elements = element.querySelectorAll(selector);
+  const elements = Array.from(element.querySelectorAll(selector));
   if (filterDeletedNodes) {
-    return Array.from(elements).filter((element2) => {
-      const hasDeletedParent = element2.closest(".del") !== null;
-      if (hasDeletedParent) {
-        return false;
-      }
-      return true;
-    });
+    return elements.filter((element2) => !isDeletedElement(element2));
   }
-  return Array.from(elements);
+  return elements;
 };
 
 // src/validation/validateLinkend.ts
@@ -2976,6 +2958,97 @@ var validatePossibleWeblinks = (root) => {
   return errors;
 };
 
+// src/validation/utils/getParentElement.ts
+var getParentElement = ({
+  element,
+  schemaCode,
+  filterDeletedNodes
+}) => {
+  let current = element.parentElement;
+  while (current) {
+    const isValidParent = findSchemaByElement(current)?.code === schemaCode;
+    const isFilterDeleted = filterDeletedNodes && isDeletedElement(current);
+    if (isValidParent || isFilterDeleted) {
+      return current;
+    }
+    current = current.parentElement;
+  }
+  return void 0;
+};
+
+// src/validation/validateHeadingHierarchy.ts
+var getHierarchyLevel = (element) => {
+  const role = element.getAttribute("role");
+  if (!role) return void 0;
+  const validHeadingLevel = HEADING_LEVEL.indexOf(role) + 1;
+  if (!validHeadingLevel) return void 0;
+  return validHeadingLevel;
+};
+var validateHeadingHierarchy = (element) => {
+  const errors = [];
+  if (isDeletedElement(element)) {
+    return errors;
+  }
+  const level = getHierarchyLevel(element);
+  if (level === void 0) {
+    return errors;
+  }
+  const parentHeading = getParentElement({
+    element,
+    schemaCode: HEADING_SCHEMA.code,
+    filterDeletedNodes: true
+  });
+  if (!parentHeading) {
+    if (level !== 1) {
+      addValidationIssue(errors, {
+        store: getStore(element),
+        title: "Missing heading H1",
+        kind: "missing",
+        description: `H${level} is not under an H1. Please check the heading hierarchy.`,
+        level: "warning"
+      });
+    }
+    return errors;
+  }
+  const parentLevel = getHierarchyLevel(parentHeading);
+  if (parentLevel === void 0) {
+    return errors;
+  }
+  const expectedLevel = parentLevel + 1;
+  if (level === expectedLevel) {
+    return errors;
+  }
+  addValidationIssue(errors, {
+    store: getStore(element),
+    title: "Invalid heading hierarchy",
+    kind: "forbidden",
+    description: `H${level} cannot follow H${parentLevel} directly. Please check the heading hierarchy.`,
+    level: "warning"
+  });
+  return errors;
+};
+
+// src/validation/validateOlink.ts
+var ORCID_PATTERN = /^\d{4}-\d{4}-\d{4}-\d{4}$/;
+var validateOlink = (element) => {
+  const errors = [];
+  if (isDeletedElement(element)) {
+    return errors;
+  }
+  const text = retrieveTextIgnoringNodesWithSelector(element).trim();
+  if (ORCID_PATTERN.test(text)) {
+    return errors;
+  }
+  addValidationIssue(errors, {
+    store: getStore(element.parentElement ?? element),
+    title: "Invalid ORCID",
+    kind: "forbidden",
+    description: "The ORCiD is not the correct format. Please check it and adjust.",
+    level: "warning"
+  });
+  return errors;
+};
+
 // src/validation/validateXml.ts
 var validateElement = (element, root, elementsToLink, linkElements, schemasToValidateAgainst) => {
   if (isIgnoredElement(element)) {
@@ -2996,6 +3069,12 @@ var validateElement = (element, root, elementsToLink, linkElements, schemasToVal
     if (schema.tag === FOOTNOTE_SCHEMA.tag) {
       errors.push(...validateFootnoteCue(element, linkElements));
     }
+    if (schema.code === HEADING_SCHEMA.code) {
+      errors.push(...validateHeadingHierarchy(element));
+    }
+    if (schema.code === OLINK_SCHEMA.code) {
+      errors.push(...validateOlink(element));
+    }
     if (isIgnoredValidation(schema.code)) {
       return errors;
     }

package/package.json

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