pro-editor-schema 0.2.1 → 0.2.21

package/dist/index.d.mts

@@ -22,7 +22,7 @@ type Schema<TRequiredAttributes = readonly AttributeDefinition[], TOptionalAttri
 };
 type SchemaCode = ElementSchemaCode | InlineSchemaCode | AtomSchemaCode;
 type ElementSchemaCode = "referenceBibliomixed" | "referenceBibliography" | "bibliodiv" | "degrees" | "email" | "equation" | "fignote" | "figsource" | "firstname" | "footnote" | "footnoteno" | "honorific" | "img" | "informalfigure" | "keyword" | "label1" | "li" | "line" | "lrh" | "math" | "mathphrase" | "merror" | "mfrac" | "mi" | "mmultiscripts" | "mn" | "mo" | "mover" | "mpadded" | "mphantom" | "mprescripts" | "mroot" | "mrow" | "ms" | "mspace" | "msqrt" | "mstyle" | "msub" | "msubsup" | "msup" | "mtable" | "mtd" | "mtext" | "mtr" | "munder" | "munderover" | "olink" | "org" | "orgname" | "para" | "punc" | "rrh" | "source1" | "speaker" | "subtitle1" | "surname" | "tag" | "tblfn" | "tblsource" | "thead" | "title1" | "token" | "tp" | "abstract1" | "affiliation" | "alttext" | "appendix" | "author" | "authorgroup" | "blockquote" | "caption1" | "chapter" | "dialogue" | "epigraph" | "figure1" | "footnoteSection" | "heading" | "imageobject" | "info1" | "keywordset" | "mediaobject" | "ol" | "personname" | "poem" | "sidebar" | "table" | "table1" | "tbody" | "td" | "tgroup" | "tr" | "ul";
-type AtomSchemaCode = "indexterm" | "primary" | "secondary" | "tertiary" | "quaternary" | "bookmark" | "see" | "commentQuerySection" | "comment" | "content" | "query" | "reply" | "deletion" | "emphasis" | "highlightmark" | "i" | "insertion" | "sc" | "strike" | "sub" | "sup" | "u" | "b" | "referenceMark";
+type AtomSchemaCode = "indexterm" | "primary" | "secondary" | "tertiary" | "quaternary" | "bookmark" | "see" | "commentQuerySection" | "comment" | "content" | "query" | "reply" | "deletion" | "emphasis" | "highlightmark" | "i" | "insertion" | "sc" | "strike" | "sub" | "sup" | "u" | "b" | "referenceMark" | "abbreviation";
 type InlineSchemaCode = "footnote1" | "inlineequation" | "link" | "uri" | "phrase";
 
 declare const SCHEMAS: Record<SchemaCode, Schema>;

package/dist/index.d.ts

@@ -22,7 +22,7 @@ type Schema<TRequiredAttributes = readonly AttributeDefinition[], TOptionalAttri
 };
 type SchemaCode = ElementSchemaCode | InlineSchemaCode | AtomSchemaCode;
 type ElementSchemaCode = "referenceBibliomixed" | "referenceBibliography" | "bibliodiv" | "degrees" | "email" | "equation" | "fignote" | "figsource" | "firstname" | "footnote" | "footnoteno" | "honorific" | "img" | "informalfigure" | "keyword" | "label1" | "li" | "line" | "lrh" | "math" | "mathphrase" | "merror" | "mfrac" | "mi" | "mmultiscripts" | "mn" | "mo" | "mover" | "mpadded" | "mphantom" | "mprescripts" | "mroot" | "mrow" | "ms" | "mspace" | "msqrt" | "mstyle" | "msub" | "msubsup" | "msup" | "mtable" | "mtd" | "mtext" | "mtr" | "munder" | "munderover" | "olink" | "org" | "orgname" | "para" | "punc" | "rrh" | "source1" | "speaker" | "subtitle1" | "surname" | "tag" | "tblfn" | "tblsource" | "thead" | "title1" | "token" | "tp" | "abstract1" | "affiliation" | "alttext" | "appendix" | "author" | "authorgroup" | "blockquote" | "caption1" | "chapter" | "dialogue" | "epigraph" | "figure1" | "footnoteSection" | "heading" | "imageobject" | "info1" | "keywordset" | "mediaobject" | "ol" | "personname" | "poem" | "sidebar" | "table" | "table1" | "tbody" | "td" | "tgroup" | "tr" | "ul";
