pro-editor-schema 0.1.183 → 0.1.185

package/dist/index.d.mts

@@ -34,8 +34,8 @@ declare const SCHEMAS: Record<SchemaCode, Schema>;
 
 declare const isIgnoredAttribute: (attribute: string) => boolean;
 declare const isIgnoredElement: (element: Element) => boolean;
-declare const findSchemaByCode: (code: SchemaCode) => Schema | undefined;
-declare const findSchemaByElement: (element: Element) => Schema | undefined;
+declare const findSchemaByCode: (code: SchemaCode) => Schema;
+declare const findSchemaByElement: (element: Element) => Schema;
 declare const isAttributeRestricted: (attr: AttributeDefinition) => attr is RestrictedAttribute;
 declare const getAttributeName: (attribute: AttributeDefinition) => string;
 declare const findAttributeDefinitionByName: (definitions: readonly AttributeDefinition[], name: string) => AttributeDefinition | undefined;
@@ -102,10 +102,10 @@ type ValidationError = {
  
  * @param xml - The XML document to validate.
  * @param elementsLinkedTo - The elements IDs that are linked to.
- * @param shouldValidateAgainstSchema - Whether to validate against the schema.
+ * @param schemasToValidateAgainst - The schemas to validate against.
  * * ValidateConsecutiveFootnotes and ValidateConsecutiveFootnoteCues are default validations.
  * @returns The validation errors.
  */
-declare const validateXml: (xml: Element, elementsLinkedTo: readonly string[], shouldValidateAgainstSchema?: boolean) => ValidationError[];
+declare const validateXml: (xml: Element, elementsLinkedTo: readonly string[], schemasToValidateAgainst: SchemaCode[]) => ValidationError[];
 
 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

@@ -34,8 +34,8 @@ declare const SCHEMAS: Record<SchemaCode, Schema>;
 
 declare const isIgnoredAttribute: (attribute: string) => boolean;
 declare const isIgnoredElement: (element: Element) => boolean;
-declare const findSchemaByCode: (code: SchemaCode) => Schema | undefined;
-declare const findSchemaByElement: (element: Element) => Schema | undefined;
+declare const findSchemaByCode: (code: SchemaCode) => Schema;
+declare const findSchemaByElement: (element: Element) => Schema;
 declare const isAttributeRestricted: (attr: AttributeDefinition) => attr is RestrictedAttribute;
 declare const getAttributeName: (attribute: AttributeDefinition) => string;
 declare const findAttributeDefinitionByName: (definitions: readonly AttributeDefinition[], name: string) => AttributeDefinition | undefined;
@@ -102,10 +102,10 @@ type ValidationError = {
  
  * @param xml - The XML document to validate.
  * @param elementsLinkedTo - The elements IDs that are linked to.
- * @param shouldValidateAgainstSchema - Whether to validate against the schema.
+ * @param schemasToValidateAgainst - The schemas to validate against.
  * * ValidateConsecutiveFootnotes and ValidateConsecutiveFootnoteCues are default validations.
  * @returns The validation errors.
  */
-declare const validateXml: (xml: Element, elementsLinkedTo: readonly string[], shouldValidateAgainstSchema?: boolean) => ValidationError[];
+declare const validateXml: (xml: Element, elementsLinkedTo: readonly string[], schemasToValidateAgainst: SchemaCode[]) => ValidationError[];
 
 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

@@ -2037,9 +2037,9 @@ var MATHPHRASE_SCHEMA = createSchema({
     }
   ],
   forbiddenElements: [
-    { code: QUERY_SCHEMA.code, resolveTo: "remove" },
-    { code: COMMENT_SCHEMA.code, resolveTo: "remove" },
-    { code: COMMENT_QUERY_SECTION_SCHEMA.code, resolveTo: "unwrap" }
+    { code: QUERY_SCHEMA.code, resolveTo: "skip" },
+    { code: COMMENT_SCHEMA.code, resolveTo: "skip" },
+    { code: COMMENT_QUERY_SECTION_SCHEMA.code, resolveTo: "skip" }
   ]
 });
 
@@ -2272,10 +2272,7 @@ var findSchemaByElement = (element) => {
   const candidates = Object.values(SCHEMAS).filter(
     (schema) => schema.tag === element.tagName.toUpperCase()
   );
-  if (candidates.length > 0) {
-    return candidates[0];
-  }
-  return void 0;
+  return candidates[0];
 };
 var isAttributeRestricted = (attr) => typeof attr !== "string";
 var getAttributeName = (attribute) => typeof attribute === "string" ? attribute : attribute.name;
