pro-editor-schema 0.1.181 → 0.1.183

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/index.d.mts +7 -1
  2. package/dist/index.d.ts +7 -1
  3. package/dist/index.js +22 -5
  4. package/dist/index.mjs +22 -5
  5. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -10,6 +10,11 @@ type AllowedChildren = {
10
10
  tagName: string;
11
11
  required: boolean;
12
12
  };
13
+ type ResolveTo = "unwrap" | "skip" | "remove";
14
+ type ForbiddenElement = {
15
+ code: SchemaCode;
16
+ resolveTo?: ResolveTo;
17
+ };
13
18
  type Schema<TRequiredAttributes = readonly AttributeDefinition[], TOptionalAttributes = readonly AttributeDefinition[]> = {
14
19
  code: SchemaCode;
15
20
  kind: SchemaKind;
@@ -18,6 +23,7 @@ type Schema<TRequiredAttributes = readonly AttributeDefinition[], TOptionalAttri
18
23
  optionalAttributes: TOptionalAttributes;
19
24
  defaultChildTagName?: string;
20
25
  allowedChildTagNames: ReadonlySet<AllowedChildren>;
26
+ forbiddenElements?: ReadonlySet<ForbiddenElement>;
21
27
  };
22
28
  type SchemaCode = ElementSchemaCode | InlineSchemaCode | AtomSchemaCode;
23
29
  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";
@@ -102,4 +108,4 @@ type ValidationError = {
102
108
  */
103
109
  declare const validateXml: (xml: Element, elementsLinkedTo: readonly string[], shouldValidateAgainstSchema?: boolean) => ValidationError[];
104
110
 
105
- 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 };
111
+ 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 CHANGED
@@ -10,6 +10,11 @@ type AllowedChildren = {
10
10
  tagName: string;
11
11
  required: boolean;
12
12
  };
13
+ type ResolveTo = "unwrap" | "skip" | "remove";
14
+ type ForbiddenElement = {
15
+ code: SchemaCode;
16
+ resolveTo?: ResolveTo;
17
+ };
13
18
  type Schema<TRequiredAttributes = readonly AttributeDefinition[], TOptionalAttributes = readonly AttributeDefinition[]> = {
14
19
  code: SchemaCode;
15
20
  kind: SchemaKind;
@@ -18,6 +23,7 @@ type Schema<TRequiredAttributes = readonly AttributeDefinition[], TOptionalAttri
18
23
  optionalAttributes: TOptionalAttributes;
19
24
  defaultChildTagName?: string;
20
25
  allowedChildTagNames: ReadonlySet<AllowedChildren>;
26
+ forbiddenElements?: ReadonlySet<ForbiddenElement>;
21
27
  };
22
28
  type SchemaCode = ElementSchemaCode | InlineSchemaCode | AtomSchemaCode;
23
29
  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";
@@ -102,4 +108,4 @@ type ValidationError = {
102
108
  */
103
109
  declare const validateXml: (xml: Element, elementsLinkedTo: readonly string[], shouldValidateAgainstSchema?: boolean) => ValidationError[];
104
110
 
105
- 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 };
111
+ 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 CHANGED
@@ -69,7 +69,8 @@ var createSchema = ({
69
69
  requiredAttributes,
70
70
  optionalAttributes,
71
71
  defaultChildTagName,
72
- allowedChildTagNames
72
+ allowedChildTagNames,
73
+ forbiddenElements
73
74
  }) => {
74
75
  return {
75
76
  code,
@@ -78,7 +79,8 @@ var createSchema = ({
78
79
  requiredAttributes,
79
80
  optionalAttributes,
80
81
  defaultChildTagName,
81
- allowedChildTagNames: new Set(allowedChildTagNames)
82
+ allowedChildTagNames: new Set(allowedChildTagNames),
83
+ forbiddenElements: new Set(forbiddenElements)
82
84
  };
83
85
  };
84
86
 
@@ -856,7 +858,13 @@ var EQUATION_SCHEMA = createSchema({
856
858
  defaultValue: "added"
857
859
  }
858
860
  ],
859
- allowedChildTagNames: [{ tagName: MATHPHRASE_TAG, required: true }]
861
+ allowedChildTagNames: [
862
+ { tagName: MATHPHRASE_TAG, required: true },
863
+ {
864
+ tagName: CAPTION_TAG,
865
+ required: false
866
+ }
867
+ ]
860
868
  });
