rename node processors methods for better readability

packages/kbn-openapi-bundler/src/bundler/document_processors/bundle_refs.ts

@@ -39,13 +39,13 @@ export class BundleRefProcessor implements DocumentNodeProcessor {
 
   constructor(private inliningPropName: string) {}
 
-  enter(node: Readonly<DocumentNode>): void {
+  onNodeEnter(node: Readonly<DocumentNode>): void {
     if (hasProp(node, this.inliningPropName, true)) {
       this.nodesToInline.add(node);
     }
   }
 
-  ref(node: RefNode, resolvedRef: ResolvedRef, context: TraverseDocumentContext): void {
+  onRefNodeLeave(node: RefNode, resolvedRef: ResolvedRef, context: TraverseDocumentContext): void {
     if (!resolvedRef.pointer.startsWith('/components')) {
       throw new Error(
         `$ref pointer ${chalk.yellow(

packages/kbn-openapi-bundler/src/bundler/document_processors/modify_partial.ts

@@ -17,7 +17,7 @@ import { X_MODIFY } from '../known_custom_props';
  */
 export function createModifyPartialProcessor(): DocumentNodeProcessor {
   return {
-    ref(node, resolvedRef) {
+    onRefNodeLeave(node, resolvedRef) {
       if (!hasProp(node, X_MODIFY, 'partial')) {
         return;
       }
@@ -27,7 +27,7 @@ export function createModifyPartialProcessor(): DocumentNodeProcessor {
 
       delete node.required;
     },
-    leave(node) {
+    onNodeLeave(node) {
       if (!hasProp(node, X_MODIFY, 'partial')) {
         return;
       }

packages/kbn-openapi-bundler/src/bundler/document_processors/modify_required.ts

@@ -20,7 +20,7 @@ import { inlineRef } from './utils/inline_ref';
  */
 export function createModifyRequiredProcessor(): DocumentNodeProcessor {
   return {
-    ref(node, resolvedRef) {
+    onRefNodeLeave(node, resolvedRef) {
       if (!hasProp(node, X_MODIFY, 'required')) {
         return;
       }
@@ -48,7 +48,7 @@ export function createModifyRequiredProcessor(): DocumentNodeProcessor {
 
       node.required = Object.keys(resolvedRef.refNode.properties);
     },
-    leave(node) {
+    onNodeLeave(node) {
       if (!hasProp(node, X_MODIFY, 'required')) {
         return;
       }

packages/kbn-openapi-bundler/src/bundler/document_processors/reduce_all_of_items/flatten_folded_all_of_items.ts

@@ -48,7 +48,7 @@ import { DocumentNodeProcessor } from '../../types';
  */
 export function createFlattenFoldedAllOfItemsProcessor(): DocumentNodeProcessor {
   return {
-    leave(node) {
+    onNodeLeave(node) {
       if (!('allOf' in node) || !Array.isArray(node.allOf)) {
         return;
       }

packages/kbn-openapi-bundler/src/bundler/document_processors/reduce_all_of_items/merge_non_conflicting_all_of_items.ts

@@ -59,7 +59,7 @@ type MergedObjectSchema = Required<Pick<OpenAPIV3.SchemaObject, 'type' | 'proper
  */
 export function createMergeNonConflictingAllOfItemsProcessor(): DocumentNodeProcessor {
   return {
-    leave(allOfNode) {
+    onNodeLeave(allOfNode) {
       if (
         !('allOf' in allOfNode) ||
         !Array.isArray(allOfNode.allOf) ||

packages/kbn-openapi-bundler/src/bundler/document_processors/reduce_all_of_items/unfold_single_all_of_item.ts

@@ -39,7 +39,7 @@ import { DocumentNodeProcessor } from '../../types';
  */
 export function createUnfoldSingleAllOfItemProcessor(): DocumentNodeProcessor {
   return {
-    leave(node) {
+    onNodeLeave(node) {
       if (!('allOf' in node) || !Array.isArray(node.allOf) || node.allOf.length > 1) {
         return;
       }

packages/kbn-openapi-bundler/src/bundler/document_processors/remove_props.ts

@@ -14,7 +14,7 @@ import { DocumentNodeProcessor } from '../types';
  */
 export function createRemovePropsProcessor(propNames: string[]): DocumentNodeProcessor {
   return {
-    leave(node) {
+    onNodeLeave(node) {
       if (!isPlainObjectType(node)) {
         return;
       }

packages/kbn-openapi-bundler/src/bundler/document_processors/remove_unused_components.ts

@@ -8,7 +8,7 @@
 
 import { hasProp } from '../../utils/has_prop';
 import { isPlainObjectType } from '../../utils/is_plain_object_type';
-import { PlainObjectNode, ResolvedRef } from '../types';
+import { DocumentNodeProcessor, PlainObjectNode, ResolvedRef } from '../types';
 
 /**
  * Helps to remove unused components.
@@ -17,10 +17,10 @@ import { PlainObjectNode, ResolvedRef } from '../types';
  * and then `removeUnusedComponents()` should be invoked after document processing to perform
  * actual unused components deletion.
  */
-export class RemoveUnusedComponentsProcessor {
+export class RemoveUnusedComponentsProcessor implements DocumentNodeProcessor {
   private refs = new Set();
 
-  ref(node: unknown, resolvedRef: ResolvedRef): void {
+  onRefNodeLeave(node: unknown, resolvedRef: ResolvedRef): void {
     // If the reference has been inlined by one of the previous processors skip it
     if (!hasProp(node, '$ref')) {
       return;

packages/kbn-openapi-bundler/src/bundler/process_document.test.ts

@@ -19,13 +19,13 @@ describe('processDocument', () => {
       document: {} as Document,
     };
     const calls: string[] = [];
-    const processor1 = {
-      leave() {
+    const processor1: DocumentNodeProcessor = {
+      onNodeLeave() {
         calls.push('processor1');
       },
     };
-    const processor2 = {
-      leave() {
+    const processor2: DocumentNodeProcessor = {
+      onNodeLeave() {
         calls.push('processor2');
       },
     };
@@ -46,17 +46,17 @@ describe('processDocument', () => {
     const calls: string[] = [];
     const refResolver = new RefResolver();
     const processor: DocumentNodeProcessor = {
-      enter(node) {
+      onNodeEnter(node) {
         calls.push(`enter - ${(node as NodeWithId).id}`);
       },
       shouldRemove(node) {
         calls.push(`shouldRemove - ${(node as NodeWithId).id}`);
         return false;
       },
-      ref(node) {
+      onRefNodeLeave(node) {
         calls.push(`ref - ${(node as NodeWithId).id}`);
       },
-      leave(node) {
+      onNodeLeave(node) {
         calls.push(`leave - ${(node as NodeWithId).id}`);
       },
     };

packages/kbn-openapi-bundler/src/bundler/process_document.ts

@@ -146,14 +146,14 @@ export async function processDocument(
       // If ref has been inlined by one of the processors it's not a ref node anymore
       // so we can skip the following processors
       if (isRefNode(traverseItem.node) && traverseItem.resolvedRef) {
-        processor.ref?.(
+        processor.onRefNodeLeave?.(
           traverseItem.node as RefNode,
           traverseItem.resolvedRef,
           traverseItem.context
         );
       }
 
-      processor.leave?.(traverseItem.node, traverseItem.context);
+      processor.onNodeLeave?.(traverseItem.node, traverseItem.context);
     }
   }
 }
@@ -172,7 +172,7 @@ function applyEnterProcessors(
   processors: DocumentNodeProcessor[]
 ): void {
   for (const processor of processors) {
-    processor.enter?.(traverseItem.node, {
+    processor.onNodeEnter?.(traverseItem.node, {
       ...traverseItem.context,
       parentNode: traverseItem.parentNode,
       parentKey: traverseItem.parentKey,

packages/kbn-openapi-bundler/src/bundler/types.ts

@@ -103,19 +103,19 @@ export type TraverseDocumentEntryContext = TraverseDocumentContext & {
  * - `false` - keep the node
  *
  */
-export type ShouldRemoveProcessorFn = (
+export type ShouldRemoveNodeProcessorFn = (
   node: Readonly<DocumentNode>,
   context: TraverseDocumentEntryContext
 ) => boolean;
 
-export type EntryProcessorFn = (
+export type OnNodeEntryProcessorFn = (
   node: Readonly<DocumentNode>,
   context: TraverseDocumentEntryContext
 ) => void;
 
-export type LeaveProcessorFn = (node: DocumentNode, context: TraverseDocumentContext) => void;
+export type OnNodeLeaveProcessorFn = (node: DocumentNode, context: TraverseDocumentContext) => void;
 
-export type RefProcessorFn = (
+export type OnRefNodeLeaveProcessorFn = (
   node: RefNode,
   resolvedRef: ResolvedRef,
   context: TraverseDocumentContext
@@ -135,28 +135,29 @@ export type RefProcessorFn = (
  *
  * 1st phase
  *
- * - `enter` - Callback function is invoked at the first phase (diving from root to leaves) while traversing
- *             the document. It can be considered in a similar way events dive in DOM during capture phase.
- *             In the other words it means entering a subtree. It allows to analyze unprocessed nodes.
+ * - `onNodeEnter` - Callback function is invoked at the first phase (diving from root to leaves) while
+ *             traversing the document. It can be considered in a similar way events dive in DOM during
+ *             capture phase. In the other words it means entering a subtree. It allows to analyze
+ *             unprocessed nodes.
  *
- * - `shouldRemove` - Callback function is invoked at the first phase (diving from root to leaves) while traversing
- *             the document. It controls whether the node will be excluded from further processing and the
- *             result document eventually. Returning `true` excluded the node while returning `false` passes
- *             the node untouched.
+ * - `shouldRemove` - Callback function is invoked at the first phase (diving from root to leaves) while
+ *             traversing the document. It controls whether the node will be excluded from further processing
+ *             and the result document eventually. Returning `true` excluded the node while returning `false`
+ *             passes the node untouched.
  *
  * 2nd phase
  *
- * - `leave` - Callback function is invoked upon leaving any type of node. It give an opportunity to modify
- *             the document like inline references or remove unwanted properties. It can be considered in
- *             a similar way event bubble in DOM during bubble phase. In the other words it means leaving
+ * - `onNodeLeave` - Callback function is invoked upon leaving any type of node. It give an opportunity to
+ *             modify the document like inline references or remove unwanted properties. It can be considered
+ *             in a similar way event bubble in DOM during bubble phase. In the other words it means leaving
  *             a subtree.
  *
- * - `ref` - Callback function is invoked upon leaving a reference node (a node having `$ref` key)
+ * - `onRefNodeLeave` - Callback function is invoked upon leaving a reference node (a node having `$ref` key)
  *
  */
 export interface DocumentNodeProcessor {
-  shouldRemove?: ShouldRemoveProcessorFn;
-  enter?: EntryProcessorFn;
-  leave?: LeaveProcessorFn;
-  ref?: RefProcessorFn;
+  shouldRemove?: ShouldRemoveNodeProcessorFn;
+  onNodeEnter?: OnNodeEntryProcessorFn;
+  onNodeLeave?: OnNodeLeaveProcessorFn;
+  onRefNodeLeave?: OnRefNodeLeaveProcessorFn;
 }