pro-editor-schema 1.1.0 → 1.1.1

package/dist/index.d.mts

@@ -17,7 +17,7 @@ type Schema<TRequiredAttributes = readonly AttributeDefinition[], TOptionalAttri
     requiredAttributes: TRequiredAttributes;
     optionalAttributes: TOptionalAttributes;
     defaultChildCode?: SchemaCode;
-    allowedChildrenCodes: AllowedChildren[];
+    allowedChildrenCodes: readonly AllowedChildren[];
     matchesElement?: (element: Element) => boolean;
 };
 type SchemaCode = ElementSchemaCode | InlineSchemaCode | AtomSchemaCode;

package/dist/index.d.ts

@@ -17,7 +17,7 @@ type Schema<TRequiredAttributes = readonly AttributeDefinition[], TOptionalAttri
     requiredAttributes: TRequiredAttributes;
     optionalAttributes: TOptionalAttributes;
     defaultChildCode?: SchemaCode;
-    allowedChildrenCodes: AllowedChildren[];
+    allowedChildrenCodes: readonly AllowedChildren[];
     matchesElement?: (element: Element) => boolean;
 };
 type SchemaCode = ElementSchemaCode | InlineSchemaCode | AtomSchemaCode;

package/dist/index.js

@@ -1353,6 +1353,7 @@ var FOOTNOTE_SCHEMA = createSchema({
     }
   ],
   optionalAttributes: [...TRACK_CHANGES_ATTRS],