861
869
 
862
870
  // src/schema/shared/allowedMathChildren.ts
@@ -894,7 +902,8 @@ var MATH_SCHEMA = createSchema({
894
902
  kind: "element",
895
903
  tag: MATH_TAG,
896
904
  requiredAttributes: [],
897
- optionalAttributes: ["xmlns"],
905
+ optionalAttributes: ["xmlns", "display"],
906
+ defaultChildTagName: MI_TAG,
898
907
  allowedChildTagNames: [...MATH_PRESENTATION_TAGS_ALLOWED_CHILDREN]
899
908
  });
900
909
 
@@ -2022,7 +2031,15 @@ var MATHPHRASE_SCHEMA = createSchema({
2022
2031
  optionalAttributes: [],
2023
2032
  allowedChildTagNames: [
2024
2033
  { tagName: MATH_TAG, required: true },
2025
- { tagName: SPAN_TAG, required: false }
2034
+ {
2035
+ tagName: SPAN_TAG,
2036
+ required: false
2037
+ }
2038
+ ],
2039
+ forbiddenElements: [
2040
+ { code: QUERY_SCHEMA.code, resolveTo: "remove" },
2041
+ { code: COMMENT_SCHEMA.code, resolveTo: "remove" },
2042
+ { code: COMMENT_QUERY_SECTION_SCHEMA.code, resolveTo: "unwrap" }
2026
2043
  ]
2027
2044
  });
2028
2045
 
package/dist/index.mjs CHANGED
@@ -6,7 +6,8 @@ var createSchema = ({
6
6
  requiredAttributes,
7
7
  optionalAttributes,
8
8
  defaultChildTagName,
9
- allowedChildTagNames
9
+ allowedChildTagNames,
10
+ forbiddenElements
10
11
  }) => {
11
12
  return {
12
13
  code,
@@ -15,7 +16,8 @@ var createSchema = ({
15
16
  requiredAttributes,
16
17
  optionalAttributes,
17
18
  defaultChildTagName,
18
- allowedChildTagNames: new Set(allowedChildTagNames)
19
+ allowedChildTagNames: new Set(allowedChildTagNames),
20
+ forbiddenElements: new Set(forbiddenElements)
19
21
  };
20
22
  };
21
23
 
@@ -793,7 +795,13 @@ var EQUATION_SCHEMA = createSchema({
793
795
  defaultValue: "added"
794
796
  }
795
797
  ],
796
- allowedChildTagNames: [{ tagName: MATHPHRASE_TAG, required: true }]
798
+ allowedChildTagNames: [
799
+ { tagName: MATHPHRASE_TAG, required: true },
800
+ {
801
+ tagName: CAPTION_TAG,
802
+ required: false
803
+ }
804
+ ]
797
805
  });
798
806
 
799
807
  // src/schema/shared/allowedMathChildren.ts
@@ -831,7 +839,8 @@ var MATH_SCHEMA = createSchema({
831
839
  kind: "element",
832
840
  tag: MATH_TAG,
833
841
  requiredAttributes: [],
834
- optionalAttributes: ["xmlns"],
842
+ optionalAttributes: ["xmlns", "display"],
843
+ defaultChildTagName: MI_TAG,
835
844
  allowedChildTagNames: [...MATH_PRESENTATION_TAGS_ALLOWED_CHILDREN]
836
845
  });
837
846
 
@@ -1959,7 +1968,15 @@ var MATHPHRASE_SCHEMA = createSchema({
1959
1968
  optionalAttributes: [],
1960
1969
  allowedChildTagNames: [
1961
1970
  { tagName: MATH_TAG, required: true },
1962
- { tagName: SPAN_TAG, required: false }
1971
+ {
1972
+ tagName: SPAN_TAG,
1973
+ required: false
1974
+ }
1975
+ ],
1976
+ forbiddenElements: [
1977
+ { code: QUERY_SCHEMA.code, resolveTo: "remove" },
1978
+ { code: COMMENT_SCHEMA.code, resolveTo: "remove" },
1979
+ { code: COMMENT_QUERY_SECTION_SCHEMA.code, resolveTo: "unwrap" }
1963
1980
  ]
1964
1981
  });
1965
1982
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "pro-editor-schema",
3
- "version": "0.1.181",
3
+ "version": "0.1.183",
4
4
  "description": "Pro Editor XML schemas",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",