pro-editor-schema 0.1.182 → 0.1.184

package/dist/index.d.mts

@@ -10,6 +10,11 @@ type AllowedChildren = {
     tagName: string;
     required: boolean;
 };
+type ResolveTo = "unwrap" | "skip" | "remove";
+type ForbiddenElement = {
+    code: SchemaCode;
+    resolveTo?: ResolveTo;
+};
 type Schema<TRequiredAttributes = readonly AttributeDefinition[], TOptionalAttributes = readonly AttributeDefinition[]> = {
     code: SchemaCode;
     kind: SchemaKind;
@@ -18,7 +23,7 @@ type Schema<TRequiredAttributes = readonly AttributeDefinition[], TOptionalAttri
     optionalAttributes: TOptionalAttributes;
     defaultChildTagName?: string;
     allowedChildTagNames: ReadonlySet<AllowedChildren>;
-    unhierarchicalAllowedChildTagNames?: readonly string[];
+    forbiddenElements?: ReadonlySet<ForbiddenElement>;
 };
 type SchemaCode = ElementSchemaCode | InlineSchemaCode | AtomSchemaCode;
 type ElementSchemaCode = "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";
@@ -103,4 +108,4 @@ type ValidationError = {
  */
 declare const validateXml: (xml: Element, elementsLinkedTo: readonly string[], shouldValidateAgainstSchema?: boolean) => ValidationError[];
 
-export { ALIGNMENT_ATTRIBUTE, ATOM_SCHEMAS, type AllowedChildren, type AtomSchemaCode, type AttributeDefinition, ELEMENT_SCHEMAS, ELE_ID_ATTRIBUTE, type ElementSchemaCode, FIGURE_PLACEMENT_ATTRIBUTE, type FreeAttribute, ID_ATTRS, IGNORED_ATTRIBUTES, IGNORED_ATTRIBUTES_STARTS_WITH, IGNORED_ELEMENT_SELECTORS, INDENT_TYPE_ATTRIBUTE, INLINE_ELEMENT_SCHEMAS, type InlineSchemaCode, LAYOUT_ATTRIBUTES, LAYOUT_CELL_WIDTH, LAYOUT_USER_ATTRIBUTE, LEFT_INDENT_ATTRIBUTE, ORIENTATION_ATTRIBUTE, PLACEMENT_ATTRIBUTE, RIGHT_INDENT_ATTRIBUTE, type RestrictedAttribute, SCHEMAS, SPACE_ABOVE_ATTRIBUTE, SPACE_BELOW_ATTRIBUTE, SPECIAL_INDENT_ATTRIBUTE, STORE_ATTRIBUTE, STYLE_NAME_ATTRIBUTE, type Schema, type SchemaCode, type SchemaKind, TRACK_CHANGES_ATTRS, TRACK_CHANGES_ATTR_DATA_DATE, TRACK_CHANGES_ATTR_DATA_TIME, TRACK_CHANGES_ATTR_DATA_USERID, TRACK_CHANGES_ATTR_DATA_USERNAME, type ValidationError, type ValidationErrorKind, type ValidationErrorLevel, createElement, findAttributeDefinitionByName, findSchemaByCode, findSchemaByElement, getAttributeName, isAttributeRestricted, isIgnoredAttribute, isIgnoredElement, validateXml };
+export { ALIGNMENT_ATTRIBUTE, ATOM_SCHEMAS, type AllowedChildren, type AtomSchemaCode, type AttributeDefinition, ELEMENT_SCHEMAS, ELE_ID_ATTRIBUTE, type ElementSchemaCode, FIGURE_PLACEMENT_ATTRIBUTE, type ForbiddenElement, type FreeAttribute, ID_ATTRS, IGNORED_ATTRIBUTES, IGNORED_ATTRIBUTES_STARTS_WITH, IGNORED_ELEMENT_SELECTORS, INDENT_TYPE_ATTRIBUTE, INLINE_ELEMENT_SCHEMAS, type InlineSchemaCode, LAYOUT_ATTRIBUTES, LAYOUT_CELL_WIDTH, LAYOUT_USER_ATTRIBUTE, LEFT_INDENT_ATTRIBUTE, ORIENTATION_ATTRIBUTE, PLACEMENT_ATTRIBUTE, RIGHT_INDENT_ATTRIBUTE, type ResolveTo, type RestrictedAttribute, SCHEMAS, SPACE_ABOVE_ATTRIBUTE, SPACE_BELOW_ATTRIBUTE, SPECIAL_INDENT_ATTRIBUTE, STORE_ATTRIBUTE, STYLE_NAME_ATTRIBUTE, type Schema, type SchemaCode, type SchemaKind, TRACK_CHANGES_ATTRS, TRACK_CHANGES_ATTR_DATA_DATE, TRACK_CHANGES_ATTR_DATA_TIME, TRACK_CHANGES_ATTR_DATA_USERID, TRACK_CHANGES_ATTR_DATA_USERNAME, type ValidationError, type ValidationErrorKind, type ValidationErrorLevel, createElement, findAttributeDefinitionByName, findSchemaByCode, findSchemaByElement, getAttributeName, isAttributeRestricted, isIgnoredAttribute, isIgnoredElement, validateXml };

package/dist/index.d.ts

@@ -10,6 +10,11 @@ type AllowedChildren = {
     tagName: string;
     required: boolean;
 };
+type ResolveTo = "unwrap" | "skip" | "remove";
+type ForbiddenElement = {
+    code: SchemaCode;
+    resolveTo?: ResolveTo;
+};
 type Schema<TRequiredAttributes = readonly AttributeDefinition[], TOptionalAttributes = readonly AttributeDefinition[]> = {
     code: SchemaCode;
     kind: SchemaKind;
@@ -18,7 +23,7 @@ type Schema<TRequiredAttributes = readonly AttributeDefinition[], TOptionalAttri
     optionalAttributes: TOptionalAttributes;
     defaultChildTagName?: string;
     allowedChildTagNames: ReadonlySet<AllowedChildren>;
-    unhierarchicalAllowedChildTagNames?: readonly string[];
+    forbiddenElements?: ReadonlySet<ForbiddenElement>;
 };
 type SchemaCode = ElementSchemaCode | InlineSchemaCode | AtomSchemaCode;
 type ElementSchemaCode = "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";
@@ -103,4 +108,4 @@ type ValidationError = {
  */
 declare const validateXml: (xml: Element, elementsLinkedTo: readonly string[], shouldValidateAgainstSchema?: boolean) => ValidationError[];
 
-export { ALIGNMENT_ATTRIBUTE, ATOM_SCHEMAS, type AllowedChildren, type AtomSchemaCode, type AttributeDefinition, ELEMENT_SCHEMAS, ELE_ID_ATTRIBUTE, type ElementSchemaCode, FIGURE_PLACEMENT_ATTRIBUTE, type FreeAttribute, ID_ATTRS, IGNORED_ATTRIBUTES, IGNORED_ATTRIBUTES_STARTS_WITH, IGNORED_ELEMENT_SELECTORS, INDENT_TYPE_ATTRIBUTE, INLINE_ELEMENT_SCHEMAS, type InlineSchemaCode, LAYOUT_ATTRIBUTES, LAYOUT_CELL_WIDTH, LAYOUT_USER_ATTRIBUTE, LEFT_INDENT_ATTRIBUTE, ORIENTATION_ATTRIBUTE, PLACEMENT_ATTRIBUTE, RIGHT_INDENT_ATTRIBUTE, type RestrictedAttribute, SCHEMAS, SPACE_ABOVE_ATTRIBUTE, SPACE_BELOW_ATTRIBUTE, SPECIAL_INDENT_ATTRIBUTE, STORE_ATTRIBUTE, STYLE_NAME_ATTRIBUTE, type Schema, type SchemaCode, type SchemaKind, TRACK_CHANGES_ATTRS, TRACK_CHANGES_ATTR_DATA_DATE, TRACK_CHANGES_ATTR_DATA_TIME, TRACK_CHANGES_ATTR_DATA_USERID, TRACK_CHANGES_ATTR_DATA_USERNAME, type ValidationError, type ValidationErrorKind, type ValidationErrorLevel, createElement, findAttributeDefinitionByName, findSchemaByCode, findSchemaByElement, getAttributeName, isAttributeRestricted, isIgnoredAttribute, isIgnoredElement, validateXml };
+export { ALIGNMENT_ATTRIBUTE, ATOM_SCHEMAS, type AllowedChildren, type AtomSchemaCode, type AttributeDefinition, ELEMENT_SCHEMAS, ELE_ID_ATTRIBUTE, type ElementSchemaCode, FIGURE_PLACEMENT_ATTRIBUTE, type ForbiddenElement, type FreeAttribute, ID_ATTRS, IGNORED_ATTRIBUTES, IGNORED_ATTRIBUTES_STARTS_WITH, IGNORED_ELEMENT_SELECTORS, INDENT_TYPE_ATTRIBUTE, INLINE_ELEMENT_SCHEMAS, type InlineSchemaCode, LAYOUT_ATTRIBUTES, LAYOUT_CELL_WIDTH, LAYOUT_USER_ATTRIBUTE, LEFT_INDENT_ATTRIBUTE, ORIENTATION_ATTRIBUTE, PLACEMENT_ATTRIBUTE, RIGHT_INDENT_ATTRIBUTE, type ResolveTo, type RestrictedAttribute, SCHEMAS, SPACE_ABOVE_ATTRIBUTE, SPACE_BELOW_ATTRIBUTE, SPECIAL_INDENT_ATTRIBUTE, STORE_ATTRIBUTE, STYLE_NAME_ATTRIBUTE, type Schema, type SchemaCode, type SchemaKind, TRACK_CHANGES_ATTRS, TRACK_CHANGES_ATTR_DATA_DATE, TRACK_CHANGES_ATTR_DATA_TIME, TRACK_CHANGES_ATTR_DATA_USERID, TRACK_CHANGES_ATTR_DATA_USERNAME, type ValidationError, type ValidationErrorKind, type ValidationErrorLevel, createElement, findAttributeDefinitionByName, findSchemaByCode, findSchemaByElement, getAttributeName, isAttributeRestricted, isIgnoredAttribute, isIgnoredElement, validateXml };

package/dist/index.js

@@ -70,7 +70,7 @@ var createSchema = ({
   optionalAttributes,
   defaultChildTagName,
   allowedChildTagNames,
-  unhierarchicalAllowedChildTagNames
+  forbiddenElements
 }) => {
   return {
     code,
@@ -80,7 +80,7 @@ var createSchema = ({
     optionalAttributes,
     defaultChildTagName,
     allowedChildTagNames: new Set(allowedChildTagNames),
-    unhierarchicalAllowedChildTagNames
+    forbiddenElements: new Set(forbiddenElements)
   };
 };
 
@@ -858,7 +858,13 @@ var EQUATION_SCHEMA = createSchema({
       defaultValue: "added"
     }
   ],
-  allowedChildTagNames: [{ tagName: MATHPHRASE_TAG, required: true }]
+  allowedChildTagNames: [
+    { tagName: MATHPHRASE_TAG, required: true },
+    {
+      tagName: CAPTION_TAG,
+      required: false
+    }
+  ]
 });
 
 // src/schema/shared/allowedMathChildren.ts
@@ -896,7 +902,8 @@ var MATH_SCHEMA = createSchema({
   kind: "element",
   tag: MATH_TAG,
   requiredAttributes: [],
-  optionalAttributes: ["xmlns"],
+  optionalAttributes: ["xmlns", "display"],
+  defaultChildTagName: MI_TAG,
   allowedChildTagNames: [...MATH_PRESENTATION_TAGS_ALLOWED_CHILDREN]
 });
 
@@ -2022,8 +2029,18 @@ var MATHPHRASE_SCHEMA = createSchema({
   tag: MATHPHRASE_TAG,
   requiredAttributes: [ELE_ID_ATTRIBUTE],
   optionalAttributes: [],
-  allowedChildTagNames: [{ tagName: MATH_TAG, required: true }],
-  unhierarchicalAllowedChildTagNames: [SPAN_TAG]
+  allowedChildTagNames: [
+    { tagName: MATH_TAG, required: true },
+    {
+      tagName: SPAN_TAG,
+      required: false
+    }
+  ],
+  forbiddenElements: [
+    { code: QUERY_SCHEMA.code, resolveTo: "skip" },
+    { code: COMMENT_SCHEMA.code, resolveTo: "skip" },
+    { code: COMMENT_QUERY_SECTION_SCHEMA.code, resolveTo: "skip" }
+  ]
 });
 
 // src/schema/elementSchemas/elements/index.ts
@@ -2584,6 +2601,21 @@ var validateChildren = (element, schema) => {
       });
       continue;
     }