+  defaultChildCode: "para",
   allowedChildrenCodes: [
     { code: "footnoteno", required: false },
     { code: "para", required: false }
@@ -1620,7 +1621,6 @@ var RRH_SCHEMA = createSchema({
   tag: RRH_TAG,
   requiredAttributes: [...ID_ATTRS],
   optionalAttributes: [],
-  defaultChildCode: "rrh",
   allowedChildrenCodes: [
     ...ATOM_CODES_ALLOWED_CHILDREN,
     { code: "phrase", required: false }
@@ -1734,7 +1734,6 @@ var HTML_TABLE_SCHEMA = createSchema({
   tag: HTML_TABLE_TAG,
   requiredAttributes: [],
   optionalAttributes: [...ID_ATTRS],
-  defaultChildCode: "table",
   allowedChildrenCodes: [
     { code: "thead", required: false },
     { code: "tbody", required: true }
@@ -2011,7 +2010,7 @@ var FOOTNOTE_SECTION_SCHEMA = createSchema({
     }
   ],
   optionalAttributes: [...TRACK_CHANGES_ATTRS],
-  defaultChildCode: "para",
+  defaultChildCode: "footnote",
   allowedChildrenCodes: [
     { code: "footnote", required: true },
     { code: "title1", required: true }
@@ -2272,12 +2271,22 @@ var URI_TAG = "URI";
 var PHRASE_TAG = "PHRASE";
 
 // src/schema/elementSchemas/inlineElements/footnoteLink.ts
+var FOOTNOTE_LINK_ROLES = ["end-ch-note", "end-bk-note"];
 var FOOTNOTE_LINK_SCHEMA = createSchema({
   code: "footnote1",
   kind: "inline",
   tag: FOOTNOTE_LINK_TAG,
-  requiredAttributes: [...ID_ATTRS],
-  optionalAttributes: ["linkend"],
+  requiredAttributes: [
+    ...ID_ATTRS,
+    {
+      name: "role",
+      values: FOOTNOTE_LINK_ROLES,
+      defaultValue: "end-ch-note"
+    },
+    "label",
+    "linkend"
+  ],
+  optionalAttributes: [],
   defaultChildCode: "sup",
   allowedChildrenCodes: [{ code: "sup", required: true }]
 });
@@ -2341,8 +2350,8 @@ var URI_SCHEMA = createSchema({
   code: "uri",
   kind: "inline",
   tag: URI_TAG,
-  requiredAttributes: [LINK_ATTRIBUTE],
-  optionalAttributes: [],
+  requiredAttributes: [...ID_ATTRS],
+  optionalAttributes: [LINK_ATTRIBUTE],
   allowedChildrenCodes: [...ATOM_CODES_ALLOWED_CHILDREN]
 });
 
@@ -2378,7 +2387,8 @@ var IGNORED_ELEMENT_SELECTORS = [
   "span.printlabel",
   "span.refIcon",
   "span.missLink",
-  "span.ref-drag"
+  "span.ref-drag",
+  "span#dummySpan"
 ];
 var IGNORED_VALIDATION_ELEMENT_SELECTORS = [
   "referenceBibliomixed"
@@ -2725,64 +2735,85 @@ var validateFootnoteCue = (footnoteElement, linkElements) => {
   return errors;
 };
 var validateConsecutiveFootnotes = (root) => {
-  const footnotes = getElementsSelector({
-    element: root,
-    selector: FOOTNOTE_SCHEMA.tag,
-    filterDeletedNodes: true
-  });
-  if (footnotes.length === 0) {
-    return [];
-  }
-  for (const [index, footnote] of footnotes.entries()) {
-    const expectedNumber = index + 1;
-    const footnoteNumberElement = footnote.querySelector(
-      FOOTNOTE_NUMBER_SCHEMA.tag
+  const errors = [];
+  for (const role of FOOTNOTE_SECTION_ROLES) {
+    const footnoteSections = root.querySelectorAll(
+      `${FOOTNOTE_SECTION_SCHEMA.tag}[role="${role}"]`
     );
-    if (!footnoteNumberElement) {
-      continue;
-    }
-    const label = extractFootnoteNumber(footnoteNumberElement);
-    if (label === expectedNumber) {
-      continue;
+    for (const footnoteSection of footnoteSections) {
+      const footnotes = getElementsSelector({
+        element: footnoteSection,
+        selector: FOOTNOTE_SCHEMA.tag,
+        filterDeletedNodes: true
+      });
+      if (footnotes.length === 0) {
+        continue;
+      }
+      for (const [index, footnote] of footnotes.entries()) {
+        const expectedNumber = index + 1;
+        const footnoteNumberElement = footnote.querySelector(
+          FOOTNOTE_NUMBER_SCHEMA.tag
+        );
+        if (!footnoteNumberElement) {
+          errors.push(
+            createValidationIssue({
+              store: getStore(footnote),
+              title: "Footnote number missing",
+              kind: "missing",
+              description: "The footnote number is missing. Please add it to the footnote.",
+              level: "blocker"
+            })
+          );
+        }
+        const label = extractFootnoteNumber(footnoteNumberElement);
+        if (label === expectedNumber) {
+          continue;
+        }
+        errors.push(
+          createValidationIssue({
+            store: getStore(footnote),
+            title: "Non-consecutive footnote numbers",
+            kind: "missing",
+            description: `Footnote numbers must be consecutive, footnote number (${label}) expected to be (${expectedNumber}). Please reorder the footnotes.`,
+            level: "warning"
+          })
+        );
+        break;
+      }
     }
-    return [
-      createValidationIssue({
-        store: getStore(footnote),
-        title: "Non-consecutive footnote numbers",
-        kind: "missing",
-        description: "Footnote numbers must be consecutive. Please reorder the footnotes.",
-        level: "warning"
-      })
-    ];
   }
-  return [];
+  return errors;
 };
 var validateConsecutiveFootnoteCues = (root) => {
-  const footnoteLinks = getElementsSelector({
-    element: root,
-    selector: FOOTNOTE_LINK_SCHEMA.tag,
-    filterDeletedNodes: true
-  });
-  if (footnoteLinks.length === 0) {
-    return [];
-  }
-  for (const [index, footnoteLink] of footnoteLinks.entries()) {
-    const expectedNumber = index + 1;
-    const label = extractFootnoteNumber(footnoteLink);
-    if (label === expectedNumber) {
+  const errors = [];
+  for (const role of FOOTNOTE_LINK_ROLES) {
+    const footnoteLinks = getElementsSelector({
+      element: root,
+      selector: `${FOOTNOTE_LINK_SCHEMA.tag}[role="${role}"]`,
+      filterDeletedNodes: true
+    });
+    if (footnoteLinks.length === 0) {
       continue;
     }
-    return [
-      createValidationIssue({
-        store: getStore(footnoteLink),
-        title: "Non-consecutive footnote cues",
-        kind: "missing",
-        description: "Footnote cues must be consecutive. Please reorder the footnote cues.",
-        level: "warning"
-      })
-    ];
+    for (const [index, footnoteLink] of footnoteLinks.entries()) {
+      const expectedNumber = index + 1;
+      const label = extractFootnoteNumber(footnoteLink);
+      if (label === expectedNumber) {
+        continue;
+      }
+      errors.push(
+        createValidationIssue({
+          store: getStore(footnoteLink),
+          title: "Non-consecutive footnote cues",
+          kind: "missing",
+          description: "Footnote cues must be consecutive. Please reorder the footnote cues.",
+          level: "warning"
+        })
+      );
+      break;
+    }
   }
-  return [];
+  return errors;
 };
 
 // src/validation/validateAttributes.ts

package/dist/index.mjs

@@ -1285,6 +1285,7 @@ var FOOTNOTE_SCHEMA = createSchema({
     }
   ],
   optionalAttributes: [...TRACK_CHANGES_ATTRS],
+  defaultChildCode: "para",
   allowedChildrenCodes: [
     { code: "footnoteno", required: false },
     { code: "para", required: false }
@@ -1552,7 +1553,6 @@ var RRH_SCHEMA = createSchema({
   tag: RRH_TAG,
   requiredAttributes: [...ID_ATTRS],
   optionalAttributes: [],
-  defaultChildCode: "rrh",
   allowedChildrenCodes: [
     ...ATOM_CODES_ALLOWED_CHILDREN,
     { code: "phrase", required: false }
@@ -1666,7 +1666,6 @@ var HTML_TABLE_SCHEMA = createSchema({
   tag: HTML_TABLE_TAG,
   requiredAttributes: [],
   optionalAttributes: [...ID_ATTRS],
-  defaultChildCode: "table",
   allowedChildrenCodes: [
     { code: "thead", required: false },
     { code: "tbody", required: true }
@@ -1943,7 +1942,7 @@ var FOOTNOTE_SECTION_SCHEMA = createSchema({
     }
   ],
   optionalAttributes: [...TRACK_CHANGES_ATTRS],
-  defaultChildCode: "para",
+  defaultChildCode: "footnote",
   allowedChildrenCodes: [
     { code: "footnote", required: true },
     { code: "title1", required: true }
@@ -2204,12 +2203,22 @@ var URI_TAG = "URI";
 var PHRASE_TAG = "PHRASE";
 
 // src/schema/elementSchemas/inlineElements/footnoteLink.ts
+var FOOTNOTE_LINK_ROLES = ["end-ch-note", "end-bk-note"];
 var FOOTNOTE_LINK_SCHEMA = createSchema({
   code: "footnote1",
   kind: "inline",
   tag: FOOTNOTE_LINK_TAG,
-  requiredAttributes: [...ID_ATTRS],
-  optionalAttributes: ["linkend"],
+  requiredAttributes: [
+    ...ID_ATTRS,
+    {
+      name: "role",
+      values: FOOTNOTE_LINK_ROLES,
+      defaultValue: "end-ch-note"
+    },
+    "label",
+    "linkend"
+  ],
+  optionalAttributes: [],
   defaultChildCode: "sup",
   allowedChildrenCodes: [{ code: "sup", required: true }]
 });
@@ -2273,8 +2282,8 @@ var URI_SCHEMA = createSchema({
   code: "uri",
   kind: "inline",
   tag: URI_TAG,
-  requiredAttributes: [LINK_ATTRIBUTE],
-  optionalAttributes: [],
+  requiredAttributes: [...ID_ATTRS],
+  optionalAttributes: [LINK_ATTRIBUTE],
   allowedChildrenCodes: [...ATOM_CODES_ALLOWED_CHILDREN]
 });
 
@@ -2310,7 +2319,8 @@ var IGNORED_ELEMENT_SELECTORS = [
   "span.printlabel",
   "span.refIcon",
   "span.missLink",
-  "span.ref-drag"
+  "span.ref-drag",
+  "span#dummySpan"
 ];
 var IGNORED_VALIDATION_ELEMENT_SELECTORS = [
   "referenceBibliomixed"
@@ -2657,64 +2667,85 @@ var validateFootnoteCue = (footnoteElement, linkElements) => {
   return errors;
 };
 var validateConsecutiveFootnotes = (root) => {
-  const footnotes = getElementsSelector({
-    element: root,
-    selector: FOOTNOTE_SCHEMA.tag,
-    filterDeletedNodes: true
-  });
-  if (footnotes.length === 0) {
-    return [];
-  }
-  for (const [index, footnote] of footnotes.entries()) {
-    const expectedNumber = index + 1;
-    const footnoteNumberElement = footnote.querySelector(
-      FOOTNOTE_NUMBER_SCHEMA.tag
+  const errors = [];
+  for (const role of FOOTNOTE_SECTION_ROLES) {
+    const footnoteSections = root.querySelectorAll(
+      `${FOOTNOTE_SECTION_SCHEMA.tag}[role="${role}"]`
     );
-    if (!footnoteNumberElement) {
-      continue;
-    }
-    const label = extractFootnoteNumber(footnoteNumberElement);
-    if (label === expectedNumber) {
-      continue;
+    for (const footnoteSection of footnoteSections) {
+      const footnotes = getElementsSelector({
+        element: footnoteSection,
+        selector: FOOTNOTE_SCHEMA.tag,
+        filterDeletedNodes: true
+      });
+      if (footnotes.length === 0) {
+        continue;
+      }
+      for (const [index, footnote] of footnotes.entries()) {
+        const expectedNumber = index + 1;
+        const footnoteNumberElement = footnote.querySelector(
+          FOOTNOTE_NUMBER_SCHEMA.tag
+        );
+        if (!footnoteNumberElement) {
+          errors.push(
+            createValidationIssue({
+              store: getStore(footnote),
+              title: "Footnote number missing",
+              kind: "missing",
+              description: "The footnote number is missing. Please add it to the footnote.",
+              level: "blocker"
+            })
+          );
+        }
+        const label = extractFootnoteNumber(footnoteNumberElement);
+        if (label === expectedNumber) {
+          continue;
+        }
+        errors.push(
+          createValidationIssue({
+            store: getStore(footnote),
+            title: "Non-consecutive footnote numbers",
+            kind: "missing",
+            description: `Footnote numbers must be consecutive, footnote number (${label}) expected to be (${expectedNumber}). Please reorder the footnotes.`,
+            level: "warning"
+          })
+        );
+        break;
+      }
     }
-    return [
-      createValidationIssue({
-        store: getStore(footnote),
-        title: "Non-consecutive footnote numbers",
-        kind: "missing",
-        description: "Footnote numbers must be consecutive. Please reorder the footnotes.",
-        level: "warning"
-      })
-    ];
   }
-  return [];
+  return errors;
 };
 var validateConsecutiveFootnoteCues = (root) => {
-  const footnoteLinks = getElementsSelector({
-    element: root,
-    selector: FOOTNOTE_LINK_SCHEMA.tag,
-    filterDeletedNodes: true
-  });
-  if (footnoteLinks.length === 0) {
-    return [];
-  }
-  for (const [index, footnoteLink] of footnoteLinks.entries()) {
-    const expectedNumber = index + 1;
-    const label = extractFootnoteNumber(footnoteLink);
-    if (label === expectedNumber) {
+  const errors = [];
+  for (const role of FOOTNOTE_LINK_ROLES) {
+    const footnoteLinks = getElementsSelector({
+      element: root,
+      selector: `${FOOTNOTE_LINK_SCHEMA.tag}[role="${role}"]`,
+      filterDeletedNodes: true
+    });
+    if (footnoteLinks.length === 0) {
       continue;
     }
-    return [
-      createValidationIssue({
-        store: getStore(footnoteLink),
-        title: "Non-consecutive footnote cues",
-        kind: "missing",
-        description: "Footnote cues must be consecutive. Please reorder the footnote cues.",
-        level: "warning"
-      })
-    ];
+    for (const [index, footnoteLink] of footnoteLinks.entries()) {
+      const expectedNumber = index + 1;
+      const label = extractFootnoteNumber(footnoteLink);
+      if (label === expectedNumber) {
+        continue;
+      }
+      errors.push(
+        createValidationIssue({
+          store: getStore(footnoteLink),
+          title: "Non-consecutive footnote cues",
+          kind: "missing",
+          description: "Footnote cues must be consecutive. Please reorder the footnote cues.",
+          level: "warning"
+        })
+      );
+      break;
+    }
   }
-  return [];
+  return errors;
 };
 
 // src/validation/validateAttributes.ts

package/package.json

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