fix: resolvers

Author: CountRedClaw

src/builder.ts

@@ -277,7 +277,8 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
     version?: string,
     packageId?: string,
     operationIds?: OperationId[],
-    includeData = true,
+    includeData: boolean = true,
+    operationsCount?: number,
   ): Promise<ResolvedOperations | null> {
     if (!version) {
       return null
@@ -301,6 +302,7 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
       packageId,
       operationIds,
       includeData,
+      operationsCount,
     )
 
     // validate for missing operationData
@@ -398,6 +400,8 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
   async versionResolver(
     version: string,
     packageId: string,
+    includeOperations?: boolean,
+    includeSummary?: boolean,
   ): Promise<VersionCache | null> {
     const compositeKey = getCompositeKey(packageId, version)
 
@@ -415,7 +419,7 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
       throw new Error('No versionResolver provided')
     }
 
-    const versionContent = await versionResolver(packageId, version, true)
+    const versionContent = await versionResolver(packageId, version, includeOperations, includeSummary)
 
     if (!versionContent) {
       this.notifications.push({

src/components/compare/compare.operations.ts

@@ -45,6 +45,7 @@ import {
   calculateImpactedSummary,
   executeInBatches,
   getSplittedVersionKey,
+  IGNORE_PATH_PARAM_UNIFIED_PLACEHOLDER,
   removeFirstSlash,
   removeObjectDuplicates,
   slugify,
@@ -65,8 +66,8 @@ export async function compareVersionsOperations(
   const { versionResolver } = ctx
 
   // resolve all version with operation hashes
-  const prevVersionData = prev && (await versionResolver(...prev) ?? { version: prev?.[0], packageId: prev?.[1] })
-  const currVersionData = curr && (await versionResolver(...curr) ?? { version: curr?.[0], packageId: curr?.[1] })
+  const prevVersionData = prev && (await versionResolver(...prev, false, true) ?? { version: prev?.[0], packageId: prev?.[1] })
+  const currVersionData = curr && (await versionResolver(...curr, false, true) ?? { version: curr?.[0], packageId: curr?.[1] })
 
   // compare operations of each type
   for (const apiType of getUniqueApiTypesFromVersions(prevVersionData, currVersionData)) {

src/components/compare/compare.utils.ts

@@ -28,10 +28,15 @@ import {
   VersionCache,
 } from '../../types'
 import { BUILD_TYPE, EMPTY_CHANGE_SUMMARY, MESSAGE_SEVERITY } from '../../consts'
-import { convertToSlug, NormalizedPath, PATH_PARAM_UNIFIED_PLACEHOLDER, slugify, takeIfDefined } from '../../utils'
+import {
+  convertToSlug,
+  IGNORE_PATH_PARAM_UNIFIED_PLACEHOLDER,
+  NormalizedPath,
+  slugify,
+  takeIfDefined,
+} from '../../utils'
 import { REST_API_TYPE } from '../../apitypes'
 import { OpenAPIV3 } from 'openapi-types'
-import { CharMap } from 'slug'
 
 export const totalChanges = (changeSummary?: ChangeSummary): number => {
   return changeSummary
@@ -91,8 +96,6 @@ export type OperationIdentityMap = Record<OperationIdWithoutGroupPrefix, Operati
 
 type NormalizedOperationId = `${NormalizedPath}-${OpenAPIV3.HttpMethods}`
 
-const IGNORE_PATH_PARAM_UNIFIED_PLACEHOLDER: CharMap = { [PATH_PARAM_UNIFIED_PLACEHOLDER]: PATH_PARAM_UNIFIED_PLACEHOLDER }
-
 export function getOperationsHashMapByApiType(
   currentApiType: OperationsApiType,
   operations: ResolvedOperation[],

src/types/internal/apiBuilder.ts

@@ -67,7 +67,7 @@ export type TemplateResolver = (
 ) => Promise<string>
 
 export interface CompareOperationsPairContext {
-  notifications: NotificationMessage[],
+  notifications: NotificationMessage[]
   versionDeprecatedResolver: VersionDeprecatedResolver
   previousVersion: VersionId
   currentVersion: VersionId
@@ -99,7 +99,12 @@ export interface ApiBuilder<T = any, O = any, M = any> {
 }
 
 // internal
-export type _VersionResolver = (packageId: PackageId, version: VersionId) => Promise<VersionCache | null>
+export type _VersionResolver = (
+  packageId: PackageId,
+  version: VersionId,
+  includeOperations?: boolean,
+  includeSummary?: boolean,
+) => Promise<VersionCache | null>
 export type _VersionReferencesResolver = (packageId: PackageId, version: VersionId) => Promise<BuildConfigRef[]>
 
 export type _ParsedFileResolver = (fileId: string) => Promise<File | null>

src/utils/document.ts

@@ -36,6 +36,7 @@ import {
 import { bundle, Resolver } from 'api-ref-bundler'
 import { FILE_FORMAT_JSON, FILE_FORMAT_YAML, MESSAGE_SEVERITY } from '../consts'
 import { isNotEmpty } from './arrays'
+import { PATH_PARAM_UNIFIED_PLACEHOLDER } from './builder'
 
 export const EXPORT_FORMAT_TO_FILE_FORMAT = new Map<OperationsGroupExportFormat, FileFormat>([
   [YAML_EXPORT_GROUP_FORMAT, FILE_FORMAT_YAML],
@@ -100,6 +101,8 @@ export const findSharedPath = (fileIds: string[]): string => {
   return first.slice(0, i).join('/') + (i ? '/' : '')
 }
 
+export const IGNORE_PATH_PARAM_UNIFIED_PLACEHOLDER: CharMap = { [PATH_PARAM_UNIFIED_PLACEHOLDER]: PATH_PARAM_UNIFIED_PLACEHOLDER }
+
 export const slugify = (text: string, slugs: string[] = [], charMapEntry?: CharMap): string => {
   if (!text) {
     return ''