feat: Review

Author: makeev-pavel

src/apitypes/rest/rest.changes.ts

@@ -82,7 +82,7 @@ import {
   getOperationTags,
   OperationsMap,
 } from '../../components'
-import { checkApiKind, getApiKindFormLabels } from '../../components/compare/bwc.validation'
+import { createApiKindChecker, getApiKindFormLabels } from '../../components/compare/bwc.validation'
 
 export const compareDocuments: DocumentsCompare = async (
   operationsMap: OperationsMap,
@@ -135,7 +135,7 @@ export const compareDocuments: DocumentsCompare = async (
       normalizedResult: false,
       afterValueNormalizedProperty: AFTER_VALUE_NORMALIZED_PROPERTY,
       beforeValueNormalizedProperty: BEFORE_VALUE_NORMALIZED_PROPERTY,
-      apiCompatibilityScopeFunction: checkApiKind(
+      apiCompatibilityScopeFunction: createApiKindChecker(
         prevDoc?.apiKind ?? getApiKindFormLabels(prevDocData?.info, prevDoc?.labels, previousVersionLabels),
         currDoc?.apiKind ?? getApiKindFormLabels(currDocData?.info, currDoc?.labels, currentVersionLabels),
       ),

src/components/compare/bwc.validation.ts

@@ -79,15 +79,15 @@ const checkAllMethodsHaveSameApiKind = (obj: unknown, apiKind: string): boolean
 
 const ROOT_PATH_LENGTH = 0
 const PATH_ITEM_PATH_LENGTH = 2
-const MAX_BWC_FLAG_PATH_LENGTH = 3
+const OPERATION_OBJECT_PATH_LENGTH = 3
 
-export const checkApiKind = (
+export const createApiKindChecker = (
   prevApiKind: string = API_KIND.BWC,
   currApiKind: string = API_KIND.BWC,
 ): ApiCompatibilityScopeFunction => {
   const defaultApiCompatibilityKind = (prevApiKind === API_KIND.NO_BWC || currApiKind === API_KIND.NO_BWC)
     ? ApiCompatibilityKind.NOT_BACKWARD_COMPATIBLE
-    : undefined
+    : ApiCompatibilityKind.BACKWARD_COMPATIBLE
 
   return (
     path?: JsonPath,
@@ -98,7 +98,7 @@ export const checkApiKind = (
     /*
      * Calculating Api Kind for the entire document as the default
      * If there is a NO_BWC marker on:
-     * - Publish label
+     * - Version labels and Document labels
      * - Document API info section
      */
     if (pathLength === ROOT_PATH_LENGTH) {
@@ -110,7 +110,7 @@ export const checkApiKind = (
     * Level 3: When individual operations are deleted/added
      */
     const isFirstPathSegmentPaths = path?.[0] === 'paths'
-    if (!isFirstPathSegmentPaths || pathLength < PATH_ITEM_PATH_LENGTH || pathLength > MAX_BWC_FLAG_PATH_LENGTH) {
+    if (!isFirstPathSegmentPaths || pathLength < PATH_ITEM_PATH_LENGTH || pathLength > OPERATION_OBJECT_PATH_LENGTH) {
       return undefined
     }
 

src/components/document.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { BuildConfigFile, BuilderContext, FILE_KIND, SourceFile, TextFile, VersionDocument } from '../types'
+import { ApiKind, BuildConfigFile, BuilderContext, FILE_KIND, SourceFile, TextFile, VersionDocument } from '../types'
 import { API_KIND, API_KIND_LABEL, DOCUMENT_TYPE, FILE_FORMAT_UNKNOWN } from '../consts'
 import { createVersionInternalDocument, getDocumentTitle, getFileExtension, isObject, rawToApiKind } from '../utils'
 import { buildBinaryDocument, REST_KIND_KEY, unknownApiBuilder } from '../apitypes'
@@ -56,7 +56,7 @@ export const buildDocument = async (parsedFile: SourceFile, file: BuildConfigFil
   }
 }
 
-export const findApiKindLabel = (fileLabels: unknown, versionLabels: unknown): string => {
+export const findApiKindLabel = (fileLabels: unknown, versionLabels: unknown): ApiKind => {
   if (!Array.isArray(fileLabels) && !Array.isArray(versionLabels)) {
     return API_KIND.BWC
   }

src/types/external/version.ts

@@ -37,7 +37,6 @@ export type ResolvedVersion = {
   // operationSummary?: object
   // createdAt: string
   // createdBy: string
-  // versionLabels?: string[]
 }
 
 export type OperationTypes = {

src/types/internal/apiBuilder.ts

@@ -20,7 +20,8 @@ import {
   BuildConfigRef,
   ExportFormat,
   FileId,
-  GroupDocumentsResolver, Labels,
+  GroupDocumentsResolver,
+  Labels,
   OperationId,
   OperationsApiType,
   PackageId,