-type AtomSchemaCode = "indexterm" | "primary" | "secondary" | "tertiary" | "quaternary" | "bookmark" | "see" | "commentQuerySection" | "comment" | "content" | "query" | "reply" | "deletion" | "emphasis" | "highlightmark" | "i" | "insertion" | "sc" | "strike" | "sub" | "sup" | "u" | "b" | "referenceMark";
+type AtomSchemaCode = "indexterm" | "primary" | "secondary" | "tertiary" | "quaternary" | "bookmark" | "see" | "commentQuerySection" | "comment" | "content" | "query" | "reply" | "deletion" | "emphasis" | "highlightmark" | "i" | "insertion" | "sc" | "strike" | "sub" | "sup" | "u" | "b" | "referenceMark" | "abbreviation";
 type InlineSchemaCode = "footnote1" | "inlineequation" | "link" | "uri" | "phrase";
 
 declare const SCHEMAS: Record<SchemaCode, Schema>;

package/dist/index.js

@@ -127,11 +127,13 @@ var ATOM_CODES_ALLOWED_CHILDREN = [
   { code: "commentQuerySection", required: false },
   { code: "comment", required: false },
   { code: "query", required: false },
-  { code: "referenceMark", required: false }
+  { code: "referenceMark", required: false },
+  { code: "abbreviation", required: false }
 ];
 
 // src/schema/elementSchemas/atoms/atomTags.ts
 var B_TAG = "B";
+var ABBR_TAG = "ABBR";
 var I_TAG = "I";
 var U_TAG = "U";
 var SC_TAG = "SC";
@@ -536,6 +538,27 @@ var REFERENCE_MARK_SCHEMA = createSchema({
   allowedChildrenCodes: [...ATOM_CODES_ALLOWED_CHILDREN]
 });
 