+    if (schema.forbiddenElements) {
+      const forbiddenChild = Array.from(schema.forbiddenElements).find(
+        (candidate) => candidate.code === childSchema.code
+      );
+      if (forbiddenChild) {
+        addValidationIssue(errors, {
+          store: getStore(child),
+          title: `Forbidden element ${child.tagName}`,
+          level: "blocker",
+          kind: "forbidden",
+          description: `The element ${childSchema.code} is not permitted within ${schema.tag} content. Please delete the element or move it to a different location.`
+        });
+        continue;
+      }
+    }
     errors.push(...validateElementAgainstSchema(child, childSchema));
   }
   for (const allowedChild of allowedChildren) {
@@ -2606,10 +2638,10 @@ var validateChildren = (element, schema) => {
   if (schema.allowedChildTagNames.size === 0 && childElements.length > 0) {
     addValidationIssue(errors, {
       store: getStore(element),
-      title: "Leaf element cannot contain child elements",
+      title: "Atom element cannot contain child elements",
       level: "warning",
       kind: "forbidden",
-      description: `The element is a leaf element and cannot contain child elements.`
+      description: `The element is an atom element and cannot contain child elements.`
     });
   }
   return errors;

package/dist/index.mjs

@@ -7,7 +7,7 @@ var createSchema = ({
   optionalAttributes,
   defaultChildTagName,
   allowedChildTagNames,
-  unhierarchicalAllowedChildTagNames
+  forbiddenElements
 }) => {
   return {
     code,
@@ -17,7 +17,7 @@ var createSchema = ({
     optionalAttributes,
     defaultChildTagName,
     allowedChildTagNames: new Set(allowedChildTagNames),
-    unhierarchicalAllowedChildTagNames
+    forbiddenElements: new Set(forbiddenElements)
   };
 };
 
@@ -795,7 +795,13 @@ var EQUATION_SCHEMA = createSchema({
       defaultValue: "added"
     }
   ],
-  allowedChildTagNames: [{ tagName: MATHPHRASE_TAG, required: true }]
+  allowedChildTagNames: [
+    { tagName: MATHPHRASE_TAG, required: true },
+    {
+      tagName: CAPTION_TAG,
+      required: false
+    }
+  ]
 });
 
 // src/schema/shared/allowedMathChildren.ts
@@ -833,7 +839,8 @@ var MATH_SCHEMA = createSchema({
   kind: "element",
   tag: MATH_TAG,
   requiredAttributes: [],
-  optionalAttributes: ["xmlns"],
+  optionalAttributes: ["xmlns", "display"],
+  defaultChildTagName: MI_TAG,
   allowedChildTagNames: [...MATH_PRESENTATION_TAGS_ALLOWED_CHILDREN]
 });
 
@@ -1959,8 +1966,18 @@ var MATHPHRASE_SCHEMA = createSchema({
   tag: MATHPHRASE_TAG,
   requiredAttributes: [ELE_ID_ATTRIBUTE],
   optionalAttributes: [],
-  allowedChildTagNames: [{ tagName: MATH_TAG, required: true }],
-  unhierarchicalAllowedChildTagNames: [SPAN_TAG]
+  allowedChildTagNames: [
+    { tagName: MATH_TAG, required: true },
+    {
+      tagName: SPAN_TAG,
+      required: false
+    }
+  ],
+  forbiddenElements: [
+    { code: QUERY_SCHEMA.code, resolveTo: "skip" },
+    { code: COMMENT_SCHEMA.code, resolveTo: "skip" },
+    { code: COMMENT_QUERY_SECTION_SCHEMA.code, resolveTo: "skip" }
+  ]
 });
 
 // src/schema/elementSchemas/elements/index.ts
@@ -2521,6 +2538,21 @@ var validateChildren = (element, schema) => {
       });
       continue;
     }