@@ -2601,6 +2598,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) {
@@ -2623,10 +2635,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;
@@ -2648,14 +2660,14 @@ var getLinkableRoles = () => {
 };
 
 // src/validation/validateXml.ts
-var validateElement = (element, root, elementsLinkedTo, shouldValidateAgainstSchema = false) => {
+var validateElement = (element, root, elementsLinkedTo, schemasToValidateAgainst) => {
   if (isIgnoredElement(element)) {
     return [];
   }
   const errors = [];
   const schema = findSchemaByElement(element);
   if (schema) {
-    if (shouldValidateAgainstSchema) {
+    if (schemasToValidateAgainst.includes(schema.code)) {
       errors.push(...validateElementAgainstSchema(element, schema));
     }
     const role = element.getAttribute("role") || "";
@@ -2668,11 +2680,18 @@ var validateElement = (element, root, elementsLinkedTo, shouldValidateAgainstSch
     }
   }
   for (const child of Array.from(element.children)) {
-    errors.push(...validateElement(child, root, elementsLinkedTo));
+    errors.push(
+      ...validateElement(
+        child,
+        root,
+        elementsLinkedTo,
+        schemasToValidateAgainst
+      )
+    );
   }
   return errors;
 };
-var validateXml = (xml, elementsLinkedTo, shouldValidateAgainstSchema) => {
+var validateXml = (xml, elementsLinkedTo, schemasToValidateAgainst) => {
   const errors = [];
   errors.push(...validateConsecutiveFootnotes(xml));
   errors.push(...validateConsecutiveFootnoteCues(xml));
@@ -2682,7 +2701,7 @@ var validateXml = (xml, elementsLinkedTo, shouldValidateAgainstSchema) => {
         child,
         xml,
         elementsLinkedTo,
-        shouldValidateAgainstSchema
+        schemasToValidateAgainst
       )
     );
   }

package/dist/index.mjs

@@ -1974,9 +1974,9 @@ var MATHPHRASE_SCHEMA = createSchema({
     }
   ],
   forbiddenElements: [
-    { code: QUERY_SCHEMA.code, resolveTo: "remove" },
-    { code: COMMENT_SCHEMA.code, resolveTo: "remove" },
-    { code: COMMENT_QUERY_SECTION_SCHEMA.code, resolveTo: "unwrap" }
+    { code: QUERY_SCHEMA.code, resolveTo: "skip" },
+    { code: COMMENT_SCHEMA.code, resolveTo: "skip" },
+    { code: COMMENT_QUERY_SECTION_SCHEMA.code, resolveTo: "skip" }
   ]
 });
 
@@ -2209,10 +2209,7 @@ var findSchemaByElement = (element) => {
   const candidates = Object.values(SCHEMAS).filter(
     (schema) => schema.tag === element.tagName.toUpperCase()
   );
-  if (candidates.length > 0) {
-    return candidates[0];
-  }
-  return void 0;
+  return candidates[0];
 };
 var isAttributeRestricted = (attr) => typeof attr !== "string";
 var getAttributeName = (attribute) => typeof attribute === "string" ? attribute : attribute.name;
@@ -2538,6 +2535,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) {
@@ -2560,10 +2572,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;
@@ -2585,14 +2597,14 @@ var getLinkableRoles = () => {
 };
 
 // src/validation/validateXml.ts
-var validateElement = (element, root, elementsLinkedTo, shouldValidateAgainstSchema = false) => {
+var validateElement = (element, root, elementsLinkedTo, schemasToValidateAgainst) => {
   if (isIgnoredElement(element)) {
     return [];
   }
   const errors = [];
   const schema = findSchemaByElement(element);
   if (schema) {
-    if (shouldValidateAgainstSchema) {
+    if (schemasToValidateAgainst.includes(schema.code)) {
       errors.push(...validateElementAgainstSchema(element, schema));
     }
     const role = element.getAttribute("role") || "";
@@ -2605,11 +2617,18 @@ var validateElement = (element, root, elementsLinkedTo, shouldValidateAgainstSch
     }
   }
   for (const child of Array.from(element.children)) {
-    errors.push(...validateElement(child, root, elementsLinkedTo));
+    errors.push(
+      ...validateElement(
+        child,
+        root,
+        elementsLinkedTo,
+        schemasToValidateAgainst
+      )
+    );
   }
   return errors;
 };
-var validateXml = (xml, elementsLinkedTo, shouldValidateAgainstSchema) => {
+var validateXml = (xml, elementsLinkedTo, schemasToValidateAgainst) => {
   const errors = [];
   errors.push(...validateConsecutiveFootnotes(xml));
   errors.push(...validateConsecutiveFootnoteCues(xml));
@@ -2619,7 +2638,7 @@ var validateXml = (xml, elementsLinkedTo, shouldValidateAgainstSchema) => {
         child,
         xml,
         elementsLinkedTo,
-        shouldValidateAgainstSchema
+        schemasToValidateAgainst
       )
     );
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pro-editor-schema",
-  "version": "0.1.183",
+  "version": "0.1.185",
   "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"