Merge remote-tracking branch 'refs/remotes/origin/develop' into feature/export-build-tasks-support

# Conflicts:
#	src/builder.ts
#	src/types/internal/apiBuilder.ts

Author: CountRedClaw

.github/CODEOWNERS

@@ -0,0 +1 @@
+@alagishev 

.github/workflows/delete-dist-tag.yaml

@@ -0,0 +1,8 @@
+name: delete-dist-tag
+
+on:
+  delete:
+
+jobs:
+  delete-dist-tag:
+    uses: netcracker/qubership-apihub-ci/.github/workflows/delete-dist-tag.yaml@main

.github/workflows/frontend-ci.yaml

@@ -1,4 +1,4 @@
-name: Frontend CI Workflow
+name: frontend-ci 
 
 on:
   push:
@@ -10,7 +10,6 @@ on:
       - bugfix/*      
     tags:
       - '**'
-  delete:
 
 jobs:
   call-frontend-ci-workflow:

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@netcracker/qubership-apihub-api-processor",
-  "version": "3.1.1",
+  "version": "4.0.1",
   "description": "",
   "license": "Apache-2.0",
   "module": "dist/esm/src/index.js",
@@ -28,14 +28,11 @@
     "operation:test": "node ./test/operation.js",
     "profile": "node --inspect-brk ./test/profile.js",
     "test:coverage": "jest --verbose --coverage",
-    "feature-start": "feature-start --featureName",
-    "feature-finish": "feature-finish",
-    "release-start": "release-start",
-    "release-finish": "release-finish"
+    "update-lock-file": "update-lock-file @netcracker"
   },
   "dependencies": {
-    "@netcracker/qubership-apihub-api-diff": "dev",
-    "@netcracker/qubership-apihub-api-unifier": "1.0.4",
+    "@netcracker/qubership-apihub-api-diff": "2.0.0",
+    "@netcracker/qubership-apihub-api-unifier": "2.0.0",
     "@netcracker/qubership-apihub-json-crawl": "1.0.4",
     "@netcracker/qubership-apihub-graphapi": "1.0.8",
     "adm-zip": "0.5.10",
@@ -52,7 +49,7 @@
     "swagger2openapi": "^7.0.8"
   },
   "devDependencies": {
-    "@netcracker/qubership-apihub-npm-gitflow": "2.2.2",
+    "@netcracker/qubership-apihub-npm-gitflow": "3.0.1",
     "@types/adm-zip": "0.5.7",
     "@types/jest": "^29.5.12",
     "@types/js-yaml": "^4.0.5",

package.json

@@ -19,7 +19,7 @@ import { OpenAPIV3 } from 'openapi-types'
 import { buildRestDocument, dumpRestDocument } from './rest.document'
 import { REST_API_TYPE, REST_DOCUMENT_TYPE } from './rest.consts'
 import { compareRestOperationsData } from './rest.changes'
-import { buildRestOperations } from './rest.operations'
+import { buildRestOperations, createNormalizedOperationId } from './rest.operations'
 import { parseRestFile } from './rest.parser'
 
 import { ApiBuilder } from '../../types'
@@ -34,4 +34,5 @@ export const restApiBuilder: ApiBuilder<OpenAPIV3.Document> = {
   buildOperations: buildRestOperations,
   dumpDocument: dumpRestDocument,
   compareOperationsData: compareRestOperationsData,
+  createNormalizedOperationId: createNormalizedOperationId,
 }

src/apitypes/rest/index.ts

@@ -17,14 +17,20 @@
 import { OpenAPIV3 } from 'openapi-types'
 
 import { buildRestOperation } from './rest.operation'
-import { OperationsBuilder } from '../../types'
-import { createBundlingErrorHandler, removeComponents, removeFirstSlash, slugify } from '../../utils'
+import { OperationIdNormalizer, OperationsBuilder } from '../../types'
+import {
+  createBundlingErrorHandler,
+  IGNORE_PATH_PARAM_UNIFIED_PLACEHOLDER,
+  removeComponents,
+  removeFirstSlash,
+  slugify,
+} from '../../utils'
 import { getOperationBasePath } from './rest.utils'
 import type * as TYPE from './rest.types'
 import { HASH_FLAG, INLINE_REFS_FLAG, MESSAGE_SEVERITY, NORMALIZE_OPTIONS, ORIGINS_SYMBOL } from '../../consts'
 import { asyncFunction } from '../../utils/async'
 import { logLongBuild, syncDebugPerformance } from '../../utils/logs'
-import { normalize } from '@netcracker/qubership-apihub-api-unifier'
+import { normalize, RefErrorType } from '@netcracker/qubership-apihub-api-unifier'
 
 export const buildRestOperations: OperationsBuilder<OpenAPIV3.Document> = async (document, ctx, debugCtx) => {
   const documentWithoutComponents = removeComponents(document.data)
@@ -38,8 +44,8 @@ export const buildRestOperations: OperationsBuilder<OpenAPIV3.Document> = async
         originsFlag: ORIGINS_SYMBOL,
         hashFlag: HASH_FLAG,
         source: document.data,
-        onRefResolveError: (_: string, __: PropertyKey[], ref: string) =>
-          bundlingErrorHandler([`The $ref "${ref}" references an invalid location in the document.`]),
+        onRefResolveError: (message: string, _path: PropertyKey[], _ref: string, errorType: RefErrorType) =>
+          bundlingErrorHandler([{ message, errorType }]),
       },
     ) as OpenAPIV3.Document
     const refsOnlyDocument = normalize(
@@ -106,3 +112,8 @@ export const buildRestOperations: OperationsBuilder<OpenAPIV3.Document> = async
   }
   return operations
 }
+
+export const createNormalizedOperationId: OperationIdNormalizer = (operation) => {
+  const { metadata: { path, method } } = operation
+  return slugify(`${path}-${method}`, [], IGNORE_PATH_PARAM_UNIFIED_PLACEHOLDER)
+}

src/apitypes/rest/rest.operations.ts

@@ -18,13 +18,14 @@ import type { OpenAPIV3 } from 'openapi-types'
 
 import type { ApiOperation, NotificationMessage, VersionDocument } from '../../types'
 import { REST_DOCUMENT_TYPE, REST_KIND_KEY, REST_SCOPES } from './rest.consts'
+import { NormalizedPath } from '../../utils'
 
 export type RestScopeType = keyof typeof REST_SCOPES
 export type RestDocumentType = (typeof REST_DOCUMENT_TYPE)[keyof typeof REST_DOCUMENT_TYPE]
 export type CustomTags = Record<string, unknown>
 
 export interface RestOperationMeta {
-  path: string                            // `/packages/*/version/*`
+  path: NormalizedPath                    // `/packages/*/version/*`
   originalPath: string                    // `/packages/{packageId}/version/{version}`
   method: OpenAPIV3.HttpMethods           // `get` | `post` | ...
   tags?: string[]                         // operations tags

src/apitypes/rest/rest.types.ts

@@ -341,7 +341,10 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
     packageId = packageId ?? this.config.packageId
 
     if (this.canBeResolvedLocally(version, packageId)) {
-      const currentOperations = operationIds ? this.operationList.filter(({ operationId }) => operationIds.includes(operationId)) : this.operationList
+      const currentApiTypeOperations = this.operationList.filter((operation) => operation.apiType === apiType)
+      const currentOperations = operationIds
+        ? currentApiTypeOperations.filter(({ operationId }) => operationIds.includes(operationId))
+        : currentApiTypeOperations
       return { operations: currentOperations }
     }
 
@@ -498,6 +501,8 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
       throw new Error('No versionResolver provided')
     }
 
+    // includeOperations=true is only used to extract unique apiTypes (see getUniqueApiTypesFromVersions)
+    // the operations map itself is no longer used in processor
     const versionContent = await versionResolver(packageId, version, true)
 
     if (!versionContent) {
@@ -576,10 +581,9 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
     const operationsTypes: OperationTypes[] = []
 
     for (const apiType of this.existingOperationsApiTypes) {
-      const operationsHashMap = this.operationsHashMapByApiType(apiType)
       operationsTypes.push({
         apiType: apiType,
-        operations: operationsHashMap,
+        operationsCount: this.operations.size,
       })
     }
 
@@ -592,18 +596,6 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
     return new Set(apiTypes)
   }
 
-  private operationsHashMapByApiType(operationsApiType: OperationsApiType): ResolvedVersionOperationsHashMap {
-    const hashMap: ResolvedVersionOperationsHashMap = {}
-
-    for (const { apiType, operationId, dataHash } of this.operations.values()) {
-      if (apiType === operationsApiType) {
-        hashMap[operationId] = dataHash
-      }
-    }
-
-    return hashMap
-  }
-
   async parseFile(fileId: string, source: Blob): Promise<SourceFile | null> {
     if (this.parsedFiles.has(fileId)) {
       return this.parsedFiles.get(fileId) ?? null