+// src/schema/elementSchemas/atoms/abbr.ts
+var ABBR_SCHEMA = createSchema({
+  code: "abbreviation",
+  kind: "atom",
+  tag: ABBR_TAG,
+  requiredAttributes: [
+    ...ID_ATTRS,
+    "title",
+    TRACK_CHANGES_ATTR_DATA_TIME,
+    TRACK_CHANGES_ATTR_DATA_USERID,
+    TRACK_CHANGES_ATTR_DATA_USERNAME,
+    {
+      name: "data-abbr-action",
+      values: ["add", "edit"],
+      defaultValue: "add"
+    }
+  ],
+  optionalAttributes: [],
+  allowedChildrenCodes: [...ATOM_CODES_ALLOWED_CHILDREN]
+});
+
 // src/schema/elementSchemas/atoms/index.ts
 var ATOM_SCHEMAS = {
   indexterm: INDEXTERM_SCHEMA,
@@ -561,7 +584,8 @@ var ATOM_SCHEMAS = {
   content: CONTENT_SCHEMA,
   comment: COMMENT_SCHEMA,
   query: QUERY_SCHEMA,
-  reply: REPLY_SCHEMA
+  reply: REPLY_SCHEMA,
+  abbreviation: ABBR_SCHEMA
 };
 
 // src/schema/elementSchemas/elements/elementsTags.ts
@@ -2275,6 +2299,12 @@ var INLINEEQUATION_SCHEMA = createSchema({
 });
 
 // src/schema/elementSchemas/inlineElements/link.ts
+var TABLE_LINK_ROLE = "table";
+var FIGURE_LINK_ROLE = "figure";
+var EQUATION_LINK_ROLE = "equation";
+var FOOTNOTE_LINK_ROLE = "footnote";
+var REFERENCE_LINK_ROLE = "bibr";
+var CHAPTER_LINK_ROLE = "chapter";
 var LINK_SCHEMA = createSchema({
   code: "link",
   kind: "inline",
@@ -2282,14 +2312,20 @@ var LINK_SCHEMA = createSchema({
   requiredAttributes: [
     ...ID_ATTRS,
     "linkend",
-    "data-target-id",
     {
       name: "role",
-      values: ["table", "figure", "equation", "footnote", "bibr"],
-      defaultValue: ""
+      values: [
+        TABLE_LINK_ROLE,
+        FIGURE_LINK_ROLE,
+        EQUATION_LINK_ROLE,
+        FOOTNOTE_LINK_ROLE,
+        REFERENCE_LINK_ROLE,
+        CHAPTER_LINK_ROLE
+      ],
+      defaultValue: "bibr"
     }
   ],
-  optionalAttributes: [],
+  optionalAttributes: ["data-target-id"],
   allowedChildrenCodes: [...ATOM_CODES_ALLOWED_CHILDREN]
 });
 
@@ -2522,7 +2558,8 @@ var ElementLabel = {
   inlineequation: "Inline Equation",
   link: "Link",
   uri: "URI",
-  phrase: "Phrase"
+  phrase: "Phrase",
+  abbreviation: "Abbreviation"
 };
 
 // src/schema/shared/dependentsForbiddenElements.ts
@@ -2664,6 +2701,13 @@ var validateConsecutiveFootnoteCues = (root) => {
 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) {
@@ -2684,16 +2728,21 @@ var validateLinkend = (linkElement, elementsToLink) => {
       })
     ];
   }
+  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 reference chapters. Please link it again manually.",
-      level: "blocker"
+      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"
     })
   ];
 };
@@ -2727,8 +2776,8 @@ var validateAttributes = (element, schema) => {
     }
     if (!definition.values.includes(value)) {
       addValidationIssue(errors, {
-        store: element.id,
-        title: `Invalid attribute value "${value}"`,
+        store: getStore(element),
+        title: `Invalid attribute value "${value}" in element ${element.tagName}`,
         level: "warning",
         kind: "forbidden",
         description: `The attribute "${name}" has an invalid value "${value}".`
@@ -2862,7 +2911,7 @@ var validateReferenceCited = (referenceElement, linkElements) => {
       title: "Unlinked element",
       kind: "unlinked",
       description: "This reference is not cited in this chapter or any other chapter. Please add a link to this reference or delete the reference.",
-      level: "blocker"
+      level: "warning"
     })
   ];
 };

package/dist/index.mjs

@@ -59,11 +59,13 @@ var ATOM_CODES_ALLOWED_CHILDREN = [
   { code: "commentQuerySection", required: false },
   { code: "comment", required: false },
   { code: "query", required: false },
-  { code: "referenceMark", required: false }
+  { code: "referenceMark", required: false },
+  { code: "abbreviation", required: false }
 ];
 
 // src/schema/elementSchemas/atoms/atomTags.ts
 var B_TAG = "B";
+var ABBR_TAG = "ABBR";
 var I_TAG = "I";
 var U_TAG = "U";
 var SC_TAG = "SC";
@@ -468,6 +470,27 @@ var REFERENCE_MARK_SCHEMA = createSchema({
   allowedChildrenCodes: [...ATOM_CODES_ALLOWED_CHILDREN]
 });
 
