feat: add ExportRestOperationsGroupStrategy

Author: CountRedClaw

src/builder.ts

@@ -72,6 +72,8 @@ import { BuildStrategy, ChangelogStrategy, DocumentGroupStrategy, PrefixGroupsCh
 import { BuilderStrategyContext } from './builder-strategy'
 import { MergedDocumentGroupStrategy } from './strategies/merged-document-group.strategy'
 import { asyncDebugPerformance } from './utils/logs'
+import { ExportRestOperationsGroupStrategy } from './strategies/rest-operations-group.strategy'
+// import { ExportVersionStrategy } from './strategies/export-version.strategy'
 
 export const DEFAULT_RUN_OPTIONS: BuilderRunOptions = {
   cleanCache: false,
@@ -230,6 +232,18 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
       builderStrategyContext.setStrategy(new MergedDocumentGroupStrategy())
     }
 
+    // if (buildType === BUILD_TYPE.EXPORT_VERSION) {
+    //   builderStrategyContext.setStrategy(new ExportVersionStrategy())
+    // }
+
+    // if (buildType === BUILD_TYPE.EXPORT_REST_DOCUMENT) {
+    //   builderStrategyContext.setStrategy(new MergedDocumentGroupStrategy())
+    // }
+
+    if (buildType === BUILD_TYPE.EXPORT_REST_OPERATIONS_GROUP) {
+      builderStrategyContext.setStrategy(new ExportRestOperationsGroupStrategy())
+    }
+
     await asyncDebugPerformance('[Builder]', async (debugCtx) => {
       this.setBuildResult(await builderStrategyContext.executeStrategy(debugCtx))
     }, undefined, [buildType, this.config.packageId, this.config.version])

src/consts.ts

@@ -80,6 +80,9 @@ export const BUILD_TYPE = {
   DOCUMENT_GROUP: 'documentGroup',
   REDUCED_SOURCE_SPECIFICATIONS: 'reducedSourceSpecifications',
   MERGED_SPECIFICATION: 'mergedSpecification',
+  EXPORT_VERSION: 'exportVersion',
+  EXPORT_REST_DOCUMENT: 'exportRestDocument',
+  EXPORT_REST_OPERATIONS_GROUP: 'exportRestOperationsGroup',
 } as const
 
 export const VERSION_STATUS = {

src/strategies/document-group.strategy.ts

@@ -21,7 +21,7 @@ import {
   BuildTypeContexts,
   FileFormat,
   JSON_EXPORT_GROUP_FORMAT,
-  ResolvedDocument,
+  ResolvedDocument, ResolvedReferenceMap,
   VersionDocument,
 } from '../types'
 import { REST_API_TYPE } from '../apitypes'
@@ -43,7 +43,7 @@ import { normalize } from '@netcracker/qubership-apihub-api-unifier'
 import { calculateSpecRefs, extractCommonPathItemProperties } from '../apitypes/rest/rest.operation'
 import { groupBy } from 'graphql/jsutils/groupBy'
 
-async function getTransformedDocument(document: ResolvedDocument, format: FileFormat): Promise<VersionRestDocument> {
+async function getTransformedDocument(document: ResolvedDocument, format: FileFormat, packages: ResolvedReferenceMap): Promise<VersionRestDocument> {
   const versionDocument = toVersionDocument(document, format)
 
   const source = extractDocumentData(versionDocument)
@@ -60,6 +60,13 @@ async function getTransformedDocument(document: ResolvedDocument, format: FileFo
 
   calculateSpecRefs(source, normalizedDocument, versionDocument.data)
 
+  // dashboard case
+  if (document.packageRef) {
+    const { refId } = packages[document.packageRef]
+    versionDocument.fileId = `${refId}_${versionDocument.fileId}`
+    versionDocument.filename = `${refId}_${versionDocument.filename}`
+  }
+
   return versionDocument
 }
 
@@ -83,17 +90,17 @@ export class DocumentGroupStrategy implements BuilderStrategy {
 
     const builderContextObject = builderContext(config)
 
-    const { documents } = await builderContextObject.versionDocumentsResolver(
-      apiType,
+    const { documents, packages } = await builderContextObject.versionDocumentsResolver(
+      REST_API_TYPE,
       version,
       packageId,
       groupName,
-    ) ?? { documents: [] }
+    ) ?? { documents: [], packages: {} }
 
     const transformTasks = []
 
     for (const document of documents) {
-      transformTasks.push(getTransformedDocument(document, documentFormat))
+      transformTasks.push(getTransformedDocument(document, documentFormat, packages))
     }
 
     const transformedDocuments = await Promise.all(transformTasks)

src/strategies/rest-operations-group.strategy.ts

@@ -0,0 +1,41 @@
+/**
+ * Copyright 2024-2025 NetCracker Technology Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  BuildConfig,
+  BuildResult,
+  BuildTypeContexts,
+  TRANSFORMATION_KIND_MERGED,
+  TRANSFORMATION_KIND_REDUCED,
+} from '../types'
+import { DocumentGroupStrategy } from './document-group.strategy'
+import { MergedDocumentGroupStrategy } from './merged-document-group.strategy'
+
+export class ExportRestOperationsGroupStrategy extends DocumentGroupStrategy {
+  async execute(config: BuildConfig, buildResult: BuildResult, contexts: BuildTypeContexts): Promise<BuildResult> {
+
+    switch (config.operationsSpecTransformation) {
+      case TRANSFORMATION_KIND_MERGED:
+        await new MergedDocumentGroupStrategy().execute(config, buildResult, contexts)
+        break
+      case TRANSFORMATION_KIND_REDUCED:
+        await new DocumentGroupStrategy().execute(config, buildResult, contexts)
+        break
+    }
+
+    return buildResult
+  }
+}

src/types/external/config.ts

@@ -16,6 +16,7 @@
 
 import { FileId, KeyOfConstType, OperationsApiType, PackageId, VersionId } from './types'
 import { BUILD_TYPE, VERSION_STATUS } from '../../consts'
+import { OpenApiExtensionKey } from '@netcracker/qubership-apihub-api-unifier'
 
 export type BuildType = KeyOfConstType<typeof BUILD_TYPE>
 export type VersionStatus = KeyOfConstType<typeof VERSION_STATUS>
@@ -61,8 +62,63 @@ export interface BuildConfig {
   format?: OperationsGroupExportFormat
 
   validationRulesSeverity?: ValidationRulesSeverity
+  operationsSpecTransformation?: OperationsSpecTransformation
 }
 
+export interface BuildConfigBase {
+// export interface BuildConfig {
+  buildType: BuildType
+}
+
+export interface PublishBuildConfig extends BuildConfigBase {
+  buildType: typeof BUILD_TYPE.BUILD
+  version: VersionId // @revision for rebuild
+  previousVersion?: VersionId
+  previousVersionPackageId?: PackageId
+  status: VersionStatus
+  versionLabels?: string[]
+  refs?: BuildConfigRef[]
+  files?: BuildConfigFile[]
+  // apiType?: OperationsApiType //todo Document transformation is available only for apiType = REST
+}
+
+export interface ExportVersionBuildConfig extends BuildConfigBase {
+  buildType: typeof BUILD_TYPE.EXPORT_VERSION
+  packageId: PackageId
+  version: VersionId // @revision for rebuild
+  // apiType?: OperationsApiType //todo Document transformation is available only for apiType = REST
+  format: OperationsGroupExportFormat
+  allowedOasExtensions?: OpenApiExtensionKey
+}
+
+export interface ExportRestDocumentBuildConfig extends BuildConfigBase {
+  buildType: typeof BUILD_TYPE.EXPORT_REST_DOCUMENT
+  packageId: PackageId
+  version: VersionId // @revision for rebuild
+  documentId: string
+  // apiType?: OperationsApiType //todo Document transformation is available only for apiType = REST
+  format: OperationsGroupExportFormat
+  allowedOasExtensions?: OpenApiExtensionKey
+}
+
+export interface ExportRestOperationsGroupBuildConfig extends BuildConfigBase {
+  buildType: typeof BUILD_TYPE.EXPORT_REST_OPERATIONS_GROUP
+  packageId: PackageId
+  version: VersionId // @revision for rebuild
+  // apiType?: OperationsApiType //todo Document transformation is available only for apiType = REST
+  groupName: string
+  operationsSpecTransformation: OperationsSpecTransformation
+  format: OperationsGroupExportFormat
+  allowedOasExtensions?: OpenApiExtensionKey
+}
+
+export const TRANSFORMATION_KIND_REDUCED = 'reducedSourceSpecifications'
+export const TRANSFORMATION_KIND_MERGED = 'mergedSpecification'
+
+export type OperationsSpecTransformation =
+  | typeof TRANSFORMATION_KIND_REDUCED
+  | typeof TRANSFORMATION_KIND_MERGED
+
 export interface BuildConfigFile {
   fileId: FileId
   slug?: string // for rebuild

src/types/external/documents.ts

@@ -15,6 +15,7 @@
  */
 
 import { OperationsApiType, PackageId, VersionId } from './types'
+import { ResolvedReferenceMap } from './references'
 
 export type VersionDocumentsResolver = (
   apiType: OperationsApiType,
@@ -25,6 +26,7 @@ export type VersionDocumentsResolver = (
 
 export type ResolvedDocuments = {
   documents: ReadonlyArray<ResolvedDocument>
+  packages: ResolvedReferenceMap
 }
 
 export type ResolvedDocument = {
@@ -38,4 +40,5 @@ export type ResolvedDocument = {
   labels: string[]
   includedOperationIds?: string[]
   data?: string
+  packageRef?: string
 }

src/types/external/references.ts

@@ -15,6 +15,7 @@
  */
 
 import { PackageId, VersionId } from './types'
+import { VersionStatus } from './config'
 
 export type VersionReferencesResolver = (
   version: VersionId,
@@ -32,22 +33,23 @@ export interface ResolvedReferences {
   packages: ResolvedReferenceMap
 }
 
-export type ResolvedReferenceMap = Record<string, ResolvedReference>
+export type ResolvedReferenceMap = Record<string, ReferencedPackage>
 
-export interface ResolvedReference {
+export interface ReferencedPackage {
   refId: string
+  kind: ReferencedPackageKind
+  name: string
   version: string
-  versionRevision: number
-  parentRefId?: string
-  parentRefVersion?: string
-  excluded?: boolean
+  status: VersionStatus
+  parentPackages: string[]
   deletedAt?: string
+  deletedBy?: string
+  notLatestRevision?: string
+}
 
-  // other params
-  // [key: string]: unknown
+export const KIND_PACKAGE = 'package'
+export const KIND_DASHBOARD = 'dashboard'
 
-  // name: string
-  // status: 'draft' | 'release' | 'release candidate' | 'deprecated' | 'archived'
-  // kind?: 'package' | 'dashboard'
-  // parents?: unknown[]
-}
+export type ReferencedPackageKind =
+  | typeof KIND_PACKAGE
+  | typeof KIND_DASHBOARD