+    if (schema.forbiddenElements) {
+      const forbiddenChild = Array.from(schema.forbiddenElements).find(
+        (candidate) => candidate.code === childSchema.code
+      );
+      if (forbiddenChild) {
+        addValidationIssue(errors, {
+          store: getStore(child),
+          title: `Forbidden element ${child.tagName}`,
+          level: "blocker",
+          kind: "forbidden",
+          description: `The element ${childSchema.code} is not permitted within ${schema.tag} content. Please delete the element or move it to a different location.`
+        });
+        continue;
+      }
+    }
     errors.push(...validateElementAgainstSchema(child, childSchema));
   }
   for (const allowedChild of allowedChildren) {
@@ -2543,10 +2575,10 @@ var validateChildren = (element, schema) => {
   if (schema.allowedChildTagNames.size === 0 && childElements.length > 0) {
     addValidationIssue(errors, {
       store: getStore(element),
-      title: "Leaf element cannot contain child elements",
+      title: "Atom element cannot contain child elements",
       level: "warning",
       kind: "forbidden",
-      description: `The element is a leaf element and cannot contain child elements.`
+      description: `The element is an atom element and cannot contain child elements.`
     });
   }
   return errors;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pro-editor-schema",
-  "version": "0.1.182",
+  "version": "0.1.184",
   "description": "Pro Editor XML schemas",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -17,6 +17,7 @@
   ],
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
     "typecheck": "tsc --noEmit",
     "test": "vitest run",
     "test:watch": "vitest"