+// src/schema/elementSchemas/atoms/abbr.ts
+var ABBR_SCHEMA = createSchema({
+  code: "abbreviation",
+  kind: "atom",
+  tag: ABBR_TAG,
+  requiredAttributes: [
+    ...ID_ATTRS,
+    "title",
+    TRACK_CHANGES_ATTR_DATA_TIME,
+    TRACK_CHANGES_ATTR_DATA_USERID,
+    TRACK_CHANGES_ATTR_DATA_USERNAME,
+    {
+      name: "data-abbr-action",
+      values: ["add", "edit"],
+      defaultValue: "add"
+    }
+  ],
+  optionalAttributes: [],
+  allowedChildrenCodes: [...ATOM_CODES_ALLOWED_CHILDREN]
+});
+
 // src/schema/elementSchemas/atoms/index.ts
 var ATOM_SCHEMAS = {
   indexterm: INDEXTERM_SCHEMA,
@@ -493,7 +516,8 @@ var ATOM_SCHEMAS = {
   content: CONTENT_SCHEMA,
   comment: COMMENT_SCHEMA,
   query: QUERY_SCHEMA,
-  reply: REPLY_SCHEMA
+  reply: REPLY_SCHEMA,
+  abbreviation: ABBR_SCHEMA
 };
 
 // src/schema/elementSchemas/elements/elementsTags.ts
@@ -2207,6 +2231,12 @@ var INLINEEQUATION_SCHEMA = createSchema({
 });
 
 // src/schema/elementSchemas/inlineElements/link.ts
+var TABLE_LINK_ROLE = "table";
+var FIGURE_LINK_ROLE = "figure";
+var EQUATION_LINK_ROLE = "equation";
+var FOOTNOTE_LINK_ROLE = "footnote";
+var REFERENCE_LINK_ROLE = "bibr";
+var CHAPTER_LINK_ROLE = "chapter";
 var LINK_SCHEMA = createSchema({
   code: "link",
   kind: "inline",
@@ -2214,14 +2244,20 @@ var LINK_SCHEMA = createSchema({
   requiredAttributes: [
     ...ID_ATTRS,
     "linkend",
-    "data-target-id",
     {
       name: "role",
-      values: ["table", "figure", "equation", "footnote", "bibr"],
-      defaultValue: ""
+      values: [
+        TABLE_LINK_ROLE,
+        FIGURE_LINK_ROLE,
+        EQUATION_LINK_ROLE,
+        FOOTNOTE_LINK_ROLE,
+        REFERENCE_LINK_ROLE,
+        CHAPTER_LINK_ROLE
+      ],
+      defaultValue: "bibr"
     }
   ],
-  optionalAttributes: [],
+  optionalAttributes: ["data-target-id"],
   allowedChildrenCodes: [...ATOM_CODES_ALLOWED_CHILDREN]
 });
 
@@ -2454,7 +2490,8 @@ var ElementLabel = {
   inlineequation: "Inline Equation",
   link: "Link",
   uri: "URI",
-  phrase: "Phrase"
+  phrase: "Phrase",
+  abbreviation: "Abbreviation"
 };
 
 // src/schema/shared/dependentsForbiddenElements.ts
@@ -2596,6 +2633,13 @@ var validateConsecutiveFootnoteCues = (root) => {
 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) {
@@ -2616,16 +2660,21 @@ var validateLinkend = (linkElement, elementsToLink) => {
       })
     ];
   }
+  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 reference chapters. Please link it again manually.",
-      level: "blocker"
+      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"
     })
   ];
 };
@@ -2659,8 +2708,8 @@ var validateAttributes = (element, schema) => {
     }
     if (!definition.values.includes(value)) {
       addValidationIssue(errors, {
-        store: element.id,
-        title: `Invalid attribute value "${value}"`,
+        store: getStore(element),
+        title: `Invalid attribute value "${value}" in element ${element.tagName}`,
         level: "warning",
         kind: "forbidden",
         description: `The attribute "${name}" has an invalid value "${value}".`
@@ -2794,7 +2843,7 @@ var validateReferenceCited = (referenceElement, linkElements) => {
       title: "Unlinked element",
       kind: "unlinked",
       description: "This reference is not cited in this chapter or any other chapter. Please add a link to this reference or delete the reference.",
-      level: "blocker"
+      level: "warning"
     })
   ];
 };

package/package.json

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