transform to dto only zip files

Author: Iurii Golovinskii

src/builder.ts

@@ -17,7 +17,7 @@
 import type {
   BuildConfig,
   BuildConfigFile,
-  BuildConfigRef, DiffTypeDto,
+  BuildConfigRef,
   FileId,
   OperationId,
   OperationsApiType,
@@ -29,6 +29,7 @@ import type {
   ResolvedOperations,
   ResolvedVersionOperationsHashMap,
   VersionId,
+  VersionsComparison,
 } from './types'
 import {
   ApiBuilder,
@@ -45,7 +46,6 @@ import {
   OperationChanges,
   VersionCache,
   VersionDocument,
-  VersionsComparisonDto,
 } from './types/internal'
 import type { NotificationMessage, PackageConfig } from './types/package'
 import { graphqlApiBuilder, REST_API_TYPE, restApiBuilder, textApiBuilder, unknownApiBuilder } from './apitypes'
@@ -73,7 +73,7 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
   apiBuilders: ApiBuilder[] = []
   documents = new Map<string, VersionDocument>()
   operations = new Map<string, ApiOperation>()
-  comparisons: VersionsComparisonDto<DiffTypeDto>[] = []
+  comparisons: VersionsComparison[] = []
 
   versionsCache = new Map<string, VersionCache>()
   referencesCache = new Map<string, BuildConfigRef[]>()
@@ -462,7 +462,10 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
       return []
     }
 
-    const referencesCache: BuildConfigRef[] = Object.values(versionReferences.packages ?? {}).filter(pack => !pack.deletedAt).map(pack => ({ refId: pack.refId, version: pack.version }))
+    const referencesCache: BuildConfigRef[] = Object.values(versionReferences.packages ?? {}).filter(pack => !pack.deletedAt).map(pack => ({
+      refId: pack.refId,
+      version: pack.version,
+    }))
     this.referencesCache.set(compositeKey, referencesCache)
 
     return referencesCache

src/components/compare/compare.ts

@@ -14,26 +14,17 @@
  * limitations under the License.
  */
 
-import {
-  BuildConfigRef,
-  CompareContext,
-  DiffTypeDto,
-  VersionParams,
-  VersionsComparison,
-  VersionsComparisonDto,
-} from '../../types'
+import { BuildConfigRef, CompareContext, VersionParams, VersionsComparison } from '../../types'
 import { compareVersionsOperations } from './compare.operations'
 import { getSplittedVersionKey } from '../../utils'
-import { toVersionsComparisonDto } from '../../utils/transformToDto'
-import { MESSAGE_SEVERITY } from '../../consts'
 import { asyncDebugPerformance, DebugPerformanceContext } from '../../utils/logs'
 
 export async function compareVersions(
   prev: VersionParams,
   curr: VersionParams,
   ctx: CompareContext,
   debugCtx?: DebugPerformanceContext,
-): Promise<VersionsComparisonDto<DiffTypeDto>[]> {
+): Promise<VersionsComparison[]> {
   let comparisons: VersionsComparison[] = []
   await asyncDebugPerformance('[CompareVersions]', async (versionsDebugContext) => {
     comparisons = await compareVersionsReferences(prev, curr, ctx)
@@ -44,14 +35,7 @@ export async function compareVersions(
     ))
   }, debugCtx, prev ? [prev[1], prev[0]] : ['empty previous id', 'empty previous version'])
 
-  const logError = (message: string): void => {
-    ctx.notifications.push({
-      severity: MESSAGE_SEVERITY.Error,
-      message: message,
-    })
-  }
-
-  return comparisons.map(comparison => toVersionsComparisonDto(comparison, logError))
+  return comparisons
 }
 
 export async function compareVersionsReferences(

src/components/package.ts

@@ -17,10 +17,10 @@
 import JSZip from 'jszip'
 import { version } from '../../package.json'
 
-import type {
+import {
   ApiOperation,
   BuilderContext,
-  BuildResult,
+  BuildResultDto,
   PackageComparison,
   PackageComparisonOperations,
   PackageComparisons,
@@ -29,11 +29,12 @@ import type {
   PackageNotifications,
   PackageOperation,
   PackageOperations,
-  VersionDocument,
+  VersionDocument, VersionsComparisonDto, BuildResult,
 } from '../types'
 import { unknownApiBuilder } from '../apitypes'
-import { PACKAGE } from '../consts'
+import { MESSAGE_SEVERITY, PACKAGE } from '../consts'
 import { takeIf, toPackageDocument } from '../utils'
+import { toVersionsComparisonDto } from '../utils/transformToDto'
 
 export interface ZipTool {
   // todo method should only accept Blob content, transformation is not a responsibility of this method
@@ -48,30 +49,41 @@ export const createVersionPackage = async (
   ctx: BuilderContext,
   options?: JSZip.JSZipGeneratorOptions,
 ): Promise<any> => {
-  await createInfoFile(zip, buildResult.config)
+  const logError = (message: string): void => {
+    ctx.notifications.push({
+      severity: MESSAGE_SEVERITY.Error,
+      message: message,
+    })
+  }
+  const transformToDtoBuildResult: BuildResultDto = {
+    ...buildResult,
+    comparisons: buildResult.comparisons.map(comparison => toVersionsComparisonDto(comparison, logError)) as VersionsComparisonDto[],
+  }
+
+  await createInfoFile(zip, transformToDtoBuildResult.config)
 
-  const documents = buildResult.merged ? [buildResult.merged] : [...buildResult.documents.values()]
+  const documents = transformToDtoBuildResult.merged ? [transformToDtoBuildResult.merged] : [...transformToDtoBuildResult.documents.values()]
 
   createDocumentsFile(zip, documents)
   await createDocumentDataFiles(zip, documents, ctx)
 
-  createOperationsFile(zip, buildResult.operations)
+  createOperationsFile(zip, transformToDtoBuildResult.operations)
   const operationsDir = zip.folder(PACKAGE.OPERATIONS_DIR_NAME)!
-  for (const { data, operationId } of buildResult.operations.values()) {
+  for (const { data, operationId } of transformToDtoBuildResult.operations.values()) {
     createOperationDataFile(operationsDir, operationId, data)
   }
 
-  if (buildResult.comparisons.length) {
-    const comparisons: PackageComparison[] = buildResult.comparisons.map(({ data, ...rest }) => rest)
+  if (transformToDtoBuildResult.comparisons.length) {
+    const comparisons: PackageComparison[] = transformToDtoBuildResult.comparisons.map(({ data, ...rest }) => rest)
     createComparisonsFile(zip, { comparisons })
     const comparisonsDir = zip.folder(PACKAGE.COMPARISONS_DIR_NAME)
 
-    for (const comparison of buildResult.comparisons) {
+    for (const comparison of transformToDtoBuildResult.comparisons) {
       if (!comparison.comparisonFileId || !comparison.data) { continue }
       createComparisonDataFile(comparisonsDir!, comparison.comparisonFileId, { operations: comparison.data })
     }
   }
-  createNotificationsFile(zip, { notifications: buildResult.notifications })
+  createNotificationsFile(zip, { notifications: transformToDtoBuildResult.notifications })
 
   return await zip.buildResult(options)
 }

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

src/types/internal/builder.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import { BuildConfig, BuilderResolvers, DiffTypeDto, FileId, PackageId, ResolvedVersion, VersionId } from '../external'
-import { VersionsComparisonDto } from './compare'
+import { BuildConfig, BuilderResolvers, FileId, PackageId, ResolvedVersion, VersionId } from '../external'
+import { VersionsComparison, VersionsComparisonDto } from './compare'
 import { PackageConfig } from '../package/config'
 import { NotificationMessage } from '../package/notifications'
 import { VersionDocument } from './documents'
@@ -27,9 +27,18 @@ export type VersionCache = ResolvedVersion & {
   version: VersionId
 }
 
+export interface BuildResultDto {
+  config: PackageConfig
+  comparisons: VersionsComparisonDto[]
+  notifications: NotificationMessage[]
+  documents: Map<string, VersionDocument>
+  operations: Map<string, ApiOperation>
+  merged?: VersionDocument
+}
+
 export interface BuildResult {
   config: PackageConfig
-  comparisons: VersionsComparisonDto<DiffTypeDto>[]
+  comparisons: VersionsComparison[]
   notifications: NotificationMessage[]
   documents: Map<string, VersionDocument>
   operations: Map<string, ApiOperation>

src/utils/transformToDto.ts

@@ -169,7 +169,6 @@ export function convertDtoFieldOperationTypes<
   override,
 }: OptionDiffReplacer = { origin: SEMI_BREAKING_CHANGE_TYPE, override: risky }): OperationType<J>[] {
   return operationTypes?.map((type) => {
-    // if(!type.changesSummary || !type.changesSummary ) return type
     return {
       ...type,
       changesSummary: replacePropertyInChangesSummary<T, J>(type.changesSummary, {