feat(core): make dynamic modifiers are public (#805)

Author: d3m1d0v

src/core/SchemaDynamicModifier.ts

@@ -2,6 +2,14 @@ import type {NodeSpec} from 'prosemirror-model';
 
 export type TokenAttrs = {[name: string]: unknown};
 
+export interface NodeSpecProcessor {
+    allowedAttrs?: string[];
+}
+
+export interface SchemaDynamicModifierConfig {
+    [elementType: string]: NodeSpecProcessor;
+}
+
 /**
  * Class SchemaDynamicModifier
  *
@@ -19,18 +27,6 @@ export type TokenAttrs = {[name: string]: unknown};
  * });
  * ```
  */
-
-/** @internal */
-export interface NodeSpecProcessor {
-    allowedAttrs?: string[];
-}
-
-/** @internal */
-export interface SchemaDynamicModifierConfig {
-    [elementType: string]: NodeSpecProcessor;
-}
-
-/** @internal */
 export class SchemaDynamicModifier {
     private nodeSpecsProcessors: Map<string, NodeSpecProcessor>;
 

src/core/markdown/MarkdownParser.ts

@@ -374,6 +374,29 @@ function withoutTrailingNewline(str: string) {
     return str[str.length - 1] === '\n' || str.endsWith('\\n') ? str.slice(0, str.length - 1) : str;
 }
 
+export type ProcessToken = (
+    token: Token,
+    index: number,
+    rawMarkup: string,
+    allowedAttrs?: string[],
+) => Token;
+export type ProcessNodeAttrs = (
+    token: Token,
+    attrs: TokenAttrs,
+    allowedAttrs?: string[],
+) => TokenAttrs;
+export type ProcessNode = (node: Node) => Node;
+
+export interface ElementProcessor {
+    processToken?: ProcessToken[];
+    processNodeAttrs?: ProcessNodeAttrs[];
+    processNode?: ProcessNode[];
+}
+
+export interface MarkdownParserDynamicModifierConfig {
+    [elementType: string]: ElementProcessor;
+}
+
 /**
  * Class MarkdownParserDynamicModifier
  *
@@ -425,34 +448,6 @@ function withoutTrailingNewline(str: string) {
  * - Modifying token metadata.
  * - Logging or customizing processing steps for debugging.
  */
-
-/** @internal */
-export type ProcessToken = (
-    token: Token,
-    index: number,
-    rawMarkup: string,
-    allowedAttrs?: string[],
-) => Token;
-export type ProcessNodeAttrs = (
-    token: Token,
-    attrs: TokenAttrs,
-    allowedAttrs?: string[],
-) => TokenAttrs;
-export type ProcessNode = (node: Node) => Node;
-
-/** @internal */
-export interface ElementProcessor {
-    processToken?: ProcessToken[];
-    processNodeAttrs?: ProcessNodeAttrs[];
-    processNode?: ProcessNode[];
-}
-
-/** @internal */
-export interface MarkdownParserDynamicModifierConfig {
-    [elementType: string]: ElementProcessor;
-}
-
-/** @internal */
 export class MarkdownParserDynamicModifier {
     private elementProcessors: Map<string, ElementProcessor>;
 

src/core/markdown/MarkdownSerializerDynamicModifier.ts

@@ -2,7 +2,6 @@ import type {Node} from 'prosemirror-model';
 
 import type {SerializerNodeToken, SerializerState} from '../types/serializer';
 
-/** @internal */
 export type SerializerProcessNode = (
     state: SerializerState,
     node: Node,
@@ -11,12 +10,10 @@ export type SerializerProcessNode = (
     callback?: SerializerNodeToken,
 ) => void;
 
-/** @internal */
 export interface SerializerNodeProcessor {
     processNode?: SerializerProcessNode[];
 }
 
-/** @internal */
 export interface MarkdownSerializerDynamicModifierConfig {
     [nodeType: string]: SerializerNodeProcessor;
 }
@@ -47,8 +44,6 @@ export interface MarkdownSerializerDynamicModifierConfig {
  * - Customizing the serialization output.
  * - Logging or modifying node content during serialization.
  */
-
-/** @internal */
 export class MarkdownSerializerDynamicModifier {
     private nodeProcessors: Map<string, SerializerNodeProcessor>;
 

src/core/types/dynamicModifiers.ts

@@ -1,43 +1,37 @@
 import type {ProcessNode, ProcessNodeAttrs, ProcessToken} from '../markdown/MarkdownParser';
 import type {SerializerProcessNode} from '../markdown/MarkdownSerializerDynamicModifier';
 
-/** @internal */
 export type DynamicModifiers =
     | ParserTokenModifier
     | ParserNodeAttrsModifier
     | ParserNodeModifier
     | SerializerNodeModifier
     | SchemaNodeSpecModifier;
 
-/** @internal */
 export type ParserTokenModifier = {
     type: 'parserToken';
     tokenName: string;
     process: ProcessToken;
 };
 
-/** @internal */
 export type ParserNodeAttrsModifier = {
     type: 'parserNodeAttrs'; // TODO: fix name
     tokenName: string;
     process: ProcessNodeAttrs;
 };
 
-/** @internal */
 export type ParserNodeModifier = {
     type: 'parserNode';
     nodeName: string;
     process: ProcessNode;
 };
 
-/** @internal */
 export type SerializerNodeModifier = {
     type: 'serializerNode';
     nodeName: string;
     process: SerializerProcessNode;
 };
 
-/** @internal */
 export type SchemaNodeSpecModifier = {
     type: 'schemaNodeSpec';
     nodeName: string;