feat: Refactoring

Author: makeev-pavel

src/apitypes/rest/rest.operation.ts

@@ -36,7 +36,7 @@ import {
   isOperationDeprecated,
   normalizePath,
   rawToApiKind,
-  resolveRefAndMap,
+  getValueByRefAndUpdate,
   setValueByPath,
   takeIf,
   takeIfDefined,
@@ -311,14 +311,10 @@ const createSingleOperationSpec = (
   }
 
   if (pathData.$ref) {
-    const cleanedDocument = resolveRefAndMap(
-      document,
-      pathData.$ref,
-      (pathItemObject: OpenAPIV3.PathItemObject) => ({
-        ...extractCommonPathItemProperties(pathItemObject),
-        [method]: { ...pathItemObject[method] },
-      }),
-    )
+    const cleanedDocument = getValueByRefAndUpdate(pathData.$ref, document, (pathItemObject: OpenAPIV3.PathItemObject) => ({
+      ...extractCommonPathItemProperties(pathItemObject),
+      [method]: { ...pathItemObject[method] },
+    }))
 
     return {
       ...baseSpec,

src/strategies/document-group.strategy.ts

@@ -29,10 +29,9 @@ import {
   EXPORT_FORMAT_TO_FILE_FORMAT,
   fromBase64,
   getParentValueByRef,
-  resolveRefAndMap,
+  getValueByRefAndUpdate,
   removeFirstSlash,
   slugify,
-  takeIfDefined,
   toVersionDocument,
 } from '../utils'
 import { OpenAPIV3 } from 'openapi-types'
@@ -182,30 +181,27 @@ function transformDocumentData(versionDocument: VersionDocument): OpenAPIV3.Docu
 }
 
 function handleRefPathItem(
-  resultDoc: OpenAPIV3.Document,
-  sourceDoc: OpenAPIV3.Document,
+  resultDocument: OpenAPIV3.Document,
+  sourceDocument: OpenAPIV3.Document,
   path: string,
   pathData: OpenAPIV3.PathItemObject | OpenAPIV3.ReferenceObject,
   method: OpenAPIV3.HttpMethods,
 ): void {
-  const targetFromResultDoc = getParentValueByRef(resultDoc, (pathData as any).$ref ?? '')
-
-  const target = resolveRefAndMap(
-    sourceDoc,
-    (pathData as any).$ref ?? '',
-    (pathItemObject: OpenAPIV3.PathItemObject) => ({
-      ...targetFromResultDoc,
-      ...extractCommonPathItemProperties(pathItemObject),
-      [method]: { ...pathItemObject[method] },
-    }),
-  )
-
-  resultDoc.paths[path] = pathData
-
-  if (target.components) {
-    resultDoc.components = {
-      ...resultDoc.components,
-      ...target.components,
+  const ref = pathData.$ref ?? ''
+  const operationsFormResult = getParentValueByRef(ref, resultDocument)
+
+  const clearedDocument = getValueByRefAndUpdate(ref, sourceDocument, (pathItemObject: OpenAPIV3.PathItemObject) => ({
+    ...operationsFormResult,
+    ...extractCommonPathItemProperties(pathItemObject),
+    [method]: { ...pathItemObject[method] },
+  }))
+
+  resultDocument.paths[path] = pathData
+
+  if (clearedDocument.components) {
+    resultDocument.components = {
+      ...resultDocument.components,
+      ...clearedDocument.components,
     }
   }
 }

src/utils/builder.ts

@@ -193,19 +193,18 @@ const getValueByJsonPath = (root: any, path: JsonPath): any => {
   return current
 }
 
-export const getParentValueByRef = (obj: any, ref: string): any => {
-  const visited = new Set<string>()
+export const getParentValueByRef = (ref: string, document: OpenAPIV3.Document): any => {
+  const cyclingGuard = new Set<string>()
   let currentRef: string | undefined = ref
 
   while (currentRef) {
-    if (visited.has(currentRef)) {
-      // circular reference guard
+    if (cyclingGuard.has(currentRef)) {
       return undefined
     }
-    visited.add(currentRef)
+    cyclingGuard.add(currentRef)
 
     const { jsonPath } = parseRef(currentRef)
-    const value = getValueByJsonPath(obj, jsonPath)
+    const value = getValueByJsonPath(document, jsonPath)
 
     if (isRecordObject(value) && typeof value.$ref === 'string') {
       currentRef = value.$ref
@@ -217,9 +216,9 @@ export const getParentValueByRef = (obj: any, ref: string): any => {
   return undefined
 }
 
-export const resolveRefAndMap = (
-  document: OpenAPIV3.Document,
+export const getValueByRefAndUpdate = (
   ref: string,
+  document: OpenAPIV3.Document,
   valueMapper: (target: Record<string, unknown>) => Record<string, unknown>,
   result: Record<string, unknown> = {},
 ): Record<string, unknown> => {