feat: Review

Author: makeev-pavel

src/apitypes/rest/rest.operation.ts

@@ -37,8 +37,8 @@ import {
   getSplittedVersionKey,
   getSymbolValueIfDefined,
   isDeprecatedOperationItem,
-  isObject,
   isOperationDeprecated,
+  isValidHttpMethod,
   normalizePath,
   rawToApiKind,
   removeFirstSlash,
@@ -297,7 +297,7 @@ function reduceComponentPathItemsToOperations(
   }
 }
 
-const getPathItemComponentJsonPath = (sourcePathItem: OpenAPIV3.PathItemObject): JsonPath | undefined=> {
+const getPathItemComponentJsonPath = (sourcePathItem: OpenAPIV3.PathItemObject): JsonPath | undefined => {
   const refs = getSymbolValueIfDefined(sourcePathItem, INLINE_REFS_FLAG) as string[] | undefined
   if (!refs || refs.length === 0) {
     return undefined
@@ -363,15 +363,11 @@ export const extractCommonPathItemProperties = (
   ...takeIfDefined({ parameters: pathData?.parameters }),
 })
 
-function isValidHttpMethod(method: string): method is OpenAPIV3.HttpMethods {
-  return (Object.values(OpenAPIV3.HttpMethods) as string[]).includes(method)
-}
-
-export function calculateOperationId(
+export const calculateOperationId = (
   basePath: string,
   key: string,
   path: string,
-): string {
+): string => {
   const operationPath = basePath + path
   return slugify(`${removeFirstSlash(operationPath)}-${key}`)
 }

src/strategies/document-group.strategy.ts

@@ -25,7 +25,7 @@ import {
   VersionDocument,
 } from '../types'
 import { REST_API_TYPE } from '../apitypes'
-import { EXPORT_FORMAT_TO_FILE_FORMAT, fromBase64, takeIfDefined, toVersionDocument } from '../utils'
+import { EXPORT_FORMAT_TO_FILE_FORMAT, fromBase64, isValidHttpMethod, takeIfDefined, toVersionDocument } from '../utils'
 import { OpenAPIV3 } from 'openapi-types'
 import { getOperationBasePath } from '../apitypes/rest/rest.utils'
 import { VersionRestDocument } from '../apitypes/rest/rest.types'
@@ -148,12 +148,12 @@ function transformDocumentData(versionDocument: VersionDocument): OpenAPIV3.Docu
         const pathData = sourceDocument.paths[path]!
         const isRefPathData = !!pathData.$ref
         resultDocument.paths[path] = isRefPathData
-            ? pathData
-            : {
-              ...resultDocument.paths[path],
-              ...commonPathItemProperties,
-              [httpMethod]: { ...pathData[httpMethod] },
-            }
+          ? pathData
+          : {
+            ...resultDocument.paths[path],
+            ...commonPathItemProperties,
+            [httpMethod]: { ...pathData[httpMethod] },
+          }
 
         resultDocument.components = {
           ...takeIfDefined({ securitySchemes: sourceComponents?.securitySchemes }),
@@ -176,10 +176,6 @@ function normalizeOpenApi(document: OpenAPIV3.Document, source?: OpenAPIV3.Docum
   ) as OpenAPIV3.Document
 }
 
-function isValidHttpMethod(method: string): method is OpenAPIV3.HttpMethods {
-  return (Object.values(OpenAPIV3.HttpMethods) as string[]).includes(method)
-}
-
 function isNonNullObject(value: unknown): value is Record<string, unknown> {
   return typeof value === 'object' && value !== null
 }

src/utils/operations.utils.ts

@@ -16,7 +16,7 @@
 
 import { ApiOperation, BuildResult } from '../types'
 import { GraphApiComponents, GraphApiDirectiveDefinition } from '@netcracker/qubership-apihub-graphapi'
-import type { OpenAPIV3 } from 'openapi-types'
+import { OpenAPIV3 } from 'openapi-types'
 import { isObject } from './objects'
 import { slugify } from './document'
 import { removeFirstSlash } from './builder'
@@ -82,3 +82,9 @@ export function isOperationRemove(operationDiff: Diff): boolean {
   // length is 2 because json path has view like ['paths', '/test/element']
   return operationDiff.action === DiffAction.remove && !!matchPaths(operationDiff.beforeDeclarationPaths, [[OPEN_API_PROPERTY_PATHS, PREDICATE_ANY_VALUE]])
 }
+
+const HTTP_METHODS_SET = new Set(Object.values(OpenAPIV3.HttpMethods) as string[])
+
+export const isValidHttpMethod = (method: string): method is OpenAPIV3.HttpMethods => {
+  return HTTP_METHODS_SET.has(method)
+}